Package org.openqa.selenium.devtools.v101.accessibility

Class Accessibility

  • @Beta
public class Accessibility
extends java.lang.Object

    • Constructor Summary

      Constructors 
      Constructor Description
      Accessibility()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static org.openqa.selenium.devtools.Command<java.lang.Void> disable()
      Disables the accessibility domain.
      static org.openqa.selenium.devtools.Command<java.lang.Void> enable()
      Enables the accessibility domain which causes `AXNodeId`s to remain consistent between method calls.
      static org.openqa.selenium.devtools.Command<java.util.List<AXNode>> getAXNodeAndAncestors​(java.util.Optional<NodeId> nodeId, java.util.Optional<BackendNodeId> backendNodeId, java.util.Optional<RemoteObjectId> objectId)
      Fetches a node and all ancestors up to and including the root.
      static org.openqa.selenium.devtools.Command<java.util.List<AXNode>> getChildAXNodes​(AXNodeId id, java.util.Optional<FrameId> frameId)
      Fetches a particular accessibility node by AXNodeId.
      static org.openqa.selenium.devtools.Command<java.util.List<AXNode>> getFullAXTree​(java.util.Optional<java.lang.Integer> depth, java.util.Optional<FrameId> frameId)
      Fetches the entire accessibility tree for the root Document
      static org.openqa.selenium.devtools.Command<java.util.List<AXNode>> getPartialAXTree​(java.util.Optional<NodeId> nodeId, java.util.Optional<BackendNodeId> backendNodeId, java.util.Optional<RemoteObjectId> objectId, java.util.Optional<java.lang.Boolean> fetchRelatives)
      Fetches the accessibility node and partial accessibility tree for this DOM node, if it exists.
      static org.openqa.selenium.devtools.Command<AXNode> getRootAXNode​(java.util.Optional<FrameId> frameId)
      Fetches the root node.
      static org.openqa.selenium.devtools.Event<AXNode> loadComplete()  
      static org.openqa.selenium.devtools.Event<java.util.List<AXNode>> nodesUpdated()  
      static org.openqa.selenium.devtools.Command<java.util.List<AXNode>> queryAXTree​(java.util.Optional<NodeId> nodeId, java.util.Optional<BackendNodeId> backendNodeId, java.util.Optional<RemoteObjectId> objectId, java.util.Optional<java.lang.String> accessibleName, java.util.Optional<java.lang.String> role)
      Query a DOM node's accessibility subtree for accessible name and role.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Accessibility

        public Accessibility()

    • Method Detail

      • disable

        public static org.openqa.selenium.devtools.Command<java.lang.Void> disable()
        Disables the accessibility domain.

      • enable

        public static org.openqa.selenium.devtools.Command<java.lang.Void> enable()
        Enables the accessibility domain which causes `AXNodeId`s to remain consistent between method calls. This turns on accessibility for the page, which can impact performance until accessibility is disabled.

      • getPartialAXTree

        @Beta
public static org.openqa.selenium.devtools.Command<java.util.List<AXNode>> getPartialAXTree​(java.util.Optional<NodeId> nodeId,
                                                                                            java.util.Optional<BackendNodeId> backendNodeId,
                                                                                            java.util.Optional<RemoteObjectId> objectId,
                                                                                            java.util.Optional<java.lang.Boolean> fetchRelatives)
        Fetches the accessibility node and partial accessibility tree for this DOM node, if it exists.

      • getFullAXTree

        @Beta
public static org.openqa.selenium.devtools.Command<java.util.List<AXNode>> getFullAXTree​(java.util.Optional<java.lang.Integer> depth,
                                                                                         java.util.Optional<FrameId> frameId)
        Fetches the entire accessibility tree for the root Document

      • getRootAXNode

        @Beta
public static org.openqa.selenium.devtools.Command<AXNode> getRootAXNode​(java.util.Optional<FrameId> frameId)
        Fetches the root node. Requires `enable()` to have been called previously.

      • getAXNodeAndAncestors

        @Beta
public static org.openqa.selenium.devtools.Command<java.util.List<AXNode>> getAXNodeAndAncestors​(java.util.Optional<NodeId> nodeId,
                                                                                                 java.util.Optional<BackendNodeId> backendNodeId,
                                                                                                 java.util.Optional<RemoteObjectId> objectId)
        Fetches a node and all ancestors up to and including the root. Requires `enable()` to have been called previously.

      • getChildAXNodes

        @Beta
public static org.openqa.selenium.devtools.Command<java.util.List<AXNode>> getChildAXNodes​(AXNodeId id,
                                                                                           java.util.Optional<FrameId> frameId)
        Fetches a particular accessibility node by AXNodeId. Requires `enable()` to have been called previously.

      • queryAXTree

        @Beta
public static org.openqa.selenium.devtools.Command<java.util.List<AXNode>> queryAXTree​(java.util.Optional<NodeId> nodeId,
                                                                                       java.util.Optional<BackendNodeId> backendNodeId,
                                                                                       java.util.Optional<RemoteObjectId> objectId,
                                                                                       java.util.Optional<java.lang.String> accessibleName,
                                                                                       java.util.Optional<java.lang.String> role)
        Query a DOM node's accessibility subtree for accessible name and role. This command computes the name and role for all nodes in the subtree, including those that are ignored for accessibility, and returns those that mactch the specified name and role. If no DOM node is specified, or the DOM node does not exist, the command returns an error. If neither `accessibleName` or `role` is specified, it returns all the accessibility nodes in the subtree.

      • loadComplete

        public static org.openqa.selenium.devtools.Event<AXNode> loadComplete()

      • nodesUpdated

        public static org.openqa.selenium.devtools.Event<java.util.List<AXNode>> nodesUpdated()