2362N/A * Copyright (c) 1997, 2009, Oracle and/or its affiliates. All rights reserved. 0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 0N/A * This code is free software; you can redistribute it and/or modify it 0N/A * under the terms of the GNU General Public License version 2 only, as 2362N/A * published by the Free Software Foundation. Oracle designates this 0N/A * particular file as subject to the "Classpath" exception as provided 2362N/A * by Oracle in the LICENSE file that accompanied this code. 0N/A * This code is distributed in the hope that it will be useful, but WITHOUT 0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 0N/A * version 2 for more details (a copy is included in the LICENSE file that 0N/A * accompanied this code). 0N/A * You should have received a copy of the GNU General Public License version 0N/A * 2 along with this work; if not, write to the Free Software Foundation, 0N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 2362N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 2362N/A * or visit www.oracle.com if you need additional information or have any 0N/A * The <code>Action</code> interface provides a useful extension to the 0N/A * <code>ActionListener</code> 0N/A * interface in cases where the same functionality may be accessed by 0N/A * In addition to the <code>actionPerformed</code> method defined by the 0N/A * <code>ActionListener</code> interface, this interface allows the 0N/A * application to define, in a single place: 0N/A * <li>One or more text strings that describe the function. These strings 0N/A * can be used, for example, to display the flyover text for a button 0N/A * or to set the text in a menu item. 0N/A * <li>One or more icons that depict the function. These icons can be used 0N/A * for the images in a menu control, or for composite entries in a more 0N/A * sophisticated user interface. 0N/A * to separately disable the menu item and the toolbar button, the 0N/A * application can disable the function that implements this interface. 0N/A * All components which are registered as listeners for the state change 0N/A * then know to disable event generation for that item and to modify the 0N/A * display accordingly. 0N/A * This interface can be added to an existing class or used to create an 0N/A * adapter (typically, by subclassing <code>AbstractAction</code>). 0N/A * The <code>Action</code> object 0N/A * can then be added to multiple <code>Action</code>-aware containers 0N/A * and connected to <code>Action</code>-capable 0N/A * components. The GUI controls can then be activated or 0N/A * deactivated all at once by invoking the <code>Action</code> object's 0N/A * <code>setEnabled</code> method. 0N/A * Note that <code>Action</code> implementations tend to be more expensive 0N/A * in terms of storage than a typical <code>ActionListener</code>, 0N/A * which does not offer the benefits of centralized control of 0N/A * functionality and broadcast of property changes. For this reason, 0N/A * you should take care to only use <code>Action</code>s where their benefits 0N/A * are desired, and use simple <code>ActionListener</code>s elsewhere. 0N/A * <h4><a name="buttonActions"></a>Swing Components Supporting <code>Action</code></h4> 0N/A * Many of Swing's components have an <code>Action</code> property. When 0N/A * an <code>Action</code> is set on a component, the following things 0N/A * <li>The <code>Action</code> is added as an <code>ActionListener</code> to 0N/A * <li>The component configures some of its properties to match the 0N/A * <code>Action</code>. 0N/A * <li>The component installs a <code>PropertyChangeListener</code> on the 0N/A * <code>Action</code> so that the component can change its properties 0N/A * to reflect changes in the <code>Action</code>'s properties. 0N/A * The following table describes the properties used by 0N/A * <code>Swing</code> components that support <code>Actions</code>. 0N/A * In the table, <em>button</em> refers to any 0N/A * <code>AbstractButton</code> subclass, which includes not only 0N/A * <code>JButton</code> but also classes such as 0N/A * <code>JMenuItem</code>. Unless otherwise stated, a 0N/A * <code>null</code> property value in an <code>Action</code> (or a 0N/A * <code>Action</code> that is <code>null</code>) results in the 0N/A * button's corresponding property being set to <code>null</code>. 0N/A * <table border="1" cellpadding="1" cellspacing="0" 0N/A * summary="Supported Action properties" 0N/A * <tr valign="top" align="left"> 0N/A * <th bgcolor="#CCCCFF" align="left">Component Property 0N/A * <th bgcolor="#CCCCFF" align="left">Components 0N/A * <th bgcolor="#CCCCFF" align="left">Action Key 0N/A * <th bgcolor="#CCCCFF" align="left">Notes 0N/A * <tr valign="top" align="left"> 0N/A * <td><b><code>enabled</code></b> 0N/A * <td>The <code>isEnabled</code> method 0N/A * <tr valign="top" align="left"> 0N/A * <td><b><code>toolTipText</code></b> 0N/A * <td><code>SHORT_DESCRIPTION</code> 0N/A * <tr valign="top" align="left"> 0N/A * <td><b><code>actionCommand</code></b> 0N/A * <td><code>ACTION_COMMAND_KEY</code> 0N/A * <tr valign="top" align="left"> 0N/A * <td><b><code>mnemonic</code></b> 0N/A * <td><code>MNEMONIC_KEY</code> 0N/A * <td>A <code>null</code> value or <code>Action</code> results in the 0N/A * button's <code>mnemonic</code> property being set to 0N/A * <code>'\0'</code>. 0N/A * <tr valign="top" align="left"> 0N/A * <td><b><code>text</code></b> 0N/A * <td><code>NAME</code> 0N/A * <td>If you do not want the text of the button to mirror that 0N/A * of the <code>Action</code>, set the property 0N/A * <code>hideActionText</code> to <code>true</code>. If 0N/A * <code>hideActionText</code> is <code>true</code>, setting the 0N/A * <code>Action</code> changes the text of the button to 0N/A * <code>null</code> and any changes to <code>NAME</code> 0N/A * are ignored. <code>hideActionText</code> is useful for 0N/A * tool bar buttons that typically only show an <code>Icon</code>. 0N/A * <code>JToolBar.add(Action)</code> sets the property to 0N/A * <code>true</code> if the <code>Action</code> has a 0N/A * non-<code>null</code> value for <code>LARGE_ICON_KEY</code> or 0N/A * <code>SMALL_ICON</code>. 0N/A * <tr valign="top" align="left"> 0N/A * <td><b><code>displayedMnemonicIndex</code></b> 0N/A * <td><code>DISPLAYED_MNEMONIC_INDEX_KEY</code> 0N/A * <td>If the value of <code>DISPLAYED_MNEMONIC_INDEX_KEY</code> is 0N/A * beyond the bounds of the text, it is ignored. When 0N/A * <code>setAction</code> is called, if the value from the 0N/A * <code>Action</code> is <code>null</code>, the displayed 0N/A * mnemonic index is not updated. In any subsequent changes to 0N/A * <code>DISPLAYED_MNEMONIC_INDEX_KEY</code>, <code>null</code> 0N/A * <tr valign="top" align="left"> 0N/A * <td><b><code>icon</code></b> 0N/A * <td>All buttons except of <code>JCheckBox</code>, 0N/A * <code>JToggleButton</code> and <code>JRadioButton</code>. 0N/A * <td>either <code>LARGE_ICON_KEY</code> or 0N/A * <code>SMALL_ICON</code> 0N/A * <td>The <code>JMenuItem</code> subclasses only use 0N/A * <code>SMALL_ICON</code>. All other buttons will use 0N/A * <code>LARGE_ICON_KEY</code>; if the value is <code>null</code> they 0N/A * use <code>SMALL_ICON</code>. 0N/A * <tr valign="top" align="left"> 0N/A * <td><b><code>accelerator</code></b> 0N/A * <td>All <code>JMenuItem</code> subclasses, with the exception of 0N/A * <code>JMenu</code>. 0N/A * <td><code>ACCELERATOR_KEY</code> 0N/A * <tr valign="top" align="left"> 0N/A * <td><b><code>selected</code></b> 0N/A * <td><code>JToggleButton</code>, <code>JCheckBox</code>, 0N/A * <code>JRadioButton</code>, <code>JCheckBoxMenuItem</code> and 0N/A * <code>JRadioButtonMenuItem</code> 0N/A * <td><code>SELECTED_KEY</code> 0N/A * <td>Components that honor this property only use 0N/A * the value if it is {@code non-null}. For example, if 0N/A * you set an {@code Action} that has a {@code null} 0N/A * value for {@code SELECTED_KEY} on a {@code JToggleButton}, the 0N/A * {@code JToggleButton} will not update it's selected state in 0N/A * any way. Similarly, any time the {@code JToggleButton}'s 0N/A * selected state changes it will only set the value back on 0N/A * the {@code Action} if the {@code Action} has a {@code non-null} 0N/A * value for {@code SELECTED_KEY}. 0N/A * Components that honor this property keep their selected state 0N/A * in sync with this property. When the same {@code Action} is used 0N/A * with multiple components, all the components keep their selected 0N/A * state in sync with this property. Mutually exclusive 0N/A * buttons, such as {@code JToggleButton}s in a {@code ButtonGroup}, 0N/A * force only one of the buttons to be selected. As such, do not 0N/A * use the same {@code Action} that defines a value for the 0N/A * {@code SELECTED_KEY} property with multiple mutually 0N/A * exclusive buttons. 0N/A * <code>JPopupMenu</code>, <code>JToolBar</code> and <code>JMenu</code> 0N/A * all provide convenience methods for creating a component and setting the 0N/A * <code>Action</code> on the corresponding component. Refer to each of 0N/A * these classes for more information. 0N/A * <code>Action</code> uses <code>PropertyChangeListener</code> to 0N/A * inform listeners the <code>Action</code> has changed. The beans 0N/A * specification indicates that a <code>null</code> property name can * be used to indicate multiple values have changed. By default Swing * components that take an <code>Action</code> do not handle such a * change. To indicate that Swing should treat <code>null</code> * according to the beans specification set the system property * <code>swing.actions.reconfigureOnNull</code> to the <code>String</code> * value <code>true</code>. * Useful constants that can be used as the storage-retrieval key * when setting or getting one of this object's properties (text * The key used for storing the <code>String</code> name * for the action, used for a menu or button. * The key used for storing a short <code>String</code> * description for the action, used for tooltip text. * The key used for storing a longer <code>String</code> * description for the action, could be used for context-sensitive help. * The key used for storing a small <code>Icon</code>, such * as <code>ImageIcon</code>. This is typically used with * menus such as <code>JMenuItem</code>. * If the same <code>Action</code> is used with menus and buttons you'll * typically specify both a <code>SMALL_ICON</code> and a * <code>LARGE_ICON_KEY</code>. The menu will use the * <code>SMALL_ICON</code> and the button will use the * <code>LARGE_ICON_KEY</code>. * The key used to determine the command <code>String</code> for the * <code>ActionEvent</code> that will be created when an * <code>Action</code> is going to be notified as the result of * residing in a <code>Keymap</code> associated with a * <code>JComponent</code>. * The key used for storing a <code>KeyStroke</code> to be used as the * accelerator for the action. * The key used for storing an <code>Integer</code> that corresponds to * one of the <code>KeyEvent</code> key codes. The value is * commonly used to specify a mnemonic. For example: * <code>myAction.putValue(Action.MNEMONIC_KEY, KeyEvent.VK_A)</code> * sets the mnemonic of <code>myAction</code> to 'a', while * <code>myAction.putValue(Action.MNEMONIC_KEY, KeyEvent.getExtendedKeyCodeForChar('\u0444'))</code> * sets the mnemonic of <code>myAction</code> to Cyrillic letter "Ef". * The key used for storing a <code>Boolean</code> that corresponds * to the selected state. This is typically used only for components * that have a meaningful selection state. For example, * <code>JRadioButton</code> and <code>JCheckBox</code> make use of * this but instances of <code>JMenu</code> 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 <code>Action</code> is attached to a <code>JCheckBox</code> * the selected state of the <code>JCheckBox</code> will be set from * that of the <code>Action</code>. If the user clicks on the * <code>JCheckBox</code> the selected state of the <code>JCheckBox</code> * <b>and</b> the <code>Action</code> will <b>both</b> be updated. * Note: the value of this field is prefixed with 'Swing' to * avoid possible collisions with existing <code>Actions</code>. * The key used for storing an <code>Integer</code> that corresponds * to the index in the text (identified by the <code>NAME</code> * 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 <code>Actions</code>. * @see AbstractButton#setDisplayedMnemonicIndex "SwingDisplayedMnemonicIndexKey";
* The key used for storing an <code>Icon</code>. This is typically * used by buttons, such as <code>JButton</code> and * <code>JToggleButton</code>. * If the same <code>Action</code> is used with menus and buttons you'll * typically specify both a <code>SMALL_ICON</code> and a * <code>LARGE_ICON_KEY</code>. The menu will use the * <code>SMALL_ICON</code> and the button the <code>LARGE_ICON_KEY</code>. * Note: the value of this field is prefixed with 'Swing' to * avoid possible collisions with existing <code>Actions</code>. * Gets one of this object's properties * using the associated key. * Sets one of this object's properties * using the associated key. If the value has * changed, a <code>PropertyChangeEvent</code> is sent * @param key a <code>String</code> containing the key * @param value an <code>Object</code> value * Sets the enabled state of the <code>Action</code>. When enabled, * any component associated with this object is active and * able to fire this object's <code>actionPerformed</code> method. * If the value has changed, a <code>PropertyChangeEvent</code> is sent * @param b true to enable this <code>Action</code>, false to disable it * Returns the enabled state of the <code>Action</code>. When enabled, * any component associated with this object is active and * able to fire this object's <code>actionPerformed</code> method. * @return true if this <code>Action</code> is enabled * Adds a <code>PropertyChange</code> listener. Containers and attached * components use these methods to register interest in this * <code>Action</code> object. When its enabled state or other property * changes, the registered listeners are informed of the change. * @param listener a <code>PropertyChangeListener</code> object * Removes a <code>PropertyChange</code> listener. * @param listener a <code>PropertyChangeListener</code> object * @see #addPropertyChangeListener