--- /dev/null
+<html>
+<head>
+ <title>The source code</title>
+ <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
+ <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
+</head>
+<body onload="prettyPrint();">
+ <pre class="prettyprint lang-js">Ext.namespace('Ext.ux.grid.filter');\r
+\r
+<div id="cls-Ext.ux.grid.filter.Filter"></div>/** \r
+ * @class Ext.ux.grid.filter.Filter\r
+ * @extends Ext.util.Observable\r
+ * Abstract base class for filter implementations.\r
+ */\r
+Ext.ux.grid.filter.Filter = Ext.extend(Ext.util.Observable, {\r
+ <div id="cfg-Ext.ux.grid.filter.Filter-active"></div>/**\r
+ * @cfg {Boolean} active\r
+ * Indicates the initial status of the filter (defaults to false).\r
+ */\r
+ active : false,\r
+ <div id="prop-Ext.ux.grid.filter.Filter-active"></div>/**\r
+ * True if this filter is active. Use setActive() to alter after configuration.\r
+ * @type Boolean\r
+ * @property active\r
+ */\r
+ <div id="cfg-Ext.ux.grid.filter.Filter-dataIndex"></div>/**\r
+ * @cfg {String} dataIndex \r
+ * The {@link Ext.data.Store} dataIndex of the field this filter represents.\r
+ * The dataIndex does not actually have to exist in the store.\r
+ */\r
+ dataIndex : null,\r
+ <div id="prop-Ext.ux.grid.filter.Filter-menu"></div>/**\r
+ * The filter configuration menu that will be installed into the filter submenu of a column menu.\r
+ * @type Ext.menu.Menu\r
+ * @property\r
+ */\r
+ menu : null,\r
+ <div id="cfg-Ext.ux.grid.filter.Filter-updateBuffer"></div>/**\r
+ * @cfg {Number} updateBuffer\r
+ * Number of milliseconds to wait after user interaction to fire an update. Only supported \r
+ * by filters: 'list', 'numeric', and 'string'. Defaults to 500.\r
+ */\r
+ updateBuffer : 500,\r
+\r
+ constructor : function (config) {\r
+ Ext.apply(this, config);\r
+ \r
+ this.addEvents(\r
+ <div id="event-Ext.ux.grid.filter.Filter-activate"></div>/**\r
+ * @event activate\r
+ * Fires when an inactive filter becomes active\r
+ * @param {Ext.ux.grid.filter.Filter} this\r
+ */\r
+ 'activate',\r
+ <div id="event-Ext.ux.grid.filter.Filter-deactivate"></div>/**\r
+ * @event deactivate\r
+ * Fires when an active filter becomes inactive\r
+ * @param {Ext.ux.grid.filter.Filter} this\r
+ */\r
+ 'deactivate',\r
+ <div id="event-Ext.ux.grid.filter.Filter-serialize"></div>/**\r
+ * @event serialize\r
+ * Fires after the serialization process. Use this to attach additional parameters to serialization\r
+ * data before it is encoded and sent to the server.\r
+ * @param {Array/Object} data A map or collection of maps representing the current filter configuration.\r
+ * @param {Ext.ux.grid.filter.Filter} filter The filter being serialized.\r
+ */\r
+ 'serialize',\r
+ <div id="event-Ext.ux.grid.filter.Filter-update"></div>/**\r
+ * @event update\r
+ * Fires when a filter configuration has changed\r
+ * @param {Ext.ux.grid.filter.Filter} this The filter object.\r
+ */\r
+ 'update'\r
+ );\r
+ Ext.ux.grid.filter.Filter.superclass.constructor.call(this);\r
+\r
+ this.menu = new Ext.menu.Menu();\r
+ this.init(config);\r
+ if(config && config.value){\r
+ this.setValue(config.value);\r
+ this.setActive(config.active !== false, true);\r
+ delete config.value;\r
+ }\r
+ },\r
+\r
+ <div id="method-Ext.ux.grid.filter.Filter-destroy"></div>/**\r
+ * Destroys this filter by purging any event listeners, and removing any menus.\r
+ */\r
+ destroy : function(){\r
+ if (this.menu){\r
+ this.menu.destroy();\r
+ }\r
+ this.purgeListeners();\r
+ },\r
+\r
+ <div id="prop-Ext.ux.grid.filter.Filter-init"></div>/**\r
+ * Template method to be implemented by all subclasses that is to\r
+ * initialize the filter and install required menu items.\r
+ * Defaults to Ext.emptyFn.\r
+ */\r
+ init : Ext.emptyFn,\r
+ \r
+ <div id="method-Ext.ux.grid.filter.Filter-getValue"></div>/**\r
+ * Template method to be implemented by all subclasses that is to\r
+ * get and return the value of the filter.\r
+ * Defaults to Ext.emptyFn.\r
+ * @return {Object} The 'serialized' form of this filter\r
+ * @methodOf Ext.ux.grid.filter.Filter\r
+ */\r
+ getValue : Ext.emptyFn,\r
+ \r
+ <div id="method-Ext.ux.grid.filter.Filter-setValue"></div>/**\r
+ * Template method to be implemented by all subclasses that is to\r
+ * set the value of the filter and fire the 'update' event.\r
+ * Defaults to Ext.emptyFn.\r
+ * @param {Object} data The value to set the filter\r
+ * @methodOf Ext.ux.grid.filter.Filter\r
+ */ \r
+ setValue : Ext.emptyFn,\r
+ \r
+ <div id="method-Ext.ux.grid.filter.Filter-isActivatable"></div>/**\r
+ * Template method to be implemented by all subclasses that is to\r
+ * return <tt>true</tt> if the filter has enough configuration information to be activated.\r
+ * Defaults to <tt>return true</tt>.\r
+ * @return {Boolean}\r
+ */\r
+ isActivatable : function(){\r
+ return true;\r
+ },\r
+ \r
+ <div id="prop-Ext.ux.grid.filter.Filter-getSerialArgs"></div>/**\r
+ * Template method to be implemented by all subclasses that is to\r
+ * get and return serialized filter data for transmission to the server.\r
+ * Defaults to Ext.emptyFn.\r
+ */\r
+ getSerialArgs : Ext.emptyFn,\r
+\r
+ <div id="method-Ext.ux.grid.filter.Filter-validateRecord"></div>/**\r
+ * Template method to be implemented by all subclasses that is to\r
+ * validates the provided Ext.data.Record against the filters configuration.\r
+ * Defaults to <tt>return true</tt>.\r
+ * @param {Ext.data.Record} record The record to validate\r
+ * @return {Boolean} true if the record is valid within the bounds\r
+ * of the filter, false otherwise.\r
+ */\r
+ validateRecord : function(){\r
+ return true;\r
+ },\r
+\r
+ <div id="method-Ext.ux.grid.filter.Filter-serialize"></div>/**\r
+ * Returns the serialized filter data for transmission to the server\r
+ * and fires the 'serialize' event.\r
+ * @return {Object/Array} An object or collection of objects containing\r
+ * key value pairs representing the current configuration of the filter.\r
+ * @methodOf Ext.ux.grid.filter.Filter\r
+ */\r
+ serialize : function(){\r
+ var args = this.getSerialArgs();\r
+ this.fireEvent('serialize', args, this);\r
+ return args;\r
+ },\r
+\r
+ /** @private */\r
+ fireUpdate : function(){\r
+ if (this.active) {\r
+ this.fireEvent('update', this);\r
+ }\r
+ this.setActive(this.isActivatable());\r
+ },\r
+ \r
+ <div id="method-Ext.ux.grid.filter.Filter-setActive"></div>/**\r
+ * Sets the status of the filter and fires the appropriate events.\r
+ * @param {Boolean} active The new filter state.\r
+ * @param {Boolean} suppressEvent True to prevent events from being fired.\r
+ * @methodOf Ext.ux.grid.filter.Filter\r
+ */\r
+ setActive : function(active, suppressEvent){\r
+ if(this.active != active){\r
+ this.active = active;\r
+ if (suppressEvent !== true) {\r
+ this.fireEvent(active ? 'activate' : 'deactivate', this);\r
+ }\r
+ }\r
+ } \r
+});</pre>
+</body>
+</html>
\ No newline at end of file
git.ithinksw.org / extjs.git / blobdiff