org.cytoscape.application.events

Class SetCurrentNetworkEvent

java.lang.Object

org.cytoscape.event.AbstractCyEvent<CyApplicationManager>

org.cytoscape.application.events.SetCurrentNetworkEvent

All Implemented Interfaces:

CyEvent<CyApplicationManager>

public final class SetCurrentNetworkEvent
extends AbstractCyEvent<CyApplicationManager>

An event signaling that the a network has been set to current.

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: application-api

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

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

Constructor Summary

Constructors

Constructor and Description
SetCurrentNetworkEvent(CyApplicationManager source, CyNetwork net) Constructor.

Method Summary

Modifier and Type	Method and Description
CyNetwork	getNetwork() Returns the network 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

SetCurrentNetworkEvent

public SetCurrentNetworkEvent(CyApplicationManager source,
                              CyNetwork net)

Constructor.

Parameters:

source - The application manager that is the source of the event.

net - The network that has been set to the current network.

Method Detail

getNetwork

public final CyNetwork getNetwork()

Returns the network associated with this event. The network returned may be null!

Returns:

the network associated with this event.