XAction (SoftSmithy Utility Library

All Superinterfaces:

Action, ActionListener, EventListener

All Known Subinterfaces:

CustomizerAction

All Known Implementing Classes:

AbstractXAction, DefaultCustomizerAction, DefaultXAction, ReflectiveCustomizerAction, ReflectiveXAction, XActionWrapper
```
public interface XAction
extends Action
```
XAction extends Action by defining more property keys and convenience methods.
Note: The API may change in a future version!
Note: Eventually this belongs to the javax.swing.Action interface.

Author:

Florian Brunner

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`LARGE_DISABLED_ICON` The key used for storing a large icon for the disabled action.
`static String`	`LARGE_DISABLED_SELECTED_ICON` The key used for storing a large icon for the disabled and selected action.
`static String`	`LARGE_ICON` The key used for storing a large icon for the action.
`static String`	`LARGE_PRESSED_ICON` The key used for storing a large icon for the pressed action.
`static String`	`LARGE_ROLLOVER_ICON` The key used for storing a large icon for the action duricng rollover.
`static String`	`LARGE_ROLLOVER_SELECTED_ICON` The key used for storing a large icon for the selected action during rollover.
`static String`	`LARGE_SELECTED_ICON` The key used for storing a large icon for the selected action.
`static String`	`SMALL_DISABLED_ICON` The key used for storing a small icon for the disabled action.
`static String`	`SMALL_DISABLED_SELECTED_ICON` The key used for storing a small icon for the disabled and selected action.
`static String`	`SMALL_PRESSED_ICON` The key used for storing a small icon for the pressed action.
`static String`	`SMALL_ROLLOVER_ICON` The key used for storing a small icon for the action during rollover.
`static String`	`SMALL_ROLLOVER_SELECTED_ICON` The key used for storing a small icon for the selected action during rollover.
`static String`	`SMALL_SELECTED_ICON` The key used for storing a small icon for the selected action.

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

Method Summary

All Methods Instance Methods Abstract Methods
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 accelerator)` 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 menmonicKey)` 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 interface javax.swing.Action
addPropertyChangeListener, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from interface java.awt.event.ActionListener
actionPerformed

- Field Detail
  - LARGE_DISABLED_ICON
```
static final String LARGE_DISABLED_ICON
```
    The key used for storing a large icon for the disabled action.
    
    See Also:
    
    Constant Field Values
  - LARGE_DISABLED_SELECTED_ICON
```
static final String LARGE_DISABLED_SELECTED_ICON
```
    The key used for storing a large icon for the disabled and selected action.
    
    See Also:
    
    Constant Field Values
  - LARGE_ICON
```
static final String LARGE_ICON
```
    The key used for storing a large icon for the action.
    
    See Also:
    
    Constant Field Values
  - LARGE_PRESSED_ICON
```
static final String LARGE_PRESSED_ICON
```
    The key used for storing a large icon for the pressed action.
    
    See Also:
    
    Constant Field Values
  - LARGE_ROLLOVER_ICON
```
static final String LARGE_ROLLOVER_ICON
```
    The key used for storing a large icon for the action duricng rollover.
    
    See Also:
    
    Constant Field Values
  - LARGE_ROLLOVER_SELECTED_ICON
```
static final String LARGE_ROLLOVER_SELECTED_ICON
```
    The key used for storing a large icon for the selected action during rollover.
    
    See Also:
    
    Constant Field Values
  - LARGE_SELECTED_ICON
```
static final String LARGE_SELECTED_ICON
```
    The key used for storing a large icon for the selected action.
    
    See Also:
    
    Constant Field Values
  - SMALL_DISABLED_ICON
```
static final String SMALL_DISABLED_ICON
```
    The key used for storing a small icon for the disabled action.
    
    See Also:
    
    Constant Field Values
  - SMALL_DISABLED_SELECTED_ICON
```
static final String SMALL_DISABLED_SELECTED_ICON
```
    The key used for storing a small icon for the disabled and selected action.
    
    See Also:
    
    Constant Field Values
  - SMALL_PRESSED_ICON
```
static final String SMALL_PRESSED_ICON
```
    The key used for storing a small icon for the pressed action.
    
    See Also:
    
    Constant Field Values
  - SMALL_ROLLOVER_ICON
```
static final String SMALL_ROLLOVER_ICON
```
    The key used for storing a small icon for the action during rollover.
    
    See Also:
    
    Constant Field Values
  - SMALL_ROLLOVER_SELECTED_ICON
```
static final String SMALL_ROLLOVER_SELECTED_ICON
```
    The key used for storing a small icon for the selected action during rollover.
    
    See Also:
    
    Constant Field Values
  - SMALL_SELECTED_ICON
```
static final String SMALL_SELECTED_ICON
```
    The key used for storing a small icon for the selected action.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getAccelerator
```
KeyStroke getAccelerator()
```
    Gets the value from the key Action.ACCELERATOR_KEY
    
    Returns:
    
    the accelerator
  - setAccelerator
```
void setAccelerator(KeyStroke accelerator)
```
    Sets the value for the key Action.ACCELERATOR_KEY
    
    Parameters:
    
    accelerator - The new accelerator value
  - getActionCommand
```
String getActionCommand()
```
    Gets the value from the key Action.ACTION_COMMAND_KEY
    
    Returns:
    
    the action command
  - setActionCommand
```
void setActionCommand(String actionCommand)
```
    Sets the value for the key Action.ACTION_COMMAND_KEY
    
    Parameters:
    
    actionCommand - the action command
  - getLargeDisabledIcon
```
Icon getLargeDisabledIcon()
```
    Gets the value from the key XAction.LARGE_DISABLED_ICON
    
    Returns:
    
    the large disabled icon
  - setLargeDisabledIcon
```
void setLargeDisabledIcon(Icon icon)
```
    Sets the value for the key XAction.LARGE_DISABLED_ICON
    
    Parameters:
    
    icon - the large disabled icon
  - getLargeDisabledSelectedIcon
```
Icon getLargeDisabledSelectedIcon()
```
    Gets the value from the key XAction.LARGE_DISABLED_SELECTED_ICON
    
    Returns:
    
    the large disabled selected icon
  - setLargeDisabledSelectedIcon
```
void setLargeDisabledSelectedIcon(Icon icon)
```
    Sets the value for the key XAction.LARGE_DISABLED_SELECTED_ICON
    
    Parameters:
    
    icon - the large disabled selected icon
  - getLargeIcon
```
Icon getLargeIcon()
```
    Gets the value from the key XAction.LARGE_ICON
    
    Returns:
    
    the large icon
  - setLargeIcon
```
void setLargeIcon(Icon icon)
```
    Sets the value for the key XAction.LARGE_ICON
    
    Parameters:
    
    icon - the large icon
  - getLargePressedIcon
```
Icon getLargePressedIcon()
```
    Gets the value from the key XAction.LARGE_PRESSED_ICON
    
    Returns:
    
    the large pressed icon value
  - setLargePressedIcon
```
void setLargePressedIcon(Icon icon)
```
    Sets the value for the key XAction.LARGE_PRESSED_ICON
    
    Parameters:
    
    icon - the large pressed icon
  - getLargeRolloverIcon
```
Icon getLargeRolloverIcon()
```
    Gets the value from the key XAction.LARGE_ROLLOVER_ICON
    
    Returns:
    
    the large rollover icon
  - setLargeRolloverIcon
```
void setLargeRolloverIcon(Icon icon)
```
    Sets the value for the key XAction.LARGE_ROLLOVER_ICON
    
    Parameters:
    
    icon - the large rollover icon
  - getLargeRolloverSelectedIcon
```
Icon getLargeRolloverSelectedIcon()
```
    Gets the value from the key XAction.LARGE_ROLLOVER_SELECTED_ICON
    
    Returns:
    
    the large rollover selected icon
  - setLargeRolloverSelectedIcon
```
void setLargeRolloverSelectedIcon(Icon icon)
```
    Sets the value for the key XAction.LARGE_ROLLOVER_SELECTED_ICON
    
    Parameters:
    
    icon - the large rollover selected icon
  - getLargeSelectedIcon
```
Icon getLargeSelectedIcon()
```
    Gets the value from the key XAction.LARGE_SELECTED_ICON
    
    Returns:
    
    the large selected icon
  - setLargeSelectedIcon
```
void setLargeSelectedIcon(Icon icon)
```
    Sets the value for the key XAction.LARGE_SELECTED_ICON
    
    Parameters:
    
    icon - the large selected icon
  - getLongDescription
```
String getLongDescription()
```
    Gets the value from the key Action.LONG_DESCRIPTION
    
    Returns:
    
    the long description
  - setLongDescription
```
void setLongDescription(String longDescription)
```
    Sets the value for the key Action.LONG_DESCRIPTION
    
    Parameters:
    
    longDescription - the long description
  - getMnemonicKey
```
int getMnemonicKey()
```
    Gets the value from the key Action.MNEMONIC_KEY
    
    Returns:
    
    the menmonic key as an int value defined by KeyEvent
  - setMnemonicKey
```
void setMnemonicKey(int menmonicKey)
```
    Sets the value for the key Action.MNEMONIC_KEY
    
    Parameters:
    
    menmonicKey - The new mnemonicKey value
  - getName
```
String getName()
```
    Gets the value from the key Action.NAME
    
    Returns:
    
    the name
  - setName
```
void setName(String name)
```
    Sets the value for the key Action.NAME
    
    Parameters:
    
    name - the name
  - getShortDescription
```
String getShortDescription()
```
    Gets the value from the key Action.SHORT_DESCRIPTION
    
    Returns:
    
    the short description
  - setShortDescription
```
void setShortDescription(String shortDescription)
```
    Sets the value for the key Action.SHORT_DESCRIPTION
    
    Parameters:
    
    shortDescription - the short description
  - getSmallDisabledIcon
```
Icon getSmallDisabledIcon()
```
    Gets the value from the key XAction.SMALL_DISABLED_ICON
    
    Returns:
    
    the small disabled icon
  - setSmallDisabledIcon
```
void setSmallDisabledIcon(Icon icon)
```
    Sets the value for the key XAction.SMALL_DISABLED_ICON
    
    Parameters:
    
    icon - the small disabled icon
  - getSmallDisabledSelectedIcon
```
Icon getSmallDisabledSelectedIcon()
```
    Gets the value from the key XAction.SMALL_DISABLED_SELECTED_ICON
    
    Returns:
    
    the small disabled selected icon
  - setSmallDisabledSelectedIcon
```
void setSmallDisabledSelectedIcon(Icon icon)
```
    Sets the value for the key XAction.SMALL_DISABLED_SELECTED_ICON
    
    Parameters:
    
    icon - the small disabled selected icon
  - getSmallIcon
```
Icon getSmallIcon()
```
    Gets the value from the key Action.SMALL_ICON
    
    Returns:
    
    the small icon
  - setSmallIcon
```
void setSmallIcon(Icon icon)
```
    Sets the value for the key Action.SMALL_ICON
    
    Parameters:
    
    icon - the small icon
  - getSmallPressedIcon
```
Icon getSmallPressedIcon()
```
    Gets the value from the key XAction.SMALL_PRESSED_ICON
    
    Returns:
    
    the small pressed icon
  - setSmallPressedIcon
```
void setSmallPressedIcon(Icon icon)
```
    Sets the value for the key XAction.SMALL_PRESSED_ICON
    
    Parameters:
    
    icon - the small pressed icon
  - getSmallRolloverIcon
```
Icon getSmallRolloverIcon()
```
    Gets the value from the key XAction.SMALL_ROLLOVER_ICON
    
    Returns:
    
    the small rollover icon
  - setSmallRolloverIcon
```
void setSmallRolloverIcon(Icon icon)
```
    Sets the value for the key XAction.SMALL_ROLLOVER_ICON
    
    Parameters:
    
    icon - the small rollover icon
  - getSmallRolloverSelectedIcon
```
Icon getSmallRolloverSelectedIcon()
```
    Gets the value from the key XAction.SMALL_ROLLOVER_SELECTED_ICON
    
    Returns:
    
    the small rollover selected icon
  - setSmallRolloverSelectedIcon
```
void setSmallRolloverSelectedIcon(Icon icon)
```
    Sets the value for the key XAction.SMALL_ROLLOVER_SELECTED_ICON
    
    Parameters:
    
    icon - the small rollover selected icon
  - getSmallSelectedIcon
```
Icon getSmallSelectedIcon()
```
    Gets the value from the key XAction.SMALL_SELECTED_ICON
    
    Returns:
    
    the small selected icon
  - setSmallSelectedIcon
```
void setSmallSelectedIcon(Icon icon)
```
    Sets the value for the key XAction.SMALL_SELECTED_ICON
    
    Parameters:
    
    icon - the small selected icon

Interface XAction

Field Summary

Fields inherited from interface javax.swing.Action

Method Summary

Methods inherited from interface javax.swing.Action

Methods inherited from interface java.awt.event.ActionListener

Field Detail

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

Method Detail

getAccelerator

setAccelerator

getActionCommand

setActionCommand

getLargeDisabledIcon

setLargeDisabledIcon

getLargeDisabledSelectedIcon

setLargeDisabledSelectedIcon

getLargeIcon

setLargeIcon

getLargePressedIcon

setLargePressedIcon

getLargeRolloverIcon

setLargeRolloverIcon

getLargeRolloverSelectedIcon

setLargeRolloverSelectedIcon

getLargeSelectedIcon

setLargeSelectedIcon

getLongDescription

setLongDescription

getMnemonicKey

setMnemonicKey

getName

setName

getShortDescription

setShortDescription

getSmallDisabledIcon

setSmallDisabledIcon

getSmallDisabledSelectedIcon

setSmallDisabledSelectedIcon

getSmallIcon

setSmallIcon

getSmallPressedIcon

setSmallPressedIcon

getSmallRolloverIcon

setSmallRolloverIcon

getSmallRolloverSelectedIcon

setSmallRolloverSelectedIcon

getSmallSelectedIcon

setSmallSelectedIcon