org.cytoscape.model.events
Class AboutToRemoveNodesEvent

java.lang.Object
  org.cytoscape.event.AbstractCyEvent<CyNetwork>
      org.cytoscape.model.events.AboutToRemoveNodesEvent

All Implemented Interfaces:

CyEvent<CyNetwork>

public final class AboutToRemoveNodesEvent
extends AbstractCyEvent<CyNetwork>

Fired before a node is actually removed so that listeners have a chance to clean up before the node object disappears. Note that this event also implies an AboutToRemoveEdgesEvent for every edge adjacent to the node in question (because all adjacent edges are removed as a consequence of removing a node), even though the AboutToRemoveEdgesEvent is not actually fired. If you only care about removing edges, be sure to listen for this event as well!

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.

Constructor Summary

AboutToRemoveNodesEvent(CyNetwork source, Collection<CyNode> nodes)
Constructs event.

Method Summary

Collection<CyNode>

getNodes() Returns the collection of nodes about to be removed.

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

Constructor Detail

AboutToRemoveNodesEvent

public AboutToRemoveNodesEvent(CyNetwork source,
                               Collection<CyNode> nodes)

Constructs event.

Parameters:

source - the network firing this event.

nodes - the collection of nodes about to be removed.

Method Detail

getNodes

public Collection<CyNode> getNodes()

Returns the collection of nodes about to be removed.

Returns:

the collection of nodes about to be removed.