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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* 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_XULTreeAccessible_h__
#define mozilla_a11y_XULTreeAccessible_h__
#include "nsITreeView.h"
#include "XULListboxAccessible.h"
#include "mozilla/dom/XULTreeElement.h"
class nsTreeBodyFrame;
class nsTreeColumn;
namespace mozilla {
namespace a11y {
class XULTreeGridCellAccessible;
class XULTreeItemAccessibleBase;
/*
* A class the represents the XUL Tree widget.
*/
const uint32_t kMaxTreeColumns = 100;
const uint32_t kDefaultTreeCacheLength = 128;
/**
* LocalAccessible class for XUL tree element.
*/
class XULTreeAccessible : public AccessibleWrap {
public:
XULTreeAccessible(nsIContent* aContent, DocAccessible* aDoc,
nsTreeBodyFrame* aTreeframe);
// nsISupports and cycle collection
NS_DECL_ISUPPORTS_INHERITED
NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(XULTreeAccessible, LocalAccessible)
// LocalAccessible
virtual void Shutdown() override;
virtual void Value(nsString& aValue) const override;
virtual a11y::role NativeRole() const override;
virtual uint64_t NativeState() const override;
virtual LocalAccessible* LocalChildAtPoint(
int32_t aX, int32_t aY, EWhichChildAtPoint aWhichChild) override;
virtual LocalAccessible* LocalChildAt(uint32_t aIndex) const override;
virtual uint32_t ChildCount() const override;
virtual Relation RelationByType(RelationType aType) const override;
// SelectAccessible
virtual void SelectedItems(nsTArray<Accessible*>* aItems) override;
virtual uint32_t SelectedItemCount() override;
virtual Accessible* GetSelectedItem(uint32_t aIndex) override;
virtual bool IsItemSelected(uint32_t aIndex) override;
virtual bool AddItemToSelection(uint32_t aIndex) override;
virtual bool RemoveItemFromSelection(uint32_t aIndex) override;
virtual bool SelectAll() override;
virtual bool UnselectAll() override;
// Widgets
virtual bool IsWidget() const override;
virtual bool IsActiveWidget() const override;
virtual bool AreItemsOperable() const override;
virtual LocalAccessible* CurrentItem() const override;
virtual void SetCurrentItem(const LocalAccessible* aItem) override;
virtual LocalAccessible* ContainerWidget() const override;
// XULTreeAccessible
/**
* Return tree item accessible at the givem row. If accessible doesn't exist
* in the cache then create and cache it.
*
* @param aRow [in] the given row index
*/
XULTreeItemAccessibleBase* GetTreeItemAccessible(int32_t aRow) const;
/**
* Invalidates the number of cached treeitem accessibles.
*
* @param aRow [in] row index the invalidation starts from
* @param aCount [in] the number of treeitem accessibles to invalidate,
* the number sign specifies whether rows have been
* inserted (plus) or removed (minus)
*/
void InvalidateCache(int32_t aRow, int32_t aCount);
/**
* Fires name change events for invalidated area of tree.
*
* @param aStartRow [in] row index invalidation starts from
* @param aEndRow [in] row index invalidation ends, -1 means last row index
* @param aStartCol [in] column index invalidation starts from
* @param aEndCol [in] column index invalidation ends, -1 mens last column
* index
*/
void TreeViewInvalidated(int32_t aStartRow, int32_t aEndRow,
int32_t aStartCol, int32_t aEndCol);
/**
* Invalidates children created for previous tree view.
*/
void TreeViewChanged(nsITreeView* aView);
protected:
virtual ~XULTreeAccessible();
/**
* Creates tree item accessible for the given row index.
*/
virtual already_AddRefed<XULTreeItemAccessibleBase> CreateTreeItemAccessible(
int32_t aRow) const;
RefPtr<dom::XULTreeElement> mTree;
nsITreeView* mTreeView;
mutable nsRefPtrHashtable<nsPtrHashKey<const void>, XULTreeItemAccessibleBase>
mAccessibleCache;
};
/**
* Base class for tree item accessibles.
*/
class XULTreeItemAccessibleBase : public AccessibleWrap {
public:
XULTreeItemAccessibleBase(nsIContent* aContent, DocAccessible* aDoc,
LocalAccessible* aParent,
dom::XULTreeElement* aTree, nsITreeView* aTreeView,
int32_t aRow);
// nsISupports and cycle collection
NS_DECL_ISUPPORTS_INHERITED
NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(XULTreeItemAccessibleBase,
AccessibleWrap)
// LocalAccessible
virtual void Shutdown() override;
virtual nsRect BoundsInAppUnits() const override;
MOZ_CAN_RUN_SCRIPT_BOUNDARY
virtual nsIntRect BoundsInCSSPixels() const override;
virtual GroupPos GroupPosition() override;
virtual uint64_t NativeState() const override;
virtual uint64_t NativeInteractiveState() const override;
virtual int32_t IndexInParent() const override;
virtual Relation RelationByType(RelationType aType) const override;
virtual Accessible* FocusedChild() override;
virtual void SetSelected(bool aSelect) override;
virtual void TakeFocus() const override;
// ActionAccessible
virtual uint8_t ActionCount() const override;
virtual bool HasPrimaryAction() const override;
virtual void ActionNameAt(uint8_t aIndex, nsAString& aName) override;
virtual bool DoAction(uint8_t aIndex) const override;
// Widgets
virtual LocalAccessible* ContainerWidget() const override;
/**
* Return row index associated with the accessible.
*/
int32_t GetRowIndex() const { return mRow; }
/**
* Return cell accessible for the given column. If XUL tree accessible is not
* accessible table then return null.
*/
virtual XULTreeGridCellAccessible* GetCellAccessible(
nsTreeColumn* aColumn) const {
return nullptr;
}
/**
* Proccess row invalidation. Used to fires name change events.
*/
virtual void RowInvalidated(int32_t aStartColIdx, int32_t aEndColIdx) = 0;
protected:
virtual ~XULTreeItemAccessibleBase();
enum { eAction_Click = 0, eAction_Expand = 1 };
// LocalAccessible
MOZ_CAN_RUN_SCRIPT
virtual void DispatchClickEvent(nsIContent* aContent,
uint32_t aActionIndex) const override;
virtual LocalAccessible* GetSiblingAtOffset(
int32_t aOffset, nsresult* aError = nullptr) const override;
// XULTreeItemAccessibleBase
/**
* Return true if the tree item accessible is expandable (contains subrows).
*/
bool IsExpandable() const;
/**
* Return name for cell at the given column.
*/
void GetCellName(nsTreeColumn* aColumn, nsAString& aName) const;
RefPtr<dom::XULTreeElement> mTree;
nsITreeView* mTreeView;
int32_t mRow;
};
/**
* LocalAccessible class for items for XUL tree.
*/
class XULTreeItemAccessible : public XULTreeItemAccessibleBase {
public:
XULTreeItemAccessible(nsIContent* aContent, DocAccessible* aDoc,
LocalAccessible* aParent, dom::XULTreeElement* aTree,
nsITreeView* aTreeView, int32_t aRow);
// nsISupports and cycle collection
NS_DECL_ISUPPORTS_INHERITED
NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(XULTreeItemAccessible,
XULTreeItemAccessibleBase)
// LocalAccessible
virtual void Shutdown() override;
virtual ENameValueFlag Name(nsString& aName) const override;
virtual a11y::role NativeRole() const override;
// XULTreeItemAccessibleBase
virtual void RowInvalidated(int32_t aStartColIdx,
int32_t aEndColIdx) override;
protected:
virtual ~XULTreeItemAccessible();
// XULTreeItemAccessible
RefPtr<nsTreeColumn> mColumn;
nsString mCachedName;
};
/**
* LocalAccessible class for columns element of XUL tree.
*/
class XULTreeColumAccessible : public XULColumAccessible {
public:
XULTreeColumAccessible(nsIContent* aContent, DocAccessible* aDoc);
protected:
// LocalAccessible
virtual LocalAccessible* GetSiblingAtOffset(
int32_t aOffset, nsresult* aError = nullptr) const override;
};
////////////////////////////////////////////////////////////////////////////////
// LocalAccessible downcasting method
inline XULTreeAccessible* LocalAccessible::AsXULTree() {
return IsXULTree() ? static_cast<XULTreeAccessible*>(this) : nullptr;
}
} // namespace a11y
} // namespace mozilla
#endif
|
