remixlab.bias.event

Class MotionShortcut

java.lang.Object

remixlab.bias.Shortcut

remixlab.bias.event.MotionShortcut

public final class MotionShortcut
extends Shortcut

This class represents MotionEvent shortcuts.

Motion shortcuts can be of one of two forms: 1. A gesture-id (e.g., 'LEFT_ID' , or even 'NO_ID') or, ; 2. A gesture-id + modifier key combinations (e.g., 'RIGHT_ID' + 'CTRL').

Note that the shortcut may be empty: the no-id (NO_ID) and no-modifier-mask (NO_MODIFIER_MASK) combo may also defined a shortcut. Empty shortcuts may bind gesture-less motion interactions (e.g., mouse move without any button pressed).

Note that the motion-event Shortcut.id() DOFs should be registered first (see registerID(int, String)) before using the shortcut.

Constructor Summary

Constructors

Constructor and Description
MotionShortcut() Constructs an "empty" shortcut by conveniently calling this(NO_MODIFIER_MASK, NO_ID);
MotionShortcut(int id) Defines a shortcut from the given gesture-id.
MotionShortcut(int m, int id) Defines a shortcut from the given modifier mask and gesture-id combination.

Method Summary

Modifier and Type	Method and Description
Class<? extends MotionEvent>	defaultEventClass() Returns the default-event class (alternative to Shortcut.eventClass()) this shortcut is to be attached to.
static int	dofs(int id) Returns the Shortcut.id() DOF's.
Class<? extends MotionEvent>	eventClass() Returns DOFnEvent.class where n is dofs(int).
static boolean	hasID(int id) Same as return Shortcut.hasID(MotionShortcut.class, id).
static int	registerID(int id, int dof, String description) Registers a MotionEvent Shortcut.id() with the given dofs and description.
static int	registerID(int dof, String description) Registers a MotionEvent Shortcut.id() with the given dofs and description.

Methods inherited from class remixlab.bias.Shortcut

description, equals, hashCode, hasID, id, modifiers, registerID, registerID, registerID

Methods inherited from class java.lang.Object

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

Constructor Detail

MotionShortcut

public MotionShortcut()

Constructs an "empty" shortcut by conveniently calling this(NO_MODIFIER_MASK, NO_ID);

MotionShortcut

public MotionShortcut(int id)

Defines a shortcut from the given gesture-id.

Parameters:

id - gesture-id

MotionShortcut

public MotionShortcut(int m,
                      int id)

Defines a shortcut from the given modifier mask and gesture-id combination.

Parameters:

m - the mask

id - gesture-id

Method Detail

dofs

public static int dofs(int id)

Returns the Shortcut.id() DOF's.

Returns null if nthe id is not registered.

See Also:

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

registerID

public static int registerID(int id,
                             int dof,
                             String description)

Registers a MotionEvent Shortcut.id() with the given dofs and description.

Parameters:

id - the intended Shortcut.id() to be registered.

dof - Motion id degrees-of-freedom. Either 1,2,3, or 6.

Returns:

the id or an exception if the id exists.

See Also:

registerID(int, String), dofs(int), hasID(int)

registerID

public static int registerID(int dof,
                             String description)

Registers a MotionEvent Shortcut.id() with the given dofs and description.

Parameters:

dof - Motion id degrees-of-freedom. Either 1,2,3, or 6.

Returns:

the id.

See Also:

registerID(int, int, String), dofs(int), hasID(int)

hasID

public static boolean hasID(int id)

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

See Also:

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

eventClass

public Class<? extends MotionEvent> eventClass()

Returns DOFnEvent.class where n is dofs(int).

Returns MotionEvent.class if the shortcut Shortcut.id() isn't registered.

See Also:

dofs(int), registerID(int, int, String)

defaultEventClass

public Class<? extends MotionEvent> defaultEventClass()

Description copied from class: Shortcut

Returns the default-event class (alternative to Shortcut.eventClass()) this shortcut is to be attached to. Default value is null.

Override it when an optional Shortcut.eventClass() is needed (rarely). For an example refer to the MotionEvent implementation.

See Also:

Shortcut.eventClass()