Class ComponentInputMap

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 for WHEN_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

    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 this ComponentInputMap.

    Methods declared in class InputMap

    allKeys, get, getParent, keys, size
    Modifier and Type
    Method
    Description
    KeyStroke[]
    allKeys()
    Returns an array of the KeyStrokes defined in this InputMap and its parent.
    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.
    int
    size()
    Returns the number of KeyStroke bindings.

    Methods declared in class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    Modifier and Type
    Method
    Description
    protected Object
    clone()
    Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
    boolean
    equals(Object o)
    Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
    protected void
    finalize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    May cause performance issues, deadlocks and hangs.
    final Class<? extends Object>
    getClass()
    Answers the unique instance of java.lang.Class which represents the class of the receiver.
    int
    hashCode()
    Answers an integer hash code for the receiver.
    final void
    notify()
    Causes one thread which is waiting on the receiver to be made ready to run.
    final void
    notifyAll()
    Causes all threads which are waiting on the receiver to be made ready to run.
    String
    toString()
    Answers a string containing a concise, human-readable description of the receiver.
    final void
    wait()
    Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
    final void
    wait(long time)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
    final void
    wait(long time, int frac)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

  • Constructor Details

    • ComponentInputMap

      public ComponentInputMap(JComponent component)
      Creates a ComponentInputMap associated with the specified component.
      Parameters:
      component - a non-null JComponent
      Throws:
      IllegalArgumentException - if component is null

  • Method Details

    • setParent

      public void setParent(InputMap map)
      Sets the parent, which must be a ComponentInputMap associated with the same component as this ComponentInputMap.
      Overrides:
      setParent in class InputMap
      Parameters:
      map - a ComponentInputMap
      Throws:
      IllegalArgumentException - 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.
      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 in class InputMap
      Parameters:
      keyStroke - a KeyStroke
      actionMapKey - an action map key

    • remove

      public void remove(KeyStroke key)
      Removes the binding for key from this object.
      Overrides:
      remove in class InputMap
      Parameters:
      key - the KeyStroke for which to remove the binding

    • clear

      public void clear()
      Removes all the mappings from this object.
      Overrides:
      clear in class InputMap