Package Torello.Browser.BrowserAPI

Class DOMSnapshot.DocumentSnapshot

java.lang.Object

Torello.Browser.BaseType<DOMSnapshot.DocumentSnapshot>

Torello.Browser.BrowserAPI.DOMSnapshot.DocumentSnapshot

All Implemented Interfaces:

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

Enclosing class:

DOMSnapshot

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

Document snapshot.

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

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

File Size: 15,987 Bytes Line Count: 374 '\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	baseURL	Base URL that Document or FrameOwner node uses for URL completion.
Number	contentHeight	Document content height.
int	contentLanguage	Contains the document's content language.
Number	contentWidth	Document content width.
int	documentURL	Document URL that Document or FrameOwner node points to.
int	encodingName	Contains the document's character set encoding.
int	frameId	Frame ID for frame owner elements and also for the document node.
DOMSnapshot.LayoutTreeSnapshot	layout	The nodes in the layout tree.
DOMSnapshot.NodeTreeSnapshot	nodes	A table with dom nodes.
int	publicId	DocumentType node's publicId.
Number	scrollOffsetX	Horizontal scroll offset.
Number	scrollOffsetY	Vertical scroll offset.
int	systemId	DocumentType node's systemId.
DOMSnapshot.TextBoxSnapshot	textBoxes	The post-layout inline text nodes.
int	title	Document title.

Fields inherited from class Torello.Browser.BaseType

domain, helperSingleton, isPresent, name, numFields

Constructor Summary

Constructors

Constructor	Description
DocumentSnapshot(ReadOnlyList<Boolean> isPresent, int documentURL, int title, int baseURL, int contentLanguage, int encodingName, int publicId, int systemId, int frameId, DOMSnapshot.NodeTreeSnapshot nodes, DOMSnapshot.LayoutTreeSnapshot layout, DOMSnapshot.TextBoxSnapshot textBoxes, Number scrollOffsetX, Number scrollOffsetY, Number contentWidth, Number contentHeight)	Constructor.

Method Summary

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

documentURL

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final int documentURL

Document URL that Document or FrameOwner node points to.

title

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final int title

Document title.

baseURL

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final int baseURL

Base URL that Document or FrameOwner node uses for URL completion.

contentLanguage

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final int contentLanguage

Contains the document's content language.

encodingName

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final int encodingName

Contains the document's character set encoding.

publicId

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final int publicId

DocumentType node's publicId.

systemId

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final int systemId

DocumentType node's systemId.

frameId

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final int frameId

Frame ID for frame owner elements and also for the document node.

nodes

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final DOMSnapshot.NodeTreeSnapshot nodes

A table with dom nodes.

layout

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final DOMSnapshot.LayoutTreeSnapshot layout

The nodes in the layout tree.

textBoxes

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final DOMSnapshot.TextBoxSnapshot textBoxes

The post-layout inline text nodes.

scrollOffsetX

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.Number scrollOffsetX

Horizontal scroll offset.
OPTIONAL

scrollOffsetY

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.Number scrollOffsetY

Vertical scroll offset.
OPTIONAL

contentWidth

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.Number contentWidth

Document content width.
OPTIONAL

contentHeight

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.Number contentHeight

Document content height.
OPTIONAL

Constructor Detail

DocumentSnapshot

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public DocumentSnapshot(ReadOnlyList<java.lang.Boolean> isPresent,
                        int documentURL,
                        int title,
                        int baseURL,
                        int contentLanguage,
                        int encodingName,
                        int publicId,
                        int systemId,
                        int frameId,
                        DOMSnapshot.NodeTreeSnapshot nodes,
                        DOMSnapshot.LayoutTreeSnapshot layout,
                        DOMSnapshot.TextBoxSnapshot textBoxes,
                        java.lang.Number scrollOffsetX,
                        java.lang.Number scrollOffsetY,
                        java.lang.Number contentWidth,
                        java.lang.Number contentHeight)

Constructor. Please review this class' fields for documentation.

Method Detail

fromJSON

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public static DOMSnapshot.DocumentSnapshot 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.DocumentSnapshot> descriptor()

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

Code:

Exact Method Body:

 return singleton.descriptor();