Class ActionMap

java.lang.Object
javax.swing.ActionMap
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
ActionMapUIResource
public classActionMapextendsObjectimplementsSerializable
ActionMap provides mappings fromObjects (calledkeys orAction names) toActions. AnActionMap is usually used with anInputMap to locate a particular action when a key is pressed. As withInputMap, anActionMap can have a parent that is searched for keys not defined in theActionMap.

As withInputMap 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.

Since:
1.3
See Also:

  • Constructor Details

    • ActionMap

      public ActionMap()
      Creates anActionMap with no parent and no mappings.

  • Method Details

    • setParent

      public void setParent(ActionMap map)
      Sets thisActionMap's parent.
      Parameters:
      map - theActionMap that is the parent of this one

    • getParent

      public ActionMap getParent()
      Returns thisActionMap's parent.
      Returns:
      theActionMap that is the parent of this one, or null if thisActionMap has no parent

    • put

      public void put(Object key,Action action)
      Adds a binding forkey toaction. Ifaction is null, this removes the current binding forkey.

      In most instances,key will beaction.getValue(NAME).

      Parameters:
      key - a key
      action - a binding forkey

    • get

      public Action get(Object key)
      Returns the binding forkey, messaging the parentActionMap if the binding is not locally defined.
      Parameters:
      key - a key
      Returns:
      the binding forkey

    • remove

      public void remove(Object key)
      Removes the binding forkey from thisActionMap.
      Parameters:
      key - a key

    • clear

      public void clear()
      Removes all the mappings from thisActionMap.

    • keys

      public Object[] keys()
      Returns theAction names that are bound in thisActionMap.
      Returns:
      an array of the keys

    • size

      public int size()
      Returns the number of bindings in thisActionMap.
      Returns:
      the number of bindings in thisActionMap

    • allKeys

      public Object[] allKeys()
      Returns an array of the keys defined in thisActionMap and its parent. This method differs fromkeys() in that this method includes the keys defined in the parent.
      Returns:
      an array of the keys