@openui5/types 1.115.1 → 1.117.0

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.115.1
+// For Library Version: 1.117.0
 
 declare module "sap/ui/layout/library" {
   import Control from "sap/ui/core/Control";
@@ -3621,9 +3621,7 @@ declare module "sap/ui/layout/cssgrid/GridResponsiveLayout" {
     /**
      * Fired when the currently active GridSettings changes
      */
-    layoutChange?: (
-      oEvent: Event<GridResponsiveLayout$LayoutChangeEventParameters>
-    ) => void;
+    layoutChange?: (oEvent: GridResponsiveLayout$LayoutChangeEvent) => void;
   }
 
   export interface GridResponsiveLayout$LayoutChangeEventParameters {
@@ -3633,13 +3631,10 @@ declare module "sap/ui/layout/cssgrid/GridResponsiveLayout" {
     layout?: string;
   }
 
-  /**
-   * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'GridResponsiveLayout$LayoutChangeEventParameters'
-   * in 1.115.1 and any later releases.
-   */
-  export type $GridResponsiveLayoutLayoutChangeEventParameters = GridResponsiveLayout$LayoutChangeEventParameters;
-
-  export type GridResponsiveLayout$LayoutChangeEvent = Event<GridResponsiveLayout$LayoutChangeEventParameters>;
+  export type GridResponsiveLayout$LayoutChangeEvent = Event<
+    GridResponsiveLayout$LayoutChangeEventParameters,
+    GridResponsiveLayout
+  >;
 }
 
 declare module "sap/ui/layout/cssgrid/GridSettings" {
@@ -4319,9 +4314,7 @@ declare module "sap/ui/layout/cssgrid/ResponsiveColumnLayout" {
     /**
      * Fired when the currently active layout changes
      */
-    layoutChange?: (
-      oEvent: Event<ResponsiveColumnLayout$LayoutChangeEventParameters>
-    ) => void;
+    layoutChange?: (oEvent: ResponsiveColumnLayout$LayoutChangeEvent) => void;
   }
 
   export interface ResponsiveColumnLayout$LayoutChangeEventParameters {
@@ -4331,13 +4324,10 @@ declare module "sap/ui/layout/cssgrid/ResponsiveColumnLayout" {
     layout?: string;
   }
 
-  /**
-   * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'ResponsiveColumnLayout$LayoutChangeEventParameters'
-   * in 1.115.1 and any later releases.
-   */
-  export type $ResponsiveColumnLayoutLayoutChangeEventParameters = ResponsiveColumnLayout$LayoutChangeEventParameters;
-
-  export type ResponsiveColumnLayout$LayoutChangeEvent = Event<ResponsiveColumnLayout$LayoutChangeEventParameters>;
+  export type ResponsiveColumnLayout$LayoutChangeEvent = Event<
+    ResponsiveColumnLayout$LayoutChangeEventParameters,
+    ResponsiveColumnLayout
+  >;
 }
 
 declare module "sap/ui/layout/DynamicSideContent" {
@@ -5023,7 +5013,7 @@ declare module "sap/ui/layout/DynamicSideContent" {
      * Fires when the current breakpoint has been changed.
      */
     breakpointChanged?: (
-      oEvent: Event<DynamicSideContent$BreakpointChangedEventParameters>
+      oEvent: DynamicSideContent$BreakpointChangedEvent
     ) => void;
   }
 
@@ -5031,13 +5021,10 @@ declare module "sap/ui/layout/DynamicSideContent" {
     currentBreakpoint?: string;
   }
 
-  /**
-   * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'DynamicSideContent$BreakpointChangedEventParameters'
-   * in 1.115.1 and any later releases.
-   */
-  export type $DynamicSideContentBreakpointChangedEventParameters = DynamicSideContent$BreakpointChangedEventParameters;
-
-  export type DynamicSideContent$BreakpointChangedEvent = Event<DynamicSideContent$BreakpointChangedEventParameters>;
+  export type DynamicSideContent$BreakpointChangedEvent = Event<
+    DynamicSideContent$BreakpointChangedEventParameters,
+    DynamicSideContent
+  >;
 }
 
 declare module "sap/ui/layout/FixFlex" {
@@ -7025,22 +7012,6 @@ declare module "sap/ui/layout/form/FormElement" {
      * @returns Metadata object describing this class
      */
     static getMetadata(): 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}.
      *
@@ -7223,6 +7194,8 @@ declare module "sap/ui/layout/form/FormLayout" {
 
   import { BackgroundDesign } from "sap/ui/layout/library";
 
+  import LayoutData from "sap/ui/core/LayoutData";
+
   import ElementMetadata from "sap/ui/core/ElementMetadata";
 
   import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
@@ -7310,6 +7283,55 @@ declare module "sap/ui/layout/form/FormLayout" {
      * @returns Value of property `backgroundDesign`
      */
     getBackgroundDesign(): BackgroundDesign | keyof typeof 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(): 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?: LayoutData
+    ): 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
      *
@@ -9291,6 +9313,8 @@ declare module "sap/ui/layout/form/SimpleForm" {
      */
     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.
@@ -9378,10 +9402,11 @@ declare module "sap/ui/layout/form/SimpleForm" {
      * **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`
      */
@@ -9401,6 +9426,8 @@ declare module "sap/ui/layout/form/SimpleForm" {
      */
     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`.
@@ -9826,6 +9853,8 @@ declare module "sap/ui/layout/form/SimpleForm" {
       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.
@@ -9948,12 +9977,13 @@ declare module "sap/ui/layout/form/SimpleForm" {
      * **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
      */
@@ -9985,6 +10015,8 @@ declare module "sap/ui/layout/form/SimpleForm" {
       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`.
@@ -10089,6 +10121,8 @@ declare module "sap/ui/layout/form/SimpleForm" {
     maxContainerCols?: int | PropertyBindingInfo | `{${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
@@ -10124,6 +10158,8 @@ declare module "sap/ui/layout/form/SimpleForm" {
     editable?: boolean | PropertyBindingInfo | `{${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.
@@ -10139,8 +10175,9 @@ declare module "sap/ui/layout/form/SimpleForm" {
      * **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?:
       | (form.SimpleFormLayout | keyof typeof form.SimpleFormLayout)
@@ -12508,7 +12545,7 @@ declare module "sap/ui/layout/PaneContainer" {
     /**
      * Fired when contents are resized.
      */
-    resize?: (oEvent: Event<PaneContainer$ResizeEventParameters>) => void;
+    resize?: (oEvent: PaneContainer$ResizeEvent) => void;
   }
 
   export interface PaneContainer$ResizeEventParameters {
@@ -12523,13 +12560,10 @@ declare module "sap/ui/layout/PaneContainer" {
     newSizes?: float[];
   }
 
-  /**
-   * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'PaneContainer$ResizeEventParameters'
-   * in 1.115.1 and any later releases.
-   */
-  export type $PaneContainerResizeEventParameters = PaneContainer$ResizeEventParameters;
-
-  export type PaneContainer$ResizeEvent = Event<PaneContainer$ResizeEventParameters>;
+  export type PaneContainer$ResizeEvent = Event<
+    PaneContainer$ResizeEventParameters,
+    PaneContainer
+  >;
 }
 
 declare module "sap/ui/layout/ResponsiveFlowLayout" {
@@ -13894,7 +13928,7 @@ declare module "sap/ui/layout/Splitter" {
     /**
      * Event is fired when contents are resized.
      */
-    resize?: (oEvent: Event<Splitter$ResizeEventParameters>) => void;
+    resize?: (oEvent: Splitter$ResizeEvent) => void;
   }
 
   export interface Splitter$ResizeEventParameters {
@@ -13915,13 +13949,10 @@ declare module "sap/ui/layout/Splitter" {
     newSizes?: int[];
   }
 
-  /**
-   * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'Splitter$ResizeEventParameters'
-   * in 1.115.1 and any later releases.
-   */
-  export type $SplitterResizeEventParameters = Splitter$ResizeEventParameters;
-
-  export type Splitter$ResizeEvent = Event<Splitter$ResizeEventParameters>;
+  export type Splitter$ResizeEvent = Event<
+    Splitter$ResizeEventParameters,
+    Splitter
+  >;
 }
 
 declare module "sap/ui/layout/SplitterLayoutData" {