@openui5/sap.ui.core 1.127.1 → 1.129.0

package/src/sap/ui/core/util/reflection/JsControlTreeModifier.js

@@ -7,26 +7,39 @@
  */
 
 sap.ui.define([
-	"sap/ui/base/BindingParser",
-	"./BaseTreeModifier",
-	"./XmlTreeModifier",
-	"sap/base/util/ObjectPath",
-	"sap/ui/util/XMLHelper",
 	"sap/base/util/merge",
+	"sap/base/util/ObjectPath",
+	"sap/ui/base/BindingParser",
+	"sap/ui/core/util/reflection/BaseTreeModifier",
+	"sap/ui/core/util/reflection/XmlTreeModifier",
 	"sap/ui/core/Element",
-	"sap/ui/core/Fragment"
-], function (
+	"sap/ui/core/Fragment",
+	"sap/ui/util/XMLHelper"
+], function(
+	merge,
+	ObjectPath,
 	BindingParser,
 	BaseTreeModifier,
 	XmlTreeModifier,
-	ObjectPath,
-	XMLHelper,
-	merge,
 	Element,
-	Fragment
+	Fragment,
+	XMLHelper
 ) {
 
 	"use strict";
+
+	function requireClass(sClassName) {
+		return new Promise(function(fnResolve, fnReject) {
+			sap.ui.require([sClassName],
+				function(oClassObject) { fnResolve(oClassObject); },
+				function() {
+					fnReject(new Error("Required control '" + sClassName
+						+ "' couldn't be created asynchronously"));
+				}
+			);
+		});
+	}
+
 	/**
 	 * Static utility class to access ManagedObjects in a harmonized way with XMLNodes.
 	 *
@@ -36,14 +49,13 @@ sap.ui.define([
 	 * @ui5-restricted
 	 * @since 1.56.0
 	 */
-	var JsControlTreeModifier = /** @lends sap.ui.core.util.reflection.JsControlTreeModifier */ {
-
+	const JsControlTreeModifier = /** @lends sap.ui.core.util.reflection.JsControlTreeModifier */ {
 		targets: "jsControlTree",
 
 		/**
 		 * @inheritDoc
 		 */
-		setVisible: function (oControl, bVisible) {
+		setVisible: function(oControl, bVisible) {
 			if (oControl.setVisible) {
 				this.unbindProperty(oControl, "visible");
 				oControl.setVisible(bVisible);
@@ -55,7 +67,7 @@ sap.ui.define([
 		/**
 		 * @inheritDoc
 		 */
-		getVisible: function (oControl) {
+		getVisible: function(oControl) {
 			if (oControl.getVisible) {
 				return Promise.resolve(oControl.getVisible());
 			} else {
@@ -66,7 +78,7 @@ sap.ui.define([
 		/**
 		 * @inheritDoc
 		 */
-		setStashed: async function (oControl, bStashed) {
+		setStashed: async function(oControl, bStashed) {
 			bStashed = !!bStashed;
 			if (oControl.unstash) {
 				// check if the control is stashed and should be unstashed
@@ -88,30 +100,28 @@ sap.ui.define([
 		/**
 		 * @inheritDoc
 		 */
-		getStashed: function (oControl) {
+		getStashed: async function(oControl) {
 			if (oControl.isStashed) {
 				if (oControl.isStashed()) {
-					return Promise.resolve(true);
+					return true;
 				}
-				return this.getVisible(oControl)
-					.then(function (bIsVisible) {
-						return !bIsVisible;
-					});
+				const bIsVisible = await this.getVisible(oControl);
+				return !bIsVisible;
 			}
-			return Promise.reject(new Error("Provided control instance has no isStashed method"));
+			throw new Error("Provided control instance has no isStashed method");
 		},
 
 		/**
 		 * @inheritDoc
 		 */
-		bindProperty: function (oControl, sPropertyName, vBindingInfos) {
+		bindProperty: function(oControl, sPropertyName, vBindingInfos) {
 			oControl.bindProperty(sPropertyName, vBindingInfos);
 		},
 
 		/**
 		 * @inheritDoc
 		 */
-		unbindProperty: function (oControl, sPropertyName) {
+		unbindProperty: function(oControl, sPropertyName) {
 			if (oControl) {
 				oControl.unbindProperty(sPropertyName, /*bSuppressReset = */true);
 			}
@@ -120,10 +130,10 @@ sap.ui.define([
 		/**
 		 * @inheritDoc
 		 */
-		setProperty: function (oControl, sPropertyName, vPropertyValue) {
-			var oMetadata = oControl.getMetadata().getPropertyLikeSetting(sPropertyName);
-			var oBindingParserResult;
-			var bError;
+		setProperty: function(oControl, sPropertyName, vPropertyValue) {
+			const oMetadata = oControl.getMetadata().getPropertyLikeSetting(sPropertyName);
+			let oBindingParserResult;
+			let bError;
 
 			this.unbindProperty(oControl, sPropertyName);
 
@@ -139,7 +149,7 @@ sap.ui.define([
 					if (oBindingParserResult && typeof oBindingParserResult === "object" || bError) {
 						vPropertyValue = this._escapeCurlyBracketsInString(vPropertyValue);
 					}
-					var sPropertySetter = oMetadata._sMutator;
+					const sPropertySetter = oMetadata._sMutator;
 					oControl[sPropertySetter](vPropertyValue);
 				} else {
 					throw new TypeError("Value cannot be stringified", "sap.ui.core.util.reflection.JsControlTreeModifier");
@@ -150,11 +160,11 @@ sap.ui.define([
 		/**
 		 * @inheritDoc
 		 */
-		getProperty: function (oControl, sPropertyName) {
-			var oMetadata = oControl.getMetadata().getPropertyLikeSetting(sPropertyName);
-			var oProperty;
+		getProperty: function(oControl, sPropertyName) {
+			const oMetadata = oControl.getMetadata().getPropertyLikeSetting(sPropertyName);
+			let oProperty;
 			if (oMetadata) {
-				var sPropertyGetter = oMetadata._sGetter;
+				const sPropertyGetter = oMetadata._sGetter;
 				oProperty = oControl[sPropertyGetter]();
 			}
 			return Promise.resolve(oProperty);
@@ -163,16 +173,16 @@ sap.ui.define([
 		/**
 		 * @inheritDoc
 		 */
-		isPropertyInitial: function (oControl, sPropertyName) {
+		isPropertyInitial: function(oControl, sPropertyName) {
 			return oControl.isPropertyInitial(sPropertyName);
 		},
 
 		/**
 		 * @inheritDoc
 		 */
-		setPropertyBinding: function (oControl, sPropertyName, oPropertyBinding) {
+		setPropertyBinding: function(oControl, sPropertyName, oPropertyBinding) {
 			this.unbindProperty(oControl, sPropertyName);
-			var mSettings = {};
+			const mSettings = {};
 			mSettings[sPropertyName] = oPropertyBinding;
 			return oControl.applySettings(mSettings);
 		},
@@ -180,27 +190,25 @@ sap.ui.define([
 		/**
 		 * @inheritDoc
 		 */
-		getPropertyBinding: function (oControl, sPropertyName) {
+		getPropertyBinding: function(oControl, sPropertyName) {
 			return oControl.getBindingInfo(sPropertyName);
 		},
 
 		/**
 		 * @inheritDoc
 		 */
-		createAndAddCustomData: function(oControl, sCustomDataKey, sValue, oAppComponent) {
-			return this.createControl("sap.ui.core.CustomData", oAppComponent)
-				.then(function (oCustomData) {
-					this.setProperty(oCustomData, "key", sCustomDataKey);
-					this.setProperty(oCustomData, "value", sValue);
-					return this.insertAggregation(oControl, "customData", oCustomData, 0);
-				}.bind(this));
+		createAndAddCustomData: async function(oControl, sCustomDataKey, sValue, oAppComponent) {
+			const oCustomData = await this.createControl("sap.ui.core.CustomData", oAppComponent);
+			this.setProperty(oCustomData, "key", sCustomDataKey);
+			this.setProperty(oCustomData, "value", sValue);
+			return this.insertAggregation(oControl, "customData", oCustomData, 0);
 		},
 
 		/**
 		 * @inheritDoc
 		 */
 		getCustomDataInfo: function(oControl, sCustomDataKey) {
-			var oCustomData;
+			let oCustomData;
 			if (oControl.getCustomData) {
 				oControl.getCustomData().some(function(oCurrentCustomData) {
 					if (oCurrentCustomData.getKey() === sCustomDataKey) {
@@ -223,34 +231,16 @@ sap.ui.define([
 		/**
 		 * @inheritDoc
 		 */
-		createControl: function (sClassName, oAppComponent, oView, oSelector, mSettings) {
+		createControl: async function(sClassName, oAppComponent, oView, oSelector, mSettings) {
 			sClassName = sClassName.replace(/\./g,"/");
 			if (this.bySelector(oSelector, oAppComponent)) {
-				var sErrorMessage = "Can't create a control with duplicated ID " + (oSelector.id || oSelector);
+				const sErrorMessage = "Can't create a control with duplicated ID " + (oSelector.id || oSelector);
 				return Promise.reject(sErrorMessage);
 			}
 
-			var oPromise;
-			var oClassObject = sap.ui.require(sClassName);
-			if (oClassObject) {
-				oPromise = Promise.resolve(oClassObject);
-			} else {
-				oPromise = new Promise(function(fnResolve, fnReject) {
-					sap.ui.require([sClassName],
-						function(oClassObject) { fnResolve(oClassObject); },
-						function() {
-							fnReject(new Error("Required control '" + sClassName
-								+ "' couldn't be created asynchronously"));
-						}
-					);
-				});
-			}
-
-			return oPromise
-				.then(function(ClassObject) {
-					var sId = this.getControlIdBySelector(oSelector, oAppComponent);
-					return new ClassObject(sId, mSettings);
-				}.bind(this));
+			const ClassObject = sap.ui.require(sClassName) || await requireClass(sClassName);
+			const sId = this.getControlIdBySelector(oSelector, oAppComponent);
+			return new ClassObject(sId, mSettings);
 		},
 
 		/**
@@ -263,78 +253,76 @@ sap.ui.define([
 		/**
 		 * @inheritDoc
 		 */
-		_byId: function (sId) {
+		_byId: function(sId) {
 			return Element.getElementById(sId);
 		},
 
 		/**
 		 * @inheritDoc
 		 */
-		getId: function (oControl) {
+		getId: function(oControl) {
 			return oControl.getId();
 		},
 
 		/**
 		 * @inheritDoc
 		 */
-		getParent: function (oControl) {
-			return oControl.getParent && oControl.getParent();
+		getParent: function(oControl) {
+			return oControl.getParent?.();
 		},
 
 		/**
 		 * @inheritDoc
 		 */
-		getControlMetadata: function (oControl) {
-			return Promise.resolve(oControl && oControl.getMetadata());
+		getControlMetadata: function(oControl) {
+			return Promise.resolve(oControl?.getMetadata());
 		},
 
 		/**
 		 * @inheritDoc
 		 */
-		getControlType: function (oControl) {
-			return oControl && oControl.getMetadata().getName();
+		getControlType: function(oControl) {
+			return oControl?.getMetadata().getName();
 		},
 
 		/**
 		 * @inheritDoc
 		 */
-		setAssociation: function (vParent, sName, sId) {
-			var oMetadata = vParent.getMetadata().getAssociation(sName);
+		setAssociation: function(vParent, sName, sId) {
+			const oMetadata = vParent.getMetadata().getAssociation(sName);
 			oMetadata.set(vParent, sId);
 		},
 
 		/**
 		 * @inheritDoc
 		 */
-		getAssociation: function (vParent, sName) {
-			var oMetadata = vParent.getMetadata().getAssociation(sName);
+		getAssociation: function(vParent, sName) {
+			const oMetadata = vParent.getMetadata().getAssociation(sName);
 			return oMetadata.get(vParent);
 		},
 
 		/**
 		 * @inheritDoc
 		 */
-		getAllAggregations: function (oParent) {
+		getAllAggregations: function(oParent) {
 			return Promise.resolve(oParent.getMetadata().getAllAggregations());
 		},
 
 		/**
 		 * @inheritDoc
 		 */
-		getAggregation: function (oParent, sName) {
-			return this.findAggregation(oParent, sName)
-				.then(function (oAggregation) {
-					if (oAggregation) {
-						return oParent[oAggregation._sGetter]();
-					}
-					return undefined;
-				});
+		getAggregation: async function(oParent, sName) {
+			const oAggregation = await this.findAggregation(oParent, sName);
+			if (oAggregation) {
+				return oParent[oAggregation._sGetter]();
+			}
+			return undefined;
 		},
 
 		/**
 		 * @inheritDoc
 		 */
-		insertAggregation: async function (oParent, sName, oObject, iIndex) {
+		insertAggregation: async function(oParent, sName, oObject, iIndex) {
 			//special handling without invalidation for customData
 			if (sName === "customData") {
 				oParent.insertAggregation(sName, oObject, iIndex, /*bSuppressInvalidate=*/true);
@@ -354,7 +342,7 @@ sap.ui.define([
 		/**
 		 * @inheritDoc
 		 */
-		removeAggregation: async function (oParent, sName, oObject) {
+		removeAggregation: async function(oParent, sName, oObject) {
 			//special handling without invalidation for customData
 			if (sName === "customData") {
 				oParent.removeAggregation(sName, oObject, /*bSuppressInvalidate=*/true);
@@ -409,75 +397,66 @@ sap.ui.define([
 		/**
 		 * @inheritDoc
 		 */
-		removeAllAggregation: function (oControl, sName) {
+		removeAllAggregation: async function(oControl, sName) {
 			//special handling without invalidation for customData
 			if (sName === "customData") {
 				oControl.removeAllAggregation(sName, /*bSuppressInvalidate=*/true);
-				return Promise.resolve();
+			} else {
+				const oAggregation = await this.findAggregation(oControl, sName);
+				if (oAggregation) {
+					oControl[oAggregation._sRemoveAllMutator]();
+				}
 			}
-			return this.findAggregation(oControl, sName)
-				.then(function (oAggregation) {
-					if (oAggregation) {
-						oControl[oAggregation._sRemoveAllMutator]();
-					}
-				});
 		},
 
 		/**
 		 * @inheritDoc
 		 */
-		getBindingTemplate: function (oControl, sAggregationName) {
-			var oBinding = oControl.getBindingInfo(sAggregationName);
-			return Promise.resolve(oBinding && oBinding.template);
+		getBindingTemplate: function(oControl, sAggregationName) {
+			const oBinding = oControl.getBindingInfo(sAggregationName);
+			return Promise.resolve(oBinding?.template);
 		},
 
 		/**
 		 * @inheritDoc
 		 */
-		updateAggregation: function (oControl, sAggregationName) {
-			return this.findAggregation(oControl, sAggregationName)
-				.then(function (oAggregation) {
-					if (oAggregation && oControl.getBinding(sAggregationName)) {
-						oControl[oAggregation._sDestructor]();
-						oControl.updateAggregation(sAggregationName);
-					}
-				});
+		updateAggregation: async function(oControl, sAggregationName) {
+			const oAggregation = await this.findAggregation(oControl, sAggregationName);
+			if (oAggregation && oControl.getBinding(sAggregationName)) {
+				oControl[oAggregation._sDestructor]();
+				oControl.updateAggregation(sAggregationName);
+			}
 		},
 
 		/**
 		 * @inheritDoc
 		 */
-		findIndexInParentAggregation: function(oControl) {
-			var oParent = this.getParent(oControl);
+		findIndexInParentAggregation: async function(oControl) {
+			const oParent = this.getParent(oControl);
 
 			if (!oParent) {
-				return Promise.resolve(-1);
+				return -1;
 			}
 
-			return this.getParentAggregationName(oControl)
-				.then(function (sParentAggregationName) {
-					// we need all controls in the aggregation
-					return this.getAggregation(oParent, sParentAggregationName);
-				}.bind(this))
-				.then(function (aControlsInAggregation) {
-					// if aControls is an array:
-					if (Array.isArray(aControlsInAggregation)) {
-						// then the aggregtion is multiple and we can find the index of
-						// oControl in the array
-						return aControlsInAggregation.indexOf(oControl);
-					} else {
-						// if aControlsInAggregation is not an array, then the aggregation is
-						// of type 0..1 and aControlsInAggregation is the oControl provided
-						// to the function initially, so its index is 0
-						return 0;
-					}
-				});
+			const sParentAggregationName = await this.getParentAggregationName(oControl);
+			// we need all controls in the aggregation
+			const aControlsInAggregation = await this.getAggregation(oParent, sParentAggregationName);
+			// if aControls is an array:
+			if (Array.isArray(aControlsInAggregation)) {
+				// then the aggregation is multiple and we can find the index of oControl in the array
+				return aControlsInAggregation.indexOf(oControl);
+			} else {
+				// if aControlsInAggregation is not an array, then the aggregation is
+				// of type 0..1 and aControlsInAggregation is the oControl provided
+				// to the function initially, so its index is 0
+				return 0;
+			}
 		},
 
 		/**
 		 * @inheritDoc
 		 */
-		getParentAggregationName: function (oControl) {
+		getParentAggregationName: function(oControl) {
 			return Promise.resolve(oControl.sParentAggregationName);
 		},
 
@@ -485,71 +464,57 @@ sap.ui.define([
 		 * @inheritDoc
 		 */
 		findAggregation: function(oControl, sAggregationName) {
-			return new Promise(function (resolve, reject) {
-				if (oControl) {
-					if (oControl.getMetadata) {
-						var oMetadata = oControl.getMetadata();
-						var oAggregations = oMetadata.getAllAggregations();
-						if (oAggregations) {
-							resolve(oAggregations[sAggregationName]);
-							return;
-						}
-					}
-				}
-				resolve();
-			});
+			if (oControl?.getMetadata) {
+				const oMetadata = oControl.getMetadata();
+				const oAggregations = oMetadata.getAllAggregations();
+				return Promise.resolve(oAggregations[sAggregationName]);
+			}
+			return Promise.resolve(undefined);
 		},
 
 		/**
 		 * @inheritDoc
 		 */
-		validateType: function(oControl, oAggregationMetadata, oParent, sFragment) {
-			var sTypeOrInterface = oAggregationMetadata.type;
+		validateType: async function(oControl, oAggregationMetadata, oParent, sFragment) {
+			const sTypeOrInterface = oAggregationMetadata.type;
 
-			return this.getAggregation(oParent, oAggregationMetadata.name)
-				.then(function (oAggregation) {
-					// if aggregation is not multiple and already has element inside, then it is not valid for element
-					if (oAggregationMetadata.multiple === false && oAggregation && oAggregation.length > 0) {
-						return false;
-					}
-					return oControl.isA(sTypeOrInterface);
-				});
+			const oAggregation = await this.getAggregation(oParent, oAggregationMetadata.name);
+			// if aggregation is not multiple and already has element inside, then it is not valid for element
+			if (oAggregationMetadata.multiple === false && oAggregation && oAggregation.length > 0) {
+				return false;
+			}
+			return oControl.isA(sTypeOrInterface);
 		},
 
 		/**
 		 * @inheritDoc
 		 */
-		instantiateFragment: function(sFragment, sNamespace, oView) {
-			var oFragment = XMLHelper.parse(sFragment);
-
-			return this._checkAndPrefixIdsInFragment(oFragment, sNamespace)
-				.then(function (oFragment) {
-					return Fragment.load({
-						definition: oFragment,
-						sId: oView && oView.getId(),
-						controller: oView.getController()
-					});
-				}).then(function(vNewControls) {
-					if (vNewControls && !Array.isArray(vNewControls)) {
-						vNewControls = [vNewControls];
-					}
-					return vNewControls || [];
-				});
+		instantiateFragment: async function(sFragment, sNamespace, oView) {
+			const oInputFragment = XMLHelper.parse(sFragment);
+			const oFragment = await this._checkAndPrefixIdsInFragment(oInputFragment, sNamespace);
+			const vNewControls = await Fragment.load({
+				definition: oFragment,
+				sId: oView && oView.getId(),
+				controller: oView.getController()
+			});
+			if (vNewControls && !Array.isArray(vNewControls)) {
+				return [vNewControls];
+			}
+			return vNewControls || [];
 		},
 
 		/**
 		 * @inheritDoc
 		 */
-		templateControlFragment: function(sFragmentName, mPreprocessorSettings, oView) {
-			return BaseTreeModifier._templateFragment(
+		templateControlFragment: async function(sFragmentName, mPreprocessorSettings, oView) {
+			const oFragment = await BaseTreeModifier._templateFragment(
 				sFragmentName,
 				mPreprocessorSettings
-			).then(function(oFragment) {
-				var oController = (oView && oView.getController()) || undefined;
-				return Fragment.load({
-					definition: oFragment,
-					controller: oController
-				});
+			);
+			const oController = oView?.getController();
+			return Fragment.load({
+				definition: oFragment,
+				controller: oController
 			});
 		},
 
@@ -561,7 +526,7 @@ sap.ui.define([
 		},
 
 		_getFlexCustomData: function(oControl, sType) {
-			var oCustomData = typeof oControl === "object"
+			const oCustomData = typeof oControl === "object"
 				&& typeof oControl.data === "function"
 				&& oControl.data("sap-ui-custom-settings");
 			return ObjectPath.get(["sap.ui.fl", sType], oCustomData);
@@ -570,14 +535,14 @@ sap.ui.define([
 		/**
 		 * @inheritDoc
 		 */
-		bindAggregation: function (oControl, sAggregationName, oBindingInfo) {
+		bindAggregation: function(oControl, sAggregationName, oBindingInfo) {
 			return Promise.resolve(oControl.bindAggregation(sAggregationName, oBindingInfo));
 		},
 
 		/**
 		 * @inheritDoc
 		 */
-		unbindAggregation: function (oControl, sAggregationName) {
+		unbindAggregation: function(oControl, sAggregationName) {
 			// bSuppressReset is not supported
 			return Promise.resolve(oControl.unbindAggregation(sAggregationName));
 		},
@@ -585,25 +550,23 @@ sap.ui.define([
 		/**
 		 * @inheritDoc
 		 */
-		getExtensionPointInfo: function(sExtensionPointName, oView) {
-			var oViewNode = (oView._xContent) ? oView._xContent : oView;
-			return XmlTreeModifier.getExtensionPointInfo(sExtensionPointName, oViewNode)
-				.then(function (oExtensionPointInfo) {
-					if (oExtensionPointInfo) {
-						// decrease the index by 1 to get the index of the extension point itself for js-case
-						oExtensionPointInfo.index--;
-						oExtensionPointInfo.parent = oExtensionPointInfo.parent && this._byId(oView.createId(oExtensionPointInfo.parent.getAttribute("id")));
-						oExtensionPointInfo.defaultContent = oExtensionPointInfo.defaultContent
-							.map(function (oNode) {
-								var sId = oView.createId(oNode.getAttribute("id"));
-								return this._byId(sId);
-							}.bind(this))
-							.filter(function (oControl) {
-								return !!oControl;
-							});
-					}
-					return oExtensionPointInfo;
-				}.bind(this));
+		getExtensionPointInfo: async function(sExtensionPointName, oView) {
+			const oViewNode = (oView._xContent) ? oView._xContent : oView;
+			const oExtensionPointInfo = await XmlTreeModifier.getExtensionPointInfo(sExtensionPointName, oViewNode);
+			if (oExtensionPointInfo) {
+				// decrease the index by 1 to get the index of the extension point itself for js-case
+				oExtensionPointInfo.index--;
+				oExtensionPointInfo.parent = oExtensionPointInfo.parent && this._byId(oView.createId(oExtensionPointInfo.parent.getAttribute("id")));
+				oExtensionPointInfo.defaultContent = oExtensionPointInfo.defaultContent
+				.map((oNode) => {
+					const sId = oView.createId(oNode.getAttribute("id"));
+					return this._byId(sId);
+				})
+				.filter((oControl) => {
+					return !!oControl;
+				});
+			}
+			return oExtensionPointInfo;
 		}
 	};