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<GetRegion>	accessibilityRegions
protected static String	BEFORE_CAPTURE_SCREENSHOT
protected List<GetRegion>	contentRegions
protected Boolean	enablePatterns
protected List<GetRegion>	floatingRegions
protected Boolean	ignoreDisplacements
protected List<GetRegion>	ignoreRegions
protected List<GetRegion>	layoutRegions
protected String	name
protected String	pageId
protected Map<String,String>	scriptHooks
protected Boolean	sendDom
protected List<GetRegion>	strictRegions
protected Boolean	useDom

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CheckSettings()
	CheckSettings(Integer retryTimeout) For internal use only.
protected	CheckSettings(com.applitools.eyes.Region region)

Method Summary

Modifier and Type	Method and Description
protected void	accessibility_(GetRegion accessibilityRegionProvider)
protected void	accessibility_(com.applitools.eyes.Region rect, AccessibilityRegionType regionType)
protected void	accessibility(GetRegion accessibilityRegionProvider)
ICheckSettings	accessibility(com.applitools.eyes.Region region, AccessibilityRegionType regionType)
ICheckSettings	autProxy(com.applitools.eyes.AutProxySettings autProxy)
ICheckSettings	beforeRenderScreenshotHook(String hook)
CheckSettings	clone()
protected void	content_(GetRegion regionProvider)
protected void	content_(com.applitools.eyes.Region region)
ICheckSettings	content() Shortcut to set the match level to MatchLevel.CONTENT.
ICheckSettings	content(com.applitools.eyes.Region[] regions) Adds one or more content regions.
ICheckSettings	content(com.applitools.eyes.Region region, com.applitools.eyes.Region... regions) Adds one or more content regions.
ICheckSettings	densityMetrics(int xDpi, int yDpi) sets the density metrics for the screenshot
ICheckSettings	densityMetrics(int xDpi, int yDpi, Double scaleRatio) sets the density metrics for the screenshot.
ICheckSettings	enablePatterns()
ICheckSettings	enablePatterns(Boolean enablePatterns)
ICheckSettings	exact() Shortcut to set the match level to MatchLevel.EXACT.
protected void	floating_(com.applitools.eyes.Region region, int maxUpOffset, int maxDownOffset, int maxLeftOffset, int maxRightOffset)
protected void	floating(GetRegion regionProvider)
ICheckSettings	floating(int maxOffset, com.applitools.eyes.Region... regions) Adds a floating region.
ICheckSettings	floating(com.applitools.eyes.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.
GetRegion[]	getAccessibilityRegions()
AccessibilitySettings	getAccessibilityValidation()
com.applitools.eyes.AutProxySettings	getAutProxy()
GetRegion[]	getContentRegions()
DensityMetrics	getDensityMetrics()
GetRegion[]	getFloatingRegions()
Boolean	getHideCaret()
Boolean	getHideScrollBars()
Boolean	getIgnoreCaret()
GetRegion[]	getIgnoreRegions()
List<Integer>	getLayoutBreakpoints()
GetRegion[]	getLayoutRegions()
LazyLoadOptions	getLazyLoadOptions()
MatchLevel	getMatchLevel()
String	getName()
BaseOcrRegion	getOcrRegion()
Integer	getOverlap()
String	getPageId()
Map<String,String>	getScriptHooks()
String	getSizeMode()
PositionProvider	getStepPositionProvider() Internal Usage
Boolean	getStitchContent()
StitchMode	getStitchMode()
GetRegion[]	getStrictRegions()
com.applitools.eyes.Region	getTargetRegion()
Integer	getTimeout()
String	getVariationGroupId()
List<VisualGridOption>	getVisualGridOptions()
Integer	getWaitBeforeCapture()
protected void	ignore_(GetRegion regionProvider)
protected void	ignore_(com.applitools.eyes.Region region)
ICheckSettings	ignore(com.applitools.eyes.Region[] regions) Adds one or more ignore regions.
ICheckSettings	ignore(com.applitools.eyes.Region region, com.applitools.eyes.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	ignoreColors()
ICheckSettings	ignoreDisplacements()
ICheckSettings	ignoreDisplacements(Boolean ignoreDisplacements)
Boolean	isCheckWindow()
Boolean	isDefaultLayoutBreakpointsSet()
Boolean	isDisableBrowserFetching()
Boolean	isEnablePatterns()
Boolean	isIgnoreDisplacements()
Boolean	isSendDom()
Boolean	isStitchContent()
Boolean	isUseDom()
protected void	layout_(GetRegion regionProvider)
protected void	layout_(com.applitools.eyes.Region region)
ICheckSettings	layout() Shortcut to set the match level to MatchLevel.LAYOUT.
ICheckSettings	layout(com.applitools.eyes.Region[] regions) Adds one or more layout regions.
ICheckSettings	layout(com.applitools.eyes.Region region, com.applitools.eyes.Region... regions) Adds one or more layout regions.
ICheckSettings	lazyLoad() to handle lazy load will scroll before capturing
ICheckSettings	lazyLoad(LazyLoadOptions lazyLoadOptions) to handle lazy load will scroll before capturing
ICheckSettings	matchLevel(MatchLevel matchLevel) Set the match level by which to compare the screenshot.
ICheckSettings	ocrRegion(BaseOcrRegion ocrRegion)
ICheckSettings	pageId(String pageId)
protected void	populateClone(CheckSettings clone)
ICheckSettings	scriptHook(String hook) Deprecated.
ICheckSettings	sendDom()
ICheckSettings	sendDom(Boolean sendDom)
ICheckSettings	setAccessibilityValidation(AccessibilitySettings accessibilitySettings)
ICheckSettings	setDisableBrowserFetching(Boolean disableBrowserFetching)
ICheckSettings	setHideCaret(Boolean hideCaret)
ICheckSettings	setHideScrollBars(Boolean hideScrollBars)
ICheckSettings	setLayoutBreakpoints(Boolean shouldSet)
ICheckSettings	setLayoutBreakpoints(int... breakpoints)
ICheckSettings	setOverlap(Integer overlap)
void	setStitchContent(boolean stitchContent)
ICheckSettings	stitchMode(StitchMode stitchMode)
ICheckSettings	stitchOverlap(Integer overlap)
ICheckSettings	stitchOverlap(StitchOverlap stitchOverlap)
protected void	strict_(GetRegion regionProvider)
protected void	strict_(com.applitools.eyes.Region region)
ICheckSettings	strict() Shortcut to set the match level to MatchLevel.STRICT.
ICheckSettings	strict(com.applitools.eyes.Region[] regions) Adds one or more strict regions.
ICheckSettings	strict(com.applitools.eyes.Region region, com.applitools.eyes.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(com.applitools.eyes.Region region)
ICheckSettings	useDom(Boolean useDom)
ICheckSettings	variationGroupId(String variationGroupId)
ICheckSettings	visualGridOptions(VisualGridOption... options)
ICheckSettings	waitBeforeCapture(Integer milliSec) waits before every screenshot capturing.
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

ignoreDisplacements

protected Boolean ignoreDisplacements

name

protected String name

pageId

protected String pageId

ignoreRegions

protected final List<GetRegion> ignoreRegions

layoutRegions

protected final List<GetRegion> layoutRegions

strictRegions

protected final List<GetRegion> strictRegions

contentRegions

protected final List<GetRegion> contentRegions

floatingRegions

protected final List<GetRegion> floatingRegions

accessibilityRegions

protected List<GetRegion> accessibilityRegions

sendDom

protected Boolean sendDom

useDom

protected Boolean useDom

enablePatterns

protected Boolean enablePatterns

scriptHooks

protected Map<String,String> scriptHooks

Constructor Detail

CheckSettings

protected CheckSettings()

CheckSettings

protected CheckSettings(com.applitools.eyes.Region region)

CheckSettings

public CheckSettings(Integer retryTimeout)

For internal use only.

Parameters:

retryTimeout - timeout

Method Detail

ignore_

protected void ignore_(com.applitools.eyes.Region region)

ignore_

protected void ignore_(GetRegion regionProvider)

layout_

protected void layout_(com.applitools.eyes.Region region)

layout_

protected void layout_(GetRegion regionProvider)

content_

protected void content_(com.applitools.eyes.Region region)

content_

protected void content_(GetRegion regionProvider)

strict_

protected void strict_(com.applitools.eyes.Region region)

strict_

protected void strict_(GetRegion regionProvider)

floating_

protected void floating_(com.applitools.eyes.Region region,
                         int maxUpOffset,
                         int maxDownOffset,
                         int maxLeftOffset,
                         int maxRightOffset)

floating

protected void floating(GetRegion 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(com.applitools.eyes.Region region,
                             com.applitools.eyes.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(com.applitools.eyes.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(com.applitools.eyes.Region region,
                             com.applitools.eyes.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(com.applitools.eyes.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(com.applitools.eyes.Region region,
                             com.applitools.eyes.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(com.applitools.eyes.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(com.applitools.eyes.Region region,
                              com.applitools.eyes.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(com.applitools.eyes.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,
                               com.applitools.eyes.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(com.applitools.eyes.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.

ignoreColors

public ICheckSettings ignoreColors()

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 com.applitools.eyes.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 GetRegion[] getIgnoreRegions()

getStrictRegions

public GetRegion[] getStrictRegions()

getLayoutRegions

public GetRegion[] getLayoutRegions()

getContentRegions

public GetRegion[] getContentRegions()

getFloatingRegions

public GetRegion[] 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(com.applitools.eyes.Region region)

populateClone

protected void populateClone(CheckSettings clone)

setStitchContent

public void setStitchContent(boolean stitchContent)

isEnablePatterns

public Boolean isEnablePatterns()

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_(GetRegion accessibilityRegionProvider)

accessibility_

protected void accessibility_(com.applitools.eyes.Region rect,
                              AccessibilityRegionType regionType)

accessibility

public ICheckSettings accessibility(com.applitools.eyes.Region region,
                                    AccessibilityRegionType regionType)

Specified by:

accessibility in interface ICheckSettings

accessibility

protected void accessibility(GetRegion accessibilityRegionProvider)

getAccessibilityRegions

public GetRegion[] 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

waitBeforeCapture

public ICheckSettings waitBeforeCapture(Integer milliSec)

Description copied from interface: ICheckSettings

waits before every screenshot capturing.

Specified by:

waitBeforeCapture in interface ICheckSettings

Parameters:

milliSec - wait time.

Returns:

An updated clone of this settings object.

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

getWaitBeforeCapture

public Integer getWaitBeforeCapture()

lazyLoad

public ICheckSettings lazyLoad()

Description copied from interface: ICheckSettings

to handle lazy load will scroll before capturing

Specified by:

lazyLoad in interface ICheckSettings

Returns:

An updated clone of this settings object.

lazyLoad

public ICheckSettings lazyLoad(LazyLoadOptions lazyLoadOptions)

Description copied from interface: ICheckSettings

to handle lazy load will scroll before capturing

Specified by:

lazyLoad in interface ICheckSettings

Parameters:

lazyLoadOptions - lazy load options

Returns:

An updated clone of this settings object.

getLazyLoadOptions

public LazyLoadOptions getLazyLoadOptions()

getAutProxy

public com.applitools.eyes.AutProxySettings getAutProxy()

autProxy

public ICheckSettings autProxy(com.applitools.eyes.AutProxySettings autProxy)

getAccessibilityValidation

public AccessibilitySettings getAccessibilityValidation()

setAccessibilityValidation

public ICheckSettings setAccessibilityValidation(AccessibilitySettings accessibilitySettings)

getStitchMode

public StitchMode getStitchMode()

stitchMode

public ICheckSettings stitchMode(StitchMode stitchMode)

getHideScrollBars

public Boolean getHideScrollBars()

setHideScrollBars

public ICheckSettings setHideScrollBars(Boolean hideScrollBars)

getHideCaret

public Boolean getHideCaret()

setHideCaret

public ICheckSettings setHideCaret(Boolean hideCaret)

getOverlap

public Integer getOverlap()

setOverlap

public ICheckSettings setOverlap(Integer overlap)

stitchOverlap

public ICheckSettings stitchOverlap(Integer overlap)

stitchOverlap

public ICheckSettings stitchOverlap(StitchOverlap stitchOverlap)

setLayoutBreakpoints

public ICheckSettings setLayoutBreakpoints(Boolean shouldSet)

isDefaultLayoutBreakpointsSet

public Boolean isDefaultLayoutBreakpointsSet()

setLayoutBreakpoints

public ICheckSettings setLayoutBreakpoints(int... breakpoints)

getLayoutBreakpoints

public List<Integer> getLayoutBreakpoints()

pageId

public ICheckSettings pageId(String pageId)

getPageId

public String getPageId()

densityMetrics

public ICheckSettings densityMetrics(int xDpi,
                                     int yDpi)

Description copied from interface: ICheckSettings

sets the density metrics for the screenshot

Specified by:

densityMetrics in interface ICheckSettings

Parameters:

xDpi - the exact physical pixels per inch of the screen in the X dimension

yDpi - the exact physical pixels per inch of the screen in the Y dimension

Returns:

@return An updated clone of this settings object

densityMetrics

public ICheckSettings densityMetrics(int xDpi,
                                     int yDpi,
                                     Double scaleRatio)

Description copied from interface: ICheckSettings

sets the density metrics for the screenshot.

Specified by:

densityMetrics in interface ICheckSettings

Parameters:

xDpi - the exact physical pixels per inch of the screen in the X dimension

yDpi - the exact physical pixels per inch of the screen in the Y dimension

scaleRatio - the scale ratio

Returns:

@return An updated clone of this settings object

getDensityMetrics

public DensityMetrics getDensityMetrics()