com.plealog.genericapp.ui.menu

Class EZBasicAction

java.lang.Object

javax.swing.AbstractAction

com.plealog.genericapp.ui.menu.EZBasicAction

All Implemented Interfaces:

ActionListener, Serializable, Cloneable, EventListener, Action

public class EZBasicAction
extends AbstractAction

Implementation of an AbstractAction for EZMenu system. In addition to the standard AbstractAction capabilities, this action may have a user object and implements a default behavior for method actionPerformed(): it fires a property change. The name of the property if the one returned by this.getKeyName().

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	GLOBAL_UPDT_PROP property name used by this.fireUpdate().

Fields inherited from class javax.swing.AbstractAction

changeSupport, enabled

Fields inherited from interface javax.swing.Action

ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, DISPLAYED_MNEMONIC_INDEX_KEY, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SMALL_ICON

Constructor Summary

Constructors

Constructor and Description
EZBasicAction() Default constructor.
EZBasicAction(Object usrObject) Construction with a user object.
EZBasicAction(Object usrObject, String name) Basic constructor with a user object and a key name.
EZBasicAction(Object usrObject, String name, Icon icon) Basic constructor with a user object, a key name and an icon.
EZBasicAction(String name) Basic constructor with a key name.
EZBasicAction(String name, Icon icon) Basic constructor a key name and an icon.

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent e) Implementation of AbstractAction method.
protected void	fireUpdate() Sends an update notification message to this action property change listeners.
protected String	getClassNameWithoutPackage(Class<?> cl)
String	getKeyName() Returns the key name of the action.
Object	getUserObject() Returns the user object associated to this action.
boolean	isValidForThisOsMenu() Figures out if this Action can be displayed in Menus for the current OS.
void	setKeyName(String name) Sets the key name of this action.
void	setUserObject(Object usrObject) Sets the user object.
void	update() Enable or disable this action.
void	validForThisOsMenu(boolean b) Sets whether or not this Action can be displayed in Menus for the current OS.

Methods inherited from class javax.swing.AbstractAction

addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from class java.lang.Object

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

Field Detail

GLOBAL_UPDT_PROP

public static final String GLOBAL_UPDT_PROP

property name used by this.fireUpdate().

See Also:

Constant Field Values

Constructor Detail

EZBasicAction

public EZBasicAction()

Default constructor.

EZBasicAction

public EZBasicAction(Object usrObject)

Construction with a user object.

EZBasicAction

public EZBasicAction(String name)

Basic constructor with a key name.

EZBasicAction

public EZBasicAction(Object usrObject,
             String name)

Basic constructor with a user object and a key name.

EZBasicAction

public EZBasicAction(Object usrObject,
             String name,
             Icon icon)

Basic constructor with a user object, a key name and an icon.

EZBasicAction

public EZBasicAction(String name,
             Icon icon)

Basic constructor a key name and an icon.

Method Detail

getClassNameWithoutPackage

protected String getClassNameWithoutPackage(Class<?> cl)

getKeyName

public String getKeyName()

Returns the key name of the action. This is that name that is used by EZActionManager to store this Action in the ActionMap.

setKeyName

public void setKeyName(String name)

Sets the key name of this action.

update

public void update()

Enable or disable this action. Default implementation disables this action if user object is null.

setUserObject

public void setUserObject(Object usrObject)

Sets the user object.

getUserObject

public Object getUserObject()

Returns the user object associated to this action.

validForThisOsMenu

public void validForThisOsMenu(boolean b)

Sets whether or not this Action can be displayed in Menus for the current OS.

isValidForThisOsMenu

public boolean isValidForThisOsMenu()

Figures out if this Action can be displayed in Menus for the current OS.

fireUpdate

protected void fireUpdate()

Sends an update notification message to this action property change listeners. In the fired event, property name is set to EZBasicAction.GLOBAL_UPDT_PROP, and both new and old values are set to null.

actionPerformed

public void actionPerformed(ActionEvent e)

Implementation of AbstractAction method. This default implementation fires a property change with property name sets to this.getKeyName(), old value sets to null and new value sets to ActionEvent 'e'.