|
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: yui YUI (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>yui <span class="subtitle">3.0.0</span></h3> |
|
20 <a href="./index.html" title="Yahoo! UI Library">Yahoo! UI Library</a> |
|
21 > <a href="./module_yui.html" title="yui">yui</a> |
|
22 > YUI |
|
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">YUI</b> |
|
52 <span class="extends"> |
|
53 </span> |
|
54 |
|
55 <span class="extends" rel="yui:extends"> |
|
56 - uses |
|
57 |
|
58 <span rel="extend" resource="EventTarget.html"> |
|
59 <a href="EventTarget.html" property="yui:name" title="EventTarget">EventTarget</a> |
|
60 </span> |
|
61 |
|
62 |
|
63 </span> |
|
64 </h2> |
|
65 <!-- class tree goes here --> |
|
66 |
|
67 |
|
68 |
|
69 |
|
70 <div class="summary description" property="yui:description"> |
|
71 The YUI global namespace object. If YUI is already defined, the |
|
72 existing YUI object will not be overwritten so that defined |
|
73 namespaces are preserved. |
|
74 </div> |
|
75 |
|
76 <div class="section constructor details" rel="yui:constructor" resource="#constructor"> |
|
77 <h3 id="constructor">Constructor</h3> |
|
78 <div class="content"> |
|
79 <div class="detail"> |
|
80 <strong property="yui:name">YUI</strong> |
|
81 <code> |
|
82 ( |
|
83 |
|
84 |
|
85 |
|
86 o* |
|
87 ) |
|
88 </code> |
|
89 <div class="description"> |
|
90 <dl rel="yui:parameters"> |
|
91 <dt>Parameters:</dt> |
|
92 <dd rel="yui:parameter"> |
|
93 <code><span property="yui:name">o*</span> |
|
94 <<span property="yui:type">object</span>> |
|
95 </code> |
|
96 <span property="yui:description"> Up to five optional configuration objects. This object is stored |
|
97 in YUI.config. See config for the list of supported properties.</span> |
|
98 </dd> |
|
99 </dl> |
|
100 |
|
101 |
|
102 </div> |
|
103 </div> |
|
104 </div> |
|
105 </div> |
|
106 |
|
107 <div rel="yui:properties" resource="#properties"> |
|
108 <div class="section field details"> |
|
109 <h3 id="properties">Properties</h3> |
|
110 <div class="content"> |
|
111 <div class="" rel="yui:property" resource="#property_Global"> |
|
112 <h4><a name="property_Global" property="yui:name">Global</a> |
|
113 - <code><span property="yui:type">EventTarget</span></code> |
|
114 </h4> |
|
115 <div class="detail"> |
|
116 <div class="description" property="yui:description"> |
|
117 Hosts YUI page level events. This is where events bubble to |
|
118 when the broadcast config is set to 2. This property is |
|
119 only available if the custom event module is loaded. |
|
120 </div> |
|
121 </div> |
|
122 |
|
123 |
|
124 |
|
125 |
|
126 <hr /> |
|
127 </div> |
|
128 </div> |
|
129 </div> |
|
130 |
|
131 </div> |
|
132 |
|
133 <div rel="yui:methods" resource="#methods"> |
|
134 <div class="section method details"> |
|
135 <h3 id="methods">Methods</h3> |
|
136 <div class="content"> |
|
137 <div class="private" rel="yui:method" resource="#method__init"> |
|
138 <h4> |
|
139 <a name="method__init">_init</a></h4> |
|
140 <div class="detail" > |
|
141 <code> |
|
142 private |
|
143 |
|
144 |
|
145 void |
|
146 <strong property="yui:name">_init</strong> |
|
147 ( |
|
148 ) |
|
149 </code> |
|
150 |
|
151 <div class="description" property="yui:description"> |
|
152 Initialize this YUI instance |
|
153 </div> |
|
154 |
|
155 <div class="description"> |
|
156 |
|
157 |
|
158 |
|
159 |
|
160 |
|
161 |
|
162 </div> |
|
163 |
|
164 </div> |
|
165 <hr /> |
|
166 </div> |
|
167 <div class="private" rel="yui:method" resource="#method__setup"> |
|
168 <h4> |
|
169 <a name="method__setup">_setup</a></h4> |
|
170 <div class="detail" > |
|
171 <code> |
|
172 private |
|
173 |
|
174 |
|
175 void |
|
176 <strong property="yui:name">_setup</strong> |
|
177 ( |
|
178 ) |
|
179 </code> |
|
180 |
|
181 <div class="description" property="yui:description"> |
|
182 Finishes the instance setup. Attaches whatever modules were defined |
|
183 when the yui modules was registered. |
|
184 </div> |
|
185 |
|
186 <div class="description"> |
|
187 |
|
188 |
|
189 |
|
190 |
|
191 |
|
192 |
|
193 </div> |
|
194 |
|
195 </div> |
|
196 <hr /> |
|
197 </div> |
|
198 <div class="" rel="yui:method" resource="#method_add"> |
|
199 <h4> |
|
200 <a name="method_add">add</a></h4> |
|
201 <div class="detail" > |
|
202 <code> |
|
203 |
|
204 |
|
205 |
|
206 YUI |
|
207 <strong property="yui:name">add</strong> |
|
208 ( |
|
209 |
|
210 |
|
211 name |
|
212 |
|
213 |
|
214 , |
|
215 fn |
|
216 |
|
217 |
|
218 , |
|
219 version |
|
220 |
|
221 |
|
222 , |
|
223 details |
|
224 |
|
225 |
|
226 ) |
|
227 </code> |
|
228 |
|
229 <div class="description" property="yui:description"> |
|
230 Register a module |
|
231 </div> |
|
232 |
|
233 <div class="description"> |
|
234 |
|
235 <dl rel="yui:parameters"> |
|
236 <dt>Parameters:</dt> |
|
237 <dd rel="yui:parameter"> |
|
238 <code><span property="yui:name">name</span> |
|
239 <<span property="yui:type">string</span>> |
|
240 </code> |
|
241 <span property="yui:description"> module name</span> |
|
242 </dd> |
|
243 <dd rel="yui:parameter"> |
|
244 <code><span property="yui:name">fn</span> |
|
245 <<span property="yui:type">Function</span>> |
|
246 </code> |
|
247 <span property="yui:description"> entry point into the module that |
|
248 is used to bind module to the YUI instance</span> |
|
249 </dd> |
|
250 <dd rel="yui:parameter"> |
|
251 <code><span property="yui:name">version</span> |
|
252 <<span property="yui:type">string</span>> |
|
253 </code> |
|
254 <span property="yui:description"> version string</span> |
|
255 </dd> |
|
256 <dd rel="yui:parameter"> |
|
257 <code><span property="yui:name">details</span> |
|
258 <<span property="yui:type">object</span>> |
|
259 </code> |
|
260 <span property="yui:description"> optional config data: |
|
261 requires - features that should be present before loading |
|
262 optional - optional features that should be present if load optional defined |
|
263 use - features that should be attached automatically |
|
264 skinnable - |
|
265 rollup |
|
266 omit - features that should not be loaded if this module is present</span> |
|
267 </dd> |
|
268 </dl> |
|
269 |
|
270 <dl> |
|
271 <dt>Returns: |
|
272 <code property="yui:return"> |
|
273 YUI |
|
274 </code></dt> |
|
275 <dd property="yui:returnInfo">the YUI instance</dd> |
|
276 </dl> |
|
277 |
|
278 |
|
279 |
|
280 |
|
281 </div> |
|
282 |
|
283 </div> |
|
284 <hr /> |
|
285 </div> |
|
286 <div class="" rel="yui:method" resource="#method_after"> |
|
287 <h4> |
|
288 <a name="method_after">after</a></h4> |
|
289 <div class="detail" > |
|
290 <code> |
|
291 |
|
292 |
|
293 |
|
294 |
|
295 <strong property="yui:name">after</strong> |
|
296 ( |
|
297 |
|
298 |
|
299 type |
|
300 |
|
301 |
|
302 , |
|
303 fn |
|
304 |
|
305 |
|
306 , |
|
307 target |
|
308 |
|
309 |
|
310 , |
|
311 extra |
|
312 |
|
313 |
|
314 , |
|
315 context |
|
316 |
|
317 |
|
318 , |
|
319 args* |
|
320 |
|
321 |
|
322 ) |
|
323 </code> |
|
324 |
|
325 <div class="description" property="yui:description"> |
|
326 after() is a unified interface for subscribing to |
|
327 most events exposed by YUI. This includes custom events, |
|
328 DOM events, and AOP events. This works the same way as |
|
329 the on() function, only it operates after any default |
|
330 behavior for the event has executed. @see <code>on</code> for more |
|
331 information. |
|
332 </div> |
|
333 |
|
334 <div class="description"> |
|
335 |
|
336 <dl rel="yui:parameters"> |
|
337 <dt>Parameters:</dt> |
|
338 <dd rel="yui:parameter"> |
|
339 <code><span property="yui:name">type</span> |
|
340 <<span property="yui:type">object</span>> |
|
341 </code> |
|
342 <span property="yui:description"> event type (this parameter does not apply for function events)</span> |
|
343 </dd> |
|
344 <dd rel="yui:parameter"> |
|
345 <code><span property="yui:name">fn</span> |
|
346 <<span property="yui:type">object</span>> |
|
347 </code> |
|
348 <span property="yui:description"> the callback</span> |
|
349 </dd> |
|
350 <dd rel="yui:parameter"> |
|
351 <code><span property="yui:name">target</span> |
|
352 <<span property="yui:type">object</span>> |
|
353 </code> |
|
354 <span property="yui:description"> a descriptor for the target (applies to custom events only). |
|
355 For function events, this is the object that contains the function to |
|
356 execute.</span> |
|
357 </dd> |
|
358 <dd rel="yui:parameter"> |
|
359 <code><span property="yui:name">extra</span> |
|
360 <<span property="yui:type">object</span>> |
|
361 </code> |
|
362 <span property="yui:description"> 0..n Extra information a particular event may need. These |
|
363 will be documented with the event. In the case of function events, this |
|
364 is the name of the function to execute on the host. In the case of |
|
365 delegate listeners, this is the event delegation specification.</span> |
|
366 </dd> |
|
367 <dd rel="yui:parameter"> |
|
368 <code><span property="yui:name">context</span> |
|
369 <<span property="yui:type">object</span>> |
|
370 </code> |
|
371 <span property="yui:description"> optionally change the value of 'this' in the callback</span> |
|
372 </dd> |
|
373 <dd rel="yui:parameter"> |
|
374 <code><span property="yui:name">args*</span> |
|
375 <<span property="yui:type">object</span>> |
|
376 </code> |
|
377 <span property="yui:description"> 0..n additional arguments to pass to the callback.</span> |
|
378 </dd> |
|
379 </dl> |
|
380 |
|
381 <dl> |
|
382 <dt>Returns: |
|
383 <code property="yui:return"> |
|
384 </code></dt> |
|
385 <dd property="yui:returnInfo">the event target or a detach handle per 'chain' config</dd> |
|
386 </dl> |
|
387 |
|
388 |
|
389 |
|
390 |
|
391 </div> |
|
392 |
|
393 </div> |
|
394 <hr /> |
|
395 </div> |
|
396 <div class="" rel="yui:method" resource="#method_applyTo"> |
|
397 <h4> |
|
398 <a name="method_applyTo">applyTo</a></h4> |
|
399 <div class="detail" > |
|
400 <code> |
|
401 |
|
402 |
|
403 |
|
404 object |
|
405 <strong property="yui:name">applyTo</strong> |
|
406 ( |
|
407 |
|
408 |
|
409 id |
|
410 |
|
411 |
|
412 , |
|
413 method |
|
414 |
|
415 |
|
416 , |
|
417 args |
|
418 |
|
419 |
|
420 ) |
|
421 </code> |
|
422 |
|
423 <div class="description" property="yui:description"> |
|
424 Executes a method on a YUI instance with |
|
425 the specified id if the specified method is whitelisted. |
|
426 </div> |
|
427 |
|
428 <div class="description"> |
|
429 |
|
430 <dl rel="yui:parameters"> |
|
431 <dt>Parameters:</dt> |
|
432 <dd rel="yui:parameter"> |
|
433 <code><span property="yui:name">id</span> |
|
434 <<span property="yui:type">string</span>> |
|
435 </code> |
|
436 <span property="yui:description"> the YUI instance id</span> |
|
437 </dd> |
|
438 <dd rel="yui:parameter"> |
|
439 <code><span property="yui:name">method</span> |
|
440 <<span property="yui:type">string</span>> |
|
441 </code> |
|
442 <span property="yui:description"> the name of the method to exectute. |
|
443 Ex: 'Object.keys'</span> |
|
444 </dd> |
|
445 <dd rel="yui:parameter"> |
|
446 <code><span property="yui:name">args</span> |
|
447 <<span property="yui:type">Array</span>> |
|
448 </code> |
|
449 <span property="yui:description"> the arguments to apply to the method</span> |
|
450 </dd> |
|
451 </dl> |
|
452 |
|
453 <dl> |
|
454 <dt>Returns: |
|
455 <code property="yui:return"> |
|
456 object |
|
457 </code></dt> |
|
458 <dd property="yui:returnInfo">the return value from the applied method or null</dd> |
|
459 </dl> |
|
460 |
|
461 |
|
462 |
|
463 |
|
464 </div> |
|
465 |
|
466 </div> |
|
467 <hr /> |
|
468 </div> |
|
469 <div class="" rel="yui:method" resource="#method_cached"> |
|
470 <h4> |
|
471 <a name="method_cached">cached</a></h4> |
|
472 <div class="detail" > |
|
473 <code> |
|
474 |
|
475 |
|
476 |
|
477 Function |
|
478 <strong property="yui:name">cached</strong> |
|
479 ( |
|
480 |
|
481 |
|
482 source |
|
483 |
|
484 |
|
485 , |
|
486 cache |
|
487 |
|
488 |
|
489 , |
|
490 refetch |
|
491 |
|
492 |
|
493 ) |
|
494 </code> |
|
495 |
|
496 <div class="description" property="yui:description"> |
|
497 Returns a wrapper for a function which caches the |
|
498 return value of that function, keyed off of the combined |
|
499 argument values. |
|
500 </div> |
|
501 |
|
502 <div class="description"> |
|
503 |
|
504 <dl rel="yui:parameters"> |
|
505 <dt>Parameters:</dt> |
|
506 <dd rel="yui:parameter"> |
|
507 <code><span property="yui:name">source</span> |
|
508 <<span property="yui:type">function</span>> |
|
509 </code> |
|
510 <span property="yui:description"> the function to memoize</span> |
|
511 </dd> |
|
512 <dd rel="yui:parameter"> |
|
513 <code><span property="yui:name">cache</span> |
|
514 <<span property="yui:type">object</span>> |
|
515 </code> |
|
516 <span property="yui:description"> an optional cache seed</span> |
|
517 </dd> |
|
518 <dd rel="yui:parameter"> |
|
519 <code><span property="yui:name">refetch</span> |
|
520 <<span property="yui:type">object</span>> |
|
521 </code> |
|
522 <span property="yui:description"> if supplied, this value is tested against the cached |
|
523 value. If the values are equal, the wrapped function is executed again.</span> |
|
524 </dd> |
|
525 </dl> |
|
526 |
|
527 <dl> |
|
528 <dt>Returns: |
|
529 <code property="yui:return"> |
|
530 Function |
|
531 </code></dt> |
|
532 <dd property="yui:returnInfo">the wrapped function</dd> |
|
533 </dl> |
|
534 |
|
535 |
|
536 |
|
537 |
|
538 </div> |
|
539 |
|
540 </div> |
|
541 <hr /> |
|
542 </div> |
|
543 <div class="" rel="yui:method" resource="#method_delegate"> |
|
544 <h4> |
|
545 <a name="method_delegate">delegate</a></h4> |
|
546 <div class="detail" > |
|
547 <code> |
|
548 |
|
549 |
|
550 |
|
551 EventHandle |
|
552 <strong property="yui:name">delegate</strong> |
|
553 ( |
|
554 |
|
555 |
|
556 type |
|
557 |
|
558 |
|
559 , |
|
560 fn |
|
561 |
|
562 |
|
563 , |
|
564 el |
|
565 |
|
566 |
|
567 , |
|
568 spec |
|
569 |
|
570 |
|
571 , |
|
572 context |
|
573 |
|
574 |
|
575 , |
|
576 args* |
|
577 |
|
578 |
|
579 ) |
|
580 </code> |
|
581 |
|
582 <div class="description" property="yui:description"> |
|
583 Sets up event delegation on a container element. The delegated event |
|
584 will use a supplied selector to test if the target or one of the |
|
585 descendants of the target match it. The supplied callback function |
|
586 will only be executed if a match was encountered, and, in fact, |
|
587 will be executed for each element that matches if you supply an |
|
588 ambiguous selector. |
|
589 The event object for the delegated event is supplied to the callback |
|
590 function. It is modified slightly in order to support all properties |
|
591 that may be needed for event delegation. 'currentTarget' is set to |
|
592 the element that matched the delegation specifcation. 'container' is |
|
593 set to the element that the listener is bound to (this normally would |
|
594 be the 'currentTarget'). |
|
595 </div> |
|
596 |
|
597 <div class="description"> |
|
598 |
|
599 <dl rel="yui:parameters"> |
|
600 <dt>Parameters:</dt> |
|
601 <dd rel="yui:parameter"> |
|
602 <code><span property="yui:name">type</span> |
|
603 <<span property="yui:type">string</span>> |
|
604 </code> |
|
605 <span property="yui:description"> the event type to delegate</span> |
|
606 </dd> |
|
607 <dd rel="yui:parameter"> |
|
608 <code><span property="yui:name">fn</span> |
|
609 <<span property="yui:type">function</span>> |
|
610 </code> |
|
611 <span property="yui:description"> the callback function to execute. This function |
|
612 will be provided the event object for the delegated event.</span> |
|
613 </dd> |
|
614 <dd rel="yui:parameter"> |
|
615 <code><span property="yui:name">el</span> |
|
616 <<span property="yui:type">string|node</span>> |
|
617 </code> |
|
618 <span property="yui:description"> the element that is the delegation container</span> |
|
619 </dd> |
|
620 <dd rel="yui:parameter"> |
|
621 <code><span property="yui:name">spec</span> |
|
622 <<span property="yui:type">string</span>> |
|
623 </code> |
|
624 <span property="yui:description"> a selector that must match the target of the |
|
625 event.</span> |
|
626 </dd> |
|
627 <dd rel="yui:parameter"> |
|
628 <code><span property="yui:name">context</span> |
|
629 <<span property="yui:type">object</span>> |
|
630 </code> |
|
631 <span property="yui:description"> optional argument that specifies what 'this' refers to.</span> |
|
632 </dd> |
|
633 <dd rel="yui:parameter"> |
|
634 <code><span property="yui:name">args*</span> |
|
635 <<span property="yui:type">object</span>> |
|
636 </code> |
|
637 <span property="yui:description"> 0..n additional arguments to pass on to the callback function. |
|
638 These arguments will be added after the event object.</span> |
|
639 </dd> |
|
640 </dl> |
|
641 |
|
642 <dl> |
|
643 <dt>Returns: |
|
644 <code property="yui:return"> |
|
645 EventHandle |
|
646 </code></dt> |
|
647 <dd property="yui:returnInfo">the detach handle</dd> |
|
648 </dl> |
|
649 |
|
650 |
|
651 |
|
652 |
|
653 </div> |
|
654 |
|
655 </div> |
|
656 <hr /> |
|
657 </div> |
|
658 <div class="" rel="yui:method" resource="#method_error"> |
|
659 <h4> |
|
660 <a name="method_error">error</a></h4> |
|
661 <div class="detail" > |
|
662 <code> |
|
663 |
|
664 |
|
665 |
|
666 YUI |
|
667 <strong property="yui:name">error</strong> |
|
668 ( |
|
669 |
|
670 |
|
671 msg |
|
672 |
|
673 |
|
674 , |
|
675 e |
|
676 |
|
677 |
|
678 ) |
|
679 </code> |
|
680 |
|
681 <div class="description" property="yui:description"> |
|
682 Report an error. The reporting mechanism is controled by |
|
683 the 'throwFail' configuration attribute. If throwFail is |
|
684 not specified, the message is written to the Logger, otherwise |
|
685 a JS error is thrown |
|
686 </div> |
|
687 |
|
688 <div class="description"> |
|
689 |
|
690 <dl rel="yui:parameters"> |
|
691 <dt>Parameters:</dt> |
|
692 <dd rel="yui:parameter"> |
|
693 <code><span property="yui:name">msg</span> |
|
694 <<span property="yui:type">string</span>> |
|
695 </code> |
|
696 <span property="yui:description"> the error message</span> |
|
697 </dd> |
|
698 <dd rel="yui:parameter"> |
|
699 <code><span property="yui:name">e</span> |
|
700 <<span property="yui:type">Error</span>> |
|
701 </code> |
|
702 <span property="yui:description"> Optional JS error that was caught. If supplied |
|
703 and throwFail is specified, this error will be re-thrown.</span> |
|
704 </dd> |
|
705 </dl> |
|
706 |
|
707 <dl> |
|
708 <dt>Returns: |
|
709 <code property="yui:return"> |
|
710 YUI |
|
711 </code></dt> |
|
712 <dd property="yui:returnInfo">this YUI instance</dd> |
|
713 </dl> |
|
714 |
|
715 |
|
716 |
|
717 |
|
718 </div> |
|
719 |
|
720 </div> |
|
721 <hr /> |
|
722 </div> |
|
723 <div class="" rel="yui:method" resource="#method_guid"> |
|
724 <h4> |
|
725 <a name="method_guid">guid</a></h4> |
|
726 <div class="detail" > |
|
727 <code> |
|
728 |
|
729 |
|
730 |
|
731 string |
|
732 <strong property="yui:name">guid</strong> |
|
733 ( |
|
734 |
|
735 |
|
736 pre |
|
737 |
|
738 |
|
739 ) |
|
740 </code> |
|
741 |
|
742 <div class="description" property="yui:description"> |
|
743 Generate an id that is unique among all YUI instances |
|
744 </div> |
|
745 |
|
746 <div class="description"> |
|
747 |
|
748 <dl rel="yui:parameters"> |
|
749 <dt>Parameters:</dt> |
|
750 <dd rel="yui:parameter"> |
|
751 <code><span property="yui:name">pre</span> |
|
752 <<span property="yui:type">string</span>> |
|
753 </code> |
|
754 <span property="yui:description"> optional guid prefix</span> |
|
755 </dd> |
|
756 </dl> |
|
757 |
|
758 <dl> |
|
759 <dt>Returns: |
|
760 <code property="yui:return"> |
|
761 string |
|
762 </code></dt> |
|
763 <dd property="yui:returnInfo">the guid</dd> |
|
764 </dl> |
|
765 |
|
766 |
|
767 |
|
768 |
|
769 </div> |
|
770 |
|
771 </div> |
|
772 <hr /> |
|
773 </div> |
|
774 <div class="" rel="yui:method" resource="#method_later"> |
|
775 <h4> |
|
776 <a name="method_later">later</a></h4> |
|
777 <div class="detail" > |
|
778 <code> |
|
779 |
|
780 |
|
781 |
|
782 object |
|
783 <strong property="yui:name">later</strong> |
|
784 ( |
|
785 |
|
786 |
|
787 when |
|
788 |
|
789 |
|
790 , |
|
791 o |
|
792 |
|
793 |
|
794 , |
|
795 fn |
|
796 |
|
797 |
|
798 , |
|
799 data |
|
800 |
|
801 |
|
802 , |
|
803 periodic |
|
804 |
|
805 |
|
806 ) |
|
807 </code> |
|
808 |
|
809 <div class="description" property="yui:description"> |
|
810 Executes the supplied function in the context of the supplied |
|
811 object 'when' milliseconds later. Executes the function a |
|
812 single time unless periodic is set to true. |
|
813 </div> |
|
814 |
|
815 <div class="description"> |
|
816 |
|
817 <dl rel="yui:parameters"> |
|
818 <dt>Parameters:</dt> |
|
819 <dd rel="yui:parameter"> |
|
820 <code><span property="yui:name">when</span> |
|
821 <<span property="yui:type">int</span>> |
|
822 </code> |
|
823 <span property="yui:description"> the number of milliseconds to wait until the fn |
|
824 is executed.</span> |
|
825 </dd> |
|
826 <dd rel="yui:parameter"> |
|
827 <code><span property="yui:name">o</span> |
|
828 <<span property="yui:type">object</span>> |
|
829 </code> |
|
830 <span property="yui:description"> the context object.</span> |
|
831 </dd> |
|
832 <dd rel="yui:parameter"> |
|
833 <code><span property="yui:name">fn</span> |
|
834 <<span property="yui:type">Function|String</span>> |
|
835 </code> |
|
836 <span property="yui:description"> the function to execute or the name of |
|
837 the method in the 'o' object to execute.</span> |
|
838 </dd> |
|
839 <dd rel="yui:parameter"> |
|
840 <code><span property="yui:name">data</span> |
|
841 <<span property="yui:type">object</span>> |
|
842 </code> |
|
843 <span property="yui:description"> [Array] data that is provided to the function. This accepts |
|
844 either a single item or an array. If an array is provided, the |
|
845 function is executed with one parameter for each array item. If |
|
846 you need to pass a single array parameter, it needs to be wrapped in |
|
847 an array [myarray].</span> |
|
848 </dd> |
|
849 <dd rel="yui:parameter"> |
|
850 <code><span property="yui:name">periodic</span> |
|
851 <<span property="yui:type">boolean</span>> |
|
852 </code> |
|
853 <span property="yui:description"> if true, executes continuously at supplied |
|
854 interval until canceled.</span> |
|
855 </dd> |
|
856 </dl> |
|
857 |
|
858 <dl> |
|
859 <dt>Returns: |
|
860 <code property="yui:return"> |
|
861 object |
|
862 </code></dt> |
|
863 <dd property="yui:returnInfo">a timer object. Call the cancel() method on this object to |
|
864 stop the timer.</dd> |
|
865 </dl> |
|
866 |
|
867 |
|
868 |
|
869 |
|
870 </div> |
|
871 |
|
872 </div> |
|
873 <hr /> |
|
874 </div> |
|
875 <div class="" rel="yui:method" resource="#method_log"> |
|
876 <h4> |
|
877 <a name="method_log">log</a></h4> |
|
878 <div class="detail" > |
|
879 <code> |
|
880 |
|
881 |
|
882 |
|
883 YUI |
|
884 <strong property="yui:name">log</strong> |
|
885 ( |
|
886 |
|
887 |
|
888 msg |
|
889 |
|
890 |
|
891 , |
|
892 cat |
|
893 |
|
894 |
|
895 , |
|
896 src |
|
897 |
|
898 |
|
899 , |
|
900 silent |
|
901 |
|
902 |
|
903 ) |
|
904 </code> |
|
905 |
|
906 <div class="description" property="yui:description"> |
|
907 If the 'debug' config is true, a 'yui:log' event will be |
|
908 dispatched, which the Console widget and anything else |
|
909 can consume. If the 'useBrowserConsole' config is true, it will |
|
910 write to the browser console if available. YUI-specific log |
|
911 messages will only be present in the -debug versions of the |
|
912 JS files. The build system is supposed to remove log statements |
|
913 from the raw and minified versions of the files. |
|
914 </div> |
|
915 |
|
916 <div class="description"> |
|
917 |
|
918 <dl rel="yui:parameters"> |
|
919 <dt>Parameters:</dt> |
|
920 <dd rel="yui:parameter"> |
|
921 <code><span property="yui:name">msg</span> |
|
922 <<span property="yui:type">String</span>> |
|
923 </code> |
|
924 <span property="yui:description"> The message to log.</span> |
|
925 </dd> |
|
926 <dd rel="yui:parameter"> |
|
927 <code><span property="yui:name">cat</span> |
|
928 <<span property="yui:type">String</span>> |
|
929 </code> |
|
930 <span property="yui:description"> The log category for the message. Default |
|
931 categories are "info", "warn", "error", time". |
|
932 Custom categories can be used as well. (opt)</span> |
|
933 </dd> |
|
934 <dd rel="yui:parameter"> |
|
935 <code><span property="yui:name">src</span> |
|
936 <<span property="yui:type">String</span>> |
|
937 </code> |
|
938 <span property="yui:description"> The source of the the message (opt)</span> |
|
939 </dd> |
|
940 <dd rel="yui:parameter"> |
|
941 <code><span property="yui:name">silent</span> |
|
942 <<span property="yui:type">boolean</span>> |
|
943 </code> |
|
944 <span property="yui:description"> If true, the log event won't fire</span> |
|
945 </dd> |
|
946 </dl> |
|
947 |
|
948 <dl> |
|
949 <dt>Returns: |
|
950 <code property="yui:return"> |
|
951 YUI |
|
952 </code></dt> |
|
953 <dd property="yui:returnInfo">YUI instance</dd> |
|
954 </dl> |
|
955 |
|
956 |
|
957 |
|
958 |
|
959 </div> |
|
960 |
|
961 </div> |
|
962 <hr /> |
|
963 </div> |
|
964 <div class="" rel="yui:method" resource="#method_merge"> |
|
965 <h4> |
|
966 <a name="method_merge">merge</a></h4> |
|
967 <div class="detail" > |
|
968 <code> |
|
969 |
|
970 |
|
971 |
|
972 object |
|
973 <strong property="yui:name">merge</strong> |
|
974 ( |
|
975 |
|
976 |
|
977 arguments |
|
978 |
|
979 |
|
980 ) |
|
981 </code> |
|
982 |
|
983 <div class="description" property="yui:description"> |
|
984 Returns a new object containing all of the properties of |
|
985 all the supplied objects. The properties from later objects |
|
986 will overwrite those in earlier objects. Passing in a |
|
987 single object will create a shallow copy of it. For a deep |
|
988 copy, use clone. |
|
989 </div> |
|
990 |
|
991 <div class="description"> |
|
992 |
|
993 <dl rel="yui:parameters"> |
|
994 <dt>Parameters:</dt> |
|
995 <dd rel="yui:parameter"> |
|
996 <code><span property="yui:name">arguments</span> |
|
997 <<span property="yui:type">Object*</span>> |
|
998 </code> |
|
999 <span property="yui:description"> the objects to merge</span> |
|
1000 </dd> |
|
1001 </dl> |
|
1002 |
|
1003 <dl> |
|
1004 <dt>Returns: |
|
1005 <code property="yui:return"> |
|
1006 object |
|
1007 </code></dt> |
|
1008 <dd property="yui:returnInfo">the new merged object</dd> |
|
1009 </dl> |
|
1010 |
|
1011 |
|
1012 |
|
1013 |
|
1014 </div> |
|
1015 |
|
1016 </div> |
|
1017 <hr /> |
|
1018 </div> |
|
1019 <div class="" rel="yui:method" resource="#method_message"> |
|
1020 <h4> |
|
1021 <a name="method_message">message</a></h4> |
|
1022 <div class="detail" > |
|
1023 <code> |
|
1024 |
|
1025 |
|
1026 |
|
1027 YUI |
|
1028 <strong property="yui:name">message</strong> |
|
1029 ( |
|
1030 |
|
1031 |
|
1032 msg |
|
1033 |
|
1034 |
|
1035 , |
|
1036 cat |
|
1037 |
|
1038 |
|
1039 , |
|
1040 src |
|
1041 |
|
1042 |
|
1043 , |
|
1044 silent |
|
1045 |
|
1046 |
|
1047 ) |
|
1048 </code> |
|
1049 |
|
1050 <div class="description" property="yui:description"> |
|
1051 Write a system message. This message will be preserved in the |
|
1052 minified and raw versions of the YUI files, unlike log statements. |
|
1053 </div> |
|
1054 |
|
1055 <div class="description"> |
|
1056 |
|
1057 <dl rel="yui:parameters"> |
|
1058 <dt>Parameters:</dt> |
|
1059 <dd rel="yui:parameter"> |
|
1060 <code><span property="yui:name">msg</span> |
|
1061 <<span property="yui:type">String</span>> |
|
1062 </code> |
|
1063 <span property="yui:description"> The message to log.</span> |
|
1064 </dd> |
|
1065 <dd rel="yui:parameter"> |
|
1066 <code><span property="yui:name">cat</span> |
|
1067 <<span property="yui:type">String</span>> |
|
1068 </code> |
|
1069 <span property="yui:description"> The log category for the message. Default |
|
1070 categories are "info", "warn", "error", time". |
|
1071 Custom categories can be used as well. (opt)</span> |
|
1072 </dd> |
|
1073 <dd rel="yui:parameter"> |
|
1074 <code><span property="yui:name">src</span> |
|
1075 <<span property="yui:type">String</span>> |
|
1076 </code> |
|
1077 <span property="yui:description"> The source of the the message (opt)</span> |
|
1078 </dd> |
|
1079 <dd rel="yui:parameter"> |
|
1080 <code><span property="yui:name">silent</span> |
|
1081 <<span property="yui:type">boolean</span>> |
|
1082 </code> |
|
1083 <span property="yui:description"> If true, the log event won't fire</span> |
|
1084 </dd> |
|
1085 </dl> |
|
1086 |
|
1087 <dl> |
|
1088 <dt>Returns: |
|
1089 <code property="yui:return"> |
|
1090 YUI |
|
1091 </code></dt> |
|
1092 <dd property="yui:returnInfo">YUI instance</dd> |
|
1093 </dl> |
|
1094 |
|
1095 |
|
1096 |
|
1097 |
|
1098 </div> |
|
1099 |
|
1100 </div> |
|
1101 <hr /> |
|
1102 </div> |
|
1103 <div class="" rel="yui:method" resource="#method_mix"> |
|
1104 <h4> |
|
1105 <a name="method_mix">mix</a></h4> |
|
1106 <div class="detail" > |
|
1107 <code> |
|
1108 |
|
1109 |
|
1110 |
|
1111 object |
|
1112 <strong property="yui:name">mix</strong> |
|
1113 ( |
|
1114 |
|
1115 |
|
1116 r |
|
1117 |
|
1118 |
|
1119 , |
|
1120 s |
|
1121 |
|
1122 |
|
1123 , |
|
1124 ov |
|
1125 |
|
1126 |
|
1127 , |
|
1128 wl |
|
1129 |
|
1130 |
|
1131 , |
|
1132 mode |
|
1133 |
|
1134 |
|
1135 , |
|
1136 merge |
|
1137 |
|
1138 |
|
1139 ) |
|
1140 </code> |
|
1141 |
|
1142 <div class="description" property="yui:description"> |
|
1143 Applies the supplier's properties to the receiver. By default |
|
1144 all prototype and static propertes on the supplier are applied |
|
1145 to the corresponding spot on the receiver. By default all |
|
1146 properties are applied, and a property that is already on the |
|
1147 reciever will not be overwritten. The default behavior can |
|
1148 be modified by supplying the appropriate parameters. |
|
1149 </div> |
|
1150 |
|
1151 <div class="description"> |
|
1152 |
|
1153 <dl rel="yui:parameters"> |
|
1154 <dt>Parameters:</dt> |
|
1155 <dd rel="yui:parameter"> |
|
1156 <code><span property="yui:name">r</span> |
|
1157 <<span property="yui:type">Function</span>> |
|
1158 </code> |
|
1159 <span property="yui:description"> the object to receive the augmentation</span> |
|
1160 </dd> |
|
1161 <dd rel="yui:parameter"> |
|
1162 <code><span property="yui:name">s</span> |
|
1163 <<span property="yui:type">Function</span>> |
|
1164 </code> |
|
1165 <span property="yui:description"> the object that supplies the properties to augment</span> |
|
1166 </dd> |
|
1167 <dd rel="yui:parameter"> |
|
1168 <code><span property="yui:name">ov</span> |
|
1169 <<span property="yui:type">boolean</span>> |
|
1170 </code> |
|
1171 <span property="yui:description"> if true, properties already on the receiver |
|
1172 will be overwritten if found on the supplier.</span> |
|
1173 </dd> |
|
1174 <dd rel="yui:parameter"> |
|
1175 <code><span property="yui:name">wl</span> |
|
1176 <<span property="yui:type">string[]</span>> |
|
1177 </code> |
|
1178 <span property="yui:description"> a whitelist. If supplied, only properties in |
|
1179 this list will be applied to the receiver.</span> |
|
1180 </dd> |
|
1181 <dd rel="yui:parameter"> |
|
1182 <code><span property="yui:name">mode</span> |
|
1183 <<span property="yui:type">int</span>> |
|
1184 </code> |
|
1185 <span property="yui:description"> what should be copies, and to where |
|
1186 default(0): object to object |
|
1187 1: prototype to prototype (old augment) |
|
1188 2: prototype to prototype and object props (new augment) |
|
1189 3: prototype to object |
|
1190 4: object to prototype</span> |
|
1191 </dd> |
|
1192 <dd rel="yui:parameter"> |
|
1193 <code><span property="yui:name">merge</span> |
|
1194 <<span property="yui:type">boolean</span>> |
|
1195 </code> |
|
1196 <span property="yui:description"> merge objects instead of overwriting/ignoring |
|
1197 Used by Y.aggregate</span> |
|
1198 </dd> |
|
1199 </dl> |
|
1200 |
|
1201 <dl> |
|
1202 <dt>Returns: |
|
1203 <code property="yui:return"> |
|
1204 object |
|
1205 </code></dt> |
|
1206 <dd property="yui:returnInfo">the augmented object</dd> |
|
1207 </dl> |
|
1208 |
|
1209 |
|
1210 |
|
1211 |
|
1212 </div> |
|
1213 |
|
1214 </div> |
|
1215 <hr /> |
|
1216 </div> |
|
1217 <div class="" rel="yui:method" resource="#method_namespace"> |
|
1218 <h4> |
|
1219 <a name="method_namespace">namespace</a></h4> |
|
1220 <div class="detail" > |
|
1221 <code> |
|
1222 |
|
1223 |
|
1224 |
|
1225 object |
|
1226 <strong property="yui:name">namespace</strong> |
|
1227 ( |
|
1228 |
|
1229 |
|
1230 arguments |
|
1231 |
|
1232 |
|
1233 ) |
|
1234 </code> |
|
1235 |
|
1236 <div class="description" property="yui:description"> |
|
1237 Returns the namespace specified and creates it if it doesn't exist |
|
1238 <pre> |
|
1239 YUI.namespace("property.package"); |
|
1240 YUI.namespace("YAHOO.property.package"); |
|
1241 </pre> |
|
1242 Either of the above would create YUI.property, then |
|
1243 YUI.property.package (YAHOO is scrubbed out, this is |
|
1244 to remain compatible with YUI2) |
|
1245 Be careful when naming packages. Reserved words may work in some browsers |
|
1246 and not others. For instance, the following will fail in Safari: |
|
1247 <pre> |
|
1248 YUI.namespace("really.long.nested.namespace"); |
|
1249 </pre> |
|
1250 This fails because "long" is a future reserved word in ECMAScript |
|
1251 </div> |
|
1252 |
|
1253 <div class="description"> |
|
1254 |
|
1255 <dl rel="yui:parameters"> |
|
1256 <dt>Parameters:</dt> |
|
1257 <dd rel="yui:parameter"> |
|
1258 <code><span property="yui:name">arguments</span> |
|
1259 <<span property="yui:type">string*</span>> |
|
1260 </code> |
|
1261 <span property="yui:description"> 1-n namespaces to create</span> |
|
1262 </dd> |
|
1263 </dl> |
|
1264 |
|
1265 <dl> |
|
1266 <dt>Returns: |
|
1267 <code property="yui:return"> |
|
1268 object |
|
1269 </code></dt> |
|
1270 <dd property="yui:returnInfo">A reference to the last namespace object created</dd> |
|
1271 </dl> |
|
1272 |
|
1273 |
|
1274 |
|
1275 |
|
1276 </div> |
|
1277 |
|
1278 </div> |
|
1279 <hr /> |
|
1280 </div> |
|
1281 <div class="" rel="yui:method" resource="#method_Node.plug"> |
|
1282 <h4> |
|
1283 <a name="method_Node.plug">Node.plug</a></h4> |
|
1284 <div class="detail" > |
|
1285 <code> |
|
1286 |
|
1287 static |
|
1288 |
|
1289 void |
|
1290 <strong property="yui:name">Node.plug</strong> |
|
1291 ( |
|
1292 |
|
1293 |
|
1294 plugin |
|
1295 |
|
1296 |
|
1297 , |
|
1298 config |
|
1299 |
|
1300 |
|
1301 ) |
|
1302 </code> |
|
1303 |
|
1304 <div class="description" property="yui:description"> |
|
1305 Registers plugins to be instantiated at the class level (plugins |
|
1306 which should be plugged into every instance of Node by default). |
|
1307 </div> |
|
1308 |
|
1309 <div class="description"> |
|
1310 |
|
1311 <dl rel="yui:parameters"> |
|
1312 <dt>Parameters:</dt> |
|
1313 <dd rel="yui:parameter"> |
|
1314 <code><span property="yui:name">plugin</span> |
|
1315 <<span property="yui:type">Function | Array</span>> |
|
1316 </code> |
|
1317 <span property="yui:description"> Either the plugin class, an array of plugin classes or an array of objects (with fn and cfg properties defined)</span> |
|
1318 </dd> |
|
1319 <dd rel="yui:parameter"> |
|
1320 <code><span property="yui:name">config</span> |
|
1321 <<span property="yui:type">Object</span>> |
|
1322 </code> |
|
1323 <span property="yui:description"> (Optional) If plugin is the plugin class, the configuration for the plugin</span> |
|
1324 </dd> |
|
1325 </dl> |
|
1326 |
|
1327 |
|
1328 |
|
1329 |
|
1330 |
|
1331 </div> |
|
1332 |
|
1333 </div> |
|
1334 <hr /> |
|
1335 </div> |
|
1336 <div class="" rel="yui:method" resource="#method_Node.unplug"> |
|
1337 <h4> |
|
1338 <a name="method_Node.unplug">Node.unplug</a></h4> |
|
1339 <div class="detail" > |
|
1340 <code> |
|
1341 |
|
1342 static |
|
1343 |
|
1344 void |
|
1345 <strong property="yui:name">Node.unplug</strong> |
|
1346 ( |
|
1347 |
|
1348 |
|
1349 plugin |
|
1350 |
|
1351 |
|
1352 ) |
|
1353 </code> |
|
1354 |
|
1355 <div class="description" property="yui:description"> |
|
1356 Unregisters any class level plugins which have been registered by the Node |
|
1357 </div> |
|
1358 |
|
1359 <div class="description"> |
|
1360 |
|
1361 <dl rel="yui:parameters"> |
|
1362 <dt>Parameters:</dt> |
|
1363 <dd rel="yui:parameter"> |
|
1364 <code><span property="yui:name">plugin</span> |
|
1365 <<span property="yui:type">Function | Array</span>> |
|
1366 </code> |
|
1367 <span property="yui:description"> The plugin class, or an array of plugin classes</span> |
|
1368 </dd> |
|
1369 </dl> |
|
1370 |
|
1371 |
|
1372 |
|
1373 |
|
1374 |
|
1375 </div> |
|
1376 |
|
1377 </div> |
|
1378 <hr /> |
|
1379 </div> |
|
1380 <div class="" rel="yui:method" resource="#method_on"> |
|
1381 <h4> |
|
1382 <a name="method_on">on</a></h4> |
|
1383 <div class="detail" > |
|
1384 <code> |
|
1385 |
|
1386 |
|
1387 |
|
1388 |
|
1389 <strong property="yui:name">on</strong> |
|
1390 ( |
|
1391 |
|
1392 |
|
1393 type** |
|
1394 |
|
1395 |
|
1396 , |
|
1397 fn |
|
1398 |
|
1399 |
|
1400 , |
|
1401 target** |
|
1402 |
|
1403 |
|
1404 , |
|
1405 extra** |
|
1406 |
|
1407 |
|
1408 , |
|
1409 context |
|
1410 |
|
1411 |
|
1412 , |
|
1413 args* |
|
1414 |
|
1415 |
|
1416 ) |
|
1417 </code> |
|
1418 |
|
1419 <div class="description" property="yui:description"> |
|
1420 <code>YUI</code>'s <code>on</code> method is a unified interface for subscribing to |
|
1421 most events exposed by YUI. This includes custom events, DOM events, and |
|
1422 function events. <code>detach</code> is also provided to remove listeners |
|
1423 serviced by this function. |
|
1424 The signature that <code>on</code> accepts varies depending on the type |
|
1425 of event being consumed. Refer to the specific methods that will |
|
1426 service a specific request for additional information about subscribing |
|
1427 to that type of event. |
|
1428 <ul> |
|
1429 <li>Custom events. These events are defined by various |
|
1430 modules in the library. This type of event is delegated to |
|
1431 <code>EventTarget</code>'s <code>on</code> method. |
|
1432 <ul> |
|
1433 <li>The type of the event</li> |
|
1434 <li>The callback to execute</li> |
|
1435 <li>An optional context object</li> |
|
1436 <li>0..n additional arguments to supply the callback.</li> |
|
1437 </ul> |
|
1438 Example: |
|
1439 <code>Y.on('domready', function() { // start work });</code> |
|
1440 </li> |
|
1441 <li>DOM events. These are moments reported by the browser related |
|
1442 to browser functionality and user interaction. |
|
1443 This type of event is delegated to <code>Event</code>'s |
|
1444 <code>attach</code> method. |
|
1445 <ul> |
|
1446 <li>The type of the event</li> |
|
1447 <li>The callback to execute</li> |
|
1448 <li>The specification for the Node(s) to attach the listener |
|
1449 to. This can be a selector, collections, or Node/Element |
|
1450 refereces.</li> |
|
1451 <li>An optional context object</li> |
|
1452 <li>0..n additional arguments to supply the callback.</li> |
|
1453 </ul> |
|
1454 Example: |
|
1455 <code>Y.on('click', function(e) { // something was clicked }, '#someelement');</code> |
|
1456 </li> |
|
1457 <li>Function events. These events can be used to react before or after a |
|
1458 function is executed. This type of event is delegated to <code>Event.Do</code>'s |
|
1459 <code>before</code> method. |
|
1460 <ul> |
|
1461 <li>The callback to execute</li> |
|
1462 <li>The object that has the function that will be listened for.</li> |
|
1463 <li>The name of the function to listen for.</li> |
|
1464 <li>An optional context object</li> |
|
1465 <li>0..n additional arguments to supply the callback.</li> |
|
1466 </ul> |
|
1467 Example <code>Y.on(function(arg1, arg2, etc) { // obj.methodname was executed }, obj 'methodname');</code> |
|
1468 </li> |
|
1469 </ul> |
|
1470 <code>on</code> corresponds to the moment before any default behavior of |
|
1471 the event. <code>after</code> works the same way, but these listeners |
|
1472 execute after the event's default behavior. <code>before</code> is an |
|
1473 alias for <code>on</code>. |
|
1474 </div> |
|
1475 |
|
1476 <div class="description"> |
|
1477 |
|
1478 <dl rel="yui:parameters"> |
|
1479 <dt>Parameters:</dt> |
|
1480 <dd rel="yui:parameter"> |
|
1481 <code><span property="yui:name">type**</span> |
|
1482 <<span property="yui:type">object</span>> |
|
1483 </code> |
|
1484 <span property="yui:description"> event type (this parameter does not apply for function events)</span> |
|
1485 </dd> |
|
1486 <dd rel="yui:parameter"> |
|
1487 <code><span property="yui:name">fn</span> |
|
1488 <<span property="yui:type">object</span>> |
|
1489 </code> |
|
1490 <span property="yui:description"> the callback</span> |
|
1491 </dd> |
|
1492 <dd rel="yui:parameter"> |
|
1493 <code><span property="yui:name">target**</span> |
|
1494 <<span property="yui:type">object</span>> |
|
1495 </code> |
|
1496 <span property="yui:description"> a descriptor for the target (applies to custom events only). |
|
1497 For function events, this is the object that contains the function to |
|
1498 execute.</span> |
|
1499 </dd> |
|
1500 <dd rel="yui:parameter"> |
|
1501 <code><span property="yui:name">extra**</span> |
|
1502 <<span property="yui:type">object</span>> |
|
1503 </code> |
|
1504 <span property="yui:description"> 0..n Extra information a particular event may need. These |
|
1505 will be documented with the event. In the case of function events, this |
|
1506 is the name of the function to execute on the host. In the case of |
|
1507 delegate listeners, this is the event delegation specification.</span> |
|
1508 </dd> |
|
1509 <dd rel="yui:parameter"> |
|
1510 <code><span property="yui:name">context</span> |
|
1511 <<span property="yui:type">object</span>> |
|
1512 </code> |
|
1513 <span property="yui:description"> optionally change the value of 'this' in the callback</span> |
|
1514 </dd> |
|
1515 <dd rel="yui:parameter"> |
|
1516 <code><span property="yui:name">args*</span> |
|
1517 <<span property="yui:type">object</span>> |
|
1518 </code> |
|
1519 <span property="yui:description"> 0..n additional arguments to pass to the callback.</span> |
|
1520 </dd> |
|
1521 </dl> |
|
1522 |
|
1523 <dl> |
|
1524 <dt>Returns: |
|
1525 <code property="yui:return"> |
|
1526 </code></dt> |
|
1527 <dd property="yui:returnInfo">the event target or a detach handle per 'chain' config</dd> |
|
1528 </dl> |
|
1529 |
|
1530 |
|
1531 |
|
1532 |
|
1533 </div> |
|
1534 |
|
1535 </div> |
|
1536 <hr /> |
|
1537 </div> |
|
1538 <div class="" rel="yui:method" resource="#method_simulate"> |
|
1539 <h4> |
|
1540 <a name="method_simulate">simulate</a></h4> |
|
1541 <div class="detail" > |
|
1542 <code> |
|
1543 |
|
1544 static |
|
1545 |
|
1546 void |
|
1547 <strong property="yui:name">simulate</strong> |
|
1548 ( |
|
1549 |
|
1550 |
|
1551 target |
|
1552 |
|
1553 |
|
1554 , |
|
1555 type |
|
1556 |
|
1557 |
|
1558 , |
|
1559 options |
|
1560 |
|
1561 |
|
1562 ) |
|
1563 </code> |
|
1564 |
|
1565 <div class="description" property="yui:description"> |
|
1566 Simulates the event with the given name on a target. |
|
1567 </div> |
|
1568 |
|
1569 <div class="description"> |
|
1570 |
|
1571 <dl rel="yui:parameters"> |
|
1572 <dt>Parameters:</dt> |
|
1573 <dd rel="yui:parameter"> |
|
1574 <code><span property="yui:name">target</span> |
|
1575 <<span property="yui:type">HTMLElement</span>> |
|
1576 </code> |
|
1577 <span property="yui:description"> The DOM element that's the target of the event.</span> |
|
1578 </dd> |
|
1579 <dd rel="yui:parameter"> |
|
1580 <code><span property="yui:name">type</span> |
|
1581 <<span property="yui:type">String</span>> |
|
1582 </code> |
|
1583 <span property="yui:description"> The type of event to simulate (i.e., "click").</span> |
|
1584 </dd> |
|
1585 <dd rel="yui:parameter"> |
|
1586 <code><span property="yui:name">options</span> |
|
1587 <<span property="yui:type">Object</span>> |
|
1588 </code> |
|
1589 <span property="yui:description"> (Optional) Extra options to copy onto the event object.</span> |
|
1590 </dd> |
|
1591 </dl> |
|
1592 |
|
1593 |
|
1594 |
|
1595 |
|
1596 |
|
1597 </div> |
|
1598 |
|
1599 </div> |
|
1600 <hr /> |
|
1601 </div> |
|
1602 <div class="" rel="yui:method" resource="#method_stamp"> |
|
1603 <h4> |
|
1604 <a name="method_stamp">stamp</a></h4> |
|
1605 <div class="detail" > |
|
1606 <code> |
|
1607 |
|
1608 |
|
1609 |
|
1610 string |
|
1611 <strong property="yui:name">stamp</strong> |
|
1612 ( |
|
1613 |
|
1614 |
|
1615 o |
|
1616 |
|
1617 |
|
1618 , |
|
1619 readOnly |
|
1620 |
|
1621 |
|
1622 ) |
|
1623 </code> |
|
1624 |
|
1625 <div class="description" property="yui:description"> |
|
1626 Returns a guid associated with an object. If the object |
|
1627 does not have one, a new one is created unless readOnly |
|
1628 is specified. |
|
1629 </div> |
|
1630 |
|
1631 <div class="description"> |
|
1632 |
|
1633 <dl rel="yui:parameters"> |
|
1634 <dt>Parameters:</dt> |
|
1635 <dd rel="yui:parameter"> |
|
1636 <code><span property="yui:name">o</span> |
|
1637 <<span property="yui:type">object</span>> |
|
1638 </code> |
|
1639 <span property="yui:description"> The object to stamp</span> |
|
1640 </dd> |
|
1641 <dd rel="yui:parameter"> |
|
1642 <code><span property="yui:name">readOnly</span> |
|
1643 <<span property="yui:type">boolean</span>> |
|
1644 </code> |
|
1645 <span property="yui:description"> if true, a valid guid will only |
|
1646 be returned if the object has one assigned to it.</span> |
|
1647 </dd> |
|
1648 </dl> |
|
1649 |
|
1650 <dl> |
|
1651 <dt>Returns: |
|
1652 <code property="yui:return"> |
|
1653 string |
|
1654 </code></dt> |
|
1655 <dd property="yui:returnInfo">The object's guid or null</dd> |
|
1656 </dl> |
|
1657 |
|
1658 |
|
1659 |
|
1660 |
|
1661 </div> |
|
1662 |
|
1663 </div> |
|
1664 <hr /> |
|
1665 </div> |
|
1666 <div class="" rel="yui:method" resource="#method_use"> |
|
1667 <h4> |
|
1668 <a name="method_use">use</a></h4> |
|
1669 <div class="detail" > |
|
1670 <code> |
|
1671 |
|
1672 |
|
1673 |
|
1674 YUI |
|
1675 <strong property="yui:name">use</strong> |
|
1676 ( |
|
1677 |
|
1678 |
|
1679 modules* |
|
1680 |
|
1681 |
|
1682 , |
|
1683 *callback |
|
1684 |
|
1685 |
|
1686 ) |
|
1687 </code> |
|
1688 |
|
1689 <div class="description" property="yui:description"> |
|
1690 Bind a module to a YUI instance |
|
1691 </div> |
|
1692 |
|
1693 <div class="description"> |
|
1694 |
|
1695 <dl rel="yui:parameters"> |
|
1696 <dt>Parameters:</dt> |
|
1697 <dd rel="yui:parameter"> |
|
1698 <code><span property="yui:name">modules*</span> |
|
1699 <<span property="yui:type">string</span>> |
|
1700 </code> |
|
1701 <span property="yui:description"> 1-n modules to bind (uses arguments array)</span> |
|
1702 </dd> |
|
1703 <dd rel="yui:parameter"> |
|
1704 <code><span property="yui:name">*callback</span> |
|
1705 <<span property="yui:type">function</span>> |
|
1706 </code> |
|
1707 <span property="yui:description"> callback function executed when |
|
1708 the instance has the required functionality. If included, it |
|
1709 must be the last parameter.</span> |
|
1710 </dd> |
|
1711 </dl> |
|
1712 |
|
1713 <dl> |
|
1714 <dt>Returns: |
|
1715 <code property="yui:return"> |
|
1716 YUI |
|
1717 </code></dt> |
|
1718 <dd property="yui:returnInfo">the YUI instance</dd> |
|
1719 </dl> |
|
1720 |
|
1721 |
|
1722 |
|
1723 |
|
1724 </div> |
|
1725 |
|
1726 </div> |
|
1727 <hr /> |
|
1728 </div> |
|
1729 </div> |
|
1730 </div> |
|
1731 |
|
1732 <div rel="yui:inheritance"> |
|
1733 <div class="section field inheritance" rel="yui:superclass" resource="EventTarget.html"> |
|
1734 <h4>Methods inherited from <a href="EventTarget.html" property="yui:name" title="EventTarget">EventTarget</a>:</h4> |
|
1735 <div class="content" rel="yui:methods"> |
|
1736 <code> |
|
1737 <span rel="yui:method" resource="EventTarget.html#method__getType"> |
|
1738 <a class="private" href="EventTarget.html#method__getType" property="yui:name" title="_getType">_getType</a><span class="private">,</span> |
|
1739 </span> |
|
1740 <span rel="yui:method" resource="EventTarget.html#method__parseType"> |
|
1741 <a class="private" href="EventTarget.html#method__parseType" property="yui:name" title="_parseType">_parseType</a><span class="private">,</span> |
|
1742 </span> |
|
1743 <span rel="yui:method" resource="EventTarget.html#method_addTarget"> |
|
1744 <a class="" href="EventTarget.html#method_addTarget" property="yui:name" title="addTarget">addTarget</a><span class="">,</span> |
|
1745 </span> |
|
1746 <span rel="yui:method" resource="EventTarget.html#method_after"> |
|
1747 <a class="" href="EventTarget.html#method_after" property="yui:name" title="after">after</a><span class="">,</span> |
|
1748 </span> |
|
1749 <span rel="yui:method" resource="EventTarget.html#method_before"> |
|
1750 <a class=" deprecated" href="EventTarget.html#method_before" property="yui:name" title="before">before</a><span class=" deprecated">,</span> |
|
1751 </span> |
|
1752 <span rel="yui:method" resource="EventTarget.html#method_bubble"> |
|
1753 <a class="" href="EventTarget.html#method_bubble" property="yui:name" title="bubble">bubble</a><span class="">,</span> |
|
1754 </span> |
|
1755 <span rel="yui:method" resource="EventTarget.html#method_detach"> |
|
1756 <a class="" href="EventTarget.html#method_detach" property="yui:name" title="detach">detach</a><span class="">,</span> |
|
1757 </span> |
|
1758 <span rel="yui:method" resource="EventTarget.html#method_detachAll"> |
|
1759 <a class="" href="EventTarget.html#method_detachAll" property="yui:name" title="detachAll">detachAll</a><span class="">,</span> |
|
1760 </span> |
|
1761 <span rel="yui:method" resource="EventTarget.html#method_fire"> |
|
1762 <a class="" href="EventTarget.html#method_fire" property="yui:name" title="fire">fire</a><span class="">,</span> |
|
1763 </span> |
|
1764 <span rel="yui:method" resource="EventTarget.html#method_getEvent"> |
|
1765 <a class="" href="EventTarget.html#method_getEvent" property="yui:name" title="getEvent">getEvent</a><span class="">,</span> |
|
1766 </span> |
|
1767 <span rel="yui:method" resource="EventTarget.html#method_on"> |
|
1768 <a class="" href="EventTarget.html#method_on" property="yui:name" title="on">on</a><span class="">,</span> |
|
1769 </span> |
|
1770 <span rel="yui:method" resource="EventTarget.html#method_publish"> |
|
1771 <a class="" href="EventTarget.html#method_publish" property="yui:name" title="publish">publish</a><span class="">,</span> |
|
1772 </span> |
|
1773 <span rel="yui:method" resource="EventTarget.html#method_removeTarget"> |
|
1774 <a class="" href="EventTarget.html#method_removeTarget" property="yui:name" title="removeTarget">removeTarget</a><span class="">,</span> |
|
1775 </span> |
|
1776 <span rel="yui:method" resource="EventTarget.html#method_subscribe"> |
|
1777 <a class=" deprecated" href="EventTarget.html#method_subscribe" property="yui:name" title="subscribe">subscribe</a><span class=" deprecated">,</span> |
|
1778 </span> |
|
1779 <span rel="yui:method" resource="EventTarget.html#method_unsubscribe"> |
|
1780 <a class=" deprecated" href="EventTarget.html#method_unsubscribe" property="yui:name" title="unsubscribe">unsubscribe</a><span class=" deprecated">,</span> |
|
1781 </span> |
|
1782 <span rel="yui:method" resource="EventTarget.html#method_unsubscribeAll"> |
|
1783 <a class=" deprecated" href="EventTarget.html#method_unsubscribeAll" property="yui:name" title="unsubscribeAll">unsubscribeAll</a> |
|
1784 </span> |
|
1785 </code> |
|
1786 </div> |
|
1787 </div> |
|
1788 </div> |
|
1789 </div> |
|
1790 |
|
1791 <div rel="yui:events" resource="#events"> |
|
1792 <div class="section method details"> |
|
1793 <h3 id="events">Events</h3> |
|
1794 <div class="content"> |
|
1795 <div class="" rel="yui:event" resource="#event_available"> |
|
1796 <h4> |
|
1797 <a name="event_available">available</a></h4> |
|
1798 <div class="detail"> |
|
1799 <code> |
|
1800 |
|
1801 |
|
1802 |
|
1803 <strong property="yui:name">available</strong> |
|
1804 |
|
1805 ( |
|
1806 |
|
1807 |
|
1808 type |
|
1809 |
|
1810 |
|
1811 , |
|
1812 fn |
|
1813 |
|
1814 |
|
1815 , |
|
1816 el |
|
1817 |
|
1818 |
|
1819 , |
|
1820 context |
|
1821 |
|
1822 |
|
1823 , |
|
1824 args* |
|
1825 |
|
1826 |
|
1827 ) |
|
1828 |
|
1829 </code> |
|
1830 |
|
1831 <div class="description" property="yui:description"> |
|
1832 Executes the callback as soon as the specified element |
|
1833 is detected in the DOM. |
|
1834 </div> |
|
1835 |
|
1836 <div class="description"> |
|
1837 |
|
1838 |
|
1839 <dl rel="yui:parameters"> |
|
1840 <dt>Parameters:</dt> |
|
1841 <dd rel="yui:parameter"> |
|
1842 <code><span property="yui:name">type</span> |
|
1843 <<span property="yui:type">string</span>> |
|
1844 </code> |
|
1845 <span property="yui:description"> 'available'</span> |
|
1846 </dd> |
|
1847 |
|
1848 <dd rel="yui:parameter"> |
|
1849 <code><span property="yui:name">fn</span> |
|
1850 <<span property="yui:type">function</span>> |
|
1851 </code> |
|
1852 <span property="yui:description"> the callback function to execute.</span> |
|
1853 </dd> |
|
1854 |
|
1855 <dd rel="yui:parameter"> |
|
1856 <code><span property="yui:name">el</span> |
|
1857 <<span property="yui:type">string|HTMLElement|collection</span>> |
|
1858 </code> |
|
1859 <span property="yui:description"> the element(s) to attach</span> |
|
1860 </dd> |
|
1861 |
|
1862 <dd rel="yui:parameter"> |
|
1863 <code><span property="yui:name">context</span> |
|
1864 <<span property="yui:type">object</span>> |
|
1865 </code> |
|
1866 <span property="yui:description"> optional argument that specifies what 'this' refers to.</span> |
|
1867 </dd> |
|
1868 |
|
1869 <dd rel="yui:parameter"> |
|
1870 <code><span property="yui:name">args*</span> |
|
1871 <<span property="yui:type">object</span>> |
|
1872 </code> |
|
1873 <span property="yui:description"> 0..n additional arguments to pass on to the callback function. |
|
1874 These arguments will be added after the event object.</span> |
|
1875 </dd> |
|
1876 |
|
1877 </dl> |
|
1878 |
|
1879 |
|
1880 </div> |
|
1881 |
|
1882 </div> |
|
1883 <hr /> |
|
1884 </div> |
|
1885 <div class="" rel="yui:event" resource="#event_blur"> |
|
1886 <h4> |
|
1887 <a name="event_blur">blur</a></h4> |
|
1888 <div class="detail"> |
|
1889 <code> |
|
1890 |
|
1891 |
|
1892 |
|
1893 <strong property="yui:name">blur</strong> |
|
1894 |
|
1895 ( |
|
1896 |
|
1897 |
|
1898 type |
|
1899 |
|
1900 |
|
1901 , |
|
1902 fn |
|
1903 |
|
1904 |
|
1905 , |
|
1906 o |
|
1907 |
|
1908 |
|
1909 , |
|
1910 context |
|
1911 |
|
1912 |
|
1913 , |
|
1914 args |
|
1915 |
|
1916 |
|
1917 ) |
|
1918 |
|
1919 </code> |
|
1920 |
|
1921 <div class="description" property="yui:description"> |
|
1922 Adds a DOM blur listener. Uses the focusout event in IE, |
|
1923 DOMFocusOut for Opera and Webkit, and the capture phase for Gecko so that |
|
1924 the event propagates in a way that enables event delegation. |
|
1925 </div> |
|
1926 |
|
1927 <div class="description"> |
|
1928 |
|
1929 |
|
1930 <dl rel="yui:parameters"> |
|
1931 <dt>Parameters:</dt> |
|
1932 <dd rel="yui:parameter"> |
|
1933 <code><span property="yui:name">type</span> |
|
1934 <<span property="yui:type">string</span>> |
|
1935 </code> |
|
1936 <span property="yui:description"> 'blur'</span> |
|
1937 </dd> |
|
1938 |
|
1939 <dd rel="yui:parameter"> |
|
1940 <code><span property="yui:name">fn</span> |
|
1941 <<span property="yui:type">function</span>> |
|
1942 </code> |
|
1943 <span property="yui:description"> the callback function to execute</span> |
|
1944 </dd> |
|
1945 |
|
1946 <dd rel="yui:parameter"> |
|
1947 <code><span property="yui:name">o</span> |
|
1948 <<span property="yui:type">string|HTMLElement|collection</span>> |
|
1949 </code> |
|
1950 <span property="yui:description"> the element(s) to bind</span> |
|
1951 </dd> |
|
1952 |
|
1953 <dd rel="yui:parameter"> |
|
1954 <code><span property="yui:name">context</span> |
|
1955 <<span property="yui:type">object</span>> |
|
1956 </code> |
|
1957 <span property="yui:description"> optional context object</span> |
|
1958 </dd> |
|
1959 |
|
1960 <dd rel="yui:parameter"> |
|
1961 <code><span property="yui:name">args</span> |
|
1962 <<span property="yui:type">object</span>> |
|
1963 </code> |
|
1964 <span property="yui:description"> 0..n additional arguments to provide to the listener.</span> |
|
1965 </dd> |
|
1966 |
|
1967 </dl> |
|
1968 |
|
1969 |
|
1970 </div> |
|
1971 |
|
1972 </div> |
|
1973 <hr /> |
|
1974 </div> |
|
1975 <div class="" rel="yui:event" resource="#event_contentready"> |
|
1976 <h4> |
|
1977 <a name="event_contentready">contentready</a></h4> |
|
1978 <div class="detail"> |
|
1979 <code> |
|
1980 |
|
1981 |
|
1982 |
|
1983 <strong property="yui:name">contentready</strong> |
|
1984 |
|
1985 ( |
|
1986 |
|
1987 |
|
1988 type |
|
1989 |
|
1990 |
|
1991 , |
|
1992 fn |
|
1993 |
|
1994 |
|
1995 , |
|
1996 el |
|
1997 |
|
1998 |
|
1999 , |
|
2000 context |
|
2001 |
|
2002 |
|
2003 , |
|
2004 args* |
|
2005 |
|
2006 |
|
2007 ) |
|
2008 |
|
2009 </code> |
|
2010 |
|
2011 <div class="description" property="yui:description"> |
|
2012 Executes the callback as soon as the specified element |
|
2013 is detected in the DOM with a nextSibling property |
|
2014 (indicating that the element's children are available) |
|
2015 </div> |
|
2016 |
|
2017 <div class="description"> |
|
2018 |
|
2019 |
|
2020 <dl rel="yui:parameters"> |
|
2021 <dt>Parameters:</dt> |
|
2022 <dd rel="yui:parameter"> |
|
2023 <code><span property="yui:name">type</span> |
|
2024 <<span property="yui:type">string</span>> |
|
2025 </code> |
|
2026 <span property="yui:description"> 'contentready'</span> |
|
2027 </dd> |
|
2028 |
|
2029 <dd rel="yui:parameter"> |
|
2030 <code><span property="yui:name">fn</span> |
|
2031 <<span property="yui:type">function</span>> |
|
2032 </code> |
|
2033 <span property="yui:description"> the callback function to execute.</span> |
|
2034 </dd> |
|
2035 |
|
2036 <dd rel="yui:parameter"> |
|
2037 <code><span property="yui:name">el</span> |
|
2038 <<span property="yui:type">string|HTMLElement|collection</span>> |
|
2039 </code> |
|
2040 <span property="yui:description"> the element(s) to attach</span> |
|
2041 </dd> |
|
2042 |
|
2043 <dd rel="yui:parameter"> |
|
2044 <code><span property="yui:name">context</span> |
|
2045 <<span property="yui:type">object</span>> |
|
2046 </code> |
|
2047 <span property="yui:description"> optional argument that specifies what 'this' refers to.</span> |
|
2048 </dd> |
|
2049 |
|
2050 <dd rel="yui:parameter"> |
|
2051 <code><span property="yui:name">args*</span> |
|
2052 <<span property="yui:type">object</span>> |
|
2053 </code> |
|
2054 <span property="yui:description"> 0..n additional arguments to pass on to the callback function. |
|
2055 These arguments will be added after the event object.</span> |
|
2056 </dd> |
|
2057 |
|
2058 </dl> |
|
2059 |
|
2060 |
|
2061 </div> |
|
2062 |
|
2063 </div> |
|
2064 <hr /> |
|
2065 </div> |
|
2066 <div class=" deprecated" rel="yui:event" resource="#event_delegate"> |
|
2067 <h4> |
|
2068 <a name="event_delegate">delegate</a></h4> |
|
2069 <div class="detail"> |
|
2070 <code> |
|
2071 |
|
2072 |
|
2073 |
|
2074 <strong property="yui:name">delegate</strong> |
|
2075 |
|
2076 ( |
|
2077 |
|
2078 |
|
2079 type |
|
2080 |
|
2081 |
|
2082 , |
|
2083 fn |
|
2084 |
|
2085 |
|
2086 , |
|
2087 el |
|
2088 |
|
2089 |
|
2090 , |
|
2091 delegateType |
|
2092 |
|
2093 |
|
2094 , |
|
2095 spec |
|
2096 |
|
2097 |
|
2098 , |
|
2099 context |
|
2100 |
|
2101 |
|
2102 , |
|
2103 args* |
|
2104 |
|
2105 |
|
2106 ) |
|
2107 |
|
2108 </code> |
|
2109 |
|
2110 <div class="description" property="yui:description"> |
|
2111 Sets up event delegation on a container element. The delegated event |
|
2112 will use a supplied selector to test if the target or one of the |
|
2113 descendants of the target match it. The supplied callback function |
|
2114 will only be executed if a match was encountered, and, in fact, |
|
2115 will be executed for each element that matches if you supply an |
|
2116 ambiguous selector. |
|
2117 The event object for the delegated event is supplied to the callback |
|
2118 function. It is modified slightly in order to support all properties |
|
2119 that may be needed for event delegation. 'currentTarget' is set to |
|
2120 the element that matched the delegation specifcation. 'container' is |
|
2121 set to the element that the listener is bound to (this normally would |
|
2122 be the 'currentTarget'). |
|
2123 </div> |
|
2124 |
|
2125 <div class="description"> |
|
2126 |
|
2127 |
|
2128 <dl rel="yui:parameters"> |
|
2129 <dt>Parameters:</dt> |
|
2130 <dd rel="yui:parameter"> |
|
2131 <code><span property="yui:name">type</span> |
|
2132 <<span property="yui:type">string</span>> |
|
2133 </code> |
|
2134 <span property="yui:description"> 'delegate'</span> |
|
2135 </dd> |
|
2136 |
|
2137 <dd rel="yui:parameter"> |
|
2138 <code><span property="yui:name">fn</span> |
|
2139 <<span property="yui:type">function</span>> |
|
2140 </code> |
|
2141 <span property="yui:description"> the callback function to execute. This function |
|
2142 will be provided the event object for the delegated event.</span> |
|
2143 </dd> |
|
2144 |
|
2145 <dd rel="yui:parameter"> |
|
2146 <code><span property="yui:name">el</span> |
|
2147 <<span property="yui:type">string|node</span>> |
|
2148 </code> |
|
2149 <span property="yui:description"> the element that is the delegation container</span> |
|
2150 </dd> |
|
2151 |
|
2152 <dd rel="yui:parameter"> |
|
2153 <code><span property="yui:name">delegateType</span> |
|
2154 <<span property="yui:type">string</span>> |
|
2155 </code> |
|
2156 <span property="yui:description"> the event type to delegate</span> |
|
2157 </dd> |
|
2158 |
|
2159 <dd rel="yui:parameter"> |
|
2160 <code><span property="yui:name">spec</span> |
|
2161 <<span property="yui:type">string</span>> |
|
2162 </code> |
|
2163 <span property="yui:description"> a selector that must match the target of the |
|
2164 event.</span> |
|
2165 </dd> |
|
2166 |
|
2167 <dd rel="yui:parameter"> |
|
2168 <code><span property="yui:name">context</span> |
|
2169 <<span property="yui:type">object</span>> |
|
2170 </code> |
|
2171 <span property="yui:description"> optional argument that specifies what 'this' refers to.</span> |
|
2172 </dd> |
|
2173 |
|
2174 <dd rel="yui:parameter"> |
|
2175 <code><span property="yui:name">args*</span> |
|
2176 <<span property="yui:type">object</span>> |
|
2177 </code> |
|
2178 <span property="yui:description"> 0..n additional arguments to pass on to the callback function. |
|
2179 These arguments will be added after the event object.</span> |
|
2180 </dd> |
|
2181 |
|
2182 </dl> |
|
2183 |
|
2184 |
|
2185 <div class="deprecated"> |
|
2186 <strong>Deprecated</strong> use Y.delegate |
|
2187 </div> |
|
2188 </div> |
|
2189 |
|
2190 </div> |
|
2191 <hr /> |
|
2192 </div> |
|
2193 <div class="" rel="yui:event" resource="#event_focus"> |
|
2194 <h4> |
|
2195 <a name="event_focus">focus</a></h4> |
|
2196 <div class="detail"> |
|
2197 <code> |
|
2198 |
|
2199 |
|
2200 |
|
2201 <strong property="yui:name">focus</strong> |
|
2202 |
|
2203 ( |
|
2204 |
|
2205 |
|
2206 type |
|
2207 |
|
2208 |
|
2209 , |
|
2210 fn |
|
2211 |
|
2212 |
|
2213 , |
|
2214 o |
|
2215 |
|
2216 |
|
2217 , |
|
2218 context |
|
2219 |
|
2220 |
|
2221 , |
|
2222 args |
|
2223 |
|
2224 |
|
2225 ) |
|
2226 |
|
2227 </code> |
|
2228 |
|
2229 <div class="description" property="yui:description"> |
|
2230 Adds a DOM focus listener. Uses the focusin event in IE, |
|
2231 DOMFocusIn for Opera and Webkit, and the capture phase for Gecko so that |
|
2232 the event propagates in a way that enables event delegation. |
|
2233 </div> |
|
2234 |
|
2235 <div class="description"> |
|
2236 |
|
2237 |
|
2238 <dl rel="yui:parameters"> |
|
2239 <dt>Parameters:</dt> |
|
2240 <dd rel="yui:parameter"> |
|
2241 <code><span property="yui:name">type</span> |
|
2242 <<span property="yui:type">string</span>> |
|
2243 </code> |
|
2244 <span property="yui:description"> 'focus'</span> |
|
2245 </dd> |
|
2246 |
|
2247 <dd rel="yui:parameter"> |
|
2248 <code><span property="yui:name">fn</span> |
|
2249 <<span property="yui:type">function</span>> |
|
2250 </code> |
|
2251 <span property="yui:description"> the callback function to execute</span> |
|
2252 </dd> |
|
2253 |
|
2254 <dd rel="yui:parameter"> |
|
2255 <code><span property="yui:name">o</span> |
|
2256 <<span property="yui:type">string|HTMLElement|collection</span>> |
|
2257 </code> |
|
2258 <span property="yui:description"> the element(s) to bind</span> |
|
2259 </dd> |
|
2260 |
|
2261 <dd rel="yui:parameter"> |
|
2262 <code><span property="yui:name">context</span> |
|
2263 <<span property="yui:type">object</span>> |
|
2264 </code> |
|
2265 <span property="yui:description"> optional context object</span> |
|
2266 </dd> |
|
2267 |
|
2268 <dd rel="yui:parameter"> |
|
2269 <code><span property="yui:name">args</span> |
|
2270 <<span property="yui:type">object</span>> |
|
2271 </code> |
|
2272 <span property="yui:description"> 0..n additional arguments to provide to the listener.</span> |
|
2273 </dd> |
|
2274 |
|
2275 </dl> |
|
2276 |
|
2277 |
|
2278 </div> |
|
2279 |
|
2280 </div> |
|
2281 <hr /> |
|
2282 </div> |
|
2283 <div class="" rel="yui:event" resource="#event_key"> |
|
2284 <h4> |
|
2285 <a name="event_key">key</a></h4> |
|
2286 <div class="detail"> |
|
2287 <code> |
|
2288 |
|
2289 |
|
2290 |
|
2291 <strong property="yui:name">key</strong> |
|
2292 |
|
2293 ( |
|
2294 |
|
2295 |
|
2296 type |
|
2297 |
|
2298 |
|
2299 , |
|
2300 fn |
|
2301 |
|
2302 |
|
2303 , |
|
2304 id |
|
2305 |
|
2306 |
|
2307 , |
|
2308 spec |
|
2309 |
|
2310 |
|
2311 , |
|
2312 o |
|
2313 |
|
2314 |
|
2315 , |
|
2316 args |
|
2317 |
|
2318 |
|
2319 ) |
|
2320 |
|
2321 </code> |
|
2322 |
|
2323 <div class="description" property="yui:description"> |
|
2324 Add a key listener. The listener will only be notified if the |
|
2325 keystroke detected meets the supplied specification. The |
|
2326 spec consists of the key event type, followed by a colon, |
|
2327 followed by zero or more comma separated key codes, followed |
|
2328 by zero or more modifiers delimited by a plus sign. Ex: |
|
2329 press:12,65+shift+ctrl |
|
2330 </div> |
|
2331 |
|
2332 <div class="description"> |
|
2333 |
|
2334 |
|
2335 <dl rel="yui:parameters"> |
|
2336 <dt>Parameters:</dt> |
|
2337 <dd rel="yui:parameter"> |
|
2338 <code><span property="yui:name">type</span> |
|
2339 <<span property="yui:type">string</span>> |
|
2340 </code> |
|
2341 <span property="yui:description"> 'key'</span> |
|
2342 </dd> |
|
2343 |
|
2344 <dd rel="yui:parameter"> |
|
2345 <code><span property="yui:name">fn</span> |
|
2346 <<span property="yui:type">function</span>> |
|
2347 </code> |
|
2348 <span property="yui:description"> the function to execute</span> |
|
2349 </dd> |
|
2350 |
|
2351 <dd rel="yui:parameter"> |
|
2352 <code><span property="yui:name">id</span> |
|
2353 <<span property="yui:type">string|HTMLElement|collection</span>> |
|
2354 </code> |
|
2355 <span property="yui:description"> the element(s) to bind</span> |
|
2356 </dd> |
|
2357 |
|
2358 <dd rel="yui:parameter"> |
|
2359 <code><span property="yui:name">spec</span> |
|
2360 <<span property="yui:type">string</span>> |
|
2361 </code> |
|
2362 <span property="yui:description"> the keyCode and modifier specification</span> |
|
2363 </dd> |
|
2364 |
|
2365 <dd rel="yui:parameter"> |
|
2366 <code><span property="yui:name">o</span> |
|
2367 <<span property="yui:type">object</span>> |
|
2368 </code> |
|
2369 <span property="yui:description"> optional context object</span> |
|
2370 </dd> |
|
2371 |
|
2372 <dd rel="yui:parameter"> |
|
2373 <code><span property="yui:name">args</span> |
|
2374 <<span property="yui:type">object</span>> |
|
2375 </code> |
|
2376 <span property="yui:description"> 0..n additional arguments to provide to the listener.</span> |
|
2377 </dd> |
|
2378 |
|
2379 </dl> |
|
2380 |
|
2381 |
|
2382 </div> |
|
2383 |
|
2384 </div> |
|
2385 <hr /> |
|
2386 </div> |
|
2387 <div class="" rel="yui:event" resource="#event_mouseenter"> |
|
2388 <h4> |
|
2389 <a name="event_mouseenter">mouseenter</a></h4> |
|
2390 <div class="detail"> |
|
2391 <code> |
|
2392 |
|
2393 |
|
2394 |
|
2395 <strong property="yui:name">mouseenter</strong> |
|
2396 |
|
2397 ( |
|
2398 |
|
2399 |
|
2400 type |
|
2401 |
|
2402 |
|
2403 , |
|
2404 fn |
|
2405 |
|
2406 |
|
2407 , |
|
2408 el |
|
2409 |
|
2410 |
|
2411 , |
|
2412 spec |
|
2413 |
|
2414 |
|
2415 ) |
|
2416 |
|
2417 </code> |
|
2418 |
|
2419 <div class="description" property="yui:description"> |
|
2420 Sets up a "mouseenter" listener—a listener that is called the first time |
|
2421 the user's mouse enters the specified element(s). |
|
2422 </div> |
|
2423 |
|
2424 <div class="description"> |
|
2425 |
|
2426 |
|
2427 <dl rel="yui:parameters"> |
|
2428 <dt>Parameters:</dt> |
|
2429 <dd rel="yui:parameter"> |
|
2430 <code><span property="yui:name">type</span> |
|
2431 <<span property="yui:type">string</span>> |
|
2432 </code> |
|
2433 <span property="yui:description"> "mouseenter"</span> |
|
2434 </dd> |
|
2435 |
|
2436 <dd rel="yui:parameter"> |
|
2437 <code><span property="yui:name">fn</span> |
|
2438 <<span property="yui:type">function</span>> |
|
2439 </code> |
|
2440 <span property="yui:description"> The method the event invokes.</span> |
|
2441 </dd> |
|
2442 |
|
2443 <dd rel="yui:parameter"> |
|
2444 <code><span property="yui:name">el</span> |
|
2445 <<span property="yui:type">string|node</span>> |
|
2446 </code> |
|
2447 <span property="yui:description"> The element(s) to assign the listener to.</span> |
|
2448 </dd> |
|
2449 |
|
2450 <dd rel="yui:parameter"> |
|
2451 <code><span property="yui:name">spec</span> |
|
2452 <<span property="yui:type">string</span>> |
|
2453 </code> |
|
2454 <span property="yui:description"> Optional. String representing a selector that must |
|
2455 match the target of the event in order for the listener to be called.</span> |
|
2456 </dd> |
|
2457 |
|
2458 </dl> |
|
2459 |
|
2460 |
|
2461 </div> |
|
2462 |
|
2463 </div> |
|
2464 <hr /> |
|
2465 </div> |
|
2466 <div class="" rel="yui:event" resource="#event_mouseleave"> |
|
2467 <h4> |
|
2468 <a name="event_mouseleave">mouseleave</a></h4> |
|
2469 <div class="detail"> |
|
2470 <code> |
|
2471 |
|
2472 |
|
2473 |
|
2474 <strong property="yui:name">mouseleave</strong> |
|
2475 |
|
2476 ( |
|
2477 |
|
2478 |
|
2479 type |
|
2480 |
|
2481 |
|
2482 , |
|
2483 fn |
|
2484 |
|
2485 |
|
2486 , |
|
2487 el |
|
2488 |
|
2489 |
|
2490 , |
|
2491 spec |
|
2492 |
|
2493 |
|
2494 ) |
|
2495 |
|
2496 </code> |
|
2497 |
|
2498 <div class="description" property="yui:description"> |
|
2499 Sets up a "mouseleave" listener—a listener that is called the first time |
|
2500 the user's mouse leaves the specified element(s). |
|
2501 </div> |
|
2502 |
|
2503 <div class="description"> |
|
2504 |
|
2505 |
|
2506 <dl rel="yui:parameters"> |
|
2507 <dt>Parameters:</dt> |
|
2508 <dd rel="yui:parameter"> |
|
2509 <code><span property="yui:name">type</span> |
|
2510 <<span property="yui:type">string</span>> |
|
2511 </code> |
|
2512 <span property="yui:description"> "mouseleave"</span> |
|
2513 </dd> |
|
2514 |
|
2515 <dd rel="yui:parameter"> |
|
2516 <code><span property="yui:name">fn</span> |
|
2517 <<span property="yui:type">function</span>> |
|
2518 </code> |
|
2519 <span property="yui:description"> The method the event invokes.</span> |
|
2520 </dd> |
|
2521 |
|
2522 <dd rel="yui:parameter"> |
|
2523 <code><span property="yui:name">el</span> |
|
2524 <<span property="yui:type">string|node</span>> |
|
2525 </code> |
|
2526 <span property="yui:description"> The element(s) to assign the listener to.</span> |
|
2527 </dd> |
|
2528 |
|
2529 <dd rel="yui:parameter"> |
|
2530 <code><span property="yui:name">spec</span> |
|
2531 <<span property="yui:type">string</span>> |
|
2532 </code> |
|
2533 <span property="yui:description"> Optional. String representing a selector that must |
|
2534 match the target of the event in order for the listener to be called.</span> |
|
2535 </dd> |
|
2536 |
|
2537 </dl> |
|
2538 |
|
2539 |
|
2540 </div> |
|
2541 |
|
2542 </div> |
|
2543 <hr /> |
|
2544 </div> |
|
2545 <div class="" rel="yui:event" resource="#event_mousewheel"> |
|
2546 <h4> |
|
2547 <a name="event_mousewheel">mousewheel</a></h4> |
|
2548 <div class="detail"> |
|
2549 <code> |
|
2550 |
|
2551 |
|
2552 |
|
2553 <strong property="yui:name">mousewheel</strong> |
|
2554 |
|
2555 ( |
|
2556 |
|
2557 |
|
2558 type |
|
2559 |
|
2560 |
|
2561 , |
|
2562 fn |
|
2563 |
|
2564 |
|
2565 , |
|
2566 context |
|
2567 |
|
2568 |
|
2569 , |
|
2570 args |
|
2571 |
|
2572 |
|
2573 ) |
|
2574 |
|
2575 </code> |
|
2576 |
|
2577 <div class="description" property="yui:description"> |
|
2578 Mousewheel event. This listener is automatically attached to the |
|
2579 correct target, so one should not be supplied. Mouse wheel |
|
2580 direction and velocity is stored in the 'mouseDelta' field. |
|
2581 </div> |
|
2582 |
|
2583 <div class="description"> |
|
2584 |
|
2585 |
|
2586 <dl rel="yui:parameters"> |
|
2587 <dt>Parameters:</dt> |
|
2588 <dd rel="yui:parameter"> |
|
2589 <code><span property="yui:name">type</span> |
|
2590 <<span property="yui:type">string</span>> |
|
2591 </code> |
|
2592 <span property="yui:description"> 'mousewheel'</span> |
|
2593 </dd> |
|
2594 |
|
2595 <dd rel="yui:parameter"> |
|
2596 <code><span property="yui:name">fn</span> |
|
2597 <<span property="yui:type">function</span>> |
|
2598 </code> |
|
2599 <span property="yui:description"> the callback to execute</span> |
|
2600 </dd> |
|
2601 |
|
2602 <dd rel="yui:parameter"> |
|
2603 <code><span property="yui:name">context</span> |
|
2604 <<span property="yui:type">object</span>> |
|
2605 </code> |
|
2606 <span property="yui:description"> optional context object</span> |
|
2607 </dd> |
|
2608 |
|
2609 <dd rel="yui:parameter"> |
|
2610 <code><span property="yui:name">args</span> |
|
2611 <<span property="yui:type">object</span>> |
|
2612 </code> |
|
2613 <span property="yui:description"> 0..n additional arguments to provide to the listener.</span> |
|
2614 </dd> |
|
2615 |
|
2616 </dl> |
|
2617 |
|
2618 |
|
2619 </div> |
|
2620 |
|
2621 </div> |
|
2622 <hr /> |
|
2623 </div> |
|
2624 <div class="" rel="yui:event" resource="#event_windowresize"> |
|
2625 <h4> |
|
2626 <a name="event_windowresize">windowresize</a></h4> |
|
2627 <div class="detail"> |
|
2628 <code> |
|
2629 |
|
2630 |
|
2631 |
|
2632 <strong property="yui:name">windowresize</strong> |
|
2633 |
|
2634 ( |
|
2635 ) |
|
2636 |
|
2637 </code> |
|
2638 |
|
2639 <div class="description" property="yui:description"> |
|
2640 Firefox fires the window resize event once when the resize action |
|
2641 finishes, other browsers fire the event periodically during the |
|
2642 resize. This code uses timeout logic to simulate the Firefox |
|
2643 behavior in other browsers. |
|
2644 </div> |
|
2645 |
|
2646 <div class="description"> |
|
2647 |
|
2648 |
|
2649 |
|
2650 |
|
2651 </div> |
|
2652 |
|
2653 </div> |
|
2654 <hr /> |
|
2655 </div> |
|
2656 </div> |
|
2657 </div> |
|
2658 |
|
2659 |
|
2660 </div> |
|
2661 |
|
2662 <div rel="yui:attributes" resource="#configattributes"> |
|
2663 |
|
2664 </div> |
|
2665 |
|
2666 </div> |
|
2667 </div> |
|
2668 <div class="yui-b"> |
|
2669 <div class="nav"> |
|
2670 |
|
2671 <div id="moduleList" class="module"> |
|
2672 <h4>Modules</h4> |
|
2673 <ul class="content"> |
|
2674 <li class=""><a href="module_anim.html" title="anim">anim</a></li> |
|
2675 <li class=""><a href="module_async-queue.html" title="async-queue">async-queue</a></li> |
|
2676 <li class=""><a href="module_attribute.html" title="attribute">attribute</a></li> |
|
2677 <li class=""><a href="module_base.html" title="base">base</a></li> |
|
2678 <li class=""><a href="module_cache.html" title="cache">cache</a></li> |
|
2679 <li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li> |
|
2680 <li class=""><a href="module_collection.html" title="collection">collection</a></li> |
|
2681 <li class=""><a href="module_console.html" title="console">console</a></li> |
|
2682 <li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li> |
|
2683 <li class=""><a href="module_cookie.html" title="cookie">cookie</a></li> |
|
2684 <li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li> |
|
2685 <li class=""><a href="module_datasource.html" title="datasource">datasource</a></li> |
|
2686 <li class=""><a href="module_datatype.html" title="datatype">datatype</a></li> |
|
2687 <li class=""><a href="module_dd.html" title="dd">dd</a></li> |
|
2688 <li class=""><a href="module_dom.html" title="dom">dom</a></li> |
|
2689 <li class=""><a href="module_dump.html" title="dump">dump</a></li> |
|
2690 <li class=""><a href="module_event.html" title="event">event</a></li> |
|
2691 <li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li> |
|
2692 <li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li> |
|
2693 <li class=""><a href="module_history.html" title="history">history</a></li> |
|
2694 <li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li> |
|
2695 <li class=""><a href="module_io.html" title="io">io</a></li> |
|
2696 <li class=""><a href="module_json.html" title="json">json</a></li> |
|
2697 <li class=""><a href="module_node.html" title="node">node</a></li> |
|
2698 <li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li> |
|
2699 <li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li> |
|
2700 <li class=""><a href="module_oop.html" title="oop">oop</a></li> |
|
2701 <li class=""><a href="module_overlay.html" title="overlay">overlay</a></li> |
|
2702 <li class=""><a href="module_plugin.html" title="plugin">plugin</a></li> |
|
2703 <li class=""><a href="module_profiler.html" title="profiler">profiler</a></li> |
|
2704 <li class=""><a href="module_queue-promote.html" title="queue-promote">queue-promote</a></li> |
|
2705 <li class=""><a href="module_slider.html" title="slider">slider</a></li> |
|
2706 <li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li> |
|
2707 <li class=""><a href="module_substitute.html" title="substitute">substitute</a></li> |
|
2708 <li class=""><a href="module_test.html" title="test">test</a></li> |
|
2709 <li class=""><a href="module_widget.html" title="widget">widget</a></li> |
|
2710 <li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li> |
|
2711 <li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li> |
|
2712 <li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li> |
|
2713 <li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li> |
|
2714 <li class="selected"><a href="module_yui.html" title="yui">yui</a></li> |
|
2715 </ul> |
|
2716 </div> |
|
2717 |
|
2718 <div id="classList" class="module"> |
|
2719 <h4>Classes</h4> |
|
2720 <ul class="content"> |
|
2721 <li class=""><a href="Array.html" title="Array">Array</a></li> |
|
2722 <li class=""><a href="config.html" title="config">config</a></li> |
|
2723 <li class=""><a href="Get.html" title="Get">Get</a></li> |
|
2724 <li class=""><a href="Lang.html" title="Lang">Lang</a></li> |
|
2725 <li class=""><a href="Object.html" title="Object">Object</a></li> |
|
2726 <li class=""><a href="Queue.html" title="Queue">Queue</a></li> |
|
2727 <li class=""><a href="UA.html" title="UA">UA</a></li> |
|
2728 <li class="selected"><a href="YUI.html" title="YUI">YUI</a></li> |
|
2729 </ul> |
|
2730 </div> |
|
2731 |
|
2732 <div id="fileList" class="module"> |
|
2733 <h4>Files</h4> |
|
2734 <ul class="content"> |
|
2735 <li class=""><a href="_module.js.html" title="_module.js">_module.js</a></li> |
|
2736 <li class=""><a href="get.js.html" title="get.js">get.js</a></li> |
|
2737 <li class=""><a href="queue-base.js.html" title="queue-base.js">queue-base.js</a></li> |
|
2738 <li class=""><a href="yui-array.js.html" title="yui-array.js">yui-array.js</a></li> |
|
2739 <li class=""><a href="yui-base.js.html" title="yui-base.js">yui-base.js</a></li> |
|
2740 <li class=""><a href="yui-core.js.html" title="yui-core.js">yui-core.js</a></li> |
|
2741 <li class=""><a href="yui-init.js.html" title="yui-init.js">yui-init.js</a></li> |
|
2742 <li class=""><a href="yui-lang.js.html" title="yui-lang.js">yui-lang.js</a></li> |
|
2743 <li class=""><a href="yui-later.js.html" title="yui-later.js">yui-later.js</a></li> |
|
2744 <li class=""><a href="yui-log.js.html" title="yui-log.js">yui-log.js</a></li> |
|
2745 <li class=""><a href="yui-object.js.html" title="yui-object.js">yui-object.js</a></li> |
|
2746 <li class=""><a href="yui-ua.js.html" title="yui-ua.js">yui-ua.js</a></li> |
|
2747 <li class=""><a href="yui.js.html" title="yui.js">yui.js</a></li> |
|
2748 </ul> |
|
2749 </div> |
|
2750 |
|
2751 <div id="propertyList" class="module"> |
|
2752 <h4>Properties</h4> |
|
2753 <ul class="content"> |
|
2754 <li class=""><a href="#property_Global" title="Global">Global</a></li> |
|
2755 </ul> |
|
2756 </div> |
|
2757 |
|
2758 <div id="methodsList" class="module"> |
|
2759 <h4>Methods</h4> |
|
2760 <ul class="content"> |
|
2761 <li class="private"><a href="#method__init" title="_init">_init</a></li> |
|
2762 <li class="private"><a href="#method__setup" title="_setup">_setup</a></li> |
|
2763 <li class=""><a href="#method_add" title="add">add</a></li> |
|
2764 <li class=""><a href="#method_after" title="after">after</a></li> |
|
2765 <li class=""><a href="#method_applyTo" title="applyTo">applyTo</a></li> |
|
2766 <li class=""><a href="#method_cached" title="cached">cached</a></li> |
|
2767 <li class=""><a href="#method_delegate" title="delegate">delegate</a></li> |
|
2768 <li class=""><a href="#method_error" title="error">error</a></li> |
|
2769 <li class=""><a href="#method_guid" title="guid">guid</a></li> |
|
2770 <li class=""><a href="#method_later" title="later">later</a></li> |
|
2771 <li class=""><a href="#method_log" title="log">log</a></li> |
|
2772 <li class=""><a href="#method_merge" title="merge">merge</a></li> |
|
2773 <li class=""><a href="#method_message" title="message">message</a></li> |
|
2774 <li class=""><a href="#method_mix" title="mix">mix</a></li> |
|
2775 <li class=""><a href="#method_namespace" title="namespace">namespace</a></li> |
|
2776 <li class=""><a href="#method_Node.plug" title="Node.plug">Node.plug</a></li> |
|
2777 <li class=""><a href="#method_Node.unplug" title="Node.unplug">Node.unplug</a></li> |
|
2778 <li class=""><a href="#method_on" title="on">on</a></li> |
|
2779 <li class=""><a href="#method_simulate" title="simulate">simulate</a></li> |
|
2780 <li class=""><a href="#method_stamp" title="stamp">stamp</a></li> |
|
2781 <li class=""><a href="#method_use" title="use">use</a></li> |
|
2782 </ul> |
|
2783 </div> |
|
2784 |
|
2785 <div id="eventsList" class="module"> |
|
2786 <h4>Events</h4> |
|
2787 <ul class="content"> |
|
2788 <li class=""><a href="#event_available" title="available">available</a></li> |
|
2789 <li class=""><a href="#event_blur" title="blur">blur</a></li> |
|
2790 <li class=""><a href="#event_contentready" title="contentready">contentready</a></li> |
|
2791 <li class=" deprecated"><a href="#event_delegate" title="delegate">delegate</a></li> |
|
2792 <li class=""><a href="#event_focus" title="focus">focus</a></li> |
|
2793 <li class=""><a href="#event_key" title="key">key</a></li> |
|
2794 <li class=""><a href="#event_mouseenter" title="mouseenter">mouseenter</a></li> |
|
2795 <li class=""><a href="#event_mouseleave" title="mouseleave">mouseleave</a></li> |
|
2796 <li class=""><a href="#event_mousewheel" title="mousewheel">mousewheel</a></li> |
|
2797 <li class=""><a href="#event_windowresize" title="windowresize">windowresize</a></li> |
|
2798 </ul> |
|
2799 </div> |
|
2800 |
|
2801 |
|
2802 </div> |
|
2803 </div> |
|
2804 </div> |
|
2805 <div id="ft"> |
|
2806 <hr /> |
|
2807 Copyright © 2009 Yahoo! Inc. All rights reserved. |
|
2808 </div> |
|
2809 </div> |
|
2810 <script type="text/javascript"> |
|
2811 ALL_YUI_PROPS = [{"access": "", "host": "Object", "name": "()", "url": "Object.html#method_()", "type": "method"}, {"access": "", "host": "YUI", "name": "add", "url": "YUI.html#method_add", "type": "method"}, {"access": "", "host": "YUI", "name": "after", "url": "YUI.html#method_after", "type": "method"}, {"access": "", "host": "YUI", "name": "applyTo", "url": "YUI.html#method_applyTo", "type": "method"}, {"access": "", "host": "YUI", "name": "available", "url": "YUI.html#event_available", "type": "event"}, {"access": "", "host": "YUI", "name": "blur", "url": "YUI.html#event_blur", "type": "event"}, {"access": "", "host": "YUI", "name": "cached", "url": "YUI.html#method_cached", "type": "method"}, {"access": "", "host": "YUI", "name": "contentready", "url": "YUI.html#event_contentready", "type": "event"}, {"access": "", "host": "YUI", "name": "delegate", "url": "YUI.html#method_delegate", "type": "method"}, {"access": "", "host": "YUI", "name": "delegate", "url": "YUI.html#event_delegate", "type": "event"}, {"access": "", "host": "Object", "name": "each", "url": "Object.html#method_each", "type": "method"}, {"access": "", "host": "YUI", "name": "error", "url": "YUI.html#method_error", "type": "method"}, {"access": "private", "host": "Object", "name": "_extract", "url": "Object.html#method__extract", "type": "method"}, {"access": "", "host": "YUI", "name": "focus", "url": "YUI.html#event_focus", "type": "event"}, {"access": "", "host": "Object", "name": "getValue", "url": "Object.html#method_getValue", "type": "method"}, {"access": "", "host": "YUI", "name": "Global", "url": "YUI.html#property_Global", "type": "property"}, {"access": "", "host": "YUI", "name": "guid", "url": "YUI.html#method_guid", "type": "method"}, {"access": "", "host": "Object", "name": "hasKey", "url": "Object.html#method_hasKey", "type": "method"}, {"access": "", "host": "Object", "name": "hasValue", "url": "Object.html#method_hasValue", "type": "method"}, {"access": "private", "host": "YUI", "name": "_init", "url": "YUI.html#method__init", "type": "method"}, {"access": "", "host": "YUI", "name": "key", "url": "YUI.html#event_key", "type": "event"}, {"access": "", "host": "Object", "name": "keys", "url": "Object.html#method_keys", "type": "method"}, {"access": "", "host": "YUI", "name": "later", "url": "YUI.html#method_later", "type": "method"}, {"access": "", "host": "YUI", "name": "log", "url": "YUI.html#method_log", "type": "method"}, {"access": "", "host": "YUI", "name": "merge", "url": "YUI.html#method_merge", "type": "method"}, {"access": "", "host": "YUI", "name": "message", "url": "YUI.html#method_message", "type": "method"}, {"access": "", "host": "YUI", "name": "mix", "url": "YUI.html#method_mix", "type": "method"}, {"access": "", "host": "YUI", "name": "mouseenter", "url": "YUI.html#event_mouseenter", "type": "event"}, {"access": "", "host": "YUI", "name": "mouseleave", "url": "YUI.html#event_mouseleave", "type": "event"}, {"access": "", "host": "YUI", "name": "mousewheel", "url": "YUI.html#event_mousewheel", "type": "event"}, {"access": "", "host": "YUI", "name": "namespace", "url": "YUI.html#method_namespace", "type": "method"}, {"access": "", "host": "YUI", "name": "Node.plug", "url": "YUI.html#method_Node.plug", "type": "method"}, {"access": "", "host": "YUI", "name": "Node.unplug", "url": "YUI.html#method_Node.unplug", "type": "method"}, {"access": "", "host": "YUI", "name": "on", "url": "YUI.html#method_on", "type": "method"}, {"access": "", "host": "Object", "name": "owns", "url": "Object.html#method_owns", "type": "method"}, {"access": "private", "host": "YUI", "name": "_setup", "url": "YUI.html#method__setup", "type": "method"}, {"access": "", "host": "Object", "name": "setValue", "url": "Object.html#method_setValue", "type": "method"}, {"access": "", "host": "YUI", "name": "simulate", "url": "YUI.html#method_simulate", "type": "method"}, {"access": "", "host": "Object", "name": "size", "url": "Object.html#method_size", "type": "method"}, {"access": "", "host": "YUI", "name": "stamp", "url": "YUI.html#method_stamp", "type": "method"}, {"access": "", "host": "YUI", "name": "use", "url": "YUI.html#method_use", "type": "method"}, {"access": "", "host": "Object", "name": "values", "url": "Object.html#method_values", "type": "method"}, {"access": "", "host": "YUI", "name": "windowresize", "url": "YUI.html#event_windowresize", "type": "event"}]; |
|
2812 </script> |
|
2813 </body> |
|
2814 </html> |