diff -r 000000000000 -r 40c8f766c9b8 src/cm/media/js/lib/yui/yui3.0.0/api/Queue.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/cm/media/js/lib/yui/yui3.0.0/api/Queue.html Mon Nov 23 15:14:29 2009 +0100 @@ -0,0 +1,508 @@ + + + + + API: yui Queue (YUI Library) + + + + + + + + + + +
+
+

Yahoo! UI Library

+

yui  3.0.0

+ Yahoo! UI Library + > yui + > Queue + +
+
+ Search: +
+   +
+
+
+
+ +
+
+
+
+
+ Filters + + + +
+
+ +

+ + + + + Class Queue + + + +

+ + + + + +
+ A simple FIFO queue. Items are added to the Queue with add(1..n items) and +removed using next(). +
+ + +
+
+

Properties

+
+
+

_q + - protected {Array} +

+
+
+ The collection of enqueued items +
+
+ + + + +
+
+
+
+ +
+ +
+
+

Methods

+
+
+

+ _init

+
+ + protected + + + void + _init + ( + ) + + +
+ Initialize the queue +
+ +
+ + + + + + +
+ +
+
+
+
+

+ add

+
+ + + + + void + add + ( + + + item* + + + ) + + +
+ Add 0..n items to the end of the queue +
+ +
+ +
+
Parameters:
+
+ item* + <MIXED> + + 0..n items +
+
+ + + + + +
+ +
+
+
+
+

+ indexOf

+
+ + + + + Number + indexOf + ( + + + needle + + + ) + + +
+ Returns the current index in the queue of the specified item +
+ +
+ +
+
Parameters:
+
+ needle + <MIXED> + + the item to search for +
+
+ +
+
Returns: + + Number +
+
the index of the item or -1 if not found
+
+ + + + +
+ +
+
+
+
+

+ next

+
+ + + + + MIXED + next + ( + ) + + +
+ Get the next item in the queue. +
+ +
+ + +
+
Returns: + + MIXED +
+
the next item in the queue
+
+ + + + +
+ +
+
+
+
+

+ promote

+
+ + + + + void + promote + ( + + + item + + + ) + + +
+ Moves the referenced item to the head of the queue +
+ +
+ +
+
Parameters:
+
+ item + <MIXED> + + an item in the queue +
+
+ + + + + +
+ +
+
+
+
+

+ remove

+
+ + + + + void + remove + ( + + + item + + + ) + + +
+ Removes the referenced item from the queue +
+ +
+ +
+
Parameters:
+
+ item + <MIXED> + + an item in the queue +
+
+ + + + + +
+ +
+
+
+
+

+ size

+
+ + + + + Number + size + ( + ) + + +
+ Returns the current number of queued items +
+ +
+ + + + + + +
+ +
+
+
+
+
+ +
+ +
+ + +
+ +
+ +
+ +
+
+ +
+
+
+ Copyright © 2009 Yahoo! Inc. All rights reserved. +
+
+ + +