@sapui5/ts-types 1.114.0 → 1.115.0

package/types/sap.tnt.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.114.0
+// For Library Version: 1.115.0
 
 declare namespace sap {
   /**
@@ -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.$NavigationListItemSelectEventParameters>
+      ) => void;
     }
 
     interface $NavigationListItemSettings extends sap.ui.core.$ItemSettings {
@@ -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.$NavigationListItemSelectEventParameters>
+      ) => void;
     }
 
     interface $SideNavigationSettings extends sap.ui.core.$ControlSettings {
@@ -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.$SideNavigationItemSelectEventParameters>
+      ) => void;
     }
 
     interface $ToolHeaderSettings extends sap.m.$OverflowToolbarSettings {}
@@ -270,6 +276,16 @@ 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.
        */
@@ -297,6 +313,27 @@ declare namespace sap {
         | `{${string}}`;
     }
 
+    interface $NavigationListItemSelectEventParameters {
+      /**
+       * The selected item.
+       */
+      item?: sap.ui.core.Item;
+    }
+
+    interface $NavigationListItemSelectEventParameters {
+      /**
+       * The selected item.
+       */
+      item?: sap.ui.core.Item;
+    }
+
+    interface $SideNavigationItemSelectEventParameters {
+      /**
+       * The selected item.
+       */
+      item?: sap.ui.core.Item;
+    }
+
     /**
      * @SINCE 1.54
      *
@@ -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.
@@ -731,7 +768,9 @@ declare namespace sap {
         /**
          * The function to be called when the event occurs
          */
-        fnFunction: (p1: sap.ui.base.Event) => void,
+        fnFunction: (
+          p1: sap.ui.base.Event<sap.tnt.$NavigationListItemSelectEventParameters>
+        ) => void,
         /**
          * Context object to call the event handler with. Defaults to this `sap.tnt.NavigationList` itself
          */
@@ -751,7 +790,9 @@ declare namespace sap {
         /**
          * The function to be called when the event occurs
          */
-        fnFunction: (p1: sap.ui.base.Event) => void,
+        fnFunction: (
+          p1: sap.ui.base.Event<sap.tnt.$NavigationListItemSelectEventParameters>
+        ) => void,
         /**
          * Context object to call the event handler with. Defaults to this `sap.tnt.NavigationList` itself
          */
@@ -774,7 +815,9 @@ declare namespace sap {
         /**
          * The function to be called, when the event occurs
          */
-        fnFunction: (p1: sap.ui.base.Event) => void,
+        fnFunction: (
+          p1: sap.ui.base.Event<sap.tnt.$NavigationListItemSelectEventParameters>
+        ) => void,
         /**
          * Context object on which the given function had to be called
          */
@@ -791,21 +834,14 @@ declare namespace sap {
         /**
          * Parameters to pass along with the event
          */
-        mParameters?: {
-          /**
-           * The selected item.
-           */
-          item?: sap.ui.core.Item;
-        }
+        mParameters?: sap.tnt.$NavigationListItemSelectEventParameters
       ): 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[];
       /**
@@ -1082,7 +1118,9 @@ declare namespace sap {
         /**
          * The function to be called when the event occurs
          */
-        fnFunction: (p1: sap.ui.base.Event) => void,
+        fnFunction: (
+          p1: sap.ui.base.Event<sap.tnt.$NavigationListItemSelectEventParameters>
+        ) => void,
         /**
          * Context object to call the event handler with. Defaults to this `sap.tnt.NavigationListItem` itself
          */
@@ -1102,7 +1140,9 @@ declare namespace sap {
         /**
          * The function to be called when the event occurs
          */
-        fnFunction: (p1: sap.ui.base.Event) => void,
+        fnFunction: (
+          p1: sap.ui.base.Event<sap.tnt.$NavigationListItemSelectEventParameters>
+        ) => void,
         /**
          * Context object to call the event handler with. Defaults to this `sap.tnt.NavigationListItem` itself
          */
@@ -1125,7 +1165,9 @@ declare namespace sap {
         /**
          * The function to be called, when the event occurs
          */
-        fnFunction: (p1: sap.ui.base.Event) => void,
+        fnFunction: (
+          p1: sap.ui.base.Event<sap.tnt.$NavigationListItemSelectEventParameters>
+        ) => void,
         /**
          * Context object on which the given function had to be called
          */
@@ -1142,12 +1184,7 @@ declare namespace sap {
         /**
          * Parameters to pass along with the event
          */
-        mParameters?: {
-          /**
-           * The selected item.
-           */
-          item?: sap.ui.core.Item;
-        }
+        mParameters?: sap.tnt.$NavigationListItemSelectEventParameters
       ): this;
       /**
        * Gets current value of property {@link #getExpanded expanded}.
@@ -1159,6 +1196,14 @@ declare namespace sap {
        * @returns Value of property `expanded`
        */
       getExpanded(): boolean;
+      /**
+       * @PROTECTED - DO NOT USE IN APPLICATIONS (only for 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}.
        *
@@ -1379,7 +1424,7 @@ declare namespace sap {
      * 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 +1510,9 @@ declare namespace sap {
         /**
          * The function to be called when the event occurs
          */
-        fnFunction: (p1: sap.ui.base.Event) => void,
+        fnFunction: (
+          p1: sap.ui.base.Event<sap.tnt.$SideNavigationItemSelectEventParameters>
+        ) => void,
         /**
          * Context object to call the event handler with. Defaults to this `sap.tnt.SideNavigation` itself
          */
@@ -1485,7 +1532,9 @@ declare namespace sap {
         /**
          * The function to be called when the event occurs
          */
-        fnFunction: (p1: sap.ui.base.Event) => void,
+        fnFunction: (
+          p1: sap.ui.base.Event<sap.tnt.$SideNavigationItemSelectEventParameters>
+        ) => void,
         /**
          * Context object to call the event handler with. Defaults to this `sap.tnt.SideNavigation` itself
          */
@@ -1534,7 +1583,9 @@ declare namespace sap {
         /**
          * The function to be called, when the event occurs
          */
-        fnFunction: (p1: sap.ui.base.Event) => void,
+        fnFunction: (
+          p1: sap.ui.base.Event<sap.tnt.$SideNavigationItemSelectEventParameters>
+        ) => void,
         /**
          * Context object on which the given function had to be called
          */
@@ -1551,12 +1602,7 @@ declare namespace sap {
         /**
          * Parameters to pass along with the event
          */
-        mParameters?: {
-          /**
-           * The selected item.
-           */
-          item?: sap.ui.core.Item;
-        }
+        mParameters?: sap.tnt.$SideNavigationItemSelectEventParameters
       ): this;
       /**
        * @SINCE 1.98
@@ -1706,16 +1752,19 @@ declare namespace sap {
     /**
      * @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 +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}
        */
@@ -1767,8 +1816,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}
        */
@@ -1827,8 +1876,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 +1892,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(
         /**
@@ -1892,9 +1941,9 @@ declare namespace sap {
      *
      * 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 {
       /**
@@ -1994,6 +2043,18 @@ declare namespace sap {
        * @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}.
        *
@@ -2078,6 +2139,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}.
        *

package/types/sap.ui.codeeditor.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.114.0
+// For Library Version: 1.115.0
 
 declare namespace sap {
   namespace ui {
@@ -106,12 +106,40 @@ declare namespace sap {
         /**
          * Fired when the value is changed by user interaction - each keystroke, delete, paste, etc.
          */
-        liveChange?: (oEvent: sap.ui.base.Event) => void;
+        liveChange?: (
+          oEvent: sap.ui.base.Event<sap.ui.codeeditor.$CodeEditorLiveChangeEventParameters>
+        ) => void;
 
         /**
          * Fired when the value has changed and the focus leaves the code editor.
          */
-        change?: (oEvent: sap.ui.base.Event) => void;
+        change?: (
+          oEvent: sap.ui.base.Event<sap.ui.codeeditor.$CodeEditorChangeEventParameters>
+        ) => void;
+      }
+
+      interface $CodeEditorChangeEventParameters {
+        /**
+         * The current value of the code editor.
+         */
+        value?: string;
+
+        /**
+         * The old value of the code editor.
+         */
+        oldValue?: string;
+      }
+
+      interface $CodeEditorLiveChangeEventParameters {
+        /**
+         * The current value of the code editor.
+         */
+        value?: string;
+
+        /**
+         * The underlying change event of the third-party code editor.
+         */
+        editorEvent?: object;
       }
 
       /**
@@ -216,7 +244,9 @@ declare namespace sap {
           /**
            * The function to be called when the event occurs
            */
-          fnFunction: (p1: sap.ui.base.Event) => void,
+          fnFunction: (
+            p1: sap.ui.base.Event<sap.ui.codeeditor.$CodeEditorChangeEventParameters>
+          ) => void,
           /**
            * Context object to call the event handler with. Defaults to this `sap.ui.codeeditor.CodeEditor` itself
            */
@@ -236,7 +266,9 @@ declare namespace sap {
           /**
            * The function to be called when the event occurs
            */
-          fnFunction: (p1: sap.ui.base.Event) => void,
+          fnFunction: (
+            p1: sap.ui.base.Event<sap.ui.codeeditor.$CodeEditorChangeEventParameters>
+          ) => void,
           /**
            * Context object to call the event handler with. Defaults to this `sap.ui.codeeditor.CodeEditor` itself
            */
@@ -261,7 +293,9 @@ declare namespace sap {
           /**
            * The function to be called when the event occurs
            */
-          fnFunction: (p1: sap.ui.base.Event) => void,
+          fnFunction: (
+            p1: sap.ui.base.Event<sap.ui.codeeditor.$CodeEditorLiveChangeEventParameters>
+          ) => void,
           /**
            * Context object to call the event handler with. Defaults to this `sap.ui.codeeditor.CodeEditor` itself
            */
@@ -281,7 +315,9 @@ declare namespace sap {
           /**
            * The function to be called when the event occurs
            */
-          fnFunction: (p1: sap.ui.base.Event) => void,
+          fnFunction: (
+            p1: sap.ui.base.Event<sap.ui.codeeditor.$CodeEditorLiveChangeEventParameters>
+          ) => void,
           /**
            * Context object to call the event handler with. Defaults to this `sap.ui.codeeditor.CodeEditor` itself
            */
@@ -298,7 +334,9 @@ declare namespace sap {
           /**
            * The function to be called, when the event occurs
            */
-          fnFunction: (p1: sap.ui.base.Event) => void,
+          fnFunction: (
+            p1: sap.ui.base.Event<sap.ui.codeeditor.$CodeEditorChangeEventParameters>
+          ) => void,
           /**
            * Context object on which the given function had to be called
            */
@@ -315,7 +353,9 @@ declare namespace sap {
           /**
            * The function to be called, when the event occurs
            */
-          fnFunction: (p1: sap.ui.base.Event) => void,
+          fnFunction: (
+            p1: sap.ui.base.Event<sap.ui.codeeditor.$CodeEditorLiveChangeEventParameters>
+          ) => void,
           /**
            * Context object on which the given function had to be called
            */
@@ -332,16 +372,7 @@ declare namespace sap {
           /**
            * Parameters to pass along with the event
            */
-          mParameters?: {
-            /**
-             * The current value of the code editor.
-             */
-            value?: string;
-            /**
-             * The old value of the code editor.
-             */
-            oldValue?: string;
-          }
+          mParameters?: sap.ui.codeeditor.$CodeEditorChangeEventParameters
         ): this;
         /**
          * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
@@ -354,16 +385,7 @@ declare namespace sap {
           /**
            * Parameters to pass along with the event
            */
-          mParameters?: {
-            /**
-             * The current value of the code editor.
-             */
-            value?: string;
-            /**
-             * The underlying change event of the third-party code editor.
-             */
-            editorEvent?: object;
-          }
+          mParameters?: sap.ui.codeeditor.$CodeEditorLiveChangeEventParameters
         ): this;
         /**
          * Sets the focus to the code editor