@sapui5/ts-types-esm 1.147.2 → 1.148.0

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.147.1
+// For Library Version: 1.148.0
 
 declare module "sap/ui/comp/library" {
   /**
@@ -21229,6 +21229,14 @@ declare module "sap/ui/comp/smartfilterbar/SmartFilterBar" {
      * @returns Value of property `defaultSelectionVariantName`
      */
     getDefaultSelectionVariantName(): string;
+    /**
+     * Returns the currently configured default values as a map of property names to condition ranges.
+     *
+     * @since 1.148
+     *
+     * @returns Map of property names to their condition ranges
+     */
+    getDefaultValues(): Object;
     /**
      * Reads the descriptions for given filters and value keys.
      *
@@ -21768,6 +21776,38 @@ declare module "sap/ui/comp/smartfilterbar/SmartFilterBar" {
        */
       sDefaultSelectionVariantName?: string
     ): this;
+    /**
+     * Configures which filter fields support the DefaultValues operation and sets their predefined conditions.
+     * Only the listed fields will have DefaultValues support enabled. Can be called before the SmartFilterBar
+     * is initialized; the configuration will be applied once initialization completes.
+     *
+     * @since 1.148
+     */
+    setDefaultValues(
+      /**
+       * Map of property names to their condition ranges, e.g.
+       * ```javascript
+       *
+       * {
+       *   "Field1": [
+       *     { Sign: "I", Option: "EQ", Low: "value", High: null }
+       *   ],
+       *   "Field2": [
+       *     { Sign: "I", Option: "BT", Low: "low", High: "high" }
+       *   ]
+       * }
+       * ```
+       *  Each key is a filter field property name. Each value is an array of condition objects with:
+       * 	 - `Sign` - "I" (include) or "E" (exclude)
+       * 	 - `Option` - Operator such as "EQ", "BT", "CP", "GT", "LT", etc.
+       * 	 - `Low` - The low value of the condition
+       * 	 - `High` - The high value (used with "BT" operator, otherwise `null`)
+       */
+      oFieldConditions: Record<
+        string,
+        /* was: sap.ui.comp.smartfilterbar.SelectOptionType */ any[]
+      >
+    ): void;
     /**
      * Sets a new value for property {@link #getEnableBasicSearch enableBasicSearch}.
      *
@@ -31017,6 +31057,8 @@ declare module "sap/ui/comp/smarttable/SmartTable" {
 
   import DataStateIndicator from "sap/m/plugins/DataStateIndicator";
 
+  import TableExportSettings from "sap/ui/export/TableExportSettings";
+
   import { Priority, TitleLevel, ID } from "sap/ui/core/library";
 
   import { smarttable } from "sap/ui/comp/library";
@@ -31034,6 +31076,8 @@ declare module "sap/ui/comp/smarttable/SmartTable" {
     AggregationBindingInfo,
   } from "sap/ui/base/ManagedObject";
 
+  import Filter from "sap/ui/export/util/Filter";
+
   /**
    * Paste-related column information
    *
@@ -32052,6 +32096,14 @@ declare module "sap/ui/comp/smarttable/SmartTable" {
      * @returns Reference to `this` in order to allow method chaining
      */
     destroyDataStateIndicator(): this;
+    /**
+     * Destroys the defaultExportSettings in the aggregation {@link #getDefaultExportSettings defaultExportSettings}.
+     *
+     * @since 1.148
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    destroyDefaultExportSettings(): this;
     /**
      * Destroys all the filterControlConfiguration in the aggregation {@link #getFilterControlConfiguration filterControlConfiguration}.
      *
@@ -32751,6 +32803,22 @@ declare module "sap/ui/comp/smarttable/SmartTable" {
      * @returns array of column keys
      */
     getDeactivatedColumns(): string[];
+    /**
+     * Gets content of aggregation {@link #getDefaultExportSettings defaultExportSettings}.
+     *
+     * Defines default values shown in the export dialog.
+     *
+     * Configure default values that are displayed in the export dialog. For example, the `fileName` property
+     * of {@link sap.ui.export.TableExportSettings} defines the default file name shown in the export dialog.
+     * If not specified, the table header is used.
+     *
+     * **Note:** These values are defaults shown to the user. The user can still modify them before export.
+     * If the user modifies a value in the dialog, the user choice takes precedence and is not overridden by
+     * event handlers.
+     *
+     * @since 1.148
+     */
+    getDefaultExportSettings(): TableExportSettings;
     /**
      * Gets current value of property {@link #getDemandPopin demandPopin}.
      *
@@ -33688,6 +33756,19 @@ declare module "sap/ui/comp/smarttable/SmartTable" {
        */
       oDataStateIndicator: DataStateIndicator
     ): this;
+    /**
+     * Sets the aggregated {@link #getDefaultExportSettings defaultExportSettings}.
+     *
+     * @since 1.148
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    setDefaultExportSettings(
+      /**
+       * The defaultExportSettings to set
+       */
+      oDefaultExportSettings: TableExportSettings
+    ): this;
     /**
      * Sets a new value for property {@link #getDemandPopin demandPopin}.
      *
@@ -34020,10 +34101,10 @@ declare module "sap/ui/comp/smarttable/SmartTable" {
       sLevel: string
     ): SmartTable;
     /**
-     * Sets the value for the `headerSty;e` property.
+     * Sets the value for the `headerStyle` property.
      *
      *
-     * @returns Reference to this in order to allow method chaining
+     * @returns Reference to `this` in order to allow method chaining
      */
     setHeaderStyle(
       /**
@@ -35220,6 +35301,21 @@ declare module "sap/ui/comp/smarttable/SmartTable" {
      */
     useDateRangeType?: boolean | PropertyBindingInfo | `{${string}}`;
 
+    /**
+     * Defines default values shown in the export dialog.
+     *
+     * Configure default values that are displayed in the export dialog. For example, the `fileName` property
+     * of {@link sap.ui.export.TableExportSettings} defines the default file name shown in the export dialog.
+     * If not specified, the table header is used.
+     *
+     * **Note:** These values are defaults shown to the user. The user can still modify them before export.
+     * If the user modifies a value in the dialog, the user choice takes precedence and is not overridden by
+     * event handlers.
+     *
+     * @since 1.148
+     */
+    defaultExportSettings?: TableExportSettings;
+
     /**
      * A toolbar that can be added by the user to define their own custom buttons, icons, etc. If this is specified,
      * the SmartTable control does not create an additional toolbar, but makes use of this one.
@@ -35511,7 +35607,7 @@ declare module "sap/ui/comp/smarttable/SmartTable" {
     /**
      * Filter settings that will be contained in the exported file
      */
-    filterSettings?: /* was: sap.ui.export.util.Filter */ any[];
+    filterSettings?: Filter[];
   }
 
   /**
@@ -39271,6 +39367,19 @@ declare module "sap/ui/comp/state/UIState" {
       mSettings?: $UIStateSettings
     );
 
+    /**
+     * Scans the filter model data for fields that have a DefaultValues range.
+     *
+     * @ui5-protected Do not call from applications (only from related classes in the framework)
+     *
+     * @returns the defaultValues structure or null
+     */
+    static calcDefaultValues(
+      /**
+       * the filter provider model data
+       */
+      mData: Record<string, any>
+    ): object | null;
     /**
      * Constructs the value state out of a given selection variant and the current model data
      *
@@ -39348,6 +39457,23 @@ declare module "sap/ui/comp/state/UIState" {
        */
       aIgnoreSelOptionNames: Object[]
     ): Record<string, Object[]>;
+    /**
+     * Enriches the internal filter bar value format with DefaultValues skeleton ranges.
+     *
+     * @ui5-protected Do not call from applications (only from related classes in the framework)
+     *
+     * @returns enriched the filter bar inner data format
+     */
+    static enrichWithDefaultValues(
+      /**
+       * the filter bar inner data format
+       */
+      sPayload: string,
+      /**
+       * DefaultValues field information
+       */
+      oDefaultValues: object
+    ): string;
     /**
      * Enriches the internal filter bar value format with the semantic date information.
      *
@@ -39413,6 +39539,28 @@ declare module "sap/ui/comp/state/UIState" {
      * @returns Metadata object describing this class
      */
     static getMetadata(): ManagedObjectMetadata;
+    /**
+     * Gets current value of property {@link #getDefaultValues defaultValues}.
+     *
+     * Structure containing field names that use the DefaultValues operation.
+     *
+     *
+     * ```javascript
+     *
+     * {
+     * 	Fields: [
+     * 		{
+     * 			PropertyName: string
+     * 		}
+     * 	]
+     * }
+     * ```
+     *
+     *
+     *
+     * @returns Value of property `defaultValues`
+     */
+    getDefaultValues(): object;
     /**
      * Gets current value of property {@link #getOrderedItems orderedItems}.
      *
@@ -39583,6 +39731,35 @@ declare module "sap/ui/comp/state/UIState" {
      * @returns Value of property `variantName`
      */
     getVariantName(): string;
+    /**
+     * Sets a new value for property {@link #getDefaultValues defaultValues}.
+     *
+     * Structure containing field names that use the DefaultValues operation.
+     *
+     *
+     * ```javascript
+     *
+     * {
+     * 	Fields: [
+     * 		{
+     * 			PropertyName: string
+     * 		}
+     * 	]
+     * }
+     * ```
+     *
+     *
+     * 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
+     */
+    setDefaultValues(
+      /**
+       * New value for property `defaultValues`
+       */
+      oDefaultValues: object
+    ): this;
     /**
      * Sets a new value for property {@link #getOrderedItems orderedItems}.
      *
@@ -39924,6 +40101,23 @@ declare module "sap/ui/comp/state/UIState" {
      */
     semanticDates?: object | PropertyBindingInfo | `{${string}}`;
 
+    /**
+     * Structure containing field names that use the DefaultValues operation.
+     *
+     *
+     * ```javascript
+     *
+     * {
+     * 	Fields: [
+     * 		{
+     * 			PropertyName: string
+     * 		}
+     * 	]
+     * }
+     * ```
+     */
+    defaultValues?: object | PropertyBindingInfo | `{${string}}`;
+
     /**
      * Structure containing table related settings. The properties might be related to a specific table type
      * and will be ignored if a different table type is used.