1 /**
  2  * The Render Engine
  3  * IntervalTimer
  4  *
  5  * @fileoverview An interval timer which repeats until destroyed.
  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.IntervalTimer",
 36     "requires":[
 37         "R.lang.AbstractTimer"
 38     ]
 39 });
 40 
 41 /**
 42  * @class An extension of {@link R.lang.AbstractTimer} that wraps the <tt>window.setInterval</tt> method.
 43  * @param name {String} The name of the timer
 44  * @param interval {Number} The interval for the timer, in milliseconds
 45  * @param callback {Function} The function to call when the interval is reached
 46  * @extends R.lang.AbstractTimer
 47  * @constructor
 48  * @description Create an interval timer
 49  */
 50 R.lang.IntervalTimer = function () {
 51     "use strict";
 52     return R.lang.AbstractTimer.extend(/** @scope R.lang.IntervalTimer.prototype */{
 53 
 54         /**
 55          * Cancel this interval timer.
 56          */
 57         cancel:function () {
 58             R.global.clearInterval(this.getTimer());
 59             this.base();
 60         },
 61 
 62         /**
 63          * Cancel and destroy the interval timer.
 64          */
 65         destroy:function () {
 66             this.cancel();
 67             this.base();
 68         },
 69 
 70         /**
 71          * Restart this interval timer.
 72          */
 73         restart:function () {
 74             this.setTimer(R.global.setInterval(this.getCallback(), this.getInterval()));
 75         }
 76     }, /** @scope R.lang.IntervalTimer.prototype */ {
 77 
 78         /**
 79          * Get the class name of this object
 80          * @return {String} "R.lang.IntervalTimer"
 81          */
 82         getClassName:function () {
 83             return "R.lang.IntervalTimer";
 84         }
 85     });
 86 
 87 }