examples/docs/source/Filter.html

   1 <html>
   2 <head>
   3   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   4   <title>The source code</title>
   5     <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
   6     <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
   7 </head>
   8 <body  onload="prettyPrint();">
   9     <pre class="prettyprint lang-js">/*!
  10  * Ext JS Library 3.3.1
  11  * Copyright(c) 2006-2010 Sencha Inc.
  12  * licensing@sencha.com
  13  * http://www.sencha.com/license
  14  */
  15 Ext.namespace('Ext.ux.grid.filter');
  16
  17 <div id="cls-Ext.ux.grid.filter.Filter"></div>/**
  18  * @class Ext.ux.grid.filter.Filter
  19  * @extends Ext.util.Observable
  20  * Abstract base class for filter implementations.
  21  */
  22 Ext.ux.grid.filter.Filter = Ext.extend(Ext.util.Observable, {
  23     <div id="cfg-Ext.ux.grid.filter.Filter-active"></div>/**
  24      * @cfg {Boolean} active
  25      * Indicates the initial status of the filter (defaults to false).
  26      */
  27     active : false,
  28     <div id="prop-Ext.ux.grid.filter.Filter-active"></div>/**
  29      * True if this filter is active.  Use setActive() to alter after configuration.
  30      * @type Boolean
  31      * @property active
  32      */
  33     <div id="cfg-Ext.ux.grid.filter.Filter-dataIndex"></div>/**
  34      * @cfg {String} dataIndex
  35      * The {@link Ext.data.Store} dataIndex of the field this filter represents.
  36      * The dataIndex does not actually have to exist in the store.
  37      */
  38     dataIndex : null,
  39     <div id="prop-Ext.ux.grid.filter.Filter-menu"></div>/**
  40      * The filter configuration menu that will be installed into the filter submenu of a column menu.
  41      * @type Ext.menu.Menu
  42      * @property
  43      */
  44     menu : null,
  45     <div id="cfg-Ext.ux.grid.filter.Filter-updateBuffer"></div>/**
  46      * @cfg {Number} updateBuffer
  47      * Number of milliseconds to wait after user interaction to fire an update. Only supported
  48      * by filters: 'list', 'numeric', and 'string'. Defaults to 500.
  49      */
  50     updateBuffer : 500,
  51
  52     constructor : function (config) {
  53         Ext.apply(this, config);
  54
  55         this.addEvents(
  56             <div id="event-Ext.ux.grid.filter.Filter-activate"></div>/**
  57              * @event activate
  58              * Fires when an inactive filter becomes active
  59              * @param {Ext.ux.grid.filter.Filter} this
  60              */
  61             'activate',
  62             <div id="event-Ext.ux.grid.filter.Filter-deactivate"></div>/**
  63              * @event deactivate
  64              * Fires when an active filter becomes inactive
  65              * @param {Ext.ux.grid.filter.Filter} this
  66              */
  67             'deactivate',
  68             <div id="event-Ext.ux.grid.filter.Filter-serialize"></div>/**
  69              * @event serialize
  70              * Fires after the serialization process. Use this to attach additional parameters to serialization
  71              * data before it is encoded and sent to the server.
  72              * @param {Array/Object} data A map or collection of maps representing the current filter configuration.
  73              * @param {Ext.ux.grid.filter.Filter} filter The filter being serialized.
  74              */
  75             'serialize',
  76             <div id="event-Ext.ux.grid.filter.Filter-update"></div>/**
  77              * @event update
  78              * Fires when a filter configuration has changed
  79              * @param {Ext.ux.grid.filter.Filter} this The filter object.
  80              */
  81             'update'
  82         );
  83         Ext.ux.grid.filter.Filter.superclass.constructor.call(this);
  84
  85         this.menu = new Ext.menu.Menu();
  86         this.init(config);
  87         if(config && config.value){
  88             this.setValue(config.value);
  89             this.setActive(config.active !== false, true);
  90             delete config.value;
  91         }
  92     },
  93
  94     <div id="method-Ext.ux.grid.filter.Filter-destroy"></div>/**
  95      * Destroys this filter by purging any event listeners, and removing any menus.
  96      */
  97     destroy : function(){
  98         if (this.menu){
  99             this.menu.destroy();
 100         }
 101         this.purgeListeners();
 102     },
 103
 104     <div id="prop-Ext.ux.grid.filter.Filter-init"></div>/**
 105      * Template method to be implemented by all subclasses that is to
 106      * initialize the filter and install required menu items.
 107      * Defaults to Ext.emptyFn.
 108      */
 109     init : Ext.emptyFn,
 110
 111     <div id="method-Ext.ux.grid.filter.Filter-getValue"></div>/**
 112      * Template method to be implemented by all subclasses that is to
 113      * get and return the value of the filter.
 114      * Defaults to Ext.emptyFn.
 115      * @return {Object} The 'serialized' form of this filter
 116      * @methodOf Ext.ux.grid.filter.Filter
 117      */
 118     getValue : Ext.emptyFn,
 119
 120     <div id="method-Ext.ux.grid.filter.Filter-setValue"></div>/**
 121      * Template method to be implemented by all subclasses that is to
 122      * set the value of the filter and fire the 'update' event.
 123      * Defaults to Ext.emptyFn.
 124      * @param {Object} data The value to set the filter
 125      * @methodOf Ext.ux.grid.filter.Filter
 126      */
 127     setValue : Ext.emptyFn,
 128
 129     <div id="method-Ext.ux.grid.filter.Filter-isActivatable"></div>/**
 130      * Template method to be implemented by all subclasses that is to
 131      * return <tt>true</tt> if the filter has enough configuration information to be activated.
 132      * Defaults to <tt>return true</tt>.
 133      * @return {Boolean}
 134      */
 135     isActivatable : function(){
 136         return true;
 137     },
 138
 139     <div id="prop-Ext.ux.grid.filter.Filter-getSerialArgs"></div>/**
 140      * Template method to be implemented by all subclasses that is to
 141      * get and return serialized filter data for transmission to the server.
 142      * Defaults to Ext.emptyFn.
 143      */
 144     getSerialArgs : Ext.emptyFn,
 145
 146     <div id="method-Ext.ux.grid.filter.Filter-validateRecord"></div>/**
 147      * Template method to be implemented by all subclasses that is to
 148      * validates the provided Ext.data.Record against the filters configuration.
 149      * Defaults to <tt>return true</tt>.
 150      * @param {Ext.data.Record} record The record to validate
 151      * @return {Boolean} true if the record is valid within the bounds
 152      * of the filter, false otherwise.
 153      */
 154     validateRecord : function(){
 155         return true;
 156     },
 157
 158     <div id="method-Ext.ux.grid.filter.Filter-serialize"></div>/**
 159      * Returns the serialized filter data for transmission to the server
 160      * and fires the 'serialize' event.
 161      * @return {Object/Array} An object or collection of objects containing
 162      * key value pairs representing the current configuration of the filter.
 163      * @methodOf Ext.ux.grid.filter.Filter
 164      */
 165     serialize : function(){
 166         var args = this.getSerialArgs();
 167         this.fireEvent('serialize', args, this);
 168         return args;
 169     },
 170
 171     /** @private */
 172     fireUpdate : function(){
 173         if (this.active) {
 174             this.fireEvent('update', this);
 175         }
 176         this.setActive(this.isActivatable());
 177     },
 178
 179     <div id="method-Ext.ux.grid.filter.Filter-setActive"></div>/**
 180      * Sets the status of the filter and fires the appropriate events.
 181      * @param {Boolean} active        The new filter state.
 182      * @param {Boolean} suppressEvent True to prevent events from being fired.
 183      * @methodOf Ext.ux.grid.filter.Filter
 184      */
 185     setActive : function(active, suppressEvent){
 186         if(this.active != active){
 187             this.active = active;
 188             if (suppressEvent !== true) {
 189                 this.fireEvent(active ? 'activate' : 'deactivate', this);
 190             }
 191         }
 192     }
 193 });</pre>
 194 </body>
 195 </html>