PageRenderTime 56ms CodeModel.GetById 19ms RepoModel.GetById 0ms app.codeStats 0ms

/doc/temple/core/CoreTimer.html

http://github.com/MediaMonks/Temple
HTML | 133 lines | 98 code | 27 blank | 8 comment | 0 complexity | ae1bb8a5b7a4ad76f2555d11be1c5fb2 MD5 | raw file
    

  1. <!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="CoreTimer,temple.core.CoreTimer,_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.CoreTimer</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"><!--
    2. 

  2. 				asdocTitle = 'CoreTimer - Temple API Documentation';
    3. 

  3. 				var baseRef = '../../';
    4. 

  4. 				window.onload = configPage;
    5. 

  5. 			--></script>
    6. 

  6. <script type="text/javascript">
    7. 

  7. 			scrollToNameAnchor();
    8. 

  8. 		</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>&nbsp;|&nbsp;<a href="../../class-summary.html" onclick="loadClassListFrame('../../all-classes.html')">All Classes</a>&nbsp;|&nbsp;<a href="../../all-index-A.html" onclick="loadClassListFrame('../../index-list.html')">Index</a>&nbsp;|&nbsp;<a id="framesLink1" href="../../index.html?temple/core/CoreTimer.html&amp;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">CoreTimer</td><td class="titleTableSubNav" id="subNav" align="right"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a>&nbsp;| <a href="#eventSummary">Events</a></td></tr><tr class="titleTableRow3"><td colspan="3">&nbsp;</td></tr></table><script language="javascript" type="text/javascript" xml:space="preserve">
    9. 

  9. 				<!--
    10. 

  10. 				
    11. 

  11. 					if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("CoreTimer"); titleBar_setSubNav(false,true,false,false,false,false,true,false,true,false,false	,false,false,false,false,false);}	
    12. 

  12. 				-->
    13. 

  13. 			</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  CoreTimer</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">CoreTimer  <img src="../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> flash.utils.Timer</td></tr><tr><td class="classHeaderTableLabel">Implements</td><td> <a href="../../temple/destruction/IDestructableEventDispatcher.html">IDestructableEventDispatcher</a>,  <a href="../../temple/core/ICoreObject.html">ICoreObject</a></td></tr></table><p></p><p></p>
    14. 

  14. 	 Base class for all Timers in the Temple. The CoreTimer handles some core features of the Temple:
    15. 

  15. 	 <ul>
    16. 

  16. 	 	               <li>Registration to the Registry class.</li>
    17. 

  17. 	 	               <li>Event dispatch optimization.</li>
    18. 

  18. 	 	               <li>Easy remove of all EventListeners.</li>
    19. 

  19. 	 	               <li>Wrapper for Log class for easy logging.</li>
    20. 

  20. 	 	               <li>Completely destructable.</li>
    21. 

  21. 	 	               <li>Tracked in Memory (of this feature is enabled).</li>
    22. 

  22. 	              </ul>
    23. 

  23. 	 
    24. 

  24. 	              <p>Note: since the CoreTimer is not a DisplayObject, the CoreTimer will not be automatic destructed. So you should
    25. 

  25. 	 always destruct the CoreTimer manually.</p>
    26. 

  26. 	 
    27. 

  27. 	              <p>You should always use and/or extend the CoreTimer instead of Timer if you want to make use of the Temple features.</p>
    28. 

  28. 	 
    29. 

  29. 	           <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>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#eventListenerManager" class="signatureLink">eventListenerManager</a> : <a href="../../temple/destruction/EventListenerManager.html">EventListenerManager</a><div class="summaryTableDescription">[read-only] 
    30. 

  30. 		 
    31. 

  31. 		 Returns a reference to the EventListenerManager of the IDestructableEventDispatcher
    32. 

  32. 		 </div></td><td class="summaryTableOwnerCol">CoreTimer</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#isDestructed" class="signatureLink">isDestructed</a> : Boolean<div class="summaryTableDescription">[read-only] 
    33. 

  33. 		 
    34. 

  34. 		 If an object is destructed, this property is set to true.</div></td><td class="summaryTableOwnerCol">CoreTimer</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#registryId" class="signatureLink">registryId</a> : uint<div class="summaryTableDescription">[read-only] 
    35. 

  35. 		 
    36. 

  36. 		 The unique identifier of the object.</div></td><td class="summaryTableOwnerCol">CoreTimer</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>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#CoreTimer()" class="signatureLink">CoreTimer</a>(delay:Number, repeatCount:int = 0)</div><div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol">CoreTimer</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</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] 
    37. 

  37. 		 </div></td><td class="summaryTableOwnerCol">CoreTimer</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#destruct()" class="signatureLink">destruct</a>():void</div><div class="summaryTableDescription">
    38. 

  38. 		 
    39. 

  39. 		 Destroys the objects, all intern listeners will be removed.</div></td><td class="summaryTableOwnerCol">CoreTimer</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#dispatchEvent()" class="signatureLink">dispatchEvent</a>(event:Event):Boolean</div><div class="summaryTableDescription">[override] 
    40. 

  40. 		 </div></td><td class="summaryTableOwnerCol">CoreTimer</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#removeAllEventListeners()" class="signatureLink">removeAllEventListeners</a>():void</div><div class="summaryTableDescription">
    41. 

  41. 		 
    42. 

  42. 		 Removes all strong (non weak) EventListeners.</div></td><td class="summaryTableOwnerCol">CoreTimer</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#removeAllStrongEventListenersForListener()" class="signatureLink">removeAllStrongEventListenersForListener</a>(listener:Function):void</div><div class="summaryTableDescription">
    43. 

  43. 		 
    44. 

  44. 		 Removes all strong (non weak) EventListeners that are handled by a specified listener.</div></td><td class="summaryTableOwnerCol">CoreTimer</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#removeAllStrongEventListenersForType()" class="signatureLink">removeAllStrongEventListenersForType</a>(type:String):void</div><div class="summaryTableDescription">
    45. 

  45. 		 
    46. 

  46. 		 Removes all strong (non-weak) EventListeners of a specific type.</div></td><td class="summaryTableOwnerCol">CoreTimer</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</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] 
    47. 

  47. 		 </div></td><td class="summaryTableOwnerCol">CoreTimer</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#toString()" class="signatureLink">toString</a>():String</div><div class="summaryTableDescription">[override] 
    48. 

  48. 		 </div></td><td class="summaryTableOwnerCol">CoreTimer</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>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#logDebug()" class="signatureLink">logDebug</a>(data:*):void</div><div class="summaryTableDescription">
    49. 

  49. 		 Does a Log.debug, but has already filled in some known data
    50. 

  50. 		 </div></td><td class="summaryTableOwnerCol">CoreTimer</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#logError()" class="signatureLink">logError</a>(data:*):void</div><div class="summaryTableDescription">
    51. 

  51. 		 Does a Log.error, but has already filled in some known data
    52. 

  52. 		 </div></td><td class="summaryTableOwnerCol">CoreTimer</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#logFatal()" class="signatureLink">logFatal</a>(data:*):void</div><div class="summaryTableDescription">
    53. 

  53. 		 Does a Log.fatal, but has already filled in some known data
    54. 

  54. 		 </div></td><td class="summaryTableOwnerCol">CoreTimer</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#logInfo()" class="signatureLink">logInfo</a>(data:*):void</div><div class="summaryTableDescription">
    55. 

  55. 		 Does a Log.info, but has already filled in some known data
    56. 

  56. 		 </div></td><td class="summaryTableOwnerCol">CoreTimer</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#logStatus()" class="signatureLink">logStatus</a>(data:*):void</div><div class="summaryTableDescription">
    57. 

  57. 		 Does a Log.status, but has already filled in some known data
    58. 

  58. 		 </div></td><td class="summaryTableOwnerCol">CoreTimer</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#logWarn()" class="signatureLink">logWarn</a>(data:*):void</div><div class="summaryTableDescription">
    59. 

  59. 		 Does a Log.warn, but has already filled in some known data
    60. 

  60. 		 </div></td><td class="summaryTableOwnerCol">CoreTimer</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>&nbsp;</th><th colspan="2">Event</th><th> Summary </th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:DestructEvent.destruct" class="signatureLink">DestructEvent.destruct</a></div></td><td class="summaryTableDescription summaryTableCol">
    61. 

  61. 		 Dispatched just before the object is destructed.</td><td class="summaryTableOwnerCol">CoreTimer</td></tr></table></div><script language="javascript" type="text/javascript"><!--
    62. 

  62. 										showHideInherited();
    63. 

  63. 										--></script><div class="MainContent"><div class="detailSectionHeader">Property Detail</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></tr></table><div class="detailBody"><code>eventListenerManager:<a href="../../temple/destruction/EventListenerManager.html">EventListenerManager</a></code>&nbsp;&nbsp;[read-only] <p></p><p>
    64. 

  64. 		 
    65. 

  65. 		 Returns a reference to the EventListenerManager of the IDestructableEventDispatcher
    66. 

  66. 		 </p><br/><span class="label"> Implementation </span><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function get eventListenerManager():<a href="../../temple/destruction/EventListenerManager.html">EventListenerManager</a></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">&nbsp;</td></tr></table><div class="detailBody"><code>isDestructed:Boolean</code>&nbsp;&nbsp;[read-only] <p></p><p>
    67. 

  67. 		 
    68. 

  68. 		 If an object is destructed, this property is set to true.
    69. 

  69. 		 
    70. 

  70. 		 <p>After a garbage collection the object should be disappeared from Memory (if Temple.registerObjectsInMemory is set to true).
    71. 

  71. 		 
    72. 

  72. 		 If the object still exists, you should check your code.</p>
    73. 

  73. 		 
    74. 

  74. 		 </p><br/><span class="label"> Implementation </span><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function get isDestructed():Boolean</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">&nbsp;</td></tr></table><div class="detailBody"><code>registryId:uint</code>&nbsp;&nbsp;[read-only] <p></p><p>
    75. 

  75. 		 
    76. 

  76. 		 The unique identifier of the object. The id is generated and registered by the Registry class
    77. 

  77. 		 </p><br/><span class="label"> Implementation </span><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function get registryId():uint</code><br/></div><a name="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="CoreTimer()"></a><a name="CoreTimer(Number,int)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">CoreTimer</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function CoreTimer(delay:Number, repeatCount:int = 0)</code><br/><br/><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">delay</span>:Number</code></td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">repeatCount</span>:int</code> (default = <code>0</code>)<code></code></td></tr></table></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>
    78. 

  78. 		 </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">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">listener</span>:Function</code></td></tr><tr><td class="paramSpacer">&nbsp;</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">&nbsp;</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">&nbsp;</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="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">&nbsp;</td></tr></table><div class="detailBody"><code> public function destruct():void</code><p></p><p>
    79. 

  79. 		 
    80. 

  80. 		 Destroys the objects, all intern listeners will be removed.
    81. 

  81. 		 
    82. 

  82. 		 <p>When overriding this method, always call super.destruct() at the end!</p>
    83. 

  83. 		 
    84. 

  84. 		 If you want the object to be available for garbage collection make sure you:
    85. 

  85. 		 <ul>
    86. 

  86. 		 	<li>Remove all event listeners on this object (use removeAllEventListeners on Temple objects).</li>
    87. 

  87. 		 	<li>Remove all event listeners from this object.</li>
    88. 

  88. 		 	<li>Set all non-primitive variables to null.</li>
    89. 

  89. 		 	<li>Set all references to this object to null in other objects.</li>
    90. 

  90. 		 </ul>
    91. 

  91. 		 
    92. 

  92. 		 When a Temple object is destructed a DestructEvent.DESTRUCT is dispatched from the object (if the object implements IDestructableEventDispatcher).
    93. 

  93. 		 
    94. 

  94. 		 <p>Note: Bear in mind that it is possible an object can be destructed more than once.</p>
    95. 

  95. 		 
    96. 

  96. 		  </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">&nbsp;</td></tr></table><div class="detailBody"><code>override public function dispatchEvent(event:Event):Boolean</code><p></p><p>
    97. 

  97. 		 </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="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">&nbsp;</td></tr></table><div class="detailBody"><code> protected final function logDebug(data:*):void</code><p></p><p>
    98. 

  98. 		 Does a Log.debug, but has already filled in some known data
    99. 

  99. 		 </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> &mdash; the data to be logged
    100. 

  100. 		 </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">&nbsp;</td></tr></table><div class="detailBody"><code> protected final function logError(data:*):void</code><p></p><p>
    101. 

  101. 		 Does a Log.error, but has already filled in some known data
    102. 

  102. 		 </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> &mdash; the data to be logged
    103. 

  103. 		 </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">&nbsp;</td></tr></table><div class="detailBody"><code> protected final function logFatal(data:*):void</code><p></p><p>
    104. 

  104. 		 Does a Log.fatal, but has already filled in some known data
    105. 

  105. 		 </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> &mdash; the data to be logged
    106. 

  106. 		 </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">&nbsp;</td></tr></table><div class="detailBody"><code> protected final function logInfo(data:*):void</code><p></p><p>
    107. 

  107. 		 Does a Log.info, but has already filled in some known data
    108. 

  108. 		 </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> &mdash; the data to be logged
    109. 

  109. 		 </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">&nbsp;</td></tr></table><div class="detailBody"><code> protected final function logStatus(data:*):void</code><p></p><p>
    110. 

  110. 		 Does a Log.status, but has already filled in some known data
    111. 

  111. 		 </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> &mdash; the data to be logged
    112. 

  112. 		 </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">&nbsp;</td></tr></table><div class="detailBody"><code> protected final function logWarn(data:*):void</code><p></p><p>
    113. 

  113. 		 Does a Log.warn, but has already filled in some known data
    114. 

  114. 		 </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> &mdash; the data to be logged
    115. 

  115. 		 </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">&nbsp;</td></tr></table><div class="detailBody"><code> public function removeAllEventListeners():void</code><p></p><p>
    116. 

  116. 		 
    117. 

  117. 		 Removes all strong (non weak) EventListeners.
    118. 

  118. 		 </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">&nbsp;</td></tr></table><div class="detailBody"><code> public function removeAllStrongEventListenersForListener(listener:Function):void</code><p></p><p>
    119. 

  119. 		 
    120. 

  120. 		 Removes all strong (non weak) EventListeners that are handled by a specified listener.
    121. 

  121. 		 	
    122. 

  122. 		 </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> &mdash; The listener function that handles the event.
    123. 

  123. 		 </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">&nbsp;</td></tr></table><div class="detailBody"><code> public function removeAllStrongEventListenersForType(type:String):void</code><p></p><p>
    124. 

  124. 		 
    125. 

  125. 		 Removes all strong (non-weak) EventListeners of a specific type.
    126. 

  126. 		 	
    127. 

  127. 		 </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> &mdash; The type of event.
    128. 

  128. 		 </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">&nbsp;</td></tr></table><div class="detailBody"><code>override public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void</code><p></p><p>
    129. 

  129. 		 </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">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">listener</span>:Function</code></td></tr><tr><td class="paramSpacer">&nbsp;</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">&nbsp;</td></tr></table><div class="detailBody"><code>override public function toString():String</code><p></p><p>
    130. 

  130. 		 </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>
    131. 

  131. 	 </p>
    132. 

  132. 		 Dispatched just before the object is destructed.
    133. 

  133. 		 </div><br/><br/><hr><br/><p></p><center class="copyright"><footer> </footer><br/> </center></div></body></html><!-- <br/> -->
    134.