@openui5/ts-types 1.115.0 → 1.116.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,3 +1,3 @@
1
- // For Library Version: 1.115.0
1
+ // For Library Version: 1.116.0
2
2
 
3
3
  declare namespace sap {}
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.115.0
1
+ // For Library Version: 1.116.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -57,15 +57,6 @@ declare namespace sap {
57
57
  | sap.ui.base.ManagedObject.PropertyBindingInfo
58
58
  | `{${string}}`;
59
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
60
  /**
70
61
  * Indicates that the control is in error state. If set to `true`, an error message will be displayed whenever
71
62
  * the variant is opened.
@@ -93,7 +84,7 @@ declare namespace sap {
93
84
  | sap.ui.base.ManagedObject.PropertyBindingInfo;
94
85
 
95
86
  /**
96
- * @SINCE 1.104
87
+ * @since 1.104
97
88
  *
98
89
  * Semantic level of the header. For more information, see {@link sap.m.Title#setLevel}.
99
90
  */
@@ -103,7 +94,7 @@ declare namespace sap {
103
94
  | `{${string}}`;
104
95
 
105
96
  /**
106
- * @SINCE 1.109
97
+ * @since 1.109
107
98
  *
108
99
  * Defines the style of the title. For more information, see {@link sap.m.Title#setTitleStyle}.
109
100
  */
@@ -113,7 +104,7 @@ declare namespace sap {
113
104
  | `{${string}}`;
114
105
 
115
106
  /**
116
- * @SINCE 1.109
107
+ * @since 1.109
117
108
  *
118
109
  * Sets the maximum width of the control.
119
110
  */
@@ -136,9 +127,7 @@ declare namespace sap {
136
127
  * This event is fired when the Save View dialog or the Save As dialog is closed with the
137
128
  * save button.
138
129
  */
139
- save?: (
140
- oEvent: sap.ui.base.Event<sap.ui.fl.variants.$VariantManagementSaveEventParameters>
141
- ) => void;
130
+ save?: (oEvent: VariantManagement$SaveEvent) => void;
142
131
 
143
132
  /**
144
133
  * This event is fired when users presses the cancel button inside Save As dialog.
@@ -148,23 +137,19 @@ declare namespace sap {
148
137
  /**
149
138
  * This event is fired when users apply changes to variants in the Manage Views dialog.
150
139
  */
151
- manage?: (
152
- oEvent: sap.ui.base.Event<sap.ui.fl.variants.$VariantManagementManageEventParameters>
153
- ) => void;
140
+ manage?: (oEvent: VariantManagement$ManageEvent) => void;
154
141
 
155
142
  /**
156
143
  * This event is fired when a new variant is selected.
157
144
  */
158
- select?: (
159
- oEvent: sap.ui.base.Event<sap.ui.fl.variants.$VariantManagementSelectEventParameters>
160
- ) => void;
145
+ select?: (oEvent: VariantManagement$SelectEvent) => void;
161
146
  }
162
147
 
163
- interface $VariantManagementCancelEventParameters {}
148
+ interface VariantManagement$CancelEventParameters {}
164
149
 
165
- interface $VariantManagementInitializedEventParameters {}
150
+ interface VariantManagement$InitializedEventParameters {}
166
151
 
167
- interface $VariantManagementManageEventParameters {
152
+ interface VariantManagement$ManageEventParameters {
168
153
  /**
169
154
  * List of changed variants. Each entry contains a 'key' - the variant key and a 'name' - the new title
170
155
  * of the variant
@@ -187,7 +172,7 @@ declare namespace sap {
187
172
  def?: string;
188
173
  }
189
174
 
190
- interface $VariantManagementSaveEventParameters {
175
+ interface VariantManagement$SaveEventParameters {
191
176
  /**
192
177
  * Variant title
193
178
  */
@@ -226,7 +211,7 @@ declare namespace sap {
226
211
  tile?: boolean;
227
212
  }
228
213
 
229
- interface $VariantManagementSelectEventParameters {
214
+ interface VariantManagement$SelectEventParameters {
230
215
  /**
231
216
  * Variant key
232
217
  */
@@ -234,7 +219,7 @@ declare namespace sap {
234
219
  }
235
220
 
236
221
  /**
237
- * @SINCE 1.56
222
+ * @since 1.56
238
223
  *
239
224
  * Can be used to manage variants. You can use this control in most controls that are enabled for key
240
225
  * user adaptation.
@@ -437,9 +422,7 @@ declare namespace sap {
437
422
  /**
438
423
  * The function to be called when the event occurs
439
424
  */
440
- fnFunction: (
441
- p1: sap.ui.base.Event<sap.ui.fl.variants.$VariantManagementManageEventParameters>
442
- ) => void,
425
+ fnFunction: (p1: VariantManagement$ManageEvent) => void,
443
426
  /**
444
427
  * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
445
428
  * itself
@@ -460,9 +443,7 @@ declare namespace sap {
460
443
  /**
461
444
  * The function to be called when the event occurs
462
445
  */
463
- fnFunction: (
464
- p1: sap.ui.base.Event<sap.ui.fl.variants.$VariantManagementManageEventParameters>
465
- ) => void,
446
+ fnFunction: (p1: VariantManagement$ManageEvent) => void,
466
447
  /**
467
448
  * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
468
449
  * itself
@@ -489,9 +470,7 @@ declare namespace sap {
489
470
  /**
490
471
  * The function to be called when the event occurs
491
472
  */
492
- fnFunction: (
493
- p1: sap.ui.base.Event<sap.ui.fl.variants.$VariantManagementSaveEventParameters>
494
- ) => void,
473
+ fnFunction: (p1: VariantManagement$SaveEvent) => void,
495
474
  /**
496
475
  * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
497
476
  * itself
@@ -513,9 +492,7 @@ declare namespace sap {
513
492
  /**
514
493
  * The function to be called when the event occurs
515
494
  */
516
- fnFunction: (
517
- p1: sap.ui.base.Event<sap.ui.fl.variants.$VariantManagementSaveEventParameters>
518
- ) => void,
495
+ fnFunction: (p1: VariantManagement$SaveEvent) => void,
519
496
  /**
520
497
  * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
521
498
  * itself
@@ -541,9 +518,7 @@ declare namespace sap {
541
518
  /**
542
519
  * The function to be called when the event occurs
543
520
  */
544
- fnFunction: (
545
- p1: sap.ui.base.Event<sap.ui.fl.variants.$VariantManagementSelectEventParameters>
546
- ) => void,
521
+ fnFunction: (p1: VariantManagement$SelectEvent) => void,
547
522
  /**
548
523
  * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
549
524
  * itself
@@ -564,9 +539,7 @@ declare namespace sap {
564
539
  /**
565
540
  * The function to be called when the event occurs
566
541
  */
567
- fnFunction: (
568
- p1: sap.ui.base.Event<sap.ui.fl.variants.$VariantManagementSelectEventParameters>
569
- ) => void,
542
+ fnFunction: (p1: VariantManagement$SelectEvent) => void,
570
543
  /**
571
544
  * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
572
545
  * itself
@@ -618,9 +591,7 @@ declare namespace sap {
618
591
  /**
619
592
  * The function to be called, when the event occurs
620
593
  */
621
- fnFunction: (
622
- p1: sap.ui.base.Event<sap.ui.fl.variants.$VariantManagementManageEventParameters>
623
- ) => void,
594
+ fnFunction: (p1: VariantManagement$ManageEvent) => void,
624
595
  /**
625
596
  * Context object on which the given function had to be called
626
597
  */
@@ -637,9 +608,7 @@ declare namespace sap {
637
608
  /**
638
609
  * The function to be called, when the event occurs
639
610
  */
640
- fnFunction: (
641
- p1: sap.ui.base.Event<sap.ui.fl.variants.$VariantManagementSaveEventParameters>
642
- ) => void,
611
+ fnFunction: (p1: VariantManagement$SaveEvent) => void,
643
612
  /**
644
613
  * Context object on which the given function had to be called
645
614
  */
@@ -656,16 +625,14 @@ declare namespace sap {
656
625
  /**
657
626
  * The function to be called, when the event occurs
658
627
  */
659
- fnFunction: (
660
- p1: sap.ui.base.Event<sap.ui.fl.variants.$VariantManagementSelectEventParameters>
661
- ) => void,
628
+ fnFunction: (p1: VariantManagement$SelectEvent) => void,
662
629
  /**
663
630
  * Context object on which the given function had to be called
664
631
  */
665
632
  oListener?: object
666
633
  ): this;
667
634
  /**
668
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
635
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
669
636
  *
670
637
  * Fires event {@link #event:cancel cancel} to attached listeners.
671
638
  *
@@ -678,7 +645,7 @@ declare namespace sap {
678
645
  mParameters?: object
679
646
  ): this;
680
647
  /**
681
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
648
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
682
649
  *
683
650
  * Fires event {@link #event:initialized initialized} to attached listeners.
684
651
  *
@@ -691,7 +658,7 @@ declare namespace sap {
691
658
  mParameters?: object
692
659
  ): this;
693
660
  /**
694
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
661
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
695
662
  *
696
663
  * Fires event {@link #event:manage manage} to attached listeners.
697
664
  *
@@ -701,10 +668,10 @@ declare namespace sap {
701
668
  /**
702
669
  * Parameters to pass along with the event
703
670
  */
704
- mParameters?: sap.ui.fl.variants.$VariantManagementManageEventParameters
671
+ mParameters?: sap.ui.fl.variants.VariantManagement$ManageEventParameters
705
672
  ): this;
706
673
  /**
707
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
674
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
708
675
  *
709
676
  * Fires event {@link #event:save save} to attached listeners.
710
677
  *
@@ -714,10 +681,10 @@ declare namespace sap {
714
681
  /**
715
682
  * Parameters to pass along with the event
716
683
  */
717
- mParameters?: sap.ui.fl.variants.$VariantManagementSaveEventParameters
684
+ mParameters?: sap.ui.fl.variants.VariantManagement$SaveEventParameters
718
685
  ): this;
719
686
  /**
720
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
687
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
721
688
  *
722
689
  * Fires event {@link #event:select select} to attached listeners.
723
690
  *
@@ -727,7 +694,7 @@ declare namespace sap {
727
694
  /**
728
695
  * Parameters to pass along with the event
729
696
  */
730
- mParameters?: sap.ui.fl.variants.$VariantManagementSelectEventParameters
697
+ mParameters?: sap.ui.fl.variants.VariantManagement$SelectEventParameters
731
698
  ): this;
732
699
  /**
733
700
  * Gets the currently selected variant key.
@@ -772,7 +739,7 @@ declare namespace sap {
772
739
  */
773
740
  getFor(): sap.ui.core.ID[];
774
741
  /**
775
- * @SINCE 1.104
742
+ * @since 1.104
776
743
  *
777
744
  * Gets current value of property {@link #getHeaderLevel headerLevel}.
778
745
  *
@@ -795,18 +762,7 @@ declare namespace sap {
795
762
  */
796
763
  getInErrorState(): boolean;
797
764
  /**
798
- * Gets current value of property {@link #getManualVariantKey manualVariantKey}.
799
- *
800
- * If set to `true`, the key for a vendor variant will be added manually.
801
- * **Note:** This flag is only used internally.
802
- *
803
- * Default value is `false`.
804
- *
805
- * @returns Value of property `manualVariantKey`
806
- */
807
- getManualVariantKey(): boolean;
808
- /**
809
- * @SINCE 1.109
765
+ * @since 1.109
810
766
  *
811
767
  * Gets current value of property {@link #getMaxWidth maxWidth}.
812
768
  *
@@ -834,7 +790,7 @@ declare namespace sap {
834
790
  */
835
791
  getModified(): boolean;
836
792
  /**
837
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
793
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
838
794
  *
839
795
  * Required by the {@link sap.m.IOverflowToolbarContent} interface. Registers invalidations event which
840
796
  * is fired when width of the control is changed.
@@ -869,7 +825,7 @@ declare namespace sap {
869
825
  */
870
826
  getShowSetAsDefault(): boolean;
871
827
  /**
872
- * @SINCE 1.109
828
+ * @since 1.109
873
829
  *
874
830
  * Gets current value of property {@link #getTitleStyle titleStyle}.
875
831
  *
@@ -978,7 +934,7 @@ declare namespace sap {
978
934
  bExecuteOnSelectionForStandardDefault?: boolean
979
935
  ): this;
980
936
  /**
981
- * @SINCE 1.104
937
+ * @since 1.104
982
938
  *
983
939
  * Sets a new value for property {@link #getHeaderLevel headerLevel}.
984
940
  *
@@ -1015,25 +971,7 @@ declare namespace sap {
1015
971
  bInErrorState?: boolean
1016
972
  ): this;
1017
973
  /**
1018
- * Sets a new value for property {@link #getManualVariantKey manualVariantKey}.
1019
- *
1020
- * If set to `true`, the key for a vendor variant will be added manually.
1021
- * **Note:** This flag is only used internally.
1022
- *
1023
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1024
- *
1025
- * Default value is `false`.
1026
- *
1027
- * @returns Reference to `this` in order to allow method chaining
1028
- */
1029
- setManualVariantKey(
1030
- /**
1031
- * New value for property `manualVariantKey`
1032
- */
1033
- bManualVariantKey?: boolean
1034
- ): this;
1035
- /**
1036
- * @SINCE 1.109
974
+ * @since 1.109
1037
975
  *
1038
976
  * Sets a new value for property {@link #getMaxWidth maxWidth}.
1039
977
  *
@@ -1105,7 +1043,7 @@ declare namespace sap {
1105
1043
  bShowSetAsDefault?: boolean
1106
1044
  ): this;
1107
1045
  /**
1108
- * @SINCE 1.109
1046
+ * @since 1.109
1109
1047
  *
1110
1048
  * Sets a new value for property {@link #getTitleStyle titleStyle}.
1111
1049
  *
@@ -1143,6 +1081,16 @@ declare namespace sap {
1143
1081
  bUpdateVariantInURL?: boolean
1144
1082
  ): this;
1145
1083
  }
1084
+
1085
+ type VariantManagement$CancelEvent = sap.ui.base.Event<VariantManagement$CancelEventParameters>;
1086
+
1087
+ type VariantManagement$InitializedEvent = sap.ui.base.Event<VariantManagement$InitializedEventParameters>;
1088
+
1089
+ type VariantManagement$ManageEvent = sap.ui.base.Event<VariantManagement$ManageEventParameters>;
1090
+
1091
+ type VariantManagement$SaveEvent = sap.ui.base.Event<VariantManagement$SaveEventParameters>;
1092
+
1093
+ type VariantManagement$SelectEvent = sap.ui.base.Event<VariantManagement$SelectEventParameters>;
1146
1094
  }
1147
1095
  /**
1148
1096
  * The `sap.ui.fl.write` namespace contains all code to create, update, and reset flex objects. Additional
@@ -1155,7 +1103,7 @@ declare namespace sap {
1155
1103
  */
1156
1104
  namespace api {
1157
1105
  /**
1158
- * @SINCE 1.70
1106
+ * @since 1.70
1159
1107
  *
1160
1108
  * Provides an API to determine which features are available for flexibility.
1161
1109
  */