com.applitools.eyes

Class EyesScreenshot

java.lang.Object

com.applitools.eyes.EyesScreenshot

public abstract class EyesScreenshot
extends Object

Base class for handling screenshots.

Field Summary

Fields

Modifier and Type	Field and Description
protected BufferedImage	image

Constructor Summary

Constructors

Constructor and Description
EyesScreenshot(BufferedImage image)

Method Summary

Modifier and Type	Method and Description
abstract Location	convertLocation(Location location, CoordinatesType from, CoordinatesType to) Converts a location's coordinates with the from coordinates type to the to coordinates type.
Region	convertRegionLocation(Region region, CoordinatesType from, CoordinatesType to) Converts a region's location coordinates with the from coordinates type to the to coordinates type.
BufferedImage	getImage()
Region	getIntersectedRegion(Region region, CoordinatesType coordinatesType) Get the intersection of the given region with the screenshot.
abstract Region	getIntersectedRegion(Region region, CoordinatesType originalCoordinatesType, CoordinatesType resultCoordinatesType) Get the intersection of the given region with the screenshot.
abstract Location	getLocationInScreenshot(Location location, CoordinatesType coordinatesType) Calculates the location in the screenshot of the location given as parameter.
abstract EyesScreenshot	getSubScreenshot(Region region, CoordinatesType coordinatesType, boolean throwIfClipped) Returns a part of the screenshot based on the given region.

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

EyesScreenshot

public EyesScreenshot(BufferedImage image)

Method Detail

getImage

public BufferedImage getImage()

Returns:

The screenshot image.

getSubScreenshot

public abstract EyesScreenshot getSubScreenshot(Region region,
                                                CoordinatesType coordinatesType,
                                                boolean throwIfClipped)

Returns a part of the screenshot based on the given region.

Parameters:

region - The region for which we should get the sub screenshot.

coordinatesType - How should the region be calculated on the screenshot image.

throwIfClipped - Throw an EyesException if the region is not fully contained in the screenshot.

Returns:

A screenshot instance containing the given region.

convertLocation

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

Converts a location's coordinates with the from coordinates type to the to coordinates type.

Parameters:

location - The location which coordinates needs to be converted.

from - The current coordinates type for location.

to - The target coordinates type for location.

Returns:

A new location which is the transformation of location to the to coordinates type.

getLocationInScreenshot

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

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

Parameters:

location - The location as coordinates inside the current frame.

coordinatesType - The coordinates type of location.

Returns:

The corresponding location inside the screenshot, in screenshot as-is coordinates type.

Throws:

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

getIntersectedRegion

public abstract Region getIntersectedRegion(Region region,
                                            CoordinatesType originalCoordinatesType,
                                            CoordinatesType resultCoordinatesType)

Get the intersection of the given region with the screenshot.

Parameters:

region - The region to intersect.

originalCoordinatesType - The coordinates type of region.

resultCoordinatesType - The coordinates type of the resulting region.

Returns:

The intersected region, in resultCoordinatesType coordinates.

getIntersectedRegion

public Region getIntersectedRegion(Region region,
                                   CoordinatesType coordinatesType)

Get the intersection of the given region with the screenshot.

Parameters:

region - The region to intersect.

coordinatesType - The coordinates type of region.

Returns:

The intersected region, in coordinatesType coordinates.

convertRegionLocation

public Region convertRegionLocation(Region region,
                                    CoordinatesType from,
                                    CoordinatesType to)

Converts a region's location coordinates with the from coordinates type to the to coordinates type.

Parameters:

region - The region which location's coordinates needs to be converted.

from - The current coordinates type for region.

to - The target coordinates type for region.

Returns:

A new region which is the transformation of region to the to coordinates type.