- java.lang.Object
-
- javax.swing.ActionMap
-
- All Implemented Interfaces:
- Serializable
- Direct Known Subclasses:
- ActionMapUIResource
public class ActionMap extends Object implements Serializable
ActionMap
provides mappings fromObject
s (called keys orAction
names) toAction
s. 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 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:
InputMap
-
-
Constructor Summary
Constructors Constructor and Description ActionMap()
Creates anActionMap
with no parent and no mappings.
-
Method Summary
Methods Modifier and Type Method and Description Object[]
allKeys()
Returns an array of the keys defined in thisActionMap
and its parent.void
clear()
Removes all the mappings from thisActionMap
.Action
get(Object key)
Returns the binding forkey
, messaging the parentActionMap
if the binding is not locally defined.ActionMap
getParent()
Returns thisActionMap
's parent.Object[]
keys()
Returns theAction
names that are bound in thisActionMap
.void
put(Object key, Action action)
Adds a binding forkey
toaction
.void
remove(Object key)
Removes the binding forkey
from thisActionMap
.void
setParent(ActionMap map)
Sets thisActionMap
's parent.int
size()
Returns the number of bindings in thisActionMap
.
-
-
-
Constructor Detail
-
ActionMap
public ActionMap()
Creates anActionMap
with no parent and no mappings.
-
-
Method Detail
-
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:
- the
ActionMap
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)
.
-
get
public Action get(Object key)
Returns the binding forkey
, messaging the parentActionMap
if the binding is not locally defined.
-
remove
public void remove(Object key)
Removes the binding forkey
from thisActionMap
.
-
clear
public void clear()
Removes all the mappings from thisActionMap
.
-
keys
public Object[] keys()
Returns theAction
names 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 thisActionMap
and its parent. This method differs fromkeys()
in that this method includes the keys defined in the parent.
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/swing/actionmap.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.