Package org.cytoscape.model.events
Class AboutToRemoveNodesEvent
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.
Module: model-api
To use this in your app, include the following dependency in your POM:
<dependency> <groupId>org.cytoscape</groupId> <artifactId>model-api</artifactId> </dependency>
-
Constructor Summary
ConstructorDescriptionAboutToRemoveNodesEvent
(CyNetwork source, Collection<CyNode> nodes) Constructs event. -
Method Summary
Modifier and TypeMethodDescriptiongetNodes()
Returns the collection of nodes about to be removed.Methods inherited from class org.cytoscape.event.AbstractCyEvent
getListenerClass, getSource
-
Constructor Details
-
AboutToRemoveNodesEvent
Constructs event.- Parameters:
source
- the network firing this event.nodes
- the collection of nodes about to be removed.
-
-
Method Details
-
getNodes
Returns the collection of nodes about to be removed.- Returns:
- the collection of nodes about to be removed.
-