io.appium.droiddriver.scroll

Class ForwardingScrollStepStrategy

java.lang.Object

io.appium.droiddriver.scroll.ForwardingScrollStepStrategy

All Implemented Interfaces:

ScrollStepStrategy

Direct Known Subclasses:

Scrollers.ProgressBarScrollStepStrategy

public abstract class ForwardingScrollStepStrategy
extends java.lang.Object
implements ScrollStepStrategy

An abstract base class for implementing the decorator pattern, forwarding calls to all methods of ScrollStepStrategy to delegate.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ForwardingScrollStepStrategy()

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.
protected abstract ScrollStepStrategy	delegate() Returns the backing delegate instance that methods are forwarded to.
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.appium.droiddriver.scroll.ScrollStepStrategy

toString

Constructor Detail

ForwardingScrollStepStrategy

protected ForwardingScrollStepStrategy()

Method Detail

delegate

protected abstract ScrollStepStrategy delegate()

Returns the backing delegate instance that methods are forwarded to.

scroll

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

Description copied from interface: ScrollStepStrategy

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

Specified by:

scroll in interface ScrollStepStrategy

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

public final Direction.DirectionConverter getDirectionConverter()

Description copied from interface: ScrollStepStrategy

Returns the Direction.DirectionConverter.

Specified by:

getDirectionConverter in interface ScrollStepStrategy

beginScrolling

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

Description copied from interface: ScrollStepStrategy

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

Specified by:

beginScrolling in interface ScrollStepStrategy

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

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

Description copied from interface: ScrollStepStrategy

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

Specified by:

endScrolling in interface ScrollStepStrategy

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

public void doScroll(UiElement container,
                     Direction.PhysicalDirection direction)

Description copied from interface: ScrollStepStrategy

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

Specified by:

doScroll in interface ScrollStepStrategy

Parameters:

container - the container that can scroll

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