Package com.luciad.lucy.gui

Class TLcyActionBarItem

java.lang.Object

com.luciad.lucy.gui.TLcyActionBarItem

public class TLcyActionBarItem
extends Object

Represents an action, active settable, component or sub-menu in an ILcyActionBar (e.g. a menu bar), depending on which of the four constructors is used. Every property that isn't specified for a specific constructor returns null.

See Also:

• TLcyActionBarItemComparator

Constructor Summary

Constructors

Constructor	Description
TLcyActionBarItem(ILcdAction aAction, TLcyGroupDescriptor aGroupDescriptor, String[] aMenus, TLcyGroupDescriptor[] aMenuGroupDescriptors, long aInsertTime)	Creates a TLcyActionBarItem that represents an action.
TLcyActionBarItem(ILcyActiveSettable aActiveSettable, boolean aDeactivatePossible, TLcyGroupDescriptor aGroupDescriptor, String[] aMenus, TLcyGroupDescriptor[] aMenuGroupDescriptors, long aInsertTime)	Creates a TLcyActionBarItem that represents an active settable.
TLcyActionBarItem(Component aComponent, TLcyGroupDescriptor aGroupDescriptor, long aInsertTime)	Creates a TLcyActionBarItem that represents a component that was inserted directly.
TLcyActionBarItem(String[] aMenus, TLcyGroupDescriptor[] aMenuGroupDescriptors, long aInsertTime)	Creates a TLcyActionBarItem that represents a sub-menu.

Method Summary

Modifier and Type	Method	Description
ILcdAction	getAction()	Returns the ILcdAction.
ILcyActiveSettable	getActiveSettable()	Returns the ILcyActiveSettable.
Component	getComponent()	Returns the Component.
TLcyGroupDescriptor	getGroupDescriptor()	Returns the TLcyGroupDescriptor.
long	getInsertTime()	Returns the insertion time.
TLcyGroupDescriptor[]	getMenuGroupDescriptors()	Returns the menu group descriptors.
String[]	getMenus()	Returns the menus.
String	getText()	Utility method that returns the NAME property from the action (if not null), or from the active settable (if not null) or the last menu name (if not null).
boolean	isDeactivatePossible()	Returns the deactivatePossible property.
boolean	isMenu()	Utility method to find out if this descriptor represents a (sub)menu (so not an action, not an active settable and not a component).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TLcyActionBarItem

public TLcyActionBarItem(ILcdAction aAction,
 TLcyGroupDescriptor aGroupDescriptor,
 String[] aMenus,
 TLcyGroupDescriptor[] aMenuGroupDescriptors,
 long aInsertTime)

Creates a TLcyActionBarItem that represents an action.

Parameters:

aAction - The action, as defined in insertAction.

aGroupDescriptor - The group descriptor, as defined in insertAction.

aMenus - The menus, as defined in insertAction.

aMenuGroupDescriptors - The menu group descriptors, as defined in insertAction.

aInsertTime - The insert time, see getInsertTime().

See Also:

• ILcyActionBar.insertAction(com.luciad.gui.ILcdAction, TLcyGroupDescriptor, String[], TLcyGroupDescriptor[])

TLcyActionBarItem

public TLcyActionBarItem(ILcyActiveSettable aActiveSettable,
 boolean aDeactivatePossible,
 TLcyGroupDescriptor aGroupDescriptor,
 String[] aMenus,
 TLcyGroupDescriptor[] aMenuGroupDescriptors,
 long aInsertTime)

Creates a TLcyActionBarItem that represents an active settable.

Parameters:

aActiveSettable - The active settable, as defined in insertActiveSettable.

aDeactivatePossible - The deactivate possible property, as defined in insertActiveSettable.

aGroupDescriptor - The group descriptor, as defined in insertActiveSettable.

aMenus - The menus, as defined in insertActiveSettable.

aMenuGroupDescriptors - The menu group descriptors, as defined in insertActiveSettable.

aInsertTime - The insert time, see getInsertTime().

See Also:

• ILcyActionBar.insertActiveSettable(ILcyActiveSettable, TLcyGroupDescriptor, String[], TLcyGroupDescriptor[], boolean)

TLcyActionBarItem

public TLcyActionBarItem(Component aComponent,
 TLcyGroupDescriptor aGroupDescriptor,
 long aInsertTime)

Creates a TLcyActionBarItem that represents a component that was inserted directly.

Parameters:

aComponent - The component, as defined in insertComponent.

aGroupDescriptor - The group descriptor, as defined in insertComponent.

aInsertTime - The insert time, see getInsertTime().

See Also:

• ALcyActionBar.insertComponent(java.awt.Component, TLcyGroupDescriptor)

TLcyActionBarItem

public TLcyActionBarItem(String[] aMenus,
 TLcyGroupDescriptor[] aMenuGroupDescriptors,
 long aInsertTime)

Creates a TLcyActionBarItem that represents a sub-menu.

Parameters:

aMenus - The menus, as defined in insertAction or insertActiveSettable.

aMenuGroupDescriptors - The menu group descriptors, as defined in insertAction or insertActiveSettable.

aInsertTime - The insert time, see getInsertTime().

See Also:

• ILcyActionBar.insertAction(com.luciad.gui.ILcdAction, TLcyGroupDescriptor, String[], TLcyGroupDescriptor[])
• ILcyActionBar.insertActiveSettable(ILcyActiveSettable, TLcyGroupDescriptor, String[], TLcyGroupDescriptor[], boolean)

Method Details

getText

public String getText()

Utility method that returns the NAME property from the action (if not null), or from the active settable (if not null) or the last menu name (if not null). If these are all unavailable, null is returned.

Returns:

The textual representation of this TLcyActionBarItem, if any. Null otherwise.

isMenu

public boolean isMenu()

Utility method to find out if this descriptor represents a (sub)menu (so not an action, not an active settable and not a component).

Returns:

true if this descriptor represents a (sub)menu, false otherwise.

getAction

public ILcdAction getAction()

Returns the ILcdAction. See constructors and class comment for more information.

Returns:

the ILcdAction.

getActiveSettable

public ILcyActiveSettable getActiveSettable()

Returns the ILcyActiveSettable. See constructors and class comment for more information.

Returns:

the ILcyActiveSettable.

isDeactivatePossible

public boolean isDeactivatePossible()

Returns the deactivatePossible property. See constructors and class comment for more information.

Returns:

the deactivatePossible property.

getGroupDescriptor

public TLcyGroupDescriptor getGroupDescriptor()

Returns the TLcyGroupDescriptor. See constructors and class comment for more information.

Returns:

the TLcyGroupDescriptor.

getComponent

public Component getComponent()

Returns the Component. See constructors and class comment for more information.

Returns:

the Component.

getMenus

public String[] getMenus()

Returns the menus. See constructors and class comment for more information.

Returns:

the menus.

getMenuGroupDescriptors

public TLcyGroupDescriptor[] getMenuGroupDescriptors()

Returns the menu group descriptors. See constructors and class comment for more information.

Returns:

the menu group descriptors.

getInsertTime

public long getInsertTime()

Returns the insertion time. The insertion time is not related to wall-clock time, but represents the order in which actions, active settables, components or sub-menus were added. The later they were added, the bigger this value. It can be used to automatically order items based on their insertion time, to for example keep the most recently added item in a recent items list at the top.

Returns:

the insertion time.