com.xdev.ui.action

Class AbstractAction

java.lang.Object

com.xdev.ui.action.AbstractAction

All Implemented Interfaces:

Action, ActionListener, EventListener

Direct Known Subclasses:

AbstractToggleAction, ContextSensitiveAction

public abstract class AbstractAction
extends Object
implements Action

This class provides default implementations for the Action interface.

Standard behaviors like the get and set methods for Action object properties (icon, caption, enabled, ...) are defined here. The developer need only subclass this abstract class and define the ActionListener.actionPerformed(ActionEvent) method.

Author:

XDEV Software

Field Summary

Fields inherited from interface com.xdev.ui.action.Action

CAPTION_PROPERTY, DESCRIPTION_PROPERTY, ENABLED_PROPERTY, ICON_PROPERTY, SHORTCUT_PROPERTY

Constructor Summary

Constructors

Constructor and Description
AbstractAction(XdevUI ui) Creates an Action.
AbstractAction(XdevUI ui, Resource icon) Creates an Action with the specified icon.
AbstractAction(XdevUI ui, String caption) Creates an Action with the specified caption.
AbstractAction(XdevUI ui, String caption, Resource icon) Creates an Action with the specified caption and icon.

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 class java.lang.Object

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

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

actionPerformed

Constructor Detail

AbstractAction

public AbstractAction(XdevUI ui)

Creates an Action.

AbstractAction

public AbstractAction(XdevUI ui,
                      String caption)

Creates an Action with the specified caption.

AbstractAction

public AbstractAction(XdevUI ui,
                      Resource icon)

Creates an Action with the specified icon.

AbstractAction

public AbstractAction(XdevUI ui,
                      String caption,
                      Resource icon)

Creates an Action with the specified caption and icon.

Method Detail

addPropertyChangeListener

public 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.

Specified by:

addPropertyChangeListener in interface Action

Parameters:

listener - a PropertyChangeListener object

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

Removes a PropertyChange listener.

Specified by:

removePropertyChangeListener in interface Action

Parameters:

listener - a PropertyChangeListener object

See Also:

Action.addPropertyChangeListener(java.beans.PropertyChangeListener)

getUI

public XdevUI getUI()

Returns the UI object which this action is associated with.

Specified by:

getUI in interface Action

Returns:

getCaption

public String getCaption()

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

Specified by:

getCaption in interface Action

Returns:

the caption of this action

setCaption

public 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.

Specified by:

setCaption in interface Action

Parameters:

caption - the new caption

See Also:

Action.CAPTION_PROPERTY

getIcon

public Resource getIcon()

Returns the icon of this action.

Specified by:

getIcon in interface Action

Returns:

setIcon

public void setIcon(Resource icon)

Returns the icon of this action.

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

Specified by:

setIcon in interface Action

Parameters:

icon - the icon of this action

See Also:

Action.ICON_PROPERTY

getDescription

public String getDescription()

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

Specified by:

getDescription in interface Action

Returns:

the caption of this action

setDescription

public 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.

Specified by:

setDescription in interface Action

Parameters:

description - the new caption

See Also:

Action.DESCRIPTION_PROPERTY

getShortcut

public Shortcut getShortcut()

Returns the associated shortcut of this action.

Specified by:

getShortcut in interface Action

Returns:

the shortcut of this action

setShortcut

public 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.

Specified by:

setShortcut in interface Action

Parameters:

shortcut - the new shortcut

See Also:

Action.SHORTCUT_PROPERTY

isEnabled

public 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.

Specified by:

isEnabled in interface Action

Returns:

true if this Action is enabled

setEnabled

public 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.

Specified by:

setEnabled in interface Action

Parameters:

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

See Also:

Action.ENABLED_PROPERTY