Package Torello.Browser.BrowserAPI

Class Overlay.LineStyle

java.lang.Object

Torello.Browser.BaseType<Overlay.LineStyle>

Torello.Browser.BrowserAPI.Overlay.LineStyle

All Implemented Interfaces:

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

Enclosing class:

Overlay

public static class Overlay.LineStyle
extends BaseType<Overlay.LineStyle>
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.

Style information for drawing a line.

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: 1,983 Bytes Line Count: 52 '\n' Characters Found
Helper: Equals, HashCode, toJSON, etc

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

File Size: 8,030 Bytes Line Count: 210 '\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	color	The color of the line (default: transparent)
String	pattern	The line pattern (default: solid)

Fields inherited from class Torello.Browser.BaseType

domain, helperSingleton, isPresent, name, numFields

Constructor Summary

Constructors

Constructor	Description
LineStyle(ReadOnlyList<Boolean> isPresent, DOM.RGBA color, String pattern)	Constructor.

Method Summary

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

color

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final DOM.RGBA color

The color of the line (default: transparent)
OPTIONAL

pattern

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.String pattern

The line pattern (default: solid)
OPTIONAL

This particular field will have its values resricted to the contents of a CDP defined Enumerated String List. That list may be viewed inside the hilited source code from this class nested helper. Click the link below, and scroll down to find the definition for a ReadOnlyList<String> named 'pattern$$':

📎 Overlay$$LineStyle$$

Programmatically Accessing the Enum:

// Retrieve the list of enumerated strings for this field
ReadOnlyList<String> enumerationStrs = Overlay.LineStyle.enumStrList("pattern");

// Print the list of strings to the terminal
for (final String s : enumerationStrs) System.out.println('\"' + s + "\", ");

See Also:

BaseType.enumStrList(String)

Constructor Detail

LineStyle

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public LineStyle(ReadOnlyList<java.lang.Boolean> isPresent,
                 DOM.RGBA color,
                 java.lang.String pattern)

Constructor. Please review this class' fields for documentation.

Method Detail

fromJSON

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

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

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

Code:

Exact Method Body:

 return singleton.descriptor();