java.lang.Object
javax.swing.ActionMap
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
ActionMapUIResource
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.
- Since:
- 1.3
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionObject[]allKeys()Returns an array of the keys defined in thisActionMapand its parent.voidclear()Removes all the mappings from thisActionMap.Returns the binding forkey, messaging the parentActionMapif the binding is not locally defined.Returns thisActionMap's parent.Object[]keys()Returns theActionnames that are bound in thisActionMap.voidAdds a binding forkeytoaction.voidRemoves the binding forkeyfrom thisActionMap.voidSets thisActionMap's parent.intsize()Returns the number of bindings in thisActionMap.
-
Constructor Details
-
ActionMap
public ActionMap()Creates anActionMapwith no parent and no mappings.
-
-
Method Details
-
setParent
Sets thisActionMap's parent.- Parameters:
map- theActionMapthat is the parent of this one
-
getParent
Returns thisActionMap's parent.- Returns:
- the
ActionMapthat is the parent of this one, or null if thisActionMaphas no parent
-
put
Adds a binding forkeytoaction. Ifactionis null, this removes the current binding forkey.In most instances,
keywill beaction.getValue(NAME).- Parameters:
key- a keyaction- a binding forkey
-
get
Returns the binding forkey, messaging the parentActionMapif the binding is not locally defined.- Parameters:
key- a key- Returns:
- the binding for
key
-
remove
Removes the binding forkeyfrom thisActionMap.- Parameters:
key- a key
-
clear
public void clear()Removes all the mappings from thisActionMap. -
keys
Returns theActionnames 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 this
ActionMap
-
allKeys
Returns an array of the keys defined in thisActionMapand its parent. This method differs fromkeys()in that this method includes the keys defined in the parent.- Returns:
- an array of the keys
-