com.xdev.ui.action

Interface Action

All Superinterfaces:

ActionListener, EventListener

All Known Subinterfaces:

ToggleAction

All Known Implementing Classes:

AbstractAction, AbstractToggleAction, ContextSensitiveAction

public interface Action
extends ActionListener

The Action interface provides a useful extension to the ActionListener interface in cases where the same functionality may be accessed by several controls.

In addition to the actionPerformed method defined by the ActionListener interface, this interface allows the application to define, in a single place:

• One or more text strings that describe the function. These strings can be used, for example, to display the flyover text for a button or to set the text in a menu item.
• One or more icons that depict the function. These icons can be used for the images in a menu control, or for composite entries in a more sophisticated user interface.
• The enabled/disabled state of the functionality. Instead of having to separately disable the menu item and the toolbar button, the application can disable the function that implements this interface. All components which are registered as listeners for the state change then know to disable event generation for that item and to modify the display accordingly.

This interface can be added to an existing class or used to create an adapter (typically, by subclassing AbstractAction). The Action object can then be added to multiple Action -aware containers and connected to Action-capable components. The GUI controls can then be activated or deactivated all at once by invoking the Action object's setEnabled method.

Actions are always bound to a XdevUI instance.

Components currently supporting Action:

• XdevButton
• XdevNativeButton
• XdevMenuBar.XdevMenuItem

Author:

XDEV Software

See Also:

getUI(), ActionComponent, ActionListener, AbstractAction, ContextSensitiveAction

Field Summary

Fields

Modifier and Type	Field and Description
static String	CAPTION_PROPERTY Property name of the caption property.
static String	DESCRIPTION_PROPERTY Property name of the description property.
static String	ENABLED_PROPERTY Property name of the enabled property.
static String	ICON_PROPERTY Property name of the icon property.
static String	SHORTCUT_PROPERTY Property name of the shortcut property.

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(PropertyChangeListener listener) Adds a PropertyChange listener.
String	getCaption() Returns the caption of this action, used e.g.
String	getDescription() Returns the caption of this action, used e.g.
Resource	getIcon() Returns the icon of this action.
Shortcut	getShortcut() Returns the associated shortcut of this action.
XdevUI	getUI() Returns the UI object which this action is associated with.
boolean	isEnabled() Returns the enabled state of the Action.
void	removePropertyChangeListener(PropertyChangeListener listener) Removes a PropertyChange listener.
void	setCaption(String caption) Sets the caption of this action, used e.g.
void	setDescription(String description) Sets the description of this action, used e.g.
void	setEnabled(boolean enabled) Sets the enabled state of the Action.
void	setIcon(Resource icon) Returns the icon of this action.
void	setShortcut(Shortcut shortcut) Sets the shortcut for this action.

Methods inherited from interface com.xdev.ui.event.ActionListener

actionPerformed

Field Detail

CAPTION_PROPERTY

static final String CAPTION_PROPERTY

Property name of the caption property.

See Also:

setCaption(String), Constant Field Values

ICON_PROPERTY

static final String ICON_PROPERTY

Property name of the icon property.

See Also:

setIcon(Resource), Constant Field Values

DESCRIPTION_PROPERTY

static final String DESCRIPTION_PROPERTY

Property name of the description property.

See Also:

setDescription(String), Constant Field Values

ENABLED_PROPERTY

static final String ENABLED_PROPERTY

Property name of the enabled property.

See Also:

setEnabled(boolean), Constant Field Values

SHORTCUT_PROPERTY

static final String SHORTCUT_PROPERTY

Property name of the shortcut property.

See Also:

setShortcut(Shortcut), Constant Field Values

Method Detail

addPropertyChangeListener

void addPropertyChangeListener(PropertyChangeListener listener)

Adds a PropertyChange listener. Containers and attached components use these methods to register interest in this Action object. When its enabled state or other property changes, the registered listeners are informed of the change.

Parameters:

listener - a PropertyChangeListener object

removePropertyChangeListener

void removePropertyChangeListener(PropertyChangeListener listener)

Removes a PropertyChange listener.

Parameters:

listener - a PropertyChangeListener object

See Also:

addPropertyChangeListener(java.beans.PropertyChangeListener)

getUI

XdevUI getUI()

Returns the UI object which this action is associated with.

Returns:

getCaption

String getCaption()

Returns the caption of this action, used e.g. as text for a XdevButton.

Returns:

the caption of this action

setCaption

void setCaption(String caption)

Sets the caption of this action, used e.g. as text for a XdevButton.

If the value has changed, a PropertyChangeEvent is sent to listeners.

Parameters:

caption - the new caption

See Also:

CAPTION_PROPERTY

getIcon

Resource getIcon()

Returns the icon of this action.

Returns:

setIcon

void setIcon(Resource icon)

Returns the icon of this action.

If the value has changed, a PropertyChangeEvent is sent to listeners.

Parameters:

icon - the icon of this action

See Also:

ICON_PROPERTY

getDescription

String getDescription()

Returns the caption of this action, used e.g. as tool tip text for a XdevButton.

Returns:

the caption of this action

setDescription

void setDescription(String description)

Sets the description of this action, used e.g. as tool tip text for a XdevButton.

If the value has changed, a PropertyChangeEvent is sent to listeners.

Parameters:

description - the new caption

See Also:

DESCRIPTION_PROPERTY

getShortcut

Shortcut getShortcut()

Returns the associated shortcut of this action.

Returns:

the shortcut of this action

setShortcut

void setShortcut(Shortcut shortcut)

Sets the shortcut for this action. When the according keys are pressed in the browser window, this action's ActionListener.actionPerformed(ActionEvent) method will be triggered, given that this action is enabled.

If the value has changed, a PropertyChangeEvent is sent to listeners.

The change of the shortcut will not reflect to already created components.

Parameters:

shortcut - the new shortcut

See Also:

SHORTCUT_PROPERTY

isEnabled

boolean isEnabled()

Returns the enabled state of the Action. When enabled, any component associated with this object is active and able to fire this object's actionPerformed method.

Returns:

true if this Action is enabled

setEnabled

void setEnabled(boolean enabled)

Sets the enabled state of the Action. When enabled, any component associated with this object is active and able to fire this object's actionPerformed method.

If the value has changed, a PropertyChangeEvent is sent to listeners.

Parameters:

enabled - true to enable this Action, false to disable it

See Also:

ENABLED_PROPERTY