@openui5/sap.ui.core 1.119.0 → 1.120.0

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

@@ -10,12 +10,12 @@ sap.ui.define([
 	"sap/ui/base/EventProvider",
 	"sap/ui/performance/trace/Interaction",
 	"sap/ui/performance/Measurement"
-], function(
+], (
 	Log,
 	EventProvider,
 	Interaction,
 	Measurement
-) {
+) => {
 	"use strict";
 
 	/**
@@ -28,7 +28,7 @@ sap.ui.define([
 	 *
 	 * @private
 	 */
-	var oRenderLog = Log.getLogger("sap.ui.Rendering",
+	const 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
@@ -37,31 +37,31 @@ sap.ui.define([
 			) ? Log.Level.DEBUG : Math.min(Log.Level.INFO, Log.getLevel())
 		);
 
-	var MAX_RENDERING_ITERATIONS = 20;
-
-	var _sRerenderTimer;
+	const MAX_RENDERING_ITERATIONS = 20,
+		_oEventProvider = new EventProvider(),
+		// to protect against nested rendering we use an array of Steps instead of a single one
+		aFnDone = [];
 
-	var mUIAreas = {};
+	let _sRerenderTimer,
+		mUIAreas = {};
 
 	/**
 	 * Tasks that are called just before the rendering starts.
 	 * @private
 	 */
-	var aPrerenderingTasks = [];
+	let aPrerenderingTasks = [];
 
-	var _oEventProvider = new EventProvider();
+	let _bRendering = false;
 
-	var _bRendering = false;
-
-	function _renderPendingUIUpdates(sCaller) {
+	const _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;
+		let iLoopCount = 0;
+
+		const bLooped = MAX_RENDERING_ITERATIONS > 0;
 
 		_bRendering = true;
 
@@ -83,21 +83,21 @@ sap.ui.define([
 
 			// 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
+				if ( _sRerenderTimer !== Rendering ) { // '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()();
+				if (aFnDone.length > 0) {
+					aFnDone.pop()();
 				}
 			}
 
 			runPrerenderingTasks();
 
-			var mUIAreasSnapshot = mUIAreas;
+			const mUIAreasSnapshot = mUIAreas;
 			mUIAreas = {};
-			for (var sId in mUIAreasSnapshot) {
-				bUIUpdated = mUIAreasSnapshot[sId].rerender() || bUIUpdated;
+			for (const sId in mUIAreasSnapshot) {
+				mUIAreasSnapshot[sId].rerender();
 			}
 
 		// eslint-disable-next-line no-unmodified-loop-condition
@@ -106,28 +106,32 @@ sap.ui.define([
 		_bRendering = false;
 
 		// TODO: Provide information on what actually was re-rendered...
-		if (bUIUpdated) {
-			Rendering.fireUIUpdated();
-		}
+		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: [],
+	};
 
+	/**
+	 * Collects and triggers rendering for invalidated UIAreas
+	 *
+	 * @namespace
+	 * @alias module:sap/ui/core/Rendering
+	 * @private
+	 * @ui5-restricted sap.ui.core, sap.ui.model.odata.v4
+	 */
+	const Rendering = {
 		/**
 		 * Notify async Interaction step.
 		 *
 		 * @private
 		 * @ui5-restricted sap.ui.core.Core
 		 */
-		notifyInteractionStep: function () {
-			Rendering.aFnDone.push(Interaction.notifyAsyncStep());
+		notifyInteractionStep() {
+			aFnDone.push(Interaction.notifyAsyncStep());
 		},
 
 		/**
@@ -141,7 +145,7 @@ sap.ui.define([
 		 * @private
 		 * @ui5-restricted sap.ui.model.odata.v4
 		 */
-		addPrerenderingTask: function (fnPrerenderingTask, bFirst) {
+		addPrerenderingTask(fnPrerenderingTask, bFirst) {
 			if (bFirst) {
 				aPrerenderingTasks.unshift(fnPrerenderingTask);
 			} else {
@@ -161,10 +165,10 @@ sap.ui.define([
 		 * @param {string} sCaller The Caller id
 		 * @private
 		 */
-		renderPendingUIUpdates: function(sCaller, iTimeout) {
+		renderPendingUIUpdates(sCaller, iTimeout) {
 			if (iTimeout !== undefined) {
 				// start async interaction step
-				Rendering.aFnDone.push(Interaction.notifyAsyncStep());
+				aFnDone.push(Interaction.notifyAsyncStep());
 				_sRerenderTimer = setTimeout(_renderPendingUIUpdates.bind(null, sCaller), iTimeout);
 			} else {
 				_renderPendingUIUpdates(sCaller);
@@ -176,7 +180,7 @@ sap.ui.define([
 		 * @private
 		 * @ui5-restricted sap.ui.core
 		 */
-		suspend: function() {
+		suspend() {
 			/**
 			 * The ID of a timer that will execute the next rendering.
 			 *
@@ -185,7 +189,7 @@ sap.ui.define([
 			 * to the special value <code>this</code> which is non-falsy and which should never
 			 * represent a valid timer ID (no chance of misinterpretation).
 			 */
-			_sRerenderTimer = this; //eslint-disable-line consistent-this
+			_sRerenderTimer = Rendering; //eslint-disable-line consistent-this
 		},
 		/**
 		 * Resumes rendering if it was suspended by calling <code>sap.ui.core.Rendering.suspend</code> and
@@ -195,7 +199,7 @@ sap.ui.define([
 		 * @private
 		 * @ui5-restricted sap.ui.core
 		 */
-		resume: function(sReason) {
+		resume(sReason) {
 			Rendering.renderPendingUIUpdates(sReason, 0);
 		},
 
@@ -207,7 +211,7 @@ sap.ui.define([
 		 * @private
 		 * @ui5-restricted sap.ui.core
 		 */
-		isPending: function() {
+		isPending() {
 			return !!(_sRerenderTimer || _bRendering);
 		},
 
@@ -217,15 +221,15 @@ sap.ui.define([
 		 * @private
 		 * @function
 		 */
-		attachUIUpdated: function(fnFunction, oListener) {
+		attachUIUpdated(fnFunction, oListener) {
 			_oEventProvider.attachEvent("UIUpdated", fnFunction, oListener);
 		},
 
-		detachUIUpdated: function(fnFunction, oListener) {
+		detachUIUpdated(fnFunction, oListener) {
 			_oEventProvider.detachEvent("UIUpdated", fnFunction, oListener);
 		},
 
-		fireUIUpdated: function(mParameters) {
+		fireUIUpdated(mParameters) {
 			_oEventProvider.fireEvent("UIUpdated", mParameters);
 		},
 
@@ -235,7 +239,7 @@ sap.ui.define([
 		 * @returns {module:sap/base/Log} The Rendering logger
 		 * @private
 		 */
-		getLogger: function() {
+		getLogger() {
 			return oRenderLog;
 		},
 
@@ -245,7 +249,7 @@ sap.ui.define([
 		 * @param {sap.ui.core.UIArea} oUIArea The invalidated UIArea
 		 * @private
 		 */
-		invalidateUIArea: function(oUIArea) {
+		invalidateUIArea(oUIArea) {
 			mUIAreas[oUIArea.getId()] = oUIArea;
 			if ( !_sRerenderTimer ) {
 				// TODO: we should handle xx-waitForTheme here...
@@ -259,14 +263,14 @@ sap.ui.define([
 	 * Runs all prerendering tasks and resets the list.
 	 * @private
 	 */
-	function runPrerenderingTasks() {
-		var aTasks = aPrerenderingTasks.slice();
+	const runPrerenderingTasks = () => {
+		const aTasks = aPrerenderingTasks.slice();
 
 		aPrerenderingTasks = [];
-		aTasks.forEach(function (fnPrerenderingTask) {
+		aTasks.forEach((fnPrerenderingTask) => {
 			fnPrerenderingTask();
 		});
-	}
+	};
 
 	return Rendering;
 });

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

@@ -36,7 +36,7 @@ sap.ui.define([
 	 * @alias sap.ui.core.ResizeHandler
 	 * @extends sap.ui.base.Object
 	 * @author SAP SE
-	 * @version 1.119.0
+	 * @version 1.120.0
 	 * @public
 	 */
 
@@ -101,7 +101,7 @@ sap.ui.define([
 	 * @private
 	 */
 	ResizeHandler.prototype.attachListener = function(oRef, fnHandler){
-		var bIsControl = BaseObject.isA(oRef, 'sap.ui.core.Control'),
+		var bIsControl = BaseObject.isObjectA(oRef, 'sap.ui.core.Control'),
 			bIsJQuery = oRef instanceof jQuery, // actually, jQuery objects are not allowed as oRef, as per the API documentation. But this happens in the wild.
 			oDom = bIsControl ? oRef.getDomRef() : oRef,
 			iWidth = oDom ? oDom.offsetWidth : 0,

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

@@ -44,7 +44,7 @@ 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.119.0
+	 * @version 1.120.0
 	 *
 	 * @public
 	 * @deprecated as of version 1.56

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

@@ -23,7 +23,7 @@ sap.ui.define(['./Item', './library'],
 	 * @extends sap.ui.core.Item
 	 *
 	 * @author SAP SE
-	 * @version 1.119.0
+	 * @version 1.120.0
 	 *
 	 * @public
 	 * @alias sap.ui.core.SeparatorItem

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

@@ -5,9 +5,11 @@
  */
 
 sap.ui.define([
+	"sap/ui/core/StaticArea",
 	"sap/ui/core/util/ShortcutHelper",
 	'sap/base/assert'
 ], function(
+		StaticArea,
 		ShortcutHelper,
 		assert
 	) {
@@ -94,7 +96,7 @@ sap.ui.define([
 			function wrapCallback() {
 				var oFocusedElement = document.activeElement,
 					oSpan = document.createElement("span"),
-					oStaticUiAreaDomRef = sap.ui.getCore().getStaticAreaRef(),
+					oStaticAreaDomRef = StaticArea.getDomRef(),
 					args = arguments;
 
 				oSpan.setAttribute("tabindex", 0);
@@ -106,7 +108,7 @@ sap.ui.define([
 				oSpan.style.right = "50%";
 
 				// add span to static-ui-area
-				oStaticUiAreaDomRef.appendChild(oSpan);
+				oStaticAreaDomRef.appendChild(oSpan);
 
 				// set focus on span to enforce blur - e.g. data of input field needs to get peristed
 				oSpan.focus();
@@ -116,7 +118,7 @@ sap.ui.define([
 					oFocusedElement.focus();
 
 					// cleanup DOM
-					oStaticUiAreaDomRef.removeChild(oSpan);
+					oStaticAreaDomRef.removeChild(oSpan);
 
 					// trigger callback
 					fnCallback.apply(null, args);

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

@@ -0,0 +1,146 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2023 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+sap.ui.define([
+	"sap/base/config"
+], (
+	BaseConfig
+) => {
+	"use strict";
+
+	/**
+	 * Provides supportability related API
+	 *
+	 * @alias module:sap/ui/core/Supportability
+	 * @namespace
+	 * @private
+	 * @ui5-restricted sap.ui.core
+	 * @since 1.120.0
+	 */
+	const Supportability = {
+		/**
+		 * Returns whether the page runs in full debug mode.
+		 * @returns {boolean} Whether the page runs in full debug mode
+		 * @private
+		 * @ui5-restricted sap.ui.core
+		 * @since 1.120.0
+		 */
+		isDebugModeEnabled() {
+			// Configuration only maintains a flag for the full debug mode.
+			// ui5loader-autoconfig calculates detailed information also for the partial debug
+			// mode and writes it to window["sap-ui-debug"].
+			// Only a value of true must be reflected by this getter
+			let bDebug = window["sap-ui-debug"] === true ||
+				BaseConfig.get({
+					name: "sapUiDebug",
+					type: BaseConfig.Type.Boolean,
+					external: true
+				});
+
+			try {
+				bDebug = bDebug || /^(?:true|x|X)$/.test(window.localStorage.getItem("sap-ui-debug"));
+			} catch (e) {
+				// access to local storage might fail due to security / privacy settings
+			}
+			return bDebug;
+		},
+
+		/**
+		 * Returns whether the UI5 control inspector is displayed.
+		 * Has only an effect when the sap-ui-debug module has been loaded
+		 * @return {boolean} whether the UI5 control inspector is displayed
+		 * @private
+		 * @ui5-restricted sap.ui.core
+		 * @since 1.120.0
+		 */
+		isControlInspectorEnabled() {
+			return BaseConfig.get({
+				name: "sapUiInspect",
+				type: BaseConfig.Type.Boolean,
+				external: true
+			});
+		},
+
+		/**
+		 * Flag if statistics are requested.
+		 *
+		 * Flag set by TechnicalInfo Popup will also be checked.
+		 * So its active if set by URL parameter or manually via TechnicalInfo.
+		 *
+		 * @returns {boolean} Whether statistics are enabled
+		 * @private
+		 * @ui5-restricted sap.ui.core
+		 * @since 1.120.0
+		 */
+		isStatisticsEnabled() {
+			var result = BaseConfig.get({
+				name: "sapUiStatistics",
+				type: BaseConfig.Type.Boolean,
+				defaultValue: BaseConfig.get({
+					name: "sapStatistics",
+					type: BaseConfig.Type.Boolean,
+					external: true
+				}),
+				external: true
+			});
+			try {
+				result = result || window.localStorage.getItem("sap-ui-statistics") == "X";
+			} catch (e) {
+				// access to local storage might fail due to security / privacy settings
+			}
+			return result;
+		},
+
+		/**
+		 * Returns the support settings. In case there are no settings,
+		 * the support is disabled.
+		 *
+		 * @return {string[]} The support settings.
+		 * @experimental
+		 * @since 1.120.0
+		 */
+		getSupportSettings() {
+			return BaseConfig.get({
+				name: "sapUiSupport",
+				type: BaseConfig.Type.StringArray,
+				defaultValue: null,
+				external: true
+			});
+		},
+
+		/**
+		 * Returns the test recorder settings. In case there are no settings,
+		 * the test recorder is disabled.
+		 *
+		 * @return {string[]} The test recorder settings.
+		 * @experimental
+		 * @since 1.120.0
+		 */
+		getTestRecorderSettings() {
+			return BaseConfig.get({
+				name: "sapUiTestRecorder",
+				type: BaseConfig.Type.StringArray,
+				defaultValue: null,
+				external: true
+			});
+		},
+
+		/**
+		 * Returns whether the text origin information is collected.
+		 * @return {boolean} whether the text info is collected
+		 * @private
+		 * @ui5-restricted sap.ui.core, sap.ui.model
+		 */
+		collectOriginInfo() {
+			return BaseConfig.get({
+				name: "sapUiOriginInfo",
+				type: BaseConfig.Type.Boolean,
+				external: true
+			});
+		}
+	};
+
+	return Supportability;
+});