@openui5/types 1.120.7 → 1.121.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.7
1
+ // For Library Version: 1.121.0
2
2
 
3
3
  declare module "sap/ui/fl/library" {}
4
4
 
@@ -6,14 +6,15 @@ declare module "sap/ui/fl/apply/api/ControlVariantApplyAPI" {
6
6
  import ManagedObject from "sap/ui/base/ManagedObject";
7
7
 
8
8
  /**
9
- * @since 1.67
10
- *
11
9
  * Provides an API for applications to work with control variants. See also {@link sap.ui.fl.variants.VariantManagement}.
10
+ *
11
+ * @since 1.67
12
12
  */
13
13
  interface ControlVariantApplyAPI {
14
14
  /**
15
15
  * Activates the passed variant applicable to the passed control/component.
16
16
  *
17
+ *
17
18
  * @returns Resolves after the variant is activated or rejects if an error occurs
18
19
  */
19
20
  activateVariant(
@@ -108,12 +109,12 @@ declare module "sap/ui/fl/transport/TransportDialog" {
108
109
  import ElementMetadata from "sap/ui/core/ElementMetadata";
109
110
 
110
111
  /**
111
- * @deprecated (since 1.74) - The TransportDialog should be used only internally inside the `sap.ui.fl`
112
- * library.
113
- *
114
112
  * The Transport Dialog Control can be used to implement a value help for selecting an ABAP package and
115
113
  * transport request. It is not a generic utility, but part of the Variantmanament and therefore cannot
116
114
  * be used in any other application.
115
+ *
116
+ * @deprecated (since 1.74) - The TransportDialog should be used only internally inside the `sap.ui.fl`
117
+ * library.
117
118
  */
118
119
  export default class TransportDialog extends Dialog {
119
120
  /**
@@ -159,6 +160,7 @@ declare module "sap/ui/fl/transport/TransportDialog" {
159
160
  *
160
161
  * `oClassInfo` might contain the same kind of information as described in {@link sap.m.Dialog.extend}.
161
162
  *
163
+ *
162
164
  * @returns Created class / constructor function
163
165
  */
164
166
  static extend<T extends Record<string, unknown>>(
@@ -179,6 +181,7 @@ declare module "sap/ui/fl/transport/TransportDialog" {
179
181
  /**
180
182
  * Returns a metadata object for class sap.ui.fl.transport.TransportDialog.
181
183
  *
184
+ *
182
185
  * @returns Metadata object describing this class
183
186
  */
184
187
  static getMetadata(): ElementMetadata;
@@ -201,11 +204,11 @@ declare module "sap/ui/fl/variants/VariantManagement" {
201
204
  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
202
205
 
203
206
  /**
204
- * @since 1.56
205
- *
206
207
  * Can be used to manage variants. You can use this control in most controls that are enabled for key
207
208
  * user adaptation.
208
209
  * **Note: **On the user interface, variants are generally referred to as "views".
210
+ *
211
+ * @since 1.56
209
212
  */
210
213
  export default class VariantManagement
211
214
  extends Control
@@ -257,6 +260,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
257
260
  *
258
261
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
259
262
  *
263
+ *
260
264
  * @returns Created class / constructor function
261
265
  */
262
266
  static extend<T extends Record<string, unknown>>(
@@ -277,12 +281,14 @@ declare module "sap/ui/fl/variants/VariantManagement" {
277
281
  /**
278
282
  * Returns a metadata object for class sap.ui.fl.variants.VariantManagement.
279
283
  *
284
+ *
280
285
  * @returns Metadata object describing this class
281
286
  */
282
287
  static getMetadata(): ElementMetadata;
283
288
  /**
284
289
  * Adds a control to the association {@link #for for}.
285
290
  *
291
+ *
286
292
  * @returns Reference to `this` in order to allow method chaining
287
293
  */
288
294
  addFor(
@@ -297,7 +303,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
297
303
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
298
304
  * otherwise it will be bound to this `sap.ui.fl.variants.VariantManagement` itself.
299
305
  *
300
- * This event is fired when users presses the cancel button inside Save As dialog.
306
+ * This event is fired when users press the Cancel button inside the Save As dialog.
307
+ *
301
308
  *
302
309
  * @returns Reference to `this` in order to allow method chaining
303
310
  */
@@ -323,7 +330,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
323
330
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
324
331
  * otherwise it will be bound to this `sap.ui.fl.variants.VariantManagement` itself.
325
332
  *
326
- * This event is fired when users presses the cancel button inside Save As dialog.
333
+ * This event is fired when users press the Cancel button inside the Save As dialog.
334
+ *
327
335
  *
328
336
  * @returns Reference to `this` in order to allow method chaining
329
337
  */
@@ -346,6 +354,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
346
354
  *
347
355
  * This event is fired when the model and context are set.
348
356
  *
357
+ *
349
358
  * @returns Reference to `this` in order to allow method chaining
350
359
  */
351
360
  attachInitialized(
@@ -372,6 +381,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
372
381
  *
373
382
  * This event is fired when the model and context are set.
374
383
  *
384
+ *
375
385
  * @returns Reference to `this` in order to allow method chaining
376
386
  */
377
387
  attachInitialized(
@@ -393,6 +403,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
393
403
  *
394
404
  * This event is fired when users apply changes to variants in the Manage Views dialog.
395
405
  *
406
+ *
396
407
  * @returns Reference to `this` in order to allow method chaining
397
408
  */
398
409
  attachManage(
@@ -419,6 +430,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
419
430
  *
420
431
  * This event is fired when users apply changes to variants in the Manage Views dialog.
421
432
  *
433
+ *
422
434
  * @returns Reference to `this` in order to allow method chaining
423
435
  */
424
436
  attachManage(
@@ -438,8 +450,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
438
450
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
439
451
  * otherwise it will be bound to this `sap.ui.fl.variants.VariantManagement` itself.
440
452
  *
441
- * This event is fired when the Save View dialog or the Save As dialog is closed with the
442
- * save button.
453
+ * This event is fired when the Save View dialog or the Save As dialog is closed with the Save button.
454
+ *
443
455
  *
444
456
  * @returns Reference to `this` in order to allow method chaining
445
457
  */
@@ -465,8 +477,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
465
477
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
466
478
  * otherwise it will be bound to this `sap.ui.fl.variants.VariantManagement` itself.
467
479
  *
468
- * This event is fired when the Save View dialog or the Save As dialog is closed with the
469
- * save button.
480
+ * This event is fired when the Save View dialog or the Save As dialog is closed with the Save button.
481
+ *
470
482
  *
471
483
  * @returns Reference to `this` in order to allow method chaining
472
484
  */
@@ -489,6 +501,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
489
501
  *
490
502
  * This event is fired when a new variant is selected.
491
503
  *
504
+ *
492
505
  * @returns Reference to `this` in order to allow method chaining
493
506
  */
494
507
  attachSelect(
@@ -515,6 +528,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
515
528
  *
516
529
  * This event is fired when a new variant is selected.
517
530
  *
531
+ *
518
532
  * @returns Reference to `this` in order to allow method chaining
519
533
  */
520
534
  attachSelect(
@@ -533,6 +547,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
533
547
  *
534
548
  * The passed function and listener object must match the ones used for event registration.
535
549
  *
550
+ *
536
551
  * @returns Reference to `this` in order to allow method chaining
537
552
  */
538
553
  detachCancel(
@@ -550,6 +565,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
550
565
  *
551
566
  * The passed function and listener object must match the ones used for event registration.
552
567
  *
568
+ *
553
569
  * @returns Reference to `this` in order to allow method chaining
554
570
  */
555
571
  detachInitialized(
@@ -567,6 +583,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
567
583
  *
568
584
  * The passed function and listener object must match the ones used for event registration.
569
585
  *
586
+ *
570
587
  * @returns Reference to `this` in order to allow method chaining
571
588
  */
572
589
  detachManage(
@@ -584,6 +601,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
584
601
  *
585
602
  * The passed function and listener object must match the ones used for event registration.
586
603
  *
604
+ *
587
605
  * @returns Reference to `this` in order to allow method chaining
588
606
  */
589
607
  detachSave(
@@ -601,6 +619,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
601
619
  *
602
620
  * The passed function and listener object must match the ones used for event registration.
603
621
  *
622
+ *
604
623
  * @returns Reference to `this` in order to allow method chaining
605
624
  */
606
625
  detachSelect(
@@ -614,10 +633,10 @@ declare module "sap/ui/fl/variants/VariantManagement" {
614
633
  oListener?: object
615
634
  ): this;
616
635
  /**
617
- * @ui5-protected Do not call from applications (only from related classes in the framework)
618
- *
619
636
  * Fires event {@link #event:cancel cancel} to attached listeners.
620
637
  *
638
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
639
+ *
621
640
  * @returns Reference to `this` in order to allow method chaining
622
641
  */
623
642
  fireCancel(
@@ -627,10 +646,10 @@ declare module "sap/ui/fl/variants/VariantManagement" {
627
646
  mParameters?: object
628
647
  ): this;
629
648
  /**
630
- * @ui5-protected Do not call from applications (only from related classes in the framework)
631
- *
632
649
  * Fires event {@link #event:initialized initialized} to attached listeners.
633
650
  *
651
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
652
+ *
634
653
  * @returns Reference to `this` in order to allow method chaining
635
654
  */
636
655
  fireInitialized(
@@ -640,10 +659,10 @@ declare module "sap/ui/fl/variants/VariantManagement" {
640
659
  mParameters?: object
641
660
  ): this;
642
661
  /**
643
- * @ui5-protected Do not call from applications (only from related classes in the framework)
644
- *
645
662
  * Fires event {@link #event:manage manage} to attached listeners.
646
663
  *
664
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
665
+ *
647
666
  * @returns Reference to `this` in order to allow method chaining
648
667
  */
649
668
  fireManage(
@@ -653,10 +672,10 @@ declare module "sap/ui/fl/variants/VariantManagement" {
653
672
  mParameters?: VariantManagement$ManageEventParameters
654
673
  ): this;
655
674
  /**
656
- * @ui5-protected Do not call from applications (only from related classes in the framework)
657
- *
658
675
  * Fires event {@link #event:save save} to attached listeners.
659
676
  *
677
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
678
+ *
660
679
  * @returns Reference to `this` in order to allow method chaining
661
680
  */
662
681
  fireSave(
@@ -666,10 +685,10 @@ declare module "sap/ui/fl/variants/VariantManagement" {
666
685
  mParameters?: VariantManagement$SaveEventParameters
667
686
  ): this;
668
687
  /**
669
- * @ui5-protected Do not call from applications (only from related classes in the framework)
670
- *
671
688
  * Fires event {@link #event:select select} to attached listeners.
672
689
  *
690
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
691
+ *
673
692
  * @returns Reference to `this` in order to allow method chaining
674
693
  */
675
694
  fireSelect(
@@ -681,28 +700,31 @@ declare module "sap/ui/fl/variants/VariantManagement" {
681
700
  /**
682
701
  * Gets the currently selected variant key.
683
702
  *
684
- * @returns Key of the currently selected variant. In case the model is not yet set `null` will be returned.
703
+ *
704
+ * @returns Key of the currently selected variant. In case the model is not yet set `null` will be returned
685
705
  */
686
706
  getCurrentVariantKey(): string | null;
687
707
  /**
688
708
  * Gets current value of property {@link #getDisplayTextForExecuteOnSelectionForStandardVariant displayTextForExecuteOnSelectionForStandardVariant}.
689
709
  *
690
710
  * Defines the Apply Automatically text for the standard variant in the Manage Views dialog if the application
691
- * controls this behavior. **Note:** the usage of this property is restricted to `sap.fe` components
711
+ * controls this behavior. **Note:** The usage of this property is restricted to `sap.fe` components
692
712
  * only.
693
713
  *
694
714
  * Default value is `empty string`.
695
715
  *
716
+ *
696
717
  * @returns Value of property `displayTextForExecuteOnSelectionForStandardVariant`
697
718
  */
698
719
  getDisplayTextForExecuteOnSelectionForStandardVariant(): string;
699
720
  /**
700
721
  * Gets current value of property {@link #getEditable editable}.
701
722
  *
702
- * Indicated if the buttons on the 'My Views' are visible.
723
+ * Indicates whether the buttons on My Views are visible.
703
724
  *
704
725
  * Default value is `true`.
705
726
  *
727
+ *
706
728
  * @returns Value of property `editable`
707
729
  */
708
730
  getEditable(): boolean;
@@ -713,6 +735,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
713
735
  *
714
736
  * Default value is `false`.
715
737
  *
738
+ *
716
739
  * @returns Value of property `executeOnSelectionForStandardDefault`
717
740
  */
718
741
  getExecuteOnSelectionForStandardDefault(): boolean;
@@ -721,37 +744,38 @@ declare module "sap/ui/fl/variants/VariantManagement" {
721
744
  */
722
745
  getFor(): ID[];
723
746
  /**
724
- * @since 1.104
725
- *
726
747
  * Gets current value of property {@link #getHeaderLevel headerLevel}.
727
748
  *
728
749
  * Semantic level of the header. For more information, see {@link sap.m.Title#setLevel}.
729
750
  *
730
751
  * Default value is `Auto`.
731
752
  *
753
+ * @since 1.104
754
+ *
732
755
  * @returns Value of property `headerLevel`
733
756
  */
734
757
  getHeaderLevel(): TitleLevel | keyof typeof TitleLevel;
735
758
  /**
736
759
  * Gets current value of property {@link #getInErrorState inErrorState}.
737
760
  *
738
- * Indicates that the control is in error state. If set to `true`, an error message will be displayed whenever
739
- * the variant is opened.
761
+ * Indicates whether the control is in error state. If set to `true`, an error message will be displayed
762
+ * when the variant is opened.
740
763
  *
741
764
  * Default value is `false`.
742
765
  *
766
+ *
743
767
  * @returns Value of property `inErrorState`
744
768
  */
745
769
  getInErrorState(): boolean;
746
770
  /**
747
- * @since 1.109
748
- *
749
771
  * Gets current value of property {@link #getMaxWidth maxWidth}.
750
772
  *
751
773
  * Sets the maximum width of the control.
752
774
  *
753
775
  * Default value is `"100%"`.
754
776
  *
777
+ * @since 1.109
778
+ *
755
779
  * @returns Value of property `maxWidth`
756
780
  */
757
781
  getMaxWidth(): CSSSize;
@@ -762,22 +786,24 @@ declare module "sap/ui/fl/variants/VariantManagement" {
762
786
  *
763
787
  * Default value is `empty string`.
764
788
  *
789
+ *
765
790
  * @returns Value of property `modelName`
766
791
  */
767
792
  getModelName(): string;
768
793
  /**
769
- * Determines if the current variant is modified.
794
+ * Determines whether the current variant is modified.
770
795
  *
771
- * @returns If the current variant is modified `true`, otherwise `false`
796
+ *
797
+ * @returns Returns `true`, if the current variant is modified, otherwise `false`
772
798
  */
773
799
  getModified(): boolean;
774
800
  /**
775
- * @ui5-protected Do not call from applications (only from related classes in the framework)
801
+ * Registers an invalidation event that is fired when the width of the control is changed. **Note:** This
802
+ * is required by the {@link sap.m.IOverflowToolbarContent} interface.
776
803
  *
777
- * Required by the {@link sap.m.IOverflowToolbarContent} interface. Registers invalidations event which
778
- * is fired when width of the control is changed.
804
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
779
805
  *
780
- * @returns Configuration information for the `sap.m.IOverflowToolbarContent` interface.
806
+ * @returns Configuration information for the {@link sap.m.IOverflowToolbarContent} interface
781
807
  */
782
808
  getOverflowToolbarConfig(): {
783
809
  canOverflow: boolean;
@@ -787,64 +813,71 @@ declare module "sap/ui/fl/variants/VariantManagement" {
787
813
  /**
788
814
  * Gets current value of property {@link #getResetOnContextChange resetOnContextChange}.
789
815
  *
790
- * When set to `false`, doesn't reset the `VariantManagement` control to the default variant, when its binding
791
- * context is changed. **Note:** The `VariantManagement` control does not react in any way to this property.
792
- * It is used internally by the flexibility layer.
816
+ * If set to `false`, it does not reset the `VariantManagement` control to the default variant if its binding
817
+ * context is changed. **Note:** The `VariantManagement` control itself is not affected by this property.
818
+ * It is only used internally by the SAPUI5 flexibility layer.
793
819
  *
794
820
  * Default value is `true`.
795
821
  *
822
+ *
796
823
  * @returns Value of property `resetOnContextChange`
797
824
  */
798
825
  getResetOnContextChange(): boolean;
799
826
  /**
800
827
  * Gets current value of property {@link #getShowSetAsDefault showSetAsDefault}.
801
828
  *
802
- * Indicated if the defaulting functionality is enabled.
829
+ * Indicates whether the functionality of setting a default variant is enabled. The Default column in Manage
830
+ * Views and the Set as Default checkbox in Save View will be disabled if set to `false`.
803
831
  *
804
832
  * Default value is `true`.
805
833
  *
834
+ *
806
835
  * @returns Value of property `showSetAsDefault`
807
836
  */
808
837
  getShowSetAsDefault(): boolean;
809
838
  /**
810
- * @since 1.109
811
- *
812
839
  * Gets current value of property {@link #getTitleStyle titleStyle}.
813
840
  *
814
841
  * Defines the style of the title. For more information, see {@link sap.m.Title#setTitleStyle}.
815
842
  *
816
843
  * Default value is `Auto`.
817
844
  *
845
+ * @since 1.109
846
+ *
818
847
  * @returns Value of property `titleStyle`
819
848
  */
820
849
  getTitleStyle(): TitleLevel | keyof typeof TitleLevel;
821
850
  /**
822
851
  * Gets current value of property {@link #getUpdateVariantInURL updateVariantInURL}.
823
852
  *
824
- * Determines the intention of setting the current variant based on passed information. **Note:** The
825
- * `VariantManagement` control does not react in any way to this property. It is used internally by the
826
- * flexibility layer.
853
+ * Indicates whether the current variant is updated based on the passed information in the URL. **Note:**
854
+ * The `VariantManagement` control itself is not affected by this property. It is only used internally by
855
+ * the SAPUI5 flexibility layer.
827
856
  *
828
857
  * Default value is `false`.
829
858
  *
859
+ *
830
860
  * @returns Value of property `updateVariantInURL`
831
861
  */
832
862
  getUpdateVariantInURL(): boolean;
833
863
  /**
834
- * Retrieves all variants.
864
+ * Gets all variants.
865
+ *
835
866
  *
836
- * @returns All variants. In case the model is not yet set, an empty array will be returned.
867
+ * @returns All variants; if the model is not yet set, an empty array will be returned.
837
868
  */
838
869
  getVariants(): any[];
839
870
  /**
840
871
  * Removes all the controls in the association named {@link #getFor for}.
841
872
  *
873
+ *
842
874
  * @returns An array of the removed elements (might be empty)
843
875
  */
844
876
  removeAllFor(): ID[];
845
877
  /**
846
878
  * Removes an for from the association named {@link #getFor for}.
847
879
  *
880
+ *
848
881
  * @returns The removed for or `null`
849
882
  */
850
883
  removeFor(
@@ -858,7 +891,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
858
891
  */
859
892
  setCurrentVariantKey(
860
893
  /**
861
- * Key of the variant that should be selected.
894
+ * Key of the variant that is selected
862
895
  */
863
896
  sKey: string
864
897
  ): void;
@@ -866,13 +899,14 @@ declare module "sap/ui/fl/variants/VariantManagement" {
866
899
  * Sets a new value for property {@link #getDisplayTextForExecuteOnSelectionForStandardVariant displayTextForExecuteOnSelectionForStandardVariant}.
867
900
  *
868
901
  * Defines the Apply Automatically text for the standard variant in the Manage Views dialog if the application
869
- * controls this behavior. **Note:** the usage of this property is restricted to `sap.fe` components
902
+ * controls this behavior. **Note:** The usage of this property is restricted to `sap.fe` components
870
903
  * only.
871
904
  *
872
905
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
873
906
  *
874
907
  * Default value is `empty string`.
875
908
  *
909
+ *
876
910
  * @returns Reference to `this` in order to allow method chaining
877
911
  */
878
912
  setDisplayTextForExecuteOnSelectionForStandardVariant(
@@ -884,12 +918,13 @@ declare module "sap/ui/fl/variants/VariantManagement" {
884
918
  /**
885
919
  * Sets a new value for property {@link #getEditable editable}.
886
920
  *
887
- * Indicated if the buttons on the 'My Views' are visible.
921
+ * Indicates whether the buttons on My Views are visible.
888
922
  *
889
923
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
890
924
  *
891
925
  * Default value is `true`.
892
926
  *
927
+ *
893
928
  * @returns Reference to `this` in order to allow method chaining
894
929
  */
895
930
  setEditable(
@@ -907,6 +942,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
907
942
  *
908
943
  * Default value is `false`.
909
944
  *
945
+ *
910
946
  * @returns Reference to `this` in order to allow method chaining
911
947
  */
912
948
  setExecuteOnSelectionForStandardDefault(
@@ -916,8 +952,6 @@ declare module "sap/ui/fl/variants/VariantManagement" {
916
952
  bExecuteOnSelectionForStandardDefault?: boolean
917
953
  ): this;
918
954
  /**
919
- * @since 1.104
920
- *
921
955
  * Sets a new value for property {@link #getHeaderLevel headerLevel}.
922
956
  *
923
957
  * Semantic level of the header. For more information, see {@link sap.m.Title#setLevel}.
@@ -926,6 +960,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
926
960
  *
927
961
  * Default value is `Auto`.
928
962
  *
963
+ * @since 1.104
964
+ *
929
965
  * @returns Reference to `this` in order to allow method chaining
930
966
  */
931
967
  setHeaderLevel(
@@ -937,13 +973,14 @@ declare module "sap/ui/fl/variants/VariantManagement" {
937
973
  /**
938
974
  * Sets a new value for property {@link #getInErrorState inErrorState}.
939
975
  *
940
- * Indicates that the control is in error state. If set to `true`, an error message will be displayed whenever
941
- * the variant is opened.
976
+ * Indicates whether the control is in error state. If set to `true`, an error message will be displayed
977
+ * when the variant is opened.
942
978
  *
943
979
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
944
980
  *
945
981
  * Default value is `false`.
946
982
  *
983
+ *
947
984
  * @returns Reference to `this` in order to allow method chaining
948
985
  */
949
986
  setInErrorState(
@@ -953,8 +990,6 @@ declare module "sap/ui/fl/variants/VariantManagement" {
953
990
  bInErrorState?: boolean
954
991
  ): this;
955
992
  /**
956
- * @since 1.109
957
- *
958
993
  * Sets a new value for property {@link #getMaxWidth maxWidth}.
959
994
  *
960
995
  * Sets the maximum width of the control.
@@ -963,6 +998,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
963
998
  *
964
999
  * Default value is `"100%"`.
965
1000
  *
1001
+ * @since 1.109
1002
+ *
966
1003
  * @returns Reference to `this` in order to allow method chaining
967
1004
  */
968
1005
  setMaxWidth(
@@ -980,6 +1017,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
980
1017
  *
981
1018
  * Default value is `empty string`.
982
1019
  *
1020
+ *
983
1021
  * @returns Reference to `this` in order to allow method chaining
984
1022
  */
985
1023
  setModelName(
@@ -991,14 +1029,15 @@ declare module "sap/ui/fl/variants/VariantManagement" {
991
1029
  /**
992
1030
  * Sets a new value for property {@link #getResetOnContextChange resetOnContextChange}.
993
1031
  *
994
- * When set to `false`, doesn't reset the `VariantManagement` control to the default variant, when its binding
995
- * context is changed. **Note:** The `VariantManagement` control does not react in any way to this property.
996
- * It is used internally by the flexibility layer.
1032
+ * If set to `false`, it does not reset the `VariantManagement` control to the default variant if its binding
1033
+ * context is changed. **Note:** The `VariantManagement` control itself is not affected by this property.
1034
+ * It is only used internally by the SAPUI5 flexibility layer.
997
1035
  *
998
1036
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
999
1037
  *
1000
1038
  * Default value is `true`.
1001
1039
  *
1040
+ *
1002
1041
  * @returns Reference to `this` in order to allow method chaining
1003
1042
  */
1004
1043
  setResetOnContextChange(
@@ -1010,12 +1049,14 @@ declare module "sap/ui/fl/variants/VariantManagement" {
1010
1049
  /**
1011
1050
  * Sets a new value for property {@link #getShowSetAsDefault showSetAsDefault}.
1012
1051
  *
1013
- * Indicated if the defaulting functionality is enabled.
1052
+ * Indicates whether the functionality of setting a default variant is enabled. The Default column in Manage
1053
+ * Views and the Set as Default checkbox in Save View will be disabled if set to `false`.
1014
1054
  *
1015
1055
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1016
1056
  *
1017
1057
  * Default value is `true`.
1018
1058
  *
1059
+ *
1019
1060
  * @returns Reference to `this` in order to allow method chaining
1020
1061
  */
1021
1062
  setShowSetAsDefault(
@@ -1025,8 +1066,6 @@ declare module "sap/ui/fl/variants/VariantManagement" {
1025
1066
  bShowSetAsDefault?: boolean
1026
1067
  ): this;
1027
1068
  /**
1028
- * @since 1.109
1029
- *
1030
1069
  * Sets a new value for property {@link #getTitleStyle titleStyle}.
1031
1070
  *
1032
1071
  * Defines the style of the title. For more information, see {@link sap.m.Title#setTitleStyle}.
@@ -1035,6 +1074,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
1035
1074
  *
1036
1075
  * Default value is `Auto`.
1037
1076
  *
1077
+ * @since 1.109
1078
+ *
1038
1079
  * @returns Reference to `this` in order to allow method chaining
1039
1080
  */
1040
1081
  setTitleStyle(
@@ -1046,14 +1087,15 @@ declare module "sap/ui/fl/variants/VariantManagement" {
1046
1087
  /**
1047
1088
  * Sets a new value for property {@link #getUpdateVariantInURL updateVariantInURL}.
1048
1089
  *
1049
- * Determines the intention of setting the current variant based on passed information. **Note:** The
1050
- * `VariantManagement` control does not react in any way to this property. It is used internally by the
1051
- * flexibility layer.
1090
+ * Indicates whether the current variant is updated based on the passed information in the URL. **Note:**
1091
+ * The `VariantManagement` control itself is not affected by this property. It is only used internally by
1092
+ * the SAPUI5 flexibility layer.
1052
1093
  *
1053
1094
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1054
1095
  *
1055
1096
  * Default value is `false`.
1056
1097
  *
1098
+ *
1057
1099
  * @returns Reference to `this` in order to allow method chaining
1058
1100
  */
1059
1101
  setUpdateVariantInURL(
@@ -1066,16 +1108,16 @@ declare module "sap/ui/fl/variants/VariantManagement" {
1066
1108
 
1067
1109
  export interface $VariantManagementSettings extends $ControlSettings {
1068
1110
  /**
1069
- * Determines the intention of setting the current variant based on passed information. **Note:** The
1070
- * `VariantManagement` control does not react in any way to this property. It is used internally by the
1071
- * flexibility layer.
1111
+ * Indicates whether the current variant is updated based on the passed information in the URL. **Note:**
1112
+ * The `VariantManagement` control itself is not affected by this property. It is only used internally by
1113
+ * the SAPUI5 flexibility layer.
1072
1114
  */
1073
1115
  updateVariantInURL?: boolean | PropertyBindingInfo | `{${string}}`;
1074
1116
 
1075
1117
  /**
1076
- * When set to `false`, doesn't reset the `VariantManagement` control to the default variant, when its binding
1077
- * context is changed. **Note:** The `VariantManagement` control does not react in any way to this property.
1078
- * It is used internally by the flexibility layer.
1118
+ * If set to `false`, it does not reset the `VariantManagement` control to the default variant if its binding
1119
+ * context is changed. **Note:** The `VariantManagement` control itself is not affected by this property.
1120
+ * It is only used internally by the SAPUI5 flexibility layer.
1079
1121
  */
1080
1122
  resetOnContextChange?: boolean | PropertyBindingInfo | `{${string}}`;
1081
1123
 
@@ -1085,18 +1127,19 @@ declare module "sap/ui/fl/variants/VariantManagement" {
1085
1127
  modelName?: string | PropertyBindingInfo;
1086
1128
 
1087
1129
  /**
1088
- * Indicated if the buttons on the 'My Views' are visible.
1130
+ * Indicates whether the buttons on My Views are visible.
1089
1131
  */
1090
1132
  editable?: boolean | PropertyBindingInfo | `{${string}}`;
1091
1133
 
1092
1134
  /**
1093
- * Indicated if the defaulting functionality is enabled.
1135
+ * Indicates whether the functionality of setting a default variant is enabled. The Default column in Manage
1136
+ * Views and the Set as Default checkbox in Save View will be disabled if set to `false`.
1094
1137
  */
1095
1138
  showSetAsDefault?: boolean | PropertyBindingInfo | `{${string}}`;
1096
1139
 
1097
1140
  /**
1098
- * Indicates that the control is in error state. If set to `true`, an error message will be displayed whenever
1099
- * the variant is opened.
1141
+ * Indicates whether the control is in error state. If set to `true`, an error message will be displayed
1142
+ * when the variant is opened.
1100
1143
  */
1101
1144
  inErrorState?: boolean | PropertyBindingInfo | `{${string}}`;
1102
1145
 
@@ -1110,7 +1153,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
1110
1153
 
1111
1154
  /**
1112
1155
  * Defines the Apply Automatically text for the standard variant in the Manage Views dialog if the application
1113
- * controls this behavior. **Note:** the usage of this property is restricted to `sap.fe` components
1156
+ * controls this behavior. **Note:** The usage of this property is restricted to `sap.fe` components
1114
1157
  * only.
1115
1158
  */
1116
1159
  displayTextForExecuteOnSelectionForStandardVariant?:
@@ -1118,9 +1161,9 @@ declare module "sap/ui/fl/variants/VariantManagement" {
1118
1161
  | PropertyBindingInfo;
1119
1162
 
1120
1163
  /**
1121
- * @since 1.104
1122
- *
1123
1164
  * Semantic level of the header. For more information, see {@link sap.m.Title#setLevel}.
1165
+ *
1166
+ * @since 1.104
1124
1167
  */
1125
1168
  headerLevel?:
1126
1169
  | (TitleLevel | keyof typeof TitleLevel)
@@ -1128,9 +1171,9 @@ declare module "sap/ui/fl/variants/VariantManagement" {
1128
1171
  | `{${string}}`;
1129
1172
 
1130
1173
  /**
1131
- * @since 1.109
1132
- *
1133
1174
  * Defines the style of the title. For more information, see {@link sap.m.Title#setTitleStyle}.
1175
+ *
1176
+ * @since 1.109
1134
1177
  */
1135
1178
  titleStyle?:
1136
1179
  | (TitleLevel | keyof typeof TitleLevel)
@@ -1138,14 +1181,14 @@ declare module "sap/ui/fl/variants/VariantManagement" {
1138
1181
  | `{${string}}`;
1139
1182
 
1140
1183
  /**
1141
- * @since 1.109
1142
- *
1143
1184
  * Sets the maximum width of the control.
1185
+ *
1186
+ * @since 1.109
1144
1187
  */
1145
1188
  maxWidth?: CSSSize | PropertyBindingInfo | `{${string}}`;
1146
1189
 
1147
1190
  /**
1148
- * Contains the ids of the controls for which the variant management is responsible.
1191
+ * Contains the IDs of the relevant controls for which the variant management is used.
1149
1192
  */
1150
1193
  for?: Array<Control | string>;
1151
1194
 
@@ -1155,13 +1198,12 @@ declare module "sap/ui/fl/variants/VariantManagement" {
1155
1198
  initialized?: (oEvent: Event) => void;
1156
1199
 
1157
1200
  /**
1158
- * This event is fired when the Save View dialog or the Save As dialog is closed with the
1159
- * save button.
1201
+ * This event is fired when the Save View dialog or the Save As dialog is closed with the Save button.
1160
1202
  */
1161
1203
  save?: (oEvent: VariantManagement$SaveEvent) => void;
1162
1204
 
1163
1205
  /**
1164
- * This event is fired when users presses the cancel button inside Save As dialog.
1206
+ * This event is fired when users press the Cancel button inside the Save As dialog.
1165
1207
  */
1166
1208
  cancel?: (oEvent: Event) => void;
1167
1209
 
@@ -1192,8 +1234,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
1192
1234
 
1193
1235
  export interface VariantManagement$ManageEventParameters {
1194
1236
  /**
1195
- * List of changed variants. Each entry contains a 'key' - the variant key and a 'name' - the new title
1196
- * of the variant
1237
+ * List of changed variants. Each entry contains a `key` (the variant key) and a `name` (the new title of
1238
+ * the variant).
1197
1239
  */
1198
1240
  renamed?: object[];
1199
1241
 
@@ -1203,14 +1245,28 @@ declare module "sap/ui/fl/variants/VariantManagement" {
1203
1245
  deleted?: string[];
1204
1246
 
1205
1247
  /**
1206
- * List of variant keys and the associated Execute on Selection indicator
1248
+ * List of variant keys and the associated Execute on Selection indicator. Each entry contains a `key` (the
1249
+ * variant key) and an `exe` flag describing the intention.
1207
1250
  */
1208
1251
  exe?: object[];
1209
1252
 
1253
+ /**
1254
+ * List of variant keys and the associated favorite indicator. Each entry contains a `key` (the variant
1255
+ * key) and a `visible` flag describing the intention.
1256
+ */
1257
+ fav?: object[];
1258
+
1210
1259
  /**
1211
1260
  * The default variant key
1212
1261
  */
1213
1262
  def?: string;
1263
+
1264
+ /**
1265
+ * List of variant keys and the associated contexts array. Each entry contains a `key` (the variant key)
1266
+ * and a `contexts` array describing the contexts. **Note:** It is only used internally by the SAPUI5 flexibility
1267
+ * layer.
1268
+ */
1269
+ contexts?: object[];
1214
1270
  }
1215
1271
 
1216
1272
  export type VariantManagement$ManageEvent = Event<
@@ -1225,12 +1281,12 @@ declare module "sap/ui/fl/variants/VariantManagement" {
1225
1281
  name?: string;
1226
1282
 
1227
1283
  /**
1228
- * Indicates if an existing variant is overwritten or if a new variant is created.
1284
+ * Indicates whether an existing variant is overwritten or whether a new variant is created
1229
1285
  */
1230
1286
  overwrite?: boolean;
1231
1287
 
1232
1288
  /**
1233
- * Variant key
1289
+ * Variant key. This property is set if `overwrite` is set to `true`.
1234
1290
  */
1235
1291
  key?: string;
1236
1292
 
@@ -1240,7 +1296,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
1240
1296
  execute?: boolean;
1241
1297
 
1242
1298
  /**
1243
- * Indicates the check box state for 'Public'.
1299
+ * Indicates the checkbox state for Public
1244
1300
  */
1245
1301
  public?: boolean;
1246
1302
 
@@ -1250,9 +1306,12 @@ declare module "sap/ui/fl/variants/VariantManagement" {
1250
1306
  def?: boolean;
1251
1307
 
1252
1308
  /**
1253
- * Indicates the check box state for 'Create Tile'.
1254
- * Note:
1255
- * This event parameter is used only internally.
1309
+ * Array describing the contexts. **Note:** It is only used internally by the SAPUI5 flexibility layer.
1310
+ */
1311
+ contexts?: object[];
1312
+
1313
+ /**
1314
+ * Indicates the checkbox state for Create Tile **Note:** This event parameter is used only internally.
1256
1315
  */
1257
1316
  tile?: boolean;
1258
1317
  }
@@ -1281,10 +1340,10 @@ declare module "sap/ui/fl/write/_internal/fieldExtensibility/ABAPExtensibilityVa
1281
1340
  import Metadata from "sap/ui/base/Metadata";
1282
1341
 
1283
1342
  /**
1284
- * @since 1.87
1285
- *
1286
1343
  * Abstraction providing an API to handle an ABAP extension variant. Serves also as base class and dummy
1287
1344
  * implementation.
1345
+ *
1346
+ * @since 1.87
1288
1347
  */
1289
1348
  interface ABAPExtensibilityVariant extends BaseObject {
1290
1349
  /**
@@ -1293,6 +1352,7 @@ declare module "sap/ui/fl/write/_internal/fieldExtensibility/ABAPExtensibilityVa
1293
1352
  *
1294
1353
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
1295
1354
  *
1355
+ *
1296
1356
  * @returns Created class / constructor function
1297
1357
  */
1298
1358
  extend(
@@ -1313,6 +1373,7 @@ declare module "sap/ui/fl/write/_internal/fieldExtensibility/ABAPExtensibilityVa
1313
1373
  /**
1314
1374
  * Returns a metadata object for class sap.ui.fl.write._internal.fieldExtensibility.ABAPExtensibilityVariant.
1315
1375
  *
1376
+ *
1316
1377
  * @returns Metadata object describing this class
1317
1378
  */
1318
1379
  getMetadata(): Metadata;
@@ -1327,9 +1388,9 @@ declare module "sap/ui/fl/write/_internal/fieldExtensibility/MultiTenantABAPExte
1327
1388
  import Metadata from "sap/ui/base/Metadata";
1328
1389
 
1329
1390
  /**
1330
- * @since 1.87
1331
- *
1332
1391
  * Extension variant for ABAP multi tenant environments (via so called Predefined Fields)
1392
+ *
1393
+ * @since 1.87
1333
1394
  */
1334
1395
  interface MultiTenantABAPExtensibilityVariant
1335
1396
  extends ABAPExtensibilityVariant {
@@ -1339,6 +1400,7 @@ declare module "sap/ui/fl/write/_internal/fieldExtensibility/MultiTenantABAPExte
1339
1400
  *
1340
1401
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.fl.write._internal.fieldExtensibility.ABAPExtensibilityVariant.extend}.
1341
1402
  *
1403
+ *
1342
1404
  * @returns Created class / constructor function
1343
1405
  */
1344
1406
  extend(
@@ -1359,6 +1421,7 @@ declare module "sap/ui/fl/write/_internal/fieldExtensibility/MultiTenantABAPExte
1359
1421
  /**
1360
1422
  * Returns a metadata object for class sap.ui.fl.write._internal.fieldExtensibility.MultiTenantABAPExtensibilityVariant.
1361
1423
  *
1424
+ *
1362
1425
  * @returns Metadata object describing this class
1363
1426
  */
1364
1427
  getMetadata(): Metadata;
@@ -1373,9 +1436,9 @@ declare module "sap/ui/fl/write/_internal/fieldExtensibility/SingleTenantABAPExt
1373
1436
  import Metadata from "sap/ui/base/Metadata";
1374
1437
 
1375
1438
  /**
1376
- * @since 1.87
1377
- *
1378
1439
  * Extension variant for ABAP single tenant environnments (via so called Custom Fields)
1440
+ *
1441
+ * @since 1.87
1379
1442
  */
1380
1443
  interface SingleTenantABAPExtensibilityVariant
1381
1444
  extends ABAPExtensibilityVariant {
@@ -1385,6 +1448,7 @@ declare module "sap/ui/fl/write/_internal/fieldExtensibility/SingleTenantABAPExt
1385
1448
  *
1386
1449
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.fl.write._internal.fieldExtensibility.ABAPExtensibilityVariant.extend}.
1387
1450
  *
1451
+ *
1388
1452
  * @returns Created class / constructor function
1389
1453
  */
1390
1454
  extend(
@@ -1405,6 +1469,7 @@ declare module "sap/ui/fl/write/_internal/fieldExtensibility/SingleTenantABAPExt
1405
1469
  /**
1406
1470
  * Returns a metadata object for class sap.ui.fl.write._internal.fieldExtensibility.SingleTenantABAPExtensibilityVariant.
1407
1471
  *
1472
+ *
1408
1473
  * @returns Metadata object describing this class
1409
1474
  */
1410
1475
  getMetadata(): Metadata;
@@ -1415,9 +1480,9 @@ declare module "sap/ui/fl/write/_internal/fieldExtensibility/SingleTenantABAPExt
1415
1480
 
1416
1481
  declare module "sap/ui/fl/write/api/FeaturesAPI" {
1417
1482
  /**
1418
- * @since 1.70
1419
- *
1420
1483
  * Provides an API to determine which features are available for flexibility.
1484
+ *
1485
+ * @since 1.70
1421
1486
  */
1422
1487
  interface FeaturesAPI {
1423
1488
  /**
@@ -1425,6 +1490,7 @@ declare module "sap/ui/fl/write/api/FeaturesAPI" {
1425
1490
  * to decide if the key user adaptation feature should be visible to the current user. This only applies
1426
1491
  * if key user adaptation should be handled standalone without an SAP Fiori launchpad.
1427
1492
  *
1493
+ *
1428
1494
  * @returns Resolves to a boolean indicating if the key user role is assigned to the user
1429
1495
  */
1430
1496
  isKeyUser(): Promise<boolean>;
@@ -1481,6 +1547,8 @@ declare namespace sap {
1481
1547
 
1482
1548
  "sap/ui/fl/apply/_internal/controlVariants/URLHandler": undefined;
1483
1549
 
1550
+ "sap/ui/fl/apply/_internal/extensionPoint/Registry": undefined;
1551
+
1484
1552
  "sap/ui/fl/apply/_internal/flexObjects/AppDescriptorChange": undefined;
1485
1553
 
1486
1554
  "sap/ui/fl/apply/_internal/flexObjects/CompVariant": undefined;
@@ -1503,6 +1571,8 @@ declare namespace sap {
1503
1571
 
1504
1572
  "sap/ui/fl/apply/_internal/flexState/changes/ExtensionPointState": undefined;
1505
1573
 
1574
+ "sap/ui/fl/apply/_internal/flexState/changes/UIChangesState": undefined;
1575
+
1506
1576
  "sap/ui/fl/apply/_internal/flexState/compVariants/CompVariantMerger": undefined;
1507
1577
 
1508
1578
  "sap/ui/fl/apply/_internal/flexState/controlVariants/Switcher": undefined;
@@ -1529,6 +1599,8 @@ declare namespace sap {
1529
1599
 
1530
1600
  "sap/ui/fl/apply/api/DelegateMediatorAPI": undefined;
1531
1601
 
1602
+ "sap/ui/fl/apply/api/ExtensionPointRegistryAPI": undefined;
1603
+
1532
1604
  "sap/ui/fl/apply/api/FlexRuntimeInfoAPI": undefined;
1533
1605
 
1534
1606
  "sap/ui/fl/apply/api/SmartVariantManagementApplyAPI": undefined;
@@ -1549,6 +1621,8 @@ declare namespace sap {
1549
1621
 
1550
1622
  "sap/ui/fl/initial/_internal/connectors/BackendConnector": undefined;
1551
1623
 
1624
+ "sap/ui/fl/initial/_internal/connectors/BtpServiceConnector": undefined;
1625
+
1552
1626
  "sap/ui/fl/initial/_internal/connectors/KeyUserConnector": undefined;
1553
1627
 
1554
1628
  "sap/ui/fl/initial/_internal/connectors/LrepConnector": undefined;
@@ -1573,6 +1647,8 @@ declare namespace sap {
1573
1647
 
1574
1648
  "sap/ui/fl/registry/Settings": undefined;
1575
1649
 
1650
+ "sap/ui/fl/support/_internal/getAllUIChanges": undefined;
1651
+
1576
1652
  "sap/ui/fl/support/_internal/getChangeDependencies": undefined;
1577
1653
 
1578
1654
  "sap/ui/fl/support/_internal/getFlexSettings": undefined;
@@ -1599,6 +1675,8 @@ declare namespace sap {
1599
1675
 
1600
1676
  "sap/ui/fl/write/_internal/connectors/BackendConnector": undefined;
1601
1677
 
1678
+ "sap/ui/fl/write/_internal/connectors/BtpServiceConnector": undefined;
1679
+
1602
1680
  "sap/ui/fl/write/_internal/connectors/JsObjectConnector": undefined;
1603
1681
 
1604
1682
  "sap/ui/fl/write/_internal/connectors/KeyUserConnector": undefined;
@@ -1619,8 +1697,6 @@ declare namespace sap {
1619
1697
 
1620
1698
  "sap/ui/fl/write/_internal/connectors/Utils": undefined;
1621
1699
 
1622
- "sap/ui/fl/write/_internal/extensionPoint/Registry": undefined;
1623
-
1624
1700
  "sap/ui/fl/write/_internal/fieldExtensibility/ABAPExtensibilityVariant": undefined;
1625
1701
 
1626
1702
  "sap/ui/fl/write/_internal/fieldExtensibility/MultiTenantABAPExtensibilityVariant": undefined;
@@ -1635,8 +1711,6 @@ declare namespace sap {
1635
1711
 
1636
1712
  "sap/ui/fl/write/_internal/Storage": undefined;
1637
1713
 
1638
- "sap/ui/fl/write/_internal/StorageFeaturesMerger": undefined;
1639
-
1640
1714
  "sap/ui/fl/write/_internal/Versions": undefined;
1641
1715
 
1642
1716
  "sap/ui/fl/write/api/AppVariantWriteAPI": undefined;
@@ -1651,8 +1725,6 @@ declare namespace sap {
1651
1725
 
1652
1726
  "sap/ui/fl/write/api/ControlPersonalizationWriteAPI": undefined;
1653
1727
 
1654
- "sap/ui/fl/write/api/ExtensionPointRegistryAPI": undefined;
1655
-
1656
1728
  "sap/ui/fl/write/api/FeaturesAPI": undefined;
1657
1729
 
1658
1730
  "sap/ui/fl/write/api/FieldExtensibility": undefined;