com.datalogic.device.input

Class KeyboardManager

java.lang.Object

com.datalogic.device.input.KeyboardManager

public class KeyboardManager
extends java.lang.Object

This class provides access to keyboard related methods of the device.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	KeyboardManager.VScanCode Virtual key scan codes.

Field Summary

Fields

Modifier and Type	Field and Description
static int	TRIGGER_ID_AUTOSCAN ID for AutoScan trigger.
static int	TRIGGER_ID_FRONT ID for Front trigger.
static int	TRIGGER_ID_LEFT ID for Left trigger.
static int	TRIGGER_ID_MOTION ID for Motion trigger.
static int	TRIGGER_ID_PISTOL ID for Pistol trigger.
static int	TRIGGER_ID_RIGHT ID for Right trigger.

Constructor Summary

Constructors

Constructor and Description
KeyboardManager() This is the constructor of KeyboardManager.

Method Summary

Modifier and Type	Method and Description
int	clearAllMappings() Removes all the configured mappings.
int	clearMapping(VScanEntry scanCode) Removes a single active mapping.
int	disableKey(VScanEntry scanCode, boolean disable) Disables completely a single physical key, through the VScanEntry data structure.
AdvancedKeyboard	getAdvancedKeyboard() Returns the AdvancedKeyboard object, which can be used to customize the keyboard configuration, read info about the currently installed keyboard and listen to some keyboard events.
java.util.List<Trigger>	getAvailableTriggers() Returns the available triggers in the device.
android.content.Intent	getIntent(VScanEntry scanCode) Returns current mapping between a physical key and an Intent.
static int[][]	getKeyboardLayout() Returns the physical keyboard layout.
KeyCodeEntry	getKeyCode(VScanEntry scanCode) Returns current mapping between a physical scan code key and an Android key code.
java.util.Map<VScanEntry,android.content.Intent>	getMappedIntents() Provides a Map< VScanEntry, android.content.Intent > containing all the stored and active Android Intent mappings.
java.util.Map<VScanEntry,KeyCodeEntry>	getMappedKeyCodes() Provides a Map< VScanEntry, KeyCodeEntry> containing all the stored and active Android key codes mappings.
java.util.Map<VScanEntry,java.lang.Character>	getMappedUnicodes() Provides a Map< VScanEntry, Character> containing all the stored and active Character mappings.
java.lang.Character	getUnicode(VScanEntry scanCode) Returns current mapping between a physical key and a unicode character.
boolean	isInputLocked() Tells if the input from keyboard is locked.
boolean	isKeyDisabled(VScanEntry scanCode) Checks if a physical key is disabled.
int	lockInput(boolean lock) Locks or unlocks the input from keyboard and physical buttons.
int	mapIntent(VScanEntry scanCode, android.content.Intent intent) Assigns an Intent to a physical key.
int	mapKeyCode(VScanEntry scanCode, KeyCodeEntry keyCode) Assigns a virtual key code to a physical key.
int	mapUnicode(VScanEntry scanCode, java.lang.Character c) Assigns a unicode character to a physical key.

Methods inherited from class java.lang.Object

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

Field Detail

TRIGGER_ID_LEFT

public static final int TRIGGER_ID_LEFT

ID for Left trigger.

See Also:

Constant Field Values

TRIGGER_ID_RIGHT

public static final int TRIGGER_ID_RIGHT

ID for Right trigger.

See Also:

Constant Field Values

TRIGGER_ID_PISTOL

public static final int TRIGGER_ID_PISTOL

ID for Pistol trigger.

See Also:

Constant Field Values

TRIGGER_ID_FRONT

public static final int TRIGGER_ID_FRONT

ID for Front trigger.

See Also:

Constant Field Values

TRIGGER_ID_AUTOSCAN

public static final int TRIGGER_ID_AUTOSCAN

ID for AutoScan trigger.

See Also:

Constant Field Values

TRIGGER_ID_MOTION

public static final int TRIGGER_ID_MOTION

ID for Motion trigger.

See Also:

Constant Field Values

Constructor Detail

KeyboardManager

public KeyboardManager()

This is the constructor of KeyboardManager.

Throws:

DeviceException - in case of error.

Method Detail

lockInput

public int lockInput(boolean lock)

Locks or unlocks the input from keyboard and physical buttons.

Parameters:

lock - boolean it specifies whether or not the keyboard will be locked.

Returns:

int DeviceException.SUCCESS in case of success, otherwise a possible error code, matching one of the DeviceException error constants.

Throws:

DeviceException - in case of error, when exceptions are enabled through the ErrorManager singleton.

isInputLocked

public boolean isInputLocked()

Tells if the input from keyboard is locked.

Returns:

boolean it returns whether or not the keyboard is locked.

mapKeyCode

public int mapKeyCode(VScanEntry scanCode,
                      KeyCodeEntry keyCode)

Assigns a virtual key code to a physical key. If a mapping for the desired physical key is already assigned and saved, it will be overridden.

Parameters:

scanCode - a VScanEntry representing the virtual scan code.

keyCode - a KeyCodeEntry representing the Android key code and meta state.

Example code to avoid any keyboard event on the left scan trigger pressure:
(new KeyboardManager()).mapKeyCode(new VScanEntry(VScanCode.VSCAN_LEFT_TRIGGER), new KeyCodeEntry(KeyEvent.KEYCODE_UNKNOWN));

Example code to map the left scan trigger to the Android left trigger button key code:
(new KeyboardManager()).mapKeyCode(new VScanEntry(VScanCode.VSCAN_LEFT_TRIGGER), new KeyCodeEntry(KeyEvent.KEYCODE_BUTTON_L1));

Example code to map the enter key to the Android home key code:
(new KeyboardManager()).mapKeyCode(new VScanEntry(VScanCode.VSCAN_RIGHT_ENTER), new KeyCodeEntry(KeyEvent.KEYCODE_HOME));

Returns:

int DeviceException.SUCCESS in case of success, otherwise a possible error code, matching one of the DeviceException error constants.

Throws:

DeviceException - in case of error, when exceptions are enabled through the ErrorManager singleton.

See Also:

VScanEntry, KeyCodeEntry

getKeyCode

public KeyCodeEntry getKeyCode(VScanEntry scanCode)

Returns current mapping between a physical scan code key and an Android key code.

Parameters:

scanCode - a VScanEntry representing the virtual scan code.

Returns:

KeyCodeEntry representing an Android key code and meta state. Returns null in case there is no association.

Throws:

DeviceException - in case of error, when exceptions are enabled through the ErrorManager singleton.

See Also:

VScanEntry, KeyCodeEntry

mapUnicode

public int mapUnicode(VScanEntry scanCode,
                      java.lang.Character c)

Assigns a unicode character to a physical key. If a mapping for the desired physical key is already assigned and saved, it will be overridden.

Parameters:

scanCode - a VScanEntry representing the virtual scan code.

c - unicode character

Example code to assign a Thai unicode character to the physical key '1':
(new KeyboardManager()).mapUnicode(new VScanEntry(VScanCode.VSCAN_1), '\\u0e01');

Returns:

int DeviceException.SUCCESS in case of success, otherwise a possible error code, matching one of the DeviceException error constants.

Throws:

DeviceException - in case of error, when exceptions are enabled through the ErrorManager singleton.

See Also:

VScanEntry

getUnicode

public java.lang.Character getUnicode(VScanEntry scanCode)

Returns current mapping between a physical key and a unicode character.

Parameters:

scanCode - a VScanEntry representing the virtual scan code.

Returns:

unicode character. Returns null in case there is no association.

Throws:

DeviceException - in case of error, when exceptions are enabled through the ErrorManager singleton.

See Also:

VScanEntry

mapIntent

public int mapIntent(VScanEntry scanCode,
                     android.content.Intent intent)

Assigns an Intent to a physical key. If a mapping for the desired physical key is already assigned and saved, it will be overridden.

Parameters:

scanCode - a VScanEntry representing the virtual scan code.

intent - Intent used to launch an Android activity through the Context.startActivity(Intent intent) method.

Example code to make Camera Activity capture an image on the front scan trigger pressure:
(new KeyboardManager()).mapIntent(new VScanEntry(VScanCode.VSCAN_FRONT_TRIGGER), new Intent(MediaStore.ACTION_IMAGE_CAPTURE));

Example code to make BarcodeManager capture a barcode on the front scan trigger pressure and to stop capturing on the front scan trigger release:
(new KeyboardManager()).mapIntent(new VScanEntry(VScanCode.VSCAN_FRONT_TRIGGER), new Intent(BarcodeManager.ACTION_START_DECODE));

Returns:

int DeviceException.SUCCESS in case of success, otherwise a possible error code, matching one of the DeviceException error constants.

Throws:

DeviceException - in case of error, when exceptions are enabled through the ErrorManager singleton.

See Also:

VScanEntry

getIntent

public android.content.Intent getIntent(VScanEntry scanCode)

Returns current mapping between a physical key and an Intent.

Parameters:

scanCode - a VScanEntry representing the virtual scan code.

Returns:

Intent used to launch an Android activity through the Context.startActivity(Intent intent) method. Returns null in case there is no association.

Throws:

DeviceException - in case of error, when exceptions are enabled through the ErrorManager singleton.

See Also:

VScanEntry

clearAllMappings

public int clearAllMappings()

Removes all the configured mappings. Whenever this method is called, all the current active mappings are cleared and removed.

Returns:

int DeviceException.SUCCESS in case of success, otherwise a possible error code, matching one of the DeviceException error constants.

Throws:

DeviceException - in case of error, when exceptions are enabled through the ErrorManager singleton.

clearMapping

public int clearMapping(VScanEntry scanCode)

Removes a single active mapping. The current active mapping for the selected VScanEntry, if existing, is removed.

Parameters:

scanCode - a VScanEntry representing the virtual scan code, mapped that must be removed.

Returns:

int DeviceException.SUCCESS in case of success, otherwise a possible error code, matching one of the DeviceException error constants.

Throws:

DeviceException - in case of error, when exceptions are enabled through the ErrorManager singleton.

getMappedKeyCodes

public java.util.Map<VScanEntry,KeyCodeEntry> getMappedKeyCodes()

Provides a Map< VScanEntry, KeyCodeEntry> containing all the stored and active Android key codes mappings.

Returns:

Map< VScanEntry, KeyCodeEntry> the corresponding saved mappings. Null is returned if there aren't any mappings saved.

Throws:

DeviceException - in case of error, when exceptions are enabled through the ErrorManager singleton.

getMappedIntents

public java.util.Map<VScanEntry,android.content.Intent> getMappedIntents()

Provides a Map< VScanEntry, android.content.Intent > containing all the stored and active Android Intent mappings.

Returns:

Map< VScanEntry, android.content.Intent > the corresponding saved mappings. Null is returned if there aren't any mappings saved.

Throws:

DeviceException - in case of error, when exceptions are enabled through the ErrorManager singleton.

getMappedUnicodes

public java.util.Map<VScanEntry,java.lang.Character> getMappedUnicodes()

Provides a Map< VScanEntry, Character> containing all the stored and active Character mappings.

Returns:

Map< VScanEntry, Character> the corresponding saved mappings. Null is returned if there aren't any mappings saved.

Throws:

DeviceException - in case of error, when exceptions are enabled through the ErrorManager singleton.

disableKey

public int disableKey(VScanEntry scanCode,
                      boolean disable)

Disables completely a single physical key, through the VScanEntry data structure. When a key is disabled, no input will be produced whenever key presses are detected. When a key is again re-enabled, is reset to its original value, so any previous mapping is automatically lost.

Parameters:

scanCode - a VScanEntry representing the virtual scan code, associated to the physical key.

disable - a boolean that specifies whether or not the key will be disabled.

Returns:

int DeviceException.SUCCESS in case of success, otherwise a possible error code, matching one of the DeviceException error constants.

Throws:

DeviceException - in case of error, when exceptions are enabled through the ErrorManager singleton.

isKeyDisabled

public boolean isKeyDisabled(VScanEntry scanCode)

Checks if a physical key is disabled.

Parameters:

scanCode - a VScanEntry representing the virtual scan code, associated to the physical key.

Returns:

boolean True in case the key is disabled, false otherwise or in case of error.

Throws:

DeviceException - in case of error, when exceptions are enabled through the ErrorManager singleton.

getKeyboardLayout

public static int[][] getKeyboardLayout()

Returns the physical keyboard layout. It can be used by application for keyboard remapping.

Returns:

Cubic grid of scan codes, representing the physical keyboard present. If a row does not span the entire length, 0's or -1's will fill those spots.

getAvailableTriggers

public java.util.List<Trigger> getAvailableTriggers()

Returns the available triggers in the device.

Returns:

List of Trigger objects, each representing one of the supported triggers.

Throws:

DeviceException - in case of error, when exceptions are enabled through the ErrorManager singleton.

getAdvancedKeyboard

public AdvancedKeyboard getAdvancedKeyboard()

Returns the AdvancedKeyboard object, which can be used to customize the keyboard configuration, read info about the currently installed keyboard and listen to some keyboard events.

Returns:

AdvancedKeyboard object if the device supports it, otherwise it throws an exception if exceptions are enabled through the ErrorManager singleton or null if exceptions are disabled.

Throws:

DeviceException - in case of unsupported device, when exceptions are enabled through the ErrorManager singleton.