ComponentInputMap (Java Platform SE 8 ) (original) (raw)

• java.lang.Object

• • 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.
Since:
1.3

• • Constructor Summary

  Constructors

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

  • Method Summary

  All Methods Instance Methods Concrete Methods

  Modifier and Type	Method	Description
  void	clear()	Removes all the mappings from this object.
  JComponent	getComponent()	Returns the component the InputMap was created for.
  void	put(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](../../javax/swing/InputMap.html "class in javax.swing")  
     `[allKeys](../../javax/swing/InputMap.html#allKeys--), [get](../../javax/swing/InputMap.html#get-javax.swing.KeyStroke-), [getParent](../../javax/swing/InputMap.html#getParent--), [keys](../../javax/swing/InputMap.html#keys--), [size](../../javax/swing/InputMap.html#size--)`  
     * ### Methods inherited from class java.lang.[Object](../../java/lang/Object.html "class in java.lang")  
     `[clone](../../java/lang/Object.html#clone--), [equals](../../java/lang/Object.html#equals-java.lang.Object-), [finalize](../../java/lang/Object.html#finalize--), [getClass](../../java/lang/Object.html#getClass--), [hashCode](../../java/lang/Object.html#hashCode--), [notify](../../java/lang/Object.html#notify--), [notifyAll](../../java/lang/Object.html#notifyAll--), [toString](../../java/lang/Object.html#toString--), [wait](../../java/lang/Object.html#wait--), [wait](../../java/lang/Object.html#wait-long-), [wait](../../java/lang/Object.html#wait-long-int-)`

• • Constructor Detail

     * #### ComponentInputMap  
     public ComponentInputMap([JComponent](../../javax/swing/JComponent.html "class in javax.swing") 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](../../javax/swing/InputMap.html "class in javax.swing") map)  
    Sets the parent, which must be a `ComponentInputMap` associated with the same component as this`ComponentInputMap`.  
    Overrides:  
    `[setParent](../../javax/swing/InputMap.html#setParent-javax.swing.InputMap-)` 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](../../javax/swing/JComponent.html "class in javax.swing") getComponent()  
    Returns the component the `InputMap` was created for.  
    * #### put  
    public void put([KeyStroke](../../javax/swing/KeyStroke.html "class in javax.swing") keyStroke,  
                    [Object](../../java/lang/Object.html "class in java.lang") 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-javax.swing.KeyStroke-java.lang.Object-)` in class `[InputMap](../../javax/swing/InputMap.html "class in javax.swing")`  
    * #### remove  
    public void remove([KeyStroke](../../javax/swing/KeyStroke.html "class in javax.swing") key)  
    Removes the binding for `key` from this object.  
    Overrides:  
    `[remove](../../javax/swing/InputMap.html#remove-javax.swing.KeyStroke-)` 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--)` 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 SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.