Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## charvax.swing
Class ActionMap

    java.lang.Object
      charvax.swing.ActionMap

All Implemented Interfaces:
  java.io.Serializable

public class ActionMap
extends java.lang.Object
implements java.io.Serializable

`ActionMap` provides mappings from `Object`s (called keys or `Action` names) to `Action`s. 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.

Version:
  1.14 12/19/03
Author:
  Scott Violet
See Also:
  `javax.swing.InputMap`, Serialized Form

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

Method Summary
`java.lang.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(java.lang.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.
`java.lang.Object[]` | `keys()` Returns the `Action` names that are bound in this `ActionMap`.
`void` | `put(java.lang.Object key, Action action)` Adds a binding for `key` to `action`.
`void` | `remove(java.lang.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

### setParent

    public void setParent(ActionMap map)

  Sets this `ActionMap`'s parent.

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

### 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

### put

    public void put(java.lang.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)`.

### get

    public Action get(java.lang.Object key)

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

### remove

    public void remove(java.lang.Object key)

  Removes the binding for `key` from this `ActionMap`.

### clear

    public void clear()

  Removes all the mappings from this `ActionMap`.

### keys

    public java.lang.Object[] keys()

  Returns the `Action` names that are bound in this `ActionMap`.

### size

    public int size()

  Returns the number of `KeyStroke` bindings.

### allKeys

    public java.lang.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.

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD