Package org.cytoscape.application.swing.events

Class CytoPanelStateChangedEvent

java.lang.Object

org.cytoscape.event.AbstractCyEvent<Object>

org.cytoscape.application.swing.events.CytoPanelStateChangedEvent

All Implemented Interfaces:

CyEvent<Object>

public final class CytoPanelStateChangedEvent
extends AbstractCyEvent<Object>

An event to indicate that a CytoPanel has changed state.

Module: swing-application-api

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

<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>swing-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
CytoPanelStateChangedEvent(Object source, CytoPanel cp, CytoPanelState newState)	Constructor.

Method Summary

Modifier and Type	Method	Description
CytoPanel	getCytoPanel()	Returns the CytoPanel whose state has changed.
CytoPanelState	getNewState()	Returns the new state of the CytoPanel.

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

CytoPanelStateChangedEvent

public CytoPanelStateChangedEvent(Object source,
                                  CytoPanel cp,
                                  CytoPanelState newState)

Constructor.

Parameters:

source - The object firing the event.

cp - The CytoPanel whose state has changed.

newState - The new state of the CytoPanel.

Method Detail

getCytoPanel

public CytoPanel getCytoPanel()

Returns the CytoPanel whose state has changed.

Returns:

the CytoPanel whose state has changed.

getNewState

public CytoPanelState getNewState()

Returns the new state of the CytoPanel.

Returns:

The new state of the CytoPanel.