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
|
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef mozilla_a11y_FocusManager_h_
#define mozilla_a11y_FocusManager_h_
#include "mozilla/RefPtr.h"
class nsINode;
class nsISupports;
namespace mozilla {
namespace dom {
class Document;
}
namespace a11y {
class Accessible;
class AccEvent;
class LocalAccessible;
class DocAccessible;
class DocAccessibleParent;
/**
* Manage the accessible focus. Used to fire and process accessible events.
*/
class FocusManager {
public:
virtual ~FocusManager();
/**
* Return the currently focused LocalAccessible. If a remote document has
* focus, this will return null.
*/
LocalAccessible* FocusedLocalAccessible() const;
/**
* Return the currently focused Accessible, local or remote.
*/
Accessible* FocusedAccessible() const;
/**
* Return true if given accessible is focused.
*/
bool IsFocused(const Accessible* aAccessible) const {
return FocusedAccessible() == aAccessible;
}
/**
* Return true if the given accessible is an active item, i.e. an item that
* is current within the active widget.
*/
inline bool IsActiveItem(const LocalAccessible* aAccessible) {
return aAccessible == mActiveItem;
}
/**
* Return DOM node having DOM focus.
*/
nsINode* FocusedDOMNode() const;
/**
* Return true if given DOM node has DOM focus.
*/
inline bool HasDOMFocus(const nsINode* aNode) const {
return aNode == FocusedDOMNode();
}
/**
* Return true if focused accessible is within the given container.
*/
bool IsFocusWithin(const Accessible* aContainer) const;
/**
* Return whether the given accessible is focused or contains the focus or
* contained by focused accessible.
*/
enum FocusDisposition { eNone, eFocused, eContainsFocus, eContainedByFocus };
FocusDisposition IsInOrContainsFocus(
const LocalAccessible* aAccessible) const;
/**
* Return true if the given accessible was the last accessible focused.
* This is useful to detect the case where the last focused accessible was
* removed before something else was focused. This can happen in one of two
* ways:
* 1. The DOM focus was removed. DOM doesn't fire a blur event when this
* happens; see bug 559561.
* 2. The accessibility focus was an active item (e.g. aria-activedescendant)
* and that item was removed.
*/
bool WasLastFocused(const LocalAccessible* aAccessible) const;
//////////////////////////////////////////////////////////////////////////////
// Focus notifications and processing (don't use until you know what you do).
/**
* Called when DOM focus event is fired.
*/
void NotifyOfDOMFocus(nsISupports* aTarget);
/**
* Called when DOM blur event is fired.
*/
void NotifyOfDOMBlur(nsISupports* aTarget);
/**
* Called when active item is changed. Note: must be called when accessible
* tree is up to date.
*/
void ActiveItemChanged(LocalAccessible* aItem, bool aCheckIfActive = true);
/**
* Dispatch delayed focus event for the current focus accessible.
*/
void ForceFocusEvent();
/**
* Dispatch delayed focus event for the given target.
*/
void DispatchFocusEvent(DocAccessible* aDocument, LocalAccessible* aTarget);
/**
* Process DOM focus notification.
*/
void ProcessDOMFocus(nsINode* aTarget);
/**
* Process the delayed accessible event.
* do.
*/
void ProcessFocusEvent(AccEvent* aEvent);
#ifdef ANDROID
void SetFocusedRemoteDoc(DocAccessibleParent* aDoc) {
mFocusedRemoteDoc = aDoc;
}
bool IsFocusedRemoteDoc(DocAccessibleParent* aDoc) {
return mFocusedRemoteDoc == aDoc;
}
#endif
protected:
FocusManager();
private:
FocusManager(const FocusManager&);
FocusManager& operator=(const FocusManager&);
/**
* Return DOM document having DOM focus.
*/
dom::Document* FocusedDOMDocument() const;
private:
RefPtr<LocalAccessible> mActiveItem;
RefPtr<LocalAccessible> mLastFocus;
RefPtr<LocalAccessible> mActiveARIAMenubar;
#ifdef ANDROID
DocAccessibleParent* mFocusedRemoteDoc = nullptr;
#endif
};
} // namespace a11y
} // namespace mozilla
#endif
|
