PageRenderTime 26ms CodeModel.GetById 18ms RepoModel.GetById 0ms app.codeStats 1ms

/docs/org/tractionas3/load/loaders/LoaderCore.html

http://tractionas3.googlecode.com/
HTML | 664 lines | 612 code | 43 blank | 9 comment | 0 complexity | 898bc76f808c4c7a40825eea725582ed MD5 | raw file
    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    2. 

  2. <html>
    3. 

  3. <head>
    4. 

  4. <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
    5. 

  5. <link rel="stylesheet" href="../../../../style.css" type="text/css" media="screen">
    6. 

  6. <link rel="stylesheet" href="../../../../print.css" type="text/css" media="print">
    7. 

  7. <meta content="LoaderCore,org.tractionas3.load.loaders.LoaderCore,bytesLoaded,bytesTotal,bytesTotalPrefetcher,cancelable,data,loadTime,loaded,loading,name,priority,progress,url,clone,destruct,getURLRequest,listDestructableProperties,load,prefetchBytesTotal,reset,toString" name="keywords">
    8. 

  8. <title>org.tractionas3.load.loaders.LoaderCore</title>
    9. 

  9. </head>
    10. 

  10. <body>
    11. 

  11. <script type="text/javascript" language="javascript" src="../../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../../cookies.js"></script><script type="text/javascript" language="javascript">
    12. 

  12. <!--
    13. 

  13. 				asdocTitle = 'LoaderCore - TractionAS3 Framework Documentation';
    14. 

  14. 				var baseRef = '../../../../';
    15. 

  15. 				window.onload = configPage;
    16. 

  16. 			--></script>
    17. 

  17. <table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
    18. 

  18. <tr>
    19. 

  19. <td align="left" class="titleTableTitle">TractionAS3 Framework Documentation</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../../all-classes.html')" href="../../../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../all-classes.html')" href="../../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../index-list.html')" href="../../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../../index.html?org/tractionas3/load/loaders/LoaderCore.html&amp;org/tractionas3/load/loaders/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../../images/logo.jpg"></td>
    20. 

  20. </tr>
    21. 

  21. <tr class="titleTableRow2">
    22. 

  22. <td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;LoaderCore</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a></td>
    23. 

  23. </tr>
    24. 

  24. <tr class="titleTableRow3">
    25. 

  25. <td colspan="2">&nbsp;</td>
    26. 

  26. </tr>
    27. 

  27. </table>
    28. 

  28. <script type="text/javascript" language="javascript">
    29. 

  29. <!--
    30. 

  30. if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class LoaderCore"); titleBar_setSubNav(false,true,false,false,false,false,true,false,false,false,false,false,false,false);}
    31. 

  31. --></script>
    32. 

  32. <div class="MainContent">
    33. 

  33. <table cellspacing="0" cellpadding="0" class="classHeaderTable">
    34. 

  34. <tr>
    35. 

  35. <td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">org.tractionas3.load.loaders</a></td>
    36. 

  36. </tr>
    37. 

  37. <tr>
    38. 

  38. <td class="classHeaderTableLabel">Class</td><td class="classSignature">public class LoaderCore</td>
    39. 

  39. </tr>
    40. 

  40. <tr>
    41. 

  41. <td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">LoaderCore <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../../images/inherit-arrow.gif"> <a href="../../events/WeakEventDispatcher.html">WeakEventDispatcher</a> <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../../images/inherit-arrow.gif"> <a href="../../events/ClearableEventDispatcher.html">ClearableEventDispatcher</a> <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../../images/inherit-arrow.gif"> flash.events.EventDispatcher</td>
    42. 

  42. </tr>
    43. 

  43. <tr>
    44. 

  44. <td class="classHeaderTableLabel">Implements</td><td><a href="../ILoadable.html">ILoadable</a></td>
    45. 

  45. </tr>
    46. 

  46. <tr>
    47. 

  47. <td class="classHeaderTableLabel">Subclasses</td><td><a href="../loaders/DisplayLoader.html">DisplayLoader</a>, <a href="../loaders/SoundLoader.html">SoundLoader</a>, <a href="../loaders/URLDataLoader.html">URLDataLoader</a>, <a href="../loaders/VideoLoader.html">VideoLoader</a></td>
    48. 

  48. </tr>
    49. 

  49. </table>
    50. 

  50. <p></p>
    51. 

  51.   LoaderCore class is the base class of all loader classes.
    52. 

  52.   <p />
    53. 

  53.   Providing core functinality to all loader classes, LoaderCore is the type to reference when dealing with common loader properties
    54. 

  54.   such as <code>name</code> and <code>priority</code>.
    55. 

  55.   <p />
    56. 

  56.   <p></p>
    57. 

  57. <br>
    58. 

  58. <hr>
    59. 

  59. </div>
    60. 

  60. <a name="propertySummary"></a>
    61. 

  61. <div class="summarySection">
    62. 

  62. <div class="summaryTableTitle">Public Properties</div>
    63. 

  63. <div class="showHideLinks">
    64. 

  64. <div class="hideInheritedProperty" id="hideInheritedProperty">
    65. 

  65. <a onclick="javascript:setInheritedVisible(false,'Property');" href="#propertySummary" class="showHideLink"><img src="../../../../images/expanded.gif" class="showHideLinkImage"> Hide Inherited Public Properties</a>
    66. 

  66. </div>
    67. 

  67. <div class="showInheritedProperty" id="showInheritedProperty">
    68. 

  68. <a onclick="javascript:setInheritedVisible(true,'Property');" href="#propertySummary" class="showHideLink"><img src="../../../../images/collapsed.gif" class="showHideLinkImage"> Show Inherited Public Properties</a>
    69. 

  69. </div>
    70. 

  70. </div>
    71. 

  71. <table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
    72. 

  72. <tr>
    73. 

  73. <th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
    74. 

  74. </tr>
    75. 

  75. <tr class="">
    76. 

  76. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#bytesLoaded">bytesLoaded</a> : uint<div class="summaryTableDescription">[read-only]
    77. 

  77.    
    78. 

  78.    Indicates the number of loaded bytes from the loaders target file.</div>
    79. 

  79. </td><td class="summaryTableOwnerCol">LoaderCore</td>
    80. 

  80. </tr>
    81. 

  81. <tr class="">
    82. 

  82. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#bytesTotal">bytesTotal</a> : int<div class="summaryTableDescription">[read-only]
    83. 

  83.    
    84. 

  84.    Indicates the number of total bytes of the loaders target file.</div>
    85. 

  85. </td><td class="summaryTableOwnerCol">LoaderCore</td>
    86. 

  86. </tr>
    87. 

  87. <tr class="">
    88. 

  88. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#bytesTotalPrefetcher">bytesTotalPrefetcher</a> : <a href="../loaders/BytesTotalPrefetcher.html">BytesTotalPrefetcher</a>
    89. 

  89. <div class="summaryTableDescription">[read-only]
    90. 

  90.    
    91. 

  91.    Returns the bytesTotal prefetcher instance.</div>
    92. 

  92. </td><td class="summaryTableOwnerCol">LoaderCore</td>
    93. 

  93. </tr>
    94. 

  94. <tr class="">
    95. 

  95. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#cancelable">cancelable</a> : Boolean<div class="summaryTableDescription">[read-only]
    96. 

  96.    
    97. 

  97.    Indicates whether the loader is cancelable.</div>
    98. 

  98. </td><td class="summaryTableOwnerCol">LoaderCore</td>
    99. 

  99. </tr>
    100. 

  100. <tr class="">
    101. 

  101. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#data">data</a> : *<div class="summaryTableDescription">[read-only]
    102. 

  102.    Returns the loaded data of the LoaderCore.</div>
    103. 

  103. </td><td class="summaryTableOwnerCol">LoaderCore</td>
    104. 

  104. </tr>
    105. 

  105. <tr class="">
    106. 

  106. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#loaded">loaded</a> : Boolean<div class="summaryTableDescription">[read-only]
    107. 

  107.    
    108. 

  108.    Indicates whether the loading process has finished.</div>
    109. 

  109. </td><td class="summaryTableOwnerCol">LoaderCore</td>
    110. 

  110. </tr>
    111. 

  111. <tr class="">
    112. 

  112. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#loading">loading</a> : Boolean<div class="summaryTableDescription">[read-only]
    113. 

  113.    
    114. 

  114.    Indicates whether the loading process is running.</div>
    115. 

  115. </td><td class="summaryTableOwnerCol">LoaderCore</td>
    116. 

  116. </tr>
    117. 

  117. <tr class="">
    118. 

  118. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#loadTime">loadTime</a> : uint<div class="summaryTableDescription">[read-only]
    119. 

  119.    
    120. 

  120.    Indicates, in milliseconds, the time elapsed from loading start to loading completion.</div>
    121. 

  121. </td><td class="summaryTableOwnerCol">LoaderCore</td>
    122. 

  122. </tr>
    123. 

  123. <tr class="">
    124. 

  124. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#name">name</a> : String<div class="summaryTableDescription">
    125. 

  125.    
    126. 

  126.    Specifies the name of the loader.</div>
    127. 

  127. </td><td class="summaryTableOwnerCol">LoaderCore</td>
    128. 

  128. </tr>
    129. 

  129. <tr class="hideInheritedProperty">
    130. 

  130. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="../../events/ClearableEventDispatcher.html#numEventListeners">numEventListeners</a> : uint<div class="summaryTableDescription">
    131. 

  131.    
    132. 

  132.    Indicates the number of total event listerers added to the IClearableEventDispatcher object.</div>
    133. 

  133. </td><td class="summaryTableOwnerCol"><a href="../../events/ClearableEventDispatcher.html">ClearableEventDispatcher</a></td>
    134. 

  134. </tr>
    135. 

  135. <tr class="">
    136. 

  136. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#priority">priority</a> : uint<div class="summaryTableDescription">
    137. 

  137.    </div>
    138. 

  138. </td><td class="summaryTableOwnerCol">LoaderCore</td>
    139. 

  139. </tr>
    140. 

  140. <tr class="">
    141. 

  141. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#progress">progress</a> : Number<div class="summaryTableDescription">[read-only]
    142. 

  142.    
    143. 

  143.    Returns a value between zero and one indicating the current loading progress of the loader.</div>
    144. 

  144. </td><td class="summaryTableOwnerCol">LoaderCore</td>
    145. 

  145. </tr>
    146. 

  146. <tr class="">
    147. 

  147. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#url">url</a> : String<div class="summaryTableDescription"></div>
    148. 

  148. </td><td class="summaryTableOwnerCol">LoaderCore</td>
    149. 

  149. </tr>
    150. 

  150. </table>
    151. 

  151. </div>
    152. 

  152. <a name="methodSummary"></a>
    153. 

  153. <div class="summarySection">
    154. 

  154. <div class="summaryTableTitle">Public Methods</div>
    155. 

  155. <div class="showHideLinks">
    156. 

  156. <div class="hideInheritedMethod" id="hideInheritedMethod">
    157. 

  157. <a onclick="javascript:setInheritedVisible(false,'Method');" href="#methodSummary" class="showHideLink"><img src="../../../../images/expanded.gif" class="showHideLinkImage"> Hide Inherited Public Methods</a>
    158. 

  158. </div>
    159. 

  159. <div class="showInheritedMethod" id="showInheritedMethod">
    160. 

  160. <a onclick="javascript:setInheritedVisible(true,'Method');" href="#methodSummary" class="showHideLink"><img src="../../../../images/collapsed.gif" class="showHideLinkImage"> Show Inherited Public Methods</a>
    161. 

  161. </div>
    162. 

  162. </div>
    163. 

  163. <table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
    164. 

  164. <tr>
    165. 

  165. <th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
    166. 

  166. </tr>
    167. 

  167. <tr class="">
    168. 

  168. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
    169. 

  169. <div class="summarySignature">
    170. 

  170. <a class="signatureLink" href="#LoaderCore()">LoaderCore</a>(url:String = null, loaderName:String = null)</div>
    171. 

  171. <div class="summaryTableDescription">
    172. 

  172.    Creates a new LoaderCore object.</div>
    173. 

  173. </td><td class="summaryTableOwnerCol">LoaderCore</td>
    174. 

  174. </tr>
    175. 

  175. <tr class="hideInheritedMethod">
    176. 

  176. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
    177. 

  177. <div class="summarySignature">
    178. 

  178. <a class="signatureLink" href="../../events/WeakEventDispatcher.html#addEventListener()">addEventListener</a>(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = true):void</div>
    179. 

  179. <div class="summaryTableDescription">
    180. 

  180.    Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.</div>
    181. 

  181. </td><td class="summaryTableOwnerCol"><a href="../../events/WeakEventDispatcher.html">WeakEventDispatcher</a></td>
    182. 

  182. </tr>
    183. 

  183. <tr class="">
    184. 

  184. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
    185. 

  185. <div class="summarySignature">
    186. 

  186. <a class="signatureLink" href="#clone()">clone</a>():<a href="../../core/interfaces/ICloneable.html">ICloneable</a>
    187. 

  187. </div>
    188. 

  188. <div class="summaryTableDescription">
    189. 

  189.    
    190. 

  190.    Creates a duplicate of the instance.</div>
    191. 

  191. </td><td class="summaryTableOwnerCol">LoaderCore</td>
    192. 

  192. </tr>
    193. 

  193. <tr class="">
    194. 

  194. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
    195. 

  195. <div class="summarySignature">
    196. 

  196. <a class="signatureLink" href="#destruct()">destruct</a>(deepDestruct:Boolean = false):void</div>
    197. 

  197. <div class="summaryTableDescription">
    198. 

  198.    
    199. 

  199.    
    200. 

  200.    Destructs implementing instance of specified properties.</div>
    201. 

  201. </td><td class="summaryTableOwnerCol">LoaderCore</td>
    202. 

  202. </tr>
    203. 

  203. <tr class="hideInheritedMethod">
    204. 

  204. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
    205. 

  205. <div class="summarySignature">
    206. 

  206. <a class="signatureLink" href="../../events/WeakEventDispatcher.html#dispatchEvent()">dispatchEvent</a>(e:Event):Boolean</div>
    207. 

  207. <div class="summaryTableDescription">
    208. 

  208.    Dispatches an event into the event flow, <i>only</i> if event property <code>hasEventListener</code> or <code>bubbles</code> are <code>true</code>.</div>
    209. 

  209. </td><td class="summaryTableOwnerCol"><a href="../../events/WeakEventDispatcher.html">WeakEventDispatcher</a></td>
    210. 

  210. </tr>
    211. 

  211. <tr class="">
    212. 

  212. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
    213. 

  213. <div class="summarySignature">
    214. 

  214. <a class="signatureLink" href="#getURLRequest()">getURLRequest</a>():URLRequest</div>
    215. 

  215. <div class="summaryTableDescription">
    216. 

  216.    
    217. 

  217.    Returns the <code>URLRequest</code> of the loader.</div>
    218. 

  218. </td><td class="summaryTableOwnerCol">LoaderCore</td>
    219. 

  219. </tr>
    220. 

  220. <tr class="">
    221. 

  221. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
    222. 

  222. <div class="summarySignature">
    223. 

  223. <a class="signatureLink" href="#listDestructableProperties()">listDestructableProperties</a>():Array</div>
    224. 

  224. <div class="summaryTableDescription">
    225. 

  225.    
    226. 

  226.    
    227. 

  227.    Specifies an array of strings representing properties that are to be
    228. 

  228.    nullified or reset upon destruction.</div>
    229. 

  229. </td><td class="summaryTableOwnerCol">LoaderCore</td>
    230. 

  230. </tr>
    231. 

  231. <tr class="">
    232. 

  232. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
    233. 

  233. <div class="summarySignature">
    234. 

  234. <a class="signatureLink" href="#load()">load</a>(newURL:String = null):void</div>
    235. 

  235. <div class="summaryTableDescription">
    236. 

  236.    
    237. 

  237.    Initiates the loading process of the loader.</div>
    238. 

  238. </td><td class="summaryTableOwnerCol">LoaderCore</td>
    239. 

  239. </tr>
    240. 

  240. <tr class="">
    241. 

  241. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
    242. 

  242. <div class="summarySignature">
    243. 

  243. <a class="signatureLink" href="#prefetchBytesTotal()">prefetchBytesTotal</a>():void</div>
    244. 

  244. <div class="summaryTableDescription">
    245. 

  245.    
    246. 

  246.    Instructs the loader to prefech the total file size of target file without having to start the actual loading progress.</div>
    247. 

  247. </td><td class="summaryTableOwnerCol">LoaderCore</td>
    248. 

  248. </tr>
    249. 

  249. <tr class="hideInheritedMethod">
    250. 

  250. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
    251. 

  251. <div class="summarySignature">
    252. 

  252. <a class="signatureLink" href="../../events/ClearableEventDispatcher.html#removeAllEventListeners()">removeAllEventListeners</a>():uint</div>
    253. 

  253. <div class="summaryTableDescription">
    254. 

  254.    
    255. 

  255.    Removes all event listeners from the IClearableEventDispatcher object.</div>
    256. 

  256. </td><td class="summaryTableOwnerCol"><a href="../../events/ClearableEventDispatcher.html">ClearableEventDispatcher</a></td>
    257. 

  257. </tr>
    258. 

  258. <tr class="hideInheritedMethod">
    259. 

  259. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
    260. 

  260. <div class="summarySignature">
    261. 

  261. <a class="signatureLink" href="../../events/ClearableEventDispatcher.html#removeEventListener()">removeEventListener</a>(type:String, listener:Function, useCapture:Boolean = false):void</div>
    262. 

  262. <div class="summaryTableDescription">
    263. 

  263.    Removes a listener from the EventDispatcher object.</div>
    264. 

  264. </td><td class="summaryTableOwnerCol"><a href="../../events/ClearableEventDispatcher.html">ClearableEventDispatcher</a></td>
    265. 

  265. </tr>
    266. 

  266. <tr class="hideInheritedMethod">
    267. 

  267. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
    268. 

  268. <div class="summarySignature">
    269. 

  269. <a class="signatureLink" href="../../events/ClearableEventDispatcher.html#removeEventListenersOf()">removeEventListenersOf</a>(listener:Function):uint</div>
    270. 

  270. <div class="summaryTableDescription">
    271. 

  271.    
    272. 

  272.    Removes all event listenres from the IClearableEventDispatcher with specified listener.</div>
    273. 

  273. </td><td class="summaryTableOwnerCol"><a href="../../events/ClearableEventDispatcher.html">ClearableEventDispatcher</a></td>
    274. 

  274. </tr>
    275. 

  275. <tr class="hideInheritedMethod">
    276. 

  276. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
    277. 

  277. <div class="summarySignature">
    278. 

  278. <a class="signatureLink" href="../../events/ClearableEventDispatcher.html#removeEventListenersWithType()">removeEventListenersWithType</a>(type:String):uint</div>
    279. 

  279. <div class="summaryTableDescription">
    280. 

  280.    
    281. 

  281.    Removes all event listenres from the IClearableEventDispatcher with specified type.</div>
    282. 

  282. </td><td class="summaryTableOwnerCol"><a href="../../events/ClearableEventDispatcher.html">ClearableEventDispatcher</a></td>
    283. 

  283. </tr>
    284. 

  284. <tr class="">
    285. 

  285. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
    286. 

  286. <div class="summarySignature">
    287. 

  287. <a class="signatureLink" href="#reset()">reset</a>():void</div>
    288. 

  288. <div class="summaryTableDescription">
    289. 

  289.    Resets the loader and its properties to what they were upon instantiation.</div>
    290. 

  290. </td><td class="summaryTableOwnerCol">LoaderCore</td>
    291. 

  291. </tr>
    292. 

  292. <tr class="">
    293. 

  293. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
    294. 

  294. <div class="summarySignature">
    295. 

  295. <a class="signatureLink" href="#toString()">toString</a>():String</div>
    296. 

  296. <div class="summaryTableDescription"></div>
    297. 

  297. </td><td class="summaryTableOwnerCol">LoaderCore</td>
    298. 

  298. </tr>
    299. 

  299. </table>
    300. 

  300. </div>
    301. 

  301. <script type="text/javascript" language="javascript">
    302. 

  302. <!--
    303. 

  303. showHideInherited();
    304. 

  304. --></script>
    305. 

  305. <div class="MainContent">
    306. 

  306. <a name="propertyDetail"></a>
    307. 

  307. <div class="detailSectionHeader">Property detail</div>
    308. 

  308. <a name="bytesLoaded"></a>
    309. 

  309. <table cellspacing="0" cellpadding="0" class="detailHeader">
    310. 

  310. <tr>
    311. 

  311. <td class="detailHeaderName">bytesLoaded</td><td class="detailHeaderType">property</td>
    312. 

  312. </tr>
    313. 

  313. </table>
    314. 

  314. <div class="detailBody">
    315. 

  315. <code>bytesLoaded:uint</code>&nbsp;&nbsp;[read-only]<p>
    316. 

  316.    
    317. 

  317.    Indicates the number of loaded bytes from the loaders target file.
    318. 

  318.    </p><span class="label">Implementation</span>
    319. 

  319. <br>
    320. 

  320. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function get bytesLoaded():uint</code>
    321. 

  321. <br>
    322. 

  322. </div>
    323. 

  323. <a name="bytesTotal"></a>
    324. 

  324. <table cellspacing="0" cellpadding="0" class="detailHeader">
    325. 

  325. <tr>
    326. 

  326. <td class="detailHeaderName">bytesTotal</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
    327. 

  327. </tr>
    328. 

  328. </table>
    329. 

  329. <div class="detailBody">
    330. 

  330. <code>bytesTotal:int</code>&nbsp;&nbsp;[read-only]<p>
    331. 

  331.    
    332. 

  332.    Indicates the number of total bytes of the loaders target file.
    333. 

  333.    </p><span class="label">Implementation</span>
    334. 

  334. <br>
    335. 

  335. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function get bytesTotal():int</code>
    336. 

  336. <br>
    337. 

  337. </div>
    338. 

  338. <a name="bytesTotalPrefetcher"></a>
    339. 

  339. <table cellspacing="0" cellpadding="0" class="detailHeader">
    340. 

  340. <tr>
    341. 

  341. <td class="detailHeaderName">bytesTotalPrefetcher</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
    342. 

  342. </tr>
    343. 

  343. </table>
    344. 

  344. <div class="detailBody">
    345. 

  345. <code>bytesTotalPrefetcher:<a href="../loaders/BytesTotalPrefetcher.html">BytesTotalPrefetcher</a></code>&nbsp;&nbsp;[read-only]<p>
    346. 

  346.    
    347. 

  347.    Returns the bytesTotal prefetcher instance.
    348. 

  348.    </p><span class="label">Implementation</span>
    349. 

  349. <br>
    350. 

  350. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function get bytesTotalPrefetcher():<a href="../loaders/BytesTotalPrefetcher.html">BytesTotalPrefetcher</a></code>
    351. 

  351. <br>
    352. 

  352. </div>
    353. 

  353. <a name="cancelable"></a>
    354. 

  354. <table cellspacing="0" cellpadding="0" class="detailHeader">
    355. 

  355. <tr>
    356. 

  356. <td class="detailHeaderName">cancelable</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
    357. 

  357. </tr>
    358. 

  358. </table>
    359. 

  359. <div class="detailBody">
    360. 

  360. <code>cancelable:Boolean</code>&nbsp;&nbsp;[read-only]<p>
    361. 

  361.    
    362. 

  362.    Indicates whether the loader is cancelable. Cancelable loaders may be interrupted while loading.
    363. 

  363.    Note that if you wish to cancel a loading process to resume it later you need to use the <code>reset()</code> method before calling
    364. 

  364.    the <code>load()</code> method again.
    365. 

  365.    
    366. 

  366.    </p><span class="label">Implementation</span>
    367. 

  367. <br>
    368. 

  368. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function get cancelable():Boolean</code>
    369. 

  369. <br>
    370. 

  370. </div>
    371. 

  371. <a name="data"></a>
    372. 

  372. <table cellspacing="0" cellpadding="0" class="detailHeader">
    373. 

  373. <tr>
    374. 

  374. <td class="detailHeaderName">data</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
    375. 

  375. </tr>
    376. 

  376. </table>
    377. 

  377. <div class="detailBody">
    378. 

  378. <code>data:*</code>&nbsp;&nbsp;[read-only]<p>
    379. 

  379.    Returns the loaded data of the LoaderCore.
    380. 

  380.    
    381. 

  381.    </p><span class="label">Implementation</span>
    382. 

  382. <br>
    383. 

  383. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function get data():*</code>
    384. 

  384. <br>
    385. 

  385. </div>
    386. 

  386. <a name="loaded"></a>
    387. 

  387. <table cellspacing="0" cellpadding="0" class="detailHeader">
    388. 

  388. <tr>
    389. 

  389. <td class="detailHeaderName">loaded</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
    390. 

  390. </tr>
    391. 

  391. </table>
    392. 

  392. <div class="detailBody">
    393. 

  393. <code>loaded:Boolean</code>&nbsp;&nbsp;[read-only]<p>
    394. 

  394.    
    395. 

  395.    Indicates whether the loading process has finished.
    396. 

  396.    </p><span class="label">Implementation</span>
    397. 

  397. <br>
    398. 

  398. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function get loaded():Boolean</code>
    399. 

  399. <br>
    400. 

  400. </div>
    401. 

  401. <a name="loading"></a>
    402. 

  402. <table cellspacing="0" cellpadding="0" class="detailHeader">
    403. 

  403. <tr>
    404. 

  404. <td class="detailHeaderName">loading</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
    405. 

  405. </tr>
    406. 

  406. </table>
    407. 

  407. <div class="detailBody">
    408. 

  408. <code>loading:Boolean</code>&nbsp;&nbsp;[read-only]<p>
    409. 

  409.    
    410. 

  410.    Indicates whether the loading process is running.
    411. 

  411.    </p><span class="label">Implementation</span>
    412. 

  412. <br>
    413. 

  413. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function get loading():Boolean</code>
    414. 

  414. <br>
    415. 

  415. </div>
    416. 

  416. <a name="loadTime"></a>
    417. 

  417. <table cellspacing="0" cellpadding="0" class="detailHeader">
    418. 

  418. <tr>
    419. 

  419. <td class="detailHeaderName">loadTime</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
    420. 

  420. </tr>
    421. 

  421. </table>
    422. 

  422. <div class="detailBody">
    423. 

  423. <code>loadTime:uint</code>&nbsp;&nbsp;[read-only]<p>
    424. 

  424.    
    425. 

  425.    Indicates, in milliseconds, the time elapsed from loading start to loading completion.
    426. 

  426.    </p><span class="label">Implementation</span>
    427. 

  427. <br>
    428. 

  428. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function get loadTime():uint</code>
    429. 

  429. <br>
    430. 

  430. </div>
    431. 

  431. <a name="name"></a>
    432. 

  432. <table cellspacing="0" cellpadding="0" class="detailHeader">
    433. 

  433. <tr>
    434. 

  434. <td class="detailHeaderName">name</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
    435. 

  435. </tr>
    436. 

  436. </table>
    437. 

  437. <div class="detailBody">
    438. 

  438. <code>name:String</code>&nbsp;&nbsp;[read-write]<p>
    439. 

  439.    
    440. 

  440.    Specifies the name of the loader.
    441. 

  441.    A loader name must be unique.
    442. 

  442.    </p><span class="label">Implementation</span>
    443. 

  443. <br>
    444. 

  444. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function get name():String</code>
    445. 

  445. <br>
    446. 

  446. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function set name(value:String):void</code>
    447. 

  447. <br>
    448. 

  448. </div>
    449. 

  449. <a name="priority"></a>
    450. 

  450. <table cellspacing="0" cellpadding="0" class="detailHeader">
    451. 

  451. <tr>
    452. 

  452. <td class="detailHeaderName">priority</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
    453. 

  453. </tr>
    454. 

  454. </table>
    455. 

  455. <div class="detailBody">
    456. 

  456. <code>priority:uint</code>&nbsp;&nbsp;[read-write]<p>
    457. 

  457.    </p><span class="label">Implementation</span>
    458. 

  458. <br>
    459. 

  459. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function get priority():uint</code>
    460. 

  460. <br>
    461. 

  461. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function set priority(value:uint):void</code>
    462. 

  462. <br>
    463. 

  463. </div>
    464. 

  464. <a name="progress"></a>
    465. 

  465. <table cellspacing="0" cellpadding="0" class="detailHeader">
    466. 

  466. <tr>
    467. 

  467. <td class="detailHeaderName">progress</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
    468. 

  468. </tr>
    469. 

  469. </table>
    470. 

  470. <div class="detailBody">
    471. 

  471. <code>progress:Number</code>&nbsp;&nbsp;[read-only]<p>
    472. 

  472.    
    473. 

  473.    Returns a value between zero and one indicating the current loading progress of the loader.
    474. 

  474.    </p><span class="label">Implementation</span>
    475. 

  475. <br>
    476. 

  476. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function get progress():Number</code>
    477. 

  477. <br>
    478. 

  478. </div>
    479. 

  479. <a name="url"></a>
    480. 

  480. <table cellspacing="0" cellpadding="0" class="detailHeader">
    481. 

  481. <tr>
    482. 

  482. <td class="detailHeaderName">url</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
    483. 

  483. </tr>
    484. 

  484. </table>
    485. 

  485. <div class="detailBody">
    486. 

  486. <code>url:String</code>&nbsp;&nbsp;[read-write]<span class="label">Implementation</span>
    487. 

  487. <br>
    488. 

  488. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function get url():String</code>
    489. 

  489. <br>
    490. 

  490. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function set url(value:String):void</code>
    491. 

  491. <br>
    492. 

  492. </div>
    493. 

  493. <a name="constructorDetail"></a>
    494. 

  494. <div class="detailSectionHeader">Constructor detail</div>
    495. 

  495. <a name="LoaderCore()"></a>
    496. 

  496. <table cellspacing="0" cellpadding="0" class="detailHeader">
    497. 

  497. <tr>
    498. 

  498. <td class="detailHeaderName">LoaderCore</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
    499. 

  499. </tr>
    500. 

  500. </table>
    501. 

  501. <div class="detailBody">
    502. 

  502. <code>public function LoaderCore(url:String = null, loaderName:String = null)</code><p>
    503. 

  503.    Creates a new LoaderCore object.
    504. 

  504.    
    505. 

  505.    </p><span class="label">Parameters</span>
    506. 

  506. <table border="0" cellspacing="0" cellpadding="0">
    507. 

  507. <tr>
    508. 

  508. <td width="20px"></td><td><code><span class="label">url</span>:String</code> (default = <code>null</code>)<code></code> &mdash; The URL from wich the data should be loaded.
    509. 

  509.    </td>
    510. 

  510. </tr>
    511. 

  511. <tr>
    512. 

  512. <td class="paramSpacer">&nbsp;</td>
    513. 

  513. </tr>
    514. 

  514. <tr>
    515. 

  515. <td width="20px"></td><td><code><span class="label">loaderName</span>:String</code> (default = <code>null</code>)<code></code> &mdash; Assigned name to the loader.
    516. 

  516.    </td>
    517. 

  517. </tr>
    518. 

  518. </table>
    519. 

  519. </div>
    520. 

  520. <a name="methodDetail"></a>
    521. 

  521. <div class="detailSectionHeader">Method detail</div>
    522. 

  522. <a name="clone()"></a>
    523. 

  523. <table cellspacing="0" cellpadding="0" class="detailHeader">
    524. 

  524. <tr>
    525. 

  525. <td class="detailHeaderName">clone</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
    526. 

  526. </tr>
    527. 

  527. </table>
    528. 

  528. <div class="detailBody">
    529. 

  529. <code>public function clone():<a href="../../core/interfaces/ICloneable.html">ICloneable</a></code><p>
    530. 

  530.    
    531. 

  531.    Creates a duplicate of the instance.
    532. 

  532.    </p><p></p>
    533. 

  533. <span class="label">Returns</span>
    534. 

  534. <table border="0" cellspacing="0" cellpadding="0">
    535. 

  535. <tr>
    536. 

  536. <td width="20"></td><td><code><a href="../../core/interfaces/ICloneable.html">ICloneable</a></code></td>
    537. 

  537. </tr>
    538. 

  538. </table>
    539. 

  539. </div>
    540. 

  540. <a name="destruct()"></a>
    541. 

  541. <table cellspacing="0" cellpadding="0" class="detailHeader">
    542. 

  542. <tr>
    543. 

  543. <td class="detailHeaderName">destruct</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
    544. 

  544. </tr>
    545. 

  545. </table>
    546. 

  546. <div class="detailBody">
    547. 

  547. <code>public override function destruct(deepDestruct:Boolean = false):void</code><p>
    548. 

  548.    
    549. 

  549.    
    550. 

  550.    Destructs implementing instance of specified properties.
    551. 

  551.    <p />
    552. 

  552.    <b>Note:</b> You can override this method to remove unused references in your custom class.
    553. 

  553.    
    554. 

  554.    </p><span class="label">Parameters</span>
    555. 

  555. <table border="0" cellspacing="0" cellpadding="0">
    556. 

  556. <tr>
    557. 

  557. <td width="20px"></td><td><code><span class="label">deepDestruct</span>:Boolean</code> (default = <code>false</code>)<code></code></td>
    558. 

  558. </tr>
    559. 

  559. </table>
    560. 

  560. </div>
    561. 

  561. <a name="getURLRequest()"></a>
    562. 

  562. <table cellspacing="0" cellpadding="0" class="detailHeader">
    563. 

  563. <tr>
    564. 

  564. <td class="detailHeaderName">getURLRequest</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
    565. 

  565. </tr>
    566. 

  566. </table>
    567. 

  567. <div class="detailBody">
    568. 

  568. <code>public final function getURLRequest():URLRequest</code><p>
    569. 

  569.    
    570. 

  570.    Returns the <code>URLRequest</code> of the loader. The <code>URLRequest</code> cannot be changed.
    571. 

  571.    </p><p></p>
    572. 

  572. <span class="label">Returns</span>
    573. 

  573. <table border="0" cellspacing="0" cellpadding="0">
    574. 

  574. <tr>
    575. 

  575. <td width="20"></td><td><code>URLRequest</code></td>
    576. 

  576. </tr>
    577. 

  577. </table>
    578. 

  578. </div>
    579. 

  579. <a name="listDestructableProperties()"></a>
    580. 

  580. <table cellspacing="0" cellpadding="0" class="detailHeader">
    581. 

  581. <tr>
    582. 

  582. <td class="detailHeaderName">listDestructableProperties</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
    583. 

  583. </tr>
    584. 

  584. </table>
    585. 

  585. <div class="detailBody">
    586. 

  586. <code>public override function listDestructableProperties():Array</code><p>
    587. 

  587.    
    588. 

  588.    
    589. 

  589.    Specifies an array of strings representing properties that are to be
    590. 

  590.    nullified or reset upon destruction. Applies to public properties <b>only</b>
    591. 

  591.    </p><p></p>
    592. 

  592. <span class="label">Returns</span>
    593. 

  593. <table border="0" cellspacing="0" cellpadding="0">
    594. 

  594. <tr>
    595. 

  595. <td width="20"></td><td><code>Array</code></td>
    596. 

  596. </tr>
    597. 

  597. </table>
    598. 

  598. </div>
    599. 

  599. <a name="load()"></a>
    600. 

  600. <table cellspacing="0" cellpadding="0" class="detailHeader">
    601. 

  601. <tr>
    602. 

  602. <td class="detailHeaderName">load</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
    603. 

  603. </tr>
    604. 

  604. </table>
    605. 

  605. <div class="detailBody">
    606. 

  606. <code>public function load(newURL:String = null):void</code><p>
    607. 

  607.    
    608. 

  608.    Initiates the loading process of the loader. A new URLRequest cannot be defined through this method. 
    609. 

  609.    </p><span class="label">Parameters</span>
    610. 

  610. <table border="0" cellspacing="0" cellpadding="0">
    611. 

  611. <tr>
    612. 

  612. <td width="20px"></td><td><code><span class="label">newURL</span>:String</code> (default = <code>null</code>)<code></code></td>
    613. 

  613. </tr>
    614. 

  614. </table>
    615. 

  615. </div>
    616. 

  616. <a name="prefetchBytesTotal()"></a>
    617. 

  617. <table cellspacing="0" cellpadding="0" class="detailHeader">
    618. 

  618. <tr>
    619. 

  619. <td class="detailHeaderName">prefetchBytesTotal</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
    620. 

  620. </tr>
    621. 

  621. </table>
    622. 

  622. <div class="detailBody">
    623. 

  623. <code>public final function prefetchBytesTotal():void</code><p>
    624. 

  624.    
    625. 

  625.    Instructs the loader to prefech the total file size of target file without having to start the actual loading progress.
    626. 

  626.    
    627. 

  627.    </p></div>
    628. 

  628. <a name="reset()"></a>
    629. 

  629. <table cellspacing="0" cellpadding="0" class="detailHeader">
    630. 

  630. <tr>
    631. 

  631. <td class="detailHeaderName">reset</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
    632. 

  632. </tr>
    633. 

  633. </table>
    634. 

  634. <div class="detailBody">
    635. 

  635. <code>public function reset():void</code><p>
    636. 

  636.    Resets the loader and its properties to what they were upon instantiation.
    637. 

  637.    </p></div>
    638. 

  638. <a name="toString()"></a>
    639. 

  639. <table cellspacing="0" cellpadding="0" class="detailHeader">
    640. 

  640. <tr>
    641. 

  641. <td class="detailHeaderName">toString</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
    642. 

  642. </tr>
    643. 

  643. </table>
    644. 

  644. <div class="detailBody">
    645. 

  645. <code>public override function toString():String</code>
    646. 

  646. <p></p>
    647. 

  647. <span class="label">Returns</span>
    648. 

  648. <table border="0" cellspacing="0" cellpadding="0">
    649. 

  649. <tr>
    650. 

  650. <td width="20"></td><td><code>String</code></td>
    651. 

  651. </tr>
    652. 

  652. </table>
    653. 

  653. </div>
    654. 

  654. <br>
    655. 

  655. <br>
    656. 

  656. <hr>
    657. 

  657. <br>
    658. 

  658. <p></p>
    659. 

  659. <center class="copyright"> 
    660. 

  660. </center>
    661. 

  661. </div>
    662. 

  662. </body>
    663. 

  663. </html>
    664. 

  664. <!-- -->
    665. 

  665.