ActionMap (Java SE 19 & JDK 19) (original) (raw)

All Implemented Interfaces:

[Serializable](../../../java.base/java/io/Serializable.html "interface in java.io")

Direct Known Subclasses:

[ActionMapUIResource](plaf/ActionMapUIResource.html "class in javax.swing.plaf")

ActionMap provides mappings fromObjects (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:

• InputMap

• Constructor Summary

Constructors
[ActionMap](#%3Cinit%3E%28%29)()
Creates an ActionMap with no parent and no mappings.

• Method Summary

[allKeys](#allKeys%28%29)()
Returns an array of the keys defined in this ActionMap and its parent.
void
[clear](#clear%28%29)()
Removes all the mappings from this ActionMap.
Returns the binding for key, messaging the parent ActionMap if the binding is not locally defined.
[getParent](#getParent%28%29)()
Returns this ActionMap's parent.
[keys](#keys%28%29)()
Returns the Action names that are bound in this ActionMap.
void
Adds a binding for key to action.
void
Removes the binding for key from this ActionMap.
void
Sets this ActionMap's parent.
int
[size](#size%28%29)()
Returns the number of bindings in this ActionMap.

Methods declared in class java.lang.Object

[clone](../../../java.base/java/lang/Object.html#clone%28%29), [equals](../../../java.base/java/lang/Object.html#equals%28java.lang.Object%29), [finalize](../../../java.base/java/lang/Object.html#finalize%28%29), [getClass](../../../java.base/java/lang/Object.html#getClass%28%29), [hashCode](../../../java.base/java/lang/Object.html#hashCode%28%29), [notify](../../../java.base/java/lang/Object.html#notify%28%29), [notifyAll](../../../java.base/java/lang/Object.html#notifyAll%28%29), [toString](../../../java.base/java/lang/Object.html#toString%28%29), [wait](../../../java.base/java/lang/Object.html#wait%28%29), [wait](../../../java.base/java/lang/Object.html#wait%28long%29), [wait](../../../java.base/java/lang/Object.html#wait%28long,int%29)

• Constructor Details

  • ActionMap

  public ActionMap()
  Creates an ActionMap with no parent and no mappings.

• Method Details

  • setParent

  Sets this ActionMap's parent.
  Parameters:
  map - the ActionMap that is the parent of this one

  • getParent

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

  • put

  Adds a binding for key to action. If action is null, this removes the current binding for key.
  In most instances, key will beaction.getValue(NAME).
  Parameters:
  key - a key
  action - a binding for key

  • get

  Returns the binding for key, messaging the parent ActionMap if the binding is not locally defined.
  Parameters:
  key - a key
  Returns:
  the binding for key

  • remove

  public void remove(Object key)
  Removes the binding for key from this ActionMap.
  Parameters:
  key - a key

  • clear

  public void clear()
  Removes all the mappings from this ActionMap.

  • keys

  Returns the Action names that are bound in this ActionMap.
  Returns:
  an array of the keys

  • size

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

  • allKeys

  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:
  an array of the keys