com.datalogic.device.input

Class AdvancedKeyboard

java.lang.Object

com.datalogic.device.input.AdvancedKeyboard

public class AdvancedKeyboard
extends java.lang.Object

Class exposing advanced keyboard methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AdvancedKeyboard.ActionEventListener Interface representing a listener of keyboard action events.
class	AdvancedKeyboard.Configuration Class that stores the configuration related some keyboard parameters.
class	AdvancedKeyboard.Info Class that stores the info related to the installed keyboard configuration.
static interface	AdvancedKeyboard.LayoutChangeEventListener Interface representing a listener of keyboard layout change events.
static class	AdvancedKeyboard.LayoutNotificationType Enumerative representing the type of notification to use in order to represent visually the current layout in which the keyboard is.
static interface	AdvancedKeyboard.MultitapEventListener Interface representing a listener of keyboard multitap events.
class	AdvancedKeyboard.Overlay Class that stores the info related to a keyboard overlay configuration.
static class	AdvancedKeyboard.PersistenceType Enumerative representing the persistence type of the installed keyboard configuration.
static class	AdvancedKeyboard.Property Read-only properties related to the currently configured keyboard.
class	AdvancedKeyboard.Resources Class that stores the resources related to the installed keyboard configuration.

Method Summary

Modifier and Type	Method and Description
boolean	addActionEventListener(AdvancedKeyboard.ActionEventListener listener) Adds a listener to all action key events.
boolean	addActionEventListener(AdvancedKeyboard.ActionEventListener listener, int actionId) Adds a listener to an action key event, registering to both press and release events.
boolean	addActionEventListener(AdvancedKeyboard.ActionEventListener listener, int actionId, boolean pressed) Adds a listener to a specific action key press or release.
boolean	addLayoutChangeEventListener(AdvancedKeyboard.LayoutChangeEventListener listener) Adds a listener to layout change events.
boolean	addMultitapEventListener(AdvancedKeyboard.MultitapEventListener listener) Adds a listener to multitap events.
AdvancedKeyboard.Configuration	getConfiguration() Gets the configuration related to some keyboard parameters.
int	getCurrentLayoutIndex() Gets the index of the current layout in which the keyboard is.
AdvancedKeyboard.Info	getInfo() Gets the info related to the installed keyboard configuration.
int	getIntProperty(AdvancedKeyboard.Property property) Reads an integer property.
java.util.List<AdvancedKeyboard.Overlay>	getOverlays() Gets the currently available keyboard overlays.
AdvancedKeyboard.Resources	getResources() Gets the resources related to the installed keyboard configuration.
java.lang.String	getStringProperty(AdvancedKeyboard.Property property) Reads a string property.
boolean	installKeyboard(java.lang.String path, AdvancedKeyboard.PersistenceType persistenceType) Command the installation of a new keyboard configuration, by specifying the path to the keyboard configuration file (as exported through the Keyboard Editor application), the desired type of persistence and the option to clear any existing configuration (outside of the default one).
boolean	installOverlay(AdvancedKeyboard.Overlay overlay, AdvancedKeyboard.PersistenceType persistenceType) Command the installation of a keyboard overlay, by specifying the overlay object for the keyboard to install.
boolean	isLayoutLocked() Checks if the keyboard layout is currently locked, preventing any layout change both manually and through the SDK.
boolean	removeActionEventListener(AdvancedKeyboard.ActionEventListener listener) Removes a listener to all action key events.
boolean	removeActionEventListener(AdvancedKeyboard.ActionEventListener listener, int actionId) Removes a listener to a specific action key event, both for press and release.
boolean	removeActionEventListener(AdvancedKeyboard.ActionEventListener listener, int actionId, boolean pressed) Removes a listener to a specific action key press or release.
boolean	removeLayoutChangeEventListener(AdvancedKeyboard.LayoutChangeEventListener listener) Removes a listener to layout change events.
boolean	removeMultitapEventListener(AdvancedKeyboard.MultitapEventListener listener) Removes a listener to multitap events.
void	resetToDefault() Resets the keyboard configuration to the default one.
boolean	setConfiguration(AdvancedKeyboard.Configuration configuration) Sets the keyboard configuration parameters.
boolean	setCurrentLayoutIndex(int layoutIndex) Sets the current layout index.
void	setLayoutLocked(boolean layoutLocked) Locks or unlocks the possibility for the keyboard to change its current layout both manually or through the SDK methods.

Methods inherited from class java.lang.Object

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

Method Detail

getIntProperty

public int getIntProperty(AdvancedKeyboard.Property property)

Reads an integer property.

Parameters:

property - The property to read.

Returns:

Value of the property if present, otherwise it throws an exception if exceptions are enabled through the ErrorManager singleton or it returns Integer.MIN_VALUE if exceptions are disabled.

Throws:

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

getStringProperty

public java.lang.String getStringProperty(AdvancedKeyboard.Property property)

Reads a string property.

Parameters:

property - The property to read.

Returns:

Value of the property if present, otherwise it throws an exception if exceptions are enabled through the ErrorManager singleton or it returns null if exceptions are disabled.

Throws:

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

getInfo

public AdvancedKeyboard.Info getInfo()

Gets the info related to the installed keyboard configuration.

Returns:

The keyboard configuration info if available, otherwise it throws an exception if exceptions are enabled through the ErrorManager singleton or null if the exceptions are disabled.

Throws:

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

getResources

public AdvancedKeyboard.Resources getResources()

Gets the resources related to the installed keyboard configuration.

Returns:

The keyboard configuration resources if available, otherwise it throws an exception if exceptions are enabled through the ErrorManager singleton or null if the exceptions are disabled.

Throws:

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

getConfiguration

public AdvancedKeyboard.Configuration getConfiguration()

Gets the configuration related to some keyboard parameters.

Returns:

The keyboard configuration if available, otherwise it throws an exception if exceptions are enabled through the ErrorManager singleton or null if the exceptions are disabled.

Throws:

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

setConfiguration

public boolean setConfiguration(AdvancedKeyboard.Configuration configuration)

Sets the keyboard configuration parameters.

Parameters:

configuration - The keyboard configuration to set.

Returns:

True in case the configuration has been set correctrly, otherwise it throws an exception if exceptions are enabled through the ErrorManager singleton or returns false if the exceptions are disabled.

Throws:

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

getOverlays

public java.util.List<AdvancedKeyboard.Overlay> getOverlays()

Gets the currently available keyboard overlays.

Returns:

A list of available overlays that can be empty if there are no overlays available.

installOverlay

public boolean installOverlay(AdvancedKeyboard.Overlay overlay,
                              AdvancedKeyboard.PersistenceType persistenceType)

Command the installation of a keyboard overlay, by specifying the overlay object for the keyboard to install. This object must be one of the overlays available through the getOverlays() method.

Parameters:

overlay - The overlay object.

persistenceType - Desired type of persistence. Be aware that the FACTORY_RESET_PERSISTENT is not allowed and will cause an installation failure.

Returns:

true in case the installation is done and all new keyboard data is immediately available, false in case of installation failure or throws an exception if exceptions are enabled through the ErrorManager singleton.

Throws:

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

getCurrentLayoutIndex

public int getCurrentLayoutIndex()

Gets the index of the current layout in which the keyboard is.

Returns:

The layout index (0 is the default layout). If there is an error in reading this value, it will throw an exception if exceptions are enabled through the ErrorManager singleton or return Integer.MIN_VALUE if exceptions are disabled.

Throws:

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

setCurrentLayoutIndex

public boolean setCurrentLayoutIndex(int layoutIndex)

Sets the current layout index. This operation will be done in a moment in which all keyboard keys are released.

Parameters:

layoutIndex - The layout index.

Returns:

True in case the layout has been set successfully. If there is an error in reading this value, it will throw an exception if exceptions are enabled through the ErrorManager singleton or return false if exceptions are disabled.

Throws:

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

isLayoutLocked

public boolean isLayoutLocked()

Checks if the keyboard layout is currently locked, preventing any layout change both manually and through the SDK.

Returns:

True if the layout is locked, false otherwise. In case of error it will throw an exception if exceptions are enabled through the ErrorManager singleton or return false if exceptions are disabled.

Throws:

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

setLayoutLocked

public void setLayoutLocked(boolean layoutLocked)

Locks or unlocks the possibility for the keyboard to change its current layout both manually or through the SDK methods.

Parameters:

layoutLocked - True to lock the layout, false to unlock it.

Throws:

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

installKeyboard

public boolean installKeyboard(java.lang.String path,
                               AdvancedKeyboard.PersistenceType persistenceType)

Command the installation of a new keyboard configuration, by specifying the path to the keyboard configuration file (as exported through the Keyboard Editor application), the desired type of persistence and the option to clear any existing configuration (outside of the default one).

Parameters:

path - Path of a zip file created through the use of the Keyboard Editor application.

persistenceType - Desired type of persistence. Be aware that the FACTORY_RESET_PERSISTENT is not allowed and will cause an installation failure.

Returns:

true in case the installation is done and all new keyboard data is immediately available, false in case of installation failure or throws an exception if exceptions are enabled through the ErrorManager singleton.

Throws:

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

resetToDefault

public void resetToDefault()

Resets the keyboard configuration to the default one.

addActionEventListener

public boolean addActionEventListener(AdvancedKeyboard.ActionEventListener listener,
                                      int actionId,
                                      boolean pressed)

Adds a listener to a specific action key press or release.

Parameters:

listener - The listener to add.

actionId - ID of the action event to listen to.

pressed - True to listen to the pressure event, false to listen to the release event.

Returns:

True if the listener has been added successfully, false otherwise or throws an exception if exceptions are enabled through the ErrorManager singleton.

Throws:

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

addActionEventListener

public boolean addActionEventListener(AdvancedKeyboard.ActionEventListener listener,
                                      int actionId)

Adds a listener to an action key event, registering to both press and release events.

Parameters:

listener - The listener to add.

actionId - ID of the action event to listen to.

Returns:

True if the listener has been added successfully, false otherwise or throws an exception if exceptions are enabled through the ErrorManager singleton.

Throws:

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

addActionEventListener

public boolean addActionEventListener(AdvancedKeyboard.ActionEventListener listener)

Adds a listener to all action key events.

Parameters:

listener - The listener to add.

Returns:

True if the listener has been added successfully, false otherwise or throws an exception if exceptions are enabled through the ErrorManager singleton.

Throws:

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

removeActionEventListener

public boolean removeActionEventListener(AdvancedKeyboard.ActionEventListener listener,
                                         int actionId,
                                         boolean pressed)

Removes a listener to a specific action key press or release.

Parameters:

listener - The listener to remove.

actionId - ID of the related action key.

pressed - True to remove the pressure event, false to remove the release event.

Returns:

True if the listener has been removed successfully, false otherwise or throws an exception if exceptions are enabled through the ErrorManager singleton.

Throws:

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

removeActionEventListener

public boolean removeActionEventListener(AdvancedKeyboard.ActionEventListener listener,
                                         int actionId)

Removes a listener to a specific action key event, both for press and release.

Parameters:

listener - The listener to remove.

actionId - ID of the related action key.

Returns:

True if the listener has been removed successfully, false otherwise or throws an exception if exceptions are enabled through the ErrorManager singleton.

Throws:

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

removeActionEventListener

public boolean removeActionEventListener(AdvancedKeyboard.ActionEventListener listener)

Removes a listener to all action key events.

Parameters:

listener - The listener to remove.

Returns:

True if the listener has been removed successfully, false otherwise or throws an exception if exceptions are enabled through the ErrorManager singleton.

Throws:

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

addLayoutChangeEventListener

public boolean addLayoutChangeEventListener(AdvancedKeyboard.LayoutChangeEventListener listener)

Adds a listener to layout change events.

Parameters:

listener - The listener to add.

Returns:

True if the listener has been added successfully, false otherwise or throws an exception if exceptions are enabled through the ErrorManager singleton.

Throws:

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

removeLayoutChangeEventListener

public boolean removeLayoutChangeEventListener(AdvancedKeyboard.LayoutChangeEventListener listener)

Removes a listener to layout change events.

Parameters:

listener - The listener to remove.

Returns:

True if the listener has been removed successfully, false otherwise or throws an exception if exceptions are enabled through the ErrorManager singleton.

Throws:

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

addMultitapEventListener

public boolean addMultitapEventListener(AdvancedKeyboard.MultitapEventListener listener)

Adds a listener to multitap events.

Parameters:

listener - The listener to add.

Returns:

True if the listener has been added successfully, false otherwise or throws an exception if exceptions are enabled through the ErrorManager singleton.

Throws:

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

removeMultitapEventListener

public boolean removeMultitapEventListener(AdvancedKeyboard.MultitapEventListener listener)

Removes a listener to multitap events.

Parameters:

listener - The listener to remove.

Returns:

True if the listener has been removed successfully, false otherwise or throws an exception if exceptions are enabled through the ErrorManager singleton.

Throws:

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