@openui5/sap.ui.core 1.105.1 → 1.107.0

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

@@ -0,0 +1,251 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+
+// Provides class sap.ui.core.Rendering
+sap.ui.define([
+	"sap/base/Log",
+	"sap/ui/base/EventProvider",
+	"sap/ui/performance/trace/Interaction",
+	"sap/ui/performance/Measurement"
+], function(
+	Log,
+	EventProvider,
+	Interaction,
+	Measurement
+) {
+	"use strict";
+
+	/**
+	 * A private logger instance used for 'debugRendering' logging.
+	 *
+	 * It can be activated by setting the URL parameter sap-ui-xx-debugRerendering to true.
+	 * If activated, stack traces of invalidate() calls will be recorded and if new
+	 * invalidations occur during rendering, they will be logged to the console together
+	 * with the causing stack traces.
+	 *
+	 * @private
+	 */
+	var oRenderLog = Log.getLogger("sap.ui.Rendering",
+			(
+				// Note that the sap-ui-config option still is expected in camel case.
+				// Lower case is only accepted here because of the config normalization which will be removed in future
+				(window["sap-ui-config"] && (window["sap-ui-config"]["xx-debugRendering"] || window["sap-ui-config"]["xx-debugrendering"]) )
+				|| /sap-ui-xx-debug(R|-r)endering=(true|x|X)/.test(document.location.search)
+			) ? Log.Level.DEBUG : Math.min(Log.Level.INFO, Log.getLevel())
+		);
+
+	var MAX_RENDERING_ITERATIONS = 20;
+
+	/**
+	 * The ID of a timer that will execute the next rendering.
+	 *
+	 * A non-falsy value indicates that a timer exists already, or at least that no
+	 * new timer needs to be created as. During the boot phase, this member is set
+	 * to the special value <code>this</code> which is non-falsy and which should never
+	 * represent a valid timer ID (no chance of misinterpretation).
+	 */
+	var _sRerenderTimer = this; //eslint-disable-line consistent-this
+
+	var mUIAreas = {};
+
+	/**
+	 * Tasks that are called just before the rendering starts.
+	 * @private
+	 */
+	var aPrerenderingTasks = [];
+
+	var _oEventProvider = new EventProvider();
+
+	var _bRendering = false;
+
+	function _renderPendingUIUpdates(sCaller) {
+		// start performance measurement
+		Measurement.start("renderPendingUIUpdates","Render pending UI updates in all UIAreas");
+
+		oRenderLog.debug("Render pending UI updates: start (" + (sCaller || "by timer" ) + ")");
+
+		var bUIUpdated = false,
+			bLooped = MAX_RENDERING_ITERATIONS > 0,
+			iLoopCount = 0;
+
+		_bRendering = true;
+
+		do {
+
+			if ( bLooped ) {
+				// try to detect long running ('endless') rendering loops
+				iLoopCount++;
+				// if we run another iteration despite the tracking mode, we complain ourselves
+				if ( iLoopCount > MAX_RENDERING_ITERATIONS ) {
+					_bRendering = false;
+					throw new Error("Rendering has been re-started too many times (" + iLoopCount + "). Add URL parameter sap-ui-xx-debugRendering=true for a detailed analysis.");
+				}
+
+				if ( iLoopCount > 1 ) {
+					oRenderLog.debug("Render pending UI updates: iteration " + iLoopCount);
+				}
+			}
+
+			// clear a pending timer so that the next call to re-render will create a new timer
+			if (_sRerenderTimer) {
+				if ( _sRerenderTimer !== this ) { // 'this' is used as a marker for a delayed initial rendering, no timer to cleanup then
+					clearTimeout(_sRerenderTimer); // explicitly stop the timer, as this call might be a synchronous call (applyChanges) while still a timer is running
+				}
+				_sRerenderTimer = undefined;
+				if (Rendering.aFnDone.length > 0) {
+					Rendering.aFnDone.pop()();
+				}
+			}
+
+			runPrerenderingTasks();
+
+			var mUIAreasSnapshot = mUIAreas;
+			mUIAreas = {};
+			for (var sId in mUIAreasSnapshot) {
+				bUIUpdated = mUIAreasSnapshot[sId].rerender() || bUIUpdated;
+			}
+
+		// eslint-disable-next-line no-unmodified-loop-condition
+		} while ( bLooped && _sRerenderTimer ); // iterate if there are new rendering tasks
+
+		_bRendering = false;
+
+		// TODO: Provide information on what actually was re-rendered...
+		if (bUIUpdated) {
+			Rendering.fireUIUpdated();
+		}
+
+		oRenderLog.debug("Render pending UI updates: finished");
+
+		// end performance measurement
+		Measurement.end("renderPendingUIUpdates");
+	}
+
+	var Rendering = {
+		// to protect against nested rendering we use an array of Steps instead of a single one
+		aFnDone: [],
+
+		/**
+		 * Notify async Interaction step.
+		 *
+		 * @private
+		 * @ui5-restricted sap.ui.core.Core
+		 */
+		notifyInteractionStep: function () {
+			Rendering.aFnDone.push(Interaction.notifyAsyncStep());
+		},
+
+		/**
+		 * Adds a task that is guaranteed to run once, just before the next rendering. A rendering
+		 * request is not triggered.
+		 *
+		 * @param {function} fnPrerenderingTask
+		 *   A function that is called before the rendering
+		 * @param {boolean} [bFirst=false]
+		 *   Whether the task should become the first one, not the last one
+		 * @private
+		 */
+		addPrerenderingTask: function (fnPrerenderingTask, bFirst) {
+			if (bFirst) {
+				aPrerenderingTasks.unshift(fnPrerenderingTask);
+			} else {
+				aPrerenderingTasks.push(fnPrerenderingTask);
+			}
+		},
+		/**
+		 * Asks all UIAreas to execute any pending rendering tasks.
+		 *
+		 * The execution of rendering tasks might require multiple iterations
+		 * until either no more rendering tasks are produced or until
+		 * MAX_RENDERING_ITERATIONS are reached.
+		 *
+		 * With a value of MAX_RENDERING_ITERATIONS=0 the loop can be avoided
+		 * and the remaining tasks are executed after another timeout.
+		 *
+		 * @param {string} sCaller The Caller id
+		 * @private
+		 */
+		renderPendingUIUpdates: function(sCaller, iTimeout) {
+			if (iTimeout !== undefined) {
+				_sRerenderTimer = setTimeout(_renderPendingUIUpdates.bind(null, sCaller), iTimeout);
+			} else {
+				Rendering.aFnDone.push(Interaction.notifyAsyncStep());
+				_renderPendingUIUpdates(sCaller);
+			}
+		},
+		/**
+		 * Returns <code>true</code> if there are any pending rendering tasks or when
+		 * such rendering tasks are currently being executed.
+		 *
+		 * @return {boolean} true if there are pending (or executing) rendering tasks.
+		 * @private
+		 */
+		getUIDirty: function() {
+			return !!(_sRerenderTimer || _bRendering);
+		},
+
+		/**
+		 * @name sap.ui.core.Core#UIUpdated
+		 * @event
+		 * @private
+		 * @function
+		 */
+
+		attachUIUpdated: function(fnFunction, oListener) {
+			_oEventProvider.attachEvent("UIUpdated", fnFunction, oListener);
+		},
+
+		detachUIUpdated: function(fnFunction, oListener) {
+			_oEventProvider.detachEvent("UIUpdated", fnFunction, oListener);
+		},
+
+		fireUIUpdated: function(mParameters) {
+			_oEventProvider.fireEvent("UIUpdated", mParameters);
+		},
+
+		/**
+		 * Returns the internal rendering Logger.
+		 *
+		 * @returns {sap.base.Log} The Rendering logger
+		 * @private
+		 */
+		getLogger: function() {
+			return oRenderLog;
+		},
+
+		/**
+		 * Registers an invalidated UIArea for rerendering.
+		 *
+		 * @param {sap.ui.core.UIArea} oUIArea The invalidated UIArea
+		 * @private
+		 */
+		invalidateUIArea: function(oUIArea) {
+			mUIAreas[oUIArea.getId()] = oUIArea;
+			if ( !_sRerenderTimer ) {
+				// TODO: we should handle xx-waitForTheme here...
+				oRenderLog.debug("Registering timer for delayed re-rendering");
+				// start async interaction step
+				Rendering.aFnDone.push(Interaction.notifyAsyncStep());
+				Rendering.renderPendingUIUpdates('invalidated UIArea', 0); // decoupled for collecting several invalidations into one redraw
+			}
+		}
+	};
+
+	/**
+	 * Runs all prerendering tasks and resets the list.
+	 * @private
+	 */
+	function runPrerenderingTasks() {
+		var aTasks = aPrerenderingTasks.slice();
+
+		aPrerenderingTasks = [];
+		aTasks.forEach(function (fnPrerenderingTask) {
+			fnPrerenderingTask();
+		});
+	}
+
+	return Rendering;
+});

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

@@ -33,7 +33,7 @@ sap.ui.define([
 	 * @alias sap.ui.core.ResizeHandler
 	 * @extends sap.ui.base.Object
 	 * @author SAP SE
-	 * @version 1.105.1
+	 * @version 1.107.0
 	 * @public
 	 */
 
@@ -98,7 +98,7 @@ sap.ui.define([
 	 *
 	 * @param {Element|sap.ui.core.Control} oRef the DOM reference or a control
 	 * @param {function} fHandler the event handler function
-	 * @return {string} Registration-ID for later detaching.
+	 * @returns {string} Registration-ID for later detaching.
 	 * @private
 	 */
 	ResizeHandler.prototype.attachListener = function(oRef, fHandler){
@@ -227,7 +227,7 @@ sap.ui.define([
 	 * @param {function} fHandler
 	 *             The event handler which should be called whenever the size of the given reference is changed.
 	 *             The event object is passed as first argument to the event handler. See the description of this function for more details about the available parameters of this event.
-	 * @return {string}
+	 * @returns {string|null}
 	 *             A registration ID which can be used for deregistering the event handler, see {@link sap.ui.core.ResizeHandler.deregister}.
 	 *             If the UI5 framework is not yet initialized <code>null</code> is returned.
 	 * @public
@@ -265,7 +265,7 @@ sap.ui.define([
 	/**
 	 * Suspends indefinitely the execution of ResizeHandler listeners for the given DOM reference and its children
 	 * @param {Element} oDomRef the DOM reference to suspend
-	 * @return {boolean} Whether the <code>oDomRef</code> was successfully marked as suspended
+	 * @returns {boolean} Whether the <code>oDomRef</code> was successfully marked as suspended
 	 * @private
 	 */
 	ResizeHandler.suspend = function(oDomRef) {
@@ -285,7 +285,7 @@ sap.ui.define([
 	/**
 	 * Resumes the execution of ResizeHandler listeners for the given DOM reference
 	 * @param {Element} oDomRef the DOM reference to resume
-	 * @return {boolean} Whether resume for <code>oDomRef</code> was successful
+	 * @returns {boolean} Whether resume for <code>oDomRef</code> was successful
 	 * @private
 	 */
 	ResizeHandler.resume = function(oDomRef) {
@@ -316,7 +316,7 @@ sap.ui.define([
 	 * Checks if the given DOM reference is a child (or exact match) of a DOM area that is suspended from observation for size changes.
 	 * This instance method is an internal shortcut.
 	 * @param {Element} oDomRef the DOM reference
-	 * @return {boolean} Whether the <code>oDomRef</code> is suspended
+	 * @returns {boolean} Whether the <code>oDomRef</code> is suspended
 	 * @private
 	 */
 	ResizeHandler.prototype._isSuspended = function(oDomRef) {
@@ -338,7 +338,7 @@ sap.ui.define([
 	 * @param {function} [fnCallback] a callback function to be called once the DOM node is resumed which was found to be the primary
 	 *        reason for oDomRef to be suspended. Note that isSuspended() may still be true when other DOM nodes are still suspended.
 	 *        Also note that each isSuspended() call registers the callback, but only if it was not found to be already registered.
-	 * @return {boolean} Whether the <code>oDomRef</code> is suspended
+	 * @returns {boolean} Whether the <code>oDomRef</code> is suspended
 	 * @private
 	 */
 	ResizeHandler.isSuspended = function(oDomRef, fnCallback) {

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

@@ -13,7 +13,8 @@ sap.ui.define([
 	"sap/ui/performance/trace/Interaction",
 	"sap/base/Log",
 	"sap/ui/events/jquery/EventSimulation",
-	"sap/ui/thirdparty/jquery"
+	"sap/ui/thirdparty/jquery",
+	"sap/ui/core/Configuration"
 ],
 	function(
 		Device,
@@ -23,7 +24,8 @@ sap.ui.define([
 		Interaction,
 		Log,
 		EventSimulation,
-		jQuery
+		jQuery,
+		Configuration
 	) {
 	"use strict";
 
@@ -42,12 +44,11 @@ sap.ui.define([
 	 * The ScrollBar control can be used for virtual scrolling of a certain area.
 	 * This means: to simulate a very large scrollable area when technically the area is small and the control takes care of displaying the respective part only. E.g. a Table control can take care of only rendering the currently visible rows and use this ScrollBar control to make the user think he actually scrolls through a long list.
 	 * @extends sap.ui.core.Control
-	 * @version 1.105.1
+	 * @version 1.107.0
 	 *
 	 * @public
 	 * @deprecated as of version 1.56
 	 * @alias sap.ui.core.ScrollBar
-	 * @ui5-metamodel This control/element also will be described in the UI5 (legacy) designtime metamodel
 	 */
 	var ScrollBar = Control.extend("sap.ui.core.ScrollBar", /** @lends sap.ui.core.ScrollBar.prototype */ {
 		metadata : {
@@ -146,7 +147,7 @@ sap.ui.define([
 		this._bScrollPosIsChecked = false;
 
 		// RTL mode
-		this._bRTL = sap.ui.getCore().getConfiguration().getRTL();
+		this._bRTL = Configuration.getRTL();
 
 		// suppress scroll event
 		this._bSuppressScroll = false;
@@ -523,7 +524,6 @@ sap.ui.define([
 	 * @param {string} oOwnerDomRef
 	 *         Dom ref of the Control that uses the scrollbar
 	 * @public
-	 * @ui5-metamodel This method also will be described in the UI5 (legacy) designtime metamodel
 	 */
 	ScrollBar.prototype.unbind = function (oOwnerDomRef) {
 		if (oOwnerDomRef) {
@@ -547,7 +547,6 @@ sap.ui.define([
 	 * @param {string} oOwnerDomRef
 	 *         Dom ref of the control that uses the scrollbar
 	 * @public
-	 * @ui5-metamodel This method also will be described in the UI5 (legacy) designtime metamodel
 	 */
 	ScrollBar.prototype.bind = function (oOwnerDomRef) {
 		if (oOwnerDomRef) {
@@ -581,7 +580,6 @@ sap.ui.define([
 	 * Page Up is used to scroll one page back.
 	 *
 	 * @public
-	 * @ui5-metamodel This method also will be described in the UI5 (legacy) designtime metamodel
 	 */
 	ScrollBar.prototype.pageUp = function() {
 		// call on scroll
@@ -592,7 +590,6 @@ sap.ui.define([
 	 * Page Down is used to scroll one page forward.
 	 *
 	 * @public
-	 * @ui5-metamodel This method also will be described in the UI5 (legacy) designtime metamodel
 	 */
 	ScrollBar.prototype.pageDown = function() {
 		// call on scroll

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

@@ -5,8 +5,8 @@
  */
 
 // A renderer for the ScrollBar control
-sap.ui.define(['sap/ui/Device', "sap/ui/dom/getScrollbarSize"],
-	function(Device, getScrollbarSize) {
+sap.ui.define(['sap/ui/Device', "sap/ui/dom/getScrollbarSize", "sap/ui/core/Configuration"],
+	function(Device, getScrollbarSize, Configuration) {
 	"use strict";
 
 
@@ -27,7 +27,7 @@ sap.ui.define(['sap/ui/Device', "sap/ui/dom/getScrollbarSize"],
 	 * @param {sap.ui.core.ScrollBar} oControl Object representation of the control that should be rendered
 	 */
 	ScrollBarRenderer.render = function(oRM, oScrollBar){
-		var bRTL = sap.ui.getCore().getConfiguration().getRTL();
+		var bRTL = Configuration.getRTL();
 
 		oRM.openStart("div", oScrollBar);
 		oRM.class("sapUiScrollBar");

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

@@ -23,11 +23,10 @@ sap.ui.define(['./Item', './library'],
 	 * @extends sap.ui.core.Item
 	 *
 	 * @author SAP SE
-	 * @version 1.105.1
+	 * @version 1.107.0
 	 *
 	 * @public
 	 * @alias sap.ui.core.SeparatorItem
-	 * @ui5-metamodel This control/element also will be described in the UI5 (legacy) designtime metamodel
 	 */
 	var SeparatorItem = Item.extend("sap.ui.core.SeparatorItem", /** @lends sap.ui.core.SeparatorItem.prototype */ { metadata : {
 

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

@@ -25,12 +25,11 @@ sap.ui.define(['./Element', './library'],
 	 * @extends sap.ui.core.Element
 	 *
 	 * @author SAP SE
-	 * @version 1.105.1
+	 * @version 1.107.0
 	 *
 	 * @public
 	 * @since 1.16.0
 	 * @alias sap.ui.core.Title
-	 * @ui5-metamodel This control/element also will be described in the UI5 (legacy) designtime metamodel
 	 */
 	var Title = Element.extend("sap.ui.core.Title", /** @lends sap.ui.core.Title.prototype */ { metadata : {
 

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

@@ -7,14 +7,13 @@
 // Provides control sap.ui.core.TooltipBase.
 sap.ui.define([
 	'./Control',
+	'./Element',
 	'./Popup',
 	'./library',
 	"sap/ui/events/KeyCodes",
-	"sap/ui/thirdparty/jquery",
-	// jQuery Plugin "control"
-	"sap/ui/dom/jquery/control"
+	"sap/ui/thirdparty/jquery"
 ],
-	function(Control, Popup, library, KeyCodes, jQuery) {
+	function(Control, Element, Popup, library, KeyCodes, jQuery) {
 	"use strict";
 
 
@@ -31,11 +30,10 @@ sap.ui.define([
 	 * @class
 	 * Abstract class that can be extended in order to implement any extended tooltip. For example, RichTooltip Control is based on it. It provides the opening/closing behavior and the main "text" property.
 	 * @extends sap.ui.core.Control
-	 * @version 1.105.1
+	 * @version 1.107.0
 	 *
 	 * @public
 	 * @alias sap.ui.core.TooltipBase
-	 * @ui5-metamodel This control/element also will be described in the UI5 (legacy) designtime metamodel
 	 */
 	var TooltipBase = Control.extend("sap.ui.core.TooltipBase", /** @lends sap.ui.core.TooltipBase.prototype */ {
 		metadata : {
@@ -124,7 +122,7 @@ sap.ui.define([
 	 */
 	TooltipBase.prototype.onfocusin = function(oEvent) {
 
-		var oSC = jQuery(oEvent.target).control(0);
+		var oSC = Element.closestTo(oEvent.target);
 		if (oSC != null) {
 			var oDomRef = oSC.getFocusDomRef();
 			this.sStoredTooltip = null;
@@ -156,7 +154,7 @@ sap.ui.define([
 	 * @private
 	 */
 	TooltipBase.prototype.onfocusout = function(oEvent) {
-		var oSC = jQuery(oEvent.target).control(0);
+		var oSC = Element.closestTo(oEvent.target);
 		if (oSC != null) {
 
 			var oDomRef = oSC.getFocusDomRef();
@@ -204,10 +202,10 @@ sap.ui.define([
 	 */
 	TooltipBase.prototype.onmouseover = function(oEvent) {
 
-		var oEventSource = jQuery(oEvent.target).control(0), // The Element or Control that initiated the event.
-			oCurrentElement = jQuery(oEvent.currentTarget).control(0), // The current Element or Control within the event bubbling phase.
-			oLeftElement = jQuery(oEvent.relatedTarget).control(0); // Indicates the element being exited.
-		// Log.debug("MOUSE OVER    " +  oEventSource + "  " + jQuery(oEvent.currentTarget).control(0) + "   " + this._currentControl.getId());
+		var oEventSource = Element.closestTo(oEvent.target), // The Element or Control that initiated the event.
+			oCurrentElement = Element.closestTo(oEvent.currentTarget), // The current Element or Control within the event bubbling phase.
+			oLeftElement = Element.closestTo(oEvent.relatedTarget); // Indicates the element being exited.
+		// Log.debug("MOUSE OVER    " +  oEventSource + "  " + Element.closestTo(oEvent.currentTarget) + "   " + this._currentControl.getId());
 
 		if (!oEventSource) {
 			return;
@@ -278,7 +276,7 @@ sap.ui.define([
 	 * @private
 	 */
 	TooltipBase.prototype.onmouseout = function(oEvent) {
-		// Log.debug("MOUSE OUT    " + jQuery(oEvent.target).control(0) + "   "+ jQuery(oEvent.currentTarget).control(0) );
+		// Log.debug("MOUSE OUT    " + Element.closestTo(oEvent.target) + "   " + Element.closestTo(oEvent.currentTarget) );
 		if (TooltipBase.sOpenTimeout) {
 			clearTimeout(TooltipBase.sOpenTimeout);
 			TooltipBase.sOpenTimeout = undefined;
@@ -444,7 +442,7 @@ sap.ui.define([
 		if (oEvent.ctrlKey && oEvent.which == KeyCodes.I) {
 			// The Element or Control that initiated the event.
 
-			var oEventSource = jQuery(oEvent.target).control(0);
+			var oEventSource = Element.closestTo(oEvent.target);
 			if (oEventSource != null) {
 				// If the current control is the event source or event source does not have a standard tooltip
 				if (this._currentControl === oEventSource || !this.isStandardTooltip(oEventSource.getTooltip())) {