@sapui5/sap.ushell 1.126.1 → 1.127.1

package/src/main/js/sap/ushell/renderer/Shell.controller.js

@@ -24,10 +24,8 @@ sap.ui.define([
     "sap/ui/thirdparty/jquery",
     "sap/ui/util/Storage",
     "sap/ushell/bootstrap/SchedulingAgent",
-    "sap/ushell/components/_HeaderManager/ControlManager",
     "sap/ushell/components/applicationIntegration/AppLifeCycle",
     "sap/ushell/components/applicationIntegration/relatedServices/RelatedServices",
-    "sap/ushell/components/HeaderManager",
     "sap/ushell/Config",
     "sap/ushell/EventHub",
     "sap/ushell/library",
@@ -40,7 +38,9 @@ sap.ui.define([
     "sap/ushell/renderer/ShellLayout",
     "sap/ushell/renderer/utils",
     "sap/base/util/ObjectPath",
-    "sap/ushell/Container"
+    "sap/ushell/Container",
+    "sap/ushell/state/ShellModel",
+    "sap/ushell/state/StateManager"
 ], function (
     History,
     Log,
@@ -62,10 +62,8 @@ sap.ui.define([
     jQuery,
     Storage,
     SchedulingAgent,
-    HeaderControlManager,
     AppLifeCycleAI,
     RelatedServices,
-    HeaderManager,
     Config,
     EventHub,
     ushellLibrary,
@@ -78,7 +76,9 @@ sap.ui.define([
     ShellLayout,
     RendererUtils,
     ObjectPath,
-    Container
+    Container,
+    ShellModel,
+    StateManager
 ) {
     "use strict";
 
@@ -90,14 +90,25 @@ sap.ui.define([
     // shortcut for sap.ushell.AppType
     var AppType = ushellLibrary.AppType;
 
+    // shortcut for sap.ushell.state.StateManager.LaunchpadState
+    const LaunchpadState = StateManager.LaunchpadState;
+
+    // shortcut for sap.ushell.state.StateManager.Operation
+    const Operation = StateManager.Operation;
+
+    // shortcut for sap.ushell.state.StateManager.ShellMode
+    const ShellMode = StateManager.ShellMode;
+    const {
+        Standalone,
+        Embedded,
+        Minimal
+    } = ShellMode;
+
     /* don't delay these cause they are needed for direct bookmarks */
 
     // create global model and add some demo data
     var closeAllDialogs = true;
     var bPreviousPageDirty = false;
-    var oShellModel;
-    var ShellModel = AppLifeCycleAI.getElementsModel();
-    var oModel;
     var oEPCMNavigationMode = {
         embedded: 0,
         newWindowThenEmbedded: 1,
@@ -258,13 +269,11 @@ sap.ui.define([
             var mediaQ = window.matchMedia("(min-width: 600px)");
             var oViewConfig = oViewData.config || {};
 
-            var oApplicationModel = AppLifeCycleAI.shellElements().model();
-            HeaderManager.init(oViewConfig, oApplicationModel);
-
-            oView.setModel(oViewData.helperModel, "helper");
-            oView.setModel(oViewData.shellModel);
             // Add global model to view
-            this.initShellModel(oViewConfig, oApplicationModel);
+            oView.setModel(this._getConfigModel(), "configModel");
+            oView.setModel(ShellModel.getModel(), "shellModel");
+
+            Config.emit("/core/shell/model/personalization", Config.last("/core/shell/enablePersonalization"));
 
             var handleMedia = function (mq) {
                 Config.emit("/core/shell/model/isPhoneWidth", !mq.matches);
@@ -287,20 +296,11 @@ sap.ui.define([
             // Doable objects are kept in a global array to enable their off-ing later on.
             this._registerAndCreateEventHubDoables();
 
-            oShellModel.addHeaderEndItem(["userActionsMenuHeaderButton"], false, ["home", "app", "minimal", "standalone", "embedded", "embedded-home", "lean"], true);
-
-            // Actions to add to custom states
-            var aActions = [];
-
-            if (oViewConfig && !oViewConfig.moveContactSupportActionToShellHeader) {
-                aActions.push("ContactSupportBtn");
-            }
-
             this.history = History;
             this.oViewPortContainer = Element.getElementById("viewPortContainer");
-            AppLifeCycleAI.init(oViewConfig.appState, this.oViewPortContainer, oViewConfig.rootIntent, oViewConfig.disableHomeAppCache, {
+            AppLifeCycleAI.init(this.oViewPortContainer, oViewConfig.rootIntent, oViewConfig.disableHomeAppCache, {
                 ownerComponent: this.getOwnerComponent()
-            }, aActions, oViewConfig.cacheConfiguration);
+            }, oViewConfig.cacheConfiguration);
 
             // init Shell Navigation
             var initShellNavigationInternal = function (oShellNavigationInternal, oAppLifeCycleService) {
@@ -316,6 +316,7 @@ sap.ui.define([
                 this.oShellNavigationInternal.registerNavigationFilter(this._disableSourceAppRouter.bind(this));
 
                 this.oShellNavigationInternal.registerNavigationFilter(this.handleDataLoss.bind(this));
+                this.oShellNavigationInternal.registerNavigationFilter(this._unblockUI.bind(this));
 
                 AppLifeCycleAI.registerHandleHashChange(this.oShellNavigationInternal);
                 // enable the direct app start and tests to wait for the initialization
@@ -339,7 +340,7 @@ sap.ui.define([
 
             if (Device.system.desktop) {
                 sap.ui.require(["sap/ushell/renderer/AccessKeysHandler"], function (AccessKeysHandler) {
-                    AccessKeysHandler.init(oModel);
+                    AccessKeysHandler.init();
                 });
             }
 
@@ -402,6 +403,18 @@ sap.ui.define([
             }
         },
 
+        /**
+         * Returns the current configuration model.
+         * Note: The model instance changes when the launchpad is restarted (e.g. in tests)
+         * @returns {sap.ui.model.Model} The configuration model.
+         *
+         * @since 1.127.0
+         * @private
+         */
+        _getConfigModel: function () {
+            return ShellModel.getConfigModel();
+        },
+
         shellUpdateAggItem: function (sId, oContext) {
             return Element.getElementById(oContext.getObject());
         },
@@ -431,13 +444,6 @@ sap.ui.define([
             }.bind(this));
         },
 
-        initShellModel: function (oConfigForModel, oApplicationModel) {
-            oShellModel = ShellModel;
-            oShellModel.init(oConfigForModel, oApplicationModel);
-            oModel = this.getView().getViewData().shellModel;
-            Config.emit("/core/shell/model/personalization", Config.last("/core/shell/enablePersonalization"));
-        },
-
         initShellUIService: function () {
             AppLifeCycleAI.initShellUIService({
                 fnOnBackNavigationChange: this.onBackNavigationChange.bind(this)
@@ -461,12 +467,13 @@ sap.ui.define([
         onBackNavigationChange: function (oEvent) {
             AppLifeCycleAI.setBackNavigationChanged(true);
             var fnCallback = oEvent.getParameters().data;
-            var oCurrentStateModel = Config.last("/core/shell/model/currentState");
+            const sCurrentShellMode = StateManager.getShellMode();
+            const sCurrentLaunchpadState = StateManager.getLaunchpadState();
 
             if (fnCallback) {
                 AppLifeCycleAI.service().setNavigateBack(fnCallback);
 
-                if (oCurrentStateModel.stateName === "minimal" || oCurrentStateModel.stateName === "standalone" || oCurrentStateModel.stateName === "embedded") {
+                if (sCurrentLaunchpadState === LaunchpadState.App && [Minimal, Standalone, Embedded].includes(sCurrentShellMode)) {
                     Container.getRendererInternal("fiori2").showHeaderItem("backBtn", true);
                 }
             } else {
@@ -501,6 +508,16 @@ sap.ui.define([
             return this.oShellNavigationInternal.NavigationFilterStatus.Continue;
         },
 
+        // Make sure that UI is unblocked during navigation.
+        // The header and menu are blocked when an embedded ui5 app shows a modal popup.
+        // However, such a block does not prevent navigation via the browser url and back/forward button navigation.
+        // Therefore, this unblock code is related only to the very specific case and has low impact.
+        _unblockUI: function () {
+            Element.getElementById("shell-header")?.setBlocked?.(false);
+            Element.getElementById("menubar")?.setBlocked?.(false);
+            return this.oShellNavigationInternal.NavigationFilterStatus.Continue;
+        },
+
         _setConfigurationToModel: function () {
             var oViewData = this.getView().getViewData();
 
@@ -508,33 +525,39 @@ sap.ui.define([
                 oConfig = oViewData.config || {};
             }
             if (oConfig) {
+                /**
+                 * @deprecated since 1.120 The 'states' configuration was discontinued.
+                 */
                 if (oConfig.states) {
-                    ShellModel.extendStates(oConfig.states);
-                    HeaderManager.extendStates(oConfig.states);
+                    Log.error("The 'states' configuration was discontinued");
                 }
 
                 if (oConfig.enableSetTheme !== undefined) {
-                    oModel.setProperty("/setTheme", oConfig.enableSetTheme);
+                    this._getConfigModel().setProperty("/setTheme", oConfig.enableSetTheme);
                 }
 
                 // Compact Cozy mode
-                oModel.setProperty("/contentDensity", oConfig.enableContentDensity === undefined ? true : oConfig.enableContentDensity);
+                this._getConfigModel().setProperty("/contentDensity", oConfig.enableContentDensity === undefined ? true : oConfig.enableContentDensity);
 
                 // Check if the configuration is passed by html of older version(1.28 and lower)
                 if (oConfig.migrationConfig !== undefined) {
-                    oModel.setProperty("/migrationConfig", oConfig.migrationConfig);
+                    this._getConfigModel().setProperty("/migrationConfig", oConfig.migrationConfig);
                 }
                 // User default parameters settings
                 if (oConfig.enableUserDefaultParameters !== undefined) {
-                    oModel.setProperty("/userDefaultParameters", oConfig.enableUserDefaultParameters);
+                    this._getConfigModel().setProperty("/userDefaultParameters", oConfig.enableUserDefaultParameters);
                 }
 
                 if (oConfig.disableHomeAppCache !== undefined) {
-                    oModel.setProperty("/disableHomeAppCache", oConfig.disableHomeAppCache);
+                    this._getConfigModel().setProperty("/disableHomeAppCache", oConfig.disableHomeAppCache);
                 }
                 // xRay enablement configuration
-                oModel.setProperty("/enableHelp", Config.last("/core/extension/enableHelp"));
-                oModel.setProperty("/searchAvailable", (oConfig.enableSearch !== false));
+                this._getConfigModel().setProperty("/enableHelp", Config.last("/core/extension/enableHelp"));
+                this._getConfigModel().setProperty("/searchAvailable", (oConfig.enableSearch !== false));
+
+                if (oConfig.title !== undefined) {
+                    this.setHeaderTitle(oConfig.title);
+                }
             }
         },
 
@@ -543,19 +566,19 @@ sap.ui.define([
             this._getPersData({
                 container: "flp.settings.FlpSettings",
                 item: "userActivitesTracking"
-            }).then(function (enableTrackingActivity) {
+            }).then((enableTrackingActivity) => {
                 if (enableTrackingActivity === undefined) {
                     enableTrackingActivity = true;
                 }
-                oModel.setProperty("/enableTrackingActivity", enableTrackingActivity);
+                this._getConfigModel().setProperty("/enableTrackingActivity", enableTrackingActivity);
                 EventHub.emit("StepDone", eventData.stepName);
-            }).catch(function (error) {
+            }).catch((error) => {
                 Log.error(
                     "Failed to load tracking activities state from the personalization, tracking activities is disabled", error,
                     "sap.ushell.components.flp.settings.FlpSettings");
                 // if the personalization cannot be read disable the functionality
                 // but don't prevent the FLP scheduler from triggering further steps
-                oModel.setProperty("/enableTrackingActivity", false);
+                this._getConfigModel().setProperty("/enableTrackingActivity", false);
                 EventHub.emit("StepDone", eventData.stepName);
             });
         },
@@ -617,13 +640,9 @@ sap.ui.define([
                 this.oShellNavigationInternal.hashChanger.destroy();
             }
 
-            HeaderManager.destroy();
-            HeaderControlManager.destroy();
-
             sap.ui.require("sap/ushell/UserActivityLog")?.deactivate();
-            oShellModel.destroy();
-            AppLifeCycleAI.shellElements().clean();
-            oShellModel = undefined;
+
+            StateManager.destroy(true);
         },
 
         /**
@@ -1258,14 +1277,13 @@ sap.ui.define([
          * @private
          */
         _handleEarlyNavigation: function (sFixedShellHash, sAppPart, oResolvedHashFragment) {
-            var that = this;
             var oDashboard;
 
-            return new Promise(function (fnResolve) {
-                that._openAppViaNWBC(oResolvedHashFragment).then(function (bOpenedViaNWBC) {
+            return new Promise((fnResolve) => {
+                this._openAppViaNWBC(oResolvedHashFragment).then((bOpenedViaNWBC) => {
                     if (bOpenedViaNWBC === true) {
                         oResolvedHashFragment.sFixedShellHash = sFixedShellHash;
-                        that.logOpenAppAction(oResolvedHashFragment, sAppPart).catch(() => {
+                        this.logOpenAppAction(oResolvedHashFragment, sAppPart).catch(() => {
                             Log.info("NWBC application was not logged.", undefined, "sap.ushell.renderer.Shell.controller");
                         });
                         oDashboard = Element.getElementById("sapUshellDashboardPage");
@@ -1282,12 +1300,12 @@ sap.ui.define([
                     if (bNewWindowNavigation) {
                         // add the app to application usage log
                         oResolvedHashFragment.sFixedShellHash = sFixedShellHash;
-                        that.logOpenAppAction(oResolvedHashFragment, sAppPart).catch(() => {
+                        this.logOpenAppAction(oResolvedHashFragment, sAppPart).catch(() => {
                             Log.info("Application in new window was not logged.", undefined, "sap.ushell.renderer.Shell.controller");
                         });
-                        sap.ui.require(["sap/ushell/components/container/ApplicationContainer"], function (ApplicationContainer) {
+                        sap.ui.require(["sap/ushell/components/container/ApplicationContainer"], (ApplicationContainer) => {
                             oResolvedHashFragment.url = ApplicationContainer.prototype._checkNwbcUrlAdjustment(undefined, oResolvedHashFragment.applicationType, oResolvedHashFragment.url, true);
-                            that._openAppInNewWindowAndRestore(oResolvedHashFragment);
+                            this._openAppInNewWindowAndRestore(oResolvedHashFragment);
                             oDashboard = Element.getElementById("sapUshellDashboardPage");
                             if (oDashboard) {
                                 oDashboard.setBlocked(false);
@@ -1309,7 +1327,7 @@ sap.ui.define([
                     // will be an empty hash. Otherwise, change hash to rootIntent to trigger normal resolution.
                     if (Config.last("/core/shell/model/migrationConfig")) {
                         oConfig.migrationConfig = false;
-                        that.getModel().setProperty("/migrationConfig", false);
+                        this._getConfigModel().setProperty("/migrationConfig", false);
 
                         if (oResolvedHashFragment && sFixedShellHash === "#") {
                             oConfig.rootIntent = "";
@@ -1817,14 +1835,10 @@ sap.ui.define([
             var sIntent = oParsedShellHash ? oParsedShellHash.semanticObject + "-" + oParsedShellHash.action : "";
 
             AppLifeCycleAI.switchViewState(
-                AppLifeCycleAI.shellElements().calculateElementsState(
-                    bIsNavToHome ? "home" : "app",
-                    oResolvedHashFragment.applicationType,
-                    oConfig.appState,
-                    oResolvedHashFragment.explicitNavMode
-                ),
-                undefined,
-                sAppId
+                bIsNavToHome ? LaunchpadState.Home : LaunchpadState.App,
+                sAppId,
+                oResolvedHashFragment.applicationType,
+                oResolvedHashFragment.explicitNavMode
             );
 
             if (bIsNavToHome) {
@@ -1873,8 +1887,11 @@ sap.ui.define([
 
             if (Device.system.desktop) {
                 sap.ui.require(["sap/ushell/renderer/AccessKeysHandler"], function (AccessKeysHandler) {
+                    const sCurrentLaunchpadState = StateManager.getLaunchpadState();
+                    const bDefaultShellMode = StateManager.getShellMode() === ShellMode.Default;
                     var oShellAppTitle = Element.getElementById("shellAppTitle");
-                    if (oShellAppTitle && Config.last("/core/shell/model/currentState/stateName") === "app") {
+
+                    if (oShellAppTitle && sCurrentLaunchpadState === LaunchpadState.App && bDefaultShellMode) {
                         var oShellAppTitleDomRef = oShellAppTitle.getFocusDomRef();
                         if (oShellAppTitleDomRef) {
                             AccessKeysHandler.sendFocusBackToShell(oShellAppTitleDomRef.getAttribute("id"));
@@ -1961,7 +1978,8 @@ sap.ui.define([
             if (oShellUIService) {
                 AppLifeCycleAI.initAppMetaParams();
             }
-            oShellModel.updateStateProperty("application/icon", AppLifeCycleAI.getAppMeta().getAppIcon(), true);
+            const sIcon = AppLifeCycleAI.getAppMeta().getAppIcon();
+            StateManager.updateCurrentState("application.icon", Operation.Set, sIcon);
         },
 
         /**
@@ -2764,7 +2782,7 @@ sap.ui.define([
                 this._oFloatingContainerPromise = this.getView().createFloatingContainer();
             }
 
-            this.getView().getModel("helper").setProperty("/shell/floatingContainerVisible", bVisible);
+            StateManager.updateAllBaseStates("floatingContainer.visible", Operation.Set, bVisible);
 
             return this._oFloatingContainerPromise.then(function () {
                 var sLastState = this.getFloatingContainerState() || "";
@@ -2791,11 +2809,7 @@ sap.ui.define([
         },
 
         getFloatingContainerVisibility: function () {
-            return this.getView().getModel("helper").getProperty("/shell/floatingContainerVisible");
-        },
-
-        setFloatingContainerContent: function (sPropertyString, aIds, bCurrentState, aStates) {
-            oShellModel.setFloatingContainerContent(sPropertyString, aIds, bCurrentState, aStates);
+            return ShellModel.getModel().getProperty("/floatingContainer/visible");
         },
 
         getRightFloatingContainerVisibility: function () {
@@ -2804,13 +2818,7 @@ sap.ui.define([
         },
 
         setHeaderTitle: function (sTitle) {
-            HeaderManager.updateStates({
-                propertyName: "title",
-                value: sTitle || "",
-                aStates: ["home", "app"],
-                bCurrentState: false,
-                bDoNotPropagate: false
-            });
+            StateManager.updateAllBaseStates("header.secondTitle", Operation.Set, sTitle || "");
         },
 
         setNavigationBar: function (oNavigationBar) {
@@ -2828,18 +2836,16 @@ sap.ui.define([
         },
 
         setFooter: function (oFooter) {
-            var oView = this.getView();
-            var oHelperModel = oView.getModel("helper");
             if (typeof oFooter !== "object" || !oFooter.getId) {
                 throw new Error("oFooter value is invalid");
             }
 
-            var sOldFooterId = oHelperModel.getProperty("/shell/footerContent");
+            var sOldFooterId = this.getFooterId();
             if (sOldFooterId) {
                 Log.warning("You can only set one footer. Replacing existing footer: " + sOldFooterId + ", with the new footer: " + oFooter.getId() + ".");
             }
 
-            oHelperModel.setProperty("/shell/footerContent", oFooter.getId());
+            StateManager.updateAllBaseStates("footer.content", Operation.Set, oFooter.getId());
             oFooter.placeAt(ShellLayoutMapping.Footer, "only");
             this.addDanglingControl(oFooter);
 
@@ -2849,15 +2855,11 @@ sap.ui.define([
         },
 
         getFooterId: function () {
-            var oView = this.getView();
-            var oHelperModel = oView.getModel("helper");
-            return oHelperModel.getProperty("/shell/footerContent");
+            return ShellModel.getModel().getProperty("/footer/content");
         },
 
         removeFooter: function () {
-            var oView = this.getView();
-            var oHelperModel = oView.getModel("helper");
-            var sFooterId = oHelperModel.getProperty("/shell/footerContent");
+            var sFooterId = this.getFooterId();
 
             if (sFooterId) {
                 var oFooter = Element.getElementById(sFooterId);
@@ -2866,7 +2868,7 @@ sap.ui.define([
                 }
             }
 
-            oHelperModel.setProperty("/shell/footerContent", "");
+            StateManager.updateAllBaseStates("footer.content", Operation.Set, "");
         },
 
         addUserPreferencesEntry: function (entryObject, bGrouped) {
@@ -3031,10 +3033,6 @@ sap.ui.define([
             return aNewEntries.concat(aEntries);
         },
 
-        getModel: function () {
-            return oModel;
-        },
-
         _getConfig: function () {
             return oConfig || {};
         },