com.canto.cumulus.ui.events

Class ContextMenuEventObject<_Source>

java.lang.Object

java.util.EventObject

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

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

All Implemented Interfaces:

java.io.Serializable

public class ContextMenuEventObject<_Source>
extends BaseEventObject<_Source,ContextMenuListener<_Source>>

The event object for the ContextMenuListener interface.

Since:

8.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ContextMenuEventObject.EventType

Constructor Summary

Constructors

Constructor and Description
ContextMenuEventObject(ContextMenuEventObject.EventType eventType, int collectionWindowID, GUID paneID, Menu menu, boolean selectionMenu) Internal use only.

Method Summary

Methods

Modifier and Type	Method and Description
int	getCollectionWindowID() Get the ID of the collection window for the event.
Menu	getMenu() Return the menu where the event belongs to.
GUID	getPaneID() Return the ID of the pane that the context menu belongs to.
boolean	isSelectionMenu() Return whether the context menu is for selected categories.
java.lang.String	toString() Return a string representation of this event object.

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

getSource

Methods inherited from class java.lang.Object

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

Constructor Detail

ContextMenuEventObject

public ContextMenuEventObject(ContextMenuEventObject.EventType eventType,
                      int collectionWindowID,
                      GUID paneID,
                      Menu menu,
                      boolean selectionMenu)

Internal use only.

Method Detail

getCollectionWindowID

public int getCollectionWindowID()

Get the ID of the collection window for the event.

Returns:

The current collection window ID.

getMenu

public Menu getMenu()

Return the menu where the event belongs to.

Returns:

The context menu being created or deleted.

getPaneID

public GUID getPaneID()

Return the ID of the pane that the context menu belongs to.

Returns:

The ID of the context menu's pane.

isSelectionMenu

public boolean isSelectionMenu()

Return whether the context menu is for selected categories. This only applies to the context menu for the categories pane because Cumulus create two context menus: one for the case that no category is selected and a second one for the case that some categories are selected.

Returns:

true if the context menu belongs to the categories pane to be used for selected categories.

toString

public java.lang.String toString()

Return a string representation of this event object.

Overrides:

toString in class java.util.EventObject

Returns:

this event object as a string.