com.atlassian.webdriver.visualcomparison

Class WebDriverBrowserEngine

java.lang.Object

com.atlassian.webdriver.visualcomparison.WebDriverBrowserEngine

All Implemented Interfaces:

BrowserEngine

public final class WebDriverBrowserEngine
extends Object
implements BrowserEngine

Since:

2.3

Constructor Summary

Constructors

Constructor and Description
WebDriverBrowserEngine(org.openqa.selenium.WebDriver webDriver)

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebDriverBrowserEngine

@Inject
public WebDriverBrowserEngine(@Nonnull
                                      org.openqa.selenium.WebDriver webDriver)

Method Detail

getElementAt

@Nonnull
public ScreenElement getElementAt(int x,
                                           int y)

Description copied from interface: BrowserEngine

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

Specified by:

getElementAt in interface BrowserEngine

Parameters:

x - x coordinate of the point of interest

y - y coordinate of the point of interest

Returns:

element at (x,y)

resizeTo

@Nonnull
public BrowserEngine resizeTo(@Nonnull
                                       Resolution resolution)

Description copied from interface: BrowserEngine

Resize the browser window to the given resolution.

Specified by:

resizeTo in interface BrowserEngine

Parameters:

resolution - resolution to resize to

Returns:

this engine instance for chaining.

captureScreenshotTo

@Nonnull
public BrowserEngine captureScreenshotTo(@Nonnull
                                                  File file)

Description copied from interface: BrowserEngine

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

Specified by:

captureScreenshotTo in interface BrowserEngine

Parameters:

file - file to store the screenshot in

Returns:

this engine instance for chaining.

reloadPage

@Nonnull
public BrowserEngine reloadPage()

Description copied from interface: BrowserEngine

Refresh the current page.

Specified by:

reloadPage in interface BrowserEngine

Returns:

this engine instance for chaining.

executeScript

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

Description copied from interface: BrowserEngine

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

Specified by:

executeScript in interface BrowserEngine

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