public class InputMap extends Object implements Serializable
InputMap provides a binding between an input event
(currently only KeyStrokes 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.
| Constructor and Description |
|---|
InputMap()
Creates an
InputMap with no parent and no mappings. |
| Modifier and Type | Method and Description |
|---|---|
KeyStroke[] |
allKeys()
Returns an array of the
KeyStrokes defined in this
InputMap and its parent. |
void |
clear()
Removes all the mappings from this
InputMap. |
Object |
get(KeyStroke keyStroke)
Returns the binding for
keyStroke, messaging the
parent InputMap if the binding is not locally defined. |
InputMap |
getParent()
Gets this
InputMap's parent. |
KeyStroke[] |
keys()
Returns the
KeyStrokes that are bound in this InputMap. |
void |
put(KeyStroke keyStroke,
Object actionMapKey)
Adds a binding for
keyStroke to actionMapKey. |
void |
remove(KeyStroke key)
Removes the binding for
key from this
InputMap. |
void |
setParent(InputMap map)
Sets this
InputMap's parent. |
int |
size()
Returns the number of
KeyStroke bindings. |
public void setParent(InputMap map)
InputMap's parent.map - the InputMap that is the parent of this onepublic InputMap getParent()
InputMap's parent.InputMap that is the parent of this one,
or null if this InputMap has no parentpublic void put(KeyStroke keyStroke, Object actionMapKey)
keyStroke to actionMapKey.
If actionMapKey is null, this removes the current binding
for keyStroke.public Object get(KeyStroke keyStroke)
keyStroke, messaging the
parent InputMap if the binding is not locally defined.public void remove(KeyStroke key)
key from this
InputMap.public void clear()
InputMap.public KeyStroke[] keys()
KeyStrokes that are bound in this InputMap.public int size()
KeyStroke bindings.public KeyStroke[] allKeys()
KeyStrokes defined in this
InputMap and its parent. This differs from keys() 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, 2015, Oracle and/or its affiliates. All rights reserved.