UiCollection

UiCollection

Used to enumerate a container's user interface (UI) elements for the purpose of counting, or targeting a sub elements by a child's text or description.

Summary

Public Constructors
	UiCollection(UiSelector selector)

Public Methods
UiObject	getChildByDescription(UiSelector childPattern, String text) Searches for child UI element within the constraints of this `UiSelector` selector.
UiObject	getChildByInstance(UiSelector childPattern, int instance) Searches for child UI element within the constraints of this `UiSelector`.
UiObject	getChildByText(UiSelector childPattern, String text) Searches for child UI element within the constraints of this `UiSelector`.
int	getChildCount(UiSelector childPattern) Counts child UI element instances matching the `childPattern` argument.

[Expand]

Inherited Methods

From class com.android.uiautomator.core.UiObject

void	clearTextField() Clears the existing text contents in an editable field.
boolean	click() Performs a click at the center of the visible bounds of the UI element represented by this UiObject.
boolean	clickAndWaitForNewWindow(long timeout) Performs a click at the center of the visible bounds of the UI element represented by this UiObject and waits for window transitions.
boolean	clickAndWaitForNewWindow() See `clickAndWaitForNewWindow(long)` This method is intended to reliably wait for window transitions that would typically take longer than the usual default timeouts.
boolean	clickBottomRight() Clicks the bottom and right corner of the UI element
boolean	clickTopLeft() Clicks the top and left corner of the UI element
boolean	exists() Check if UI element exists.
Rect	getBounds() Returns the UI element's `bounds` property.
UiObject	getChild(UiSelector selector) Creates a new UiObject representing a child UI element of the element currently represented by this UiObject.
int	getChildCount() Counts the child UI elements immediately under the UI element currently represented by this UiObject.
String	getContentDescription() Reads the `content_desc` property of the UI element
UiObject	getFromParent(UiSelector selector) Creates a new UiObject representing a child UI element from the parent element currently represented by this object.
String	getPackageName() Reads the UI element's `package` property
final UiSelector	getSelector() Debugging helper.
String	getText() Reads the `text` property of the UI element
Rect	getVisibleBounds() Returns the visible bounds of the UI element.
boolean	isCheckable() Check if the UI element's `checkable` property is currently true
boolean	isChecked() Check if the UI element's `checked` property is currently true
boolean	isClickable() Check if the UI element's `clickable` property is currently true
boolean	isEnabled() Check if the UI element's `enabled` property is currently true
boolean	isFocusable() Check if the UI element's `focusable` property is currently true
boolean	isFocused() Check if the UI element's `focused` property is currently true
boolean	isLongClickable() Check if the UI element's `long-clickable` property is currently true
boolean	isScrollable() Check if the UI element's `scrollable` property is currently true
boolean	isSelected() Check if the UI element's `selected` property is currently true
boolean	longClick() Long clicks the center of the visible bounds of the UI element
boolean	longClickBottomRight() Long clicks bottom and right corner of the UI element
boolean	longClickTopLeft() Long clicks on the top and left corner of the UI element
boolean	setText(String text) Sets the text in an editable field, after clearing the field's content.
boolean	swipeDown(int steps) Perform the action on the UI element that is represented by this object, Also see #scrollToBeginning(int), #scrollToEnd(int), #scrollBackward(), #scrollForward().
boolean	swipeLeft(int steps) Perform the action on the UI element that is represented by this object.
boolean	swipeRight(int steps) Perform the action on the UI element that is represented by this object.
boolean	swipeUp(int steps) Perform the action on the UI element that is represented by this UiObject.
boolean	waitForExists(long timeout) Waits a specified length of time for a UI element to become visible.
boolean	waitUntilGone(long timeout) Waits a specified length of time for a UI element to become undetectable.

From class java.lang.Object

Public Constructors

public UiCollection (UiSelector selector)

Public Methods

public UiObject getChildByDescription (UiSelector childPattern, String text)

Searches for child UI element within the constraints of this UiSelector selector. It looks for any child matching the childPattern argument that has a child UI element anywhere within its sub hierarchy that has content-description text. The returned UiObject will point at the childPattern instance that matched the search and not at the identifying child element that matched the content description.

Parameters

childPattern	`UiSelector` selector of the child pattern to match and return
text	String of the identifying child contents of of the `childPattern`

Returns

UiObject pointing at and instance of childPattern

Throws

UiObjectNotFoundException

public UiObject getChildByInstance (UiSelector childPattern, int instance)

Searches for child UI element within the constraints of this UiSelector. It looks for any child matching the childPattern argument that has a child UI element anywhere within its sub hierarchy that is at the instance specified. The operation is performed only on the visible items and no scrolling is performed in this case.

Parameters

childPattern	`UiSelector` selector of the child pattern to match and return
instance	int the desired matched instance of this `childPattern`

Returns

UiObject pointing at and instance of childPattern

Throws

UiObjectNotFoundException

public UiObject getChildByText (UiSelector childPattern, String text)

Searches for child UI element within the constraints of this UiSelector selector. It looks for any child matching the childPattern argument that has a child UI element anywhere within its sub hierarchy that has a text attribute equal to text. The returned UiObject will point at the childPattern instance that matched the search and not at the identifying child element that matched the text attribute.

Parameters

childPattern	`UiSelector` selector of the child pattern to match and return
text	String of the identifying child contents of of the `childPattern`

Returns

UiObject pointing at and instance of childPattern

Throws

UiObjectNotFoundException

public int getChildCount (UiSelector childPattern)

Counts child UI element instances matching the childPattern argument. The method returns the number of matching UI elements that are currently visible. The count does not include items of a scrollable list that are off-screen.

Parameters

childPattern	a `UiSelector` that represents the matching child UI elements to count

Returns

the number of matched childPattern under the current UiCollection

Results

Summary

Public Constructors

public UiCollection (UiSelector selector)

Public Methods

public UiObject getChildByDescription (UiSelector childPattern, String text)

Parameters

Returns

Throws

public UiObject getChildByInstance (UiSelector childPattern, int instance)

Parameters

Returns

Throws

public UiObject getChildByText (UiSelector childPattern, String text)

Parameters

Returns

Throws

public int getChildCount (UiSelector childPattern)

Parameters

Returns