ej.microui.event.generator

Class Keypad

java.lang.Object

ej.microui.event.EventGenerator

ej.microui.event.generator.Keyboard

ej.microui.event.generator.Keypad

public abstract class Keypad
extends Keyboard

Keypad is a Keyboard that defines an event generator for 12-key keypads. It follows the ETSI ES 202 130 mapping, which takes into account ETSI, ITU-T, CEN and ISO/IEC specifications and recommendations. Also see ISO/IEC 10646.

The key mapping is defined in Table 33 and in Table 63 of ETSI ES 202 130 (v1.1.1). In addition the next three keys have extended mapping defined as:
key10: '*' : this key is only used to switch from one mode to another
key11: ' ', '+', '0' in order
key12: '\n', '#' in order

Keypad sends low-level Keyboard events with basic code of the key (from '0' to '9', '#' or '*') and high level Keyboard.TEXT_INPUT events with next key code mapping until key is validated (Key codes are scrolled in order, circularly). A key is validated when no new key has been pressed before validation delay or if an other physical key of the keypad is pressed. The delay starts when the key is pressed, so a key may be validated even if it is not yet released. When a key is validated Keypad sends KEY_VALIDATED event. The delay for key validation can be modified at any time using setDelay(int) Keypad uses 4 different modes to filter the letters that are scrolled.

• NUM: only digits are selected
• ALPHA: digits and letters are selected
• CAP: only capital letters and digits are selected
• CAP1: same as CAP, but must switch to ALPHA mode after the first character is validated

For example, assuming that low-level events are enabled (see Keyboard) pressing the '2' key twice rapidly and then waiting a little amount of time after activation delay will generate:

• Keyboard.KEY_DOWN '2'
• Keyboard.TEXT_INPUT 'a'
• Keyboard.KEY_UP '2'
• Keyboard.KEY_DOWN '2'
• Keyboard.TEXT_INPUT 'b'
• Keyboard.KEY_UP '2'
• KEY_VALIDATED (after a delay, see setDelay(int))

See Also:

Keyboard

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALPHA The ALPHA mode. In ALPHA mode the keypad may return several letters and digits according to the number of consequent key press.
static int	CAP The CAP mode. In CAP mode only capital letters and digits are returned
static int	CAP1 The CAP1 mode. In CAP1 mode is the same has CAP mode, but automatically switch to ALPHA mode after the Keyboard.KEY_UP event
static int	KEY_VALIDATED The KEY_VALIDATED event action. This event action is sent when last key is validated, meaning that no new key has been pressed during delay.
static int	NUM The NUM mode. In NUM mode the keypad may return several digits according to the number of consequent key press.

Fields inherited from class ej.microui.event.generator.Keyboard

KEY_DOWN, KEY_UP, TEXT_INPUT

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
abstract char[]	getAssignment(char key) Gets the complete array of chars associated with the specified key.
int	getDelay() Gets the delay.
int	getEventType() Gets the event type associated with the event generator
abstract java.lang.String	getLanguage() Gets the currently selected language.
int	getMode() Gets the mode.
abstract java.lang.String[]	getSupportedLanguages() Gets the supported languages for this keypad.
void	setDelay(int delay) Sets the delay The delay is the value between two press that allows to select a letter out of several.
abstract void	setLanguage(java.lang.String language) Sets the language.
void	setMode(int mode) Sets the mode.

Methods inherited from class ej.microui.event.generator.Keyboard

dropOnFull, getAction, getNextChar, onlyTextInput, reset, send

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

KEY_VALIDATED

public static final int KEY_VALIDATED

The KEY_VALIDATED event action.
This event action is sent when last key is validated, meaning that no new key has been pressed during delay.

See Also:

Keyboard.getAction(int), Constant Field Values

ALPHA

public static final int ALPHA

The ALPHA mode.
In ALPHA mode the keypad may return several letters and digits according to the number of consequent key press.

See Also:

setMode(int), Constant Field Values

NUM

public static final int NUM

The NUM mode.
In NUM mode the keypad may return several digits according to the number of consequent key press.

See Also:

setMode(int), Constant Field Values

CAP

public static final int CAP

The CAP mode.
In CAP mode only capital letters and digits are returned

See Also:

setMode(int), Constant Field Values

CAP1

public static final int CAP1

The CAP1 mode.
In CAP1 mode is the same has CAP mode, but automatically switch to ALPHA mode after the Keyboard.KEY_UP event

See Also:

CAP, setMode(int), Constant Field Values

Constructor Detail

Keypad

public Keypad(int size)

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

Parameters:

size - of the buffer.

See Also:

Keyboard.dropOnFull()

Method Detail

getEventType

public int getEventType()

Description copied from class: EventGenerator

Gets the event type associated with the event generator

Overrides:

getEventType in class Keyboard

Returns:

Event.KEYPAD

setDelay

public void setDelay(int delay)

Sets the delay The delay is the value between two press that allows to select a letter out of several. The default value is 750ms.

Parameters:

delay - the delay to set

Throws:

java.lang.IllegalArgumentException - if delay is negative or zero

getDelay

public int getDelay()

Gets the delay. The delay is the value between two press that allows to select a letter out of several. The default value is 750ms.

Returns:

the delay

setMode

public void setMode(int mode)

Sets the mode.

Parameters:

mode - one of ALPHA, NUM, CAP, CAP1

Throws:

java.lang.IllegalArgumentException - if mode is not one of ALPHA, NUM, CAP, CAP1

getMode

public int getMode()

Gets the mode.

Returns:

one of ALPHA, NUM, CAP, CAP1

setLanguage

public abstract void setLanguage(java.lang.String language)

Sets the language. Select the nearest mapping available on the platform.
The language must be a valid ISO language code. These codes are the lower-case, two-letter codes as defined by ISO-639.

Parameters:

language - the ISO language code

getLanguage

public abstract java.lang.String getLanguage()

Gets the currently selected language.

Returns:

the ISO language code

See Also:

setLanguage(String)

getSupportedLanguages

public abstract java.lang.String[] getSupportedLanguages()

Gets the supported languages for this keypad.

Returns:

an array of supported ISO language codes

getAssignment

public abstract char[] getAssignment(char key)

Gets the complete array of chars associated with the specified key. The key must be one of '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '*', '0', '#'.

Parameters:

key - the key

Returns:

the array of char associated with the key