Package io.appium.java_client.android.nativekey

Enum Class KeyEventMetaModifier

java.lang.Object

java.lang.Enum<KeyEventMetaModifier>

io.appium.java_client.android.nativekey.KeyEventMetaModifier

All Implemented Interfaces:

Serializable, Comparable<KeyEventMetaModifier>, Constable

public enum KeyEventMetaModifier
extends Enum<KeyEventMetaModifier>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALT_LEFT_ON	This mask is used to check whether the left ALT meta key is pressed.
ALT_LOCKED	ALT key locked.
ALT_MASK	This mask is a combination of ALT_ON, ALT_LEFT_ON and ALT_RIGHT_ON.
ALT_ON	This mask is used to check whether one of the ALT meta keys is pressed.
ALT_RIGHT_ON	This mask is used to check whether the right the ALT meta key is pressed.
CAP_LOCKED	SHIFT key locked in CAPS mode.
CAPS_LOCK_ON	This mask is used to check whether the CAPS LOCK meta key is on.
CTRL_LEFT_ON	This mask is used to check whether the left CTRL meta key is pressed.
CTRL_MASK	This mask is a combination of CTRL_ON, CTRL_LEFT_ON and CTRL_RIGHT_ON.
CTRL_ON	This mask is used to check whether one of the CTRL meta keys is pressed.
CTRL_RIGHT_ON	This mask is used to check whether the right CTRL meta key is pressed.
FUNCTION_ON	This mask is used to check whether the FUNCTION meta key is pressed.
META_LEFT_ON	This mask is used to check whether the left META meta key is pressed.
META_MASK	This mask is a combination of META_ON, META_LEFT_ON and META_RIGHT_ON.
META_ON	This mask is used to check whether one of the META meta keys is pressed.
META_RIGHT_ON	This mask is used to check whether the right META meta key is pressed.
NUM_LOCK_ON	This mask is used to check whether the NUM LOCK meta key is on.
SCROLL_LOCK_ON	This mask is used to check whether the SCROLL LOCK meta key is on.
SELECTING	Text is in selection mode.
SHIFT_LEFT_ON	This mask is used to check whether the left SHIFT meta key is pressed.
SHIFT_MASK	This mask is a combination of SHIFT_ON, SHIFT_LEFT_ON and SHIFT_RIGHT_ON.
SHIFT_ON	This mask is used to check whether one of the SHIFT meta keys is pressed.
SHIFT_RIGHT_ON	This mask is used to check whether the right SHIFT meta key is pressed.
SYM_LOCKED	SYM key locked.
SYM_ON	This mask is used to check whether the SYM meta key is pressed.

Method Summary

Modifier and Type	Method	Description
int	getValue()
static KeyEventMetaModifier	valueOf(String name)	Returns the enum constant of this class with the specified name.
static KeyEventMetaModifier[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CAP_LOCKED

public static final KeyEventMetaModifier CAP_LOCKED

SHIFT key locked in CAPS mode. Reserved for use by MetaKeyKeyListener for a published constant in its API.

ALT_LOCKED

public static final KeyEventMetaModifier ALT_LOCKED

ALT key locked. Reserved for use by MetaKeyKeyListener for a published constant in its API.

SYM_LOCKED

public static final KeyEventMetaModifier SYM_LOCKED

SYM key locked. Reserved for use by MetaKeyKeyListener for a published constant in its API.

SELECTING

public static final KeyEventMetaModifier SELECTING

Text is in selection mode. Reserved for use by MetaKeyKeyListener for a private unpublished constant in its API that is currently being retained for legacy reasons.

ALT_ON

public static final KeyEventMetaModifier ALT_ON

This mask is used to check whether one of the ALT meta keys is pressed.

See Also:

• AndroidKey.ALT_LEFT
• AndroidKey.ALT_RIGHT

ALT_LEFT_ON

public static final KeyEventMetaModifier ALT_LEFT_ON

This mask is used to check whether the left ALT meta key is pressed.

See Also:

• AndroidKey.ALT_LEFT

ALT_RIGHT_ON

public static final KeyEventMetaModifier ALT_RIGHT_ON

This mask is used to check whether the right the ALT meta key is pressed.

See Also:

• AndroidKey.ALT_RIGHT

SHIFT_ON

public static final KeyEventMetaModifier SHIFT_ON

This mask is used to check whether one of the SHIFT meta keys is pressed.

See Also:

• AndroidKey.SHIFT_LEFT
• AndroidKey.SHIFT_RIGHT

SHIFT_LEFT_ON

public static final KeyEventMetaModifier SHIFT_LEFT_ON

This mask is used to check whether the left SHIFT meta key is pressed.

See Also:

• AndroidKey.SHIFT_LEFT

SHIFT_RIGHT_ON

public static final KeyEventMetaModifier SHIFT_RIGHT_ON

This mask is used to check whether the right SHIFT meta key is pressed.

See Also:

• AndroidKey.SHIFT_RIGHT

SYM_ON

public static final KeyEventMetaModifier SYM_ON

This mask is used to check whether the SYM meta key is pressed.

FUNCTION_ON

public static final KeyEventMetaModifier FUNCTION_ON

This mask is used to check whether the FUNCTION meta key is pressed.

CTRL_ON

public static final KeyEventMetaModifier CTRL_ON

This mask is used to check whether one of the CTRL meta keys is pressed.

See Also:

• AndroidKey.CTRL_LEFT
• AndroidKey.CTRL_RIGHT

CTRL_LEFT_ON

public static final KeyEventMetaModifier CTRL_LEFT_ON

This mask is used to check whether the left CTRL meta key is pressed.

See Also:

• AndroidKey.CTRL_LEFT

CTRL_RIGHT_ON

public static final KeyEventMetaModifier CTRL_RIGHT_ON

This mask is used to check whether the right CTRL meta key is pressed.

See Also:

• AndroidKey.CTRL_RIGHT

META_ON

public static final KeyEventMetaModifier META_ON

This mask is used to check whether one of the META meta keys is pressed.

See Also:

• AndroidKey.META_LEFT
• AndroidKey.META_RIGHT

META_LEFT_ON

public static final KeyEventMetaModifier META_LEFT_ON

This mask is used to check whether the left META meta key is pressed.

See Also:

• AndroidKey.META_LEFT

META_RIGHT_ON

public static final KeyEventMetaModifier META_RIGHT_ON

This mask is used to check whether the right META meta key is pressed.

See Also:

• AndroidKey.META_RIGHT

CAPS_LOCK_ON

public static final KeyEventMetaModifier CAPS_LOCK_ON

This mask is used to check whether the CAPS LOCK meta key is on.

See Also:

• AndroidKey.CAPS_LOCK

NUM_LOCK_ON

public static final KeyEventMetaModifier NUM_LOCK_ON

This mask is used to check whether the NUM LOCK meta key is on.

See Also:

• AndroidKey.NUM_LOCK

SCROLL_LOCK_ON

public static final KeyEventMetaModifier SCROLL_LOCK_ON

This mask is used to check whether the SCROLL LOCK meta key is on.

See Also:

• AndroidKey.SCROLL_LOCK

SHIFT_MASK

public static final KeyEventMetaModifier SHIFT_MASK

This mask is a combination of SHIFT_ON, SHIFT_LEFT_ON and SHIFT_RIGHT_ON.

ALT_MASK

public static final KeyEventMetaModifier ALT_MASK

This mask is a combination of ALT_ON, ALT_LEFT_ON and ALT_RIGHT_ON.

CTRL_MASK

public static final KeyEventMetaModifier CTRL_MASK

This mask is a combination of CTRL_ON, CTRL_LEFT_ON and CTRL_RIGHT_ON.

META_MASK

public static final KeyEventMetaModifier META_MASK

This mask is a combination of META_ON, META_LEFT_ON and META_RIGHT_ON.

Method Details

values

public static KeyEventMetaModifier[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static KeyEventMetaModifier valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()