Upgrade to ExtJS 3.1.0 - Released 12/16/2009
[extjs.git] / docs / source / BooleanFilter.html
diff --git a/docs/source/BooleanFilter.html b/docs/source/BooleanFilter.html
deleted file mode 100644 (file)
index 8d9c3bf..0000000
+++ /dev/null
@@ -1,106 +0,0 @@
-<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"><div id="cls-Ext.ux.grid.filter.BooleanFilter"></div>/** \r
- * @class Ext.ux.grid.filter.BooleanFilter\r
- * @extends Ext.ux.grid.filter.Filter\r
- * Boolean filters use unique radio group IDs (so you can have more than one!)\r
- * <p><b><u>Example Usage:</u></b></p>\r
- * <pre><code>    \r
-var filters = new Ext.ux.grid.GridFilters({\r
-    ...\r
-    filters: [{\r
-        // required configs\r
-        type: 'boolean',\r
-        dataIndex: 'visible'\r
-\r
-        // optional configs\r
-        defaultValue: null, // leave unselected (false selected by default)\r
-        yesText: 'Yes',     // default\r
-        noText: 'No'        // default\r
-    }]\r
-});\r
- * </code></pre>\r
- */\r
-Ext.ux.grid.filter.BooleanFilter = Ext.extend(Ext.ux.grid.filter.Filter, {\r
-       <div id="cfg-Ext.ux.grid.filter.BooleanFilter-defaultValue"></div>/**\r
-        * @cfg {Boolean} defaultValue\r
-        * Set this to null if you do not want either option to be checked by default. Defaults to false.\r
-        */\r
-       defaultValue : false,\r
-       <div id="cfg-Ext.ux.grid.filter.BooleanFilter-yesText"></div>/**\r
-        * @cfg {String} yesText\r
-        * Defaults to 'Yes'.\r
-        */\r
-       yesText : 'Yes',\r
-       <div id="cfg-Ext.ux.grid.filter.BooleanFilter-noText"></div>/**\r
-        * @cfg {String} noText\r
-        * Defaults to 'No'.\r
-        */\r
-       noText : 'No',\r
-\r
-    /**  \r
-     * @private\r
-     * Template method that is to initialize the filter and install required menu items.\r
-     */\r
-    init : function (config) {\r
-        var gId = Ext.id();\r
-               this.options = [\r
-                       new Ext.menu.CheckItem({text: this.yesText, group: gId, checked: this.defaultValue === true}),\r
-                       new Ext.menu.CheckItem({text: this.noText, group: gId, checked: this.defaultValue === false})];\r
-               \r
-               this.menu.add(this.options[0], this.options[1]);\r
-               \r
-               for(var i=0; i<this.options.length; i++){\r
-                       this.options[i].on('click', this.fireUpdate, this);\r
-                       this.options[i].on('checkchange', this.fireUpdate, this);\r
-               }\r
-       },\r
-       \r
-    /**\r
-     * @private\r
-     * Template method that is to get and return the value of the filter.\r
-     * @return {String} The value of this filter\r
-     */\r
-    getValue : function () {\r
-               return this.options[0].checked;\r
-       },\r
-\r
-    /**\r
-     * @private\r
-     * Template method that is to set the value of the filter.\r
-     * @param {Object} value The value to set the filter\r
-     */        \r
-       setValue : function (value) {\r
-               this.options[value ? 0 : 1].setChecked(true);\r
-       },\r
-\r
-    /**\r
-     * @private\r
-     * Template method that is to get and return serialized filter data for\r
-     * transmission to the server.\r
-     * @return {Object/Array} An object or collection of objects containing\r
-     * key value pairs representing the current configuration of the filter.\r
-     */\r
-    getSerialArgs : function () {\r
-               var args = {type: 'boolean', value: this.getValue()};\r
-               return args;\r
-       },\r
-       \r
-    <div id="method-Ext.ux.grid.filter.BooleanFilter-validateRecord"></div>/**\r
-     * Template method that is to validate the provided Ext.data.Record\r
-     * against the filters configuration.\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 (record) {\r
-               return record.get(this.dataIndex) == this.getValue();\r
-       }\r
-});</pre>
-</body>
-</html>
\ No newline at end of file