io.appium.droiddriver.scroll

Class SentinelStrategy

java.lang.Object

io.appium.droiddriver.scroll.SentinelStrategy

All Implemented Interfaces:

ScrollStepStrategy

Direct Known Subclasses:

DynamicSentinelStrategy, StaticSentinelStrategy

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

A ScrollStepStrategy that determines whether scrolling is possible based on a sentinel.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SentinelStrategy.Getter A Finder for sentinel.
static class	SentinelStrategy.MorePredicateGetter Decorates a SentinelStrategy.Getter by adding another Predicate.

Field Summary

Fields

Modifier and Type	Field and Description
static SentinelStrategy.Getter	FIRST_CHILD_GETTER Returns the first child as the sentinel.
static SentinelStrategy.Getter	LAST_CHILD_GETTER Returns the last child as the sentinel.
static SentinelStrategy.Getter	SECOND_CHILD_GETTER Returns the second child as the sentinel.
static SentinelStrategy.Getter	SECOND_LAST_CHILD_GETTER Returns the second last child as the sentinel.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SentinelStrategy(SentinelStrategy.Getter backwardGetter, SentinelStrategy.Getter forwardGetter, Direction.DirectionConverter directionConverter)

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.
protected UiElement	getSentinel(DroidDriver driver, Finder containerFinder, Direction.PhysicalDirection direction)
java.lang.String	toString() It is recommended that this method return a description to help debugging.

Methods inherited from class java.lang.Object

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

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

scroll

Field Detail

FIRST_CHILD_GETTER

public static final SentinelStrategy.Getter FIRST_CHILD_GETTER

Returns the first child as the sentinel.

LAST_CHILD_GETTER

public static final SentinelStrategy.Getter LAST_CHILD_GETTER

Returns the last child as the sentinel.

SECOND_LAST_CHILD_GETTER

public static final SentinelStrategy.Getter SECOND_LAST_CHILD_GETTER

Returns the second last child as the sentinel. Useful when the activity always shows the last child as an anchor (for example a footer).

Sometimes uiautomatorviewer may not show the anchor as the last child, due to the reordering by layout described in UiElement.getChildren(io.appium.droiddriver.finders.Predicate<? super io.appium.droiddriver.UiElement>). This is not a problem with UiAutomationDriver because it sees the same as uiautomatorviewer does, but could be a problem with InstrumentationDriver.

SECOND_CHILD_GETTER

public static final SentinelStrategy.Getter SECOND_CHILD_GETTER

Returns the second child as the sentinel. Useful when the activity shows a fixed first child.

Constructor Detail

SentinelStrategy

protected SentinelStrategy(SentinelStrategy.Getter backwardGetter,
                           SentinelStrategy.Getter forwardGetter,
                           Direction.DirectionConverter directionConverter)

Method Detail

getSentinel

protected UiElement getSentinel(DroidDriver driver,
                                Finder containerFinder,
                                Direction.PhysicalDirection direction)

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

toString

public java.lang.String toString()

Description copied from interface: ScrollStepStrategy

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

Specified by:

toString in interface ScrollStepStrategy

Overrides:

toString in class java.lang.Object

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