org.cytoscape.view.model.events
Class AboutToRemoveNodeViewsEvent

java.lang.Object
  org.cytoscape.event.AbstractCyEvent<CyNetworkView>
      org.cytoscape.view.model.events.AboutToRemoveNodeViewsEvent

All Implemented Interfaces:

CyEvent<CyNetworkView>

public final class AboutToRemoveNodeViewsEvent
extends AbstractCyEvent<CyNetworkView>

When node Views are about to be removed from 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.

Constructor Summary

AboutToRemoveNodeViewsEvent(CyNetworkView source, Collection<View<CyNode>> payload)
Creates the event for about to be removed node views.

Method Summary

Collection<View<CyNode>>

getNodeViews() Returns a Collection of Views of type CyNode that are 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

AboutToRemoveNodeViewsEvent

public AboutToRemoveNodeViewsEvent(CyNetworkView source,
                                   Collection<View<CyNode>> payload)

Creates the event for about to be removed node views.

Parameters:

source - network view which includes the node views about to be removed.

payload - Collection of node view objects about to be removed.

Method Detail

getNodeViews

public Collection<View<CyNode>> getNodeViews()

Returns a Collection of Views of type CyNode that are about to be removed.

Returns:

a Collection of Views of type CyNode that are about to be removed.