Interval

/*
    CASA Lib for ActionScript 3.0
    Copyright (c) 2011, Aaron Clinger & Contributors of CASA Lib
    All rights reserved.
    
    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions are met:
    
    - Redistributions of source code must retain the above copyright notice,
      this list of conditions and the following disclaimer.
    
    - Redistributions in binary form must reproduce the above copyright notice,
      this list of conditions and the following disclaimer in the documentation
      and/or other materials provided with the distribution.
    
    - Neither the name of the CASA Lib nor the names of its contributors
      may be used to endorse or promote products derived from this software
      without specific prior written permission.
    
    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
    LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    POSSIBILITY OF SUCH DAMAGE.
*/
package org.casalib.time {
    import flash.events.Event;
    import flash.events.TimerEvent;
    import flash.utils.Timer;
    import org.casalib.control.IRunnable;
    import org.casalib.core.IDestroyable;
    import org.casalib.events.IRemovableEventDispatcher;
    import org.casalib.events.ListenerManager;
    
    /**
        To be used instead of flash.utils.setInterval and flash.utils.setTimeout functions.
        
        Advantages over setInterval/setTimeout:
        

            
Ability to stop and start intervals without redefining.
            
Change the time (delay), {@link Interval#callBack call back} and {@link Interval#arguments arguments} without redefining.
            
Included repeatCount for intervals that only need to fire finitely.
            
{@link Interval#setInterval} and {@link Interval#setTimeout} return an object instead of interval id for better OOP structure.
            
Built in events/event dispatcher.
        
        
        @author Aaron Clinger
        @author Mike Creighton
        @version 02/11/10
        @example
            
                package {
                    import org.casalib.display.CasaMovieClip;
                    import org.casalib.time.Interval;
                    
                    
                    public class MyExample extends CasaMovieClip {
                        protected var _interval:Interval;
                        
                        
                        public function MyExample() {
                            super();
                            
                            this._interval = Interval.setInterval(this._repeatingFunction, 1000, "CASA");
                            this._interval.repeatCount = 3;
                            this._interval.start();
                        }
                        
                        protected function _repeatingFunction(name:String):void {
                            trace(name);
                        }
                    }
                }
            
    */
    public class Interval extends Timer implements IDestroyable, IRemovableEventDispatcher, IRunnable {
        protected var _callBack:Function;
        protected var _arguments:Array;
        protected var _isDestroyed:Boolean;
        protected var _listenerManager:ListenerManager;
        
        
        /**
            Runs a function at a specified periodic interval.
            
            @param callBack: The function to execute after specified delay.
            @param delay: The time in milliseconds between calls.
            @param arguments: The arguments to be passed to the call back function when executed.
            @return: An {@link Interval} reference.
        */
        public static function setInterval(callBack:Function, delay:Number, ...arguments):Interval {
            return new Interval(delay, 0, callBack, arguments);
        }
        
        /**
            Runs a function at a specified periodic interval. Acts identically like {@link Interval#setInterval} except setTimeout defaults repeatCount to 1.
            
            @param callBack: The function to execute after specified delay.
            @param delay: The time in milliseconds between calls.
            @param arguments: The arguments to be passed to the call back function when executed.
            @return: An {@link Interval} reference.
        */
        public static function setTimeout(callBack:Function, delay:Number, ...arguments):Interval {
            return new Interval(delay, 1, callBack, arguments);
        }
        
        /**
            @exclude
        */
        public function Interval(delay:Number, repeatCount:int, callBack:Function, args:Array) {
            super(delay, repeatCount);
            
            this.callBack         = callBack;
            this.arguments        = args;
            this._listenerManager = ListenerManager.getManager(this);
            
            super.addEventListener(TimerEvent.TIMER, this._timerHandler, false, 0, true);
        }
        
        /**
            The function to execute after specified delay.
        */
        public function get callBack():Function {
            return this._callBack;
        }
        
        public function set callBack(cb:Function):void {
            this._callBack = cb;
        }
        
        /**
            The arguments to be passed to the call back function when executed.
        */
        public function get arguments():Array {
            return this._arguments;
        }
        
        public function set arguments(args:Array):void {
            this._arguments = args;
        }
        
        /**
            @exclude
        */
        override public function dispatchEvent(event:Event):Boolean {
            if (this.willTrigger(event.type))
                return super.dispatchEvent(event);
            
            return true;
        }
        
        /**
            @exclude
        */
        override public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void {
            super.addEventListener(type, listener, useCapture, priority, useWeakReference);
            this._listenerManager.addEventListener(type, listener, useCapture, priority, useWeakReference);
        }
        
        /**
            @exclude
        */
        override public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void {
            super.removeEventListener(type, listener, useCapture);
            this._listenerManager.removeEventListener(type, listener, useCapture);
        }
        
        public function removeEventsForType(type:String):void {
            this._listenerManager.removeEventsForType(type);
        }
        
        public function removeEventsForListener(listener:Function):void {
            this._listenerManager.removeEventsForListener(listener);
        }
        
        public function removeEventListeners():void {
            this._listenerManager.removeEventListeners();
        }
        
        public function getTotalEventListeners(type:String = null):uint {
            return this._listenerManager.getTotalEventListeners(type);
        }
        
        public function get destroyed():Boolean {
            return this._isDestroyed;
        }
        
        public function destroy():void {
            this.reset();
            
            this._listenerManager.destroy();
            
            super.removeEventListener(TimerEvent.TIMER, this._timerHandler);
            
            this._isDestroyed = true;
        }
        
        protected function _timerHandler(e:TimerEvent):void {
            this._callBack.apply(null, this._arguments);
        }
    }
}