@openui5/sap.ui.layout 1.92.0 → 1.95.0

package/src/sap/ui/layout/changeHandler/AddSimpleFormField.js

@@ -5,9 +5,11 @@
  */
 
 sap.ui.define([
-	"sap/ui/fl/changeHandler/BaseAddViaDelegate"
+	"sap/ui/fl/changeHandler/BaseAddViaDelegate",
+	"sap/ui/core/util/reflection/JsControlTreeModifier"
 ], function(
-	BaseAddViaDelegate
+	BaseAddViaDelegate,
+	JsControlTreeModifier
 ) {
 	"use strict";
 
@@ -30,29 +32,29 @@ sap.ui.define([
 		// This logic is for insertIndex being a desired index of a form element inside a container
 		// However we cannot allow that new fields are added inside other FormElements, therefore
 		// we must find the end of the FormElement to add the new FormElement there
-		if (aContent.length === 1 || aContent.length === iIndexOfHeader + 1){
+		if (aContent.length === 1 || aContent.length === iIndexOfHeader + 1) {
 			// Empty container (only header or toolbar)
 			iNewIndex = aContent.length;
 		} else {
 			var j = 0;
-			for (j = iIndexOfHeader + 1; j < aContent.length; j++){
+			for (j = iIndexOfHeader + 1; j < aContent.length; j++) {
 				var sControlType = oModifier.getControlType(aContent[j]);
 				// When the next control is a label (= end of FormElement)
-				if (sControlType === sTypeLabel || sControlType === sTypeSmartLabel ){
-					if (iFormElementIndex == insertIndex){
+				if (sControlType === sTypeLabel || sControlType === sTypeSmartLabel) {
+					if (iFormElementIndex === insertIndex) {
 						iNewIndex = j;
 						break;
 					}
 					iFormElementIndex++;
 				}
 				// Next control is a title or toolbar (= end of container)
-				if (sControlType === sTypeTitle || sControlType === sTypeToolBar){
+				if (sControlType === sTypeTitle || sControlType === sTypeToolBar) {
 					iNewIndex = j;
 					break;
 				}
 
 				// If there are no more titles, toolbars or labels (= this is the last FormElement) -> insert at end
-				if (j === (aContent.length - 1)){
+				if (j === (aContent.length - 1)) {
 					iNewIndex = aContent.length;
 				}
 			}
@@ -67,15 +69,17 @@ sap.ui.define([
 	}
 
 	function recreateContentAggregation(oSimpleForm, aContentClone, oModifier, mPropertyBag) {
-		oModifier.removeAllAggregation(oSimpleForm, "content");
-			for (var i = 0; i < aContentClone.length; ++i) {
-				oModifier.insertAggregation(oSimpleForm,
-					"content",
-					aContentClone[i],
-					i,
-					mPropertyBag.view
-				);
-			}
+		return aContentClone.reduce(function(oPreviousPromise, oContentClone, iIndex) {
+			return oPreviousPromise
+				.then(function() {
+					return oModifier.insertAggregation(oSimpleForm,
+						"content",
+						oContentClone,
+						iIndex,
+						mPropertyBag.view
+					);
+				});
+		}, Promise.resolve());
 	}
 
 	/**
@@ -87,41 +91,52 @@ sap.ui.define([
 	 *
 	 * @author SAP SE
 	 *
-	 * @version 1.92.0
+	 * @version 1.95.0
 	 *
 	 * @experimental Since 1.49.0 This class is experimental and provides only limited functionality. Also the API might be
 	 *               changed in future.
 	 */
 	var AddSimpleFormField = BaseAddViaDelegate.createAddViaDelegateChangeHandler({
-		addProperty : function(mPropertyBag) {
+		addProperty: function(mPropertyBag) {
 			var oSimpleForm = mPropertyBag.control;
 
 			var mInnerControls = mPropertyBag.innerControls;
 			var oModifier = mPropertyBag.modifier;
 			var oAppComponent = mPropertyBag.appComponent;
+			var aContent;
+			var iNewIndex;
+			var aContentClone;
 
 			var oChange = mPropertyBag.change;
 			// as the label is stored independent of the field and will not be destroyed by destroying the field, is needs to be remembered
 			var oRevertData = oChange.getRevertData();
 			oRevertData.labelSelector = oModifier.getSelector(mInnerControls.label, oAppComponent);
 
-			var aContent = oModifier.getAggregation(oSimpleForm, "content");
-			var iNewIndex = getIndex(aContent, mPropertyBag);
-			var aContentClone = insertLabelAndField(aContent, iNewIndex, mInnerControls);
-
-			recreateContentAggregation(oSimpleForm, aContentClone, oModifier, mPropertyBag);
-
-			if (mInnerControls.valueHelp) {
-				oModifier.insertAggregation(
-					oSimpleForm,
-					"dependents",
-					mInnerControls.valueHelp,
-					0,
-					mPropertyBag.view
-				);
-			}
+			return Promise.resolve()
+				.then(oModifier.getAggregation.bind(oModifier, oSimpleForm, "content"))
+				.then(function(aAggregationContent) {
+					aContent = aAggregationContent;
+					iNewIndex = getIndex(aContent, mPropertyBag);
+					aContentClone = insertLabelAndField(aContent, iNewIndex, mInnerControls);
+					return oModifier.removeAllAggregation(oSimpleForm, "content");
+				})
+				.then(function() {
+					return recreateContentAggregation(oSimpleForm, aContentClone, oModifier, mPropertyBag);
+				})
+				.then(function() {
+					if (mInnerControls.valueHelp) {
+						return oModifier.insertAggregation(
+							oSimpleForm,
+							"dependents",
+							mInnerControls.valueHelp,
+							0,
+							mPropertyBag.view
+						);
+					}
+					return undefined;
+				});
 		},
-		revertAdditionalControls : function(mPropertyBag) {
+		revertAdditionalControls: function(mPropertyBag) {
 			var oSimpleForm = mPropertyBag.control;
 			var oChange = mPropertyBag.change;
 			var oModifier = mPropertyBag.modifier;
@@ -130,9 +145,11 @@ sap.ui.define([
 			var mLabelSelector = oChange.getRevertData().labelSelector;
 			if (mLabelSelector) {
 				var oLabel = oModifier.bySelector(mLabelSelector, oAppComponent);
-				oModifier.removeAggregation(oSimpleForm, "content", oLabel);
-				oModifier.destroy(oLabel);
+				return Promise.resolve()
+					.then(oModifier.removeAggregation.bind(oModifier, oSimpleForm, "content", oLabel))
+					.then(oModifier.destroy.bind(oModifier, oLabel));
 			}
+			return Promise.resolve();
 		},
 		aggregationName: "content",
 		mapParentIdIntoChange: function (oChange, mSpecificChangeInfo, mPropertyBag) {
@@ -154,6 +171,18 @@ sap.ui.define([
 		supportsDefault: true
 	});
 
+	AddSimpleFormField.getChangeVisualizationInfo = function(oChange, oAppComponent) {
+		var oRevertData = oChange.getRevertData();
+		if (oRevertData && oRevertData.labelSelector) {
+			return {
+				affectedControls: [JsControlTreeModifier.bySelector(oRevertData.labelSelector, oAppComponent).getParent().getId()]
+			};
+		}
+		return {
+			affectedControls: [oChange.getContent().newFieldSelector]
+		};
+	};
+
 	return AddSimpleFormField;
 },
 /* bExport= */true);

package/src/sap/ui/layout/changeHandler/AddSimpleFormGroup.js

@@ -6,7 +6,7 @@
 
 sap.ui.define([
 	"sap/ui/fl/changeHandler/Base",
-	"sap/ui/fl/changeHandler/JsControlTreeModifier",
+	"sap/ui/core/util/reflection/JsControlTreeModifier",
 	"sap/base/Log"
 ], function (
 	Base,
@@ -19,7 +19,7 @@ sap.ui.define([
 		* Change handler for adding a simple form group.
 		* @alias sap.ui.layout.changeHandler.AddSimpleFormGroup
 		* @author SAP SE
-		* @version 1.92.0
+		* @version 1.95.0
 		* @experimental Since 1.27.0
 		*/
 	var AddSimpleFormGroup = {};
@@ -27,16 +27,25 @@ sap.ui.define([
 	AddSimpleFormGroup.CONTENT_AGGREGATION = "content";
 
 	var fnFirstGroupWithoutTitle = function(oModifier, aStopToken, aContent) {
-		for (var i = 0; i < aContent.length; i++) {
-			var sType = oModifier.getControlType(aContent[i]);
-			if (aStopToken.indexOf(sType) === -1) {
-				if (oModifier.getVisible(aContent[i])) {
-					return true;
-				}
-			} else {
-				return false;
-			}
-		}
+		return aContent.reduce(function(oPreviousPromise, oContent){
+			return oPreviousPromise
+				.then(function(bReturnValue){
+					if (bReturnValue !== undefined) {
+						return bReturnValue;
+					}
+					var sType = oModifier.getControlType(oContent);
+					if (aStopToken.indexOf(sType) === -1) {
+						return Promise.resolve()
+							.then(oModifier.getVisible.bind(oModifier, oContent))
+							.then(function(bVisible){
+								return bVisible || undefined;
+							});
+					} else {
+						return false;
+					}
+				});
+		}, Promise.resolve());
+
 	};
 
 	var fnMapGroupIndexToContentAggregationIndex = function(oModifier, aStopToken, aContent, iGroupIndex) {
@@ -47,22 +56,24 @@ sap.ui.define([
 		if (iGroupIndex === 0) {
 			return iGroupIndex;
 		}
+		return fnFirstGroupWithoutTitle(oModifier, aStopToken, aContent)
+			.then(function(bFirstGroupWithoutName){
+				if (bFirstGroupWithoutName) {
+					iCurrentGroupIndex++;
+				}
 
-		if (fnFirstGroupWithoutTitle(oModifier, aStopToken, aContent)) {
-			iCurrentGroupIndex++;
-		}
-
-		for (var i = 0; i < aContent.length; i++) {
-			var sType = oModifier.getControlType(aContent[i]);
-			if (aStopToken.indexOf(sType) > -1) {
-				iCurrentGroupIndex++;
-				if (iCurrentGroupIndex === iGroupIndex) {
-					oResult = aContent[i];
-					return aContent.indexOf(oResult);
+				for (var i = 0; i < aContent.length; i++) {
+					var sType = oModifier.getControlType(aContent[i]);
+					if (aStopToken.indexOf(sType) > -1) {
+						iCurrentGroupIndex++;
+						if (iCurrentGroupIndex === iGroupIndex) {
+							oResult = aContent[i];
+							return aContent.indexOf(oResult);
+						}
+					}
 				}
-			}
-		}
-		return aContent.length;
+				return aContent.length;
+			});
 	};
 
 	/**
@@ -74,14 +85,14 @@ sap.ui.define([
 	 * @param {object} mPropertyBag.modifier Modifier for the controls
 	 * @param {object} mPropertyBag.appComponent Component in which the change should be applied
 	 * @param {object} mPropertyBag.view Application view
-	 * @return {boolean} True if successful
+	 * @return {Promise} Promise resolving when change is applied successfully
 	 * @public
 	 */
 	AddSimpleFormGroup.applyChange = function (oChangeWrapper, oForm, mPropertyBag) {
 		var oModifier = mPropertyBag.modifier;
 		var oView = mPropertyBag.view;
-		var oAppComponent = mPropertyBag.appComponent,
-			oTitle;
+		var oAppComponent = mPropertyBag.appComponent;
+		var iInsertIndex;
 
 		var oChange = oChangeWrapper.getDefinition();
 		if (oChange.texts && oChange.texts.groupLabel && oChange.texts.groupLabel.value &&
@@ -100,37 +111,39 @@ sap.ui.define([
 			}
 			oChangeWrapper.setRevertData({groupId: sGroupId});
 			var sLabelText = oChange.texts.groupLabel.value;
-
-			var aContent = oModifier.getAggregation(oForm, AddSimpleFormGroup.CONTENT_AGGREGATION);
-
-			var iInsertIndex;
 			var iRelativeIndex;
-
-			if (typeof oChange.content.group.index === "number") {
-				// The old code support
-				iInsertIndex = oChange.content.group.index;
-			} else {
-				iRelativeIndex = oChange.content.group.relativeIndex;
-				iInsertIndex = fnMapGroupIndexToContentAggregationIndex(oModifier,
-					["sap.ui.core.Title", "sap.m.Title", "sap.m.Toolbar", "sap.m.OverflowToolbar"],
-					aContent, iRelativeIndex);
-			}
-
-			// Check if the change is applicable
-			if (oModifier.bySelector(sGroupId, oAppComponent)) {
-				return Base.markAsNotApplicable("Control to be created already exists:" + sGroupId);
-			}
-			oTitle = oModifier.createControl("sap.ui.core.Title", oAppComponent, oView, sGroupId);
-
-			oModifier.setProperty(oTitle, "text", sLabelText);
-			oModifier.insertAggregation(oForm, "content", oTitle, iInsertIndex, oView);
+			return Promise.resolve()
+				.then(function(){
+					return oModifier.getAggregation(oForm, AddSimpleFormGroup.CONTENT_AGGREGATION);
+				})
+				.then(function(aContent){
+					if (typeof oChange.content.group.index === "number") {
+						// The old code support
+						return oChange.content.group.index;
+					} else {
+						iRelativeIndex = oChange.content.group.relativeIndex;
+						return fnMapGroupIndexToContentAggregationIndex(oModifier,
+							["sap.ui.core.Title", "sap.m.Title", "sap.m.Toolbar", "sap.m.OverflowToolbar"],
+							aContent, iRelativeIndex);
+					}
+				})
+				.then(function(iReturnedInsertIndex) {
+					iInsertIndex = iReturnedInsertIndex;
+					// Check if the change is applicable
+					if (oModifier.bySelector(sGroupId, oAppComponent)) {
+						return Base.markAsNotApplicable("Control to be created already exists:" + sGroupId);
+					}
+					return oModifier.createControl("sap.ui.core.Title", oAppComponent, oView, sGroupId);
+				})
+				.then(function(oTitle) {
+					oModifier.setProperty(oTitle, "text", sLabelText);
+					return oModifier.insertAggregation(oForm, "content", oTitle, iInsertIndex, oView);
+				});
 
 		} else {
 			Log.error("Change does not contain sufficient information to be applied: [" + oChange.layer + "]" + oChange.namespace + "/" + oChange.fileName + "." + oChange.fileType);
 			//however subsequent changes should be applied
 		}
-
-		return true;
 	};
 
 	/**
@@ -198,7 +211,7 @@ sap.ui.define([
 	 * @param {object} mPropertyBag.modifier Modifier for the controls
 	 * @param {object} mPropertyBag.appComponent Component in which the change should be applied
 	 * @param {object} mPropertyBag.view Application view
-	 * @return {boolean} True if successful
+	 * @return {Promise} Promise resolving when change is successfully reverted
 	 * @public
 	 */
 	AddSimpleFormGroup.revertChange = function (oChangeWrapper, oForm, mPropertyBag) {
@@ -209,11 +222,14 @@ sap.ui.define([
 
 		var oGroupSelector = oModifier.getSelector(sGroupId, oAppComponent);
 		var oGroup = oModifier.bySelector(oGroupSelector, oAppComponent, oView);
-		oModifier.removeAggregation(oForm, AddSimpleFormGroup.CONTENT_AGGREGATION, oGroup);
-		oModifier.destroy(oGroup);
-		oChangeWrapper.resetRevertData();
-
-		return true;
+		return Promise.resolve()
+			.then(function() {
+				return oModifier.removeAggregation(oForm, AddSimpleFormGroup.CONTENT_AGGREGATION, oGroup);
+			})
+			.then(function() {
+				oModifier.destroy(oGroup);
+				oChangeWrapper.resetRevertData();
+			});
 	};
 
 	AddSimpleFormGroup.getChangeVisualizationInfo = function(oChange, oAppComponent) {