public class CheckSettings extends Object implements ICheckSettings, ICheckSettingsInternal
| Modifier and Type | Field and Description |
|---|---|
protected List<GetRegion> |
accessibilityRegions |
protected static String |
BEFORE_CAPTURE_SCREENSHOT |
protected List<GetRegion> |
contentRegions |
protected Boolean |
enablePatterns |
protected List<GetRegion> |
floatingRegions |
protected Boolean |
ignoreDisplacements |
protected List<GetRegion> |
ignoreRegions |
protected List<GetRegion> |
layoutRegions |
protected String |
name |
protected String |
pageId |
protected Map<String,String> |
scriptHooks |
protected Boolean |
sendDom |
protected List<GetRegion> |
strictRegions |
protected Boolean |
useDom |
| Modifier | Constructor and Description |
|---|---|
protected |
CheckSettings() |
|
CheckSettings(Integer retryTimeout)
For internal use only.
|
protected |
CheckSettings(Region region) |
protected static final String BEFORE_CAPTURE_SCREENSHOT
protected Boolean ignoreDisplacements
protected String name
protected String pageId
protected Boolean sendDom
protected Boolean useDom
protected Boolean enablePatterns
protected CheckSettings()
protected CheckSettings(Region region)
public CheckSettings(Integer retryTimeout)
retryTimeout - timeoutprotected void ignore_(Region region)
protected void ignore_(GetSimpleRegion regionProvider)
protected void layout_(Region region)
protected void layout_(GetSimpleRegion regionProvider)
protected void content_(Region region)
protected void content_(GetSimpleRegion regionProvider)
protected void strict_(Region region)
protected void strict_(GetSimpleRegion regionProvider)
protected void floating_(Region region, int maxUpOffset, int maxDownOffset, int maxLeftOffset, int maxRightOffset)
protected void floating(GetFloatingRegion regionProvider)
public CheckSettings clone()
clone in interface ICheckSettingsInternalclone in class Objectpublic Boolean isStitchContent()
isStitchContent in interface ICheckSettingsInternalpublic ICheckSettings ignore(Region region, Region... regions)
ignore in interface ICheckSettingsregion - A region to ignore when validating the screenshot.regions - Optional extra regions to ignore when validating the screenshot.public ICheckSettings ignore(Region[] regions)
ignore in interface ICheckSettingsregions - An array of regions to ignore when validating the screenshot.public ICheckSettings layout(Region region, Region... regions)
layout in interface ICheckSettingsregion - A region to match using the Layout method.regions - Optional extra regions to match using the Layout method.public ICheckSettings layout(Region[] regions)
layout in interface ICheckSettingsregions - An array of regions to match using the Layout method.public ICheckSettings strict(Region region, Region... regions)
strict in interface ICheckSettingsregion - A region to match using the Strict method.regions - Optional extra regions to match using the Strict method.public ICheckSettings strict(Region[] regions)
strict in interface ICheckSettingsregions - An array of regions to match using the Strict method.public ICheckSettings content(Region region, Region... regions)
content in interface ICheckSettingsregion - A region to match using the Content method.regions - Optional extra regions to match using the Content method.public ICheckSettings content(Region[] regions)
content in interface ICheckSettingsregions - An array of regions to match using the Content method.public ICheckSettings fully()
fully in interface ICheckSettingspublic ICheckSettings fully(Boolean fully)
fully in interface ICheckSettingsfully - defines whether the screenshot will contain the entire element or region.public ICheckSettings floating(int maxOffset, Region... regions)
floating in interface ICheckSettingsmaxOffset - How much each of the content rectangles can move in any direction.regions - One or more content rectangles.public ICheckSettings floating(Region region, int maxUpOffset, int maxDownOffset, int maxLeftOffset, int maxRightOffset)
floating in interface ICheckSettingsregion - 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.public ICheckSettings timeout(Integer timeoutMilliseconds)
timeout in interface ICheckSettingstimeoutMilliseconds - The timeout to use in milliseconds.public ICheckSettings layout()
MatchLevel.LAYOUT.layout in interface ICheckSettingspublic ICheckSettings exact()
MatchLevel.EXACT.exact in interface ICheckSettingspublic ICheckSettings strict()
MatchLevel.STRICT.strict in interface ICheckSettingspublic ICheckSettings content()
MatchLevel.CONTENT.content in interface ICheckSettingspublic ICheckSettings ignoreColors()
public ICheckSettings matchLevel(MatchLevel matchLevel)
matchLevel in interface ICheckSettingsmatchLevel - The match level to use.public ICheckSettings ignoreCaret(Boolean ignoreCaret)
ignoreCaret in interface ICheckSettingsignoreCaret - Whether or not to detect and ignore a blinking caret in the screenshot.public ICheckSettings ignoreCaret()
ignoreCaret in interface ICheckSettingspublic ICheckSettings withName(String name)
withName in interface ICheckSettingsname - A name by which to identify the checkpoint.public Boolean isSendDom()
isSendDom in interface ICheckSettingsInternalpublic Boolean isIgnoreDisplacements()
isIgnoreDisplacements in interface ICheckSettingsInternalpublic Boolean isUseDom()
isUseDom in interface ICheckSettingsInternalpublic ICheckSettings useDom(Boolean useDom)
useDom in interface ICheckSettingspublic ICheckSettings sendDom(Boolean sendDom)
sendDom in interface ICheckSettingspublic ICheckSettings sendDom()
sendDom in interface ICheckSettingspublic Region getTargetRegion()
getTargetRegion in interface ICheckSettingsInternalpublic Integer getTimeout()
getTimeout in interface ICheckSettingsInternalpublic Boolean getStitchContent()
public MatchLevel getMatchLevel()
getMatchLevel in interface ICheckSettingsInternalpublic GetRegion[] getIgnoreRegions()
public GetRegion[] getStrictRegions()
public GetRegion[] getLayoutRegions()
public GetRegion[] getContentRegions()
public GetRegion[] getFloatingRegions()
public Boolean getIgnoreCaret()
public String getName()
getName in interface ICheckSettingsInternalpublic Map<String,String> getScriptHooks()
getScriptHooks in interface ICheckSettingsInternalpublic String getSizeMode()
getSizeMode in interface ICheckSettingsInternalprotected void updateTargetRegion(Region region)
protected void populateClone(CheckSettings clone)
public void setStitchContent(boolean stitchContent)
public Boolean isEnablePatterns()
public VisualGridSelector getVGTargetSelector()
getVGTargetSelector in interface ICheckSettingsInternalpublic ICheckSettings enablePatterns(Boolean enablePatterns)
enablePatterns in interface ICheckSettingspublic ICheckSettings enablePatterns()
enablePatterns in interface ICheckSettings@Deprecated public ICheckSettings scriptHook(String hook)
scriptHook in interface ICheckSettingspublic ICheckSettings beforeRenderScreenshotHook(String hook)
beforeRenderScreenshotHook in interface ICheckSettingspublic ICheckSettings ignoreDisplacements(Boolean ignoreDisplacements)
ignoreDisplacements in interface ICheckSettingspublic ICheckSettings ignoreDisplacements()
ignoreDisplacements in interface ICheckSettingsprotected void accessibility_(GetAccessibilityRegion accessibilityRegionProvider)
protected void accessibility_(Region rect, AccessibilityRegionType regionType)
public ICheckSettings accessibility(Region region, AccessibilityRegionType regionType)
accessibility in interface ICheckSettingsprotected void accessibility(GetAccessibilityRegion accessibilityRegionProvider)
public GetRegion[] getAccessibilityRegions()
public ICheckSettings ocrRegion(BaseOcrRegion ocrRegion)
public BaseOcrRegion getOcrRegion()
public ICheckSettings variationGroupId(String variationGroupId)
public String getVariationGroupId()
public PositionProvider getStepPositionProvider()
public ICheckSettings visualGridOptions(VisualGridOption... options)
visualGridOptions in interface ICheckSettingspublic Boolean isCheckWindow()
isCheckWindow in interface ICheckSettingspublic ICheckSettings waitBeforeCapture(Integer milliSec)
ICheckSettingswaitBeforeCapture in interface ICheckSettingsmilliSec - wait time.public List<VisualGridOption> getVisualGridOptions()
getVisualGridOptions in interface ICheckSettingsInternalpublic Boolean isDisableBrowserFetching()
isDisableBrowserFetching in interface ICheckSettingsInternalpublic ICheckSettings setDisableBrowserFetching(Boolean disableBrowserFetching)
setDisableBrowserFetching in interface ICheckSettingsInternalpublic Integer getWaitBeforeCapture()
public ICheckSettings lazyLoad()
ICheckSettingslazyLoad in interface ICheckSettingspublic ICheckSettings lazyLoad(LazyLoadOptions lazyLoadOptions)
ICheckSettingslazyLoad in interface ICheckSettingslazyLoadOptions - lazy load optionspublic LazyLoadOptions getLazyLoadOptions()
public AutProxySettings getAutProxy()
public ICheckSettings autProxy(AutProxySettings autProxy)
public AccessibilitySettings getAccessibilityValidation()
public ICheckSettings setAccessibilityValidation(AccessibilitySettings accessibilitySettings)
public StitchMode getStitchMode()
public ICheckSettings stitchMode(StitchMode stitchMode)
public Boolean getHideScrollBars()
public ICheckSettings setHideScrollBars(Boolean hideScrollBars)
public Boolean getHideCaret()
public ICheckSettings setHideCaret(Boolean hideCaret)
public Integer getOverlap()
public ICheckSettings setOverlap(Integer overlap)
public ICheckSettings setLayoutBreakpoints(Boolean shouldSet)
public Boolean isDefaultLayoutBreakpointsSet()
public ICheckSettings setLayoutBreakpoints(int... breakpoints)
public ICheckSettings pageId(String pageId)
public String getPageId()
Copyright © 2023. All rights reserved.