This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


javax.swing
class InputMap

java.lang.Object extended by javax.swing.InputMap
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
ComponentInputMap, InputMapUIResource

Most common way to construct:

InputMap am = new InputMap();

Based on 38 examples


public class InputMap
extends Object
implements Serializable

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.


Constructor Summary

          Creates an InputMap with no parent and no mappings.
 
Method Summary
 KeyStroke[]

          Returns an array of the KeyStrokes defined in this InputMap and its parent.
 void

          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

          Gets this InputMap's parent.
 KeyStroke[]

          Returns the KeyStrokes that are bound in this InputMap.
 void
put(KeyStroke keyStroke, Object actionMapKey)

          Adds a binding for keyStroke to actionMapKey.
 void

          Removes the binding for key from this InputMap.
 void

          Sets this InputMap's parent.
 int

          Returns the number of KeyStroke bindings.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

InputMap

public InputMap()
Creates an InputMap with no parent and no mappings.

Method Detail

allKeys

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.


clear

public void clear()
Removes all the mappings from this InputMap.


get

public Object get(KeyStroke keyStroke)
Returns the binding for keyStroke, messaging the parent InputMap if the binding is not locally defined.

Parameters:
keyStroke

getParent

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

keys

public KeyStroke[] keys()
Returns the KeyStrokes that are bound in this InputMap.


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.

Parameters:
keyStroke
actionMapKey

remove

public void remove(KeyStroke key)
Removes the binding for key from this InputMap.

Parameters:
key

setParent

public void setParent(InputMap map)
Sets this InputMap's parent.

Parameters:
map - the InputMap that is the parent of this one

size

public int size()
Returns the number of KeyStroke bindings.



This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.