org.cytoscape.model.events

Class AboutToRemoveEdgesEvent

java.lang.Object

org.cytoscape.event.AbstractCyEvent<CyNetwork>

org.cytoscape.model.events.AboutToRemoveEdgesEvent

All Implemented Interfaces:

CyEvent<CyNetwork>

public final class AboutToRemoveEdgesEvent
extends AbstractCyEvent<CyNetwork>

Fired before an edge is actually removed so that listeners have a chance to clean up before the edge object disappears.

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.

Module: model-api

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

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

Constructor Summary

Constructors

Constructor and Description
AboutToRemoveEdgesEvent(CyNetwork source, Collection<CyEdge> edges) Constructs event.

Method Summary

Modifier and Type	Method and Description
Collection<CyEdge>	getEdges() Returns the collection of edges 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

AboutToRemoveEdgesEvent

public AboutToRemoveEdgesEvent(CyNetwork source,
                               Collection<CyEdge> edges)

Constructs event.

Parameters:

source - the network firing this event.

edges - the collection of edges about to be removed.

Method Detail

getEdges

public Collection<CyEdge> getEdges()

Returns the collection of edges about to be removed.

Returns:

the collection of edges about to be removed.