Package Torello.Browser.BrowserAPI

Class DOMSnapshot.LayoutTreeSnapshot

java.lang.Object

Torello.Browser.BaseType<DOMSnapshot.LayoutTreeSnapshot>

Torello.Browser.BrowserAPI.DOMSnapshot.LayoutTreeSnapshot

All Implemented Interfaces:

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

Enclosing class:

DOMSnapshot

public static class DOMSnapshot.LayoutTreeSnapshot
extends BaseType<DOMSnapshot.LayoutTreeSnapshot>
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 DOMSnapshot 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.

Table of details of an element in the DOM tree with a LayoutObject.

See Also:

Serialized Form

Hi-Lited Source-Code:

This File's Source Code:

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

File Size: 4,589 Bytes Line Count: 105 '\n' Characters Found
Helper: Equals, HashCode, toJSON, etc

• View Here: DOMSnapshot$$LayoutTreeSnapshot$$.java
• Open New Browser-Tab: DOMSnapshot$$LayoutTreeSnapshot$$.java

File Size: 16,922 Bytes Line Count: 386 '\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
int[]	blendedBackgroundColors	The list of background colors that are blended with colors of overlapping elements.
Number[]	bounds	The absolute position bounding box.
Number[]	clientRects	The client rect of nodes.
int[]	nodeIndex	Index of the corresponding node in the NodeTreeSnapshot array returned by captureSnapshot.
Number[]	offsetRects	The offset rect of nodes.
int[]	paintOrders	Global paint order index, which is determined by the stacking order of the nodes.
Number[]	scrollRects	The scroll rect of nodes.
DOMSnapshot.RareBooleanData	stackingContexts	Stacking context information.
int[][]	styles	Array of indexes specifying computed style strings, filtered according to the computedStyles parameter passed to captureSnapshot.
int[]	text	Contents of the LayoutText, if any.
Number[]	textColorOpacities	The list of computed text opacities.

Fields inherited from class Torello.Browser.BaseType

domain, helperSingleton, isPresent, name, numFields

Constructor Summary

Constructors

Constructor	Description
LayoutTreeSnapshot(ReadOnlyList<Boolean> isPresent, int[] nodeIndex, int[][] styles, Number[] bounds, int[] text, DOMSnapshot.RareBooleanData stackingContexts, int[] paintOrders, Number[] offsetRects, Number[] scrollRects, Number[] clientRects, int[] blendedBackgroundColors, Number[] textColorOpacities)	Constructor.

Method Summary

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

nodeIndex

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final int[] nodeIndex

Index of the corresponding node in the NodeTreeSnapshot array returned by captureSnapshot.

styles

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final int[][] styles

Array of indexes specifying computed style strings, filtered according to the computedStyles parameter passed to captureSnapshot.

bounds

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.Number[] bounds

The absolute position bounding box.

text

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final int[] text

Contents of the LayoutText, if any.

stackingContexts

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final DOMSnapshot.RareBooleanData stackingContexts

Stacking context information.

paintOrders

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final int[] paintOrders

Global paint order index, which is determined by the stacking order of the nodes. Nodes that are painted together will have the same index. Only provided if includePaintOrder in captureSnapshot was true.
OPTIONAL

offsetRects

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.Number[] offsetRects

The offset rect of nodes. Only available when includeDOMRects is set to true
OPTIONAL

scrollRects

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.Number[] scrollRects

The scroll rect of nodes. Only available when includeDOMRects is set to true
OPTIONAL

clientRects

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.Number[] clientRects

The client rect of nodes. Only available when includeDOMRects is set to true
OPTIONAL

blendedBackgroundColors

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final int[] blendedBackgroundColors

The list of background colors that are blended with colors of overlapping elements.
OPTIONALEXPERIMENTAL

textColorOpacities

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.Number[] textColorOpacities

The list of computed text opacities.
OPTIONALEXPERIMENTAL

Constructor Detail

LayoutTreeSnapshot

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public LayoutTreeSnapshot(ReadOnlyList<java.lang.Boolean> isPresent,
                          int[] nodeIndex,
                          int[][] styles,
                          java.lang.Number[] bounds,
                          int[] text,
                          DOMSnapshot.RareBooleanData stackingContexts,
                          int[] paintOrders,
                          java.lang.Number[] offsetRects,
                          java.lang.Number[] scrollRects,
                          java.lang.Number[] clientRects,
                          int[] blendedBackgroundColors,
                          java.lang.Number[] textColorOpacities)

Constructor. Please review this class' fields for documentation.

Method Detail

fromJSON

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public static DOMSnapshot.LayoutTreeSnapshot fromJSON(JsonObject jo)

Creates an instance of this class from a JsonObject.

Code:

Exact Method Body:

 return singleton.fromJSON(jo);

descriptor

🡅 ⇈ ⮫ 🗕 🗗 🗖

public static NestedDescriptor<DOMSnapshot.LayoutTreeSnapshot> descriptor()

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

Code:

Exact Method Body:

 return singleton.descriptor();