ViewMatchers

A replacement for MatcherAssert.assertThat that renders View objects nicely.

A replacement for MatcherAssert.assertThat that renders View objects nicely.

Returns a matcher that matches View based on background resource.

Note: This method compares images at a pixel level and might have significant performance implications for larger bitmaps.

This API is currently in beta.

Matches a ViewGroup if it has exactly the specified number of children.

Returns an Matcher that matches Views with any content description.

Returns a matcher that matches Views based on the presence of a descendant in its view hierarchy.

Returns a matcher that matches EditText based on edit text error string value.

Note: Sugar for hasErrorText(is("string")).

Returns a matcher that matches EditText based on edit text error string value.

Note: View's error property can be null, to match against it use hasErrorText(nullValue(String.class)

Returns a matcher that matches Views currently have focus.

Returns a matcher that matches views that support input methods (e.g. EditText) and have the specified IME action set in its EditorInfo.

Returns a matcher that matches views that support input methods (e.g. EditText) and have the specified IME action set in its EditorInfo.

Returns a matcher that matches TextViews that have links.

Matches a ViewGroup if it has at least the specified number of children.

Returns an Matcher that matches Views based on their siblings.

This may be particularly useful when a view cannot be uniquely selected on properties such as text or R.id. For example: a call button is repeated several times in a contacts layout and the only way to differentiate the call button view is by what appears next to it (e.g. the unique name of the contact).

Returns a matcher that matches TextView based on it's color.

This API is currently in beta.

Matches Views based on instance or subclass of the provided class.

Some versions of Hamcrest make the generic typing of this a nightmare, so we have a special case for our users.

Returns a matcher that accepts if and only if the view is a CompoundButton (or subtype of) and is in checked state.

Returns a matcher that matches Views that are clickable.

Returns a matcher which only accepts a view whose height and width fit perfectly within the currently displayed region of this view.

There exist views (such as ScrollViews) whose height and width are larger then the physical device screen by design. Such views will never be completely displayed.

Returns a matcher that matches Views based on the given ancestor type.

Returns a matcher that matches Views that are currently displayed on the screen to the user.

Note: isDisplayed will select views that are partially displayed (eg: the full height/width of the view is greater than the height/width of the visible rectangle). If you wish to ensure the entire rectangle this view draws is displayed to the user use isCompletelyDisplayed().

Returns a matcher which accepts a view so long as a given percentage of that view's area is not obscured by any parent view and is thus visible to the user.

Returns a matcher that matches Views that are enabled.

Returns a matcher that matches Views that are focusable.

Returns a matcher that matches WebView if they are evaluating JavaScript.

Returns a matcher that accepts if and only if the view is a CompoundButton (or subtype of) and is not in checked state.

Returns a matcher that matches root View.

Returns a matcher that matches Views that are selected.

Returns a matcher that matches views that support input methods.

Matches Views with the specified alpha value.

Returns true only if the view's child is accepted by the provided matcher.

Returns a matcher that matches Views with class name matching the given matcher.

Returns a Matcher that matches Views based on content description property value.

Returns an Matcher that matches Views based on content description's text value.

Returns an Matcher that matches Views based on content description property value.

Returns a matcher that matches Views that have "effective" visibility set to the given value.

Effective visibility takes into account not only the view's visibility value, but also that of its ancestors. In case of ERROR(/View.VISIBLE), this means that the view and all of its ancestors have visibility=VISIBLE. In case of GONE and INVISIBLE, it's the opposite - any GONE or INVISIBLE parent will make all of its children have their effective visibility.

Note: Contrary to what the name may imply, view visibility does not directly translate into whether the view is displayed on screen (use isDisplayed() for that). For example, the view and all of its ancestors can have visibility=VISIBLE, but the view may need to be scrolled to in order to be actually visible to the user. Unless you're specifically targeting the visibility value with your test, use isDisplayed().

Returns a matcher that matches TextViews based on hint property value.

Note: View's hint property can be null, to match against it use withHint(nullValue(String.class)

Returns a matcher that matches a descendant of TextView that is displaying the hint associated with the given resource id.

Returns a matcher that matches TextView based on it's hint property value.

Note: View's sugar for withHint(is("string")).

Returns a matcher that matches Views based on resource ids. Note: Android resource ids are not guaranteed to be unique. You may have to pair this matcher with another one to guarantee a unique view selection.

A matcher that matches Views based on its resource id.

Same as withId(is(int)) but attempts to look up resource name of the given id and use a R.id.myView style description with describeTo. If resource lookup is unavailable, at the time describeTo is invoked, this will print out a simple "with id: %d". If the lookup for a given id fails, "with id: %d (resource name not found)" will be returned as the description.

Note: Android resource ids are not guaranteed to be unique. You may have to pair this matcher with another one to guarantee a unique view selection.

Returns a matcher that matches InputType.

A matcher that accepts a view if and only if the view's parent is accepted by the provided matcher.

Returns a matcher that matches the child index inside the ViewParent.

Returns a matcher that matches Views based on resource id names, (for instance, channel_avatar).

Returns a matcher that matches Views based on resource id names, (for instance, channel_avatar).

Returns a matcher that matches a descendant of Spinner that is displaying the string of the selected item associated with the given resource id.

Returns a matcher that matches Spinner based on it's selected item's toString value.

Note: Sugar for withSpinnerText(is("string")).

Returns a matcher that matches Spinner's based on toString value of the selected item.

Returns a matcher that matches TextView that contains the specific substring.

Note: View's sugar for withText(containsString("string")).

Returns a matcher that matches Views based on tag keys.

Returns a matcher that matches View based on tag keys.

Returns a matcher that matches Views based on tag property values.

Returns a matcher that matches TextViews based on text property value.

Note: A View text property is never null. If you call setText(CharSequence) with a null value it will still be "" (empty string). Do not use a null matcher.

Returns a matcher that matches TextView based on its text property value.

Note: View's sugar for withText(is("string")).

Returns a matcher that matches a descendant of TextView that is displaying the string associated with the given resource id.