PageRenderTime 28ms CodeModel.GetById 0ms RepoModel.GetById 0ms app.codeStats 0ms

/docs/org/tractionas3/load/ILoadable.html

http://tractionas3.googlecode.com/
HTML | 472 lines | 460 code | 3 blank | 9 comment | 0 complexity | 6e760a6415aad08849c2dcf2e66ceb33 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="ILoadable,org.tractionas3.load.ILoadable,bytesLoaded,bytesTotal,bytesTotalPrefetcher,cancelable,data,loadTime,loaded,loading,name,priority,progress,url,getURLRequest,load,prefetchBytesTotal" name="keywords">
    8. 

  8. <title>org.tractionas3.load.ILoadable</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 = 'ILoadable - 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/ILoadable.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;ILoadable</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 ILoadable"); 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 ILoadable 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="loaders/AVM1Loader.html">AVM1Loader</a>, <a href="loaders/BitmapDataLoader.html">BitmapDataLoader</a>, <a href="loaders/BitmapLoader.html">BitmapLoader</a>, <a href="loaders/ByteArrayLoader.html">ByteArrayLoader</a>, <a href="loaders/DisplayLoader.html">DisplayLoader</a>, <a href="loaders/LoaderCore.html">LoaderCore</a>, <a href="loaders/SoundLoader.html">SoundLoader</a>, <a href="loaders/StyleSheetLoader.html">StyleSheetLoader</a>, <a href="loaders/SWFLoader.html">SWFLoader</a>, <a href="loaders/URLDataLoader.html">URLDataLoader</a>, <a href="loaders/VideoLoader.html">VideoLoader</a>, <a href="loaders/XMLLoader.html">XMLLoader</a></td>
    42. 

  42. </tr>
    43. 

  43. </table>
    44. 

  44. <p></p>
    45. 

  45.   ILoadable 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">ILoadable</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">ILoadable</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="loaders/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">ILoadable</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">ILoadable</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">ILoadable</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">ILoadable</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">ILoadable</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">ILoadable</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="#name">name</a> : String<div class="summaryTableDescription">
    100. 

  100.    Specifies the name of the loader.</div>
    101. 

  101. </td><td class="summaryTableOwnerCol">ILoadable</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="#priority">priority</a> : uint<div class="summaryTableDescription">
    105. 

  105.    Defines the priority of the loader.</div>
    106. 

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

  107. </tr>
    108. 

  108. <tr class="">
    109. 

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

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

  111. </td><td class="summaryTableOwnerCol">ILoadable</td>
    112. 

  112. </tr>
    113. 

  113. <tr class="">
    114. 

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

  115.    Returns the url of the loader.</div>
    116. 

  116. </td><td class="summaryTableOwnerCol">ILoadable</td>
    117. 

  117. </tr>
    118. 

  118. </table>
    119. 

  119. </div>
    120. 

  120. <a name="methodSummary"></a>
    121. 

  121. <div class="summarySection">
    122. 

  122. <div class="summaryTableTitle">Public Methods</div>
    123. 

  123. <div class="showHideLinks">
    124. 

  124. <div class="hideInheritedMethod" id="hideInheritedMethod">
    125. 

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

  126. </div>
    127. 

  127. <div class="showInheritedMethod" id="showInheritedMethod">
    128. 

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

  129. </div>
    130. 

  130. </div>
    131. 

  131. <table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
    132. 

  132. <tr>
    133. 

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

  134. </tr>
    135. 

  135. <tr class="hideInheritedMethod">
    136. 

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

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

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

  139. </div>
    140. 

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

  141.    Creates a duplicate of the instance.</div>
    142. 

  142. </td><td class="summaryTableOwnerCol"><a href="../core/interfaces/ICloneable.html">ICloneable</a></td>
    143. 

  143. </tr>
    144. 

  144. <tr class="hideInheritedMethod">
    145. 

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

  146. <div class="summarySignature">
    147. 

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

  148. <div class="summaryTableDescription">
    149. 

  149.    Destructs implementing instance of specified properties.</div>
    150. 

  150. </td><td class="summaryTableOwnerCol"><a href="../core/interfaces/IDestructable.html">IDestructable</a></td>
    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="#getURLRequest()">getURLRequest</a>():URLRequest</div>
    156. 

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

  157.    Returns the <code>URLRequest</code> of the loader.</div>
    158. 

  158. </td><td class="summaryTableOwnerCol">ILoadable</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="../core/interfaces/IDestructable.html#listDestructableProperties()">listDestructableProperties</a>():Array</div>
    164. 

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

  165.    Specifies an array of strings representing properties that are to be
    166. 

  166.    nullified or reset upon destruction.</div>
    167. 

  167. </td><td class="summaryTableOwnerCol"><a href="../core/interfaces/IDestructable.html">IDestructable</a></td>
    168. 

  168. </tr>
    169. 

  169. <tr class="">
    170. 

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

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

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

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

  174.    Initiates the loading process of the loader.</div>
    175. 

  175. </td><td class="summaryTableOwnerCol">ILoadable</td>
    176. 

  176. </tr>
    177. 

  177. <tr class="">
    178. 

  178. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
    179. 

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

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

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

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

  183. </td><td class="summaryTableOwnerCol">ILoadable</td>
    184. 

  184. </tr>
    185. 

  185. <tr class="hideInheritedMethod">
    186. 

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

  187. <div class="summarySignature">
    188. 

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

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

  190.    Resets the resetable instance to its construct state.</div>
    191. 

  191. </td><td class="summaryTableOwnerCol"><a href="../core/interfaces/IResetable.html">IResetable</a></td>
    192. 

  192. </tr>
    193. 

  193. <tr class="hideInheritedMethod">
    194. 

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

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

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

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

  198.    Returns the string representation of the instance.</div>
    199. 

  199. </td><td class="summaryTableOwnerCol"><a href="../core/interfaces/ICoreInterface.html">ICoreInterface</a></td>
    200. 

  200. </tr>
    201. 

  201. </table>
    202. 

  202. </div>
    203. 

  203. <script type="text/javascript" language="javascript">
    204. 

  204. <!--
    205. 

  205. showHideInherited();
    206. 

  206. --></script>
    207. 

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

  208. <a name="propertyDetail"></a>
    209. 

  209. <div class="detailSectionHeader">Property detail</div>
    210. 

  210. <a name="bytesLoaded"></a>
    211. 

  211. <table cellspacing="0" cellpadding="0" class="detailHeader">
    212. 

  212. <tr>
    213. 

  213. <td class="detailHeaderName">bytesLoaded</td><td class="detailHeaderType">property</td>
    214. 

  214. </tr>
    215. 

  215. </table>
    216. 

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

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

  218.    Indicates the number of loaded bytes from the loaders target file.
    219. 

  219.    </p><span class="label">Implementation</span>
    220. 

  220. <br>
    221. 

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

  222. <br>
    223. 

  223. </div>
    224. 

  224. <a name="bytesTotal"></a>
    225. 

  225. <table cellspacing="0" cellpadding="0" class="detailHeader">
    226. 

  226. <tr>
    227. 

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

  228. </tr>
    229. 

  229. </table>
    230. 

  230. <div class="detailBody">
    231. 

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

  232.    Indicates the number of total bytes of the loaders target file.
    233. 

  233.    </p><span class="label">Implementation</span>
    234. 

  234. <br>
    235. 

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

  236. <br>
    237. 

  237. </div>
    238. 

  238. <a name="bytesTotalPrefetcher"></a>
    239. 

  239. <table cellspacing="0" cellpadding="0" class="detailHeader">
    240. 

  240. <tr>
    241. 

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

  242. </tr>
    243. 

  243. </table>
    244. 

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

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

  246.    Returns the bytesTotal prefetcher instance.
    247. 

  247.    </p><span class="label">Implementation</span>
    248. 

  248. <br>
    249. 

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

  250. <br>
    251. 

  251. </div>
    252. 

  252. <a name="cancelable"></a>
    253. 

  253. <table cellspacing="0" cellpadding="0" class="detailHeader">
    254. 

  254. <tr>
    255. 

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

  256. </tr>
    257. 

  257. </table>
    258. 

  258. <div class="detailBody">
    259. 

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

  260.    Indicates whether the loader is cancelable. Cancelable loaders may be interrupted while loading.
    261. 

  261.    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
    262. 

  262.    the <code>load()</code> method again.
    263. 

  263.    
    264. 

  264.    </p><span class="label">Implementation</span>
    265. 

  265. <br>
    266. 

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

  267. <br>
    268. 

  268. <p>
    269. 

  269. <span class="label">See also</span>
    270. 

  270. </p>
    271. 

  271. <div class="seeAlso">org.tractionas3.core.interfaces.Cancelable;<br>reset()<br>load()</div>
    272. 

  272. </div>
    273. 

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

  274. <table cellspacing="0" cellpadding="0" class="detailHeader">
    275. 

  275. <tr>
    276. 

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

  277. </tr>
    278. 

  278. </table>
    279. 

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

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

  281.    </p><span class="label">Implementation</span>
    282. 

  282. <br>
    283. 

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

  284. <br>
    285. 

  285. <p>
    286. 

  286. <span class="label">See also</span>
    287. 

  287. </p>
    288. 

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

  289. <a href="../load/ILoadable.html#loaded" target="">loaded</a>
    290. 

  290. <br>
    291. 

  291. <a href="../load/ILoadable.html#loading" target="">loading</a>
    292. 

  292. </div>
    293. 

  293. </div>
    294. 

  294. <a name="loaded"></a>
    295. 

  295. <table cellspacing="0" cellpadding="0" class="detailHeader">
    296. 

  296. <tr>
    297. 

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

  298. </tr>
    299. 

  299. </table>
    300. 

  300. <div class="detailBody">
    301. 

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

  302.    Indicates whether the loading process has finished.
    303. 

  303.    </p><span class="label">Implementation</span>
    304. 

  304. <br>
    305. 

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

  306. <br>
    307. 

  307. </div>
    308. 

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

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

  310. <tr>
    311. 

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

  312. </tr>
    313. 

  313. </table>
    314. 

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

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

  316.    Indicates whether the loading process is running.
    317. 

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

  318. <br>
    319. 

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

  320. <br>
    321. 

  321. </div>
    322. 

  322. <a name="loadTime"></a>
    323. 

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

  324. <tr>
    325. 

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

  326. </tr>
    327. 

  327. </table>
    328. 

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

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

  330.    Indicates, in milliseconds, the time elapsed from loading start to loading completion.
    331. 

  331.    </p><span class="label">Implementation</span>
    332. 

  332. <br>
    333. 

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

  334. <br>
    335. 

  335. </div>
    336. 

  336. <a name="name"></a>
    337. 

  337. <table cellspacing="0" cellpadding="0" class="detailHeader">
    338. 

  338. <tr>
    339. 

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

  340. </tr>
    341. 

  341. </table>
    342. 

  342. <div class="detailBody">
    343. 

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

  344.    Specifies the name of the loader.
    345. 

  345.    A loader name must be unique.
    346. 

  346.    </p><span class="label">Implementation</span>
    347. 

  347. <br>
    348. 

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

  349. <br>
    350. 

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

  351. <br>
    352. 

  352. </div>
    353. 

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

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

  355. <tr>
    356. 

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

  361.    Defines the priority of the loader.
    362. 

  362.    Loaders with a high priority value will be loaded before loaders with a higher priority value
    363. 

  363.    in a loader queue.
    364. 

  364.    
    365. 

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

  366. <br>
    367. 

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

  368. <br>
    369. 

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

  370. <br>
    371. 

  371. <p>
    372. 

  372. <span class="label">See also</span>
    373. 

  373. </p>
    374. 

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

  375. <a href="../load/LoaderQueue.html" target="">org.tractionas3.load.LoaderQueue</a>
    376. 

  376. <br>
    377. 

  377. <a href="../load/LoadManager.html" target="">org.tractionas3.load.LoadManager</a>
    378. 

  378. </div>
    379. 

  379. </div>
    380. 

  380. <a name="progress"></a>
    381. 

  381. <table cellspacing="0" cellpadding="0" class="detailHeader">
    382. 

  382. <tr>
    383. 

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

  384. </tr>
    385. 

  385. </table>
    386. 

  386. <div class="detailBody">
    387. 

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

  388.    Returns a value between zero and one indicating the current loading progress of the loader.
    389. 

  389.    </p><span class="label">Implementation</span>
    390. 

  390. <br>
    391. 

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

  392. <br>
    393. 

  393. </div>
    394. 

  394. <a name="url"></a>
    395. 

  395. <table cellspacing="0" cellpadding="0" class="detailHeader">
    396. 

  396. <tr>
    397. 

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

  398. </tr>
    399. 

  399. </table>
    400. 

  400. <div class="detailBody">
    401. 

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

  402.    Returns the url of the loader. The url property cannot be changed.
    403. 

  403.    </p><span class="label">Implementation</span>
    404. 

  404. <br>
    405. 

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

  406. <br>
    407. 

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

  408. <br>
    409. 

  409. </div>
    410. 

  410. <a name="methodDetail"></a>
    411. 

  411. <div class="detailSectionHeader">Method detail</div>
    412. 

  412. <a name="getURLRequest()"></a>
    413. 

  413. <table cellspacing="0" cellpadding="0" class="detailHeader">
    414. 

  414. <tr>
    415. 

  415. <td class="detailHeaderName">getURLRequest</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
    416. 

  416. </tr>
    417. 

  417. </table>
    418. 

  418. <div class="detailBody">
    419. 

  419. <code>public function getURLRequest():URLRequest</code><p>
    420. 

  420.    Returns the <code>URLRequest</code> of the loader. The <code>URLRequest</code> cannot be changed.
    421. 

  421.    </p><p></p>
    422. 

  422. <span class="label">Returns</span>
    423. 

  423. <table border="0" cellspacing="0" cellpadding="0">
    424. 

  424. <tr>
    425. 

  425. <td width="20"></td><td><code>URLRequest</code></td>
    426. 

  426. </tr>
    427. 

  427. </table>
    428. 

  428. </div>
    429. 

  429. <a name="load()"></a>
    430. 

  430. <table cellspacing="0" cellpadding="0" class="detailHeader">
    431. 

  431. <tr>
    432. 

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

  433. </tr>
    434. 

  434. </table>
    435. 

  435. <div class="detailBody">
    436. 

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

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

  438.    </p><span class="label">Parameters</span>
    439. 

  439. <table border="0" cellspacing="0" cellpadding="0">
    440. 

  440. <tr>
    441. 

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

  442. </tr>
    443. 

  443. </table>
    444. 

  444. </div>
    445. 

  445. <a name="prefetchBytesTotal()"></a>
    446. 

  446. <table cellspacing="0" cellpadding="0" class="detailHeader">
    447. 

  447. <tr>
    448. 

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

  449. </tr>
    450. 

  450. </table>
    451. 

  451. <div class="detailBody">
    452. 

  452. <code>public function prefetchBytesTotal():void</code><p>
    453. 

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

  454.    
    455. 

  455.    </p><p>
    456. 

  456. <span class="label">See also</span>
    457. 

  457. </p>
    458. 

  458. <div class="seeAlso">
    459. 

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

  460. </div>
    461. 

  461. </div>
    462. 

  462. <br>
    463. 

  463. <br>
    464. 

  464. <hr>
    465. 

  465. <br>
    466. 

  466. <p></p>
    467. 

  467. <center class="copyright"> 
    468. 

  468. </center>
    469. 

  469. </div>
    470. 

  470. </body>
    471. 

  471. </html>
    472. 

  472. <!-- -->
    473. 

  473.