/doc/temple/core/CoreMovieClip.html
HTML | 176 lines | 129 code | 39 blank | 8 comment | 0 complexity | 193d937c2f71359f3a80b4ee1ceb5f66 MD5 | raw file
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><link rel="stylesheet" href="../../style.css" type="text/css" media="screen"><link rel="stylesheet" href="../../print.css" type="text/css" media="print"><link rel="stylesheet" href="../../override.css" type="text/css"><meta name="keywords" content="CoreMovieClip,temple.core.CoreMovieClip,_destructOnError,_destructOnError,_isLoaded,_isLoaded,_isLoaded,_isLoading,_isLoading,_isLoading,_logErrors,_logErrors,_logErrors,_preloadableBehavior,_preloadableBehavior,_preloadableBehavior,_url,autoAlpha,autoAlpha,autoAlpha,autoAlpha,autoAlpha,autoAlpha,bytesLoaded,bytesTotal,destructOnError,destructOnError,disposeBitmapDataOnDestruct,eventListenerManager,eventListenerManager,eventListenerManager,eventListenerManager,eventListenerManager,eventListenerManager,eventListenerManager,eventListenerManager,eventListenerManager,eventListenerManager,hasParent,hasParent,hasParent,hasParent,hasParent,hasParent,height,height,height,height,height,isDestructed,isDestructed,isDestructed,isDestructed,isDestructed,isDestructed,isDestructed,isDestructed,isDestructed,isDestructed,isDestructed,logErrors,logErrors,logErrors,logErrors,logErrors,onStage,onStage,onStage,onStage,onStage,onStage,position,position,position,position,position,position,preloader,preloader,preloader,preloader,registryId,registryId,registryId,registryId,registryId,registryId,registryId,registryId,registryId,registryId,registryId,registryId,scale,scale,scale,scale,scale,scale,stage,stage,stage,stage,stage,url,url,url,url,url,width,width,width,width,width,addEventListener,addEventListener,addEventListener,addEventListener,addEventListener,addEventListener,addEventListener,addEventListener,addEventListener,addEventListener,checkParent,checkParent,checkParent,checkParent,close,close,destruct,destruct,destruct,destruct,destruct,destruct,destruct,destruct,destruct,destruct,destruct,dispatchEvent,dispatchEvent,dispatchEvent,dispatchEvent,dispatchEvent,dispatchEvent,dispatchEvent,dispatchEvent,dispatchEvent,handleAddedToStage,handleAddedToStage,handleAddedToStage,handleAddedToStage,handleAddedToStage,handleAdded,handleAdded,handleAdded,handleAdded,handleAdded,handleCoreUnload,handleCoreUnload,handleDestructedFrameDelay,handleDestructedFrameDelay,handleDestructedFrameDelay,handleDestructedFrameDelay,handleIOError,handleIOError,handleIOError,handleLoadComplete,handleLoadComplete,handleLoadComplete,handleLoadInit,handleLoadProgress,handleLoadProgress,handleLoadProgress,handleLoadStart,handleLoadStart,handleLoadStart,handleRemovedFromStage,handleRemovedFromStage,handleRemovedFromStage,handleRemovedFromStage,handleRemovedFromStage,handleRemoved,handleRemoved,handleRemoved,handleRemoved,handleRemoved,handleSecurityError,handleSecurityError,handleSecurityError,handleUnload,handleUnload,handleUnload,isLoaded,isLoaded,isLoaded,isLoaded,isLoading,isLoading,isLoading,isLoading,load,load,load,loadBytes,logDebug,logDebug,logDebug,logDebug,logDebug,logDebug,logDebug,logDebug,logDebug,logDebug,logDebug,logError,logError,logError,logError,logError,logError,logError,logError,logError,logError,logError,logFatal,logFatal,logFatal,logFatal,logFatal,logFatal,logFatal,logFatal,logFatal,logFatal,logFatal,logInfo,logInfo,logInfo,logInfo,logInfo,logInfo,logInfo,logInfo,logInfo,logInfo,logInfo,logStatus,logStatus,logStatus,logStatus,logStatus,logStatus,logStatus,logStatus,logStatus,logStatus,logStatus,logWarn,logWarn,logWarn,logWarn,logWarn,logWarn,logWarn,logWarn,logWarn,logWarn,logWarn,play,removeAllEventListeners,removeAllEventListeners,removeAllEventListeners,removeAllEventListeners,removeAllEventListeners,removeAllEventListeners,removeAllEventListeners,removeAllEventListeners,removeAllEventListeners,removeAllEventListeners,removeAllStrongEventListenersForListener,removeAllStrongEventListenersForListener,removeAllStrongEventListenersForListener,removeAllStrongEventListenersForListener,removeAllStrongEventListenersForListener,removeAllStrongEventListenersForListener,removeAllStrongEventListenersForListener,removeAllStrongEventListenersForListener,removeAllStrongEventListenersForListener,removeAllStrongEventListenersForListener,removeAllStrongEventListenersForType,removeAllStrongEventListenersForType,removeAllStrongEventListenersForType,removeAllStrongEventListenersForType,removeAllStrongEventListenersForType,removeAllStrongEventListenersForType,removeAllStrongEventListenersForType,removeAllStrongEventListenersForType,removeAllStrongEventListenersForType,removeAllStrongEventListenersForType,removeEventListener,removeEventListener,removeEventListener,removeEventListener,removeEventListener,removeEventListener,removeEventListener,removeEventListener,removeEventListener,removeEventListener,toString,toString,toString,toString,toString,toString,toString,toString,toString,toString,toString,unload"><title>temple.core.CoreMovieClip</title></head><body><script language="javascript" type="text/javascript" src="../../asdoc.js"></script><script language="javascript" type="text/javascript" src="../../help.js"></script><script language="javascript" type="text/javascript" src="../../cookies.js"></script><script language="javascript" type="text/javascript"><!--
- asdocTitle = 'CoreMovieClip - Temple API Documentation';
- var baseRef = '../../';
- window.onload = configPage;
- --></script>
- <script type="text/javascript">
- scrollToNameAnchor();
- </script><table class="titleTable" cellpadding="0" cellspacing="0" id="titleTable" style="display:none"><tr><td class="titleTableTitle" align="left">Temple API Documentation</td><td class="titleTableTopNav" align="right"><a href="../../package-summary.html" onclick="loadClassListFrame('../../all-classes.html')">All Packages</a> | <a href="../../class-summary.html" onclick="loadClassListFrame('../../all-classes.html')">All Classes</a> | <a href="../../all-index-A.html" onclick="loadClassListFrame('../../index-list.html')">Index</a> | <a id="framesLink1" href="../../index.html?temple/core/CoreMovieClip.html&temple/core/class-list.html">Frames</a><a id="noFramesLink1" style="display:none" href="" onclick="parent.location=document.location"> No Frames </a></td><td class="titleTableLogo" align="right" rowspan="3"><img src="../../images/logo.jpg" class="logoImage" alt=" Adobe Logo " title=" Adobe Logo "></td></tr><tr class="titleTableRow2"><td class="titleTableSubTitle" id="subTitle" align="left">CoreMovieClip</td><td class="titleTableSubNav" id="subNav" align="right"><a href="#propertySummary">Properties</a> | <a href="#methodSummary">Methods</a> | <a href="#eventSummary">Events</a></td></tr><tr class="titleTableRow3"><td colspan="3"> </td></tr></table><script language="javascript" type="text/javascript" xml:space="preserve">
- <!--
-
- if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("CoreMovieClip"); titleBar_setSubNav(false,true,false,false,false,false,true,false,true,false,false ,false,false,false,false,false);}
- -->
- </script><div xmlns:fn="http://www.w3.org/2005/xpath-functions" class="MainContent"><table class="classHeaderTable" cellpadding="0" cellspacing="0"><tr><td class="classHeaderTableLabel">Package</td><td><a href="package-detail.html" onclick="javascript:loadClassListFrame('class-list.html')">temple.core</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public class CoreMovieClip</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">CoreMovieClip <img src="../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> flash.display.MovieClip</td></tr><tr><td class="classHeaderTableLabel">Implements</td><td> <a href="../../temple/core/ICoreDisplayObject.html">ICoreDisplayObject</a></td></tr></table><p></p><p></p>
- Base class for all MovieClips in the Temple. The CoreMovieClip handles some core features of the Temple:
- <ul>
- <li>Registration to the Registry class.</li>
- <li>Global reference to the stage trough the StageProvider.</li>
- <li>Corrects a timeline bug in Flash (see <a href="http://www.tyz.nl/2009/06/23/weird-parent-thing-bug-in-flash/" target="external">http://www.tyz.nl/2009/06/23/weird-parent-thing-bug-in-flash/</a>).</li>
- <li>Event dispatch optimization.</li>
- <li>Easy remove of all EventListeners.</li>
- <li>Wrapper for Log class for easy logging.</li>
- <li>Completely destructable.</li>
- <li>Automatic removes and destruct children, grant-children etc. on destruction.</li>
- <li>Tracked in Memory (of this feature is enabled).</li>
- <li>Some usefull extra properties like autoAlpha, position and scale.</li>
- </ul>
-
- <p>You should always use and/or extend the CoreMovieClip instead of MovieClip if you want to make use of the Temple features.</p>
-
- <p></p><p><span class="classHeaderTableLabel">See also</span></p><div class="seeAlso"><a href="../../temple/Temple.html#registerObjectsInMemory()" target="">temple.Temple.registerObjectsInMemory()</a></div><br/><hr></div><a name="propertySummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Properties</div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableProperty"><tr><th> </th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#autoAlpha" class="signatureLink">autoAlpha</a> : Number<div class="summaryTableDescription">
-
- Same as alpha, but the visible property will automaticly be set.</div></td><td class="summaryTableOwnerCol">CoreMovieClip</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#eventListenerManager" class="signatureLink">eventListenerManager</a> : <a href="../../temple/destruction/EventListenerManager.html">EventListenerManager</a><div class="summaryTableDescription">[read-only]
-
- Returns a reference to the EventListenerManager of the IDestructableEventDispatcher
- </div></td><td class="summaryTableOwnerCol">CoreMovieClip</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#hasParent" class="signatureLink">hasParent</a> : Boolean<div class="summaryTableDescription">[read-only]
-
- Returns true if this object has a parent.</div></td><td class="summaryTableOwnerCol">CoreMovieClip</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#height" class="signatureLink">height</a> : Number<div class="summaryTableDescription">[override]
- </div></td><td class="summaryTableOwnerCol">CoreMovieClip</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#isDestructed" class="signatureLink">isDestructed</a> : Boolean<div class="summaryTableDescription">[read-only]
-
- If an object is destructed, this property is set to true.</div></td><td class="summaryTableOwnerCol">CoreMovieClip</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#onStage" class="signatureLink">onStage</a> : Boolean<div class="summaryTableDescription">[read-only]
-
- Returns true if this object is on the Stage, false if not.</div></td><td class="summaryTableOwnerCol">CoreMovieClip</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#position" class="signatureLink">position</a> : Point<div class="summaryTableDescription">
-
- Get or set to position of the object as a Point.</div></td><td class="summaryTableOwnerCol">CoreMovieClip</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#registryId" class="signatureLink">registryId</a> : uint<div class="summaryTableDescription">[read-only]
-
- The unique identifier of the object.</div></td><td class="summaryTableOwnerCol">CoreMovieClip</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#scale" class="signatureLink">scale</a> : Number<div class="summaryTableDescription">
-
- Get and set scaleX and scaleY in one property.</div></td><td class="summaryTableOwnerCol">CoreMovieClip</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#stage" class="signatureLink">stage</a> : Stage<div class="summaryTableDescription">[override] [read-only]
- </div></td><td class="summaryTableOwnerCol">CoreMovieClip</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#width" class="signatureLink">width</a> : Number<div class="summaryTableDescription">[override]
- </div></td><td class="summaryTableOwnerCol">CoreMovieClip</td></tr></table></div><a name="methodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Methods </div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableMethod"><tr><th> </th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#CoreMovieClip()" class="signatureLink">CoreMovieClip</a>()</div><div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol">CoreMovieClip</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#addEventListener()" class="signatureLink">addEventListener</a>(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void</div><div class="summaryTableDescription">[override]
- </div></td><td class="summaryTableOwnerCol">CoreMovieClip</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#destruct()" class="signatureLink">destruct</a>():void</div><div class="summaryTableDescription">
-
- Destroys the objects, all intern listeners will be removed.</div></td><td class="summaryTableOwnerCol">CoreMovieClip</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#dispatchEvent()" class="signatureLink">dispatchEvent</a>(event:Event):Boolean</div><div class="summaryTableDescription">[override]
- </div></td><td class="summaryTableOwnerCol">CoreMovieClip</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#removeAllEventListeners()" class="signatureLink">removeAllEventListeners</a>():void</div><div class="summaryTableDescription">
-
- Removes all strong (non weak) EventListeners.</div></td><td class="summaryTableOwnerCol">CoreMovieClip</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#removeAllStrongEventListenersForListener()" class="signatureLink">removeAllStrongEventListenersForListener</a>(listener:Function):void</div><div class="summaryTableDescription">
-
- Removes all strong (non weak) EventListeners that are handled by a specified listener.</div></td><td class="summaryTableOwnerCol">CoreMovieClip</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#removeAllStrongEventListenersForType()" class="signatureLink">removeAllStrongEventListenersForType</a>(type:String):void</div><div class="summaryTableDescription">
-
- Removes all strong (non-weak) EventListeners of a specific type.</div></td><td class="summaryTableOwnerCol">CoreMovieClip</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#removeEventListener()" class="signatureLink">removeEventListener</a>(type:String, listener:Function, useCapture:Boolean = false):void</div><div class="summaryTableDescription">[override]
- </div></td><td class="summaryTableOwnerCol">CoreMovieClip</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#toString()" class="signatureLink">toString</a>():String</div><div class="summaryTableDescription">[override]
- </div></td><td class="summaryTableOwnerCol">CoreMovieClip</td></tr></table></div><a name="protectedMethodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Protected Methods </div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableProtectedMethod"><tr><th> </th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#logDebug()" class="signatureLink">logDebug</a>(data:*):void</div><div class="summaryTableDescription">
- Does a Log.debug, but has already filled in some known data
- </div></td><td class="summaryTableOwnerCol">CoreMovieClip</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#logError()" class="signatureLink">logError</a>(data:*):void</div><div class="summaryTableDescription">
- Does a Log.error, but has already filled in some known data
- </div></td><td class="summaryTableOwnerCol">CoreMovieClip</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#logFatal()" class="signatureLink">logFatal</a>(data:*):void</div><div class="summaryTableDescription">
- Does a Log.fatal, but has already filled in some known data
- </div></td><td class="summaryTableOwnerCol">CoreMovieClip</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#logInfo()" class="signatureLink">logInfo</a>(data:*):void</div><div class="summaryTableDescription">
- Does a Log.info, but has already filled in some known data
- </div></td><td class="summaryTableOwnerCol">CoreMovieClip</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#logStatus()" class="signatureLink">logStatus</a>(data:*):void</div><div class="summaryTableDescription">
- Does a Log.status, but has already filled in some known data
- </div></td><td class="summaryTableOwnerCol">CoreMovieClip</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#logWarn()" class="signatureLink">logWarn</a>(data:*):void</div><div class="summaryTableDescription">
- Does a Log.warn, but has already filled in some known data
- </div></td><td class="summaryTableOwnerCol">CoreMovieClip</td></tr></table></div><a name="eventSummary"></a><div class="summarySection"><div class="summaryTableTitle">Events</div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableEvent"><tr><th> </th><th colspan="2">Event</th><th> Summary </th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:DestructEvent.destruct" class="signatureLink">DestructEvent.destruct</a></div></td><td class="summaryTableDescription summaryTableCol">
- Dispatched just before the object is destructed.</td><td class="summaryTableOwnerCol">CoreMovieClip</td></tr></table></div><script language="javascript" type="text/javascript"><!--
- showHideInherited();
- --></script><div class="MainContent"><div class="detailSectionHeader">Property Detail</div><a name="propertyDetail"></a><a name="autoAlpha"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">autoAlpha</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>autoAlpha:Number</code><p></p><p>
-
- Same as alpha, but the visible property will automaticly be set.
-
- <p>When value is 0 visible will be false, else visible will be true.
- If alpha > 0, but visible == false, then autoAlpha will return 0</p>
- </p><br/><span class="label"> Implementation </span><br/><code> public function get autoAlpha():Number</code><br/><code> public function set autoAlpha(value:Number):void</code><br/></div><a name="propertyDetail"></a><a name="eventListenerManager"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">eventListenerManager</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>eventListenerManager:<a href="../../temple/destruction/EventListenerManager.html">EventListenerManager</a></code> [read-only] <p></p><p>
-
- Returns a reference to the EventListenerManager of the IDestructableEventDispatcher
- </p><br/><span class="label"> Implementation </span><br/><code> public function get eventListenerManager():<a href="../../temple/destruction/EventListenerManager.html">EventListenerManager</a></code><br/></div><a name="propertyDetail"></a><a name="hasParent"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">hasParent</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>hasParent:Boolean</code> [read-only] <p></p><p>
-
- Returns true if this object has a parent.
-
- <p>Needed since .parent can't be trusted for timeline objects.</p>
- </p><br/><span class="label"> Implementation </span><br/><code> public function get hasParent():Boolean</code><br/></div><a name="propertyDetail"></a><a name="height"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">height</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>height:Number</code>[override] <p></p><p>
- </p><br/><span class="label"> Implementation </span><br/><code> public function get height():Number</code><br/><code> public function set height(value:Number):void</code><br/></div><a name="propertyDetail"></a><a name="isDestructed"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">isDestructed</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>isDestructed:Boolean</code> [read-only] <p></p><p>
-
- If an object is destructed, this property is set to true.
-
- <p>After a garbage collection the object should be disappeared from Memory (if Temple.registerObjectsInMemory is set to true).
-
- If the object still exists, you should check your code.</p>
-
- </p><br/><span class="label"> Implementation </span><br/><code> public function get isDestructed():Boolean</code><br/></div><a name="propertyDetail"></a><a name="onStage"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">onStage</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>onStage:Boolean</code> [read-only] <p></p><p>
-
- Returns true if this object is on the Stage, false if not.
- <p>Needed since .stage can't be trusted for timeline objects.
-
- The stage property can be filled even when the ICoreDisplayObject is not on the stage. The ICoreDisplayObject gets the stage from the StageProvider</p>
- </p><br/><span class="label"> Implementation </span><br/><code> public function get onStage():Boolean</code><br/></div><a name="propertyDetail"></a><a name="position"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">position</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>position:Point</code><p></p><p>
-
- Get or set to position of the object as a Point. It is not possible to set x and/or y directy on the Point. Use x and/or y of the DisplayObject instead.
- </p><br/><span class="label"> Implementation </span><br/><code> public function get position():Point</code><br/><code> public function set position(value:Point):void</code><br/></div><a name="propertyDetail"></a><a name="registryId"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">registryId</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>registryId:uint</code> [read-only] <p></p><p>
-
- The unique identifier of the object. The id is generated and registered by the Registry class
- </p><br/><span class="label"> Implementation </span><br/><code> public function get registryId():uint</code><br/></div><a name="propertyDetail"></a><a name="scale"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">scale</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>scale:Number</code><p></p><p>
-
- Get and set scaleX and scaleY in one property. If scaleX is not the same as scaleY NaN is returned.
- </p><br/><span class="label"> Implementation </span><br/><code> public function get scale():Number</code><br/><code> public function set scale(value:Number):void</code><br/></div><a name="propertyDetail"></a><a name="stage"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">stage</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>stage:Stage</code> [read-only] [override] <p></p><p>
- </p><br/><span class="label"> Implementation </span><br/><code> public function get stage():Stage</code><br/></div><a name="propertyDetail"></a><a name="width"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">width</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>width:Number</code>[override] <p></p><p>
- </p><br/><span class="label"> Implementation </span><br/><code> public function get width():Number</code><br/><code> public function set width(value:Number):void</code><br/></div><a name="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="CoreMovieClip()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">CoreMovieClip</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function CoreMovieClip()</code><br/><br/></div><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="addEventListener()"></a><a name="addEventListener(String,Function,Boolean,int,Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">addEventListener</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code>override public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void</code><p></p><p>
- </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">type</span>:String</code></td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">listener</span>:Function</code></td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">useCapture</span>:Boolean</code> (default = <code>false</code>)<code></code></td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">priority</span>:int</code> (default = <code>0</code>)<code></code></td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">useWeakReference</span>:Boolean</code> (default = <code>false</code>)<code></code></td></tr></table></p></div><a name="checkParent()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">checkParent</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> temple function checkParent():void</code><p></p><p>
- Check objects parent, after being removed. If the object still has a parent, the object has been removed by a timeline animation.
- If an object is removed by a timeline animation, the object is not used anymore and can be destructed
- </p></div><a name="destruct()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">destruct</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function destruct():void</code><p></p><p>
-
- Destroys the objects, all intern listeners will be removed.
-
- <p>When overriding this method, always call super.destruct() at the end!</p>
-
- If you want the object to be available for garbage collection make sure you:
- <ul>
- <li>Remove all event listeners on this object (use removeAllEventListeners on Temple objects).</li>
- <li>Remove all event listeners from this object.</li>
- <li>Set all non-primitive variables to null.</li>
- <li>Set all references to this object to null in other objects.</li>
- </ul>
-
- When a Temple object is destructed a DestructEvent.DESTRUCT is dispatched from the object (if the object implements IDestructableEventDispatcher).
-
- <p>Note: Bear in mind that it is possible an object can be destructed more than once.</p>
-
- </p></div><a name="dispatchEvent()"></a><a name="dispatchEvent(flash.events.Event)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">dispatchEvent</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>override public function dispatchEvent(event:Event):Boolean</code><p></p><p>
- </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">event</span>:Event</code></td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Boolean</code></td></tr></table></div><a name="handleAdded()"></a><a name="handleAdded(flash.events.Event)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">handleAdded</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> temple function handleAdded(event:Event):void</code><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">event</span>:Event</code></td></tr></table></p></div><a name="handleAddedToStage()"></a><a name="handleAddedToStage(flash.events.Event)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">handleAddedToStage</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> temple function handleAddedToStage(event:Event):void</code><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">event</span>:Event</code></td></tr></table></p></div><a name="handleDestructedFrameDelay()"></a><a name="handleDestructedFrameDelay(flash.events.Event)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">handleDestructedFrameDelay</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> temple function handleDestructedFrameDelay(event:Event):void</code><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">event</span>:Event</code></td></tr></table></p></div><a name="handleRemoved()"></a><a name="handleRemoved(flash.events.Event)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">handleRemoved</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> temple function handleRemoved(event:Event):void</code><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">event</span>:Event</code></td></tr></table></p></div><a name="handleRemovedFromStage()"></a><a name="handleRemovedFromStage(flash.events.Event)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">handleRemovedFromStage</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> temple function handleRemovedFromStage(event:Event):void</code><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">event</span>:Event</code></td></tr></table></p></div><a name="handleUnload()"></a><a name="handleUnload(flash.events.Event)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">handleUnload</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> temple function handleUnload(event:Event):void</code><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">event</span>:Event</code></td></tr></table></p></div><a name="logDebug()"></a><a name="logDebug()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">logDebug</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected final function logDebug(data:*):void</code><p></p><p>
- Does a Log.debug, but has already filled in some known data
- </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">data</span>:*</code> — the data to be logged
- </td></tr></table></p></div><a name="logError()"></a><a name="logError()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">logError</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected final function logError(data:*):void</code><p></p><p>
- Does a Log.error, but has already filled in some known data
- </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">data</span>:*</code> — the data to be logged
- </td></tr></table></p></div><a name="logFatal()"></a><a name="logFatal()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">logFatal</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected final function logFatal(data:*):void</code><p></p><p>
- Does a Log.fatal, but has already filled in some known data
- </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">data</span>:*</code> — the data to be logged
- </td></tr></table></p></div><a name="logInfo()"></a><a name="logInfo()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">logInfo</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected final function logInfo(data:*):void</code><p></p><p>
- Does a Log.info, but has already filled in some known data
- </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">data</span>:*</code> — the data to be logged
- </td></tr></table></p></div><a name="logStatus()"></a><a name="logStatus()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">logStatus</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected final function logStatus(data:*):void</code><p></p><p>
- Does a Log.status, but has already filled in some known data
- </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">data</span>:*</code> — the data to be logged
- </td></tr></table></p></div><a name="logWarn()"></a><a name="logWarn()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">logWarn</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected final function logWarn(data:*):void</code><p></p><p>
- Does a Log.warn, but has already filled in some known data
- </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">data</span>:*</code> — the data to be logged
- </td></tr></table></p></div><a name="removeAllEventListeners()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">removeAllEventListeners</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function removeAllEventListeners():void</code><p></p><p>
-
- Removes all strong (non weak) EventListeners.
- </p></div><a name="removeAllStrongEventListenersForListener()"></a><a name="removeAllStrongEventListenersForListener(Function)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">removeAllStrongEventListenersForListener</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function removeAllStrongEventListenersForListener(listener:Function):void</code><p></p><p>
-
- Removes all strong (non weak) EventListeners that are handled by a specified listener.
-
- </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">listener</span>:Function</code> — The listener function that handles the event.
- </td></tr></table></p></div><a name="removeAllStrongEventListenersForType()"></a><a name="removeAllStrongEventListenersForType(String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">removeAllStrongEventListenersForType</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function removeAllStrongEventListenersForType(type:String):void</code><p></p><p>
-
- Removes all strong (non-weak) EventListeners of a specific type.
-
- </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">type</span>:String</code> — The type of event.
- </td></tr></table></p></div><a name="removeEventListener()"></a><a name="removeEventListener(String,Function,Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">removeEventListener</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>override public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void</code><p></p><p>
- </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">type</span>:String</code></td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">listener</span>:Function</code></td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">useCapture</span>:Boolean</code> (default = <code>false</code>)<code></code></td></tr></table></p></div><a name="toString()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">toString</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>override public function toString():String</code><p></p><p>
- </p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>String</code></td></tr></table></div><div class="detailSectionHeader"> Event Detail </div><a name="event:DestructEvent.destruct"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">DestructEvent.destruct</td><td class="detailHeaderType"> Event </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../temple/destruction/DestructEvent.html"><code>temple.destruction.DestructEvent</code></a><br/><span class="label">DestructEvent.type property = </span><a href="../../temple/destruction/DestructEvent.html#DESTRUCT"><code>temple.destruction.DestructEvent.DESTRUCT</code></a><br/><p></p><p>
- </p>
- Dispatched just before the object is destructed.
- </div><br/><br/><hr><br/><p></p><center class="copyright"><footer> </footer><br/> </center></div></body></html><!-- <br/> -->