ej.microui.event

Class LLUIInput

java.lang.Object

ej.microui.event.LLUIInput

public class LLUIInput
extends java.lang.Object

This class provides some methods to create internal MicroUI events which target the MicroUI EventGenerator event generator implementation.

Several methods takes in argument a string generatorID. This ID must refer to a MicroUI events generator defined during the MicroEJ plaform build in microui/microui.xml file (in platform configuration project).

In designer mode (plugin mode), this ID is unknown so all methods throw an IllegalArgumentException. The caller should catch this exception and prints in the standard output stream a description of this event.

In MicroEJ application mode, this exception should not occur (the MicroUI events generator ID should exist). However, when exception occurs, the trace allows to the user to note there is an issue according the MicroUI events generator ID.

Method Summary

Modifier and Type	Method and Description
static int	buildEvent(int generatorId, int data) Constructs and returns an event.
static int	buildEvent(java.lang.String generatorId, int data) Constructs and returns an event.
static int	getData(int event) Returns the data component of the event.
static int	getType(int event) Returns the type (i.e.
static void	sendEvent(int event) Sends an event in the queue.
static void	sendEvent(int generatorId, int data) Constructs an event and sends it to the simulator input queue.
static void	sendEvent(java.lang.String generatorId, int data) Constructs an event and sends it to the simulator input queue.
static void	sendEvents(int[] events) Sends several events in the queue.

Methods inherited from class java.lang.Object

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

Method Detail

getType

public static int getType(int event)

Returns the type (i.e. the event generator id) of the event.

Parameters:

event - the event to decode.

Returns:

the event's type.

getData

public static int getData(int event)

Returns the data component of the event.

Parameters:

event - the event to decode.

Returns:

the data component of the event.

buildEvent

public static int buildEvent(java.lang.String generatorId,
                             int data)

Constructs and returns an event.

Parameters:

generatorId - the required generator id (i.e. type) of the event.

data - the data component of the event.

Returns:

the constructed event.

Throws:

java.lang.IllegalArgumentException - whether the generatorID refers to an unknown MicroUI generator (see class comment).

buildEvent

public static int buildEvent(int generatorId,
                             int data)

Constructs and returns an event.

Parameters:

generatorId - the required generator id (i.e. type) of the event.

data - the data component of the event.

Returns:

the constructed event.

sendEvent

public static void sendEvent(int event)

Sends an event in the queue. This event must have been build using buildEvent(int, int) or buildEvent(String, int).

Parameters:

event - the event to send.

sendEvents

public static void sendEvents(int[] events)

Sends several events in the queue. The first event in the array must have been build using buildEvent(int, int) or buildEvent(String, int).

Parameters:

events - the events to send.

sendEvent

public static void sendEvent(java.lang.String generatorId,
                             int data)

Constructs an event and sends it to the simulator input queue. Exactly equivalent to sendEvent(buildEvent(generatorId, data)).

Parameters:

generatorId - the required generator id (i.e. type) of the event.

data - the data component of the event.

Throws:

java.lang.IllegalArgumentException - whether the generatorID refers to an unknown MicroUI generator (see class comment).

sendEvent

public static void sendEvent(int generatorId,
                             int data)

Constructs an event and sends it to the simulator input queue. Exactly equivalent to sendEvent(buildEvent(generatorId, data)).

Parameters:

generatorId - the required generator id (i.e. type) of the event.

data - the data component of the event.