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 com.applitools.eyes.Region	bounds
protected BufferedImage	image

Constructor Summary

Constructors

Constructor and Description
EyesWebDriverScreenshot(com.applitools.eyes.EyesWebDriver driver, BufferedImage image)
EyesWebDriverScreenshot(com.applitools.eyes.EyesWebDriver driver, BufferedImage image, com.applitools.eyes.EyesWebDriverScreenshot.ScreenshotType screenshotType, com.applitools.eyes.Location location, com.applitools.eyes.Location frameLocationInScreenshot)

Method Summary

Methods

Modifier and Type	Method and Description
com.applitools.eyes.Region	getBounds()
com.applitools.eyes.Region	getElementRegionInFrameViewport(org.openqa.selenium.WebElement element)
FrameChain	getFrameChain()
BufferedImage	getImage()
com.applitools.eyes.Region	getIntersectedRegion(com.applitools.eyes.Region region) This function intersects a region with the current screenshot, considering frames.
com.applitools.eyes.Region	getIntersectedRegion(org.openqa.selenium.WebElement element) This function intersects a region with the current screenshot, considering frames.
com.applitools.eyes.Location	getLocationInScreenshot(com.applitools.eyes.Location location) Calculates the location in the screenshot of the location given as parameter.
protected com.applitools.eyes.Location	getLocationRelativeToFrameViewport(com.applitools.eyes.Location location) If this is not a full screen screenshot, or we're inside a frame, adjust the location to the current viewport.
protected BufferedImage	getSubImage(com.applitools.eyes.Region arg0)
EyesWebDriverScreenshot	getSubScreenshot(com.applitools.eyes.Region region)
EyesWebDriverScreenshot	getSubScreenshot(org.openqa.selenium.WebElement element)

Methods inherited from class java.lang.Object

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

Field Detail

image

protected BufferedImage image

bounds

protected com.applitools.eyes.Region bounds

Constructor Detail

EyesWebDriverScreenshot

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

EyesWebDriverScreenshot

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

Method Detail

getFrameChain

public FrameChain getFrameChain()

Returns:

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

getLocationRelativeToFrameViewport

protected com.applitools.eyes.Location getLocationRelativeToFrameViewport(com.applitools.eyes.Location location)

If this is not a full screen screenshot, or we're inside a frame, adjust the location to the current viewport.

Parameters:

location - The location to adjust

Returns:

A location adjusted to the current frame/viewport. IMPORTANT this location can be negative (location is outside the frame/viewport..)

getLocationInScreenshot

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

Calculates the location in the screenshot of the location given as parameter.

Parameters:

location - The location as coordinates inside the current frame.

Returns:

The corresponding location inside the screenshot, if available.

Throws:

com.applitools.eyes.OutOfBoundsException - If the location is not inside the frame's region in the screenshot.

getElementRegionInFrameViewport

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

Parameters:

element - The element which region we would like to receive.

Returns:

The region representing the element's bounds within the current frame's viewport.

getIntersectedRegion

public com.applitools.eyes.Region getIntersectedRegion(com.applitools.eyes.Region region)

This function intersects a region with the current screenshot, considering frames.

Parameters:

region - The region to intersect, relative to the frames top/left within the parent (meaning, scroll isn't considered!)

Returns:

The intersected region.

getIntersectedRegion

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

This function intersects a region with the current screenshot, considering frames.

Parameters:

element - The region to intersect.

Returns:

The intersected region.

getSubScreenshot

public EyesWebDriverScreenshot getSubScreenshot(com.applitools.eyes.Region region)

Parameters:

region - The region in the coordinates of the current frame.

Returns:

A screenshot encapsulating the intersection of the region given as a parameter with the current screenshot.

getSubScreenshot

public EyesWebDriverScreenshot getSubScreenshot(org.openqa.selenium.WebElement element)

Parameters:

element - The element for which to get a screenshot from the current screenshot.

Returns:

The screenshot wrapping the region defined by the given element.

getImage

public BufferedImage getImage()

getSubImage

protected BufferedImage getSubImage(com.applitools.eyes.Region arg0)

getBounds

public com.applitools.eyes.Region getBounds()