org.softsmithy.lib.swing.action

Class AbstractXAction

java.lang.Object

javax.swing.AbstractAction

org.softsmithy.lib.swing.action.AbstractXAction

All Implemented Interfaces:

ActionListener, Serializable, Cloneable, EventListener, Action, XAction

Direct Known Subclasses:

DefaultXAction, ReflectiveXAction

public abstract class AbstractXAction
extends AbstractAction
implements XAction

This class provides defaul implementations for the XAction interface.
Note: The API may change in a future version!
Note: Eventually this belongs to the javax.swing.Action interface.

Author:

Florian Brunner

See Also:

Serialized Form

Field Summary

Fields inherited from class javax.swing.AbstractAction

changeSupport, enabled

Fields inherited from interface org.softsmithy.lib.swing.action.XAction

LARGE_DISABLED_ICON, LARGE_DISABLED_SELECTED_ICON, LARGE_ICON, LARGE_PRESSED_ICON, LARGE_ROLLOVER_ICON, LARGE_ROLLOVER_SELECTED_ICON, LARGE_SELECTED_ICON, SMALL_DISABLED_ICON, SMALL_DISABLED_SELECTED_ICON, SMALL_PRESSED_ICON, SMALL_ROLLOVER_ICON, SMALL_ROLLOVER_SELECTED_ICON, SMALL_SELECTED_ICON

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
AbstractXAction() Creates an empty AbstractXAction.

Method Summary

Modifier and Type	Method and Description
KeyStroke	getAccelerator() Gets the value from the key Action.ACCELERATOR_KEY
String	getActionCommand() Gets the value from the key Action.ACTION_COMMAND_KEY
Icon	getLargeDisabledIcon() Gets the value from the key XAction.LARGE_DISABLED_ICON
Icon	getLargeDisabledSelectedIcon() Gets the value from the key XAction.LARGE_DISABLED_SELECTED_ICON
Icon	getLargeIcon() Gets the value from the key XAction.LARGE_ICON
Icon	getLargePressedIcon() Gets the value from the key XAction.LARGE_PRESSED_ICON
Icon	getLargeRolloverIcon() Gets the value from the key XAction.LARGE_ROLLOVER_ICON
Icon	getLargeRolloverSelectedIcon() Gets the value from the key XAction.LARGE_ROLLOVER_SELECTED_ICON
Icon	getLargeSelectedIcon() Gets the value from the key XAction.LARGE_SELECTED_ICON
String	getLongDescription() Gets the value from the key Action.LONG_DESCRIPTION
int	getMnemonicKey() Gets the value from the key Action.MNEMONIC_KEY
String	getName() Gets the value from the key Action.NAME
String	getShortDescription() Gets the value from the key Action.SHORT_DESCRIPTION
Icon	getSmallDisabledIcon() Gets the value from the key XAction.SMALL_DISABLED_ICON
Icon	getSmallDisabledSelectedIcon() Gets the value from the key XAction.SMALL_DISABLED_SELECTED_ICON
Icon	getSmallIcon() Gets the value from the key Action.SMALL_ICON
Icon	getSmallPressedIcon() Gets the value from the key XAction.SMALL_PRESSED_ICON
Icon	getSmallRolloverIcon() Gets the value from the key XAction.SMALL_ROLLOVER_ICON
Icon	getSmallRolloverSelectedIcon() Gets the value from the key XAction.SMALL_ROLLOVER_SELECTED_ICON
Icon	getSmallSelectedIcon() Gets the value from the key XAction.SMALL_SELECTED_ICON
void	setAccelerator(KeyStroke keyStroke) Sets the value for the key Action.ACCELERATOR_KEY
void	setActionCommand(String actionCommand) Sets the value for the key Action.ACTION_COMMAND_KEY
void	setLargeDisabledIcon(Icon icon) Sets the value for the key XAction.LARGE_DISABLED_ICON
void	setLargeDisabledSelectedIcon(Icon icon) Sets the value for the key XAction.LARGE_DISABLED_SELECTED_ICON
void	setLargeIcon(Icon icon) Sets the value for the key XAction.LARGE_ICON
void	setLargePressedIcon(Icon icon) Sets the value for the key XAction.LARGE_PRESSED_ICON
void	setLargeRolloverIcon(Icon icon) Sets the value for the key XAction.LARGE_ROLLOVER_ICON
void	setLargeRolloverSelectedIcon(Icon icon) Sets the value for the key XAction.LARGE_ROLLOVER_SELECTED_ICON
void	setLargeSelectedIcon(Icon icon) Sets the value for the key XAction.LARGE_SELECTED_ICON
void	setLongDescription(String longDescription) Sets the value for the key Action.LONG_DESCRIPTION
void	setMnemonicKey(int mnemonicKey) Sets the value for the key Action.MNEMONIC_KEY
void	setName(String name) Sets the value for the key Action.NAME
void	setShortDescription(String shortDescription) Sets the value for the key Action.SHORT_DESCRIPTION
void	setSmallDisabledIcon(Icon icon) Sets the value for the key XAction.SMALL_DISABLED_ICON
void	setSmallDisabledSelectedIcon(Icon icon) Sets the value for the key XAction.SMALL_DISABLED_SELECTED_ICON
void	setSmallIcon(Icon icon) Sets the value for the key Action.SMALL_ICON
void	setSmallPressedIcon(Icon icon) Sets the value for the key XAction.SMALL_PRESSED_ICON
void	setSmallRolloverIcon(Icon icon) Sets the value for the key XAction.SMALL_ROLLOVER_ICON
void	setSmallRolloverSelectedIcon(Icon icon) Sets the value for the key XAction.SMALL_ROLLOVER_SELECTED_ICON
void	setSmallSelectedIcon(Icon icon) Sets the value for the key XAction.SMALL_SELECTED_ICON

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

Methods inherited from interface javax.swing.Action

addPropertyChangeListener, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from interface java.awt.event.ActionListener

actionPerformed

Constructor Detail

AbstractXAction

public AbstractXAction()

Creates an empty AbstractXAction.

Method Detail

getAccelerator

public KeyStroke getAccelerator()

Gets the value from the key Action.ACCELERATOR_KEY

Specified by:

getAccelerator in interface XAction

Returns:

the accelerator

setAccelerator

public void setAccelerator(KeyStroke keyStroke)

Sets the value for the key Action.ACCELERATOR_KEY

Specified by:

setAccelerator in interface XAction

Parameters:

keyStroke - The new accelerator value

getActionCommand

public String getActionCommand()

Gets the value from the key Action.ACTION_COMMAND_KEY

Specified by:

getActionCommand in interface XAction

Returns:

the action command

setActionCommand

public void setActionCommand(String actionCommand)

Sets the value for the key Action.ACTION_COMMAND_KEY

Specified by:

setActionCommand in interface XAction

Parameters:

actionCommand - the action command

getLargeDisabledIcon

public Icon getLargeDisabledIcon()

Gets the value from the key XAction.LARGE_DISABLED_ICON

Specified by:

getLargeDisabledIcon in interface XAction

Returns:

the large disabled icon

setLargeDisabledIcon

public void setLargeDisabledIcon(Icon icon)

Sets the value for the key XAction.LARGE_DISABLED_ICON

Specified by:

setLargeDisabledIcon in interface XAction

Parameters:

icon - the large disabled icon

getLargeDisabledSelectedIcon

public Icon getLargeDisabledSelectedIcon()

Gets the value from the key XAction.LARGE_DISABLED_SELECTED_ICON

Specified by:

getLargeDisabledSelectedIcon in interface XAction

Returns:

the large disabled selected icon

setLargeDisabledSelectedIcon

public void setLargeDisabledSelectedIcon(Icon icon)

Sets the value for the key XAction.LARGE_DISABLED_SELECTED_ICON

Specified by:

setLargeDisabledSelectedIcon in interface XAction

Parameters:

icon - the large disabled selected icon

getLargeIcon

public Icon getLargeIcon()

Gets the value from the key XAction.LARGE_ICON

Specified by:

getLargeIcon in interface XAction

Returns:

the large icon

setLargeIcon

public void setLargeIcon(Icon icon)

Sets the value for the key XAction.LARGE_ICON

Specified by:

setLargeIcon in interface XAction

Parameters:

icon - the large icon

getLargePressedIcon

public Icon getLargePressedIcon()

Gets the value from the key XAction.LARGE_PRESSED_ICON

Specified by:

getLargePressedIcon in interface XAction

Returns:

the large pressed icon value

setLargePressedIcon

public void setLargePressedIcon(Icon icon)

Sets the value for the key XAction.LARGE_PRESSED_ICON

Specified by:

setLargePressedIcon in interface XAction

Parameters:

icon - the large pressed icon

getLargeRolloverIcon

public Icon getLargeRolloverIcon()

Gets the value from the key XAction.LARGE_ROLLOVER_ICON

Specified by:

getLargeRolloverIcon in interface XAction

Returns:

the large rollover icon

setLargeRolloverIcon

public void setLargeRolloverIcon(Icon icon)

Sets the value for the key XAction.LARGE_ROLLOVER_ICON

Specified by:

setLargeRolloverIcon in interface XAction

Parameters:

icon - the large rollover icon

getLargeRolloverSelectedIcon

public Icon getLargeRolloverSelectedIcon()

Gets the value from the key XAction.LARGE_ROLLOVER_SELECTED_ICON

Specified by:

getLargeRolloverSelectedIcon in interface XAction

Returns:

the large rollover selected icon

setLargeRolloverSelectedIcon

public void setLargeRolloverSelectedIcon(Icon icon)

Sets the value for the key XAction.LARGE_ROLLOVER_SELECTED_ICON

Specified by:

setLargeRolloverSelectedIcon in interface XAction

Parameters:

icon - the large rollover selected icon

getLargeSelectedIcon

public Icon getLargeSelectedIcon()

Gets the value from the key XAction.LARGE_SELECTED_ICON

Specified by:

getLargeSelectedIcon in interface XAction

Returns:

the large selected icon

setLargeSelectedIcon

public void setLargeSelectedIcon(Icon icon)

Sets the value for the key XAction.LARGE_SELECTED_ICON

Specified by:

setLargeSelectedIcon in interface XAction

Parameters:

icon - the large selected icon

getLongDescription

public String getLongDescription()

Gets the value from the key Action.LONG_DESCRIPTION

Specified by:

getLongDescription in interface XAction

Returns:

the long description

setLongDescription

public void setLongDescription(String longDescription)

Sets the value for the key Action.LONG_DESCRIPTION

Specified by:

setLongDescription in interface XAction

Parameters:

longDescription - the long description

getMnemonicKey

public int getMnemonicKey()

Gets the value from the key Action.MNEMONIC_KEY

Specified by:

getMnemonicKey in interface XAction

Returns:

the menmonic key as an int value defined by KeyEvent

setMnemonicKey

public void setMnemonicKey(int mnemonicKey)

Sets the value for the key Action.MNEMONIC_KEY

Specified by:

setMnemonicKey in interface XAction

Parameters:

mnemonicKey - The new mnemonicKey value

getName

public String getName()

Gets the value from the key Action.NAME

Specified by:

getName in interface XAction

Returns:

the name

setName

public void setName(String name)

Sets the value for the key Action.NAME

Specified by:

setName in interface XAction

Parameters:

name - the name

getShortDescription

public String getShortDescription()

Gets the value from the key Action.SHORT_DESCRIPTION

Specified by:

getShortDescription in interface XAction

Returns:

the short description

setShortDescription

public void setShortDescription(String shortDescription)

Sets the value for the key Action.SHORT_DESCRIPTION

Specified by:

setShortDescription in interface XAction

Parameters:

shortDescription - the short description

getSmallDisabledIcon

public Icon getSmallDisabledIcon()

Gets the value from the key XAction.SMALL_DISABLED_ICON

Specified by:

getSmallDisabledIcon in interface XAction

Returns:

the small disabled icon

setSmallDisabledIcon

public void setSmallDisabledIcon(Icon icon)

Sets the value for the key XAction.SMALL_DISABLED_ICON

Specified by:

setSmallDisabledIcon in interface XAction

Parameters:

icon - the small disabled icon

getSmallDisabledSelectedIcon

public Icon getSmallDisabledSelectedIcon()

Gets the value from the key XAction.SMALL_DISABLED_SELECTED_ICON

Specified by:

getSmallDisabledSelectedIcon in interface XAction

Returns:

the small disabled selected icon

setSmallDisabledSelectedIcon

public void setSmallDisabledSelectedIcon(Icon icon)

Sets the value for the key XAction.SMALL_DISABLED_SELECTED_ICON

Specified by:

setSmallDisabledSelectedIcon in interface XAction

Parameters:

icon - the small disabled selected icon

getSmallIcon

public Icon getSmallIcon()

Gets the value from the key Action.SMALL_ICON

Specified by:

getSmallIcon in interface XAction

Returns:

the small icon

setSmallIcon

public void setSmallIcon(Icon icon)

Sets the value for the key Action.SMALL_ICON

Specified by:

setSmallIcon in interface XAction

Parameters:

icon - the small icon

getSmallPressedIcon

public Icon getSmallPressedIcon()

Gets the value from the key XAction.SMALL_PRESSED_ICON

Specified by:

getSmallPressedIcon in interface XAction

Returns:

the small pressed icon

setSmallPressedIcon

public void setSmallPressedIcon(Icon icon)

Sets the value for the key XAction.SMALL_PRESSED_ICON

Specified by:

setSmallPressedIcon in interface XAction

Parameters:

icon - the small pressed icon

getSmallRolloverIcon

public Icon getSmallRolloverIcon()

Gets the value from the key XAction.SMALL_ROLLOVER_ICON

Specified by:

getSmallRolloverIcon in interface XAction

Returns:

the small rollover icon

setSmallRolloverIcon

public void setSmallRolloverIcon(Icon icon)

Sets the value for the key XAction.SMALL_ROLLOVER_ICON

Specified by:

setSmallRolloverIcon in interface XAction

Parameters:

icon - the small rollover icon

getSmallRolloverSelectedIcon

public Icon getSmallRolloverSelectedIcon()

Gets the value from the key XAction.SMALL_ROLLOVER_SELECTED_ICON

Specified by:

getSmallRolloverSelectedIcon in interface XAction

Returns:

the small rollover selected icon

setSmallRolloverSelectedIcon

public void setSmallRolloverSelectedIcon(Icon icon)

Sets the value for the key XAction.SMALL_ROLLOVER_SELECTED_ICON

Specified by:

setSmallRolloverSelectedIcon in interface XAction

Parameters:

icon - the small rollover selected icon

getSmallSelectedIcon

public Icon getSmallSelectedIcon()

Gets the value from the key XAction.SMALL_SELECTED_ICON

Specified by:

getSmallSelectedIcon in interface XAction

Returns:

the small selected icon

setSmallSelectedIcon

public void setSmallSelectedIcon(Icon icon)

Sets the value for the key XAction.SMALL_SELECTED_ICON

Specified by:

setSmallSelectedIcon in interface XAction

Parameters:

icon - the small selected icon