Google Git
Sign in
chromium / chromium / third_party / espresso / f6ec5bf85711ba07d87157ae6f47267c89780157 / . / docs / javadocs / apidocs / com / google / android / apps / common / testing / ui / espresso / ViewInteraction.html
blob: 9cdf4f8d41e0693c284ebcec317263c9c2cf784b [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_45) on Tue Jan 07 16:24:27 PST 2014 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>ViewInteraction (TestKit 1.1 API)</title>
<meta name="date" content="2014-01-07">
<link rel="stylesheet" type="text/css" href="../../../../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ViewInteraction (TestKit 1.1 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ViewInteraction.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../../com/google/android/apps/common/testing/ui/espresso/ViewFinder.html" title="interface in com.google.android.apps.common.testing.ui.espresso"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../../com/google/android/apps/common/testing/ui/espresso/ViewInteractionModule.html" title="class in com.google.android.apps.common.testing.ui.espresso"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?com/google/android/apps/common/testing/ui/espresso/ViewInteraction.html" target="_top">Frames</a></li>
<li><a href="ViewInteraction.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.google.android.apps.common.testing.ui.espresso</div>
<h2 title="Class ViewInteraction" class="title">Class ViewInteraction</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>com.google.android.apps.common.testing.ui.espresso.ViewInteraction</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <span class="strong">ViewInteraction</span>
extends <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Provides the primary interface for test authors to perform actions or asserts on views.
<p>
Each interaction is associated with a view identified by a view matcher. All view actions and
asserts are performed on the UI thread (thus ensuring sequential execution). The same goes for
retrieval of views (this is done to ensure that view state is "fresh" prior to execution of each
operation).
<p></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../../../../com/google/android/apps/common/testing/ui/espresso/ViewInteraction.html#ViewInteraction(com.google.android.apps.common.testing.ui.espresso.UiController, com.google.android.apps.common.testing.ui.espresso.ViewFinder, java.util.concurrent.Executor, com.google.android.apps.common.testing.ui.espresso.FailureHandler, org.hamcrest.Matcher, java.util.concurrent.atomic.AtomicReference)">ViewInteraction</a></strong>(<a href="../../../../../../../../com/google/android/apps/common/testing/ui/espresso/UiController.html" title="interface in com.google.android.apps.common.testing.ui.espresso">UiController</a>&nbsp;uiController,
<a href="../../../../../../../../com/google/android/apps/common/testing/ui/espresso/ViewFinder.html" title="interface in com.google.android.apps.common.testing.ui.espresso">ViewFinder</a>&nbsp;viewFinder,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/concurrent/Executor.html?is-external=true" title="class or interface in java.util.concurrent">Executor</a>&nbsp;mainThreadExecutor,
<a href="../../../../../../../../com/google/android/apps/common/testing/ui/espresso/FailureHandler.html" title="interface in com.google.android.apps.common.testing.ui.espresso">FailureHandler</a>&nbsp;failureHandler,
org.hamcrest.Matcher&lt;android.view.View&gt;&nbsp;viewMatcher,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/concurrent/atomic/AtomicReference.html?is-external=true" title="class or interface in java.util.concurrent.atomic">AtomicReference</a>&lt;org.hamcrest.Matcher&lt;<a href="../../../../../../../../com/google/android/apps/common/testing/ui/espresso/Root.html" title="class in com.google.android.apps.common.testing.ui.espresso">Root</a>&gt;&gt;&nbsp;rootMatcherRef)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../../../com/google/android/apps/common/testing/ui/espresso/ViewInteraction.html" title="class in com.google.android.apps.common.testing.ui.espresso">ViewInteraction</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../../../com/google/android/apps/common/testing/ui/espresso/ViewInteraction.html#check(com.google.android.apps.common.testing.ui.espresso.ViewAssertion)">check</a></strong>(<a href="../../../../../../../../com/google/android/apps/common/testing/ui/espresso/ViewAssertion.html" title="interface in com.google.android.apps.common.testing.ui.espresso">ViewAssertion</a>&nbsp;viewAssert)</code>
<div class="block">Checks the given <a href="../../../../../../../../com/google/android/apps/common/testing/ui/espresso/ViewAssertion.html" title="interface in com.google.android.apps.common.testing.ui.espresso"><code>ViewAssertion</code></a> on the the view selected by the current view matcher.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../../com/google/android/apps/common/testing/ui/espresso/ViewInteraction.html" title="class in com.google.android.apps.common.testing.ui.espresso">ViewInteraction</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../../../com/google/android/apps/common/testing/ui/espresso/ViewInteraction.html#inRoot(org.hamcrest.Matcher)">inRoot</a></strong>(org.hamcrest.Matcher&lt;<a href="../../../../../../../../com/google/android/apps/common/testing/ui/espresso/Root.html" title="class in com.google.android.apps.common.testing.ui.espresso">Root</a>&gt;&nbsp;rootMatcher)</code>
<div class="block">Makes this ViewInteraction scoped to the root selected by the given root matcher.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../../../com/google/android/apps/common/testing/ui/espresso/ViewInteraction.html" title="class in com.google.android.apps.common.testing.ui.espresso">ViewInteraction</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../../../com/google/android/apps/common/testing/ui/espresso/ViewInteraction.html#perform(com.google.android.apps.common.testing.ui.espresso.ViewAction...)">perform</a></strong>(<a href="../../../../../../../../com/google/android/apps/common/testing/ui/espresso/ViewAction.html" title="interface in com.google.android.apps.common.testing.ui.espresso">ViewAction</a>...&nbsp;viewActions)</code>
<div class="block">Performs the given action(s) on the view selected by the current view matcher.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ViewInteraction(com.google.android.apps.common.testing.ui.espresso.UiController, com.google.android.apps.common.testing.ui.espresso.ViewFinder, java.util.concurrent.Executor, com.google.android.apps.common.testing.ui.espresso.FailureHandler, org.hamcrest.Matcher, java.util.concurrent.atomic.AtomicReference)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ViewInteraction</h4>
<pre>@Inject
ViewInteraction(<a href="../../../../../../../../com/google/android/apps/common/testing/ui/espresso/UiController.html" title="interface in com.google.android.apps.common.testing.ui.espresso">UiController</a>&nbsp;uiController,
<a href="../../../../../../../../com/google/android/apps/common/testing/ui/espresso/ViewFinder.html" title="interface in com.google.android.apps.common.testing.ui.espresso">ViewFinder</a>&nbsp;viewFinder,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/concurrent/Executor.html?is-external=true" title="class or interface in java.util.concurrent">Executor</a>&nbsp;mainThreadExecutor,
<a href="../../../../../../../../com/google/android/apps/common/testing/ui/espresso/FailureHandler.html" title="interface in com.google.android.apps.common.testing.ui.espresso">FailureHandler</a>&nbsp;failureHandler,
org.hamcrest.Matcher&lt;android.view.View&gt;&nbsp;viewMatcher,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/concurrent/atomic/AtomicReference.html?is-external=true" title="class or interface in java.util.concurrent.atomic">AtomicReference</a>&lt;org.hamcrest.Matcher&lt;<a href="../../../../../../../../com/google/android/apps/common/testing/ui/espresso/Root.html" title="class in com.google.android.apps.common.testing.ui.espresso">Root</a>&gt;&gt;&nbsp;rootMatcherRef)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="perform(com.google.android.apps.common.testing.ui.espresso.ViewAction...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>perform</h4>
<pre>public&nbsp;<a href="../../../../../../../../com/google/android/apps/common/testing/ui/espresso/ViewInteraction.html" title="class in com.google.android.apps.common.testing.ui.espresso">ViewInteraction</a>&nbsp;perform(<a href="../../../../../../../../com/google/android/apps/common/testing/ui/espresso/ViewAction.html" title="interface in com.google.android.apps.common.testing.ui.espresso">ViewAction</a>...&nbsp;viewActions)</pre>
<div class="block">Performs the given action(s) on the view selected by the current view matcher. If more than one
action is provided, actions are executed in the order provided with precondition checks running
prior to each action.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>viewActions</code> - one or more actions to execute.</dd>
<dt><span class="strong">Returns:</span></dt><dd>this interaction for further perform/verification calls.</dd></dl>
</li>
</ul>
<a name="inRoot(org.hamcrest.Matcher)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>inRoot</h4>
<pre>public&nbsp;<a href="../../../../../../../../com/google/android/apps/common/testing/ui/espresso/ViewInteraction.html" title="class in com.google.android.apps.common.testing.ui.espresso">ViewInteraction</a>&nbsp;inRoot(org.hamcrest.Matcher&lt;<a href="../../../../../../../../com/google/android/apps/common/testing/ui/espresso/Root.html" title="class in com.google.android.apps.common.testing.ui.espresso">Root</a>&gt;&nbsp;rootMatcher)</pre>
<div class="block">Makes this ViewInteraction scoped to the root selected by the given root matcher.</div>
</li>
</ul>
<a name="check(com.google.android.apps.common.testing.ui.espresso.ViewAssertion)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>check</h4>
<pre>public&nbsp;<a href="../../../../../../../../com/google/android/apps/common/testing/ui/espresso/ViewInteraction.html" title="class in com.google.android.apps.common.testing.ui.espresso">ViewInteraction</a>&nbsp;check(<a href="../../../../../../../../com/google/android/apps/common/testing/ui/espresso/ViewAssertion.html" title="interface in com.google.android.apps.common.testing.ui.espresso">ViewAssertion</a>&nbsp;viewAssert)</pre>
<div class="block">Checks the given <a href="../../../../../../../../com/google/android/apps/common/testing/ui/espresso/ViewAssertion.html" title="interface in com.google.android.apps.common.testing.ui.espresso"><code>ViewAssertion</code></a> on the the view selected by the current view matcher.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>viewAssert</code> - the assertion to perform.</dd>
<dt><span class="strong">Returns:</span></dt><dd>this interaction for further perform/verification calls.</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ViewInteraction.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../../com/google/android/apps/common/testing/ui/espresso/ViewFinder.html" title="interface in com.google.android.apps.common.testing.ui.espresso"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../../com/google/android/apps/common/testing/ui/espresso/ViewInteractionModule.html" title="class in com.google.android.apps.common.testing.ui.espresso"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?com/google/android/apps/common/testing/ui/espresso/ViewInteraction.html" target="_top">Frames</a></li>
<li><a href="ViewInteraction.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2014. All rights reserved.</small></p>
</body>
</html>