@sapui5/ts-types 1.121.2 → 1.122.0

package/types/sap.suite.ui.generic.template.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.121.2
+// For Library Version: 1.122.0
 
 declare namespace sap {
   namespace suite {
@@ -1706,7 +1706,8 @@ declare namespace sap {
                  */
                 getQuickVariantSelectionKey(): string;
                 /**
-                 * Get the list entries currently selected for smart table
+                 * Generally, it returns the currently selected contexts of the smart table. In case the context menu is
+                 * opened, it returns the contexts applicable to the context menu.
                  *
                  *
                  * @returns contains one entry per line selected
@@ -2654,7 +2655,8 @@ declare namespace sap {
                   sSectionKey: string
                 ): string;
                 /**
-                 * Get the entries currently selected in one ui element (table, chart, or list)
+                 * Generally, this method returns the currently selected contexts in one ui element (table, chart, or list).
+                 * In case the context menu is opened, it returns the contexts applicable to the context menu.
                  *
                  *
                  * @returns contains one entry per entry selected

package/types/sap.suite.ui.microchart.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.121.1
+// For Library Version: 1.122.0
 
 declare namespace sap {
   namespace suite {

package/types/{tnt-1.121.0-d.ts → sap.tnt.d.ts}

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

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

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

package/types/{commons-1.121.0-d.ts → sap.ui.commons.d.ts}

@@ -1,4 +1,4 @@
-// For Library Version: 1.121.0
+// For Library Version: 1.122.0
 
 declare namespace sap {
   namespace ui {
@@ -31004,6 +31004,7 @@ declare namespace sap {
        * The object contains the available parameters for BorderLayout's Area.
        *
        * @since 1.110
+       * @deprecated (since 1.110) - as it is an integral part of the already deprecated {@link sap.ui.commons.BorderLayout}.
        */
       type BorderLayoutAreaData = {
         /**
@@ -31041,6 +31042,8 @@ declare namespace sap {
       /**
        * The object representing the serialized focus information.
        *
+       * @since 1.110
+       * @deprecated (since 1.110) - as it is an integral part of the already deprecated {@link sap.ui.commons.TextField}.
        * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
        */
       type FocusInfo = {

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.121.1
+// For Library Version: 1.122.0
 
 declare namespace sap {
   namespace ui {
@@ -29,7 +29,7 @@ declare namespace sap {
           };
         }
 
-        interface $FilterBarSettings extends sap.ui.layout.$GridSettings {
+        interface $FilterBarSettings extends sap.ui.core.$ControlSettings {
           /**
            * Key used to access personalization data. Only if the persistencyKey is provided, will the `VariantManagement`
            * control be used.
@@ -69,9 +69,10 @@ declare namespace sap {
             | `{${string}}`;
 
           /**
-           * Shows the filters area. When property `useToolbar` is set to `false`, `filterBarExpanded` is set to `true`
-           * automatically. **Note:** When `SmartFilterBar` is used inside a `ValueHelpDialog`, it is initially collapsed.
-           * The filter bar is initially expanded in the following cases:
+           * Shows the filters area. When property `useToolbar` is set to `false`, `filterBarExpanded` is ignored
+           * automatically and the `FilterBar` is always expanded. **Note:** When `SmartFilterBar` is used inside
+           * a `ValueHelpDialog`, it is initially collapsed. The filter bar is initially expanded in the following
+           * cases:
            *
            * - When there is no basic search field.
            *
@@ -194,7 +195,8 @@ declare namespace sap {
 
           /**
            * Determines what design is used. Default is the design with toolbar. If the property `useToolbar` is set
-           * to `false`, the property `filterBarExpanded` is set to `true` automatically. **Note:**
+           * to `false`, the property `filterBarExpanded` is ignored automatically and the `FilterBar` is always expanded.
+           * **Note:**
            *  If set to `false`, the `VariantManagement` control is not available at all. This scenario is only intended
            * for the {@link sap.ui.comp.smartfilterbar.SmartFilterBar}.
            *
@@ -300,6 +302,21 @@ declare namespace sap {
             | sap.ui.base.ManagedObject.AggregationBindingInfo
             | `{${string}}`;
 
+          /**
+           * Do NOT use this aggregation directly. The `FilterBar` control is not meant to be used with arbitrary
+           * content. It renders filterFields which are added by `filterGroupItems` aggregation. If you need to add
+           * some content below the `FilterBar`, this can be done by adding it as sibling of the `FilterBar`. For
+           * example, if `FilterBar` is child of `DynamicPageHeader`, the custom content can be added to the `DynamicPageHeader`
+           * as well.
+           *
+           * @deprecated (since 1.122)
+           */
+          content?:
+            | sap.ui.core.Control[]
+            | sap.ui.core.Control
+            | sap.ui.base.ManagedObject.AggregationBindingInfo
+            | `{${string}}`;
+
           /**
            * Populates the basic search area on the FilterBar and the Filters dialog.
            *
@@ -665,7 +682,7 @@ declare namespace sap {
          *
          * In this dialog, the user has full control over the `FilterBar`.
          */
-        class FilterBar extends sap.ui.layout.Grid {
+        class FilterBar extends sap.ui.core.Control {
           /**
            * Constructor for a new FilterBar.
            *
@@ -707,7 +724,7 @@ declare namespace sap {
            * Creates a new subclass of class sap.ui.comp.filterbar.FilterBar with name `sClassName` and enriches it
            * with the information contained in `oClassInfo`.
            *
-           * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.layout.Grid.extend}.
+           * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
            *
            *
            * @returns Created class / constructor function
@@ -819,6 +836,19 @@ declare namespace sap {
               selectionChange?: Function;
             }
           ): void;
+          /**
+           * Adds some content to the aggregation {@link #getContent content}.
+           *
+           * @deprecated (since 1.122)
+           *
+           * @returns Reference to `this` in order to allow method chaining
+           */
+          addContent(
+            /**
+             * The content to add; if empty, nothing is inserted
+             */
+            oContent: sap.ui.core.Control
+          ): this;
           /**
            * Enables to add application specific content to the filters dialog. If the content was not yet added it
            * will be added. The content will be set to visible, all other filters dialog content will be set to invisible.
@@ -1738,6 +1768,14 @@ declare namespace sap {
            * Resets the current selection in the variant management control to standard.
            */
           clearVariantSelection(): void;
+          /**
+           * Destroys all the content in the aggregation {@link #getContent content}.
+           *
+           * @deprecated (since 1.122)
+           *
+           * @returns Reference to `this` in order to allow method chaining
+           */
+          destroyContent(): this;
           /**
            * Destroys all the filterGroupItems in the aggregation {@link #getFilterGroupItems filterGroupItems}.
            *
@@ -2429,6 +2467,18 @@ declare namespace sap {
            * @returns Value of property `considerGroupTitle`
            */
           getConsiderGroupTitle(): boolean;
+          /**
+           * Gets content of aggregation {@link #getContent content}.
+           *
+           * Do NOT use this aggregation directly. The `FilterBar` control is not meant to be used with arbitrary
+           * content. It renders filterFields which are added by `filterGroupItems` aggregation. If you need to add
+           * some content below the `FilterBar`, this can be done by adding it as sibling of the `FilterBar`. For
+           * example, if `FilterBar` is child of `DynamicPageHeader`, the custom content can be added to the `DynamicPageHeader`
+           * as well.
+           *
+           * @deprecated (since 1.122)
+           */
+          getContent(): sap.ui.core.Control[];
           /**
            * Retrieves the current variant ID.
            *
@@ -2493,9 +2543,10 @@ declare namespace sap {
           /**
            * Gets current value of property {@link #getFilterBarExpanded filterBarExpanded}.
            *
-           * Shows the filters area. When property `useToolbar` is set to `false`, `filterBarExpanded` is set to `true`
-           * automatically. **Note:** When `SmartFilterBar` is used inside a `ValueHelpDialog`, it is initially collapsed.
-           * The filter bar is initially expanded in the following cases:
+           * Shows the filters area. When property `useToolbar` is set to `false`, `filterBarExpanded` is ignored
+           * automatically and the `FilterBar` is always expanded. **Note:** When `SmartFilterBar` is used inside
+           * a `ValueHelpDialog`, it is initially collapsed. The filter bar is initially expanded in the following
+           * cases:
            *
            * - When there is no basic search field.
            *
@@ -2760,7 +2811,8 @@ declare namespace sap {
            * Gets current value of property {@link #getUseToolbar useToolbar}.
            *
            * Determines what design is used. Default is the design with toolbar. If the property `useToolbar` is set
-           * to `false`, the property `filterBarExpanded` is set to `true` automatically. **Note:**
+           * to `false`, the property `filterBarExpanded` is ignored automatically and the `FilterBar` is always expanded.
+           * **Note:**
            *  If set to `false`, the `VariantManagement` control is not available at all. This scenario is only intended
            * for the {@link sap.ui.comp.smartfilterbar.SmartFilterBar}.
            *
@@ -2789,6 +2841,20 @@ declare namespace sap {
            * @ui5-protected Do not call from applications (only from related classes in the framework)
            */
           hideGoButton(): void;
+          /**
+           * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getContent content}. and returns
+           * its index if found or -1 otherwise.
+           *
+           * @deprecated (since 1.122)
+           *
+           * @returns The index of the provided control in the aggregation if found, or -1 otherwise
+           */
+          indexOfContent(
+            /**
+             * The content whose index is looked for
+             */
+            oContent: sap.ui.core.Control
+          ): int;
           /**
            * Checks for the provided `sap.ui.comp.filterbar.FilterGroupItem` in the aggregation {@link #getFilterGroupItems filterGroupItems}.
            * and returns its index if found or -1 otherwise.
@@ -2816,6 +2882,25 @@ declare namespace sap {
              */
             oFilterItem: sap.ui.comp.filterbar.FilterItem
           ): int;
+          /**
+           * Inserts a content into the aggregation {@link #getContent content}.
+           *
+           * @deprecated (since 1.122)
+           *
+           * @returns Reference to `this` in order to allow method chaining
+           */
+          insertContent(
+            /**
+             * The content to insert; if empty, nothing is inserted
+             */
+            oContent: sap.ui.core.Control,
+            /**
+             * The `0`-based index the content should be inserted at; for a negative value of `iIndex`, the content
+             * is inserted at position 0; for a value greater than the current size of the aggregation, the content
+             * is inserted at the last position
+             */
+            iIndex: int
+          ): this;
           /**
            * Returns the information whether the flag 'executeOnSelect' is set or not on current variant.
            *
@@ -2881,6 +2966,16 @@ declare namespace sap {
              */
             fCallBack: /* was: sap.ui.comp.filterbar.FilterBar.fGetFiltersWithValuesCallBack */ any
           ): this;
+          /**
+           * Removes all the controls from the aggregation {@link #getContent content}.
+           *
+           * Additionally, it unregisters them from the hosting UIArea.
+           *
+           * @deprecated (since 1.122)
+           *
+           * @returns An array of the removed elements (might be empty)
+           */
+          removeAllContent(): sap.ui.core.Control[];
           /**
            * Removes all entries in the aggregation filterGroupItems.
            *
@@ -2900,6 +2995,19 @@ declare namespace sap {
            * Removes all entries in the aggregations filterItems, filterGroupItems, basicSearch
            */
           removeAllFilters(): void;
+          /**
+           * Removes a content from the aggregation {@link #getContent content}.
+           *
+           * @deprecated (since 1.122)
+           *
+           * @returns The removed content or `null`
+           */
+          removeContent(
+            /**
+             * The content to remove or its index or id
+             */
+            vContent: int | string | sap.ui.core.Control
+          ): sap.ui.core.Control | null;
           /**
            * Removes a filterGroupItem from the aggregation {@link #getFilterGroupItems filterGroupItems}.
            *
@@ -2928,12 +3036,6 @@ declare namespace sap {
              */
             vFilterItem: int | string | sap.ui.comp.filterbar.FilterItem
           ): sap.ui.comp.filterbar.FilterItem | null;
-          /**
-           * Adapts the visibility for all filter containers.
-           *
-           * @ui5-protected Do not call from applications (only from related classes in the framework)
-           */
-          rerenderFilters(): void;
           /**
            * Restores the visibility of the Go button on FilterBar. The visibility of the Go button will be set, according
            * to the showGoOnFB property.
@@ -3125,9 +3227,10 @@ declare namespace sap {
           /**
            * Sets a new value for property {@link #getFilterBarExpanded filterBarExpanded}.
            *
-           * Shows the filters area. When property `useToolbar` is set to `false`, `filterBarExpanded` is set to `true`
-           * automatically. **Note:** When `SmartFilterBar` is used inside a `ValueHelpDialog`, it is initially collapsed.
-           * The filter bar is initially expanded in the following cases:
+           * Shows the filters area. When property `useToolbar` is set to `false`, `filterBarExpanded` is ignored
+           * automatically and the `FilterBar` is always expanded. **Note:** When `SmartFilterBar` is used inside
+           * a `ValueHelpDialog`, it is initially collapsed. The filter bar is initially expanded in the following
+           * cases:
            *
            * - When there is no basic search field.
            *
@@ -3150,6 +3253,25 @@ declare namespace sap {
              */
             bFilterBarExpanded?: boolean
           ): this;
+          /**
+           * Sets a new value for property {@link #getFilterContainerWidth filterContainerWidth}.
+           *
+           * Sets the width of the filters container.
+           *
+           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+           *
+           * Default value is `"12rem"`.
+           *
+           * @since 1.34.0
+           *
+           * @returns Reference to `this` in order to allow method chaining
+           */
+          setFilterContainerWidth(
+            /**
+             * New value for property `filterContainerWidth`
+             */
+            sFilterContainerWidth?: string
+          ): this;
           /**
            * Sets a new value for property {@link #getHeader header}.
            *
@@ -3170,6 +3292,26 @@ declare namespace sap {
              */
             sHeader?: string
           ): this;
+          /**
+           * Sets a new value for property {@link #getHeaderLevel headerLevel}.
+           *
+           * Specifies the semantic header level of the {@link #getHeader header} text property. For more information,
+           * see {@link sap.m.Title#setLevel}. This property is ignored, when `useToolbar` is set to `false`.
+           *
+           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+           *
+           * Default value is `Auto`.
+           *
+           * @since 1.121
+           *
+           * @returns Reference to `this` in order to allow method chaining
+           */
+          setHeaderLevel(
+            /**
+             * New value for property `headerLevel`
+             */
+            sHeaderLevel?: sap.ui.core.TitleLevel
+          ): this;
           /**
            * Sets a new value for property {@link #getIsRunningInValueHelpDialog isRunningInValueHelpDialog}.
            *
@@ -3267,6 +3409,25 @@ declare namespace sap {
              */
             bShowClearButton?: boolean
           ): this;
+          /**
+           * Sets a new value for property {@link #getShowClearOnFB showClearOnFB}.
+           *
+           * Handles visibility of the Clear button on the FilterBar.
+           *
+           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+           *
+           * Default value is `false`.
+           *
+           * @since 1.28.0
+           *
+           * @returns Reference to `this` in order to allow method chaining
+           */
+          setShowClearOnFB(
+            /**
+             * New value for property `showClearOnFB`
+             */
+            bShowClearOnFB?: boolean
+          ): this;
           /**
            * Sets a new value for property {@link #getShowFilterConfiguration showFilterConfiguration}.
            *
@@ -3304,6 +3465,25 @@ declare namespace sap {
              */
             bShowGoButton?: boolean
           ): this;
+          /**
+           * Sets a new value for property {@link #getShowGoOnFB showGoOnFB}.
+           *
+           * Handles visibility of the Go button on the FilterBar.
+           *
+           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+           *
+           * Default value is `true`.
+           *
+           * @since 1.28.0
+           *
+           * @returns Reference to `this` in order to allow method chaining
+           */
+          setShowGoOnFB(
+            /**
+             * New value for property `showGoOnFB`
+             */
+            bShowGoOnFB?: boolean
+          ): this;
           /**
            * Once set, the activation of the 'Adapt Filters' button will open the 'old' filters dialog. This method
            * offers an intermediate solution for the visual filters scenario, which relies on the old filters dialog.
@@ -3334,6 +3514,25 @@ declare namespace sap {
              */
             bShowRestoreButton?: boolean
           ): this;
+          /**
+           * Sets a new value for property {@link #getShowRestoreOnFB showRestoreOnFB}.
+           *
+           * Handles visibility of the Restore button on the FilterBar.
+           *
+           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+           *
+           * Default value is `false`.
+           *
+           * @since 1.28.0
+           *
+           * @returns Reference to `this` in order to allow method chaining
+           */
+          setShowRestoreOnFB(
+            /**
+             * New value for property `showRestoreOnFB`
+             */
+            bShowRestoreOnFB?: boolean
+          ): this;
           /**
            * Sets the current UI state of the `FilterBar` control.
            *  The current UI state represents the data suite format.
@@ -3410,7 +3609,8 @@ declare namespace sap {
            * Sets a new value for property {@link #getUseToolbar useToolbar}.
            *
            * Determines what design is used. Default is the design with toolbar. If the property `useToolbar` is set
-           * to `false`, the property `filterBarExpanded` is set to `true` automatically. **Note:**
+           * to `false`, the property `filterBarExpanded` is ignored automatically and the `FilterBar` is always expanded.
+           * **Note:**
            *  If set to `false`, the `VariantManagement` control is not available at all. This scenario is only intended
            * for the {@link sap.ui.comp.smartfilterbar.SmartFilterBar}.
            *
@@ -29498,8 +29698,11 @@ declare namespace sap {
          *     The default is `preserveDecimals=true` for the `customData`. This `customData` is then used for formatting
          *     the `Edm.Decimal` type as well as the `Currency` and `Unit` cell template. If the number of decimal digits
          *     is different from the values returned by the code list, then the decimal point alignment for the `Currency`
-         *     and `Unit` values cannot be guaranteed. Cell data of type `string` containing whitespace characters
-         *     are replaced with unicode characters to visualize the whitespaces on the UI. This is enabled by default.
+         *     and `Unit` values cannot be guaranteed.
+         * 	 - Cell data of type `string` containing whitespace characters are replaced with unicode characters
+         *     to visualize the whitespaces on the UI. This is enabled by default.
+         * 	 - The `SmartTable` must not be cloned or used as a template. Doing this might cause issues with its
+         *     behavior, personalization, or `VariantManagement`.
          */
         class SmartTable extends sap.m.VBox {
           /**
@@ -32790,11 +32993,13 @@ declare namespace sap {
            */
           GW = "GW",
           /**
-           * UI5 client-side spreadsheet export service is used (default as of UI5 version 1.52)
+           * UI5 client-side spreadsheet export service is used
            */
           UI5Client = "UI5Client",
           /**
            * UI5 client-side spreadsheet export service is used along with Gateway backend PDF export service.
+           *
+           * @since 1.100
            */
           UI5ClientPDF = "UI5ClientPDF",
         }