Action (SSHTOOLS UI 3.1.0 API)

All Superinterfaces:

ActionListener, EventListener

All Known Implementing Classes:

AbstractAction
```
public interface Action
extends ActionListener
```
An extended ActionListener for AWT.

Author:

$Author: brett $

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACCELERATOR_KEY` Key used for storing a `KeyStroke` for the accelerator for the action.
`static String`	`ACTION_COMMAND_KEY`
`static String`	`HIDE_TOOLBAR_TEXT` `Boolean` value to specify if text should be shown when this action is used to build components for an `ActionBar`
`static String`	`IMAGE_PATH` Key for a `String` value to specify the resource name for the icon
`static String`	`LONG_DESCRIPTION` Key for storing a long description for the action.
`static String`	`MNEMONIC_KEY` Key for storing an `Integer` object to be used as the mnemonic for the action.
`static String`	`NAME` Key used for storing the action name
`static String`	`SHORT_DESCRIPTION` Key for a short description for the action, used for tooltip text.
`static String`	`SMALL_IMAGE_PATH` Key for a `String` value to specify the resource name for the small icon

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addPropertyChangeListener(PropertyChangeListener l)` Add a `PropertyChangeListener` that will be notified when either a value changes or the enabled state changes
`String`	`getName()` Return the name of the action.
`Object`	`getValue(String key)` Actions can have any number of attributes, each referenced by a key (a string).
`boolean`	`isEnabled()` Get if the component(s) that were built from this action should be enabled or not.
`void`	`putValue(String key, Object value)` Actions can have any number of attributes, each referenced by a key (a string).
`void`	`removePropertyChangeListener(PropertyChangeListener l)` Remove a `PropertyChangeListener` from the list that will be notified when either a value changes or the enabled state changes
`void`	`setEnabled(boolean enabled)` Set if the component(s) that were built from this action should be enabled or not.

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

- Field Detail
  - NAME
```
static final String NAME
```
    Key used for storing the action name
    
    See Also:
    
    Constant Field Values
  - SHORT_DESCRIPTION
```
static final String SHORT_DESCRIPTION
```
    Key for a short description for the action, used for tooltip text.
    
    See Also:
    
    Constant Field Values
  - LONG_DESCRIPTION
```
static final String LONG_DESCRIPTION
```
    Key for storing a long description for the action.
    
    See Also:
    
    Constant Field Values
  - ACTION_COMMAND_KEY
```
static final String ACTION_COMMAND_KEY
```
    See Also:
    
    Constant Field Values
  - ACCELERATOR_KEY
```
static final String ACCELERATOR_KEY
```
    Key used for storing a KeyStroke for the accelerator for the action.
    
    See Also:
    
    Constant Field Values
  - MNEMONIC_KEY
```
static final String MNEMONIC_KEY
```
    Key for storing an Integer object to be used as the mnemonic for the action.
    
    See Also:
    
    Constant Field Values
  - SMALL_IMAGE_PATH
```
static final String SMALL_IMAGE_PATH
```
    Key for a String value to specify the resource name for the small icon
    
    See Also:
    
    Constant Field Values
  - IMAGE_PATH
```
static final String IMAGE_PATH
```
    Key for a String value to specify the resource name for the icon
    
    See Also:
    
    Constant Field Values
  - HIDE_TOOLBAR_TEXT
```
static final String HIDE_TOOLBAR_TEXT
```
    Boolean value to specify if text should be shown when this action is used to build components for an ActionBar
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getValue
```
Object getValue(String key)
```
    Actions can have any number of attributes, each referenced by a key (a string). null will be returned if no such attribute exists
    
    Parameters:
    
    key - key
    
    Returns:
    
    action attribute value
  - putValue
```
void putValue(String key,
              Object value)
```
    Actions can have any number of attributes, each referenced by a key (a string).
    
    Parameters:
    
    key - key
    
    value - value
  - getName
```
String getName()
```
    Return the name of the action. Same as doing AppAction.getValue using a key of AppAction.NAME.
    
    Returns:
    
    action name
  - isEnabled
```
boolean isEnabled()
```
    Get if the component(s) that were built from this action should be enabled or not.
    
    Returns:
    
    enabled
  - setEnabled
```
void setEnabled(boolean enabled)
```
    Set if the component(s) that were built from this action should be enabled or not.
    
    Parameters:
    
    enabled - action enaqbled
  - addPropertyChangeListener
```
void addPropertyChangeListener(PropertyChangeListener l)
```
    Add a PropertyChangeListener that will be notified when either a value changes or the enabled state changes
    
    Parameters:
    
    l - listener to add
  - removePropertyChangeListener
```
void removePropertyChangeListener(PropertyChangeListener l)
```
    Remove a PropertyChangeListener from the list that will be notified when either a value changes or the enabled state changes
    
    Parameters:
    
    l - listener to remove

Interface Action

Field Summary

Method Summary

Methods inherited from interface java.awt.event.ActionListener

Field Detail

NAME

SHORT_DESCRIPTION

LONG_DESCRIPTION

ACTION_COMMAND_KEY

ACCELERATOR_KEY

MNEMONIC_KEY

SMALL_IMAGE_PATH

IMAGE_PATH

HIDE_TOOLBAR_TEXT

Method Detail

getValue

putValue

getName

isEnabled

setEnabled

addPropertyChangeListener

removePropertyChangeListener