Behaviours (SciJava Javadocs 0-SNAPSHOT API)

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

```
public class Behaviours
extends Object
```
Convenience class for adding to a InputTriggerMap/BehaviourMap pair, with InputTriggerMap triggers that are read from a given InputTriggerConfig. The maps can be installed into TriggerBehaviourBindings.

Author:

Tobias Pietzsch

Field Summary

Fields
Modifier and Type Field and Description

protected InputTriggerAdder inputTriggerAdder

protected InputTriggerAdder.Factory keyConfig

Fields
Modifier and Type	Field and Description
`protected InputTriggerAdder`	`inputTriggerAdder`
`protected InputTriggerAdder.Factory`	`keyConfig`

Constructor Summary

Constructors
Constructor and Description
`Behaviours(InputTriggerAdder.Factory keyConfig, String... keyConfigContexts)` Construct with new, empty `InputTriggerMap` and `BehaviourMap`.
`Behaviours(InputTriggerMap inputTriggerMap, BehaviourMap behaviourMap, InputTriggerAdder.Factory keyConfig, String... keyConfigContexts)` Construct with the specified `InputTriggerMap` and `BehaviourMap`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`behaviour(Behaviour behaviour, String name, String... defaultTriggers)`
`BehaviourMap`	`getBehaviourMap()`
`InputTriggerMap`	`getInputTriggerMap()`
`void`	`install(TriggerBehaviourBindings triggerBehaviourBindings, String name)` Adds the `InputTriggerMap` and `BehaviourMap` to `triggerBehaviourBindings` under the given `name`.
`void`	`namedBehaviour(AbstractNamedBehaviour behaviour, String... defaultTriggers)`
`void`	`updateKeyConfig(InputTriggerConfig keyConfig)` Clears the `InputTriggerMap` and re-adds all behaviour keys from `BehaviourMap` using the provided `keyConfig`.
`void`	`updateKeyConfig(InputTriggerConfig keyConfig, boolean clearAll)` Clears the `InputTriggerMap` and re-adds all behaviour keys from `BehaviourMap` 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 InputTriggerAdder.Factory keyConfig
```
  - inputTriggerAdder
```
protected InputTriggerAdder inputTriggerAdder
```
- Constructor Detail
  - Behaviours
```
public Behaviours(InputTriggerAdder.Factory keyConfig,
                  String... keyConfigContexts)
```
    Construct with new, empty InputTriggerMap and BehaviourMap. Behaviours that are added to these maps (using behaviour(Behaviour, String, String...), namedBehaviour(AbstractNamedBehaviour, String...)) have their triggers defined by the specified keyConfig.
    
    Parameters:
    
    keyConfig - added behaviours have their triggers defined by the specified keyConfig. (overrides default triggers.)
    
    keyConfigContexts - for which context names in the keyConfig should triggers be retrieved.
  - Behaviours
```
public Behaviours(InputTriggerMap inputTriggerMap,
                  BehaviourMap behaviourMap,
                  InputTriggerAdder.Factory keyConfig,
                  String... keyConfigContexts)
```
    Construct with the specified InputTriggerMap and BehaviourMap. Behaviours that are added to these maps (using behaviour(Behaviour, String, String...), namedBehaviour(AbstractNamedBehaviour, String...)) have their triggers defined by the specified keyConfig.
    
    Parameters:
    
    inputTriggerMap - InputTriggerMap to add to.
    
    behaviourMap - BehaviourMap to add to.
    
    keyConfig - added behaviours have their triggers defined by the specified keyConfig. (overrides default triggers.)
    
    keyConfigContexts - for which context names in the keyConfig should triggers be retrieved.
- Method Detail
  - getInputTriggerMap
```
public InputTriggerMap getInputTriggerMap()
```
  - getBehaviourMap
```
public BehaviourMap getBehaviourMap()
```
  - install
```
public void install(TriggerBehaviourBindings triggerBehaviourBindings,
                    String name)
```
    Adds the InputTriggerMap and BehaviourMap to triggerBehaviourBindings under the given name.
    Convenience method for
```
                triggerBehaviourBindings.addInputTriggerMap( name, getInputTriggerMap() );
                triggerBehaviourBindings.addBehaviourMap( name, getBehaviourMap() );
 
```
    Parameters:
    
    triggerBehaviourBindings - where to install the InputTriggerMap/ BehaviourMap.
    
    name - name under which the InputTriggerMap/ BehaviourMap is installed.
  - behaviour
```
public void behaviour(Behaviour behaviour,
                      String name,
                      String... defaultTriggers)
```
  - namedBehaviour
```
public void namedBehaviour(AbstractNamedBehaviour behaviour,
                           String... defaultTriggers)
```
  - updateKeyConfig
```
public void updateKeyConfig(InputTriggerConfig keyConfig)
```
    Clears the InputTriggerMap and re-adds all behaviour keys from BehaviourMap using the provided keyConfig.
    
    Parameters:
    
    keyConfig - the new keyConfig
  - updateKeyConfig
```
public void updateKeyConfig(InputTriggerConfig keyConfig,
                            boolean clearAll)
```
    Clears the InputTriggerMap and re-adds all behaviour keys from BehaviourMap using the provided keyConfig.
    If clearAll==false, then behaviours that are currently in the InputTriggerMap but are not defined in the keyConfig retain their current keystrokes (note that keyConfig can map behaviours to "not mapped").
    
    Parameters:
    
    keyConfig - the new keyConfig
    
    clearAll - whether to clear all bindings (also of behaviours that are undefined in keyConfig)

Class Behaviours

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

keyConfig

inputTriggerAdder

Constructor Detail

Behaviours

Behaviours

Method Detail

getInputTriggerMap

getBehaviourMap

install

behaviour

namedBehaviour

updateKeyConfig

updateKeyConfig