@sapui5/sap.ushell 1.126.1 → 1.127.0

package/src/main/js/sap/ushell/components/shell/Settings/Component.js

@@ -4,7 +4,6 @@ sap.ui.define([
     "sap/ui/core/Element",
     "sap/ui/core/mvc/XMLView",
     "sap/ui/core/UIComponent",
-    "sap/ui/model/json/JSONModel",
     "sap/ushell/Config",
     "sap/ushell/EventHub",
     "sap/ushell/resources",
@@ -18,12 +17,12 @@ sap.ui.define([
     "sap/ushell/components/shell/Settings/userLanguageRegion/UserLanguageRegionEntry",
     "sap/ushell/ui/shell/ShellHeadItem",
     "sap/ushell/utils",
-    "sap/ushell/Container"
+    "sap/ushell/Container",
+    "sap/ushell/state/StateManager"
 ], function (
     Element,
     XMLView,
     UIComponent,
-    JSONModel,
     Config,
     EventHub,
     resources,
@@ -37,16 +36,20 @@ sap.ui.define([
     UserLanguageRegionEntry,
     ShellHeadItem,
     Utils,
-    Container
+    Container,
+    StateManager
 ) {
     "use strict";
 
+    // shortcut for sap.ushell.state.StateManager.Operation
+    const Operation = StateManager.Operation;
+
     var aDoables = [];
 
     return UIComponent.extend("sap.ushell.components.shell.Settings.Component", {
 
         metadata: {
-            version: "1.126.1",
+            version: "1.127.0",
             library: "sap.ushell",
             dependencies: {
                 libs: {
@@ -66,6 +69,7 @@ sap.ui.define([
         init: function () {
             UIComponent.prototype.init.apply(this, arguments);
             var oShellConfig = Container.getRendererInternal("fiori2").getShellConfig();
+
             if (oShellConfig.moveUserSettingsActionToShellHeader) {
                 this.oSettingsBtn = this._addUserSettingsButton();
             }
@@ -162,10 +166,6 @@ sap.ui.define([
                     viewName: "sap.ushell.components.shell.Settings.UserSettings"
                 }).then(function (oSettingView) {
                     this.oSettingsView = oSettingView;
-                    oSettingView.setModel(new JSONModel({
-                        entries: []
-                    }));
-                    oSettingView.setModel(resources.i18nModel, "i18n");
                     var sControlId = oEvent.controlId || "shell-header";
                     Element.getElementById(sControlId).addDependent(oSettingView);
                     return oSettingView.byId("userSettingsDialog");
@@ -190,13 +190,9 @@ sap.ui.define([
                 ariaHaspopup: "dialog",
                 press: this._openUserSettings.bind(this)
             });
-            //Use ElementsModel, because button should be added only for specific states without propagation
-            Container.getRendererInternal("fiori2").oShellModel.addHeaderEndItem(
-                [oUserSettingsButton.getId()],
-                false,
-                ["home", "app", "minimal", "standalone", "embedded", "embedded-home", "merged", "merged-home"],
-                true
-            );
+
+            // Add to userActions. The actual move happens within the state management
+            StateManager.updateAllBaseStates("userActions.items", Operation.Add, oUserSettingsButton.getId());
 
             return oUserSettingsButton;
         },

package/src/main/js/sap/ushell/components/shell/Settings/UserSettings.controller.js

@@ -47,11 +47,13 @@ sap.ui.define([
          * @private
          */
         onInit: function () {
+            const oSettingView = this.getView();
+
             // Contains the id of the last selected entry.
             // If it was a grouped entry, it contains all the ids of the entry inside of the group.
             this._aPreviouslySelectedItems = [];
 
-            this.getView().byId("userSettingEntryList").addEventDelegate({
+            oSettingView.byId("userSettingEntryList").addEventDelegate({
                 onAfterRendering: this._listAfterRendering.bind(this)
             });
 
@@ -62,9 +64,12 @@ sap.ui.define([
             // or a wrapper for the combination of grouped entries
             this._mLoadedWrappers = new Map();
 
+            oSettingView.setModel(new JSONModel({}));
+            oSettingView.setModel(resources.i18nModel, "i18n");
+
             // Model which stores valueResult and contentResult
             // this helps avoiding infinite processing of entries due to async updates
-            this.getView().setModel(new JSONModel({ entries: {} }), "results");
+            oSettingView.setModel(new JSONModel({ entries: {} }), "results");
 
             Device.orientation.attachHandler(this._fnOrientationChange, this);
 
@@ -464,8 +469,8 @@ sap.ui.define([
                 var oEntryContent = aResults[1];
 
                 var aEntries = Config.last("/core/userPreferences/entries");
-                var bEntryAvailable = aEntries.some(function (oEntry) {
-                    return oEntry.id === sEntryId && oEntry.visible !== false;
+                var bEntryAvailable = aEntries.some(function (entry) {
+                    return entry.id === sEntryId && entry.visible !== false;
                 });
 
                 var oMasterEntryList = oView.byId("userSettingEntryList");

package/src/main/js/sap/ushell/components/shell/Settings/UserSettings.view.xml

@@ -21,16 +21,16 @@
                         icon="sap-icon://nav-back"
                         press="._navBackButtonPressHandler"
                         tooltip="{i18n>ToggleButtonShow}"
-                        visible="false"/>
+                        visible="false" />
                     <ToggleButton id="userSettingsMenuButton"
                         icon="sap-icon://menu2"
                         press="._navToggleButtonPressHandler"
                         tooltip="{i18n>ToggleButtonShow}"
-                        visible="false"/>
+                        visible="false" />
                 </contentLeft>
                 <contentMiddle>
                     <Title
-                        text="{i18n>userSettings}"/>
+                        text="{i18n>userSettings}" />
                 </contentMiddle>
             </Bar>
         </customHeader>
@@ -53,8 +53,7 @@
                                         mode="SingleSelectMaster"
                                         itemPress="._itemPress">
                                         <StandardListItem
-                                            class="sapUshellUserSettingMasterListItem"
-                                            title= "{title}"
+                                            title="{title}"
                                             description="{
                                                 parts: ['id', 'tabs', 'results>/entries'],
                                                 formatter: '._formatDescription'
@@ -62,6 +61,7 @@
                                             icon="{= !!${icon} ? ${icon} : 'sap-icon://action-settings' }"
                                             iconDensityAware="false"
                                             visible="{visible}"
+                                            wrapping="true"
                                             type="Active">
                                             <customData>
                                                 <core:CustomData key="help-id" value="{entryHelpID}" writeToDom="{= !!${entryHelpID}}" />
@@ -85,17 +85,17 @@
                             visible="false"
                             press="._handleMessagePopoverPress"
                             icon="sap-icon://message-error"
-                            ariaHasPopup="Dialog"/>
-                        <ToolbarSpacer/>
+                            ariaHasPopup="Dialog" />
+                        <ToolbarSpacer />
                         <Button
                             id="userSettingSaveButton"
                             text="{i18n>saveBtn}"
                             type="Emphasized"
-                            press="._handleSaveButtonPress"/>
+                            press="._handleSaveButtonPress" />
                         <Button
                             id="userSettingCancelButton"
                             text="{i18n>cancelBtn}"
-                            press="._handleCancel"/>
+                            press="._handleCancel" />
                     </OverflowToolbar>
                 </footer>
             </Page>

package/src/main/js/sap/ushell/components/shell/UserActionsMenu/Component.js

@@ -2,34 +2,19 @@
 sap.ui.define([
     "sap/ui/core/EventBus",
     "sap/ui/core/UIComponent",
-    "sap/ushell/components/applicationIntegration/AppLifeCycle",
-    "sap/ushell/Config",
-    "sap/ushell/components/shell/UserActionsMenu/UserActionsMenu.controller",
-    "sap/ushell/Container"
+    "sap/ushell/components/shell/UserActionsMenu/UserActionsMenu.controller"
 ], function (
     EventBus,
     UIComponent,
-    AppLifeCycle,
-    Config,
-    UserActionsMenuController,
-    Container
+    UserActionsMenuController
 ) {
     "use strict";
 
-    var _oRenderer;
-    // Shortcut to sap.ushell.Container.getRendererInternal("fiori2")
-    function _renderer () {
-        if (!_oRenderer) {
-            _oRenderer = Container.getRendererInternal("fiori2");
-        }
-        return _oRenderer;
-    }
-
     // UserActionsMenu Component
     return UIComponent.extend("sap.ushell.components.shell.UserActionsMenu.Component", {
 
         metadata: {
-            version: "1.126.1",
+            version: "1.127.0",
             library: "sap.ushell",
             dependencies: {
                 libs: ["sap.m"]
@@ -42,37 +27,10 @@ sap.ui.define([
             this.oUserActionsMenuController = new UserActionsMenuController();
             this.oUserActionsMenuController.onInit();
 
-            var that = this;
-
-            // In state blank when no Action Items do not display UserActionsMenu.
-            AppLifeCycle.getElementsModel().createTriggers([{
-                fnRegister: function () {
-                    if (!that.oActionsDoable) {
-                        that.oActionsDoable = Config.on("/core/shell/model/currentState/actions").do(function (aActions) {
-                            if (aActions && aActions.length > 0) {
-                                _renderer().showHeaderEndItem(["userActionsMenuHeaderButton"], true);
-                            } else {
-                                _renderer().hideHeaderEndItem(["userActionsMenuHeaderButton"], true);
-                            }
-                        });
-                    }
-                },
-                fnUnRegister: function () {
-                    if (!that.oActionsDoable) {
-                        that.oActionsDoable.off();
-                        that.oActionsDoable = null;
-                    }
-                }
-            }], false, ["blank-home", "blank"]);
-
             EventBus.getInstance().publish("shell", "userActionsMenuCompLoaded", { delay: 0 });
         },
 
         exit: function () {
-            if (this.oActionsDoable) {
-                this.oActionsDoable.off();
-            }
-            this.oEventListener.off();
             this.oUserActionsMenuController.onExit();
         }
     });

package/src/main/js/sap/ushell/components/shell/UserActionsMenu/UserActionsMenu.controller.js

@@ -17,7 +17,9 @@ sap.ui.define([
     "sap/ushell/ui/footerbar/AboutButton",
     "sap/ushell/ui/footerbar/ContactSupportButton",
     "sap/ushell/ui/launchpad/ActionItem",
-    "sap/ushell/ui/QuickAccess"
+    "sap/ushell/ui/QuickAccess",
+    "sap/ushell/state/ShellModel",
+    "sap/ushell/state/StateManager"
 ], function (
     Log,
     mobileLibrary,
@@ -35,23 +37,20 @@ sap.ui.define([
     AboutButton,
     ContactSupportButton,
     ActionItem,
-    QuickAccess
+    QuickAccess,
+    ShellModel,
+    StateManager
 ) {
     "use strict";
 
     // shortcut for sap.m.ListType
-    var ListType = mobileLibrary.ListType;
+    const ListType = mobileLibrary.ListType;
 
     // shortcut for sap.m.ButtonType
-    var ButtonType = mobileLibrary.ButtonType;
+    const ButtonType = mobileLibrary.ButtonType;
 
-    function isActionExist (sActionId) {
-        if (!Element.getElementById(sActionId)) {
-            Log.debug("Could not render ActionItem because it was not created: " + sActionId);
-            return false;
-        }
-        return true;
-    }
+    // shortcut for sap.ushell.state.StateManager.Operation
+    const Operation = StateManager.Operation;
 
     return Controller.extend("sap.ushell.components.shell.UserActionsMenu.UserActionsMenu", {
         _aDanglingControl: [],
@@ -63,15 +62,9 @@ sap.ui.define([
 
             var oUser = Container.getUser();
 
-            var aCreatedActions = Config.last("/core/shell/model/currentState/actions").filter(isActionExist);
             this.oModel = new JSONModel({
-                actions: aCreatedActions,
                 userName: oUser.getFullName() || oUser.getId()
             });
-            this._aDoables.push(Config.on("/core/shell/model/currentState/actions").do(function (aActions) {
-                var aFilteredActions = aActions.filter(isActionExist);
-                this.getModel().setProperty("/actions", aFilteredActions);
-            }.bind(this)));
 
             this._aDoables.push(EventHub.on("showUserActionsMenu").do(function (bShow) {
                 var oPopover = Element.getElementById("sapUshellUserActionsMenuPopover");
@@ -97,6 +90,14 @@ sap.ui.define([
             }
         },
 
+        filterUserActions: function (sActionId) {
+            if (!Element.getElementById(sActionId)) {
+                Log.debug("Could not render ActionItem because it was not created: " + sActionId);
+                return false;
+            }
+            return true;
+        },
+
         getModel: function () {
             return this.oModel;
         },
@@ -124,7 +125,7 @@ sap.ui.define([
                 this._createSupportTicketButton(bEnableHelp);
             }
 
-            if (oConfig.enableRecentActivity && Config.last("/core/shell/model/currentState/showRecentActivity")) {
+            if (oConfig.enableRecentActivity && Config.last("/core/shell/model/showRecentActivity")) {
                 this._createRecentActivitiesButton();
                 this._createFrequentActivitiesButton();
             }
@@ -155,6 +156,8 @@ sap.ui.define([
                 oOpenCatalogItem.addStyleClass("help-id-openCatalogActionItem"); // xRay help ID
             }
             this._addDanglingControl(oOpenCatalogItem);
+
+            StateManager.updateAllBaseStates("userActions.items", Operation.Add, oOpenCatalogItem.getId());
         },
 
         _createAboutButton: function (bEnableHelp) {
@@ -185,6 +188,9 @@ sap.ui.define([
                 }
                 this._addDanglingControl(oUserPrefButton);
             }
+
+            // Add to userActions. The actual move happens within the state management
+            StateManager.updateAllBaseStates("userActions.items", Operation.Add, sId);
         },
 
         _createSupportTicketButton: function (bEnableHelp) {
@@ -346,24 +352,26 @@ sap.ui.define([
          * @param {boolean} bShow flag to open or close UserActionsMenu popover
          * @private
          */
-        _toggleUserActionsMenuPopover: function (bShow) {
+        _toggleUserActionsMenuPopover: async function (bShow) {
             if (!this.oPopover) {
-                Fragment.load({
+                await Fragment.load({
                     name: "sap.ushell.components.shell.UserActionsMenu.UserActionsMenuPopover",
                     type: "XML",
                     controller: this
                 }).then(function (popover) {
                     this.oPopover = popover;
                     this.oPopover.setModel(this.getModel());
-                    this._toggleUserActionsMenuPopover(bShow);
+                    this.oPopover.setModel(ShellModel.getModel(), "shellModel");
+                    return this._toggleUserActionsMenuPopover(bShow);
                 }.bind(this));
             } else if (bShow) {
-                this.oPopover.getModel().refresh(true); // force refresh by reopen because the visibility of actions may change
+                // force refresh by reopen because the visibility of actions may change
+                this.oPopover.getModel("shellModel").refresh(true);
                 this.oPopover.openBy(Element.getElementById("userActionsMenuHeaderButton"));
             } else {
                 this.oPopover.close();
                 if (window.document.activeElement && window.document.activeElement.id !== "userActionsMenuHeaderButton") {
-                    window.document.getElementById("userActionsMenuHeaderButton").focus();
+                    window.document.getElementById("userActionsMenuHeaderButton")?.focus();
                 }
             }
         },

package/src/main/js/sap/ushell/components/shell/UserActionsMenu/UserActionsMenuPopover.fragment.xml

@@ -13,8 +13,13 @@
                 showSeparators="None"
                 includeItemInSelection="true"
                 items="{
-                    path: '/actions',
-                    factory: '.userActionsMenuPopoverItemFactory'
+                    path: 'shellModel>/userActions/items',
+                    factory: '.userActionsMenuPopoverItemFactory',
+                    filters: [{
+                        path: '',
+                        caseSensitive: true,
+                        test: '.filterUserActions'
+                    }]
                 }">
                 <headerToolbar>
                     <Toolbar style="Clear">

package/src/main/js/sap/ushell/components/shell/UserImage/Component.js

@@ -30,7 +30,7 @@ sap.ui.define([
     var oShellView;
     var ButtonType = coreLibrary.ButtonType;
     /**
-     * TODO: This entire thing does not need to have a UI COmponent as it has no own UI representation.
+     * TODO: This entire thing does not need to have a UI Component as it has no own UI representation.
      * User Image is part of Shell Header and ME area
      * Should rather be a plain Component
      *
@@ -38,7 +38,7 @@ sap.ui.define([
     return UIComponent.extend("sap.ushell.components.shell.UserImage.Component", {
 
         metadata: {
-            version: "1.126.1",
+            version: "1.127.0",
             library: "sap.ushell.components.shell.UserImage",
             dependencies: {
                 libs: {
@@ -83,7 +83,7 @@ sap.ui.define([
                 }
             });
             sap.ui.require([
-                "sap/ui/layout/form/VerticalLayout",
+                "sap/ui/layout/form/VerticalLayout", // todo move to sap/ui/layout/VerticalLayout in follow up
                 "sap/m/Dialog",
                 "sap/m/Text",
                 "sap/m/Link",

package/src/main/js/sap/ushell/components/tiles/applauncher/StaticTile.controller.js

@@ -3,7 +3,6 @@
 sap.ui.define([
     "sap/ui/core/mvc/Controller",
     "sap/ushell/components/tiles/utils",
-    "sap/ushell/components/applicationIntegration/AppLifeCycle",
     "sap/ushell/Config",
     "sap/ushell/utils/WindowUtils",
     "sap/m/library",
@@ -17,7 +16,6 @@ sap.ui.define([
 ], function (
     Controller,
     utils,
-    AppLifeCycle,
     Config,
     WindowUtils,
     mobileLibrary,
@@ -54,8 +52,6 @@ sap.ui.define([
             var sNavigationTargetUrl = oConfig.navigation_target_url;
             var oHash;
 
-            this.oShellModel = AppLifeCycle.getElementsModel();
-
             var sSystem = oTileApi.url.getApplicationSystem();
             if (sSystem) { // propagate system to target application
                 // when the navigation url is hash we want to make sure system parameter is in the parameters part

package/src/main/js/sap/ushell/components/tiles/applauncherdynamic/DynamicTile.controller.js

@@ -93,7 +93,6 @@ sap.ui.define([
             Log.setLevel(2, COMPONENT_NAME);
 
             this.bIsRequestCompleted = false;
-            this.oShellModel = AppLifeCycle.getElementsModel();
             this.navigationTargetUrl = this.constructTargetUrlWithSapSystem(sNavigationTargetUrlInit, sSystem);
 
             var oModel = new JSONModel({

package/src/main/js/sap/ushell/components/tiles/indicatorcomparison/ComparisonTile.controller.js

@@ -84,7 +84,7 @@ sap.ui.define([
                 if (unit && unit[i] && eachData[unit[i].name]) {
                     unitValue = eachData[unit[i].name];
                 }
-                tempVar = sap.ushell.components.tiles.indicatorTileUtils.util.getLocaleFormattedValue(calculatedValueForScaling, scaling, that.oConfig.EVALUATION.SCALING, that.oConfig.EVALUATION.DECIMAL_PRECISION, c, unitValue);
+                tempVar = sap.ushell.components.tiles.indicatorTileUtils.util.getLocaleFormattedValue(calculatedValueForScaling, that.oConfig.EVALUATION.SCALING, that.oConfig.EVALUATION.DECIMAL_PRECISION, c, unitValue);
                 if (that.oConfig.EVALUATION.SCALING == -2 && isEvaluationThresholdMeasure) {
                     tempVar += " %";
                 }

package/src/main/js/sap/ushell/components/visualizationOrganizer/Component.js

@@ -40,7 +40,7 @@ sap.ui.define([
     // visualizationOrganizer Component
     return UIComponent.extend("sap.ushell.components.visualizationOrganizer.Component", {
         metadata: {
-            version: "1.126.1",
+            version: "1.127.0",
             library: "sap.ushell",
             dependencies: { libs: ["sap.m"] },
             properties: {

package/src/main/js/sap/ushell/components/workPageBuilder/Component.js

@@ -3,7 +3,7 @@
  * @fileOverview WorkPageBuilder Component
  * This UIComponent gets initialized by the FLP renderer upon visiting a work page if work pages are enabled (/core/workPages/enabled).
  *
- * @version 1.126.1
+ * @version 1.127.0
  */
 
 sap.ui.define([
@@ -30,6 +30,7 @@ sap.ui.define([
         metadata: {
             manifest: "json",
             library: "sap.ushell",
+            interfaces: ["sap.ui.core.IAsyncContentCreation"],
             events: {
                 workPageEdited: {},
                 visualizationFilterApplied: {

package/src/main/js/sap/ushell/components/workPageBuilder/controller/WorkPageBuilder.accessibility.js

@@ -2,7 +2,7 @@
 
 /**
  * @file WorkPageBuilder accessibility features
- * @version 1.126.1
+ * @version 1.127.0
  */
 
 sap.ui.define([