Ext.data.JsonP.Ext_ux_grid_FiltersFeature({"alternateClassNames":[],"aliases":{"feature":["filters"]},"enum":null,"parentMixins":[],"tagname":"class","subclasses":[],"extends":"Ext.grid.feature.Feature","uses":["Ext.ux.grid.filter.BooleanFilter","Ext.ux.grid.filter.DateFilter","Ext.ux.grid.filter.DateTimeFilter","Ext.ux.grid.filter.ListFilter","Ext.ux.grid.filter.NumericFilter","Ext.ux.grid.filter.StringFilter","Ext.ux.grid.menu.ListMenu","Ext.ux.grid.menu.RangeMenu"],"html":"

Hierarchy

Uses

Files

FiltersFeature is a grid feature that allows for a slightly more\nrobust representation of filtering than what is provided by the default store.

\n\n

Filtering is adjusted by the user using the grid's column header menu (this menu can be\ndisabled through configuration). Through this menu users can configure, enable, and\ndisable filters for each column.

\n\n

Features

\n\n

Filtering implementations:

\n\n

Default filtering for Strings, Numeric Ranges, Date Ranges, Lists (which can be backed by a\nExt.data.Store), and Boolean. Additional custom filter types and menus are easily\ncreated by extending Ext.ux.grid.filter.Filter.

\n\n

Graphical Indicators:

\n\n

Columns that are filtered have a configurable css class applied to the column headers.

\n\n

Automatic Reconfiguration:

\n\n

Filters automatically reconfigure when the grid 'reconfigure' event fires.

\n\n

Stateful:

\n\n

Filter information will be persisted across page loads by specifying a stateId\nin the Grid configuration.

\n\n

The filter collection binds to the beforestaterestore\nand beforestatesave events in order to be stateful.

\n\n

GridPanel Changes:

\n\n\n\n\n

Server side code examples:

\n\n\n\n\n

Example usage:

\n\n
var store = Ext.create('Ext.data.Store', {\n    pageSize: 15\n    ...\n});\n\nvar filtersCfg = {\n    ftype: 'filters',\n    autoReload: false, //don't reload automatically\n    local: true, //only filter locally\n    // filters may be configured through the plugin,\n    // or in the column definition within the headers configuration\n    filters: [{\n        type: 'numeric',\n        dataIndex: 'id'\n    }, {\n        type: 'string',\n        dataIndex: 'name'\n    }, {\n        type: 'numeric',\n        dataIndex: 'price'\n    }, {\n        type: 'date',\n        dataIndex: 'dateAdded'\n    }, {\n        type: 'list',\n        dataIndex: 'size',\n        options: ['extra small', 'small', 'medium', 'large', 'extra large'],\n        phpMode: true\n    }, {\n        type: 'boolean',\n        dataIndex: 'visible'\n    }]\n};\n\nvar grid = Ext.create('Ext.grid.Panel', {\n     store: store,\n     columns: ...,\n     features: [filtersCfg],\n     height: 400,\n     width: 700,\n     bbar: Ext.create('Ext.PagingToolbar', {\n         store: store\n     })\n});\n\n// a filters property is added to the GridPanel\ngrid.filters\n
\n
Defined By

Config options

Ext.ux.grid.FiltersFeature
view source
: Boolean
Defaults to true, reloading the datasource when a filter change happens. ...

Defaults to true, reloading the datasource when a filter change happens.\nSet this to false to prevent the datastore from being reloaded if there\nare changes to the filters. See updateBuffer.

\n

Defaults to: true

Ext.ux.grid.FiltersFeature
view source
: Boolean
Specify true for buildQuery to use Ext.util.JSON.encode to\nencode the filter query parameter sent with a remote request. ...

Specify true for buildQuery to use Ext.util.JSON.encode to\nencode the filter query parameter sent with a remote request.\nDefaults to false.

\n
Ext.ux.grid.FiltersFeature
view source
: String
The css class to be applied to column headers with active filters. ...

The css class to be applied to column headers with active filters.\nDefaults to 'ux-filterd-column'.

\n

Defaults to: 'ux-filtered-column'

Ext.ux.grid.FiltersFeature
view source
: Array
An Array of filters config objects. ...

An Array of filters config objects. Refer to each filter type class for\nconfiguration details specific to each filter type. Filters for Strings,\nNumeric Ranges, Date Ranges, Lists, and Boolean are the standard filters\navailable.

\n
A config object containing one or more event handlers to be added to this object during initialization. ...

A config object containing one or more event handlers to be added to this object during initialization. This\nshould be a valid listeners config object as specified in the addListener example for attaching multiple\nhandlers at once.

\n\n

DOM events from Ext JS Components

\n\n

While some Ext JS Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this is usually\nonly done when extra value can be added. For example the DataView's itemclick event passing the node clicked on. To access DOM events directly from a\nchild element of a Component, we need to specify the element option to identify the Component property to add a\nDOM listener to:

\n\n
new Ext.panel.Panel({\n    width: 400,\n    height: 200,\n    dockedItems: [{\n        xtype: 'toolbar'\n    }],\n    listeners: {\n        click: {\n            element: 'el', //bind to the underlying el property on the panel\n            fn: function(){ console.log('click el'); }\n        },\n        dblclick: {\n            element: 'body', //bind to the underlying body property on the panel\n            fn: function(){ console.log('dblclick body'); }\n        }\n    }\n});\n
\n
Ext.ux.grid.FiltersFeature
view source
: Boolean
true to use Ext.data.Store filter functions (local filtering)\ninstead of the default (false) server side filtering. ...

true to use Ext.data.Store filter functions (local filtering)\ninstead of the default (false) server side filtering.

\n

Defaults to: false

Ext.ux.grid.FiltersFeature
view source
: String
defaults to 'Filters'. ...

defaults to 'Filters'.

\n

Defaults to: 'Filters'

Ext.ux.grid.FiltersFeature
view source
: String
The url parameter prefix for the filters. ...

The url parameter prefix for the filters.\nDefaults to 'filter'.

\n

Defaults to: 'filter'

Ext.ux.grid.FiltersFeature
view source
: Boolean
Defaults to true, including a filter submenu in the default header menu. ...

Defaults to true, including a filter submenu in the default header menu.

\n

Defaults to: true

Ext.ux.grid.FiltersFeature
view source
stateId : String

Name of the value to be used to store state information.

\n

Name of the value to be used to store state information.

\n
Ext.ux.grid.FiltersFeature
view source
: Number
Number of milliseconds to defer store updates since the last filter change. ...

Number of milliseconds to defer store updates since the last filter change.

\n

Defaults to: 500

Properties

Defined By

Instance Properties

...
\n

Defaults to: 'Ext.Base'

...
\n

Defaults to: {}

True when feature is disabled. ...

True when feature is disabled.

\n

Defaults to: false

Prefix to use when firing events on the view. ...

Prefix to use when firing events on the view.\nFor example a prefix of group would expose \"groupclick\", \"groupcontextmenu\", \"groupdblclick\".

\n

Selector used to determine when to fire the event with the eventPrefix.

\n

Selector used to determine when to fire the event with the eventPrefix.

\n
Initial suspended call count. ...

Initial suspended call count. Incremented when suspendEvents is called, decremented when resumeEvents is called.

\n

Defaults to: 0

Reference to the grid panel

\n

Reference to the grid panel

\n
Ext.ux.grid.FiltersFeature
view source
: Boolean
doesn't handle grid body events\n\nMost features will expose additional events, some may not and will\nneed to change th...

doesn't handle grid body events

\n\n

Most features will expose additional events, some may not and will\nneed to change this to false.

\n

Defaults to: false

Overrides: Ext.grid.feature.Feature.hasFeatureEvent

This object holds a key for any event that has a listener. ...

This object holds a key for any event that has a listener. The listener may be set\ndirectly on the instance, or on its class or a super class (via observe) or\non the MVC EventBus. The values of this object are truthy\n(a non-zero number) and falsy (0 or undefined). They do not represent an exact count\nof listeners. The value for an event is truthy if the event must be fired and is\nfalsy if there is no need to fire the event.

\n\n

The intended use of this property is to avoid the expense of fireEvent calls when\nthere are no listeners. This can be particularly helpful when one would otherwise\nhave to call fireEvent hundreds or thousands of times. It is used like this:

\n\n
 if (this.hasListeners.foo) {\n     this.fireEvent('foo', this, arg1);\n }\n
\n
...
\n

Defaults to: []

...
\n

Defaults to: {}

true in this class to identify an object as an instantiated Feature, or subclass thereof. ...

true in this class to identify an object as an instantiated Feature, or subclass thereof.

\n

Defaults to: true

...
\n

Defaults to: true

true in this class to identify an object as an instantiated Observable, or subclass thereof. ...

true in this class to identify an object as an instantiated Observable, or subclass thereof.

\n

Defaults to: true

Get the reference to the current class from which this object was instantiated. ...

Get the reference to the current class from which this object was instantiated. Unlike statics,\nthis.self is scope-dependent and it's meant to be used for dynamic inheritance. See statics\nfor a detailed comparison

\n\n
Ext.define('My.Cat', {\n    statics: {\n        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n    },\n\n    constructor: function() {\n        alert(this.self.speciesName); // dependent on 'this'\n    },\n\n    clone: function() {\n        return new this.self();\n    }\n});\n\n\nExt.define('My.SnowLeopard', {\n    extend: 'My.Cat',\n    statics: {\n        speciesName: 'Snow Leopard'         // My.SnowLeopard.speciesName = 'Snow Leopard'\n    }\n});\n\nvar cat = new My.Cat();                     // alerts 'Cat'\nvar snowLeopard = new My.SnowLeopard();     // alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone));             // alerts 'My.SnowLeopard'\n
\n

Reference to the TableView.

\n

Reference to the TableView.

\n
Defined By

Static Properties

...
\n

Defaults to: []

Methods

Defined By

Instance Methods

Ext.ux.grid.FiltersFeature
view source
new( config ) : Ext.ux.grid.FiltersFeatureprivate
...
Adds the specified events to the list of events which this Observable may fire. ...

Adds the specified events to the list of events which this Observable may fire.

\n

Parameters

  • eventNames : Object/String...

    Either an object with event names as properties with\na value of true. For example:

    \n\n
    this.addEvents({\n    storeloaded: true,\n    storecleared: true\n});\n
    \n\n

    Or any number of event names as separate parameters. For example:

    \n\n
    this.addEvents('storeloaded', 'storecleared');\n
    \n
Ext.ux.grid.FiltersFeature
view source
( config ) : Ext.ux.grid.filter.Filter
Adds a filter to the collection and observes it for state change. ...

Adds a filter to the collection and observes it for state change.

\n

Parameters

Returns

Ext.ux.grid.FiltersFeature
view source
( filters )
Adds filters to the collection. ...

Adds filters to the collection.

\n

Parameters

  • filters : Array

    An Array of filter configuration objects.

    \n
( eventName, [fn], [scope], [options] ) : Object
Appends an event handler to this object. ...

Appends an event handler to this object. For example:

\n\n
myGridPanel.on(\"mouseover\", this.onMouseOver, this);\n
\n\n

The method also allows for a single argument to be passed which is a config object\ncontaining properties which specify multiple events. For example:

\n\n
myGridPanel.on({\n    cellClick: this.onCellClick,\n    mouseover: this.onMouseOver,\n    mouseout: this.onMouseOut,\n    scope: this // Important. Ensure \"this\" is correct during handler execution\n});\n
\n\n

One can also specify options for each event handler separately:

\n\n
myGridPanel.on({\n    cellClick: {fn: this.onCellClick, scope: this, single: true},\n    mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n
\n\n

Names of methods in a specified scope may also be used. Note that\nscope MUST be specified to use this option:

\n\n
myGridPanel.on({\n    cellClick: {fn: 'onCellClick', scope: this, single: true},\n    mouseover: {fn: 'onMouseOver', scope: panel}\n});\n
\n

Parameters

  • eventName : String/Object

    The name of the event to listen for.\nMay also be an object who's property names are event names.

    \n\n
  • fn : Function (optional)

    The method the event invokes, or if scope is specified, the name* of the method within\nthe specified scope. Will be called with arguments\ngiven to fireEvent plus the options parameter described below.

    \n\n
  • scope : Object (optional)

    The scope (this reference) in which the handler function is\nexecuted. If omitted, defaults to the object which fired the event.

    \n\n
  • options : Object (optional)

    An object containing handler configuration.

    \n\n\n\n\n

    Note: Unlike in ExtJS 3.x, the options object will also be passed as the last\nargument to every event handler.

    \n\n\n\n\n

    This object may contain any of the following properties:

    \n\n
    • scope : Object

      The scope (this reference) in which the handler function is executed. If omitted,\n defaults to the object which fired the event.

      \n\n
    • delay : Number

      The number of milliseconds to delay the invocation of the handler after the event fires.

      \n\n
    • single : Boolean

      True to add a handler to handle just the next firing of the event, and then remove itself.

      \n\n
    • buffer : Number

      Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed\n by the specified number of milliseconds. If the event fires again within that time,\n the original handler is not invoked, but the new handler is scheduled in its place.

      \n\n
    • target : Ext.util.Observable

      Only call the handler if the event was fired on the target Observable, not if the event\n was bubbled up from a child Observable.

      \n\n
    • element : String

      This option is only valid for listeners bound to Components.\n The name of a Component property which references an element to add a listener to.

      \n\n\n\n\n

      This option is useful during Component construction to add DOM event listeners to elements of\n Components which will exist only after the Component is rendered.\n For example, to add a click listener to a Panel's body:

      \n\n\n\n\n
        new Ext.panel.Panel({\n      title: 'The title',\n      listeners: {\n          click: this.handlePanelClick,\n          element: 'body'\n      }\n  });\n
      \n\n
    • destroyable : Boolean (optional)

      When specified as true, the function returns A Destroyable object. An object which implements the destroy method which removes all listeners added in this call.

      \n\n

      Defaults to: false

    • priority : Number (optional)

      An optional numeric priority that determines the order in which event handlers\n are run. Event handlers with no priority will be run as if they had a priority\n of 0. Handlers with a higher priority will be prioritized to run sooner than\n those with a lower priority. Negative numbers can be used to set a priority\n lower than the default. Internally, the framework uses a range of 1000 or\n greater, and -1000 or lesser for handers that are intended to run before or\n after all others, so it is recommended to stay within the range of -999 to 999\n when setting the priority of event handlers in application-level code.

      \n\n\n\n\n

      Combining Options

      \n\n\n\n\n

      Using the options argument, it is possible to combine different types of listeners:

      \n\n\n\n\n

      A delayed, one-time listener.

      \n\n\n\n\n
      myPanel.on('hide', this.handleClick, this, {\n    single: true,\n    delay: 100\n});\n
      \n\n

Returns

  • Object

    Only when the destroyable option is specified.

    \n\n\n\n\n

    A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

    \n\n\n\n\n
    this.btnListeners =  = myButton.on({\n    destroyable: true\n    mouseover:   function() { console.log('mouseover'); },\n    mouseout:    function() { console.log('mouseout'); },\n    click:       function() { console.log('click'); }\n});\n
    \n\n\n\n\n

    And when those listeners need to be removed:

    \n\n\n\n\n
    Ext.destroy(this.btnListeners);\n
    \n\n\n\n\n

    or

    \n\n\n\n\n
    this.btnListeners.destroy();\n
    \n\n
( item, ename, [fn], [scope], [options] ) : Object
Adds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is\ndestr...

Adds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is\ndestroyed.

\n

Parameters

  • item : Ext.util.Observable/Ext.Element

    The item to which to add a listener/listeners.

    \n\n
  • ename : Object/String

    The event name, or an object containing event name properties.

    \n\n
  • fn : Function (optional)

    If the ename parameter was an event name, this is the handler function.

    \n\n
  • scope : Object (optional)

    If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.

    \n\n
  • options : Object (optional)

    If the ename parameter was an event name, this is the\naddListener options.

    \n\n

Returns

  • Object

    Only when the destroyable option is specified.

    \n\n\n\n\n

    A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

    \n\n\n\n\n
    this.btnListeners =  = myButton.mon({\n    destroyable: true\n    mouseover:   function() { console.log('mouseover'); },\n    mouseout:    function() { console.log('mouseout'); },\n    click:       function() { console.log('click'); }\n});\n
    \n\n\n\n\n

    And when those listeners need to be removed:

    \n\n\n\n\n
    Ext.destroy(this.btnListeners);\n
    \n\n\n\n\n

    or

    \n\n\n\n\n
    this.btnListeners.destroy();\n
    \n\n
Ext.ux.grid.FiltersFeature
view source
( grid, state )private
Handler for the grid's beforestaterestore event (fires before the state of the\ngrid is restored). ...

Handler for the grid's beforestaterestore event (fires before the state of the\ngrid is restored).

\n

Parameters

  • grid : Object

    The grid object

    \n
  • state : Object

    The hash of state values returned from the StateProvider.

    \n
Ext.ux.grid.FiltersFeature
view source
( store )
Changes the data store bound to this view and refreshes it. ...

Changes the data store bound to this view and refreshes it.

\n

Parameters

Ext.ux.grid.FiltersFeature
view source
( filters ) : Object
Function to take the active filters data and build it into a query. ...

Function to take the active filters data and build it into a query.\nThe format of the query depends on the encode configuration:

\n\n
    \n
  • false (Default) :\nFlatten into query string of the form (assuming paramPrefix='filters':

    \n\n
    filters[0][field]=\"someDataIndex\"&\nfilters[0][data][comparison]=\"someValue1\"&\nfilters[0][data][type]=\"someValue2\"&\nfilters[0][data][value]=\"someValue3\"&\n
  • \n
  • true :\nJSON encode the filter data

    \n\n
    {filters:[{\"field\":\"someDataIndex\",\"comparison\":\"someValue1\",\"type\":\"someValue2\",\"value\":\"someValue3\"}]}\n
  • \n
\n\n\n

Override this method to customize the format of the filter query for remote requests.

\n

Parameters

  • filters : Array

    A collection of objects representing active filters and their configuration.\nEach element will take the form of {field: dataIndex, data: filterConf}. dataIndex is not assured\nto be unique as any one filter may be a composite of more basic filters for the same dataIndex.

    \n

Returns

( args ) : Objectdeprecatedprotected
Call the original method that was previously overridden with override\n\nExt.define('My.Cat', {\n constructor: functi...

Call the original method that was previously overridden with override

\n\n
Ext.define('My.Cat', {\n    constructor: function() {\n        alert(\"I'm a cat!\");\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        this.callOverridden();\n\n        alert(\"Meeeeoooowwww\");\n    }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n                          // alerts \"I'm a cat!\"\n                          // alerts \"Meeeeoooowwww\"\n
\n
\n

This method has been deprecated

\n

as of 4.1. Use callParent instead.

\n\n
\n

Parameters

  • args : Array/Arguments

    The arguments, either an array or the arguments object\nfrom the current method, for example: this.callOverridden(arguments)

    \n

Returns

  • Object

    Returns the result of calling the overridden method

    \n
Call the \"parent\" method of the current method. ...

Call the \"parent\" method of the current method. That is the method previously\noverridden by derivation or by an override (see Ext.define).

\n\n
 Ext.define('My.Base', {\n     constructor: function (x) {\n         this.x = x;\n     },\n\n     statics: {\n         method: function (x) {\n             return x;\n         }\n     }\n });\n\n Ext.define('My.Derived', {\n     extend: 'My.Base',\n\n     constructor: function () {\n         this.callParent([21]);\n     }\n });\n\n var obj = new My.Derived();\n\n alert(obj.x);  // alerts 21\n
\n\n

This can be used with an override as follows:

\n\n
 Ext.define('My.DerivedOverride', {\n     override: 'My.Derived',\n\n     constructor: function (x) {\n         this.callParent([x*2]); // calls original My.Derived constructor\n     }\n });\n\n var obj = new My.Derived();\n\n alert(obj.x);  // now alerts 42\n
\n\n

This also works with static methods.

\n\n
 Ext.define('My.Derived2', {\n     extend: 'My.Base',\n\n     statics: {\n         method: function (x) {\n             return this.callParent([x*2]); // calls My.Base.method\n         }\n     }\n });\n\n alert(My.Base.method(10);     // alerts 10\n alert(My.Derived2.method(10); // alerts 20\n
\n\n

Lastly, it also works with overridden static methods.

\n\n
 Ext.define('My.Derived2Override', {\n     override: 'My.Derived2',\n\n     statics: {\n         method: function (x) {\n             return this.callParent([x*2]); // calls My.Derived2.method\n         }\n     }\n });\n\n alert(My.Derived2.method(10); // now alerts 40\n
\n\n

To override a method and replace it and also call the superclass method, use\ncallSuper. This is often done to patch a method to fix a bug.

\n

Parameters

  • args : Array/Arguments

    The arguments, either an array or the arguments object\nfrom the current method, for example: this.callParent(arguments)

    \n

Returns

  • Object

    Returns the result of calling the parent method

    \n
This method is used by an override to call the superclass method but bypass any\noverridden method. ...

This method is used by an override to call the superclass method but bypass any\noverridden method. This is often done to \"patch\" a method that contains a bug\nbut for whatever reason cannot be fixed directly.

\n\n

Consider:

\n\n
 Ext.define('Ext.some.Class', {\n     method: function () {\n         console.log('Good');\n     }\n });\n\n Ext.define('Ext.some.DerivedClass', {\n     method: function () {\n         console.log('Bad');\n\n         // ... logic but with a bug ...\n\n         this.callParent();\n     }\n });\n
\n\n

To patch the bug in DerivedClass.method, the typical solution is to create an\noverride:

\n\n
 Ext.define('App.paches.DerivedClass', {\n     override: 'Ext.some.DerivedClass',\n\n     method: function () {\n         console.log('Fixed');\n\n         // ... logic but with bug fixed ...\n\n         this.callSuper();\n     }\n });\n
\n\n

The patch method cannot use callParent to call the superclass method since\nthat would call the overridden method containing the bug. In other words, the\nabove patch would only produce \"Fixed\" then \"Good\" in the console log, whereas,\nusing callParent would produce \"Fixed\" then \"Bad\" then \"Good\".

\n

Parameters

  • args : Array/Arguments

    The arguments, either an array or the arguments object\nfrom the current method, for example: this.callSuper(arguments)

    \n

Returns

  • Object

    Returns the result of calling the superclass method

    \n
...
\n

Parameters

Ext.ux.grid.FiltersFeature
view source
( p )
Removes filter related query parameters from the provided object. ...

Removes filter related query parameters from the provided object.

\n

Parameters

  • p : Object

    Query parameters that may contain filter related fields.

    \n
Ext.ux.grid.FiltersFeature
view source
( )
Turns all filters off. ...

Turns all filters off. This does not clear the configuration information\n(see removeAll).

\n
Removes all listeners for this object including the managed listeners ...

Removes all listeners for this object including the managed listeners

\n
Removes all managed listeners for this object. ...

Removes all managed listeners for this object.

\n
( eventName, args, bubbles )private
Continue to fire event. ...

Continue to fire event.

\n

Parameters

Ext.ux.grid.FiltersFeature
view source
( )private
Create the Filter objects for the current configuration, destroying any existing ones first. ...

Create the Filter objects for the current configuration, destroying any existing ones first.

\n
Ext.ux.grid.FiltersFeature
view source
( )private
...
\n
Ext.ux.grid.FiltersFeature
view source
( menu )private
...
\n

Parameters

Creates an event handling function which refires the event from this object as the passed event name. ...

Creates an event handling function which refires the event from this object as the passed event name.

\n

Parameters

  • newName : String

    The name under which to refire the passed parameters.

    \n
  • beginEnd : Array (optional)

    The caller can specify on which indices to slice.

    \n

Returns

Ext.ux.grid.FiltersFeature
view source
( )private
Handler called by the grid 'beforedestroy' event ...

Handler called by the grid 'beforedestroy' event

\n

Overrides: Ext.grid.feature.Feature.destroy

Disables the feature. ...

Disables the feature.

\n
Enables the feature. ...

Enables the feature.

\n
Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if\npresent. ...

Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if\npresent. There is no implementation in the Observable base class.

\n\n

This is commonly used by Ext.Components to bubble events to owner Containers.\nSee Ext.Component.getBubbleTarget. The default implementation in Ext.Component returns the\nComponent's immediate owner. But if a known target is required, this can be overridden to access the\nrequired target more quickly.

\n\n

Example:

\n\n
Ext.define('Ext.overrides.form.field.Base', {\n    override: 'Ext.form.field.Base',\n\n    //  Add functionality to Field's initComponent to enable the change event to bubble\n    initComponent: function () {\n        this.callParent();\n        this.enableBubble('change');\n    }\n});\n\nvar myForm = Ext.create('Ext.form.Panel', {\n    title: 'User Details',\n    items: [{\n        ...\n    }],\n    listeners: {\n        change: function() {\n            // Title goes red if form has been modified.\n            myForm.header.setStyle('color', 'red');\n        }\n    }\n});\n
\n

Parameters

  • eventNames : String/String[]

    The event name to bubble, or an Array of event names.

    \n
Fires the specified event with the passed parameters (minus the event name, plus the options object passed\nto addList...

Fires the specified event with the passed parameters (minus the event name, plus the options object passed\nto addListener).

\n\n

An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) by\ncalling enableBubble.

\n

Parameters

  • eventName : String

    The name of the event to fire.

    \n
  • args : Object...

    Variable number of parameters are passed to handlers.

    \n

Returns

  • Boolean

    returns false if any of the handlers return false otherwise it returns true.

    \n
Fires the specified event with the passed parameter list. ...

Fires the specified event with the passed parameter list.

\n\n

An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) by\ncalling enableBubble.

\n

Parameters

  • eventName : String

    The name of the event to fire.

    \n
  • args : Object[]

    An array of parameters which are passed to handlers.

    \n

Returns

  • Boolean

    returns false if any of the handlers return false otherwise it returns true.

    \n
Gets the bubbling parent for an Observable ...

Gets the bubbling parent for an Observable

\n

Returns

...
\n

Parameters

Ext.ux.grid.FiltersFeature
view source
( dataIndex ) : Ext.ux.grid.filter.Filter
Returns a filter for the given dataIndex, if one exists. ...

Returns a filter for the given dataIndex, if one exists.

\n

Parameters

  • dataIndex : String

    The dataIndex of the desired filter object.

    \n

Returns

Ext.ux.grid.FiltersFeature
view source
( type ) : Function
Function for locating filter classes, overwrite this with your favorite\nloader to provide dynamic filter loading. ...

Function for locating filter classes, overwrite this with your favorite\nloader to provide dynamic filter loading.

\n

Parameters

  • type : String

    The type of filter to load ('Filter' is automatically\nappended to the passed type; eg, 'string' becomes 'StringFilter').

    \n

Returns

Ext.ux.grid.FiltersFeature
view source
( ) : Array
Returns an Array of the currently active filters. ...

Returns an Array of the currently active filters.

\n

Returns

  • Array

    filters Array of the currently active filters.

    \n
Ext.ux.grid.FiltersFeature
view source
( )private
...
\n
( eventName, view, featureTarget, e )template
Abstract method to be overriden when a feature should add additional\narguments to its event signature. ...

Abstract method to be overriden when a feature should add additional\narguments to its event signature. By default the event will fire:

\n\n\n\n\n

The method must also return the eventName as the first index of the array\nto be passed to fireEvent.

\n
\n

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

\n
\n

Parameters

Ext.ux.grid.FiltersFeature
view source
( )private
...
\n
Returns the initial configuration passed to constructor when instantiating\nthis class. ...

Returns the initial configuration passed to constructor when instantiating\nthis class.

\n

Parameters

  • name : String (optional)

    Name of the config option to return.

    \n

Returns

  • Object/Mixed

    The full config object or a single config value\nwhen name parameter specified.

    \n
Ext.ux.grid.FiltersFeature
view source
( )private
Get the filter menu from the filters MixedCollection based on the clicked header ...

Get the filter menu from the filters MixedCollection based on the clicked header

\n
Ext.ux.grid.FiltersFeature
view source
( )private
Method factory that generates a record validator for the filters active at the time\nof invokation. ...

Method factory that generates a record validator for the filters active at the time\nof invokation.

\n
...
\n

Parameters

Checks to see if this object has any listeners for a specified event, or whether the event bubbles. ...

Checks to see if this object has any listeners for a specified event, or whether the event bubbles. The answer\nindicates whether the event needs firing or not.

\n

Parameters

  • eventName : String

    The name of the event to check for

    \n

Returns

  • Boolean

    true if the event is being listened for or bubbles, else false

    \n
Ext.ux.grid.FiltersFeature
view source
( grid )private
...
\n

Parameters

Overrides: Ext.grid.feature.Feature.init

( config ) : Ext.Basechainableprotected
Initialize configuration for this class. ...

Initialize configuration for this class. a typical example:

\n\n
Ext.define('My.awesome.Class', {\n    // The default config\n    config: {\n        name: 'Awesome',\n        isAwesome: true\n    },\n\n    constructor: function(config) {\n        this.initConfig(config);\n    }\n});\n\nvar awesome = new My.awesome.Class({\n    name: 'Super Awesome'\n});\n\nalert(awesome.getName()); // 'Super Awesome'\n
\n

Parameters

Returns

Ext.ux.grid.FiltersFeature
view source
( filters )private
...
\n

Parameters

( item, ename, [fn], [scope], [options] ) : Object
Shorthand for addManagedListener. ...

Shorthand for addManagedListener.

\n\n

Adds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is\ndestroyed.

\n

Parameters

  • item : Ext.util.Observable/Ext.Element

    The item to which to add a listener/listeners.

    \n\n
  • ename : Object/String

    The event name, or an object containing event name properties.

    \n\n
  • fn : Function (optional)

    If the ename parameter was an event name, this is the handler function.

    \n\n
  • scope : Object (optional)

    If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.

    \n\n
  • options : Object (optional)

    If the ename parameter was an event name, this is the\naddListener options.

    \n\n

Returns

  • Object

    Only when the destroyable option is specified.

    \n\n\n\n\n

    A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

    \n\n\n\n\n
    this.btnListeners =  = myButton.mon({\n    destroyable: true\n    mouseover:   function() { console.log('mouseover'); },\n    mouseout:    function() { console.log('mouseout'); },\n    click:       function() { console.log('click'); }\n});\n
    \n\n\n\n\n

    And when those listeners need to be removed:

    \n\n\n\n\n
    Ext.destroy(this.btnListeners);\n
    \n\n\n\n\n

    or

    \n\n\n\n\n
    this.btnListeners.destroy();\n
    \n\n
( item, ename, [fn], [scope] )
Shorthand for removeManagedListener. ...

Shorthand for removeManagedListener.

\n\n

Removes listeners that were added by the mon method.

\n

Parameters

  • item : Ext.util.Observable/Ext.Element

    The item from which to remove a listener/listeners.

    \n\n
  • ename : Object/String

    The event name, or an object containing event name properties.

    \n\n
  • fn : Function (optional)

    If the ename parameter was an event name, this is the handler function.

    \n\n
  • scope : Object (optional)

    If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.

    \n\n
( eventName, [fn], [scope], [options] ) : Object
Shorthand for addListener. ...

Shorthand for addListener.

\n\n

Appends an event handler to this object. For example:

\n\n
myGridPanel.on(\"mouseover\", this.onMouseOver, this);\n
\n\n

The method also allows for a single argument to be passed which is a config object\ncontaining properties which specify multiple events. For example:

\n\n
myGridPanel.on({\n    cellClick: this.onCellClick,\n    mouseover: this.onMouseOver,\n    mouseout: this.onMouseOut,\n    scope: this // Important. Ensure \"this\" is correct during handler execution\n});\n
\n\n

One can also specify options for each event handler separately:

\n\n
myGridPanel.on({\n    cellClick: {fn: this.onCellClick, scope: this, single: true},\n    mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n
\n\n

Names of methods in a specified scope may also be used. Note that\nscope MUST be specified to use this option:

\n\n
myGridPanel.on({\n    cellClick: {fn: 'onCellClick', scope: this, single: true},\n    mouseover: {fn: 'onMouseOver', scope: panel}\n});\n
\n

Parameters

  • eventName : String/Object

    The name of the event to listen for.\nMay also be an object who's property names are event names.

    \n\n
  • fn : Function (optional)

    The method the event invokes, or if scope is specified, the name* of the method within\nthe specified scope. Will be called with arguments\ngiven to fireEvent plus the options parameter described below.

    \n\n
  • scope : Object (optional)

    The scope (this reference) in which the handler function is\nexecuted. If omitted, defaults to the object which fired the event.

    \n\n
  • options : Object (optional)

    An object containing handler configuration.

    \n\n\n\n\n

    Note: Unlike in ExtJS 3.x, the options object will also be passed as the last\nargument to every event handler.

    \n\n\n\n\n

    This object may contain any of the following properties:

    \n\n
    • scope : Object

      The scope (this reference) in which the handler function is executed. If omitted,\n defaults to the object which fired the event.

      \n\n
    • delay : Number

      The number of milliseconds to delay the invocation of the handler after the event fires.

      \n\n
    • single : Boolean

      True to add a handler to handle just the next firing of the event, and then remove itself.

      \n\n
    • buffer : Number

      Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed\n by the specified number of milliseconds. If the event fires again within that time,\n the original handler is not invoked, but the new handler is scheduled in its place.

      \n\n
    • target : Ext.util.Observable

      Only call the handler if the event was fired on the target Observable, not if the event\n was bubbled up from a child Observable.

      \n\n
    • element : String

      This option is only valid for listeners bound to Components.\n The name of a Component property which references an element to add a listener to.

      \n\n\n\n\n

      This option is useful during Component construction to add DOM event listeners to elements of\n Components which will exist only after the Component is rendered.\n For example, to add a click listener to a Panel's body:

      \n\n\n\n\n
        new Ext.panel.Panel({\n      title: 'The title',\n      listeners: {\n          click: this.handlePanelClick,\n          element: 'body'\n      }\n  });\n
      \n\n
    • destroyable : Boolean (optional)

      When specified as true, the function returns A Destroyable object. An object which implements the destroy method which removes all listeners added in this call.

      \n\n

      Defaults to: false

    • priority : Number (optional)

      An optional numeric priority that determines the order in which event handlers\n are run. Event handlers with no priority will be run as if they had a priority\n of 0. Handlers with a higher priority will be prioritized to run sooner than\n those with a lower priority. Negative numbers can be used to set a priority\n lower than the default. Internally, the framework uses a range of 1000 or\n greater, and -1000 or lesser for handers that are intended to run before or\n after all others, so it is recommended to stay within the range of -999 to 999\n when setting the priority of event handlers in application-level code.

      \n\n\n\n\n

      Combining Options

      \n\n\n\n\n

      Using the options argument, it is possible to combine different types of listeners:

      \n\n\n\n\n

      A delayed, one-time listener.

      \n\n\n\n\n
      myPanel.on('hide', this.handleClick, this, {\n    single: true,\n    delay: 100\n});\n
      \n\n

Returns

  • Object

    Only when the destroyable option is specified.

    \n\n\n\n\n

    A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

    \n\n\n\n\n
    this.btnListeners =  = myButton.on({\n    destroyable: true\n    mouseover:   function() { console.log('mouseover'); },\n    mouseout:    function() { console.log('mouseout'); },\n    click:       function() { console.log('click'); }\n});\n
    \n\n\n\n\n

    And when those listeners need to be removed:

    \n\n\n\n\n
    Ext.destroy(this.btnListeners);\n
    \n\n\n\n\n

    or

    \n\n\n\n\n
    this.btnListeners.destroy();\n
    \n\n
Ext.ux.grid.FiltersFeature
view source
( check, value )private
...
\n

Parameters

Ext.ux.grid.FiltersFeature
view source
( store, options )private
Handler for store's beforeload event when configured for remote filtering ...

Handler for store's beforeload event when configured for remote filtering

\n

Parameters

Ext.ux.grid.FiltersFeature
view source
( item, value )private
...
\n

Parameters

( names, callback, scope )private
...
\n

Parameters

Ext.ux.grid.FiltersFeature
view source
( store )private
Handler for store's load event when configured for local filtering ...

Handler for store's load event when configured for local filtering

\n

Parameters

Ext.ux.grid.FiltersFeature
view source
( menu )private
Handle showing of the grid's header menu. ...

Handle showing of the grid's header menu. Sets up the filter item and menu\nappropriate for the target column.

\n

Parameters

Ext.ux.grid.FiltersFeature
view source
( headerCt, menu )private
Handle creation of the grid's header menu. ...

Handle creation of the grid's header menu. Initializes the filters and listens\nfor the menu being shown.

\n

Parameters

Ext.ux.grid.FiltersFeature
view source
( )private
Handler called when the grid's view is refreshed ...

Handler called when the grid's view is refreshed

\n
Ext.ux.grid.FiltersFeature
view source
( event, filter )private
Handler for all events on filters. ...

Handler for all events on filters.

\n

Parameters

  • event : String

    Event name

    \n
  • filter : Object

    Standard signature of the event before the event is fired

    \n
Prepares a given class for observable instances. ...

Prepares a given class for observable instances. This method is called when a\nclass derives from this class or uses this class as a mixin.

\n

Parameters

  • T : Function

    The class constructor to prepare.

    \n
Relays selected events from the specified Observable as if the events were fired by this. ...

Relays selected events from the specified Observable as if the events were fired by this.

\n\n

For example if you are extending Grid, you might decide to forward some events from store.\nSo you can do this inside your initComponent:

\n\n
this.relayEvents(this.getStore(), ['load']);\n
\n\n

The grid instance will then have an observable 'load' event which will be passed the\nparameters of the store's load event and any function fired with the grid's load event\nwould have access to the grid using the this keyword.

\n

Parameters

  • origin : Object

    The Observable whose events this object is to relay.

    \n
  • events : String[]

    Array of event names to relay.

    \n
  • prefix : String (optional)

    A common prefix to prepend to the event names. For example:

    \n\n
    this.relayEvents(this.getStore(), ['load', 'clear'], 'store');\n
    \n\n

    Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'.

    \n

Returns

  • Object

    A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example:

    \n\n
    this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store');\n
    \n\n

    Can be undone by calling

    \n\n
    Ext.destroy(this.storeRelayers);\n
    \n\n

    or

    \n\n
    this.store.relayers.destroy();\n
    \n
Ext.ux.grid.FiltersFeature
view source
( )private
...
\n
Ext.ux.grid.FiltersFeature
view source
( )
Remove all filters, permanently destroying them. ...

Remove all filters, permanently destroying them.

\n
Removes an event handler. ...

Removes an event handler.

\n

Parameters

  • eventName : String

    The type of event the handler was associated with.

    \n\n
  • fn : Function

    The handler to remove. This must be a reference to the function passed into the\naddListener call.

    \n\n
  • scope : Object (optional)

    The scope originally specified for the handler. It must be the same as the\nscope argument specified in the original call to addListener or the listener will not be removed.

    \n\n
Removes listeners that were added by the mon method. ...

Removes listeners that were added by the mon method.

\n

Parameters

  • item : Ext.util.Observable/Ext.Element

    The item from which to remove a listener/listeners.

    \n\n
  • ename : Object/String

    The event name, or an object containing event name properties.

    \n\n
  • fn : Function (optional)

    If the ename parameter was an event name, this is the handler function.

    \n\n
  • scope : Object (optional)

    If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.

    \n\n
Remove a single managed listener item ...

Remove a single managed listener item

\n

Parameters

  • isClear : Boolean

    True if this is being called during a clear

    \n
  • managedListener : Object

    The managed listener item\nSee removeManagedListener for other args

    \n
Resumes firing of the named event(s). ...

Resumes firing of the named event(s).

\n\n

After calling this method to resume events, the events will fire when requested to fire.

\n\n

Note that if the suspendEvent method is called multiple times for a certain event,\nthis converse method will have to be called the same number of times for it to resume firing.

\n

Parameters

  • eventName : String...

    Multiple event names to resume.

    \n
Resumes firing events (see suspendEvents). ...

Resumes firing events (see suspendEvents).

\n\n

If events were suspended using the queueSuspended parameter, then all events fired\nduring event suspension will be sent to any listeners now.

\n
Ext.ux.grid.FiltersFeature
view source
( grid, state ) : Boolean
Saves the state of all active filters ...

Saves the state of all active filters

\n

Parameters

Returns

( config, applyIfNotSet ) : Ext.Basechainableprivate
...
\n

Parameters

Returns

Get the reference to the class from which this object was instantiated. ...

Get the reference to the class from which this object was instantiated. Note that unlike self,\nthis.statics() is scope-independent and it always returns the class from which it was called, regardless of what\nthis points to during run-time

\n\n
Ext.define('My.Cat', {\n    statics: {\n        totalCreated: 0,\n        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n    },\n\n    constructor: function() {\n        var statics = this.statics();\n\n        alert(statics.speciesName);     // always equals to 'Cat' no matter what 'this' refers to\n                                        // equivalent to: My.Cat.speciesName\n\n        alert(this.self.speciesName);   // dependent on 'this'\n\n        statics.totalCreated++;\n    },\n\n    clone: function() {\n        var cloned = new this.self;                      // dependent on 'this'\n\n        cloned.groupName = this.statics().speciesName;   // equivalent to: My.Cat.speciesName\n\n        return cloned;\n    }\n});\n\n\nExt.define('My.SnowLeopard', {\n    extend: 'My.Cat',\n\n    statics: {\n        speciesName: 'Snow Leopard'     // My.SnowLeopard.speciesName = 'Snow Leopard'\n    },\n\n    constructor: function() {\n        this.callParent();\n    }\n});\n\nvar cat = new My.Cat();                 // alerts 'Cat', then alerts 'Cat'\n\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone));         // alerts 'My.SnowLeopard'\nalert(clone.groupName);                 // alerts 'Cat'\n\nalert(My.Cat.totalCreated);             // alerts 3\n
\n

Returns

Suspends firing of the named event(s). ...

Suspends firing of the named event(s).

\n\n

After calling this method to suspend events, the events will no longer fire when requested to fire.

\n\n

Note that if this is called multiple times for a certain event, the converse method\nresumeEvent will have to be called the same number of times for it to resume firing.

\n

Parameters

  • eventName : String...

    Multiple event names to suspend.

    \n
Suspends the firing of all events. ...

Suspends the firing of all events. (see resumeEvents)

\n

Parameters

  • queueSuspended : Boolean

    Pass as true to queue up suspended events to be fired\nafter the resumeEvents call instead of discarding all suspended events.

    \n
( eventName, fn, [scope] )
Shorthand for removeListener. ...

Shorthand for removeListener.

\n\n

Removes an event handler.

\n

Parameters

  • eventName : String

    The type of event the handler was associated with.

    \n\n
  • fn : Function

    The handler to remove. This must be a reference to the function passed into the\naddListener call.

    \n\n
  • scope : Object (optional)

    The scope originally specified for the handler. It must be the same as the\nscope argument specified in the original call to addListener or the listener will not be removed.

    \n\n
Ext.ux.grid.FiltersFeature
view source
( )
Update the styles for the header row based on the active filters ...

Update the styles for the header row based on the active filters

\n
Defined By

Static Methods

( config )privatestatic
...
\n

Parameters

( members )chainableprivatestatic
...
\n

Parameters

( name, member )chainableprivatestatic
...
\n

Parameters

( members )chainablestatic
Add methods / properties to the prototype of this class. ...

Add methods / properties to the prototype of this class.

\n\n
Ext.define('My.awesome.Cat', {\n    constructor: function() {\n        ...\n    }\n});\n\n My.awesome.Cat.addMembers({\n     meow: function() {\n        alert('Meowww...');\n     }\n });\n\n var kitty = new My.awesome.Cat;\n kitty.meow();\n
\n

Parameters

( members ) : Ext.Basechainablestatic
Add / override static properties of this class. ...

Add / override static properties of this class.

\n\n
Ext.define('My.cool.Class', {\n    ...\n});\n\nMy.cool.Class.addStatics({\n    someProperty: 'someValue',      // My.cool.Class.someProperty = 'someValue'\n    method1: function() { ... },    // My.cool.Class.method1 = function() { ... };\n    method2: function() { ... }     // My.cool.Class.method2 = function() { ... };\n});\n
\n

Parameters

Returns

( xtype )chainableprivatestatic
...
\n

Parameters

( fromClass, members ) : Ext.Basechainableprivatestatic
Borrow another class' members to the prototype of this class. ...

Borrow another class' members to the prototype of this class.

\n\n
Ext.define('Bank', {\n    money: '$$$',\n    printMoney: function() {\n        alert('$$$$$$$');\n    }\n});\n\nExt.define('Thief', {\n    ...\n});\n\nThief.borrow(Bank, ['money', 'printMoney']);\n\nvar steve = new Thief();\n\nalert(steve.money); // alerts '$$$'\nsteve.printMoney(); // alerts '$$$$$$$'\n
\n

Parameters

  • fromClass : Ext.Base

    The class to borrow members from

    \n
  • members : Array/String

    The names of the members to borrow

    \n

Returns

Create a new instance of this Class. ...

Create a new instance of this Class.

\n\n
Ext.define('My.cool.Class', {\n    ...\n});\n\nMy.cool.Class.create({\n    someConfig: true\n});\n
\n\n

All parameters are passed to the constructor of the class.

\n

Returns

( alias, origin )static
Create aliases for existing prototype methods. ...

Create aliases for existing prototype methods. Example:

\n\n
Ext.define('My.cool.Class', {\n    method1: function() { ... },\n    method2: function() { ... }\n});\n\nvar test = new My.cool.Class();\n\nMy.cool.Class.createAlias({\n    method3: 'method1',\n    method4: 'method2'\n});\n\ntest.method3(); // test.method1()\n\nMy.cool.Class.createAlias('method5', 'method3');\n\ntest.method5(); // test.method3() -> test.method1()\n
\n

Parameters

( config )privatestatic
...
\n

Parameters

Get the current class' name in string format. ...

Get the current class' name in string format.

\n\n
Ext.define('My.cool.Class', {\n    constructor: function() {\n        alert(this.self.getName()); // alerts 'My.cool.Class'\n    }\n});\n\nMy.cool.Class.getName(); // 'My.cool.Class'\n
\n

Returns

( )deprecatedstatic
Adds members to class. ...

Adds members to class.

\n
\n

This method has been deprecated since 4.1

\n

Use addMembers instead.

\n\n
\n
( name, mixinClass )privatestatic
Used internally by the mixins pre-processor ...

Used internally by the mixins pre-processor

\n

Parameters

( fn, scope )chainableprivatestatic
...
\n

Parameters

( members ) : Ext.Basechainabledeprecatedstatic
Override members of this class. ...

Override members of this class. Overridden methods can be invoked via\ncallParent.

\n\n
Ext.define('My.Cat', {\n    constructor: function() {\n        alert(\"I'm a cat!\");\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        this.callParent(arguments);\n\n        alert(\"Meeeeoooowwww\");\n    }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n                          // alerts \"I'm a cat!\"\n                          // alerts \"Meeeeoooowwww\"\n
\n\n

As of 4.1, direct use of this method is deprecated. Use Ext.define\ninstead:

\n\n
Ext.define('My.CatOverride', {\n    override: 'My.Cat',\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        this.callParent(arguments);\n\n        alert(\"Meeeeoooowwww\");\n    }\n});\n
\n\n

The above accomplishes the same result but can be managed by the Ext.Loader\nwhich can properly order the override and its target class and the build process\ncan determine whether the override is needed based on the required state of the\ntarget class (My.Cat).

\n
\n

This method has been deprecated since 4.1.0

\n

Use Ext.define instead

\n\n
\n

Parameters

  • members : Object

    The properties to add to this class. This should be\nspecified as an object literal containing one or more properties.

    \n

Returns

","superclasses":["Ext.Base","Ext.util.Observable","Ext.grid.feature.Feature"],"meta":{},"code_type":"ext_define","requires":[],"html_meta":{},"statics":{"property":[{"tagname":"property","owner":"Ext.Base","meta":{"static":true,"private":true},"name":"$onExtended","id":"static-property-S-onExtended"}],"cfg":[],"css_var":[],"method":[{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"private":true},"name":"addConfig","id":"static-method-addConfig"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"chainable":true,"private":true},"name":"addInheritableStatics","id":"static-method-addInheritableStatics"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"chainable":true,"private":true},"name":"addMember","id":"static-method-addMember"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"chainable":true},"name":"addMembers","id":"static-method-addMembers"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"chainable":true},"name":"addStatics","id":"static-method-addStatics"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"chainable":true,"private":true},"name":"addXtype","id":"static-method-addXtype"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"chainable":true,"private":true},"name":"borrow","id":"static-method-borrow"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true},"name":"create","id":"static-method-create"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true},"name":"createAlias","id":"static-method-createAlias"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"private":true},"name":"extend","id":"static-method-extend"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true},"name":"getName","id":"static-method-getName"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"deprecated":{"text":"Use {@link #addMembers} instead.","version":"4.1"}},"name":"implement","id":"static-method-implement"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"private":true},"name":"mixin","id":"static-method-mixin"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"chainable":true,"private":true},"name":"onExtended","id":"static-method-onExtended"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"chainable":true,"markdown":true,"deprecated":{"text":"Use {@link Ext#define Ext.define} instead","version":"4.1.0"}},"name":"override","id":"static-method-override"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"private":true},"name":"triggerExtended","id":"static-method-triggerExtended"}],"event":[],"css_mixin":[]},"files":[{"href":"FiltersFeature.html#Ext-ux-grid-FiltersFeature","filename":"FiltersFeature.js"}],"linenr":1,"members":{"property":[{"tagname":"property","owner":"Ext.Base","meta":{"private":true},"name":"$className","id":"property-S-className"},{"tagname":"property","owner":"Ext.Base","meta":{"private":true},"name":"configMap","id":"property-configMap"},{"tagname":"property","owner":"Ext.grid.feature.Feature","meta":{},"name":"disabled","id":"property-disabled"},{"tagname":"property","owner":"Ext.grid.feature.Feature","meta":{},"name":"eventPrefix","id":"property-eventPrefix"},{"tagname":"property","owner":"Ext.grid.feature.Feature","meta":{},"name":"eventSelector","id":"property-eventSelector"},{"tagname":"property","owner":"Ext.util.Observable","meta":{"private":true},"name":"eventsSuspended","id":"property-eventsSuspended"},{"tagname":"property","owner":"Ext.grid.feature.Feature","meta":{},"name":"grid","id":"property-grid"},{"tagname":"property","owner":"Ext.ux.grid.FiltersFeature","meta":{},"name":"hasFeatureEvent","id":"property-hasFeatureEvent"},{"tagname":"property","owner":"Ext.util.Observable","meta":{"readonly":true},"name":"hasListeners","id":"property-hasListeners"},{"tagname":"property","owner":"Ext.Base","meta":{"private":true},"name":"initConfigList","id":"property-initConfigList"},{"tagname":"property","owner":"Ext.Base","meta":{"private":true},"name":"initConfigMap","id":"property-initConfigMap"},{"tagname":"property","owner":"Ext.grid.feature.Feature","meta":{"private":true},"name":"isFeature","id":"property-isFeature"},{"tagname":"property","owner":"Ext.Base","meta":{"private":true},"name":"isInstance","id":"property-isInstance"},{"tagname":"property","owner":"Ext.util.Observable","meta":{},"name":"isObservable","id":"property-isObservable"},{"tagname":"property","owner":"Ext.Base","meta":{"protected":true},"name":"self","id":"property-self"},{"tagname":"property","owner":"Ext.grid.feature.Feature","meta":{},"name":"view","id":"property-view"},{"tagname":"property","owner":"Ext.grid.feature.Feature","meta":{"private":true},"name":"wrapsItem","id":"property-wrapsItem"}],"cfg":[{"tagname":"cfg","owner":"Ext.ux.grid.FiltersFeature","meta":{},"name":"autoReload","id":"cfg-autoReload"},{"tagname":"cfg","owner":"Ext.ux.grid.FiltersFeature","meta":{},"name":"encode","id":"cfg-encode"},{"tagname":"cfg","owner":"Ext.ux.grid.FiltersFeature","meta":{},"name":"filterCls","id":"cfg-filterCls"},{"tagname":"cfg","owner":"Ext.ux.grid.FiltersFeature","meta":{},"name":"filters","id":"cfg-filters"},{"tagname":"cfg","owner":"Ext.util.Observable","meta":{},"name":"listeners","id":"cfg-listeners"},{"tagname":"cfg","owner":"Ext.ux.grid.FiltersFeature","meta":{},"name":"local","id":"cfg-local"},{"tagname":"cfg","owner":"Ext.ux.grid.FiltersFeature","meta":{},"name":"menuFilterText","id":"cfg-menuFilterText"},{"tagname":"cfg","owner":"Ext.ux.grid.FiltersFeature","meta":{},"name":"paramPrefix","id":"cfg-paramPrefix"},{"tagname":"cfg","owner":"Ext.ux.grid.FiltersFeature","meta":{},"name":"showMenu","id":"cfg-showMenu"},{"tagname":"cfg","owner":"Ext.ux.grid.FiltersFeature","meta":{},"name":"stateId","id":"cfg-stateId"},{"tagname":"cfg","owner":"Ext.ux.grid.FiltersFeature","meta":{},"name":"updateBuffer","id":"cfg-updateBuffer"}],"css_var":[],"method":[{"tagname":"method","owner":"Ext.ux.grid.FiltersFeature","meta":{"private":true},"name":"constructor","id":"method-constructor"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"addEvents","id":"method-addEvents"},{"tagname":"method","owner":"Ext.ux.grid.FiltersFeature","meta":{},"name":"addFilter","id":"method-addFilter"},{"tagname":"method","owner":"Ext.ux.grid.FiltersFeature","meta":{},"name":"addFilters","id":"method-addFilters"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"addListener","id":"method-addListener"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"addManagedListener","id":"method-addManagedListener"},{"tagname":"method","owner":"Ext.ux.grid.FiltersFeature","meta":{"private":true},"name":"applyState","id":"method-applyState"},{"tagname":"method","owner":"Ext.ux.grid.FiltersFeature","meta":{},"name":"bindStore","id":"method-bindStore"},{"tagname":"method","owner":"Ext.ux.grid.FiltersFeature","meta":{},"name":"buildQuery","id":"method-buildQuery"},{"tagname":"method","owner":"Ext.Base","meta":{"protected":true,"deprecated":{"text":"as of 4.1. Use {@link #callParent} instead."}},"name":"callOverridden","id":"method-callOverridden"},{"tagname":"method","owner":"Ext.Base","meta":{"protected":true},"name":"callParent","id":"method-callParent"},{"tagname":"method","owner":"Ext.Base","meta":{"protected":true},"name":"callSuper","id":"method-callSuper"},{"tagname":"method","owner":"Ext.util.Observable","meta":{"private":true},"name":"captureArgs","id":"method-captureArgs"},{"tagname":"method","owner":"Ext.ux.grid.FiltersFeature","meta":{},"name":"cleanParams","id":"method-cleanParams"},{"tagname":"method","owner":"Ext.ux.grid.FiltersFeature","meta":{},"name":"clearFilters","id":"method-clearFilters"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"clearListeners","id":"method-clearListeners"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"clearManagedListeners","id":"method-clearManagedListeners"},{"tagname":"method","owner":"Ext.grid.feature.Feature","meta":{"private":true},"name":"clone","id":"method-clone"},{"tagname":"method","owner":"Ext.Base","meta":{"private":true},"name":"configClass","id":"method-configClass"},{"tagname":"method","owner":"Ext.util.Observable","meta":{"private":true},"name":"continueFireEvent","id":"method-continueFireEvent"},{"tagname":"method","owner":"Ext.ux.grid.FiltersFeature","meta":{"private":true},"name":"createFilters","id":"method-createFilters"},{"tagname":"method","owner":"Ext.ux.grid.FiltersFeature","meta":{"private":true},"name":"createFiltersCollection","id":"method-createFiltersCollection"},{"tagname":"method","owner":"Ext.ux.grid.FiltersFeature","meta":{"private":true},"name":"createMenuItem","id":"method-createMenuItem"},{"tagname":"method","owner":"Ext.util.Observable","meta":{"private":true},"name":"createRelayer","id":"method-createRelayer"},{"tagname":"method","owner":"Ext.ux.grid.FiltersFeature","meta":{"private":true},"name":"destroy","id":"method-destroy"},{"tagname":"method","owner":"Ext.grid.feature.Feature","meta":{},"name":"disable","id":"method-disable"},{"tagname":"method","owner":"Ext.grid.feature.Feature","meta":{},"name":"enable","id":"method-enable"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"enableBubble","id":"method-enableBubble"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"fireEvent","id":"method-fireEvent"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"fireEventArgs","id":"method-fireEventArgs"},{"tagname":"method","owner":"Ext.util.Observable","meta":{"private":true},"name":"getBubbleParent","id":"method-getBubbleParent"},{"tagname":"method","owner":"Ext.Base","meta":{"private":true},"name":"getConfig","id":"method-getConfig"},{"tagname":"method","owner":"Ext.ux.grid.FiltersFeature","meta":{},"name":"getFilter","id":"method-getFilter"},{"tagname":"method","owner":"Ext.ux.grid.FiltersFeature","meta":{},"name":"getFilterClass","id":"method-getFilterClass"},{"tagname":"method","owner":"Ext.ux.grid.FiltersFeature","meta":{},"name":"getFilterData","id":"method-getFilterData"},{"tagname":"method","owner":"Ext.ux.grid.FiltersFeature","meta":{"private":true},"name":"getFilterItems","id":"method-getFilterItems"},{"tagname":"method","owner":"Ext.grid.feature.Feature","meta":{"template":true},"name":"getFireEventArgs","id":"method-getFireEventArgs"},{"tagname":"method","owner":"Ext.ux.grid.FiltersFeature","meta":{"private":true},"name":"getGridPanel","id":"method-getGridPanel"},{"tagname":"method","owner":"Ext.Base","meta":{},"name":"getInitialConfig","id":"method-getInitialConfig"},{"tagname":"method","owner":"Ext.ux.grid.FiltersFeature","meta":{"private":true},"name":"getMenuFilter","id":"method-getMenuFilter"},{"tagname":"method","owner":"Ext.ux.grid.FiltersFeature","meta":{"private":true},"name":"getRecordFilter","id":"method-getRecordFilter"},{"tagname":"method","owner":"Ext.Base","meta":{"private":true},"name":"hasConfig","id":"method-hasConfig"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"hasListener","id":"method-hasListener"},{"tagname":"method","owner":"Ext.ux.grid.FiltersFeature","meta":{"private":true},"name":"init","id":"method-init"},{"tagname":"method","owner":"Ext.Base","meta":{"chainable":true,"protected":true},"name":"initConfig","id":"method-initConfig"},{"tagname":"method","owner":"Ext.ux.grid.FiltersFeature","meta":{"private":true},"name":"initializeFilters","id":"method-initializeFilters"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"mon","id":"method-mon"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"mun","id":"method-mun"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"on","id":"method-on"},{"tagname":"method","owner":"Ext.ux.grid.FiltersFeature","meta":{"private":true},"name":"onBeforeCheck","id":"method-onBeforeCheck"},{"tagname":"method","owner":"Ext.ux.grid.FiltersFeature","meta":{"private":true},"name":"onBeforeLoad","id":"method-onBeforeLoad"},{"tagname":"method","owner":"Ext.ux.grid.FiltersFeature","meta":{"private":true},"name":"onCheckChange","id":"method-onCheckChange"},{"tagname":"method","owner":"Ext.Base","meta":{"private":true},"name":"onConfigUpdate","id":"method-onConfigUpdate"},{"tagname":"method","owner":"Ext.ux.grid.FiltersFeature","meta":{"private":true},"name":"onLoad","id":"method-onLoad"},{"tagname":"method","owner":"Ext.ux.grid.FiltersFeature","meta":{"private":true},"name":"onMenuBeforeShow","id":"method-onMenuBeforeShow"},{"tagname":"method","owner":"Ext.ux.grid.FiltersFeature","meta":{"private":true},"name":"onMenuCreate","id":"method-onMenuCreate"},{"tagname":"method","owner":"Ext.ux.grid.FiltersFeature","meta":{"private":true},"name":"onRefresh","id":"method-onRefresh"},{"tagname":"method","owner":"Ext.ux.grid.FiltersFeature","meta":{"private":true},"name":"onStateChange","id":"method-onStateChange"},{"tagname":"method","owner":"Ext.util.Observable","meta":{"private":true},"name":"prepareClass","id":"method-prepareClass"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"relayEvents","id":"method-relayEvents"},{"tagname":"method","owner":"Ext.ux.grid.FiltersFeature","meta":{"private":true},"name":"reload","id":"method-reload"},{"tagname":"method","owner":"Ext.ux.grid.FiltersFeature","meta":{},"name":"removeAll","id":"method-removeAll"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"removeListener","id":"method-removeListener"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"removeManagedListener","id":"method-removeManagedListener"},{"tagname":"method","owner":"Ext.util.Observable","meta":{"private":true},"name":"removeManagedListenerItem","id":"method-removeManagedListenerItem"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"resumeEvent","id":"method-resumeEvent"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"resumeEvents","id":"method-resumeEvents"},{"tagname":"method","owner":"Ext.ux.grid.FiltersFeature","meta":{},"name":"saveState","id":"method-saveState"},{"tagname":"method","owner":"Ext.Base","meta":{"chainable":true,"private":true},"name":"setConfig","id":"method-setConfig"},{"tagname":"method","owner":"Ext.Base","meta":{"protected":true},"name":"statics","id":"method-statics"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"suspendEvent","id":"method-suspendEvent"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"suspendEvents","id":"method-suspendEvents"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"un","id":"method-un"},{"tagname":"method","owner":"Ext.ux.grid.FiltersFeature","meta":{},"name":"updateColumnHeadings","id":"method-updateColumnHeadings"},{"tagname":"method","owner":"Ext.grid.feature.Feature","meta":{"private":true},"name":"vetoEvent","id":"method-vetoEvent"}],"event":[],"css_mixin":[]},"inheritable":null,"private":null,"component":false,"name":"Ext.ux.grid.FiltersFeature","singleton":false,"override":null,"inheritdoc":null,"id":"class-Ext.ux.grid.FiltersFeature","mixins":[],"mixedInto":[]});