@openui5/sap.ui.mdc 1.97.1 → 1.99.1

package/src/sap/ui/mdc/p13n/Engine.js

@@ -40,7 +40,7 @@ sap.ui.define([
 	 * @extends sap.ui.base.Object
 	 *
 	 * @author SAP SE
-	 * @version 1.97.1
+	 * @version 1.99.1
 	 *
 	 * @private
 	 * @ui5-restricted sap.ui.mdc
@@ -192,7 +192,7 @@ sap.ui.define([
 		return this.initAdaptation(vControl, sKey).then(function(){
 
 			var oController = this.getController(vControl, sKey);
-			var mchangeOperations = oController.getChangeOperations();
+			var mChangeOperations = oController.getChangeOperations();
 
 			var oRegistryEntry = this._getRegistryEntry(vControl);
 			var oCurrentState = oController.getCurrentState();
@@ -203,7 +203,7 @@ sap.ui.define([
 				applyAbsolute: bApplyAbsolute,
 				changedState: aNewState,
 				control: oController.getAdaptationControl(),
-				changeOperations: mchangeOperations,
+				changeOperations: mChangeOperations,
 				deltaAttributes: ["name"],
 				propertyInfo: oRegistryEntry.helper.getProperties().map(function(a){return {name: a.name};})
 			};
@@ -235,7 +235,14 @@ sap.ui.define([
 
 		aKeys = aKeys instanceof Array ? aKeys : [aKeys];
 
+		var aSelectors = [];
+
+		aKeys.forEach(function(sKey) {
+			aSelectors = aSelectors.concat(this.getController(oControl, sKey).getSelectorForReset());
+		}.bind(this));
+
 		var oResetConfig = {
+			selectors: aSelectors,
 			selector: oControl
 		};
 
@@ -293,7 +300,11 @@ sap.ui.define([
 			var oModificationSetting = this._determineModification(vControl);
 			return oModificationSetting.handler.processChanges(aChanges, oModificationSetting.payload)
 			.then(function(aChanges){
-				this.stateHandlerRegistry.fireChange(Engine.getControlInstance(vControl));
+				var oControl = Engine.getControlInstance(vControl);
+				this.stateHandlerRegistry.fireChange(oControl);
+				if (oControl._onChangeAppliance instanceof Function) {
+					oControl._onChangeAppliance.call(oControl);
+				}
 				return aChanges;
 			}.bind(this));
 		} else {
@@ -318,9 +329,10 @@ sap.ui.define([
 		var fResolveRTA;
 
 		//var aVMs = Engine.hasForReference(oControl, "sap.ui.fl.variants.VariantManagement");
+		// TODO: clarify if we need this error handling / what to do with the Link if we want to keep it
 		var aPVs = Engine.hasForReference(oControl, "sap.ui.mdc.p13n.PersistenceProvider");
 
-		if (aPVs.length > 0) {
+		if (aPVs.length > 0 && !oControl.isA("sap.ui.mdc.link.Panel")) {
 			return Promise.reject("Please do not use a PeristenceProvider in RTA.");
 		}
 
@@ -344,6 +356,9 @@ sap.ui.define([
 				oCustomHeader.getContentRight()[0].setVisible(false);
 			}
 			oContainer.addStyleClass(mPropertyBag.styleClass);
+			if (mPropertyBag.fnAfterClose instanceof Function) {
+				oContainer.attachAfterClose(mPropertyBag.fnAfterClose);
+			}
 		});
 
 		oRTAPromise.then(function(){
@@ -613,7 +628,8 @@ sap.ui.define([
 	 *
 	 * @returns {object} The requested UI settings of the control instance and provided keys
 	 */
-	Engine.prototype.getUISettings = function(vControl, aKeys) {
+	Engine.prototype.getUISettings = function(vControl, vKeys) {
+		var aKeys = Array.isArray(vKeys) ? vKeys : [vKeys];
 		this.verifyController(vControl, aKeys);
 		var oPropertyHelper = this._getRegistryEntry(vControl).helper;
 		var mUiSettings = {};
@@ -622,6 +638,8 @@ sap.ui.define([
 			var oController = this.getController(vControl, sKey);
 			var pAdaptationUI = oController.getAdaptationUI(oPropertyHelper);
 			//Check faceless controller implementations and skip them
+
+			//TODO: error handling for non promises
 			if (pAdaptationUI instanceof Promise){
 				mUiSettings[sKey] = {};
 				mUiSettings[sKey] = {
@@ -792,8 +810,8 @@ sap.ui.define([
 	 * Determines and registeres the ModificationHandler per control instance
 	 *
 	 * @private
-	 * @param {String} sControlId The control id
-	 * @param {String} sAncestorControlId The control ancestor id
+	 * @param {string} sControlId The control id
+	 * @param {string} sAncestorControlId The control ancestor id
 	 *
 	 * @returns {boolean} Returns whether an according ancestor could be found.
 	 */
@@ -969,27 +987,27 @@ sap.ui.define([
 	 * @param {object[]} [aCustomPropertyInfo] A custom set of propertyinfo.
 	 *
 	 */
-	Engine.prototype._retrievePropertyHelper = function(vControl, aCustomPropertyInfo){
+	Engine.prototype._retrievePropertyHelper = function (vControl, aCustomPropertyInfo) {
 
 		var oRegistryEntry = this._getRegistryEntry(vControl);
 		var oControl = Engine.getControlInstance(vControl);
 
 		if (aCustomPropertyInfo) {
-			if (oRegistryEntry.helper){
+			if (oRegistryEntry.helper) {
 				oRegistryEntry.helper.destroy();
 			}
 			oRegistryEntry.helper = new PropertyHelper(aCustomPropertyInfo);
 			return Promise.resolve(oRegistryEntry.helper);
-        }
+		}
 
 		if (oRegistryEntry.helper) {
 			return Promise.resolve(oRegistryEntry.helper);
 		}
 
-		return oControl.initPropertyHelper().then(function(oPropertyHelper){
+		return oControl.initPropertyHelper().then(function (oPropertyHelper) {
 			oRegistryEntry.helper = oPropertyHelper;
 			return oPropertyHelper;
-		}, function(sHelperError){
+		}, function (sHelperError) {
 			throw new Error(sHelperError);
 		});
 	};

package/src/sap/ui/mdc/p13n/FlexUtil.js

@@ -10,101 +10,6 @@ sap.ui.define([
 
 	var FlexUtil = {
 
-		/**
-		* Generates a set of changes based on the given arrays for a specified control
-		*
-		* @public
-		*
-		* @param {object} mDeltaInfo Map containing the necessary information to calculate the diff as change objects
-		* @param {array} mDeltaInfo.existingState An array describing the control state before a adaptation
-		* @param {array} mDeltaInfo.changedState An array describing the control state after a certain adaptation
-		* @param {object} mDeltaInfo.control Control instance which is being used to generate the changes
-		* @param {object} mDeltaInfo.changeOperations Map containing the changeOperations for the given Control instance
-		* @param {string} mDeltaInfo.changeOperations.add Name of the control specific 'add' changehandler
-		* @param {string} mDeltaInfo.changeOperations.remove Name of the control specific 'remove' changehandler
-		* @param {string} [mDeltaInfo.changeOperations.move] Name of the control specific 'move' changehandler
-		* @param {string} [mDeltaInfo.generator] Name of the change generator (E.g. the namespace of the UI creating the change object)
-		*
-		* @returns {array} Array containing the delta based created changes
-		*/
-		getArrayDeltaChanges: function (mDeltaInfo) {
-
-			var aExistingArray = mDeltaInfo.existingState;
-			var aChangedArray = mDeltaInfo.changedState;
-			var oControl = mDeltaInfo.control;
-			var sInsertOperation = mDeltaInfo.changeOperations.add;
-			var sRemoveOperation = mDeltaInfo.changeOperations.remove;
-			var sMoveOperation = mDeltaInfo.changeOperations.move;
-			var sGenerator = mDeltaInfo.generator;
-
-			var aDeltaAttributes = mDeltaInfo.deltaAttributes || [];
-
-			var fnSymbol = function(o) {
-				var sDiff = "";
-				aDeltaAttributes.forEach(function(sAttribute){
-					sDiff = sDiff + o[sAttribute];
-				});
-				return sDiff;
-			};
-
-			var aResults = diff(aExistingArray, aChangedArray, fnSymbol);
-			// Function to match field with exising field in the given array
-			var fMatch = function (oField, aArray) {
-				return aArray.filter(function (oExistingField) {
-					return oExistingField && (oExistingField.name === oField.name);
-				})[0];
-			};
-
-			var aChanges = [];
-			var aProcessedArray = aExistingArray.slice(0);
-
-			aResults.forEach(function (oResult) {
-				// Begin --> hack for handling result returned by diff
-				if (oResult.type === "delete" && aProcessedArray[oResult.index] === undefined) {
-					aProcessedArray.splice(oResult.index, 1);
-					return;
-				}
-
-				var oProp, oExistingProp, iLength;
-				if (oResult.type === "insert") {
-					oExistingProp = fMatch(aChangedArray[oResult.index], aProcessedArray);
-					if (oExistingProp) {
-						oExistingProp.index = aProcessedArray.indexOf(oExistingProp);
-						aProcessedArray.splice(oExistingProp.index, 1, undefined);
-						aChanges.push(FlexUtil.createAddRemoveChange(oControl, sRemoveOperation, FlexUtil._getChangeContent(oExistingProp, aDeltaAttributes), sGenerator));
-					}
-				}
-				// End hack
-				oProp = oResult.type === "delete" ? aProcessedArray[oResult.index] : aChangedArray[oResult.index];
-				oProp.index = oResult.index;
-				if (oResult.type === "delete") {
-					aProcessedArray.splice(oProp.index, 1);
-				} else {
-					aProcessedArray.splice(oProp.index, 0, oProp);
-				}
-				// Move operation shows up as insert followed by delete OR delete followed by insert
-				if (sMoveOperation) {
-					iLength = aChanges.length;
-					// Get the last added change
-					if (iLength) {
-						oExistingProp = aChanges[iLength - 1];
-						oExistingProp = oExistingProp ? oExistingProp.changeSpecificData.content : undefined;
-					}
-					// Matching property exists with a different index --> then this is a move operation
-					if (oExistingProp && oExistingProp.name === oProp.name && oResult.index != oExistingProp.index) {
-						// remove the last insert/delete operation
-						aChanges.pop();
-						aChanges.push(FlexUtil.createMoveChange(oExistingProp.id, oExistingProp.name, oResult.index, sMoveOperation, oControl, sMoveOperation !== "moveSort", sGenerator));
-						return;
-					}
-				}
-
-				aChanges.push(FlexUtil.createAddRemoveChange(oControl, oResult.type === "delete" ? sRemoveOperation : sInsertOperation, FlexUtil._getChangeContent(oProp, aDeltaAttributes), sGenerator));
-
-			});
-			return aChanges;
-		},
-
 		getPropertySetterChanges: function(mDeltaInfo) {
 			var oControl = mDeltaInfo.control;
 			var aExistingState = mDeltaInfo.existingState;
@@ -124,7 +29,7 @@ sap.ui.define([
 					var vNewValue = oItem[sSetAttribute];
 					var bValueChanged = vOldValue !== vNewValue;
 					if (bValueChanged) {
-						aSetterChanges.push(this.createAddRemoveChange(oControl, sOperation, {
+						aSetterChanges.push(this.createChange(oControl, sOperation, {
 							name: oItem.name,
 							value: oItem[sSetAttribute]
 						}));
@@ -193,7 +98,14 @@ sap.ui.define([
 					Log.warning("property '" + sFieldPath + "' not supported");
 					continue;
 				}
-				aConditionChanges = aConditionChanges.concat(FlexUtil._diffConditionPath(sFieldPath, mNewConditionState[sFieldPath], mPreviousConditionState[sFieldPath], oAdaptationControl));
+
+				var aFilterConditionChanges = FlexUtil._diffConditionPath(sFieldPath, mNewConditionState[sFieldPath], mPreviousConditionState[sFieldPath], oAdaptationControl);
+
+				if (oAdaptationControl && oAdaptationControl.createPropertyInfoChanges && (aFilterConditionChanges.length > 0)) {
+					aFilterConditionChanges = oAdaptationControl.createPropertyInfoChanges(sFieldPath).concat(aFilterConditionChanges);
+				}
+
+				aConditionChanges = aConditionChanges.concat(aFilterConditionChanges);
 			}
 
 			return aConditionChanges;
@@ -274,7 +186,8 @@ sap.ui.define([
 
 			return aChanges;
 		},
-		createAddRemoveChange: function(oControl, sOperation, oContent){
+
+		createChange: function(oControl, sOperation, oContent){
 			var oAddRemoveChange = {
 				selectorElement: oControl,
 				changeSpecificData: {
@@ -285,26 +198,6 @@ sap.ui.define([
 			return oAddRemoveChange;
 		},
 
-		createMoveChange: function (sId, sPropertyName, iNewIndex, sMoveOperation, oControl, bPersistId) {
-			var oMoveChange =  {
-				selectorElement: oControl,
-				changeSpecificData: {
-					changeType: sMoveOperation,
-					content: {
-						id: sId,
-						name: sPropertyName,
-						index: iNewIndex
-					}
-				}
-			};
-
-			if (!bPersistId) {
-				delete oMoveChange.changeSpecificData.content.id;
-			}
-
-			return oMoveChange;
-		},
-
 		createConditionChange: function(sChangeType, oControl, sFieldPath, oCondition) {
 			var oConditionChange = {
 				selectorElement: oControl,

package/src/sap/ui/mdc/p13n/P13nBuilder.js

@@ -31,8 +31,8 @@ sap.ui.define([
          * @param {object} oP13nUI Control displayed in the content area
          * @param {object} mDialogSettings Settings to overwrite popover default properties, such as: <code>contentHeight</code>
          * @param {object} [mDialogSettings.reset] Reset settings for the custom header creation
-         * @param {Function} [mDialogSettings.reset.onExecute] Callback executed upon triggering a reset
-         * @param {String} [mDialogSettings.reset.warningText] Warning which is displyed prior to executing the reset
+         * @param {function} [mDialogSettings.reset.onExecute] Callback executed upon triggering a reset
+         * @param {string} [mDialogSettings.reset.warningText] Warning which is displyed prior to executing the reset
          *
          * @returns {Promise} promise resolving in the Popover instance
          */
@@ -76,8 +76,8 @@ sap.ui.define([
          * @param {object} oP13nUI Control displayed in the content area
          * @param {object} mDialogSettings Settings to overwrite dialog default properties, such as: <code>contentHeight</code>
          * @param {object} [mDialogSettings.reset] Reset settings for the custom header creation
-         * @param {Function} [mDialogSettings.reset.onExecute] Callback executed upon triggering a reset
-         * @param {String} [mDialogSettings.reset.warningText] Warning which is displyed prior to executing the reset
+         * @param {function} [mDialogSettings.reset.onExecute] Callback executed upon triggering a reset
+         * @param {string} [mDialogSettings.reset.warningText] Warning which is displyed prior to executing the reset
          *
          * @returns {Promise} Promise resolving in the Dialog instance
          */
@@ -149,9 +149,9 @@ sap.ui.define([
         /**
          *
          * @param {object} mSettings Settings object to create a customHeader including a reset Button
-         * @param {String} mSettings.title Title for the custom reset header
+         * @param {string} mSettings.title Title for the custom reset header
          * @param {function} mSettings.reset Control specific reset handling
-         * @param {String} [mSettings.warningText] Text which is displayed prior to executing to reset execution
+         * @param {string} [mSettings.warningText] Text which is displayed prior to executing to reset execution
          *
          * @returns {sap.m.Bar} The created custom header Bar
          */
@@ -196,7 +196,7 @@ sap.ui.define([
         prepareAdaptationData: function(vProperties, fnEnhace, bGroupData) {
 
 			var oPropertyHelper =
-				vProperties && vProperties.getProperties instanceof Function ?
+                vProperties && vProperties.getProperties instanceof Function ?
 				vProperties : new P13nPropertyHelper(vProperties);
 
             var aItems = [];

package/src/sap/ui/mdc/p13n/PropertyHelper.js

@@ -29,7 +29,7 @@ sap.ui.define([
 	 * @extends sap.ui.mdc.util.PropertyHelper
 	 *
 	 * @author SAP SE
-	 * @version 1.97.1
+	 * @version 1.99.1
 	 *
 	 * @private
 	 * @experimental

package/src/sap/ui/mdc/p13n/StateUtil.js

@@ -79,6 +79,16 @@ sap.ui.define([
 		*			Country: {
 		*				aggregated: false
 		*			}
+		*		},
+		*		//The supplementaryConfig can be used to modify control specific attributes, for example the column width in the Table
+		*		supplementaryConfig: {
+		*			aggregations: {
+		*				columns: {
+		*					Category: {
+		*						width: "150px"
+		*					}
+		*				}
+		*			}
 		*		}
 		* }
 		*
@@ -112,6 +122,9 @@ sap.ui.define([
 		 * Attaches an event handler to the <code>StateUtil</code>.
 		 * The event handler may be fired every time a user triggers a personalization change for a control instance during runtime.
 		 *
+		 * @private
+		 * @ui5-restricted sap.fe
+		 * @MDC_PUBLIC_CANDIDATE
 		 * @param {function} fnListener fnFunction The handler function to call when the event occurs
 		 */
 		attachStateChange: function(fnListener) {
@@ -122,6 +135,9 @@ sap.ui.define([
 		 * Removes a previously attached state change event handler from the <code>StateUtil</code> class.
 		 * The passed parameters must match those used for registration with {@link StateUtil#attachChange} beforehand.
 		 *
+		 * @private
+		 * @ui5-restricted sap.fe
+		 * @MDC_PUBLIC_CANDIDATE
 		 * @param {function} fnListener fnFunction The handler function to detach from the event
 		 */
 		detachStateChange: function(fnListener) {
@@ -135,7 +151,8 @@ sap.ui.define([
 				Aggregate: "aggregations",
 				Filter: "filter",
 				Item: "items",
-				Column: "items"
+				Column: "items",
+				ColumnWidth: "supplementaryConfig"
 			};
 			var oTransformedState = {};
 
@@ -144,10 +161,6 @@ sap.ui.define([
 				var sTransformedKey = sExternalKey || sProvidedEngineKey;//no external key --> provide internal key
 				oTransformedState[sTransformedKey] = oInternalState[sProvidedEngineKey];
 			});
-			//TODO: Remove once the stateUtil for columnWidth is introduced
-			if (oTransformedState.ColumnWidth) {
-				delete oTransformedState.ColumnWidth;
-			}
 			return oTransformedState;
 		},
 
@@ -157,7 +170,8 @@ sap.ui.define([
 				groupLevels: ["Group"],
 				aggregations: ["Aggregate"],
 				filter: ["Filter"],
-				items: ["Item", "Column"]
+				items: ["Item", "Column"],
+				supplementaryConfig: ["ColumnWidth"]
 			};
 
 			var oTransformedState = {};

package/src/sap/ui/mdc/p13n/UIManager.js

@@ -32,7 +32,7 @@ sap.ui.define([
 	 * @extends sap.ui.base.Object
 	 *
 	 * @author SAP SE
-	 * @version 1.97.1
+	 * @version 1.99.1
 	 *
 	 * @private
 	 * @ui5-restricted sap.ui.mdc
@@ -364,7 +364,7 @@ sap.ui.define([
 
 		var mSettings = Object.assign({
 			verticalScrolling: true,
-			reset: mUISettings.reset,
+			reset: mUISettings.reset || {},
 			afterClose: function(oEvt) {
 				var oDialog = oEvt.getSource();
 				if (oDialog) {
@@ -375,11 +375,9 @@ sap.ui.define([
 		}, mUISettings.containerSettings);
 
 		if (mUISettings.resetEnabled){
-			mSettings.reset = {
-				onExecute: function() {
-					this.oAdaptationProvider.reset(oControl, aKeys);
-				}.bind(this)
-			};
+			mSettings.reset.onExecute = function() {
+				this.oAdaptationProvider.reset(oControl, aKeys);
+			}.bind(this);
 		}
 
 		mSettings.confirm = {

package/src/sap/ui/mdc/p13n/modification/FlexModificationHandler.js

@@ -54,8 +54,11 @@ sap.ui.define([
 
     FlexModificationHandler.prototype.reset = function(mPropertyBag, oModificationPayload){
         var sPersistenceMode = oModificationPayload.mode;
+
         var bIsGlobal = sPersistenceMode === mode.Global;
-        return bIsGlobal ? FlexUtil.reset.call(this, mPropertyBag) : FlexUtil.restore.call(this, mPropertyBag);
+        var bIsAutoGlobal = !oModificationPayload.hasVM && oModificationPayload.hasPP && sPersistenceMode === mode.Auto;
+
+        return (bIsGlobal || bIsAutoGlobal) ? FlexUtil.reset.call(this, mPropertyBag) : FlexUtil.restore.call(this, mPropertyBag);
     };
 
     FlexModificationHandler.prototype.isModificationSupported = function(mPropertyBag, oModificationPayload){

package/src/sap/ui/mdc/p13n/modification/ModificationHandler.js

@@ -160,15 +160,18 @@ sap.ui.define([
 
 				var oAppComponent = mPropertyBag ? mPropertyBag.appComponent : undefined;
 
-				if (!oControl._bHasXConfig) {
-					oControl._bHasXConfig = true;
-					return oModifier.createAndAddCustomData(oControl, "xConfig", oConfig, oAppComponent)
-					.then(function() {
+				if (!oControl._pXConfigCreation) {
+					oControl._pXConfigCreation = oModifier.createAndAddCustomData(oControl, "xConfig", oConfig, oAppComponent);
+					return oControl._pXConfigCreation
+					.then(function(){
 						return oConfig;
 					});
 				} else {
-					oModifier.setProperty(oXConfig, "value", oConfig);
-					return oConfig;
+					oControl._pXConfigCreation
+					.then(function(oCustomData){
+						oModifier.setProperty(oCustomData, "value", oConfig);
+						return oConfig;
+					});
 				}
 			});
 	};

package/src/sap/ui/mdc/p13n/modules/DefaultProviderRegistry.js

@@ -25,7 +25,7 @@ sap.ui.define([
 	 * @extends sap.ui.base.Object
 	 *
 	 * @author SAP SE
-	 * @version 1.97.1
+	 * @version 1.99.1
 	 *
 	 * @private
 	 * @ui5-restricted sap.ui.mdc