@sapui5/sap.fe.core 1.95.0 → 1.98.0

package/src/sap/fe/core/RouterProxy.js

@@ -1,6 +1,6 @@
 /*!
  * SAPUI5
- * (c) Copyright 2009-2021 SAP SE. All rights reserved.
+ * (c) Copyright 2009-2022 SAP SE. All rights reserved.
  */
 /* eslint-disable no-alert */
 sap.ui.define(
@@ -128,6 +128,7 @@ sap.ui.define(
 				this._bDisableOnHashChange = false;
 				this._bIgnoreRestore = false;
 				this._bCleanedRestore = false;
+				this._bForceFocus = true; // Trigger the focus mechanism for the first view displayed by the app
 			},
 
 			destroy: function() {
@@ -158,6 +159,14 @@ sap.ui.define(
 				return this._oRouter.getHashChanger().getHash();
 			},
 
+			isFocusForced: function() {
+				return this._bForceFocus;
+			},
+
+			setFocusForced: function(bForced) {
+				this._bForceFocus = bForced;
+			},
+
 			/**
 			 * Resets the internal variable sIAppStateKey.
 			 *
@@ -180,42 +189,31 @@ sap.ui.define(
 			 * @param {string} sHash Hash to be navigated to
 			 * @param {boolean} bPreserveHistory If set to true, non-ancestor entries in history will be retained
 			 * @param {boolean} bDisablePreservationCache If set to true, cache preservation mechanism is disabled for the current navigation
-			 * @returns {Promise} Promise that is resolved when the navigation is finalized
+			 * @param {boolean} bForceFocus If set to true, the logic to set the focus once the navigation is finalized will be triggered (onPageReady)
+			 * @returns {Promise} Promise (resolved when the navigation is finalized) that returns 'true' if a navigation took place, 'false' if the navigation didn't happen
 			 * @ui5-restricted
 			 */
-			navToHash: function(sHash, bPreserveHistory, bDisablePreservationCache) {
+			navToHash: function(sHash, bPreserveHistory, bDisablePreservationCache, bForceFocus) {
 				var that = this;
 
 				if (this._oRouteMatchSynchronization) {
 					return this._oRouteMatchSynchronization.waitFor().then(function() {
 						that._oRouteMatchSynchronization = null;
-						return that._internalNavToHash(sHash, bPreserveHistory, bDisablePreservationCache);
+						return that._internalNavToHash(sHash, bPreserveHistory, bDisablePreservationCache, bForceFocus);
 					});
 				} else {
 					if (this._bActivateRouteMatchSynchro) {
 						this.waitForRouteMatchBeforeNavigation();
 					}
-					return that._internalNavToHash(sHash, bPreserveHistory, bDisablePreservationCache);
+					return that._internalNavToHash(sHash, bPreserveHistory, bDisablePreservationCache, bForceFocus);
 				}
 			},
 
-			_internalNavToHash: function(sHash, bPreserveHistory, bDisablePreservationCache) {
-				var that = this,
-					sLastFocusControlId = sap.ui.getCore().getCurrentFocusedControlId(),
-					sLastFocusInfo =
-						sLastFocusControlId && sap.ui.getCore().byId(sLastFocusControlId)
-							? sap.ui
-									.getCore()
-									.byId(sLastFocusControlId)
-									.getFocusInfo()
-							: null,
-					shashBeforeRoutechanged = this.getHash();
-
+			_internalNavToHash: function(sHash, bPreserveHistory, bDisablePreservationCache, bForceFocus) {
 				// Add the app state in the hash if needed
 				if (this.fclEnabled && this.sIAppStateKey && !findAppStateInHash(sHash)) {
 					sHash = setAppStateInHash(sHash, this.sIAppStateKey);
 				}
-				var oNewState = this._extractStateFromHash(sHash);
 
 				if (!this.checkHashWithGuard(sHash)) {
 					if (!this.oResourceBundle) {
@@ -226,15 +224,28 @@ sap.ui.define(
 					// in the EditFlow we rely on a UI5 mechanism that displays a confirm dialog.
 					if (!confirm(this.oResourceBundle.getText("C_ROUTER_PROXY_SAPFE_EXIT_NOTSAVED_MESSAGE"))) {
 						// The user clicked on Cancel --> cancel navigation
-						return Promise.resolve();
+						return Promise.resolve(false);
 					}
 					this.bIsGuardCrossAllowed = true;
 				}
+
+				// In case the navigation will cause a new view to be displayed, we force the focus
+				// I.e. if the keys for the hash we're navigating to is a superset of the current hash keys.
+				var oNewState = this._extractStateFromHash(sHash);
+				if (!this._bForceFocus) {
+					// If the focus was already forced, keep it
+					var aCurrentHashKeys = this._extractKeysFromHash(this.getHash());
+					this._bForceFocus =
+						bForceFocus ||
+						(aCurrentHashKeys.length < oNewState.keys.length &&
+							aCurrentHashKeys.every(function(key, index) {
+								return key === oNewState.keys[index];
+							}));
+				}
+
 				var oHistoryAction = this._pushNewState(oNewState, false, bPreserveHistory, bDisablePreservationCache);
 
-				return this._rebuildBrowserHistory(oHistoryAction, false).then(function() {
-					that.storeFocusForHash(sLastFocusControlId, sLastFocusInfo, shashBeforeRoutechanged);
-				});
+				return this._rebuildBrowserHistory(oHistoryAction, false);
 			},
 
 			/**
@@ -258,34 +269,6 @@ sap.ui.define(
 				}
 			},
 
-			getFocusControlForCurrentHash: function() {
-				var sCurrenthash = this.getHash();
-				var oLastFocusedControl;
-				for (var i = this._oManagedHistory.length - 1; i >= 0; i--) {
-					if (sCurrenthash === this._oManagedHistory[i].hash) {
-						oLastFocusedControl = this._oManagedHistory[i].oLastFocusControl;
-						break;
-					} else {
-						this._oManagedHistory[i].oLastFocusControl = undefined;
-					}
-				}
-
-				return oLastFocusedControl;
-			},
-
-			storeFocusForHash: function(sLastFocusControlId, sLastFocusInfo, sHash) {
-				var oManagedhistory = this._oManagedHistory;
-				for (var i = 0; i < oManagedhistory.length; i++) {
-					if (sHash === oManagedhistory[i].hash) {
-						oManagedhistory[i].oLastFocusControl = {
-							controlId: sLastFocusControlId,
-							focusInfo: sLastFocusInfo
-						};
-						break;
-					}
-				}
-			},
-
 			/**
 			 * Navigates back in the history.
 			 *
@@ -432,6 +415,24 @@ sap.ui.define(
 				this._bActivateRouteMatchSynchro = false;
 			},
 
+			_extractKeysFromHash: function(sHash) {
+				if (sHash === undefined) {
+					sHash = "";
+				}
+				var sHashNoParams = sHash.split("?")[0]; // remove params
+				var aTokens = sHashNoParams.split("/");
+				var aKeys = [];
+
+				aTokens.forEach(function(sToken) {
+					var regexKey = /[^\(\)]+\([^\(\)]+\)/; // abc(def)
+					if (regexKey.test(sToken)) {
+						aKeys.push(sToken.split("(")[0]);
+					}
+				});
+
+				return aKeys;
+			},
+
 			/**
 			 * Builds a state from a hash.
 			 *
@@ -441,22 +442,13 @@ sap.ui.define(
 			 * @ui5-restricted
 			 */
 			_extractStateFromHash: function(sHash) {
-				var oState = {
-					keys: []
-				};
-
-				// Retrieve object keys
 				if (sHash === undefined) {
 					sHash = "";
 				}
-				var sHashNoParams = sHash.split("?")[0];
-				var sTokens = sHashNoParams.split("/");
-				sTokens.forEach(function(sToken) {
-					var regexKey = /[^\(\)]+\([^\(\)]+\)/; // abc(def)
-					if (regexKey.test(sToken)) {
-						oState.keys.push(sToken.split("(")[0]);
-					}
-				});
+
+				var oState = {
+					keys: this._extractKeysFromHash(sHash)
+				};
 
 				// Retrieve layout (if any)
 				var aLayout = sHash.match(new RegExp("\\?.*" + enumURLParams.LAYOUTPARAM + "=([^&]*)"));
@@ -518,7 +510,6 @@ sap.ui.define(
 				}
 
 				// 3. Then pop all states until we find an ancestor of the new state, or we find a state that need to be preserved
-				var oLastFocusControl;
 				var oLastRemovedItem;
 				while (this._oManagedHistory.length > 0) {
 					var oTopState = this._oManagedHistory[this._oManagedHistory.length - 1];
@@ -527,13 +518,11 @@ sap.ui.define(
 						this._compareCacheStates(oTopState, oNewState) !== enumState.ANCESTOR
 					) {
 						// The top state is not an ancestor of oNewState and is not preserved --> we can pop it
-						oLastFocusControl = oTopState.oLastFocusControl;
 						oLastRemovedItem = this._oManagedHistory.pop();
 						iPopCount++;
 					} else if (oTopState.preserved && removeAppStateInHash(oTopState.hash) === removeAppStateInHash(oNewState.hash)) {
 						// We try to add a state that is already in cache (due to preserved flag) but with a different iapp-state
 						// --> we should delete the previous entry (it will be later replaced by the new one) and stop popping
-						oLastFocusControl = oTopState.oLastFocusControl;
 						oLastRemovedItem = this._oManagedHistory.pop();
 						iPopCount++;
 						oNewState.preserved = true;
@@ -565,7 +554,6 @@ sap.ui.define(
 				}
 
 				// 5. Now we can push the state at the top of the internal history
-				oNewState.oLastFocusControl = oLastFocusControl;
 				var bHasSameHash = oLastRemovedItem && oNewState.hash === oLastRemovedItem.hash;
 				if (this._oManagedHistory.length === 0 || this._oManagedHistory[this._oManagedHistory.length - 1].hash !== oNewState.hash) {
 					this._oManagedHistory.push(oNewState);
@@ -619,12 +607,12 @@ sap.ui.define(
 			},
 
 			/**
-			 * Rebuilds the browser history from the app root page.
+			 * Synchronizes the browser history with the internal history of the routerProxy, and triggers a navigation if needed.
 			 *
 			 * @memberof sap.fe.core.RouterProxy
 			 * @param {object} oHistoryAction Specifies the navigation action to be performed
-			 * @param {boolean} bRebuildOnly `true` if rebuilding history
-			 * @returns {Promise} A promise that is resolved when the navigation is finalized
+			 * @param {boolean} bRebuildOnly `true` if internal history is currently being rebuilt
+			 * @returns {Promise} Promise (resolved when the navigation is finalized) that returns 'true' if a navigation took place, 'false' if the navigation didn't happen
 			 * @ui5-restricted
 			 * @final
 			 */
@@ -652,7 +640,7 @@ sap.ui.define(
 						}
 
 						that.bIsRebuildHistoryRunning = false;
-						resolve();
+						resolve(true); // a navigation occurred
 					}
 
 					// Async callbacks when navigating back, in order to let all notifications and events get processed
@@ -667,7 +655,7 @@ sap.ui.define(
 					function backAsync() {
 						window.removeEventListener("popstate", backAsync);
 						that.bIsRebuildHistoryRunning = false;
-						resolve();
+						resolve(true); // a navigation occurred
 					}
 
 					that._bIgnoreRestore = true;
@@ -677,14 +665,14 @@ sap.ui.define(
 							that._oRouter.getHashChanger().replaceHash(oTargetState.hash);
 							history.replaceState(Object.assign({ feLevel: newLevel }, history.state), "");
 							that.bIsRebuildHistoryRunning = false;
-							resolve();
+							resolve(true); // a navigation occurred
 							break;
 
 						case "append":
 							that._oRouter.getHashChanger().setHash(oTargetState.hash);
 							history.replaceState(Object.assign({ feLevel: newLevel }, history.state), "");
 							that.bIsRebuildHistoryRunning = false;
-							resolve();
+							resolve(true); // a navigation occurred
 							break;
 
 						case "back":
@@ -701,7 +689,7 @@ sap.ui.define(
 						default:
 							// No navigation
 							that.bIsRebuildHistoryRunning = false;
-							resolve();
+							resolve(false); // no navigation --> resolve to false
 					}
 				});
 			},
@@ -815,6 +803,22 @@ sap.ui.define(
 					return !sPrevHash || !that.checkHashWithGuard(sPrevHash);
 				}
 				return false;
+			},
+
+			/**
+			 * Checks if the last 2 entries in the history share the same context.
+			 *
+			 * @returns {boolean} `true` if they share the same context.
+			 */
+			checkIfBackHasSameContext: function() {
+				if (this._oManagedHistory.length < 2) {
+					return false;
+				}
+
+				var oCurrentState = this._oManagedHistory[this._oManagedHistory.length - 1];
+				var oPreviousState = this._oManagedHistory[this._oManagedHistory.length - 2];
+
+				return oCurrentState.hash.split("?")[0] === oPreviousState.hash.split("?")[0];
 			}
 		});
 	}

package/src/sap/fe/core/Synchronization.js

@@ -1,6 +1,6 @@
 /*!
  * SAPUI5
- * (c) Copyright 2009-2021 SAP SE. All rights reserved.
+ * (c) Copyright 2009-2022 SAP SE. All rights reserved.
  */
 sap.ui.define(["sap/base/Log", "sap/ui/base/Object"], function(Log, BaseObject) {
 	"use strict";

package/src/sap/fe/core/TemplateComponent.js

@@ -1,10 +1,10 @@
 /*!
  * SAPUI5
- * (c) Copyright 2009-2021 SAP SE. All rights reserved.
+ * (c) Copyright 2009-2022 SAP SE. All rights reserved.
  */
 sap.ui.define(
-	["sap/ui/core/UIComponent", "sap/fe/core/CommonUtils", "sap/base/Log"],
-	function(UIComponent, CommonUtils, Log) {
+	["sap/ui/core/UIComponent", "sap/fe/core/CommonUtils", "sap/ui/mdc/p13n/StateUtil", "sap/base/Log"],
+	function(UIComponent, CommonUtils, StateUtil, Log) {
 		"use strict";
 
 		var TemplateComponent = UIComponent.extend("sap.fe.core.TemplateComponent", {
@@ -12,7 +12,7 @@ sap.ui.define(
 				interfaces: ["sap.ui.core.IAsyncContentCreation"],
 				properties: {
 					/**
-					 * OData EntitySet name
+					 * Name of the OData entity set
 					 */
 					entitySet: {
 						type: "string",
@@ -93,6 +93,15 @@ sap.ui.define(
 			init: function() {
 				this.oAppComponent = CommonUtils.getAppComponent(this);
 				UIComponent.prototype.init.apply(this, arguments);
+				var oStateChangedHandler = function(oEvent) {
+					var oControl = oEvent.getParameter("control");
+					if (oControl.isA("sap.ui.mdc.Table") || oControl.isA("sap.ui.mdc.FilterBar")) {
+						var oMacroAPI = oControl.getParent();
+						oMacroAPI.fireStateChanged();
+					}
+				};
+				StateUtil.detachStateChange(oStateChangedHandler);
+				StateUtil.attachStateChange(oStateChangedHandler);
 			},
 
 			// This method is called by UI5 core to access to the component containing the customizing configuration.
@@ -102,11 +111,11 @@ sap.ui.define(
 				return this.oAppComponent;
 			},
 
-			onPageReady: function(oLastFocusedControl) {
+			onPageReady: function(mParameters) {
 				if (this.getRootControl() && this.getRootControl().getController() && this.getRootControl().getController().onPageReady) {
 					this.getRootControl()
 						.getController()
-						.onPageReady(oLastFocusedControl);
+						.onPageReady(mParameters);
 				}
 			},
 
@@ -141,7 +150,7 @@ sap.ui.define(
 						.getController()
 						._getPageTitleInformation();
 				} else {
-					return Promise.resolve({});
+					return {};
 				}
 			},
 

package/src/sap/fe/core/TemplateModel.js

@@ -1,6 +1,6 @@
 /*!
  * SAPUI5
- * (c) Copyright 2009-2021 SAP SE. All rights reserved.
+ * (c) Copyright 2009-2022 SAP SE. All rights reserved.
  */
 sap.ui.define(["sap/base/Log", "sap/ui/base/Object", "sap/ui/model/json/JSONModel"], function(Log, BaseObject, JSONModel) {
 	"use strict";