diff options
| -rw-r--r-- | ChangeLog | 5 | ||||
| -rw-r--r-- | javax/swing/AbstractAction.java | 57 | ||||
| -rw-r--r-- | javax/swing/Action.java | 77 |
3 files changed, 85 insertions, 54 deletions
@@ -1,5 +1,10 @@ 2005-07-05 David Gilbert <david.gilbert@object-refinery.com> + * javax/swing/AbstractAction.java: updated API docs, + * javax/swing/Action.java: likewise. + +2005-07-05 David Gilbert <david.gilbert@object-refinery.com> + * java/applet/Applet.java: added import to fix API doc link. 2005-07-05 Audrius Meskauskas <AudriusA@Bioinformatics.org> diff --git a/javax/swing/AbstractAction.java b/javax/swing/AbstractAction.java index a58c8b420..6bb423394 100644 --- a/javax/swing/AbstractAction.java +++ b/javax/swing/AbstractAction.java @@ -48,7 +48,8 @@ import java.util.HashMap; import javax.swing.event.SwingPropertyChangeSupport; /** - * AbstractAction + * A base class for implementing the {@link Action} interface. + * * @author Andrew Selkirk * @version 1.0 */ @@ -58,12 +59,12 @@ public abstract class AbstractAction private static final long serialVersionUID = -6803159439231523484L; /** - * enabled + * A flag that indicates whether or not the action is enabled. */ protected boolean enabled = true; /** - * changeSupport + * Provides support for property change event notification. */ protected SwingPropertyChangeSupport changeSupport = new SwingPropertyChangeSupport(this); @@ -74,7 +75,8 @@ public abstract class AbstractAction private transient HashMap store = new HashMap(); /** - * Constructor AbstractAction + * Creates a new action with an empty string for the name. All other + * properties are initialised to <code>null</code> */ public AbstractAction() { @@ -82,9 +84,10 @@ public abstract class AbstractAction } /** - * Constructor AbstractAction + * Creates a new action with the specified name. All other properties are + * initialised to <code>null</code>. * - * @param name TODO + * @param name the name (<code>null</code> permitted). */ public AbstractAction(String name) { @@ -92,10 +95,11 @@ public abstract class AbstractAction } /** - * Constructor AbstractAction + * Creates a new action with the specified name and icon. All other + * properties are initialised to <code>null</code>. * - * @param name TODO - * @param icon TODO + * @param name the name (<code>null</code> permitted). + * @param icon the icon (<code>null</code> permitted). */ public AbstractAction(String name, Icon icon) { @@ -144,11 +148,12 @@ public abstract class AbstractAction } /** - * Returns a value for a given key from the built-in store. - * - * @param key the key to get the value for - * - * @return Object + * Returns the value associated with the specified key. + * + * @param key the key (not <code>null</code>). + * + * @return The value associated with the specified key, or + * <code>null</code> if the key is not found. */ public Object getValue(String key) { @@ -156,10 +161,16 @@ public abstract class AbstractAction } /** - * Puts a key/value pair into the built-in store. - * - * @param key the key - * @param value the value + * Sets the value associated with the specified key and sends a + * {@link java.beans.PropertyChangeEvent} to all registered listeners. + * The standard keys are: {@link #NAME}, {@link #SHORT_DESCRIPTION}, + * {@link #LONG_DESCRIPTION}, {@link #SMALL_ICON}, + * {@link #ACTION_COMMAND_KEY}, {@link #ACCELERATOR_KEY} and + * {@link #MNEMONIC_KEY}. Any existing value associated with the key will be + * overwritten. + * + * @param key the key (not <code>null</code>). + * @param value the value (<code>null</code> permitted). */ public void putValue(String key, Object value) { @@ -172,9 +183,9 @@ public abstract class AbstractAction } /** - * isEnabled + * Returns the flag that indicates whether or not the action is enabled. * - * @return boolean + * @return The flag. */ public boolean isEnabled() { @@ -182,9 +193,11 @@ public abstract class AbstractAction } /** - * setEnabled + * 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 + * {@link java.beans.PropertyChangeEvent} to all registered listeners. * - * @param enabled TODO + * @param enabled the new flag value. */ public void setEnabled(boolean enabled) { diff --git a/javax/swing/Action.java b/javax/swing/Action.java index 16b37f146..17168c3be 100644 --- a/javax/swing/Action.java +++ b/javax/swing/Action.java @@ -1,5 +1,5 @@ /* Action.java -- - Copyright (C) 2002, 2004 Free Software Foundation, Inc. + Copyright (C) 2002, 2004, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. @@ -41,99 +41,112 @@ import java.awt.event.ActionListener; import java.beans.PropertyChangeListener; /** - * Action + * An action provides a convenient central point of control for some task + * that can be triggered by more than one control in a Swing user interface + * (for example, a menu item and a toolbar button). + * + * @see AbstractButton#setAction(Action) + * * @author Ronald Veldema (rveldema@cs.vu.nl) * @author Andrew Selkirk */ public interface Action extends ActionListener { /** - * DEFAULT + * A key to access the default property for the action (this is not used). */ String DEFAULT = "Default"; - /** - * LONG_DESCRIPTION + /** + * A key to access the long description for the action. */ String LONG_DESCRIPTION = "LongDescription"; /** - * NAME + * A key to access the name for the action. */ String NAME = "Name"; /** - * SHORT_DESCRIPTION + * A key to access the short description for the action (the short + * description is typically used as the tool tip text). */ String SHORT_DESCRIPTION = "ShortDescription"; /** - * SMALL_ICON + * A key to access the icon for the action. */ String SMALL_ICON = "SmallIcon"; /** - * ACCELERATOR_KEY + * A key to access the {@link KeyStroke} used as the accelerator for the + * action. */ String ACCELERATOR_KEY = "AcceleratorKey"; /** - * ACTION_COMMAND_KEY + * A key to access the action command string for the action. */ String ACTION_COMMAND_KEY = "ActionCommandKey"; /** - * MNEMONIC_KEY + * A key to access the mnemonic for the action. */ String MNEMONIC_KEY = "MnemonicKey"; - /** - * getValue + /** + * Returns the value associated with the specified key. + * + * @param key the key (not <code>null</code>). * - * @param key - * TODO - * @returns TODO + * @return The value associated with the specified key, or + * <code>null</code> if the key is not found. */ Object getValue(String key); /** - * setValue + * Sets the value associated with the specified key and sends a + * {@link java.beans.PropertyChangeEvent} to all registered listeners. + * The standard keys are defined in this interface: {@link #NAME}, + * {@link #SHORT_DESCRIPTION}, {@link #LONG_DESCRIPTION}, + * {@link #SMALL_ICON}, {@link #ACTION_COMMAND_KEY}, + * {@link #ACCELERATOR_KEY} and {@link #MNEMONIC_KEY}. Any existing value + * associated with the key will be overwritten. * - * @param key - * TODO - * @param value - * TODO + * @param key the key (not <code>null</code>). + * @param value the value (<code>null</code> permitted). */ void putValue(String key, Object value); /** - * isEnabled + * Returns the flag that indicates whether or not this action is enabled. * - * @returns TODO + * @return The flag. */ boolean isEnabled(); /** - * setEnabled + * Sets the flag that indicates whether or not this action is enabled. If + * the value changes, a {@link java.beans.PropertyChangeEvent} is sent to + * all registered listeners. * - * @param b - * TODO + * @param b the new value of the flag. */ void setEnabled(boolean b); /** - * addPropertyChangeListener + * Registers a listener to receive notification whenever one of the + * action's properties is modified. * - * @param listener - * TODO + * @param listener the listener. */ void addPropertyChangeListener(PropertyChangeListener listener); /** - * removePropertyChangeListener + * Deregisters a listener so that it no longer receives notification of + * changes to the action's properties. * - * @param listener - * TODO + * @param listener the listener. */ void removePropertyChangeListener(PropertyChangeListener listener); |