Package io.webfolder.cdp.command

Interface Overlay

public interface Overlay
This domain provides various functionality related to drawing atop the inspected page

  • Method Summary

    Modifier and Type Method Description
    void disable()
    Disables domain notifications.
    void enable()
    Enables domain notifications.
    void hideHighlight()
    Hides any highlight.
    void highlightFrame​(java.lang.String frameId)
    Highlights owner element of the frame with given id.
    void highlightFrame​(java.lang.String frameId, RGBA contentColor, RGBA contentOutlineColor)
    Highlights owner element of the frame with given id.
    void highlightNode​(HighlightConfig highlightConfig)
    Highlights DOM node with given id or with the given JavaScript object wrapper.
    void highlightNode​(HighlightConfig highlightConfig, java.lang.Integer nodeId, java.lang.Integer backendNodeId, java.lang.String objectId)
    Highlights DOM node with given id or with the given JavaScript object wrapper.
    void highlightQuad​(java.util.List<java.lang.Double> quad)
    Highlights given quad.
    void highlightQuad​(java.util.List<java.lang.Double> quad, RGBA color, RGBA outlineColor)
    Highlights given quad.
    void highlightRect​(java.lang.Integer x, java.lang.Integer y, java.lang.Integer width, java.lang.Integer height)
    Highlights given rectangle.
    void highlightRect​(java.lang.Integer x, java.lang.Integer y, java.lang.Integer width, java.lang.Integer height, RGBA color, RGBA outlineColor)
    Highlights given rectangle.
    void setInspectMode​(InspectMode mode)
    Enters the 'inspect' mode.
    void setInspectMode​(InspectMode mode, HighlightConfig highlightConfig)
    Enters the 'inspect' mode.
    void setPausedInDebuggerMessage()  
    void setPausedInDebuggerMessage​(java.lang.String message)  
    void setShowDebugBorders​(java.lang.Boolean show)
    Requests that backend shows debug borders on layers
    void setShowFPSCounter​(java.lang.Boolean show)
    Requests that backend shows the FPS counter
    void setShowHitTestBorders​(java.lang.Boolean show)
    Requests that backend shows hit-test borders on layers
    void setShowPaintRects​(java.lang.Boolean result)
    Requests that backend shows paint rectangles
    void setShowScrollBottleneckRects​(java.lang.Boolean show)
    Requests that backend shows scroll bottleneck rects
    void setShowViewportSizeOnResize​(java.lang.Boolean show)
    Paints viewport size upon main frame resize.
    void setSuspended​(java.lang.Boolean suspended)  

  • Method Details

    • disable

      void disable()
      Disables domain notifications.

    • enable

      void enable()
      Enables domain notifications.

    • hideHighlight

      void hideHighlight()
      Hides any highlight.

    • highlightFrame

      void highlightFrame​(java.lang.String frameId, RGBA contentColor, RGBA contentOutlineColor)
      Highlights owner element of the frame with given id.
      Parameters:
      frameId - Identifier of the frame to highlight.
      contentColor - The content box highlight fill color (default: transparent).
      contentOutlineColor - The content box highlight outline color (default: transparent).

    • highlightNode

      void highlightNode​(HighlightConfig highlightConfig, java.lang.Integer nodeId, java.lang.Integer backendNodeId, java.lang.String objectId)
      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.
      backendNodeId - Identifier of the backend node to highlight.
      objectId - JavaScript object id of the node to be highlighted.

    • highlightQuad

      void highlightQuad​(java.util.List<java.lang.Double> quad, RGBA color, 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).
      outlineColor - The highlight outline color (default: transparent).

    • highlightRect

      void highlightRect​(java.lang.Integer x, java.lang.Integer y, java.lang.Integer width, java.lang.Integer height, RGBA color, 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).
      outlineColor - The highlight outline color (default: transparent).

    • setInspectMode

      void setInspectMode​(InspectMode mode, 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.

    • setPausedInDebuggerMessage

      void setPausedInDebuggerMessage​(java.lang.String message)

    • setShowDebugBorders

      void setShowDebugBorders​(java.lang.Boolean show)
      Requests that backend shows debug borders on layers
      Parameters:
      show - True for showing debug borders

    • setShowFPSCounter

      void setShowFPSCounter​(java.lang.Boolean show)
      Requests that backend shows the FPS counter
      Parameters:
      show - True for showing the FPS counter

    • setShowPaintRects

      void setShowPaintRects​(java.lang.Boolean result)
      Requests that backend shows paint rectangles
      Parameters:
      result - True for showing paint rectangles

    • setShowScrollBottleneckRects

      void setShowScrollBottleneckRects​(java.lang.Boolean show)
      Requests that backend shows scroll bottleneck rects
      Parameters:
      show - True for showing scroll bottleneck rects

    • setShowHitTestBorders

      void setShowHitTestBorders​(java.lang.Boolean show)
      Requests that backend shows hit-test borders on layers
      Parameters:
      show - True for showing hit-test borders

    • setShowViewportSizeOnResize

      void setShowViewportSizeOnResize​(java.lang.Boolean show)
      Paints viewport size upon main frame resize.
      Parameters:
      show - Whether to paint size or not.

    • setSuspended

      void setSuspended​(java.lang.Boolean suspended)

    • highlightFrame

      void highlightFrame​(java.lang.String frameId)
      Highlights owner element of the frame with given id.
      Parameters:
      frameId - Identifier of the frame to highlight.

    • highlightNode

      void highlightNode​(HighlightConfig highlightConfig)
      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.

    • highlightQuad

      void highlightQuad​(java.util.List<java.lang.Double> quad)
      Highlights given quad. Coordinates are absolute with respect to the main frame viewport.
      Parameters:
      quad - Quad to highlight

    • highlightRect

      void highlightRect​(java.lang.Integer x, java.lang.Integer y, java.lang.Integer width, java.lang.Integer height)
      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

    • setInspectMode

      void setInspectMode​(InspectMode mode)
      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.

    • setPausedInDebuggerMessage

      void setPausedInDebuggerMessage()