Cytoscape 3.0.1 API

org.cytoscape.group.events
Class GroupEdgesAddedEvent

java.lang.Object
  extended by org.cytoscape.event.AbstractCyEvent
      extended by org.cytoscape.group.events.GroupEdgesAddedEvent
All Implemented Interfaces:
CyEvent

public final class GroupEdgesAddedEvent
extends AbstractCyEvent

This event signals that edges have been added to the network.


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
GroupEdgesAddedEvent(CyGroup source, CyEdge edge)
          Constructs event.
GroupEdgesAddedEvent(CyGroup source, List<CyEdge> edges)
          Constructs event.
 
Method Summary
 List<CyEdge> getEdges()
          Returns the list of edges associated with this event.
 
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

GroupEdgesAddedEvent

public GroupEdgesAddedEvent(CyGroup source,
                            CyEdge edge)
Constructs event.

Parameters:
source - the CyGroup that is changing.
edge - A single edge added.

GroupEdgesAddedEvent

public GroupEdgesAddedEvent(CyGroup source,
                            List<CyEdge> edges)
Constructs event.

Parameters:
source - the CyGroup that is changing.
edges - A list of edges added. May be null.
Method Detail

getEdges

public List<CyEdge> getEdges()
Returns the list of edges associated with this event. The list may be empty, but will not be null.

Returns:
the list of edges associated with this event.

Cytoscape 3.0.1 API

Copyright 2011 Cytoscape Consortium. All rights reserved.