java.lang.Object
- Torello.Browser.BaseType<Overlay.HighlightConfig>
- - Torello.Browser.BrowserAPI.Overlay.HighlightConfig

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BaseType<?>>

Enclosing class:

Overlay
```
public static class Overlay.HighlightConfig
extends BaseType<Overlay.HighlightConfig>
implements java.io.Serializable
```
This Nested Java Class is declared as a "Type", which is similar to a Java Class. The CDP API Specifications list this type among the types, events & commands located in the Overlay domain, which may be found within the BrowserAPI.

📌 All browser domain type classes will have a class name that begins with an upper case letter.

Configuration data for the highlighting of page elements.

See Also:

Serialized Form
Hi-Lited Source-Code:
This File's Source Code:
- View Here: Torello/Browser/BrowserAPI/Overlay.java
- Open New Browser-Tab: Torello/Browser/BrowserAPI/Overlay.java
File Size: 7,759 Bytes Line Count: 183 '\n' Characters Found
Helper: Equals, HashCode, toJSON, etc
- View Here: Overlay$$HighlightConfig$$.java
- Open New Browser-Tab: Overlay$$HighlightConfig$$.java
File Size: 21,539 Bytes Line Count: 483 '\n' Characters Found

Field Summary

Serializable ID

Modifier and Type	Field	Description
`protected static long`	`serialVersionUID`

Type Fields / Properties (from Google & Browser Specs)
Modifier and Type	Field	Description
`DOM.RGBA`	`borderColor`	The border highlight fill color (default: transparent).
`String`	`colorFormat`	The color format used to format color styles (default: hex).
`Overlay.ContainerQueryContainerHighlightConfig`	`containerQueryContainerHighlightConfig`	The container query container highlight configuration (default: all transparent).
`DOM.RGBA`	`contentColor`	The content box highlight fill color (default: transparent).
`String`	`contrastAlgorithm`	The contrast algorithm to use for the contrast ratio (default: aa).
`DOM.RGBA`	`cssGridColor`	The grid layout color (default: transparent).
`DOM.RGBA`	`eventTargetColor`	The event target element highlight fill color (default: transparent).
`Overlay.FlexContainerHighlightConfig`	`flexContainerHighlightConfig`	The flex container highlight configuration (default: all transparent).
`Overlay.FlexItemHighlightConfig`	`flexItemHighlightConfig`	The flex item highlight configuration (default: all transparent).
`Overlay.GridHighlightConfig`	`gridHighlightConfig`	The grid layout highlight configuration (default: all transparent).
`DOM.RGBA`	`marginColor`	The margin highlight fill color (default: transparent).
`DOM.RGBA`	`paddingColor`	The padding highlight fill color (default: transparent).
`DOM.RGBA`	`shapeColor`	The shape outside fill color (default: transparent).
`DOM.RGBA`	`shapeMarginColor`	The shape margin fill color (default: transparent).
`Boolean`	`showAccessibilityInfo`	Whether the a11y info should be shown (default: true).
`Boolean`	`showExtensionLines`	Whether the extension lines from node to the rulers should be shown (default: false).
`Boolean`	`showInfo`	Whether the node info tooltip should be shown (default: false).
`Boolean`	`showRulers`	Whether the rulers should be shown (default: false).
`Boolean`	`showStyles`	Whether the node styles in the tooltip (default: false).

Fields inherited from class Torello.Browser.BaseType
domain, helperSingleton, isPresent, name, numFields

Constructor Summary

Constructors
Constructor	Description
HighlightConfig(ReadOnlyList<Boolean> isPresent, Boolean showInfo, Boolean showStyles, Boolean showRulers, Boolean showAccessibilityInfo, Boolean showExtensionLines, DOM.RGBA contentColor, DOM.RGBA paddingColor, DOM.RGBA borderColor, DOM.RGBA marginColor, DOM.RGBA eventTargetColor, DOM.RGBA shapeColor, DOM.RGBA shapeMarginColor, DOM.RGBA cssGridColor, String colorFormat, Overlay.GridHighlightConfig gridHighlightConfig, Overlay.FlexContainerHighlightConfig flexContainerHighlightConfig, Overlay.FlexItemHighlightConfig flexItemHighlightConfig, String contrastAlgorithm, Overlay.ContainerQueryContainerHighlightConfig containerQueryContainerHighlightConfig)	Constructor.

Method Summary

Static Builder Convert a JsonObject to a POJO

Modifier and Type	Method	Description
`static Overlay.HighlightConfig`	`fromJSON(JsonObject jo)`	Creates an instance of this class from a `JsonObject`.

Retrieve the Type-Descriptor Singleton-Instance for this Nested Class.
Modifier and Type	Method	Description
`static NestedDescriptor<Overlay.HighlightConfig>`	`descriptor()`	Returns this class's `NestedDescriptor` singleton-instance.

Methods inherited from class Torello.Browser.BaseType
allEnumStrROLs, compareTo, enumStrList, enumStrValidate, enumStrValidateThrow, equals, hashCode, isPresent, optionalsValidate, optionalsValidateThrow, toJSON, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - serialVersionUID
    
    🡇 ⇈ ⮫ 🗕 🗗 🗖
    protected static final long serialVersionUID
    
    This fulfils the SerialVersion UID requirement for all classes that implement Java's interface java.io.Serializable. Using the Serializable Implementation offered by java is very easy, and can make saving program state when debugging a lot easier. It can also be used in place of more complicated systems like "hibernate" to store data as well.
    
    See Also:
    
    Constant Field Values
  - showInfo
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final java.lang.Boolean showInfo
    
    Whether the node info tooltip should be shown (default: false).
    OPTIONAL
  - showStyles
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final java.lang.Boolean showStyles
    
    Whether the node styles in the tooltip (default: false).
    OPTIONAL
  - showRulers
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final java.lang.Boolean showRulers
    
    Whether the rulers should be shown (default: false).
    OPTIONAL
  - showAccessibilityInfo
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final java.lang.Boolean showAccessibilityInfo
    
    Whether the a11y info should be shown (default: true).
    OPTIONAL
  - showExtensionLines
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final java.lang.Boolean showExtensionLines
    
    Whether the extension lines from node to the rulers should be shown (default: false).
    OPTIONAL
  - contentColor
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final DOM.RGBA contentColor
    
    The content box highlight fill color (default: transparent).
    OPTIONAL
  - paddingColor
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final DOM.RGBA paddingColor
    
    The padding highlight fill color (default: transparent).
    OPTIONAL
  - borderColor
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final DOM.RGBA borderColor
    
    The border highlight fill color (default: transparent).
    OPTIONAL
  - marginColor
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final DOM.RGBA marginColor
    
    The margin highlight fill color (default: transparent).
    OPTIONAL
  - eventTargetColor
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final DOM.RGBA eventTargetColor
    
    The event target element highlight fill color (default: transparent).
    OPTIONAL
  - shapeColor
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final DOM.RGBA shapeColor
    
    The shape outside fill color (default: transparent).
    OPTIONAL
  - shapeMarginColor
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final DOM.RGBA shapeMarginColor
    
    The shape margin fill color (default: transparent).
    OPTIONAL
  - cssGridColor
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final DOM.RGBA cssGridColor
    
    The grid layout color (default: transparent).
    OPTIONAL
  - colorFormat
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final java.lang.String colorFormat
    
    The color format used to format color styles (default: hex).
    OPTIONAL
    
    This particular field will have its values resricted to the contents of a CDP defined Enumerated String List. That list may be viewed here:
    
    📎 Overlay.ColorFormat
    
    Programmatically Accessing the Enum:
    
    // Retrieve the list of enumerated strings for this field ReadOnlyList<String> enumerationStrs = Overlay.ColorFormat.enumStrList("colorFormat"); // Print the list of strings to the terminal for (final String s : enumerationStrs) System.out.println('\"' + s + "\", ");
    
    See Also:
    
    BaseType.enumStrList(String)
  - gridHighlightConfig
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final Overlay.GridHighlightConfig gridHighlightConfig
    
    The grid layout highlight configuration (default: all transparent).
    OPTIONAL
  - flexContainerHighlightConfig
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final Overlay.FlexContainerHighlightConfig flexContainerHighlightConfig
    
    The flex container highlight configuration (default: all transparent).
    OPTIONAL
  - flexItemHighlightConfig
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final Overlay.FlexItemHighlightConfig flexItemHighlightConfig
    
    The flex item highlight configuration (default: all transparent).
    OPTIONAL
  - contrastAlgorithm
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final java.lang.String contrastAlgorithm
    
    The contrast algorithm to use for the contrast ratio (default: aa).
    OPTIONAL
    
    This particular field will have its values resricted to the contents of a CDP defined Enumerated String List. That list may be viewed here:
    
    📎 Overlay.ContrastAlgorithm
    
    Programmatically Accessing the Enum:
    
    // Retrieve the list of enumerated strings for this field ReadOnlyList<String> enumerationStrs = Overlay.ContrastAlgorithm.enumStrList("contrastAlgorithm"); // Print the list of strings to the terminal for (final String s : enumerationStrs) System.out.println('\"' + s + "\", ");
    
    See Also:
    
    BaseType.enumStrList(String)
  - containerQueryContainerHighlightConfig
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final Overlay.ContainerQueryContainerHighlightConfig containerQueryContainerHighlightConfig
    
    The container query container highlight configuration (default: all transparent).
    OPTIONAL
- Constructor Detail
  - HighlightConfig
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public HighlightConfig (ReadOnlyList<java.lang.Boolean> isPresent, java.lang.Boolean showInfo, java.lang.Boolean showStyles, java.lang.Boolean showRulers, java.lang.Boolean showAccessibilityInfo, java.lang.Boolean showExtensionLines, DOM.RGBA contentColor, DOM.RGBA paddingColor, DOM.RGBA borderColor, DOM.RGBA marginColor, DOM.RGBA eventTargetColor, DOM.RGBA shapeColor, DOM.RGBA shapeMarginColor, DOM.RGBA cssGridColor, java.lang.String colorFormat, Overlay.GridHighlightConfig gridHighlightConfig, Overlay.FlexContainerHighlightConfig flexContainerHighlightConfig, Overlay.FlexItemHighlightConfig flexItemHighlightConfig, java.lang.String contrastAlgorithm, Overlay.ContainerQueryContainerHighlightConfig containerQueryContainerHighlightConfig)
    
    Constructor. Please review this class' fields for documentation.
- Method Detail
  - fromJSON
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static Overlay.HighlightConfig fromJSON(JsonObject jo)
    
    Creates an instance of this class from a JsonObject.
    
    Code:
    
    Exact Method Body:
    
    return singleton.fromJSON(jo);
  - descriptor
    
    🡅 ⇈ ⮫ 🗕 🗗 🗖
    public static NestedDescriptor<Overlay.HighlightConfig> descriptor()
    
    Returns this class's NestedDescriptor singleton-instance. class / type.
    
    Code:
    
    Exact Method Body:
    
    return singleton.descriptor();

Fields
RGBA	borderColor
String	colorFormat
ContainerQueryContainerHighlightConfig	containerQueryContainerHighlightConfig
RGBA	contentColor
String	contrastAlgorithm
RGBA	cssGridColor
RGBA	eventTargetColor
FlexContainerHighlightConfig	flexContainerHighlightConfig
FlexItemHighlightConfig	flexItemHighlightConfig
GridHighlightConfig	gridHighlightConfig
RGBA	marginColor
RGBA	paddingColor
long	serialVersionUID
RGBA	shapeColor
RGBA	shapeMarginColor
Boolean	showAccessibilityInfo
Boolean	showExtensionLines
Boolean	showInfo
Boolean	showRulers
Boolean	showStyles
Constructors
HighlightConfig(ReadOnlyList isPresent, Boolean showInfo, Boolean showStyles, Boolean showRulers, Boolean showAccessibilityInfo, Boolean showExtensionLines, RGBA contentColor, RGBA paddingColor, RGBA borderColor, RGBA marginColor, RGBA eventTargetColor, RGBA shapeColor, RGBA shapeMarginColor, RGBA cssGridColor, String colorFormat, GridHighlightConfig gridHighlightConfig, FlexContainerHighlightConfig flexContainerHighlightConfig, FlexItemHighlightConfig flexItemHighlightConfig, String contrastAlgorithm, ContainerQueryContainerHighlightConfig containerQueryContainerHighlightConfig)
Methods
NestedDescriptor	descriptor()
HighlightConfig	fromJSON(JsonObject jo)

Class Overlay.HighlightConfig

Field Summary

Fields inherited from class Torello.Browser.BaseType

Constructor Summary

Method Summary

Methods inherited from class Torello.Browser.BaseType

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

showInfo

showStyles

showRulers

showAccessibilityInfo

showExtensionLines

contentColor

paddingColor

borderColor

marginColor

eventTargetColor

shapeColor

shapeMarginColor

cssGridColor

colorFormat

gridHighlightConfig

flexContainerHighlightConfig

flexItemHighlightConfig

contrastAlgorithm

containerQueryContainerHighlightConfig

Constructor Detail

HighlightConfig

Method Detail

fromJSON

descriptor