@openui5/types 1.116.0 → 1.117.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,3 +1,3 @@
1
- // For Library Version: 1.116.0
1
+ // For Library Version: 1.117.0
2
2
 
3
3
  declare namespace sap {}
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.116.0
1
+ // For Library Version: 1.117.0
2
2
 
3
3
  declare module "sap/ui/fl/library" {}
4
4
 
@@ -1179,11 +1179,17 @@ declare module "sap/ui/fl/variants/VariantManagement" {
1179
1179
 
1180
1180
  export interface VariantManagement$CancelEventParameters {}
1181
1181
 
1182
- export type VariantManagement$CancelEvent = Event<VariantManagement$CancelEventParameters>;
1182
+ export type VariantManagement$CancelEvent = Event<
1183
+ VariantManagement$CancelEventParameters,
1184
+ VariantManagement
1185
+ >;
1183
1186
 
1184
1187
  export interface VariantManagement$InitializedEventParameters {}
1185
1188
 
1186
- export type VariantManagement$InitializedEvent = Event<VariantManagement$InitializedEventParameters>;
1189
+ export type VariantManagement$InitializedEvent = Event<
1190
+ VariantManagement$InitializedEventParameters,
1191
+ VariantManagement
1192
+ >;
1187
1193
 
1188
1194
  export interface VariantManagement$ManageEventParameters {
1189
1195
  /**
@@ -1208,7 +1214,10 @@ declare module "sap/ui/fl/variants/VariantManagement" {
1208
1214
  def?: string;
1209
1215
  }
1210
1216
 
1211
- export type VariantManagement$ManageEvent = Event<VariantManagement$ManageEventParameters>;
1217
+ export type VariantManagement$ManageEvent = Event<
1218
+ VariantManagement$ManageEventParameters,
1219
+ VariantManagement
1220
+ >;
1212
1221
 
1213
1222
  export interface VariantManagement$SaveEventParameters {
1214
1223
  /**
@@ -1249,7 +1258,10 @@ declare module "sap/ui/fl/variants/VariantManagement" {
1249
1258
  tile?: boolean;
1250
1259
  }
1251
1260
 
1252
- export type VariantManagement$SaveEvent = Event<VariantManagement$SaveEventParameters>;
1261
+ export type VariantManagement$SaveEvent = Event<
1262
+ VariantManagement$SaveEventParameters,
1263
+ VariantManagement
1264
+ >;
1253
1265
 
1254
1266
  export interface VariantManagement$SelectEventParameters {
1255
1267
  /**
@@ -1258,7 +1270,10 @@ declare module "sap/ui/fl/variants/VariantManagement" {
1258
1270
  key?: string;
1259
1271
  }
1260
1272
 
1261
- export type VariantManagement$SelectEvent = Event<VariantManagement$SelectEventParameters>;
1273
+ export type VariantManagement$SelectEvent = Event<
1274
+ VariantManagement$SelectEventParameters,
1275
+ VariantManagement
1276
+ >;
1262
1277
  }
1263
1278
 
1264
1279
  declare module "sap/ui/fl/write/_internal/fieldExtensibility/ABAPExtensibilityVariant" {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.116.0
1
+ // For Library Version: 1.117.0
2
2
 
3
3
  declare module "sap/ui/integration/library" {
4
4
  import { URI } from "sap/ui/core/library";
@@ -600,7 +600,10 @@ declare module "sap/ui/integration/ActionDefinition" {
600
600
 
601
601
  export interface ActionDefinition$PressEventParameters {}
602
602
 
603
- export type ActionDefinition$PressEvent = Event<ActionDefinition$PressEventParameters>;
603
+ export type ActionDefinition$PressEvent = Event<
604
+ ActionDefinition$PressEventParameters,
605
+ ActionDefinition
606
+ >;
604
607
  }
605
608
 
606
609
  declare module "sap/ui/integration/widgets/Card" {
@@ -1468,6 +1471,12 @@ declare module "sap/ui/integration/widgets/Card" {
1468
1471
  */
1469
1472
  eCardArea?: CardArea | keyof typeof CardArea
1470
1473
  ): void;
1474
+ /**
1475
+ * @experimental (since 1.117)
1476
+ *
1477
+ * Hides the message previously shown by showMessage.
1478
+ */
1479
+ hideMessage(): void;
1471
1480
  /**
1472
1481
  * @since 1.85
1473
1482
  * @experimental (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
@@ -2010,6 +2019,12 @@ declare module "sap/ui/integration/widgets/Card" {
2010
2019
  */
2011
2020
  eCardArea?: CardArea | keyof typeof CardArea
2012
2021
  ): void;
2022
+ /**
2023
+ * @experimental (since 1.117)
2024
+ *
2025
+ * Hides the message previously shown by showMessage.
2026
+ */
2027
+ hideMessage(): void;
2013
2028
  /**
2014
2029
  * @since 1.85
2015
2030
  * @experimental (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
@@ -2410,7 +2425,7 @@ declare module "sap/ui/integration/widgets/Card" {
2410
2425
  type?: CardActionType | keyof typeof CardActionType;
2411
2426
  }
2412
2427
 
2413
- export type Card$ActionEvent = Event<Card$ActionEventParameters>;
2428
+ export type Card$ActionEvent = Event<Card$ActionEventParameters, Card>;
2414
2429
 
2415
2430
  export interface Card$ConfigurationChangeEventParameters {
2416
2431
  /**
@@ -2428,19 +2443,31 @@ declare module "sap/ui/integration/widgets/Card" {
2428
2443
  changes?: object;
2429
2444
  }
2430
2445
 
2431
- export type Card$ConfigurationChangeEvent = Event<Card$ConfigurationChangeEventParameters>;
2446
+ export type Card$ConfigurationChangeEvent = Event<
2447
+ Card$ConfigurationChangeEventParameters,
2448
+ Card
2449
+ >;
2432
2450
 
2433
2451
  export interface Card$ManifestAppliedEventParameters {}
2434
2452
 
2435
- export type Card$ManifestAppliedEvent = Event<Card$ManifestAppliedEventParameters>;
2453
+ export type Card$ManifestAppliedEvent = Event<
2454
+ Card$ManifestAppliedEventParameters,
2455
+ Card
2456
+ >;
2436
2457
 
2437
2458
  export interface Card$ManifestReadyEventParameters {}
2438
2459
 
2439
- export type Card$ManifestReadyEvent = Event<Card$ManifestReadyEventParameters>;
2460
+ export type Card$ManifestReadyEvent = Event<
2461
+ Card$ManifestReadyEventParameters,
2462
+ Card
2463
+ >;
2440
2464
 
2441
2465
  export interface Card$StateChangedEventParameters {}
2442
2466
 
2443
- export type Card$StateChangedEvent = Event<Card$StateChangedEventParameters>;
2467
+ export type Card$StateChangedEvent = Event<
2468
+ Card$StateChangedEventParameters,
2469
+ Card
2470
+ >;
2444
2471
  }
2445
2472
 
2446
2473
  declare module "sap/ui/integration/Designtime" {
@@ -3187,6 +3214,25 @@ declare module "sap/ui/integration/Extension" {
3187
3214
  * Called after the card is initialized.
3188
3215
  */
3189
3216
  onCardReady(): void;
3217
+ /**
3218
+ * @deprecated (since 1.85) - This property is replaced by the `actions` aggregation of the card;
3219
+ * @experimental (since 1.75) - Disclaimer: this property is in a beta state - incompatible API changes
3220
+ * may be done before its official public release. Use at your own discretion.
3221
+ *
3222
+ * Sets a new value for property {@link #getActions actions}.
3223
+ *
3224
+ * The actions configuration.
3225
+ *
3226
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3227
+ *
3228
+ * @returns Reference to `this` in order to allow method chaining
3229
+ */
3230
+ setActions(
3231
+ /**
3232
+ * New value for property `actions`
3233
+ */
3234
+ sActions: CardMenuAction[]
3235
+ ): this;
3190
3236
  /**
3191
3237
  * Sets current value of property {@link #setFormatters formatters}.
3192
3238
  *
@@ -3260,7 +3306,10 @@ declare module "sap/ui/integration/Extension" {
3260
3306
  type?: CardActionType | keyof typeof CardActionType;
3261
3307
  }
3262
3308
 
3263
- export type Extension$ActionEvent = Event<Extension$ActionEventParameters>;
3309
+ export type Extension$ActionEvent = Event<
3310
+ Extension$ActionEventParameters,
3311
+ Extension
3312
+ >;
3264
3313
  }
3265
3314
 
3266
3315
  declare module "sap/ui/integration/Host" {
@@ -4057,7 +4106,7 @@ declare module "sap/ui/integration/Host" {
4057
4106
  type?: CardActionType | keyof typeof CardActionType;
4058
4107
  }
4059
4108
 
4060
- export type Host$ActionEvent = Event<Host$ActionEventParameters>;
4109
+ export type Host$ActionEvent = Event<Host$ActionEventParameters, Host>;
4061
4110
 
4062
4111
  export interface Host$CardConfigurationChangeEventParameters {
4063
4112
  /**
@@ -4080,7 +4129,10 @@ declare module "sap/ui/integration/Host" {
4080
4129
  changes?: object;
4081
4130
  }
4082
4131
 
4083
- export type Host$CardConfigurationChangeEvent = Event<Host$CardConfigurationChangeEventParameters>;
4132
+ export type Host$CardConfigurationChangeEvent = Event<
4133
+ Host$CardConfigurationChangeEventParameters,
4134
+ Host
4135
+ >;
4084
4136
 
4085
4137
  export interface Host$CardInitializedEventParameters {
4086
4138
  /**
@@ -4089,7 +4141,10 @@ declare module "sap/ui/integration/Host" {
4089
4141
  card?: Control;
4090
4142
  }
4091
4143
 
4092
- export type Host$CardInitializedEvent = Event<Host$CardInitializedEventParameters>;
4144
+ export type Host$CardInitializedEvent = Event<
4145
+ Host$CardInitializedEventParameters,
4146
+ Host
4147
+ >;
4093
4148
 
4094
4149
  export interface Host$CardStateChangedEventParameters {
4095
4150
  /**
@@ -4098,13 +4153,16 @@ declare module "sap/ui/integration/Host" {
4098
4153
  card?: Control;
4099
4154
  }
4100
4155
 
4101
- export type Host$CardStateChangedEvent = Event<Host$CardStateChangedEventParameters>;
4156
+ export type Host$CardStateChangedEvent = Event<
4157
+ Host$CardStateChangedEventParameters,
4158
+ Host
4159
+ >;
4102
4160
 
4103
4161
  export interface Host$MessageEventParameters {
4104
4162
  data?: object;
4105
4163
  }
4106
4164
 
4107
- export type Host$MessageEvent = Event<Host$MessageEventParameters>;
4165
+ export type Host$MessageEvent = Event<Host$MessageEventParameters, Host>;
4108
4166
  }
4109
4167
 
4110
4168
  declare namespace sap {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.116.0
1
+ // For Library Version: 1.117.0
2
2
 
3
3
  declare module "sap/ui/layout/library" {
4
4
  import Control from "sap/ui/core/Control";
@@ -3631,7 +3631,10 @@ declare module "sap/ui/layout/cssgrid/GridResponsiveLayout" {
3631
3631
  layout?: string;
3632
3632
  }
3633
3633
 
3634
- export type GridResponsiveLayout$LayoutChangeEvent = Event<GridResponsiveLayout$LayoutChangeEventParameters>;
3634
+ export type GridResponsiveLayout$LayoutChangeEvent = Event<
3635
+ GridResponsiveLayout$LayoutChangeEventParameters,
3636
+ GridResponsiveLayout
3637
+ >;
3635
3638
  }
3636
3639
 
3637
3640
  declare module "sap/ui/layout/cssgrid/GridSettings" {
@@ -4321,7 +4324,10 @@ declare module "sap/ui/layout/cssgrid/ResponsiveColumnLayout" {
4321
4324
  layout?: string;
4322
4325
  }
4323
4326
 
4324
- export type ResponsiveColumnLayout$LayoutChangeEvent = Event<ResponsiveColumnLayout$LayoutChangeEventParameters>;
4327
+ export type ResponsiveColumnLayout$LayoutChangeEvent = Event<
4328
+ ResponsiveColumnLayout$LayoutChangeEventParameters,
4329
+ ResponsiveColumnLayout
4330
+ >;
4325
4331
  }
4326
4332
 
4327
4333
  declare module "sap/ui/layout/DynamicSideContent" {
@@ -5015,7 +5021,10 @@ declare module "sap/ui/layout/DynamicSideContent" {
5015
5021
  currentBreakpoint?: string;
5016
5022
  }
5017
5023
 
5018
- export type DynamicSideContent$BreakpointChangedEvent = Event<DynamicSideContent$BreakpointChangedEventParameters>;
5024
+ export type DynamicSideContent$BreakpointChangedEvent = Event<
5025
+ DynamicSideContent$BreakpointChangedEventParameters,
5026
+ DynamicSideContent
5027
+ >;
5019
5028
  }
5020
5029
 
5021
5030
  declare module "sap/ui/layout/FixFlex" {
@@ -7003,22 +7012,6 @@ declare module "sap/ui/layout/form/FormElement" {
7003
7012
  * @returns Metadata object describing this class
7004
7013
  */
7005
7014
  static getMetadata(): ElementMetadata;
7006
- /**
7007
- * @since 1.74.0
7008
- * @ui5-protected Do not call from applications (only from related classes in the framework)
7009
- *
7010
- * Sets the editable state of the `FormElement`.
7011
- *
7012
- * This must only be called from the `Form` and it's `FormContainers`.
7013
- *
7014
- * Labels inside of a `Form` must be invalidated if `editable` changed on `Form`.
7015
- */
7016
- _setEditable(
7017
- /**
7018
- * Editable state of the `Form`
7019
- */
7020
- bEditable: boolean
7021
- ): void;
7022
7015
  /**
7023
7016
  * Adds some field to the aggregation {@link #getFields fields}.
7024
7017
  *
@@ -7201,6 +7194,8 @@ declare module "sap/ui/layout/form/FormLayout" {
7201
7194
 
7202
7195
  import { BackgroundDesign } from "sap/ui/layout/library";
7203
7196
 
7197
+ import LayoutData from "sap/ui/core/LayoutData";
7198
+
7204
7199
  import ElementMetadata from "sap/ui/core/ElementMetadata";
7205
7200
 
7206
7201
  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
@@ -7288,6 +7283,55 @@ declare module "sap/ui/layout/form/FormLayout" {
7288
7283
  * @returns Value of property `backgroundDesign`
7289
7284
  */
7290
7285
  getBackgroundDesign(): BackgroundDesign | keyof typeof BackgroundDesign;
7286
+ /**
7287
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
7288
+ *
7289
+ * In {@link sap.ui.layout.SemanticFormElement SemanticFormElement}, delimiters are rendered. They should
7290
+ * use only a small space. So `Layout`-dependent `LayoutData` are needed.
7291
+ *
7292
+ * This function needs to be implemented by the specific `Layout`.
7293
+ *
7294
+ * @returns LayoutData or promise retuning LayoutData
7295
+ */
7296
+ getLayoutDataForDelimiter(): LayoutData | Promise<any>;
7297
+ /**
7298
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
7299
+ *
7300
+ * In {@link sap.ui.layout.SemanticFormElement SemanticFormElement}, delimiters are rendered. The fields
7301
+ * should be rendered per default in a way, the field and the corresponding delimiter filling one row in
7302
+ * phone mode. In desktop mode they should all be in one row.
7303
+ *
7304
+ * This function needs to be implemented by the specific `Layout`.
7305
+ *
7306
+ * @returns LayoutData or promise retuning LayoutData
7307
+ */
7308
+ getLayoutDataForSemanticField(
7309
+ /**
7310
+ * Number of field in the `SemanticFormElement`
7311
+ */
7312
+ iFields: int,
7313
+ /**
7314
+ * Index of field in the `SemanticFormElement`
7315
+ */
7316
+ iIndex: int,
7317
+ /**
7318
+ * existing `LayoutData` that might be just changed
7319
+ */
7320
+ oLayoutData?: LayoutData
7321
+ ): LayoutData | Promise<any>;
7322
+ /**
7323
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
7324
+ *
7325
+ * For {@link sap.ui.layout.SemanticFormElement SemanticFormElement}, all text-based controls should be
7326
+ * concatenated in display mode. If the `Layout` supports rendering of single controls, they are rendered
7327
+ * divided by delimiters. If the `Layout` doesn't support this, one concatenated text is rendered. Here
7328
+ * only text is supported, no links or other special rendering.
7329
+ *
7330
+ * This function needs to be implemented by the specific `Layout`.
7331
+ *
7332
+ * @returns `true` if layout allows to render single controls for {@link sap.ui.layout.SemanticFormElement SemanticFormElement}
7333
+ */
7334
+ renderControlsForSemanticElement(): boolean;
7291
7335
  /**
7292
7336
  * @since 1.36.0
7293
7337
  *
@@ -9269,6 +9313,8 @@ declare module "sap/ui/layout/form/SimpleForm" {
9269
9313
  */
9270
9314
  getEmptySpanXL(): int;
9271
9315
  /**
9316
+ * @deprecated (since 1.93) - use another `Layout`
9317
+ *
9272
9318
  * Gets current value of property {@link #getLabelMinWidth labelMinWidth}.
9273
9319
  *
9274
9320
  * Specifies the min-width in pixels of the label in all form rows.
@@ -9356,10 +9402,11 @@ declare module "sap/ui/layout/form/SimpleForm" {
9356
9402
  * **Note** If possible, set the `layout` before adding content to prevent calculations for the default
9357
9403
  * layout.
9358
9404
  *
9359
- * **Note** The `ResponsiveLayout` has been deprecated and must no longer be used. For compatibility reasons
9360
- * the default could not be changed.
9405
+ * **Note** The `ResponsiveLayout` has been deprecated and must no longer be used.
9406
+ *
9407
+ * **Note** As of version 1.117, the `ResponsiveGridLayout` is used as default.
9361
9408
  *
9362
- * Default value is `ResponsiveLayout`.
9409
+ * Default value is `ResponsiveGridLayout`.
9363
9410
  *
9364
9411
  * @returns Value of property `layout`
9365
9412
  */
@@ -9379,6 +9426,8 @@ declare module "sap/ui/layout/form/SimpleForm" {
9379
9426
  */
9380
9427
  getMaxContainerCols(): int;
9381
9428
  /**
9429
+ * @deprecated (since 1.93) - use another `Layout`
9430
+ *
9382
9431
  * Gets current value of property {@link #getMinWidth minWidth}.
9383
9432
  *
9384
9433
  * The overall minimum width in pixels that is used for the `SimpleForm`.
@@ -9804,6 +9853,8 @@ declare module "sap/ui/layout/form/SimpleForm" {
9804
9853
  iEmptySpanXL?: int
9805
9854
  ): this;
9806
9855
  /**
9856
+ * @deprecated (since 1.93) - use another `Layout`
9857
+ *
9807
9858
  * Sets a new value for property {@link #getLabelMinWidth labelMinWidth}.
9808
9859
  *
9809
9860
  * Specifies the min-width in pixels of the label in all form rows.
@@ -9926,12 +9977,13 @@ declare module "sap/ui/layout/form/SimpleForm" {
9926
9977
  * **Note** If possible, set the `layout` before adding content to prevent calculations for the default
9927
9978
  * layout.
9928
9979
  *
9929
- * **Note** The `ResponsiveLayout` has been deprecated and must no longer be used. For compatibility reasons
9930
- * the default could not be changed.
9980
+ * **Note** The `ResponsiveLayout` has been deprecated and must no longer be used.
9981
+ *
9982
+ * **Note** As of version 1.117, the `ResponsiveGridLayout` is used as default.
9931
9983
  *
9932
9984
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
9933
9985
  *
9934
- * Default value is `ResponsiveLayout`.
9986
+ * Default value is `ResponsiveGridLayout`.
9935
9987
  *
9936
9988
  * @returns Reference to `this` in order to allow method chaining
9937
9989
  */
@@ -9963,6 +10015,8 @@ declare module "sap/ui/layout/form/SimpleForm" {
9963
10015
  iMaxContainerCols?: int
9964
10016
  ): this;
9965
10017
  /**
10018
+ * @deprecated (since 1.93) - use another `Layout`
10019
+ *
9966
10020
  * Sets a new value for property {@link #getMinWidth minWidth}.
9967
10021
  *
9968
10022
  * The overall minimum width in pixels that is used for the `SimpleForm`.
@@ -10067,6 +10121,8 @@ declare module "sap/ui/layout/form/SimpleForm" {
10067
10121
  maxContainerCols?: int | PropertyBindingInfo | `{${string}}`;
10068
10122
 
10069
10123
  /**
10124
+ * @deprecated (since 1.93) - use another `Layout`
10125
+ *
10070
10126
  * The overall minimum width in pixels that is used for the `SimpleForm`.
10071
10127
  *
10072
10128
  * If the available width is below the given `minWidth` the `SimpleForm` will create a new row for the next
@@ -10102,6 +10158,8 @@ declare module "sap/ui/layout/form/SimpleForm" {
10102
10158
  editable?: boolean | PropertyBindingInfo | `{${string}}`;
10103
10159
 
10104
10160
  /**
10161
+ * @deprecated (since 1.93) - use another `Layout`
10162
+ *
10105
10163
  * Specifies the min-width in pixels of the label in all form rows.
10106
10164
  *
10107
10165
  * **Note:** This property is only used if a `ResponsiveLayout` is used as a layout.
@@ -10117,8 +10175,9 @@ declare module "sap/ui/layout/form/SimpleForm" {
10117
10175
  * **Note** If possible, set the `layout` before adding content to prevent calculations for the default
10118
10176
  * layout.
10119
10177
  *
10120
- * **Note** The `ResponsiveLayout` has been deprecated and must no longer be used. For compatibility reasons
10121
- * the default could not be changed.
10178
+ * **Note** The `ResponsiveLayout` has been deprecated and must no longer be used.
10179
+ *
10180
+ * **Note** As of version 1.117, the `ResponsiveGridLayout` is used as default.
10122
10181
  */
10123
10182
  layout?:
10124
10183
  | (form.SimpleFormLayout | keyof typeof form.SimpleFormLayout)
@@ -12501,7 +12560,10 @@ declare module "sap/ui/layout/PaneContainer" {
12501
12560
  newSizes?: float[];
12502
12561
  }
12503
12562
 
12504
- export type PaneContainer$ResizeEvent = Event<PaneContainer$ResizeEventParameters>;
12563
+ export type PaneContainer$ResizeEvent = Event<
12564
+ PaneContainer$ResizeEventParameters,
12565
+ PaneContainer
12566
+ >;
12505
12567
  }
12506
12568
 
12507
12569
  declare module "sap/ui/layout/ResponsiveFlowLayout" {
@@ -13887,7 +13949,10 @@ declare module "sap/ui/layout/Splitter" {
13887
13949
  newSizes?: int[];
13888
13950
  }
13889
13951
 
13890
- export type Splitter$ResizeEvent = Event<Splitter$ResizeEventParameters>;
13952
+ export type Splitter$ResizeEvent = Event<
13953
+ Splitter$ResizeEventParameters,
13954
+ Splitter
13955
+ >;
13891
13956
  }
13892
13957
 
13893
13958
  declare module "sap/ui/layout/SplitterLayoutData" {