Package org.openqa.selenium.devtools.v126.overlay.model

Class HighlightConfig

java.lang.Object

org.openqa.selenium.devtools.v126.overlay.model.HighlightConfig

public class HighlightConfig
extends Object

Configuration data for the highlighting of page elements.

Constructor Summary

Constructors

Constructor

Description

HighlightConfig(Optional<Boolean> showInfo, Optional<Boolean> showStyles, Optional<Boolean> showRulers, Optional<Boolean> showAccessibilityInfo, Optional<Boolean> showExtensionLines, Optional<RGBA> contentColor, Optional<RGBA> paddingColor, Optional<RGBA> borderColor, Optional<RGBA> marginColor, Optional<RGBA> eventTargetColor, Optional<RGBA> shapeColor, Optional<RGBA> shapeMarginColor, Optional<RGBA> cssGridColor, Optional<ColorFormat> colorFormat, Optional<GridHighlightConfig> gridHighlightConfig, Optional<FlexContainerHighlightConfig> flexContainerHighlightConfig, Optional<FlexItemHighlightConfig> flexItemHighlightConfig, Optional<ContrastAlgorithm> contrastAlgorithm, Optional<ContainerQueryContainerHighlightConfig> containerQueryContainerHighlightConfig)

Method Summary

Modifier and Type	Method	Description
Optional<RGBA>	getBorderColor()	The border highlight fill color (default: transparent).
Optional<ColorFormat>	getColorFormat()	The color format used to format color styles (default: hex).
Optional<ContainerQueryContainerHighlightConfig>	getContainerQueryContainerHighlightConfig()	The container query container highlight configuration (default: all transparent).
Optional<RGBA>	getContentColor()	The content box highlight fill color (default: transparent).
Optional<ContrastAlgorithm>	getContrastAlgorithm()	The contrast algorithm to use for the contrast ratio (default: aa).
Optional<RGBA>	getCssGridColor()	The grid layout color (default: transparent).
Optional<RGBA>	getEventTargetColor()	The event target element highlight fill color (default: transparent).
Optional<FlexContainerHighlightConfig>	getFlexContainerHighlightConfig()	The flex container highlight configuration (default: all transparent).
Optional<FlexItemHighlightConfig>	getFlexItemHighlightConfig()	The flex item highlight configuration (default: all transparent).
Optional<GridHighlightConfig>	getGridHighlightConfig()	The grid layout highlight configuration (default: all transparent).
Optional<RGBA>	getMarginColor()	The margin highlight fill color (default: transparent).
Optional<RGBA>	getPaddingColor()	The padding highlight fill color (default: transparent).
Optional<RGBA>	getShapeColor()	The shape outside fill color (default: transparent).
Optional<RGBA>	getShapeMarginColor()	The shape margin fill color (default: transparent).
Optional<Boolean>	getShowAccessibilityInfo()	Whether the a11y info should be shown (default: true).
Optional<Boolean>	getShowExtensionLines()	Whether the extension lines from node to the rulers should be shown (default: false).
Optional<Boolean>	getShowInfo()	Whether the node info tooltip should be shown (default: false).
Optional<Boolean>	getShowRulers()	Whether the rulers should be shown (default: false).
Optional<Boolean>	getShowStyles()	Whether the node styles in the tooltip (default: false).

Methods inherited from class java.lang.Object

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

Constructor Details

HighlightConfig

public HighlightConfig(Optional<Boolean> showInfo,
 Optional<Boolean> showStyles,
 Optional<Boolean> showRulers,
 Optional<Boolean> showAccessibilityInfo,
 Optional<Boolean> showExtensionLines,
 Optional<RGBA> contentColor,
 Optional<RGBA> paddingColor,
 Optional<RGBA> borderColor,
 Optional<RGBA> marginColor,
 Optional<RGBA> eventTargetColor,
 Optional<RGBA> shapeColor,
 Optional<RGBA> shapeMarginColor,
 Optional<RGBA> cssGridColor,
 Optional<ColorFormat> colorFormat,
 Optional<GridHighlightConfig> gridHighlightConfig,
 Optional<FlexContainerHighlightConfig> flexContainerHighlightConfig,
 Optional<FlexItemHighlightConfig> flexItemHighlightConfig,
 Optional<ContrastAlgorithm> contrastAlgorithm,
 Optional<ContainerQueryContainerHighlightConfig> containerQueryContainerHighlightConfig)

Method Details

getShowInfo

public Optional<Boolean> getShowInfo()

Whether the node info tooltip should be shown (default: false).

getShowStyles

public Optional<Boolean> getShowStyles()

Whether the node styles in the tooltip (default: false).

getShowRulers

public Optional<Boolean> getShowRulers()

Whether the rulers should be shown (default: false).

getShowAccessibilityInfo

public Optional<Boolean> getShowAccessibilityInfo()

Whether the a11y info should be shown (default: true).

getShowExtensionLines

public Optional<Boolean> getShowExtensionLines()

Whether the extension lines from node to the rulers should be shown (default: false).

getContentColor

public Optional<RGBA> getContentColor()

The content box highlight fill color (default: transparent).

getPaddingColor

public Optional<RGBA> getPaddingColor()

The padding highlight fill color (default: transparent).

getBorderColor

public Optional<RGBA> getBorderColor()

The border highlight fill color (default: transparent).

getMarginColor

public Optional<RGBA> getMarginColor()

The margin highlight fill color (default: transparent).

getEventTargetColor

public Optional<RGBA> getEventTargetColor()

The event target element highlight fill color (default: transparent).

getShapeColor

public Optional<RGBA> getShapeColor()

The shape outside fill color (default: transparent).

getShapeMarginColor

public Optional<RGBA> getShapeMarginColor()

The shape margin fill color (default: transparent).

getCssGridColor

public Optional<RGBA> getCssGridColor()

The grid layout color (default: transparent).

getColorFormat

public Optional<ColorFormat> getColorFormat()

The color format used to format color styles (default: hex).

getGridHighlightConfig

public Optional<GridHighlightConfig> getGridHighlightConfig()

The grid layout highlight configuration (default: all transparent).

getFlexContainerHighlightConfig

public Optional<FlexContainerHighlightConfig> getFlexContainerHighlightConfig()

The flex container highlight configuration (default: all transparent).

getFlexItemHighlightConfig

public Optional<FlexItemHighlightConfig> getFlexItemHighlightConfig()

The flex item highlight configuration (default: all transparent).

getContrastAlgorithm

public Optional<ContrastAlgorithm> getContrastAlgorithm()

The contrast algorithm to use for the contrast ratio (default: aa).

getContainerQueryContainerHighlightConfig

public Optional<ContainerQueryContainerHighlightConfig> getContainerQueryContainerHighlightConfig()

The container query container highlight configuration (default: all transparent).