com.applitools.eyes.appium

Class AppiumScrollPositionProvider

java.lang.Object

com.applitools.eyes.appium.AppiumScrollPositionProvider

All Implemented Interfaces:

PositionProvider, ScrollingPositionProvider, SeleniumScrollingPositionProvider

Direct Known Subclasses:

AndroidScrollPositionProvider, IOSScrollPositionProvider

public abstract class AppiumScrollPositionProvider
extends Object
implements SeleniumScrollingPositionProvider

Field Summary

Fields

Modifier and Type	Field and Description
protected ContentSize	contentSize
protected org.openqa.selenium.WebElement	cutElement
protected double	distanceRatio
protected io.appium.java_client.AppiumDriver	driver
protected EyesAppiumDriver	eyesDriver
protected Logger	logger
protected int	verticalScrollGap

Constructor Summary

Constructors

Constructor and Description
AppiumScrollPositionProvider(Logger logger, EyesAppiumDriver driver)

Method Summary

Modifier and Type	Method and Description
protected ContentSize	getCachedContentSize()
protected org.openqa.selenium.WebElement	getCachedFirstVisibleChild()
Location	getCurrentPosition()
Location	getCurrentPosition(boolean absolute)
Location	getCurrentPositionWithoutStatusBar(boolean absolute)
abstract Region	getElementRegion(org.openqa.selenium.WebElement element, boolean shouldStitchContent, Boolean statusBarExists)
RectangleSize	getEntireSize()
Location	getFirstVisibleChildLocation()
Location	getScrollableViewLocation()
Region	getScrollableViewRegion()
PositionMemento	getState()
abstract void	restoreState(PositionMemento state)
abstract Location	scrollDown(boolean returnAbsoluteLocation)
abstract void	scrollTo(int startX, int startY, int endX, int endY, boolean shouldCancel)
void	scrollToBottomRight()
void	setCutElement(org.openqa.selenium.WebElement cutElement)
void	setPosition(Frame frame)
abstract void	setPosition(Location location)
abstract void	setPosition(org.openqa.selenium.WebElement element)

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final 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

contentSize

protected ContentSize contentSize

Constructor Detail

AppiumScrollPositionProvider

public AppiumScrollPositionProvider(Logger logger,
                                    EyesAppiumDriver driver)

Method Detail

setCutElement

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

getCachedFirstVisibleChild

protected org.openqa.selenium.WebElement getCachedFirstVisibleChild()

getCachedContentSize

@Nullable
protected ContentSize getCachedContentSize()

getScrollableViewLocation

public Location getScrollableViewLocation()

getScrollableViewRegion

public Region getScrollableViewRegion()

getFirstVisibleChildLocation

public Location getFirstVisibleChildLocation()

getCurrentPosition

public Location getCurrentPosition(boolean absolute)

Returns:

The scroll position of the current frame.

getCurrentPositionWithoutStatusBar

public Location getCurrentPositionWithoutStatusBar(boolean absolute)

getCurrentPosition

public Location getCurrentPosition()

Specified by:

getCurrentPosition in interface PositionProvider

setPosition

public abstract void setPosition(Location location)

Specified by:

setPosition in interface PositionProvider

setPosition

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

Specified by:

setPosition in interface SeleniumScrollingPositionProvider

setPosition

public void setPosition(Frame frame)

Specified by:

setPosition in interface SeleniumScrollingPositionProvider

getEntireSize

public RectangleSize getEntireSize()

Specified by:

getEntireSize in interface PositionProvider

Returns:

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

getState

public PositionMemento getState()

Specified by:

getState in interface PositionProvider

restoreState

public abstract void restoreState(PositionMemento state)

Specified by:

restoreState in interface PositionProvider

scrollToBottomRight

public void scrollToBottomRight()

Specified by:

scrollToBottomRight in interface ScrollingPositionProvider

scrollDown

public abstract Location scrollDown(boolean returnAbsoluteLocation)

scrollTo

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

getElementRegion

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