OpenJDK 27 · javax.swing.ActionMap · APIdia, the JavaDoc alternative

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.

Field Summary

Modifier and Type	Field and Description
private transient ArrayTable	arrayTable Handles the mapping between Action name and Action.
private ActionMap	parent Parent that handles any bindings we don't contain.

Constructor Summary

Access	Constructor and Description
public	ActionMap() Creates an `ActionMap` with no parent and no mappings.

Method Summary

Modifier and Type	Method and Description
public Object[]	Returns: an array of the keys allKeys() Returns an array of the keys defined in this `ActionMap` and its parent.
public void	clear() Removes all the mappings from this `ActionMap`.
public Action	Returns: the binding for `key` get(Object a key key) Returns the binding for `key`, messaging the parent `ActionMap` if the binding is not locally defined.
public ActionMap	Returns: the `ActionMap` that is the parent of this one, or null if this `ActionMap` has no parent getParent() Returns this `ActionMap`'s parent.
public Object[]	Returns: an array of the keys keys() Returns the `Action` names that are bound in this `ActionMap`.
public void	put(Object a key key, Action a binding for `key` action) Adds a binding for `key` to `action`.
private void	readObject(ObjectInputStream s)
public void	remove(Object a key key) Removes the binding for `key` from this `ActionMap`.
public void	setParent(ActionMap the `ActionMap` that is the parent of this one map) Sets this `ActionMap`'s parent.
public int	Returns: the number of bindings in this `ActionMap` size() Returns the number of bindings in this `ActionMap`.
private void	writeObject(ObjectOutputStream s)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

arrayTable	back to summary
private transient ArrayTable arrayTable Handles the mapping between Action name and Action.

parent	back to summary
private ActionMap parent Parent that handles any bindings we don't contain.

Constructor Detail

ActionMap	back to summary
public ActionMap() Creates an `ActionMap` with no parent and no mappings.

Method Detail

allKeys back to summary

allKeys	back to summary
public Object[] allKeys() Returns an array of the keys defined in this `ActionMap` and its parent. This method differs from `keys()` in that this method includes the keys defined in the parent. Returns:Object[] an array of the keys

public Object[] allKeys()

Returns an array of the keys defined in this ActionMap and its parent. This method differs from keys() in that this method includes the keys defined in the parent.

Returns:Object[]: an array of the keys

clear	back to summary
public void clear() Removes all the mappings from this `ActionMap`.

get back to summary

get	back to summary
public Action get(Object key) Returns the binding for `key`, messaging the parent `ActionMap` if the binding is not locally defined. Parameters key:Object a key Returns:Action the binding for `key`

public Action get(Object key)

Returns the binding for key, messaging the parent ActionMap if the binding is not locally defined.

Parameters

key:Object: a key

Returns:Action

the binding for key

getParent back to summary

getParent	back to summary
public ActionMap getParent() Returns this `ActionMap`'s parent. Returns:ActionMap the `ActionMap` that is the parent of this one, or null if this `ActionMap` has no parent

public ActionMap getParent()

Returns this ActionMap's parent.

Returns:ActionMap: the ActionMap that is the parent of this one, or null if this ActionMap has no parent

keys back to summary

keys	back to summary
public Object[] keys() Returns the `Action` names that are bound in this `ActionMap`. Returns:Object[] an array of the keys

public Object[] keys()

Returns the Action names that are bound in this ActionMap.

Returns:Object[]: an array of the keys

put back to summary

put	back to summary
public void put(Object key, Action action) Adds a binding for `key` to `action`. If `action` is null, this removes the current binding for `key`. In most instances, `key` will be `action.getValue(NAME)`. Parameters key:Object a key action:Action a binding for `key`

public void put(Object key, Action action)

Adds a binding for key to action. If action is null, this removes the current binding for key.

In most instances, key will be action.getValue(NAME).

Parameters

key:Object: a key
action:Action: a binding for key

readObject	back to summary
private void readObject(ObjectInputStream s) throws ClassNotFoundException, IOException Annotations @Serial

remove back to summary

remove	back to summary
public void remove(Object key) Removes the binding for `key` from this `ActionMap`. Parameters key:Object a key

public void remove(Object key)

Removes the binding for key from this ActionMap.

Parameters

key:Object: a key

setParent back to summary

setParent	back to summary
public void setParent(ActionMap map) Sets this `ActionMap`'s parent. Parameters map:ActionMap the `ActionMap` that is the parent of this one

public void setParent(ActionMap map)

Sets this ActionMap's parent.

Parameters

map:ActionMap: the ActionMap that is the parent of this one

size back to summary

size	back to summary
public int size() Returns the number of bindings in this `ActionMap`. Returns:int the number of bindings in this `ActionMap`

public int size()

Returns the number of bindings in this ActionMap.

Returns:int: the number of bindings in this ActionMap

writeObject	back to summary
private void writeObject(ObjectOutputStream s) throws IOException Annotations @Serial

public Class ActionMap

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail