com.applitools.eyes.positioning

Interface PositionProvider

All Known Implementing Classes:

InvalidPositionProvider

public interface PositionProvider

Encapsulates page/element positioning.

Method Summary

Modifier and Type	Method and Description
Location	getCurrentPosition()
RectangleSize	getEntireSize()
PositionMemento	getState() Get the current state of the position provider.
void	restoreState(PositionMemento state) Restores the state of the position provider to the state provided as a parameter.
Location	setPosition(Location location) Go to the specified location.

Method Detail

getCurrentPosition

Location getCurrentPosition()

Returns:

The current position, or null if position is not available.

setPosition

Location setPosition(Location location)

Go to the specified location.

Parameters:

location - The position to set.

getEntireSize

RectangleSize getEntireSize()

Returns:

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

getState

PositionMemento getState()

Get the current state of the position provider. This is different from getCurrentPosition() in that the state of the position provider might include other model than just the coordinates. For example a CSS translation based position provider (in WebDriver based SDKs), might save the entire "transform" style value as its state.

Returns:

The current state of the position provider, which can later be restored by passing it as a parameter to restoreState(com.applitools.eyes.positioning.PositionMemento).

restoreState

void restoreState(PositionMemento state)

Restores the state of the position provider to the state provided as a parameter.

Parameters:

state - The state to restore to.