remixlab.bias

Class Shortcut

java.lang.Object

remixlab.bias.Shortcut

Direct Known Subclasses:

ClickShortcut, KeyboardShortcut, MotionShortcut

public class Shortcut
extends Object

Shortcuts are BogusEvent means to bind user-defined actions from a BogusEvent.

Every BogusEvent instance has a shortcut which represents a gesture-id(), for instance, the button being dragged and the modifier key pressed (see modifiers()) at the very moment an user interaction takes place, such as when she drags a giving mouse button while pressing the 'CTRL' modifier key. See BogusEvent.shortcut(). Note that for the shortcut description() to work properly, gesture-id()s should be registered at the shortcut class first (see registerID(String)).

Different bogus event types should be related to different shortcuts. The current implementation supports the following event/shortcut types:

1. MotionEvent / MotionShortcut. Note that motion-event derived classes: DOF1Event, DOF2Event, DOF3Event, DOF6Event, are also related to motion shortcuts.
2. ClickEvent / ClickShortcut
3. KeyboardEvent / KeyboardShortcut

If you ever need to define your own shortcut type (such as when declaring a custom bogus-event type) derive from this class and override eventClass().e.g.,

 
 protected Class<? extends CustomEvent> eventClass() {
   return CustomEvent.class;
 }
 
 

and implement a register id routine either from registerID(Class, String) or registerID(Class, int, String), e.g.,

 
 public static int registerID(int id, String description) {
   return Shortcut.registerID(CustomShortcut.class, id, description);
 }
 
 

Note that if your CustomShortcut class defines it's own attributes, its hashCode() and equals(Object) methods should be overridden as well.

Constructor Summary

Constructors

Constructor and Description
Shortcut() Constructs an "empty" shortcut.
Shortcut(int _id) Defines a shortcut from the given id.
Shortcut(int m, int i)

Method Summary

Modifier and Type	Method and Description
String	description() Shortcut description.
boolean	equals(Object obj)
int	hashCode()
static boolean	hasID(Class<? extends Shortcut> clazz, int id) Returns true if the given Shortcut clazz id is registered and false otherwise.
static boolean	hasID(int id) Same as return Shortcut.hasID(Shortcut.class, id).
int	id() Returns the shortcut's id.
int	modifiers() Returns the shortcut's modifiers mask.
static int	registerID(Class<? extends Shortcut> clazz, int id, String description) Registers (and returns) the given id for the shortcut clazz with the given description.
static int	registerID(Class<? extends Shortcut> clazz, String description) Registers (and returns) the first available id for the shortcut clazz with the given description.
static int	registerID(int id, String description) Same as return registerID(Shortcut.class, id, description).
static int	registerID(String description) Same as return registerID(Shortcut.class, description).

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Shortcut

public Shortcut()

Constructs an "empty" shortcut. Same as: Shortcut(int) with the integer parameter being NO_NOMODIFIER_MASK.

Shortcut

public Shortcut(int _id)

Defines a shortcut from the given id.

Parameters:

_id - gesture-id

Shortcut

public Shortcut(int m,
                int i)

Parameters:

m - modifier mask defining the shortcut

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

registerID

public static int registerID(Class<? extends Shortcut> clazz,
                             String description)

Registers (and returns) the first available id for the shortcut clazz with the given description.

See Also:

registerID(Class, int, String), hasID(Class, int)

hasID

public static boolean hasID(Class<? extends Shortcut> clazz,
                            int id)

Returns true if the given Shortcut clazz id is registered and false otherwise.

See Also:

registerID(Class, String), registerID(Class, int, String)

registerID

public static int registerID(Class<? extends Shortcut> clazz,
                             int id,
                             String description)

Registers (and returns) the given id for the shortcut clazz with the given description.

See Also:

registerID(Class, String), hasID(Class, int)

registerID

public static int registerID(int id,
                             String description)

Same as return registerID(Shortcut.class, id, description).

See Also:

registerID(Class, int, String), hasID(Class, int)

registerID

public static int registerID(String description)

Same as return registerID(Shortcut.class, description).

See Also:

registerID(Class, String), hasID(Class, int)

hasID

public static boolean hasID(int id)

Same as return Shortcut.hasID(Shortcut.class, id).

See Also:

registerID(int, String), hasID(Class, int)

description

public String description()

Shortcut description.

Returns:

description as a String

modifiers

public int modifiers()

Returns the shortcut's modifiers mask.

id

public int id()

Returns the shortcut's id.