com.canto.cumulus.ui.events

Class SelectionChangedEventObject<_Source>

java.lang.Object

java.util.EventObject

com.canto.cumulus.events.BaseEventObject<_Source,SelectionListener<_Source>>

com.canto.cumulus.ui.events.SelectionChangedEventObject<_Source>

All Implemented Interfaces:

java.io.Serializable

public class SelectionChangedEventObject<_Source>
extends BaseEventObject<_Source,SelectionListener<_Source>>

The event object for the SelectionListener interface.

Since:

8.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SelectionChangedEventObject(int collectionWindowID, GUID paneID, java.lang.String masterCategoryName) For internal use only.

Method Summary

Methods

Modifier and Type	Method and Description
int	getCollectionWindowID() Return the ID of the collection window that has the new selection.
java.lang.String	getMasterCategoryName() Get the name of the master category for the tab in the categories pane where the selection has changed.
GUID	getPaneID() Return the ID of the pane that holds the current selection.

Methods inherited from class com.canto.cumulus.events.BaseEventObject

getSource

Methods inherited from class java.util.EventObject

toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SelectionChangedEventObject

public SelectionChangedEventObject(int collectionWindowID,
                           GUID paneID,
                           java.lang.String masterCategoryName)

For internal use only.

Method Detail

getCollectionWindowID

public int getCollectionWindowID()

Return the ID of the collection window that has the new selection.

Returns:

The current collection window's ID.

getPaneID

public GUID getPaneID()

Return the ID of the pane that holds the current selection.

Returns:

The current pane's ID.

getMasterCategoryName

public java.lang.String getMasterCategoryName()

Get the name of the master category for the tab in the categories pane where the selection has changed. This returns null if the selection change event does not belong to a categories pane.

Returns:

The name of the master category (e.g. "$Sources") where the category selection has changed or null in case it is not related to categories.