1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119<!DOCTYPE html> 120<html devsite> 121<head> 122 123 124 <meta name="top_category" value="develop" /> 125 126 <meta name="subcategory" value="reference" /> 127 128 129 <meta name="book_path" value="/reference/android/support/test/_book.yaml" /> 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145<title>DrawerActions</title> 146 147 148</head> 149 150<body class="gc-documentation develop reference api apilevel-"> 151<div id="doc-api-level" class="" style="display:none"></div> 152 153 154 155 156<div id="naMessage"></div> 157 158<div id="api-info-block"> 159<div class="api-level"> 160 161 162 163 164</div> 165 166 167 168 169 170 171 172 173 174 175 176<div class="sum-details-links"> 177 178Summary: 179 180 181 182 183 184 185 186 187 188 189 190 <a href="#pubmethods">Methods</a> 191 192 193 194 195 | <a href="#inhmethods">Inherited Methods</a> 196 197| <a href="#" onclick="return toggleAllClassInherited()" id="toggleAllClassInherited">[Expand All]</a> 198 199</div><!-- end sum-details-links --> 200</div><!-- end api-info-block --> 201 202<div class="api apilevel-" id="jd-content"> 203 204<!-- ======== START OF CLASS DATA ======== --> 205 206<h1 class="api-title">DrawerActions</h1> 207<p> 208<code class="api-signature"> 209 public 210 211 final 212 213 class 214 DrawerActions 215</code> 216<br> 217 218 219<code class="api-signature"> 220 221 extends Object 222 223 224 225</code> 226 227<code class="api-signature"> 228 229 230 231</code> 232 233</p><table class="jd-inheritance-table"> 234 235 236 <tr> 237 238 <td colspan="2" class="jd-inheritance-class-cell">java.lang.Object 239 </td> 240 </tr> 241 242 243 <tr> 244 245 <td class="jd-inheritance-space"> ↳</td> 246 247 <td colspan="1" class="jd-inheritance-class-cell">android.support.test.espresso.contrib.DrawerActions 248 </td> 249 </tr> 250 251 252</table> 253 254 255 256 257<br><hr> 258 259 260 <p>Espresso actions for using a <code><a href="/reference/android/support/v4/widget/DrawerLayout.html">DrawerLayout</a></code>.</p> 261 262 263 264 <div> 265 <p><b>See also:</b></p> 266 <ul class="nolist"><li><a href="http://developer.android.com/design/patterns/navigation-drawer.html">Navigation 267 drawer design guide</a></li> 268 </ul> 269 </div> 270 271 272 273 274<h2 class="api-section">Summary</h2> 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302<!-- ========== METHOD SUMMARY =========== --> 303<table id="pubmethods" class="responsive methods"> 304<tr><th colspan="2"><h3>Public methods</h3></th></tr> 305 306 307 308 309 <tr class="api apilevel-" > 310 311 312 <td><code> 313 314 315 static 316 317 318 <a href="/reference/android/support/test/espresso/ViewAction.html">ViewAction</a></code> 319 </td> 320 321 <td width="100%"> 322 <code> 323 <a href="/reference/android/support/test/espresso/contrib/DrawerActions.html#close(int)">close</a>(int gravity) 324 </code> 325 326 <p>Creates an action which closes the <code><a href="/reference/android/support/v4/widget/DrawerLayout.html">DrawerLayout</a></code> with the gravity. 327 328 329</p> 330 331 </td> 332 </tr> 333 334 335 336 <tr class="api apilevel-" > 337 338 339 <td><code> 340 341 342 static 343 344 345 <a href="/reference/android/support/test/espresso/ViewAction.html">ViewAction</a></code> 346 </td> 347 348 <td width="100%"> 349 <code> 350 <a href="/reference/android/support/test/espresso/contrib/DrawerActions.html#close()">close</a>() 351 </code> 352 353 <p>Creates an action which closes the <code><a href="/reference/android/support/v4/widget/DrawerLayout.html">DrawerLayout</a></code> with gravity START. 354 355 356</p> 357 358 </td> 359 </tr> 360 361 362 363 <tr class="api apilevel-" > 364 365 366 <td><code> 367 368 369 static 370 371 372 void</code> 373 </td> 374 375 <td width="100%"> 376 <code> 377 <a href="/reference/android/support/test/espresso/contrib/DrawerActions.html#closeDrawer(int, int)">closeDrawer</a>(int drawerLayoutId, int gravity) 378 </code> 379 380 <p><em> 381 This method is deprecated. 382 Use <code><a href="/reference/android/support/test/espresso/contrib/DrawerActions.html#open(int)">open(int)</a></code> with <code>perform</code> after matching a view. This method will 383 be removed in the next release. 384</em> 385 386 387</p> 388 389 </td> 390 </tr> 391 392 393 394 <tr class="api apilevel-" > 395 396 397 <td><code> 398 399 400 static 401 402 403 void</code> 404 </td> 405 406 <td width="100%"> 407 <code> 408 <a href="/reference/android/support/test/espresso/contrib/DrawerActions.html#closeDrawer(int)">closeDrawer</a>(int drawerLayoutId) 409 </code> 410 411 <p><em> 412 This method is deprecated. 413 Use <code><a href="/reference/android/support/test/espresso/contrib/DrawerActions.html#close()">close()</a></code> with <code>perform</code> after matching a view. This method will 414 be removed in the next release. 415</em> 416 417 418</p> 419 420 </td> 421 </tr> 422 423 424 425 <tr class="api apilevel-" > 426 427 428 <td><code> 429 430 431 static 432 433 434 <a href="/reference/android/support/test/espresso/ViewAction.html">ViewAction</a></code> 435 </td> 436 437 <td width="100%"> 438 <code> 439 <a href="/reference/android/support/test/espresso/contrib/DrawerActions.html#open(int)">open</a>(int gravity) 440 </code> 441 442 <p>Creates an action which opens the <code><a href="/reference/android/support/v4/widget/DrawerLayout.html">DrawerLayout</a></code> drawer with the gravity. 443 444 445</p> 446 447 </td> 448 </tr> 449 450 451 452 <tr class="api apilevel-" > 453 454 455 <td><code> 456 457 458 static 459 460 461 <a href="/reference/android/support/test/espresso/ViewAction.html">ViewAction</a></code> 462 </td> 463 464 <td width="100%"> 465 <code> 466 <a href="/reference/android/support/test/espresso/contrib/DrawerActions.html#open()">open</a>() 467 </code> 468 469 <p>Creates an action which opens the <code><a href="/reference/android/support/v4/widget/DrawerLayout.html">DrawerLayout</a></code> drawer with gravity START. 470 471 472</p> 473 474 </td> 475 </tr> 476 477 478 479 <tr class="api apilevel-" > 480 481 482 <td><code> 483 484 485 static 486 487 488 void</code> 489 </td> 490 491 <td width="100%"> 492 <code> 493 <a href="/reference/android/support/test/espresso/contrib/DrawerActions.html#openDrawer(int)">openDrawer</a>(int drawerLayoutId) 494 </code> 495 496 <p><em> 497 This method is deprecated. 498 Use <code><a href="/reference/android/support/test/espresso/contrib/DrawerActions.html#open()">open()</a></code> with <code>perform</code> after matching a view. This method will 499 be removed in the next release. 500</em> 501 502 503</p> 504 505 </td> 506 </tr> 507 508 509 510 <tr class="api apilevel-" > 511 512 513 <td><code> 514 515 516 static 517 518 519 void</code> 520 </td> 521 522 <td width="100%"> 523 <code> 524 <a href="/reference/android/support/test/espresso/contrib/DrawerActions.html#openDrawer(int, int)">openDrawer</a>(int drawerLayoutId, int gravity) 525 </code> 526 527 <p><em> 528 This method is deprecated. 529 Use <code><a href="/reference/android/support/test/espresso/contrib/DrawerActions.html#open(int)">open(int)</a></code> with <code>perform</code> after matching a view. This method will 530 be removed in the next release. 531</em> 532 533 534</p> 535 536 </td> 537 </tr> 538 539 540 541</table> 542 543 544 545 546 547 548 549<!-- ========== METHOD SUMMARY =========== --> 550<table id="inhmethods" class="methods inhtable"> 551<tr><th><h3>Inherited methods</h3></th></tr> 552 553 554<tr class="api apilevel-" > 555<td colspan="2"> 556 557 <a href="#" onclick="return toggleInherited(this, null)" id="inherited-methods-java.lang.Object" class="jd-expando-trigger closed" 558 ><img height="34" id="inherited-methods-java.lang.Object-trigger" 559 src="/assets/images/styles/disclosure_down.png" 560 class="jd-expando-trigger-img" /></a>From 561class 562<code> 563 564 java.lang.Object 565 566</code> 567<div id="inherited-methods-java.lang.Object"> 568 <div id="inherited-methods-java.lang.Object-list" 569 class="jd-inheritedlinks"> 570 </div> 571 <div id="inherited-methods-java.lang.Object-summary" style="display: none;"> 572 <table class="jd-sumtable-expando responsive"> 573 574 575 576 577 <tr class="api apilevel-" > 578 579 580 <td><code> 581 582 583 584 585 586 Object</code> 587 </td> 588 589 <td width="100%"> 590 <code> 591 clone() 592 </code> 593 594 </td> 595 </tr> 596 597 598 599 <tr class="api apilevel-" > 600 601 602 <td><code> 603 604 605 606 607 608 boolean</code> 609 </td> 610 611 <td width="100%"> 612 <code> 613 equals(Object arg0) 614 </code> 615 616 </td> 617 </tr> 618 619 620 621 <tr class="api apilevel-" > 622 623 624 <td><code> 625 626 627 628 629 630 void</code> 631 </td> 632 633 <td width="100%"> 634 <code> 635 finalize() 636 </code> 637 638 </td> 639 </tr> 640 641 642 643 <tr class="api apilevel-" > 644 645 646 <td><code> 647 648 649 650 final 651 652 Class<?></code> 653 </td> 654 655 <td width="100%"> 656 <code> 657 getClass() 658 </code> 659 660 </td> 661 </tr> 662 663 664 665 <tr class="api apilevel-" > 666 667 668 <td><code> 669 670 671 672 673 674 int</code> 675 </td> 676 677 <td width="100%"> 678 <code> 679 hashCode() 680 </code> 681 682 </td> 683 </tr> 684 685 686 687 <tr class="api apilevel-" > 688 689 690 <td><code> 691 692 693 694 final 695 696 void</code> 697 </td> 698 699 <td width="100%"> 700 <code> 701 notify() 702 </code> 703 704 </td> 705 </tr> 706 707 708 709 <tr class="api apilevel-" > 710 711 712 <td><code> 713 714 715 716 final 717 718 void</code> 719 </td> 720 721 <td width="100%"> 722 <code> 723 notifyAll() 724 </code> 725 726 </td> 727 </tr> 728 729 730 731 <tr class="api apilevel-" > 732 733 734 <td><code> 735 736 737 738 739 740 String</code> 741 </td> 742 743 <td width="100%"> 744 <code> 745 toString() 746 </code> 747 748 </td> 749 </tr> 750 751 752 753 <tr class="api apilevel-" > 754 755 756 <td><code> 757 758 759 760 final 761 762 void</code> 763 </td> 764 765 <td width="100%"> 766 <code> 767 wait(long arg0, int arg1) 768 </code> 769 770 </td> 771 </tr> 772 773 774 775 <tr class="api apilevel-" > 776 777 778 <td><code> 779 780 781 782 final 783 784 void</code> 785 </td> 786 787 <td width="100%"> 788 <code> 789 wait(long arg0) 790 </code> 791 792 </td> 793 </tr> 794 795 796 797 <tr class="api apilevel-" > 798 799 800 <td><code> 801 802 803 804 final 805 806 void</code> 807 </td> 808 809 <td width="100%"> 810 <code> 811 wait() 812 </code> 813 814 </td> 815 </tr> 816 817 818 819 </table> 820 </div> 821</div> 822</td></tr> 823 824 825</table> 826 827 828 829<!-- XML Attributes --> 830 831 832<!-- Enum Values --> 833 834 835<!-- Constants --> 836 837 838<!-- Fields --> 839 840 841<!-- Public ctors --> 842 843 844 845<!-- ========= CONSTRUCTOR DETAIL ======== --> 846<!-- Protected ctors --> 847 848 849 850<!-- ========= METHOD DETAIL ======== --> 851<!-- Public methdos --> 852 853<h2 class="api-section">Public methods</h2> 854 855 856 857<A NAME="close(int)"></A> 858 859<div class="api apilevel-"> 860 <h3 class="api-name">close</h3> 861 <div class="api-level"> 862 <div></div> 863 864 865 866 </div> 867<pre class="api-signature no-pretty-print"> 868<a href="/reference/android/support/test/espresso/ViewAction.html">ViewAction</a> close (int gravity)</pre> 869 870 871 872 873 <p>Creates an action which closes the <code><a href="/reference/android/support/v4/widget/DrawerLayout.html">DrawerLayout</a></code> with the gravity. This method 874 blocks until the drawer is fully closed. No operation if the drawer is already closed. 875</p> 876 <table class="responsive"> 877 <tr><th colspan=2>Parameters</th></tr> 878 <tr> 879 <td><code>gravity</code></td> 880 <td width="100%"> 881 <code>int</code> 882 <!-- no parameter comment --></td> 883 </tr> 884 </table> 885 <table class="responsive"> 886 <tr><th colspan=2>Returns</th></tr> 887 <tr> 888 <td><code><a href="/reference/android/support/test/espresso/ViewAction.html">ViewAction</a></code></td> 889 <td width="100%"><!-- no returns description in source --></td> 890 </tr> 891 </table> 892 893</div> 894 895 896<A NAME="close()"></A> 897 898<div class="api apilevel-"> 899 <h3 class="api-name">close</h3> 900 <div class="api-level"> 901 <div></div> 902 903 904 905 </div> 906<pre class="api-signature no-pretty-print"> 907<a href="/reference/android/support/test/espresso/ViewAction.html">ViewAction</a> close ()</pre> 908 909 910 911 912 <p>Creates an action which closes the <code><a href="/reference/android/support/v4/widget/DrawerLayout.html">DrawerLayout</a></code> with gravity START. This method 913 blocks until the drawer is fully closed. No operation if the drawer is already closed. 914</p> 915 <table class="responsive"> 916 <tr><th colspan=2>Returns</th></tr> 917 <tr> 918 <td><code><a href="/reference/android/support/test/espresso/ViewAction.html">ViewAction</a></code></td> 919 <td width="100%"><!-- no returns description in source --></td> 920 </tr> 921 </table> 922 923</div> 924 925 926<A NAME="closeDrawer(int, int)"></A> 927 928<div class="api apilevel-"> 929 <h3 class="api-name">closeDrawer</h3> 930 <div class="api-level"> 931 <div></div> 932 933 934 935 </div> 936<pre class="api-signature no-pretty-print"> 937void closeDrawer (int drawerLayoutId, 938 int gravity)</pre> 939 940 941 942 <p> 943 <p class="caution"><strong> 944 This method is deprecated.</strong><br/> 945 Use <code><a href="/reference/android/support/test/espresso/contrib/DrawerActions.html#open(int)">open(int)</a></code> with <code>perform</code> after matching a view. This method will 946 be removed in the next release. 947 948 </p> 949 <p></p> 950 <table class="responsive"> 951 <tr><th colspan=2>Parameters</th></tr> 952 <tr> 953 <td><code>drawerLayoutId</code></td> 954 <td width="100%"> 955 <code>int</code> 956 <!-- no parameter comment --></td> 957 </tr> 958 <tr> 959 <td><code>gravity</code></td> 960 <td width="100%"> 961 <code>int</code> 962 <!-- no parameter comment --></td> 963 </tr> 964 </table> 965 966</div> 967 968 969<A NAME="closeDrawer(int)"></A> 970 971<div class="api apilevel-"> 972 <h3 class="api-name">closeDrawer</h3> 973 <div class="api-level"> 974 <div></div> 975 976 977 978 </div> 979<pre class="api-signature no-pretty-print"> 980void closeDrawer (int drawerLayoutId)</pre> 981 982 983 984 <p> 985 <p class="caution"><strong> 986 This method is deprecated.</strong><br/> 987 Use <code><a href="/reference/android/support/test/espresso/contrib/DrawerActions.html#close()">close()</a></code> with <code>perform</code> after matching a view. This method will 988 be removed in the next release. 989 990 </p> 991 <p></p> 992 <table class="responsive"> 993 <tr><th colspan=2>Parameters</th></tr> 994 <tr> 995 <td><code>drawerLayoutId</code></td> 996 <td width="100%"> 997 <code>int</code> 998 <!-- no parameter comment --></td> 999 </tr> 1000 </table> 1001 1002</div> 1003 1004 1005<A NAME="open(int)"></A> 1006 1007<div class="api apilevel-"> 1008 <h3 class="api-name">open</h3> 1009 <div class="api-level"> 1010 <div></div> 1011 1012 1013 1014 </div> 1015<pre class="api-signature no-pretty-print"> 1016<a href="/reference/android/support/test/espresso/ViewAction.html">ViewAction</a> open (int gravity)</pre> 1017 1018 1019 1020 1021 <p>Creates an action which opens the <code><a href="/reference/android/support/v4/widget/DrawerLayout.html">DrawerLayout</a></code> drawer with the gravity. This method 1022 blocks until the drawer is fully open. No operation if the drawer is already open. 1023</p> 1024 <table class="responsive"> 1025 <tr><th colspan=2>Parameters</th></tr> 1026 <tr> 1027 <td><code>gravity</code></td> 1028 <td width="100%"> 1029 <code>int</code> 1030 <!-- no parameter comment --></td> 1031 </tr> 1032 </table> 1033 <table class="responsive"> 1034 <tr><th colspan=2>Returns</th></tr> 1035 <tr> 1036 <td><code><a href="/reference/android/support/test/espresso/ViewAction.html">ViewAction</a></code></td> 1037 <td width="100%"><!-- no returns description in source --></td> 1038 </tr> 1039 </table> 1040 1041</div> 1042 1043 1044<A NAME="open()"></A> 1045 1046<div class="api apilevel-"> 1047 <h3 class="api-name">open</h3> 1048 <div class="api-level"> 1049 <div></div> 1050 1051 1052 1053 </div> 1054<pre class="api-signature no-pretty-print"> 1055<a href="/reference/android/support/test/espresso/ViewAction.html">ViewAction</a> open ()</pre> 1056 1057 1058 1059 1060 <p>Creates an action which opens the <code><a href="/reference/android/support/v4/widget/DrawerLayout.html">DrawerLayout</a></code> drawer with gravity START. This method 1061 blocks until the drawer is fully open. No operation if the drawer is already open. 1062</p> 1063 <table class="responsive"> 1064 <tr><th colspan=2>Returns</th></tr> 1065 <tr> 1066 <td><code><a href="/reference/android/support/test/espresso/ViewAction.html">ViewAction</a></code></td> 1067 <td width="100%"><!-- no returns description in source --></td> 1068 </tr> 1069 </table> 1070 1071</div> 1072 1073 1074<A NAME="openDrawer(int)"></A> 1075 1076<div class="api apilevel-"> 1077 <h3 class="api-name">openDrawer</h3> 1078 <div class="api-level"> 1079 <div></div> 1080 1081 1082 1083 </div> 1084<pre class="api-signature no-pretty-print"> 1085void openDrawer (int drawerLayoutId)</pre> 1086 1087 1088 1089 <p> 1090 <p class="caution"><strong> 1091 This method is deprecated.</strong><br/> 1092 Use <code><a href="/reference/android/support/test/espresso/contrib/DrawerActions.html#open()">open()</a></code> with <code>perform</code> after matching a view. This method will 1093 be removed in the next release. 1094 1095 </p> 1096 <p></p> 1097 <table class="responsive"> 1098 <tr><th colspan=2>Parameters</th></tr> 1099 <tr> 1100 <td><code>drawerLayoutId</code></td> 1101 <td width="100%"> 1102 <code>int</code> 1103 <!-- no parameter comment --></td> 1104 </tr> 1105 </table> 1106 1107</div> 1108 1109 1110<A NAME="openDrawer(int, int)"></A> 1111 1112<div class="api apilevel-"> 1113 <h3 class="api-name">openDrawer</h3> 1114 <div class="api-level"> 1115 <div></div> 1116 1117 1118 1119 </div> 1120<pre class="api-signature no-pretty-print"> 1121void openDrawer (int drawerLayoutId, 1122 int gravity)</pre> 1123 1124 1125 1126 <p> 1127 <p class="caution"><strong> 1128 This method is deprecated.</strong><br/> 1129 Use <code><a href="/reference/android/support/test/espresso/contrib/DrawerActions.html#open(int)">open(int)</a></code> with <code>perform</code> after matching a view. This method will 1130 be removed in the next release. 1131 1132 </p> 1133 <p></p> 1134 <table class="responsive"> 1135 <tr><th colspan=2>Parameters</th></tr> 1136 <tr> 1137 <td><code>drawerLayoutId</code></td> 1138 <td width="100%"> 1139 <code>int</code> 1140 <!-- no parameter comment --></td> 1141 </tr> 1142 <tr> 1143 <td><code>gravity</code></td> 1144 <td width="100%"> 1145 <code>int</code> 1146 <!-- no parameter comment --></td> 1147 </tr> 1148 </table> 1149 1150</div> 1151 1152 1153 1154 1155 1156<!-- ========= METHOD DETAIL ======== --> 1157 1158 1159 1160<!-- ========= END OF CLASS DATA ========= --> 1161 1162</div><!-- end jd-content --> 1163 1164 1165 1166<div class="data-reference-resources-wrapper"> 1167 1168 <ul data-reference-resources> 1169 1170 1171 <li><h2>Interfaces</h2> 1172 <ul> 1173 <li class="api apilevel-"><a href="/reference/android/support/test/espresso/contrib/RecyclerViewActions.PositionableRecyclerViewAction.html">RecyclerViewActions.PositionableRecyclerViewAction</a></li> 1174 </ul> 1175 </li> 1176 1177 <li><h2>Classes</h2> 1178 <ul> 1179 <li class="api apilevel-"><a href="/reference/android/support/test/espresso/contrib/AccessibilityChecks.html">AccessibilityChecks</a></li> 1180 <li class="api apilevel-"><a href="/reference/android/support/test/espresso/contrib/CountingIdlingResource.html">CountingIdlingResource</a></li> 1181 <li class="selected api apilevel-"><a href="/reference/android/support/test/espresso/contrib/DrawerActions.html">DrawerActions</a></li> 1182 <li class="api apilevel-"><a href="/reference/android/support/test/espresso/contrib/DrawerMatchers.html">DrawerMatchers</a></li> 1183 <li class="api apilevel-"><a href="/reference/android/support/test/espresso/contrib/NavigationViewActions.html">NavigationViewActions</a></li> 1184 <li class="api apilevel-"><a href="/reference/android/support/test/espresso/contrib/PickerActions.html">PickerActions</a></li> 1185 <li class="api apilevel-"><a href="/reference/android/support/test/espresso/contrib/RecyclerViewActions.html">RecyclerViewActions</a></li> 1186 </ul> 1187 </li> 1188 1189 1190 1191 </ul> 1192 1193</div> 1194 1195 1196 1197</body> 1198</html> 1199