OLD | NEW |
1 // Copyright 2014 The Chromium Authors. All rights reserved. | 1 // Copyright 2014 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 /** | 5 /** |
6 * @fileoverview An interface (and partial implementation) for the basic | 6 * @fileoverview An interface (and partial implementation) for the basic |
7 * traversal through some piece of the dom. | 7 * traversal through some piece of the dom. |
8 * For each different ordered (either in dom or by any other metric) set | 8 * For each different ordered (either in dom or by any other metric) set |
9 * of "valid selections" (just set from now on), a new | 9 * of "valid selections" (just set from now on), a new |
10 * base class should be defined that implements this interface. For example, | 10 * base class should be defined that implements this interface. For example, |
(...skipping 113 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
124 /** | 124 /** |
125 * Returns an array of NavDescriptions that defines what should be said | 125 * Returns an array of NavDescriptions that defines what should be said |
126 * by the tts engine on traversal from prevSel to sel. While this is | 126 * by the tts engine on traversal from prevSel to sel. While this is |
127 * introducing knowledge (of NavDescriptions) into this class that | 127 * introducing knowledge (of NavDescriptions) into this class that |
128 * it shouldn't know, this is currently the best place for this method | 128 * it shouldn't know, this is currently the best place for this method |
129 * to reside, as the set of valid CursorSelections must be known. | 129 * to reside, as the set of valid CursorSelections must be known. |
130 * sel must be valid CursorSelections for this walker, prevSel may be any | 130 * sel must be valid CursorSelections for this walker, prevSel may be any |
131 * selection. Undefined behavior otherwise. | 131 * selection. Undefined behavior otherwise. |
132 * @param {!cvox.CursorSelection} prevSel The valid previous selection. | 132 * @param {!cvox.CursorSelection} prevSel The valid previous selection. |
133 * @param {!cvox.CursorSelection} sel The valid current selection. | 133 * @param {!cvox.CursorSelection} sel The valid current selection. |
134 * @return {!Array.<!cvox.NavDescription>} The description array. | 134 * @return {!Array<!cvox.NavDescription>} The description array. |
135 */ | 135 */ |
136 cvox.AbstractWalker.prototype.getDescription = goog.abstractMethod; | 136 cvox.AbstractWalker.prototype.getDescription = goog.abstractMethod; |
137 | 137 |
138 | 138 |
139 /** | 139 /** |
140 * Returns a NavBraille that defines what should be brailled on traversal from | 140 * Returns a NavBraille that defines what should be brailled on traversal from |
141 * prevSel to sel. | 141 * prevSel to sel. |
142 * sel must be valid CursorSelections for this walker, prevSel may be any | 142 * sel must be valid CursorSelections for this walker, prevSel may be any |
143 * selection. Undefined behavior otherwise. | 143 * selection. Undefined behavior otherwise. |
144 * @param {!cvox.CursorSelection} prevSel The valid previous selection. | 144 * @param {!cvox.CursorSelection} prevSel The valid previous selection. |
(...skipping 23 matching lines...) Expand all Loading... |
168 return this[name](sel); | 168 return this[name](sel); |
169 } | 169 } |
170 return null; | 170 return null; |
171 }; | 171 }; |
172 | 172 |
173 /** | 173 /** |
174 * Returns message string of the walker's granularity. | 174 * Returns message string of the walker's granularity. |
175 * @return {string} The message string. | 175 * @return {string} The message string. |
176 */ | 176 */ |
177 cvox.AbstractWalker.prototype.getGranularityMsg = goog.abstractMethod; | 177 cvox.AbstractWalker.prototype.getGranularityMsg = goog.abstractMethod; |
OLD | NEW |