Class DOMSnapshot

  • public class DOMSnapshot
extends java.lang.Object

    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.

    These files were converted into this Java-Browser (CDP) Library. The intention is to have them function in a similar fasion to the Node.js Tool known as 'Puppeteer', Microsoft's 'Playwright' and of course the Main-Stay 'Selenium.' The Java-HTML JAR Library merely implements the Java Types & Commands defined by Google's DevTools Protocol.

    🧠 View the Google CDP API:

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

    The top-level description and explanation for this class (this comment, at the top this Java-Doc Page) is repeated, verbatim, across all of the domain classes which comprise Google's CDP API.

    This class is intended to be used with a Browser Instance

    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. Google-Corporation is the developer of this API, but any browser which accepts a Remote Debug Port Connection over Web-Sockets.

    Google-Chrome was used during the development process of the classes in this particular package. Lately, it has been asserted Microsoft has switched to using the Chrome Browser-Engine for its Microsoft Edge Internal Code-Base. Therefore, there may some functionality available when running the methods in this class with Microsoft-Edge.

    Check whether the your Web-Browser will allow itself to be driven by the Web-Socket RDP-Port 9223. See the examples available in package Torello.Browser to undertand how to build a PageConn and BrowserConn Web-Socket Connection, and how to build a WebSocketSender instance in order to execute the methods in this class.

    Web-Socket & JSON 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 Connection
    3. Receive BOTH that Command-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 a User-Registered, Event-Listener (Events) or a Promise Object (Command Responses / Results)

    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".


    Asking Chat-GPT for Help:   
    The LLM otherwise known as "Chat-GPT" does, indeed, have an expert level of knowledge about the "Remote DevTools Protocol". The API that the Chrome DevTools Protocl (CDP) exports is extremely well understood by the LLM, and generally I have found that Chat-GPT understands (by 2 or 3 orders of magnitude) better what my Auto-Generated JSON-Wrappers can do in controlling a Web-Browser than I could ever possibly hope to understand.

    Though not available today, there will soon be an automatically downloadable Token-Stream (AI Embeddings) BUTTON available on my Java-Doc Pages that should hopefully make it extremely easy to post my code-base, RAG Style, to Chat-GPT and other LLM's when 'interogating' them. Presently, because my "Get Token Stream Button" does not exist yet on any of my pages, what you can do is copy-and-paste any Method-Signature from any one of these pages and then ask Chat-GPT to explain what that Browser or Java-Script Function is actually doing. It is very likely to give you some pretty neat answers.

    I have found that every single one of the Domains, Types & Events which are offered by the CDP Protocol (though not documented very well by Google), are perfectly understood by the A.I. LLM - literally to the point where it does know (much better than I ever could) what my own code base actually does!

    Try it out, it's a lot of fun. Note that this package and these classes were originally developed solely to be able to execute the Java-Script that a browser executes when visiting a Web-Site. Complete HTML-Page Content can be scraped (using the HTML Data-Scraping Tools in Java-HTML) off of Web-Sites that have dynamic / Java-Script Generated Content.


    Conspicuous Boxed-Types Usage:
    You may notice that there are many methods that have parameters which accept, for instance, an Integer, instead of a primitive int. Just to remind the readiner, in Java Programs a Boxed Type is a standard Java-Primitive which has been converted into an Object-Reference. The use of Boxed-Types in this code base is an easy-and-fast-way to allow for the concept of "Optional Parameters" or "Optional Field Value."

    Whenever you see a method that accepts an Integer, the reason for this Parameter-Type choice is actually to allow a user to pass 'null' to it. This is a simple way to ELIDE passing any value at all to parameters which Google-Chrome would otherwise assert are "Optional." Whenever you pass 'null' to a Boxed-Types in this class, the Json-Processor will simply eliminate that Object-Property from the command altogether; and the browser will simply not receive any value for that parameter when that command is invoked.

    The Java Language Specification does not have an easy or well defined means of accepting optional method parameters; so Boxed-Types and 'null' are utilized here. Note that 'null' may be passed to any Command Method-Parameter that is listed as Optional on the Java-Doc Page description for that parameter.



    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
    • 5 Method(s), 5 declared static
    • 3 Field(s), 3 declared static, 3 declared final


    • Nested Class Summary

       
      Type Nested Classes: Types / Classes that Are Used & Exported by this Domain
      Modifier and Type Class Description
      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.
       
      Command-Returns Nested Classes: Domain-Commands with Multiple Return-Values, and a Dedicated Inner-Class
      Modifier and Type Class Description
      static class  DOMSnapshot.captureSnapshot$$RET
      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.
      static class  DOMSnapshot.getSnapshot$$RET
      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.

    • Field Summary

       
      Eliminated Types: Removed CDP Types which Have Been Re-Mapped to Basic Java String Constants
      Modifier and Type Field Description
      static String ArrayOfStrings
      Index of the string in the strings table.
      static String Rectangle
      [No Description Provided by Google]
      static String StringIndex
      Index of the string in the strings table.

    • Method Summary

       
      DOMSnapshot Domain Commands
      Script Returns Modifier and Type Method
      DOMSnapshot.captureSnapshot$$RET 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.
      Void static Script<> disable()
      Disables DOM snapshot agent for the given page.
      Void static Script<> enable()
      Enables DOM snapshot agent for the given page.
      DOMSnapshot.getSnapshot$$RET 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.
       
      DOMSnapshot Domain CommandBuilder Methods
      Modifier and Type Method Description
      static CommandBuilder
      <DOMSnapshot.captureSnapshot$$RET>      		 captureSnapshot()
      Creates a buider for conveniently assigning parameters to this method.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • ArrayOfStrings

        🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static final java.lang.String ArrayOfStrings
        Index of the string in the strings table.

        The Type ArrayOfStrings has been eliminated, because it is a direct mapping to a basic Java-Type; it has no additional fields, or other distinguishing properties. Instead, this CDP defined type has been relegated to a simple String Constant, for documentation & reference purposes only.

        The code which is generated which employs this type replaces its use with the Standard Java-Type: int[]

        Eliminated Type
        See Also:
        Constant Field Values

      • Rectangle

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static final java.lang.String Rectangle
        [No Description Provided by Google]

        The Type Rectangle has been eliminated, because it is a direct mapping to a basic Java-Type; it has no additional fields, or other distinguishing properties. Instead, this CDP defined type has been relegated to a simple String Constant, for documentation & reference purposes only.

        The code which is generated which employs this type replaces its use with the Standard Java-Type: Number

        Eliminated Type
        See Also:
        Constant Field Values

      • StringIndex

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static final java.lang.String StringIndex
        Index of the string in the strings table.

        The Type StringIndex has been eliminated, because it is a direct mapping to a basic Java-Type; it has no additional fields, or other distinguishing properties. Instead, this CDP defined type has been relegated to a simple String Constant, for documentation & reference purposes only.

        The code which is generated which employs this type replaces its use with the Standard Java-Type: int

        Eliminated Type
        See Also:
        Constant Field Values

    • Method Detail

      • captureSnapshot

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<DOMSnapshot.captureSnapshot$$RET> 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.

        👍 Because of the sheer number of input parameters to this method, there is a a CommandBuilder variant to this method which may be invoked instead.

        Please View: captureSnapshot()
        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.
        OPTIONALEXPERIMENTAL
        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.
        OPTIONALEXPERIMENTAL
        Returns:
        An instance of Script<DOMSnapshot.captureSnapshot$$RET>

        This script may be executed, using Script.exec, and afterwards, a Promise <DOMSnapshot.captureSnapshot$$RET> will be returned

        Finally, the Promise may be awaited, using Promise.await(), and the returned result of this Browser Function may be retrieved.

        This Browser Function's Promise returns:DOMSnapshot.captureSnapshot$$RET A dedicated return type implies that the browser may return more than 1 datum

      • disable

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.Void> disable()
        Disables DOM snapshot agent for the given page.
        Returns:
        An instance of Script<Void>

        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<Void> to ensure that the Browser Function has run to completion.

      • enable

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.Void> enable()
        Enables DOM snapshot agent for the given page.
        Returns:
        An instance of Script<Void>

        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<Void> to ensure that the Browser Function has run to completion.

      • getSnapshot

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<DOMSnapshot.getSnapshot$$RET> 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<DOMSnapshot.getSnapshot$$RET>

        This script may be executed, using Script.exec, and afterwards, a Promise <DOMSnapshot.getSnapshot$$RET> will be returned

        Finally, the Promise may be awaited, using Promise.await(), and the returned result of this Browser Function may be retrieved.

        This Browser Function's Promise returns:DOMSnapshot.getSnapshot$$RET A dedicated return type implies that the browser may return more than 1 datum