|
0
|
1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> |
|
|
2 |
<html xmlns:yui="http://yuilibrary.com/rdf/1.0/yui.rdf#"> |
|
|
3 |
<head> |
|
|
4 |
<meta http-equiv="content-type" content="text/html; charset=UTF-8" /> |
|
|
5 |
<title>API: node-focusmanager plugin.NodeFocusManager (YUI Library)</title> |
|
|
6 |
|
|
|
7 |
<link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css" /> |
|
|
8 |
<link rel="stylesheet" type="text/css" href="assets/api.css" /> |
|
|
9 |
|
|
|
10 |
<script type="text/javascript" src="assets/api-js"></script> |
|
|
11 |
<script type="text/javascript" src="assets/ac-js"></script> |
|
|
12 |
</head> |
|
|
13 |
|
|
|
14 |
<body id="yahoo-com"> |
|
|
15 |
|
|
|
16 |
<div id="doc3" class="yui-t2"> |
|
|
17 |
<div id="hd"> |
|
|
18 |
<h1><a href="http://developer.yahoo.com/yui/" title="Yahoo! UI Library">Yahoo! UI Library</a></h1> |
|
|
19 |
<h3>node-focusmanager <span class="subtitle">3.0.0b1</span></h3> |
|
|
20 |
<a href="./index.html" title="Yahoo! UI Library">Yahoo! UI Library</a> |
|
|
21 |
> <a href="./module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a> |
|
|
22 |
> plugin.NodeFocusManager |
|
|
23 |
|
|
|
24 |
<form onsubmit="return false"> |
|
|
25 |
<div id="propertysearch"> |
|
|
26 |
Search: <input autocomplete="off" id="searchinput" /> |
|
|
27 |
<div id="searchresults"> |
|
|
28 |
|
|
|
29 |
</div> |
|
|
30 |
</div> |
|
|
31 |
</form> |
|
|
32 |
</div> |
|
|
33 |
|
|
|
34 |
<div id="bd"> |
|
|
35 |
<div id="yui-main"> |
|
|
36 |
<div class="yui-b"> |
|
|
37 |
<form action="#" name="yui-classopts-form" method="get" id="yui-classopts-form"> |
|
|
38 |
<fieldset> |
|
|
39 |
<legend>Filters</legend> |
|
|
40 |
<span class="classopts"><input type="checkbox" name="show_private" id="show_private" /> <label for="show_private">Show Private</label></span> |
|
|
41 |
<span class="classopts"><input type="checkbox" name="show_protected" id="show_protected" /> <label for="show_protected">Show Protected</label></span> |
|
|
42 |
<span class="classopts"><input type="checkbox" name="show_deprecated" id="show_deprecated" /> <label for="show_deprecated">Show Deprecated</label></span> |
|
|
43 |
</fieldset> |
|
|
44 |
</form> |
|
|
45 |
|
|
|
46 |
<h2> |
|
|
47 |
|
|
|
48 |
|
|
|
49 |
|
|
|
50 |
|
|
|
51 |
Class <b property="yui:name">plugin.NodeFocusManager</b> |
|
|
52 |
<span class="extends"> |
|
|
53 |
</span> |
|
|
54 |
|
|
|
55 |
</h2> |
|
|
56 |
<!-- class tree goes here --> |
|
|
57 |
|
|
|
58 |
|
|
|
59 |
|
|
|
60 |
|
|
|
61 |
<div class="summary description" property="yui:description"> |
|
|
62 |
The NodeFocusManager class is a plugin for a Node instance. The class is used |
|
|
63 |
via the <a href="Node.html#method_plug"><code>plug</code></a> method of Node |
|
|
64 |
and should not be instantiated directly. |
|
|
65 |
</div> |
|
|
66 |
|
|
|
67 |
|
|
|
68 |
<div rel="yui:properties" resource="#properties"> |
|
|
69 |
|
|
|
70 |
</div> |
|
|
71 |
|
|
|
72 |
<div rel="yui:methods" resource="#methods"> |
|
|
73 |
<div class="section method details"> |
|
|
74 |
<h3 id="methods">Methods</h3> |
|
|
75 |
<div class="content"> |
|
|
76 |
<div class="protected" rel="yui:method" resource="#method__afterActiveDescendantChange"> |
|
|
77 |
<h4> |
|
|
78 |
<a name="method__afterActiveDescendantChange">_afterActiveDescendantChange</a></h4> |
|
|
79 |
<div class="detail" > |
|
|
80 |
<code> |
|
|
81 |
protected |
|
|
82 |
|
|
|
83 |
|
|
|
84 |
void |
|
|
85 |
<strong property="yui:name">_afterActiveDescendantChange</strong> |
|
|
86 |
( |
|
|
87 |
|
|
|
88 |
|
|
|
89 |
event |
|
|
90 |
|
|
|
91 |
|
|
|
92 |
) |
|
|
93 |
</code> |
|
|
94 |
|
|
|
95 |
<div class="description" property="yui:description"> |
|
|
96 |
afterChange event handler for the |
|
|
97 |
"activeDescendant" attribute. |
|
|
98 |
</div> |
|
|
99 |
|
|
|
100 |
<div class="description"> |
|
|
101 |
|
|
|
102 |
<dl rel="yui:parameters"> |
|
|
103 |
<dt>Parameters:</dt> |
|
|
104 |
<dd rel="yui:parameter"> |
|
|
105 |
<code><span property="yui:name">event</span> |
|
|
106 |
<<span property="yui:type">Object</span>> |
|
|
107 |
</code> |
|
|
108 |
<span property="yui:description"> Object representing the change event.</span> |
|
|
109 |
</dd> |
|
|
110 |
</dl> |
|
|
111 |
|
|
|
112 |
<dl> |
|
|
113 |
<dt>Returns: |
|
|
114 |
<code property="yui:return"> |
|
|
115 |
void |
|
|
116 |
</code></dt> |
|
|
117 |
<dd property="yui:returnInfo"></dd> |
|
|
118 |
</dl> |
|
|
119 |
|
|
|
120 |
|
|
|
121 |
|
|
|
122 |
|
|
|
123 |
</div> |
|
|
124 |
|
|
|
125 |
</div> |
|
|
126 |
<hr /> |
|
|
127 |
</div> |
|
|
128 |
<div class="protected" rel="yui:method" resource="#method__attachKeyHandler"> |
|
|
129 |
<h4> |
|
|
130 |
<a name="method__attachKeyHandler">_attachKeyHandler</a></h4> |
|
|
131 |
<div class="detail" > |
|
|
132 |
<code> |
|
|
133 |
protected |
|
|
134 |
|
|
|
135 |
|
|
|
136 |
void |
|
|
137 |
<strong property="yui:name">_attachKeyHandler</strong> |
|
|
138 |
( |
|
|
139 |
) |
|
|
140 |
</code> |
|
|
141 |
|
|
|
142 |
<div class="description" property="yui:description"> |
|
|
143 |
Attaches the "key" event handlers used to support the "keys" |
|
|
144 |
attribute. |
|
|
145 |
</div> |
|
|
146 |
|
|
|
147 |
<div class="description"> |
|
|
148 |
|
|
|
149 |
|
|
|
150 |
<dl> |
|
|
151 |
<dt>Returns: |
|
|
152 |
<code property="yui:return"> |
|
|
153 |
void |
|
|
154 |
</code></dt> |
|
|
155 |
<dd property="yui:returnInfo"></dd> |
|
|
156 |
</dl> |
|
|
157 |
|
|
|
158 |
|
|
|
159 |
|
|
|
160 |
|
|
|
161 |
</div> |
|
|
162 |
|
|
|
163 |
</div> |
|
|
164 |
<hr /> |
|
|
165 |
</div> |
|
|
166 |
<div class="protected" rel="yui:method" resource="#method__detachEventHandlers"> |
|
|
167 |
<h4> |
|
|
168 |
<a name="method__detachEventHandlers">_detachEventHandlers</a></h4> |
|
|
169 |
<div class="detail" > |
|
|
170 |
<code> |
|
|
171 |
protected |
|
|
172 |
|
|
|
173 |
|
|
|
174 |
void |
|
|
175 |
<strong property="yui:name">_detachEventHandlers</strong> |
|
|
176 |
( |
|
|
177 |
) |
|
|
178 |
</code> |
|
|
179 |
|
|
|
180 |
<div class="description" property="yui:description"> |
|
|
181 |
Detaches all event handlers used by the Focus Manager. |
|
|
182 |
</div> |
|
|
183 |
|
|
|
184 |
<div class="description"> |
|
|
185 |
|
|
|
186 |
|
|
|
187 |
<dl> |
|
|
188 |
<dt>Returns: |
|
|
189 |
<code property="yui:return"> |
|
|
190 |
void |
|
|
191 |
</code></dt> |
|
|
192 |
<dd property="yui:returnInfo"></dd> |
|
|
193 |
</dl> |
|
|
194 |
|
|
|
195 |
|
|
|
196 |
|
|
|
197 |
|
|
|
198 |
</div> |
|
|
199 |
|
|
|
200 |
</div> |
|
|
201 |
<hr /> |
|
|
202 |
</div> |
|
|
203 |
<div class="protected" rel="yui:method" resource="#method__detachKeyHandler"> |
|
|
204 |
<h4> |
|
|
205 |
<a name="method__detachKeyHandler">_detachKeyHandler</a></h4> |
|
|
206 |
<div class="detail" > |
|
|
207 |
<code> |
|
|
208 |
protected |
|
|
209 |
|
|
|
210 |
|
|
|
211 |
void |
|
|
212 |
<strong property="yui:name">_detachKeyHandler</strong> |
|
|
213 |
( |
|
|
214 |
) |
|
|
215 |
</code> |
|
|
216 |
|
|
|
217 |
<div class="description" property="yui:description"> |
|
|
218 |
Detaches the "key" event handlers used to support the "keys" |
|
|
219 |
attribute. |
|
|
220 |
</div> |
|
|
221 |
|
|
|
222 |
<div class="description"> |
|
|
223 |
|
|
|
224 |
|
|
|
225 |
<dl> |
|
|
226 |
<dt>Returns: |
|
|
227 |
<code property="yui:return"> |
|
|
228 |
void |
|
|
229 |
</code></dt> |
|
|
230 |
<dd property="yui:returnInfo"></dd> |
|
|
231 |
</dl> |
|
|
232 |
|
|
|
233 |
|
|
|
234 |
|
|
|
235 |
|
|
|
236 |
</div> |
|
|
237 |
|
|
|
238 |
</div> |
|
|
239 |
<hr /> |
|
|
240 |
</div> |
|
|
241 |
<div class="protected" rel="yui:method" resource="#method__focusNext"> |
|
|
242 |
<h4> |
|
|
243 |
<a name="method__focusNext">_focusNext</a></h4> |
|
|
244 |
<div class="detail" > |
|
|
245 |
<code> |
|
|
246 |
protected |
|
|
247 |
|
|
|
248 |
|
|
|
249 |
void |
|
|
250 |
<strong property="yui:name">_focusNext</strong> |
|
|
251 |
( |
|
|
252 |
|
|
|
253 |
|
|
|
254 |
event |
|
|
255 |
|
|
|
256 |
|
|
|
257 |
, |
|
|
258 |
activeDescendant |
|
|
259 |
|
|
|
260 |
|
|
|
261 |
) |
|
|
262 |
</code> |
|
|
263 |
|
|
|
264 |
<div class="description" property="yui:description"> |
|
|
265 |
Keydown event handler that moves focus to the next |
|
|
266 |
enabled descendant. |
|
|
267 |
</div> |
|
|
268 |
|
|
|
269 |
<div class="description"> |
|
|
270 |
|
|
|
271 |
<dl rel="yui:parameters"> |
|
|
272 |
<dt>Parameters:</dt> |
|
|
273 |
<dd rel="yui:parameter"> |
|
|
274 |
<code><span property="yui:name">event</span> |
|
|
275 |
<<span property="yui:type">Object</span>> |
|
|
276 |
</code> |
|
|
277 |
<span property="yui:description"> Object representing the DOM event.</span> |
|
|
278 |
</dd> |
|
|
279 |
<dd rel="yui:parameter"> |
|
|
280 |
<code><span property="yui:name">activeDescendant</span> |
|
|
281 |
<<span property="yui:type">Number</span>> |
|
|
282 |
</code> |
|
|
283 |
<span property="yui:description"> Number representing the index of the |
|
|
284 |
next descendant to be focused</span> |
|
|
285 |
</dd> |
|
|
286 |
</dl> |
|
|
287 |
|
|
|
288 |
<dl> |
|
|
289 |
<dt>Returns: |
|
|
290 |
<code property="yui:return"> |
|
|
291 |
void |
|
|
292 |
</code></dt> |
|
|
293 |
<dd property="yui:returnInfo"></dd> |
|
|
294 |
</dl> |
|
|
295 |
|
|
|
296 |
|
|
|
297 |
|
|
|
298 |
|
|
|
299 |
</div> |
|
|
300 |
|
|
|
301 |
</div> |
|
|
302 |
<hr /> |
|
|
303 |
</div> |
|
|
304 |
<div class="protected" rel="yui:method" resource="#method__focusPrevious"> |
|
|
305 |
<h4> |
|
|
306 |
<a name="method__focusPrevious">_focusPrevious</a></h4> |
|
|
307 |
<div class="detail" > |
|
|
308 |
<code> |
|
|
309 |
protected |
|
|
310 |
|
|
|
311 |
|
|
|
312 |
void |
|
|
313 |
<strong property="yui:name">_focusPrevious</strong> |
|
|
314 |
( |
|
|
315 |
|
|
|
316 |
|
|
|
317 |
event |
|
|
318 |
|
|
|
319 |
|
|
|
320 |
, |
|
|
321 |
activeDescendant |
|
|
322 |
|
|
|
323 |
|
|
|
324 |
) |
|
|
325 |
</code> |
|
|
326 |
|
|
|
327 |
<div class="description" property="yui:description"> |
|
|
328 |
Keydown event handler that moves focus to the previous |
|
|
329 |
enabled descendant. |
|
|
330 |
</div> |
|
|
331 |
|
|
|
332 |
<div class="description"> |
|
|
333 |
|
|
|
334 |
<dl rel="yui:parameters"> |
|
|
335 |
<dt>Parameters:</dt> |
|
|
336 |
<dd rel="yui:parameter"> |
|
|
337 |
<code><span property="yui:name">event</span> |
|
|
338 |
<<span property="yui:type">Object</span>> |
|
|
339 |
</code> |
|
|
340 |
<span property="yui:description"> Object representing the DOM event.</span> |
|
|
341 |
</dd> |
|
|
342 |
<dd rel="yui:parameter"> |
|
|
343 |
<code><span property="yui:name">activeDescendant</span> |
|
|
344 |
<<span property="yui:type">Number</span>> |
|
|
345 |
</code> |
|
|
346 |
<span property="yui:description"> Number representing the index of the |
|
|
347 |
next descendant to be focused.</span> |
|
|
348 |
</dd> |
|
|
349 |
</dl> |
|
|
350 |
|
|
|
351 |
<dl> |
|
|
352 |
<dt>Returns: |
|
|
353 |
<code property="yui:return"> |
|
|
354 |
void |
|
|
355 |
</code></dt> |
|
|
356 |
<dd property="yui:returnInfo"></dd> |
|
|
357 |
</dl> |
|
|
358 |
|
|
|
359 |
|
|
|
360 |
|
|
|
361 |
|
|
|
362 |
</div> |
|
|
363 |
|
|
|
364 |
</div> |
|
|
365 |
<hr /> |
|
|
366 |
</div> |
|
|
367 |
<div class="protected" rel="yui:method" resource="#method__initDescendants"> |
|
|
368 |
<h4> |
|
|
369 |
<a name="method__initDescendants">_initDescendants</a></h4> |
|
|
370 |
<div class="detail" > |
|
|
371 |
<code> |
|
|
372 |
protected |
|
|
373 |
|
|
|
374 |
|
|
|
375 |
void |
|
|
376 |
<strong property="yui:name">_initDescendants</strong> |
|
|
377 |
( |
|
|
378 |
) |
|
|
379 |
</code> |
|
|
380 |
|
|
|
381 |
<div class="description" property="yui:description"> |
|
|
382 |
Sets the <code>tabIndex</code> attribute of all of the |
|
|
383 |
descendants to -1, except the active descendant, whose |
|
|
384 |
<code>tabIndex</code> attribute is set to 0. |
|
|
385 |
</div> |
|
|
386 |
|
|
|
387 |
<div class="description"> |
|
|
388 |
|
|
|
389 |
|
|
|
390 |
<dl> |
|
|
391 |
<dt>Returns: |
|
|
392 |
<code property="yui:return"> |
|
|
393 |
void |
|
|
394 |
</code></dt> |
|
|
395 |
<dd property="yui:returnInfo"></dd> |
|
|
396 |
</dl> |
|
|
397 |
|
|
|
398 |
|
|
|
399 |
|
|
|
400 |
|
|
|
401 |
</div> |
|
|
402 |
|
|
|
403 |
</div> |
|
|
404 |
<hr /> |
|
|
405 |
</div> |
|
|
406 |
<div class="protected" rel="yui:method" resource="#method__isDescendant"> |
|
|
407 |
<h4> |
|
|
408 |
<a name="method__isDescendant">_isDescendant</a></h4> |
|
|
409 |
<div class="detail" > |
|
|
410 |
<code> |
|
|
411 |
protected |
|
|
412 |
|
|
|
413 |
|
|
|
414 |
Boolean |
|
|
415 |
<strong property="yui:name">_isDescendant</strong> |
|
|
416 |
( |
|
|
417 |
|
|
|
418 |
|
|
|
419 |
node |
|
|
420 |
|
|
|
421 |
|
|
|
422 |
) |
|
|
423 |
</code> |
|
|
424 |
|
|
|
425 |
<div class="description" property="yui:description"> |
|
|
426 |
Determines if the specified Node instance is a descendant |
|
|
427 |
managed by the Focus Manager. |
|
|
428 |
</div> |
|
|
429 |
|
|
|
430 |
<div class="description"> |
|
|
431 |
|
|
|
432 |
<dl rel="yui:parameters"> |
|
|
433 |
<dt>Parameters:</dt> |
|
|
434 |
<dd rel="yui:parameter"> |
|
|
435 |
<code><span property="yui:name">node</span> |
|
|
436 |
<<span property="yui:type">Node</span>> |
|
|
437 |
</code> |
|
|
438 |
<span property="yui:description"> Node instance to be checked.</span> |
|
|
439 |
</dd> |
|
|
440 |
</dl> |
|
|
441 |
|
|
|
442 |
<dl> |
|
|
443 |
<dt>Returns: |
|
|
444 |
<code property="yui:return"> |
|
|
445 |
Boolean |
|
|
446 |
</code></dt> |
|
|
447 |
<dd property="yui:returnInfo">Boolean indicating if the specified Node instance is a |
|
|
448 |
descendant managed by the Focus Manager.</dd> |
|
|
449 |
</dl> |
|
|
450 |
|
|
|
451 |
|
|
|
452 |
|
|
|
453 |
|
|
|
454 |
</div> |
|
|
455 |
|
|
|
456 |
</div> |
|
|
457 |
<hr /> |
|
|
458 |
</div> |
|
|
459 |
<div class="protected" rel="yui:method" resource="#method__onDocFocus"> |
|
|
460 |
<h4> |
|
|
461 |
<a name="method__onDocFocus">_onDocFocus</a></h4> |
|
|
462 |
<div class="detail" > |
|
|
463 |
<code> |
|
|
464 |
protected |
|
|
465 |
|
|
|
466 |
|
|
|
467 |
void |
|
|
468 |
<strong property="yui:name">_onDocFocus</strong> |
|
|
469 |
( |
|
|
470 |
|
|
|
471 |
|
|
|
472 |
event |
|
|
473 |
|
|
|
474 |
|
|
|
475 |
) |
|
|
476 |
</code> |
|
|
477 |
|
|
|
478 |
<div class="description" property="yui:description"> |
|
|
479 |
"focus" event handler for the owner document of the |
|
|
480 |
Focus Manager's Node. |
|
|
481 |
</div> |
|
|
482 |
|
|
|
483 |
<div class="description"> |
|
|
484 |
|
|
|
485 |
<dl rel="yui:parameters"> |
|
|
486 |
<dt>Parameters:</dt> |
|
|
487 |
<dd rel="yui:parameter"> |
|
|
488 |
<code><span property="yui:name">event</span> |
|
|
489 |
<<span property="yui:type">Object</span>> |
|
|
490 |
</code> |
|
|
491 |
<span property="yui:description"> Object representing the DOM event.</span> |
|
|
492 |
</dd> |
|
|
493 |
</dl> |
|
|
494 |
|
|
|
495 |
<dl> |
|
|
496 |
<dt>Returns: |
|
|
497 |
<code property="yui:return"> |
|
|
498 |
void |
|
|
499 |
</code></dt> |
|
|
500 |
<dd property="yui:returnInfo"></dd> |
|
|
501 |
</dl> |
|
|
502 |
|
|
|
503 |
|
|
|
504 |
|
|
|
505 |
|
|
|
506 |
</div> |
|
|
507 |
|
|
|
508 |
</div> |
|
|
509 |
<hr /> |
|
|
510 |
</div> |
|
|
511 |
<div class="protected" rel="yui:method" resource="#method__onDocMouseDown"> |
|
|
512 |
<h4> |
|
|
513 |
<a name="method__onDocMouseDown">_onDocMouseDown</a></h4> |
|
|
514 |
<div class="detail" > |
|
|
515 |
<code> |
|
|
516 |
protected |
|
|
517 |
|
|
|
518 |
|
|
|
519 |
void |
|
|
520 |
<strong property="yui:name">_onDocMouseDown</strong> |
|
|
521 |
( |
|
|
522 |
|
|
|
523 |
|
|
|
524 |
event |
|
|
525 |
|
|
|
526 |
|
|
|
527 |
) |
|
|
528 |
</code> |
|
|
529 |
|
|
|
530 |
<div class="description" property="yui:description"> |
|
|
531 |
"mousedown" event handler for the owner document of the |
|
|
532 |
Focus Manager's Node. |
|
|
533 |
</div> |
|
|
534 |
|
|
|
535 |
<div class="description"> |
|
|
536 |
|
|
|
537 |
<dl rel="yui:parameters"> |
|
|
538 |
<dt>Parameters:</dt> |
|
|
539 |
<dd rel="yui:parameter"> |
|
|
540 |
<code><span property="yui:name">event</span> |
|
|
541 |
<<span property="yui:type">Object</span>> |
|
|
542 |
</code> |
|
|
543 |
<span property="yui:description"> Object representing the DOM event.</span> |
|
|
544 |
</dd> |
|
|
545 |
</dl> |
|
|
546 |
|
|
|
547 |
<dl> |
|
|
548 |
<dt>Returns: |
|
|
549 |
<code property="yui:return"> |
|
|
550 |
void |
|
|
551 |
</code></dt> |
|
|
552 |
<dd property="yui:returnInfo"></dd> |
|
|
553 |
</dl> |
|
|
554 |
|
|
|
555 |
|
|
|
556 |
|
|
|
557 |
|
|
|
558 |
</div> |
|
|
559 |
|
|
|
560 |
</div> |
|
|
561 |
<hr /> |
|
|
562 |
</div> |
|
|
563 |
<div class="protected" rel="yui:method" resource="#method__preventScroll"> |
|
|
564 |
<h4> |
|
|
565 |
<a name="method__preventScroll">_preventScroll</a></h4> |
|
|
566 |
<div class="detail" > |
|
|
567 |
<code> |
|
|
568 |
protected |
|
|
569 |
|
|
|
570 |
|
|
|
571 |
void |
|
|
572 |
<strong property="yui:name">_preventScroll</strong> |
|
|
573 |
( |
|
|
574 |
) |
|
|
575 |
</code> |
|
|
576 |
|
|
|
577 |
<div class="description" property="yui:description"> |
|
|
578 |
Prevents the viewport from scolling when the user presses |
|
|
579 |
the up, down, left, or right key. |
|
|
580 |
</div> |
|
|
581 |
|
|
|
582 |
<div class="description"> |
|
|
583 |
|
|
|
584 |
|
|
|
585 |
<dl> |
|
|
586 |
<dt>Returns: |
|
|
587 |
<code property="yui:return"> |
|
|
588 |
void |
|
|
589 |
</code></dt> |
|
|
590 |
<dd property="yui:returnInfo"></dd> |
|
|
591 |
</dl> |
|
|
592 |
|
|
|
593 |
|
|
|
594 |
|
|
|
595 |
|
|
|
596 |
</div> |
|
|
597 |
|
|
|
598 |
</div> |
|
|
599 |
<hr /> |
|
|
600 |
</div> |
|
|
601 |
<div class="protected" rel="yui:method" resource="#method__removeFocusClass"> |
|
|
602 |
<h4> |
|
|
603 |
<a name="method__removeFocusClass">_removeFocusClass</a></h4> |
|
|
604 |
<div class="detail" > |
|
|
605 |
<code> |
|
|
606 |
protected |
|
|
607 |
|
|
|
608 |
|
|
|
609 |
void |
|
|
610 |
<strong property="yui:name">_removeFocusClass</strong> |
|
|
611 |
( |
|
|
612 |
) |
|
|
613 |
</code> |
|
|
614 |
|
|
|
615 |
<div class="description" property="yui:description"> |
|
|
616 |
Removes the class name representing focus (as specified by |
|
|
617 |
the "focusClass" attribute) from the Node instance to which it is |
|
|
618 |
currently applied. |
|
|
619 |
</div> |
|
|
620 |
|
|
|
621 |
<div class="description"> |
|
|
622 |
|
|
|
623 |
|
|
|
624 |
<dl> |
|
|
625 |
<dt>Returns: |
|
|
626 |
<code property="yui:return"> |
|
|
627 |
void |
|
|
628 |
</code></dt> |
|
|
629 |
<dd property="yui:returnInfo"></dd> |
|
|
630 |
</dl> |
|
|
631 |
|
|
|
632 |
|
|
|
633 |
|
|
|
634 |
|
|
|
635 |
</div> |
|
|
636 |
|
|
|
637 |
</div> |
|
|
638 |
<hr /> |
|
|
639 |
</div> |
|
|
640 |
<div class="" rel="yui:method" resource="#method_blur"> |
|
|
641 |
<h4> |
|
|
642 |
<a name="method_blur">blur</a></h4> |
|
|
643 |
<div class="detail" > |
|
|
644 |
<code> |
|
|
645 |
|
|
|
646 |
|
|
|
647 |
|
|
|
648 |
void |
|
|
649 |
<strong property="yui:name">blur</strong> |
|
|
650 |
( |
|
|
651 |
) |
|
|
652 |
</code> |
|
|
653 |
|
|
|
654 |
<div class="description" property="yui:description"> |
|
|
655 |
Blurs the current active descendant and sets the |
|
|
656 |
<code>focused</code> attribute to false. |
|
|
657 |
</div> |
|
|
658 |
|
|
|
659 |
<div class="description"> |
|
|
660 |
|
|
|
661 |
|
|
|
662 |
<dl> |
|
|
663 |
<dt>Returns: |
|
|
664 |
<code property="yui:return"> |
|
|
665 |
void |
|
|
666 |
</code></dt> |
|
|
667 |
<dd property="yui:returnInfo"></dd> |
|
|
668 |
</dl> |
|
|
669 |
|
|
|
670 |
|
|
|
671 |
|
|
|
672 |
|
|
|
673 |
</div> |
|
|
674 |
|
|
|
675 |
</div> |
|
|
676 |
<hr /> |
|
|
677 |
</div> |
|
|
678 |
<div class="" rel="yui:method" resource="#method_focus"> |
|
|
679 |
<h4> |
|
|
680 |
<a name="method_focus">focus</a></h4> |
|
|
681 |
<div class="detail" > |
|
|
682 |
<code> |
|
|
683 |
|
|
|
684 |
|
|
|
685 |
|
|
|
686 |
void |
|
|
687 |
<strong property="yui:name">focus</strong> |
|
|
688 |
( |
|
|
689 |
|
|
|
690 |
|
|
|
691 |
index |
|
|
692 |
|
|
|
693 |
|
|
|
694 |
|
|
|
695 |
|
|
|
696 |
) |
|
|
697 |
</code> |
|
|
698 |
|
|
|
699 |
<div class="description" property="yui:description"> |
|
|
700 |
Focuses the active descendant and sets the |
|
|
701 |
<code>focused</code> attribute to true. |
|
|
702 |
</div> |
|
|
703 |
|
|
|
704 |
<div class="description"> |
|
|
705 |
|
|
|
706 |
<dl rel="yui:parameters"> |
|
|
707 |
<dt>Parameters:</dt> |
|
|
708 |
<dd rel="yui:parameter"> |
|
|
709 |
<code><span property="yui:name">index</span> |
|
|
710 |
<<span property="yui:type">Number</span>> |
|
|
711 |
</code> |
|
|
712 |
<span property="yui:description"> Optional. Number representing the index of the |
|
|
713 |
descendant to be set as the active descendant.</span> |
|
|
714 |
</dd> |
|
|
715 |
<dd rel="yui:parameter"> |
|
|
716 |
<code><span property="yui:name">index</span> |
|
|
717 |
<<span property="yui:type">Node</span>> |
|
|
718 |
</code> |
|
|
719 |
<span property="yui:description"> Optional. Node instance representing the |
|
|
720 |
descendant to be set as the active descendant.</span> |
|
|
721 |
</dd> |
|
|
722 |
</dl> |
|
|
723 |
|
|
|
724 |
<dl> |
|
|
725 |
<dt>Returns: |
|
|
726 |
<code property="yui:return"> |
|
|
727 |
void |
|
|
728 |
</code></dt> |
|
|
729 |
<dd property="yui:returnInfo"></dd> |
|
|
730 |
</dl> |
|
|
731 |
|
|
|
732 |
|
|
|
733 |
|
|
|
734 |
|
|
|
735 |
</div> |
|
|
736 |
|
|
|
737 |
</div> |
|
|
738 |
<hr /> |
|
|
739 |
</div> |
|
|
740 |
<div class="" rel="yui:method" resource="#method_refresh"> |
|
|
741 |
<h4> |
|
|
742 |
<a name="method_refresh">refresh</a></h4> |
|
|
743 |
<div class="detail" > |
|
|
744 |
<code> |
|
|
745 |
|
|
|
746 |
|
|
|
747 |
|
|
|
748 |
void |
|
|
749 |
<strong property="yui:name">refresh</strong> |
|
|
750 |
( |
|
|
751 |
) |
|
|
752 |
</code> |
|
|
753 |
|
|
|
754 |
<div class="description" property="yui:description"> |
|
|
755 |
Refreshes the Focus Manager's descendants by re-executing the |
|
|
756 |
CSS selector query specified by the <code>descendants</code> attribute. |
|
|
757 |
</div> |
|
|
758 |
|
|
|
759 |
<div class="description"> |
|
|
760 |
|
|
|
761 |
|
|
|
762 |
<dl> |
|
|
763 |
<dt>Returns: |
|
|
764 |
<code property="yui:return"> |
|
|
765 |
void |
|
|
766 |
</code></dt> |
|
|
767 |
<dd property="yui:returnInfo"></dd> |
|
|
768 |
</dl> |
|
|
769 |
|
|
|
770 |
|
|
|
771 |
|
|
|
772 |
|
|
|
773 |
</div> |
|
|
774 |
|
|
|
775 |
</div> |
|
|
776 |
<hr /> |
|
|
777 |
</div> |
|
|
778 |
<div class="" rel="yui:method" resource="#method_start"> |
|
|
779 |
<h4> |
|
|
780 |
<a name="method_start">start</a></h4> |
|
|
781 |
<div class="detail" > |
|
|
782 |
<code> |
|
|
783 |
|
|
|
784 |
|
|
|
785 |
|
|
|
786 |
void |
|
|
787 |
<strong property="yui:name">start</strong> |
|
|
788 |
( |
|
|
789 |
) |
|
|
790 |
</code> |
|
|
791 |
|
|
|
792 |
<div class="description" property="yui:description"> |
|
|
793 |
Enables the Focus Manager. |
|
|
794 |
</div> |
|
|
795 |
|
|
|
796 |
<div class="description"> |
|
|
797 |
|
|
|
798 |
|
|
|
799 |
<dl> |
|
|
800 |
<dt>Returns: |
|
|
801 |
<code property="yui:return"> |
|
|
802 |
void |
|
|
803 |
</code></dt> |
|
|
804 |
<dd property="yui:returnInfo"></dd> |
|
|
805 |
</dl> |
|
|
806 |
|
|
|
807 |
|
|
|
808 |
|
|
|
809 |
|
|
|
810 |
</div> |
|
|
811 |
|
|
|
812 |
</div> |
|
|
813 |
<hr /> |
|
|
814 |
</div> |
|
|
815 |
<div class="" rel="yui:method" resource="#method_stop"> |
|
|
816 |
<h4> |
|
|
817 |
<a name="method_stop">stop</a></h4> |
|
|
818 |
<div class="detail" > |
|
|
819 |
<code> |
|
|
820 |
|
|
|
821 |
|
|
|
822 |
|
|
|
823 |
void |
|
|
824 |
<strong property="yui:name">stop</strong> |
|
|
825 |
( |
|
|
826 |
) |
|
|
827 |
</code> |
|
|
828 |
|
|
|
829 |
<div class="description" property="yui:description"> |
|
|
830 |
Disables the Focus Manager by detaching all event handlers. |
|
|
831 |
</div> |
|
|
832 |
|
|
|
833 |
<div class="description"> |
|
|
834 |
|
|
|
835 |
|
|
|
836 |
<dl> |
|
|
837 |
<dt>Returns: |
|
|
838 |
<code property="yui:return"> |
|
|
839 |
void |
|
|
840 |
</code></dt> |
|
|
841 |
<dd property="yui:returnInfo"></dd> |
|
|
842 |
</dl> |
|
|
843 |
|
|
|
844 |
|
|
|
845 |
|
|
|
846 |
|
|
|
847 |
</div> |
|
|
848 |
|
|
|
849 |
</div> |
|
|
850 |
<hr /> |
|
|
851 |
</div> |
|
|
852 |
</div> |
|
|
853 |
</div> |
|
|
854 |
|
|
|
855 |
</div> |
|
|
856 |
|
|
|
857 |
<div rel="yui:events" resource="#events"> |
|
|
858 |
<div class="section method details"> |
|
|
859 |
<h3 id="events">Events</h3> |
|
|
860 |
<div class="content"> |
|
|
861 |
<div class="" rel="yui:event" resource="#event_activeDescendantChange"> |
|
|
862 |
<h4> |
|
|
863 |
<a name="event_activeDescendantChange">activeDescendantChange</a></h4> |
|
|
864 |
<div class="detail"> |
|
|
865 |
<code> |
|
|
866 |
|
|
|
867 |
|
|
|
868 |
|
|
|
869 |
<strong property="yui:name">activeDescendantChange</strong> |
|
|
870 |
|
|
|
871 |
( |
|
|
872 |
|
|
|
873 |
|
|
|
874 |
event |
|
|
875 |
|
|
|
876 |
|
|
|
877 |
) |
|
|
878 |
|
|
|
879 |
</code> |
|
|
880 |
|
|
|
881 |
<div class="description" property="yui:description"> |
|
|
882 |
Fires when the value for the configuration attribute 'activeDescendant' is changed. You can listen for the event using the <a href="Attribute.html#method_on">on</a> method if you wish to be notified before the attribute's value has changed, or using the <a href="Event.Target.html#method_after">after</a> method if you wish to be notified after the attribute's value has changed. |
|
|
883 |
</div> |
|
|
884 |
|
|
|
885 |
<div class="description"> |
|
|
886 |
|
|
|
887 |
|
|
|
888 |
<dl rel="yui:parameters"> |
|
|
889 |
<dt>Parameters:</dt> |
|
|
890 |
<dd rel="yui:parameter"> |
|
|
891 |
<code><span property="yui:name">event</span> |
|
|
892 |
<<span property="yui:type">Event.Facade</span>> |
|
|
893 |
</code> |
|
|
894 |
<span property="yui:description">An Event Facade object with the following attribute specific properties added: <dl> <dt>prevVal</dt> <dd>The value of the attribute, prior to it being set</dd> <dt>newVal</dt> <dd>The value the attribute is to be set to</dd> <dt>attrName</dt> <dd>The name of the attribute being set</dd> <dt>subAttrName</dt> <dd>If setting a property within the attribute's value, the name of the sub-attribute property being set</dd> </dl></span> |
|
|
895 |
</dd> |
|
|
896 |
|
|
|
897 |
</dl> |
|
|
898 |
|
|
|
899 |
|
|
|
900 |
</div> |
|
|
901 |
|
|
|
902 |
</div> |
|
|
903 |
<hr /> |
|
|
904 |
</div> |
|
|
905 |
<div class="" rel="yui:event" resource="#event_circularChange"> |
|
|
906 |
<h4> |
|
|
907 |
<a name="event_circularChange">circularChange</a></h4> |
|
|
908 |
<div class="detail"> |
|
|
909 |
<code> |
|
|
910 |
|
|
|
911 |
|
|
|
912 |
|
|
|
913 |
<strong property="yui:name">circularChange</strong> |
|
|
914 |
|
|
|
915 |
( |
|
|
916 |
|
|
|
917 |
|
|
|
918 |
event |
|
|
919 |
|
|
|
920 |
|
|
|
921 |
) |
|
|
922 |
|
|
|
923 |
</code> |
|
|
924 |
|
|
|
925 |
<div class="description" property="yui:description"> |
|
|
926 |
Fires when the value for the configuration attribute 'circular' is changed. You can listen for the event using the <a href="Attribute.html#method_on">on</a> method if you wish to be notified before the attribute's value has changed, or using the <a href="Event.Target.html#method_after">after</a> method if you wish to be notified after the attribute's value has changed. |
|
|
927 |
</div> |
|
|
928 |
|
|
|
929 |
<div class="description"> |
|
|
930 |
|
|
|
931 |
|
|
|
932 |
<dl rel="yui:parameters"> |
|
|
933 |
<dt>Parameters:</dt> |
|
|
934 |
<dd rel="yui:parameter"> |
|
|
935 |
<code><span property="yui:name">event</span> |
|
|
936 |
<<span property="yui:type">Event.Facade</span>> |
|
|
937 |
</code> |
|
|
938 |
<span property="yui:description">An Event Facade object with the following attribute specific properties added: <dl> <dt>prevVal</dt> <dd>The value of the attribute, prior to it being set</dd> <dt>newVal</dt> <dd>The value the attribute is to be set to</dd> <dt>attrName</dt> <dd>The name of the attribute being set</dd> <dt>subAttrName</dt> <dd>If setting a property within the attribute's value, the name of the sub-attribute property being set</dd> </dl></span> |
|
|
939 |
</dd> |
|
|
940 |
|
|
|
941 |
</dl> |
|
|
942 |
|
|
|
943 |
|
|
|
944 |
</div> |
|
|
945 |
|
|
|
946 |
</div> |
|
|
947 |
<hr /> |
|
|
948 |
</div> |
|
|
949 |
<div class="" rel="yui:event" resource="#event_descendantsChange"> |
|
|
950 |
<h4> |
|
|
951 |
<a name="event_descendantsChange">descendantsChange</a></h4> |
|
|
952 |
<div class="detail"> |
|
|
953 |
<code> |
|
|
954 |
|
|
|
955 |
|
|
|
956 |
|
|
|
957 |
<strong property="yui:name">descendantsChange</strong> |
|
|
958 |
|
|
|
959 |
( |
|
|
960 |
|
|
|
961 |
|
|
|
962 |
event |
|
|
963 |
|
|
|
964 |
|
|
|
965 |
) |
|
|
966 |
|
|
|
967 |
</code> |
|
|
968 |
|
|
|
969 |
<div class="description" property="yui:description"> |
|
|
970 |
Fires when the value for the configuration attribute 'descendants' is changed. You can listen for the event using the <a href="Attribute.html#method_on">on</a> method if you wish to be notified before the attribute's value has changed, or using the <a href="Event.Target.html#method_after">after</a> method if you wish to be notified after the attribute's value has changed. |
|
|
971 |
</div> |
|
|
972 |
|
|
|
973 |
<div class="description"> |
|
|
974 |
|
|
|
975 |
|
|
|
976 |
<dl rel="yui:parameters"> |
|
|
977 |
<dt>Parameters:</dt> |
|
|
978 |
<dd rel="yui:parameter"> |
|
|
979 |
<code><span property="yui:name">event</span> |
|
|
980 |
<<span property="yui:type">Event.Facade</span>> |
|
|
981 |
</code> |
|
|
982 |
<span property="yui:description">An Event Facade object with the following attribute specific properties added: <dl> <dt>prevVal</dt> <dd>The value of the attribute, prior to it being set</dd> <dt>newVal</dt> <dd>The value the attribute is to be set to</dd> <dt>attrName</dt> <dd>The name of the attribute being set</dd> <dt>subAttrName</dt> <dd>If setting a property within the attribute's value, the name of the sub-attribute property being set</dd> </dl></span> |
|
|
983 |
</dd> |
|
|
984 |
|
|
|
985 |
</dl> |
|
|
986 |
|
|
|
987 |
|
|
|
988 |
</div> |
|
|
989 |
|
|
|
990 |
</div> |
|
|
991 |
<hr /> |
|
|
992 |
</div> |
|
|
993 |
<div class="" rel="yui:event" resource="#event_focusClassChange"> |
|
|
994 |
<h4> |
|
|
995 |
<a name="event_focusClassChange">focusClassChange</a></h4> |
|
|
996 |
<div class="detail"> |
|
|
997 |
<code> |
|
|
998 |
|
|
|
999 |
|
|
|
1000 |
|
|
|
1001 |
<strong property="yui:name">focusClassChange</strong> |
|
|
1002 |
|
|
|
1003 |
( |
|
|
1004 |
|
|
|
1005 |
|
|
|
1006 |
event |
|
|
1007 |
|
|
|
1008 |
|
|
|
1009 |
) |
|
|
1010 |
|
|
|
1011 |
</code> |
|
|
1012 |
|
|
|
1013 |
<div class="description" property="yui:description"> |
|
|
1014 |
Fires when the value for the configuration attribute 'focusClass' is changed. You can listen for the event using the <a href="Attribute.html#method_on">on</a> method if you wish to be notified before the attribute's value has changed, or using the <a href="Event.Target.html#method_after">after</a> method if you wish to be notified after the attribute's value has changed. |
|
|
1015 |
</div> |
|
|
1016 |
|
|
|
1017 |
<div class="description"> |
|
|
1018 |
|
|
|
1019 |
|
|
|
1020 |
<dl rel="yui:parameters"> |
|
|
1021 |
<dt>Parameters:</dt> |
|
|
1022 |
<dd rel="yui:parameter"> |
|
|
1023 |
<code><span property="yui:name">event</span> |
|
|
1024 |
<<span property="yui:type">Event.Facade</span>> |
|
|
1025 |
</code> |
|
|
1026 |
<span property="yui:description">An Event Facade object with the following attribute specific properties added: <dl> <dt>prevVal</dt> <dd>The value of the attribute, prior to it being set</dd> <dt>newVal</dt> <dd>The value the attribute is to be set to</dd> <dt>attrName</dt> <dd>The name of the attribute being set</dd> <dt>subAttrName</dt> <dd>If setting a property within the attribute's value, the name of the sub-attribute property being set</dd> </dl></span> |
|
|
1027 |
</dd> |
|
|
1028 |
|
|
|
1029 |
</dl> |
|
|
1030 |
|
|
|
1031 |
|
|
|
1032 |
</div> |
|
|
1033 |
|
|
|
1034 |
</div> |
|
|
1035 |
<hr /> |
|
|
1036 |
</div> |
|
|
1037 |
<div class="" rel="yui:event" resource="#event_focusedChange"> |
|
|
1038 |
<h4> |
|
|
1039 |
<a name="event_focusedChange">focusedChange</a></h4> |
|
|
1040 |
<div class="detail"> |
|
|
1041 |
<code> |
|
|
1042 |
|
|
|
1043 |
|
|
|
1044 |
|
|
|
1045 |
<strong property="yui:name">focusedChange</strong> |
|
|
1046 |
|
|
|
1047 |
( |
|
|
1048 |
|
|
|
1049 |
|
|
|
1050 |
event |
|
|
1051 |
|
|
|
1052 |
|
|
|
1053 |
) |
|
|
1054 |
|
|
|
1055 |
</code> |
|
|
1056 |
|
|
|
1057 |
<div class="description" property="yui:description"> |
|
|
1058 |
Fires when the value for the configuration attribute 'focused' is changed. You can listen for the event using the <a href="Attribute.html#method_on">on</a> method if you wish to be notified before the attribute's value has changed, or using the <a href="Event.Target.html#method_after">after</a> method if you wish to be notified after the attribute's value has changed. |
|
|
1059 |
</div> |
|
|
1060 |
|
|
|
1061 |
<div class="description"> |
|
|
1062 |
|
|
|
1063 |
|
|
|
1064 |
<dl rel="yui:parameters"> |
|
|
1065 |
<dt>Parameters:</dt> |
|
|
1066 |
<dd rel="yui:parameter"> |
|
|
1067 |
<code><span property="yui:name">event</span> |
|
|
1068 |
<<span property="yui:type">Event.Facade</span>> |
|
|
1069 |
</code> |
|
|
1070 |
<span property="yui:description">An Event Facade object with the following attribute specific properties added: <dl> <dt>prevVal</dt> <dd>The value of the attribute, prior to it being set</dd> <dt>newVal</dt> <dd>The value the attribute is to be set to</dd> <dt>attrName</dt> <dd>The name of the attribute being set</dd> <dt>subAttrName</dt> <dd>If setting a property within the attribute's value, the name of the sub-attribute property being set</dd> </dl></span> |
|
|
1071 |
</dd> |
|
|
1072 |
|
|
|
1073 |
</dl> |
|
|
1074 |
|
|
|
1075 |
|
|
|
1076 |
</div> |
|
|
1077 |
|
|
|
1078 |
</div> |
|
|
1079 |
<hr /> |
|
|
1080 |
</div> |
|
|
1081 |
<div class="" rel="yui:event" resource="#event_keysChange"> |
|
|
1082 |
<h4> |
|
|
1083 |
<a name="event_keysChange">keysChange</a></h4> |
|
|
1084 |
<div class="detail"> |
|
|
1085 |
<code> |
|
|
1086 |
|
|
|
1087 |
|
|
|
1088 |
|
|
|
1089 |
<strong property="yui:name">keysChange</strong> |
|
|
1090 |
|
|
|
1091 |
( |
|
|
1092 |
|
|
|
1093 |
|
|
|
1094 |
event |
|
|
1095 |
|
|
|
1096 |
|
|
|
1097 |
) |
|
|
1098 |
|
|
|
1099 |
</code> |
|
|
1100 |
|
|
|
1101 |
<div class="description" property="yui:description"> |
|
|
1102 |
Fires when the value for the configuration attribute 'keys' is changed. You can listen for the event using the <a href="Attribute.html#method_on">on</a> method if you wish to be notified before the attribute's value has changed, or using the <a href="Event.Target.html#method_after">after</a> method if you wish to be notified after the attribute's value has changed. |
|
|
1103 |
</div> |
|
|
1104 |
|
|
|
1105 |
<div class="description"> |
|
|
1106 |
|
|
|
1107 |
|
|
|
1108 |
<dl rel="yui:parameters"> |
|
|
1109 |
<dt>Parameters:</dt> |
|
|
1110 |
<dd rel="yui:parameter"> |
|
|
1111 |
<code><span property="yui:name">event</span> |
|
|
1112 |
<<span property="yui:type">Event.Facade</span>> |
|
|
1113 |
</code> |
|
|
1114 |
<span property="yui:description">An Event Facade object with the following attribute specific properties added: <dl> <dt>prevVal</dt> <dd>The value of the attribute, prior to it being set</dd> <dt>newVal</dt> <dd>The value the attribute is to be set to</dd> <dt>attrName</dt> <dd>The name of the attribute being set</dd> <dt>subAttrName</dt> <dd>If setting a property within the attribute's value, the name of the sub-attribute property being set</dd> </dl></span> |
|
|
1115 |
</dd> |
|
|
1116 |
|
|
|
1117 |
</dl> |
|
|
1118 |
|
|
|
1119 |
|
|
|
1120 |
</div> |
|
|
1121 |
|
|
|
1122 |
</div> |
|
|
1123 |
<hr /> |
|
|
1124 |
</div> |
|
|
1125 |
</div> |
|
|
1126 |
</div> |
|
|
1127 |
|
|
|
1128 |
|
|
|
1129 |
</div> |
|
|
1130 |
|
|
|
1131 |
<div rel="yui:attributes" resource="#configattributes"> |
|
|
1132 |
<div class="section field details"> |
|
|
1133 |
<h3 id="configattributes">Configuration Attributes</h3> |
|
|
1134 |
<div class="content"> |
|
|
1135 |
<div class="" rel="yui:attribute" resource="#config_activeDescendant"> |
|
|
1136 |
<h4><a name="config_activeDescendant">activeDescendant</a> |
|
|
1137 |
<code>- <span property="yui:type">Number</span></code> |
|
|
1138 |
</h4> |
|
|
1139 |
<div class="detail"> |
|
|
1140 |
<div class="description" property="yui:description"> |
|
|
1141 |
<p>Node, or index of the Node, representing the descendant that is either |
|
|
1142 |
focused or is focusable (<code>tabIndex</code> attribute is set to 0). |
|
|
1143 |
The value cannot represent a disabled descendant Node. Use a value of -1 |
|
|
1144 |
to remove all descendant Nodes from the default tab flow. |
|
|
1145 |
If no value is specified, the active descendant will be inferred using |
|
|
1146 |
the following criteria:</p> |
|
|
1147 |
<ol> |
|
|
1148 |
<li>Examining the <code>tabIndex</code> attribute of each descendant and |
|
|
1149 |
using the first descendant whose <code>tabIndex</code> attribute is set |
|
|
1150 |
to 0</li> |
|
|
1151 |
<li>If no default can be inferred then the value is set to either 0 or |
|
|
1152 |
the index of the first enabled descendant.</li> |
|
|
1153 |
</ol> |
|
|
1154 |
</div> |
|
|
1155 |
</div> |
|
|
1156 |
|
|
|
1157 |
|
|
|
1158 |
|
|
|
1159 |
<hr /> |
|
|
1160 |
</div> |
|
|
1161 |
<div class="" rel="yui:attribute" resource="#config_circular"> |
|
|
1162 |
<h4><a name="config_circular">circular</a> |
|
|
1163 |
<code>- <span property="yui:type">Boolean</span></code> |
|
|
1164 |
</h4> |
|
|
1165 |
<div class="detail"> |
|
|
1166 |
<div class="description" property="yui:description"> |
|
|
1167 |
Boolean indicating if focus should be set to the first/last descendant |
|
|
1168 |
when the end or beginning of the descendants has been reached. |
|
|
1169 |
</div> |
|
|
1170 |
</div> |
|
|
1171 |
|
|
|
1172 |
|
|
|
1173 |
|
|
|
1174 |
<hr /> |
|
|
1175 |
</div> |
|
|
1176 |
<div class="" rel="yui:attribute" resource="#config_descendants"> |
|
|
1177 |
<h4><a name="config_descendants">descendants</a> |
|
|
1178 |
<code>- <span property="yui:type">Y.NodeList</span></code> |
|
|
1179 |
</h4> |
|
|
1180 |
<div class="detail"> |
|
|
1181 |
<div class="description" property="yui:description"> |
|
|
1182 |
String representing the CSS selector used to define the descendant Nodes |
|
|
1183 |
whose focus should be managed. |
|
|
1184 |
</div> |
|
|
1185 |
</div> |
|
|
1186 |
|
|
|
1187 |
|
|
|
1188 |
|
|
|
1189 |
<hr /> |
|
|
1190 |
</div> |
|
|
1191 |
<div class="" rel="yui:attribute" resource="#config_focusClass"> |
|
|
1192 |
<h4><a name="config_focusClass">focusClass</a> |
|
|
1193 |
<code>- <span property="yui:type">String|Object</span></code> |
|
|
1194 |
</h4> |
|
|
1195 |
<div class="detail"> |
|
|
1196 |
<div class="description" property="yui:description"> |
|
|
1197 |
String representing the name of class applied to the focused active |
|
|
1198 |
descendant Node. Can also be an object literal used to define both the |
|
|
1199 |
class name, and the Node to which the class should be applied. If using |
|
|
1200 |
an object literal, the format is: |
|
|
1201 |
<code>{ className: "focus", fn: myFunction }</code>. The function |
|
|
1202 |
referenced by the <code>fn</code> property in the object literal will be |
|
|
1203 |
passed a reference to the currently focused active descendant Node. |
|
|
1204 |
</div> |
|
|
1205 |
</div> |
|
|
1206 |
|
|
|
1207 |
|
|
|
1208 |
|
|
|
1209 |
<hr /> |
|
|
1210 |
</div> |
|
|
1211 |
<div class="" rel="yui:attribute" resource="#config_focused"> |
|
|
1212 |
<h4><a name="config_focused">focused</a> |
|
|
1213 |
<code>- <span property="yui:type">boolean</span></code> |
|
|
1214 |
</h4> |
|
|
1215 |
<div class="detail"> |
|
|
1216 |
<div class="description" property="yui:description"> |
|
|
1217 |
Boolean indicating that one of the descendants is focused. |
|
|
1218 |
</div> |
|
|
1219 |
</div> |
|
|
1220 |
|
|
|
1221 |
|
|
|
1222 |
<div class="default"> |
|
|
1223 |
Default Value: false |
|
|
1224 |
</div> |
|
|
1225 |
|
|
|
1226 |
<hr /> |
|
|
1227 |
</div> |
|
|
1228 |
<div class="" rel="yui:attribute" resource="#config_keys"> |
|
|
1229 |
<h4><a name="config_keys">keys</a> |
|
|
1230 |
<code>- <span property="yui:type">Object</span></code> |
|
|
1231 |
</h4> |
|
|
1232 |
<div class="detail"> |
|
|
1233 |
<div class="description" property="yui:description"> |
|
|
1234 |
Object literal representing the keys to be used to navigate between the |
|
|
1235 |
next/previous descendant. The format for the attribute's value is |
|
|
1236 |
<code>{ next: "down:40", previous: "down:38" }</code>. The value for the |
|
|
1237 |
"next" and "previous" properties are used to attach |
|
|
1238 |
<a href="event/#keylistener"><code>key</code></a> event listeners. See |
|
|
1239 |
the <a href="event/#keylistener">Using the key Event</a> section of |
|
|
1240 |
the Event documentation for more information on "key" event listeners. |
|
|
1241 |
</div> |
|
|
1242 |
</div> |
|
|
1243 |
|
|
|
1244 |
|
|
|
1245 |
|
|
|
1246 |
<hr /> |
|
|
1247 |
</div> |
|
|
1248 |
|
|
|
1249 |
</div> |
|
|
1250 |
</div> |
|
|
1251 |
|
|
|
1252 |
</div> |
|
|
1253 |
|
|
|
1254 |
</div> |
|
|
1255 |
</div> |
|
|
1256 |
<div class="yui-b"> |
|
|
1257 |
<div class="nav"> |
|
|
1258 |
|
|
|
1259 |
<div id="moduleList" class="module"> |
|
|
1260 |
<h4>Modules</h4> |
|
|
1261 |
<ul class="content"> |
|
|
1262 |
<li class=""><a href="module_anim.html" title="anim">anim</a></li> |
|
|
1263 |
<li class=""><a href="module_attribute.html" title="attribute">attribute</a></li> |
|
|
1264 |
<li class=""><a href="module_base.html" title="base">base</a></li> |
|
|
1265 |
<li class=""><a href="module_cache.html" title="cache">cache</a></li> |
|
|
1266 |
<li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li> |
|
|
1267 |
<li class=""><a href="module_collection.html" title="collection">collection</a></li> |
|
|
1268 |
<li class=""><a href="module_console.html" title="console">console</a></li> |
|
|
1269 |
<li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li> |
|
|
1270 |
<li class=""><a href="module_cookie.html" title="cookie">cookie</a></li> |
|
|
1271 |
<li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li> |
|
|
1272 |
<li class=""><a href="module_datasource.html" title="datasource">datasource</a></li> |
|
|
1273 |
<li class=""><a href="module_datatype.html" title="datatype">datatype</a></li> |
|
|
1274 |
<li class=""><a href="module_dd.html" title="dd">dd</a></li> |
|
|
1275 |
<li class=""><a href="module_dom.html" title="dom">dom</a></li> |
|
|
1276 |
<li class=""><a href="module_dump.html" title="dump">dump</a></li> |
|
|
1277 |
<li class=""><a href="module_event.html" title="event">event</a></li> |
|
|
1278 |
<li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li> |
|
|
1279 |
<li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li> |
|
|
1280 |
<li class=""><a href="module_history.html" title="history">history</a></li> |
|
|
1281 |
<li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li> |
|
|
1282 |
<li class=""><a href="module_io.html" title="io">io</a></li> |
|
|
1283 |
<li class=""><a href="module_json.html" title="json">json</a></li> |
|
|
1284 |
<li class=""><a href="module_node.html" title="node">node</a></li> |
|
|
1285 |
<li class="selected"><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li> |
|
|
1286 |
<li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li> |
|
|
1287 |
<li class=""><a href="module_oop.html" title="oop">oop</a></li> |
|
|
1288 |
<li class=""><a href="module_overlay.html" title="overlay">overlay</a></li> |
|
|
1289 |
<li class=""><a href="module_plugin.html" title="plugin">plugin</a></li> |
|
|
1290 |
<li class=""><a href="module_profiler.html" title="profiler">profiler</a></li> |
|
|
1291 |
<li class=""><a href="module_queue.html" title="queue">queue</a></li> |
|
|
1292 |
<li class=""><a href="module_slider.html" title="slider">slider</a></li> |
|
|
1293 |
<li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li> |
|
|
1294 |
<li class=""><a href="module_substitute.html" title="substitute">substitute</a></li> |
|
|
1295 |
<li class=""><a href="module_test.html" title="test">test</a></li> |
|
|
1296 |
<li class=""><a href="module_widget.html" title="widget">widget</a></li> |
|
|
1297 |
<li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li> |
|
|
1298 |
<li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li> |
|
|
1299 |
<li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li> |
|
|
1300 |
<li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li> |
|
|
1301 |
<li class=""><a href="module_yui.html" title="yui">yui</a></li> |
|
|
1302 |
</ul> |
|
|
1303 |
</div> |
|
|
1304 |
|
|
|
1305 |
<div id="classList" class="module"> |
|
|
1306 |
<h4>Classes</h4> |
|
|
1307 |
<ul class="content"> |
|
|
1308 |
<li class="selected"><a href="plugin.NodeFocusManager.html" title="plugin.NodeFocusManager">plugin.NodeFocusManager</a></li> |
|
|
1309 |
</ul> |
|
|
1310 |
</div> |
|
|
1311 |
|
|
|
1312 |
<div id="fileList" class="module"> |
|
|
1313 |
<h4>Files</h4> |
|
|
1314 |
<ul class="content"> |
|
|
1315 |
<li class=""><a href="node-focusmanager.js.html" title="node-focusmanager.js">node-focusmanager.js</a></li> |
|
|
1316 |
</ul> |
|
|
1317 |
</div> |
|
|
1318 |
|
|
|
1319 |
|
|
|
1320 |
<div id="methodsList" class="module"> |
|
|
1321 |
<h4>Methods</h4> |
|
|
1322 |
<ul class="content"> |
|
|
1323 |
<li class="protected"><a href="#method__afterActiveDescendantChange" title="_afterActiveDescendantChange">_afterActiveDescendantChange</a></li> |
|
|
1324 |
<li class="protected"><a href="#method__attachKeyHandler" title="_attachKeyHandler">_attachKeyHandler</a></li> |
|
|
1325 |
<li class="protected"><a href="#method__detachEventHandlers" title="_detachEventHandlers">_detachEventHandlers</a></li> |
|
|
1326 |
<li class="protected"><a href="#method__detachKeyHandler" title="_detachKeyHandler">_detachKeyHandler</a></li> |
|
|
1327 |
<li class="protected"><a href="#method__focusNext" title="_focusNext">_focusNext</a></li> |
|
|
1328 |
<li class="protected"><a href="#method__focusPrevious" title="_focusPrevious">_focusPrevious</a></li> |
|
|
1329 |
<li class="protected"><a href="#method__initDescendants" title="_initDescendants">_initDescendants</a></li> |
|
|
1330 |
<li class="protected"><a href="#method__isDescendant" title="_isDescendant">_isDescendant</a></li> |
|
|
1331 |
<li class="protected"><a href="#method__onDocFocus" title="_onDocFocus">_onDocFocus</a></li> |
|
|
1332 |
<li class="protected"><a href="#method__onDocMouseDown" title="_onDocMouseDown">_onDocMouseDown</a></li> |
|
|
1333 |
<li class="protected"><a href="#method__preventScroll" title="_preventScroll">_preventScroll</a></li> |
|
|
1334 |
<li class="protected"><a href="#method__removeFocusClass" title="_removeFocusClass">_removeFocusClass</a></li> |
|
|
1335 |
<li class=""><a href="#method_blur" title="blur">blur</a></li> |
|
|
1336 |
<li class=""><a href="#method_focus" title="focus">focus</a></li> |
|
|
1337 |
<li class=""><a href="#method_refresh" title="refresh">refresh</a></li> |
|
|
1338 |
<li class=""><a href="#method_start" title="start">start</a></li> |
|
|
1339 |
<li class=""><a href="#method_stop" title="stop">stop</a></li> |
|
|
1340 |
</ul> |
|
|
1341 |
</div> |
|
|
1342 |
|
|
|
1343 |
<div id="eventsList" class="module"> |
|
|
1344 |
<h4>Events</h4> |
|
|
1345 |
<ul class="content"> |
|
|
1346 |
<li class=""><a href="#event_activeDescendantChange" title="activeDescendantChange">activeDescendantChange</a></li> |
|
|
1347 |
<li class=""><a href="#event_circularChange" title="circularChange">circularChange</a></li> |
|
|
1348 |
<li class=""><a href="#event_descendantsChange" title="descendantsChange">descendantsChange</a></li> |
|
|
1349 |
<li class=""><a href="#event_focusClassChange" title="focusClassChange">focusClassChange</a></li> |
|
|
1350 |
<li class=""><a href="#event_focusedChange" title="focusedChange">focusedChange</a></li> |
|
|
1351 |
<li class=""><a href="#event_keysChange" title="keysChange">keysChange</a></li> |
|
|
1352 |
</ul> |
|
|
1353 |
</div> |
|
|
1354 |
|
|
|
1355 |
<div id="configList" class="module"> |
|
|
1356 |
<h4>Configuration Attributes</h4> |
|
|
1357 |
<ul class="content"> |
|
|
1358 |
<li class=""><a href="#config_activeDescendant" title="activeDescendant">activeDescendant</a></li> |
|
|
1359 |
<li class=""><a href="#config_circular" title="circular">circular</a></li> |
|
|
1360 |
<li class=""><a href="#config_descendants" title="descendants">descendants</a></li> |
|
|
1361 |
<li class=""><a href="#config_focusClass" title="focusClass">focusClass</a></li> |
|
|
1362 |
<li class=""><a href="#config_focused" title="focused">focused</a></li> |
|
|
1363 |
<li class=""><a href="#config_keys" title="keys">keys</a></li> |
|
|
1364 |
</ul> |
|
|
1365 |
</div> |
|
|
1366 |
|
|
|
1367 |
</div> |
|
|
1368 |
</div> |
|
|
1369 |
</div> |
|
|
1370 |
<div id="ft"> |
|
|
1371 |
<hr /> |
|
|
1372 |
Copyright © 2009 Yahoo! Inc. All rights reserved. |
|
|
1373 |
</div> |
|
|
1374 |
</div> |
|
|
1375 |
<script type="text/javascript"> |
|
|
1376 |
ALL_YUI_PROPS = [{"access": "", "host": "plugin.NodeFocusManager", "name": "activeDescendant", "url": "plugin.NodeFocusManager.html#config_activeDescendant", "type": "config"}, {"access": "", "host": "plugin.NodeFocusManager", "name": "activeDescendantChange", "url": "plugin.NodeFocusManager.html#event_activeDescendantChange", "type": "event"}, {"access": "protected", "host": "plugin.NodeFocusManager", "name": "_afterActiveDescendantChange", "url": "plugin.NodeFocusManager.html#method__afterActiveDescendantChange", "type": "method"}, {"access": "protected", "host": "plugin.NodeFocusManager", "name": "_attachKeyHandler", "url": "plugin.NodeFocusManager.html#method__attachKeyHandler", "type": "method"}, {"access": "", "host": "plugin.NodeFocusManager", "name": "blur", "url": "plugin.NodeFocusManager.html#method_blur", "type": "method"}, {"access": "", "host": "plugin.NodeFocusManager", "name": "circular", "url": "plugin.NodeFocusManager.html#config_circular", "type": "config"}, {"access": "", "host": "plugin.NodeFocusManager", "name": "circularChange", "url": "plugin.NodeFocusManager.html#event_circularChange", "type": "event"}, {"access": "", "host": "plugin.NodeFocusManager", "name": "descendants", "url": "plugin.NodeFocusManager.html#config_descendants", "type": "config"}, {"access": "", "host": "plugin.NodeFocusManager", "name": "descendantsChange", "url": "plugin.NodeFocusManager.html#event_descendantsChange", "type": "event"}, {"access": "protected", "host": "plugin.NodeFocusManager", "name": "_detachEventHandlers", "url": "plugin.NodeFocusManager.html#method__detachEventHandlers", "type": "method"}, {"access": "protected", "host": "plugin.NodeFocusManager", "name": "_detachKeyHandler", "url": "plugin.NodeFocusManager.html#method__detachKeyHandler", "type": "method"}, {"access": "", "host": "plugin.NodeFocusManager", "name": "focus", "url": "plugin.NodeFocusManager.html#method_focus", "type": "method"}, {"access": "", "host": "plugin.NodeFocusManager", "name": "focusClass", "url": "plugin.NodeFocusManager.html#config_focusClass", "type": "config"}, {"access": "", "host": "plugin.NodeFocusManager", "name": "focusClassChange", "url": "plugin.NodeFocusManager.html#event_focusClassChange", "type": "event"}, {"access": "", "host": "plugin.NodeFocusManager", "name": "focused", "url": "plugin.NodeFocusManager.html#config_focused", "type": "config"}, {"access": "", "host": "plugin.NodeFocusManager", "name": "focusedChange", "url": "plugin.NodeFocusManager.html#event_focusedChange", "type": "event"}, {"access": "protected", "host": "plugin.NodeFocusManager", "name": "_focusNext", "url": "plugin.NodeFocusManager.html#method__focusNext", "type": "method"}, {"access": "protected", "host": "plugin.NodeFocusManager", "name": "_focusPrevious", "url": "plugin.NodeFocusManager.html#method__focusPrevious", "type": "method"}, {"access": "protected", "host": "plugin.NodeFocusManager", "name": "_initDescendants", "url": "plugin.NodeFocusManager.html#method__initDescendants", "type": "method"}, {"access": "protected", "host": "plugin.NodeFocusManager", "name": "_isDescendant", "url": "plugin.NodeFocusManager.html#method__isDescendant", "type": "method"}, {"access": "", "host": "plugin.NodeFocusManager", "name": "keys", "url": "plugin.NodeFocusManager.html#config_keys", "type": "config"}, {"access": "", "host": "plugin.NodeFocusManager", "name": "keysChange", "url": "plugin.NodeFocusManager.html#event_keysChange", "type": "event"}, {"access": "protected", "host": "plugin.NodeFocusManager", "name": "_onDocFocus", "url": "plugin.NodeFocusManager.html#method__onDocFocus", "type": "method"}, {"access": "protected", "host": "plugin.NodeFocusManager", "name": "_onDocMouseDown", "url": "plugin.NodeFocusManager.html#method__onDocMouseDown", "type": "method"}, {"access": "protected", "host": "plugin.NodeFocusManager", "name": "_preventScroll", "url": "plugin.NodeFocusManager.html#method__preventScroll", "type": "method"}, {"access": "", "host": "plugin.NodeFocusManager", "name": "refresh", "url": "plugin.NodeFocusManager.html#method_refresh", "type": "method"}, {"access": "protected", "host": "plugin.NodeFocusManager", "name": "_removeFocusClass", "url": "plugin.NodeFocusManager.html#method__removeFocusClass", "type": "method"}, {"access": "", "host": "plugin.NodeFocusManager", "name": "start", "url": "plugin.NodeFocusManager.html#method_start", "type": "method"}, {"access": "", "host": "plugin.NodeFocusManager", "name": "stop", "url": "plugin.NodeFocusManager.html#method_stop", "type": "method"}]; |
|
|
1377 |
</script> |
|
|
1378 |
</body> |
|
|
1379 |
</html> |