+Show TOC
×Hide TOC

RemovableEventDispatcher

Kind of class:	public class
Package:	org.casalib.events
Inherits from:	EventDispatcher
Implements:	IDestroyable IRemovableEventDispatcher
Known subclasses:	EnterFrame Inactivity Key Process
Version:	12/11/08
Author:	Aaron Clinger
Classpath:	org.casalib.events.RemovableEventDispatcher
File last modified:	Thursday, 19 February 2009, 11:33:36

► View source

▼ Hide source

/*
    CASA Lib for ActionScript 3.0
    Copyright (c) 2009, 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.events {
    import flash.events.Event;
    import flash.events.EventDispatcher;
    import flash.events.IEventDispatcher;
    import org.casalib.events.IRemovableEventDispatcher;
    import org.casalib.events.ListenerManager;
    import org.casalib.core.IDestroyable;
    
    
    /**
        Extends <code>EventDispatcher</code> to allow for simple and quick removal of event listeners.
        
        @author Aaron Clinger
        @version 12/11/08
    */
    public class RemovableEventDispatcher extends EventDispatcher implements IRemovableEventDispatcher, IDestroyable {
        protected var _listenerManager:ListenerManager;
        protected var _isDestroyed:Boolean;
        
        
        /**
            Creates a new RemovableEventDispatcher.
            
            @param target: The target object for events dispatched to the EventDispatcher object.
        */
        public function RemovableEventDispatcher(target:IEventDispatcher = null) {
            super(target);
            
            this._listenerManager = ListenerManager.getManager(this);
        }
        
        /**
            @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 get destroyed():Boolean {
            return this._isDestroyed;
        }
        
        public function destroy():void {
            this.removeEventListeners();
            this._listenerManager.destroy();
            
            this._isDestroyed = true;
        }
    }
}

Extends EventDispatcher to allow for simple and quick removal of event listeners.

Summary

Constructor

RemovableEventDispatcher (target:IEventDispatcher = null)
- Creates a new RemovableEventDispatcher.

Instance properties

destroyed : Boolean

Instance methods

removeEventsForType (type:String) : void
- Removes all events of a specific type.
removeEventsForListener (listener:Function) : void
- Removes all events that report to the specified listener.
removeEventListeners : void
- Removes all event listeners.
destroy : void
- Removes any event listeners and stops all internal processes to help allow for prompt garbage collection.

Constructor

RemovableEventDispatcher

public function RemovableEventDispatcher (

target:IEventDispatcher = null)

Creates a new RemovableEventDispatcher.

Parameters:

target:

The target object for events dispatched to the EventDispatcher object.

Instance properties

destroyed

public destroyed:Boolean

(read)

Instance methods

destroy

public function destroy (

) : void

Removes any event listeners and stops all internal processes to help allow for prompt garbage collection.

Always call EventDispatcher before deleting last object pointer.

Specified by: