@sapui5/ts-types 1.112.3 → 1.114.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 (64) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +0 -1
  3. package/types/sap.apf.d.ts +1 -1
  4. package/types/sap.ca.ui.d.ts +59 -2
  5. package/types/sap.chart.d.ts +15 -1
  6. package/types/sap.collaboration.d.ts +33 -1
  7. package/types/sap.esh.search.ui.d.ts +449 -1
  8. package/types/sap.f.d.ts +125 -38
  9. package/types/sap.fe.core.d.ts +35 -5
  10. package/types/sap.fe.macros.d.ts +80 -72
  11. package/types/sap.fe.navigation.d.ts +2 -0
  12. package/types/sap.fe.templates.d.ts +6 -0
  13. package/types/sap.fe.test.d.ts +7 -1
  14. package/types/sap.feedback.ui.d.ts +2 -6
  15. package/types/sap.gantt.d.ts +238 -16
  16. package/types/sap.insights.d.ts +1 -1
  17. package/types/sap.landvisz.d.ts +27 -1
  18. package/types/sap.m.d.ts +2306 -1028
  19. package/types/sap.makit.d.ts +13 -1
  20. package/types/sap.me.d.ts +17 -1
  21. package/types/sap.ndc.d.ts +10 -2
  22. package/types/sap.ovp.d.ts +7 -1
  23. package/types/sap.rules.ui.d.ts +9 -1
  24. package/types/sap.sac.df.d.ts +64 -551
  25. package/types/sap.suite.ui.commons.d.ts +276 -2
  26. package/types/sap.suite.ui.generic.template.d.ts +180 -1
  27. package/types/sap.suite.ui.microchart.d.ts +37 -1
  28. package/types/sap.tnt.d.ts +7 -1
  29. package/types/sap.ui.codeeditor.d.ts +5 -1
  30. package/types/sap.ui.commons.d.ts +197 -1
  31. package/types/sap.ui.comp.d.ts +706 -263
  32. package/types/sap.ui.core.d.ts +3117 -1641
  33. package/types/sap.ui.dt.d.ts +1 -1
  34. package/types/sap.ui.export.d.ts +1 -1
  35. package/types/sap.ui.fl.d.ts +13 -3
  36. package/types/sap.ui.generic.app.d.ts +21 -8
  37. package/types/sap.ui.generic.template.d.ts +1 -1
  38. package/types/sap.ui.integration.d.ts +158 -22
  39. package/types/sap.ui.layout.d.ts +43 -1
  40. package/types/sap.ui.mdc.d.ts +17 -7
  41. package/types/sap.ui.richtexteditor.d.ts +11 -1
  42. package/types/sap.ui.rta.d.ts +1 -1
  43. package/types/sap.ui.suite.d.ts +5 -1
  44. package/types/sap.ui.support.d.ts +1 -1
  45. package/types/sap.ui.table.d.ts +98 -7
  46. package/types/sap.ui.testrecorder.d.ts +1 -1
  47. package/types/sap.ui.unified.d.ts +433 -111
  48. package/types/sap.ui.ux3.d.ts +147 -1
  49. package/types/sap.ui.vbm.d.ts +122 -1
  50. package/types/sap.ui.vk.d.ts +414 -2
  51. package/types/sap.ui.vtm.d.ts +73 -1
  52. package/types/sap.ui.webc.common.d.ts +1 -1
  53. package/types/sap.ui.webc.fiori.d.ts +63 -1
  54. package/types/sap.ui.webc.main.d.ts +189 -5
  55. package/types/sap.uiext.inbox.d.ts +27 -1
  56. package/types/sap.ushell.d.ts +380 -84
  57. package/types/sap.ushell_abap.d.ts +1 -1
  58. package/types/sap.uxap.d.ts +26 -1
  59. package/types/sap.viz.d.ts +229 -1
  60. package/types/sap.webanalytics.core.d.ts +1 -1
  61. package/types/sap.zen.commons.d.ts +1 -1
  62. package/types/sap.zen.crosstab.d.ts +1 -1
  63. package/types/sap.zen.dsh.d.ts +10 -1
  64. package/types/sap.sac.grid.d.ts +0 -760
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.112.2
1
+ // For Library Version: 1.114.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -13,6 +13,22 @@ declare namespace sap {
13
13
  */
14
14
  namespace comp {
15
15
  namespace filterbar {
16
+ namespace FilterBar {
17
+ type fetchVariantResponse = {
18
+ filterBarVariant: string | Object;
19
+
20
+ filterbar: Object;
21
+
22
+ orderedFilterItems: string;
23
+
24
+ singleInputsTextArrangementData: string;
25
+
26
+ version: string | undefined;
27
+
28
+ basicSearch: string | undefined;
29
+ };
30
+ }
31
+
16
32
  interface $FilterBarSettings extends sap.ui.layout.$GridSettings {
17
33
  /**
18
34
  * Key used to access personalization data. Only if the persistencyKey is provided, will the `VariantManagement`
@@ -586,6 +602,8 @@ declare namespace sap {
586
602
  */
587
603
  static getMetadata(): sap.ui.core.ElementMetadata;
588
604
  /**
605
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
606
+ *
589
607
  * Adds a `FilterGroupItem` element to the aggregation `_parameters`.
590
608
  *
591
609
  * @returns Reference to this in order to allow method chaining
@@ -597,18 +615,24 @@ declare namespace sap {
597
615
  oParameter: sap.ui.comp.filterbar.FilterGroupItem
598
616
  ): this;
599
617
  /**
618
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
619
+ *
600
620
  * Checks if running on phone.
601
621
  *
602
622
  * @returns `True` if phone, `false` otherwise
603
623
  */
604
624
  _isPhone(): boolean;
605
625
  /**
626
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
627
+ *
606
628
  * Checks if running on tablet.
607
629
  *
608
630
  * @returns `True` if tablet, `false` otherwise
609
631
  */
610
632
  _isTablet(): boolean;
611
633
  /**
634
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
635
+ *
612
636
  * Retrieves the controls for all visible filters.
613
637
  *
614
638
  * @returns all visible controls/filter name & controls
@@ -624,6 +648,8 @@ declare namespace sap {
624
648
  bConsiderParameters: boolean
625
649
  ): any[];
626
650
  /**
651
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
652
+ *
627
653
  * Updates the 'Filters'-button text with the count of filters with values
628
654
  */
629
655
  _updateToolbarText(): void;
@@ -706,7 +732,7 @@ declare namespace sap {
706
732
  /**
707
733
  * JSON object
708
734
  */
709
- oVariant: object,
735
+ oVariant: Object,
710
736
  /**
711
737
  * Describes in which context the variant is applied. The context is passed on to the application via the
712
738
  * afterVariantLoad event
@@ -1983,8 +2009,10 @@ declare namespace sap {
1983
2009
  * basicSearch: string|undefined
1984
2010
  * }```
1985
2011
  */
1986
- fetchVariant(): Object;
2012
+ fetchVariant(): sap.ui.comp.filterbar.FilterBar.fetchVariantResponse;
1987
2013
  /**
2014
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2015
+ *
1988
2016
  * Fires event {@link #event:afterVariantSave afterVariantSave} to attached listeners.
1989
2017
  *
1990
2018
  * @returns Reference to `this` in order to allow method chaining
@@ -1997,6 +2025,7 @@ declare namespace sap {
1997
2025
  ): this;
1998
2026
  /**
1999
2027
  * @SINCE 1.38.0
2028
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2000
2029
  *
2001
2030
  * Fires event {@link #event:assignedFiltersChanged assignedFiltersChanged} to attached listeners.
2002
2031
  *
@@ -2010,6 +2039,7 @@ declare namespace sap {
2010
2039
  ): this;
2011
2040
  /**
2012
2041
  * @SINCE 1.28.13
2042
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2013
2043
  *
2014
2044
  * Fires event {@link #event:beforeVariantFetch beforeVariantFetch} to attached listeners.
2015
2045
  *
@@ -2022,6 +2052,8 @@ declare namespace sap {
2022
2052
  mParameters?: object
2023
2053
  ): this;
2024
2054
  /**
2055
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2056
+ *
2025
2057
  * Fires event {@link #event:cancel cancel} to attached listeners.
2026
2058
  *
2027
2059
  * @returns Reference to `this` in order to allow method chaining
@@ -2033,6 +2065,8 @@ declare namespace sap {
2033
2065
  mParameters?: object
2034
2066
  ): this;
2035
2067
  /**
2068
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2069
+ *
2036
2070
  * Fires event {@link #event:clear clear} to attached listeners.
2037
2071
  *
2038
2072
  * @returns Reference to `this` in order to allow method chaining
@@ -2050,6 +2084,7 @@ declare namespace sap {
2050
2084
  ): this;
2051
2085
  /**
2052
2086
  * @SINCE 1.48.0
2087
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2053
2088
  *
2054
2089
  * Fires event {@link #event:filtersDialogBeforeOpen filtersDialogBeforeOpen} to attached listeners.
2055
2090
  *
@@ -2063,6 +2098,7 @@ declare namespace sap {
2063
2098
  ): this;
2064
2099
  /**
2065
2100
  * @SINCE 1.48.0
2101
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2066
2102
  *
2067
2103
  * Fires event {@link #event:filtersDialogCancel filtersDialogCancel} to attached listeners.
2068
2104
  *
@@ -2076,6 +2112,7 @@ declare namespace sap {
2076
2112
  ): this;
2077
2113
  /**
2078
2114
  * @SINCE 1.34.0
2115
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2079
2116
  *
2080
2117
  * Fires event {@link #event:filtersDialogClosed filtersDialogClosed} to attached listeners.
2081
2118
  *
@@ -2095,6 +2132,7 @@ declare namespace sap {
2095
2132
  /**
2096
2133
  * @SINCE 1.48.0
2097
2134
  * @deprecated (since 1.84)
2135
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2098
2136
  *
2099
2137
  * Fires event {@link #event:filtersDialogSearch filtersDialogSearch} to attached listeners.
2100
2138
  *
@@ -2109,6 +2147,7 @@ declare namespace sap {
2109
2147
  /**
2110
2148
  * @SINCE 1.48.0
2111
2149
  * @deprecated (since 1.84)
2150
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2112
2151
  *
2113
2152
  * Fires event {@link #event:filtersDialogSearchForFilters filtersDialogSearchForFilters} to attached listeners.
2114
2153
  *
@@ -2126,6 +2165,8 @@ declare namespace sap {
2126
2165
  }
2127
2166
  ): this;
2128
2167
  /**
2168
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2169
+ *
2129
2170
  * Fires event {@link #event:initialise initialise} to attached listeners.
2130
2171
  *
2131
2172
  * @returns Reference to `this` in order to allow method chaining
@@ -2138,6 +2179,7 @@ declare namespace sap {
2138
2179
  ): this;
2139
2180
  /**
2140
2181
  * @SINCE 1.38.0
2182
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2141
2183
  *
2142
2184
  * Fires event {@link #event:initialized initialized} to attached listeners.
2143
2185
  *
@@ -2150,6 +2192,8 @@ declare namespace sap {
2150
2192
  mParameters?: object
2151
2193
  ): this;
2152
2194
  /**
2195
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2196
+ *
2153
2197
  * Fires event {@link #event:reset reset} to attached listeners.
2154
2198
  *
2155
2199
  * @returns Reference to `this` in order to allow method chaining
@@ -2166,6 +2210,8 @@ declare namespace sap {
2166
2210
  }
2167
2211
  ): this;
2168
2212
  /**
2213
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2214
+ *
2169
2215
  * Fires event {@link #event:search search} to attached listeners.
2170
2216
  *
2171
2217
  * @returns Reference to `this` in order to allow method chaining
@@ -2215,12 +2261,16 @@ declare namespace sap {
2215
2261
  */
2216
2262
  getBasicSearch(): sap.ui.core.ID;
2217
2263
  /**
2264
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2265
+ *
2218
2266
  * Determine the internal basic search field name.
2219
2267
  *
2220
2268
  * @returns name of the basic search field.
2221
2269
  */
2222
2270
  getBasicSearchName(): string;
2223
2271
  /**
2272
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2273
+ *
2224
2274
  * Determine the value of the basic search.
2225
2275
  *
2226
2276
  * @returns current value of the basic search field.
@@ -2274,6 +2324,7 @@ declare namespace sap {
2274
2324
  getDeltaVariantMode(): boolean;
2275
2325
  /**
2276
2326
  * @SINCE 1.75
2327
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2277
2328
  *
2278
2329
  * Reads the descriptions for given filters and value keys.
2279
2330
  */
@@ -2375,7 +2426,7 @@ declare namespace sap {
2375
2426
  /**
2376
2427
  * Returns promise which will be resolve when the initialized event is fired.
2377
2428
  */
2378
- getInitializedPromise(): Promise<any>;
2429
+ getInitializedPromise(): Promise<undefined>;
2379
2430
  /**
2380
2431
  * Gets current value of property {@link #getIsRunningInValueHelpDialog isRunningInValueHelpDialog}.
2381
2432
  *
@@ -2446,17 +2497,6 @@ declare namespace sap {
2446
2497
  * @returns Value of property `showFilterConfiguration`
2447
2498
  */
2448
2499
  getShowFilterConfiguration(): boolean;
2449
- /**
2450
- * @SINCE 1.26.1
2451
- * @deprecated (since 1.28.0) - Replaced by property `showGoOnFB`
2452
- *
2453
- * Gets current value of property {@link #getShowGoButton showGoButton}.
2454
- *
2455
- * Handles visibility of the Go button on the FilterBar.
2456
- *
2457
- * @returns Value of property `showGoButton`
2458
- */
2459
- getShowGoButton(): boolean;
2460
2500
  /**
2461
2501
  * @SINCE 1.28.0
2462
2502
  *
@@ -2557,9 +2597,10 @@ declare namespace sap {
2557
2597
  *
2558
2598
  * @returns the associated VariantManagement control.
2559
2599
  */
2560
- getVariantManagement(): sap.ui.comp.variants.VariantManagement;
2600
+ getVariantManagement(): null | sap.ui.comp.variants.VariantManagement;
2561
2601
  /**
2562
2602
  * @SINCE 1.40.4
2603
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2563
2604
  *
2564
2605
  * Hides the Go button on FilterBar. Allows to hide the Go-button for dedicated scenarios, like liveMode.
2565
2606
  */
@@ -2606,6 +2647,8 @@ declare namespace sap {
2606
2647
  */
2607
2648
  isCurrentVariantStandard(): boolean | undefined;
2608
2649
  /**
2650
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2651
+ *
2609
2652
  * Determines if the filters dialog is opened.
2610
2653
  *
2611
2654
  * @returns State of filters dialog
@@ -2616,25 +2659,25 @@ declare namespace sap {
2616
2659
  * applied. The callback function will receive the corresponding data set containing all relevant data in
2617
2660
  * JSON, as initially provided by the callback for fetchData.
2618
2661
  *
2619
- * @returns Reference to this in order to allow method chaining.
2662
+ * @returns Returns `this` to allow method chaining.
2620
2663
  */
2621
2664
  registerApplyData(
2622
2665
  /**
2623
2666
  * Called when a variant must be applied
2624
2667
  */
2625
- fCallBack: Function
2668
+ fCallBack: (p1: string, p2: string) => void
2626
2669
  ): this;
2627
2670
  /**
2628
2671
  * Registration of a callback function. The provided callback function is executed when saving a variant
2629
2672
  * is triggered and must provide all relevant fields and values in JSON.
2630
2673
  *
2631
- * @returns Reference to this in order to allow method chaining.
2674
+ * @returns Returns `this` to allow method chaining.
2632
2675
  */
2633
2676
  registerFetchData(
2634
2677
  /**
2635
2678
  * Called when a variant must be fetched
2636
2679
  */
2637
- fCallBack: Function
2680
+ fCallBack: (p1: string) => void
2638
2681
  ): this;
2639
2682
  /**
2640
2683
  * @SINCE 1.26.1
@@ -2648,7 +2691,7 @@ declare namespace sap {
2648
2691
  /**
2649
2692
  * Called when a variant must be applied
2650
2693
  */
2651
- fCallBack: Function
2694
+ fCallBack: /* was: sap.ui.comp.filterbar.FilterBar.fGetFiltersWithValuesCallBack */ any
2652
2695
  ): this;
2653
2696
  /**
2654
2697
  * Removes all entries in the aggregation filterGroupItems.
@@ -2696,11 +2739,14 @@ declare namespace sap {
2696
2739
  vFilterItem: int | string | sap.ui.comp.filterbar.FilterItem
2697
2740
  ): sap.ui.comp.filterbar.FilterItem | null;
2698
2741
  /**
2742
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2743
+ *
2699
2744
  * Adapts the visibility for all filter containers.
2700
2745
  */
2701
2746
  rerenderFilters(): void;
2702
2747
  /**
2703
2748
  * @SINCE 1.40.4
2749
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2704
2750
  *
2705
2751
  * Restores the visibility of the Go button on FilterBar. The visibility of the Go button will be set, according
2706
2752
  * to the showGoOnFB property.
@@ -2906,25 +2952,6 @@ declare namespace sap {
2906
2952
  */
2907
2953
  bFilterBarExpanded?: boolean
2908
2954
  ): this;
2909
- /**
2910
- * @SINCE 1.34.0
2911
- *
2912
- * Sets a new value for property {@link #getFilterContainerWidth filterContainerWidth}.
2913
- *
2914
- * Sets the width of the filters container.
2915
- *
2916
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2917
- *
2918
- * Default value is `"12rem"`.
2919
- *
2920
- * @returns Reference to `this` in order to allow method chaining
2921
- */
2922
- setFilterContainerWidth(
2923
- /**
2924
- * New value for property `filterContainerWidth`
2925
- */
2926
- sFilterContainerWidth?: string
2927
- ): this;
2928
2955
  /**
2929
2956
  * @SINCE 1.38.0
2930
2957
  *
@@ -3019,25 +3046,6 @@ declare namespace sap {
3019
3046
  */
3020
3047
  bShowClearButton?: boolean
3021
3048
  ): this;
3022
- /**
3023
- * @SINCE 1.28.0
3024
- *
3025
- * Sets a new value for property {@link #getShowClearOnFB showClearOnFB}.
3026
- *
3027
- * Handles visibility of the Clear button on the FilterBar.
3028
- *
3029
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3030
- *
3031
- * Default value is `false`.
3032
- *
3033
- * @returns Reference to `this` in order to allow method chaining
3034
- */
3035
- setShowClearOnFB(
3036
- /**
3037
- * New value for property `showClearOnFB`
3038
- */
3039
- bShowClearOnFB?: boolean
3040
- ): this;
3041
3049
  /**
3042
3050
  * @SINCE 1.38.0
3043
3051
  *
@@ -3057,45 +3065,9 @@ declare namespace sap {
3057
3065
  */
3058
3066
  bShowFilterConfiguration?: boolean
3059
3067
  ): this;
3060
- /**
3061
- * @SINCE 1.26.1
3062
- * @deprecated (since 1.28.0) - Replaced by property `showGoOnFB`
3063
- *
3064
- * Sets a new value for property {@link #getShowGoButton showGoButton}.
3065
- *
3066
- * Handles visibility of the Go button on the FilterBar.
3067
- *
3068
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3069
- *
3070
- * @returns Reference to `this` in order to allow method chaining
3071
- */
3072
- setShowGoButton(
3073
- /**
3074
- * New value for property `showGoButton`
3075
- */
3076
- bShowGoButton?: boolean
3077
- ): this;
3078
- /**
3079
- * @SINCE 1.28.0
3080
- *
3081
- * Sets a new value for property {@link #getShowGoOnFB showGoOnFB}.
3082
- *
3083
- * Handles visibility of the Go button on the FilterBar.
3084
- *
3085
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3086
- *
3087
- * Default value is `true`.
3088
- *
3089
- * @returns Reference to `this` in order to allow method chaining
3090
- */
3091
- setShowGoOnFB(
3092
- /**
3093
- * New value for property `showGoOnFB`
3094
- */
3095
- bShowGoOnFB?: boolean
3096
- ): this;
3097
3068
  /**
3098
3069
  * @deprecated (since 1.84)
3070
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
3099
3071
  *
3100
3072
  * Once set, the activation of the 'Adapt Filters' button will open the 'old' filters dialog. This method
3101
3073
  * offers an intermediate solution for the visual filters scenario, which relies on the old filters dialog.
@@ -3123,25 +3095,6 @@ declare namespace sap {
3123
3095
  */
3124
3096
  bShowRestoreButton?: boolean
3125
3097
  ): this;
3126
- /**
3127
- * @SINCE 1.28.0
3128
- *
3129
- * Sets a new value for property {@link #getShowRestoreOnFB showRestoreOnFB}.
3130
- *
3131
- * Handles visibility of the Restore button on the FilterBar.
3132
- *
3133
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3134
- *
3135
- * Default value is `false`.
3136
- *
3137
- * @returns Reference to `this` in order to allow method chaining
3138
- */
3139
- setShowRestoreOnFB(
3140
- /**
3141
- * New value for property `showRestoreOnFB`
3142
- */
3143
- bShowRestoreOnFB?: boolean
3144
- ): this;
3145
3098
  /**
3146
3099
  * @SINCE 1.48
3147
3100
  *
@@ -3236,6 +3189,8 @@ declare namespace sap {
3236
3189
  */
3237
3190
  showFilterDialog(): void;
3238
3191
  /**
3192
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
3193
+ *
3239
3194
  * This method will be called by the SmartVariantMangement and indicates, that the standard variant was
3240
3195
  * obtained. It indicates, that the variant management is fully initialized.
3241
3196
  */
@@ -3498,6 +3453,8 @@ declare namespace sap {
3498
3453
  oListener?: object
3499
3454
  ): this;
3500
3455
  /**
3456
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
3457
+ *
3501
3458
  * Fires event {@link #event:change change} to attached listeners.
3502
3459
  *
3503
3460
  * @returns Reference to `this` in order to allow method chaining
@@ -5161,6 +5118,7 @@ declare namespace sap {
5161
5118
  ): this;
5162
5119
  /**
5163
5120
  * @SINCE 1.44.0
5121
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
5164
5122
  *
5165
5123
  * Fires event {@link #event:availableActionsPersonalizationPress availableActionsPersonalizationPress}
5166
5124
  * to attached listeners.
@@ -5175,6 +5133,7 @@ declare namespace sap {
5175
5133
  ): this;
5176
5134
  /**
5177
5135
  * @SINCE 1.28.0
5136
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
5178
5137
  *
5179
5138
  * Fires event {@link #event:navigate navigate} to attached listeners.
5180
5139
  *
@@ -5201,6 +5160,7 @@ declare namespace sap {
5201
5160
  * is no longer done by NavigationPopover. Instead the NavigationPopoverHandler is responsible for target
5202
5161
  * determination. The event `navigationTargetsObtained` is fired from NavigationPopoverHandler after navigation
5203
5162
  * targets are determined.
5163
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
5204
5164
  *
5205
5165
  * Fires event {@link #event:targetsObtained targetsObtained} to attached listeners.
5206
5166
  *
@@ -5858,6 +5818,7 @@ declare namespace sap {
5858
5818
  ): this;
5859
5819
  /**
5860
5820
  * @SINCE 1.36.0
5821
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
5861
5822
  *
5862
5823
  * Fires event {@link #event:beforePopoverOpens beforePopoverOpens} to attached listeners.
5863
5824
  *
@@ -5910,6 +5871,7 @@ declare namespace sap {
5910
5871
  ): this;
5911
5872
  /**
5912
5873
  * @SINCE 1.36.0
5874
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
5913
5875
  *
5914
5876
  * Fires event {@link #event:innerNavigate innerNavigate} to attached listeners.
5915
5877
  *
@@ -5944,6 +5906,7 @@ declare namespace sap {
5944
5906
  ): this;
5945
5907
  /**
5946
5908
  * @SINCE 1.36.0
5909
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
5947
5910
  *
5948
5911
  * Fires event {@link #event:navigationTargetsObtained navigationTargetsObtained} to attached listeners.
5949
5912
  *
@@ -6717,6 +6680,7 @@ declare namespace sap {
6717
6680
  ): this;
6718
6681
  /**
6719
6682
  * @SINCE 1.28.0
6683
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
6720
6684
  *
6721
6685
  * Fires event {@link #event:beforePopoverOpens beforePopoverOpens} to attached listeners.
6722
6686
  *
@@ -6772,6 +6736,7 @@ declare namespace sap {
6772
6736
  ): this;
6773
6737
  /**
6774
6738
  * @SINCE 1.28.0
6739
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
6775
6740
  *
6776
6741
  * Fires event {@link #event:navigate navigate} to attached listeners.
6777
6742
  *
@@ -6809,6 +6774,7 @@ declare namespace sap {
6809
6774
  ): this;
6810
6775
  /**
6811
6776
  * @SINCE 1.28.0
6777
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
6812
6778
  *
6813
6779
  * Fires event {@link #event:navigationTargetsObtained navigationTargetsObtained} to attached listeners.
6814
6780
  *
@@ -6885,6 +6851,7 @@ declare namespace sap {
6885
6851
  * @SINCE 1.28.0
6886
6852
  * @deprecated (since 1.42.0) - The event `prefetchDone` is obsolete because it depends on the property
6887
6853
  * `prefetchNavigationTargets` which has been deprecated.
6854
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
6888
6855
  *
6889
6856
  * Fires event {@link #event:prefetchDone prefetchDone} to attached listeners.
6890
6857
  *
@@ -7609,6 +7576,7 @@ declare namespace sap {
7609
7576
  ): this;
7610
7577
  /**
7611
7578
  * @SINCE 1.28.0
7579
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
7612
7580
  *
7613
7581
  * Fires event {@link #event:beforePopoverOpens beforePopoverOpens} to attached listeners.
7614
7582
  *
@@ -7661,6 +7629,7 @@ declare namespace sap {
7661
7629
  ): this;
7662
7630
  /**
7663
7631
  * @SINCE 1.28.0
7632
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
7664
7633
  *
7665
7634
  * Fires event {@link #event:innerNavigate innerNavigate} to attached listeners.
7666
7635
  *
@@ -7695,6 +7664,7 @@ declare namespace sap {
7695
7664
  ): this;
7696
7665
  /**
7697
7666
  * @SINCE 1.28.0
7667
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
7698
7668
  *
7699
7669
  * Fires event {@link #event:navigationTargetsObtained navigationTargetsObtained} to attached listeners.
7700
7670
  *
@@ -8229,6 +8199,8 @@ declare namespace sap {
8229
8199
  }
8230
8200
 
8231
8201
  /**
8202
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
8203
+ *
8232
8204
  * Extends the functionalities in sap.m.ComboBox
8233
8205
  */
8234
8206
  class ComboBox
@@ -8236,6 +8208,8 @@ declare namespace sap {
8236
8208
  implements /* was: sap.ui.comp.IDropDownTextArrangement */ Object {
8237
8209
  __implements__sap_ui_comp_IDropDownTextArrangement: boolean;
8238
8210
  /**
8211
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
8212
+ *
8239
8213
  * Constructor for a new `odata/ComboBox`.
8240
8214
  *
8241
8215
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
@@ -8249,6 +8223,8 @@ declare namespace sap {
8249
8223
  mSettings?: sap.ui.comp.odata.$ComboBoxSettings
8250
8224
  );
8251
8225
  /**
8226
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
8227
+ *
8252
8228
  * Constructor for a new `odata/ComboBox`.
8253
8229
  *
8254
8230
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
@@ -8267,6 +8243,8 @@ declare namespace sap {
8267
8243
  );
8268
8244
 
8269
8245
  /**
8246
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
8247
+ *
8270
8248
  * Creates a new subclass of class sap.ui.comp.odata.ComboBox with name `sClassName` and enriches it with
8271
8249
  * the information contained in `oClassInfo`.
8272
8250
  *
@@ -8290,12 +8268,16 @@ declare namespace sap {
8290
8268
  FNMetaImpl?: Function
8291
8269
  ): Function;
8292
8270
  /**
8271
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
8272
+ *
8293
8273
  * Returns a metadata object for class sap.ui.comp.odata.ComboBox.
8294
8274
  *
8295
8275
  * @returns Metadata object describing this class
8296
8276
  */
8297
8277
  static getMetadata(): sap.ui.core.ElementMetadata;
8298
8278
  /**
8279
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
8280
+ *
8299
8281
  * Gets current value of property {@link #getTextArrangement textArrangement}.
8300
8282
  *
8301
8283
  * Sets the `value` property formatting according to the `com.sap.vocabularies.UI.v1.TextArrangementType`
@@ -8307,6 +8289,8 @@ declare namespace sap {
8307
8289
  */
8308
8290
  getTextArrangement(): string;
8309
8291
  /**
8292
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
8293
+ *
8310
8294
  * Sets a new value for property {@link #getTextArrangement textArrangement}.
8311
8295
  *
8312
8296
  * Sets the `value` property formatting according to the `com.sap.vocabularies.UI.v1.TextArrangementType`
@@ -9856,10 +9840,14 @@ declare namespace sap {
9856
9840
  oListener?: object
9857
9841
  ): this;
9858
9842
  /**
9843
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
9844
+ *
9859
9845
  * Cleans up the control.
9860
9846
  */
9861
9847
  exit(): void;
9862
9848
  /**
9849
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
9850
+ *
9863
9851
  * Function for the {@link sap.ui.comp.smartvariants.SmartVariantManagement} control that returns the currently
9864
9852
  * used variant data in an internal format. **Note:** This function must not be used by applications.
9865
9853
  *
@@ -9867,6 +9855,8 @@ declare namespace sap {
9867
9855
  */
9868
9856
  fetchVariant(): sap.ui.comp.SmartChart.Variant;
9869
9857
  /**
9858
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
9859
+ *
9870
9860
  * Fires event {@link #event:afterVariantApply afterVariantApply} to attached listeners.
9871
9861
  *
9872
9862
  * @returns Reference to `this` in order to allow method chaining
@@ -9883,6 +9873,8 @@ declare namespace sap {
9883
9873
  }
9884
9874
  ): this;
9885
9875
  /**
9876
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
9877
+ *
9886
9878
  * Fires event {@link #event:afterVariantInitialise afterVariantInitialise} to attached listeners.
9887
9879
  *
9888
9880
  * @returns Reference to `this` in order to allow method chaining
@@ -9894,6 +9886,8 @@ declare namespace sap {
9894
9886
  mParameters?: object
9895
9887
  ): this;
9896
9888
  /**
9889
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
9890
+ *
9897
9891
  * Fires event {@link #event:afterVariantSave afterVariantSave} to attached listeners.
9898
9892
  *
9899
9893
  * @returns Reference to `this` in order to allow method chaining
@@ -9910,6 +9904,8 @@ declare namespace sap {
9910
9904
  }
9911
9905
  ): this;
9912
9906
  /**
9907
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
9908
+ *
9913
9909
  * Fires event {@link #event:beforeRebindChart beforeRebindChart} to attached listeners.
9914
9910
  *
9915
9911
  * @returns Reference to `this` in order to allow method chaining
@@ -9921,6 +9917,8 @@ declare namespace sap {
9921
9917
  mParameters?: object
9922
9918
  ): this;
9923
9919
  /**
9920
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
9921
+ *
9924
9922
  * Fires event {@link #event:chartDataChanged chartDataChanged} to attached listeners.
9925
9923
  *
9926
9924
  * @returns Reference to `this` in order to allow method chaining
@@ -9938,6 +9936,7 @@ declare namespace sap {
9938
9936
  ): this;
9939
9937
  /**
9940
9938
  * @deprecated (since 1.56) - Use `beforeRebindChart` event to attach/listen to the binding "events" directly
9939
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
9941
9940
  *
9942
9941
  * Fires event {@link #event:dataReceived dataReceived} to attached listeners.
9943
9942
  *
@@ -9951,6 +9950,7 @@ declare namespace sap {
9951
9950
  ): this;
9952
9951
  /**
9953
9952
  * @SINCE 1.46
9953
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
9954
9954
  *
9955
9955
  * Fires event {@link #event:fullScreenToggled fullScreenToggled} to attached listeners.
9956
9956
  *
@@ -9969,6 +9969,7 @@ declare namespace sap {
9969
9969
  ): this;
9970
9970
  /**
9971
9971
  * @deprecated (since 1.65)
9972
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
9972
9973
  *
9973
9974
  * Fires event {@link #event:initialise initialise} to attached listeners.
9974
9975
  *
@@ -9981,6 +9982,8 @@ declare namespace sap {
9981
9982
  mParameters?: object
9982
9983
  ): this;
9983
9984
  /**
9985
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
9986
+ *
9984
9987
  * Fires event {@link #event:initialized initialized} to attached listeners.
9985
9988
  *
9986
9989
  * @returns Reference to `this` in order to allow method chaining
@@ -9994,6 +9997,7 @@ declare namespace sap {
9994
9997
  /**
9995
9998
  * @SINCE 1.48
9996
9999
  * @EXPERIMENTAL (since 1.48)
10000
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
9997
10001
  *
9998
10002
  * Fires event {@link #event:selectionDetailsActionPress selectionDetailsActionPress} to attached listeners.
9999
10003
  *
@@ -10022,6 +10026,8 @@ declare namespace sap {
10022
10026
  }
10023
10027
  ): this;
10024
10028
  /**
10029
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
10030
+ *
10025
10031
  * Fires event {@link #event:showOverlay showOverlay} to attached listeners.
10026
10032
  *
10027
10033
  * @returns Reference to `this` in order to allow method chaining
@@ -10034,6 +10040,7 @@ declare namespace sap {
10034
10040
  ): this;
10035
10041
  /**
10036
10042
  * @SINCE 1.96.15
10043
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
10037
10044
  *
10038
10045
  * Fires event {@link #event:uiStateChange uiStateChange} to attached listeners.
10039
10046
  *
@@ -10631,12 +10638,16 @@ declare namespace sap {
10631
10638
  iIndex: int
10632
10639
  ): this;
10633
10640
  /**
10641
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
10642
+ *
10634
10643
  * Checks whether the control is initialized.
10635
10644
  *
10636
10645
  * @returns returns whether the control is already initialized
10637
10646
  */
10638
10647
  isInitialised(): boolean;
10639
10648
  /**
10649
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
10650
+ *
10640
10651
  * This can be used to trigger binding on the chart used in the SmartChart
10641
10652
  */
10642
10653
  rebindChart(): void;
@@ -11247,12 +11258,27 @@ declare namespace sap {
11247
11258
 
11248
11259
  namespace smartfield {
11249
11260
  interface $ComboBoxSettings extends sap.m.$ComboBoxSettings {
11261
+ /**
11262
+ * Key of the selected item.
11263
+ *
11264
+ * **Note:** If duplicate keys exist, the first item matching the key is used.
11265
+ */
11266
+ selectedKey?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
11267
+
11250
11268
  enteredValue?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
11251
11269
 
11252
11270
  /**
11253
11271
  * Property works the same as sap.m.Input control `value`
11254
11272
  */
11255
11273
  realValue?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
11274
+
11275
+ /**
11276
+ * Sets the `value` property formatting according to the `com.sap.vocabularies.UI.v1.TextArrangementType`
11277
+ * from the ValueList property.
11278
+ */
11279
+ valueTextArrangement?:
11280
+ | string
11281
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
11256
11282
  }
11257
11283
 
11258
11284
  interface $ConfigurationSettings extends sap.ui.core.$ElementSettings {
@@ -11918,8 +11944,6 @@ declare namespace sap {
11918
11944
  *
11919
11945
  * If the value of the text input field is subject to data type constraints, the constraints must be fulfilled,
11920
11946
  * which implies the value is stored in the binding/model before the event is fired.
11921
- *
11922
- * **Note:** The changeModelValue event is currently experimental and might be redefined.
11923
11947
  */
11924
11948
  changeModelValue?: (oEvent: sap.ui.base.Event) => void;
11925
11949
 
@@ -11936,14 +11960,14 @@ declare namespace sap {
11936
11960
  /**
11937
11961
  * @SINCE 1.30.0
11938
11962
  *
11939
- * The event is fired after the value of editable property of the control has changed.
11963
+ * Fired when the control is rendered if the value of `editable` property of the control has changed.
11940
11964
  */
11941
11965
  editableChanged?: (oEvent: sap.ui.base.Event) => void;
11942
11966
 
11943
11967
  /**
11944
11968
  * @SINCE 1.32.0
11945
11969
  *
11946
- * The event is fired after the context editable property of the control has changed.
11970
+ * Fired when the control is rendered if the value of `contextEditable` property of the control has changed.
11947
11971
  */
11948
11972
  contextEditableChanged?: (oEvent: sap.ui.base.Event) => void;
11949
11973
 
@@ -11970,10 +11994,14 @@ declare namespace sap {
11970
11994
  }
11971
11995
 
11972
11996
  /**
11997
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
11998
+ *
11973
11999
  * Extends the functionalities in sap.m.ComboBox
11974
12000
  */
11975
12001
  class ComboBox extends sap.m.ComboBox {
11976
12002
  /**
12003
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
12004
+ *
11977
12005
  * Constructor for a new `SmartField/ComboBox`.
11978
12006
  *
11979
12007
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
@@ -11987,6 +12015,8 @@ declare namespace sap {
11987
12015
  mSettings?: sap.ui.comp.smartfield.$ComboBoxSettings
11988
12016
  );
11989
12017
  /**
12018
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
12019
+ *
11990
12020
  * Constructor for a new `SmartField/ComboBox`.
11991
12021
  *
11992
12022
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
@@ -12005,6 +12035,8 @@ declare namespace sap {
12005
12035
  );
12006
12036
 
12007
12037
  /**
12038
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
12039
+ *
12008
12040
  * Creates a new subclass of class sap.ui.comp.smartfield.ComboBox with name `sClassName` and enriches it
12009
12041
  * with the information contained in `oClassInfo`.
12010
12042
  *
@@ -12028,36 +12060,63 @@ declare namespace sap {
12028
12060
  FNMetaImpl?: Function
12029
12061
  ): Function;
12030
12062
  /**
12063
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
12064
+ *
12031
12065
  * Returns a metadata object for class sap.ui.comp.smartfield.ComboBox.
12032
12066
  *
12033
12067
  * @returns Metadata object describing this class
12034
12068
  */
12035
12069
  static getMetadata(): sap.ui.core.ElementMetadata;
12036
12070
  /**
12037
- * Gets current value of property {@link #getEnteredValue enteredValue}.
12071
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
12038
12072
  *
12039
- * Default value is `empty string`.
12073
+ * Gets current value of property {@link #getEnteredValue enteredValue}.
12040
12074
  *
12041
12075
  * @returns Value of property `enteredValue`
12042
12076
  */
12043
12077
  getEnteredValue(): string;
12044
12078
  /**
12079
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
12080
+ *
12045
12081
  * Gets current value of property {@link #getRealValue realValue}.
12046
12082
  *
12047
12083
  * Property works the same as sap.m.Input control `value`
12048
12084
  *
12049
- * Default value is `empty string`.
12050
- *
12051
12085
  * @returns Value of property `realValue`
12052
12086
  */
12053
12087
  getRealValue(): string;
12054
12088
  /**
12055
- * Sets a new value for property {@link #getEnteredValue enteredValue}.
12089
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
12056
12090
  *
12057
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
12091
+ * Gets current value of property {@link #getSelectedKey selectedKey}.
12092
+ *
12093
+ * Key of the selected item.
12094
+ *
12095
+ * **Note:** If duplicate keys exist, the first item matching the key is used.
12096
+ *
12097
+ * @returns Value of property `selectedKey`
12098
+ */
12099
+ getSelectedKey(): string;
12100
+ /**
12101
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
12102
+ *
12103
+ * Gets current value of property {@link #getValueTextArrangement valueTextArrangement}.
12104
+ *
12105
+ * Sets the `value` property formatting according to the `com.sap.vocabularies.UI.v1.TextArrangementType`
12106
+ * from the ValueList property.
12058
12107
  *
12059
12108
  * Default value is `empty string`.
12060
12109
  *
12110
+ * @returns Value of property `valueTextArrangement`
12111
+ */
12112
+ getValueTextArrangement(): string;
12113
+ /**
12114
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
12115
+ *
12116
+ * Sets a new value for property {@link #getEnteredValue enteredValue}.
12117
+ *
12118
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
12119
+ *
12061
12120
  * @returns Reference to `this` in order to allow method chaining
12062
12121
  */
12063
12122
  setEnteredValue(
@@ -12067,14 +12126,14 @@ declare namespace sap {
12067
12126
  sEnteredValue?: string
12068
12127
  ): this;
12069
12128
  /**
12129
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
12130
+ *
12070
12131
  * Sets a new value for property {@link #getRealValue realValue}.
12071
12132
  *
12072
12133
  * Property works the same as sap.m.Input control `value`
12073
12134
  *
12074
12135
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
12075
12136
  *
12076
- * Default value is `empty string`.
12077
- *
12078
12137
  * @returns Reference to `this` in order to allow method chaining
12079
12138
  */
12080
12139
  setRealValue(
@@ -12083,6 +12142,45 @@ declare namespace sap {
12083
12142
  */
12084
12143
  sRealValue?: string
12085
12144
  ): this;
12145
+ /**
12146
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
12147
+ *
12148
+ * Sets a new value for property {@link #getSelectedKey selectedKey}.
12149
+ *
12150
+ * Key of the selected item.
12151
+ *
12152
+ * **Note:** If duplicate keys exist, the first item matching the key is used.
12153
+ *
12154
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
12155
+ *
12156
+ * @returns Reference to `this` in order to allow method chaining
12157
+ */
12158
+ setSelectedKey(
12159
+ /**
12160
+ * New value for property `selectedKey`
12161
+ */
12162
+ sSelectedKey?: string
12163
+ ): this;
12164
+ /**
12165
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
12166
+ *
12167
+ * Sets a new value for property {@link #getValueTextArrangement valueTextArrangement}.
12168
+ *
12169
+ * Sets the `value` property formatting according to the `com.sap.vocabularies.UI.v1.TextArrangementType`
12170
+ * from the ValueList property.
12171
+ *
12172
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
12173
+ *
12174
+ * Default value is `empty string`.
12175
+ *
12176
+ * @returns Reference to `this` in order to allow method chaining
12177
+ */
12178
+ setValueTextArrangement(
12179
+ /**
12180
+ * New value for property `valueTextArrangement`
12181
+ */
12182
+ sValueTextArrangement?: string
12183
+ ): this;
12086
12184
  }
12087
12185
  /**
12088
12186
  * The configuration allows to further define the behavior of a `SmartField`.
@@ -12617,7 +12715,7 @@ declare namespace sap {
12617
12715
  * If set to `true`, no properties are returned
12618
12716
  */
12619
12717
  bNavigationPathsOnly: boolean
12620
- ): any[];
12718
+ ): Record<string, string[]>;
12621
12719
  /**
12622
12720
  * @SINCE 1.96
12623
12721
  *
@@ -12716,8 +12814,6 @@ declare namespace sap {
12716
12814
  * If the value of the text input field is subject to data type constraints, the constraints must be fulfilled,
12717
12815
  * which implies the value is stored in the binding/model before the event is fired.
12718
12816
  *
12719
- * **Note:** The changeModelValue event is currently experimental and might be redefined.
12720
- *
12721
12817
  * @returns Reference to `this` in order to allow method chaining
12722
12818
  */
12723
12819
  attachChangeModelValue(
@@ -12754,8 +12850,6 @@ declare namespace sap {
12754
12850
  * If the value of the text input field is subject to data type constraints, the constraints must be fulfilled,
12755
12851
  * which implies the value is stored in the binding/model before the event is fired.
12756
12852
  *
12757
- * **Note:** The changeModelValue event is currently experimental and might be redefined.
12758
- *
12759
12853
  * @returns Reference to `this` in order to allow method chaining
12760
12854
  */
12761
12855
  attachChangeModelValue(
@@ -12777,7 +12871,7 @@ declare namespace sap {
12777
12871
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
12778
12872
  * otherwise it will be bound to this `sap.ui.comp.smartfield.SmartField` itself.
12779
12873
  *
12780
- * The event is fired after the context editable property of the control has changed.
12874
+ * Fired when the control is rendered if the value of `contextEditable` property of the control has changed.
12781
12875
  *
12782
12876
  * @returns Reference to `this` in order to allow method chaining
12783
12877
  */
@@ -12805,7 +12899,7 @@ declare namespace sap {
12805
12899
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
12806
12900
  * otherwise it will be bound to this `sap.ui.comp.smartfield.SmartField` itself.
12807
12901
  *
12808
- * The event is fired after the context editable property of the control has changed.
12902
+ * Fired when the control is rendered if the value of `contextEditable` property of the control has changed.
12809
12903
  *
12810
12904
  * @returns Reference to `this` in order to allow method chaining
12811
12905
  */
@@ -12828,7 +12922,7 @@ declare namespace sap {
12828
12922
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
12829
12923
  * otherwise it will be bound to this `sap.ui.comp.smartfield.SmartField` itself.
12830
12924
  *
12831
- * The event is fired after the value of editable property of the control has changed.
12925
+ * Fired when the control is rendered if the value of `editable` property of the control has changed.
12832
12926
  *
12833
12927
  * @returns Reference to `this` in order to allow method chaining
12834
12928
  */
@@ -12856,7 +12950,7 @@ declare namespace sap {
12856
12950
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
12857
12951
  * otherwise it will be bound to this `sap.ui.comp.smartfield.SmartField` itself.
12858
12952
  *
12859
- * The event is fired after the value of editable property of the control has changed.
12953
+ * Fired when the control is rendered if the value of `editable` property of the control has changed.
12860
12954
  *
12861
12955
  * @returns Reference to `this` in order to allow method chaining
12862
12956
  */
@@ -13205,6 +13299,7 @@ declare namespace sap {
13205
13299
  ): boolean;
13206
13300
  /**
13207
13301
  * @SINCE 1.90
13302
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
13208
13303
  *
13209
13304
  * Checks the validity of the values for the given control.
13210
13305
  *
@@ -13214,7 +13309,7 @@ declare namespace sap {
13214
13309
  /**
13215
13310
  * Additional settings
13216
13311
  */
13217
- oSettings?: object
13312
+ oSettings?: Object
13218
13313
  ): boolean;
13219
13314
  /**
13220
13315
  * @SINCE 1.64
@@ -13480,6 +13575,8 @@ declare namespace sap {
13480
13575
  oListener?: object
13481
13576
  ): this;
13482
13577
  /**
13578
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
13579
+ *
13483
13580
  * Fires event {@link #event:change change} to attached listeners.
13484
13581
  *
13485
13582
  * @returns Reference to `this` in order to allow method chaining
@@ -13504,6 +13601,8 @@ declare namespace sap {
13504
13601
  }
13505
13602
  ): this;
13506
13603
  /**
13604
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
13605
+ *
13507
13606
  * Fires event {@link #event:changeModelValue changeModelValue} to attached listeners.
13508
13607
  *
13509
13608
  * @returns Reference to `this` in order to allow method chaining
@@ -13533,6 +13632,7 @@ declare namespace sap {
13533
13632
  ): this;
13534
13633
  /**
13535
13634
  * @SINCE 1.32.0
13635
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
13536
13636
  *
13537
13637
  * Fires event {@link #event:contextEditableChanged contextEditableChanged} to attached listeners.
13538
13638
  *
@@ -13551,6 +13651,7 @@ declare namespace sap {
13551
13651
  ): this;
13552
13652
  /**
13553
13653
  * @SINCE 1.30.0
13654
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
13554
13655
  *
13555
13656
  * Fires event {@link #event:editableChanged editableChanged} to attached listeners.
13556
13657
  *
@@ -13568,6 +13669,8 @@ declare namespace sap {
13568
13669
  }
13569
13670
  ): this;
13570
13671
  /**
13672
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
13673
+ *
13571
13674
  * Fires event {@link #event:entitySetFound entitySetFound} to attached listeners.
13572
13675
  *
13573
13676
  * @returns Reference to `this` in order to allow method chaining
@@ -13584,6 +13687,8 @@ declare namespace sap {
13584
13687
  }
13585
13688
  ): this;
13586
13689
  /**
13690
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
13691
+ *
13587
13692
  * Fires event {@link #event:initialise initialise} to attached listeners.
13588
13693
  *
13589
13694
  * @returns Reference to `this` in order to allow method chaining
@@ -13595,6 +13700,8 @@ declare namespace sap {
13595
13700
  mParameters?: object
13596
13701
  ): this;
13597
13702
  /**
13703
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
13704
+ *
13598
13705
  * Fires event {@link #event:innerControlsCreated innerControlsCreated} to attached listeners.
13599
13706
  *
13600
13707
  * @returns Reference to `this` in order to allow method chaining
@@ -13607,6 +13714,7 @@ declare namespace sap {
13607
13714
  ): this;
13608
13715
  /**
13609
13716
  * @SINCE 1.36.0
13717
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
13610
13718
  *
13611
13719
  * Fires event {@link #event:press press} to attached listeners.
13612
13720
  *
@@ -13620,6 +13728,7 @@ declare namespace sap {
13620
13728
  ): this;
13621
13729
  /**
13622
13730
  * @SINCE 1.31.0
13731
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
13623
13732
  *
13624
13733
  * Fires event {@link #event:valueListChanged valueListChanged} to attached listeners.
13625
13734
  *
@@ -13637,6 +13746,8 @@ declare namespace sap {
13637
13746
  }
13638
13747
  ): this;
13639
13748
  /**
13749
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
13750
+ *
13640
13751
  * Fires event {@link #event:visibleChanged visibleChanged} to attached listeners.
13641
13752
  *
13642
13753
  * @returns Reference to `this` in order to allow method chaining
@@ -13740,7 +13851,7 @@ declare namespace sap {
13740
13851
  *
13741
13852
  * @returns The OData property.
13742
13853
  */
13743
- getDataProperty(): object;
13854
+ getDataProperty(): Record<string, string> | null;
13744
13855
  /**
13745
13856
  * Returns the EDM data type of the OData property to which the value property of the control is bound.
13746
13857
  * If no model or no OData property is available `null` is returned.
@@ -13884,7 +13995,7 @@ declare namespace sap {
13884
13995
  *
13885
13996
  * @returns Formatted value or a `Promise` returning the formatted value if resolved
13886
13997
  */
13887
- getFormFormattedValue(): string | Promise<any>;
13998
+ getFormFormattedValue(): Promise<string>;
13888
13999
  /**
13889
14000
  * @SINCE 1.88
13890
14001
  *
@@ -13926,6 +14037,8 @@ declare namespace sap {
13926
14037
  */
13927
14038
  getImportance(): sap.ui.comp.smartfield.Importance;
13928
14039
  /**
14040
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
14041
+ *
13929
14042
  * Resolves the controls hosted currently by this `SmartField` control.
13930
14043
  *
13931
14044
  * @returns The controls hosted currently by this `SmartField`
@@ -13990,6 +14103,8 @@ declare namespace sap {
13990
14103
  */
13991
14104
  getMaxLength(): int;
13992
14105
  /**
14106
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
14107
+ *
13993
14108
  * Returns the current SmartField's edit mode
13994
14109
  *
13995
14110
  * @returns Returns "edit" or "display"
@@ -14030,6 +14145,7 @@ declare namespace sap {
14030
14145
  getProposedControl(): sap.ui.comp.smartfield.ControlProposalType;
14031
14146
  /**
14032
14147
  * @SINCE 1.48.0
14148
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
14033
14149
  *
14034
14150
  * Gets the value of the `mandatory` property.
14035
14151
  *
@@ -15500,7 +15616,7 @@ declare namespace sap {
15500
15616
  /**
15501
15617
  * The Edm name of the property the control is bound to.
15502
15618
  */
15503
- property: string | undefined;
15619
+ property: string;
15504
15620
  /**
15505
15621
  * The instance of the control on which the checkValuesValidity method was called
15506
15622
  */
@@ -15509,6 +15625,31 @@ declare namespace sap {
15509
15625
  }
15510
15626
 
15511
15627
  namespace smartfilterbar {
15628
+ namespace SmartFilterBar {
15629
+ type DateRangeTypeByKeyResponse = {
15630
+ defaultValue: string;
15631
+
15632
+ type: string;
15633
+
15634
+ group: string;
15635
+ };
15636
+
15637
+ type SearchAllowed = {
15638
+ /**
15639
+ * Mandatory - Indicates that some mandatory filters or parameters are empty
15640
+ */
15641
+ mandatory?: undefined | boolean;
15642
+ /**
15643
+ * Pending - Indicates that a token validation is going on
15644
+ */
15645
+ pending?: undefined | boolean;
15646
+ /**
15647
+ * Error - Indicates that some filters or parameters are in error state
15648
+ */
15649
+ error?: undefined | boolean;
15650
+ };
15651
+ }
15652
+
15512
15653
  interface $ControlConfigurationSettings
15513
15654
  extends sap.ui.core.$ElementSettings {
15514
15655
  /**
@@ -15575,7 +15716,7 @@ declare namespace sap {
15575
15716
 
15576
15717
  /**
15577
15718
  * Property can be used to enable the TypeAhead service. TypeAhead does not work with all controls, e.g
15578
- * it does not work for DrodDownListbox
15719
+ * it does not work for DropDownListbox
15579
15720
  */
15580
15721
  hasTypeAhead?:
15581
15722
  | boolean
@@ -16145,6 +16286,8 @@ declare namespace sap {
16145
16286
  oListener?: object
16146
16287
  ): this;
16147
16288
  /**
16289
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
16290
+ *
16148
16291
  * Fires event {@link #event:change change} to attached listeners.
16149
16292
  *
16150
16293
  * @returns Reference to `this` in order to allow method chaining
@@ -16271,7 +16414,7 @@ declare namespace sap {
16271
16414
  * Gets current value of property {@link #getHasTypeAhead hasTypeAhead}.
16272
16415
  *
16273
16416
  * Property can be used to enable the TypeAhead service. TypeAhead does not work with all controls, e.g
16274
- * it does not work for DrodDownListbox
16417
+ * it does not work for DropDownListbox
16275
16418
  *
16276
16419
  * Default value is `true`.
16277
16420
  *
@@ -16593,7 +16736,7 @@ declare namespace sap {
16593
16736
  * Sets a new value for property {@link #getHasTypeAhead hasTypeAhead}.
16594
16737
  *
16595
16738
  * Property can be used to enable the TypeAhead service. TypeAhead does not work with all controls, e.g
16596
- * it does not work for DrodDownListbox
16739
+ * it does not work for DropDownListbox
16597
16740
  *
16598
16741
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
16599
16742
  *
@@ -16937,6 +17080,8 @@ declare namespace sap {
16937
17080
  oListener?: object
16938
17081
  ): this;
16939
17082
  /**
17083
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
17084
+ *
16940
17085
  * Fires event {@link #event:change change} to attached listeners.
16941
17086
  *
16942
17087
  * @returns Reference to `this` in order to allow method chaining
@@ -17203,6 +17348,8 @@ declare namespace sap {
17203
17348
  ): this;
17204
17349
  }
17205
17350
  /**
17351
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
17352
+ *
17206
17353
  * Extends the functionalities in sap.m.MultiComboBox
17207
17354
  */
17208
17355
  class SFBMultiComboBox
@@ -17210,6 +17357,8 @@ declare namespace sap {
17210
17357
  implements /* was: sap.ui.comp.IDropDownTextArrangement */ Object {
17211
17358
  __implements__sap_ui_comp_IDropDownTextArrangement: boolean;
17212
17359
  /**
17360
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
17361
+ *
17213
17362
  * Constructor for a new `SmartFilterBar/SFBMultiComboBox`.
17214
17363
  *
17215
17364
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
@@ -17219,6 +17368,8 @@ declare namespace sap {
17219
17368
  constructor();
17220
17369
 
17221
17370
  /**
17371
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
17372
+ *
17222
17373
  * Creates a new subclass of class sap.ui.comp.smartfilterbar.SFBMultiComboBox with name `sClassName` and
17223
17374
  * enriches it with the information contained in `oClassInfo`.
17224
17375
  *
@@ -17245,12 +17396,16 @@ declare namespace sap {
17245
17396
  FNMetaImpl?: Function
17246
17397
  ): Function;
17247
17398
  /**
17399
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
17400
+ *
17248
17401
  * Returns a metadata object for class sap.ui.comp.smartfilterbar.SFBMultiComboBox.
17249
17402
  *
17250
17403
  * @returns Metadata object describing this class
17251
17404
  */
17252
17405
  static getMetadata(): sap.ui.core.ElementMetadata;
17253
17406
  /**
17407
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
17408
+ *
17254
17409
  * Gets current value of property {@link #getTextArrangement textArrangement}.
17255
17410
  *
17256
17411
  * Sets the `value` property formatting according to the `com.sap.vocabularies.UI.v1.TextArrangementType`
@@ -17262,6 +17417,8 @@ declare namespace sap {
17262
17417
  */
17263
17418
  getTextArrangement(): string;
17264
17419
  /**
17420
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
17421
+ *
17265
17422
  * Sets a new value for property {@link #getTextArrangement textArrangement}.
17266
17423
  *
17267
17424
  * Sets the `value` property formatting according to the `com.sap.vocabularies.UI.v1.TextArrangementType`
@@ -17409,7 +17566,7 @@ declare namespace sap {
17409
17566
  /**
17410
17567
  * The variant that must be applied. oVariant must contain a valid JSON object.
17411
17568
  */
17412
- oVariant: object
17569
+ oVariant: Object
17413
17570
  ): void;
17414
17571
  /**
17415
17572
  * @SINCE 1.36
@@ -17540,10 +17697,32 @@ declare namespace sap {
17540
17697
  /**
17541
17698
  * Retrieves the currently visible filters and the values for storing them as variants. The result will
17542
17699
  * be passed on as a JSON object to the callee smart variant control.
17700
+ *
17701
+ * @returns An arbitrary Object with an example structure:
17702
+ *
17703
+ * ```javascript
17704
+ * {
17705
+ * filterBarVariant: any,
17706
+ * filterbar: [
17707
+ * {
17708
+ * group: string,
17709
+ * name: string,
17710
+ * partOfCurrentVariant: boolean,
17711
+ * visible: boolean,
17712
+ * visibleInFilterBar: boolean
17713
+ * },
17714
+ * ...
17715
+ * ],
17716
+ * orderedFilterItems: string,
17717
+ * singleInputsTextArrangementData: string,
17718
+ * version: string|undefined,
17719
+ * basicSearch: string|undefined
17720
+ * }```
17543
17721
  */
17544
- fetchVariant(): object;
17722
+ fetchVariant(): sap.ui.comp.filterbar.FilterBar.fetchVariantResponse;
17545
17723
  /**
17546
17724
  * @SINCE 1.36
17725
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
17547
17726
  *
17548
17727
  * Fires event {@link #event:pendingChange pendingChange} to attached listeners.
17549
17728
  *
@@ -17573,7 +17752,7 @@ declare namespace sap {
17573
17752
  *
17574
17753
  * @returns Basic search control
17575
17754
  */
17576
- getBasicSearchControl(): object;
17755
+ getBasicSearchControl(): Record<string, sap.m.SearchField>;
17577
17756
  /**
17578
17757
  * Gets current value of property {@link #getBasicSearchFieldName basicSearchFieldName}.
17579
17758
  *
@@ -17624,7 +17803,7 @@ declare namespace sap {
17624
17803
  * The key as present in the OData property name/control configuration
17625
17804
  */
17626
17805
  sKey: string
17627
- ): object | sap.ui.core.Control;
17806
+ ): Object | sap.ui.core.Control | undefined;
17628
17807
  /**
17629
17808
  * Gets content of aggregation {@link #getControlConfiguration controlConfiguration}.
17630
17809
  *
@@ -17634,6 +17813,8 @@ declare namespace sap {
17634
17813
  */
17635
17814
  getControlConfiguration(): sap.ui.comp.smartfilterbar.ControlConfiguration[];
17636
17815
  /**
17816
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
17817
+ *
17637
17818
  * Returns the condition type object (if any) with the specified key (Property name in OData entity). Use
17638
17819
  * just the property name as the key when getting a control from the basic area.
17639
17820
  *
@@ -17644,7 +17825,10 @@ declare namespace sap {
17644
17825
  * The key as present in the OData property name/control configuration
17645
17826
  */
17646
17827
  sKey: string
17647
- ): object;
17828
+ ): Promise<
17829
+ | sap.ui.comp.smartfilterbar.SmartFilterBar.DateRangeTypeByKeyResponse
17830
+ | undefined
17831
+ >;
17648
17832
  /**
17649
17833
  * @deprecated (since 1.87) - Please use the `com.sap.vocabularies.UI.v1.SelectionPresentationVariant` annotation
17650
17834
  * through the {@link sap.ui.comp.smartvariants.SmartVariantManagement#setEntitySet}
@@ -17662,6 +17846,7 @@ declare namespace sap {
17662
17846
  getDefaultSelectionVariantName(): string;
17663
17847
  /**
17664
17848
  * @SINCE 1.75
17849
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
17665
17850
  *
17666
17851
  * Reads the descriptions for given filters and value keys.
17667
17852
  */
@@ -17705,6 +17890,8 @@ declare namespace sap {
17705
17890
  */
17706
17891
  getEntityType(): string;
17707
17892
  /**
17893
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
17894
+ *
17708
17895
  * Get the filter context url.
17709
17896
  *
17710
17897
  * @returns Filter context url.
@@ -17720,7 +17907,7 @@ declare namespace sap {
17720
17907
  * Also include empty/invisible fields filter data
17721
17908
  */
17722
17909
  bAllFilterData?: boolean
17723
- ): object;
17910
+ ): Object;
17724
17911
  /**
17725
17912
  * Returns the data currently set in the filter data model as string.
17726
17913
  *
@@ -17784,6 +17971,8 @@ declare namespace sap {
17784
17971
  */
17785
17972
  getLiveMode(): boolean;
17786
17973
  /**
17974
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
17975
+ *
17787
17976
  * Get the model data.
17788
17977
  *
17789
17978
  * @returns of the model data.
@@ -17814,6 +18003,8 @@ declare namespace sap {
17814
18003
  */
17815
18004
  getParameterBindingPath(): string;
17816
18005
  /**
18006
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
18007
+ *
17817
18008
  * Get the parameter context url.
17818
18009
  *
17819
18010
  * @returns Parameter context url.
@@ -17839,7 +18030,7 @@ declare namespace sap {
17839
18030
  *
17840
18031
  * @returns A parameter object containing OData query parameters
17841
18032
  */
17842
- getParameters(): object;
18033
+ getParameters(): Record<string, Record<string, string>>;
17843
18034
  /**
17844
18035
  * @deprecated (since 1.29) - Set an ODataModel as the main model on your control/view instead
17845
18036
  *
@@ -17975,12 +18166,16 @@ declare namespace sap {
17975
18166
  iIndex: int
17976
18167
  ): this;
17977
18168
  /**
18169
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
18170
+ *
17978
18171
  * Checks whether the control is initialised
17979
18172
  *
17980
18173
  * @returns returns whether control is already initialised
17981
18174
  */
17982
18175
  isInitialised(): boolean;
17983
18176
  /**
18177
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
18178
+ *
17984
18179
  * Determines if the custom data 'dateFormatSettings' is set with UTC mode `true`
17985
18180
  *
17986
18181
  * @returns returns whether the filter bar is running in UTC mode
@@ -18114,6 +18309,8 @@ declare namespace sap {
18114
18309
  bConsiderSelectionVariants?: boolean
18115
18310
  ): this;
18116
18311
  /**
18312
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
18313
+ *
18117
18314
  * Sets the the Dynamic Date Option of condition type (if any) data in the filter data model.
18118
18315
  *
18119
18316
  * @returns returns Promise
@@ -18127,7 +18324,10 @@ declare namespace sap {
18127
18324
  * The key of Dynamic Date Option
18128
18325
  */
18129
18326
  sOption: string
18130
- ): object;
18327
+ ): Promise<
18328
+ | sap.ui.comp.smartfilterbar.SmartFilterBar.DateRangeTypeByKeyResponse
18329
+ | undefined
18330
+ >;
18131
18331
  /**
18132
18332
  * @deprecated (since 1.87) - Please use the `com.sap.vocabularies.UI.v1.SelectionPresentationVariant` annotation
18133
18333
  * through the {@link sap.ui.comp.smartvariants.SmartVariantManagement#setEntitySet}
@@ -18395,7 +18595,7 @@ declare namespace sap {
18395
18595
  * pending indicates that a token validation is going on. an object with the property error indicates that
18396
18596
  * some filters or parameters are in error state.
18397
18597
  */
18398
- verifySearchAllowed(): object;
18598
+ verifySearchAllowed(): sap.ui.comp.smartfilterbar.SmartFilterBar.SearchAllowed;
18399
18599
  }
18400
18600
  /**
18401
18601
  * Represents a filter belonging to a group other than basic.
@@ -19932,6 +20132,8 @@ declare namespace sap {
19932
20132
  oListener?: object
19933
20133
  ): this;
19934
20134
  /**
20135
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
20136
+ *
19935
20137
  * Fires event {@link #event:visibleChanged visibleChanged} to attached listeners.
19936
20138
  *
19937
20139
  * @returns Reference to `this` in order to allow method chaining
@@ -20822,6 +21024,8 @@ declare namespace sap {
20822
21024
  oListener?: object
20823
21025
  ): this;
20824
21026
  /**
21027
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
21028
+ *
20825
21029
  * Fires event {@link #event:visibleChanged visibleChanged} to attached listeners.
20826
21030
  *
20827
21031
  * @returns Reference to `this` in order to allow method chaining
@@ -21202,7 +21406,7 @@ declare namespace sap {
21202
21406
  */
21203
21407
  handleSuccess?: boolean;
21204
21408
  }
21205
- ): string[] | Array<Promise<any>>;
21409
+ ): string[] | Promise<Object[]>;
21206
21410
  /**
21207
21411
  * Destroys the customToolbar in the aggregation {@link #getCustomToolbar customToolbar}.
21208
21412
  *
@@ -21262,6 +21466,8 @@ declare namespace sap {
21262
21466
  oListener?: object
21263
21467
  ): this;
21264
21468
  /**
21469
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
21470
+ *
21265
21471
  * Fires event {@link #event:checked checked} to attached listeners.
21266
21472
  *
21267
21473
  * @returns Reference to `this` in order to allow method chaining
@@ -21278,6 +21484,8 @@ declare namespace sap {
21278
21484
  }
21279
21485
  ): this;
21280
21486
  /**
21487
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
21488
+ *
21281
21489
  * Fires event {@link #event:editToggled editToggled} to attached listeners.
21282
21490
  *
21283
21491
  * @returns Reference to `this` in order to allow method chaining
@@ -22421,11 +22629,14 @@ declare namespace sap {
22421
22629
  oListener?: object
22422
22630
  ): this;
22423
22631
  /**
22632
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
22633
+ *
22424
22634
  * Cleans up the control
22425
22635
  */
22426
22636
  exit(): void;
22427
22637
  /**
22428
22638
  * @SINCE 1.48.0
22639
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
22429
22640
  *
22430
22641
  * Fires event {@link #event:beforeRebindList beforeRebindList} to attached listeners.
22431
22642
  *
@@ -22439,6 +22650,7 @@ declare namespace sap {
22439
22650
  ): this;
22440
22651
  /**
22441
22652
  * @SINCE 1.48.0
22653
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
22442
22654
  *
22443
22655
  * Fires event {@link #event:dataReceived dataReceived} to attached listeners.
22444
22656
  *
@@ -22452,6 +22664,7 @@ declare namespace sap {
22452
22664
  ): this;
22453
22665
  /**
22454
22666
  * @SINCE 1.48.0
22667
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
22455
22668
  *
22456
22669
  * Fires event {@link #event:initialise initialise} to attached listeners.
22457
22670
  *
@@ -22603,12 +22816,16 @@ declare namespace sap {
22603
22816
  */
22604
22817
  getSmartFilter(): sap.ui.core.ID;
22605
22818
  /**
22819
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
22820
+ *
22606
22821
  * Checks whether the control is initialized.
22607
22822
  *
22608
22823
  * @returns returns whether control has already been initialized
22609
22824
  */
22610
22825
  isInitialised(): boolean;
22611
22826
  /**
22827
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
22828
+ *
22612
22829
  * This can be used to trigger binding on the list used in the SmartList
22613
22830
  */
22614
22831
  rebindList(
@@ -23974,6 +24191,8 @@ declare namespace sap {
23974
24191
  oListener?: object
23975
24192
  ): this;
23976
24193
  /**
24194
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
24195
+ *
23977
24196
  * Fires event {@link #event:initialize initialize} to attached listeners.
23978
24197
  *
23979
24198
  * @returns Reference to `this` in order to allow method chaining
@@ -24459,6 +24678,8 @@ declare namespace sap {
24459
24678
  oListener?: object
24460
24679
  ): this;
24461
24680
  /**
24681
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
24682
+ *
24462
24683
  * Fires event {@link #event:initialize initialize} to attached listeners.
24463
24684
  *
24464
24685
  * @returns Reference to `this` in order to allow method chaining
@@ -25370,6 +25591,8 @@ declare namespace sap {
25370
25591
  oListener?: object
25371
25592
  ): this;
25372
25593
  /**
25594
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
25595
+ *
25373
25596
  * Fires event {@link #event:change change} to attached listeners.
25374
25597
  *
25375
25598
  * @returns Reference to `this` in order to allow method chaining
@@ -26242,6 +26465,8 @@ declare namespace sap {
26242
26465
  oListener?: object
26243
26466
  ): this;
26244
26467
  /**
26468
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
26469
+ *
26245
26470
  * Fires event {@link #event:beforeCreate beforeCreate} to attached listeners.
26246
26471
  *
26247
26472
  * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
@@ -26267,6 +26492,8 @@ declare namespace sap {
26267
26492
  }
26268
26493
  ): boolean;
26269
26494
  /**
26495
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
26496
+ *
26270
26497
  * Fires event {@link #event:beforeRemove beforeRemove} to attached listeners.
26271
26498
  *
26272
26499
  * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
@@ -26288,6 +26515,8 @@ declare namespace sap {
26288
26515
  }
26289
26516
  ): boolean;
26290
26517
  /**
26518
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
26519
+ *
26291
26520
  * Fires event {@link #event:selectionChange selectionChange} to attached listeners.
26292
26521
  *
26293
26522
  * @returns Reference to `this` in order to allow method chaining
@@ -26308,6 +26537,8 @@ declare namespace sap {
26308
26537
  }
26309
26538
  ): this;
26310
26539
  /**
26540
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
26541
+ *
26311
26542
  * Fires event {@link #event:selectionFinish selectionFinish} to attached listeners.
26312
26543
  *
26313
26544
  * @returns Reference to `this` in order to allow method chaining
@@ -26324,6 +26555,8 @@ declare namespace sap {
26324
26555
  }
26325
26556
  ): this;
26326
26557
  /**
26558
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
26559
+ *
26327
26560
  * Fires event {@link #event:tokenUpdate tokenUpdate} to attached listeners.
26328
26561
  *
26329
26562
  * @returns Reference to `this` in order to allow method chaining
@@ -26578,7 +26811,7 @@ declare namespace sap {
26578
26811
  * (also in the closest parent View) and attaches to the relevant events of the SmartFilter; to fetch data,
26579
26812
  * show overlay etc.
26580
26813
  *
26581
- * Note:
26814
+ * **Note:**
26582
26815
  * This is not a dynamic property and cannot be changed once the control has been initialized.
26583
26816
  */
26584
26817
  smartFilterId?:
@@ -26592,7 +26825,7 @@ declare namespace sap {
26592
26825
  * The `SmartTable` control will not create built-in columns for the fields defined by this property and
26593
26826
  * will not offer these fields in table personalization.
26594
26827
  *
26595
- * Note:
26828
+ * **Note:**
26596
26829
  *
26597
26830
  * - Please ensure that you do not add spaces or special characters as no validation is done for this
26598
26831
  * property.
@@ -26610,7 +26843,7 @@ declare namespace sap {
26610
26843
  * This property is mainly meant to be used when no LineItem annotation exists.
26611
26844
  * If you have fields in the XMLView they are always shown first; then, the columns are added based on
26612
26845
  * the LineItem annotation and finally based on this property.
26613
- * Note:
26846
+ * **Note:**
26614
26847
  *
26615
26848
  * - If both this property and the LineItem annotation exist, the order of fields cannot be guaranteed
26616
26849
  * to be as mentioned here.
@@ -26629,7 +26862,7 @@ declare namespace sap {
26629
26862
  * This property is mainly meant to be used when there is no PresentationVariant annotation.
26630
26863
  * If both this property and the PresentationVariant annotation exist, the select request sent to the backend
26631
26864
  * would be a combination of both.
26632
- * Note:
26865
+ * **Note:**
26633
26866
  * For `AnalyticalTable` (supported since 1.54), the following restrictions apply:
26634
26867
  * - The property name(s) must not point to a new dimension or a measure.
26635
26868
  * - The property name(s) must not point to a navigationProperty/association path, as this might not supported
@@ -26647,7 +26880,7 @@ declare namespace sap {
26647
26880
  * This property must only be used for use cases where a technical field/column is required to fetch some
26648
26881
  * data from the backend but is hidden in the table personalization and on the UI.
26649
26882
  *
26650
- * Note:
26883
+ * **Note:**
26651
26884
  *
26652
26885
  * - Please ensure that you do not add spaces or special characters as no validation is done for this
26653
26886
  * property.
@@ -26663,7 +26896,7 @@ declare namespace sap {
26663
26896
  * @SINCE 1.26.0
26664
26897
  *
26665
26898
  * Specifies the type of table to be created in the SmartTable control.
26666
- * Note:
26899
+ * **Note:**
26667
26900
  *
26668
26901
  * - If you add a table to the content of the SmartTable in the view, this property has no effect.
26669
26902
  * - This is not a dynamic property and cannot be changed once the control has been initialized.
@@ -26684,6 +26917,24 @@ declare namespace sap {
26684
26917
  | sap.ui.base.ManagedObject.PropertyBindingInfo
26685
26918
  | `{${string}}`;
26686
26919
 
26920
+ /**
26921
+ * @SINCE 1.114.0
26922
+ *
26923
+ * If no tooltips have been provided, neither by the `QuickInfo` annotation nor for custom columns directly
26924
+ * via property, the column label will automatically be applied as a tooltip for the column.
26925
+ *
26926
+ * To enable this mechanism for custom columns, a `sap.m.Label` or `sap.m.Text` must be used as header label.
26927
+ * Custom tooltips are not affected by this functionality when they are provided on the column header label
26928
+ * for tables of type `ResponsiveTable` and on the column for other table types.
26929
+ *
26930
+ * **Note:**
26931
+ * This is not a dynamic property and cannot be changed once the control has been initialized.
26932
+ */
26933
+ useColumnLabelsAsTooltips?:
26934
+ | boolean
26935
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
26936
+ | `{${string}}`;
26937
+
26687
26938
  /**
26688
26939
  * @SINCE 1.38.0
26689
26940
  *
@@ -26701,7 +26952,7 @@ declare namespace sap {
26701
26952
  *
26702
26953
  * Can be set to true or false depending on whether you want to export data to a spreadsheet application,
26703
26954
  * for example Microsoft Excel.
26704
- * Note:
26955
+ * **Note:**
26705
26956
  * If `exportType` is `sap.ui.comp.smarttable.ExportType.GW`, any $expand parameters are removed when sending
26706
26957
  * the request to generate the spreadsheet.
26707
26958
  * As of UI5 version 1.56: If `exportType` is `sap.ui.comp.smarttable.ExportType.UI5Client` and `TreeTable`
@@ -26719,6 +26970,7 @@ declare namespace sap {
26719
26970
  * Enables the export of data from the `SmartTable` control to another file, for example, a spreadsheet.
26720
26971
  * If `exportType` is `sap.ui.comp.smarttable.ExportType.GW`, any `$expand` parameters are removed when
26721
26972
  * sending the request to generate the file.
26973
+ * To use the export functionality, the {@link sap.ui.export} library is required.
26722
26974
  */
26723
26975
  enableExport?:
26724
26976
  | boolean
@@ -26742,7 +26994,7 @@ declare namespace sap {
26742
26994
  * define personalized table settings. If you want to persist the table personalization, you need to specify
26743
26995
  * the persistencyKey property.
26744
26996
  *
26745
- * Note:
26997
+ * **Note:**
26746
26998
  * This is not a dynamic property and cannot be changed once the control has been initialized.
26747
26999
  */
26748
27000
  useTablePersonalisation?:
@@ -26808,6 +27060,7 @@ declare namespace sap {
26808
27060
  * The number of rows is shown along with the header text if the property `showRowCount` is set to `true`.
26809
27061
  *
26810
27062
  * **Note:**
27063
+ *
26811
27064
  * - To improve your application's performance, activate the inline count for OData bindings to avoid
26812
27065
  * sending dedicated OData requests.
26813
27066
  * - If no stable overall count can be retrieved from the binding, the count will not be displayed. This
@@ -26865,7 +27118,7 @@ declare namespace sap {
26865
27118
  *
26866
27119
  * Key used to access personalization data.
26867
27120
  *
26868
- * Note:
27121
+ * **Note:**
26869
27122
  * This is not a dynamic property and cannot be changed once the control has been initialized.
26870
27123
  */
26871
27124
  persistencyKey?:
@@ -26921,7 +27174,7 @@ declare namespace sap {
26921
27174
  * When set to true, this enables automatic binding of the table using the tableBindingPath (if it exists)
26922
27175
  * or entitySet property. This happens just after the `initialise` event has been fired.
26923
27176
  *
26924
- * Note:
27177
+ * **Note:**
26925
27178
  * This is not a dynamic property and cannot be changed once the control has been initialized.
26926
27179
  */
26927
27180
  enableAutoBinding?:
@@ -27018,7 +27271,8 @@ declare namespace sap {
27018
27271
  * in the table toolbar and gives the user the possibility to toggle the visibility of the hidden columns
27019
27272
  * in the pop-in area.
27020
27273
  *
27021
- * **Note:** This is not a dynamic property and cannot be changed once the control has been initialized.
27274
+ * **Note:**
27275
+ * This is not a dynamic property and cannot be changed once the control has been initialized.
27022
27276
  */
27023
27277
  showDetailsButton?:
27024
27278
  | boolean
@@ -27103,8 +27357,9 @@ declare namespace sap {
27103
27357
  * ```
27104
27358
  *
27105
27359
  *
27106
- * **Note:** The `enableAutoColumnWidth` is not a dynamic property and cannot be changed once the control
27107
- * has been initialized.
27360
+ * **Note:**
27361
+ * The `enableAutoColumnWidth` is not a dynamic property and cannot be changed once the control has been
27362
+ * initialized.
27108
27363
  */
27109
27364
  enableAutoColumnWidth?:
27110
27365
  | boolean
@@ -27136,7 +27391,7 @@ declare namespace sap {
27136
27391
  *
27137
27392
  * A toolbar that can be added by the user to define their own custom buttons, icons, etc. If this is specified,
27138
27393
  * the SmartTable control does not create an additional toolbar, but makes use of this one.
27139
- * Note:
27394
+ * **Note:**
27140
27395
  * The CSS class sapMTBHeader-CTX is applied on the given toolbar.
27141
27396
  */
27142
27397
  customToolbar?: sap.m.Toolbar;
@@ -27167,7 +27422,7 @@ declare namespace sap {
27167
27422
  *
27168
27423
  * Allows users to specify an additional control that will be added to a VBox for the first semantic key
27169
27424
  * field.
27170
- * Note:
27425
+ * **Note:**
27171
27426
  * This property is not meant for public use.
27172
27427
  */
27173
27428
  semanticKeyAdditionalControl?: sap.ui.core.Control;
@@ -27188,6 +27443,20 @@ declare namespace sap {
27188
27443
  */
27189
27444
  dataStateIndicator?: sap.m.plugins.DataStateIndicator;
27190
27445
 
27446
+ /**
27447
+ * @SINCE 1.114
27448
+ *
27449
+ * Defines an aggregation for the `CopyProvider` plugin that provides copy to clipboard capabilities for
27450
+ * the selected rows of the table and creates a Copy button for the toolbar of the table. To disable the
27451
+ * copy function of the table, including the Copy button in the toolbar, the `enabled` property of the `CopyProvider`
27452
+ * must be set to `false`. To hide the Copy button from the toolbar, the `visible` property of the `CopyProvider`
27453
+ * must be set to `false`.
27454
+ *
27455
+ * **Note:** The {@link sap.m.plugins.CopyProvider#extractData extractData} property of the `CopyProvider`
27456
+ * must not be managed by the application.
27457
+ */
27458
+ copyProvider?: sap.m.plugins.CopyProvider;
27459
+
27191
27460
  /**
27192
27461
  * @SINCE 1.38
27193
27462
  *
@@ -28186,6 +28455,14 @@ declare namespace sap {
28186
28455
  */
28187
28456
  aColumnKeys: string[] | null | undefined
28188
28457
  ): void;
28458
+ /**
28459
+ * @SINCE 1.114
28460
+ *
28461
+ * Destroys the copyProvider in the aggregation {@link #getCopyProvider copyProvider}.
28462
+ *
28463
+ * @returns Reference to `this` in order to allow method chaining
28464
+ */
28465
+ destroyCopyProvider(): this;
28189
28466
  /**
28190
28467
  * @SINCE 1.26.0
28191
28468
  *
@@ -28522,6 +28799,8 @@ declare namespace sap {
28522
28799
  oListener?: object
28523
28800
  ): this;
28524
28801
  /**
28802
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
28803
+ *
28525
28804
  * Cleans up the control
28526
28805
  */
28527
28806
  exit(): void;
@@ -28533,6 +28812,7 @@ declare namespace sap {
28533
28812
  fetchVariant(): object;
28534
28813
  /**
28535
28814
  * @SINCE 1.28.0
28815
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
28536
28816
  *
28537
28817
  * Fires event {@link #event:afterVariantApply afterVariantApply} to attached listeners.
28538
28818
  *
@@ -28551,6 +28831,7 @@ declare namespace sap {
28551
28831
  ): this;
28552
28832
  /**
28553
28833
  * @SINCE 1.28.0
28834
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
28554
28835
  *
28555
28836
  * Fires event {@link #event:afterVariantInitialise afterVariantInitialise} to attached listeners.
28556
28837
  *
@@ -28564,6 +28845,7 @@ declare namespace sap {
28564
28845
  ): this;
28565
28846
  /**
28566
28847
  * @SINCE 1.28.0
28848
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
28567
28849
  *
28568
28850
  * Fires event {@link #event:afterVariantSave afterVariantSave} to attached listeners.
28569
28851
  *
@@ -28582,6 +28864,7 @@ declare namespace sap {
28582
28864
  ): this;
28583
28865
  /**
28584
28866
  * @SINCE 1.50
28867
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
28585
28868
  *
28586
28869
  * Fires event {@link #event:beforeExport beforeExport} to attached listeners.
28587
28870
  *
@@ -28608,6 +28891,7 @@ declare namespace sap {
28608
28891
  ): this;
28609
28892
  /**
28610
28893
  * @EXPERIMENTAL (since 1.64) - This API is experimental and subject to change
28894
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
28611
28895
  *
28612
28896
  * Fires event {@link #event:beforePaste beforePaste} to attached listeners.
28613
28897
  *
@@ -28629,6 +28913,7 @@ declare namespace sap {
28629
28913
  ): boolean;
28630
28914
  /**
28631
28915
  * @SINCE 1.26.0
28916
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
28632
28917
  *
28633
28918
  * Fires event {@link #event:beforeRebindTable beforeRebindTable} to attached listeners.
28634
28919
  *
@@ -28643,6 +28928,7 @@ declare namespace sap {
28643
28928
  /**
28644
28929
  * @SINCE 1.28.0
28645
28930
  * @deprecated (since 1.56) - Use `beforeRebindTable` event to attach/listen to the binding "events" directly
28931
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
28646
28932
  *
28647
28933
  * Fires event {@link #event:dataReceived dataReceived} to attached listeners.
28648
28934
  *
@@ -28657,6 +28943,7 @@ declare namespace sap {
28657
28943
  /**
28658
28944
  * @SINCE 1.52.0
28659
28945
  * @deprecated (since 1.56) - Use `beforeRebindTable` event to attach/listen to the binding "events" directly
28946
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
28660
28947
  *
28661
28948
  * Fires event {@link #event:dataRequested dataRequested} to attached listeners.
28662
28949
  *
@@ -28670,6 +28957,7 @@ declare namespace sap {
28670
28957
  ): this;
28671
28958
  /**
28672
28959
  * @SINCE 1.28.0
28960
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
28673
28961
  *
28674
28962
  * Fires event {@link #event:editToggled editToggled} to attached listeners.
28675
28963
  *
@@ -28683,6 +28971,7 @@ declare namespace sap {
28683
28971
  ): this;
28684
28972
  /**
28685
28973
  * @SINCE 1.34.0
28974
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
28686
28975
  *
28687
28976
  * Fires event {@link #event:fieldChange fieldChange} to attached listeners.
28688
28977
  *
@@ -28696,6 +28985,7 @@ declare namespace sap {
28696
28985
  ): this;
28697
28986
  /**
28698
28987
  * @SINCE 1.46
28988
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
28699
28989
  *
28700
28990
  * Fires event {@link #event:fullScreenToggled fullScreenToggled} to attached listeners.
28701
28991
  *
@@ -28714,6 +29004,7 @@ declare namespace sap {
28714
29004
  ): this;
28715
29005
  /**
28716
29006
  * @SINCE 1.26.0
29007
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
28717
29008
  *
28718
29009
  * Fires event {@link #event:initialise initialise} to attached listeners.
28719
29010
  *
@@ -28727,6 +29018,7 @@ declare namespace sap {
28727
29018
  ): this;
28728
29019
  /**
28729
29020
  * @EXPERIMENTAL (since 1.64) - This API is experimental and subject to change
29021
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
28730
29022
  *
28731
29023
  * Fires event {@link #event:paste paste} to attached listeners.
28732
29024
  *
@@ -28745,6 +29037,7 @@ declare namespace sap {
28745
29037
  ): this;
28746
29038
  /**
28747
29039
  * @SINCE 1.32.0
29040
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
28748
29041
  *
28749
29042
  * Fires event {@link #event:showOverlay showOverlay} to attached listeners.
28750
29043
  *
@@ -28758,6 +29051,7 @@ declare namespace sap {
28758
29051
  ): this;
28759
29052
  /**
28760
29053
  * @SINCE 1.96.15
29054
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
28761
29055
  *
28762
29056
  * Fires event {@link #event:uiStateChange uiStateChange} to attached listeners.
28763
29057
  *
@@ -28769,6 +29063,21 @@ declare namespace sap {
28769
29063
  */
28770
29064
  mParameters?: object
28771
29065
  ): this;
29066
+ /**
29067
+ * @SINCE 1.114
29068
+ *
29069
+ * Gets content of aggregation {@link #getCopyProvider copyProvider}.
29070
+ *
29071
+ * Defines an aggregation for the `CopyProvider` plugin that provides copy to clipboard capabilities for
29072
+ * the selected rows of the table and creates a Copy button for the toolbar of the table. To disable the
29073
+ * copy function of the table, including the Copy button in the toolbar, the `enabled` property of the `CopyProvider`
29074
+ * must be set to `false`. To hide the Copy button from the toolbar, the `visible` property of the `CopyProvider`
29075
+ * must be set to `false`.
29076
+ *
29077
+ * **Note:** The {@link sap.m.plugins.CopyProvider#extractData extractData} property of the `CopyProvider`
29078
+ * must not be managed by the application.
29079
+ */
29080
+ getCopyProvider(): sap.m.plugins.CopyProvider;
28772
29081
  /**
28773
29082
  * returns the id of the currently selected variant.
28774
29083
  *
@@ -28824,7 +29133,7 @@ declare namespace sap {
28824
29133
  *
28825
29134
  * A toolbar that can be added by the user to define their own custom buttons, icons, etc. If this is specified,
28826
29135
  * the SmartTable control does not create an additional toolbar, but makes use of this one.
28827
- * Note:
29136
+ * **Note:**
28828
29137
  * The CSS class sapMTBHeader-CTX is applied on the given toolbar.
28829
29138
  */
28830
29139
  getCustomToolbar(): sap.m.Toolbar;
@@ -28918,7 +29227,7 @@ declare namespace sap {
28918
29227
  * When set to true, this enables automatic binding of the table using the tableBindingPath (if it exists)
28919
29228
  * or entitySet property. This happens just after the `initialise` event has been fired.
28920
29229
  *
28921
- * Note:
29230
+ * **Note:**
28922
29231
  * This is not a dynamic property and cannot be changed once the control has been initialized.
28923
29232
  *
28924
29233
  * Default value is `false`.
@@ -28990,8 +29299,9 @@ declare namespace sap {
28990
29299
  * ```
28991
29300
  *
28992
29301
  *
28993
- * **Note:** The `enableAutoColumnWidth` is not a dynamic property and cannot be changed once the control
28994
- * has been initialized.
29302
+ * **Note:**
29303
+ * The `enableAutoColumnWidth` is not a dynamic property and cannot be changed once the control has been
29304
+ * initialized.
28995
29305
  *
28996
29306
  * Default value is `false`.
28997
29307
  *
@@ -29024,6 +29334,7 @@ declare namespace sap {
29024
29334
  * Enables the export of data from the `SmartTable` control to another file, for example, a spreadsheet.
29025
29335
  * If `exportType` is `sap.ui.comp.smarttable.ExportType.GW`, any `$expand` parameters are removed when
29026
29336
  * sending the request to generate the file.
29337
+ * To use the export functionality, the {@link sap.ui.export} library is required.
29027
29338
  *
29028
29339
  * Default value is `true`.
29029
29340
  *
@@ -29112,7 +29423,7 @@ declare namespace sap {
29112
29423
  * The `SmartTable` control will not create built-in columns for the fields defined by this property and
29113
29424
  * will not offer these fields in table personalization.
29114
29425
  *
29115
- * Note:
29426
+ * **Note:**
29116
29427
  *
29117
29428
  * - Please ensure that you do not add spaces or special characters as no validation is done for this
29118
29429
  * property.
@@ -29130,7 +29441,7 @@ declare namespace sap {
29130
29441
  * This property must only be used for use cases where a technical field/column is required to fetch some
29131
29442
  * data from the backend but is hidden in the table personalization and on the UI.
29132
29443
  *
29133
- * Note:
29444
+ * **Note:**
29134
29445
  *
29135
29446
  * - Please ensure that you do not add spaces or special characters as no validation is done for this
29136
29447
  * property.
@@ -29151,7 +29462,7 @@ declare namespace sap {
29151
29462
  * This property is mainly meant to be used when no LineItem annotation exists.
29152
29463
  * If you have fields in the XMLView they are always shown first; then, the columns are added based on
29153
29464
  * the LineItem annotation and finally based on this property.
29154
- * Note:
29465
+ * **Note:**
29155
29466
  *
29156
29467
  * - If both this property and the LineItem annotation exist, the order of fields cannot be guaranteed
29157
29468
  * to be as mentioned here.
@@ -29194,7 +29505,7 @@ declare namespace sap {
29194
29505
  *
29195
29506
  * Key used to access personalization data.
29196
29507
  *
29197
- * Note:
29508
+ * **Note:**
29198
29509
  * This is not a dynamic property and cannot be changed once the control has been initialized.
29199
29510
  *
29200
29511
  * @returns Value of property `persistencyKey`
@@ -29222,7 +29533,7 @@ declare namespace sap {
29222
29533
  * This property is mainly meant to be used when there is no PresentationVariant annotation.
29223
29534
  * If both this property and the PresentationVariant annotation exist, the select request sent to the backend
29224
29535
  * would be a combination of both.
29225
- * Note:
29536
+ * **Note:**
29226
29537
  * For `AnalyticalTable` (supported since 1.54), the following restrictions apply:
29227
29538
  * - The property name(s) must not point to a new dimension or a measure.
29228
29539
  * - The property name(s) must not point to a navigationProperty/association path, as this might not supported
@@ -29239,7 +29550,7 @@ declare namespace sap {
29239
29550
  *
29240
29551
  * Allows users to specify an additional control that will be added to a VBox for the first semantic key
29241
29552
  * field.
29242
- * Note:
29553
+ * **Note:**
29243
29554
  * This property is not meant for public use.
29244
29555
  */
29245
29556
  getSemanticKeyAdditionalControl(): sap.ui.core.Control;
@@ -29265,7 +29576,8 @@ declare namespace sap {
29265
29576
  * in the table toolbar and gives the user the possibility to toggle the visibility of the hidden columns
29266
29577
  * in the pop-in area.
29267
29578
  *
29268
- * **Note:** This is not a dynamic property and cannot be changed once the control has been initialized.
29579
+ * **Note:**
29580
+ * This is not a dynamic property and cannot be changed once the control has been initialized.
29269
29581
  *
29270
29582
  * Default value is `false`.
29271
29583
  *
@@ -29304,6 +29616,7 @@ declare namespace sap {
29304
29616
  * The number of rows is shown along with the header text if the property `showRowCount` is set to `true`.
29305
29617
  *
29306
29618
  * **Note:**
29619
+ *
29307
29620
  * - To improve your application's performance, activate the inline count for OData bindings to avoid
29308
29621
  * sending dedicated OData requests.
29309
29622
  * - If no stable overall count can be retrieved from the binding, the count will not be displayed. This
@@ -29349,7 +29662,7 @@ declare namespace sap {
29349
29662
  * (also in the closest parent View) and attaches to the relevant events of the SmartFilter; to fetch data,
29350
29663
  * show overlay etc.
29351
29664
  *
29352
- * Note:
29665
+ * **Note:**
29353
29666
  * This is not a dynamic property and cannot be changed once the control has been initialized.
29354
29667
  *
29355
29668
  * @returns Value of property `smartFilterId`
@@ -29387,7 +29700,7 @@ declare namespace sap {
29387
29700
  * Gets current value of property {@link #getTableType tableType}.
29388
29701
  *
29389
29702
  * Specifies the type of table to be created in the SmartTable control.
29390
- * Note:
29703
+ * **Note:**
29391
29704
  *
29392
29705
  * - If you add a table to the content of the SmartTable in the view, this property has no effect.
29393
29706
  * - This is not a dynamic property and cannot be changed once the control has been initialized.
@@ -29434,6 +29747,26 @@ declare namespace sap {
29434
29747
  * @returns Current UI state
29435
29748
  */
29436
29749
  getUiState(): sap.ui.comp.state.UIState;
29750
+ /**
29751
+ * @SINCE 1.114.0
29752
+ *
29753
+ * Gets current value of property {@link #getUseColumnLabelsAsTooltips useColumnLabelsAsTooltips}.
29754
+ *
29755
+ * If no tooltips have been provided, neither by the `QuickInfo` annotation nor for custom columns directly
29756
+ * via property, the column label will automatically be applied as a tooltip for the column.
29757
+ *
29758
+ * To enable this mechanism for custom columns, a `sap.m.Label` or `sap.m.Text` must be used as header label.
29759
+ * Custom tooltips are not affected by this functionality when they are provided on the column header label
29760
+ * for tables of type `ResponsiveTable` and on the column for other table types.
29761
+ *
29762
+ * **Note:**
29763
+ * This is not a dynamic property and cannot be changed once the control has been initialized.
29764
+ *
29765
+ * Default value is `true`.
29766
+ *
29767
+ * @returns Value of property `useColumnLabelsAsTooltips`
29768
+ */
29769
+ getUseColumnLabelsAsTooltips(): boolean;
29437
29770
  /**
29438
29771
  * @SINCE 1.26.0
29439
29772
  * @deprecated (since 1.100) - replaced by `enableExport` property.
@@ -29442,7 +29775,7 @@ declare namespace sap {
29442
29775
  *
29443
29776
  * Can be set to true or false depending on whether you want to export data to a spreadsheet application,
29444
29777
  * for example Microsoft Excel.
29445
- * Note:
29778
+ * **Note:**
29446
29779
  * If `exportType` is `sap.ui.comp.smarttable.ExportType.GW`, any $expand parameters are removed when sending
29447
29780
  * the request to generate the spreadsheet.
29448
29781
  * As of UI5 version 1.56: If `exportType` is `sap.ui.comp.smarttable.ExportType.UI5Client` and `TreeTable`
@@ -29501,7 +29834,7 @@ declare namespace sap {
29501
29834
  * define personalized table settings. If you want to persist the table personalization, you need to specify
29502
29835
  * the persistencyKey property.
29503
29836
  *
29504
- * Note:
29837
+ * **Note:**
29505
29838
  * This is not a dynamic property and cannot be changed once the control has been initialized.
29506
29839
  *
29507
29840
  * Default value is `true`.
@@ -29550,6 +29883,19 @@ declare namespace sap {
29550
29883
  */
29551
29884
  bForceRebind: boolean
29552
29885
  ): void;
29886
+ /**
29887
+ * @SINCE 1.114
29888
+ *
29889
+ * Sets the aggregated {@link #getCopyProvider copyProvider}.
29890
+ *
29891
+ * @returns Reference to `this` in order to allow method chaining
29892
+ */
29893
+ setCopyProvider(
29894
+ /**
29895
+ * The copyProvider to set
29896
+ */
29897
+ oCopyProvider: sap.m.plugins.CopyProvider
29898
+ ): this;
29553
29899
  /**
29554
29900
  * Set the current variant according to the sVariantId. In case an empty string or null or undefined was
29555
29901
  * passed the STANDARD will be set. STANDARD will also be set, in case the passed sVariantId could not be
@@ -29730,7 +30076,7 @@ declare namespace sap {
29730
30076
  * When set to true, this enables automatic binding of the table using the tableBindingPath (if it exists)
29731
30077
  * or entitySet property. This happens just after the `initialise` event has been fired.
29732
30078
  *
29733
- * Note:
30079
+ * **Note:**
29734
30080
  * This is not a dynamic property and cannot be changed once the control has been initialized.
29735
30081
  *
29736
30082
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
@@ -29809,8 +30155,9 @@ declare namespace sap {
29809
30155
  * ```
29810
30156
  *
29811
30157
  *
29812
- * **Note:** The `enableAutoColumnWidth` is not a dynamic property and cannot be changed once the control
29813
- * has been initialized.
30158
+ * **Note:**
30159
+ * The `enableAutoColumnWidth` is not a dynamic property and cannot be changed once the control has been
30160
+ * initialized.
29814
30161
  *
29815
30162
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
29816
30163
  *
@@ -29932,7 +30279,7 @@ declare namespace sap {
29932
30279
  * The `SmartTable` control will not create built-in columns for the fields defined by this property and
29933
30280
  * will not offer these fields in table personalization.
29934
30281
  *
29935
- * Note:
30282
+ * **Note:**
29936
30283
  *
29937
30284
  * - Please ensure that you do not add spaces or special characters as no validation is done for this
29938
30285
  * property.
@@ -29957,7 +30304,7 @@ declare namespace sap {
29957
30304
  * This property must only be used for use cases where a technical field/column is required to fetch some
29958
30305
  * data from the backend but is hidden in the table personalization and on the UI.
29959
30306
  *
29960
- * Note:
30307
+ * **Note:**
29961
30308
  *
29962
30309
  * - Please ensure that you do not add spaces or special characters as no validation is done for this
29963
30310
  * property.
@@ -29985,7 +30332,7 @@ declare namespace sap {
29985
30332
  * This property is mainly meant to be used when no LineItem annotation exists.
29986
30333
  * If you have fields in the XMLView they are always shown first; then, the columns are added based on
29987
30334
  * the LineItem annotation and finally based on this property.
29988
- * Note:
30335
+ * **Note:**
29989
30336
  *
29990
30337
  * - If both this property and the LineItem annotation exist, the order of fields cannot be guaranteed
29991
30338
  * to be as mentioned here.
@@ -30044,7 +30391,7 @@ declare namespace sap {
30044
30391
  *
30045
30392
  * Key used to access personalization data.
30046
30393
  *
30047
- * Note:
30394
+ * **Note:**
30048
30395
  * This is not a dynamic property and cannot be changed once the control has been initialized.
30049
30396
  *
30050
30397
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
@@ -30086,7 +30433,7 @@ declare namespace sap {
30086
30433
  * This property is mainly meant to be used when there is no PresentationVariant annotation.
30087
30434
  * If both this property and the PresentationVariant annotation exist, the select request sent to the backend
30088
30435
  * would be a combination of both.
30089
- * Note:
30436
+ * **Note:**
30090
30437
  * For `AnalyticalTable` (supported since 1.54), the following restrictions apply:
30091
30438
  * - The property name(s) must not point to a new dimension or a measure.
30092
30439
  * - The property name(s) must not point to a navigationProperty/association path, as this might not supported
@@ -30142,7 +30489,8 @@ declare namespace sap {
30142
30489
  * in the table toolbar and gives the user the possibility to toggle the visibility of the hidden columns
30143
30490
  * in the pop-in area.
30144
30491
  *
30145
- * **Note:** This is not a dynamic property and cannot be changed once the control has been initialized.
30492
+ * **Note:**
30493
+ * This is not a dynamic property and cannot be changed once the control has been initialized.
30146
30494
  *
30147
30495
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
30148
30496
  *
@@ -30202,6 +30550,7 @@ declare namespace sap {
30202
30550
  * The number of rows is shown along with the header text if the property `showRowCount` is set to `true`.
30203
30551
  *
30204
30552
  * **Note:**
30553
+ *
30205
30554
  * - To improve your application's performance, activate the inline count for OData bindings to avoid
30206
30555
  * sending dedicated OData requests.
30207
30556
  * - If no stable overall count can be retrieved from the binding, the count will not be displayed. This
@@ -30268,7 +30617,7 @@ declare namespace sap {
30268
30617
  * (also in the closest parent View) and attaches to the relevant events of the SmartFilter; to fetch data,
30269
30618
  * show overlay etc.
30270
30619
  *
30271
- * Note:
30620
+ * **Note:**
30272
30621
  * This is not a dynamic property and cannot be changed once the control has been initialized.
30273
30622
  *
30274
30623
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
@@ -30320,7 +30669,7 @@ declare namespace sap {
30320
30669
  * Sets a new value for property {@link #getTableType tableType}.
30321
30670
  *
30322
30671
  * Specifies the type of table to be created in the SmartTable control.
30323
- * Note:
30672
+ * **Note:**
30324
30673
  *
30325
30674
  * - If you add a table to the content of the SmartTable in the view, this property has no effect.
30326
30675
  * - This is not a dynamic property and cannot be changed once the control has been initialized.
@@ -30375,6 +30724,33 @@ declare namespace sap {
30375
30724
  */
30376
30725
  oUIState: sap.ui.comp.state.UIState
30377
30726
  ): void;
30727
+ /**
30728
+ * @SINCE 1.114.0
30729
+ *
30730
+ * Sets a new value for property {@link #getUseColumnLabelsAsTooltips useColumnLabelsAsTooltips}.
30731
+ *
30732
+ * If no tooltips have been provided, neither by the `QuickInfo` annotation nor for custom columns directly
30733
+ * via property, the column label will automatically be applied as a tooltip for the column.
30734
+ *
30735
+ * To enable this mechanism for custom columns, a `sap.m.Label` or `sap.m.Text` must be used as header label.
30736
+ * Custom tooltips are not affected by this functionality when they are provided on the column header label
30737
+ * for tables of type `ResponsiveTable` and on the column for other table types.
30738
+ *
30739
+ * **Note:**
30740
+ * This is not a dynamic property and cannot be changed once the control has been initialized.
30741
+ *
30742
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
30743
+ *
30744
+ * Default value is `true`.
30745
+ *
30746
+ * @returns Reference to `this` in order to allow method chaining
30747
+ */
30748
+ setUseColumnLabelsAsTooltips(
30749
+ /**
30750
+ * New value for property `useColumnLabelsAsTooltips`
30751
+ */
30752
+ bUseColumnLabelsAsTooltips?: boolean
30753
+ ): this;
30378
30754
  /**
30379
30755
  * @deprecated (since 1.100) - replaced by {@link #setEnableExport}.
30380
30756
  *
@@ -30443,7 +30819,7 @@ declare namespace sap {
30443
30819
  * define personalized table settings. If you want to persist the table personalization, you need to specify
30444
30820
  * the persistencyKey property.
30445
30821
  *
30446
- * Note:
30822
+ * **Note:**
30447
30823
  * This is not a dynamic property and cannot be changed once the control has been initialized.
30448
30824
  *
30449
30825
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
@@ -31321,6 +31697,8 @@ declare namespace sap {
31321
31697
  oListener?: object
31322
31698
  ): this;
31323
31699
  /**
31700
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
31701
+ *
31324
31702
  * Fires event {@link #event:afterSave afterSave} to attached listeners.
31325
31703
  *
31326
31704
  * @returns Reference to `this` in order to allow method chaining
@@ -31334,6 +31712,7 @@ declare namespace sap {
31334
31712
  /**
31335
31713
  * @deprecated (since 1.38.0) - Replaced by providing the personalizable control and the callback via the
31336
31714
  * `initialise`-method.
31715
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
31337
31716
  *
31338
31717
  * Fires event {@link #event:initialise initialise} to attached listeners.
31339
31718
  *
@@ -31695,17 +32074,6 @@ declare namespace sap {
31695
32074
  * @returns Metadata object describing this class
31696
32075
  */
31697
32076
  static getMetadata(): sap.ui.core.ElementMetadata;
31698
- /**
31699
- * Adds some variantItem to the aggregation {@link #getVariantItems variantItems}.
31700
- *
31701
- * @returns Reference to `this` in order to allow method chaining
31702
- */
31703
- addVariantItem(
31704
- /**
31705
- * The variantItem to add; if empty, nothing is inserted
31706
- */
31707
- oVariantItem: sap.ui.comp.variants.VariantItem
31708
- ): this;
31709
32077
  /**
31710
32078
  * Attaches event handler `fnFunction` to the {@link #event:manage manage} event of this `sap.ui.comp.smartvariants.SmartVariantManagementBase`.
31711
32079
  *
@@ -31862,12 +32230,6 @@ declare namespace sap {
31862
32230
  */
31863
32231
  bFlag: boolean
31864
32232
  ): void;
31865
- /**
31866
- * Destroys all the variantItems in the aggregation {@link #getVariantItems variantItems}.
31867
- *
31868
- * @returns Reference to `this` in order to allow method chaining
31869
- */
31870
- destroyVariantItems(): this;
31871
32233
  /**
31872
32234
  * Detaches event handler `fnFunction` from the {@link #event:manage manage} event of this `sap.ui.comp.smartvariants.SmartVariantManagementBase`.
31873
32235
  *
@@ -31920,6 +32282,8 @@ declare namespace sap {
31920
32282
  oListener?: object
31921
32283
  ): this;
31922
32284
  /**
32285
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
32286
+ *
31923
32287
  * Fires event {@link #event:manage manage} to attached listeners.
31924
32288
  *
31925
32289
  * @returns Reference to `this` in order to allow method chaining
@@ -31949,6 +32313,8 @@ declare namespace sap {
31949
32313
  }
31950
32314
  ): this;
31951
32315
  /**
32316
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
32317
+ *
31952
32318
  * Fires event {@link #event:save save} to attached listeners.
31953
32319
  *
31954
32320
  * @returns Reference to `this` in order to allow method chaining
@@ -31985,6 +32351,8 @@ declare namespace sap {
31985
32351
  }
31986
32352
  ): this;
31987
32353
  /**
32354
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
32355
+ *
31988
32356
  * Fires event {@link #event:select select} to attached listeners.
31989
32357
  *
31990
32358
  * @returns Reference to `this` in order to allow method chaining
@@ -32098,6 +32466,8 @@ declare namespace sap {
32098
32466
  */
32099
32467
  getMaxWidth(): sap.ui.core.CSSSize;
32100
32468
  /**
32469
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
32470
+ *
32101
32471
  * Required by the {@link sap.m.IOverflowToolbarContent} interface. Registers invalidations event which
32102
32472
  * is fired when width of the control is changed.
32103
32473
  *
@@ -32234,42 +32604,6 @@ declare namespace sap {
32234
32604
  */
32235
32605
  oVariantItem: sap.ui.comp.variants.VariantItem
32236
32606
  ): int;
32237
- /**
32238
- * Inserts a variantItem into the aggregation {@link #getVariantItems variantItems}.
32239
- *
32240
- * @returns Reference to `this` in order to allow method chaining
32241
- */
32242
- insertVariantItem(
32243
- /**
32244
- * The variantItem to insert; if empty, nothing is inserted
32245
- */
32246
- oVariantItem: sap.ui.comp.variants.VariantItem,
32247
- /**
32248
- * The `0`-based index the variantItem should be inserted at; for a negative value of `iIndex`, the variantItem
32249
- * is inserted at position 0; for a value greater than the current size of the aggregation, the variantItem
32250
- * is inserted at the last position
32251
- */
32252
- iIndex: int
32253
- ): this;
32254
- /**
32255
- * Removes all the controls from the aggregation {@link #getVariantItems variantItems}.
32256
- *
32257
- * Additionally, it unregisters them from the hosting UIArea.
32258
- *
32259
- * @returns An array of the removed elements (might be empty)
32260
- */
32261
- removeAllVariantItems(): sap.ui.comp.variants.VariantItem[];
32262
- /**
32263
- * Removes a variantItem from the aggregation {@link #getVariantItems variantItems}.
32264
- *
32265
- * @returns The removed variantItem or `null`
32266
- */
32267
- removeVariantItem(
32268
- /**
32269
- * The variantItem to remove or its index or id
32270
- */
32271
- vVariantItem: int | string | sap.ui.comp.variants.VariantItem
32272
- ): sap.ui.comp.variants.VariantItem | null;
32273
32607
  /**
32274
32608
  * Sets the new selected variant.
32275
32609
  */
@@ -32829,6 +33163,8 @@ declare namespace sap {
32829
33163
  oListener?: object
32830
33164
  ): this;
32831
33165
  /**
33166
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
33167
+ *
32832
33168
  * Fires event {@link #event:afterSave afterSave} to attached listeners.
32833
33169
  *
32834
33170
  * @returns Reference to `this` in order to allow method chaining
@@ -32840,6 +33176,8 @@ declare namespace sap {
32840
33176
  mParameters?: object
32841
33177
  ): this;
32842
33178
  /**
33179
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
33180
+ *
32843
33181
  * Fires event {@link #event:initialise initialise} to attached listeners.
32844
33182
  *
32845
33183
  * @returns Reference to `this` in order to allow method chaining
@@ -32931,6 +33269,20 @@ declare namespace sap {
32931
33269
  }
32932
33270
 
32933
33271
  namespace state {
33272
+ namespace UIState {
33273
+ type SelectionVariantParam = {
33274
+ FilterContextUrl: string;
33275
+
33276
+ ParameterContextUrl: string;
33277
+
33278
+ Parameters: Object[];
33279
+
33280
+ SelectOptions: Object[];
33281
+
33282
+ SelectionVariantID: string;
33283
+ };
33284
+ }
33285
+
32934
33286
  interface $UIStateSettings extends sap.ui.base.$ManagedObjectSettings {
32935
33287
  /**
32936
33288
  * Object representing the presentation variant. The structure looks like:
@@ -33083,6 +33435,8 @@ declare namespace sap {
33083
33435
  );
33084
33436
 
33085
33437
  /**
33438
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
33439
+ *
33086
33440
  * Constructs the value state out of a given selection variant and the current model data
33087
33441
  *
33088
33442
  * @returns the values texts format
@@ -33091,13 +33445,15 @@ declare namespace sap {
33091
33445
  /**
33092
33446
  * selection variant object
33093
33447
  */
33094
- oSelectionVariant: object,
33448
+ oSelectionVariant: sap.ui.comp.state.UIState.SelectionVariantParam,
33095
33449
  /**
33096
33450
  * the filter provider model data
33097
33451
  */
33098
33452
  mData: Record<string, any>
33099
- ): object;
33453
+ ): Record<string, Object[]>;
33100
33454
  /**
33455
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
33456
+ *
33101
33457
  * Constructs the value state out of a given selection variant and the current model data
33102
33458
  *
33103
33459
  * @returns the values texts format
@@ -33106,13 +33462,15 @@ declare namespace sap {
33106
33462
  /**
33107
33463
  * selection variant object
33108
33464
  */
33109
- oSelectionVariant: object,
33465
+ oSelectionVariant: sap.ui.comp.state.UIState.SelectionVariantParam,
33110
33466
  /**
33111
33467
  * the filter provider model data
33112
33468
  */
33113
33469
  mData: Record<string, any>
33114
- ): object;
33470
+ ): Record<string, Object[]>;
33115
33471
  /**
33472
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
33473
+ *
33116
33474
  * Converts PresentationVariant annotation to UIState object.
33117
33475
  *
33118
33476
  * @returns UIState object containing converted parts of SelectionVariant and PresentationVariant annotations
@@ -33125,14 +33483,15 @@ declare namespace sap {
33125
33483
  /**
33126
33484
  * Object representing the com.sap.vocabularies.UI.v1.SelectionVariant annotation provided by MetadataAnalyser
33127
33485
  */
33128
- oSelectionVariantAnnotation: object,
33486
+ oSelectionVariantAnnotation: Object,
33129
33487
  /**
33130
33488
  * Object representing the com.sap.vocabularies.UI.v1.PresentationVariant annotation provided by MetadataAnalyser
33131
33489
  */
33132
- oPresentationVariantAnnotation: object
33490
+ oPresentationVariantAnnotation: Object
33133
33491
  ): sap.ui.comp.state.UIState;
33134
33492
  /**
33135
33493
  * @SINCE 1.75
33494
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
33136
33495
  *
33137
33496
  * Determines the filter names with value keys where the description is not available.
33138
33497
  *
@@ -33146,13 +33505,15 @@ declare namespace sap {
33146
33505
  /**
33147
33506
  * The selection variant containing filters and value keys
33148
33507
  */
33149
- oSelectionVariant: object,
33508
+ oSelectionVariant: sap.ui.comp.state.UIState.SelectionVariantParam,
33150
33509
  /**
33151
33510
  * Filter names to ignore
33152
33511
  */
33153
- aIgnoreSelOptionNames: any[]
33154
- ): object;
33512
+ aIgnoreSelOptionNames: Object[]
33513
+ ): Record<string, Object[]>;
33155
33514
  /**
33515
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
33516
+ *
33156
33517
  * Enriches the internal filter bar value format with the semantic date information.
33157
33518
  *
33158
33519
  * @returns enriched the filter bar inner data format
@@ -33165,9 +33526,11 @@ declare namespace sap {
33165
33526
  /**
33166
33527
  * Semantic date information
33167
33528
  */
33168
- oSemanticDates: object
33529
+ oSemanticDates: Record<string, Object[]>
33169
33530
  ): string;
33170
33531
  /**
33532
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
33533
+ *
33171
33534
  * Enriches the internal filter bar value format with the information from the value state.
33172
33535
  *
33173
33536
  * @returns enriched the filter bar inner data format
@@ -33180,7 +33543,7 @@ declare namespace sap {
33180
33543
  /**
33181
33544
  * the value texts format containing the eventual descriptions.
33182
33545
  */
33183
- oValueTexts: object
33546
+ oValueTexts: Record<string, Object[]>
33184
33547
  ): string;
33185
33548
  /**
33186
33549
  * Creates a new subclass of class sap.ui.comp.state.UIState with name `sClassName` and enriches it with
@@ -33629,6 +33992,20 @@ declare namespace sap {
33629
33992
  | string
33630
33993
  | sap.ui.base.ManagedObject.PropertyBindingInfo;
33631
33994
 
33995
+ /**
33996
+ * @SINCE 1.113
33997
+ *
33998
+ * Sets usage of `MultiSelectionPlugin`. If enabled the default behaviour is changed and the `ValueHelpDialog`
33999
+ * table uses the plugin which provides only "Deselect all" option and the ability for range selection.
34000
+ * Also a limit of 1000 items that are able to be selected as a restriction.
34001
+ *
34002
+ * Note: Using `MultiSelectionPlugin` mode the method `update` will return a promise.
34003
+ */
34004
+ enabledMultiSelectionPlugin?:
34005
+ | boolean
34006
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
34007
+ | `{${string}}`;
34008
+
33632
34009
  /**
33633
34010
  * Allows you to add a {@link sap.ui.comp.filterbar.FilterBar FilterBar} or {@link sap.ui.comp.smartfilterbar.SmartFilterBar
33634
34011
  * SmartFilterBar} control to the value help dialog.
@@ -34132,6 +34509,7 @@ declare namespace sap {
34132
34509
  ): this;
34133
34510
  /**
34134
34511
  * @SINCE 1.24
34512
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
34135
34513
  *
34136
34514
  * Fires event {@link #event:cancel cancel} to attached listeners.
34137
34515
  *
@@ -34145,6 +34523,7 @@ declare namespace sap {
34145
34523
  ): this;
34146
34524
  /**
34147
34525
  * @SINCE 1.24
34526
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
34148
34527
  *
34149
34528
  * Fires event {@link #event:ok ok} to attached listeners.
34150
34529
  *
@@ -34163,6 +34542,7 @@ declare namespace sap {
34163
34542
  ): this;
34164
34543
  /**
34165
34544
  * @SINCE 1.32
34545
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
34166
34546
  *
34167
34547
  * Fires event {@link #event:selectionChange selectionChange} to attached listeners.
34168
34548
  *
@@ -34195,6 +34575,7 @@ declare namespace sap {
34195
34575
  ): this;
34196
34576
  /**
34197
34577
  * @SINCE 1.32
34578
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
34198
34579
  *
34199
34580
  * Fires event {@link #event:tokenRemove tokenRemove} to attached listeners.
34200
34581
  *
@@ -34217,6 +34598,7 @@ declare namespace sap {
34217
34598
  ): this;
34218
34599
  /**
34219
34600
  * @SINCE 1.32
34601
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
34220
34602
  *
34221
34603
  * Fires event {@link #event:updateSelection updateSelection} to attached listeners.
34222
34604
  *
@@ -34286,6 +34668,22 @@ declare namespace sap {
34286
34668
  * @returns Value of property `displayFormat`
34287
34669
  */
34288
34670
  getDisplayFormat(): string;
34671
+ /**
34672
+ * @SINCE 1.113
34673
+ *
34674
+ * Gets current value of property {@link #getEnabledMultiSelectionPlugin enabledMultiSelectionPlugin}.
34675
+ *
34676
+ * Sets usage of `MultiSelectionPlugin`. If enabled the default behaviour is changed and the `ValueHelpDialog`
34677
+ * table uses the plugin which provides only "Deselect all" option and the ability for range selection.
34678
+ * Also a limit of 1000 items that are able to be selected as a restriction.
34679
+ *
34680
+ * Note: Using `MultiSelectionPlugin` mode the method `update` will return a promise.
34681
+ *
34682
+ * Default value is `false`.
34683
+ *
34684
+ * @returns Value of property `enabledMultiSelectionPlugin`
34685
+ */
34686
+ getEnabledMultiSelectionPlugin(): boolean;
34289
34687
  /**
34290
34688
  * Gets content of aggregation {@link #getFilterBar filterBar}.
34291
34689
  *
@@ -34409,7 +34807,10 @@ declare namespace sap {
34409
34807
  *
34410
34808
  * @returns the used table instance
34411
34809
  */
34412
- getTable(): object;
34810
+ getTable(): Record<
34811
+ string,
34812
+ sap.m.Table | sap.ui.table.Table | sap.ui.comp.smarttable.SmartTable
34813
+ >;
34413
34814
  /**
34414
34815
  * @SINCE 1.58
34415
34816
  *
@@ -34417,7 +34818,14 @@ declare namespace sap {
34417
34818
  *
34418
34819
  * @returns Promise that, if resolved, returns the table object
34419
34820
  */
34420
- getTableAsync(): Promise<any>;
34821
+ getTableAsync(): Promise<
34822
+ Record<
34823
+ string,
34824
+ | sap.m.Table
34825
+ | sap.ui.table.Table
34826
+ | sap.ui.comp.smarttable.SmartTable
34827
+ >
34828
+ >;
34421
34829
  /**
34422
34830
  * @SINCE 1.24
34423
34831
  *
@@ -34508,6 +34916,29 @@ declare namespace sap {
34508
34916
  */
34509
34917
  sDisplayFormat?: string
34510
34918
  ): this;
34919
+ /**
34920
+ * @SINCE 1.113
34921
+ *
34922
+ * Sets a new value for property {@link #getEnabledMultiSelectionPlugin enabledMultiSelectionPlugin}.
34923
+ *
34924
+ * Sets usage of `MultiSelectionPlugin`. If enabled the default behaviour is changed and the `ValueHelpDialog`
34925
+ * table uses the plugin which provides only "Deselect all" option and the ability for range selection.
34926
+ * Also a limit of 1000 items that are able to be selected as a restriction.
34927
+ *
34928
+ * Note: Using `MultiSelectionPlugin` mode the method `update` will return a promise.
34929
+ *
34930
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
34931
+ *
34932
+ * Default value is `false`.
34933
+ *
34934
+ * @returns Reference to `this` in order to allow method chaining
34935
+ */
34936
+ setEnabledMultiSelectionPlugin(
34937
+ /**
34938
+ * New value for property `enabledMultiSelectionPlugin`
34939
+ */
34940
+ bEnabledMultiSelectionPlugin?: boolean
34941
+ ): this;
34511
34942
  /**
34512
34943
  * @SINCE 1.24
34513
34944
  *
@@ -34672,7 +35103,7 @@ declare namespace sap {
34672
35103
  /**
34673
35104
  * An array of range KeyFields `[{key: "CompanyCode", label: "ID"}, {key:"CompanyName", label : "Name"}]`
34674
35105
  */
34675
- aRangeKeyFields: object[]
35106
+ aRangeKeyFields: Record<string, Object[]>
34676
35107
  ): void;
34677
35108
  /**
34678
35109
  * @SINCE 1.24
@@ -34741,7 +35172,12 @@ declare namespace sap {
34741
35172
  /**
34742
35173
  * The used table control instance
34743
35174
  */
34744
- oTable: object
35175
+ oTable: Record<
35176
+ string,
35177
+ | sap.m.Table
35178
+ | sap.ui.table.Table
35179
+ | sap.ui.comp.smarttable.SmartTable
35180
+ >
34745
35181
  ): void;
34746
35182
  /**
34747
35183
  * @SINCE 1.24
@@ -35671,6 +36107,8 @@ declare namespace sap {
35671
36107
  oListener?: object
35672
36108
  ): this;
35673
36109
  /**
36110
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
36111
+ *
35674
36112
  * Fires event {@link #event:change change} to attached listeners.
35675
36113
  *
35676
36114
  * @returns Reference to `this` in order to allow method chaining
@@ -36275,6 +36713,7 @@ declare namespace sap {
36275
36713
  ): this;
36276
36714
  /**
36277
36715
  * @SINCE 1.22.0
36716
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
36278
36717
  *
36279
36718
  * Fires event {@link #event:manage manage} to attached listeners.
36280
36719
  *
@@ -36306,6 +36745,7 @@ declare namespace sap {
36306
36745
  ): this;
36307
36746
  /**
36308
36747
  * @SINCE 1.22.0
36748
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
36309
36749
  *
36310
36750
  * Fires event {@link #event:save save} to attached listeners.
36311
36751
  *
@@ -36352,6 +36792,7 @@ declare namespace sap {
36352
36792
  ): this;
36353
36793
  /**
36354
36794
  * @SINCE 1.22.0
36795
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
36355
36796
  *
36356
36797
  * Fires event {@link #event:select select} to attached listeners.
36357
36798
  *
@@ -36437,6 +36878,8 @@ declare namespace sap {
36437
36878
  */
36438
36879
  getLifecycleSupport(): boolean;
36439
36880
  /**
36881
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
36882
+ *
36440
36883
  * Required by the {@link sap.m.IOverflowToolbarContent} interface. Registers invalidations event which
36441
36884
  * is fired when width of the control is changed.
36442
36885
  *