Package org.cytoscape.application.swing.events

Class CytoPanelComponentSelectedEvent

java.lang.Object

org.cytoscape.event.AbstractCyEvent<Object>

org.cytoscape.application.swing.events.CytoPanelComponentSelectedEvent

All Implemented Interfaces:

CyEvent<Object>

public final class CytoPanelComponentSelectedEvent
extends AbstractCyEvent<Object>

The event fired to indicate that a CytoPanelComponent has been selected.

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
CytoPanelComponentSelectedEvent(Object source, CytoPanel cp, int index)	Constructor.

Method Summary

Modifier and Type	Method	Description
CytoPanel	getCytoPanel()	Returns the CytoPanel on which a component was selected.
int	getSelectedIndex()	Returns the index of the CytoPanelComponent selected.

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

CytoPanelComponentSelectedEvent

public CytoPanelComponentSelectedEvent(Object source,
                                       CytoPanel cp,
                                       int index)

Constructor.

Parameters:

source - The object firing the event.

cp - The CytoPanel on which a component was selected.

index - The index of the CytoPanelComponent selected.

Method Detail

getCytoPanel

public CytoPanel getCytoPanel()

Returns the CytoPanel on which a component was selected.

Returns:

the CytoPanel on which a component was selected.

getSelectedIndex

public int getSelectedIndex()

Returns the index of the CytoPanelComponent selected.

Returns:

the index of the CytoPanelComponent selected.