com.applitools.eyes.appium

Class AndroidScrollPositionProvider

java.lang.Object

com.applitools.eyes.appium.AppiumScrollPositionProvider

com.applitools.eyes.appium.AndroidScrollPositionProvider

All Implemented Interfaces:

com.applitools.eyes.positioning.PositionProvider, ScrollPositionProvider

public class AndroidScrollPositionProvider
extends AppiumScrollPositionProvider

Field Summary

Fields inherited from class com.applitools.eyes.appium.AppiumScrollPositionProvider

cachedScrollableView, cachedScrollableViewLocation, cachedScrollableViewRegion, cacheScrollableSize, contentInset, contentSize, cutElement, distanceRatio, driver, eyesDriver, logger, scrollRootElement, scrollRootElementSelector, verticalScrollGap

Constructor Summary

Constructors

Constructor and Description
AndroidScrollPositionProvider(com.applitools.eyes.Logger logger, EyesAppiumDriver driver)

Method Summary

Modifier and Type	Method and Description
void	cleanupCachedData()
int	getBehaviorOffsetWithHelperLibrary()
com.applitools.eyes.Location	getCurrentPosition(boolean absolute)
com.applitools.eyes.Location	getCurrentPositionWithoutStatusBar(boolean absolute)
com.applitools.eyes.Region	getElementRegion(org.openqa.selenium.WebElement element, boolean shouldStitchContent, Boolean statusBarExists)
com.applitools.eyes.RectangleSize	getEntireSize()
protected org.openqa.selenium.WebElement	getFirstScrollableView()
com.applitools.eyes.Location	getScrollableViewLocation()
com.applitools.eyes.Region	getScrollableViewRegion()
boolean	moveToTop(String elementId)
void	restoreState(com.applitools.eyes.positioning.PositionMemento state)
com.applitools.eyes.Location	scrollDown(boolean returnAbsoluteLocation)
void	scrollTo(int startX, int startY, int endX, int endY, boolean shouldCancel)
com.applitools.eyes.Location	setPosition(com.applitools.eyes.Location location)
void	setPosition(org.openqa.selenium.WebElement element)
void	tryDumpVHSWithHelperLibrary()
String	tryGetClassWithHelperLibrary()
boolean	tryScrollBehaviorOffsetWithHelperLibrary(String elementId, int offset)
boolean	tryScrollWithHelperLibrary(String elementId, int offset, int step, int totalSteps)

Methods inherited from class com.applitools.eyes.appium.AppiumScrollPositionProvider

getCachedContentSize, getCachedFirstVisibleChild, getCachedFirstVisibleChildHeight, getCurrentPosition, getFirstVisibleChildLocation, getState, scrollToBottomRight, setCacheScrollableSize, setContentInset, setCutElement, setScrollRootElement, setScrollRootElementSelector

Methods inherited from class java.lang.Object

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

Constructor Detail

AndroidScrollPositionProvider

public AndroidScrollPositionProvider(com.applitools.eyes.Logger logger,
                                     EyesAppiumDriver driver)

Method Detail

getScrollableViewLocation

public com.applitools.eyes.Location getScrollableViewLocation()

Overrides:

getScrollableViewLocation in class AppiumScrollPositionProvider

getScrollableViewRegion

public com.applitools.eyes.Region getScrollableViewRegion()

Overrides:

getScrollableViewRegion in class AppiumScrollPositionProvider

getCurrentPosition

public com.applitools.eyes.Location getCurrentPosition(boolean absolute)

Overrides:

getCurrentPosition in class AppiumScrollPositionProvider

Returns:

The scroll position of the current frame.

getCurrentPositionWithoutStatusBar

public com.applitools.eyes.Location getCurrentPositionWithoutStatusBar(boolean absolute)

Overrides:

getCurrentPositionWithoutStatusBar in class AppiumScrollPositionProvider

setPosition

public com.applitools.eyes.Location setPosition(com.applitools.eyes.Location location)

setPosition

public void setPosition(org.openqa.selenium.WebElement element)

restoreState

public void restoreState(com.applitools.eyes.positioning.PositionMemento state)

Specified by:

restoreState in interface com.applitools.eyes.positioning.PositionProvider

Specified by:

restoreState in class AppiumScrollPositionProvider

scrollDown

public com.applitools.eyes.Location scrollDown(boolean returnAbsoluteLocation)

scrollTo

public void scrollTo(int startX,
                     int startY,
                     int endX,
                     int endY,
                     boolean shouldCancel)

Specified by:

scrollTo in class AppiumScrollPositionProvider

tryScrollWithHelperLibrary

public boolean tryScrollWithHelperLibrary(String elementId,
                                          int offset,
                                          int step,
                                          int totalSteps)

moveToTop

public boolean moveToTop(String elementId)

getBehaviorOffsetWithHelperLibrary

public int getBehaviorOffsetWithHelperLibrary()

tryScrollBehaviorOffsetWithHelperLibrary

public boolean tryScrollBehaviorOffsetWithHelperLibrary(String elementId,
                                                        int offset)

tryGetClassWithHelperLibrary

public String tryGetClassWithHelperLibrary()

tryDumpVHSWithHelperLibrary

public void tryDumpVHSWithHelperLibrary()

getElementRegion

public com.applitools.eyes.Region getElementRegion(org.openqa.selenium.WebElement element,
                                                   boolean shouldStitchContent,
                                                   Boolean statusBarExists)

Specified by:

getElementRegion in class AppiumScrollPositionProvider

getEntireSize

public com.applitools.eyes.RectangleSize getEntireSize()

Specified by:

getEntireSize in interface com.applitools.eyes.positioning.PositionProvider

Overrides:

getEntireSize in class AppiumScrollPositionProvider

Returns:

The entire size of the container which the position is relative to.

getFirstScrollableView

protected org.openqa.selenium.WebElement getFirstScrollableView()

Overrides:

getFirstScrollableView in class AppiumScrollPositionProvider

cleanupCachedData

public void cleanupCachedData()

Overrides:

cleanupCachedData in class AppiumScrollPositionProvider