to top
Datalogic APIs
public class

AdvancedKeyboard.Configuration

extends Object
java.lang.Object
   ↳ com.datalogic.device.input.AdvancedKeyboard.Configuration

Class Overview

Class that stores the configuration related some keyboard parameters. It can be retrieved by using the getConfiguration method and modified back using the setConfiguration method.

Summary

Public Methods
int getBacklightBrightness()
Gets the keyboard backlight brightness.
int getBacklightTimeout()
Gets the keyboard backlight timeout in milliseconds.
AdvancedKeyboard.LayoutNotificationType getLayoutNotificationType()
Gets the layout notification type.
int getMultitapDelay()
Gets the keyboard multitap delay used to define after how much time from the first multitap key press the associated character will be submitted to the UI.
boolean isBacklightControlEnabled()
Checks if the keyboard backlight control is enabled.
boolean isBacklightNotificationEnabled()
Checks if the backlight notification is enabled.
boolean isMultitapNotificationEnabled()
Checks if the multitap notification is enabled.
void setBacklightBrightness(int backlightBrightness)
Sets the keyboard backlight brightness.
void setBacklightControlEnabled(boolean backlightControlEnabled)
Sets the parameter to enable or disable the keyboard backlight control.
void setBacklightNotificationEnabled(boolean backlightNotificationEnabled)
Enables or disables the backlight notification.
void setBacklightTimeout(int backlightTimeout)
Sets the keyboard backlight inactivity timeout.
void setLayoutNotificationType(AdvancedKeyboard.LayoutNotificationType layoutNotificationType)
Sets the layout notification type.
void setMultitapDelay(int multitapDelay)
Sets the keyboard multitap delay used to define after how much time from the first multitap key press the associated character will be submitted to the UI.
void setMultitapNotificationEnabled(boolean multitapNotificationEnabled)
Enables or disables the multitap notification.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public int getBacklightBrightness ()

Added in revision 22

Gets the keyboard backlight brightness. This is effective only when the backlight control is enabled.

Returns
  • The keyboard backlight brightness.

public int getBacklightTimeout ()

Added in revision 22

Gets the keyboard backlight timeout in milliseconds. In case of inactivity, the keyboard backlight will turn off after this amount of time.

Returns
  • The backlight timeout.

public AdvancedKeyboard.LayoutNotificationType getLayoutNotificationType ()

Added in revision 22

Gets the layout notification type.

Returns
  • The layout notification type.

public int getMultitapDelay ()

Added in revision 22

Gets the keyboard multitap delay used to define after how much time from the first multitap key press the associated character will be submitted to the UI.

Returns
  • Keyboard multitap delay (in milliseconds).

public boolean isBacklightControlEnabled ()

Added in revision 22

Checks if the keyboard backlight control is enabled.

Returns
  • True if the backlight control is enabled, false otherwise.

public boolean isBacklightNotificationEnabled ()

Added in revision 22

Checks if the backlight notification is enabled. This notification is visible after the backlight up or down keys are pressed, showing the currently backlight brightness level and allowing the user to edit it directly through the touch scren. The notification automatically disappears after the backlight timeout has been reached.

Returns
  • True if the backlight notification is enabled, false otherwise.

public boolean isMultitapNotificationEnabled ()

Added in revision 22

Checks if the multitap notification is enabled. This notification is visible after a multitap key is pressed, showing the list of all multitap characters related to that key and the currently selected one. The notification automatically disappears after the multitap delay has been reached.

Returns
  • True if the multitap notification is enabled, false otherwise.

public void setBacklightBrightness (int backlightBrightness)

Added in revision 22

Sets the keyboard backlight brightness. This is effective only when the keyboard baclight control is enabled.

Parameters
backlightBrightness The backlight brightness (in the range 0-100).

public void setBacklightControlEnabled (boolean backlightControlEnabled)

Added in revision 22

Sets the parameter to enable or disable the keyboard backlight control.

Parameters
backlightControlEnabled True to enable the backlight control, false to disable it.

public void setBacklightNotificationEnabled (boolean backlightNotificationEnabled)

Added in revision 22

Enables or disables the backlight notification. This notification is visible after the backlight up or down keys are pressed, showing the currently backlight brightness level and allowing the user to edit it directly through the touch scren. The notification automatically disappears after the backlight timeout has been reached.

Parameters
backlightNotificationEnabled True to enable the backlight notification, false to disable it.

public void setBacklightTimeout (int backlightTimeout)

Added in revision 22

Sets the keyboard backlight inactivity timeout. In case of inactivity, the keyboard backlight will turn off after this amount of time.

Parameters
backlightTimeout The backlight timeout.

public void setLayoutNotificationType (AdvancedKeyboard.LayoutNotificationType layoutNotificationType)

Added in revision 22

Sets the layout notification type.

Parameters
layoutNotificationType The layout notification type to set.

public void setMultitapDelay (int multitapDelay)

Added in revision 22

Sets the keyboard multitap delay used to define after how much time from the first multitap key press the associated character will be submitted to the UI.

Parameters
multitapDelay The keyboard multitap delay to set (in milliseconds). It must be more than 0.

public void setMultitapNotificationEnabled (boolean multitapNotificationEnabled)

Added in revision 22

Enables or disables the multitap notification. This notification is visible after a multitap key is pressed, showing the list of all multitap characters related to that key and the currently selected one. The notification automatically disappears after the multitap delay has been reached.

Parameters
multitapNotificationEnabled True to enable the multitap notification, false to disable it.