javax.swing
Class ActionMap

java.lang.Object
  extended by javax.swing.ActionMap
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
ActionMapUIResource

public class ActionMap
extends Object
implements Serializable

Maps arbitrary keys (usually Strings) to Action instances. This is used in combination with InputMaps. If a component receives an input event, this is looked up in the component's InputMap. The result is an object which serves as a key to the components ActionMap. Finally the Action that is stored is executed.

See Also:
Serialized Form

Constructor Summary
ActionMap()
          Creates a new ActionMap instance.
 
Method Summary
 Object[] allKeys()
          Returns all keys of entries in this ActionMap and all its parents.
 void clear()
          Clears the ActionMap.
 Action get(Object key)
          Returns an action associated with an object.
 ActionMap getParent()
          Returns the parent of this ActionMap.
 Object[] keys()
          Returns all keys of entries in this ActionMap.
 void put(Object key, Action action)
          Puts a new Action into the ActionMap.
 void remove(Object key)
          Remove an entry from the ActionMap.
 void setParent(ActionMap parentMap)
          Sets a parent for this ActionMap.
 int size()
          Returns the number of entries in this ActionMap.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ActionMap

public ActionMap()
Creates a new ActionMap instance.

Method Detail

get

public Action get(Object key)
Returns an action associated with an object.

Parameters:
key - the key of the enty
Returns:
the action associated with key, may be null

put

public void put(Object key,
                Action action)
Puts a new Action into the ActionMap. If action is null an existing entry will be removed.

Parameters:
key - the key for the entry
action - the action.

remove

public void remove(Object key)
Remove an entry from the ActionMap.

Parameters:
key - the key of the entry to remove

getParent

public ActionMap getParent()
Returns the parent of this ActionMap.

Returns:
the parent, may be null.

setParent

public void setParent(ActionMap parentMap)
Sets a parent for this ActionMap.

Parameters:
parentMap - the new parent

size

public int size()
Returns the number of entries in this ActionMap.

Returns:
the number of entries

clear

public void clear()
Clears the ActionMap.


keys

public Object[] keys()
Returns all keys of entries in this ActionMap.

Returns:
an array of keys

allKeys

public Object[] allKeys()
Returns all keys of entries in this ActionMap and all its parents.

Returns:
an array of keys