UiObject

Constructs a UiObject to represent a specific UI element matched by the specified UiSelector selector properties.

Clears the existing text contents in an editable field. The UiSelector of this object must reference a UI element that is editable. When you call this method, the method first sets focus at the start edge of the field. The method then simulates a long-press to select the existing text, and deletes the selected text. If a "Select-All" option is displayed, the method will automatically attempt to use it to ensure full text selection. Note that it is possible that not all the text in the field is selected; for example, if the text contains separators such as spaces, slashes, at symbol etc. Also, not all editable fields support the long-press functionality.

Performs a click at the center of the visible bounds of the UI element represented by this UiObject.

Performs a click at the center of the visible bounds of the UI element represented by this UiObject and waits for window transitions. This method differ from click() only in that this method waits for a a new window transition as a result of the click. Some examples of a window transition:

See clickAndWaitForNewWindow(long) This method is intended to reliably wait for window transitions that would typically take longer than the usual default timeouts.

Clicks the bottom and right corner of the UI element

Clicks the top and left corner of the UI element

Check if UI element exists. This methods performs a waitForExists(long) with zero timeout. This basically returns immediately whether the UI element represented by this UiObject exists or not. If you need to wait longer for this UI element, then see waitForExists(long).

Returns the UI element's bounds property. See getVisibleBounds()

Creates a new UiObject representing a child UI element of the element currently represented by this UiObject.

Counts the child UI elements immediately under the UI element currently represented by this UiObject.

Reads the content_desc property of the UI element

Creates a new UiObject representing a child UI element from the parent element currently represented by this object. Essentially this is starting the search from the parent element and can also be used to find sibling UI elements to the one currently represented by this UiObject.

Reads the UI element's package property

Debugging helper. A test can dump the properties of a selector as a string to its logs if needed. getSelector().toString();

Reads the text property of the UI element

Returns the visible bounds of the UI element. If a portion of the UI element is visible, only the bounds of the visible portion are reported.

Check if the UI element's checkable property is currently true

Check if the UI element's checked property is currently true

Check if the UI element's clickable property is currently true

Check if the UI element's enabled property is currently true

Check if the UI element's focusable property is currently true

Check if the UI element's focused property is currently true

Check if the UI element's long-clickable property is currently true

Check if the UI element's scrollable property is currently true

Check if the UI element's selected property is currently true

Long clicks the center of the visible bounds of the UI element

Long clicks bottom and right corner of the UI element

Long clicks on the top and left corner of the UI element

Sets the text in an editable field, after clearing the field's content. The UiSelector selector of this object must reference a UI element that is editable. When you call this method, the method first simulates a click() on editable field to set focus. The method then clears the field's contents and injects your specified text into the field. If you want to capture the original contents of the field, call getText() first. You can then modify the text and use this method to update the field.

Perform the action on the UI element that is represented by this object, Also see #scrollToBeginning(int), #scrollToEnd(int), #scrollBackward(), #scrollForward(). This method will perform the swipe gesture over any surface. The targeted UI element does not need to have the attribute scrollable set to true for this operation to be performed.

Perform the action on the UI element that is represented by this object. Also see #scrollToBeginning(int), #scrollToEnd(int), #scrollBackward(), #scrollForward(). This method will perform the swipe gesture over any surface. The targeted UI element does not need to have the attribute scrollable set to true for this operation to be performed.

Perform the action on the UI element that is represented by this object. Also see #scrollToBeginning(int), #scrollToEnd(int), #scrollBackward(), #scrollForward(). This method will perform the swipe gesture over any surface. The targeted UI element does not need to have the attribute scrollable set to true for this operation to be performed.

Perform the action on the UI element that is represented by this UiObject. Also see #scrollToBeginning(int), #scrollToEnd(int), #scrollBackward(), #scrollForward().

Waits a specified length of time for a UI element to become visible. This method waits until the UI element becomes visible on the display, or until the timeout has elapsed. You can use this method in situations where the content that you want to select is not immediately displayed.

Waits a specified length of time for a UI element to become undetectable. This method waits until a UI element is no longer matchable, or until the timeout has elapsed. A UI element becomes undetectable when the UiSelector of the object is unable to find a match because the element has either changed its state or is no longer displayed. You can use this method when attempting to wait for some long operation to compete, such as downloading a large file or connecting to a remote server.