com.applitools.eyes

Class EyesWebDriverScreenshot

java.lang.Object

com.applitools.eyes.EyesWebDriverScreenshot

public class EyesWebDriverScreenshot
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected BufferedImage	image

Constructor Summary

Constructors

Constructor and Description
EyesWebDriverScreenshot(com.applitools.eyes.Logger logger, EyesWebDriver driver, BufferedImage image)
EyesWebDriverScreenshot(com.applitools.eyes.Logger logger, EyesWebDriver driver, BufferedImage image, com.applitools.eyes.EyesWebDriverScreenshot.ScreenshotType screenshotType, com.applitools.eyes.Location frameLocationInScreenshot)
EyesWebDriverScreenshot(com.applitools.eyes.Logger logger, EyesWebDriver driver, BufferedImage image, com.applitools.eyes.RectangleSize entireFrameSize) Creates a frame(!) window screenshot.

Method Summary

Modifier and Type	Method and Description
protected com.applitools.eyes.Location	convertLocation(com.applitools.eyes.Location location, com.applitools.eyes.CoordinatesType from, com.applitools.eyes.CoordinatesType to)
protected com.applitools.eyes.Region	convertRegionLocation(com.applitools.eyes.Region arg0, com.applitools.eyes.CoordinatesType arg1, com.applitools.eyes.CoordinatesType arg2)
FrameChain	getFrameChain()
com.applitools.eyes.Region	getFrameWindow()
BufferedImage	getImage()
protected com.applitools.eyes.Region	getIntersectedRegion(com.applitools.eyes.Region arg0, com.applitools.eyes.CoordinatesType arg1)
protected com.applitools.eyes.Region	getIntersectedRegion(com.applitools.eyes.Region region, com.applitools.eyes.CoordinatesType originalCoordinatesType, com.applitools.eyes.CoordinatesType resultCoordinatesType)
com.applitools.eyes.Region	getIntersectedRegion(org.openqa.selenium.WebElement element)
com.applitools.eyes.Location	getLocationInScreenshot(com.applitools.eyes.Location location, com.applitools.eyes.CoordinatesType coordinatesType)
EyesWebDriverScreenshot	getSubScreenshot(com.applitools.eyes.Region region, com.applitools.eyes.CoordinatesType coordinatesType, boolean throwIfClipped)

Methods inherited from class java.lang.Object

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

Field Detail

image

protected BufferedImage image

Constructor Detail

EyesWebDriverScreenshot

public EyesWebDriverScreenshot(com.applitools.eyes.Logger logger,
                               EyesWebDriver driver,
                               BufferedImage image,
                               com.applitools.eyes.EyesWebDriverScreenshot.ScreenshotType screenshotType,
                               com.applitools.eyes.Location frameLocationInScreenshot)

Parameters:

logger - A Logger instance.

driver - The web driver used to get the screenshot.

image - The actual screenshot image.

screenshotType - (Optional) The screenshot's type (e.g., viewport/full page).

frameLocationInScreenshot - (Optional) The current frame's location in the screenshot.

EyesWebDriverScreenshot

public EyesWebDriverScreenshot(com.applitools.eyes.Logger logger,
                               EyesWebDriver driver,
                               BufferedImage image)

Parameters:

logger - A Logger instance.

driver - The web driver used to get the screenshot.

image - The actual screenshot image.

See Also:

{@code screenshotType} defaults to {@code null}. {@code frameLocationInScreenshot} defaults to {@code null}.

EyesWebDriverScreenshot

public EyesWebDriverScreenshot(com.applitools.eyes.Logger logger,
                               EyesWebDriver driver,
                               BufferedImage image,
                               com.applitools.eyes.RectangleSize entireFrameSize)

Creates a frame(!) window screenshot.

Parameters:

logger - A Logger instance.

driver - The web driver used to get the screenshot.

image - The actual screenshot image.

entireFrameSize - The full internal size of the frame.

Method Detail

getFrameWindow

public com.applitools.eyes.Region getFrameWindow()

Returns:

The region of the frame which is available in the screenshot, in screenshot coordinates.

getFrameChain

public FrameChain getFrameChain()

Returns:

A copy of the frame chain which was available when the screenshot was created.

getSubScreenshot

public EyesWebDriverScreenshot getSubScreenshot(com.applitools.eyes.Region region,
                                                com.applitools.eyes.CoordinatesType coordinatesType,
                                                boolean throwIfClipped)

convertLocation

protected com.applitools.eyes.Location convertLocation(com.applitools.eyes.Location location,
                                                       com.applitools.eyes.CoordinatesType from,
                                                       com.applitools.eyes.CoordinatesType to)

getLocationInScreenshot

public com.applitools.eyes.Location getLocationInScreenshot(com.applitools.eyes.Location location,
                                                            com.applitools.eyes.CoordinatesType coordinatesType)
                                                     throws com.applitools.eyes.OutOfBoundsException

Throws:

com.applitools.eyes.OutOfBoundsException

getIntersectedRegion

protected com.applitools.eyes.Region getIntersectedRegion(com.applitools.eyes.Region region,
                                                          com.applitools.eyes.CoordinatesType originalCoordinatesType,
                                                          com.applitools.eyes.CoordinatesType resultCoordinatesType)

getIntersectedRegion

public com.applitools.eyes.Region getIntersectedRegion(org.openqa.selenium.WebElement element)

getImage

public BufferedImage getImage()

getIntersectedRegion

protected com.applitools.eyes.Region getIntersectedRegion(com.applitools.eyes.Region arg0,
                                                          com.applitools.eyes.CoordinatesType arg1)

convertRegionLocation

protected com.applitools.eyes.Region convertRegionLocation(com.applitools.eyes.Region arg0,
                                                           com.applitools.eyes.CoordinatesType arg1,
                                                           com.applitools.eyes.CoordinatesType arg2)