Package com.applitools.eyes.selenium.fluent

Class SeleniumCheckSettings

java.lang.Object

com.applitools.eyes.fluent.CheckSettings

com.applitools.eyes.selenium.fluent.SeleniumCheckSettings

All Implemented Interfaces:

com.applitools.eyes.fluent.ICheckSettingsInternal, IScrollRootElementContainer, ISeleniumCheckTarget, com.applitools.ICheckSettings, com.applitools.ICheckSettingsInternal, Cloneable

public class SeleniumCheckSettings
extends com.applitools.eyes.fluent.CheckSettings
implements ISeleniumCheckTarget, Cloneable

Field Summary

Fields

Modifier and Type	Field	Description
static String	FULL_PAGE
static String	FULL_SELECTOR
static String	REGION
static String	SELECTOR
static String	VIEWPORT

Fields inherited from class com.applitools.eyes.fluent.CheckSettings

accessibilityRegions, BEFORE_CAPTURE_SCREENSHOT, contentRegions, enablePatterns, floatingRegions, ignoreDisplacements, ignoreRegions, layoutRegions, name, pageId, scriptHooks, sendDom, strictRegions, useDom

Constructor Summary

Constructors

Constructor	Description
SeleniumCheckSettings()
SeleniumCheckSettings(com.applitools.eyes.Region region)
SeleniumCheckSettings(com.applitools.eyes.Region region, boolean isSendDom)
SeleniumCheckSettings(TargetPathLocator targetLocator)
SeleniumCheckSettings(String tag)

Method Summary

Modifier and Type	Method	Description
SeleniumCheckSettings	accessibility(com.applitools.eyes.AccessibilityRegionType regionType, org.openqa.selenium.WebElement[] elementsToIgnore)
SeleniumCheckSettings	accessibility(org.openqa.selenium.By regionSelector, com.applitools.eyes.AccessibilityRegionType regionType)
SeleniumCheckSettings	accessibility(org.openqa.selenium.WebElement element, com.applitools.eyes.AccessibilityRegionType regionType)
SeleniumCheckSettings	beforeRenderScreenshotHook(String hook)
SeleniumCheckSettings	clone()
SeleniumCheckSettings	content()
SeleniumCheckSettings	content(com.applitools.eyes.Region[] regions)
SeleniumCheckSettings	content(com.applitools.eyes.Region region, com.applitools.eyes.Region... regions)
SeleniumCheckSettings	content(org.openqa.selenium.By[] regionSelectors)
SeleniumCheckSettings	content(org.openqa.selenium.By[] regionSelectors, String regionId)
SeleniumCheckSettings	content(org.openqa.selenium.By selector, int leftPadding, int topPadding, int rightPadding, int bottomPadding)
SeleniumCheckSettings	content(org.openqa.selenium.By selector, int leftPadding, int topPadding, int rightPadding, int bottomPadding, String regionId)
SeleniumCheckSettings	content(org.openqa.selenium.By selector, com.applitools.eyes.Padding padding)	add one content region with padding.
SeleniumCheckSettings	content(org.openqa.selenium.By selector, com.applitools.eyes.Padding padding, String regionId)	add one content region with padding and a region ID.
SeleniumCheckSettings	content(org.openqa.selenium.By regionSelector, String regionId, org.openqa.selenium.By... regionSelectors)
SeleniumCheckSettings	content(org.openqa.selenium.By regionSelector, org.openqa.selenium.By... regionSelectors)
SeleniumCheckSettings	content(org.openqa.selenium.WebElement[] elements)
SeleniumCheckSettings	content(org.openqa.selenium.WebElement[] elements, String regionId)
SeleniumCheckSettings	content(org.openqa.selenium.WebElement element, int leftPadding, int topPadding, int rightPadding, int bottomPadding)
SeleniumCheckSettings	content(org.openqa.selenium.WebElement element, int leftPadding, int topPadding, int rightPadding, int bottomPadding, String regionId)
SeleniumCheckSettings	content(org.openqa.selenium.WebElement element, com.applitools.eyes.Padding padding)	add one content region with padding.
SeleniumCheckSettings	content(org.openqa.selenium.WebElement element, com.applitools.eyes.Padding padding, String regionId)	add one content region with padding and a region ID
SeleniumCheckSettings	content(org.openqa.selenium.WebElement element, String regionId, org.openqa.selenium.WebElement... elements)
SeleniumCheckSettings	content(org.openqa.selenium.WebElement element, org.openqa.selenium.WebElement... elements)
SeleniumCheckSettings	densityMetrics(int xDpi, int yDpi)
SeleniumCheckSettings	densityMetrics(int xDpi, int yDpi, Double scaleRatio)
SeleniumCheckSettings	exact()
SeleniumCheckSettings	floating(org.openqa.selenium.By regionSelector, int maxUpOffset, int maxDownOffset, int maxLeftOffset, int maxRightOffset)
SeleniumCheckSettings	floating(org.openqa.selenium.By regionSelector, int maxUpOffset, int maxDownOffset, int maxLeftOffset, int maxRightOffset, String regionId)
SeleniumCheckSettings	floating(org.openqa.selenium.WebElement element, int maxUpOffset, int maxDownOffset, int maxLeftOffset, int maxRightOffset)
SeleniumCheckSettings	floating(org.openqa.selenium.WebElement element, int maxUpOffset, int maxDownOffset, int maxLeftOffset, int maxRightOffset, String regionId)
SeleniumCheckSettings	frame(int index)
SeleniumCheckSettings	frame(String frameNameOrId)
SeleniumCheckSettings	frame(org.openqa.selenium.By by)
SeleniumCheckSettings	frame(org.openqa.selenium.WebElement frameReference)
SeleniumCheckSettings	fully()
SeleniumCheckSettings	fully(Boolean fully)
List<FrameLocator>	getFrameChain()
List<Integer>	getLayoutBreakpoints()
com.applitools.eyes.options.LayoutBreakpointsOptions	getLayoutBreakpointsOptions()
com.applitools.eyes.LazyLoadOptions	getLazyLoadOptions()
Map<String,String>	getScriptHooks()
org.openqa.selenium.WebElement	getScrollRootElement()
org.openqa.selenium.By	getScrollRootSelector()
String	getSizeMode()
com.applitools.eyes.positioning.PositionProvider	getStepPositionProvider()	Deprecated.
TargetPathLocator	getTargetPathLocator()
SeleniumCheckSettings	hideCaret(Boolean hideCaret)
SeleniumCheckSettings	hideScrollBars(Boolean hideScrollBars)
SeleniumCheckSettings	ignore(com.applitools.eyes.Region[] regions)
SeleniumCheckSettings	ignore(com.applitools.eyes.Region region, com.applitools.eyes.Region... regions)
SeleniumCheckSettings	ignore(org.openqa.selenium.By[] regionSelectors)
SeleniumCheckSettings	ignore(org.openqa.selenium.By[] regionSelectors, String regionId)
SeleniumCheckSettings	ignore(org.openqa.selenium.By selector, int leftPadding, int topPadding, int rightPadding, int bottomPadding)
SeleniumCheckSettings	ignore(org.openqa.selenium.By selector, int leftPadding, int topPadding, int rightPadding, int bottomPadding, String regionId)
SeleniumCheckSettings	ignore(org.openqa.selenium.By selector, com.applitools.eyes.Padding padding)	add one ignore region with padding
SeleniumCheckSettings	ignore(org.openqa.selenium.By selector, com.applitools.eyes.Padding padding, String regionId)	add one ignore region with padding and a region ID
SeleniumCheckSettings	ignore(org.openqa.selenium.By regionSelector, String regionId, org.openqa.selenium.By... regionSelectors)
SeleniumCheckSettings	ignore(org.openqa.selenium.By regionSelector, org.openqa.selenium.By... regionSelectors)
SeleniumCheckSettings	ignore(org.openqa.selenium.WebElement[] elements)
SeleniumCheckSettings	ignore(org.openqa.selenium.WebElement[] elements, String regionId)
SeleniumCheckSettings	ignore(org.openqa.selenium.WebElement element, int leftPadding, int topPadding, int rightPadding, int bottomPadding)
SeleniumCheckSettings	ignore(org.openqa.selenium.WebElement element, int leftPadding, int topPadding, int rightPadding, int bottomPadding, String regionId)
SeleniumCheckSettings	ignore(org.openqa.selenium.WebElement element, com.applitools.eyes.Padding padding)	add one ignore region with padding
SeleniumCheckSettings	ignore(org.openqa.selenium.WebElement element, com.applitools.eyes.Padding padding, String regionId)	add one ignore region with padding and a region ID
SeleniumCheckSettings	ignore(org.openqa.selenium.WebElement element, String regionId, org.openqa.selenium.WebElement... elements)
SeleniumCheckSettings	ignore(org.openqa.selenium.WebElement element, org.openqa.selenium.WebElement... elements)
SeleniumCheckSettings	ignoreCaret()
SeleniumCheckSettings	ignoreCaret(Boolean ignoreCaret)
SeleniumCheckSettings	ignoreDisplacements()
SeleniumCheckSettings	ignoreDisplacements(boolean ignoreDisplacements)
Boolean	isDefaultLayoutBreakpointsSet()
SeleniumCheckSettings	layout()
SeleniumCheckSettings	layout(com.applitools.eyes.Region[] regions)
SeleniumCheckSettings	layout(com.applitools.eyes.Region region, com.applitools.eyes.Region... regions)
SeleniumCheckSettings	layout(org.openqa.selenium.By[] regionSelectors)
SeleniumCheckSettings	layout(org.openqa.selenium.By[] regionSelectors, String regionId)
SeleniumCheckSettings	layout(org.openqa.selenium.By selector, int leftPadding, int topPadding, int rightPadding, int bottomPadding)
SeleniumCheckSettings	layout(org.openqa.selenium.By selector, int leftPadding, int topPadding, int rightPadding, int bottomPadding, String regionId)
SeleniumCheckSettings	layout(org.openqa.selenium.By selector, com.applitools.eyes.Padding padding)	add one layout region with padding.
SeleniumCheckSettings	layout(org.openqa.selenium.By selector, com.applitools.eyes.Padding padding, String regionId)	add one layout region with padding and a region ID.
SeleniumCheckSettings	layout(org.openqa.selenium.By regionSelector, String regionId, org.openqa.selenium.By... regionSelectors)
SeleniumCheckSettings	layout(org.openqa.selenium.By regionSelector, org.openqa.selenium.By... regionSelectors)
SeleniumCheckSettings	layout(org.openqa.selenium.WebElement[] elements)
SeleniumCheckSettings	layout(org.openqa.selenium.WebElement[] elements, String regionId)
SeleniumCheckSettings	layout(org.openqa.selenium.WebElement element, int leftPadding, int topPadding, int rightPadding, int bottomPadding)
SeleniumCheckSettings	layout(org.openqa.selenium.WebElement element, int leftPadding, int topPadding, int rightPadding, int bottomPadding, String regionId)
SeleniumCheckSettings	layout(org.openqa.selenium.WebElement element, com.applitools.eyes.Padding padding)	add one layout region with padding.
SeleniumCheckSettings	layout(org.openqa.selenium.WebElement element, com.applitools.eyes.Padding padding, String regionId)	add one layout region with padding and a region ID
SeleniumCheckSettings	layout(org.openqa.selenium.WebElement element, String regionId, org.openqa.selenium.WebElement... elements)
SeleniumCheckSettings	layout(org.openqa.selenium.WebElement element, org.openqa.selenium.WebElement... elements)
SeleniumCheckSettings	layoutBreakpoints(int[] breakpoints)
SeleniumCheckSettings	layoutBreakpoints(com.applitools.eyes.options.LayoutBreakpointsOptions layoutBreakpointsOptions)
SeleniumCheckSettings	layoutBreakpoints(Boolean shouldSet)
SeleniumCheckSettings	layoutBreakpoints(Integer... breakpoints)
SeleniumCheckSettings	lazyLoad()
SeleniumCheckSettings	lazyLoad(com.applitools.eyes.LazyLoadOptions lazyLoadOptions)
SeleniumCheckSettings	matchLevel(com.applitools.eyes.MatchLevel matchLevel)
SeleniumCheckSettings	region(com.applitools.eyes.Region region)
SeleniumCheckSettings	region(TargetPathLocator targetPathLocator)
SeleniumCheckSettings	region(org.openqa.selenium.By by)
SeleniumCheckSettings	region(org.openqa.selenium.WebElement element)
SeleniumCheckSettings	scriptHook(String hook)	Deprecated.
SeleniumCheckSettings	scrollRootElement(org.openqa.selenium.By selector)
SeleniumCheckSettings	scrollRootElement(org.openqa.selenium.WebElement element)
SeleniumCheckSettings	setHideCaret(Boolean hideCaret)	Deprecated.
SeleniumCheckSettings	setHideScrollBars(Boolean hideScrollBars)	Deprecated.
SeleniumCheckSettings	stitchMode(com.applitools.eyes.selenium.StitchMode stitchMode)
SeleniumCheckSettings	stitchOverlap(com.applitools.eyes.StitchOverlap stitchOverlap)
SeleniumCheckSettings	stitchOverlap(Integer overlap)
SeleniumCheckSettings	strict()
SeleniumCheckSettings	strict(com.applitools.eyes.Region[] regions)
SeleniumCheckSettings	strict(com.applitools.eyes.Region region, com.applitools.eyes.Region... regions)
SeleniumCheckSettings	strict(org.openqa.selenium.By[] regionSelectors)
SeleniumCheckSettings	strict(org.openqa.selenium.By[] regionSelectors, String regionId)
SeleniumCheckSettings	strict(org.openqa.selenium.By selector, int leftPadding, int topPadding, int rightPadding, int bottomPadding)
SeleniumCheckSettings	strict(org.openqa.selenium.By selector, int leftPadding, int topPadding, int rightPadding, int bottomPadding, String regionId)
SeleniumCheckSettings	strict(org.openqa.selenium.By selector, com.applitools.eyes.Padding padding)	add one strict region with padding.
SeleniumCheckSettings	strict(org.openqa.selenium.By selector, com.applitools.eyes.Padding padding, String regionId)	add one strict region with padding and a region ID.
SeleniumCheckSettings	strict(org.openqa.selenium.By regionSelector, String regionId, org.openqa.selenium.By... regionSelectors)
SeleniumCheckSettings	strict(org.openqa.selenium.By regionSelector, org.openqa.selenium.By... regionSelectors)
SeleniumCheckSettings	strict(org.openqa.selenium.WebElement[] elements)
SeleniumCheckSettings	strict(org.openqa.selenium.WebElement[] elements, String regionId)
SeleniumCheckSettings	strict(org.openqa.selenium.WebElement element, int leftPadding, int topPadding, int rightPadding, int bottomPadding)
SeleniumCheckSettings	strict(org.openqa.selenium.WebElement element, int leftPadding, int topPadding, int rightPadding, int bottomPadding, String regionId)
SeleniumCheckSettings	strict(org.openqa.selenium.WebElement element, com.applitools.eyes.Padding padding)	add one strict region with padding.
SeleniumCheckSettings	strict(org.openqa.selenium.WebElement element, com.applitools.eyes.Padding padding, String regionId)	add one strict region with padding and a region ID
SeleniumCheckSettings	strict(org.openqa.selenium.WebElement element, String regionId, org.openqa.selenium.WebElement... elements)
SeleniumCheckSettings	strict(org.openqa.selenium.WebElement element, org.openqa.selenium.WebElement... elements)
SeleniumCheckSettings	timeout(Integer timeoutMilliseconds)
SeleniumCheckSettings	withName(String name)

Methods inherited from class com.applitools.eyes.fluent.CheckSettings

accessibility, accessibility, accessibility_, accessibility_, autProxy, content_, content_, enablePatterns, enablePatterns, floating, floating, floating, floating_, getAccessibilityRegions, getAccessibilityValidation, getAutProxy, getContentRegions, getDensityMetrics, getFloatingRegions, getHideCaret, getHideScrollBars, getIgnoreCaret, getIgnoreRegions, getLayoutRegions, getMatchLevel, getName, getOcrRegion, getOverlap, getPageId, getStitchContent, getStitchMode, getStitchOverlap, getStrictRegions, getTargetRegion, getTimeout, getVariationGroupId, getVisualGridOptions, getWaitBeforeCapture, ignore_, ignore_, ignoreColors, ignoreDisplacements, isCheckWindow, isDisableBrowserFetching, isEnablePatterns, isIgnoreDisplacements, isSendDom, isStitchContent, isUseDom, layout_, layout_, ocrRegion, pageId, populateClone, sendDom, sendDom, setAccessibilityValidation, setDisableBrowserFetching, setLayoutBreakpoints, setLayoutBreakpoints, setLayoutBreakpoints, setOverlap, setStitchContent, strict_, strict_, updateTargetRegion, useDom, variationGroupId, visualGridOptions, waitBeforeCapture

Methods inherited from class java.lang.Object

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

Field Detail

FULL_PAGE

public static final String FULL_PAGE

See Also:

Constant Field Values

VIEWPORT

public static final String VIEWPORT

See Also:

Constant Field Values

REGION

public static final String REGION

See Also:

Constant Field Values

SELECTOR

public static final String SELECTOR

See Also:

Constant Field Values

FULL_SELECTOR

public static final String FULL_SELECTOR

See Also:

Constant Field Values

Constructor Detail

SeleniumCheckSettings

public SeleniumCheckSettings()

SeleniumCheckSettings

public SeleniumCheckSettings(com.applitools.eyes.Region region)

SeleniumCheckSettings

public SeleniumCheckSettings(String tag)

SeleniumCheckSettings

public SeleniumCheckSettings(TargetPathLocator targetLocator)

SeleniumCheckSettings

public SeleniumCheckSettings(com.applitools.eyes.Region region,
                             boolean isSendDom)

Method Detail

getFrameChain

public List<FrameLocator> getFrameChain()

Specified by:

getFrameChain in interface ISeleniumCheckTarget

clone

public SeleniumCheckSettings clone()

Specified by:

clone in interface com.applitools.ICheckSettingsInternal

Overrides:

clone in class com.applitools.eyes.fluent.CheckSettings

frame

public SeleniumCheckSettings frame(org.openqa.selenium.By by)

frame

public SeleniumCheckSettings frame(String frameNameOrId)

frame

public SeleniumCheckSettings frame(int index)

frame

public SeleniumCheckSettings frame(org.openqa.selenium.WebElement frameReference)

region

public SeleniumCheckSettings region(com.applitools.eyes.Region region)

Specified by:

region in interface com.applitools.ICheckSettings

Overrides:

region in class com.applitools.eyes.fluent.CheckSettings

region

public SeleniumCheckSettings region(org.openqa.selenium.WebElement element)

region

public SeleniumCheckSettings region(org.openqa.selenium.By by)

region

public SeleniumCheckSettings region(TargetPathLocator targetPathLocator)

ignore

public SeleniumCheckSettings ignore(org.openqa.selenium.By regionSelector,
                                    org.openqa.selenium.By... regionSelectors)

ignore

public SeleniumCheckSettings ignore(org.openqa.selenium.By regionSelector,
                                    String regionId,
                                    org.openqa.selenium.By... regionSelectors)

ignore

public SeleniumCheckSettings ignore(org.openqa.selenium.WebElement element,
                                    org.openqa.selenium.WebElement... elements)

ignore

public SeleniumCheckSettings ignore(org.openqa.selenium.WebElement element,
                                    String regionId,
                                    org.openqa.selenium.WebElement... elements)

ignore

public SeleniumCheckSettings ignore(org.openqa.selenium.By[] regionSelectors)

ignore

public SeleniumCheckSettings ignore(org.openqa.selenium.By[] regionSelectors,
                                    String regionId)

ignore

public SeleniumCheckSettings ignore(org.openqa.selenium.WebElement[] elements)

ignore

public SeleniumCheckSettings ignore(org.openqa.selenium.WebElement[] elements,
                                    String regionId)

ignore

public SeleniumCheckSettings ignore(org.openqa.selenium.By selector,
                                    com.applitools.eyes.Padding padding)

add one ignore region with padding

Parameters:

selector - By selector to ignore when validating the screenshot.

padding - Padding to add around the ignore region

Returns:

An updated clone of this settings object.

ignore

public SeleniumCheckSettings ignore(org.openqa.selenium.By selector,
                                    com.applitools.eyes.Padding padding,
                                    String regionId)

add one ignore region with padding and a region ID

Parameters:

selector - By selector to ignore when validating the screenshot.

padding - Padding to add around the ignore region.

regionId - The region ID

Returns:

An updated clone of this settings object.

ignore

public SeleniumCheckSettings ignore(org.openqa.selenium.WebElement element,
                                    com.applitools.eyes.Padding padding)

add one ignore region with padding

Parameters:

element - WebElement to ignore when validating the screenshot.

padding - Padding to add around the ignore region

Returns:

An updated clone of this settings object.

ignore

public SeleniumCheckSettings ignore(org.openqa.selenium.WebElement element,
                                    com.applitools.eyes.Padding padding,
                                    String regionId)

add one ignore region with padding and a region ID

Parameters:

element - WebElement to ignore when validating the screenshot.

padding - Padding to add around the ignore region.

regionId - The region ID

Returns:

An updated clone of this settings object.

ignore

public SeleniumCheckSettings ignore(org.openqa.selenium.By selector,
                                    int leftPadding,
                                    int topPadding,
                                    int rightPadding,
                                    int bottomPadding)

ignore

public SeleniumCheckSettings ignore(org.openqa.selenium.By selector,
                                    int leftPadding,
                                    int topPadding,
                                    int rightPadding,
                                    int bottomPadding,
                                    String regionId)

ignore

public SeleniumCheckSettings ignore(org.openqa.selenium.WebElement element,
                                    int leftPadding,
                                    int topPadding,
                                    int rightPadding,
                                    int bottomPadding)

ignore

public SeleniumCheckSettings ignore(org.openqa.selenium.WebElement element,
                                    int leftPadding,
                                    int topPadding,
                                    int rightPadding,
                                    int bottomPadding,
                                    String regionId)

layout

public SeleniumCheckSettings layout(org.openqa.selenium.By regionSelector,
                                    org.openqa.selenium.By... regionSelectors)

layout

public SeleniumCheckSettings layout(org.openqa.selenium.By regionSelector,
                                    String regionId,
                                    org.openqa.selenium.By... regionSelectors)

layout

public SeleniumCheckSettings layout(org.openqa.selenium.WebElement element,
                                    org.openqa.selenium.WebElement... elements)

layout

public SeleniumCheckSettings layout(org.openqa.selenium.WebElement element,
                                    String regionId,
                                    org.openqa.selenium.WebElement... elements)

layout

public SeleniumCheckSettings layout(org.openqa.selenium.By[] regionSelectors)

layout

public SeleniumCheckSettings layout(org.openqa.selenium.By[] regionSelectors,
                                    String regionId)

layout

public SeleniumCheckSettings layout(org.openqa.selenium.WebElement[] elements)

layout

public SeleniumCheckSettings layout(org.openqa.selenium.WebElement[] elements,
                                    String regionId)

layout

public SeleniumCheckSettings layout(org.openqa.selenium.By selector,
                                    com.applitools.eyes.Padding padding)

add one layout region with padding.

Parameters:

selector - By selector to match using the Layout method.

padding - Padding to add around the layout region.

Returns:

An updated clone of this settings object.

layout

public SeleniumCheckSettings layout(org.openqa.selenium.By selector,
                                    com.applitools.eyes.Padding padding,
                                    String regionId)

add one layout region with padding and a region ID.

Parameters:

selector - By selector to match using the Layout method.

padding - Padding to add around the layout region.

regionId - The region ID.

Returns:

An updated clone of this settings object.

layout

public SeleniumCheckSettings layout(org.openqa.selenium.WebElement element,
                                    com.applitools.eyes.Padding padding)

add one layout region with padding.

Parameters:

element - WebElement to match using the Layout method.

padding - Padding to add around the layout region.

Returns:

An updated clone of this settings object.

layout

public SeleniumCheckSettings layout(org.openqa.selenium.WebElement element,
                                    com.applitools.eyes.Padding padding,
                                    String regionId)

add one layout region with padding and a region ID

Parameters:

element - WebElement to match using the Layout method.

padding - Padding to add around the layout region.

regionId - The region ID.

Returns:

An updated clone of this settings object.

layout

public SeleniumCheckSettings layout(org.openqa.selenium.By selector,
                                    int leftPadding,
                                    int topPadding,
                                    int rightPadding,
                                    int bottomPadding)

layout

public SeleniumCheckSettings layout(org.openqa.selenium.By selector,
                                    int leftPadding,
                                    int topPadding,
                                    int rightPadding,
                                    int bottomPadding,
                                    String regionId)

layout

public SeleniumCheckSettings layout(org.openqa.selenium.WebElement element,
                                    int leftPadding,
                                    int topPadding,
                                    int rightPadding,
                                    int bottomPadding)

layout

public SeleniumCheckSettings layout(org.openqa.selenium.WebElement element,
                                    int leftPadding,
                                    int topPadding,
                                    int rightPadding,
                                    int bottomPadding,
                                    String regionId)

strict

public SeleniumCheckSettings strict(org.openqa.selenium.By regionSelector,
                                    org.openqa.selenium.By... regionSelectors)

strict

public SeleniumCheckSettings strict(org.openqa.selenium.By regionSelector,
                                    String regionId,
                                    org.openqa.selenium.By... regionSelectors)

strict

public SeleniumCheckSettings strict(org.openqa.selenium.WebElement element,
                                    org.openqa.selenium.WebElement... elements)

strict

public SeleniumCheckSettings strict(org.openqa.selenium.WebElement element,
                                    String regionId,
                                    org.openqa.selenium.WebElement... elements)

strict

public SeleniumCheckSettings strict(org.openqa.selenium.By[] regionSelectors)

strict

public SeleniumCheckSettings strict(org.openqa.selenium.By[] regionSelectors,
                                    String regionId)

strict

public SeleniumCheckSettings strict(org.openqa.selenium.WebElement[] elements)

strict

public SeleniumCheckSettings strict(org.openqa.selenium.WebElement[] elements,
                                    String regionId)

strict

public SeleniumCheckSettings strict(org.openqa.selenium.By selector,
                                    com.applitools.eyes.Padding padding)

add one strict region with padding.

Parameters:

selector - By selector to match using the Strict method.

padding - Padding to add around the strict region.

Returns:

An updated clone of this settings object.

strict

public SeleniumCheckSettings strict(org.openqa.selenium.By selector,
                                    com.applitools.eyes.Padding padding,
                                    String regionId)

add one strict region with padding and a region ID.

Parameters:

selector - By selector to match using the Strict method.

padding - Padding to add around the strict region.

regionId - The region ID.

Returns:

An updated clone of this settings object.

strict

public SeleniumCheckSettings strict(org.openqa.selenium.WebElement element,
                                    com.applitools.eyes.Padding padding)

add one strict region with padding.

Parameters:

element - WebElement to match using the Strict method.

padding - Padding to add around the strict region.

Returns:

An updated clone of this settings object.

strict

public SeleniumCheckSettings strict(org.openqa.selenium.WebElement element,
                                    com.applitools.eyes.Padding padding,
                                    String regionId)

add one strict region with padding and a region ID

Parameters:

element - WebElement to match using the Strict method.

padding - Padding to add around the strict region.

regionId - The region ID.

Returns:

An updated clone of this settings object.

strict

public SeleniumCheckSettings strict(org.openqa.selenium.By selector,
                                    int leftPadding,
                                    int topPadding,
                                    int rightPadding,
                                    int bottomPadding)

strict

public SeleniumCheckSettings strict(org.openqa.selenium.By selector,
                                    int leftPadding,
                                    int topPadding,
                                    int rightPadding,
                                    int bottomPadding,
                                    String regionId)

strict

public SeleniumCheckSettings strict(org.openqa.selenium.WebElement element,
                                    int leftPadding,
                                    int topPadding,
                                    int rightPadding,
                                    int bottomPadding)

strict

public SeleniumCheckSettings strict(org.openqa.selenium.WebElement element,
                                    int leftPadding,
                                    int topPadding,
                                    int rightPadding,
                                    int bottomPadding,
                                    String regionId)

content

public SeleniumCheckSettings content(org.openqa.selenium.By regionSelector,
                                     org.openqa.selenium.By... regionSelectors)

content

public SeleniumCheckSettings content(org.openqa.selenium.By regionSelector,
                                     String regionId,
                                     org.openqa.selenium.By... regionSelectors)

content

public SeleniumCheckSettings content(org.openqa.selenium.WebElement element,
                                     org.openqa.selenium.WebElement... elements)

content

public SeleniumCheckSettings content(org.openqa.selenium.WebElement element,
                                     String regionId,
                                     org.openqa.selenium.WebElement... elements)

content

public SeleniumCheckSettings content(org.openqa.selenium.By[] regionSelectors)

content

public SeleniumCheckSettings content(org.openqa.selenium.By[] regionSelectors,
                                     String regionId)

content

public SeleniumCheckSettings content(org.openqa.selenium.WebElement[] elements)

content

public SeleniumCheckSettings content(org.openqa.selenium.WebElement[] elements,
                                     String regionId)

content

public SeleniumCheckSettings content(org.openqa.selenium.By selector,
                                     com.applitools.eyes.Padding padding)

add one content region with padding.

Parameters:

selector - By selector to match using the Content method.

padding - Padding to add around the content region.

Returns:

An updated clone of this settings object.

content

public SeleniumCheckSettings content(org.openqa.selenium.By selector,
                                     com.applitools.eyes.Padding padding,
                                     String regionId)

add one content region with padding and a region ID.

Parameters:

selector - By selector to match using the Content method.

padding - Padding to add around the content region.

regionId - The region ID.

Returns:

An updated clone of this settings object.

content

public SeleniumCheckSettings content(org.openqa.selenium.WebElement element,
                                     com.applitools.eyes.Padding padding)

add one content region with padding.

Parameters:

element - WebElement to match using the Content method.

padding - Padding to add around the content region.

Returns:

An updated clone of this settings object.

content

public SeleniumCheckSettings content(org.openqa.selenium.WebElement element,
                                     com.applitools.eyes.Padding padding,
                                     String regionId)

add one content region with padding and a region ID

Parameters:

element - WebElement to match using the Content method.

padding - Padding to add around the content region.

regionId - The region ID.

Returns:

An updated clone of this settings object.

content

public SeleniumCheckSettings content(org.openqa.selenium.By selector,
                                     int leftPadding,
                                     int topPadding,
                                     int rightPadding,
                                     int bottomPadding)

content

public SeleniumCheckSettings content(org.openqa.selenium.By selector,
                                     int leftPadding,
                                     int topPadding,
                                     int rightPadding,
                                     int bottomPadding,
                                     String regionId)

content

public SeleniumCheckSettings content(org.openqa.selenium.WebElement element,
                                     int leftPadding,
                                     int topPadding,
                                     int rightPadding,
                                     int bottomPadding)

content

public SeleniumCheckSettings content(org.openqa.selenium.WebElement element,
                                     int leftPadding,
                                     int topPadding,
                                     int rightPadding,
                                     int bottomPadding,
                                     String regionId)

floating

public SeleniumCheckSettings floating(org.openqa.selenium.By regionSelector,
                                      int maxUpOffset,
                                      int maxDownOffset,
                                      int maxLeftOffset,
                                      int maxRightOffset)

floating

public SeleniumCheckSettings floating(org.openqa.selenium.By regionSelector,
                                      int maxUpOffset,
                                      int maxDownOffset,
                                      int maxLeftOffset,
                                      int maxRightOffset,
                                      String regionId)

floating

public SeleniumCheckSettings floating(org.openqa.selenium.WebElement element,
                                      int maxUpOffset,
                                      int maxDownOffset,
                                      int maxLeftOffset,
                                      int maxRightOffset)

floating

public SeleniumCheckSettings floating(org.openqa.selenium.WebElement element,
                                      int maxUpOffset,
                                      int maxDownOffset,
                                      int maxLeftOffset,
                                      int maxRightOffset,
                                      String regionId)

scrollRootElement

public SeleniumCheckSettings scrollRootElement(org.openqa.selenium.By selector)

scrollRootElement

public SeleniumCheckSettings scrollRootElement(org.openqa.selenium.WebElement element)

fully

public SeleniumCheckSettings fully()

Specified by:

fully in interface com.applitools.ICheckSettings

Overrides:

fully in class com.applitools.eyes.fluent.CheckSettings

fully

public SeleniumCheckSettings fully(Boolean fully)

Specified by:

fully in interface com.applitools.ICheckSettings

Overrides:

fully in class com.applitools.eyes.fluent.CheckSettings

withName

public SeleniumCheckSettings withName(String name)

Specified by:

withName in interface com.applitools.ICheckSettings

Overrides:

withName in class com.applitools.eyes.fluent.CheckSettings

ignoreCaret

public SeleniumCheckSettings ignoreCaret(Boolean ignoreCaret)

Specified by:

ignoreCaret in interface com.applitools.ICheckSettings

Overrides:

ignoreCaret in class com.applitools.eyes.fluent.CheckSettings

ignoreCaret

public SeleniumCheckSettings ignoreCaret()

Specified by:

ignoreCaret in interface com.applitools.ICheckSettings

Overrides:

ignoreCaret in class com.applitools.eyes.fluent.CheckSettings

matchLevel

public SeleniumCheckSettings matchLevel(com.applitools.eyes.MatchLevel matchLevel)

Specified by:

matchLevel in interface com.applitools.ICheckSettings

Overrides:

matchLevel in class com.applitools.eyes.fluent.CheckSettings

content

public SeleniumCheckSettings content()

Specified by:

content in interface com.applitools.ICheckSettings

Overrides:

content in class com.applitools.eyes.fluent.CheckSettings

strict

public SeleniumCheckSettings strict()

Specified by:

strict in interface com.applitools.ICheckSettings

Overrides:

strict in class com.applitools.eyes.fluent.CheckSettings

layout

public SeleniumCheckSettings layout()

Specified by:

layout in interface com.applitools.ICheckSettings

Overrides:

layout in class com.applitools.eyes.fluent.CheckSettings

exact

public SeleniumCheckSettings exact()

Specified by:

exact in interface com.applitools.ICheckSettings

Overrides:

exact in class com.applitools.eyes.fluent.CheckSettings

timeout

public SeleniumCheckSettings timeout(Integer timeoutMilliseconds)

Specified by:

timeout in interface com.applitools.ICheckSettings

Overrides:

timeout in class com.applitools.eyes.fluent.CheckSettings

ignore

public SeleniumCheckSettings ignore(com.applitools.eyes.Region region,
                                    com.applitools.eyes.Region... regions)

Specified by:

ignore in interface com.applitools.ICheckSettings

Overrides:

ignore in class com.applitools.eyes.fluent.CheckSettings

ignore

public SeleniumCheckSettings ignore(com.applitools.eyes.Region[] regions)

Specified by:

ignore in interface com.applitools.ICheckSettings

Overrides:

ignore in class com.applitools.eyes.fluent.CheckSettings

layout

public SeleniumCheckSettings layout(com.applitools.eyes.Region region,
                                    com.applitools.eyes.Region... regions)

Specified by:

layout in interface com.applitools.ICheckSettings

Overrides:

layout in class com.applitools.eyes.fluent.CheckSettings

layout

public SeleniumCheckSettings layout(com.applitools.eyes.Region[] regions)

Specified by:

layout in interface com.applitools.ICheckSettings

Overrides:

layout in class com.applitools.eyes.fluent.CheckSettings

strict

public SeleniumCheckSettings strict(com.applitools.eyes.Region region,
                                    com.applitools.eyes.Region... regions)

Specified by:

strict in interface com.applitools.ICheckSettings

Overrides:

strict in class com.applitools.eyes.fluent.CheckSettings

strict

public SeleniumCheckSettings strict(com.applitools.eyes.Region[] regions)

Specified by:

strict in interface com.applitools.ICheckSettings

Overrides:

strict in class com.applitools.eyes.fluent.CheckSettings

content

public SeleniumCheckSettings content(com.applitools.eyes.Region region,
                                     com.applitools.eyes.Region... regions)

Specified by:

content in interface com.applitools.ICheckSettings

Overrides:

content in class com.applitools.eyes.fluent.CheckSettings

content

public SeleniumCheckSettings content(com.applitools.eyes.Region[] regions)

Specified by:

content in interface com.applitools.ICheckSettings

Overrides:

content in class com.applitools.eyes.fluent.CheckSettings

getScrollRootElement

public org.openqa.selenium.WebElement getScrollRootElement()

Specified by:

getScrollRootElement in interface IScrollRootElementContainer

getScrollRootSelector

public org.openqa.selenium.By getScrollRootSelector()

Specified by:

getScrollRootSelector in interface IScrollRootElementContainer

getSizeMode

public String getSizeMode()

Specified by:

getSizeMode in interface com.applitools.ICheckSettingsInternal

Overrides:

getSizeMode in class com.applitools.eyes.fluent.CheckSettings

getScriptHooks

public Map<String,String> getScriptHooks()

Specified by:

getScriptHooks in interface com.applitools.ICheckSettingsInternal

Overrides:

getScriptHooks in class com.applitools.eyes.fluent.CheckSettings

scriptHook

@Deprecated
public SeleniumCheckSettings scriptHook(String hook)

Deprecated.

Specified by:

scriptHook in interface com.applitools.ICheckSettings

Specified by:

scriptHook in interface com.applitools.eyes.fluent.ICheckSettingsInternal

Overrides:

scriptHook in class com.applitools.eyes.fluent.CheckSettings

beforeRenderScreenshotHook

public SeleniumCheckSettings beforeRenderScreenshotHook(String hook)

Specified by:

beforeRenderScreenshotHook in interface com.applitools.ICheckSettings

Specified by:

beforeRenderScreenshotHook in interface com.applitools.eyes.fluent.ICheckSettingsInternal

Overrides:

beforeRenderScreenshotHook in class com.applitools.eyes.fluent.CheckSettings

ignoreDisplacements

public SeleniumCheckSettings ignoreDisplacements(boolean ignoreDisplacements)

ignoreDisplacements

public SeleniumCheckSettings ignoreDisplacements()

Specified by:

ignoreDisplacements in interface com.applitools.ICheckSettings

Overrides:

ignoreDisplacements in class com.applitools.eyes.fluent.CheckSettings

accessibility

public SeleniumCheckSettings accessibility(org.openqa.selenium.By regionSelector,
                                           com.applitools.eyes.AccessibilityRegionType regionType)

accessibility

public SeleniumCheckSettings accessibility(org.openqa.selenium.WebElement element,
                                           com.applitools.eyes.AccessibilityRegionType regionType)

accessibility

public SeleniumCheckSettings accessibility(com.applitools.eyes.AccessibilityRegionType regionType,
                                           org.openqa.selenium.WebElement[] elementsToIgnore)

isDefaultLayoutBreakpointsSet

public Boolean isDefaultLayoutBreakpointsSet()

Overrides:

isDefaultLayoutBreakpointsSet in class com.applitools.eyes.fluent.CheckSettings

layoutBreakpoints

public SeleniumCheckSettings layoutBreakpoints(Boolean shouldSet)

Specified by:

layoutBreakpoints in interface com.applitools.ICheckSettings

Overrides:

layoutBreakpoints in class com.applitools.eyes.fluent.CheckSettings

layoutBreakpoints

public SeleniumCheckSettings layoutBreakpoints(Integer... breakpoints)

Specified by:

layoutBreakpoints in interface com.applitools.ICheckSettings

Overrides:

layoutBreakpoints in class com.applitools.eyes.fluent.CheckSettings

layoutBreakpoints

public SeleniumCheckSettings layoutBreakpoints(int[] breakpoints)

Overrides:

layoutBreakpoints in class com.applitools.eyes.fluent.CheckSettings

layoutBreakpoints

public SeleniumCheckSettings layoutBreakpoints(com.applitools.eyes.options.LayoutBreakpointsOptions layoutBreakpointsOptions)

Specified by:

layoutBreakpoints in interface com.applitools.ICheckSettings

Overrides:

layoutBreakpoints in class com.applitools.eyes.fluent.CheckSettings

getLayoutBreakpoints

public List<Integer> getLayoutBreakpoints()

Overrides:

getLayoutBreakpoints in class com.applitools.eyes.fluent.CheckSettings

getLayoutBreakpointsOptions

public com.applitools.eyes.options.LayoutBreakpointsOptions getLayoutBreakpointsOptions()

Overrides:

getLayoutBreakpointsOptions in class com.applitools.eyes.fluent.CheckSettings

getStepPositionProvider

@Deprecated
public com.applitools.eyes.positioning.PositionProvider getStepPositionProvider()

Deprecated.

Specified by:

getStepPositionProvider in interface com.applitools.eyes.fluent.ICheckSettingsInternal

Overrides:

getStepPositionProvider in class com.applitools.eyes.fluent.CheckSettings

lazyLoad

public SeleniumCheckSettings lazyLoad()

Specified by:

lazyLoad in interface com.applitools.ICheckSettings

Overrides:

lazyLoad in class com.applitools.eyes.fluent.CheckSettings

lazyLoad

public SeleniumCheckSettings lazyLoad(com.applitools.eyes.LazyLoadOptions lazyLoadOptions)

Specified by:

lazyLoad in interface com.applitools.ICheckSettings

Overrides:

lazyLoad in class com.applitools.eyes.fluent.CheckSettings

getLazyLoadOptions

public com.applitools.eyes.LazyLoadOptions getLazyLoadOptions()

Overrides:

getLazyLoadOptions in class com.applitools.eyes.fluent.CheckSettings

densityMetrics

public SeleniumCheckSettings densityMetrics(int xDpi,
                                            int yDpi)

Specified by:

densityMetrics in interface com.applitools.ICheckSettings

Overrides:

densityMetrics in class com.applitools.eyes.fluent.CheckSettings

densityMetrics

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

Specified by:

densityMetrics in interface com.applitools.ICheckSettings

Overrides:

densityMetrics in class com.applitools.eyes.fluent.CheckSettings

stitchOverlap

public SeleniumCheckSettings stitchOverlap(Integer overlap)

Overrides:

stitchOverlap in class com.applitools.eyes.fluent.CheckSettings

stitchOverlap

public SeleniumCheckSettings stitchOverlap(com.applitools.eyes.StitchOverlap stitchOverlap)

Overrides:

stitchOverlap in class com.applitools.eyes.fluent.CheckSettings

hideCaret

public SeleniumCheckSettings hideCaret(Boolean hideCaret)

Overrides:

hideCaret in class com.applitools.eyes.fluent.CheckSettings

hideScrollBars

public SeleniumCheckSettings hideScrollBars(Boolean hideScrollBars)

Overrides:

hideScrollBars in class com.applitools.eyes.fluent.CheckSettings

stitchMode

public SeleniumCheckSettings stitchMode(com.applitools.eyes.selenium.StitchMode stitchMode)

Overrides:

stitchMode in class com.applitools.eyes.fluent.CheckSettings

getTargetPathLocator

public TargetPathLocator getTargetPathLocator()

Specified by:

getTargetPathLocator in interface ISeleniumCheckTarget

setHideCaret

@Deprecated
public SeleniumCheckSettings setHideCaret(Boolean hideCaret)

Deprecated.

see hideCaret(Boolean)

Overrides:

setHideCaret in class com.applitools.eyes.fluent.CheckSettings

setHideScrollBars

@Deprecated
public SeleniumCheckSettings setHideScrollBars(Boolean hideScrollBars)

Deprecated.

see hideScrollBars(Boolean)

Overrides:

setHideScrollBars in class com.applitools.eyes.fluent.CheckSettings