@sapui5/ts-types 1.120.8 → 1.121.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.
Files changed (65) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +1 -0
  3. package/types/sap.apf.d.ts +50 -18
  4. package/types/sap.ca.ui.d.ts +1114 -546
  5. package/types/sap.chart.d.ts +17 -1
  6. package/types/sap.collaboration.d.ts +185 -64
  7. package/types/sap.esh.search.ui.d.ts +2 -1960
  8. package/types/sap.f.d.ts +124 -45
  9. package/types/sap.fe.core.d.ts +212 -191
  10. package/types/sap.fe.macros.d.ts +371 -531
  11. package/types/sap.fe.navigation.d.ts +59 -26
  12. package/types/sap.fe.placeholder.d.ts +1 -1
  13. package/types/sap.fe.plugins.managecache.d.ts +7 -0
  14. package/types/sap.fe.templates.d.ts +16 -11
  15. package/types/sap.fe.test.d.ts +333 -33
  16. package/types/sap.fe.tools.d.ts +1 -1
  17. package/types/sap.feedback.ui.d.ts +1 -1
  18. package/types/sap.gantt.d.ts +3947 -1754
  19. package/types/sap.insights.d.ts +162 -43
  20. package/types/sap.m.d.ts +2023 -289
  21. package/types/sap.makit.d.ts +11 -1
  22. package/types/sap.me.d.ts +7 -1
  23. package/types/sap.ndc.d.ts +1 -1
  24. package/types/sap.ovp.d.ts +9 -7
  25. package/types/sap.rules.ui.d.ts +134 -75
  26. package/types/sap.sac.df.d.ts +272 -49
  27. package/types/sap.suite.ui.commons.d.ts +4231 -1008
  28. package/types/sap.suite.ui.generic.template.d.ts +38 -48
  29. package/types/sap.suite.ui.microchart.d.ts +66 -1
  30. package/types/sap.tnt.d.ts +601 -116
  31. package/types/sap.ui.codeeditor.d.ts +10 -6
  32. package/types/sap.ui.commons.d.ts +86 -8
  33. package/types/sap.ui.comp.d.ts +259 -110
  34. package/types/sap.ui.core.d.ts +471 -186
  35. package/types/sap.ui.dt.d.ts +1 -1
  36. package/types/sap.ui.export.d.ts +16 -3
  37. package/types/sap.ui.fl.d.ts +91 -68
  38. package/types/sap.ui.generic.app.d.ts +250 -193
  39. package/types/sap.ui.generic.template.d.ts +1 -1
  40. package/types/sap.ui.integration.d.ts +51 -4
  41. package/types/sap.ui.layout.d.ts +221 -26
  42. package/types/sap.ui.mdc.d.ts +1516 -787
  43. package/types/sap.ui.richtexteditor.d.ts +4 -1
  44. package/types/sap.ui.rta.d.ts +1 -1
  45. package/types/sap.ui.suite.d.ts +3 -1
  46. package/types/sap.ui.support.d.ts +28 -4
  47. package/types/sap.ui.table.d.ts +65 -11
  48. package/types/sap.ui.testrecorder.d.ts +1 -1
  49. package/types/sap.ui.unified.d.ts +157 -54
  50. package/types/sap.ui.ux3.d.ts +30 -12
  51. package/types/sap.ui.vbm.d.ts +5300 -2517
  52. package/types/sap.ui.vk.d.ts +2742 -836
  53. package/types/sap.ui.vtm.d.ts +685 -215
  54. package/types/sap.ui.webc.common.d.ts +1 -1
  55. package/types/sap.ui.webc.fiori.d.ts +49 -1
  56. package/types/sap.ui.webc.main.d.ts +144 -9
  57. package/types/sap.uiext.inbox.d.ts +1 -1
  58. package/types/sap.ushell.d.ts +977 -535
  59. package/types/sap.ushell_abap.d.ts +1 -1
  60. package/types/sap.uxap.d.ts +55 -5
  61. package/types/sap.viz.d.ts +86 -1
  62. package/types/sap.webanalytics.core.d.ts +1 -1
  63. package/types/sap.zen.commons.d.ts +79 -18
  64. package/types/sap.zen.crosstab.d.ts +83 -15
  65. package/types/sap.zen.dsh.d.ts +194 -143
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.8
1
+ // For Library Version: 1.121.0
2
2
 
3
3
  declare module "sap/ui/mdc/AggregationBaseDelegate" {
4
4
  import BaseDelegate from "sap/ui/mdc/BaseDelegate";
@@ -21,34 +21,30 @@ declare module "sap/ui/mdc/AggregationBaseDelegate" {
21
21
  */
22
22
  interface AggregationBaseDelegate extends BaseDelegate {
23
23
  /**
24
- * Creates an instance of the implementing MDC Control's default aggregation.
24
+ * Central hook to add items to the provided control instance. This method must return a promise that resolves
25
+ * with an instance of the implementing {@link sap.ui.mdc.Control Control} default aggregation.
25
26
  *
26
- * **Note:** The `addItem` hook can be used during the processing of an SAPUI5 flexibility change. Consequently
27
- * the parameter `mPropertyBag` is only passed during preprocessing. In runtime scenarios (such as opening
28
- * a personalization dialog), this method might be called without the parameter `mPropertyBag`.
29
- *
30
- *
31
- * @returns Promise that resolves with an instance of the implementing {@link sap.ui.mdc.Control Control }
32
- * default aggregation. **Note:** This method always requires a return value once it has been called. If
33
- * an item for a given property `sPropertyName` has already been created, it is required to either return
34
- * the existing instance or create a new instance.
27
+ * Consequently the parameter `mPropertyBag` is only passed during preprocessing. In runtime scenarios (such
28
+ * as opening a personalization dialog), this method might be called without the parameter `mPropertyBag`.
35
29
  */
36
30
  addItem(
37
31
  /**
38
- * Instance of an `sap.ui.mdc.Control`
32
+ * Instance of an `sap.ui.mdc.Control`. **Note:** The `addItem` hook can be used during the processing of
33
+ * an SAPUI5 flexibility change.
39
34
  */
40
35
  oControl: sap.ui.mdc.Control | Element,
41
36
  /**
42
- * The name of the property info object/JSON
37
+ * The name of the property info object
43
38
  */
44
39
  sPropertyName: string,
45
40
  /**
46
41
  * Instance of property bag from SAPUI5 flexibility change API
47
42
  */
48
43
  mPropertyBag?: Object
49
- ): Promise<any>;
44
+ ): void;
50
45
  /**
51
46
  * Retrieves the relevant metadata for a given payload and returns the property info array.
47
+ * By default, this method returns a `Promise` that resolves into `[]`.
52
48
  *
53
49
  *
54
50
  * @returns Once resolved, an array of property info objects is returned
@@ -77,13 +73,16 @@ declare module "sap/ui/mdc/AggregationBaseDelegate" {
77
73
  * Triggers any necessary follow-up steps that need to be taken after the removal of created items via `removeItem`.
78
74
  * The returned Boolean value inside the `Promise` can be used to prevent the default follow-up behavior
79
75
  * of the SAPUI5 flexibility handling.
76
+ * By default, this method returns a `Promise` that resolves into `true`. This will ensure, that the item
77
+ * will be destroyed subsequentially after it has been removed by the control.
80
78
  *
81
79
  * **Note:** The `removeItem` hook can be used during the processing of an SAPUI5 flexibility change. Consequently
82
80
  * the parameter `mPropertyBag` is only passed during preprocessing. In runtime scenarios (such as opening
83
81
  * a personalization dialog), this method might be called without the parameter `mPropertyBag`.
84
82
  *
85
83
  *
86
- * @returns Promise that resolves with `true`, `false` to allow/prevent default behavior of the change
84
+ * @returns Promise resolving in a boolean, deciding whether the item should be destroyed (`true`) or kept
85
+ * (`false`) after removing it from the control aggregation.
87
86
  */
88
87
  removeItem(
89
88
  /**
@@ -98,7 +97,7 @@ declare module "sap/ui/mdc/AggregationBaseDelegate" {
98
97
  * Instance of property bag from SAPUI5 flexibility
99
98
  */
100
99
  mPropertyBag?: Object
101
- ): Promise<any>;
100
+ ): Promise<boolean>;
102
101
  }
103
102
  const AggregationBaseDelegate: AggregationBaseDelegate;
104
103
  export default AggregationBaseDelegate;
@@ -113,8 +112,8 @@ declare module "sap/ui/mdc/BaseDelegate" {
113
112
  *
114
113
  * All delegate implementations for MDC controls must be derived directly or indirectly from this entity.
115
114
  * Applications should implement {@link module:sap/ui/mdc/BaseDelegate.getTypeMap getTypeMap} to provide
116
- * type mappings based on their model usage. Please also see the following extensible presets: {@link sap.ui.mdc.DefaultTypeMap},
117
- * {@link sap.ui.mdc.odata.TypeMap}, {@link sap.ui.mdc.odata.v4.TypeMap}
115
+ * type mappings based on their model usage. Please also see the following extensible presets: {@link module:sap/ui/mdc/DefaultTypeMap sap.ui.mdc.DefaultTypeMap},
116
+ * {@link module:sap/ui/mdc/odata/TypeMap sap.ui.mdc.odata.TypeMap}, {@link module:sap/ui/mdc/odata/v4/TypeMap sap.ui.mdc.odata.v4.TypeMap}
118
117
  *
119
118
  * @since 1.79.0
120
119
  */
@@ -306,6 +305,21 @@ declare module "sap/ui/mdc/ChartDelegate" {
306
305
  p2: string
307
306
  ) => Promise<sap.ui.mdc.FilterField>;
308
307
  };
308
+ /**
309
+ * Returns filters to be applied when updating the chart's binding based on the filter conditions of the
310
+ * chart itself and it's associated {@link sap.ui.mdc.IFilterSource IFilterSource}.
311
+ *
312
+ * @since 1.121
313
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
314
+ *
315
+ * @returns Array of filters
316
+ */
317
+ getFilters(
318
+ /**
319
+ * Reference to the chart
320
+ */
321
+ oChart: sap.ui.mdc.Chart
322
+ ): sap.ui.model.Filter[];
309
323
  /**
310
324
  * Returns the instance of the inner chart.
311
325
  *
@@ -414,6 +428,7 @@ declare module "sap/ui/mdc/ChartDelegate" {
414
428
  ): sap.ui.mdc.chart.ZoomState;
415
429
  /**
416
430
  * Loads the required libraries and creates the inner chart.
431
+ * By default, the method returns `Promise.reject()`.
417
432
  *
418
433
  *
419
434
  * @returns Resolved once the inner chart has been initialized
@@ -562,6 +577,8 @@ declare module "sap/ui/mdc/ChartDelegate" {
562
577
  ): void;
563
578
  /**
564
579
  * Updates the binding info with the relevant filters.
580
+ * By default, this method updates a given {@link sap.ui.base.ManagedObject.AggregationBindingInfo AggregationBindingInfo }
581
+ * with the return value from the delegate's own {@link module:sap/ui/mdc/ChartDelegate.getFilters getFilters}.
565
582
  */
566
583
  updateBindingInfo(
567
584
  /**
@@ -600,9 +617,9 @@ declare module "sap/ui/mdc/DefaultTypeMap" {
600
617
  import TypeMap from "sap/ui/mdc/util/TypeMap";
601
618
 
602
619
  /**
603
- * Generic {@link sap.ui.mdc.util.TypeMap TypeMap} configuration for simple use cases.
620
+ * Generic {@link module:sap/ui/mdc/util/TypeMap TypeMap} configuration for simple use cases.
604
621
  *
605
- * **Note:** This {@link sap.ui.mdc.util.TypeMap TypeMap} implementation contains the following types:
622
+ * **Note:** This {@link module:sap/ui/mdc/util/TypeMap TypeMap} implementation contains the following types:
606
623
  *
607
624
  *
608
625
  * - {@link sap.ui.model.type.Boolean} (alias `Boolean`)
@@ -636,6 +653,8 @@ declare module "sap/ui/mdc/field/FieldBaseDelegate" {
636
653
  /**
637
654
  * Enables applications to control condition updates based on `value` / `additionalvalue` property changes.
638
655
  *
656
+ * By default, this method returns a condition with an `EQ` operator.
657
+ *
639
658
  * **Note:** Custom implementations of this method may lead to intransparency as a field's condition may
640
659
  * then differ from the state of the `value` / `additionalvalue` properties. Avoid expensive operations,
641
660
  * as this can delay the rendering of the output.
@@ -665,6 +684,8 @@ declare module "sap/ui/mdc/field/FieldBaseDelegate" {
665
684
  /**
666
685
  * Enables applications to control condition updates based on `value` / `additionalvalue` property changes.
667
686
  *
687
+ * By default, this method returns a condition with an `EQ` operator.
688
+ *
668
689
  * **Note:** Custom implementations of this method may lead to intransparency as a field's condition may
669
690
  * then differ from the state of the `value` / `additionalvalue` properties. Avoid expensive operations,
670
691
  * as this can delay the rendering of the output.
@@ -727,17 +748,69 @@ declare module "sap/ui/mdc/field/FieldBaseDelegate" {
727
748
  */
728
749
  aValues: any[]
729
750
  ): undefined | object;
751
+ /**
752
+ * Determines the text for the autocomplete functionality.
753
+ *
754
+ * This function is called during a user's type-ahead into a {@link sap.ui.mdc.Field Field}, {@link sap.ui.mdc.FilterField FilterField},
755
+ * or {@link sap.ui.mdc.MultiValueField MultiValueField} control.
756
+ *
757
+ * The returned text will be shown as selected after the user input ends.
758
+ *
759
+ * By Default this method uses the {@link sap.ui.mdc.field.FieldBase#getDisplay display} property of the
760
+ * {@link sap.ui.mdc.Field Field}, {@link sap.ui.mdc.FilterField FilterField}, or {@link sap.ui.mdc.MultiValueField MultiValueField }
761
+ * control to determine what text (key or description) is used as autocomplete-text. A text is only used
762
+ * if it matches the user input. If set to `Value`, the key is used. If set to `Description`, the description
763
+ * is used. If set to `ValueDescription`, the key is used, if it maps, otherwise the description. If set
764
+ * to `DescriptionValue`, the description is used, if it maps, otherwise the key.
765
+ *
766
+ * **Note:** Whatever this function returns, the user input will not be overwritten, only the text after
767
+ * the user input will be added and shown as selected. Otherwise the cursor position might change or the
768
+ * user input changes while typing what would lead to confusion.
769
+ *
770
+ *
771
+ * @returns Output text
772
+ */
773
+ getAutocompleteOutput(
774
+ /**
775
+ * `Field` control instance
776
+ */
777
+ oField: sap.ui.mdc.field.FieldBase,
778
+ /**
779
+ * Condition
780
+ */
781
+ oCondition: sap.ui.mdc.condition.ConditionObject,
782
+ /**
783
+ * Formatted text of the key (value)
784
+ */
785
+ sKey: string,
786
+ /**
787
+ * FormattedText of the description
788
+ */
789
+ sDescription: string,
790
+ /**
791
+ * If `true` the key matches to the user input
792
+ */
793
+ bKeyMatch: boolean,
794
+ /**
795
+ * If `true` the description matches to the user input
796
+ */
797
+ bDescriptionMatch: boolean
798
+ ): string;
730
799
  /**
731
800
  * Determines the description for a given key.
801
+ * By default, this method calls the {@link sap.ui.mdc.ValueHelp#getItemForValue getItemForValue} function
802
+ * of the assigned {@link sap.ui.mdc.ValueHelp ValueHelp}.
732
803
  *
733
- * This function is called while formatting the output of a {@link sap.ui.mdc.Field Field} or {@link sap.ui.mdc.FilterField FilterField }
734
- * control if a description should be displayed but only a key is given.
804
+ * This function is called while formatting the output of a {@link sap.ui.mdc.Field Field}, {@link sap.ui.mdc.FilterField FilterField},
805
+ * or {@link sap.ui.mdc.MultiValueField MultiValueField} control if a description should be displayed but
806
+ * only a key is given.
735
807
  *
736
808
  * If this needs to be determined asynchronously, a `Promise` is returned.
737
809
  *
738
810
  * As the key might change (uppercase), an object with key and description can be returned.
739
811
  *
740
- * If the description cannot be determined, a corresponding FormatException is thrown.
812
+ * If the description cannot be determined, a corresponding {@link sap.ui.model.FormatException FormatException }
813
+ * is thrown.
741
814
  *
742
815
  *
743
816
  * @returns Description for key or object containing description, key, and payload. If it is not available
@@ -749,8 +822,8 @@ declare module "sap/ui/mdc/field/FieldBaseDelegate" {
749
822
  */
750
823
  oField: sap.ui.mdc.field.FieldBase,
751
824
  /**
752
- * Field help assigned to the {@link sap.ui.mdc.Field Field} or {@link sap.ui.mdc.FilterField FilterField }
753
- * control
825
+ * Field help assigned to the {@link sap.ui.mdc.Field Field}, {@link sap.ui.mdc.FilterField FilterField},
826
+ * or {@link sap.ui.mdc.MultiValueField MultiValueField} control
754
827
  */
755
828
  oValueHelp: sap.ui.mdc.ValueHelp,
756
829
  /**
@@ -796,15 +869,19 @@ declare module "sap/ui/mdc/field/FieldBaseDelegate" {
796
869
  | Promise<string | /* was: sap.ui.mdc.valuehelp.ValueHelpItem */ any>;
797
870
  /**
798
871
  * Determines the description for a given key.
872
+ * By default, this method calls the {@link sap.ui.mdc.ValueHelp#getItemForValue getItemForValue} function
873
+ * of the assigned {@link sap.ui.mdc.ValueHelp ValueHelp}.
799
874
  *
800
- * This function is called while formatting the output of a {@link sap.ui.mdc.Field Field} or {@link sap.ui.mdc.FilterField FilterField }
801
- * control if a description should be displayed but only a key is given.
875
+ * This function is called while formatting the output of a {@link sap.ui.mdc.Field Field}, {@link sap.ui.mdc.FilterField FilterField},
876
+ * or {@link sap.ui.mdc.MultiValueField MultiValueField} control if a description should be displayed but
877
+ * only a key is given.
802
878
  *
803
879
  * If this needs to be determined asynchronously, a `Promise` is returned.
804
880
  *
805
881
  * As the key might change (uppercase), an object with key and description can be returned.
806
882
  *
807
- * If the description cannot be determined, a corresponding FormatException is thrown.
883
+ * If the description cannot be determined, a corresponding {@link sap.ui.model.FormatException FormatException }
884
+ * is thrown.
808
885
  *
809
886
  *
810
887
  * @returns Description for key or object containing description, key, and payload. If it is not available
@@ -816,8 +893,8 @@ declare module "sap/ui/mdc/field/FieldBaseDelegate" {
816
893
  */
817
894
  oField: sap.ui.mdc.field.FieldBase,
818
895
  /**
819
- * Field help assigned to the {@link sap.ui.mdc.Field Field} or {@link sap.ui.mdc.FilterField FilterField }
820
- * control
896
+ * Field help assigned to the {@link sap.ui.mdc.Field Field}, {@link sap.ui.mdc.FilterField FilterField},
897
+ * or {@link sap.ui.mdc.MultiValueField MultiValueField} control
821
898
  */
822
899
  oValueHelp: sap.ui.mdc.ValueHelp,
823
900
  /**
@@ -859,15 +936,19 @@ declare module "sap/ui/mdc/field/FieldBaseDelegate" {
859
936
  | Promise<string | /* was: sap.ui.mdc.valuehelp.ValueHelpItem */ any>;
860
937
  /**
861
938
  * Determines the description for a given key.
939
+ * By default, this method calls the {@link sap.ui.mdc.ValueHelp#getItemForValue getItemForValue} function
940
+ * of the assigned {@link sap.ui.mdc.ValueHelp ValueHelp}.
862
941
  *
863
- * This function is called while formatting the output of a {@link sap.ui.mdc.Field Field} or {@link sap.ui.mdc.FilterField FilterField }
864
- * control if a description should be displayed but only a key is given.
942
+ * This function is called while formatting the output of a {@link sap.ui.mdc.Field Field}, {@link sap.ui.mdc.FilterField FilterField},
943
+ * or {@link sap.ui.mdc.MultiValueField MultiValueField} control if a description should be displayed but
944
+ * only a key is given.
865
945
  *
866
946
  * If this needs to be determined asynchronously, a `Promise` is returned.
867
947
  *
868
948
  * As the key might change (uppercase), an object with key and description can be returned.
869
949
  *
870
- * If the description cannot be determined, a corresponding FormatException is thrown.
950
+ * If the description cannot be determined, a corresponding {@link sap.ui.model.FormatException FormatException }
951
+ * is thrown.
871
952
  *
872
953
  *
873
954
  * @returns Description for key or object containing description, key, and payload. If it is not available
@@ -879,8 +960,8 @@ declare module "sap/ui/mdc/field/FieldBaseDelegate" {
879
960
  */
880
961
  oField: sap.ui.mdc.field.FieldBase,
881
962
  /**
882
- * Field help assigned to the {@link sap.ui.mdc.Field Field} or {@link sap.ui.mdc.FilterField FilterField }
883
- * control
963
+ * Field help assigned to the {@link sap.ui.mdc.Field Field}, {@link sap.ui.mdc.FilterField FilterField},
964
+ * or {@link sap.ui.mdc.MultiValueField MultiValueField} control
884
965
  */
885
966
  oValueHelp: sap.ui.mdc.ValueHelp,
886
967
  /**
@@ -922,15 +1003,19 @@ declare module "sap/ui/mdc/field/FieldBaseDelegate" {
922
1003
  | Promise<string | /* was: sap.ui.mdc.valuehelp.ValueHelpItem */ any>;
923
1004
  /**
924
1005
  * Determines the description for a given key.
1006
+ * By default, this method calls the {@link sap.ui.mdc.ValueHelp#getItemForValue getItemForValue} function
1007
+ * of the assigned {@link sap.ui.mdc.ValueHelp ValueHelp}.
925
1008
  *
926
- * This function is called while formatting the output of a {@link sap.ui.mdc.Field Field} or {@link sap.ui.mdc.FilterField FilterField }
927
- * control if a description should be displayed but only a key is given.
1009
+ * This function is called while formatting the output of a {@link sap.ui.mdc.Field Field}, {@link sap.ui.mdc.FilterField FilterField},
1010
+ * or {@link sap.ui.mdc.MultiValueField MultiValueField} control if a description should be displayed but
1011
+ * only a key is given.
928
1012
  *
929
1013
  * If this needs to be determined asynchronously, a `Promise` is returned.
930
1014
  *
931
1015
  * As the key might change (uppercase), an object with key and description can be returned.
932
1016
  *
933
- * If the description cannot be determined, a corresponding FormatException is thrown.
1017
+ * If the description cannot be determined, a corresponding {@link sap.ui.model.FormatException FormatException }
1018
+ * is thrown.
934
1019
  *
935
1020
  *
936
1021
  * @returns Description for key or object containing description, key, and payload. If it is not available
@@ -942,8 +1027,8 @@ declare module "sap/ui/mdc/field/FieldBaseDelegate" {
942
1027
  */
943
1028
  oField: sap.ui.mdc.field.FieldBase,
944
1029
  /**
945
- * Field help assigned to the {@link sap.ui.mdc.Field Field} or {@link sap.ui.mdc.FilterField FilterField }
946
- * control
1030
+ * Field help assigned to the {@link sap.ui.mdc.Field Field}, {@link sap.ui.mdc.FilterField FilterField},
1031
+ * or {@link sap.ui.mdc.MultiValueField MultiValueField} control
947
1032
  */
948
1033
  oValueHelp: sap.ui.mdc.ValueHelp,
949
1034
  /**
@@ -981,10 +1066,13 @@ declare module "sap/ui/mdc/field/FieldBaseDelegate" {
981
1066
  | Promise<string | /* was: sap.ui.mdc.valuehelp.ValueHelpItem */ any>;
982
1067
  /**
983
1068
  * Determines the key, description, and payload of a user input.
1069
+ * By default, this method calls the {@link sap.ui.mdc.ValueHelp#getItemForValue getItemForValue} function
1070
+ * of the assigned {@link sap.ui.mdc.ValueHelp ValueHelp}.
984
1071
  *
985
1072
  * If this needs to be determined asynchronously, a `Promise` is returned.
986
1073
  *
987
- * If the item cannot be determined, a corresponding ParseException is thrown.
1074
+ * If the item cannot be determined, a corresponding {@link sap.ui.model.ParseException ParseException }
1075
+ * is thrown.
988
1076
  *
989
1077
  *
990
1078
  * @returns Object containing description, key, and payload. If it is not available right now (must be requested),
@@ -996,8 +1084,8 @@ declare module "sap/ui/mdc/field/FieldBaseDelegate" {
996
1084
  */
997
1085
  oField: sap.ui.mdc.field.FieldBase,
998
1086
  /**
999
- * Field help assigned to the {@link sap.ui.mdc.Field Field} or {@link sap.ui.mdc.FilterField FilterField }
1000
- * control
1087
+ * Field help assigned to the {@link sap.ui.mdc.Field Field}, {@link sap.ui.mdc.FilterField FilterField},
1088
+ * or {@link sap.ui.mdc.MultiValueField MultiValueField} control
1001
1089
  */
1002
1090
  oValueHelp: sap.ui.mdc.ValueHelp,
1003
1091
  /**
@@ -1007,11 +1095,80 @@ declare module "sap/ui/mdc/field/FieldBaseDelegate" {
1007
1095
  ): /* was: sap.ui.mdc.valuehelp.ValueHelpItem */
1008
1096
  | any
1009
1097
  | Promise</* was: sap.ui.mdc.valuehelp.ValueHelpItem */ any>;
1098
+ /**
1099
+ * Checks if entered text matches text found from value help
1100
+ *
1101
+ * This function is called during a user's type-ahead into a {@link sap.ui.mdc.Field Field}, {@link sap.ui.mdc.FilterField FilterField},
1102
+ * or {@link sap.ui.mdc.MultiValueField MultiValueField} control.
1103
+ *
1104
+ * By Default this method checks if the text starts with the user input. Depending of the `bCaseSensitive`
1105
+ * parameter this check is performed case sensitive.
1106
+ *
1107
+ *
1108
+ * @returns `true` if text matches user input
1109
+ */
1110
+ isInputMatchingText(
1111
+ /**
1112
+ * `Field` control instance
1113
+ */
1114
+ oField: sap.ui.mdc.field.FieldBase,
1115
+ /**
1116
+ * Currently typed text (Could be changed when the type-ahed result is returned asynchronously.)
1117
+ */
1118
+ sUserInput: string,
1119
+ /**
1120
+ * Text to be checked
1121
+ */
1122
+ sText: string,
1123
+ /**
1124
+ * If `true` this text is the description
1125
+ */
1126
+ bDescription: boolean,
1127
+ /**
1128
+ * If `true` the filtering was done case sensitive
1129
+ */
1130
+ bCaseSensitive: boolean
1131
+ ): boolean;
1010
1132
  }
1011
1133
  const FieldBaseDelegate: FieldBaseDelegate;
1012
1134
  export default FieldBaseDelegate;
1013
1135
  }
1014
1136
 
1137
+ declare module "sap/ui/mdc/field/MultiValueFieldDelegate" {
1138
+ import FieldBaseDelegate from "sap/ui/mdc/field/FieldBaseDelegate";
1139
+
1140
+ /**
1141
+ * Delegate for {@link sap.ui.mdc.MultiValueField MultiValueField}.
1142
+ *
1143
+ * @since 1.93.0
1144
+ */
1145
+ interface MultiValueFieldDelegate extends FieldBaseDelegate {
1146
+ /**
1147
+ * Implements the model-specific logic to update items after conditions have been updated.
1148
+ *
1149
+ * Items can be removed, updated, or added. Use the binding information of the `MultiValueField` control
1150
+ * to update the data in the model.
1151
+ */
1152
+ updateItems(
1153
+ /**
1154
+ * Payload for delegate
1155
+ */
1156
+ oPayload: object,
1157
+ /**
1158
+ * Current conditions of the `MultiValueField` control
1159
+ */
1160
+ aConditions: sap.ui.mdc.condition.ConditionObject[],
1161
+ /**
1162
+ * Current `MultiValueField` control to determine binding information to update the values of the corresponding
1163
+ * model
1164
+ */
1165
+ oMultiValueField: sap.ui.mdc.MultiValueField
1166
+ ): void;
1167
+ }
1168
+ const MultiValueFieldDelegate: MultiValueFieldDelegate;
1169
+ export default MultiValueFieldDelegate;
1170
+ }
1171
+
1015
1172
  declare module "sap/ui/mdc/FilterBarDelegate" {
1016
1173
  import AggregationBaseDelegate from "sap/ui/mdc/AggregationBaseDelegate";
1017
1174
 
@@ -1199,9 +1356,11 @@ declare module "sap/ui/mdc/LinkDelegate" {
1199
1356
  interface LinkDelegate extends BaseDelegate {
1200
1357
  /**
1201
1358
  * Allows for interception before the actual navigation takes place.
1359
+ * By default, this method returns a `Promise` that resolves into `true`.
1202
1360
  *
1203
1361
  *
1204
- * @returns Once resolved, it returns a Boolean value that determines whether the navigation takes place
1362
+ * @returns Once resolved, this method returns a boolean value that determines whether the navigation
1363
+ * takes place
1205
1364
  */
1206
1365
  beforeNavigationCallback(
1207
1366
  /**
@@ -1215,6 +1374,7 @@ declare module "sap/ui/mdc/LinkDelegate" {
1215
1374
  ): Promise<boolean>;
1216
1375
  /**
1217
1376
  * Retrieves and returns the relevant `additionalContent` for the `Link` control as an array.
1377
+ * By default, this method returns a `Promise` that resolves into an empty array.
1218
1378
  *
1219
1379
  *
1220
1380
  * @returns Once resolved, an array of {@link sap.ui.core.Control} is returned
@@ -1227,6 +1387,7 @@ declare module "sap/ui/mdc/LinkDelegate" {
1227
1387
  ): Promise<sap.ui.core.Control[]>;
1228
1388
  /**
1229
1389
  * Retrieves and returns the relevant {@link sap.ui.mdc.link.LinkItem} for the `Link` control.
1390
+ * By default, this method returns a `Promise` that resolves into `null`.
1230
1391
  *
1231
1392
  *
1232
1393
  * @returns Once resolved, `null` or an array of {@link sap.ui.mdc.link.LinkItem} is returned If `null`
@@ -1248,6 +1409,10 @@ declare module "sap/ui/mdc/LinkDelegate" {
1248
1409
  ): Promise<null | sap.ui.mdc.link.LinkItem[]>;
1249
1410
  /**
1250
1411
  * Calculates and returns the type of link that is displayed.
1412
+ * By default, this method returns a `Promise` that resolves into a {@link sap.ui.mdc.link.LinkTypeWrapper LinkTypeWrapper}.
1413
+ * The {@link sap.ui.mdc.link.LinkTypeWrapper LinkTypeWrapper} contains an `initialType` and a `runtimeType`
1414
+ * {@link sap.ui.mdc.link.LinkType LinkType}. The `initialType` has a `type` property of type `Popover`
1415
+ * and a `directLink` property of type `undefined`. The `runtimeType` is of type `null`.
1251
1416
  *
1252
1417
  *
1253
1418
  * @returns Once resolved, a {@link sap.ui.mdc.link.LinkTypeWrapper} containing an initial {@link sap.ui.mdc.link.LinkType }
@@ -1261,9 +1426,42 @@ declare module "sap/ui/mdc/LinkDelegate" {
1261
1426
  */
1262
1427
  oLink: sap.ui.mdc.Link
1263
1428
  ): Promise<sap.ui.mdc.link.LinkTypeWrapper>;
1429
+ /**
1430
+ * Enables the modification of the {@link sap.m.ResponsivePopover#title} property and setting which `Control`
1431
+ * should be added to the `ariaLabelledBy` association.
1432
+ *
1433
+ *
1434
+ * @returns Once resolved, an `Object` containing the title string and an `Control` which is referenced
1435
+ * as arialabelledBy.
1436
+ */
1437
+ fetchPopoverTitle(
1438
+ /**
1439
+ * Instance of the `Link`
1440
+ */
1441
+ oLink: sap.ui.mdc.Link,
1442
+ /**
1443
+ * Instance of the `Panel`
1444
+ */
1445
+ oPanel: /* was: sap.ui.mdc.link.Panel */ any
1446
+ ): any;
1447
+ /**
1448
+ * Allows to differenciate the created `Panel` of multiple `Link` instances for personalization reasons.
1449
+ * Please provide different IDs for each `Link` as otherwise the personalization will have problems keeping
1450
+ * the `Panel` controls apart.
1451
+ *
1452
+ *
1453
+ * @returns The ID of the `Panel` that is created by the `Link`
1454
+ */
1455
+ getPanelId(
1456
+ /**
1457
+ * Instance of the `Link`
1458
+ */
1459
+ oLink: sap.ui.mdc.Link
1460
+ ): string;
1264
1461
  /**
1265
1462
  * Enables the modification of the {@link sap.ui.mdc.link.LinkItem} instances before the popover opens.
1266
1463
  * This enables additional parameters to be added to the link.
1464
+ * By default, this method returns a `Promise` that resolves into the passed `aLinkItems` array.
1267
1465
  *
1268
1466
  *
1269
1467
  * @returns Once resolved, an array of link items is returned
@@ -1278,9 +1476,9 @@ declare module "sap/ui/mdc/LinkDelegate" {
1278
1476
  */
1279
1477
  oBindingContext: sap.ui.model.Context | null | undefined,
1280
1478
  /**
1281
- * The {@link sap.ui.mdc.link.LinkItem} instances of the link that can be modified
1479
+ * Array of {@link sap.ui.mdc.link.LinkItem} instances of the link that can be modified
1282
1480
  */
1283
- aLinkItems: sap.ui.mdc.link.LinkItem
1481
+ aLinkItems: sap.ui.mdc.link.LinkItem[]
1284
1482
  ): Promise<sap.ui.mdc.link.LinkItem[]>;
1285
1483
  }
1286
1484
  const LinkDelegate: LinkDelegate;
@@ -1291,9 +1489,9 @@ declare module "sap/ui/mdc/odata/TypeMap" {
1291
1489
  import DefaultTypeMap from "sap/ui/mdc/DefaultTypeMap";
1292
1490
 
1293
1491
  /**
1294
- * OData-specific {@link sap.ui.mdc.util.TypeMap TypeMap} configuration.
1492
+ * OData-specific {@link module:sap/ui/mdc/util/TypeMap TypeMap} configuration.
1295
1493
  *
1296
- * **Note:** This {@link sap.ui.mdc.util.TypeMap TypeMap} implementation contains the following types:
1494
+ * **Note:** This `TypeMap` implementation contains the following types:
1297
1495
  *
1298
1496
  *
1299
1497
  * - {@link sap.ui.model.type.Boolean} (alias `Boolean`)
@@ -1351,19 +1549,31 @@ declare module "sap/ui/mdc/odata/v4/TableDelegate" {
1351
1549
  import TableDelegate1 from "sap/ui/mdc/TableDelegate";
1352
1550
 
1353
1551
  /**
1354
- * Delegate for {@link sap.ui.mdc.Table} and `ODataV4`. Enables additional analytical capabilities.
1552
+ * Base delegate for {@link sap.ui.mdc.Table} and `ODataV4`.
1553
+ *
1554
+ * Extend this object in your project to use all functionalities of the table. For more information, please
1555
+ * see {@link module:sap/ui/mdc/TableDelegate}.
1556
+ *
1557
+ * **Note:** This base delegate supports the `p13nMode` `Aggregate` only if the table type is {@link sap.ui.mdc.table.GridTableType GridTable},
1558
+ * and the `p13nMode` `Group` is not supported if the table type is {@link sap.ui.mdc.table.TreeTableType TreeTable}.
1559
+ * This cannot be changed in your delegate implementation.
1355
1560
  *
1356
1561
  * @since 1.85
1357
1562
  */
1358
1563
  interface TableDelegate extends TableDelegate1 {
1359
1564
  /**
1360
- * Updates the row binding of the table if possible, rebinds otherwise.
1565
+ * Updates the binding of the table with the binding info object returned from {@link module:sap/ui/mdc/TableDelegate.updateBindingInfo updateBindingInfo}.
1566
+ * If an update is not possible, it rebinds the table.
1567
+ *
1568
+ * Compares the current and previous state of the table to detect whether rebinding is necessary. The diffing
1569
+ * is done for the sorters, filters, aggregation, parameters, and the path of the binding. Other {@link sap.ui.base.ManagedObject.AggregationBindingInfo binding info }
1570
+ * keys, such as `events` or `model`, must be provided in `updateBindingInfo`, and those keys must not be
1571
+ * changed conditionally.
1361
1572
  *
1362
- * Compares the current and previous state of the table to detect whether rebinding is necessary or not.
1363
- * The diffing happens for the sorters, filters, aggregation, parameters, and the path of the binding. Other
1364
- * {@link sap.ui.base.ManagedObject.AggregationBindingInfo binding info} keys like `events`, `model`...
1365
- * must be provided in the {@link #updateBindingInfo updateBindingInfo} method always, and those keys must
1366
- * not be changed conditionally.
1573
+ * **Note:** To remove a binding info parameter, the value must be set to `undefined` in `updateBindingInfo`.
1574
+ * For more information, see {@link sap.ui.model.odata.v4.ODataListBinding#changeParameters}.
1575
+ * See:
1576
+ * rebind
1367
1577
  *
1368
1578
  * @ui5-protected Do not call from applications (only from related classes in the framework)
1369
1579
  */
@@ -1373,11 +1583,11 @@ declare module "sap/ui/mdc/odata/v4/TableDelegate" {
1373
1583
  */
1374
1584
  oTable: sap.ui.mdc.Table,
1375
1585
  /**
1376
- * The binding info object to be used to bind the table to the model.
1586
+ * The binding info object to be used to bind the table
1377
1587
  */
1378
1588
  oBindingInfo: sap.ui.base.ManagedObject.AggregationBindingInfo,
1379
1589
  /**
1380
- * The binding instance of the table
1590
+ * The binding instance of the table that can be used to update the binding and avoid a rebind
1381
1591
  */
1382
1592
  oBinding?: sap.ui.model.ListBinding,
1383
1593
  /**
@@ -1385,7 +1595,7 @@ declare module "sap/ui/mdc/odata/v4/TableDelegate" {
1385
1595
  */
1386
1596
  mSettings?: {
1387
1597
  /**
1388
- * Indicates that the binding has to be refreshed even if `oBindingInfo` has not been changed
1598
+ * Indicates that the binding has to be refreshed even if the binding info has not changed
1389
1599
  */
1390
1600
  forceRefresh?: boolean;
1391
1601
  }
@@ -1399,10 +1609,9 @@ declare module "sap/ui/mdc/odata/v4/TypeMap" {
1399
1609
  import TypeMap1 from "sap/ui/mdc/odata/TypeMap";
1400
1610
 
1401
1611
  /**
1402
- * ODataV4-specific {@link sap.ui.mdc.util.TypeMap TypeMap} configuration.
1612
+ * ODataV4-specific {@link module:sap/ui/mdc/util/TypeMap TypeMap} configuration.
1403
1613
  *
1404
- * **Note:** This {@link sap.ui.mdc.util.TypeMap TypeMap} implementation contains the following types including
1405
- * ODataV4-specific configuration:
1614
+ * **Note:** This `TypeMap` implementation contains the following types including ODataV4-specific configuration:
1406
1615
  *
1407
1616
  *
1408
1617
  * - {@link sap.ui.model.type.Boolean} (alias `Boolean`)
@@ -1445,56 +1654,115 @@ declare module "sap/ui/mdc/TableDelegate" {
1445
1654
  import AggregationBaseDelegate from "sap/ui/mdc/AggregationBaseDelegate";
1446
1655
 
1447
1656
  /**
1448
- * Base delegate for {@link sap.ui.mdc.Table}.
1657
+ * Base delegate for {@link sap.ui.mdc.Table}. Extend this object in your project to use all functionalities
1658
+ * of the table. This base delegate already meets some requirements of certain features. Others need to
1659
+ * be met by your delegate implementation.
1660
+ *
1661
+ * The following methods need to be added or overridden in your delegate. Please also see the documentation
1662
+ * of the methods to learn about their default implementation and what you need to implement.
1663
+ * - `Basic prerequisites`
1664
+ * - {@link module:sap/ui/mdc/TableDelegate.fetchProperties fetchProperties}
1665
+ * - {@link module:sap/ui/mdc/TableDelegate.updateBindingInfo updateBindingInfo}
1666
+ * - Column personalization (related to `p13nMode` `Column`)
1667
+ * - {@link module:sap/ui/mdc/TableDelegate.addItem addItem}
1668
+ * - Filter personalization (related to `p13nMode` `Filter`)
1669
+ * - {@link module:sap/ui/mdc/TableDelegate.getFilterDelegate getFilterDelegate}
1670
+ *
1671
+ * **Note:** This base delegate does not support the `p13nMode` `Aggregate`, and the `p13nMode` `Group`
1672
+ * is only supported if the table type is {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}.
1673
+ * This cannot be changed in your delegate implementation.
1449
1674
  *
1450
1675
  * @since 1.60
1451
1676
  */
1452
1677
  interface TableDelegate extends AggregationBaseDelegate {
1453
1678
  /**
1454
- * Collapses all nodes.
1679
+ * Central hook that is called to add columns to the table when the state is applied, for example, when
1680
+ * SAPUI5 flexibility changes are applied. During preprocessing, this method is called without the `mPropertyBag`
1681
+ * parameter, and `oTable` is an XML node.
1682
+ *
1683
+ * By default, this method does not create a column and just returns a `Promise` that resolves without a
1684
+ * value.
1455
1685
  *
1456
1686
  * @ui5-protected Do not call from applications (only from related classes in the framework)
1687
+ *
1688
+ * @returns A `Promise` that resolves with a column
1457
1689
  */
1458
- collapseAll(
1690
+ addItem(
1691
+ /**
1692
+ * Instance of the table or an XML node representing the table during preprocessing
1693
+ */
1694
+ oTable: sap.ui.mdc.Table | Element,
1459
1695
  /**
1460
- * Instance of the MDC table
1696
+ * The property name
1697
+ */
1698
+ sPropertyName: string,
1699
+ /**
1700
+ * Instance of a property bag from the SAPUI5 flexibility API
1701
+ */
1702
+ mPropertyBag?: Object
1703
+ ): Promise<sap.ui.mdc.table.Column>;
1704
+ /**
1705
+ * Collapses all rows.
1706
+ *
1707
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1708
+ */
1709
+ collapseAllRows(
1710
+ /**
1711
+ * Instance of the table
1461
1712
  */
1462
1713
  oTable: sap.ui.mdc.Table
1463
1714
  ): void;
1464
1715
  /**
1465
- * Expands all nodes.
1716
+ * Expands all rows.
1466
1717
  *
1467
1718
  * @ui5-protected Do not call from applications (only from related classes in the framework)
1468
1719
  */
1469
- expandAll(
1720
+ expandAllRows(
1470
1721
  /**
1471
- * Instance of the MDC table
1722
+ * Instance of the table
1472
1723
  */
1473
1724
  oTable: sap.ui.mdc.Table
1474
1725
  ): void;
1475
1726
  /**
1476
- * Returns the feature set for exporting data in the MDC Table.
1727
+ * Returns the feature set for exporting data in the table.
1728
+ *
1729
+ * By default, this method returns basic `sap.ui.export.FileType.XLSX` capabilities.
1477
1730
  *
1478
1731
  * @ui5-protected Do not call from applications (only from related classes in the framework)
1479
1732
  *
1480
- * @returns Export capabilities with specific features
1733
+ * @returns A `Promise` that resolves with an object as specified in {@link sap.ui.export.ExportHandler}
1481
1734
  */
1482
1735
  fetchExportCapabilities(
1483
1736
  /**
1484
- * Instance of the MDC table
1737
+ * Instance of the table
1485
1738
  */
1486
1739
  oTable: sap.ui.mdc.Table
1487
- ): Promise<any>;
1740
+ ): Promise<object>;
1741
+ /**
1742
+ * Retrieves information about the relevant properties.
1743
+ *
1744
+ * By default, this method returns a `Promise` that resolves with an empty array.
1745
+ *
1746
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1747
+ *
1748
+ * @returns A `Promise` that resolves with the property information
1749
+ */
1750
+ fetchProperties(
1751
+ /**
1752
+ * Instance of the table
1753
+ */
1754
+ oTable: sap.ui.mdc.Table
1755
+ ): Promise<sap.ui.mdc.table.PropertyInfo[]>;
1488
1756
  /**
1489
1757
  * Formats the title text of a group header row of the table.
1490
1758
  *
1491
1759
  * @ui5-protected Do not call from applications (only from related classes in the framework)
1492
1760
  *
1493
- * @returns The group header title. If `undefined` is returned, the default group header title is set.
1761
+ * @returns The group header title
1494
1762
  */
1495
1763
  formatGroupHeader(
1496
1764
  /**
1497
- * Instance of the MDC table
1765
+ * Instance of the table
1498
1766
  */
1499
1767
  oTable: sap.ui.mdc.Table,
1500
1768
  /**
@@ -1502,14 +1770,17 @@ declare module "sap/ui/mdc/TableDelegate" {
1502
1770
  */
1503
1771
  oContext: sap.ui.model.Context,
1504
1772
  /**
1505
- * The name of the grouped property
1773
+ * Name of the grouped property
1506
1774
  */
1507
1775
  sProperty: string
1508
- ): string | undefined;
1776
+ ): string;
1509
1777
  /**
1510
1778
  * Returns the filter delegate of the table that provides basic filter functionality, such as adding filter
1511
- * fields. **Note:** The functionality provided in this delegate acts as a subset of a `FilterBarDelegate`
1512
- * to enable the table for inbuilt filtering.
1779
+ * fields.
1780
+ *
1781
+ * **Note:** The functionality provided in this delegate acts as a subset of a `FilterBarDelegate` to enable
1782
+ * the table for inbuilt filtering.
1783
+ *
1513
1784
  *
1514
1785
  * @ui5-protected Do not call from applications (only from related classes in the framework)
1515
1786
  *
@@ -1522,8 +1793,10 @@ declare module "sap/ui/mdc/TableDelegate" {
1522
1793
  ) => Promise<sap.ui.mdc.FilterField>;
1523
1794
  };
1524
1795
  /**
1525
- * Returns filters that are used when updating the table's binding and are created based on the filter conditions
1526
- * of the table and its associated filter control.
1796
+ * Returns filters to be applied when updating the table's binding based on the filter conditions of the
1797
+ * table itself and its associated {@link sap.ui.mdc.IFilterSource IFilterSource}.
1798
+ *
1799
+ * By default, filters for the associated filter source are only generated for a `sap.ui.mdc.FilterBar`.
1527
1800
  *
1528
1801
  * @ui5-protected Do not call from applications (only from related classes in the framework)
1529
1802
  *
@@ -1536,43 +1809,49 @@ declare module "sap/ui/mdc/TableDelegate" {
1536
1809
  oTable: sap.ui.mdc.Table
1537
1810
  ): sap.ui.model.Filter[];
1538
1811
  /**
1539
- * Creates a new sorter for the grouping functionality.
1812
+ * Returns a sorter for the grouping functionality to be applied when updating the table's binding based
1813
+ * on the group conditions of the table.
1814
+ *
1815
+ * **Note:** No sorter must be returned if the table type, for example, {@link sap.ui.mdc.table.GridTableType GridTable},
1816
+ * cannot be grouped this way.
1540
1817
  *
1541
1818
  * @ui5-protected Do not call from applications (only from related classes in the framework)
1542
1819
  *
1543
- * @returns New sorter
1820
+ * @returns The sorter or `undefined` if there is no group condition or if it cannot be applied
1544
1821
  */
1545
1822
  getGroupSorter(
1546
1823
  /**
1547
- * Instance of the MDC table
1824
+ * Instance of the table
1548
1825
  */
1549
1826
  oTable: sap.ui.mdc.Table
1550
1827
  ): sap.ui.model.Sorter | undefined;
1551
1828
  /**
1552
- * Returns the sort conditions that are used when updating the table's binding.
1829
+ * Returns sorters to be applied when updating the table's binding based on the sort conditions of the table.
1553
1830
  *
1554
1831
  * @ui5-protected Do not call from applications (only from related classes in the framework)
1555
1832
  *
1556
- * @returns Sort Conditions
1833
+ * @returns Array of sorters
1557
1834
  */
1558
1835
  getSorters(
1559
1836
  /**
1560
- * Instance of the MDC table
1837
+ * Instance of the table
1561
1838
  */
1562
1839
  oTable: sap.ui.mdc.Table
1563
1840
  ): sap.ui.model.Sorter[];
1564
1841
  /**
1565
- * Rebinds the table.
1842
+ * Rebinds the table with the binding info object returned from {@link module:sap/ui/mdc/TableDelegate.updateBindingInfo updateBindingInfo}.
1843
+ * See:
1844
+ * updateBinding
1566
1845
  *
1567
1846
  * @ui5-protected Do not call from applications (only from related classes in the framework)
1568
1847
  */
1569
1848
  rebind(
1570
1849
  /**
1571
- * Instance of the MDC table
1850
+ * Instance of the table
1572
1851
  */
1573
1852
  oTable: sap.ui.mdc.Table,
1574
1853
  /**
1575
- * The binding info object to be used to bind the table to the model
1854
+ * The binding info object used to bind the table
1576
1855
  */
1577
1856
  oBindingInfo: sap.ui.base.ManagedObject.AggregationBindingInfo
1578
1857
  ): void;
@@ -1608,17 +1887,24 @@ declare module "sap/ui/mdc/TableDelegate" {
1608
1887
  }
1609
1888
  ): void;
1610
1889
  /**
1611
- * Provides a hook to update the binding info object that is used to bind the table to the model.
1890
+ * Updates the binding info object that is used to bind the table in {@link module:sap/ui/mdc/TableDelegate.updateBinding updateBinding}.
1891
+ *
1892
+ * By default, filters and sorters are added to the binding info. Please see {@link module:sap/ui/mdc/TableDelegate.getFilters getFilters},
1893
+ * {@link module:sap/ui/mdc/TableDelegate.getSorters getSorters}, and {@link module:sap/ui/mdc/TableDelegate.getGroupSorter getGroupSorter }
1894
+ * for more details.
1895
+ *
1896
+ * **Note:** Any other required information, such as the path, must be additionally provided by your delegate
1897
+ * implementation.
1612
1898
  *
1613
1899
  * @ui5-protected Do not call from applications (only from related classes in the framework)
1614
1900
  */
1615
1901
  updateBindingInfo(
1616
1902
  /**
1617
- * Instance of the MDC table
1903
+ * Instance of the table
1618
1904
  */
1619
1905
  oTable: sap.ui.mdc.Table,
1620
1906
  /**
1621
- * The binding info object to be used to bind the table to the model
1907
+ * The binding info
1622
1908
  */
1623
1909
  oBindingInfo: sap.ui.base.ManagedObject.AggregationBindingInfo
1624
1910
  ): void;
@@ -1629,7 +1915,7 @@ declare module "sap/ui/mdc/TableDelegate" {
1629
1915
 
1630
1916
  declare module "sap/ui/mdc/util/TypeMap" {
1631
1917
  /**
1632
- * Configuration class for type-handling in MDC delegates. Allows mapping of model-types to {@link sap.ui.mdc.enums.BaseType }
1918
+ * Configuration class for type handling in delegates. Allows mapping of model types to {@link sap.ui.mdc.enums.BaseType }
1633
1919
  * and enables model-specific type configuration.
1634
1920
  *
1635
1921
  * **Note:** This utility is experimental and the API/behavior is not finalized. Hence, it should not be
@@ -1639,7 +1925,7 @@ declare module "sap/ui/mdc/util/TypeMap" {
1639
1925
  */
1640
1926
  interface TypeMap {
1641
1927
  /**
1642
- * Exports the `TypeMap`'s current data.
1928
+ * Exports the current data of the `TypeMap`.
1643
1929
  *
1644
1930
  *
1645
1931
  * @returns `Array` created from this `TypeMap`'s internal `Map`
@@ -1650,7 +1936,7 @@ declare module "sap/ui/mdc/util/TypeMap" {
1650
1936
  *
1651
1937
  * The value is not checked for validity. The used values must be compatible with the used basic type.
1652
1938
  *
1653
- * **Note:** Number types are not converted, the number conversion is done by the SAPUI5 Flexibility handling.
1939
+ * **Note:** Number types are not converted, the number conversion is done by the SAPUI5 flexibility handling.
1654
1940
  *
1655
1941
  *
1656
1942
  * @returns Converted value
@@ -1674,18 +1960,19 @@ declare module "sap/ui/mdc/util/TypeMap" {
1674
1960
  oConstraints?: object
1675
1961
  ): string;
1676
1962
  /**
1677
- * Prevents further manipulation of a `TypeMap`'s data
1963
+ * Prevents further modification of the data of a `TypeMap`.
1678
1964
  */
1679
1965
  freeze(): void;
1680
1966
  /**
1681
- * To determine which internal controls to render, the {@link sap.ui.mdc.Field Field}, {@link sap.ui.mdc.MultiValueField MultiValueField},
1682
- * or {@link sap.ui.mdc.FilterField FilterField} controls need to know if the type represents a `date`,
1683
- * a `number`, or another {@link sap.ui.mdc.enums.BaseType BaseType}.
1967
+ * To determine which internal controls to render, either the {@link sap.ui.mdc.Field Field}, the {@link sap.ui.mdc.MultiValueField MultiValueField},
1968
+ * or the {@link sap.ui.mdc.FilterField FilterField} control needs information about whether the type represents
1969
+ * a `date`, a `number`, or another {@link sap.ui.mdc.enums.BaseType BaseType}.
1684
1970
  *
1685
1971
  * As default, `string` is returned.
1686
1972
  *
1687
1973
  *
1688
- * @returns Corresponding {@link sap.ui.mdc.enums.BaseType BaseType}, e.g. `Date`, `DateTime` or `Time`
1974
+ * @returns Corresponding {@link sap.ui.mdc.enums.BaseType BaseType}, for example, `Date`, `DateTime` or
1975
+ * `Time`
1689
1976
  */
1690
1977
  getBaseType(
1691
1978
  /**
@@ -1705,7 +1992,8 @@ declare module "sap/ui/mdc/util/TypeMap" {
1705
1992
  * Convenience method to retrieve the `BaseType` for a given {@link sap.ui.model.SimpleType SimpleType}.
1706
1993
  *
1707
1994
  *
1708
- * @returns Corresponding {@link sap.ui.mdc.enums.BaseType BaseType}, e.g. `Date`, `DateTime` or `Time`
1995
+ * @returns Corresponding {@link sap.ui.mdc.enums.BaseType BaseType}, for example, `Date`, `DateTime` or
1996
+ * `Time`
1709
1997
  */
1710
1998
  getBaseTypeForType(
1711
1999
  /**
@@ -1735,7 +2023,7 @@ declare module "sap/ui/mdc/util/TypeMap" {
1735
2023
  */
1736
2024
  getDataTypeClassName(
1737
2025
  /**
1738
- * Given model specific type
2026
+ * Given model-specific type
1739
2027
  */
1740
2028
  sType: string
1741
2029
  ): string;
@@ -1784,11 +2072,11 @@ declare module "sap/ui/mdc/util/TypeMap" {
1784
2072
  oConstraints?: object
1785
2073
  ): /* was: sap.ui.mdc.TypeConfig */ any;
1786
2074
  /**
1787
- * Imports a `TypeMap`'s data into another `TypeMap`.
2075
+ * Imports the data of a `TypeMap` into another `TypeMap`.
1788
2076
  */
1789
2077
  import(
1790
2078
  /**
1791
- * `TypeMap` to import
2079
+ * `TypeMap` that gets imported
1792
2080
  */
1793
2081
  oTypeMap: TypeMap
1794
2082
  ): void;
@@ -1797,7 +2085,7 @@ declare module "sap/ui/mdc/util/TypeMap" {
1797
2085
  *
1798
2086
  * The value is not checked for validity. The used values must be compatible with the used basic type.
1799
2087
  *
1800
- * **Note:** Number types are not converted. The number conversion is done by the SAPUI5 Flexibility handling.
2088
+ * **Note:** Number types are not converted. The number conversion is done by the SAPUI5 flexibility handling.
1801
2089
  *
1802
2090
  *
1803
2091
  * @returns Converted value
@@ -1824,7 +2112,7 @@ declare module "sap/ui/mdc/util/TypeMap" {
1824
2112
  * Sets a {@link sap.ui.mdc.enums.BaseType BaseType} and an optional model- or scenario-specific configuration
1825
2113
  * method for a given {@link sap.ui.model.SimpleType} `ObjectPath` `string`.
1826
2114
  *
1827
- * As default `string` is returned.
2115
+ * As default, `string` is returned.
1828
2116
  */
1829
2117
  set(
1830
2118
  /**
@@ -1839,13 +2127,13 @@ declare module "sap/ui/mdc/util/TypeMap" {
1839
2127
  | (sap.ui.mdc.enums.BaseType | keyof typeof sap.ui.mdc.enums.BaseType)
1840
2128
  | Function,
1841
2129
  /**
1842
- * Optional customizing method for format options and constraints. See {@link sap.ui.mdc.DefaultTypeMap }
2130
+ * Optional customizing method for format options and constraints. See {@link module:sap/ui/mdc/DefaultTypeMap DefaultTypeMap }
1843
2131
  * for examples.
1844
2132
  */
1845
2133
  fnOptions?: Function
1846
2134
  ): void;
1847
2135
  /**
1848
- * Allows alternative identifiers for types, such as "Boolean" for "{@link sap.ui.model.type.Boolean}".
2136
+ * Allows alternative identifiers for types, such as a Boolean for {@link sap.ui.model.type.Boolean}.
1849
2137
  */
1850
2138
  setAlias(
1851
2139
  /**
@@ -1866,16 +2154,20 @@ declare module "sap/ui/mdc/ValueHelpDelegate" {
1866
2154
  import BaseDelegate from "sap/ui/mdc/BaseDelegate";
1867
2155
 
1868
2156
  /**
1869
- * Delegate for {@link sap.ui.mdc.ValueHelp ValueHelp}.
1870
- * **Note:** The class is experimental and the API/behavior is not finalized and hence this should not
1871
- * be used for productive usage.
2157
+ * Delegate for {@link sap.ui.mdc.ValueHelp}.
2158
+ *
2159
+ * **Note:** The class is experimental and the API/behavior is not finalized and hence this should not be
2160
+ * used for productive usage.
1872
2161
  *
1873
2162
  * @since 1.95.0
1874
2163
  */
1875
2164
  interface ValueHelpDelegate extends BaseDelegate {
1876
2165
  /**
1877
2166
  * Checks if the `ListBinding` is waiting for an update. As long as the context has not been set for `ListBinding`,
1878
- * `ValueHelp` needs to wait.
2167
+ * the `ValueHelp` needs to wait.
2168
+ * By default, this method returns `false` if no {@link sap.ui.model.ListBinding ListBinding} is available
2169
+ * or the given `ListBinding` is suspended. Otherwise, it returns a `Promise` that resolves into a `boolean`
2170
+ * value indicating that at least one context is available after retrieval.
1879
2171
  *
1880
2172
  *
1881
2173
  * @returns `Promise` that is resolved once `ListBinding` has been updated
@@ -1897,6 +2189,7 @@ declare module "sap/ui/mdc/ValueHelpDelegate" {
1897
2189
  /**
1898
2190
  * Provides the possibility to convey custom data in conditions. This enables an application to enhance
1899
2191
  * conditions with data relevant for combined key or out parameter scenarios.
2192
+ * By default, this method returns `undefined`.
1900
2193
  *
1901
2194
  * @since 1.101.0
1902
2195
  *
@@ -1922,6 +2215,7 @@ declare module "sap/ui/mdc/ValueHelpDelegate" {
1922
2215
  ): undefined | object;
1923
2216
  /**
1924
2217
  * Executes a filter in a `ListBinding`.
2218
+ * By default, this method returns a `Promise` that resolves into the given `ListBinding`.
1925
2219
  *
1926
2220
  *
1927
2221
  * @returns `Promise` that is resolved if search is executed
@@ -1941,10 +2235,11 @@ declare module "sap/ui/mdc/ValueHelpDelegate" {
1941
2235
  iRequestedItems: int
1942
2236
  ): Promise<sap.ui.model.ListBinding>;
1943
2237
  /**
1944
- * Find all conditions, which are represented by the given context for 'Select from list' scenarios. By
1945
- * default, only condition keys are considered. This may be extended with payload dependent filters.
2238
+ * Finds all conditions that are represented by the given context for 'Select from list' scenarios.
2239
+ * By default, this method only takes {@link sap.ui.mdc.condition.ConditionObject Condition} keys into consideration.
2240
+ * This can be extended with payload-dependent filters.
1946
2241
  *
1947
- * Note: this method replaces the former `isFilterableListItemSelected`
2242
+ * **Note:** This method replaces the former `isFilterableListItemSelected`.
1948
2243
  *
1949
2244
  * @since 1.118.0
1950
2245
  *
@@ -1969,15 +2264,16 @@ declare module "sap/ui/mdc/ValueHelpDelegate" {
1969
2264
  aConditions: sap.ui.mdc.condition.ConditionObject[]
1970
2265
  ): sap.ui.mdc.condition.ConditionObject[];
1971
2266
  /**
1972
- * Provides a map of conditions for the following situations:
1973
- * - Initial set of conditions applied every time value help content is shown for the first time since
1974
- * opening its container.
1975
- * - Detailed set of conditions in `getItemForValue` scenarios that allow you to find a specific value
1976
- * help item (indicated by oConfig availability).
2267
+ * Provides an object of conditions per binding path.
2268
+ * By default, this method returns an empty `object`.
2269
+ *
2270
+ * This method provides the initial set of conditions applied every time value help content is shown for
2271
+ * the first time after opening its container. It is also relevant for `getItemForValue` scenarios that
2272
+ * allow you to find a specific value help item (indicated by the availability of the `oConfig` argument).
1977
2273
  *
1978
2274
  * @since 1.106.0
1979
2275
  *
1980
- * @returns Returns a map of conditions
2276
+ * @returns Returns a map-like object containing conditions suitable for `Filter` creation
1981
2277
  */
1982
2278
  getFilterConditions(
1983
2279
  /**
@@ -1991,59 +2287,35 @@ declare module "sap/ui/mdc/ValueHelpDelegate" {
1991
2287
  /**
1992
2288
  * Configuration
1993
2289
  */
1994
- oConfig?: {
1995
- /**
1996
- * Value as entered by user
1997
- */
1998
- value: any;
1999
- /**
2000
- * Value parsed by type to fit the data type of the key
2001
- */
2002
- parsedValue?: any;
2003
- /**
2004
- * Contextual information provided by condition payload or `inParameters`/`outParameters`. This is only
2005
- * filled if the description needs to be determined for an existing condition.
2006
- */
2007
- context?: {
2008
- /**
2009
- * In parameters of the current condition (`inParameter` are not used any longer, but it might be filled
2010
- * in older conditions stored in variants.)
2011
- */
2012
- inParameter?: object;
2013
- /**
2014
- * Out parameters of the current condition (`outParameter` are not used any longer, but it might be filled
2015
- * in older conditions stored in variants.)
2016
- */
2017
- ouParameter?: object;
2018
- /**
2019
- * Payload of the current condition
2020
- */
2021
- payload?: object;
2022
- };
2023
- /**
2024
- * Instance of the calling control
2025
- */
2026
- control: sap.ui.core.Control;
2027
- /**
2028
- * `BindingContext` of the checked field. Inside a table, the `ValueHelp` element might be connected to
2029
- * a different row.
2030
- */
2031
- bindingContext?: sap.ui.model.Context;
2032
- /**
2033
- * If set, the value help checks only if there is an item with the given key. This is set to `false` if
2034
- * the value cannot be a valid key because of type validation.
2035
- */
2036
- checkKey: boolean;
2037
- /**
2038
- * If set, the value help checks only if there is an item with the given description. This is set to `false`
2039
- * if only the key is used in the field.
2040
- */
2041
- checkDescription: boolean;
2042
- }
2043
- ): Promise<object> | object;
2290
+ oConfig?: sap.ui.mdc.valuehelp.base.ItemForValueConfiguration
2291
+ ):
2292
+ | Promise<sap.ui.mdc.util.FilterConditionMap>
2293
+ | sap.ui.mdc.util.FilterConditionMap;
2294
+ /**
2295
+ * Returns filters that are used when updating the binding of the `ValueHelp`.
2296
+ * By default, this method returns a set of {@link sap.ui.model.Filter Filters} originating from an available
2297
+ * {@link sap.ui.mdc.FilterBar FilterBar}, the delegate's own {@link #getFilterConditions}, and/or the {@link sap.ui.mdc.valuehelp.base.FilterableListContent#getFilterFields filterFields }
2298
+ * configuration of the given {@link sap.ui.mdc.valuehelp.base.FilterableListContent FilterableListContent}.
2299
+ *
2300
+ * @since 1.121
2301
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2302
+ *
2303
+ * @returns Array of filters
2304
+ */
2305
+ getFilters(
2306
+ /**
2307
+ * The `ValueHelp` control instance
2308
+ */
2309
+ oValueHelp: sap.ui.mdc.ValueHelp,
2310
+ /**
2311
+ * `ValueHelp` content requesting conditions configuration
2312
+ */
2313
+ oContent: sap.ui.mdc.valuehelp.base.FilterableListContent
2314
+ ): sap.ui.model.Filter[];
2044
2315
  /**
2045
2316
  * Returns the content that is used for the autocomplete feature and for user input, if the entered text
2046
2317
  * leads to more than one filter result.
2318
+ * 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}.
2047
2319
  *
2048
2320
  * @since 1.120.0
2049
2321
  *
@@ -2065,6 +2337,8 @@ declare module "sap/ui/mdc/ValueHelpDelegate" {
2065
2337
  ): sap.ui.model.Context;
2066
2338
  /**
2067
2339
  * Provides type information for list content filtering.
2340
+ * By default, this method returns an object of types per binding path, extracted from a binding template
2341
+ * of the given {@link sap.ui.mdc.valuehelp.base.FilterableListContent FilterableListContent}.
2068
2342
  *
2069
2343
  * @since 1.101.0
2070
2344
  *
@@ -2083,9 +2357,63 @@ declare module "sap/ui/mdc/ValueHelpDelegate" {
2083
2357
  * Set of conditions to create filters for
2084
2358
  */
2085
2359
  oConditions: object
2086
- ): object;
2360
+ ): sap.ui.mdc.util.FilterTypeConfig;
2361
+ /**
2362
+ * Provides the possibility to customize selections in 'Select from list' scenarios.
2363
+ * By default, this method only takes {@link sap.ui.mdc.condition.ConditionObject Condition} keys into consideration.
2364
+ * This might be extended with payload-dependent filters.
2365
+ *
2366
+ * @since 1.101.0
2367
+ * @deprecated - (since 1.118.0) - replaced by {@link module:sap/ui/mdc/ValueHelpDelegate.findConditionsForContext findConditionsForContext}
2368
+ *
2369
+ * @returns `true` if item is selected
2370
+ */
2371
+ isFilterableListItemSelected(
2372
+ /**
2373
+ * The `ValueHelp` control instance
2374
+ */
2375
+ oValueHelp: sap.ui.mdc.ValueHelp,
2376
+ /**
2377
+ * `ValueHelp` content instance
2378
+ */
2379
+ oContent: sap.ui.mdc.valuehelp.base.FilterableListContent,
2380
+ /**
2381
+ * Entry of a given list
2382
+ */
2383
+ oItem: {
2384
+ /**
2385
+ * Get the binding context of this object for the given model name.
2386
+ */
2387
+ getBindingContext: Function;
2388
+ },
2389
+ /**
2390
+ * current conditions
2391
+ */
2392
+ aConditions: sap.ui.mdc.condition.ConditionObject[]
2393
+ ): boolean;
2394
+ /**
2395
+ * Determines is the filtering used for type-ahead is case sensitive.
2396
+ * By default the value of the {@link sap.ui.mdc.base.ListContent#getCaseSensitive CaseSensitive} property
2397
+ * of the content instance is returned. If `$search` or other methods are used this might depend on the
2398
+ * backend logic.
2399
+ *
2400
+ * @since 1.121.0
2401
+ *
2402
+ * @returns If `true` the filtering is case sensitive
2403
+ */
2404
+ isFilteringCaseSensitive(
2405
+ /**
2406
+ * The `ValueHelp` control instance
2407
+ */
2408
+ oValueHelp: sap.ui.mdc.ValueHelp,
2409
+ /**
2410
+ * `ValueHelp` content instance
2411
+ */
2412
+ oContent: sap.ui.mdc.valuehelp.base.ListContent
2413
+ ): boolean;
2087
2414
  /**
2088
2415
  * Checks if a `ListBinding` supports `$search`.
2416
+ * By default, this method returns `false`.
2089
2417
  *
2090
2418
  *
2091
2419
  * @returns `true` if `$search` is supported
@@ -2107,6 +2435,7 @@ declare module "sap/ui/mdc/ValueHelpDelegate" {
2107
2435
  /**
2108
2436
  * Provides the possibility to customize selection events in 'Select from list' scenarios. This enables
2109
2437
  * an application to reuse conditions in collective search scenarios, instead of always creating new ones.
2438
+ * By default, this method returns given changes without modification.
2110
2439
  *
2111
2440
  * @since 1.101.0
2112
2441
  *
@@ -2138,6 +2467,7 @@ declare module "sap/ui/mdc/ValueHelpDelegate" {
2138
2467
  /**
2139
2468
  * Callback invoked every time a {@link sap.ui.mdc.ValueHelp ValueHelp} fires a `select` event or the value
2140
2469
  * of the corresponding field changes. This callback can be used to update external fields.
2470
+ * By default, this method is empty.
2141
2471
  *
2142
2472
  * @since 1.101.0
2143
2473
  */
@@ -2158,13 +2488,14 @@ declare module "sap/ui/mdc/ValueHelpDelegate" {
2158
2488
  oConfig: object
2159
2489
  ): void;
2160
2490
  /**
2161
- * Requests the content of the value help.
2491
+ * Requests additional content for the value help.
2162
2492
  *
2163
2493
  * This function is called when the value help is opened or a key or description is requested.
2164
2494
  *
2165
- * So depending on the value help content used, all content controls and data need to be assigned. Once
2166
- * they are assigned and the data is set, the returned `Promise` needs to be resolved. Only then does the
2167
- * value help continue opening or reading data.
2495
+ * So depending on the value help {@link sap.ui.mdc.valuehelp.base.Content Content} used, all content controls
2496
+ * and data need to be assigned. Once they are assigned and the data is set, the returned `Promise` needs
2497
+ * to be resolved. Only then does the value help continue opening or reading data.
2498
+ * By default, this method returns a `Promise` that resolves into `undefined`.
2168
2499
  *
2169
2500
  *
2170
2501
  * @returns `Promise` that is resolved if all content is available
@@ -2183,12 +2514,58 @@ declare module "sap/ui/mdc/ValueHelpDelegate" {
2183
2514
  */
2184
2515
  sContentId: string
2185
2516
  ): Promise<any>;
2517
+ /**
2518
+ * Determines if the value help is opened when the user clicks into the connected control.
2519
+ * By default, the value of the {@link sap.ui.mdc.valuehelp.Popover#getOpensOnClick opensOnClick} property
2520
+ * is returned, if set, or the content configuration is checked.
2521
+ *
2522
+ * Currently this is only supported for the type-ahead container.
2523
+ *
2524
+ * @since 1.121.0
2525
+ *
2526
+ * @returns If `true`, the value help is opened when user clicks into the connected field control
2527
+ */
2528
+ shouldOpenOnClick(
2529
+ /**
2530
+ * The `ValueHelp` control instance
2531
+ */
2532
+ oValueHelp: sap.ui.mdc.ValueHelp,
2533
+ /**
2534
+ * Container instance
2535
+ */
2536
+ oContainer: sap.ui.mdc.valuehelp.base.Container
2537
+ ): Promise<boolean>;
2538
+ /**
2539
+ * Determines if the value help is opened when the user focuses on the connected control.
2540
+ * By default, the value of the {@link sap.ui.mdc.valuehelp.Popover#getOpensOnFocus opensOnFocus} property
2541
+ * is returned.
2542
+ *
2543
+ * Currently this is only supported for the type-ahead container.
2544
+ *
2545
+ * @since 1.121.0
2546
+ *
2547
+ * @returns If `true`, the value help is opened when user focuses on the connected field control
2548
+ */
2549
+ shouldOpenOnFocus(
2550
+ /**
2551
+ * The `ValueHelp` control instance
2552
+ */
2553
+ oValueHelp: sap.ui.mdc.ValueHelp,
2554
+ /**
2555
+ * Container instance
2556
+ */
2557
+ oContainer: sap.ui.mdc.valuehelp.base.Container
2558
+ ): Promise<boolean>;
2186
2559
  /**
2187
2560
  * Controls if a type-ahead is opened or closed.
2561
+ * By default, this method returns `false` if a given content is a {@link sap.ui.mdc.valuehelp.base.FilterableListContent FilterableListContent }
2562
+ * but no (truthy) `filterValue` is applied. Otherwise, if the given content is either a {@link sap.ui.mdc.valuehelp.base.ListContent ListContent }
2563
+ * with available contexts or any other type of {@link sap.ui.mdc.valuehelp.base.Content Content}, `true`
2564
+ * is returned.
2188
2565
  *
2189
2566
  * @since 1.110.0
2190
2567
  *
2191
- * @returns Boolean or `Promise` resolving into a boolean indicating the desired behavior
2568
+ * @returns Boolean or `Promise` that resolves into a `boolean` indicating the desired behavior
2192
2569
  */
2193
2570
  showTypeahead(
2194
2571
  /**
@@ -2199,9 +2576,12 @@ declare module "sap/ui/mdc/ValueHelpDelegate" {
2199
2576
  * `ValueHelp` Content requesting conditions configuration
2200
2577
  */
2201
2578
  oContent: sap.ui.mdc.valuehelp.base.Content
2202
- ): Promise<any> | boolean;
2579
+ ): Promise<boolean> | boolean;
2203
2580
  /**
2204
2581
  * Executes a filter in a `ListBinding` and resumes it, if suspended.
2582
+ * By default, this method applies `filters` found in the given {@link sap.ui.base.ManagedObject.AggregationBindingInfo AggregationBindingInfo }
2583
+ * to the given {@link sap.ui.model.ListBinding ListBinding}. A suspended `ListBinding` is also resumed
2584
+ * afterwards.
2205
2585
  *
2206
2586
  * @since 1.110.0
2207
2587
  */
@@ -2225,6 +2605,8 @@ declare module "sap/ui/mdc/ValueHelpDelegate" {
2225
2605
  ): void;
2226
2606
  /**
2227
2607
  * Adjustable filtering for list-based contents.
2608
+ * By default, this method updates a given {@link sap.ui.base.ManagedObject.AggregationBindingInfo AggregationBindingInfo }
2609
+ * with the return value from the delegate's own {@link module:sap/ui/mdc/ValueHelpDelegate.getFilters getFilters}.
2228
2610
  *
2229
2611
  * @since 1.110.0
2230
2612
  */
@@ -2278,7 +2660,7 @@ declare namespace sap {
2278
2660
  /**
2279
2661
  * Control that is shown when there is no data available inside the chart.
2280
2662
  * This can be used if the standard behavior of the used chart control needs to be overriden.
2281
- * To show this `noDataContent`, set {@link sap.ui.mdc.chart.ChartImplementationContainer#setShowNoDataStruct showNoDataStruct}.
2663
+ * To show this `noDataContent`, set {@link #getShowNoDataStruct showNoDataStruct}.
2282
2664
  */
2283
2665
  noDataContent?: sap.ui.core.Control;
2284
2666
 
@@ -2449,7 +2831,7 @@ declare namespace sap {
2449
2831
  * ID of the element which is the current target of the association {@link #getChartNoDataContent chartNoDataContent},
2450
2832
  * or `null`.
2451
2833
  */
2452
- getChartNoDataContent(): sap.ui.core.ID;
2834
+ getChartNoDataContent(): sap.ui.core.ID | null;
2453
2835
  /**
2454
2836
  * Gets content of aggregation {@link #getContent content}.
2455
2837
  *
@@ -2461,7 +2843,7 @@ declare namespace sap {
2461
2843
  *
2462
2844
  * Control that is shown when there is no data available inside the chart.
2463
2845
  * This can be used if the standard behavior of the used chart control needs to be overriden.
2464
- * To show this `noDataContent`, set {@link sap.ui.mdc.chart.ChartImplementationContainer#setShowNoDataStruct showNoDataStruct}.
2846
+ * To show this `noDataContent`, set {@link #getShowNoDataStruct showNoDataStruct}.
2465
2847
  */
2466
2848
  getNoDataContent(): sap.ui.core.Control;
2467
2849
  /**
@@ -3115,46 +3497,14 @@ declare namespace sap {
3115
3497
  *
3116
3498
  * When specifying the `PropertyInfo` objects in the {@link sap.ui.mdc.Chart#getPropertyInfo propertyInfo }
3117
3499
  * property, the following attributes need to be specified:
3500
+ * - `key`
3118
3501
  * - `label`
3119
- * - `propertyPath`
3502
+ * - `groupable`
3503
+ * - `aggregatable`
3504
+ * - `role`
3505
+ * - `dataType`
3120
3506
  */
3121
- type PropertyInfo = {
3122
- /**
3123
- * The path to the property in the back end
3124
- */
3125
- propertyPath: string;
3126
- /**
3127
- * The identifier of the property
3128
- */
3129
- name?: string;
3130
- /**
3131
- * The label of the identifier
3132
- */
3133
- label: string;
3134
- /**
3135
- * The tooltip of the identifier
3136
- */
3137
- tooltip?: string;
3138
- /**
3139
- * The name of the data type of the property
3140
- */
3141
- datatype: string;
3142
- /**
3143
- * Defines constraints for the data type of the property
3144
- */
3145
- constraints?: object;
3146
- /**
3147
- * Defines formatting options for the data type of the property
3148
- */
3149
- formatOptions?: object;
3150
- /**
3151
- * Defines if the filter is mandatory
3152
- */
3153
- required?: boolean;
3154
- /**
3155
- * Defines if the filter supports multiple values `-1` or single values `1`
3156
- */
3157
- maxConditions: int;
3507
+ type PropertyInfo = sap.ui.mdc.util.PropertyInfo & {
3158
3508
  /**
3159
3509
  * Defines whether the property is groupable and is selectable as a dimension in the chart
3160
3510
  */
@@ -3183,6 +3533,15 @@ declare namespace sap {
3183
3533
  * The text property used for the dimension
3184
3534
  */
3185
3535
  textProperty?: string;
3536
+ /**
3537
+ * The text formatter object which can be used to format the textProperty
3538
+ */
3539
+ textFormatter?: object;
3540
+ /**
3541
+ * The name of the unit property which will be used to display and format measure values with a unit value
3542
+ * on a selectionDetails popover
3543
+ */
3544
+ unitPath?: object;
3186
3545
  };
3187
3546
 
3188
3547
  /**
@@ -3934,10 +4293,6 @@ declare namespace sap {
3934
4293
  * Drill-down and drill-up action.
3935
4294
  */
3936
4295
  DrillDownUp = "DrillDownUp",
3937
- /**
3938
- * Full screen action.
3939
- */
3940
- FullScreen = "FullScreen",
3941
4296
  /**
3942
4297
  * Legend action.
3943
4298
  */
@@ -4153,7 +4508,7 @@ declare namespace sap {
4153
4508
  * "equal to" operator
4154
4509
  *
4155
4510
  * Depending on the used `DisplayFormat`, the key, the description, or both are used as output of formatting
4156
- * during parsing.
4511
+ * and during parsing.
4157
4512
  *
4158
4513
  * The operator is available for all data types.
4159
4514
  *
@@ -4692,113 +5047,116 @@ declare namespace sap {
4692
5047
  Static = "static",
4693
5048
  }
4694
5049
  /**
4695
- * Defines the growing options of the responsive table.
5050
+ * Growing mode of the table.
4696
5051
  *
4697
5052
  * @since 1.115
4698
5053
  */
4699
5054
  enum TableGrowingMode {
4700
5055
  /**
4701
- * Basic growing takes place (`growing` is set in the responsive table)
5056
+ * A More is shown with which the user can request to load more rows
4702
5057
  */
4703
5058
  Basic = "Basic",
4704
5059
  /**
4705
- * Growing does not take place (`growing` is not set in the responsive table)
5060
+ * A fixed number of rows is shown
4706
5061
  */
4707
5062
  None = "None",
4708
5063
  /**
4709
- * Growing with `scroll` takes place (`growing` and `growingScrollToLoad` are set in the responsive table)
5064
+ * Either the user requests to load more rows by scrolling down, or the More button is displayed if no scrolling
5065
+ * is required because the table is fully visible
4710
5066
  */
4711
5067
  Scroll = "Scroll",
4712
5068
  }
4713
5069
  /**
4714
- * Defines the personalization mode of the table.
5070
+ * Personalization mode of the table.
4715
5071
  *
4716
5072
  * @since 1.115
4717
5073
  */
4718
5074
  enum TableP13nMode {
4719
5075
  /**
4720
- * Aggregation personalization is enabled.
5076
+ * The table can be aggregated
4721
5077
  */
4722
5078
  Aggregate = "Aggregate",
4723
5079
  /**
4724
- * Column personalization is enabled.
5080
+ * Columns can be shown, hidden and reordered
4725
5081
  */
4726
5082
  Column = "Column",
4727
5083
  /**
4728
- * Filter personalization is enabled.
5084
+ * The table can be filtered
4729
5085
  */
4730
5086
  Filter = "Filter",
4731
5087
  /**
4732
- * Group personalization is enabled.
5088
+ * The table can be grouped
4733
5089
  */
4734
5090
  Group = "Group",
4735
5091
  /**
4736
- * Sort personalization is enabled.
5092
+ * The table can be sorted
4737
5093
  */
4738
5094
  Sort = "Sort",
4739
5095
  }
4740
5096
  /**
4741
- * Defines the actions that can be used in the table.
5097
+ * Type of a table row action.
4742
5098
  *
4743
5099
  * @since 1.115
4744
5100
  */
4745
- enum TableRowAction {
5101
+ enum TableRowActionType {
4746
5102
  /**
4747
- * Navigation arrow (chevron) is shown in the table rows/items.
5103
+ * Navigation arrow (chevron) is shown
4748
5104
  */
4749
5105
  Navigation = "Navigation",
4750
5106
  }
4751
5107
  /**
4752
- * Defines the row count mode of the GridTable.
5108
+ * Row count mode of the table.
4753
5109
  *
4754
5110
  * @since 1.115
4755
5111
  */
4756
5112
  enum TableRowCountMode {
4757
5113
  /**
4758
- * The table automatically fills the height of the surrounding container.
5114
+ * The table automatically fills the height of the surrounding container
4759
5115
  */
4760
5116
  Auto = "Auto",
4761
5117
  /**
4762
- * The table always has as many rows as defined in the `rowCount` property of `GridTableType`.
5118
+ * A fixed number of rows is shown
4763
5119
  */
4764
5120
  Fixed = "Fixed",
4765
5121
  }
4766
5122
  /**
4767
- * Defines the mode of the table.
5123
+ * Selection mode of the table.
4768
5124
  *
4769
5125
  * @since 1.115
4770
5126
  */
4771
5127
  enum TableSelectionMode {
4772
5128
  /**
4773
- * Multiple rows/items can be selected at a time.
5129
+ * Multiple rows can be selected at a time
4774
5130
  */
4775
5131
  Multi = "Multi",
4776
5132
  /**
4777
- * No rows/items can be selected (default).
5133
+ * No row selection available
4778
5134
  */
4779
5135
  None = "None",
4780
5136
  /**
4781
- * Only one row/item can be selected at a time.
5137
+ * Only one row can be selected at a time
4782
5138
  */
4783
5139
  Single = "Single",
4784
5140
  /**
4785
- * Only one row/item can be selected at a time. Should be used for navigation scenarios to indicate the
4786
- * navigated row/item. If this selection mode is used, no `rowPress` event is fired.
5141
+ * Only one row can be selected at a time. The selection column is not shown. Instead, the user can press
5142
+ * the row to select it.
5143
+ *
5144
+ * **Note:** If this selection mode is used, the table does not fire the `rowPress` event
4787
5145
  */
4788
5146
  SingleMaster = "SingleMaster",
4789
5147
  }
4790
5148
  /**
4791
- * Defines the type of table used in the MDC table.
5149
+ * Type of the table.
4792
5150
  *
4793
5151
  * @since 1.115
4794
5152
  */
4795
5153
  enum TableType {
4796
5154
  /**
4797
- * Responsive table ({@link sap.m.Table} control) is used.
5155
+ * Equivalent to the default configuration of {@link sap.ui.mdc.table.ResponsiveTableType}
4798
5156
  */
4799
5157
  ResponsiveTable = "ResponsiveTable",
4800
5158
  /**
4801
- * Grid table ({@link sap.ui.table.Table} control) is used (default)
5159
+ * Equivalent to the default configuration of {@link sap.ui.mdc.table.GridTableType}
4802
5160
  */
4803
5161
  Table = "Table",
4804
5162
  }
@@ -4831,6 +5189,9 @@ declare namespace sap {
4831
5189
  interface $FieldBaseSettings extends sap.ui.mdc.$ControlSettings {
4832
5190
  /**
4833
5191
  * The type of data handled by the field. This type is used to parse, format, and validate the value.
5192
+ *
5193
+ * **Note:** The module of the data type should be loaded before it is assigned to the field. Otherwise
5194
+ * the asynchronous loading of the module might lead to unwanted side effects.
4834
5195
  */
4835
5196
  dataType?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
4836
5197
 
@@ -4989,13 +5350,21 @@ declare namespace sap {
4989
5350
  label?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
4990
5351
 
4991
5352
  /**
4992
- * Path to `FieldBaseDelegate` module that provides the required APIs to execute model-specific logic.
5353
+ * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
5354
+ * The object has the following properties:
5355
+ * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/field/FieldBaseDelegate FieldBaseDelegate }
5356
+ *
5357
+ * - `payload` (optional) defines application-specific information that can be used in the given delegate
5358
+ * Sample delegate object:
5359
+ * ```javascript
5360
+ * {
5361
+ * name: "sap/ui/mdc/field/FieldBaseDelegate",
5362
+ * payload: {}
5363
+ * }```
4993
5364
  * **Note:** Ensure that the related file can be requested (any required library has to be loaded before
4994
5365
  * that).
4995
- * Do not bind or modify the module. Once the required module is associated, this property might not be
4996
- * needed any longer.
5366
+ * Do not bind or modify the module. This property can only be configured during control initialization.
4997
5367
  *
4998
- * @since 1.72.0
4999
5368
  * @experimental
5000
5369
  */
5001
5370
  delegate?:
@@ -6267,7 +6636,12 @@ declare namespace sap {
6267
6636
  /**
6268
6637
  * @since 1.98 Further control-specific setting of the focus target within the control
6269
6638
  */
6270
- targetInfo?: any;
6639
+ targetInfo?: {
6640
+ /**
6641
+ * @since 1.114 Suppresses typeahead opening
6642
+ */
6643
+ silent?: boolean;
6644
+ };
6271
6645
  }
6272
6646
  ): void;
6273
6647
  /**
@@ -6393,6 +6767,8 @@ declare namespace sap {
6393
6767
  */
6394
6768
  getContentEdit(): sap.ui.core.Control;
6395
6769
  /**
6770
+ * Returns the `ContentFactory` used to manage the internal content control.
6771
+ *
6396
6772
  * @ui5-protected Do not call from applications (only from related classes in the framework)
6397
6773
  *
6398
6774
  * @returns oContentFactory the ContentFactory of the Field
@@ -6411,6 +6787,9 @@ declare namespace sap {
6411
6787
  *
6412
6788
  * The type of data handled by the field. This type is used to parse, format, and validate the value.
6413
6789
  *
6790
+ * **Note:** The module of the data type should be loaded before it is assigned to the field. Otherwise
6791
+ * the asynchronous loading of the module might lead to unwanted side effects.
6792
+ *
6414
6793
  * Default value is `'sap.ui.model.type.String'`.
6415
6794
  *
6416
6795
  *
@@ -6438,15 +6817,23 @@ declare namespace sap {
6438
6817
  /**
6439
6818
  * Gets current value of property {@link #getDelegate delegate}.
6440
6819
  *
6441
- * Path to `FieldBaseDelegate` module that provides the required APIs to execute model-specific logic.
6820
+ * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
6821
+ * The object has the following properties:
6822
+ * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/field/FieldBaseDelegate FieldBaseDelegate }
6823
+ *
6824
+ * - `payload` (optional) defines application-specific information that can be used in the given delegate
6825
+ * Sample delegate object:
6826
+ * ```javascript
6827
+ * {
6828
+ * name: "sap/ui/mdc/field/FieldBaseDelegate",
6829
+ * payload: {}
6830
+ * }```
6442
6831
  * **Note:** Ensure that the related file can be requested (any required library has to be loaded before
6443
6832
  * that).
6444
- * Do not bind or modify the module. Once the required module is associated, this property might not be
6445
- * needed any longer.
6833
+ * Do not bind or modify the module. This property can only be configured during control initialization.
6446
6834
  *
6447
6835
  * Default value is `...see text or source`.
6448
6836
  *
6449
- * @since 1.72.0
6450
6837
  * @experimental
6451
6838
  *
6452
6839
  * @returns Value of property `delegate`
@@ -6480,7 +6867,7 @@ declare namespace sap {
6480
6867
  *
6481
6868
  * @deprecated (since 1.114.0) - replaced by {@link #setValueHelp valueHelp} association
6482
6869
  */
6483
- getFieldHelp(): sap.ui.core.ID;
6870
+ getFieldHelp(): sap.ui.core.ID | null;
6484
6871
  /**
6485
6872
  * Gets content of aggregation {@link #getFieldInfo fieldInfo}.
6486
6873
  *
@@ -6660,7 +7047,7 @@ declare namespace sap {
6660
7047
  * ID of the element which is the current target of the association {@link #getValueHelp valueHelp}, or
6661
7048
  * `null`.
6662
7049
  */
6663
- getValueHelp(): sap.ui.core.ID;
7050
+ getValueHelp(): sap.ui.core.ID | null;
6664
7051
  /**
6665
7052
  * Gets current value of property {@link #getValueState valueState}.
6666
7053
  *
@@ -6896,6 +7283,9 @@ declare namespace sap {
6896
7283
  *
6897
7284
  * The type of data handled by the field. This type is used to parse, format, and validate the value.
6898
7285
  *
7286
+ * **Note:** The module of the data type should be loaded before it is assigned to the field. Otherwise
7287
+ * the asynchronous loading of the module might lead to unwanted side effects.
7288
+ *
6899
7289
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6900
7290
  *
6901
7291
  * Default value is `'sap.ui.model.type.String'`.
@@ -6944,17 +7334,25 @@ declare namespace sap {
6944
7334
  /**
6945
7335
  * Sets a new value for property {@link #getDelegate delegate}.
6946
7336
  *
6947
- * Path to `FieldBaseDelegate` module that provides the required APIs to execute model-specific logic.
7337
+ * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
7338
+ * The object has the following properties:
7339
+ * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/field/FieldBaseDelegate FieldBaseDelegate }
7340
+ *
7341
+ * - `payload` (optional) defines application-specific information that can be used in the given delegate
7342
+ * Sample delegate object:
7343
+ * ```javascript
7344
+ * {
7345
+ * name: "sap/ui/mdc/field/FieldBaseDelegate",
7346
+ * payload: {}
7347
+ * }```
6948
7348
  * **Note:** Ensure that the related file can be requested (any required library has to be loaded before
6949
7349
  * that).
6950
- * Do not bind or modify the module. Once the required module is associated, this property might not be
6951
- * needed any longer.
7350
+ * Do not bind or modify the module. This property can only be configured during control initialization.
6952
7351
  *
6953
7352
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6954
7353
  *
6955
7354
  * Default value is `...see text or source`.
6956
7355
  *
6957
- * @since 1.72.0
6958
7356
  * @experimental
6959
7357
  *
6960
7358
  * @returns Reference to `this` in order to allow method chaining
@@ -7582,41 +7980,15 @@ declare namespace sap {
7582
7980
  */
7583
7981
  open(
7584
7982
  /**
7585
- * Optional control reference to which the popover is attached. By default the parent is used as reference.
7983
+ * Optional control reference to which the popover is
7586
7984
  */
7587
- oControl: sap.ui.core.Control
7588
- ): Promise<any>;
7589
- }
7590
- /**
7591
- * Delegate class for `sap.ui.mdc.MultiValueField`.
7592
- *
7593
- *
7594
- * @since 1.93.0
7595
- */
7596
- class MultiValueFieldDelegate {
7597
- constructor();
7598
-
7599
- /**
7600
- * Implements the model-specific logic to update items after conditions have been updated.
7601
- *
7602
- * Items can be removed, updated, or added. Use the binding information of the `MultiValueField` control
7603
- * to update the data in the model.
7604
- */
7605
- static updateItems(
7606
- /**
7607
- * Payload for delegate
7608
- */
7609
- oPayload: object,
7610
- /**
7611
- * Current conditions of the `MultiValueField` control
7612
- */
7613
- aConditions: sap.ui.mdc.condition.ConditionObject[],
7985
+ oControl: sap.ui.core.Control,
7614
7986
  /**
7615
- * Current `MultiValueField` control to determine binding information to update the values of the corresponding
7616
- * model
7987
+ * Object of the event that gets fired by the `onPress` event of the link in `Field` attached. By default
7988
+ * the parent is used as reference.
7617
7989
  */
7618
- oMultiValueField: sap.ui.mdc.MultiValueField
7619
- ): void;
7990
+ oEvent: sap.ui.base.Event
7991
+ ): Promise<any>;
7620
7992
  }
7621
7993
  /**
7622
7994
  * Base type for `MultiValueFieldItem` control. The {@link sap.ui.mdc.MultiValueField MultiValueField} holds
@@ -7739,24 +8111,6 @@ declare namespace sap {
7739
8111
  ): this;
7740
8112
  }
7741
8113
 
7742
- /**
7743
- * Return object for the autocomplete feature.
7744
- */
7745
- type AutocompleteInfo = {
7746
- /**
7747
- * Complete text that is shown in the field
7748
- */
7749
- text: string;
7750
- /**
7751
- * Start of the selected text
7752
- */
7753
- selectionStart: int;
7754
- /**
7755
- * End of the selected text
7756
- */
7757
- selectionEnd: int;
7758
- };
7759
-
7760
8114
  type FieldBase$LiveChangeEvent = sap.ui.base.Event<
7761
8115
  FieldBase$LiveChangeEventParameters,
7762
8116
  FieldBase
@@ -7797,7 +8151,16 @@ declare namespace sap {
7797
8151
  interface $FilterBarSettings
7798
8152
  extends sap.ui.mdc.filterbar.$FilterBarBaseSettings {
7799
8153
  /**
7800
- * Path to the `Delegate` module that provides the required APIs to execute model-specific logic.
8154
+ * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
8155
+ * The object has the following properties:
8156
+ * - `name` defines the path to the `Delegate` module
8157
+ * - `payload` (optional) defines application-specific information that can be used in the given delegate
8158
+ * Sample delegate object:
8159
+ * ```javascript
8160
+ * {
8161
+ * name: "sap/ui/mdc/BaseDelegate",
8162
+ * payload: {}
8163
+ * }```
7801
8164
  * **Note:** Ensure that the related file can be requested (any required library has to be loaded before
7802
8165
  * that).
7803
8166
  * Do not bind or modify the module. This property can only be configured during control initialization.
@@ -7832,8 +8195,8 @@ declare namespace sap {
7832
8195
  * and the width of the filters. The Go button triggers the search event, and the Show Filters button shows
7833
8196
  * the additional filter field.
7834
8197
  * The `FilterBar` control creates and handles the filters based on the provided metadata information.
7835
- * The metadata information is provided via the {@link sap.ui.mdc.FilterBarDelegate FilterBarDelegate} implementation.
7836
- * This implementation has to be provided by the application.
8198
+ * The metadata information is provided via the {@link module:sap/ui/mdc/FilterBarDelegate FilterBarDelegate }
8199
+ * implementation. This implementation has to be provided by the application.
7837
8200
  * **Note:** The `FilterBar` can only be used for a {@link sap.ui.mdc.valuehelp.Dialog Dialog} and not
7838
8201
  * on its own.
7839
8202
  *
@@ -7902,31 +8265,19 @@ declare namespace sap {
7902
8265
  * @returns Metadata object describing this class
7903
8266
  */
7904
8267
  static getMetadata(): sap.ui.core.ElementMetadata;
7905
- /**
7906
- * Destroys the {@link sap.ui.mdc.filterbar.vh.CollectiveSearchSelect CollectiveSearchSelect} control.
7907
- *
7908
- * **Note:** This must only be used by the corresponding value help, not from outside.
7909
- *
7910
- * @ui5-protected Do not call from applications (only from related classes in the framework)
7911
- *
7912
- * @returns Reference to `this` to allow method chaining
7913
- */
7914
- destroyCollectiveSearch(): this;
7915
- /**
7916
- * Gets the {@link sap.ui.mdc.filterbar.vh.CollectiveSearchSelect CollectiveSearchSelect} control
7917
- *
7918
- * **Note:** This must only be used by the corresponding value help, not from outside.
7919
- *
7920
- * @ui5-protected Do not call from applications (only from related classes in the framework)
7921
- *
7922
- * @returns Instance of the {@link sap.ui.mdc.filterbar.vh.CollectiveSearchSelect CollectiveSearchSelect }
7923
- * control
7924
- */
7925
- getCollectiveSearch(): /* was: sap.ui.mdc.filterbar.vh.CollectiveSearchSelect */ any;
7926
8268
  /**
7927
8269
  * Gets current value of property {@link #getDelegate delegate}.
7928
8270
  *
7929
- * Path to the `Delegate` module that provides the required APIs to execute model-specific logic.
8271
+ * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
8272
+ * The object has the following properties:
8273
+ * - `name` defines the path to the `Delegate` module
8274
+ * - `payload` (optional) defines application-specific information that can be used in the given delegate
8275
+ * Sample delegate object:
8276
+ * ```javascript
8277
+ * {
8278
+ * name: "sap/ui/mdc/BaseDelegate",
8279
+ * payload: {}
8280
+ * }```
7930
8281
  * **Note:** Ensure that the related file can be requested (any required library has to be loaded before
7931
8282
  * that).
7932
8283
  * Do not bind or modify the module. This property can only be configured during control initialization.
@@ -7962,25 +8313,19 @@ declare namespace sap {
7962
8313
  * @returns Value of property `filterFieldThreshold`
7963
8314
  */
7964
8315
  getFilterFieldThreshold(): int;
7965
- /**
7966
- * Sets the {@link sap.ui.mdc.filterbar.vh.CollectiveSearchSelect CollectiveSearchSelect} control.
7967
- *
7968
- * **Note:** This must only be done by the corresponding value help, not from outside.
7969
- *
7970
- * @ui5-protected Do not call from applications (only from related classes in the framework)
7971
- *
7972
- * @returns Reference to `this` to allow method chaining
7973
- */
7974
- setCollectiveSearch(
7975
- /**
7976
- * Instance of the {@link sap.ui.mdc.filterbar.vh.CollectiveSearchSelect CollectiveSearchSelect} control
7977
- */
7978
- oCollectiveSearch: /* was: sap.ui.mdc.filterbar.vh.CollectiveSearchSelect */ any
7979
- ): this;
7980
8316
  /**
7981
8317
  * Sets a new value for property {@link #getDelegate delegate}.
7982
8318
  *
7983
- * Path to the `Delegate` module that provides the required APIs to execute model-specific logic.
8319
+ * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
8320
+ * The object has the following properties:
8321
+ * - `name` defines the path to the `Delegate` module
8322
+ * - `payload` (optional) defines application-specific information that can be used in the given delegate
8323
+ * Sample delegate object:
8324
+ * ```javascript
8325
+ * {
8326
+ * name: "sap/ui/mdc/BaseDelegate",
8327
+ * payload: {}
8328
+ * }```
7984
8329
  * **Note:** Ensure that the related file can be requested (any required library has to be loaded before
7985
8330
  * that).
7986
8331
  * Do not bind or modify the module. This property can only be configured during control initialization.
@@ -8042,14 +8387,21 @@ declare namespace sap {
8042
8387
 
8043
8388
  interface $FilterBarBaseSettings extends sap.ui.mdc.$ControlSettings {
8044
8389
  /**
8045
- * Defines the path to the metadata retrieval class for the `FilterBarBase` control. It basically identifies
8046
- * the {@link sap.ui.mdc.FilterBarDelegate FilterBarDelegate} file that provides the required APIs to create
8047
- * the content of the {@link sap.ui.mdc.FilterBar FilterBar} control.
8390
+ * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
8391
+ * The object has the following properties:
8392
+ * - `name` defines the path to the `Delegate` module
8393
+ * - `payload` (optional) defines application-specific information that can be used in the given delegate
8394
+ * Sample delegate object:
8395
+ * ```javascript
8396
+ * {
8397
+ * name: "sap/ui/mdc/BaseDelegate",
8398
+ * payload: {}
8399
+ * }```
8048
8400
  * **Note:** Ensure that the related file can be requested (any required library has to be loaded before
8049
8401
  * that).
8050
- * **Note:** This property must not be bound.
8402
+ * Do not bind or modify the module. This property can only be configured during control initialization.
8051
8403
  *
8052
- * @since 1.74
8404
+ * @experimental
8053
8405
  */
8054
8406
  delegate?:
8055
8407
  | object
@@ -8502,16 +8854,23 @@ declare namespace sap {
8502
8854
  /**
8503
8855
  * Gets current value of property {@link #getDelegate delegate}.
8504
8856
  *
8505
- * Defines the path to the metadata retrieval class for the `FilterBarBase` control. It basically identifies
8506
- * the {@link sap.ui.mdc.FilterBarDelegate FilterBarDelegate} file that provides the required APIs to create
8507
- * the content of the {@link sap.ui.mdc.FilterBar FilterBar} control.
8857
+ * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
8858
+ * The object has the following properties:
8859
+ * - `name` defines the path to the `Delegate` module
8860
+ * - `payload` (optional) defines application-specific information that can be used in the given delegate
8861
+ * Sample delegate object:
8862
+ * ```javascript
8863
+ * {
8864
+ * name: "sap/ui/mdc/BaseDelegate",
8865
+ * payload: {}
8866
+ * }```
8508
8867
  * **Note:** Ensure that the related file can be requested (any required library has to be loaded before
8509
8868
  * that).
8510
- * **Note:** This property must not be bound.
8869
+ * Do not bind or modify the module. This property can only be configured during control initialization.
8511
8870
  *
8512
8871
  * Default value is `...see text or source`.
8513
8872
  *
8514
- * @since 1.74
8873
+ * @experimental
8515
8874
  *
8516
8875
  * @returns Value of property `delegate`
8517
8876
  */
@@ -8589,7 +8948,7 @@ declare namespace sap {
8589
8948
  * ID of the element which is the current target of the association {@link #getVariantBackreference variantBackreference},
8590
8949
  * or `null`.
8591
8950
  */
8592
- getVariantBackreference(): sap.ui.core.ID;
8951
+ getVariantBackreference(): sap.ui.core.ID | null;
8593
8952
  /**
8594
8953
  * Checks for the provided `sap.ui.mdc.FilterField` in the aggregation {@link #getFilterItems filterItems}.
8595
8954
  * and returns its index if found or -1 otherwise.
@@ -8632,18 +8991,25 @@ declare namespace sap {
8632
8991
  /**
8633
8992
  * Sets a new value for property {@link #getDelegate delegate}.
8634
8993
  *
8635
- * Defines the path to the metadata retrieval class for the `FilterBarBase` control. It basically identifies
8636
- * the {@link sap.ui.mdc.FilterBarDelegate FilterBarDelegate} file that provides the required APIs to create
8637
- * the content of the {@link sap.ui.mdc.FilterBar FilterBar} control.
8994
+ * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
8995
+ * The object has the following properties:
8996
+ * - `name` defines the path to the `Delegate` module
8997
+ * - `payload` (optional) defines application-specific information that can be used in the given delegate
8998
+ * Sample delegate object:
8999
+ * ```javascript
9000
+ * {
9001
+ * name: "sap/ui/mdc/BaseDelegate",
9002
+ * payload: {}
9003
+ * }```
8638
9004
  * **Note:** Ensure that the related file can be requested (any required library has to be loaded before
8639
9005
  * that).
8640
- * **Note:** This property must not be bound.
9006
+ * Do not bind or modify the module. This property can only be configured during control initialization.
8641
9007
  *
8642
9008
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8643
9009
  *
8644
9010
  * Default value is `...see text or source`.
8645
9011
  *
8646
- * @since 1.74
9012
+ * @experimental
8647
9013
  *
8648
9014
  * @returns Reference to `this` in order to allow method chaining
8649
9015
  */
@@ -8753,8 +9119,8 @@ declare namespace sap {
8753
9119
  * Triggers the search.
8754
9120
  *
8755
9121
  *
8756
- * @returns If the {@link sap.ui.mdc.FilterBarBase#setSuspendSelection suspendSelection} property is set
8757
- * to `true`, the method will be immediately resolved, otherwise it returns the result of the {@link sap.ui.mdc.FilterBarBase#validate }
9122
+ * @returns If the {@link sap.ui.mdc.filterbar.FilterBarBase#setSuspendSelection suspendSelection} property
9123
+ * is set to `true`, the method will be immediately resolved, otherwise it returns the result of the {@link sap.ui.mdc.filterbar.FilterBarBase#validate }
8758
9124
  * call.
8759
9125
  */
8760
9126
  triggerSearch(): Promise<any>;
@@ -8830,51 +9196,6 @@ declare namespace sap {
8830
9196
  * @since 1.112.0
8831
9197
  */
8832
9198
  type PropertyInfo = sap.ui.mdc.util.PropertyInfo & {
8833
- /**
8834
- * The identifier of the property
8835
- */
8836
- path: string;
8837
- /**
8838
- * The alternative identifier of the property. Either `path` or `name` property can be used. The `path`
8839
- * is the preferred property.
8840
- */
8841
- name?: string;
8842
- /**
8843
- * The label of the identifier
8844
- */
8845
- label: string;
8846
- /**
8847
- * The tooltip of the identifier
8848
- */
8849
- tooltip?: string;
8850
- /**
8851
- * The data type of the property
8852
- */
8853
- dataType: string;
8854
- /**
8855
- * Defines constraints for the data type of the property
8856
- */
8857
- constraints?: object;
8858
- /**
8859
- * Defines format options for the data type of the property
8860
- */
8861
- formatOptions?: object;
8862
- /**
8863
- * The group identifier to which the property belongs
8864
- */
8865
- group?: string;
8866
- /**
8867
- * The group name of the group identifier
8868
- */
8869
- groupLabel?: string;
8870
- /**
8871
- * If set to `true`, the filter value is treated as case-sensitive
8872
- */
8873
- caseSensitive?: boolean;
8874
- /**
8875
- * Describes how the value will be presented to the user
8876
- */
8877
- display?: sap.ui.mdc.enums.FieldDisplay;
8878
9199
  /**
8879
9200
  * If set to `false`, the filter is visible in the `FilterBar`
8880
9201
  */
@@ -8883,10 +9204,6 @@ declare namespace sap {
8883
9204
  * If set to `true`, the filter is mandatory
8884
9205
  */
8885
9206
  required?: boolean;
8886
- /**
8887
- * Defines if the filter supports multiple values `-1` or single values `1`
8888
- */
8889
- maxConditions?: int;
8890
9207
  };
8891
9208
 
8892
9209
  type FilterBarBase$FiltersChangedEvent = sap.ui.base.Event<
@@ -8905,6 +9222,55 @@ declare namespace sap {
8905
9222
  * @since 1.74.0
8906
9223
  */
8907
9224
  namespace util {
9225
+ /**
9226
+ * Map-like configuration object for filter creation.
9227
+ * The keys for this object must be aligned with any {@link sap.ui.mdc.util.FilterTypeConfig} the `FilterConditionMap`
9228
+ * is combined with during filter creation.
9229
+ *
9230
+ *
9231
+ * **Structure:** Object.<string, {@link sap.ui.mdc.condition.ConditionObject sap.ui.mdc.condition.ConditionObject[]}>
9232
+ *
9233
+ * @since 1.121.0
9234
+ */
9235
+ type FilterConditionMap = Record<
9236
+ string,
9237
+ sap.ui.mdc.condition.ConditionObject[]
9238
+ >;
9239
+
9240
+ /**
9241
+ * Map-like configuration object for filter creation.
9242
+ * The keys for this object must be aligned with any {@link sap.ui.mdc.util.FilterConditionMap} the `FilterTypeConfig`
9243
+ * is combined with during filter creation.
9244
+ *
9245
+ * **Structure:** Object.<string, {@link sap.ui.mdc.util.FilterTypeConfigEntry}>
9246
+ *
9247
+ * @since 1.121.0
9248
+ */
9249
+ type FilterTypeConfig = Record<
9250
+ string,
9251
+ sap.ui.mdc.util.FilterTypeConfigEntry
9252
+ >;
9253
+
9254
+ /**
9255
+ * Configuration object for filter creation.
9256
+ *
9257
+ * @since 1.121.0
9258
+ */
9259
+ type FilterTypeConfigEntry = {
9260
+ /**
9261
+ * Type instance
9262
+ */
9263
+ type: sap.ui.model.Type;
9264
+ /**
9265
+ * Indicates if a created filter is case-sensitive
9266
+ */
9267
+ caseSensitive?: boolean;
9268
+ /**
9269
+ * BaseType configuration for the given type useful for externalization/internalization of filter values
9270
+ */
9271
+ baseType?: sap.ui.mdc.enums.BaseType;
9272
+ };
9273
+
8908
9274
  /**
8909
9275
  * An object literal describing a data property.
8910
9276
  */
@@ -8912,9 +9278,10 @@ declare namespace sap {
8912
9278
  /**
8913
9279
  * Unique, stable key for the property. It must only contain characters allowed for IDs, see {@link sap.ui.core.ID}.
8914
9280
  * Does not have to be an existing attribute in the data model or the technical name of an attribute in
8915
- * the data model.
9281
+ * the data model. **Note:** 'key' replaces the deprecated 'name' attribute, which will also be interpolated
9282
+ * by the PropertyHelper for legacy code support.
8916
9283
  */
8917
- name: string;
9284
+ key: string;
8918
9285
  /**
8919
9286
  * The technical path for a data source property.
8920
9287
  */
@@ -9167,7 +9534,7 @@ declare namespace sap {
9167
9534
  *
9168
9535
  * If it is empty, no suggestion is available.
9169
9536
  *
9170
- * @deprecated (since 1.120.2) - replaced in future version by {@link sap.ui.mdc.ValueHelpDelegate.isSearchSupported isSearchSupported}
9537
+ * @deprecated (since 1.120.2) - please see `{@link module:sap/ui/mdc/ValueHelpDelegate.isSearchSupported isSearchSupported}`
9171
9538
  */
9172
9539
  filterFields?:
9173
9540
  | string
@@ -9218,7 +9585,7 @@ declare namespace sap {
9218
9585
  * If set, `getItemForValue` returns the first item that matches the text.
9219
9586
  *
9220
9587
  * In the default implementation, this is the first item that matches the entered text. Which item is used
9221
- * can be determined by implementing {@link sap.ui.mdc.ValueHelpDelegate#getFirstMatch}.
9588
+ * can be determined by implementing {@link module:sap/ui/mdc/ValueHelpDelegate.getFirstMatch getFirstMatch}.
9222
9589
  *
9223
9590
  * The matching item is returned in the `typeaheadSuggested` event and used for the autocomplete feature
9224
9591
  * in the connected field.
@@ -9314,6 +9681,11 @@ declare namespace sap {
9314
9681
  * ID of the suggested item (This is needed to set the corresponding ARIA attribute)
9315
9682
  */
9316
9683
  itemId?: string;
9684
+
9685
+ /**
9686
+ * If `true` the filtering was executed case sensitive
9687
+ */
9688
+ caseSensitive?: boolean;
9317
9689
  }
9318
9690
 
9319
9691
  interface Content$CancelEventParameters {}
@@ -9377,6 +9749,11 @@ declare namespace sap {
9377
9749
  * ID of the suggested item (This is needed to set the corresponding ARIA attribute)
9378
9750
  */
9379
9751
  itemId?: string;
9752
+
9753
+ /**
9754
+ * If `true` the filtering was executed case sensitive
9755
+ */
9756
+ caseSensitive?: boolean;
9380
9757
  }
9381
9758
 
9382
9759
  /**
@@ -11627,6 +12004,14 @@ declare namespace sap {
11627
12004
  * @returns Reference to `this` in order to allow method chaining
11628
12005
  */
11629
12006
  destroyFilterBar(): this;
12007
+ /**
12008
+ * Gets the currently used `FilterBar` control.
12009
+ *
12010
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
12011
+ *
12012
+ * @returns FilterBar
12013
+ */
12014
+ getActiveFilterBar(): sap.ui.mdc.filterbar.vh.FilterBar;
11630
12015
  /**
11631
12016
  * Gets current value of property {@link #getDescriptionPath descriptionPath}.
11632
12017
  *
@@ -11662,7 +12047,7 @@ declare namespace sap {
11662
12047
  *
11663
12048
  * Default value is `empty string`.
11664
12049
  *
11665
- * @deprecated (since 1.120.2) - replaced in future version by {@link sap.ui.mdc.ValueHelpDelegate.isSearchSupported isSearchSupported}
12050
+ * @deprecated (since 1.120.2) - please see `{@link module:sap/ui/mdc/ValueHelpDelegate.isSearchSupported isSearchSupported}`
11666
12051
  *
11667
12052
  * @returns Value of property `filterFields`
11668
12053
  */
@@ -11717,6 +12102,14 @@ declare namespace sap {
11717
12102
  * @returns `ListBindingInfo`
11718
12103
  */
11719
12104
  getListBindingInfo(): sap.ui.base.ManagedObject.AggregationBindingInfo;
12105
+ /**
12106
+ * Gets the currently used filter value.
12107
+ *
12108
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
12109
+ *
12110
+ * @returns filter value
12111
+ */
12112
+ getSearch(): string;
11720
12113
  /**
11721
12114
  * Gets the conditions that are selectable from list content.
11722
12115
  *
@@ -11724,9 +12117,9 @@ declare namespace sap {
11724
12117
  *
11725
12118
  * @ui5-protected Do not call from applications (only from related classes in the framework)
11726
12119
  *
11727
- * @returns ListBindingInfo
12120
+ * @returns Conditions
11728
12121
  */
11729
- getSelectableConditions(): sap.ui.base.ManagedObject.AggregationBindingInfo;
12122
+ getSelectableConditions(): sap.ui.mdc.condition.ConditionObject[];
11730
12123
  /**
11731
12124
  * Sets a new value for property {@link #getDescriptionPath descriptionPath}.
11732
12125
  *
@@ -11777,7 +12170,7 @@ declare namespace sap {
11777
12170
  *
11778
12171
  * Default value is `empty string`.
11779
12172
  *
11780
- * @deprecated (since 1.120.2) - replaced in future version by {@link sap.ui.mdc.ValueHelpDelegate.isSearchSupported isSearchSupported}
12173
+ * @deprecated (since 1.120.2) - please see `{@link module:sap/ui/mdc/ValueHelpDelegate.isSearchSupported isSearchSupported}`
11781
12174
  *
11782
12175
  * @returns Reference to `this` in order to allow method chaining
11783
12176
  */
@@ -11933,6 +12326,9 @@ declare namespace sap {
11933
12326
  * @returns `BindingContexts`
11934
12327
  */
11935
12328
  getRelevantContexts(
12329
+ /**
12330
+ * Configuration
12331
+ */
11936
12332
  oConfig: sap.ui.mdc.valuehelp.base.ItemForValueConfiguration
11937
12333
  ): sap.ui.model.Context[];
11938
12334
  /**
@@ -11952,7 +12348,7 @@ declare namespace sap {
11952
12348
  * If set, `getItemForValue` returns the first item that matches the text.
11953
12349
  *
11954
12350
  * In the default implementation, this is the first item that matches the entered text. Which item is used
11955
- * can be determined by implementing {@link sap.ui.mdc.ValueHelpDelegate#getFirstMatch}.
12351
+ * can be determined by implementing {@link module:sap/ui/mdc/ValueHelpDelegate.getFirstMatch getFirstMatch}.
11956
12352
  *
11957
12353
  * The matching item is returned in the `typeaheadSuggested` event and used for the autocomplete feature
11958
12354
  * in the connected field.
@@ -12009,7 +12405,7 @@ declare namespace sap {
12009
12405
  * If set, `getItemForValue` returns the first item that matches the text.
12010
12406
  *
12011
12407
  * In the default implementation, this is the first item that matches the entered text. Which item is used
12012
- * can be determined by implementing {@link sap.ui.mdc.ValueHelpDelegate#getFirstMatch}.
12408
+ * can be determined by implementing {@link module:sap/ui/mdc/ValueHelpDelegate.getFirstMatch getFirstMatch}.
12013
12409
  *
12014
12410
  * The matching item is returned in the `typeaheadSuggested` event and used for the autocomplete feature
12015
12411
  * in the connected field.
@@ -12386,7 +12782,7 @@ declare namespace sap {
12386
12782
  *
12387
12783
  * @deprecated (since 1.114.0) - replaced by {@link #setValueHelp valueHelp} association
12388
12784
  */
12389
- getFieldHelp(): sap.ui.core.ID;
12785
+ getFieldHelp(): sap.ui.core.ID | null;
12390
12786
  /**
12391
12787
  * Gets current value of property {@link #getLabel label}.
12392
12788
  *
@@ -12400,7 +12796,7 @@ declare namespace sap {
12400
12796
  * ID of the element which is the current target of the association {@link #getValueHelp valueHelp}, or
12401
12797
  * `null`.
12402
12798
  */
12403
- getValueHelp(): sap.ui.core.ID;
12799
+ getValueHelp(): sap.ui.core.ID | null;
12404
12800
  /**
12405
12801
  * Sets the associated {@link #getFieldHelp fieldHelp}.
12406
12802
  *
@@ -13171,9 +13567,10 @@ declare namespace sap {
13171
13567
  *
13172
13568
  * **Note:** By default, a type-ahead is only shown to provide suggestions when users enter input in a connected
13173
13569
  * control. This property enables scenarios where popovers need to be shown earlier (for example, recommendations
13174
- * or recently entered values). See also {@link sap.ui.mdc.ValueHelpDelegate.showTypeahead showTypeahead}
13570
+ * or recently entered values). See also {@link module:sap/ui/mdc/ValueHelpDelegate.showTypeahead showTypeahead}
13175
13571
  *
13176
13572
  * @since 1.110.0
13573
+ * @deprecated (since 1.121.0) - replaced by {@link module:sap/ui/mdc/ValueHelpDelegate.shouldOpenOnClick shouldOpenOnClick}
13177
13574
  */
13178
13575
  opensOnClick?:
13179
13576
  | boolean
@@ -13185,9 +13582,10 @@ declare namespace sap {
13185
13582
  *
13186
13583
  * **Note:** By default, a type-ahead is only shown to provide suggestions when users enter input in a connected
13187
13584
  * control. This property enables scenarios where popovers need to be shown earlier (for example, recommendations
13188
- * or recently entered values). See also {@link sap.ui.mdc.ValueHelpDelegate.showTypeahead showTypeahead}
13585
+ * or recently entered values). See also {@link module:sap/ui/mdc/ValueHelpDelegate.showTypeahead showTypeahead}
13189
13586
  *
13190
13587
  * @since 1.112.0
13588
+ * @deprecated (since 1.121.0) - replaced by {@link module:sap/ui/mdc/ValueHelpDelegate.shouldOpenOnFocus shouldOpenOnFocus}
13191
13589
  */
13192
13590
  opensOnFocus?:
13193
13591
  | boolean
@@ -13403,11 +13801,12 @@ declare namespace sap {
13403
13801
  *
13404
13802
  * **Note:** By default, a type-ahead is only shown to provide suggestions when users enter input in a connected
13405
13803
  * control. This property enables scenarios where popovers need to be shown earlier (for example, recommendations
13406
- * or recently entered values). See also {@link sap.ui.mdc.ValueHelpDelegate.showTypeahead showTypeahead}
13804
+ * or recently entered values). See also {@link module:sap/ui/mdc/ValueHelpDelegate.showTypeahead showTypeahead}
13407
13805
  *
13408
13806
  * Default value is `false`.
13409
13807
  *
13410
13808
  * @since 1.110.0
13809
+ * @deprecated (since 1.121.0) - replaced by {@link module:sap/ui/mdc/ValueHelpDelegate.shouldOpenOnClick shouldOpenOnClick}
13411
13810
  *
13412
13811
  * @returns Value of property `opensOnClick`
13413
13812
  */
@@ -13419,11 +13818,12 @@ declare namespace sap {
13419
13818
  *
13420
13819
  * **Note:** By default, a type-ahead is only shown to provide suggestions when users enter input in a connected
13421
13820
  * control. This property enables scenarios where popovers need to be shown earlier (for example, recommendations
13422
- * or recently entered values). See also {@link sap.ui.mdc.ValueHelpDelegate.showTypeahead showTypeahead}
13821
+ * or recently entered values). See also {@link module:sap/ui/mdc/ValueHelpDelegate.showTypeahead showTypeahead}
13423
13822
  *
13424
13823
  * Default value is `false`.
13425
13824
  *
13426
13825
  * @since 1.112.0
13826
+ * @deprecated (since 1.121.0) - replaced by {@link module:sap/ui/mdc/ValueHelpDelegate.shouldOpenOnFocus shouldOpenOnFocus}
13427
13827
  *
13428
13828
  * @returns Value of property `opensOnFocus`
13429
13829
  */
@@ -13436,13 +13836,14 @@ declare namespace sap {
13436
13836
  *
13437
13837
  * **Note:** By default, a type-ahead is only shown to provide suggestions when users enter input in a connected
13438
13838
  * control. This property enables scenarios where popovers need to be shown earlier (for example, recommendations
13439
- * or recently entered values). See also {@link sap.ui.mdc.ValueHelpDelegate.showTypeahead showTypeahead}
13839
+ * or recently entered values). See also {@link module:sap/ui/mdc/ValueHelpDelegate.showTypeahead showTypeahead}
13440
13840
  *
13441
13841
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
13442
13842
  *
13443
13843
  * Default value is `false`.
13444
13844
  *
13445
13845
  * @since 1.110.0
13846
+ * @deprecated (since 1.121.0) - replaced by {@link module:sap/ui/mdc/ValueHelpDelegate.shouldOpenOnClick shouldOpenOnClick}
13446
13847
  *
13447
13848
  * @returns Reference to `this` in order to allow method chaining
13448
13849
  */
@@ -13459,13 +13860,14 @@ declare namespace sap {
13459
13860
  *
13460
13861
  * **Note:** By default, a type-ahead is only shown to provide suggestions when users enter input in a connected
13461
13862
  * control. This property enables scenarios where popovers need to be shown earlier (for example, recommendations
13462
- * or recently entered values). See also {@link sap.ui.mdc.ValueHelpDelegate.showTypeahead showTypeahead}
13863
+ * or recently entered values). See also {@link module:sap/ui/mdc/ValueHelpDelegate.showTypeahead showTypeahead}
13463
13864
  *
13464
13865
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
13465
13866
  *
13466
13867
  * Default value is `false`.
13467
13868
  *
13468
13869
  * @since 1.112.0
13870
+ * @deprecated (since 1.121.0) - replaced by {@link module:sap/ui/mdc/ValueHelpDelegate.shouldOpenOnFocus shouldOpenOnFocus}
13469
13871
  *
13470
13872
  * @returns Reference to `this` in order to allow method chaining
13471
13873
  */
@@ -13596,6 +13998,17 @@ declare namespace sap {
13596
13998
  * @returns Value of property `layoutInformation`
13597
13999
  */
13598
14000
  getLayoutInformation(): object;
14001
+ /**
14002
+ * Observes changes in `Action` aggregation.
14003
+ *
14004
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
14005
+ */
14006
+ observeChanges(
14007
+ /**
14008
+ * Changes
14009
+ */
14010
+ oChanges: object
14011
+ ): void;
13599
14012
  /**
13600
14013
  * Sets the aggregated {@link #getAction action}.
13601
14014
  *
@@ -14021,11 +14434,11 @@ declare namespace sap {
14021
14434
  namespace odata {
14022
14435
  namespace v4 {
14023
14436
  /**
14024
- * An object literal describing a data property in the context of a {@link sap.ui.mdc.Table} with {@link module:sap/ui/mdc/odata/v4/TableDelegate}.
14437
+ * An object literal describing a data property in the context of a {@link sap.ui.mdc.Table} with {@link module:sap/ui/mdc/odata/v4/TableDelegate sap/ui/mdc/odata/v4/TableDelegate}.
14025
14438
  *
14026
14439
  * When specifying the `PropertyInfo` objects in the {@link sap.ui.mdc.Table#getPropertyInfo propertyInfo }
14027
14440
  * property, the following attributes need to be specified:
14028
- * - `name`
14441
+ * - `key`
14029
14442
  * - `path`
14030
14443
  * - `dataType`
14031
14444
  * - `formatOptions`
@@ -14035,7 +14448,7 @@ declare namespace sap {
14035
14448
  * - `visualSettings.widthCalculation`
14036
14449
  * - `propertyInfos`
14037
14450
  * - `groupable`
14038
- * - `key`
14451
+ * - `isKey`
14039
14452
  * - `unit`
14040
14453
  * - `text`
14041
14454
  * - `aggregatable`
@@ -14045,7 +14458,7 @@ declare namespace sap {
14045
14458
  * - `extension.customAggregate.contextDefiningProperties`
14046
14459
  *
14047
14460
  * If the property is complex, the following attributes need to be specified:
14048
- * - `name`
14461
+ * - `key`
14049
14462
  * - `visualSettings.widthCalculation`
14050
14463
  * - `propertyInfos` (all referenced properties must be specified)
14051
14464
  */
@@ -14506,7 +14919,7 @@ declare namespace sap {
14506
14919
  | `{${string}}`;
14507
14920
 
14508
14921
  /**
14509
- * Defines the number of fixed columns in the inner table.
14922
+ * Defines the number of fixed columns.
14510
14923
  */
14511
14924
  fixedColumnCount?:
14512
14925
  | int
@@ -14519,9 +14932,10 @@ declare namespace sap {
14519
14932
  /**
14520
14933
  * Defines the column importance.
14521
14934
  *
14522
- * The column importance is taken into consideration for calculating the `minScreenWidth` property and for
14523
- * setting the `demandPopin` property of the column. See {@link sap.m.Table#getAutoPopinMode} for more details,
14524
- * which is automatically set to `true`.
14935
+ * Columns are moved to the pop-in area in the following order:
14936
+ * - With importance `High`: moved last
14937
+ * - With importance `Medium` or `None`: moved second
14938
+ * - With importance `Low`: moved first
14525
14939
  *
14526
14940
  * @since 1.110
14527
14941
  */
@@ -14531,12 +14945,11 @@ declare namespace sap {
14531
14945
  | `{${string}}`;
14532
14946
 
14533
14947
  /**
14534
- * Defines the control serialization function to merge duplicate cells into one cell block. The control
14535
- * itself uses this function to compare values of two duplicate cells.
14948
+ * Defines the control serialization function to merge duplicate cells into one cell block. This function
14949
+ * is used to compare values of two cells.
14536
14950
  *
14537
- * **Note:** Providing this property will automatically set {@link sap.m.Column#getMergeDuplicates} to `true`,
14538
- * and the property itself is mapped to {@link sap.m.Column#getMergeFunctionName} of the inner column. Don't
14539
- * set this property for cells for which the content provides a user interaction, such as `sap.m.Link`.
14951
+ * **Note:** Don't set this property for cells for which the content provides a user interaction, such as
14952
+ * `sap.m.Link`.
14540
14953
  *
14541
14954
  * @since 1.110
14542
14955
  */
@@ -14556,7 +14969,7 @@ declare namespace sap {
14556
14969
  | `{${string}}`;
14557
14970
 
14558
14971
  /**
14559
- * Specifies whether the Show / Hide Details button for the `ResponsiveTable` scenario is shown.
14972
+ * Specifies whether the Show / Hide Details button is shown.
14560
14973
  *
14561
14974
  * If the available screen space gets too narrow, the columns configured with `High` and `Medium` importance
14562
14975
  * move to the pop-in area, while the columns with `Low` importance are hidden.
@@ -14573,13 +14986,12 @@ declare namespace sap {
14573
14986
 
14574
14987
  /**
14575
14988
  * Defines which columns are hidden instead of moved into the pop-in area depending on their importance.
14576
- * See {@link sap.m.Column#getImportance} and {@link sap.m.Table#getHiddenInPopin} for more details.
14989
+ * See {@link sap.ui.mdc.table.ResponsiveColumnSettings#getImportance} for more details.
14577
14990
  *
14578
- * **Note:** To hide columns based on their importance, it's mandatory to set `showDetailsButton="true"`.
14579
- * If no priority is given, the default configuration of {@link sap.ui.mdc.table.ResponsiveTableType#getShowDetailsButton }
14580
- * is used.
14581
- * If this property is changed after the `Table` has been initialized, the new changes take effect only
14582
- * when the Show / Hide Details button is pressed a second time.
14991
+ * **Note:** To hide columns based on their importance, it's mandatory to set `showDetailsButton` to `true`.
14992
+ * If no importance is given, a device-dependent default configuration is used.
14993
+ * If this property is changed after the table has been initialized, the new changes take effect only when
14994
+ * the Show / Hide Details button is pressed a second time.
14583
14995
  *
14584
14996
  * @since 1.86
14585
14997
  */
@@ -14603,26 +15015,25 @@ declare namespace sap {
14603
15015
  /**
14604
15016
  * Type of the row action item.
14605
15017
  *
14606
- * As of version 1.98, only sap.ui.mdc.enums.TableRowAction.Navigation is available. Setting the type ensures
14607
- * default values for the properties `icon` and `text`. If an icon or text is set explicitly this setting
14608
- * is used.
15018
+ * Setting the type ensures default values for the properties `icon` and `text`. If an icon or text is set
15019
+ * explicitly, this setting is used.
14609
15020
  */
14610
15021
  type?:
14611
- | sap.ui.mdc.enums.TableRowAction
15022
+ | sap.ui.mdc.enums.TableRowActionType
14612
15023
  | sap.ui.base.ManagedObject.PropertyBindingInfo
14613
15024
  | `{${string}}`;
14614
15025
 
14615
15026
  /**
14616
15027
  * Text for the row action item.
14617
15028
  *
14618
- * Custom text cannot be set when using `sap.m.Table`.
15029
+ * **Note:** A custom text cannot be set when the table type is {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}.
14619
15030
  */
14620
15031
  text?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
14621
15032
 
14622
15033
  /**
14623
15034
  * Icon for the row action item.
14624
15035
  *
14625
- * A custom icon cannot be set when using `sap.m.Table`
15036
+ * **Note:** A custom icon cannot be set when the table type is {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}.
14626
15037
  */
14627
15038
  icon?:
14628
15039
  | sap.ui.core.URI
@@ -14640,10 +15051,11 @@ declare namespace sap {
14640
15051
  /**
14641
15052
  * Fired when the row action item is pressed.
14642
15053
  *
14643
- * `sap.ui.table.Table`: The press event is fired when a row action item is pressed.
15054
+ * If the table type is {@link sap.ui.mdc.table.GridTableType GridTable}, the `press` event is fired when
15055
+ * a row action item is pressed.
14644
15056
  *
14645
- * `sap.m.Table`: The press event is fired when a row with a row action item is pressed. The `sap.ui.mdc.Table`'s
14646
- * `rowPress` event is fired as well, when pressing a row with a row action item.
15057
+ * If the table type is {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}, the `press` event
15058
+ * and the table's `rowPress` event are fired when a row with a row action item is pressed.
14647
15059
  */
14648
15060
  press?: (oEvent: RowActionItem$PressEvent) => void;
14649
15061
  }
@@ -14656,7 +15068,7 @@ declare namespace sap {
14656
15068
  * highlights are visible. Valid values for the `highlight` property are values of the enumerations {@link sap.ui.core.MessageType }
14657
15069
  * or {@link sap.ui.core.IndicationColor}.
14658
15070
  *
14659
- * Accessibility support is provided through the associated {@link sap.ui.mdc.table.RowSettings#setHighlightText highlightText }
15071
+ * Accessibility support is provided with the {@link sap.ui.mdc.table.RowSettings#setHighlightText highlightText }
14660
15072
  * property. If the `highlight` property is set to a value of {@link sap.ui.core.MessageType}, the `highlightText`
14661
15073
  * property does not need to be set because a default text is used. However, the default text can be overridden
14662
15074
  * by setting the `highlightText` property. In all other cases the `highlightText` property must be set.
@@ -14672,9 +15084,7 @@ declare namespace sap {
14672
15084
  | sap.ui.base.ManagedObject.PropertyBindingInfo;
14673
15085
 
14674
15086
  /**
14675
- * The navigated state of a row.
14676
- *
14677
- * If set to `true`, a navigation indicator is displayed at the end of the row.
15087
+ * The navigated state of a row. The navigation indicator is displayed at the end of a row.
14678
15088
  */
14679
15089
  navigated?:
14680
15090
  | boolean
@@ -14682,10 +15092,11 @@ declare namespace sap {
14682
15092
  | `{${string}}`;
14683
15093
 
14684
15094
  /**
14685
- * The available actions for a row.
15095
+ * The actions that appear at the end of a row.
14686
15096
  *
14687
- * rowActions cannot be bound with a factory. Additionally, {@link sap.m.Table} only works with row actions
14688
- * of type navigation.
15097
+ * **Note:** This aggregation cannot be bound with a factory.
15098
+ * If the table type is {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}, only the `Navigation`
15099
+ * row action type is supported.
14689
15100
  */
14690
15101
  rowActions?:
14691
15102
  | sap.ui.mdc.table.RowActionItem[]
@@ -15231,8 +15642,6 @@ declare namespace sap {
15231
15642
  /**
15232
15643
  * Constructor for a new `ColumnSettings`.
15233
15644
  *
15234
- * Provides a number of general settings that are supported by both {@link sap.m.Column} and {@link sap.ui.table.Column}.
15235
- *
15236
15645
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
15237
15646
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
15238
15647
  * of the syntax of the settings object.
@@ -15249,8 +15658,6 @@ declare namespace sap {
15249
15658
  /**
15250
15659
  * Constructor for a new `ColumnSettings`.
15251
15660
  *
15252
- * Provides a number of general settings that are supported by both {@link sap.m.Column} and {@link sap.ui.table.Column}.
15253
- *
15254
15661
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
15255
15662
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
15256
15663
  * of the syntax of the settings object.
@@ -15969,7 +16376,7 @@ declare namespace sap {
15969
16376
  /**
15970
16377
  * Gets current value of property {@link #getFixedColumnCount fixedColumnCount}.
15971
16378
  *
15972
- * Defines the number of fixed columns in the inner table.
16379
+ * Defines the number of fixed columns.
15973
16380
  *
15974
16381
  * Default value is `0`.
15975
16382
  *
@@ -16036,7 +16443,7 @@ declare namespace sap {
16036
16443
  /**
16037
16444
  * Sets a new value for property {@link #getFixedColumnCount fixedColumnCount}.
16038
16445
  *
16039
- * Defines the number of fixed columns in the inner table.
16446
+ * Defines the number of fixed columns.
16040
16447
  *
16041
16448
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
16042
16449
  *
@@ -16197,9 +16604,10 @@ declare namespace sap {
16197
16604
  *
16198
16605
  * Defines the column importance.
16199
16606
  *
16200
- * The column importance is taken into consideration for calculating the `minScreenWidth` property and for
16201
- * setting the `demandPopin` property of the column. See {@link sap.m.Table#getAutoPopinMode} for more details,
16202
- * which is automatically set to `true`.
16607
+ * Columns are moved to the pop-in area in the following order:
16608
+ * - With importance `High`: moved last
16609
+ * - With importance `Medium` or `None`: moved second
16610
+ * - With importance `Low`: moved first
16203
16611
  *
16204
16612
  * Default value is `"None"`.
16205
16613
  *
@@ -16211,12 +16619,11 @@ declare namespace sap {
16211
16619
  /**
16212
16620
  * Gets current value of property {@link #getMergeFunction mergeFunction}.
16213
16621
  *
16214
- * Defines the control serialization function to merge duplicate cells into one cell block. The control
16215
- * itself uses this function to compare values of two duplicate cells.
16622
+ * Defines the control serialization function to merge duplicate cells into one cell block. This function
16623
+ * is used to compare values of two cells.
16216
16624
  *
16217
- * **Note:** Providing this property will automatically set {@link sap.m.Column#getMergeDuplicates} to `true`,
16218
- * and the property itself is mapped to {@link sap.m.Column#getMergeFunctionName} of the inner column. Don't
16219
- * set this property for cells for which the content provides a user interaction, such as `sap.m.Link`.
16625
+ * **Note:** Don't set this property for cells for which the content provides a user interaction, such as
16626
+ * `sap.m.Link`.
16220
16627
  *
16221
16628
  * @since 1.110
16222
16629
  *
@@ -16228,9 +16635,10 @@ declare namespace sap {
16228
16635
  *
16229
16636
  * Defines the column importance.
16230
16637
  *
16231
- * The column importance is taken into consideration for calculating the `minScreenWidth` property and for
16232
- * setting the `demandPopin` property of the column. See {@link sap.m.Table#getAutoPopinMode} for more details,
16233
- * which is automatically set to `true`.
16638
+ * Columns are moved to the pop-in area in the following order:
16639
+ * - With importance `High`: moved last
16640
+ * - With importance `Medium` or `None`: moved second
16641
+ * - With importance `Low`: moved first
16234
16642
  *
16235
16643
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
16236
16644
  *
@@ -16249,12 +16657,11 @@ declare namespace sap {
16249
16657
  /**
16250
16658
  * Sets a new value for property {@link #getMergeFunction mergeFunction}.
16251
16659
  *
16252
- * Defines the control serialization function to merge duplicate cells into one cell block. The control
16253
- * itself uses this function to compare values of two duplicate cells.
16660
+ * Defines the control serialization function to merge duplicate cells into one cell block. This function
16661
+ * is used to compare values of two cells.
16254
16662
  *
16255
- * **Note:** Providing this property will automatically set {@link sap.m.Column#getMergeDuplicates} to `true`,
16256
- * and the property itself is mapped to {@link sap.m.Column#getMergeFunctionName} of the inner column. Don't
16257
- * set this property for cells for which the content provides a user interaction, such as `sap.m.Link`.
16663
+ * **Note:** Don't set this property for cells for which the content provides a user interaction, such as
16664
+ * `sap.m.Link`.
16258
16665
  *
16259
16666
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
16260
16667
  *
@@ -16341,13 +16748,12 @@ declare namespace sap {
16341
16748
  * Gets current value of property {@link #getDetailsButtonSetting detailsButtonSetting}.
16342
16749
  *
16343
16750
  * Defines which columns are hidden instead of moved into the pop-in area depending on their importance.
16344
- * See {@link sap.m.Column#getImportance} and {@link sap.m.Table#getHiddenInPopin} for more details.
16751
+ * See {@link sap.ui.mdc.table.ResponsiveColumnSettings#getImportance} for more details.
16345
16752
  *
16346
- * **Note:** To hide columns based on their importance, it's mandatory to set `showDetailsButton="true"`.
16347
- * If no priority is given, the default configuration of {@link sap.ui.mdc.table.ResponsiveTableType#getShowDetailsButton }
16348
- * is used.
16349
- * If this property is changed after the `Table` has been initialized, the new changes take effect only
16350
- * when the Show / Hide Details button is pressed a second time.
16753
+ * **Note:** To hide columns based on their importance, it's mandatory to set `showDetailsButton` to `true`.
16754
+ * If no importance is given, a device-dependent default configuration is used.
16755
+ * If this property is changed after the table has been initialized, the new changes take effect only when
16756
+ * the Show / Hide Details button is pressed a second time.
16351
16757
  *
16352
16758
  * @since 1.86
16353
16759
  *
@@ -16380,7 +16786,7 @@ declare namespace sap {
16380
16786
  /**
16381
16787
  * Gets current value of property {@link #getShowDetailsButton showDetailsButton}.
16382
16788
  *
16383
- * Specifies whether the Show / Hide Details button for the `ResponsiveTable` scenario is shown.
16789
+ * Specifies whether the Show / Hide Details button is shown.
16384
16790
  *
16385
16791
  * If the available screen space gets too narrow, the columns configured with `High` and `Medium` importance
16386
16792
  * move to the pop-in area, while the columns with `Low` importance are hidden.
@@ -16399,13 +16805,12 @@ declare namespace sap {
16399
16805
  * Sets a new value for property {@link #getDetailsButtonSetting detailsButtonSetting}.
16400
16806
  *
16401
16807
  * Defines which columns are hidden instead of moved into the pop-in area depending on their importance.
16402
- * See {@link sap.m.Column#getImportance} and {@link sap.m.Table#getHiddenInPopin} for more details.
16808
+ * See {@link sap.ui.mdc.table.ResponsiveColumnSettings#getImportance} for more details.
16403
16809
  *
16404
- * **Note:** To hide columns based on their importance, it's mandatory to set `showDetailsButton="true"`.
16405
- * If no priority is given, the default configuration of {@link sap.ui.mdc.table.ResponsiveTableType#getShowDetailsButton }
16406
- * is used.
16407
- * If this property is changed after the `Table` has been initialized, the new changes take effect only
16408
- * when the Show / Hide Details button is pressed a second time.
16810
+ * **Note:** To hide columns based on their importance, it's mandatory to set `showDetailsButton` to `true`.
16811
+ * If no importance is given, a device-dependent default configuration is used.
16812
+ * If this property is changed after the table has been initialized, the new changes take effect only when
16813
+ * the Show / Hide Details button is pressed a second time.
16409
16814
  *
16410
16815
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
16411
16816
  *
@@ -16459,7 +16864,7 @@ declare namespace sap {
16459
16864
  /**
16460
16865
  * Sets a new value for property {@link #getShowDetailsButton showDetailsButton}.
16461
16866
  *
16462
- * Specifies whether the Show / Hide Details button for the `ResponsiveTable` scenario is shown.
16867
+ * Specifies whether the Show / Hide Details button is shown.
16463
16868
  *
16464
16869
  * If the available screen space gets too narrow, the columns configured with `High` and `Medium` importance
16465
16870
  * move to the pop-in area, while the columns with `Low` importance are hidden.
@@ -16557,10 +16962,11 @@ declare namespace sap {
16557
16962
  *
16558
16963
  * Fired when the row action item is pressed.
16559
16964
  *
16560
- * `sap.ui.table.Table`: The press event is fired when a row action item is pressed.
16965
+ * If the table type is {@link sap.ui.mdc.table.GridTableType GridTable}, the `press` event is fired when
16966
+ * a row action item is pressed.
16561
16967
  *
16562
- * `sap.m.Table`: The press event is fired when a row with a row action item is pressed. The `sap.ui.mdc.Table`'s
16563
- * `rowPress` event is fired as well, when pressing a row with a row action item.
16968
+ * If the table type is {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}, the `press` event
16969
+ * and the table's `rowPress` event are fired when a row with a row action item is pressed.
16564
16970
  *
16565
16971
  *
16566
16972
  * @returns Reference to `this` in order to allow method chaining
@@ -16588,10 +16994,11 @@ declare namespace sap {
16588
16994
  *
16589
16995
  * Fired when the row action item is pressed.
16590
16996
  *
16591
- * `sap.ui.table.Table`: The press event is fired when a row action item is pressed.
16997
+ * If the table type is {@link sap.ui.mdc.table.GridTableType GridTable}, the `press` event is fired when
16998
+ * a row action item is pressed.
16592
16999
  *
16593
- * `sap.m.Table`: The press event is fired when a row with a row action item is pressed. The `sap.ui.mdc.Table`'s
16594
- * `rowPress` event is fired as well, when pressing a row with a row action item.
17000
+ * If the table type is {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}, the `press` event
17001
+ * and the table's `rowPress` event are fired when a row with a row action item is pressed.
16595
17002
  *
16596
17003
  *
16597
17004
  * @returns Reference to `this` in order to allow method chaining
@@ -16642,7 +17049,7 @@ declare namespace sap {
16642
17049
  *
16643
17050
  * Icon for the row action item.
16644
17051
  *
16645
- * A custom icon cannot be set when using `sap.m.Table`
17052
+ * **Note:** A custom icon cannot be set when the table type is {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}.
16646
17053
  *
16647
17054
  *
16648
17055
  * @returns Value of property `icon`
@@ -16653,7 +17060,7 @@ declare namespace sap {
16653
17060
  *
16654
17061
  * Text for the row action item.
16655
17062
  *
16656
- * Custom text cannot be set when using `sap.m.Table`.
17063
+ * **Note:** A custom text cannot be set when the table type is {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}.
16657
17064
  *
16658
17065
  *
16659
17066
  * @returns Value of property `text`
@@ -16664,14 +17071,13 @@ declare namespace sap {
16664
17071
  *
16665
17072
  * Type of the row action item.
16666
17073
  *
16667
- * As of version 1.98, only sap.ui.mdc.enums.TableRowAction.Navigation is available. Setting the type ensures
16668
- * default values for the properties `icon` and `text`. If an icon or text is set explicitly this setting
16669
- * is used.
17074
+ * Setting the type ensures default values for the properties `icon` and `text`. If an icon or text is set
17075
+ * explicitly, this setting is used.
16670
17076
  *
16671
17077
  *
16672
17078
  * @returns Value of property `type`
16673
17079
  */
16674
- getType(): sap.ui.mdc.enums.TableRowAction;
17080
+ getType(): sap.ui.mdc.enums.TableRowActionType;
16675
17081
  /**
16676
17082
  * Gets current value of property {@link #getVisible visible}.
16677
17083
  *
@@ -16688,7 +17094,7 @@ declare namespace sap {
16688
17094
  *
16689
17095
  * Icon for the row action item.
16690
17096
  *
16691
- * A custom icon cannot be set when using `sap.m.Table`
17097
+ * **Note:** A custom icon cannot be set when the table type is {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}.
16692
17098
  *
16693
17099
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
16694
17100
  *
@@ -16706,7 +17112,7 @@ declare namespace sap {
16706
17112
  *
16707
17113
  * Text for the row action item.
16708
17114
  *
16709
- * Custom text cannot be set when using `sap.m.Table`.
17115
+ * **Note:** A custom text cannot be set when the table type is {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}.
16710
17116
  *
16711
17117
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
16712
17118
  *
@@ -16724,9 +17130,8 @@ declare namespace sap {
16724
17130
  *
16725
17131
  * Type of the row action item.
16726
17132
  *
16727
- * As of version 1.98, only sap.ui.mdc.enums.TableRowAction.Navigation is available. Setting the type ensures
16728
- * default values for the properties `icon` and `text`. If an icon or text is set explicitly this setting
16729
- * is used.
17133
+ * Setting the type ensures default values for the properties `icon` and `text`. If an icon or text is set
17134
+ * explicitly, this setting is used.
16730
17135
  *
16731
17136
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
16732
17137
  *
@@ -16737,7 +17142,7 @@ declare namespace sap {
16737
17142
  /**
16738
17143
  * New value for property `type`
16739
17144
  */
16740
- sType: sap.ui.mdc.enums.TableRowAction
17145
+ sType: sap.ui.mdc.enums.TableRowActionType
16741
17146
  ): this;
16742
17147
  /**
16743
17148
  * Sets a new value for property {@link #getVisible visible}.
@@ -16859,7 +17264,7 @@ declare namespace sap {
16859
17264
  * highlights are visible. Valid values for the `highlight` property are values of the enumerations {@link sap.ui.core.MessageType }
16860
17265
  * or {@link sap.ui.core.IndicationColor}.
16861
17266
  *
16862
- * Accessibility support is provided through the associated {@link sap.ui.mdc.table.RowSettings#setHighlightText highlightText }
17267
+ * Accessibility support is provided with the {@link sap.ui.mdc.table.RowSettings#setHighlightText highlightText }
16863
17268
  * property. If the `highlight` property is set to a value of {@link sap.ui.core.MessageType}, the `highlightText`
16864
17269
  * property does not need to be set because a default text is used. However, the default text can be overridden
16865
17270
  * by setting the `highlightText` property. In all other cases the `highlightText` property must be set.
@@ -16885,9 +17290,7 @@ declare namespace sap {
16885
17290
  /**
16886
17291
  * Gets current value of property {@link #getNavigated navigated}.
16887
17292
  *
16888
- * The navigated state of a row.
16889
- *
16890
- * If set to `true`, a navigation indicator is displayed at the end of the row.
17293
+ * The navigated state of a row. The navigation indicator is displayed at the end of a row.
16891
17294
  *
16892
17295
  * Default value is `false`.
16893
17296
  *
@@ -16898,10 +17301,11 @@ declare namespace sap {
16898
17301
  /**
16899
17302
  * Gets content of aggregation {@link #getRowActions rowActions}.
16900
17303
  *
16901
- * The available actions for a row.
17304
+ * The actions that appear at the end of a row.
16902
17305
  *
16903
- * rowActions cannot be bound with a factory. Additionally, {@link sap.m.Table} only works with row actions
16904
- * of type navigation.
17306
+ * **Note:** This aggregation cannot be bound with a factory.
17307
+ * If the table type is {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}, only the `Navigation`
17308
+ * row action type is supported.
16905
17309
  */
16906
17310
  getRowActions(): sap.ui.mdc.table.RowActionItem[];
16907
17311
  /**
@@ -16965,7 +17369,7 @@ declare namespace sap {
16965
17369
  * highlights are visible. Valid values for the `highlight` property are values of the enumerations {@link sap.ui.core.MessageType }
16966
17370
  * or {@link sap.ui.core.IndicationColor}.
16967
17371
  *
16968
- * Accessibility support is provided through the associated {@link sap.ui.mdc.table.RowSettings#setHighlightText highlightText }
17372
+ * Accessibility support is provided with the {@link sap.ui.mdc.table.RowSettings#setHighlightText highlightText }
16969
17373
  * property. If the `highlight` property is set to a value of {@link sap.ui.core.MessageType}, the `highlightText`
16970
17374
  * property does not need to be set because a default text is used. However, the default text can be overridden
16971
17375
  * by setting the `highlightText` property. In all other cases the `highlightText` property must be set.
@@ -17005,9 +17409,7 @@ declare namespace sap {
17005
17409
  /**
17006
17410
  * Sets a new value for property {@link #getNavigated navigated}.
17007
17411
  *
17008
- * The navigated state of a row.
17009
- *
17010
- * If set to `true`, a navigation indicator is displayed at the end of the row.
17412
+ * The navigated state of a row. The navigation indicator is displayed at the end of a row.
17011
17413
  *
17012
17414
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
17013
17415
  *
@@ -17179,7 +17581,7 @@ declare namespace sap {
17179
17581
  *
17180
17582
  * When specifying the `PropertyInfo` objects in the {@link sap.ui.mdc.Table#getPropertyInfo propertyInfo }
17181
17583
  * property, the following attributes need to be specified:
17182
- * - `name`
17584
+ * - `key`
17183
17585
  * - `path`
17184
17586
  * - `dataType`
17185
17587
  * - `formatOptions`
@@ -17189,12 +17591,12 @@ declare namespace sap {
17189
17591
  * - `visualSettings.widthCalculation`
17190
17592
  * - `propertyInfos`
17191
17593
  * - `groupable`
17192
- * - `key`
17594
+ * - `isKey`
17193
17595
  * - `unit`
17194
17596
  * - `text`
17195
17597
  *
17196
17598
  * If the property is complex, the following attributes need to be specified:
17197
- * - `name`
17599
+ * - `key`
17198
17600
  * - `visualSettings.widthCalculation`
17199
17601
  * - `propertyInfos` (all referenced properties must be specified)
17200
17602
  */
@@ -17214,7 +17616,7 @@ declare namespace sap {
17214
17616
  /**
17215
17617
  * Defines whether a property is a key or part of a key in the data.
17216
17618
  */
17217
- key?: boolean;
17619
+ isKey?: boolean;
17218
17620
  /**
17219
17621
  * Name of the unit property that is related to this property.
17220
17622
  */
@@ -17453,7 +17855,21 @@ declare namespace sap {
17453
17855
  | `{${string}}`;
17454
17856
 
17455
17857
  /**
17456
- * Defines the module path of the metadata delegate.
17858
+ * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
17859
+ * The object has the following properties:
17860
+ * - `name` defines the path to the `Delegate` module
17861
+ * - `payload` (optional) defines application-specific information that can be used in the given delegate
17862
+ * Sample delegate object:
17863
+ * ```javascript
17864
+ * {
17865
+ * name: "sap/ui/mdc/BaseDelegate",
17866
+ * payload: {}
17867
+ * }```
17868
+ * **Note:** Ensure that the related file can be requested (any required library has to be loaded before
17869
+ * that).
17870
+ * Do not bind or modify the module. This property can only be configured during control initialization.
17871
+ *
17872
+ * @experimental
17457
17873
  */
17458
17874
  delegate?:
17459
17875
  | object
@@ -17673,8 +18089,10 @@ declare namespace sap {
17673
18089
  noData?: sap.ui.core.Control;
17674
18090
 
17675
18091
  /**
17676
- * Control or object that enables the chart to do filtering, such as {@link sap.ui.mdc.FilterBar}. Also
17677
- * see {@link sap.ui.mdc.IFilter}.
18092
+ * Control or object that enables the chart to do filtering, such as {@link sap.ui.mdc.FilterBar}. See also
18093
+ * {@link sap.ui.mdc.IFilter}.
18094
+ *
18095
+ * Automatic filter generation only works in combination with a `sap.ui.mdc.FilterBar`.
17678
18096
  *
17679
18097
  * @since 1.88
17680
18098
  */
@@ -17690,7 +18108,16 @@ declare namespace sap {
17690
18108
 
17691
18109
  interface $ControlSettings extends sap.ui.core.$ControlSettings {
17692
18110
  /**
17693
- * Path to the `Delegate` module that provides the required APIs to execute model-specific logic.
18111
+ * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
18112
+ * The object has the following properties:
18113
+ * - `name` defines the path to the `Delegate` module
18114
+ * - `payload` (optional) defines application-specific information that can be used in the given delegate
18115
+ * Sample delegate object:
18116
+ * ```javascript
18117
+ * {
18118
+ * name: "sap/ui/mdc/BaseDelegate",
18119
+ * payload: {}
18120
+ * }```
17694
18121
  * **Note:** Ensure that the related file can be requested (any required library has to be loaded before
17695
18122
  * that).
17696
18123
  * Do not bind or modify the module. This property can only be configured during control initialization.
@@ -17705,7 +18132,16 @@ declare namespace sap {
17705
18132
 
17706
18133
  interface $ElementSettings extends sap.ui.core.$ElementSettings {
17707
18134
  /**
17708
- * Path to the `Delegate` module that provides the required APIs to execute model-specific logic.
18135
+ * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
18136
+ * The object has the following properties:
18137
+ * - `name` defines the path to the `Delegate` module
18138
+ * - `payload` (optional) defines application-specific information that can be used in the given delegate
18139
+ * Sample delegate object:
18140
+ * ```javascript
18141
+ * {
18142
+ * name: "sap/ui/mdc/BaseDelegate",
18143
+ * payload: {}
18144
+ * }```
17709
18145
  * **Note:** Ensure that the related file can be requested (any required library has to be loaded before
17710
18146
  * that).
17711
18147
  * Do not bind or modify the module. This property can only be configured during control initialization.
@@ -17788,6 +18224,12 @@ declare namespace sap {
17788
18224
  * If empty, default operators depending on used data type are taken. The standard operators are mentioned
17789
18225
  * in {@link sap.ui.mdc.enums.OperatorName OperatorName}.
17790
18226
  *
18227
+ * **Note:** If a custom control is used as {@link sap.ui.mdc.field.FieldBase#setContent Content}, {@link sap.ui.mdc.field.FieldBase#setContentEdit ContentEdit},
18228
+ * or {@link sap.ui.mdc.field.FieldBase#setContentDisplay ContentDisplay}, and the custom control only supports
18229
+ * one operator (as no operator can be shown), only the required operator must be set. So the user input
18230
+ * into the custom control creates a condition with the set operator, and a condition with this operator
18231
+ * provides the value the custom control needs.
18232
+ *
17791
18233
  * @since 1.73.0
17792
18234
  */
17793
18235
  operators?:
@@ -17846,11 +18288,19 @@ declare namespace sap {
17846
18288
  | `{${string}}`;
17847
18289
 
17848
18290
  /**
17849
- * Path to `LinkDelegate` module that provides the required APIs to create content for the `Link` control.
18291
+ * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
18292
+ * The object has the following properties:
18293
+ * - `name` defines the path to the `Delegate` module
18294
+ * - `payload` (optional) defines application-specific information that can be used in the given delegate
18295
+ * Sample delegate object:
18296
+ * ```javascript
18297
+ * {
18298
+ * name: "sap/ui/mdc/BaseDelegate",
18299
+ * payload: {}
18300
+ * }```
17850
18301
  * **Note:** Ensure that the related file can be requested (any required library has to be loaded before
17851
18302
  * that).
17852
- * Do not bind or modify the module. Once the required module is associated, this property might not be
17853
- * needed any longer.
18303
+ * Do not bind or modify the module. This property can only be configured during control initialization.
17854
18304
  *
17855
18305
  * @experimental
17856
18306
  */
@@ -17869,12 +18319,19 @@ declare namespace sap {
17869
18319
  interface $MultiValueFieldSettings
17870
18320
  extends sap.ui.mdc.field.$FieldBaseSettings {
17871
18321
  /**
17872
- * Path to the `MultiValueFieldDelegate` module that provides the required APIs to execute model-specific
17873
- * logic.
18322
+ * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
18323
+ * The object has the following properties:
18324
+ * - `name` defines the path to the `Delegate` module
18325
+ * - `payload` (optional) defines application-specific information that can be used in the given delegate
18326
+ * Sample delegate object:
18327
+ * ```javascript
18328
+ * {
18329
+ * name: "sap/ui/mdc/BaseDelegate",
18330
+ * payload: {}
18331
+ * }```
17874
18332
  * **Note:** Ensure that the related file can be requested (any required library has to be loaded before
17875
18333
  * that).
17876
- * Do not bind or modify the module. Once the required module is associated, this property might not be
17877
- * needed any longer.
18334
+ * Do not bind or modify the module. This property can only be configured during control initialization.
17878
18335
  *
17879
18336
  * @experimental
17880
18337
  */
@@ -17910,9 +18367,9 @@ declare namespace sap {
17910
18367
  | `{${string}}`;
17911
18368
 
17912
18369
  /**
17913
- * This property has no effect and will be rmoved soon.
18370
+ * This property has no effect and will be removed soon.
17914
18371
  *
17915
- * @deprecated - Do not use.
18372
+ * @deprecated (since 1.115)
17916
18373
  */
17917
18374
  height?:
17918
18375
  | sap.ui.core.CSSSize
@@ -17921,7 +18378,10 @@ declare namespace sap {
17921
18378
 
17922
18379
  /**
17923
18380
  * Personalization options for the table.
17924
- * **Note:** The order of the options does not influence the position on the UI.
18381
+ *
18382
+ * **Note:** Whether a personalization option is supported depends on the used delegate. Please refer to
18383
+ * the documentation of the individual delegates. The order of the provided options does not influence their
18384
+ * order on the UI.
17925
18385
  *
17926
18386
  * @since 1.62
17927
18387
  */
@@ -17931,11 +18391,22 @@ declare namespace sap {
17931
18391
  | `{${string}}`;
17932
18392
 
17933
18393
  /**
17934
- * Path to `TableDelegate` module that provides the required APIs to create table content.
17935
- * **Note:** Ensure that the related file can be requested (any required library has to be loaded before
18394
+ * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
18395
+ * The object has the following properties:
18396
+ * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/TableDelegate TableDelegate}.
18397
+ *
18398
+ * - `payload` (optional) defines application-specific information that can be used in the given delegate
18399
+ * Sample delegate object:
18400
+ * ```javascript
18401
+ * {
18402
+ * name: "sap/ui/mdc/TableDelegate",
18403
+ * payload: {}
18404
+ * }```
18405
+ *
18406
+ *
18407
+ * **Note:** Ensure that the related file can be requested (any required library has to be loaded before
17936
18408
  * that).
17937
- * Do not bind or modify the module. Once the required module is associated, this property might not be
17938
- * needed any longer.
18409
+ * Do not bind or modify the module. This property can only be configured during control initialization.
17939
18410
  *
17940
18411
  * @experimental
17941
18412
  */
@@ -17974,7 +18445,8 @@ declare namespace sap {
17974
18445
  | `{${string}}`;
17975
18446
 
17976
18447
  /**
17977
- * Header text that is shown in the table.
18448
+ * Header text that is shown in the table. The header must always be set to comply with accessibility standards,
18449
+ * even if other settings make the header invisible.
17978
18450
  */
17979
18451
  header?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
17980
18452
 
@@ -18004,9 +18476,9 @@ declare namespace sap {
18004
18476
  * Selection mode of the table. Specifies whether single or multiple rows can be selected and how the selection
18005
18477
  * can be extended. It may also influence the visual appearance.
18006
18478
  *
18007
- * With the {@link sap.ui.mdc.table.GridTableType GridTableType} and server-side models, range selections,
18008
- * including Select All, only work properly if the count is known. Make sure the model/binding is configured
18009
- * to request the count from the service.
18479
+ * **Note:** With the {@link sap.ui.mdc.table.GridTableType GridTable} and server-side models, range selections,
18480
+ * including Select All, only work properly if the count is known. Please refer to the documentation of
18481
+ * the used model for information on requesting the count, for example, {@link sap.ui.model.odata.v4.ODataModel}.
18010
18482
  */
18011
18483
  selectionMode?:
18012
18484
  | sap.ui.mdc.enums.TableSelectionMode
@@ -18014,12 +18486,11 @@ declare namespace sap {
18014
18486
  | `{${string}}`;
18015
18487
 
18016
18488
  /**
18017
- * Determines whether the number of rows is shown along with the header text. If set to `false`, the number
18018
- * of rows is not shown on the user interface.
18019
- * **Note:**
18020
- * For better performance dedicated OData requests should not be sent. The count mode must be configured
18021
- * either in the model or in the binding of the table.
18022
- * This property can only be used if the back-end service supports row count.
18489
+ * Determines whether the number of rows is shown along with the header text.
18490
+ *
18491
+ * **Note:** Whether this feature can be used depends on whether the model used and the data service can
18492
+ * provide a count. Please refer to the documentation of the used model for information on requesting the
18493
+ * count, for example, {@link sap.ui.model.odata.v4.ODataModel}.
18023
18494
  */
18024
18495
  showRowCount?:
18025
18496
  | boolean
@@ -18027,12 +18498,19 @@ declare namespace sap {
18027
18498
  | `{${string}}`;
18028
18499
 
18029
18500
  /**
18030
- * Number of records to be requested from the model. If the `type` property is set to `ResponsiveTable`,
18031
- * then it refers to the {@link sap.m.ListBase#getGrowingThreshold growingThreshold} property of `ResponsiveTable`.
18032
- * If the `type` property is set to `Table`, then it refers to the {@link sap.ui.table.Table#getThreshold threshold }
18033
- * property of `GridTable`.
18034
- * **Note:** This property only takes effect if it is set to a positive integer value. Otherwise the table
18035
- * uses the default value of the corresponding table types.
18501
+ * Number of records to be requested from the model.
18502
+ *
18503
+ * If the table type is {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}, the threshold defines
18504
+ * the number of rows that are displayed initially, and the number of rows that are added when the table
18505
+ * grows ({@link sap.ui.mdc.table.ResponsiveTableType#getGrowingMode growingMode}).
18506
+ *
18507
+ * If the table type is {@link sap.ui.mdc.table.GridTableType GridTable}, the threshold defines how many
18508
+ * additional (not yet visible) data records from the back-end system are pre-fetched. If the `threshold`
18509
+ * is lower than the number of visible rows, the number of visible rows is used as the `threshold`. If the
18510
+ * value is 0, thresholding is disabled.
18511
+ *
18512
+ * **Note:** This property only takes effect if it is set to a positive integer value. Otherwise the table
18513
+ * uses a type-dependent default value.
18036
18514
  *
18037
18515
  * @since 1.63
18038
18516
  */
@@ -18044,8 +18522,8 @@ declare namespace sap {
18044
18522
  /**
18045
18523
  * Defines the sort conditions.
18046
18524
  *
18047
- * **Note**: This property must not be bound.
18048
- * **Note:** This property is used exclusively for handling SAPUI5 flexibility changes. Do not use it otherwise.
18525
+ * **Note:** This property must not be bound.
18526
+ * This property is used exclusively for handling SAPUI5 flexibility changes. Do not use it otherwise.
18049
18527
  *
18050
18528
  * @since 1.73
18051
18529
  */
@@ -18057,8 +18535,8 @@ declare namespace sap {
18057
18535
  /**
18058
18536
  * Defines the filter conditions.
18059
18537
  *
18060
- * **Note**: This property must not be bound.
18061
- * **Note:** This property is used exclusively for handling SAPUI5 flexibility changes. Do not use it otherwise.
18538
+ * **Note:** This property must not be bound.
18539
+ * This property is used exclusively for handling SAPUI5 flexibility changes. Do not use it otherwise.
18062
18540
  *
18063
18541
  * @since 1.80.0
18064
18542
  */
@@ -18070,8 +18548,8 @@ declare namespace sap {
18070
18548
  /**
18071
18549
  * Defines the group conditions.
18072
18550
  *
18073
- * **Note**: This property must not be bound.
18074
- * **Note:** This property is used exclusively for handling SAPUI5 flexibility changes. Do not use it otherwise.
18551
+ * **Note:** This property must not be bound.
18552
+ * This property is used exclusively for handling SAPUI5 flexibility changes. Do not use it otherwise.
18075
18553
  *
18076
18554
  * @since 1.87
18077
18555
  */
@@ -18083,8 +18561,8 @@ declare namespace sap {
18083
18561
  /**
18084
18562
  * Defines the aggregate conditions.
18085
18563
  *
18086
- * **Note**: This property must not be bound.
18087
- * **Note:** This property is exclusively used for handling SAPUI5 flexibility changes. Do not use it otherwise.
18564
+ * **Note:** This property must not be bound.
18565
+ * This property is exclusively used for handling SAPUI5 flexibility changes. Do not use it otherwise.
18088
18566
  *
18089
18567
  * @since 1.87
18090
18568
  */
@@ -18094,8 +18572,12 @@ declare namespace sap {
18094
18572
  | `{${string}}`;
18095
18573
 
18096
18574
  /**
18097
- * Determines whether the table data export is enabled. To use the export functionality, the {@link sap.ui.export }
18098
- * library is required.
18575
+ * Determines whether the data export is enabled.
18576
+ *
18577
+ * The delegate can customize the export result with the `exportSettings` field in the {@link sap.ui.mdc.table.PropertyInfo PropertyInfo}.
18578
+ *
18579
+ * **Note:** To use the export functionality, the {@link sap.ui.export} library is required, otherwise an
18580
+ * error message is displayed when the user presses the Export button.
18099
18581
  *
18100
18582
  * @since 1.75
18101
18583
  */
@@ -18143,14 +18625,12 @@ declare namespace sap {
18143
18625
  | `{${string}}`;
18144
18626
 
18145
18627
  /**
18146
- * Defines the multi-selection mode for the control. If this property is set to the `Default` value, the
18147
- * `ResponsiveTable` type control renders the Select All checkbox in the column header, otherwise the Deselect
18148
- * All icon is rendered.
18628
+ * Defines the multi-selection mode.
18149
18629
  *
18150
- * This property is used with the `selectionMode="Multi"`.
18151
- *
18152
- * **Note:** This property has currently no effect for table types other than `ResponsiveTable` type. This
18153
- * is subject to change in future.
18630
+ * **Note:** This property has no effect in the following cases:
18631
+ * - Table type is not {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}. This is subject to
18632
+ * change in the future.
18633
+ * - Selection mode is not `Multi`.
18154
18634
  *
18155
18635
  * @since 1.93
18156
18636
  */
@@ -18160,16 +18640,18 @@ declare namespace sap {
18160
18640
  | `{${string}}`;
18161
18641
 
18162
18642
  /**
18163
- * Enables automatic column width calculation based on metadata information if set to `true`. The column
18164
- * width calculation takes the type, column label, referenced properties, and many other metadata parameters
18165
- * into account. Providing a more precise `maxLength` value for the `String` type or `precision` value for
18166
- * numeric types can help this algorithm to produce better results. The calculated column widths can have
18167
- * a minimum of 3rem and a maximum of 20rem.
18643
+ * Enables automatic column width calculation. The column width calculation takes the type, column label,
18644
+ * referenced properties, and other information into account. The calculated column widths can have a minimum
18645
+ * of 3rem and a maximum of 20rem.
18646
+ *
18647
+ * The delegate can customize the automatic column width calculation with the `visualSettings.widthSettings`
18648
+ * field in the {@link sap.ui.mdc.table.PropertyInfo PropertyInfo}. To disable the heuristic column width
18649
+ * calculation for a particular column, the `visualSettings.widthSettings` field can be set to `null`. Providing
18650
+ * a more precise `maxLength` value for the `String` type or `precision` value for numeric types can help
18651
+ * the algorithm to produce better results.
18168
18652
  *
18169
- * **Note:** To customize the automatic column width calculation, the `visualSettings.widthSettings` key
18170
- * of the `PropertyInfo` can be used. To avoid the heuristic column width calculation for a particular column,
18171
- * the `visualSettings.widthSettings` key of the `PropertyInfo` must be set to `null`. This feature has
18172
- * no effect if the `width` property of the column is bound or its value is set.
18653
+ * **Note:** The column width is not calculated if the `width` property of the column is bound or its value
18654
+ * is set.
18173
18655
  *
18174
18656
  * @since 1.95
18175
18657
  */
@@ -18205,6 +18687,34 @@ declare namespace sap {
18205
18687
  | sap.ui.base.ManagedObject.PropertyBindingInfo
18206
18688
  | `{${string}}`;
18207
18689
 
18690
+ /**
18691
+ * Determines whether the toolbar is visible.
18692
+ *
18693
+ * **Note:** Hiding the toolbar limits the functionality of the table in the following ways:
18694
+ *
18695
+ * - The `showRowCount` property **must** be set to `false`.
18696
+ * - The export **must** be disabled by setting the `enableExport` property to `false`.
18697
+ * - For {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}, show and hide details won't be
18698
+ * visible as the table will always run in "Show Details" mode.
18699
+ * - Copy and paste will only work via keyboard.
18700
+ * - For {@link sap.ui.mdc.table.TreeTableType TreeTable}, "Collapse All" and "Expand All" won't be possible.
18701
+ *
18702
+ * - The `actions` and the `quickFilter` aggregations and a table-related {@link sap.ui.fl.variants.VariantManagement }
18703
+ * **must not** be used.
18704
+ * - The table title will not be displayed but will be replaced by an `InvisibleText`. The `header` property
18705
+ * **must** be set. In addition, `headerVisible` **must** be set to `false` to ensure accessibility compatibility.
18706
+ *
18707
+ * - Personalization (`p13nMode`) can still be used via the column headers. If the option to show or hide
18708
+ * columns is activated, it is recommended to use an {@link sap.m.IllustratedMessage} for the `nodata` display.
18709
+ * It ensures that columns can be made visible again when the user has accidentally hidden them all.
18710
+ *
18711
+ * @since 1.121
18712
+ */
18713
+ hideToolbar?:
18714
+ | boolean
18715
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
18716
+ | `{${string}}`;
18717
+
18208
18718
  /**
18209
18719
  * Type of the table.
18210
18720
  */
@@ -18215,9 +18725,11 @@ declare namespace sap {
18215
18725
  | `{${string}}`;
18216
18726
 
18217
18727
  /**
18218
- * Columns of the table. **Note:** This aggregation is managed by the control, can only be populated during
18219
- * the definition in the XML view, and is not bindable. Any changes of the initial aggregation content might
18220
- * result in undesired effects. Changes of the aggregation have to be made with the {@link sap.ui.mdc.p13n.StateUtil StateUtil}.
18728
+ * Columns of the table.
18729
+ *
18730
+ * **Note:** This aggregation is managed by the control, can only be populated during the definition in
18731
+ * the XML view, and is not bindable. Any changes of the initial aggregation content might result in unwanted
18732
+ * effects. Changes of the aggregation have to be made with the {@link sap.ui.mdc.p13n.StateUtil StateUtil}.
18221
18733
  */
18222
18734
  columns?:
18223
18735
  | sap.ui.mdc.table.Column[]
@@ -18227,18 +18739,20 @@ declare namespace sap {
18227
18739
 
18228
18740
  /**
18229
18741
  * This row can be used for user input to create new data if {@link sap.ui.mdc.enums.TableType TableType }
18230
- * is "`Table`". **Note:** Once the binding supports creating transient records, this aggregation will be
18231
- * removed.
18742
+ * is "`Table`".
18743
+ *
18744
+ * **Note:** Once the binding supports creating transient records, this aggregation will be removed.
18232
18745
  *
18233
18746
  * @experimental - Do not use
18234
18747
  */
18235
18748
  creationRow?: /* was: sap.ui.mdc.table.CreationRow */ any;
18236
18749
 
18237
18750
  /**
18238
- * Additional/external actions available for the table. **Note:** This aggregation is managed by the control,
18239
- * can only be populated during the definition in the XML view, and is not bindable. Any changes of the
18240
- * initial aggregation content might result in undesired effects. Changes of the aggregation have to be
18241
- * made with the {@link sap.ui.mdc.p13n.StateUtil StateUtil}.
18751
+ * Additional actions that will be available in the toolbar.
18752
+ *
18753
+ * **Note:** This aggregation is managed by the control, can only be populated during the definition in
18754
+ * the XML view, and is not bindable. Any changes of the initial aggregation content might result in undesired
18755
+ * effects. Changes of the aggregation have to be made with the {@link sap.ui.mdc.p13n.StateUtil StateUtil}.
18242
18756
  */
18243
18757
  actions?:
18244
18758
  | sap.ui.core.Control[]
@@ -18252,7 +18766,7 @@ declare namespace sap {
18252
18766
  variant?: sap.ui.fl.variants.VariantManagement;
18253
18767
 
18254
18768
  /**
18255
- * Additional `Filter` for the table.
18769
+ * Additional control for filtering that will be available in the toolbar.
18256
18770
  */
18257
18771
  quickFilter?: sap.ui.core.Control;
18258
18772
 
@@ -18275,7 +18789,7 @@ declare namespace sap {
18275
18789
  dataStateIndicator?: sap.m.plugins.DataStateIndicator;
18276
18790
 
18277
18791
  /**
18278
- * Defines the custom visualization if there is no data to show in the table.
18792
+ * Defines the custom visualization if there is no data to show.
18279
18793
  *
18280
18794
  * **Note:** If {@link sap.m.IllustratedMessage} control is set for the `noData` aggregation and its {@link sap.m.IllustratedMessage#getTitle title }
18281
18795
  * property is not set then the table automatically offers a no data text with fitting {@link sap.m.IllustratedMessage.IllustratedMessageType illustration}.
@@ -18289,33 +18803,32 @@ declare namespace sap {
18289
18803
 
18290
18804
  /**
18291
18805
  * Defines an aggregation for the `CopyProvider` plugin that provides copy to clipboard capabilities for
18292
- * the selected rows of the table and creates a Copy button for the toolbar of the table. To disable the
18293
- * copy function of the table, including the Copy button in the toolbar, the `enabled` property of the `CopyProvider`
18294
- * must be set to `false`. To hide the Copy button from the toolbar, the `visible` property of the `CopyProvider`
18295
- * must be set to `false`.
18806
+ * the selected rows and creates a Copy button for the toolbar. To disable the copy function, including
18807
+ * the Copy button in the toolbar, the `enabled` property of the `CopyProvider` must be set to `false`.
18808
+ * To hide the Copy button from the toolbar, the `visible` property of the `CopyProvider` must be set to
18809
+ * `false`.
18296
18810
  *
18297
18811
  * **Note:** The {@link sap.m.plugins.CopyProvider#extractData extractData} property of the `CopyProvider`
18298
- * must not be managed by the application. **Note:** The `CopyProvider` requires a secure context to access
18299
- * the clipboard API. If the context is not secure, the plugin will not be added, and the copy button will
18300
- * not be generated.
18812
+ * must not be managed by the application.
18813
+ * The `CopyProvider` requires a secure context to access the clipboard API. If the context is not secure,
18814
+ * the plugin will not be added, and the Copy button will not be generated.
18301
18815
  *
18302
18816
  * @since 1.114
18303
18817
  */
18304
18818
  copyProvider?: sap.m.plugins.CopyProvider;
18305
18819
 
18306
18820
  /**
18307
- * Defines the context menu for the table rows.
18821
+ * Defines the context menu for the rows.
18308
18822
  *
18309
18823
  * @since 1.118
18310
18824
  */
18311
18825
  contextMenu?: sap.ui.core.IContextMenu;
18312
18826
 
18313
18827
  /**
18314
- * Defines an aggregation for the `CellSelector` plugin that provides cell selection capabilities to the
18315
- * table.
18828
+ * Defines an aggregation for the `CellSelector` plugin that provides cell selection capabilities.
18316
18829
  *
18317
- * **Note:** The `CellSelector` is currently only available in combination with the `GridTableType`. Please
18318
- * refer to {@link sap.m.plugins.CellSelector} see the addiditional restrictions.
18830
+ * **Note:** The `CellSelector` is currently only available in combination with the {@link sap.ui.mdc.table.GridTableType GridTable}.
18831
+ * Please refer to {@link sap.m.plugins.CellSelector} for additional restrictions.
18319
18832
  *
18320
18833
  * @since 1.119
18321
18834
  */
@@ -18325,17 +18838,18 @@ declare namespace sap {
18325
18838
  * Control or object that enables the table to do filtering, such as {@link sap.ui.mdc.FilterBar}. See also
18326
18839
  * {@link sap.ui.mdc.IFilter}.
18327
18840
  *
18328
- * Automatic filter generation only works in combination with a `sap.ui.mdc.FilterBar`.
18841
+ * **Note:** By default, automatic filter generation only works in combination with a `sap.ui.mdc.FilterBar`,
18842
+ * see also {@link module:sap/ui/mdc/TableDelegate.getFilters}.
18329
18843
  */
18330
18844
  filter?: sap.ui.mdc.IFilter | string;
18331
18845
 
18332
18846
  /**
18333
- * This event is fired when a row in the table is pressed.
18847
+ * This event is fired when a row is pressed.
18334
18848
  */
18335
18849
  rowPress?: (oEvent: Table$RowPressEvent) => void;
18336
18850
 
18337
18851
  /**
18338
- * This event is fired when the selection in the table is changed.
18852
+ * This event is fired when the selection is changed.
18339
18853
  */
18340
18854
  selectionChange?: (oEvent: Table$SelectionChangeEvent) => void;
18341
18855
 
@@ -18378,7 +18892,17 @@ declare namespace sap {
18378
18892
  | `{${string}}`;
18379
18893
 
18380
18894
  /**
18381
- * Path to the `Delegate` module that provides the required APIs to execute model-specific logic.
18895
+ * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
18896
+ * The object has the following properties:
18897
+ * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/ValueHelpDelegate ValueHelpDelegate }
18898
+ *
18899
+ * - `payload` (optional) defines application-specific information that can be used in the given delegate
18900
+ * Sample delegate object:
18901
+ * ```javascript
18902
+ * {
18903
+ * name: "sap/ui/mdc/ValueHelpDelegate",
18904
+ * payload: {}
18905
+ * }```
18382
18906
  * **Note:** Ensure that the related file can be requested (any required library has to be loaded before
18383
18907
  * that).
18384
18908
  * Do not bind or modify the module. This property can only be configured during control initialization.
@@ -18600,8 +19124,10 @@ declare namespace sap {
18600
19124
  bindingContext?: sap.ui.model.Context;
18601
19125
 
18602
19126
  /**
18603
- * The column used for the context menu **Note:** The column parameter can be empty when opened in a popin
18604
- * area for responsiveTable type.
19127
+ * The column used for the context menu
19128
+ *
19129
+ * **Note:** This parameter can be undefined if the area where the context menu opens is not related to
19130
+ * a column instance.
18605
19131
  */
18606
19132
  column?: sap.ui.mdc.table.Column;
18607
19133
  }
@@ -18709,6 +19235,11 @@ declare namespace sap {
18709
19235
  * ID of the suggested item (This is needed to set the corresponding ARIA attribute)
18710
19236
  */
18711
19237
  itemId?: string;
19238
+
19239
+ /**
19240
+ * If `true` the filtering was executed case sensitive
19241
+ */
19242
+ caseSensitive?: boolean;
18712
19243
  }
18713
19244
 
18714
19245
  /**
@@ -19329,13 +19860,6 @@ declare namespace sap {
19329
19860
  * @returns Value of property `chartType`
19330
19861
  */
19331
19862
  getChartType(): string;
19332
- /**
19333
- * Retrieves the chart type layout configuration. **Note:** This is only used inside personalization.
19334
- *
19335
- *
19336
- * @returns Layout configuration
19337
- */
19338
- getChartTypeLayoutConfig(): object;
19339
19863
  /**
19340
19864
  * Getter for `Conditions` set in the personalization settings.
19341
19865
  *
@@ -19346,10 +19870,23 @@ declare namespace sap {
19346
19870
  /**
19347
19871
  * Gets current value of property {@link #getDelegate delegate}.
19348
19872
  *
19349
- * Defines the module path of the metadata delegate.
19873
+ * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
19874
+ * The object has the following properties:
19875
+ * - `name` defines the path to the `Delegate` module
19876
+ * - `payload` (optional) defines application-specific information that can be used in the given delegate
19877
+ * Sample delegate object:
19878
+ * ```javascript
19879
+ * {
19880
+ * name: "sap/ui/mdc/BaseDelegate",
19881
+ * payload: {}
19882
+ * }```
19883
+ * **Note:** Ensure that the related file can be requested (any required library has to be loaded before
19884
+ * that).
19885
+ * Do not bind or modify the module. This property can only be configured during control initialization.
19350
19886
  *
19351
19887
  * Default value is `...see text or source`.
19352
19888
  *
19889
+ * @experimental
19353
19890
  *
19354
19891
  * @returns Value of property `delegate`
19355
19892
  */
@@ -19359,7 +19896,7 @@ declare namespace sap {
19359
19896
  *
19360
19897
  * @since 1.88
19361
19898
  */
19362
- getFilter(): sap.ui.core.ID;
19899
+ getFilter(): sap.ui.core.ID | null;
19363
19900
  /**
19364
19901
  * Gets current value of property {@link #getHeader header}.
19365
19902
  *
@@ -19515,13 +20052,6 @@ declare namespace sap {
19515
20052
  * For more information, see {@link sap.ui.mdc.chart.SelectionDetailsActions SelectionDetailsActions}.
19516
20053
  */
19517
20054
  getSelectionDetailsActions(): sap.ui.mdc.chart.SelectionDetailsActions;
19518
- /**
19519
- * Retrieves the selection handler of the inner chart.
19520
- *
19521
- *
19522
- * @returns Selection handler of the inner chart
19523
- */
19524
- getSelectionHandler(): object;
19525
20055
  /**
19526
20056
  * Gets current value of property {@link #getShowChartTooltip showChartTooltip}.
19527
20057
  *
@@ -19611,12 +20141,25 @@ declare namespace sap {
19611
20141
  /**
19612
20142
  * Sets a new value for property {@link #getDelegate delegate}.
19613
20143
  *
19614
- * Defines the module path of the metadata delegate.
20144
+ * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
20145
+ * The object has the following properties:
20146
+ * - `name` defines the path to the `Delegate` module
20147
+ * - `payload` (optional) defines application-specific information that can be used in the given delegate
20148
+ * Sample delegate object:
20149
+ * ```javascript
20150
+ * {
20151
+ * name: "sap/ui/mdc/BaseDelegate",
20152
+ * payload: {}
20153
+ * }```
20154
+ * **Note:** Ensure that the related file can be requested (any required library has to be loaded before
20155
+ * that).
20156
+ * Do not bind or modify the module. This property can only be configured during control initialization.
19615
20157
  *
19616
20158
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
19617
20159
  *
19618
20160
  * Default value is `...see text or source`.
19619
20161
  *
20162
+ * @experimental
19620
20163
  *
19621
20164
  * @returns Reference to `this` in order to allow method chaining
19622
20165
  */
@@ -20746,8 +21289,8 @@ declare namespace sap {
20746
21289
  * and the width of the filters. The Go button fires the search event, and the Adapt Filters button shows
20747
21290
  * the filter dialog.
20748
21291
  * The `FilterBar` control creates and handles the filters based on the provided metadata information.
20749
- * The metadata information is provided via the {@link sap.ui.mdc.FilterBarDelegate FilterBarDelegate} implementation.
20750
- * This implementation has to be provided by the application.
21292
+ * The metadata information is provided via the {@link module:sap/ui/mdc/FilterBarDelegate FilterBarDelegate }
21293
+ * implementation. This implementation has to be provided by the application.
20751
21294
  *
20752
21295
  * @since 1.61.0
20753
21296
  * @experimental (since 1.61.0)
@@ -21168,6 +21711,12 @@ declare namespace sap {
21168
21711
  * If empty, default operators depending on used data type are taken. The standard operators are mentioned
21169
21712
  * in {@link sap.ui.mdc.enums.OperatorName OperatorName}.
21170
21713
  *
21714
+ * **Note:** If a custom control is used as {@link sap.ui.mdc.field.FieldBase#setContent Content}, {@link sap.ui.mdc.field.FieldBase#setContentEdit ContentEdit},
21715
+ * or {@link sap.ui.mdc.field.FieldBase#setContentDisplay ContentDisplay}, and the custom control only supports
21716
+ * one operator (as no operator can be shown), only the required operator must be set. So the user input
21717
+ * into the custom control creates a condition with the set operator, and a condition with this operator
21718
+ * provides the value the custom control needs.
21719
+ *
21171
21720
  * Default value is `[]`.
21172
21721
  *
21173
21722
  * @since 1.73.0
@@ -21261,6 +21810,12 @@ declare namespace sap {
21261
21810
  * If empty, default operators depending on used data type are taken. The standard operators are mentioned
21262
21811
  * in {@link sap.ui.mdc.enums.OperatorName OperatorName}.
21263
21812
  *
21813
+ * **Note:** If a custom control is used as {@link sap.ui.mdc.field.FieldBase#setContent Content}, {@link sap.ui.mdc.field.FieldBase#setContentEdit ContentEdit},
21814
+ * or {@link sap.ui.mdc.field.FieldBase#setContentDisplay ContentDisplay}, and the custom control only supports
21815
+ * one operator (as no operator can be shown), only the required operator must be set. So the user input
21816
+ * into the custom control creates a condition with the set operator, and a condition with this operator
21817
+ * provides the value the custom control needs.
21818
+ *
21264
21819
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
21265
21820
  *
21266
21821
  * Default value is `[]`.
@@ -21397,11 +21952,19 @@ declare namespace sap {
21397
21952
  /**
21398
21953
  * Gets current value of property {@link #getDelegate delegate}.
21399
21954
  *
21400
- * Path to `LinkDelegate` module that provides the required APIs to create content for the `Link` control.
21955
+ * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
21956
+ * The object has the following properties:
21957
+ * - `name` defines the path to the `Delegate` module
21958
+ * - `payload` (optional) defines application-specific information that can be used in the given delegate
21959
+ * Sample delegate object:
21960
+ * ```javascript
21961
+ * {
21962
+ * name: "sap/ui/mdc/BaseDelegate",
21963
+ * payload: {}
21964
+ * }```
21401
21965
  * **Note:** Ensure that the related file can be requested (any required library has to be loaded before
21402
21966
  * that).
21403
- * Do not bind or modify the module. Once the required module is associated, this property might not be
21404
- * needed any longer.
21967
+ * Do not bind or modify the module. This property can only be configured during control initialization.
21405
21968
  *
21406
21969
  * Default value is `...see text or source`.
21407
21970
  *
@@ -21425,7 +21988,7 @@ declare namespace sap {
21425
21988
  * ID of the element which is the current target of the association {@link #getSourceControl sourceControl},
21426
21989
  * or `null`.
21427
21990
  */
21428
- getSourceControl(): sap.ui.core.ID;
21991
+ getSourceControl(): sap.ui.core.ID | null;
21429
21992
  /**
21430
21993
  * Retrieves the `AdditionalContent` objects depending on the given `LinkDelegate`. Caches the returned
21431
21994
  * objects for further usage.
@@ -21451,11 +22014,19 @@ declare namespace sap {
21451
22014
  /**
21452
22015
  * Sets a new value for property {@link #getDelegate delegate}.
21453
22016
  *
21454
- * Path to `LinkDelegate` module that provides the required APIs to create content for the `Link` control.
22017
+ * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
22018
+ * The object has the following properties:
22019
+ * - `name` defines the path to the `Delegate` module
22020
+ * - `payload` (optional) defines application-specific information that can be used in the given delegate
22021
+ * Sample delegate object:
22022
+ * ```javascript
22023
+ * {
22024
+ * name: "sap/ui/mdc/BaseDelegate",
22025
+ * payload: {}
22026
+ * }```
21455
22027
  * **Note:** Ensure that the related file can be requested (any required library has to be loaded before
21456
22028
  * that).
21457
- * Do not bind or modify the module. Once the required module is associated, this property might not be
21458
- * needed any longer.
22029
+ * Do not bind or modify the module. This property can only be configured during control initialization.
21459
22030
  *
21460
22031
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
21461
22032
  *
@@ -21776,12 +22347,19 @@ declare namespace sap {
21776
22347
  /**
21777
22348
  * Gets current value of property {@link #getDelegate delegate}.
21778
22349
  *
21779
- * Path to the `MultiValueFieldDelegate` module that provides the required APIs to execute model-specific
21780
- * logic.
22350
+ * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
22351
+ * The object has the following properties:
22352
+ * - `name` defines the path to the `Delegate` module
22353
+ * - `payload` (optional) defines application-specific information that can be used in the given delegate
22354
+ * Sample delegate object:
22355
+ * ```javascript
22356
+ * {
22357
+ * name: "sap/ui/mdc/BaseDelegate",
22358
+ * payload: {}
22359
+ * }```
21781
22360
  * **Note:** Ensure that the related file can be requested (any required library has to be loaded before
21782
22361
  * that).
21783
- * Do not bind or modify the module. Once the required module is associated, this property might not be
21784
- * needed any longer.
22362
+ * Do not bind or modify the module. This property can only be configured during control initialization.
21785
22363
  *
21786
22364
  * Default value is `...see text or source`.
21787
22365
  *
@@ -21927,12 +22505,19 @@ declare namespace sap {
21927
22505
  /**
21928
22506
  * Sets a new value for property {@link #getDelegate delegate}.
21929
22507
  *
21930
- * Path to the `MultiValueFieldDelegate` module that provides the required APIs to execute model-specific
21931
- * logic.
22508
+ * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
22509
+ * The object has the following properties:
22510
+ * - `name` defines the path to the `Delegate` module
22511
+ * - `payload` (optional) defines application-specific information that can be used in the given delegate
22512
+ * Sample delegate object:
22513
+ * ```javascript
22514
+ * {
22515
+ * name: "sap/ui/mdc/BaseDelegate",
22516
+ * payload: {}
22517
+ * }```
21932
22518
  * **Note:** Ensure that the related file can be requested (any required library has to be loaded before
21933
22519
  * that).
21934
- * Do not bind or modify the module. Once the required module is associated, this property might not be
21935
- * needed any longer.
22520
+ * Do not bind or modify the module. This property can only be configured during control initialization.
21936
22521
  *
21937
22522
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
21938
22523
  *
@@ -21997,6 +22582,10 @@ declare namespace sap {
21997
22582
  * controls. The metadata needs to be provided via the {@link module:sap/ui/mdc/TableDelegate TableDelegate }
21998
22583
  * implementation as {@link sap.ui.mdc.table.PropertyInfo}.
21999
22584
  *
22585
+ * **Note:** Read and write access to internal elements is not permitted. Such elements are, for example,
22586
+ * the inner table including its children. This is independent of how access was gained. Internal elements
22587
+ * and their types are subject to change without notice.
22588
+ *
22000
22589
  * @since 1.58
22001
22590
  * @experimental (since 1.58.0)
22002
22591
  */
@@ -22006,7 +22595,7 @@ declare namespace sap {
22006
22595
  __implements__sap_ui_mdc_IFilterSource: boolean;
22007
22596
  __implements__sap_ui_mdc_IxState: boolean;
22008
22597
  /**
22009
- * Constructor for a new `MDCTable`.
22598
+ * Constructor for a new `Table`.
22010
22599
  *
22011
22600
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
22012
22601
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
@@ -22019,7 +22608,7 @@ declare namespace sap {
22019
22608
  mSettings?: sap.ui.mdc.$TableSettings
22020
22609
  );
22021
22610
  /**
22022
- * Constructor for a new `MDCTable`.
22611
+ * Constructor for a new `Table`.
22023
22612
  *
22024
22613
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
22025
22614
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
@@ -22225,7 +22814,7 @@ declare namespace sap {
22225
22814
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
22226
22815
  * otherwise it will be bound to this `sap.ui.mdc.Table` itself.
22227
22816
  *
22228
- * This event is fired when a row in the table is pressed.
22817
+ * This event is fired when a row is pressed.
22229
22818
  *
22230
22819
  *
22231
22820
  * @returns Reference to `this` in order to allow method chaining
@@ -22251,7 +22840,7 @@ declare namespace sap {
22251
22840
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
22252
22841
  * otherwise it will be bound to this `sap.ui.mdc.Table` itself.
22253
22842
  *
22254
- * This event is fired when a row in the table is pressed.
22843
+ * This event is fired when a row is pressed.
22255
22844
  *
22256
22845
  *
22257
22846
  * @returns Reference to `this` in order to allow method chaining
@@ -22273,7 +22862,7 @@ declare namespace sap {
22273
22862
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
22274
22863
  * otherwise it will be bound to this `sap.ui.mdc.Table` itself.
22275
22864
  *
22276
- * This event is fired when the selection in the table is changed.
22865
+ * This event is fired when the selection is changed.
22277
22866
  *
22278
22867
  *
22279
22868
  * @returns Reference to `this` in order to allow method chaining
@@ -22300,7 +22889,7 @@ declare namespace sap {
22300
22889
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
22301
22890
  * otherwise it will be bound to this `sap.ui.mdc.Table` itself.
22302
22891
  *
22303
- * This event is fired when the selection in the table is changed.
22892
+ * This event is fired when the selection is changed.
22304
22893
  *
22305
22894
  *
22306
22895
  * @returns Reference to `this` in order to allow method chaining
@@ -22583,10 +23172,11 @@ declare namespace sap {
22583
23172
  /**
22584
23173
  * Gets content of aggregation {@link #getActions actions}.
22585
23174
  *
22586
- * Additional/external actions available for the table. **Note:** This aggregation is managed by the control,
22587
- * can only be populated during the definition in the XML view, and is not bindable. Any changes of the
22588
- * initial aggregation content might result in undesired effects. Changes of the aggregation have to be
22589
- * made with the {@link sap.ui.mdc.p13n.StateUtil StateUtil}.
23175
+ * Additional actions that will be available in the toolbar.
23176
+ *
23177
+ * **Note:** This aggregation is managed by the control, can only be populated during the definition in
23178
+ * the XML view, and is not bindable. Any changes of the initial aggregation content might result in undesired
23179
+ * effects. Changes of the aggregation have to be made with the {@link sap.ui.mdc.p13n.StateUtil StateUtil}.
22590
23180
  */
22591
23181
  getActions(): sap.ui.core.Control[];
22592
23182
  /**
@@ -22614,11 +23204,10 @@ declare namespace sap {
22614
23204
  /**
22615
23205
  * Gets content of aggregation {@link #getCellSelector cellSelector}.
22616
23206
  *
22617
- * Defines an aggregation for the `CellSelector` plugin that provides cell selection capabilities to the
22618
- * table.
23207
+ * Defines an aggregation for the `CellSelector` plugin that provides cell selection capabilities.
22619
23208
  *
22620
- * **Note:** The `CellSelector` is currently only available in combination with the `GridTableType`. Please
22621
- * refer to {@link sap.m.plugins.CellSelector} see the addiditional restrictions.
23209
+ * **Note:** The `CellSelector` is currently only available in combination with the {@link sap.ui.mdc.table.GridTableType GridTable}.
23210
+ * Please refer to {@link sap.m.plugins.CellSelector} for additional restrictions.
22622
23211
  *
22623
23212
  * @since 1.119
22624
23213
  */
@@ -22626,15 +23215,17 @@ declare namespace sap {
22626
23215
  /**
22627
23216
  * Gets content of aggregation {@link #getColumns columns}.
22628
23217
  *
22629
- * Columns of the table. **Note:** This aggregation is managed by the control, can only be populated during
22630
- * the definition in the XML view, and is not bindable. Any changes of the initial aggregation content might
22631
- * result in undesired effects. Changes of the aggregation have to be made with the {@link sap.ui.mdc.p13n.StateUtil StateUtil}.
23218
+ * Columns of the table.
23219
+ *
23220
+ * **Note:** This aggregation is managed by the control, can only be populated during the definition in
23221
+ * the XML view, and is not bindable. Any changes of the initial aggregation content might result in unwanted
23222
+ * effects. Changes of the aggregation have to be made with the {@link sap.ui.mdc.p13n.StateUtil StateUtil}.
22632
23223
  */
22633
23224
  getColumns(): sap.ui.mdc.table.Column[];
22634
23225
  /**
22635
23226
  * Gets content of aggregation {@link #getContextMenu contextMenu}.
22636
23227
  *
22637
- * Defines the context menu for the table rows.
23228
+ * Defines the context menu for the rows.
22638
23229
  *
22639
23230
  * @since 1.118
22640
23231
  */
@@ -22643,15 +23234,15 @@ declare namespace sap {
22643
23234
  * Gets content of aggregation {@link #getCopyProvider copyProvider}.
22644
23235
  *
22645
23236
  * Defines an aggregation for the `CopyProvider` plugin that provides copy to clipboard capabilities for
22646
- * the selected rows of the table and creates a Copy button for the toolbar of the table. To disable the
22647
- * copy function of the table, including the Copy button in the toolbar, the `enabled` property of the `CopyProvider`
22648
- * must be set to `false`. To hide the Copy button from the toolbar, the `visible` property of the `CopyProvider`
22649
- * must be set to `false`.
23237
+ * the selected rows and creates a Copy button for the toolbar. To disable the copy function, including
23238
+ * the Copy button in the toolbar, the `enabled` property of the `CopyProvider` must be set to `false`.
23239
+ * To hide the Copy button from the toolbar, the `visible` property of the `CopyProvider` must be set to
23240
+ * `false`.
22650
23241
  *
22651
23242
  * **Note:** The {@link sap.m.plugins.CopyProvider#extractData extractData} property of the `CopyProvider`
22652
- * must not be managed by the application. **Note:** The `CopyProvider` requires a secure context to access
22653
- * the clipboard API. If the context is not secure, the plugin will not be added, and the copy button will
22654
- * not be generated.
23243
+ * must not be managed by the application.
23244
+ * The `CopyProvider` requires a secure context to access the clipboard API. If the context is not secure,
23245
+ * the plugin will not be added, and the Copy button will not be generated.
22655
23246
  *
22656
23247
  * @since 1.114
22657
23248
  */
@@ -22660,8 +23251,9 @@ declare namespace sap {
22660
23251
  * Gets content of aggregation {@link #getCreationRow creationRow}.
22661
23252
  *
22662
23253
  * This row can be used for user input to create new data if {@link sap.ui.mdc.enums.TableType TableType }
22663
- * is "`Table`". **Note:** Once the binding supports creating transient records, this aggregation will be
22664
- * removed.
23254
+ * is "`Table`".
23255
+ *
23256
+ * **Note:** Once the binding supports creating transient records, this aggregation will be removed.
22665
23257
  *
22666
23258
  * @experimental - Do not use
22667
23259
  */
@@ -22680,11 +23272,22 @@ declare namespace sap {
22680
23272
  /**
22681
23273
  * Gets current value of property {@link #getDelegate delegate}.
22682
23274
  *
22683
- * Path to `TableDelegate` module that provides the required APIs to create table content.
22684
- * **Note:** Ensure that the related file can be requested (any required library has to be loaded before
23275
+ * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
23276
+ * The object has the following properties:
23277
+ * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/TableDelegate TableDelegate}.
23278
+ *
23279
+ * - `payload` (optional) defines application-specific information that can be used in the given delegate
23280
+ * Sample delegate object:
23281
+ * ```javascript
23282
+ * {
23283
+ * name: "sap/ui/mdc/TableDelegate",
23284
+ * payload: {}
23285
+ * }```
23286
+ *
23287
+ *
23288
+ * **Note:** Ensure that the related file can be requested (any required library has to be loaded before
22685
23289
  * that).
22686
- * Do not bind or modify the module. Once the required module is associated, this property might not be
22687
- * needed any longer.
23290
+ * Do not bind or modify the module. This property can only be configured during control initialization.
22688
23291
  *
22689
23292
  * Default value is `...see text or source`.
22690
23293
  *
@@ -22696,16 +23299,18 @@ declare namespace sap {
22696
23299
  /**
22697
23300
  * Gets current value of property {@link #getEnableAutoColumnWidth enableAutoColumnWidth}.
22698
23301
  *
22699
- * Enables automatic column width calculation based on metadata information if set to `true`. The column
22700
- * width calculation takes the type, column label, referenced properties, and many other metadata parameters
22701
- * into account. Providing a more precise `maxLength` value for the `String` type or `precision` value for
22702
- * numeric types can help this algorithm to produce better results. The calculated column widths can have
22703
- * a minimum of 3rem and a maximum of 20rem.
23302
+ * Enables automatic column width calculation. The column width calculation takes the type, column label,
23303
+ * referenced properties, and other information into account. The calculated column widths can have a minimum
23304
+ * of 3rem and a maximum of 20rem.
23305
+ *
23306
+ * The delegate can customize the automatic column width calculation with the `visualSettings.widthSettings`
23307
+ * field in the {@link sap.ui.mdc.table.PropertyInfo PropertyInfo}. To disable the heuristic column width
23308
+ * calculation for a particular column, the `visualSettings.widthSettings` field can be set to `null`. Providing
23309
+ * a more precise `maxLength` value for the `String` type or `precision` value for numeric types can help
23310
+ * the algorithm to produce better results.
22704
23311
  *
22705
- * **Note:** To customize the automatic column width calculation, the `visualSettings.widthSettings` key
22706
- * of the `PropertyInfo` can be used. To avoid the heuristic column width calculation for a particular column,
22707
- * the `visualSettings.widthSettings` key of the `PropertyInfo` must be set to `null`. This feature has
22708
- * no effect if the `width` property of the column is bound or its value is set.
23312
+ * **Note:** The column width is not calculated if the `width` property of the column is bound or its value
23313
+ * is set.
22709
23314
  *
22710
23315
  * Default value is `false`.
22711
23316
  *
@@ -22729,8 +23334,12 @@ declare namespace sap {
22729
23334
  /**
22730
23335
  * Gets current value of property {@link #getEnableExport enableExport}.
22731
23336
  *
22732
- * Determines whether the table data export is enabled. To use the export functionality, the {@link sap.ui.export }
22733
- * library is required.
23337
+ * Determines whether the data export is enabled.
23338
+ *
23339
+ * The delegate can customize the export result with the `exportSettings` field in the {@link sap.ui.mdc.table.PropertyInfo PropertyInfo}.
23340
+ *
23341
+ * **Note:** To use the export functionality, the {@link sap.ui.export} library is required, otherwise an
23342
+ * error message is displayed when the user presses the Export button.
22734
23343
  *
22735
23344
  * Default value is `false`.
22736
23345
  *
@@ -22754,11 +23363,12 @@ declare namespace sap {
22754
23363
  /**
22755
23364
  * ID of the element which is the current target of the association {@link #getFilter filter}, or `null`.
22756
23365
  */
22757
- getFilter(): sap.ui.core.ID;
23366
+ getFilter(): sap.ui.core.ID | null;
22758
23367
  /**
22759
23368
  * Gets current value of property {@link #getHeader header}.
22760
23369
  *
22761
- * Header text that is shown in the table.
23370
+ * Header text that is shown in the table. The header must always be set to comply with accessibility standards,
23371
+ * even if other settings make the header invisible.
22762
23372
  *
22763
23373
  *
22764
23374
  * @returns Value of property `header`
@@ -22803,24 +23413,52 @@ declare namespace sap {
22803
23413
  /**
22804
23414
  * Gets current value of property {@link #getHeight height}.
22805
23415
  *
22806
- * This property has no effect and will be rmoved soon.
23416
+ * This property has no effect and will be removed soon.
22807
23417
  *
22808
- * @deprecated - Do not use.
23418
+ * @deprecated (since 1.115)
22809
23419
  *
22810
23420
  * @returns Value of property `height`
22811
23421
  */
22812
23422
  getHeight(): sap.ui.core.CSSSize;
22813
23423
  /**
22814
- * Gets current value of property {@link #getMultiSelectMode multiSelectMode}.
23424
+ * Gets current value of property {@link #getHideToolbar hideToolbar}.
23425
+ *
23426
+ * Determines whether the toolbar is visible.
23427
+ *
23428
+ * **Note:** Hiding the toolbar limits the functionality of the table in the following ways:
23429
+ *
23430
+ * - The `showRowCount` property **must** be set to `false`.
23431
+ * - The export **must** be disabled by setting the `enableExport` property to `false`.
23432
+ * - For {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}, show and hide details won't be
23433
+ * visible as the table will always run in "Show Details" mode.
23434
+ * - Copy and paste will only work via keyboard.
23435
+ * - For {@link sap.ui.mdc.table.TreeTableType TreeTable}, "Collapse All" and "Expand All" won't be possible.
23436
+ *
23437
+ * - The `actions` and the `quickFilter` aggregations and a table-related {@link sap.ui.fl.variants.VariantManagement }
23438
+ * **must not** be used.
23439
+ * - The table title will not be displayed but will be replaced by an `InvisibleText`. The `header` property
23440
+ * **must** be set. In addition, `headerVisible` **must** be set to `false` to ensure accessibility compatibility.
23441
+ *
23442
+ * - Personalization (`p13nMode`) can still be used via the column headers. If the option to show or hide
23443
+ * columns is activated, it is recommended to use an {@link sap.m.IllustratedMessage} for the `nodata` display.
23444
+ * It ensures that columns can be made visible again when the user has accidentally hidden them all.
23445
+ *
23446
+ * Default value is `false`.
22815
23447
  *
22816
- * Defines the multi-selection mode for the control. If this property is set to the `Default` value, the
22817
- * `ResponsiveTable` type control renders the Select All checkbox in the column header, otherwise the Deselect
22818
- * All icon is rendered.
23448
+ * @since 1.121
22819
23449
  *
22820
- * This property is used with the `selectionMode="Multi"`.
23450
+ * @returns Value of property `hideToolbar`
23451
+ */
23452
+ getHideToolbar(): boolean;
23453
+ /**
23454
+ * Gets current value of property {@link #getMultiSelectMode multiSelectMode}.
23455
+ *
23456
+ * Defines the multi-selection mode.
22821
23457
  *
22822
- * **Note:** This property has currently no effect for table types other than `ResponsiveTable` type. This
22823
- * is subject to change in future.
23458
+ * **Note:** This property has no effect in the following cases:
23459
+ * - Table type is not {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}. This is subject to
23460
+ * change in the future.
23461
+ * - Selection mode is not `Multi`.
22824
23462
  *
22825
23463
  * Default value is `Default`.
22826
23464
  *
@@ -22832,7 +23470,7 @@ declare namespace sap {
22832
23470
  /**
22833
23471
  * Gets content of aggregation {@link #getNoData noData}.
22834
23472
  *
22835
- * Defines the custom visualization if there is no data to show in the table.
23473
+ * Defines the custom visualization if there is no data to show.
22836
23474
  *
22837
23475
  * **Note:** If {@link sap.m.IllustratedMessage} control is set for the `noData` aggregation and its {@link sap.m.IllustratedMessage#getTitle title }
22838
23476
  * property is not set then the table automatically offers a no data text with fitting {@link sap.m.IllustratedMessage.IllustratedMessageType illustration}.
@@ -22844,7 +23482,10 @@ declare namespace sap {
22844
23482
  * Gets current value of property {@link #getP13nMode p13nMode}.
22845
23483
  *
22846
23484
  * Personalization options for the table.
22847
- * **Note:** The order of the options does not influence the position on the UI.
23485
+ *
23486
+ * **Note:** Whether a personalization option is supported depends on the used delegate. Please refer to
23487
+ * the documentation of the individual delegates. The order of the provided options does not influence their
23488
+ * order on the UI.
22848
23489
  *
22849
23490
  * Default value is `[]`.
22850
23491
  *
@@ -22856,7 +23497,7 @@ declare namespace sap {
22856
23497
  /**
22857
23498
  * Gets content of aggregation {@link #getQuickFilter quickFilter}.
22858
23499
  *
22859
- * Additional `Filter` for the table.
23500
+ * Additional control for filtering that will be available in the toolbar.
22860
23501
  */
22861
23502
  getQuickFilter(): sap.ui.core.Control;
22862
23503
  /**
@@ -22881,9 +23522,9 @@ declare namespace sap {
22881
23522
  * Selection mode of the table. Specifies whether single or multiple rows can be selected and how the selection
22882
23523
  * can be extended. It may also influence the visual appearance.
22883
23524
  *
22884
- * With the {@link sap.ui.mdc.table.GridTableType GridTableType} and server-side models, range selections,
22885
- * including Select All, only work properly if the count is known. Make sure the model/binding is configured
22886
- * to request the count from the service.
23525
+ * **Note:** With the {@link sap.ui.mdc.table.GridTableType GridTable} and server-side models, range selections,
23526
+ * including Select All, only work properly if the count is known. Please refer to the documentation of
23527
+ * the used model for information on requesting the count, for example, {@link sap.ui.model.odata.v4.ODataModel}.
22887
23528
  *
22888
23529
  * Default value is `None`.
22889
23530
  *
@@ -22906,12 +23547,11 @@ declare namespace sap {
22906
23547
  /**
22907
23548
  * Gets current value of property {@link #getShowRowCount showRowCount}.
22908
23549
  *
22909
- * Determines whether the number of rows is shown along with the header text. If set to `false`, the number
22910
- * of rows is not shown on the user interface.
22911
- * **Note:**
22912
- * For better performance dedicated OData requests should not be sent. The count mode must be configured
22913
- * either in the model or in the binding of the table.
22914
- * This property can only be used if the back-end service supports row count.
23550
+ * Determines whether the number of rows is shown along with the header text.
23551
+ *
23552
+ * **Note:** Whether this feature can be used depends on whether the model used and the data service can
23553
+ * provide a count. Please refer to the documentation of the used model for information on requesting the
23554
+ * count, for example, {@link sap.ui.model.odata.v4.ODataModel}.
22915
23555
  *
22916
23556
  * Default value is `true`.
22917
23557
  *
@@ -22922,12 +23562,19 @@ declare namespace sap {
22922
23562
  /**
22923
23563
  * Gets current value of property {@link #getThreshold threshold}.
22924
23564
  *
22925
- * Number of records to be requested from the model. If the `type` property is set to `ResponsiveTable`,
22926
- * then it refers to the {@link sap.m.ListBase#getGrowingThreshold growingThreshold} property of `ResponsiveTable`.
22927
- * If the `type` property is set to `Table`, then it refers to the {@link sap.ui.table.Table#getThreshold threshold }
22928
- * property of `GridTable`.
22929
- * **Note:** This property only takes effect if it is set to a positive integer value. Otherwise the table
22930
- * uses the default value of the corresponding table types.
23565
+ * Number of records to be requested from the model.
23566
+ *
23567
+ * If the table type is {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}, the threshold defines
23568
+ * the number of rows that are displayed initially, and the number of rows that are added when the table
23569
+ * grows ({@link sap.ui.mdc.table.ResponsiveTableType#getGrowingMode growingMode}).
23570
+ *
23571
+ * If the table type is {@link sap.ui.mdc.table.GridTableType GridTable}, the threshold defines how many
23572
+ * additional (not yet visible) data records from the back-end system are pre-fetched. If the `threshold`
23573
+ * is lower than the number of visible rows, the number of visible rows is used as the `threshold`. If the
23574
+ * value is 0, thresholding is disabled.
23575
+ *
23576
+ * **Note:** This property only takes effect if it is set to a positive integer value. Otherwise the table
23577
+ * uses a type-dependent default value.
22931
23578
  *
22932
23579
  * Default value is `-1`.
22933
23580
  *
@@ -22997,8 +23644,8 @@ declare namespace sap {
22997
23644
  oColumn: sap.ui.mdc.table.Column
22998
23645
  ): int;
22999
23646
  /**
23000
- * Returns a `Promise` that resolves once the table has been initialized after the creation and changing
23001
- * of its type.
23647
+ * Returns a `Promise` that resolves after the table has been initialized, and after it has been created
23648
+ * or its type has been changed.
23002
23649
  *
23003
23650
  *
23004
23651
  * @returns A `Promise` that resolves after the table has been initialized
@@ -23020,7 +23667,7 @@ declare namespace sap {
23020
23667
  *
23021
23668
  * @since 1.76
23022
23669
  *
23023
- * @returns A `Promise` that resolves after the table scrolls to the row with the given index
23670
+ * @returns A `Promise` that resolves after the table has been scrolled to the row with the given index
23024
23671
  */
23025
23672
  scrollToIndex(
23026
23673
  /**
@@ -23132,11 +23779,22 @@ declare namespace sap {
23132
23779
  /**
23133
23780
  * Sets a new value for property {@link #getDelegate delegate}.
23134
23781
  *
23135
- * Path to `TableDelegate` module that provides the required APIs to create table content.
23136
- * **Note:** Ensure that the related file can be requested (any required library has to be loaded before
23782
+ * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
23783
+ * The object has the following properties:
23784
+ * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/TableDelegate TableDelegate}.
23785
+ *
23786
+ * - `payload` (optional) defines application-specific information that can be used in the given delegate
23787
+ * Sample delegate object:
23788
+ * ```javascript
23789
+ * {
23790
+ * name: "sap/ui/mdc/TableDelegate",
23791
+ * payload: {}
23792
+ * }```
23793
+ *
23794
+ *
23795
+ * **Note:** Ensure that the related file can be requested (any required library has to be loaded before
23137
23796
  * that).
23138
- * Do not bind or modify the module. Once the required module is associated, this property might not be
23139
- * needed any longer.
23797
+ * Do not bind or modify the module. This property can only be configured during control initialization.
23140
23798
  *
23141
23799
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
23142
23800
  *
@@ -23155,16 +23813,18 @@ declare namespace sap {
23155
23813
  /**
23156
23814
  * Sets a new value for property {@link #getEnableAutoColumnWidth enableAutoColumnWidth}.
23157
23815
  *
23158
- * Enables automatic column width calculation based on metadata information if set to `true`. The column
23159
- * width calculation takes the type, column label, referenced properties, and many other metadata parameters
23160
- * into account. Providing a more precise `maxLength` value for the `String` type or `precision` value for
23161
- * numeric types can help this algorithm to produce better results. The calculated column widths can have
23162
- * a minimum of 3rem and a maximum of 20rem.
23816
+ * Enables automatic column width calculation. The column width calculation takes the type, column label,
23817
+ * referenced properties, and other information into account. The calculated column widths can have a minimum
23818
+ * of 3rem and a maximum of 20rem.
23163
23819
  *
23164
- * **Note:** To customize the automatic column width calculation, the `visualSettings.widthSettings` key
23165
- * of the `PropertyInfo` can be used. To avoid the heuristic column width calculation for a particular column,
23166
- * the `visualSettings.widthSettings` key of the `PropertyInfo` must be set to `null`. This feature has
23167
- * no effect if the `width` property of the column is bound or its value is set.
23820
+ * The delegate can customize the automatic column width calculation with the `visualSettings.widthSettings`
23821
+ * field in the {@link sap.ui.mdc.table.PropertyInfo PropertyInfo}. To disable the heuristic column width
23822
+ * calculation for a particular column, the `visualSettings.widthSettings` field can be set to `null`. Providing
23823
+ * a more precise `maxLength` value for the `String` type or `precision` value for numeric types can help
23824
+ * the algorithm to produce better results.
23825
+ *
23826
+ * **Note:** The column width is not calculated if the `width` property of the column is bound or its value
23827
+ * is set.
23168
23828
  *
23169
23829
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
23170
23830
  *
@@ -23202,8 +23862,12 @@ declare namespace sap {
23202
23862
  /**
23203
23863
  * Sets a new value for property {@link #getEnableExport enableExport}.
23204
23864
  *
23205
- * Determines whether the table data export is enabled. To use the export functionality, the {@link sap.ui.export }
23206
- * library is required.
23865
+ * Determines whether the data export is enabled.
23866
+ *
23867
+ * The delegate can customize the export result with the `exportSettings` field in the {@link sap.ui.mdc.table.PropertyInfo PropertyInfo}.
23868
+ *
23869
+ * **Note:** To use the export functionality, the {@link sap.ui.export} library is required, otherwise an
23870
+ * error message is displayed when the user presses the Export button.
23207
23871
  *
23208
23872
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
23209
23873
  *
@@ -23254,7 +23918,8 @@ declare namespace sap {
23254
23918
  /**
23255
23919
  * Sets a new value for property {@link #getHeader header}.
23256
23920
  *
23257
- * Header text that is shown in the table.
23921
+ * Header text that is shown in the table. The header must always be set to comply with accessibility standards,
23922
+ * even if other settings make the header invisible.
23258
23923
  *
23259
23924
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
23260
23925
  *
@@ -23327,11 +23992,11 @@ declare namespace sap {
23327
23992
  /**
23328
23993
  * Sets a new value for property {@link #getHeight height}.
23329
23994
  *
23330
- * This property has no effect and will be rmoved soon.
23995
+ * This property has no effect and will be removed soon.
23331
23996
  *
23332
23997
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
23333
23998
  *
23334
- * @deprecated - Do not use.
23999
+ * @deprecated (since 1.115)
23335
24000
  *
23336
24001
  * @returns Reference to `this` in order to allow method chaining
23337
24002
  */
@@ -23342,16 +24007,51 @@ declare namespace sap {
23342
24007
  sHeight?: sap.ui.core.CSSSize
23343
24008
  ): this;
23344
24009
  /**
23345
- * Sets a new value for property {@link #getMultiSelectMode multiSelectMode}.
24010
+ * Sets a new value for property {@link #getHideToolbar hideToolbar}.
24011
+ *
24012
+ * Determines whether the toolbar is visible.
24013
+ *
24014
+ * **Note:** Hiding the toolbar limits the functionality of the table in the following ways:
24015
+ *
24016
+ * - The `showRowCount` property **must** be set to `false`.
24017
+ * - The export **must** be disabled by setting the `enableExport` property to `false`.
24018
+ * - For {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}, show and hide details won't be
24019
+ * visible as the table will always run in "Show Details" mode.
24020
+ * - Copy and paste will only work via keyboard.
24021
+ * - For {@link sap.ui.mdc.table.TreeTableType TreeTable}, "Collapse All" and "Expand All" won't be possible.
24022
+ *
24023
+ * - The `actions` and the `quickFilter` aggregations and a table-related {@link sap.ui.fl.variants.VariantManagement }
24024
+ * **must not** be used.
24025
+ * - The table title will not be displayed but will be replaced by an `InvisibleText`. The `header` property
24026
+ * **must** be set. In addition, `headerVisible` **must** be set to `false` to ensure accessibility compatibility.
24027
+ *
24028
+ * - Personalization (`p13nMode`) can still be used via the column headers. If the option to show or hide
24029
+ * columns is activated, it is recommended to use an {@link sap.m.IllustratedMessage} for the `nodata` display.
24030
+ * It ensures that columns can be made visible again when the user has accidentally hidden them all.
24031
+ *
24032
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
24033
+ *
24034
+ * Default value is `false`.
24035
+ *
24036
+ * @since 1.121
23346
24037
  *
23347
- * Defines the multi-selection mode for the control. If this property is set to the `Default` value, the
23348
- * `ResponsiveTable` type control renders the Select All checkbox in the column header, otherwise the Deselect
23349
- * All icon is rendered.
24038
+ * @returns Reference to `this` in order to allow method chaining
24039
+ */
24040
+ setHideToolbar(
24041
+ /**
24042
+ * New value for property `hideToolbar`
24043
+ */
24044
+ bHideToolbar?: boolean
24045
+ ): this;
24046
+ /**
24047
+ * Sets a new value for property {@link #getMultiSelectMode multiSelectMode}.
23350
24048
  *
23351
- * This property is used with the `selectionMode="Multi"`.
24049
+ * Defines the multi-selection mode.
23352
24050
  *
23353
- * **Note:** This property has currently no effect for table types other than `ResponsiveTable` type. This
23354
- * is subject to change in future.
24051
+ * **Note:** This property has no effect in the following cases:
24052
+ * - Table type is not {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}. This is subject to
24053
+ * change in the future.
24054
+ * - Selection mode is not `Multi`.
23355
24055
  *
23356
24056
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
23357
24057
  *
@@ -23384,7 +24084,10 @@ declare namespace sap {
23384
24084
  * Sets a new value for property {@link #getP13nMode p13nMode}.
23385
24085
  *
23386
24086
  * Personalization options for the table.
23387
- * **Note:** The order of the options does not influence the position on the UI.
24087
+ *
24088
+ * **Note:** Whether a personalization option is supported depends on the used delegate. Please refer to
24089
+ * the documentation of the individual delegates. The order of the provided options does not influence their
24090
+ * order on the UI.
23388
24091
  *
23389
24092
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
23390
24093
  *
@@ -23430,9 +24133,9 @@ declare namespace sap {
23430
24133
  * Selection mode of the table. Specifies whether single or multiple rows can be selected and how the selection
23431
24134
  * can be extended. It may also influence the visual appearance.
23432
24135
  *
23433
- * With the {@link sap.ui.mdc.table.GridTableType GridTableType} and server-side models, range selections,
23434
- * including Select All, only work properly if the count is known. Make sure the model/binding is configured
23435
- * to request the count from the service.
24136
+ * **Note:** With the {@link sap.ui.mdc.table.GridTableType GridTable} and server-side models, range selections,
24137
+ * including Select All, only work properly if the count is known. Please refer to the documentation of
24138
+ * the used model for information on requesting the count, for example, {@link sap.ui.model.odata.v4.ODataModel}.
23436
24139
  *
23437
24140
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
23438
24141
  *
@@ -23469,12 +24172,11 @@ declare namespace sap {
23469
24172
  /**
23470
24173
  * Sets a new value for property {@link #getShowRowCount showRowCount}.
23471
24174
  *
23472
- * Determines whether the number of rows is shown along with the header text. If set to `false`, the number
23473
- * of rows is not shown on the user interface.
23474
- * **Note:**
23475
- * For better performance dedicated OData requests should not be sent. The count mode must be configured
23476
- * either in the model or in the binding of the table.
23477
- * This property can only be used if the back-end service supports row count.
24175
+ * Determines whether the number of rows is shown along with the header text.
24176
+ *
24177
+ * **Note:** Whether this feature can be used depends on whether the model used and the data service can
24178
+ * provide a count. Please refer to the documentation of the used model for information on requesting the
24179
+ * count, for example, {@link sap.ui.model.odata.v4.ODataModel}.
23478
24180
  *
23479
24181
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
23480
24182
  *
@@ -23492,12 +24194,19 @@ declare namespace sap {
23492
24194
  /**
23493
24195
  * Sets a new value for property {@link #getThreshold threshold}.
23494
24196
  *
23495
- * Number of records to be requested from the model. If the `type` property is set to `ResponsiveTable`,
23496
- * then it refers to the {@link sap.m.ListBase#getGrowingThreshold growingThreshold} property of `ResponsiveTable`.
23497
- * If the `type` property is set to `Table`, then it refers to the {@link sap.ui.table.Table#getThreshold threshold }
23498
- * property of `GridTable`.
23499
- * **Note:** This property only takes effect if it is set to a positive integer value. Otherwise the table
23500
- * uses the default value of the corresponding table types.
24197
+ * Number of records to be requested from the model.
24198
+ *
24199
+ * If the table type is {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}, the threshold defines
24200
+ * the number of rows that are displayed initially, and the number of rows that are added when the table
24201
+ * grows ({@link sap.ui.mdc.table.ResponsiveTableType#getGrowingMode growingMode}).
24202
+ *
24203
+ * If the table type is {@link sap.ui.mdc.table.GridTableType GridTable}, the threshold defines how many
24204
+ * additional (not yet visible) data records from the back-end system are pre-fetched. If the `threshold`
24205
+ * is lower than the number of visible rows, the number of visible rows is used as the `threshold`. If the
24206
+ * value is 0, thresholding is disabled.
24207
+ *
24208
+ * **Note:** This property only takes effect if it is set to a positive integer value. Otherwise the table
24209
+ * uses a type-dependent default value.
23501
24210
  *
23502
24211
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
23503
24212
  *
@@ -24325,7 +25034,17 @@ declare namespace sap {
24325
25034
  /**
24326
25035
  * Gets current value of property {@link #getDelegate delegate}.
24327
25036
  *
24328
- * Path to the `Delegate` module that provides the required APIs to execute model-specific logic.
25037
+ * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
25038
+ * The object has the following properties:
25039
+ * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/ValueHelpDelegate ValueHelpDelegate }
25040
+ *
25041
+ * - `payload` (optional) defines application-specific information that can be used in the given delegate
25042
+ * Sample delegate object:
25043
+ * ```javascript
25044
+ * {
25045
+ * name: "sap/ui/mdc/ValueHelpDelegate",
25046
+ * payload: {}
25047
+ * }```
24329
25048
  * **Note:** Ensure that the related file can be requested (any required library has to be loaded before
24330
25049
  * that).
24331
25050
  * Do not bind or modify the module. This property can only be configured during control initialization.
@@ -24408,7 +25127,17 @@ declare namespace sap {
24408
25127
  /**
24409
25128
  * Sets a new value for property {@link #getDelegate delegate}.
24410
25129
  *
24411
- * Path to the `Delegate` module that provides the required APIs to execute model-specific logic.
25130
+ * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
25131
+ * The object has the following properties:
25132
+ * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/ValueHelpDelegate ValueHelpDelegate }
25133
+ *
25134
+ * - `payload` (optional) defines application-specific information that can be used in the given delegate
25135
+ * Sample delegate object:
25136
+ * ```javascript
25137
+ * {
25138
+ * name: "sap/ui/mdc/ValueHelpDelegate",
25139
+ * payload: {}
25140
+ * }```
24412
25141
  * **Note:** Ensure that the related file can be requested (any required library has to be loaded before
24413
25142
  * that).
24414
25143
  * Do not bind or modify the module. This property can only be configured during control initialization.
@@ -24728,7 +25457,7 @@ declare namespace sap {
24728
25457
 
24729
25458
  "sap/ui/mdc/enums/TableP13nMode": undefined;
24730
25459
 
24731
- "sap/ui/mdc/enums/TableRowAction": undefined;
25460
+ "sap/ui/mdc/enums/TableRowActionType": undefined;
24732
25461
 
24733
25462
  "sap/ui/mdc/enums/TableRowCountMode": undefined;
24734
25463