@openui5/sap.m 1.104.0 → 1.105.0

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

@@ -81,6 +81,7 @@ sap.ui.define([
 				oVM.setModel(oModel, Utils.VARIANT_MODEL_NAME);
 			});
 			this._oWrapper = new VerticalLayout(this.getId() + "--accWrapper", {
+				visible: true,
 				content: [
 					oVM
 				]
@@ -98,19 +99,43 @@ sap.ui.define([
 		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 (bValue) {
+	PersistenceProvider.prototype.setMode = function (sValue) {
 
-		if (this._bmodeLocked && bValue !== this.getMode()) {
+		if (this._bmodeLocked && sValue !== this.getMode()) {
 			throw new Error("mode is a final property.");
 		}
 
-		this.setProperty("mode", bValue);
+		this.setProperty("mode", sValue);
 
 		return this;
 	};

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.104.0
+	 * @version 1.105.0
 	 *
 	 * @public
 	 * @experimental Since 1.97.

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.104.0
+	 * @version 1.105.0
 	 *
 	 * @private
 	 * @ui5-restricted

package/src/sap/m/p13n/SelectionController.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.
  */
@@ -9,10 +9,9 @@ sap.ui.define([
     'sap/ui/base/Object',
     'sap/base/util/merge',
     'sap/base/util/deepEqual',
-    'sap/ui/model/json/JSONModel',
     'sap/m/p13n/SelectionPanel',
     'sap/m/p13n/modules/xConfigAPI'
-], function (diff, BaseObject, merge, deepEqual, JSONModel, SelectionPanel, xConfigAPI) {
+], function (diff, BaseObject, merge, deepEqual, SelectionPanel, xConfigAPI) {
 	"use strict";
 
     /**
@@ -29,7 +28,7 @@ sap.ui.define([
 	 * @extends sap.ui.base.Object
 	 *
 	 * @author SAP SE
-	 * @version 1.104.0
+	 * @version 1.105.0
 	 *
 	 * @public
 	 * @experimental Since 1.104. Please note that the API of this control is not yet finalized!
@@ -39,12 +38,19 @@ sap.ui.define([
         constructor: function(mSettings) {
             BaseObject.call(this);
 
+            this._oAdaptationControl = mSettings.control;
+
+            if (!this._oAdaptationControl) {
+                throw new Error("Always provide atleast a 'control' configuration when creating a new p13n controller!");
+            }
+
             this._sTargetAggregation = mSettings.targetAggregation;
             this._fSelector = mSettings.selector;
-            this._oAdaptationControl = mSettings.control;
+
             this._oP13nData = null;
             this._bLiveMode = false;
             this._bResetEnabled = false;
+            this._bReorderingEnabled = mSettings.hasOwnProperty("enableReorder") ? mSettings.enableReorder : true;
 
         }
     });
@@ -97,20 +103,17 @@ sap.ui.define([
      */
     SelectionController.prototype.initAdaptationUI = function(oPropertyHelper){
         var oAdaptationData = this.mixInfoAndState(oPropertyHelper);
-        return this.retrieveUI(oAdaptationData)
-        .then(function(oSelectionPanel){
-            this._oPanel = oSelectionPanel;
-            return Promise.resolve(oSelectionPanel);
-        }.bind(this));
+        this._oPanel = this.createUI(oAdaptationData);
+        return Promise.resolve(this._oPanel);
     };
 
-    SelectionController.prototype.retrieveUI = function(oAdaptationData) {
+    SelectionController.prototype.createUI = function(oAdaptationData) {
         var oSelectionPanel = new SelectionPanel({
             showHeader: true,
             enableCount: true
         });
-        oSelectionPanel.setP13nData(oAdaptationData.items);
-        return Promise.resolve(oSelectionPanel);
+        oSelectionPanel.setEnableReorder(this._bReorderingEnabled);
+        return oSelectionPanel.setP13nData(oAdaptationData.items);
     };
 
     SelectionController.prototype.getCurrentState = function(){
@@ -131,14 +134,16 @@ sap.ui.define([
             var aStateKeys = aState.map(function(o){return o.key;});
             var iCurrentIndex = aStateKeys.indexOf(sKey);
             var iNewIndex = oItemXConfig[sKey].position;
+            var bVisible = oItemXConfig[sKey].visible !== false;
+            var bReordered = iNewIndex !== undefined;
 
-            if (oItemXConfig[sKey].visible === true && iCurrentIndex === -1) {
+            if (bVisible && iCurrentIndex === -1) {
                 aState.push({
                     key: sKey
                 });
             }
 
-            if (iNewIndex !== undefined && aState.length > 0) {
+            if (bVisible && bReordered && aState.length > 0) {
                 var oItem = aState.splice(iCurrentIndex, 1)[0];
                 aState.splice(iNewIndex, 0, oItem);
                 iCurrentIndex = iNewIndex;
@@ -424,26 +429,6 @@ sap.ui.define([
 		return aNewItemsPrepared;
 	};
 
-    /**
-     *
-     * Getter for the personalization model
-     *
-     * @param {sap.ui.mdc.util.PropertyHelper} oPropertyHelper The property helper instance
-     * @returns {sap.ui.model.json.JSONModel} The personalization model.
-     *
-     */
-    SelectionController.prototype._getP13nModel = function(oPropertyHelper) {
-        if (!this._oAdaptationModel) {
-            this._oAdaptationModel = new JSONModel(this.mixInfoAndState(oPropertyHelper));
-            this._oP13nData = this._oAdaptationModel.getData();
-            this._oAdaptationModel.setSizeLimit(10000);
-        } else {
-            this.update(oPropertyHelper);
-        }
-
-        return this._oAdaptationModel;
-    };
-
     SelectionController.prototype.changesToState = function(aChanges) {
 
         var aState = [];

package/src/sap/m/p13n/SelectionPanel.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.
  */
@@ -48,7 +48,7 @@ sap.ui.define([
 	 * @extends sap.m.p13n.BasePanel
 	 *
 	 * @author SAP SE
-	 * @version 1.104.0
+	 * @version 1.105.0
 	 *
 	 * @public
 	 * @experimental Since 1.96.

package/src/sap/m/p13n/SortController.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.
  */
@@ -22,7 +22,7 @@ sap.ui.define([
 	 * @extends sap.ui.base.Object
 	 *
 	 * @author SAP SE
-	 * @version 1.104.0
+	 * @version 1.105.0
 	 *
 	 * @public
 	 * @experimental Since 1.104. Please note that the API of this control is not yet finalized!

package/src/sap/m/p13n/SortPanel.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,7 +21,7 @@ sap.ui.define([
 	 * @extends sap.m.p13n.QueryPanel
 	 *
 	 * @author SAP SE
-	 * @version 1.104.0
+	 * @version 1.105.0
 	 *
 	 * @public
 	 * @experimental Since 1.96.

package/src/sap/m/p13n/handler/xConfigHandler.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.
  */

package/src/sap/m/p13n/modification/FlexModificationHandler.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([
     "./ModificationHandler",
     "sap/m/p13n/FlexUtil",

package/src/sap/m/p13n/modification/LocalStorageModificationHandler.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/m/p13n/modification/ModificationHandler"
 ], function(Modificationhandler) {

package/src/sap/m/p13n/modification/ModificationHandler.js

@@ -1,13 +1,12 @@
-/*
-* ! 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/base/Object",
-	"sap/base/util/merge",
 	"sap/ui/core/util/reflection/JsControlTreeModifier"
-], function(BaseObject, merge, JsControlTreeModifier) {
+], function(BaseObject, JsControlTreeModifier) {
 	"use strict";
 
 	var oModificationHandler;
@@ -23,6 +22,8 @@ sap.ui.define([
 	 */
 	var ModificationHandler = BaseObject.extend("sap.m.p13n.modification.ModificationHandler");
 
+	var mInitialState = new WeakMap();
+
 	/**
 	 * Should implement the appliance of changes
 	 *
@@ -102,7 +103,20 @@ sap.ui.define([
 	 * @returns {Promise} Returns a <code>Promise</code> reflecting the reset execution
 	 */
 	ModificationHandler.prototype.reset = function(mPropertyBag, oModificationPayload) {
-		return Promise.resolve();
+		var oControl = mPropertyBag.selector;
+		return sap.m.p13n.Engine.getInstance().applyState(oControl, mInitialState.get(oControl), true);
+	};
+
+	ModificationHandler.prototype.initialize = function(oControl) {
+		var pInitial, oInitialState;
+
+		pInitial = sap.m.p13n.Engine.getInstance().retrieveState(oControl)
+		.then(function(oRetrievedState){
+			oInitialState = oRetrievedState;
+			mInitialState.set(oControl, oInitialState);
+		});
+
+		return pInitial;
 	};
 
 	/**
@@ -118,10 +132,6 @@ sap.ui.define([
 		return false;
 	};
 
-	ModificationHandler.prototype.initialize = function(oControl) {
-		return Promise.resolve();
-	};
-
 	ModificationHandler.getInstance = function() {
 		if (!oModificationHandler){
 			oModificationHandler = new ModificationHandler();

package/src/sap/m/p13n/modules/AdaptationProvider.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/base/Object"
 ], function(BaseObject) {

package/src/sap/m/p13n/modules/DefaultProviderRegistry.js

@@ -1,13 +1,14 @@
-/*
- * ! 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/base/Object",
-	"sap/m/p13n/PersistenceProvider"
-], function (BaseObject, PersistenceProvider) {
+	"sap/m/p13n/PersistenceProvider",
+	"sap/ui/fl/Utils"
+], function (BaseObject, PersistenceProvider, FLUtils) {
 	"use strict";
 
 	var ERROR_INSTANCING = "DefaultProviderRegistry: This class is a singleton and should not be used without an AdaptationProvider. Please use 'sap.m.p13n.Engine.getInstance().defaultProviderRegistry' instead";
@@ -25,14 +26,14 @@ sap.ui.define([
 	 * @extends sap.ui.base.Object
 	 *
 	 * @author SAP SE
-	 * @version 1.104.0
+	 * @version 1.105.0
 	 *
 	 * @private
 	 * @since 1.104
 	 * @alias sap.m.p13n.modules.DefaultProviderRegistry
 	 */
 	var DefaultProviderRegistry = BaseObject.extend("sap.m.p13n.modules.DefaultProviderRegistry", {
-		constructor: function() {
+		constructor: function(oEngine) {
 
 			if (oDefaultProviderRegistry) {
 				throw Error(ERROR_INSTANCING);
@@ -40,6 +41,7 @@ sap.ui.define([
 
 			BaseObject.call(this);
 			this._mDefaultProviders = {};
+			this._oEngine = oEngine;
 		}
 	});
 
@@ -52,6 +54,8 @@ sap.ui.define([
 			this._mDefaultProviders[sProviderName].destroy();
 			delete this._mDefaultProviders[sProviderName];
 		}.bind(this));
+		this._oEngine = null;
+		oDefaultProviderRegistry = null;
 		BaseObject.prototype.destroy.apply(this, arguments);
 	};
 
@@ -61,18 +65,20 @@ sap.ui.define([
 	 *
 	 * Attaches a control to a default persistence provider held inside the DefaultProviderRegistry for the given <code>PersistenceMode</code>
 	 *
-	 * @param {sap.m.Control|string} vControl The control instance or a control id.
+	 * @param {sap.ui.core.Control|string} vElement The control instance or a control id.
 	 * @param {sap.m.enum.PersistenceMode} sPersistenceMode Desired persistence mode for the retrieved persistence provider
 	 * @returns {sap.m.p13n.PersistenceProvider} Returns a persistence provider instance, if possible
 	 */
-	DefaultProviderRegistry.prototype.attach = function (vControl, sPersistenceMode) {
-		if (vControl.getEngine().isRegisteredForModification(vControl)) { // Modification settings for a registered control are only determined once in the Engine
-			throw new Error("DefaultProviderRegistry: You must not change the modificationSettings for an already registered control");
+	 DefaultProviderRegistry.prototype.attach = function (vElement, sPersistenceMode) {
+		if (this._oEngine.isRegisteredForModification(vElement)) { // Modification settings for a registered element are only determined once in the Engine
+			throw new Error("DefaultProviderRegistry: You must not change the modificationSettings for an already registered element");
 		}
-		var oDefaultProvider = this._retrieveDefaultProvider(sPersistenceMode);
-		var sControlId = typeof vControl === "string" ? vControl : vControl.getId();
-		if (oDefaultProvider.getFor().indexOf(sControlId) === -1) {
-			oDefaultProvider.addFor(vControl);
+
+		var oElement = typeof vElement === "string" ? sap.ui.getCore().byId(vElement) : vElement, sElementId = typeof vElement === "string" ? vElement : vElement.getId();
+		var oDefaultProvider = this._retrieveDefaultProvider(oElement, sPersistenceMode);
+
+		if (oDefaultProvider.getFor().indexOf(sElementId) === -1) {
+			oDefaultProvider.addFor(vElement);
 		}
 
 		return oDefaultProvider;
@@ -84,7 +90,7 @@ sap.ui.define([
 	 *
 	 * Detaches a control from any existing default persistence provider
 	 *
-	 * @param {sap.m.Control|string} vControl The control instance or a control id.
+	 * @param {sap.ui.core.Control|string} vControl The control instance or a control id.
 	 */
 	DefaultProviderRegistry.prototype.detach = function (vControl) {
 		Object.keys(this._mDefaultProviders).forEach(function (sMode) {
@@ -95,15 +101,32 @@ sap.ui.define([
 
 	/**
 	 * @private
-	 * @ui5-restricted sap.m
+	 * @ui5-restricted sap.ui.mdc
 	 *
 	 * Returns a promise resolving a default persistence provider for the given <code>Control</code> and <code>PersistenceMode</code>.
-	 *
-	 * @param {sap.m.enum.PersistenceMode} sPersistenceMode Desired persistence mode for the retrieved persistence provider
+	 * @param {sap.ui.core.Element} oElement The element instance.
+	 * @param {sap.ui.mdc.enum.PersistenceMode} sPersistenceMode Desired persistence mode for the retrieved persistence provider
 	 * @returns {Promise} Returns a <code>Promise</code> returning a persistence provider instance, if possible
 	 */
-	DefaultProviderRegistry.prototype._retrieveDefaultProvider = function (sPersistenceMode) {
-		this._mDefaultProviders[sPersistenceMode] = this._mDefaultProviders[sPersistenceMode] || new PersistenceProvider({mode: sPersistenceMode});
+	 DefaultProviderRegistry.prototype._retrieveDefaultProvider = function (oElement, sPersistenceMode) {
+
+		if (!this._mDefaultProviders[sPersistenceMode]) {
+			var oProvider = new PersistenceProvider("defaultProviderRegistry" + sPersistenceMode, {
+				mode: sPersistenceMode
+			});
+
+			var fnAttachVariantModel = function(){
+				var oModel = oElement.getModel(FLUtils.VARIANT_MODEL_NAME);
+				if (oModel) {
+					oProvider.setModel(oModel, FLUtils.VARIANT_MODEL_NAME);
+					oElement.detachEvent("modelContextChange", fnAttachVariantModel);
+				}
+			};
+
+			oElement.attachEvent("modelContextChange", fnAttachVariantModel);
+			this._mDefaultProviders[sPersistenceMode] = oProvider;
+		}
+
 		return this._mDefaultProviders[sPersistenceMode];
 	};
 
@@ -113,9 +136,9 @@ sap.ui.define([
 	 *
 	 * This method is the central point of access to the DefaultProviderRegistry Singleton.
 	 */
-	 DefaultProviderRegistry.getInstance = function() {
+	 DefaultProviderRegistry.getInstance = function(Engine) {
 		if (!oDefaultProviderRegistry) {
-			oDefaultProviderRegistry = new DefaultProviderRegistry();
+			oDefaultProviderRegistry = new DefaultProviderRegistry(Engine);
 		}
 		return oDefaultProviderRegistry;
 	};

package/src/sap/m/p13n/modules/StateHandlerRegistry.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,7 +21,7 @@ sap.ui.define([
 	 * @extends sap.ui.base.Object
 	 *
 	 * @author SAP SE
-	 * @version 1.104.0
+	 * @version 1.105.0
 	 *
 	 * @private
 	 * @since 1.104
@@ -72,7 +72,7 @@ sap.ui.define([
 	 *
 	 * Fires an {@link sap.ui.base.Event event} with the given settings and notifies all attached event handlers.
 	 *
-	 * @param {sap.m.Control} oControl The control instance
+	 * @param {sap.ui.core.Control} oControl The control instance
 	 * @param {object} oState The updated state
 	 * @returns {this} Returns <code>this</code> to allow method chaining
 	 */

package/src/sap/m/p13n/modules/UIManager.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.
  */
@@ -28,7 +28,7 @@ sap.ui.define([
 	 * @extends sap.ui.base.Object
 	 *
 	 * @author SAP SE
-	 * @version 1.104.0
+	 * @version 1.105.0
 	 *
 	 * @private
 	 *

package/src/sap/m/p13n/modules/xConfigAPI.js

@@ -1,6 +1,8 @@
-/*
-* ! {copyright}
-*/
+/*!
+ * 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/base/util/merge",
 	"sap/ui/core/util/reflection/JsControlTreeModifier"