com.qeagle.devtools.protocol.commands

Interface Overlay

public interface Overlay

This domain provides various functionality related to drawing atop the inspected page.

Method Summary

Modifier and Type	Method and Description
void	disable() Disables domain notifications.
void	enable() Enables domain notifications.
Map<String,Object>	getHighlightObjectForTest(Integer nodeId) For testing.
Map<String,Object>	getHighlightObjectForTest(Integer nodeId, Boolean includeDistance, Boolean includeStyle) For testing.
void	hideHighlight() Hides any highlight.
void	highlightFrame(String frameId) Highlights owner element of the frame with given id.
void	highlightFrame(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, Integer nodeId, Integer backendNodeId, String objectId, String selector) Highlights DOM node with given id or with the given JavaScript object wrapper.
void	highlightQuad(List<Double> quad) Highlights given quad.
void	highlightQuad(List<Double> quad, RGBA color, RGBA outlineColor) Highlights given quad.
void	highlightRect(Integer x, Integer y, Integer width, Integer height) Highlights given rectangle.
void	highlightRect(Integer x, Integer y, Integer width, Integer height, RGBA color, RGBA outlineColor) Highlights given rectangle.
EventListener	onInspectModeCanceled(EventHandler<InspectModeCanceled> eventListener) Fired when user cancels the inspect mode.
EventListener	onInspectNodeRequested(EventHandler<InspectNodeRequested> eventListener) Fired when the node should be inspected.
EventListener	onNodeHighlightRequested(EventHandler<NodeHighlightRequested> eventListener) Fired when the node should be highlighted.
EventListener	onScreenshotRequested(EventHandler<ScreenshotRequested> eventListener) Fired when user asks to capture screenshot of some area on the page.
void	setInspectMode(InspectMode mode) Enters the 'inspect' mode.
void	setInspectMode(InspectMode mode, HighlightConfig highlightConfig) Enters the 'inspect' mode.
void	setPausedInDebuggerMessage()
void	setPausedInDebuggerMessage(String message)
void	setShowAdHighlights(Boolean show) Highlights owner element of all frames detected to be ads.
void	setShowDebugBorders(Boolean show) Requests that backend shows debug borders on layers
void	setShowFPSCounter(Boolean show) Requests that backend shows the FPS counter
void	setShowHitTestBorders(Boolean show) Requests that backend shows hit-test borders on layers
void	setShowLayoutShiftRegions(Boolean result) Requests that backend shows layout shift regions
void	setShowPaintRects(Boolean result) Requests that backend shows paint rectangles
void	setShowScrollBottleneckRects(Boolean show) Requests that backend shows scroll bottleneck rects
void	setShowViewportSizeOnResize(Boolean show) Paints viewport size upon main frame resize.

Method Detail

disable

void disable()

Disables domain notifications.

enable

void enable()

Enables domain notifications.

getHighlightObjectForTest

Map<String,Object> getHighlightObjectForTest(Integer nodeId)

For testing.

Parameters:

nodeId - Id of the node to get highlight object for.

getHighlightObjectForTest

Map<String,Object> getHighlightObjectForTest(Integer nodeId,
                                             Boolean includeDistance,
                                             Boolean includeStyle)

For testing.

Parameters:

nodeId - Id of the node to get highlight object for.

includeDistance - Whether to include distance info.

includeStyle - Whether to include style info.

hideHighlight

void hideHighlight()

Hides any highlight.

highlightFrame

void highlightFrame(String frameId)

Highlights owner element of the frame with given id.

Parameters:

frameId - Identifier of the frame to highlight.

highlightFrame

void highlightFrame(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)

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.

highlightNode

void highlightNode(HighlightConfig highlightConfig,
                   Integer nodeId,
                   Integer backendNodeId,
                   String objectId,
                   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.

backendNodeId - Identifier of the backend node to highlight.

objectId - JavaScript object id of the node to be highlighted.

selector - Selectors to highlight relevant nodes.

highlightQuad

void highlightQuad(List<Double> quad)

Highlights given quad. Coordinates are absolute with respect to the main frame viewport.

Parameters:

quad - Quad to highlight

highlightQuad

void highlightQuad(List<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(Integer x,
                   Integer y,
                   Integer width,
                   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

highlightRect

void highlightRect(Integer x,
                   Integer y,
                   Integer width,
                   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)

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.

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

setShowAdHighlights

void setShowAdHighlights(Boolean show)

Highlights owner element of all frames detected to be ads.

Parameters:

show - True for showing ad highlights

setPausedInDebuggerMessage

void setPausedInDebuggerMessage()

setPausedInDebuggerMessage

void setPausedInDebuggerMessage(String message)

Parameters:

message - The message to display, also triggers resume and step over controls.

setShowDebugBorders

void setShowDebugBorders(Boolean show)

Requests that backend shows debug borders on layers

Parameters:

show - True for showing debug borders

setShowFPSCounter

void setShowFPSCounter(Boolean show)

Requests that backend shows the FPS counter

Parameters:

show - True for showing the FPS counter

setShowPaintRects

void setShowPaintRects(Boolean result)

Requests that backend shows paint rectangles

Parameters:

result - True for showing paint rectangles

setShowLayoutShiftRegions

void setShowLayoutShiftRegions(Boolean result)

Requests that backend shows layout shift regions

Parameters:

result - True for showing layout shift regions

setShowScrollBottleneckRects

void setShowScrollBottleneckRects(Boolean show)

Requests that backend shows scroll bottleneck rects

Parameters:

show - True for showing scroll bottleneck rects

setShowHitTestBorders

void setShowHitTestBorders(Boolean show)

Requests that backend shows hit-test borders on layers

Parameters:

show - True for showing hit-test borders

setShowViewportSizeOnResize

void setShowViewportSizeOnResize(Boolean show)

Paints viewport size upon main frame resize.

Parameters:

show - Whether to paint size or not.

onInspectNodeRequested

EventListener onInspectNodeRequested(EventHandler<InspectNodeRequested> eventListener)

Fired when the node should be inspected. This happens after call to `setInspectMode` or when user manually inspects an element.

onNodeHighlightRequested

EventListener onNodeHighlightRequested(EventHandler<NodeHighlightRequested> eventListener)

Fired when the node should be highlighted. This happens after call to `setInspectMode`.

onScreenshotRequested

EventListener onScreenshotRequested(EventHandler<ScreenshotRequested> eventListener)

Fired when user asks to capture screenshot of some area on the page.

onInspectModeCanceled

EventListener onInspectModeCanceled(EventHandler<InspectModeCanceled> eventListener)

Fired when user cancels the inspect mode.