@sapui5/sap.ushell 1.128.1 → 1.129.0

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

@@ -33,8 +33,10 @@ sap.ui.define([
     "sap/ushell/renderer/ShellLayout",
     "sap/ushell/renderer/utils",
     "sap/ushell/ui/launchpad/ActionItem",
+    "sap/ushell/state/ShellModel",
     "sap/ushell/state/StateManager",
-    "sap/ushell/renderers/fiori2/RendererExtensions" // restore deprecated globals
+    "sap/ushell/renderers/fiori2/RendererExtensions", // restore deprecated globals
+    "sap/ushell/components/applicationIntegration/configuration/AppMeta"
 ], function (
     Component,
     Element,
@@ -43,7 +45,7 @@ sap.ui.define([
     Config,
     Container,
     EventHub,
-    oUshellUtils,
+    ushellUtils,
     AppLifeCycleAI,
     Device,
     JSONModel,
@@ -64,8 +66,10 @@ sap.ui.define([
     ShellLayout,
     RendererUtils,
     ActionItem,
+    ShellModel,
     StateManager,
-    RendererExtensions // restore deprecated globals
+    RendererExtensions, // restore deprecated globals
+    AppMeta
 ) {
     "use strict";
 
@@ -100,9 +104,9 @@ sap.ui.define([
      */
     var Renderer = UIComponent.extend("sap.ushell.renderer.Renderer", /** @lends sap.ushell.renderer.Renderer.prototype */ {
         metadata: {
-            version: "1.128.1",
+            version: "1.129.0",
             dependencies: {
-                version: "1.128.1",
+                version: "1.129.0",
                 libs: ["sap.ui.core", "sap.m"],
                 components: []
             },
@@ -360,7 +364,7 @@ sap.ui.define([
                 });
 
                 AppLifeCycleAI.switchViewState("app", false, "Shell-appfinder");
-                AppLifeCycleAI.getAppMeta().setAppIcons();
+                AppMeta.setAppIcons();
 
                 oSharedComponentUtils.initializeAccessKeys();
             }, this);
@@ -402,7 +406,7 @@ sap.ui.define([
         var sHomeTitle = resources.getTranslationFromJSON(sCustomHomeTitle) || resources.i18n.getText("homeBtn_tooltip");
 
         var sRootIntent = this.getShellConfig().rootIntent;
-        var bIsRootIntentFlpHome = !sRootIntent || oUshellUtils.isFlpHomeIntent(sRootIntent);
+        var bIsRootIntentFlpHome = !sRootIntent || ushellUtils.isFlpHomeIntent(sRootIntent);
 
         // switch to home first so that #set calls below have effect
         AppLifeCycleAI.switchViewState(bIsRootIntentFlpHome ? LaunchpadState.Home : LaunchpadState.App, false, "Shell-home");
@@ -413,7 +417,7 @@ sap.ui.define([
         AppLifeCycleAI.getShellUIService().setTitle(sHomeTitle);
         AppLifeCycleAI.getShellUIService().setHierarchy();
         AppLifeCycleAI.getShellUIService().setRelatedApps();
-        AppLifeCycleAI.getAppMeta().setAppIcons(); // For the custom theme the favicon should be loaded get from theme parameter
+        AppMeta.setAppIcons(); // For the custom theme the favicon should be loaded get from theme parameter
 
         oSharedComponentUtils.initializeAccessKeys();
     };
@@ -1106,41 +1110,39 @@ sap.ui.define([
         var controlType = oParameters.controlType;
         var oControlProperties = oParameters.oControlProperties;
 
-        // If a control instance is already created - get it by its id
-        if (oControlProperties && oControlProperties.id && Element.getElementById(oControlProperties.id)) {
+        if (!controlType) {
+            Log.warning("You must specify control type in order to create it");
+            oDeferred.reject("You must specify control type in order to create it");
+            return oDeferred.promise();
+        }
+
+        if (!oControlProperties) {
+            Log.warning("You must specify control properties in order to create it");
+            oDeferred.reject("You must specify control properties in order to create it");
+            return oDeferred.promise();
+        }
+
+        var sControlResource = controlType.replace(/\./g, "/");
+        sap.ui.require([sControlResource], function (ControlObject) {
+            // If a control instance is already created - get it by its id
             oControlInstance = Element.getElementById(oControlProperties.id);
-            if (oControlInstance) {
-                // In case a footer was created before, we remove it first before setting a new one
-                if (this.lastFooterId) {
-                    this.removeFooter();
-                }
-                // This parameter holds the id of a footer that was created by the setFooterControl API
-                this.lastFooterId = oControlInstance.getId();
-                this.shellCtrl.setFooter(oControlInstance);
+            if (!oControlInstance) {
+                // only create the control if it doesn't already exist
+                oControlInstance = new ControlObject(oControlProperties);
+            }
 
-                oDeferred.resolve(oControlInstance);
+            // In case a footer was created before, we remove it first before setting a new one
+            if (that.lastFooterId) {
+                that.removeFooter();
             }
-        }
 
-        if (controlType) {
-            var sControlResource = controlType.replace(/\./g, "/");
-            sap.ui.require([sControlResource],
-                function (ControlObject) {
-                    oControlInstance = new ControlObject(oControlProperties);
-                    // In case a footer was created before, we remove it first before setting a new one
-                    if (that.lastFooterId) {
-                        that.removeFooter();
-                    }
+            // This parameter holds the id of a footer that was created by the setFooterControl API
+            that.lastFooterId = oControlInstance.getId();
+            that.shellCtrl.setFooter(oControlInstance);
 
-                    // This parameter holds the id of a footer that was created by the setFooterControl API
-                    that.lastFooterId = oControlInstance.getId();
-                    that.shellCtrl.setFooter(oControlInstance);
+            oDeferred.resolve(oControlInstance);
+        });
 
-                    oDeferred.resolve(oControlInstance);
-                });
-        } else {
-            Log.warning("You must specify control type in order to create it");
-        }
         return oDeferred.promise();
     };
 
@@ -1459,30 +1461,34 @@ sap.ui.define([
         var bCurrentState = oParameters.bCurrentState;
         var aStates = oParameters.aStates;
 
-        // If a control instance is already created - get it by its id
-        if (oControlProperties && oControlProperties.id && Element.getElementById(oControlProperties.id)) {
-            oControlInstance = Element.getElementById(oControlProperties.id);
-            if (oControlInstance) {
-                if (bIsVisible) {
-                    this.showSubHeader(oControlInstance.getId(), bCurrentState, aStates);
-                }
-                oDeferred.resolve(oControlInstance);
-            }
+        if (!controlType) {
+            Log.warning("You must specify control type in order to create it");
+            oDeferred.reject("You must specify control type in order to create it");
+            return oDeferred.promise();
         }
-        if (controlType) {
-            var sControlResource = controlType.replace(/\./g, "/");
-            sap.ui.require([sControlResource], function (ControlObject) {
-                    oControlInstance = new ControlObject(oControlProperties);
-                    StateManager.addManagedControl(oControlInstance.getId(), !bCurrentState);
 
-                    if (bIsVisible) {
-                        that.showSubHeader(oControlInstance.getId(), bCurrentState, aStates);
-                    }
-                    oDeferred.resolve(oControlInstance);
-                });
-        } else {
-            Log.warning("You must specify control type in order to create it");
+        if (!oControlProperties) {
+            Log.warning("You must specify control properties in order to create it");
+            oDeferred.reject("You must specify control properties in order to create it");
+            return oDeferred.promise();
         }
+
+        var sControlResource = controlType.replace(/\./g, "/");
+        sap.ui.require([sControlResource], function (ControlObject) {
+            // If a control instance is already created - get it by its id
+            oControlInstance = Element.getElementById(oControlProperties.id);
+            if (!oControlInstance) {
+                // only create the control if it doesn't already exist
+                oControlInstance = new ControlObject(oControlProperties);
+
+                StateManager.addManagedControl(oControlInstance.getId(), !bCurrentState);
+            }
+
+            if (bIsVisible) {
+                that.showSubHeader(oControlInstance.getId(), bCurrentState, aStates);
+            }
+            oDeferred.resolve(oControlInstance);
+        });
         return oDeferred.promise();
     };
 
@@ -1601,50 +1607,51 @@ sap.ui.define([
     Renderer.prototype.addUserAction = function (oParameters) {
         var oDeferred = new jQuery.Deferred();
         var that = this;
-        var oControlInstance;
+        let { controlType } = oParameters;
         const {
-            controlType,
             oControlProperties,
             bIsVisible,
             bCurrentState,
             aStates
         } = oParameters;
 
-        if (oControlProperties) {
-            // If a control instance is already created - get it by its id
-            oControlInstance = Element.getElementById(oControlProperties.id);
-            if (oControlInstance) {
-                oDeferred.resolve(oControlInstance);
-
-                if (!oControlInstance.getActionType) {
-                    const oShallowCopy = { ...oControlProperties };
-                    delete oShallowCopy.id;
-                    oControlInstance = new ActionItem(oShallowCopy);
-
-                    StateManager.addManagedControl(oControlInstance.getId(), !bCurrentState);
-                }
-
-                if (bIsVisible) {
-                    that.showActionButton(oControlInstance.getId(), bCurrentState, aStates);
-                }
-
+        if (!controlType) {
+            if (Element.getElementById(oControlProperties?.id)) {
+                controlType = "sap.ushell.ui.launchpad.ActionItem";
+            } else {
+                const sNoControlTypeErrorMessage = "You must specify control type in order to create it";
+                Log.warning(sNoControlTypeErrorMessage);
+                oDeferred.reject(sNoControlTypeErrorMessage);
                 return oDeferred.promise();
             }
         }
 
-        if (!controlType) {
-            const sNoControlTypeErrorMessage = "You must specify control type in order to create it";
-            Log.warning(sNoControlTypeErrorMessage);
-            oDeferred.reject(sNoControlTypeErrorMessage);
+        if (!oControlProperties) {
+            const sNoControlPropertiesErrorMessage = "You must specify control properties in order to create it";
+            Log.warning(sNoControlPropertiesErrorMessage);
+            oDeferred.reject(sNoControlPropertiesErrorMessage);
             return oDeferred.promise();
         }
 
         const sControlType = controlType === "sap.m.Button" ? "sap.ushell.ui.launchpad.ActionItem" : controlType;
-        var sControlResource = sControlType.replace(/\./g, "/");
+        const sControlResource = sControlType.replace(/\./g, "/");
         sap.ui.require([sControlResource], (ControlClass) => {
-            oControlInstance = new ControlClass(oControlProperties);
+            // If a control instance is already created - get it by its id
+            let oControlInstance = Element.getElementById(oControlProperties.id);
+            if (!oControlInstance) {
+                // only create the control if it doesn't already exist
+                oControlInstance = new ControlClass(oControlProperties);
+
+                StateManager.addManagedControl(oControlInstance.getId(), !bCurrentState);
+            }
 
-            StateManager.addManagedControl(oControlInstance.getId(), !bCurrentState);
+            if (!oControlInstance.getActionType) {
+                const oShallowCopy = { ...oControlProperties };
+                delete oShallowCopy.id;
+                oControlInstance = new ActionItem(oShallowCopy);
+
+                StateManager.addManagedControl(oControlInstance.getId(), !bCurrentState);
+            }
 
             if (bIsVisible) {
                 that.showActionButton(oControlInstance.getId(), bCurrentState, aStates);
@@ -1656,6 +1663,7 @@ sap.ui.define([
             Log.error(sControlTypeErrorMessage);
             oDeferred.reject(sControlTypeErrorMessage);
         });
+
         return oDeferred.promise();
     };
 
@@ -1764,35 +1772,29 @@ sap.ui.define([
     Renderer.prototype.addFloatingButton = function (oParameters) {
         var oDeferred = new jQuery.Deferred();
         var that = this;
-        var sControlResource;
         var oControlInstance;
-        var controlType = oParameters.controlType;
+        var sControlType = oParameters.controlType || "sap.m.Button";
         var oControlProperties = oParameters.oControlProperties;
         var bIsVisible = oParameters.bIsVisible;
         var bCurrentState = oParameters.bCurrentState;
         var aStates = oParameters.aStates;
 
-        // If a control instance is already created - get it by its id
-        if (oControlProperties && oControlProperties.id && Element.getElementById(oControlProperties.id)) {
-            oControlInstance = Element.getElementById(oControlProperties.id);
-            if (oControlInstance) {
-                if (bIsVisible) {
-                    that.showFloatingActionButton(oControlInstance.getId(), bCurrentState, aStates);
-                }
-                oDeferred.resolve(oControlInstance);
-            }
-        }
-
-        if (controlType) {
-            sControlResource = controlType.replace(/\./g, "/");
-        } else {
-            sControlResource = "sap/m/Button";
+        if (!oControlProperties) {
+            Log.warning("You must specify control properties in order to create it");
+            oDeferred.reject("You must specify control properties in order to create it");
+            return oDeferred.promise();
         }
 
+        var sControlResource = sControlType.replace(/\./g, "/");
         sap.ui.require([sControlResource], function (ControlObject) {
-                oControlInstance = new ControlObject(oControlProperties);
+                // If a control instance is already created - get it by its id
+                oControlInstance = Element.getElementById(oControlProperties.id);
+                if (!oControlInstance) {
+                    // only create the control if it doesn't already exist
+                    oControlInstance = new ControlObject(oControlProperties);
 
-                StateManager.addManagedControl(oControlInstance.getId(), !bCurrentState);
+                    StateManager.addManagedControl(oControlInstance.getId(), !bCurrentState);
+                }
 
                 if (bIsVisible) {
                     that.showFloatingActionButton(oControlInstance.getId(), bCurrentState, aStates);
@@ -1923,29 +1925,35 @@ sap.ui.define([
         var bCurrentState = oParameters.bCurrentState;
         var aStates = oParameters.aStates;
 
-        // If a control instance is already created - get it by its id
-        if (oControlProperties && oControlProperties.id && Element.getElementById(oControlProperties.id)) {
-            oControlInstance = Element.getElementById(oControlProperties.id);
-            if (oControlInstance) {
-                oDeferred.resolve(oControlInstance);
-            }
+        if (!controlType) {
+            Log.warning("You must specify control type in order to create it");
+            oDeferred.reject("You must specify control type in order to create it");
+            return oDeferred.promise();
         }
 
-        if (controlType) {
-            var sControlResource = controlType.replace(/\./g, "/");
-            sap.ui.require([sControlResource], function (ControlObject) {
-                    oControlInstance = new ControlObject(oControlProperties);
+        if (!oControlProperties) {
+            Log.warning("You must specify control properties in order to create it");
+            oDeferred.reject("You must specify control properties in order to create it");
+            return oDeferred.promise();
+        }
 
-                    StateManager.addManagedControl(oControlInstance.getId(), !bCurrentState);
+        var sControlResource = controlType.replace(/\./g, "/");
+        sap.ui.require([sControlResource], function (ControlObject) {
+            // If a control instance is already created - get it by its id
+            oControlInstance = Element.getElementById(oControlProperties.id);
+            if (!oControlInstance) {
+                // only create the control if it doesn't already exist
+                oControlInstance = new ControlObject(oControlProperties);
+
+                StateManager.addManagedControl(oControlInstance.getId(), !bCurrentState);
+            }
+
+            if (bIsVisible) {
+                that.showLeftPaneContent(oControlInstance.getId(), bCurrentState, aStates);
+            }
+            oDeferred.resolve(oControlInstance);
+        });
 
-                    if (bIsVisible) {
-                        that.showLeftPaneContent(oControlInstance.getId(), bCurrentState, aStates);
-                    }
-                    oDeferred.resolve(oControlInstance);
-                });
-        } else {
-            Log.warning("You must specify control type in order to create it");
-        }
         return oDeferred.promise();
     };
 
@@ -2477,7 +2485,7 @@ sap.ui.define([
      * @private
      */
     Renderer.prototype.setFloatingContainerVisibility = function (bVisible) {
-        this.shellCtrl.setFloatingContainerVisibility(bVisible);
+        StateManager.updateAllBaseStates("floatingContainer.visible", Operation.Set, bVisible);
     };
 
     /**
@@ -2487,7 +2495,7 @@ sap.ui.define([
      * @private
      */
     Renderer.prototype.getFloatingContainerState = function () {
-        return this.shellCtrl.getFloatingContainerState();
+        return ShellModel.getModel().getProperty("/floatingContainer/state");
     };
 
     /**
@@ -2497,7 +2505,7 @@ sap.ui.define([
      * @private
      */
     Renderer.prototype.getFloatingContainerVisiblity = function () {
-        return this.shellCtrl.getFloatingContainerVisibility();
+        return ShellModel.getModel().getProperty("/floatingContainer/visible");
     };
 
     /**
@@ -2517,7 +2525,7 @@ sap.ui.define([
      * @private
      */
     Renderer.prototype.setFloatingContainerDragSelector = function (sElementToCaptureSelector) {
-        this.shellCtrl.setFloatingContainerDragSelector(sElementToCaptureSelector);
+        StateManager.updateAllBaseStates("floatingContainer.dragSelector", Operation.Set, sElementToCaptureSelector);
     };
 
     /*---------------States------------------------*/