com.applitools.eyes

Class EyesWebDriver

java.lang.Object

com.applitools.eyes.EyesWebDriver

All Implemented Interfaces:

org.openqa.selenium.HasCapabilities, org.openqa.selenium.interactions.HasInputDevices, org.openqa.selenium.interactions.HasTouchScreen, org.openqa.selenium.internal.FindsByClassName, org.openqa.selenium.internal.FindsByCssSelector, org.openqa.selenium.internal.FindsById, org.openqa.selenium.internal.FindsByLinkText, org.openqa.selenium.internal.FindsByName, org.openqa.selenium.internal.FindsByTagName, org.openqa.selenium.internal.FindsByXPath, org.openqa.selenium.JavascriptExecutor, org.openqa.selenium.SearchContext, org.openqa.selenium.TakesScreenshot, org.openqa.selenium.WebDriver

public class EyesWebDriver
extends Object
implements org.openqa.selenium.HasCapabilities, org.openqa.selenium.interactions.HasInputDevices, org.openqa.selenium.internal.FindsByClassName, org.openqa.selenium.internal.FindsByCssSelector, org.openqa.selenium.internal.FindsById, org.openqa.selenium.internal.FindsByLinkText, org.openqa.selenium.internal.FindsByName, org.openqa.selenium.internal.FindsByTagName, org.openqa.selenium.internal.FindsByXPath, org.openqa.selenium.JavascriptExecutor, org.openqa.selenium.SearchContext, org.openqa.selenium.TakesScreenshot, org.openqa.selenium.WebDriver, org.openqa.selenium.interactions.HasTouchScreen

An Eyes implementation of the interfaces implemented by RemoteWebDriver. Used so we'll be able to return the users an object with the same functionality as RemoteWebDriver.

Nested Class Summary

Nested classes/interfaces inherited from interface org.openqa.selenium.WebDriver

org.openqa.selenium.WebDriver.ImeHandler, org.openqa.selenium.WebDriver.Navigation, org.openqa.selenium.WebDriver.Options, org.openqa.selenium.WebDriver.TargetLocator, org.openqa.selenium.WebDriver.Timeouts, org.openqa.selenium.WebDriver.Window

Constructor Summary

Constructors

Constructor and Description
EyesWebDriver(com.applitools.eyes.Logger logger, Eyes eyes, org.openqa.selenium.remote.RemoteWebDriver driver)

Method Summary

Modifier and Type	Method and Description
void	close()
Object	executeAsyncScript(String script, Object... args)
Object	executeScript(String script, Object... args)
protected int	extractViewportHeight()
protected int	extractViewportWidth()
org.openqa.selenium.WebElement	findElement(org.openqa.selenium.By by)
org.openqa.selenium.WebElement	findElementByClassName(String className)
org.openqa.selenium.WebElement	findElementByCssSelector(String cssSelector)
org.openqa.selenium.WebElement	findElementById(String id)
org.openqa.selenium.WebElement	findElementByLinkText(String linkText)
org.openqa.selenium.WebElement	findElementByName(String name)
org.openqa.selenium.WebElement	findElementByPartialLinkText(String partialLinkText)
org.openqa.selenium.WebElement	findElementByTagName(String tagName)
org.openqa.selenium.WebElement	findElementByXPath(String path)
List<org.openqa.selenium.WebElement>	findElements(org.openqa.selenium.By by)
List<org.openqa.selenium.WebElement>	findElementsByClassName(String className)
List<org.openqa.selenium.WebElement>	findElementsByCssSelector(String cssSelector)
List<org.openqa.selenium.WebElement>	findElementsById(String id)
List<org.openqa.selenium.WebElement>	findElementsByLinkText(String linkText)
List<org.openqa.selenium.WebElement>	findElementsByName(String name)
List<org.openqa.selenium.WebElement>	findElementsByPartialLinkText(String partialLinkText)
List<org.openqa.selenium.WebElement>	findElementsByTagName(String tagName)
List<org.openqa.selenium.WebElement>	findElementsByXPath(String path)
void	get(String s)
org.openqa.selenium.Capabilities	getCapabilities()
com.applitools.eyes.Location	getCurrentScrollPosition()
String	getCurrentUrl()
com.applitools.eyes.RectangleSize	getDefaultContentViewportSize()
int	getDisplayRotation()
Map<String,org.openqa.selenium.WebElement>	getElementIds() Found elements are sometimes accessed by their IDs (e.g.
com.applitools.eyes.RectangleSize	getEntirePageSize()
Eyes	getEyes()
FrameChain	getFrameChain()
BufferedImage	getFullPageScreenshot() Creates a full page image by scrolling the viewport and "stitching" the screenshots to each other.
org.openqa.selenium.interactions.Keyboard	getKeyboard()
org.openqa.selenium.interactions.Mouse	getMouse()
String	getPageSource()
org.openqa.selenium.remote.RemoteWebDriver	getRemoteWebDriver()
<X> X	getScreenshotAs(org.openqa.selenium.OutputType<X> xOutputType)
BufferedImage	getStitchedRegion(com.applitools.eyes.RegionProvider regionProvider) Returns a stitching of a region.
String	getTitle()
org.openqa.selenium.interactions.TouchScreen	getTouch()
String	getUserAgent()
String	getWindowHandle()
Set<String>	getWindowHandles()
String	hideScrollbars() Hides the scrollbars of the current context's document element.
org.openqa.selenium.WebDriver.Options	manage()
org.openqa.selenium.WebDriver.Navigation	navigate()
void	quit()
void	scrollTo(com.applitools.eyes.Location scrollPosition) Scrolls to the given position.
String	setOverflow(String value) Sets the overflow of the current context's document element
org.openqa.selenium.WebDriver.TargetLocator	switchTo()

Methods inherited from class java.lang.Object

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

Constructor Detail

EyesWebDriver

public EyesWebDriver(com.applitools.eyes.Logger logger,
                     Eyes eyes,
                     org.openqa.selenium.remote.RemoteWebDriver driver)
              throws com.applitools.eyes.EyesException

Throws:

com.applitools.eyes.EyesException

Method Detail

getEyes

public Eyes getEyes()

getRemoteWebDriver

public org.openqa.selenium.remote.RemoteWebDriver getRemoteWebDriver()

getTouch

public org.openqa.selenium.interactions.TouchScreen getTouch()

Specified by:

getTouch in interface org.openqa.selenium.interactions.HasTouchScreen

getDisplayRotation

public int getDisplayRotation()

Returns:

Whether the display is rotated.

get

public void get(String s)

Specified by:

get in interface org.openqa.selenium.WebDriver

getCurrentUrl

public String getCurrentUrl()

Specified by:

getCurrentUrl in interface org.openqa.selenium.WebDriver

getTitle

public String getTitle()

Specified by:

getTitle in interface org.openqa.selenium.WebDriver

findElements

public List<org.openqa.selenium.WebElement> findElements(org.openqa.selenium.By by)

Specified by:

findElements in interface org.openqa.selenium.SearchContext

Specified by:

findElements in interface org.openqa.selenium.WebDriver

findElement

public org.openqa.selenium.WebElement findElement(org.openqa.selenium.By by)

Specified by:

findElement in interface org.openqa.selenium.SearchContext

Specified by:

findElement in interface org.openqa.selenium.WebDriver

getElementIds

public Map<String,org.openqa.selenium.WebElement> getElementIds()

Found elements are sometimes accessed by their IDs (e.g. tapping an element in Appium).

Returns:

Maps of IDs for found elements.

getPageSource

public String getPageSource()

Specified by:

getPageSource in interface org.openqa.selenium.WebDriver

close

public void close()

Specified by:

close in interface org.openqa.selenium.WebDriver

quit

public void quit()

Specified by:

quit in interface org.openqa.selenium.WebDriver

getWindowHandles

public Set<String> getWindowHandles()

Specified by:

getWindowHandles in interface org.openqa.selenium.WebDriver

getWindowHandle

public String getWindowHandle()

Specified by:

getWindowHandle in interface org.openqa.selenium.WebDriver

switchTo

public org.openqa.selenium.WebDriver.TargetLocator switchTo()

Specified by:

switchTo in interface org.openqa.selenium.WebDriver

navigate

public org.openqa.selenium.WebDriver.Navigation navigate()

Specified by:

navigate in interface org.openqa.selenium.WebDriver

manage

public org.openqa.selenium.WebDriver.Options manage()

Specified by:

manage in interface org.openqa.selenium.WebDriver

getMouse

public org.openqa.selenium.interactions.Mouse getMouse()

Specified by:

getMouse in interface org.openqa.selenium.interactions.HasInputDevices

getKeyboard

public org.openqa.selenium.interactions.Keyboard getKeyboard()

Specified by:

getKeyboard in interface org.openqa.selenium.interactions.HasInputDevices

findElementByClassName

public org.openqa.selenium.WebElement findElementByClassName(String className)

Specified by:

findElementByClassName in interface org.openqa.selenium.internal.FindsByClassName

findElementsByClassName

public List<org.openqa.selenium.WebElement> findElementsByClassName(String className)

Specified by:

findElementsByClassName in interface org.openqa.selenium.internal.FindsByClassName

findElementByCssSelector

public org.openqa.selenium.WebElement findElementByCssSelector(String cssSelector)

Specified by:

findElementByCssSelector in interface org.openqa.selenium.internal.FindsByCssSelector

findElementsByCssSelector

public List<org.openqa.selenium.WebElement> findElementsByCssSelector(String cssSelector)

Specified by:

findElementsByCssSelector in interface org.openqa.selenium.internal.FindsByCssSelector

findElementById

public org.openqa.selenium.WebElement findElementById(String id)

Specified by:

findElementById in interface org.openqa.selenium.internal.FindsById

findElementsById

public List<org.openqa.selenium.WebElement> findElementsById(String id)

Specified by:

findElementsById in interface org.openqa.selenium.internal.FindsById

findElementByLinkText

public org.openqa.selenium.WebElement findElementByLinkText(String linkText)

Specified by:

findElementByLinkText in interface org.openqa.selenium.internal.FindsByLinkText

findElementsByLinkText

public List<org.openqa.selenium.WebElement> findElementsByLinkText(String linkText)

Specified by:

findElementsByLinkText in interface org.openqa.selenium.internal.FindsByLinkText

findElementByPartialLinkText

public org.openqa.selenium.WebElement findElementByPartialLinkText(String partialLinkText)

Specified by:

findElementByPartialLinkText in interface org.openqa.selenium.internal.FindsByLinkText

findElementsByPartialLinkText

public List<org.openqa.selenium.WebElement> findElementsByPartialLinkText(String partialLinkText)

Specified by:

findElementsByPartialLinkText in interface org.openqa.selenium.internal.FindsByLinkText

findElementByName

public org.openqa.selenium.WebElement findElementByName(String name)

Specified by:

findElementByName in interface org.openqa.selenium.internal.FindsByName

findElementsByName

public List<org.openqa.selenium.WebElement> findElementsByName(String name)

Specified by:

findElementsByName in interface org.openqa.selenium.internal.FindsByName

findElementByTagName

public org.openqa.selenium.WebElement findElementByTagName(String tagName)

Specified by:

findElementByTagName in interface org.openqa.selenium.internal.FindsByTagName

findElementsByTagName

public List<org.openqa.selenium.WebElement> findElementsByTagName(String tagName)

Specified by:

findElementsByTagName in interface org.openqa.selenium.internal.FindsByTagName

findElementByXPath

public org.openqa.selenium.WebElement findElementByXPath(String path)

Specified by:

findElementByXPath in interface org.openqa.selenium.internal.FindsByXPath

findElementsByXPath

public List<org.openqa.selenium.WebElement> findElementsByXPath(String path)

Specified by:

findElementsByXPath in interface org.openqa.selenium.internal.FindsByXPath

getCapabilities

public org.openqa.selenium.Capabilities getCapabilities()

Specified by:

getCapabilities in interface org.openqa.selenium.HasCapabilities

executeScript

public Object executeScript(String script,
                            Object... args)

Specified by:

executeScript in interface org.openqa.selenium.JavascriptExecutor

executeAsyncScript

public Object executeAsyncScript(String script,
                                 Object... args)

Specified by:

executeAsyncScript in interface org.openqa.selenium.JavascriptExecutor

setOverflow

public String setOverflow(String value)

Sets the overflow of the current context's document element

Parameters:

value - The overflow value to set.

Returns:

The previous overflow value (could be null if undefined).

hideScrollbars

public String hideScrollbars()

Hides the scrollbars of the current context's document element.

Returns:

The previous value of the overflow property (could be null).

extractViewportWidth

protected int extractViewportWidth()

extractViewportHeight

protected int extractViewportHeight()

getCurrentScrollPosition

public com.applitools.eyes.Location getCurrentScrollPosition()

Returns:

The scroll position of the current frame.

getEntirePageSize

public com.applitools.eyes.RectangleSize getEntirePageSize()

Returns:

The size of the entire page based on the scroll width/height.

getDefaultContentViewportSize

public com.applitools.eyes.RectangleSize getDefaultContentViewportSize()

Returns:

The viewport size of the default content (outer most frame).

scrollTo

public void scrollTo(com.applitools.eyes.Location scrollPosition)

Scrolls to the given position.

Parameters:

scrollPosition - The position to scroll to.

getFrameChain

public FrameChain getFrameChain()

Returns:

A copy of the current frame chain.

getStitchedRegion

public BufferedImage getStitchedRegion(com.applitools.eyes.RegionProvider regionProvider)

Returns a stitching of a region.

Parameters:

regionProvider - A provider of the region to stitch. If getRegion returns Region.EMPTY, the entire image will be stitched.

Returns:

An image which represents the stitched region.

getFullPageScreenshot

public BufferedImage getFullPageScreenshot()

Creates a full page image by scrolling the viewport and "stitching" the screenshots to each other.

Returns:

The image of the entire page.

getScreenshotAs

public <X> X getScreenshotAs(org.openqa.selenium.OutputType<X> xOutputType)
                      throws org.openqa.selenium.WebDriverException

Specified by:

getScreenshotAs in interface org.openqa.selenium.TakesScreenshot

Throws:

org.openqa.selenium.WebDriverException

getUserAgent

public String getUserAgent()