ActionMap (Java Platform SE 6)

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.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.swing
class ActionMap

java.lang.Object
  javax.swing.ActionMap

All Implemented Interfaces:: Serializable

Direct Known Subclasses:: ActionMapUIResource

Most common way to construct:

ActionMap am = new ActionMap();

Based on 43 examples

public class ActionMap
extends Object
implements Serializable

ActionMap provides mappings from Objects (called keys or Action names) to Actions. An ActionMap is usually used with an InputMap to locate a particular action when a key is pressed. As with InputMap, an ActionMap can have a parent that is searched for keys not defined in the ActionMap.

As with InputMap if you create a cycle, eg:

   ActionMap am = new ActionMap();
   ActionMap bm = new ActionMap():
   am.setParent(bm);
   bm.setParent(am);

some of the methods will cause a StackOverflowError to be thrown.

Constructor Summary
`ActionMap()` Creates an `ActionMap` with no parent and no mappings.

Method Summary
`Object[]`	`allKeys()` Returns an array of the keys defined in this `ActionMap` and its parent.
`void`	`clear()` Removes all the mappings from this `ActionMap`.
`Action`	`get(Object key)` Returns the binding for `key`, messaging the parent `ActionMap` if the binding is not locally defined.
`ActionMap`	`getParent()` Returns this `ActionMap`'s parent.
`Object[]`	`keys()` Returns the `Action` names that are bound in this `ActionMap`.
`void`	`put(Object key, Action action)` Adds a binding for `key` to `action`.
`void`	`remove(Object key)` Removes the binding for `key` from this `ActionMap`.
`void`	`setParent(ActionMap map)` Sets this `ActionMap`'s parent.
`int`	`size()` 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

ActionMap

public ActionMap()

Creates an ActionMap with no parent and no mappings.

Method Detail

allKeys

public Object[] allKeys()

Returns an array of the keys defined in this ActionMap and its parent. This method differs from keys() in that this method includes the keys defined in the parent.

clear

public void clear()

Removes all the mappings from this ActionMap.

get

public Action get(Object key)

Returns the binding for key, messaging the parent ActionMap if the binding is not locally defined.

Parameters:: key

getParent

public ActionMap getParent()

Returns this ActionMap's parent.

Returns:: the ActionMap that is the parent of this one, or null if this ActionMap has no parent

keys

public Object[] keys()

Returns the Action names that are bound in this ActionMap.

put

public void put(Object key,
                Action action)

Adds a binding for key to action. If action is null, this removes the current binding for key.

In most instances, key will be action.getValue(NAME).

Parameters:: key; action

remove

public void remove(Object key)

Removes the binding for key from this ActionMap.

Parameters:: key

setParent

public void setParent(ActionMap map)

Sets this ActionMap's parent.

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

size

public int size()

Returns the number of KeyStroke bindings.