By

Artifact: androidx.test.uiautomator:uiautomator

Added in 2.2.0

Kotlin |Java

class By

By is a utility class which enables the creation of BySelectors in a concise manner.

Its primary function is to provide static factory methods for constructing BySelectors using a shortened syntax. For example, you would use findObject(By.text("foo")) rather than findObject(new BySelector().text("foo")) to select UI elements with the text value "foo".

Summary

Nested types
`class By.Window` This nested class is used to create a `ByWindowSelector` that matches a window.

Public functions
`java-static BySelector`	`checkable(isCheckable: Boolean)` Constructs a new `BySelector` and sets the checkable criteria.
`java-static BySelector`	`checked(isChecked: Boolean)` Constructs a new `BySelector` and sets the checked criteria.
`java-static BySelector`	`clazz(className: Pattern)` Constructs a new `BySelector` and sets the class name criteria.
`java-static BySelector`	`clazz(className: String)` Constructs a new `BySelector` and sets the class name criteria.
`java-static BySelector`	`clazz(clazz: Class)` Constructs a new `BySelector` and sets the class name criteria.
`java-static BySelector`	`clazz(packageName: String, className: String)` Constructs a new `BySelector` and sets the class name criteria.
`java-static BySelector`	`clickable(isClickable: Boolean)` Constructs a new `BySelector` and sets the clickable criteria.
`java-static BySelector`	`copy(original: BySelector)` Constructs a new `BySelector` and copies the criteria from `original`.
`java-static BySelector`	`depth(depth: Int)` Constructs a new `BySelector` and sets the depth criteria.
`java-static BySelector`	`desc(contentDescription: Pattern)` Constructs a new `BySelector` and sets the content description criteria.
`java-static BySelector`	`desc(contentDescription: String)` Constructs a new `BySelector` and sets the content description criteria.
`java-static BySelector`	`descContains(substring: String)` Constructs a new `BySelector` and sets the content description criteria.
`java-static BySelector`	`descEndsWith(suffix: String)` Constructs a new `BySelector` and sets the content description criteria.
`java-static BySelector`	`descStartsWith(prefix: String)` Constructs a new `BySelector` and sets the content description criteria.
`java-static BySelector`	`@RequiresApi(value = 30) displayId(displayId: Int)` Constructs a new `BySelector` and sets the display ID criteria.
`java-static BySelector`	`enabled(isEnabled: Boolean)` Constructs a new `BySelector` and sets the enabled criteria.
`java-static BySelector`	`focusable(isFocusable: Boolean)` Constructs a new `BySelector` and sets the focusable criteria.
`java-static BySelector`	`focused(isFocused: Boolean)` Constructs a new `BySelector` and sets the focused criteria.
`java-static BySelector`	`hasAncestor(ancestorSelector: BySelector)` Constructs a new `BySelector` and adds an ancestor selector criteria.
`java-static BySelector`	`hasAncestor( ancestorSelector: BySelector, maxAncestorDistance: @IntRange(from = 1) Int )` Constructs a new `BySelector` and adds an ancestor selector criteria.
`java-static BySelector`	`hasChild(childSelector: BySelector)` Constructs a new `BySelector` and adds a child selector criteria.
`java-static BySelector`	`hasDescendant(descendantSelector: BySelector)` Constructs a new `BySelector` and adds a descendant selector criteria.
`java-static BySelector`	`hasDescendant(descendantSelector: BySelector, maxDepth: Int)` Constructs a new `BySelector` and adds a descendant selector criteria.
`java-static BySelector`	`hasParent(parentSelector: BySelector)` Constructs a new `BySelector` and adds a parent selector criteria.
`java-static BySelector`	`@RequiresApi(value = 26) hint(hint: String)` Constructs a new `BySelector` and sets the hint value criteria.
`java-static BySelector`	`@RequiresApi(value = 26) hint(regex: Pattern)` Constructs a new `BySelector` and sets the hint value criteria.
`java-static BySelector`	`@RequiresApi(value = 26) hintContains(substring: String)` Constructs a new `BySelector` and sets the hint value criteria.
`java-static BySelector`	`@RequiresApi(value = 26) hintEndsWith(suffix: String)` Constructs a new `BySelector` and sets the hint value criteria.
`java-static BySelector`	`@RequiresApi(value = 26) hintStartsWith(prefix: String)` Constructs a new `BySelector` and sets the hint value criteria.
`java-static BySelector`	`longClickable(isLongClickable: Boolean)` Constructs a new `BySelector` and sets the long clickable criteria.
`java-static BySelector`	`pkg(applicationPackage: Pattern)` Constructs a new `BySelector` and sets the application package name criteria.
`java-static BySelector`	`pkg(applicationPackage: String)` Constructs a new `BySelector` and sets the application package name criteria.
`java-static BySelector`	`res(resourceName: Pattern)` Constructs a new `BySelector` and sets the resource id criteria.
`java-static BySelector`	`res(resourceName: String)` Constructs a new `BySelector` and sets the resource name criteria.
`java-static BySelector`	`res(resourcePackage: String, resourceId: String)` Constructs a new `BySelector` and sets the resource name criteria.
`java-static BySelector`	`scrollable(isScrollable: Boolean)` Constructs a new `BySelector` and sets the scrollable criteria.
`java-static BySelector`	`selected(isSelected: Boolean)` Constructs a new `BySelector` and sets the selected criteria.
`java-static BySelector`	`text(regex: Pattern)` Constructs a new `BySelector` and sets the text value criteria.
`java-static BySelector`	`text(text: String)` Constructs a new `BySelector` and sets the text value criteria.
`java-static BySelector`	`textContains(substring: String)` Constructs a new `BySelector` and sets the text value criteria.
`java-static BySelector`	`textEndsWith(suffix: String)` Constructs a new `BySelector` and sets the text value criteria.
`java-static BySelector`	`textStartsWith(prefix: String)` Constructs a new `BySelector` and sets the text value criteria.

Public functions

checkable

Added in 2.2.0

java-static fun checkable(isCheckable: Boolean): BySelector

Constructs a new BySelector and sets the checkable criteria.

See also
`checkable`	BySelector.checkable(boolean)

checked

Added in 2.2.0

java-static fun checked(isChecked: Boolean): BySelector

Constructs a new BySelector and sets the checked criteria.

See also
`checked`	BySelector.checked(boolean)

clazz

Added in 2.2.0

java-static fun clazz(className: Pattern): BySelector

Constructs a new BySelector and sets the class name criteria.

See also
`clazz`	BySelector.clazz(Pattern)

clazz

Added in 2.2.0

java-static fun clazz(className: String): BySelector

Constructs a new BySelector and sets the class name criteria.

See also
`clazz`	BySelector.clazz(String)

clazz

Added in 2.2.0

java-static fun clazz(clazz: Class): BySelector

Constructs a new BySelector and sets the class name criteria.

See also
`clazz`	BySelector.clazz(Class)

clazz

Added in 2.2.0

java-static fun clazz(packageName: String, className: String): BySelector

Constructs a new BySelector and sets the class name criteria.

See also
`clazz`	BySelector.clazz(String, String)

clickable

Added in 2.2.0

java-static fun clickable(isClickable: Boolean): BySelector

Constructs a new BySelector and sets the clickable criteria.

See also
`clickable`	BySelector.clickable(boolean)

copy

Added in 2.2.0

java-static fun copy(original: BySelector): BySelector

Constructs a new BySelector and copies the criteria from original.

depth

Added in 2.2.0

java-static fun depth(depth: Int): BySelector

Constructs a new BySelector and sets the depth criteria.