- 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 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
+ 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>);
git.ithinksw.org / extjs.git / blobdiff