summaryrefslogtreecommitdiff
path: root/addons/web/static/src/js/control_panel/groupby_menu.js
diff options
context:
space:
mode:
authorJulien Mougenot <jum@odoo.com>2020-03-11 09:38:28 +0000
committerJulien Mougenot <jum@odoo.com>2020-03-13 14:08:33 +0000
commitfbf347498f1cc7b74ef373179b7bcae201715c24 (patch)
treeb8d1eb29ec93b6c2e43dbade712e636d32fe6716 /addons/web/static/src/js/control_panel/groupby_menu.js
parent0a129284e4856b6485c48a194fd86c3ab5c736e7 (diff)
[REF] web: Control panel Owl
Refactoring of the control panel with the Owl framework. The MVC structure of the control panel has been changed to a 'component <-> model' relationship. As such: - Removed the old control panel: view/model/controller/renderer - Created a new Owl Component (ControlPanel) - Created a new class: the Model (an Owl Store did not fit here) and a newly designed ControlPanelModel extending it Refactored all inner subcomponents, including: - Pager - ActionMenus (peviously SideBar) - Filter menu > Custom filter item - Group by menu > Custom group by item > Removal of groupby_menu_mixin (and refactored graph controller in sibling commit) - Time range menu - Favorite menu > Custom favorite item > Moved the favorite menu registry to the favorite_menu file - Search bar > Removed and splitted auto-completion dropdown logic between the new SearchBar Component (descriptions) and to the new ControlPanelModel (domains). The templates (all in web/base.xml) have been adapted to the new standards. Most of the DOM structure remains unchanged with some occasional improvements (replace hiding with not rendering, removed pointless wrapper divs, etc.). Part of task 2196029 Co-authored-by: Mathieu Duckerts-Antoine <dam@odoo.com>
Diffstat (limited to 'addons/web/static/src/js/control_panel/groupby_menu.js')
-rw-r--r--addons/web/static/src/js/control_panel/groupby_menu.js94
1 files changed, 94 insertions, 0 deletions
diff --git a/addons/web/static/src/js/control_panel/groupby_menu.js b/addons/web/static/src/js/control_panel/groupby_menu.js
new file mode 100644
index 00000000000..858f2a7953e
--- /dev/null
+++ b/addons/web/static/src/js/control_panel/groupby_menu.js
@@ -0,0 +1,94 @@
+odoo.define('web.GroupByMenu', function (require) {
+ "use strict";
+
+ const { GROUPABLE_TYPES } = require('web.searchUtils');
+ const DropdownMenu = require('web.DropdownMenu');
+ const CustomGroupByItem = require('web.CustomGroupByItem');
+ const { useModel } = require('web.model');
+
+ /**
+ * 'Group by' menu
+ *
+ * Simple rendering of the filters of type `groupBy` given by the control panel
+ * model. It uses most of the behaviours implemented by the dropdown menu Component,
+ * with the addition of a groupBy filter generator (@see CustomGroupByItem).
+ * @see DropdownMenu for additional details.
+ * @extends DropdownMenu
+ */
+ class GroupByMenu extends DropdownMenu {
+
+ constructor() {
+ super(...arguments);
+
+ this.fields = Object.values(this.props.fields)
+ .filter(field => this._validateField(field))
+ .sort(({ string: a }, { string: b }) => a > b ? 1 : a < b ? -1 : 0);
+
+ this.model = useModel('controlPanelModel');
+ }
+
+ //---------------------------------------------------------------------
+ // Getters
+ //---------------------------------------------------------------------
+
+ /**
+ * @override
+ */
+ get items() {
+ return this.model.getFiltersOfType('groupBy');
+ }
+
+ /**
+ * @override
+ */
+ get title() {
+ return this.env._t("Group By");
+ }
+
+ //---------------------------------------------------------------------
+ // Private
+ //---------------------------------------------------------------------
+
+ /**
+ * @private
+ * @param {Object} field
+ * @returns {boolean}
+ */
+ _validateField(field) {
+ return field.sortable &&
+ field.name !== "id" &&
+ GROUPABLE_TYPES.includes(field.type);
+ }
+
+ //---------------------------------------------------------------------
+ // Handlers
+ //---------------------------------------------------------------------
+
+ /**
+ * @private
+ * @param {OwlEvent} ev
+ */
+ _onItemSelected(ev) {
+ ev.stopPropagation();
+ const { item, option } = ev.detail;
+ if (option) {
+ this.model.dispatch('toggleFilterWithOptions', item.id, option.id);
+ } else {
+ this.model.dispatch('toggleFilter', item.id);
+ }
+ }
+ }
+
+ GroupByMenu.components = Object.assign({}, DropdownMenu.components, {
+ CustomGroupByItem,
+ });
+ GroupByMenu.defaultProps = Object.assign({}, DropdownMenu.defaultProps, {
+ icon: 'fa fa-bars',
+ });
+ GroupByMenu.props = Object.assign({}, DropdownMenu.props, {
+ fields: Object,
+ });
+ GroupByMenu.template = 'web.GroupByMenu';
+
+ return GroupByMenu;
+});