lightbulb_outline Please take our October 2018 developer survey. Start survey

PositionAssertions

public final class PositionAssertions
extends Object

java.lang.Object
   ↳ androidx.test.espresso.assertion.PositionAssertions


A collection of ViewAssertions for checking relative position of elements on the screen.

These comparisons are on the x,y plane; they ignore the z plane.

Summary

Public methods

static ViewAssertion isAbove(Matcher<View> matcher)

This method is deprecated. Use isCompletelyAbove(Matcher) instead.

static ViewAssertion isBelow(Matcher<View> matcher)

This method is deprecated. Use isCompletelyBelow(Matcher) instead.

static ViewAssertion isBottomAlignedWith(Matcher<View> matcher)

Returns a ViewAssertion that asserts that view displayed is bottom aligned with the view matching the given matcher.

static ViewAssertion isCompletelyAbove(Matcher<View> matcher)

Returns a ViewAssertion that asserts that view displayed is completely above the view matching the given matcher.

static ViewAssertion isCompletelyBelow(Matcher<View> matcher)

Returns a ViewAssertion that asserts that view displayed is completely below the view matching the given matcher.

static ViewAssertion isCompletelyLeftOf(Matcher<View> matcher)

Returns a ViewAssertion that asserts that view displayed is completely left of the view matching the given matcher.

static ViewAssertion isCompletelyRightOf(Matcher<View> matcher)

Returns a ViewAssertion that asserts that view displayed is completely right of the view matching the given matcher.

static ViewAssertion isLeftAlignedWith(Matcher<View> matcher)

Returns a ViewAssertion that asserts that view displayed is left aligned with the view matching the given matcher.

static ViewAssertion isLeftOf(Matcher<View> matcher)

This method is deprecated. Use isCompletelyLeftOf(Matcher) instead.

static ViewAssertion isPartiallyAbove(Matcher<View> matcher)

Returns a ViewAssertion that asserts that view displayed is partially above the view matching the given matcher.

static ViewAssertion isPartiallyBelow(Matcher<View> matcher)

Returns a ViewAssertion that asserts that view displayed is partially below the view matching the given matcher.

static ViewAssertion isPartiallyLeftOf(Matcher<View> matcher)

Returns a ViewAssertion that asserts that view displayed is partially left of the view matching the given matcher.

static ViewAssertion isPartiallyRightOf(Matcher<View> matcher)

Returns a ViewAssertion that asserts that view displayed is partially right of the view matching the given matcher.

static ViewAssertion isRightAlignedWith(Matcher<View> matcher)

Returns a ViewAssertion that asserts that view displayed is right aligned with the view matching the given matcher.

static ViewAssertion isRightOf(Matcher<View> matcher)

This method is deprecated. Use isCompletelyRightOf(Matcher) instead.

static ViewAssertion isTopAlignedWith(Matcher<View> matcher)

Returns a ViewAssertion that asserts that view displayed is top aligned with the view matching the given matcher.

Inherited methods

From class java.lang.Object

Public methods

isAbove

ViewAssertion isAbove (Matcher<View> matcher)

This method is deprecated.
Use isCompletelyAbove(Matcher) instead.

Returns a ViewAssertion that asserts that view displayed is completely above the view matching the given matcher.

Parameters
matcher Matcher

Returns
ViewAssertion

Throws
AssertionFailedError if there is any vertical overlap.
AmbiguousViewMatcherException if more than one view matches the given matcher.
NoMatchingViewException if no views match the given matcher.

isBelow

ViewAssertion isBelow (Matcher<View> matcher)

This method is deprecated.
Use isCompletelyBelow(Matcher) instead.

Returns a ViewAssertion that asserts that view displayed is completely below the view matching the given matcher.

Parameters
matcher Matcher

Returns
ViewAssertion

Throws
AssertionFailedError if there any vertical overlap.
AmbiguousViewMatcherException if more than one view matches the given matcher.
NoMatchingViewException if no views match the given matcher.

isBottomAlignedWith

ViewAssertion isBottomAlignedWith (Matcher<View> matcher)

Returns a ViewAssertion that asserts that view displayed is bottom aligned with the view matching the given matcher.

The bottom 'y' coordinate of the view displayed must equal the bottom 'y' coordinate of the view matching the given matcher.

Parameters
matcher Matcher

Returns
ViewAssertion

Throws
AssertionFailedError if the views are not aligned bottom.
AmbiguousViewMatcherException if more than one view matches the given matcher.
NoMatchingViewException if no views match the given matcher.

isCompletelyAbove

ViewAssertion isCompletelyAbove (Matcher<View> matcher)

Returns a ViewAssertion that asserts that view displayed is completely above the view matching the given matcher.

Parameters
matcher Matcher

Returns
ViewAssertion

Throws
AssertionFailedError if there is any vertical overlap.
AmbiguousViewMatcherException if more than one view matches the given matcher.
NoMatchingViewException if no views match the given matcher.

isCompletelyBelow

ViewAssertion isCompletelyBelow (Matcher<View> matcher)

Returns a ViewAssertion that asserts that view displayed is completely below the view matching the given matcher.

Parameters
matcher Matcher

Returns
ViewAssertion

Throws
AssertionFailedError if there is any vertical overlap.
AmbiguousViewMatcherException if more than one view matches the given matcher.
NoMatchingViewException if no views match the given matcher.

isCompletelyLeftOf

ViewAssertion isCompletelyLeftOf (Matcher<View> matcher)

Returns a ViewAssertion that asserts that view displayed is completely left of the view matching the given matcher.

Parameters
matcher Matcher

Returns
ViewAssertion

Throws
AssertionFailedError if there is any horizontal overlap.
AmbiguousViewMatcherException if more than one view matches the given matcher.
NoMatchingViewException if no views match the given matcher.

isCompletelyRightOf

ViewAssertion isCompletelyRightOf (Matcher<View> matcher)

Returns a ViewAssertion that asserts that view displayed is completely right of the view matching the given matcher.

Parameters
matcher Matcher

Returns
ViewAssertion

Throws
AssertionFailedError if there is any horizontal overlap.
AmbiguousViewMatcherException if more than one view matches the given matcher.
NoMatchingViewException if no views match the given matcher.

isLeftAlignedWith

ViewAssertion isLeftAlignedWith (Matcher<View> matcher)

Returns a ViewAssertion that asserts that view displayed is left aligned with the view matching the given matcher.

The left 'x' coordinate of the view displayed must equal the left 'x' coordinate of the view matching the given matcher.

Parameters
matcher Matcher

Returns
ViewAssertion

Throws
AssertionFailedError if the views are not aligned to the left.
AmbiguousViewMatcherException if more than one view matches the given matcher.
NoMatchingViewException if no views match the given matcher.

isLeftOf

ViewAssertion isLeftOf (Matcher<View> matcher)

This method is deprecated.
Use isCompletelyLeftOf(Matcher) instead.

Returns a ViewAssertion that asserts that view displayed is completely left of the view matching the given matcher.

Parameters
matcher Matcher

Returns
ViewAssertion

Throws
AssertionFailedError if there is any horizontal overlap.
AmbiguousViewMatcherException if more than one view matches the given matcher.
NoMatchingViewException if no views match the given matcher.

isPartiallyAbove

ViewAssertion isPartiallyAbove (Matcher<View> matcher)

Returns a ViewAssertion that asserts that view displayed is partially above the view matching the given matcher.

Parameters
matcher Matcher

Returns
ViewAssertion

Throws
AssertionFailedError if there is no vertical overlap.
AmbiguousViewMatcherException if more than one view matches the given matcher.
NoMatchingViewException if no views match the given matcher.

isPartiallyBelow

ViewAssertion isPartiallyBelow (Matcher<View> matcher)

Returns a ViewAssertion that asserts that view displayed is partially below the view matching the given matcher.

Parameters
matcher Matcher

Returns
ViewAssertion

Throws
AssertionFailedError if there is no vertical overlap.
AmbiguousViewMatcherException if more than one view matches the given matcher.
NoMatchingViewException if no views match the given matcher.

isPartiallyLeftOf

ViewAssertion isPartiallyLeftOf (Matcher<View> matcher)

Returns a ViewAssertion that asserts that view displayed is partially left of the view matching the given matcher.

Parameters
matcher Matcher

Returns
ViewAssertion

Throws
AssertionFailedError if there is no horizontal overlap.
AmbiguousViewMatcherException if more than one view matches the given matcher.
NoMatchingViewException if no views match the given matcher.

isPartiallyRightOf

ViewAssertion isPartiallyRightOf (Matcher<View> matcher)

Returns a ViewAssertion that asserts that view displayed is partially right of the view matching the given matcher.

Parameters
matcher Matcher

Returns
ViewAssertion

Throws
AssertionFailedError if there is no horizontal overlap.
AmbiguousViewMatcherException if more than one view matches the given matcher.
NoMatchingViewException if no views match the given matcher.

isRightAlignedWith

ViewAssertion isRightAlignedWith (Matcher<View> matcher)

Returns a ViewAssertion that asserts that view displayed is right aligned with the view matching the given matcher.

The right 'x' coordinate of the view displayed must equal the right 'x' coordinate of the view matching the given matcher.

Parameters
matcher Matcher

Returns
ViewAssertion

Throws
AssertionFailedError if the views are not aligned to the right.
AmbiguousViewMatcherException if more than one view matches the given matcher.
NoMatchingViewException if no views match the given matcher.

isRightOf

ViewAssertion isRightOf (Matcher<View> matcher)

This method is deprecated.
Use isCompletelyRightOf(Matcher) instead.

Returns a ViewAssertion that asserts that view displayed is completely right of the view matching the given matcher.

Parameters
matcher Matcher

Returns
ViewAssertion

Throws
AssertionFailedError if there is any horizontal overlap.
AmbiguousViewMatcherException if more than one view matches the given matcher.
NoMatchingViewException if no views match the given matcher.

isTopAlignedWith

ViewAssertion isTopAlignedWith (Matcher<View> matcher)

Returns a ViewAssertion that asserts that view displayed is top aligned with the view matching the given matcher.

The top 'y' coordinate of the view displayed must equal the top 'y' coordinate of the view matching the given matcher.

Parameters
matcher Matcher

Returns
ViewAssertion

Throws
AssertionFailedError if the views are not aligned top.
AmbiguousViewMatcherException if more than one view matches the given matcher.
NoMatchingViewException if no views match the given matcher.