@openui5/sap.ui.fl 1.92.0 → 1.95.0

package/src/sap/ui/fl/changeHandler/MoveElements.js

@@ -5,9 +5,11 @@
  */
 
 sap.ui.define([
-	"sap/base/Log"
+	"sap/base/Log",
+	"sap/ui/fl/Utils"
 ], function(
-	Log
+	Log,
+	FlUtils
 ) {
 	"use strict";
 
@@ -16,13 +18,69 @@ sap.ui.define([
 	 *
 	 * @alias sap.ui.fl.changeHandler.MoveElements
 	 * @author SAP SE
-	 * @version 1.92.0
+	 * @version 1.95.0
 	 * @experimental Since 1.34.0
 	 */
 	var MoveElements = { };
 
 	MoveElements.CHANGE_TYPE = "moveElements";
 
+	function fnCheckConditions(oChange, oModifier, oView, oAppComponent) {
+		if (!oChange) {
+			return Promise.reject(new Error("No change instance"));
+		}
+
+		var oChangeContent = oChange.getContent();
+
+		if (!oChangeContent || !oChangeContent.movedElements || oChangeContent.movedElements.length === 0) {
+			return Promise.reject(new Error("Change format invalid"));
+		}
+		if (!oChange.getSelector().aggregation) {
+			return Promise.reject(new Error("No source aggregation supplied via selector for move"));
+		}
+		if (!oChangeContent.target || !oChangeContent.target.selector) {
+			return Promise.reject(new Error("No target supplied for move"));
+		}
+		if (!oModifier.bySelector(oChangeContent.target.selector, oAppComponent, oView)) {
+			return Promise.reject(new Error("Move target parent not found"));
+		}
+		if (!oChangeContent.target.selector.aggregation) {
+			return Promise.reject(new Error("No target aggregation supplied for move"));
+		}
+
+		return Promise.resolve();
+	}
+
+	function fnGetElementControlOrThrowError(mMovedElement, oModifier, oAppComponent, oView) {
+		if (!mMovedElement.selector && !mMovedElement.id) {
+			return Promise.reject(new Error("Change format invalid - moveElements element has no id attribute"));
+		}
+		if (typeof mMovedElement.targetIndex !== "number") {
+			return Promise.reject(new Error("Missing targetIndex for element with id '" + mMovedElement.selector.id
+				+ "' in movedElements supplied"));
+		}
+
+		return Promise.resolve()
+			.then(function() {
+				return oModifier.bySelector(mMovedElement.selector || mMovedElement.id, oAppComponent, oView);
+			});
+	}
+
+	function fnHandleMovedElement(mMovedElement, oModifier, oAppComponent, oView, oSourceParent, oTargetParent, sSourceAggregation, sTargetAggregation) {
+		var oMovedElement;
+		return fnGetElementControlOrThrowError(mMovedElement, oModifier, oAppComponent, oView)
+			.then(function(oRetrievedMovedElement) {
+				oMovedElement = oRetrievedMovedElement;
+				if (!oMovedElement) {
+					Log.warning("Element to move not found");
+					return Promise.reject();
+				}
+				return Promise.resolve()
+					.then(oModifier.removeAggregation.bind(oModifier, oSourceParent, sSourceAggregation, oMovedElement))
+					.then(oModifier.insertAggregation.bind(oModifier, oTargetParent, sTargetAggregation, oMovedElement, mMovedElement.targetIndex, oView));
+			});
+	}
+
 	/**
 	 * Moves an element from one aggregation to another.
 	 *
@@ -32,79 +90,50 @@ sap.ui.define([
 	 * @param {object} mPropertyBag.view - xml node representing a ui5 view
 	 * @param {sap.ui.core.util.reflection.BaseTreeModifier} mPropertyBag.modifier - modifier for the controls
 	 * @param {sap.ui.core.UIComponent} mPropertyBag.appComponent - appComopnent
-	 * @return {boolean} true - if change could be applied
+	 * @return {Promise} Promise resolving when change has been applied
 	 * @public
 	 * @function
 	 * @name sap.ui.fl.changeHandler.MoveElements#applyChange
 	 */
 	MoveElements.applyChange = function(oChange, oSourceParent, mPropertyBag) {
-		function checkConditions(oChange, oModifier, oView, oAppComponent) {
-			if (!oChange) {
-				throw new Error("No change instance");
-			}
-
-			var oChangeContent = oChange.getContent();
-
-			if (!oChangeContent || !oChangeContent.movedElements || oChangeContent.movedElements.length === 0) {
-				throw new Error("Change format invalid");
-			}
-			if (!oChange.getSelector().aggregation) {
-				throw new Error("No source aggregation supplied via selector for move");
-			}
-			if (!oChangeContent.target || !oChangeContent.target.selector) {
-				throw new Error("No target supplied for move");
-			}
-			if (!oModifier.bySelector(oChangeContent.target.selector, oAppComponent, oView)) {
-				throw new Error("Move target parent not found");
-			}
-			if (!oChangeContent.target.selector.aggregation) {
-				throw new Error("No target aggregation supplied for move");
-			}
-		}
-
-		function getElementControlOrThrowError(mMovedElement, oModifier, oAppComponent, oView) {
-			if (!mMovedElement.selector && !mMovedElement.id) {
-				throw new Error("Change format invalid - moveElements element has no id attribute");
-			}
-			if (typeof mMovedElement.targetIndex !== "number") {
-				throw new Error("Missing targetIndex for element with id '" + mMovedElement.selector.id
-						+ "' in movedElements supplied");
-			}
-
-			return oModifier.bySelector(mMovedElement.selector || mMovedElement.id, oAppComponent, oView);
-		}
-
 		var oModifier = mPropertyBag.modifier;
 		var oView = mPropertyBag.view;
 		var oAppComponent = mPropertyBag.appComponent;
-
-		checkConditions(oChange, oModifier, oView, oAppComponent);
-
 		var oChangeContent = oChange.getContent();
-		var oTargetParent = oModifier.bySelector(oChangeContent.target.selector, oAppComponent, oView);
-		var sSourceAggregation = oChange.getSelector().aggregation;
-		var sTargetAggregation = oChangeContent.target.selector.aggregation;
-
-		oChangeContent.movedElements.forEach(function(mMovedElement) {
-			var oMovedElement = getElementControlOrThrowError(mMovedElement, oModifier, oAppComponent, oView);
-
-			if (!oMovedElement) {
-				Log.warning("Element to move not found");
-				return;
-			}
-
-			oModifier.removeAggregation(oSourceParent, sSourceAggregation, oMovedElement);
-			oModifier.insertAggregation(oTargetParent, sTargetAggregation, oMovedElement, mMovedElement.targetIndex, oView);
-		});
-
-		return true;
+		var sSourceAggregation;
+		var sTargetAggregation;
+		var oTargetParent;
+
+		return fnCheckConditions(oChange, oModifier, oView, oAppComponent)
+			.then(function() {
+				sSourceAggregation = oChange.getSelector().aggregation;
+				sTargetAggregation = oChangeContent.target.selector.aggregation;
+				return oModifier.bySelector(oChangeContent.target.selector, oAppComponent, oView);
+			})
+			.then(function(oRetrievedTargetParent) {
+				oTargetParent = oRetrievedTargetParent;
+				var aPromises = [];
+				oChangeContent.movedElements.forEach(function(mMovedElement) {
+					aPromises.push(fnHandleMovedElement.bind(
+						null,
+						mMovedElement,
+						oModifier,
+						oAppComponent,
+						oView,
+						oSourceParent,
+						oTargetParent,
+						sSourceAggregation,
+						sTargetAggregation));
+				});
+				return FlUtils.execPromiseQueueSequentially(aPromises, true, true);
+			});
 	};
 
 	/**
 	 * @deprecated
 	 */
 	MoveElements.completeChangeContent = function() {
-		throw new Error('Using deprecated change handler. Please consider of using \'MoveControls\' instead');
+		throw new Error('Using deprecated change handler. Please consider using \'MoveControls\' instead');
 	};
 
 	/**

package/src/sap/ui/fl/changeHandler/PropertyBindingChange.js

@@ -16,7 +16,7 @@ sap.ui.define([
 	 *
 	 * @alias sap.ui.fl.changeHandler.PropertyBindingChange
 	 * @author SAP SE
-	 * @version 1.92.0
+	 * @version 1.95.0
 	 * @since 1.38
 	 * @private
 	 * @experimental Since 1.38. This class is experimental and provides only limited functionality. Also the API might be changed in future.
@@ -32,8 +32,9 @@ sap.ui.define([
 	/**
 	 * @param {object} oChange - change object with instructions to be applied on the control
 	 * @param {object} oControl - the control which has been determined by the selector id
-	 * @param {object} mPropertyBag
+	 * @param {object} mPropertyBag - property bag
 	 * @param {object} mPropertyBag.modifier - modifier for the controls
+	 * @returns {Promise} Promise that resolves with setting the property binding
 	 * @public
 	 * @name sap.ui.fl.changeHandler.PropertyBindingChange#applyChange
 	 */
@@ -48,18 +49,20 @@ sap.ui.define([
 		// 	throw new Error(sNoBindingError);
 		// }
 
-		var vOriginalValue = oModifier.getPropertyBindingOrProperty(oControl, sPropertyName);
-		oChange.setRevertData({
-			originalValue: vOriginalValue
-		});
-
-		oModifier.setPropertyBinding(oControl, sPropertyName, vPropertyValue);
+		return Promise.resolve()
+			.then(oModifier.getPropertyBindingOrProperty.bind(oModifier, oControl, sPropertyName))
+			.then(function(vOriginalValue) {
+				oChange.setRevertData({
+					originalValue: vOriginalValue
+				});
+				oModifier.setPropertyBinding(oControl, sPropertyName, vPropertyValue);
+			});
 	};
 
 	/**
 	 * @param {object} oChange - change object with instructions to be applied on the control
 	 * @param {object} oControl - the control which has been determined by the selector id
-	 * @param {object} mPropertyBag
+	 * @param {object} mPropertyBag - property bag
 	 * @param {object} mPropertyBag.modifier - modifier for the controls
 	 * @public
 	 * @name sap.ui.fl.changeHandler.PropertyBindingChange#revertChange
@@ -77,10 +80,7 @@ sap.ui.define([
 			oChange.resetRevertData();
 		} else {
 			Log.error("Attempt to revert an unapplied change.");
-			return false;
 		}
-
-		return true;
 	};
 
 	/**

package/src/sap/ui/fl/changeHandler/PropertyChange.js

@@ -20,7 +20,7 @@ sap.ui.define([
 	 *
 	 * @alias sap.ui.fl.changeHandler.PropertyChange
 	 * @author SAP SE
-	 * @version 1.92.0
+	 * @version 1.95.0
 	 * @since 1.36
 	 * @private
 	 * @experimental Since 1.36. This class is experimental and provides only limited functionality. Also the API might be changed in future.
@@ -50,8 +50,9 @@ sap.ui.define([
 	 *
 	 * @param {object} oChange - change object with instructions to be applied on the control
 	 * @param {object} oControl - the control which has been determined by the selector id
-	 * @param {object} mPropertyBag
+	 * @param {object} mPropertyBag - property bag
 	 * @param {object} mPropertyBag.modifier - modifier for the controls
+	 * @returns {Promise} Promise resolving when change is applied
 	 * @public
 	 * @name sap.ui.fl.changeHandler.PropertyChange#applyChange
 	 */
@@ -66,11 +67,14 @@ sap.ui.define([
 		// 	throw new Error(sBindingError);
 		// }
 
-		oChange.setRevertData({
-			originalValue: oModifier.getPropertyBindingOrProperty(oControl, sPropertyName)
-		});
-
-		changeProperty(oControl, sPropertyName, vPropertyValue, oModifier);
+		return Promise.resolve()
+			.then(oModifier.getPropertyBindingOrProperty.bind(oModifier, oControl, sPropertyName))
+			.then(function(oOriginalValue) {
+				oChange.setRevertData({
+					originalValue: oOriginalValue
+				});
+				changeProperty(oControl, sPropertyName, vPropertyValue, oModifier);
+			});
 	};
 
 	/**
@@ -78,9 +82,8 @@ sap.ui.define([
 	 *
 	 * @param {object} oChange - change object with instructions to be applied on the control
 	 * @param {object} oControl - the control which has been determined by the selector id
-	 * @param {object} mPropertyBag
+	 * @param {object} mPropertyBag - property bag
 	 * @param {object} mPropertyBag.modifier - modifier for the controls
-	 * @return {boolean} true - if change has been reverted
 	 * @public
 	 */
 	PropertyChange.revertChange = function(oChange, oControl, mPropertyBag) {
@@ -96,10 +99,7 @@ sap.ui.define([
 			oChange.resetRevertData();
 		} else {
 			Log.error("Attempt to revert an unapplied change.");
-			return false;
 		}
-
-		return true;
 	};
 
 	/**
@@ -108,21 +108,25 @@ sap.ui.define([
 	 * @param {object} oChange change object to be completed
 	 * @param {object} oSpecificChangeInfo with attribute property which contains an array which holds objects which have attributes
 	 * 				   id and index - id is the id of the field to property and index the new position of the field in the smart form group
+	 * @returns {Promise} Promise that resolves completing the change content
 	 * @public
 	 * @name sap.ui.fl.changeHandler.PropertyChange#completeChangeContent
 	 */
 	PropertyChange.completeChangeContent = function(oChange, oSpecificChangeInfo) {
-		var oChangeJson = oChange.getDefinition();
-
-		if (!oSpecificChangeInfo.content) {
-			throw new Error("oSpecificChangeInfo attribute required");
-		}
-		// TODO: enable again when apps have adapted
-		// if (isBinding(oSpecificChangeInfo.content.newValue)) {
-		// 	throw new Error(sBindingError);
-		// }
-
-		oChangeJson.content = oSpecificChangeInfo.content;
+		return Promise.resolve()
+			.then(function() {
+				var oChangeJson = oChange.getDefinition();
+
+				if (!oSpecificChangeInfo.content) {
+					throw new Error("oSpecificChangeInfo attribute required");
+				}
+				// TODO: enable again when apps have adapted
+				// if (isBinding(oSpecificChangeInfo.content.newValue)) {
+				// 	throw new Error(sBindingError);
+				// }
+
+				oChangeJson.content = oSpecificChangeInfo.content;
+			});
 	};
 
 	/**

package/src/sap/ui/fl/changeHandler/StashControl.js

@@ -15,7 +15,7 @@ sap.ui.define([
 	 * Change handler for stashing of a control.
 	 * @alias sap.ui.fl.changeHandler.StashControl
 	 * @author SAP SE
-	 * @version 1.92.0
+	 * @version 1.95.0
 	 * @experimental Since 1.27.0
 	 */
 	var StashControl = {};
@@ -27,20 +27,43 @@ sap.ui.define([
 	 * @param {sap.ui.core.Control} oControl - Control that matches the change selector for applying the change
 	 * @param {object} mPropertyBag - Map of properties
 	 * @param {sap.ui.core.util.reflection.BaseTreeModifier} mPropertyBag.modifier - Modifier for the controls
+	 * @returns {Promise} Promise resolving when the change is applied.
 	 * @public
 	 */
 	StashControl.applyChange = function(oChange, oControl, mPropertyBag) {
-		var bStashed = mPropertyBag.modifier.getStashed(oControl);
-		var iOriginalIndex = mPropertyBag.modifier.findIndexInParentAggregation(oControl);
-		this.setChangeRevertData(oChange, bStashed, iOriginalIndex);
+		var bStashed;
+		var oModifier = mPropertyBag.modifier;
 
-		if (LayerUtils.isDeveloperLayer(oChange.getLayer())) {
-			mPropertyBag.modifier.setStashed(oControl, true);
-		} else {
-			mPropertyBag.modifier.setVisible(oControl, false);
-		}
+		return Promise.resolve()
+			.then(oModifier.getStashed.bind(oModifier, oControl))
+			.then(function(bRetrievedStashed) {
+				bStashed = bRetrievedStashed;
+				return oModifier.findIndexInParentAggregation(oControl);
+			})
+			.then(function(iOriginalIndex) {
+				this.setChangeRevertData(oChange, bStashed, iOriginalIndex);
+				if (LayerUtils.isDeveloperLayer(oChange.getLayer())) {
+					return oModifier.setStashed(oControl, true);
+				}
+				return oModifier.setVisible(oControl, false);
+			}.bind(this));
 	};
 
+	function fnHandleUnstashedControl(iUnstashedIndex, mRevertData, oUnstashedControl, oModifier) {
+		var sAggregationName;
+		if (iUnstashedIndex !== mRevertData.originalIndex) {
+			var oParent = oModifier.getParent(oUnstashedControl);
+			return Promise.return()
+				.then(oModifier.getParentAggregationName.bind(oModifier, oUnstashedControl))
+				.then(function(sRetrievedAggregationName) {
+					sAggregationName = sRetrievedAggregationName;
+					return oModifier.removeAggregation(oParent, sAggregationName, oUnstashedControl);
+				})
+				.then(oModifier.insertAggregation.bind(oModifier, oParent, sAggregationName, oUnstashedControl, mRevertData.originalIndex));
+		}
+		return Promise.resolve();
+	}
+
 	/**
 	 * Reverts previously applied change
 	 *
@@ -48,26 +71,31 @@ sap.ui.define([
 	 * @param {sap.ui.core.Control} oControl - Control that matches the change selector for applying the change
 	 * @param {object} mPropertyBag - Map of properties
 	 * @param {sap.ui.core.util.reflection.BaseTreeModifier} mPropertyBag.modifier - Modifier for the controls
+	 * @returns {Promise} Promise resolving when change is reverted
 	 * @public
 	 */
 	StashControl.revertChange = function(oChange, oControl, mPropertyBag) {
 		var mRevertData = oChange.getRevertData();
+		var oModifier = mPropertyBag.modifier;
 
-		if (LayerUtils.isDeveloperLayer(oChange.getLayer())) {
-			var oUnstashedControl = mPropertyBag.modifier.setStashed(oControl, mRevertData.originalValue, mPropertyBag.appComponent);
-			if (oUnstashedControl) {
-				var iUnstashedIndex = mPropertyBag.modifier.findIndexInParentAggregation((oUnstashedControl));
-				if (iUnstashedIndex !== mRevertData.originalIndex) {
-					var oParent = mPropertyBag.modifier.getParent(oUnstashedControl);
-					var sAggregationName = mPropertyBag.modifier.getParentAggregationName(oUnstashedControl);
-					mPropertyBag.modifier.removeAggregation(oParent, sAggregationName, oUnstashedControl);
-					mPropertyBag.modifier.insertAggregation(oParent, sAggregationName, oUnstashedControl, mRevertData.originalIndex);
+		return Promise.resolve()
+			.then(function() {
+				if (LayerUtils.isDeveloperLayer(oChange.getLayer())) {
+					var oUnstashedControl = oModifier.setStashed(oControl, mRevertData.originalValue, mPropertyBag.appComponent);
+					if (oUnstashedControl) {
+						return Promise.resolve()
+							.then(oModifier.findIndexInParentAggregation.bind(oModifier, oUnstashedControl))
+							.then(function(iUnstashedIndex) {
+								return fnHandleUnstashedControl(iUnstashedIndex, mRevertData, oUnstashedControl, oModifier);
+							});
+					}
+					return Promise.resolve();
 				}
-			}
-		} else {
-			mPropertyBag.modifier.setVisible(oControl, !mRevertData.originalValue);
-		}
-		oChange.resetRevertData();
+				return oModifier.setVisible(oControl, !mRevertData.originalValue);
+			})
+			.then(function() {
+				oChange.resetRevertData();
+			});
 	};
 
 	/**

package/src/sap/ui/fl/changeHandler/UnhideControl.js

@@ -17,7 +17,7 @@ sap.ui.define([
 	 * Change handler for unhiding of a control.
 	 * @alias sap.ui.fl.changeHandler.UnhideControl
 	 * @author SAP SE
-	 * @version 1.92.0
+	 * @version 1.95.0
 	 * @experimental Since 1.27.0
 	 */
 	var UnhideControl = {};
@@ -27,18 +27,21 @@ sap.ui.define([
 	 *
 	 * @param {sap.ui.fl.Change} oChange change object with instructions to be applied on the control map
 	 * @param {sap.ui.core.Control} oControl control that matches the change selector for applying the change
-	 * @param {object} mPropertyBag
+	 * @param {object} mPropertyBag - property bag
 	 * @param {object} mPropertyBag.modifier - modifier for the controls
-	 * @return {boolean} true - if change could be applied
+	 * @return {Promise} Promise resolving when the change is applied successfully
 	 * @public
 	 */
 	UnhideControl.applyChange = function(oChange, oControl, mPropertyBag) {
-		oChange.setRevertData({
-			originalValue: mPropertyBag.modifier.getProperty(oControl, PROPERTY_NAME)
-		});
-
-		mPropertyBag.modifier.setVisible(oControl, true);
-		return true;
+		var oModifier = mPropertyBag.modifier;
+		return Promise.resolve()
+			.then(oModifier.getProperty.bind(oModifier, oControl, PROPERTY_NAME))
+			.then(function(oOriginalValue) {
+				oChange.setRevertData({
+					originalValue: oOriginalValue
+				});
+				mPropertyBag.modifier.setVisible(oControl, true);
+			});
 	};
 
 	/**
@@ -46,9 +49,8 @@ sap.ui.define([
 	 *
 	 * @param {sap.ui.fl.Change} oChange change object with instructions to be applied on the control map
 	 * @param {sap.ui.core.Control} oControl control that matches the change selector for applying the change
-	 * @param {object} mPropertyBag
+	 * @param {object} mPropertyBag - property bag
 	 * @param {object} mPropertyBag.modifier - modifier for the controls
-	 * @return {boolean} true - if change has been reverted
 	 * @public
 	 */
 	UnhideControl.revertChange = function(oChange, oControl, mPropertyBag) {
@@ -59,10 +61,7 @@ sap.ui.define([
 			oChange.resetRevertData();
 		} else {
 			Log.error("Attempt to revert an unapplied change.");
-			return false;
 		}
-
-		return true;
 	};
 
 	/**

package/src/sap/ui/fl/changeHandler/UnstashControl.js

@@ -11,7 +11,7 @@ sap.ui.define([], function() {
 	 * Change handler for unstashing of a control.
 	 * @alias sap.ui.fl.changeHandler.UnstashControl
 	 * @author SAP SE
-	 * @version 1.92.0
+	 * @version 1.95.0
 	 * @experimental Since 1.27.0
 	 */
 	var UnstashControl = {};
@@ -30,22 +30,29 @@ sap.ui.define([], function() {
 		var mContent = oChange.getContent();
 		var oModifier = mPropertyBag.modifier;
 		var bStashed = false;
+		var oUnstashedControl;
 
-		oChange.setRevertData({
-			originalValue: mPropertyBag.modifier.getStashed(oControl)
-		});
-
-		var oUnstashedControl = oModifier.setStashed(oControl, bStashed, mPropertyBag.appComponent) || oControl;
-
-		//old way including move, new way will have separate move change
-		//only applicable for XML modifier
-		if (mContent.parentAggregationName) {
-			var sTargetAggregation = mContent.parentAggregationName;
-			var oTargetParent = oModifier.getParent(oUnstashedControl);
-			oModifier.removeAggregation(oTargetParent, sTargetAggregation, oUnstashedControl);
-			oModifier.insertAggregation(oTargetParent, sTargetAggregation, oUnstashedControl, mContent.index, mPropertyBag.view);
-		}
-		return oUnstashedControl;
+		return Promise.resolve()
+			.then(oModifier.getStashed.bind(oModifier, oControl))
+			.then(function(bPreviouslyStashed) {
+				oChange.setRevertData({
+					originalValue: bPreviouslyStashed
+				});
+				oUnstashedControl = oModifier.setStashed(oControl, bStashed, mPropertyBag.appComponent) || oControl;
+				//old way including move, new way will have separate move change
+				//only applicable for XML modifier
+				if (mContent.parentAggregationName) {
+					var sTargetAggregation = mContent.parentAggregationName;
+					var oTargetParent = oModifier.getParent(oUnstashedControl);
+					return Promise.resolve()
+						.then(oModifier.removeAggregation.bind(oModifier, oTargetParent, sTargetAggregation, oUnstashedControl))
+						.then(oModifier.insertAggregation.bind(oModifier, oTargetParent, sTargetAggregation, oUnstashedControl, mContent.index, mPropertyBag.view));
+				}
+				return undefined;
+			})
+			.then(function() {
+				return oUnstashedControl;
+			});
 	};
 
 	/**