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

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.ux.grid.filter.ListFilter
  3.  * @extends Ext.ux.grid.filter.Filter
  4.  * <p>List filters are able to be preloaded/backed by an Ext.data.Store to load
  5.  * their options the first time they are shown. ListFilter utilizes the
  6.  * {@link Ext.ux.menu.ListMenu} component.</p>
  7.  * <p>Although not shown here, this class accepts all configuration options
  8.  * for {@link Ext.ux.menu.ListMenu}.</p>
  9.  * 
  10.  * <p><b><u>Example Usage:</u></b></p>
  11.  * <pre><code>    
  12. var filters = new Ext.ux.grid.GridFilters({
  13.     ...
  14.     filters: [{
  15.         type: 'list',
  16.         dataIndex: 'size',
  17.         phpMode: true,
  18.         // options will be used as data to implicitly creates an ArrayStore
  19.         options: ['extra small', 'small', 'medium', 'large', 'extra large']
  20.     }]
  21. });
  22.  * </code></pre>
  23.  * 
  24.  */
  25. Ext.ux.grid.filter.ListFilter = Ext.extend(Ext.ux.grid.filter.Filter, {
  26.     /**
  27.      * @cfg {Array} options
  28.      * <p><code>data</code> to be used to implicitly create a data store
  29.      * to back this list when the data source is <b>local</b>. If the
  30.      * data for the list is remote, use the <code>{@link #store}</code>
  31.      * config instead.</p>
  32.      * <br><p>Each item within the provided array may be in one of the
  33.      * following formats:</p>
  34.      * <div class="mdetail-params"><ul>
  35.      * <li><b>Array</b> :
  36.      * <pre><code>
  37. options: [
  38.     [11, 'extra small'], 
  39.     [18, 'small'],
  40.     [22, 'medium'],
  41.     [35, 'large'],
  42.     [44, 'extra large']
  43. ]
  44.      * </code></pre>
  45.      * </li>
  46.      * <li><b>Object</b> :
  47.      * <pre><code>
  48. labelField: 'name', // override default of 'text'
  49. options: [
  50.     {id: 11, name:'extra small'}, 
  51.     {id: 18, name:'small'}, 
  52.     {id: 22, name:'medium'}, 
  53.     {id: 35, name:'large'}, 
  54.     {id: 44, name:'extra large'} 
  55. ]
  56.      * </code></pre>
  57.      * </li>
  58.      * <li><b>String</b> :
  59.      * <pre><code>
  60.      * options: ['extra small', 'small', 'medium', 'large', 'extra large']
  61.      * </code></pre>
  62.      * </li>
  63.      */
  64.     /**
  65.      * @cfg {Boolean} phpMode
  66.      * <p>Adjust the format of this filter. Defaults to false.</p>
  67.      * <br><p>When GridFilters <code>@cfg encode = false</code> (default):</p>
  68.      * <pre><code>
  69. // phpMode == false (default):
  70. filter[0][data][type] list
  71. filter[0][data][value] value1
  72. filter[0][data][value] value2
  73. filter[0][field] prod 
  74. // phpMode == true:
  75. filter[0][data][type] list
  76. filter[0][data][value] value1, value2
  77. filter[0][field] prod 
  78.      * </code></pre>
  79.      * When GridFilters <code>@cfg encode = true</code>:
  80.      * <pre><code>
  81. // phpMode == false (default):
  82. filter : [{"type":"list","value":["small","medium"],"field":"size"}]
  83. // phpMode == true:
  84. filter : [{"type":"list","value":"small,medium","field":"size"}]
  85.      * </code></pre>
  86.      */
  87.     phpMode : false,
  88.     /**
  89.      * @cfg {Ext.data.Store} store
  90.      * The {@link Ext.data.Store} this list should use as its data source
  91.      * when the data source is <b>remote</b>. If the data for the list
  92.      * is local, use the <code>{@link #options}</code> config instead.
  93.      */
  94.     /**  
  95.      * @private
  96.      * Template method that is to initialize the filter and install required menu items.
  97.      * @param {Object} config
  98.      */
  99.     init : function (config) {
  100.         this.dt = new Ext.util.DelayedTask(this.fireUpdate, this);
  101.         // if a menu already existed, do clean up first
  102.         if (this.menu){
  103.             this.menu.destroy();
  104.         }
  105.         this.menu = new Ext.ux.menu.ListMenu(config);
  106.         this.menu.on('checkchange', this.onCheckChange, this);
  107.     },
  108.     
  109.     /**
  110.      * @private
  111.      * Template method that is to get and return the value of the filter.
  112.      * @return {String} The value of this filter
  113.      */
  114.     getValue : function () {
  115.         return this.menu.getSelected();
  116.     },
  117.     /**
  118.      * @private
  119.      * Template method that is to set the value of the filter.
  120.      * @param {Object} value The value to set the filter
  121.      */
  122.     setValue : function (value) {
  123.         this.menu.setSelected(value);
  124.         this.fireEvent('update', this);
  125.     },
  126.     /**
  127.      * @private
  128.      * Template method that is to return <tt>true</tt> if the filter
  129.      * has enough configuration information to be activated.
  130.      * @return {Boolean}
  131.      */
  132.     isActivatable : function () {
  133.         return this.getValue().length > 0;
  134.     },
  135.     
  136.     /**
  137.      * @private
  138.      * Template method that is to get and return serialized filter data for
  139.      * transmission to the server.
  140.      * @return {Object/Array} An object or collection of objects containing
  141.      * key value pairs representing the current configuration of the filter.
  142.      */
  143.     getSerialArgs : function () {
  144.         var args = {type: 'list', value: this.phpMode ? this.getValue().join(',') : this.getValue()};
  145.         return args;
  146.     },
  147.     /** @private */
  148.     onCheckChange : function(){
  149.         this.dt.delay(this.updateBuffer);
  150.     },
  151.     
  152.     
  153.     /**
  154.      * Template method that is to validate the provided Ext.data.Record
  155.      * against the filters configuration.
  156.      * @param {Ext.data.Record} record The record to validate
  157.      * @return {Boolean} true if the record is valid within the bounds
  158.      * of the filter, false otherwise.
  159.      */
  160.     validateRecord : function (record) {
  161.         return this.getValue().indexOf(record.get(this.dataIndex)) > -1;
  162.     }
  163. });