dojox/collections/Queue.js

  • Provides:

    • dojox.collections.Queue
  • Requires:

    • dojox.collections._base in common
  • dojox.collections.Queue

    • type
      Function
    • parameters:
      • arr: (typeof array)
    • source: [view]
      dojo.provide("dojox.collections.Queue");
      dojo.require("dojox.collections._base");


      dojox.collections.Queue=function(/* array? */arr){
       // summary
       // return an object of type dojox.collections.Queue
       var q=[];
       if (arr){
        q=q.concat(arr);
       }
       this.count=q.length;
       this.clear=function(){
        // summary
        // clears the internal collection
        q=[];
        this.count=q.length;
       };
       this.clone=function(){
        // summary
        // creates a new Queue based on this one
        return new dojox.collections.Queue(q); // dojox.collections.Queue
       };
       this.contains=function(/* object */ o){
        // summary
        // Check to see if the passed object is an element in this queue
        for(var i=0; i   if (q[i]==o){
          return true; // bool
         }
        }
        return false; // bool
       };
       this.copyTo=function(/* array */ arr, /* int */ i){
        // summary
        // Copy the contents of this queue into the passed array at index i.
        arr.splice(i,0,q);
       };
       this.dequeue=function(){
        // summary
        // shift the first element off the queue and return it
        var r=q.shift();
        this.count=q.length;
        return r; // object
       };
       this.enqueue=function(/* object */ o){
        // summary
        // put the passed object at the end of the queue
        this.count=q.push(o);
       };
       this.forEach=function(/* function */ fn, /* object? */ scope){
        // summary
        // functional iterator, following the mozilla spec.
        dojo.forEach(q, fn, scope);
       };
       this.getIterator=function(){
        // summary
        // get an Iterator based on this queue.
        return new dojox.collections.Iterator(q); // dojox.collections.Iterator
       };
       this.peek=function(){
        // summary
        // get the next element in the queue without altering the queue.
        return q[0];
       };
       this.toArray=function(){
        // summary
        // return an array based on the internal array of the queue.
        return [].concat(q);
       };
    • returns
      dojox.collections.Queue|bool|object|dojox.collections.Iterator
    • summary
  • dojox.collections.Queue.count

    • summary
  • dojox.collections.Queue.clear

    • type
      Function
    • source: [view]
      dojo.provide("dojox.collections.Queue");
      dojo.require("dojox.collections._base");


      dojox.collections.Queue=function(/* array? */arr){
       // summary
       // return an object of type dojox.collections.Queue
       var q=[];
       if (arr){
        q=q.concat(arr);
       }
       this.count=q.length;
       this.clear=function(){
        // summary
        // clears the internal collection
        q=[];
        this.count=q.length;
    • summary
  • dojox.collections.Queue.clone

    • type
      Function
    • source: [view]
      dojo.provide("dojox.collections.Queue");
      dojo.require("dojox.collections._base");


      dojox.collections.Queue=function(/* array? */arr){
       // summary
       // return an object of type dojox.collections.Queue
       var q=[];
       if (arr){
        q=q.concat(arr);
       }
       this.count=q.length;
       this.clear=function(){
        // summary
        // clears the internal collection
        q=[];
        this.count=q.length;
       };
       this.clone=function(){
        // summary
        // creates a new Queue based on this one
        return new dojox.collections.Queue(q); // dojox.collections.Queue
    • returns
      dojox.collections.Queue
    • summary
  • dojox.collections.Queue.contains

    • type
      Function
    • parameters:
      • o: (typeof object)
    • source: [view]
      dojo.provide("dojox.collections.Queue");
      dojo.require("dojox.collections._base");


      dojox.collections.Queue=function(/* array? */arr){
       // summary
       // return an object of type dojox.collections.Queue
       var q=[];
       if (arr){
        q=q.concat(arr);
       }
       this.count=q.length;
       this.clear=function(){
        // summary
        // clears the internal collection
        q=[];
        this.count=q.length;
       };
       this.clone=function(){
        // summary
        // creates a new Queue based on this one
        return new dojox.collections.Queue(q); // dojox.collections.Queue
       };
       this.contains=function(/* object */ o){
        // summary
        // Check to see if the passed object is an element in this queue
        for(var i=0; i   if (q[i]==o){
          return true; // bool
         }
        }
        return false; // bool
    • returns
      dojox.collections.Queue|bool
    • summary
  • dojox.collections.Queue.copyTo

    • type
      Function
    • parameters:
      • arr: (typeof array)
      • i: (typeof int)
    • source: [view]
      dojo.provide("dojox.collections.Queue");
      dojo.require("dojox.collections._base");


      dojox.collections.Queue=function(/* array? */arr){
       // summary
       // return an object of type dojox.collections.Queue
       var q=[];
       if (arr){
        q=q.concat(arr);
       }
       this.count=q.length;
       this.clear=function(){
        // summary
        // clears the internal collection
        q=[];
        this.count=q.length;
       };
       this.clone=function(){
        // summary
        // creates a new Queue based on this one
        return new dojox.collections.Queue(q); // dojox.collections.Queue
       };
       this.contains=function(/* object */ o){
        // summary
        // Check to see if the passed object is an element in this queue
        for(var i=0; i   if (q[i]==o){
          return true; // bool
         }
        }
        return false; // bool
       };
       this.copyTo=function(/* array */ arr, /* int */ i){
        // summary
        // Copy the contents of this queue into the passed array at index i.
        arr.splice(i,0,q);
    • returns
      dojox.collections.Queue|bool
    • summary
  • dojox.collections.Queue.dequeue

    • type
      Function
    • source: [view]
      dojo.provide("dojox.collections.Queue");
      dojo.require("dojox.collections._base");


      dojox.collections.Queue=function(/* array? */arr){
       // summary
       // return an object of type dojox.collections.Queue
       var q=[];
       if (arr){
        q=q.concat(arr);
       }
       this.count=q.length;
       this.clear=function(){
        // summary
        // clears the internal collection
        q=[];
        this.count=q.length;
       };
       this.clone=function(){
        // summary
        // creates a new Queue based on this one
        return new dojox.collections.Queue(q); // dojox.collections.Queue
       };
       this.contains=function(/* object */ o){
        // summary
        // Check to see if the passed object is an element in this queue
        for(var i=0; i   if (q[i]==o){
          return true; // bool
         }
        }
        return false; // bool
       };
       this.copyTo=function(/* array */ arr, /* int */ i){
        // summary
        // Copy the contents of this queue into the passed array at index i.
        arr.splice(i,0,q);
       };
       this.dequeue=function(){
        // summary
        // shift the first element off the queue and return it
        var r=q.shift();
        this.count=q.length;
        return r; // object
    • returns
      dojox.collections.Queue|bool|object
    • summary
  • dojox.collections.Queue.enqueue

    • type
      Function
    • parameters:
      • o: (typeof object)
    • source: [view]
      dojo.provide("dojox.collections.Queue");
      dojo.require("dojox.collections._base");


      dojox.collections.Queue=function(/* array? */arr){
       // summary
       // return an object of type dojox.collections.Queue
       var q=[];
       if (arr){
        q=q.concat(arr);
       }
       this.count=q.length;
       this.clear=function(){
        // summary
        // clears the internal collection
        q=[];
        this.count=q.length;
       };
       this.clone=function(){
        // summary
        // creates a new Queue based on this one
        return new dojox.collections.Queue(q); // dojox.collections.Queue
       };
       this.contains=function(/* object */ o){
        // summary
        // Check to see if the passed object is an element in this queue
        for(var i=0; i   if (q[i]==o){
          return true; // bool
         }
        }
        return false; // bool
       };
       this.copyTo=function(/* array */ arr, /* int */ i){
        // summary
        // Copy the contents of this queue into the passed array at index i.
        arr.splice(i,0,q);
       };
       this.dequeue=function(){
        // summary
        // shift the first element off the queue and return it
        var r=q.shift();
        this.count=q.length;
        return r; // object
       };
       this.enqueue=function(/* object */ o){
        // summary
        // put the passed object at the end of the queue
        this.count=q.push(o);
    • returns
      dojox.collections.Queue|bool|object
    • summary
  • dojox.collections.Queue.forEach

    • type
      Function
    • parameters:
      • fn: (typeof function)
      • scope: (typeof object)
    • source: [view]
      dojo.provide("dojox.collections.Queue");
      dojo.require("dojox.collections._base");


      dojox.collections.Queue=function(/* array? */arr){
       // summary
       // return an object of type dojox.collections.Queue
       var q=[];
       if (arr){
        q=q.concat(arr);
       }
       this.count=q.length;
       this.clear=function(){
        // summary
        // clears the internal collection
        q=[];
        this.count=q.length;
       };
       this.clone=function(){
        // summary
        // creates a new Queue based on this one
        return new dojox.collections.Queue(q); // dojox.collections.Queue
       };
       this.contains=function(/* object */ o){
        // summary
        // Check to see if the passed object is an element in this queue
        for(var i=0; i   if (q[i]==o){
          return true; // bool
         }
        }
        return false; // bool
       };
       this.copyTo=function(/* array */ arr, /* int */ i){
        // summary
        // Copy the contents of this queue into the passed array at index i.
        arr.splice(i,0,q);
       };
       this.dequeue=function(){
        // summary
        // shift the first element off the queue and return it
        var r=q.shift();
        this.count=q.length;
        return r; // object
       };
       this.enqueue=function(/* object */ o){
        // summary
        // put the passed object at the end of the queue
        this.count=q.push(o);
       };
       this.forEach=function(/* function */ fn, /* object? */ scope){
        // summary
        // functional iterator, following the mozilla spec.
        dojo.forEach(q, fn, scope);
    • returns
      dojox.collections.Queue|bool|object
    • summary
  • dojox.collections.Queue.getIterator

    • type
      Function
    • source: [view]
      dojo.provide("dojox.collections.Queue");
      dojo.require("dojox.collections._base");


      dojox.collections.Queue=function(/* array? */arr){
       // summary
       // return an object of type dojox.collections.Queue
       var q=[];
       if (arr){
        q=q.concat(arr);
       }
       this.count=q.length;
       this.clear=function(){
        // summary
        // clears the internal collection
        q=[];
        this.count=q.length;
       };
       this.clone=function(){
        // summary
        // creates a new Queue based on this one
        return new dojox.collections.Queue(q); // dojox.collections.Queue
       };
       this.contains=function(/* object */ o){
        // summary
        // Check to see if the passed object is an element in this queue
        for(var i=0; i   if (q[i]==o){
          return true; // bool
         }
        }
        return false; // bool
       };
       this.copyTo=function(/* array */ arr, /* int */ i){
        // summary
        // Copy the contents of this queue into the passed array at index i.
        arr.splice(i,0,q);
       };
       this.dequeue=function(){
        // summary
        // shift the first element off the queue and return it
        var r=q.shift();
        this.count=q.length;
        return r; // object
       };
       this.enqueue=function(/* object */ o){
        // summary
        // put the passed object at the end of the queue
        this.count=q.push(o);
       };
       this.forEach=function(/* function */ fn, /* object? */ scope){
        // summary
        // functional iterator, following the mozilla spec.
        dojo.forEach(q, fn, scope);
       };
       this.getIterator=function(){
        // summary
        // get an Iterator based on this queue.
        return new dojox.collections.Iterator(q); // dojox.collections.Iterator
    • returns
      dojox.collections.Queue|bool|object|dojox.collections.Iterator
    • summary
  • dojox.collections.Queue.peek

    • type
      Function
    • source: [view]
      dojo.provide("dojox.collections.Queue");
      dojo.require("dojox.collections._base");


      dojox.collections.Queue=function(/* array? */arr){
       // summary
       // return an object of type dojox.collections.Queue
       var q=[];
       if (arr){
        q=q.concat(arr);
       }
       this.count=q.length;
       this.clear=function(){
        // summary
        // clears the internal collection
        q=[];
        this.count=q.length;
       };
       this.clone=function(){
        // summary
        // creates a new Queue based on this one
        return new dojox.collections.Queue(q); // dojox.collections.Queue
       };
       this.contains=function(/* object */ o){
        // summary
        // Check to see if the passed object is an element in this queue
        for(var i=0; i   if (q[i]==o){
          return true; // bool
         }
        }
        return false; // bool
       };
       this.copyTo=function(/* array */ arr, /* int */ i){
        // summary
        // Copy the contents of this queue into the passed array at index i.
        arr.splice(i,0,q);
       };
       this.dequeue=function(){
        // summary
        // shift the first element off the queue and return it
        var r=q.shift();
        this.count=q.length;
        return r; // object
       };
       this.enqueue=function(/* object */ o){
        // summary
        // put the passed object at the end of the queue
        this.count=q.push(o);
       };
       this.forEach=function(/* function */ fn, /* object? */ scope){
        // summary
        // functional iterator, following the mozilla spec.
        dojo.forEach(q, fn, scope);
       };
       this.getIterator=function(){
        // summary
        // get an Iterator based on this queue.
        return new dojox.collections.Iterator(q); // dojox.collections.Iterator
       };
       this.peek=function(){
        // summary
        // get the next element in the queue without altering the queue.
        return q[0];
    • returns
      dojox.collections.Queue|bool|object|dojox.collections.Iterator
    • summary
  • dojox.collections.Queue.toArray

    • type
      Function
    • source: [view]
      dojo.provide("dojox.collections.Queue");
      dojo.require("dojox.collections._base");


      dojox.collections.Queue=function(/* array? */arr){
       // summary
       // return an object of type dojox.collections.Queue
       var q=[];
       if (arr){
        q=q.concat(arr);
       }
       this.count=q.length;
       this.clear=function(){
        // summary
        // clears the internal collection
        q=[];
        this.count=q.length;
       };
       this.clone=function(){
        // summary
        // creates a new Queue based on this one
        return new dojox.collections.Queue(q); // dojox.collections.Queue
       };
       this.contains=function(/* object */ o){
        // summary
        // Check to see if the passed object is an element in this queue
        for(var i=0; i   if (q[i]==o){
          return true; // bool
         }
        }
        return false; // bool
       };
       this.copyTo=function(/* array */ arr, /* int */ i){
        // summary
        // Copy the contents of this queue into the passed array at index i.
        arr.splice(i,0,q);
       };
       this.dequeue=function(){
        // summary
        // shift the first element off the queue and return it
        var r=q.shift();
        this.count=q.length;
        return r; // object
       };
       this.enqueue=function(/* object */ o){
        // summary
        // put the passed object at the end of the queue
        this.count=q.push(o);
       };
       this.forEach=function(/* function */ fn, /* object? */ scope){
        // summary
        // functional iterator, following the mozilla spec.
        dojo.forEach(q, fn, scope);
       };
       this.getIterator=function(){
        // summary
        // get an Iterator based on this queue.
        return new dojox.collections.Iterator(q); // dojox.collections.Iterator
       };
       this.peek=function(){
        // summary
        // get the next element in the queue without altering the queue.
        return q[0];
       };
       this.toArray=function(){
        // summary
        // return an array based on the internal array of the queue.
        return [].concat(q);
    • returns
      dojox.collections.Queue|bool|object|dojox.collections.Iterator
    • summary
  • dojox.collections

    • type
      Object
    • summary
  • dojox

    • type
      Object
    • summary