io.appium.droiddriver.scroll

Interface ScrollStepStrategy

All Known Implementing Classes:

AccessibilityEventScrollStepStrategy, AccessibilityEventScrollStepStrategy.NullAccessibilityEventScrollStepStrategy, DynamicSentinelStrategy, ForwardingScrollStepStrategy, Scrollers.ProgressBarScrollStepStrategy, SentinelStrategy, StaticSentinelStrategy

public interface ScrollStepStrategy

Interface for determining whether scrolling is possible.

Method Summary

Modifier and Type	Method and Description
void	beginScrolling(DroidDriver driver, Finder containerFinder, Finder itemFinder, Direction.PhysicalDirection direction) Called only if this step is at the beginning of a series of scroll steps with regard to the given arguments.
void	doScroll(UiElement container, Direction.PhysicalDirection direction) Performs the scroll action on container.
void	endScrolling(DroidDriver driver, Finder containerFinder, Finder itemFinder, Direction.PhysicalDirection direction) Called only if this step is at the end of a series of scroll steps with regard to the given arguments.
Direction.DirectionConverter	getDirectionConverter() Returns the Direction.DirectionConverter.
boolean	scroll(DroidDriver driver, Finder containerFinder, Direction.PhysicalDirection direction) Tries to scroll containerFinder in direction.
java.lang.String	toString() It is recommended that this method return a description to help debugging.

Method Detail

scroll

boolean scroll(DroidDriver driver,
               Finder containerFinder,
               Direction.PhysicalDirection direction)

Tries to scroll containerFinder in direction. Returns whether scrolling is effective.

Parameters:

driver - a DroidDriver instance

containerFinder - Finder for the container that can scroll, for instance a ListView

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

Returns:

whether scrolling is effective

getDirectionConverter

Direction.DirectionConverter getDirectionConverter()

Returns the Direction.DirectionConverter.

beginScrolling

void beginScrolling(DroidDriver driver,
                    Finder containerFinder,
                    Finder itemFinder,
                    Direction.PhysicalDirection direction)

Called only if this step is at the beginning of a series of scroll steps with regard to the given arguments.

Parameters:

driver - a DroidDriver instance

containerFinder - Finder for the container that can scroll, for instance a ListView

itemFinder - Finder for the desired item; relative to containerFinder

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

endScrolling

void endScrolling(DroidDriver driver,
                  Finder containerFinder,
                  Finder itemFinder,
                  Direction.PhysicalDirection direction)

Called only if this step is at the end of a series of scroll steps with regard to the given arguments.

Parameters:

driver - a DroidDriver instance

containerFinder - Finder for the container that can scroll, for instance a ListView

itemFinder - Finder for the desired item; relative to containerFinder

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

doScroll

void doScroll(UiElement container,
              Direction.PhysicalDirection direction)

Performs the scroll action on container. Subclasses can override this to customize the scroll action, for example, to adjust the scroll margins.

Parameters:

container - the container that can scroll

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

toString

java.lang.String toString()

It is recommended that this method return a description to help debugging.

Overrides:

toString in class java.lang.Object