@sapui5/sap.ushell 1.120.8 → 1.121.0

package/src/main/js/sap/ushell/ui/launchpad/TileStateInternal.js

@@ -0,0 +1,119 @@
+// Copyright (c) 2009-2023 SAP SE, All Rights Reserved
+
+/**
+ * @file Provides control "sap.ushell.ui.launchpad.TileStateInternal"
+ * Note: Link counterpart "sap.ushell.ui.launchpad.LinkTileWrapper"
+ * @see sap.ushell.ui.launchpad.LinkTileWrapper
+ */
+sap.ui.define([
+    "sap/ui/core/Control",
+    "sap/ui/core/Icon",
+    "sap/ushell/resources",
+    "sap/ui/core/HTML",
+    "./TileStateInternalRenderer",
+    "sap/ushell/library" // css style dependency
+], function (
+    Control,
+    Icon,
+    resources,
+    HTML,
+    TileStateRenderer
+    // library
+) {
+    "use strict";
+
+    /**
+     * @alias sap.ushell.ui.launchpad.TileStateInternal
+     * @class
+     * @classdesc Constructor for a new ui/launchpad/TileState.
+     * The tile state control that displays loading indicator,
+     * while tile view is loading and failed status in case tile view is not available.
+     *
+     * @param {string} [sId] id for the new control, generated automatically if no id is given
+     * @param {object} [mSettings] initial settings for the new control
+     *
+     * @extends sap.ui.core.Control
+     *
+     * @private
+     */
+    var TileStateInternal = Control.extend("sap.ushell.ui.launchpad.TileStateInternal", /** @lends sap.ushell.ui.launchpad.TileStateInternal.prototype */ {
+        metadata: {
+            library: "sap.ushell",
+            properties: {
+                // load state
+                state: { type: "string", group: "Misc", defaultValue: "Loaded" }
+            },
+            events: {
+                press: {}
+            }
+        },
+        renderer: TileStateRenderer
+    });
+
+    TileStateInternal.prototype.init = function () {
+        this._rb = resources.i18n;
+
+        this._sFailedToLoad = this._rb.getText("cannotLoadTile");
+
+        this._oWarningIcon = new Icon(this.getId() + "-warn-icon", {
+            src: "sap-icon://notification",
+            size: "1.37rem"
+        }).addStyleClass("sapSuiteGTFtrFldIcnMrk");
+
+        this.attachPress(this._onPress);
+    };
+
+    /**
+     * Mapping of the native browser event to the UI5 semantic event.
+     *
+     * @param {object} [oEvent] The event object coming from the browser (not from UI5).
+     * @private
+     */
+    TileStateInternal.prototype.onclick = function (/*oEvent*/) {
+        this.firePress();
+    };
+
+    /**
+     * Handler of the "press" event.
+     * Checks whether the tile is in the "Failed" state and, if so, opens the FailedTileDialog. Does nothing otherwise.
+     *
+     * @param {sap.ui.base.Event} [oEvent] The event object.
+     * @private
+     */
+    TileStateInternal.prototype._onPress = function (oEvent) {
+        if (this.getState() !== "Failed") { return; }
+        if (!this.FailedTileDialog) {
+            sap.ui.require(["sap/ushell/ui/launchpad/FailedTileDialog"], function (FailedTileDialog) {
+                this.FailedTileDialog = new FailedTileDialog();
+                this._onPress(oEvent);
+            }.bind(this));
+        } else {
+            this.FailedTileDialog.openFor(this);
+        }
+    };
+
+    TileStateInternal.prototype._getBusyContainer = function () {
+        if (!this._oBusyContainer) {
+            this._oBusyContainer = new HTML({
+                content: "<div class='sapUshellTileStateLoading'><div>"
+            });
+            this._oBusyContainer.setBusy(true);
+        }
+
+        return this._oBusyContainer;
+    };
+
+    TileStateInternal.prototype.exit = function () {
+        this._oWarningIcon.destroy();
+        if (this._oBusyContainer) {
+            this._oBusyContainer.destroy();
+        }
+    };
+
+    TileStateInternal.prototype.setState = function (oState, isSuppressed) {
+        this.setProperty("state", oState, isSuppressed);
+        return this;
+    };
+
+    return TileStateInternal;
+});

package/src/main/js/sap/ushell/ui/launchpad/TileStateInternalRenderer.js

@@ -0,0 +1,72 @@
+// Copyright (c) 2009-2023 SAP SE, All Rights Reserved
+
+sap.ui.define([], function () {
+    "use strict";
+
+    /**
+     * TileState renderer.
+     * @namespace
+     * @static
+     * @private
+     */
+    var TileStateInternalRenderer = {
+        apiVersion: 2
+    };
+
+    /**
+     * Renders the HTML for the given control, using the provided {@link sap.ui.core.RenderManager}.
+     *
+     * @param {sap.ui.core.RenderManager} rm the RenderManager that can be used for writing to the render output buffer
+     * @param {sap.ui.core.Control} oControl an object representation of the control that should be rendered
+     */
+    TileStateInternalRenderer.render = function (rm, oControl) {
+        rm.openStart("div", oControl);
+        rm.class("sapUshellGT");
+        rm.openEnd();
+
+        var sState = oControl.getState();
+
+        rm.openStart("div", oControl.getId() + "-overlay");
+        rm.class("sapUshellOverlay");
+
+        if (sState === "Failed") {
+            rm.attr("title", oControl._sFailedToLoad);
+        }
+        rm.openEnd();
+
+        switch (sState) {
+            case "Loading":
+                var oBusyContainer = oControl._getBusyContainer();
+                rm.renderControl(oBusyContainer);
+                break;
+
+            case "Failed":
+                rm.openStart("div", oControl.getId() + "-failed-ftr");
+                rm.class("sapUshellTileStateFtrFld");
+                rm.openEnd();
+
+                rm.openStart("div", oControl.getId() + "-failed-icon");
+                rm.class("sapUshellTileStateFtrFldIcn");
+                rm.openEnd();
+
+                rm.renderControl(oControl._oWarningIcon);
+
+                rm.close("div");
+
+                rm.openStart("div", oControl.getId() + "-failed-text");
+                rm.class("sapUshellTileStateFtrFldTxt");
+                rm.openEnd();
+
+                rm.text(oControl._sFailedToLoad);
+
+                rm.close("div");
+                rm.close("div");
+                break;
+            default:
+        }
+        rm.close("div");
+        rm.close("div");
+    };
+
+    return TileStateInternalRenderer;
+}, /* bExport= */ false);

package/src/main/js/sap/ushell/ui/launchpad/TileStateRenderer.js

@@ -1,71 +1,10 @@
 // Copyright (c) 2009-2023 SAP SE, All Rights Reserved
 
-sap.ui.define([], function () {
+sap.ui.define([
+    "sap/ushell/ui/launchpad/TileStateInternalRenderer"
+], function (TileStateInternalRenderer) {
     "use strict";
 
-    /**
-     * @name TileState renderer.
-     * @static
-     * @private
-     */
-    var TileStateRenderer = {
-        apiVersion: 2
-    };
+    return TileStateInternalRenderer;
 
-    /**
-     * Renders the HTML for the given control, using the provided {@link sap.ui.core.RenderManager}.
-     *
-     * @param {sap.ui.core.RenderManager} rm the RenderManager that can be used for writing to the render output buffer
-     * @param {sap.ui.core.Control} oControl an object representation of the control that should be rendered
-     */
-    TileStateRenderer.render = function (rm, oControl) {
-        rm.openStart("div", oControl);
-        rm.class("sapUshellGT");
-        rm.openEnd();
-
-        var sState = oControl.getState();
-
-        rm.openStart("div", oControl.getId() + "-overlay");
-        rm.class("sapUshellOverlay");
-
-        if (sState === "Failed") {
-            rm.attr("title", oControl._sFailedToLoad);
-        }
-        rm.openEnd();
-
-        switch (sState) {
-            case "Loading":
-                var oBusyContainer = oControl._getBusyContainer();
-                rm.renderControl(oBusyContainer);
-                break;
-
-            case "Failed":
-                rm.openStart("div", oControl.getId() + "-failed-ftr");
-                rm.class("sapUshellTileStateFtrFld");
-                rm.openEnd();
-
-                rm.openStart("div", oControl.getId() + "-failed-icon");
-                rm.class("sapUshellTileStateFtrFldIcn");
-                rm.openEnd();
-
-                rm.renderControl(oControl._oWarningIcon);
-
-                rm.close("div");
-
-                rm.openStart("div", oControl.getId() + "-failed-text");
-                rm.class("sapUshellTileStateFtrFldTxt");
-                rm.openEnd();
-
-                rm.text(oControl._sFailedToLoad);
-
-                rm.close("div");
-                rm.close("div");
-                break;
-            default:
-        }
-        rm.close("div");
-        rm.close("div");
-    };
-
-    return TileStateRenderer;
 }, /* bExport= */ true);

package/src/main/js/sap/ushell/ui/launchpad/ViewPortState.js

@@ -1,11 +1,10 @@
 // Copyright (c) 2009-2023 SAP SE, All Rights Reserved
-/**
- * @name sap.ushell.ui.launchpad.ViewPortState
- *
- * @private
- */sap.ui.define(function() {
-	"use strict";
-
+sap.ui.define(function() {
+    "use strict";
 
+    /**
+     * @name sap.ushell.ui.launchpad.ViewPortState
+     * @private
+     */
 
 }, /* bExport= */ false);

package/src/main/js/sap/ushell/{services/_VisualizationInstantiation → ui/launchpad}/VizInstance.js

@@ -2,37 +2,33 @@
 
 sap.ui.define([
     "sap/m/ActionSheet",
-    "sap/m/Button",
     "sap/m/GenericTile",
     "sap/m/library",
     "sap/m/Popover",
     "sap/m/Text",
     "sap/m/VBox",
     "sap/ui/core/Component",
-    "sap/ui/core/Control",
-    "sap/ui/core/Core",
     "sap/ui/core/Icon",
+    "sap/ui/core/Lib",
     "sap/ui/events/PseudoEvents",
-    "sap/ushell/Config",
     "sap/ushell/library",
     "sap/ushell/resources",
-    "sap/ushell/services/_VisualizationInstantiation/VizInstanceRenderer"
+    "sap/ushell/ui/launchpad/VizInstanceBase",
+    "sap/ushell/ui/launchpad/VizInstanceRenderer"
 ], function (
     ActionSheet,
-    Button,
     GenericTile,
     mobileLibrary,
     Popover,
     Text,
     VBox,
     Component,
-    Control,
-    Core,
     Icon,
+    Library,
     PseudoEvents,
-    Config,
     ushellLibrary,
     resources,
+    VizInstanceBase,
     VizInstanceRenderer
 ) {
     "use strict";
@@ -53,9 +49,15 @@ sap.ui.define([
     var DisplayFormat = ushellLibrary.DisplayFormat;
 
     /**
+     * @alias sap.ushell.ui.launchpad.VizInstance
      * @class
+     * @classdesc Wrapper control for tiles. This control must only be created via {@link sap.ushell.services.VisualizationInstantiation#instantiateVisualization}
+     *
+     * @extends sap.ushell.ui.launchpad.VizInstanceBase
+     *
+     * @private
      */
-    var VizInstance = Control.extend("sap.ushell.ui.launchpad.VizInstance", /** @lends sap.ushell.ui.launchpad.VizInstance.prototype*/ {
+    var VizInstance = VizInstanceBase.extend("sap.ushell.ui.launchpad.VizInstance", /** @lends sap.ushell.ui.launchpad.VizInstance.prototype*/ {
         metadata: {
             library: "sap.ushell",
             properties: {
@@ -144,11 +146,15 @@ sap.ui.define([
                     type: "string",
                     defaultValue: ""
                 },
+                contentProviderLabel: {
+                    type: "string",
+                    defaultValue: ""
+                },
                 vizConfig: {
                     type: "object"
                 },
                 supportedDisplayFormats: {
-                    type: "string[]",
+                    type: "sap.ushell.DisplayFormat[]",
                     defaultValue: [DisplayFormat.Standard]
                 },
                 dataHelpId: {
@@ -165,7 +171,7 @@ sap.ui.define([
                  * would fail validation instead of falling back to default.
                  */
                 displayFormat: {
-                    type: "string",
+                    type: "sap.ushell.DisplayFormat",
                     defaultValue: DisplayFormat.Standard
                 },
                 preview: {
@@ -203,7 +209,6 @@ sap.ui.define([
     });
 
     VizInstance.prototype.init = function () {
-        this._customTileActions = [];
         var oContent = new GenericTile({
             frameType: this._formatPlaceholderFrameType(this.getDisplayFormat()),
             state: this.getState()
@@ -214,7 +219,13 @@ sap.ui.define([
         this.setAggregation("content", oContent);
     };
 
-
+    /**
+     * Updates current displayFormat and sets the size accordingly
+     * @param {sap.ushell.DisplayFormat} sDisplayFormat The new displayFormat
+     * @returns {this} Reference to <code>this</code> for method chaining.
+     *
+     * @private
+     */
     VizInstance.prototype.setDisplayFormat = function (sDisplayFormat) {
         this.setProperty("displayFormat", sDisplayFormat);
         this._setSize();
@@ -226,6 +237,13 @@ sap.ui.define([
         return this;
     };
 
+    /**
+     * Updates current state
+     * @param {sap.m.LoadState} sState The new state
+     * @returns {this} Reference to <code>this</code> for method chaining.
+     *
+     * @private
+     */
     VizInstance.prototype.setState = function (sState) {
         this.setProperty("state", sState);
 
@@ -238,8 +256,10 @@ sap.ui.define([
 
     /**
      * @param {sap.m.TileSizeBehavior} sSizeBehavior The sizeBehavior.
-     * @returns {sap.ushell.services._VisualizationInstantiation.VizInstance} The vizInstance.
+     * @returns {this} Reference to <code>this</code> for method chaining.
+     *
      * @since 1.116.0
+     * @private
      */
     VizInstance.prototype.setSizeBehavior = function (sSizeBehavior) {
         this.setProperty("sizeBehavior", sSizeBehavior);
@@ -247,6 +267,12 @@ sap.ui.define([
         return this;
     };
 
+    /**
+     * @param {boolean} editable The editable boolean.
+     * @returns {this} Reference to <code>this</code> for method chaining.
+     *
+     * @private
+     */
     VizInstance.prototype.setEditable = function (editable) {
         this.setProperty("editable", editable);
         this.setTileEditable(editable);
@@ -258,8 +284,10 @@ sap.ui.define([
      * This method is supposed to be overridden by child classes.
      *
      * @param {boolean} editable The edit mode flag.
-     * @returns {VizInstance} The current VizInstance.
+     * @returns {this} Reference to <code>this</code> for method chaining.
+     *
      * @since 1.104.0
+     * @private
      */
     VizInstance.prototype.setTileEditable = function (editable) {
         var sScope = editable ? GenericTileScope.ActionMore : GenericTileScope.Display;
@@ -276,8 +304,10 @@ sap.ui.define([
      * This method is supposed to be overridden by child classes.
      *
      * @param {sap.m.TileSizeBehavior} sSizeBehavior The sizeBehavior.
-     * @returns {VizInstance} The current VizInstance.
+     * @returns {this} Reference to <code>this</code> for method chaining.
+     *
      * @since 1.104.0
+     * @private
      */
     VizInstance.prototype.setTileSizeBehavior = function (sSizeBehavior) {
         var oContent = this.getContent();
@@ -328,8 +358,10 @@ sap.ui.define([
     /**
      * Returns the layout data for the GridContainer/Section.
      *
-     * @returns {object} The layout data in "columns x rows" format. E.g.: "2x2"
+     * @returns {{columns: int, rows: int}} The layout data in "columns x rows" format. E.g.: "2x2"
+     *
      * @since 1.77.0
+     * @private
      */
     VizInstance.prototype.getLayout = function () {
         return {
@@ -342,7 +374,9 @@ sap.ui.define([
      * Updates the content aggregation of the control and recalculates its layout data
      *
      * @param {sap.ui.core.Control} content The control to be put inside the visualization
+     *
      * @since 1.77.0
+     * @private
      */
     VizInstance.prototype.setContent = function (content) {
         var oGridData = this.getLayoutData();
@@ -369,14 +403,15 @@ sap.ui.define([
      * Removes the tabindex of a possible genericTile inside of the given control.
      *
      * @param {sap.ui.core.Control} [content] the control to search in
-     * @private
+     *
      * @since 1.121
+     * @private
      */
     VizInstance.prototype._disableTabindexOfContent = function (content) {
         if (content) {
             if (content.isA("sap.ui.core.ComponentContainer")) {
                 var sComponentName = content.getComponent();
-                var oComponent = Component.get(sComponentName);
+                var oComponent = Component.getComponentById(sComponentName);
                 if (oComponent) {
                     this._disableTabindexOfContent(oComponent.getRootControl());
                 }
@@ -403,8 +438,9 @@ sap.ui.define([
      * Removes the tabindex of tile, so we avoid the inner and outer focus issue.
      *
      * @param {sap.m.GenericTile} genericTile the tile that should not be focusable
-     * @private
+     *
      * @since 1.121
+     * @private
      */
     VizInstance.prototype._disableTabindexOfGenericTile = function (genericTile) {
         function removeTabindex (control) {
@@ -428,6 +464,8 @@ sap.ui.define([
      * Returns a new ActionSheet. If it was already created it will return the instance.
      *
      * @returns {sap.m.ActionSheet} The ActionSheet control.
+     *
+     * @private
      */
     VizInstance.prototype._getTileActionSheet = function () {
         if (!this._oActionSheet) {
@@ -439,47 +477,6 @@ sap.ui.define([
         return this._oActionSheet;
     };
 
-    /**
-     * Destroys all custom TileActions
-     * @private
-     */
-    VizInstance.prototype._destroyCustomTileActions = function () {
-        this._customTileActions.forEach(function (oButton) {
-            this.removeTileAction(oButton);
-            oButton.destroy();
-        }.bind(this));
-        this._customTileActions = [];
-    };
-
-    /**
-     * Destroys existing custom TileActions and adds them back.
-     * This allows TileActionsProviders to change their tileActions
-     * @returns {Promise<undefined>} Resolves when the tileActions were added
-     * @private
-     */
-    VizInstance.prototype._addCustomTileActions = function () {
-        if (this._oCustomTileActionsPromise) {
-            return this._oCustomTileActionsPromise;
-        }
-
-        // destroy all existing to avoid duplicates
-        this._destroyCustomTileActions();
-
-        var oRenderer = sap.ushell.Container.getRenderer();
-
-        this._oCustomTileActionsPromise = oRenderer.getCustomTileActions(this).then(function (aTileActions) {
-            aTileActions.forEach(function (oTileAction) {
-                var oButton = new Button(oTileAction);
-                this._customTileActions.push(oButton);
-                this.addTileAction(oButton);
-            }.bind(this));
-
-            this._oCustomTileActionsPromise = null;
-        }.bind(this));
-
-        return this._oCustomTileActionsPromise;
-    };
-
     /**
      * Press handler for action menu icon.
      *
@@ -492,11 +489,6 @@ sap.ui.define([
                 this.fireBeforeActionSheetOpen();
             }
 
-            var bEnableTileColors = Config.last("/core/extension/enableTileColors");
-            if (bEnableTileColors) {
-                this._addCustomTileActions();
-            }
-
             if (this.getTileActions().length === 0) {
                 this._openNoActionsPopover();
                 return;
@@ -508,8 +500,8 @@ sap.ui.define([
 
     /**
      * Does a lookup on the internal content aggregation and searches for a proper dom ref to focus
-     *
      * @returns {object} the dom ref to focus
+     *
      * @private
      */
     VizInstance.prototype.getFocusDomRef = function () {
@@ -543,9 +535,10 @@ sap.ui.define([
 
     /**
      * Click handler. Prevents the navigation if the edit mode is active.
-     *
      * @param {Event} oEvent The Event object
+     *
      * @since 1.78.0
+     * @private
      */
     VizInstance.prototype.onclick = function (oEvent) {
         if (this._preventDefault(oEvent)) {
@@ -571,11 +564,16 @@ sap.ui.define([
         }
     };
 
+    /**
+     * @private
+     */
     VizInstance.prototype._openNoActionsPopover = function () {
+        var oText = new Text({ text: resources.i18n.getText("tileHasNoActions") });
         new Popover({
             placement: PlacementType.VerticalPreferedBottom,
             showHeader: false,
-            content: new Text({ text: resources.i18n.getText("tileHasNoActions") })
+            ariaLabelledBy: oText.getId(),
+            content: oText
         }).addStyleClass("sapUiContentPadding").openBy(this._oActionModeIcon);
     };
 
@@ -607,7 +605,8 @@ sap.ui.define([
      * If delete or backspace is pressed, the focused VizInstance gets removes.
      * If space or enter is pressed, the navigation gets prevented.
      *
-     * @param {Event} oEvent Browser Keyboard event
+     * @param {sap.ui.base.Event} oEvent Browser Keyboard event
+     *
      * @since 1.78.0
      * @private
      */
@@ -630,9 +629,11 @@ sap.ui.define([
     /**
      * Stops the given event from bubbling up or down the DOM and prevents its default behavior.
      *
-     * @param {Event} oEvent The browser event
+     * @param {sap.ui.base.Event} oEvent The browser event
      * @returns {boolean} False if the default behavior is prevented, otherwise true.
+     *
      * @since 1.78.0
+     * @private
      */
     VizInstance.prototype._preventDefault = function (oEvent) {
         if (this.getEditable() || !this.getClickable()) {
@@ -648,10 +649,11 @@ sap.ui.define([
      * Loads the content of the VizInstance and resolves the returned Promise
      * when loading is completed.
      * @param {boolean} [bIsCustomVizType] Should be true if the visualization is a custom one. (Only used in CDM)
+     * @returns {Promise} Resolves when loading is completed
      *
-     * @returns {Promise<undefined>} Resolves when loading is completed
      * @abstract
      * @since 1.77.0
+     * @private
      */
     VizInstance.prototype.load = function () {
         // As this is the base control that doesn't load anything, a resolved Promise is
@@ -663,6 +665,7 @@ sap.ui.define([
      * Sets the width and the height of the vizInstance based on the display format.
      *
      * @since 1.88.0
+     * @private
      */
     VizInstance.prototype._setSize = function () {
         var oSize = {};
@@ -693,9 +696,10 @@ sap.ui.define([
     /**
      * Returns all display formats available after filtering out the current and non-eligible ones
      *
-     * @returns {string[]} aAvailableDisplayFormats The available display formats
+     * @returns {sap.ushell.DisplayFormat[]} aAvailableDisplayFormats The available display formats
      *
      * @since 1.85.0
+     * @private
      */
     VizInstance.prototype.getAvailableDisplayFormats = function () {
         var aAvailableDisplayFormats;
@@ -720,12 +724,14 @@ sap.ui.define([
     /**
      * Instantiates and returns the VBox containing the remove icon used in the edit mode
      *
+     * @returns {sap.m.VBox} The VBox containing the remove icon
+     *
      * @since 1.93.0
-     * @returns {object} The VBox containing the remove icon
+     * @private
      */
     VizInstance.prototype._getRemoveIconVBox = function () {
         if (!this._oRemoveIconVBox) {
-            var oMBundle = Core.getLibraryResourceBundle("sap.m");
+            var oMBundle = Library.getResourceBundleFor("sap.m");
             var oRemoveIcon = new Icon({
                 id: this.getId() + "-action-remove",
                 alt: oMBundle.getText("GENERICTILE_ACTIONS_ARIA_TEXT"),
@@ -747,12 +753,14 @@ sap.ui.define([
     /**
      * Instantiates and returns the VBox containing the Icon used to access the tile options menu
      *
+     * @returns {sap.m.VBox} The VBox containing the Icon used to access the tile options menu
+     *
      * @since 1.93.0
-     * @returns {object} The VBox containing the Icon used to access the tile options menu
+     * @private
      */
     VizInstance.prototype._getActionModeButtonIconVBox = function () {
         if (!this._oActionModeButtonIconVBox) {
-            var oMBundle = Core.getLibraryResourceBundle("sap.m");
+            var oMBundle = Library.getResourceBundleFor("sap.m");
 
             this._oActionModeIcon = new Icon({
                 id: this.getId() + "-action-more",