ej.microui.event

Class EventState

java.lang.Object

ej.microui.event.EventState

public class EventState
extends java.lang.Object

This class holds all methods to send MicroUI States events to MicroUI application.

Contrary to the other event generators, the MicroUI States generator must be initialized with the default state of each state. MicroUI implementation calls the method getInitialStateValue(int, int) on startup (after front panel device startup). The front panel project has the responsability to call the method setInitialStateValue(int, int, int) before device starting in order to fill the states.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMMON_MICROUI_GENERATOR_TAG Usual MicroUI States generator tag used in platform configuration project (microui.xml).

Method Summary

Modifier and Type	Method and Description
static int	getInitialStateValue(int eventGeneratorID, int stateID) Gets the state initial value (startup value).
static void	sendStateEvent(int stateID, int stateValue) Send a STATE event to the event generator with the MicroUI generator tag COMMON_MICROUI_GENERATOR_TAG.
static void	sendStateEvent(java.lang.String statesEventGenerator, int stateID, int stateValue) Send a STATE event to the event generator.
static void	setInitialStateValue(int eventGeneratorID, int stateID, int value) Initializes a state generator with its default state on startup.

Methods inherited from class java.lang.Object

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

Field Detail

COMMON_MICROUI_GENERATOR_TAG

public static final java.lang.String COMMON_MICROUI_GENERATOR_TAG

Usual MicroUI States generator tag used in platform configuration project (microui.xml).

See Also:

Constant Field Values

Method Detail

sendStateEvent

public static void sendStateEvent(int stateID,
                                  int stateValue)

Send a STATE event to the event generator with the MicroUI generator tag COMMON_MICROUI_GENERATOR_TAG.

Parameters:

stateID - the state machine identifier, between 0 and 255.

stateValue - the new state value, between 0 and 255.

See Also:

sendStateEvent(String, int, int)

sendStateEvent

public static void sendStateEvent(java.lang.String statesEventGenerator,
                                  int stateID,
                                  int stateValue)

Send a STATE event to the event generator.

The result of this method is unknown when the given event generator is not a MicroUI States event generator.

Parameters:

statesEventGenerator - the MicroUI States event generator.

stateID - the state machine identifier, between 0 and 255.

stateValue - the new state value, between 0 and 255.

setInitialStateValue

public static void setInitialStateValue(int eventGeneratorID,
                                        int stateID,
                                        int value)

Initializes a state generator with its default state on startup.

Parameters:

eventGeneratorID - the MicroUI States event generator.

stateID - the state machine identifier, between 0 and 255.

value - the state value, between 0 and 255.

getInitialStateValue

public static int getInitialStateValue(int eventGeneratorID,
                                       int stateID)

Gets the state initial value (startup value). Called by MicroUI implementation on startup.

Parameters:

eventGeneratorID - the MicroUI States event generator.

stateID - the state machine identifier, between 0 and 255.

Returns:

state initial value.