Class AbstractActionExt

java.lang.Object
javax.swing.AbstractAction
org.jdesktop.swingx.action.AbstractActionExt
All Implemented Interfaces:
ActionListener, ItemListener, Serializable, Cloneable, EventListener, Action
Direct Known Subclasses:
AbstractHyperlinkAction, BoundAction, ColumnControlButton.ColumnVisibilityAction, CompositeAction, JXGradientChooser.AddThumbAction, JXGradientChooser.DeleteThumbAction, JXLoginPane.CancelAction, JXLoginPane.LoginAction, TargetableAction
public abstract class AbstractActionExt extends AbstractAction implements ItemListener
Extends the concept of the Action to include toggle or group states.

SwingX 1.6.3 updates AbstractActionExt to use new features of Action that were added in Java 1.6. The selection is now managed with Action.SELECTED_KEY, which allows the action to correctly configured Swing buttons. The LARGE_ICON has also been changed to correspond to Action.LARGE_ICON_KEY.

See Also:

  • Field Details

  • Constructor Details

    • AbstractActionExt

      public AbstractActionExt()
      Default constructor, does nothing.

    • AbstractActionExt

      public AbstractActionExt(AbstractActionExt action)
      Copy constructor copies the state.

    • AbstractActionExt

      public AbstractActionExt(String name)

    • AbstractActionExt

      public AbstractActionExt(String name, Icon icon)

    • AbstractActionExt

      public AbstractActionExt(String name, String command)
      Constructs an Action with the label and command
      Parameters:
      name - name of the action usually used as a label
      command - command key of the action

    • AbstractActionExt

      public AbstractActionExt(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

    • getShortDescription

      public String getShortDescription()
      Returns a short description of the action.
      Returns:
      the short description or null

    • setShortDescription

      public void setShortDescription(String desc)
      Sets the short description of the action. This will also set the long description value is it is null.

      This is a convenience method for putValue with the Action.SHORT_DESCRIPTION key.

      Parameters:
      desc - the short description; can be nullw
      See Also:

    • getLongDescription

      public String getLongDescription()
      Returns a long description of the action.
      Returns:
      the long description or null

    • setLongDescription

      public void setLongDescription(String desc)
      Sets the long description of the action. This will also set the value of the short description if that value is null.

      This is a convenience method for putValue with the Action.LONG_DESCRIPTION key.

      Parameters:
      desc - the long description; can be null
      See Also:

    • getSmallIcon

      public Icon getSmallIcon()
      Returns a small icon which represents the action.
      Returns:
      the small icon or null

    • setSmallIcon

      public void setSmallIcon(Icon icon)
      Sets the small icon which represents the action.

      This is a convenience method for putValue with the Action.SMALL_ICON key.

      Parameters:
      icon - the small icon; can be null
      See Also:

    • getLargeIcon

      public Icon getLargeIcon()
      Returns a large icon which represents the action.
      Returns:
      the large icon or null

    • setLargeIcon

      public void setLargeIcon(Icon icon)
      Sets the large icon which represents the action.

      This is a convenience method for putValue with the LARGE_ICON key.

      Parameters:
      icon - the large icon; can be null
      See Also:

    • setName

      public void setName(String name)
      Sets the name of the action.

      This is a convenience method for putValue with the Action.NAME key.

      Parameters:
      name - the name of the action; can be null
      See Also:

    • getName

      public String getName()
      Returns the name of the action.
      Returns:
      the name of the action or null

    • setMnemonic

      public void setMnemonic(String mnemonic)

    • setMnemonic

      public void setMnemonic(int mnemonic)
      Sets the mnemonic key code for the action.

      This is a convenience method for putValue with the Action.MNEMONIC_KEY key.

      This method does not validate the value. Please see AbstractButton.setMnemonic(int) for details concerning the value of the mnemonic.

      Parameters:
      mnemonic - an int key code mnemonic or 0
      See Also:

    • getMnemonic

      public int getMnemonic()
      Return the mnemonic key code for the action.
      Returns:
      the mnemonic or 0

    • setActionCommand

      public void setActionCommand(String key)
      Sets the action command key. The action command key is used to identify the action.

      This is a convenience method for putValue with the Action.ACTION_COMMAND_KEY key.

      Parameters:
      key - the action command
      See Also:

    • getActionCommand

      public String getActionCommand()
      Returns the action command.
      Returns:
      the action command or null

    • getAccelerator

      public KeyStroke getAccelerator()
      Returns the key stroke which represents an accelerator for the action.
      Returns:
      the key stroke or null

    • setAccelerator

      public void setAccelerator(KeyStroke key)
      Sets the key stroke which represents an accelerator for the action.

      This is a convenience method for putValue with the Action.ACCELERATOR_KEY key.

      Parameters:
      key - the key stroke; can be null
      See Also:

    • setGroup

      public void setGroup(Object group)
      Sets the group identity of the state action. This is used to identify the action as part of a button group.

    • getGroup

      public Object getGroup()

    • dispose

      public void dispose()
      Will perform cleanup on the object. Should be called when finished with the Action. This should be used if a new action is constructed from the properties of an old action. The old action properties should be disposed.

    • isStateAction

      public boolean isStateAction()
      Indicates if this action has states. If this method returns true then the this will send ItemEvents to ItemListeners when the control constructed with this action in invoked.
      Returns:
      true if this can handle states

    • setStateAction

      public void setStateAction()
      Set the state property to true.

    • setStateAction

      public void setStateAction(boolean state)
      Set the state property.
      Parameters:
      state - if true then this action will fire ItemEvents

    • isSelected

      public boolean isSelected()
      Returns:
      true if the action is in the selected state

    • setSelected

      public void setSelected(boolean newValue)
      Changes the state of the action. This is a convenience method for updating the Action via the value map.
      Parameters:
      newValue - true to set the action as selected of the action.
      See Also:

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • itemStateChanged

      public void itemStateChanged(ItemEvent e)
      Callback method as ItemListener. Updates internal state based on the given ItemEvent.

      Here: synchs selected property if isStateAction(), does nothing otherwise.

      Specified by:
      itemStateChanged in interface ItemListener
      Parameters:
      e - the ItemEvent fired by a ItemSelectable on changing the selected state.