Skip to content
This repository was archived by the owner on Oct 8, 2021. It is now read-only.

Commit 77e55b6

Browse files
brtnJelteMX
brtn
authored and
JelteMX
committed
Added the capability to make filters exclusive (#40)
* Added the capability to make filters exclusive * Changes after review phase 1 * Remove unused styling
1 parent 9a67393 commit 77e55b6

15 files changed

Lines changed: 350 additions & 105 deletions

‎dist/TreeView.mpk‎

3.83 KB
Binary file not shown.

‎src/TreeView/GridView.xml‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -358,7 +358,7 @@ Pmmn04F2ux1MpVI79I4q6jJMfXsbe3iMjYKIcDicKxQKt4qiWFRJi6Joe9iUkWER6C8e48eQCJLC
358358
<property key="blaat4" type="object" isList="true" required="false">
359359
<caption>Search filters</caption>
360360
<category>3) Search</category>
361-
<description>This properties creates quick-filter dropdown buttons for the grid. A filter can be based on a boolean or enumeration value.</description>
361+
<description>These properties creates quick-filter dropdown buttons for the grid. A filter can be based on a boolean or enumeration value.</description>
362362
<properties>
363363
<property key="filterattr" type="attribute" entityProperty="../entity" required="true" isPath="optional" pathType="reference">
364364
<caption>Filter attribute</caption>
@@ -390,6 +390,11 @@ Pmmn04F2ux1MpVI79I4q6jJMfXsbe3iMjYKIcDicKxQKt4qiWFRJi6Joe9iUkWER6C8e48eQCJLC
390390
<enumerationValue key="false">False only</enumerationValue>
391391
</enumerationValues>
392392
</property>
393+
<property key="filteranycaption" type="translatableString" required="false">
394+
<caption>Any/All caption</caption>
395+
<category>3) Exclusive filter</category>
396+
<description>Examples: "All Users", "Any type"</description>
397+
</property>
393398
</properties>
394399
</property>
395400

@@ -500,6 +505,11 @@ Pmmn04F2ux1MpVI79I4q6jJMfXsbe3iMjYKIcDicKxQKt4qiWFRJi6Joe9iUkWER6C8e48eQCJLC
500505
<category>3) Search</category>
501506
<description>If a dataset is provided, the values of this dataset will appear as dropdown list in the search box when searching</description>
502507
</property>
508+
<property key="filterexclusive" type="boolean" defaultValue="false" required="true">
509+
<caption>Use exclusive filters</caption>
510+
<category>3) Search</category>
511+
<description>If when checked, each filter will have its own dropdown menu.</description>
512+
</property>
503513
<property key="showtotals" type="boolean" defaultValue="true">
504514
<caption>Show item count in the paging section</caption>
505515
<category>2) Appearance</category>

‎src/TreeView/widget/Commons/FilterManager.js‎

Lines changed: 0 additions & 64 deletions
This file was deleted.

‎src/TreeView/widget/Filters/AbstractFilter.js‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
define([
2+
"dojo/_base/declare",
3+
"dojo/_base/lang"
4+
], function(declare, lang) {
5+
"use strict";
6+
7+
return declare("TreeView.widget.Filters.AbstractFilter", null, {
8+
filterManager: null,
9+
10+
filterattr: null,
11+
filtertruecaption: null,
12+
filterfalsecaption: null,
13+
filterbooleandefault: null,
14+
15+
isEnum: false,
16+
trueitem: null,
17+
falseitem: null,
18+
enumStateMap: null,
19+
enumItems: null,
20+
21+
itemClick: function () {
22+
this.filterManager.applyFilters();
23+
},
24+
25+
constructor: function (args, filterManager) {
26+
this.filterManager = filterManager;
27+
dojo.mixin(this, args);
28+
29+
},
30+
31+
getSearchConstraints: function () {
32+
console.error("ERROR: You must override getSearchConstraints()");
33+
},
34+
35+
free: function () {}
36+
});
37+
});

‎src/TreeView/widget/Filters/BoolFilter.js‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
define([
2+
"dojo/_base/declare",
3+
"dojo/_base/lang",
4+
"dijit/CheckedMenuItem",
5+
"TreeView/widget/Commons",
6+
"TreeView/widget/Filters/ExclusiveFilter"
7+
], function(declare, lang, CheckedMenuItem, Commons, ExclusiveFilter) {
8+
"use strict";
9+
10+
return declare("TreeView.widget.Filters.BoolFilter", ExclusiveFilter, {
11+
12+
constructor: function (args, fm) {
13+
this.anyitem = new CheckedMenuItem({
14+
label: this.anylabel,
15+
checked: true,
16+
onChange: lang.hitch(this, this.itemClick, this.anylabel)
17+
});
18+
this.menuItems.push(this.anyitem);
19+
20+
if (this.filtertruecaption){
21+
this.trueitem = new CheckedMenuItem({
22+
label: this.filtertruecaption,
23+
checked: false,
24+
onChange: lang.hitch(this, this.itemClick, this.filtertruecaption)
25+
});
26+
this.menuItems.push(this.trueitem);
27+
}
28+
if (this.filterfalsecaption){
29+
this.falseitem = new CheckedMenuItem({
30+
label: this.filterfalsecaption,
31+
checked: false,
32+
onChange: lang.hitch(this, this.itemClick, this.filterfalsecaption)
33+
});
34+
this.menuItems.push(this.falseitem);
35+
}
36+
37+
dojo.forEach(this.menuItems, function(item) {
38+
this.menu.addChild(item);
39+
}, this);
40+
},
41+
42+
getSearchConstraints: function () {
43+
var res = [];
44+
45+
if (this.trueitem && this.trueitem.get("checked") === true){
46+
res.push(this.filterattr + " = true() ");
47+
}
48+
if (this.falseitem && this.falseitem.get("checked") === true){
49+
res.push(this.filterattr + " = false()");
50+
}
51+
52+
if (res.length == 0) {//filter all out
53+
res.push(this.filterattr + " = true() or " + this.filterattr + " = false()");
54+
}
55+
return res;
56+
}
57+
});
58+
});

‎src/TreeView/widget/Filters/EnumFilter.js‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
define([
2+
"dojo/_base/declare",
3+
"dojo/_base/lang",
4+
"dijit/CheckedMenuItem",
5+
"TreeView/widget/Commons",
6+
"TreeView/widget/Filters/ExclusiveFilter"
7+
], function(declare, lang, CheckedMenuItem, Commons, ExclusiveFilter) {
8+
"use strict";
9+
10+
return declare("TreeView.widget.Filters.EnumFilter", ExclusiveFilter, {
11+
12+
constructor: function (args, filterManager) {
13+
14+
this.enumStateMap = {};
15+
16+
this.anyitem = new CheckedMenuItem({
17+
label: this.anylabel,
18+
checked: true,
19+
onClick: lang.hitch(this, this.itemClick, this.anylabel)
20+
});
21+
this.menuItems.push(this.anyitem);
22+
23+
this.menuItems = this.menuItems.concat( dojo.map(
24+
Commons.getEnumMap(filterManager.widget.entity, this.filterattr),
25+
function (enumItem) {
26+
27+
var mi = new CheckedMenuItem({
28+
label: enumItem.caption,
29+
checked: false,
30+
onClick: lang.hitch(this, this.itemClick, enumItem.caption)
31+
});
32+
33+
this.enumStateMap[enumItem.key] = mi;
34+
return mi;
35+
}, this));
36+
37+
dojo.forEach(this.menuItems, function(item) {
38+
this.menu.addChild(item);
39+
}, this);
40+
41+
},
42+
43+
getSearchConstraints: function () {
44+
var res = [];
45+
46+
for (var key in this.enumStateMap){
47+
if (this.enumStateMap[key].get("checked") === true){
48+
res.push(this.filterattr + " = '" + key + "'");
49+
}
50+
}
51+
52+
return res;
53+
}
54+
});
55+
});

‎src/TreeView/widget/Filters/ExclusiveFilter.js‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
define([
2+
"dojo/_base/declare",
3+
"dojo/_base/lang",
4+
"dijit/form/DropDownButton",
5+
"dijit/Menu",
6+
"dijit/CheckedMenuItem",
7+
"TreeView/widget/Commons",
8+
"TreeView/widget/Filters/AbstractFilter"
9+
], function(declare, lang, DropDownButton, Menu, CheckedMenuItem, Commons, AbstractFilter) {
10+
"use strict";
11+
12+
return declare("TreeView.widget.Filters.ExclusiveFilter", AbstractFilter, {
13+
14+
itemClick: function (label, e) {
15+
this.dropdown.set("label", label);
16+
17+
for (var i = 0; i < this.menuItems.length; i++) {
18+
var item = this.menuItems[i];
19+
20+
item.set("checked", (item.label == label));
21+
}
22+
23+
this.filterManager.applyFilters();
24+
},
25+
26+
constructor: function (args, filterManager) {
27+
this.filterManager = filterManager;
28+
dojo.mixin(this, args);
29+
30+
this.menu = new Menu({
31+
style: "display: none;"
32+
});
33+
this.menuItems = [];
34+
35+
this.dropdown = new DropDownButton({
36+
label : this.filterattr,
37+
dropDown : this.menu
38+
});
39+
40+
if (this.filteranycaption) {
41+
this.anylabel = this.filteranycaption;
42+
} else {
43+
this.anylabel = this.filterattr + ": -";
44+
}
45+
46+
this.dropdown.set("label", this.anylabel);
47+
48+
dojo.addClass(this.dropdown.dropDown.domNode, "gv_filter_dropdown_menu");
49+
dojo.addClass(this.dropdown.domNode, "gv_filter_dropdown");
50+
51+
dojo.place(this.dropdown.domNode, this.filterManager.domNode);
52+
}
53+
});
54+
});

src/TreeView/widget/Commons/Filter.js renamed to src/TreeView/widget/Filters/Filter.js

Lines changed: 8 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -2,39 +2,23 @@ define([
22
"dojo/_base/declare",
33
"dojo/_base/lang",
44
"dijit/CheckedMenuItem",
5-
"TreeView/widget/Commons"
6-
], function(declare, lang, CheckedMenuItem, Commons) {
5+
"TreeView/widget/Commons",
6+
"TreeView/widget/Filters/AbstractFilter"
7+
], function(declare, lang, CheckedMenuItem, Commons, AbstractFilter) {
78
"use strict";
89

9-
return declare("TreeView.widget.Commons.Filter", null, {
10-
fm: null,
11-
filterattr: null,
12-
filtertruecaption: null,
13-
filterfalsecaption: null,
14-
filterbooleandefault: null,
10+
return declare("TreeView.widget.Filters.Filter", AbstractFilter, {
1511

16-
isEnum: false,
17-
trueitem: null,
18-
falseitem: null,
19-
enumStateMap: null,
20-
enumItems: null,
12+
constructor: function (args, filterManager) {
2113

22-
itemClick: function () {
23-
this.fm.applyFilters();
24-
},
25-
26-
constructor: function (args, fm) {
27-
this.fm = fm;
28-
dojo.mixin(this, args);
29-
30-
this.isEnum = Commons.getAttributeType(fm.widget.entity, this.filterattr) == "Enum";
14+
this.isEnum = Commons.getAttributeType(filterManager.widget.entity, this.filterattr) == "Enum";
3115

3216
//setup enum menu items
3317
if (this.isEnum) {
3418
this.enumStateMap = {};
3519

3620
this.enumItems = dojo.map(
37-
Commons.getEnumMap(fm.widget.entity, this.filterattr),
21+
Commons.getEnumMap(filterManager.widget.entity, this.filterattr),
3822
function (enumItem) {
3923

4024
var mi = new CheckedMenuItem({
@@ -67,9 +51,8 @@ define([
6751
}
6852
}
6953

70-
this.fm.addFilter(this);
7154
},
72-
55+
7356
getMenuItems: function () {
7457
if (this.isEnum){
7558
return this.enumItems;
@@ -113,10 +96,6 @@ define([
11396
res.push(this.isEnum ? this.filterattr + " = NULL" : this.filterattr + " = true() and " + this.filterattr + " = false()");
11497
}
11598
return res;
116-
},
117-
118-
free: function () {
119-
12099
}
121100
});
122101
});

0 commit comments

Comments
 (0)