Home » openjdk-7 » javax » swing » [javadoc | source]
public class: InputMap [javadoc | source]

All Implemented Interfaces:

Direct Known Subclasses:
    KeymapWrapper, ComponentInputMapUIResource, RootPaneInputMap, ComponentInputMap, InputMapUIResource

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():
some of the methods will cause a StackOverflowError to be thrown.
 public InputMap() 
Method from javax.swing.InputMap Summary:
allKeys,   clear,   get,   getParent,   keys,   put,   remove,   setParent,   size
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.swing.InputMap Detail:
 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.
 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.
 public int size() 
    Returns the number of KeyStroke bindings.