BogusEvent (Javadocs: proscene)

java.lang.Object
- remixlab.bias.BogusEvent

All Implemented Interfaces:

Copyable

Direct Known Subclasses:

ClickEvent, KeyboardEvent, MotionEvent
```
public class BogusEvent
extends Object
implements Copyable
```
The root of all events that are to be handled by an Agent. Every BogusEvent encapsulates a Shortcut which may be bound to an user-defined action (see shortcut()). Gesture initialization and termination, which may be of the interest of Grabber objects, are reported by fired() and flushed(), respectively.
The following are the main class specializations: MotionEvent, ClickEvent, and KeyboardEvent. Please refer to their documentation for details.
If you ever need to define you're own bogus-event type, derive from this class, declare a shortcut type for your event (for details refer to the Shortcut), and override the shortcut() and get() methods. If your custom event class defines it's own attributes, its hashCode(), equals(Object) and get() methods should be overridden as well.
Note BogusEvent detection/reduction could happened in several different ways. For instance, in the context of Java-based application, it typically takes place when implementing a mouse listener interface. In Processing, it does it when registering at the PApplet the so called mouseEvent and KeyEvent methods. Moreover, the Agent.handleFeed() provides a callback alternative when none of these mechanisms are available (as it often happens when dealing with specialized, non-default input hardware).

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALT`
`static int`	`ALT_GRAPH`
`static int`	`CTRL`
`static int`	`META`
`static int`	`NO_ID`
`static int`	`NO_MODIFIER_MASK`
`static int`	`SHIFT`

Constructor Summary

Constructors
Constructor and Description
`BogusEvent()` Constructs an event with an "empty" `Shortcut`.
`BogusEvent(int modifiers, int id)` Constructs an event taking the given `modifiers` as a `Shortcut`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`BogusEvent`	`fire()` Same as `this.get()` but sets the `fired()` flag to true.
`boolean`	`fired()` Returns true if this is a 'fired' event.
`BogusEvent`	`flush()` Same as `this.get()` but sets the `flushed()` flag to true.
`boolean`	`flushed()` Returns true if this is a 'flushed' event.
`BogusEvent`	`get()` Returns a deep copy of the object.
`int`	`hashCode()`
`int`	`id()` Returns the id defining the event's `Shortcut`.
`boolean`	`isAltDown()`
`boolean`	`isAltGraph()`
`boolean`	`isControlDown()`
`boolean`	`isMetaDown()`
`boolean`	`isNull()` Only `MotionEvent`s may be null.
`boolean`	`isShiftDown()`
`int`	`modifiers()`
`static String`	`modifiersText(int mask)`
`Shortcut`	`shortcut()`
`long`	`timestamp()`

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

- Field Detail
  - NO_MODIFIER_MASK
```
public static final int NO_MODIFIER_MASK
```
    See Also:
    
    Constant Field Values
  - NO_ID
```
public static final int NO_ID
```
    See Also:
    
    Constant Field Values
  - SHIFT
```
public static final int SHIFT
```
    See Also:
    
    Constant Field Values
  - CTRL
```
public static final int CTRL
```
    See Also:
    
    Constant Field Values
  - META
```
public static final int META
```
    See Also:
    
    Constant Field Values
  - ALT
```
public static final int ALT
```
    See Also:
    
    Constant Field Values
  - ALT_GRAPH
```
public static final int ALT_GRAPH
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BogusEvent
```
public BogusEvent()
```
    Constructs an event with an "empty" Shortcut.
  - BogusEvent
```
public BogusEvent(int modifiers,
                  int id)
```
    Constructs an event taking the given modifiers as a Shortcut.
- Method Detail
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - get
```
public BogusEvent get()
```
    Description copied from interface: Copyable
    
    Returns a deep copy of the object.
    Typical implementation should simple look like: return new Object(this).
    
    Specified by:
    
    get in interface Copyable
  - flush
```
public BogusEvent flush()
```
    Same as this.get() but sets the flushed() flag to true. Only agents may call this.
    
    See Also:
    
    flushed()
  - fire
```
public BogusEvent fire()
```
    Same as this.get() but sets the fired() flag to true. Only agents may call this.
    
    See Also:
    
    flushed()
  - flushed
```
public boolean flushed()
```
    Returns true if this is a 'flushed' event. Flushed events indicate gesture termination, such as a mouse-release.
    
    See Also:
    
    fired()
  - fired
```
public boolean fired()
```
    Returns true if this is a 'fired' event. Fired events indicate gesture activation, such as a mouse-press.
    
    See Also:
    
    flushed()
  - shortcut
```
public Shortcut shortcut()
```
    Returns:
    
    the shortcut encapsulated by this event.
    
    See Also:
    
    Shortcut
  - modifiers
```
public int modifiers()
```
    Returns:
    
    the modifiers defining the event Shortcut.
  - id
```
public int id()
```
    Returns the id defining the event's Shortcut.
  - timestamp
```
public long timestamp()
```
    Returns:
    
    the time at which the event occurs
  - isNull
```
public boolean isNull()
```
    Only MotionEvents may be null.
  - isShiftDown
```
public boolean isShiftDown()
```
    Returns:
    
    true if Shift was down when the event occurs
  - isControlDown
```
public boolean isControlDown()
```
    Returns:
    
    true if Ctrl was down when the event occurs
  - isMetaDown
```
public boolean isMetaDown()
```
    Returns:
    
    true if Meta was down when the event occurs
  - isAltDown
```
public boolean isAltDown()
```
    Returns:
    
    true if Alt was down when the event occurs
  - isAltGraph
```
public boolean isAltGraph()
```
    Returns:
    
    true if AltGraph was down when the event occurs
  - modifiersText
```
public static String modifiersText(int mask)
```
    Parameters:
    
    mask - of modifiers
    
    Returns:
    
    a String listing the event modifiers

Class BogusEvent

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NO_MODIFIER_MASK

NO_ID

SHIFT

CTRL

META

ALT

ALT_GRAPH

Constructor Detail

BogusEvent

BogusEvent

Method Detail

hashCode

equals

get

flush

fire

flushed

fired

shortcut

modifiers

id

timestamp

isNull

isShiftDown

isControlDown

isMetaDown

isAltDown

isAltGraph

modifiersText