io.appium.droiddriver.helpers

Class ScrollerHelper

java.lang.Object

io.appium.droiddriver.helpers.ScrollerHelper

public class ScrollerHelper
extends java.lang.Object

Helper for Scroller.

Constructor Summary

Constructors

Constructor and Description
ScrollerHelper(Scroller scroller, DroidDriver driver, Finder containerFinder)

Method Summary

Modifier and Type	Method and Description
boolean	canScrollTo(Finder itemFinder) Scrolls to itemFinder and returns true, otherwise returns false.
UiElement	scrollTo(Finder itemFinder) Scrolls containerFinder in both directions if necessary to find itemFinder, which is a descendant of containerFinder.
UiElement	scrollTo(Finder itemFinder, Direction.PhysicalDirection direction) Scrolls containerFinder in direction if necessary to find itemFinder, which is a descendant of containerFinder.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScrollerHelper

public ScrollerHelper(Scroller scroller,
                      DroidDriver driver,
                      Finder containerFinder)

Method Detail

scrollTo

public UiElement scrollTo(Finder itemFinder)

Scrolls containerFinder in both directions if necessary to find itemFinder, which is a descendant of containerFinder.

Parameters:

itemFinder - Finder for the desired item; relative to containerFinder

Returns:

the UiElement matching itemFinder

Throws:

ElementNotFoundException - If no match is found

scrollTo

public UiElement scrollTo(Finder itemFinder,
                          Direction.PhysicalDirection direction)

Scrolls containerFinder in direction if necessary to find itemFinder, which is a descendant of containerFinder.

Parameters:

itemFinder - Finder for the desired item; relative to containerFinder

direction - specifies where the view port will move instead of the finger

Returns:

the UiElement matching itemFinder

Throws:

ElementNotFoundException - If no match is found

canScrollTo

public boolean canScrollTo(Finder itemFinder)

Scrolls to itemFinder and returns true, otherwise returns false.

Parameters:

itemFinder - Finder for the desired item

Returns:

true if successful, otherwise false