summaryrefslogtreecommitdiffstats
path: root/third_party/WebKit/Source/modules/accessibility/AXNodeObject.h
blob: 0061dbb9691a51c73aff7dd0a900953475360bf0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
/*
 * Copyright (C) 2012, Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1.  Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 * 2.  Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
 *     its contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef AXNodeObject_h
#define AXNodeObject_h

#include "modules/ModulesExport.h"
#include "modules/accessibility/AXObject.h"
#include "wtf/Forward.h"

namespace blink {

class AXObjectCacheImpl;
class Element;
class HTMLLabelElement;
class LayoutRect;
class Node;

class MODULES_EXPORT AXNodeObject : public AXObject {
protected:
    AXNodeObject(Node*, AXObjectCacheImpl&);

public:
    static AXNodeObject* create(Node*, AXObjectCacheImpl&);
    ~AXNodeObject() override;
    DECLARE_VIRTUAL_TRACE();

protected:
    // Protected data.
    AccessibilityRole m_ariaRole;
    bool m_childrenDirty;
#if ENABLE(ASSERT)
    bool m_initialized;
#endif

    bool computeAccessibilityIsIgnored(IgnoredReasons* = nullptr) const override;
    const AXObject* inheritsPresentationalRoleFrom() const override;
    virtual AccessibilityRole determineAccessibilityRole();
    AccessibilityRole determineAccessibilityRoleUtil();
    String accessibilityDescriptionForElements(WillBeHeapVector<RawPtrWillBeMember<Element>> &elements) const;
    void alterSliderValue(bool increase);
    String ariaAccessibilityDescription() const;
    String ariaAutoComplete() const;
    void ariaLabelledbyElements(WillBeHeapVector<RawPtrWillBeMember<Element>>& elements) const;
    AccessibilityRole determineAriaRoleAttribute() const;
    void tokenVectorFromAttribute(Vector<String>&, const QualifiedName&) const;
    void elementsFromAttribute(WillBeHeapVector<RawPtrWillBeMember<Element>>& elements, const QualifiedName&) const;
    void accessibilityChildrenFromAttribute(QualifiedName attr, AXObject::AXObjectVector&) const;

    bool hasContentEditableAttributeSet() const;
    bool isTextControl() const override;
    // This returns true if it's focusable but it's not content editable and it's not a control or ARIA control.
    bool isGenericFocusableElement() const;
    HTMLLabelElement* labelForElement(const Element*) const;
    AXObject* menuButtonForMenu() const;
    Element* menuItemElementForMenu() const;
    Element* mouseButtonListener() const;
    String deprecatedPlaceholder() const;
    AccessibilityRole remapAriaRoleDueToParent(AccessibilityRole) const;
    bool isNativeCheckboxOrRadio() const;
    void setNode(Node*);
    AXObject* correspondingControlForLabelElement() const;
    HTMLLabelElement* labelElementContainer() const;

    //
    // Overridden from AXObject.
    //

    void init() override;
    void detach() override;
    bool isDetached() const override { return !m_node; }
    bool isAXNodeObject() const final { return true; }

    // Check object role or purpose.
    bool isAnchor() const final;
    bool isControl() const override;
    bool isControllingVideoElement() const;
    bool isEditable() const override { return isTextControl(); }
    bool isEmbeddedObject() const final;
    bool isFieldset() const final;
    bool isHeading() const final;
    bool isHovered() const final;
    bool isImage() const final;
    bool isImageButton() const;
    bool isInputImage() const final;
    bool isLink() const override;
    bool isMenu() const final;
    bool isMenuButton() const final;
    bool isMeter() const final;
    bool isMultiSelectable() const override;
    bool isNativeImage() const;
    bool isNativeTextControl() const final;
    bool isNonNativeTextControl() const final;
    bool isPasswordField() const final;
    bool isProgressIndicator() const override;
    bool isRichlyEditable() const override { return hasContentEditableAttributeSet(); }
    bool isSlider() const override;
    bool isNativeSlider() const override;

    // Check object state.
    bool isChecked() const final;
    bool isClickable() const final;
    bool isEnabled() const override;
    AccessibilityExpanded isExpanded() const override;
    bool isIndeterminate() const final;
    bool isPressed() const final;
    bool isReadOnly() const override;
    bool isRequired() const final;

    // Check whether certain properties can be modified.
    bool canSetFocusAttribute() const override;
    bool canSetValueAttribute() const override;

    // Properties of static elements.
    RGBA32 colorValue() const final;
    bool canvasHasFallbackContent() const final;
    bool deprecatedExposesTitleUIElement() const override;
    int headingLevel() const final;
    unsigned hierarchicalLevel() const final;
    AccessibilityOrientation orientation() const override;
    String text() const override;
    AXObject* deprecatedTitleUIElement() const override;

    // Properties of interactive elements.
    AccessibilityButtonState checkboxOrRadioValue() const final;
    InvalidState invalidState() const final;
    // Only used when invalidState() returns InvalidStateOther.
    String ariaInvalidValue() const final;
    String valueDescription() const override;
    float valueForRange() const override;
    float maxValueForRange() const override;
    float minValueForRange() const override;
    String stringValue() const override;

    // ARIA attributes.
    String ariaDescribedByAttribute() const final;
    String ariaLabelledbyAttribute() const final;
    AccessibilityRole ariaRoleAttribute() const final;

    // Accessibility Text.
    String deprecatedTextUnderElement(TextUnderElementMode) const override;
    String deprecatedAccessibilityDescription() const override;
    String deprecatedTitle(TextUnderElementMode) const override;
    String deprecatedHelpText() const override;
    String computedName() const override;

    // New AX name calculation.
    String textAlternative(bool recursive, bool inAriaLabelledByTraversal, AXObjectSet& visited, AXNameFrom&, AXRelatedObjectVector*, NameSources*) const override;
    String description(AXNameFrom, AXDescriptionFrom&, AXObjectVector* descriptionObjects) const override;
    String description(AXNameFrom, AXDescriptionFrom&, DescriptionSources*, AXRelatedObjectVector*) const override;

    // Location and click point in frame-relative coordinates.
    LayoutRect elementRect() const override;

    // High-level accessibility tree access.
    AXObject* computeParent() const override;
    AXObject* computeParentIfExists() const override;

    // Low-level accessibility tree exploration.
    AXObject* firstChild() const override;
    AXObject* nextSibling() const override;
    void addChildren() override;
    bool canHaveChildren() const override;
    void addChild(AXObject*);
    void insertChild(AXObject*, unsigned index);

    // DOM and Render tree access.
    Element* actionElement() const override;
    Element* anchorElement() const override;
    Document* document() const override;
    Node* node() const override { return m_node; }

    // Modify or take an action on an object.
    void setFocused(bool) final;
    void increment() final;
    void decrement() final;

    // Notifications that this object may have changed.
    void childrenChanged() override;
    void selectionChanged() final;
    void textChanged() override;
    void updateAccessibilityRole() final;

    // Position in set and Size of set
    int posInSet() const override;
    int setSize() const override;

    // Aria-owns.
    void computeAriaOwnsChildren(HeapVector<Member<AXObject>>& ownedChildren);

private:
    RawPtrWillBeMember<Node> m_node;

    String deprecatedAlternativeTextForWebArea() const;
    void deprecatedAlternativeText(HeapVector<Member<AccessibilityText>>&) const;
    void deprecatedAriaLabelledbyText(HeapVector<Member<AccessibilityText>>&) const;

    String textFromDescendants(AXObjectSet& visited) const;
    String textFromElements(bool inAriaLabelledByTraversal, AXObjectSet& visited, WillBeHeapVector<RawPtrWillBeMember<Element>>& elements, AXRelatedObjectVector* relatedObjects) const;
    String textFromAriaLabelledby(AXObjectSet& visited, AXRelatedObjectVector* relatedObjects) const;
    String textFromAriaDescribedby(AXRelatedObjectVector* relatedObjects) const;
    String nativeTextAlternative(AXObjectSet& visited, AXNameFrom&, AXRelatedObjectVector*, NameSources*, bool* foundTextAlternative) const;
    float stepValueForRange() const;
    AXObject* findChildWithTagName(const HTMLQualifiedName&) const;
    bool isDescendantOfElementType(const HTMLQualifiedName& tagName) const;
    String stringValueOfControl() const;
};

DEFINE_AX_OBJECT_TYPE_CASTS(AXNodeObject, isAXNodeObject());

} // namespace blink

#endif // AXNodeObject_h