TypeTextAction

public final class TypeTextAction implements ViewAction


Enables typing text on views.

Summary

Public constructors

TypeTextAction(String stringToBeTyped)

Constructs TypeTextAction with given string.

@RemoteMsgConstructor
TypeTextAction(String stringToBeTyped, boolean tapToFocus)

Constructs TypeTextAction with given string.

TypeTextAction(
    String stringToBeTyped,
    boolean tapToFocus,
    GeneralClickAction clickAction
)

Constructs TypeTextAction with given string.

Public methods

Matcher<View>

A mechanism for ViewActions to specify what type of views they can operate on.

String

Returns a description of the view action.

void
perform(UiController uiController, View view)

Performs this action on the given view.

Public constructors

TypeTextAction

public TypeTextAction(String stringToBeTyped)

Constructs TypeTextAction with given string. If the string is empty it results in no-op (nothing is typed). By default this action sends a tap event to the center of the view to attain focus before typing.

Parameters
String stringToBeTyped

String To be typed by TypeTextAction

TypeTextAction

@RemoteMsgConstructor
public TypeTextAction(String stringToBeTyped, boolean tapToFocus)

Constructs TypeTextAction with given string. If the string is empty it results in no-op (nothing is typed).

Parameters
String stringToBeTyped

String To be typed by TypeTextAction

boolean tapToFocus

indicates whether a tap should be sent to the underlying view before typing.

TypeTextAction

public TypeTextAction(
    String stringToBeTyped,
    boolean tapToFocus,
    GeneralClickAction clickAction
)

Constructs TypeTextAction with given string. If the string is empty it results in no-op (nothing is typed).

Parameters
String stringToBeTyped

String To be typed by TypeTextAction

boolean tapToFocus

indicates whether a tap should be sent to the underlying view before typing.

GeneralClickAction clickAction

the click action instance to use when tapping to focus. Can be null if tapToFocus is false. If tapToFocus is true but no clickAction is specified, a default click action will be used for tapping.

Public methods

getConstraints

public Matcher<ViewgetConstraints()

A mechanism for ViewActions to specify what type of views they can operate on.

A ViewAction can demand that the view passed to perform meets certain constraints. For example it may want to ensure the view is already in the viewable physical screen of the device or is of a certain type.

Returns
Matcher<View>

a Matcher that will be tested prior to calling perform.

getDescription

public String getDescription()

Returns a description of the view action. The description should not be overly long and should fit nicely in a sentence like: "performing %description% action on view with id ..."

perform

public void perform(UiController uiController, View view)

Performs this action on the given view.

Parameters
UiController uiController

the controller to use to interact with the UI.

View view

the view to act upon. never null.