PageRenderTime 48ms CodeModel.GetById 17ms RepoModel.GetById 1ms app.codeStats 0ms

/docs/org/tractionas3/load/AbstractLoader.html

http://tractionas3.googlecode.com/
HTML | 681 lines | 672 code | 0 blank | 9 comment | 0 complexity | e7064f4cc347583b24dea62d913f882b 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"
    6. 

  6. 	media="screen">
    7. 

  7. <link rel="stylesheet" href="../../../print.css" type="text/css"
    8. 

  8. 	media="print">
    9. 

  9. <meta
    10. 

  10. 	content="AbstractLoader,org.tractionas3.load.AbstractLoader,name,priority,bytesLoaded,bytesTotal,bytesTotalPrefetcher,cancelable,data,loadTime,loaded,loading,progress,clone,getURLRequest,load,prefetchBytesTotal,reset,toString"
    11. 

  11. 	name="keywords">
    12. 

  12. <title>org.tractionas3.load.AbstractLoader</title>
    13. 

  13. </head>
    14. 

  14. <body>
    15. 

  15. <script type="text/javascript" language="javascript"
    16. 

  16. 	src="../../../asdoc.js"></script>
    17. 

  17. <script type="text/javascript" language="javascript"
    18. 

  18. 	src="../../../cookies.js"></script>
    19. 

  19. <script type="text/javascript" language="javascript">
    20. 

  20. <!--
    21. 

  21. 				asdocTitle = 'AbstractLoader - TractionAS3 Framework Documentation';
    22. 

  22. 				var baseRef = '../../../';
    23. 

  23. 				window.onload = configPage;
    24. 

  24. 			--></script>
    25. 

  25. <table style="display: none" id="titleTable" cellspacing="0"
    26. 

  26. 	cellpadding="0" class="titleTable">
    27. 

  27. 	<tr>
    28. 

  28. 		<td align="left" class="titleTableTitle">TractionAS3 Framework
    29. 

  29. 		Documentation</td>
    30. 

  30. 		<td align="right" class="titleTableTopNav"><a
    31. 

  31. 			onclick="loadClassListFrame('../../../all-classes.html')"
    32. 

  32. 			href="../../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a
    33. 

  33. 			onclick="loadClassListFrame('../../../all-classes.html')"
    34. 

  34. 			href="../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a
    35. 

  35. 			onclick="loadClassListFrame('../../../index-list.html')"
    36. 

  36. 			href="../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a
    37. 

  37. 			href="../../../index.html?org/tractionas3/load/AbstractLoader.html&amp;org/tractionas3/load/class-list.html"
    38. 

  38. 			id="framesLink1">Frames</a><a
    39. 

  39. 			onclick="parent.location=document.location" href=""
    40. 

  40. 			style="display: none" id="noFramesLink1">No&nbsp;Frames</a></td>
    41. 

  41. 		<td rowspan="3" align="right" class="titleTableLogo"><img
    42. 

  42. 			alt="Adobe Logo" title="Adobe Logo" class="logoImage"
    43. 

  43. 			src="../../../images/logo.jpg"></td>
    44. 

  44. 	</tr>
    45. 

  45. 	<tr class="titleTableRow2">
    46. 

  46. 		<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;AbstractLoader</td>
    47. 

  47. 		<td align="right" id="subNav" class="titleTableSubNav"><a
    48. 

  48. 			href="#propertySummary">Properties</a>&nbsp;| <a
    49. 

  49. 			href="#methodSummary">Methods</a></td>
    50. 

  50. 	</tr>
    51. 

  51. 	<tr class="titleTableRow3">
    52. 

  52. 		<td colspan="2">&nbsp;</td>
    53. 

  53. 	</tr>
    54. 

  54. </table>
    55. 

  55. <script type="text/javascript" language="javascript">
    56. 

  56. <!--
    57. 

  57. if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class AbstractLoader"); titleBar_setSubNav(false,true,false,false,false,false,true,false,false,false,false,false,false,false);}
    58. 

  58. --></script>
    59. 

  59. <div class="MainContent">
    60. 

  60. <table cellspacing="0" cellpadding="0" class="classHeaderTable">
    61. 

  61. 	<tr>
    62. 

  62. 		<td class="classHeaderTableLabel">Package</td>
    63. 

  63. 		<td><a onclick="javascript:loadClassListFrame('class-list.html')"
    64. 

  64. 			href="package-detail.html">org.tractionas3.load</a></td>
    65. 

  65. 	</tr>
    66. 

  66. 	<tr>
    67. 

  67. 		<td class="classHeaderTableLabel">Class</td>
    68. 

  68. 		<td class="classSignature">public class AbstractLoader</td>
    69. 

  69. 	</tr>
    70. 

  70. 	<tr>
    71. 

  71. 		<td class="classHeaderTableLabel">Inheritance</td>
    72. 

  72. 		<td class="inheritanceList">AbstractLoader <img
    73. 

  73. 			class="inheritArrow" alt="Inheritance" title="Inheritance"
    74. 

  74. 			src="../../../images/inherit-arrow.gif"> <a
    75. 

  75. 			href="../events/WeakEventDispatcher.html">WeakEventDispatcher</a> <img
    76. 

  76. 			class="inheritArrow" alt="Inheritance" title="Inheritance"
    77. 

  77. 			src="../../../images/inherit-arrow.gif">
    78. 

  78. 		flash.events.EventDispatcher</td>
    79. 

  79. 	</tr>
    80. 

  80. 	<tr>
    81. 

  81. 		<td class="classHeaderTableLabel">Implements</td>
    82. 

  82. 		<td><a href="Loadable.html">Loadable</a></td>
    83. 

  83. 	</tr>
    84. 

  84. 	<tr>
    85. 

  85. 		<td class="classHeaderTableLabel">Subclasses</td>
    86. 

  86. 		<td><a href="../load/DisplayLoader.html">DisplayLoader</a>, <a
    87. 

  87. 			href="../load/SoundLoader.html">SoundLoader</a>, <a
    88. 

  88. 			href="../load/URLDataLoader.html">URLDataLoader</a>, <a
    89. 

  89. 			href="../load/VideoLoader.html">VideoLoader</a></td>
    90. 

  90. 	</tr>
    91. 

  91. </table>
    92. 

  92. <p></p>
    93. 

  93. AbstractLoader class is the base class of all loader classes.
    94. 

  94. <p></p>
    95. 

  95. <br>
    96. 

  96. <hr>
    97. 

  97. </div>
    98. 

  98. <a name="propertySummary"></a>
    99. 

  99. <div class="summarySection">
    100. 

  100. <div class="summaryTableTitle">Public Properties</div>
    101. 

  101. <table id="summaryTableProperty" class="summaryTable " cellpadding="3"
    102. 

  102. 	cellspacing="0">
    103. 

  103. 	<tr>
    104. 

  104. 		<th>&nbsp;</th>
    105. 

  105. 		<th colspan="2">Property</th>
    106. 

  106. 		<th class="summaryTableOwnerCol">Defined&nbsp;by</th>
    107. 

  107. 	</tr>
    108. 

  108. 	<tr class="">
    109. 

  109. 		<td class="summaryTablePaddingCol">&nbsp;</td>
    110. 

  110. 		<td class="summaryTableInheritanceCol">&nbsp;</td>
    111. 

  111. 		<td class="summaryTableSignatureCol"><a class="signatureLink"
    112. 

  112. 			href="#bytesLoaded">bytesLoaded</a> : uint
    113. 

  113. 		<div class="summaryTableDescription">[read-only] Indicates the
    114. 

  114. 		number of loaded bytes from the loaders target file.</div>
    115. 

  115. 		</td>
    116. 

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

  117. 	</tr>
    118. 

  118. 	<tr class="">
    119. 

  119. 		<td class="summaryTablePaddingCol">&nbsp;</td>
    120. 

  120. 		<td class="summaryTableInheritanceCol">&nbsp;</td>
    121. 

  121. 		<td class="summaryTableSignatureCol"><a class="signatureLink"
    122. 

  122. 			href="#bytesTotal">bytesTotal</a> : int
    123. 

  123. 		<div class="summaryTableDescription">[read-only] Indicates the
    124. 

  124. 		number of total bytes of the loaders target file.</div>
    125. 

  125. 		</td>
    126. 

  126. 		<td class="summaryTableOwnerCol">AbstractLoader</td>
    127. 

  127. 	</tr>
    128. 

  128. 	<tr class="">
    129. 

  129. 		<td class="summaryTablePaddingCol">&nbsp;</td>
    130. 

  130. 		<td class="summaryTableInheritanceCol">&nbsp;</td>
    131. 

  131. 		<td class="summaryTableSignatureCol"><a class="signatureLink"
    132. 

  132. 			href="#bytesTotalPrefetcher">bytesTotalPrefetcher</a> : <a
    133. 

  133. 			href="../load/BytesTotalPrefetcher.html">BytesTotalPrefetcher</a>
    134. 

  134. 		<div class="summaryTableDescription">[read-only] Returns the
    135. 

  135. 		bytesTotal prefetcher instance.</div>
    136. 

  136. 		</td>
    137. 

  137. 		<td class="summaryTableOwnerCol">AbstractLoader</td>
    138. 

  138. 	</tr>
    139. 

  139. 	<tr class="">
    140. 

  140. 		<td class="summaryTablePaddingCol">&nbsp;</td>
    141. 

  141. 		<td class="summaryTableInheritanceCol">&nbsp;</td>
    142. 

  142. 		<td class="summaryTableSignatureCol"><a class="signatureLink"
    143. 

  143. 			href="#cancelable">cancelable</a> : Boolean
    144. 

  144. 		<div class="summaryTableDescription">[read-only] Indicates
    145. 

  145. 		whether the loader is cancelable.</div>
    146. 

  146. 		</td>
    147. 

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

  148. 	</tr>
    149. 

  149. 	<tr class="">
    150. 

  150. 		<td class="summaryTablePaddingCol">&nbsp;</td>
    151. 

  151. 		<td class="summaryTableInheritanceCol">&nbsp;</td>
    152. 

  152. 		<td class="summaryTableSignatureCol"><a class="signatureLink"
    153. 

  153. 			href="#data">data</a> : *
    154. 

  154. 		<div class="summaryTableDescription">[read-only] Returns the
    155. 

  155. 		loaded data of the loader.</div>
    156. 

  156. 		</td>
    157. 

  157. 		<td class="summaryTableOwnerCol">AbstractLoader</td>
    158. 

  158. 	</tr>
    159. 

  159. 	<tr class="">
    160. 

  160. 		<td class="summaryTablePaddingCol">&nbsp;</td>
    161. 

  161. 		<td class="summaryTableInheritanceCol">&nbsp;</td>
    162. 

  162. 		<td class="summaryTableSignatureCol"><a class="signatureLink"
    163. 

  163. 			href="#loaded">loaded</a> : Boolean
    164. 

  164. 		<div class="summaryTableDescription">[read-only] Indicates
    165. 

  165. 		whether the loading process has finished.</div>
    166. 

  166. 		</td>
    167. 

  167. 		<td class="summaryTableOwnerCol">AbstractLoader</td>
    168. 

  168. 	</tr>
    169. 

  169. 	<tr class="">
    170. 

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

  171. 		<td class="summaryTableInheritanceCol">&nbsp;</td>
    172. 

  172. 		<td class="summaryTableSignatureCol"><a class="signatureLink"
    173. 

  173. 			href="#loading">loading</a> : Boolean
    174. 

  174. 		<div class="summaryTableDescription">[read-only] Indicates
    175. 

  175. 		whether the loading process is running.</div>
    176. 

  176. 		</td>
    177. 

  177. 		<td class="summaryTableOwnerCol">AbstractLoader</td>
    178. 

  178. 	</tr>
    179. 

  179. 	<tr class="">
    180. 

  180. 		<td class="summaryTablePaddingCol">&nbsp;</td>
    181. 

  181. 		<td class="summaryTableInheritanceCol">&nbsp;</td>
    182. 

  182. 		<td class="summaryTableSignatureCol"><a class="signatureLink"
    183. 

  183. 			href="#loadTime">loadTime</a> : uint
    184. 

  184. 		<div class="summaryTableDescription">[read-only] Indicates, in
    185. 

  185. 		milliseconds, the time elapsed from loading start to loading
    186. 

  186. 		completion.</div>
    187. 

  187. 		</td>
    188. 

  188. 		<td class="summaryTableOwnerCol">AbstractLoader</td>
    189. 

  189. 	</tr>
    190. 

  190. 	<tr class="">
    191. 

  191. 		<td class="summaryTablePaddingCol">&nbsp;</td>
    192. 

  192. 		<td class="summaryTableInheritanceCol">&nbsp;</td>
    193. 

  193. 		<td class="summaryTableSignatureCol"><a class="signatureLink"
    194. 

  194. 			href="#name">name</a> : String
    195. 

  195. 		<div class="summaryTableDescription">Specifies the name of the
    196. 

  196. 		loader.</div>
    197. 

  197. 		</td>
    198. 

  198. 		<td class="summaryTableOwnerCol">AbstractLoader</td>
    199. 

  199. 	</tr>
    200. 

  200. 	<tr class="">
    201. 

  201. 		<td class="summaryTablePaddingCol">&nbsp;</td>
    202. 

  202. 		<td class="summaryTableInheritanceCol">&nbsp;</td>
    203. 

  203. 		<td class="summaryTableSignatureCol"><a class="signatureLink"
    204. 

  204. 			href="#priority">priority</a> : uint = 0
    205. 

  205. 		<div class="summaryTableDescription">Defines the priority of the
    206. 

  206. 		loader.</div>
    207. 

  207. 		</td>
    208. 

  208. 		<td class="summaryTableOwnerCol">AbstractLoader</td>
    209. 

  209. 	</tr>
    210. 

  210. 	<tr class="">
    211. 

  211. 		<td class="summaryTablePaddingCol">&nbsp;</td>
    212. 

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

  213. 		<td class="summaryTableSignatureCol"><a class="signatureLink"
    214. 

  214. 			href="#progress">progress</a> : Number
    215. 

  215. 		<div class="summaryTableDescription">[read-only] Returns a value
    216. 

  216. 		between zero and one indicating the current loading progress of the
    217. 

  217. 		loader.</div>
    218. 

  218. 		</td>
    219. 

  219. 		<td class="summaryTableOwnerCol">AbstractLoader</td>
    220. 

  220. 	</tr>
    221. 

  221. </table>
    222. 

  222. </div>
    223. 

  223. <a name="methodSummary"></a>
    224. 

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

  225. <div class="summaryTableTitle">Public Methods</div>
    226. 

  226. <div class="showHideLinks">
    227. 

  227. <div class="hideInheritedMethod" id="hideInheritedMethod"><a
    228. 

  228. 	onclick="javascript:setInheritedVisible(false,'Method');"
    229. 

  229. 	href="#methodSummary" class="showHideLink"><img
    230. 

  230. 	src="../../../images/expanded.gif" class="showHideLinkImage">
    231. 

  231. Hide Inherited Public Methods</a></div>
    232. 

  232. <div class="showInheritedMethod" id="showInheritedMethod"><a
    233. 

  233. 	onclick="javascript:setInheritedVisible(true,'Method');"
    234. 

  234. 	href="#methodSummary" class="showHideLink"><img
    235. 

  235. 	src="../../../images/collapsed.gif" class="showHideLinkImage">
    236. 

  236. Show Inherited Public Methods</a></div>
    237. 

  237. </div>
    238. 

  238. <table id="summaryTableMethod" class="summaryTable " cellpadding="3"
    239. 

  239. 	cellspacing="0">
    240. 

  240. 	<tr>
    241. 

  241. 		<th>&nbsp;</th>
    242. 

  242. 		<th colspan="2">Method</th>
    243. 

  243. 		<th class="summaryTableOwnerCol">Defined&nbsp;by</th>
    244. 

  244. 	</tr>
    245. 

  245. 	<tr class="">
    246. 

  246. 		<td class="summaryTablePaddingCol">&nbsp;</td>
    247. 

  247. 		<td class="summaryTableInheritanceCol">&nbsp;</td>
    248. 

  248. 		<td class="summaryTableSignatureCol">
    249. 

  249. 		<div class="summarySignature"><a class="signatureLink"
    250. 

  250. 			href="#AbstractLoader()">AbstractLoader</a>(request:URLRequest,
    251. 

  251. 		loaderName:String = null)</div>
    252. 

  252. 		<div class="summaryTableDescription">AbstractLoader Constructor
    253. 

  253. 		</div>
    254. 

  254. 		</td>
    255. 

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

  256. 	</tr>
    257. 

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

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

  259. 		<td class="summaryTableInheritanceCol"><img
    260. 

  260. 			class="inheritedSummaryImage" title="Inherited" alt="Inherited"
    261. 

  261. 			src="../../../images/inheritedSummary.gif"></td>
    262. 

  262. 		<td class="summaryTableSignatureCol">
    263. 

  263. 		<div class="summarySignature"><a class="signatureLink"
    264. 

  264. 			href="../events/WeakEventDispatcher.html#addEventListener()">addEventListener</a>(type:String,
    265. 

  265. 		listener:Function, useCapture:Boolean = false, priority:int = 0,
    266. 

  266. 		useWeakReference:Boolean = true):void</div>
    267. 

  267. 		<div class="summaryTableDescription">Registers an event listener
    268. 

  268. 		object with an EventDispatcher object so that the listener receives
    269. 

  269. 		notification of an event.</div>
    270. 

  270. 		</td>
    271. 

  271. 		<td class="summaryTableOwnerCol"><a
    272. 

  272. 			href="../events/WeakEventDispatcher.html">WeakEventDispatcher</a></td>
    273. 

  273. 	</tr>
    274. 

  274. 	<tr class="">
    275. 

  275. 		<td class="summaryTablePaddingCol">&nbsp;</td>
    276. 

  276. 		<td class="summaryTableInheritanceCol">&nbsp;</td>
    277. 

  277. 		<td class="summaryTableSignatureCol">
    278. 

  278. 		<div class="summarySignature"><a class="signatureLink"
    279. 

  279. 			href="#clone()">clone</a>():Object</div>
    280. 

  280. 		<div class="summaryTableDescription">Creates a duplicate of the
    281. 

  281. 		instance.</div>
    282. 

  282. 		</td>
    283. 

  283. 		<td class="summaryTableOwnerCol">AbstractLoader</td>
    284. 

  284. 	</tr>
    285. 

  285. 	<tr class="hideInheritedMethod">
    286. 

  286. 		<td class="summaryTablePaddingCol">&nbsp;</td>
    287. 

  287. 		<td class="summaryTableInheritanceCol"><img
    288. 

  288. 			class="inheritedSummaryImage" title="Inherited" alt="Inherited"
    289. 

  289. 			src="../../../images/inheritedSummary.gif"></td>
    290. 

  290. 		<td class="summaryTableSignatureCol">
    291. 

  291. 		<div class="summarySignature"><a class="signatureLink"
    292. 

  292. 			href="../events/WeakEventDispatcher.html#destruct()">destruct</a>(deepDestruct:Boolean
    293. 

  293. 		= false):void</div>
    294. 

  294. 		<div class="summaryTableDescription">Destructs the instance in
    295. 

  295. 		an attempt to clear it of all its references, properties and values.</div>
    296. 

  296. 		</td>
    297. 

  297. 		<td class="summaryTableOwnerCol"><a
    298. 

  298. 			href="../events/WeakEventDispatcher.html">WeakEventDispatcher</a></td>
    299. 

  299. 	</tr>
    300. 

  300. 	<tr class="hideInheritedMethod">
    301. 

  301. 		<td class="summaryTablePaddingCol">&nbsp;</td>
    302. 

  302. 		<td class="summaryTableInheritanceCol"><img
    303. 

  303. 			class="inheritedSummaryImage" title="Inherited" alt="Inherited"
    304. 

  304. 			src="../../../images/inheritedSummary.gif"></td>
    305. 

  305. 		<td class="summaryTableSignatureCol">
    306. 

  306. 		<div class="summarySignature"><a class="signatureLink"
    307. 

  307. 			href="../events/WeakEventDispatcher.html#dispatchEvent()">dispatchEvent</a>(e:Event):Boolean</div>
    308. 

  308. 		<div class="summaryTableDescription">Dispatches an event into
    309. 

  309. 		the event flow, <i>only</i> if event property <code>hasEventListener</code>
    310. 

  310. 		or <code>bubbles</code> are <code>true</code>.</div>
    311. 

  311. 		</td>
    312. 

  312. 		<td class="summaryTableOwnerCol"><a
    313. 

  313. 			href="../events/WeakEventDispatcher.html">WeakEventDispatcher</a></td>
    314. 

  314. 	</tr>
    315. 

  315. 	<tr class="">
    316. 

  316. 		<td class="summaryTablePaddingCol">&nbsp;</td>
    317. 

  317. 		<td class="summaryTableInheritanceCol">&nbsp;</td>
    318. 

  318. 		<td class="summaryTableSignatureCol">
    319. 

  319. 		<div class="summarySignature"><a class="signatureLink"
    320. 

  320. 			href="#getURLRequest()">getURLRequest</a>():URLRequest</div>
    321. 

  321. 		<div class="summaryTableDescription">Returns the <code>URLRequest</code>
    322. 

  322. 		of the loader.</div>
    323. 

  323. 		</td>
    324. 

  324. 		<td class="summaryTableOwnerCol">AbstractLoader</td>
    325. 

  325. 	</tr>
    326. 

  326. 	<tr class="">
    327. 

  327. 		<td class="summaryTablePaddingCol">&nbsp;</td>
    328. 

  328. 		<td class="summaryTableInheritanceCol">&nbsp;</td>
    329. 

  329. 		<td class="summaryTableSignatureCol">
    330. 

  330. 		<div class="summarySignature"><a class="signatureLink"
    331. 

  331. 			href="#load()">load</a>():void</div>
    332. 

  332. 		<div class="summaryTableDescription">Initiates the loading
    333. 

  333. 		process of the loader.</div>
    334. 

  334. 		</td>
    335. 

  335. 		<td class="summaryTableOwnerCol">AbstractLoader</td>
    336. 

  336. 	</tr>
    337. 

  337. 	<tr class="">
    338. 

  338. 		<td class="summaryTablePaddingCol">&nbsp;</td>
    339. 

  339. 		<td class="summaryTableInheritanceCol">&nbsp;</td>
    340. 

  340. 		<td class="summaryTableSignatureCol">
    341. 

  341. 		<div class="summarySignature"><a class="signatureLink"
    342. 

  342. 			href="#prefetchBytesTotal()">prefetchBytesTotal</a>():void</div>
    343. 

  343. 		<div class="summaryTableDescription">Instructs the loader to
    344. 

  344. 		prefech the total file size of target file without having to start the
    345. 

  345. 		actual loading progress.</div>
    346. 

  346. 		</td>
    347. 

  347. 		<td class="summaryTableOwnerCol">AbstractLoader</td>
    348. 

  348. 	</tr>
    349. 

  349. 	<tr class="">
    350. 

  350. 		<td class="summaryTablePaddingCol">&nbsp;</td>
    351. 

  351. 		<td class="summaryTableInheritanceCol">&nbsp;</td>
    352. 

  352. 		<td class="summaryTableSignatureCol">
    353. 

  353. 		<div class="summarySignature"><a class="signatureLink"
    354. 

  354. 			href="#reset()">reset</a>():void</div>
    355. 

  355. 		<div class="summaryTableDescription">Resets the loader and its
    356. 

  356. 		properties to what they were upon instantiation.</div>
    357. 

  357. 		</td>
    358. 

  358. 		<td class="summaryTableOwnerCol">AbstractLoader</td>
    359. 

  359. 	</tr>
    360. 

  360. 	<tr class="">
    361. 

  361. 		<td class="summaryTablePaddingCol">&nbsp;</td>
    362. 

  362. 		<td class="summaryTableInheritanceCol">&nbsp;</td>
    363. 

  363. 		<td class="summaryTableSignatureCol">
    364. 

  364. 		<div class="summarySignature"><a class="signatureLink"
    365. 

  365. 			href="#toString()">toString</a>():String</div>
    366. 

  366. 		<div class="summaryTableDescription">Returns the string
    367. 

  367. 		representation of the instance.</div>
    368. 

  368. 		</td>
    369. 

  369. 		<td class="summaryTableOwnerCol">AbstractLoader</td>
    370. 

  370. 	</tr>
    371. 

  371. </table>
    372. 

  372. </div>
    373. 

  373. <script type="text/javascript" language="javascript">
    374. 

  374. <!--
    375. 

  375. showHideInherited();
    376. 

  376. --></script>
    377. 

  377. <div class="MainContent"><a name="propertyDetail"></a>
    378. 

  378. <div class="detailSectionHeader">Property detail</div>
    379. 

  379. <a name="bytesLoaded"></a>
    380. 

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

  381. 	<tr>
    382. 

  382. 		<td class="detailHeaderName">bytesLoaded</td>
    383. 

  383. 		<td class="detailHeaderType">property</td>
    384. 

  384. 	</tr>
    385. 

  385. </table>
    386. 

  386. <div class="detailBody"><code>bytesLoaded:uint</code>&nbsp;&nbsp;[read-only]
    387. 

  387. <p>Indicates the number of loaded bytes from the loaders target
    388. 

  388. file.</p>
    389. 

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

  390. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function get
    391. 

  391. bytesLoaded():uint</code> <br>
    392. 

  392. </div>
    393. 

  393. <a name="bytesTotal"></a>
    394. 

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

  395. 	<tr>
    396. 

  396. 		<td class="detailHeaderName">bytesTotal</td>
    397. 

  397. 		<td class="detailHeaderType">property</td>
    398. 

  398. 		<td class="detailHeaderRule">&nbsp;</td>
    399. 

  399. 	</tr>
    400. 

  400. </table>
    401. 

  401. <div class="detailBody"><code>bytesTotal:int</code>&nbsp;&nbsp;[read-only]
    402. 

  402. <p>Indicates the number of total bytes of the loaders target file.</p>
    403. 

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

  404. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function get
    405. 

  405. bytesTotal():int</code> <br>
    406. 

  406. </div>
    407. 

  407. <a name="bytesTotalPrefetcher"></a>
    408. 

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

  409. 	<tr>
    410. 

  410. 		<td class="detailHeaderName">bytesTotalPrefetcher</td>
    411. 

  411. 		<td class="detailHeaderType">property</td>
    412. 

  412. 		<td class="detailHeaderRule">&nbsp;</td>
    413. 

  413. 	</tr>
    414. 

  414. </table>
    415. 

  415. <div class="detailBody"><code>bytesTotalPrefetcher:<a
    416. 

  416. 	href="../load/BytesTotalPrefetcher.html">BytesTotalPrefetcher</a></code>&nbsp;&nbsp;[read-only]
    417. 

  417. <p>Returns the bytesTotal prefetcher instance.</p>
    418. 

  418. <span class="label">Implementation</span> <br>
    419. 

  419. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function get
    420. 

  420. bytesTotalPrefetcher():<a href="../load/BytesTotalPrefetcher.html">BytesTotalPrefetcher</a></code>
    421. 

  421. <br>
    422. 

  422. </div>
    423. 

  423. <a name="cancelable"></a>
    424. 

  424. <table cellspacing="0" cellpadding="0" class="detailHeader">
    425. 

  425. 	<tr>
    426. 

  426. 		<td class="detailHeaderName">cancelable</td>
    427. 

  427. 		<td class="detailHeaderType">property</td>
    428. 

  428. 		<td class="detailHeaderRule">&nbsp;</td>
    429. 

  429. 	</tr>
    430. 

  430. </table>
    431. 

  431. <div class="detailBody"><code>cancelable:Boolean</code>&nbsp;&nbsp;[read-only]
    432. 

  432. <p>Indicates whether the loader is cancelable. Cancelable loaders
    433. 

  433. may be interrupted while loading. Note that if you wish to cancel a
    434. 

  434. loading process to resume it later you need to use the <code>reset()</code>
    435. 

  435. method before calling the <code>load()</code> method again.</p>
    436. 

  436. <span class="label">Implementation</span> <br>
    437. 

  437. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function get
    438. 

  438. cancelable():Boolean</code> <br>
    439. 

  439. </div>
    440. 

  440. <a name="data"></a>
    441. 

  441. <table cellspacing="0" cellpadding="0" class="detailHeader">
    442. 

  442. 	<tr>
    443. 

  443. 		<td class="detailHeaderName">data</td>
    444. 

  444. 		<td class="detailHeaderType">property</td>
    445. 

  445. 		<td class="detailHeaderRule">&nbsp;</td>
    446. 

  446. 	</tr>
    447. 

  447. </table>
    448. 

  448. <div class="detailBody"><code>data:*</code>&nbsp;&nbsp;[read-only]
    449. 

  449. <p>Returns the loaded data of the loader.</p>
    450. 

  450. <span class="label">Implementation</span> <br>
    451. 

  451. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function get data():*</code> <br>
    452. 

  452. </div>
    453. 

  453. <a name="loaded"></a>
    454. 

  454. <table cellspacing="0" cellpadding="0" class="detailHeader">
    455. 

  455. 	<tr>
    456. 

  456. 		<td class="detailHeaderName">loaded</td>
    457. 

  457. 		<td class="detailHeaderType">property</td>
    458. 

  458. 		<td class="detailHeaderRule">&nbsp;</td>
    459. 

  459. 	</tr>
    460. 

  460. </table>
    461. 

  461. <div class="detailBody"><code>loaded:Boolean</code>&nbsp;&nbsp;[read-only]
    462. 

  462. <p>Indicates whether the loading process has finished.</p>
    463. 

  463. <span class="label">Implementation</span> <br>
    464. 

  464. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function get
    465. 

  465. loaded():Boolean</code> <br>
    466. 

  466. </div>
    467. 

  467. <a name="loading"></a>
    468. 

  468. <table cellspacing="0" cellpadding="0" class="detailHeader">
    469. 

  469. 	<tr>
    470. 

  470. 		<td class="detailHeaderName">loading</td>
    471. 

  471. 		<td class="detailHeaderType">property</td>
    472. 

  472. 		<td class="detailHeaderRule">&nbsp;</td>
    473. 

  473. 	</tr>
    474. 

  474. </table>
    475. 

  475. <div class="detailBody"><code>loading:Boolean</code>&nbsp;&nbsp;[read-only]
    476. 

  476. <p>Indicates whether the loading process is running.</p>
    477. 

  477. <span class="label">Implementation</span> <br>
    478. 

  478. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function get
    479. 

  479. loading():Boolean</code> <br>
    480. 

  480. </div>
    481. 

  481. <a name="loadTime"></a>
    482. 

  482. <table cellspacing="0" cellpadding="0" class="detailHeader">
    483. 

  483. 	<tr>
    484. 

  484. 		<td class="detailHeaderName">loadTime</td>
    485. 

  485. 		<td class="detailHeaderType">property</td>
    486. 

  486. 		<td class="detailHeaderRule">&nbsp;</td>
    487. 

  487. 	</tr>
    488. 

  488. </table>
    489. 

  489. <div class="detailBody"><code>loadTime:uint</code>&nbsp;&nbsp;[read-only]
    490. 

  490. <p>Indicates, in milliseconds, the time elapsed from loading start
    491. 

  491. to loading completion.</p>
    492. 

  492. <span class="label">Implementation</span> <br>
    493. 

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

  494. <br>
    495. 

  495. </div>
    496. 

  496. <a name="name"></a>
    497. 

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

  498. 	<tr>
    499. 

  499. 		<td class="detailHeaderName">name</td>
    500. 

  500. 		<td class="detailHeaderType">property</td>
    501. 

  501. 		<td class="detailHeaderRule">&nbsp;</td>
    502. 

  502. 	</tr>
    503. 

  503. </table>
    504. 

  504. <div class="detailBody"><code>public var name:String</code>
    505. 

  505. <p>Specifies the name of the loader.</p>
    506. 

  506. </div>
    507. 

  507. <a name="priority"></a>
    508. 

  508. <table cellspacing="0" cellpadding="0" class="detailHeader">
    509. 

  509. 	<tr>
    510. 

  510. 		<td class="detailHeaderName">priority</td>
    511. 

  511. 		<td class="detailHeaderType">property</td>
    512. 

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

  513. 	</tr>
    514. 

  514. </table>
    515. 

  515. <div class="detailBody"><code>public var priority:uint = 0</code>
    516. 

  516. <p>Defines the priority of the loader. Loaders with a low priority
    517. 

  517. value will be loaded before loaders with a higher priority value in a
    518. 

  518. loader queue.</p>
    519. 

  519. <p><span class="label">See also</span></p>
    520. 

  520. <div class="seeAlso"><a href="../load/LoaderQueue.html" target="">org.tractionas3.load.LoaderQueue</a>
    521. 

  521. </div>
    522. 

  522. </div>
    523. 

  523. <a name="progress"></a>
    524. 

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

  525. 	<tr>
    526. 

  526. 		<td class="detailHeaderName">progress</td>
    527. 

  527. 		<td class="detailHeaderType">property</td>
    528. 

  528. 		<td class="detailHeaderRule">&nbsp;</td>
    529. 

  529. 	</tr>
    530. 

  530. </table>
    531. 

  531. <div class="detailBody"><code>progress:Number</code>&nbsp;&nbsp;[read-only]
    532. 

  532. <p>Returns a value between zero and one indicating the current
    533. 

  533. loading progress of the loader.</p>
    534. 

  534. <span class="label">Implementation</span> <br>
    535. 

  535. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function get
    536. 

  536. progress():Number</code> <br>
    537. 

  537. </div>
    538. 

  538. <a name="constructorDetail"></a>
    539. 

  539. <div class="detailSectionHeader">Constructor detail</div>
    540. 

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

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

  542. 	<tr>
    543. 

  543. 		<td class="detailHeaderName">AbstractLoader</td>
    544. 

  544. 		<td class="detailHeaderParens">()</td>
    545. 

  545. 		<td class="detailHeaderType">constructor</td>
    546. 

  546. 	</tr>
    547. 

  547. </table>
    548. 

  548. <div class="detailBody"><code>public function
    549. 

  549. AbstractLoader(request:URLRequest, loaderName:String = null)</code>
    550. 

  550. <p>AbstractLoader Constructor</p>
    551. 

  551. <span class="label">Parameters</span>
    552. 

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

  553. 	<tr>
    554. 

  554. 		<td width="20px"></td>
    555. 

  555. 		<td><code><span class="label">request</span>:URLRequest</code></td>
    556. 

  556. 	</tr>
    557. 

  557. 	<tr>
    558. 

  558. 		<td class="paramSpacer">&nbsp;</td>
    559. 

  559. 	</tr>
    560. 

  560. 	<tr>
    561. 

  561. 		<td width="20px"></td>
    562. 

  562. 		<td><code><span class="label">loaderName</span>:String</code>
    563. 

  563. 		(default = <code>null</code>)<code></code></td>
    564. 

  564. 	</tr>
    565. 

  565. </table>
    566. 

  566. </div>
    567. 

  567. <a name="methodDetail"></a>
    568. 

  568. <div class="detailSectionHeader">Method detail</div>
    569. 

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

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

  571. 	<tr>
    572. 

  572. 		<td class="detailHeaderName">clone</td>
    573. 

  573. 		<td class="detailHeaderParens">()</td>
    574. 

  574. 		<td class="detailHeaderType">method</td>
    575. 

  575. 	</tr>
    576. 

  576. </table>
    577. 

  577. <div class="detailBody"><code>public function
    578. 

  578. clone():Object</code>
    579. 

  579. <p>Creates a duplicate of the instance.</p>
    580. 

  580. <p></p>
    581. 

  581. <span class="label">Returns</span>
    582. 

  582. <table border="0" cellspacing="0" cellpadding="0">
    583. 

  583. 	<tr>
    584. 

  584. 		<td width="20"></td>
    585. 

  585. 		<td><code>Object</code></td>
    586. 

  586. 	</tr>
    587. 

  587. </table>
    588. 

  588. </div>
    589. 

  589. <a name="getURLRequest()"></a>
    590. 

  590. <table cellspacing="0" cellpadding="0" class="detailHeader">
    591. 

  591. 	<tr>
    592. 

  592. 		<td class="detailHeaderName">getURLRequest</td>
    593. 

  593. 		<td class="detailHeaderParens">()</td>
    594. 

  594. 		<td class="detailHeaderType">method</td>
    595. 

  595. 		<td class="detailHeaderRule">&nbsp;</td>
    596. 

  596. 	</tr>
    597. 

  597. </table>
    598. 

  598. <div class="detailBody"><code>public final function
    599. 

  599. getURLRequest():URLRequest</code>
    600. 

  600. <p>Returns the <code>URLRequest</code> of the loader. The <code>URLRequest</code>
    601. 

  601. cannot be changed.</p>
    602. 

  602. <p></p>
    603. 

  603. <span class="label">Returns</span>
    604. 

  604. <table border="0" cellspacing="0" cellpadding="0">
    605. 

  605. 	<tr>
    606. 

  606. 		<td width="20"></td>
    607. 

  607. 		<td><code>URLRequest</code></td>
    608. 

  608. 	</tr>
    609. 

  609. </table>
    610. 

  610. </div>
    611. 

  611. <a name="load()"></a>
    612. 

  612. <table cellspacing="0" cellpadding="0" class="detailHeader">
    613. 

  613. 	<tr>
    614. 

  614. 		<td class="detailHeaderName">load</td>
    615. 

  615. 		<td class="detailHeaderParens">()</td>
    616. 

  616. 		<td class="detailHeaderType">method</td>
    617. 

  617. 		<td class="detailHeaderRule">&nbsp;</td>
    618. 

  618. 	</tr>
    619. 

  619. </table>
    620. 

  620. <div class="detailBody"><code>public function load():void</code>
    621. 

  621. <p>Initiates the loading process of the loader. A new URLRequest
    622. 

  622. cannot be defined through this method.</p>
    623. 

  623. </div>
    624. 

  624. <a name="prefetchBytesTotal()"></a>
    625. 

  625. <table cellspacing="0" cellpadding="0" class="detailHeader">
    626. 

  626. 	<tr>
    627. 

  627. 		<td class="detailHeaderName">prefetchBytesTotal</td>
    628. 

  628. 		<td class="detailHeaderParens">()</td>
    629. 

  629. 		<td class="detailHeaderType">method</td>
    630. 

  630. 		<td class="detailHeaderRule">&nbsp;</td>
    631. 

  631. 	</tr>
    632. 

  632. </table>
    633. 

  633. <div class="detailBody"><code>public final function
    634. 

  634. prefetchBytesTotal():void</code>
    635. 

  635. <p>Instructs the loader to prefech the total file size of target
    636. 

  636. file without having to start the actual loading progress.</p>
    637. 

  637. </div>
    638. 

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

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

  640. 	<tr>
    641. 

  641. 		<td class="detailHeaderName">reset</td>
    642. 

  642. 		<td class="detailHeaderParens">()</td>
    643. 

  643. 		<td class="detailHeaderType">method</td>
    644. 

  644. 		<td class="detailHeaderRule">&nbsp;</td>
    645. 

  645. 	</tr>
    646. 

  646. </table>
    647. 

  647. <div class="detailBody"><code>public function reset():void</code>
    648. 

  648. <p>Resets the loader and its properties to what they were upon
    649. 

  649. instantiation.</p>
    650. 

  650. </div>
    651. 

  651. <a name="toString()"></a>
    652. 

  652. <table cellspacing="0" cellpadding="0" class="detailHeader">
    653. 

  653. 	<tr>
    654. 

  654. 		<td class="detailHeaderName">toString</td>
    655. 

  655. 		<td class="detailHeaderParens">()</td>
    656. 

  656. 		<td class="detailHeaderType">method</td>
    657. 

  657. 		<td class="detailHeaderRule">&nbsp;</td>
    658. 

  658. 	</tr>
    659. 

  659. </table>
    660. 

  660. <div class="detailBody"><code>public override function
    661. 

  661. toString():String</code>
    662. 

  662. <p>Returns the string representation of the instance.</p>
    663. 

  663. <p></p>
    664. 

  664. <span class="label">Returns</span>
    665. 

  665. <table border="0" cellspacing="0" cellpadding="0">
    666. 

  666. 	<tr>
    667. 

  667. 		<td width="20"></td>
    668. 

  668. 		<td><code>String</code></td>
    669. 

  669. 	</tr>
    670. 

  670. </table>
    671. 

  671. </div>
    672. 

  672. <br>
    673. 

  673. <br>
    674. 

  674. <hr>
    675. 

  675. <br>
    676. 

  676. <p></p>
    677. 

  677. <center class="copyright"></center>
    678. 

  678. </div>
    679. 

  679. </body>
    680. 

  680. </html>
    681. 

  681. <!-- -->
    682. 

  682.