java.lang.Object
javax.swing.AbstractAction
- All Implemented Interfaces:
ActionListener,Serializable,Cloneable,EventListener,Action
- Direct Known Subclasses:
BasicDesktopPaneUI.CloseAction,BasicDesktopPaneUI.MaximizeAction,BasicDesktopPaneUI.MinimizeAction,BasicDesktopPaneUI.NavigateAction,BasicDesktopPaneUI.OpenAction,BasicFileChooserUI.ApproveSelectionAction,BasicFileChooserUI.CancelSelectionAction,BasicFileChooserUI.ChangeToParentDirectoryAction,BasicFileChooserUI.GoHomeAction,BasicFileChooserUI.NewFolderAction,BasicFileChooserUI.UpdateAction,BasicInternalFrameTitlePane.CloseAction,BasicInternalFrameTitlePane.IconifyAction,BasicInternalFrameTitlePane.MaximizeAction,BasicInternalFrameTitlePane.MoveAction,BasicInternalFrameTitlePane.RestoreAction,BasicInternalFrameTitlePane.SizeAction,BasicSliderUI.ActionScroller,BasicTreeUI.TreeCancelEditingAction,BasicTreeUI.TreeHomeAction,BasicTreeUI.TreeIncrementAction,BasicTreeUI.TreePageAction,BasicTreeUI.TreeToggleAction,BasicTreeUI.TreeTraverseAction,MetalFileChooserUI.DirectoryComboBoxAction,TextAction
This class provides default implementations for the JFC
Action
interface. Standard behaviors like the get and set methods for
Action object properties (icon, text, and enabled) are defined
here. The developer need only subclass this abstract class and
define the actionPerformed method.
Warning:
Serialized objects of this class will not be compatible with
future Swing releases. The current serialization support is
appropriate for short term storage or RMI between applications running
the same version of Swing. As of 1.4, support for long term storage
of all JavaBeans
has been added to the java.beans package.
Please see XMLEncoder.
- Since:
- 1.2
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected SwingPropertyChangeSupportIf anyPropertyChangeListenershave been registered, thechangeSupportfield describes them.protected booleanSpecifies whether action is enabled; the default is true.Fields declared in interface javax.swing.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
ConstructorsConstructorDescriptionCreates anAction.AbstractAction(String name) Creates anActionwith the specified name.AbstractAction(String name, Icon icon) Creates anActionwith the specified name and small icon. -
Method Summary
Modifier and TypeMethodDescriptionvoidAdds aPropertyChangeListenerto the listener list.protected Objectclone()Clones the abstract action.protected voidfirePropertyChange(String propertyName, Object oldValue, Object newValue) Supports reporting bound property changes.Object[]getKeys()Returns an array ofObjects which are keys for which values have been set for thisAbstractAction, ornullif no keys have values set.Returns an array of all thePropertyChangeListeners added to this AbstractAction with addPropertyChangeListener().Gets theObjectassociated with the specified key.booleanReturns true if the action is enabled.voidSets theValueassociated with the specified key.voidRemoves aPropertyChangeListenerfrom the listener list.voidsetEnabled(boolean newValue) Sets whether theActionis enabled.Methods declared in class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods declared in interface java.awt.event.ActionListener
actionPerformed
-
Field Details
-
enabled
protected boolean enabledSpecifies whether action is enabled; the default is true. -
changeSupport
If anyPropertyChangeListenershave been registered, thechangeSupportfield describes them.
-
-
Constructor Details
-
AbstractAction
public AbstractAction()Creates anAction. -
AbstractAction
Creates anActionwith the specified name.- Parameters:
name- the name (Action.NAME) for the action; a value ofnullis ignored
-
AbstractAction
Creates anActionwith the specified name and small icon.- Parameters:
name- the name (Action.NAME) for the action; a value ofnullis ignoredicon- the small icon (Action.SMALL_ICON) for the action; a value ofnullis ignored
-
-
Method Details
-
getValue
Gets theObjectassociated with the specified key. -
putValue
Sets theValueassociated with the specified key. -
isEnabled
public boolean isEnabled()Returns true if the action is enabled. -
setEnabled
public void setEnabled(boolean newValue) Sets whether theActionis enabled. The default istrue.- Specified by:
setEnabledin interfaceAction- Parameters:
newValue-trueto enable the action,falseto disable it- See Also:
-
getKeys
Returns an array ofObjects which are keys for which values have been set for thisAbstractAction, ornullif no keys have values set.- Returns:
- an array of key objects, or
nullif no keys have values set - Since:
- 1.3
-
firePropertyChange
Supports reporting bound property changes. This method can be called when a bound property has changed and it will send the appropriatePropertyChangeEventto any registeredPropertyChangeListeners.- Parameters:
propertyName- the name of the property that has changedoldValue- the old value of the propertynewValue- the new value of the property
-
addPropertyChangeListener
Adds aPropertyChangeListenerto the listener list. The listener is registered for all properties.A
PropertyChangeEventwill get fired in response to setting a bound property, e.g.setFont,setBackground, orsetForeground. Note that if the current component is inheriting its foreground, background, or font from its container, then no event will be fired in response to a change in the inherited property.- Specified by:
addPropertyChangeListenerin interfaceAction- Parameters:
listener- ThePropertyChangeListenerto be added- See Also:
-
removePropertyChangeListener
Removes aPropertyChangeListenerfrom the listener list. This removes aPropertyChangeListenerthat was registered for all properties.- Specified by:
removePropertyChangeListenerin interfaceAction- Parameters:
listener- thePropertyChangeListenerto be removed- See Also:
-
getPropertyChangeListeners
Returns an array of all thePropertyChangeListeners added to this AbstractAction with addPropertyChangeListener().- Returns:
- all of the
PropertyChangeListeners added or an empty array if no listeners have been added - Since:
- 1.4
-
clone
Clones the abstract action. This gives the clone its own copy of the key/value list, which is not handled for you byObject.clone().- Overrides:
clonein classObject- Returns:
- a clone of this instance.
- Throws:
CloneNotSupportedException- if the object's class does not support theCloneableinterface. Subclasses that override theclonemethod can also throw this exception to indicate that an instance cannot be cloned.- See Also:
-