ProgressBar.js
上传用户:dawnssy
上传日期:2022-08-06
资源大小:9345k
文件大小:12k
源码类别:

JavaScript

开发平台:

JavaScript

  1. /*!  * Ext JS Library 3.1.0  * Copyright(c) 2006-2009 Ext JS, LLC  * licensing@extjs.com  * http://www.extjs.com/license  */ /**
  2.  * @class Ext.ProgressBar
  3.  * @extends Ext.BoxComponent
  4.  * <p>An updateable progress bar component.  The progress bar supports two different modes: manual and automatic.</p>
  5.  * <p>In manual mode, you are responsible for showing, updating (via {@link #updateProgress}) and clearing the
  6.  * progress bar as needed from your own code.  This method is most appropriate when you want to show progress
  7.  * throughout an operation that has predictable points of interest at which you can update the control.</p>
  8.  * <p>In automatic mode, you simply call {@link #wait} and let the progress bar run indefinitely, only clearing it
  9.  * once the operation is complete.  You can optionally have the progress bar wait for a specific amount of time
  10.  * and then clear itself.  Automatic mode is most appropriate for timed operations or asynchronous operations in
  11.  * which you have no need for indicating intermediate progress.</p>
  12.  * @cfg {Float} value A floating point value between 0 and 1 (e.g., .5, defaults to 0)
  13.  * @cfg {String} text The progress bar text (defaults to '')
  14.  * @cfg {Mixed} textEl The element to render the progress text to (defaults to the progress
  15.  * bar's internal text element)
  16.  * @cfg {String} id The progress bar element's id (defaults to an auto-generated id)
  17.  * @xtype progress
  18.  */
  19. Ext.ProgressBar = Ext.extend(Ext.BoxComponent, {
  20.    /**
  21.     * @cfg {String} baseCls
  22.     * The base CSS class to apply to the progress bar's wrapper element (defaults to 'x-progress')
  23.     */
  24.     baseCls : 'x-progress',
  25.     
  26.     /**
  27.     * @cfg {Boolean} animate
  28.     * True to animate the progress bar during transitions (defaults to false)
  29.     */
  30.     animate : false,
  31.     // private
  32.     waitTimer : null,
  33.     // private
  34.     initComponent : function(){
  35.         Ext.ProgressBar.superclass.initComponent.call(this);
  36.         this.addEvents(
  37.             /**
  38.              * @event update
  39.              * Fires after each update interval
  40.              * @param {Ext.ProgressBar} this
  41.              * @param {Number} The current progress value
  42.              * @param {String} The current progress text
  43.              */
  44.             "update"
  45.         );
  46.     },
  47.     // private
  48.     onRender : function(ct, position){
  49.         var tpl = new Ext.Template(
  50.             '<div class="{cls}-wrap">',
  51.                 '<div class="{cls}-inner">',
  52.                     '<div class="{cls}-bar">',
  53.                         '<div class="{cls}-text">',
  54.                             '<div>&#160;</div>',
  55.                         '</div>',
  56.                     '</div>',
  57.                     '<div class="{cls}-text {cls}-text-back">',
  58.                         '<div>&#160;</div>',
  59.                     '</div>',
  60.                 '</div>',
  61.             '</div>'
  62.         );
  63.         this.el = position ? tpl.insertBefore(position, {cls: this.baseCls}, true)
  64.          : tpl.append(ct, {cls: this.baseCls}, true);
  65.         
  66.         if(this.id){
  67.             this.el.dom.id = this.id;
  68.         }
  69.         var inner = this.el.dom.firstChild;
  70.         this.progressBar = Ext.get(inner.firstChild);
  71.         if(this.textEl){
  72.             //use an external text el
  73.             this.textEl = Ext.get(this.textEl);
  74.             delete this.textTopEl;
  75.         }else{
  76.             //setup our internal layered text els
  77.             this.textTopEl = Ext.get(this.progressBar.dom.firstChild);
  78.             var textBackEl = Ext.get(inner.childNodes[1]);
  79.             this.textTopEl.setStyle("z-index", 99).addClass('x-hidden');
  80.             this.textEl = new Ext.CompositeElement([this.textTopEl.dom.firstChild, textBackEl.dom.firstChild]);
  81.             this.textEl.setWidth(inner.offsetWidth);
  82.         }
  83.         this.progressBar.setHeight(inner.offsetHeight);
  84.     },
  85.     
  86.     // private
  87.     afterRender : function(){
  88.         Ext.ProgressBar.superclass.afterRender.call(this);
  89.         if(this.value){
  90.             this.updateProgress(this.value, this.text);
  91.         }else{
  92.             this.updateText(this.text);
  93.         }
  94.     },
  95.     /**
  96.      * Updates the progress bar value, and optionally its text.  If the text argument is not specified,
  97.      * any existing text value will be unchanged.  To blank out existing text, pass ''.  Note that even
  98.      * if the progress bar value exceeds 1, it will never automatically reset -- you are responsible for
  99.      * determining when the progress is complete and calling {@link #reset} to clear and/or hide the control.
  100.      * @param {Float} value (optional) A floating point value between 0 and 1 (e.g., .5, defaults to 0)
  101.      * @param {String} text (optional) The string to display in the progress text element (defaults to '')
  102.      * @param {Boolean} animate (optional) Whether to animate the transition of the progress bar. If this value is
  103.      * not specified, the default for the class is used (default to false)
  104.      * @return {Ext.ProgressBar} this
  105.      */
  106.     updateProgress : function(value, text, animate){
  107.         this.value = value || 0;
  108.         if(text){
  109.             this.updateText(text);
  110.         }
  111.         if(this.rendered){
  112.             var w = Math.floor(value*this.el.dom.firstChild.offsetWidth);
  113.             this.progressBar.setWidth(w, animate === true || (animate !== false && this.animate));
  114.             if(this.textTopEl){
  115.                 //textTopEl should be the same width as the bar so overflow will clip as the bar moves
  116.                 this.textTopEl.removeClass('x-hidden').setWidth(w);
  117.             }
  118.         }
  119.         this.fireEvent('update', this, value, text);
  120.         return this;
  121.     },
  122.     /**
  123.      * Initiates an auto-updating progress bar.  A duration can be specified, in which case the progress
  124.      * bar will automatically reset after a fixed amount of time and optionally call a callback function
  125.      * if specified.  If no duration is passed in, then the progress bar will run indefinitely and must
  126.      * be manually cleared by calling {@link #reset}.  The wait method accepts a config object with
  127.      * the following properties:
  128.      * <pre>
  129. Property   Type          Description
  130. ---------- ------------  ----------------------------------------------------------------------
  131. duration   Number        The length of time in milliseconds that the progress bar should
  132.                          run before resetting itself (defaults to undefined, in which case it
  133.                          will run indefinitely until reset is called)
  134. interval   Number        The length of time in milliseconds between each progress update
  135.                          (defaults to 1000 ms)
  136. animate    Boolean       Whether to animate the transition of the progress bar. If this value is
  137.                          not specified, the default for the class is used.                                                   
  138. increment  Number        The number of progress update segments to display within the progress
  139.                          bar (defaults to 10).  If the bar reaches the end and is still
  140.                          updating, it will automatically wrap back to the beginning.
  141. text       String        Optional text to display in the progress bar element (defaults to '').
  142. fn         Function      A callback function to execute after the progress bar finishes auto-
  143.                          updating.  The function will be called with no arguments.  This function
  144.                          will be ignored if duration is not specified since in that case the
  145.                          progress bar can only be stopped programmatically, so any required function
  146.                          should be called by the same code after it resets the progress bar.
  147. scope      Object        The scope that is passed to the callback function (only applies when
  148.                          duration and fn are both passed).
  149. </pre>
  150.          *
  151.          * Example usage:
  152.          * <pre><code>
  153. var p = new Ext.ProgressBar({
  154.    renderTo: 'my-el'
  155. });
  156. //Wait for 5 seconds, then update the status el (progress bar will auto-reset)
  157. p.wait({
  158.    interval: 100, //bar will move fast!
  159.    duration: 5000,
  160.    increment: 15,
  161.    text: 'Updating...',
  162.    scope: this,
  163.    fn: function(){
  164.       Ext.fly('status').update('Done!');
  165.    }
  166. });
  167. //Or update indefinitely until some async action completes, then reset manually
  168. p.wait();
  169. myAction.on('complete', function(){
  170.     p.reset();
  171.     Ext.fly('status').update('Done!');
  172. });
  173. </code></pre>
  174.      * @param {Object} config (optional) Configuration options
  175.      * @return {Ext.ProgressBar} this
  176.      */
  177.     wait : function(o){
  178.         if(!this.waitTimer){
  179.             var scope = this;
  180.             o = o || {};
  181.             this.updateText(o.text);
  182.             this.waitTimer = Ext.TaskMgr.start({
  183.                 run: function(i){
  184.                     var inc = o.increment || 10;
  185.                     i -= 1;
  186.                     this.updateProgress(((((i+inc)%inc)+1)*(100/inc))*0.01, null, o.animate);
  187.                 },
  188.                 interval: o.interval || 1000,
  189.                 duration: o.duration,
  190.                 onStop: function(){
  191.                     if(o.fn){
  192.                         o.fn.apply(o.scope || this);
  193.                     }
  194.                     this.reset();
  195.                 },
  196.                 scope: scope
  197.             });
  198.         }
  199.         return this;
  200.     },
  201.     /**
  202.      * Returns true if the progress bar is currently in a {@link #wait} operation
  203.      * @return {Boolean} True if waiting, else false
  204.      */
  205.     isWaiting : function(){
  206.         return this.waitTimer !== null;
  207.     },
  208.     /**
  209.      * Updates the progress bar text.  If specified, textEl will be updated, otherwise the progress
  210.      * bar itself will display the updated text.
  211.      * @param {String} text (optional) The string to display in the progress text element (defaults to '')
  212.      * @return {Ext.ProgressBar} this
  213.      */
  214.     updateText : function(text){
  215.         this.text = text || '&#160;';
  216.         if(this.rendered){
  217.             this.textEl.update(this.text);
  218.         }
  219.         return this;
  220.     },
  221.     
  222.     /**
  223.      * Synchronizes the inner bar width to the proper proportion of the total componet width based
  224.      * on the current progress {@link #value}.  This will be called automatically when the ProgressBar
  225.      * is resized by a layout, but if it is rendered auto width, this method can be called from
  226.      * another resize handler to sync the ProgressBar if necessary.
  227.      */
  228.     syncProgressBar : function(){
  229.         if(this.value){
  230.             this.updateProgress(this.value, this.text);
  231.         }
  232.         return this;
  233.     },
  234.     /**
  235.      * Sets the size of the progress bar.
  236.      * @param {Number} width The new width in pixels
  237.      * @param {Number} height The new height in pixels
  238.      * @return {Ext.ProgressBar} this
  239.      */
  240.     setSize : function(w, h){
  241.         Ext.ProgressBar.superclass.setSize.call(this, w, h);
  242.         if(this.textTopEl){
  243.             var inner = this.el.dom.firstChild;
  244.             this.textEl.setSize(inner.offsetWidth, inner.offsetHeight);
  245.         }
  246.         this.syncProgressBar();
  247.         return this;
  248.     },
  249.     /**
  250.      * Resets the progress bar value to 0 and text to empty string.  If hide = true, the progress
  251.      * bar will also be hidden (using the {@link #hideMode} property internally).
  252.      * @param {Boolean} hide (optional) True to hide the progress bar (defaults to false)
  253.      * @return {Ext.ProgressBar} this
  254.      */
  255.     reset : function(hide){
  256.         this.updateProgress(0);
  257.         if(this.textTopEl){
  258.             this.textTopEl.addClass('x-hidden');
  259.         }
  260.         if(this.waitTimer){
  261.             this.waitTimer.onStop = null; //prevent recursion
  262.             Ext.TaskMgr.stop(this.waitTimer);
  263.             this.waitTimer = null;
  264.         }
  265.         if(hide === true){
  266.             this.hide();
  267.         }
  268.         return this;
  269.     },
  270.     
  271.     onDestroy: function(){
  272.         if(this.rendered){
  273.             if(this.textEl.isComposite){
  274.                 this.textEl.clear();
  275.             }
  276.             Ext.destroyMembers(this, 'textEl', 'progressBar', 'textTopEl');
  277.         }
  278.         Ext.ProgressBar.superclass.onDestroy.call(this);
  279.     }
  280. });
  281. Ext.reg('progress', Ext.ProgressBar);