| changeset 0 | 40c8f766c9b8 |
| -1:000000000000 | 0:40c8f766c9b8 |
|---|---|
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: queue (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>queue <span class="subtitle">3.0.0b1</span></h3> |
|
20 <a href="./index.html" title="Yahoo! UI Library">Yahoo! UI Library</a> |
|
21 > <a href="./module_queue.html" title="queue">queue</a> |
|
22 |
|
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 |
|
47 <h3>Module: queue |
|
48 |
|
49 |
|
50 |
|
51 </h3> |
|
52 <div class="description summary"> |
|
53 <p>The Queue module adds a common data structure for FIFO operations. In its |
|
54 simplest form, it is little more than an array wrapper. Additional |
|
55 submodules introduce more functionality such as promotion and removal of |
|
56 queued items.</p> |
|
57 <p>An AsyncQueue class is provided in the queue-run submodule. This class |
|
58 affords a mechanism to do complex sequential and iterative callback |
|
59 execution across configured timeouts. |
|
60 </div> |
|
61 |
|
62 |
|
63 |
|
64 <div class="yui-gc"> |
|
65 <div class="yui-u first"> |
|
66 |
|
67 <p>This module contains the following classes:</p> |
|
68 <script> |
|
69 //var YUI_CLASS_LIST = [{"extends": {"superclass": {"EventTarget": "EventTarget"}, "events": {}, "configs": {}, "properties": {}, "methods": {"EventTarget": [{"access": "private", "deprecated": false, "name": "_getType"}, {"access": "private", "deprecated": false, "name": "_parseType"}, {"access": "", "deprecated": false, "name": "addTarget"}, {"access": "", "deprecated": false, "name": "after"}, {"access": "", "deprecated": true, "name": "before"}, {"access": "", "deprecated": false, "name": "bubble"}, {"access": "", "deprecated": false, "name": "detach"}, {"access": "", "deprecated": false, "name": "detachAll"}, {"access": "", "deprecated": false, "name": "fire"}, {"access": "", "deprecated": false, "name": "getEvent"}, {"access": "", "deprecated": false, "name": "on"}, {"access": "", "deprecated": false, "name": "publish"}, {"access": "", "deprecated": false, "name": "removeTarget"}, {"access": "", "deprecated": true, "name": "subscribe"}, {"access": "", "deprecated": true, "name": "unsubscribe"}, {"access": "", "deprecated": true, "name": "unsubscribeAll"}]}}, "description": "<p>A specialized queue class that supports scheduling callbacks to execute\nsequentially, iteratively, even asynchronously.<\/p>\n<p>Callbacks can be function refs or objects with the following keys. Only\nthe <code>fn<\/code> key is required.<\/p>\n<ul>\n<li><code>fn<\/code> -- The callback function<\/li>\n<li><code>context<\/code> -- The execution context for the callbackFn.<\/li>\n<li><code>args<\/code> -- Arguments to pass to callbackFn.<\/li>\n<li><code>timeout<\/code> -- Millisecond delay before executing callbackFn.\n(Applies to each iterative execution of callback)<\/li>\n<li><code>iterations<\/code> -- Number of times to repeat the callback.\n<li><code>until<\/code> -- Repeat the callback until this function returns\ntrue. This setting trumps iterations.<\/li>\n<li><code>autoContinue<\/code> -- Set to false to prevent the AsyncQueue from\nexecuting the next callback in the Queue after\nthe callback completes.<\/li>\n<li><code>id<\/code> -- Name that can be used to get, promote, get the\nindexOf, or delete this callback.<\/li>\n<\/ul>", "guessedname": "AsyncQueue", "name": "AsyncQueue"}, {"extends": {"superclass": {}, "events": {}, "configs": {}, "properties": {}, "methods": {}}, "description": "A simple FIFO queue. Items are added to the Queue with add(1..n items) and\nremoved using next().", "guessedname": "Queue", "name": "Queue"}]; |
|
70 </script> |
|
71 <div id="splash_classList"> |
|
72 <ul> |
|
73 <li><a href="AsyncQueue.html" title="AsyncQueue" id="class_0">AsyncQueue</a></li> |
|
74 <li><a href="Queue.html" title="Queue" id="class_1">Queue</a></li> |
|
75 </ul> |
|
76 </div> |
|
77 </div> |
|
78 <div class="yui-u"> |
|
79 <div class="submodules"> |
|
80 <h4>Submodules:</h4> |
|
81 <dl> |
|
82 <dt><code>queue-run</code></dt> |
|
83 <dd><p>Adds a new class AsyncQueue that is restricted to function callbacks, but |
|
84 includes a host of additional features, including events, callback |
|
85 iterations, and a run() method that can execute queued callbacks in order, |
|
86 even across configured timeouts.</p></dd> |
|
87 <dt><code>queue-promote</code></dt> |
|
88 <dd>Adds methods promote, remove, and indexOf to Queue instances.</dd> |
|
89 <dt><code>queue-base</code></dt> |
|
90 <dd>A simple FIFO queue. Items are added to the Queue with add(1..n items) and |
|
91 removed using next().</dd> |
|
92 </dl> |
|
93 </div> |
|
94 |
|
95 </div> |
|
96 </div> |
|
97 |
|
98 </div> |
|
99 </div> |
|
100 <div class="yui-b"> |
|
101 <div class="nav"> |
|
102 |
|
103 <div id="moduleList" class="module"> |
|
104 <h4>Modules</h4> |
|
105 <ul class="content"> |
|
106 <li class=""><a href="module_anim.html" title="anim">anim</a></li> |
|
107 <li class=""><a href="module_attribute.html" title="attribute">attribute</a></li> |
|
108 <li class=""><a href="module_base.html" title="base">base</a></li> |
|
109 <li class=""><a href="module_cache.html" title="cache">cache</a></li> |
|
110 <li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li> |
|
111 <li class=""><a href="module_collection.html" title="collection">collection</a></li> |
|
112 <li class=""><a href="module_console.html" title="console">console</a></li> |
|
113 <li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li> |
|
114 <li class=""><a href="module_cookie.html" title="cookie">cookie</a></li> |
|
115 <li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li> |
|
116 <li class=""><a href="module_datasource.html" title="datasource">datasource</a></li> |
|
117 <li class=""><a href="module_datatype.html" title="datatype">datatype</a></li> |
|
118 <li class=""><a href="module_dd.html" title="dd">dd</a></li> |
|
119 <li class=""><a href="module_dom.html" title="dom">dom</a></li> |
|
120 <li class=""><a href="module_dump.html" title="dump">dump</a></li> |
|
121 <li class=""><a href="module_event.html" title="event">event</a></li> |
|
122 <li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li> |
|
123 <li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li> |
|
124 <li class=""><a href="module_history.html" title="history">history</a></li> |
|
125 <li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li> |
|
126 <li class=""><a href="module_io.html" title="io">io</a></li> |
|
127 <li class=""><a href="module_json.html" title="json">json</a></li> |
|
128 <li class=""><a href="module_node.html" title="node">node</a></li> |
|
129 <li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li> |
|
130 <li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li> |
|
131 <li class=""><a href="module_oop.html" title="oop">oop</a></li> |
|
132 <li class=""><a href="module_overlay.html" title="overlay">overlay</a></li> |
|
133 <li class=""><a href="module_plugin.html" title="plugin">plugin</a></li> |
|
134 <li class=""><a href="module_profiler.html" title="profiler">profiler</a></li> |
|
135 <li class="selected"><a href="module_queue.html" title="queue">queue</a></li> |
|
136 <li class=""><a href="module_slider.html" title="slider">slider</a></li> |
|
137 <li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li> |
|
138 <li class=""><a href="module_substitute.html" title="substitute">substitute</a></li> |
|
139 <li class=""><a href="module_test.html" title="test">test</a></li> |
|
140 <li class=""><a href="module_widget.html" title="widget">widget</a></li> |
|
141 <li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li> |
|
142 <li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li> |
|
143 <li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li> |
|
144 <li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li> |
|
145 <li class=""><a href="module_yui.html" title="yui">yui</a></li> |
|
146 </ul> |
|
147 </div> |
|
148 |
|
149 <div id="classList" class="module"> |
|
150 <h4>Classes</h4> |
|
151 <ul class="content"> |
|
152 <li class=""><a href="AsyncQueue.html" title="AsyncQueue">AsyncQueue</a></li> |
|
153 <li class=""><a href="Queue.html" title="Queue">Queue</a></li> |
|
154 </ul> |
|
155 </div> |
|
156 |
|
157 <div id="fileList" class="module"> |
|
158 <h4>Files</h4> |
|
159 <ul class="content"> |
|
160 <li class=""><a href="queue-base.js.html" title="queue-base.js">queue-base.js</a></li> |
|
161 <li class=""><a href="queue-promote.js.html" title="queue-promote.js">queue-promote.js</a></li> |
|
162 <li class=""><a href="queue-run.js.html" title="queue-run.js">queue-run.js</a></li> |
|
163 </ul> |
|
164 </div> |
|
165 |
|
166 |
|
167 |
|
168 |
|
169 |
|
170 </div> |
|
171 </div> |
|
172 </div> |
|
173 <div id="ft"> |
|
174 <hr /> |
|
175 Copyright © 2009 Yahoo! Inc. All rights reserved. |
|
176 </div> |
|
177 </div> |
|
178 <script type="text/javascript"> |
|
179 ALL_YUI_PROPS = [{"access": "", "host": "AsyncQueue", "name": "add", "url": "AsyncQueue.html#method_add", "type": "method"}, {"access": "", "host": "Queue", "name": "add", "url": "Queue.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": "", "host": "Queue", "name": "indexOf", "url": "Queue.html#method_indexOf", "type": "method"}, {"access": "protected", "host": "AsyncQueue", "name": "_init", "url": "AsyncQueue.html#method__init", "type": "method"}, {"access": "protected", "host": "Queue", "name": "_init", "url": "Queue.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": "Queue", "name": "next", "url": "Queue.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": "Queue", "name": "promote", "url": "Queue.html#method_promote", "type": "method"}, {"access": "protected", "host": "Queue", "name": "_q", "url": "Queue.html#property__q", "type": "property"}, {"access": "", "host": "AsyncQueue", "name": "remove", "url": "AsyncQueue.html#method_remove", "type": "method"}, {"access": "", "host": "Queue", "name": "remove", "url": "Queue.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": "Queue", "name": "size", "url": "Queue.html#method_size", "type": "method"}, {"access": "", "host": "AsyncQueue", "name": "stop", "url": "AsyncQueue.html#method_stop", "type": "method"}]; |
|
180 </script> |
|
181 </body> |
|
182 </html> |