@openui5/ts-types 1.104.0 → 1.105.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,1116 @@
1
- // For Library Version: 1.104.0
1
+ // For Library Version: 1.105.0
2
2
 
3
3
  declare namespace sap {
4
+ namespace ui {
5
+ /**
6
+ * This is the library for SAPUI5 flexibility. It includes the handling of changes made on applications,
7
+ * such as descriptor changes, app variants, UI changes, control variants (a.k.a. views), and personalization,
8
+ * as well as APIs for consumers. In addition, it provides the {@link sap.ui.fl.variants.VariantManagement}
9
+ * control, which enables applications to use control variants (views).
10
+ */
11
+ namespace fl {
12
+ /**
13
+ * The `sap.ui.fl.variants` namespace contains the {@link sap.ui.fl.variants.VariantManagement} control
14
+ * and its internals.
15
+ */
16
+ namespace variants {
17
+ interface $VariantManagementSettings
18
+ extends sap.ui.core.$ControlSettings {
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.
23
+ */
24
+ updateVariantInURL?:
25
+ | boolean
26
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
27
+ | `{${string}}`;
28
+
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.
33
+ */
34
+ resetOnContextChange?:
35
+ | boolean
36
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
37
+ | `{${string}}`;
38
+
39
+ /**
40
+ * The name of the model containing the data.
41
+ */
42
+ modelName?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
43
+
44
+ /**
45
+ * Indicated if the buttons on the 'My Views' are visible.
46
+ */
47
+ editable?:
48
+ | boolean
49
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
50
+ | `{${string}}`;
51
+
52
+ /**
53
+ * Indicated if the defaulting functionality is enabled.
54
+ */
55
+ showSetAsDefault?:
56
+ | boolean
57
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
58
+ | `{${string}}`;
59
+
60
+ /**
61
+ * If set to `true`, the key for a vendor variant will be added manually.
62
+ * **Note:** This flag is only used internally.
63
+ */
64
+ manualVariantKey?:
65
+ | boolean
66
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
67
+ | `{${string}}`;
68
+
69
+ /**
70
+ * Indicates that the control is in error state. If set to `true`, an error message will be displayed whenever
71
+ * the variant is opened.
72
+ */
73
+ inErrorState?:
74
+ | boolean
75
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
76
+ | `{${string}}`;
77
+
78
+ /**
79
+ * Determines the behavior for Apply Automatically if the standard variant is marked as the default variant.
80
+ */
81
+ executeOnSelectionForStandardDefault?:
82
+ | boolean
83
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
84
+ | `{${string}}`;
85
+
86
+ /**
87
+ * Defines the Apply Automatically text for the standard variant in the Manage Views dialog if the application
88
+ * controls this behavior. **Note:** the usage of this property is restricted to `sap.fe` components
89
+ * only.
90
+ */
91
+ displayTextForExecuteOnSelectionForStandardVariant?:
92
+ | string
93
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
94
+
95
+ /**
96
+ * @SINCE 1.104
97
+ *
98
+ * Semantic level of the header. For more information, see {@link sap.m.Title#setLevel}.
99
+ */
100
+ headerLevel?:
101
+ | sap.ui.core.TitleLevel
102
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
103
+ | `{${string}}`;
104
+
105
+ /**
106
+ * Contains the ids of the controls for which the variant management is responsible.
107
+ */
108
+ for?: Array<sap.ui.core.Control | string>;
109
+
110
+ /**
111
+ * This event is fired when the model and context are set.
112
+ */
113
+ initialized?: (oEvent: sap.ui.base.Event) => void;
114
+
115
+ /**
116
+ * This event is fired when the Save View dialog or the Save As dialog is closed with the
117
+ * save button.
118
+ */
119
+ save?: (oEvent: sap.ui.base.Event) => void;
120
+
121
+ /**
122
+ * This event is fired when users presses the cancel button inside Save As dialog.
123
+ */
124
+ cancel?: (oEvent: sap.ui.base.Event) => void;
125
+
126
+ /**
127
+ * This event is fired when users apply changes to variants in the Manage Views dialog.
128
+ */
129
+ manage?: (oEvent: sap.ui.base.Event) => void;
130
+
131
+ /**
132
+ * This event is fired when a new variant is selected.
133
+ */
134
+ select?: (oEvent: sap.ui.base.Event) => void;
135
+ }
136
+
137
+ /**
138
+ * @SINCE 1.56
139
+ *
140
+ * Can be used to manage variants. You can use this control in most controls that are enabled for key
141
+ * user adaptation.
142
+ * **Note: **On the user interface, variants are generally referred to as "views".
143
+ */
144
+ class VariantManagement
145
+ extends sap.ui.core.Control
146
+ implements sap.m.IOverflowToolbarContent {
147
+ __implements__sap_m_IOverflowToolbarContent: boolean;
148
+ /**
149
+ * Constructor for a new `VariantManagement`.
150
+ *
151
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
152
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
153
+ * of the syntax of the settings object.
154
+ * See:
155
+ * {@link topic:f1430c0337534d469da3a56307ff76af Key User Adaptation: Enable Your App}
156
+ */
157
+ constructor(
158
+ /**
159
+ * Initial settings for the new control
160
+ */
161
+ mSettings?: sap.ui.fl.variants.$VariantManagementSettings
162
+ );
163
+ /**
164
+ * Constructor for a new `VariantManagement`.
165
+ *
166
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
167
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
168
+ * of the syntax of the settings object.
169
+ * See:
170
+ * {@link topic:f1430c0337534d469da3a56307ff76af Key User Adaptation: Enable Your App}
171
+ */
172
+ constructor(
173
+ /**
174
+ * ID for the new control, generated automatically if no ID is given
175
+ */
176
+ sId?: string,
177
+ /**
178
+ * Initial settings for the new control
179
+ */
180
+ mSettings?: sap.ui.fl.variants.$VariantManagementSettings
181
+ );
182
+
183
+ /**
184
+ * Creates a new subclass of class sap.ui.fl.variants.VariantManagement with name `sClassName` and enriches
185
+ * it with the information contained in `oClassInfo`.
186
+ *
187
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
188
+ *
189
+ * @returns Created class / constructor function
190
+ */
191
+ static extend<T extends Record<string, unknown>>(
192
+ /**
193
+ * Name of the class being created
194
+ */
195
+ sClassName: string,
196
+ /**
197
+ * Object literal with information about the class
198
+ */
199
+ oClassInfo?: sap.ClassInfo<T, sap.ui.fl.variants.VariantManagement>,
200
+ /**
201
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
202
+ * used by this class
203
+ */
204
+ FNMetaImpl?: Function
205
+ ): Function;
206
+ /**
207
+ * Returns a metadata object for class sap.ui.fl.variants.VariantManagement.
208
+ *
209
+ * @returns Metadata object describing this class
210
+ */
211
+ static getMetadata(): sap.ui.core.ElementMetadata;
212
+ /**
213
+ * Adds a control to the association {@link #for for}.
214
+ *
215
+ * @returns Reference to `this` in order to allow method chaining
216
+ */
217
+ addFor(
218
+ /**
219
+ * The control to add; if empty, nothing is inserted
220
+ */
221
+ vFor: sap.ui.core.ID | sap.ui.core.Control
222
+ ): Object;
223
+ /**
224
+ * Attaches event handler `fnFunction` to the {@link #event:cancel cancel} event of this `sap.ui.fl.variants.VariantManagement`.
225
+ *
226
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
227
+ * otherwise it will be bound to this `sap.ui.fl.variants.VariantManagement` itself.
228
+ *
229
+ * This event is fired when users presses the cancel button inside Save As dialog.
230
+ *
231
+ * @returns Reference to `this` in order to allow method chaining
232
+ */
233
+ attachCancel(
234
+ /**
235
+ * An application-specific payload object that will be passed to the event handler along with the event
236
+ * object when firing the event
237
+ */
238
+ oData: object,
239
+ /**
240
+ * The function to be called when the event occurs
241
+ */
242
+ fnFunction: (p1: sap.ui.base.Event) => void,
243
+ /**
244
+ * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
245
+ * itself
246
+ */
247
+ oListener?: object
248
+ ): this;
249
+ /**
250
+ * Attaches event handler `fnFunction` to the {@link #event:cancel cancel} event of this `sap.ui.fl.variants.VariantManagement`.
251
+ *
252
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
253
+ * otherwise it will be bound to this `sap.ui.fl.variants.VariantManagement` itself.
254
+ *
255
+ * This event is fired when users presses the cancel button inside Save As dialog.
256
+ *
257
+ * @returns Reference to `this` in order to allow method chaining
258
+ */
259
+ attachCancel(
260
+ /**
261
+ * The function to be called when the event occurs
262
+ */
263
+ fnFunction: (p1: sap.ui.base.Event) => void,
264
+ /**
265
+ * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
266
+ * itself
267
+ */
268
+ oListener?: object
269
+ ): this;
270
+ /**
271
+ * Attaches event handler `fnFunction` to the {@link #event:initialized initialized} event of this `sap.ui.fl.variants.VariantManagement`.
272
+ *
273
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
274
+ * otherwise it will be bound to this `sap.ui.fl.variants.VariantManagement` itself.
275
+ *
276
+ * This event is fired when the model and context are set.
277
+ *
278
+ * @returns Reference to `this` in order to allow method chaining
279
+ */
280
+ attachInitialized(
281
+ /**
282
+ * An application-specific payload object that will be passed to the event handler along with the event
283
+ * object when firing the event
284
+ */
285
+ oData: object,
286
+ /**
287
+ * The function to be called when the event occurs
288
+ */
289
+ fnFunction: (p1: sap.ui.base.Event) => void,
290
+ /**
291
+ * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
292
+ * itself
293
+ */
294
+ oListener?: object
295
+ ): this;
296
+ /**
297
+ * Attaches event handler `fnFunction` to the {@link #event:initialized initialized} event of this `sap.ui.fl.variants.VariantManagement`.
298
+ *
299
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
300
+ * otherwise it will be bound to this `sap.ui.fl.variants.VariantManagement` itself.
301
+ *
302
+ * This event is fired when the model and context are set.
303
+ *
304
+ * @returns Reference to `this` in order to allow method chaining
305
+ */
306
+ attachInitialized(
307
+ /**
308
+ * The function to be called when the event occurs
309
+ */
310
+ fnFunction: (p1: sap.ui.base.Event) => void,
311
+ /**
312
+ * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
313
+ * itself
314
+ */
315
+ oListener?: object
316
+ ): this;
317
+ /**
318
+ * Attaches event handler `fnFunction` to the {@link #event:manage manage} event of this `sap.ui.fl.variants.VariantManagement`.
319
+ *
320
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
321
+ * otherwise it will be bound to this `sap.ui.fl.variants.VariantManagement` itself.
322
+ *
323
+ * This event is fired when users apply changes to variants in the Manage Views dialog.
324
+ *
325
+ * @returns Reference to `this` in order to allow method chaining
326
+ */
327
+ attachManage(
328
+ /**
329
+ * An application-specific payload object that will be passed to the event handler along with the event
330
+ * object when firing the event
331
+ */
332
+ oData: object,
333
+ /**
334
+ * The function to be called when the event occurs
335
+ */
336
+ fnFunction: (p1: sap.ui.base.Event) => void,
337
+ /**
338
+ * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
339
+ * itself
340
+ */
341
+ oListener?: object
342
+ ): this;
343
+ /**
344
+ * Attaches event handler `fnFunction` to the {@link #event:manage manage} event of this `sap.ui.fl.variants.VariantManagement`.
345
+ *
346
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
347
+ * otherwise it will be bound to this `sap.ui.fl.variants.VariantManagement` itself.
348
+ *
349
+ * This event is fired when users apply changes to variants in the Manage Views dialog.
350
+ *
351
+ * @returns Reference to `this` in order to allow method chaining
352
+ */
353
+ attachManage(
354
+ /**
355
+ * The function to be called when the event occurs
356
+ */
357
+ fnFunction: (p1: sap.ui.base.Event) => void,
358
+ /**
359
+ * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
360
+ * itself
361
+ */
362
+ oListener?: object
363
+ ): this;
364
+ /**
365
+ * Attaches event handler `fnFunction` to the {@link #event:save save} event of this `sap.ui.fl.variants.VariantManagement`.
366
+ *
367
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
368
+ * otherwise it will be bound to this `sap.ui.fl.variants.VariantManagement` itself.
369
+ *
370
+ * This event is fired when the Save View dialog or the Save As dialog is closed with the
371
+ * save button.
372
+ *
373
+ * @returns Reference to `this` in order to allow method chaining
374
+ */
375
+ attachSave(
376
+ /**
377
+ * An application-specific payload object that will be passed to the event handler along with the event
378
+ * object when firing the event
379
+ */
380
+ oData: object,
381
+ /**
382
+ * The function to be called when the event occurs
383
+ */
384
+ fnFunction: (p1: sap.ui.base.Event) => void,
385
+ /**
386
+ * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
387
+ * itself
388
+ */
389
+ oListener?: object
390
+ ): this;
391
+ /**
392
+ * Attaches event handler `fnFunction` to the {@link #event:save save} event of this `sap.ui.fl.variants.VariantManagement`.
393
+ *
394
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
395
+ * otherwise it will be bound to this `sap.ui.fl.variants.VariantManagement` itself.
396
+ *
397
+ * This event is fired when the Save View dialog or the Save As dialog is closed with the
398
+ * save button.
399
+ *
400
+ * @returns Reference to `this` in order to allow method chaining
401
+ */
402
+ attachSave(
403
+ /**
404
+ * The function to be called when the event occurs
405
+ */
406
+ fnFunction: (p1: sap.ui.base.Event) => void,
407
+ /**
408
+ * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
409
+ * itself
410
+ */
411
+ oListener?: object
412
+ ): this;
413
+ /**
414
+ * Attaches event handler `fnFunction` to the {@link #event:select select} event of this `sap.ui.fl.variants.VariantManagement`.
415
+ *
416
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
417
+ * otherwise it will be bound to this `sap.ui.fl.variants.VariantManagement` itself.
418
+ *
419
+ * This event is fired when a new variant is selected.
420
+ *
421
+ * @returns Reference to `this` in order to allow method chaining
422
+ */
423
+ attachSelect(
424
+ /**
425
+ * An application-specific payload object that will be passed to the event handler along with the event
426
+ * object when firing the event
427
+ */
428
+ oData: object,
429
+ /**
430
+ * The function to be called when the event occurs
431
+ */
432
+ fnFunction: (p1: sap.ui.base.Event) => void,
433
+ /**
434
+ * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
435
+ * itself
436
+ */
437
+ oListener?: object
438
+ ): this;
439
+ /**
440
+ * Attaches event handler `fnFunction` to the {@link #event:select select} event of this `sap.ui.fl.variants.VariantManagement`.
441
+ *
442
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
443
+ * otherwise it will be bound to this `sap.ui.fl.variants.VariantManagement` itself.
444
+ *
445
+ * This event is fired when a new variant is selected.
446
+ *
447
+ * @returns Reference to `this` in order to allow method chaining
448
+ */
449
+ attachSelect(
450
+ /**
451
+ * The function to be called when the event occurs
452
+ */
453
+ fnFunction: (p1: sap.ui.base.Event) => void,
454
+ /**
455
+ * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
456
+ * itself
457
+ */
458
+ oListener?: object
459
+ ): this;
460
+ /**
461
+ * Detaches event handler `fnFunction` from the {@link #event:cancel cancel} event of this `sap.ui.fl.variants.VariantManagement`.
462
+ *
463
+ * The passed function and listener object must match the ones used for event registration.
464
+ *
465
+ * @returns Reference to `this` in order to allow method chaining
466
+ */
467
+ detachCancel(
468
+ /**
469
+ * The function to be called, when the event occurs
470
+ */
471
+ fnFunction: (p1: sap.ui.base.Event) => void,
472
+ /**
473
+ * Context object on which the given function had to be called
474
+ */
475
+ oListener?: object
476
+ ): this;
477
+ /**
478
+ * Detaches event handler `fnFunction` from the {@link #event:initialized initialized} event of this `sap.ui.fl.variants.VariantManagement`.
479
+ *
480
+ * The passed function and listener object must match the ones used for event registration.
481
+ *
482
+ * @returns Reference to `this` in order to allow method chaining
483
+ */
484
+ detachInitialized(
485
+ /**
486
+ * The function to be called, when the event occurs
487
+ */
488
+ fnFunction: (p1: sap.ui.base.Event) => void,
489
+ /**
490
+ * Context object on which the given function had to be called
491
+ */
492
+ oListener?: object
493
+ ): this;
494
+ /**
495
+ * Detaches event handler `fnFunction` from the {@link #event:manage manage} event of this `sap.ui.fl.variants.VariantManagement`.
496
+ *
497
+ * The passed function and listener object must match the ones used for event registration.
498
+ *
499
+ * @returns Reference to `this` in order to allow method chaining
500
+ */
501
+ detachManage(
502
+ /**
503
+ * The function to be called, when the event occurs
504
+ */
505
+ fnFunction: (p1: sap.ui.base.Event) => void,
506
+ /**
507
+ * Context object on which the given function had to be called
508
+ */
509
+ oListener?: object
510
+ ): this;
511
+ /**
512
+ * Detaches event handler `fnFunction` from the {@link #event:save save} event of this `sap.ui.fl.variants.VariantManagement`.
513
+ *
514
+ * The passed function and listener object must match the ones used for event registration.
515
+ *
516
+ * @returns Reference to `this` in order to allow method chaining
517
+ */
518
+ detachSave(
519
+ /**
520
+ * The function to be called, when the event occurs
521
+ */
522
+ fnFunction: (p1: sap.ui.base.Event) => void,
523
+ /**
524
+ * Context object on which the given function had to be called
525
+ */
526
+ oListener?: object
527
+ ): this;
528
+ /**
529
+ * Detaches event handler `fnFunction` from the {@link #event:select select} event of this `sap.ui.fl.variants.VariantManagement`.
530
+ *
531
+ * The passed function and listener object must match the ones used for event registration.
532
+ *
533
+ * @returns Reference to `this` in order to allow method chaining
534
+ */
535
+ detachSelect(
536
+ /**
537
+ * The function to be called, when the event occurs
538
+ */
539
+ fnFunction: (p1: sap.ui.base.Event) => void,
540
+ /**
541
+ * Context object on which the given function had to be called
542
+ */
543
+ oListener?: object
544
+ ): this;
545
+ /**
546
+ * Fires event {@link #event:cancel cancel} to attached listeners.
547
+ *
548
+ * @returns Reference to `this` in order to allow method chaining
549
+ */
550
+ fireCancel(
551
+ /**
552
+ * Parameters to pass along with the event
553
+ */
554
+ mParameters?: object
555
+ ): this;
556
+ /**
557
+ * Fires event {@link #event:initialized initialized} to attached listeners.
558
+ *
559
+ * @returns Reference to `this` in order to allow method chaining
560
+ */
561
+ fireInitialized(
562
+ /**
563
+ * Parameters to pass along with the event
564
+ */
565
+ mParameters?: object
566
+ ): this;
567
+ /**
568
+ * Fires event {@link #event:manage manage} to attached listeners.
569
+ *
570
+ * @returns Reference to `this` in order to allow method chaining
571
+ */
572
+ fireManage(
573
+ /**
574
+ * Parameters to pass along with the event
575
+ */
576
+ mParameters?: {
577
+ /**
578
+ * List of changed variants. Each entry contains a 'key' - the variant key and a 'name' - the new title
579
+ * of the variant
580
+ */
581
+ renamed?: object[];
582
+ /**
583
+ * List of deleted variant keys
584
+ */
585
+ deleted?: string[];
586
+ /**
587
+ * List of variant keys and the associated Execute on Selection indicator
588
+ */
589
+ exe?: object[];
590
+ /**
591
+ * The default variant key
592
+ */
593
+ def?: string;
594
+ }
595
+ ): this;
596
+ /**
597
+ * Fires event {@link #event:save save} to attached listeners.
598
+ *
599
+ * @returns Reference to `this` in order to allow method chaining
600
+ */
601
+ fireSave(
602
+ /**
603
+ * Parameters to pass along with the event
604
+ */
605
+ mParameters?: {
606
+ /**
607
+ * Variant title
608
+ */
609
+ name?: string;
610
+ /**
611
+ * Indicates if an existing variant is overwritten or if a new variant is created.
612
+ */
613
+ overwrite?: boolean;
614
+ /**
615
+ * Variant key
616
+ */
617
+ key?: string;
618
+ /**
619
+ * Apply Automatically indicator
620
+ */
621
+ execute?: boolean;
622
+ /**
623
+ * Indicates the check box state for 'Public'.
624
+ */
625
+ public?: boolean;
626
+ /**
627
+ * The default variant indicator
628
+ */
629
+ def?: boolean;
630
+ /**
631
+ * Indicates the check box state for 'Create Tile'.
632
+ * Note:
633
+ * This event parameter is used only internally.
634
+ */
635
+ tile?: boolean;
636
+ }
637
+ ): this;
638
+ /**
639
+ * Fires event {@link #event:select select} to attached listeners.
640
+ *
641
+ * @returns Reference to `this` in order to allow method chaining
642
+ */
643
+ fireSelect(
644
+ /**
645
+ * Parameters to pass along with the event
646
+ */
647
+ mParameters?: {
648
+ /**
649
+ * Variant key
650
+ */
651
+ key?: string;
652
+ }
653
+ ): this;
654
+ /**
655
+ * Gets the currently selected variant key.
656
+ *
657
+ * @returns Key of the currently selected variant. In case the model is not yet set `null` will be returned.
658
+ */
659
+ getCurrentVariantKey(): string;
660
+ /**
661
+ * Gets current value of property {@link #getDisplayTextForExecuteOnSelectionForStandardVariant displayTextForExecuteOnSelectionForStandardVariant}.
662
+ *
663
+ * Defines the Apply Automatically text for the standard variant in the Manage Views dialog if the application
664
+ * controls this behavior. **Note:** the usage of this property is restricted to `sap.fe` components
665
+ * only.
666
+ *
667
+ * Default value is `empty string`.
668
+ *
669
+ * @returns Value of property `displayTextForExecuteOnSelectionForStandardVariant`
670
+ */
671
+ getDisplayTextForExecuteOnSelectionForStandardVariant(): string;
672
+ /**
673
+ * Gets current value of property {@link #getEditable editable}.
674
+ *
675
+ * Indicated if the buttons on the 'My Views' are visible.
676
+ *
677
+ * Default value is `true`.
678
+ *
679
+ * @returns Value of property `editable`
680
+ */
681
+ getEditable(): boolean;
682
+ /**
683
+ * Gets current value of property {@link #getExecuteOnSelectionForStandardDefault executeOnSelectionForStandardDefault}.
684
+ *
685
+ * Determines the behavior for Apply Automatically if the standard variant is marked as the default variant.
686
+ *
687
+ * Default value is `false`.
688
+ *
689
+ * @returns Value of property `executeOnSelectionForStandardDefault`
690
+ */
691
+ getExecuteOnSelectionForStandardDefault(): boolean;
692
+ /**
693
+ * Returns array of IDs of the elements which are the current targets of the association {@link #getFor
694
+ * for}.
695
+ */
696
+ getFor(): sap.ui.core.ID[];
697
+ /**
698
+ * @SINCE 1.104
699
+ *
700
+ * Gets current value of property {@link #getHeaderLevel headerLevel}.
701
+ *
702
+ * Semantic level of the header. For more information, see {@link sap.m.Title#setLevel}.
703
+ *
704
+ * Default value is `Auto`.
705
+ *
706
+ * @returns Value of property `headerLevel`
707
+ */
708
+ getHeaderLevel(): sap.ui.core.TitleLevel;
709
+ /**
710
+ * Gets current value of property {@link #getInErrorState inErrorState}.
711
+ *
712
+ * Indicates that the control is in error state. If set to `true`, an error message will be displayed whenever
713
+ * the variant is opened.
714
+ *
715
+ * Default value is `false`.
716
+ *
717
+ * @returns Value of property `inErrorState`
718
+ */
719
+ getInErrorState(): boolean;
720
+ /**
721
+ * Gets current value of property {@link #getManualVariantKey manualVariantKey}.
722
+ *
723
+ * If set to `true`, the key for a vendor variant will be added manually.
724
+ * **Note:** This flag is only used internally.
725
+ *
726
+ * Default value is `false`.
727
+ *
728
+ * @returns Value of property `manualVariantKey`
729
+ */
730
+ getManualVariantKey(): boolean;
731
+ /**
732
+ * Gets current value of property {@link #getModelName modelName}.
733
+ *
734
+ * The name of the model containing the data.
735
+ *
736
+ * Default value is `empty string`.
737
+ *
738
+ * @returns Value of property `modelName`
739
+ */
740
+ getModelName(): string;
741
+ /**
742
+ * Determines if the current variant is modified.
743
+ *
744
+ * @returns If the current variant is modified `true`, otherwise `false`
745
+ */
746
+ getModified(): boolean;
747
+ /**
748
+ * Required by the {@link sap.m.IOverflowToolbarContent} interface. Registers invalidations event which
749
+ * is fired when width of the control is changed.
750
+ *
751
+ * @returns Configuration information for the `sap.m.IOverflowToolbarContent` interface.
752
+ */
753
+ getOverflowToolbarConfig(): object;
754
+ /**
755
+ * Gets current value of property {@link #getResetOnContextChange resetOnContextChange}.
756
+ *
757
+ * When set to `false`, doesn't reset the `VariantManagement` control to the default variant, when its binding
758
+ * context is changed. **Note:** The `VariantManagement` control does not react in any way to this property.
759
+ * It is used internally by the flexibility layer.
760
+ *
761
+ * Default value is `true`.
762
+ *
763
+ * @returns Value of property `resetOnContextChange`
764
+ */
765
+ getResetOnContextChange(): boolean;
766
+ /**
767
+ * Gets current value of property {@link #getShowSetAsDefault showSetAsDefault}.
768
+ *
769
+ * Indicated if the defaulting functionality is enabled.
770
+ *
771
+ * Default value is `true`.
772
+ *
773
+ * @returns Value of property `showSetAsDefault`
774
+ */
775
+ getShowSetAsDefault(): boolean;
776
+ /**
777
+ * Gets current value of property {@link #getUpdateVariantInURL updateVariantInURL}.
778
+ *
779
+ * Determines the intention of setting the current variant based on passed information. **Note:** The
780
+ * `VariantManagement` control does not react in any way to this property. It is used internally by the
781
+ * flexibility layer.
782
+ *
783
+ * Default value is `false`.
784
+ *
785
+ * @returns Value of property `updateVariantInURL`
786
+ */
787
+ getUpdateVariantInURL(): boolean;
788
+ /**
789
+ * Retrieves all variants.
790
+ *
791
+ * @returns All variants. In case the model is not yet set, an empty array will be returned.
792
+ */
793
+ getVariants(): any[];
794
+ /**
795
+ * Removes all the controls in the association named {@link #getFor for}.
796
+ *
797
+ * @returns An array of the removed elements (might be empty)
798
+ */
799
+ removeAllFor(): sap.ui.core.ID[];
800
+ /**
801
+ * Removes an for from the association named {@link #getFor for}.
802
+ *
803
+ * @returns The removed for or `null`
804
+ */
805
+ removeFor(
806
+ /**
807
+ * The for to be removed or its index or ID
808
+ */
809
+ vFor: int | sap.ui.core.ID | sap.ui.core.Control
810
+ ): sap.ui.core.ID;
811
+ /**
812
+ * Sets the new selected variant.
813
+ */
814
+ setCurrentVariantKey(
815
+ /**
816
+ * Key of the variant that should be selected.
817
+ */
818
+ sKey: string
819
+ ): void;
820
+ /**
821
+ * Sets a new value for property {@link #getDisplayTextForExecuteOnSelectionForStandardVariant displayTextForExecuteOnSelectionForStandardVariant}.
822
+ *
823
+ * Defines the Apply Automatically text for the standard variant in the Manage Views dialog if the application
824
+ * controls this behavior. **Note:** the usage of this property is restricted to `sap.fe` components
825
+ * only.
826
+ *
827
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
828
+ *
829
+ * Default value is `empty string`.
830
+ *
831
+ * @returns Reference to `this` in order to allow method chaining
832
+ */
833
+ setDisplayTextForExecuteOnSelectionForStandardVariant(
834
+ /**
835
+ * New value for property `displayTextForExecuteOnSelectionForStandardVariant`
836
+ */
837
+ sDisplayTextForExecuteOnSelectionForStandardVariant?: string
838
+ ): this;
839
+ /**
840
+ * Sets a new value for property {@link #getEditable editable}.
841
+ *
842
+ * Indicated if the buttons on the 'My Views' are visible.
843
+ *
844
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
845
+ *
846
+ * Default value is `true`.
847
+ *
848
+ * @returns Reference to `this` in order to allow method chaining
849
+ */
850
+ setEditable(
851
+ /**
852
+ * New value for property `editable`
853
+ */
854
+ bEditable?: boolean
855
+ ): this;
856
+ /**
857
+ * Sets a new value for property {@link #getExecuteOnSelectionForStandardDefault executeOnSelectionForStandardDefault}.
858
+ *
859
+ * Determines the behavior for Apply Automatically if the standard variant is marked as the default variant.
860
+ *
861
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
862
+ *
863
+ * Default value is `false`.
864
+ *
865
+ * @returns Reference to `this` in order to allow method chaining
866
+ */
867
+ setExecuteOnSelectionForStandardDefault(
868
+ /**
869
+ * New value for property `executeOnSelectionForStandardDefault`
870
+ */
871
+ bExecuteOnSelectionForStandardDefault?: boolean
872
+ ): this;
873
+ /**
874
+ * @SINCE 1.104
875
+ *
876
+ * Sets a new value for property {@link #getHeaderLevel headerLevel}.
877
+ *
878
+ * Semantic level of the header. For more information, see {@link sap.m.Title#setLevel}.
879
+ *
880
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
881
+ *
882
+ * Default value is `Auto`.
883
+ *
884
+ * @returns Reference to `this` in order to allow method chaining
885
+ */
886
+ setHeaderLevel(
887
+ /**
888
+ * New value for property `headerLevel`
889
+ */
890
+ sHeaderLevel?: sap.ui.core.TitleLevel
891
+ ): this;
892
+ /**
893
+ * Sets a new value for property {@link #getInErrorState inErrorState}.
894
+ *
895
+ * Indicates that the control is in error state. If set to `true`, an error message will be displayed whenever
896
+ * the variant is opened.
897
+ *
898
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
899
+ *
900
+ * Default value is `false`.
901
+ *
902
+ * @returns Reference to `this` in order to allow method chaining
903
+ */
904
+ setInErrorState(
905
+ /**
906
+ * New value for property `inErrorState`
907
+ */
908
+ bInErrorState?: boolean
909
+ ): this;
910
+ /**
911
+ * Sets a new value for property {@link #getManualVariantKey manualVariantKey}.
912
+ *
913
+ * If set to `true`, the key for a vendor variant will be added manually.
914
+ * **Note:** This flag is only used internally.
915
+ *
916
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
917
+ *
918
+ * Default value is `false`.
919
+ *
920
+ * @returns Reference to `this` in order to allow method chaining
921
+ */
922
+ setManualVariantKey(
923
+ /**
924
+ * New value for property `manualVariantKey`
925
+ */
926
+ bManualVariantKey?: boolean
927
+ ): this;
928
+ /**
929
+ * Sets a new value for property {@link #getModelName modelName}.
930
+ *
931
+ * The name of the model containing the data.
932
+ *
933
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
934
+ *
935
+ * Default value is `empty string`.
936
+ *
937
+ * @returns Reference to `this` in order to allow method chaining
938
+ */
939
+ setModelName(
940
+ /**
941
+ * New value for property `modelName`
942
+ */
943
+ sModelName?: string
944
+ ): this;
945
+ /**
946
+ * Sets a new value for property {@link #getResetOnContextChange resetOnContextChange}.
947
+ *
948
+ * When set to `false`, doesn't reset the `VariantManagement` control to the default variant, when its binding
949
+ * context is changed. **Note:** The `VariantManagement` control does not react in any way to this property.
950
+ * It is used internally by the flexibility layer.
951
+ *
952
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
953
+ *
954
+ * Default value is `true`.
955
+ *
956
+ * @returns Reference to `this` in order to allow method chaining
957
+ */
958
+ setResetOnContextChange(
959
+ /**
960
+ * New value for property `resetOnContextChange`
961
+ */
962
+ bResetOnContextChange?: boolean
963
+ ): this;
964
+ /**
965
+ * Sets a new value for property {@link #getShowSetAsDefault showSetAsDefault}.
966
+ *
967
+ * Indicated if the defaulting functionality is enabled.
968
+ *
969
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
970
+ *
971
+ * Default value is `true`.
972
+ *
973
+ * @returns Reference to `this` in order to allow method chaining
974
+ */
975
+ setShowSetAsDefault(
976
+ /**
977
+ * New value for property `showSetAsDefault`
978
+ */
979
+ bShowSetAsDefault?: boolean
980
+ ): this;
981
+ /**
982
+ * Sets a new value for property {@link #getUpdateVariantInURL updateVariantInURL}.
983
+ *
984
+ * Determines the intention of setting the current variant based on passed information. **Note:** The
985
+ * `VariantManagement` control does not react in any way to this property. It is used internally by the
986
+ * flexibility layer.
987
+ *
988
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
989
+ *
990
+ * Default value is `false`.
991
+ *
992
+ * @returns Reference to `this` in order to allow method chaining
993
+ */
994
+ setUpdateVariantInURL(
995
+ /**
996
+ * New value for property `updateVariantInURL`
997
+ */
998
+ bUpdateVariantInURL?: boolean
999
+ ): this;
1000
+ }
1001
+ }
1002
+ /**
1003
+ * The `sap.ui.fl.write` namespace contains all code to create, update, and reset flex objects. Additional
1004
+ * common functionality needed by personalization dialogs or tools like key user adaptation are part of
1005
+ * the namespace.
1006
+ */
1007
+ namespace write {
1008
+ /**
1009
+ * The `sap.ui.fl.write.api` namespace contains public APIs to work with flex objects.
1010
+ */
1011
+ namespace api {
1012
+ /**
1013
+ * @SINCE 1.70
1014
+ *
1015
+ * Provides an API to determine which features are available for flexibility.
1016
+ */
1017
+ interface FeaturesAPI {
1018
+ /**
1019
+ * Checks if key user rights are available for the current user. Application developers can use this API
1020
+ * to decide if the key user adaptation feature should be visible to the current user. This only applies
1021
+ * if key user adaptation should be handled standalone without an SAP Fiori launchpad.
1022
+ *
1023
+ * @returns Resolves to a boolean indicating if the key user role is assigned to the user
1024
+ */
1025
+ isKeyUser(): Promise<boolean>;
1026
+ }
1027
+ const FeaturesAPI: FeaturesAPI;
1028
+ }
1029
+ }
1030
+
1031
+ namespace transport {
1032
+ interface $TransportDialogSettings extends sap.m.$DialogSettings {}
1033
+
1034
+ /**
1035
+ * @deprecated (since 1.74) - The TransportDialog should be used only internally inside the `sap.ui.fl`
1036
+ * library.
1037
+ *
1038
+ * The Transport Dialog Control can be used to implement a value help for selecting an ABAP package and
1039
+ * transport request. It is not a generic utility, but part of the Variantmanament and therefore cannot
1040
+ * be used in any other application.
1041
+ */
1042
+ class TransportDialog extends sap.m.Dialog {
1043
+ /**
1044
+ * Constructor for a new transport/TransportDialog.
1045
+ *
1046
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1047
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1048
+ * of the syntax of the settings object.
1049
+ *
1050
+ * This class does not have its own settings, but all settings applicable to the base type {@link sap.m.Dialog#constructor
1051
+ * sap.m.Dialog} can be used.
1052
+ */
1053
+ constructor(
1054
+ /**
1055
+ * initial settings for the new control
1056
+ */
1057
+ mSettings?: sap.ui.fl.transport.$TransportDialogSettings
1058
+ );
1059
+ /**
1060
+ * Constructor for a new transport/TransportDialog.
1061
+ *
1062
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1063
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1064
+ * of the syntax of the settings object.
1065
+ *
1066
+ * This class does not have its own settings, but all settings applicable to the base type {@link sap.m.Dialog#constructor
1067
+ * sap.m.Dialog} can be used.
1068
+ */
1069
+ constructor(
1070
+ /**
1071
+ * id for the new control, generated automatically if no id is given
1072
+ */
1073
+ sId?: string,
1074
+ /**
1075
+ * initial settings for the new control
1076
+ */
1077
+ mSettings?: sap.ui.fl.transport.$TransportDialogSettings
1078
+ );
1079
+
1080
+ /**
1081
+ * Creates a new subclass of class sap.ui.fl.transport.TransportDialog with name `sClassName` and enriches
1082
+ * it with the information contained in `oClassInfo`.
1083
+ *
1084
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.m.Dialog.extend}.
1085
+ *
1086
+ * @returns Created class / constructor function
1087
+ */
1088
+ static extend<T extends Record<string, unknown>>(
1089
+ /**
1090
+ * Name of the class being created
1091
+ */
1092
+ sClassName: string,
1093
+ /**
1094
+ * Object literal with information about the class
1095
+ */
1096
+ oClassInfo?: sap.ClassInfo<T, sap.ui.fl.transport.TransportDialog>,
1097
+ /**
1098
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1099
+ * used by this class
1100
+ */
1101
+ FNMetaImpl?: Function
1102
+ ): Function;
1103
+ /**
1104
+ * Returns a metadata object for class sap.ui.fl.transport.TransportDialog.
1105
+ *
1106
+ * @returns Metadata object describing this class
1107
+ */
1108
+ static getMetadata(): sap.ui.core.ElementMetadata;
1109
+ }
1110
+ }
1111
+ }
1112
+ }
1113
+
4
1114
  interface IUI5DefineDependencyNames {
5
1115
  "sap/ui/fl/apply/_internal/changes/descriptor/app/AddAnnotationsToOData": undefined;
6
1116
 
@@ -44,14 +1154,20 @@ declare namespace sap {
44
1154
 
45
1155
  "sap/ui/fl/apply/_internal/controlVariants/URLHandler": undefined;
46
1156
 
1157
+ "sap/ui/fl/apply/_internal/flexObjects/AppDescriptorChange": undefined;
1158
+
47
1159
  "sap/ui/fl/apply/_internal/flexObjects/CompVariant": undefined;
48
1160
 
49
1161
  "sap/ui/fl/apply/_internal/flexObjects/CompVariantRevertData": undefined;
50
1162
 
1163
+ "sap/ui/fl/apply/_internal/flexObjects/ControllerExtensionChange": undefined;
1164
+
51
1165
  "sap/ui/fl/apply/_internal/flexObjects/FlexObject": undefined;
52
1166
 
53
1167
  "sap/ui/fl/apply/_internal/flexObjects/FlexObjectFactory": undefined;
54
1168
 
1169
+ "sap/ui/fl/apply/_internal/flexObjects/FlVariant": undefined;
1170
+
55
1171
  "sap/ui/fl/apply/_internal/flexObjects/RevertData": undefined;
56
1172
 
57
1173
  "sap/ui/fl/apply/_internal/flexObjects/UpdatableChange": undefined;
@@ -78,8 +1194,6 @@ declare namespace sap {
78
1194
 
79
1195
  "sap/ui/fl/apply/_internal/preprocessors/EventHistory": undefined;
80
1196
 
81
- "sap/ui/fl/apply/api/ControlVariantApplyAPI": undefined;
82
-
83
1197
  "sap/ui/fl/apply/api/DelegateMediatorAPI": undefined;
84
1198
 
85
1199
  "sap/ui/fl/apply/api/FlexRuntimeInfoAPI": undefined;
@@ -94,8 +1208,6 @@ declare namespace sap {
94
1208
 
95
1209
  "sap/ui/fl/changeHandler/Base": undefined;
96
1210
 
97
- "sap/ui/fl/changeHandler/BaseAddViaDelegate": undefined;
98
-
99
1211
  "sap/ui/fl/ChangePersistenceFactory": undefined;
100
1212
 
101
1213
  "sap/ui/fl/descriptorRelated/api/DescriptorChangeFactory": undefined;