-content area will be updated via Ext.Element update</div></li><li><code>loadScripts</code> : Boolean<div class="sub-desc">(optional) Only legitimate when using the html configuration. Defaults to false</div></li><li><code>callback</code> : Function<div class="sub-desc">(optional) Only legitimate when using the html configuration. Callback to execute when scripts have finished loading</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#update" ext:member="#update" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-updateBox"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-updateBox">updateBox</a></b>( <code>Object box</code> )\r
- :\r
- Ext.BoxComponent<div class="mdesc"><div class="short">Sets the current box measurements of the component's underlying element.</div><div class="long">Sets the current box measurements of the component's underlying element.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>box</code> : Object<div class="sub-desc">An object in the format {x, y, width, height}</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#updateBox" ext:member="#updateBox" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.ProgressBar-updateProgress"></a><b><a href="source/ProgressBar.html#method-Ext.ProgressBar-updateProgress">updateProgress</a></b>( <span title="Optional" class="optional">[<code>Float value</code>]</span>, <span title="Optional" class="optional">[<code>String text</code>]</span>, <span title="Optional" class="optional">[<code>Boolean animate</code>]</span> )\r
- :\r
- Ext.ProgressBar<div class="mdesc"><div class="short">Updates the progress bar value, and optionally its text. If the text argument is not specified, \r
-any existing text v...</div><div class="long">Updates the progress bar value, and optionally its text. If the text argument is not specified,\r
-any existing text value will be unchanged. To blank out existing text, pass ''. Note that even\r
-if the progress bar value exceeds 1, it will never automatically reset -- you are responsible for\r
-determining when the progress is complete and calling <a href="output/Ext.ProgressBar.html#Ext.ProgressBar-reset" ext:member="reset" ext:cls="Ext.ProgressBar">reset</a> to clear and/or hide the control.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>value</code> : Float<div class="sub-desc">(optional) A floating point value between 0 and 1 (e.g., .5, defaults to 0)</div></li><li><code>text</code> : String<div class="sub-desc">(optional) The string to display in the progress text element (defaults to '')</div></li><li><code>animate</code> : Boolean<div class="sub-desc">(optional) Whether to animate the transition of the progress bar. If this value is\r
-not specified, the default for the class is used (default to false)</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.ProgressBar</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource">ProgressBar</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.ProgressBar-updateText"></a><b><a href="source/ProgressBar.html#method-Ext.ProgressBar-updateText">updateText</a></b>( <span title="Optional" class="optional">[<code>String text</code>]</span> )\r
- :\r
- Ext.ProgressBar<div class="mdesc"><div class="short">Updates the progress bar text. If specified, textEl will be updated, otherwise the progress \r
-bar itself will display...</div><div class="long">Updates the progress bar text. If specified, textEl will be updated, otherwise the progress\r
-bar itself will display the updated text.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>text</code> : String<div class="sub-desc">(optional) The string to display in the progress text element (defaults to '')</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.ProgressBar</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource">ProgressBar</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.ProgressBar-wait"></a><b><a href="source/ProgressBar.html#method-Ext.ProgressBar-wait">wait</a></b>( <span title="Optional" class="optional">[<code>Object config</code>]</span> )\r
- :\r
- Ext.ProgressBar<div class="mdesc"><div class="short">Initiates an auto-updating progress bar. A duration can be specified, in which case the progress \r
-bar will automatic...</div><div class="long">Initiates an auto-updating progress bar. A duration can be specified, in which case the progress\r
-bar will automatically reset after a fixed amount of time and optionally call a callback function\r
-if specified. If no duration is passed in, then the progress bar will run indefinitely and must\r
-be manually cleared by calling <a href="output/Ext.ProgressBar.html#Ext.ProgressBar-reset" ext:member="reset" ext:cls="Ext.ProgressBar">reset</a>. The wait method accepts a config object with\r
-the following properties:\r
-<pre>\r
-Property Type Description\r
----------- ------------ ----------------------------------------------------------------------\r
-duration Number The length of time in milliseconds that the progress bar should\r
- run before resetting itself (defaults to undefined, in which case it\r
- will run indefinitely until reset is called)\r
-interval Number The length of time in milliseconds between each progress update\r
- (defaults to 1000 ms)\r
-animate Boolean Whether to animate the transition of the progress bar. If this value is\r
- not specified, the default for the class is used. \r
-increment Number The number of progress update segments to display within the progress\r
- bar (defaults to 10). If the bar reaches the end and is still\r
- updating, it will automatically wrap back to the beginning.\r
-text String Optional text to display in the progress bar element (defaults to '').\r
-fn Function A callback function to execute after the progress bar finishes auto-\r
- updating. The function will be called with no arguments. This function\r
- will be ignored if duration is not specified since in that case the\r
- progress bar can only be stopped programmatically, so any required function\r
- should be called by the same code after it resets the progress bar.\r
-scope Object The scope that is passed to the callback function (only applies when\r
- duration and fn are both passed).\r
-</pre>\r
-Example usage:\r
-<pre><code><b>var</b> p = <b>new</b> Ext.ProgressBar({\r
- renderTo: <em>'my-el'</em>\r
-});\r
-\r
-<i>//Wait <b>for</b> 5 seconds, then update the status el (progress bar will auto-reset)\r</i>
-p.wait({\r
- interval: 100, <i>//bar will move fast!\r</i>
- duration: 5000,\r
- increment: 15,\r
- text: <em>'Updating...'</em>,\r
- scope: this,\r
- fn: <b>function</b>(){\r
- Ext.fly(<em>'status'</em>).update(<em>'Done!'</em>);\r
- }\r
-});\r
-\r
-<i>//Or update indefinitely until some async action completes, then reset manually\r</i>
-p.wait();\r
-myAction.on(<em>'complete'</em>, <b>function</b>(){\r
- p.reset();\r
- Ext.fly(<em>'status'</em>).update(<em>'Done!'</em>);\r
-});</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>config</code> : Object<div class="sub-desc">(optional) Configuration options</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.ProgressBar</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource">ProgressBar</td></tr></tbody></table><a id="Ext.ProgressBar-events"></a><h2>Public Events</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Event</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-added"></a><b><a href="source/Component.html#event-Ext.Component-added">added</a></b> :\r
- ( <code>Ext.Component this</code>, <code>Ext.Container ownerCt</code>, <code>number index</code> )\r
- <div class="mdesc"><div class="short">Fires when a component is added to an Ext.Container</div><div class="long">Fires when a component is added to an Ext.Container<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li><li><code>ownerCt</code> : Ext.Container<div class="sub-desc">Container which holds the component</div></li><li><code>index</code> : number<div class="sub-desc">Position at which the component was added</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#added" ext:member="#added" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-afterrender"></a><b><a href="source/Component.html#event-Ext.Component-afterrender">afterrender</a></b> :\r
- ( <code>Ext.Component this</code> )\r
- <div class="mdesc"><div class="short">Fires after the component rendering is finished.\r
+content area will be updated via Ext.Element update</div></li><li><code>loadScripts</code> : Boolean<div class="sub-desc">(optional) Only legitimate when using the html configuration. Defaults to false</div></li><li><code>callback</code> : Function<div class="sub-desc">(optional) Only legitimate when using the html configuration. Callback to execute when scripts have finished loading</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#update" ext:member="#update" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-updateBox"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-updateBox">updateBox</a></b>( <code>Object box</code> )
+ :
+ Ext.BoxComponent<div class="mdesc"><div class="short">Sets the current box measurements of the component's underlying element.</div><div class="long">Sets the current box measurements of the component's underlying element.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>box</code> : Object<div class="sub-desc">An object in the format {x, y, width, height}</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#updateBox" ext:member="#updateBox" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.ProgressBar-updateProgress"></a><b><a href="source/ProgressBar.html#method-Ext.ProgressBar-updateProgress">updateProgress</a></b>( <span title="Optional" class="optional">[<code>Float value</code>]</span>, <span title="Optional" class="optional">[<code>String text</code>]</span>, <span title="Optional" class="optional">[<code>Boolean animate</code>]</span> )
+ :
+ Ext.ProgressBar<div class="mdesc"><div class="short">Updates the progress bar value, and optionally its text. If the text argument is not specified,
+any existing text va...</div><div class="long">Updates the progress bar value, and optionally its text. If the text argument is not specified,
+any existing text value will be unchanged. To blank out existing text, pass ''. Note that even
+if the progress bar value exceeds 1, it will never automatically reset -- you are responsible for
+determining when the progress is complete and calling <a href="output/Ext.ProgressBar.html#Ext.ProgressBar-reset" ext:member="reset" ext:cls="Ext.ProgressBar">reset</a> to clear and/or hide the control.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>value</code> : Float<div class="sub-desc">(optional) A floating point value between 0 and 1 (e.g., .5, defaults to 0)</div></li><li><code>text</code> : String<div class="sub-desc">(optional) The string to display in the progress text element (defaults to '')</div></li><li><code>animate</code> : Boolean<div class="sub-desc">(optional) Whether to animate the transition of the progress bar. If this value is
+not specified, the default for the class is used (default to false)</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.ProgressBar</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource">ProgressBar</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.ProgressBar-updateText"></a><b><a href="source/ProgressBar.html#method-Ext.ProgressBar-updateText">updateText</a></b>( <span title="Optional" class="optional">[<code>String text</code>]</span> )
+ :
+ Ext.ProgressBar<div class="mdesc"><div class="short">Updates the progress bar text. If specified, textEl will be updated, otherwise the progress
+bar itself will display ...</div><div class="long">Updates the progress bar text. If specified, textEl will be updated, otherwise the progress
+bar itself will display the updated text.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>text</code> : String<div class="sub-desc">(optional) The string to display in the progress text element (defaults to '')</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.ProgressBar</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource">ProgressBar</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.ProgressBar-wait"></a><b><a href="source/ProgressBar.html#method-Ext.ProgressBar-wait">wait</a></b>( <span title="Optional" class="optional">[<code>Object config</code>]</span> )
+ :
+ Ext.ProgressBar<div class="mdesc"><div class="short">Initiates an auto-updating progress bar. A duration can be specified, in which case the progress
+bar will automatica...</div><div class="long">Initiates an auto-updating progress bar. A duration can be specified, in which case the progress
+bar will automatically reset after a fixed amount of time and optionally call a callback function
+if specified. If no duration is passed in, then the progress bar will run indefinitely and must
+be manually cleared by calling <a href="output/Ext.ProgressBar.html#Ext.ProgressBar-reset" ext:member="reset" ext:cls="Ext.ProgressBar">reset</a>. The wait method accepts a config object with
+the following properties:
+<pre>
+Property Type Description
+---------- ------------ ----------------------------------------------------------------------
+duration Number The length of time in milliseconds that the progress bar should
+ run before resetting itself (defaults to undefined, in which case it
+ will run indefinitely until reset is called)
+interval Number The length of time in milliseconds between each progress update
+ (defaults to 1000 ms)
+animate Boolean Whether to animate the transition of the progress bar. If this value is
+ not specified, the default for the class is used.
+increment Number The number of progress update segments to display within the progress
+ bar (defaults to 10). If the bar reaches the end and is still
+ updating, it will automatically wrap back to the beginning.
+text String Optional text to display in the progress bar element (defaults to '').
+fn Function A callback function to execute after the progress bar finishes auto-
+ updating. The function will be called with no arguments. This function
+ will be ignored if duration is not specified since in that case the
+ progress bar can only be stopped programmatically, so any required function
+ should be called by the same code after it resets the progress bar.
+scope Object The scope that is passed to the callback function (only applies when
+ duration and fn are both passed).
+</pre>
+Example usage:
+<pre><code><b>var</b> p = <b>new</b> Ext.ProgressBar({
+ renderTo: <em>'my-el'</em>
+});
+
+<i>//Wait <b>for</b> 5 seconds, then update the status el (progress bar will auto-reset)</i>
+p.wait({
+ interval: 100, <i>//bar will move fast!</i>
+ duration: 5000,
+ increment: 15,
+ text: <em>'Updating...'</em>,
+ scope: this,
+ fn: <b>function</b>(){
+ Ext.fly(<em>'status'</em>).update(<em>'Done!'</em>);
+ }
+});
+
+<i>//Or update indefinitely until some async action completes, then reset manually</i>
+p.wait();
+myAction.on(<em>'complete'</em>, <b>function</b>(){
+ p.reset();
+ Ext.fly(<em>'status'</em>).update(<em>'Done!'</em>);
+});</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>config</code> : Object<div class="sub-desc">(optional) Configuration options</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.ProgressBar</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource">ProgressBar</td></tr></tbody></table><a id="Ext.ProgressBar-events"></a><h2>Public Events</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Event</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-added"></a><b><a href="source/Component.html#event-Ext.Component-added">added</a></b> :
+ ( <code>Ext.Component this</code>, <code>Ext.Container ownerCt</code>, <code>number index</code> )
+ <div class="mdesc"><div class="short">Fires when a component is added to an Ext.Container</div><div class="long">Fires when a component is added to an Ext.Container<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li><li><code>ownerCt</code> : Ext.Container<div class="sub-desc">Container which holds the component</div></li><li><code>index</code> : number<div class="sub-desc">Position at which the component was added</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#added" ext:member="#added" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-afterrender"></a><b><a href="source/Component.html#event-Ext.Component-afterrender">afterrender</a></b> :
+ ( <code>Ext.Component this</code> )
+ <div class="mdesc"><div class="short">Fires after the component rendering is finished.
git.ithinksw.org / extjs.git / blobdiff