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

All Implemented Interfaces:

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

Direct Known Subclasses:

[ComponentInputMap](ComponentInputMap.html "class in javax.swing"), [InputMapUIResource](plaf/InputMapUIResource.html "class in javax.swing.plaf")

InputMap provides a binding between an input event (currently onlyKeyStrokes are used) and an Object. InputMaps are usually used with an ActionMap, to determine an Action to perform when a key is pressed. An InputMap can have a parent that is searched for bindings not defined in the InputMap.

As with ActionMap if you create a cycle, eg:

InputMap am = new InputMap(); InputMap bm = new InputMap(): am.setParent(bm); bm.setParent(am);

some of the methods will cause a StackOverflowError to be thrown.

Since:

1.3

• Constructor Summary

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

• Method Summary

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

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

  • InputMap

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

• Method Details

  • setParent

  public void setParent(InputMap map)
  Sets this InputMap's parent.
  Parameters:
  map - the InputMap that is the parent of this one

  • getParent

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

  • put

  Adds a binding for keyStroke to actionMapKey. If actionMapKey is null, this removes the current binding for keyStroke.
  Parameters:
  keyStroke - a KeyStroke
actionMapKey - an action map key

  • get

  Returns the binding for keyStroke, messaging the parent InputMap if the binding is not locally defined.
  Parameters:
  keyStroke - the KeyStroke for which to get the binding
  Returns:
  the binding for keyStroke

  • remove

  Removes the binding for key from this InputMap.
  Parameters:
  key - the KeyStroke for which to remove the binding

  • clear

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

  • keys

  Returns the KeyStrokes that are bound in this InputMap.
  Returns:
  an array of the KeyStrokes that are bound in thisInputMap

  • size

  public int size()
  Returns the number of KeyStroke bindings.
  Returns:
  the number of KeyStroke bindings

  • allKeys

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