/*
* @(#)InputMap.java 1.14 03/12/19
*
* Copyright 2004 Sun Microsystems, Inc. All rights reserved.
* SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
*/
package javax.swing;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.io.Serializable;
import java.util.HashMap;
import java.util.Set;
/**
* InputMap
provides a binding between an input event
* (currently only KeyStroke
s are used)
* and an Object
. InputMap
s
* are usually used with an ActionMap
,
* to determine an Action
to perform
* when a key is pressed.
* An InputMap
can have a parent
* that is searched for bindings not defined in the InputMap
.
*
As with ActionMap
if you create a cycle, eg:
*
* InputMap am = new InputMap(); * InputMap bm = new InputMap(): * am.setParent(bm); * bm.setParent(am); ** some of the methods will cause a StackOverflowError to be thrown. * * @version 1.14 12/19/03 * @author Scott Violet * @since 1.3 */ public class InputMap implements Serializable { /** Handles the mapping between KeyStroke and Action name. */ private transient ArrayTable arrayTable; /** Parent that handles any bindings we don't contain. */ private InputMap parent; /** * Creates an
InputMap
with no parent and no mappings.
*/
public InputMap() {
}
/**
* Sets this InputMap
's parent.
*
* @param map the InputMap
that is the parent of this one
*/
public void setParent(InputMap map) {
this.parent = map;
}
/**
* Gets this InputMap
's parent.
*
* @return map the InputMap
that is the parent of this one,
* or null if this InputMap
has no parent
*/
public InputMap getParent() {
return parent;
}
/**
* Adds a binding for keyStroke
to actionMapKey
.
* If actionMapKey
is null, this removes the current binding
* for keyStroke
.
*/
public void put(KeyStroke keyStroke, Object actionMapKey) {
if (keyStroke == null) {
return;
}
if (actionMapKey == null) {
remove(keyStroke);
}
else {
if (arrayTable == null) {
arrayTable = new ArrayTable();
}
arrayTable.put(keyStroke, actionMapKey);
}
}
/**
* Returns the binding for keyStroke
, messaging the
* parent InputMap
if the binding is not locally defined.
*/
public Object get(KeyStroke keyStroke) {
if (arrayTable == null) {
InputMap parent = getParent();
if (parent != null) {
return parent.get(keyStroke);
}
return null;
}
Object value = arrayTable.get(keyStroke);
if (value == null) {
InputMap parent = getParent();
if (parent != null) {
return parent.get(keyStroke);
}
}
return value;
}
/**
* Removes the binding for key
from this
* InputMap
.
*/
public void remove(KeyStroke key) {
if (arrayTable != null) {
arrayTable.remove(key);
}
}
/**
* Removes all the mappings from this InputMap
.
*/
public void clear() {
if (arrayTable != null) {
arrayTable.clear();
}
}
/**
* Returns the KeyStroke
s that are bound in this InputMap
.
*/
public KeyStroke[] keys() {
if (arrayTable == null) {
return null;
}
KeyStroke[] keys = new KeyStroke[arrayTable.size()];
arrayTable.getKeys(keys);
return keys;
}
/**
* Returns the number of KeyStroke
bindings.
*/
public int size() {
if (arrayTable == null) {
return 0;
}
return arrayTable.size();
}
/**
* Returns an array of the KeyStroke
s defined in this
* InputMap
and its parent. This differs from keys()
in that
* this method includes the keys defined in the parent.
*/
public KeyStroke[] allKeys() {
int count = size();
InputMap parent = getParent();
if (count == 0) {
if (parent != null) {
return parent.allKeys();
}
return keys();
}
if (parent == null) {
return keys();
}
KeyStroke[] keys = keys();
KeyStroke[] pKeys = parent.allKeys();
if (pKeys == null) {
return keys;
}
if (keys == null) {
// Should only happen if size() != keys.length, which should only
// happen if mutated from multiple threads (or a bogus subclass).
return pKeys;
}
HashMap keyMap = new HashMap();
int counter;
for (counter = keys.length - 1; counter >= 0; counter--) {
keyMap.put(keys[counter], keys[counter]);
}
for (counter = pKeys.length - 1; counter >= 0; counter--) {
keyMap.put(pKeys[counter], pKeys[counter]);
}
KeyStroke[] allKeys = new KeyStroke[keyMap.size()];
return (KeyStroke[])keyMap.keySet().toArray(allKeys);
}
private void writeObject(ObjectOutputStream s) throws IOException {
s.defaultWriteObject();
ArrayTable.writeArrayTable(s, arrayTable);
}
private void readObject(ObjectInputStream s) throws ClassNotFoundException,
IOException {
s.defaultReadObject();
for (int counter = s.readInt() - 1; counter >= 0; counter--) {
put((KeyStroke)s.readObject(), s.readObject());
}
}
}