vona.ui

Class ActionMapper.Action

java.lang.Object

vona.ui.ActionMapper.Action

Direct Known Subclasses:

ActionMapper.ApplyingAction

Enclosing class:

ActionMapper

public abstract static class ActionMapper.Action
extends java.lang.Object

An action.

See ActionMapper class header doc for details.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Comparator<java.lang.String>	COMPARATOR gives a canonical ordering for Actions based on their spec
boolean	consuming Whether the action event that resulted in a call to run(java.lang.String, java.awt.Component, vona.ui.ActionMapper.ComponentState) that returned true should be consumed.
java.lang.String	description a short description string
java.lang.String	dumpOnlyForSpec If set then this Action will only appear in ActionMapper.ActionMap and ActionMapper dumps for the given spec, even though other specs may also map to it.
boolean	enabled enable for this action

Constructor Summary

Constructors

Constructor and Description
ActionMapper.Action(java.lang.String description) construct a new Action with spec and description

Method Summary

Methods

Modifier and Type	Method and Description
void	dump(java.lang.String spec) dump(String, PrintStream) to System.out
void	dump(java.lang.String spec, java.io.PrintStream s) dump this action
abstract boolean	run(java.lang.String actionSpec, java.awt.Component component, ActionMapper.ComponentState componentState) Execute the action.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

enabled

public volatile boolean enabled

enable for this action

description

public volatile java.lang.String description

a short description string

dumpOnlyForSpec

public volatile java.lang.String dumpOnlyForSpec

If set then this Action will only appear in ActionMapper.ActionMap and ActionMapper dumps for the given spec, even though other specs may also map to it.

consuming

public volatile boolean consuming

Whether the action event that resulted in a call to run(java.lang.String, java.awt.Component, vona.ui.ActionMapper.ComponentState) that returned true should be consumed.

COMPARATOR

public static final java.util.Comparator<java.lang.String> COMPARATOR

gives a canonical ordering for Actions based on their spec

Constructor Detail

ActionMapper.Action

public ActionMapper.Action(java.lang.String description)

construct a new Action with spec and description

Method Detail

dump

public void dump(java.lang.String spec,
        java.io.PrintStream s)

dump this action

dump

public void dump(java.lang.String spec)

dump(String, PrintStream) to System.out

run

public abstract boolean run(java.lang.String actionSpec,
          java.awt.Component component,
          ActionMapper.ComponentState componentState)

Execute the action.

This will only be called from the AWT event thread, and only for enabled Actions.

Parameters:

component - the AWT Component on which the event occurred

componentState - the ActionMapper.ComponentState of component, as tracked by the containing ActionMapper

actionSpec - the action spec string that invoked the action, see ActionMapper class header doc

Returns:

true unless the implementation decided not to execute the action