Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

javax.swing

Class AbstractAction

Implemented Interfaces:
Action, ActionListener, Cloneable, EventListener, Serializable
Known Direct 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
public abstract class AbstractAction
extends Object
implements Action, Cloneable, Serializable
A base class for implementing the Action interface.
See Also:
Serialized Form

Field Summary

protected SwingPropertyChangeSupport
changeSupport
Provides support for property change event notification.
protected boolean
enabled
A flag that indicates whether or not the action is enabled.

Fields inherited from interface javax.swing.Action

ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SHORT_DESCRIPTION, SMALL_ICON

Constructor Summary

AbstractAction()
Creates a new action with no properties set.
AbstractAction(String name)
Creates a new action with the specified name.
AbstractAction(String name, Icon icon)
Creates a new action with the specified name and icon.

Method Summary

void
addPropertyChangeListener(PropertyChangeListener listener)
Registers a listener to receive PropertyChangeEvent notifications from this action.
protected Object
clone()
Returns a clone of the action.
protected void
firePropertyChange(String propertyName, Object oldValue, Object newValue)
Sends a PropertyChangeEvent for the named property to all registered listeners.
Object[]
getKeys()
Returns an array of the keys for the property values that have been defined via the putValue(String,Object) method (or the class constructor).
PropertyChangeListener[]
getPropertyChangeListeners()
Returns all registered listeners.
Object
getValue(String key)
Returns the value associated with the specified key.
boolean
isEnabled()
Returns the flag that indicates whether or not the action is enabled.
void
putValue(String key, Object value)
Sets the value associated with the specified key and sends a PropertyChangeEvent to all registered listeners.
void
removePropertyChangeListener(PropertyChangeListener listener)
Deregisters a listener so that it no longer receives PropertyChangeEvent notifications from this action.
void
setEnabled(boolean enabled)
Sets the flag that indicates whether or not the action is enabled and, if the value of the flag changed from the previous setting, sends a PropertyChangeEvent to all registered listeners (using the property name 'enabled').

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

changeSupport

protected SwingPropertyChangeSupport changeSupport
Provides support for property change event notification.

enabled

protected boolean enabled
A flag that indicates whether or not the action is enabled.

Constructor Details

AbstractAction

public AbstractAction()
Creates a new action with no properties set.

AbstractAction

public AbstractAction(String name)
Creates a new action with the specified name. The name is stored as a property with the key Action.NAME, and no other properties are initialised.
Parameters:
name - the name (null permitted).

AbstractAction

public AbstractAction(String name,
                      Icon icon)
Creates a new action with the specified name and icon. The name is stored as a property with the key Action.NAME, the icon is stored as a property with the key Action.SMALL_ICON, and no other properties are initialised.
Parameters:
name - the name (null permitted).
icon - the icon (null permitted).

Method Details

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)
Registers a listener to receive PropertyChangeEvent notifications from this action.
Specified by:
addPropertyChangeListener in interface Action
Parameters:
listener - the listener.
See Also:
removePropertyChangeListener(PropertyChangeListener)

clone

protected Object clone()
            throws CloneNotSupportedException
Returns a clone of the action.
Overrides:
clone in interface Object
Returns:
A clone of the action.
Throws:
CloneNotSupportedException - if there is a problem cloning the action.

firePropertyChange

protected void firePropertyChange(String propertyName,
                                  Object oldValue,
                                  Object newValue)
Sends a PropertyChangeEvent for the named property to all registered listeners.
Parameters:
propertyName - the property name.
oldValue - the old value of the property.
newValue - the new value of the property.

getKeys

public Object[] getKeys()
Returns an array of the keys for the property values that have been defined via the putValue(String,Object) method (or the class constructor).
Returns:
An array of keys.

getPropertyChangeListeners

public PropertyChangeListener[] getPropertyChangeListeners()
Returns all registered listeners.
Returns:
An array of listeners.
Since:
1.4

getValue

public Object getValue(String key)
Returns the value associated with the specified key.
Specified by:
getValue in interface Action
Parameters:
key - the key (not null).
Returns:
The value associated with the specified key, or null if the key is not found.
See Also:
putValue(String,Object)

isEnabled

public boolean isEnabled()
Returns the flag that indicates whether or not the action is enabled.
Specified by:
isEnabled in interface Action
Returns:
The flag.
See Also:
setEnabled(boolean)

putValue

public void putValue(String key,
                     Object value)
Sets the value associated with the specified key and sends a PropertyChangeEvent to all registered listeners. The standard keys are: Any existing value associated with the key will be overwritten.
Specified by:
putValue in interface Action
Parameters:
key - the key (not null).
value - the value (null permitted).

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)
Deregisters a listener so that it no longer receives PropertyChangeEvent notifications from this action.
Specified by:
removePropertyChangeListener in interface Action
Parameters:
listener - the listener.
See Also:
addPropertyChangeListener(PropertyChangeListener)

setEnabled

public void setEnabled(boolean enabled)
Sets the flag that indicates whether or not the action is enabled and, if the value of the flag changed from the previous setting, sends a PropertyChangeEvent to all registered listeners (using the property name 'enabled').
Specified by:
setEnabled in interface Action
Parameters:
enabled - the new flag value.
See Also:
isEnabled()
AbstractAction.java -- Copyright (C) 2002, 2004, 2005, 2006 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About