1page.title=UiScrollable
2parent.title=uiautomator
3parent.link=index.html
4@jd:body
5<style>
6    h4.jd-details-title {background-color: #DEE8F1;}
7</style>
8<p>A <code><a href="UiCollection.html">UiCollection</a></code>
9that supports searching for items in scrollable layout elements. This class can
10be used with horizontally or vertically scrollable controls.</p>
11<h2>Summary</h2>
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28<!-- =========== ENUM CONSTANT SUMMARY =========== -->
29<table id="inhconstants" class="jd-sumtable"><tr><th>
30  <a href="#" class="toggle-all" onclick="return toggleAllInherited(this, null)">[Expand]</a>
31  <div style="clear:left;">Inherited Constants</div></th></tr>
32
33
34
35
36<tr class="api" >
37<td colspan="12">
38
39  <a href="#" onclick="return toggleInherited(this, null)" id="inherited-constants-com.android.uiautomator.core.UiObject" class="jd-expando-trigger closed"
40          ><img id="inherited-constants-com.android.uiautomator.core.UiObject-trigger"
41          src="../../../../../assets/images/triangle-closed.png"
42          class="jd-expando-trigger-img" /></a>From class
43<a href="UiObject.html">com.android.uiautomator.core.UiObject</a>
44<div id="inherited-constants-com.android.uiautomator.core.UiObject">
45  <div id="inherited-constants-com.android.uiautomator.core.UiObject-list"
46        class="jd-inheritedlinks">
47  </div>
48  <div id="inherited-constants-com.android.uiautomator.core.UiObject-summary" style="display: none;">
49    <table class="jd-sumtable-expando">
50
51
52
53    <tr class="api" >
54        <td class="jd-typecol">int</td>
55        <td class="jd-linkcol"><a href="UiObject.html#FINGER_TOUCH_HALF_WIDTH">FINGER_TOUCH_HALF_WIDTH</a></td>
56        <td class="jd-descrcol" width="100%"></td>
57    </tr>
58
59
60    <tr class="api" >
61        <td class="jd-typecol">int</td>
62        <td class="jd-linkcol"><a href="UiObject.html#SWIPE_MARGIN_LIMIT">SWIPE_MARGIN_LIMIT</a></td>
63        <td class="jd-descrcol" width="100%"></td>
64    </tr>
65
66
67    <tr class="api" >
68        <td class="jd-typecol">long</td>
69        <td class="jd-linkcol"><a href="UiObject.html#WAIT_FOR_EVENT_TMEOUT">WAIT_FOR_EVENT_TMEOUT</a></td>
70        <td class="jd-descrcol" width="100%"><em>
71      This constant is deprecated.
72    use <code><a href="Configurator.html#setScrollAcknowledgmentTimeout(long)">setScrollAcknowledgmentTimeout(long)</a></code>
73</em></td>
74    </tr>
75
76
77    <tr class="api" >
78        <td class="jd-typecol">long</td>
79        <td class="jd-linkcol"><a href="UiObject.html#WAIT_FOR_SELECTOR_POLL">WAIT_FOR_SELECTOR_POLL</a></td>
80        <td class="jd-descrcol" width="100%"></td>
81    </tr>
82
83
84    <tr class="api" >
85        <td class="jd-typecol">long</td>
86        <td class="jd-linkcol"><a href="UiObject.html#WAIT_FOR_SELECTOR_TIMEOUT">WAIT_FOR_SELECTOR_TIMEOUT</a></td>
87        <td class="jd-descrcol" width="100%"><em>
88      This constant is deprecated.
89    use <code><a href="Configurator.html#setWaitForSelectorTimeout(long)">setWaitForSelectorTimeout(long)</a></code>
90</em></td>
91    </tr>
92
93
94    <tr class="api" >
95        <td class="jd-typecol">long</td>
96        <td class="jd-linkcol"><a href="UiObject.html#WAIT_FOR_WINDOW_TMEOUT">WAIT_FOR_WINDOW_TMEOUT</a></td>
97        <td class="jd-descrcol" width="100%"></td>
98    </tr>
99
100
101</table>
102  </div>
103</div>
104</td></tr>
105
106
107
108
109</table>
110
111
112
113
114
115
116
117
118
119<!-- ======== CONSTRUCTOR SUMMARY ======== -->
120<table id="pubctors" class="jd-sumtable"><tr><th colspan="12">Public Constructors</th></tr>
121
122
123
124
125    <tr class="api" >
126        <td class="jd-typecol"><nobr>
127
128
129
130
131
132            </nobr>
133        </td>
134        <td class="jd-linkcol" width="100%"><nobr>
135        <span class="sympad"><a href="#UiScrollable(com.android.uiautomator.core.UiSelector)">UiScrollable</a></span>(<a href="UiSelector.html">UiSelector</a> container)</nobr>
136
137        <div class="jd-descrdiv">Constructor.</div>
138
139  </td></tr>
140
141
142
143</table>
144
145
146
147
148
149
150<!-- ========== METHOD SUMMARY =========== -->
151<table id="pubmethods" class="jd-sumtable"><tr><th colspan="12">Public Methods</th></tr>
152
153
154
155
156    <tr class="api" >
157        <td class="jd-typecol"><nobr>
158
159
160
161
162
163            boolean</nobr>
164        </td>
165        <td class="jd-linkcol" width="100%"><nobr>
166        <span class="sympad"><a href="#flingBackward()">flingBackward</a></span>()</nobr>
167
168        <div class="jd-descrdiv">Performs a backwards fling action with the default number of fling
169 steps (5).</div>
170
171  </td></tr>
172
173
174
175    <tr class="api" >
176        <td class="jd-typecol"><nobr>
177
178
179
180
181
182            boolean</nobr>
183        </td>
184        <td class="jd-linkcol" width="100%"><nobr>
185        <span class="sympad"><a href="#flingForward()">flingForward</a></span>()</nobr>
186
187        <div class="jd-descrdiv">Performs a forward fling with the default number of fling steps (5).</div>
188
189  </td></tr>
190
191
192
193    <tr class="api" >
194        <td class="jd-typecol"><nobr>
195
196
197
198
199
200            boolean</nobr>
201        </td>
202        <td class="jd-linkcol" width="100%"><nobr>
203        <span class="sympad"><a href="#flingToBeginning(int)">flingToBeginning</a></span>(int maxSwipes)</nobr>
204
205        <div class="jd-descrdiv">Performs a fling gesture to reach the beginning of a scrollable layout element.</div>
206
207  </td></tr>
208
209
210
211    <tr class="api" >
212        <td class="jd-typecol"><nobr>
213
214
215
216
217
218            boolean</nobr>
219        </td>
220        <td class="jd-linkcol" width="100%"><nobr>
221        <span class="sympad"><a href="#flingToEnd(int)">flingToEnd</a></span>(int maxSwipes)</nobr>
222
223        <div class="jd-descrdiv">Performs a fling gesture to reach the end of a scrollable layout element.</div>
224
225  </td></tr>
226
227
228
229    <tr class="api" >
230        <td class="jd-typecol"><nobr>
231
232
233
234
235
236            <a href="UiObject.html">UiObject</a></nobr>
237        </td>
238        <td class="jd-linkcol" width="100%"><nobr>
239        <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)</nobr>
240
241        <div class="jd-descrdiv">Searches for a child element in the present scrollable container.</div>
242
243  </td></tr>
244
245
246
247    <tr class="api" >
248        <td class="jd-typecol"><nobr>
249
250
251
252
253
254            <a href="UiObject.html">UiObject</a></nobr>
255        </td>
256        <td class="jd-linkcol" width="100%"><nobr>
257        <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)</nobr>
258
259        <div class="jd-descrdiv">Searches for a child element in the present scrollable container.</div>
260
261  </td></tr>
262
263
264
265    <tr class="api" >
266        <td class="jd-typecol"><nobr>
267
268
269
270
271
272            <a href="UiObject.html">UiObject</a></nobr>
273        </td>
274        <td class="jd-linkcol" width="100%"><nobr>
275        <span class="sympad"><a href="#getChildByInstance(com.android.uiautomator.core.UiSelector, int)">getChildByInstance</a></span>(<a href="UiSelector.html">UiSelector</a> childPattern, int instance)</nobr>
276
277        <div class="jd-descrdiv">Searches for a child element in the present scrollable container that
278 matches the selector you provided.</div>
279
280  </td></tr>
281
282
283
284    <tr class="api" >
285        <td class="jd-typecol"><nobr>
286
287
288
289
290
291            <a href="UiObject.html">UiObject</a></nobr>
292        </td>
293        <td class="jd-linkcol" width="100%"><nobr>
294        <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)</nobr>
295
296        <div class="jd-descrdiv">Searches for a child element in the present scrollable container.</div>
297
298  </td></tr>
299
300
301
302    <tr class="api" >
303        <td class="jd-typecol"><nobr>
304
305
306
307
308
309            <a href="UiObject.html">UiObject</a></nobr>
310        </td>
311        <td class="jd-linkcol" width="100%"><nobr>
312        <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)</nobr>
313
314        <div class="jd-descrdiv">Searches for a child element in the present scrollable
315 container.</div>
316
317  </td></tr>
318
319
320
321    <tr class="api" >
322        <td class="jd-typecol"><nobr>
323
324
325
326
327
328            int</nobr>
329        </td>
330        <td class="jd-linkcol" width="100%"><nobr>
331        <span class="sympad"><a href="#getMaxSearchSwipes()">getMaxSearchSwipes</a></span>()</nobr>
332
333        <div class="jd-descrdiv">Gets the maximum number of scrolls allowed when performing a
334 scroll action in search of a child element.</div>
335
336  </td></tr>
337
338
339
340    <tr class="api" >
341        <td class="jd-typecol"><nobr>
342
343
344
345
346
347            double</nobr>
348        </td>
349        <td class="jd-linkcol" width="100%"><nobr>
350        <span class="sympad"><a href="#getSwipeDeadZonePercentage()">getSwipeDeadZonePercentage</a></span>()</nobr>
351
352        <div class="jd-descrdiv">Returns the percentage of a widget's size that's considered as a no-touch
353 zone when swiping.</div>
354
355  </td></tr>
356
357
358
359    <tr class="api" >
360        <td class="jd-typecol"><nobr>
361
362
363
364
365
366            boolean</nobr>
367        </td>
368        <td class="jd-linkcol" width="100%"><nobr>
369        <span class="sympad"><a href="#scrollBackward(int)">scrollBackward</a></span>(int steps)</nobr>
370
371        <div class="jd-descrdiv">Performs a backward scroll.</div>
372
373  </td></tr>
374
375
376
377    <tr class="api" >
378        <td class="jd-typecol"><nobr>
379
380
381
382
383
384            boolean</nobr>
385        </td>
386        <td class="jd-linkcol" width="100%"><nobr>
387        <span class="sympad"><a href="#scrollBackward()">scrollBackward</a></span>()</nobr>
388
389        <div class="jd-descrdiv">Performs a backward scroll with the default number of scroll steps (55).</div>
390
391  </td></tr>
392
393
394
395    <tr class="api" >
396        <td class="jd-typecol"><nobr>
397
398
399
400
401
402            boolean</nobr>
403        </td>
404        <td class="jd-linkcol" width="100%"><nobr>
405        <span class="sympad"><a href="#scrollDescriptionIntoView(java.lang.String)">scrollDescriptionIntoView</a></span>(String text)</nobr>
406
407        <div class="jd-descrdiv">Performs a forward scroll action on the scrollable layout element until
408 the content-description is found, or until swipe attempts have been exhausted.</div>
409
410  </td></tr>
411
412
413
414    <tr class="api" >
415        <td class="jd-typecol"><nobr>
416
417
418
419
420
421            boolean</nobr>
422        </td>
423        <td class="jd-linkcol" width="100%"><nobr>
424        <span class="sympad"><a href="#scrollForward()">scrollForward</a></span>()</nobr>
425
426        <div class="jd-descrdiv">Performs a forward scroll with the default number of scroll steps (55).</div>
427
428  </td></tr>
429
430
431
432    <tr class="api" >
433        <td class="jd-typecol"><nobr>
434
435
436
437
438
439            boolean</nobr>
440        </td>
441        <td class="jd-linkcol" width="100%"><nobr>
442        <span class="sympad"><a href="#scrollForward(int)">scrollForward</a></span>(int steps)</nobr>
443
444        <div class="jd-descrdiv">Performs a forward scroll.</div>
445
446  </td></tr>
447
448
449
450    <tr class="api" >
451        <td class="jd-typecol"><nobr>
452
453
454
455
456
457            boolean</nobr>
458        </td>
459        <td class="jd-linkcol" width="100%"><nobr>
460        <span class="sympad"><a href="#scrollIntoView(com.android.uiautomator.core.UiSelector)">scrollIntoView</a></span>(<a href="UiSelector.html">UiSelector</a> selector)</nobr>
461
462        <div class="jd-descrdiv">Perform a scroll forward action to move through the scrollable layout
463 element until a visible item that matches the selector is found.</div>
464
465  </td></tr>
466
467
468
469    <tr class="api" >
470        <td class="jd-typecol"><nobr>
471
472
473
474
475
476            boolean</nobr>
477        </td>
478        <td class="jd-linkcol" width="100%"><nobr>
479        <span class="sympad"><a href="#scrollIntoView(com.android.uiautomator.core.UiObject)">scrollIntoView</a></span>(<a href="UiObject.html">UiObject</a> obj)</nobr>
480
481        <div class="jd-descrdiv">Perform a forward scroll action to move through the scrollable layout element until
482 a visible item that matches the <code><a href="UiObject.html">UiObject</a></code> is found.</div>
483
484  </td></tr>
485
486
487
488    <tr class="api" >
489        <td class="jd-typecol"><nobr>
490
491
492
493
494
495            boolean</nobr>
496        </td>
497        <td class="jd-linkcol" width="100%"><nobr>
498        <span class="sympad"><a href="#scrollTextIntoView(java.lang.String)">scrollTextIntoView</a></span>(String text)</nobr>
499
500        <div class="jd-descrdiv">Performs a forward scroll action on the scrollable layout element until
501 the text you provided is visible, or until swipe attempts have been exhausted.</div>
502
503  </td></tr>
504
505
506
507    <tr class="api" >
508        <td class="jd-typecol"><nobr>
509
510
511
512
513
514            boolean</nobr>
515        </td>
516        <td class="jd-linkcol" width="100%"><nobr>
517        <span class="sympad"><a href="#scrollToBeginning(int)">scrollToBeginning</a></span>(int maxSwipes)</nobr>
518
519        <div class="jd-descrdiv">Scrolls to the beginning of a scrollable layout element.</div>
520
521  </td></tr>
522
523
524
525    <tr class="api" >
526        <td class="jd-typecol"><nobr>
527
528
529
530
531
532            boolean</nobr>
533        </td>
534        <td class="jd-linkcol" width="100%"><nobr>
535        <span class="sympad"><a href="#scrollToBeginning(int, int)">scrollToBeginning</a></span>(int maxSwipes, int steps)</nobr>
536
537        <div class="jd-descrdiv">Scrolls to the beginning of a scrollable layout element.</div>
538
539  </td></tr>
540
541
542
543    <tr class="api" >
544        <td class="jd-typecol"><nobr>
545
546
547
548
549
550            boolean</nobr>
551        </td>
552        <td class="jd-linkcol" width="100%"><nobr>
553        <span class="sympad"><a href="#scrollToEnd(int, int)">scrollToEnd</a></span>(int maxSwipes, int steps)</nobr>
554
555        <div class="jd-descrdiv">Scrolls to the end of a scrollable layout element.</div>
556
557  </td></tr>
558
559
560
561    <tr class="api" >
562        <td class="jd-typecol"><nobr>
563
564
565
566
567
568            boolean</nobr>
569        </td>
570        <td class="jd-linkcol" width="100%"><nobr>
571        <span class="sympad"><a href="#scrollToEnd(int)">scrollToEnd</a></span>(int maxSwipes)</nobr>
572
573        <div class="jd-descrdiv">Scrolls to the end of a scrollable layout element.</div>
574
575  </td></tr>
576
577
578
579    <tr class="api" >
580        <td class="jd-typecol"><nobr>
581
582
583
584
585
586            <a href="#">UiScrollable</a></nobr>
587        </td>
588        <td class="jd-linkcol" width="100%"><nobr>
589        <span class="sympad"><a href="#setAsHorizontalList()">setAsHorizontalList</a></span>()</nobr>
590
591        <div class="jd-descrdiv">Set the direction of swipes to be horizontal when performing scroll actions.</div>
592
593  </td></tr>
594
595
596
597    <tr class="api" >
598        <td class="jd-typecol"><nobr>
599
600
601
602
603
604            <a href="#">UiScrollable</a></nobr>
605        </td>
606        <td class="jd-linkcol" width="100%"><nobr>
607        <span class="sympad"><a href="#setAsVerticalList()">setAsVerticalList</a></span>()</nobr>
608
609        <div class="jd-descrdiv">Set the direction of swipes to be vertical when performing scroll actions.</div>
610
611  </td></tr>
612
613
614
615    <tr class="api" >
616        <td class="jd-typecol"><nobr>
617
618
619
620
621
622            <a href="#">UiScrollable</a></nobr>
623        </td>
624        <td class="jd-linkcol" width="100%"><nobr>
625        <span class="sympad"><a href="#setMaxSearchSwipes(int)">setMaxSearchSwipes</a></span>(int swipes)</nobr>
626
627        <div class="jd-descrdiv">Sets the maximum number of scrolls allowed when performing a
628 scroll action in search of a child element.</div>
629
630  </td></tr>
631
632
633
634    <tr class="api" >
635        <td class="jd-typecol"><nobr>
636
637
638
639
640
641            <a href="#">UiScrollable</a></nobr>
642        </td>
643        <td class="jd-linkcol" width="100%"><nobr>
644        <span class="sympad"><a href="#setSwipeDeadZonePercentage(double)">setSwipeDeadZonePercentage</a></span>(double swipeDeadZonePercentage)</nobr>
645
646        <div class="jd-descrdiv">Sets the percentage of a widget's size that's considered as no-touch
647 zone when swiping.</div>
648
649  </td></tr>
650
651
652
653</table>
654
655
656
657
658<!-- ========== METHOD SUMMARY =========== -->
659<table id="promethods" class="jd-sumtable"><tr><th colspan="12">Protected Methods</th></tr>
660
661
662
663
664    <tr class="api" >
665        <td class="jd-typecol"><nobr>
666
667
668
669
670
671            boolean</nobr>
672        </td>
673        <td class="jd-linkcol" width="100%"><nobr>
674        <span class="sympad"><a href="#exists(com.android.uiautomator.core.UiSelector)">exists</a></span>(<a href="UiSelector.html">UiSelector</a> selector)</nobr>
675
676        <div class="jd-descrdiv">Used privately when performing swipe searches to decide if an element has become
677 visible or not.</div>
678
679  </td></tr>
680
681
682
683</table>
684
685
686
687
688
689<!-- ========== METHOD SUMMARY =========== -->
690<table id="inhmethods" class="jd-sumtable"><tr><th>
691  <a href="#" class="toggle-all" onclick="return toggleAllInherited(this, null)">[Expand]</a>
692  <div style="clear:left;">Inherited Methods</div></th></tr>
693
694
695<tr class="api" >
696<td colspan="12">
697  <a href="#" onclick="return toggleInherited(this, null)" id="inherited-methods-com.android.uiautomator.core.UiCollection" class="jd-expando-trigger closed"
698          ><img id="inherited-methods-com.android.uiautomator.core.UiCollection-trigger"
699          src="../../../../../assets/images/triangle-closed.png"
700          class="jd-expando-trigger-img" /></a>
701From class
702
703  <a href="UiCollection.html">com.android.uiautomator.core.UiCollection</a>
704
705<div id="inherited-methods-com.android.uiautomator.core.UiCollection">
706  <div id="inherited-methods-com.android.uiautomator.core.UiCollection-list"
707        class="jd-inheritedlinks">
708  </div>
709  <div id="inherited-methods-com.android.uiautomator.core.UiCollection-summary" style="display: none;">
710    <table class="jd-sumtable-expando">
711
712
713
714
715    <tr class="api" >
716        <td class="jd-typecol"><nobr>
717
718
719
720
721
722            <a href="UiObject.html">UiObject</a></nobr>
723        </td>
724        <td class="jd-linkcol" width="100%"><nobr>
725        <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)</nobr>
726
727        <div class="jd-descrdiv">Searches for child UI element within the constraints of this UiCollection <code><a href="UiSelector.html">UiSelector</a></code>
728 selector.</div>
729
730  </td></tr>
731
732
733
734    <tr class="api" >
735        <td class="jd-typecol"><nobr>
736
737
738
739
740
741            <a href="UiObject.html">UiObject</a></nobr>
742        </td>
743        <td class="jd-linkcol" width="100%"><nobr>
744        <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)</nobr>
745
746        <div class="jd-descrdiv">Searches for child UI element within the constraints of this UiCollection <code><a href="UiSelector.html">UiSelector</a></code>
747 selector.</div>
748
749  </td></tr>
750
751
752
753    <tr class="api" >
754        <td class="jd-typecol"><nobr>
755
756
757
758
759
760            <a href="UiObject.html">UiObject</a></nobr>
761        </td>
762        <td class="jd-linkcol" width="100%"><nobr>
763        <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)</nobr>
764
765        <div class="jd-descrdiv">Searches for child UI element within the constraints of this UiCollection <code><a href="UiSelector.html">UiSelector</a></code>
766 selector.</div>
767
768  </td></tr>
769
770
771
772    <tr class="api" >
773        <td class="jd-typecol"><nobr>
774
775
776
777
778
779            int</nobr>
780        </td>
781        <td class="jd-linkcol" width="100%"><nobr>
782        <span class="sympad"><a href="UiCollection.html#getChildCount(com.android.uiautomator.core.UiSelector)">getChildCount</a></span>(<a href="UiSelector.html">UiSelector</a> childPattern)</nobr>
783
784        <div class="jd-descrdiv">Counts child UI element instances matching the <code>childPattern</code>
785 argument.</div>
786
787  </td></tr>
788
789
790</table>
791  </div>
792</div>
793</td></tr>
794
795
796
797<tr class="api" >
798<td colspan="12">
799  <a href="#" onclick="return toggleInherited(this, null)" id="inherited-methods-com.android.uiautomator.core.UiObject" class="jd-expando-trigger closed"
800          ><img id="inherited-methods-com.android.uiautomator.core.UiObject-trigger"
801          src="../../../../../assets/images/triangle-closed.png"
802          class="jd-expando-trigger-img" /></a>
803From class
804
805  <a href="UiObject.html">com.android.uiautomator.core.UiObject</a>
806
807<div id="inherited-methods-com.android.uiautomator.core.UiObject">
808  <div id="inherited-methods-com.android.uiautomator.core.UiObject-list"
809        class="jd-inheritedlinks">
810  </div>
811  <div id="inherited-methods-com.android.uiautomator.core.UiObject-summary" style="display: none;">
812    <table class="jd-sumtable-expando">
813
814
815
816
817    <tr class="api" >
818        <td class="jd-typecol"><nobr>
819
820
821
822
823
824            void</nobr>
825        </td>
826        <td class="jd-linkcol" width="100%"><nobr>
827        <span class="sympad"><a href="UiObject.html#clearTextField()">clearTextField</a></span>()</nobr>
828
829        <div class="jd-descrdiv">Clears the existing text contents in an editable field.</div>
830
831  </td></tr>
832
833
834
835    <tr class="api" >
836        <td class="jd-typecol"><nobr>
837
838
839
840
841
842            boolean</nobr>
843        </td>
844        <td class="jd-linkcol" width="100%"><nobr>
845        <span class="sympad"><a href="UiObject.html#click()">click</a></span>()</nobr>
846
847        <div class="jd-descrdiv">Performs a click at the center of the visible bounds of the UI element represented
848 by this UiObject.</div>
849
850  </td></tr>
851
852
853
854    <tr class="api" >
855        <td class="jd-typecol"><nobr>
856
857
858
859
860
861            boolean</nobr>
862        </td>
863        <td class="jd-linkcol" width="100%"><nobr>
864        <span class="sympad"><a href="UiObject.html#clickAndWaitForNewWindow(long)">clickAndWaitForNewWindow</a></span>(long timeout)</nobr>
865
866        <div class="jd-descrdiv">Performs a click at the center of the visible bounds of the UI element represented
867 by this UiObject and waits for window transitions.</div>
868
869  </td></tr>
870
871
872
873    <tr class="api" >
874        <td class="jd-typecol"><nobr>
875
876
877
878
879
880            boolean</nobr>
881        </td>
882        <td class="jd-linkcol" width="100%"><nobr>
883        <span class="sympad"><a href="UiObject.html#clickAndWaitForNewWindow()">clickAndWaitForNewWindow</a></span>()</nobr>
884
885        <div class="jd-descrdiv">Waits for window transitions that would typically take longer than the
886 usual default timeouts.</div>
887
888  </td></tr>
889
890
891
892    <tr class="api" >
893        <td class="jd-typecol"><nobr>
894
895
896
897
898
899            boolean</nobr>
900        </td>
901        <td class="jd-linkcol" width="100%"><nobr>
902        <span class="sympad"><a href="UiObject.html#clickBottomRight()">clickBottomRight</a></span>()</nobr>
903
904        <div class="jd-descrdiv">Clicks the bottom and right corner of the UI element</div>
905
906  </td></tr>
907
908
909
910    <tr class="api" >
911        <td class="jd-typecol"><nobr>
912
913
914
915
916
917            boolean</nobr>
918        </td>
919        <td class="jd-linkcol" width="100%"><nobr>
920        <span class="sympad"><a href="UiObject.html#clickTopLeft()">clickTopLeft</a></span>()</nobr>
921
922        <div class="jd-descrdiv">Clicks the top and left corner of the UI element</div>
923
924  </td></tr>
925
926
927
928    <tr class="api" >
929        <td class="jd-typecol"><nobr>
930
931
932
933
934
935            boolean</nobr>
936        </td>
937        <td class="jd-linkcol" width="100%"><nobr>
938        <span class="sympad"><a href="UiObject.html#dragTo(com.android.uiautomator.core.UiObject, int)">dragTo</a></span>(<a href="UiObject.html">UiObject</a> destObj, int steps)</nobr>
939
940        <div class="jd-descrdiv">Drags this object to a destination UiObject.</div>
941
942  </td></tr>
943
944
945
946    <tr class="api" >
947        <td class="jd-typecol"><nobr>
948
949
950
951
952
953            boolean</nobr>
954        </td>
955        <td class="jd-linkcol" width="100%"><nobr>
956        <span class="sympad"><a href="UiObject.html#dragTo(int, int, int)">dragTo</a></span>(int destX, int destY, int steps)</nobr>
957
958        <div class="jd-descrdiv">Drags this object to arbitrary coordinates.</div>
959
960  </td></tr>
961
962
963
964    <tr class="api" >
965        <td class="jd-typecol"><nobr>
966
967
968
969
970
971            boolean</nobr>
972        </td>
973        <td class="jd-linkcol" width="100%"><nobr>
974        <span class="sympad"><a href="UiObject.html#exists()">exists</a></span>()</nobr>
975
976        <div class="jd-descrdiv">Check if view exists.</div>
977
978  </td></tr>
979
980
981
982    <tr class="api" >
983        <td class="jd-typecol"><nobr>
984
985
986
987
988
989            AccessibilityNodeInfo</nobr>
990        </td>
991        <td class="jd-linkcol" width="100%"><nobr>
992        <span class="sympad"><a href="UiObject.html#findAccessibilityNodeInfo(long)">findAccessibilityNodeInfo</a></span>(long timeout)</nobr>
993
994        <div class="jd-descrdiv">Finds a matching UI element in the accessibility hierarchy, by
995 using the selector for this UiObject.</div>
996
997  </td></tr>
998
999
1000
1001    <tr class="api" >
1002        <td class="jd-typecol"><nobr>
1003
1004
1005
1006
1007
1008            Rect</nobr>
1009        </td>
1010        <td class="jd-linkcol" width="100%"><nobr>
1011        <span class="sympad"><a href="UiObject.html#getBounds()">getBounds</a></span>()</nobr>
1012
1013        <div class="jd-descrdiv">Returns the view's <code>bounds</code> property.</div>
1014
1015  </td></tr>
1016
1017
1018
1019    <tr class="api" >
1020        <td class="jd-typecol"><nobr>
1021
1022
1023
1024
1025
1026            <a href="UiObject.html">UiObject</a></nobr>
1027        </td>
1028        <td class="jd-linkcol" width="100%"><nobr>
1029        <span class="sympad"><a href="UiObject.html#getChild(com.android.uiautomator.core.UiSelector)">getChild</a></span>(<a href="UiSelector.html">UiSelector</a> selector)</nobr>
1030
1031        <div class="jd-descrdiv">Creates a new UiObject for a child view that is under the present UiObject.</div>
1032
1033  </td></tr>
1034
1035
1036
1037    <tr class="api" >
1038        <td class="jd-typecol"><nobr>
1039
1040
1041
1042
1043
1044            int</nobr>
1045        </td>
1046        <td class="jd-linkcol" width="100%"><nobr>
1047        <span class="sympad"><a href="UiObject.html#getChildCount()">getChildCount</a></span>()</nobr>
1048
1049        <div class="jd-descrdiv">Counts the child views immediately under the present UiObject.</div>
1050
1051  </td></tr>
1052
1053
1054
1055    <tr class="api" >
1056        <td class="jd-typecol"><nobr>
1057
1058
1059
1060
1061
1062            String</nobr>
1063        </td>
1064        <td class="jd-linkcol" width="100%"><nobr>
1065        <span class="sympad"><a href="UiObject.html#getClassName()">getClassName</a></span>()</nobr>
1066
1067        <div class="jd-descrdiv">Retrieves the <code>className</code> property of the UI element.</div>
1068
1069  </td></tr>
1070
1071
1072
1073    <tr class="api" >
1074        <td class="jd-typecol"><nobr>
1075
1076
1077
1078
1079
1080            String</nobr>
1081        </td>
1082        <td class="jd-linkcol" width="100%"><nobr>
1083        <span class="sympad"><a href="UiObject.html#getContentDescription()">getContentDescription</a></span>()</nobr>
1084
1085        <div class="jd-descrdiv">Reads the <code>content_desc</code> property of the UI element</div>
1086
1087  </td></tr>
1088
1089
1090
1091    <tr class="api" >
1092        <td class="jd-typecol"><nobr>
1093
1094
1095
1096
1097
1098            <a href="UiObject.html">UiObject</a></nobr>
1099        </td>
1100        <td class="jd-linkcol" width="100%"><nobr>
1101        <span class="sympad"><a href="UiObject.html#getFromParent(com.android.uiautomator.core.UiSelector)">getFromParent</a></span>(<a href="UiSelector.html">UiSelector</a> selector)</nobr>
1102
1103        <div class="jd-descrdiv">Creates a new UiObject for a sibling view or a child of the sibling view,
1104 relative to the present UiObject.</div>
1105
1106  </td></tr>
1107
1108
1109
1110    <tr class="api" >
1111        <td class="jd-typecol"><nobr>
1112
1113
1114
1115
1116
1117            String</nobr>
1118        </td>
1119        <td class="jd-linkcol" width="100%"><nobr>
1120        <span class="sympad"><a href="UiObject.html#getPackageName()">getPackageName</a></span>()</nobr>
1121
1122        <div class="jd-descrdiv">Reads the view's <code>package</code> property</div>
1123
1124  </td></tr>
1125
1126
1127
1128    <tr class="api" >
1129        <td class="jd-typecol"><nobr>
1130
1131
1132            final
1133
1134
1135            <a href="UiSelector.html">UiSelector</a></nobr>
1136        </td>
1137        <td class="jd-linkcol" width="100%"><nobr>
1138        <span class="sympad"><a href="UiObject.html#getSelector()">getSelector</a></span>()</nobr>
1139
1140        <div class="jd-descrdiv">Debugging helper.</div>
1141
1142  </td></tr>
1143
1144
1145
1146    <tr class="api" >
1147        <td class="jd-typecol"><nobr>
1148
1149
1150
1151
1152
1153            String</nobr>
1154        </td>
1155        <td class="jd-linkcol" width="100%"><nobr>
1156        <span class="sympad"><a href="UiObject.html#getText()">getText</a></span>()</nobr>
1157
1158        <div class="jd-descrdiv">Reads the <code>text</code> property of the UI element</div>
1159
1160  </td></tr>
1161
1162
1163
1164    <tr class="api" >
1165        <td class="jd-typecol"><nobr>
1166
1167
1168
1169
1170
1171            Rect</nobr>
1172        </td>
1173        <td class="jd-linkcol" width="100%"><nobr>
1174        <span class="sympad"><a href="UiObject.html#getVisibleBounds()">getVisibleBounds</a></span>()</nobr>
1175
1176        <div class="jd-descrdiv">Returns the visible bounds of the view.</div>
1177
1178  </td></tr>
1179
1180
1181
1182    <tr class="api" >
1183        <td class="jd-typecol"><nobr>
1184
1185
1186
1187
1188
1189            boolean</nobr>
1190        </td>
1191        <td class="jd-linkcol" width="100%"><nobr>
1192        <span class="sympad"><a href="UiObject.html#isCheckable()">isCheckable</a></span>()</nobr>
1193
1194        <div class="jd-descrdiv">Checks if the UI element's <code>checkable</code> property is currently true.</div>
1195
1196  </td></tr>
1197
1198
1199
1200    <tr class="api" >
1201        <td class="jd-typecol"><nobr>
1202
1203
1204
1205
1206
1207            boolean</nobr>
1208        </td>
1209        <td class="jd-linkcol" width="100%"><nobr>
1210        <span class="sympad"><a href="UiObject.html#isChecked()">isChecked</a></span>()</nobr>
1211
1212        <div class="jd-descrdiv">Check if the UI element's <code>checked</code> property is currently true</div>
1213
1214  </td></tr>
1215
1216
1217
1218    <tr class="api" >
1219        <td class="jd-typecol"><nobr>
1220
1221
1222
1223
1224
1225            boolean</nobr>
1226        </td>
1227        <td class="jd-linkcol" width="100%"><nobr>
1228        <span class="sympad"><a href="UiObject.html#isClickable()">isClickable</a></span>()</nobr>
1229
1230        <div class="jd-descrdiv">Checks if the UI element's <code>clickable</code> property is currently true.</div>
1231
1232  </td></tr>
1233
1234
1235
1236    <tr class="api" >
1237        <td class="jd-typecol"><nobr>
1238
1239
1240
1241
1242
1243            boolean</nobr>
1244        </td>
1245        <td class="jd-linkcol" width="100%"><nobr>
1246        <span class="sympad"><a href="UiObject.html#isEnabled()">isEnabled</a></span>()</nobr>
1247
1248        <div class="jd-descrdiv">Checks if the UI element's <code>enabled</code> property is currently true.</div>
1249
1250  </td></tr>
1251
1252
1253
1254    <tr class="api" >
1255        <td class="jd-typecol"><nobr>
1256
1257
1258
1259
1260
1261            boolean</nobr>
1262        </td>
1263        <td class="jd-linkcol" width="100%"><nobr>
1264        <span class="sympad"><a href="UiObject.html#isFocusable()">isFocusable</a></span>()</nobr>
1265
1266        <div class="jd-descrdiv">Check if the UI element's <code>focusable</code> property is currently true.</div>
1267
1268  </td></tr>
1269
1270
1271
1272    <tr class="api" >
1273        <td class="jd-typecol"><nobr>
1274
1275
1276
1277
1278
1279            boolean</nobr>
1280        </td>
1281        <td class="jd-linkcol" width="100%"><nobr>
1282        <span class="sympad"><a href="UiObject.html#isFocused()">isFocused</a></span>()</nobr>
1283
1284        <div class="jd-descrdiv">Check if the UI element's <code>focused</code> property is currently true</div>
1285
1286  </td></tr>
1287
1288
1289
1290    <tr class="api" >
1291        <td class="jd-typecol"><nobr>
1292
1293
1294
1295
1296
1297            boolean</nobr>
1298        </td>
1299        <td class="jd-linkcol" width="100%"><nobr>
1300        <span class="sympad"><a href="UiObject.html#isLongClickable()">isLongClickable</a></span>()</nobr>
1301
1302        <div class="jd-descrdiv">Check if the view's <code>long-clickable</code> property is currently true</div>
1303
1304  </td></tr>
1305
1306
1307
1308    <tr class="api" >
1309        <td class="jd-typecol"><nobr>
1310
1311
1312
1313
1314
1315            boolean</nobr>
1316        </td>
1317        <td class="jd-linkcol" width="100%"><nobr>
1318        <span class="sympad"><a href="UiObject.html#isScrollable()">isScrollable</a></span>()</nobr>
1319
1320        <div class="jd-descrdiv">Check if the view's <code>scrollable</code> property is currently true</div>
1321
1322  </td></tr>
1323
1324
1325
1326    <tr class="api" >
1327        <td class="jd-typecol"><nobr>
1328
1329
1330
1331
1332
1333            boolean</nobr>
1334        </td>
1335        <td class="jd-linkcol" width="100%"><nobr>
1336        <span class="sympad"><a href="UiObject.html#isSelected()">isSelected</a></span>()</nobr>
1337
1338        <div class="jd-descrdiv">Checks if the UI element's <code>selected</code> property is currently true.</div>
1339
1340  </td></tr>
1341
1342
1343
1344    <tr class="api" >
1345        <td class="jd-typecol"><nobr>
1346
1347
1348
1349
1350
1351            boolean</nobr>
1352        </td>
1353        <td class="jd-linkcol" width="100%"><nobr>
1354        <span class="sympad"><a href="UiObject.html#longClick()">longClick</a></span>()</nobr>
1355
1356        <div class="jd-descrdiv">Long clicks the center of the visible bounds of the UI element</div>
1357
1358  </td></tr>
1359
1360
1361
1362    <tr class="api" >
1363        <td class="jd-typecol"><nobr>
1364
1365
1366
1367
1368
1369            boolean</nobr>
1370        </td>
1371        <td class="jd-linkcol" width="100%"><nobr>
1372        <span class="sympad"><a href="UiObject.html#longClickBottomRight()">longClickBottomRight</a></span>()</nobr>
1373
1374        <div class="jd-descrdiv">Long clicks bottom and right corner of the UI element</div>
1375
1376  </td></tr>
1377
1378
1379
1380    <tr class="api" >
1381        <td class="jd-typecol"><nobr>
1382
1383
1384
1385
1386
1387            boolean</nobr>
1388        </td>
1389        <td class="jd-linkcol" width="100%"><nobr>
1390        <span class="sympad"><a href="UiObject.html#longClickTopLeft()">longClickTopLeft</a></span>()</nobr>
1391
1392        <div class="jd-descrdiv">Long clicks on the top and left corner of the UI element</div>
1393
1394  </td></tr>
1395
1396
1397
1398    <tr class="api" >
1399        <td class="jd-typecol"><nobr>
1400
1401
1402
1403
1404
1405            boolean</nobr>
1406        </td>
1407        <td class="jd-linkcol" width="100%"><nobr>
1408        <span class="sympad"><a href="UiObject.html#performMultiPointerGesture(android.view.MotionEvent.PointerCoords[]...)">performMultiPointerGesture</a></span>(PointerCoords... touches)</nobr>
1409
1410        <div class="jd-descrdiv">Performs a multi-touch gesture.</div>
1411
1412  </td></tr>
1413
1414
1415
1416    <tr class="api" >
1417        <td class="jd-typecol"><nobr>
1418
1419
1420
1421
1422
1423            boolean</nobr>
1424        </td>
1425        <td class="jd-linkcol" width="100%"><nobr>
1426        <span class="sympad"><a href="UiObject.html#performTwoPointerGesture(android.graphics.Point, android.graphics.Point, android.graphics.Point, android.graphics.Point, int)">performTwoPointerGesture</a></span>(Point startPoint1, Point startPoint2, Point endPoint1, Point endPoint2, int steps)</nobr>
1427
1428        <div class="jd-descrdiv">Generates a two-pointer gesture with arbitrary starting and ending points.</div>
1429
1430  </td></tr>
1431
1432
1433
1434    <tr class="api" >
1435        <td class="jd-typecol"><nobr>
1436
1437
1438
1439
1440
1441            boolean</nobr>
1442        </td>
1443        <td class="jd-linkcol" width="100%"><nobr>
1444        <span class="sympad"><a href="UiObject.html#pinchIn(int, int)">pinchIn</a></span>(int percent, int steps)</nobr>
1445
1446        <div class="jd-descrdiv">Performs a two-pointer gesture, where each pointer moves diagonally
1447 toward the other, from the edges to the center of this UiObject .</div>
1448
1449  </td></tr>
1450
1451
1452
1453    <tr class="api" >
1454        <td class="jd-typecol"><nobr>
1455
1456
1457
1458
1459
1460            boolean</nobr>
1461        </td>
1462        <td class="jd-linkcol" width="100%"><nobr>
1463        <span class="sympad"><a href="UiObject.html#pinchOut(int, int)">pinchOut</a></span>(int percent, int steps)</nobr>
1464
1465        <div class="jd-descrdiv">Performs a two-pointer gesture, where each pointer moves diagonally
1466 opposite across the other, from the center out towards the edges of the
1467 this UiObject.</div>
1468
1469  </td></tr>
1470
1471
1472
1473    <tr class="api" >
1474        <td class="jd-typecol"><nobr>
1475
1476
1477
1478
1479
1480            boolean</nobr>
1481        </td>
1482        <td class="jd-linkcol" width="100%"><nobr>
1483        <span class="sympad"><a href="UiObject.html#setText(java.lang.String)">setText</a></span>(String text)</nobr>
1484
1485        <div class="jd-descrdiv">Sets the text in an editable field, after clearing the field's content.</div>
1486
1487  </td></tr>
1488
1489
1490
1491    <tr class="api" >
1492        <td class="jd-typecol"><nobr>
1493
1494
1495
1496
1497
1498            boolean</nobr>
1499        </td>
1500        <td class="jd-linkcol" width="100%"><nobr>
1501        <span class="sympad"><a href="UiObject.html#swipeDown(int)">swipeDown</a></span>(int steps)</nobr>
1502
1503        <div class="jd-descrdiv">Performs the swipe down action on the UiObject.</div>
1504
1505  </td></tr>
1506
1507
1508
1509    <tr class="api" >
1510        <td class="jd-typecol"><nobr>
1511
1512
1513
1514
1515
1516            boolean</nobr>
1517        </td>
1518        <td class="jd-linkcol" width="100%"><nobr>
1519        <span class="sympad"><a href="UiObject.html#swipeLeft(int)">swipeLeft</a></span>(int steps)</nobr>
1520
1521        <div class="jd-descrdiv">Performs the swipe left action on the UiObject.</div>
1522
1523  </td></tr>
1524
1525
1526
1527    <tr class="api" >
1528        <td class="jd-typecol"><nobr>
1529
1530
1531
1532
1533
1534            boolean</nobr>
1535        </td>
1536        <td class="jd-linkcol" width="100%"><nobr>
1537        <span class="sympad"><a href="UiObject.html#swipeRight(int)">swipeRight</a></span>(int steps)</nobr>
1538
1539        <div class="jd-descrdiv">Performs the swipe right action on the UiObject.</div>
1540
1541  </td></tr>
1542
1543
1544
1545    <tr class="api" >
1546        <td class="jd-typecol"><nobr>
1547
1548
1549
1550
1551
1552            boolean</nobr>
1553        </td>
1554        <td class="jd-linkcol" width="100%"><nobr>
1555        <span class="sympad"><a href="UiObject.html#swipeUp(int)">swipeUp</a></span>(int steps)</nobr>
1556
1557        <div class="jd-descrdiv">Performs the swipe up action on the UiObject.</div>
1558
1559  </td></tr>
1560
1561
1562
1563    <tr class="api" >
1564        <td class="jd-typecol"><nobr>
1565
1566
1567
1568
1569
1570            boolean</nobr>
1571        </td>
1572        <td class="jd-linkcol" width="100%"><nobr>
1573        <span class="sympad"><a href="UiObject.html#waitForExists(long)">waitForExists</a></span>(long timeout)</nobr>
1574
1575        <div class="jd-descrdiv">Waits a specified length of time for a view to become visible.</div>
1576
1577  </td></tr>
1578
1579
1580
1581    <tr class="api" >
1582        <td class="jd-typecol"><nobr>
1583
1584
1585
1586
1587
1588            boolean</nobr>
1589        </td>
1590        <td class="jd-linkcol" width="100%"><nobr>
1591        <span class="sympad"><a href="UiObject.html#waitUntilGone(long)">waitUntilGone</a></span>(long timeout)</nobr>
1592
1593        <div class="jd-descrdiv">Waits a specified length of time for a view to become undetectable.</div>
1594
1595  </td></tr>
1596
1597
1598</table>
1599  </div>
1600</div>
1601</td></tr>
1602
1603
1604
1605<tr class="api" >
1606<td colspan="12">
1607  <a href="#" onclick="return toggleInherited(this, null)" id="inherited-methods-java.lang.Object" class="jd-expando-trigger closed"
1608          ><img id="inherited-methods-java.lang.Object-trigger"
1609          src="../../../../../assets/images/triangle-closed.png"
1610          class="jd-expando-trigger-img" /></a>
1611From class
1612
1613  java.lang.Object
1614
1615<div id="inherited-methods-java.lang.Object">
1616  <div id="inherited-methods-java.lang.Object-list"
1617        class="jd-inheritedlinks">
1618  </div>
1619  <div id="inherited-methods-java.lang.Object-summary" style="display: none;">
1620    <table class="jd-sumtable-expando">
1621
1622
1623
1624
1625    <tr class="api" >
1626        <td class="jd-typecol"><nobr>
1627
1628
1629
1630
1631
1632            Object</nobr>
1633        </td>
1634        <td class="jd-linkcol" width="100%"><nobr>
1635        <span class="sympad">clone</span>()</nobr>
1636
1637  </td></tr>
1638
1639
1640
1641    <tr class="api" >
1642        <td class="jd-typecol"><nobr>
1643
1644
1645
1646
1647
1648            boolean</nobr>
1649        </td>
1650        <td class="jd-linkcol" width="100%"><nobr>
1651        <span class="sympad">equals</span>(Object arg0)</nobr>
1652
1653  </td></tr>
1654
1655
1656
1657    <tr class="api" >
1658        <td class="jd-typecol"><nobr>
1659
1660
1661
1662
1663
1664            void</nobr>
1665        </td>
1666        <td class="jd-linkcol" width="100%"><nobr>
1667        <span class="sympad">finalize</span>()</nobr>
1668
1669  </td></tr>
1670
1671
1672
1673    <tr class="api" >
1674        <td class="jd-typecol"><nobr>
1675
1676
1677            final
1678
1679
1680            Class&lt;?&gt;</nobr>
1681        </td>
1682        <td class="jd-linkcol" width="100%"><nobr>
1683        <span class="sympad">getClass</span>()</nobr>
1684
1685  </td></tr>
1686
1687
1688
1689    <tr class="api" >
1690        <td class="jd-typecol"><nobr>
1691
1692
1693
1694
1695
1696            int</nobr>
1697        </td>
1698        <td class="jd-linkcol" width="100%"><nobr>
1699        <span class="sympad">hashCode</span>()</nobr>
1700
1701  </td></tr>
1702
1703
1704
1705    <tr class="api" >
1706        <td class="jd-typecol"><nobr>
1707
1708
1709            final
1710
1711
1712            void</nobr>
1713        </td>
1714        <td class="jd-linkcol" width="100%"><nobr>
1715        <span class="sympad">notify</span>()</nobr>
1716
1717  </td></tr>
1718
1719
1720
1721    <tr class="api" >
1722        <td class="jd-typecol"><nobr>
1723
1724
1725            final
1726
1727
1728            void</nobr>
1729        </td>
1730        <td class="jd-linkcol" width="100%"><nobr>
1731        <span class="sympad">notifyAll</span>()</nobr>
1732
1733  </td></tr>
1734
1735
1736
1737    <tr class="api" >
1738        <td class="jd-typecol"><nobr>
1739
1740
1741
1742
1743
1744            String</nobr>
1745        </td>
1746        <td class="jd-linkcol" width="100%"><nobr>
1747        <span class="sympad">toString</span>()</nobr>
1748
1749  </td></tr>
1750
1751
1752
1753    <tr class="api" >
1754        <td class="jd-typecol"><nobr>
1755
1756
1757            final
1758
1759
1760            void</nobr>
1761        </td>
1762        <td class="jd-linkcol" width="100%"><nobr>
1763        <span class="sympad">wait</span>()</nobr>
1764
1765  </td></tr>
1766
1767
1768
1769    <tr class="api" >
1770        <td class="jd-typecol"><nobr>
1771
1772
1773            final
1774
1775
1776            void</nobr>
1777        </td>
1778        <td class="jd-linkcol" width="100%"><nobr>
1779        <span class="sympad">wait</span>(long arg0, int arg1)</nobr>
1780
1781  </td></tr>
1782
1783
1784
1785    <tr class="api" >
1786        <td class="jd-typecol"><nobr>
1787
1788
1789            final
1790
1791
1792            void</nobr>
1793        </td>
1794        <td class="jd-linkcol" width="100%"><nobr>
1795        <span class="sympad">wait</span>(long arg0)</nobr>
1796
1797  </td></tr>
1798
1799
1800</table>
1801  </div>
1802</div>
1803</td></tr>
1804
1805
1806</table>
1807
1808
1809</div><!-- jd-descr (summary) -->
1810
1811<!-- Details -->
1812
1813
1814
1815
1816
1817
1818
1819
1820<!-- XML Attributes -->
1821
1822
1823<!-- Enum Values -->
1824
1825
1826<!-- Constants -->
1827
1828
1829<!-- Fields -->
1830
1831
1832<!-- Public ctors -->
1833
1834
1835<!-- ========= CONSTRUCTOR DETAIL ======== -->
1836<h2>Public Constructors</h2>
1837
1838
1839
1840<A NAME="UiScrollable(com.android.uiautomator.core.UiSelector)"></A>
1841
1842<div class="jd-details api">
1843    <h4 class="jd-details-title">
1844      <span class="normal">
1845        public
1846
1847
1848
1849
1850
1851      </span>
1852      <span class="sympad">UiScrollable</span>
1853      <span class="normal">(<a href="UiSelector.html">UiSelector</a> container)</span>
1854    </h4>
1855      <div class="api-level">
1856        <div></div>
1857
1858
1859
1860      </div>
1861    <div class="jd-details-descr">
1862
1863  <div class="jd-tagdata jd-tagdescr"><p>Constructor.</p></div>
1864  <div class="jd-tagdata">
1865      <h5 class="jd-tagtitle">Parameters</h5>
1866      <table class="jd-tagtable">
1867        <tr>
1868          <th>container</td>
1869          <td>a <code><a href="UiSelector.html">UiSelector</a></code> selector to identify the scrollable
1870     layout element.</td>
1871        </tr>
1872      </table>
1873  </div>
1874
1875    </div>
1876</div>
1877
1878
1879
1880
1881
1882<!-- ========= CONSTRUCTOR DETAIL ======== -->
1883<!-- Protected ctors -->
1884
1885
1886
1887<!-- ========= METHOD DETAIL ======== -->
1888<!-- Public methdos -->
1889
1890<h2>Public Methods</h2>
1891
1892
1893
1894<A NAME="flingBackward()"></A>
1895
1896<div class="jd-details api">
1897    <h4 class="jd-details-title">
1898      <span class="normal">
1899        public
1900
1901
1902
1903
1904        boolean
1905      </span>
1906      <span class="sympad">flingBackward</span>
1907      <span class="normal">()</span>
1908    </h4>
1909      <div class="api-level">
1910        <div></div>
1911
1912
1913
1914      </div>
1915    <div class="jd-details-descr">
1916
1917  <div class="jd-tagdata jd-tagdescr"><p>Performs a backwards fling action with the default number of fling
1918 steps (5). If the swipe direction is set to vertical,
1919 then the swipe will be performed from top to bottom. If the swipe
1920 direction is set to horizontal, then the swipes will be performed from
1921 left to right. Make sure to take into account devices configured with
1922 right-to-left languages like Arabic and Hebrew.</p></div>
1923  <div class="jd-tagdata">
1924      <h5 class="jd-tagtitle">Returns</h5>
1925      <ul class="nolist"><li>true if scrolled, and false if can't scroll anymore</li></ul>
1926  </div>
1927  <div class="jd-tagdata">
1928      <h5 class="jd-tagtitle">Throws</h5>
1929      <table class="jd-tagtable">
1930        <tr>
1931            <th><a href="UiObjectNotFoundException.html">UiObjectNotFoundException</a></td>
1932            <td></td>
1933        </tr>
1934      </table>
1935  </div>
1936
1937    </div>
1938</div>
1939
1940
1941<A NAME="flingForward()"></A>
1942
1943<div class="jd-details api">
1944    <h4 class="jd-details-title">
1945      <span class="normal">
1946        public
1947
1948
1949
1950
1951        boolean
1952      </span>
1953      <span class="sympad">flingForward</span>
1954      <span class="normal">()</span>
1955    </h4>
1956      <div class="api-level">
1957        <div></div>
1958
1959
1960
1961      </div>
1962    <div class="jd-details-descr">
1963
1964  <div class="jd-tagdata jd-tagdescr"><p>Performs a forward fling with the default number of fling steps (5).
1965 If the swipe direction is set to vertical, then the swipes will be
1966 performed from bottom to top. If the swipe
1967 direction is set to horizontal, then the swipes will be performed from
1968 right to left. Make sure to take into account devices configured with
1969 right-to-left languages like Arabic and Hebrew.</p></div>
1970  <div class="jd-tagdata">
1971      <h5 class="jd-tagtitle">Returns</h5>
1972      <ul class="nolist"><li>true if scrolled, false if can't scroll anymore</li></ul>
1973  </div>
1974  <div class="jd-tagdata">
1975      <h5 class="jd-tagtitle">Throws</h5>
1976      <table class="jd-tagtable">
1977        <tr>
1978            <th><a href="UiObjectNotFoundException.html">UiObjectNotFoundException</a></td>
1979            <td></td>
1980        </tr>
1981      </table>
1982  </div>
1983
1984    </div>
1985</div>
1986
1987
1988<A NAME="flingToBeginning(int)"></A>
1989
1990<div class="jd-details api">
1991    <h4 class="jd-details-title">
1992      <span class="normal">
1993        public
1994
1995
1996
1997
1998        boolean
1999      </span>
2000      <span class="sympad">flingToBeginning</span>
2001      <span class="normal">(int maxSwipes)</span>
2002    </h4>
2003      <div class="api-level">
2004        <div></div>
2005
2006
2007
2008      </div>
2009    <div class="jd-details-descr">
2010
2011  <div class="jd-tagdata jd-tagdescr"><p>Performs a fling gesture to reach the beginning of a scrollable layout element.
2012 The beginning can be at the  top-most edge in the case of vertical controls, or
2013 the left-most edge for horizontal controls. Make sure to take into
2014 account devices configured with right-to-left languages like Arabic and Hebrew.</p></div>
2015  <div class="jd-tagdata">
2016      <h5 class="jd-tagtitle">Returns</h5>
2017      <ul class="nolist"><li>true on scrolled else false</li></ul>
2018  </div>
2019  <div class="jd-tagdata">
2020      <h5 class="jd-tagtitle">Throws</h5>
2021      <table class="jd-tagtable">
2022        <tr>
2023            <th><a href="UiObjectNotFoundException.html">UiObjectNotFoundException</a></td>
2024            <td></td>
2025        </tr>
2026      </table>
2027  </div>
2028
2029    </div>
2030</div>
2031
2032
2033<A NAME="flingToEnd(int)"></A>
2034
2035<div class="jd-details api">
2036    <h4 class="jd-details-title">
2037      <span class="normal">
2038        public
2039
2040
2041
2042
2043        boolean
2044      </span>
2045      <span class="sympad">flingToEnd</span>
2046      <span class="normal">(int maxSwipes)</span>
2047    </h4>
2048      <div class="api-level">
2049        <div></div>
2050
2051
2052
2053      </div>
2054    <div class="jd-details-descr">
2055
2056  <div class="jd-tagdata jd-tagdescr"><p>Performs a fling gesture to reach the end of a scrollable layout element.
2057 The end can be at the  bottom-most edge in the case of vertical controls, or
2058 the right-most edge for horizontal controls. Make sure to take into
2059 account devices configured with right-to-left languages like Arabic and Hebrew.</p></div>
2060  <div class="jd-tagdata">
2061      <h5 class="jd-tagtitle">Returns</h5>
2062      <ul class="nolist"><li>true on scrolled, else false</li></ul>
2063  </div>
2064  <div class="jd-tagdata">
2065      <h5 class="jd-tagtitle">Throws</h5>
2066      <table class="jd-tagtable">
2067        <tr>
2068            <th><a href="UiObjectNotFoundException.html">UiObjectNotFoundException</a></td>
2069            <td></td>
2070        </tr>
2071      </table>
2072  </div>
2073
2074    </div>
2075</div>
2076
2077
2078<A NAME="getChildByDescription(com.android.uiautomator.core.UiSelector, java.lang.String, boolean)"></A>
2079
2080<div class="jd-details api">
2081    <h4 class="jd-details-title">
2082      <span class="normal">
2083        public
2084
2085
2086
2087
2088        <a href="UiObject.html">UiObject</a>
2089      </span>
2090      <span class="sympad">getChildByDescription</span>
2091      <span class="normal">(<a href="UiSelector.html">UiSelector</a> childPattern, String text, boolean allowScrollSearch)</span>
2092    </h4>
2093      <div class="api-level">
2094        <div></div>
2095
2096
2097
2098      </div>
2099    <div class="jd-details-descr">
2100
2101  <div class="jd-tagdata jd-tagdescr"><p>Searches for a child element in the present scrollable container.
2102 The search first looks for a child element that matches the selector
2103 you provided, then looks for the content-description in its children elements.
2104 If both search conditions are fulfilled, the method returns a {@ link UiObject}
2105 representing the element matching the selector (not the child element in its
2106 subhierarchy containing the content-description).</p></div>
2107  <div class="jd-tagdata">
2108      <h5 class="jd-tagtitle">Parameters</h5>
2109      <table class="jd-tagtable">
2110        <tr>
2111          <th>childPattern</td>
2112          <td><code><a href="UiSelector.html">UiSelector</a></code> for a child in a scollable layout element</td>
2113        </tr>
2114        <tr>
2115          <th>text</td>
2116          <td>Content-description to find in the children of
2117 the <code>childPattern</code> match (may be a partial match)</td>
2118        </tr>
2119        <tr>
2120          <th>allowScrollSearch</td>
2121          <td>set to true if scrolling is allowed</td>
2122        </tr>
2123      </table>
2124  </div>
2125  <div class="jd-tagdata">
2126      <h5 class="jd-tagtitle">Returns</h5>
2127      <ul class="nolist"><li><code><a href="UiObject.html">UiObject</a></code> representing the child element that matches the search conditions</li></ul>
2128  </div>
2129  <div class="jd-tagdata">
2130      <h5 class="jd-tagtitle">Throws</h5>
2131      <table class="jd-tagtable">
2132
2133        <tr>
2134            <th><a href="UiObjectNotFoundException.html">UiObjectNotFoundException</a></td>
2135            <td></td>
2136        </tr>
2137      </table>
2138  </div>
2139
2140    </div>
2141</div>
2142
2143
2144<A NAME="getChildByDescription(com.android.uiautomator.core.UiSelector, java.lang.String)"></A>
2145
2146<div class="jd-details api">
2147    <h4 class="jd-details-title">
2148      <span class="normal">
2149        public
2150
2151
2152
2153
2154        <a href="UiObject.html">UiObject</a>
2155      </span>
2156      <span class="sympad">getChildByDescription</span>
2157      <span class="normal">(<a href="UiSelector.html">UiSelector</a> childPattern, String text)</span>
2158    </h4>
2159      <div class="api-level">
2160        <div></div>
2161
2162
2163
2164      </div>
2165    <div class="jd-details-descr">
2166
2167  <div class="jd-tagdata jd-tagdescr"><p>Searches for a child element in the present scrollable container.
2168 The search first looks for a child element that matches the selector
2169 you provided, then looks for the content-description in its children elements.
2170 If both search conditions are fulfilled, the method returns a {@ link UiObject}
2171 representing the element matching the selector (not the child element in its
2172 subhierarchy containing the content-description). By default, this method performs a
2173 scroll search.
2174 See <code><a href="#getChildByDescription(com.android.uiautomator.core.UiSelector, java.lang.String, boolean)">getChildByDescription(UiSelector, String, boolean)</a></code></p></div>
2175  <div class="jd-tagdata">
2176      <h5 class="jd-tagtitle">Parameters</h5>
2177      <table class="jd-tagtable">
2178        <tr>
2179          <th>childPattern</td>
2180          <td><code><a href="UiSelector.html">UiSelector</a></code> for a child in a scollable layout element</td>
2181        </tr>
2182        <tr>
2183          <th>text</td>
2184          <td>Content-description to find in the children of
2185 the <code>childPattern</code> match</td>
2186        </tr>
2187      </table>
2188  </div>
2189  <div class="jd-tagdata">
2190      <h5 class="jd-tagtitle">Returns</h5>
2191      <ul class="nolist"><li><code><a href="UiObject.html">UiObject</a></code> representing the child element that matches the search conditions</li></ul>
2192  </div>
2193  <div class="jd-tagdata">
2194      <h5 class="jd-tagtitle">Throws</h5>
2195      <table class="jd-tagtable">
2196        <tr>
2197            <th><a href="UiObjectNotFoundException.html">UiObjectNotFoundException</a></td>
2198            <td></td>
2199        </tr>
2200      </table>
2201  </div>
2202
2203    </div>
2204</div>
2205
2206
2207<A NAME="getChildByInstance(com.android.uiautomator.core.UiSelector, int)"></A>
2208
2209<div class="jd-details api">
2210    <h4 class="jd-details-title">
2211      <span class="normal">
2212        public
2213
2214
2215
2216
2217        <a href="UiObject.html">UiObject</a>
2218      </span>
2219      <span class="sympad">getChildByInstance</span>
2220      <span class="normal">(<a href="UiSelector.html">UiSelector</a> childPattern, int instance)</span>
2221    </h4>
2222      <div class="api-level">
2223        <div></div>
2224
2225
2226
2227      </div>
2228    <div class="jd-details-descr">
2229
2230  <div class="jd-tagdata jd-tagdescr"><p>Searches for a child element in the present scrollable container that
2231 matches the selector you provided. The search is performed without
2232 scrolling and only on visible elements.</p></div>
2233  <div class="jd-tagdata">
2234      <h5 class="jd-tagtitle">Parameters</h5>
2235      <table class="jd-tagtable">
2236        <tr>
2237          <th>childPattern</td>
2238          <td><code><a href="UiSelector.html">UiSelector</a></code> for a child in a scollable layout element</td>
2239        </tr>
2240        <tr>
2241          <th>instance</td>
2242          <td>int number representing the occurance of
2243 a <code>childPattern</code> match</td>
2244        </tr>
2245      </table>
2246  </div>
2247  <div class="jd-tagdata">
2248      <h5 class="jd-tagtitle">Returns</h5>
2249      <ul class="nolist"><li><code><a href="UiObject.html">UiObject</a></code> representing the child element that matches the search conditions</li></ul>
2250  </div>
2251  <div class="jd-tagdata">
2252      <h5 class="jd-tagtitle">Throws</h5>
2253      <table class="jd-tagtable">
2254        <tr>
2255            <th><a href="UiObjectNotFoundException.html">UiObjectNotFoundException</a></td>
2256            <td></td>
2257        </tr>
2258      </table>
2259  </div>
2260
2261    </div>
2262</div>
2263
2264
2265<A NAME="getChildByText(com.android.uiautomator.core.UiSelector, java.lang.String, boolean)"></A>
2266
2267<div class="jd-details api">
2268    <h4 class="jd-details-title">
2269      <span class="normal">
2270        public
2271
2272
2273
2274
2275        <a href="UiObject.html">UiObject</a>
2276      </span>
2277      <span class="sympad">getChildByText</span>
2278      <span class="normal">(<a href="UiSelector.html">UiSelector</a> childPattern, String text, boolean allowScrollSearch)</span>
2279    </h4>
2280      <div class="api-level">
2281        <div></div>
2282
2283
2284
2285      </div>
2286    <div class="jd-details-descr">
2287
2288  <div class="jd-tagdata jd-tagdescr"><p>Searches for a child element in the present scrollable container. The
2289 search first looks for a child element that matches the
2290 selector you provided, then looks for the text in its children elements.
2291 If both search conditions are fulfilled, the method returns a {@ link UiObject}
2292 representing the element matching the selector (not the child element in its
2293 subhierarchy containing the text).</p></div>
2294  <div class="jd-tagdata">
2295      <h5 class="jd-tagtitle">Parameters</h5>
2296      <table class="jd-tagtable">
2297        <tr>
2298          <th>childPattern</td>
2299          <td><code><a href="UiSelector.html">UiSelector</a></code> selector for a child in a scrollable layout element</td>
2300        </tr>
2301        <tr>
2302          <th>text</td>
2303          <td>String to find in the children of the <code>childPattern</code> match</td>
2304        </tr>
2305        <tr>
2306          <th>allowScrollSearch</td>
2307          <td>set to true if scrolling is allowed</td>
2308        </tr>
2309      </table>
2310  </div>
2311  <div class="jd-tagdata">
2312      <h5 class="jd-tagtitle">Returns</h5>
2313      <ul class="nolist"><li><code><a href="UiObject.html">UiObject</a></code> representing the child element that matches the search conditions</li></ul>
2314  </div>
2315  <div class="jd-tagdata">
2316      <h5 class="jd-tagtitle">Throws</h5>
2317      <table class="jd-tagtable">
2318        <tr>
2319            <th><a href="UiObjectNotFoundException.html">UiObjectNotFoundException</a></td>
2320            <td></td>
2321        </tr>
2322      </table>
2323  </div>
2324
2325    </div>
2326</div>
2327
2328
2329<A NAME="getChildByText(com.android.uiautomator.core.UiSelector, java.lang.String)"></A>
2330
2331<div class="jd-details api">
2332    <h4 class="jd-details-title">
2333      <span class="normal">
2334        public
2335
2336
2337
2338
2339        <a href="UiObject.html">UiObject</a>
2340      </span>
2341      <span class="sympad">getChildByText</span>
2342      <span class="normal">(<a href="UiSelector.html">UiSelector</a> childPattern, String text)</span>
2343    </h4>
2344      <div class="api-level">
2345        <div></div>
2346
2347
2348
2349      </div>
2350    <div class="jd-details-descr">
2351
2352  <div class="jd-tagdata jd-tagdescr"><p>Searches for a child element in the present scrollable
2353 container. The search first looks for a child element that matches the
2354 selector you provided, then looks for the text in its children elements.
2355 If both search conditions are fulfilled, the method returns a {@ link UiObject}
2356 representing the element matching the selector (not the child element in its
2357 subhierarchy containing the text). By default, this method performs a
2358 scroll search.
2359 See <code><a href="#getChildByText(com.android.uiautomator.core.UiSelector, java.lang.String, boolean)">getChildByText(UiSelector, String, boolean)</a></code></p></div>
2360  <div class="jd-tagdata">
2361      <h5 class="jd-tagtitle">Parameters</h5>
2362      <table class="jd-tagtable">
2363        <tr>
2364          <th>childPattern</td>
2365          <td><code><a href="UiSelector.html">UiSelector</a></code> selector for a child in a scrollable layout element</td>
2366        </tr>
2367        <tr>
2368          <th>text</td>
2369          <td>String to find in the children of the <code>childPattern</code> match</td>
2370        </tr>
2371      </table>
2372  </div>
2373  <div class="jd-tagdata">
2374      <h5 class="jd-tagtitle">Returns</h5>
2375      <ul class="nolist"><li><code><a href="UiObject.html">UiObject</a></code> representing the child element that matches the search conditions</li></ul>
2376  </div>
2377  <div class="jd-tagdata">
2378      <h5 class="jd-tagtitle">Throws</h5>
2379      <table class="jd-tagtable">
2380
2381        <tr>
2382            <th><a href="UiObjectNotFoundException.html">UiObjectNotFoundException</a></td>
2383            <td></td>
2384        </tr>
2385      </table>
2386  </div>
2387
2388    </div>
2389</div>
2390
2391
2392<A NAME="getMaxSearchSwipes()"></A>
2393
2394<div class="jd-details api">
2395    <h4 class="jd-details-title">
2396      <span class="normal">
2397        public
2398
2399
2400
2401
2402        int
2403      </span>
2404      <span class="sympad">getMaxSearchSwipes</span>
2405      <span class="normal">()</span>
2406    </h4>
2407      <div class="api-level">
2408        <div></div>
2409
2410
2411
2412      </div>
2413    <div class="jd-details-descr">
2414
2415  <div class="jd-tagdata jd-tagdescr"><p>Gets the maximum number of scrolls allowed when performing a
2416 scroll action in search of a child element.
2417 See <code><a href="#getChildByDescription(com.android.uiautomator.core.UiSelector, java.lang.String)">getChildByDescription(UiSelector, String)</a></code> and
2418 <code><a href="#getChildByText(com.android.uiautomator.core.UiSelector, java.lang.String)">getChildByText(UiSelector, String)</a></code>.</p></div>
2419  <div class="jd-tagdata">
2420      <h5 class="jd-tagtitle">Returns</h5>
2421      <ul class="nolist"><li>max the number of search swipes to perform until giving up</li></ul>
2422  </div>
2423
2424    </div>
2425</div>
2426
2427
2428<A NAME="getSwipeDeadZonePercentage()"></A>
2429
2430<div class="jd-details api">
2431    <h4 class="jd-details-title">
2432      <span class="normal">
2433        public
2434
2435
2436
2437
2438        double
2439      </span>
2440      <span class="sympad">getSwipeDeadZonePercentage</span>
2441      <span class="normal">()</span>
2442    </h4>
2443      <div class="api-level">
2444        <div></div>
2445
2446
2447
2448      </div>
2449    <div class="jd-details-descr">
2450
2451  <div class="jd-tagdata jd-tagdescr"><p>Returns the percentage of a widget's size that's considered as a no-touch
2452 zone when swiping. The no-touch zone is set as a percentage of a widget's total
2453 width or height, denoting a margin around the swipable area of the widget.
2454 Swipes must start and end inside this margin. This is important when the
2455 widget being swiped may not respond to the swipe if started at a point
2456 too near to the edge. The default is 10% from either edge.</p></div>
2457  <div class="jd-tagdata">
2458      <h5 class="jd-tagtitle">Returns</h5>
2459      <ul class="nolist"><li>a value between 0 and 1</li></ul>
2460  </div>
2461
2462    </div>
2463</div>
2464
2465
2466<A NAME="scrollBackward(int)"></A>
2467
2468<div class="jd-details api">
2469    <h4 class="jd-details-title">
2470      <span class="normal">
2471        public
2472
2473
2474
2475
2476        boolean
2477      </span>
2478      <span class="sympad">scrollBackward</span>
2479      <span class="normal">(int steps)</span>
2480    </h4>
2481      <div class="api-level">
2482        <div></div>
2483
2484
2485
2486      </div>
2487    <div class="jd-details-descr">
2488
2489  <div class="jd-tagdata jd-tagdescr"><p>Performs a backward scroll. If the swipe direction is set to vertical,
2490 then the swipes will be performed from top to bottom. If the swipe
2491 direction is set to horizontal, then the swipes will be performed from
2492 left to right. Make sure to take into account devices configured with
2493 right-to-left languages like Arabic and Hebrew.</p></div>
2494  <div class="jd-tagdata">
2495      <h5 class="jd-tagtitle">Parameters</h5>
2496      <table class="jd-tagtable">
2497        <tr>
2498          <th>steps</td>
2499          <td>number of steps. Use this to control the speed of the scroll action.</td>
2500        </tr>
2501      </table>
2502  </div>
2503  <div class="jd-tagdata">
2504      <h5 class="jd-tagtitle">Returns</h5>
2505      <ul class="nolist"><li>true if scrolled, false if can't scroll anymore</li></ul>
2506  </div>
2507  <div class="jd-tagdata">
2508      <h5 class="jd-tagtitle">Throws</h5>
2509      <table class="jd-tagtable">
2510        <tr>
2511            <th><a href="UiObjectNotFoundException.html">UiObjectNotFoundException</a></td>
2512            <td></td>
2513        </tr>
2514      </table>
2515  </div>
2516
2517    </div>
2518</div>
2519
2520
2521<A NAME="scrollBackward()"></A>
2522
2523<div class="jd-details api">
2524    <h4 class="jd-details-title">
2525      <span class="normal">
2526        public
2527
2528
2529
2530
2531        boolean
2532      </span>
2533      <span class="sympad">scrollBackward</span>
2534      <span class="normal">()</span>
2535    </h4>
2536      <div class="api-level">
2537        <div></div>
2538
2539
2540
2541      </div>
2542    <div class="jd-details-descr">
2543
2544  <div class="jd-tagdata jd-tagdescr"><p>Performs a backward scroll with the default number of scroll steps (55).
2545 If the swipe direction is set to vertical,
2546 then the swipes will be performed from top to bottom. If the swipe
2547 direction is set to horizontal, then the swipes will be performed from
2548 left to right. Make sure to take into account devices configured with
2549 right-to-left languages like Arabic and Hebrew.</p></div>
2550  <div class="jd-tagdata">
2551      <h5 class="jd-tagtitle">Returns</h5>
2552      <ul class="nolist"><li>true if scrolled, and false if can't scroll anymore</li></ul>
2553  </div>
2554  <div class="jd-tagdata">
2555      <h5 class="jd-tagtitle">Throws</h5>
2556      <table class="jd-tagtable">
2557        <tr>
2558            <th><a href="UiObjectNotFoundException.html">UiObjectNotFoundException</a></td>
2559            <td></td>
2560        </tr>
2561      </table>
2562  </div>
2563
2564    </div>
2565</div>
2566
2567
2568<A NAME="scrollDescriptionIntoView(java.lang.String)"></A>
2569
2570<div class="jd-details api">
2571    <h4 class="jd-details-title">
2572      <span class="normal">
2573        public
2574
2575
2576
2577
2578        boolean
2579      </span>
2580      <span class="sympad">scrollDescriptionIntoView</span>
2581      <span class="normal">(String text)</span>
2582    </h4>
2583      <div class="api-level">
2584        <div></div>
2585
2586
2587
2588      </div>
2589    <div class="jd-details-descr">
2590
2591  <div class="jd-tagdata jd-tagdescr"><p>Performs a forward scroll action on the scrollable layout element until
2592 the content-description is found, or until swipe attempts have been exhausted.
2593 See <code><a href="#setMaxSearchSwipes(int)">setMaxSearchSwipes(int)</a></code></p></div>
2594  <div class="jd-tagdata">
2595      <h5 class="jd-tagtitle">Parameters</h5>
2596      <table class="jd-tagtable">
2597        <tr>
2598          <th>text</td>
2599          <td>content-description to find within the contents of this scrollable layout element.</td>
2600        </tr>
2601      </table>
2602  </div>
2603  <div class="jd-tagdata">
2604      <h5 class="jd-tagtitle">Returns</h5>
2605      <ul class="nolist"><li>true if item is found; else, false</li></ul>
2606  </div>
2607  <div class="jd-tagdata">
2608      <h5 class="jd-tagtitle">Throws</h5>
2609      <table class="jd-tagtable">
2610        <tr>
2611            <th><a href="UiObjectNotFoundException.html">UiObjectNotFoundException</a></td>
2612            <td></td>
2613        </tr>
2614      </table>
2615  </div>
2616
2617    </div>
2618</div>
2619
2620
2621<A NAME="scrollForward()"></A>
2622
2623<div class="jd-details api">
2624    <h4 class="jd-details-title">
2625      <span class="normal">
2626        public
2627
2628
2629
2630
2631        boolean
2632      </span>
2633      <span class="sympad">scrollForward</span>
2634      <span class="normal">()</span>
2635    </h4>
2636      <div class="api-level">
2637        <div></div>
2638
2639
2640
2641      </div>
2642    <div class="jd-details-descr">
2643
2644  <div class="jd-tagdata jd-tagdescr"><p>Performs a forward scroll with the default number of scroll steps (55).
2645 If the swipe direction is set to vertical,
2646 then the swipes will be performed from bottom to top. If the swipe
2647 direction is set to horizontal, then the swipes will be performed from
2648 right to left. Make sure to take into account devices configured with
2649 right-to-left languages like Arabic and Hebrew.</p></div>
2650  <div class="jd-tagdata">
2651      <h5 class="jd-tagtitle">Returns</h5>
2652      <ul class="nolist"><li>true if scrolled, false if can't scroll anymore</li></ul>
2653  </div>
2654  <div class="jd-tagdata">
2655      <h5 class="jd-tagtitle">Throws</h5>
2656      <table class="jd-tagtable">
2657        <tr>
2658            <th><a href="UiObjectNotFoundException.html">UiObjectNotFoundException</a></td>
2659            <td></td>
2660        </tr>
2661      </table>
2662  </div>
2663
2664    </div>
2665</div>
2666
2667
2668<A NAME="scrollForward(int)"></A>
2669
2670<div class="jd-details api">
2671    <h4 class="jd-details-title">
2672      <span class="normal">
2673        public
2674
2675
2676
2677
2678        boolean
2679      </span>
2680      <span class="sympad">scrollForward</span>
2681      <span class="normal">(int steps)</span>
2682    </h4>
2683      <div class="api-level">
2684        <div></div>
2685
2686
2687
2688      </div>
2689    <div class="jd-details-descr">
2690
2691  <div class="jd-tagdata jd-tagdescr"><p>Performs a forward scroll. If the swipe direction is set to vertical,
2692 then the swipes will be performed from bottom to top. If the swipe
2693 direction is set to horizontal, then the swipes will be performed from
2694 right to left. Make sure to take into account devices configured with
2695 right-to-left languages like Arabic and Hebrew.</p></div>
2696  <div class="jd-tagdata">
2697      <h5 class="jd-tagtitle">Parameters</h5>
2698      <table class="jd-tagtable">
2699        <tr>
2700          <th>steps</td>
2701          <td>number of steps. Use this to control the speed of the scroll action</td>
2702        </tr>
2703      </table>
2704  </div>
2705  <div class="jd-tagdata">
2706      <h5 class="jd-tagtitle">Returns</h5>
2707      <ul class="nolist"><li>true if scrolled, false if can't scroll anymore</li></ul>
2708  </div>
2709  <div class="jd-tagdata">
2710      <h5 class="jd-tagtitle">Throws</h5>
2711      <table class="jd-tagtable">
2712        <tr>
2713            <th><a href="UiObjectNotFoundException.html">UiObjectNotFoundException</a></td>
2714            <td></td>
2715        </tr>
2716      </table>
2717  </div>
2718
2719    </div>
2720</div>
2721
2722
2723<A NAME="scrollIntoView(com.android.uiautomator.core.UiSelector)"></A>
2724
2725<div class="jd-details api">
2726    <h4 class="jd-details-title">
2727      <span class="normal">
2728        public
2729
2730
2731
2732
2733        boolean
2734      </span>
2735      <span class="sympad">scrollIntoView</span>
2736      <span class="normal">(<a href="UiSelector.html">UiSelector</a> selector)</span>
2737    </h4>
2738      <div class="api-level">
2739        <div></div>
2740
2741
2742
2743      </div>
2744    <div class="jd-details-descr">
2745
2746  <div class="jd-tagdata jd-tagdescr"><p>Perform a scroll forward action to move through the scrollable layout
2747 element until a visible item that matches the selector is found.
2748
2749 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>
2750  <div class="jd-tagdata">
2751      <h5 class="jd-tagtitle">Parameters</h5>
2752      <table class="jd-tagtable">
2753        <tr>
2754          <th>selector</td>
2755          <td><code><a href="UiSelector.html">UiSelector</a></code> selector</td>
2756        </tr>
2757      </table>
2758  </div>
2759  <div class="jd-tagdata">
2760      <h5 class="jd-tagtitle">Returns</h5>
2761      <ul class="nolist"><li>true if the item was found and now is in view; else, false</li></ul>
2762  </div>
2763  <div class="jd-tagdata">
2764      <h5 class="jd-tagtitle">Throws</h5>
2765      <table class="jd-tagtable">
2766        <tr>
2767            <th><a href="UiObjectNotFoundException.html">UiObjectNotFoundException</a></td>
2768            <td></td>
2769        </tr>
2770      </table>
2771  </div>
2772
2773    </div>
2774</div>
2775
2776
2777<A NAME="scrollIntoView(com.android.uiautomator.core.UiObject)"></A>
2778
2779<div class="jd-details api">
2780    <h4 class="jd-details-title">
2781      <span class="normal">
2782        public
2783
2784
2785
2786
2787        boolean
2788      </span>
2789      <span class="sympad">scrollIntoView</span>
2790      <span class="normal">(<a href="UiObject.html">UiObject</a> obj)</span>
2791    </h4>
2792      <div class="api-level">
2793        <div></div>
2794
2795
2796
2797      </div>
2798    <div class="jd-details-descr">
2799
2800  <div class="jd-tagdata jd-tagdescr"><p>Perform a forward scroll action to move through the scrollable layout element until
2801 a visible item that matches the <code><a href="UiObject.html">UiObject</a></code> is found.</p></div>
2802  <div class="jd-tagdata">
2803      <h5 class="jd-tagtitle">Parameters</h5>
2804      <table class="jd-tagtable">
2805        <tr>
2806          <th>obj</td>
2807          <td><code><a href="UiObject.html">UiObject</a></code></td>
2808        </tr>
2809      </table>
2810  </div>
2811  <div class="jd-tagdata">
2812      <h5 class="jd-tagtitle">Returns</h5>
2813      <ul class="nolist"><li>true if the item was found and now is in view else false</li></ul>
2814  </div>
2815  <div class="jd-tagdata">
2816      <h5 class="jd-tagtitle">Throws</h5>
2817      <table class="jd-tagtable">
2818        <tr>
2819            <th><a href="UiObjectNotFoundException.html">UiObjectNotFoundException</a></td>
2820            <td></td>
2821        </tr>
2822      </table>
2823  </div>
2824
2825    </div>
2826</div>
2827
2828
2829<A NAME="scrollTextIntoView(java.lang.String)"></A>
2830
2831<div class="jd-details api">
2832    <h4 class="jd-details-title">
2833      <span class="normal">
2834        public
2835
2836
2837
2838
2839        boolean
2840      </span>
2841      <span class="sympad">scrollTextIntoView</span>
2842      <span class="normal">(String text)</span>
2843    </h4>
2844      <div class="api-level">
2845        <div></div>
2846
2847
2848
2849      </div>
2850    <div class="jd-details-descr">
2851
2852  <div class="jd-tagdata jd-tagdescr"><p>Performs a forward scroll action on the scrollable layout element until
2853 the text you provided is visible, or until swipe attempts have been exhausted.
2854 See <code><a href="#setMaxSearchSwipes(int)">setMaxSearchSwipes(int)</a></code></p></div>
2855  <div class="jd-tagdata">
2856      <h5 class="jd-tagtitle">Parameters</h5>
2857      <table class="jd-tagtable">
2858        <tr>
2859          <th>text</td>
2860          <td>test to look for</td>
2861        </tr>
2862      </table>
2863  </div>
2864  <div class="jd-tagdata">
2865      <h5 class="jd-tagtitle">Returns</h5>
2866      <ul class="nolist"><li>true if item is found; else, false</li></ul>
2867  </div>
2868  <div class="jd-tagdata">
2869      <h5 class="jd-tagtitle">Throws</h5>
2870      <table class="jd-tagtable">
2871        <tr>
2872            <th><a href="UiObjectNotFoundException.html">UiObjectNotFoundException</a></td>
2873            <td></td>
2874        </tr>
2875      </table>
2876  </div>
2877
2878    </div>
2879</div>
2880
2881
2882<A NAME="scrollToBeginning(int)"></A>
2883
2884<div class="jd-details api">
2885    <h4 class="jd-details-title">
2886      <span class="normal">
2887        public
2888
2889
2890
2891
2892        boolean
2893      </span>
2894      <span class="sympad">scrollToBeginning</span>
2895      <span class="normal">(int maxSwipes)</span>
2896    </h4>
2897      <div class="api-level">
2898        <div></div>
2899
2900
2901
2902      </div>
2903    <div class="jd-details-descr">
2904
2905  <div class="jd-tagdata jd-tagdescr"><p>Scrolls to the beginning of a scrollable layout element. The beginning
2906 can be at the  top-most edge in the case of vertical controls, or the
2907 left-most edge for horizontal controls. Make sure to take into account
2908 devices configured with right-to-left languages like Arabic and Hebrew.</p></div>
2909  <div class="jd-tagdata">
2910      <h5 class="jd-tagtitle">Returns</h5>
2911      <ul class="nolist"><li>true on scrolled else false</li></ul>
2912  </div>
2913  <div class="jd-tagdata">
2914      <h5 class="jd-tagtitle">Throws</h5>
2915      <table class="jd-tagtable">
2916        <tr>
2917            <th><a href="UiObjectNotFoundException.html">UiObjectNotFoundException</a></td>
2918            <td></td>
2919        </tr>
2920      </table>
2921  </div>
2922
2923    </div>
2924</div>
2925
2926
2927<A NAME="scrollToBeginning(int, int)"></A>
2928
2929<div class="jd-details api">
2930    <h4 class="jd-details-title">
2931      <span class="normal">
2932        public
2933
2934
2935
2936
2937        boolean
2938      </span>
2939      <span class="sympad">scrollToBeginning</span>
2940      <span class="normal">(int maxSwipes, int steps)</span>
2941    </h4>
2942      <div class="api-level">
2943        <div></div>
2944
2945
2946
2947      </div>
2948    <div class="jd-details-descr">
2949
2950  <div class="jd-tagdata jd-tagdescr"><p>Scrolls to the beginning of a scrollable layout element. The beginning
2951 can be at the  top-most edge in the case of vertical controls, or the
2952 left-most edge for horizontal controls. Make sure to take into account
2953 devices configured with right-to-left languages like Arabic and Hebrew.</p></div>
2954  <div class="jd-tagdata">
2955      <h5 class="jd-tagtitle">Parameters</h5>
2956      <table class="jd-tagtable">
2957        <tr>
2958          <th>steps</td>
2959          <td>use steps to control the speed, so that it may be a scroll, or fling</td>
2960        </tr>
2961      </table>
2962  </div>
2963  <div class="jd-tagdata">
2964      <h5 class="jd-tagtitle">Returns</h5>
2965      <ul class="nolist"><li>true on scrolled else false</li></ul>
2966  </div>
2967  <div class="jd-tagdata">
2968      <h5 class="jd-tagtitle">Throws</h5>
2969      <table class="jd-tagtable">
2970        <tr>
2971            <th><a href="UiObjectNotFoundException.html">UiObjectNotFoundException</a></td>
2972            <td></td>
2973        </tr>
2974      </table>
2975  </div>
2976
2977    </div>
2978</div>
2979
2980
2981<A NAME="scrollToEnd(int, int)"></A>
2982
2983<div class="jd-details api">
2984    <h4 class="jd-details-title">
2985      <span class="normal">
2986        public
2987
2988
2989
2990
2991        boolean
2992      </span>
2993      <span class="sympad">scrollToEnd</span>
2994      <span class="normal">(int maxSwipes, int steps)</span>
2995    </h4>
2996      <div class="api-level">
2997        <div></div>
2998
2999
3000
3001      </div>
3002    <div class="jd-details-descr">
3003
3004  <div class="jd-tagdata jd-tagdescr"><p>Scrolls to the end of a scrollable layout element. The end can be at the
3005 bottom-most edge in the case of vertical controls, or the right-most edge for
3006 horizontal controls. Make sure to take into account devices configured with
3007 right-to-left languages like Arabic and Hebrew.</p></div>
3008  <div class="jd-tagdata">
3009      <h5 class="jd-tagtitle">Parameters</h5>
3010      <table class="jd-tagtable">
3011        <tr>
3012          <th>steps</td>
3013          <td>use steps to control the speed, so that it may be a scroll, or fling</td>
3014        </tr>
3015      </table>
3016  </div>
3017  <div class="jd-tagdata">
3018      <h5 class="jd-tagtitle">Returns</h5>
3019      <ul class="nolist"><li>true on scrolled else false</li></ul>
3020  </div>
3021  <div class="jd-tagdata">
3022      <h5 class="jd-tagtitle">Throws</h5>
3023      <table class="jd-tagtable">
3024        <tr>
3025            <th><a href="UiObjectNotFoundException.html">UiObjectNotFoundException</a></td>
3026            <td></td>
3027        </tr>
3028      </table>
3029  </div>
3030
3031    </div>
3032</div>
3033
3034
3035<A NAME="scrollToEnd(int)"></A>
3036
3037<div class="jd-details api">
3038    <h4 class="jd-details-title">
3039      <span class="normal">
3040        public
3041
3042
3043
3044
3045        boolean
3046      </span>
3047      <span class="sympad">scrollToEnd</span>
3048      <span class="normal">(int maxSwipes)</span>
3049    </h4>
3050      <div class="api-level">
3051        <div></div>
3052
3053
3054
3055      </div>
3056    <div class="jd-details-descr">
3057
3058  <div class="jd-tagdata jd-tagdescr"><p>Scrolls to the end of a scrollable layout element. The end can be at the
3059 bottom-most edge in the case of vertical controls, or the right-most edge for
3060 horizontal controls. Make sure to take into account devices configured with
3061 right-to-left languages like Arabic and Hebrew.</p></div>
3062  <div class="jd-tagdata">
3063      <h5 class="jd-tagtitle">Returns</h5>
3064      <ul class="nolist"><li>true on scrolled, else false</li></ul>
3065  </div>
3066  <div class="jd-tagdata">
3067      <h5 class="jd-tagtitle">Throws</h5>
3068      <table class="jd-tagtable">
3069        <tr>
3070            <th><a href="UiObjectNotFoundException.html">UiObjectNotFoundException</a></td>
3071            <td></td>
3072        </tr>
3073      </table>
3074  </div>
3075
3076    </div>
3077</div>
3078
3079
3080<A NAME="setAsHorizontalList()"></A>
3081
3082<div class="jd-details api">
3083    <h4 class="jd-details-title">
3084      <span class="normal">
3085        public
3086
3087
3088
3089
3090        <a href="#">UiScrollable</a>
3091      </span>
3092      <span class="sympad">setAsHorizontalList</span>
3093      <span class="normal">()</span>
3094    </h4>
3095      <div class="api-level">
3096        <div></div>
3097
3098
3099
3100      </div>
3101    <div class="jd-details-descr">
3102
3103  <div class="jd-tagdata jd-tagdescr"><p>Set the direction of swipes to be horizontal when performing scroll actions.</p></div>
3104  <div class="jd-tagdata">
3105      <h5 class="jd-tagtitle">Returns</h5>
3106      <ul class="nolist"><li>reference to itself</li></ul>
3107  </div>
3108
3109    </div>
3110</div>
3111
3112
3113<A NAME="setAsVerticalList()"></A>
3114
3115<div class="jd-details api">
3116    <h4 class="jd-details-title">
3117      <span class="normal">
3118        public
3119
3120
3121
3122
3123        <a href="#">UiScrollable</a>
3124      </span>
3125      <span class="sympad">setAsVerticalList</span>
3126      <span class="normal">()</span>
3127    </h4>
3128      <div class="api-level">
3129        <div></div>
3130
3131
3132
3133      </div>
3134    <div class="jd-details-descr">
3135
3136  <div class="jd-tagdata jd-tagdescr"><p>Set the direction of swipes to be vertical when performing scroll actions.</p></div>
3137  <div class="jd-tagdata">
3138      <h5 class="jd-tagtitle">Returns</h5>
3139      <ul class="nolist"><li>reference to itself</li></ul>
3140  </div>
3141
3142    </div>
3143</div>
3144
3145
3146<A NAME="setMaxSearchSwipes(int)"></A>
3147
3148<div class="jd-details api">
3149    <h4 class="jd-details-title">
3150      <span class="normal">
3151        public
3152
3153
3154
3155
3156        <a href="#">UiScrollable</a>
3157      </span>
3158      <span class="sympad">setMaxSearchSwipes</span>
3159      <span class="normal">(int swipes)</span>
3160    </h4>
3161      <div class="api-level">
3162        <div></div>
3163
3164
3165
3166      </div>
3167    <div class="jd-details-descr">
3168
3169  <div class="jd-tagdata jd-tagdescr"><p>Sets the maximum number of scrolls allowed when performing a
3170 scroll action in search of a child element.
3171 See <code><a href="#getChildByDescription(com.android.uiautomator.core.UiSelector, java.lang.String)">getChildByDescription(UiSelector, String)</a></code> and
3172 <code><a href="#getChildByText(com.android.uiautomator.core.UiSelector, java.lang.String)">getChildByText(UiSelector, String)</a></code>.</p></div>
3173  <div class="jd-tagdata">
3174      <h5 class="jd-tagtitle">Parameters</h5>
3175      <table class="jd-tagtable">
3176        <tr>
3177          <th>swipes</td>
3178          <td>the number of search swipes to perform until giving up</td>
3179        </tr>
3180      </table>
3181  </div>
3182  <div class="jd-tagdata">
3183      <h5 class="jd-tagtitle">Returns</h5>
3184      <ul class="nolist"><li>reference to itself</li></ul>
3185  </div>
3186
3187    </div>
3188</div>
3189
3190
3191<A NAME="setSwipeDeadZonePercentage(double)"></A>
3192
3193<div class="jd-details api">
3194    <h4 class="jd-details-title">
3195      <span class="normal">
3196        public
3197
3198
3199
3200
3201        <a href="#">UiScrollable</a>
3202      </span>
3203      <span class="sympad">setSwipeDeadZonePercentage</span>
3204      <span class="normal">(double swipeDeadZonePercentage)</span>
3205    </h4>
3206      <div class="api-level">
3207        <div></div>
3208
3209
3210
3211      </div>
3212    <div class="jd-details-descr">
3213
3214  <div class="jd-tagdata jd-tagdescr"><p>Sets the percentage of a widget's size that's considered as no-touch
3215 zone when swiping.
3216 The no-touch zone is set as percentage of a widget's total width or height,
3217 denoting a margin around the swipable area of the widget. Swipes must
3218 always start and end inside this margin. This is important when the
3219 widget being swiped may not respond to the swipe if started at a point
3220 too near to the edge. The default is 10% from either edge.</p></div>
3221  <div class="jd-tagdata">
3222      <h5 class="jd-tagtitle">Parameters</h5>
3223      <table class="jd-tagtable">
3224        <tr>
3225          <th>swipeDeadZonePercentage</td>
3226          <td>is a value between 0 and 1</td>
3227        </tr>
3228      </table>
3229  </div>
3230  <div class="jd-tagdata">
3231      <h5 class="jd-tagtitle">Returns</h5>
3232      <ul class="nolist"><li>reference to itself</li></ul>
3233  </div>
3234
3235    </div>
3236</div>
3237
3238
3239
3240
3241
3242<!-- ========= METHOD DETAIL ======== -->
3243
3244<h2>Protected Methods</h2>
3245
3246
3247
3248<A NAME="exists(com.android.uiautomator.core.UiSelector)"></A>
3249
3250<div class="jd-details api">
3251    <h4 class="jd-details-title">
3252      <span class="normal">
3253        protected
3254
3255
3256
3257
3258        boolean
3259      </span>
3260      <span class="sympad">exists</span>
3261      <span class="normal">(<a href="UiSelector.html">UiSelector</a> selector)</span>
3262    </h4>
3263      <div class="api-level">
3264        <div></div>
3265
3266
3267
3268      </div>
3269    <div class="jd-details-descr">
3270
3271  <div class="jd-tagdata jd-tagdescr"><p>Used privately when performing swipe searches to decide if an element has become
3272 visible or not.</p></div>
3273  <div class="jd-tagdata">
3274      <h5 class="jd-tagtitle">Returns</h5>
3275      <ul class="nolist"><li>true if found else false</li></ul>
3276  </div>
3277
3278    </div>
3279
3280
3281
3282
3283
3284