Action (Java SE 19 & JDK 19) (original) (raw)

All Superinterfaces:

[ActionListener](../../java/awt/event/ActionListener.html "interface in java.awt.event"), [EventListener](../../../java.base/java/util/EventListener.html "interface in java.util")

All Known Implementing Classes:

[AbstractAction](AbstractAction.html "class in javax.swing"), [BasicDesktopPaneUI.CloseAction](plaf/basic/BasicDesktopPaneUI.CloseAction.html "class in javax.swing.plaf.basic"), [BasicDesktopPaneUI.MaximizeAction](plaf/basic/BasicDesktopPaneUI.MaximizeAction.html "class in javax.swing.plaf.basic"), [BasicDesktopPaneUI.MinimizeAction](plaf/basic/BasicDesktopPaneUI.MinimizeAction.html "class in javax.swing.plaf.basic"), [BasicDesktopPaneUI.NavigateAction](plaf/basic/BasicDesktopPaneUI.NavigateAction.html "class in javax.swing.plaf.basic"), [BasicDesktopPaneUI.OpenAction](plaf/basic/BasicDesktopPaneUI.OpenAction.html "class in javax.swing.plaf.basic"), [BasicFileChooserUI.ApproveSelectionAction](plaf/basic/BasicFileChooserUI.ApproveSelectionAction.html "class in javax.swing.plaf.basic"), [BasicFileChooserUI.CancelSelectionAction](plaf/basic/BasicFileChooserUI.CancelSelectionAction.html "class in javax.swing.plaf.basic"), [BasicFileChooserUI.ChangeToParentDirectoryAction](plaf/basic/BasicFileChooserUI.ChangeToParentDirectoryAction.html "class in javax.swing.plaf.basic"), [BasicFileChooserUI.GoHomeAction](plaf/basic/BasicFileChooserUI.GoHomeAction.html "class in javax.swing.plaf.basic"), [BasicFileChooserUI.NewFolderAction](plaf/basic/BasicFileChooserUI.NewFolderAction.html "class in javax.swing.plaf.basic"), [BasicFileChooserUI.UpdateAction](plaf/basic/BasicFileChooserUI.UpdateAction.html "class in javax.swing.plaf.basic"), [BasicInternalFrameTitlePane.CloseAction](plaf/basic/BasicInternalFrameTitlePane.CloseAction.html "class in javax.swing.plaf.basic"), [BasicInternalFrameTitlePane.IconifyAction](plaf/basic/BasicInternalFrameTitlePane.IconifyAction.html "class in javax.swing.plaf.basic"), [BasicInternalFrameTitlePane.MaximizeAction](plaf/basic/BasicInternalFrameTitlePane.MaximizeAction.html "class in javax.swing.plaf.basic"), [BasicInternalFrameTitlePane.MoveAction](plaf/basic/BasicInternalFrameTitlePane.MoveAction.html "class in javax.swing.plaf.basic"), [BasicInternalFrameTitlePane.RestoreAction](plaf/basic/BasicInternalFrameTitlePane.RestoreAction.html "class in javax.swing.plaf.basic"), [BasicInternalFrameTitlePane.SizeAction](plaf/basic/BasicInternalFrameTitlePane.SizeAction.html "class in javax.swing.plaf.basic"), [BasicSliderUI.ActionScroller](plaf/basic/BasicSliderUI.ActionScroller.html "class in javax.swing.plaf.basic"), [BasicTreeUI.TreeCancelEditingAction](plaf/basic/BasicTreeUI.TreeCancelEditingAction.html "class in javax.swing.plaf.basic"), [BasicTreeUI.TreeHomeAction](plaf/basic/BasicTreeUI.TreeHomeAction.html "class in javax.swing.plaf.basic"), [BasicTreeUI.TreeIncrementAction](plaf/basic/BasicTreeUI.TreeIncrementAction.html "class in javax.swing.plaf.basic"), [BasicTreeUI.TreePageAction](plaf/basic/BasicTreeUI.TreePageAction.html "class in javax.swing.plaf.basic"), [BasicTreeUI.TreeToggleAction](plaf/basic/BasicTreeUI.TreeToggleAction.html "class in javax.swing.plaf.basic"), [BasicTreeUI.TreeTraverseAction](plaf/basic/BasicTreeUI.TreeTraverseAction.html "class in javax.swing.plaf.basic"), [DefaultEditorKit.BeepAction](text/DefaultEditorKit.BeepAction.html "class in javax.swing.text"), [DefaultEditorKit.CopyAction](text/DefaultEditorKit.CopyAction.html "class in javax.swing.text"), [DefaultEditorKit.CutAction](text/DefaultEditorKit.CutAction.html "class in javax.swing.text"), [DefaultEditorKit.DefaultKeyTypedAction](text/DefaultEditorKit.DefaultKeyTypedAction.html "class in javax.swing.text"), [DefaultEditorKit.InsertBreakAction](text/DefaultEditorKit.InsertBreakAction.html "class in javax.swing.text"), [DefaultEditorKit.InsertContentAction](text/DefaultEditorKit.InsertContentAction.html "class in javax.swing.text"), [DefaultEditorKit.InsertTabAction](text/DefaultEditorKit.InsertTabAction.html "class in javax.swing.text"), [DefaultEditorKit.PasteAction](text/DefaultEditorKit.PasteAction.html "class in javax.swing.text"), [HTMLEditorKit.HTMLTextAction](text/html/HTMLEditorKit.HTMLTextAction.html "class in javax.swing.text.html"), [HTMLEditorKit.InsertHTMLTextAction](text/html/HTMLEditorKit.InsertHTMLTextAction.html "class in javax.swing.text.html"), [MetalFileChooserUI.DirectoryComboBoxAction](plaf/metal/MetalFileChooserUI.DirectoryComboBoxAction.html "class in javax.swing.plaf.metal"), [StyledEditorKit.AlignmentAction](text/StyledEditorKit.AlignmentAction.html "class in javax.swing.text"), [StyledEditorKit.BoldAction](text/StyledEditorKit.BoldAction.html "class in javax.swing.text"), [StyledEditorKit.FontFamilyAction](text/StyledEditorKit.FontFamilyAction.html "class in javax.swing.text"), [StyledEditorKit.FontSizeAction](text/StyledEditorKit.FontSizeAction.html "class in javax.swing.text"), [StyledEditorKit.ForegroundAction](text/StyledEditorKit.ForegroundAction.html "class in javax.swing.text"), [StyledEditorKit.ItalicAction](text/StyledEditorKit.ItalicAction.html "class in javax.swing.text"), [StyledEditorKit.StyledTextAction](text/StyledEditorKit.StyledTextAction.html "class in javax.swing.text"), [StyledEditorKit.UnderlineAction](text/StyledEditorKit.UnderlineAction.html "class in javax.swing.text"), [TextAction](text/TextAction.html "class in javax.swing.text")

The Action interface provides a useful extension to theActionListener interface in cases where the same functionality may be accessed by several controls.

In addition to the actionPerformed method defined by theActionListener interface, this interface allows the application to define, in a single place:

• One or more text strings that describe the function. These strings can be used, for example, to display the flyover text for a button or to set the text in a menu item.
• One or more icons that depict the function. These icons can be used for the images in a menu control, or for composite entries in a more sophisticated user interface.
• The enabled/disabled state of the functionality. Instead of having to separately disable the menu item and the toolbar button, the application can disable the function that implements this interface. All components which are registered as listeners for the state change then know to disable event generation for that item and to modify the display accordingly.

This interface can be added to an existing class or used to create an adapter (typically, by subclassing AbstractAction). The Action object can then be added to multiple Action-aware containers and connected to Action-capable components. The GUI controls can then be activated or deactivated all at once by invoking the Action object'ssetEnabled method.

Note that Action implementations tend to be more expensive in terms of storage than a typical ActionListener, which does not offer the benefits of centralized control of functionality and broadcast of property changes. For this reason, you should take care to only use Actions where their benefits are desired, and use simple ActionListeners elsewhere.

Swing Components Supporting Action

Many of Swing's components have an Action property. When an Action is set on a component, the following things happen:

• The Action is added as an ActionListener to the component.
• The component configures some of its properties to match theAction.
• The component installs a PropertyChangeListener on theAction so that the component can change its properties to reflect changes in the Action's properties.

The following table describes the properties used bySwing components that support Actions. In the table, button refers to anyAbstractButton subclass, which includes not onlyJButton but also classes such asJMenuItem. Unless otherwise stated, anull property value in an Action (or aAction that is null) results in the button's corresponding property being set to null.

Supported Action properties

JPopupMenu, JToolBar and JMenu all provide convenience methods for creating a component and setting theAction on the corresponding component. Refer to each of these classes for more information.

Action uses PropertyChangeListener to inform listeners the Action has changed. The beans specification indicates that a null property name can be used to indicate multiple values have changed. By default Swing components that take an Action do not handle such a change. To indicate that Swing should treat null according to the beans specification set the system propertyswing.actions.reconfigureOnNull to the String value true.

Since:

1.2

See Also:

• AbstractAction

• Field Summary

Fields
The key used for storing a KeyStroke to be used as the accelerator for the action.
The key used to determine the command String for theActionEvent that will be created when anAction is going to be notified as the result of residing in a Keymap associated with aJComponent.
The key used for storing an Integer that corresponds to the index in the text (identified by the NAME property) that the decoration for a mnemonic should be rendered at.
The key used for storing an Icon.
The key used for storing a longer String description for the action, could be used for context-sensitive help.
The key used for storing an Integer that corresponds to one of the KeyEvent key codes.
The key used for storing the String name for the action, used for a menu or button.
The key used for storing a Boolean that corresponds to the selected state.
The key used for storing a short String description for the action, used for tooltip text.
The key used for storing a small Icon, such as ImageIcon.

• Method Summary

default boolean
Determines whether the action should be performed with the specified sender object.
void
Adds a PropertyChange listener.
Gets one of this object's properties using the associated key.
boolean
[isEnabled](#isEnabled%28%29)()
Returns the enabled state of the Action.
void
Sets one of this object's properties using the associated key.
void
Removes a PropertyChange listener.
void
[setEnabled](#setEnabled%28boolean%29)(boolean b)
Sets the enabled state of the Action.

• Field Details

  • DEFAULT

  static final String DEFAULT
  Not currently used.
  See Also:
  * Constant Field Values

  • NAME

  The key used for storing the String name for the action, used for a menu or button.
  See Also:
  * Constant Field Values

  • SHORT_DESCRIPTION

  static final String SHORT_DESCRIPTION
  The key used for storing a short String description for the action, used for tooltip text.
  See Also:
  * Constant Field Values

  • LONG_DESCRIPTION

  static final String LONG_DESCRIPTION
  The key used for storing a longer String description for the action, could be used for context-sensitive help.
  See Also:
  * Constant Field Values

  • SMALL_ICON

  static final String SMALL_ICON
  The key used for storing a small Icon, such as ImageIcon. This is typically used with menus such as JMenuItem.
  If the same Action is used with menus and buttons you'll typically specify both a SMALL_ICON and aLARGE_ICON_KEY. The menu will use theSMALL_ICON and the button will use theLARGE_ICON_KEY.
  See Also:
  * Constant Field Values

  • ACTION_COMMAND_KEY

  static final String ACTION_COMMAND_KEY
  The key used to determine the command String for theActionEvent that will be created when anAction is going to be notified as the result of residing in a Keymap associated with aJComponent.
  See Also:
  * Constant Field Values

  • ACCELERATOR_KEY

  static final String ACCELERATOR_KEY
  The key used for storing a KeyStroke to be used as the accelerator for the action.
  Since:
  1.3
  See Also:
  * Constant Field Values

  • MNEMONIC_KEY

  static final String MNEMONIC_KEY
  The key used for storing an Integer that corresponds to one of the KeyEvent key codes. The value is commonly used to specify a mnemonic. For example:myAction.putValue(Action.MNEMONIC_KEY, KeyEvent.VK_A) sets the mnemonic of myAction to 'a', whilemyAction.putValue(Action.MNEMONIC_KEY, KeyEvent.getExtendedKeyCodeForChar('ф')) sets the mnemonic of myAction to Cyrillic letter "Ef".
  Since:
  1.3
  See Also:
  * Constant Field Values

  • SELECTED_KEY

  static final String SELECTED_KEY
  The key used for storing a Boolean that corresponds to the selected state. This is typically used only for components that have a meaningful selection state. For example,JRadioButton and JCheckBox make use of this but instances of JMenu don't.
  This property differs from the others in that it is both read by the component and set by the component. For example, if an Action is attached to a JCheckBox the selected state of the JCheckBox will be set from that of the Action. If the user clicks on theJCheckBox the selected state of the JCheckBox and the Action will both be updated.
  Note: the value of this field is prefixed with 'Swing' to avoid possible collisions with existing Actions.
  Since:
  1.6
  See Also:
  * Constant Field Values

  • DISPLAYED_MNEMONIC_INDEX_KEY

  static final String DISPLAYED_MNEMONIC_INDEX_KEY
  The key used for storing an Integer that corresponds to the index in the text (identified by the NAME property) that the decoration for a mnemonic should be rendered at. If the value of this property is greater than or equal to the length of the text, it will treated as -1.
  Note: the value of this field is prefixed with 'Swing' to avoid possible collisions with existing Actions.
  Since:
  1.6
  See Also:
  * AbstractButton.setDisplayedMnemonicIndex(int)
  * Constant Field Values

  • LARGE_ICON_KEY

  static final String LARGE_ICON_KEY
  The key used for storing an Icon. This is typically used by buttons, such as JButton andJToggleButton.
  If the same Action is used with menus and buttons you'll typically specify both a SMALL_ICON and aLARGE_ICON_KEY. The menu will use theSMALL_ICON and the button the LARGE_ICON_KEY.
  Note: the value of this field is prefixed with 'Swing' to avoid possible collisions with existing Actions.
  Since:
  1.6
  See Also:
  * Constant Field Values

• Method Details

  • getValue

  Gets one of this object's properties using the associated key.
  Parameters:
  key - a String containing the key
  Returns:
  the Object value
  See Also:
  * putValue(java.lang.String, java.lang.Object)

  • putValue

  Sets one of this object's properties using the associated key. If the value has changed, a PropertyChangeEvent is sent to listeners.
  Parameters:
  key - a String containing the key
  value - an Object value

  • setEnabled

  void setEnabled(boolean b)
  Sets the enabled state of the Action. When enabled, any component associated with this object is active and able to fire this object's actionPerformed method. If the value has changed, a PropertyChangeEvent is sent to listeners.
  Parameters:
  b - true to enable this Action, false to disable it
  See Also:
  * accept(java.lang.Object)

  • isEnabled

  boolean isEnabled()
  Returns the enabled state of the Action. When enabled, any component associated with this object is active and able to fire this object's actionPerformed method.
  Returns:
  true if this Action is enabled
  See Also:
  * accept(java.lang.Object)

  • accept

  default boolean accept(Object sender)
  Determines whether the action should be performed with the specified sender object. The sender can be null. The method must return false if the action is disabled.
  Parameters:
  sender - the object to check, can be null
  Returns:
  true if the action should be performed with the sender object, must be false if the action is disabled.
  See Also:
  * isEnabled()
  * setEnabled(boolean)

  • addPropertyChangeListener

  Adds a PropertyChange listener. Containers and attached components use these methods to register interest in thisAction object. When its enabled state or other property changes, the registered listeners are informed of the change.
  Parameters:
  listener - a PropertyChangeListener object

  • removePropertyChangeListener

  Removes a PropertyChange listener.
  Parameters:
  listener - a PropertyChangeListener object
  See Also:
  * addPropertyChangeListener(java.beans.PropertyChangeListener)