com.applitools.eyes.appium

Class AppiumScrollPositionProvider

java.lang.Object

com.applitools.eyes.appium.AppiumScrollPositionProvider

All Implemented Interfaces:

com.applitools.eyes.positioning.PositionProvider, ScrollPositionProvider

Direct Known Subclasses:

AndroidScrollPositionProvider, IOSScrollPositionProvider

public abstract class AppiumScrollPositionProvider
extends Object
implements ScrollPositionProvider

Field Summary

Fields

Modifier and Type	Field and Description
protected org.openqa.selenium.WebElement	cachedScrollableView
protected com.applitools.eyes.Location	cachedScrollableViewLocation
protected com.applitools.eyes.Region	cachedScrollableViewRegion
protected boolean	cacheScrollableSize
protected com.applitools.eyes.config.ContentInset	contentInset
protected ContentSize	contentSize
protected org.openqa.selenium.WebElement	cutElement
protected double	distanceRatio
protected io.appium.java_client.AppiumDriver	driver
protected EyesAppiumDriver	eyesDriver
protected com.applitools.eyes.Logger	logger
protected org.openqa.selenium.WebElement	scrollRootElement
protected org.openqa.selenium.By	scrollRootElementSelector
protected int	verticalScrollGap

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	cleanupCachedData()
protected ContentSize	getCachedContentSize()
protected org.openqa.selenium.WebElement	getCachedFirstVisibleChild()
int	getCachedFirstVisibleChildHeight()
com.applitools.eyes.Location	getCurrentPosition()
com.applitools.eyes.Location	getCurrentPosition(boolean absolute)
com.applitools.eyes.Location	getCurrentPositionWithoutStatusBar(boolean absolute)
abstract 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	getFirstVisibleChildLocation()
com.applitools.eyes.Location	getScrollableViewLocation()
com.applitools.eyes.Region	getScrollableViewRegion()
com.applitools.eyes.positioning.PositionMemento	getState()
abstract void	restoreState(com.applitools.eyes.positioning.PositionMemento state)
abstract void	scrollTo(int startX, int startY, int endX, int endY, boolean shouldCancel)
void	scrollToBottomRight()
void	setCacheScrollableSize(boolean cacheScrollableSize)
void	setContentInset(com.applitools.eyes.config.ContentInset contentInset)
void	setCutElement(org.openqa.selenium.WebElement cutElement)
void	setScrollRootElement(org.openqa.selenium.WebElement scrollRootElement)
void	setScrollRootElementSelector(org.openqa.selenium.By scrollRootElementSelector)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.applitools.eyes.selenium.positioning.ScrollPositionProvider

setPosition

Methods inherited from interface com.applitools.eyes.positioning.PositionProvider

setPosition

Field Detail

logger

protected final com.applitools.eyes.Logger logger

driver

protected final io.appium.java_client.AppiumDriver driver

eyesDriver

protected final EyesAppiumDriver eyesDriver

distanceRatio

protected double distanceRatio

verticalScrollGap

protected int verticalScrollGap

cutElement

protected org.openqa.selenium.WebElement cutElement

scrollRootElement

protected org.openqa.selenium.WebElement scrollRootElement

scrollRootElementSelector

protected org.openqa.selenium.By scrollRootElementSelector

contentInset

protected com.applitools.eyes.config.ContentInset contentInset

cacheScrollableSize

protected boolean cacheScrollableSize

contentSize

protected ContentSize contentSize

cachedScrollableView

protected org.openqa.selenium.WebElement cachedScrollableView

cachedScrollableViewLocation

protected com.applitools.eyes.Location cachedScrollableViewLocation

cachedScrollableViewRegion

protected com.applitools.eyes.Region cachedScrollableViewRegion

Constructor Detail

AppiumScrollPositionProvider

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

Method Detail

setCutElement

public void setCutElement(org.openqa.selenium.WebElement cutElement)

getCachedFirstVisibleChild

protected org.openqa.selenium.WebElement getCachedFirstVisibleChild()

getCachedContentSize

protected ContentSize getCachedContentSize()

getScrollableViewLocation

public com.applitools.eyes.Location getScrollableViewLocation()

getScrollableViewRegion

public com.applitools.eyes.Region getScrollableViewRegion()

getFirstVisibleChildLocation

public com.applitools.eyes.Location getFirstVisibleChildLocation()

getCurrentPosition

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

Returns:

The scroll position of the current frame.

getCurrentPositionWithoutStatusBar

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

getCurrentPosition

public com.applitools.eyes.Location getCurrentPosition()

Specified by:

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

getEntireSize

public com.applitools.eyes.RectangleSize getEntireSize()

Specified by:

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

Returns:

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

getState

public com.applitools.eyes.positioning.PositionMemento getState()

Specified by:

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

restoreState

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

Specified by:

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

scrollToBottomRight

public void scrollToBottomRight()

scrollTo

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

getElementRegion

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

getFirstScrollableView

protected org.openqa.selenium.WebElement getFirstScrollableView()

cleanupCachedData

public void cleanupCachedData()

setScrollRootElement

public void setScrollRootElement(org.openqa.selenium.WebElement scrollRootElement)

setScrollRootElementSelector

public void setScrollRootElementSelector(org.openqa.selenium.By scrollRootElementSelector)

setContentInset

public void setContentInset(com.applitools.eyes.config.ContentInset contentInset)

setCacheScrollableSize

public void setCacheScrollableSize(boolean cacheScrollableSize)

getCachedFirstVisibleChildHeight

public int getCachedFirstVisibleChildHeight()