public final class

ViewActions

extends Object
java.lang.Object
   ↳ androidx.test.espresso.action.ViewActions

Class Overview

A collection of common ViewActions.

Summary

Public Methods
static ViewAction actionWithAssertions(ViewAction viewAction)
Performs all assertions before the ViewActions in this class and then performs the given ViewAction
static void addGlobalAssertion(String name, ViewAssertion viewAssertion)
Adds a ViewAssertion to be run every time a ViewAction in this class is performed.
static void clearGlobalAssertions()
static ViewAction clearText()
Returns an action that clears text on the view.
static ViewAction click()
Same as click(int inputDevice, int buttonState), but uses SOURCE_UNKNOWN as the inputDevice and BUTTON_PRIMARY as the buttonState.
static ViewAction click(int inputDevice, int buttonState)
Returns an action that clicks the view for a specific input device and button state.
static ViewAction click(ViewAction rollbackAction)
Returns an action that performs a single click on the view.
static ViewAction closeSoftKeyboard()
Returns an action that closes soft keyboard.
static ViewAction doubleClick()
Returns an action that double clicks the view.
static ViewAction longClick()
Returns an action that long clicks the view.
static ViewAction openLink(Matcher<String> linkTextMatcher, Matcher<Uri> uriMatcher)
Returns an action that opens a link matching the given link text and uri matchers.
static ViewAction openLinkWithText(String linkText)
Same as openLinkWithText(Matcher<String> linkTextMatcher), but uses is(linkText) as the linkTextMatcher.
static ViewAction openLinkWithText(Matcher<String> linkTextMatcher)
Same as openLink(Matcher<String> linkTextMatcher, Matcher<Uri> uriMatcher), but uses any(Uri.class) as the uriMatcher.
static ViewAction openLinkWithUri(String uri)
Same as openLinkWithUri(Matcher<Uri> uriMatcher), but uses is(uri) as the uriMatcher.
static ViewAction openLinkWithUri(Matcher<Uri> uriMatcher)
Same as openLink(Matcher<String> linkTextMatcher, Matcher<Uri> uriMatcher), but uses any(String.class) as the linkTextMatcher.
static ViewAction pressBack()
Returns an action that clicks the back button.
static ViewAction pressBackUnconditionally()
Similar to pressBack() but will not throw an exception when Espresso navigates outside the application or process under test.
static ViewAction pressImeActionButton()
Returns an action that presses the current action button (next, done, search, etc) on the IME (Input Method Editor).
static ViewAction pressKey(EspressoKey key)
Returns an action that presses the specified key with the specified modifiers.
static ViewAction pressKey(int keyCode)
Returns an action that presses the key specified by the keyCode (eg.
static ViewAction pressMenuKey()
Returns an action that presses the hardware menu key.
static void removeGlobalAssertion(ViewAssertion viewAssertion)
Removes the given assertion from the set of assertions to be run before actions are performed.
static ViewAction repeatedlyUntil(ViewAction action, Matcher<View> desiredStateMatcher, int maxAttempts)
Returns an action that performs given ViewAction on the view until view matches the desired Matcher<View>.
static ViewAction replaceText(String stringToBeSet)
Returns an action that updates the text attribute of a view.
static ViewAction scrollTo()
Returns an action that scrolls to the view.
static ViewAction swipeDown()
Returns an action that performs a swipe top-to-bottom across the horizontal center of the view.
static ViewAction swipeLeft()
Returns an action that performs a swipe right-to-left across the vertical center of the view.
static ViewAction swipeRight()
Returns an action that performs a swipe left-to-right across the vertical center of the view.
static ViewAction swipeUp()
Returns an action that performs a swipe bottom-to-top across the horizontal center of the view.
static ViewAction typeText(String stringToBeTyped)
Returns an action that selects the view (by clicking on it) and types the provided string into the view.
static ViewAction typeTextIntoFocusedView(String stringToBeTyped)
Returns an action that types the provided string into the view.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public static ViewAction actionWithAssertions (ViewAction viewAction)

Performs all assertions before the ViewActions in this class and then performs the given ViewAction

Parameters
viewAction ViewAction: the ViewAction to perform after the assertions
Returns
ViewAction

public static void addGlobalAssertion (String name, ViewAssertion viewAssertion)

Adds a ViewAssertion to be run every time a ViewAction in this class is performed. The assertion will be run prior to performing the action.

Parameters
name String: a name of the assertion to be added
viewAssertion ViewAssertion: a ViewAssertion to be added
Throws
IllegalArgumentException if the name/viewAssertion pair is already contained in the global assertions.

public static void clearGlobalAssertions ()

public static ViewAction clearText ()

Returns an action that clears text on the view.

View constraints:

public static ViewAction click ()

Same as click(int inputDevice, int buttonState), but uses SOURCE_UNKNOWN as the inputDevice and BUTTON_PRIMARY as the buttonState.

Returns
ViewAction

public static ViewAction click (int inputDevice, int buttonState)

Returns an action that clicks the view for a specific input device and button state.

Note: Not supported by API < 14. An UnsupportedOperationException will be thrown if called on API < 14. For API < 14, call click() instead.

View constraints:

  • must be displayed on screen

      Parameters
      inputDevice int: source input device of the click. Example: SOURCE_MOUSE
      buttonState int: buttonState associated with the click. Example: BUTTON_PRIMARY
      Returns
      ViewAction

public static ViewAction click (ViewAction rollbackAction)

Returns an action that performs a single click on the view.

If the click takes longer than the 'long press' duration (which is possible) the provided rollback action is invoked on the view and a click is attempted again.

This is only necessary if the view being clicked on has some different behaviour for long press versus a normal tap.

For example - if a long press on a particular view element opens a popup menu - ViewActions.pressBack() may be an acceptable rollback action.
View constraints:

  • must be displayed on screen
  • any constraints of the rollbackAction

      Parameters
      rollbackAction ViewAction
      Returns
      ViewAction

public static ViewAction closeSoftKeyboard ()

Returns an action that closes soft keyboard. If the keyboard is already closed, it is a no-op.

Returns
ViewAction

public static ViewAction doubleClick ()

Returns an action that double clicks the view.

View preconditions:

public static ViewAction longClick ()

Returns an action that long clicks the view.

View preconditions:

public static ViewAction openLink (Matcher<String> linkTextMatcher, Matcher<Uri> uriMatcher)

Returns an action that opens a link matching the given link text and uri matchers. The action is performed by invoking the link's onClick method (as opposed to actually issuing a click on the screen).

View preconditions:

  • must be displayed on screen
  • must be assignable from TextView
  • must have links

      Parameters
      linkTextMatcher Matcher
      uriMatcher Matcher
      Returns
      ViewAction

public static ViewAction openLinkWithText (String linkText)

Same as openLinkWithText(Matcher<String> linkTextMatcher), but uses is(linkText) as the linkTextMatcher.

Parameters
linkText String
Returns
ViewAction

public static ViewAction openLinkWithText (Matcher<String> linkTextMatcher)

Same as openLink(Matcher<String> linkTextMatcher, Matcher<Uri> uriMatcher), but uses any(Uri.class) as the uriMatcher.

Parameters
linkTextMatcher Matcher
Returns
ViewAction

public static ViewAction openLinkWithUri (String uri)

Same as openLinkWithUri(Matcher<Uri> uriMatcher), but uses is(uri) as the uriMatcher.

Parameters
uri String
Returns
ViewAction

public static ViewAction openLinkWithUri (Matcher<Uri> uriMatcher)

Same as openLink(Matcher<String> linkTextMatcher, Matcher<Uri> uriMatcher), but uses any(String.class) as the linkTextMatcher.

Parameters
uriMatcher Matcher
Returns
ViewAction

public static ViewAction pressBack ()

Returns an action that clicks the back button.

Returns
ViewAction
Throws
PerformException if Espresso navigates outside the application or process under test.

public static ViewAction pressBackUnconditionally ()

Similar to pressBack() but will not throw an exception when Espresso navigates outside the application or process under test.

Returns
ViewAction

public static ViewAction pressImeActionButton ()

Returns an action that presses the current action button (next, done, search, etc) on the IME (Input Method Editor). The selected view will have its onEditorAction method called.

Returns
ViewAction

public static ViewAction pressKey (EspressoKey key)

Returns an action that presses the specified key with the specified modifiers.

Parameters
key EspressoKey
Returns
ViewAction

public static ViewAction pressKey (int keyCode)

Returns an action that presses the key specified by the keyCode (eg. Keyevent.KEYCODE_BACK).

Parameters
keyCode int
Returns
ViewAction

public static ViewAction pressMenuKey ()

Returns an action that presses the hardware menu key.

Returns
ViewAction

public static void removeGlobalAssertion (ViewAssertion viewAssertion)

Removes the given assertion from the set of assertions to be run before actions are performed.

Parameters
viewAssertion ViewAssertion: the assertion to remove
Throws
IllegalArgumentException if the name/viewAssertion pair is not already contained in the global assertions.

public static ViewAction repeatedlyUntil (ViewAction action, Matcher<View> desiredStateMatcher, int maxAttempts)

Returns an action that performs given ViewAction on the view until view matches the desired Matcher<View>. It will repeat the given action until view matches the desired Matcher<View> or PerformException will be thrown if given number of unsuccessful attempts are made.

Parameters
action ViewAction: action to be performed repeatedly
desiredStateMatcher Matcher: action is performed repeatedly until view matches this view matcher
maxAttempts int: max number of times for which this action to be performed if view doesn't match the given view matcher
Returns
ViewAction

public static ViewAction replaceText (String stringToBeSet)

Returns an action that updates the text attribute of a view.

View preconditions:

  • must be displayed on screen
  • must be assignable from EditText

      Parameters
      stringToBeSet String
      Returns
      ViewAction

public static ViewAction scrollTo ()

Returns an action that scrolls to the view.

View preconditions:

  • must be a descendant of ScrollView
  • must have visibility set to View.VISIBLE

public static ViewAction swipeDown ()

Returns an action that performs a swipe top-to-bottom across the horizontal center of the view. The swipe doesn't start at the very edge of the view, but has a bit of offset.

View constraints:

public static ViewAction swipeLeft ()

Returns an action that performs a swipe right-to-left across the vertical center of the view. The swipe doesn't start at the very edge of the view, but is a bit offset.

View constraints:

public static ViewAction swipeRight ()

Returns an action that performs a swipe left-to-right across the vertical center of the view. The swipe doesn't start at the very edge of the view, but is a bit offset.

View constraints:

public static ViewAction swipeUp ()

Returns an action that performs a swipe bottom-to-top across the horizontal center of the view. The swipe doesn't start at the very edge of the view, but has a bit of offset.

View constraints:

public static ViewAction typeText (String stringToBeTyped)

Returns an action that selects the view (by clicking on it) and types the provided string into the view. Appending a \n to the end of the string translates to a ENTER key event. Note: this method performs a tap on the view before typing to force the view into focus, if the view already contains text this tap may place the cursor at an arbitrary position within the text.

View preconditions:

  • must be displayed on screen
  • must support input methods

      Parameters
      stringToBeTyped String
      Returns
      ViewAction

public static ViewAction typeTextIntoFocusedView (String stringToBeTyped)

Returns an action that types the provided string into the view. Appending a \n to the end of the string translates to a ENTER key event. Note: this method does not change cursor position in the focused view - text is inserted at the location where the cursor is currently pointed.

View preconditions:

  • must be displayed on screen
  • must support input methods
  • must be already focused

      Parameters
      stringToBeTyped String
      Returns
      ViewAction