io.appium.droiddriver.scroll

Class DynamicSentinelStrategy

java.lang.Object

io.appium.droiddriver.scroll.SentinelStrategy

io.appium.droiddriver.scroll.DynamicSentinelStrategy

All Implemented Interfaces:

ScrollStepStrategy

public class DynamicSentinelStrategy
extends SentinelStrategy

Determines whether scrolling is possible by checking whether the sentinel child is updated after scrolling. Use this when UiElement.getChildren(io.appium.droiddriver.finders.Predicate<? super io.appium.droiddriver.UiElement>) is not reliable. This can happen, for instance, when UiAutomationDriver is used, which skips invisible children, or in the case of dynamic list, which shows more items when scrolling beyond the end.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DynamicSentinelStrategy.ContentDescriptionUpdated Determines whether the sentinel is updated by checking the content description of a descendant element of the sentinel (or itself).
static interface	DynamicSentinelStrategy.IsUpdatedStrategy Interface for determining whether sentinel is updated.
static class	DynamicSentinelStrategy.ResourceIdUpdated Determines whether the sentinel is updated by checking the resource-id of a descendant element of the sentinel (often itself).
static class	DynamicSentinelStrategy.SingleStringUpdated Determines whether the sentinel is updated by checking a single unique String attribute of a descendant element of the sentinel (or itself).
static class	DynamicSentinelStrategy.TextUpdated Determines whether the sentinel is updated by checking the text of a descendant element of the sentinel (or itself).

Nested classes/interfaces inherited from class io.appium.droiddriver.scroll.SentinelStrategy

SentinelStrategy.Getter, SentinelStrategy.MorePredicateGetter

Field Summary

Fields inherited from class io.appium.droiddriver.scroll.SentinelStrategy

FIRST_CHILD_GETTER, LAST_CHILD_GETTER, SECOND_CHILD_GETTER, SECOND_LAST_CHILD_GETTER

Constructor Summary

Constructors

Constructor and Description
DynamicSentinelStrategy(DynamicSentinelStrategy.IsUpdatedStrategy isUpdatedStrategy, SentinelStrategy.Getter backwardGetter) Defaults to LAST_CHILD_GETTER for forward scrolling, and the standard Direction.DirectionConverter.
DynamicSentinelStrategy(DynamicSentinelStrategy.IsUpdatedStrategy isUpdatedStrategy, SentinelStrategy.Getter backwardGetter, SentinelStrategy.Getter forwardGetter) Defaults to the standard Direction.DirectionConverter.
DynamicSentinelStrategy(DynamicSentinelStrategy.IsUpdatedStrategy isUpdatedStrategy, SentinelStrategy.Getter backwardGetter, SentinelStrategy.Getter forwardGetter, Direction.DirectionConverter directionConverter) Constructs with Getters that decorate the given Getters with UiElement.VISIBLE, and the given isUpdatedStrategy and 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	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.
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.

Methods inherited from class io.appium.droiddriver.scroll.SentinelStrategy

doScroll, getDirectionConverter, getSentinel

Methods inherited from class java.lang.Object

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

Constructor Detail

DynamicSentinelStrategy

public DynamicSentinelStrategy(DynamicSentinelStrategy.IsUpdatedStrategy isUpdatedStrategy,
                               SentinelStrategy.Getter backwardGetter,
                               SentinelStrategy.Getter forwardGetter,
                               Direction.DirectionConverter directionConverter)

Constructs with Getters that decorate the given Getters with UiElement.VISIBLE, and the given isUpdatedStrategy and directionConverter. Be careful with Getters: the sentinel after each scroll should be unique.

DynamicSentinelStrategy

public DynamicSentinelStrategy(DynamicSentinelStrategy.IsUpdatedStrategy isUpdatedStrategy,
                               SentinelStrategy.Getter backwardGetter,
                               SentinelStrategy.Getter forwardGetter)

Defaults to the standard Direction.DirectionConverter.

DynamicSentinelStrategy

public DynamicSentinelStrategy(DynamicSentinelStrategy.IsUpdatedStrategy isUpdatedStrategy,
                               SentinelStrategy.Getter backwardGetter)

Defaults to LAST_CHILD_GETTER for forward scrolling, and the standard Direction.DirectionConverter.

Method Detail

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.

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

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

Overrides:

beginScrolling in class SentinelStrategy

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

Overrides:

endScrolling in class SentinelStrategy

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 SentinelStrategy