InputActionBindings (SciJava Javadocs 0-SNAPSHOT API)

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

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

Author:

Tobias Pietzsch

Constructor Summary

Constructors
Constructor and Description
`InputActionBindings()` Create empty leaf `InputMap` and `ActionMap`.
`InputActionBindings(InputMap leafInputMap)` Create empty leaf `ActionMap` and set the given leaf `InputMap`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addActionMap(int index, String id, ActionMap actionMap)` Add as `ActionMap` with the specified id at the specified position in the list (overrides maps at lower positions).
`void`	`addActionMap(String id, ActionMap actionMap)` Add as `ActionMap` with the specified id to the end of the list (overrides maps that were added earlier).
`void`	`addInputMap(int index, String id, InputMap inputMap, Collection<String> idsToBlock)` Inserts a `InputMap` with the specified id at the specified position in the list (overrides maps at lower positions).
`void`	`addInputMap(int index, String id, InputMap inputMap, String... idsToBlock)` Inserts a `InputMap` with the specified id at the specified position in the list (overrides maps at lower positions).
`void`	`addInputMap(String id, InputMap inputMap, Collection<String> idsToBlock)` Adds a `InputMap` with the specified id to the end of the list (overrides maps that were added earlier).
`void`	`addInputMap(String id, InputMap inputMap, String... idsToBlock)` Adds a `InputMap` with the specified id to the end of the list (overrides maps that were added earlier).
`ActionMap`	`getConcatenatedActionMap()` Get the chained `ActionMap`.
`InputMap`	`getConcatenatedInputMap()` Get the chained `InputMap`.
`static InputActionBindings`	`installNewBindings(JComponent component, int condition, boolean replaceExistingMaps)` Creates a new `InputActionBindings` and installs it into `component`, either augmenting or replacing `component`s existing `InputMap` and `ActionMap`.
`void`	`removeActionMap(String id)` Remove the `ActionMap` with the given id from the list.
`void`	`removeInputMap(String id)` Remove the `InputMap` with the given id from the list.
`void`	`setParentActionMap(ActionMap parent)` Set existing parent ActionMap, which is managed outside of this InputActionBindings and serves as a parent for the whole chain.
`void`	`setParentInputMap(InputMap parent)` Set existing parent InputMap, which is managed outside of this InputActionBindings and serves as a parent for the whole chain.

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

- Constructor Detail
  - InputActionBindings
```
public InputActionBindings()
```
    Create empty leaf InputMap and ActionMap.
  - InputActionBindings
```
public InputActionBindings(InputMap leafInputMap)
```
    Create empty leaf ActionMap and set the given leaf InputMap.
    This constructor is intended for use with JComponent.WHEN_IN_FOCUSED_WINDOW. In this case, a ComponentInputMap for the correct JComponent is required.
    
    Parameters:
    
    leafInputMap - the leaf InputMap.
- Method Detail
  - addActionMap
```
public void addActionMap(String id,
                         ActionMap actionMap)
```
    Add as ActionMap 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 ActionMap.
  - addActionMap
```
public void addActionMap(int index,
                         String id,
                         ActionMap actionMap)
```
    Add as ActionMap with the specified id at the specified position in the list (overrides maps at lower positions). If the specified id already exists in the list, remove the corresponding earlier ActionMap.
  - removeActionMap
```
public void removeActionMap(String id)
```
    Remove the ActionMap with the given id from the list.
  - setParentActionMap
```
public void setParentActionMap(ActionMap parent)
```
    Set existing parent ActionMap, which is managed outside of this InputActionBindings and serves as a parent for the whole chain.
  - addInputMap
```
public void addInputMap(String id,
                        InputMap inputMap,
                        String... idsToBlock)
```
    Adds a InputMap 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 InputMap.
    If idsToBlock are given, InputMaps with these ids earlier in the chain that should be disabled. The special id "all" blocks all earlier InputMaps.
    
    Parameters:
    
    id -
    
    inputMap -
    
    idsToBlock - ids of InputMaps earlier in the chain that should be disabled.
  - addInputMap
```
public void addInputMap(String id,
                        InputMap inputMap,
                        Collection<String> idsToBlock)
```
    Adds a InputMap 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 InputMap.
    If idsToBlock are given, InputMaps with these ids earlier in the chain that should be disabled. The special id "all" blocks all earlier InputMaps.
    
    Parameters:
    
    id -
    
    inputMap -
    
    idsToBlock - ids of InputMaps earlier in the chain that should be disabled.
  - addInputMap
```
public void addInputMap(int index,
                        String id,
                        InputMap inputMap,
                        String... idsToBlock)
```
    Inserts a InputMap with the specified id at the specified position in the list (overrides maps at lower positions). If the specified id already exists in the list, remove the corresponding earlier InputMap.
    If idsToBlock are given, InputMaps with these ids earlier in the chain that should be disabled. The special id "all" blocks all earlier InputMaps.
    
    Parameters:
    
    index -
    
    id -
    
    inputMap -
    
    idsToBlock - ids of InputMaps earlier in the chain that should be disabled.
  - addInputMap
```
public void addInputMap(int index,
                        String id,
                        InputMap inputMap,
                        Collection<String> idsToBlock)
```
    Inserts a InputMap with the specified id at the specified position in the list (overrides maps at lower positions). If the specified id already exists in the list, remove the corresponding earlier InputMap.
    If idsToBlock are given, InputMaps with these ids earlier in the chain that should be disabled. The special id "all" blocks all earlier InputMaps.
    
    Parameters:
    
    index -
    
    id -
    
    inputMap -
    
    idsToBlock - ids of InputMaps earlier in the chain that should be disabled.
  - removeInputMap
```
public void removeInputMap(String id)
```
    Remove the InputMap with the given id from the list.
  - setParentInputMap
```
public void setParentInputMap(InputMap parent)
```
    Set existing parent InputMap, which is managed outside of this InputActionBindings and serves as a parent for the whole chain.
  - getConcatenatedInputMap
```
public InputMap getConcatenatedInputMap()
```
    Get the chained InputMap. This is the leaf map, that has all added InputMaps as parents. Note, that this will remain the same instance when maps are added or removed.
  - getConcatenatedActionMap
```
public ActionMap getConcatenatedActionMap()
```
    Get the chained ActionMap. This is the leaf map, that has all added ActionMaps as parents. Note, that this will remain the same instance when maps are added or removed.
  - installNewBindings
```
public static InputActionBindings installNewBindings(JComponent component,
                                                     int condition,
                                                     boolean replaceExistingMaps)
```
    Creates a new InputActionBindings and installs it into component, either augmenting or replacing components existing InputMap and ActionMap.
    
    Parameters:
    
    component - the component whose InputMap and ActionMap to set.
    
    condition - one of JComponent.WHEN_IN_FOCUSED_WINDOW, WHEN_IN_FOCUSED_WINDOW, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT.
    
    replaceExistingMaps - if true, the existing InputMap and ActionMap will be replaced. If false, the existing maps will become the parents of the new ones.
    
    Returns:
    
    the new InputActionBindings

Class InputActionBindings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

InputActionBindings

InputActionBindings

Method Detail

addActionMap

addActionMap

removeActionMap

setParentActionMap

addInputMap

addInputMap

addInputMap

addInputMap

removeInputMap

setParentInputMap

getConcatenatedInputMap

getConcatenatedActionMap

installNewBindings