page.title=UiScrollable
parent.title=uiautomator
parent.link=index.html
@jd:body
<style>
h4.jd-details-title {background-color: #DEE8F1;}
</style>
<p>UiScrollable is a <code><a href="UiCollection.html">UiCollection</a></code> and provides support for searching for items in a
scrollable user interface (UI) elements. This class can be used with horizontally or vertically scrollable controls..
</p>
<div class="jd-descr">
<h2>Summary</h2>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<table id="pubctors" class="jd-sumtable"><tr><th colspan="12">Public Constructors</th></tr>
<tr class="api" >
<td class="jd-typecol">
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="#UiScrollable(com.android.uiautomator.core.UiSelector)">UiScrollable</a></span>(<a href="UiSelector.html">UiSelector</a> container)
<div class="jd-descrdiv">UiScrollable is a <code><a href="UiCollection.html">UiCollection</a></code> and as such requires a <code><a href="UiSelector.html">UiSelector</a></code> to
identify the container UI element of the scrollable collection.</div>
</td></tr>
</table>
<!-- ========== METHOD SUMMARY =========== -->
<table id="pubmethods" class="jd-sumtable"><tr><th colspan="12">Public Methods</th></tr>
<tr class="api" >
<td class="jd-typecol">
boolean
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="#flingBackward()">flingBackward</a></span>()
<div class="jd-descrdiv">See <code><a href="#scrollBackward(int)">scrollBackward(int)</a></code></div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
boolean
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="#flingForward()">flingForward</a></span>()
<div class="jd-descrdiv">A convenience version of <code><a href="#scrollForward(int)">scrollForward(int)</a></code>, performs a fling</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
boolean
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="#flingToBeginning(int)">flingToBeginning</a></span>(int maxSwipes)
<div class="jd-descrdiv">See <code><a href="#scrollToBeginning(int, int)">scrollToBeginning(int, int)</a></code></div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
boolean
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="#flingToEnd(int)">flingToEnd</a></span>(int maxSwipes)
<div class="jd-descrdiv">See <code><a href="#scrollToEnd(int, int)">scrollToEnd(int, int)</a></code></div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
<a href="UiObject.html">UiObject</a>
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="#getChildByDescription(com.android.uiautomator.core.UiSelector, java.lang.String, boolean)">getChildByDescription</a></span>(<a href="UiSelector.html">UiSelector</a> childPattern, String text, boolean allowScrollSearch)
<div class="jd-descrdiv">See <code><a href="#getChildByDescription(com.android.uiautomator.core.UiSelector, java.lang.String)">getChildByDescription(UiSelector, String)</a></code></div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
<a href="UiObject.html">UiObject</a>
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="#getChildByDescription(com.android.uiautomator.core.UiSelector, java.lang.String)">getChildByDescription</a></span>(<a href="UiSelector.html">UiSelector</a> childPattern, String text)
<div class="jd-descrdiv">Searches for child UI element within the constraints of this UiScrollable <code><a href="UiSelector.html">UiSelector</a></code>
container.</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
<a href="UiObject.html">UiObject</a>
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="#getChildByInstance(com.android.uiautomator.core.UiSelector, int)">getChildByInstance</a></span>(<a href="UiSelector.html">UiSelector</a> childPattern, int instance)
<div class="jd-descrdiv">Searches for child UI element within the constraints of this UiScrollable <code><a href="UiSelector.html">UiSelector</a></code>
selector.</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
<a href="UiObject.html">UiObject</a>
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="#getChildByText(com.android.uiautomator.core.UiSelector, java.lang.String, boolean)">getChildByText</a></span>(<a href="UiSelector.html">UiSelector</a> childPattern, String text, boolean allowScrollSearch)
<div class="jd-descrdiv">See <code><a href="#getChildByText(com.android.uiautomator.core.UiSelector, java.lang.String)">getChildByText(UiSelector, String)</a></code></div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
<a href="UiObject.html">UiObject</a>
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="#getChildByText(com.android.uiautomator.core.UiSelector, java.lang.String)">getChildByText</a></span>(<a href="UiSelector.html">UiSelector</a> childPattern, String text)
<div class="jd-descrdiv">Searches for child UI element within the constraints of this UiScrollable <code><a href="UiSelector.html">UiSelector</a></code>
container.</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
int
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="#getMaxSearchSwipes()">getMaxSearchSwipes</a></span>()
<div class="jd-descrdiv">#getChildByDescription(String, boolean) and #getChildByText(String, boolean)
use an arguments that specifies if scrolling is allowed while searching for the UI element.</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
double
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="#getSwipeDeadZonePercentage()">getSwipeDeadZonePercentage</a></span>()
<div class="jd-descrdiv">Returns the percentage of a widget's size that's considered as a no touch zone when swiping.</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
boolean
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="#scrollBackward(int)">scrollBackward</a></span>(int steps)
<div class="jd-descrdiv">Perform a scroll backward.</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
boolean
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="#scrollBackward()">scrollBackward</a></span>()
<div class="jd-descrdiv">See <code><a href="#scrollBackward(int)">scrollBackward(int)</a></code></div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
boolean
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="#scrollDescriptionIntoView(java.lang.String)">scrollDescriptionIntoView</a></span>(String text)
<div class="jd-descrdiv">Performs a swipe Up on the UI element until the requested content-description
is visible or until swipe attempts have been exhausted.</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
boolean
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="#scrollForward()">scrollForward</a></span>()
<div class="jd-descrdiv">A convenience version of <code><a href="#scrollForward(int)">scrollForward(int)</a></code>, performs a regular scroll</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
boolean
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="#scrollForward(int)">scrollForward</a></span>(int steps)
<div class="jd-descrdiv">Perform a scroll forward.</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
boolean
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="#scrollIntoView(com.android.uiautomator.core.UiSelector)">scrollIntoView</a></span>(<a href="UiSelector.html">UiSelector</a> selector)
<div class="jd-descrdiv">Perform a scroll search for a UI element matching the <code><a href="UiSelector.html">UiSelector</a></code> selector argument.</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
boolean
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="#scrollTextIntoView(java.lang.String)">scrollTextIntoView</a></span>(String text)
<div class="jd-descrdiv">Performs a swipe up on the UI element until the requested text is visible
or until swipe attempts have been exhausted.</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
boolean
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="#scrollToBeginning(int)">scrollToBeginning</a></span>(int maxSwipes)
<div class="jd-descrdiv">See <code><a href="#scrollToBeginning(int, int)">scrollToBeginning(int, int)</a></code></div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
boolean
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="#scrollToBeginning(int, int)">scrollToBeginning</a></span>(int maxSwipes, int steps)
<div class="jd-descrdiv">Scrolls to the beginning of a scrollable UI element.</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
boolean
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="#scrollToEnd(int, int)">scrollToEnd</a></span>(int maxSwipes, int steps)
<div class="jd-descrdiv">Scrolls to the end of a scrollable UI element.</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
boolean
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="#scrollToEnd(int)">scrollToEnd</a></span>(int maxSwipes)
<div class="jd-descrdiv">See {@link UiScrollable#scrollToEnd(int, int)</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
void
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="#setAsHorizontalList()">setAsHorizontalList</a></span>()
<div class="jd-descrdiv">Set the direction of swipes when performing scroll search
</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
void
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="#setAsVerticalList()">setAsVerticalList</a></span>()
<div class="jd-descrdiv">Set the direction of swipes when performing scroll search
</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
void
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="#setMaxSearchSwipes(int)">setMaxSearchSwipes</a></span>(int swipes)
<div class="jd-descrdiv">#getChildByDescription(String, boolean) and #getChildByText(String, boolean)
use an arguments that specifies if scrolling is allowed while searching for the UI element.</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
void
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="#setSwipeDeadZonePercentage(double)">setSwipeDeadZonePercentage</a></span>(double swipeDeadZonePercentage)
<div class="jd-descrdiv">Sets the percentage of a widget's size that's considered as a no touch zone when swiping.</div>
</td></tr>
</table>
<!-- ========== METHOD SUMMARY =========== -->
<table id="inhmethods" class="jd-sumtable"><tr><th>
<a href="#" class="toggle-all" onclick="return toggleAllInherited(this, null)">[Expand]</a>
<div style="clear:left;">Inherited Methods</div></th></tr>
<tr class="api apilevel-" >
<td colspan="12">
<a href="#" onclick="return toggleInherited(this, null)" id="inherited-methods-com.android.uiautomator.core.UiCollection" class="jd-expando-trigger closed"
><img id="inherited-methods-com.android.uiautomator.core.UiCollection-trigger"
src="../../../../../assets/images/triangle-closed.png"
class="jd-expando-trigger-img" /></a>
From class
<a href="UiCollection.html">com.android.uiautomator.core.UiCollection</a>
<div id="inherited-methods-com.android.uiautomator.core.UiCollection">
<div id="inherited-methods-com.android.uiautomator.core.UiCollection-list"
class="jd-inheritedlinks">
</div>
<div id="inherited-methods-com.android.uiautomator.core.UiCollection-summary" style="display: none;">
<table class="jd-sumtable-expando">
<tr class="api" >
<td class="jd-typecol">
<a href="UiObject.html">UiObject</a>
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="UiCollection.html#getChildByDescription(com.android.uiautomator.core.UiSelector, java.lang.String)">getChildByDescription</a></span>(<a href="UiSelector.html">UiSelector</a> childPattern, String text)
<div class="jd-descrdiv">Searches for child UI element within the constraints of this UiCollection <code><a href="UiSelector.html">UiSelector</a></code>
selector.</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
<a href="UiObject.html">UiObject</a>
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="UiCollection.html#getChildByInstance(com.android.uiautomator.core.UiSelector, int)">getChildByInstance</a></span>(<a href="UiSelector.html">UiSelector</a> childPattern, int instance)
<div class="jd-descrdiv">Searches for child UI element within the constraints of this UiCollection <code><a href="UiSelector.html">UiSelector</a></code>
selector.</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
<a href="UiObject.html">UiObject</a>
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="UiCollection.html#getChildByText(com.android.uiautomator.core.UiSelector, java.lang.String)">getChildByText</a></span>(<a href="UiSelector.html">UiSelector</a> childPattern, String text)
<div class="jd-descrdiv">Searches for child UI element within the constraints of this UiCollection <code><a href="UiSelector.html">UiSelector</a></code>
selector.</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
int
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="UiCollection.html#getChildCount(com.android.uiautomator.core.UiSelector)">getChildCount</a></span>(<a href="UiSelector.html">UiSelector</a> childPattern)
<div class="jd-descrdiv">Counts child UI element instances matching the <code>childPattern</code>
argument.</div>
</td></tr>
</table>
</div>
</div>
</td></tr>
<tr class="api apilevel-" >
<td colspan="12">
<a href="#" onclick="return toggleInherited(this, null)" id="inherited-methods-com.android.uiautomator.core.UiObject" class="jd-expando-trigger closed"
><img id="inherited-methods-com.android.uiautomator.core.UiObject-trigger"
src="../../../../../assets/images/triangle-closed.png"
class="jd-expando-trigger-img" /></a>
From class
<a href="UiObject.html">com.android.uiautomator.core.UiObject</a>
<div id="inherited-methods-com.android.uiautomator.core.UiObject">
<div id="inherited-methods-com.android.uiautomator.core.UiObject-list"
class="jd-inheritedlinks">
</div>
<div id="inherited-methods-com.android.uiautomator.core.UiObject-summary" style="display: none;">
<table class="jd-sumtable-expando">
<tr class="api" >
<td class="jd-typecol">
void
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="UiObject.html#clearTextField()">clearTextField</a></span>()
<div class="jd-descrdiv">Clears the existing text contents in an editable field.</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
boolean
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="UiObject.html#click()">click</a></span>()
<div class="jd-descrdiv">Performs a click at the center of the visible bounds of the UI element represented
by this UiObject.</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
boolean
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="UiObject.html#clickAndWaitForNewWindow(long)">clickAndWaitForNewWindow</a></span>(long timeout)
<div class="jd-descrdiv">Performs a click at the center of the visible bounds of the UI element represented
by this UiObject and waits for window transitions.</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
boolean
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="UiObject.html#clickAndWaitForNewWindow()">clickAndWaitForNewWindow</a></span>()
<div class="jd-descrdiv">See <code><a href="UiObject.html#clickAndWaitForNewWindow(long)">clickAndWaitForNewWindow(long)</a></code>
This method is intended to reliably wait for window transitions that would typically take
longer than the usual default timeouts.</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
boolean
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="UiObject.html#clickBottomRight()">clickBottomRight</a></span>()
<div class="jd-descrdiv">Clicks the bottom and right corner of the UI element</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
boolean
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="UiObject.html#clickTopLeft()">clickTopLeft</a></span>()
<div class="jd-descrdiv">Clicks the top and left corner of the UI element</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
boolean
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="UiObject.html#exists()">exists</a></span>()
<div class="jd-descrdiv">Check if UI element exists.</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
Rect
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="UiObject.html#getBounds()">getBounds</a></span>()
<div class="jd-descrdiv">Returns the UI element's <code>bounds</code> property.</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
<a href="UiObject.html">UiObject</a>
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="UiObject.html#getChild(com.android.uiautomator.core.UiSelector)">getChild</a></span>(<a href="UiSelector.html">UiSelector</a> selector)
<div class="jd-descrdiv">Creates a new UiObject representing a child UI element of the element currently represented
by this UiObject.</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
int
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="UiObject.html#getChildCount()">getChildCount</a></span>()
<div class="jd-descrdiv">Counts the child UI elements immediately under the UI element currently represented by
this UiObject.</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
String
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="UiObject.html#getContentDescription()">getContentDescription</a></span>()
<div class="jd-descrdiv">Reads the <code>content_desc</code> property of the UI element</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
<a href="UiObject.html">UiObject</a>
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="UiObject.html#getFromParent(com.android.uiautomator.core.UiSelector)">getFromParent</a></span>(<a href="UiSelector.html">UiSelector</a> selector)
<div class="jd-descrdiv">Creates a new UiObject representing a child UI element from the parent element currently
represented by this object.</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
String
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="UiObject.html#getPackageName()">getPackageName</a></span>()
<div class="jd-descrdiv">Reads the UI element's <code>package</code> property</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
final
<a href="UiSelector.html">UiSelector</a>
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="UiObject.html#getSelector()">getSelector</a></span>()
<div class="jd-descrdiv">Debugging helper.</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
String
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="UiObject.html#getText()">getText</a></span>()
<div class="jd-descrdiv">Reads the <code>text</code> property of the UI element</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
Rect
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="UiObject.html#getVisibleBounds()">getVisibleBounds</a></span>()
<div class="jd-descrdiv">Returns the visible bounds of the UI element.</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
boolean
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="UiObject.html#isCheckable()">isCheckable</a></span>()
<div class="jd-descrdiv">Check if the UI element's <code>checkable</code> property is currently true</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
boolean
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="UiObject.html#isChecked()">isChecked</a></span>()
<div class="jd-descrdiv">Check if the UI element's <code>checked</code> property is currently true</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
boolean
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="UiObject.html#isClickable()">isClickable</a></span>()
<div class="jd-descrdiv">Check if the UI element's <code>clickable</code> property is currently true</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
boolean
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="UiObject.html#isEnabled()">isEnabled</a></span>()
<div class="jd-descrdiv">Check if the UI element's <code>enabled</code> property is currently true</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
boolean
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="UiObject.html#isFocusable()">isFocusable</a></span>()
<div class="jd-descrdiv">Check if the UI element's <code>focusable</code> property is currently true</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
boolean
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="UiObject.html#isFocused()">isFocused</a></span>()
<div class="jd-descrdiv">Check if the UI element's <code>focused</code> property is currently true</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
boolean
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="UiObject.html#isLongClickable()">isLongClickable</a></span>()
<div class="jd-descrdiv">Check if the UI element's <code>long-clickable</code> property is currently true</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
boolean
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="UiObject.html#isScrollable()">isScrollable</a></span>()
<div class="jd-descrdiv">Check if the UI element's <code>scrollable</code> property is currently true</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
boolean
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="UiObject.html#isSelected()">isSelected</a></span>()
<div class="jd-descrdiv">Check if the UI element's <code>selected</code> property is currently true</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
boolean
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="UiObject.html#longClick()">longClick</a></span>()
<div class="jd-descrdiv">Long clicks the center of the visible bounds of the UI element</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
boolean
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="UiObject.html#longClickBottomRight()">longClickBottomRight</a></span>()
<div class="jd-descrdiv">Long clicks bottom and right corner of the UI element</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
boolean
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="UiObject.html#longClickTopLeft()">longClickTopLeft</a></span>()
<div class="jd-descrdiv">Long clicks on the top and left corner of the UI element</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
boolean
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="UiObject.html#setText(java.lang.String)">setText</a></span>(String text)
<div class="jd-descrdiv">Sets the text in an editable field, after clearing the field's content.</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
boolean
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="UiObject.html#swipeDown(int)">swipeDown</a></span>(int steps)
<div class="jd-descrdiv">Perform the action on the UI element that is represented by this object, Also see
#scrollToBeginning(int), #scrollToEnd(int), #scrollBackward(),
#scrollForward().</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
boolean
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="UiObject.html#swipeLeft(int)">swipeLeft</a></span>(int steps)
<div class="jd-descrdiv">Perform the action on the UI element that is represented by this object.</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
boolean
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="UiObject.html#swipeRight(int)">swipeRight</a></span>(int steps)
<div class="jd-descrdiv">Perform the action on the UI element that is represented by this object.</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
boolean
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="UiObject.html#swipeUp(int)">swipeUp</a></span>(int steps)
<div class="jd-descrdiv">Perform the action on the UI element that is represented by this UiObject.</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
boolean
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="UiObject.html#waitForExists(long)">waitForExists</a></span>(long timeout)
<div class="jd-descrdiv">Waits a specified length of time for a UI element to become visible.</div>
</td></tr>
<tr class="api" >
<td class="jd-typecol">
boolean
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="UiObject.html#waitUntilGone(long)">waitUntilGone</a></span>(long timeout)
<div class="jd-descrdiv">Waits a specified length of time for a UI element to become undetectable.</div>
</td></tr>
</table>
</div>
</div>
</td></tr>
<tr class="api apilevel-" >
<td colspan="12">
<a href="#" onclick="return toggleInherited(this, null)" id="inherited-methods-java.lang.Object" class="jd-expando-trigger closed"
><img id="inherited-methods-java.lang.Object-trigger"
src="../../../../../assets/images/triangle-closed.png"
class="jd-expando-trigger-img" /></a>
From class
java.lang.Object
<div id="inherited-methods-java.lang.Object">
<div id="inherited-methods-java.lang.Object-list"
class="jd-inheritedlinks">
</div>
<div id="inherited-methods-java.lang.Object-summary" style="display: none;">
<table class="jd-sumtable-expando">
<tr class="api" >
<td class="jd-typecol">
boolean
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad">equals</span>(Object arg0)
</td></tr>
<tr class="api" >
<td class="jd-typecol">
final
Class<?>
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad">getClass</span>()
</td></tr>
<tr class="api" >
<td class="jd-typecol">
int
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad">hashCode</span>()
</td></tr>
<tr class="api" >
<td class="jd-typecol">
final
void
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad">notify</span>()
</td></tr>
<tr class="api" >
<td class="jd-typecol">
final
void
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad">notifyAll</span>()
</td></tr>
<tr class="api" >
<td class="jd-typecol">
String
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad">toString</span>()
</td></tr>
<tr class="api" >
<td class="jd-typecol">
final
void
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad">wait</span>()
</td></tr>
<tr class="api" >
<td class="jd-typecol">
final
void
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad">wait</span>(long arg0, int arg1)
</td></tr>
<tr class="api" >
<td class="jd-typecol">
final
void
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad">wait</span>(long arg0)
</td></tr>
</table>
</div>
</div>
</td></tr>
</table>
</div><!-- jd-descr (summary) -->
<!-- Details -->
<!-- XML Attributes -->
<!-- Enum Values -->
<!-- Constants -->
<!-- Fields -->
<!-- Public ctors -->
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<h2>Public Constructors</h2>
<a id="UiScrollable(com.android.uiautomator.core.UiSelector)"></a>
<div class="jd-details api ">
<h4 class="jd-details-title">
<span class="normal">
public
</span>
<span class="sympad">UiScrollable</span>
<span class="normal">(<a href="UiSelector.html">UiSelector</a> container)</span>
</h4>
<div class="api-level">
<div>
</div>
</div>
<div class="jd-details-descr">
<div class="jd-tagdata jd-tagdescr"><p>UiScrollable is a <code><a href="UiCollection.html">UiCollection</a></code> and as such requires a <code><a href="UiSelector.html">UiSelector</a></code> to
identify the container UI element of the scrollable collection. Further operations on
the items in the container will require specifying UiSelector as an item selector.</p></div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Parameters</h5>
<table class="jd-tagtable">
<tr>
<th>container</th>
<td>a <code><a href="UiSelector.html">UiSelector</a></code> selector
</td>
</tr>
</table>
</div>
</div>
</div>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<!-- Protected ctors -->
<!-- ========= METHOD DETAIL ======== -->
<!-- Public methdos -->
<h2>Public Methods</h2>
<a id="flingBackward()"></a>
<div class="jd-details api ">
<h4 class="jd-details-title">
<span class="normal">
public
boolean
</span>
<span class="sympad">flingBackward</span>
<span class="normal">()</span>
</h4>
<div class="api-level">
<div>
</div>
</div>
<div class="jd-details-descr">
<div class="jd-tagdata jd-tagdescr"><p>See <code><a href="#scrollBackward(int)">scrollBackward(int)</a></code></p></div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Returns</h5>
<ul class="nolist"><li>true if scrolled and false if the control can't scroll anymore
</li></ul>
</div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Throws</h5>
<table class="jd-tagtable">
<tr>
<th><a href="UiObjectNotFoundException.html">UiObjectNotFoundException</a></td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<a id="flingForward()"></a>
<div class="jd-details api ">
<h4 class="jd-details-title">
<span class="normal">
public
boolean
</span>
<span class="sympad">flingForward</span>
<span class="normal">()</span>
</h4>
<div class="api-level">
<div>
</div>
</div>
<div class="jd-details-descr">
<div class="jd-tagdata jd-tagdescr"><p>A convenience version of <code><a href="#scrollForward(int)">scrollForward(int)</a></code>, performs a fling</p></div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Returns</h5>
<ul class="nolist"><li>true if scrolled and false if the control can't scroll anymore
</li></ul>
</div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Throws</h5>
<table class="jd-tagtable">
<tr>
<th><a href="UiObjectNotFoundException.html">UiObjectNotFoundException</a></td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<a id="flingToBeginning(int)"></a>
<div class="jd-details api ">
<h4 class="jd-details-title">
<span class="normal">
public
boolean
</span>
<span class="sympad">flingToBeginning</span>
<span class="normal">(int maxSwipes)</span>
</h4>
<div class="api-level">
<div>
</div>
</div>
<div class="jd-details-descr">
<div class="jd-tagdata jd-tagdescr"><p>See <code><a href="#scrollToBeginning(int, int)">scrollToBeginning(int, int)</a></code></p></div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Returns</h5>
<ul class="nolist"><li>true on scrolled else false
</li></ul>
</div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Throws</h5>
<table class="jd-tagtable">
<tr>
<th><a href="UiObjectNotFoundException.html">UiObjectNotFoundException</a></td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<a id="flingToEnd(int)"></a>
<div class="jd-details api ">
<h4 class="jd-details-title">
<span class="normal">
public
boolean
</span>
<span class="sympad">flingToEnd</span>
<span class="normal">(int maxSwipes)</span>
</h4>
<div class="api-level">
<div>
</div>
</div>
<div class="jd-details-descr">
<div class="jd-tagdata jd-tagdescr"><p>See <code><a href="#scrollToEnd(int, int)">scrollToEnd(int, int)</a></code></p></div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Returns</h5>
<ul class="nolist"><li>true on scrolled else false
</li></ul>
</div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Throws</h5>
<table class="jd-tagtable">
<tr>
<th><a href="UiObjectNotFoundException.html">UiObjectNotFoundException</a></td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<a id="getChildByDescription(com.android.uiautomator.core.UiSelector, java.lang.String, boolean)"></a>
<div class="jd-details api ">
<h4 class="jd-details-title">
<span class="normal">
public
<a href="UiObject.html">UiObject</a>
</span>
<span class="sympad">getChildByDescription</span>
<span class="normal">(<a href="UiSelector.html">UiSelector</a> childPattern, String text, boolean allowScrollSearch)</span>
</h4>
<div class="api-level">
<div>
</div>
</div>
<div class="jd-details-descr">
<div class="jd-tagdata jd-tagdescr"><p>See <code><a href="#getChildByDescription(com.android.uiautomator.core.UiSelector, java.lang.String)">getChildByDescription(UiSelector, String)</a></code></p></div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Parameters</h5>
<table class="jd-tagtable">
<tr>
<th>childPattern</th>
<td><code><a href="UiSelector.html">UiSelector</a></code> selector of the child pattern to match and return</td>
</tr>
<tr>
<th>text</th>
<td>String may be a partial match for the content-description of a child element.</td>
</tr>
<tr>
<th>allowScrollSearch</th>
<td>set to true if scrolling is allowed</td>
</tr>
</table>
</div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Returns</h5>
<ul class="nolist"><li><code><a href="UiObject.html">UiObject</a></code> pointing at and instance of <code>childPattern</code></li></ul>
</div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Throws</h5>
<table class="jd-tagtable">
<tr>
<th><a href="UiObjectNotFoundException.html">UiObjectNotFoundException</a></td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<a id="getChildByDescription(com.android.uiautomator.core.UiSelector, java.lang.String)"></a>
<div class="jd-details api ">
<h4 class="jd-details-title">
<span class="normal">
public
<a href="UiObject.html">UiObject</a>
</span>
<span class="sympad">getChildByDescription</span>
<span class="normal">(<a href="UiSelector.html">UiSelector</a> childPattern, String text)</span>
</h4>
<div class="api-level">
<div>
</div>
</div>
<div class="jd-details-descr">
<div class="jd-tagdata jd-tagdescr"><p>Searches for child UI element within the constraints of this UiScrollable <code><a href="UiSelector.html">UiSelector</a></code>
container. It looks for any child matching the <code>childPattern</code> argument within its
hierarchy with a matching content-description text. The returned UiObject will represent the
UI element matching the <code>childPattern</code> and not the sub element that matched the
content description.</p>
By default this operation will perform scroll search while attempting to find the UI element
See <code><a href="#getChildByDescription(com.android.uiautomator.core.UiSelector, java.lang.String, boolean)">getChildByDescription(UiSelector, String, boolean)</a></code></p></div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Parameters</h5>
<table class="jd-tagtable">
<tr>
<th>childPattern</th>
<td><code><a href="UiSelector.html">UiSelector</a></code> selector of the child pattern to match and return</td>
</tr>
<tr>
<th>text</th>
<td>String of the identifying child contents of of the <code>childPattern</code></td>
</tr>
</table>
</div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Returns</h5>
<ul class="nolist"><li><code><a href="UiObject.html">UiObject</a></code> pointing at and instance of <code>childPattern</code></li></ul>
</div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Throws</h5>
<table class="jd-tagtable">
<tr>
<th><a href="UiObjectNotFoundException.html">UiObjectNotFoundException</a></td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<a id="getChildByInstance(com.android.uiautomator.core.UiSelector, int)"></a>
<div class="jd-details api ">
<h4 class="jd-details-title">
<span class="normal">
public
<a href="UiObject.html">UiObject</a>
</span>
<span class="sympad">getChildByInstance</span>
<span class="normal">(<a href="UiSelector.html">UiSelector</a> childPattern, int instance)</span>
</h4>
<div class="api-level">
<div>
</div>
</div>
<div class="jd-details-descr">
<div class="jd-tagdata jd-tagdescr"><p>Searches for child UI element within the constraints of this UiScrollable <code><a href="UiSelector.html">UiSelector</a></code>
selector. It looks for any child matching the <code>childPattern</code> argument and
return the <code>instance</code> specified. The operation is performed only on the visible
items and no scrolling is performed in this case.</p></div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Parameters</h5>
<table class="jd-tagtable">
<tr>
<th>childPattern</th>
<td><code><a href="UiSelector.html">UiSelector</a></code> selector of the child pattern to match and return</td>
</tr>
<tr>
<th>instance</th>
<td>int the desired matched instance of this <code>childPattern</code></td>
</tr>
</table>
</div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Returns</h5>
<ul class="nolist"><li><code><a href="UiObject.html">UiObject</a></code> pointing at and instance of <code>childPattern</code>
</li></ul>
</div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Throws</h5>
<table class="jd-tagtable">
<tr>
<th><a href="UiObjectNotFoundException.html">UiObjectNotFoundException</a></td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<a id="getChildByText(com.android.uiautomator.core.UiSelector, java.lang.String, boolean)"></a>
<div class="jd-details api ">
<h4 class="jd-details-title">
<span class="normal">
public
<a href="UiObject.html">UiObject</a>
</span>
<span class="sympad">getChildByText</span>
<span class="normal">(<a href="UiSelector.html">UiSelector</a> childPattern, String text, boolean allowScrollSearch)</span>
</h4>
<div class="api-level">
<div>
</div>
</div>
<div class="jd-details-descr">
<div class="jd-tagdata jd-tagdescr"><p>See <code><a href="#getChildByText(com.android.uiautomator.core.UiSelector, java.lang.String)">getChildByText(UiSelector, String)</a></code></p></div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Parameters</h5>
<table class="jd-tagtable">
<tr>
<th>childPattern</th>
<td><code><a href="UiSelector.html">UiSelector</a></code> selector of the child pattern to match and return</td>
</tr>
<tr>
<th>text</th>
<td>String of the identifying child contents of of the <code>childPattern</code></td>
</tr>
<tr>
<th>allowScrollSearch</th>
<td>set to true if scrolling is allowed</td>
</tr>
</table>
</div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Returns</h5>
<ul class="nolist"><li><code><a href="UiObject.html">UiObject</a></code> pointing at and instance of <code>childPattern</code></li></ul>
</div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Throws</h5>
<table class="jd-tagtable">
<tr>
<th><a href="UiObjectNotFoundException.html">UiObjectNotFoundException</a></td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<a id="getChildByText(com.android.uiautomator.core.UiSelector, java.lang.String)"></a>
<div class="jd-details api ">
<h4 class="jd-details-title">
<span class="normal">
public
<a href="UiObject.html">UiObject</a>
</span>
<span class="sympad">getChildByText</span>
<span class="normal">(<a href="UiSelector.html">UiSelector</a> childPattern, String text)</span>
</h4>
<div class="api-level">
<div>
</div>
</div>
<div class="jd-details-descr">
<div class="jd-tagdata jd-tagdescr"><p>Searches for child UI element within the constraints of this UiScrollable <code><a href="UiSelector.html">UiSelector</a></code>
container. It looks for any child matching the <code>childPattern</code> argument that has
a sub UI element anywhere within its sub hierarchy that has text attribute
<code>text</code>. The returned UiObject will point at the <code>childPattern</code>
instance that matched the search and not at the text matched sub element</p>
By default this operation will perform scroll search while attempting to find the UI
element.
See <code><a href="#getChildByText(com.android.uiautomator.core.UiSelector, java.lang.String, boolean)">getChildByText(UiSelector, String, boolean)</a></code></p></div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Parameters</h5>
<table class="jd-tagtable">
<tr>
<th>childPattern</th>
<td><code><a href="UiSelector.html">UiSelector</a></code> selector of the child pattern to match and return</td>
</tr>
<tr>
<th>text</th>
<td>String of the identifying child contents of of the <code>childPattern</code></td>
</tr>
</table>
</div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Returns</h5>
<ul class="nolist"><li><code><a href="UiObject.html">UiObject</a></code> pointing at and instance of <code>childPattern</code></li></ul>
</div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Throws</h5>
<table class="jd-tagtable">
<tr>
<th><a href="UiObjectNotFoundException.html">UiObjectNotFoundException</a></td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<a id="getMaxSearchSwipes()"></a>
<div class="jd-details api ">
<h4 class="jd-details-title">
<span class="normal">
public
int
</span>
<span class="sympad">getMaxSearchSwipes</span>
<span class="normal">()</span>
</h4>
<div class="api-level">
<div>
</div>
</div>
<div class="jd-details-descr">
<div class="jd-tagdata jd-tagdescr"><p>#getChildByDescription(String, boolean) and #getChildByText(String, boolean)
use an arguments that specifies if scrolling is allowed while searching for the UI element.
The number of scrolls currently allowed to perform a search can be read by this method.
See <code><a href="#setMaxSearchSwipes(int)">setMaxSearchSwipes(int)</a></code></p></div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Returns</h5>
<ul class="nolist"><li>max value of the number of swipes currently allowed during a scroll search
</li></ul>
</div>
</div>
</div>
<a id="getSwipeDeadZonePercentage()"></a>
<div class="jd-details api ">
<h4 class="jd-details-title">
<span class="normal">
public
double
</span>
<span class="sympad">getSwipeDeadZonePercentage</span>
<span class="normal">()</span>
</h4>
<div class="api-level">
<div>
</div>
</div>
<div class="jd-details-descr">
<div class="jd-tagdata jd-tagdescr"><p>Returns the percentage of a widget's size that's considered as a no touch zone when swiping.
Dead zones are set as percentage of a widget's total width or height, denoting a margin
around the swipable area of the widget. Swipes must start and
end inside this margin.
This is important when the widget being swiped may not respond to the swipe if
started at a point too near to the edge. The default is 10% from either edge.</p></div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Returns</h5>
<ul class="nolist"><li>a value between 0 and 1
</li></ul>
</div>
</div>
</div>
<a id="scrollBackward(int)"></a>
<div class="jd-details api ">
<h4 class="jd-details-title">
<span class="normal">
public
boolean
</span>
<span class="sympad">scrollBackward</span>
<span class="normal">(int steps)</span>
</h4>
<div class="api-level">
<div>
</div>
</div>
<div class="jd-details-descr">
<div class="jd-tagdata jd-tagdescr"><p>Perform a scroll backward. If this list is set to vertical (see <code><a href="#setAsVerticalList()">setAsVerticalList()</a></code>
default) then the swipes will be executed from the top to bottom. If this list is set
to horizontal (see <code><a href="#setAsHorizontalList()">setAsHorizontalList()</a></code>) then the swipes will be executed from
the left to right. Caution is required on devices configured with right to left languages
like Arabic and Hebrew.</p></div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Parameters</h5>
<table class="jd-tagtable">
<tr>
<th>steps</th>
<td>use steps to control the speed, so that it may be a scroll, or fling</td>
</tr>
</table>
</div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Returns</h5>
<ul class="nolist"><li>true if scrolled and false if the control can't scroll anymore
</li></ul>
</div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Throws</h5>
<table class="jd-tagtable">
<tr>
<th><a href="UiObjectNotFoundException.html">UiObjectNotFoundException</a></td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<a id="scrollBackward()"></a>
<div class="jd-details api ">
<h4 class="jd-details-title">
<span class="normal">
public
boolean
</span>
<span class="sympad">scrollBackward</span>
<span class="normal">()</span>
</h4>
<div class="api-level">
<div>
</div>
</div>
<div class="jd-details-descr">
<div class="jd-tagdata jd-tagdescr"><p>See <code><a href="#scrollBackward(int)">scrollBackward(int)</a></code></p></div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Returns</h5>
<ul class="nolist"><li>true if scrolled and false if the control can't scroll anymore
</li></ul>
</div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Throws</h5>
<table class="jd-tagtable">
<tr>
<th><a href="UiObjectNotFoundException.html">UiObjectNotFoundException</a></td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<a id="scrollDescriptionIntoView(java.lang.String)"></a>
<div class="jd-details api ">
<h4 class="jd-details-title">
<span class="normal">
public
boolean
</span>
<span class="sympad">scrollDescriptionIntoView</span>
<span class="normal">(String text)</span>
</h4>
<div class="api-level">
<div>
</div>
</div>
<div class="jd-details-descr">
<div class="jd-tagdata jd-tagdescr"><p>Performs a swipe Up on the UI element until the requested content-description
is visible or until swipe attempts have been exhausted. See <code><a href="#setMaxSearchSwipes(int)">setMaxSearchSwipes(int)</a></code></p></div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Parameters</h5>
<table class="jd-tagtable">
<tr>
<th>text</th>
<td>to look for anywhere within the contents of this scrollable.</td>
</tr>
</table>
</div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Returns</h5>
<ul class="nolist"><li>true if item us found else false
</li></ul>
</div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Throws</h5>
<table class="jd-tagtable">
<tr>
<th><a href="UiObjectNotFoundException.html">UiObjectNotFoundException</a></td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<a id="scrollForward()"></a>
<div class="jd-details api ">
<h4 class="jd-details-title">
<span class="normal">
public
boolean
</span>
<span class="sympad">scrollForward</span>
<span class="normal">()</span>
</h4>
<div class="api-level">
<div>
</div>
</div>
<div class="jd-details-descr">
<div class="jd-tagdata jd-tagdescr"><p>A convenience version of <code><a href="#scrollForward(int)">scrollForward(int)</a></code>, performs a regular scroll</p></div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Returns</h5>
<ul class="nolist"><li>true if scrolled and false if the control can't scroll anymore
</li></ul>
</div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Throws</h5>
<table class="jd-tagtable">
<tr>
<th><a href="UiObjectNotFoundException.html">UiObjectNotFoundException</a></td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<a id="scrollForward(int)"></a>
<div class="jd-details api ">
<h4 class="jd-details-title">
<span class="normal">
public
boolean
</span>
<span class="sympad">scrollForward</span>
<span class="normal">(int steps)</span>
</h4>
<div class="api-level">
<div>
</div>
</div>
<div class="jd-details-descr">
<div class="jd-tagdata jd-tagdescr"><p>Perform a scroll forward. If this list is set to vertical (see <code><a href="#setAsVerticalList()">setAsVerticalList()</a></code>
default) then the swipes will be executed from the bottom to top. If this list is set
to horizontal (see <code><a href="#setAsHorizontalList()">setAsHorizontalList()</a></code>) then the swipes will be executed from
the right to left. Caution is required on devices configured with right to left languages
like Arabic and Hebrew.</p></div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Parameters</h5>
<table class="jd-tagtable">
<tr>
<th>steps</th>
<td>use steps to control the speed, so that it may be a scroll, or fling</td>
</tr>
</table>
</div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Returns</h5>
<ul class="nolist"><li>true if scrolled and false if the control can't scroll anymore
</li></ul>
</div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Throws</h5>
<table class="jd-tagtable">
<tr>
<th><a href="UiObjectNotFoundException.html">UiObjectNotFoundException</a></td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<a id="scrollIntoView(com.android.uiautomator.core.UiSelector)"></a>
<div class="jd-details api ">
<h4 class="jd-details-title">
<span class="normal">
public
boolean
</span>
<span class="sympad">scrollIntoView</span>
<span class="normal">(<a href="UiSelector.html">UiSelector</a> selector)</span>
</h4>
<div class="api-level">
<div>
</div>
</div>
<div class="jd-details-descr">
<div class="jd-tagdata jd-tagdescr"><p>Perform a scroll search for a UI element matching the <code><a href="UiSelector.html">UiSelector</a></code> selector argument.
See <code><a href="#scrollDescriptionIntoView(java.lang.String)">scrollDescriptionIntoView(String)</a></code> and <code><a href="#scrollTextIntoView(java.lang.String)">scrollTextIntoView(String)</a></code>.</p></div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Parameters</h5>
<table class="jd-tagtable">
<tr>
<th>selector</th>
<td><code><a href="UiSelector.html">UiSelector</a></code> selector</td>
</tr>
</table>
</div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Returns</h5>
<ul class="nolist"><li>true if the item was found and now is in view else false
</li></ul>
</div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Throws</h5>
<table class="jd-tagtable">
<tr>
<th><a href="UiObjectNotFoundException.html">UiObjectNotFoundException</a></td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<a id="scrollTextIntoView(java.lang.String)"></a>
<div class="jd-details api ">
<h4 class="jd-details-title">
<span class="normal">
public
boolean
</span>
<span class="sympad">scrollTextIntoView</span>
<span class="normal">(String text)</span>
</h4>
<div class="api-level">
<div>
</div>
</div>
<div class="jd-details-descr">
<div class="jd-tagdata jd-tagdescr"><p>Performs a swipe up on the UI element until the requested text is visible
or until swipe attempts have been exhausted. See <code><a href="#setMaxSearchSwipes(int)">setMaxSearchSwipes(int)</a></code></p></div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Parameters</h5>
<table class="jd-tagtable">
<tr>
<th>text</th>
<td>to look for</td>
</tr>
</table>
</div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Returns</h5>
<ul class="nolist"><li>true if item us found else false
</li></ul>
</div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Throws</h5>
<table class="jd-tagtable">
<tr>
<th><a href="UiObjectNotFoundException.html">UiObjectNotFoundException</a></td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<a id="scrollToBeginning(int)"></a>
<div class="jd-details api ">
<h4 class="jd-details-title">
<span class="normal">
public
boolean
</span>
<span class="sympad">scrollToBeginning</span>
<span class="normal">(int maxSwipes)</span>
</h4>
<div class="api-level">
<div>
</div>
</div>
<div class="jd-details-descr">
<div class="jd-tagdata jd-tagdescr"><p>See <code><a href="#scrollToBeginning(int, int)">scrollToBeginning(int, int)</a></code></p></div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Returns</h5>
<ul class="nolist"><li>true on scrolled else false
</li></ul>
</div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Throws</h5>
<table class="jd-tagtable">
<tr>
<th><a href="UiObjectNotFoundException.html">UiObjectNotFoundException</a></td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<a id="scrollToBeginning(int, int)"></a>
<div class="jd-details api ">
<h4 class="jd-details-title">
<span class="normal">
public
boolean
</span>
<span class="sympad">scrollToBeginning</span>
<span class="normal">(int maxSwipes, int steps)</span>
</h4>
<div class="api-level">
<div>
</div>
</div>
<div class="jd-details-descr">
<div class="jd-tagdata jd-tagdescr"><p>Scrolls to the beginning of a scrollable UI element. The beginning could be the top most
in case of vertical lists or the left most in case of horizontal lists. Caution is required
on devices configured with right to left languages like Arabic and Hebrew.</p></div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Parameters</h5>
<table class="jd-tagtable">
<tr>
<th>steps</th>
<td>use steps to control the speed, so that it may be a scroll, or fling</td>
</tr>
</table>
</div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Returns</h5>
<ul class="nolist"><li>true on scrolled else false
</li></ul>
</div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Throws</h5>
<table class="jd-tagtable">
<tr>
<th><a href="UiObjectNotFoundException.html">UiObjectNotFoundException</a></td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<a id="scrollToEnd(int, int)"></a>
<div class="jd-details api ">
<h4 class="jd-details-title">
<span class="normal">
public
boolean
</span>
<span class="sympad">scrollToEnd</span>
<span class="normal">(int maxSwipes, int steps)</span>
</h4>
<div class="api-level">
<div>
</div>
</div>
<div class="jd-details-descr">
<div class="jd-tagdata jd-tagdescr"><p>Scrolls to the end of a scrollable UI element. The end could be the bottom most
in case of vertical controls or the right most for horizontal controls. Caution
is required on devices configured with right to left languages like Arabic and Hebrew.</p></div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Parameters</h5>
<table class="jd-tagtable">
<tr>
<th>steps</th>
<td>use steps to control the speed, so that it may be a scroll, or fling</td>
</tr>
</table>
</div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Returns</h5>
<ul class="nolist"><li>true on scrolled else false
</li></ul>
</div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Throws</h5>
<table class="jd-tagtable">
<tr>
<th><a href="UiObjectNotFoundException.html">UiObjectNotFoundException</a></td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<a id="scrollToEnd(int)"></a>
<div class="jd-details api ">
<h4 class="jd-details-title">
<span class="normal">
public
boolean
</span>
<span class="sympad">scrollToEnd</span>
<span class="normal">(int maxSwipes)</span>
</h4>
<div class="api-level">
<div>
</div>
</div>
<div class="jd-details-descr">
<div class="jd-tagdata jd-tagdescr"><p>See {@link UiScrollable#scrollToEnd(int, int)</p></div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Returns</h5>
<ul class="nolist"><li>true on scrolled else false
</li></ul>
</div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Throws</h5>
<table class="jd-tagtable">
<tr>
<th><a href="UiObjectNotFoundException.html">UiObjectNotFoundException</a></td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<a id="setAsHorizontalList()"></a>
<div class="jd-details api ">
<h4 class="jd-details-title">
<span class="normal">
public
void
</span>
<span class="sympad">setAsHorizontalList</span>
<span class="normal">()</span>
</h4>
<div class="api-level">
<div>
</div>
</div>
<div class="jd-details-descr">
<div class="jd-tagdata jd-tagdescr"><p>Set the direction of swipes when performing scroll search
</p></div>
</div>
</div>
<a id="setAsVerticalList()"></a>
<div class="jd-details api ">
<h4 class="jd-details-title">
<span class="normal">
public
void
</span>
<span class="sympad">setAsVerticalList</span>
<span class="normal">()</span>
</h4>
<div class="api-level">
<div>
</div>
</div>
<div class="jd-details-descr">
<div class="jd-tagdata jd-tagdescr"><p>Set the direction of swipes when performing scroll search
</p></div>
</div>
</div>
<a id="setMaxSearchSwipes(int)"></a>
<div class="jd-details api ">
<h4 class="jd-details-title">
<span class="normal">
public
void
</span>
<span class="sympad">setMaxSearchSwipes</span>
<span class="normal">(int swipes)</span>
</h4>
<div class="api-level">
<div>
</div>
</div>
<div class="jd-details-descr">
<div class="jd-tagdata jd-tagdescr"><p>#getChildByDescription(String, boolean) and #getChildByText(String, boolean)
use an arguments that specifies if scrolling is allowed while searching for the UI element.
The number of scrolls allowed to perform a search can be modified by this method.
The current value can be read by calling <code><a href="#getMaxSearchSwipes()">getMaxSearchSwipes()</a></code></p></div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Parameters</h5>
<table class="jd-tagtable">
<tr>
<th>swipes</th>
<td>is the number of search swipes until abort
</td>
</tr>
</table>
</div>
</div>
</div>
<a id="setSwipeDeadZonePercentage(double)"></a>
<div class="jd-details api ">
<h4 class="jd-details-title">
<span class="normal">
public
void
</span>
<span class="sympad">setSwipeDeadZonePercentage</span>
<span class="normal">(double swipeDeadZonePercentage)</span>
</h4>
<div class="api-level">
<div>
</div>
</div>
<div class="jd-details-descr">
<div class="jd-tagdata jd-tagdescr"><p>Sets the percentage of a widget's size that's considered as a no touch zone when swiping.
Dead zones are set as percentage of a widget's total width or height, denoting a margin
around the swipable area of the widget. Swipes must always start and
end inside this margin.
This is important when the widget being swiped may not respond to the swipe if
started at a point too near to the edge. The default is 10% from either edge</p></div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Parameters</h5>
<table class="jd-tagtable">
<tr>
<th>swipeDeadZonePercentage</th>
<td>is a value between 0 and 1
</td>
</tr>
</table>
</div>
</div>
</div>