javax.swing
Class ActionMap
- java.lang.Object
-
- javax.swing.ActionMap
-
- All Implemented Interfaces:
- Serializable
- Direct Known Subclasses:
- ActionMapUIResource
public class ActionMap extends Object implements Serializable
ActionMapprovides mappings fromObjects (called keys orActionnames) toActions. AnActionMapis usually used with anInputMapto locate a particular action when a key is pressed. As withInputMap, anActionMapcan have a parent that is searched for keys not defined in theActionMap.As with
InputMapif 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:
-
InputMap
-
-
Constructor Summary
Constructors Constructor and Description ActionMap()Creates anActionMapwith no parent and no mappings.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description Object[]allKeys()Returns an array of the keys defined in thisActionMapand its parent.voidclear()Removes all the mappings from thisActionMap.Actionget(Object key)Returns the binding forkey, messaging the parentActionMapif the binding is not locally defined.ActionMapgetParent()Returns thisActionMap's parent.Object[]keys()Returns theActionnames that are bound in thisActionMap.voidput(Object key, Action action)Adds a binding forkeytoaction.voidremove(Object key)Removes the binding forkeyfrom thisActionMap.voidsetParent(ActionMap map)Sets thisActionMap's parent.intsize()Returns the number of bindings in thisActionMap.
-
-
-
Constructor Detail
ActionMap
public ActionMap()
Creates anActionMapwith no parent and no mappings.
-
Method Detail
setParent
public void setParent(ActionMap map)
Sets thisActionMap's parent.- Parameters:
-
map- theActionMapthat is the parent of this one
getParent
public ActionMap getParent()
Returns thisActionMap's parent.- Returns:
-
the
ActionMapthat is the parent of this one, or null if thisActionMaphas no parent
put
public void put(Object key, Action action)
Adds a binding forkeytoaction. Ifactionis null, this removes the current binding forkey.In most instances,
keywill beaction.getValue(NAME).
get
public Action get(Object key)
Returns the binding forkey, messaging the parentActionMapif the binding is not locally defined.
remove
public void remove(Object key)
Removes the binding forkeyfrom thisActionMap.
clear
public void clear()
Removes all the mappings from thisActionMap.
keys
public Object[] keys()
Returns theActionnames that are bound in thisActionMap.
size
public int size()
Returns the number of bindings in thisActionMap.- Returns:
-
the number of bindings in this
ActionMap
allKeys
public Object[] 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.
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
