|
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: async-queue AsyncQueue (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>async-queue <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_async-queue.html" title="async-queue">async-queue</a> |
|
22 > AsyncQueue |
|
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">AsyncQueue</b> |
|
52 <span class="extends"> |
|
53 - extends <a href="EventTarget.html" title="EventTarget">EventTarget</a> |
|
54 </span> |
|
55 |
|
56 </h2> |
|
57 <!-- class tree goes here --> |
|
58 |
|
59 |
|
60 |
|
61 |
|
62 <div class="summary description" property="yui:description"> |
|
63 <p>A specialized queue class that supports scheduling callbacks to execute |
|
64 sequentially, iteratively, even asynchronously.</p> |
|
65 <p>Callbacks can be function refs or objects with the following keys. Only |
|
66 the <code>fn</code> key is required.</p> |
|
67 <ul> |
|
68 <li><code>fn</code> -- The callback function</li> |
|
69 <li><code>context</code> -- The execution context for the callbackFn.</li> |
|
70 <li><code>args</code> -- Arguments to pass to callbackFn.</li> |
|
71 <li><code>timeout</code> -- Millisecond delay before executing callbackFn. |
|
72 (Applies to each iterative execution of callback)</li> |
|
73 <li><code>iterations</code> -- Number of times to repeat the callback. |
|
74 <li><code>until</code> -- Repeat the callback until this function returns |
|
75 true. This setting trumps iterations.</li> |
|
76 <li><code>autoContinue</code> -- Set to false to prevent the AsyncQueue from |
|
77 executing the next callback in the Queue after |
|
78 the callback completes.</li> |
|
79 <li><code>id</code> -- Name that can be used to get, promote, get the |
|
80 indexOf, or delete this callback.</li> |
|
81 </ul> |
|
82 </div> |
|
83 |
|
84 <div class="section constructor details" rel="yui:constructor" resource="#constructor"> |
|
85 <h3 id="constructor">Constructor</h3> |
|
86 <div class="content"> |
|
87 <div class="detail"> |
|
88 <strong property="yui:name">AsyncQueue</strong> |
|
89 <code> |
|
90 ( |
|
91 |
|
92 |
|
93 |
|
94 callback* |
|
95 ) |
|
96 </code> |
|
97 <div class="description"> |
|
98 <dl rel="yui:parameters"> |
|
99 <dt>Parameters:</dt> |
|
100 <dd rel="yui:parameter"> |
|
101 <code><span property="yui:name">callback*</span> |
|
102 <<span property="yui:type">Function|Object</span>> |
|
103 </code> |
|
104 <span property="yui:description"> 0..n callbacks to seed the queue</span> |
|
105 </dd> |
|
106 </dl> |
|
107 |
|
108 |
|
109 </div> |
|
110 </div> |
|
111 </div> |
|
112 </div> |
|
113 |
|
114 <div rel="yui:properties" resource="#properties"> |
|
115 <div class="section field details"> |
|
116 <h3 id="properties">Properties</h3> |
|
117 <div class="content"> |
|
118 <div class="protected" rel="yui:property" resource="#property__running"> |
|
119 <h4><a name="property__running" property="yui:name">_running</a> |
|
120 - <code>protected <span property="yui:type">{Boolean|Object} true for synchronous callback execution, the |
|
121 return handle from Y.later for async callbacks. |
|
122 Otherwise false.</span></code> |
|
123 </h4> |
|
124 <div class="detail"> |
|
125 <div class="description" property="yui:description"> |
|
126 Used to indicate the queue is currently executing a callback. |
|
127 </div> |
|
128 </div> |
|
129 |
|
130 |
|
131 |
|
132 |
|
133 <hr /> |
|
134 </div> |
|
135 <div class="" rel="yui:property" resource="#property_AsyncQueue.defaults"> |
|
136 <h4><a name="property_AsyncQueue.defaults" property="yui:name">AsyncQueue.defaults</a> |
|
137 - <code>static <span property="yui:type">{Object}</span></code> |
|
138 </h4> |
|
139 <div class="detail"> |
|
140 <div class="description" property="yui:description"> |
|
141 <p>Static default values used to populate callback configuration properties. |
|
142 Preconfigured defaults include:</p> |
|
143 <ul> |
|
144 <li><code>autoContinue</code>: <code>true</code></li> |
|
145 <li><code>iterations</code>: 1</li> |
|
146 <li><code>timeout</code>: 10 (10ms between callbacks)</li> |
|
147 <li><code>until</code>: (function to run until iterations <= 0)</li> |
|
148 </ul> |
|
149 </div> |
|
150 </div> |
|
151 |
|
152 |
|
153 |
|
154 |
|
155 <hr /> |
|
156 </div> |
|
157 <div class="" rel="yui:property" resource="#property_defaults"> |
|
158 <h4><a name="property_defaults" property="yui:name">defaults</a> |
|
159 - <code><span property="yui:type">{Object}</span></code> |
|
160 </h4> |
|
161 <div class="detail"> |
|
162 <div class="description" property="yui:description"> |
|
163 Callback defaults for this instance. Static defaults that are not |
|
164 overridden are also included. |
|
165 </div> |
|
166 </div> |
|
167 |
|
168 |
|
169 |
|
170 |
|
171 <hr /> |
|
172 </div> |
|
173 </div> |
|
174 </div> |
|
175 |
|
176 </div> |
|
177 |
|
178 <div rel="yui:methods" resource="#methods"> |
|
179 <div class="section method details"> |
|
180 <h3 id="methods">Methods</h3> |
|
181 <div class="content"> |
|
182 <div class="protected" rel="yui:method" resource="#method__defAddFn"> |
|
183 <h4> |
|
184 <a name="method__defAddFn">_defAddFn</a></h4> |
|
185 <div class="detail" > |
|
186 <code> |
|
187 protected |
|
188 |
|
189 |
|
190 void |
|
191 <strong property="yui:name">_defAddFn</strong> |
|
192 ( |
|
193 |
|
194 |
|
195 e |
|
196 |
|
197 |
|
198 ) |
|
199 </code> |
|
200 |
|
201 <div class="description" property="yui:description"> |
|
202 Default functionality for the "add" event. Adds the callbacks |
|
203 in the event facade to the queue. Callbacks successfully added to the |
|
204 queue are present in the event's <code>added</code> property in the |
|
205 after phase. |
|
206 </div> |
|
207 |
|
208 <div class="description"> |
|
209 |
|
210 <dl rel="yui:parameters"> |
|
211 <dt>Parameters:</dt> |
|
212 <dd rel="yui:parameter"> |
|
213 <code><span property="yui:name">e</span> |
|
214 <<span property="yui:type">Event</span>> |
|
215 </code> |
|
216 <span property="yui:description"> the event object</span> |
|
217 </dd> |
|
218 </dl> |
|
219 |
|
220 |
|
221 |
|
222 |
|
223 |
|
224 </div> |
|
225 |
|
226 </div> |
|
227 <hr /> |
|
228 </div> |
|
229 <div class="protected" rel="yui:method" resource="#method__defExecFn"> |
|
230 <h4> |
|
231 <a name="method__defExecFn">_defExecFn</a></h4> |
|
232 <div class="detail" > |
|
233 <code> |
|
234 protected |
|
235 |
|
236 |
|
237 void |
|
238 <strong property="yui:name">_defExecFn</strong> |
|
239 ( |
|
240 |
|
241 |
|
242 e |
|
243 |
|
244 |
|
245 ) |
|
246 </code> |
|
247 |
|
248 <div class="description" property="yui:description"> |
|
249 Default functionality for the "execute" event. Executes the |
|
250 callback function |
|
251 </div> |
|
252 |
|
253 <div class="description"> |
|
254 |
|
255 <dl rel="yui:parameters"> |
|
256 <dt>Parameters:</dt> |
|
257 <dd rel="yui:parameter"> |
|
258 <code><span property="yui:name">e</span> |
|
259 <<span property="yui:type">Event</span>> |
|
260 </code> |
|
261 <span property="yui:description"> the event object</span> |
|
262 </dd> |
|
263 </dl> |
|
264 |
|
265 |
|
266 |
|
267 |
|
268 |
|
269 </div> |
|
270 |
|
271 </div> |
|
272 <hr /> |
|
273 </div> |
|
274 <div class="protected" rel="yui:method" resource="#method__defPromoteFn"> |
|
275 <h4> |
|
276 <a name="method__defPromoteFn">_defPromoteFn</a></h4> |
|
277 <div class="detail" > |
|
278 <code> |
|
279 protected |
|
280 |
|
281 |
|
282 void |
|
283 <strong property="yui:name">_defPromoteFn</strong> |
|
284 ( |
|
285 |
|
286 |
|
287 e |
|
288 |
|
289 |
|
290 ) |
|
291 </code> |
|
292 |
|
293 <div class="description" property="yui:description"> |
|
294 <p>Default functionality for the "promote" event. Promotes the |
|
295 named callback to the head of the queue.</p> |
|
296 <p>The event object will contain a property "callback", which |
|
297 holds the id of a callback or the callback object itself.</p> |
|
298 </div> |
|
299 |
|
300 <div class="description"> |
|
301 |
|
302 <dl rel="yui:parameters"> |
|
303 <dt>Parameters:</dt> |
|
304 <dd rel="yui:parameter"> |
|
305 <code><span property="yui:name">e</span> |
|
306 <<span property="yui:type">Event</span>> |
|
307 </code> |
|
308 <span property="yui:description"> the custom event</span> |
|
309 </dd> |
|
310 </dl> |
|
311 |
|
312 |
|
313 |
|
314 |
|
315 |
|
316 </div> |
|
317 |
|
318 </div> |
|
319 <hr /> |
|
320 </div> |
|
321 <div class="protected" rel="yui:method" resource="#method__defRemoveFn"> |
|
322 <h4> |
|
323 <a name="method__defRemoveFn">_defRemoveFn</a></h4> |
|
324 <div class="detail" > |
|
325 <code> |
|
326 protected |
|
327 |
|
328 |
|
329 void |
|
330 <strong property="yui:name">_defRemoveFn</strong> |
|
331 ( |
|
332 |
|
333 |
|
334 e |
|
335 |
|
336 |
|
337 ) |
|
338 </code> |
|
339 |
|
340 <div class="description" property="yui:description"> |
|
341 <p>Default functionality for the "remove" event. Removes the |
|
342 callback from the queue.</p> |
|
343 <p>The event object will contain a property "callback", which |
|
344 holds the id of a callback or the callback object itself.</p> |
|
345 </div> |
|
346 |
|
347 <div class="description"> |
|
348 |
|
349 <dl rel="yui:parameters"> |
|
350 <dt>Parameters:</dt> |
|
351 <dd rel="yui:parameter"> |
|
352 <code><span property="yui:name">e</span> |
|
353 <<span property="yui:type">Event</span>> |
|
354 </code> |
|
355 <span property="yui:description"> the custom event</span> |
|
356 </dd> |
|
357 </dl> |
|
358 |
|
359 |
|
360 |
|
361 |
|
362 |
|
363 </div> |
|
364 |
|
365 </div> |
|
366 <hr /> |
|
367 </div> |
|
368 <div class="protected" rel="yui:method" resource="#method__defShiftFn"> |
|
369 <h4> |
|
370 <a name="method__defShiftFn">_defShiftFn</a></h4> |
|
371 <div class="detail" > |
|
372 <code> |
|
373 protected |
|
374 |
|
375 |
|
376 void |
|
377 <strong property="yui:name">_defShiftFn</strong> |
|
378 ( |
|
379 |
|
380 |
|
381 e |
|
382 |
|
383 |
|
384 ) |
|
385 </code> |
|
386 |
|
387 <div class="description" property="yui:description"> |
|
388 Default functionality for the "shift" event. Shifts the |
|
389 callback stored in the event object's <em>callback</em> property from |
|
390 the queue if it is the first item. |
|
391 </div> |
|
392 |
|
393 <div class="description"> |
|
394 |
|
395 <dl rel="yui:parameters"> |
|
396 <dt>Parameters:</dt> |
|
397 <dd rel="yui:parameter"> |
|
398 <code><span property="yui:name">e</span> |
|
399 <<span property="yui:type">Event</span>> |
|
400 </code> |
|
401 <span property="yui:description"> The event object</span> |
|
402 </dd> |
|
403 </dl> |
|
404 |
|
405 |
|
406 |
|
407 |
|
408 |
|
409 </div> |
|
410 |
|
411 </div> |
|
412 <hr /> |
|
413 </div> |
|
414 <div class="protected" rel="yui:method" resource="#method__execute"> |
|
415 <h4> |
|
416 <a name="method__execute">_execute</a></h4> |
|
417 <div class="detail" > |
|
418 <code> |
|
419 protected |
|
420 |
|
421 |
|
422 Boolean |
|
423 <strong property="yui:name">_execute</strong> |
|
424 ( |
|
425 |
|
426 |
|
427 callback |
|
428 |
|
429 |
|
430 ) |
|
431 </code> |
|
432 |
|
433 <div class="description" property="yui:description"> |
|
434 Handles the execution of callbacks. Returns a boolean indicating |
|
435 whether it is appropriate to continue running. |
|
436 </div> |
|
437 |
|
438 <div class="description"> |
|
439 |
|
440 <dl rel="yui:parameters"> |
|
441 <dt>Parameters:</dt> |
|
442 <dd rel="yui:parameter"> |
|
443 <code><span property="yui:name">callback</span> |
|
444 <<span property="yui:type">Object</span>> |
|
445 </code> |
|
446 <span property="yui:description"> the callback object to execute</span> |
|
447 </dd> |
|
448 </dl> |
|
449 |
|
450 <dl> |
|
451 <dt>Returns: |
|
452 <code property="yui:return"> |
|
453 Boolean |
|
454 </code></dt> |
|
455 <dd property="yui:returnInfo">whether the run loop should continue</dd> |
|
456 </dl> |
|
457 |
|
458 |
|
459 |
|
460 |
|
461 </div> |
|
462 |
|
463 </div> |
|
464 <hr /> |
|
465 </div> |
|
466 <div class="protected" rel="yui:method" resource="#method__init"> |
|
467 <h4> |
|
468 <a name="method__init">_init</a></h4> |
|
469 <div class="detail" > |
|
470 <code> |
|
471 protected |
|
472 |
|
473 |
|
474 void |
|
475 <strong property="yui:name">_init</strong> |
|
476 ( |
|
477 ) |
|
478 </code> |
|
479 |
|
480 <div class="description" property="yui:description"> |
|
481 Initializes the AsyncQueue instance properties and events. |
|
482 </div> |
|
483 |
|
484 <div class="description"> |
|
485 |
|
486 |
|
487 |
|
488 |
|
489 |
|
490 |
|
491 </div> |
|
492 |
|
493 </div> |
|
494 <hr /> |
|
495 </div> |
|
496 <div class="protected" rel="yui:method" resource="#method__initEvents"> |
|
497 <h4> |
|
498 <a name="method__initEvents">_initEvents</a></h4> |
|
499 <div class="detail" > |
|
500 <code> |
|
501 protected |
|
502 |
|
503 |
|
504 void |
|
505 <strong property="yui:name">_initEvents</strong> |
|
506 ( |
|
507 ) |
|
508 </code> |
|
509 |
|
510 <div class="description" property="yui:description"> |
|
511 Initializes the instance events. |
|
512 </div> |
|
513 |
|
514 <div class="description"> |
|
515 |
|
516 |
|
517 |
|
518 |
|
519 |
|
520 |
|
521 </div> |
|
522 |
|
523 </div> |
|
524 <hr /> |
|
525 </div> |
|
526 <div class="protected" rel="yui:method" resource="#method__prepare"> |
|
527 <h4> |
|
528 <a name="method__prepare">_prepare</a></h4> |
|
529 <div class="detail" > |
|
530 <code> |
|
531 protected |
|
532 |
|
533 |
|
534 Function |
|
535 <strong property="yui:name">_prepare</strong> |
|
536 ( |
|
537 |
|
538 |
|
539 callback |
|
540 |
|
541 |
|
542 ) |
|
543 </code> |
|
544 |
|
545 <div class="description" property="yui:description"> |
|
546 Creates a wrapper function to execute the callback using the aggregated |
|
547 configuration generated by combining the static AsyncQueue.defaults, the |
|
548 instance defaults, and the specified callback settings. |
|
549 The wrapper function is decorated with the callback configuration as |
|
550 properties for runtime modification. |
|
551 </div> |
|
552 |
|
553 <div class="description"> |
|
554 |
|
555 <dl rel="yui:parameters"> |
|
556 <dt>Parameters:</dt> |
|
557 <dd rel="yui:parameter"> |
|
558 <code><span property="yui:name">callback</span> |
|
559 <<span property="yui:type">Object|Function</span>> |
|
560 </code> |
|
561 <span property="yui:description"> the raw callback</span> |
|
562 </dd> |
|
563 </dl> |
|
564 |
|
565 <dl> |
|
566 <dt>Returns: |
|
567 <code property="yui:return"> |
|
568 Function |
|
569 </code></dt> |
|
570 <dd property="yui:returnInfo">a decorated function wrapper to execute the callback</dd> |
|
571 </dl> |
|
572 |
|
573 |
|
574 |
|
575 |
|
576 </div> |
|
577 |
|
578 </div> |
|
579 <hr /> |
|
580 </div> |
|
581 <div class="protected" rel="yui:method" resource="#method__schedule"> |
|
582 <h4> |
|
583 <a name="method__schedule">_schedule</a></h4> |
|
584 <div class="detail" > |
|
585 <code> |
|
586 protected |
|
587 |
|
588 |
|
589 Boolean |
|
590 <strong property="yui:name">_schedule</strong> |
|
591 ( |
|
592 |
|
593 |
|
594 callback |
|
595 |
|
596 |
|
597 ) |
|
598 </code> |
|
599 |
|
600 <div class="description" property="yui:description"> |
|
601 Schedules the execution of asynchronous callbacks. |
|
602 </div> |
|
603 |
|
604 <div class="description"> |
|
605 |
|
606 <dl rel="yui:parameters"> |
|
607 <dt>Parameters:</dt> |
|
608 <dd rel="yui:parameter"> |
|
609 <code><span property="yui:name">callback</span> |
|
610 <<span property="yui:type">Object</span>> |
|
611 </code> |
|
612 <span property="yui:description"> the callback object to execute</span> |
|
613 </dd> |
|
614 </dl> |
|
615 |
|
616 <dl> |
|
617 <dt>Returns: |
|
618 <code property="yui:return"> |
|
619 Boolean |
|
620 </code></dt> |
|
621 <dd property="yui:returnInfo">whether the run loop should continue</dd> |
|
622 </dl> |
|
623 |
|
624 |
|
625 |
|
626 |
|
627 </div> |
|
628 |
|
629 </div> |
|
630 <hr /> |
|
631 </div> |
|
632 <div class="" rel="yui:method" resource="#method_add"> |
|
633 <h4> |
|
634 <a name="method_add">add</a></h4> |
|
635 <div class="detail" > |
|
636 <code> |
|
637 |
|
638 |
|
639 |
|
640 AsyncQueue |
|
641 <strong property="yui:name">add</strong> |
|
642 ( |
|
643 |
|
644 |
|
645 callback* |
|
646 |
|
647 |
|
648 ) |
|
649 </code> |
|
650 |
|
651 <div class="description" property="yui:description"> |
|
652 Add any number of callbacks to the end of the queue. Callbacks may be |
|
653 provided as functions or objects. |
|
654 </div> |
|
655 |
|
656 <div class="description"> |
|
657 |
|
658 <dl rel="yui:parameters"> |
|
659 <dt>Parameters:</dt> |
|
660 <dd rel="yui:parameter"> |
|
661 <code><span property="yui:name">callback*</span> |
|
662 <<span property="yui:type">Function|Object</span>> |
|
663 </code> |
|
664 <span property="yui:description"> 0..n callbacks</span> |
|
665 </dd> |
|
666 </dl> |
|
667 |
|
668 <dl> |
|
669 <dt>Returns: |
|
670 <code property="yui:return"> |
|
671 AsyncQueue |
|
672 </code></dt> |
|
673 <dd property="yui:returnInfo">the AsyncQueue instance</dd> |
|
674 </dl> |
|
675 |
|
676 <div class="chainable"> |
|
677 <strong>Chainable:</strong> This method is chainable. |
|
678 </div> |
|
679 |
|
680 |
|
681 |
|
682 </div> |
|
683 |
|
684 </div> |
|
685 <hr /> |
|
686 </div> |
|
687 <div class="" rel="yui:method" resource="#method_getCallback"> |
|
688 <h4> |
|
689 <a name="method_getCallback">getCallback</a></h4> |
|
690 <div class="detail" > |
|
691 <code> |
|
692 |
|
693 |
|
694 |
|
695 Object |
|
696 <strong property="yui:name">getCallback</strong> |
|
697 ( |
|
698 |
|
699 |
|
700 id |
|
701 |
|
702 |
|
703 ) |
|
704 </code> |
|
705 |
|
706 <div class="description" property="yui:description"> |
|
707 Retrieve a callback by its id. Useful to modify the configuration |
|
708 while the queue is running. |
|
709 </div> |
|
710 |
|
711 <div class="description"> |
|
712 |
|
713 <dl rel="yui:parameters"> |
|
714 <dt>Parameters:</dt> |
|
715 <dd rel="yui:parameter"> |
|
716 <code><span property="yui:name">id</span> |
|
717 <<span property="yui:type">String</span>> |
|
718 </code> |
|
719 <span property="yui:description"> the id assigned to the callback</span> |
|
720 </dd> |
|
721 </dl> |
|
722 |
|
723 <dl> |
|
724 <dt>Returns: |
|
725 <code property="yui:return"> |
|
726 Object |
|
727 </code></dt> |
|
728 <dd property="yui:returnInfo">the callback object</dd> |
|
729 </dl> |
|
730 |
|
731 |
|
732 |
|
733 |
|
734 </div> |
|
735 |
|
736 </div> |
|
737 <hr /> |
|
738 </div> |
|
739 <div class="" rel="yui:method" resource="#method_indexOf"> |
|
740 <h4> |
|
741 <a name="method_indexOf">indexOf</a></h4> |
|
742 <div class="detail" > |
|
743 <code> |
|
744 |
|
745 |
|
746 |
|
747 Number |
|
748 <strong property="yui:name">indexOf</strong> |
|
749 ( |
|
750 |
|
751 |
|
752 callback |
|
753 |
|
754 |
|
755 ) |
|
756 </code> |
|
757 |
|
758 <div class="description" property="yui:description"> |
|
759 Returns the current index of a callback. Pass in either the id or |
|
760 callback function from getCallback. |
|
761 </div> |
|
762 |
|
763 <div class="description"> |
|
764 |
|
765 <dl rel="yui:parameters"> |
|
766 <dt>Parameters:</dt> |
|
767 <dd rel="yui:parameter"> |
|
768 <code><span property="yui:name">callback</span> |
|
769 <<span property="yui:type">String|Function</span>> |
|
770 </code> |
|
771 <span property="yui:description"> the callback or its specified id</span> |
|
772 </dd> |
|
773 </dl> |
|
774 |
|
775 <dl> |
|
776 <dt>Returns: |
|
777 <code property="yui:return"> |
|
778 Number |
|
779 </code></dt> |
|
780 <dd property="yui:returnInfo">index of the callback or -1 if not found</dd> |
|
781 </dl> |
|
782 |
|
783 |
|
784 |
|
785 |
|
786 </div> |
|
787 |
|
788 </div> |
|
789 <hr /> |
|
790 </div> |
|
791 <div class="" rel="yui:method" resource="#method_isRunning"> |
|
792 <h4> |
|
793 <a name="method_isRunning">isRunning</a></h4> |
|
794 <div class="detail" > |
|
795 <code> |
|
796 |
|
797 |
|
798 |
|
799 Boolean |
|
800 <strong property="yui:name">isRunning</strong> |
|
801 ( |
|
802 ) |
|
803 </code> |
|
804 |
|
805 <div class="description" property="yui:description"> |
|
806 Determines if the queue is waiting for a callback to complete execution. |
|
807 </div> |
|
808 |
|
809 <div class="description"> |
|
810 |
|
811 |
|
812 <dl> |
|
813 <dt>Returns: |
|
814 <code property="yui:return"> |
|
815 Boolean |
|
816 </code></dt> |
|
817 <dd property="yui:returnInfo">true if queue is waiting for a |
|
818 from any initiated transactions</dd> |
|
819 </dl> |
|
820 |
|
821 |
|
822 |
|
823 |
|
824 </div> |
|
825 |
|
826 </div> |
|
827 <hr /> |
|
828 </div> |
|
829 <div class="" rel="yui:method" resource="#method_next"> |
|
830 <h4> |
|
831 <a name="method_next">next</a></h4> |
|
832 <div class="detail" > |
|
833 <code> |
|
834 |
|
835 |
|
836 |
|
837 Function |
|
838 <strong property="yui:name">next</strong> |
|
839 ( |
|
840 ) |
|
841 </code> |
|
842 |
|
843 <div class="description" property="yui:description"> |
|
844 Returns the next callback needing execution. If a callback is |
|
845 configured to repeat via iterations or until, it will be returned until |
|
846 the completion criteria is met. |
|
847 When the queue is empty, null is returned. |
|
848 </div> |
|
849 |
|
850 <div class="description"> |
|
851 |
|
852 |
|
853 <dl> |
|
854 <dt>Returns: |
|
855 <code property="yui:return"> |
|
856 Function |
|
857 </code></dt> |
|
858 <dd property="yui:returnInfo">the callback to execute</dd> |
|
859 </dl> |
|
860 |
|
861 |
|
862 |
|
863 |
|
864 </div> |
|
865 |
|
866 </div> |
|
867 <hr /> |
|
868 </div> |
|
869 <div class="" rel="yui:method" resource="#method_pause"> |
|
870 <h4> |
|
871 <a name="method_pause">pause</a></h4> |
|
872 <div class="detail" > |
|
873 <code> |
|
874 |
|
875 |
|
876 |
|
877 AsyncQueue |
|
878 <strong property="yui:name">pause</strong> |
|
879 ( |
|
880 ) |
|
881 </code> |
|
882 |
|
883 <div class="description" property="yui:description"> |
|
884 Pause the execution of the queue after the execution of the current |
|
885 callback completes. If called from code outside of a queued callback, |
|
886 clears the timeout for the pending callback. Paused queue can be |
|
887 restarted with q.run() |
|
888 </div> |
|
889 |
|
890 <div class="description"> |
|
891 |
|
892 |
|
893 <dl> |
|
894 <dt>Returns: |
|
895 <code property="yui:return"> |
|
896 AsyncQueue |
|
897 </code></dt> |
|
898 <dd property="yui:returnInfo">the AsyncQueue instance</dd> |
|
899 </dl> |
|
900 |
|
901 <div class="chainable"> |
|
902 <strong>Chainable:</strong> This method is chainable. |
|
903 </div> |
|
904 |
|
905 |
|
906 |
|
907 </div> |
|
908 |
|
909 </div> |
|
910 <hr /> |
|
911 </div> |
|
912 <div class="" rel="yui:method" resource="#method_promote"> |
|
913 <h4> |
|
914 <a name="method_promote">promote</a></h4> |
|
915 <div class="detail" > |
|
916 <code> |
|
917 |
|
918 |
|
919 |
|
920 AsyncQueue |
|
921 <strong property="yui:name">promote</strong> |
|
922 ( |
|
923 |
|
924 |
|
925 callback |
|
926 |
|
927 |
|
928 ) |
|
929 </code> |
|
930 |
|
931 <div class="description" property="yui:description"> |
|
932 Promotes the named callback to the top of the queue. If a callback is |
|
933 currently executing or looping (via until or iterations), the promotion |
|
934 is scheduled to occur after the current callback has completed. |
|
935 </div> |
|
936 |
|
937 <div class="description"> |
|
938 |
|
939 <dl rel="yui:parameters"> |
|
940 <dt>Parameters:</dt> |
|
941 <dd rel="yui:parameter"> |
|
942 <code><span property="yui:name">callback</span> |
|
943 <<span property="yui:type">String|Object</span>> |
|
944 </code> |
|
945 <span property="yui:description"> the callback object or a callback's id</span> |
|
946 </dd> |
|
947 </dl> |
|
948 |
|
949 <dl> |
|
950 <dt>Returns: |
|
951 <code property="yui:return"> |
|
952 AsyncQueue |
|
953 </code></dt> |
|
954 <dd property="yui:returnInfo">the AsyncQueue instance</dd> |
|
955 </dl> |
|
956 |
|
957 <div class="chainable"> |
|
958 <strong>Chainable:</strong> This method is chainable. |
|
959 </div> |
|
960 |
|
961 |
|
962 |
|
963 </div> |
|
964 |
|
965 </div> |
|
966 <hr /> |
|
967 </div> |
|
968 <div class="" rel="yui:method" resource="#method_remove"> |
|
969 <h4> |
|
970 <a name="method_remove">remove</a></h4> |
|
971 <div class="detail" > |
|
972 <code> |
|
973 |
|
974 |
|
975 |
|
976 AsyncQueue |
|
977 <strong property="yui:name">remove</strong> |
|
978 ( |
|
979 |
|
980 |
|
981 callback |
|
982 |
|
983 |
|
984 ) |
|
985 </code> |
|
986 |
|
987 <div class="description" property="yui:description"> |
|
988 Removes the callback from the queue. If the queue is active, the |
|
989 removal is scheduled to occur after the current callback has completed. |
|
990 </div> |
|
991 |
|
992 <div class="description"> |
|
993 |
|
994 <dl rel="yui:parameters"> |
|
995 <dt>Parameters:</dt> |
|
996 <dd rel="yui:parameter"> |
|
997 <code><span property="yui:name">callback</span> |
|
998 <<span property="yui:type">String|Object</span>> |
|
999 </code> |
|
1000 <span property="yui:description"> the callback object or a callback's id</span> |
|
1001 </dd> |
|
1002 </dl> |
|
1003 |
|
1004 <dl> |
|
1005 <dt>Returns: |
|
1006 <code property="yui:return"> |
|
1007 AsyncQueue |
|
1008 </code></dt> |
|
1009 <dd property="yui:returnInfo">the AsyncQueue instance</dd> |
|
1010 </dl> |
|
1011 |
|
1012 <div class="chainable"> |
|
1013 <strong>Chainable:</strong> This method is chainable. |
|
1014 </div> |
|
1015 |
|
1016 |
|
1017 |
|
1018 </div> |
|
1019 |
|
1020 </div> |
|
1021 <hr /> |
|
1022 </div> |
|
1023 <div class="" rel="yui:method" resource="#method_run"> |
|
1024 <h4> |
|
1025 <a name="method_run">run</a></h4> |
|
1026 <div class="detail" > |
|
1027 <code> |
|
1028 |
|
1029 |
|
1030 |
|
1031 AsyncQueue |
|
1032 <strong property="yui:name">run</strong> |
|
1033 ( |
|
1034 ) |
|
1035 </code> |
|
1036 |
|
1037 <div class="description" property="yui:description"> |
|
1038 Sets the queue in motion. All queued callbacks will be executed in |
|
1039 order unless pause() or stop() is called or if one of the callbacks is |
|
1040 configured with autoContinue: false. |
|
1041 </div> |
|
1042 |
|
1043 <div class="description"> |
|
1044 |
|
1045 |
|
1046 <dl> |
|
1047 <dt>Returns: |
|
1048 <code property="yui:return"> |
|
1049 AsyncQueue |
|
1050 </code></dt> |
|
1051 <dd property="yui:returnInfo">the AsyncQueue instance</dd> |
|
1052 </dl> |
|
1053 |
|
1054 <div class="chainable"> |
|
1055 <strong>Chainable:</strong> This method is chainable. |
|
1056 </div> |
|
1057 |
|
1058 |
|
1059 |
|
1060 </div> |
|
1061 |
|
1062 </div> |
|
1063 <hr /> |
|
1064 </div> |
|
1065 <div class="" rel="yui:method" resource="#method_size"> |
|
1066 <h4> |
|
1067 <a name="method_size">size</a></h4> |
|
1068 <div class="detail" > |
|
1069 <code> |
|
1070 |
|
1071 |
|
1072 |
|
1073 Number |
|
1074 <strong property="yui:name">size</strong> |
|
1075 ( |
|
1076 ) |
|
1077 </code> |
|
1078 |
|
1079 <div class="description" property="yui:description"> |
|
1080 Returns the number of callbacks in the queue. |
|
1081 </div> |
|
1082 |
|
1083 <div class="description"> |
|
1084 |
|
1085 |
|
1086 |
|
1087 |
|
1088 |
|
1089 |
|
1090 </div> |
|
1091 |
|
1092 </div> |
|
1093 <hr /> |
|
1094 </div> |
|
1095 <div class="" rel="yui:method" resource="#method_stop"> |
|
1096 <h4> |
|
1097 <a name="method_stop">stop</a></h4> |
|
1098 <div class="detail" > |
|
1099 <code> |
|
1100 |
|
1101 |
|
1102 |
|
1103 AsyncQueue |
|
1104 <strong property="yui:name">stop</strong> |
|
1105 ( |
|
1106 ) |
|
1107 </code> |
|
1108 |
|
1109 <div class="description" property="yui:description"> |
|
1110 Stop and clear the queue after the current execution of the |
|
1111 current callback completes. |
|
1112 </div> |
|
1113 |
|
1114 <div class="description"> |
|
1115 |
|
1116 |
|
1117 <dl> |
|
1118 <dt>Returns: |
|
1119 <code property="yui:return"> |
|
1120 AsyncQueue |
|
1121 </code></dt> |
|
1122 <dd property="yui:returnInfo">the AsyncQueue instance</dd> |
|
1123 </dl> |
|
1124 |
|
1125 <div class="chainable"> |
|
1126 <strong>Chainable:</strong> This method is chainable. |
|
1127 </div> |
|
1128 |
|
1129 |
|
1130 |
|
1131 </div> |
|
1132 |
|
1133 </div> |
|
1134 <hr /> |
|
1135 </div> |
|
1136 </div> |
|
1137 </div> |
|
1138 |
|
1139 <div rel="yui:inheritance"> |
|
1140 <div class="section field inheritance" rel="yui:superclass" resource="EventTarget.html"> |
|
1141 <h4>Methods inherited from <a href="EventTarget.html" property="yui:name" title="EventTarget">EventTarget</a>:</h4> |
|
1142 <div class="content" rel="yui:methods"> |
|
1143 <code> |
|
1144 <span rel="yui:method" resource="EventTarget.html#method__getType"> |
|
1145 <a class="private" href="EventTarget.html#method__getType" property="yui:name" title="_getType">_getType</a><span class="private">,</span> |
|
1146 </span> |
|
1147 <span rel="yui:method" resource="EventTarget.html#method__parseType"> |
|
1148 <a class="private" href="EventTarget.html#method__parseType" property="yui:name" title="_parseType">_parseType</a><span class="private">,</span> |
|
1149 </span> |
|
1150 <span rel="yui:method" resource="EventTarget.html#method_addTarget"> |
|
1151 <a class="" href="EventTarget.html#method_addTarget" property="yui:name" title="addTarget">addTarget</a><span class="">,</span> |
|
1152 </span> |
|
1153 <span rel="yui:method" resource="EventTarget.html#method_after"> |
|
1154 <a class="" href="EventTarget.html#method_after" property="yui:name" title="after">after</a><span class="">,</span> |
|
1155 </span> |
|
1156 <span rel="yui:method" resource="EventTarget.html#method_before"> |
|
1157 <a class=" deprecated" href="EventTarget.html#method_before" property="yui:name" title="before">before</a><span class=" deprecated">,</span> |
|
1158 </span> |
|
1159 <span rel="yui:method" resource="EventTarget.html#method_bubble"> |
|
1160 <a class="" href="EventTarget.html#method_bubble" property="yui:name" title="bubble">bubble</a><span class="">,</span> |
|
1161 </span> |
|
1162 <span rel="yui:method" resource="EventTarget.html#method_detach"> |
|
1163 <a class="" href="EventTarget.html#method_detach" property="yui:name" title="detach">detach</a><span class="">,</span> |
|
1164 </span> |
|
1165 <span rel="yui:method" resource="EventTarget.html#method_detachAll"> |
|
1166 <a class="" href="EventTarget.html#method_detachAll" property="yui:name" title="detachAll">detachAll</a><span class="">,</span> |
|
1167 </span> |
|
1168 <span rel="yui:method" resource="EventTarget.html#method_fire"> |
|
1169 <a class="" href="EventTarget.html#method_fire" property="yui:name" title="fire">fire</a><span class="">,</span> |
|
1170 </span> |
|
1171 <span rel="yui:method" resource="EventTarget.html#method_getEvent"> |
|
1172 <a class="" href="EventTarget.html#method_getEvent" property="yui:name" title="getEvent">getEvent</a><span class="">,</span> |
|
1173 </span> |
|
1174 <span rel="yui:method" resource="EventTarget.html#method_on"> |
|
1175 <a class="" href="EventTarget.html#method_on" property="yui:name" title="on">on</a><span class="">,</span> |
|
1176 </span> |
|
1177 <span rel="yui:method" resource="EventTarget.html#method_publish"> |
|
1178 <a class="" href="EventTarget.html#method_publish" property="yui:name" title="publish">publish</a><span class="">,</span> |
|
1179 </span> |
|
1180 <span rel="yui:method" resource="EventTarget.html#method_removeTarget"> |
|
1181 <a class="" href="EventTarget.html#method_removeTarget" property="yui:name" title="removeTarget">removeTarget</a><span class="">,</span> |
|
1182 </span> |
|
1183 <span rel="yui:method" resource="EventTarget.html#method_subscribe"> |
|
1184 <a class=" deprecated" href="EventTarget.html#method_subscribe" property="yui:name" title="subscribe">subscribe</a><span class=" deprecated">,</span> |
|
1185 </span> |
|
1186 <span rel="yui:method" resource="EventTarget.html#method_unsubscribe"> |
|
1187 <a class=" deprecated" href="EventTarget.html#method_unsubscribe" property="yui:name" title="unsubscribe">unsubscribe</a><span class=" deprecated">,</span> |
|
1188 </span> |
|
1189 <span rel="yui:method" resource="EventTarget.html#method_unsubscribeAll"> |
|
1190 <a class=" deprecated" href="EventTarget.html#method_unsubscribeAll" property="yui:name" title="unsubscribeAll">unsubscribeAll</a> |
|
1191 </span> |
|
1192 </code> |
|
1193 </div> |
|
1194 </div> |
|
1195 </div> |
|
1196 </div> |
|
1197 |
|
1198 <div rel="yui:events" resource="#events"> |
|
1199 <div class="section method details"> |
|
1200 <h3 id="events">Events</h3> |
|
1201 <div class="content"> |
|
1202 <div class="" rel="yui:event" resource="#event_complete"> |
|
1203 <h4> |
|
1204 <a name="event_complete">complete</a></h4> |
|
1205 <div class="detail"> |
|
1206 <code> |
|
1207 |
|
1208 |
|
1209 |
|
1210 <strong property="yui:name">complete</strong> |
|
1211 |
|
1212 ( |
|
1213 ) |
|
1214 |
|
1215 </code> |
|
1216 |
|
1217 <div class="description" property="yui:description"> |
|
1218 Event fired after the last queued callback is executed. |
|
1219 </div> |
|
1220 |
|
1221 <div class="description"> |
|
1222 |
|
1223 |
|
1224 |
|
1225 |
|
1226 </div> |
|
1227 |
|
1228 </div> |
|
1229 <hr /> |
|
1230 </div> |
|
1231 </div> |
|
1232 </div> |
|
1233 |
|
1234 |
|
1235 </div> |
|
1236 |
|
1237 <div rel="yui:attributes" resource="#configattributes"> |
|
1238 |
|
1239 </div> |
|
1240 |
|
1241 </div> |
|
1242 </div> |
|
1243 <div class="yui-b"> |
|
1244 <div class="nav"> |
|
1245 |
|
1246 <div id="moduleList" class="module"> |
|
1247 <h4>Modules</h4> |
|
1248 <ul class="content"> |
|
1249 <li class=""><a href="module_anim.html" title="anim">anim</a></li> |
|
1250 <li class="selected"><a href="module_async-queue.html" title="async-queue">async-queue</a></li> |
|
1251 <li class=""><a href="module_attribute.html" title="attribute">attribute</a></li> |
|
1252 <li class=""><a href="module_base.html" title="base">base</a></li> |
|
1253 <li class=""><a href="module_cache.html" title="cache">cache</a></li> |
|
1254 <li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li> |
|
1255 <li class=""><a href="module_collection.html" title="collection">collection</a></li> |
|
1256 <li class=""><a href="module_console.html" title="console">console</a></li> |
|
1257 <li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li> |
|
1258 <li class=""><a href="module_cookie.html" title="cookie">cookie</a></li> |
|
1259 <li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li> |
|
1260 <li class=""><a href="module_datasource.html" title="datasource">datasource</a></li> |
|
1261 <li class=""><a href="module_datatype.html" title="datatype">datatype</a></li> |
|
1262 <li class=""><a href="module_dd.html" title="dd">dd</a></li> |
|
1263 <li class=""><a href="module_dom.html" title="dom">dom</a></li> |
|
1264 <li class=""><a href="module_dump.html" title="dump">dump</a></li> |
|
1265 <li class=""><a href="module_event.html" title="event">event</a></li> |
|
1266 <li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li> |
|
1267 <li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li> |
|
1268 <li class=""><a href="module_history.html" title="history">history</a></li> |
|
1269 <li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li> |
|
1270 <li class=""><a href="module_io.html" title="io">io</a></li> |
|
1271 <li class=""><a href="module_json.html" title="json">json</a></li> |
|
1272 <li class=""><a href="module_node.html" title="node">node</a></li> |
|
1273 <li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li> |
|
1274 <li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li> |
|
1275 <li class=""><a href="module_oop.html" title="oop">oop</a></li> |
|
1276 <li class=""><a href="module_overlay.html" title="overlay">overlay</a></li> |
|
1277 <li class=""><a href="module_plugin.html" title="plugin">plugin</a></li> |
|
1278 <li class=""><a href="module_profiler.html" title="profiler">profiler</a></li> |
|
1279 <li class=""><a href="module_queue-promote.html" title="queue-promote">queue-promote</a></li> |
|
1280 <li class=""><a href="module_slider.html" title="slider">slider</a></li> |
|
1281 <li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li> |
|
1282 <li class=""><a href="module_substitute.html" title="substitute">substitute</a></li> |
|
1283 <li class=""><a href="module_test.html" title="test">test</a></li> |
|
1284 <li class=""><a href="module_widget.html" title="widget">widget</a></li> |
|
1285 <li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li> |
|
1286 <li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li> |
|
1287 <li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li> |
|
1288 <li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li> |
|
1289 <li class=""><a href="module_yui.html" title="yui">yui</a></li> |
|
1290 </ul> |
|
1291 </div> |
|
1292 |
|
1293 <div id="classList" class="module"> |
|
1294 <h4>Classes</h4> |
|
1295 <ul class="content"> |
|
1296 <li class="selected"><a href="AsyncQueue.html" title="AsyncQueue">AsyncQueue</a></li> |
|
1297 </ul> |
|
1298 </div> |
|
1299 |
|
1300 <div id="fileList" class="module"> |
|
1301 <h4>Files</h4> |
|
1302 <ul class="content"> |
|
1303 <li class=""><a href="async-queue.js.html" title="async-queue.js">async-queue.js</a></li> |
|
1304 </ul> |
|
1305 </div> |
|
1306 |
|
1307 <div id="propertyList" class="module"> |
|
1308 <h4>Properties</h4> |
|
1309 <ul class="content"> |
|
1310 <li class="protected"><a href="#property__running" title="_running">_running</a></li> |
|
1311 <li class=""><a href="#property_AsyncQueue.defaults" title="AsyncQueue.defaults">AsyncQueue.defaults</a></li> |
|
1312 <li class=""><a href="#property_defaults" title="defaults">defaults</a></li> |
|
1313 </ul> |
|
1314 </div> |
|
1315 |
|
1316 <div id="methodsList" class="module"> |
|
1317 <h4>Methods</h4> |
|
1318 <ul class="content"> |
|
1319 <li class="protected"><a href="#method__defAddFn" title="_defAddFn">_defAddFn</a></li> |
|
1320 <li class="protected"><a href="#method__defExecFn" title="_defExecFn">_defExecFn</a></li> |
|
1321 <li class="protected"><a href="#method__defPromoteFn" title="_defPromoteFn">_defPromoteFn</a></li> |
|
1322 <li class="protected"><a href="#method__defRemoveFn" title="_defRemoveFn">_defRemoveFn</a></li> |
|
1323 <li class="protected"><a href="#method__defShiftFn" title="_defShiftFn">_defShiftFn</a></li> |
|
1324 <li class="protected"><a href="#method__execute" title="_execute">_execute</a></li> |
|
1325 <li class="protected"><a href="#method__init" title="_init">_init</a></li> |
|
1326 <li class="protected"><a href="#method__initEvents" title="_initEvents">_initEvents</a></li> |
|
1327 <li class="protected"><a href="#method__prepare" title="_prepare">_prepare</a></li> |
|
1328 <li class="protected"><a href="#method__schedule" title="_schedule">_schedule</a></li> |
|
1329 <li class=""><a href="#method_add" title="add">add</a></li> |
|
1330 <li class=""><a href="#method_getCallback" title="getCallback">getCallback</a></li> |
|
1331 <li class=""><a href="#method_indexOf" title="indexOf">indexOf</a></li> |
|
1332 <li class=""><a href="#method_isRunning" title="isRunning">isRunning</a></li> |
|
1333 <li class=""><a href="#method_next" title="next">next</a></li> |
|
1334 <li class=""><a href="#method_pause" title="pause">pause</a></li> |
|
1335 <li class=""><a href="#method_promote" title="promote">promote</a></li> |
|
1336 <li class=""><a href="#method_remove" title="remove">remove</a></li> |
|
1337 <li class=""><a href="#method_run" title="run">run</a></li> |
|
1338 <li class=""><a href="#method_size" title="size">size</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_complete" title="complete">complete</a></li> |
|
1347 </ul> |
|
1348 </div> |
|
1349 |
|
1350 |
|
1351 </div> |
|
1352 </div> |
|
1353 </div> |
|
1354 <div id="ft"> |
|
1355 <hr /> |
|
1356 Copyright © 2009 Yahoo! Inc. All rights reserved. |
|
1357 </div> |
|
1358 </div> |
|
1359 <script type="text/javascript"> |
|
1360 ALL_YUI_PROPS = [{"access": "", "host": "AsyncQueue", "name": "add", "url": "AsyncQueue.html#method_add", "type": "method"}, {"access": "", "host": "AsyncQueue", "name": "AsyncQueue.defaults", "url": "AsyncQueue.html#property_AsyncQueue.defaults", "type": "property"}, {"access": "", "host": "AsyncQueue", "name": "complete", "url": "AsyncQueue.html#event_complete", "type": "event"}, {"access": "protected", "host": "AsyncQueue", "name": "_defAddFn", "url": "AsyncQueue.html#method__defAddFn", "type": "method"}, {"access": "", "host": "AsyncQueue", "name": "defaults", "url": "AsyncQueue.html#property_defaults", "type": "property"}, {"access": "protected", "host": "AsyncQueue", "name": "_defExecFn", "url": "AsyncQueue.html#method__defExecFn", "type": "method"}, {"access": "protected", "host": "AsyncQueue", "name": "_defPromoteFn", "url": "AsyncQueue.html#method__defPromoteFn", "type": "method"}, {"access": "protected", "host": "AsyncQueue", "name": "_defRemoveFn", "url": "AsyncQueue.html#method__defRemoveFn", "type": "method"}, {"access": "protected", "host": "AsyncQueue", "name": "_defShiftFn", "url": "AsyncQueue.html#method__defShiftFn", "type": "method"}, {"access": "protected", "host": "AsyncQueue", "name": "_execute", "url": "AsyncQueue.html#method__execute", "type": "method"}, {"access": "", "host": "AsyncQueue", "name": "getCallback", "url": "AsyncQueue.html#method_getCallback", "type": "method"}, {"access": "", "host": "AsyncQueue", "name": "indexOf", "url": "AsyncQueue.html#method_indexOf", "type": "method"}, {"access": "protected", "host": "AsyncQueue", "name": "_init", "url": "AsyncQueue.html#method__init", "type": "method"}, {"access": "protected", "host": "AsyncQueue", "name": "_initEvents", "url": "AsyncQueue.html#method__initEvents", "type": "method"}, {"access": "", "host": "AsyncQueue", "name": "isRunning", "url": "AsyncQueue.html#method_isRunning", "type": "method"}, {"access": "", "host": "AsyncQueue", "name": "next", "url": "AsyncQueue.html#method_next", "type": "method"}, {"access": "", "host": "AsyncQueue", "name": "pause", "url": "AsyncQueue.html#method_pause", "type": "method"}, {"access": "protected", "host": "AsyncQueue", "name": "_prepare", "url": "AsyncQueue.html#method__prepare", "type": "method"}, {"access": "", "host": "AsyncQueue", "name": "promote", "url": "AsyncQueue.html#method_promote", "type": "method"}, {"access": "", "host": "AsyncQueue", "name": "remove", "url": "AsyncQueue.html#method_remove", "type": "method"}, {"access": "", "host": "AsyncQueue", "name": "run", "url": "AsyncQueue.html#method_run", "type": "method"}, {"access": "protected", "host": "AsyncQueue", "name": "_running", "url": "AsyncQueue.html#property__running", "type": "property"}, {"access": "protected", "host": "AsyncQueue", "name": "_schedule", "url": "AsyncQueue.html#method__schedule", "type": "method"}, {"access": "", "host": "AsyncQueue", "name": "size", "url": "AsyncQueue.html#method_size", "type": "method"}, {"access": "", "host": "AsyncQueue", "name": "stop", "url": "AsyncQueue.html#method_stop", "type": "method"}]; |
|
1361 </script> |
|
1362 </body> |
|
1363 </html> |