1 /**
  2  * The Render Engine
  3  * OneShotTimeout
  4  *
  5  * @fileoverview A single interval timeout timer which self-destroys.
  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.OneShotTimeout",
 36     "requires":[
 37         "R.lang.Timeout"
 38     ]
 39 });
 40 
 41 /**
 42  * @class An extension of {@link R.lang.Timeout} which is a one-shot timer that cannot
 43  *        be restarted and will self-destroy after it completes its interval.  Within
 44  *        the callback, <tt>this</tt> refers to the <tt>Timer</tt> object itself.
 45  *
 46  * @param name {String} The name of the timer
 47  * @param interval {Number} The interval for the timer, in milliseconds
 48  * @param callback {Function} The function to call when the interval is reached
 49  * @constructor
 50  * @extends R.lang.Timeout
 51  * @description Create a one-shot timeout
 52  */
 53 R.lang.OneShotTimeout = function () {
 54     "use strict";
 55     return R.lang.Timeout.extend(/** @scope R.lang.OneShotTimeout.prototype */{
 56 
 57         /**
 58          * @private
 59          */
 60         constructor:function (name, interval, callback) {
 61 
 62             var timerObj = {
 63                 callback:callback,
 64                 timer:this
 65             };
 66 
 67             var cb = R.bind(timerObj, function () {
 68                 this.callback.call(this.timer);
 69                 this.timer.destroy();
 70             });
 71 
 72             this.base(name, interval, cb);
 73         },
 74 
 75         /**
 76          * This timer cannot be restarted.
 77          * @private
 78          */
 79         restart:function () {
 80             if (!this.paused && this.running) {
 81                 return;
 82             }
 83 
 84             this.base();
 85         }
 86     }, /** @scope R.lang.OneShotTimeout.prototype */ {
 87 
 88         /**
 89          * Get the class name of this object
 90          * @return {String} "R.lang.OneShotTimeout"
 91          */
 92         getClassName:function () {
 93             return "R.lang.OneShotTimeout";
 94         }
 95     });
 96 
 97 };