@openui5/types 1.120.10 → 1.121.1

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.10
+// For Library Version: 1.121.1
 
 declare module "sap/ui/layout/library" {
   import Control from "sap/ui/core/Control";
@@ -8,6 +8,8 @@ declare module "sap/ui/layout/library" {
   /**
    * Available Background Design.
    *
+   * This enum is part of the 'sap/ui/layout/library' module export and must be accessed by the property 'BackgroundDesign'.
+   *
    * @since 1.36.0
    */
   export enum BackgroundDesign {
@@ -27,6 +29,8 @@ declare module "sap/ui/layout/library" {
   /**
    * A string type that is used inside the BlockLayout to set predefined background color to the cells inside
    * the control.
+   *
+   * This enum is part of the 'sap/ui/layout/library' module export and must be accessed by the property 'BlockBackgroundType'.
    */
   export enum BlockBackgroundType {
     /**
@@ -56,6 +60,8 @@ declare module "sap/ui/layout/library" {
   /**
    * A string type that is used inside the BlockLayoutCell to set a predefined set of colors for the cells.
    *
+   * This enum is part of the 'sap/ui/layout/library' module export and must be accessed by the property 'BlockLayoutCellColorSet'.
+   *
    * @since 1.48
    */
   export enum BlockLayoutCellColorSet {
@@ -109,6 +115,8 @@ declare module "sap/ui/layout/library" {
    * cells. The colors are defined with sap.ui.layout.BlockLayoutCellColorSet. And this is for the shades
    * only.
    *
+   * This enum is part of the 'sap/ui/layout/library' module export and must be accessed by the property 'BlockLayoutCellColorShade'.
+   *
    * @since 1.48
    */
   export enum BlockLayoutCellColorShade {
@@ -140,6 +148,8 @@ declare module "sap/ui/layout/library" {
   /**
    * A string type that is used inside the BlockLayoutRow to set predefined set of colors the cells inside
    * the control. Color sets depend on sap.ui.layout.BlockBackgroundType
+   *
+   * This enum is part of the 'sap/ui/layout/library' module export and must be accessed by the property 'BlockRowColorSets'.
    */
   export enum BlockRowColorSets {
     /**
@@ -189,6 +199,8 @@ declare module "sap/ui/layout/library" {
 
   /**
    * The position of the {@link sap.ui.layout.Grid}. Can be `Left` (default), `Center` or `Right`.
+   *
+   * This enum is part of the 'sap/ui/layout/library' module export and must be accessed by the property 'GridPosition'.
    */
   export enum GridPosition {
     /**
@@ -217,6 +229,8 @@ declare module "sap/ui/layout/library" {
   /**
    * Types of the DynamicSideContent FallDown options
    *
+   * This enum is part of the 'sap/ui/layout/library' module export and must be accessed by the property 'SideContentFallDown'.
+   *
    * @since 1.30
    */
   export enum SideContentFallDown {
@@ -239,6 +253,8 @@ declare module "sap/ui/layout/library" {
   }
   /**
    * The position of the side content - End (default) and Begin.
+   *
+   * This enum is part of the 'sap/ui/layout/library' module export and must be accessed by the property 'SideContentPosition'.
    */
   export enum SideContentPosition {
     /**
@@ -255,6 +271,8 @@ declare module "sap/ui/layout/library" {
   /**
    * Types of the DynamicSideContent Visibility options
    *
+   * This enum is part of the 'sap/ui/layout/library' module export and must be accessed by the property 'SideContentVisibility'.
+   *
    * @since 1.30
    */
   export enum SideContentVisibility {
@@ -321,6 +339,8 @@ declare module "sap/ui/layout/library" {
     /**
      * A string type that is used for CSS grid to control how the auto-placement algorithm works, specifying
      * exactly how auto-placed items get flowed into the grid.
+     *
+     * This enum is part of the 'sap/ui/layout/library' module export and must be accessed by the property 'cssgrid.CSSGridAutoFlow'.
      * See:
      * 	{@link https://developer.mozilla.org/en-US/docs/Web/CSS/grid-auto-flow}
      *
@@ -388,6 +408,8 @@ declare module "sap/ui/layout/library" {
     /**
      * Available `FormLayouts` used to render a `SimpleForm`.
      *
+     * This enum is part of the 'sap/ui/layout/library' module export and must be accessed by the property 'form.SimpleFormLayout'.
+     *
      * @since 1.16.0
      */
     enum SimpleFormLayout {
@@ -4319,6 +4341,15 @@ declare module "sap/ui/layout/cssgrid/ResponsiveColumnLayout" {
    *
    * Grid row's height is dynamically determined by the height of the highest grid element on this row.
    *
+   * The control provides the following breakpoints and layout sizes:
+   * 	 -  "S" - screen width: up to 599px.
+   * 	 -  "M" - screen width range: 600px - 1023px.
+   * 	 -  "ML" - screen width range: 1024px - 1279px.
+   * 	 -  "L" - screen width range: 1280px - 1439px.
+   * 	 -  "XL" - screen width range: 1440px - 1679px.
+   * 	 -  "XXL" - screen width range: 1680px - 1919px.
+   * 	 -  "XXXL" - screen width range: 1920px and bigger.
+   *
    * @since 1.72
    */
   export default class ResponsiveColumnLayout extends GridLayoutBase {
@@ -4507,6 +4538,8 @@ declare module "sap/ui/layout/DynamicSideContent" {
     SideContentVisibility,
   } from "sap/ui/layout/library";
 
+  import { CSSSize } from "sap/ui/core/library";
+
   import {
     PropertyBindingInfo,
     AggregationBindingInfo,
@@ -4567,10 +4600,10 @@ declare module "sap/ui/layout/DynamicSideContent" {
    * the same as in the standard view - the side content disappears on screen widths of less than 720 px and
    * can only be viewed by triggering it.
    *
-   * **Note:** If the control that has property sticky inside the `DynamicSideContent` the stickiness of that
-   * control will not work. `DynamicSideContent` has the overflow: auto style definition and this prevents
-   * the sticky elements of the control from becoming fixed at the top of the viewport. This applies for example
-   * to {@link sap.m.Table} and {@link sap.m.PlanningCalendar}.
+   * **Note:** If there is a control that has property `sticky` inside the `DynamicSideContent` the stickiness
+   * of that control will not work. `DynamicSideContent` has the overflow: auto style definition and this
+   * prevents the sticky elements of the inside controls from becoming fixed at the top of the viewport. This
+   * applies for example to {@link sap.m.Table} and {@link sap.m.PlanningCalendar}.
    *
    * @since 1.30
    */
@@ -4767,7 +4800,7 @@ declare module "sap/ui/layout/DynamicSideContent" {
     /**
      * Gets current value of property {@link #getContainerQuery containerQuery}.
      *
-     * If set to TRUE, then not the media Query (device screen size) but the size of the container, surrounding
+     * If set to `true`, then not the media Query (device screen size) but the size of the container, surrounding
      * the control, defines the current range.
      *
      * Default value is `false`.
@@ -4793,6 +4826,8 @@ declare module "sap/ui/layout/DynamicSideContent" {
      * 50:50 percent of the container on all screen sizes except for phone, where the main and side contents
      * are switching visibility using the toggle method.
      *
+     * **Note:** setting this property overrides values set in `sideContentWidthM, sideContentWidthL, sideContentWidthXL`.
+     *
      * Default value is `false`.
      *
      *
@@ -4889,6 +4924,45 @@ declare module "sap/ui/layout/DynamicSideContent" {
     getSideContentVisibility():
       | SideContentVisibility
       | keyof typeof SideContentVisibility;
+    /**
+     * Gets current value of property {@link #getSideContentWidthL sideContentWidthL}.
+     *
+     * Sets the width of the side content for L breakpoint (screen width <= 1440 px and > 1024px).
+     *
+     * Setting value to this property overrides the default width of the side content container in L breakpoint,
+     * except when an `equalSplit` property is set. The width of the main content container is calculated respectively.
+     *
+     * @since 1.121
+     *
+     * @returns Value of property `sideContentWidthL`
+     */
+    getSideContentWidthL(): CSSSize;
+    /**
+     * Gets current value of property {@link #getSideContentWidthM sideContentWidthM}.
+     *
+     * Sets the width of the side content for M breakpoint (screen width <= 1024 px and > 720px).
+     *
+     * Setting value to this property overrides the default width of the side content container in M breakpoint,
+     * except when an `equalSplit` property is set. The width of the main content container is calculated respectively.
+     *
+     * @since 1.121
+     *
+     * @returns Value of property `sideContentWidthM`
+     */
+    getSideContentWidthM(): CSSSize;
+    /**
+     * Gets current value of property {@link #getSideContentWidthXL sideContentWidthXL}.
+     *
+     * Sets the width of the side content for XL breakpoint (screen width > 1440 px).
+     *
+     * Setting value to this property overrides the default width of the side content container in XL breakpoint,
+     * except when an `equalSplit` property is set. The width of the main content container is calculated respectively.
+     *
+     * @since 1.121
+     *
+     * @returns Value of property `sideContentWidthXL`
+     */
+    getSideContentWidthXL(): CSSSize;
     /**
      * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getMainContent mainContent}.
      * and returns its index if found or -1 otherwise.
@@ -5010,7 +5084,7 @@ declare module "sap/ui/layout/DynamicSideContent" {
     /**
      * Sets a new value for property {@link #getContainerQuery containerQuery}.
      *
-     * If set to TRUE, then not the media Query (device screen size) but the size of the container, surrounding
+     * If set to `true`, then not the media Query (device screen size) but the size of the container, surrounding
      * the control, defines the current range.
      *
      * When called with a value of `null` or `undefined`, the default value of the property will be restored.
@@ -5127,6 +5201,66 @@ declare module "sap/ui/layout/DynamicSideContent" {
        */
       bSuppressVisualUpdate: boolean
     ): this;
+    /**
+     * Sets a new value for property {@link #getSideContentWidthL sideContentWidthL}.
+     *
+     * Sets the width of the side content for L breakpoint (screen width <= 1440 px and > 1024px).
+     *
+     * Setting value to this property overrides the default width of the side content container in L breakpoint,
+     * except when an `equalSplit` property is set. The width of the main content container is calculated respectively.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     *
+     * @since 1.121
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    setSideContentWidthL(
+      /**
+       * New value for property `sideContentWidthL`
+       */
+      sSideContentWidthL?: CSSSize
+    ): this;
+    /**
+     * Sets a new value for property {@link #getSideContentWidthM sideContentWidthM}.
+     *
+     * Sets the width of the side content for M breakpoint (screen width <= 1024 px and > 720px).
+     *
+     * Setting value to this property overrides the default width of the side content container in M breakpoint,
+     * except when an `equalSplit` property is set. The width of the main content container is calculated respectively.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     *
+     * @since 1.121
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    setSideContentWidthM(
+      /**
+       * New value for property `sideContentWidthM`
+       */
+      sSideContentWidthM?: CSSSize
+    ): this;
+    /**
+     * Sets a new value for property {@link #getSideContentWidthXL sideContentWidthXL}.
+     *
+     * Sets the width of the side content for XL breakpoint (screen width > 1440 px).
+     *
+     * Setting value to this property overrides the default width of the side content container in XL breakpoint,
+     * except when an `equalSplit` property is set. The width of the main content container is calculated respectively.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     *
+     * @since 1.121
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    setSideContentWidthXL(
+      /**
+       * New value for property `sideContentWidthXL`
+       */
+      sSideContentWidthXL?: CSSSize
+    ): this;
     /**
      * Used for the toggle button functionality. When the control is on a phone screen size only, one control
      * area is visible. This helper method is used to implement a button/switch for changing between the main
@@ -5168,15 +5302,47 @@ declare module "sap/ui/layout/DynamicSideContent" {
       | PropertyBindingInfo
       | `{${string}}`;
 
+    /**
+     * Sets the width of the side content for M breakpoint (screen width <= 1024 px and > 720px).
+     *
+     * Setting value to this property overrides the default width of the side content container in M breakpoint,
+     * except when an `equalSplit` property is set. The width of the main content container is calculated respectively.
+     *
+     * @since 1.121
+     */
+    sideContentWidthM?: CSSSize | PropertyBindingInfo | `{${string}}`;
+
+    /**
+     * Sets the width of the side content for L breakpoint (screen width <= 1440 px and > 1024px).
+     *
+     * Setting value to this property overrides the default width of the side content container in L breakpoint,
+     * except when an `equalSplit` property is set. The width of the main content container is calculated respectively.
+     *
+     * @since 1.121
+     */
+    sideContentWidthL?: CSSSize | PropertyBindingInfo | `{${string}}`;
+
+    /**
+     * Sets the width of the side content for XL breakpoint (screen width > 1440 px).
+     *
+     * Setting value to this property overrides the default width of the side content container in XL breakpoint,
+     * except when an `equalSplit` property is set. The width of the main content container is calculated respectively.
+     *
+     * @since 1.121
+     */
+    sideContentWidthXL?: CSSSize | PropertyBindingInfo | `{${string}}`;
+
     /**
      * Defines whether the control is in equal split mode. In this mode, the side and the main content take
      * 50:50 percent of the container on all screen sizes except for phone, where the main and side contents
      * are switching visibility using the toggle method.
+     *
+     * **Note:** setting this property overrides values set in `sideContentWidthM, sideContentWidthL, sideContentWidthXL`.
      */
     equalSplit?: boolean | PropertyBindingInfo | `{${string}}`;
 
     /**
-     * If set to TRUE, then not the media Query (device screen size) but the size of the container, surrounding
+     * If set to `true`, then not the media Query (device screen size) but the size of the container, surrounding
      * the control, defines the current range.
      */
     containerQuery?: boolean | PropertyBindingInfo | `{${string}}`;
@@ -9445,7 +9611,7 @@ declare module "sap/ui/layout/form/SimpleForm" {
     /**
      * Gets current value of property {@link #getBreakpointL breakpointL}.
      *
-     * Breakpoint between Medium size and Large size.
+     * Breakpoint between medium size and large size.
      *
      * **Note:** This property is only used if a `ResponsiveGridLayout` is used as a layout.
      *
@@ -9459,7 +9625,7 @@ declare module "sap/ui/layout/form/SimpleForm" {
     /**
      * Gets current value of property {@link #getBreakpointM breakpointM}.
      *
-     * Breakpoint between Small size and Medium size.
+     * Breakpoint between small size and medium size.
      *
      * **Note:** This property is only used if a `ResponsiveGridLayout` is used as a layout.
      *
@@ -9473,7 +9639,7 @@ declare module "sap/ui/layout/form/SimpleForm" {
     /**
      * Gets current value of property {@link #getBreakpointXL breakpointXL}.
      *
-     * Breakpoint between Medium size and Large size.
+     * Breakpoint between large size and extra large size.
      *
      * **Note:** This property is only used if a `ResponsiveGridLayout` is used as a layout.
      *
@@ -9595,6 +9761,8 @@ declare module "sap/ui/layout/form/SimpleForm" {
      * might be misaligned, the labels might be rendered in the wrong mode, and the spacing between the single
      * controls might be wrong. Also, controls that do not fit the mode might be rendered incorrectly.
      *
+     * Default value is `false`.
+     *
      *
      * @returns Value of property `editable`
      */
@@ -9964,7 +10132,7 @@ declare module "sap/ui/layout/form/SimpleForm" {
     /**
      * Sets a new value for property {@link #getBreakpointL breakpointL}.
      *
-     * Breakpoint between Medium size and Large size.
+     * Breakpoint between medium size and large size.
      *
      * **Note:** This property is only used if a `ResponsiveGridLayout` is used as a layout.
      *
@@ -9985,7 +10153,7 @@ declare module "sap/ui/layout/form/SimpleForm" {
     /**
      * Sets a new value for property {@link #getBreakpointM breakpointM}.
      *
-     * Breakpoint between Small size and Medium size.
+     * Breakpoint between small size and medium size.
      *
      * **Note:** This property is only used if a `ResponsiveGridLayout` is used as a layout.
      *
@@ -10006,7 +10174,7 @@ declare module "sap/ui/layout/form/SimpleForm" {
     /**
      * Sets a new value for property {@link #getBreakpointXL breakpointXL}.
      *
-     * Breakpoint between Medium size and Large size.
+     * Breakpoint between large size and extra large size.
      *
      * **Note:** This property is only used if a `ResponsiveGridLayout` is used as a layout.
      *
@@ -10109,6 +10277,8 @@ declare module "sap/ui/layout/form/SimpleForm" {
      *
      * When called with a value of `null` or `undefined`, the default value of the property will be restored.
      *
+     * Default value is `false`.
+     *
      *
      * @returns Reference to `this` in order to allow method chaining
      */
@@ -10684,7 +10854,7 @@ declare module "sap/ui/layout/form/SimpleForm" {
     singleContainerFullSize?: boolean | PropertyBindingInfo | `{${string}}`;
 
     /**
-     * Breakpoint between Medium size and Large size.
+     * Breakpoint between large size and extra large size.
      *
      * **Note:** This property is only used if a `ResponsiveGridLayout` is used as a layout.
      *
@@ -10693,7 +10863,7 @@ declare module "sap/ui/layout/form/SimpleForm" {
     breakpointXL?: int | PropertyBindingInfo | `{${string}}`;
 
     /**
-     * Breakpoint between Medium size and Large size.
+     * Breakpoint between medium size and large size.
      *
      * **Note:** This property is only used if a `ResponsiveGridLayout` is used as a layout.
      *
@@ -10702,7 +10872,7 @@ declare module "sap/ui/layout/form/SimpleForm" {
     breakpointL?: int | PropertyBindingInfo | `{${string}}`;
 
     /**
-     * Breakpoint between Small size and Medium size.
+     * Breakpoint between small size and medium size.
      *
      * **Note:** This property is only used if a `ResponsiveGridLayout` is used as a layout.
      *
@@ -12714,7 +12884,6 @@ declare module "sap/ui/layout/PaneContainer" {
   import { Orientation } from "sap/ui/core/library";
 
   import {
-    default as ManagedObject,
     PropertyBindingInfo,
     AggregationBindingInfo,
   } from "sap/ui/base/ManagedObject";
@@ -12926,13 +13095,23 @@ declare module "sap/ui/layout/PaneContainer" {
       oPane: UI5Element
     ): int;
     /**
-     * Pane insertion
+     * Inserts a pane into the aggregation {@link #getPanes panes}.
+     *
+     *
+     * @returns Reference to `this` in order to allow method chaining
      */
     insertPane(
-      oObject: undefined,
-
-      iIndex: undefined
-    ): ManagedObject;
+      /**
+       * The pane to insert; if empty, nothing is inserted
+       */
+      oPane: UI5Element,
+      /**
+       * The `0`-based index the pane should be inserted at; for a negative value of `iIndex`, the pane is inserted
+       * at position 0; for a value greater than the current size of the aggregation, the pane is inserted at
+       * the last position
+       */
+      iIndex: int
+    ): this;
     /**
      * Removes all the controls from the aggregation {@link #getPanes panes}.
      *
@@ -12943,9 +13122,17 @@ declare module "sap/ui/layout/PaneContainer" {
      */
     removeAllPanes(): UI5Element[];
     /**
-     * Pane removal
+     * Removes a pane from the aggregation {@link #getPanes panes}.
+     *
+     *
+     * @returns The removed pane or `null`
      */
-    removePane(oObject: undefined): ManagedObject;
+    removePane(
+      /**
+       * The pane to remove or its index or id
+       */
+      vPane: int | string | UI5Element
+    ): UI5Element | null;
     /**
      * Setter for property layoutData.
      *
@@ -13211,7 +13398,7 @@ declare module "sap/ui/layout/ResponsiveFlowLayout" {
       /**
        * The content that should be removed from the layout
        */
-      oContent: int | string | Control
+      oContent: int | ID | Control
     ): void;
     /**
      * Sets a new value for property {@link #getResponsive responsive}.
@@ -13642,7 +13829,7 @@ declare module "sap/ui/layout/ResponsiveSplitter" {
      * ID of the element which is the current target of the association {@link #getDefaultPane defaultPane},
      * or `null`.
      */
-    getDefaultPane(): ID;
+    getDefaultPane(): ID | null;
     /**
      * Gets current value of property {@link #getHeight height}.
      *