@openui5/sap.m 1.103.0 → 1.105.0

package/src/sap/m/p13n/FlexUtil.js

@@ -0,0 +1,161 @@
+/*!
+ * 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([
+], function () {
+	"use strict";
+
+	var FlexUtil = {
+
+		getPropertySetterChanges: function(mDeltaInfo) {
+			var oControl = mDeltaInfo.control;
+			var aExistingState = mDeltaInfo.existingState;
+			var aChangedState = mDeltaInfo.changedState;
+			var sOperation = mDeltaInfo.operation;
+			var sSetAttribute = mDeltaInfo.deltaAttribute;
+
+			var aSetterChanges = [];
+
+			aChangedState.forEach(function(oItem){
+				//check if the provided state item holds the value to check for
+				if (oItem.hasOwnProperty(sSetAttribute)) {
+					var oExistingItem = aExistingState.find(function(oExisting){return oExisting.name == oItem.name;});
+
+					//compare to identify delta (only create a change if really necessary)
+					var vOldValue = oExistingItem && oExistingItem.hasOwnProperty(sSetAttribute) && oExistingItem[sSetAttribute];
+					var vNewValue = oItem[sSetAttribute];
+					var bValueChanged = vOldValue !== vNewValue;
+					if (bValueChanged) {
+						aSetterChanges.push(this.createChange(oControl, sOperation, {
+							name: oItem.name,
+							value: oItem[sSetAttribute]
+						}));
+					}
+				}
+			}.bind(this));
+
+			return aSetterChanges;
+		},
+
+		/**
+		 * Method which reduces a propertyinfo map to changecontent relevant attributes.
+		 * <b>Note:</b> This method determines the attributes stored in the changeContent.
+		 *
+		 * @param {object} oProperty Object containing all values prior to change creation
+		 * @param {array} aDeltaAttributes Array containing all attributes that are necessary for the delta calculation
+		 *
+		 * @returns {object} Object containing reduced content
+		 */
+		_getChangeContent: function (oProperty, aDeltaAttributes) {
+
+			var oChangeContent = {};
+
+			// Index
+			if (oProperty.index >= 0) {
+				oChangeContent.index = oProperty.index;
+			}
+
+			aDeltaAttributes.forEach(function(sAttribute) {
+				if (oProperty.hasOwnProperty(sAttribute)){
+					oChangeContent[sAttribute] = oProperty[sAttribute];
+				}
+			});
+
+			return oChangeContent;
+		},
+
+		_hasProperty: function(aPropertyInfo, sName) {
+			return aPropertyInfo.some(function(oProperty){
+				//First check unique name
+				var bValid = oProperty.name === sName || sName == "$search";
+
+				//Use path as Fallback
+				bValid = bValid ? bValid : oProperty.path === sName;
+
+				return bValid;
+			});
+		},
+
+		createChange: function(oControl, sOperation, oContent){
+			var oAddRemoveChange = {
+				selectorElement: oControl,
+				changeSpecificData: {
+					changeType: sOperation,
+					content: oContent
+				}
+			};
+			return oAddRemoveChange;
+		},
+
+		createConditionChange: function(sChangeType, oControl, sFieldPath, oCondition) {
+			delete oCondition.filtered;
+			var oConditionChange = {
+				selectorElement: oControl,
+				changeSpecificData: {
+					changeType: sChangeType,
+					content: {
+						name: sFieldPath,
+						condition: oCondition
+					}
+				}
+			};
+
+			return oConditionChange;
+		},
+
+		handleChanges: function (aChanges, bIgnoreVM, bUseStaticArea) {
+			return new Promise(function (resolve, reject) {
+				sap.ui.require([
+					"sap/ui/fl/write/api/ControlPersonalizationWriteAPI"
+				], function (ControlPersonalizationWriteAPI) {
+					ControlPersonalizationWriteAPI.add({
+						changes: aChanges,
+						ignoreVariantManagement: bIgnoreVM,
+						useStaticArea: bUseStaticArea
+					}).then(function (aDirtyChanges) {
+						resolve(aDirtyChanges);
+					}, reject);
+				});
+			});
+		},
+
+		saveChanges: function (oControl, aDirtyChanges) {
+			return new Promise(function (resolve, reject) {
+				sap.ui.require([
+					"sap/ui/fl/write/api/ControlPersonalizationWriteAPI"
+				], function (ControlPersonalizationWriteAPI) {
+					ControlPersonalizationWriteAPI.save({
+						selector: oControl, changes: aDirtyChanges
+					}).then(resolve);
+				});
+			});
+		},
+
+		restore: function(mPropertyBag) {
+			return new Promise(function (resolve, reject) {
+				sap.ui.require([
+					"sap/ui/fl/write/api/ControlPersonalizationWriteAPI"
+				], function (ControlPersonalizationWriteAPI) {
+					ControlPersonalizationWriteAPI.restore(mPropertyBag).then(function () {
+						resolve();
+					}, reject);
+				});
+			});
+		},
+
+		reset: function(mPropertyBag) {
+			return new Promise(function (resolve, reject) {
+				sap.ui.require([
+					"sap/ui/fl/write/api/ControlPersonalizationWriteAPI"
+				], function (ControlPersonalizationWriteAPI) {
+					ControlPersonalizationWriteAPI.reset(mPropertyBag).then(function () {
+						resolve();
+					}, reject);
+				});
+			});
+		}
+	};
+	return FlexUtil;
+});

package/src/sap/m/p13n/GroupController.js

@@ -0,0 +1,145 @@
+/*!
+ * 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/p13n/SelectionController', 'sap/m/p13n/GroupPanel', 'sap/m/p13n/modules/xConfigAPI'
+], function (BaseController, GroupPanel, xConfigAPI) {
+    "use strict";
+
+     /**
+	 * Constructor for a new <code>GroupController</code>.
+	 *
+	 * @param {string} [sId] ID for the new control, generated automatically if no ID is given
+	 * @param {object} [mSettings] Initial settings for the new control
+     * @param {sap.ui.core.Control} mSettings.control The control instance to be personalized by this controller
+	 *
+	 * @class
+	 * The <code>GroupController</code> serves as base class to create sort specific personalization implementations.
+	 *
+	 * @extends sap.ui.base.Object
+	 *
+	 * @author SAP SE
+	 * @version 1.105.0
+	 *
+	 * @public
+	 * @experimental
+	 * @since 1.104
+	 * @alias sap.m.p13n.GroupController
+	 */
+    var GroupController = BaseController.extend("sap.m.p13n.subcontroller.GroupController");
+
+    GroupController.prototype.getStateKey = function () {
+        return "groupLevels";
+    };
+
+    GroupController.prototype.getCurrentState = function(bExternalize) {
+        var oXConfig = xConfigAPI.readConfig(this.getAdaptationControl()) || {};
+        var aSortConditions = oXConfig.hasOwnProperty("properties") ? oXConfig.properties.groupConditions : [];
+
+        return aSortConditions || [];
+    };
+
+    GroupController.prototype.initAdaptationUI = function(oPropertyHelper){
+        var oGroupPanel = new GroupPanel();
+        var oAdaptationData = this.mixInfoAndState(oPropertyHelper);
+		var oAdaptationControl = this.getAdaptationControl();
+
+		if (oAdaptationControl.isA("sap.m.Table")) {
+			oGroupPanel.setQueryLimit(1);
+		}
+
+        oGroupPanel.setP13nData(oAdaptationData.items);
+        this._oPanel = oGroupPanel;
+
+        return Promise.resolve(oGroupPanel);
+    };
+
+    GroupController.prototype.model2State = function() {
+        var aItems = [];
+        this._oPanel.getP13nData(true).forEach(function(oItem){
+            if (oItem.grouped){
+                aItems.push({
+                    key: oItem.key
+                });
+            }
+        });
+        return aItems;
+    };
+
+    GroupController.prototype.getChangeOperations = function () {
+        return {
+            add: "addGroup",
+            remove: "removeGroup",
+            move: "moveGroup"
+        };
+    };
+
+    GroupController.prototype._getPresenceAttribute = function () {
+        return "grouped";
+    };
+
+    GroupController.prototype._createAddRemoveChange = function(oControl, sOperation, oContent){
+        var oAddRemoveChange = {
+            selectorElement: oControl,
+            changeSpecificData: {
+                changeType: sOperation,
+                content: oContent
+            }
+        };
+        return oAddRemoveChange;
+    };
+
+    GroupController.prototype._createMoveChange = function(sId, sPropertykey, iNewIndex, sMoveOperation, oControl, bPersistId){
+        var oMoveChange =  {
+            selectorElement: oControl,
+            changeSpecificData: {
+                changeType: sMoveOperation,
+                content: {
+                    id: sId,
+                    key: sPropertykey,
+                    index: iNewIndex
+                }
+            }
+        };
+
+        if (!bPersistId) {
+            delete oMoveChange.changeSpecificData.content.id;
+        }
+
+        return oMoveChange;
+    };
+
+    GroupController.prototype.mixInfoAndState = function(oPropertyHelper) {
+
+        var aItemState = this.getCurrentState();
+        var mItemState = this.arrayToMap(aItemState);
+        var oController = this.getAdaptationControl();
+        var oAggregations = oController.getAggregateConditions ? oController.getAggregateConditions() || {} : {};
+
+        var oP13nData = this.prepareAdaptationData(oPropertyHelper, function(mItem, oProperty){
+            var oExisting = mItemState[oProperty.key];
+            mItem.grouped = !!oExisting;
+            mItem.position =  oExisting ? oExisting.position : -1;
+            return !(oProperty.groupable === false || oAggregations[oProperty.key]);
+        });
+
+        this.sortP13nData({
+            visible: "grouped",
+            position: "position"
+        }, oP13nData.items);
+
+        oP13nData.presenceAttribute = this._getPresenceAttribute();
+        oP13nData.items.forEach(function(oItem){delete oItem.position;});
+
+        return oP13nData;
+    };
+
+    GroupController.prototype.applyChange = function(aSortState){
+        return Promise.resolve();
+    };
+
+    return GroupController;
+
+});

package/src/sap/m/p13n/GroupPanel.js

@@ -1,5 +1,5 @@
-/*
- * ! OpenUI5
+/*!
+ * OpenUI5
  * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
@@ -21,17 +21,24 @@ sap.ui.define([
 	 * @extends sap.m.p13n.QueryPanel
 	 *
 	 * @author SAP SE
-	 * @version 1.103.0
+	 * @version 1.105.0
 	 *
 	 * @public
-	 * @experimental Since 1.96.
-	 * @since 1.96
+	 * @experimental Since 1.104. Please note that the API of this control is not yet finalized!
 	 * @alias sap.m.p13n.GroupPanel
 	 */
 	var GroupPanel = QueryPanel.extend("sap.m.p13n.GroupPanel", {
 		metadata: {
 			library: "sap.m",
 			properties: {
+				/**
+				 * A short text describing the panel.
+				 * <b>Note:</b> This text will only be displayed if the panel is being used in a <code>sap.m.p13n.Popup</code>.
+				 */
+				title: {
+					type: "string",
+					defaultValue: sap.ui.getCore().getLibraryResourceBundle("sap.m").getText("p13n.DEFAULT_TITLE_GROUP")
+				},
 				/**
 				 * Toggles an additional checkbox in the group panel to define whether items are made visible.
 				 */

package/src/sap/m/p13n/MetadataHelper.js

@@ -0,0 +1,35 @@
+/*!
+ * 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/base/Object"
+], function (BaseObject) {
+	"use strict";
+
+    var MetadataHelper = BaseObject.extend("sap.m.p13n.MetadataHelper", {
+        constructor: function(aProperties) {
+			BaseObject.apply(this, arguments);
+			this._aProperties = aProperties;
+		}
+    });
+
+    MetadataHelper.prototype.getProperties = function() {
+        return this._aProperties;
+    };
+
+    MetadataHelper.prototype.getProperty = function(sKey) {
+        return this._aProperties.find(function(oProp){
+            return oProp.key === sKey;
+        });
+    };
+
+    MetadataHelper.prototype.getPath = function(sKey) {
+        return this.getProperty(sKey).path;
+    };
+
+	return MetadataHelper;
+
+});

package/src/sap/m/p13n/PersistenceProvider.js

@@ -0,0 +1,160 @@
+/*!
+ * 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/Control", 	"sap/ui/fl/variants/VariantManagement", "sap/ui/fl/Utils", "sap/m/p13n/enum/PersistenceMode", "sap/ui/layout/VerticalLayout"
+], function(CoreControl, VariantManagement, Utils, mode, VerticalLayout) {
+	"use strict";
+
+	/**
+	 * The <code>PersistenceProvider</code> control provides certain persistence capabilities, such as transient personalization and global persistence.
+	 * The <code>PersistenceProvider</code> control can be used in a similar way as <code>sap.ui.fl.variants.VariantManagement</code>,
+	 * since any control that is a direct or indirect descendant of the provided <code>for</code> association is affected by this configuration.
+	 * For example, this controller can be used for <code>sap.ui.mdc</code> controls.
+	 *
+	 * @private
+	 *
+	 * @experimental
+	 * @since 1.104
+	*/
+	var PersistenceProvider = CoreControl.extend("sap.m.p13n.PersistenceProvider", /** @lends sap.ui.mdc.p13n.PersistenceProvider.prototype */ {
+		metadata: {
+			library: "sap.m",
+			designtime: "sap/ui/mdc/designtime/p13n/PersistenceProvider.designtime",
+			properties:  {
+				/**
+				 * Provides the mode setting for the <code>PersistenceProvider</code>.
+				 * Allowed options are {@link sap.ui.mdc.enum.PersistenceMode}
+				 */
+				mode: {
+					type: "sap.m.p13n.enum.PersistenceMode",
+					group: "Data",
+					defaultValue: mode.Auto
+				}
+			},
+			associations: {
+				/**
+				 * Contains the controls for which the variant management is responsible.
+				 */
+				"for": {
+					type: "sap.ui.core.Control",
+					multiple: true
+				}
+			}
+		},
+		renderer: {
+			apiVersion: 2,
+			render: function(oRm, oControl) {
+				oRm.openStart("div", oControl);
+				oRm.openEnd();
+				oRm.close("div");
+			}
+		}
+	});
+
+	PersistenceProvider.prototype.init = function () {
+		CoreControl.prototype.init.apply(this, arguments);
+		this.attachModelContextChange(this._setModel, this);
+
+		this._oModelPromise = new Promise(function (resolve, reject) {
+			this._fnResolveModel = resolve;
+		}.bind(this));
+	};
+
+	PersistenceProvider.prototype._setModel = function () {
+
+		var oModel = this.getModel(Utils.VARIANT_MODEL_NAME);
+		if (oModel) {
+			this._fnResolveModel(oModel);
+		}
+	};
+
+	PersistenceProvider.prototype.applySettings = function () {
+		CoreControl.prototype.applySettings.apply(this, arguments);
+		this._bmodeLocked = true;
+
+		if (this.getMode() === mode.Transient) {
+			var oVM = new VariantManagement(this.getId() + "--vm", {"for": this.getAssociation("for")});
+			this._oModelPromise.then(function (oModel) {
+				oVM.setModel(oModel, Utils.VARIANT_MODEL_NAME);
+			});
+			this._oWrapper = new VerticalLayout(this.getId() + "--accWrapper", {
+				visible: true,
+				content: [
+					oVM
+				]
+			});
+
+			this._oWrapper.onAfterRendering = function() {
+				VerticalLayout.prototype.onAfterRendering.apply(this, arguments);
+				this.getDomRef().setAttribute("aria-hidden", true);
+			};
+
+			var oStatic = sap.ui.getCore().getUIArea(sap.ui.getCore().getStaticAreaRef());
+			oStatic.addContent(this._oWrapper);
+		}
+
+		return this;
+	};
+
+	PersistenceProvider.prototype.addFor = function (sControlId) {
+		this.addAssociation("for", sControlId);
+
+		var oVM = sap.ui.getCore().byId(this.getId() + "--vm");
+		if (this.getMode() === mode.Transient && oVM) {
+			oVM.addFor(sControlId);
+		}
+
+		return this;
+	};
+
+	PersistenceProvider.prototype.removeFor = function (sControlId) {
+		this.removeAssociation("for", sControlId);
+
+		var oVM = sap.ui.getCore().byId(this.getId() + "--vm");
+		if (this.getMode() === mode.Transient && oVM) {
+			oVM.removeFor(sControlId);
+		}
+
+		return this;
+	};
+
+	/**
+	 * Set the mode for the <code>PersistenceProvider</code>.
+	 *
+	 * @override
+	 * @private
+	 * @ui5-restricted sap.fe
+	 * @MDC_PUBLIC_CANDIDATE
+	 */
+	PersistenceProvider.prototype.setMode = function (sValue) {
+
+		if (this._bmodeLocked && sValue !== this.getMode()) {
+			throw new Error("mode is a final property.");
+		}
+
+		this.setProperty("mode", sValue);
+
+		return this;
+	};
+
+	PersistenceProvider.prototype.exit = function () {
+		if (this._oWrapper) {
+			var oStatic = sap.ui.getCore().getUIArea(sap.ui.getCore().getStaticAreaRef());
+			oStatic.removeContent(this._oWrapper);
+
+			this._oWrapper.destroy();
+			this._oWrapper = null;
+		}
+
+		this._oModelPromise = null;
+		this._fnResolveModel = null;
+		this._bmodeLocked = null;
+
+		CoreControl.prototype.exit.apply(this, arguments);
+	};
+
+	return PersistenceProvider;
+});

package/src/sap/m/p13n/Popup.js

@@ -1,8 +1,8 @@
-/*
-* ! OpenUI5
+/*!
+ * 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/Control",
 	"sap/m/Button",
@@ -34,7 +34,7 @@ sap.ui.define([
 	 * @extends sap.ui.core.Control
 	 *
 	 * @author SAP SE
-	 * @version 1.103.0
+	 * @version 1.105.0
 	 *
 	 * @public
 	 * @experimental Since 1.97.
@@ -149,6 +149,22 @@ sap.ui.define([
 		return this;
 	};
 
+	/**
+	 * Set the reset functionality callback
+	 * <b>Note:</b> The Reset button will only be shown in case this callback is provided.
+	 *
+	 * @param {function} fnReset callback that will be executed once a reset has been triggered.
+	 * @returns {sap.m.p13n.Popup} The <code>Popup</code> instance
+	 */
+	Popup.prototype.setReset = function(fnReset) {
+		if (this._oPopup) {
+			this._oPopup.setCustomHeader(this._createTitle());
+			this._oPopup.invalidate();
+		}
+		this.setProperty("reset", fnReset);
+		return this;
+	};
+
 	/**
 	 * Opens the <code>Popup</code> control.
 	 *
@@ -184,9 +200,10 @@ sap.ui.define([
 	 *
 	 * @public
 	 * @param {sap.m.p13n.IContent} oPanel The panel instance
+	 * @param {string} [sKey] Optional key to be used for the panel registration instead of using the id
 	 * @returns {sap.m.p13n.Popup} The popup instance
 	 */
-	Popup.prototype.addPanel = function(oPanel) {
+	Popup.prototype.addPanel = function(oPanel, sKey) {
 		var oPanelTitleBindingInfo = oPanel.getBindingInfo("title"), oBindingInfo;
 		if (oPanelTitleBindingInfo && oPanelTitleBindingInfo.parts) {
 			oBindingInfo = {
@@ -194,8 +211,8 @@ sap.ui.define([
 			};
 		}
 		this._getContainer().addView(new AbstractContainerItem({
-			key: oPanel.getId(),
-			text: oBindingInfo || oPanel.getTitle(), //oBindinfInfo is undefined in case no binding is provided
+			key: sKey || oPanel.getId(),
+			text: oBindingInfo || (oPanel.getTitle instanceof Function ? oPanel.getTitle() : undefined), //oBindinfInfo is undefined in case no binding is provided
 			content: oPanel
 		}));
 		this._aPanels.push(oPanel);
@@ -211,10 +228,19 @@ sap.ui.define([
 	 */
 	Popup.prototype.removePanel = function(oPanel) {
 		this._aPanels.splice(this._aPanels.indexOf(oPanel), 1);
-		this._getContainer().removeView(this._getContainer().getView(oPanel.getId()));
+		this._getContainer().removeView(this._getContainer().getView(oPanel));
 		return this;
 	};
 
+	/**
+	 * Removes all panels from the <code>panels</code> aggregation
+	 */
+	Popup.prototype.removeAllPanels = function() {
+		this.getPanels().forEach(function(oPanel){
+			this.removePanel(oPanel);
+		}.bind(this));
+	};
+
 	/**
 	 * Removes the current panels in the <code>panels</code> aggregation.
 	 * @public
@@ -226,7 +252,12 @@ sap.ui.define([
 
 	Popup.prototype._createContainer = function(mDialogSettings) {
 		mDialogSettings = mDialogSettings ? mDialogSettings : {};
-		return this["_create" + this.getMode()].call(this, mDialogSettings);
+		var oPopup = this["_create" + this.getMode()].call(this, mDialogSettings);
+		oPopup.addStyleClass("sapMP13nPopup");
+		oPopup.isPopupAdaptationAllowed = function () {
+			return false;
+		};
+		return oPopup;
 	};
 
 	Popup.prototype._createResponsivePopover = function(mDialogSettings) {
@@ -239,7 +270,10 @@ sap.ui.define([
 			resizable: mDialogSettings.hasOwnProperty("resizable") ? mDialogSettings.resizable : true,
 			contentHeight: mDialogSettings.contentHeight ? mDialogSettings.contentHeight : "35rem",
 			placement: mDialogSettings.placement ? mDialogSettings.placement : "Bottom",
-			content: this._getContainer()
+			content: this.getPanels().length > 1 ? this._getContainer() : this.getPanels()[0],
+			afterClose: function() {
+				this._onClose(oPopover, "AutoClose");
+			}.bind(this)
 		});
 
 		oPopover.setCustomHeader(this._createTitle());
@@ -260,7 +294,10 @@ sap.ui.define([
 			draggable: true,
 			resizable: true,
 			stretch: Device.system.phone,
-			content: this._getContainer(),
+			content: this.getPanels().length > 1 ? this._getContainer() : this.getPanels()[0],
+			escapeHandler: function() {
+				this._onClose(oContainer, "Escape");
+			},
 			buttons: [
 				new Button(this.getId() + "-confirmBtn", {
 					text:  mDialogSettings.confirm && mDialogSettings.confirm.text ?  mDialogSettings.confirm.text : oResourceBundle.getText("p13n.POPUP_OK"),
@@ -295,7 +332,7 @@ sap.ui.define([
 
 		var oBar;
 
-		if (fnReset) {
+		if (fnReset instanceof Function) {
 
 			oBar = new Bar({
 				contentLeft: [

package/src/sap/m/p13n/QueryPanel.js

@@ -1,5 +1,5 @@
-/*
- * ! OpenUI5
+/*!
+ * OpenUI5
  * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
@@ -24,7 +24,7 @@ sap.ui.define([
 	 * @extends sap.m.p13n.BasePanel
 	 *
 	 * @author SAP SE
-	 * @version 1.103.0
+	 * @version 1.105.0
 	 *
 	 * @private
 	 * @ui5-restricted