UiScrollable

public class UiScrollable
extends UiCollection

java.lang.Object
↳	android.support.test.uiautomator.UiObject
	↳	android.support.test.uiautomator.UiCollection
		↳	android.support.test.uiautomator.UiScrollable

UiScrollable是一个UiCollection并提供对可滚动布局元素中的项目搜索的支持。该类可以与水平或垂直可滚动控件一起使用。

Summary

Inherited constants

From class android.support.test.uiautomator.UiObject

Public constructors
`UiScrollable(UiSelector container)` 构造函数。

Public methods
`boolean`	`flingBackward()` 使用缺省步数（5）执行向后的投掷动作。
`boolean`	`flingForward()` 使用缺省步数（5）执行向前跳跃。
`boolean`	`flingToBeginning(int maxSwipes)` 执行滑动手势以到达可滚动布局元素的开始位置。
`boolean`	`flingToEnd(int maxSwipes)` 执行滑动手势以达到可滚动布局元素的末端。
`UiObject`	`getChildByDescription(UiSelector childPattern, String text)` 搜索当前可滚动容器中的子元素。
`UiObject`	`getChildByDescription(UiSelector childPattern, String text, boolean allowScrollSearch)` 搜索当前可滚动容器中的子元素。
`UiObject`	`getChildByInstance(UiSelector childPattern, int instance)` 在当前可滚动容器中搜索与您提供的选择器相匹配的子元素。
`UiObject`	`getChildByText(UiSelector childPattern, String text, boolean allowScrollSearch)` 搜索当前可滚动容器中的子元素。
`UiObject`	`getChildByText(UiSelector childPattern, String text)` 搜索当前可滚动容器中的子元素。
`int`	`getMaxSearchSwipes()` 获取执行滚动操作以搜索子元素时允许的最大滚动数量。
`double`	`getSwipeDeadZonePercentage()` 返回滑动时认为是非触摸区域的小部件大小的百分比。
`boolean`	`scrollBackward(int steps)` 执行向后滚动。
`boolean`	`scrollBackward()` 使用默认的滚动步数（55）执行向后滚动。
`boolean`	`scrollDescriptionIntoView(String text)` 在可滚动布局元素上执行向前滚动操作，直到找到内容描述，或直到刷卡尝试已用尽。
`boolean`	`scrollForward(int steps)` 执行向前滚动。
`boolean`	`scrollForward()` 使用默认的滚动步数（55）执行向前滚动。
`boolean`	`scrollIntoView(UiSelector selector)` 执行向前滚动操作以遍历可滚动布局元素，直到找到与选择器匹配的可见项目。
`boolean`	`scrollIntoView(UiObject obj)` 执行向前滚动操作以移动可滚动布局元素，直到找到与 `UiObject`匹配的可见项目。
`boolean`	`scrollTextIntoView(String text)` 在可滚动布局元素上执行向前滚动操作，直到您提供的文本可见为止，或者直到滑动尝试已用尽。
`boolean`	`scrollToBeginning(int maxSwipes)` 滚动到可滚动布局元素的开头。
`boolean`	`scrollToBeginning(int maxSwipes, int steps)` 滚动到可滚动布局元素的开头。
`boolean`	`scrollToEnd(int maxSwipes)` 滚动到可滚动布局元素的末尾。
`boolean`	`scrollToEnd(int maxSwipes, int steps)` 滚动到可滚动布局元素的末尾。
`UiScrollable`	`setAsHorizontalList()` 执行滚动操作时，将滑动的方向设置为水平。
`UiScrollable`	`setAsVerticalList()` 执行滚动操作时，将滑动的方向设置为垂直。
`UiScrollable`	`setMaxSearchSwipes(int swipes)` 设置在搜索子元素时执行滚动操作时允许的最大滚动数量。
`UiScrollable`	`setSwipeDeadZonePercentage(double swipeDeadZonePercentage)` 设置滑动时认为无触摸区域的小部件大小的百分比。

Protected methods
`boolean`	`exists(UiSelector selector)` 在执行滑动搜索时私下使用，以确定元素是否可见。

Inherited methods

From class android.support.test.uiautomator.UiCollection

From class android.support.test.uiautomator.UiObject

`void`	`clearTextField()` 清除可编辑字段中的现有文本内容。
`boolean`	`click()` 在由此UiObject表示的UI元素的可见边界的中心执行单击。
`boolean`	`clickAndWaitForNewWindow()` 等待通常需要比通常默认超时更长的窗口转换。
`boolean`	`clickAndWaitForNewWindow(long timeout)` 在由此UiObject表示的UI元素的可见边界的中心执行单击操作，并等待窗口转换。
`boolean`	`clickBottomRight()` 点击UI元素的右下角
`boolean`	`clickTopLeft()` 点击UI元素的左上角
`boolean`	`dragTo(UiObject destObj, int steps)` 将此对象拖到目标UiObject。
`boolean`	`dragTo(int destX, int destY, int steps)` 将该对象拖到任意坐标。
`boolean`	`exists()` 检查视图是否存在。
`AccessibilityNodeInfo`	`findAccessibilityNodeInfo(long timeout)` 通过使用此UiObject的选择器在可访问性层次结构中查找匹配的UI元素。
`Rect`	`getBounds()` 返回视图的 `bounds`属性。
`UiObject`	`getChild(UiSelector selector)` 为当前UiObject下的子视图创建一个新的UiObject。
`int`	`getChildCount()` 立即计算当前UiObject下的子视图。
`String`	`getClassName()` 检索UI元素的 `className`属性。
`String`	`getContentDescription()` 读取UI元素的 `content_desc`属性
`UiObject`	`getFromParent(UiSelector selector)` 相对于当前的UiObject，为同级视图或兄弟视图的子级创建新的UiObject。
`String`	`getPackageName()` 读取视图的 `package`属性
`final UiSelector`	`getSelector()` 调试助手。
`String`	`getText()` 读取UI元素的 `text`属性
`Rect`	`getVisibleBounds()` 返回视图的可见边界。
`boolean`	`isCheckable()` 检查UI元素的 `checkable`属性当前是否为真。
`boolean`	`isChecked()` 检查UI元素的 `checked`属性当前是否为真
`boolean`	`isClickable()` 检查UI元素的 `clickable`属性当前是否为真。
`boolean`	`isEnabled()` 检查UI元素的 `enabled`属性当前是否为真。
`boolean`	`isFocusable()` 检查UI元素的 `focusable`属性当前是否为真。
`boolean`	`isFocused()` 检查UI元素的 `focused`属性当前是否为true
`boolean`	`isLongClickable()` 检查视图的 `long-clickable`属性当前是否为真
`boolean`	`isScrollable()` 检查视图的 `scrollable`属性当前是否为真
`boolean`	`isSelected()` 检查UI元素的 `selected`属性当前是否为真。
`boolean`	`longClick()` 长按一下UI元素可见边界的中心
`boolean`	`longClickBottomRight()` 长按UI元素的右下角
`boolean`	`longClickTopLeft()` 长按一下UI元素的左上角
`boolean`	`performMultiPointerGesture(PointerCoords... touches)` 执行多点触控手势。
`boolean`	`performTwoPointerGesture(Point startPoint1, Point startPoint2, Point endPoint1, Point endPoint2, int steps)` 生成任意起点和终点的双指手势。
`boolean`	`pinchIn(int percent, int steps)` 执行一个双指针手势，每个指针从对角线向另一个对象移动，从边缘到这个UiObject的中心。
`boolean`	`pinchOut(int percent, int steps)` 执行一个双指针手势，每个指针在对角线上相对移动，从中心向外朝向此UiObject的边缘。
`boolean`	`setText(String text)` 清除字段内容后，在可编辑字段中设置文本。
`boolean`	`swipeDown(int steps)` 对UiObject执行滑动操作。
`boolean`	`swipeLeft(int steps)` 在UiObject上执行滑动左操作。
`boolean`	`swipeRight(int steps)` 对UiObject执行滑动右键操作。
`boolean`	`swipeUp(int steps)` 对UiObject执行滑动操作。
`boolean`	`waitForExists(long timeout)` 等待指定的时间长度以使视图变为可见。
`boolean`	`waitUntilGone(long timeout)` 等待指定的时间长度以使视图变得无法检测。

From class java.lang.Object

Public constructors

UiScrollable

UiScrollable (UiSelector container)

构造函数。

Parameters
`container`	`UiSelector`: a `UiSelector` selector to identify the scrollable layout element.

Public methods

flingBackward

boolean flingBackward ()

使用缺省步数（5）执行向后的投掷动作。如果滑动方向设置为垂直，则滑动将从上到下执行。如果滑动方向设置为水平，则滑动将从左到右进行。确保考虑使用从阿拉伯语和希伯来语等右向左语言配置的设备。

Returns
`boolean`	true if scrolled, and false if can't scroll anymore

Throws
`UiObjectNotFoundException`

flingForward

boolean flingForward ()

使用缺省步数（5）执行向前跳跃。如果滑动方向设置为垂直，则滑动将从下到上执行。如果滑动方向设置为水平，则滑动将从右向左执行。确保考虑使用从阿拉伯语和希伯来语等右向左语言配置的设备。

Returns
`boolean`	true if scrolled, false if can't scroll anymore

Throws
`UiObjectNotFoundException`

flingToBeginning

boolean flingToBeginning (int maxSwipes)

执行滑动手势以到达可滚动布局元素的开始位置。在垂直控件的情况下，开始位置可以在最顶端，或者在水平控件的最左边。确保考虑使用从阿拉伯语和希伯来语等右向左语言配置的设备。

Returns
`boolean`	true on scrolled else false

Throws
`UiObjectNotFoundException`

flingToEnd

boolean flingToEnd (int maxSwipes)

执行滑动手势以达到可滚动布局元素的末端。在垂直控制的情况下，结束可以位于最底部的边缘，或者水平控制的最右边缘。确保考虑使用从阿拉伯语和希伯来语等右向左语言配置的设备。

Returns
`boolean`	true on scrolled, else false

Throws
`UiObjectNotFoundException`

getChildByDescription

UiObject getChildByDescription (UiSelector childPattern, 
                String text)

搜索当前可滚动容器中的子元素。搜索首先查找与您提供的选择器相匹配的子元素，然后在其子元素中查找content-description。如果两个搜索条件都满足，则该方法返回表示与选择器匹配的元素（而不是包含content-description的子元素中的子元素）的{@ link UiObject}。默认情况下，此方法执行滚动搜索。见getChildByDescription(UiSelector, String, boolean)

Parameters
`childPattern`	`UiSelector`: `UiSelector` for a child in a scollable layout element
`text`	`String`: Content-description to find in the children of the `childPattern` match

Returns
`UiObject`	`UiObject` representing the child element that matches the search conditions

Throws
	UiObjectNotFoundException
`UiObjectNotFoundException`

getChildByDescription

UiObject getChildByDescription (UiSelector childPattern, 
                String text, 
                boolean allowScrollSearch)

搜索当前可滚动容器中的子元素。搜索首先查找与您提供的选择器相匹配的子元素，然后在其子元素中查找content-description。如果两个搜索条件都满足，则该方法返回表示与选择器匹配的元素（而不是包含content-description的子元素中的子元素）的{@ link UiObject}。

Parameters
`childPattern`	`UiSelector`: `UiSelector` for a child in a scollable layout element
`text`	`String`: Content-description to find in the children of the `childPattern` match (may be a partial match)
`allowScrollSearch`	`boolean`: set to true if scrolling is allowed

Returns
`UiObject`	`UiObject` representing the child element that matches the search conditions

Throws
	UiObjectNotFoundException
`UiObjectNotFoundException`

getChildByInstance

UiObject getChildByInstance (UiSelector childPattern, 
                int instance)

在当前可滚动容器中搜索与您提供的选择器相匹配的子元素。搜索没有滚动，只在可见元素上执行。

Parameters
`childPattern`	`UiSelector`: `UiSelector` for a child in a scollable layout element
`instance`	`int`: int number representing the occurance of a `childPattern` match

Returns
`UiObject`	`UiObject` representing the child element that matches the search conditions

Throws
`UiObjectNotFoundException`

getChildByText

UiObject getChildByText (UiSelector childPattern, 
                String text, 
                boolean allowScrollSearch)

搜索当前可滚动容器中的子元素。搜索首先查找与您提供的选择器相匹配的子元素，然后在其子元素中查找文本。如果两个搜索条件都满足，则该方法返回表示与选择器匹配的元素（而不是包含文本的子层次结构中的子元素）的{@ link UiObject}。

Parameters
`childPattern`	`UiSelector`: `UiSelector` selector for a child in a scrollable layout element
`text`	`String`: String to find in the children of the `childPattern` match
`allowScrollSearch`	`boolean`: set to true if scrolling is allowed

Returns
`UiObject`	`UiObject` representing the child element that matches the search conditions

Throws
	UiObjectNotFoundException
`UiObjectNotFoundException`

getChildByText

UiObject getChildByText (UiSelector childPattern, 
                String text)

搜索当前可滚动容器中的子元素。搜索首先查找与您提供的选择器相匹配的子元素，然后在其子元素中查找文本。如果两个搜索条件都满足，则该方法返回表示与选择器匹配的元素（而不是包含文本的子层次结构中的子元素）的{@ link UiObject}。默认情况下，此方法执行滚动搜索。见getChildByText(UiSelector, String, boolean)

Parameters
`childPattern`	`UiSelector`: `UiSelector` selector for a child in a scrollable layout element
`text`	`String`: String to find in the children of the `childPattern` match

Returns
`UiObject`	`UiObject` representing the child element that matches the search conditions

Throws
	UiObjectNotFoundException
`UiObjectNotFoundException`

getMaxSearchSwipes

int getMaxSearchSwipes ()

获取执行滚动操作以搜索子元素时允许的最大滚动数量。见getChildByDescription(UiSelector, String)和getChildByText(UiSelector, String) 。

Returns
`int`	max the number of search swipes to perform until giving up

getSwipeDeadZonePercentage

double getSwipeDeadZonePercentage ()

返回滑动时认为是非触摸区域的小部件大小的百分比。非触摸区域设置为小部件总宽度或高度的百分比，表示小部件的可滑动区域周围的边距。滑动必须在这个边界内开始和结束。如果在太靠近边缘的位置开始滑动，那么这一点很重要。默认值是任一边的10％。

Returns
`double`	a value between 0 and 1

scrollBackward

boolean scrollBackward (int steps)

执行向后滚动。如果滑动方向设置为垂直，则滑动将从顶部到底部执行。如果滑动方向设置为水平，则滑动将从左到右进行。确保考虑使用从阿拉伯语和希伯来语等右向左语言配置的设备。

Parameters
`steps`	`int`: number of steps. Use this to control the speed of the scroll action.

Returns
`boolean`	true if scrolled, false if can't scroll anymore

Throws
`UiObjectNotFoundException`

scrollBackward

boolean scrollBackward ()

使用默认的滚动步数（55）执行向后滚动。如果滑动方向设置为垂直，则滑动将从顶部到底部执行。如果滑动方向设置为水平，则滑动将从左到右进行。确保考虑使用从阿拉伯语和希伯来语等右向左语言配置的设备。

Returns
`boolean`	true if scrolled, and false if can't scroll anymore

Throws
`UiObjectNotFoundException`

scrollDescriptionIntoView

boolean scrollDescriptionIntoView (String text)

在可滚动布局元素上执行向前滚动操作，直到找到内容描述，或直到刷卡尝试已用尽。见setMaxSearchSwipes(int)

Parameters
`text`	`String`: content-description to find within the contents of this scrollable layout element.

Returns
`boolean`	true if item is found; else, false

Throws
`UiObjectNotFoundException`

scrollForward

boolean scrollForward (int steps)

执行向前滚动。如果滑动方向设置为垂直，则滑动将从下到上执行。如果滑动方向设置为水平，则滑动将从右向左执行。确保考虑使用从阿拉伯语和希伯来语等右向左语言配置的设备。

Parameters
`steps`	`int`: number of steps. Use this to control the speed of the scroll action

Returns
`boolean`	true if scrolled, false if can't scroll anymore

Throws
`UiObjectNotFoundException`

scrollForward

boolean scrollForward ()

使用默认的滚动步数（55）执行向前滚动。如果滑动方向设置为垂直，则滑动将从下到上执行。如果滑动方向设置为水平，则滑动将从右向左执行。确保考虑使用从阿拉伯语和希伯来语等右向左语言配置的设备。

Returns
`boolean`	true if scrolled, false if can't scroll anymore

Throws
`UiObjectNotFoundException`

scrollIntoView

boolean scrollIntoView (UiSelector selector)

执行向前滚动操作以遍历可滚动布局元素，直到找到与选择器匹配的可见项目。见scrollDescriptionIntoView(String)和scrollTextIntoView(String) 。

Parameters
`selector`	`UiSelector`: `UiSelector` selector

Returns
`boolean`	true if the item was found and now is in view; else, false

Throws
`UiObjectNotFoundException`

scrollIntoView

boolean scrollIntoView (UiObject obj)

执行向前滚动操作以遍历可滚动布局元素，直到找到与 UiObject匹配的可见项目。

Parameters
`obj`	`UiObject`: `UiObject`

Returns
`boolean`	true if the item was found and now is in view else false

Throws
`UiObjectNotFoundException`

scrollTextIntoView

boolean scrollTextIntoView (String text)

在可滚动布局元素上执行向前滚动操作，直到您提供的文本可见为止，或者直到滑动尝试已用尽。见setMaxSearchSwipes(int)

Parameters
`text`	`String`: test to look for

Returns
`boolean`	true if item is found; else, false

Throws
`UiObjectNotFoundException`

scrollToBeginning

boolean scrollToBeginning (int maxSwipes)

滚动到可滚动布局元素的开头。在垂直控件的情况下，开始位置可以在最顶端，或者在水平控件的最左边。确保考虑使用从阿拉伯语和希伯来语等右向左语言配置的设备。

Returns
`boolean`	true on scrolled else false

Throws
`UiObjectNotFoundException`

scrollToBeginning

boolean scrollToBeginning (int maxSwipes, 
                int steps)

Parameters
`maxSwipes`	`int`
`steps`	`int`: use steps to control the speed, so that it may be a scroll, or fling

Returns
`boolean`	true on scrolled else false

Throws
`UiObjectNotFoundException`

scrollToEnd

boolean scrollToEnd (int maxSwipes)

滚动到可滚动布局元素的末尾。在垂直控制的情况下，结束可以位于最底部的边缘，或者水平控制的最右边缘。确保考虑使用从阿拉伯语和希伯来语等右向左语言配置的设备。

Returns
`boolean`	true on scrolled, else false

Throws
`UiObjectNotFoundException`

scrollToEnd

boolean scrollToEnd (int maxSwipes, 
                int steps)

Parameters
`maxSwipes`	`int`
`steps`	`int`: use steps to control the speed, so that it may be a scroll, or fling

Returns
`boolean`	true on scrolled else false

Throws
`UiObjectNotFoundException`

setAsHorizontalList

UiScrollable setAsHorizontalList ()

执行滚动操作时，将滑动的方向设置为水平。

Returns
`UiScrollable`	reference to itself

setAsVerticalList

UiScrollable setAsVerticalList ()

执行滚动操作时，将滑动的方向设置为垂直。

Returns
`UiScrollable`	reference to itself

setMaxSearchSwipes

UiScrollable setMaxSearchSwipes (int swipes)

设置在搜索子元素时执行滚动操作时允许的最大滚动数量。请参阅getChildByDescription(UiSelector, String)和getChildByText(UiSelector, String) 。

Parameters
`swipes`	`int`: the number of search swipes to perform until giving up

Returns
`UiScrollable`	reference to itself

setSwipeDeadZonePercentage

UiScrollable setSwipeDeadZonePercentage (double swipeDeadZonePercentage)

设置滑动时认为无触摸区域的小部件大小的百分比。非触摸区域设置为小部件总宽度或高度的百分比，表示小部件的可滑动区域周围的边距。滑动必须始终在该边界内开始和结束。如果在太靠近边缘的位置开始滑动，那么这一点很重要。默认值是任一边的10％。

Parameters
`swipeDeadZonePercentage`	`double`: is a value between 0 and 1

Returns
`UiScrollable`	reference to itself

Protected methods

exists

boolean exists (UiSelector selector)

在执行滑动搜索时私下使用，以确定元素是否可见。

Returns
`boolean`	true if found else false

UiScrollable

Summary

Inherited constants

Public constructors

Public methods

Protected methods

Inherited methods

Public constructors

UiScrollable

Public methods

flingBackward

flingForward

flingToBeginning

flingToEnd

getChildByDescription

getChildByDescription

getChildByInstance

getChildByText

getChildByText

getMaxSearchSwipes

getSwipeDeadZonePercentage

scrollBackward

scrollBackward

scrollDescriptionIntoView

scrollForward

scrollForward

scrollIntoView

scrollIntoView

scrollTextIntoView

scrollToBeginning

scrollToBeginning

scrollToEnd

scrollToEnd

setAsHorizontalList

setAsVerticalList

setMaxSearchSwipes

setSwipeDeadZonePercentage

Protected methods

exists

Interfaces

Classes

Enums

Exceptions