Package com.applitools.eyes

Enum Class CoordinatesType

java.lang.Object

java.lang.Enum<CoordinatesType>

com.applitools.eyes.CoordinatesType

All Implemented Interfaces:

Serializable, Comparable<CoordinatesType>, java.lang.constant.Constable

public enum CoordinatesType
extends Enum<CoordinatesType>

Encapsulates the type of coordinates used by the region provider.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONTEXT_AS_IS	The coordinates should be used "as is" within the current context.
CONTEXT_RELATIVE	Coordinates are relative to the context.
SCREENSHOT_AS_IS	The coordinates should be used "as is" on the screenshot image.

Method Summary

Modifier and Type	Method	Description
static CoordinatesType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CoordinatesType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SCREENSHOT_AS_IS

public static final CoordinatesType SCREENSHOT_AS_IS

The coordinates should be used "as is" on the screenshot image. Regardless of the current context.

CONTEXT_AS_IS

public static final CoordinatesType CONTEXT_AS_IS

The coordinates should be used "as is" within the current context. For example, if we're inside a frame, the coordinates are "as is", but within the current frame's viewport.

CONTEXT_RELATIVE

public static final CoordinatesType CONTEXT_RELATIVE

Coordinates are relative to the context. For example, if we are in a context of a frame in a web page, then the coordinates are relative to the frame. In this case, if we want to crop an image region based on an element's region, we will need to calculate their respective "as is" coordinates.

Method Details

values

public static CoordinatesType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static CoordinatesType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null