@sapui5/ts-types 1.120.7 → 1.121.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (65) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +1 -0
  3. package/types/sap.apf.d.ts +50 -18
  4. package/types/sap.ca.ui.d.ts +1114 -546
  5. package/types/sap.chart.d.ts +191 -43
  6. package/types/sap.collaboration.d.ts +185 -64
  7. package/types/sap.esh.search.ui.d.ts +2 -1960
  8. package/types/sap.f.d.ts +1607 -886
  9. package/types/sap.fe.core.d.ts +212 -191
  10. package/types/sap.fe.macros.d.ts +371 -531
  11. package/types/sap.fe.navigation.d.ts +59 -26
  12. package/types/sap.fe.placeholder.d.ts +1 -1
  13. package/types/sap.fe.plugins.managecache.d.ts +7 -0
  14. package/types/sap.fe.templates.d.ts +16 -11
  15. package/types/sap.fe.test.d.ts +333 -33
  16. package/types/sap.fe.tools.d.ts +1 -1
  17. package/types/sap.feedback.ui.d.ts +1 -1
  18. package/types/sap.gantt.d.ts +3947 -1754
  19. package/types/sap.insights.d.ts +162 -43
  20. package/types/sap.m.d.ts +14867 -8374
  21. package/types/sap.makit.d.ts +379 -187
  22. package/types/sap.me.d.ts +237 -37
  23. package/types/sap.ndc.d.ts +40 -9
  24. package/types/sap.ovp.d.ts +9 -7
  25. package/types/sap.rules.ui.d.ts +134 -75
  26. package/types/sap.sac.df.d.ts +272 -49
  27. package/types/sap.suite.ui.commons.d.ts +4231 -1008
  28. package/types/sap.suite.ui.generic.template.d.ts +236 -171
  29. package/types/sap.suite.ui.microchart.d.ts +1027 -388
  30. package/types/sap.tnt.d.ts +827 -247
  31. package/types/sap.ui.codeeditor.d.ts +57 -24
  32. package/types/sap.ui.commons.d.ts +2075 -673
  33. package/types/sap.ui.comp.d.ts +3908 -2995
  34. package/types/sap.ui.core.d.ts +5739 -3520
  35. package/types/sap.ui.dt.d.ts +1 -1
  36. package/types/sap.ui.export.d.ts +88 -67
  37. package/types/sap.ui.fl.d.ts +169 -104
  38. package/types/sap.ui.generic.app.d.ts +250 -193
  39. package/types/sap.ui.generic.template.d.ts +1 -1
  40. package/types/sap.ui.integration.d.ts +494 -388
  41. package/types/sap.ui.layout.d.ts +1345 -668
  42. package/types/sap.ui.mdc.d.ts +3395 -2036
  43. package/types/sap.ui.richtexteditor.d.ts +115 -55
  44. package/types/sap.ui.rta.d.ts +7 -7
  45. package/types/sap.ui.suite.d.ts +46 -12
  46. package/types/sap.ui.support.d.ts +58 -26
  47. package/types/sap.ui.table.d.ts +963 -627
  48. package/types/sap.ui.testrecorder.d.ts +1 -1
  49. package/types/sap.ui.unified.d.ts +1979 -1249
  50. package/types/sap.ui.ux3.d.ts +1311 -491
  51. package/types/sap.ui.vbm.d.ts +5300 -2517
  52. package/types/sap.ui.vk.d.ts +2742 -836
  53. package/types/sap.ui.vtm.d.ts +685 -215
  54. package/types/sap.ui.webc.common.d.ts +11 -9
  55. package/types/sap.ui.webc.fiori.d.ts +884 -213
  56. package/types/sap.ui.webc.main.d.ts +2815 -601
  57. package/types/sap.uiext.inbox.d.ts +207 -36
  58. package/types/sap.ushell.d.ts +1954 -1270
  59. package/types/sap.ushell_abap.d.ts +1 -1
  60. package/types/sap.uxap.d.ts +626 -321
  61. package/types/sap.viz.d.ts +4324 -2527
  62. package/types/sap.webanalytics.core.d.ts +1 -1
  63. package/types/sap.zen.commons.d.ts +79 -18
  64. package/types/sap.zen.crosstab.d.ts +83 -15
  65. package/types/sap.zen.dsh.d.ts +194 -143
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.7
1
+ // For Library Version: 1.121.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -17,9 +17,9 @@ declare namespace sap {
17
17
  interface $VariantManagementSettings
18
18
  extends sap.ui.core.$ControlSettings {
19
19
  /**
20
- * Determines the intention of setting the current variant based on passed information. **Note:** The
21
- * `VariantManagement` control does not react in any way to this property. It is used internally by the
22
- * flexibility layer.
20
+ * Indicates whether the current variant is updated based on the passed information in the URL. **Note:**
21
+ * The `VariantManagement` control itself is not affected by this property. It is only used internally by
22
+ * the SAPUI5 flexibility layer.
23
23
  */
24
24
  updateVariantInURL?:
25
25
  | boolean
@@ -27,9 +27,9 @@ declare namespace sap {
27
27
  | `{${string}}`;
28
28
 
29
29
  /**
30
- * When set to `false`, doesn't reset the `VariantManagement` control to the default variant, when its binding
31
- * context is changed. **Note:** The `VariantManagement` control does not react in any way to this property.
32
- * It is used internally by the flexibility layer.
30
+ * If set to `false`, it does not reset the `VariantManagement` control to the default variant if its binding
31
+ * context is changed. **Note:** The `VariantManagement` control itself is not affected by this property.
32
+ * It is only used internally by the SAPUI5 flexibility layer.
33
33
  */
34
34
  resetOnContextChange?:
35
35
  | boolean
@@ -42,7 +42,7 @@ declare namespace sap {
42
42
  modelName?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
43
43
 
44
44
  /**
45
- * Indicated if the buttons on the 'My Views' are visible.
45
+ * Indicates whether the buttons on My Views are visible.
46
46
  */
47
47
  editable?:
48
48
  | boolean
@@ -50,7 +50,8 @@ declare namespace sap {
50
50
  | `{${string}}`;
51
51
 
52
52
  /**
53
- * Indicated if the defaulting functionality is enabled.
53
+ * Indicates whether the functionality of setting a default variant is enabled. The Default column in Manage
54
+ * Views and the Set as Default checkbox in Save View will be disabled if set to `false`.
54
55
  */
55
56
  showSetAsDefault?:
56
57
  | boolean
@@ -58,8 +59,8 @@ declare namespace sap {
58
59
  | `{${string}}`;
59
60
 
60
61
  /**
61
- * Indicates that the control is in error state. If set to `true`, an error message will be displayed whenever
62
- * the variant is opened.
62
+ * Indicates whether the control is in error state. If set to `true`, an error message will be displayed
63
+ * when the variant is opened.
63
64
  */
64
65
  inErrorState?:
65
66
  | boolean
@@ -76,7 +77,7 @@ declare namespace sap {
76
77
 
77
78
  /**
78
79
  * Defines the Apply Automatically text for the standard variant in the Manage Views dialog if the application
79
- * controls this behavior. **Note:** the usage of this property is restricted to `sap.fe` components
80
+ * controls this behavior. **Note:** The usage of this property is restricted to `sap.fe` components
80
81
  * only.
81
82
  */
82
83
  displayTextForExecuteOnSelectionForStandardVariant?:
@@ -84,9 +85,9 @@ declare namespace sap {
84
85
  | sap.ui.base.ManagedObject.PropertyBindingInfo;
85
86
 
86
87
  /**
87
- * @since 1.104
88
- *
89
88
  * Semantic level of the header. For more information, see {@link sap.m.Title#setLevel}.
89
+ *
90
+ * @since 1.104
90
91
  */
91
92
  headerLevel?:
92
93
  | sap.ui.core.TitleLevel
@@ -94,9 +95,9 @@ declare namespace sap {
94
95
  | `{${string}}`;
95
96
 
96
97
  /**
97
- * @since 1.109
98
- *
99
98
  * Defines the style of the title. For more information, see {@link sap.m.Title#setTitleStyle}.
99
+ *
100
+ * @since 1.109
100
101
  */
101
102
  titleStyle?:
102
103
  | sap.ui.core.TitleLevel
@@ -104,9 +105,9 @@ declare namespace sap {
104
105
  | `{${string}}`;
105
106
 
106
107
  /**
107
- * @since 1.109
108
- *
109
108
  * Sets the maximum width of the control.
109
+ *
110
+ * @since 1.109
110
111
  */
111
112
  maxWidth?:
112
113
  | sap.ui.core.CSSSize
@@ -114,7 +115,7 @@ declare namespace sap {
114
115
  | `{${string}}`;
115
116
 
116
117
  /**
117
- * Contains the ids of the controls for which the variant management is responsible.
118
+ * Contains the IDs of the relevant controls for which the variant management is used.
118
119
  */
119
120
  for?: Array<sap.ui.core.Control | string>;
120
121
 
@@ -124,13 +125,12 @@ declare namespace sap {
124
125
  initialized?: (oEvent: sap.ui.base.Event) => void;
125
126
 
126
127
  /**
127
- * This event is fired when the Save View dialog or the Save As dialog is closed with the
128
- * save button.
128
+ * This event is fired when the Save View dialog or the Save As dialog is closed with the Save button.
129
129
  */
130
130
  save?: (oEvent: VariantManagement$SaveEvent) => void;
131
131
 
132
132
  /**
133
- * This event is fired when users presses the cancel button inside Save As dialog.
133
+ * This event is fired when users press the Cancel button inside the Save As dialog.
134
134
  */
135
135
  cancel?: (oEvent: sap.ui.base.Event) => void;
136
136
 
@@ -151,8 +151,8 @@ declare namespace sap {
151
151
 
152
152
  interface VariantManagement$ManageEventParameters {
153
153
  /**
154
- * List of changed variants. Each entry contains a 'key' - the variant key and a 'name' - the new title
155
- * of the variant
154
+ * List of changed variants. Each entry contains a `key` (the variant key) and a `name` (the new title of
155
+ * the variant).
156
156
  */
157
157
  renamed?: object[];
158
158
 
@@ -162,14 +162,28 @@ declare namespace sap {
162
162
  deleted?: string[];
163
163
 
164
164
  /**
165
- * List of variant keys and the associated Execute on Selection indicator
165
+ * List of variant keys and the associated Execute on Selection indicator. Each entry contains a `key` (the
166
+ * variant key) and an `exe` flag describing the intention.
166
167
  */
167
168
  exe?: object[];
168
169
 
170
+ /**
171
+ * List of variant keys and the associated favorite indicator. Each entry contains a `key` (the variant
172
+ * key) and a `visible` flag describing the intention.
173
+ */
174
+ fav?: object[];
175
+
169
176
  /**
170
177
  * The default variant key
171
178
  */
172
179
  def?: string;
180
+
181
+ /**
182
+ * List of variant keys and the associated contexts array. Each entry contains a `key` (the variant key)
183
+ * and a `contexts` array describing the contexts. **Note:** It is only used internally by the SAPUI5 flexibility
184
+ * layer.
185
+ */
186
+ contexts?: object[];
173
187
  }
174
188
 
175
189
  interface VariantManagement$SaveEventParameters {
@@ -179,12 +193,12 @@ declare namespace sap {
179
193
  name?: string;
180
194
 
181
195
  /**
182
- * Indicates if an existing variant is overwritten or if a new variant is created.
196
+ * Indicates whether an existing variant is overwritten or whether a new variant is created
183
197
  */
184
198
  overwrite?: boolean;
185
199
 
186
200
  /**
187
- * Variant key
201
+ * Variant key. This property is set if `overwrite` is set to `true`.
188
202
  */
189
203
  key?: string;
190
204
 
@@ -194,7 +208,7 @@ declare namespace sap {
194
208
  execute?: boolean;
195
209
 
196
210
  /**
197
- * Indicates the check box state for 'Public'.
211
+ * Indicates the checkbox state for Public
198
212
  */
199
213
  public?: boolean;
200
214
 
@@ -204,9 +218,12 @@ declare namespace sap {
204
218
  def?: boolean;
205
219
 
206
220
  /**
207
- * Indicates the check box state for 'Create Tile'.
208
- * Note:
209
- * This event parameter is used only internally.
221
+ * Array describing the contexts. **Note:** It is only used internally by the SAPUI5 flexibility layer.
222
+ */
223
+ contexts?: object[];
224
+
225
+ /**
226
+ * Indicates the checkbox state for Create Tile **Note:** This event parameter is used only internally.
210
227
  */
211
228
  tile?: boolean;
212
229
  }
@@ -219,11 +236,11 @@ declare namespace sap {
219
236
  }
220
237
 
221
238
  /**
222
- * @since 1.56
223
- *
224
239
  * Can be used to manage variants. You can use this control in most controls that are enabled for key
225
240
  * user adaptation.
226
241
  * **Note: **On the user interface, variants are generally referred to as "views".
242
+ *
243
+ * @since 1.56
227
244
  */
228
245
  class VariantManagement
229
246
  extends sap.ui.core.Control
@@ -275,6 +292,7 @@ declare namespace sap {
275
292
  *
276
293
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
277
294
  *
295
+ *
278
296
  * @returns Created class / constructor function
279
297
  */
280
298
  static extend<T extends Record<string, unknown>>(
@@ -295,12 +313,14 @@ declare namespace sap {
295
313
  /**
296
314
  * Returns a metadata object for class sap.ui.fl.variants.VariantManagement.
297
315
  *
316
+ *
298
317
  * @returns Metadata object describing this class
299
318
  */
300
319
  static getMetadata(): sap.ui.core.ElementMetadata;
301
320
  /**
302
321
  * Adds a control to the association {@link #for for}.
303
322
  *
323
+ *
304
324
  * @returns Reference to `this` in order to allow method chaining
305
325
  */
306
326
  addFor(
@@ -315,7 +335,8 @@ declare namespace sap {
315
335
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
316
336
  * otherwise it will be bound to this `sap.ui.fl.variants.VariantManagement` itself.
317
337
  *
318
- * This event is fired when users presses the cancel button inside Save As dialog.
338
+ * This event is fired when users press the Cancel button inside the Save As dialog.
339
+ *
319
340
  *
320
341
  * @returns Reference to `this` in order to allow method chaining
321
342
  */
@@ -341,7 +362,8 @@ declare namespace sap {
341
362
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
342
363
  * otherwise it will be bound to this `sap.ui.fl.variants.VariantManagement` itself.
343
364
  *
344
- * This event is fired when users presses the cancel button inside Save As dialog.
365
+ * This event is fired when users press the Cancel button inside the Save As dialog.
366
+ *
345
367
  *
346
368
  * @returns Reference to `this` in order to allow method chaining
347
369
  */
@@ -364,6 +386,7 @@ declare namespace sap {
364
386
  *
365
387
  * This event is fired when the model and context are set.
366
388
  *
389
+ *
367
390
  * @returns Reference to `this` in order to allow method chaining
368
391
  */
369
392
  attachInitialized(
@@ -390,6 +413,7 @@ declare namespace sap {
390
413
  *
391
414
  * This event is fired when the model and context are set.
392
415
  *
416
+ *
393
417
  * @returns Reference to `this` in order to allow method chaining
394
418
  */
395
419
  attachInitialized(
@@ -411,6 +435,7 @@ declare namespace sap {
411
435
  *
412
436
  * This event is fired when users apply changes to variants in the Manage Views dialog.
413
437
  *
438
+ *
414
439
  * @returns Reference to `this` in order to allow method chaining
415
440
  */
416
441
  attachManage(
@@ -437,6 +462,7 @@ declare namespace sap {
437
462
  *
438
463
  * This event is fired when users apply changes to variants in the Manage Views dialog.
439
464
  *
465
+ *
440
466
  * @returns Reference to `this` in order to allow method chaining
441
467
  */
442
468
  attachManage(
@@ -456,8 +482,8 @@ declare namespace sap {
456
482
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
457
483
  * otherwise it will be bound to this `sap.ui.fl.variants.VariantManagement` itself.
458
484
  *
459
- * This event is fired when the Save View dialog or the Save As dialog is closed with the
460
- * save button.
485
+ * This event is fired when the Save View dialog or the Save As dialog is closed with the Save button.
486
+ *
461
487
  *
462
488
  * @returns Reference to `this` in order to allow method chaining
463
489
  */
@@ -483,8 +509,8 @@ declare namespace sap {
483
509
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
484
510
  * otherwise it will be bound to this `sap.ui.fl.variants.VariantManagement` itself.
485
511
  *
486
- * This event is fired when the Save View dialog or the Save As dialog is closed with the
487
- * save button.
512
+ * This event is fired when the Save View dialog or the Save As dialog is closed with the Save button.
513
+ *
488
514
  *
489
515
  * @returns Reference to `this` in order to allow method chaining
490
516
  */
@@ -507,6 +533,7 @@ declare namespace sap {
507
533
  *
508
534
  * This event is fired when a new variant is selected.
509
535
  *
536
+ *
510
537
  * @returns Reference to `this` in order to allow method chaining
511
538
  */
512
539
  attachSelect(
@@ -533,6 +560,7 @@ declare namespace sap {
533
560
  *
534
561
  * This event is fired when a new variant is selected.
535
562
  *
563
+ *
536
564
  * @returns Reference to `this` in order to allow method chaining
537
565
  */
538
566
  attachSelect(
@@ -551,6 +579,7 @@ declare namespace sap {
551
579
  *
552
580
  * The passed function and listener object must match the ones used for event registration.
553
581
  *
582
+ *
554
583
  * @returns Reference to `this` in order to allow method chaining
555
584
  */
556
585
  detachCancel(
@@ -568,6 +597,7 @@ declare namespace sap {
568
597
  *
569
598
  * The passed function and listener object must match the ones used for event registration.
570
599
  *
600
+ *
571
601
  * @returns Reference to `this` in order to allow method chaining
572
602
  */
573
603
  detachInitialized(
@@ -585,6 +615,7 @@ declare namespace sap {
585
615
  *
586
616
  * The passed function and listener object must match the ones used for event registration.
587
617
  *
618
+ *
588
619
  * @returns Reference to `this` in order to allow method chaining
589
620
  */
590
621
  detachManage(
@@ -602,6 +633,7 @@ declare namespace sap {
602
633
  *
603
634
  * The passed function and listener object must match the ones used for event registration.
604
635
  *
636
+ *
605
637
  * @returns Reference to `this` in order to allow method chaining
606
638
  */
607
639
  detachSave(
@@ -619,6 +651,7 @@ declare namespace sap {
619
651
  *
620
652
  * The passed function and listener object must match the ones used for event registration.
621
653
  *
654
+ *
622
655
  * @returns Reference to `this` in order to allow method chaining
623
656
  */
624
657
  detachSelect(
@@ -632,10 +665,10 @@ declare namespace sap {
632
665
  oListener?: object
633
666
  ): this;
634
667
  /**
635
- * @ui5-protected Do not call from applications (only from related classes in the framework)
636
- *
637
668
  * Fires event {@link #event:cancel cancel} to attached listeners.
638
669
  *
670
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
671
+ *
639
672
  * @returns Reference to `this` in order to allow method chaining
640
673
  */
641
674
  fireCancel(
@@ -645,10 +678,10 @@ declare namespace sap {
645
678
  mParameters?: object
646
679
  ): this;
647
680
  /**
648
- * @ui5-protected Do not call from applications (only from related classes in the framework)
649
- *
650
681
  * Fires event {@link #event:initialized initialized} to attached listeners.
651
682
  *
683
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
684
+ *
652
685
  * @returns Reference to `this` in order to allow method chaining
653
686
  */
654
687
  fireInitialized(
@@ -658,10 +691,10 @@ declare namespace sap {
658
691
  mParameters?: object
659
692
  ): this;
660
693
  /**
661
- * @ui5-protected Do not call from applications (only from related classes in the framework)
662
- *
663
694
  * Fires event {@link #event:manage manage} to attached listeners.
664
695
  *
696
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
697
+ *
665
698
  * @returns Reference to `this` in order to allow method chaining
666
699
  */
667
700
  fireManage(
@@ -671,10 +704,10 @@ declare namespace sap {
671
704
  mParameters?: sap.ui.fl.variants.VariantManagement$ManageEventParameters
672
705
  ): this;
673
706
  /**
674
- * @ui5-protected Do not call from applications (only from related classes in the framework)
675
- *
676
707
  * Fires event {@link #event:save save} to attached listeners.
677
708
  *
709
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
710
+ *
678
711
  * @returns Reference to `this` in order to allow method chaining
679
712
  */
680
713
  fireSave(
@@ -684,10 +717,10 @@ declare namespace sap {
684
717
  mParameters?: sap.ui.fl.variants.VariantManagement$SaveEventParameters
685
718
  ): this;
686
719
  /**
687
- * @ui5-protected Do not call from applications (only from related classes in the framework)
688
- *
689
720
  * Fires event {@link #event:select select} to attached listeners.
690
721
  *
722
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
723
+ *
691
724
  * @returns Reference to `this` in order to allow method chaining
692
725
  */
693
726
  fireSelect(
@@ -699,28 +732,31 @@ declare namespace sap {
699
732
  /**
700
733
  * Gets the currently selected variant key.
701
734
  *
702
- * @returns Key of the currently selected variant. In case the model is not yet set `null` will be returned.
735
+ *
736
+ * @returns Key of the currently selected variant. In case the model is not yet set `null` will be returned
703
737
  */
704
738
  getCurrentVariantKey(): string | null;
705
739
  /**
706
740
  * Gets current value of property {@link #getDisplayTextForExecuteOnSelectionForStandardVariant displayTextForExecuteOnSelectionForStandardVariant}.
707
741
  *
708
742
  * Defines the Apply Automatically text for the standard variant in the Manage Views dialog if the application
709
- * controls this behavior. **Note:** the usage of this property is restricted to `sap.fe` components
743
+ * controls this behavior. **Note:** The usage of this property is restricted to `sap.fe` components
710
744
  * only.
711
745
  *
712
746
  * Default value is `empty string`.
713
747
  *
748
+ *
714
749
  * @returns Value of property `displayTextForExecuteOnSelectionForStandardVariant`
715
750
  */
716
751
  getDisplayTextForExecuteOnSelectionForStandardVariant(): string;
717
752
  /**
718
753
  * Gets current value of property {@link #getEditable editable}.
719
754
  *
720
- * Indicated if the buttons on the 'My Views' are visible.
755
+ * Indicates whether the buttons on My Views are visible.
721
756
  *
722
757
  * Default value is `true`.
723
758
  *
759
+ *
724
760
  * @returns Value of property `editable`
725
761
  */
726
762
  getEditable(): boolean;
@@ -731,6 +767,7 @@ declare namespace sap {
731
767
  *
732
768
  * Default value is `false`.
733
769
  *
770
+ *
734
771
  * @returns Value of property `executeOnSelectionForStandardDefault`
735
772
  */
736
773
  getExecuteOnSelectionForStandardDefault(): boolean;
@@ -739,37 +776,38 @@ declare namespace sap {
739
776
  */
740
777
  getFor(): sap.ui.core.ID[];
741
778
  /**
742
- * @since 1.104
743
- *
744
779
  * Gets current value of property {@link #getHeaderLevel headerLevel}.
745
780
  *
746
781
  * Semantic level of the header. For more information, see {@link sap.m.Title#setLevel}.
747
782
  *
748
783
  * Default value is `Auto`.
749
784
  *
785
+ * @since 1.104
786
+ *
750
787
  * @returns Value of property `headerLevel`
751
788
  */
752
789
  getHeaderLevel(): sap.ui.core.TitleLevel;
753
790
  /**
754
791
  * Gets current value of property {@link #getInErrorState inErrorState}.
755
792
  *
756
- * Indicates that the control is in error state. If set to `true`, an error message will be displayed whenever
757
- * the variant is opened.
793
+ * Indicates whether the control is in error state. If set to `true`, an error message will be displayed
794
+ * when the variant is opened.
758
795
  *
759
796
  * Default value is `false`.
760
797
  *
798
+ *
761
799
  * @returns Value of property `inErrorState`
762
800
  */
763
801
  getInErrorState(): boolean;
764
802
  /**
765
- * @since 1.109
766
- *
767
803
  * Gets current value of property {@link #getMaxWidth maxWidth}.
768
804
  *
769
805
  * Sets the maximum width of the control.
770
806
  *
771
807
  * Default value is `"100%"`.
772
808
  *
809
+ * @since 1.109
810
+ *
773
811
  * @returns Value of property `maxWidth`
774
812
  */
775
813
  getMaxWidth(): sap.ui.core.CSSSize;
@@ -780,22 +818,24 @@ declare namespace sap {
780
818
  *
781
819
  * Default value is `empty string`.
782
820
  *
821
+ *
783
822
  * @returns Value of property `modelName`
784
823
  */
785
824
  getModelName(): string;
786
825
  /**
787
- * Determines if the current variant is modified.
826
+ * Determines whether the current variant is modified.
788
827
  *
789
- * @returns If the current variant is modified `true`, otherwise `false`
828
+ *
829
+ * @returns Returns `true`, if the current variant is modified, otherwise `false`
790
830
  */
791
831
  getModified(): boolean;
792
832
  /**
793
- * @ui5-protected Do not call from applications (only from related classes in the framework)
833
+ * Registers an invalidation event that is fired when the width of the control is changed. **Note:** This
834
+ * is required by the {@link sap.m.IOverflowToolbarContent} interface.
794
835
  *
795
- * Required by the {@link sap.m.IOverflowToolbarContent} interface. Registers invalidations event which
796
- * is fired when width of the control is changed.
836
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
797
837
  *
798
- * @returns Configuration information for the `sap.m.IOverflowToolbarContent` interface.
838
+ * @returns Configuration information for the {@link sap.m.IOverflowToolbarContent} interface
799
839
  */
800
840
  getOverflowToolbarConfig(): {
801
841
  canOverflow: boolean;
@@ -805,64 +845,71 @@ declare namespace sap {
805
845
  /**
806
846
  * Gets current value of property {@link #getResetOnContextChange resetOnContextChange}.
807
847
  *
808
- * When set to `false`, doesn't reset the `VariantManagement` control to the default variant, when its binding
809
- * context is changed. **Note:** The `VariantManagement` control does not react in any way to this property.
810
- * It is used internally by the flexibility layer.
848
+ * If set to `false`, it does not reset the `VariantManagement` control to the default variant if its binding
849
+ * context is changed. **Note:** The `VariantManagement` control itself is not affected by this property.
850
+ * It is only used internally by the SAPUI5 flexibility layer.
811
851
  *
812
852
  * Default value is `true`.
813
853
  *
854
+ *
814
855
  * @returns Value of property `resetOnContextChange`
815
856
  */
816
857
  getResetOnContextChange(): boolean;
817
858
  /**
818
859
  * Gets current value of property {@link #getShowSetAsDefault showSetAsDefault}.
819
860
  *
820
- * Indicated if the defaulting functionality is enabled.
861
+ * Indicates whether the functionality of setting a default variant is enabled. The Default column in Manage
862
+ * Views and the Set as Default checkbox in Save View will be disabled if set to `false`.
821
863
  *
822
864
  * Default value is `true`.
823
865
  *
866
+ *
824
867
  * @returns Value of property `showSetAsDefault`
825
868
  */
826
869
  getShowSetAsDefault(): boolean;
827
870
  /**
828
- * @since 1.109
829
- *
830
871
  * Gets current value of property {@link #getTitleStyle titleStyle}.
831
872
  *
832
873
  * Defines the style of the title. For more information, see {@link sap.m.Title#setTitleStyle}.
833
874
  *
834
875
  * Default value is `Auto`.
835
876
  *
877
+ * @since 1.109
878
+ *
836
879
  * @returns Value of property `titleStyle`
837
880
  */
838
881
  getTitleStyle(): sap.ui.core.TitleLevel;
839
882
  /**
840
883
  * Gets current value of property {@link #getUpdateVariantInURL updateVariantInURL}.
841
884
  *
842
- * Determines the intention of setting the current variant based on passed information. **Note:** The
843
- * `VariantManagement` control does not react in any way to this property. It is used internally by the
844
- * flexibility layer.
885
+ * Indicates whether the current variant is updated based on the passed information in the URL. **Note:**
886
+ * The `VariantManagement` control itself is not affected by this property. It is only used internally by
887
+ * the SAPUI5 flexibility layer.
845
888
  *
846
889
  * Default value is `false`.
847
890
  *
891
+ *
848
892
  * @returns Value of property `updateVariantInURL`
849
893
  */
850
894
  getUpdateVariantInURL(): boolean;
851
895
  /**
852
- * Retrieves all variants.
896
+ * Gets all variants.
853
897
  *
854
- * @returns All variants. In case the model is not yet set, an empty array will be returned.
898
+ *
899
+ * @returns All variants; if the model is not yet set, an empty array will be returned.
855
900
  */
856
901
  getVariants(): any[];
857
902
  /**
858
903
  * Removes all the controls in the association named {@link #getFor for}.
859
904
  *
905
+ *
860
906
  * @returns An array of the removed elements (might be empty)
861
907
  */
862
908
  removeAllFor(): sap.ui.core.ID[];
863
909
  /**
864
910
  * Removes an for from the association named {@link #getFor for}.
865
911
  *
912
+ *
866
913
  * @returns The removed for or `null`
867
914
  */
868
915
  removeFor(
@@ -876,7 +923,7 @@ declare namespace sap {
876
923
  */
877
924
  setCurrentVariantKey(
878
925
  /**
879
- * Key of the variant that should be selected.
926
+ * Key of the variant that is selected
880
927
  */
881
928
  sKey: string
882
929
  ): void;
@@ -884,13 +931,14 @@ declare namespace sap {
884
931
  * Sets a new value for property {@link #getDisplayTextForExecuteOnSelectionForStandardVariant displayTextForExecuteOnSelectionForStandardVariant}.
885
932
  *
886
933
  * Defines the Apply Automatically text for the standard variant in the Manage Views dialog if the application
887
- * controls this behavior. **Note:** the usage of this property is restricted to `sap.fe` components
934
+ * controls this behavior. **Note:** The usage of this property is restricted to `sap.fe` components
888
935
  * only.
889
936
  *
890
937
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
891
938
  *
892
939
  * Default value is `empty string`.
893
940
  *
941
+ *
894
942
  * @returns Reference to `this` in order to allow method chaining
895
943
  */
896
944
  setDisplayTextForExecuteOnSelectionForStandardVariant(
@@ -902,12 +950,13 @@ declare namespace sap {
902
950
  /**
903
951
  * Sets a new value for property {@link #getEditable editable}.
904
952
  *
905
- * Indicated if the buttons on the 'My Views' are visible.
953
+ * Indicates whether the buttons on My Views are visible.
906
954
  *
907
955
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
908
956
  *
909
957
  * Default value is `true`.
910
958
  *
959
+ *
911
960
  * @returns Reference to `this` in order to allow method chaining
912
961
  */
913
962
  setEditable(
@@ -925,6 +974,7 @@ declare namespace sap {
925
974
  *
926
975
  * Default value is `false`.
927
976
  *
977
+ *
928
978
  * @returns Reference to `this` in order to allow method chaining
929
979
  */
930
980
  setExecuteOnSelectionForStandardDefault(
@@ -934,8 +984,6 @@ declare namespace sap {
934
984
  bExecuteOnSelectionForStandardDefault?: boolean
935
985
  ): this;
936
986
  /**
937
- * @since 1.104
938
- *
939
987
  * Sets a new value for property {@link #getHeaderLevel headerLevel}.
940
988
  *
941
989
  * Semantic level of the header. For more information, see {@link sap.m.Title#setLevel}.
@@ -944,6 +992,8 @@ declare namespace sap {
944
992
  *
945
993
  * Default value is `Auto`.
946
994
  *
995
+ * @since 1.104
996
+ *
947
997
  * @returns Reference to `this` in order to allow method chaining
948
998
  */
949
999
  setHeaderLevel(
@@ -955,13 +1005,14 @@ declare namespace sap {
955
1005
  /**
956
1006
  * Sets a new value for property {@link #getInErrorState inErrorState}.
957
1007
  *
958
- * Indicates that the control is in error state. If set to `true`, an error message will be displayed whenever
959
- * the variant is opened.
1008
+ * Indicates whether the control is in error state. If set to `true`, an error message will be displayed
1009
+ * when the variant is opened.
960
1010
  *
961
1011
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
962
1012
  *
963
1013
  * Default value is `false`.
964
1014
  *
1015
+ *
965
1016
  * @returns Reference to `this` in order to allow method chaining
966
1017
  */
967
1018
  setInErrorState(
@@ -971,8 +1022,6 @@ declare namespace sap {
971
1022
  bInErrorState?: boolean
972
1023
  ): this;
973
1024
  /**
974
- * @since 1.109
975
- *
976
1025
  * Sets a new value for property {@link #getMaxWidth maxWidth}.
977
1026
  *
978
1027
  * Sets the maximum width of the control.
@@ -981,6 +1030,8 @@ declare namespace sap {
981
1030
  *
982
1031
  * Default value is `"100%"`.
983
1032
  *
1033
+ * @since 1.109
1034
+ *
984
1035
  * @returns Reference to `this` in order to allow method chaining
985
1036
  */
986
1037
  setMaxWidth(
@@ -998,6 +1049,7 @@ declare namespace sap {
998
1049
  *
999
1050
  * Default value is `empty string`.
1000
1051
  *
1052
+ *
1001
1053
  * @returns Reference to `this` in order to allow method chaining
1002
1054
  */
1003
1055
  setModelName(
@@ -1009,14 +1061,15 @@ declare namespace sap {
1009
1061
  /**
1010
1062
  * Sets a new value for property {@link #getResetOnContextChange resetOnContextChange}.
1011
1063
  *
1012
- * When set to `false`, doesn't reset the `VariantManagement` control to the default variant, when its binding
1013
- * context is changed. **Note:** The `VariantManagement` control does not react in any way to this property.
1014
- * It is used internally by the flexibility layer.
1064
+ * If set to `false`, it does not reset the `VariantManagement` control to the default variant if its binding
1065
+ * context is changed. **Note:** The `VariantManagement` control itself is not affected by this property.
1066
+ * It is only used internally by the SAPUI5 flexibility layer.
1015
1067
  *
1016
1068
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1017
1069
  *
1018
1070
  * Default value is `true`.
1019
1071
  *
1072
+ *
1020
1073
  * @returns Reference to `this` in order to allow method chaining
1021
1074
  */
1022
1075
  setResetOnContextChange(
@@ -1028,12 +1081,14 @@ declare namespace sap {
1028
1081
  /**
1029
1082
  * Sets a new value for property {@link #getShowSetAsDefault showSetAsDefault}.
1030
1083
  *
1031
- * Indicated if the defaulting functionality is enabled.
1084
+ * Indicates whether the functionality of setting a default variant is enabled. The Default column in Manage
1085
+ * Views and the Set as Default checkbox in Save View will be disabled if set to `false`.
1032
1086
  *
1033
1087
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1034
1088
  *
1035
1089
  * Default value is `true`.
1036
1090
  *
1091
+ *
1037
1092
  * @returns Reference to `this` in order to allow method chaining
1038
1093
  */
1039
1094
  setShowSetAsDefault(
@@ -1043,8 +1098,6 @@ declare namespace sap {
1043
1098
  bShowSetAsDefault?: boolean
1044
1099
  ): this;
1045
1100
  /**
1046
- * @since 1.109
1047
- *
1048
1101
  * Sets a new value for property {@link #getTitleStyle titleStyle}.
1049
1102
  *
1050
1103
  * Defines the style of the title. For more information, see {@link sap.m.Title#setTitleStyle}.
@@ -1053,6 +1106,8 @@ declare namespace sap {
1053
1106
  *
1054
1107
  * Default value is `Auto`.
1055
1108
  *
1109
+ * @since 1.109
1110
+ *
1056
1111
  * @returns Reference to `this` in order to allow method chaining
1057
1112
  */
1058
1113
  setTitleStyle(
@@ -1064,14 +1119,15 @@ declare namespace sap {
1064
1119
  /**
1065
1120
  * Sets a new value for property {@link #getUpdateVariantInURL updateVariantInURL}.
1066
1121
  *
1067
- * Determines the intention of setting the current variant based on passed information. **Note:** The
1068
- * `VariantManagement` control does not react in any way to this property. It is used internally by the
1069
- * flexibility layer.
1122
+ * Indicates whether the current variant is updated based on the passed information in the URL. **Note:**
1123
+ * The `VariantManagement` control itself is not affected by this property. It is only used internally by
1124
+ * the SAPUI5 flexibility layer.
1070
1125
  *
1071
1126
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1072
1127
  *
1073
1128
  * Default value is `false`.
1074
1129
  *
1130
+ *
1075
1131
  * @returns Reference to `this` in order to allow method chaining
1076
1132
  */
1077
1133
  setUpdateVariantInURL(
@@ -1118,9 +1174,9 @@ declare namespace sap {
1118
1174
  */
1119
1175
  namespace api {
1120
1176
  /**
1121
- * @since 1.70
1122
- *
1123
1177
  * Provides an API to determine which features are available for flexibility.
1178
+ *
1179
+ * @since 1.70
1124
1180
  */
1125
1181
  interface FeaturesAPI {
1126
1182
  /**
@@ -1128,6 +1184,7 @@ declare namespace sap {
1128
1184
  * to decide if the key user adaptation feature should be visible to the current user. This only applies
1129
1185
  * if key user adaptation should be handled standalone without an SAP Fiori launchpad.
1130
1186
  *
1187
+ *
1131
1188
  * @returns Resolves to a boolean indicating if the key user role is assigned to the user
1132
1189
  */
1133
1190
  isKeyUser(): Promise<boolean>;
@@ -1139,12 +1196,12 @@ declare namespace sap {
1139
1196
  interface $TransportDialogSettings extends sap.m.$DialogSettings {}
1140
1197
 
1141
1198
  /**
1142
- * @deprecated (since 1.74) - The TransportDialog should be used only internally inside the `sap.ui.fl`
1143
- * library.
1144
- *
1145
1199
  * The Transport Dialog Control can be used to implement a value help for selecting an ABAP package and
1146
1200
  * transport request. It is not a generic utility, but part of the Variantmanament and therefore cannot
1147
1201
  * be used in any other application.
1202
+ *
1203
+ * @deprecated (since 1.74) - The TransportDialog should be used only internally inside the `sap.ui.fl`
1204
+ * library.
1148
1205
  */
1149
1206
  class TransportDialog extends sap.m.Dialog {
1150
1207
  /**
@@ -1190,6 +1247,7 @@ declare namespace sap {
1190
1247
  *
1191
1248
  * `oClassInfo` might contain the same kind of information as described in {@link sap.m.Dialog.extend}.
1192
1249
  *
1250
+ *
1193
1251
  * @returns Created class / constructor function
1194
1252
  */
1195
1253
  static extend<T extends Record<string, unknown>>(
@@ -1210,6 +1268,7 @@ declare namespace sap {
1210
1268
  /**
1211
1269
  * Returns a metadata object for class sap.ui.fl.transport.TransportDialog.
1212
1270
  *
1271
+ *
1213
1272
  * @returns Metadata object describing this class
1214
1273
  */
1215
1274
  static getMetadata(): sap.ui.core.ElementMetadata;
@@ -1265,6 +1324,8 @@ declare namespace sap {
1265
1324
 
1266
1325
  "sap/ui/fl/apply/_internal/controlVariants/URLHandler": undefined;
1267
1326
 
1327
+ "sap/ui/fl/apply/_internal/extensionPoint/Registry": undefined;
1328
+
1268
1329
  "sap/ui/fl/apply/_internal/flexObjects/AppDescriptorChange": undefined;
1269
1330
 
1270
1331
  "sap/ui/fl/apply/_internal/flexObjects/CompVariant": undefined;
@@ -1287,6 +1348,8 @@ declare namespace sap {
1287
1348
 
1288
1349
  "sap/ui/fl/apply/_internal/flexState/changes/ExtensionPointState": undefined;
1289
1350
 
1351
+ "sap/ui/fl/apply/_internal/flexState/changes/UIChangesState": undefined;
1352
+
1290
1353
  "sap/ui/fl/apply/_internal/flexState/compVariants/CompVariantMerger": undefined;
1291
1354
 
1292
1355
  "sap/ui/fl/apply/_internal/flexState/controlVariants/Switcher": undefined;
@@ -1313,6 +1376,8 @@ declare namespace sap {
1313
1376
 
1314
1377
  "sap/ui/fl/apply/api/DelegateMediatorAPI": undefined;
1315
1378
 
1379
+ "sap/ui/fl/apply/api/ExtensionPointRegistryAPI": undefined;
1380
+
1316
1381
  "sap/ui/fl/apply/api/FlexRuntimeInfoAPI": undefined;
1317
1382
 
1318
1383
  "sap/ui/fl/apply/api/SmartVariantManagementApplyAPI": undefined;
@@ -1333,6 +1398,8 @@ declare namespace sap {
1333
1398
 
1334
1399
  "sap/ui/fl/initial/_internal/connectors/BackendConnector": undefined;
1335
1400
 
1401
+ "sap/ui/fl/initial/_internal/connectors/BtpServiceConnector": undefined;
1402
+
1336
1403
  "sap/ui/fl/initial/_internal/connectors/KeyUserConnector": undefined;
1337
1404
 
1338
1405
  "sap/ui/fl/initial/_internal/connectors/LrepConnector": undefined;
@@ -1357,6 +1424,8 @@ declare namespace sap {
1357
1424
 
1358
1425
  "sap/ui/fl/registry/Settings": undefined;
1359
1426
 
1427
+ "sap/ui/fl/support/_internal/getAllUIChanges": undefined;
1428
+
1360
1429
  "sap/ui/fl/support/_internal/getChangeDependencies": undefined;
1361
1430
 
1362
1431
  "sap/ui/fl/support/_internal/getFlexSettings": undefined;
@@ -1383,6 +1452,8 @@ declare namespace sap {
1383
1452
 
1384
1453
  "sap/ui/fl/write/_internal/connectors/BackendConnector": undefined;
1385
1454
 
1455
+ "sap/ui/fl/write/_internal/connectors/BtpServiceConnector": undefined;
1456
+
1386
1457
  "sap/ui/fl/write/_internal/connectors/JsObjectConnector": undefined;
1387
1458
 
1388
1459
  "sap/ui/fl/write/_internal/connectors/KeyUserConnector": undefined;
@@ -1403,8 +1474,6 @@ declare namespace sap {
1403
1474
 
1404
1475
  "sap/ui/fl/write/_internal/connectors/Utils": undefined;
1405
1476
 
1406
- "sap/ui/fl/write/_internal/extensionPoint/Registry": undefined;
1407
-
1408
1477
  "sap/ui/fl/write/_internal/fieldExtensibility/ABAPExtensibilityVariant": undefined;
1409
1478
 
1410
1479
  "sap/ui/fl/write/_internal/fieldExtensibility/MultiTenantABAPExtensibilityVariant": undefined;
@@ -1419,8 +1488,6 @@ declare namespace sap {
1419
1488
 
1420
1489
  "sap/ui/fl/write/_internal/Storage": undefined;
1421
1490
 
1422
- "sap/ui/fl/write/_internal/StorageFeaturesMerger": undefined;
1423
-
1424
1491
  "sap/ui/fl/write/_internal/Versions": undefined;
1425
1492
 
1426
1493
  "sap/ui/fl/write/api/AppVariantWriteAPI": undefined;
@@ -1435,8 +1502,6 @@ declare namespace sap {
1435
1502
 
1436
1503
  "sap/ui/fl/write/api/ControlPersonalizationWriteAPI": undefined;
1437
1504
 
1438
- "sap/ui/fl/write/api/ExtensionPointRegistryAPI": undefined;
1439
-
1440
1505
  "sap/ui/fl/write/api/FeaturesAPI": undefined;
1441
1506
 
1442
1507
  "sap/ui/fl/write/api/FieldExtensibility": undefined;