org.cytoscape.view.model.events
Class AboutToRemoveEdgeViewsEvent

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

All Implemented Interfaces:

CyEvent<CyNetworkView>

public final class AboutToRemoveEdgeViewsEvent
extends AbstractCyEvent<CyNetworkView>

When edge 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

AboutToRemoveEdgeViewsEvent(CyNetworkView source, Collection<View<CyEdge>> payload)
Creates the event for about to be removed edge views.

Method Summary

Collection<View<CyEdge>>

getEdgeViews() Returns the Collection of Views of type CyEdge 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

AboutToRemoveEdgeViewsEvent

public AboutToRemoveEdgeViewsEvent(CyNetworkView source,
                                   Collection<View<CyEdge>> payload)

Creates the event for about to be removed edge views.

Parameters:

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

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

Method Detail

getEdgeViews

public Collection<View<CyEdge>> getEdgeViews()

Returns the Collection of Views of type CyEdge that are about to be removed.

Returns:

the Collection of Views of type CyEdge that are about to be removed.