@sapui5/ts-types 1.104.0 → 1.105.0

package/types/sap.ui.webc.fiori.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.104.0
+// For Library Version: 1.105.0
 
 declare namespace sap {
   namespace ui {
@@ -153,7 +153,7 @@ declare namespace sap {
         interface $BarSettings
           extends sap.ui.webc.common.$WebComponentSettings {
           /**
-           * Defines the `sap.ui.webc.fiori.Bar` design.
+           * Defines the component's design.
            *
            *
            *
@@ -469,6 +469,24 @@ declare namespace sap {
             | sap.ui.base.ManagedObject.PropertyBindingInfo
             | `{${string}}`;
 
+          /**
+           * Determines which illustration breakpoint variant is used.
+           *
+           *  Available options are:
+           * 	 - `Auto`
+           * 	 - `Base`
+           * 	 - `Spot`
+           * 	 - `Dialog`
+           * 	 - `Scene`
+           *
+           * As `IllustratedMessage` adapts itself around the `Illustration`, the other elements of the component
+           * are displayed differently on the different breakpoints/illustration sizes.
+           */
+          size?:
+            | sap.ui.webc.fiori.IllustrationMessageSize
+            | sap.ui.base.ManagedObject.PropertyBindingInfo
+            | `{${string}}`;
+
           /**
            * Defines the subtitle of the component.
            *
@@ -1690,6 +1708,11 @@ declare namespace sap {
             | sap.ui.base.ManagedObject.AggregationBindingInfo
             | `{${string}}`;
 
+          /**
+           * Fired before the component is opened. **This event does not bubble.**
+           */
+          beforeOpen?: (oEvent: sap.ui.base.Event) => void;
+
           /**
            * Fired when cancel button is activated.
            */
@@ -1952,7 +1975,7 @@ declare namespace sap {
           /**
            * Gets current value of property {@link #getDesign design}.
            *
-           * Defines the `sap.ui.webc.fiori.Bar` design.
+           * Defines the component's design.
            *
            *
            *
@@ -2140,7 +2163,7 @@ declare namespace sap {
           /**
            * Sets a new value for property {@link #getDesign design}.
            *
-           * Defines the `sap.ui.webc.fiori.Bar` design.
+           * Defines the component's design.
            *
            *
            *
@@ -3323,7 +3346,7 @@ declare namespace sap {
          *
          * Overview:
          *
-         * The `FlexibleColumnLayout` implements the master-detail-detail paradigm by displaying up to three pages
+         * The `FlexibleColumnLayout` implements the list-detail-detail paradigm by displaying up to three pages
          * in separate columns. There are several possible layouts that can be changed either with the component
          * API, or by pressing the arrows, displayed between the columns.
          *
@@ -3950,6 +3973,26 @@ declare namespace sap {
            * @returns Value of property `name`
            */
           getName(): sap.ui.webc.fiori.IllustrationMessageType;
+          /**
+           * Gets current value of property {@link #getSize size}.
+           *
+           * Determines which illustration breakpoint variant is used.
+           *
+           *  Available options are:
+           * 	 - `Auto`
+           * 	 - `Base`
+           * 	 - `Spot`
+           * 	 - `Dialog`
+           * 	 - `Scene`
+           *
+           * As `IllustratedMessage` adapts itself around the `Illustration`, the other elements of the component
+           * are displayed differently on the different breakpoints/illustration sizes.
+           *
+           * Default value is `Auto`.
+           *
+           * @returns Value of property `size`
+           */
+          getSize(): sap.ui.webc.fiori.IllustrationMessageSize;
           /**
            * Gets content of aggregation {@link #getSubtitle subtitle}.
            *
@@ -4048,6 +4091,33 @@ declare namespace sap {
              */
             sName?: sap.ui.webc.fiori.IllustrationMessageType
           ): this;
+          /**
+           * Sets a new value for property {@link #getSize size}.
+           *
+           * Determines which illustration breakpoint variant is used.
+           *
+           *  Available options are:
+           * 	 - `Auto`
+           * 	 - `Base`
+           * 	 - `Spot`
+           * 	 - `Dialog`
+           * 	 - `Scene`
+           *
+           * As `IllustratedMessage` adapts itself around the `Illustration`, the other elements of the component
+           * are displayed differently on the different breakpoints/illustration sizes.
+           *
+           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+           *
+           * Default value is `Auto`.
+           *
+           * @returns Reference to `this` in order to allow method chaining
+           */
+          setSize(
+            /**
+             * New value for property `size`
+             */
+            sSize?: sap.ui.webc.fiori.IllustrationMessageSize
+          ): this;
           /**
            * Sets the aggregated {@link #getSubtitle subtitle}.
            *
@@ -4106,8 +4176,8 @@ declare namespace sap {
          *
          * Overview:
          *
-         * The `ui-media-gallery` component allows the user to browse through multimedia items. Currently, the supported
-         * items are images and videos. The items should be defined using the `sap.ui.webc.fiori.MediaGalleryItem`
+         * The `sap.ui.webc.fiori.MediaGallery` component allows the user to browse through multimedia items. Currently,
+         * the supported items are images and videos. The items should be defined using the `sap.ui.webc.fiori.MediaGalleryItem`
          * component.
          *
          * The items are initially displayed as thumbnails. When the user selects a thumbnail, the corresponding
@@ -6295,8 +6365,8 @@ declare namespace sap {
          *
          * Overview:
          *
-         * The `sap.ui.webc.fiori.Page` is a container control that holds one whole screen of an application. The
-         * page has three distinct areas that can hold content - a header, content area and a footer. Structure:
+         * The `sap.ui.webc.fiori.Page` is a container component that holds one whole screen of an application.
+         * The page has three distinct areas that can hold content - a header, content area and a footer. Structure:
          * Header: The top most area of the page is occupied by the header. The standard header includes a navigation
          * button and a title. Content: The content occupies the main part of the page. Only the content area is
          * scrollable by default. This can be prevented by setting `enableScrolling` to `false`. Footer: The footer
@@ -11545,6 +11615,53 @@ declare namespace sap {
              */
             oSortItem: sap.ui.webc.fiori.ISortItem
           ): this;
+          /**
+           * Attaches event handler `fnFunction` to the {@link #event:beforeOpen beforeOpen} event of this `sap.ui.webc.fiori.ViewSettingsDialog`.
+           *
+           * 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.webc.fiori.ViewSettingsDialog` itself.
+           *
+           * Fired before the component is opened. **This event does not bubble.**
+           *
+           * @returns Reference to `this` in order to allow method chaining
+           */
+          attachBeforeOpen(
+            /**
+             * 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
+             */
+            fnFunction: (p1: sap.ui.base.Event) => void,
+            /**
+             * Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.ViewSettingsDialog`
+             * itself
+             */
+            oListener?: object
+          ): this;
+          /**
+           * Attaches event handler `fnFunction` to the {@link #event:beforeOpen beforeOpen} event of this `sap.ui.webc.fiori.ViewSettingsDialog`.
+           *
+           * 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.webc.fiori.ViewSettingsDialog` itself.
+           *
+           * Fired before the component is opened. **This event does not bubble.**
+           *
+           * @returns Reference to `this` in order to allow method chaining
+           */
+          attachBeforeOpen(
+            /**
+             * The function to be called when the event occurs
+             */
+            fnFunction: (p1: sap.ui.base.Event) => void,
+            /**
+             * Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.ViewSettingsDialog`
+             * itself
+             */
+            oListener?: object
+          ): this;
           /**
            * Attaches event handler `fnFunction` to the {@link #event:cancel cancel} event of this `sap.ui.webc.fiori.ViewSettingsDialog`.
            *
@@ -11651,6 +11768,23 @@ declare namespace sap {
            * @returns Reference to `this` in order to allow method chaining
            */
           destroySortItems(): this;
+          /**
+           * Detaches event handler `fnFunction` from the {@link #event:beforeOpen beforeOpen} event of this `sap.ui.webc.fiori.ViewSettingsDialog`.
+           *
+           * The passed function and listener object must match the ones used for event registration.
+           *
+           * @returns Reference to `this` in order to allow method chaining
+           */
+          detachBeforeOpen(
+            /**
+             * The function to be called, when the event occurs
+             */
+            fnFunction: (p1: sap.ui.base.Event) => void,
+            /**
+             * Context object on which the given function had to be called
+             */
+            oListener?: object
+          ): this;
           /**
            * Detaches event handler `fnFunction` from the {@link #event:cancel cancel} event of this `sap.ui.webc.fiori.ViewSettingsDialog`.
            *
@@ -11685,6 +11819,17 @@ declare namespace sap {
              */
             oListener?: object
           ): this;
+          /**
+           * Fires event {@link #event:beforeOpen beforeOpen} to attached listeners.
+           *
+           * @returns Reference to `this` in order to allow method chaining
+           */
+          fireBeforeOpen(
+            /**
+             * Parameters to pass along with the event
+             */
+            mParameters?: object
+          ): this;
           /**
            * Fires event {@link #event:cancel cancel} to attached listeners.
            *
@@ -11863,6 +12008,19 @@ declare namespace sap {
              */
             vSortItem: int | string | sap.ui.webc.fiori.ISortItem
           ): sap.ui.webc.fiori.ISortItem | null;
+          /**
+           * Sets a JavaScript object, as settings to the `sap.ui.webc.fiori.ViewSettingsDialog`. This method can
+           * be used after the dialog is initially open, as the dialog need to set its initial settings. The `sap.ui.webc.fiori.ViewSettingsDialog`
+           * throws an event called "before-open", this can be used as trigger point. The object should have the following
+           * format: `{ { "sortOrder" : "Ascending", "sortBy" : "Name", "filters" : [{"Filter 1": ["Some filter 1",
+           * "Some filter 2"]}, {"Filter 2": ["Some filter 4"]}]} }`
+           */
+          setConfirmedSettings(
+            /**
+             * A value to be set as predefined settings.
+             */
+            settings: string
+          ): void;
           /**
            * Sets a new value for property {@link #getSortDescending sortDescending}.
            *
@@ -12626,7 +12784,7 @@ declare namespace sap {
            * Desktop: 25/25/50 Start, Mid and End (expanded) columns are displayed Tablet: 0/33/67 Mid and End (expanded)
            * columns are displayed, Start is accessible by layout arrows Phone: -/-/100 (only the End column is displayed)
            *
-           * Use to display all three pages (master, detail, detail-detail) when the user should focus on the detail-detail.
+           * Use to display all three pages (list, detail, detail-detail) when the user should focus on the detail-detail.
            */
           ThreeColumnsEndExpanded = "ThreeColumnsEndExpanded",
           /**
@@ -12634,7 +12792,7 @@ declare namespace sap {
            * and End columns are displayed, Start is accessible by a layout arrow Phone: -/-/100 only the End column
            * is displayed
            *
-           * Use to display all three pages (master, detail, detail-detail) when the user should focus on the detail.
+           * Use to display all three pages (list, detail, detail-detail) when the user should focus on the detail.
            */
           ThreeColumnsMidExpanded = "ThreeColumnsMidExpanded",
           /**
@@ -12642,7 +12800,7 @@ declare namespace sap {
            * Tablet: 33/67/0 Start and Mid (expanded) columns are displayed, End is accessible by a layout arrow Phone:
            * -/-/100 only the End column is displayed
            *
-           * Use to display the master and detail pages when the user should focus on the detail. The detail-detail
+           * Use to display the list and detail pages when the user should focus on the detail. The detail-detail
            * is still loaded and easily accessible with a layout arrow.
            */
           ThreeColumnsMidExpandedEndHidden = "ThreeColumnsMidExpandedEndHidden",
@@ -12651,25 +12809,60 @@ declare namespace sap {
            * 67/33/0 Start (expanded) and Mid columns are displayed, End is accessible by layout arrows Phone: -/-/100
            * only the End column is displayed
            *
-           * Use to display the master and detail pages when the user should focus on the master. The detail-detail
-           * is still loaded and easily accessible with layout arrows.
+           * Use to display the list and detail pages when the user should focus on the list. The detail-detail is
+           * still loaded and easily accessible with layout arrows.
            */
           ThreeColumnsStartExpandedEndHidden = "ThreeColumnsStartExpandedEndHidden",
           /**
            * Desktop: 33/67/- Start and Mid (expanded) columns are displayed Tablet: 33/67/- Start and Mid (expanded)
            * columns are displayed Phone: -/100/- only the Mid column is displayed
            *
-           * Use to display both a master and a detail page when the user should focus on the detail page.
+           * Use to display both a list and a detail page when the user should focus on the detail page.
            */
           TwoColumnsMidExpanded = "TwoColumnsMidExpanded",
           /**
            * Desktop: 67/33/- Start (expanded) and Mid columns are displayed Tablet: 67/33/- Start (expanded) and
            * Mid columns are displayed Phone: -/100/- only the Mid column is displayed
            *
-           * Use to display both a master and a detail page when the user should focus on the master page.
+           * Use to display both a list and a detail page when the user should focus on the list page.
            */
           TwoColumnsStartExpanded = "TwoColumnsStartExpanded",
         }
+        /**
+         * @SINCE 1.106.0
+         * @EXPERIMENTAL (since 1.106.0)
+         *
+         * Different types of IllustrationMessageSize.
+         */
+        enum IllustrationMessageSize {
+          /**
+           * Automatically decides the `Illustration` size (`Base`, `Spot`, `Dialog`, or `Scene`) depending on the
+           * `IllustratedMessage` container width.
+           *
+           * **Note:** `Auto` is the only option where the illustration size is changed according to the available
+           * container width. If any other `IllustratedMessageSize` is chosen, it remains until changed by the app
+           * developer.
+           */
+          Auto = "Auto",
+          /**
+           * Base `Illustration` size (XS breakpoint). Suitable for cards (two columns).
+           *
+           * **Note:** When `Base` is in use, no illustration is displayed.
+           */
+          Base = "Base",
+          /**
+           * Dialog `Illustration` size (M breakpoint). Suitable for dialogs.
+           */
+          Dialog = "Dialog",
+          /**
+           * Scene `Illustration` size (L breakpoint). Suitable for a `Page` or a table.
+           */
+          Scene = "Scene",
+          /**
+           * Spot `Illustration` size (S breakpoint). Suitable for cards (four columns).
+           */
+          Spot = "Spot",
+        }
         /**
          * @SINCE 1.95.0
          * @EXPERIMENTAL (since 1.95.0)