UiSelector

Artifact: androidx.test.uiautomator:uiautomator

Added in 2.2.0

Kotlin |Java

public class UiSelector

Specifies the elements in the layout hierarchy for tests to target, filtered by properties such as text value, content-description, class name, and state information. You can also target an element by its location in a layout hierarchy.

Summary

Public constructors
`UiSelector()`

Public methods
`@NonNull UiSelector`	`checkable(boolean val)` Set the search criteria to match widgets that are checkable.
`@NonNull UiSelector`	`checked(boolean val)` Set the search criteria to match widgets that are currently checked (usually for checkboxes).
`@NonNull UiSelector`	`childSelector(@NonNull UiSelector selector)` Adds a child UiSelector criteria to this selector.
`@NonNull UiSelector`	`className(@NonNull String className)` Set the search criteria to match the class property for a widget (for example, "android.widget.Button").
`@NonNull UiSelector`	`<T> className(@NonNull Class<T> type)` Set the search criteria to match the class property for a widget (for example, "android.widget.Button").
`@NonNull UiSelector`	`classNameMatches(@NonNull String regex)` Set the search criteria to match the class property for a widget, using a regular expression.
`@NonNull UiSelector`	`clickable(boolean val)` Set the search criteria to match widgets that are clickable.
`@NonNull UiSelector`	`description(@NonNull String desc)` Set the search criteria to match the content-description property for a widget.
`@NonNull UiSelector`	`descriptionContains(@NonNull String desc)` Set the search criteria to match the content-description property for a widget.
`@NonNull UiSelector`	`descriptionMatches(@NonNull String regex)` Set the search criteria to match the content-description property for a widget.
`@NonNull UiSelector`	`descriptionStartsWith(@NonNull String desc)` Set the search criteria to match the content-description property for a widget.
`@NonNull UiSelector`	`enabled(boolean val)` Set the search criteria to match widgets that are enabled.
`@NonNull UiSelector`	`focusable(boolean val)` Set the search criteria to match widgets that are focusable.
`@NonNull UiSelector`	`focused(boolean val)` Set the search criteria to match widgets that have focus.
`@NonNull UiSelector`	`fromParent(@NonNull UiSelector selector)` Adds a child UiSelector criteria to this selector which is used to start search from the parent widget.
`@NonNull UiSelector`	`index(int index)` Set the search criteria to match the widget by its node index in the layout hierarchy.
`@NonNull UiSelector`	`instance(int instance)` Set the search criteria to match the widget by its instance number.
`@NonNull UiSelector`	`longClickable(boolean val)` Set the search criteria to match widgets that are long-clickable.
`@NonNull UiSelector`	`packageName(@NonNull String name)` Set the search criteria to match the package name of the application that contains the widget.
`@NonNull UiSelector`	`packageNameMatches(@NonNull String regex)` Set the search criteria to match the package name of the application that contains the widget.
`@NonNull UiSelector`	`resourceId(@NonNull String id)` Set the search criteria to match the given resource ID.
`@NonNull UiSelector`	`resourceIdMatches(@NonNull String regex)` Set the search criteria to match the resource ID of the widget, using a regular expression.
`@NonNull UiSelector`	`scrollable(boolean val)` Set the search criteria to match widgets that are scrollable.
`@NonNull UiSelector`	`selected(boolean val)` Set the search criteria to match widgets that are currently selected.
`@NonNull UiSelector`	`text(@NonNull String text)` Set the search criteria to match the visible text displayed in a widget (for example, the text label to launch an app).
`@NonNull UiSelector`	`textContains(@NonNull String text)` Set the search criteria to match the visible text in a widget where the visible text must contain the string in your input argument.
`@NonNull UiSelector`	`textMatches(@NonNull String regex)` Set the search criteria to match the visible text displayed in a layout element, using a regular expression.
`@NonNull UiSelector`	`textStartsWith(@NonNull String text)` Set the search criteria to match visible text in a widget that is prefixed by the text parameter.
`String`	`toString()`

Protected methods
`@NonNull UiSelector`	`cloneSelector()`

Public constructors

UiSelector

Added in 2.2.0

public UiSelector()

Public methods

checkable

Added in 2.2.0

public @NonNull UiSelector checkable(boolean val)

Set the search criteria to match widgets that are checkable. Typically, using this search criteria alone is not useful. You should also include additional criteria, such as text, content-description, or the class name for a widget. If no other search criteria is specified, and there is more than one matching widget, the first widget in the tree is selected.

Parameters
`boolean val`	Value to match

Returns
`@NonNull UiSelector`	UiSelector with the specified search criteria

checked

Added in 2.2.0

public @NonNull UiSelector checked(boolean val)

Set the search criteria to match widgets that are currently checked (usually for checkboxes). Typically, using this search criteria alone is not useful. You should also include additional criteria, such as text, content-description, or the class name for a widget. If no other search criteria is specified, and there is more than one matching widget, the first widget in the tree is selected.

Parameters
`boolean val`	Value to match

Returns
`@NonNull UiSelector`	UiSelector with the specified search criteria

childSelector

Added in 2.2.0

public @NonNull UiSelector childSelector(@NonNull UiSelector selector)

Adds a child UiSelector criteria to this selector. Use this selector to narrow the search scope to child widgets under a specific parent widget.

Parameters
`@NonNull UiSelector selector`

Returns
`@NonNull UiSelector`	UiSelector with this added search criterion

className

Added in 2.2.0

public @NonNull UiSelector className(@NonNull String className)

Set the search criteria to match the class property for a widget (for example, "android.widget.Button").

Parameters
`@NonNull String className`	Value to match

Returns
`@NonNull UiSelector`	UiSelector with the specified search criteria

className

Added in 2.2.0

public @NonNull UiSelector <T> className(@NonNull Class<T> type)

Set the search criteria to match the class property for a widget (for example, "android.widget.Button").

Parameters
`@NonNull Class<T> type`	type

Returns
`@NonNull UiSelector`	UiSelector with the specified search criteria

classNameMatches

Added in 2.2.0

public @NonNull UiSelector classNameMatches(@NonNull String regex)

Set the search criteria to match the class property for a widget, using a regular expression.

Parameters
`@NonNull String regex`	a regular expression

Returns
`@NonNull UiSelector`	UiSelector with the specified search criteria

clickable

Added in 2.2.0

public @NonNull UiSelector clickable(boolean val)

Set the search criteria to match widgets that are clickable. Typically, using this search criteria alone is not useful. You should also include additional criteria, such as text, content-description, or the class name for a widget. If no other search criteria is specified, and there is more than one matching widget, the first widget in the tree is selected.

Parameters
`boolean val`	Value to match

Returns
`@NonNull UiSelector`	UiSelector with the specified search criteria

description

Added in 2.2.0

public @NonNull UiSelector description(@NonNull String desc)

Set the search criteria to match the content-description property for a widget. The content-description is typically used by the Android Accessibility framework to provide an audio prompt for the widget when the widget is selected. The content-description for the widget must match exactly with the string in your input argument. Matching is case-sensitive.

Parameters
`@NonNull String desc`	Value to match

Returns
`@NonNull UiSelector`	UiSelector with the specified search criteria

descriptionContains

Added in 2.2.0

public @NonNull UiSelector descriptionContains(@NonNull String desc)

Set the search criteria to match the content-description property for a widget. The content-description is typically used by the Android Accessibility framework to provide an audio prompt for the widget when the widget is selected. The content-description for the widget must contain the string in your input argument. Matching is case-insensitive.

Parameters
`@NonNull String desc`	Value to match

Returns
`@NonNull UiSelector`	UiSelector with the specified search criteria

descriptionMatches

Added in 2.2.0

public @NonNull UiSelector descriptionMatches(@NonNull String regex)

Parameters
`@NonNull String regex`	a regular expression

Returns
`@NonNull UiSelector`	UiSelector with the specified search criteria

descriptionStartsWith

Added in 2.2.0

public @NonNull UiSelector descriptionStartsWith(@NonNull String desc)

Set the search criteria to match the content-description property for a widget. The content-description is typically used by the Android Accessibility framework to provide an audio prompt for the widget when the widget is selected. The content-description for the widget must start with the string in your input argument. Matching is case-insensitive.

Parameters
`@NonNull String desc`	Value to match

Returns
`@NonNull UiSelector`	UiSelector with the specified search criteria

enabled

Added in 2.2.0

public @NonNull UiSelector enabled(boolean val)

Set the search criteria to match widgets that are enabled. Typically, using this search criteria alone is not useful. You should also include additional criteria, such as text, content-description, or the class name for a widget. If no other search criteria is specified, and there is more than one matching widget, the first widget in the tree is selected.

Parameters
`boolean val`	Value to match

Returns
`@NonNull UiSelector`	UiSelector with the specified search criteria

focusable

Added in 2.2.0

public @NonNull UiSelector focusable(boolean val)

Set the search criteria to match widgets that are focusable. Typically, using this search criteria alone is not useful. You should also include additional criteria, such as text, content-description, or the class name for a widget. If no other search criteria is specified, and there is more than one matching widget, the first widget in the tree is selected.

Parameters
`boolean val`	Value to match

Returns
`@NonNull UiSelector`	UiSelector with the specified search criteria

focused

Added in 2.2.0

public @NonNull UiSelector focused(boolean val)

Set the search criteria to match widgets that have focus. Typically, using this search criteria alone is not useful. You should also include additional criteria, such as text, content-description, or the class name for a widget. If no other search criteria is specified, and there is more than one matching widget, the first widget in the tree is selected.

Parameters
`boolean val`	Value to match

Returns
`@NonNull UiSelector`	UiSelector with the specified search criteria

fromParent

Added in 2.2.0

public @NonNull UiSelector fromParent(@NonNull UiSelector selector)

Adds a child UiSelector criteria to this selector which is used to start search from the parent widget. Use this selector to narrow the search scope to sibling widgets as well all child widgets under a parent.

Parameters
`@NonNull UiSelector selector`

Returns
`@NonNull UiSelector`	UiSelector with this added search criterion

index

Added in 2.2.0

public @NonNull UiSelector index(int index)

Set the search criteria to match the widget by its node index in the layout hierarchy. The index value must be 0 or greater. Using the index can be unreliable and should only be used as a last resort for matching. Instead, consider using the instance method.

Parameters
`int index`	Value to match

Returns
`@NonNull UiSelector`	UiSelector with the specified search criteria

instance

Added in 2.2.0

public @NonNull UiSelector instance(int instance)

Set the search criteria to match the widget by its instance number. The instance value must be 0 or greater, where the first instance is 0. For example, to simulate a user click on the third image that is enabled in a UI screen, you could specify a a search criteria where the instance is 2, the className matches the image widget class, and enabled is true. The code would look like this: new UiSelector().className("android.widget.ImageView") .enabled(true).instance(2);

Parameters
`int instance`	Value to match

Returns
`@NonNull UiSelector`	UiSelector with the specified search criteria

longClickable

Added in 2.2.0

public @NonNull UiSelector longClickable(boolean val)

Set the search criteria to match widgets that are long-clickable. Typically, using this search criteria alone is not useful. You should also include additional criteria, such as text, content-description, or the class name for a widget. If no other search criteria is specified, and there is more than one matching widget, the first widget in the tree is selected.

Parameters
`boolean val`	Value to match

Returns
`@NonNull UiSelector`	UiSelector with the specified search criteria

packageName

Added in 2.2.0

public @NonNull UiSelector packageName(@NonNull String name)

Set the search criteria to match the package name of the application that contains the widget.

Parameters
`@NonNull String name`	Value to match

Returns
`@NonNull UiSelector`	UiSelector with the specified search criteria

packageNameMatches

Added in 2.2.0

public @NonNull UiSelector packageNameMatches(@NonNull String regex)

Set the search criteria to match the package name of the application that contains the widget.

Parameters
`@NonNull String regex`	a regular expression

Returns
`@NonNull UiSelector`	UiSelector with the specified search criteria

resourceId

Added in 2.2.0

public @NonNull UiSelector resourceId(@NonNull String id)

Set the search criteria to match the given resource ID.

Parameters
`@NonNull String id`	Value to match

Returns
`@NonNull UiSelector`	UiSelector with the specified search criteria

resourceIdMatches

Added in 2.2.0

public @NonNull UiSelector resourceIdMatches(@NonNull String regex)

Set the search criteria to match the resource ID of the widget, using a regular expression.

Parameters
`@NonNull String regex`	a regular expression

Returns
`@NonNull UiSelector`	UiSelector with the specified search criteria

scrollable

Added in 2.2.0

public @NonNull UiSelector scrollable(boolean val)

Set the search criteria to match widgets that are scrollable. Typically, using this search criteria alone is not useful. You should also include additional criteria, such as text, content-description, or the class name for a widget. If no other search criteria is specified, and there is more than one matching widget, the first widget in the tree is selected.

Parameters
`boolean val`	Value to match

Returns
`@NonNull UiSelector`	UiSelector with the specified search criteria

selected

Added in 2.2.0

public @NonNull UiSelector selected(boolean val)

Set the search criteria to match widgets that are currently selected. Typically, using this search criteria alone is not useful. You should also include additional criteria, such as text, content-description, or the class name for a widget. If no other search criteria is specified, and there is more than one matching widget, the first widget in the tree is selected.

Parameters
`boolean val`	Value to match

Returns
`@NonNull UiSelector`	UiSelector with the specified search criteria

text

Added in 2.2.0

public @NonNull UiSelector text(@NonNull String text)

Set the search criteria to match the visible text displayed in a widget (for example, the text label to launch an app). The text for the element must match exactly with the string in your input argument. Matching is case-sensitive.

Parameters
`@NonNull String text`	Value to match

Returns
`@NonNull UiSelector`	UiSelector with the specified search criteria

textContains

Added in 2.2.0

public @NonNull UiSelector textContains(@NonNull String text)

Set the search criteria to match the visible text in a widget where the visible text must contain the string in your input argument. The matching is case-sensitive.

Parameters
`@NonNull String text`	Value to match

Returns
`@NonNull UiSelector`	UiSelector with the specified search criteria

textMatches

Added in 2.2.0

public @NonNull UiSelector textMatches(@NonNull String regex)

Set the search criteria to match the visible text displayed in a layout element, using a regular expression. The text in the widget must match exactly with the string in your input argument.

Parameters
`@NonNull String regex`	a regular expression

Returns
`@NonNull UiSelector`	UiSelector with the specified search criteria

textStartsWith

Added in 2.2.0

public @NonNull UiSelector textStartsWith(@NonNull String text)

Set the search criteria to match visible text in a widget that is prefixed by the text parameter. The matching is case-insensitive.

Parameters
`@NonNull String text`	Value to match

Returns
`@NonNull UiSelector`	UiSelector with the specified search criteria

toString

public String toString()

Protected methods

cloneSelector

Added in 2.2.0

protected @NonNull UiSelector cloneSelector()