@openui5/sap.ui.core 1.91.0 → 1.93.2

package/src/sap/ui/core/Placeholder.js

@@ -0,0 +1,173 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2021 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+sap.ui.define([
+	'sap/ui/base/Object',
+	'sap/base/util/LoaderExtensions',
+	'sap/ui/core/BlockLayerUtils'
+], function(
+	BaseObject,
+	LoaderExtensions,
+	BlockLayerUtils
+) {
+	"use strict";
+
+	// Array containing the registered provider functions
+	var aProviders = [];
+
+	/**
+	 * Creates and initializes a new Placeholder.
+	 */
+	var Placeholder = BaseObject.extend("sap.ui.core.Placeholder", /* @lends sap.ui.core.PlaceHolder */ {
+		/**
+		 * Creates a Placeholder instance. A path to a '.html' file containing the placeholder HTML content
+		 * must be provided.
+		 *
+		 * Note: As normal '.html' files are not bundled automatically it is recomended to use a HTMLFragment
+		 * definition '.fragment.html' instead.
+		 *
+		 * @example
+		 * new Placeholder({
+		 * 	html: 'myPlaceholder.fragment.html'
+		 * });
+		 *
+		 * @param {object} mParameters Object containing the placeholder HTML file name
+		 * @param {string} [mParameters.html] Name of the HTML file that provides the placeholder content
+		 *
+		 * @ui5-restricted sap.fe
+		 * @since 1.92
+		 * @public
+		 */
+		constructor : function(mParameters) {
+			BaseObject.call(this);
+
+			if (!mParameters.html) {
+				throw new Error("A HTML page defining the placeholders content must be given!");
+			}
+			this.bShow = false;
+			this.placeholderHTML = mParameters.html;
+		},
+
+		/**
+		 * Shows the placeholder content on the container control.
+		 *
+		 * @param {object} oControl The container control on which the placeholder is shown
+		 * @param {string} sBlockedSection The block section Id
+		 * @return {Promise} Returns a promise resolving with the placeholder content
+		 *
+		 * @private
+		 * @ui5-restricted sap.ui.core.routing
+		 */
+		show: function(oControl, sBlockedSection) {
+			this.bShow = true;
+			return this._load().then(function(sPlaceholderContent) {
+				// Because it's in a 'then' method the loading promise, it could happen that the 'hide' function is
+				// already called. Therefore it's need to check the 'this.bShow' flag before inserting the placeholder
+				// DOM element.
+				// The 'show' method can be called from a rerendering delegate of a control. It's checked here whether
+				// the DOM element of the control contains the placeholder. Only when the control doesn't have the
+				// placeholder, a new placeholder DOM element is generated and inserted into the control.
+				if (this.bShow && !oControl.getDomRef().contains(this.placeholder)) {
+					// unblock old blockstate when multiple rendering happens
+					if (this.blockState) {
+						BlockLayerUtils.unblock(this.blockState);
+					}
+					this.blockState = BlockLayerUtils.block(oControl, oControl.getId() + "--placeholder", sBlockedSection);
+
+					var oDomRef = this.blockState.$blockLayer[0];
+					oDomRef.className += " sapUiPlaceholder";
+					oDomRef.insertAdjacentHTML("beforeend", sPlaceholderContent);
+					this.placeholder = oDomRef;
+				}
+				return sPlaceholderContent;
+			}.bind(this));
+		},
+
+		/**
+		 * Hides the placeholder.
+		 *
+		 * @private
+		 * @ui5-restricted sap.ui.core.routing
+		 */
+		hide: function() {
+			this.bShow = false;
+			if (this.placeholder && this.blockState) {
+				BlockLayerUtils.unblock(this.blockState);
+				this.placeholder = undefined;
+				this.blockState = undefined;
+			}
+		},
+
+		/**
+		 * Loads the placeholder from given HTML file name.
+		 *
+		 * @return {Promise} Returns a promise resolving with the placeholder content
+		 * @private
+		 */
+		_load: function() {
+			if (!this.placeholderContent && this.placeholderHTML) {
+				return LoaderExtensions.loadResource(this.placeholderHTML, {
+					async: true,
+					dataType: "html"
+				}).then(function(sPlaceholder) {
+					this.placeholderContent = sPlaceholder;
+					return sPlaceholder;
+				}.bind(this));
+			} else {
+				return Promise.resolve(this.placeholderContent);
+			}
+		}
+	});
+
+	/**
+	 * Registers provider functions which allow to dynamically define the placeholder HTML files,
+	 * based on the routing configuration.
+	 *
+	 * @param  {function} fnProvider Provider function which provides the placeholder HTML file name
+	 *
+	 * @public
+	 * @ui5-restricted sap.fe
+	 * @since 1.92
+	 */
+	Placeholder.registerProvider = function(fnProvider) {
+		aProviders.push(fnProvider);
+	};
+
+	/**
+	 * Checks if provider functions have been registered.
+	 *
+	 * @return {boolean} Whether provider functions have been registered or not.
+	 * @private
+	 */
+	Placeholder.hasProviders = function() {
+		return aProviders.length > 0;
+	};
+
+	/**
+	 * Retrieves the placeholder HTML file for the given provider configuration
+	 *
+	 * The registered provider function must return an object providing
+	 * a html property that points to the placeholders HTML content.
+	 *
+	 * @param  {object} oConfig Configuration object containing the provider name
+	 * @return {object|undefined} If available, the config defined by the provider function will be returned
+	 *
+	 * @private
+	 */
+	Placeholder.getPlaceholderFromProviders = function(oConfig) {
+		var oProviderConfig;
+
+		if (oConfig) {
+			aProviders.some(function(fnProvider) {
+				oProviderConfig = fnProvider(oConfig);
+				return !!oProviderConfig;
+			});
+		}
+
+		return oProviderConfig;
+	};
+
+	return Placeholder;
+});

package/src/sap/ui/core/Popup.js

@@ -4,7 +4,7 @@
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 
- /* global Set, HTMLElement, ResizeObserver */
+ /* global Set, HTMLElement */
 
 // Provides helper class sap.ui.core.Popup
 sap.ui.define([
@@ -60,7 +60,6 @@ sap.ui.define([
 ) {
 	"use strict";
 
-
 	// shortcut for sap.ui.core.CSSSize
 	var CSSSize = library.CSSSize;
 
@@ -71,9 +70,33 @@ sap.ui.define([
 
 	var vGlobalWithinArea;
 
-	var oResizeObserver = new ResizeObserver(function(aEntries){
-		adaptSizeAndPosition(jQuery("#sap-ui-blocklayer-popup"), aEntries[0].target);
-	});
+	var oResizeObserver;
+	var sResizeHandlerIdAttribute = "sapUiPopupResize";
+
+	if (window.ResizeObserver) {
+		oResizeObserver = new window.ResizeObserver(function(aEntries){
+			adaptSizeAndPosition(jQuery("#sap-ui-blocklayer-popup"), aEntries[0].target);
+		});
+	} else {
+		oResizeObserver = {
+			observe: function(oElement) {
+				var sHandlerId = oElement.dataset[sResizeHandlerIdAttribute];
+				if (!sHandlerId) {
+					sHandlerId = ResizeHandler.register(oElement, function(oEvent) {
+						adaptSizeAndPosition(jQuery("#sap-ui-blocklayer-popup"), oEvent.target);
+					});
+					oElement.dataset[sResizeHandlerIdAttribute] = sHandlerId;
+				}
+			},
+			unobserve: function(oElement) {
+				var sHandlerId = oElement.dataset[sResizeHandlerIdAttribute];
+				if (sHandlerId) {
+					ResizeHandler.deregister(sHandlerId);
+					delete oElement.dataset[sResizeHandlerIdAttribute];
+				}
+			}
+		};
+	}
 
 	function getStaticUIArea() {
 		if (oStaticUIArea) {
@@ -2150,6 +2173,7 @@ sap.ui.define([
 	};
 
 	/**
+	 * @function
 	 * @public
 	 * @deprecated since 1.75, please use {@link #setExtraContent} instead.
 	 */