@sapui5/types 1.120.11 → 1.120.13

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

@@ -1,13 +1,13 @@
-// For Library Version: 1.120.3
+// For Library Version: 1.120.5
 
 declare module "sap/zen/commons/library" {}
 
 declare module "sap/zen/commons/HAlign" {
   /**
-   * @deprecated (since 1.89.0)
-   *
    * Horizontal alignment, e.g. of a layout cell's content within the cell's borders. Note that some values
    * depend on the current locale's writing direction while others do not.
+   *
+   * @deprecated (since 1.89.0) - Please use the WD Grid control instead.
    */
   enum HAlign {
     /**
@@ -49,9 +49,9 @@ declare module "sap/zen/commons/layout/AbsoluteLayout" {
   } from "sap/ui/base/ManagedObject";
 
   /**
-   * @deprecated (since 1.38)
-   *
    * The Absolute Layout positions its child controls absolutely
+   *
+   * @deprecated (since 1.38)
    */
   export default class AbsoluteLayout extends Control {
     /**
@@ -91,6 +91,7 @@ declare module "sap/zen/commons/layout/AbsoluteLayout" {
      *
      * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
      *
+     *
      * @returns Created class / constructor function
      */
     static extend<T extends Record<string, unknown>>(
@@ -111,6 +112,7 @@ declare module "sap/zen/commons/layout/AbsoluteLayout" {
     /**
      * Returns a metadata object for class sap.zen.commons.layout.AbsoluteLayout.
      *
+     *
      * @returns Metadata object describing this class
      */
     static getMetadata(): ElementMetadata;
@@ -133,6 +135,7 @@ declare module "sap/zen/commons/layout/AbsoluteLayout" {
     /**
      * Adds some position to the aggregation {@link #getPositions positions}.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     addPosition(
@@ -149,6 +152,7 @@ declare module "sap/zen/commons/layout/AbsoluteLayout" {
     /**
      * Destroys all the positions in the aggregation {@link #getPositions positions}.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     destroyPositions(): this;
@@ -163,6 +167,7 @@ declare module "sap/zen/commons/layout/AbsoluteLayout" {
      *
      * Default value is `"100%"`.
      *
+     *
      * @returns Value of property `height`
      */
     getHeight(): CSSSize;
@@ -173,6 +178,7 @@ declare module "sap/zen/commons/layout/AbsoluteLayout" {
      *
      * Default value is `Hidden`.
      *
+     *
      * @returns Value of property `horizontalScrolling`
      */
     getHorizontalScrolling(): Scrolling | keyof typeof Scrolling;
@@ -189,6 +195,7 @@ declare module "sap/zen/commons/layout/AbsoluteLayout" {
      *
      * Default value is `Hidden`.
      *
+     *
      * @returns Value of property `verticalScrolling`
      */
     getVerticalScrolling(): Scrolling | keyof typeof Scrolling;
@@ -199,6 +206,7 @@ declare module "sap/zen/commons/layout/AbsoluteLayout" {
      *
      * Default value is `'100%'`.
      *
+     *
      * @returns Value of property `width`
      */
     getWidth(): CSSSize;
@@ -216,6 +224,7 @@ declare module "sap/zen/commons/layout/AbsoluteLayout" {
      * Checks for the provided `sap.zen.commons.layout.PositionContainer` in the aggregation {@link #getPositions positions}.
      * and returns its index if found or -1 otherwise.
      *
+     *
      * @returns The index of the provided control in the aggregation if found, or -1 otherwise
      */
     indexOfPosition(
@@ -249,6 +258,7 @@ declare module "sap/zen/commons/layout/AbsoluteLayout" {
     /**
      * Inserts a position into the aggregation {@link #getPositions positions}.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     insertPosition(
@@ -273,6 +283,7 @@ declare module "sap/zen/commons/layout/AbsoluteLayout" {
      *
      * Additionally, it unregisters them from the hosting UIArea.
      *
+     *
      * @returns An array of the removed elements (might be empty)
      */
     removeAllPositions(): PositionContainer[];
@@ -289,6 +300,7 @@ declare module "sap/zen/commons/layout/AbsoluteLayout" {
     /**
      * Removes a position from the aggregation {@link #getPositions positions}.
      *
+     *
      * @returns The removed position or `null`
      */
     removePosition(
@@ -306,6 +318,7 @@ declare module "sap/zen/commons/layout/AbsoluteLayout" {
      *
      * Default value is `"100%"`.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     setHeight(
@@ -323,6 +336,7 @@ declare module "sap/zen/commons/layout/AbsoluteLayout" {
      *
      * Default value is `Hidden`.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     setHorizontalScrolling(
@@ -356,6 +370,7 @@ declare module "sap/zen/commons/layout/AbsoluteLayout" {
      *
      * Default value is `Hidden`.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     setVerticalScrolling(
@@ -373,6 +388,7 @@ declare module "sap/zen/commons/layout/AbsoluteLayout" {
      *
      * Default value is `'100%'`.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     setWidth(
@@ -382,7 +398,11 @@ declare module "sap/zen/commons/layout/AbsoluteLayout" {
       sWidth?: CSSSize
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the AbsoluteLayout constructor.
+   *
+   * @deprecated (since 1.38)
+   */
   export interface $AbsoluteLayoutSettings extends $ControlSettings {
     /**
      * The overall width of the control. When not set, 100% is automatically set.
@@ -478,6 +498,7 @@ declare module "sap/zen/commons/layout/MatrixLayout" {
      *
      * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
      *
+     *
      * @returns Created class / constructor function
      */
     static extend<T extends Record<string, unknown>>(
@@ -498,12 +519,14 @@ declare module "sap/zen/commons/layout/MatrixLayout" {
     /**
      * Returns a metadata object for class sap.zen.commons.layout.MatrixLayout.
      *
+     *
      * @returns Metadata object describing this class
      */
     static getMetadata(): ElementMetadata;
     /**
      * Adds some row to the aggregation {@link #getRows rows}.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     addRow(
@@ -519,6 +542,7 @@ declare module "sap/zen/commons/layout/MatrixLayout" {
      * content control, which is wrapped with a new (default) matrix layout cell first and then added to the
      * row.
      *
+     *
      * @returns `this` to allow method chaining
      */
     createRow(
@@ -530,6 +554,7 @@ declare module "sap/zen/commons/layout/MatrixLayout" {
     /**
      * Destroys all the rows in the aggregation {@link #getRows rows}.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     destroyRows(): this;
@@ -538,6 +563,7 @@ declare module "sap/zen/commons/layout/MatrixLayout" {
      *
      * Number of columns. If not specified, the number of columns will be determined from the given cells.
      *
+     *
      * @returns Value of property `columns`
      */
     getColumns(): int;
@@ -546,6 +572,7 @@ declare module "sap/zen/commons/layout/MatrixLayout" {
      *
      * CSS height of the matrix layout.
      *
+     *
      * @returns Value of property `height`
      */
     getHeight(): CSSSize;
@@ -559,6 +586,7 @@ declare module "sap/zen/commons/layout/MatrixLayout" {
      *
      * Default value is `true`.
      *
+     *
      * @returns Value of property `layoutFixed`
      */
     getLayoutFixed(): boolean;
@@ -573,6 +601,7 @@ declare module "sap/zen/commons/layout/MatrixLayout" {
      *
      * CSS width of the matrix layout. If the LayoutFixed = true a adequate width should be provided.
      *
+     *
      * @returns Value of property `width`
      */
     getWidth(): CSSSize;
@@ -582,6 +611,7 @@ declare module "sap/zen/commons/layout/MatrixLayout" {
      * Widths of the columns. Use an array to define the widths of the columns. If a column shall have an automatical
      * sizing enter "auto" for this column width.
      *
+     *
      * @returns Value of property `widths`
      */
     getWidths(): CSSSize[];
@@ -589,6 +619,7 @@ declare module "sap/zen/commons/layout/MatrixLayout" {
      * Checks for the provided `sap.zen.commons.layout.MatrixLayoutRow` in the aggregation {@link #getRows rows}.
      * and returns its index if found or -1 otherwise.
      *
+     *
      * @returns The index of the provided control in the aggregation if found, or -1 otherwise
      */
     indexOfRow(
@@ -600,6 +631,7 @@ declare module "sap/zen/commons/layout/MatrixLayout" {
     /**
      * Inserts a row into the aggregation {@link #getRows rows}.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     insertRow(
@@ -619,12 +651,14 @@ declare module "sap/zen/commons/layout/MatrixLayout" {
      *
      * Additionally, it unregisters them from the hosting UIArea.
      *
+     *
      * @returns An array of the removed elements (might be empty)
      */
     removeAllRows(): MatrixLayoutRow[];
     /**
      * Removes a row from the aggregation {@link #getRows rows}.
      *
+     *
      * @returns The removed row or `null`
      */
     removeRow(
@@ -640,6 +674,7 @@ declare module "sap/zen/commons/layout/MatrixLayout" {
      *
      * 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
      */
     setColumns(
@@ -655,6 +690,7 @@ declare module "sap/zen/commons/layout/MatrixLayout" {
      *
      * 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
      */
     setHeight(
@@ -675,6 +711,7 @@ declare module "sap/zen/commons/layout/MatrixLayout" {
      *
      * Default value is `true`.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     setLayoutFixed(
@@ -690,6 +727,7 @@ declare module "sap/zen/commons/layout/MatrixLayout" {
      *
      * 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
      */
     setWidth(
@@ -706,6 +744,7 @@ declare module "sap/zen/commons/layout/MatrixLayout" {
      *
      * 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
      */
     setWidths(
@@ -715,7 +754,11 @@ declare module "sap/zen/commons/layout/MatrixLayout" {
       sWidths?: CSSSize[]
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the MatrixLayout constructor.
+   *
+   * @deprecated (since 1.38) - Instead, use the `sap.ui.layout.Grid` control.
+   */
   export interface $MatrixLayoutSettings extends $ControlSettings {
     /**
      * CSS width of the matrix layout. If the LayoutFixed = true a adequate width should be provided.
@@ -761,9 +804,9 @@ declare module "sap/zen/commons/layout/MatrixLayoutCell" {
   import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
 
   /**
-   * @deprecated (since 1.38) - Instead, use the `sap.ui.layout.Grid` control.
-   *
    * Non-control element used as part of a matrix layout's inner structure.
+   *
+   * @deprecated (since 1.38) - Instead, use the `sap.ui.layout.Grid` control.
    */
   export default class MatrixLayoutCell extends UI5Element {
     /**
@@ -858,7 +901,11 @@ declare module "sap/zen/commons/layout/MatrixLayoutCell" {
       sStyleClass: string
     ): MatrixLayoutCell;
   }
-
+  /**
+   * Describes the settings that can be provided to the MatrixLayoutCell constructor.
+   *
+   * @deprecated (since 1.38) - Instead, use the `sap.ui.layout.Grid` control.
+   */
   export interface $MatrixLayoutCellSettings extends $ElementSettings {}
 }
 
@@ -877,9 +924,9 @@ declare module "sap/zen/commons/layout/MatrixLayoutRow" {
   } from "sap/ui/base/ManagedObject";
 
   /**
-   * @deprecated (since 1.89.0)
-   *
    * Non-control element used as part of a matrix layout's inner structure.
+   *
+   * @deprecated (since 1.89.0)
    */
   export default class MatrixLayoutRow extends UI5Element {
     /**
@@ -919,6 +966,7 @@ declare module "sap/zen/commons/layout/MatrixLayoutRow" {
      *
      * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
      *
+     *
      * @returns Created class / constructor function
      */
     static extend<T extends Record<string, unknown>>(
@@ -939,12 +987,14 @@ declare module "sap/zen/commons/layout/MatrixLayoutRow" {
     /**
      * Returns a metadata object for class sap.zen.commons.layout.MatrixLayoutRow.
      *
+     *
      * @returns Metadata object describing this class
      */
     static getMetadata(): ElementMetadata;
     /**
      * Adds some cell to the aggregation {@link #getCells cells}.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     addCell(
@@ -994,6 +1044,7 @@ declare module "sap/zen/commons/layout/MatrixLayoutRow" {
     /**
      * Destroys all the cells in the aggregation {@link #getCells cells}.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     destroyCells(): this;
@@ -1008,6 +1059,7 @@ declare module "sap/zen/commons/layout/MatrixLayoutRow" {
      *
      * Height of the row.
      *
+     *
      * @returns Value of property `height`
      */
     getHeight(): CSSSize;
@@ -1025,6 +1077,7 @@ declare module "sap/zen/commons/layout/MatrixLayoutRow" {
      * Checks for the provided `sap.zen.commons.layout.MatrixLayoutCell` in the aggregation {@link #getCells cells}.
      * and returns its index if found or -1 otherwise.
      *
+     *
      * @returns The index of the provided control in the aggregation if found, or -1 otherwise
      */
     indexOfCell(
@@ -1036,6 +1089,7 @@ declare module "sap/zen/commons/layout/MatrixLayoutRow" {
     /**
      * Inserts a cell into the aggregation {@link #getCells cells}.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     insertCell(
@@ -1055,12 +1109,14 @@ declare module "sap/zen/commons/layout/MatrixLayoutRow" {
      *
      * Additionally, it unregisters them from the hosting UIArea.
      *
+     *
      * @returns An array of the removed elements (might be empty)
      */
     removeAllCells(): MatrixLayoutCell[];
     /**
      * Removes a cell from the aggregation {@link #getCells cells}.
      *
+     *
      * @returns The removed cell or `null`
      */
     removeCell(
@@ -1088,6 +1144,7 @@ declare module "sap/zen/commons/layout/MatrixLayoutRow" {
      *
      * 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
      */
     setHeight(
@@ -1097,7 +1154,11 @@ declare module "sap/zen/commons/layout/MatrixLayoutRow" {
       sHeight?: CSSSize
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the MatrixLayoutRow constructor.
+   *
+   * @deprecated (since 1.89.0)
+   */
   export interface $MatrixLayoutRowSettings extends $ElementSettings {
     /**
      * Height of the row.
@@ -1127,9 +1188,9 @@ declare module "sap/zen/commons/layout/PositionContainer" {
   import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
 
   /**
-   * @deprecated (since 1.89)
-   *
    * Is used to specify the position of a control in the AbsoluteLayout
+   *
+   * @deprecated (since 1.89)
    */
   export default class PositionContainer extends UI5Element {
     /**
@@ -1169,6 +1230,7 @@ declare module "sap/zen/commons/layout/PositionContainer" {
      *
      * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
      *
+     *
      * @returns Created class / constructor function
      */
     static extend<T extends Record<string, unknown>>(
@@ -1189,12 +1251,14 @@ declare module "sap/zen/commons/layout/PositionContainer" {
     /**
      * Returns a metadata object for class sap.zen.commons.layout.PositionContainer.
      *
+     *
      * @returns Metadata object describing this class
      */
     static getMetadata(): ElementMetadata;
     /**
      * Destroys the control in the aggregation {@link #getControl control}.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     destroyControl(): this;
@@ -1203,6 +1267,7 @@ declare module "sap/zen/commons/layout/PositionContainer" {
      *
      * Defines the distance to the bottom of the layout (as specified in HTML)
      *
+     *
      * @returns Value of property `bottom`
      */
     getBottom(): CSSSize;
@@ -1214,6 +1279,7 @@ declare module "sap/zen/commons/layout/PositionContainer" {
      *
      * Default value is `false`.
      *
+     *
      * @returns Value of property `centerHorizontally`
      */
     getCenterHorizontally(): boolean;
@@ -1225,6 +1291,7 @@ declare module "sap/zen/commons/layout/PositionContainer" {
      *
      * Default value is `false`.
      *
+     *
      * @returns Value of property `centerVertically`
      */
     getCenterVertically(): boolean;
@@ -1239,6 +1306,7 @@ declare module "sap/zen/commons/layout/PositionContainer" {
      *
      * Defines the distance to the left of the layout (as specified in HTML)
      *
+     *
      * @returns Value of property `left`
      */
     getLeft(): CSSSize;
@@ -1247,6 +1315,7 @@ declare module "sap/zen/commons/layout/PositionContainer" {
      *
      * Defines the distance to the right of the layout (as specified in HTML)
      *
+     *
      * @returns Value of property `right`
      */
     getRight(): CSSSize;
@@ -1255,6 +1324,7 @@ declare module "sap/zen/commons/layout/PositionContainer" {
      *
      * Defines the distance to the top of the layout (as specified in HTML)
      *
+     *
      * @returns Value of property `top`
      */
     getTop(): CSSSize;
@@ -1265,6 +1335,7 @@ declare module "sap/zen/commons/layout/PositionContainer" {
      *
      * 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
      */
     setBottom(
@@ -1283,6 +1354,7 @@ declare module "sap/zen/commons/layout/PositionContainer" {
      *
      * Default value is `false`.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     setCenterHorizontally(
@@ -1301,6 +1373,7 @@ declare module "sap/zen/commons/layout/PositionContainer" {
      *
      * Default value is `false`.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     setCenterVertically(
@@ -1312,6 +1385,7 @@ declare module "sap/zen/commons/layout/PositionContainer" {
     /**
      * Sets the aggregated {@link #getControl control}.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     setControl(
@@ -1327,6 +1401,7 @@ declare module "sap/zen/commons/layout/PositionContainer" {
      *
      * 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
      */
     setLeft(
@@ -1342,6 +1417,7 @@ declare module "sap/zen/commons/layout/PositionContainer" {
      *
      * 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
      */
     setRight(
@@ -1357,6 +1433,7 @@ declare module "sap/zen/commons/layout/PositionContainer" {
      *
      * 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
      */
     setTop(
@@ -1377,7 +1454,11 @@ declare module "sap/zen/commons/layout/PositionContainer" {
       oPos: object
     ): void;
   }
-
+  /**
+   * Describes the settings that can be provided to the PositionContainer constructor.
+   *
+   * @deprecated (since 1.89)
+   */
   export interface $PositionContainerSettings extends $ElementSettings {
     /**
      * Defines the distance to the top of the layout (as specified in HTML)
@@ -1420,12 +1501,12 @@ declare module "sap/zen/commons/layout/PositionContainer" {
 
 declare module "sap/zen/commons/Padding" {
   /**
-   * @deprecated (since 1.89)
-   * @experimental
-   *
    * Padding, e.g. of a layout cell's content within the cell's borders. Note that all options except "None"
    * include a padding of 2px at the top and bottom, and differ only in the presence of a 4px padding towards
    * the beginning or end of a line, in the current locale's writing direction.
+   *
+   * @deprecated (since 1.89.0) - Please use the WD Grid control instead.
+   * @experimental
    */
   enum Padding {
     /**
@@ -1456,10 +1537,10 @@ declare module "sap/zen/commons/Padding" {
 
 declare module "sap/zen/commons/Separation" {
   /**
-   * @deprecated (since 1.89.0)
-   *
    * Separation, e.g. of a layout cell from its neighbor, via a vertical gutter of defined width, with or
    * without a vertical line in its middle.
+   *
+   * @deprecated (since 1.89.0) - Please use the WD Grid control instead.
    */
   enum Separation {
     /**
@@ -1496,9 +1577,9 @@ declare module "sap/zen/commons/Separation" {
 
 declare module "sap/zen/commons/VAlign" {
   /**
-   * @deprecated (since 1.89.0)
-   *
    * Vertical alignment, e.g. of a layout cell's content within the cell's borders.
+   *
+   * @deprecated (since 1.89.0) - Please use the WD Grid control instead.
    */
   enum VAlign {
     /**