Class Accessibility

  • public class Accessibility
extends java.lang.Object
    Class created by Automatic Code-Generator.
    This class was built using the Chrome Remote Dev-Tools A.P.I., which is specified by two JSON-RPC Files. These files were obtained from the Chrome Dev Tools Protocol Git Hub Page, which has a "Tip of Tree" (the latest) API-Specification Page Here: JSON-RPC Protocol Specification.

    JSON-Viewable Google-API:
    These files may be viewed here: browser_protocol.json and js_protocol.json.
    These files were converted into this Java-Browser (CDT) Library; they are a Java-Alternative to the Node.js implementation.

    HTML-Viewable API:
    In addition to this Class-Library, these files were also converted to a simple HTML Page, which may be browsed here: Browser API Web-Page

    Node.js RDP-API Implementation:
    You may read about the Node.js Chrome Remote Interface on the Node.js Package Manager Web-Site: NPM
    [No Description Provided by Google]

    This class is intended to be used with a Headless Browser

    These methods have been tested, to some degree, using Google Chrome. In order to use this class you must start a web-browser instance and make a connection to the browser using a Remote Debugging Port. The initializations may be accomplished using class BRDPC (Browser Remote Debug Protocol Connection).

    Google-Chrome was used during the development process of the classes in this particular package. Note that, lately, it has been asserted Microsoft has switched to using the Chrome-Engine for its Microsoft Edge Browser Internal Code-Base. Therefore, there may limited support / functionality when running the methods in this class with Microsoft-Edge. There is the possibility these will work with Opera & Safari.

    Check whether the your Web-Browser will allow itself to be driven by the Web-Socket RDP-Port 9223.

    Foreign Function API:
    Every one of the methods that reside in this class are designed to do nothing more than:

    1. Accept Parameters from the User, and "Marshall Them" into a Valid JSON-Request
    2. Transmit the Marshalled Request-JSON to a Headless Web-Browser over a Web-Socket RDP Connection
    3. Receive BOTH that Method's Results AND any Browser Event-Firings from the Web-Socket
    4. Parse JSON Method-Results and Browser-Event Firings, and Subsequently Convert them to Standard Java-Types
    5. Report these Method-Results and Browser-Events to the User via an User-Registered Event-Listener or a Promise Object


    Java-HTML Difference:
    Unlike the bulk of the Java HTML JAR Library, there is very little native Java-Code, and very little testing that may be done on any of the classes & methods in this package. The code inside these classes does nothing more than marshall-and-unmarshall Java-Types into Json-Requests (and vice-versa). The Java-Script & Browser modules inside of a Google-Chrome instance are, theoretically, handling these requests, and returning their results (or events) over the Web-Socket Connection.

    It has been asserted (by Google Chrome Developers) that some of these methods are only "partially working" or "experimental".



    Stateless Class:
    This class neither contains any program-state, nor can it be instantiated. The @StaticFunctional Annotation may also be called 'The Spaghetti Report'. Static-Functional classes are, essentially, C-Styled Files, without any constructors or non-static member fields. It is a concept very similar to the Java-Bean's @Stateless Annotation.

    • 1 Constructor(s), 1 declared private, zero-argument constructor
    • 6 Method(s), 6 declared static
    • 9 Field(s), 9 declared static, 8 declared final
    • Fields excused from final modifier (with explanation):
      Field 'counter' is not final. Reason: CONFIGURATION


    • Field Summary

       
      Accessibility Domain Enumerated String Types
      Modifier and Type Field
      static String[] AXPropertyName
      Values of AXProperty name: - from 'busy' to 'roledescription': states which apply to every AX node - from 'live' to 'root': attributes which apply to nodes in live regions - from 'autocomplete' to 'valuetext': attributes which apply to widgets - from 'checked' to 'selected': states which apply to widgets - from 'activedescendant' to 'owns' - relationships between elements other than parent/child/sibling.
      static String[] AXValueNativeSourceType
      Enum of possible native property sources (as a subtype of a particular AXValueSourceType).
      static String[] AXValueSourceType
      Enum of possible property sources.
      static String[] AXValueType
      Enum of possible property types.

    • Method Summary

       
      Accessibility Domain Commands
      Script Returns Modifier and Type Method
      NONE (void) static Script<> disable()
      Disables the accessibility domain.
      NONE (void) static Script<> enable()
      Enables the accessibility domain which causes AXNodeIds to remain consistent between method calls.
      Accessibility.AXNode[] static Script<> getChildAXNodes​(String id, String frameId)
      Fetches a particular accessibility node by AXNodeId.
      Accessibility.AXNode[] static Script<> getFullAXTree​(Integer depth, Integer max_depth, String frameId)
      Fetches the entire accessibility tree for the root Document
      EXPERIMENTAL
      Accessibility.AXNode[] static Script<> getPartialAXTree​(Integer nodeId, Integer backendNodeId, String objectId, Boolean fetchRelatives)
      Fetches the accessibility node and partial accessibility tree for this DOM node, if it exists.
      Accessibility.AXNode[] static Script<> queryAXTree​(Integer nodeId, Integer backendNodeId, String objectId, String accessibleName, 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

    • Field Detail

      • AXPropertyName

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static final java.lang.String[] AXPropertyName
        Values of AXProperty name: - from 'busy' to 'roledescription': states which apply to every AX node - from 'live' to 'root': attributes which apply to nodes in live regions - from 'autocomplete' to 'valuetext': attributes which apply to widgets - from 'checked' to 'selected': states which apply to widgets - from 'activedescendant' to 'owns' - relationships between elements other than parent/child/sibling.

    • Method Detail

      • disable

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.String,​JsonObject,​Ret0> disable()
        Disables the accessibility domain.
        Returns:
        An instance of Script<String, JsonObject, Ret0>

        This Script instance must be executed before the browser receives the invocation-request.

        This Browser-Function does not have a return-value. You may choose to await the Promise<JsonObject, Ret0 > to ensure the Browser Function has run to completion.

      • enable

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.String,​JsonObject,​Ret0> enable()
        Enables the accessibility domain which causes AXNodeIds to remain consistent between method calls. This turns on accessibility for the page, which can impact performance until accessibility is disabled.
        Returns:
        An instance of Script<String, JsonObject, Ret0>

        This Script instance must be executed before the browser receives the invocation-request.

        This Browser-Function does not have a return-value. You may choose to await the Promise<JsonObject, Ret0 > to ensure the Browser Function has run to completion.

      • getPartialAXTree

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.String,​JsonObject,​Accessibility.AXNode[]> getPartialAXTree​
            (java.lang.Integer nodeId,
             java.lang.Integer backendNodeId,
             java.lang.String objectId,
             java.lang.Boolean fetchRelatives)
        Fetches the accessibility node and partial accessibility tree for this DOM node, if it exists.
        EXPERIMENTAL
        Parameters:
        nodeId - Identifier of the node to get the partial accessibility tree for.
        OPTIONAL
        backendNodeId - Identifier of the backend node to get the partial accessibility tree for.
        OPTIONAL
        objectId - JavaScript object id of the node wrapper to get the partial accessibility tree for.
        OPTIONAL
        fetchRelatives - Whether to fetch this nodes ancestors, siblings and children. Defaults to true.
        OPTIONAL
        Returns:
        An instance of Script<String, JsonObject, Accessibility.AXNode[]>

        This script may be executed, using Script.exec(), and afterwards, a Promise<JsonObject, Accessibility.AXNode[]> will be returned.

        Finally, the Promise may be awaited, using Promise.await(), and the returned result of this Browser Function may may be retrieved.

        This Browser Function returns

        • Accessibility.AXNode[] (nodes)
          The Accessibility.AXNode for this DOM node, if it exists, plus its ancestors, siblings and children, if requested.

      • getFullAXTree

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.String,​JsonObject,​Accessibility.AXNode[]> getFullAXTree​
            (java.lang.Integer depth,
             java.lang.Integer max_depth,
             java.lang.String frameId)
        Fetches the entire accessibility tree for the root Document
        EXPERIMENTAL
        Parameters:
        depth - The maximum depth at which descendants of the root node should be retrieved. If omitted, the full tree is returned.
        OPTIONAL
        max_depth - Deprecated. This parameter has been renamed to depth. If depth is not provided, max_depth will be used.
        OPTIONAL
        DEPRECATED
        frameId - The frame for whose document the AX tree should be retrieved. If omited, the root frame is used.
        OPTIONAL
        Returns:
        An instance of Script<String, JsonObject, Accessibility.AXNode[]>

        This script may be executed, using Script.exec(), and afterwards, a Promise<JsonObject, Accessibility.AXNode[]> will be returned.

        Finally, the Promise may be awaited, using Promise.await(), and the returned result of this Browser Function may may be retrieved.

        This Browser Function returns

      • queryAXTree

        🡅  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.String,​JsonObject,​Accessibility.AXNode[]> queryAXTree​
            (java.lang.Integer nodeId,
             java.lang.Integer backendNodeId,
             java.lang.String objectId,
             java.lang.String accessibleName,
             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.
        EXPERIMENTAL
        Parameters:
        nodeId - Identifier of the node for the root to query.
        OPTIONAL
        backendNodeId - Identifier of the backend node for the root to query.
        OPTIONAL
        objectId - JavaScript object id of the node wrapper for the root to query.
        OPTIONAL
        accessibleName - Find nodes with this computed name.
        OPTIONAL
        role - Find nodes with this computed role.
        OPTIONAL
        Returns:
        An instance of Script<String, JsonObject, Accessibility.AXNode[]>

        This script may be executed, using Script.exec(), and afterwards, a Promise<JsonObject, Accessibility.AXNode[]> will be returned.

        Finally, the Promise may be awaited, using Promise.await(), and the returned result of this Browser Function may may be retrieved.

        This Browser Function returns

        • Accessibility.AXNode[] (nodes)
          A list of Accessibility.AXNode matching the specified attributes, including nodes that are ignored for accessibility.