1 /**
  2  * The Render Engine
  3  * Timeout
  4  *
  5  * @fileoverview A single interval timeout timer.
  6  *
  7  * @author: Brett Fattori (brettf@renderengine.com)
  8  * @author: $Author: bfattori $
  9  * @version: $Revision: 1555 $
 10  *
 11  * Copyright (c) 2011 Brett Fattori (brettf@renderengine.com)
 12  *
 13  * Permission is hereby granted, free of charge, to any person obtaining a copy
 14  * of this software and associated documentation files (the "Software"), to deal
 15  * in the Software without restriction, including without limitation the rights
 16  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 17  * copies of the Software, and to permit persons to whom the Software is
 18  * furnished to do so, subject to the following conditions:
 19  *
 20  * The above copyright notice and this permission notice shall be included in
 21  * all copies or substantial portions of the Software.
 22  *
 23  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 24  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 25  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 26  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 27  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 28  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 29  * THE SOFTWARE.
 30  *
 31  */
 32 
 33 // The class this file defines and its required classes
 34 R.Engine.define({
 35     "class":"R.lang.Timeout",
 36     "requires":[
 37         "R.lang.AbstractTimer"
 38     ]
 39 });
 40 
 41 /**
 42  * @class An extension of {@link R.lang.AbstractTimer} that wraps the <tt>window.setTimeout</tt> method.
 43  *
 44  * @param name {String} The name of the timer
 45  * @param interval {Number} The interval for the timer, in milliseconds
 46  * @param callback {Function} The function to call when the interval is reached
 47  * @extends R.lang.AbstractTimer
 48  * @constructor
 49  * @description Create a timeout timer
 50  */
 51 R.lang.Timeout = function () {
 52     "use strict";
 53     return R.lang.AbstractTimer.extend(/** @scope R.lang.Timeout.prototype */{
 54 
 55         /**
 56          * Cancel this timeout timer.
 57          */
 58         cancel:function () {
 59             R.global.clearTimeout(this.getTimer());
 60             this.base();
 61         },
 62 
 63         /**
 64          * Cancel and destroy the timeout
 65          */
 66         destroy:function () {
 67             this.cancel();
 68             this.base();
 69         },
 70 
 71         /**
 72          * Restart this timeout timer
 73          */
 74         restart:function () {
 75             this.setTimer(R.global.setTimeout(this.getCallback(), this.getInterval()));
 76         }
 77     }, /** @scope R.lang.Timeout.prototype */ {
 78         /**
 79          * Get the class name of this object
 80          * @return {String} "R.lang.Timeout"
 81          */
 82         getClassName:function () {
 83             return "R.lang.Timeout";
 84         }
 85     });
 86 
 87 }