io.appium.droiddriver.actions

Class SingleKeyAction

java.lang.Object

io.appium.droiddriver.actions.BaseAction

io.appium.droiddriver.actions.EventAction

io.appium.droiddriver.actions.KeyAction

io.appium.droiddriver.actions.SingleKeyAction

All Implemented Interfaces:

Action

public class SingleKeyAction
extends KeyAction

An action to press a single key. While it is convenient for navigating the UI, do not overuse it - the application may interpret key codes in a custom way and, more importantly, application users may not have access to it because the device (physical or virtual keyboard) may not support all key codes.

Field Summary

Fields

Modifier and Type	Field and Description
static SingleKeyAction	BACK
static SingleKeyAction	CTRL_MOVE_END Requires SDK API 11 or higher
static SingleKeyAction	CTRL_MOVE_HOME Requires SDK API 11 or higher
static SingleKeyAction	DELETE
static SingleKeyAction	MENU
static SingleKeyAction	SEARCH

Constructor Summary

Constructors

Constructor and Description
SingleKeyAction(int keyCode) Defaults metaState to 0
SingleKeyAction(int keyCode, int metaState) Defaults timeoutMillis to 100 and checkFocused to false
SingleKeyAction(int keyCode, int metaState, long timeoutMillis, boolean checkFocused)

Method Summary

Modifier and Type	Method and Description
boolean	perform(InputInjector injector, UiElement element) Performs the action by injecting synthesized events.
java.lang.String	toString()

Methods inherited from class io.appium.droiddriver.actions.KeyAction

maybeCheckFocused

Methods inherited from class io.appium.droiddriver.actions.EventAction

perform

Methods inherited from class io.appium.droiddriver.actions.BaseAction

getTimeoutMillis

Methods inherited from class java.lang.Object

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

Field Detail

MENU

public static final SingleKeyAction MENU

SEARCH

public static final SingleKeyAction SEARCH

BACK

public static final SingleKeyAction BACK

DELETE

public static final SingleKeyAction DELETE

CTRL_MOVE_HOME

public static final SingleKeyAction CTRL_MOVE_HOME

Requires SDK API 11 or higher

CTRL_MOVE_END

public static final SingleKeyAction CTRL_MOVE_END

Requires SDK API 11 or higher

Constructor Detail

SingleKeyAction

public SingleKeyAction(int keyCode)

Defaults metaState to 0

SingleKeyAction

public SingleKeyAction(int keyCode,
                       int metaState)

Defaults timeoutMillis to 100 and checkFocused to false

SingleKeyAction

public SingleKeyAction(int keyCode,
                       int metaState,
                       long timeoutMillis,
                       boolean checkFocused)

Method Detail

perform

public boolean perform(InputInjector injector,
                       UiElement element)

Description copied from class: EventAction

Performs the action by injecting synthesized events.

Specified by:

perform in class EventAction

Parameters:

injector - the injector to inject InputEvents

element - the UiElement to perform the action on

Returns:

Whether the action is successful. Some actions throw exceptions in case of failure, when that behavior is more appropriate. For example, if event injection returns false.

toString

public java.lang.String toString()

Description copied from interface: Action

It is recommended that this method return the description of the action, for example, "SwipeAction{DOWN}".

Specified by:

toString in interface Action

Overrides:

toString in class java.lang.Object