Package com.applitools

Interface ICheckSettings

All Known Implementing Classes:

CheckSettings

public interface ICheckSettings

The interface of the match settings object.

Method Summary

Modifier and Type	Method	Description
ICheckSettings	accessibility(com.applitools.eyes.Region region, AccessibilityRegionType regionType)
ICheckSettings	beforeRenderScreenshotHook(String scriptHook)
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	dynamic()	Shortcut to set the match level to MatchLevel.DYNAMIC.
ICheckSettings	enablePatterns()
ICheckSettings	enablePatterns(Boolean enablePatterns)
ICheckSettings	exact()	Shortcut to set the match level to MatchLevel.EXACT.
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.
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	ignoreDisplacements()
ICheckSettings	ignoreDisplacements(Boolean ignoreDisplacements)
Boolean	isCheckWindow()
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	layoutBreakpoints(LayoutBreakpointsOptions layoutBreakpointsOptions)	sets layout breakpoints using options.
ICheckSettings	layoutBreakpoints(Boolean shouldSet)
ICheckSettings	layoutBreakpoints(Integer... breakpoints)
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	region(com.applitools.eyes.Region region)
ICheckSettings	scriptHook(String scriptHook)
ICheckSettings	sendDom()
ICheckSettings	sendDom(Boolean sendDom)
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.
ICheckSettings	useDom(Boolean useDom)
ICheckSettings	visualGridOptions(com.applitools.eyes.visualgrid.model.VisualGridOption... options)
ICheckSettings	waitBeforeCapture(Integer milliSec)	waits before every screenshot capturing.
ICheckSettings	withName(String name)	A setter for the checkpoint name.

Method Details

ignore

ICheckSettings ignore(com.applitools.eyes.Region region,
 com.applitools.eyes.Region... regions)

Adds one or more ignore regions.

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

ICheckSettings ignore(com.applitools.eyes.Region[] regions)

Adds one or more ignore regions.

Parameters:

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

Returns:

An updated clone of this settings object.

layout

ICheckSettings layout(com.applitools.eyes.Region region,
 com.applitools.eyes.Region... regions)

Adds one or more layout regions.

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

ICheckSettings layout(com.applitools.eyes.Region[] regions)

Adds one or more layout regions.

Parameters:

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

Returns:

An updated clone of this settings object.

strict

ICheckSettings strict(com.applitools.eyes.Region region,
 com.applitools.eyes.Region... regions)

Adds one or more strict regions.

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

ICheckSettings strict(com.applitools.eyes.Region[] regions)

Adds one or more strict regions.

Parameters:

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

Returns:

An updated clone of this settings object.

content

ICheckSettings content(com.applitools.eyes.Region region,
 com.applitools.eyes.Region... regions)

Adds one or more content regions.

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

ICheckSettings content(com.applitools.eyes.Region[] regions)

Adds one or more content regions.

Parameters:

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

Returns:

An updated clone of this settings object.

fully

ICheckSettings fully()

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

Returns:

An updated clone of this settings object.

fully

ICheckSettings fully(Boolean fully)

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

Parameters:

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

Returns:

An updated clone of this settings object.

floating

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.

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

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.

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

ICheckSettings timeout(Integer timeoutMilliseconds)

Defines the timeout to use when acquiring and comparing screenshots.

Parameters:

timeoutMilliseconds - The timeout to use in milliseconds.

Returns:

An updated clone of this settings object.

layout

ICheckSettings layout()

Shortcut to set the match level to MatchLevel.LAYOUT.

Returns:

An updated clone of this settings object.

dynamic

ICheckSettings dynamic()

Shortcut to set the match level to MatchLevel.DYNAMIC.

Returns:

An updated clone of this settings object.

exact

ICheckSettings exact()

Shortcut to set the match level to MatchLevel.EXACT.

Returns:

An updated clone of this settings object.

strict

ICheckSettings strict()

Shortcut to set the match level to MatchLevel.STRICT.

Returns:

An updated clone of this settings object.

content

ICheckSettings content()

Shortcut to set the match level to MatchLevel.CONTENT.

Returns:

An updated clone of this settings object.

matchLevel

ICheckSettings matchLevel(MatchLevel matchLevel)

Set the match level by which to compare the screenshot.

Parameters:

matchLevel - The match level to use.

Returns:

An updated clone of this settings object.

ignoreCaret

ICheckSettings ignoreCaret(Boolean ignoreCaret)

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

Parameters:

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

Returns:

An updated clone of this settings object.

ignoreCaret

ICheckSettings ignoreCaret()

Defines to ignore a blinking caret in the screenshot.

Returns:

An updated clone of this settings object.

withName

ICheckSettings withName(String name)

A setter for the checkpoint name.

Parameters:

name - A name by which to identify the checkpoint.

Returns:

An updated clone of this settings object.

useDom

ICheckSettings useDom(Boolean useDom)

sendDom

ICheckSettings sendDom(Boolean sendDom)

sendDom

ICheckSettings sendDom()

enablePatterns

ICheckSettings enablePatterns(Boolean enablePatterns)

enablePatterns

ICheckSettings enablePatterns()

scriptHook

ICheckSettings scriptHook(String scriptHook)

beforeRenderScreenshotHook

ICheckSettings beforeRenderScreenshotHook(String scriptHook)

ignoreDisplacements

ICheckSettings ignoreDisplacements(Boolean ignoreDisplacements)

ignoreDisplacements

ICheckSettings ignoreDisplacements()

accessibility

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

visualGridOptions

ICheckSettings visualGridOptions(com.applitools.eyes.visualgrid.model.VisualGridOption... options)

isCheckWindow

Boolean isCheckWindow()

waitBeforeCapture

ICheckSettings waitBeforeCapture(Integer milliSec)

waits before every screenshot capturing.

Parameters:

milliSec - wait time.

Returns:

An updated clone of this settings object.

lazyLoad

ICheckSettings lazyLoad()

to handle lazy load will scroll before capturing

Returns:

An updated clone of this settings object.

lazyLoad

ICheckSettings lazyLoad(LazyLoadOptions lazyLoadOptions)

to handle lazy load will scroll before capturing

Parameters:

lazyLoadOptions - lazy load options

Returns:

An updated clone of this settings object.

densityMetrics

ICheckSettings densityMetrics(int xDpi,
 int yDpi)

sets the density metrics for the screenshot

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

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

sets the density metrics for the screenshot.

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

layoutBreakpoints

ICheckSettings layoutBreakpoints(LayoutBreakpointsOptions layoutBreakpointsOptions)

sets layout breakpoints using options.

Parameters:

layoutBreakpointsOptions - the layout breakpoints options

Returns:

an updated clone of this settings object

layoutBreakpoints

ICheckSettings layoutBreakpoints(Integer... breakpoints)

layoutBreakpoints

ICheckSettings layoutBreakpoints(Boolean shouldSet)

region

ICheckSettings region(com.applitools.eyes.Region region)