javax.swing: public class: ActionMap

javax.swing
public class: ActionMap [javadoc | source]

java.lang.Object
   javax.swing.ActionMap

All Implemented Interfaces:
Serializable

Direct Known Subclasses:
LazyActionMap, ActionMapUIResource, KeymapActionMap

ActionMap provides mappings from Objects (called keys or Action names) to Actions. An ActionMap is usually used with an InputMap to locate a particular action when a key is pressed. As with InputMap, an ActionMap can have a parent that is searched for keys not defined in the ActionMap.

As with InputMap if you create a cycle, eg:

ActionMap am = new ActionMap();
ActionMap bm = new ActionMap():
am.setParent(bm);
bm.setParent(am);

some of the methods will cause a StackOverflowError to be thrown.

Also see:

InputMap

author: Scott - Violet

since: 1.3 -

Constructor:

Constructor:
public ActionMap() { } Creates an `ActionMap` with no parent and no mappings.

 public ActionMap() {

}

Creates an ActionMap with no parent and no mappings.

Method from javax.swing.ActionMap Summary:
allKeys, clear, get, getParent, keys, put, remove, setParent, size

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from javax.swing.ActionMap Detail:
public Object[] allKeys() { int count = size(); ActionMap parent = getParent(); if (count == 0) { if (parent != null) { return parent.allKeys(); } return keys(); } if (parent == null) { return keys(); } Object[] keys = keys(); Object[] 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]); } return keyMap.keySet().toArray(); } Returns an array of the keys defined in this `ActionMap` and its parent. This method differs from `keys()` in that this method includes the keys defined in the parent.
public void clear() { if (arrayTable != null) { arrayTable.clear(); } } Removes all the mappings from this `ActionMap`.
public Action get(Object key) { Action value = (arrayTable == null) ? null : (Action)arrayTable.get(key); if (value == null) { ActionMap parent = getParent(); if (parent != null) { return parent.get(key); } } return value; } Returns the binding for `key`, messaging the parent `ActionMap` if the binding is not locally defined.
public ActionMap getParent() { return parent; } Returns this `ActionMap`'s parent.
public Object[] keys() { if (arrayTable == null) { return null; } return arrayTable.getKeys(null); } Returns the `Action` names that are bound in this `ActionMap`.
public void put(Object key, Action action) { if (key == null) { return; } if (action == null) { remove(key); } else { if (arrayTable == null) { arrayTable = new ArrayTable(); } arrayTable.put(key, action); } } Adds a binding for `key` to `action`. If `action` is null, this removes the current binding for `key`. In most instances, `key` will be `action.getValue(NAME)`.
public void remove(Object key) { if (arrayTable != null) { arrayTable.remove(key); } } Removes the binding for `key` from this `ActionMap`.
public void setParent(ActionMap map) { this.parent = map; } Sets this `ActionMap`'s parent.
public int size() { if (arrayTable == null) { return 0; } return arrayTable.size(); } Returns the number of bindings in this {@code ActionMap}.

Method from javax.swing.ActionMap Detail:

 public Object[] allKeys() {
        int           count = size();
        ActionMap     parent = getParent();
        if (count == 0) {
            if (parent != null) {
                return parent.allKeys();
            }
            return keys();
        }
        if (parent == null) {
            return keys();
        }
        Object[]    keys = keys();
        Object[]    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]);
        }
        return keyMap.keySet().toArray();
}

ActionMap

keys()

 public  void clear() {
        if (arrayTable != null) {
            arrayTable.clear();
        }
}

ActionMap

 public Action get(Object key) {
        Action value = (arrayTable == null) ? null :
                       (Action)arrayTable.get(key);
        if (value == null) {
            ActionMap    parent = getParent();
            if (parent != null) {
                return parent.get(key);
            }
        }
        return value;
}

key

ActionMap

 public ActionMap getParent() {
        return parent;
}

ActionMap

 public Object[] keys() {
        if (arrayTable == null) {
            return null;
        }
        return arrayTable.getKeys(null);
}

Action

ActionMap

 public  void put(Object key,
    Action action) {
        if (key == null) {
            return;
        }
        if (action == null) {
            remove(key);
        }
        else {
            if (arrayTable == null) {
                arrayTable = new ArrayTable();
            }
            arrayTable.put(key, action);
        }
}

key

action

key

In most instances, key will be action.getValue(NAME).

 public  void remove(Object key) {
        if (arrayTable != null) {
            arrayTable.remove(key);
        }
}

key

ActionMap

 public  void setParent(ActionMap map) {
        this.parent = map;
}

ActionMap

 public int size() {
        if (arrayTable == null) {
            return 0;
        }
        return arrayTable.size();
}

Returns the number of bindings in this {@code ActionMap}.