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

/docs/org/tractionas3/load/CoreLoader.html

http://tractionas3.googlecode.com/
HTML | 607 lines | 563 code | 35 blank | 9 comment | 0 complexity | f45d5d99a4153196950b09e6c1ea39fb 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="CoreLoader,org.tractionas3.load.CoreLoader,name,priority,bytesLoaded,bytesTotal,bytesTotalPrefetcher,cancelable,data,loadTime,loaded,loading,progress,url,clone,getURLRequest,listDestructableProperties,load,prefetchBytesTotal,reset,toString" name="keywords">
    8. 

  8. <title>org.tractionas3.load.CoreLoader</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 = 'CoreLoader - 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/CoreLoader.html&amp;org/tractionas3/load/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;CoreLoader</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 CoreLoader"); 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</a></td>
    36. 

  36. </tr>
    37. 

  37. <tr>
    38. 

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

  39. </tr>
    40. 

  40. <tr>
    41. 

  41. <td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">CoreLoader <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="../load/DisplayLoader.html">DisplayLoader</a>, <a href="../load/SoundLoader.html">SoundLoader</a>, <a href="../load/URLDataLoader.html">URLDataLoader</a>, <a href="../load/VideoLoader.html">VideoLoader</a></td>
    48. 

  48. </tr>
    49. 

  49. </table>
    50. 

  50. <p></p>
    51. 

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

  52.   <p />
    53. 

  53.   Providing core functinality to all loader classes, CoreLoader 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. <table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
    64. 

  64. <tr>
    65. 

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

  66. </tr>
    67. 

  67. <tr class="">
    68. 

  68. <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]
    69. 

  69.    
    70. 

  70.    Indicates the number of loaded bytes from the loaders target file.</div>
    71. 

  71. </td><td class="summaryTableOwnerCol">CoreLoader</td>
    72. 

  72. </tr>
    73. 

  73. <tr class="">
    74. 

  74. <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]
    75. 

  75.    
    76. 

  76.    Indicates the number of total bytes of the loaders target file.</div>
    77. 

  77. </td><td class="summaryTableOwnerCol">CoreLoader</td>
    78. 

  78. </tr>
    79. 

  79. <tr class="">
    80. 

  80. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#bytesTotalPrefetcher">bytesTotalPrefetcher</a> : <a href="../load/BytesTotalPrefetcher.html">BytesTotalPrefetcher</a>
    81. 

  81. <div class="summaryTableDescription">[read-only]
    82. 

  82.    
    83. 

  83.    Returns the bytesTotal prefetcher instance.</div>
    84. 

  84. </td><td class="summaryTableOwnerCol">CoreLoader</td>
    85. 

  85. </tr>
    86. 

  86. <tr class="">
    87. 

  87. <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]
    88. 

  88.    
    89. 

  89.    Indicates whether the loader is cancelable.</div>
    90. 

  90. </td><td class="summaryTableOwnerCol">CoreLoader</td>
    91. 

  91. </tr>
    92. 

  92. <tr class="">
    93. 

  93. <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]
    94. 

  94.    Returns the loaded data of the CoreLoader.</div>
    95. 

  95. </td><td class="summaryTableOwnerCol">CoreLoader</td>
    96. 

  96. </tr>
    97. 

  97. <tr class="">
    98. 

  98. <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]
    99. 

  99.    
    100. 

  100.    Indicates whether the loading process has finished.</div>
    101. 

  101. </td><td class="summaryTableOwnerCol">CoreLoader</td>
    102. 

  102. </tr>
    103. 

  103. <tr class="">
    104. 

  104. <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]
    105. 

  105.    
    106. 

  106.    Indicates whether the loading process is running.</div>
    107. 

  107. </td><td class="summaryTableOwnerCol">CoreLoader</td>
    108. 

  108. </tr>
    109. 

  109. <tr class="">
    110. 

  110. <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]
    111. 

  111.    
    112. 

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

  113. </td><td class="summaryTableOwnerCol">CoreLoader</td>
    114. 

  114. </tr>
    115. 

  115. <tr class="">
    116. 

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

  117.    Specifies the name of the loader.</div>
    118. 

  118. </td><td class="summaryTableOwnerCol">CoreLoader</td>
    119. 

  119. </tr>
    120. 

  120. <tr class="">
    121. 

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

  122.    Defines the priority of the loader.</div>
    123. 

  123. </td><td class="summaryTableOwnerCol">CoreLoader</td>
    124. 

  124. </tr>
    125. 

  125. <tr class="">
    126. 

  126. <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]
    127. 

  127.    
    128. 

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

  129. </td><td class="summaryTableOwnerCol">CoreLoader</td>
    130. 

  130. </tr>
    131. 

  131. <tr class="">
    132. 

  132. <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>
    133. 

  133. </td><td class="summaryTableOwnerCol">CoreLoader</td>
    134. 

  134. </tr>
    135. 

  135. </table>
    136. 

  136. </div>
    137. 

  137. <a name="methodSummary"></a>
    138. 

  138. <div class="summarySection">
    139. 

  139. <div class="summaryTableTitle">Public Methods</div>
    140. 

  140. <div class="showHideLinks">
    141. 

  141. <div class="hideInheritedMethod" id="hideInheritedMethod">
    142. 

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

  143. </div>
    144. 

  144. <div class="showInheritedMethod" id="showInheritedMethod">
    145. 

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

  146. </div>
    147. 

  147. </div>
    148. 

  148. <table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
    149. 

  149. <tr>
    150. 

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

  151. </tr>
    152. 

  152. <tr class="">
    153. 

  153. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
    154. 

  154. <div class="summarySignature">
    155. 

  155. <a class="signatureLink" href="#CoreLoader()">CoreLoader</a>(url:String = null, loaderName:String = null)</div>
    156. 

  156. <div class="summaryTableDescription">
    157. 

  157.    Creates a new CoreLoader object.</div>
    158. 

  158. </td><td class="summaryTableOwnerCol">CoreLoader</td>
    159. 

  159. </tr>
    160. 

  160. <tr class="hideInheritedMethod">
    161. 

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

  162. <div class="summarySignature">
    163. 

  163. <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>
    164. 

  164. <div class="summaryTableDescription">
    165. 

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

  166. </td><td class="summaryTableOwnerCol"><a href="../events/WeakEventDispatcher.html">WeakEventDispatcher</a></td>
    167. 

  167. </tr>
    168. 

  168. <tr class="">
    169. 

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

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

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

  172. </div>
    173. 

  173. <div class="summaryTableDescription">
    174. 

  174.    
    175. 

  175.    Creates a duplicate of the instance.</div>
    176. 

  176. </td><td class="summaryTableOwnerCol">CoreLoader</td>
    177. 

  177. </tr>
    178. 

  178. <tr class="hideInheritedMethod">
    179. 

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

  180. <div class="summarySignature">
    181. 

  181. <a class="signatureLink" href="../events/ClearableEventDispatcher.html#destruct()">destruct</a>(deepDestruct:Boolean = false):void</div>
    182. 

  182. <div class="summaryTableDescription">
    183. 

  183.    
    184. 

  184.    Destructs implementing instance of specified properties.</div>
    185. 

  185. </td><td class="summaryTableOwnerCol"><a href="../events/ClearableEventDispatcher.html">ClearableEventDispatcher</a></td>
    186. 

  186. </tr>
    187. 

  187. <tr class="hideInheritedMethod">
    188. 

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

  189. <div class="summarySignature">
    190. 

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

  191. <div class="summaryTableDescription">
    192. 

  192.    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>
    193. 

  193. </td><td class="summaryTableOwnerCol"><a href="../events/WeakEventDispatcher.html">WeakEventDispatcher</a></td>
    194. 

  194. </tr>
    195. 

  195. <tr class="">
    196. 

  196. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
    197. 

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

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

  199. <div class="summaryTableDescription">
    200. 

  200.    
    201. 

  201.    Returns the <code>URLRequest</code> of the loader.</div>
    202. 

  202. </td><td class="summaryTableOwnerCol">CoreLoader</td>
    203. 

  203. </tr>
    204. 

  204. <tr class="">
    205. 

  205. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
    206. 

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

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

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

  209.    
    210. 

  210.    Specifies an array of strings representing properties that are to be
    211. 

  211.    nullified or reset upon destruction.</div>
    212. 

  212. </td><td class="summaryTableOwnerCol">CoreLoader</td>
    213. 

  213. </tr>
    214. 

  214. <tr class="">
    215. 

  215. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
    216. 

  216. <div class="summarySignature">
    217. 

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

  218. <div class="summaryTableDescription">
    219. 

  219.    
    220. 

  220.    Initiates the loading process of the loader.</div>
    221. 

  221. </td><td class="summaryTableOwnerCol">CoreLoader</td>
    222. 

  222. </tr>
    223. 

  223. <tr class="">
    224. 

  224. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
    225. 

  225. <div class="summarySignature">
    226. 

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

  227. <div class="summaryTableDescription">
    228. 

  228.    
    229. 

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

  230. </td><td class="summaryTableOwnerCol">CoreLoader</td>
    231. 

  231. </tr>
    232. 

  232. <tr class="hideInheritedMethod">
    233. 

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

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

  235. <a class="signatureLink" href="../events/ClearableEventDispatcher.html#removeAllEventListeners()">removeAllEventListeners</a>():void</div>
    236. 

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

  237.    
    238. 

  238.    Removes all event listeners from the IClearableEventDispatcher object.</div>
    239. 

  239. </td><td class="summaryTableOwnerCol"><a href="../events/ClearableEventDispatcher.html">ClearableEventDispatcher</a></td>
    240. 

  240. </tr>
    241. 

  241. <tr class="hideInheritedMethod">
    242. 

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

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

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

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

  246.    Removes a listener from the EventDispatcher object.</div>
    247. 

  247. </td><td class="summaryTableOwnerCol"><a href="../events/ClearableEventDispatcher.html">ClearableEventDispatcher</a></td>
    248. 

  248. </tr>
    249. 

  249. <tr class="">
    250. 

  250. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
    251. 

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

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

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

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

  255. </td><td class="summaryTableOwnerCol">CoreLoader</td>
    256. 

  256. </tr>
    257. 

  257. <tr class="">
    258. 

  258. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
    259. 

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

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

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

  262.    
    263. 

  263.    Returns the string representation of the instance.</div>
    264. 

  264. </td><td class="summaryTableOwnerCol">CoreLoader</td>
    265. 

  265. </tr>
    266. 

  266. </table>
    267. 

  267. </div>
    268. 

  268. <script type="text/javascript" language="javascript">
    269. 

  269. <!--
    270. 

  270. showHideInherited();
    271. 

  271. --></script>
    272. 

  272. <div class="MainContent">
    273. 

  273. <a name="propertyDetail"></a>
    274. 

  274. <div class="detailSectionHeader">Property detail</div>
    275. 

  275. <a name="bytesLoaded"></a>
    276. 

  276. <table cellspacing="0" cellpadding="0" class="detailHeader">
    277. 

  277. <tr>
    278. 

  278. <td class="detailHeaderName">bytesLoaded</td><td class="detailHeaderType">property</td>
    279. 

  279. </tr>
    280. 

  280. </table>
    281. 

  281. <div class="detailBody">
    282. 

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

  283.    
    284. 

  284.    Indicates the number of loaded bytes from the loaders target file.
    285. 

  285.    </p><span class="label">Implementation</span>
    286. 

  286. <br>
    287. 

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

  288. <br>
    289. 

  289. </div>
    290. 

  290. <a name="bytesTotal"></a>
    291. 

  291. <table cellspacing="0" cellpadding="0" class="detailHeader">
    292. 

  292. <tr>
    293. 

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

  294. </tr>
    295. 

  295. </table>
    296. 

  296. <div class="detailBody">
    297. 

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

  298.    
    299. 

  299.    Indicates the number of total bytes of the loaders target file.
    300. 

  300.    </p><span class="label">Implementation</span>
    301. 

  301. <br>
    302. 

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

  303. <br>
    304. 

  304. </div>
    305. 

  305. <a name="bytesTotalPrefetcher"></a>
    306. 

  306. <table cellspacing="0" cellpadding="0" class="detailHeader">
    307. 

  307. <tr>
    308. 

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

  309. </tr>
    310. 

  310. </table>
    311. 

  311. <div class="detailBody">
    312. 

  312. <code>bytesTotalPrefetcher:<a href="../load/BytesTotalPrefetcher.html">BytesTotalPrefetcher</a></code>&nbsp;&nbsp;[read-only]<p>
    313. 

  313.    
    314. 

  314.    Returns the bytesTotal prefetcher instance.
    315. 

  315.    </p><span class="label">Implementation</span>
    316. 

  316. <br>
    317. 

  317. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function get bytesTotalPrefetcher():<a href="../load/BytesTotalPrefetcher.html">BytesTotalPrefetcher</a></code>
    318. 

  318. <br>
    319. 

  319. </div>
    320. 

  320. <a name="cancelable"></a>
    321. 

  321. <table cellspacing="0" cellpadding="0" class="detailHeader">
    322. 

  322. <tr>
    323. 

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

  324. </tr>
    325. 

  325. </table>
    326. 

  326. <div class="detailBody">
    327. 

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

  328.    
    329. 

  329.    Indicates whether the loader is cancelable. Cancelable loaders may be interrupted while loading.
    330. 

  330.    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
    331. 

  331.    the <code>load()</code> method again.
    332. 

  332.    
    333. 

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

  334. <br>
    335. 

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

  336. <br>
    337. 

  337. </div>
    338. 

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

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

  340. <tr>
    341. 

  341. <td class="detailHeaderName">data</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>data:*</code>&nbsp;&nbsp;[read-only]<p>
    346. 

  346.    Returns the loaded data of the CoreLoader.
    347. 

  347.    
    348. 

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

  349. <br>
    350. 

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

  351. <br>
    352. 

  352. </div>
    353. 

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

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

  355. <tr>
    356. 

  356. <td class="detailHeaderName">loaded</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>loaded:Boolean</code>&nbsp;&nbsp;[read-only]<p>
    361. 

  361.    
    362. 

  362.    Indicates whether the loading process has finished.
    363. 

  363.    </p><span class="label">Implementation</span>
    364. 

  364. <br>
    365. 

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

  366. <br>
    367. 

  367. </div>
    368. 

  368. <a name="loading"></a>
    369. 

  369. <table cellspacing="0" cellpadding="0" class="detailHeader">
    370. 

  370. <tr>
    371. 

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

  372. </tr>
    373. 

  373. </table>
    374. 

  374. <div class="detailBody">
    375. 

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

  376.    
    377. 

  377.    Indicates whether the loading process is running.
    378. 

  378.    </p><span class="label">Implementation</span>
    379. 

  379. <br>
    380. 

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

  381. <br>
    382. 

  382. </div>
    383. 

  383. <a name="loadTime"></a>
    384. 

  384. <table cellspacing="0" cellpadding="0" class="detailHeader">
    385. 

  385. <tr>
    386. 

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

  387. </tr>
    388. 

  388. </table>
    389. 

  389. <div class="detailBody">
    390. 

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

  391.    
    392. 

  392.    Indicates, in milliseconds, the time elapsed from loading start to loading completion.
    393. 

  393.    </p><span class="label">Implementation</span>
    394. 

  394. <br>
    395. 

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

  396. <br>
    397. 

  397. </div>
    398. 

  398. <a name="name"></a>
    399. 

  399. <table cellspacing="0" cellpadding="0" class="detailHeader">
    400. 

  400. <tr>
    401. 

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

  402. </tr>
    403. 

  403. </table>
    404. 

  404. <div class="detailBody">
    405. 

  405. <code>public var name:String</code><p>
    406. 

  406.    Specifies the name of the loader.
    407. 

  407.    </p></div>
    408. 

  408. <a name="priority"></a>
    409. 

  409. <table cellspacing="0" cellpadding="0" class="detailHeader">
    410. 

  410. <tr>
    411. 

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

  412. </tr>
    413. 

  413. </table>
    414. 

  414. <div class="detailBody">
    415. 

  415. <code>public var priority:uint = 0</code><p>
    416. 

  416.    Defines the priority of the loader.
    417. 

  417.    Loaders with a low priority value will be loaded before loaders with a higher priority value
    418. 

  418.    in a loader queue.
    419. 

  419.    
    420. 

  420.    </p><p>
    421. 

  421. <span class="label">See also</span>
    422. 

  422. </p>
    423. 

  423. <div class="seeAlso">
    424. 

  424. <a href="../load/LoaderQueue.html" target="">org.tractionas3.load.LoaderQueue</a>
    425. 

  425. </div>
    426. 

  426. </div>
    427. 

  427. <a name="progress"></a>
    428. 

  428. <table cellspacing="0" cellpadding="0" class="detailHeader">
    429. 

  429. <tr>
    430. 

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

  431. </tr>
    432. 

  432. </table>
    433. 

  433. <div class="detailBody">
    434. 

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

  435.    
    436. 

  436.    Returns a value between zero and one indicating the current loading progress of the loader.
    437. 

  437.    </p><span class="label">Implementation</span>
    438. 

  438. <br>
    439. 

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

  440. <br>
    441. 

  441. </div>
    442. 

  442. <a name="url"></a>
    443. 

  443. <table cellspacing="0" cellpadding="0" class="detailHeader">
    444. 

  444. <tr>
    445. 

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

  446. </tr>
    447. 

  447. </table>
    448. 

  448. <div class="detailBody">
    449. 

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

  450. <br>
    451. 

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

  452. <br>
    453. 

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

  454. <br>
    455. 

  455. </div>
    456. 

  456. <a name="constructorDetail"></a>
    457. 

  457. <div class="detailSectionHeader">Constructor detail</div>
    458. 

  458. <a name="CoreLoader()"></a>
    459. 

  459. <table cellspacing="0" cellpadding="0" class="detailHeader">
    460. 

  460. <tr>
    461. 

  461. <td class="detailHeaderName">CoreLoader</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
    462. 

  462. </tr>
    463. 

  463. </table>
    464. 

  464. <div class="detailBody">
    465. 

  465. <code>public function CoreLoader(url:String = null, loaderName:String = null)</code><p>
    466. 

  466.    Creates a new CoreLoader object.
    467. 

  467.    
    468. 

  468.    </p><span class="label">Parameters</span>
    469. 

  469. <table border="0" cellspacing="0" cellpadding="0">
    470. 

  470. <tr>
    471. 

  471. <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.
    472. 

  472.    </td>
    473. 

  473. </tr>
    474. 

  474. <tr>
    475. 

  475. <td class="paramSpacer">&nbsp;</td>
    476. 

  476. </tr>
    477. 

  477. <tr>
    478. 

  478. <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.
    479. 

  479.    </td>
    480. 

  480. </tr>
    481. 

  481. </table>
    482. 

  482. </div>
    483. 

  483. <a name="methodDetail"></a>
    484. 

  484. <div class="detailSectionHeader">Method detail</div>
    485. 

  485. <a name="clone()"></a>
    486. 

  486. <table cellspacing="0" cellpadding="0" class="detailHeader">
    487. 

  487. <tr>
    488. 

  488. <td class="detailHeaderName">clone</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
    489. 

  489. </tr>
    490. 

  490. </table>
    491. 

  491. <div class="detailBody">
    492. 

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

  493.    
    494. 

  494.    Creates a duplicate of the instance.
    495. 

  495.    </p><p></p>
    496. 

  496. <span class="label">Returns</span>
    497. 

  497. <table border="0" cellspacing="0" cellpadding="0">
    498. 

  498. <tr>
    499. 

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

  500. </tr>
    501. 

  501. </table>
    502. 

  502. </div>
    503. 

  503. <a name="getURLRequest()"></a>
    504. 

  504. <table cellspacing="0" cellpadding="0" class="detailHeader">
    505. 

  505. <tr>
    506. 

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

  507. </tr>
    508. 

  508. </table>
    509. 

  509. <div class="detailBody">
    510. 

  510. <code>public final function getURLRequest():URLRequest</code><p>
    511. 

  511.    
    512. 

  512.    Returns the <code>URLRequest</code> of the loader. The <code>URLRequest</code> cannot be changed.
    513. 

  513.    </p><p></p>
    514. 

  514. <span class="label">Returns</span>
    515. 

  515. <table border="0" cellspacing="0" cellpadding="0">
    516. 

  516. <tr>
    517. 

  517. <td width="20"></td><td><code>URLRequest</code></td>
    518. 

  518. </tr>
    519. 

  519. </table>
    520. 

  520. </div>
    521. 

  521. <a name="listDestructableProperties()"></a>
    522. 

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

  523. <tr>
    524. 

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

  525. </tr>
    526. 

  526. </table>
    527. 

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

  528. <code>public override function listDestructableProperties():Array</code><p>
    529. 

  529.    
    530. 

  530.    Specifies an array of strings representing properties that are to be
    531. 

  531.    nullified or reset upon destruction. Applies to public properties <b>only</b>
    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>Array</code></td>
    537. 

  537. </tr>
    538. 

  538. </table>
    539. 

  539. </div>
    540. 

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

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

  542. <tr>
    543. 

  543. <td class="detailHeaderName">load</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 function load(newURL:String = null):void</code><p>
    548. 

  548.    
    549. 

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

  550.    </p><span class="label">Parameters</span>
    551. 

  551. <table border="0" cellspacing="0" cellpadding="0">
    552. 

  552. <tr>
    553. 

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

  554. </tr>
    555. 

  555. </table>
    556. 

  556. </div>
    557. 

  557. <a name="prefetchBytesTotal()"></a>
    558. 

  558. <table cellspacing="0" cellpadding="0" class="detailHeader">
    559. 

  559. <tr>
    560. 

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

  561. </tr>
    562. 

  562. </table>
    563. 

  563. <div class="detailBody">
    564. 

  564. <code>public final function prefetchBytesTotal():void</code><p>
    565. 

  565.    
    566. 

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

  567.    
    568. 

  568.    </p></div>
    569. 

  569. <a name="reset()"></a>
    570. 

  570. <table cellspacing="0" cellpadding="0" class="detailHeader">
    571. 

  571. <tr>
    572. 

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

  573. </tr>
    574. 

  574. </table>
    575. 

  575. <div class="detailBody">
    576. 

  576. <code>public function reset():void</code><p>
    577. 

  577.    Resets the loader and its properties to what they were upon instantiation.
    578. 

  578.    </p></div>
    579. 

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

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

  581. <tr>
    582. 

  582. <td class="detailHeaderName">toString</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 toString():String</code><p>
    587. 

  587.    
    588. 

  588.    Returns the string representation of the instance.
    589. 

  589.    </p><p></p>
    590. 

  590. <span class="label">Returns</span>
    591. 

  591. <table border="0" cellspacing="0" cellpadding="0">
    592. 

  592. <tr>
    593. 

  593. <td width="20"></td><td><code>String</code></td>
    594. 

  594. </tr>
    595. 

  595. </table>
    596. 

  596. </div>
    597. 

  597. <br>
    598. 

  598. <br>
    599. 

  599. <hr>
    600. 

  600. <br>
    601. 

  601. <p></p>
    602. 

  602. <center class="copyright"> 
    603. 

  603. </center>
    604. 

  604. </div>
    605. 

  605. </body>
    606. 

  606. </html>
    607. 

  607. <!-- -->
    608. 

  608.