Debian Codegraph @

closure-library/closure/goog/a11y/aria/attributes.js

raw
1 // Copyright 2013 The Closure Library Authors. All Rights Reserved.
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS-IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14
15
16 /**
17 * @fileoverview The file contains generated enumerations for ARIA states
18 * and properties as defined by W3C ARIA standard:
19 * http://www.w3.org/TR/wai-aria/.
20 *
21 * This is auto-generated code. Do not manually edit! For more details
22 * about how to edit it via the generator check go/closure-ariagen.
23 */
24
25 goog.provide('goog.a11y.aria.AutoCompleteValues');
26 goog.provide('goog.a11y.aria.CheckedValues');
27 goog.provide('goog.a11y.aria.DropEffectValues');
28 goog.provide('goog.a11y.aria.ExpandedValues');
29 goog.provide('goog.a11y.aria.GrabbedValues');
30 goog.provide('goog.a11y.aria.InvalidValues');
31 goog.provide('goog.a11y.aria.LivePriority');
32 goog.provide('goog.a11y.aria.OrientationValues');
33 goog.provide('goog.a11y.aria.PressedValues');
34 goog.provide('goog.a11y.aria.RelevantValues');
35 goog.provide('goog.a11y.aria.SelectedValues');
36 goog.provide('goog.a11y.aria.SortValues');
37 goog.provide('goog.a11y.aria.State');
38
39
40 /**
41 * ARIA states and properties.
42 * @enum {string}
43 */
44 goog.a11y.aria.State = {
45 // ARIA property for setting the currently active descendant of an element,
46 // for example the selected item in a list box. Value: ID of an element.
47 ACTIVEDESCENDANT: 'activedescendant',
48
49 // ARIA property that, if true, indicates that all of a changed region should
50 // be presented, instead of only parts. Value: one of {true, false}.
51 ATOMIC: 'atomic',
52
53 // ARIA property to specify that input completion is provided. Value:
54 // one of {'inline', 'list', 'both', 'none'}.
55 AUTOCOMPLETE: 'autocomplete',
56
57 // ARIA state to indicate that an element and its subtree are being updated.
58 // Value: one of {true, false}.
59 BUSY: 'busy',
60
61 // ARIA state for a checked item. Value: one of {'true', 'false', 'mixed',
62 // undefined}.
63 CHECKED: 'checked',
64
65 // ARIA state that defines an element's column index or position with respect
66 // to the total number of columns within a table, grid, or treegrid.
67 // Value: number.
68 COLINDEX: 'colindex',
69
70 // ARIA property that identifies the element or elements whose contents or
71 // presence are controlled by this element.
72 // Value: space-separated IDs of other elements.
73 CONTROLS: 'controls',
74
75 // ARIA property that identifies the element or elements that describe
76 // this element. Value: space-separated IDs of other elements.
77 DESCRIBEDBY: 'describedby',
78
79 // ARIA state for a disabled item. Value: one of {true, false}.
80 DISABLED: 'disabled',
81
82 // ARIA property that indicates what functions can be performed when a
83 // dragged object is released on the drop target. Value: one of
84 // {'copy', 'move', 'link', 'execute', 'popup', 'none'}.
85 DROPEFFECT: 'dropeffect',
86
87 // ARIA state for setting whether the element like a tree node is expanded.
88 // Value: one of {true, false, undefined}.
89 EXPANDED: 'expanded',
90
91 // ARIA property that identifies the next element (or elements) in the
92 // recommended reading order of content. Value: space-separated ids of
93 // elements to flow to.
94 FLOWTO: 'flowto',
95
96 // ARIA state that indicates an element's "grabbed" state in drag-and-drop.
97 // Value: one of {true, false, undefined}.
98 GRABBED: 'grabbed',
99
100 // ARIA property indicating whether the element has a popup.
101 // Value: one of {true, false}.
102 HASPOPUP: 'haspopup',
103
104 // ARIA state indicating that the element is not visible or perceivable
105 // to any user. Value: one of {true, false}.
106 HIDDEN: 'hidden',
107
108 // ARIA state indicating that the entered value does not conform. Value:
109 // one of {false, true, 'grammar', 'spelling'}
110 INVALID: 'invalid',
111
112 // ARIA property that provides a label to override any other text, value, or
113 // contents used to describe this element. Value: string.
114 LABEL: 'label',
115
116 // ARIA property for setting the element which labels another element.
117 // Value: space-separated IDs of elements.
118 LABELLEDBY: 'labelledby',
119
120 // ARIA property for setting the level of an element in the hierarchy.
121 // Value: integer.
122 LEVEL: 'level',
123
124 // ARIA property indicating that an element will be updated, and
125 // describes the types of updates the user agents, assistive technologies,
126 // and user can expect from the live region. Value: one of {'off', 'polite',
127 // 'assertive'}.
128 LIVE: 'live',
129
130 // ARIA property indicating whether a text box can accept multiline input.
131 // Value: one of {true, false}.
132 MULTILINE: 'multiline',
133
134 // ARIA property indicating if the user may select more than one item.
135 // Value: one of {true, false}.
136 MULTISELECTABLE: 'multiselectable',
137
138 // ARIA property indicating if the element is horizontal or vertical.
139 // Value: one of {'vertical', 'horizontal'}.
140 ORIENTATION: 'orientation',
141
142 // ARIA property creating a visual, functional, or contextual parent/child
143 // relationship when the DOM hierarchy can't be used to represent it.
144 // Value: Space-separated IDs of elements.
145 OWNS: 'owns',
146
147 // ARIA property that defines an element's number of position in a list.
148 // Value: integer.
149 POSINSET: 'posinset',
150
151 // ARIA state for a pressed item.
152 // Value: one of {true, false, undefined, 'mixed'}.
153 PRESSED: 'pressed',
154
155 // ARIA property indicating that an element is not editable.
156 // Value: one of {true, false}.
157 READONLY: 'readonly',
158
159 // ARIA property indicating that change notifications within this subtree
160 // of a live region should be announced. Value: one of {'additions',
161 // 'removals', 'text', 'all', 'additions text'}.
162 RELEVANT: 'relevant',
163
164 // ARIA property indicating that user input is required on this element
165 // before a form may be submitted. Value: one of {true, false}.
166 REQUIRED: 'required',
167
168 // ARIA state that defines an element's row index or position with respect
169 // to the total number of rows within a table, grid, or treegrid.
170 // Value: number.
171 ROWINDEX: 'rowindex',
172
173 // ARIA state for setting the currently selected item in the list.
174 // Value: one of {true, false, undefined}.
175 SELECTED: 'selected',
176
177 // ARIA property defining the number of items in a list. Value: integer.
178 SETSIZE: 'setsize',
179
180 // ARIA property indicating if items are sorted. Value: one of {'ascending',
181 // 'descending', 'none', 'other'}.
182 SORT: 'sort',
183
184 // ARIA property for slider maximum value. Value: number.
185 VALUEMAX: 'valuemax',
186
187 // ARIA property for slider minimum value. Value: number.
188 VALUEMIN: 'valuemin',
189
190 // ARIA property for slider active value. Value: number.
191 VALUENOW: 'valuenow',
192
193 // ARIA property for slider active value represented as text.
194 // Value: string.
195 VALUETEXT: 'valuetext'
196 };
197
198
199 /**
200 * ARIA state values for AutoCompleteValues.
201 * @enum {string}
202 */
203 goog.a11y.aria.AutoCompleteValues = {
204 // The system provides text after the caret as a suggestion
205 // for how to complete the field.
206 INLINE: 'inline',
207 // A list of choices appears from which the user can choose,
208 // but the edit box retains focus.
209 LIST: 'list',
210 // A list of choices appears and the currently selected suggestion
211 // also appears inline.
212 BOTH: 'both',
213 // No input completion suggestions are provided.
214 NONE: 'none'
215 };
216
217
218 /**
219 * ARIA state values for DropEffectValues.
220 * @enum {string}
221 */
222 goog.a11y.aria.DropEffectValues = {
223 // A duplicate of the source object will be dropped into the target.
224 COPY: 'copy',
225 // The source object will be removed from its current location
226 // and dropped into the target.
227 MOVE: 'move',
228 // A reference or shortcut to the dragged object
229 // will be created in the target object.
230 LINK: 'link',
231 // A function supported by the drop target is
232 // executed, using the drag source as an input.
233 EXECUTE: 'execute',
234 // There is a popup menu or dialog that allows the user to choose
235 // one of the drag operations (copy, move, link, execute) and any other
236 // drag functionality, such as cancel.
237 POPUP: 'popup',
238 // No operation can be performed; effectively
239 // cancels the drag operation if an attempt is made to drop on this object.
240 NONE: 'none'
241 };
242
243
244 /**
245 * ARIA state values for LivePriority.
246 * @enum {string}
247 */
248 goog.a11y.aria.LivePriority = {
249 // Updates to the region will not be presented to the user
250 // unless the assitive technology is currently focused on that region.
251 OFF: 'off',
252 // (Background change) Assistive technologies SHOULD announce
253 // updates at the next graceful opportunity, such as at the end of
254 // speaking the current sentence or when the user pauses typing.
255 POLITE: 'polite',
256 // This information has the highest priority and assistive
257 // technologies SHOULD notify the user immediately.
258 // Because an interruption may disorient users or cause them to not complete
259 // their current task, authors SHOULD NOT use the assertive value unless the
260 // interruption is imperative.
261 ASSERTIVE: 'assertive'
262 };
263
264
265 /**
266 * ARIA state values for OrientationValues.
267 * @enum {string}
268 */
269 goog.a11y.aria.OrientationValues = {
270 // The element is oriented vertically.
271 VERTICAL: 'vertical',
272 // The element is oriented horizontally.
273 HORIZONTAL: 'horizontal'
274 };
275
276
277 /**
278 * ARIA state values for RelevantValues.
279 * @enum {string}
280 */
281 goog.a11y.aria.RelevantValues = {
282 // Element nodes are added to the DOM within the live region.
283 ADDITIONS: 'additions',
284 // Text or element nodes within the live region are removed from the DOM.
285 REMOVALS: 'removals',
286 // Text is added to any DOM descendant nodes of the live region.
287 TEXT: 'text',
288 // Equivalent to the combination of all values, "additions removals text".
289 ALL: 'all'
290 };
291
292
293 /**
294 * ARIA state values for SortValues.
295 * @enum {string}
296 */
297 goog.a11y.aria.SortValues = {
298 // Items are sorted in ascending order by this column.
299 ASCENDING: 'ascending',
300 // Items are sorted in descending order by this column.
301 DESCENDING: 'descending',
302 // There is no defined sort applied to the column.
303 NONE: 'none',
304 // A sort algorithm other than ascending or descending has been applied.
305 OTHER: 'other'
306 };
307
308
309 /**
310 * ARIA state values for CheckedValues.
311 * @enum {string}
312 */
313 goog.a11y.aria.CheckedValues = {
314 // The selectable element is checked.
315 TRUE: 'true',
316 // The selectable element is not checked.
317 FALSE: 'false',
318 // Indicates a mixed mode value for a tri-state
319 // checkbox or menuitemcheckbox.
320 MIXED: 'mixed',
321 // The element does not support being checked.
322 UNDEFINED: 'undefined'
323 };
324
325
326 /**
327 * ARIA state values for ExpandedValues.
328 * @enum {string}
329 */
330 goog.a11y.aria.ExpandedValues = {
331 // The element, or another grouping element it controls, is expanded.
332 TRUE: 'true',
333 // The element, or another grouping element it controls, is collapsed.
334 FALSE: 'false',
335 // The element, or another grouping element
336 // it controls, is neither expandable nor collapsible; all its
337 // child elements are shown or there are no child elements.
338 UNDEFINED: 'undefined'
339 };
340
341
342 /**
343 * ARIA state values for GrabbedValues.
344 * @enum {string}
345 */
346 goog.a11y.aria.GrabbedValues = {
347 // Indicates that the element has been "grabbed" for dragging.
348 TRUE: 'true',
349 // Indicates that the element supports being dragged.
350 FALSE: 'false',
351 // Indicates that the element does not support being dragged.
352 UNDEFINED: 'undefined'
353 };
354
355
356 /**
357 * ARIA state values for InvalidValues.
358 * @enum {string}
359 */
360 goog.a11y.aria.InvalidValues = {
361 // There are no detected errors in the value.
362 FALSE: 'false',
363 // The value entered by the user has failed validation.
364 TRUE: 'true',
365 // A grammatical error was detected.
366 GRAMMAR: 'grammar',
367 // A spelling error was detected.
368 SPELLING: 'spelling'
369 };
370
371
372 /**
373 * ARIA state values for PressedValues.
374 * @enum {string}
375 */
376 goog.a11y.aria.PressedValues = {
377 // The element is pressed.
378 TRUE: 'true',
379 // The element supports being pressed but is not currently pressed.
380 FALSE: 'false',
381 // Indicates a mixed mode value for a tri-state toggle button.
382 MIXED: 'mixed',
383 // The element does not support being pressed.
384 UNDEFINED: 'undefined'
385 };
386
387
388 /**
389 * ARIA state values for SelectedValues.
390 * @enum {string}
391 */
392 goog.a11y.aria.SelectedValues = {
393 // The selectable element is selected.
394 TRUE: 'true',
395 // The selectable element is not selected.
396 FALSE: 'false',
397 // The element is not selectable.
398 UNDEFINED: 'undefined'
399 };