@sapui5/sap.ushell 1.114.0 → 1.115.1

package/src/main/js/sap/ushell/renderers/fiori2/Renderer.js

@@ -78,9 +78,9 @@ sap.ui.define([
      */
     var Renderer = UIComponent.extend("sap.ushell.renderers.fiori2.Renderer", {
         metadata: {
-            version: "1.114.0",
+            version: "1.115.1",
             dependencies: {
-                version: "1.114.0",
+                version: "1.115.1",
                 libs: ["sap.ui.core", "sap.m"],
                 components: []
             },
@@ -104,21 +104,23 @@ sap.ui.define([
                             return "homeapp";
                         }
 
-                        //CEP MyHome
-                        if (Config.last("/core/workPages/enabled") && Config.last("/core/workPages/myHome/pageId") !== null) {
-                            return "workpages";
-                        }
+                            // CEP MyHome
+                            if (Config.last("/core/workPages/enabled") && Config.last("/core/workPages/myHome/pageId") !== null) {
+                                return "workpages";
+                            }
 
-                        //CEP Standard
-                        if (Config.last("/core/workPages/enabled") && Config.last("/core/workPages/myHome/pageId") === null) {
-                            return "runtimeSwitcher";
-                        }
+                            // CEP Standard
+                            if (Config.last("/core/workPages/enabled") && Config.last("/core/workPages/myHome/pageId") === null) {
+                                return "runtimeSwitcher";
+                            }
 
-                        if (Config.last("/core/spaces/enabled")) {
-                            return "pages";
-                        }
+                            // Pages Spaces Mode
+                            if (Config.last("/core/spaces/enabled")) {
+                                return "pages";
+                            }
 
-                        return "home";
+                            // Classic Homepage
+                            return "home";
                     })()
                 }, {
                     name: "appfinder",
@@ -136,12 +138,12 @@ sap.ui.define([
                         "Launchpad-openFLPPage"
                     ],
                     target: (function () {
-                        //CEP MyHome
+                        // CEP MyHome
                         if (Config.last("/core/workPages/enabled") && Config.last("/core/workPages/myHome/pageId") !== null) {
                             return "workpages";
                         }
 
-                        //CEP Standard
+                        // CEP Standard
                         if (Config.last("/core/workPages/enabled") && Config.last("/core/workPages/myHome/pageId") === null) {
                             return "runtimeSwitcher";
                         }
@@ -518,8 +520,8 @@ sap.ui.define([
             oSyncView.loaded().then(function (oCreatedView) {
                 // initialize the RendererExtensions after the view is created.
                 // This also publishes an external event that indicates that sap.ushell.renderers.fiori2.RendererExtensions can be used.
-                sap.ushell.renderers.fiori2.utils.init(oCreatedView.getController());
                 this.shellCtrl = oCreatedView.oController;
+                sap.ushell.renderers.fiori2.utils.init(oCreatedView.getController());
             }.bind(this));
 
             return oSyncView;
@@ -537,8 +539,8 @@ sap.ui.define([
 
             // initialize the RendererExtensions after the view is created.
             // This also publishes an external event that indicates that sap.ushell.renderers.fiori2.RendererExtensions can be used.
-            sap.ushell.renderers.fiori2.utils.init(oView.getController());
             this.shellCtrl = oView.getController();
+            sap.ushell.renderers.fiori2.utils.init(oView.getController());
             return oView;
         }.bind(this));
     };
@@ -977,7 +979,7 @@ sap.ui.define([
      * renderer.setFooter(bar);
      * </pre>
      *
-     * @param {sap.m.Bar} oFooter The control to be added as the footer of the Fiori Launchpad
+     * @param {sap.m.Bar} oFooter - sap.m.Bar, the control to be added as the footer of the Fiori Launchpad
      * @since 1.30
      * @public
      */
@@ -1028,13 +1030,11 @@ sap.ui.define([
      * oRenderer.setShellFooter(oFooterControlProperties);
      * </pre>
      *
-     * @param {object} oParameters Contains the required parameters for creating and showing the new control object:<br>
-     *  Properties:<br>
-     *   - {string} controlType<br>
-     *     The (class) name of the control type to create, for example: <code>"sap.m.Bar"</code><br>
-     *   - {object} oControlProperties<br>
-     *     The properties that will be passed to the created control, for example: <code>{id: "testBar"}</code><br>
-     * @returns {jQuery.Deferred.promise} object that when resolved, returns the newly created control
+     * @param {object} oParameters Contains the required parameters for creating and showing the new control object.
+     * @param {string} oParameters.controlType The (class) name of the control type to create, for example: <code>sap.m.Bar</code>
+     * @param {object} oParameters.oControlProperties The properties that will be passed to the created control, for example: <code>{id: "testBar"}</code>
+     *
+     * @returns {jQuery.Deferred.promise} jQuery.deferred.promise object that when resolved, returns the newly created control
      * @since 1.48
      * @public
      */
@@ -1356,7 +1356,7 @@ sap.ui.define([
     /**
      * This method returns the current state of the Viewport Container control.
      *
-     * @returns {object} The current Viewport State.
+     * @returns {string} The current Viewport State.
      * @since 1.37
      * @public
      */
@@ -1391,20 +1391,15 @@ sap.ui.define([
      * oRenderer.addShellSubHeader(oAddSubHeaderProperties);
      * </pre>
      *
-     * @param {object} oParameters Contains the required parameters for creating and showing the new control object:<br>
-     *   Properties:<br>
-     *   - {string} controlType<br>
-     *     The (class) name of the control type to create.<br>
-     *   - {object} oControlProperties<br>
-     *     The properties that will be passed to the created control.<br>
-     *   - {boolean} bIsVisible<br>
-     *     Specify whether to display the control.<br>
-     *   - {boolean} bCurrentState<br>
-     *     If true, add the current control only to the current rendered shell state.<br>
-     *     Once the user navigates to another app or back to the Home page, this control will be removed.<br>
-     *   - {string[]} aStates<br>
-     *     (only valid if bCurrentState is set to false) - list of the sap.ushell.renderers.fiori2.Renderer.LaunchpadState in which to add the control.<br>
-     * @returns {object} jQuery.deferred.promise object that when resolved, returns the newly created control
+     * @param {object} oParameters Contains the required parameters for creating and showing the new control object.
+     * @param {string} oParameters.controlType The (class) name of the control type to create.
+     * @param {object} oParameters.oControlProperties The properties that will be passed to the created control.
+     * @param {boolean} oParameters.bIsVisible Specify whether to display the control.
+     * @param {boolean} oParameters.bCurrentState If true, add the current control only to the current rendered shell state. Once the user
+     * navigates to another app or back to the Home page, this control will be removed.
+     * @param {string[]} oParameters.aStates (only valid if bCurrentState is set to false) - list of the sap.ushell.renderers.fiori2.Renderer.LaunchpadState in which to add the control.
+     *
+     * @returns {jQuery.Deferred.promise} jQuery.Deferred.promise object that when resolved, returns the newly created control
      * @since 1.48
      * @public
      */
@@ -1540,23 +1535,16 @@ sap.ui.define([
      * oRenderer.addUserAction(oAddActionButtonProperties);
      * </pre>
      *
-     * @param {object} oParameters Contains the required parameters for creating and showing the new control object:<br>
-     *  Properties:<br>
-     *   - {string} controlType<br>
-     *     The (class) name of the control type to create.<br>
-     *   - {object} oControlProperties<br>
-     *     The properties that will be passed to the created control.<br>
-     *   - {boolean} bIsVisible<br>
-     *     Specify whether to display the control.<br>
-     *   - {boolean} bCurrentState<br>
-     *     If true, add the current control only to the current rendered shell state.<br>
-     *     Once the user navigates to another app or back to the Home page, this control will be removed.<br>
-     *   - {string[]} aStates<br>
-     *     (only valid if bCurrentState is set to false) - list of the sap.ushell.renderers.fiori2.Renderer.LaunchpadState in which to add the control.<br>
+     * @param {object} oParameters Contains the required parameters for creating and showing the new control object.
+     * @param {string} oParameters.controlType The (class) name of the control type to create.<br>
+     * @param {object} oParameters.oControlProperties The properties that will be passed to the created control.<br>
+     * @param {boolean} oParameters.bIsVisible Specify whether to display the control.
+     * @param {boolean} oParameters.bCurrentState If true, add the current control only to the current rendered shell state.
+     * Once the user navigates to another app or back to the Home page, this control will be removed.
+     * @param {string[]} oParameters.aStates (only valid if bCurrentState is set to false) - list of the sap.ushell.renderers.fiori2.Renderer.LaunchpadState in which to add the control.
+     * If no launchpad state is provided the content is added in all states. @see LaunchpadState
      *
-     *    @see LaunchpadState
-     *   If no launchpad state is provided the content is added in all states.
-     * @returns {object} jQuery.deferred.promise object that when resolved, returns the newly created control
+     * @returns {jQuery.Deferred.promise} jQuery.Deferred.promise object that when resolved, returns the newly created control
      * @since 1.48
      * @public
      */
@@ -1647,7 +1635,7 @@ sap.ui.define([
      *   Valid only if bCurrentState is set to false.
      *   @see sap.ushell.renderers.fiori2.renderer.LaunchpadState
      *   If no launchpad state is provided, the content is added in all states.
-     * @returns {object} oItem - the created control
+     * @returns {sap.ui.core.Control} oItem - the created control
      * @since 1.30
      * @deprecated since 1.48. Please use {@link #addUserAction} instead.
      * @public
@@ -1865,7 +1853,7 @@ sap.ui.define([
      *      @see LaunchpadState
      *      If no launchpad state is provided the content is added in all states.
      *
-     * @returns {object} jQuery.deferred.promise object that when resolved, returns the newly created control.
+     * @returns {jQuery.Deferred.promise} jQuery.Deferred.promise object that when resolved, returns the newly created control.
      *
      * @since 1.48
      * @public
@@ -2001,7 +1989,7 @@ sap.ui.define([
      *   A list of shell states (i.e. sap.ushell.renderers.fiori2.Renderer.LaunchpadState) in which the control is added.<br>
      *   If no launchpad state is provided the control is added in all states.
      *   @see LaunchpadState
-     * @returns {object} The created control
+     * @returns {sap.ui.core.Control} The created control
      * @since 1.30
      * @public
      */
@@ -2101,7 +2089,7 @@ sap.ui.define([
      *    An array of shell states (i.e. sap.ushell.renderers.fiori2.Renderer.LaunchpadState) in which the controls are added.
      *    If no launchpad state is provided the items are added in all states.
      *    @see sap.ushell.renderers.fiori2.renderer.LaunchpadState.
-     * @returns {object} the added control
+     * @returns {sap.ui.core.Control} the added control
      * @since 1.30
      * @public
      */
@@ -2170,7 +2158,7 @@ sap.ui.define([
      *   list of the sap.ushell.renderers.fiori2.Renderer.LaunchpadState in which to add the control.
      *   @see LaunchpadState
      *   If no launchpad state is provided the content is added in all states.
-     * @returns {object} oItem - the created control
+     * @returns {sap.ui.core.Control} oItem - the created control
      * @since 1.30
      * @public
      */
@@ -2238,31 +2226,22 @@ sap.ui.define([
      * oRenderer.addUserPreferencesEntry(oEntry);
      * </pre>
      *
-     * @param {object} entryObject The data of the new added User Preference entry
-     *   Including:
-     *   <ul>
-     *     <li>{string} entryHelpID (Optional) - The ID of the object.<br>
-     *     <li>{string} title - The title of the entry to be presented in the list in the User Preferences dialog box.<br>
-     *     We recommend using a string from the translation bundle.<br>
-     *     <li>{string}/{Function} value - A string to be presented as the value of the entry<br>
-     *     OR a function to be called which returns a {jQuery.Deferred.promise} object.<br>
-     *     <li>{Function} content - A function to be called that returns a {jQuery.Deferred.promise} object<br>
-     *     which consists of a {sap.ui.core.Control} to be displayed in a follow-on dialog box. A SAPUI5 view instance can also be returned.
-     *     The functions is called on each time the user opens the User Preferences dialog box.
-     *     <li>{Function} onSave - A function to be called which returns a {jQuery.Deferred.promise}
-     *     object when the user clicks Save in the User Preferences dialog box.<br>
-     *     If an error occurs, pass the error message via the {jQuery.Deferred.promise} object. Errors are displayed in the log.<br>
-     *     <li>{Function} onCancel - A function to be called that closes the User Preferences dialog box without saving any changes. <br>
-     *     <li>{Boolean} provideEmptyWrapper - Experimental. Set this value to true if you want that your content is displayed without the standard header<br>
-     *   </ul>
-     *
-     * @returns {object} User Preference Entry.
+     * @param {object} entryObject The data of the new added User Preference entry.
+     * @param {string} entryObject.entryHelpID (Optional) - The ID of the object.
+     * @param {string} entryObject.title - The title of the entry to be presented in the list in the User Preferences dialog box. We recommend using a string from the translation bundle.
+     * @param {string|function} value - A string to be presented as the value of the entry OR a function to be called which returns a {jQuery.Deferred.promise} object.
+     * @param {function} entryObject.content - A function to be called that returns a {jQuery.Deferred.promise} object which consists of a
+     * {sap.ui.core.Control} to be displayed in a follow-on dialog box. A SAPUI5 view instance can also be returned. The function is called on each time the user opens the User Preferences dialog box.
+     * @param {function} entryObject.onSave - A function to be called which returns a {jQuery.Deferred.promise} object when the user clicks "save" in the User Preferences dialog box.
+     * If an error occurs, pass the error message via the {jQuery.Deferred.promise} object. Errors are displayed in the log.
+     * @param {function} entryObject.onCancel - A function to be called that closes the User Preferences dialog box without saving any changes.
+     * @param {boolean} entryObject.provideEmptyWrapper - Experimental. Set this value to true if you want that your content is displayed without the standard header.
      *
      * @since 1.30
      * @public
      */
     Renderer.prototype.addUserPreferencesEntry = function (entryObject) {
-        return this.shellCtrl.addUserPreferencesEntry(entryObject);
+        this.shellCtrl.addUserPreferencesEntry(entryObject);
     };
 
     /**
@@ -2638,7 +2617,7 @@ sap.ui.define([
      *     }
      * </pre>
      * @param {function} fnProvider A function returning an array
-     * @returns {Promise<void>} Resolves once the provider was registered
+     * @returns {Promise<undefined>} Resolves once the provider was registered
      *
      * @private
      */
@@ -2772,24 +2751,18 @@ sap.ui.define([
         return this.shellCtrl.getView().waitForShellLayout();
     };
 
-    /**
-     * @returns {Promise} Resolves all initializations have settled
-     *
-     * @private
-     * @since 1.114.0
-     */
-    Renderer.prototype.awaitPendingInitializations = function () {
-        if (this.shellCtrl.getView().awaitPendingInitializations) {
-            return this.shellCtrl.getView().awaitPendingInitializations();
-        }
-        return Promise.resolve();
-    };
-
     /**
      * @private
      */
-    Renderer.prototype.exit = function () {
-        ShellLayout.destroyLayout();
+    Renderer.prototype.destroy = function () {
+        var oPromise = this.shellCtrl ? this.shellCtrl.awaitPendingInitializations() : Promise.resolve();
+        return oPromise
+            .then(function () {
+                return UIComponent.prototype.destroy.apply(this, arguments);
+            }.bind(this))
+            .then(function () {
+                ShellLayout.destroyLayout();
+            });
     };
 
     return Renderer;

package/src/main/js/sap/ushell/renderers/fiori2/Shell.controller.js

@@ -116,11 +116,89 @@ sap.ui.define([
      * @public
      */
     return Controller.extend("sap.ushell.renderers.fiori2.Shell", {
+        _aDoables: [],
+
+        addDoable: function (oDoable) {
+            this._aDoables.push(oDoable);
+        },
+
+        _aDanglingControls: [],
+
         /**
-         * SAPUI5 lifecycle hook.
-         * @public
+         * @param {sap.ui.core.Control} oControl The Control
+         * @see sap.ushell.renderers.fiori2.Shell.controller#onExit
+         *
+         * @private
+         * @since 1.115.0
          */
-        _aDoables: [],
+        addDanglingControl: function (oControl) {
+            this._aDanglingControls.push(oControl);
+        },
+
+        _aDanglingBindings: [],
+
+        /**
+         * Adds a binding which is destroyed on Renderer destroy
+         * @param {sap.ui.model.Binding} oBinding The Binding
+         * @see sap.ushell.renderers.fiori2.Shell.controller#onExit
+         *
+         * @private
+         * @since 1.115.0
+         */
+        addDanglingBinding: function (oBinding) {
+            this._aDanglingBindings.push(oBinding);
+        },
+
+        /**
+         * @param {sap.ui.model.Binding} oTargetBinding The Binding
+         * @see sap.ushell.renderers.fiori2.Shell.controller#onExit
+         *
+         * @private
+         * @since 1.115.0
+         */
+        removeDanglingBinding: function (oTargetBinding) {
+            var iBindingIndex = this._aDanglingBindings.findIndex(function (oBinding) {
+                return oBinding === oTargetBinding;
+            });
+
+            if (iBindingIndex > -1) {
+                this._aDanglingBindings.splice(iBindingIndex, 1);
+            }
+        },
+
+        _aPendingInitializations: [],
+
+        /**
+         * Adds a promise to the list of initializations
+         * Only used in test environments!
+         * @param {Promise} oPromise A Promise
+         * @returns {Promise} Returns the provided promise to allow chaining
+         *
+         * @private
+         * @since 1.115.0
+         */
+        addPendingInitialization: function (oPromise) {
+            this._aPendingInitializations.push(oPromise);
+            return oPromise;
+        },
+
+        /**
+         * Only used in test environments!
+         * @returns {Promise} Resolves once all initializations have settled
+         *
+         * @private
+         * @since 1.115.0
+         */
+        awaitPendingInitializations: function () {
+            var iOldLength = this._aPendingInitializations.length;
+            return Promise.allSettled(this._aPendingInitializations)
+                .then(function () {
+                    var iNewLength = this._aPendingInitializations.length;
+                    if (iOldLength < iNewLength) {
+                        return this.awaitPendingInitializations();
+                    }
+                }.bind(this));
+        },
 
         onComponentTargetDisplay: function (oEvent) {
             var oParameters = oEvent.getParameters();
@@ -201,7 +279,7 @@ sap.ui.define([
             this._setConfigurationToModel();
 
             // Doable objects are kept in a global array to enable their off-ing later on.
-            this._aDoables = this._registerAndCreateEventHubDoables();
+            this._registerAndCreateEventHubDoables();
 
             oShellModel.addHeaderEndItem(["userActionsMenuHeaderButton"], false, ["home", "app", "minimal", "standalone", "embedded", "embedded-home", "lean"], true);
 
@@ -346,12 +424,10 @@ sap.ui.define([
         },
 
         /**
-         * Creates the EventHub event bindings and returns them in a Array of doables.
-         *
-         * @returns {object[]} A list of "Doable" objects
+         * Creates the EventHub event bindings and saves them.
          */
         _registerAndCreateEventHubDoables: function () {
-            var aDoables = [
+            [
                 EventHub.once("CenterViewPointContentRendered").do(this._loadCoreExt.bind(this)),
                 EventHub.once("PagesRuntimeRendered").do(this._loadCoreExt.bind(this)),
                 EventHub.once("AppRendered").do(this._loadCoreExtNonUI5.bind(this)),
@@ -366,8 +442,9 @@ sap.ui.define([
                 EventHub.once("loadWarmupPlugins").do(this._loadWarmupPlugins.bind(this)),
                 EventHub.once("loadTrackingActivitiesSetting").do(this._loadTrackingActivitiesSetting.bind(this)),
                 EventHub.on("centerViewPort").do(this._centerViewPort.bind(this))
-            ];
-            return aDoables;
+            ].forEach(function (oDoable) {
+                this.addDoable(oDoable);
+            }.bind(this));
         },
 
         initShellModel: function (oConfigForModel, oApplicationModel) {
@@ -476,6 +553,7 @@ sap.ui.define([
                 oModel.setProperty("/searchAvailable", (oConfig.enableSearch !== false));
             }
         },
+
         _loadTrackingActivitiesSetting: function (eventData) {
             // Tracking activities
             this._getPersData({
@@ -520,7 +598,7 @@ sap.ui.define([
          * The iframe will be used for rare scenarios in which additional authentication is required.
          * This is mainly related to SAML 2.0 flows. The api sequence will be managed by UI2 services.
          *
-         * @returns {{create: Function, show: Function, destroy: Function}} Logon Frame Provider interface
+         * @returns {{create: function, show: function, destroy: function}} Logon Frame Provider interface
          * @private
          */
         _getLogonFrameProvider: function () {
@@ -533,6 +611,16 @@ sap.ui.define([
             });
             this._aDoables = [];
 
+            this._aDanglingControls.forEach(function (oControl) {
+                oControl.destroy();
+            });
+            this._aDanglingControls = [];
+
+            this._aDanglingBindings.forEach(function (oBinding) {
+                oBinding.destroy();
+            });
+            this._aDanglingBindings = [];
+
             Core.getEventBus().unsubscribe("externalSearch", this.externalSearchTriggered, this);
             Core.getEventBus().unsubscribe("ESHSearchFinished", this._logSearchActivity, this);
             Core.getEventBus().unsubscribe("sap.ushell", "appOpened", this.onAppOpened, this);
@@ -542,21 +630,6 @@ sap.ui.define([
                 this.oShellNavigation.hashChanger.destroy();
             }
 
-            var oView = this.getView();
-            if (oView) {
-                if (oView.destroyDanglingControls) {
-                    this.getView().destroyDanglingControls();
-                }
-
-                if (oView.destroyDanglingBindings) {
-                    this.getView().destroyDanglingBindings();
-                }
-
-                if (oView.destroyDoables) {
-                    this.getView().destroyDoables();
-                }
-            }
-
             HeaderManager.destroy();
             HeaderControlManager.destroy();
 
@@ -758,7 +831,7 @@ sap.ui.define([
          * Wait for the given hash to be loaded by the browser.
          *
          * @param {string} hash The hash to wait for.
-         * @returns {Promise<void>} A promise that is resolved once the given hash was found. It is not rejected.
+         * @returns {Promise<undefined>} A promise that is resolved once the given hash was found. It is not rejected.
          * @since 1.86.0
          * @private
          */
@@ -940,7 +1013,7 @@ sap.ui.define([
          * - URL is pasted in a new window
          * - user opens the page and pastes a URL
          *
-         * @return {boolean} whether the application is in a cold start state
+         * @returns {boolean} whether the application is in a cold start state
          */
         _isColdStart: function () {
             var oRenderer = sap.ushell.Container.getRenderer("fiori2");
@@ -1175,7 +1248,7 @@ sap.ui.define([
                                     // This is because oResolvedHashFragment contains the component handle already.
                                     // See the preceding note in AppLifeCycle.createComponent.
                                     Measurement.end("FLP:ShellController.UI5createComponent");
-                                    oShellController._initiateApplication(oResolvedHashFragment, sFixedShellHash, oParsedShellHash, iOriginalHistoryLength, sAppPart);
+                                    oShellController._initiateApplication(oResolvedHashFragment, sFixedShellHash, oParsedShellHash, iOriginalHistoryLength, sAppPart, sOldFixedShellHash, sOldAppPart);
                                 }).fail(function (vError) {
                                     var sErrorReason = ushellResources.i18n.getText("cannot_load_ui5_component_details", [sFixedShellHash]);
                                     var sErrorReasonEnglish = "Failed to load UI5 component for navigation intent " + sFixedShellHash;
@@ -1303,6 +1376,7 @@ sap.ui.define([
                 });
             });
         },
+
         _initiateApplication: function (oResolvedHashFragment, sFixedShellHash, oParsedShellHash, iOriginalHistoryLength, sAppPart, sOldFixedShellHash, sOldAppPart) {
             Measurement.start("FLP:ShellController._initiateApplication", "_initiateApplication", "FLP");
 
@@ -1579,7 +1653,7 @@ sap.ui.define([
          *
          * @param {object} oResolvedHashFragment
          *  The resolved hash fragment
-         * @return {Promise}
+         * @returns {Promise}
          *  Whether NWBC managed to open the application (resolved with either true or false)
          *
          * @private
@@ -1722,7 +1796,7 @@ sap.ui.define([
          * to navigate one step back in the browser history to restore the current hash.
          *
          * @param {object} oResolvedHashFragment The resolved hash fragment.
-         * @return {Promise} A Promise resolving when the hash is restored.
+         * @returns {Promise} A Promise resolving when the hash is restored.
          * @private
          */
         _restoreAfterNwbcNavigation: function (oResolvedHashFragment) {
@@ -1964,7 +2038,7 @@ sap.ui.define([
         /**
          * Shows an error message and navigates to the previous page.
          *
-         * @param {number} iHistoryLength the length of the history <b>before</b> the navigation occurred.
+         * @param {int} iHistoryLength the length of the history <b>before</b> the navigation occurred.
          * @param {string|object} vMessage the error message
          * @param {string|object} vDetails the detailed error message
          * @param {string} sComponent the component that generated the error message
@@ -2489,6 +2563,8 @@ sap.ui.define([
         /**
          * This function handle the adding animations when dock/undock
          * @param {boolean} bIsDock set docked
+         * @returns {Promise} Resolves once the animation is done
+         *
          * @private
          */
         _startFloatingContainerAnimation: function (bIsDock) {
@@ -2767,18 +2843,14 @@ sap.ui.define([
         },
 
         setNavigationBar: function (oNavigationBar) {
-            var oView = this.getView();
-
             oNavigationBar.placeAt(ShellLayoutMapping.NavigationBar, "only");
-            oView.addDanglingControl(oNavigationBar);
+            this.addDanglingControl(oNavigationBar);
         },
 
         setShellShapes: function (oShellShapes) {
             if (oShellShapes.placeAt) {
-                var oView = this.getView();
-
                 oShellShapes.placeAt(ShellLayoutMapping.ShellShapes, "only");
-                oView.addDanglingControl(oShellShapes);
+                this.addDanglingControl(oShellShapes);
             } else if (oShellShapes instanceof Node) {
                 document.getElementById(ShellLayoutMapping.ShellShapes).appendChild(oShellShapes);
             }
@@ -2798,7 +2870,7 @@ sap.ui.define([
 
             oHelperModel.setProperty("/shell/footerContent", oFooter.getId());
             oFooter.placeAt(ShellLayoutMapping.Footer, "only");
-            oView.addDanglingControl(oFooter);
+            this.addDanglingControl(oFooter);
 
             if (oFooter._applyContextClassFor) {
                 oFooter._applyContextClassFor("footer");