123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215 |
- "use strict";
- Object.defineProperty(exports, "__esModule", {
- value: true
- });
- exports.getAccessibilityTree = getAccessibilityTree;
- /**
- * Copyright 2018 Google Inc. All rights reserved.
- * Modifications copyright (c) Microsoft Corporation.
- *
- * 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.
- */
- async function getAccessibilityTree(session, needle) {
- const objectId = needle ? needle._objectId : undefined;
- const {
- tree
- } = await session.send('Accessibility.getFullAXTree', {
- objectId
- });
- const axNode = new FFAXNode(tree);
- return {
- tree: axNode,
- needle: needle ? axNode._findNeedle() : null
- };
- }
- const FFRoleToARIARole = new Map(Object.entries({
- 'pushbutton': 'button',
- 'checkbutton': 'checkbox',
- 'editcombobox': 'combobox',
- 'content deletion': 'deletion',
- 'footnote': 'doc-footnote',
- 'non-native document': 'document',
- 'grouping': 'group',
- 'graphic': 'img',
- 'content insertion': 'insertion',
- 'animation': 'marquee',
- 'flat equation': 'math',
- 'menupopup': 'menu',
- 'check menu item': 'menuitemcheckbox',
- 'radio menu item': 'menuitemradio',
- 'listbox option': 'option',
- 'radiobutton': 'radio',
- 'statusbar': 'status',
- 'pagetab': 'tab',
- 'pagetablist': 'tablist',
- 'propertypage': 'tabpanel',
- 'entry': 'textbox',
- 'outline': 'tree',
- 'tree table': 'treegrid',
- 'outlineitem': 'treeitem'
- }));
- class FFAXNode {
- constructor(payload) {
- this._children = void 0;
- this._payload = void 0;
- this._editable = void 0;
- this._richlyEditable = void 0;
- this._focusable = void 0;
- this._expanded = void 0;
- this._name = void 0;
- this._role = void 0;
- this._cachedHasFocusableChild = void 0;
- this._payload = payload;
- this._children = (payload.children || []).map(x => new FFAXNode(x));
- this._editable = !!payload.editable;
- this._richlyEditable = this._editable && payload.tag !== 'textarea' && payload.tag !== 'input';
- this._focusable = !!payload.focusable;
- this._expanded = !!payload.expanded;
- this._name = this._payload.name;
- this._role = this._payload.role;
- }
- _isPlainTextField() {
- if (this._richlyEditable) return false;
- if (this._editable) return true;
- return this._role === 'entry';
- }
- _isTextOnlyObject() {
- const role = this._role;
- return role === 'text leaf' || role === 'text' || role === 'statictext';
- }
- _hasFocusableChild() {
- if (this._cachedHasFocusableChild === undefined) {
- this._cachedHasFocusableChild = false;
- for (const child of this._children) {
- if (child._focusable || child._hasFocusableChild()) {
- this._cachedHasFocusableChild = true;
- break;
- }
- }
- }
- return this._cachedHasFocusableChild;
- }
- children() {
- return this._children;
- }
- _findNeedle() {
- if (this._payload.foundObject) return this;
- for (const child of this._children) {
- const found = child._findNeedle();
- if (found) return found;
- }
- return null;
- }
- isLeafNode() {
- if (!this._children.length) return true;
- // These types of objects may have children that we use as internal
- // implementation details, but we want to expose them as leaves to platform
- // accessibility APIs because screen readers might be confused if they find
- // any children.
- if (this._isPlainTextField() || this._isTextOnlyObject()) return true;
- // Roles whose children are only presentational according to the ARIA and
- // HTML5 Specs should be hidden from screen readers.
- // (Note that whilst ARIA buttons can have only presentational children, HTML5
- // buttons are allowed to have content.)
- switch (this._role) {
- case 'graphic':
- case 'scrollbar':
- case 'slider':
- case 'separator':
- case 'progressbar':
- return true;
- default:
- break;
- }
- // Here and below: Android heuristics
- if (this._hasFocusableChild()) return false;
- if (this._focusable && this._role !== 'document' && this._name) return true;
- if (this._role === 'heading' && this._name) return true;
- return false;
- }
- isControl() {
- switch (this._role) {
- case 'checkbutton':
- case 'check menu item':
- case 'check rich option':
- case 'combobox':
- case 'combobox option':
- case 'color chooser':
- case 'listbox':
- case 'listbox option':
- case 'listbox rich option':
- case 'popup menu':
- case 'menupopup':
- case 'menuitem':
- case 'menubar':
- case 'button':
- case 'pushbutton':
- case 'radiobutton':
- case 'radio menuitem':
- case 'scrollbar':
- case 'slider':
- case 'spinbutton':
- case 'switch':
- case 'pagetab':
- case 'entry':
- case 'tree table':
- return true;
- default:
- return false;
- }
- }
- isInteresting(insideControl) {
- if (this._focusable || this._richlyEditable) return true;
- // If it's not focusable but has a control role, then it's interesting.
- if (this.isControl()) return true;
- // A non focusable child of a control is not interesting
- if (insideControl) return false;
- return this.isLeafNode() && !!this._name.trim();
- }
- serialize() {
- const node = {
- role: FFRoleToARIARole.get(this._role) || this._role,
- name: this._name || ''
- };
- const userStringProperties = ['name', 'description', 'roledescription', 'valuetext', 'keyshortcuts'];
- for (const userStringProperty of userStringProperties) {
- if (!(userStringProperty in this._payload)) continue;
- node[userStringProperty] = this._payload[userStringProperty];
- }
- const booleanProperties = ['disabled', 'expanded', 'focused', 'modal', 'multiline', 'multiselectable', 'readonly', 'required', 'selected'];
- for (const booleanProperty of booleanProperties) {
- if (this._role === 'document' && booleanProperty === 'focused') continue; // document focusing is strange
- const value = this._payload[booleanProperty];
- if (!value) continue;
- node[booleanProperty] = value;
- }
- const numericalProperties = ['level'];
- for (const numericalProperty of numericalProperties) {
- if (!(numericalProperty in this._payload)) continue;
- node[numericalProperty] = this._payload[numericalProperty];
- }
- const tokenProperties = ['autocomplete', 'haspopup', 'invalid', 'orientation'];
- for (const tokenProperty of tokenProperties) {
- const value = this._payload[tokenProperty];
- if (!value || value === 'false') continue;
- node[tokenProperty] = value;
- }
- const axNode = node;
- axNode.valueString = this._payload.value;
- if ('checked' in this._payload) axNode.checked = this._payload.checked === true ? 'checked' : this._payload.checked === 'mixed' ? 'mixed' : 'unchecked';
- if ('pressed' in this._payload) axNode.pressed = this._payload.pressed === true ? 'pressed' : 'released';
- return axNode;
- }
- }
|