com.github.kklisura.cdt.protocol.commands

Interface Accessibility

public interface Accessibility

Method Summary

Modifier and Type	Method and Description
void	disable() Disables the accessibility domain.
void	enable() Enables the accessibility domain which causes `AXNodeId`s to remain consistent between method calls.
List<AXNode>	getChildAXNodes(String id) Fetches a particular accessibility node by AXNodeId.
List<AXNode>	getFullAXTree() Fetches the entire accessibility tree for the root Document
List<AXNode>	getFullAXTree(Integer max_depth) Fetches the entire accessibility tree for the root Document
List<AXNode>	getPartialAXTree() Fetches the accessibility node and partial accessibility tree for this DOM node, if it exists.
List<AXNode>	getPartialAXTree(Integer nodeId, Integer backendNodeId, String objectId, Boolean fetchRelatives) Fetches the accessibility node and partial accessibility tree for this DOM node, if it exists.
List<AXNode>	queryAXTree() Query a DOM node's accessibility subtree for accessible name and role.
List<AXNode>	queryAXTree(Integer nodeId, Integer backendNodeId, String objectId, String accessibleName, String role) Query a DOM node's accessibility subtree for accessible name and role.

Method Detail

disable

void disable()

Disables the accessibility domain.

enable

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

List<AXNode> getPartialAXTree()

Fetches the accessibility node and partial accessibility tree for this DOM node, if it exists.

getPartialAXTree

List<AXNode> getPartialAXTree(Integer nodeId,
                              Integer backendNodeId,
                              String objectId,
                              Boolean fetchRelatives)

Fetches the accessibility node and partial accessibility tree for this DOM node, if it exists.

Parameters:

nodeId - Identifier of the node to get the partial accessibility tree for.

backendNodeId - Identifier of the backend node to get the partial accessibility tree for.

objectId - JavaScript object id of the node wrapper to get the partial accessibility tree for.

fetchRelatives - Whether to fetch this nodes ancestors, siblings and children. Defaults to true.

getFullAXTree

List<AXNode> getFullAXTree()

Fetches the entire accessibility tree for the root Document

getFullAXTree

List<AXNode> getFullAXTree(Integer max_depth)

Fetches the entire accessibility tree for the root Document

Parameters:

max_depth - The maximum depth at which descendants of the root node should be retrieved. If omitted, the full tree is returned.

getChildAXNodes

List<AXNode> getChildAXNodes(String id)

Fetches a particular accessibility node by AXNodeId. Requires `enable()` to have been called previously.

Parameters:

id -

queryAXTree

List<AXNode> queryAXTree()

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.

queryAXTree

List<AXNode> queryAXTree(Integer nodeId,
                         Integer backendNodeId,
                         String objectId,
                         String accessibleName,
                         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.

Parameters:

nodeId - Identifier of the node for the root to query.

backendNodeId - Identifier of the backend node for the root to query.

objectId - JavaScript object id of the node wrapper for the root to query.

accessibleName - Find nodes with this computed name.

role - Find nodes with this computed role.