InputTrigger (SciJava Javadocs 0-SNAPSHOT API)

java.lang.Object
- org.scijava.ui.behaviour.InputTrigger

```
public class InputTrigger
extends Object
```
A combination of keys, mouse buttons, and/or mouse scrolling that can trigger a Behaviour.
Parsing String in getFromString(String) borrows heavily from AWTKeyStroke.

Author:

Tobias Pietzsch <tobias.pietzsch@gmail.com>

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALT_DOWN_MASK`
`static int`	`ALT_GRAPH_DOWN_MASK`
`static int`	`BUTTON1_DOWN_MASK`
`static int`	`BUTTON2_DOWN_MASK`
`static int`	`BUTTON3_DOWN_MASK`
`static int`	`CTRL_DOWN_MASK`
`static int`	`DOUBLE_CLICK_MASK`
`static int`	`IGNORE_MASK`
`static int`	`META_DOWN_MASK`
`static InputTrigger`	`NOT_MAPPED`
`static int`	`SCROLL_MASK`
`static int`	`SHIFT_DOWN_MASK`
`static int`	`WIN_DOWN_MASK`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`static InputTrigger`	`getFromString(String s)`
`KeyStroke`	`getKeyStroke()`
`int`	`getMask()` Get the modifier mask for this trigger.
`gnu.trove.TIntCollection`	`getPressedKeys()`
`int`	`hashCode()`
`boolean`	`isKeyStroke()`
`boolean`	`isKeyTriggered()`
`boolean`	`matches(int mask, gnu.trove.set.TIntSet keys)`
`boolean`	`matches(int mask, gnu.trove.set.TIntSet keys, gnu.trove.set.TIntSet tmp)`
`boolean`	`matchesSubset(int mask, gnu.trove.set.TIntSet keys)`
`boolean`	`matchesSubset(int mask, gnu.trove.set.TIntSet keys, gnu.trove.set.TIntSet tmp)`
`String`	`toString()`

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

Field Detail
- SHIFT_DOWN_MASK
```
public static final int SHIFT_DOWN_MASK
```
  See Also:
  
  Constant Field Values
- CTRL_DOWN_MASK
```
public static final int CTRL_DOWN_MASK
```
  See Also:
  
  Constant Field Values
- META_DOWN_MASK
```
public static final int META_DOWN_MASK
```
  See Also:
  
  Constant Field Values
- ALT_DOWN_MASK
```
public static final int ALT_DOWN_MASK
```
  See Also:
  
  Constant Field Values
- BUTTON1_DOWN_MASK
```
public static final int BUTTON1_DOWN_MASK
```
  See Also:
  
  Constant Field Values
- BUTTON2_DOWN_MASK
```
public static final int BUTTON2_DOWN_MASK
```
  See Also:
  
  Constant Field Values
- BUTTON3_DOWN_MASK
```
public static final int BUTTON3_DOWN_MASK
```
  See Also:
  
  Constant Field Values
- ALT_GRAPH_DOWN_MASK
```
public static final int ALT_GRAPH_DOWN_MASK
```
  See Also:
  
  Constant Field Values
- DOUBLE_CLICK_MASK
```
public static final int DOUBLE_CLICK_MASK
```
  See Also:
  
  Constant Field Values
- SCROLL_MASK
```
public static final int SCROLL_MASK
```
  See Also:
  
  Constant Field Values
- WIN_DOWN_MASK
```
public static final int WIN_DOWN_MASK
```
  See Also:
  
  Constant Field Values
- IGNORE_MASK
```
public static final int IGNORE_MASK
```
  See Also:
  
  Constant Field Values
- NOT_MAPPED
```
public static final InputTrigger NOT_MAPPED
```

Method Detail

getFromString

public static InputTrigger getFromString(String s)
                                  throws IllegalArgumentException

Throws:: IllegalArgumentException

getMask
```
public int getMask()
```
Get the modifier mask for this trigger. The mask can have the following bits:
Returns:

get the modifier mask for this trigger.

getPressedKeys

public gnu.trove.TIntCollection getPressedKeys()

isKeyTriggered
```
public boolean isKeyTriggered()
```

isKeyStroke
```
public boolean isKeyStroke()
```

getKeyStroke
```
public KeyStroke getKeyStroke()
```

matches

public boolean matches(int mask,
                       gnu.trove.set.TIntSet keys)

matches

public boolean matches(int mask,
                       gnu.trove.set.TIntSet keys,
                       gnu.trove.set.TIntSet tmp)

matchesSubset

public boolean matchesSubset(int mask,
                             gnu.trove.set.TIntSet keys)

matchesSubset

public boolean matchesSubset(int mask,
                             gnu.trove.set.TIntSet keys,
                             gnu.trove.set.TIntSet tmp)

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

equals
```
public boolean equals(Object obj)
```
Overrides:

equals in class Object

toString
```
public String toString()
```
Overrides:

toString in class Object

Class InputTrigger

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SHIFT_DOWN_MASK

CTRL_DOWN_MASK

META_DOWN_MASK

ALT_DOWN_MASK

BUTTON1_DOWN_MASK

BUTTON2_DOWN_MASK

BUTTON3_DOWN_MASK

ALT_GRAPH_DOWN_MASK

DOUBLE_CLICK_MASK

SCROLL_MASK

WIN_DOWN_MASK

IGNORE_MASK

NOT_MAPPED

Method Detail

getFromString

getMask

getPressedKeys

isKeyTriggered

isKeyStroke

getKeyStroke

matches

matches

matchesSubset

matchesSubset

hashCode

equals

toString