| /* AbstractAction.java -- |
| Copyright (C) 2002, 2004, 2005 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., 59 Temple Place, Suite 330, Boston, MA |
| 02111-1307 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. */ |
| |
| |
| package javax.swing; |
| |
| import java.beans.PropertyChangeListener; |
| import java.io.IOException; |
| import java.io.ObjectInputStream; |
| import java.io.ObjectOutputStream; |
| import java.io.Serializable; |
| import java.util.HashMap; |
| |
| import javax.swing.event.SwingPropertyChangeSupport; |
| |
| /** |
| * AbstractAction |
| * @author Andrew Selkirk |
| * @version 1.0 |
| */ |
| public abstract class AbstractAction |
| implements Action, Cloneable, Serializable |
| { |
| private static final long serialVersionUID = -6803159439231523484L; |
| |
| /** |
| * enabled |
| */ |
| protected boolean enabled = true; |
| |
| /** |
| * changeSupport |
| */ |
| protected SwingPropertyChangeSupport changeSupport = |
| new SwingPropertyChangeSupport(this); |
| |
| /** |
| * store |
| */ |
| private transient HashMap store = new HashMap(); |
| |
| /** |
| * Constructor AbstractAction |
| */ |
| public AbstractAction() |
| { |
| this(""); // TODO: default name |
| } |
| |
| /** |
| * Constructor AbstractAction |
| * |
| * @param name TODO |
| */ |
| public AbstractAction(String name) |
| { |
| this(name, null); // TODO: default icon?? |
| } |
| |
| /** |
| * Constructor AbstractAction |
| * |
| * @param name TODO |
| * @param icon TODO |
| */ |
| public AbstractAction(String name, Icon icon) |
| { |
| putValue(NAME, name); |
| putValue(SMALL_ICON, icon); |
| } |
| |
| /** |
| * readObject |
| * |
| * @param stream the stream to read from |
| * |
| * @exception ClassNotFoundException TODO |
| * @exception IOException if an error occurs |
| */ |
| private void readObject(ObjectInputStream stream) |
| throws ClassNotFoundException, IOException |
| { |
| // TODO |
| } |
| |
| /** |
| * writeObject |
| * |
| * @param stream the stream to write to |
| * |
| * @exception IOException if an error occurs |
| */ |
| private void writeObject(ObjectOutputStream stream) throws IOException |
| { |
| // TODO |
| } |
| |
| /** |
| * clone |
| * |
| * @return Object |
| * |
| * @exception CloneNotSupportedException TODO |
| */ |
| protected Object clone() throws CloneNotSupportedException |
| { |
| AbstractAction copy = (AbstractAction) super.clone(); |
| copy.store = (HashMap) store.clone(); |
| return copy; |
| } |
| |
| /** |
| * Returns a value for a given key from the built-in store. |
| * |
| * @param key the key to get the value for |
| * |
| * @return Object |
| */ |
| public Object getValue(String key) |
| { |
| return store.get(key); |
| } |
| |
| /** |
| * Puts a key/value pair into the built-in store. |
| * |
| * @param key the key |
| * @param value the value |
| */ |
| public void putValue(String key, Object value) |
| { |
| Object old = getValue(key); |
| if (old != value) |
| { |
| store.put(key, value); |
| firePropertyChange(key, old, value); |
| } |
| } |
| |
| /** |
| * isEnabled |
| * |
| * @return boolean |
| */ |
| public boolean isEnabled() |
| { |
| return enabled; |
| } |
| |
| /** |
| * setEnabled |
| * |
| * @param enabled TODO |
| */ |
| public void setEnabled(boolean enabled) |
| { |
| if (enabled != this.enabled) |
| { |
| this.enabled = enabled; |
| firePropertyChange("enabled", !this.enabled, this.enabled); |
| } |
| } |
| |
| /** |
| * getKeys |
| * @returns Object[] |
| */ |
| public Object[] getKeys() |
| { |
| return store.keySet().toArray(); |
| } |
| |
| /** |
| * This method fires a PropertyChangeEvent given the propertyName |
| * and the old and new values. |
| * |
| * @param propertyName The property that changed. |
| * @param oldValue The old value of the property. |
| * @param newValue The new value of the property. |
| */ |
| protected void firePropertyChange(String propertyName, Object oldValue, |
| Object newValue) |
| { |
| changeSupport.firePropertyChange(propertyName, oldValue, newValue); |
| } |
| |
| /** |
| * This convenience method fires a PropertyChangeEvent given |
| * the propertyName and the old and new values. |
| * |
| * @param propertyName The property that changed. |
| * @param oldValue The old value of the property. |
| * @param newValue The new value of the property. |
| */ |
| private void firePropertyChange(String propertyName, boolean oldValue, boolean newValue) |
| { |
| changeSupport.firePropertyChange(propertyName, oldValue, newValue); |
| } |
| |
| /** |
| * addPropertyChangeListener |
| * |
| * @param listener the listener to add |
| */ |
| public void addPropertyChangeListener(PropertyChangeListener listener) |
| { |
| changeSupport.addPropertyChangeListener(listener); |
| } |
| |
| /** |
| * removePropertyChangeListener |
| * |
| * @param listener the listener to remove |
| */ |
| public void removePropertyChangeListener(PropertyChangeListener listener) |
| { |
| changeSupport.removePropertyChangeListener(listener); |
| } |
| |
| /** |
| * Returns all registered listeners. |
| * |
| * @return array of listeners. |
| * |
| * @since 1.4 |
| */ |
| public PropertyChangeListener[] getPropertyChangeListeners() |
| { |
| return changeSupport.getPropertyChangeListeners(); |
| } |
| } |