Class CompositeAction

java.lang.Object

javax.swing.AbstractAction

org.jdesktop.swingx.action.AbstractActionExt

org.jdesktop.swingx.action.CompositeAction

All Implemented Interfaces:

ActionListener, ItemListener, Serializable, Cloneable, EventListener, Action

public class CompositeAction
extends AbstractActionExt

A class that represents an action which will fire a sequence of actions. The action ids are added to the internal list. When this action is invoked, the event will be dispatched to the actions in the internal list.

The action ids are represented by the value of the Action.ACTION_COMMAND_KEY and must be managed by the ActionManager. When this action is invoked, then the actions are retrieved from the ActionManager in list order and invoked.

See Also:

• ActionManager
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	LIST_IDS	Keys for storing extended action attributes.

Fields inherited from class AbstractActionExt

GROUP, IS_STATE, LARGE_ICON

Fields inherited from class AbstractAction

changeSupport, enabled

Fields inherited from interface 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	Description
CompositeAction()
CompositeAction(String name)
CompositeAction(String name, String command)
CompositeAction(String name, String command, Icon icon)
CompositeAction(String name, Icon icon)

Method Summary

Modifier and Type	Method	Description
void	actionPerformed(ActionEvent evt)	Callback for composite actions.
void	addAction(String id)	Add an action id to the action list.
List<String>	getActionIDs()	Returns a list of action ids which indicates that this is a composite action.
void	itemStateChanged(ItemEvent evt)	Callback for toggle actions.

Methods inherited from class AbstractActionExt

dispose, getAccelerator, getActionCommand, getGroup, getLargeIcon, getLongDescription, getMnemonic, getName, getShortDescription, getSmallIcon, isSelected, isStateAction, setAccelerator, setActionCommand, setGroup, setLargeIcon, setLongDescription, setMnemonic, setMnemonic, setName, setSelected, setShortDescription, setSmallIcon, setStateAction, setStateAction, toString

Methods inherited from class AbstractAction

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

Methods inherited from class Object

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

Methods inherited from interface Action

accept

Field Details

LIST_IDS

private static final String LIST_IDS

Keys for storing extended action attributes. May make public.

See Also:

• Constant Field Values

Constructor Details

CompositeAction

public CompositeAction()

CompositeAction

public CompositeAction(String name)

CompositeAction

public CompositeAction(String name,
 String command)

Parameters:

name - display name of the action

command - the value of the action command key

CompositeAction

public CompositeAction(String name,
 Icon icon)

CompositeAction

public CompositeAction(String name,
 String command,
 Icon icon)

Parameters:

name - display name of the action

command - the value of the action command key

icon - icon to display

Method Details

addAction

public void addAction(String id)

Add an action id to the action list. This action will be invoked when this composite action is invoked.

getActionIDs

public List<String> getActionIDs()

Returns a list of action ids which indicates that this is a composite action.

Returns:

a valid list of action ids or null

actionPerformed

public void actionPerformed(ActionEvent evt)

Callback for composite actions. This method will redispatch the ActionEvent to all the actions held in the list.

itemStateChanged

public void itemStateChanged(ItemEvent evt)

Callback for toggle actions.

Specified by:

itemStateChanged in interface ItemListener

Overrides:

itemStateChanged in class AbstractActionExt

Parameters:

evt - the ItemEvent fired by a ItemSelectable on changing the selected state.