@openui5/sap.ui.core 1.93.3 → 1.96.2

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

@@ -13,7 +13,7 @@ sap.ui.define([
 	"sap/base/util/ObjectPath",
 	"sap/ui/util/XMLHelper",
 	"sap/base/util/merge",
-	"sap/ui/core/Fragment" // also needed to have sap.ui.xmlfragment
+	"sap/ui/core/Fragment"
 ], function (
 	BindingParser,
 	BaseTreeModifier,
@@ -56,9 +56,9 @@ sap.ui.define([
 		 */
 		getVisible: function (oControl) {
 			if (oControl.getVisible) {
-				return oControl.getVisible();
+				return Promise.resolve(oControl.getVisible());
 			} else {
-				throw new Error("Provided control instance has no getVisible method");
+				return Promise.reject(new Error("Provided control instance has no getVisible method"));
 			}
 		},
 
@@ -89,9 +89,15 @@ sap.ui.define([
 		 */
 		getStashed: function (oControl) {
 			if (oControl.isStashed) {
-				return oControl.isStashed() ? oControl.isStashed() : !this.getVisible(oControl);
+				if (oControl.isStashed()) {
+					return Promise.resolve(true);
+				}
+				return this.getVisible(oControl)
+					.then(function (bIsVisible) {
+						return !bIsVisible;
+					});
 			}
-			throw new Error("Provided control instance has no isStashed method");
+			return Promise.reject(new Error("Provided control instance has no isStashed method"));
 		},
 
 		/**
@@ -145,10 +151,12 @@ sap.ui.define([
 		 */
 		getProperty: function (oControl, sPropertyName) {
 			var oMetadata = oControl.getMetadata().getPropertyLikeSetting(sPropertyName);
+			var oProperty;
 			if (oMetadata) {
 				var sPropertyGetter = oMetadata._sGetter;
-				return oControl[sPropertyGetter]();
+				oProperty = oControl[sPropertyGetter]();
 			}
+			return Promise.resolve(oProperty);
 		},
 
 		/**
@@ -165,7 +173,7 @@ sap.ui.define([
 			this.unbindProperty(oControl, sPropertyName);
 			var mSettings = {};
 			mSettings[sPropertyName] = oPropertyBinding;
-			oControl.applySettings(mSettings);
+			return oControl.applySettings(mSettings);
 		},
 
 		/**
@@ -179,53 +187,42 @@ sap.ui.define([
 		 * @inheritDoc
 		 */
 		createAndAddCustomData: function(oControl, sCustomDataKey, sValue, oAppComponent) {
-			var oCustomData = this.createControl("sap.ui.core.CustomData", oAppComponent);
-			this.setProperty(oCustomData, "key", sCustomDataKey);
-			this.setProperty(oCustomData, "value", sValue);
-			this.insertAggregation(oControl, "customData", oCustomData, 0);
+			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));
 		},
 
 		/**
 		 * @inheritDoc
 		 */
-		createControl: function (sClassName, oAppComponent, oView, oSelector, mSettings, bAsync) {
-			var sErrorMessage;
-			if (this.bySelector(oSelector, oAppComponent)) {
-				sErrorMessage = "Can't create a control with duplicated ID " + (oSelector.id || oSelector);
-				if (bAsync) {
-					return Promise.reject(sErrorMessage);
+		createControl: function (sClassName, oAppComponent, oView, oSelector, mSettings) {
+			return new Promise(function(fnResolve, fnReject) {
+				if (this.bySelector(oSelector, oAppComponent)) {
+					var sErrorMessage = "Can't create a control with duplicated ID " + (oSelector.id || oSelector);
+					fnReject(sErrorMessage);
+					return;
 				}
-				throw new Error(sErrorMessage);
-			}
-
-			if (bAsync) {
-				return new Promise(function(fnResolve, fnReject) {
-					sap.ui.require([sClassName.replace(/\./g,"/")],
-						function(ClassObject) {
-							var sId = this.getControlIdBySelector(oSelector, oAppComponent);
-							fnResolve(new ClassObject(sId, mSettings));
-						}.bind(this),
-						function() {
-							fnReject(new Error("Required control '" + sClassName + "' couldn't be created asynchronously"));
-						}
-					);
-				}.bind(this));
-			}
+				sap.ui.require([sClassName.replace(/\./g,"/")],
+					function(ClassObject) {
+						var sId = this.getControlIdBySelector(oSelector, oAppComponent);
+						fnResolve(new ClassObject(sId, mSettings));
+					}.bind(this),
+					function() {
+						fnReject(new Error("Required control '" + sClassName + "' couldn't be created asynchronously"));
+					}
+				);
+			}.bind(this));
 
-			// in the synchronous case, object should already be preloaded
-			var ClassObject = ObjectPath.get(sClassName);
-			if (!ClassObject) {
-				throw new Error("Can't create a control because the matching class object has not yet been loaded. Please preload the '" + sClassName + "' module");
-			}
-			var sId = this.getControlIdBySelector(oSelector, oAppComponent);
-			return new ClassObject(sId, mSettings);
 		},
 
 		/**
 		 * @inheritDoc
 		 */
 		applySettings: function(oControl, mSettings) {
-			oControl.applySettings(mSettings);
+			return Promise.resolve(oControl.applySettings(mSettings));
 		},
 
 		/**
@@ -253,7 +250,7 @@ sap.ui.define([
 		 * @inheritDoc
 		 */
 		getControlMetadata: function (oControl) {
-			return oControl && oControl.getMetadata();
+			return Promise.resolve(oControl && oControl.getMetadata());
 		},
 
 		/**
@@ -283,17 +280,20 @@ sap.ui.define([
 		 * @inheritDoc
 		 */
 		getAllAggregations: function (oParent) {
-			return oParent.getMetadata().getAllAggregations();
+			return Promise.resolve(oParent.getMetadata().getAllAggregations());
 		},
 
 		/**
 		 * @inheritDoc
 		 */
 		getAggregation: function (oParent, sName) {
-			var oAggregation = this.findAggregation(oParent, sName);
-			if (oAggregation) {
-				return oParent[oAggregation._sGetter]();
-			}
+			return this.findAggregation(oParent, sName)
+				.then(function (oAggregation) {
+					if (oAggregation) {
+						return oParent[oAggregation._sGetter]();
+					}
+					return undefined;
+				});
 		},
 
 		/**
@@ -302,19 +302,19 @@ sap.ui.define([
 		insertAggregation: function (oParent, sName, oObject, iIndex) {
 			//special handling without invalidation for customData
 			if ( sName === "customData"){
-				oParent.insertAggregation(sName, oObject, iIndex, /*bSuppressInvalidate=*/true);
-			} else {
-				var oAggregation = this.findAggregation(oParent, sName);
-				if (oAggregation) {
-					if (oAggregation.multiple) {
-						var iInsertIndex = iIndex || 0;
-						oParent[oAggregation._sInsertMutator](oObject, iInsertIndex);
-					} else {
-						oParent[oAggregation._sMutator](oObject);
-					}
-				}
+				return oParent.insertAggregation(sName, oObject, iIndex, /*bSuppressInvalidate=*/true);
 			}
-
+			return this.findAggregation(oParent, sName)
+				.then(function (oAggregation) {
+					if (oAggregation) {
+						if (oAggregation.multiple) {
+							var iInsertIndex = iIndex || 0;
+							oParent[oAggregation._sInsertMutator](oObject, iInsertIndex);
+						} else {
+							oParent[oAggregation._sMutator](oObject);
+						}
+					}
+				});
 		},
 
 		/**
@@ -324,12 +324,14 @@ sap.ui.define([
 			//special handling without invalidation for customData
 			if ( sName === "customData"){
 				oControl.removeAggregation(sName, oObject, /*bSuppressInvalidate=*/true);
-			} else {
-				var oAggregation = this.findAggregation(oControl, sName);
-				if (oAggregation) {
-					oControl[oAggregation._sRemoveMutator](oObject);
-				}
+				return Promise.resolve();
 			}
+			return this.findAggregation(oControl, sName)
+				.then(function (oAggregation) {
+					if (oAggregation) {
+						oControl[oAggregation._sRemoveMutator](oObject);
+					}
+				});
 		},
 
 		/**
@@ -339,12 +341,14 @@ sap.ui.define([
 			//special handling without invalidation for customData
 			if ( sName === "customData"){
 				oControl.removeAllAggregation(sName, /*bSuppressInvalidate=*/true);
-			} else {
-				var oAggregation = this.findAggregation(oControl, sName);
-				if (oAggregation) {
-					oControl[oAggregation._sRemoveAllMutator]();
-				}
+				return Promise.resolve();
 			}
+			return this.findAggregation(oControl, sName)
+				.then(function (oAggregation) {
+					if (oAggregation) {
+						oControl[oAggregation._sRemoveAllMutator]();
+					}
+				});
 		},
 
 		/**
@@ -352,67 +356,76 @@ sap.ui.define([
 		 */
 		getBindingTemplate: function (oControl, sAggregationName) {
 			var oBinding = oControl.getBindingInfo(sAggregationName);
-			return oBinding && oBinding.template;
+			return Promise.resolve(oBinding && oBinding.template);
 		},
 
 		/**
 		 * @inheritDoc
 		 */
 		updateAggregation: function (oControl, sAggregationName) {
-			var oAggregation = this.findAggregation(oControl, sAggregationName);
-			if (oAggregation && oControl.getBinding(sAggregationName)) {
-				oControl[oAggregation._sDestructor]();
-				oControl.updateAggregation(sAggregationName);
-			}
+			return this.findAggregation(oControl, sAggregationName)
+				.then(function (oAggregation) {
+					if (oAggregation && oControl.getBinding(sAggregationName)) {
+						oControl[oAggregation._sDestructor]();
+						oControl.updateAggregation(sAggregationName);
+					}
+				});
 		},
 
 		/**
 		 * @inheritDoc
 		 */
 		findIndexInParentAggregation: function(oControl) {
-			var oParent = this.getParent(oControl),
-				aControlsInAggregation;
+			var oParent = this.getParent(oControl);
 
 			if (!oParent) {
-				return -1;
+				return Promise.resolve(-1);
 			}
 
-			// we need all controls in the aggregation
-			aControlsInAggregation = this.getAggregation(oParent, this.getParentAggregationName(oControl));
-
-			// 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;
-			}
+			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;
+					}
+				});
 		},
 
 		/**
 		 * @inheritDoc
 		 */
 		getParentAggregationName: function (oControl) {
-			return oControl.sParentAggregationName;
+			return Promise.resolve(oControl.sParentAggregationName);
 		},
 
 		/**
 		 * @inheritDoc
 		 */
 		findAggregation: function(oControl, sAggregationName) {
-			if (oControl) {
-				if (oControl.getMetadata) {
-					var oMetadata = oControl.getMetadata();
-					var oAggregations = oMetadata.getAllAggregations();
-					if (oAggregations) {
-						return oAggregations[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();
+			});
 		},
 
 		/**
@@ -421,12 +434,14 @@ sap.ui.define([
 		validateType: function(oControl, oAggregationMetadata, oParent, sFragment) {
 			var sTypeOrInterface = oAggregationMetadata.type;
 
-			// if aggregation is not multiple and already has element inside, then it is not valid for element
-			if (oAggregationMetadata.multiple === false && this.getAggregation(oParent, oAggregationMetadata.name) &&
-					this.getAggregation(oParent, oAggregationMetadata.name).length > 0) {
-				return false;
-			}
-			return oControl.isA(sTypeOrInterface);
+			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);
+				});
 		},
 
 		/**
@@ -434,20 +449,20 @@ sap.ui.define([
 		 */
 		instantiateFragment: function(sFragment, sNamespace, oView) {
 			var oFragment = XMLHelper.parse(sFragment);
-			oFragment = this._checkAndPrefixIdsInFragment(oFragment, sNamespace);
-
-			var aNewControls;
-			var sId = oView && oView.getId();
-			var oController = oView.getController();
-			aNewControls = sap.ui.xmlfragment({
-				fragmentContent: oFragment,
-				sId:sId
-			}, oController);
-
-			if (!Array.isArray(aNewControls)) {
-				aNewControls = [aNewControls];
-			}
-			return aNewControls;
+
+			return this._checkAndPrefixIdsInFragment(oFragment, sNamespace)
+				.then(function (oFragment) {
+					return Fragment.load({
+						definition: oFragment,
+						sId: oView && oView.getId(),
+						controller: oView.getController()
+					});
+				}).then(function(aNewControls) {
+					if (!Array.isArray(aNewControls)) {
+						aNewControls = [aNewControls];
+					}
+					return aNewControls;
+				});
 		},
 
 		/**
@@ -484,35 +499,35 @@ sap.ui.define([
 		 * @inheritDoc
 		 */
 		attachEvent: function (oObject, sEventName, sFunctionPath, vData) {
-			var fnCallback = ObjectPath.get(sFunctionPath);
-
-			if (typeof fnCallback !== "function") {
-				throw new Error("Can't attach event because the event handler function is not found or not a function.");
-			}
-
-			oObject.attachEvent(sEventName, vData, fnCallback);
+			return new Promise(function (fnResolve, fnReject) {
+				var fnCallback = ObjectPath.get(sFunctionPath);
+				if (typeof fnCallback !== "function") {
+					fnReject(new Error("Can't attach event because the event handler function is not found or not a function."));
+				}
+				fnResolve(oObject.attachEvent(sEventName, vData, fnCallback));
+			});
 		},
 
 		/**
 		 * @inheritDoc
 		 */
 		detachEvent: function (oObject, sEventName, sFunctionPath) {
-			var fnCallback = ObjectPath.get(sFunctionPath);
-
-			if (typeof fnCallback !== "function") {
-				throw new Error("Can't attach event because the event handler function is not found or not a function.");
-			}
-
-			// EventProvider.detachEvent doesn't accept vData parameter, therefore it might lead
-			// to a situation when an incorrect event listener is detached.
-			oObject.detachEvent(sEventName, fnCallback);
+			return new Promise(function (fnResolve, fnReject) {
+				var fnCallback = ObjectPath.get(sFunctionPath);
+				if (typeof fnCallback !== "function") {
+					fnReject(new Error("Can't attach event because the event handler function is not found or not a function."));
+				}
+				// EventProvider.detachEvent doesn't accept vData parameter, therefore it might lead
+				// to a situation when an incorrect event listener is detached.
+				fnResolve(oObject.detachEvent(sEventName, fnCallback));
+			});
 		},
 
 		/**
 		 * @inheritDoc
 		 */
 		bindAggregation: function (oControl, sAggregationName, oBindingInfo) {
-			oControl.bindAggregation(sAggregationName, oBindingInfo);
+			return Promise.resolve(oControl.bindAggregation(sAggregationName, oBindingInfo));
 		},
 
 		/**
@@ -520,7 +535,7 @@ sap.ui.define([
 		 */
 		unbindAggregation: function (oControl, sAggregationName) {
 			// bSuppressReset is not supported
-			oControl.unbindAggregation(sAggregationName);
+			return Promise.resolve(oControl.unbindAggregation(sAggregationName));
 		},
 
 		/**
@@ -528,21 +543,23 @@ sap.ui.define([
 		 */
 		getExtensionPointInfo: function(sExtensionPointName, oView) {
 			var oViewNode = (oView._xContent) ? oView._xContent : oView;
-			var oExtensionPointInfo = 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(function (oNode) {
-						var sId = oView.createId(oNode.getAttribute("id"));
-						return this._byId(sId);
-					}.bind(this))
-					.filter(function (oControl) {
-						return !!oControl;
-					});
-			}
-			return oExtensionPointInfo;
+			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));
 		}
 	};