CasaMovieClip

Kind of class: public class
Package:
Inherits from:
  • MovieClip
Implements:
Known subclasses:
Classpath: org.casalib.display.CasaMovieClip
File last modified: Monday, 10 October 2011, 16:40:40
► View source▼ Hide source
?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
/*
    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.display {
    import flash.display.MovieClip;
    import flash.display.Stage;
    import flash.events.Event;
    import org.casalib.events.IRemovableEventDispatcher;
    import org.casalib.events.ListenerManager;
    import org.casalib.core.IDestroyable;
    import org.casalib.util.StageReference;
    import org.casalib.util.DisplayObjectUtil;
     
     
    /**
        A base MovieClip that implements {@link IRemovableEventDispatcher} and {@link ICasaDisplayObjectContainer}.
         
        @author Aaron Clinger
        @author Mike Creighton
        @version 10/09/11
    */
    dynamic public class CasaMovieClip extends MovieClip implements IRemovableEventDispatcher, IDestroyable {
        protected var _listenerManager:ListenerManager;
        protected var _isDestroyed:Boolean;
         
         
        /**
            Creates a new <code>CasaMovieClip</code>.
        */
        public function CasaMovieClip() {
            super();
             
            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;
        }
         
        /**
            Returns the current children of the <code>CasaMovieClip</code> as an <code>Array</code>.
             
            @usageNote The <code>Array</code> is created dynamically when requested. It is best practice to store the result until no longer needed.
        */
        public function get children():Array {
            return DisplayObjectUtil.getChildren(this);
        }
         
        /**
            Removes and optionally destroys children of the <code>CasaMovieClip</code>.
             
            @param destroyChildren: If a child 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 children's children (all the way down the display list) <code>true</code>, or leave the children's children <code>false</code>; defaults to <code>false</code>.
        */
        public function removeAllChildren(destroyChildren:Boolean = false, recursive:Boolean = false):void {
            DisplayObjectUtil.removeAllChildren(this, destroyChildren, recursive);
        }
         
        /**
            Removes and optionally destroys children of the <code>CasaMovieClip</code> then destroys itself.
             
            @param destroyChildren: If a child 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 children's children (all the way down the display list) <code>true</code>, or leave the children's children <code>false</code>; defaults to <code>false</code>.
        */
        public function removeAllChildrenAndDestroy(destroyChildren:Boolean = false, recursive:Boolean = false):void {
            this.removeAllChildren(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.removeEventListeners();
            this._listenerManager.destroy();
             
            this.stop();
             
            this._isDestroyed = true;
             
            if (this.parent != null)
                this.parent.removeChild(this);
        }
    }
}

Summary

Constructor
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.
  • children : Array
    • Returns the current children of the CasaMovieClip as an Array.
  • destroyed : Boolean
Instance methods

Constructor

CasaMovieClip

function CasaMovieClip()

Creates a new CasaMovieClip.

Instance properties

children

children:Array(read)

Returns the current children of the CasaMovieClip as an Array.

Usage note
  • The Array is created dynamically when requested. It is best practice to store the result until no longer needed.

destroyed

destroyed:Boolean(read)

Determines if the object has been destroyed , or is still available for use . →

stage

override 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.

Overrides
  • MovieClip.stage

Instance methods

destroy

function destroy() : void

Removes any event listeners and stops all internal processes to help allow for prompt garbage collection. Always call destroy() before deleting last object pointer. →
Calling destroy() on a CASA display object also removes it from its current parent.

getTotalEventListeners

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 for all events. →
Returns
  • The number of listeners. →

removeAllChildren

function removeAllChildren(destroyChildren:Boolean = false, recursive:Boolean = false) : void

Removes and optionally destroys children of the CasaMovieClip.

Parameters
destroyChildren:If a child 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 children's children (all the way down the display list) true, or leave the children's children false; defaults to false.

removeAllChildrenAndDestroy

function removeAllChildrenAndDestroy(destroyChildren:Boolean = false, recursive:Boolean = false) : void

Removes and optionally destroys children of the CasaMovieClip then destroys itself.

Parameters
destroyChildren:If a child 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 children's children (all the way down the display list) true, or leave the children's children false; defaults to false.

removeEventListeners

function removeEventListeners() : void

Removes all event listeners. →

removeEventsForListener

function removeEventsForListener(listener:Function) : void

Removes all events that report to the specified listener. →

Parameters
listener:
The listener function that processes the event. →

removeEventsForType

function removeEventsForType(type:String) : void

Removes all events of a specific type. →

Parameters
type:
The type of event. →