Package Torello.Browser

Class DOMSnapshot

java.lang.Object

Torello.Browser.DOMSnapshot

public class DOMSnapshot
extends java.lang.Object

Class created by Automatic Code-Generator.
This class was built using the Chrome Remote Dev-Tools A.P.I., which is specified by two JSON-RPC Files. These files were obtained from the Chrome Dev Tools Protocol Git Hub Page, which has a "Tip of Tree" (the latest) API-Specification Page Here: JSON-RPC Protocol Specification.

JSON-Viewable Google-API:
These files may be viewed here: browser_protocol.json and js_protocol.json.
These files were converted into this Java-Browser (CDT) Library; they are a Java-Alternative to the Node.js implementation.

HTML-Viewable API:
In addition to this Class-Library, these files were also converted to a simple HTML Page, which may be browsed here: Browser API Web-Page

Node.js RDP-API Implementation:
You may read about the Node.js Chrome Remote Interface on the Node.js Package Manager Web-Site: NPM

This domain facilitates obtaining document snapshots with DOM, layout, and style information.

This class is intended to be used with a Headless Browser

These methods have been tested, to some degree, using Google Chrome. In order to use this class you must start a web-browser instance and make a connection to the browser using a Remote Debugging Port. The initializations may be accomplished using class BRDPC (Browser Remote Debug Protocol Connection).

Google-Chrome was used during the development process of the classes in this particular package. Note that, lately, it has been asserted Microsoft has switched to using the Chrome-Engine for its Microsoft Edge Browser Internal Code-Base. Therefore, there may limited support / functionality when running the methods in this class with Microsoft-Edge. There is the possibility these will work with Opera & Safari.

Check whether the your Web-Browser will allow itself to be driven by the Web-Socket RDP-Port 9223.

Foreign Function API:
Every one of the methods that reside in this class are designed to do nothing more than:

1. Accept Parameters from the User, and "Marshall Them" into a Valid JSON-Request
2. Transmit the Marshalled Request-JSON to a Headless Web-Browser over a Web-Socket RDP Connection
3. Receive BOTH that Method's Results AND any Browser Event-Firings from the Web-Socket
4. Parse JSON Method-Results and Browser-Event Firings, and Subsequently Convert them to Standard Java-Types
5. Report these Method-Results and Browser-Events to the User via an User-Registered Event-Listener or a Promise Object

Java-HTML Difference:
Unlike the bulk of the Java HTML JAR Library, there is very little native Java-Code, and very little testing that may be done on any of the classes & methods in this package. The code inside these classes does nothing more than marshall-and-unmarshall Java-Types into Json-Requests (and vice-versa). The Java-Script & Browser modules inside of a Google-Chrome instance are, theoretically, handling these requests, and returning their results (or events) over the Web-Socket Connection.

It has been asserted (by Google Chrome Developers) that some of these methods are only "partially working" or "experimental".

Hi-Lited Source-Code:

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

File Size: 95,546 Bytes Line Count: 2,251 '\n' Characters Found

Stateless Class:

This class neither contains any program-state, nor can it be instantiated. The @StaticFunctional Annotation may also be called 'The Spaghetti Report'. Static-Functional classes are, essentially, C-Styled Files, without any constructors or non-static member fields. It is a concept very similar to the Java-Bean's @Stateless Annotation.

• 1 Constructor(s), 1 declared private, zero-argument constructor
• 4 Method(s), 4 declared static
• 5 Field(s), 5 declared static, 4 declared final
• Fields excused from final modifier (with explanation):

  Field 'counter' is not final.

  Reason: CONFIGURATION

Nested Class Summary

Type Classes: DOMSnapshot Domain Types
Modifier and Type	Inner-Class
static class	DOMSnapshot.ComputedStyle	A subset of the full ComputedStyle as defined by the request whitelist.
static class	DOMSnapshot.DocumentSnapshot	Document snapshot.
static class	DOMSnapshot.DOMNode	A Node in the DOM tree.
static class	DOMSnapshot.InlineTextBox	Details of post layout rendered text positions.
static class	DOMSnapshot.LayoutTreeNode	Details of an element in the DOM tree with a LayoutObject.
static class	DOMSnapshot.LayoutTreeSnapshot	Table of details of an element in the DOM tree with a LayoutObject.
static class	DOMSnapshot.NameValue	A name/value pair.
static class	DOMSnapshot.NodeTreeSnapshot	Table containing nodes.
static class	DOMSnapshot.RareBooleanData	[No Description Provided by Google]
static class	DOMSnapshot.RareIntegerData	[No Description Provided by Google]
static class	DOMSnapshot.RareStringData	Data that is only present on rare nodes.
static class	DOMSnapshot.TextBoxSnapshot	Table of details of the post layout rendered text positions.

Method Summary

DOMSnapshot Domain Commands
Script Returns	Modifier and Type	Method
Ret2<DOMSnapshot.DocumentSnapshot[], String[]>	static Script<>	captureSnapshot(String[] computedStyles, Boolean includePaintOrder, Boolean includeDOMRects, Boolean includeBlendedBackgroundColors, Boolean includeTextColorOpacities) Returns a document snapshot, including the full DOM tree of the root node (including iframes, template contents, and imported documents) in a flattened array, as well as layout and white-listed computed style information for the nodes.
NONE (void)	static Script<>	disable() Disables DOM snapshot agent for the given page.
NONE (void)	static Script<>	enable() Enables DOM snapshot agent for the given page.
Ret3<DOMSnapshot.DOMNode[], DOMSnapshot.LayoutTreeNode[], DOMSnapshot.ComputedStyle[]>	static Script<>	getSnapshot(String[] computedStyleWhitelist, Boolean includeEventListeners, Boolean includePaintOrder, Boolean includeUserAgentShadowTree) Returns a document snapshot, including the full DOM tree of the root node (including iframes, template contents, and imported documents) in a flattened array, as well as layout and white-listed computed style information for the nodes.

Methods inherited from class java.lang.Object

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

Method Detail

disable

🡇 ⇈ ⮫ 🗕 🗗 🗖

public static Script<java.lang.String,JsonObject,Ret0> disable()

Disables DOM snapshot agent for the given page.

Returns:

An instance of Script<String, JsonObject, Ret0>

This Script instance must be executed before the browser receives the invocation-request.

This Browser-Function does not have a return-value. You may choose to await the Promise<JsonObject, Ret0 > to ensure the Browser Function has run to completion.

enable

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public static Script<java.lang.String,JsonObject,Ret0> enable()

Enables DOM snapshot agent for the given page.

Returns:

An instance of Script<String, JsonObject, Ret0>

This Script instance must be executed before the browser receives the invocation-request.

This Browser-Function does not have a return-value. You may choose to await the Promise<JsonObject, Ret0 > to ensure the Browser Function has run to completion.

getSnapshot

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public static Script<java.lang.String,JsonObject,Ret3<DOMSnapshot.DOMNode[],DOMSnapshot.LayoutTreeNode[],DOMSnapshot.ComputedStyle[]>> getSnapshot
            (java.lang.String[] computedStyleWhitelist,
             java.lang.Boolean includeEventListeners,
             java.lang.Boolean includePaintOrder,
             java.lang.Boolean includeUserAgentShadowTree)

Returns a document snapshot, including the full DOM tree of the root node (including iframes, template contents, and imported documents) in a flattened array, as well as layout and white-listed computed style information for the nodes. Shadow DOM in the returned DOM tree is flattened.
DEPRECATED

Parameters:

computedStyleWhitelist - Whitelist of computed styles to return.

includeEventListeners - Whether or not to retrieve details of DOM listeners (default false).
OPTIONAL

includePaintOrder - Whether to determine and include the paint order index of LayoutTreeNodes (default false).
OPTIONAL

includeUserAgentShadowTree - Whether to include UA shadow tree in the snapshot (default false).
OPTIONAL

Returns:

An instance of Script<String, JsonObject, Ret3>

This Script may be executed (using Script.exec()), and a Promise returned.

When the Promise is awaited (using Promise.await()), the Ret3 will subsequently be returned from that call.

The returned values are encapsulated in an instance of Ret3

• Ret3.a: DOMSnapshot.DOMNode[] (domNodes)
  The nodes in the DOM tree. The DOMNode at index 0 corresponds to the root document.
  
  
• Ret3.b: DOMSnapshot.LayoutTreeNode[] (layoutTreeNodes)
  The nodes in the layout tree.
  
  
• Ret3.c: DOMSnapshot.ComputedStyle[] (computedStyles)
  Whitelisted ComputedStyle properties for each node in the layout tree.

captureSnapshot

🡅 ⇈ ⮫ 🗕 🗗 🗖

public static Script<java.lang.String,JsonObject,Ret2<DOMSnapshot.DocumentSnapshot[],java.lang.String[]>> captureSnapshot
            (java.lang.String[] computedStyles,
             java.lang.Boolean includePaintOrder,
             java.lang.Boolean includeDOMRects,
             java.lang.Boolean includeBlendedBackgroundColors,
             java.lang.Boolean includeTextColorOpacities)

Returns a document snapshot, including the full DOM tree of the root node (including iframes, template contents, and imported documents) in a flattened array, as well as layout and white-listed computed style information for the nodes. Shadow DOM in the returned DOM tree is flattened.

Parameters:

computedStyles - Whitelist of computed styles to return.

includePaintOrder - Whether to include layout object paint orders into the snapshot.
OPTIONAL

includeDOMRects - Whether to include DOM rectangles (offsetRects, clientRects, scrollRects) into the snapshot
OPTIONAL

includeBlendedBackgroundColors - Whether to include blended background colors in the snapshot (default: false). Blended background color is achieved by blending background colors of all elements that overlap with the current element.
OPTIONAL
EXPERIMENTAL

includeTextColorOpacities - Whether to include text color opacity in the snapshot (default: false). An element might have the opacity property set that affects the text color of the element. The final text color opacity is computed based on the opacity of all overlapping elements.
OPTIONAL
EXPERIMENTAL

Returns:

An instance of Script<String, JsonObject, Ret2>

This Script may be executed (using Script.exec()), and a Promise returned.

When the Promise is awaited (using Promise.await()), the Ret2 will subsequently be returned from that call.

The returned values are encapsulated in an instance of Ret2

• Ret2.a: DOMSnapshot.DocumentSnapshot[] (documents)
  The nodes in the DOM tree. The DOMNode at index 0 corresponds to the root document.
  
  
• Ret2.b: String[] (strings)
  Shared string table that all string properties refer to with indexes.