@openui5/sap.m 1.98.0 → 1.101.0

package/src/sap/m/table/columnmenu/QuickAction.js

@@ -0,0 +1,65 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+
+sap.ui.define([
+	"sap/m/table/columnmenu/QuickActionBase"
+], function (
+	QuickActionBase
+) {
+	"use strict";
+
+	/**
+	 * Constructor for a new QuickAction.
+	 *
+	 * @param {string} [sId] ID for the new QuickAction, generated automatically if no ID is given
+	 * @param {object} [mSettings] Initial settings for the new QuickAction
+	 *
+	 * @class
+	 * The QuickAction serves as a quick action for sap.m.table.columnmenu.Menu.
+	 * It can be used to specify control- and application specific quick actions.
+	 *
+	 * @extends sap.m.table.columnmenu.QuickActionBase
+	 *
+	 * @author SAP SE
+	 * @version 1.101.0
+	 *
+	 * @private
+	 * @since 1.99
+	 * @experimental
+	 *
+	 * @alias sap.m.table.columnmenu.QuickAction
+	 */
+	var QuickAction = QuickActionBase.extend("sap.m.table.columnmenu.QuickAction", {
+		metadata: {
+			library: "sap.m",
+			properties: {
+				/**
+				 * Defines the text for the label.
+				 */
+				label: { type: "string" }
+			},
+			aggregations: {
+				/**
+				 * Defines the content that is shown for the quick action.
+				 *
+				 * <b>Notes:</b>
+				 * <ul>
+				 * <li>Adding additional content to the quick action or altering its layout will
+				 * only take effect once the popover has been closed and reopened again.</li>
+				 * <li>The layout of the content of <code>QuickAction</code> can be altered by providing {@link sap.ui.layout.GridData} for each
+				 * <code>layoutData</code> aggregation of each content control. In size S, content controls can take up to
+				 * 12 columns, while in sizes M and bigger, content controls can take up to 8 columns of space.</li>
+				 * <li>If there are more than 2 controls inside a quick action, they will be shown underneath each other if the <code>ColumnMenu</code> is in size S.</li>
+				 * <li>By default, the content controls of <code>QuickAction</code> will take up the same amount of space and will have the same size.</li>
+				 * </ul>
+				 */
+				content: { type: "sap.ui.core.Control", multiple: true }
+			}
+		}
+	});
+
+	return QuickAction;
+});

package/src/sap/m/table/columnmenu/QuickActionBase.js

@@ -0,0 +1,54 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+sap.ui.define([
+	"sap/m/table/columnmenu/Entry"
+], function(
+	Entry
+) {
+	"use strict";
+
+	/**
+	 * Constructor for a new QuickActionBase.
+	 *
+	 * @param {string} [sId] ID for the new QuickActionBase, generated automatically if no ID is given
+	 * @param {object} [mSettings] Initial settings for the new QuickActionBase
+	 *
+	 * @class
+	 * The QuickActionBase serves as a base class for quick actions.
+	 * This base class is faceless and should be inherited by elements which intend to serve as quick actions for the sap.m.table.columnmenu.Menu.
+	 *
+	 * @extends sap.m.table.columnmenu.Entry
+	 *
+	 * @author SAP SE
+	 * @version 1.101.0
+	 *
+	 * @private
+	 * @experimental
+	 *
+	 * @alias sap.m.table.columnmenu.QuickActionBase
+	 */
+	var QuickActionBase = Entry.extend("sap.m.table.columnmenu.QuickActionBase", {
+		metadata: {
+			"abstract": true,
+			library: "sap.m"
+		}
+	});
+
+	/**
+	 * This method can be used to retrieve the effective quick actions.
+	 *
+	 * Subclasses can implement this method, if there are compositions of other quick actions.
+	 * @returns {sap.m.table.columnmenu.QuickActionBase[]} The effective quick actions
+	 *
+	 * @virtual
+	 * @public
+	 */
+	QuickActionBase.prototype.getEffectiveQuickActions = function() {
+		return [this];
+	};
+
+	return QuickActionBase;
+});

package/src/sap/m/table/columnmenu/QuickActionContainer.js

@@ -0,0 +1,29 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+sap.ui.define([
+	"sap/m/table/columnmenu/QuickActionBase"
+], function(
+	QuickActionBase
+) {
+	"use strict";
+
+	var QuickActionContainer = QuickActionBase.extend("sap.m.table.columnmenu.QuickActionContainer", {
+		metadata: {
+			library: "sap.m",
+			aggregations: {
+				quickActions: {type: "sap.m.table.columnmenu.QuickActionBase"}
+			}
+		}
+	});
+
+	QuickActionContainer.prototype.getEffectiveQuickActions = function() {
+		return this.getQuickActions().reduce(function(aQuickActions, oQuickAction) {
+			return aQuickActions.concat(oQuickAction.getEffectiveQuickActions());
+		}, []);
+	};
+
+	return QuickActionContainer;
+});

package/src/sap/m/table/columnmenu/QuickActionItem.js

@@ -0,0 +1,51 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+
+sap.ui.define([
+	"sap/ui/core/Element"
+], function (
+	Element
+) {
+	"use strict";
+
+	/**
+	 * Constructor for a new QuickActionItem.
+	 *
+	 * @param {string} [sId] ID for the new QuickActionItem, generated automatically if no ID is given
+	 * @param {object} [mSettings] Initial settings for the new QuickActionItem
+	 *
+	 * @class
+	 * This element serves as a quick action item.
+	 * It can be used to specify control- and application specific quick action items.
+	 *
+	 * @extends sap.ui.core.Element
+	 *
+	 * @author SAP SE
+	 * @version 1.101.0
+	 *
+	 * @private
+	 * @experimental
+	 *
+	 * @alias sap.m.table.columnmenu.QuickActionItem
+	 */
+	var QuickActionItem = Element.extend("sap.m.table.columnmenu.QuickActionItem", {
+		metadata: {
+			library: "sap.m",
+			properties: {
+				/**
+				 * The property name
+				 */
+				key: { type: "string" },
+				/**
+				 * Defines the text for the label.
+				 */
+				label: { type: "string" }
+			}
+		}
+	});
+
+	return QuickActionItem;
+});

package/src/sap/m/table/columnmenu/QuickGroup.js

@@ -0,0 +1,146 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+
+sap.ui.define([
+	"sap/m/table/columnmenu/QuickActionBase",
+	"sap/m/HBox",
+	"sap/m/ToggleButton"
+], function (
+	QuickActionBase,
+	HBox,
+	ToggleButton
+) {
+	"use strict";
+
+	/**
+	 * Constructor for a new QuickGroup.
+	 *
+	 * @param {string} [sId] ID for the new QuickGroup, generated automatically if no ID is given
+	 * @param {object} [mSettings] Initial settings for the new QuickGroup
+	 *
+	 * @class
+	 * Quick action - group
+	 *
+	 * @extends sap.m.table.columnmenu.QuickActionBase
+	 *
+	 * @author SAP SE
+	 * @version 1.101.0
+	 *
+	 * @private
+	 * @experimental
+	 *
+	 * @alias sap.m.table.columnmenu.QuickGroup
+	 */
+	var QuickGroup = QuickActionBase.extend("sap.m.table.columnmenu.QuickGroup", {
+		metadata: {
+			library: "sap.m",
+			aggregations: {
+				/**
+				 * The groupable properties and the initial state.
+				 */
+				items: { type: "sap.m.table.columnmenu.QuickGroupItem", multiple: true }
+			},
+			events: {
+				/**
+				 * Fires the change event.
+				 */
+				change: {
+					parameters: {
+						/**
+						 * The key of the property to be grouped.
+						 */
+						key: { type: "string" },
+						/**
+						 * The new grouped state.
+						 */
+						grouped: { type: "boolean" }
+					}
+				}
+			}
+		}
+	});
+
+	QuickGroup.prototype.exit = function() {
+		this.destroyContent();
+	};
+
+	QuickGroup.prototype.getLabel = function() {
+		var oBundle = sap.ui.getCore().getLibraryResourceBundle("sap.m");
+		return oBundle.getText("table.COLUMNMENU_QUICK_GROUP");
+	};
+
+	QuickGroup.prototype.getContent = function() {
+		if (!this._aContent) {
+			this._aContent = this.createContent(this.getItems());
+			this._aContent.forEach(function(oItem) {
+				this.addDependent(oItem);
+			}.bind(this));
+		}
+
+		return this._aContent;
+	};
+
+	QuickGroup.prototype.addItem = function(oItem) {
+		this.destroyContent();
+		return this.addAggregation("items", oItem);
+	};
+
+	QuickGroup.prototype.insertItem = function(oItem, iIndex) {
+		this.destroyContent();
+		return this.insertAggregation("items", oItem, iIndex);
+	};
+
+	QuickGroup.prototype.removeItem = function(oItem) {
+		this.destroyContent();
+		return this.removeAggregation("items", oItem);
+	};
+
+	QuickGroup.prototype.removeAllItems = function() {
+		this.destroyContent();
+		return this.removeAllAggregation("items");
+	};
+
+	QuickGroup.prototype.destroyItems = function() {
+		this.destroyContent();
+		return this.destroyAggregation("items");
+	};
+
+	QuickGroup.prototype.createContent = function(aItems) {
+		return aItems.map(function(oItem) {
+			return new ToggleButton({
+				text: oItem.getLabel(),
+				pressed: oItem.getGrouped(),
+				press: [oItem, this.onChange, this]
+			});
+		}, this);
+	};
+
+	QuickGroup.prototype.destroyContent = function() {
+		if (this._aContent) {
+			this._aContent.forEach(function (oContent) {
+				oContent.destroy();
+			});
+			delete this._aContent;
+		}
+	};
+
+	QuickGroup.prototype._onItemChange = function(oQuickGroupItem, bGrouped) {
+		var sLabel = oQuickGroupItem.getLabel();
+
+		var oButton = this.getContent().find(function(oBtn) {
+			return oBtn.getText() === sLabel;
+		});
+
+		oButton.setPressed(bGrouped);
+	};
+
+	QuickGroup.prototype.onChange = function(oEvent, oItem) {
+		oItem.setProperty("grouped", oEvent.getParameters().pressed, true);
+		this.fireChange({item: oItem});
+	};
+
+	return QuickGroup;
+});

package/src/sap/m/table/columnmenu/QuickGroupItem.js

@@ -0,0 +1,59 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+
+sap.ui.define([
+	"./QuickActionItem"
+], function (
+	QuickActionItem
+) {
+	"use strict";
+
+	/**
+	 * Constructor for a new QuickGroupItem.
+	 *
+	 * @param {string} [sId] ID for the new QuickGroupItem, generated automatically if no ID is given
+	 * @param {object} [mSettings] Initial settings for the new QuickGroupItem
+	 *
+	 * @class
+	 * This element serves as a quick group item.
+	 * It can be used to specify control- and application specific quick group items.
+	 *
+	 * @extends sap.m.table.columnmenu.QuickActionItem
+	 *
+	 * @author SAP SE
+	 * @version 1.101.0
+	 *
+	 * @private
+	 * @experimental
+	 *
+	 * @alias sap.m.table.columnmenu.QuickGroupItem
+	 */
+	var QuickGroupItem = QuickActionItem.extend("sap.m.table.columnmenu.QuickGroupItem", {
+		metadata: {
+			library: "sap.m",
+			properties: {
+				/**
+				 * Specifies whether the respective column is grouped.
+				 */
+				grouped: { type: "boolean", defaultValue: false }
+			}
+		}
+	});
+
+	/*
+	 * @see JSDoc generated by SAPUI5 control API generator
+	 */
+	QuickGroupItem.prototype.setGrouped = function(bGrouped) {
+		this.setProperty("grouped", bGrouped);
+
+		var oQuickGroup = this.getParent();
+		if (oQuickGroup) {
+			oQuickGroup._onItemChange(this, bGrouped);
+		}
+	};
+
+	return QuickGroupItem;
+});

package/src/sap/m/table/columnmenu/QuickSort.js

@@ -0,0 +1,80 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+
+sap.ui.define([
+	"sap/ui/core/Element",
+	"sap/m/table/columnmenu/QuickActionBase"
+], function (
+	Element,
+	QuickActionBase
+) {
+	"use strict";
+
+	/**
+	 * Constructor for a new QuickSort.
+	 *
+	 * @param {string} [sId] ID for the new QuickSort, generated automatically if no ID is given
+	 * @param {object} [mSettings] Initial settings for the new QuickSort
+	 *
+	 * @class
+	 * Quick action - sort
+	 *
+	 * @extends sap.m.table.columnmenu.QuickActionBase
+	 *
+	 * @author SAP SE
+	 * @version 1.101.0
+	 *
+	 * @private
+	 * @experimental
+	 *
+	 * @alias sap.m.table.columnmenu.QuickSort
+	 */
+	var QuickSort = QuickActionBase.extend("sap.m.table.columnmenu.QuickSort", {
+		metadata: {
+			library: "sap.m",
+			aggregations: {
+				/**
+				 * The sortable properties and the initial state.
+				 */
+				items: { type: "sap.m.table.columnmenu.QuickSortItem", multiple: true }
+			},
+			events: {
+				/**
+				 * Fires the change event.
+				 */
+				change: {
+					parameters: {
+						/**
+						 * The key of the property to be sorted.
+						 */
+						key: { type: "string" },
+						/**
+						 * The new sort order.
+						 */
+						sortOrder: { type: "sap.ui.core.SortOrder" }
+					}
+				}
+			}
+		}
+	});
+
+	QuickSort.prototype.getEffectiveQuickActions = function() {
+		var aItems = this.getItems();
+		var aEffectiveQuickActions = [];
+
+		aItems.forEach(function(oItem) {
+			aEffectiveQuickActions.push(oItem._getAction());
+		}, this);
+
+		return aEffectiveQuickActions;
+	};
+
+	QuickSort.prototype.onChange = function(oItem) {
+		this.fireChange({item: oItem});
+	};
+
+	return QuickSort;
+});

package/src/sap/m/table/columnmenu/QuickSortItem.js

@@ -0,0 +1,118 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+
+sap.ui.define([
+	"./QuickActionItem",
+	"./QuickAction",
+	"sap/m/HBox",
+	"sap/m/ToggleButton",
+	"sap/ui/core/library"
+], function (
+	QuickActionItem,
+	QuickAction,
+	HBox,
+	ToggleButton,
+	library
+) {
+	"use strict";
+
+	var SortOrder = library.SortOrder;
+
+	/**
+	 * Constructor for a new QuickSortItem.
+	 *
+	 * @param {string} [sId] ID for the new QuickSortItem, generated automatically if no ID is given
+	 * @param {object} [mSettings] Initial settings for the new QuickSortItem
+	 *
+	 * @class
+	 * This element serves as a quick sort item.
+	 * It can be used to specify control- and application specific quick sort items.
+	 *
+	 * @extends sap.m.table.columnmenu.QuickActionItem
+	 *
+	 * @author SAP SE
+	 * @version 1.101.0
+	 *
+	 * @private
+	 * @experimental
+	 *
+	 * @alias sap.m.table.columnmenu.QuickSortItem
+	 */
+	var QuickSortItem = QuickActionItem.extend("sap.m.table.columnmenu.QuickSortItem", {
+		metadata: {
+			library: "sap.m",
+			properties: {
+				sortOrder: { type: "sap.ui.core.SortOrder", defaultValue: library.SortOrder.None }
+			},
+			aggregations: {
+				quickAction: { type: "sap.m.table.columnmenu.QuickAction", multiple: false, visibility: "hidden" }
+			}
+		}
+	});
+
+	QuickSortItem.prototype._getAction = function() {
+		var oQuickAction = this.getAggregation("quickAction");
+		var sLabel = this._getLabel(this.getParent().getItems().length);
+
+		if (oQuickAction) {
+			oQuickAction.setLabel(sLabel);
+		} else {
+			oQuickAction = new QuickAction({
+				label: sLabel,
+				content: [this._createContent()]
+			});
+		}
+
+		this.setAggregation("quickAction", oQuickAction, true);
+		return oQuickAction;
+	};
+
+	QuickSortItem.prototype._getLabel = function(iLength) {
+		var oBundle = sap.ui.getCore().getLibraryResourceBundle("sap.m");
+		if (iLength === 1) {
+			return oBundle.getText("table.COLUMNMENU_QUICK_SORT");
+		} else {
+			return oBundle.getText("table.COLUMNMENU_SORT_BY", this.getLabel());
+		}
+	};
+
+	QuickSortItem.prototype._createContent = function() {
+		var oBundle = sap.ui.getCore().getLibraryResourceBundle("sap.m");
+		return [
+			new ToggleButton({
+				text: oBundle.getText("table.COLUMNMENU_SORT_ASCENDING"),
+				pressed: this.getSortOrder() === SortOrder.Ascending,
+				press: [{item: this, sortOrder: SortOrder.Ascending}, this._onSortChange, this]
+			}),
+			new ToggleButton({
+				text: oBundle.getText("table.COLUMNMENU_SORT_DESCENDING"),
+				pressed: this.getSortOrder() === SortOrder.Descending,
+				press: [{item: this, sortOrder: SortOrder.Descending}, this._onSortChange, this]
+			})
+		];
+	};
+
+	QuickSortItem.prototype._onSortChange = function (oEvent, mSortInfo) {
+		this.setSortOrder(oEvent.getParameters().pressed ? mSortInfo.sortOrder : SortOrder.None, true);
+		this.getParent().onChange(mSortInfo.item);
+	};
+
+	/*
+	 * @see JSDoc generated by SAPUI5 control API generator
+	 */
+	QuickSortItem.prototype.setSortOrder = function(sSortOrder) {
+		this.setProperty("sortOrder", sSortOrder);
+
+		var oQuickAction = this.getAggregation("quickAction");
+		if (oQuickAction) {
+			var aButtons = oQuickAction.getContent();
+			aButtons[0].setPressed(sSortOrder === SortOrder.Ascending);
+			aButtons[1].setPressed(sSortOrder === SortOrder.Descending);
+		}
+	};
+
+	return QuickSortItem;
+});