ej.microui.event

Class Event

java.lang.Object

ej.microui.event.Event

public class Event
extends java.lang.Object

MicroUI features int-based events, allowing for a rich event mechanism compatible with scare resources. This class provides EventGenerator classes with event constants and helper methods to build and analyse events.

An event has a type, a 8-bit figure that forms the most significant byte of the int-event, followed by 8-bits which is the generator id quantity, and followed by 16-bit of data.

event : type (8-bit) + generatorID (8-bit) + data (16-bit)

The very first 16 types [0x00..0x0f], some of which are defined by constants in this class, are MicroUI reserved. An application may create as many as 240 different kind of events.

See Also:

EventGenerator

Field Summary

Fields

Modifier and Type	Field and Description
static int	BUTTON The BUTTON event type.
static int	COMMAND The COMMAND event type.
static int	KEYBOARD The KEYBOARD event type.
static int	KEYPAD The KEYPAD event type.
static int	POINTER The POINTER event type.
static int	STATE The STATE event type.

Method Summary

Modifier and Type	Method and Description
static int	buildEvent(int type, EventGenerator gen, int data) Builds an event from a given type, an eventGenerator and data.
static int	getData(int event) Returns the event's data issued by a generator.
static EventGenerator	getGenerator(int event) Gets a converter out of an event assuming the event has been generated by an EventGenerator that has been previously added to the system pool.
static int	getGeneratorID(int event) Returns the event's generator id.
static int	getType(int event) Returns the type of an event.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COMMAND

public static final int COMMAND

The COMMAND event type.

See Also:

Constant Field Values

BUTTON

public static final int BUTTON

The BUTTON event type.

See Also:

Constant Field Values

KEYBOARD

public static final int KEYBOARD

The KEYBOARD event type.

See Also:

Constant Field Values

POINTER

public static final int POINTER

The POINTER event type.

See Also:

Constant Field Values

KEYPAD

public static final int KEYPAD

The KEYPAD event type.

See Also:

Constant Field Values

STATE

public static final int STATE

The STATE event type.

See Also:

Constant Field Values

Method Detail

buildEvent

public static int buildEvent(int type,
                             EventGenerator gen,
                             int data)

Builds an event from a given type, an eventGenerator and data.

Parameters:

type - the type of the event to build

gen - the generator associated with the event

data - the data of the event to build

Returns:

the event as an int

getType

public static int getType(int event)

Returns the type of an event.

Parameters:

event - an event

Returns:

event's type as an int

getData

public static int getData(int event)

Returns the event's data issued by a generator.

Parameters:

event - an event

Returns:

event's data as an int

getGeneratorID

public static int getGeneratorID(int event)

Returns the event's generator id.

Parameters:

event - an event

Returns:

event's generator as an int

getGenerator

public static EventGenerator getGenerator(int event)

Gets a converter out of an event assuming the event has been generated by an EventGenerator that has been previously added to the system pool.

Parameters:

event - an event

Returns:

the associated EventGenerator

Throws:

java.lang.NullPointerException - if the generator does not exist (most likely because the event is not an EventGenerator related event).

See Also:

EventGenerator.addToSystemPool()