Summary: Ctors | Methods | Inherited Methods | [Expand All]

public class

InputMap

extends Object
implements Serializable

java.lang.Object
↳	javax.swing.InputMap

Known Direct Subclasses

ComponentInputMap, InputMapUIResource

Known Indirect Subclasses

ComponentInputMapUIResource

Class Overview

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.

Summary

Public Constructors
	InputMap() Creates an `InputMap` with no parent and no mappings.

Public Methods
KeyStroke[]	allKeys() Returns an array of the `KeyStroke`s 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 `KeyStroke`s 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.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this object.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
final Class<?>	getClass() Returns the runtime class of this `Object`.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait() Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
final void	wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.

Public Constructors

public InputMap ()

Creates an InputMap with no parent and no mappings.

Public Methods

public KeyStroke[] allKeys ()

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

public void clear ()

Removes all the mappings from this InputMap.

public Object get (KeyStroke keyStroke)

Returns the binding for keyStroke, messaging the parent InputMap if the binding is not locally defined.

public InputMap 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

public KeyStroke[] keys ()

Returns the KeyStrokes that are bound in this InputMap.

public void put (KeyStroke keyStroke, Object actionMapKey)

Adds a binding for keyStroke to actionMapKey. If actionMapKey is null, this removes the current binding for keyStroke.

public void remove (KeyStroke key)

Removes the binding for key from this InputMap.

public void setParent (InputMap map)

Sets this InputMap's parent.

Parameters

map	the `InputMap` that is the parent of this one

public int size ()

Returns the number of KeyStroke bindings.

Interfaces

Classes

Enums

Exceptions