3 * Copyright(c) 2006-2010 Ext JS, LLC
5 * http://www.extjs.com/license
8 * @class Ext.ProgressBar
\r
9 * @extends Ext.BoxComponent
\r
10 * <p>An updateable progress bar component. The progress bar supports two different modes: manual and automatic.</p>
\r
11 * <p>In manual mode, you are responsible for showing, updating (via {@link #updateProgress}) and clearing the
\r
12 * progress bar as needed from your own code. This method is most appropriate when you want to show progress
\r
13 * throughout an operation that has predictable points of interest at which you can update the control.</p>
\r
14 * <p>In automatic mode, you simply call {@link #wait} and let the progress bar run indefinitely, only clearing it
\r
15 * once the operation is complete. You can optionally have the progress bar wait for a specific amount of time
\r
16 * and then clear itself. Automatic mode is most appropriate for timed operations or asynchronous operations in
\r
17 * which you have no need for indicating intermediate progress.</p>
\r
18 * @cfg {Float} value A floating point value between 0 and 1 (e.g., .5, defaults to 0)
\r
19 * @cfg {String} text The progress bar text (defaults to '')
\r
20 * @cfg {Mixed} textEl The element to render the progress text to (defaults to the progress
\r
21 * bar's internal text element)
\r
22 * @cfg {String} id The progress bar element's id (defaults to an auto-generated id)
\r
25 Ext.ProgressBar = Ext.extend(Ext.BoxComponent, {
\r
27 * @cfg {String} baseCls
\r
28 * The base CSS class to apply to the progress bar's wrapper element (defaults to 'x-progress')
\r
30 baseCls : 'x-progress',
\r
33 * @cfg {Boolean} animate
\r
34 * True to animate the progress bar during transitions (defaults to false)
\r
42 initComponent : function(){
\r
43 Ext.ProgressBar.superclass.initComponent.call(this);
\r
47 * Fires after each update interval
\r
48 * @param {Ext.ProgressBar} this
\r
49 * @param {Number} The current progress value
\r
50 * @param {String} The current progress text
\r
57 onRender : function(ct, position){
\r
58 var tpl = new Ext.Template(
\r
59 '<div class="{cls}-wrap">',
\r
60 '<div class="{cls}-inner">',
\r
61 '<div class="{cls}-bar">',
\r
62 '<div class="{cls}-text">',
\r
63 '<div> </div>',
\r
66 '<div class="{cls}-text {cls}-text-back">',
\r
67 '<div> </div>',
\r
73 this.el = position ? tpl.insertBefore(position, {cls: this.baseCls}, true)
\r
74 : tpl.append(ct, {cls: this.baseCls}, true);
\r
77 this.el.dom.id = this.id;
\r
79 var inner = this.el.dom.firstChild;
\r
80 this.progressBar = Ext.get(inner.firstChild);
\r
83 //use an external text el
\r
84 this.textEl = Ext.get(this.textEl);
\r
85 delete this.textTopEl;
\r
87 //setup our internal layered text els
\r
88 this.textTopEl = Ext.get(this.progressBar.dom.firstChild);
\r
89 var textBackEl = Ext.get(inner.childNodes[1]);
\r
90 this.textTopEl.setStyle("z-index", 99).addClass('x-hidden');
\r
91 this.textEl = new Ext.CompositeElement([this.textTopEl.dom.firstChild, textBackEl.dom.firstChild]);
\r
92 this.textEl.setWidth(inner.offsetWidth);
\r
94 this.progressBar.setHeight(inner.offsetHeight);
\r
98 afterRender : function(){
\r
99 Ext.ProgressBar.superclass.afterRender.call(this);
\r
101 this.updateProgress(this.value, this.text);
\r
103 this.updateText(this.text);
\r
108 * Updates the progress bar value, and optionally its text. If the text argument is not specified,
\r
109 * any existing text value will be unchanged. To blank out existing text, pass ''. Note that even
\r
110 * if the progress bar value exceeds 1, it will never automatically reset -- you are responsible for
\r
111 * determining when the progress is complete and calling {@link #reset} to clear and/or hide the control.
\r
112 * @param {Float} value (optional) A floating point value between 0 and 1 (e.g., .5, defaults to 0)
\r
113 * @param {String} text (optional) The string to display in the progress text element (defaults to '')
\r
114 * @param {Boolean} animate (optional) Whether to animate the transition of the progress bar. If this value is
\r
115 * not specified, the default for the class is used (default to false)
\r
116 * @return {Ext.ProgressBar} this
\r
118 updateProgress : function(value, text, animate){
\r
119 this.value = value || 0;
\r
121 this.updateText(text);
\r
123 if(this.rendered && !this.isDestroyed){
\r
124 var w = Math.floor(value*this.el.dom.firstChild.offsetWidth);
\r
125 this.progressBar.setWidth(w, animate === true || (animate !== false && this.animate));
\r
126 if(this.textTopEl){
\r
127 //textTopEl should be the same width as the bar so overflow will clip as the bar moves
\r
128 this.textTopEl.removeClass('x-hidden').setWidth(w);
\r
131 this.fireEvent('update', this, value, text);
\r
136 * Initiates an auto-updating progress bar. A duration can be specified, in which case the progress
\r
137 * bar will automatically reset after a fixed amount of time and optionally call a callback function
\r
138 * if specified. If no duration is passed in, then the progress bar will run indefinitely and must
\r
139 * be manually cleared by calling {@link #reset}. The wait method accepts a config object with
\r
140 * the following properties:
\r
142 Property Type Description
\r
143 ---------- ------------ ----------------------------------------------------------------------
\r
144 duration Number The length of time in milliseconds that the progress bar should
\r
145 run before resetting itself (defaults to undefined, in which case it
\r
146 will run indefinitely until reset is called)
\r
147 interval Number The length of time in milliseconds between each progress update
\r
148 (defaults to 1000 ms)
\r
149 animate Boolean Whether to animate the transition of the progress bar. If this value is
\r
150 not specified, the default for the class is used.
\r
151 increment Number The number of progress update segments to display within the progress
\r
152 bar (defaults to 10). If the bar reaches the end and is still
\r
153 updating, it will automatically wrap back to the beginning.
\r
154 text String Optional text to display in the progress bar element (defaults to '').
\r
155 fn Function A callback function to execute after the progress bar finishes auto-
\r
156 updating. The function will be called with no arguments. This function
\r
157 will be ignored if duration is not specified since in that case the
\r
158 progress bar can only be stopped programmatically, so any required function
\r
159 should be called by the same code after it resets the progress bar.
\r
160 scope Object The scope that is passed to the callback function (only applies when
\r
161 duration and fn are both passed).
\r
166 var p = new Ext.ProgressBar({
\r
170 //Wait for 5 seconds, then update the status el (progress bar will auto-reset)
\r
172 interval: 100, //bar will move fast!
\r
175 text: 'Updating...',
\r
178 Ext.fly('status').update('Done!');
\r
182 //Or update indefinitely until some async action completes, then reset manually
\r
184 myAction.on('complete', function(){
\r
186 Ext.fly('status').update('Done!');
\r
189 * @param {Object} config (optional) Configuration options
\r
190 * @return {Ext.ProgressBar} this
\r
192 wait : function(o){
\r
193 if(!this.waitTimer){
\r
196 this.updateText(o.text);
\r
197 this.waitTimer = Ext.TaskMgr.start({
\r
199 var inc = o.increment || 10;
\r
201 this.updateProgress(((((i+inc)%inc)+1)*(100/inc))*0.01, null, o.animate);
\r
203 interval: o.interval || 1000,
\r
204 duration: o.duration,
\r
205 onStop: function(){
\r
207 o.fn.apply(o.scope || this);
\r
218 * Returns true if the progress bar is currently in a {@link #wait} operation
\r
219 * @return {Boolean} True if waiting, else false
\r
221 isWaiting : function(){
\r
222 return this.waitTimer !== null;
\r
226 * Updates the progress bar text. If specified, textEl will be updated, otherwise the progress
\r
227 * bar itself will display the updated text.
\r
228 * @param {String} text (optional) The string to display in the progress text element (defaults to '')
\r
229 * @return {Ext.ProgressBar} this
\r
231 updateText : function(text){
\r
232 this.text = text || ' ';
\r
234 this.textEl.update(this.text);
\r
240 * Synchronizes the inner bar width to the proper proportion of the total componet width based
\r
241 * on the current progress {@link #value}. This will be called automatically when the ProgressBar
\r
242 * is resized by a layout, but if it is rendered auto width, this method can be called from
\r
243 * another resize handler to sync the ProgressBar if necessary.
\r
245 syncProgressBar : function(){
\r
247 this.updateProgress(this.value, this.text);
\r
253 * Sets the size of the progress bar.
\r
254 * @param {Number} width The new width in pixels
\r
255 * @param {Number} height The new height in pixels
\r
256 * @return {Ext.ProgressBar} this
\r
258 setSize : function(w, h){
\r
259 Ext.ProgressBar.superclass.setSize.call(this, w, h);
\r
260 if(this.textTopEl){
\r
261 var inner = this.el.dom.firstChild;
\r
262 this.textEl.setSize(inner.offsetWidth, inner.offsetHeight);
\r
264 this.syncProgressBar();
\r
269 * Resets the progress bar value to 0 and text to empty string. If hide = true, the progress
\r
270 * bar will also be hidden (using the {@link #hideMode} property internally).
\r
271 * @param {Boolean} hide (optional) True to hide the progress bar (defaults to false)
\r
272 * @return {Ext.ProgressBar} this
\r
274 reset : function(hide){
\r
275 this.updateProgress(0);
\r
276 if(this.textTopEl){
\r
277 this.textTopEl.addClass('x-hidden');
\r
287 clearTimer : function(){
\r
288 if(this.waitTimer){
\r
289 this.waitTimer.onStop = null; //prevent recursion
\r
290 Ext.TaskMgr.stop(this.waitTimer);
\r
291 this.waitTimer = null;
\r
295 onDestroy: function(){
\r
298 if(this.textEl.isComposite){
\r
299 this.textEl.clear();
\r
301 Ext.destroyMembers(this, 'textEl', 'progressBar', 'textTopEl');
\r
303 Ext.ProgressBar.superclass.onDestroy.call(this);
\r
306 Ext.reg('progress', Ext.ProgressBar);