ComponentInputMap (Java 2 Platform SE 5.0) (original) (raw)

javax.swing

Class ComponentInputMap

java.lang.Object extended by javax.swing.InputMap javax.swing.ComponentInputMap

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ComponentInputMapUIResource

public class ComponentInputMap

extends InputMap

A ComponentInputMap is an InputMap associated with a particular JComponent. The component is automatically notified whenever the ComponentInputMap changes.ComponentInputMaps are used forWHEN_IN_FOCUSED_WINDOW bindings.

Constructor Summary
ComponentInputMap(JComponent component) Creates a ComponentInputMap associated with the specified component.

Method Summary
void	clear() Removes all the mappings from this object.
JComponent	getComponent() Returns the component the InputMap was created for.
void	[put](../../javax/swing/ComponentInputMap.html#put%28javax.swing.KeyStroke, java.lang.Object%29)(KeyStroke keyStroke,Object actionMapKey) Adds a binding for keyStroke to actionMapKey.
void	remove(KeyStroke key) Removes the binding for key from this object.
void	setParent(InputMap map) Sets the parent, which must be a ComponentInputMap associated with the same component as thisComponentInputMap.

Methods inherited from class javax.swing.InputMap
allKeys, get, getParent, keys, size

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

Constructor Detail

ComponentInputMap

public ComponentInputMap(JComponent component)

Creates a ComponentInputMap associated with the specified component.

Parameters:

component - a non-null JComponent

Throws:

[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang") - if component is null

Method Detail

setParent

public void setParent(InputMap map)

Sets the parent, which must be a ComponentInputMap associated with the same component as thisComponentInputMap.

Overrides:

[setParent](../../javax/swing/InputMap.html#setParent%28javax.swing.InputMap%29) in class [InputMap](../../javax/swing/InputMap.html "class in javax.swing")

Parameters:

map - a ComponentInputMap

Throws:

[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang") - if map is not a ComponentInputMap or is not associated with the same component

getComponent

public JComponent getComponent()

Returns the component the InputMap was created for.

put

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.

Overrides:

[put](../../javax/swing/InputMap.html#put%28javax.swing.KeyStroke, java.lang.Object%29) in class [InputMap](../../javax/swing/InputMap.html "class in javax.swing")

remove

public void remove(KeyStroke key)

Removes the binding for key from this object.

Overrides:

[remove](../../javax/swing/InputMap.html#remove%28javax.swing.KeyStroke%29) in class [InputMap](../../javax/swing/InputMap.html "class in javax.swing")

clear

public void clear()

Removes all the mappings from this object.

Overrides:

[clear](../../javax/swing/InputMap.html#clear%28%29) in class [InputMap](../../javax/swing/InputMap.html "class in javax.swing")

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.