com.github.testsmith.cdt.protocol.commands.DOMSnapshot Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cdt-java-client Show documentation
Chrome DevTools java client
The newest version!
package com.github.testsmith.cdt.protocol.commands;

/*-
 * #%L
 * cdt-java-client
 * %%
 * Copyright (C) 2018 - 2024 Kenan Klisura
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */

import com.github.testsmith.cdt.protocol.support.annotations.Experimental;
import com.github.testsmith.cdt.protocol.support.annotations.Optional;
import com.github.testsmith.cdt.protocol.support.annotations.ParamName;
import com.github.testsmith.cdt.protocol.types.domsnapshot.CaptureSnapshot;
import com.github.testsmith.cdt.protocol.types.domsnapshot.Snapshot;
import java.util.List;

/**
 * This domain facilitates obtaining document snapshots with DOM, layout, and style information.
 *
 * @author roy
 * @version $Id: $Id
 */
@Experimental
public interface DOMSnapshot {

  /** Disables DOM snapshot agent for the given page. */
  void disable();

  /** Enables DOM snapshot agent for the given page. */
  void enable();

  /**
   * 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.
   *
   * @param computedStyleWhitelist Whitelist of computed styles to return.
   * @return a {@link com.github.testsmith.cdt.protocol.types.domsnapshot.Snapshot} object
   */
  @Deprecated
  Snapshot getSnapshot(@ParamName("computedStyleWhitelist") List computedStyleWhitelist);

  /**
   * 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.
   *
   * @param computedStyleWhitelist Whitelist of computed styles to return.
   * @param includeEventListeners Whether or not to retrieve details of DOM listeners (default
   *     false).
   * @param includePaintOrder Whether to determine and include the paint order index of
   *     LayoutTreeNodes (default false).
   * @param includeUserAgentShadowTree Whether to include UA shadow tree in the snapshot (default
   *     false).
   * @return a {@link com.github.testsmith.cdt.protocol.types.domsnapshot.Snapshot} object
   */
  @Deprecated
  Snapshot getSnapshot(
      @ParamName("computedStyleWhitelist") List computedStyleWhitelist,
      @Optional @ParamName("includeEventListeners") Boolean includeEventListeners,
      @Optional @ParamName("includePaintOrder") Boolean includePaintOrder,
      @Optional @ParamName("includeUserAgentShadowTree") 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.
   *
   * @param computedStyles Whitelist of computed styles to return.
   * @return a {@link com.github.testsmith.cdt.protocol.types.domsnapshot.CaptureSnapshot} object
   */
  CaptureSnapshot captureSnapshot(@ParamName("computedStyles") List 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.
   *
   * @param computedStyles Whitelist of computed styles to return.
   * @param includePaintOrder Whether to include layout object paint orders into the snapshot.
   * @param includeDOMRects Whether to include DOM rectangles (offsetRects, clientRects,
   *     scrollRects) into the snapshot
   * @param 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.
   * @param 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.
   * @return a {@link com.github.testsmith.cdt.protocol.types.domsnapshot.CaptureSnapshot} object
   */
  CaptureSnapshot captureSnapshot(
      @ParamName("computedStyles") List computedStyles,
      @Optional @ParamName("includePaintOrder") Boolean includePaintOrder,
      @Optional @ParamName("includeDOMRects") Boolean includeDOMRects,
      @Experimental @Optional @ParamName("includeBlendedBackgroundColors")
          Boolean includeBlendedBackgroundColors,
      @Experimental @Optional @ParamName("includeTextColorOpacities")
          Boolean includeTextColorOpacities);
}