javax.swing

Class ActionMap

Implemented Interfaces:
Serializable
Known Direct Subclasses:
ActionMapUIResource

public class ActionMap
extends Object
implements Serializable

Maps arbitrary keys (usually Strings) to Action instances. This is used in combination with InputMaps. 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 components ActionMap. Finally the Action that is stored is executed.
See Also:
Serialized Form

Constructor Summary

ActionMap()
Creates a new ActionMap instance.

Method Summary

Object[]
allKeys()
Returns all keys of entries in this ActionMap and all its parents.
void
clear()
Clears the ActionMap.
Action
get(Object key)
Returns an action associated with an object.
ActionMap
getParent()
Returns the parent of this ActionMap.
Object[]
keys()
Returns all keys of entries in this ActionMap.
void
put(Object key, Action action)
Puts a new Action into the ActionMap.
void
remove(Object key)
Remove an entry from the ActionMap.
void
setParent(ActionMap parentMap)
Sets a parent for this ActionMap.
int
size()
Returns the number of entries in this ActionMap.

Methods inherited from class java.lang.Object

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

Constructor Details

ActionMap

public ActionMap()
Creates a new ActionMap instance.

Method Details

allKeys

public Object[] allKeys()
Returns all keys of entries in this ActionMap and all its parents.
Returns:
an array of keys

clear

public void clear()
Clears the ActionMap.

get

public Action get(Object key)
Returns an action associated with an object.
Parameters:
key - the key of the enty
Returns:
the action associated with key, may be null

getParent

public ActionMap getParent()
Returns the parent of this ActionMap.
Returns:
the parent, may be null.

keys

public Object[] keys()
Returns all keys of entries in this ActionMap.
Returns:
an array of keys

put

public void put(Object key,
                Action action)
Puts a new Action into the ActionMap. If action is null an existing entry will be removed.
Parameters:
key - the key for the entry
action - the action.

remove

public void remove(Object key)
Remove an entry from the ActionMap.
Parameters:
key - the key of the entry to remove

setParent

public void setParent(ActionMap parentMap)
Sets a parent for this ActionMap.
Parameters:
parentMap - the new parent

size

public int size()
Returns the number of entries in this ActionMap.
Returns:
the number of entries

ActionMap.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.