/docs/org/tractionas3/load/CoreLoader.html
HTML | 607 lines | 563 code | 35 blank | 9 comment | 0 complexity | f45d5d99a4153196950b09e6c1ea39fb MD5 | raw file
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
- <html>
- <head>
- <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
- <link rel="stylesheet" href="../../../style.css" type="text/css" media="screen">
- <link rel="stylesheet" href="../../../print.css" type="text/css" media="print">
- <meta content="CoreLoader,org.tractionas3.load.CoreLoader,name,priority,bytesLoaded,bytesTotal,bytesTotalPrefetcher,cancelable,data,loadTime,loaded,loading,progress,url,clone,getURLRequest,listDestructableProperties,load,prefetchBytesTotal,reset,toString" name="keywords">
- <title>org.tractionas3.load.CoreLoader</title>
- </head>
- <body>
- <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">
- <!--
- asdocTitle = 'CoreLoader - TractionAS3 Framework Documentation';
- var baseRef = '../../../';
- window.onload = configPage;
- --></script>
- <table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
- <tr>
- <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 Packages</a> | <a onclick="loadClassListFrame('../../../all-classes.html')" href="../../../class-summary.html">All Classes</a> | <a onclick="loadClassListFrame('../../../index-list.html')" href="../../../all-index-A.html">Index</a> | <a href="../../../index.html?org/tractionas3/load/CoreLoader.html&org/tractionas3/load/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../images/logo.jpg"></td>
- </tr>
- <tr class="titleTableRow2">
- <td align="left" id="subTitle" class="titleTableSubTitle">Class CoreLoader</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a> | <a href="#methodSummary">Methods</a></td>
- </tr>
- <tr class="titleTableRow3">
- <td colspan="2"> </td>
- </tr>
- </table>
- <script type="text/javascript" language="javascript">
- <!--
- if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class CoreLoader"); titleBar_setSubNav(false,true,false,false,false,false,true,false,false,false,false,false,false,false);}
- --></script>
- <div class="MainContent">
- <table cellspacing="0" cellpadding="0" class="classHeaderTable">
- <tr>
- <td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">org.tractionas3.load</a></td>
- </tr>
- <tr>
- <td class="classHeaderTableLabel">Class</td><td class="classSignature">public class CoreLoader</td>
- </tr>
- <tr>
- <td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">CoreLoader <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../images/inherit-arrow.gif"> <a href="../events/WeakEventDispatcher.html">WeakEventDispatcher</a> <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../images/inherit-arrow.gif"> <a href="../events/ClearableEventDispatcher.html">ClearableEventDispatcher</a> <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../images/inherit-arrow.gif"> flash.events.EventDispatcher</td>
- </tr>
- <tr>
- <td class="classHeaderTableLabel">Implements</td><td><a href="ILoadable.html">ILoadable</a></td>
- </tr>
- <tr>
- <td class="classHeaderTableLabel">Subclasses</td><td><a href="../load/DisplayLoader.html">DisplayLoader</a>, <a href="../load/SoundLoader.html">SoundLoader</a>, <a href="../load/URLDataLoader.html">URLDataLoader</a>, <a href="../load/VideoLoader.html">VideoLoader</a></td>
- </tr>
- </table>
- <p></p>
- CoreLoader class is the base class of all loader classes.
- <p />
- Providing core functinality to all loader classes, CoreLoader is the type to reference when dealing with common loader properties
- such as <code>name</code> and <code>priority</code>.
- <p />
- <p></p>
- <br>
- <hr>
- </div>
- <a name="propertySummary"></a>
- <div class="summarySection">
- <div class="summaryTableTitle">Public Properties</div>
- <table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
- <tr>
- <th> </th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined by</th>
- </tr>
- <tr class="">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#bytesLoaded">bytesLoaded</a> : uint<div class="summaryTableDescription">[read-only]
-
- Indicates the number of loaded bytes from the loaders target file.</div>
- </td><td class="summaryTableOwnerCol">CoreLoader</td>
- </tr>
- <tr class="">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#bytesTotal">bytesTotal</a> : int<div class="summaryTableDescription">[read-only]
-
- Indicates the number of total bytes of the loaders target file.</div>
- </td><td class="summaryTableOwnerCol">CoreLoader</td>
- </tr>
- <tr class="">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#bytesTotalPrefetcher">bytesTotalPrefetcher</a> : <a href="../load/BytesTotalPrefetcher.html">BytesTotalPrefetcher</a>
- <div class="summaryTableDescription">[read-only]
-
- Returns the bytesTotal prefetcher instance.</div>
- </td><td class="summaryTableOwnerCol">CoreLoader</td>
- </tr>
- <tr class="">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#cancelable">cancelable</a> : Boolean<div class="summaryTableDescription">[read-only]
-
- Indicates whether the loader is cancelable.</div>
- </td><td class="summaryTableOwnerCol">CoreLoader</td>
- </tr>
- <tr class="">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#data">data</a> : *<div class="summaryTableDescription">[read-only]
- Returns the loaded data of the CoreLoader.</div>
- </td><td class="summaryTableOwnerCol">CoreLoader</td>
- </tr>
- <tr class="">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#loaded">loaded</a> : Boolean<div class="summaryTableDescription">[read-only]
-
- Indicates whether the loading process has finished.</div>
- </td><td class="summaryTableOwnerCol">CoreLoader</td>
- </tr>
- <tr class="">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#loading">loading</a> : Boolean<div class="summaryTableDescription">[read-only]
-
- Indicates whether the loading process is running.</div>
- </td><td class="summaryTableOwnerCol">CoreLoader</td>
- </tr>
- <tr class="">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#loadTime">loadTime</a> : uint<div class="summaryTableDescription">[read-only]
-
- Indicates, in milliseconds, the time elapsed from loading start to loading completion.</div>
- </td><td class="summaryTableOwnerCol">CoreLoader</td>
- </tr>
- <tr class="">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#name">name</a> : String<div class="summaryTableDescription">
- Specifies the name of the loader.</div>
- </td><td class="summaryTableOwnerCol">CoreLoader</td>
- </tr>
- <tr class="">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#priority">priority</a> : uint = 0<div class="summaryTableDescription">
- Defines the priority of the loader.</div>
- </td><td class="summaryTableOwnerCol">CoreLoader</td>
- </tr>
- <tr class="">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#progress">progress</a> : Number<div class="summaryTableDescription">[read-only]
-
- Returns a value between zero and one indicating the current loading progress of the loader.</div>
- </td><td class="summaryTableOwnerCol">CoreLoader</td>
- </tr>
- <tr class="">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#url">url</a> : String<div class="summaryTableDescription"></div>
- </td><td class="summaryTableOwnerCol">CoreLoader</td>
- </tr>
- </table>
- </div>
- <a name="methodSummary"></a>
- <div class="summarySection">
- <div class="summaryTableTitle">Public Methods</div>
- <div class="showHideLinks">
- <div class="hideInheritedMethod" id="hideInheritedMethod">
- <a onclick="javascript:setInheritedVisible(false,'Method');" href="#methodSummary" class="showHideLink"><img src="../../../images/expanded.gif" class="showHideLinkImage"> Hide Inherited Public Methods</a>
- </div>
- <div class="showInheritedMethod" id="showInheritedMethod">
- <a onclick="javascript:setInheritedVisible(true,'Method');" href="#methodSummary" class="showHideLink"><img src="../../../images/collapsed.gif" class="showHideLinkImage"> Show Inherited Public Methods</a>
- </div>
- </div>
- <table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
- <tr>
- <th> </th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined by</th>
- </tr>
- <tr class="">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
- <div class="summarySignature">
- <a class="signatureLink" href="#CoreLoader()">CoreLoader</a>(url:String = null, loaderName:String = null)</div>
- <div class="summaryTableDescription">
- Creates a new CoreLoader object.</div>
- </td><td class="summaryTableOwnerCol">CoreLoader</td>
- </tr>
- <tr class="hideInheritedMethod">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
- <div class="summarySignature">
- <a class="signatureLink" href="../events/WeakEventDispatcher.html#addEventListener()">addEventListener</a>(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = true):void</div>
- <div class="summaryTableDescription">
- Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.</div>
- </td><td class="summaryTableOwnerCol"><a href="../events/WeakEventDispatcher.html">WeakEventDispatcher</a></td>
- </tr>
- <tr class="">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
- <div class="summarySignature">
- <a class="signatureLink" href="#clone()">clone</a>():<a href="../core/interfaces/ICloneable.html">ICloneable</a>
- </div>
- <div class="summaryTableDescription">
-
- Creates a duplicate of the instance.</div>
- </td><td class="summaryTableOwnerCol">CoreLoader</td>
- </tr>
- <tr class="hideInheritedMethod">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
- <div class="summarySignature">
- <a class="signatureLink" href="../events/ClearableEventDispatcher.html#destruct()">destruct</a>(deepDestruct:Boolean = false):void</div>
- <div class="summaryTableDescription">
-
- Destructs implementing instance of specified properties.</div>
- </td><td class="summaryTableOwnerCol"><a href="../events/ClearableEventDispatcher.html">ClearableEventDispatcher</a></td>
- </tr>
- <tr class="hideInheritedMethod">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
- <div class="summarySignature">
- <a class="signatureLink" href="../events/WeakEventDispatcher.html#dispatchEvent()">dispatchEvent</a>(e:Event):Boolean</div>
- <div class="summaryTableDescription">
- Dispatches an event into the event flow, <i>only</i> if event property <code>hasEventListener</code> or <code>bubbles</code> are <code>true</code>.</div>
- </td><td class="summaryTableOwnerCol"><a href="../events/WeakEventDispatcher.html">WeakEventDispatcher</a></td>
- </tr>
- <tr class="">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
- <div class="summarySignature">
- <a class="signatureLink" href="#getURLRequest()">getURLRequest</a>():URLRequest</div>
- <div class="summaryTableDescription">
-
- Returns the <code>URLRequest</code> of the loader.</div>
- </td><td class="summaryTableOwnerCol">CoreLoader</td>
- </tr>
- <tr class="">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
- <div class="summarySignature">
- <a class="signatureLink" href="#listDestructableProperties()">listDestructableProperties</a>():Array</div>
- <div class="summaryTableDescription">
-
- Specifies an array of strings representing properties that are to be
- nullified or reset upon destruction.</div>
- </td><td class="summaryTableOwnerCol">CoreLoader</td>
- </tr>
- <tr class="">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
- <div class="summarySignature">
- <a class="signatureLink" href="#load()">load</a>(newURL:String = null):void</div>
- <div class="summaryTableDescription">
-
- Initiates the loading process of the loader.</div>
- </td><td class="summaryTableOwnerCol">CoreLoader</td>
- </tr>
- <tr class="">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
- <div class="summarySignature">
- <a class="signatureLink" href="#prefetchBytesTotal()">prefetchBytesTotal</a>():void</div>
- <div class="summaryTableDescription">
-
- Instructs the loader to prefech the total file size of target file without having to start the actual loading progress.</div>
- </td><td class="summaryTableOwnerCol">CoreLoader</td>
- </tr>
- <tr class="hideInheritedMethod">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
- <div class="summarySignature">
- <a class="signatureLink" href="../events/ClearableEventDispatcher.html#removeAllEventListeners()">removeAllEventListeners</a>():void</div>
- <div class="summaryTableDescription">
-
- Removes all event listeners from the IClearableEventDispatcher object.</div>
- </td><td class="summaryTableOwnerCol"><a href="../events/ClearableEventDispatcher.html">ClearableEventDispatcher</a></td>
- </tr>
- <tr class="hideInheritedMethod">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
- <div class="summarySignature">
- <a class="signatureLink" href="../events/ClearableEventDispatcher.html#removeEventListener()">removeEventListener</a>(type:String, listener:Function, useCapture:Boolean = false):void</div>
- <div class="summaryTableDescription">
- Removes a listener from the EventDispatcher object.</div>
- </td><td class="summaryTableOwnerCol"><a href="../events/ClearableEventDispatcher.html">ClearableEventDispatcher</a></td>
- </tr>
- <tr class="">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
- <div class="summarySignature">
- <a class="signatureLink" href="#reset()">reset</a>():void</div>
- <div class="summaryTableDescription">
- Resets the loader and its properties to what they were upon instantiation.</div>
- </td><td class="summaryTableOwnerCol">CoreLoader</td>
- </tr>
- <tr class="">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
- <div class="summarySignature">
- <a class="signatureLink" href="#toString()">toString</a>():String</div>
- <div class="summaryTableDescription">
-
- Returns the string representation of the instance.</div>
- </td><td class="summaryTableOwnerCol">CoreLoader</td>
- </tr>
- </table>
- </div>
- <script type="text/javascript" language="javascript">
- <!--
- showHideInherited();
- --></script>
- <div class="MainContent">
- <a name="propertyDetail"></a>
- <div class="detailSectionHeader">Property detail</div>
- <a name="bytesLoaded"></a>
- <table cellspacing="0" cellpadding="0" class="detailHeader">
- <tr>
- <td class="detailHeaderName">bytesLoaded</td><td class="detailHeaderType">property</td>
- </tr>
- </table>
- <div class="detailBody">
- <code>bytesLoaded:uint</code> [read-only]<p>
-
- Indicates the number of loaded bytes from the loaders target file.
- </p><span class="label">Implementation</span>
- <br>
- <code> public function get bytesLoaded():uint</code>
- <br>
- </div>
- <a name="bytesTotal"></a>
- <table cellspacing="0" cellpadding="0" class="detailHeader">
- <tr>
- <td class="detailHeaderName">bytesTotal</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td>
- </tr>
- </table>
- <div class="detailBody">
- <code>bytesTotal:int</code> [read-only]<p>
-
- Indicates the number of total bytes of the loaders target file.
- </p><span class="label">Implementation</span>
- <br>
- <code> public function get bytesTotal():int</code>
- <br>
- </div>
- <a name="bytesTotalPrefetcher"></a>
- <table cellspacing="0" cellpadding="0" class="detailHeader">
- <tr>
- <td class="detailHeaderName">bytesTotalPrefetcher</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td>
- </tr>
- </table>
- <div class="detailBody">
- <code>bytesTotalPrefetcher:<a href="../load/BytesTotalPrefetcher.html">BytesTotalPrefetcher</a></code> [read-only]<p>
-
- Returns the bytesTotal prefetcher instance.
- </p><span class="label">Implementation</span>
- <br>
- <code> public function get bytesTotalPrefetcher():<a href="../load/BytesTotalPrefetcher.html">BytesTotalPrefetcher</a></code>
- <br>
- </div>
- <a name="cancelable"></a>
- <table cellspacing="0" cellpadding="0" class="detailHeader">
- <tr>
- <td class="detailHeaderName">cancelable</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td>
- </tr>
- </table>
- <div class="detailBody">
- <code>cancelable:Boolean</code> [read-only]<p>
-
- Indicates whether the loader is cancelable. Cancelable loaders may be interrupted while loading.
- 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
- the <code>load()</code> method again.
-
- </p><span class="label">Implementation</span>
- <br>
- <code> public function get cancelable():Boolean</code>
- <br>
- </div>
- <a name="data"></a>
- <table cellspacing="0" cellpadding="0" class="detailHeader">
- <tr>
- <td class="detailHeaderName">data</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td>
- </tr>
- </table>
- <div class="detailBody">
- <code>data:*</code> [read-only]<p>
- Returns the loaded data of the CoreLoader.
-
- </p><span class="label">Implementation</span>
- <br>
- <code> public function get data():*</code>
- <br>
- </div>
- <a name="loaded"></a>
- <table cellspacing="0" cellpadding="0" class="detailHeader">
- <tr>
- <td class="detailHeaderName">loaded</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td>
- </tr>
- </table>
- <div class="detailBody">
- <code>loaded:Boolean</code> [read-only]<p>
-
- Indicates whether the loading process has finished.
- </p><span class="label">Implementation</span>
- <br>
- <code> public function get loaded():Boolean</code>
- <br>
- </div>
- <a name="loading"></a>
- <table cellspacing="0" cellpadding="0" class="detailHeader">
- <tr>
- <td class="detailHeaderName">loading</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td>
- </tr>
- </table>
- <div class="detailBody">
- <code>loading:Boolean</code> [read-only]<p>
-
- Indicates whether the loading process is running.
- </p><span class="label">Implementation</span>
- <br>
- <code> public function get loading():Boolean</code>
- <br>
- </div>
- <a name="loadTime"></a>
- <table cellspacing="0" cellpadding="0" class="detailHeader">
- <tr>
- <td class="detailHeaderName">loadTime</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td>
- </tr>
- </table>
- <div class="detailBody">
- <code>loadTime:uint</code> [read-only]<p>
-
- Indicates, in milliseconds, the time elapsed from loading start to loading completion.
- </p><span class="label">Implementation</span>
- <br>
- <code> public function get loadTime():uint</code>
- <br>
- </div>
- <a name="name"></a>
- <table cellspacing="0" cellpadding="0" class="detailHeader">
- <tr>
- <td class="detailHeaderName">name</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td>
- </tr>
- </table>
- <div class="detailBody">
- <code>public var name:String</code><p>
- Specifies the name of the loader.
- </p></div>
- <a name="priority"></a>
- <table cellspacing="0" cellpadding="0" class="detailHeader">
- <tr>
- <td class="detailHeaderName">priority</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td>
- </tr>
- </table>
- <div class="detailBody">
- <code>public var priority:uint = 0</code><p>
- Defines the priority of the loader.
- Loaders with a low priority value will be loaded before loaders with a higher priority value
- in a loader queue.
-
- </p><p>
- <span class="label">See also</span>
- </p>
- <div class="seeAlso">
- <a href="../load/LoaderQueue.html" target="">org.tractionas3.load.LoaderQueue</a>
- </div>
- </div>
- <a name="progress"></a>
- <table cellspacing="0" cellpadding="0" class="detailHeader">
- <tr>
- <td class="detailHeaderName">progress</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td>
- </tr>
- </table>
- <div class="detailBody">
- <code>progress:Number</code> [read-only]<p>
-
- Returns a value between zero and one indicating the current loading progress of the loader.
- </p><span class="label">Implementation</span>
- <br>
- <code> public function get progress():Number</code>
- <br>
- </div>
- <a name="url"></a>
- <table cellspacing="0" cellpadding="0" class="detailHeader">
- <tr>
- <td class="detailHeaderName">url</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td>
- </tr>
- </table>
- <div class="detailBody">
- <code>url:String</code> [read-write]<span class="label">Implementation</span>
- <br>
- <code> public function get url():String</code>
- <br>
- <code> public function set url(value:String):void</code>
- <br>
- </div>
- <a name="constructorDetail"></a>
- <div class="detailSectionHeader">Constructor detail</div>
- <a name="CoreLoader()"></a>
- <table cellspacing="0" cellpadding="0" class="detailHeader">
- <tr>
- <td class="detailHeaderName">CoreLoader</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
- </tr>
- </table>
- <div class="detailBody">
- <code>public function CoreLoader(url:String = null, loaderName:String = null)</code><p>
- Creates a new CoreLoader object.
-
- </p><span class="label">Parameters</span>
- <table border="0" cellspacing="0" cellpadding="0">
- <tr>
- <td width="20px"></td><td><code><span class="label">url</span>:String</code> (default = <code>null</code>)<code></code> — The URL from wich the data should be loaded.
- </td>
- </tr>
- <tr>
- <td class="paramSpacer"> </td>
- </tr>
- <tr>
- <td width="20px"></td><td><code><span class="label">loaderName</span>:String</code> (default = <code>null</code>)<code></code> — Assigned name to the loader.
- </td>
- </tr>
- </table>
- </div>
- <a name="methodDetail"></a>
- <div class="detailSectionHeader">Method detail</div>
- <a name="clone()"></a>
- <table cellspacing="0" cellpadding="0" class="detailHeader">
- <tr>
- <td class="detailHeaderName">clone</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
- </tr>
- </table>
- <div class="detailBody">
- <code>public function clone():<a href="../core/interfaces/ICloneable.html">ICloneable</a></code><p>
-
- Creates a duplicate of the instance.
- </p><p></p>
- <span class="label">Returns</span>
- <table border="0" cellspacing="0" cellpadding="0">
- <tr>
- <td width="20"></td><td><code><a href="../core/interfaces/ICloneable.html">ICloneable</a></code></td>
- </tr>
- </table>
- </div>
- <a name="getURLRequest()"></a>
- <table cellspacing="0" cellpadding="0" class="detailHeader">
- <tr>
- <td class="detailHeaderName">getURLRequest</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td>
- </tr>
- </table>
- <div class="detailBody">
- <code>public final function getURLRequest():URLRequest</code><p>
-
- Returns the <code>URLRequest</code> of the loader. The <code>URLRequest</code> cannot be changed.
- </p><p></p>
- <span class="label">Returns</span>
- <table border="0" cellspacing="0" cellpadding="0">
- <tr>
- <td width="20"></td><td><code>URLRequest</code></td>
- </tr>
- </table>
- </div>
- <a name="listDestructableProperties()"></a>
- <table cellspacing="0" cellpadding="0" class="detailHeader">
- <tr>
- <td class="detailHeaderName">listDestructableProperties</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td>
- </tr>
- </table>
- <div class="detailBody">
- <code>public override function listDestructableProperties():Array</code><p>
-
- Specifies an array of strings representing properties that are to be
- nullified or reset upon destruction. Applies to public properties <b>only</b>
- </p><p></p>
- <span class="label">Returns</span>
- <table border="0" cellspacing="0" cellpadding="0">
- <tr>
- <td width="20"></td><td><code>Array</code></td>
- </tr>
- </table>
- </div>
- <a name="load()"></a>
- <table cellspacing="0" cellpadding="0" class="detailHeader">
- <tr>
- <td class="detailHeaderName">load</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td>
- </tr>
- </table>
- <div class="detailBody">
- <code>public function load(newURL:String = null):void</code><p>
-
- Initiates the loading process of the loader. A new URLRequest cannot be defined through this method.
- </p><span class="label">Parameters</span>
- <table border="0" cellspacing="0" cellpadding="0">
- <tr>
- <td width="20px"></td><td><code><span class="label">newURL</span>:String</code> (default = <code>null</code>)<code></code></td>
- </tr>
- </table>
- </div>
- <a name="prefetchBytesTotal()"></a>
- <table cellspacing="0" cellpadding="0" class="detailHeader">
- <tr>
- <td class="detailHeaderName">prefetchBytesTotal</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td>
- </tr>
- </table>
- <div class="detailBody">
- <code>public final function prefetchBytesTotal():void</code><p>
-
- Instructs the loader to prefech the total file size of target file without having to start the actual loading progress.
-
- </p></div>
- <a name="reset()"></a>
- <table cellspacing="0" cellpadding="0" class="detailHeader">
- <tr>
- <td class="detailHeaderName">reset</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td>
- </tr>
- </table>
- <div class="detailBody">
- <code>public function reset():void</code><p>
- Resets the loader and its properties to what they were upon instantiation.
- </p></div>
- <a name="toString()"></a>
- <table cellspacing="0" cellpadding="0" class="detailHeader">
- <tr>
- <td class="detailHeaderName">toString</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td>
- </tr>
- </table>
- <div class="detailBody">
- <code>public override function toString():String</code><p>
-
- Returns the string representation of the instance.
- </p><p></p>
- <span class="label">Returns</span>
- <table border="0" cellspacing="0" cellpadding="0">
- <tr>
- <td width="20"></td><td><code>String</code></td>
- </tr>
- </table>
- </div>
- <br>
- <br>
- <hr>
- <br>
- <p></p>
- <center class="copyright">
- </center>
- </div>
- </body>
- </html>
- <!-- -->