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