Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

javax.swing

Class InputMap

Implemented Interfaces:
Serializable
Known Direct Subclasses:
ComponentInputMap, InputMapUIResource
public class InputMap
extends Object
implements Serializable
Maps KeyStrokes to arbitrary objects, usually Strings. This is used in combination with ActionMaps. If a component receives an input event, this is looked up in the component's InputMap. The result is an object which serves as a key to the component's ActionMap. Finally the Action that is stored is executed.
Since:
1.3
See Also:
Serialized Form

Constructor Summary

InputMap()
Creates a new InputMap instance.

Method Summary

KeyStroke[]
allKeys()
Returns all keys of entries in this InputMap and all its parents.
void
clear()
Clears the entries from this InputMap.
Object
get(KeyStroke keystroke)
Returns the binding for the specified keystroke, if there is one.
InputMap
getParent()
Returns the parent of this InputMap.
KeyStroke[]
keys()
Returns all keys of entries in this InputMap.
void
put(KeyStroke keystroke, Object actionMapKey)
Puts a new entry into the InputMap.
void
remove(KeyStroke keystroke)
Removes an entry from this InputMap.
void
setParent(InputMap parentMap)
Sets a parent for this InputMap.
int
size()
Returns the number of entries in this InputMap.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

InputMap

public InputMap()
Creates a new InputMap instance. This default instance contains no mappings and has no parent.

Method Details

allKeys

public KeyStroke[] allKeys()
Returns all keys of entries in this InputMap and all its parents.
Returns:
An array of keys (may be null or have zero length).

clear

public void clear()
Clears the entries from this InputMap. The parent map, if there is one, is not cleared.

get

public Object get(KeyStroke keystroke)
Returns the binding for the specified keystroke, if there is one.
Parameters:
keystroke - the key of the entry (null is ignored).
Returns:
The binding associated with the specified keystroke (or null).

getParent

public InputMap getParent()
Returns the parent of this InputMap. The default value is null.
Returns:
The parent map (possibly null).
See Also:
setParent(InputMap)

keys

public KeyStroke[] keys()
Returns all keys of entries in this InputMap. This does not include keys defined in the parent, if there is one (use the allKeys() method for that case).

Following the behaviour of the reference implementation, this method will return null when no entries have been added to the map, and a zero length array if entries have been added but subsequently removed (or cleared) from the map.
Returns:
An array of keys (may be null or have zero length).

put

public void put(KeyStroke keystroke,
                Object actionMapKey)
Puts a new entry into the InputMap. If actionMapKey is null any existing entry will be removed.
Parameters:
keystroke - the keystroke for the entry (null is ignored).
actionMapKey - the action (null permitted).

remove

public void remove(KeyStroke keystroke)
Removes an entry from this InputMap. Note that this will not remove any entry from the parent map, if there is one.
Parameters:
keystroke - the key of the entry to remove (null is ignored).

setParent

public void setParent(InputMap parentMap)
Sets a parent for this InputMap. If a parent is specified, the get(KeyStroke) method will look in the parent if it cannot find an entry in this map.
Parameters:
parentMap - the new parent (null permitted).
See Also:
getParent()

size

public int size()
Returns the number of entries in this InputMap. This count does not include any entries from the parent map, if there is one.
Returns:
The number of entries.
InputMap.java -- Copyright (C) 2002, 2004, 2006, Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About