com.atlassian.selenium.visualcomparison.v2

Interface BrowserEngine

All Known Implementing Classes:

WebDriverBrowserEngine

@ExperimentalApi
 @PublicSpi
public interface BrowserEngine

An SPI to hook in the browser automation framework used to drive the visual comparison.

Since:

2.3

Method Summary

Modifier and Type	Method and Description
BrowserEngine	captureScreenshotTo(File file) Capture a screenshot of the current page.
<T> T	executeScript(Class<T> returnType, String script, Object... args) Execute a Javascript snippet in the context of the current page.
ScreenElement	getElementAt(int x, int y) Get an element that is closest to the point in the document specified by x and y.
BrowserEngine	reloadPage() Refresh the current page.
BrowserEngine	resizeTo(Resolution resolution) Resize the browser window to the given resolution.

Method Detail

getElementAt

@Nonnull
ScreenElement getElementAt(int x,
                                    int y)

Get an element that is closest to the point in the document specified by x and y.

Parameters:

x - x coordinate of the point of interest

y - y coordinate of the point of interest

Returns:

element at (x,y)

resizeTo

@Nonnull
BrowserEngine resizeTo(@Nonnull
                                Resolution resolution)

Resize the browser window to the given resolution.

Parameters:

resolution - resolution to resize to

Returns:

this engine instance for chaining.

captureScreenshotTo

@Nonnull
BrowserEngine captureScreenshotTo(@Nonnull
                                           File file)

Capture a screenshot of the current page. This should be an entire document and not just contents of the viewport.

Parameters:

file - file to store the screenshot in

Returns:

this engine instance for chaining.

reloadPage

@Nonnull
BrowserEngine reloadPage()

Refresh the current page.

Returns:

this engine instance for chaining.

executeScript

@Nullable
<T> T executeScript(@Nonnull
                              Class<T> returnType,
                              @Nonnull
                              String script,
                              @Nonnull
                              Object... args)

Execute a Javascript snippet in the context of the current page.

Type Parameters:

T - return type parameter

Parameters:

returnType - expected return type. At the very least String, Boolean and Long should be supported.

script - script to execute

args - arguments to the script

Returns:

result of the script

Throws:

ClassCastException - if the result type was different than expected