@sapui5/ts-types 1.116.0 → 1.117.0

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

@@ -1,3 +1,3 @@
-// For Library Version: 1.116.0
+// For Library Version: 1.117.0
 
 declare namespace sap {}

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.116.0
+// For Library Version: 1.117.0
 
 declare namespace sap {
   namespace ui {
@@ -163,6 +163,23 @@ declare namespace sap {
 
       interface ExportBase$BeforeExportEventParameters {}
 
+      interface ExportHandler$BeforeExportEventParameters {
+        /**
+         * Contains export-related configuration
+         */
+        exportSettings?: object;
+
+        /**
+         * User-specific settings from the Export As dialog
+         */
+        userExportSettings?: object;
+
+        /**
+         * Array of filter settings for the exported data
+         */
+        filterSettings?: sap.ui.export.util.Filter[];
+      }
+
       interface Spreadsheet$BeforeSaveEventParameters {}
 
       /**
@@ -340,6 +357,162 @@ declare namespace sap {
             | sap.ui.model.TreeBinding
         ): object | null;
       }
+      /**
+       * @since 1.102
+       *
+       * The `sap.ui.export.ExportHandler` class allows you to export table data from an SAPUI5 application.
+       */
+      class ExportHandler extends sap.ui.base.EventProvider {
+        /**
+         * Any export-related functionality is encapsulated in the `ExportHandler` that also stores user settings
+         * throughout the session.
+         */
+        constructor(
+          /**
+           * `ExportHandler` capabilities that define supported file types and features
+           */
+          mCapabilities: object
+        );
+
+        /**
+         * Creates a new subclass of class sap.ui.export.ExportHandler 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.base.EventProvider.extend}.
+         *
+         * @returns Created class / constructor function
+         */
+        static extend<T extends Record<string, unknown>>(
+          /**
+           * Name of the class being created
+           */
+          sClassName: string,
+          /**
+           * Object literal with information about the class
+           */
+          oClassInfo?: sap.ClassInfo<T, sap.ui.export.ExportHandler>,
+          /**
+           * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
+           * used by this class
+           */
+          FNMetaImpl?: Function
+        ): Function;
+        /**
+         * Returns a metadata object for class sap.ui.export.ExportHandler.
+         *
+         * @returns Metadata object describing this class
+         */
+        static getMetadata(): sap.ui.base.Metadata;
+        /**
+         * @since 1.102
+         *
+         * Attaches event handler `fnFunction` to the {@link sap.ui.export.ExportHandler#event:beforeExport} event
+         * of this `sap.ui.export.ExportHandler`.
+         *  When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
+         * otherwise it will be bound to this `sap.ui.export.ExportHandler` itself.
+         *  This event is fired just before the export process is started.
+         *
+         * @returns Reference to `this` in order to allow method chaining
+         */
+        attachBeforeExport(
+          /**
+           * An application-specific payload object that will be passed to the event handler along with the event
+           * object when firing the event
+           */
+          oData: object,
+          /**
+           * The function to be called when the event occurs
+           */
+          fnHandler: Function,
+          /**
+           * Context object to call the event handler with; defaults to this `sap.ui.export.ExportHandler` instance
+           * itself
+           */
+          oListener?: object
+        ): this;
+        /**
+         * @since 1.102
+         *
+         * Attaches event handler `fnFunction` to the {@link sap.ui.export.ExportHandler#event:beforeExport} event
+         * of this `sap.ui.export.ExportHandler`.
+         *  When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
+         * otherwise it will be bound to this `sap.ui.export.ExportHandler` itself.
+         *  This event is fired just before the export process is started.
+         *
+         * @returns Reference to `this` in order to allow method chaining
+         */
+        attachBeforeExport(
+          /**
+           * The function to be called when the event occurs
+           */
+          fnHandler: Function,
+          /**
+           * Context object to call the event handler with; defaults to this `sap.ui.export.ExportHandler` instance
+           * itself
+           */
+          oListener?: object
+        ): this;
+        /**
+         * Cleans up the internal structures and removes all event handlers.
+         *
+         * The object must not be used anymore after destroy was called.
+         * See:
+         * 	sap.ui.base.Object#destroy
+         */
+        destroy(): void;
+        /**
+         * @since 1.102
+         *
+         * Detaches event handler `fnFunction` from the {@link sap.ui.export.ExportHandler#event:beforeExport} event
+         * of this `sap.ui.export.ExportHandler`.
+         *  The passed function and listener object must match the ones used for event registration.
+         *
+         * @returns Reference to `this` in order to allow method chaining
+         */
+        detachBeforeExport(
+          /**
+           * The function to be called when the event occurs
+           */
+          fnHandler: Function,
+          /**
+           * Context object on which the given function had to be called
+           */
+          oListener?: object
+        ): this;
+        /**
+         * @since 1.102
+         *
+         * Exports the data as defined via parameter. The function returns a `Promise` that will be resolved after
+         * the export process has been finished. In case of an error, its message will be shown in a `Dialog`, and
+         * the `Promise` will be rejected.
+         *
+         * @returns A `Promise` that gets resolved after the export process has been finished
+         */
+        export(
+          /**
+           * Export settings that are used for the export
+           */
+          mExportSettings: object
+        ): Promise<any>;
+        /**
+         * @since 1.102
+         *
+         * Exports the data as defined by the user. This function will show an export settings dialog where the
+         * user can define certain settings that influence the output of the export functionality.
+         *
+         * @returns A `Promise` that resolves once the data has been exported
+         */
+        exportAs(
+          /**
+           * General export settings containing `workbook` and `dataSource` information
+           */
+          oSettings: object,
+          /**
+           * Resolves the label for a particular column that is not directly contained in the export settings
+           */
+          fnResolveColumnLabel?: Function
+        ): Promise<any>;
+      }
       /**
        * @since 1.50
        *
@@ -808,15 +981,32 @@ declare namespace sap {
        * File types for document export.
        */
       enum FileType {
+        /**
+         * @since 1.117
+         *
+         * Portable Document Format (PDF) file type.
+         */
+        PDF = "PDF",
         /**
          * Office Open XML - SpreadsheetML file type.
          */
         XLSX = "XLSX",
       }
 
-      type ExportBase$BeforeExportEvent = sap.ui.base.Event<ExportBase$BeforeExportEventParameters>;
+      type ExportBase$BeforeExportEvent = sap.ui.base.Event<
+        ExportBase$BeforeExportEventParameters,
+        ExportBase
+      >;
+
+      type ExportHandler$BeforeExportEvent = sap.ui.base.Event<
+        ExportHandler$BeforeExportEventParameters,
+        ExportHandler
+      >;
 
-      type Spreadsheet$BeforeSaveEvent = sap.ui.base.Event<Spreadsheet$BeforeSaveEventParameters>;
+      type Spreadsheet$BeforeSaveEvent = sap.ui.base.Event<
+        Spreadsheet$BeforeSaveEventParameters,
+        Spreadsheet
+      >;
     }
   }
 

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.116.0
+// For Library Version: 1.117.0
 
 declare namespace sap {
   namespace ui {
@@ -1082,15 +1082,30 @@ declare namespace sap {
           ): this;
         }
 
-        type VariantManagement$CancelEvent = sap.ui.base.Event<VariantManagement$CancelEventParameters>;
-
-        type VariantManagement$InitializedEvent = sap.ui.base.Event<VariantManagement$InitializedEventParameters>;
-
-        type VariantManagement$ManageEvent = sap.ui.base.Event<VariantManagement$ManageEventParameters>;
-
-        type VariantManagement$SaveEvent = sap.ui.base.Event<VariantManagement$SaveEventParameters>;
-
-        type VariantManagement$SelectEvent = sap.ui.base.Event<VariantManagement$SelectEventParameters>;
+        type VariantManagement$CancelEvent = sap.ui.base.Event<
+          VariantManagement$CancelEventParameters,
+          VariantManagement
+        >;
+
+        type VariantManagement$InitializedEvent = sap.ui.base.Event<
+          VariantManagement$InitializedEventParameters,
+          VariantManagement
+        >;
+
+        type VariantManagement$ManageEvent = sap.ui.base.Event<
+          VariantManagement$ManageEventParameters,
+          VariantManagement
+        >;
+
+        type VariantManagement$SaveEvent = sap.ui.base.Event<
+          VariantManagement$SaveEventParameters,
+          VariantManagement
+        >;
+
+        type VariantManagement$SelectEvent = sap.ui.base.Event<
+          VariantManagement$SelectEventParameters,
+          VariantManagement
+        >;
       }
       /**
        * The `sap.ui.fl.write` namespace contains all code to create, update, and reset flex objects. Additional

package/types/sap.ui.generic.app.d.ts

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

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

@@ -1,3 +1,3 @@
-// For Library Version: 1.116.0
+// For Library Version: 1.117.0
 
 declare namespace sap {}

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.116.0
+// For Library Version: 1.117.0
 
 declare namespace sap {
   namespace ui {
@@ -519,6 +519,12 @@ declare namespace sap {
              */
             eCardArea?: sap.ui.integration.CardArea
           ): void;
+          /**
+           * @experimental (since 1.117)
+           *
+           * Hides the message previously shown by showMessage.
+           */
+          hideMessage(): void;
           /**
            * @since 1.85
            * @experimental (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
@@ -1754,6 +1760,12 @@ declare namespace sap {
              */
             eCardArea?: sap.ui.integration.CardArea
           ): void;
+          /**
+           * @experimental (since 1.117)
+           *
+           * Hides the message previously shown by showMessage.
+           */
+          hideMessage(): void;
           /**
            * @since 1.85
            * @experimental (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
@@ -2173,15 +2185,30 @@ declare namespace sap {
           validateControls(): boolean;
         }
 
-        type Card$ActionEvent = sap.ui.base.Event<Card$ActionEventParameters>;
-
-        type Card$ConfigurationChangeEvent = sap.ui.base.Event<Card$ConfigurationChangeEventParameters>;
-
-        type Card$ManifestAppliedEvent = sap.ui.base.Event<Card$ManifestAppliedEventParameters>;
-
-        type Card$ManifestReadyEvent = sap.ui.base.Event<Card$ManifestReadyEventParameters>;
-
-        type Card$StateChangedEvent = sap.ui.base.Event<Card$StateChangedEventParameters>;
+        type Card$ActionEvent = sap.ui.base.Event<
+          Card$ActionEventParameters,
+          Card
+        >;
+
+        type Card$ConfigurationChangeEvent = sap.ui.base.Event<
+          Card$ConfigurationChangeEventParameters,
+          Card
+        >;
+
+        type Card$ManifestAppliedEvent = sap.ui.base.Event<
+          Card$ManifestAppliedEventParameters,
+          Card
+        >;
+
+        type Card$ManifestReadyEvent = sap.ui.base.Event<
+          Card$ManifestReadyEventParameters,
+          Card
+        >;
+
+        type Card$StateChangedEvent = sap.ui.base.Event<
+          Card$StateChangedEventParameters,
+          Card
+        >;
       }
 
       interface $ActionDefinitionSettings extends sap.ui.core.$ElementSettings {
@@ -3087,6 +3114,25 @@ declare namespace sap {
          * Called after the card is initialized.
          */
         onCardReady(): void;
+        /**
+         * @deprecated (since 1.85) - This property is replaced by the `actions` aggregation of the card;
+         * @experimental (since 1.75) - Disclaimer: this property is in a beta state - incompatible API changes
+         * may be done before its official public release. Use at your own discretion.
+         *
+         * Sets a new value for property {@link #getActions actions}.
+         *
+         * The actions configuration.
+         *
+         * 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
+         */
+        setActions(
+          /**
+           * New value for property `actions`
+           */
+          sActions: sap.ui.integration.CardMenuAction[]
+        ): this;
         /**
          * Sets current value of property {@link #setFormatters formatters}.
          *
@@ -4023,19 +4069,40 @@ declare namespace sap {
         parameters: object;
       };
 
-      type ActionDefinition$PressEvent = sap.ui.base.Event<ActionDefinition$PressEventParameters>;
-
-      type Extension$ActionEvent = sap.ui.base.Event<Extension$ActionEventParameters>;
-
-      type Host$ActionEvent = sap.ui.base.Event<Host$ActionEventParameters>;
-
-      type Host$CardConfigurationChangeEvent = sap.ui.base.Event<Host$CardConfigurationChangeEventParameters>;
-
-      type Host$CardInitializedEvent = sap.ui.base.Event<Host$CardInitializedEventParameters>;
-
-      type Host$CardStateChangedEvent = sap.ui.base.Event<Host$CardStateChangedEventParameters>;
-
-      type Host$MessageEvent = sap.ui.base.Event<Host$MessageEventParameters>;
+      type ActionDefinition$PressEvent = sap.ui.base.Event<
+        ActionDefinition$PressEventParameters,
+        ActionDefinition
+      >;
+
+      type Extension$ActionEvent = sap.ui.base.Event<
+        Extension$ActionEventParameters,
+        Extension
+      >;
+
+      type Host$ActionEvent = sap.ui.base.Event<
+        Host$ActionEventParameters,
+        Host
+      >;
+
+      type Host$CardConfigurationChangeEvent = sap.ui.base.Event<
+        Host$CardConfigurationChangeEventParameters,
+        Host
+      >;
+
+      type Host$CardInitializedEvent = sap.ui.base.Event<
+        Host$CardInitializedEventParameters,
+        Host
+      >;
+
+      type Host$CardStateChangedEvent = sap.ui.base.Event<
+        Host$CardStateChangedEventParameters,
+        Host
+      >;
+
+      type Host$MessageEvent = sap.ui.base.Event<
+        Host$MessageEventParameters,
+        Host
+      >;
     }
   }
 

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.116.0
+// For Library Version: 1.117.0
 
 declare namespace sap {
   namespace ui {
@@ -2686,9 +2686,15 @@ declare namespace sap {
          */
         type CSSGridTrack = string;
 
-        type GridResponsiveLayout$LayoutChangeEvent = sap.ui.base.Event<GridResponsiveLayout$LayoutChangeEventParameters>;
+        type GridResponsiveLayout$LayoutChangeEvent = sap.ui.base.Event<
+          GridResponsiveLayout$LayoutChangeEventParameters,
+          GridResponsiveLayout
+        >;
 
-        type ResponsiveColumnLayout$LayoutChangeEvent = sap.ui.base.Event<ResponsiveColumnLayout$LayoutChangeEventParameters>;
+        type ResponsiveColumnLayout$LayoutChangeEvent = sap.ui.base.Event<
+          ResponsiveColumnLayout$LayoutChangeEventParameters,
+          ResponsiveColumnLayout
+        >;
       }
 
       namespace form {
@@ -3292,6 +3298,8 @@ declare namespace sap {
             | `{${string}}`;
 
           /**
+           * @deprecated (since 1.93) - use another `Layout`
+           *
            * The overall minimum width in pixels that is used for the `SimpleForm`.
            *
            * If the available width is below the given `minWidth` the `SimpleForm` will create a new row for the next
@@ -3336,6 +3344,8 @@ declare namespace sap {
             | `{${string}}`;
 
           /**
+           * @deprecated (since 1.93) - use another `Layout`
+           *
            * Specifies the min-width in pixels of the label in all form rows.
            *
            * **Note:** This property is only used if a `ResponsiveLayout` is used as a layout.
@@ -3354,8 +3364,9 @@ declare namespace sap {
            * **Note** If possible, set the `layout` before adding content to prevent calculations for the default
            * layout.
            *
-           * **Note** The `ResponsiveLayout` has been deprecated and must no longer be used. For compatibility reasons
-           * the default could not be changed.
+           * **Note** The `ResponsiveLayout` has been deprecated and must no longer be used.
+           *
+           * **Note** As of version 1.117, the `ResponsiveGridLayout` is used as default.
            */
           layout?:
             | sap.ui.layout.form.SimpleFormLayout
@@ -4999,22 +5010,6 @@ declare namespace sap {
            * @returns Metadata object describing this class
            */
           static getMetadata(): sap.ui.core.ElementMetadata;
-          /**
-           * @since 1.74.0
-           * @ui5-protected Do not call from applications (only from related classes in the framework)
-           *
-           * Sets the editable state of the `FormElement`.
-           *
-           * This must only be called from the `Form` and it's `FormContainers`.
-           *
-           * Labels inside of a `Form` must be invalidated if `editable` changed on `Form`.
-           */
-          _setEditable(
-            /**
-             * Editable state of the `Form`
-             */
-            bEditable: boolean
-          ): void;
           /**
            * Adds some field to the aggregation {@link #getFields fields}.
            *
@@ -5249,6 +5244,55 @@ declare namespace sap {
            * @returns Value of property `backgroundDesign`
            */
           getBackgroundDesign(): sap.ui.layout.BackgroundDesign;
+          /**
+           * @ui5-protected Do not call from applications (only from related classes in the framework)
+           *
+           * In {@link sap.ui.layout.SemanticFormElement SemanticFormElement}, delimiters are rendered. They should
+           * use only a small space. So `Layout`-dependent `LayoutData` are needed.
+           *
+           * This function needs to be implemented by the specific `Layout`.
+           *
+           * @returns LayoutData or promise retuning LayoutData
+           */
+          getLayoutDataForDelimiter(): sap.ui.core.LayoutData | Promise<any>;
+          /**
+           * @ui5-protected Do not call from applications (only from related classes in the framework)
+           *
+           * In {@link sap.ui.layout.SemanticFormElement SemanticFormElement}, delimiters are rendered. The fields
+           * should be rendered per default in a way, the field and the corresponding delimiter filling one row in
+           * phone mode. In desktop mode they should all be in one row.
+           *
+           * This function needs to be implemented by the specific `Layout`.
+           *
+           * @returns LayoutData or promise retuning LayoutData
+           */
+          getLayoutDataForSemanticField(
+            /**
+             * Number of field in the `SemanticFormElement`
+             */
+            iFields: int,
+            /**
+             * Index of field in the `SemanticFormElement`
+             */
+            iIndex: int,
+            /**
+             * existing `LayoutData` that might be just changed
+             */
+            oLayoutData?: sap.ui.core.LayoutData
+          ): sap.ui.core.LayoutData | Promise<any>;
+          /**
+           * @ui5-protected Do not call from applications (only from related classes in the framework)
+           *
+           * For {@link sap.ui.layout.SemanticFormElement SemanticFormElement}, all text-based controls should be
+           * concatenated in display mode. If the `Layout` supports rendering of single controls, they are rendered
+           * divided by delimiters. If the `Layout` doesn't support this, one concatenated text is rendered. Here
+           * only text is supported, no links or other special rendering.
+           *
+           * This function needs to be implemented by the specific `Layout`.
+           *
+           * @returns `true` if layout allows to render single controls for {@link sap.ui.layout.SemanticFormElement SemanticFormElement}
+           */
+          renderControlsForSemanticElement(): boolean;
           /**
            * @since 1.36.0
            *
@@ -6917,6 +6961,8 @@ declare namespace sap {
            */
           getEmptySpanXL(): int;
           /**
+           * @deprecated (since 1.93) - use another `Layout`
+           *
            * Gets current value of property {@link #getLabelMinWidth labelMinWidth}.
            *
            * Specifies the min-width in pixels of the label in all form rows.
@@ -7004,10 +7050,11 @@ declare namespace sap {
            * **Note** If possible, set the `layout` before adding content to prevent calculations for the default
            * layout.
            *
-           * **Note** The `ResponsiveLayout` has been deprecated and must no longer be used. For compatibility reasons
-           * the default could not be changed.
+           * **Note** The `ResponsiveLayout` has been deprecated and must no longer be used.
            *
-           * Default value is `ResponsiveLayout`.
+           * **Note** As of version 1.117, the `ResponsiveGridLayout` is used as default.
+           *
+           * Default value is `ResponsiveGridLayout`.
            *
            * @returns Value of property `layout`
            */
@@ -7027,6 +7074,8 @@ declare namespace sap {
            */
           getMaxContainerCols(): int;
           /**
+           * @deprecated (since 1.93) - use another `Layout`
+           *
            * Gets current value of property {@link #getMinWidth minWidth}.
            *
            * The overall minimum width in pixels that is used for the `SimpleForm`.
@@ -7452,6 +7501,8 @@ declare namespace sap {
             iEmptySpanXL?: int
           ): this;
           /**
+           * @deprecated (since 1.93) - use another `Layout`
+           *
            * Sets a new value for property {@link #getLabelMinWidth labelMinWidth}.
            *
            * Specifies the min-width in pixels of the label in all form rows.
@@ -7574,12 +7625,13 @@ declare namespace sap {
            * **Note** If possible, set the `layout` before adding content to prevent calculations for the default
            * layout.
            *
-           * **Note** The `ResponsiveLayout` has been deprecated and must no longer be used. For compatibility reasons
-           * the default could not be changed.
+           * **Note** The `ResponsiveLayout` has been deprecated and must no longer be used.
+           *
+           * **Note** As of version 1.117, the `ResponsiveGridLayout` is used as default.
            *
            * When called with a value of `null` or `undefined`, the default value of the property will be restored.
            *
-           * Default value is `ResponsiveLayout`.
+           * Default value is `ResponsiveGridLayout`.
            *
            * @returns Reference to `this` in order to allow method chaining
            */
@@ -7611,6 +7663,8 @@ declare namespace sap {
             iMaxContainerCols?: int
           ): this;
           /**
+           * @deprecated (since 1.93) - use another `Layout`
+           *
            * Sets a new value for property {@link #getMinWidth minWidth}.
            *
            * The overall minimum width in pixels that is used for the `SimpleForm`.
@@ -14231,11 +14285,20 @@ declare namespace sap {
        */
       type GridSpan = string;
 
-      type DynamicSideContent$BreakpointChangedEvent = sap.ui.base.Event<DynamicSideContent$BreakpointChangedEventParameters>;
+      type DynamicSideContent$BreakpointChangedEvent = sap.ui.base.Event<
+        DynamicSideContent$BreakpointChangedEventParameters,
+        DynamicSideContent
+      >;
 
-      type PaneContainer$ResizeEvent = sap.ui.base.Event<PaneContainer$ResizeEventParameters>;
+      type PaneContainer$ResizeEvent = sap.ui.base.Event<
+        PaneContainer$ResizeEventParameters,
+        PaneContainer
+      >;
 
-      type Splitter$ResizeEvent = sap.ui.base.Event<Splitter$ResizeEventParameters>;
+      type Splitter$ResizeEvent = sap.ui.base.Event<
+        Splitter$ResizeEventParameters,
+        Splitter
+      >;
     }
   }