Package org.jdesktop.swingx.action
Class CompositeAction
- java.lang.Object
-
- javax.swing.AbstractAction
-
- org.jdesktop.swingx.action.AbstractActionExt
-
- org.jdesktop.swingx.action.CompositeAction
-
- All Implemented Interfaces:
java.awt.event.ActionListener
,java.awt.event.ItemListener
,java.io.Serializable
,java.lang.Cloneable
,java.util.EventListener
,javax.swing.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 theActionManager
. 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 java.lang.String
LIST_IDS
Keys for storing extended action attributes.-
Fields inherited from class org.jdesktop.swingx.action.AbstractActionExt
GROUP, IS_STATE, LARGE_ICON
-
-
Constructor Summary
Constructors Constructor Description CompositeAction()
CompositeAction(java.lang.String name)
CompositeAction(java.lang.String name, java.lang.String command)
CompositeAction(java.lang.String name, java.lang.String command, javax.swing.Icon icon)
CompositeAction(java.lang.String name, javax.swing.Icon icon)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
actionPerformed(java.awt.event.ActionEvent evt)
Callback for composite actions.void
addAction(java.lang.String id)
Add an action id to the action list.java.util.List<java.lang.String>
getActionIDs()
Returns a list of action ids which indicates that this is a composite action.void
itemStateChanged(java.awt.event.ItemEvent evt)
Callback for toggle actions.-
Methods inherited from class org.jdesktop.swingx.action.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 javax.swing.AbstractAction
addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled
-
-
-
-
Field Detail
-
LIST_IDS
private static final java.lang.String LIST_IDS
Keys for storing extended action attributes. May make public.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CompositeAction
public CompositeAction()
-
CompositeAction
public CompositeAction(java.lang.String name)
-
CompositeAction
public CompositeAction(java.lang.String name, java.lang.String command)
- Parameters:
name
- display name of the actioncommand
- the value of the action command key
-
CompositeAction
public CompositeAction(java.lang.String name, javax.swing.Icon icon)
-
CompositeAction
public CompositeAction(java.lang.String name, java.lang.String command, javax.swing.Icon icon)
- Parameters:
name
- display name of the actioncommand
- the value of the action command keyicon
- icon to display
-
-
Method Detail
-
addAction
public void addAction(java.lang.String id)
Add an action id to the action list. This action will be invoked when this composite action is invoked.
-
getActionIDs
public java.util.List<java.lang.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(java.awt.event.ActionEvent evt)
Callback for composite actions. This method will redispatch the ActionEvent to all the actions held in the list.
-
itemStateChanged
public void itemStateChanged(java.awt.event.ItemEvent evt)
Callback for toggle actions.- Specified by:
itemStateChanged
in interfacejava.awt.event.ItemListener
- Overrides:
itemStateChanged
in classAbstractActionExt
- Parameters:
evt
- the ItemEvent fired by a ItemSelectable on changing the selected state.
-
-