Package org.cytoscape.application.events

Class SetCurrentNetworkViewEvent

java.lang.Object

org.cytoscape.event.AbstractCyEvent<CyApplicationManager>

org.cytoscape.application.events.SetCurrentNetworkViewEvent

All Implemented Interfaces:

CyEvent<CyApplicationManager>

public final class SetCurrentNetworkViewEvent
extends AbstractCyEvent<CyApplicationManager>

An event indicating that a network view has been set to current.

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>

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
SetCurrentNetworkViewEvent(CyApplicationManager source, CyNetworkView view)	Constructor.

Method Summary

Modifier and Type	Method	Description
CyNetworkView	getNetworkView()	Returns the network view 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

SetCurrentNetworkViewEvent

public SetCurrentNetworkViewEvent(CyApplicationManager source,
                                  CyNetworkView view)

Constructor.

Parameters:

source - The application manager firing this event.

view - The network view that has been set as current.

Method Detail

getNetworkView

public final CyNetworkView getNetworkView()

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

Returns:

the network view associated with this event.