📄 biscriptloaderqueue.html
字号:
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"><html><!--Generated using api.website.xsl version 2003-07-17--><head><META http-equiv="Content-Type" content="text/html; charset=utf-8"><title>BiScriptLoaderQueue</title><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><link type="text/css" rel="stylesheet" href="api.css"><script type="text/javascript"> function showDerivedClasses() { var ul = document.getElementById("api-derived-classes"); var lis = ul.childNodes; var l = lis.length; for (var i = 1; i < l; i++) lis[i].style.display = ""; lis[0].style.display = "none"; } </script></head><body><h1 id="BiScriptLoaderQueue">BiScriptLoaderQueue</h1><p>Used to load multiple js files and once all are loaded they are executed in the order they were added.</p><p>This class extends <code><a href="BiEventTarget.html">BiEventTarget</a></code> and therefore all methods and fields available for <code><a href="BiEventTarget.html">BiEventTarget</a></code> are also available for <code>BiScriptLoaderQueue</code>.</p><ul class="partial-class-tree"><li><code><a href="BiObject.html">BiObject</a></code><ul><li><code><a href="BiEventTarget.html">BiEventTarget</a></code><ul><li><code>BiScriptLoaderQueue</code><ul id="api-derived-classes"></ul></li></ul></li></ul></li></ul><h2>Constructor</h2><p><code> new BiScriptLoaderQueue()</code></p><h3>Parameters</h3><p>No parameters.</p><h2>Properties</h2><table><thead><tr><td>Name</td><td>Type</td><td class="get-header">get</td><td class="set-header">set</td><td>Descripton</td></tr></thead><tbody><tr><td><a name="async"></a><code>async</code></td><td><code class="type">Boolean</code></td><td class="get-column"><img src="check.png" alt="checked"></td><td class="set-column"><img src="check.png" alt="checked"></td><td>If this is set to false then the loading will lock the UI thread but the loading and execution will happen and finish when <code><a href="#load">load</a></code> is called.</td></tr><tr><td><a name="loaded"></a><code>loaded</code></td><td><code class="type">Boolean</code></td><td class="get-column"><img src="check.png" alt="checked"></td><td class="set-column"></td><td>Whether all scripts have been loaded. This does not necessarily mean that the code inside the scripts have been executed.</td></tr><tr><td><a name="loadedCount"></a><code>loadedCount</code></td><td><code class="type">Number</code></td><td class="get-column"><img src="check.png" alt="checked"></td><td class="set-column"></td><td>Returns the number of finished loading scripts. This includeds the inline scripts as well.</td></tr><tr><td><a name="scriptCount"></a><code>scriptCount</code></td><td><code class="type">Number</code></td><td class="get-column"><img src="check.png" alt="checked"></td><td class="set-column"></td><td>Returns the number of added scripts. This includeds the inline scripts as well.</td></tr></tbody></table><h2>Methods</h2><table><thead><tr><td>Name</td><td>Description</td></tr></thead><tbody><tr><td><code><a href="#abort">abort</a></code></td><td>Stops the current loading</td></tr><tr><td><code><a href="#add">add</a></code></td><td>Adds an external script file by providing the URI for the file</td></tr><tr><td><code><a href="#addInline">addInline</a></code></td><td>Adds inline script code</td></tr><tr><td><code><a href="#execScript">execScript</a></code></td><td>Executes a string containing javascript in the global scope</td></tr><tr><td><code><a href="#load">load</a></code></td><td>Starts the loading of the scripts. The loading is done asynchronously so this will return immediately. When all scripts are loaded the <code><a href="#load">load</a></code> event will fire.</td></tr></tbody></table><h2>Events</h2><table><thead><tr><td>Name</td><td>Type</td><td class="bubbles-header">Bubbles</td><td>Descripton</td></tr></thead><tbody><tr><td><a name="load"></a><code>load</code></td><td><code class="type"> <code><a href="BiEvent.html">BiEvent</a></code> </code></td><td class="bubbles-column"></td><td>Fires when all the scripts have been loaded and executed</td></tr><tr><td><a name="progress"></a><code>progress</code></td><td><code class="type"> <code><a href="BiEvent.html">BiEvent</a></code> </code></td><td class="bubbles-column"></td><td>Fires every time one of the external scripts have been loaded. This is useful for providing visual feedback.</td></tr></tbody></table><h2>Static Methods</h2><p>None.</p><h2>Static Fields</h2><p>None.</p><h2>Remarks</h2><p> </p><h2>Method Details</h2><h3><a name="abort"></a>abort</h3><p>Stops the current loading</p><h4>Syntax</h4><pre class="method-syntax">object.abort()</pre><h4>Parameters</h4><p>No arguments.</p><h4>Return Type</h4><p><code class="type">void</code></p><h3><a name="add"></a>add</h3><p>Adds an external script file by providing the URI for the file</p><h4>Syntax</h4><pre class="method-syntax">object.add(<span class="methodArgument">oUri</span>)</pre><h4>Parameters</h4><table><thead><tr><td>Name</td><td>Type</td><td class="optional-header">Optional</td><td>Default</td><td>Descripton</td></tr></thead><tbody><tr><td><code>oUri</code></td><td><code class="type"> <code><a href="BiUri.html">BiUri</a></code> </code></td><td class="optional-column"></td><td></td><td>The location of the script file. If this is a string a new URI is created from that string relative to the <code><a href="BiApplication.html#adfPath">ADF path</a></code>.</td></tr></tbody></table><h4>Return Type</h4><p><code class="type">void</code></p><h3><a name="addInline"></a>addInline</h3><p>Adds inline script code</p><h4>Syntax</h4><pre class="method-syntax">object.addInline(<span class="methodArgument">sText</span>)</pre><h4>Parameters</h4><table><thead><tr><td>Name</td><td>Type</td><td class="optional-header">Optional</td><td>Default</td><td>Descripton</td></tr></thead><tbody><tr><td><code>sText</code></td><td><code class="type">String</code></td><td class="optional-column"></td><td></td><td>The JavaScript code to add</td></tr></tbody></table><h4>Return Type</h4><p><code class="type">void</code></p><h3><a name="execScript"></a>execScript</h3><p>Executes a string containing javascript in the global scope</p><h4>Syntax</h4><pre class="method-syntax">object.execScript(<span class="methodArgument">s</span>)</pre><h4>Parameters</h4><table><thead><tr><td>Name</td><td>Type</td><td class="optional-header">Optional</td><td>Default</td><td>Descripton</td></tr></thead><tbody><tr><td><code>s</code></td><td><code class="type">String</code></td><td class="optional-column"></td><td></td><td>The javascript code to execute</td></tr></tbody></table><h4>Return Type</h4><p><code class="type">void</code></p><h3><a name="load"></a>load</h3><p>Starts the loading of the scripts. The loading is done asynchronously so this will return immediately. When all scripts are loaded the <code><a href="#load">load</a></code> event will fire.</p><h4>Syntax</h4><pre class="method-syntax">object.load()</pre><h4>Parameters</h4><p>No arguments.</p><h4>Return Type</h4><p><code class="type">void</code></p></body></html>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -