FiltersFeature.html
27 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<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>
<style type="text/css">
.highlight { display: block; background-color: #ddd; }
</style>
<script type="text/javascript">
function highlight() {
document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
}
</script>
</head>
<body onload="prettyPrint(); highlight();">
<pre class="prettyprint lang-js"><span id='Ext-ux-grid-FiltersFeature'>/**
</span> * FiltersFeature is a grid {@link Ext.grid.feature.Feature feature} that allows for a slightly more
* robust representation of filtering than what is provided by the default store.
*
* Filtering is adjusted by the user using the grid's column header menu (this menu can be
* disabled through configuration). Through this menu users can configure, enable, and
* disable filters for each column.
*
* #Features#
*
* ##Filtering implementations:##
*
* Default filtering for Strings, Numeric Ranges, Date Ranges, Lists (which can be backed by a
* {@link Ext.data.Store}), and Boolean. Additional custom filter types and menus are easily
* created by extending {@link Ext.ux.grid.filter.Filter}.
*
* ##Graphical Indicators:##
*
* Columns that are filtered have {@link #filterCls a configurable css class} applied to the column headers.
*
* ##Automatic Reconfiguration:##
*
* Filters automatically reconfigure when the grid 'reconfigure' event fires.
*
* ##Stateful:##
*
* Filter information will be persisted across page loads by specifying a `stateId`
* in the Grid configuration.
*
* The filter collection binds to the {@link Ext.grid.Panel#beforestaterestore beforestaterestore}
* and {@link Ext.grid.Panel#beforestatesave beforestatesave} events in order to be stateful.
*
* ##GridPanel Changes:##
*
* - A `filters` property is added to the GridPanel using this feature.
* - A `filterupdate` event is added to the GridPanel and is fired upon onStateChange completion.
*
* ##Server side code examples:##
*
* - [PHP](http://www.vinylfox.com/extjs/grid-filter-php-backend-code.php) - (Thanks VinylFox)
* - [Ruby on Rails](http://extjs.com/forum/showthread.php?p=77326#post77326) - (Thanks Zyclops)
* - [Ruby on Rails](http://extjs.com/forum/showthread.php?p=176596#post176596) - (Thanks Rotomaul)
*
* #Example usage:#
*
* var store = Ext.create('Ext.data.Store', {
* pageSize: 15
* ...
* });
*
* var filtersCfg = {
* ftype: 'filters',
* autoReload: false, //don't reload automatically
* local: true, //only filter locally
* // filters may be configured through the plugin,
* // or in the column definition within the headers configuration
* filters: [{
* type: 'numeric',
* dataIndex: 'id'
* }, {
* type: 'string',
* dataIndex: 'name'
* }, {
* type: 'numeric',
* dataIndex: 'price'
* }, {
* type: 'date',
* dataIndex: 'dateAdded'
* }, {
* type: 'list',
* dataIndex: 'size',
* options: ['extra small', 'small', 'medium', 'large', 'extra large'],
* phpMode: true
* }, {
* type: 'boolean',
* dataIndex: 'visible'
* }]
* };
*
* var grid = Ext.create('Ext.grid.Panel', {
* store: store,
* columns: ...,
* features: [filtersCfg],
* height: 400,
* width: 700,
* bbar: Ext.create('Ext.PagingToolbar', {
* store: store
* })
* });
*
* // a filters property is added to the GridPanel
* grid.filters
*/
Ext.define('Ext.ux.grid.FiltersFeature', {
extend: 'Ext.grid.feature.Feature',
alias: 'feature.filters',
uses: [
'Ext.ux.grid.menu.ListMenu',
'Ext.ux.grid.menu.RangeMenu',
'Ext.ux.grid.filter.BooleanFilter',
'Ext.ux.grid.filter.DateFilter',
'Ext.ux.grid.filter.ListFilter',
'Ext.ux.grid.filter.NumericFilter',
'Ext.ux.grid.filter.StringFilter'
],
<span id='Ext-ux-grid-FiltersFeature-cfg-autoReload'> /**
</span> * @cfg {Boolean} autoReload
* Defaults to true, reloading the datasource when a filter change happens.
* Set this to false to prevent the datastore from being reloaded if there
* are changes to the filters. See <code>{@link #updateBuffer}</code>.
*/
autoReload : true,
<span id='Ext-ux-grid-FiltersFeature-cfg-encode'> /**
</span> * @cfg {Boolean} encode
* Specify true for {@link #buildQuery} to use Ext.util.JSON.encode to
* encode the filter query parameter sent with a remote request.
* Defaults to false.
*/
<span id='Ext-ux-grid-FiltersFeature-cfg-filters'> /**
</span> * @cfg {Array} filters
* An Array of filters config objects. Refer to each filter type class for
* configuration details specific to each filter type. Filters for Strings,
* Numeric Ranges, Date Ranges, Lists, and Boolean are the standard filters
* available.
*/
<span id='Ext-ux-grid-FiltersFeature-cfg-filterCls'> /**
</span> * @cfg {String} filterCls
* The css class to be applied to column headers with active filters.
* Defaults to <tt>'ux-filterd-column'</tt>.
*/
filterCls : 'ux-filtered-column',
<span id='Ext-ux-grid-FiltersFeature-cfg-local'> /**
</span> * @cfg {Boolean} local
* <tt>true</tt> to use Ext.data.Store filter functions (local filtering)
* instead of the default (<tt>false</tt>) server side filtering.
*/
local : false,
<span id='Ext-ux-grid-FiltersFeature-cfg-menuFilterText'> /**
</span> * @cfg {String} menuFilterText
* defaults to <tt>'Filters'</tt>.
*/
menuFilterText : 'Filters',
<span id='Ext-ux-grid-FiltersFeature-cfg-paramPrefix'> /**
</span> * @cfg {String} paramPrefix
* The url parameter prefix for the filters.
* Defaults to <tt>'filter'</tt>.
*/
paramPrefix : 'filter',
<span id='Ext-ux-grid-FiltersFeature-cfg-showMenu'> /**
</span> * @cfg {Boolean} showMenu
* Defaults to true, including a filter submenu in the default header menu.
*/
showMenu : true,
<span id='Ext-ux-grid-FiltersFeature-cfg-stateId'> /**
</span> * @cfg {String} stateId
* Name of the value to be used to store state information.
*/
stateId : undefined,
<span id='Ext-ux-grid-FiltersFeature-cfg-updateBuffer'> /**
</span> * @cfg {Number} updateBuffer
* Number of milliseconds to defer store updates since the last filter change.
*/
updateBuffer : 500,
// doesn't handle grid body events
hasFeatureEvent: false,
<span id='Ext-ux-grid-FiltersFeature-method-constructor'> /** @private */
</span> constructor : function (config) {
var me = this;
config = config || {};
Ext.apply(me, config);
me.deferredUpdate = Ext.create('Ext.util.DelayedTask', me.reload, me);
// Init filters
me.filters = me.createFiltersCollection();
me.filterConfigs = config.filters;
},
attachEvents: function() {
var me = this,
view = me.view,
headerCt = view.headerCt,
grid = me.getGridPanel();
me.bindStore(view.getStore(), true);
// Listen for header menu being created
headerCt.on('menucreate', me.onMenuCreate, me);
view.on('refresh', me.onRefresh, me);
grid.on({
scope: me,
beforestaterestore: me.applyState,
beforestatesave: me.saveState,
beforedestroy: me.destroy
});
// Add event and filters shortcut on grid panel
grid.filters = me;
grid.addEvents('filterupdate');
},
createFiltersCollection: function () {
return Ext.create('Ext.util.MixedCollection', false, function (o) {
return o ? o.dataIndex : null;
});
},
<span id='Ext-ux-grid-FiltersFeature-method-createFilters'> /**
</span> * @private Create the Filter objects for the current configuration, destroying any existing ones first.
*/
createFilters: function() {
var me = this,
hadFilters = me.filters.getCount(),
grid = me.getGridPanel(),
filters = me.createFiltersCollection(),
model = grid.store.model,
fields = model.prototype.fields,
field,
filter,
state;
if (hadFilters) {
state = {};
me.saveState(null, state);
}
function add (dataIndex, config, filterable) {
if (dataIndex && (filterable || config)) {
field = fields.get(dataIndex);
filter = {
dataIndex: dataIndex,
type: (field && field.type && field.type.type) || 'auto'
};
if (Ext.isObject(config)) {
Ext.apply(filter, config);
}
filters.replace(filter);
}
}
// We start with filters from our config
Ext.Array.each(me.filterConfigs, function (filterConfig) {
add(filterConfig.dataIndex, filterConfig);
});
// Then we merge on filters from the columns in the grid. The columns' filters take precedence.
Ext.Array.each(grid.columns, function (column) {
if (column.filterable === false) {
filters.removeAtKey(column.dataIndex);
} else {
add(column.dataIndex, column.filter, column.filterable);
}
});
me.removeAll();
if (filters.items) {
me.initializeFilters(filters.items);
}
if (hadFilters) {
me.applyState(null, state);
}
},
<span id='Ext-ux-grid-FiltersFeature-method-initializeFilters'> /**
</span> * @private
*/
initializeFilters: function(filters) {
var me = this,
filtersLength = filters.length,
i, filter, FilterClass;
for (i = 0; i < filtersLength; i++) {
filter = filters[i];
if (filter) {
FilterClass = me.getFilterClass(filter.type);
filter = filter.menu ? filter : new FilterClass(filter);
me.filters.add(filter);
Ext.util.Observable.capture(filter, this.onStateChange, this);
}
}
},
<span id='Ext-ux-grid-FiltersFeature-method-onMenuCreate'> /**
</span> * @private Handle creation of the grid's header menu. Initializes the filters and listens
* for the menu being shown.
*/
onMenuCreate: function(headerCt, menu) {
var me = this;
me.createFilters();
menu.on('beforeshow', me.onMenuBeforeShow, me);
},
<span id='Ext-ux-grid-FiltersFeature-method-onMenuBeforeShow'> /**
</span> * @private Handle showing of the grid's header menu. Sets up the filter item and menu
* appropriate for the target column.
*/
onMenuBeforeShow: function(menu) {
var me = this,
menuItem, filter;
if (me.showMenu) {
menuItem = me.menuItem;
if (!menuItem || menuItem.isDestroyed) {
me.createMenuItem(menu);
menuItem = me.menuItem;
}
filter = me.getMenuFilter();
if (filter) {
menuItem.setMenu(filter.menu, false);
menuItem.setChecked(filter.active);
// disable the menu if filter.disabled explicitly set to true
menuItem.setDisabled(filter.disabled === true);
}
menuItem.setVisible(!!filter);
this.sep.setVisible(!!filter);
}
},
createMenuItem: function(menu) {
var me = this;
me.sep = menu.add('-');
me.menuItem = menu.add({
checked: false,
itemId: 'filters',
text: me.menuFilterText,
listeners: {
scope: me,
checkchange: me.onCheckChange,
beforecheckchange: me.onBeforeCheck
}
});
},
getGridPanel: function() {
return this.view.up('gridpanel');
},
<span id='Ext-ux-grid-FiltersFeature-method-applyState'> /**
</span> * @private
* Handler for the grid's beforestaterestore event (fires before the state of the
* grid is restored).
* @param {Object} grid The grid object
* @param {Object} state The hash of state values returned from the StateProvider.
*/
applyState : function (grid, state) {
var me = this,
key, filter;
me.applyingState = true;
me.clearFilters();
if (state.filters) {
for (key in state.filters) {
if (state.filters.hasOwnProperty(key)) {
filter = me.filters.get(key);
if (filter) {
filter.setValue(state.filters[key]);
filter.setActive(true);
}
}
}
}
me.deferredUpdate.cancel();
if (me.local) {
me.reload();
}
delete me.applyingState;
delete state.filters;
},
<span id='Ext-ux-grid-FiltersFeature-method-saveState'> /**
</span> * Saves the state of all active filters
* @param {Object} grid
* @param {Object} state
* @return {Boolean}
*/
saveState : function (grid, state) {
var filters = {};
this.filters.each(function (filter) {
if (filter.active) {
filters[filter.dataIndex] = filter.getValue();
}
});
return (state.filters = filters);
},
<span id='Ext-ux-grid-FiltersFeature-method-destroy'> /**
</span> * @private
* Handler called by the grid 'beforedestroy' event
*/
destroy : function () {
var me = this;
Ext.destroyMembers(me, 'menuItem', 'sep');
me.removeAll();
me.clearListeners();
},
<span id='Ext-ux-grid-FiltersFeature-method-removeAll'> /**
</span> * Remove all filters, permanently destroying them.
*/
removeAll : function () {
if(this.filters){
Ext.destroy.apply(Ext, this.filters.items);
// remove all items from the collection
this.filters.clear();
}
},
<span id='Ext-ux-grid-FiltersFeature-method-bindStore'> /**
</span> * Changes the data store bound to this view and refreshes it.
* @param {Ext.data.Store} store The store to bind to this view
*/
bindStore : function(store) {
var me = this;
// Unbind from the old Store
if (me.store && me.storeListeners) {
me.store.un(me.storeListeners);
}
// Set up correct listeners
if (store) {
me.storeListeners = {
scope: me
};
if (me.local) {
me.storeListeners.load = me.onLoad;
} else {
me.storeListeners['before' + (store.buffered ? 'prefetch' : 'load')] = me.onBeforeLoad;
}
store.on(me.storeListeners);
} else {
delete me.storeListeners;
}
me.store = store;
},
<span id='Ext-ux-grid-FiltersFeature-method-getMenuFilter'> /**
</span> * @private
* Get the filter menu from the filters MixedCollection based on the clicked header
*/
getMenuFilter : function () {
var header = this.view.headerCt.getMenu().activeHeader;
return header ? this.filters.get(header.dataIndex) : null;
},
<span id='Ext-ux-grid-FiltersFeature-method-onCheckChange'> /** @private */
</span> onCheckChange : function (item, value) {
this.getMenuFilter().setActive(value);
},
<span id='Ext-ux-grid-FiltersFeature-method-onBeforeCheck'> /** @private */
</span> onBeforeCheck : function (check, value) {
return !value || this.getMenuFilter().isActivatable();
},
<span id='Ext-ux-grid-FiltersFeature-method-onStateChange'> /**
</span> * @private
* Handler for all events on filters.
* @param {String} event Event name
* @param {Object} filter Standard signature of the event before the event is fired
*/
onStateChange : function (event, filter) {
if (event !== 'serialize') {
var me = this,
grid = me.getGridPanel();
if (filter == me.getMenuFilter()) {
me.menuItem.setChecked(filter.active, false);
}
if ((me.autoReload || me.local) && !me.applyingState) {
me.deferredUpdate.delay(me.updateBuffer);
}
me.updateColumnHeadings();
if (!me.applyingState) {
grid.saveState();
}
grid.fireEvent('filterupdate', me, filter);
}
},
<span id='Ext-ux-grid-FiltersFeature-method-onBeforeLoad'> /**
</span> * @private
* Handler for store's beforeload event when configured for remote filtering
* @param {Object} store
* @param {Object} options
*/
onBeforeLoad : function (store, options) {
options.params = options.params || {};
this.cleanParams(options.params);
var params = this.buildQuery(this.getFilterData());
Ext.apply(options.params, params);
},
<span id='Ext-ux-grid-FiltersFeature-method-onLoad'> /**
</span> * @private
* Handler for store's load event when configured for local filtering
* @param {Object} store
*/
onLoad : function (store) {
store.filterBy(this.getRecordFilter());
},
<span id='Ext-ux-grid-FiltersFeature-method-onRefresh'> /**
</span> * @private
* Handler called when the grid's view is refreshed
*/
onRefresh : function () {
this.updateColumnHeadings();
},
<span id='Ext-ux-grid-FiltersFeature-method-updateColumnHeadings'> /**
</span> * Update the styles for the header row based on the active filters
*/
updateColumnHeadings : function () {
var me = this,
headerCt = me.view.headerCt;
if (headerCt) {
headerCt.items.each(function(header) {
var filter = me.getFilter(header.dataIndex);
header[filter && filter.active ? 'addCls' : 'removeCls'](me.filterCls);
});
}
},
<span id='Ext-ux-grid-FiltersFeature-method-reload'> /** @private */
</span> reload : function () {
var me = this,
store = me.view.getStore();
if (me.local) {
store.clearFilter(true);
store.filterBy(me.getRecordFilter());
store.sort();
} else {
me.deferredUpdate.cancel();
if (store.buffered) {
store.pageMap.clear();
}
store.loadPage(1);
}
},
<span id='Ext-ux-grid-FiltersFeature-method-getRecordFilter'> /**
</span> * Method factory that generates a record validator for the filters active at the time
* of invokation.
* @private
*/
getRecordFilter : function () {
var f = [], len, i;
this.filters.each(function (filter) {
if (filter.active) {
f.push(filter);
}
});
len = f.length;
return function (record) {
for (i = 0; i < len; i++) {
if (!f[i].validateRecord(record)) {
return false;
}
}
return true;
};
},
<span id='Ext-ux-grid-FiltersFeature-method-addFilter'> /**
</span> * Adds a filter to the collection and observes it for state change.
* @param {Object/Ext.ux.grid.filter.Filter} config A filter configuration or a filter object.
* @return {Ext.ux.grid.filter.Filter} The existing or newly created filter object.
*/
addFilter : function (config) {
var me = this,
columns = me.getGridPanel().columns,
i, columnsLength, column, filtersLength, filter;
for (i = 0, columnsLength = columns.length; i < columnsLength; i++) {
column = columns[i];
if (column.dataIndex === config.dataIndex) {
column.filter = config;
}
}
if (me.view.headerCt.menu) {
me.createFilters();
} else {
// Call getMenu() to ensure the menu is created, and so, also are the filters. We cannot call
// createFilters() withouth having a menu because it will cause in a recursion to applyState()
// that ends up to clear all the filter values. This is likely to happen when we reorder a column
// and then add a new filter before the menu is recreated.
me.view.headerCt.getMenu();
}
for (i = 0, filtersLength = me.filters.items.length; i < filtersLength; i++) {
filter = me.filters.items[i];
if (filter.dataIndex === config.dataIndex) {
return filter;
}
}
},
<span id='Ext-ux-grid-FiltersFeature-method-addFilters'> /**
</span> * Adds filters to the collection.
* @param {Array} filters An Array of filter configuration objects.
*/
addFilters : function (filters) {
if (filters) {
var me = this,
i, filtersLength;
for (i = 0, filtersLength = filters.length; i < filtersLength; i++) {
me.addFilter(filters[i]);
}
}
},
<span id='Ext-ux-grid-FiltersFeature-method-getFilter'> /**
</span> * Returns a filter for the given dataIndex, if one exists.
* @param {String} dataIndex The dataIndex of the desired filter object.
* @return {Ext.ux.grid.filter.Filter}
*/
getFilter : function (dataIndex) {
return this.filters.get(dataIndex);
},
<span id='Ext-ux-grid-FiltersFeature-method-clearFilters'> /**
</span> * Turns all filters off. This does not clear the configuration information
* (see {@link #removeAll}).
*/
clearFilters : function () {
this.filters.each(function (filter) {
filter.setActive(false);
});
},
<span id='Ext-ux-grid-FiltersFeature-method-getFilterData'> /**
</span> * Returns an Array of the currently active filters.
* @return {Array} filters Array of the currently active filters.
*/
getFilterData : function () {
var filters = [], i, len;
this.filters.each(function (f) {
if (f.active) {
var d = [].concat(f.serialize());
for (i = 0, len = d.length; i < len; i++) {
filters.push({
field: f.dataIndex,
data: d[i]
});
}
}
});
return filters;
},
<span id='Ext-ux-grid-FiltersFeature-method-buildQuery'> /**
</span> * Function to take the active filters data and build it into a query.
* The format of the query depends on the {@link #encode} configuration:
*
* - `false` (Default) :
* Flatten into query string of the form (assuming <code>{@link #paramPrefix}='filters'</code>:
*
* filters[0][field]="someDataIndex"&
* filters[0][data][comparison]="someValue1"&
* filters[0][data][type]="someValue2"&
* filters[0][data][value]="someValue3"&
*
*
* - `true` :
* JSON encode the filter data
*
* {filters:[{"field":"someDataIndex","comparison":"someValue1","type":"someValue2","value":"someValue3"}]}
*
* Override this method to customize the format of the filter query for remote requests.
*
* @param {Array} filters A collection of objects representing active filters and their configuration.
* Each element will take the form of {field: dataIndex, data: filterConf}. dataIndex is not assured
* to be unique as any one filter may be a composite of more basic filters for the same dataIndex.
*
* @return {Object} Query keys and values
*/
buildQuery : function (filters) {
var p = {}, i, f, root, dataPrefix, key, tmp,
len = filters.length;
if (!this.encode){
for (i = 0; i < len; i++) {
f = filters[i];
root = [this.paramPrefix, '[', i, ']'].join('');
p[root + '[field]'] = f.field;
dataPrefix = root + '[data]';
for (key in f.data) {
p[[dataPrefix, '[', key, ']'].join('')] = f.data[key];
}
}
} else {
tmp = [];
for (i = 0; i < len; i++) {
f = filters[i];
tmp.push(Ext.apply(
{},
{field: f.field},
f.data
));
}
// only build if there is active filter
if (tmp.length > 0){
p[this.paramPrefix] = Ext.JSON.encode(tmp);
}
}
return p;
},
<span id='Ext-ux-grid-FiltersFeature-method-cleanParams'> /**
</span> * Removes filter related query parameters from the provided object.
* @param {Object} p Query parameters that may contain filter related fields.
*/
cleanParams : function (p) {
// if encoding just delete the property
if (this.encode) {
delete p[this.paramPrefix];
// otherwise scrub the object of filter data
} else {
var regex, key;
regex = new RegExp('^' + this.paramPrefix + '\[[0-9]+\]');
for (key in p) {
if (regex.test(key)) {
delete p[key];
}
}
}
},
<span id='Ext-ux-grid-FiltersFeature-method-getFilterClass'> /**
</span> * Function for locating filter classes, overwrite this with your favorite
* loader to provide dynamic filter loading.
* @param {String} type The type of filter to load ('Filter' is automatically
* appended to the passed type; eg, 'string' becomes 'StringFilter').
* @return {Function} The Ext.ux.grid.filter.Class
*/
getFilterClass : function (type) {
// map the supported Ext.data.Field type values into a supported filter
switch(type) {
case 'auto':
type = 'string';
break;
case 'int':
case 'float':
type = 'numeric';
break;
case 'bool':
type = 'boolean';
break;
}
return Ext.ClassManager.getByAlias('gridfilter.' + type);
}
});
</pre>
</body>
</html>