Cytoscape 3.0.1 API

org.cytoscape.view.model.events
Class AddedEdgeViewsEvent

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.AddedEdgeViewsEvent
All Implemented Interfaces:
CyEvent<CyNetworkView>, CyPayloadEvent<CyNetworkView,View<CyEdge>>

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

When edge View is added to 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
AddedEdgeViewsEvent(CyNetworkView source, Collection<View<CyEdge>> edgeViews)
          Creates the event for new edge views.
 
Method Summary
 Collection<View<CyEdge>> getEdgeViews()
          Returns new edge view added to the source network view object.
 
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

AddedEdgeViewsEvent

public AddedEdgeViewsEvent(CyNetworkView source,
                           Collection<View<CyEdge>> edgeViews)
Creates the event for new edge views.

Parameters:
source - network view which includes the new edge view.
edgeViews - Collection of newly created view object for an edge.
Method Detail

getEdgeViews

public Collection<View<CyEdge>> getEdgeViews()
Returns new edge view added to the source network view object.

Returns:
new edge view added to the network view.

Cytoscape 3.0.1 API

Copyright 2011 Cytoscape Consortium. All rights reserved.