Package Torello.Browser

Class Overlay.GridHighlightConfig

java.lang.Object

Torello.Java.JSON.BaseType

Torello.Browser.Overlay.GridHighlightConfig

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

Overlay

public static class Overlay.GridHighlightConfig
extends BaseType
implements java.io.Serializable

Configuration data for the highlighting of Grid elements.

See Also:

Serialized Form

Hi-Lited Source-Code:

• View Here: Torello/Browser/Overlay.java
• Open New Browser-Tab: Torello/Browser/Overlay.java

File Size: 15,030 Bytes Line Count: 336 '\n' Characters Found

Field Summary

Serializable ID
Modifier and Type	Field
protected static long	serialVersionUID	For Object Serialization.
Type Properties
Modifier and Type	Field
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).

Constructor Summary

Constructors

Constructor	Description
GridHighlightConfig(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
GridHighlightConfig(JsonObject jo)	JSON Object Constructor

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object other)	Checks whether 'this' equals an input Java-Object
int	hashCode()	Generates a Hash-Code for 'this' instance
boolean[]	optionals()	Implementing this method allows sub-classes to specify which JSON Properties may be absent or null.

Methods inherited from class Torello.Java.JSON.BaseType

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

For Object Serialization. java.io.Serializable

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.

OPTIONAL
DEPRECATED

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.

OPTIONAL
DEPRECATED

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

Parameters:

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

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

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

showAreaNames - Show area name labels (default: false).
OPTIONAL

showLineNames - Show line name labels (default: false).
OPTIONAL

showTrackSizes - Show track size labels (default: false).
OPTIONAL

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

cellBorderColor - The cell border color (default: transparent). Deprecated, please use rowLineColor and columnLineColor instead.
OPTIONAL
DEPRECATED

rowLineColor - The row line color (default: transparent).
OPTIONAL

columnLineColor - The column line color (default: transparent).
OPTIONAL

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

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

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

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

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

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

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

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

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

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

GridHighlightConfig

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public GridHighlightConfig(JsonObject jo)

JSON Object Constructor

Parameters:

jo - A Json-Object having data about an instance of 'GridHighlightConfig'.

Method Detail

optionals

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public boolean[] optionals()

Description copied from class: BaseType

Implementing this method allows sub-classes to specify which JSON Properties may be absent or null. When binding a JsonObject to a Java-Object, if some of the expected fields for the Java-Object map to Properties which might be left-out or omitted, then that may be indicated by setting that fields array position TRUE.

NOTE: This array should have a length equal to the number of fields contained by the Java Object. The first boolean in the array should specify whether the first Object Field may by absent. The second boolean should specify whether the second Object Field is optional in the JSON - and so on and so forth...

Specified by:

optionals in class BaseType

Returns:

A boolean[] array whose length is precisely equal to the number of fields in the Java Object.

equals

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public boolean equals(java.lang.Object other)

Checks whether 'this' equals an input Java-Object

Overrides:

equals in class java.lang.Object

hashCode

🡅 ⇈ ⮫ 🗕 🗗 🗖

public int hashCode()

Generates a Hash-Code for 'this' instance

Overrides:

hashCode in class java.lang.Object