Class Overlay

  • public class Overlay
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 provides various functionality related to drawing atop the inspected page.

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



    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
    • 28 Method(s), 28 declared static
    • 8 Field(s), 8 declared static, 7 declared final
    • Fields excused from final modifier (with explanation):
      Field 'counter' is not final. Reason: CONFIGURATION


    • Field Detail

      • ContrastAlgorithm

        🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static final java.lang.String[] ContrastAlgorithm
        [No Description Provided by Google]
        Code:
        Exact Field Declaration Expression:
         public static final String[] ContrastAlgorithm =
     { "aa", "aaa", "apca", };

      • ColorFormat

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static final java.lang.String[] ColorFormat
        [No Description Provided by Google]
        Code:
        Exact Field Declaration Expression:
         public static final String[] ColorFormat =
     { "rgb", "hsl", "hex", };

      • InspectMode

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static final java.lang.String[] InspectMode
        [No Description Provided by Google]
        Code:
        Exact Field Declaration Expression:
         public static final String[] InspectMode =
     { 
         "searchForNode", "searchForUAShadowDOM", "captureAreaScreenshot", "showDistances", "none", 
     };

    • Method Detail

      • disable

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.String,​JsonObject,​Ret0> disable()
        Disables domain notifications.
        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 domain notifications.
        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.

      • getHighlightObjectForTest

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.String,​JsonObject,​JsonObject> getHighlightObjectForTest​
            (int nodeId,
             java.lang.Boolean includeDistance,
             java.lang.Boolean includeStyle,
             java.lang.String colorFormat,
             java.lang.Boolean showAccessibilityInfo)
        For testing.
        Parameters:
        nodeId - Id of the node to get highlight object for.
        includeDistance - Whether to include distance info.
        OPTIONAL
        includeStyle - Whether to include style info.
        OPTIONAL
        colorFormat - The color format to get config with (default: hex).
        OPTIONAL
        showAccessibilityInfo - Whether to show accessibility info (default: true).
        OPTIONAL
        Returns:
        An instance of Script<String, JsonObject, JsonObject>

        This script may be executed, using Script.exec(), and afterwards, a Promise<JsonObject, JsonObject> will be returned.

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

        This Browser Function returns

        • JsonObject (highlight)
          Highlight data for the node.

      • getGridHighlightObjectsForTest

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.String,​JsonObject,​JsonObject> getGridHighlightObjectsForTest​
            (int[] nodeIds)
        For Persistent Grid testing.
        Parameters:
        nodeIds - Ids of the node to get highlight object for.
        Returns:
        An instance of Script<String, JsonObject, JsonObject>

        This script may be executed, using Script.exec(), and afterwards, a Promise<JsonObject, JsonObject> will be returned.

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

        This Browser Function returns

        • JsonObject (highlights)
          Grid Highlight data for the node ids provided.

      • getSourceOrderHighlightObjectForTest

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.String,​JsonObject,​JsonObject> getSourceOrderHighlightObjectForTest​
            (int nodeId)
        For Source Order Viewer testing.
        Parameters:
        nodeId - Id of the node to highlight.
        Returns:
        An instance of Script<String, JsonObject, JsonObject>

        This script may be executed, using Script.exec(), and afterwards, a Promise<JsonObject, JsonObject> will be returned.

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

        This Browser Function returns

        • JsonObject (highlight)
          Source order highlight data for the node id provided.

      • hideHighlight

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.String,​JsonObject,​Ret0> hideHighlight()
        Hides any highlight.
        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.

      • highlightFrame

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.String,​JsonObject,​Ret0> highlightFrame​
            (java.lang.String frameId,
             DOM.RGBA contentColor,
             DOM.RGBA contentOutlineColor)
        Highlights owner element of the frame with given id. Deprecated: Doesn't work reliablity and cannot be fixed due to process separatation (the owner node might be in a different process). Determine the owner node in the client and use highlightNode.
        DEPRECATED
        Parameters:
        frameId - Identifier of the frame to highlight.
        contentColor - The content box highlight fill color (default: transparent).
        OPTIONAL
        contentOutlineColor - The content box highlight outline color (default: transparent).
        OPTIONAL
        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.

      • highlightNode

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.String,​JsonObject,​Ret0> highlightNode​
            (Overlay.HighlightConfig highlightConfig,
             java.lang.Integer nodeId,
             java.lang.Integer backendNodeId,
             java.lang.String objectId,
             java.lang.String selector)
        Highlights DOM node with given id or with the given JavaScript object wrapper. Either nodeId or objectId must be specified.
        Parameters:
        highlightConfig - A descriptor for the highlight appearance.
        nodeId - Identifier of the node to highlight.
        OPTIONAL
        backendNodeId - Identifier of the backend node to highlight.
        OPTIONAL
        objectId - JavaScript object id of the node to be highlighted.
        OPTIONAL
        selector - Selectors to highlight relevant nodes.
        OPTIONAL
        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.

      • highlightQuad

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.String,​JsonObject,​Ret0> highlightQuad​
            (java.lang.Number[] quad,
             DOM.RGBA color,
             DOM.RGBA outlineColor)
        Highlights given quad. Coordinates are absolute with respect to the main frame viewport.
        Parameters:
        quad - Quad to highlight
        color - The highlight fill color (default: transparent).
        OPTIONAL
        outlineColor - The highlight outline color (default: transparent).
        OPTIONAL
        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.

      • highlightRect

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.String,​JsonObject,​Ret0> highlightRect​
            (int x,
             int y,
             int width,
             int height,
             DOM.RGBA color,
             DOM.RGBA outlineColor)
        Highlights given rectangle. Coordinates are absolute with respect to the main frame viewport.
        Parameters:
        x - X coordinate
        y - Y coordinate
        width - Rectangle width
        height - Rectangle height
        color - The highlight fill color (default: transparent).
        OPTIONAL
        outlineColor - The highlight outline color (default: transparent).
        OPTIONAL
        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.

      • highlightSourceOrder

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.String,​JsonObject,​Ret0> highlightSourceOrder​
            (Overlay.SourceOrderConfig sourceOrderConfig,
             java.lang.Integer nodeId,
             java.lang.Integer backendNodeId,
             java.lang.String objectId)
        Highlights the source order of the children of the DOM node with given id or with the given JavaScript object wrapper. Either nodeId or objectId must be specified.
        Parameters:
        sourceOrderConfig - A descriptor for the appearance of the overlay drawing.
        nodeId - Identifier of the node to highlight.
        OPTIONAL
        backendNodeId - Identifier of the backend node to highlight.
        OPTIONAL
        objectId - JavaScript object id of the node to be highlighted.
        OPTIONAL
        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.

      • setInspectMode

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.String,​JsonObject,​Ret0> setInspectMode​
            (java.lang.String mode,
             Overlay.HighlightConfig highlightConfig)
        Enters the 'inspect' mode. In this mode, elements that user is hovering over are highlighted. Backend then generates 'inspectNodeRequested' event upon element selection.
        Parameters:
        mode - Set an inspection mode.
        highlightConfig - A descriptor for the highlight appearance of hovered-over nodes. May be omitted if enabled == false.
        OPTIONAL
        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.

      • setShowAdHighlights

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.String,​JsonObject,​Ret0> setShowAdHighlights​
            (boolean show)
        Highlights owner element of all frames detected to be ads.
        Parameters:
        show - True for showing ad highlights
        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.

      • setPausedInDebuggerMessage

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.String,​JsonObject,​Ret0> setPausedInDebuggerMessage​
            (java.lang.String message)
        [No Description Provided by Google]
        Parameters:
        message - The message to display, also triggers resume and step over controls.
        OPTIONAL
        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.

      • setShowDebugBorders

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.String,​JsonObject,​Ret0> setShowDebugBorders​
            (boolean show)
        Requests that backend shows debug borders on layers
        Parameters:
        show - True for showing debug borders
        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.

      • setShowFPSCounter

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.String,​JsonObject,​Ret0> setShowFPSCounter​
            (boolean show)
        Requests that backend shows the FPS counter
        Parameters:
        show - True for showing the FPS counter
        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.

      • setShowGridOverlays

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.String,​JsonObject,​Ret0> setShowGridOverlays​
            (Overlay.GridNodeHighlightConfig[] gridNodeHighlightConfigs)
        Highlight multiple elements with the CSS Grid overlay.
        Parameters:
        gridNodeHighlightConfigs - An array of node identifiers and descriptors for the highlight appearance.
        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.

      • setShowFlexOverlays

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.String,​JsonObject,​Ret0> setShowFlexOverlays​
            (Overlay.FlexNodeHighlightConfig[] flexNodeHighlightConfigs)
        [No Description Provided by Google]
        Parameters:
        flexNodeHighlightConfigs - An array of node identifiers and descriptors for the highlight appearance.
        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.

      • setShowScrollSnapOverlays

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.String,​JsonObject,​Ret0> setShowScrollSnapOverlays​
            (Overlay.ScrollSnapHighlightConfig[] scrollSnapHighlightConfigs)
        [No Description Provided by Google]
        Parameters:
        scrollSnapHighlightConfigs - An array of node identifiers and descriptors for the highlight appearance.
        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.

      • setShowPaintRects

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.String,​JsonObject,​Ret0> setShowPaintRects​
            (boolean result)
        Requests that backend shows paint rectangles
        Parameters:
        result - True for showing paint rectangles
        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.

      • setShowLayoutShiftRegions

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.String,​JsonObject,​Ret0> setShowLayoutShiftRegions​
            (boolean result)
        Requests that backend shows layout shift regions
        Parameters:
        result - True for showing layout shift regions
        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.

      • setShowScrollBottleneckRects

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.String,​JsonObject,​Ret0> setShowScrollBottleneckRects​
            (boolean show)
        Requests that backend shows scroll bottleneck rects
        Parameters:
        show - True for showing scroll bottleneck rects
        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.

      • setShowHitTestBorders

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.String,​JsonObject,​Ret0> setShowHitTestBorders​
            (boolean show)
        Requests that backend shows hit-test borders on layers
        Parameters:
        show - True for showing hit-test borders
        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.

      • setShowWebVitals

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.String,​JsonObject,​Ret0> setShowWebVitals​
            (boolean show)
        Request that backend shows an overlay with web vital metrics.
        Parameters:
        show - -
        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.

      • setShowViewportSizeOnResize

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.String,​JsonObject,​Ret0> setShowViewportSizeOnResize​
            (boolean show)
        Paints viewport size upon main frame resize.
        Parameters:
        show - Whether to paint size or not.
        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.

      • setShowHinge

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.String,​JsonObject,​Ret0> setShowHinge​
            (Overlay.HingeConfig hingeConfig)
        Add a dual screen device hinge
        Parameters:
        hingeConfig - hinge data, null means hideHinge
        OPTIONAL
        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.

      • setShowIsolatedElements

        🡅  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.String,​JsonObject,​Ret0> setShowIsolatedElements​
            (Overlay.IsolatedElementHighlightConfig[] isolatedElementHighlightConfigs)
        Show elements in isolation mode with overlays.
        Parameters:
        isolatedElementHighlightConfigs - An array of node identifiers and descriptors for the highlight appearance.
        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.