Actions (SciJava Javadocs 0-SNAPSHOT API)

java.lang.Object
- org.scijava.ui.behaviour.util.Actions

```
public class Actions
extends Object
```
Convenience class for adding to a InputMap/ActionMap pair, with InputMap keys that are read from a given InputTriggerConfig. The maps can be installed into InputActionBindings.

Author:

Tobias Pietzsch

Field Summary

Fields
Modifier and Type Field and Description

protected KeyStrokeAdder.Factory keyConfig

protected KeyStrokeAdder keyStrokeAdder

Fields
Modifier and Type	Field and Description
`protected KeyStrokeAdder.Factory`	`keyConfig`
`protected KeyStrokeAdder`	`keyStrokeAdder`

Constructor Summary

Constructors
Constructor and Description
`Actions(InputMap inputMap, ActionMap actionMap, KeyStrokeAdder.Factory keyConfig, String... keyConfigContexts)` Construct with specified `InputMap` and `ActionMap`.
`Actions(KeyStrokeAdder.Factory keyConfig, String... keyConfigContexts)` Construct with new, empty `InputMap` and `ActionMap`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ActionMap`	`getActionMap()`
`InputMap`	`getInputMap()`
`void`	`install(InputActionBindings inputActionBindings, String name)` Adds the `InputMap` and `ActionMap` to `inputActionBindings` under the given `name`.
`void`	`namedAction(AbstractNamedAction action, String... defaultKeyStrokes)` Install the specified `AbstractNamedAction`.
`void`	`runnableAction(Runnable runnable, String name, String... defaultKeyStrokes)` Create and install a new `Action` with the specified `name` that calls the specified `Runnable` when triggered.
`void`	`updateKeyConfig(InputTriggerConfig keyConfig)` Clears the `InputMap` and re-adds all (`String`) action keys from `ActionMap` using the provided `keyConfig`.
`void`	`updateKeyConfig(InputTriggerConfig keyConfig, boolean clearAll)` Clears the `InputMap` and re-adds all (`String`) action keys from `ActionMap` using the provided `keyConfig`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - keyConfig
```
protected KeyStrokeAdder.Factory keyConfig
```
  - keyStrokeAdder
```
protected KeyStrokeAdder keyStrokeAdder
```
- Constructor Detail
  - Actions
```
public Actions(KeyStrokeAdder.Factory keyConfig,
               String... keyConfigContexts)
```
    Construct with new, empty InputMap and ActionMap. Actions that are added to these maps (using namedAction(AbstractNamedAction, String...), runnableAction(Runnable, String, String...)) have their key stroke triggers defined by the specified keyConfig.
    
    Parameters:
    
    keyConfig - added actions have their key stroke triggers defined by the specified keyConfig. (overrides default key strokes.)
    
    keyConfigContexts - for which context names in the keyConfig should key strokes be retrieved.
  - Actions
```
public Actions(InputMap inputMap,
               ActionMap actionMap,
               KeyStrokeAdder.Factory keyConfig,
               String... keyConfigContexts)
```
    Construct with specified InputMap and ActionMap. Actions that are added to these maps (using namedAction(AbstractNamedAction, String...), runnableAction(Runnable, String, String...)) have their key stroke triggers defined by the specified keyConfig.
    
    Parameters:
    
    inputMap - InputMap to add to.
    
    actionMap - ActionMap to add to.
    
    keyConfig - added actions have their key stroke triggers defined by the specified keyConfig. (overrides default key strokes.)
    
    keyConfigContexts - for which context names in the keyConfig should key strokes be retrieved.
- Method Detail
  - getInputMap
```
public InputMap getInputMap()
```
  - getActionMap
```
public ActionMap getActionMap()
```
  - install
```
public void install(InputActionBindings inputActionBindings,
                    String name)
```
    Adds the InputMap and ActionMap to inputActionBindings under the given name.
    Convenience method for
```
 inputActionBindings.addActionMap( name, getActionMap() );
 inputActionBindings.addInputMap( name, getInputMap() );
 
```
    Parameters:
    
    inputActionBindings - where to install the InputMap/ActionMap.
    
    name - name under which the InputMap/ActionMap is installed.
  - runnableAction
```
public void runnableAction(Runnable runnable,
                           String name,
                           String... defaultKeyStrokes)
```
    Create and install a new Action with the specified name that calls the specified Runnable when triggered.
    
    Parameters:
    
    runnable - action to install.
    
    name - name of the action.
    
    defaultKeyStrokes - default key strokes that trigger the action. These are used, if no mapping in the InputTriggerConfig (specified in the constructor) is found.
  - namedAction
```
public void namedAction(AbstractNamedAction action,
                        String... defaultKeyStrokes)
```
    Install the specified AbstractNamedAction.
    
    Parameters:
    
    action - action to install.
    
    defaultKeyStrokes - default key strokes that trigger the action. These are used, if no mapping in the InputTriggerConfig (specified in the constructor) is found.
  - updateKeyConfig
```
public void updateKeyConfig(InputTriggerConfig keyConfig)
```
    Clears the InputMap and re-adds all (String) action keys from ActionMap using the provided keyConfig.
    
    Parameters:
    
    keyConfig - the new keyConfig
  - updateKeyConfig
```
public void updateKeyConfig(InputTriggerConfig keyConfig,
                            boolean clearAll)
```
    Clears the InputMap and re-adds all (String) action keys from ActionMap using the provided keyConfig.
    Actions that are currently in the InputMap but are not defined in the keyConfig retain their current keystrokes (note that keyConfig can map actions to "not mapped").
    
    Parameters:
    
    keyConfig - the new keyConfig
    
    clearAll - whether to clear all bindings (also of actions that are undefined in keyConfig)

Class Actions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

keyConfig

keyStrokeAdder

Constructor Detail

Actions

Actions

Method Detail

getInputMap

getActionMap

install

runnableAction

namedAction

updateKeyConfig

updateKeyConfig