--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/src/cm/media/js/lib/yui/yui3.0.0/api/AsyncQueue.html Mon Nov 23 15:14:29 2009 +0100
@@ -0,0 +1,1363 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<html xmlns:yui="http://yuilibrary.com/rdf/1.0/yui.rdf#">
+<head>
+ <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
+ <title>API: async-queue AsyncQueue (YUI Library)</title>
+
+ <link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css" />
+ <link rel="stylesheet" type="text/css" href="assets/api.css" />
+
+ <script type="text/javascript" src="assets/api-js"></script>
+ <script type="text/javascript" src="assets/ac-js"></script>
+</head>
+
+<body id="yahoo-com">
+
+<div id="doc3" class="yui-t2">
+ <div id="hd">
+ <h1><a href="http://developer.yahoo.com/yui/" title="Yahoo! UI Library">Yahoo! UI Library</a></h1>
+ <h3>async-queue <span class="subtitle">3.0.0</span></h3>
+ <a href="./index.html" title="Yahoo! UI Library">Yahoo! UI Library</a>
+ > <a href="./module_async-queue.html" title="async-queue">async-queue</a>
+ > AsyncQueue
+
+ <form onsubmit="return false">
+ <div id="propertysearch">
+ Search: <input autocomplete="off" id="searchinput" />
+ <div id="searchresults">
+
+ </div>
+ </div>
+ </form>
+ </div>
+
+ <div id="bd">
+ <div id="yui-main">
+ <div class="yui-b">
+ <form action="#" name="yui-classopts-form" method="get" id="yui-classopts-form">
+ <fieldset>
+ <legend>Filters</legend>
+ <span class="classopts"><input type="checkbox" name="show_private" id="show_private" /> <label for="show_private">Show Private</label></span>
+ <span class="classopts"><input type="checkbox" name="show_protected" id="show_protected" /> <label for="show_protected">Show Protected</label></span>
+ <span class="classopts"><input type="checkbox" name="show_deprecated" id="show_deprecated" /> <label for="show_deprecated">Show Deprecated</label></span>
+ </fieldset>
+ </form>
+
+ <h2>
+
+
+
+
+ Class <b property="yui:name">AsyncQueue</b>
+ <span class="extends">
+ - extends <a href="EventTarget.html" title="EventTarget">EventTarget</a>
+ </span>
+
+ </h2>
+ <!-- class tree goes here -->
+
+
+
+
+ <div class="summary description" property="yui:description">
+ <p>A specialized queue class that supports scheduling callbacks to execute
+sequentially, iteratively, even asynchronously.</p>
+<p>Callbacks can be function refs or objects with the following keys. Only
+the <code>fn</code> key is required.</p>
+<ul>
+<li><code>fn</code> -- The callback function</li>
+<li><code>context</code> -- The execution context for the callbackFn.</li>
+<li><code>args</code> -- Arguments to pass to callbackFn.</li>
+<li><code>timeout</code> -- Millisecond delay before executing callbackFn.
+(Applies to each iterative execution of callback)</li>
+<li><code>iterations</code> -- Number of times to repeat the callback.
+<li><code>until</code> -- Repeat the callback until this function returns
+true. This setting trumps iterations.</li>
+<li><code>autoContinue</code> -- Set to false to prevent the AsyncQueue from
+executing the next callback in the Queue after
+the callback completes.</li>
+<li><code>id</code> -- Name that can be used to get, promote, get the
+indexOf, or delete this callback.</li>
+</ul>
+ </div>
+
+ <div class="section constructor details" rel="yui:constructor" resource="#constructor">
+ <h3 id="constructor">Constructor</h3>
+ <div class="content">
+ <div class="detail">
+ <strong property="yui:name">AsyncQueue</strong>
+ <code>
+ (
+
+
+
+ callback*
+ )
+ </code>
+ <div class="description">
+ <dl rel="yui:parameters">
+ <dt>Parameters:</dt>
+ <dd rel="yui:parameter">
+ <code><span property="yui:name">callback*</span>
+ <<span property="yui:type">Function|Object</span>>
+ </code>
+ <span property="yui:description"> 0..n callbacks to seed the queue</span>
+ </dd>
+ </dl>
+
+
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <div rel="yui:properties" resource="#properties">
+ <div class="section field details">
+ <h3 id="properties">Properties</h3>
+ <div class="content">
+ <div class="protected" rel="yui:property" resource="#property__running">
+ <h4><a name="property__running" property="yui:name">_running</a>
+ - <code>protected <span property="yui:type">{Boolean|Object} true for synchronous callback execution, the
+return handle from Y.later for async callbacks.
+Otherwise false.</span></code>
+ </h4>
+ <div class="detail">
+ <div class="description" property="yui:description">
+ Used to indicate the queue is currently executing a callback.
+ </div>
+ </div>
+
+
+
+
+ <hr />
+ </div>
+ <div class="" rel="yui:property" resource="#property_AsyncQueue.defaults">
+ <h4><a name="property_AsyncQueue.defaults" property="yui:name">AsyncQueue.defaults</a>
+ - <code>static <span property="yui:type">{Object}</span></code>
+ </h4>
+ <div class="detail">
+ <div class="description" property="yui:description">
+ <p>Static default values used to populate callback configuration properties.
+Preconfigured defaults include:</p>
+<ul>
+<li><code>autoContinue</code>: <code>true</code></li>
+<li><code>iterations</code>: 1</li>
+<li><code>timeout</code>: 10 (10ms between callbacks)</li>
+<li><code>until</code>: (function to run until iterations <= 0)</li>
+</ul>
+ </div>
+ </div>
+
+
+
+
+ <hr />
+ </div>
+ <div class="" rel="yui:property" resource="#property_defaults">
+ <h4><a name="property_defaults" property="yui:name">defaults</a>
+ - <code><span property="yui:type">{Object}</span></code>
+ </h4>
+ <div class="detail">
+ <div class="description" property="yui:description">
+ Callback defaults for this instance. Static defaults that are not
+overridden are also included.
+ </div>
+ </div>
+
+
+
+
+ <hr />
+ </div>
+ </div>
+ </div>
+
+ </div>
+
+ <div rel="yui:methods" resource="#methods">
+ <div class="section method details">
+ <h3 id="methods">Methods</h3>
+ <div class="content">
+ <div class="protected" rel="yui:method" resource="#method__defAddFn">
+ <h4>
+ <a name="method__defAddFn">_defAddFn</a></h4>
+ <div class="detail" >
+ <code>
+ protected
+
+
+ void
+ <strong property="yui:name">_defAddFn</strong>
+ (
+
+
+ e
+
+
+ )
+ </code>
+
+ <div class="description" property="yui:description">
+ Default functionality for the "add" event. Adds the callbacks
+in the event facade to the queue. Callbacks successfully added to the
+queue are present in the event's <code>added</code> property in the
+after phase.
+ </div>
+
+ <div class="description">
+
+ <dl rel="yui:parameters">
+ <dt>Parameters:</dt>
+ <dd rel="yui:parameter">
+ <code><span property="yui:name">e</span>
+ <<span property="yui:type">Event</span>>
+ </code>
+ <span property="yui:description"> the event object</span>
+ </dd>
+ </dl>
+
+
+
+
+
+ </div>
+
+ </div>
+ <hr />
+ </div>
+ <div class="protected" rel="yui:method" resource="#method__defExecFn">
+ <h4>
+ <a name="method__defExecFn">_defExecFn</a></h4>
+ <div class="detail" >
+ <code>
+ protected
+
+
+ void
+ <strong property="yui:name">_defExecFn</strong>
+ (
+
+
+ e
+
+
+ )
+ </code>
+
+ <div class="description" property="yui:description">
+ Default functionality for the "execute" event. Executes the
+callback function
+ </div>
+
+ <div class="description">
+
+ <dl rel="yui:parameters">
+ <dt>Parameters:</dt>
+ <dd rel="yui:parameter">
+ <code><span property="yui:name">e</span>
+ <<span property="yui:type">Event</span>>
+ </code>
+ <span property="yui:description"> the event object</span>
+ </dd>
+ </dl>
+
+
+
+
+
+ </div>
+
+ </div>
+ <hr />
+ </div>
+ <div class="protected" rel="yui:method" resource="#method__defPromoteFn">
+ <h4>
+ <a name="method__defPromoteFn">_defPromoteFn</a></h4>
+ <div class="detail" >
+ <code>
+ protected
+
+
+ void
+ <strong property="yui:name">_defPromoteFn</strong>
+ (
+
+
+ e
+
+
+ )
+ </code>
+
+ <div class="description" property="yui:description">
+ <p>Default functionality for the "promote" event. Promotes the
+named callback to the head of the queue.</p>
+<p>The event object will contain a property "callback", which
+holds the id of a callback or the callback object itself.</p>
+ </div>
+
+ <div class="description">
+
+ <dl rel="yui:parameters">
+ <dt>Parameters:</dt>
+ <dd rel="yui:parameter">
+ <code><span property="yui:name">e</span>
+ <<span property="yui:type">Event</span>>
+ </code>
+ <span property="yui:description"> the custom event</span>
+ </dd>
+ </dl>
+
+
+
+
+
+ </div>
+
+ </div>
+ <hr />
+ </div>
+ <div class="protected" rel="yui:method" resource="#method__defRemoveFn">
+ <h4>
+ <a name="method__defRemoveFn">_defRemoveFn</a></h4>
+ <div class="detail" >
+ <code>
+ protected
+
+
+ void
+ <strong property="yui:name">_defRemoveFn</strong>
+ (
+
+
+ e
+
+
+ )
+ </code>
+
+ <div class="description" property="yui:description">
+ <p>Default functionality for the "remove" event. Removes the
+callback from the queue.</p>
+<p>The event object will contain a property "callback", which
+holds the id of a callback or the callback object itself.</p>
+ </div>
+
+ <div class="description">
+
+ <dl rel="yui:parameters">
+ <dt>Parameters:</dt>
+ <dd rel="yui:parameter">
+ <code><span property="yui:name">e</span>
+ <<span property="yui:type">Event</span>>
+ </code>
+ <span property="yui:description"> the custom event</span>
+ </dd>
+ </dl>
+
+
+
+
+
+ </div>
+
+ </div>
+ <hr />
+ </div>
+ <div class="protected" rel="yui:method" resource="#method__defShiftFn">
+ <h4>
+ <a name="method__defShiftFn">_defShiftFn</a></h4>
+ <div class="detail" >
+ <code>
+ protected
+
+
+ void
+ <strong property="yui:name">_defShiftFn</strong>
+ (
+
+
+ e
+
+
+ )
+ </code>
+
+ <div class="description" property="yui:description">
+ Default functionality for the "shift" event. Shifts the
+callback stored in the event object's <em>callback</em> property from
+the queue if it is the first item.
+ </div>
+
+ <div class="description">
+
+ <dl rel="yui:parameters">
+ <dt>Parameters:</dt>
+ <dd rel="yui:parameter">
+ <code><span property="yui:name">e</span>
+ <<span property="yui:type">Event</span>>
+ </code>
+ <span property="yui:description"> The event object</span>
+ </dd>
+ </dl>
+
+
+
+
+
+ </div>
+
+ </div>
+ <hr />
+ </div>
+ <div class="protected" rel="yui:method" resource="#method__execute">
+ <h4>
+ <a name="method__execute">_execute</a></h4>
+ <div class="detail" >
+ <code>
+ protected
+
+
+ Boolean
+ <strong property="yui:name">_execute</strong>
+ (
+
+
+ callback
+
+
+ )
+ </code>
+
+ <div class="description" property="yui:description">
+ Handles the execution of callbacks. Returns a boolean indicating
+whether it is appropriate to continue running.
+ </div>
+
+ <div class="description">
+
+ <dl rel="yui:parameters">
+ <dt>Parameters:</dt>
+ <dd rel="yui:parameter">
+ <code><span property="yui:name">callback</span>
+ <<span property="yui:type">Object</span>>
+ </code>
+ <span property="yui:description"> the callback object to execute</span>
+ </dd>
+ </dl>
+
+ <dl>
+ <dt>Returns:
+ <code property="yui:return">
+ Boolean
+ </code></dt>
+ <dd property="yui:returnInfo">whether the run loop should continue</dd>
+ </dl>
+
+
+
+
+ </div>
+
+ </div>
+ <hr />
+ </div>
+ <div class="protected" rel="yui:method" resource="#method__init">
+ <h4>
+ <a name="method__init">_init</a></h4>
+ <div class="detail" >
+ <code>
+ protected
+
+
+ void
+ <strong property="yui:name">_init</strong>
+ (
+ )
+ </code>
+
+ <div class="description" property="yui:description">
+ Initializes the AsyncQueue instance properties and events.
+ </div>
+
+ <div class="description">
+
+
+
+
+
+
+ </div>
+
+ </div>
+ <hr />
+ </div>
+ <div class="protected" rel="yui:method" resource="#method__initEvents">
+ <h4>
+ <a name="method__initEvents">_initEvents</a></h4>
+ <div class="detail" >
+ <code>
+ protected
+
+
+ void
+ <strong property="yui:name">_initEvents</strong>
+ (
+ )
+ </code>
+
+ <div class="description" property="yui:description">
+ Initializes the instance events.
+ </div>
+
+ <div class="description">
+
+
+
+
+
+
+ </div>
+
+ </div>
+ <hr />
+ </div>
+ <div class="protected" rel="yui:method" resource="#method__prepare">
+ <h4>
+ <a name="method__prepare">_prepare</a></h4>
+ <div class="detail" >
+ <code>
+ protected
+
+
+ Function
+ <strong property="yui:name">_prepare</strong>
+ (
+
+
+ callback
+
+
+ )
+ </code>
+
+ <div class="description" property="yui:description">
+ Creates a wrapper function to execute the callback using the aggregated
+configuration generated by combining the static AsyncQueue.defaults, the
+instance defaults, and the specified callback settings.
+The wrapper function is decorated with the callback configuration as
+properties for runtime modification.
+ </div>
+
+ <div class="description">
+
+ <dl rel="yui:parameters">
+ <dt>Parameters:</dt>
+ <dd rel="yui:parameter">
+ <code><span property="yui:name">callback</span>
+ <<span property="yui:type">Object|Function</span>>
+ </code>
+ <span property="yui:description"> the raw callback</span>
+ </dd>
+ </dl>
+
+ <dl>
+ <dt>Returns:
+ <code property="yui:return">
+ Function
+ </code></dt>
+ <dd property="yui:returnInfo">a decorated function wrapper to execute the callback</dd>
+ </dl>
+
+
+
+
+ </div>
+
+ </div>
+ <hr />
+ </div>
+ <div class="protected" rel="yui:method" resource="#method__schedule">
+ <h4>
+ <a name="method__schedule">_schedule</a></h4>
+ <div class="detail" >
+ <code>
+ protected
+
+
+ Boolean
+ <strong property="yui:name">_schedule</strong>
+ (
+
+
+ callback
+
+
+ )
+ </code>
+
+ <div class="description" property="yui:description">
+ Schedules the execution of asynchronous callbacks.
+ </div>
+
+ <div class="description">
+
+ <dl rel="yui:parameters">
+ <dt>Parameters:</dt>
+ <dd rel="yui:parameter">
+ <code><span property="yui:name">callback</span>
+ <<span property="yui:type">Object</span>>
+ </code>
+ <span property="yui:description"> the callback object to execute</span>
+ </dd>
+ </dl>
+
+ <dl>
+ <dt>Returns:
+ <code property="yui:return">
+ Boolean
+ </code></dt>
+ <dd property="yui:returnInfo">whether the run loop should continue</dd>
+ </dl>
+
+
+
+
+ </div>
+
+ </div>
+ <hr />
+ </div>
+ <div class="" rel="yui:method" resource="#method_add">
+ <h4>
+ <a name="method_add">add</a></h4>
+ <div class="detail" >
+ <code>
+
+
+
+ AsyncQueue
+ <strong property="yui:name">add</strong>
+ (
+
+
+ callback*
+
+
+ )
+ </code>
+
+ <div class="description" property="yui:description">
+ Add any number of callbacks to the end of the queue. Callbacks may be
+provided as functions or objects.
+ </div>
+
+ <div class="description">
+
+ <dl rel="yui:parameters">
+ <dt>Parameters:</dt>
+ <dd rel="yui:parameter">
+ <code><span property="yui:name">callback*</span>
+ <<span property="yui:type">Function|Object</span>>
+ </code>
+ <span property="yui:description"> 0..n callbacks</span>
+ </dd>
+ </dl>
+
+ <dl>
+ <dt>Returns:
+ <code property="yui:return">
+ AsyncQueue
+ </code></dt>
+ <dd property="yui:returnInfo">the AsyncQueue instance</dd>
+ </dl>
+
+ <div class="chainable">
+ <strong>Chainable:</strong> This method is chainable.
+ </div>
+
+
+
+ </div>
+
+ </div>
+ <hr />
+ </div>
+ <div class="" rel="yui:method" resource="#method_getCallback">
+ <h4>
+ <a name="method_getCallback">getCallback</a></h4>
+ <div class="detail" >
+ <code>
+
+
+
+ Object
+ <strong property="yui:name">getCallback</strong>
+ (
+
+
+ id
+
+
+ )
+ </code>
+
+ <div class="description" property="yui:description">
+ Retrieve a callback by its id. Useful to modify the configuration
+while the queue is running.
+ </div>
+
+ <div class="description">
+
+ <dl rel="yui:parameters">
+ <dt>Parameters:</dt>
+ <dd rel="yui:parameter">
+ <code><span property="yui:name">id</span>
+ <<span property="yui:type">String</span>>
+ </code>
+ <span property="yui:description"> the id assigned to the callback</span>
+ </dd>
+ </dl>
+
+ <dl>
+ <dt>Returns:
+ <code property="yui:return">
+ Object
+ </code></dt>
+ <dd property="yui:returnInfo">the callback object</dd>
+ </dl>
+
+
+
+
+ </div>
+
+ </div>
+ <hr />
+ </div>
+ <div class="" rel="yui:method" resource="#method_indexOf">
+ <h4>
+ <a name="method_indexOf">indexOf</a></h4>
+ <div class="detail" >
+ <code>
+
+
+
+ Number
+ <strong property="yui:name">indexOf</strong>
+ (
+
+
+ callback
+
+
+ )
+ </code>
+
+ <div class="description" property="yui:description">
+ Returns the current index of a callback. Pass in either the id or
+callback function from getCallback.
+ </div>
+
+ <div class="description">
+
+ <dl rel="yui:parameters">
+ <dt>Parameters:</dt>
+ <dd rel="yui:parameter">
+ <code><span property="yui:name">callback</span>
+ <<span property="yui:type">String|Function</span>>
+ </code>
+ <span property="yui:description"> the callback or its specified id</span>
+ </dd>
+ </dl>
+
+ <dl>
+ <dt>Returns:
+ <code property="yui:return">
+ Number
+ </code></dt>
+ <dd property="yui:returnInfo">index of the callback or -1 if not found</dd>
+ </dl>
+
+
+
+
+ </div>
+
+ </div>
+ <hr />
+ </div>
+ <div class="" rel="yui:method" resource="#method_isRunning">
+ <h4>
+ <a name="method_isRunning">isRunning</a></h4>
+ <div class="detail" >
+ <code>
+
+
+
+ Boolean
+ <strong property="yui:name">isRunning</strong>
+ (
+ )
+ </code>
+
+ <div class="description" property="yui:description">
+ Determines if the queue is waiting for a callback to complete execution.
+ </div>
+
+ <div class="description">
+
+
+ <dl>
+ <dt>Returns:
+ <code property="yui:return">
+ Boolean
+ </code></dt>
+ <dd property="yui:returnInfo">true if queue is waiting for a
+from any initiated transactions</dd>
+ </dl>
+
+
+
+
+ </div>
+
+ </div>
+ <hr />
+ </div>
+ <div class="" rel="yui:method" resource="#method_next">
+ <h4>
+ <a name="method_next">next</a></h4>
+ <div class="detail" >
+ <code>
+
+
+
+ Function
+ <strong property="yui:name">next</strong>
+ (
+ )
+ </code>
+
+ <div class="description" property="yui:description">
+ Returns the next callback needing execution. If a callback is
+configured to repeat via iterations or until, it will be returned until
+the completion criteria is met.
+When the queue is empty, null is returned.
+ </div>
+
+ <div class="description">
+
+
+ <dl>
+ <dt>Returns:
+ <code property="yui:return">
+ Function
+ </code></dt>
+ <dd property="yui:returnInfo">the callback to execute</dd>
+ </dl>
+
+
+
+
+ </div>
+
+ </div>
+ <hr />
+ </div>
+ <div class="" rel="yui:method" resource="#method_pause">
+ <h4>
+ <a name="method_pause">pause</a></h4>
+ <div class="detail" >
+ <code>
+
+
+
+ AsyncQueue
+ <strong property="yui:name">pause</strong>
+ (
+ )
+ </code>
+
+ <div class="description" property="yui:description">
+ Pause the execution of the queue after the execution of the current
+callback completes. If called from code outside of a queued callback,
+clears the timeout for the pending callback. Paused queue can be
+restarted with q.run()
+ </div>
+
+ <div class="description">
+
+
+ <dl>
+ <dt>Returns:
+ <code property="yui:return">
+ AsyncQueue
+ </code></dt>
+ <dd property="yui:returnInfo">the AsyncQueue instance</dd>
+ </dl>
+
+ <div class="chainable">
+ <strong>Chainable:</strong> This method is chainable.
+ </div>
+
+
+
+ </div>
+
+ </div>
+ <hr />
+ </div>
+ <div class="" rel="yui:method" resource="#method_promote">
+ <h4>
+ <a name="method_promote">promote</a></h4>
+ <div class="detail" >
+ <code>
+
+
+
+ AsyncQueue
+ <strong property="yui:name">promote</strong>
+ (
+
+
+ callback
+
+
+ )
+ </code>
+
+ <div class="description" property="yui:description">
+ Promotes the named callback to the top of the queue. If a callback is
+currently executing or looping (via until or iterations), the promotion
+is scheduled to occur after the current callback has completed.
+ </div>
+
+ <div class="description">
+
+ <dl rel="yui:parameters">
+ <dt>Parameters:</dt>
+ <dd rel="yui:parameter">
+ <code><span property="yui:name">callback</span>
+ <<span property="yui:type">String|Object</span>>
+ </code>
+ <span property="yui:description"> the callback object or a callback's id</span>
+ </dd>
+ </dl>
+
+ <dl>
+ <dt>Returns:
+ <code property="yui:return">
+ AsyncQueue
+ </code></dt>
+ <dd property="yui:returnInfo">the AsyncQueue instance</dd>
+ </dl>
+
+ <div class="chainable">
+ <strong>Chainable:</strong> This method is chainable.
+ </div>
+
+
+
+ </div>
+
+ </div>
+ <hr />
+ </div>
+ <div class="" rel="yui:method" resource="#method_remove">
+ <h4>
+ <a name="method_remove">remove</a></h4>
+ <div class="detail" >
+ <code>
+
+
+
+ AsyncQueue
+ <strong property="yui:name">remove</strong>
+ (
+
+
+ callback
+
+
+ )
+ </code>
+
+ <div class="description" property="yui:description">
+ Removes the callback from the queue. If the queue is active, the
+removal is scheduled to occur after the current callback has completed.
+ </div>
+
+ <div class="description">
+
+ <dl rel="yui:parameters">
+ <dt>Parameters:</dt>
+ <dd rel="yui:parameter">
+ <code><span property="yui:name">callback</span>
+ <<span property="yui:type">String|Object</span>>
+ </code>
+ <span property="yui:description"> the callback object or a callback's id</span>
+ </dd>
+ </dl>
+
+ <dl>
+ <dt>Returns:
+ <code property="yui:return">
+ AsyncQueue
+ </code></dt>
+ <dd property="yui:returnInfo">the AsyncQueue instance</dd>
+ </dl>
+
+ <div class="chainable">
+ <strong>Chainable:</strong> This method is chainable.
+ </div>
+
+
+
+ </div>
+
+ </div>
+ <hr />
+ </div>
+ <div class="" rel="yui:method" resource="#method_run">
+ <h4>
+ <a name="method_run">run</a></h4>
+ <div class="detail" >
+ <code>
+
+
+
+ AsyncQueue
+ <strong property="yui:name">run</strong>
+ (
+ )
+ </code>
+
+ <div class="description" property="yui:description">
+ Sets the queue in motion. All queued callbacks will be executed in
+order unless pause() or stop() is called or if one of the callbacks is
+configured with autoContinue: false.
+ </div>
+
+ <div class="description">
+
+
+ <dl>
+ <dt>Returns:
+ <code property="yui:return">
+ AsyncQueue
+ </code></dt>
+ <dd property="yui:returnInfo">the AsyncQueue instance</dd>
+ </dl>
+
+ <div class="chainable">
+ <strong>Chainable:</strong> This method is chainable.
+ </div>
+
+
+
+ </div>
+
+ </div>
+ <hr />
+ </div>
+ <div class="" rel="yui:method" resource="#method_size">
+ <h4>
+ <a name="method_size">size</a></h4>
+ <div class="detail" >
+ <code>
+
+
+
+ Number
+ <strong property="yui:name">size</strong>
+ (
+ )
+ </code>
+
+ <div class="description" property="yui:description">
+ Returns the number of callbacks in the queue.
+ </div>
+
+ <div class="description">
+
+
+
+
+
+
+ </div>
+
+ </div>
+ <hr />
+ </div>
+ <div class="" rel="yui:method" resource="#method_stop">
+ <h4>
+ <a name="method_stop">stop</a></h4>
+ <div class="detail" >
+ <code>
+
+
+
+ AsyncQueue
+ <strong property="yui:name">stop</strong>
+ (
+ )
+ </code>
+
+ <div class="description" property="yui:description">
+ Stop and clear the queue after the current execution of the
+current callback completes.
+ </div>
+
+ <div class="description">
+
+
+ <dl>
+ <dt>Returns:
+ <code property="yui:return">
+ AsyncQueue
+ </code></dt>
+ <dd property="yui:returnInfo">the AsyncQueue instance</dd>
+ </dl>
+
+ <div class="chainable">
+ <strong>Chainable:</strong> This method is chainable.
+ </div>
+
+
+
+ </div>
+
+ </div>
+ <hr />
+ </div>
+ </div>
+ </div>
+
+ <div rel="yui:inheritance">
+ <div class="section field inheritance" rel="yui:superclass" resource="EventTarget.html">
+ <h4>Methods inherited from <a href="EventTarget.html" property="yui:name" title="EventTarget">EventTarget</a>:</h4>
+ <div class="content" rel="yui:methods">
+ <code>
+ <span rel="yui:method" resource="EventTarget.html#method__getType">
+ <a class="private" href="EventTarget.html#method__getType" property="yui:name" title="_getType">_getType</a><span class="private">,</span>
+ </span>
+ <span rel="yui:method" resource="EventTarget.html#method__parseType">
+ <a class="private" href="EventTarget.html#method__parseType" property="yui:name" title="_parseType">_parseType</a><span class="private">,</span>
+ </span>
+ <span rel="yui:method" resource="EventTarget.html#method_addTarget">
+ <a class="" href="EventTarget.html#method_addTarget" property="yui:name" title="addTarget">addTarget</a><span class="">,</span>
+ </span>
+ <span rel="yui:method" resource="EventTarget.html#method_after">
+ <a class="" href="EventTarget.html#method_after" property="yui:name" title="after">after</a><span class="">,</span>
+ </span>
+ <span rel="yui:method" resource="EventTarget.html#method_before">
+ <a class=" deprecated" href="EventTarget.html#method_before" property="yui:name" title="before">before</a><span class=" deprecated">,</span>
+ </span>
+ <span rel="yui:method" resource="EventTarget.html#method_bubble">
+ <a class="" href="EventTarget.html#method_bubble" property="yui:name" title="bubble">bubble</a><span class="">,</span>
+ </span>
+ <span rel="yui:method" resource="EventTarget.html#method_detach">
+ <a class="" href="EventTarget.html#method_detach" property="yui:name" title="detach">detach</a><span class="">,</span>
+ </span>
+ <span rel="yui:method" resource="EventTarget.html#method_detachAll">
+ <a class="" href="EventTarget.html#method_detachAll" property="yui:name" title="detachAll">detachAll</a><span class="">,</span>
+ </span>
+ <span rel="yui:method" resource="EventTarget.html#method_fire">
+ <a class="" href="EventTarget.html#method_fire" property="yui:name" title="fire">fire</a><span class="">,</span>
+ </span>
+ <span rel="yui:method" resource="EventTarget.html#method_getEvent">
+ <a class="" href="EventTarget.html#method_getEvent" property="yui:name" title="getEvent">getEvent</a><span class="">,</span>
+ </span>
+ <span rel="yui:method" resource="EventTarget.html#method_on">
+ <a class="" href="EventTarget.html#method_on" property="yui:name" title="on">on</a><span class="">,</span>
+ </span>
+ <span rel="yui:method" resource="EventTarget.html#method_publish">
+ <a class="" href="EventTarget.html#method_publish" property="yui:name" title="publish">publish</a><span class="">,</span>
+ </span>
+ <span rel="yui:method" resource="EventTarget.html#method_removeTarget">
+ <a class="" href="EventTarget.html#method_removeTarget" property="yui:name" title="removeTarget">removeTarget</a><span class="">,</span>
+ </span>
+ <span rel="yui:method" resource="EventTarget.html#method_subscribe">
+ <a class=" deprecated" href="EventTarget.html#method_subscribe" property="yui:name" title="subscribe">subscribe</a><span class=" deprecated">,</span>
+ </span>
+ <span rel="yui:method" resource="EventTarget.html#method_unsubscribe">
+ <a class=" deprecated" href="EventTarget.html#method_unsubscribe" property="yui:name" title="unsubscribe">unsubscribe</a><span class=" deprecated">,</span>
+ </span>
+ <span rel="yui:method" resource="EventTarget.html#method_unsubscribeAll">
+ <a class=" deprecated" href="EventTarget.html#method_unsubscribeAll" property="yui:name" title="unsubscribeAll">unsubscribeAll</a>
+ </span>
+ </code>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <div rel="yui:events" resource="#events">
+ <div class="section method details">
+ <h3 id="events">Events</h3>
+ <div class="content">
+ <div class="" rel="yui:event" resource="#event_complete">
+ <h4>
+ <a name="event_complete">complete</a></h4>
+ <div class="detail">
+ <code>
+
+
+
+ <strong property="yui:name">complete</strong>
+
+ (
+ )
+
+ </code>
+
+ <div class="description" property="yui:description">
+ Event fired after the last queued callback is executed.
+ </div>
+
+ <div class="description">
+
+
+
+
+ </div>
+
+ </div>
+ <hr />
+ </div>
+ </div>
+ </div>
+
+
+ </div>
+
+ <div rel="yui:attributes" resource="#configattributes">
+
+ </div>
+
+ </div>
+ </div>
+ <div class="yui-b">
+ <div class="nav">
+
+ <div id="moduleList" class="module">
+ <h4>Modules</h4>
+ <ul class="content">
+ <li class=""><a href="module_anim.html" title="anim">anim</a></li>
+ <li class="selected"><a href="module_async-queue.html" title="async-queue">async-queue</a></li>
+ <li class=""><a href="module_attribute.html" title="attribute">attribute</a></li>
+ <li class=""><a href="module_base.html" title="base">base</a></li>
+ <li class=""><a href="module_cache.html" title="cache">cache</a></li>
+ <li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li>
+ <li class=""><a href="module_collection.html" title="collection">collection</a></li>
+ <li class=""><a href="module_console.html" title="console">console</a></li>
+ <li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li>
+ <li class=""><a href="module_cookie.html" title="cookie">cookie</a></li>
+ <li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li>
+ <li class=""><a href="module_datasource.html" title="datasource">datasource</a></li>
+ <li class=""><a href="module_datatype.html" title="datatype">datatype</a></li>
+ <li class=""><a href="module_dd.html" title="dd">dd</a></li>
+ <li class=""><a href="module_dom.html" title="dom">dom</a></li>
+ <li class=""><a href="module_dump.html" title="dump">dump</a></li>
+ <li class=""><a href="module_event.html" title="event">event</a></li>
+ <li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li>
+ <li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li>
+ <li class=""><a href="module_history.html" title="history">history</a></li>
+ <li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li>
+ <li class=""><a href="module_io.html" title="io">io</a></li>
+ <li class=""><a href="module_json.html" title="json">json</a></li>
+ <li class=""><a href="module_node.html" title="node">node</a></li>
+ <li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li>
+ <li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li>
+ <li class=""><a href="module_oop.html" title="oop">oop</a></li>
+ <li class=""><a href="module_overlay.html" title="overlay">overlay</a></li>
+ <li class=""><a href="module_plugin.html" title="plugin">plugin</a></li>
+ <li class=""><a href="module_profiler.html" title="profiler">profiler</a></li>
+ <li class=""><a href="module_queue-promote.html" title="queue-promote">queue-promote</a></li>
+ <li class=""><a href="module_slider.html" title="slider">slider</a></li>
+ <li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li>
+ <li class=""><a href="module_substitute.html" title="substitute">substitute</a></li>
+ <li class=""><a href="module_test.html" title="test">test</a></li>
+ <li class=""><a href="module_widget.html" title="widget">widget</a></li>
+ <li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li>
+ <li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li>
+ <li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li>
+ <li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li>
+ <li class=""><a href="module_yui.html" title="yui">yui</a></li>
+ </ul>
+ </div>
+
+ <div id="classList" class="module">
+ <h4>Classes</h4>
+ <ul class="content">
+ <li class="selected"><a href="AsyncQueue.html" title="AsyncQueue">AsyncQueue</a></li>
+ </ul>
+ </div>
+
+ <div id="fileList" class="module">
+ <h4>Files</h4>
+ <ul class="content">
+ <li class=""><a href="async-queue.js.html" title="async-queue.js">async-queue.js</a></li>
+ </ul>
+ </div>
+
+ <div id="propertyList" class="module">
+ <h4>Properties</h4>
+ <ul class="content">
+ <li class="protected"><a href="#property__running" title="_running">_running</a></li>
+ <li class=""><a href="#property_AsyncQueue.defaults" title="AsyncQueue.defaults">AsyncQueue.defaults</a></li>
+ <li class=""><a href="#property_defaults" title="defaults">defaults</a></li>
+ </ul>
+ </div>
+
+ <div id="methodsList" class="module">
+ <h4>Methods</h4>
+ <ul class="content">
+ <li class="protected"><a href="#method__defAddFn" title="_defAddFn">_defAddFn</a></li>
+ <li class="protected"><a href="#method__defExecFn" title="_defExecFn">_defExecFn</a></li>
+ <li class="protected"><a href="#method__defPromoteFn" title="_defPromoteFn">_defPromoteFn</a></li>
+ <li class="protected"><a href="#method__defRemoveFn" title="_defRemoveFn">_defRemoveFn</a></li>
+ <li class="protected"><a href="#method__defShiftFn" title="_defShiftFn">_defShiftFn</a></li>
+ <li class="protected"><a href="#method__execute" title="_execute">_execute</a></li>
+ <li class="protected"><a href="#method__init" title="_init">_init</a></li>
+ <li class="protected"><a href="#method__initEvents" title="_initEvents">_initEvents</a></li>
+ <li class="protected"><a href="#method__prepare" title="_prepare">_prepare</a></li>
+ <li class="protected"><a href="#method__schedule" title="_schedule">_schedule</a></li>
+ <li class=""><a href="#method_add" title="add">add</a></li>
+ <li class=""><a href="#method_getCallback" title="getCallback">getCallback</a></li>
+ <li class=""><a href="#method_indexOf" title="indexOf">indexOf</a></li>
+ <li class=""><a href="#method_isRunning" title="isRunning">isRunning</a></li>
+ <li class=""><a href="#method_next" title="next">next</a></li>
+ <li class=""><a href="#method_pause" title="pause">pause</a></li>
+ <li class=""><a href="#method_promote" title="promote">promote</a></li>
+ <li class=""><a href="#method_remove" title="remove">remove</a></li>
+ <li class=""><a href="#method_run" title="run">run</a></li>
+ <li class=""><a href="#method_size" title="size">size</a></li>
+ <li class=""><a href="#method_stop" title="stop">stop</a></li>
+ </ul>
+ </div>
+
+ <div id="eventsList" class="module">
+ <h4>Events</h4>
+ <ul class="content">
+ <li class=""><a href="#event_complete" title="complete">complete</a></li>
+ </ul>
+ </div>
+
+
+ </div>
+ </div>
+ </div>
+ <div id="ft">
+ <hr />
+ Copyright © 2009 Yahoo! Inc. All rights reserved.
+ </div>
+</div>
+<script type="text/javascript">
+ 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"}];
+</script>
+</body>
+</html>