com.applitools.eyes

Class Region

java.lang.Object

com.applitools.eyes.Region

public class Region
extends Object

Represents a region.

Field Summary

Fields

Modifier and Type	Field and Description
static Region	EMPTY

Constructor Summary

Constructors

Constructor and Description
Region(int left, int top, int width, int height)
Region(Location location, RectangleSize size)
Region(Region other)

Method Summary

Modifier and Type	Method and Description
boolean	contains(Location location) Check if a specified location is contained within this region.
boolean	contains(Region other) Check if a region is contained within the current region.
boolean	equals(Object obj)
int	getHeight()
int	getLeft()
Location	getLocation()
Location	getMiddleOffset()
RectangleSize	getSize()
Iterable<Region>	getSubRegions(RectangleSize subRegionSize) See getSubRegions(RectangleSize, boolean).
Iterable<Region>	getSubRegions(RectangleSize subRegionSize, boolean isFixedSize) Returns a list of sub-regions which compose the current region.
int	getTop()
int	getWidth()
int	hashCode()
void	intersect(Region other) Replaces this region with the intersection of itself and other
boolean	isEmpty()
boolean	isIntersected(Region other) Check if a region is intersected with the current region.
protected void	makeEmpty()
void	offset(int dx, int dy) Offsets the region's location (in place).
void	setLocation(Location location) Set the (top,left) position of the current region
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EMPTY

public static final Region EMPTY

Constructor Detail

Region

public Region(int left,
              int top,
              int width,
              int height)

Region

public Region(Location location,
              RectangleSize size)

Region

public Region(Region other)

Method Detail

makeEmpty

protected void makeEmpty()

isEmpty

public boolean isEmpty()

Returns:

true if the region is empty, false otherwise.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getLocation

public Location getLocation()

Returns:

The (top,left) position of the current region.

offset

public void offset(int dx,
                   int dy)

Offsets the region's location (in place).

Parameters:

dx - The X axis offset.

dy - The Y axis offset.

getSize

public RectangleSize getSize()

Returns:

The (top,left) position of the current region.

setLocation

public void setLocation(Location location)

Set the (top,left) position of the current region

Parameters:

location - The (top,left) position to set.

getSubRegions

public Iterable<Region> getSubRegions(RectangleSize subRegionSize,
                                      boolean isFixedSize)

Returns a list of sub-regions which compose the current region.

Parameters:

subRegionSize - The default sub-region size to use.

isFixedSize - If false, then sub-regions might have a size which is smaller then subRegionSize (thus there will be no overlap of regions). Otherwise, all sub-regions will have the same size, but sub-regions might overlap.

Returns:

The sub-regions composing the current region. If subRegionSize is equal or greater than the current region, only a single region is returned.

getSubRegions

public Iterable<Region> getSubRegions(RectangleSize subRegionSize)

See getSubRegions(RectangleSize, boolean). isFixedSize defaults to false.

contains

public boolean contains(Region other)

Check if a region is contained within the current region.

Parameters:

other - The region to check if it is contained within the current region.

Returns:

True if other is contained within the current region, false otherwise.

contains

public boolean contains(Location location)

Check if a specified location is contained within this region.

Parameters:

location - The location to test.

Returns:

True if the location is contained within this region, false otherwise.

isIntersected

public boolean isIntersected(Region other)

Check if a region is intersected with the current region.

Parameters:

other - The region to check intersection with.

Returns:

True if the regions are intersected, false otherwise.

intersect

public void intersect(Region other)

Replaces this region with the intersection of itself and other

Parameters:

other - The region with which to intersect.

getLeft

public int getLeft()

getTop

public int getTop()

getWidth

public int getWidth()

getHeight

public int getHeight()

getMiddleOffset

public Location getMiddleOffset()

toString

public String toString()

Overrides:

toString in class Object