com.applitools.eyes.selenium.fluent

Class SeleniumCheckSettings

java.lang.Object

com.applitools.eyes.fluent.CheckSettings

com.applitools.eyes.selenium.fluent.SeleniumCheckSettings

All Implemented Interfaces:

ImplicitInitiation, 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 and 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, scriptHooks, sendDom, strictRegions, useDom

Constructor Summary

Constructors

Constructor and Description
SeleniumCheckSettings()
SeleniumCheckSettings(org.openqa.selenium.By targetSelector)
SeleniumCheckSettings(com.applitools.eyes.Region region)
SeleniumCheckSettings(com.applitools.eyes.Region region, boolean isSendDom)
SeleniumCheckSettings(String tag)
SeleniumCheckSettings(org.openqa.selenium.WebElement targetElement)

Method Summary

Modifier and Type	Method and 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(org.openqa.selenium.By[] regionSelectors)
SeleniumCheckSettings	content(org.openqa.selenium.By regionSelector, org.openqa.selenium.By... regionSelectors)
SeleniumCheckSettings	content(org.openqa.selenium.By selector, int leftPadding, int topPadding, int rightPadding, int bottomPadding)
SeleniumCheckSettings	content(com.applitools.eyes.Region[] regions)
SeleniumCheckSettings	content(com.applitools.eyes.Region region, com.applitools.eyes.Region... regions)
SeleniumCheckSettings	content(org.openqa.selenium.WebElement[] elements)
SeleniumCheckSettings	content(org.openqa.selenium.WebElement element, int leftPadding, int topPadding, int rightPadding, int bottomPadding)
SeleniumCheckSettings	content(org.openqa.selenium.WebElement element, org.openqa.selenium.WebElement... elements)
SeleniumCheckSettings	exact()
SeleniumCheckSettings	floating(org.openqa.selenium.By regionSelector, int maxUpOffset, int maxDownOffset, int maxLeftOffset, int maxRightOffset)
SeleniumCheckSettings	floating(org.openqa.selenium.WebElement element, int maxUpOffset, int maxDownOffset, int maxLeftOffset, int maxRightOffset)
SeleniumCheckSettings	frame(org.openqa.selenium.By by)
SeleniumCheckSettings	frame(int index)
SeleniumCheckSettings	frame(String frameNameOrId)
SeleniumCheckSettings	frame(org.openqa.selenium.WebElement frameReference)
SeleniumCheckSettings	fully()
SeleniumCheckSettings	fully(Boolean fully)
List<FrameLocator>	getFrameChain()
List<Integer>	getLayoutBreakpoints()
Map<String,String>	getScriptHooks()
org.openqa.selenium.WebElement	getScrollRootElement()
org.openqa.selenium.By	getScrollRootSelector()
String	getSizeMode()
CheckState	getState()
com.applitools.eyes.positioning.PositionProvider	getStepPositionProvider()
org.openqa.selenium.WebElement	getTargetElement()
org.openqa.selenium.By	getTargetSelector()
com.applitools.eyes.visualgrid.model.VisualGridSelector	getVGTargetSelector()
SeleniumCheckSettings	ignore(org.openqa.selenium.By[] regionSelectors)
SeleniumCheckSettings	ignore(org.openqa.selenium.By regionSelector, org.openqa.selenium.By... regionSelectors)
SeleniumCheckSettings	ignore(org.openqa.selenium.By selector, int leftPadding, int topPadding, int rightPadding, int bottomPadding)
SeleniumCheckSettings	ignore(com.applitools.eyes.Region[] regions)
SeleniumCheckSettings	ignore(com.applitools.eyes.Region region, com.applitools.eyes.Region... regions)
SeleniumCheckSettings	ignore(org.openqa.selenium.WebElement[] elements)
SeleniumCheckSettings	ignore(org.openqa.selenium.WebElement element, int leftPadding, int topPadding, int rightPadding, int bottomPadding)
SeleniumCheckSettings	ignore(org.openqa.selenium.WebElement element, org.openqa.selenium.WebElement... elements)
SeleniumCheckSettings	ignoreCaret()
SeleniumCheckSettings	ignoreCaret(boolean ignoreCaret)
SeleniumCheckSettings	ignoreDisplacements()
SeleniumCheckSettings	ignoreDisplacements(boolean ignoreDisplacements)
void	init(com.applitools.eyes.Logger logger, EyesWebDriver driver)
boolean	isDefaultLayoutBreakpointsSet()
SeleniumCheckSettings	layout()
SeleniumCheckSettings	layout(org.openqa.selenium.By[] regionSelectors)
SeleniumCheckSettings	layout(org.openqa.selenium.By regionSelector, org.openqa.selenium.By... regionSelectors)
SeleniumCheckSettings	layout(org.openqa.selenium.By selector, int leftPadding, int topPadding, int rightPadding, int bottomPadding)
SeleniumCheckSettings	layout(com.applitools.eyes.Region[] regions)
SeleniumCheckSettings	layout(com.applitools.eyes.Region region, com.applitools.eyes.Region... regions)
SeleniumCheckSettings	layout(org.openqa.selenium.WebElement[] elements)
SeleniumCheckSettings	layout(org.openqa.selenium.WebElement element, int leftPadding, int topPadding, int rightPadding, int bottomPadding)
SeleniumCheckSettings	layout(org.openqa.selenium.WebElement element, org.openqa.selenium.WebElement... elements)
SeleniumCheckSettings	layoutBreakpoints(boolean shouldSet)
SeleniumCheckSettings	layoutBreakpoints(Integer... breakpoints)
SeleniumCheckSettings	matchLevel(com.applitools.eyes.MatchLevel matchLevel)
SeleniumCheckSettings	region(org.openqa.selenium.By by)
SeleniumCheckSettings	region(com.applitools.eyes.Region region)
SeleniumCheckSettings	region(org.openqa.selenium.WebElement element)
void	sanitizeSettings(EyesSeleniumDriver driver, boolean isFully)
SeleniumCheckSettings	scriptHook(String hook) Deprecated.
SeleniumCheckSettings	scrollRootElement(org.openqa.selenium.By selector)
SeleniumCheckSettings	scrollRootElement(org.openqa.selenium.WebElement element)
void	setState(CheckState state)
void	setTargetSelector(com.applitools.eyes.visualgrid.model.VisualGridSelector selector)
SeleniumCheckSettings	strict()
SeleniumCheckSettings	strict(org.openqa.selenium.By[] regionSelectors)
SeleniumCheckSettings	strict(org.openqa.selenium.By regionSelector, org.openqa.selenium.By... regionSelectors)
SeleniumCheckSettings	strict(org.openqa.selenium.By selector, int leftPadding, int topPadding, int rightPadding, int bottomPadding)
SeleniumCheckSettings	strict(com.applitools.eyes.Region[] regions)
SeleniumCheckSettings	strict(com.applitools.eyes.Region region, com.applitools.eyes.Region... regions)
SeleniumCheckSettings	strict(org.openqa.selenium.WebElement[] elements)
SeleniumCheckSettings	strict(org.openqa.selenium.WebElement element, int leftPadding, int topPadding, int rightPadding, int bottomPadding)
SeleniumCheckSettings	strict(org.openqa.selenium.WebElement element, org.openqa.selenium.WebElement... elements)
SeleniumCheckSettings	timeout(int timeoutMilliseconds)
SeleniumCheckSettings	withName(String name)

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

accessibility_, accessibility_, accessibility, accessibility, content_, content_, enablePatterns, enablePatterns, floating_, floating, floating, floating, getAccessibilityRegions, getContentRegions, getFloatingRegions, getIgnoreCaret, getIgnoreRegions, getLayoutRegions, getMatchLevel, getName, getOcrRegion, getStitchContent, getStrictRegions, getTargetRegion, getTimeout, getVariationGroupId, getVisualGridOptions, ignore_, ignore_, isCheckWindow, isEnablePatterns, isIgnoreDisplacements, isSendDom, isStitchContent, isUseDom, layout_, layout_, ocrRegion, populateClone, sendDom, sendDom, setStitchContent, strict_, strict_, updateTargetRegion, useDom, variationGroupId, visualGridOptions

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(org.openqa.selenium.By targetSelector)

SeleniumCheckSettings

public SeleniumCheckSettings(org.openqa.selenium.WebElement targetElement)

SeleniumCheckSettings

public SeleniumCheckSettings(String tag)

SeleniumCheckSettings

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

Method Detail

init

public void init(com.applitools.eyes.Logger logger,
                 EyesWebDriver driver)

Specified by:

init in interface ImplicitInitiation

getTargetSelector

public org.openqa.selenium.By getTargetSelector()

Specified by:

getTargetSelector in interface ISeleniumCheckTarget

getTargetElement

public org.openqa.selenium.WebElement getTargetElement()

Specified by:

getTargetElement in interface ISeleniumCheckTarget

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)

region

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

region

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

ignore

public SeleniumCheckSettings ignore(org.openqa.selenium.By regionSelector,
                                    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.By[] regionSelectors)

ignore

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

ignore

public SeleniumCheckSettings ignore(org.openqa.selenium.By selector,
                                    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)

layout

public SeleniumCheckSettings layout(org.openqa.selenium.By regionSelector,
                                    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.By[] regionSelectors)

layout

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

layout

public SeleniumCheckSettings layout(org.openqa.selenium.By selector,
                                    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)

strict

public SeleniumCheckSettings strict(org.openqa.selenium.By regionSelector,
                                    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.By[] regionSelectors)

strict

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

strict

public SeleniumCheckSettings strict(org.openqa.selenium.By selector,
                                    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)

content

public SeleniumCheckSettings content(org.openqa.selenium.By regionSelector,
                                     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.By[] regionSelectors)

content

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

content

public SeleniumCheckSettings content(org.openqa.selenium.By selector,
                                     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)

floating

public SeleniumCheckSettings floating(org.openqa.selenium.By regionSelector,
                                      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)

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(int 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

Overrides:

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

beforeRenderScreenshotHook

public SeleniumCheckSettings beforeRenderScreenshotHook(String hook)

Specified by:

beforeRenderScreenshotHook in interface com.applitools.ICheckSettings

Overrides:

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

getVGTargetSelector

public com.applitools.eyes.visualgrid.model.VisualGridSelector getVGTargetSelector()

Specified by:

getVGTargetSelector in interface com.applitools.ICheckSettingsInternal

Overrides:

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

setTargetSelector

public void setTargetSelector(com.applitools.eyes.visualgrid.model.VisualGridSelector selector)

ignoreDisplacements

public SeleniumCheckSettings ignoreDisplacements(boolean ignoreDisplacements)

Specified by:

ignoreDisplacements in interface com.applitools.ICheckSettings

Overrides:

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

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)

setState

public void setState(CheckState state)

Specified by:

setState in interface ISeleniumCheckTarget

getState

public CheckState getState()

Specified by:

getState in interface ISeleniumCheckTarget

layoutBreakpoints

public SeleniumCheckSettings layoutBreakpoints(boolean shouldSet)

isDefaultLayoutBreakpointsSet

public boolean isDefaultLayoutBreakpointsSet()

layoutBreakpoints

public SeleniumCheckSettings layoutBreakpoints(Integer... breakpoints)

getLayoutBreakpoints

public List<Integer> getLayoutBreakpoints()

sanitizeSettings

public void sanitizeSettings(EyesSeleniumDriver driver,
                             boolean isFully)

getStepPositionProvider

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

Overrides:

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