@sapui5/types 1.113.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 (66) hide show
  1. package/LICENSE.txt +35 -0
  2. package/README.md +35 -0
  3. package/package.json +23 -0
  4. package/types/index.d.ts +67 -0
  5. package/types/sap.apf.d.ts +1026 -0
  6. package/types/sap.ca.ui.d.ts +14005 -0
  7. package/types/sap.chart.d.ts +4815 -0
  8. package/types/sap.collaboration.d.ts +2704 -0
  9. package/types/sap.esh.search.ui.d.ts +1595 -0
  10. package/types/sap.f.d.ts +20085 -0
  11. package/types/sap.fe.core.d.ts +1508 -0
  12. package/types/sap.fe.macros.d.ts +975 -0
  13. package/types/sap.fe.navigation.d.ts +917 -0
  14. package/types/sap.fe.templates.d.ts +522 -0
  15. package/types/sap.fe.test.d.ts +3533 -0
  16. package/types/sap.feedback.ui.d.ts +3 -0
  17. package/types/sap.gantt.d.ts +51684 -0
  18. package/types/sap.insights.d.ts +23 -0
  19. package/types/sap.landvisz.d.ts +7952 -0
  20. package/types/sap.m.d.ts +147796 -0
  21. package/types/sap.makit.d.ts +4533 -0
  22. package/types/sap.me.d.ts +3665 -0
  23. package/types/sap.ndc.d.ts +774 -0
  24. package/types/sap.ovp.d.ts +176 -0
  25. package/types/sap.rules.ui.d.ts +1471 -0
  26. package/types/sap.sac.df.d.ts +2292 -0
  27. package/types/sap.sac.grid.d.ts +774 -0
  28. package/types/sap.suite.ui.commons.d.ts +46971 -0
  29. package/types/sap.suite.ui.generic.template.d.ts +3431 -0
  30. package/types/sap.suite.ui.microchart.d.ts +12652 -0
  31. package/types/sap.tnt.d.ts +2227 -0
  32. package/types/sap.ui.codeeditor.d.ts +693 -0
  33. package/types/sap.ui.commons.d.ts +30235 -0
  34. package/types/sap.ui.comp.d.ts +37411 -0
  35. package/types/sap.ui.core.d.ts +78872 -0
  36. package/types/sap.ui.dt.d.ts +3 -0
  37. package/types/sap.ui.export.d.ts +843 -0
  38. package/types/sap.ui.fl.d.ts +1663 -0
  39. package/types/sap.ui.generic.app.d.ts +2683 -0
  40. package/types/sap.ui.generic.template.d.ts +3 -0
  41. package/types/sap.ui.integration.d.ts +4032 -0
  42. package/types/sap.ui.layout.d.ts +14472 -0
  43. package/types/sap.ui.mdc.d.ts +476 -0
  44. package/types/sap.ui.richtexteditor.d.ts +1666 -0
  45. package/types/sap.ui.rta.d.ts +124 -0
  46. package/types/sap.ui.suite.d.ts +685 -0
  47. package/types/sap.ui.support.d.ts +453 -0
  48. package/types/sap.ui.table.d.ts +9325 -0
  49. package/types/sap.ui.testrecorder.d.ts +9 -0
  50. package/types/sap.ui.unified.d.ts +20640 -0
  51. package/types/sap.ui.ux3.d.ts +18288 -0
  52. package/types/sap.ui.vbm.d.ts +17251 -0
  53. package/types/sap.ui.vk.d.ts +42381 -0
  54. package/types/sap.ui.vtm.d.ts +10547 -0
  55. package/types/sap.ui.webc.common.d.ts +113 -0
  56. package/types/sap.ui.webc.fiori.d.ts +13850 -0
  57. package/types/sap.ui.webc.main.d.ts +40833 -0
  58. package/types/sap.uiext.inbox.d.ts +4079 -0
  59. package/types/sap.ushell.d.ts +10255 -0
  60. package/types/sap.ushell_abap.d.ts +9 -0
  61. package/types/sap.uxap.d.ts +7636 -0
  62. package/types/sap.viz.d.ts +51209 -0
  63. package/types/sap.webanalytics.core.d.ts +3 -0
  64. package/types/sap.zen.commons.d.ts +1542 -0
  65. package/types/sap.zen.crosstab.d.ts +1159 -0
  66. package/types/sap.zen.dsh.d.ts +2132 -0
@@ -0,0 +1,1663 @@
1
+ // For Library Version: 1.113.0
2
+
3
+ declare module "sap/ui/fl/library" {}
4
+
5
+ declare module "sap/ui/fl/apply/api/ControlVariantApplyAPI" {
6
+ import ManagedObject from "sap/ui/base/ManagedObject";
7
+
8
+ /**
9
+ * @SINCE 1.67
10
+ * @EXPERIMENTAL (since 1.67)
11
+ *
12
+ * Provides an API for applications to work with control variants. See also {@link sap.ui.fl.variants.VariantManagement}.
13
+ */
14
+ interface ControlVariantApplyAPI {
15
+ /**
16
+ * Activates the passed variant applicable to the passed control/component.
17
+ *
18
+ * @returns Resolves after the variant is activated or rejects if an error occurs
19
+ */
20
+ activateVariant(
21
+ /**
22
+ * Object with parameters as properties
23
+ */
24
+ mPropertyBag: {
25
+ /**
26
+ * Component or control (instance or ID) on which the `variantModel` is set
27
+ */
28
+ element: ManagedObject | string;
29
+ /**
30
+ * Reference to the variant that needs to be activated
31
+ */
32
+ variantReference: string;
33
+ }
34
+ ): Promise<any>;
35
+ /**
36
+ * Saves a function that will be called after a variant has been applied with the new variant as parameter.
37
+ * Even if the same variant is selected again the callback is called. The function also performs a sanity
38
+ * check after the control has been rendered. If the passed variant control ID does not match the responsible
39
+ * variant management control, the callback will not be saved. Optionally this function is also called after
40
+ * the initial variant is applied without a sanity check.
41
+ */
42
+ attachVariantApplied(
43
+ /**
44
+ * Object with parameters as properties
45
+ */
46
+ mPropertyBag: {
47
+ /**
48
+ * Selector of the control
49
+ */
50
+ selector: /* was: sap.ui.fl.Selector */ any;
51
+ /**
52
+ * ID of the variant management control
53
+ */
54
+ vmControlId: string;
55
+ /**
56
+ * Callback that will be called after a variant has been applied
57
+ */
58
+ callback: Function;
59
+ /**
60
+ * The callback will also be called after the initial variant is applied
61
+ */
62
+ callAfterInitialVariant?: boolean;
63
+ }
64
+ ): void;
65
+ /**
66
+ * Clears URL technical parameter `sap-ui-fl-control-variant-id` for control variants. Use this method in
67
+ * case you normally want the variant parameter in the URL, but have a few special navigation patterns where
68
+ * you want to clear it. If you don't want that parameter in general, set the `updateVariantInURL` parameter
69
+ * on your variant management control to `false`. SAP Fiori elements use this method. If a variant management
70
+ * control is given as a parameter, only parameters specific to that control are cleared.
71
+ */
72
+ clearVariantParameterInURL(
73
+ /**
74
+ * Object with parameters as properties
75
+ */
76
+ mPropertyBag: {
77
+ /**
78
+ * Variant management control for which the URL technical parameter has to be cleared
79
+ */
80
+ control: ManagedObject;
81
+ }
82
+ ): void;
83
+ /**
84
+ * Removes the saved callback for the given control and variant management control.
85
+ */
86
+ detachVariantApplied(
87
+ /**
88
+ * Object with parameters as properties
89
+ */
90
+ mPropertyBag: {
91
+ /**
92
+ * Selector of the control
93
+ */
94
+ selector: /* was: sap.ui.fl.Selector */ any;
95
+ /**
96
+ * ID of the variant management control
97
+ */
98
+ vmControlId: string;
99
+ }
100
+ ): void;
101
+ }
102
+ const ControlVariantApplyAPI: ControlVariantApplyAPI;
103
+ export default ControlVariantApplyAPI;
104
+ }
105
+
106
+ declare module "sap/ui/fl/transport/TransportDialog" {
107
+ import { default as Dialog, $DialogSettings } from "sap/m/Dialog";
108
+
109
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
110
+
111
+ /**
112
+ * @deprecated (since 1.74) - The TransportDialog should be used only internally inside the `sap.ui.fl`
113
+ * library.
114
+ *
115
+ * The Transport Dialog Control can be used to implement a value help for selecting an ABAP package and
116
+ * transport request. It is not a generic utility, but part of the Variantmanament and therefore cannot
117
+ * be used in any other application.
118
+ */
119
+ export default class TransportDialog extends Dialog {
120
+ /**
121
+ * Constructor for a new transport/TransportDialog.
122
+ *
123
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
124
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
125
+ * of the syntax of the settings object.
126
+ *
127
+ * This class does not have its own settings, but all settings applicable to the base type {@link sap.m.Dialog#constructor
128
+ * sap.m.Dialog} can be used.
129
+ */
130
+ constructor(
131
+ /**
132
+ * initial settings for the new control
133
+ */
134
+ mSettings?: $TransportDialogSettings
135
+ );
136
+ /**
137
+ * Constructor for a new transport/TransportDialog.
138
+ *
139
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
140
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
141
+ * of the syntax of the settings object.
142
+ *
143
+ * This class does not have its own settings, but all settings applicable to the base type {@link sap.m.Dialog#constructor
144
+ * sap.m.Dialog} can be used.
145
+ */
146
+ constructor(
147
+ /**
148
+ * id for the new control, generated automatically if no id is given
149
+ */
150
+ sId?: string,
151
+ /**
152
+ * initial settings for the new control
153
+ */
154
+ mSettings?: $TransportDialogSettings
155
+ );
156
+
157
+ /**
158
+ * Creates a new subclass of class sap.ui.fl.transport.TransportDialog with name `sClassName` and enriches
159
+ * it with the information contained in `oClassInfo`.
160
+ *
161
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.m.Dialog.extend}.
162
+ *
163
+ * @returns Created class / constructor function
164
+ */
165
+ static extend<T extends Record<string, unknown>>(
166
+ /**
167
+ * Name of the class being created
168
+ */
169
+ sClassName: string,
170
+ /**
171
+ * Object literal with information about the class
172
+ */
173
+ oClassInfo?: sap.ClassInfo<T, TransportDialog>,
174
+ /**
175
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
176
+ * used by this class
177
+ */
178
+ FNMetaImpl?: Function
179
+ ): Function;
180
+ /**
181
+ * Returns a metadata object for class sap.ui.fl.transport.TransportDialog.
182
+ *
183
+ * @returns Metadata object describing this class
184
+ */
185
+ static getMetadata(): ElementMetadata;
186
+ }
187
+
188
+ export interface $TransportDialogSettings extends $DialogSettings {}
189
+ }
190
+
191
+ declare module "sap/ui/fl/variants/VariantManagement" {
192
+ import { default as Control, $ControlSettings } from "sap/ui/core/Control";
193
+
194
+ import { IShrinkable, ID, TitleLevel, CSSSize } from "sap/ui/core/library";
195
+
196
+ import { IOverflowToolbarContent } from "sap/m/library";
197
+
198
+ import Event from "sap/ui/base/Event";
199
+
200
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
201
+
202
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
203
+
204
+ /**
205
+ * @SINCE 1.56
206
+ *
207
+ * Can be used to manage variants. You can use this control in most controls that are enabled for key
208
+ * user adaptation.
209
+ * **Note: **On the user interface, variants are generally referred to as "views".
210
+ */
211
+ export default class VariantManagement
212
+ extends Control
213
+ implements
214
+ IShrinkable,
215
+ IOverflowToolbarContent,
216
+ /* was: sap.m.IToolbarInteractiveControl */ Object {
217
+ __implements__sap_ui_core_IShrinkable: boolean;
218
+ __implements__sap_m_IOverflowToolbarContent: boolean;
219
+ __implements__sap_m_IToolbarInteractiveControl: boolean;
220
+ /**
221
+ * Constructor for a new `VariantManagement`.
222
+ *
223
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
224
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
225
+ * of the syntax of the settings object.
226
+ * See:
227
+ * {@link topic:f1430c0337534d469da3a56307ff76af Key User Adaptation: Enable Your App}
228
+ */
229
+ constructor(
230
+ /**
231
+ * Initial settings for the new control
232
+ */
233
+ mSettings?: $VariantManagementSettings
234
+ );
235
+ /**
236
+ * Constructor for a new `VariantManagement`.
237
+ *
238
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
239
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
240
+ * of the syntax of the settings object.
241
+ * See:
242
+ * {@link topic:f1430c0337534d469da3a56307ff76af Key User Adaptation: Enable Your App}
243
+ */
244
+ constructor(
245
+ /**
246
+ * ID for the new control, generated automatically if no ID is given
247
+ */
248
+ sId?: string,
249
+ /**
250
+ * Initial settings for the new control
251
+ */
252
+ mSettings?: $VariantManagementSettings
253
+ );
254
+
255
+ /**
256
+ * Creates a new subclass of class sap.ui.fl.variants.VariantManagement with name `sClassName` and enriches
257
+ * it with the information contained in `oClassInfo`.
258
+ *
259
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
260
+ *
261
+ * @returns Created class / constructor function
262
+ */
263
+ static extend<T extends Record<string, unknown>>(
264
+ /**
265
+ * Name of the class being created
266
+ */
267
+ sClassName: string,
268
+ /**
269
+ * Object literal with information about the class
270
+ */
271
+ oClassInfo?: sap.ClassInfo<T, VariantManagement>,
272
+ /**
273
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
274
+ * used by this class
275
+ */
276
+ FNMetaImpl?: Function
277
+ ): Function;
278
+ /**
279
+ * Returns a metadata object for class sap.ui.fl.variants.VariantManagement.
280
+ *
281
+ * @returns Metadata object describing this class
282
+ */
283
+ static getMetadata(): ElementMetadata;
284
+ /**
285
+ * Adds a control to the association {@link #for for}.
286
+ *
287
+ * @returns Reference to `this` in order to allow method chaining
288
+ */
289
+ addFor(
290
+ /**
291
+ * The control to add; if empty, nothing is inserted
292
+ */
293
+ vFor: ID | Control
294
+ ): this;
295
+ /**
296
+ * Attaches event handler `fnFunction` to the {@link #event:cancel cancel} event of this `sap.ui.fl.variants.VariantManagement`.
297
+ *
298
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
299
+ * otherwise it will be bound to this `sap.ui.fl.variants.VariantManagement` itself.
300
+ *
301
+ * This event is fired when users presses the cancel button inside Save As dialog.
302
+ *
303
+ * @returns Reference to `this` in order to allow method chaining
304
+ */
305
+ attachCancel(
306
+ /**
307
+ * An application-specific payload object that will be passed to the event handler along with the event
308
+ * object when firing the event
309
+ */
310
+ oData: object,
311
+ /**
312
+ * The function to be called when the event occurs
313
+ */
314
+ fnFunction: (p1: Event) => void,
315
+ /**
316
+ * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
317
+ * itself
318
+ */
319
+ oListener?: object
320
+ ): this;
321
+ /**
322
+ * Attaches event handler `fnFunction` to the {@link #event:cancel cancel} event of this `sap.ui.fl.variants.VariantManagement`.
323
+ *
324
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
325
+ * otherwise it will be bound to this `sap.ui.fl.variants.VariantManagement` itself.
326
+ *
327
+ * This event is fired when users presses the cancel button inside Save As dialog.
328
+ *
329
+ * @returns Reference to `this` in order to allow method chaining
330
+ */
331
+ attachCancel(
332
+ /**
333
+ * The function to be called when the event occurs
334
+ */
335
+ fnFunction: (p1: Event) => void,
336
+ /**
337
+ * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
338
+ * itself
339
+ */
340
+ oListener?: object
341
+ ): this;
342
+ /**
343
+ * Attaches event handler `fnFunction` to the {@link #event:initialized initialized} event of this `sap.ui.fl.variants.VariantManagement`.
344
+ *
345
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
346
+ * otherwise it will be bound to this `sap.ui.fl.variants.VariantManagement` itself.
347
+ *
348
+ * This event is fired when the model and context are set.
349
+ *
350
+ * @returns Reference to `this` in order to allow method chaining
351
+ */
352
+ attachInitialized(
353
+ /**
354
+ * An application-specific payload object that will be passed to the event handler along with the event
355
+ * object when firing the event
356
+ */
357
+ oData: object,
358
+ /**
359
+ * The function to be called when the event occurs
360
+ */
361
+ fnFunction: (p1: Event) => void,
362
+ /**
363
+ * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
364
+ * itself
365
+ */
366
+ oListener?: object
367
+ ): this;
368
+ /**
369
+ * Attaches event handler `fnFunction` to the {@link #event:initialized initialized} event of this `sap.ui.fl.variants.VariantManagement`.
370
+ *
371
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
372
+ * otherwise it will be bound to this `sap.ui.fl.variants.VariantManagement` itself.
373
+ *
374
+ * This event is fired when the model and context are set.
375
+ *
376
+ * @returns Reference to `this` in order to allow method chaining
377
+ */
378
+ attachInitialized(
379
+ /**
380
+ * The function to be called when the event occurs
381
+ */
382
+ fnFunction: (p1: Event) => void,
383
+ /**
384
+ * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
385
+ * itself
386
+ */
387
+ oListener?: object
388
+ ): this;
389
+ /**
390
+ * Attaches event handler `fnFunction` to the {@link #event:manage manage} event of this `sap.ui.fl.variants.VariantManagement`.
391
+ *
392
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
393
+ * otherwise it will be bound to this `sap.ui.fl.variants.VariantManagement` itself.
394
+ *
395
+ * This event is fired when users apply changes to variants in the Manage Views dialog.
396
+ *
397
+ * @returns Reference to `this` in order to allow method chaining
398
+ */
399
+ attachManage(
400
+ /**
401
+ * An application-specific payload object that will be passed to the event handler along with the event
402
+ * object when firing the event
403
+ */
404
+ oData: object,
405
+ /**
406
+ * The function to be called when the event occurs
407
+ */
408
+ fnFunction: (p1: Event) => void,
409
+ /**
410
+ * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
411
+ * itself
412
+ */
413
+ oListener?: object
414
+ ): this;
415
+ /**
416
+ * Attaches event handler `fnFunction` to the {@link #event:manage manage} event of this `sap.ui.fl.variants.VariantManagement`.
417
+ *
418
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
419
+ * otherwise it will be bound to this `sap.ui.fl.variants.VariantManagement` itself.
420
+ *
421
+ * This event is fired when users apply changes to variants in the Manage Views dialog.
422
+ *
423
+ * @returns Reference to `this` in order to allow method chaining
424
+ */
425
+ attachManage(
426
+ /**
427
+ * The function to be called when the event occurs
428
+ */
429
+ fnFunction: (p1: Event) => void,
430
+ /**
431
+ * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
432
+ * itself
433
+ */
434
+ oListener?: object
435
+ ): this;
436
+ /**
437
+ * Attaches event handler `fnFunction` to the {@link #event:save save} event of this `sap.ui.fl.variants.VariantManagement`.
438
+ *
439
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
440
+ * otherwise it will be bound to this `sap.ui.fl.variants.VariantManagement` itself.
441
+ *
442
+ * This event is fired when the Save View dialog or the Save As dialog is closed with the
443
+ * save button.
444
+ *
445
+ * @returns Reference to `this` in order to allow method chaining
446
+ */
447
+ attachSave(
448
+ /**
449
+ * An application-specific payload object that will be passed to the event handler along with the event
450
+ * object when firing the event
451
+ */
452
+ oData: object,
453
+ /**
454
+ * The function to be called when the event occurs
455
+ */
456
+ fnFunction: (p1: Event) => void,
457
+ /**
458
+ * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
459
+ * itself
460
+ */
461
+ oListener?: object
462
+ ): this;
463
+ /**
464
+ * Attaches event handler `fnFunction` to the {@link #event:save save} event of this `sap.ui.fl.variants.VariantManagement`.
465
+ *
466
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
467
+ * otherwise it will be bound to this `sap.ui.fl.variants.VariantManagement` itself.
468
+ *
469
+ * This event is fired when the Save View dialog or the Save As dialog is closed with the
470
+ * save button.
471
+ *
472
+ * @returns Reference to `this` in order to allow method chaining
473
+ */
474
+ attachSave(
475
+ /**
476
+ * The function to be called when the event occurs
477
+ */
478
+ fnFunction: (p1: Event) => void,
479
+ /**
480
+ * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
481
+ * itself
482
+ */
483
+ oListener?: object
484
+ ): this;
485
+ /**
486
+ * Attaches event handler `fnFunction` to the {@link #event:select select} event of this `sap.ui.fl.variants.VariantManagement`.
487
+ *
488
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
489
+ * otherwise it will be bound to this `sap.ui.fl.variants.VariantManagement` itself.
490
+ *
491
+ * This event is fired when a new variant is selected.
492
+ *
493
+ * @returns Reference to `this` in order to allow method chaining
494
+ */
495
+ attachSelect(
496
+ /**
497
+ * An application-specific payload object that will be passed to the event handler along with the event
498
+ * object when firing the event
499
+ */
500
+ oData: object,
501
+ /**
502
+ * The function to be called when the event occurs
503
+ */
504
+ fnFunction: (p1: Event) => void,
505
+ /**
506
+ * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
507
+ * itself
508
+ */
509
+ oListener?: object
510
+ ): this;
511
+ /**
512
+ * Attaches event handler `fnFunction` to the {@link #event:select select} event of this `sap.ui.fl.variants.VariantManagement`.
513
+ *
514
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
515
+ * otherwise it will be bound to this `sap.ui.fl.variants.VariantManagement` itself.
516
+ *
517
+ * This event is fired when a new variant is selected.
518
+ *
519
+ * @returns Reference to `this` in order to allow method chaining
520
+ */
521
+ attachSelect(
522
+ /**
523
+ * The function to be called when the event occurs
524
+ */
525
+ fnFunction: (p1: Event) => void,
526
+ /**
527
+ * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
528
+ * itself
529
+ */
530
+ oListener?: object
531
+ ): this;
532
+ /**
533
+ * Detaches event handler `fnFunction` from the {@link #event:cancel cancel} event of this `sap.ui.fl.variants.VariantManagement`.
534
+ *
535
+ * The passed function and listener object must match the ones used for event registration.
536
+ *
537
+ * @returns Reference to `this` in order to allow method chaining
538
+ */
539
+ detachCancel(
540
+ /**
541
+ * The function to be called, when the event occurs
542
+ */
543
+ fnFunction: (p1: Event) => void,
544
+ /**
545
+ * Context object on which the given function had to be called
546
+ */
547
+ oListener?: object
548
+ ): this;
549
+ /**
550
+ * Detaches event handler `fnFunction` from the {@link #event:initialized initialized} event of this `sap.ui.fl.variants.VariantManagement`.
551
+ *
552
+ * The passed function and listener object must match the ones used for event registration.
553
+ *
554
+ * @returns Reference to `this` in order to allow method chaining
555
+ */
556
+ detachInitialized(
557
+ /**
558
+ * The function to be called, when the event occurs
559
+ */
560
+ fnFunction: (p1: Event) => void,
561
+ /**
562
+ * Context object on which the given function had to be called
563
+ */
564
+ oListener?: object
565
+ ): this;
566
+ /**
567
+ * Detaches event handler `fnFunction` from the {@link #event:manage manage} event of this `sap.ui.fl.variants.VariantManagement`.
568
+ *
569
+ * The passed function and listener object must match the ones used for event registration.
570
+ *
571
+ * @returns Reference to `this` in order to allow method chaining
572
+ */
573
+ detachManage(
574
+ /**
575
+ * The function to be called, when the event occurs
576
+ */
577
+ fnFunction: (p1: Event) => void,
578
+ /**
579
+ * Context object on which the given function had to be called
580
+ */
581
+ oListener?: object
582
+ ): this;
583
+ /**
584
+ * Detaches event handler `fnFunction` from the {@link #event:save save} event of this `sap.ui.fl.variants.VariantManagement`.
585
+ *
586
+ * The passed function and listener object must match the ones used for event registration.
587
+ *
588
+ * @returns Reference to `this` in order to allow method chaining
589
+ */
590
+ detachSave(
591
+ /**
592
+ * The function to be called, when the event occurs
593
+ */
594
+ fnFunction: (p1: Event) => void,
595
+ /**
596
+ * Context object on which the given function had to be called
597
+ */
598
+ oListener?: object
599
+ ): this;
600
+ /**
601
+ * Detaches event handler `fnFunction` from the {@link #event:select select} event of this `sap.ui.fl.variants.VariantManagement`.
602
+ *
603
+ * The passed function and listener object must match the ones used for event registration.
604
+ *
605
+ * @returns Reference to `this` in order to allow method chaining
606
+ */
607
+ detachSelect(
608
+ /**
609
+ * The function to be called, when the event occurs
610
+ */
611
+ fnFunction: (p1: Event) => void,
612
+ /**
613
+ * Context object on which the given function had to be called
614
+ */
615
+ oListener?: object
616
+ ): this;
617
+ /**
618
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
619
+ *
620
+ * Fires event {@link #event:cancel cancel} to attached listeners.
621
+ *
622
+ * @returns Reference to `this` in order to allow method chaining
623
+ */
624
+ fireCancel(
625
+ /**
626
+ * Parameters to pass along with the event
627
+ */
628
+ mParameters?: object
629
+ ): this;
630
+ /**
631
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
632
+ *
633
+ * Fires event {@link #event:initialized initialized} to attached listeners.
634
+ *
635
+ * @returns Reference to `this` in order to allow method chaining
636
+ */
637
+ fireInitialized(
638
+ /**
639
+ * Parameters to pass along with the event
640
+ */
641
+ mParameters?: object
642
+ ): this;
643
+ /**
644
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
645
+ *
646
+ * Fires event {@link #event:manage manage} to attached listeners.
647
+ *
648
+ * @returns Reference to `this` in order to allow method chaining
649
+ */
650
+ fireManage(
651
+ /**
652
+ * Parameters to pass along with the event
653
+ */
654
+ mParameters?: {
655
+ /**
656
+ * List of changed variants. Each entry contains a 'key' - the variant key and a 'name' - the new title
657
+ * of the variant
658
+ */
659
+ renamed?: object[];
660
+ /**
661
+ * List of deleted variant keys
662
+ */
663
+ deleted?: string[];
664
+ /**
665
+ * List of variant keys and the associated Execute on Selection indicator
666
+ */
667
+ exe?: object[];
668
+ /**
669
+ * The default variant key
670
+ */
671
+ def?: string;
672
+ }
673
+ ): this;
674
+ /**
675
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
676
+ *
677
+ * Fires event {@link #event:save save} to attached listeners.
678
+ *
679
+ * @returns Reference to `this` in order to allow method chaining
680
+ */
681
+ fireSave(
682
+ /**
683
+ * Parameters to pass along with the event
684
+ */
685
+ mParameters?: {
686
+ /**
687
+ * Variant title
688
+ */
689
+ name?: string;
690
+ /**
691
+ * Indicates if an existing variant is overwritten or if a new variant is created.
692
+ */
693
+ overwrite?: boolean;
694
+ /**
695
+ * Variant key
696
+ */
697
+ key?: string;
698
+ /**
699
+ * Apply Automatically indicator
700
+ */
701
+ execute?: boolean;
702
+ /**
703
+ * Indicates the check box state for 'Public'.
704
+ */
705
+ public?: boolean;
706
+ /**
707
+ * The default variant indicator
708
+ */
709
+ def?: boolean;
710
+ /**
711
+ * Indicates the check box state for 'Create Tile'.
712
+ * Note:
713
+ * This event parameter is used only internally.
714
+ */
715
+ tile?: boolean;
716
+ }
717
+ ): this;
718
+ /**
719
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
720
+ *
721
+ * Fires event {@link #event:select select} to attached listeners.
722
+ *
723
+ * @returns Reference to `this` in order to allow method chaining
724
+ */
725
+ fireSelect(
726
+ /**
727
+ * Parameters to pass along with the event
728
+ */
729
+ mParameters?: {
730
+ /**
731
+ * Variant key
732
+ */
733
+ key?: string;
734
+ }
735
+ ): this;
736
+ /**
737
+ * Gets the currently selected variant key.
738
+ *
739
+ * @returns Key of the currently selected variant. In case the model is not yet set `null` will be returned.
740
+ */
741
+ getCurrentVariantKey(): string | null;
742
+ /**
743
+ * Gets current value of property {@link #getDisplayTextForExecuteOnSelectionForStandardVariant displayTextForExecuteOnSelectionForStandardVariant}.
744
+ *
745
+ * Defines the Apply Automatically text for the standard variant in the Manage Views dialog if the application
746
+ * controls this behavior. **Note:** the usage of this property is restricted to `sap.fe` components
747
+ * only.
748
+ *
749
+ * Default value is `empty string`.
750
+ *
751
+ * @returns Value of property `displayTextForExecuteOnSelectionForStandardVariant`
752
+ */
753
+ getDisplayTextForExecuteOnSelectionForStandardVariant(): string;
754
+ /**
755
+ * Gets current value of property {@link #getEditable editable}.
756
+ *
757
+ * Indicated if the buttons on the 'My Views' are visible.
758
+ *
759
+ * Default value is `true`.
760
+ *
761
+ * @returns Value of property `editable`
762
+ */
763
+ getEditable(): boolean;
764
+ /**
765
+ * Gets current value of property {@link #getExecuteOnSelectionForStandardDefault executeOnSelectionForStandardDefault}.
766
+ *
767
+ * Determines the behavior for Apply Automatically if the standard variant is marked as the default variant.
768
+ *
769
+ * Default value is `false`.
770
+ *
771
+ * @returns Value of property `executeOnSelectionForStandardDefault`
772
+ */
773
+ getExecuteOnSelectionForStandardDefault(): boolean;
774
+ /**
775
+ * Returns array of IDs of the elements which are the current targets of the association {@link #getFor
776
+ * for}.
777
+ */
778
+ getFor(): ID[];
779
+ /**
780
+ * @SINCE 1.104
781
+ *
782
+ * Gets current value of property {@link #getHeaderLevel headerLevel}.
783
+ *
784
+ * Semantic level of the header. For more information, see {@link sap.m.Title#setLevel}.
785
+ *
786
+ * Default value is `Auto`.
787
+ *
788
+ * @returns Value of property `headerLevel`
789
+ */
790
+ getHeaderLevel(): TitleLevel | keyof typeof TitleLevel;
791
+ /**
792
+ * Gets current value of property {@link #getInErrorState inErrorState}.
793
+ *
794
+ * Indicates that the control is in error state. If set to `true`, an error message will be displayed whenever
795
+ * the variant is opened.
796
+ *
797
+ * Default value is `false`.
798
+ *
799
+ * @returns Value of property `inErrorState`
800
+ */
801
+ getInErrorState(): boolean;
802
+ /**
803
+ * Gets current value of property {@link #getManualVariantKey manualVariantKey}.
804
+ *
805
+ * If set to `true`, the key for a vendor variant will be added manually.
806
+ * **Note:** This flag is only used internally.
807
+ *
808
+ * Default value is `false`.
809
+ *
810
+ * @returns Value of property `manualVariantKey`
811
+ */
812
+ getManualVariantKey(): boolean;
813
+ /**
814
+ * @SINCE 1.109
815
+ *
816
+ * Gets current value of property {@link #getMaxWidth maxWidth}.
817
+ *
818
+ * Sets the maximum width of the control.
819
+ *
820
+ * Default value is `"100%"`.
821
+ *
822
+ * @returns Value of property `maxWidth`
823
+ */
824
+ getMaxWidth(): CSSSize;
825
+ /**
826
+ * Gets current value of property {@link #getModelName modelName}.
827
+ *
828
+ * The name of the model containing the data.
829
+ *
830
+ * Default value is `empty string`.
831
+ *
832
+ * @returns Value of property `modelName`
833
+ */
834
+ getModelName(): string;
835
+ /**
836
+ * Determines if the current variant is modified.
837
+ *
838
+ * @returns If the current variant is modified `true`, otherwise `false`
839
+ */
840
+ getModified(): boolean;
841
+ /**
842
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
843
+ *
844
+ * Required by the {@link sap.m.IOverflowToolbarContent} interface. Registers invalidations event which
845
+ * is fired when width of the control is changed.
846
+ *
847
+ * @returns Configuration information for the `sap.m.IOverflowToolbarContent` interface.
848
+ */
849
+ getOverflowToolbarConfig(): {
850
+ canOverflow: boolean;
851
+
852
+ invalidationEvents: string[];
853
+ };
854
+ /**
855
+ * Gets current value of property {@link #getResetOnContextChange resetOnContextChange}.
856
+ *
857
+ * When set to `false`, doesn't reset the `VariantManagement` control to the default variant, when its binding
858
+ * context is changed. **Note:** The `VariantManagement` control does not react in any way to this property.
859
+ * It is used internally by the flexibility layer.
860
+ *
861
+ * Default value is `true`.
862
+ *
863
+ * @returns Value of property `resetOnContextChange`
864
+ */
865
+ getResetOnContextChange(): boolean;
866
+ /**
867
+ * Gets current value of property {@link #getShowSetAsDefault showSetAsDefault}.
868
+ *
869
+ * Indicated if the defaulting functionality is enabled.
870
+ *
871
+ * Default value is `true`.
872
+ *
873
+ * @returns Value of property `showSetAsDefault`
874
+ */
875
+ getShowSetAsDefault(): boolean;
876
+ /**
877
+ * @SINCE 1.109
878
+ *
879
+ * Gets current value of property {@link #getTitleStyle titleStyle}.
880
+ *
881
+ * Defines the style of the title. For more information, see {@link sap.m.Title#setTitleStyle}.
882
+ *
883
+ * Default value is `Auto`.
884
+ *
885
+ * @returns Value of property `titleStyle`
886
+ */
887
+ getTitleStyle(): TitleLevel | keyof typeof TitleLevel;
888
+ /**
889
+ * Gets current value of property {@link #getUpdateVariantInURL updateVariantInURL}.
890
+ *
891
+ * Determines the intention of setting the current variant based on passed information. **Note:** The
892
+ * `VariantManagement` control does not react in any way to this property. It is used internally by the
893
+ * flexibility layer.
894
+ *
895
+ * Default value is `false`.
896
+ *
897
+ * @returns Value of property `updateVariantInURL`
898
+ */
899
+ getUpdateVariantInURL(): boolean;
900
+ /**
901
+ * Retrieves all variants.
902
+ *
903
+ * @returns All variants. In case the model is not yet set, an empty array will be returned.
904
+ */
905
+ getVariants(): any[];
906
+ /**
907
+ * Removes all the controls in the association named {@link #getFor for}.
908
+ *
909
+ * @returns An array of the removed elements (might be empty)
910
+ */
911
+ removeAllFor(): ID[];
912
+ /**
913
+ * Removes an for from the association named {@link #getFor for}.
914
+ *
915
+ * @returns The removed for or `null`
916
+ */
917
+ removeFor(
918
+ /**
919
+ * The for to be removed or its index or ID
920
+ */
921
+ vFor: int | ID | Control
922
+ ): ID | null;
923
+ /**
924
+ * Sets the new selected variant.
925
+ */
926
+ setCurrentVariantKey(
927
+ /**
928
+ * Key of the variant that should be selected.
929
+ */
930
+ sKey: string
931
+ ): void;
932
+ /**
933
+ * Sets a new value for property {@link #getDisplayTextForExecuteOnSelectionForStandardVariant displayTextForExecuteOnSelectionForStandardVariant}.
934
+ *
935
+ * Defines the Apply Automatically text for the standard variant in the Manage Views dialog if the application
936
+ * controls this behavior. **Note:** the usage of this property is restricted to `sap.fe` components
937
+ * only.
938
+ *
939
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
940
+ *
941
+ * Default value is `empty string`.
942
+ *
943
+ * @returns Reference to `this` in order to allow method chaining
944
+ */
945
+ setDisplayTextForExecuteOnSelectionForStandardVariant(
946
+ /**
947
+ * New value for property `displayTextForExecuteOnSelectionForStandardVariant`
948
+ */
949
+ sDisplayTextForExecuteOnSelectionForStandardVariant?: string
950
+ ): this;
951
+ /**
952
+ * Sets a new value for property {@link #getEditable editable}.
953
+ *
954
+ * Indicated if the buttons on the 'My Views' are visible.
955
+ *
956
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
957
+ *
958
+ * Default value is `true`.
959
+ *
960
+ * @returns Reference to `this` in order to allow method chaining
961
+ */
962
+ setEditable(
963
+ /**
964
+ * New value for property `editable`
965
+ */
966
+ bEditable?: boolean
967
+ ): this;
968
+ /**
969
+ * Sets a new value for property {@link #getExecuteOnSelectionForStandardDefault executeOnSelectionForStandardDefault}.
970
+ *
971
+ * Determines the behavior for Apply Automatically if the standard variant is marked as the default variant.
972
+ *
973
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
974
+ *
975
+ * Default value is `false`.
976
+ *
977
+ * @returns Reference to `this` in order to allow method chaining
978
+ */
979
+ setExecuteOnSelectionForStandardDefault(
980
+ /**
981
+ * New value for property `executeOnSelectionForStandardDefault`
982
+ */
983
+ bExecuteOnSelectionForStandardDefault?: boolean
984
+ ): this;
985
+ /**
986
+ * @SINCE 1.104
987
+ *
988
+ * Sets a new value for property {@link #getHeaderLevel headerLevel}.
989
+ *
990
+ * Semantic level of the header. For more information, see {@link sap.m.Title#setLevel}.
991
+ *
992
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
993
+ *
994
+ * Default value is `Auto`.
995
+ *
996
+ * @returns Reference to `this` in order to allow method chaining
997
+ */
998
+ setHeaderLevel(
999
+ /**
1000
+ * New value for property `headerLevel`
1001
+ */
1002
+ sHeaderLevel?: TitleLevel | keyof typeof TitleLevel
1003
+ ): this;
1004
+ /**
1005
+ * Sets a new value for property {@link #getInErrorState inErrorState}.
1006
+ *
1007
+ * Indicates that the control is in error state. If set to `true`, an error message will be displayed whenever
1008
+ * the variant is opened.
1009
+ *
1010
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1011
+ *
1012
+ * Default value is `false`.
1013
+ *
1014
+ * @returns Reference to `this` in order to allow method chaining
1015
+ */
1016
+ setInErrorState(
1017
+ /**
1018
+ * New value for property `inErrorState`
1019
+ */
1020
+ bInErrorState?: boolean
1021
+ ): this;
1022
+ /**
1023
+ * Sets a new value for property {@link #getManualVariantKey manualVariantKey}.
1024
+ *
1025
+ * If set to `true`, the key for a vendor variant will be added manually.
1026
+ * **Note:** This flag is only used internally.
1027
+ *
1028
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1029
+ *
1030
+ * Default value is `false`.
1031
+ *
1032
+ * @returns Reference to `this` in order to allow method chaining
1033
+ */
1034
+ setManualVariantKey(
1035
+ /**
1036
+ * New value for property `manualVariantKey`
1037
+ */
1038
+ bManualVariantKey?: boolean
1039
+ ): this;
1040
+ /**
1041
+ * @SINCE 1.109
1042
+ *
1043
+ * Sets a new value for property {@link #getMaxWidth maxWidth}.
1044
+ *
1045
+ * Sets the maximum width of the control.
1046
+ *
1047
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1048
+ *
1049
+ * Default value is `"100%"`.
1050
+ *
1051
+ * @returns Reference to `this` in order to allow method chaining
1052
+ */
1053
+ setMaxWidth(
1054
+ /**
1055
+ * New value for property `maxWidth`
1056
+ */
1057
+ sMaxWidth?: CSSSize
1058
+ ): this;
1059
+ /**
1060
+ * Sets a new value for property {@link #getModelName modelName}.
1061
+ *
1062
+ * The name of the model containing the data.
1063
+ *
1064
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1065
+ *
1066
+ * Default value is `empty string`.
1067
+ *
1068
+ * @returns Reference to `this` in order to allow method chaining
1069
+ */
1070
+ setModelName(
1071
+ /**
1072
+ * New value for property `modelName`
1073
+ */
1074
+ sModelName?: string
1075
+ ): this;
1076
+ /**
1077
+ * Sets a new value for property {@link #getResetOnContextChange resetOnContextChange}.
1078
+ *
1079
+ * When set to `false`, doesn't reset the `VariantManagement` control to the default variant, when its binding
1080
+ * context is changed. **Note:** The `VariantManagement` control does not react in any way to this property.
1081
+ * It is used internally by the flexibility layer.
1082
+ *
1083
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1084
+ *
1085
+ * Default value is `true`.
1086
+ *
1087
+ * @returns Reference to `this` in order to allow method chaining
1088
+ */
1089
+ setResetOnContextChange(
1090
+ /**
1091
+ * New value for property `resetOnContextChange`
1092
+ */
1093
+ bResetOnContextChange?: boolean
1094
+ ): this;
1095
+ /**
1096
+ * Sets a new value for property {@link #getShowSetAsDefault showSetAsDefault}.
1097
+ *
1098
+ * Indicated if the defaulting functionality is enabled.
1099
+ *
1100
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1101
+ *
1102
+ * Default value is `true`.
1103
+ *
1104
+ * @returns Reference to `this` in order to allow method chaining
1105
+ */
1106
+ setShowSetAsDefault(
1107
+ /**
1108
+ * New value for property `showSetAsDefault`
1109
+ */
1110
+ bShowSetAsDefault?: boolean
1111
+ ): this;
1112
+ /**
1113
+ * @SINCE 1.109
1114
+ *
1115
+ * Sets a new value for property {@link #getTitleStyle titleStyle}.
1116
+ *
1117
+ * Defines the style of the title. For more information, see {@link sap.m.Title#setTitleStyle}.
1118
+ *
1119
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1120
+ *
1121
+ * Default value is `Auto`.
1122
+ *
1123
+ * @returns Reference to `this` in order to allow method chaining
1124
+ */
1125
+ setTitleStyle(
1126
+ /**
1127
+ * New value for property `titleStyle`
1128
+ */
1129
+ sTitleStyle?: TitleLevel | keyof typeof TitleLevel
1130
+ ): this;
1131
+ /**
1132
+ * Sets a new value for property {@link #getUpdateVariantInURL updateVariantInURL}.
1133
+ *
1134
+ * Determines the intention of setting the current variant based on passed information. **Note:** The
1135
+ * `VariantManagement` control does not react in any way to this property. It is used internally by the
1136
+ * flexibility layer.
1137
+ *
1138
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1139
+ *
1140
+ * Default value is `false`.
1141
+ *
1142
+ * @returns Reference to `this` in order to allow method chaining
1143
+ */
1144
+ setUpdateVariantInURL(
1145
+ /**
1146
+ * New value for property `updateVariantInURL`
1147
+ */
1148
+ bUpdateVariantInURL?: boolean
1149
+ ): this;
1150
+ }
1151
+
1152
+ export interface $VariantManagementSettings extends $ControlSettings {
1153
+ /**
1154
+ * Determines the intention of setting the current variant based on passed information. **Note:** The
1155
+ * `VariantManagement` control does not react in any way to this property. It is used internally by the
1156
+ * flexibility layer.
1157
+ */
1158
+ updateVariantInURL?: boolean | PropertyBindingInfo | `{${string}}`;
1159
+
1160
+ /**
1161
+ * When set to `false`, doesn't reset the `VariantManagement` control to the default variant, when its binding
1162
+ * context is changed. **Note:** The `VariantManagement` control does not react in any way to this property.
1163
+ * It is used internally by the flexibility layer.
1164
+ */
1165
+ resetOnContextChange?: boolean | PropertyBindingInfo | `{${string}}`;
1166
+
1167
+ /**
1168
+ * The name of the model containing the data.
1169
+ */
1170
+ modelName?: string | PropertyBindingInfo;
1171
+
1172
+ /**
1173
+ * Indicated if the buttons on the 'My Views' are visible.
1174
+ */
1175
+ editable?: boolean | PropertyBindingInfo | `{${string}}`;
1176
+
1177
+ /**
1178
+ * Indicated if the defaulting functionality is enabled.
1179
+ */
1180
+ showSetAsDefault?: boolean | PropertyBindingInfo | `{${string}}`;
1181
+
1182
+ /**
1183
+ * If set to `true`, the key for a vendor variant will be added manually.
1184
+ * **Note:** This flag is only used internally.
1185
+ */
1186
+ manualVariantKey?: boolean | PropertyBindingInfo | `{${string}}`;
1187
+
1188
+ /**
1189
+ * Indicates that the control is in error state. If set to `true`, an error message will be displayed whenever
1190
+ * the variant is opened.
1191
+ */
1192
+ inErrorState?: boolean | PropertyBindingInfo | `{${string}}`;
1193
+
1194
+ /**
1195
+ * Determines the behavior for Apply Automatically if the standard variant is marked as the default variant.
1196
+ */
1197
+ executeOnSelectionForStandardDefault?:
1198
+ | boolean
1199
+ | PropertyBindingInfo
1200
+ | `{${string}}`;
1201
+
1202
+ /**
1203
+ * Defines the Apply Automatically text for the standard variant in the Manage Views dialog if the application
1204
+ * controls this behavior. **Note:** the usage of this property is restricted to `sap.fe` components
1205
+ * only.
1206
+ */
1207
+ displayTextForExecuteOnSelectionForStandardVariant?:
1208
+ | string
1209
+ | PropertyBindingInfo;
1210
+
1211
+ /**
1212
+ * @SINCE 1.104
1213
+ *
1214
+ * Semantic level of the header. For more information, see {@link sap.m.Title#setLevel}.
1215
+ */
1216
+ headerLevel?:
1217
+ | (TitleLevel | keyof typeof TitleLevel)
1218
+ | PropertyBindingInfo
1219
+ | `{${string}}`;
1220
+
1221
+ /**
1222
+ * @SINCE 1.109
1223
+ *
1224
+ * Defines the style of the title. For more information, see {@link sap.m.Title#setTitleStyle}.
1225
+ */
1226
+ titleStyle?:
1227
+ | (TitleLevel | keyof typeof TitleLevel)
1228
+ | PropertyBindingInfo
1229
+ | `{${string}}`;
1230
+
1231
+ /**
1232
+ * @SINCE 1.109
1233
+ *
1234
+ * Sets the maximum width of the control.
1235
+ */
1236
+ maxWidth?: CSSSize | PropertyBindingInfo | `{${string}}`;
1237
+
1238
+ /**
1239
+ * Contains the ids of the controls for which the variant management is responsible.
1240
+ */
1241
+ for?: Array<Control | string>;
1242
+
1243
+ /**
1244
+ * This event is fired when the model and context are set.
1245
+ */
1246
+ initialized?: (oEvent: Event) => void;
1247
+
1248
+ /**
1249
+ * This event is fired when the Save View dialog or the Save As dialog is closed with the
1250
+ * save button.
1251
+ */
1252
+ save?: (oEvent: Event) => void;
1253
+
1254
+ /**
1255
+ * This event is fired when users presses the cancel button inside Save As dialog.
1256
+ */
1257
+ cancel?: (oEvent: Event) => void;
1258
+
1259
+ /**
1260
+ * This event is fired when users apply changes to variants in the Manage Views dialog.
1261
+ */
1262
+ manage?: (oEvent: Event) => void;
1263
+
1264
+ /**
1265
+ * This event is fired when a new variant is selected.
1266
+ */
1267
+ select?: (oEvent: Event) => void;
1268
+ }
1269
+ }
1270
+
1271
+ declare module "sap/ui/fl/write/_internal/fieldExtensibility/ABAPExtensibilityVariant" {
1272
+ import Metadata from "sap/ui/base/Metadata";
1273
+
1274
+ /**
1275
+ * @SINCE 1.87
1276
+ *
1277
+ * Abstraction providing an API to handle an ABAP extension variant. Serves also as base class and dummy
1278
+ * implementation.
1279
+ */
1280
+ interface ABAPExtensibilityVariant {
1281
+ /**
1282
+ * Creates a new subclass of class sap.ui.fl.write._internal.fieldExtensibility.ABAPExtensibilityVariant
1283
+ * with name `sClassName` and enriches it with the information contained in `oClassInfo`.
1284
+ *
1285
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
1286
+ *
1287
+ * @returns Created class / constructor function
1288
+ */
1289
+ extend(
1290
+ /**
1291
+ * Name of the class being created
1292
+ */
1293
+ sClassName: string,
1294
+ /**
1295
+ * Object literal with information about the class
1296
+ */
1297
+ oClassInfo?: object,
1298
+ /**
1299
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1300
+ * used by this class
1301
+ */
1302
+ FNMetaImpl?: Function
1303
+ ): Function;
1304
+ /**
1305
+ * Returns a metadata object for class sap.ui.fl.write._internal.fieldExtensibility.ABAPExtensibilityVariant.
1306
+ *
1307
+ * @returns Metadata object describing this class
1308
+ */
1309
+ getMetadata(): Metadata;
1310
+ }
1311
+ const ABAPExtensibilityVariant: ABAPExtensibilityVariant;
1312
+ export default ABAPExtensibilityVariant;
1313
+ }
1314
+
1315
+ declare module "sap/ui/fl/write/_internal/fieldExtensibility/MultiTenantABAPExtensibilityVariant" {
1316
+ import Metadata from "sap/ui/base/Metadata";
1317
+
1318
+ /**
1319
+ * @SINCE 1.87
1320
+ *
1321
+ * Extension variant for ABAP multi tenant environments (via so called Predefined Fields)
1322
+ */
1323
+ interface MultiTenantABAPExtensibilityVariant {
1324
+ /**
1325
+ * Creates a new subclass of class sap.ui.fl.write._internal.fieldExtensibility.MultiTenantABAPExtensibilityVariant
1326
+ * with name `sClassName` and enriches it with the information contained in `oClassInfo`.
1327
+ *
1328
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.fl.write._internal.fieldExtensibility.ABAPExtensibilityVariant.extend}.
1329
+ *
1330
+ * @returns Created class / constructor function
1331
+ */
1332
+ extend(
1333
+ /**
1334
+ * Name of the class being created
1335
+ */
1336
+ sClassName: string,
1337
+ /**
1338
+ * Object literal with information about the class
1339
+ */
1340
+ oClassInfo?: object,
1341
+ /**
1342
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1343
+ * used by this class
1344
+ */
1345
+ FNMetaImpl?: Function
1346
+ ): Function;
1347
+ /**
1348
+ * Returns a metadata object for class sap.ui.fl.write._internal.fieldExtensibility.MultiTenantABAPExtensibilityVariant.
1349
+ *
1350
+ * @returns Metadata object describing this class
1351
+ */
1352
+ getMetadata(): Metadata;
1353
+ }
1354
+ const MultiTenantABAPExtensibilityVariant: MultiTenantABAPExtensibilityVariant;
1355
+ export default MultiTenantABAPExtensibilityVariant;
1356
+ }
1357
+
1358
+ declare module "sap/ui/fl/write/_internal/fieldExtensibility/SingleTenantABAPExtensibilityVariant" {
1359
+ import Metadata from "sap/ui/base/Metadata";
1360
+
1361
+ /**
1362
+ * @SINCE 1.87
1363
+ *
1364
+ * Extension variant for ABAP single tenant environnments (via so called Custom Fields)
1365
+ */
1366
+ interface SingleTenantABAPExtensibilityVariant {
1367
+ /**
1368
+ * Creates a new subclass of class sap.ui.fl.write._internal.fieldExtensibility.SingleTenantABAPExtensibilityVariant
1369
+ * with name `sClassName` and enriches it with the information contained in `oClassInfo`.
1370
+ *
1371
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.fl.write._internal.fieldExtensibility.ABAPExtensibilityVariant.extend}.
1372
+ *
1373
+ * @returns Created class / constructor function
1374
+ */
1375
+ extend(
1376
+ /**
1377
+ * Name of the class being created
1378
+ */
1379
+ sClassName: string,
1380
+ /**
1381
+ * Object literal with information about the class
1382
+ */
1383
+ oClassInfo?: object,
1384
+ /**
1385
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1386
+ * used by this class
1387
+ */
1388
+ FNMetaImpl?: Function
1389
+ ): Function;
1390
+ /**
1391
+ * Returns a metadata object for class sap.ui.fl.write._internal.fieldExtensibility.SingleTenantABAPExtensibilityVariant.
1392
+ *
1393
+ * @returns Metadata object describing this class
1394
+ */
1395
+ getMetadata(): Metadata;
1396
+ }
1397
+ const SingleTenantABAPExtensibilityVariant: SingleTenantABAPExtensibilityVariant;
1398
+ export default SingleTenantABAPExtensibilityVariant;
1399
+ }
1400
+
1401
+ declare module "sap/ui/fl/write/api/FeaturesAPI" {
1402
+ /**
1403
+ * @SINCE 1.70
1404
+ *
1405
+ * Provides an API to determine which features are available for flexibility.
1406
+ */
1407
+ interface FeaturesAPI {
1408
+ /**
1409
+ * Checks if key user rights are available for the current user. Application developers can use this API
1410
+ * to decide if the key user adaptation feature should be visible to the current user. This only applies
1411
+ * if key user adaptation should be handled standalone without an SAP Fiori launchpad.
1412
+ *
1413
+ * @returns Resolves to a boolean indicating if the key user role is assigned to the user
1414
+ */
1415
+ isKeyUser(): Promise<boolean>;
1416
+ }
1417
+ const FeaturesAPI: FeaturesAPI;
1418
+ export default FeaturesAPI;
1419
+ }
1420
+
1421
+ declare namespace sap {
1422
+ interface IUI5DefineDependencyNames {
1423
+ "sap/ui/fl/apply/_internal/changes/descriptor/app/AddAnnotationsToOData": undefined;
1424
+
1425
+ "sap/ui/fl/apply/_internal/changes/descriptor/app/AddNewInbound": undefined;
1426
+
1427
+ "sap/ui/fl/apply/_internal/changes/descriptor/app/ChangeDataSource": undefined;
1428
+
1429
+ "sap/ui/fl/apply/_internal/changes/descriptor/app/ChangeInbound": undefined;
1430
+
1431
+ "sap/ui/fl/apply/_internal/changes/descriptor/app/RemoveAllInboundsExceptOne": undefined;
1432
+
1433
+ "sap/ui/fl/apply/_internal/changes/descriptor/app/SetTitle": undefined;
1434
+
1435
+ "sap/ui/fl/apply/_internal/changes/descriptor/fiori/SetAbstract": undefined;
1436
+
1437
+ "sap/ui/fl/apply/_internal/changes/descriptor/fiori/SetRegistrationIds": undefined;
1438
+
1439
+ "sap/ui/fl/apply/_internal/changes/descriptor/ovp/AddNewCard": undefined;
1440
+
1441
+ "sap/ui/fl/apply/_internal/changes/descriptor/ovp/ChangeCard": undefined;
1442
+
1443
+ "sap/ui/fl/apply/_internal/changes/descriptor/ovp/DeleteCard": undefined;
1444
+
1445
+ "sap/ui/fl/apply/_internal/changes/descriptor/Preprocessor": undefined;
1446
+
1447
+ "sap/ui/fl/apply/_internal/changes/descriptor/Registration": undefined;
1448
+
1449
+ "sap/ui/fl/apply/_internal/changes/descriptor/RegistrationBuild": undefined;
1450
+
1451
+ "sap/ui/fl/apply/_internal/changes/descriptor/ui5/AddComponentUsages": undefined;
1452
+
1453
+ "sap/ui/fl/apply/_internal/changes/descriptor/ui5/AddLibrary": undefined;
1454
+
1455
+ "sap/ui/fl/apply/_internal/changes/descriptor/ui5/AddNewModel": undefined;
1456
+
1457
+ "sap/ui/fl/apply/_internal/changes/descriptor/ui5/AddNewModelEnhanceWith": undefined;
1458
+
1459
+ "sap/ui/fl/apply/_internal/changes/descriptor/ui5/SetFlexExtensionPointEnabled": undefined;
1460
+
1461
+ "sap/ui/fl/apply/_internal/changes/descriptor/ui5/SetMinUI5Version": undefined;
1462
+
1463
+ "sap/ui/fl/apply/_internal/changes/Utils": undefined;
1464
+
1465
+ "sap/ui/fl/apply/_internal/connectors/ObjectStorageConnector": undefined;
1466
+
1467
+ "sap/ui/fl/apply/_internal/controlVariants/URLHandler": undefined;
1468
+
1469
+ "sap/ui/fl/apply/_internal/flexObjects/AppDescriptorChange": undefined;
1470
+
1471
+ "sap/ui/fl/apply/_internal/flexObjects/CompVariant": undefined;
1472
+
1473
+ "sap/ui/fl/apply/_internal/flexObjects/ControllerExtensionChange": undefined;
1474
+
1475
+ "sap/ui/fl/apply/_internal/flexObjects/FlexObject": undefined;
1476
+
1477
+ "sap/ui/fl/apply/_internal/flexObjects/FlexObjectFactory": undefined;
1478
+
1479
+ "sap/ui/fl/apply/_internal/flexObjects/FlVariant": undefined;
1480
+
1481
+ "sap/ui/fl/apply/_internal/flexObjects/UIChange": undefined;
1482
+
1483
+ "sap/ui/fl/apply/_internal/flexObjects/UpdatableChange": undefined;
1484
+
1485
+ "sap/ui/fl/apply/_internal/flexObjects/Variant": undefined;
1486
+
1487
+ "sap/ui/fl/apply/_internal/flexState/changes/DependencyHandler": undefined;
1488
+
1489
+ "sap/ui/fl/apply/_internal/flexState/changes/ExtensionPointState": undefined;
1490
+
1491
+ "sap/ui/fl/apply/_internal/flexState/compVariants/CompVariantMerger": undefined;
1492
+
1493
+ "sap/ui/fl/apply/_internal/flexState/controlVariants/Switcher": undefined;
1494
+
1495
+ "sap/ui/fl/apply/_internal/flexState/controlVariants/VariantManagementState": undefined;
1496
+
1497
+ "sap/ui/fl/apply/_internal/flexState/DataSelector": undefined;
1498
+
1499
+ "sap/ui/fl/apply/_internal/flexState/FlexState": undefined;
1500
+
1501
+ "sap/ui/fl/apply/_internal/flexState/InitialPrepareFunctions": undefined;
1502
+
1503
+ "sap/ui/fl/apply/_internal/flexState/Loader": undefined;
1504
+
1505
+ "sap/ui/fl/apply/_internal/flexState/UI2Personalization/UI2PersonalizationState": undefined;
1506
+
1507
+ "sap/ui/fl/apply/_internal/preprocessors/ControllerExtension": undefined;
1508
+
1509
+ "sap/ui/fl/apply/_internal/preprocessors/EventHistory": undefined;
1510
+
1511
+ "sap/ui/fl/apply/api/ControlVariantApplyAPI": undefined;
1512
+
1513
+ "sap/ui/fl/apply/api/DelegateMediatorAPI": undefined;
1514
+
1515
+ "sap/ui/fl/apply/api/FlexRuntimeInfoAPI": undefined;
1516
+
1517
+ "sap/ui/fl/apply/api/SmartVariantManagementApplyAPI": undefined;
1518
+
1519
+ "sap/ui/fl/apply/api/UI2PersonalizationApplyAPI": undefined;
1520
+
1521
+ "sap/ui/fl/Cache": undefined;
1522
+
1523
+ "sap/ui/fl/changeHandler/Base": undefined;
1524
+
1525
+ "sap/ui/fl/ChangePersistenceFactory": undefined;
1526
+
1527
+ "sap/ui/fl/descriptorRelated/api/DescriptorChangeFactory": undefined;
1528
+
1529
+ "sap/ui/fl/descriptorRelated/api/DescriptorInlineChangeFactory": undefined;
1530
+
1531
+ "sap/ui/fl/descriptorRelated/api/DescriptorVariantFactory": undefined;
1532
+
1533
+ "sap/ui/fl/FlexControllerFactory": undefined;
1534
+
1535
+ "sap/ui/fl/initial/_internal/changeHandlers/ChangeRegistryItem": undefined;
1536
+
1537
+ "sap/ui/fl/initial/_internal/connectors/BackendConnector": undefined;
1538
+
1539
+ "sap/ui/fl/initial/_internal/connectors/KeyUserConnector": undefined;
1540
+
1541
+ "sap/ui/fl/initial/_internal/connectors/LrepConnector": undefined;
1542
+
1543
+ "sap/ui/fl/initial/_internal/connectors/NeoLrepConnector": undefined;
1544
+
1545
+ "sap/ui/fl/initial/_internal/connectors/PersonalizationConnector": undefined;
1546
+
1547
+ "sap/ui/fl/initial/_internal/connectors/StaticFileConnector": undefined;
1548
+
1549
+ "sap/ui/fl/initial/_internal/connectors/Utils": undefined;
1550
+
1551
+ "sap/ui/fl/initial/_internal/Storage": undefined;
1552
+
1553
+ "sap/ui/fl/initial/_internal/StorageUtils": undefined;
1554
+
1555
+ "sap/ui/fl/interfaces/BaseLoadConnector": undefined;
1556
+
1557
+ "sap/ui/fl/interfaces/Delegate": undefined;
1558
+
1559
+ "sap/ui/fl/library": undefined;
1560
+
1561
+ "sap/ui/fl/registry/Settings": undefined;
1562
+
1563
+ "sap/ui/fl/support/_internal/getChangeDependencies": undefined;
1564
+
1565
+ "sap/ui/fl/support/_internal/getFlexSettings": undefined;
1566
+
1567
+ "sap/ui/fl/support/api/SupportAPI": undefined;
1568
+
1569
+ "sap/ui/fl/transport/TransportDialog": undefined;
1570
+
1571
+ "sap/ui/fl/Utils": undefined;
1572
+
1573
+ "sap/ui/fl/variants/context/Component": undefined;
1574
+
1575
+ "sap/ui/fl/variants/VariantManagement": undefined;
1576
+
1577
+ "sap/ui/fl/variants/VariantModel": undefined;
1578
+
1579
+ "sap/ui/fl/write/_internal/appVariant/AppVariant": undefined;
1580
+
1581
+ "sap/ui/fl/write/_internal/appVariant/AppVariantFactory": undefined;
1582
+
1583
+ "sap/ui/fl/write/_internal/appVariant/AppVariantInlineChange": undefined;
1584
+
1585
+ "sap/ui/fl/write/_internal/appVariant/AppVariantInlineChangeFactory": undefined;
1586
+
1587
+ "sap/ui/fl/write/_internal/connectors/BackendConnector": undefined;
1588
+
1589
+ "sap/ui/fl/write/_internal/connectors/JsObjectConnector": undefined;
1590
+
1591
+ "sap/ui/fl/write/_internal/connectors/KeyUserConnector": undefined;
1592
+
1593
+ "sap/ui/fl/write/_internal/connectors/LocalStorageConnector": undefined;
1594
+
1595
+ "sap/ui/fl/write/_internal/connectors/LrepConnector": undefined;
1596
+
1597
+ "sap/ui/fl/write/_internal/connectors/NeoLrepConnector": undefined;
1598
+
1599
+ "sap/ui/fl/write/_internal/connectors/ObjectPathConnector": undefined;
1600
+
1601
+ "sap/ui/fl/write/_internal/connectors/ObjectStorageConnector": undefined;
1602
+
1603
+ "sap/ui/fl/write/_internal/connectors/PersonalizationConnector": undefined;
1604
+
1605
+ "sap/ui/fl/write/_internal/connectors/SessionStorageConnector": undefined;
1606
+
1607
+ "sap/ui/fl/write/_internal/connectors/Utils": undefined;
1608
+
1609
+ "sap/ui/fl/write/_internal/extensionPoint/Registry": undefined;
1610
+
1611
+ "sap/ui/fl/write/_internal/fieldExtensibility/ABAPExtensibilityVariant": undefined;
1612
+
1613
+ "sap/ui/fl/write/_internal/fieldExtensibility/MultiTenantABAPExtensibilityVariant": undefined;
1614
+
1615
+ "sap/ui/fl/write/_internal/fieldExtensibility/SingleTenantABAPExtensibilityVariant": undefined;
1616
+
1617
+ "sap/ui/fl/write/_internal/flexState/compVariants/CompVariantState": undefined;
1618
+
1619
+ "sap/ui/fl/write/_internal/flexState/FlexObjectState": undefined;
1620
+
1621
+ "sap/ui/fl/write/_internal/Storage": undefined;
1622
+
1623
+ "sap/ui/fl/write/_internal/StorageFeaturesMerger": undefined;
1624
+
1625
+ "sap/ui/fl/write/_internal/Versions": undefined;
1626
+
1627
+ "sap/ui/fl/write/api/AppVariantWriteAPI": undefined;
1628
+
1629
+ "sap/ui/fl/write/api/ChangesWriteAPI": undefined;
1630
+
1631
+ "sap/ui/fl/write/api/connectors/ObjectStorageConnector": undefined;
1632
+
1633
+ "sap/ui/fl/write/api/ContextBasedAdaptationsAPI": undefined;
1634
+
1635
+ "sap/ui/fl/write/api/ContextSharingAPI": undefined;
1636
+
1637
+ "sap/ui/fl/write/api/ControlPersonalizationWriteAPI": undefined;
1638
+
1639
+ "sap/ui/fl/write/api/ExtensionPointRegistryAPI": undefined;
1640
+
1641
+ "sap/ui/fl/write/api/FeaturesAPI": undefined;
1642
+
1643
+ "sap/ui/fl/write/api/FieldExtensibility": undefined;
1644
+
1645
+ "sap/ui/fl/write/api/LocalResetAPI": undefined;
1646
+
1647
+ "sap/ui/fl/write/api/PersistenceWriteAPI": undefined;
1648
+
1649
+ "sap/ui/fl/write/api/ReloadInfoAPI": undefined;
1650
+
1651
+ "sap/ui/fl/write/api/SmartBusinessWriteAPI": undefined;
1652
+
1653
+ "sap/ui/fl/write/api/SmartVariantManagementWriteAPI": undefined;
1654
+
1655
+ "sap/ui/fl/write/api/TranslationAPI": undefined;
1656
+
1657
+ "sap/ui/fl/write/api/UI2PersonalizationWriteAPI": undefined;
1658
+
1659
+ "sap/ui/fl/write/api/VersionsAPI": undefined;
1660
+
1661
+ "sap/ui/fl/write/connectors/BaseConnector": undefined;
1662
+ }
1663
+ }