@openui5/types 1.114.0 → 1.115.1

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.114.0
1
+ // For Library Version: 1.115.1
2
2
 
3
3
  declare namespace sap {}
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.114.0
1
+ // For Library Version: 1.115.1
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
  */
@@ -124,8 +124,8 @@ declare module "sap/ui/fl/transport/TransportDialog" {
124
124
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
125
125
  * of the syntax of the settings object.
126
126
  *
127
- * This class does not have its own settings, but all settings applicable to the base type {@link sap.m.Dialog#constructor
128
- * sap.m.Dialog} can be used.
127
+ * This class does not have its own settings, but all settings applicable to the base type {@link sap.m.Dialog#constructor sap.m.Dialog }
128
+ * can be used.
129
129
  */
130
130
  constructor(
131
131
  /**
@@ -140,8 +140,8 @@ declare module "sap/ui/fl/transport/TransportDialog" {
140
140
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
141
141
  * of the syntax of the settings object.
142
142
  *
143
- * This class does not have its own settings, but all settings applicable to the base type {@link sap.m.Dialog#constructor
144
- * sap.m.Dialog} can be used.
143
+ * This class does not have its own settings, but all settings applicable to the base type {@link sap.m.Dialog#constructor sap.m.Dialog }
144
+ * can be used.
145
145
  */
146
146
  constructor(
147
147
  /**
@@ -202,7 +202,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
202
202
  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
203
203
 
204
204
  /**
205
- * @SINCE 1.56
205
+ * @since 1.56
206
206
  *
207
207
  * Can be used to manage variants. You can use this control in most controls that are enabled for key
208
208
  * user adaptation.
@@ -224,7 +224,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
224
224
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
225
225
  * of the syntax of the settings object.
226
226
  * See:
227
- * {@link topic:f1430c0337534d469da3a56307ff76af Key User Adaptation: Enable Your App}
227
+ * {@link https://ui5.sap.com/#/topic/f1430c0337534d469da3a56307ff76af Key User Adaptation: Enable Your App}
228
228
  */
229
229
  constructor(
230
230
  /**
@@ -239,7 +239,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
239
239
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
240
240
  * of the syntax of the settings object.
241
241
  * See:
242
- * {@link topic:f1430c0337534d469da3a56307ff76af Key User Adaptation: Enable Your App}
242
+ * {@link https://ui5.sap.com/#/topic/f1430c0337534d469da3a56307ff76af Key User Adaptation: Enable Your App}
243
243
  */
244
244
  constructor(
245
245
  /**
@@ -405,7 +405,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
405
405
  /**
406
406
  * The function to be called when the event occurs
407
407
  */
408
- fnFunction: (p1: Event) => void,
408
+ fnFunction: (p1: VariantManagement$ManageEvent) => void,
409
409
  /**
410
410
  * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
411
411
  * itself
@@ -426,7 +426,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
426
426
  /**
427
427
  * The function to be called when the event occurs
428
428
  */
429
- fnFunction: (p1: Event) => void,
429
+ fnFunction: (p1: VariantManagement$ManageEvent) => void,
430
430
  /**
431
431
  * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
432
432
  * itself
@@ -453,7 +453,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
453
453
  /**
454
454
  * The function to be called when the event occurs
455
455
  */
456
- fnFunction: (p1: Event) => void,
456
+ fnFunction: (p1: VariantManagement$SaveEvent) => void,
457
457
  /**
458
458
  * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
459
459
  * itself
@@ -475,7 +475,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
475
475
  /**
476
476
  * The function to be called when the event occurs
477
477
  */
478
- fnFunction: (p1: Event) => void,
478
+ fnFunction: (p1: VariantManagement$SaveEvent) => void,
479
479
  /**
480
480
  * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
481
481
  * itself
@@ -501,7 +501,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
501
501
  /**
502
502
  * The function to be called when the event occurs
503
503
  */
504
- fnFunction: (p1: Event) => void,
504
+ fnFunction: (p1: VariantManagement$SelectEvent) => void,
505
505
  /**
506
506
  * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
507
507
  * itself
@@ -522,7 +522,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
522
522
  /**
523
523
  * The function to be called when the event occurs
524
524
  */
525
- fnFunction: (p1: Event) => void,
525
+ fnFunction: (p1: VariantManagement$SelectEvent) => void,
526
526
  /**
527
527
  * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
528
528
  * itself
@@ -574,7 +574,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
574
574
  /**
575
575
  * The function to be called, when the event occurs
576
576
  */
577
- fnFunction: (p1: Event) => void,
577
+ fnFunction: (p1: VariantManagement$ManageEvent) => void,
578
578
  /**
579
579
  * Context object on which the given function had to be called
580
580
  */
@@ -591,7 +591,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
591
591
  /**
592
592
  * The function to be called, when the event occurs
593
593
  */
594
- fnFunction: (p1: Event) => void,
594
+ fnFunction: (p1: VariantManagement$SaveEvent) => void,
595
595
  /**
596
596
  * Context object on which the given function had to be called
597
597
  */
@@ -608,14 +608,14 @@ declare module "sap/ui/fl/variants/VariantManagement" {
608
608
  /**
609
609
  * The function to be called, when the event occurs
610
610
  */
611
- fnFunction: (p1: Event) => void,
611
+ fnFunction: (p1: VariantManagement$SelectEvent) => void,
612
612
  /**
613
613
  * Context object on which the given function had to be called
614
614
  */
615
615
  oListener?: object
616
616
  ): this;
617
617
  /**
618
- * @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)
619
619
  *
620
620
  * Fires event {@link #event:cancel cancel} to attached listeners.
621
621
  *
@@ -628,7 +628,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
628
628
  mParameters?: object
629
629
  ): this;
630
630
  /**
631
- * @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)
632
632
  *
633
633
  * Fires event {@link #event:initialized initialized} to attached listeners.
634
634
  *
@@ -641,7 +641,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
641
641
  mParameters?: object
642
642
  ): this;
643
643
  /**
644
- * @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)
645
645
  *
646
646
  * Fires event {@link #event:manage manage} to attached listeners.
647
647
  *
@@ -651,28 +651,10 @@ declare module "sap/ui/fl/variants/VariantManagement" {
651
651
  /**
652
652
  * Parameters to pass along with the event
653
653
  */
654
- mParameters?: {
655
- /**
656
- * List of changed variants. Each entry contains a 'key' - the variant key and a 'name' - the new title
657
- * of the variant
658
- */
659
- renamed?: object[];
660
- /**
661
- * List of deleted variant keys
662
- */
663
- deleted?: string[];
664
- /**
665
- * List of variant keys and the associated Execute on Selection indicator
666
- */
667
- exe?: object[];
668
- /**
669
- * The default variant key
670
- */
671
- def?: string;
672
- }
654
+ mParameters?: VariantManagement$ManageEventParameters
673
655
  ): this;
674
656
  /**
675
- * @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)
676
658
  *
677
659
  * Fires event {@link #event:save save} to attached listeners.
678
660
  *
@@ -682,41 +664,10 @@ declare module "sap/ui/fl/variants/VariantManagement" {
682
664
  /**
683
665
  * Parameters to pass along with the event
684
666
  */
685
- mParameters?: {
686
- /**
687
- * Variant title
688
- */
689
- name?: string;
690
- /**
691
- * Indicates if an existing variant is overwritten or if a new variant is created.
692
- */
693
- overwrite?: boolean;
694
- /**
695
- * Variant key
696
- */
697
- key?: string;
698
- /**
699
- * Apply Automatically indicator
700
- */
701
- execute?: boolean;
702
- /**
703
- * Indicates the check box state for 'Public'.
704
- */
705
- public?: boolean;
706
- /**
707
- * The default variant indicator
708
- */
709
- def?: boolean;
710
- /**
711
- * Indicates the check box state for 'Create Tile'.
712
- * Note:
713
- * This event parameter is used only internally.
714
- */
715
- tile?: boolean;
716
- }
667
+ mParameters?: VariantManagement$SaveEventParameters
717
668
  ): this;
718
669
  /**
719
- * @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)
720
671
  *
721
672
  * Fires event {@link #event:select select} to attached listeners.
722
673
  *
@@ -726,12 +677,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
726
677
  /**
727
678
  * Parameters to pass along with the event
728
679
  */
729
- mParameters?: {
730
- /**
731
- * Variant key
732
- */
733
- key?: string;
734
- }
680
+ mParameters?: VariantManagement$SelectEventParameters
735
681
  ): this;
736
682
  /**
737
683
  * Gets the currently selected variant key.
@@ -772,12 +718,11 @@ declare module "sap/ui/fl/variants/VariantManagement" {
772
718
  */
773
719
  getExecuteOnSelectionForStandardDefault(): boolean;
774
720
  /**
775
- * Returns array of IDs of the elements which are the current targets of the association {@link #getFor
776
- * for}.
721
+ * Returns array of IDs of the elements which are the current targets of the association {@link #getFor for}.
777
722
  */
778
723
  getFor(): ID[];
779
724
  /**
780
- * @SINCE 1.104
725
+ * @since 1.104
781
726
  *
782
727
  * Gets current value of property {@link #getHeaderLevel headerLevel}.
783
728
  *
@@ -811,7 +756,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
811
756
  */
812
757
  getManualVariantKey(): boolean;
813
758
  /**
814
- * @SINCE 1.109
759
+ * @since 1.109
815
760
  *
816
761
  * Gets current value of property {@link #getMaxWidth maxWidth}.
817
762
  *
@@ -839,7 +784,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
839
784
  */
840
785
  getModified(): boolean;
841
786
  /**
842
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
787
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
843
788
  *
844
789
  * Required by the {@link sap.m.IOverflowToolbarContent} interface. Registers invalidations event which
845
790
  * is fired when width of the control is changed.
@@ -874,7 +819,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
874
819
  */
875
820
  getShowSetAsDefault(): boolean;
876
821
  /**
877
- * @SINCE 1.109
822
+ * @since 1.109
878
823
  *
879
824
  * Gets current value of property {@link #getTitleStyle titleStyle}.
880
825
  *
@@ -983,7 +928,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
983
928
  bExecuteOnSelectionForStandardDefault?: boolean
984
929
  ): this;
985
930
  /**
986
- * @SINCE 1.104
931
+ * @since 1.104
987
932
  *
988
933
  * Sets a new value for property {@link #getHeaderLevel headerLevel}.
989
934
  *
@@ -1038,7 +983,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
1038
983
  bManualVariantKey?: boolean
1039
984
  ): this;
1040
985
  /**
1041
- * @SINCE 1.109
986
+ * @since 1.109
1042
987
  *
1043
988
  * Sets a new value for property {@link #getMaxWidth maxWidth}.
1044
989
  *
@@ -1110,7 +1055,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
1110
1055
  bShowSetAsDefault?: boolean
1111
1056
  ): this;
1112
1057
  /**
1113
- * @SINCE 1.109
1058
+ * @since 1.109
1114
1059
  *
1115
1060
  * Sets a new value for property {@link #getTitleStyle titleStyle}.
1116
1061
  *
@@ -1209,7 +1154,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
1209
1154
  | PropertyBindingInfo;
1210
1155
 
1211
1156
  /**
1212
- * @SINCE 1.104
1157
+ * @since 1.104
1213
1158
  *
1214
1159
  * Semantic level of the header. For more information, see {@link sap.m.Title#setLevel}.
1215
1160
  */
@@ -1219,7 +1164,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
1219
1164
  | `{${string}}`;
1220
1165
 
1221
1166
  /**
1222
- * @SINCE 1.109
1167
+ * @since 1.109
1223
1168
  *
1224
1169
  * Defines the style of the title. For more information, see {@link sap.m.Title#setTitleStyle}.
1225
1170
  */
@@ -1229,7 +1174,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
1229
1174
  | `{${string}}`;
1230
1175
 
1231
1176
  /**
1232
- * @SINCE 1.109
1177
+ * @since 1.109
1233
1178
  *
1234
1179
  * Sets the maximum width of the control.
1235
1180
  */
@@ -1249,7 +1194,7 @@ declare module "sap/ui/fl/variants/VariantManagement" {
1249
1194
  * This event is fired when the Save View dialog or the Save As dialog is closed with the
1250
1195
  * save button.
1251
1196
  */
1252
- save?: (oEvent: Event) => void;
1197
+ save?: (oEvent: Event<VariantManagement$SaveEventParameters>) => void;
1253
1198
 
1254
1199
  /**
1255
1200
  * This event is fired when users presses the cancel button inside Save As dialog.
@@ -1259,20 +1204,133 @@ declare module "sap/ui/fl/variants/VariantManagement" {
1259
1204
  /**
1260
1205
  * This event is fired when users apply changes to variants in the Manage Views dialog.
1261
1206
  */
1262
- manage?: (oEvent: Event) => void;
1207
+ manage?: (oEvent: Event<VariantManagement$ManageEventParameters>) => void;
1263
1208
 
1264
1209
  /**
1265
1210
  * This event is fired when a new variant is selected.
1266
1211
  */
1267
- select?: (oEvent: Event) => void;
1212
+ select?: (oEvent: Event<VariantManagement$SelectEventParameters>) => void;
1213
+ }
1214
+
1215
+ export interface VariantManagement$CancelEventParameters {}
1216
+
1217
+ /**
1218
+ * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'VariantManagement$CancelEventParameters'
1219
+ * in 1.115.1 and any later releases.
1220
+ */
1221
+ export type $VariantManagementCancelEventParameters = VariantManagement$CancelEventParameters;
1222
+
1223
+ export type VariantManagement$CancelEvent = Event<VariantManagement$CancelEventParameters>;
1224
+
1225
+ export interface VariantManagement$InitializedEventParameters {}
1226
+
1227
+ /**
1228
+ * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'VariantManagement$InitializedEventParameters'
1229
+ * in 1.115.1 and any later releases.
1230
+ */
1231
+ export type $VariantManagementInitializedEventParameters = VariantManagement$InitializedEventParameters;
1232
+
1233
+ export type VariantManagement$InitializedEvent = Event<VariantManagement$InitializedEventParameters>;
1234
+
1235
+ export interface VariantManagement$ManageEventParameters {
1236
+ /**
1237
+ * List of changed variants. Each entry contains a 'key' - the variant key and a 'name' - the new title
1238
+ * of the variant
1239
+ */
1240
+ renamed?: object[];
1241
+
1242
+ /**
1243
+ * List of deleted variant keys
1244
+ */
1245
+ deleted?: string[];
1246
+
1247
+ /**
1248
+ * List of variant keys and the associated Execute on Selection indicator
1249
+ */
1250
+ exe?: object[];
1251
+
1252
+ /**
1253
+ * The default variant key
1254
+ */
1255
+ def?: string;
1268
1256
  }
1257
+
1258
+ /**
1259
+ * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'VariantManagement$ManageEventParameters'
1260
+ * in 1.115.1 and any later releases.
1261
+ */
1262
+ export type $VariantManagementManageEventParameters = VariantManagement$ManageEventParameters;
1263
+
1264
+ export type VariantManagement$ManageEvent = Event<VariantManagement$ManageEventParameters>;
1265
+
1266
+ export interface VariantManagement$SaveEventParameters {
1267
+ /**
1268
+ * Variant title
1269
+ */
1270
+ name?: string;
1271
+
1272
+ /**
1273
+ * Indicates if an existing variant is overwritten or if a new variant is created.
1274
+ */
1275
+ overwrite?: boolean;
1276
+
1277
+ /**
1278
+ * Variant key
1279
+ */
1280
+ key?: string;
1281
+
1282
+ /**
1283
+ * Apply Automatically indicator
1284
+ */
1285
+ execute?: boolean;
1286
+
1287
+ /**
1288
+ * Indicates the check box state for 'Public'.
1289
+ */
1290
+ public?: boolean;
1291
+
1292
+ /**
1293
+ * The default variant indicator
1294
+ */
1295
+ def?: boolean;
1296
+
1297
+ /**
1298
+ * Indicates the check box state for 'Create Tile'.
1299
+ * Note:
1300
+ * This event parameter is used only internally.
1301
+ */
1302
+ tile?: boolean;
1303
+ }
1304
+
1305
+ /**
1306
+ * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'VariantManagement$SaveEventParameters'
1307
+ * in 1.115.1 and any later releases.
1308
+ */
1309
+ export type $VariantManagementSaveEventParameters = VariantManagement$SaveEventParameters;
1310
+
1311
+ export type VariantManagement$SaveEvent = Event<VariantManagement$SaveEventParameters>;
1312
+
1313
+ export interface VariantManagement$SelectEventParameters {
1314
+ /**
1315
+ * Variant key
1316
+ */
1317
+ key?: string;
1318
+ }
1319
+
1320
+ /**
1321
+ * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'VariantManagement$SelectEventParameters'
1322
+ * in 1.115.1 and any later releases.
1323
+ */
1324
+ export type $VariantManagementSelectEventParameters = VariantManagement$SelectEventParameters;
1325
+
1326
+ export type VariantManagement$SelectEvent = Event<VariantManagement$SelectEventParameters>;
1269
1327
  }
1270
1328
 
1271
1329
  declare module "sap/ui/fl/write/_internal/fieldExtensibility/ABAPExtensibilityVariant" {
1272
1330
  import Metadata from "sap/ui/base/Metadata";
1273
1331
 
1274
1332
  /**
1275
- * @SINCE 1.87
1333
+ * @since 1.87
1276
1334
  *
1277
1335
  * Abstraction providing an API to handle an ABAP extension variant. Serves also as base class and dummy
1278
1336
  * implementation.
@@ -1316,7 +1374,7 @@ declare module "sap/ui/fl/write/_internal/fieldExtensibility/MultiTenantABAPExte
1316
1374
  import Metadata from "sap/ui/base/Metadata";
1317
1375
 
1318
1376
  /**
1319
- * @SINCE 1.87
1377
+ * @since 1.87
1320
1378
  *
1321
1379
  * Extension variant for ABAP multi tenant environments (via so called Predefined Fields)
1322
1380
  */
@@ -1359,7 +1417,7 @@ declare module "sap/ui/fl/write/_internal/fieldExtensibility/SingleTenantABAPExt
1359
1417
  import Metadata from "sap/ui/base/Metadata";
1360
1418
 
1361
1419
  /**
1362
- * @SINCE 1.87
1420
+ * @since 1.87
1363
1421
  *
1364
1422
  * Extension variant for ABAP single tenant environnments (via so called Custom Fields)
1365
1423
  */
@@ -1400,7 +1458,7 @@ declare module "sap/ui/fl/write/_internal/fieldExtensibility/SingleTenantABAPExt
1400
1458
 
1401
1459
  declare module "sap/ui/fl/write/api/FeaturesAPI" {
1402
1460
  /**
1403
- * @SINCE 1.70
1461
+ * @since 1.70
1404
1462
  *
1405
1463
  * Provides an API to determine which features are available for flexibility.
1406
1464
  */
@@ -1504,6 +1562,8 @@ declare namespace sap {
1504
1562
 
1505
1563
  "sap/ui/fl/apply/_internal/flexState/UI2Personalization/UI2PersonalizationState": undefined;
1506
1564
 
1565
+ "sap/ui/fl/apply/_internal/preprocessors/ComponentLifecycleHooks": undefined;
1566
+
1507
1567
  "sap/ui/fl/apply/_internal/preprocessors/ControllerExtension": undefined;
1508
1568
 
1509
1569
  "sap/ui/fl/apply/_internal/preprocessors/EventHistory": undefined;