PageRenderTime 59ms CodeModel.GetById 31ms RepoModel.GetById 0ms app.codeStats 0ms

/doc/temple/core/CoreObject.html

http://github.com/MediaMonks/Temple
HTML | 93 lines | 69 code | 16 blank | 8 comment | 0 complexity | e68f47077d8b834f6c0112f357a4b1f3 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="CoreObject,temple.core.CoreObject,_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.CoreObject</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. asdocTitle = 'CoreObject - Temple API Documentation';
  3. var baseRef = '../../';
  4. window.onload = configPage;
  5. --></script>
  6. <script type="text/javascript">
  7. scrollToNameAnchor();
  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/CoreObject.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">CoreObject</td><td class="titleTableSubNav" id="subNav" align="right"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a></td></tr><tr class="titleTableRow3"><td colspan="3">&nbsp;</td></tr></table><script language="javascript" type="text/javascript" xml:space="preserve">
  9. <!--
  10. if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("CoreObject"); titleBar_setSubNav(false,true,false,false,false,false,false,false,true,false,false ,false,false,false,false,false);}
  11. -->
  12. </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 dynamic class CoreObject</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">CoreObject <img src="../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> Object</td></tr><tr><td class="classHeaderTableLabel">Implements</td><td> <a href="../../temple/core/ICoreObject.html">ICoreObject</a></td></tr><tr><td class="classHeaderTableLabel">Subclasses</td><td> <a href="../../temple/debug/DebugManager.html">DebugManager</a>, <a href="../../temple/destruction/DestructController.html">DestructController</a>, <a href="../../temple/destruction/EventListenerManager.html">EventListenerManager</a>, <a href="../../temple/utils/FrameDelay.html">FrameDelay</a>, <a href="../../temple/data/collections/HashMap.html">HashMap</a>, <a href="../../temple/utils/KeyMapper.html">KeyMapper</a>, <a href="../../temple/data/notificationcenter/NotificationCenter.html">NotificationCenter</a>, <a href="../../temple/utils/SiteDisabler.html">SiteDisabler</a>, <a href="../../temple/utils/TimeOut.html">TimeOut</a>, <a href="../../temple/data/url/URLData.html">URLData</a></td></tr></table><p></p><p></p>
  13. Base class for all Objects in the Temple. The CoreObject handles some core features of the Temple:
  14. <ul>
  15. <li>Registration to the Registry class.</li>
  16. <li>Wrapper for Log class for easy logging.</li>
  17. <li>Completely destructable.</li>
  18. <li>Tracked in Memory (of this feature is enabled).</li>
  19. </ul>
  20. <p>You should always use and/or extend the CoreObject instead of Object if you want to make use of the Temple features.</p>
  21. <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="#isDestructed" class="signatureLink">isDestructed</a> : Boolean<div class="summaryTableDescription">[read-only]
  22. If an object is destructed, this property is set to true.</div></td><td class="summaryTableOwnerCol">CoreObject</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]
  23. The unique identifier of the object.</div></td><td class="summaryTableOwnerCol">CoreObject</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="#CoreObject()" class="signatureLink">CoreObject</a>()</div><div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol">CoreObject</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">
  24. Destroys the objects, all intern listeners will be removed.</div></td><td class="summaryTableOwnerCol">CoreObject</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">
  25. </div></td><td class="summaryTableOwnerCol">CoreObject</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">
  26. Does a Log.debug, but has already filled in some known data
  27. </div></td><td class="summaryTableOwnerCol">CoreObject</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">
  28. Does a Log.error, but has already filled in some known data
  29. </div></td><td class="summaryTableOwnerCol">CoreObject</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">
  30. Does a Log.fatal, but has already filled in some known data
  31. </div></td><td class="summaryTableOwnerCol">CoreObject</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">
  32. Does a Log.info, but has already filled in some known data
  33. </div></td><td class="summaryTableOwnerCol">CoreObject</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">
  34. Does a Log.status, but has already filled in some known data
  35. </div></td><td class="summaryTableOwnerCol">CoreObject</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">
  36. Does a Log.warn, but has already filled in some known data
  37. </div></td><td class="summaryTableOwnerCol">CoreObject</td></tr></table></div><script language="javascript" type="text/javascript"><!--
  38. showHideInherited();
  39. --></script><div class="MainContent"><div class="detailSectionHeader">Property Detail</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></tr></table><div class="detailBody"><code>isDestructed:Boolean</code>&nbsp;&nbsp;[read-only] <p></p><p>
  40. If an object is destructed, this property is set to true.
  41. <p>After a garbage collection the object should be disappeared from Memory (if Temple.registerObjectsInMemory is set to true).
  42. If the object still exists, you should check your code.</p>
  43. </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>
  44. The unique identifier of the object. The id is generated and registered by the Registry class
  45. </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="CoreObject()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">CoreObject</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function CoreObject()</code><br/><br/></div><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</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></tr></table><div class="detailBody"><code> public function destruct():void</code><p></p><p>
  46. Destroys the objects, all intern listeners will be removed.
  47. <p>When overriding this method, always call super.destruct() at the end!</p>
  48. If you want the object to be available for garbage collection make sure you:
  49. <ul>
  50. <li>Remove all event listeners on this object (use removeAllEventListeners on Temple objects).</li>
  51. <li>Remove all event listeners from this object.</li>
  52. <li>Set all non-primitive variables to null.</li>
  53. <li>Set all references to this object to null in other objects.</li>
  54. </ul>
  55. When a Temple object is destructed a DestructEvent.DESTRUCT is dispatched from the object (if the object implements IDestructableEventDispatcher).
  56. <p>Note: Bear in mind that it is possible an object can be destructed more than once.</p>
  57. </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">&nbsp;</td></tr></table><div class="detailBody"><code> protected final function logDebug(data:*):void</code><p></p><p>
  58. Does a Log.debug, but has already filled in some known data
  59. </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
  60. </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>
  61. Does a Log.error, but has already filled in some known data
  62. </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
  63. </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>
  64. Does a Log.fatal, but has already filled in some known data
  65. </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
  66. </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>
  67. Does a Log.info, but has already filled in some known data
  68. </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
  69. </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>
  70. Does a Log.status, but has already filled in some known data
  71. </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
  72. </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>
  73. Does a Log.warn, but has already filled in some known data
  74. </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
  75. </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> public function toString():String</code><p></p><p>
  76. </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><br/><br/><hr><br/><p></p><center class="copyright"><footer> </footer><br/> </center></div></body></html><!-- <br/> -->