vona.ui

Class ActionMapper.ActionMap

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<java.lang.String,ActionMapper.Action>

vona.ui.ActionMapper.ActionMap

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,ActionMapper.Action>

Enclosing class:

ActionMapper

public static class ActionMapper.ActionMap
extends java.util.LinkedHashMap<java.lang.String,ActionMapper.Action>

a map taking action specs to ActionMapper.Actions

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
boolean	enabled enable for this map
java.lang.String	name name for this map
boolean	warnDuplicate Whether to issue a warning to stderr if an action is replaced.

Constructor Summary

Constructors

Constructor and Description
ActionMapper.ActionMap(java.lang.String name) make a new map with the given name

Method Summary

Methods

Modifier and Type	Method and Description
int	add(ActionMapper.Action action, java.lang.String... spec) Convenience to add/replace the mapping(s) from spec(s) to action.
int	addSimpleAction(java.lang.String description, java.lang.Runnable task, java.lang.String... spec) add(vona.ui.ActionMapper.Action, java.lang.String...) a new ActionMapper.Action consed up to run task.
void	dump() dump(PrintStream, boolean, boolean) to System.out, skipping disabled and sorting.
void	dump(boolean skipDisabled, boolean sort) dump(PrintStream, boolean, boolean) to System.out
void	dump(java.io.PrintStream s, boolean skipDisabled, boolean sort) dump map contents
int	remove(ActionMapper.Action action) Convenience to remove all mappings to an action.
int	remove(java.lang.String... spec) Convenience to remove a set of mappings.

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, get, removeEldestEntry

Methods inherited from class java.util.HashMap

clone, containsKey, entrySet, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

containsKey, entrySet, equals, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Field Detail

enabled

public volatile boolean enabled

enable for this map

warnDuplicate

public volatile boolean warnDuplicate

Whether to issue a warning to stderr if an action is replaced.

This only applies to actions added via add(vona.ui.ActionMapper.Action, java.lang.String...).

name

public final java.lang.String name

name for this map

Constructor Detail

ActionMapper.ActionMap

public ActionMapper.ActionMap(java.lang.String name)

make a new map with the given name

Method Detail

add

public int add(ActionMapper.Action action,
      java.lang.String... spec)

Convenience to add/replace the mapping(s) from spec(s) to action.

Returns:

the number of existing mappings that were replaced

addSimpleAction

public int addSimpleAction(java.lang.String description,
                  java.lang.Runnable task,
                  java.lang.String... spec)

add(vona.ui.ActionMapper.Action, java.lang.String...) a new ActionMapper.Action consed up to run task.

This can make for shorter syntax when the action doesn't need any of the ActionMapper.Action.run(java.lang.String, java.awt.Component, vona.ui.ActionMapper.ComponentState) parameters and always returns true.

remove

public int remove(ActionMapper.Action action)

Convenience to remove all mappings to an action.

Returns:

the number of removed mappings

remove

public int remove(java.lang.String... spec)

Convenience to remove a set of mappings.

Returns:

the number of removed mappings

dump

public void dump(java.io.PrintStream s,
        boolean skipDisabled,
        boolean sort)

dump map contents

dump

public void dump(boolean skipDisabled,
        boolean sort)

dump(PrintStream, boolean, boolean) to System.out

dump

public void dump()

dump(PrintStream, boolean, boolean) to System.out, skipping disabled and sorting.