Package Torello.Browser.BrowserAPI

Class Overlay.GridHighlightConfig

java.lang.Object

Torello.Browser.BaseType<Overlay.GridHighlightConfig>

Torello.Browser.BrowserAPI.Overlay.GridHighlightConfig

All Implemented Interfaces:

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

Enclosing class:

Overlay

public static class Overlay.GridHighlightConfig
extends BaseType<Overlay.GridHighlightConfig>
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 Grid 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,290 Bytes Line Count: 185 '\n' Characters Found
Helper: Equals, HashCode, toJSON, etc

• View Here: Overlay$$GridHighlightConfig$$.java
• Open New Browser-Tab: Overlay$$GridHighlightConfig$$.java

File Size: 21,229 Bytes Line Count: 472 '\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	areaBorderColor	The named grid areas border color (Default: transparent).
DOM.RGBA	cellBorderColor	The cell border color (default: transparent).
Boolean	cellBorderDash	Whether the cell border is dashed (default: false).
DOM.RGBA	columnGapColor	The column gap highlight fill color (default: transparent).
DOM.RGBA	columnHatchColor	The column gap hatching fill color (default: transparent).
DOM.RGBA	columnLineColor	The column line color (default: transparent).
Boolean	columnLineDash	Whether column lines are dashed (default: false).
DOM.RGBA	gridBackgroundColor	The grid container background color (Default: transparent).
DOM.RGBA	gridBorderColor	The grid container border highlight color (default: transparent).
Boolean	gridBorderDash	Whether the grid border is dashed (default: false).
DOM.RGBA	rowGapColor	The row gap highlight fill color (default: transparent).
DOM.RGBA	rowHatchColor	The row gap hatching fill color (default: transparent).
DOM.RGBA	rowLineColor	The row line color (default: transparent).
Boolean	rowLineDash	Whether row lines are dashed (default: false).
Boolean	showAreaNames	Show area name labels (default: false).
Boolean	showGridExtensionLines	Whether the extension lines from grid cells to the rulers should be shown (default: false).
Boolean	showLineNames	Show line name labels (default: false).
Boolean	showNegativeLineNumbers	Show Negative line number labels (default: false).
Boolean	showPositiveLineNumbers	Show Positive line number labels (default: false).
Boolean	showTrackSizes	Show track size labels (default: false).

Fields inherited from class Torello.Browser.BaseType

domain, helperSingleton, isPresent, name, numFields

Constructor Summary

Constructors

Constructor

Description

GridHighlightConfig(ReadOnlyList<Boolean> isPresent, Boolean showGridExtensionLines, Boolean showPositiveLineNumbers, Boolean showNegativeLineNumbers, Boolean showAreaNames, Boolean showLineNames, Boolean showTrackSizes, DOM.RGBA gridBorderColor, DOM.RGBA cellBorderColor, DOM.RGBA rowLineColor, DOM.RGBA columnLineColor, Boolean gridBorderDash, Boolean cellBorderDash, Boolean rowLineDash, Boolean columnLineDash, DOM.RGBA rowGapColor, DOM.RGBA rowHatchColor, DOM.RGBA columnGapColor, DOM.RGBA columnHatchColor, DOM.RGBA areaBorderColor, DOM.RGBA gridBackgroundColor)

Constructor.

Method Summary

Static Builder Convert a JsonObject to a POJO
Modifier and Type	Method	Description
static Overlay.GridHighlightConfig	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.GridHighlightConfig>	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

showGridExtensionLines

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.Boolean showGridExtensionLines

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

showPositiveLineNumbers

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.Boolean showPositiveLineNumbers

Show Positive line number labels (default: false).
OPTIONAL

showNegativeLineNumbers

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.Boolean showNegativeLineNumbers

Show Negative line number labels (default: false).
OPTIONAL

showAreaNames

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.Boolean showAreaNames

Show area name labels (default: false).
OPTIONAL

showLineNames

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.Boolean showLineNames

Show line name labels (default: false).
OPTIONAL

showTrackSizes

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.Boolean showTrackSizes

Show track size labels (default: false).
OPTIONAL

gridBorderColor

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final DOM.RGBA gridBorderColor

The grid container border highlight color (default: transparent).
OPTIONAL

cellBorderColor

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final DOM.RGBA cellBorderColor

The cell border color (default: transparent). Deprecated, please use rowLineColor and columnLineColor instead.
OPTIONALDEPRECATED

rowLineColor

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final DOM.RGBA rowLineColor

The row line color (default: transparent).
OPTIONAL

columnLineColor

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final DOM.RGBA columnLineColor

The column line color (default: transparent).
OPTIONAL

gridBorderDash

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.Boolean gridBorderDash

Whether the grid border is dashed (default: false).
OPTIONAL

cellBorderDash

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.Boolean cellBorderDash

Whether the cell border is dashed (default: false). Deprecated, please us rowLineDash and columnLineDash instead.
OPTIONALDEPRECATED

rowLineDash

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.Boolean rowLineDash

Whether row lines are dashed (default: false).
OPTIONAL

columnLineDash

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.Boolean columnLineDash

Whether column lines are dashed (default: false).
OPTIONAL

rowGapColor

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final DOM.RGBA rowGapColor

The row gap highlight fill color (default: transparent).
OPTIONAL

rowHatchColor

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final DOM.RGBA rowHatchColor

The row gap hatching fill color (default: transparent).
OPTIONAL

columnGapColor

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final DOM.RGBA columnGapColor

The column gap highlight fill color (default: transparent).
OPTIONAL

columnHatchColor

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final DOM.RGBA columnHatchColor

The column gap hatching fill color (default: transparent).
OPTIONAL

areaBorderColor

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final DOM.RGBA areaBorderColor

The named grid areas border color (Default: transparent).
OPTIONAL

gridBackgroundColor

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final DOM.RGBA gridBackgroundColor

The grid container background color (Default: transparent).
OPTIONAL

Constructor Detail

GridHighlightConfig

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public GridHighlightConfig(ReadOnlyList<java.lang.Boolean> isPresent,
                           java.lang.Boolean showGridExtensionLines,
                           java.lang.Boolean showPositiveLineNumbers,
                           java.lang.Boolean showNegativeLineNumbers,
                           java.lang.Boolean showAreaNames,
                           java.lang.Boolean showLineNames,
                           java.lang.Boolean showTrackSizes,
                           DOM.RGBA gridBorderColor,
                           DOM.RGBA cellBorderColor,
                           DOM.RGBA rowLineColor,
                           DOM.RGBA columnLineColor,
                           java.lang.Boolean gridBorderDash,
                           java.lang.Boolean cellBorderDash,
                           java.lang.Boolean rowLineDash,
                           java.lang.Boolean columnLineDash,
                           DOM.RGBA rowGapColor,
                           DOM.RGBA rowHatchColor,
                           DOM.RGBA columnGapColor,
                           DOM.RGBA columnHatchColor,
                           DOM.RGBA areaBorderColor,
                           DOM.RGBA gridBackgroundColor)

Constructor. Please review this class' fields for documentation.

Method Detail

fromJSON

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public static Overlay.GridHighlightConfig 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.GridHighlightConfig> descriptor()

Returns this class's NestedDescriptor singleton-instance. class / type.

Code:

Exact Method Body:

 return singleton.descriptor();