+Show TOC
×Hide TOC

CasaSimpleButton

Kind of class:	public class
Package:	org.casalib.display
Inherits from:	SimpleButton
Implements:	IDestroyable IRemovableEventDispatcher
Version:	02/11/10
Author:	Aaron Clinger
Classpath:	org.casalib.display.CasaSimpleButton
File last modified:	Sunday, 28 March 2010, 11:55:55

► View source

▼ Hide source

/*
    CASA Lib for ActionScript 3.0
    Copyright (c) 2010, 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.display {
    import flash.display.SimpleButton;
    import flash.display.Stage;
    import flash.events.Event;
    import org.casalib.core.IDestroyable;
    import org.casalib.events.IRemovableEventDispatcher;
    import org.casalib.events.ListenerManager;
    import org.casalib.util.StageReference;
    import flash.display.DisplayObject;
    import org.casalib.util.DisplayObjectUtil;
    
    
    /**
        A base SimpleButton that implements {@link IRemovableEventDispatcher} and {@link IDestroyable}.
        
        @author Aaron Clinger
        @version 02/11/10
    */
    public class CasaSimpleButton extends SimpleButton implements IRemovableEventDispatcher, IDestroyable {
        protected var _listenerManager:ListenerManager;
        protected var _isDestroyed:Boolean;
        
        
        /**
            Creates a new CasaSimpleButton.
            
            @param upState: The initial value for the SimpleButton up state.
            @param overState: The initial value for the SimpleButton over state.
            @param downState: The initial value for the SimpleButton down state.
            @param hitTestState: The initial value for the SimpleButton hitTest state.
        */
        public function CasaSimpleButton(upState:DisplayObject = null, overState:DisplayObject = null, downState:DisplayObject = null, hitTestState:DisplayObject = null) {
            super(upState, overState, downState, hitTestState);
            
            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 getTotalEventListeners(type:String = null):uint {
            return this._listenerManager.getTotalEventListeners(type);
        }
        
        /**
            The Stage of the display object or if the display object is not added to the display list and {@link StageReference} is defined <code>stage</code> will return the {@link StageReference#STAGE_DEFAULT default stage}; otherwise <code>null</code>.
        */
        override public function get stage():Stage {
            if (super.stage == null) {
                try {
                    return StageReference.getStage();
                } catch (e:Error) {}
            }
            
            return super.stage;
        }
        
        /**
            Removes and optionally destroys the button states of the CasaSprite.
            
            @param destroyChildren: If the button state implements {@link IDestroyable} call its {@link IDestroyable#destroy destroy} method <code>true</code>, or don't destroy <code>false</code>; defaults to <code>false</code>.
            @param recursive: Call this method with the same arguments on all of the button state's children (all the way down the display list) <code>true</code>, or leave the button state's children <code>false</code>; defaults to <code>false</code>.
        */
        public function removeChildren(destroyChildren:Boolean = false, recursive:Boolean = false):void {
            DisplayObjectUtil.removeChildren(this, destroyChildren, recursive);
        }
        
        /**
            Removes and optionally destroys the button states of the CasaSprite then destroys itself.
            
            @param destroyChildren: If the button state implements {@link IDestroyable} call its {@link IDestroyable#destroy destroy} method <code>true</code>, or don't destroy <code>false</code>; defaults to <code>false</code>.
            @param recursive: Call this method with the same arguments on all of the button state's children (all the way down the display list) <code>true</code>, or leave the button state's children <code>false</code>; defaults to <code>false</code>.
        */
        public function removeChildrenAndDestroy(destroyChildren:Boolean = false, recursive:Boolean = false):void {
            this.removeChildren(destroyChildren, recursive);
            this.destroy();
        }
        
        public function get destroyed():Boolean {
            return this._isDestroyed;
        }
        
        /**
            {@inheritDoc}
            
            Calling <code>destroy()</code> on a CASA display object also removes it from its current parent.
        */
        public function destroy():void {
            this._listenerManager.destroy();
            
            this._isDestroyed = true;
            
            if (this.parent != null)
                this.parent.removeChild(this);
        }
    }
}

A base SimpleButton that implements IRemovableEventDispatcher and IDestroyable.

Summary

Constructor

CasaSimpleButton (upState:DisplayObject = null, overState:DisplayObject = null, downState:DisplayObject = null, hitTestState:DisplayObject = null)
- Creates a new CasaSimpleButton.

Instance properties

stage : Stage
- The Stage of the display object or if the display object is not added to the display list and StageReference is defined stage will return the default stage; otherwise null.
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.
getTotalEventListeners (type:String = null) : uint
- Reports the number of listeners for a specific event or the total listeners for all events.
removeChildren (destroyChildren:Boolean = false, recursive:Boolean = false) : void
- Removes and optionally destroys the button states of the CasaSprite.
removeChildrenAndDestroy (destroyChildren:Boolean = false, recursive:Boolean = false) : void
- Removes and optionally destroys the button states of the CasaSprite then destroys itself.
destroy : void
- Removes any event listeners and stops all internal processes to help allow for prompt garbage collection.

Constructor

CasaSimpleButton

public function CasaSimpleButton (

upState:DisplayObject = null, overState:DisplayObject = null, downState:DisplayObject = null, hitTestState:DisplayObject = null)

Creates a new CasaSimpleButton.

Parameters:

upState :

The initial value for the SimpleButton up state.

overState :

The initial value for the SimpleButton over state.

downState :

The initial value for the SimpleButton down state.

hitTestState:

The initial value for the SimpleButton hitTest state.

Instance properties

destroyed

public destroyed:Boolean

(read)

stage

override public stage:Stage

(read)

The Stage of the display object or if the display object is not added to the display list and StageReference is defined stage will return the default stage; otherwise null.

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 stage before deleting last object pointer.

#

Calling destroy() on a CASA display object also removes it from its current parent.

Specified by:

IDestroyable.destroy

getTotalEventListeners

public function getTotalEventListeners (

type:String = null) : uint

Reports the number of listeners for a specific event or the total listeners for all events.

Parameters:

type:

The name of event or stage for all events.

Returns:

The number of listeners.
#

Specified by:

IRemovableEventDispatcher.getTotalEventListeners

removeChildren

public function removeChildren (

destroyChildren:Boolean = false, recursive:Boolean = false) : void

Removes and optionally destroys the button states of the CasaSprite.

Parameters:

destroyChildren:

If the button state implements IDestroyable call its destroy method true, or don't destroy false; defaults to false.

recursive :

Call this method with the same arguments on all of the button state's children (all the way down the display list) true, or leave the button state's children false; defaults to false.

removeChildrenAndDestroy

public function removeChildrenAndDestroy (

destroyChildren:Boolean = false, recursive:Boolean = false) : void

Removes and optionally destroys the button states of the CasaSprite then destroys itself.

Parameters:

destroyChildren:

If the button state implements IDestroyable call its destroy method true, or don't destroy false; defaults to false.

recursive :

Call this method with the same arguments on all of the button state's children (all the way down the display list) true, or leave the button state's children false; defaults to false.

removeEventListeners

public function removeEventListeners (

) : void

Removes all event listeners.

Specified by:

IRemovableEventDispatcher.removeEventListeners

removeEventsForListener

public function removeEventsForListener (

listener:Function) : void

Removes all events that report to the specified listener.

Parameters:

listener:

The listener function that processes the event.

Specified by:

IRemovableEventDispatcher.removeEventsForListener

removeEventsForType

public function removeEventsForType (

type:String) : void

Removes all events of a specific type.

Parameters:

type:

The type of event.

Specified by:

IRemovableEventDispatcher.removeEventsForType