@openui5/ts-types 1.114.0 → 1.115.1

package/types/sap.tnt.d.ts

@@ -1,14 +1,14 @@
-// For Library Version: 1.114.0
+// For Library Version: 1.115.1
 
 declare namespace sap {
   /**
-   * @SINCE 1.36
+   * @since 1.36
    *
    * SAPUI5 library with controls specialized for administrative applications.
    */
   namespace tnt {
     /**
-     * @SINCE 1.68
+     * @since 1.68
      *
      * Interface for controls suitable for the `header` aggregation of {@link sap.tnt.ToolPage}.
      */
@@ -70,7 +70,7 @@ declare namespace sap {
         | `{${string}}`;
 
       /**
-       * @SINCE 1.74
+       * @since 1.74
        *
        * Defines the icon to be displayed as graphical element within the `InfoLabel`. It can be an icon from
        * the icon font.
@@ -99,7 +99,7 @@ declare namespace sap {
         | `{${string}}`;
 
       /**
-       * @SINCE 1.62.0
+       * @since 1.62.0
        *
        * Specifies the currently selected key.
        */
@@ -125,7 +125,7 @@ declare namespace sap {
       ariaLabelledBy?: Array<sap.ui.core.Control | string>;
 
       /**
-       * @SINCE 1.52.0
+       * @since 1.52.0
        *
        * The currently selected `NavigationListItem`.
        */
@@ -134,7 +134,9 @@ declare namespace sap {
       /**
        * Fired when an item is selected.
        */
-      itemSelect?: (oEvent: sap.ui.base.Event) => void;
+      itemSelect?: (
+        oEvent: sap.ui.base.Event<sap.tnt.NavigationList$ItemSelectEventParameters>
+      ) => void;
     }
 
     interface $NavigationListItemSettings extends sap.ui.core.$ItemSettings {
@@ -163,7 +165,7 @@ declare namespace sap {
         | `{${string}}`;
 
       /**
-       * @SINCE 1.52
+       * @since 1.52
        *
        * Specifies if the item should be shown.
        */
@@ -202,7 +204,9 @@ declare namespace sap {
       /**
        * Fired when this item is selected.
        */
-      select?: (oEvent: sap.ui.base.Event) => void;
+      select?: (
+        oEvent: sap.ui.base.Event<sap.tnt.NavigationListItem$SelectEventParameters>
+      ) => void;
     }
 
     interface $SideNavigationSettings extends sap.ui.core.$ControlSettings {
@@ -215,14 +219,14 @@ declare namespace sap {
         | `{${string}}`;
 
       /**
-       * @SINCE 1.62.0
+       * @since 1.62.0
        *
        * Specifies the currently selected key.
        */
       selectedKey?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
 
       /**
-       * @SINCE 1.98
+       * @since 1.98
        *
        * Specifies an optional aria-label that can be used by the screen readers.
        */
@@ -244,7 +248,7 @@ declare namespace sap {
       footer?: sap.tnt.NavigationList;
 
       /**
-       * @SINCE 1.52.0
+       * @since 1.52.0
        *
        * The selected `NavigationListItem`.
        */
@@ -253,7 +257,9 @@ declare namespace sap {
       /**
        * Fired when an item is selected.
        */
-      itemSelect?: (oEvent: sap.ui.base.Event) => void;
+      itemSelect?: (
+        oEvent: sap.ui.base.Event<sap.tnt.SideNavigation$ItemSelectEventParameters>
+      ) => void;
     }
 
     interface $ToolHeaderSettings extends sap.m.$OverflowToolbarSettings {}
@@ -270,13 +276,23 @@ declare namespace sap {
         | sap.ui.base.ManagedObject.PropertyBindingInfo
         | `{${string}}`;
 
+      /**
+       * @since 1.115
+       *
+       * Specifies the content background design.
+       */
+      contentBackgroundDesign?:
+        | sap.m.PageBackgroundDesign
+        | sap.ui.base.ManagedObject.PropertyBindingInfo
+        | `{${string}}`;
+
       /**
        * The control to appear in the header area.
        */
       header?: sap.tnt.IToolHeader;
 
       /**
-       * @SINCE 1.93
+       * @since 1.93
        *
        * The control to appear in the subheader area.
        */
@@ -297,8 +313,29 @@ declare namespace sap {
         | `{${string}}`;
     }
 
+    interface NavigationList$ItemSelectEventParameters {
+      /**
+       * The selected item.
+       */
+      item?: sap.ui.core.Item;
+    }
+
+    interface NavigationListItem$SelectEventParameters {
+      /**
+       * The selected item.
+       */
+      item?: sap.ui.core.Item;
+    }
+
+    interface SideNavigation$ItemSelectEventParameters {
+      /**
+       * The selected item.
+       */
+      item?: sap.ui.core.Item;
+    }
+
     /**
-     * @SINCE 1.54
+     * @since 1.54
      *
      * The `InfoLabel` is a small non-interactive control which contains text information and non-semantic color
      * chosen from a list of predefined color schemes. It serves the purpose to attract the user attention to
@@ -315,9 +352,9 @@ declare namespace sap {
      *
      * Usage Guidelines:
      * 	 - If the text is longer than the width of the control, it doesn’t wrap. Instead, it’s represented as
-     * 			ellipsis.
+     *     ellipsis.
      * 	 - When truncated, the full text in the control is not visible. Therefore, it’s recommended to make
-     * 			more space for longer items to be fully displayed.
+     *     more space for longer items to be fully displayed.
      * 	 - Colors are not semantic and have no visual representation in sap_belize_hcb and sap_belize_hcw themes.
      *
      * 	 - The control shows plain text only, formatting is not visualized.
@@ -425,7 +462,7 @@ declare namespace sap {
        */
       getDisplayOnly(): boolean;
       /**
-       * @SINCE 1.74
+       * @since 1.74
        *
        * Gets current value of property {@link #getIcon icon}.
        *
@@ -517,7 +554,7 @@ declare namespace sap {
         bDisplayOnly?: boolean
       ): this;
       /**
-       * @SINCE 1.74
+       * @since 1.74
        *
        * Sets a new value for property {@link #getIcon icon}.
        *
@@ -613,7 +650,7 @@ declare namespace sap {
       unbindText(): this;
     }
     /**
-     * @SINCE 1.34
+     * @since 1.34
      *
      * The NavigationList control is an interactive control, which provides a choice of different items, ordered
      * as a list.
@@ -731,7 +768,7 @@ declare namespace sap {
         /**
          * The function to be called when the event occurs
          */
-        fnFunction: (p1: sap.ui.base.Event) => void,
+        fnFunction: (p1: NavigationList$ItemSelectEvent) => void,
         /**
          * Context object to call the event handler with. Defaults to this `sap.tnt.NavigationList` itself
          */
@@ -751,7 +788,7 @@ declare namespace sap {
         /**
          * The function to be called when the event occurs
          */
-        fnFunction: (p1: sap.ui.base.Event) => void,
+        fnFunction: (p1: NavigationList$ItemSelectEvent) => void,
         /**
          * Context object to call the event handler with. Defaults to this `sap.tnt.NavigationList` itself
          */
@@ -774,14 +811,14 @@ declare namespace sap {
         /**
          * The function to be called, when the event occurs
          */
-        fnFunction: (p1: sap.ui.base.Event) => void,
+        fnFunction: (p1: NavigationList$ItemSelectEvent) => void,
         /**
          * Context object on which the given function had to be called
          */
         oListener?: object
       ): this;
       /**
-       * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+       * @ui5-protected Do not call from applications (only from related classes in the framework)
        *
        * Fires event {@link #event:itemSelect itemSelect} to attached listeners.
        *
@@ -791,21 +828,14 @@ declare namespace sap {
         /**
          * Parameters to pass along with the event
          */
-        mParameters?: {
-          /**
-           * The selected item.
-           */
-          item?: sap.ui.core.Item;
-        }
+        mParameters?: sap.tnt.NavigationList$ItemSelectEventParameters
       ): this;
       /**
-       * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy
-       * ariaDescribedBy}.
+       * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}.
        */
       getAriaDescribedBy(): sap.ui.core.ID[];
       /**
-       * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy
-       * ariaLabelledBy}.
+       * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
        */
       getAriaLabelledBy(): sap.ui.core.ID[];
       /**
@@ -831,7 +861,7 @@ declare namespace sap {
        */
       getSelectedItem(): sap.tnt.NavigationListItem | null;
       /**
-       * @SINCE 1.62.0
+       * @since 1.62.0
        *
        * Gets current value of property {@link #getSelectedKey selectedKey}.
        *
@@ -986,7 +1016,7 @@ declare namespace sap {
       ): this;
     }
     /**
-     * @SINCE 1.34
+     * @since 1.34
      *
      * The NavigationListItem control represents an action, which can be selected by the user. It can provide
      * sub items.
@@ -1082,7 +1112,7 @@ declare namespace sap {
         /**
          * The function to be called when the event occurs
          */
-        fnFunction: (p1: sap.ui.base.Event) => void,
+        fnFunction: (p1: NavigationListItem$SelectEvent) => void,
         /**
          * Context object to call the event handler with. Defaults to this `sap.tnt.NavigationListItem` itself
          */
@@ -1102,7 +1132,7 @@ declare namespace sap {
         /**
          * The function to be called when the event occurs
          */
-        fnFunction: (p1: sap.ui.base.Event) => void,
+        fnFunction: (p1: NavigationListItem$SelectEvent) => void,
         /**
          * Context object to call the event handler with. Defaults to this `sap.tnt.NavigationListItem` itself
          */
@@ -1125,14 +1155,14 @@ declare namespace sap {
         /**
          * The function to be called, when the event occurs
          */
-        fnFunction: (p1: sap.ui.base.Event) => void,
+        fnFunction: (p1: NavigationListItem$SelectEvent) => void,
         /**
          * Context object on which the given function had to be called
          */
         oListener?: object
       ): this;
       /**
-       * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+       * @ui5-protected Do not call from applications (only from related classes in the framework)
        *
        * Fires event {@link #event:select select} to attached listeners.
        *
@@ -1142,12 +1172,7 @@ declare namespace sap {
         /**
          * Parameters to pass along with the event
          */
-        mParameters?: {
-          /**
-           * The selected item.
-           */
-          item?: sap.ui.core.Item;
-        }
+        mParameters?: sap.tnt.NavigationListItem$SelectEventParameters
       ): this;
       /**
        * Gets current value of property {@link #getExpanded expanded}.
@@ -1159,6 +1184,14 @@ declare namespace sap {
        * @returns Value of property `expanded`
        */
       getExpanded(): boolean;
+      /**
+       * @ui5-protected Do not call from applications (only from related classes in the framework)
+       *
+       * Returns the DOM Element that should get the focus.
+       *
+       * @returns Returns the DOM Element that should get the focus
+       */
+      getFocusDomRef(): Element;
       /**
        * Gets current value of property {@link #getHasExpander hasExpander}.
        *
@@ -1207,7 +1240,7 @@ declare namespace sap {
        */
       getTarget(): string;
       /**
-       * @SINCE 1.52
+       * @since 1.52
        *
        * Gets current value of property {@link #getVisible visible}.
        *
@@ -1353,7 +1386,7 @@ declare namespace sap {
         sTarget?: string
       ): this;
       /**
-       * @SINCE 1.52
+       * @since 1.52
        *
        * Sets a new value for property {@link #getVisible visible}.
        *
@@ -1373,13 +1406,13 @@ declare namespace sap {
       ): this;
     }
     /**
-     * @SINCE 1.34
+     * @since 1.34
      *
      * The SideNavigation control is a container, which consists of flexible and fixed parts on top of each
      * other. Responsive Behavior:
      * 	 - The flexible part adapts its size to the fixed one.
      * 	 - The flexible part has a scrollbar when the content is larger than the available space.  **Note:**
-     * 			In order for the SideNavigation to stretch properly, its parent layout control should only be the sap.tnt.ToolPage.
+     *     In order for the SideNavigation to stretch properly, its parent layout control should only be the sap.tnt.ToolPage.
      */
     class SideNavigation extends sap.ui.core.Control {
       /**
@@ -1465,7 +1498,7 @@ declare namespace sap {
         /**
          * The function to be called when the event occurs
          */
-        fnFunction: (p1: sap.ui.base.Event) => void,
+        fnFunction: (p1: SideNavigation$ItemSelectEvent) => void,
         /**
          * Context object to call the event handler with. Defaults to this `sap.tnt.SideNavigation` itself
          */
@@ -1485,7 +1518,7 @@ declare namespace sap {
         /**
          * The function to be called when the event occurs
          */
-        fnFunction: (p1: sap.ui.base.Event) => void,
+        fnFunction: (p1: SideNavigation$ItemSelectEvent) => void,
         /**
          * Context object to call the event handler with. Defaults to this `sap.tnt.SideNavigation` itself
          */
@@ -1534,14 +1567,14 @@ declare namespace sap {
         /**
          * The function to be called, when the event occurs
          */
-        fnFunction: (p1: sap.ui.base.Event) => void,
+        fnFunction: (p1: SideNavigation$ItemSelectEvent) => void,
         /**
          * Context object on which the given function had to be called
          */
         oListener?: object
       ): this;
       /**
-       * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+       * @ui5-protected Do not call from applications (only from related classes in the framework)
        *
        * Fires event {@link #event:itemSelect itemSelect} to attached listeners.
        *
@@ -1551,15 +1584,10 @@ declare namespace sap {
         /**
          * Parameters to pass along with the event
          */
-        mParameters?: {
-          /**
-           * The selected item.
-           */
-          item?: sap.ui.core.Item;
-        }
+        mParameters?: sap.tnt.SideNavigation$ItemSelectEventParameters
       ): this;
       /**
-       * @SINCE 1.98
+       * @since 1.98
        *
        * Gets current value of property {@link #getAriaLabel ariaLabel}.
        *
@@ -1597,14 +1625,14 @@ declare namespace sap {
        */
       getItem(): sap.tnt.NavigationList;
       /**
-       * @SINCE 1.52.0
+       * @since 1.52.0
        *
        * ID of the element which is the current target of the association {@link #getSelectedItem selectedItem},
        * or `null`.
        */
       getSelectedItem(): sap.ui.core.ID;
       /**
-       * @SINCE 1.62.0
+       * @since 1.62.0
        *
        * Gets current value of property {@link #getSelectedKey selectedKey}.
        *
@@ -1614,7 +1642,7 @@ declare namespace sap {
        */
       getSelectedKey(): string;
       /**
-       * @SINCE 1.98
+       * @since 1.98
        *
        * Sets a new value for property {@link #getAriaLabel ariaLabel}.
        *
@@ -1704,18 +1732,21 @@ declare namespace sap {
       unbindItem(): this;
     }
     /**
-     * @SINCE 1.34
+     * @since 1.34
      *
-     * The ToolHeader control is a horizontal container that is most commonly used to display buttons, labels,
+     * The ToolHeader control is a horizontal container that is most commonly used to display buttons, texts,
      * and other various input controls. Overview: The ToolHeader control is based on {@link sap.m.OverflowToolbar}.
      * It contains clearly structured menus of commands that are available across the various apps within the
      * same tool layout. Usage:
+     * 	 - This control is specialized for administrative applications. For other types of applications use:
+     *     {@link sap.m.Shell}
      * 	 - If an app implements side navigation in addition to the tool header menu, the menu icon must be the
-     * 			first item on the left-hand side of the tool header.
+     *     first item on the left-hand side of the tool header.
      * 	 - The app menu and the side navigation must not have any dependencies and must work independently.
-     * 			 Fiori 3 theme specifics: In Fiori 3 Default theme the ToolHeader is with dark design unlike most
-     * 			of the other controls. This defines the usage of limited controls inside it, which will result in good
-     * 			design combination.
+     *      Horizon theme specifics: Only the following controls are supported: sap.m.Button, sap.m.Image,
+     *     sap.m.Title, sap.m.Text, sap.m.SearchField, sap.m.Avatar. Fiori 3 theme specifics: In Fiori 3 Default
+     *     theme the ToolHeader is with dark design unlike most of the other controls. This defines the usage of
+     *     limited controls inside it, which will result in good design combination.
      *  The ToolHeader stylizes the contained controls with the Shell color parameters, to match the dark design
      * requirement. However, that's not a dark theme.
      *
@@ -1749,8 +1780,8 @@ declare namespace sap {
        * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
        * of the syntax of the settings object.
        *
-       * This class does not have its own settings, but all settings applicable to the base type {@link sap.m.OverflowToolbar#constructor
-       * sap.m.OverflowToolbar} can be used.
+       * This class does not have its own settings, but all settings applicable to the base type {@link sap.m.OverflowToolbar#constructor sap.m.OverflowToolbar }
+       * can be used.
        * See:
        * 	{@link fiori:https://experience.sap.com/fiori-design-web/tool-header/ Tool Header}
        */
@@ -1767,8 +1798,8 @@ declare namespace sap {
        * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
        * of the syntax of the settings object.
        *
-       * This class does not have its own settings, but all settings applicable to the base type {@link sap.m.OverflowToolbar#constructor
-       * sap.m.OverflowToolbar} can be used.
+       * This class does not have its own settings, but all settings applicable to the base type {@link sap.m.OverflowToolbar#constructor sap.m.OverflowToolbar }
+       * can be used.
        * See:
        * 	{@link fiori:https://experience.sap.com/fiori-design-web/tool-header/ Tool Header}
        */
@@ -1814,7 +1845,7 @@ declare namespace sap {
       static getMetadata(): sap.ui.core.ElementMetadata;
     }
     /**
-     * @SINCE 1.16
+     * @since 1.16
      *
      * The ToolHeaderUtilitySeparator control is used in the sap.tnt.ToolHeader control to specify where the
      * overflow button is placed.
@@ -1827,8 +1858,8 @@ declare namespace sap {
        * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
        * of the syntax of the settings object.
        *
-       * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.core.Control#constructor
-       * sap.ui.core.Control} can be used.
+       * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.core.Control#constructor sap.ui.core.Control }
+       * can be used.
        */
       constructor(
         /**
@@ -1843,8 +1874,8 @@ declare namespace sap {
        * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
        * of the syntax of the settings object.
        *
-       * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.core.Control#constructor
-       * sap.ui.core.Control} can be used.
+       * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.core.Control#constructor sap.ui.core.Control }
+       * can be used.
        */
       constructor(
         /**
@@ -1888,13 +1919,13 @@ declare namespace sap {
       static getMetadata(): sap.ui.core.ElementMetadata;
     }
     /**
-     * @SINCE 1.34
+     * @since 1.34
      *
      * The ToolPage is a layout control, used to create a basic tools app that has a header, side navigation
      * and contents area. Overview: The control has three main areas - a header on top, navigation to the side
-     * and a content area that can hold any control. The header and side navigation use custom controls - {@link
-     * sap.tnt.ToolHeader} and {@link sap.tnt.SideNavigation}. Usage: The main usage of the sap.tnt controls
-     * is for scenarios in the tooling or administration space.
+     * and a content area that can hold any control. The header and side navigation use custom controls - {@link sap.tnt.ToolHeader }
+     * and {@link sap.tnt.SideNavigation}. Usage: The main usage of the sap.tnt controls is for scenarios in
+     * the tooling or administration space.
      */
     class ToolPage extends sap.ui.core.Control {
       /**
@@ -1987,13 +2018,25 @@ declare namespace sap {
        */
       destroySideContent(): this;
       /**
-       * @SINCE 1.93
+       * @since 1.93
        *
        * Destroys the subHeader in the aggregation {@link #getSubHeader subHeader}.
        *
        * @returns Reference to `this` in order to allow method chaining
        */
       destroySubHeader(): this;
+      /**
+       * @since 1.115
+       *
+       * Gets current value of property {@link #getContentBackgroundDesign contentBackgroundDesign}.
+       *
+       * Specifies the content background design.
+       *
+       * Default value is `Standard`.
+       *
+       * @returns Value of property `contentBackgroundDesign`
+       */
+      getContentBackgroundDesign(): sap.m.PageBackgroundDesign;
       /**
        * Gets content of aggregation {@link #getHeader header}.
        *
@@ -2023,7 +2066,7 @@ declare namespace sap {
        */
       getSideExpanded(): boolean;
       /**
-       * @SINCE 1.93
+       * @since 1.93
        *
        * Gets content of aggregation {@link #getSubHeader subHeader}.
        *
@@ -2078,6 +2121,25 @@ declare namespace sap {
          */
         vMainContent: int | string | sap.ui.core.Control
       ): sap.ui.core.Control | null;
+      /**
+       * @since 1.115
+       *
+       * Sets a new value for property {@link #getContentBackgroundDesign contentBackgroundDesign}.
+       *
+       * Specifies the content background design.
+       *
+       * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+       *
+       * Default value is `Standard`.
+       *
+       * @returns Reference to `this` in order to allow method chaining
+       */
+      setContentBackgroundDesign(
+        /**
+         * New value for property `contentBackgroundDesign`
+         */
+        sContentBackgroundDesign?: sap.m.PageBackgroundDesign
+      ): this;
       /**
        * Sets the aggregated {@link #getHeader header}.
        *
@@ -2112,7 +2174,7 @@ declare namespace sap {
         bSideExpanded: boolean
       ): this;
       /**
-       * @SINCE 1.93
+       * @since 1.93
        *
        * Sets the aggregated {@link #getSubHeader subHeader}.
        *
@@ -2144,6 +2206,18 @@ declare namespace sap {
        */
       Narrow = "Narrow",
     }
+
+    type NavigationList$ItemSelectEvent = sap.ui.base.Event<NavigationList$ItemSelectEventParameters>;
+
+    type NavigationListItem$SelectEvent = sap.ui.base.Event<NavigationListItem$SelectEventParameters>;
+
+    /**
+     * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'SideNavigation$ItemSelectEventParameters'
+     * in 1.115.1 and any later releases.
+     */
+    type $SideNavigationItemSelectEventParameters = sap.tnt.SideNavigation$ItemSelectEventParameters;
+
+    type SideNavigation$ItemSelectEvent = sap.ui.base.Event<SideNavigation$ItemSelectEventParameters>;
   }
 
   interface IUI5DefineDependencyNames {