com.sas.swing.util
Interface Action

All Superinterfaces:

All Known Subinterfaces:

ActionList, SelectorActionInterface

All Known Implementing Classes:

BaseAction

public interface Action

extends javax.swing.Action

Extends the javax.swing.Action interface with some additional properties.

Field Summary

static String	ALIGNMENT_CENTER Constant value for TEXT_ALIGNMENT property which indicates where the text ( Action.NAME ) should be positioned relative to the icon.
static String	ALIGNMENT_LEADING Constant value for TEXT_ALIGNMENT property which indicates where the text ( Action.NAME ) should be positioned relative to the icon.
static String	ALIGNMENT_LEFT Constant value for TEXT_ALIGNMENT property which indicates where the text ( Action.NAME ) should be positioned relative to the icon.
static String	ALIGNMENT_RIGHT Constant value for TEXT_ALIGNMENT property which indicates where the text ( Action.NAME ) should be positioned relative to the icon.
static String	ALIGNMENT_TRAILING Constant value for TEXT_ALIGNMENT property which indicates where the text ( Action.NAME ) should be positioned relative to the icon.
static String	ALTERNATE_TEXT The key used for storing a string that represents the 'alt' attribute text within an tag.
static String	COMMAND_CLASS The key used for storing the class to instantiate and execute when the action's actionPerformed method is called.
static String	GROUP_NAME The key used for storing the name of the group that this action belongs to; for example, consider a group of menu items that are part of a radio box group.
static String	LABEL The key used for storing the displayable label.
static String	LARGE_DISABLED_ICON The key used for storing the disabled version of the large icon; typically used in shortcut bars when the shortcut action is unavailable.
static String	LARGE_DISABLED_ICON_NAME The key used for storing the name of the disabled version of the large icon.
static String	LARGE_ICON The key used for storing the large icon to associate with the action; typically used for shortcut bars.
static String	LARGE_ICON_NAME The key used for storing the name of the large icon to associate with the action.
static String	LONG_DISABLED_DESCRIPTION The key used for storing the text that describes the action's icon.
static String	LONG_NAME The key used for storing the long name to associate with the action; typically used for tasks in a task pane.
static String	MNEMONIC_INDEX The key used for storing an int to be used as the index of the mnemonic for the action.
static String	ROLLOVER_ICON_NAME Transformation bean components only.
static String	SHORT_DISABLED_DESCRIPTION The key used for storing the text that describes the action's disabled icon.
static String	SMALL_DISABLED_ICON The key used for storing the disabled version of the small icon; typically used in tool bars when an action is unavailable.
static String	SMALL_DISABLED_ICON_NAME The key used for storing the name of the disabled version of the small icon.
static String	SMALL_ICON_NAME The key used for storing the name of the small icon.
static String	STYLE_MAP The key used for storing the action's style map.
static String	TARGET The key used for storing a string that represents the client target in the anchor tag that is rendered for this action.
static String	TEXT_ALIGNMENT The key used for storing the horizontal alignment of the text ( Action.Name ) relative to the icon.
static String	TYPE The key used for storing the action's type.
static String	TYPE_BOOLEAN Constant value for TYPE property which indicates that the result of this action is boolean in nature; for example, consider a check box menu item.
static String	TYPE_NORMAL Constant value for TYPE property which indicates that this is a typical, or normal, action that does not require any special handling.
static String	URL The key used for storing a string that represents a URL to go to when the action's actionPerformed method is called.

Fields inherited from interface javax.swing.Action

ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SHORT_DESCRIPTION, SMALL_ICON

Method Summary

void	performAction() Provides a way to programmatically perform the action without having to create an ActionEvent.

Methods inherited from interface javax.swing.Action

addPropertyChangeListener, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from interface java.awt.event.ActionListener

actionPerformed

Field Detail

LONG_NAME

public static final String LONG_NAME

The key used for storing the long name to associate with the action; typically used for tasks in a task pane. This complements NAME defined by our parent interface.

LABEL

public static final String LABEL

The key used for storing the displayable label. This value replaces Action.NAME as the text displayed for the Action.

See Also:

Action.NAME

SMALL_ICON_NAME

public static final String SMALL_ICON_NAME

The key used for storing the name of the small icon.

This differs from the SMALL_ICON which is of type javax.swing.Icon. So typically one would set SMALL_ICON_NAME and the Action implementation will derive SMALL_ICON from it.

See Also:

Action.SMALL_ICON, LARGE_ICON_NAME

SMALL_DISABLED_ICON

public static final String SMALL_DISABLED_ICON

The key used for storing the disabled version of the small icon; typically used in tool bars when an action is unavailable.

If not set defaults to SMALL_ICON.

See Also:

SMALL_DISABLED_ICON_NAME, LARGE_DISABLED_ICON

SMALL_DISABLED_ICON_NAME

public static final String SMALL_DISABLED_ICON_NAME

The key used for storing the name of the disabled version of the small icon.

This differs from the SMALL_DISABLED_ICON which is of type javax.swing.Icon. So typically one would set SMALL_DISABLED_ICON_NAME and the Action implementation will derive SMALL_DISABLED_ICON from it.

If not set defaults to SMALL_ICON_NAME.

See Also:

SMALL_DISABLED_ICON, LARGE_DISABLED_ICON_NAME

SHORT_DISABLED_DESCRIPTION

public static final String SHORT_DISABLED_DESCRIPTION

The key used for storing the text that describes the action's disabled icon.

If not set defaults to SHORT_DESCRIPTION.

See Also:

Action.SHORT_DESCRIPTION

LARGE_ICON

public static final String LARGE_ICON

The key used for storing the large icon to associate with the action; typically used for shortcut bars. This complements SMALL_ICON defined by our parent interface.

If not set defaults to SMALL_ICON.

See Also:

LARGE_ICON_NAME, LARGE_DISABLED_ICON

LARGE_ICON_NAME

public static final String LARGE_ICON_NAME

The key used for storing the name of the large icon to associate with the action.

This differs from the LARGE_ICON which is of type javax.swing.Icon. So typically one would set LARGE_ICON_NAME and the Action implementation will derive LARGE_ICON from it.

If not set defaults to SMALL_ICON_NAME.

See Also:

LARGE_ICON, LARGE_DISABLED_ICON_NAME, SMALL_ICON_NAME

LARGE_DISABLED_ICON

public static final String LARGE_DISABLED_ICON

The key used for storing the disabled version of the large icon; typically used in shortcut bars when the shortcut action is unavailable.

If not set defaults to LARGE_ICON.

See Also:

LARGE_ICON, LARGE_DISABLED_ICON_NAME

LARGE_DISABLED_ICON_NAME

public static final String LARGE_DISABLED_ICON_NAME

The key used for storing the name of the disabled version of the large icon.

This differs from the LARGE_DISABLED_ICON which is of type javax.swing.Icon. So typically one would set LARGE_DISABLED_ICON_NAME and the Action implementation will derive LARGE_DISABLED_ICON from it.

If not set defaults to LARGE_ICON_NAME.

See Also:

LARGE_DISABLED_ICON, SMALL_DISABLED_ICON_NAME

LONG_DISABLED_DESCRIPTION

public static final String LONG_DISABLED_DESCRIPTION

The key used for storing the text that describes the action's icon.

If not set defaults to LONG_DESCRIPTION.

See Also:

Action.LONG_DESCRIPTION

ROLLOVER_ICON_NAME

public static final String ROLLOVER_ICON_NAME

Transformation bean components only. The key used for storing the name of the rollover icon.

When set, the anchor tag for the Action will reference the image with the onMouseOver tag element.

GROUP_NAME

public static final String GROUP_NAME

The key used for storing the name of the group that this action belongs to; for example, consider a group of menu items that are part of a radio box group.

TYPE

public static final String TYPE

The key used for storing the action's type. The type can be any of the TYPE_* constant values. If no type is specified the implementation should default to TYPE_NORMAL.

See Also:

TYPE_NORMAL, TYPE_BOOLEAN

TYPE_NORMAL

public static final String TYPE_NORMAL

Constant value for TYPE property which indicates that this is a typical, or normal, action that does not require any special handling.

See Also:

TYPE

TYPE_BOOLEAN

public static final String TYPE_BOOLEAN

Constant value for TYPE property which indicates that the result of this action is boolean in nature; for example, consider a check box menu item.

See Also:

TYPE

TEXT_ALIGNMENT

public static final String TEXT_ALIGNMENT

The key used for storing the horizontal alignment of the text ( Action.Name ) relative to the icon. The type can be any of the ALIGNMENT_* constant values. If no type is specified the implementation should default to ALIGNMENT_RIGHT.

See Also:

ALIGNMENT_LEFT, ALIGNMENT_RIGHT, ALIGNMENT_LEADING, ALIGNMENT_TRAILING, ALIGNMENT_CENTER

ALIGNMENT_RIGHT

public static final String ALIGNMENT_RIGHT

Constant value for TEXT_ALIGNMENT property which indicates where the text ( Action.NAME ) should be positioned relative to the icon.

See Also:

TEXT_ALIGNMENT

ALIGNMENT_LEFT

public static final String ALIGNMENT_LEFT

Constant value for TEXT_ALIGNMENT property which indicates where the text ( Action.NAME ) should be positioned relative to the icon.

See Also:

TEXT_ALIGNMENT

ALIGNMENT_LEADING

public static final String ALIGNMENT_LEADING

Constant value for TEXT_ALIGNMENT property which indicates where the text ( Action.NAME ) should be positioned relative to the icon.

See Also:

TEXT_ALIGNMENT

ALIGNMENT_TRAILING

public static final String ALIGNMENT_TRAILING

Constant value for TEXT_ALIGNMENT property which indicates where the text ( Action.NAME ) should be positioned relative to the icon.

See Also:

TEXT_ALIGNMENT

ALIGNMENT_CENTER

public static final String ALIGNMENT_CENTER

Constant value for TEXT_ALIGNMENT property which indicates where the text ( Action.NAME ) should be positioned relative to the icon.

See Also:

TEXT_ALIGNMENT

COMMAND_CLASS

public static final String COMMAND_CLASS

The key used for storing the class to instantiate and execute when the action's actionPerformed method is called.

The class must be an instance of com.sas.util.Command.

URL

public static final String URL

The key used for storing a string that represents a URL to go to when the action's actionPerformed method is called. Transformation bean components only.

ALTERNATE_TEXT

public static final String ALTERNATE_TEXT

The key used for storing a string that represents the 'alt' attribute text within an tag. Transformation bean components only.

TARGET

public static final String TARGET

The key used for storing a string that represents the client target in the anchor tag that is rendered for this action. Transformation bean components only.

STYLE_MAP

public static final String STYLE_MAP

The key used for storing the action's style map. Http only.

MNEMONIC_INDEX

public static final String MNEMONIC_INDEX

The key used for storing an int to be used as the index of the mnemonic for the action.

This differs from the MNEMONIC_KEY as this sets the index in the string in which the mnemonic exists. The MNEMONIC_KEY needs to be set as well in order for the mnemonic index to work. So typically one would set the MNEMONIC_KEY first and then set the MNEMONIC_INDEX.

See Also:

Action.MNEMONIC_KEY

Method Detail

performAction

public void performAction()

Provides a way to programmatically perform the action without having to create an ActionEvent.