@openui5/ts-types 1.117.0 → 1.118.0

package/types/sap.m.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.117.0
+// For Library Version: 1.118.0
 
 declare namespace sap {
   /**
@@ -131,23 +131,28 @@ declare namespace sap {
     namespace p13n {
       /**
        * @since 1.97
-       * @experimental
        *
        * Interface for P13nPopup which are suitable as content for the `sap.m.p13n.Popup`. Implementation of this
        * interface should include the following methods:
        * 	 - `getTitle`
+       * 	 - `getVerticalScrolling`
        */
       interface IContent {
         __implements__sap_m_p13n_IContent: boolean;
 
         /**
-         * @experimental
-         *
          * Returns the title, which should be displayed in the P13nPopup to describe related content.
          *
          * @returns The title for the corresponding content to be displayed in the `sap.m.p13n.Popup`.
          */
         getTitle(): string;
+        /**
+         * Optionally returns the enablement of the contents vertical scrolling in case only one panel is used to
+         * determine if the content provides its own scrolling capabilites.
+         *
+         * @returns The enablement of the vertical scrolling enablement for the `sap.m.p13n.Popup`.
+         */
+        getVerticalScrolling?(): boolean;
       }
 
       interface $BasePanelSettings extends sap.ui.core.$ControlSettings {
@@ -10923,27 +10928,33 @@ declare namespace sap {
            *
            * Fires event {@link #event:cancel cancel} to attached listeners.
            *
-           * @returns Reference to `this` in order to allow method chaining
+           * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
+           * event object. The return value of this method indicates whether the default action should be executed.
+           *
+           * @returns Whether or not to prevent the default action
            */
           fireCancel(
             /**
              * Parameters to pass along with the event
              */
             mParameters?: object
-          ): this;
+          ): boolean;
           /**
            * @ui5-protected Do not call from applications (only from related classes in the framework)
            *
            * Fires event {@link #event:confirm confirm} to attached listeners.
            *
-           * @returns Reference to `this` in order to allow method chaining
+           * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
+           * event object. The return value of this method indicates whether the default action should be executed.
+           *
+           * @returns Whether or not to prevent the default action
            */
           fireConfirm(
             /**
              * Parameters to pass along with the event
              */
             mParameters?: object
-          ): this;
+          ): boolean;
           /**
            * @ui5-protected Do not call from applications (only from related classes in the framework)
            *
@@ -22363,6 +22374,18 @@ declare namespace sap {
        */
       tileBadge?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
 
+      /**
+       * @since 1.118
+       * @experimental (since 1.113)
+       *
+       * Sets the offset for the Drop Area associated with a Generic Tile. The offset is applied uniformly to
+       * all the tile edges.
+       */
+      dropAreaOffset?:
+        | int
+        | sap.ui.base.ManagedObject.PropertyBindingInfo
+        | `{${string}}`;
+
       /**
        * The content of the tile.
        */
@@ -28933,6 +28956,14 @@ declare namespace sap {
         | sap.ui.base.ManagedObject.PropertyBindingInfo
         | `{${string}}`;
 
+      /**
+       * Defines the shape of the `Avatar`.
+       */
+      iconShape?:
+        | sap.m.AvatarShape
+        | sap.ui.base.ManagedObject.PropertyBindingInfo
+        | `{${string}}`;
+
       /**
        * Rows of the `PlanningCalendar`.
        */
@@ -39021,6 +39052,20 @@ declare namespace sap {
      * {@link sap.m.IllustrationPool.loadRestOfTheAssets} API.
      */
     interface IllustrationPool {
+      /**
+       * @since 1.116.0
+       *
+       * Returns the metadata of an Illustration Set. The metadata contains the names of the symbols and the theme
+       * mappings. If the Illustration Set is not registered, an error is logged and null is returned.
+       *
+       * @returns The metadata of the Illustration Set
+       */
+      getIllustrationSetMetadata(
+        /**
+         * The name of the illustration set
+         */
+        sSet: string
+      ): object;
       /**
        * Loads an SVG asset depending on the input asset ID.
        */
@@ -39032,7 +39077,13 @@ declare namespace sap {
         /**
          * the ID of the Illustration instance which is requiring the asset
          */
-        sInstanceId: string
+        sInstanceId: string,
+        /**
+         * The prefix of the path of the asset being loaded. Used for loading assets from different collections.
+         * Used to store the asset ID in the DOM pool, so it can be distinguished from other assets with the same
+         * ID.
+         */
+        sIdPrefix: string
       ): void;
       /**
        * Loads the rest of the SVG assets for a given illustration set.
@@ -55679,9 +55730,9 @@ declare namespace sap {
        * popup. Standard options are arranged in 6 groups - from 1 to 6. 1 - Single Dates 2 - Date Ranges 3 -
        * Weeks 4 - Months 5 - Quarters 6 - Years
        *
-       * @returns A group index
+       * @returns A group key from {@link sap.m.DynamicDateRangeGroups}
        */
-      getGroup(): int;
+      getGroup(): int | string;
       /**
        * Provides the option's group header text.
        *
@@ -55953,6 +56004,21 @@ declare namespace sap {
          */
         oCustomOption: sap.m.DynamicDateOption
       ): this;
+      /**
+       * @since 1.118
+       *
+       * Adds a group to the enumeration containing the current groups in `sap.m.DynamicDateRange`
+       */
+      addGroup(
+        /**
+         * the name that the group will be selected by.
+         */
+        sGroupName: string,
+        /**
+         * the group header that will be presented in the list.
+         */
+        sGroupHeader: string
+      ): void;
       /**
        * @since 1.92
        *
@@ -56114,6 +56180,14 @@ declare namespace sap {
        * @returns Value of property `enableGroupHeaders`
        */
       getEnableGroupHeaders(): boolean;
+      /**
+       * @since 1.118
+       *
+       * Provides the option's group header text.
+       *
+       * @returns A group header
+       */
+      getGroupHeader(): string;
       /**
        * @since 1.105
        *
@@ -56363,6 +56437,10 @@ declare namespace sap {
          */
         vAriaLabelledBy: int | sap.ui.core.ID | sap.ui.core.Control
       ): sap.ui.core.ID | null;
+      /**
+       * Removes all additionally added groups
+       */
+      removeCustomGroups(): void;
       /**
        * Removes a customOption from the aggregation {@link #getCustomOptions customOptions}.
        *
@@ -56451,6 +56529,19 @@ declare namespace sap {
          */
         bEnableGroupHeaders?: boolean
       ): this;
+      /**
+       * Sets a new header to an existing custom group.
+       */
+      setGroupHeader(
+        /**
+         * the name that the group will be selected by.
+         */
+        sGroupName: string,
+        /**
+         * the group header that will be presented in the list.
+         */
+        sGroupHeader: string
+      ): void;
       /**
        * @since 1.105
        *
@@ -57780,23 +57871,6 @@ declare namespace sap {
        * @returns Value of property `text`
        */
       getText(): string;
-      /**
-       * @deprecated (since 1.18.11) - replaced by `setCounter` method
-       *
-       * Sets a new value for property {@link #getCount count}.
-       *
-       * Defines the number of objects that match this item in the target data set.
-       *
-       * When called with a value of `null` or `undefined`, the default value of the property will be restored.
-       *
-       * @returns Reference to `this` in order to allow method chaining
-       */
-      setCount(
-        /**
-         * New value for property `count`
-         */
-        iCount?: int
-      ): this;
       /**
        * Sets a new value for property {@link #getKey key}.
        *
@@ -58414,27 +58488,6 @@ declare namespace sap {
          */
         mode: sap.m.ListMode
       ): this;
-      /**
-       * @deprecated (since 1.20.0) - replaced by `setMode` method. `FacetFilterList` overrides the `setMode`
-       * method to restrict the possible modes to `MultiSelect` and `SingleSelectMaster`. All other modes are
-       * ignored and will not be set.
-       *
-       * Sets a new value for property {@link #getMultiSelect multiSelect}.
-       *
-       * Specifies whether multiple or single selection is used.
-       *
-       * When called with a value of `null` or `undefined`, the default value of the property will be restored.
-       *
-       * Default value is `true`.
-       *
-       * @returns Reference to `this` in order to allow method chaining
-       */
-      setMultiSelect(
-        /**
-         * New value for property `multiSelect`
-         */
-        bMultiSelect?: boolean
-      ): this;
       /**
        * @since 1.22.1
        *
@@ -62409,6 +62462,20 @@ declare namespace sap {
        * @returns An array containing all of the tile's bounding rectangles
        */
       getBoundingRects(): object[];
+      /**
+       * @since 1.118
+       * @experimental (since 1.113)
+       *
+       * Gets current value of property {@link #getDropAreaOffset dropAreaOffset}.
+       *
+       * Sets the offset for the Drop Area associated with a Generic Tile. The offset is applied uniformly to
+       * all the tile edges.
+       *
+       * Default value is `0`.
+       *
+       * @returns Value of property `dropAreaOffset`
+       */
+      getDropAreaOffset(): int;
       /**
        * @experimental (since 1.96)
        *
@@ -62902,6 +62969,27 @@ declare namespace sap {
          */
         sBackgroundImage?: sap.ui.core.URI
       ): this;
+      /**
+       * @since 1.118
+       * @experimental (since 1.113)
+       *
+       * Sets a new value for property {@link #getDropAreaOffset dropAreaOffset}.
+       *
+       * Sets the offset for the Drop Area associated with a Generic Tile. The offset is applied uniformly to
+       * all the tile edges.
+       *
+       * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+       *
+       * Default value is `0`.
+       *
+       * @returns Reference to `this` in order to allow method chaining
+       */
+      setDropAreaOffset(
+        /**
+         * New value for property `dropAreaOffset`
+         */
+        iDropAreaOffset?: int
+      ): this;
       /**
        * @experimental (since 1.96)
        *
@@ -74178,22 +74266,6 @@ declare namespace sap {
          */
         oListener?: object
       ): this;
-      /**
-       * @ui5-protected Do not call from applications (only from related classes in the framework)
-       *
-       * This method is a hook for the RenderManager that gets called during the rendering of child Controls.
-       * It allows to add, remove and update existing accessibility attributes (ARIA) of those controls.
-       */
-      enhanceAccessibilityState(
-        /**
-         * The Control that gets rendered by the RenderManager
-         */
-        oElement: sap.ui.core.Control,
-        /**
-         * The mapping of "aria-" prefixed attributes
-         */
-        mAriaProps: object
-      ): void;
       /**
        * @since 1.54
        * @ui5-protected Do not call from applications (only from related classes in the framework)
@@ -74555,7 +74627,7 @@ declare namespace sap {
        *
        * Defines keyboard handling behavior of the control.
        *
-       * Default value is `Navigation`.
+       * Default value is `"Navigation"`.
        *
        * @returns Value of property `keyboardMode`
        */
@@ -75165,7 +75237,7 @@ declare namespace sap {
        *
        * When called with a value of `null` or `undefined`, the default value of the property will be restored.
        *
-       * Default value is `Navigation`.
+       * Default value is `"Navigation"`.
        *
        * @returns Reference to `this` in order to allow method chaining
        */
@@ -99908,6 +99980,16 @@ declare namespace sap {
        * @returns Value of property `height`
        */
       getHeight(): sap.ui.core.CSSSize;
+      /**
+       * Gets current value of property {@link #getIconShape iconShape}.
+       *
+       * Defines the shape of the `Avatar`.
+       *
+       * Default value is `Circle`.
+       *
+       * @returns Value of property `iconShape`
+       */
+      getIconShape(): sap.m.AvatarShape;
       /**
        * @since 1.40.0
        *
@@ -100596,6 +100678,23 @@ declare namespace sap {
          */
         sHeight?: sap.ui.core.CSSSize
       ): this;
+      /**
+       * Sets a new value for property {@link #getIconShape iconShape}.
+       *
+       * Defines the shape of the `Avatar`.
+       *
+       * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+       *
+       * Default value is `Circle`.
+       *
+       * @returns Reference to `this` in order to allow method chaining
+       */
+      setIconShape(
+        /**
+         * New value for property `iconShape`
+         */
+        sIconShape?: sap.m.AvatarShape
+      ): this;
       /**
        * @since 1.40.0
        *
@@ -143703,6 +143802,37 @@ declare namespace sap {
        */
       Saving = "Saving",
     }
+    /**
+     * @since 1.118
+     *
+     * Defines the groups in {@link sap.m.DynamicDateRange}.
+     */
+    enum DynamicDateRangeGroups {
+      /**
+       * Group of options that provide selection of date ranges.
+       */
+      DateRanges = "DateRanges",
+      /**
+       * Group of options that provide selection of month related ranges.
+       */
+      Month = "Month",
+      /**
+       * Group of options that provide selection of quarter related ranges.
+       */
+      Quarters = "Quarters",
+      /**
+       * Group of options that provide selection of single dates.
+       */
+      SingleDates = "SingleDates",
+      /**
+       * Group of options that provide selection of week related ranges.
+       */
+      Weeks = "Weeks",
+      /**
+       * Group of options that provide selection of year related ranges.
+       */
+      Years = "Years",
+    }
     /**
      * @since 1.87
      *
@@ -144736,18 +144866,19 @@ declare namespace sap {
      */
     enum ListKeyboardMode {
       /**
-       * This mode is suitable if the number of items is limited and if there are editable fields within the item.
+       * This mode is suitable if there are only editable fields within the item.
        *
-       * While the last/first interactive element within an item has the focus, pressing tab/shift+tab moves the
-       * focus to the next/previous element in the tab chain after/before the item .
+       * In this mode, the first focus goes to the first interactive element within the first item and this is
+       * the only difference between the `Edit` and `Navigation` mode.
        */
       Edit = "Edit",
       /**
-       * This default mode is suitable if the number of items is unlimited or if there is no editable field within
-       * the item.
+       * This default mode is suitable if the List or Table contains editable and/or non-editable fields.
        *
-       * While the last/first interactive element within an item has the focus, pressing tab/shift+tab moves the
-       * focus to the next/previous element in the tab chain after/before the `sap.m.List` or `sap.m.Table`.
+       * In this mode, the first focus goes to the first item. If the focus is on the item, or cell, pressing
+       * tab/shift+tab moves the focus to the next/previous element in the tab chain after/before the `sap.m.List`
+       * or `sap.m.Table` control. If the focus is on the interactive element, pressing tab/shift+tab moves the
+       * focus to the next/previous element in the tab chain after/before the focused interactive element.
        */
       Navigation = "Navigation",
     }

package/types/sap.tnt.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.117.0
+// For Library Version: 1.118.0
 
 declare namespace sap {
   /**

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.117.0
+// For Library Version: 1.118.0
 
 declare namespace sap {
   namespace ui {
@@ -517,7 +517,10 @@ declare namespace sap {
         /**
          * @since 1.54.1
          *
-         * Pretty-prints the content of the editor
+         * Pretty-prints the content of the editor.
+         *
+         * **Note:** Works well only for PHP. For other programming languages, the content might not be formatted
+         * well. In such cases it is recommended to use your own formatting.
          */
         prettyPrint(): void;
         /**

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.117.0
+// For Library Version: 1.118.0
 
 declare namespace sap {
   namespace ui {