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

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

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
ICheckSettings	content() Shortcut to set the match level to MatchLevel.CONTENT.
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.
GetFloatingRegion[]	getFloatingRegions()
Boolean	getIgnoreCaret()
GetRegion[]	getIgnoreRegions()
MatchLevel	getMatchLevel()
boolean	getStitchContent()
Region	getTargetRegion()
int	getTimeout()
protected void	ignore(GetRegion regionProvider)
ICheckSettings	ignore(Region... regions) Adds one or more ignore regions.
protected void	ignore(Region region)
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.
protected void	updateTargetRegion(Region region)

Methods inherited from class java.lang.Object

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

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)

floating_

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

floating

protected void floating(GetFloatingRegion regionProvider)

ignore

public ICheckSettings ignore(Region... regions)

Adds one or more ignore regions.

Specified by:

ignore in interface ICheckSettings

Parameters:

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

Returns:

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

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

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

This instance of the settings object.

timeout

public ICheckSettings timeout(int 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:

This instance of the settings object.

layout

public ICheckSettings layout()

Shortcut to set the match level to MatchLevel.LAYOUT.

Specified by:

layout in interface ICheckSettings

Returns:

This instance of the settings object.

exact

public ICheckSettings exact()

Shortcut to set the match level to MatchLevel.EXACT.

Specified by:

exact in interface ICheckSettings

Returns:

This instance of the settings object.

strict

public ICheckSettings strict()

Shortcut to set the match level to MatchLevel.STRICT.

Specified by:

strict in interface ICheckSettings

Returns:

This instance of the settings object.

content

public ICheckSettings content()

Shortcut to set the match level to MatchLevel.CONTENT.

Specified by:

content in interface ICheckSettings

Returns:

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

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

This instance of the settings object.

ignoreCaret

public ICheckSettings ignoreCaret()

Defines to ignore a blinking caret in the screenshot.

Specified by:

ignoreCaret in interface ICheckSettings

Returns:

This instance of the settings object.

getTargetRegion

public Region getTargetRegion()

Specified by:

getTargetRegion in interface ICheckSettingsInternal

getTimeout

public int getTimeout()

Specified by:

getTimeout in interface ICheckSettingsInternal

getStitchContent

public boolean getStitchContent()

Specified by:

getStitchContent in interface ICheckSettingsInternal

getMatchLevel

public MatchLevel getMatchLevel()

Specified by:

getMatchLevel in interface ICheckSettingsInternal

getIgnoreRegions

public GetRegion[] getIgnoreRegions()

Specified by:

getIgnoreRegions in interface ICheckSettingsInternal

getFloatingRegions

public GetFloatingRegion[] getFloatingRegions()

Specified by:

getFloatingRegions in interface ICheckSettingsInternal

getIgnoreCaret

public Boolean getIgnoreCaret()

Specified by:

getIgnoreCaret in interface ICheckSettingsInternal

updateTargetRegion

protected void updateTargetRegion(Region region)