@sapui5/sap.ushell 1.121.2 → 1.122.1

package/src/main/js/sap/ushell/plugins/rta-personalize/Component.js

@@ -1,34 +1,14 @@
 // Copyright (c) 2009-2023 SAP SE, All Rights Reserved
 
 sap.ui.define([
-    "sap/base/util/UriParameters",
-    "sap/m/MessageBox",
-    "sap/m/MessageToast",
-    "sap/ui/core/Component",
-    "sap/ui/core/Element",
-    "sap/ui/core/EventBus",
-    "sap/ui/fl/Utils",
-    "sap/ui/fl/apply/_internal/preprocessors/EventHistory",
-    "sap/ushell/plugins/BaseRTAPlugin",
-    "sap/ushell/appRuntime/ui5/plugins/baseRta/CheckConditions",
-    "sap/ushell/appRuntime/ui5/plugins/baseRta/Renderer"
-], function(
-    UriParameters,
-    MessageBox,
-    MessageToast,
-    Component,
-    Element,
-    EventBus,
-    FlexUtils,
-    EventHistory,
-    BaseRTAPlugin,
-    CheckConditions,
-    Renderer
+    "sap/base/Log",
+    "sap/ushell/plugins/BaseRTAPlugin"
+], function (
+    Log,
+    BaseRTAPlugin
 ) {
     "use strict";
 
-    var sButtonId = "PERSONALIZE_Plugin_ActionButton";
-
     var RTAPlugin = BaseRTAPlugin.extend("sap.ushell.plugins.rta-personalize.Component", {
         sType: "rta-personalize",
 
@@ -38,235 +18,7 @@ sap.ui.define([
         },
 
         init: function () {
-            var oConfig = {
-                sComponentName: "sap.ushell.plugins.rta-personalize",
-                layer: "USER",
-                developerMode: false,
-                id: sButtonId,
-                text: "PERSONALIZE_BUTTON_TEXT",
-                icon: "sap-icon://edit",
-                visible: false,
-                checkRestartRTA: false
-            };
-
-            BaseRTAPlugin.prototype.init.call(this, oConfig);
-            CheckConditions.checkUI5App()
-                .then(function (bIsUI5App) {
-                    var bButtonIsVisible = this.mConfig.visible && bIsUI5App;
-                    return Renderer.createActionButton(this, this._onAdapt.bind(this), bButtonIsVisible);
-                }.bind(this))
-                .then(this._checkForEnabledControls.bind(this));
-        },
-
-        removePersonalizableControl: function (oControl) {
-            var iIndex = this._aPersonalizableControls.indexOf(oControl);
-            this._aPersonalizableControls.splice(iIndex, 1);
-            this._aOriginalFooterVisibility.splice(iIndex, 1);
-            if (this._aPersonalizableControls.length === 0) {
-                this._oObserver.disconnect();
-                delete this._oObserver;
-                this._adaptButtonVisibility(sButtonId, false);
-            }
-        },
-
-        _checkForEnabledControls: function () {
-            this._aPersonalizableControls = [];
-            this._aOriginalFooterVisibility = [];
-
-            function addPersonalizableControl (oControl) {
-                if (this._aPersonalizableControls.indexOf(oControl) === -1) {
-                    this._aPersonalizableControls.push(oControl);
-                    CheckConditions.checkUI5App()
-                        .then(function (bIsUI5App) {
-                            this._adaptButtonVisibility(sButtonId, bIsUI5App);
-                        }.bind(this));
-                }
-            }
-
-            function onPersonalizableControlRendered (sChannelId, sEventId, vControl) {
-                if (FlexUtils.checkControlId(vControl)) {
-                    var oControl = this._getControlInstance(vControl);
-                    addPersonalizableControl.call(this, oControl);
-                    if (!this._oObserver) {
-                        this._oObserver = new MutationObserver(function (mutations) {
-                            this._aPersonalizableControls.forEach(function (oPersonalizableControl) {
-                                if (!oPersonalizableControl.getDomRef()) {
-                                    this.removePersonalizableControl(oPersonalizableControl);
-                                }
-                            }.bind(this));
-                        }.bind(this));
-                        var oObserverConfig = {
-                            attributes: true,
-                            childList: true,
-                            characterData: false,
-                            subtree: true,
-                            attributeFilter: ["style", "class"]
-                        };
-                        this._oObserver.observe(window.document, oObserverConfig);
-                    }
-                }
-            }
-
-            EventBus.getInstance().subscribe("sap.ui", "ControlForPersonalizationRendered", onPersonalizableControlRendered, this);
-            var aEvents = EventHistory.getHistoryAndStop("ControlForPersonalizationRendered");
-            aEvents.forEach(function (oEvent) {
-                onPersonalizableControlRendered.call(this, oEvent.channelId, oEvent.eventId, oEvent.parameters);
-            }.bind(this));
-        },
-
-        _getControlInstance: function (vElement) {
-            if (typeof vElement === "string") {
-                var oElement = Element.getElementById(vElement);
-                return oElement || Component.getComponentById(vElement);
-            }
-            return vElement;
-        },
-
-        _onAppLoaded: function () {
-            // remove all personalizable controls if a new app is loaded and hide the button
-            // the listener for such controls is already active at this point
-            var iLength = this._aPersonalizableControls.length;
-            for (var i = iLength; i > 0; i--) {
-                this.removePersonalizableControl(this._aPersonalizableControls[i - 1]);
-            }
-        },
-
-        /**
-         * This function is called when the start event of RTA was fired
-         *
-         * @param {sap.ui.base.Event} oEvent the RTA start event
-         * @private
-         * @override
-         */
-        _onStartHandler: function (oEvent) {
-            var iEditablePlugins = oEvent.getParameter("editablePluginsCount");
-            if (iEditablePlugins !== undefined && iEditablePlugins <= 0) {
-                MessageBox.information(this.mConfig.i18n.getText("MSG_STARTUP_NO_OVERLAYS"), {
-                    onClose: function () {
-                        this.oTrigger.triggerStopRta(/*bSkipSave = */true, /*bSkipRestart = */true);
-                    }.bind(this)
-                });
-            }
-        },
-
-        /**
-         * This function should be used when custom plugins are needed
-         *
-         * @param {sap.ui.rta.RuntimeAuthoring} oRTA Instance of RuntimeAuthoring
-         * @private
-         * @override
-         */
-        _loadPlugins: function (oRTA) {
-            // only require the needed plugins when RTA is started
-            var oPromise = new Promise(function (resolve) {
-                sap.ui.require([
-                    "sap/ui/rta/plugin/EasyAdd",
-                    "sap/ui/rta/plugin/EasyRemove"
-                ], function (EasyAddPlugin, EasyRemovePlugin) {
-                    var mPlugins = oRTA.getDefaultPlugins(),
-                        oRemovePlugin = mPlugins.remove;
-                    mPlugins.remove = new EasyRemovePlugin({ commandFactory: oRemovePlugin.getCommandFactory() });
-
-                    var oAdditionalElementsPlugin = mPlugins.additionalElements;
-                    mPlugins.additionalElements = new EasyAddPlugin({
-                        commandFactory: oAdditionalElementsPlugin.getCommandFactory()
-                    });
-
-                    mPlugins.contextMenu.setOpenOnClick(false);
-
-                    oRTA.setPlugins(mPlugins);
-                    resolve();
-                });
-            });
-            return oPromise;
-        },
-
-        /**
-         * Event handler for the "Adapt" button of the RTA FLP Plugin
-         *
-         * @param {sap.ui.base.Event} oEvent the button click event
-         * @private
-         * @override
-         */
-        _onAdapt: function (oEvent) {
-            var oSource = oEvent.getSource();
-            if (oSource.getText() === this.mConfig.i18n.getText("PERSONALIZE_BUTTON_TEXT")) {
-                var oUriParams = UriParameters.fromURL(window.location.href),
-                    sSapUiLayer = oUriParams.mParams["sap-ui-layer"] && oUriParams.mParams["sap-ui-layer"][0];
-                if (!sSapUiLayer || sSapUiLayer === "USER") {
-                    oSource.setText(this.mConfig.i18n.getText("END_PERSONALIZE_BUTTON_TEXT"));
-
-                    this._adaptButtonVisibility("RTA_Plugin_ActionButton", false);
-
-                    // Store the original values for the Footer Visibility
-                    this._aPersonalizableControls.forEach(function (oControl) {
-                        if (oControl.setShowFooter) {
-                            this._aOriginalFooterVisibility.push(oControl.getShowFooter());
-                        } else {
-                            this._aOriginalFooterVisibility.push(undefined);
-                        }
-                    }.bind(this));
-
-                    this._adaptFooterVisibility(false);
-
-                    var oSearchButton = this._getFlpSearchButton();
-                    this._bOriginalSearchButtonVisibility = oSearchButton && oSearchButton.getVisible();
-                    if (this._bOriginalSearchButtonVisibility) {
-                        this._adaptButtonVisibility(oSearchButton, false);
-                    }
-
-                    BaseRTAPlugin.prototype._onAdapt.call(this);
-                } else {
-                    MessageBox.information(this.mConfig.i18n.getText("MSG_STARTUP_WRONG_LAYER"));
-                }
-            } else {
-                this.oTrigger.triggerStopRta(/*bSkipSave = */false, /*bSkipRestart = */true);
-            }
-            return Promise.resolve();
-        },
-
-        /**
-         * Leaves the personalization mode
-         * @private
-         * @override
-         */
-        _switchToDefaultMode: function () {
-            Element.getElementById(sButtonId).setText(this.mConfig.i18n.getText("PERSONALIZE_BUTTON_TEXT"));
-
-            this._adaptButtonVisibility("RTA_Plugin_ActionButton", true);
-            this._adaptFooterVisibility(true);
-
-            if (this._bOriginalSearchButtonVisibility !== undefined) {
-                this._adaptButtonVisibility(this._getFlpSearchButton(), this._bOriginalSearchButtonVisibility);
-                delete this._bOriginalSearchButtonVisibility;
-            }
-
-            MessageToast.show(this.mConfig.i18n.getText("SAVE_SUCCESSFUL"), {
-                duration: 4000,
-                offset: "0 -50"
-            });
-        },
-
-        /**
-         * Sets the Footer visibility of the personalizable Controls
-         *
-         * @param {boolean} bVisible new visibility of the Footer
-         * @private
-         */
-        _adaptFooterVisibility: function (bVisible) {
-            this._aPersonalizableControls.forEach(function (oControl, iIndex) {
-                if (this._aOriginalFooterVisibility[iIndex]) {
-                    oControl.setShowFooter(bVisible);
-                }
-            }.bind(this));
-        },
-
-        _getFlpSearchButton: function () {
-            return this.oRenderer.getRootControl().getShellHeader().getHeadEndItems()[0];
-        },
-
-        _getFLPViewPort: function () {
-            return Element.getElementById("viewPortContainer");
+            Log.error("[Deprecated] The FLP plugin for RTA Personalization (sap.ushell.plugins.rta-personalize) is no longer supported.");
         }
     });
 

package/src/main/js/sap/ushell/plugins/rta-personalize/manifest.json

@@ -3,56 +3,7 @@
 
 	"sap.app": {
 		"_version": "1.1.0",
-		"i18n": {
-			"bundleUrl": "i18n/i18n.properties",
-			"supportedLocales": [
-				"",
-				"ar",
-				"bg",
-				"ca",
-				"cs",
-				"da",
-				"de",
-				"el",
-				"en",
-				"en_US_sappsd",
-				"en_US_saptrc",
-				"es",
-				"et",
-				"fi",
-				"fr",
-				"hi",
-				"hr",
-				"hu",
-				"it",
-				"iw",
-				"ja",
-				"kk",
-				"ko",
-				"lt",
-				"lv",
-				"ms",
-				"nl",
-				"no",
-				"pl",
-				"pt",
-				"ro",
-				"ru",
-				"sh",
-				"sk",
-				"sl",
-				"sv",
-				"th",
-				"tr",
-				"uk",
-				"vi",
-				"zh_CN",
-				"zh_TW"
-			],
-			"fallbackLocale": "en"
-		},
 		"id": "sap.ushell.plugins.rta-personalize",
-		"title": "{{APP_TITLE}}",
 		"type": "component",
 		"applicationVersion": {
 			"version": "1.0.0"
@@ -99,59 +50,6 @@
 					"lazy": true
 				}
 			}
-		},
-		"models": {
-			"i18n": {
-				"type": "sap.ui.model.resource.ResourceModel",
-				"uri": "i18n/i18n.properties",
-				"settings": {
-					"supportedLocales": [
-						"",
-						"ar",
-						"bg",
-						"ca",
-						"cs",
-						"da",
-						"de",
-						"el",
-						"en",
-						"en_US_sappsd",
-						"en_US_saptrc",
-						"es",
-						"et",
-						"fi",
-						"fr",
-						"hi",
-						"hr",
-						"hu",
-						"it",
-						"iw",
-						"ja",
-						"kk",
-						"ko",
-						"lt",
-						"lv",
-						"ms",
-						"nl",
-						"no",
-						"pl",
-						"pt",
-						"ro",
-						"ru",
-						"sh",
-						"sk",
-						"sl",
-						"sv",
-						"th",
-						"tr",
-						"uk",
-						"vi",
-						"zh_CN",
-						"zh_TW"
-					],
-					"fallbackLocale": "en"
-				}
-			}
 		}
 	},
 	"sap.flp": {

package/src/main/js/sap/ushell/renderer/AccessKeysHandler.js

@@ -381,8 +381,6 @@ sap.ui.define([
         if (oEvent.shiftKey) {
             if (oEvent.keyCode === 70) { // CTRL + SHIFT + F
                 if (this._isFocusInDialog()) {
-                    oEvent.preventDefault();
-                    oEvent.stopPropagation();
                     return;
                 }
 
@@ -406,16 +404,12 @@ sap.ui.define([
             }
         } else if (oEvent.keyCode === 112) { // CTRL + F1
             if (this._isFocusInDialog()) {
-                oEvent.preventDefault();
-                oEvent.stopPropagation();
                 return;
             }
 
             this._handleAccessOverviewKey(bAdvancedShellActions);
         } else if (oEvent.keyCode === 83) { // CTRL + S
             if (this._isFocusInDialog()) {
-                oEvent.preventDefault();
-                oEvent.stopPropagation();
                 return;
             }
 
@@ -427,8 +421,6 @@ sap.ui.define([
             }
         } else if (oEvent.keyCode === 13) { // CTRL + Enter
             if (this._isFocusInDialog()) {
-                oEvent.preventDefault();
-                oEvent.stopPropagation();
                 return;
             }
 

package/src/main/js/sap/ushell/renderer/Renderer.js

@@ -83,9 +83,9 @@ sap.ui.define([
      */
     var Renderer = UIComponent.extend("sap.ushell.renderer.Renderer", /** @lends sap.ushell.renderer.Renderer.prototype */ {
         metadata: {
-            version: "1.121.2",
+            version: "1.122.1",
             dependencies: {
-                version: "1.121.2",
+                version: "1.122.1",
                 libs: ["sap.ui.core", "sap.m"],
                 components: []
             },

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

@@ -752,7 +752,7 @@ sap.ui.define([
             var bIsBackNavigation = Ui5History.getInstance().getHistoryStateOffset() < 0;
             Promise.all([
                 this._waitForHash(currentIntent),
-                sap.ushell.Container.getServiceAsync("NavTargetResolution"),
+                sap.ushell.Container.getServiceAsync("NavTargetResolutionInternal"),
                 sap.ushell.Container.getDirtyFlagsAsync()
             ])
                 .then(function (aResults) {
@@ -1126,7 +1126,7 @@ sap.ui.define([
                     var oConfig = oShellController._getConfig();
                     var bComponentLoaded = !!(oResolvedHashFragment && oResolvedHashFragment.componentHandle);
                     // for SAPUI5 apps, the application type is still "URL" due to backwards compatibility, but the
-                    // NavTargetResolution service already extracts the component name, so this can directly be used as indicator
+                    // NavTargetResolutionInternal service already extracts the component name, so this can directly be used as indicator
                     var sTargetUi5ComponentName = oResolvedHashFragment && oResolvedHashFragment.ui5ComponentName;
 
                     // calculate effective Navigation Mode with resolution result and current Application,
@@ -1373,7 +1373,7 @@ sap.ui.define([
          *
          * @param {string} sShellHash the hash fragment to parse (must start with "#")
          * @returns {jQuery.Promise} Resolves with an object containing the resolved hash fragment (i.e., the result of
-         *   {@link sap.ushell.services.NavTargetResolution#resolveHashFragment}), the parsed shell hash obtained via
+         *   {@link sap.ushell.services.NavTargetResolutionInternal#resolveHashFragment}), the parsed shell hash obtained via
          *   {@link sap.ushell.services.URLParsing#parseShellHash}, and a boolean value indicating whether application dependencies
          *   <b>and</b> core-ext-light were loaded earlier. The promise is rejected with an error message in case errors occur.
          */
@@ -1402,7 +1402,7 @@ sap.ui.define([
             }
 
             // Perform target resolution as normal...
-            sap.ushell.Container.getServiceAsync("NavTargetResolution").then(function (oNavTargetResolution) {
+            sap.ushell.Container.getServiceAsync("NavTargetResolutionInternal").then(function (oNavTargetResolution) {
                 oNavTargetResolution.resolveHashFragment(sShellHash)
                     .done(function (oResolvedHashFragment) {
                         //@FIXME: Should be also executed for directstart
@@ -1430,7 +1430,7 @@ sap.ui.define([
          *
          * {@link #navigate}.
          *
-         * @param {object} oResolvedHashFragment the hash fragment resolved via {@link sap.ushell.services.NavTargetResolution#resolveHashFragment}
+         * @param {object} oResolvedHashFragment the hash fragment resolved via {@link sap.ushell.services.NavTargetResolutionInternal#resolveHashFragment}
          * @returns {object} a new, potentially altered resolution result. Note that url and navigation mode may have been changed!
          *   For navigation in new window, the URL is replaced with the current location hash.
          *   NOTE: refactor this; we should not have these implicit changes of the navigation target
@@ -1525,7 +1525,7 @@ sap.ui.define([
          * @param {object} oParsedShellHash the parsed shell hash obtained via {@link sap.ushell.services.URLParsing} service
          * @param {string} sFixedShellHash the hash fragment to navigate to. It must start with "#" (i.e., fixed).
          * @param {object} oMetadata the metadata object obtained via {@link sap.ushell.services.AppConfiguration#parseShellHash}
-         * @param {object} oResolvedHashFragment the hash fragment resolved via {@link sap.ushell.services.NavTargetResolution#resolveHashFragment}
+         * @param {object} oResolvedHashFragment the hash fragment resolved via {@link sap.ushell.services.NavTargetResolutionInternal#resolveHashFragment}
          *
          * @returns {Promise} Navigation Promise
          */
@@ -2216,7 +2216,7 @@ sap.ui.define([
          * Notifies the UITracer service about the navigation (app launch) by emitting
          * a corresponding event on the event hub.
          *
-         * @param {object} oResolvedHashFragment - the result of the NavTargetResolution service
+         * @param {object} oResolvedHashFragment - the result of the NavTargetResolutionInternal service
          */
         _notifyUITracer: function (oResolvedHashFragment) {
             try {

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

@@ -15,7 +15,6 @@ sap.ui.define([
     "sap/ui/core/mvc/View",
     "sap/ui/core/mvc/XMLView",
     "sap/ui/core/Fragment",
-    "sap/ui/core/Core",
     "sap/ushell/renderer/ShellLayout",
     "sap/ushell/renderer/Shell.controller" // controller must be preloaded to avoid naming clashes
 ], function (
@@ -33,7 +32,6 @@ sap.ui.define([
     View,
     XMLView,
     Fragment,
-    Core,
     ShellLayout,
     ShellController
 ) {
@@ -229,14 +227,8 @@ sap.ui.define([
         },
 
         createCanvasShapesManager: function () {
-            var iInterval = setInterval(function () {
-                if (Core.isThemeApplied()) {
-                    clearInterval(iInterval);
-                    sap.ui.require(["sap/ushell/CanvasShapesManager"], function (CanvasShapesManager) {
-                        CanvasShapesManager.drawShapes();
-                    });
-                }
-            }, 200);
+            // The initial drawing of the canvas shapes is triggered within the manager
+            sap.ui.require(["sap/ushell/CanvasShapesManager"]);
         },
 
         createSubHeader: function () {

package/src/main/js/sap/ushell/renderer/allMyApps/AllMyApps.controller.js

@@ -103,8 +103,7 @@ sap.ui.define([
 
         /**
          * Adjusts the amount of columns for the ItemNavigation of the ItemContainerList.
-         * The custom style class "sapUshellAllMyAppsListItem" sets the css property display to inline-flex.
-         * This way, if the screen size allows it, the items can be shown in two columns instead of one.
+         * The custom CSS class "sapUshellAllMyAppsListItem" decides whether to display the items in one or two columns.
          *
          * @private
          * @since 1.121
@@ -137,7 +136,7 @@ sap.ui.define([
         },
 
         /**
-         * Loads apps data (that needs to be updated each time AllMyapps UI is opened)
+         * Loads apps data (that needs to be updated each time AllMyApps UI is opened)
          * and switches the UI to the initial state
          *
          * @returns {Promise} For testing
@@ -152,7 +151,7 @@ sap.ui.define([
                 var oMasterPage = oView.byId("sapUshellAllMyAppsMasterPage");
                 var oDetailsPage = oView.byId("sapUshellAllMyAppsDetailsPage");
 
-                //Show busy indicator only upon initial loading of "AllMyApps".
+                // Show busy indicator only upon initial loading of "AllMyApps".
                 if (!this.bAfterInitialLoading) {
                     if (oMasterPage) {
                         oMasterPage.setBusy(true);
@@ -161,8 +160,8 @@ sap.ui.define([
                         oDetailsPage.setBusy(true);
                     }
                     oSplitApp.toMaster(this.createId("sapUshellAllMyAppsMasterPage"), "show");
-                    //On "Phones" the sap.m.SplitApp displays only Detail or Master context at once.
-                    //Consequently, calling 'toDetail' on phones changes also the context to the Detail and this should be avoided.
+                    // On "Phones" the sap.m.SplitApp displays only Detail or Master context at once.
+                    // Consequently, calling 'toDetail' on phones changes also the context to the Detail and this should be avoided.
                     if (!Device.system.phone) {
                         oSplitApp.toDetail("sapUshellAllMyAppsDetailsPage", "show");
                     }
@@ -469,14 +468,14 @@ sap.ui.define([
             var oCustomPanelLabel = this._getCustomPanelLabel();
             var oCustomPanelLink = this._getCustomPanelLink();
             var oBindingContext;
-            var oBindedEntryObject;
+            var oBoundEntryObject;
 
             if (bSingleDataSource === true) {
                 oBindingContext = oAllMyAppsModel.createBindingContext("/AppsData/0/groups/0");
-                oBindedEntryObject = oAllMyAppsModel.getProperty(oBindingContext.getPath());
+                oBoundEntryObject = oAllMyAppsModel.getProperty(oBindingContext.getPath());
             } else {
                 oBindingContext = oAllMyAppsModel.createBindingContext("/AppsData/" + iFirstSelectedDataSourceIndex);
-                oBindedEntryObject = oAllMyAppsModel.getProperty(oBindingContext.getPath());
+                oBoundEntryObject = oAllMyAppsModel.getProperty(oBindingContext.getPath());
             }
 
             // Set the context of the details area to point the items/apps of the first catalog or (if no catalogs) the first group
@@ -488,9 +487,9 @@ sap.ui.define([
                 oCustomPanelLink.setBindingContext(oBindingContext, "allMyAppsModel");
             }
 
-            if (oBindedEntryObject !== undefined) {
+            if (oBoundEntryObject !== undefined) {
                 // Set the text of the details area header to show the title of the first catalog or (if no catalogs) the first group
-                this._getDetailsHeaderLabel().setText(oBindedEntryObject.title);
+                this._getDetailsHeaderLabel().setText(oBoundEntryObject.title);
             }
 
             if (oData.bFirstCatalogLoadedEvent === true) {