add extjs 6.0.1 sources

[extjs.git] / extjs / classic / classic / src / grid / filters / filter / Boolean.js

/**\r
 * The boolean grid filter allows you to create a filter selection that limits results\r
 * to values matching true or false.  The filter can be set programmatically or via \r
 * user input with a configurable {@link Ext.form.field.Radio radio field} in the filter section \r
 * of the column header.\r
 * \r
 * Boolean filters use unique radio group IDs, so you may utilize more than one.\r
 *\r
 * Example Boolean Filter Usage:\r
 * \r
 *     @example\r
 *     var shows = Ext.create('Ext.data.Store', {\r
 *         fields: ['id','show', 'visible'],\r
 *         data: [\r
 *             {id: 0, show: 'Battlestar Galactica', visible: true},\r
 *             {id: 1, show: 'Doctor Who', visible: true},\r
 *             {id: 2, show: 'Farscape', visible: false},\r
 *             {id: 3, show: 'Firefly', visible: true},\r
 *             {id: 4, show: 'Star Trek', visible: true},\r
 *             {id: 5, show: 'Star Wars: Christmas Special', visible: false}\r
 *         ]\r
 *     });\r
 *   \r
 *     Ext.create('Ext.grid.Panel', {\r
 *         renderTo: Ext.getBody(),\r
 *         title: 'Sci-Fi Television',\r
 *         height: 250,\r
 *         width: 375,\r
 *         store: shows,\r
 *         plugins: 'gridfilters',\r
 *         columns: [{\r
 *             dataIndex: 'id',\r
 *             text: 'ID',\r
 *             width: 50\r
 *         },{\r
 *             dataIndex: 'show',\r
 *             text: 'Show',\r
 *             flex: 1                  \r
 *         },{\r
 *             dataIndex: 'visible',\r
 *             text: 'Visibility',\r
 *             width: 125,\r
 *             filter: {\r
 *                 type: 'boolean',\r
 *                 value: 'true',\r
 *                 yesText: 'True',\r
 *                 noText: 'False'\r
 *             }\r
 *         }]\r
 *     });  \r
 */\r
Ext.define('Ext.grid.filters.filter.Boolean', {\r
    extend: 'Ext.grid.filters.filter.SingleFilter',\r
    alias: 'grid.filter.boolean',\r
\r
    type: 'boolean',\r
\r
    operator: '=',\r
\r
    /**\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
\r
    //<locale>\r
    /**\r
     * @cfg {String} yesText\r
     * Defaults to 'Yes'.\r
     */\r
    yesText: 'Yes',\r
    //</locale>\r
\r
    //<locale>\r
    /**\r
     * @cfg {String} noText\r
     * Defaults to 'No'.\r
     */\r
    noText: 'No',\r
    //</locale>\r
\r
    updateBuffer: 0,\r
\r
    /**\r
     * @private\r
     * Template method that is to initialize the filter and install required menu items.\r
     */\r
    createMenu: function (config) {\r
        var me = this,\r
            gId = Ext.id(),\r
            listeners = {\r
                scope: me,\r
                click: me.onClick\r
            },\r
            itemDefaults = me.getItemDefaults();\r
\r
        me.callParent(arguments);\r
\r
        me.menu.add([Ext.apply({\r
            text: me.yesText,\r
            filterKey: 1,\r
            group: gId,\r
            checked: !!me.defaultValue,\r
            listeners: listeners\r
        }, itemDefaults), Ext.apply({\r
            text: me.noText,\r
            filterKey: 0,\r
            group: gId,\r
            checked: !me.defaultValue,\r
            listeners: listeners\r
        }, itemDefaults)]);\r
    },\r
\r
    /**\r
     * @private\r
     */\r
    onClick: function (field) {\r
        this.setValue(!!field.filterKey);\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
        var me = this;\r
\r
        me.filter.setValue(value);\r
\r
        if (value !== undefined && me.active) {\r
            me.value = value;\r
            me.updateStoreFilter();\r
        } else {\r
            me.setActive(true);\r
        }\r
    },\r
\r
    // This is supposed to be just a stub.\r
    activateMenu: Ext.emptyFn\r
});\r