TriggerBehaviourBindings (SciJava Javadocs 0-SNAPSHOT API)

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

```
public final class TriggerBehaviourBindings
extends Object
```
Maintains lists of BehaviourMaps and InputTriggerMaps, which are chained to a concatenated InputTriggerMap and a concatenated BehaviourMap. Maps can be added and will be chained in reverse order of addition, that is, the last added map overrides all previous ones. For InputTriggerMaps it is possible to block maps that were added earlier.

Author:

Tobias Pietzsch <tobias.pietzsch@gmail.com>

Constructor Summary

Constructors
Constructor and Description

TriggerBehaviourBindings()
Create chained maps just consisting of empty roots.

Constructors
Constructor and Description
`TriggerBehaviourBindings()` Create chained maps just consisting of empty roots.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addBehaviourMap(String id, BehaviourMap behaviourMap)` Add as `BehaviourMap` with the specified id to the end of the list (overrides maps that were added earlier).
`void`	`addInputTriggerMap(String id, InputTriggerMap inputTriggerMap, Collection<String> idsToBlock)` Add as `InputTriggerMap` with the specified id to the end of the list (overrides maps that were added earlier).
`void`	`addInputTriggerMap(String id, InputTriggerMap inputTriggerMap, String... idsToBlock)` Add as `InputTriggerMap` with the specified id to the end of the list (overrides maps that were added earlier).
`BehaviourMap`	`getConcatenatedBehaviourMap()` Get the chained `BehaviourMap`.
`InputTriggerMap`	`getConcatenatedInputTriggerMap()` Get the chained `InputTriggerMap`.
`void`	`removeBehaviourMap(String id)` Remove the `BehaviourMap` with the given id from the list.
`void`	`removeInputTriggerMap(String id)` Remove the `InputTriggerMap` with the given id from the list.

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

- Constructor Detail
  - TriggerBehaviourBindings
```
public TriggerBehaviourBindings()
```
    Create chained maps just consisting of empty roots.
- Method Detail
  - addBehaviourMap
```
public void addBehaviourMap(String id,
                            BehaviourMap behaviourMap)
```
    Add as BehaviourMap with the specified id to the end of the list (overrides maps that were added earlier). If the specified id already exists in the list, remove the corresponding earlier BehaviourMap.
  - removeBehaviourMap
```
public void removeBehaviourMap(String id)
```
    Remove the BehaviourMap with the given id from the list.
  - addInputTriggerMap
```
public void addInputTriggerMap(String id,
                               InputTriggerMap inputTriggerMap,
                               String... idsToBlock)
```
    Add as InputTriggerMap with the specified id to the end of the list (overrides maps that were added earlier). If the specified id already exists in the list, remove the corresponding earlier InputTriggerMap.
    If idsToBlock are given, InputTriggerMaps with these ids earlier in the chain that should be disabled. The special id "all" blocks all earlier InputTriggerMaps.
    
    Parameters:
    
    id -
    
    inputTriggerMap -
    
    idsToBlock - ids of InputTriggerMaps earlier in the chain that should be disabled.
  - addInputTriggerMap
```
public void addInputTriggerMap(String id,
                               InputTriggerMap inputTriggerMap,
                               Collection<String> idsToBlock)
```
    Add as InputTriggerMap with the specified id to the end of the list (overrides maps that were added earlier). If the specified id already exists in the list, remove the corresponding earlier InputTriggerMap.
    If idsToBlock are given, InputTriggerMaps with these ids earlier in the chain that should be disabled. The special id "all" blocks all earlier InputTriggerMaps.
    
    Parameters:
    
    id -
    
    inputTriggerMap -
    
    idsToBlock - ids of InputTriggerMaps earlier in the chain that should be disabled.
  - removeInputTriggerMap
```
public void removeInputTriggerMap(String id)
```
    Remove the InputTriggerMap with the given id from the list.
  - getConcatenatedInputTriggerMap
```
public InputTriggerMap getConcatenatedInputTriggerMap()
```
    Get the chained InputTriggerMap. Note, that this will remain the same instance when maps are added or removed.
  - getConcatenatedBehaviourMap
```
public BehaviourMap getConcatenatedBehaviourMap()
```
    Get the chained BehaviourMap. Note, that this will remain the same instance when maps are added or removed.

Class TriggerBehaviourBindings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TriggerBehaviourBindings

Method Detail

addBehaviourMap

removeBehaviourMap

addInputTriggerMap

addInputTriggerMap

removeInputTriggerMap

getConcatenatedInputTriggerMap

getConcatenatedBehaviourMap