com.applitools.eyes.fluent

Class CheckSettings

java.lang.Object

com.applitools.eyes.fluent.CheckSettings

All Implemented Interfaces:

ICheckSettings, ICheckSettingsInternal

public class CheckSettings
extends Object
implements ICheckSettings, ICheckSettingsInternal

Field Summary

Fields

Modifier and Type	Field and Description
protected List<GetAccessibilityRegion>	accessibilityRegions
protected static String	BEFORE_CAPTURE_SCREENSHOT
protected List<GetSimpleRegion>	contentRegions
protected Boolean	enablePatterns
protected List<GetFloatingRegion>	floatingRegions
protected Boolean	ignoreDisplacements
protected List<GetSimpleRegion>	ignoreRegions
protected List<GetSimpleRegion>	layoutRegions
protected String	name
protected Map<String,String>	scriptHooks
protected Boolean	sendDom
protected List<GetSimpleRegion>	strictRegions
protected Boolean	useDom

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	accessibility_(GetAccessibilityRegion accessibilityRegionProvider)
protected void	accessibility_(Region rect, AccessibilityRegionType regionType)
protected void	accessibility(GetAccessibilityRegion accessibilityRegionProvider)
ICheckSettings	accessibility(Region region, AccessibilityRegionType regionType)
ICheckSettings	beforeRenderScreenshotHook(String hook)
CheckSettings	clone()
protected void	content_(GetSimpleRegion regionProvider)
protected void	content_(Region region)
ICheckSettings	content() Shortcut to set the match level to MatchLevel.CONTENT.
ICheckSettings	content(Region[] regions) Adds one or more content regions.
ICheckSettings	content(Region region, Region... regions) Adds one or more content regions.
ICheckSettings	enablePatterns()
ICheckSettings	enablePatterns(Boolean enablePatterns)
ICheckSettings	exact() Shortcut to set the match level to MatchLevel.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) Adds a floating region.
ICheckSettings	floating(Region region, int maxUpOffset, int maxDownOffset, int maxLeftOffset, int maxRightOffset) Adds a floating region.
ICheckSettings	fully() Defines that the screenshot will contain the entire element or region, even if it's outside the view.
ICheckSettings	fully(Boolean fully) Defines whether the screenshot will contain the entire element or region, even if it's outside the view.
GetAccessibilityRegion[]	getAccessibilityRegions()
GetSimpleRegion[]	getContentRegions()
GetFloatingRegion[]	getFloatingRegions()
Boolean	getIgnoreCaret()
GetSimpleRegion[]	getIgnoreRegions()
GetSimpleRegion[]	getLayoutRegions()
MatchLevel	getMatchLevel()
String	getName()
BaseOcrRegion	getOcrRegion()
Map<String,String>	getScriptHooks()
String	getSizeMode()
PositionProvider	getStepPositionProvider() Internal Usage
Boolean	getStitchContent()
GetSimpleRegion[]	getStrictRegions()
Region	getTargetRegion()
Integer	getTimeout()
String	getVariationGroupId()
VisualGridSelector	getVGTargetSelector()
List<VisualGridOption>	getVisualGridOptions()
protected void	ignore_(GetSimpleRegion regionProvider)
protected void	ignore_(Region region)
ICheckSettings	ignore(Region[] regions) Adds one or more ignore regions.
ICheckSettings	ignore(Region region, Region... regions) Adds one or more ignore regions.
ICheckSettings	ignoreCaret() Defines to ignore a blinking caret in the screenshot.
ICheckSettings	ignoreCaret(Boolean ignoreCaret) Defines if to detect and ignore a blinking caret in the screenshot.
ICheckSettings	ignoreDisplacements()
ICheckSettings	ignoreDisplacements(Boolean ignoreDisplacements)
Boolean	isCheckWindow()
Boolean	isDisableBrowserFetching()
Boolean	isEnablePatterns()
Boolean	isIgnoreDisplacements()
Boolean	isSendDom()
Boolean	isStitchContent()
Boolean	isUseDom()
protected void	layout_(GetSimpleRegion regionProvider)
protected void	layout_(Region region)
ICheckSettings	layout() Shortcut to set the match level to MatchLevel.LAYOUT.
ICheckSettings	layout(Region[] regions) Adds one or more layout regions.
ICheckSettings	layout(Region region, Region... regions) Adds one or more layout regions.
ICheckSettings	matchLevel(MatchLevel matchLevel) Set the match level by which to compare the screenshot.
ICheckSettings	ocrRegion(BaseOcrRegion ocrRegion)
protected void	populateClone(CheckSettings clone)
ICheckSettings	scriptHook(String hook) Deprecated.
ICheckSettings	sendDom()
ICheckSettings	sendDom(Boolean sendDom)
ICheckSettings	setDisableBrowserFetching(Boolean disableBrowserFetching)
void	setStitchContent(boolean stitchContent)
protected void	strict_(GetSimpleRegion regionProvider)
protected void	strict_(Region region)
ICheckSettings	strict() Shortcut to set the match level to MatchLevel.STRICT.
ICheckSettings	strict(Region[] regions) Adds one or more strict regions.
ICheckSettings	strict(Region region, Region... regions) Adds one or more strict regions.
ICheckSettings	timeout(Integer timeoutMilliseconds) Defines the timeout to use when acquiring and comparing screenshots.
protected void	updateTargetRegion(Region region)
ICheckSettings	useDom(Boolean useDom)
ICheckSettings	variationGroupId(String variationGroupId)
ICheckSettings	visualGridOptions(VisualGridOption... options)
ICheckSettings	withName(String name) A setter for the checkpoint name.

Methods inherited from class java.lang.Object

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

Field Detail

BEFORE_CAPTURE_SCREENSHOT

protected static final String BEFORE_CAPTURE_SCREENSHOT

See Also:

Constant Field Values

ignoreRegions

protected final List<GetSimpleRegion> ignoreRegions

layoutRegions

protected final List<GetSimpleRegion> layoutRegions

strictRegions

protected final List<GetSimpleRegion> strictRegions

contentRegions

protected final List<GetSimpleRegion> contentRegions

floatingRegions

protected final List<GetFloatingRegion> floatingRegions

accessibilityRegions

protected List<GetAccessibilityRegion> accessibilityRegions

name

protected String name

enablePatterns

protected Boolean enablePatterns

sendDom

protected Boolean sendDom

useDom

protected Boolean useDom

scriptHooks

protected Map<String,String> scriptHooks

ignoreDisplacements

protected Boolean ignoreDisplacements

Constructor Detail

CheckSettings

protected CheckSettings()

CheckSettings

protected CheckSettings(Region region)

CheckSettings

public CheckSettings(Integer timeout)

For internal use only.

Parameters:

timeout - timeout

Method Detail

ignore_

protected void ignore_(Region region)

ignore_

protected void ignore_(GetSimpleRegion regionProvider)

layout_

protected void layout_(Region region)

layout_

protected void layout_(GetSimpleRegion regionProvider)

content_

protected void content_(Region region)

content_

protected void content_(GetSimpleRegion regionProvider)

strict_

protected void strict_(Region region)

strict_

protected void strict_(GetSimpleRegion 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()

Specified by:

clone in interface ICheckSettingsInternal

Overrides:

clone in class Object

isStitchContent

public Boolean isStitchContent()

Specified by:

isStitchContent in interface ICheckSettingsInternal

ignore

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

Adds one or more ignore regions.

Specified by:

ignore in interface ICheckSettings

Parameters:

region - A region to ignore when validating the screenshot.

regions - Optional extra regions to ignore when validating the screenshot.

Returns:

An updated clone of this settings object.

ignore

public ICheckSettings ignore(Region[] regions)

Adds one or more ignore regions.

Specified by:

ignore in interface ICheckSettings

Parameters:

regions - An array of regions to ignore when validating the screenshot.

Returns:

An updated clone of this settings object.

layout

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

Adds one or more layout regions.

Specified by:

layout in interface ICheckSettings

Parameters:

region - A region to match using the Layout method.

regions - Optional extra regions to match using the Layout method.

Returns:

An updated clone of this settings object.

layout

public ICheckSettings layout(Region[] regions)

Adds one or more layout regions.

Specified by:

layout in interface ICheckSettings

Parameters:

regions - An array of regions to match using the Layout method.

Returns:

An updated clone of this settings object.

strict

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

Adds one or more strict regions.

Specified by:

strict in interface ICheckSettings

Parameters:

region - A region to match using the Strict method.

regions - Optional extra regions to match using the Strict method.

Returns:

An updated clone of this settings object.

strict

public ICheckSettings strict(Region[] regions)

Adds one or more strict regions.

Specified by:

strict in interface ICheckSettings

Parameters:

regions - An array of regions to match using the Strict method.

Returns:

An updated clone of this settings object.

content

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

Adds one or more content regions.

Specified by:

content in interface ICheckSettings

Parameters:

region - A region to match using the Content method.

regions - Optional extra regions to match using the Content method.

Returns:

An updated clone of this settings object.

content

public ICheckSettings content(Region[] regions)

Adds one or more content regions.

Specified by:

content in interface ICheckSettings

Parameters:

regions - An array of regions to match using the Content method.

Returns:

An updated clone of this settings object.

fully

public ICheckSettings fully()

Defines that the screenshot will contain the entire element or region, even if it's outside the view.

Specified by:

fully in interface ICheckSettings

Returns:

An updated clone of this settings object.

fully

public ICheckSettings fully(Boolean fully)

Defines whether the screenshot will contain the entire element or region, even if it's outside the view.

Specified by:

fully in interface ICheckSettings

Parameters:

fully - defines whether the screenshot will contain the entire element or region.

Returns:

An updated clone of this settings object.

floating

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

Adds a floating region. A floating region is a a region that can be placed within the boundaries of a bigger region.

Specified by:

floating in interface ICheckSettings

Parameters:

maxOffset - How much each of the content rectangles can move in any direction.

regions - One or more content rectangles.

Returns:

An updated clone of this settings object.

floating

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

Adds a floating region. A floating region is a a region that can be placed within the boundaries of a bigger region.

Specified by:

floating in interface ICheckSettings

Parameters:

region - The content rectangle.

maxUpOffset - How much the content can move up.

maxDownOffset - How much the content can move down.

maxLeftOffset - How much the content can move to the left.

maxRightOffset - How much the content can move to the right.

Returns:

An updated clone of this settings object.

timeout

public ICheckSettings timeout(Integer timeoutMilliseconds)

Defines the timeout to use when acquiring and comparing screenshots.

Specified by:

timeout in interface ICheckSettings

Parameters:

timeoutMilliseconds - The timeout to use in milliseconds.

Returns:

An updated clone of this settings object.

layout

public ICheckSettings layout()

Shortcut to set the match level to MatchLevel.LAYOUT.

Specified by:

layout in interface ICheckSettings

Returns:

An updated clone of this settings object.

exact

public ICheckSettings exact()

Shortcut to set the match level to MatchLevel.EXACT.

Specified by:

exact in interface ICheckSettings

Returns:

An updated clone of this settings object.

strict

public ICheckSettings strict()

Shortcut to set the match level to MatchLevel.STRICT.

Specified by:

strict in interface ICheckSettings

Returns:

An updated clone of this settings object.

content

public ICheckSettings content()

Shortcut to set the match level to MatchLevel.CONTENT.

Specified by:

content in interface ICheckSettings

Returns:

An updated clone of this settings object.

matchLevel

public ICheckSettings matchLevel(MatchLevel matchLevel)

Set the match level by which to compare the screenshot.

Specified by:

matchLevel in interface ICheckSettings

Parameters:

matchLevel - The match level to use.

Returns:

An updated clone of this settings object.

ignoreCaret

public ICheckSettings ignoreCaret(Boolean ignoreCaret)

Defines if to detect and ignore a blinking caret in the screenshot.

Specified by:

ignoreCaret in interface ICheckSettings

Parameters:

ignoreCaret - Whether or not to detect and ignore a blinking caret in the screenshot.

Returns:

An updated clone of this settings object.

ignoreCaret

public ICheckSettings ignoreCaret()

Defines to ignore a blinking caret in the screenshot.

Specified by:

ignoreCaret in interface ICheckSettings

Returns:

An updated clone of this settings object.

withName

public ICheckSettings withName(String name)

A setter for the checkpoint name.

Specified by:

withName in interface ICheckSettings

Parameters:

name - A name by which to identify the checkpoint.

Returns:

An updated clone of this settings object.

isSendDom

public Boolean isSendDom()

Specified by:

isSendDom in interface ICheckSettingsInternal

isIgnoreDisplacements

public Boolean isIgnoreDisplacements()

Specified by:

isIgnoreDisplacements in interface ICheckSettingsInternal

isUseDom

public Boolean isUseDom()

Specified by:

isUseDom in interface ICheckSettingsInternal

useDom

public ICheckSettings useDom(Boolean useDom)

Specified by:

useDom in interface ICheckSettings

sendDom

public ICheckSettings sendDom(Boolean sendDom)

Specified by:

sendDom in interface ICheckSettings

sendDom

public ICheckSettings sendDom()

Specified by:

sendDom in interface ICheckSettings

getTargetRegion

public Region getTargetRegion()

Specified by:

getTargetRegion in interface ICheckSettingsInternal

getTimeout

public Integer getTimeout()

Specified by:

getTimeout in interface ICheckSettingsInternal

getStitchContent

public Boolean getStitchContent()

getMatchLevel

public MatchLevel getMatchLevel()

Specified by:

getMatchLevel in interface ICheckSettingsInternal

getIgnoreRegions

public GetSimpleRegion[] getIgnoreRegions()

getStrictRegions

public GetSimpleRegion[] getStrictRegions()

getLayoutRegions

public GetSimpleRegion[] getLayoutRegions()

getContentRegions

public GetSimpleRegion[] getContentRegions()

getFloatingRegions

public GetFloatingRegion[] getFloatingRegions()

getIgnoreCaret

public Boolean getIgnoreCaret()

getName

public String getName()

Specified by:

getName in interface ICheckSettingsInternal

getScriptHooks

public Map<String,String> getScriptHooks()

Specified by:

getScriptHooks in interface ICheckSettingsInternal

getSizeMode

public String getSizeMode()

Specified by:

getSizeMode in interface ICheckSettingsInternal

updateTargetRegion

protected void updateTargetRegion(Region region)

populateClone

protected void populateClone(CheckSettings clone)

setStitchContent

public void setStitchContent(boolean stitchContent)

isEnablePatterns

public Boolean isEnablePatterns()

getVGTargetSelector

public VisualGridSelector getVGTargetSelector()

Specified by:

getVGTargetSelector in interface ICheckSettingsInternal

enablePatterns

public ICheckSettings enablePatterns(Boolean enablePatterns)

Specified by:

enablePatterns in interface ICheckSettings

enablePatterns

public ICheckSettings enablePatterns()

Specified by:

enablePatterns in interface ICheckSettings

scriptHook

@Deprecated
public ICheckSettings scriptHook(String hook)

Deprecated.

Specified by:

scriptHook in interface ICheckSettings

beforeRenderScreenshotHook

public ICheckSettings beforeRenderScreenshotHook(String hook)

Specified by:

beforeRenderScreenshotHook in interface ICheckSettings

ignoreDisplacements

public ICheckSettings ignoreDisplacements(Boolean ignoreDisplacements)

Specified by:

ignoreDisplacements in interface ICheckSettings

ignoreDisplacements

public ICheckSettings ignoreDisplacements()

Specified by:

ignoreDisplacements in interface ICheckSettings

accessibility_

protected void accessibility_(GetAccessibilityRegion accessibilityRegionProvider)

accessibility_

protected void accessibility_(Region rect,
                              AccessibilityRegionType regionType)

accessibility

public ICheckSettings accessibility(Region region,
                                    AccessibilityRegionType regionType)

Specified by:

accessibility in interface ICheckSettings

accessibility

protected void accessibility(GetAccessibilityRegion accessibilityRegionProvider)

getAccessibilityRegions

public GetAccessibilityRegion[] getAccessibilityRegions()

ocrRegion

public ICheckSettings ocrRegion(BaseOcrRegion ocrRegion)

getOcrRegion

public BaseOcrRegion getOcrRegion()

variationGroupId

public ICheckSettings variationGroupId(String variationGroupId)

getVariationGroupId

public String getVariationGroupId()

getStepPositionProvider

public PositionProvider getStepPositionProvider()

Internal Usage

visualGridOptions

public ICheckSettings visualGridOptions(VisualGridOption... options)

Specified by:

visualGridOptions in interface ICheckSettings

isCheckWindow

public Boolean isCheckWindow()

Specified by:

isCheckWindow in interface ICheckSettings

getVisualGridOptions

public List<VisualGridOption> getVisualGridOptions()

Specified by:

getVisualGridOptions in interface ICheckSettingsInternal

isDisableBrowserFetching

public Boolean isDisableBrowserFetching()

Specified by:

isDisableBrowserFetching in interface ICheckSettingsInternal

setDisableBrowserFetching

public ICheckSettings setDisableBrowserFetching(Boolean disableBrowserFetching)

Specified by:

setDisableBrowserFetching in interface ICheckSettingsInternal