com.applitools.eyes.selenium.capture

Class EyesWebDriverScreenshot

java.lang.Object

com.applitools.eyes.EyesScreenshot

com.applitools.eyes.selenium.capture.EyesWebDriverScreenshot

public class EyesWebDriverScreenshot
extends EyesScreenshot

Field Summary

Fields inherited from class com.applitools.eyes.EyesScreenshot

image, logger

Constructor Summary

Constructors

Constructor and Description
EyesWebDriverScreenshot(Logger logger, EyesWebDriver driver, BufferedImage image) See EyesWebDriverScreenshot(Logger, EyesWebDriver, BufferedImage, ScreenshotType, Location).
EyesWebDriverScreenshot(Logger logger, EyesWebDriver driver, BufferedImage image, com.applitools.eyes.selenium.capture.EyesWebDriverScreenshot.ScreenshotType screenshotType, Location frameLocationInScreenshot)
EyesWebDriverScreenshot(Logger logger, EyesWebDriver driver, BufferedImage image, RectangleSize entireFrameSize) Creates a frame(!) window screenshot.
EyesWebDriverScreenshot(Logger logger, EyesWebDriver driver, BufferedImage image, Region screenshotRegion) Creates a frame-like window screenshot, to be used for checkRegion screenshots.

Method Summary

Modifier and Type	Method and Description
static Location	calcFrameLocationInScreenshot(Logger logger, EyesWebDriver driver, FrameChain frameChain, com.applitools.eyes.selenium.capture.EyesWebDriverScreenshot.ScreenshotType screenshotType)
Location	convertLocation(Location location, CoordinatesType from, CoordinatesType to)
FrameChain	getFrameChain()
Region	getFrameWindow()
Region	getIntersectedRegion(Region region, CoordinatesType resultCoordinatesType)
Region	getIntersectedRegion(org.openqa.selenium.WebElement element) Gets the elements region in the screenshot.
Location	getLocationInScreenshot(Location location, CoordinatesType coordinatesType)
EyesWebDriverScreenshot	getSubScreenshot(Region region, boolean throwIfClipped)
EyesWebDriverScreenshot	getSubScreenshotForRegion(Region region, boolean throwIfClipped)

Methods inherited from class com.applitools.eyes.EyesScreenshot

convertRegionLocation, getImage

Methods inherited from class java.lang.Object

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

Constructor Detail

EyesWebDriverScreenshot

public EyesWebDriverScreenshot(Logger logger,
                               EyesWebDriver driver,
                               BufferedImage image,
                               com.applitools.eyes.selenium.capture.EyesWebDriverScreenshot.ScreenshotType screenshotType,
                               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(Logger logger,
                               EyesWebDriver driver,
                               BufferedImage image)

See EyesWebDriverScreenshot(Logger, EyesWebDriver, BufferedImage, ScreenshotType, Location). screenshotType defaults to null. frameLocationInScreenshot defaults to null.

Parameters:

logger - A Logger instance.

driver - The web driver used to get the screenshot.

image - The actual screenshot image.

EyesWebDriverScreenshot

public EyesWebDriverScreenshot(Logger logger,
                               EyesWebDriver driver,
                               BufferedImage image,
                               Region screenshotRegion)

Creates a frame-like window screenshot, to be used for checkRegion screenshots.

Parameters:

logger - A Logger instance.

driver - The web driver used to get the screenshot.

image - The actual screenshot image.

screenshotRegion - The region of the screenshot.

EyesWebDriverScreenshot

public EyesWebDriverScreenshot(Logger logger,
                               EyesWebDriver driver,
                               BufferedImage image,
                               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

calcFrameLocationInScreenshot

public static Location calcFrameLocationInScreenshot(Logger logger,
                                                     EyesWebDriver driver,
                                                     FrameChain frameChain,
                                                     com.applitools.eyes.selenium.capture.EyesWebDriverScreenshot.ScreenshotType screenshotType)

getFrameWindow

public 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(Region region,
                                                boolean throwIfClipped)

Specified by:

getSubScreenshot in class EyesScreenshot

getSubScreenshotForRegion

public EyesWebDriverScreenshot getSubScreenshotForRegion(Region region,
                                                         boolean throwIfClipped)

convertLocation

public Location convertLocation(Location location,
                                CoordinatesType from,
                                CoordinatesType to)

Specified by:

convertLocation in class EyesScreenshot

getLocationInScreenshot

public Location getLocationInScreenshot(Location location,
                                        CoordinatesType coordinatesType)
                                 throws OutOfBoundsException

Specified by:

getLocationInScreenshot in class EyesScreenshot

Throws:

OutOfBoundsException

getIntersectedRegion

public Region getIntersectedRegion(Region region,
                                   CoordinatesType resultCoordinatesType)

Specified by:

getIntersectedRegion in class EyesScreenshot

getIntersectedRegion

public Region getIntersectedRegion(org.openqa.selenium.WebElement element)

Gets the elements region in the screenshot.

Parameters:

element - The element which region we want to intersect.

Returns:

The intersected region, in SCREENSHOT_AS_IS coordinates type.