StatusBar.js
上传用户:shuoshiled
上传日期:2018-01-28
资源大小:10124k
文件大小:15k
源码类别:

中间件编程

开发平台:

JavaScript

  1. /*!
  2.  * Ext JS Library 3.0.0
  3.  * Copyright(c) 2006-2009 Ext JS, LLC
  4.  * licensing@extjs.com
  5.  * http://www.extjs.com/license
  6.  */
  7. /**
  8.  * @class Ext.ux.StatusBar
  9.  * <p>Basic status bar component that can be used as the bottom toolbar of any {@link Ext.Panel}.  In addition to
  10.  * supporting the standard {@link Ext.Toolbar} interface for adding buttons, menus and other items, the StatusBar
  11.  * provides a greedy status element that can be aligned to either side and has convenient methods for setting the
  12.  * status text and icon.  You can also indicate that something is processing using the {@link #showBusy} method.</p>
  13.  * <p><b>Note:</b> Although StatusBar supports xtype:'statusbar', at this time Ext.Toolbar (the base class) does
  14.  * not support xtype.  For this reason, if you are adding Toolbar items into the StatusBar you must declare it
  15.  * using the "new StatusBar()" syntax for the items to render correctly.</p>
  16.  * <pre><code>
  17. new Ext.Panel({
  18.     title: 'StatusBar',
  19.     // etc.
  20.     bbar: new Ext.ux.StatusBar({
  21.         id: 'my-status',
  22.         // defaults to use when the status is cleared:
  23.         defaultText: 'Default status text',
  24.         defaultIconCls: 'default-icon',
  25.         // values to set initially:
  26.         text: 'Ready',
  27.         iconCls: 'ready-icon',
  28.         // any standard Toolbar items:
  29.         items: [{
  30.             text: 'A Button'
  31.         }, '-', 'Plain Text']
  32.     })
  33. });
  34. // Update the status bar later in code:
  35. var sb = Ext.getCmp('my-status');
  36. sb.setStatus({
  37.     text: 'OK',
  38.     iconCls: 'ok-icon',
  39.     clear: true // auto-clear after a set interval
  40. });
  41. // Set the status bar to show that something is processing:
  42. sb.showBusy();
  43. // processing....
  44. sb.clearStatus(); // once completeed
  45. </code></pre>
  46.  * @extends Ext.Toolbar
  47.  * @constructor
  48.  * Creates a new StatusBar
  49.  * @param {Object/Array} config A config object
  50.  */
  51. Ext.ux.StatusBar = Ext.extend(Ext.Toolbar, {
  52.     /**
  53.      * @cfg {String} statusAlign
  54.      * The alignment of the status element within the overall StatusBar layout.  When the StatusBar is rendered,
  55.      * it creates an internal div containing the status text and icon.  Any additional Toolbar items added in the
  56.      * StatusBar's {@link #items} config, or added via {@link #add} or any of the supported add* methods, will be
  57.      * rendered, in added order, to the opposite side.  The status element is greedy, so it will automatically
  58.      * expand to take up all sapce left over by any other items.  Example usage:
  59.      * <pre><code>
  60. // Create a left-aligned status bar containing a button,
  61. // separator and text item that will be right-aligned (default):
  62. new Ext.Panel({
  63.     title: 'StatusBar',
  64.     // etc.
  65.     bbar: new Ext.ux.StatusBar({
  66.         defaultText: 'Default status text',
  67.         id: 'status-id',
  68.         items: [{
  69.             text: 'A Button'
  70.         }, '-', 'Plain Text']
  71.     })
  72. });
  73. // By adding the statusAlign config, this will create the
  74. // exact same toolbar, except the status and toolbar item
  75. // layout will be reversed from the previous example:
  76. new Ext.Panel({
  77.     title: 'StatusBar',
  78.     // etc.
  79.     bbar: new Ext.ux.StatusBar({
  80.         defaultText: 'Default status text',
  81.         id: 'status-id',
  82.         statusAlign: 'right',
  83.         items: [{
  84.             text: 'A Button'
  85.         }, '-', 'Plain Text']
  86.     })
  87. });
  88. </code></pre>
  89.      */
  90.     /**
  91.      * @cfg {String} defaultText
  92.      * The default {@link #text} value.  This will be used anytime the status bar is cleared with the
  93.      * <tt>useDefaults:true</tt> option (defaults to '').
  94.      */
  95.     /**
  96.      * @cfg {String} defaultIconCls
  97.      * The default {@link #iconCls} value (see the iconCls docs for additional details about customizing the icon).
  98.      * This will be used anytime the status bar is cleared with the <tt>useDefaults:true</tt> option (defaults to '').
  99.      */
  100.     /**
  101.      * @cfg {String} text
  102.      * A string that will be rendered into the status element as the status message (defaults to '');
  103.      */
  104.     /**
  105.      * @cfg {String} iconCls
  106.      * A CSS class that will be applied to the status element and is expected to provide a background image that will
  107.      * serve as the status bar icon (defaults to '').  The class is applied directly to the div that also contains the
  108.      * status text, so the rule should provide the appropriate padding on the div to make room for the image.
  109.      * Example usage:<pre><code>
  110. // Example CSS rule:
  111. .x-statusbar .x-status-custom {
  112.     padding-left: 25px;
  113.     background: transparent url(images/custom-icon.gif) no-repeat 3px 3px;
  114. }
  115. // Initializing the status bar:
  116. var sb = new Ext.ux.StatusBar({
  117.     defaultIconCls: 'x-status-custom'
  118. });
  119. // Setting it in code:
  120. sb.setStatus({
  121.     text: 'New status',
  122.     iconCls: 'x-status-custom'
  123. });
  124. </code></pre>
  125.      */
  126.     /**
  127.      * @cfg {String} cls
  128.      * The base class applied to the containing element for this component on render (defaults to 'x-statusbar')
  129.      */
  130.     cls : 'x-statusbar',
  131.     /**
  132.      * @cfg {String} busyIconCls
  133.      * The default {@link #iconCls} applied when calling {@link #showBusy} (defaults to 'x-status-busy'). It can be
  134.      * overridden at any time by passing the <tt>iconCls</tt> argument into <tt>showBusy</tt>. See the
  135.      * iconCls docs for additional details about customizing the icon.
  136.      */
  137.     busyIconCls : 'x-status-busy',
  138.     /**
  139.      * @cfg {String} busyText
  140.      * The default {@link #text} applied when calling {@link #showBusy} (defaults to 'Loading...'). It can be
  141.      * overridden at any time by passing the <tt>text</tt> argument into <tt>showBusy</tt>.
  142.      */
  143.     busyText : 'Loading...',
  144.     /**
  145.      * @cfg {Number} autoClear
  146.      * The number of milliseconds to wait after setting the status via {@link #setStatus} before automatically
  147.      * clearing the status text and icon (defaults to 5000).  Note that this only applies when passing the
  148.      * <tt>clear</tt> argument to setStatus since that is the only way to defer clearing the status.  This can
  149.      * be overridden by specifying a different <tt>wait</tt> value in setStatus. Calls to {@link #clearStatus}
  150.      * always clear the status bar immediately and ignore this value.
  151.      */
  152.     autoClear : 5000,
  153.     // private
  154.     activeThreadId : 0,
  155.     // private
  156.     initComponent : function(){
  157.         if(this.statusAlign=='right'){
  158.             this.cls += ' x-status-right';
  159.         }
  160.         Ext.ux.StatusBar.superclass.initComponent.call(this);
  161.     },
  162.     // private
  163.     afterRender : function(){
  164.         Ext.ux.StatusBar.superclass.afterRender.call(this);
  165.         var right = this.statusAlign == 'right';
  166.         this.statusEl = new Ext.Toolbar.TextItem({
  167.             cls: 'x-status-text ' + (this.iconCls || this.defaultIconCls || ''),
  168.             text: this.text || this.defaultText || ''
  169.         });
  170.         if(right){
  171.             this.add('->');
  172.             this.add(this.statusEl);
  173.         }else{
  174.             this.insert(0, this.statusEl);
  175.             this.insert(1, '->');
  176.         }
  177. //         this.statusEl = td.createChild({
  178. //             cls: 'x-status-text ' + (this.iconCls || this.defaultIconCls || ''),
  179. //             html: this.text || this.defaultText || ''
  180. //         });
  181. //         this.statusEl.unselectable();
  182. //         this.spacerEl = td.insertSibling({
  183. //             tag: 'td',
  184. //             style: 'width:100%',
  185. //             cn: [{cls:'ytb-spacer'}]
  186. //         }, right ? 'before' : 'after');
  187.     },
  188.     /**
  189.      * Sets the status {@link #text} and/or {@link #iconCls}. Also supports automatically clearing the
  190.      * status that was set after a specified interval.
  191.      * @param {Object/String} config A config object specifying what status to set, or a string assumed
  192.      * to be the status text (and all other options are defaulted as explained below). A config
  193.      * object containing any or all of the following properties can be passed:<ul>
  194.      * <li><tt>text</tt> {String} : (optional) The status text to display.  If not specified, any current
  195.      * status text will remain unchanged.</li>
  196.      * <li><tt>iconCls</tt> {String} : (optional) The CSS class used to customize the status icon (see
  197.      * {@link #iconCls} for details). If not specified, any current iconCls will remain unchanged.</li>
  198.      * <li><tt>clear</tt> {Boolean/Number/Object} : (optional) Allows you to set an internal callback that will
  199.      * automatically clear the status text and iconCls after a specified amount of time has passed. If clear is not
  200.      * specified, the new status will not be auto-cleared and will stay until updated again or cleared using
  201.      * {@link #clearStatus}. If <tt>true</tt> is passed, the status will be cleared using {@link #autoClear},
  202.      * {@link #defaultText} and {@link #defaultIconCls} via a fade out animation. If a numeric value is passed,
  203.      * it will be used as the callback interval (in milliseconds), overriding the {@link #autoClear} value.
  204.      * All other options will be defaulted as with the boolean option.  To customize any other options,
  205.      * you can pass an object in the format:<ul>
  206.      *    <li><tt>wait</tt> {Number} : (optional) The number of milliseconds to wait before clearing
  207.      *    (defaults to {@link #autoClear}).</li>
  208.      *    <li><tt>anim</tt> {Number} : (optional) False to clear the status immediately once the callback
  209.      *    executes (defaults to true which fades the status out).</li>
  210.      *    <li><tt>useDefaults</tt> {Number} : (optional) False to completely clear the status text and iconCls
  211.      *    (defaults to true which uses {@link #defaultText} and {@link #defaultIconCls}).</li>
  212.      * </ul></li></ul>
  213.      * Example usage:<pre><code>
  214. // Simple call to update the text
  215. statusBar.setStatus('New status');
  216. // Set the status and icon, auto-clearing with default options:
  217. statusBar.setStatus({
  218.     text: 'New status',
  219.     iconCls: 'x-status-custom',
  220.     clear: true
  221. });
  222. // Auto-clear with custom options:
  223. statusBar.setStatus({
  224.     text: 'New status',
  225.     iconCls: 'x-status-custom',
  226.     clear: {
  227.         wait: 8000,
  228.         anim: false,
  229.         useDefaults: false
  230.     }
  231. });
  232. </code></pre>
  233.      * @return {Ext.ux.StatusBar} this
  234.      */
  235.     setStatus : function(o){
  236.         o = o || {};
  237.         if(typeof o == 'string'){
  238.             o = {text:o};
  239.         }
  240.         if(o.text !== undefined){
  241.             this.setText(o.text);
  242.         }
  243.         if(o.iconCls !== undefined){
  244.             this.setIcon(o.iconCls);
  245.         }
  246.         if(o.clear){
  247.             var c = o.clear,
  248.                 wait = this.autoClear,
  249.                 defaults = {useDefaults: true, anim: true};
  250.             if(typeof c == 'object'){
  251.                 c = Ext.applyIf(c, defaults);
  252.                 if(c.wait){
  253.                     wait = c.wait;
  254.                 }
  255.             }else if(typeof c == 'number'){
  256.                 wait = c;
  257.                 c = defaults;
  258.             }else if(typeof c == 'boolean'){
  259.                 c = defaults;
  260.             }
  261.             c.threadId = this.activeThreadId;
  262.             this.clearStatus.defer(wait, this, [c]);
  263.         }
  264.         return this;
  265.     },
  266.     /**
  267.      * Clears the status {@link #text} and {@link #iconCls}. Also supports clearing via an optional fade out animation.
  268.      * @param {Object} config (optional) A config object containing any or all of the following properties.  If this
  269.      * object is not specified the status will be cleared using the defaults below:<ul>
  270.      * <li><tt>anim</tt> {Boolean} : (optional) True to clear the status by fading out the status element (defaults
  271.      * to false which clears immediately).</li>
  272.      * <li><tt>useDefaults</tt> {Boolean} : (optional) True to reset the text and icon using {@link #defaultText} and
  273.      * {@link #defaultIconCls} (defaults to false which sets the text to '' and removes any existing icon class).</li>
  274.      * </ul>
  275.      * @return {Ext.ux.StatusBar} this
  276.      */
  277.     clearStatus : function(o){
  278.         o = o || {};
  279.         if(o.threadId && o.threadId !== this.activeThreadId){
  280.             // this means the current call was made internally, but a newer
  281.             // thread has set a message since this call was deferred.  Since
  282.             // we don't want to overwrite a newer message just ignore.
  283.             return this;
  284.         }
  285.         var text = o.useDefaults ? this.defaultText : '',
  286.             iconCls = o.useDefaults ? (this.defaultIconCls ? this.defaultIconCls : '') : '';
  287.         if(o.anim){
  288.             this.statusEl.fadeOut({
  289.                 remove: false,
  290.                 useDisplay: true,
  291.                 scope: this,
  292.                 callback: function(){
  293.                     this.setStatus({
  294.                     text: text,
  295.                     iconCls: iconCls
  296.                 });
  297.                     this.statusEl.show();
  298.                 }
  299.             });
  300.         }else{
  301.             // hide/show the el to avoid jumpy text or icon
  302.             this.statusEl.hide();
  303.         this.setStatus({
  304.             text: text,
  305.             iconCls: iconCls
  306.         });
  307.             this.statusEl.show();
  308.         }
  309.         return this;
  310.     },
  311.     /**
  312.      * Convenience method for setting the status text directly.  For more flexible options see {@link #setStatus}.
  313.      * @param {String} text (optional) The text to set (defaults to '')
  314.      * @return {Ext.ux.StatusBar} this
  315.      */
  316.     setText : function(text){
  317.         this.activeThreadId++;
  318.         this.text = text || '';
  319.         if(this.rendered){
  320.             this.statusEl.setText(this.text);
  321.         }
  322.         return this;
  323.     },
  324.     /**
  325.      * Returns the current status text.
  326.      * @return {String} The status text
  327.      */
  328.     getText : function(){
  329.         return this.text;
  330.     },
  331.     /**
  332.      * Convenience method for setting the status icon directly.  For more flexible options see {@link #setStatus}.
  333.      * See {@link #iconCls} for complete details about customizing the icon.
  334.      * @param {String} iconCls (optional) The icon class to set (defaults to '', and any current icon class is removed)
  335.      * @return {Ext.ux.StatusBar} this
  336.      */
  337.     setIcon : function(cls){
  338.         this.activeThreadId++;
  339.         cls = cls || '';
  340.         if(this.rendered){
  341.         if(this.currIconCls){
  342.             this.statusEl.removeClass(this.currIconCls);
  343.             this.currIconCls = null;
  344.         }
  345.         if(cls.length > 0){
  346.             this.statusEl.addClass(cls);
  347.             this.currIconCls = cls;
  348.         }
  349.         }else{
  350.             this.currIconCls = cls;
  351.         }
  352.         return this;
  353.     },
  354.     /**
  355.      * Convenience method for setting the status text and icon to special values that are pre-configured to indicate
  356.      * a "busy" state, usually for loading or processing activities.
  357.      * @param {Object/String} config (optional) A config object in the same format supported by {@link #setStatus}, or a
  358.      * string to use as the status text (in which case all other options for setStatus will be defaulted).  Use the
  359.      * <tt>text</tt> and/or <tt>iconCls</tt> properties on the config to override the default {@link #busyText}
  360.      * and {@link #busyIconCls} settings. If the config argument is not specified, {@link #busyText} and
  361.      * {@link #busyIconCls} will be used in conjunction with all of the default options for {@link #setStatus}.
  362.      * @return {Ext.ux.StatusBar} this
  363.      */
  364.     showBusy : function(o){
  365.         if(typeof o == 'string'){
  366.             o = {text:o};
  367.         }
  368.         o = Ext.applyIf(o || {}, {
  369.             text: this.busyText,
  370.             iconCls: this.busyIconCls
  371.         });
  372.         return this.setStatus(o);
  373.     }
  374. });
  375. Ext.reg('statusbar', Ext.ux.StatusBar);