com.smartdevicelink.proxy.rpc.enums

Enum KeyboardEvent

java.lang.Object

java.lang.Enum<KeyboardEvent>

com.smartdevicelink.proxy.rpc.enums.KeyboardEvent

All Implemented Interfaces:

Serializable, Comparable<KeyboardEvent>

public enum KeyboardEvent
extends Enum<KeyboardEvent>

Enumeration listing possible keyboard events.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ENTRY_ABORTED The User has not finished entering text and the keyboard is aborted with the event of higher priority.
ENTRY_CANCELLED The User has pressed the HMI-defined "Cancel" button.
ENTRY_SUBMITTED The User has finished entering text from the keyboard and submitted the entry.
ENTRY_VOICE
INPUT_KEY_MASK_DISABLED
INPUT_KEY_MASK_ENABLED
KEYPRESS The use has pressed the keyboard key (applies to both SINGLE_KEYPRESS and RESEND_CURRENT_ENTRY modes).

Method Summary

Modifier and Type	Method and Description
static KeyboardEvent	valueForString(String value) Convert String to KeyboardEvent
static KeyboardEvent	valueOf(String name) Returns the enum constant of this type with the specified name.
static KeyboardEvent[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

KEYPRESS

public static final KeyboardEvent KEYPRESS

The use has pressed the keyboard key (applies to both SINGLE_KEYPRESS and RESEND_CURRENT_ENTRY modes).

ENTRY_SUBMITTED

public static final KeyboardEvent ENTRY_SUBMITTED

The User has finished entering text from the keyboard and submitted the entry.

ENTRY_CANCELLED

public static final KeyboardEvent ENTRY_CANCELLED

The User has pressed the HMI-defined "Cancel" button.

ENTRY_ABORTED

public static final KeyboardEvent ENTRY_ABORTED

The User has not finished entering text and the keyboard is aborted with the event of higher priority.

ENTRY_VOICE

public static final KeyboardEvent ENTRY_VOICE

Since:

SmartDeviceLink 4.0

INPUT_KEY_MASK_ENABLED

public static final KeyboardEvent INPUT_KEY_MASK_ENABLED

Since:

SmartDeviceLink 7.1.0

INPUT_KEY_MASK_DISABLED

public static final KeyboardEvent INPUT_KEY_MASK_DISABLED

Since:

SmartDeviceLink 7.1.0

Method Detail

values

public static KeyboardEvent[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (KeyboardEvent c : KeyboardEvent.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static KeyboardEvent valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

valueForString

public static KeyboardEvent valueForString(String value)

Convert String to KeyboardEvent

Parameters:

value - String

Returns:

KeyboardEvent