@openui5/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 module "sap/ui/fl/library" {}
4
4
 
@@ -6,8 +6,8 @@ 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
- * @EXPERIMENTAL (since 1.67)
9
+ * @since 1.67
10
+ * @experimental (since 1.67)
11
11
  *
12
12
  * Provides an API for applications to work with control variants. See also {@link sap.ui.fl.variants.VariantManagement}.
13
13
  */
@@ -116,7 +116,7 @@ declare module "sap/ui/fl/transport/TransportDialog" {
116
116
  * transport request. It is not a generic utility, but part of the Variantmanament and therefore cannot
117
117
  * be used in any other application.
118
118
  */
119
- class TransportDialog extends Dialog {
119
+ export default class TransportDialog extends Dialog {
120
120
  /**
121
121
  * Constructor for a new transport/TransportDialog.
122
122
  *
@@ -184,7 +184,6 @@ declare module "sap/ui/fl/transport/TransportDialog" {
184
184
  */
185
185
  static getMetadata(): ElementMetadata;
186
186
  }
187
- export default TransportDialog;
188
187
 
189
188
  export interface $TransportDialogSettings extends $DialogSettings {}
190
189
  }
@@ -203,13 +202,13 @@ declare module "sap/ui/fl/variants/VariantManagement" {
203
202
  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
204
203
 
205
204
  /**
206
- * @SINCE 1.56
205
+ * @since 1.56
207
206
  *
208
207
  * Can be used to manage variants. You can use this control in most controls that are enabled for key
209
208
  * user adaptation.
210
209
  * **Note: **On the user interface, variants are generally referred to as "views".
211
210
  */
212
- class VariantManagement
211
+ export default class VariantManagement
213
212
  extends Control
214
213
  implements
215
214
  IShrinkable,
@@ -406,7 +405,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
406
405
  /**
407
406
  * The function to be called when the event occurs
408
407
  */
409
- fnFunction: (p1: Event<$VariantManagementManageEventParameters>) => void,
408
+ fnFunction: (p1: VariantManagement$ManageEvent) => void,
410
409
  /**
411
410
  * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
412
411
  * itself
@@ -427,7 +426,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
427
426
  /**
428
427
  * The function to be called when the event occurs
429
428
  */
430
- fnFunction: (p1: Event<$VariantManagementManageEventParameters>) => void,
429
+ fnFunction: (p1: VariantManagement$ManageEvent) => void,
431
430
  /**
432
431
  * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
433
432
  * itself
@@ -454,7 +453,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
454
453
  /**
455
454
  * The function to be called when the event occurs
456
455
  */
457
- fnFunction: (p1: Event<$VariantManagementSaveEventParameters>) => void,
456
+ fnFunction: (p1: VariantManagement$SaveEvent) => void,
458
457
  /**
459
458
  * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
460
459
  * itself
@@ -476,7 +475,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
476
475
  /**
477
476
  * The function to be called when the event occurs
478
477
  */
479
- fnFunction: (p1: Event<$VariantManagementSaveEventParameters>) => void,
478
+ fnFunction: (p1: VariantManagement$SaveEvent) => void,
480
479
  /**
481
480
  * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
482
481
  * itself
@@ -502,7 +501,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
502
501
  /**
503
502
  * The function to be called when the event occurs
504
503
  */
505
- fnFunction: (p1: Event<$VariantManagementSelectEventParameters>) => void,
504
+ fnFunction: (p1: VariantManagement$SelectEvent) => void,
506
505
  /**
507
506
  * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
508
507
  * itself
@@ -523,7 +522,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
523
522
  /**
524
523
  * The function to be called when the event occurs
525
524
  */
526
- fnFunction: (p1: Event<$VariantManagementSelectEventParameters>) => void,
525
+ fnFunction: (p1: VariantManagement$SelectEvent) => void,
527
526
  /**
528
527
  * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
529
528
  * itself
@@ -575,7 +574,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
575
574
  /**
576
575
  * The function to be called, when the event occurs
577
576
  */
578
- fnFunction: (p1: Event<$VariantManagementManageEventParameters>) => void,
577
+ fnFunction: (p1: VariantManagement$ManageEvent) => void,
579
578
  /**
580
579
  * Context object on which the given function had to be called
581
580
  */
@@ -592,7 +591,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
592
591
  /**
593
592
  * The function to be called, when the event occurs
594
593
  */
595
- fnFunction: (p1: Event<$VariantManagementSaveEventParameters>) => void,
594
+ fnFunction: (p1: VariantManagement$SaveEvent) => void,
596
595
  /**
597
596
  * Context object on which the given function had to be called
598
597
  */
@@ -609,14 +608,14 @@ declare module "sap/ui/fl/variants/VariantManagement" {
609
608
  /**
610
609
  * The function to be called, when the event occurs
611
610
  */
612
- fnFunction: (p1: Event<$VariantManagementSelectEventParameters>) => void,
611
+ fnFunction: (p1: VariantManagement$SelectEvent) => void,
613
612
  /**
614
613
  * Context object on which the given function had to be called
615
614
  */
616
615
  oListener?: object
617
616
  ): this;
618
617
  /**
619
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
618
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
620
619
  *
621
620
  * Fires event {@link #event:cancel cancel} to attached listeners.
622
621
  *
@@ -629,7 +628,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
629
628
  mParameters?: object
630
629
  ): this;
631
630
  /**
632
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
631
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
633
632
  *
634
633
  * Fires event {@link #event:initialized initialized} to attached listeners.
635
634
  *
@@ -642,7 +641,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
642
641
  mParameters?: object
643
642
  ): this;
644
643
  /**
645
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
644
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
646
645
  *
647
646
  * Fires event {@link #event:manage manage} to attached listeners.
648
647
  *
@@ -652,10 +651,10 @@ declare module "sap/ui/fl/variants/VariantManagement" {
652
651
  /**
653
652
  * Parameters to pass along with the event
654
653
  */
655
- mParameters?: $VariantManagementManageEventParameters
654
+ mParameters?: VariantManagement$ManageEventParameters
656
655
  ): this;
657
656
  /**
658
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
657
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
659
658
  *
660
659
  * Fires event {@link #event:save save} to attached listeners.
661
660
  *
@@ -665,10 +664,10 @@ declare module "sap/ui/fl/variants/VariantManagement" {
665
664
  /**
666
665
  * Parameters to pass along with the event
667
666
  */
668
- mParameters?: $VariantManagementSaveEventParameters
667
+ mParameters?: VariantManagement$SaveEventParameters
669
668
  ): this;
670
669
  /**
671
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
670
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
672
671
  *
673
672
  * Fires event {@link #event:select select} to attached listeners.
674
673
  *
@@ -678,7 +677,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
678
677
  /**
679
678
  * Parameters to pass along with the event
680
679
  */
681
- mParameters?: $VariantManagementSelectEventParameters
680
+ mParameters?: VariantManagement$SelectEventParameters
682
681
  ): this;
683
682
  /**
684
683
  * Gets the currently selected variant key.
@@ -723,7 +722,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
723
722
  */
724
723
  getFor(): ID[];
725
724
  /**
726
- * @SINCE 1.104
725
+ * @since 1.104
727
726
  *
728
727
  * Gets current value of property {@link #getHeaderLevel headerLevel}.
729
728
  *
@@ -746,18 +745,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
746
745
  */
747
746
  getInErrorState(): boolean;
748
747
  /**
749
- * Gets current value of property {@link #getManualVariantKey manualVariantKey}.
750
- *
751
- * If set to `true`, the key for a vendor variant will be added manually.
752
- * **Note:** This flag is only used internally.
753
- *
754
- * Default value is `false`.
755
- *
756
- * @returns Value of property `manualVariantKey`
757
- */
758
- getManualVariantKey(): boolean;
759
- /**
760
- * @SINCE 1.109
748
+ * @since 1.109
761
749
  *
762
750
  * Gets current value of property {@link #getMaxWidth maxWidth}.
763
751
  *
@@ -785,7 +773,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
785
773
  */
786
774
  getModified(): boolean;
787
775
  /**
788
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
776
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
789
777
  *
790
778
  * Required by the {@link sap.m.IOverflowToolbarContent} interface. Registers invalidations event which
791
779
  * is fired when width of the control is changed.
@@ -820,7 +808,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
820
808
  */
821
809
  getShowSetAsDefault(): boolean;
822
810
  /**
823
- * @SINCE 1.109
811
+ * @since 1.109
824
812
  *
825
813
  * Gets current value of property {@link #getTitleStyle titleStyle}.
826
814
  *
@@ -929,7 +917,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
929
917
  bExecuteOnSelectionForStandardDefault?: boolean
930
918
  ): this;
931
919
  /**
932
- * @SINCE 1.104
920
+ * @since 1.104
933
921
  *
934
922
  * Sets a new value for property {@link #getHeaderLevel headerLevel}.
935
923
  *
@@ -966,25 +954,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
966
954
  bInErrorState?: boolean
967
955
  ): this;
968
956
  /**
969
- * Sets a new value for property {@link #getManualVariantKey manualVariantKey}.
970
- *
971
- * If set to `true`, the key for a vendor variant will be added manually.
972
- * **Note:** This flag is only used internally.
973
- *
974
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
975
- *
976
- * Default value is `false`.
977
- *
978
- * @returns Reference to `this` in order to allow method chaining
979
- */
980
- setManualVariantKey(
981
- /**
982
- * New value for property `manualVariantKey`
983
- */
984
- bManualVariantKey?: boolean
985
- ): this;
986
- /**
987
- * @SINCE 1.109
957
+ * @since 1.109
988
958
  *
989
959
  * Sets a new value for property {@link #getMaxWidth maxWidth}.
990
960
  *
@@ -1056,7 +1026,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
1056
1026
  bShowSetAsDefault?: boolean
1057
1027
  ): this;
1058
1028
  /**
1059
- * @SINCE 1.109
1029
+ * @since 1.109
1060
1030
  *
1061
1031
  * Sets a new value for property {@link #getTitleStyle titleStyle}.
1062
1032
  *
@@ -1094,7 +1064,6 @@ declare module "sap/ui/fl/variants/VariantManagement" {
1094
1064
  bUpdateVariantInURL?: boolean
1095
1065
  ): this;
1096
1066
  }
1097
- export default VariantManagement;
1098
1067
 
1099
1068
  export interface $VariantManagementSettings extends $ControlSettings {
1100
1069
  /**
@@ -1126,12 +1095,6 @@ declare module "sap/ui/fl/variants/VariantManagement" {
1126
1095
  */
1127
1096
  showSetAsDefault?: boolean | PropertyBindingInfo | `{${string}}`;
1128
1097
 
1129
- /**
1130
- * If set to `true`, the key for a vendor variant will be added manually.
1131
- * **Note:** This flag is only used internally.
1132
- */
1133
- manualVariantKey?: boolean | PropertyBindingInfo | `{${string}}`;
1134
-
1135
1098
  /**
1136
1099
  * Indicates that the control is in error state. If set to `true`, an error message will be displayed whenever
1137
1100
  * the variant is opened.
@@ -1156,7 +1119,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
1156
1119
  | PropertyBindingInfo;
1157
1120
 
1158
1121
  /**
1159
- * @SINCE 1.104
1122
+ * @since 1.104
1160
1123
  *
1161
1124
  * Semantic level of the header. For more information, see {@link sap.m.Title#setLevel}.
1162
1125
  */
@@ -1166,7 +1129,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
1166
1129
  | `{${string}}`;
1167
1130
 
1168
1131
  /**
1169
- * @SINCE 1.109
1132
+ * @since 1.109
1170
1133
  *
1171
1134
  * Defines the style of the title. For more information, see {@link sap.m.Title#setTitleStyle}.
1172
1135
  */
@@ -1176,7 +1139,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
1176
1139
  | `{${string}}`;
1177
1140
 
1178
1141
  /**
1179
- * @SINCE 1.109
1142
+ * @since 1.109
1180
1143
  *
1181
1144
  * Sets the maximum width of the control.
1182
1145
  */
@@ -1196,7 +1159,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
1196
1159
  * This event is fired when the Save View dialog or the Save As dialog is closed with the
1197
1160
  * save button.
1198
1161
  */
1199
- save?: (oEvent: Event<$VariantManagementSaveEventParameters>) => void;
1162
+ save?: (oEvent: VariantManagement$SaveEvent) => void;
1200
1163
 
1201
1164
  /**
1202
1165
  * This event is fired when users presses the cancel button inside Save As dialog.
@@ -1206,19 +1169,23 @@ declare module "sap/ui/fl/variants/VariantManagement" {
1206
1169
  /**
1207
1170
  * This event is fired when users apply changes to variants in the Manage Views dialog.
1208
1171
  */
1209
- manage?: (oEvent: Event<$VariantManagementManageEventParameters>) => void;
1172
+ manage?: (oEvent: VariantManagement$ManageEvent) => void;
1210
1173
 
1211
1174
  /**
1212
1175
  * This event is fired when a new variant is selected.
1213
1176
  */
1214
- select?: (oEvent: Event<$VariantManagementSelectEventParameters>) => void;
1177
+ select?: (oEvent: VariantManagement$SelectEvent) => void;
1215
1178
  }
1216
1179
 
1217
- export interface $VariantManagementCancelEventParameters {}
1180
+ export interface VariantManagement$CancelEventParameters {}
1181
+
1182
+ export type VariantManagement$CancelEvent = Event<VariantManagement$CancelEventParameters>;
1183
+
1184
+ export interface VariantManagement$InitializedEventParameters {}
1218
1185
 
1219
- export interface $VariantManagementInitializedEventParameters {}
1186
+ export type VariantManagement$InitializedEvent = Event<VariantManagement$InitializedEventParameters>;
1220
1187
 
1221
- export interface $VariantManagementManageEventParameters {
1188
+ export interface VariantManagement$ManageEventParameters {
1222
1189
  /**
1223
1190
  * List of changed variants. Each entry contains a 'key' - the variant key and a 'name' - the new title
1224
1191
  * of the variant
@@ -1241,7 +1208,9 @@ declare module "sap/ui/fl/variants/VariantManagement" {
1241
1208
  def?: string;
1242
1209
  }
1243
1210
 
1244
- export interface $VariantManagementSaveEventParameters {
1211
+ export type VariantManagement$ManageEvent = Event<VariantManagement$ManageEventParameters>;
1212
+
1213
+ export interface VariantManagement$SaveEventParameters {
1245
1214
  /**
1246
1215
  * Variant title
1247
1216
  */
@@ -1280,19 +1249,23 @@ declare module "sap/ui/fl/variants/VariantManagement" {
1280
1249
  tile?: boolean;
1281
1250
  }
1282
1251
 
1283
- export interface $VariantManagementSelectEventParameters {
1252
+ export type VariantManagement$SaveEvent = Event<VariantManagement$SaveEventParameters>;
1253
+
1254
+ export interface VariantManagement$SelectEventParameters {
1284
1255
  /**
1285
1256
  * Variant key
1286
1257
  */
1287
1258
  key?: string;
1288
1259
  }
1260
+
1261
+ export type VariantManagement$SelectEvent = Event<VariantManagement$SelectEventParameters>;
1289
1262
  }
1290
1263
 
1291
1264
  declare module "sap/ui/fl/write/_internal/fieldExtensibility/ABAPExtensibilityVariant" {
1292
1265
  import Metadata from "sap/ui/base/Metadata";
1293
1266
 
1294
1267
  /**
1295
- * @SINCE 1.87
1268
+ * @since 1.87
1296
1269
  *
1297
1270
  * Abstraction providing an API to handle an ABAP extension variant. Serves also as base class and dummy
1298
1271
  * implementation.
@@ -1336,7 +1309,7 @@ declare module "sap/ui/fl/write/_internal/fieldExtensibility/MultiTenantABAPExte
1336
1309
  import Metadata from "sap/ui/base/Metadata";
1337
1310
 
1338
1311
  /**
1339
- * @SINCE 1.87
1312
+ * @since 1.87
1340
1313
  *
1341
1314
  * Extension variant for ABAP multi tenant environments (via so called Predefined Fields)
1342
1315
  */
@@ -1379,7 +1352,7 @@ declare module "sap/ui/fl/write/_internal/fieldExtensibility/SingleTenantABAPExt
1379
1352
  import Metadata from "sap/ui/base/Metadata";
1380
1353
 
1381
1354
  /**
1382
- * @SINCE 1.87
1355
+ * @since 1.87
1383
1356
  *
1384
1357
  * Extension variant for ABAP single tenant environnments (via so called Custom Fields)
1385
1358
  */
@@ -1420,7 +1393,7 @@ declare module "sap/ui/fl/write/_internal/fieldExtensibility/SingleTenantABAPExt
1420
1393
 
1421
1394
  declare module "sap/ui/fl/write/api/FeaturesAPI" {
1422
1395
  /**
1423
- * @SINCE 1.70
1396
+ * @since 1.70
1424
1397
  *
1425
1398
  * Provides an API to determine which features are available for flexibility.
1426
1399
  */