@openui5/types 1.120.11 → 1.120.13

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.11
+// For Library Version: 1.120.13
 
 declare module "sap/ui/layout/library" {
   import Control from "sap/ui/core/Control";
@@ -739,7 +739,9 @@ declare module "sap/ui/layout/BlockLayout" {
       bKeepFontSize?: boolean
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the BlockLayout constructor.
+   */
   export interface $BlockLayoutSettings extends $ControlSettings {
     /**
      * Determines the background used for the Layout
@@ -1148,7 +1150,9 @@ declare module "sap/ui/layout/BlockLayoutCell" {
       iWidth: number
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the BlockLayoutCell constructor.
+   */
   export interface $BlockLayoutCellSettings extends $ControlSettings {
     /**
      * Defines the title of the cell. **Note:** When the `titleLink` aggregation is provided, the title of the
@@ -1423,7 +1427,9 @@ declare module "sap/ui/layout/BlockLayoutCellData" {
       iXlSize?: int
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the BlockLayoutCellData constructor.
+   */
   export interface $BlockLayoutCellDataSettings extends $LayoutDataSettings {
     /**
      * Sets the width of the cell for S size of the BlockLayout.
@@ -1700,7 +1706,9 @@ declare module "sap/ui/layout/BlockLayoutRow" {
       bScrollable?: boolean
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the BlockLayoutRow constructor.
+   */
   export interface $BlockLayoutRowSettings extends $ControlSettings {
     /**
      * Sets the rendering mode of the BlockLayoutRow to scrollable. In scrollable mode, the cells get aligned
@@ -2285,7 +2293,9 @@ declare module "sap/ui/layout/cssgrid/CSSGrid" {
       sWidth?: CSSSize
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the CSSGrid constructor.
+   */
   export interface $CSSGridSettings extends $ControlSettings {
     /**
      * The width of the control
@@ -2677,7 +2687,9 @@ declare module "sap/ui/layout/cssgrid/GridBasicLayout" {
       sGridTemplateRows?: cssgrid.CSSGridTrack
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the GridBasicLayout constructor.
+   */
   export interface $GridBasicLayoutSettings extends $GridLayoutBaseSettings {
     /**
      * Sets the value for the CSS display:grid property {@link https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-columns MDN web docs: grid-template-columns}
@@ -2920,7 +2932,9 @@ declare module "sap/ui/layout/cssgrid/GridBoxLayout" {
       sBoxWidth?: CSSSize
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the GridBoxLayout constructor.
+   */
   export interface $GridBoxLayoutSettings extends $GridLayoutBaseSettings {
     /**
      * Defines the minimum width of the Boxes
@@ -3197,7 +3211,9 @@ declare module "sap/ui/layout/cssgrid/GridItemLayoutData" {
       sGridRowStart?: cssgrid.CSSGridLine
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the GridItemLayoutData constructor.
+   */
   export interface $GridItemLayoutDataSettings extends $LayoutDataSettings {
     /**
      * Sets the value for the CSS display:grid item property grid-column-start {@link https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column-start MDN web docs: grid-column-start}
@@ -3382,7 +3398,9 @@ declare module "sap/ui/layout/cssgrid/GridLayoutBase" {
       oEvent: jQuery.Event
     ): void;
   }
-
+  /**
+   * Describes the settings that can be provided to the GridLayoutBase constructor.
+   */
   export interface $GridLayoutBaseSettings extends $ManagedObjectSettings {}
 }
 
@@ -3718,7 +3736,9 @@ declare module "sap/ui/layout/cssgrid/GridResponsiveLayout" {
       oLayoutXL: GridSettings
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the GridResponsiveLayout constructor.
+   */
   export interface $GridResponsiveLayoutSettings
     extends $GridLayoutBaseSettings {
     /**
@@ -3758,6 +3778,9 @@ declare module "sap/ui/layout/cssgrid/GridResponsiveLayout" {
     layoutChange?: (oEvent: GridResponsiveLayout$LayoutChangeEvent) => void;
   }
 
+  /**
+   * Parameters of the GridResponsiveLayout#layoutChange event.
+   */
   export interface GridResponsiveLayout$LayoutChangeEventParameters {
     /**
      * The name of the newly active layout aggregation
@@ -3765,6 +3788,9 @@ declare module "sap/ui/layout/cssgrid/GridResponsiveLayout" {
     layout?: string;
   }
 
+  /**
+   * Event object of the GridResponsiveLayout#layoutChange event.
+   */
   export type GridResponsiveLayout$LayoutChangeEvent = Event<
     GridResponsiveLayout$LayoutChangeEventParameters,
     GridResponsiveLayout
@@ -4089,7 +4115,9 @@ declare module "sap/ui/layout/cssgrid/GridSettings" {
       sGridTemplateRows?: cssgrid.CSSGridTrack
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the GridSettings constructor.
+   */
   export interface $GridSettingsSettings extends $ManagedObjectSettings {
     /**
      * Sets the value for the CSS display:grid property {@link https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-columns MDN web docs: grid-template-columns}
@@ -4287,7 +4315,9 @@ declare module "sap/ui/layout/cssgrid/ResponsiveColumnItemLayoutData" {
       iRows?: int
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the ResponsiveColumnItemLayoutData constructor.
+   */
   export interface $ResponsiveColumnItemLayoutDataSettings
     extends $LayoutDataSettings {
     /**
@@ -4472,7 +4502,9 @@ declare module "sap/ui/layout/cssgrid/ResponsiveColumnLayout" {
      */
     isResponsive(): boolean;
   }
-
+  /**
+   * Describes the settings that can be provided to the ResponsiveColumnLayout constructor.
+   */
   export interface $ResponsiveColumnLayoutSettings
     extends $GridLayoutBaseSettings {
     /**
@@ -4481,6 +4513,9 @@ declare module "sap/ui/layout/cssgrid/ResponsiveColumnLayout" {
     layoutChange?: (oEvent: ResponsiveColumnLayout$LayoutChangeEvent) => void;
   }
 
+  /**
+   * Parameters of the ResponsiveColumnLayout#layoutChange event.
+   */
   export interface ResponsiveColumnLayout$LayoutChangeEventParameters {
     /**
      * The name of the newly active layout - "S", "M", "ML", "L", "XL", "XXL" or "XXXL".
@@ -4488,6 +4523,9 @@ declare module "sap/ui/layout/cssgrid/ResponsiveColumnLayout" {
     layout?: string;
   }
 
+  /**
+   * Event object of the ResponsiveColumnLayout#layoutChange event.
+   */
   export type ResponsiveColumnLayout$LayoutChangeEvent = Event<
     ResponsiveColumnLayout$LayoutChangeEventParameters,
     ResponsiveColumnLayout
@@ -5137,7 +5175,9 @@ declare module "sap/ui/layout/DynamicSideContent" {
      */
     toggle(): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the DynamicSideContent constructor.
+   */
   export interface $DynamicSideContentSettings extends $ControlSettings {
     /**
      * Determines whether the side content is visible or hidden.
@@ -5211,10 +5251,16 @@ declare module "sap/ui/layout/DynamicSideContent" {
     ) => void;
   }
 
+  /**
+   * Parameters of the DynamicSideContent#breakpointChanged event.
+   */
   export interface DynamicSideContent$BreakpointChangedEventParameters {
     currentBreakpoint?: string;
   }
 
+  /**
+   * Event object of the DynamicSideContent#breakpointChanged event.
+   */
   export type DynamicSideContent$BreakpointChangedEvent = Event<
     DynamicSideContent$BreakpointChangedEventParameters,
     DynamicSideContent
@@ -5554,7 +5600,9 @@ declare module "sap/ui/layout/FixFlex" {
       bVertical?: boolean
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the FixFlex constructor.
+   */
   export interface $FixFlexSettings extends $ControlSettings {
     /**
      * Determines the direction of the layout of child elements. True for vertical and false for horizontal
@@ -5776,7 +5824,9 @@ declare module "sap/ui/layout/form/ColumnContainerData" {
       sColumnsXL?: form.ColumnsXL
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the ColumnContainerData constructor.
+   */
   export interface $ColumnContainerDataSettings extends $LayoutDataSettings {
     /**
      * Number of columns the `FormContainer` element uses if the `Form` control has extra-large size.
@@ -5953,7 +6003,9 @@ declare module "sap/ui/layout/form/ColumnElementData" {
       sCellsSmall?: form.ColumnCells
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the ColumnElementData constructor.
+   */
   export interface $ColumnElementDataSettings extends $LayoutDataSettings {
     /**
      * Number of cells used by a field if the `FormElement` element is large. The label is then beside the fields
@@ -6248,7 +6300,9 @@ declare module "sap/ui/layout/form/ColumnLayout" {
       sLabelCellsLarge?: form.ColumnCells
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the ColumnLayout constructor.
+   */
   export interface $ColumnLayoutSettings extends $FormLayoutSettings {
     /**
      * Number of columns for extra-large size.
@@ -6675,7 +6729,9 @@ declare module "sap/ui/layout/form/Form" {
       sWidth?: CSSSize
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the Form constructor.
+   */
   export interface $FormSettings extends $ControlSettings {
     /**
      * Width of the `Form`.
@@ -7140,7 +7196,9 @@ declare module "sap/ui/layout/form/FormContainer" {
       bVisible?: boolean
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the FormContainer constructor.
+   */
   export interface $FormContainerSettings extends $ElementSettings {
     /**
      * Container is expanded.
@@ -7452,7 +7510,9 @@ declare module "sap/ui/layout/form/FormElement" {
       bVisible?: boolean
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the FormElement constructor.
+   */
   export interface $FormElementSettings extends $ElementSettings {
     /**
      * If set to `false`, the `FormElement` is not rendered.
@@ -7645,7 +7705,9 @@ declare module "sap/ui/layout/form/FormLayout" {
       sBackgroundDesign?: BackgroundDesign | keyof typeof BackgroundDesign
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the FormLayout constructor.
+   */
   export interface $FormLayoutSettings extends $ControlSettings {
     /**
      * Specifies the background color of the `Form` content.
@@ -7775,7 +7837,12 @@ declare module "sap/ui/layout/form/GridContainerData" {
       bHalfGrid?: boolean
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the GridContainerData constructor.
+   *
+   * @deprecated (since 1.67.0) - as `sap.ui.commons` library is deprecated and the `GridLayout` must not
+   * be used in responsive applications. Please use `ResponsiveGridLayout` or `ColumnLayout` instead.
+   */
   export interface $GridContainerDataSettings extends $LayoutDataSettings {
     /**
      * If set, the container takes half the width of the `Form` (8 cells), if not it takes the full width (16
@@ -7947,7 +8014,12 @@ declare module "sap/ui/layout/form/GridElementData" {
       iVCells?: int
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the GridElementData constructor.
+   *
+   * @deprecated (since 1.67.0) - as `sap.ui.commons` library is deprecated and the `GridLayout` must not
+   * be used in responsive applications. Please use `ResponsiveGridLayout` or `ColumnLayout` instead.
+   */
   export interface $GridElementDataSettings extends $LayoutDataSettings {
     /**
      * Number of cells in horizontal direction.
@@ -8100,7 +8172,12 @@ declare module "sap/ui/layout/form/GridLayout" {
       bSingleColumn?: boolean
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the GridLayout constructor.
+   *
+   * @deprecated (since 1.67.0) - as `sap.ui.commons` library is deprecated and the `GridLayout` must not
+   * be used in responsive applications. Please use `ResponsiveGridLayout` or `ColumnLayout` instead.
+   */
   export interface $GridLayoutSettings extends $FormLayoutSettings {
     /**
      * If set, the grid renders only one `FormContainer` per column. That means one `FormContainer` is below
@@ -8773,7 +8850,9 @@ declare module "sap/ui/layout/form/ResponsiveGridLayout" {
       bSingleContainerFullSize?: boolean
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the ResponsiveGridLayout constructor.
+   */
   export interface $ResponsiveGridLayoutSettings extends $FormLayoutSettings {
     /**
      * Default span for labels in extra large size.
@@ -9023,7 +9102,11 @@ declare module "sap/ui/layout/form/ResponsiveLayout" {
      */
     static getMetadata(): ElementMetadata;
   }
-
+  /**
+   * Describes the settings that can be provided to the ResponsiveLayout constructor.
+   *
+   * @deprecated (since 1.93) - replaced by {@link sap.ui.layout.form.ColumnLayout ColumnLayout}
+   */
   export interface $ResponsiveLayoutSettings extends $FormLayoutSettings {}
 }
 
@@ -9232,7 +9315,11 @@ declare module "sap/ui/layout/form/SemanticFormElement" {
       sDelimiter?: string
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the SemanticFormElement constructor.
+   *
+   * @experimental (since 1.86)
+   */
   export interface $SemanticFormElementSettings extends $FormElementSettings {
     /**
      * Delimiter symbol to separate the fields.
@@ -10464,7 +10551,9 @@ declare module "sap/ui/layout/form/SimpleForm" {
       sWidth?: CSSSize
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the SimpleForm constructor.
+   */
   export interface $SimpleFormSettings extends $ControlSettings {
     /**
      * The maximum amount of groups (`{@link sap.ui.layout.form.FormContainer FormContainers}`) per row that
@@ -11259,7 +11348,9 @@ declare module "sap/ui/layout/Grid" {
       sWidth?: CSSSize
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the Grid constructor.
+   */
   export interface $GridSettings extends $ControlSettings {
     /**
      * Optional. Defines the width of the `Grid`. If not specified, then 100%.
@@ -12290,7 +12381,9 @@ declare module "sap/ui/layout/GridData" {
       bVisibleXL?: boolean
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the GridData constructor.
+   */
   export interface $GridDataSettings extends $LayoutDataSettings {
     /**
      * A string type that represents the span values of the `Grid` for large, medium and small screens.
@@ -12689,7 +12782,9 @@ declare module "sap/ui/layout/HorizontalLayout" {
       bAllowWrapping?: boolean
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the HorizontalLayout constructor.
+   */
   export interface $HorizontalLayoutSettings extends $ControlSettings {
     /**
      * Specifies whether the content inside the Layout shall be line-wrapped in the case that there is less
@@ -12971,7 +13066,9 @@ declare module "sap/ui/layout/PaneContainer" {
       sOrientation: Orientation | keyof typeof Orientation
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the PaneContainer constructor.
+   */
   export interface $PaneContainerSettings extends $ElementSettings {
     /**
      * The orientation of the Splitter
@@ -12992,6 +13089,9 @@ declare module "sap/ui/layout/PaneContainer" {
     resize?: (oEvent: PaneContainer$ResizeEvent) => void;
   }
 
+  /**
+   * Parameters of the PaneContainer#resize event.
+   */
   export interface PaneContainer$ResizeEventParameters {
     /**
      * An array of values representing the old (pixel)sizes of the split panes, which are inside the pane container.
@@ -13004,6 +13104,9 @@ declare module "sap/ui/layout/PaneContainer" {
     newSizes?: float[];
   }
 
+  /**
+   * Event object of the PaneContainer#resize event.
+   */
   export type PaneContainer$ResizeEvent = Event<
     PaneContainer$ResizeEventParameters,
     PaneContainer
@@ -13233,7 +13336,9 @@ declare module "sap/ui/layout/ResponsiveFlowLayout" {
       bResponsive?: boolean
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the ResponsiveFlowLayout constructor.
+   */
   export interface $ResponsiveFlowLayoutSettings extends $ControlSettings {
     /**
      * If set to false, all added controls will keep their width, or otherwise, the controls will be stretched
@@ -13490,7 +13595,9 @@ declare module "sap/ui/layout/ResponsiveFlowLayoutData" {
       iWeight?: int
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the ResponsiveFlowLayoutData constructor.
+   */
   export interface $ResponsiveFlowLayoutDataSettings
     extends $LayoutDataSettings {
     /**
@@ -13733,7 +13840,9 @@ declare module "sap/ui/layout/ResponsiveSplitter" {
       sWidth?: CSSSize
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the ResponsiveSplitter constructor.
+   */
   export interface $ResponsiveSplitterSettings extends $ControlSettings {
     /**
      * The width of the control
@@ -13932,7 +14041,9 @@ declare module "sap/ui/layout/SplitPane" {
       iRequiredParentWidth?: int
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the SplitPane constructor.
+   */
   export interface $SplitPaneSettings extends $ElementSettings {
     /**
      * Determines whether the pane will be moved to the pagination
@@ -14395,7 +14506,9 @@ declare module "sap/ui/layout/Splitter" {
       forceDirectly?: boolean
     ): void;
   }
-
+  /**
+   * Describes the settings that can be provided to the Splitter constructor.
+   */
   export interface $SplitterSettings extends $ControlSettings {
     /**
      * Whether to split the contents horizontally (default) or vertically.
@@ -14426,6 +14539,9 @@ declare module "sap/ui/layout/Splitter" {
     resize?: (oEvent: Splitter$ResizeEvent) => void;
   }
 
+  /**
+   * Parameters of the Splitter#resize event.
+   */
   export interface Splitter$ResizeEventParameters {
     /**
      * The ID of the splitter control. The splitter control can also be accessed by calling getSource() on the
@@ -14444,6 +14560,9 @@ declare module "sap/ui/layout/Splitter" {
     newSizes?: int[];
   }
 
+  /**
+   * Event object of the Splitter#resize event.
+   */
   export type Splitter$ResizeEvent = Event<
     Splitter$ResizeEventParameters,
     Splitter
@@ -14620,7 +14739,11 @@ declare module "sap/ui/layout/SplitterLayoutData" {
       sSize?: CSSSize
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the SplitterLayoutData constructor.
+   *
+   * @experimental (since 1.22.0) - API is not yet finished and might change completely
+   */
   export interface $SplitterLayoutDataSettings extends $LayoutDataSettings {
     /**
      * Determines whether the control in the splitter can be resized or not.
@@ -14862,7 +14985,9 @@ declare module "sap/ui/layout/VerticalLayout" {
       sWidth?: CSSSize
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the VerticalLayout constructor.
+   */
   export interface $VerticalLayoutSettings extends $ControlSettings {
     /**
      * Width of the `VerticalLayout`. If no width is set, the width of the content is used. If the content of