ej.microui.event.generator

Class Keyboard

java.lang.Object

ej.microui.event.EventGenerator

ej.microui.event.generator.Keyboard

Direct Known Subclasses:

Keypad

public class Keyboard
extends EventGenerator

A Keyboard event generator allows key combinations to generate a key code. A keyboard generates the low-level events KEY_DOWN and KEY_UP and the high-level event TEXT_INPUT. The low-level events may be turned on, as they are off by default.

Pressing the Q key on a PC/AT US keyboard using a US keyboard layout mapping will produce:

• KEY_DOWN with Q as letter
• TEXT_INPUT with q as letter
• KEY_UP with Q as letter

If a shift key is pressed while the same Q key is pressed, the following keyboard events will be produced:

• KEY_DOWN with SHIFT as letter
• KEY_DOWN with Q as letter
• TEXT_INPUT with Q as letter
• KEY_UP with SHIFT as letter
• KEY_UP with Q as letter

Field Summary

Fields

Modifier and Type	Field and Description
static int	KEY_DOWN The KEY_DOWN event action.
static int	KEY_UP The KEY_UP event action.
static int	TEXT_INPUT The TEXT_INPUT event action.

Constructor Summary

Constructors

Constructor and Description
Keyboard(int bufferSize) Keyboards hold a buffer (potentially of size one) that stores the keys before they are used by the application (key associated to KEY_UP, KEY_DOWN and TEXT_INPUT event).

Method Summary

Modifier and Type	Method and Description
boolean	dropOnFull() Subclasses should override this method to specify their policy.
int	getAction(int event) Returns the keyboard action held by the keyboard event.
int	getEventType() Gets the event type associated with the event generator
char	getNextChar(int event) Gets the next character associated with the specified event.
void	onlyTextInput(boolean onlyText) Specifies whether the KEY_UP and KEY_DOWN events should be generated.
void	reset() Reset the keyboard by flushing all pending characters.
void	send(int type, char c) Send an keyboard event to the MicroUI application.

Methods inherited from class ej.microui.event.EventGenerator

addToSystemPool, get, get, get, getEventHandler, getID, getList, removeFromSystemPool, sendEvent, setEventHandler

Methods inherited from class java.lang.Object

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

Field Detail

TEXT_INPUT

public static final int TEXT_INPUT

The TEXT_INPUT event action.

See Also:

getAction(int), Constant Field Values

KEY_DOWN

public static final int KEY_DOWN

The KEY_DOWN event action.

See Also:

getAction(int), Constant Field Values

KEY_UP

public static final int KEY_UP

The KEY_UP event action.

See Also:

getAction(int), Constant Field Values

Constructor Detail

Keyboard

public Keyboard(int bufferSize)

Keyboards hold a buffer (potentially of size one) that stores the keys before they are used by the application (key associated to KEY_UP, KEY_DOWN and TEXT_INPUT event). By default, a keyboard will only send TEXT_INPUT events.

Parameters:

bufferSize - the size of the buffer.

See Also:

dropOnFull(), onlyTextInput(boolean)

Method Detail

dropOnFull

public boolean dropOnFull()

Subclasses should override this method to specify their policy. By default this method returns false , which means the oldest data are overwritten by new data. If it returns true new data are dropped when the pump is full.

Returns:

true to drop the new data or false to overwrite the oldest data.

getEventType

public int getEventType()

Description copied from class: EventGenerator

Gets the event type associated with the event generator

Specified by:

getEventType in class EventGenerator

Returns:

Event.KEYBOARD

onlyTextInput

public void onlyTextInput(boolean onlyText)

Specifies whether the KEY_UP and KEY_DOWN events should be generated. By default they are not generated.

Parameters:

onlyText - When true, the low level KEY_UP and KEY_DOWN are not issued to listener, only TEXT_INPUT events are sent.

getAction

public int getAction(int event)

Returns the keyboard action held by the keyboard event.

Parameters:

event - the keyboard event.

Returns:

the keyboard action held by the keyboard event.

getNextChar

public char getNextChar(int event)

Gets the next character associated with the specified event.

Parameters:

event - an event in the standard MicroUI format

Returns:

the next available char associated with the event's type, if none is available 0x0000 is returned.

reset

public void reset()

Reset the keyboard by flushing all pending characters.

See Also:

getNextChar(int)

send

public void send(int type,
                 char c)

Send an keyboard event to the MicroUI application. Default event type are KEY_UP, KEY_DOWN and TEXT_INPUT.

Parameters:

type - a type between KEY_UP, KEY_DOWN and TEXT_INPUT.

c - the character to send.