org.openqa.selenium.devtools.v123.domsnapshot.DOMSnapshot Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of selenium-devtools-v123 Show documentation
Show all versions of selenium-devtools-v123 Show documentation
Selenium automates browsers. That's it! What you do with that power is entirely up to you.
package org.openqa.selenium.devtools.v123.domsnapshot;
import org.openqa.selenium.Beta;
import org.openqa.selenium.devtools.Command;
import org.openqa.selenium.devtools.Event;
import org.openqa.selenium.devtools.ConverterFunctions;
import java.util.Map;
import java.util.LinkedHashMap;
import org.openqa.selenium.json.JsonInput;
/**
* This domain facilitates obtaining document snapshots with DOM, layout, and style information.
*/
@Beta()
public class DOMSnapshot {
/**
* Disables DOM snapshot agent for the given page.
*/
public static Command disable() {
LinkedHashMap params = new LinkedHashMap<>();
return new Command<>("DOMSnapshot.disable", Map.copyOf(params));
}
/**
* Enables DOM snapshot agent for the given page.
*/
public static Command enable() {
LinkedHashMap params = new LinkedHashMap<>();
return new Command<>("DOMSnapshot.enable", Map.copyOf(params));
}
public static class GetSnapshotResponse {
private final java.util.List domNodes;
private final java.util.List layoutTreeNodes;
private final java.util.List computedStyles;
public GetSnapshotResponse(java.util.List domNodes, java.util.List layoutTreeNodes, java.util.List computedStyles) {
this.domNodes = java.util.Objects.requireNonNull(domNodes, "domNodes is required");
this.layoutTreeNodes = java.util.Objects.requireNonNull(layoutTreeNodes, "layoutTreeNodes is required");
this.computedStyles = java.util.Objects.requireNonNull(computedStyles, "computedStyles is required");
}
/**
* The nodes in the DOM tree. The DOMNode at index 0 corresponds to the root document.
*/
public java.util.List getDomNodes() {
return domNodes;
}
/**
* The nodes in the layout tree.
*/
public java.util.List getLayoutTreeNodes() {
return layoutTreeNodes;
}
/**
* Whitelisted ComputedStyle properties for each node in the layout tree.
*/
public java.util.List getComputedStyles() {
return computedStyles;
}
private static GetSnapshotResponse fromJson(JsonInput input) {
java.util.List domNodes = null;
java.util.List layoutTreeNodes = null;
java.util.List computedStyles = null;
input.beginObject();
while (input.hasNext()) {
switch(input.nextName()) {
case "domNodes":
domNodes = input.readArray(org.openqa.selenium.devtools.v123.domsnapshot.model.DOMNode.class);
break;
case "layoutTreeNodes":
layoutTreeNodes = input.readArray(org.openqa.selenium.devtools.v123.domsnapshot.model.LayoutTreeNode.class);
break;
case "computedStyles":
computedStyles = input.readArray(org.openqa.selenium.devtools.v123.domsnapshot.model.ComputedStyle.class);
break;
default:
input.skipValue();
break;
}
}
input.endObject();
return new GetSnapshotResponse(domNodes, layoutTreeNodes, computedStyles);
}
}
/**
* 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()
public static Command getSnapshot(java.util.List computedStyleWhitelist, java.util.Optional includeEventListeners, java.util.Optional includePaintOrder, java.util.Optional includeUserAgentShadowTree) {
java.util.Objects.requireNonNull(computedStyleWhitelist, "computedStyleWhitelist is required");
LinkedHashMap params = new LinkedHashMap<>();
params.put("computedStyleWhitelist", computedStyleWhitelist);
includeEventListeners.ifPresent(p -> params.put("includeEventListeners", p));
includePaintOrder.ifPresent(p -> params.put("includePaintOrder", p));
includeUserAgentShadowTree.ifPresent(p -> params.put("includeUserAgentShadowTree", p));
return new Command<>("DOMSnapshot.getSnapshot", Map.copyOf(params), input -> input.read(org.openqa.selenium.devtools.v123.domsnapshot.DOMSnapshot.GetSnapshotResponse.class));
}
public static class CaptureSnapshotResponse {
private final java.util.List documents;
private final java.util.List strings;
public CaptureSnapshotResponse(java.util.List documents, java.util.List strings) {
this.documents = java.util.Objects.requireNonNull(documents, "documents is required");
this.strings = java.util.Objects.requireNonNull(strings, "strings is required");
}
/**
* The nodes in the DOM tree. The DOMNode at index 0 corresponds to the root document.
*/
public java.util.List getDocuments() {
return documents;
}
/**
* Shared string table that all string properties refer to with indexes.
*/
public java.util.List getStrings() {
return strings;
}
private static CaptureSnapshotResponse fromJson(JsonInput input) {
java.util.List documents = null;
java.util.List strings = null;
input.beginObject();
while (input.hasNext()) {
switch(input.nextName()) {
case "documents":
documents = input.readArray(org.openqa.selenium.devtools.v123.domsnapshot.model.DocumentSnapshot.class);
break;
case "strings":
strings = input.readArray(java.lang.String.class);
break;
default:
input.skipValue();
break;
}
}
input.endObject();
return new CaptureSnapshotResponse(documents, strings);
}
}
/**
* 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.
*/
public static Command captureSnapshot(java.util.List computedStyles, java.util.Optional includePaintOrder, java.util.Optional includeDOMRects, java.util.Optional includeBlendedBackgroundColors, java.util.Optional includeTextColorOpacities) {
java.util.Objects.requireNonNull(computedStyles, "computedStyles is required");
LinkedHashMap params = new LinkedHashMap<>();
params.put("computedStyles", computedStyles);
includePaintOrder.ifPresent(p -> params.put("includePaintOrder", p));
includeDOMRects.ifPresent(p -> params.put("includeDOMRects", p));
includeBlendedBackgroundColors.ifPresent(p -> params.put("includeBlendedBackgroundColors", p));
includeTextColorOpacities.ifPresent(p -> params.put("includeTextColorOpacities", p));
return new Command<>("DOMSnapshot.captureSnapshot", Map.copyOf(params), input -> input.read(org.openqa.selenium.devtools.v123.domsnapshot.DOMSnapshot.CaptureSnapshotResponse.class));
}
}