@openui5/types 1.122.0 → 1.123.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,4 +1,4 @@
1
- // For Library Version: 1.122.0
1
+ // For Library Version: 1.123.0
2
2
 
3
3
  declare module "sap/ui/mdc/AggregationBaseDelegate" {
4
4
  import BaseDelegate from "sap/ui/mdc/BaseDelegate";
@@ -868,7 +868,8 @@ declare module "sap/ui/mdc/field/FieldBaseDelegate" {
868
868
  * user input changes while typing what would lead to confusion.
869
869
  *
870
870
  *
871
- * @returns Output text
871
+ * @returns Output text or boolean true, if the autocomplete value should be accepted without modifying
872
+ * the visible input
872
873
  */
873
874
  getAutocompleteOutput(
874
875
  /**
@@ -895,7 +896,7 @@ declare module "sap/ui/mdc/field/FieldBaseDelegate" {
895
896
  * If `true` the description matches to the user input
896
897
  */
897
898
  bDescriptionMatch: boolean
898
- ): string;
899
+ ): string | boolean;
899
900
  /**
900
901
  * Determines the description for a given key.
901
902
  * By default, this method calls the {@link sap.ui.mdc.ValueHelp#getItemForValue getItemForValue} function
@@ -1251,7 +1252,7 @@ declare module "sap/ui/mdc/field/MultiValueFieldDelegate" {
1251
1252
  * Implements the model-specific logic to update items after conditions have been updated.
1252
1253
  *
1253
1254
  * Items can be removed, updated, or added. Use the binding information of the `MultiValueField` control
1254
- * to update the data in the model.
1255
+ * to update the data in the related model.
1255
1256
  */
1256
1257
  updateItems(
1257
1258
  /**
@@ -1263,7 +1264,7 @@ declare module "sap/ui/mdc/field/MultiValueFieldDelegate" {
1263
1264
  */
1264
1265
  aConditions: ConditionObject[],
1265
1266
  /**
1266
- * Current `MultiValueField` control to determine binding information to update the values of the corresponding
1267
+ * Current `MultiValueField` control to determine binding information to update the values of the related
1267
1268
  * model
1268
1269
  */
1269
1270
  oMultiValueField: MultiValueField
@@ -1688,6 +1689,28 @@ declare module "sap/ui/mdc/odata/v4/TableDelegate" {
1688
1689
  * @since 1.85
1689
1690
  */
1690
1691
  interface TableDelegate extends TableDelegate1 {
1692
+ /**
1693
+ * Collapses all rows.
1694
+ *
1695
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1696
+ */
1697
+ collapseAllRows(
1698
+ /**
1699
+ * Instance of the table
1700
+ */
1701
+ oTable: Table
1702
+ ): void;
1703
+ /**
1704
+ * Expands all rows.
1705
+ *
1706
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1707
+ */
1708
+ expandAllRows(
1709
+ /**
1710
+ * Instance of the table
1711
+ */
1712
+ oTable: Table
1713
+ ): void;
1691
1714
  /**
1692
1715
  * Retrieves information about the relevant properties.
1693
1716
  *
@@ -1846,7 +1869,7 @@ declare module "sap/ui/mdc/TableDelegate" {
1846
1869
  *
1847
1870
  * The following methods need to be added or overridden in your delegate. Please also see the documentation
1848
1871
  * of the methods to learn about their default implementation and what you need to implement.
1849
- * - `Basic prerequisites`
1872
+ * - **Basic prerequisites**
1850
1873
  * - {@link module:sap/ui/mdc/TableDelegate.fetchProperties fetchProperties}
1851
1874
  * - {@link module:sap/ui/mdc/TableDelegate.updateBindingInfo updateBindingInfo}
1852
1875
  * - Column personalization (related to `p13nMode` `Column`)
@@ -2525,7 +2548,20 @@ declare module "sap/ui/mdc/ValueHelpDelegate" {
2525
2548
  /**
2526
2549
  * Returns the content that is used for the autocomplete feature and for user input, if the entered text
2527
2550
  * leads to more than one filter result.
2528
- * By default, this method returns the first entry of a set of relevant contexts of the given {@link sap.ui.mdc.valuehelp.base.ListContent ListContent}.
2551
+ *
2552
+ * By default, this method searches and returns an entry from a set of relevant contexts of the given {@link sap.ui.mdc.valuehelp.base.ListContent ListContent}.
2553
+ *
2554
+ * To determine which columns are relevant for the search, the currently active displayMode {@link sap.ui.mdc.enums.FieldDisplay Display }
2555
+ * of the connected control will be used. While a 'Value' configuration will lead to a 'key'-only search,
2556
+ * 'DescriptionValue' leads to searching 'description' first and 'key' afterwards. Other modes work accordingly.
2557
+ *
2558
+ * For each relevant column all items are searched for an exact match first and again with a startsWith
2559
+ * filter afterwards, if necessary.
2560
+ *
2561
+ * If the caseSensitive property is disabled, the letter case of the user's input and the corresponding
2562
+ * column value are completely ignored. Whichever entry comes first, wins.
2563
+ *
2564
+ * {@link sap.ui.mdc.valuehelp.base.ListContent ListContent}
2529
2565
  *
2530
2566
  * @since 1.120.0
2531
2567
  *
@@ -3495,7 +3531,9 @@ declare module "sap/ui/mdc/ActionToolbar" {
3495
3531
  bUseAsHeader?: boolean
3496
3532
  ): this;
3497
3533
  }
3498
-
3534
+ /**
3535
+ * Describes the settings that can be provided to the ActionToolbar constructor.
3536
+ */
3499
3537
  export interface $ActionToolbarSettings extends $OverflowToolbarSettings {
3500
3538
  /**
3501
3539
  * Determines whether the toolbar is used as header (e.g. for a table).
@@ -3677,7 +3715,9 @@ declare module "sap/ui/mdc/actiontoolbar/ActionToolbarAction" {
3677
3715
  oLayoutInformation?: object
3678
3716
  ): this;
3679
3717
  }
3680
-
3718
+ /**
3719
+ * Describes the settings that can be provided to the ActionToolbarAction constructor.
3720
+ */
3681
3721
  export interface $ActionToolbarActionSettings extends $ControlSettings {
3682
3722
  /**
3683
3723
  * Contains the information where the action is displayed on the `ActionToolbar`.
@@ -4196,6 +4236,15 @@ declare module "sap/ui/mdc/Chart" {
4196
4236
  */
4197
4237
  oItem: Item
4198
4238
  ): int;
4239
+ /**
4240
+ * Executes a rebind considering the provided external and inbuilt filtering.
4241
+ *
4242
+ * @since 1.98
4243
+ *
4244
+ * @returns A `Promise` that resolves after rebind is executed, and rejects if rebind cannot be executed,
4245
+ * for example because there are invalid filters.
4246
+ */
4247
+ rebind(): Promise<any>;
4199
4248
  /**
4200
4249
  * Sets a new value for property {@link #getAutoBindOnInit autoBindOnInit}.
4201
4250
  *
@@ -4593,6 +4642,11 @@ declare module "sap/ui/mdc/Chart" {
4593
4642
  unitPath?: object;
4594
4643
  };
4595
4644
 
4645
+ /**
4646
+ * Describes the settings that can be provided to the Chart constructor.
4647
+ *
4648
+ * @experimental (since 1.88)
4649
+ */
4596
4650
  export interface $ChartSettings extends $ControlSettings {
4597
4651
  /**
4598
4652
  * Defines the width of the chart.
@@ -4815,6 +4869,9 @@ declare module "sap/ui/mdc/Chart" {
4815
4869
  ) => void;
4816
4870
  }
4817
4871
 
4872
+ /**
4873
+ * Parameters of the Chart#selectionDetailsActionPressed event.
4874
+ */
4818
4875
  export interface Chart$SelectionDetailsActionPressedEventParameters {
4819
4876
  /**
4820
4877
  * The action that has to be processed once the action has been pressed
@@ -4837,6 +4894,9 @@ declare module "sap/ui/mdc/Chart" {
4837
4894
  | keyof typeof SelectionDetailsActionLevel;
4838
4895
  }
4839
4896
 
4897
+ /**
4898
+ * Event object of the Chart#selectionDetailsActionPressed event.
4899
+ */
4840
4900
  export type Chart$SelectionDetailsActionPressedEvent = Event<
4841
4901
  Chart$SelectionDetailsActionPressedEventParameters,
4842
4902
  Chart
@@ -4966,7 +5026,9 @@ declare module "sap/ui/mdc/chart/ChartImplementationContainer" {
4966
5026
  */
4967
5027
  getShowNoDataStruct(): boolean;
4968
5028
  }
4969
-
5029
+ /**
5030
+ * Describes the settings that can be provided to the ChartImplementationContainer constructor.
5031
+ */
4970
5032
  export interface $ChartImplementationContainerSettings
4971
5033
  extends $ControlSettings {
4972
5034
  /**
@@ -5078,7 +5140,9 @@ declare module "sap/ui/mdc/chart/ChartSelectionDetails" {
5078
5140
  */
5079
5141
  static getMetadata(): ElementMetadata;
5080
5142
  }
5081
-
5143
+ /**
5144
+ * Describes the settings that can be provided to the ChartSelectionDetails constructor.
5145
+ */
5082
5146
  export interface $ChartSelectionDetailsSettings
5083
5147
  extends $SelectionDetailsSettings {}
5084
5148
  }
@@ -5305,7 +5369,9 @@ declare module "sap/ui/mdc/chart/Item" {
5305
5369
  sType?: string
5306
5370
  ): this;
5307
5371
  }
5308
-
5372
+ /**
5373
+ * Describes the settings that can be provided to the Item constructor.
5374
+ */
5309
5375
  export interface $ItemSettings extends $ElementSettings {
5310
5376
  /**
5311
5377
  * The unique identifier of the chart item that reflects the name of the data property in the resulting
@@ -5653,7 +5719,9 @@ declare module "sap/ui/mdc/chart/SelectionDetailsActions" {
5653
5719
  vDetailsItemAction: int | string | Item
5654
5720
  ): Item | null;
5655
5721
  }
5656
-
5722
+ /**
5723
+ * Describes the settings that can be provided to the SelectionDetailsActions constructor.
5724
+ */
5657
5725
  export interface $SelectionDetailsActionsSettings extends $ElementSettings {
5658
5726
  /**
5659
5727
  * Action `item` shown in the Items area of the details popover.
@@ -6185,6 +6253,36 @@ declare module "sap/ui/mdc/condition/Operator" {
6185
6253
  * used (undefined) the Include or Exclude information of the operator is used.
6186
6254
  */
6187
6255
  additionalInfo?: string;
6256
+ /**
6257
+ * Additional group settings for the operator. Will be used by the `DynamicDateRange`. If not used (undefined),
6258
+ * the operators will be added to the include and exclude groups.
6259
+ */
6260
+ group?: {
6261
+ /**
6262
+ * Group ID for the operator. The following groups are available for the `DynamicDateRange` control:
6263
+ *
6264
+ * - 1 - Single Dates
6265
+ * - 2 - Date Ranges
6266
+ * - 3 - Weeks
6267
+ * - 4 - Months
6268
+ * - 5 - Quarters
6269
+ * - 6 - Years See {@link sap.m.DynamicDateRangeGroups DynamicDateRangeGroups}.
6270
+ * This only works for `FilterFields` with custom operators if `maxConditions=1` and no `valueHelp` is
6271
+ * assigned to the `FilterField`. Example:
6272
+ * group: undefined - if group is not specified; default behavior include/exclude group with id 1 and 2
6273
+ * will be created
6274
+ * group: {id : 1} - adds the operator to existing group 1 'Single Dates'
6275
+ * group: {id : 2, text: "new group"} - inserts a new group with id 2. Existing group 2 will be shifted
6276
+ * to 3, 4....
6277
+ * group: {id : 10, text: "new group at the end"} - adds a new group with id 10 and text "new group as
6278
+ * the end" to the end of all groups
6279
+ */
6280
+ id: string;
6281
+ /**
6282
+ * Group title for the operator. When used a new group with this title will be added.
6283
+ */
6284
+ text?: string;
6285
+ };
6188
6286
  }
6189
6287
  );
6190
6288
 
@@ -6529,7 +6627,11 @@ declare module "sap/ui/mdc/Control" {
6529
6627
  */
6530
6628
  isPropertyHelperFinal(): boolean;
6531
6629
  }
6532
-
6630
+ /**
6631
+ * Describes the settings that can be provided to the Control constructor.
6632
+ *
6633
+ * @experimental (since 1.61)
6634
+ */
6533
6635
  export interface $ControlSettings extends $ControlSettings1 {
6534
6636
  /**
6535
6637
  * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
@@ -6752,7 +6854,11 @@ declare module "sap/ui/mdc/Element" {
6752
6854
  */
6753
6855
  isPropertyHelperFinal(): boolean;
6754
6856
  }
6755
-
6857
+ /**
6858
+ * Describes the settings that can be provided to the Element constructor.
6859
+ *
6860
+ * @experimental (since 1.74)
6861
+ */
6756
6862
  export interface $ElementSettings extends $ElementSettings1 {
6757
6863
  /**
6758
6864
  * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
@@ -7780,7 +7886,7 @@ declare module "sap/ui/mdc/enums/TableSelectionMode" {
7780
7886
  * Only one row can be selected at a time. The selection column is not shown. Instead, the user can press
7781
7887
  * the row to select it.
7782
7888
  *
7783
- * **Note:** If this selection mode is used, the table does not fire the `rowPress` event
7889
+ * **Note:** If this selection mode is used, the table does not fire the `rowPress` event.
7784
7890
  */
7785
7891
  SingleMaster = "SingleMaster",
7786
7892
  }
@@ -8283,7 +8389,11 @@ declare module "sap/ui/mdc/Field" {
8283
8389
  */
8284
8390
  unbindValue(): this;
8285
8391
  }
8286
-
8392
+ /**
8393
+ * Describes the settings that can be provided to the Field constructor.
8394
+ *
8395
+ * @experimental (since 1.54.0)
8396
+ */
8287
8397
  export interface $FieldSettings extends $FieldBaseSettings {
8288
8398
  /**
8289
8399
  * The value of the field.
@@ -8308,6 +8418,9 @@ declare module "sap/ui/mdc/Field" {
8308
8418
  change?: (oEvent: Field$ChangeEvent) => void;
8309
8419
  }
8310
8420
 
8421
+ /**
8422
+ * Parameters of the Field#change event.
8423
+ */
8311
8424
  export interface Field$ChangeEventParameters {
8312
8425
  /**
8313
8426
  * The new value of the `Field`.
@@ -8332,6 +8445,9 @@ declare module "sap/ui/mdc/Field" {
8332
8445
  promise?: Promise<any>;
8333
8446
  }
8334
8447
 
8448
+ /**
8449
+ * Event object of the Field#change event.
8450
+ */
8335
8451
  export type Field$ChangeEvent = Event<Field$ChangeEventParameters, Field>;
8336
8452
  }
8337
8453
 
@@ -10530,7 +10646,9 @@ declare module "sap/ui/mdc/field/FieldBase" {
10530
10646
  */
10531
10647
  updateInternalContent(): void;
10532
10648
  }
10533
-
10649
+ /**
10650
+ * Describes the settings that can be provided to the FieldBase constructor.
10651
+ */
10534
10652
  export interface $FieldBaseSettings extends $ControlSettings {
10535
10653
  /**
10536
10654
  * The type of data handled by the field. This type is used to parse, format, and validate the value.
@@ -10837,6 +10955,9 @@ declare module "sap/ui/mdc/field/FieldBase" {
10837
10955
  submit?: (oEvent: FieldBase$SubmitEvent) => void;
10838
10956
  }
10839
10957
 
10958
+ /**
10959
+ * Parameters of the FieldBase#liveChange event.
10960
+ */
10840
10961
  export interface FieldBase$LiveChangeEventParameters {
10841
10962
  /**
10842
10963
  * The new value of the input
@@ -10854,18 +10975,30 @@ declare module "sap/ui/mdc/field/FieldBase" {
10854
10975
  previousValue?: string;
10855
10976
  }
10856
10977
 
10978
+ /**
10979
+ * Event object of the FieldBase#liveChange event.
10980
+ */
10857
10981
  export type FieldBase$LiveChangeEvent = Event<
10858
10982
  FieldBase$LiveChangeEventParameters,
10859
10983
  FieldBase
10860
10984
  >;
10861
10985
 
10986
+ /**
10987
+ * Parameters of the FieldBase#press event.
10988
+ */
10862
10989
  export interface FieldBase$PressEventParameters {}
10863
10990
 
10991
+ /**
10992
+ * Event object of the FieldBase#press event.
10993
+ */
10864
10994
  export type FieldBase$PressEvent = Event<
10865
10995
  FieldBase$PressEventParameters,
10866
10996
  FieldBase
10867
10997
  >;
10868
10998
 
10999
+ /**
11000
+ * Parameters of the FieldBase#submit event.
11001
+ */
10869
11002
  export interface FieldBase$SubmitEventParameters {
10870
11003
  /**
10871
11004
  * Returns a `Promise` for the change. The `Promise` returns the value if it is resolved. If the last `change`
@@ -10875,6 +11008,9 @@ declare module "sap/ui/mdc/field/FieldBase" {
10875
11008
  promise?: Promise<any>;
10876
11009
  }
10877
11010
 
11011
+ /**
11012
+ * Event object of the FieldBase#submit event.
11013
+ */
10878
11014
  export type FieldBase$SubmitEvent = Event<
10879
11015
  FieldBase$SubmitEventParameters,
10880
11016
  FieldBase
@@ -11192,7 +11328,9 @@ declare module "sap/ui/mdc/field/FieldInfoBase" {
11192
11328
  oEvent: Event
11193
11329
  ): Promise<any>;
11194
11330
  }
11195
-
11331
+ /**
11332
+ * Describes the settings that can be provided to the FieldInfoBase constructor.
11333
+ */
11196
11334
  export interface $FieldInfoBaseSettings extends $ElementSettings {
11197
11335
  /**
11198
11336
  * This event is fired if the data was updated.
@@ -11205,15 +11343,27 @@ declare module "sap/ui/mdc/field/FieldInfoBase" {
11205
11343
  popoverAfterOpen?: (oEvent: Event) => void;
11206
11344
  }
11207
11345
 
11346
+ /**
11347
+ * Parameters of the FieldInfoBase#dataUpdate event.
11348
+ */
11208
11349
  export interface FieldInfoBase$DataUpdateEventParameters {}
11209
11350
 
11351
+ /**
11352
+ * Event object of the FieldInfoBase#dataUpdate event.
11353
+ */
11210
11354
  export type FieldInfoBase$DataUpdateEvent = Event<
11211
11355
  FieldInfoBase$DataUpdateEventParameters,
11212
11356
  FieldInfoBase
11213
11357
  >;
11214
11358
 
11359
+ /**
11360
+ * Parameters of the FieldInfoBase#popoverAfterOpen event.
11361
+ */
11215
11362
  export interface FieldInfoBase$PopoverAfterOpenEventParameters {}
11216
11363
 
11364
+ /**
11365
+ * Event object of the FieldInfoBase#popoverAfterOpen event.
11366
+ */
11217
11367
  export type FieldInfoBase$PopoverAfterOpenEvent = Event<
11218
11368
  FieldInfoBase$PopoverAfterOpenEventParameters,
11219
11369
  FieldInfoBase
@@ -11347,7 +11497,9 @@ declare module "sap/ui/mdc/field/MultiValueFieldItem" {
11347
11497
  oKey: any
11348
11498
  ): this;
11349
11499
  }
11350
-
11500
+ /**
11501
+ * Describes the settings that can be provided to the MultiValueFieldItem constructor.
11502
+ */
11351
11503
  export interface $MultiValueFieldItemSettings extends $ElementSettings {
11352
11504
  /**
11353
11505
  * Key of the item.
@@ -11573,6 +11725,11 @@ declare module "sap/ui/mdc/FilterBar" {
11573
11725
  required?: boolean;
11574
11726
  };
11575
11727
 
11728
+ /**
11729
+ * Describes the settings that can be provided to the FilterBar constructor.
11730
+ *
11731
+ * @experimental (since 1.61.0)
11732
+ */
11576
11733
  export interface $FilterBarSettings extends $FilterBarBaseSettings {
11577
11734
  /**
11578
11735
  * Determines whether the Adapt Filters button is visible in the `FilterBar`.
@@ -12206,7 +12363,9 @@ declare module "sap/ui/mdc/filterbar/FilterBarBase" {
12206
12363
  bSuppressSearch: boolean
12207
12364
  ): Promise<any>;
12208
12365
  }
12209
-
12366
+ /**
12367
+ * Describes the settings that can be provided to the FilterBarBase constructor.
12368
+ */
12210
12369
  export interface $FilterBarBaseSettings extends $ControlSettings {
12211
12370
  /**
12212
12371
  * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
@@ -12318,6 +12477,9 @@ declare module "sap/ui/mdc/filterbar/FilterBarBase" {
12318
12477
  filtersChanged?: (oEvent: FilterBarBase$FiltersChangedEvent) => void;
12319
12478
  }
12320
12479
 
12480
+ /**
12481
+ * Parameters of the FilterBarBase#filtersChanged event.
12482
+ */
12321
12483
  export interface FilterBarBase$FiltersChangedEventParameters {
12322
12484
  /**
12323
12485
  * Indicates if the event is based on condition changes
@@ -12335,11 +12497,17 @@ declare module "sap/ui/mdc/filterbar/FilterBarBase" {
12335
12497
  filtersTextExpanded?: string;
12336
12498
  }
12337
12499
 
12500
+ /**
12501
+ * Event object of the FilterBarBase#filtersChanged event.
12502
+ */
12338
12503
  export type FilterBarBase$FiltersChangedEvent = Event<
12339
12504
  FilterBarBase$FiltersChangedEventParameters,
12340
12505
  FilterBarBase
12341
12506
  >;
12342
12507
 
12508
+ /**
12509
+ * Parameters of the FilterBarBase#search event.
12510
+ */
12343
12511
  export interface FilterBarBase$SearchEventParameters {
12344
12512
  /**
12345
12513
  * Indicates the initial reason for the search. This can either be:
@@ -12353,6 +12521,9 @@ declare module "sap/ui/mdc/filterbar/FilterBarBase" {
12353
12521
  reason?: /* was: sap.ui.mdc.enums.ReasonMode */ any;
12354
12522
  }
12355
12523
 
12524
+ /**
12525
+ * Event object of the FilterBarBase#search event.
12526
+ */
12356
12527
  export type FilterBarBase$SearchEvent = Event<
12357
12528
  FilterBarBase$SearchEventParameters,
12358
12529
  FilterBarBase
@@ -12624,7 +12795,9 @@ declare module "sap/ui/mdc/filterbar/vh/FilterBar" {
12624
12795
  iFilterFieldThreshold?: int
12625
12796
  ): this;
12626
12797
  }
12627
-
12798
+ /**
12799
+ * Describes the settings that can be provided to the FilterBar constructor.
12800
+ */
12628
12801
  export interface $FilterBarSettings extends $FilterBarBaseSettings {
12629
12802
  /**
12630
12803
  * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
@@ -13059,7 +13232,11 @@ declare module "sap/ui/mdc/FilterField" {
13059
13232
  sPropertyKey?: string
13060
13233
  ): this;
13061
13234
  }
13062
-
13235
+ /**
13236
+ * Describes the settings that can be provided to the FilterField constructor.
13237
+ *
13238
+ * @experimental (since 1.48.0)
13239
+ */
13063
13240
  export interface $FilterFieldSettings extends $FieldBaseSettings {
13064
13241
  /**
13065
13242
  * Supported operator names for conditions.
@@ -13113,6 +13290,9 @@ declare module "sap/ui/mdc/FilterField" {
13113
13290
  change?: (oEvent: FilterField$ChangeEvent) => void;
13114
13291
  }
13115
13292
 
13293
+ /**
13294
+ * Parameters of the FilterField#change event.
13295
+ */
13116
13296
  export interface FilterField$ChangeEventParameters {
13117
13297
  /**
13118
13298
  * The new value of the `control`
@@ -13142,6 +13322,9 @@ declare module "sap/ui/mdc/FilterField" {
13142
13322
  promise?: boolean;
13143
13323
  }
13144
13324
 
13325
+ /**
13326
+ * Event object of the FilterField#change event.
13327
+ */
13145
13328
  export type FilterField$ChangeEvent = Event<
13146
13329
  FilterField$ChangeEventParameters,
13147
13330
  FilterField
@@ -13448,6 +13631,11 @@ declare module "sap/ui/mdc/Link" {
13448
13631
  runtimeType: Promise<LinkType>;
13449
13632
  };
13450
13633
 
13634
+ /**
13635
+ * Describes the settings that can be provided to the Link constructor.
13636
+ *
13637
+ * @experimental (since 1.74.0)
13638
+ */
13451
13639
  export interface $LinkSettings extends $FieldInfoBaseSettings {
13452
13640
  /**
13453
13641
  * Enables/disables the personalization settings for users and key users.
@@ -13810,7 +13998,9 @@ declare module "sap/ui/mdc/link/LinkItem" {
13810
13998
  sText?: string
13811
13999
  ): this;
13812
14000
  }
13813
-
14001
+ /**
14002
+ * Describes the settings that can be provided to the LinkItem constructor.
14003
+ */
13814
14004
  export interface $LinkItemSettings extends $ElementSettings {
13815
14005
  /**
13816
14006
  * Unique key of the `LinkItem` that is used for personalization.
@@ -14159,12 +14349,13 @@ declare module "sap/ui/mdc/MultiValueField" {
14159
14349
  *
14160
14350
  * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
14161
14351
  * The object has the following properties:
14162
- * - `name` defines the path to the `Delegate` module
14352
+ * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/field/MultiValueFieldDelegate MultiValueFieldDelegate}.
14353
+ *
14163
14354
  * - `payload` (optional) defines application-specific information that can be used in the given delegate
14164
14355
  * Sample delegate object:
14165
14356
  * ```javascript
14166
14357
  * {
14167
- * name: "sap/ui/mdc/BaseDelegate",
14358
+ * name: "sap/ui/mdc/field/MultiValueFieldDelegate",
14168
14359
  * payload: {}
14169
14360
  * }```
14170
14361
  * **Note:** Ensure that the related file can be requested (any required library has to be loaded before
@@ -14182,6 +14373,10 @@ declare module "sap/ui/mdc/MultiValueField" {
14182
14373
  * Gets content of aggregation {@link #getItems items}.
14183
14374
  *
14184
14375
  * Items of the `MultiValueField` control.
14376
+ *
14377
+ * The items are not updated by user input or value help selection automatically. That's because an aggregation
14378
+ * binding can only be updated by the model, not by the bound aggregation. Therefore, the {@link module:sap/ui/mdc/field/MultiValueFieldDelegate.updateItems MultiValueFieldDelegate.updateItems }
14379
+ * function needs to be implemented to update the items after a user interaction.
14185
14380
  */
14186
14381
  getItems(): MultiValueFieldItem[];
14187
14382
  /**
@@ -14317,12 +14512,13 @@ declare module "sap/ui/mdc/MultiValueField" {
14317
14512
  *
14318
14513
  * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
14319
14514
  * The object has the following properties:
14320
- * - `name` defines the path to the `Delegate` module
14515
+ * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/field/MultiValueFieldDelegate MultiValueFieldDelegate}.
14516
+ *
14321
14517
  * - `payload` (optional) defines application-specific information that can be used in the given delegate
14322
14518
  * Sample delegate object:
14323
14519
  * ```javascript
14324
14520
  * {
14325
- * name: "sap/ui/mdc/BaseDelegate",
14521
+ * name: "sap/ui/mdc/field/MultiValueFieldDelegate",
14326
14522
  * payload: {}
14327
14523
  * }```
14328
14524
  * **Note:** Ensure that the related file can be requested (any required library has to be loaded before
@@ -14387,17 +14583,22 @@ declare module "sap/ui/mdc/MultiValueField" {
14387
14583
  */
14388
14584
  unbindItems(): this;
14389
14585
  }
14390
-
14586
+ /**
14587
+ * Describes the settings that can be provided to the MultiValueField constructor.
14588
+ *
14589
+ * @experimental (since 1.93.0)
14590
+ */
14391
14591
  export interface $MultiValueFieldSettings extends $FieldBaseSettings {
14392
14592
  /**
14393
14593
  * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
14394
14594
  * The object has the following properties:
14395
- * - `name` defines the path to the `Delegate` module
14595
+ * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/field/MultiValueFieldDelegate MultiValueFieldDelegate}.
14596
+ *
14396
14597
  * - `payload` (optional) defines application-specific information that can be used in the given delegate
14397
14598
  * Sample delegate object:
14398
14599
  * ```javascript
14399
14600
  * {
14400
- * name: "sap/ui/mdc/BaseDelegate",
14601
+ * name: "sap/ui/mdc/field/MultiValueFieldDelegate",
14401
14602
  * payload: {}
14402
14603
  * }```
14403
14604
  * **Note:** Ensure that the related file can be requested (any required library has to be loaded before
@@ -14410,6 +14611,10 @@ declare module "sap/ui/mdc/MultiValueField" {
14410
14611
 
14411
14612
  /**
14412
14613
  * Items of the `MultiValueField` control.
14614
+ *
14615
+ * The items are not updated by user input or value help selection automatically. That's because an aggregation
14616
+ * binding can only be updated by the model, not by the bound aggregation. Therefore, the {@link module:sap/ui/mdc/field/MultiValueFieldDelegate.updateItems MultiValueFieldDelegate.updateItems }
14617
+ * function needs to be implemented to update the items after a user interaction.
14413
14618
  */
14414
14619
  items?:
14415
14620
  | MultiValueFieldItem[]
@@ -14425,6 +14630,9 @@ declare module "sap/ui/mdc/MultiValueField" {
14425
14630
  change?: (oEvent: MultiValueField$ChangeEvent) => void;
14426
14631
  }
14427
14632
 
14633
+ /**
14634
+ * Parameters of the MultiValueField#change event.
14635
+ */
14428
14636
  export interface MultiValueField$ChangeEventParameters {
14429
14637
  /**
14430
14638
  * The new items of the `MultiValueField` control.
@@ -14450,6 +14658,9 @@ declare module "sap/ui/mdc/MultiValueField" {
14450
14658
  promise?: Promise<any>;
14451
14659
  }
14452
14660
 
14661
+ /**
14662
+ * Event object of the MultiValueField#change event.
14663
+ */
14453
14664
  export type MultiValueField$ChangeEvent = Event<
14454
14665
  MultiValueField$ChangeEventParameters,
14455
14666
  MultiValueField
@@ -15395,7 +15606,7 @@ declare module "sap/ui/mdc/Table" {
15395
15606
  *
15396
15607
  * This property has no effect and will be removed soon.
15397
15608
  *
15398
- * @deprecated (since 1.115)
15609
+ * @deprecated (since 1.115) - the concept has been discarded.
15399
15610
  *
15400
15611
  * @returns Value of property `height`
15401
15612
  */
@@ -15638,6 +15849,15 @@ declare module "sap/ui/mdc/Table" {
15638
15849
  * @returns Whether the table is bound
15639
15850
  */
15640
15851
  isTableBound(): boolean;
15852
+ /**
15853
+ * Executes a rebind considering the provided external and inbuilt filtering.
15854
+ *
15855
+ * @since 1.98
15856
+ *
15857
+ * @returns A `Promise` that resolves after rebind is executed, and rejects if rebind cannot be executed,
15858
+ * for example because there are invalid filters.
15859
+ */
15860
+ rebind(): Promise<any>;
15641
15861
  /**
15642
15862
  * Scrolls the table to the row with the given index. Depending on the table type, this might cause additional
15643
15863
  * requests. If the given index is -1, it will scroll to the end of the table based on the length of the
@@ -15976,7 +16196,7 @@ declare module "sap/ui/mdc/Table" {
15976
16196
  *
15977
16197
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
15978
16198
  *
15979
- * @deprecated (since 1.115)
16199
+ * @deprecated (since 1.115) - the concept has been discarded.
15980
16200
  *
15981
16201
  * @returns Reference to `this` in order to allow method chaining
15982
16202
  */
@@ -16376,6 +16596,11 @@ declare module "sap/ui/mdc/Table" {
16376
16596
  propertyInfos?: string[];
16377
16597
  };
16378
16598
 
16599
+ /**
16600
+ * Describes the settings that can be provided to the Table constructor.
16601
+ *
16602
+ * @experimental (since 1.58.0)
16603
+ */
16379
16604
  export interface $TableSettings extends $ControlSettings {
16380
16605
  /**
16381
16606
  * Width of the table.
@@ -16385,7 +16610,7 @@ declare module "sap/ui/mdc/Table" {
16385
16610
  /**
16386
16611
  * This property has no effect and will be removed soon.
16387
16612
  *
16388
- * @deprecated (since 1.115)
16613
+ * @deprecated (since 1.115) - the concept has been discarded.
16389
16614
  */
16390
16615
  height?: CSSSize | PropertyBindingInfo | `{${string}}`;
16391
16616
 
@@ -16823,6 +17048,9 @@ declare module "sap/ui/mdc/Table" {
16823
17048
  beforeOpenContextMenu?: (oEvent: Table$BeforeOpenContextMenuEvent) => void;
16824
17049
  }
16825
17050
 
17051
+ /**
17052
+ * Parameters of the Table#beforeExport event.
17053
+ */
16826
17054
  export interface Table$BeforeExportEventParameters {
16827
17055
  /**
16828
17056
  * Contains `workbook.columns, dataSource`, and other export-related information.
@@ -16843,11 +17071,17 @@ declare module "sap/ui/mdc/Table" {
16843
17071
  filterSettings?: object[];
16844
17072
  }
16845
17073
 
17074
+ /**
17075
+ * Event object of the Table#beforeExport event.
17076
+ */
16846
17077
  export type Table$BeforeExportEvent = Event<
16847
17078
  Table$BeforeExportEventParameters,
16848
17079
  Table
16849
17080
  >;
16850
17081
 
17082
+ /**
17083
+ * Parameters of the Table#beforeOpenContextMenu event.
17084
+ */
16851
17085
  export interface Table$BeforeOpenContextMenuEventParameters {
16852
17086
  /**
16853
17087
  * The binding context
@@ -16863,11 +17097,17 @@ declare module "sap/ui/mdc/Table" {
16863
17097
  column?: Column;
16864
17098
  }
16865
17099
 
17100
+ /**
17101
+ * Event object of the Table#beforeOpenContextMenu event.
17102
+ */
16866
17103
  export type Table$BeforeOpenContextMenuEvent = Event<
16867
17104
  Table$BeforeOpenContextMenuEventParameters,
16868
17105
  Table
16869
17106
  >;
16870
17107
 
17108
+ /**
17109
+ * Parameters of the Table#paste event.
17110
+ */
16871
17111
  export interface Table$PasteEventParameters {
16872
17112
  /**
16873
17113
  * 2D array of strings with data from the clipboard. The first dimension represents the rows, and the second
@@ -16876,8 +17116,14 @@ declare module "sap/ui/mdc/Table" {
16876
17116
  data?: string[][];
16877
17117
  }
16878
17118
 
17119
+ /**
17120
+ * Event object of the Table#paste event.
17121
+ */
16879
17122
  export type Table$PasteEvent = Event<Table$PasteEventParameters, Table>;
16880
17123
 
17124
+ /**
17125
+ * Parameters of the Table#rowPress event.
17126
+ */
16881
17127
  export interface Table$RowPressEventParameters {
16882
17128
  /**
16883
17129
  * The binding context
@@ -16885,8 +17131,14 @@ declare module "sap/ui/mdc/Table" {
16885
17131
  bindingContext?: Context;
16886
17132
  }
16887
17133
 
17134
+ /**
17135
+ * Event object of the Table#rowPress event.
17136
+ */
16888
17137
  export type Table$RowPressEvent = Event<Table$RowPressEventParameters, Table>;
16889
17138
 
17139
+ /**
17140
+ * Parameters of the Table#selectionChange event.
17141
+ */
16890
17142
  export interface Table$SelectionChangeEventParameters {
16891
17143
  /**
16892
17144
  * Identifies whether the Select All checkbox was pressed
@@ -16894,6 +17146,9 @@ declare module "sap/ui/mdc/Table" {
16894
17146
  selectAll?: boolean;
16895
17147
  }
16896
17148
 
17149
+ /**
17150
+ * Event object of the Table#selectionChange event.
17151
+ */
16897
17152
  export type Table$SelectionChangeEvent = Event<
16898
17153
  Table$SelectionChangeEventParameters,
16899
17154
  Table
@@ -17489,7 +17744,9 @@ declare module "sap/ui/mdc/table/Column" {
17489
17744
  sWidth?: CSSSize
17490
17745
  ): this;
17491
17746
  }
17492
-
17747
+ /**
17748
+ * Describes the settings that can be provided to the Column constructor.
17749
+ */
17493
17750
  export interface $ColumnSettings extends $ControlSettings {
17494
17751
  /**
17495
17752
  * Defines the width of the column.
@@ -17682,7 +17939,9 @@ declare module "sap/ui/mdc/table/ColumnSettings" {
17682
17939
  */
17683
17940
  static getMetadata(): ElementMetadata;
17684
17941
  }
17685
-
17942
+ /**
17943
+ * Describes the settings that can be provided to the ColumnSettings constructor.
17944
+ */
17686
17945
  export interface $ColumnSettingsSettings extends $ElementSettings {}
17687
17946
  }
17688
17947
 
@@ -18304,6 +18563,9 @@ declare module "sap/ui/mdc/table/DragDropConfig" {
18304
18563
 
18305
18564
  export type DragSource = Context | UI5Element;
18306
18565
 
18566
+ /**
18567
+ * Describes the settings that can be provided to the DragDropConfig constructor.
18568
+ */
18307
18569
  export interface $DragDropConfigSettings extends $DragDropBaseSettings {
18308
18570
  /**
18309
18571
  * Determines whether the rows of the table are draggable.
@@ -18365,6 +18627,9 @@ declare module "sap/ui/mdc/table/DragDropConfig" {
18365
18627
  drop?: (oEvent: DragDropConfig$DropEvent) => void;
18366
18628
  }
18367
18629
 
18630
+ /**
18631
+ * Parameters of the DragDropConfig#dragEnd event.
18632
+ */
18368
18633
  export interface DragDropConfig$DragEndEventParameters {
18369
18634
  /**
18370
18635
  * The binding context of the dragged row
@@ -18372,11 +18637,17 @@ declare module "sap/ui/mdc/table/DragDropConfig" {
18372
18637
  bindingContext?: Context;
18373
18638
  }
18374
18639
 
18640
+ /**
18641
+ * Event object of the DragDropConfig#dragEnd event.
18642
+ */
18375
18643
  export type DragDropConfig$DragEndEvent = Event<
18376
18644
  DragDropConfig$DragEndEventParameters,
18377
18645
  DragDropConfig
18378
18646
  >;
18379
18647
 
18648
+ /**
18649
+ * Parameters of the DragDropConfig#dragEnter event.
18650
+ */
18380
18651
  export interface DragDropConfig$DragEnterEventParameters {
18381
18652
  /**
18382
18653
  * The binding context of the row on which the dragged element will be dropped
@@ -18389,11 +18660,17 @@ declare module "sap/ui/mdc/table/DragDropConfig" {
18389
18660
  dragSource?: DragSource;
18390
18661
  }
18391
18662
 
18663
+ /**
18664
+ * Event object of the DragDropConfig#dragEnter event.
18665
+ */
18392
18666
  export type DragDropConfig$DragEnterEvent = Event<
18393
18667
  DragDropConfig$DragEnterEventParameters,
18394
18668
  DragDropConfig
18395
18669
  >;
18396
18670
 
18671
+ /**
18672
+ * Parameters of the DragDropConfig#dragOver event.
18673
+ */
18397
18674
  export interface DragDropConfig$DragOverEventParameters {
18398
18675
  /**
18399
18676
  * The binding context of the row on which the dragged element will be dropped
@@ -18413,11 +18690,17 @@ declare module "sap/ui/mdc/table/DragDropConfig" {
18413
18690
  | keyof typeof dnd.RelativeDropPosition;
18414
18691
  }
18415
18692
 
18693
+ /**
18694
+ * Event object of the DragDropConfig#dragOver event.
18695
+ */
18416
18696
  export type DragDropConfig$DragOverEvent = Event<
18417
18697
  DragDropConfig$DragOverEventParameters,
18418
18698
  DragDropConfig
18419
18699
  >;
18420
18700
 
18701
+ /**
18702
+ * Parameters of the DragDropConfig#dragStart event.
18703
+ */
18421
18704
  export interface DragDropConfig$DragStartEventParameters {
18422
18705
  /**
18423
18706
  * The binding context of the dragged row
@@ -18425,11 +18708,17 @@ declare module "sap/ui/mdc/table/DragDropConfig" {
18425
18708
  bindingContext?: Context;
18426
18709
  }
18427
18710
 
18711
+ /**
18712
+ * Event object of the DragDropConfig#dragStart event.
18713
+ */
18428
18714
  export type DragDropConfig$DragStartEvent = Event<
18429
18715
  DragDropConfig$DragStartEventParameters,
18430
18716
  DragDropConfig
18431
18717
  >;
18432
18718
 
18719
+ /**
18720
+ * Parameters of the DragDropConfig#drop event.
18721
+ */
18433
18722
  export interface DragDropConfig$DropEventParameters {
18434
18723
  /**
18435
18724
  * The binding context of the row on which the dragged element is dropped
@@ -18449,6 +18738,9 @@ declare module "sap/ui/mdc/table/DragDropConfig" {
18449
18738
  | keyof typeof dnd.RelativeDropPosition;
18450
18739
  }
18451
18740
 
18741
+ /**
18742
+ * Event object of the DragDropConfig#drop event.
18743
+ */
18452
18744
  export type DragDropConfig$DropEvent = Event<
18453
18745
  DragDropConfig$DropEventParameters,
18454
18746
  DragDropConfig
@@ -18705,7 +18997,9 @@ declare module "sap/ui/mdc/table/GridTableType" {
18705
18997
  bShowHeaderSelector?: boolean
18706
18998
  ): this;
18707
18999
  }
18708
-
19000
+ /**
19001
+ * Describes the settings that can be provided to the GridTableType constructor.
19002
+ */
18709
19003
  export interface $GridTableTypeSettings extends $TableTypeBaseSettings {
18710
19004
  /**
18711
19005
  * Defines how the table handles the row count.
@@ -18882,7 +19176,9 @@ declare module "sap/ui/mdc/table/ResponsiveColumnSettings" {
18882
19176
  sMergeFunction: string
18883
19177
  ): this;
18884
19178
  }
18885
-
19179
+ /**
19180
+ * Describes the settings that can be provided to the ResponsiveColumnSettings constructor.
19181
+ */
18886
19182
  export interface $ResponsiveColumnSettingsSettings
18887
19183
  extends $ColumnSettingsSettings {
18888
19184
  /**
@@ -19140,7 +19436,9 @@ declare module "sap/ui/mdc/table/ResponsiveTableType" {
19140
19436
  bShowDetailsButton?: boolean
19141
19437
  ): this;
19142
19438
  }
19143
-
19439
+ /**
19440
+ * Describes the settings that can be provided to the ResponsiveTableType constructor.
19441
+ */
19144
19442
  export interface $ResponsiveTableTypeSettings extends $TableTypeBaseSettings {
19145
19443
  /**
19146
19444
  * Specifies the growing mode.
@@ -19482,7 +19780,9 @@ declare module "sap/ui/mdc/table/RowActionItem" {
19482
19780
  bVisible?: boolean
19483
19781
  ): this;
19484
19782
  }
19485
-
19783
+ /**
19784
+ * Describes the settings that can be provided to the RowActionItem constructor.
19785
+ */
19486
19786
  export interface $RowActionItemSettings extends $ElementSettings {
19487
19787
  /**
19488
19788
  * Type of the row action item.
@@ -19526,6 +19826,9 @@ declare module "sap/ui/mdc/table/RowActionItem" {
19526
19826
  press?: (oEvent: RowActionItem$PressEvent) => void;
19527
19827
  }
19528
19828
 
19829
+ /**
19830
+ * Parameters of the RowActionItem#press event.
19831
+ */
19529
19832
  export interface RowActionItem$PressEventParameters {
19530
19833
  /**
19531
19834
  * The binding context of the pressed row action
@@ -19533,6 +19836,9 @@ declare module "sap/ui/mdc/table/RowActionItem" {
19533
19836
  bindingContext?: Context;
19534
19837
  }
19535
19838
 
19839
+ /**
19840
+ * Event object of the RowActionItem#press event.
19841
+ */
19536
19842
  export type RowActionItem$PressEvent = Event<
19537
19843
  RowActionItem$PressEventParameters,
19538
19844
  RowActionItem
@@ -19813,7 +20119,9 @@ declare module "sap/ui/mdc/table/RowSettings" {
19813
20119
  bNavigated?: boolean
19814
20120
  ): this;
19815
20121
  }
19816
-
20122
+ /**
20123
+ * Describes the settings that can be provided to the RowSettings constructor.
20124
+ */
19817
20125
  export interface $RowSettingsSettings extends $ElementSettings {
19818
20126
  /**
19819
20127
  * The highlight state of the rows.
@@ -19935,7 +20243,9 @@ declare module "sap/ui/mdc/table/TableTypeBase" {
19935
20243
  */
19936
20244
  static getMetadata(): ElementMetadata;
19937
20245
  }
19938
-
20246
+ /**
20247
+ * Describes the settings that can be provided to the TableTypeBase constructor.
20248
+ */
19939
20249
  export interface $TableTypeBaseSettings extends $ElementSettings {}
19940
20250
  }
19941
20251
 
@@ -20022,7 +20332,9 @@ declare module "sap/ui/mdc/table/TreeTableType" {
20022
20332
  */
20023
20333
  static getMetadata(): ElementMetadata;
20024
20334
  }
20025
-
20335
+ /**
20336
+ * Describes the settings that can be provided to the TreeTableType constructor.
20337
+ */
20026
20338
  export interface $TreeTableTypeSettings extends $GridTableTypeSettings {}
20027
20339
  }
20028
20340
 
@@ -21114,6 +21426,11 @@ declare module "sap/ui/mdc/ValueHelp" {
21114
21426
  control: Control;
21115
21427
  };
21116
21428
 
21429
+ /**
21430
+ * Describes the settings that can be provided to the ValueHelp constructor.
21431
+ *
21432
+ * @experimental (since 1.95.0)
21433
+ */
21117
21434
  export interface $ValueHelpSettings extends $ElementSettings {
21118
21435
  /**
21119
21436
  * The conditions of the selected items.
@@ -21225,20 +21542,35 @@ declare module "sap/ui/mdc/ValueHelp" {
21225
21542
  typeaheadSuggested?: (oEvent: ValueHelp$TypeaheadSuggestedEvent) => void;
21226
21543
  }
21227
21544
 
21545
+ /**
21546
+ * Parameters of the ValueHelp#closed event.
21547
+ */
21228
21548
  export interface ValueHelp$ClosedEventParameters {}
21229
21549
 
21550
+ /**
21551
+ * Event object of the ValueHelp#closed event.
21552
+ */
21230
21553
  export type ValueHelp$ClosedEvent = Event<
21231
21554
  ValueHelp$ClosedEventParameters,
21232
21555
  ValueHelp
21233
21556
  >;
21234
21557
 
21558
+ /**
21559
+ * Parameters of the ValueHelp#disconnect event.
21560
+ */
21235
21561
  export interface ValueHelp$DisconnectEventParameters {}
21236
21562
 
21563
+ /**
21564
+ * Event object of the ValueHelp#disconnect event.
21565
+ */
21237
21566
  export type ValueHelp$DisconnectEvent = Event<
21238
21567
  ValueHelp$DisconnectEventParameters,
21239
21568
  ValueHelp
21240
21569
  >;
21241
21570
 
21571
+ /**
21572
+ * Parameters of the ValueHelp#navigated event.
21573
+ */
21242
21574
  export interface ValueHelp$NavigatedEventParameters {
21243
21575
  /**
21244
21576
  * True if the focus should be set back to the field.
@@ -21258,11 +21590,17 @@ declare module "sap/ui/mdc/ValueHelp" {
21258
21590
  itemId?: string;
21259
21591
  }
21260
21592
 
21593
+ /**
21594
+ * Event object of the ValueHelp#navigated event.
21595
+ */
21261
21596
  export type ValueHelp$NavigatedEvent = Event<
21262
21597
  ValueHelp$NavigatedEventParameters,
21263
21598
  ValueHelp
21264
21599
  >;
21265
21600
 
21601
+ /**
21602
+ * Parameters of the ValueHelp#open event.
21603
+ */
21266
21604
  export interface ValueHelp$OpenEventParameters {
21267
21605
  /**
21268
21606
  * The container which will be opened
@@ -21270,11 +21608,17 @@ declare module "sap/ui/mdc/ValueHelp" {
21270
21608
  container?: Container;
21271
21609
  }
21272
21610
 
21611
+ /**
21612
+ * Event object of the ValueHelp#open event.
21613
+ */
21273
21614
  export type ValueHelp$OpenEvent = Event<
21274
21615
  ValueHelp$OpenEventParameters,
21275
21616
  ValueHelp
21276
21617
  >;
21277
21618
 
21619
+ /**
21620
+ * Parameters of the ValueHelp#opened event.
21621
+ */
21278
21622
  export interface ValueHelp$OpenedEventParameters {
21279
21623
  /**
21280
21624
  * The container which was opened
@@ -21287,11 +21631,17 @@ declare module "sap/ui/mdc/ValueHelp" {
21287
21631
  itemId?: string;
21288
21632
  }
21289
21633
 
21634
+ /**
21635
+ * Event object of the ValueHelp#opened event.
21636
+ */
21290
21637
  export type ValueHelp$OpenedEvent = Event<
21291
21638
  ValueHelp$OpenedEventParameters,
21292
21639
  ValueHelp
21293
21640
  >;
21294
21641
 
21642
+ /**
21643
+ * Parameters of the ValueHelp#select event.
21644
+ */
21295
21645
  export interface ValueHelp$SelectEventParameters {
21296
21646
  /**
21297
21647
  * The selected `conditions`
@@ -21312,18 +21662,30 @@ declare module "sap/ui/mdc/ValueHelp" {
21312
21662
  close?: boolean;
21313
21663
  }
21314
21664
 
21665
+ /**
21666
+ * Event object of the ValueHelp#select event.
21667
+ */
21315
21668
  export type ValueHelp$SelectEvent = Event<
21316
21669
  ValueHelp$SelectEventParameters,
21317
21670
  ValueHelp
21318
21671
  >;
21319
21672
 
21673
+ /**
21674
+ * Parameters of the ValueHelp#switchToValueHelp event.
21675
+ */
21320
21676
  export interface ValueHelp$SwitchToValueHelpEventParameters {}
21321
21677
 
21678
+ /**
21679
+ * Event object of the ValueHelp#switchToValueHelp event.
21680
+ */
21322
21681
  export type ValueHelp$SwitchToValueHelpEvent = Event<
21323
21682
  ValueHelp$SwitchToValueHelpEventParameters,
21324
21683
  ValueHelp
21325
21684
  >;
21326
21685
 
21686
+ /**
21687
+ * Parameters of the ValueHelp#typeaheadSuggested event.
21688
+ */
21327
21689
  export interface ValueHelp$TypeaheadSuggestedEventParameters {
21328
21690
  /**
21329
21691
  * Suggested condition
@@ -21348,6 +21710,9 @@ declare module "sap/ui/mdc/ValueHelp" {
21348
21710
  caseSensitive?: boolean;
21349
21711
  }
21350
21712
 
21713
+ /**
21714
+ * Event object of the ValueHelp#typeaheadSuggested event.
21715
+ */
21351
21716
  export type ValueHelp$TypeaheadSuggestedEvent = Event<
21352
21717
  ValueHelp$TypeaheadSuggestedEventParameters,
21353
21718
  ValueHelp
@@ -22551,7 +22916,9 @@ declare module "sap/ui/mdc/valuehelp/base/Container" {
22551
22916
  oContent: Content
22552
22917
  ): void;
22553
22918
  }
22554
-
22919
+ /**
22920
+ * Describes the settings that can be provided to the Container constructor.
22921
+ */
22555
22922
  export interface $ContainerSettings extends $ElementSettings {
22556
22923
  /**
22557
22924
  * Title text that appears in the dialog or tab header.
@@ -22620,20 +22987,35 @@ declare module "sap/ui/mdc/valuehelp/base/Container" {
22620
22987
  typeaheadSuggested?: (oEvent: Container$TypeaheadSuggestedEvent) => void;
22621
22988
  }
22622
22989
 
22990
+ /**
22991
+ * Parameters of the Container#cancel event.
22992
+ */
22623
22993
  export interface Container$CancelEventParameters {}
22624
22994
 
22995
+ /**
22996
+ * Event object of the Container#cancel event.
22997
+ */
22625
22998
  export type Container$CancelEvent = Event<
22626
22999
  Container$CancelEventParameters,
22627
23000
  Container
22628
23001
  >;
22629
23002
 
23003
+ /**
23004
+ * Parameters of the Container#closed event.
23005
+ */
22630
23006
  export interface Container$ClosedEventParameters {}
22631
23007
 
23008
+ /**
23009
+ * Event object of the Container#closed event.
23010
+ */
22632
23011
  export type Container$ClosedEvent = Event<
22633
23012
  Container$ClosedEventParameters,
22634
23013
  Container
22635
23014
  >;
22636
23015
 
23016
+ /**
23017
+ * Parameters of the Container#confirm event.
23018
+ */
22637
23019
  export interface Container$ConfirmEventParameters {
22638
23020
  /**
22639
23021
  * `true` if the value help needs to be closed
@@ -22641,11 +23023,17 @@ declare module "sap/ui/mdc/valuehelp/base/Container" {
22641
23023
  close?: boolean;
22642
23024
  }
22643
23025
 
23026
+ /**
23027
+ * Event object of the Container#confirm event.
23028
+ */
22644
23029
  export type Container$ConfirmEvent = Event<
22645
23030
  Container$ConfirmEventParameters,
22646
23031
  Container
22647
23032
  >;
22648
23033
 
23034
+ /**
23035
+ * Parameters of the Container#navigated event.
23036
+ */
22649
23037
  export interface Container$NavigatedEventParameters {
22650
23038
  /**
22651
23039
  * `true` if the focus should be set back to the field.
@@ -22665,11 +23053,17 @@ declare module "sap/ui/mdc/valuehelp/base/Container" {
22665
23053
  itemId?: string;
22666
23054
  }
22667
23055
 
23056
+ /**
23057
+ * Event object of the Container#navigated event.
23058
+ */
22668
23059
  export type Container$NavigatedEvent = Event<
22669
23060
  Container$NavigatedEventParameters,
22670
23061
  Container
22671
23062
  >;
22672
23063
 
23064
+ /**
23065
+ * Parameters of the Container#opened event.
23066
+ */
22673
23067
  export interface Container$OpenedEventParameters {
22674
23068
  /**
22675
23069
  * ID of the initially selected item
@@ -22677,11 +23071,17 @@ declare module "sap/ui/mdc/valuehelp/base/Container" {
22677
23071
  itemId?: string;
22678
23072
  }
22679
23073
 
23074
+ /**
23075
+ * Event object of the Container#opened event.
23076
+ */
22680
23077
  export type Container$OpenedEvent = Event<
22681
23078
  Container$OpenedEventParameters,
22682
23079
  Container
22683
23080
  >;
22684
23081
 
23082
+ /**
23083
+ * Parameters of the Container#requestDelegateContent event.
23084
+ */
22685
23085
  export interface Container$RequestDelegateContentEventParameters {
22686
23086
  /**
22687
23087
  * Content wrapper ID for which contents are requested
@@ -22689,18 +23089,30 @@ declare module "sap/ui/mdc/valuehelp/base/Container" {
22689
23089
  contentId?: string;
22690
23090
  }
22691
23091
 
23092
+ /**
23093
+ * Event object of the Container#requestDelegateContent event.
23094
+ */
22692
23095
  export type Container$RequestDelegateContentEvent = Event<
22693
23096
  Container$RequestDelegateContentEventParameters,
22694
23097
  Container
22695
23098
  >;
22696
23099
 
23100
+ /**
23101
+ * Parameters of the Container#requestSwitchToDialog event.
23102
+ */
22697
23103
  export interface Container$RequestSwitchToDialogEventParameters {}
22698
23104
 
23105
+ /**
23106
+ * Event object of the Container#requestSwitchToDialog event.
23107
+ */
22699
23108
  export type Container$RequestSwitchToDialogEvent = Event<
22700
23109
  Container$RequestSwitchToDialogEventParameters,
22701
23110
  Container
22702
23111
  >;
22703
23112
 
23113
+ /**
23114
+ * Parameters of the Container#select event.
23115
+ */
22704
23116
  export interface Container$SelectEventParameters {
22705
23117
  /**
22706
23118
  * Type of the selection change (add, remove)
@@ -22715,11 +23127,17 @@ declare module "sap/ui/mdc/valuehelp/base/Container" {
22715
23127
  conditions?: object[];
22716
23128
  }
22717
23129
 
23130
+ /**
23131
+ * Event object of the Container#select event.
23132
+ */
22718
23133
  export type Container$SelectEvent = Event<
22719
23134
  Container$SelectEventParameters,
22720
23135
  Container
22721
23136
  >;
22722
23137
 
23138
+ /**
23139
+ * Parameters of the Container#typeaheadSuggested event.
23140
+ */
22723
23141
  export interface Container$TypeaheadSuggestedEventParameters {
22724
23142
  /**
22725
23143
  * Suggested condition
@@ -22744,6 +23162,9 @@ declare module "sap/ui/mdc/valuehelp/base/Container" {
22744
23162
  caseSensitive?: boolean;
22745
23163
  }
22746
23164
 
23165
+ /**
23166
+ * Event object of the Container#typeaheadSuggested event.
23167
+ */
22747
23168
  export type Container$TypeaheadSuggestedEvent = Event<
22748
23169
  Container$TypeaheadSuggestedEventParameters,
22749
23170
  Container
@@ -23725,7 +24146,9 @@ declare module "sap/ui/mdc/valuehelp/base/Content" {
23725
24146
  bVisible?: boolean
23726
24147
  ): this;
23727
24148
  }
23728
-
24149
+ /**
24150
+ * Describes the settings that can be provided to the Content constructor.
24151
+ */
23729
24152
  export interface $ContentSettings extends $ElementSettings {
23730
24153
  /**
23731
24154
  * Title text that appears in the tab header.
@@ -23808,13 +24231,22 @@ declare module "sap/ui/mdc/valuehelp/base/Content" {
23808
24231
  typeaheadSuggested?: (oEvent: Content$TypeaheadSuggestedEvent) => void;
23809
24232
  }
23810
24233
 
24234
+ /**
24235
+ * Parameters of the Content#cancel event.
24236
+ */
23811
24237
  export interface Content$CancelEventParameters {}
23812
24238
 
24239
+ /**
24240
+ * Event object of the Content#cancel event.
24241
+ */
23813
24242
  export type Content$CancelEvent = Event<
23814
24243
  Content$CancelEventParameters,
23815
24244
  Content
23816
24245
  >;
23817
24246
 
24247
+ /**
24248
+ * Parameters of the Content#confirm event.
24249
+ */
23818
24250
  export interface Content$ConfirmEventParameters {
23819
24251
  /**
23820
24252
  * `true` if the value help needs to be closed
@@ -23822,11 +24254,17 @@ declare module "sap/ui/mdc/valuehelp/base/Content" {
23822
24254
  close?: boolean;
23823
24255
  }
23824
24256
 
24257
+ /**
24258
+ * Event object of the Content#confirm event.
24259
+ */
23825
24260
  export type Content$ConfirmEvent = Event<
23826
24261
  Content$ConfirmEventParameters,
23827
24262
  Content
23828
24263
  >;
23829
24264
 
24265
+ /**
24266
+ * Parameters of the Content#navigated event.
24267
+ */
23830
24268
  export interface Content$NavigatedEventParameters {
23831
24269
  /**
23832
24270
  * `true` if the focus should be set back to the field.
@@ -23846,18 +24284,30 @@ declare module "sap/ui/mdc/valuehelp/base/Content" {
23846
24284
  itemId?: string;
23847
24285
  }
23848
24286
 
24287
+ /**
24288
+ * Event object of the Content#navigated event.
24289
+ */
23849
24290
  export type Content$NavigatedEvent = Event<
23850
24291
  Content$NavigatedEventParameters,
23851
24292
  Content
23852
24293
  >;
23853
24294
 
24295
+ /**
24296
+ * Parameters of the Content#requestSwitchToDialog event.
24297
+ */
23854
24298
  export interface Content$RequestSwitchToDialogEventParameters {}
23855
24299
 
24300
+ /**
24301
+ * Event object of the Content#requestSwitchToDialog event.
24302
+ */
23856
24303
  export type Content$RequestSwitchToDialogEvent = Event<
23857
24304
  Content$RequestSwitchToDialogEventParameters,
23858
24305
  Content
23859
24306
  >;
23860
24307
 
24308
+ /**
24309
+ * Parameters of the Content#select event.
24310
+ */
23861
24311
  export interface Content$SelectEventParameters {
23862
24312
  /**
23863
24313
  * Type of the selection change (add, remove)
@@ -23872,11 +24322,17 @@ declare module "sap/ui/mdc/valuehelp/base/Content" {
23872
24322
  conditions?: object[];
23873
24323
  }
23874
24324
 
24325
+ /**
24326
+ * Event object of the Content#select event.
24327
+ */
23875
24328
  export type Content$SelectEvent = Event<
23876
24329
  Content$SelectEventParameters,
23877
24330
  Content
23878
24331
  >;
23879
24332
 
24333
+ /**
24334
+ * Parameters of the Content#typeaheadSuggested event.
24335
+ */
23880
24336
  export interface Content$TypeaheadSuggestedEventParameters {
23881
24337
  /**
23882
24338
  * Suggested condition
@@ -23901,6 +24357,9 @@ declare module "sap/ui/mdc/valuehelp/base/Content" {
23901
24357
  caseSensitive?: boolean;
23902
24358
  }
23903
24359
 
24360
+ /**
24361
+ * Event object of the Content#typeaheadSuggested event.
24362
+ */
23904
24363
  export type Content$TypeaheadSuggestedEvent = Event<
23905
24364
  Content$TypeaheadSuggestedEventParameters,
23906
24365
  Content
@@ -24246,7 +24705,9 @@ declare module "sap/ui/mdc/valuehelp/base/FilterableListContent" {
24246
24705
  sKeyPath?: string
24247
24706
  ): this;
24248
24707
  }
24249
-
24708
+ /**
24709
+ * Describes the settings that can be provided to the FilterableListContent constructor.
24710
+ */
24250
24711
  export interface $FilterableListContentSettings extends $ListContentSettings {
24251
24712
  /**
24252
24713
  * The fields based on which the table data is filtered. For filtering, the value of the `filterValue` property
@@ -24301,10 +24762,6 @@ declare module "sap/ui/mdc/valuehelp/base/ListContent" {
24301
24762
 
24302
24763
  import ElementMetadata from "sap/ui/core/ElementMetadata";
24303
24764
 
24304
- import { ItemForValueConfiguration } from "sap/ui/mdc/ValueHelp";
24305
-
24306
- import Context from "sap/ui/model/Context";
24307
-
24308
24765
  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
24309
24766
 
24310
24767
  /**
@@ -24395,26 +24852,26 @@ declare module "sap/ui/mdc/valuehelp/base/ListContent" {
24395
24852
  */
24396
24853
  getCaseSensitive(): boolean;
24397
24854
  /**
24398
- * Gets the `ListBinding` of the content.
24855
+ * Gets current descriptionPath of the content. **Note:** Every listcontent must implement this method.
24399
24856
  *
24400
- * @ui5-protected Do not call from applications (only from related classes in the framework)
24401
24857
  *
24402
- * @returns `ListBinding`
24858
+ * @returns Content description path
24403
24859
  */
24404
- getListBinding(): ListBinding;
24860
+ getDescriptionPath(): string;
24405
24861
  /**
24406
- * Gets the relevant `BindingContexts` of the content.
24862
+ * Gets current keyPath of the content. **Note:** Every listcontent must implement this method.
24407
24863
  *
24408
- * @ui5-protected Do not call from applications (only from related classes in the framework)
24409
24864
  *
24410
- * @returns `BindingContexts`
24865
+ * @returns Content key path
24411
24866
  */
24412
- getRelevantContexts(
24413
- /**
24414
- * Configuration
24415
- */
24416
- oConfig: ItemForValueConfiguration
24417
- ): Context[];
24867
+ getKeyPath(): string;
24868
+ /**
24869
+ * Gets the `ListBinding` of the content. **Note:** Every listcontent must implement this method.
24870
+ *
24871
+ *
24872
+ * @returns `ListBinding`
24873
+ */
24874
+ getListBinding(): ListBinding;
24418
24875
  /**
24419
24876
  * Gets current value of property {@link #getUseAsValueHelp useAsValueHelp}.
24420
24877
  *
@@ -24508,7 +24965,9 @@ declare module "sap/ui/mdc/valuehelp/base/ListContent" {
24508
24965
  bUseFirstMatch?: boolean
24509
24966
  ): this;
24510
24967
  }
24511
-
24968
+ /**
24969
+ * Describes the settings that can be provided to the ListContent constructor.
24970
+ */
24512
24971
  export interface $ListContentSettings extends $ContentSettings {
24513
24972
  /**
24514
24973
  * If this property is set to `true`, the filtering for user input is always case-sensitive. Otherwise user
@@ -24684,7 +25143,9 @@ declare module "sap/ui/mdc/valuehelp/content/Conditions" {
24684
25143
  oValueHelp: ID | ValueHelp
24685
25144
  ): this;
24686
25145
  }
24687
-
25146
+ /**
25147
+ * Describes the settings that can be provided to the Conditions constructor.
25148
+ */
24688
25149
  export interface $ConditionsSettings extends $ContentSettings {
24689
25150
  /**
24690
25151
  * Label shown on condition panel.
@@ -24959,7 +25420,9 @@ declare module "sap/ui/mdc/valuehelp/content/FixedList" {
24959
25420
  bGroupable?: boolean
24960
25421
  ): this;
24961
25422
  }
24962
-
25423
+ /**
25424
+ * Describes the settings that can be provided to the FixedList constructor.
25425
+ */
24963
25426
  export interface $FixedListSettings extends $ListContentSettings {
24964
25427
  /**
24965
25428
  * If set, the items of the list can be grouped
@@ -25120,7 +25583,9 @@ declare module "sap/ui/mdc/valuehelp/content/FixedListItem" {
25120
25583
  sGroupText?: string
25121
25584
  ): this;
25122
25585
  }
25123
-
25586
+ /**
25587
+ * Describes the settings that can be provided to the FixedListItem constructor.
25588
+ */
25124
25589
  export interface $FixedListItemSettings extends $ListItemSettings {
25125
25590
  /**
25126
25591
  * Key of the group for what the items are grouped
@@ -25287,7 +25752,9 @@ declare module "sap/ui/mdc/valuehelp/Dialog" {
25287
25752
  oGroupConfig?: object
25288
25753
  ): this;
25289
25754
  }
25290
-
25755
+ /**
25756
+ * Describes the settings that can be provided to the Dialog constructor.
25757
+ */
25291
25758
  export interface $DialogSettings extends $ContainerSettings {
25292
25759
  /**
25293
25760
  * Configuration for groups (collective search).
@@ -25454,7 +25921,9 @@ declare module "sap/ui/mdc/valuehelp/content/MDCTable" {
25454
25921
  oTable: Table
25455
25922
  ): this;
25456
25923
  }
25457
-
25924
+ /**
25925
+ * Describes the settings that can be provided to the MDCTable constructor.
25926
+ */
25458
25927
  export interface $MDCTableSettings extends $FilterableListContentSettings {
25459
25928
  /**
25460
25929
  * This property will lead to a rebind on newly inserted tables after initial filters are set, immediately
@@ -25676,7 +26145,9 @@ declare module "sap/ui/mdc/valuehelp/content/MTable" {
25676
26145
  oTable: Table
25677
26146
  ): this;
25678
26147
  }
25679
-
26148
+ /**
26149
+ * Describes the settings that can be provided to the MTable constructor.
26150
+ */
25680
26151
  export interface $MTableSettings extends $FilterableListContentSettings {
25681
26152
  /**
25682
26153
  * Table that is used in the value help.
@@ -25699,8 +26170,18 @@ declare module "sap/ui/mdc/valuehelp/content/MTable" {
25699
26170
  contentUpdated?: (oEvent: Event) => void;
25700
26171
  }
25701
26172
 
26173
+ /**
26174
+ * Parameters of the MTable#contentUpdated event.
26175
+ *
26176
+ * @deprecated (since 1.118.0) - This event is not fired or consumed anymore
26177
+ */
25702
26178
  export interface MTable$ContentUpdatedEventParameters {}
25703
26179
 
26180
+ /**
26181
+ * Event object of the MTable#contentUpdated event.
26182
+ *
26183
+ * @deprecated (since 1.118.0) - This event is not fired or consumed anymore
26184
+ */
25704
26185
  export type MTable$ContentUpdatedEvent = Event<
25705
26186
  MTable$ContentUpdatedEventParameters,
25706
26187
  MTable
@@ -25873,7 +26354,9 @@ declare module "sap/ui/mdc/valuehelp/Popover" {
25873
26354
  bOpensOnFocus?: boolean
25874
26355
  ): this;
25875
26356
  }
25876
-
26357
+ /**
26358
+ * Describes the settings that can be provided to the Popover constructor.
26359
+ */
25877
26360
  export interface $PopoverSettings extends $ContainerSettings {
25878
26361
  /**
25879
26362
  * Controls the possibility to open this popover container by clicking on a connected control, even if no