nu.zoom.ldap.eon.event
Interface ActionValues

All Known Subinterfaces:

AllAttributesPopUpItem, DirectoryTreePopUpItem

All Known Implementing Classes:

CopyItem, CutItem, DeleteItem, PasteItem, RefreshItem, RenameItem

public interface ActionValues

Interface that helps in construction of Actions that are to appear on menus and toolbars.

Version:

$Revision: 1.1 $

Author:

$Author: johan $

Method Summary

Integer	getAcceleratorKey() Set the accelerator key.
Integer	getAcceleratorKeyMask() Set the accelerator key.
Icon	getIcon() Get the Icon to use on the action.
Integer	getMnemonic() Get the mnemonic key to use for the action.
String	getName() Get the name of the action.
String	getToolTip() Get the tooltip text to use for this action.

Method Detail

getName

String getName()

Get the name of the action. This will be displayed on menues and toolbars.

Returns:

The name. Must not be null.

getToolTip

String getToolTip()

Get the tooltip text to use for this action.

Returns:

The tooltip text. Null is valid and means to not set a tooltip text.

getIcon

Icon getIcon()

Get the Icon to use on the action.

Returns:

The icon to use, null indicates that this action should not have an Icon.

getMnemonic

Integer getMnemonic()

Get the mnemonic key to use for the action. A mnemonic is a key that makes an already visible menu item be chosen. See How to use menues

Returns:

A key event for the mnemonic key. Return null if this item does not have a mnemonic key.

See Also:

Action.MNEMONIC_KEY, KeyEvent

getAcceleratorKey

Integer getAcceleratorKey()

Set the accelerator key. An accelerator is a key combination that causes a menu item to be chosen, whether or not it's visible. See How to use menues

Returns:

The key used to trigger the action. For example KeyEvent.VK_L. Null means that no accelerator key is used.

See Also:

KeyEvent, Action.ACCELERATOR_KEY

getAcceleratorKeyMask

Integer getAcceleratorKeyMask()

Set the accelerator key. An accelerator is a key combination that causes a menu item to be chosen, whether or not it's visible. See How to use menues

Returns:

The key mask used in combination with the accelrator key (for example KeyEvent.CTRL_DOWN_MASK)). Null means that no mask is used.

See Also:

KeyEvent, Action.ACCELERATOR_KEY