com.applitools.eyes.fluent

Class CheckSettings

java.lang.Object

com.applitools.eyes.fluent.CheckSettings

All Implemented Interfaces:

ICheckSettings, ICheckSettingsInternal

Direct Known Subclasses:

CheckRGSettings

public class CheckSettings
extends Object
implements ICheckSettings, ICheckSettingsInternal

The Match settings object to use in the various Eyes.Check methods.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	name

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CheckSettings()
	CheckSettings(int timeout) For internal use only.
protected	CheckSettings(Region region)

Method Summary

Modifier and Type	Method and Description
CheckSettings	clone()
protected void	content_(GetRegion regionProvider)
protected void	content_(Region region)
ICheckSettings	content()
ICheckSettings	content(Region[] regions)
ICheckSettings	content(Region region, Region... regions)
ICheckSettings	exact()
protected void	floating_(Region region, int maxUpOffset, int maxDownOffset, int maxLeftOffset, int maxRightOffset)
protected void	floating(GetFloatingRegion regionProvider)
ICheckSettings	floating(int maxOffset, Region... regions)
ICheckSettings	floating(Region region, int maxUpOffset, int maxDownOffset, int maxLeftOffset, int maxRightOffset)
ICheckSettings	fully()
ICheckSettings	fully(boolean fully)
GetRegion[]	getContentRegions()
GetFloatingRegion[]	getFloatingRegions()
Boolean	getIgnoreCaret()
GetRegion[]	getIgnoreRegions()
GetRegion[]	getLayoutRegions()
MatchLevel	getMatchLevel()
String	getName()
boolean	getStitchContent()
GetRegion[]	getStrictRegions()
Region	getTargetRegion()
int	getTimeout()
protected void	ignore_(GetRegion regionProvider)
protected void	ignore_(Region region)
ICheckSettings	ignore(Region[] regions)
ICheckSettings	ignore(Region region, Region... regions)
ICheckSettings	ignoreCaret()
ICheckSettings	ignoreCaret(boolean ignoreCaret)
protected void	layout_(GetRegion regionProvider)
protected void	layout_(Region region)
ICheckSettings	layout()
ICheckSettings	layout(Region[] regions)
ICheckSettings	layout(Region region, Region... regions)
ICheckSettings	matchLevel(MatchLevel matchLevel)
protected void	populateClone(CheckSettings clone)
void	setStitchContent(boolean stitchContent)
protected void	strict_(GetRegion regionProvider)
protected void	strict_(Region region)
ICheckSettings	strict()
ICheckSettings	strict(Region[] regions)
ICheckSettings	strict(Region region, Region... regions)
ICheckSettings	timeout(int timeoutMilliseconds)
protected void	updateTargetRegion(Region region)
ICheckSettings	withName(String name)

Methods inherited from class java.lang.Object

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

Field Detail

name

protected String name

Constructor Detail

CheckSettings

protected CheckSettings()

CheckSettings

protected CheckSettings(Region region)

CheckSettings

public CheckSettings(int timeout)

For internal use only.

Parameters:

timeout - timeout

Method Detail

ignore_

protected void ignore_(Region region)

ignore_

protected void ignore_(GetRegion regionProvider)

layout_

protected void layout_(Region region)

layout_

protected void layout_(GetRegion regionProvider)

content_

protected void content_(Region region)

content_

protected void content_(GetRegion regionProvider)

strict_

protected void strict_(Region region)

strict_

protected void strict_(GetRegion regionProvider)

floating_

protected void floating_(Region region,
                         int maxUpOffset,
                         int maxDownOffset,
                         int maxLeftOffset,
                         int maxRightOffset)

floating

protected void floating(GetFloatingRegion regionProvider)

clone

public CheckSettings clone()

Overrides:

clone in class Object

ignore

public ICheckSettings ignore(Region region,
                             Region... regions)

Specified by:

ignore in interface ICheckSettings

ignore

public ICheckSettings ignore(Region[] regions)

Specified by:

ignore in interface ICheckSettings

layout

public ICheckSettings layout(Region region,
                             Region... regions)

Specified by:

layout in interface ICheckSettings

layout

public ICheckSettings layout(Region[] regions)

Specified by:

layout in interface ICheckSettings

strict

public ICheckSettings strict(Region region,
                             Region... regions)

Specified by:

strict in interface ICheckSettings

strict

public ICheckSettings strict(Region[] regions)

Specified by:

strict in interface ICheckSettings

content

public ICheckSettings content(Region region,
                              Region... regions)

Specified by:

content in interface ICheckSettings

content

public ICheckSettings content(Region[] regions)

Specified by:

content in interface ICheckSettings

fully

public ICheckSettings fully()

Specified by:

fully in interface ICheckSettings

fully

public ICheckSettings fully(boolean fully)

Specified by:

fully in interface ICheckSettings

floating

public ICheckSettings floating(int maxOffset,
                               Region... regions)

Specified by:

floating in interface ICheckSettings

floating

public ICheckSettings floating(Region region,
                               int maxUpOffset,
                               int maxDownOffset,
                               int maxLeftOffset,
                               int maxRightOffset)

Specified by:

floating in interface ICheckSettings

timeout

public ICheckSettings timeout(int timeoutMilliseconds)

Specified by:

timeout in interface ICheckSettings

layout

public ICheckSettings layout()

Specified by:

layout in interface ICheckSettings

exact

public ICheckSettings exact()

Specified by:

exact in interface ICheckSettings

strict

public ICheckSettings strict()

Specified by:

strict in interface ICheckSettings

content

public ICheckSettings content()

Specified by:

content in interface ICheckSettings

matchLevel

public ICheckSettings matchLevel(MatchLevel matchLevel)

Specified by:

matchLevel in interface ICheckSettings

ignoreCaret

public ICheckSettings ignoreCaret(boolean ignoreCaret)

Specified by:

ignoreCaret in interface ICheckSettings

ignoreCaret

public ICheckSettings ignoreCaret()

Specified by:

ignoreCaret in interface ICheckSettings

withName

public ICheckSettings withName(String name)

Specified by:

withName in interface ICheckSettings

getTargetRegion

public Region getTargetRegion()

Specified by:

getTargetRegion in interface ICheckSettingsInternal

getTimeout

public int getTimeout()

Specified by:

getTimeout in interface ICheckSettingsInternal

getStitchContent

public boolean getStitchContent()

getMatchLevel

public MatchLevel getMatchLevel()

Specified by:

getMatchLevel in interface ICheckSettingsInternal

getIgnoreRegions

public GetRegion[] getIgnoreRegions()

getStrictRegions

public GetRegion[] getStrictRegions()

getLayoutRegions

public GetRegion[] getLayoutRegions()

getContentRegions

public GetRegion[] getContentRegions()

getFloatingRegions

public GetFloatingRegion[] getFloatingRegions()

getIgnoreCaret

public Boolean getIgnoreCaret()

getName

public String getName()

Specified by:

getName in interface ICheckSettingsInternal

updateTargetRegion

protected void updateTargetRegion(Region region)

populateClone

protected void populateClone(CheckSettings clone)

setStitchContent

public void setStitchContent(boolean stitchContent)