Package Torello.Browser

Class DOMSnapshot.DocumentSnapshot

java.lang.Object

Torello.Java.Additional.BaseType

Torello.Browser.DOMSnapshot.DocumentSnapshot

Enclosing class:

DOMSnapshot

public static class DOMSnapshot.DocumentSnapshot
extends BaseType

Document snapshot.

Hi-Lited Source-Code:

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

File Size: 6,825 Bytes Line Count: 162 '\n' Characters Found

Field Summary

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean[]	optionals()	Implementing this method allows sub-classes to specify which JSON Properties may be absent or null.

Methods inherited from class Torello.Java.Additional.BaseType

toJSON, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

🡇 ⇈ ⮫

protected static final long serialVersionUID

For Object Serialization. java.io.Serializable

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

Parameters:

documentURL - Document URL that Document or FrameOwner node points to.

title - Document title.

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

contentLanguage - Contains the document's content language.

encodingName - Contains the document's character set encoding.

publicId - DocumentType node's publicId.

systemId - DocumentType node's systemId.

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

nodes - A table with dom nodes.

layout - The nodes in the layout tree.

textBoxes - The post-layout inline text nodes.

scrollOffsetX - Horizontal scroll offset.
OPTIONAL

scrollOffsetY - Vertical scroll offset.
OPTIONAL

contentWidth - Document content width.
OPTIONAL

contentHeight - Document content height.
OPTIONAL

DocumentSnapshot

🡅 🡇 ⇈ ⮫

public DocumentSnapshot(JsonObject jo)

JSON Object Constructor

Parameters:

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

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.