Package org.cytoscape.group.events

Class GroupEdgesRemovedEvent

java.lang.Object

org.cytoscape.event.AbstractCyEvent

org.cytoscape.group.events.GroupEdgesRemovedEvent

All Implemented Interfaces:

CyEvent

public final class GroupEdgesRemovedEvent
extends AbstractCyEvent

This event signals that edges have been removed from the network.

Module: group-api

To use this in your app, include the following dependency in your POM:

<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>group-api</artifactId>
</dependency>

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

Constructors

Constructor	Description
GroupEdgesRemovedEvent(CyGroup source, List<CyEdge> edges)	Constructs event.
GroupEdgesRemovedEvent(CyGroup source, CyEdge edge)	Constructs event.

Method Summary

Modifier and Type	Method	Description
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

GroupEdgesRemovedEvent

public GroupEdgesRemovedEvent(CyGroup source,
                              CyEdge edge)

Constructs event.

Parameters:

source - the CyGroup that is changing.

edge - A single edge removed.

GroupEdgesRemovedEvent

public GroupEdgesRemovedEvent(CyGroup source,
                              List<CyEdge> edges)

Constructs event.

Parameters:

source - the CyGroup that is changing.

edges - A list of edges removed. 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.