Cytoscape 3.0.1 API

org.cytoscape.view.model.events
Class AboutToRemoveEdgeViewsEvent

java.lang.Object
  extended by org.cytoscape.event.AbstractCyEvent<T>
      extended by org.cytoscape.event.AbstractCyPayloadEvent<CyNetworkView,View<CyEdge>>
          extended by org.cytoscape.view.model.events.AboutToRemoveEdgeViewsEvent
All Implemented Interfaces:
CyEvent<CyNetworkView>, CyPayloadEvent<CyNetworkView,View<CyEdge>>

public final class AboutToRemoveEdgeViewsEvent
extends AbstractCyPayloadEvent<CyNetworkView,View<CyEdge>>

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

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.

Cytoscape 3.0.1 API

Copyright 2011 Cytoscape Consortium. All rights reserved.