PageRenderTime 53ms CodeModel.GetById 22ms RepoModel.GetById 0ms app.codeStats 0ms

/docs/org/tractionas3/load/Loadable.html

http://tractionas3.googlecode.com/
HTML | 419 lines | 408 code | 2 blank | 9 comment | 0 complexity | ed332c0b502f0fa209683cc368b2eb6d 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="Loadable,org.tractionas3.load.Loadable,bytesLoaded,bytesTotal,bytesTotalPrefetcher,cancelable,data,loadTime,loaded,loading,progress,url,getURLRequest,load,prefetchBytesTotal" name="keywords">
    8. 

  8. <title>org.tractionas3.load.Loadable</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 = 'Loadable - 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/Loadable.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">Interface&nbsp;Loadable</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("Interface Loadable"); 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">Interface</td><td class="classSignature">public interface Loadable extends <a href="../core/interfaces/ICoreInterface.html">ICoreInterface</a>, <a href="../core/interfaces/IDestructable.html">IDestructable</a>, <a href="../core/interfaces/ICloneable.html">ICloneable</a>, <a href="../core/interfaces/IResetable.html">IResetable</a></td>
    39. 

  39. </tr>
    40. 

  40. <tr>
    41. 

  41. <td class="classHeaderTableLabel">Implementors</td><td><a href="../load/AVM1Loader.html">AVM1Loader</a>, <a href="../load/BitmapDataLoader.html">BitmapDataLoader</a>, <a href="../load/BitmapLoader.html">BitmapLoader</a>, <a href="../load/ByteArrayLoader.html">ByteArrayLoader</a>, <a href="../load/CoreLoader.html">CoreLoader</a>, <a href="../load/DisplayLoader.html">DisplayLoader</a>, <a href="../load/SoundLoader.html">SoundLoader</a>, <a href="../load/StyleSheetLoader.html">StyleSheetLoader</a>, <a href="../load/SWFLoader.html">SWFLoader</a>, <a href="../load/URLDataLoader.html">URLDataLoader</a>, <a href="../load/VideoLoader.html">VideoLoader</a>, <a href="../load/XMLLoader.html">XMLLoader</a></td>
    42. 

  42. </tr>
    43. 

  43. </table>
    44. 

  44. <p></p>
    45. 

  45.   ILoader interface is the core interface for all loader classes defining the core loading functionality.
    46. 

  46.   <p></p>
    47. 

  47. <br>
    48. 

  48. <hr>
    49. 

  49. </div>
    50. 

  50. <a name="propertySummary"></a>
    51. 

  51. <div class="summarySection">
    52. 

  52. <div class="summaryTableTitle">Public Properties</div>
    53. 

  53. <table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
    54. 

  54. <tr>
    55. 

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

  56. </tr>
    57. 

  57. <tr class="">
    58. 

  58. <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]
    59. 

  59.    Indicates the number of loaded bytes from the loaders target file.</div>
    60. 

  60. </td><td class="summaryTableOwnerCol">Loadable</td>
    61. 

  61. </tr>
    62. 

  62. <tr class="">
    63. 

  63. <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]
    64. 

  64.    Indicates the number of total bytes of the loaders target file.</div>
    65. 

  65. </td><td class="summaryTableOwnerCol">Loadable</td>
    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="#bytesTotalPrefetcher">bytesTotalPrefetcher</a> : <a href="../load/BytesTotalPrefetcher.html">BytesTotalPrefetcher</a>
    69. 

  69. <div class="summaryTableDescription">[read-only]
    70. 

  70.    Returns the bytesTotal prefetcher instance.</div>
    71. 

  71. </td><td class="summaryTableOwnerCol">Loadable</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="#cancelable">cancelable</a> : Boolean<div class="summaryTableDescription">[read-only]
    75. 

  75.    Indicates whether the loader is cancelable.</div>
    76. 

  76. </td><td class="summaryTableOwnerCol">Loadable</td>
    77. 

  77. </tr>
    78. 

  78. <tr class="">
    79. 

  79. <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]
    80. 

  80.    </div>
    81. 

  81. </td><td class="summaryTableOwnerCol">Loadable</td>
    82. 

  82. </tr>
    83. 

  83. <tr class="">
    84. 

  84. <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]
    85. 

  85.    Indicates whether the loading process has finished.</div>
    86. 

  86. </td><td class="summaryTableOwnerCol">Loadable</td>
    87. 

  87. </tr>
    88. 

  88. <tr class="">
    89. 

  89. <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]
    90. 

  90.    Indicates whether the loading process is running.</div>
    91. 

  91. </td><td class="summaryTableOwnerCol">Loadable</td>
    92. 

  92. </tr>
    93. 

  93. <tr class="">
    94. 

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

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

  96. </td><td class="summaryTableOwnerCol">Loadable</td>
    97. 

  97. </tr>
    98. 

  98. <tr class="">
    99. 

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

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

  101. </td><td class="summaryTableOwnerCol">Loadable</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="#url">url</a> : String<div class="summaryTableDescription">
    105. 

  105.    Returns the url of the loader.</div>
    106. 

  106. </td><td class="summaryTableOwnerCol">Loadable</td>
    107. 

  107. </tr>
    108. 

  108. </table>
    109. 

  109. </div>
    110. 

  110. <a name="methodSummary"></a>
    111. 

  111. <div class="summarySection">
    112. 

  112. <div class="summaryTableTitle">Public Methods</div>
    113. 

  113. <div class="showHideLinks">
    114. 

  114. <div class="hideInheritedMethod" id="hideInheritedMethod">
    115. 

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

  116. </div>
    117. 

  117. <div class="showInheritedMethod" id="showInheritedMethod">
    118. 

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

  119. </div>
    120. 

  120. </div>
    121. 

  121. <table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
    122. 

  122. <tr>
    123. 

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

  124. </tr>
    125. 

  125. <tr class="hideInheritedMethod">
    126. 

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

  127. <div class="summarySignature">
    128. 

  128. <a class="signatureLink" href="../core/interfaces/ICloneable.html#clone()">clone</a>():Object</div>
    129. 

  129. <div class="summaryTableDescription">
    130. 

  130.    Creates a duplicate of the instance.</div>
    131. 

  131. </td><td class="summaryTableOwnerCol"><a href="../core/interfaces/ICloneable.html">ICloneable</a></td>
    132. 

  132. </tr>
    133. 

  133. <tr class="hideInheritedMethod">
    134. 

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

  135. <div class="summarySignature">
    136. 

  136. <a class="signatureLink" href="../core/interfaces/IDestructable.html#destruct()">destruct</a>(deepDestruct:Boolean = false):void</div>
    137. 

  137. <div class="summaryTableDescription">
    138. 

  138.    Destructs implementing instance of specified properties.</div>
    139. 

  139. </td><td class="summaryTableOwnerCol"><a href="../core/interfaces/IDestructable.html">IDestructable</a></td>
    140. 

  140. </tr>
    141. 

  141. <tr class="">
    142. 

  142. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
    143. 

  143. <div class="summarySignature">
    144. 

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

  145. <div class="summaryTableDescription">
    146. 

  146.    Returns the <code>URLRequest</code> of the loader.</div>
    147. 

  147. </td><td class="summaryTableOwnerCol">Loadable</td>
    148. 

  148. </tr>
    149. 

  149. <tr class="hideInheritedMethod">
    150. 

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

  151. <div class="summarySignature">
    152. 

  152. <a class="signatureLink" href="../core/interfaces/IDestructable.html#listDestructableProperties()">listDestructableProperties</a>():Array</div>
    153. 

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

  154.    Specifies an array of strings representing properties that are to be
    155. 

  155.    nullified or reset upon destruction.</div>
    156. 

  156. </td><td class="summaryTableOwnerCol"><a href="../core/interfaces/IDestructable.html">IDestructable</a></td>
    157. 

  157. </tr>
    158. 

  158. <tr class="">
    159. 

  159. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
    160. 

  160. <div class="summarySignature">
    161. 

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

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

  163.    Initiates the loading process of the loader.</div>
    164. 

  164. </td><td class="summaryTableOwnerCol">Loadable</td>
    165. 

  165. </tr>
    166. 

  166. <tr class="">
    167. 

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

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

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

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

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

  172. </td><td class="summaryTableOwnerCol">Loadable</td>
    173. 

  173. </tr>
    174. 

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

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

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

  177. <a class="signatureLink" href="../core/interfaces/IResetable.html#reset()">reset</a>():void</div>
    178. 

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

  179.    Resets the resetable instance to its construct state.</div>
    180. 

  180. </td><td class="summaryTableOwnerCol"><a href="../core/interfaces/IResetable.html">IResetable</a></td>
    181. 

  181. </tr>
    182. 

  182. <tr class="hideInheritedMethod">
    183. 

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

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

  185. <a class="signatureLink" href="../core/interfaces/ICoreInterface.html#toString()">toString</a>():String</div>
    186. 

  186. <div class="summaryTableDescription">
    187. 

  187.    Returns the string representation of the instance.</div>
    188. 

  188. </td><td class="summaryTableOwnerCol"><a href="../core/interfaces/ICoreInterface.html">ICoreInterface</a></td>
    189. 

  189. </tr>
    190. 

  190. </table>
    191. 

  191. </div>
    192. 

  192. <script type="text/javascript" language="javascript">
    193. 

  193. <!--
    194. 

  194. showHideInherited();
    195. 

  195. --></script>
    196. 

  196. <div class="MainContent">
    197. 

  197. <a name="propertyDetail"></a>
    198. 

  198. <div class="detailSectionHeader">Property detail</div>
    199. 

  199. <a name="bytesLoaded"></a>
    200. 

  200. <table cellspacing="0" cellpadding="0" class="detailHeader">
    201. 

  201. <tr>
    202. 

  202. <td class="detailHeaderName">bytesLoaded</td><td class="detailHeaderType">property</td>
    203. 

  203. </tr>
    204. 

  204. </table>
    205. 

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

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

  207.    Indicates the number of loaded bytes from the loaders target file.
    208. 

  208.    </p><span class="label">Implementation</span>
    209. 

  209. <br>
    210. 

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

  211. <br>
    212. 

  212. </div>
    213. 

  213. <a name="bytesTotal"></a>
    214. 

  214. <table cellspacing="0" cellpadding="0" class="detailHeader">
    215. 

  215. <tr>
    216. 

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

  217. </tr>
    218. 

  218. </table>
    219. 

  219. <div class="detailBody">
    220. 

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

  221.    Indicates the number of total bytes of the loaders target file.
    222. 

  222.    </p><span class="label">Implementation</span>
    223. 

  223. <br>
    224. 

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

  225. <br>
    226. 

  226. </div>
    227. 

  227. <a name="bytesTotalPrefetcher"></a>
    228. 

  228. <table cellspacing="0" cellpadding="0" class="detailHeader">
    229. 

  229. <tr>
    230. 

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

  231. </tr>
    232. 

  232. </table>
    233. 

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

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

  235.    Returns the bytesTotal prefetcher instance.
    236. 

  236.    </p><span class="label">Implementation</span>
    237. 

  237. <br>
    238. 

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

  239. <br>
    240. 

  240. </div>
    241. 

  241. <a name="cancelable"></a>
    242. 

  242. <table cellspacing="0" cellpadding="0" class="detailHeader">
    243. 

  243. <tr>
    244. 

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

  245. </tr>
    246. 

  246. </table>
    247. 

  247. <div class="detailBody">
    248. 

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

  249.    Indicates whether the loader is cancelable. Cancelable loaders may be interrupted while loading.
    250. 

  250.    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
    251. 

  251.    the <code>load()</code> method again.
    252. 

  252.    
    253. 

  253.    </p><span class="label">Implementation</span>
    254. 

  254. <br>
    255. 

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

  256. <br>
    257. 

  257. <p>
    258. 

  258. <span class="label">See also</span>
    259. 

  259. </p>
    260. 

  260. <div class="seeAlso">org.tractionas3.core.interfaces.Cancelable;<br>
    261. 

  261. <a href="../load/Loadable.html#reset()" target="">reset()</a>
    262. 

  262. <br>load()</div>
    263. 

  263. </div>
    264. 

  264. <a name="data"></a>
    265. 

  265. <table cellspacing="0" cellpadding="0" class="detailHeader">
    266. 

  266. <tr>
    267. 

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

  268. </tr>
    269. 

  269. </table>
    270. 

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

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

  272.    </p><span class="label">Implementation</span>
    273. 

  273. <br>
    274. 

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

  275. <br>
    276. 

  276. <p>
    277. 

  277. <span class="label">See also</span>
    278. 

  278. </p>
    279. 

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

  280. <a href="../load/Loadable.html#loaded" target="">loaded</a>
    281. 

  281. <br>
    282. 

  282. <a href="../load/Loadable.html#loading" target="">loading</a>
    283. 

  283. </div>
    284. 

  284. </div>
    285. 

  285. <a name="loaded"></a>
    286. 

  286. <table cellspacing="0" cellpadding="0" class="detailHeader">
    287. 

  287. <tr>
    288. 

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

  289. </tr>
    290. 

  290. </table>
    291. 

  291. <div class="detailBody">
    292. 

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

  293.    Indicates whether the loading process has finished.
    294. 

  294.    </p><span class="label">Implementation</span>
    295. 

  295. <br>
    296. 

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

  297. <br>
    298. 

  298. </div>
    299. 

  299. <a name="loading"></a>
    300. 

  300. <table cellspacing="0" cellpadding="0" class="detailHeader">
    301. 

  301. <tr>
    302. 

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

  303. </tr>
    304. 

  304. </table>
    305. 

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

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

  307.    Indicates whether the loading process is running.
    308. 

  308.    </p><span class="label">Implementation</span>
    309. 

  309. <br>
    310. 

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

  311. <br>
    312. 

  312. </div>
    313. 

  313. <a name="loadTime"></a>
    314. 

  314. <table cellspacing="0" cellpadding="0" class="detailHeader">
    315. 

  315. <tr>
    316. 

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

  317. </tr>
    318. 

  318. </table>
    319. 

  319. <div class="detailBody">
    320. 

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

  321.    Indicates, in milliseconds, the time elapsed from loading start to loading completion.
    322. 

  322.    </p><span class="label">Implementation</span>
    323. 

  323. <br>
    324. 

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

  325. <br>
    326. 

  326. </div>
    327. 

  327. <a name="progress"></a>
    328. 

  328. <table cellspacing="0" cellpadding="0" class="detailHeader">
    329. 

  329. <tr>
    330. 

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

  331. </tr>
    332. 

  332. </table>
    333. 

  333. <div class="detailBody">
    334. 

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

  335.    Returns a value between zero and one indicating the current loading progress of the loader.
    336. 

  336.    </p><span class="label">Implementation</span>
    337. 

  337. <br>
    338. 

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

  339. <br>
    340. 

  340. </div>
    341. 

  341. <a name="url"></a>
    342. 

  342. <table cellspacing="0" cellpadding="0" class="detailHeader">
    343. 

  343. <tr>
    344. 

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

  345. </tr>
    346. 

  346. </table>
    347. 

  347. <div class="detailBody">
    348. 

  348. <code>url:String</code>&nbsp;&nbsp;[read-write]<p>
    349. 

  349.    Returns the url of the loader. The url property cannot be changed.
    350. 

  350.    </p><span class="label">Implementation</span>
    351. 

  351. <br>
    352. 

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

  353. <br>
    354. 

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

  355. <br>
    356. 

  356. </div>
    357. 

  357. <a name="methodDetail"></a>
    358. 

  358. <div class="detailSectionHeader">Method detail</div>
    359. 

  359. <a name="getURLRequest()"></a>
    360. 

  360. <table cellspacing="0" cellpadding="0" class="detailHeader">
    361. 

  361. <tr>
    362. 

  362. <td class="detailHeaderName">getURLRequest</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
    363. 

  363. </tr>
    364. 

  364. </table>
    365. 

  365. <div class="detailBody">
    366. 

  366. <code>public function getURLRequest():URLRequest</code><p>
    367. 

  367.    Returns the <code>URLRequest</code> of the loader. The <code>URLRequest</code> cannot be changed.
    368. 

  368.    </p><p></p>
    369. 

  369. <span class="label">Returns</span>
    370. 

  370. <table border="0" cellspacing="0" cellpadding="0">
    371. 

  371. <tr>
    372. 

  372. <td width="20"></td><td><code>URLRequest</code></td>
    373. 

  373. </tr>
    374. 

  374. </table>
    375. 

  375. </div>
    376. 

  376. <a name="load()"></a>
    377. 

  377. <table cellspacing="0" cellpadding="0" class="detailHeader">
    378. 

  378. <tr>
    379. 

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

  380. </tr>
    381. 

  381. </table>
    382. 

  382. <div class="detailBody">
    383. 

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

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

  385.    </p><span class="label">Parameters</span>
    386. 

  386. <table border="0" cellspacing="0" cellpadding="0">
    387. 

  387. <tr>
    388. 

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

  389. </tr>
    390. 

  390. </table>
    391. 

  391. </div>
    392. 

  392. <a name="prefetchBytesTotal()"></a>
    393. 

  393. <table cellspacing="0" cellpadding="0" class="detailHeader">
    394. 

  394. <tr>
    395. 

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

  396. </tr>
    397. 

  397. </table>
    398. 

  398. <div class="detailBody">
    399. 

  399. <code>public function prefetchBytesTotal():void</code><p>
    400. 

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

  401.    
    402. 

  402.    </p><p>
    403. 

  403. <span class="label">See also</span>
    404. 

  404. </p>
    405. 

  405. <div class="seeAlso">
    406. 

  406. <a href="../events/LoaderEvent.html#BYTESTOTAL_PREFETCHED" target="">org.tractionas3.events.LoaderEvent.BYTESTOTAL_PREFETCHED</a>
    407. 

  407. </div>
    408. 

  408. </div>
    409. 

  409. <br>
    410. 

  410. <br>
    411. 

  411. <hr>
    412. 

  412. <br>
    413. 

  413. <p></p>
    414. 

  414. <center class="copyright"> 
    415. 

  415. </center>
    416. 

  416. </div>
    417. 

  417. </body>
    418. 

  418. </html>
    419. 

  419. <!-- -->
    420. 

  420.