GNU Classpath (0.18) | ||
Frames | No Frames |
1: /* ActionMap.java -- 2: Copyright (C) 2002, 2004 Free Software Foundation, Inc. 3: 4: This file is part of GNU Classpath. 5: 6: GNU Classpath is free software; you can redistribute it and/or modify 7: it under the terms of the GNU General Public License as published by 8: the Free Software Foundation; either version 2, or (at your option) 9: any later version. 10: 11: GNU Classpath is distributed in the hope that it will be useful, but 12: WITHOUT ANY WARRANTY; without even the implied warranty of 13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 14: General Public License for more details. 15: 16: You should have received a copy of the GNU General Public License 17: along with GNU Classpath; see the file COPYING. If not, write to the 18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 19: 02110-1301 USA. 20: 21: Linking this library statically or dynamically with other modules is 22: making a combined work based on this library. Thus, the terms and 23: conditions of the GNU General Public License cover the whole 24: combination. 25: 26: As a special exception, the copyright holders of this library give you 27: permission to link this library with independent modules to produce an 28: executable, regardless of the license terms of these independent 29: modules, and to copy and distribute the resulting executable under 30: terms of your choice, provided that you also meet, for each linked 31: independent module, the terms and conditions of the license of that 32: module. An independent module is a module which is not derived from 33: or based on this library. If you modify this library, you may extend 34: this exception to your version of the library, but you are not 35: obligated to do so. If you do not wish to do so, delete this 36: exception statement from your version. */ 37: 38: package javax.swing; 39: 40: import java.io.IOException; 41: import java.io.ObjectInputStream; 42: import java.io.ObjectOutputStream; 43: import java.io.Serializable; 44: import java.util.Arrays; 45: import java.util.HashMap; 46: import java.util.HashSet; 47: import java.util.Map; 48: import java.util.Set; 49: 50: 51: /** 52: * Maps arbitrary keys (usually Strings) to {@link Action} instances. This 53: * is used in combination with {@link InputMap}s. 54: * 55: * If a component receives an input event, this is looked up in 56: * the component's <code>InputMap</code>. The result is an object which 57: * serves as a key to the components <code>ActionMap</code>. Finally 58: * the <code>Action</code> that is stored is executed. 59: * 60: * @author Andrew Selkirk 61: * @author Michael Koch 62: */ 63: public class ActionMap 64: implements Serializable 65: { 66: private static final long serialVersionUID = -6277518704513986346L; 67: 68: /** 69: * actionMap 70: */ 71: private Map actionMap = new HashMap(); 72: 73: /** 74: * parent 75: */ 76: private ActionMap parent; 77: 78: /** 79: * Creates a new <code>ActionMap</code> instance. 80: */ 81: public ActionMap() 82: { 83: } 84: 85: /** 86: * Returns an action associated with an object. 87: * 88: * @param key the key of the enty 89: * 90: * @return the action associated with key, may be null 91: */ 92: public Action get(Object key) 93: { 94: Object result = actionMap.get(key); 95: 96: if (result == null && parent != null) 97: result = parent.get(key); 98: 99: return (Action) result; 100: } 101: 102: /** 103: * Puts a new <code>Action</code> into the <code>ActionMap</code>. 104: * If action is null an existing entry will be removed. 105: * 106: * @param key the key for the entry 107: * @param action the action. 108: */ 109: public void put(Object key, Action action) 110: { 111: if (action == null) 112: actionMap.remove(key); 113: else 114: actionMap.put(key, action); 115: } 116: 117: /** 118: * Remove an entry from the <code>ActionMap</code>. 119: * 120: * @param key the key of the entry to remove 121: */ 122: public void remove(Object key) 123: { 124: actionMap.remove(key); 125: } 126: 127: /** 128: * Returns the parent of this <code>ActionMap</code>. 129: * 130: * @return the parent, may be null. 131: */ 132: public ActionMap getParent() 133: { 134: return parent; 135: } 136: 137: /** 138: * Sets a parent for this <code>ActionMap</code>. 139: * 140: * @param parentMap the new parent 141: */ 142: public void setParent(ActionMap parentMap) 143: { 144: if (parentMap != this) 145: parent = parentMap; 146: } 147: 148: /** 149: * Returns the number of entries in this <code>ActionMap</code>. 150: * 151: * @return the number of entries 152: */ 153: public int size() 154: { 155: return actionMap.size(); 156: } 157: 158: /** 159: * Clears the <code>ActionMap</code>. 160: */ 161: public void clear() 162: { 163: actionMap.clear(); 164: } 165: 166: /** 167: * Returns all keys of entries in this <code>ActionMap</code>. 168: * 169: * @return an array of keys 170: */ 171: public Object[] keys() 172: { 173: return actionMap.keySet().toArray(); 174: } 175: 176: /** 177: * Returns all keys of entries in this <code>ActionMap</code> 178: * and all its parents. 179: * 180: * @return an array of keys 181: */ 182: public Object[] allKeys() 183: { 184: Set set = new HashSet(); 185: 186: if (parent != null) 187: set.addAll(Arrays.asList(parent.allKeys())); 188: 189: set.addAll(actionMap.keySet()); 190: return set.toArray(); 191: } 192: 193: /** 194: * writeObject 195: * 196: * @param stream the stream to write to 197: * 198: * @exception IOException If an error occurs 199: */ 200: private void writeObject(ObjectOutputStream stream) 201: throws IOException 202: { 203: // TODO 204: } 205: 206: /** 207: * readObject 208: * 209: * @param stream the stream to read from 210: * 211: * @exception ClassNotFoundException If the serialized class cannot be found 212: * @exception IOException If an error occurs 213: */ 214: private void readObject(ObjectInputStream stream) 215: throws ClassNotFoundException, IOException 216: { 217: // TODO 218: } 219: }
GNU Classpath (0.18) |