com.applitools.eyes.fluent

Interface ICheckSettings

All Known Implementing Classes:

CheckSettings

public interface ICheckSettings

The interface of the match settings object.

Method Summary

Modifier and Type	Method and Description
ICheckSettings	content() Shortcut to set the match level to MatchLevel.CONTENT.
ICheckSettings	exact() Shortcut to set the match level to MatchLevel.EXACT.
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	ignore(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	layout() Shortcut to set the match level to MatchLevel.LAYOUT.
ICheckSettings	matchLevel(MatchLevel matchLevel) Set the match level by which to compare the screenshot.
ICheckSettings	strict() Shortcut to set the match level to MatchLevel.STRICT.
ICheckSettings	timeout(int timeoutMilliseconds) Defines the timeout to use when acquiring and comparing screenshots.

Method Detail

ignore

ICheckSettings ignore(Region... regions)

Adds one or more ignore regions.

Parameters:

regions - One or more regions to ignore when validating the screenshot.

Returns:

This instance of the settings object.

fully

ICheckSettings fully()

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

Returns:

This instance of the settings object.

floating

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.

Parameters:

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

regions - One or more content rectangles.

Returns:

This instance of the settings object.

floating

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.

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:

This instance of the settings object.

timeout

ICheckSettings timeout(int timeoutMilliseconds)

Defines the timeout to use when acquiring and comparing screenshots.

Parameters:

timeoutMilliseconds - The timeout to use in milliseconds.

Returns:

This instance of the settings object.

layout

ICheckSettings layout()

Shortcut to set the match level to MatchLevel.LAYOUT.

Returns:

This instance of the settings object.

exact

ICheckSettings exact()

Shortcut to set the match level to MatchLevel.EXACT.

Returns:

This instance of the settings object.

strict

ICheckSettings strict()

Shortcut to set the match level to MatchLevel.STRICT.

Returns:

This instance of the settings object.

content

ICheckSettings content()

Shortcut to set the match level to MatchLevel.CONTENT.

Returns:

This instance of the 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:

This instance of the 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:

This instance of the settings object.

ignoreCaret

ICheckSettings ignoreCaret()

Defines to ignore a blinking caret in the screenshot.

Returns:

This instance of the settings object.