org.cytoscape.view.model.events

Class AddedNodeViewsEvent

java.lang.Object

org.cytoscape.event.AbstractCyEvent<T>

org.cytoscape.event.AbstractCyPayloadEvent<CyNetworkView,View<CyNode>>

org.cytoscape.view.model.events.AddedNodeViewsEvent

All Implemented Interfaces:

CyEvent<CyNetworkView>, CyPayloadEvent<CyNetworkView,View<CyNode>>

public final class AddedNodeViewsEvent
extends AbstractCyPayloadEvent<CyNetworkView,View<CyNode>>

When node View is added to a CyNetworkView, this event will be fired.

Cytoscape Backwards Compatibility (Final Class): This class is final and therefore can't be extended by users. This means that we may add methods for minor version updates. Methods will only be removed for major version updates.

Module: viewmodel-api

To use this in your app, include the following dependency in your POM:

<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>viewmodel-api</artifactId>
</dependency>

Constructor Summary

Constructors

Constructor and Description
AddedNodeViewsEvent(CyNetworkView source, Collection<View<CyNode>> nodeViews) Creates the event for a new node view.

Method Summary

Modifier and Type	Method and Description
Collection<View<CyNode>>	getNodeViews() Returns new node view object.

Methods inherited from class org.cytoscape.event.AbstractCyPayloadEvent

getPayloadCollection

Methods inherited from class org.cytoscape.event.AbstractCyEvent

getListenerClass, getSource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.cytoscape.event.CyEvent

getListenerClass, getSource

Constructor Detail

AddedNodeViewsEvent

public AddedNodeViewsEvent(CyNetworkView source,
                           Collection<View<CyNode>> nodeViews)

Creates the event for a new node view.

Parameters:

source - network view which includes the new node view.

nodeViews - Collection of newly created view object for a node.

Method Detail

getNodeViews

public Collection<View<CyNode>> getNodeViews()

Returns new node view object.

Returns:

new node view