@openui5/ts-types-esm 1.101.0 → 1.102.2
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.
- package/package.json +1 -1
- package/types/sap.f.d.ts +1722 -100
- package/types/sap.m.d.ts +15212 -1155
- package/types/sap.tnt.d.ts +251 -19
- package/types/sap.ui.codeeditor.d.ts +74 -8
- package/types/sap.ui.commons.d.ts +3379 -313
- package/types/sap.ui.core.d.ts +6107 -312
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.fl.d.ts +149 -8
- package/types/sap.ui.integration.d.ts +293 -23
- package/types/sap.ui.layout.d.ts +1550 -199
- package/types/sap.ui.mdc.d.ts +5 -1
- package/types/sap.ui.rta.d.ts +5 -1
- package/types/sap.ui.suite.d.ts +75 -6
- package/types/sap.ui.support.d.ts +30 -1
- package/types/sap.ui.table.d.ts +920 -80
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +2456 -202
- package/types/sap.ui.ux3.d.ts +2192 -181
- package/types/sap.ui.webc.common.d.ts +5 -4
- package/types/sap.ui.webc.fiori.d.ts +1386 -105
- package/types/sap.ui.webc.main.d.ts +4946 -365
- package/types/sap.uxap.d.ts +811 -87
package/types/sap.ui.dt.d.ts
CHANGED
package/types/sap.ui.fl.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.
|
|
1
|
+
// For Library Version: 1.102.2
|
|
2
2
|
|
|
3
3
|
declare module "sap/ui/fl/library" {}
|
|
4
4
|
|
|
@@ -14,6 +14,8 @@ declare module "sap/ui/fl/apply/api/ControlVariantApplyAPI" {
|
|
|
14
14
|
interface ControlVariantApplyAPI {
|
|
15
15
|
/**
|
|
16
16
|
* Activates the passed variant applicable to the passed control/component.
|
|
17
|
+
*
|
|
18
|
+
* @returns Resolves after the variant is activated or rejects if an error occurs
|
|
17
19
|
*/
|
|
18
20
|
activateVariant(
|
|
19
21
|
/**
|
|
@@ -110,6 +112,8 @@ declare module "sap/ui/fl/changeHandler/BaseAddViaDelegate" {
|
|
|
110
112
|
|
|
111
113
|
/**
|
|
112
114
|
* Returns an instance of the addViaDelegate change handler
|
|
115
|
+
*
|
|
116
|
+
* @returns The addViaDelegate change handler object
|
|
113
117
|
*/
|
|
114
118
|
static createAddViaDelegateChangeHandler(
|
|
115
119
|
/**
|
|
@@ -203,6 +207,8 @@ declare module "sap/ui/fl/interfaces/Delegate" {
|
|
|
203
207
|
* Creates a control to show and edit the corresponding metadata property and provide a value help if that
|
|
204
208
|
* is needed in addition. The control should be created with the modifier as it will be called by change
|
|
205
209
|
* handlers during XML preprocessing with XML nodes as well as at runtime when real control instances exist.
|
|
210
|
+
*
|
|
211
|
+
* @returns Map containing the controls to add
|
|
206
212
|
*/
|
|
207
213
|
createControlForProperty(
|
|
208
214
|
/**
|
|
@@ -260,6 +266,8 @@ declare module "sap/ui/fl/interfaces/Delegate" {
|
|
|
260
266
|
* Creates a label for the corresponding metadata property. The control should be created with the modifier
|
|
261
267
|
* as it will be called by change handlers during XML preprocessing with XML nodes as well as at runtime
|
|
262
268
|
* when real control instances exist.
|
|
269
|
+
*
|
|
270
|
+
* @returns Control representation of the label (e.g. `sap.m.Label`)
|
|
263
271
|
*/
|
|
264
272
|
createLabel(
|
|
265
273
|
/**
|
|
@@ -309,6 +317,8 @@ declare module "sap/ui/fl/interfaces/Delegate" {
|
|
|
309
317
|
* property in an arrangement fitting a generic layout container. The controls should be created with the
|
|
310
318
|
* modifier as it will be called by change handlers during XML preprocessing with XML nodes as well as at
|
|
311
319
|
* runtime when real control instances exist.
|
|
320
|
+
*
|
|
321
|
+
* @returns Map containing the controls to add
|
|
312
322
|
*/
|
|
313
323
|
createLayout(
|
|
314
324
|
/**
|
|
@@ -361,6 +371,8 @@ declare module "sap/ui/fl/interfaces/Delegate" {
|
|
|
361
371
|
/**
|
|
362
372
|
* Provides all properties that are available at the current binding context. In OData, this will probably
|
|
363
373
|
* be all properties of the entityType. Technical properties, such as field control, should not be returned.
|
|
374
|
+
*
|
|
375
|
+
* @returns Metadata in a deep structure of nodes and properties
|
|
364
376
|
*/
|
|
365
377
|
getPropertyInfo(
|
|
366
378
|
/**
|
|
@@ -387,6 +399,10 @@ declare module "sap/ui/fl/interfaces/Delegate" {
|
|
|
387
399
|
* Optional method to provide all properties and the corresponding controls that represent them. Implement
|
|
388
400
|
* this method if evaluating the binding is not enough e.g. a Table has not yet received a binding or if
|
|
389
401
|
* e.g. a filter field represents a property without binding.
|
|
402
|
+
*
|
|
403
|
+
* @returns Data about properties represented. Resolve `undefined` or don't implement the method if you
|
|
404
|
+
* don't want to take over the check for representation. Resolve an empty array if no property is represented
|
|
405
|
+
* at the moment.
|
|
390
406
|
*/
|
|
391
407
|
getRepresentedProperties(
|
|
392
408
|
/**
|
|
@@ -574,6 +590,8 @@ declare module "sap/ui/fl/transport/TransportDialog" {
|
|
|
574
590
|
* it with the information contained in `oClassInfo`.
|
|
575
591
|
*
|
|
576
592
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.m.Dialog.extend}.
|
|
593
|
+
*
|
|
594
|
+
* @returns Created class / constructor function
|
|
577
595
|
*/
|
|
578
596
|
static extend<T extends Record<string, unknown>>(
|
|
579
597
|
/**
|
|
@@ -592,6 +610,8 @@ declare module "sap/ui/fl/transport/TransportDialog" {
|
|
|
592
610
|
): Function;
|
|
593
611
|
/**
|
|
594
612
|
* Returns a metadata object for class sap.ui.fl.transport.TransportDialog.
|
|
613
|
+
*
|
|
614
|
+
* @returns Metadata object describing this class
|
|
595
615
|
*/
|
|
596
616
|
static getMetadata(): ElementMetadata;
|
|
597
617
|
}
|
|
@@ -665,6 +685,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
|
|
|
665
685
|
* it with the information contained in `oClassInfo`.
|
|
666
686
|
*
|
|
667
687
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
|
|
688
|
+
*
|
|
689
|
+
* @returns Created class / constructor function
|
|
668
690
|
*/
|
|
669
691
|
static extend<T extends Record<string, unknown>>(
|
|
670
692
|
/**
|
|
@@ -683,10 +705,14 @@ declare module "sap/ui/fl/variants/VariantManagement" {
|
|
|
683
705
|
): Function;
|
|
684
706
|
/**
|
|
685
707
|
* Returns a metadata object for class sap.ui.fl.variants.VariantManagement.
|
|
708
|
+
*
|
|
709
|
+
* @returns Metadata object describing this class
|
|
686
710
|
*/
|
|
687
711
|
static getMetadata(): ElementMetadata;
|
|
688
712
|
/**
|
|
689
713
|
* Adds some for into the association {@link #getFor for}.
|
|
714
|
+
*
|
|
715
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
690
716
|
*/
|
|
691
717
|
addFor(
|
|
692
718
|
/**
|
|
@@ -701,6 +727,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
|
|
|
701
727
|
* otherwise it will be bound to this `sap.ui.fl.variants.VariantManagement` itself.
|
|
702
728
|
*
|
|
703
729
|
* This event is fired when users presses the cancel button inside Save As dialog.
|
|
730
|
+
*
|
|
731
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
704
732
|
*/
|
|
705
733
|
attachCancel(
|
|
706
734
|
/**
|
|
@@ -725,6 +753,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
|
|
|
725
753
|
* otherwise it will be bound to this `sap.ui.fl.variants.VariantManagement` itself.
|
|
726
754
|
*
|
|
727
755
|
* This event is fired when users presses the cancel button inside Save As dialog.
|
|
756
|
+
*
|
|
757
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
728
758
|
*/
|
|
729
759
|
attachCancel(
|
|
730
760
|
/**
|
|
@@ -744,6 +774,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
|
|
|
744
774
|
* otherwise it will be bound to this `sap.ui.fl.variants.VariantManagement` itself.
|
|
745
775
|
*
|
|
746
776
|
* This event is fired when the model and context are set.
|
|
777
|
+
*
|
|
778
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
747
779
|
*/
|
|
748
780
|
attachInitialized(
|
|
749
781
|
/**
|
|
@@ -768,6 +800,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
|
|
|
768
800
|
* otherwise it will be bound to this `sap.ui.fl.variants.VariantManagement` itself.
|
|
769
801
|
*
|
|
770
802
|
* This event is fired when the model and context are set.
|
|
803
|
+
*
|
|
804
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
771
805
|
*/
|
|
772
806
|
attachInitialized(
|
|
773
807
|
/**
|
|
@@ -787,6 +821,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
|
|
|
787
821
|
* otherwise it will be bound to this `sap.ui.fl.variants.VariantManagement` itself.
|
|
788
822
|
*
|
|
789
823
|
* This event is fired when users apply changes to variants in the Manage Views dialog.
|
|
824
|
+
*
|
|
825
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
790
826
|
*/
|
|
791
827
|
attachManage(
|
|
792
828
|
/**
|
|
@@ -811,6 +847,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
|
|
|
811
847
|
* otherwise it will be bound to this `sap.ui.fl.variants.VariantManagement` itself.
|
|
812
848
|
*
|
|
813
849
|
* This event is fired when users apply changes to variants in the Manage Views dialog.
|
|
850
|
+
*
|
|
851
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
814
852
|
*/
|
|
815
853
|
attachManage(
|
|
816
854
|
/**
|
|
@@ -831,6 +869,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
|
|
|
831
869
|
*
|
|
832
870
|
* This event is fired when the Save View dialog or the Save As dialog is closed with the
|
|
833
871
|
* save button.
|
|
872
|
+
*
|
|
873
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
834
874
|
*/
|
|
835
875
|
attachSave(
|
|
836
876
|
/**
|
|
@@ -856,6 +896,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
|
|
|
856
896
|
*
|
|
857
897
|
* This event is fired when the Save View dialog or the Save As dialog is closed with the
|
|
858
898
|
* save button.
|
|
899
|
+
*
|
|
900
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
859
901
|
*/
|
|
860
902
|
attachSave(
|
|
861
903
|
/**
|
|
@@ -875,6 +917,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
|
|
|
875
917
|
* otherwise it will be bound to this `sap.ui.fl.variants.VariantManagement` itself.
|
|
876
918
|
*
|
|
877
919
|
* This event is fired when a new variant is selected.
|
|
920
|
+
*
|
|
921
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
878
922
|
*/
|
|
879
923
|
attachSelect(
|
|
880
924
|
/**
|
|
@@ -899,6 +943,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
|
|
|
899
943
|
* otherwise it will be bound to this `sap.ui.fl.variants.VariantManagement` itself.
|
|
900
944
|
*
|
|
901
945
|
* This event is fired when a new variant is selected.
|
|
946
|
+
*
|
|
947
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
902
948
|
*/
|
|
903
949
|
attachSelect(
|
|
904
950
|
/**
|
|
@@ -915,6 +961,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
|
|
|
915
961
|
* Detaches event handler `fnFunction` from the {@link #event:cancel cancel} event of this `sap.ui.fl.variants.VariantManagement`.
|
|
916
962
|
*
|
|
917
963
|
* The passed function and listener object must match the ones used for event registration.
|
|
964
|
+
*
|
|
965
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
918
966
|
*/
|
|
919
967
|
detachCancel(
|
|
920
968
|
/**
|
|
@@ -930,6 +978,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
|
|
|
930
978
|
* Detaches event handler `fnFunction` from the {@link #event:initialized initialized} event of this `sap.ui.fl.variants.VariantManagement`.
|
|
931
979
|
*
|
|
932
980
|
* The passed function and listener object must match the ones used for event registration.
|
|
981
|
+
*
|
|
982
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
933
983
|
*/
|
|
934
984
|
detachInitialized(
|
|
935
985
|
/**
|
|
@@ -945,6 +995,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
|
|
|
945
995
|
* Detaches event handler `fnFunction` from the {@link #event:manage manage} event of this `sap.ui.fl.variants.VariantManagement`.
|
|
946
996
|
*
|
|
947
997
|
* The passed function and listener object must match the ones used for event registration.
|
|
998
|
+
*
|
|
999
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
948
1000
|
*/
|
|
949
1001
|
detachManage(
|
|
950
1002
|
/**
|
|
@@ -960,6 +1012,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
|
|
|
960
1012
|
* Detaches event handler `fnFunction` from the {@link #event:save save} event of this `sap.ui.fl.variants.VariantManagement`.
|
|
961
1013
|
*
|
|
962
1014
|
* The passed function and listener object must match the ones used for event registration.
|
|
1015
|
+
*
|
|
1016
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
963
1017
|
*/
|
|
964
1018
|
detachSave(
|
|
965
1019
|
/**
|
|
@@ -975,6 +1029,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
|
|
|
975
1029
|
* Detaches event handler `fnFunction` from the {@link #event:select select} event of this `sap.ui.fl.variants.VariantManagement`.
|
|
976
1030
|
*
|
|
977
1031
|
* The passed function and listener object must match the ones used for event registration.
|
|
1032
|
+
*
|
|
1033
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
978
1034
|
*/
|
|
979
1035
|
detachSelect(
|
|
980
1036
|
/**
|
|
@@ -988,6 +1044,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
|
|
|
988
1044
|
): this;
|
|
989
1045
|
/**
|
|
990
1046
|
* Fires event {@link #event:cancel cancel} to attached listeners.
|
|
1047
|
+
*
|
|
1048
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
991
1049
|
*/
|
|
992
1050
|
fireCancel(
|
|
993
1051
|
/**
|
|
@@ -997,6 +1055,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
|
|
|
997
1055
|
): this;
|
|
998
1056
|
/**
|
|
999
1057
|
* Fires event {@link #event:initialized initialized} to attached listeners.
|
|
1058
|
+
*
|
|
1059
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1000
1060
|
*/
|
|
1001
1061
|
fireInitialized(
|
|
1002
1062
|
/**
|
|
@@ -1006,6 +1066,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
|
|
|
1006
1066
|
): this;
|
|
1007
1067
|
/**
|
|
1008
1068
|
* Fires event {@link #event:manage manage} to attached listeners.
|
|
1069
|
+
*
|
|
1070
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1009
1071
|
*/
|
|
1010
1072
|
fireManage(
|
|
1011
1073
|
/**
|
|
@@ -1015,6 +1077,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
|
|
|
1015
1077
|
): this;
|
|
1016
1078
|
/**
|
|
1017
1079
|
* Fires event {@link #event:save save} to attached listeners.
|
|
1080
|
+
*
|
|
1081
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1018
1082
|
*/
|
|
1019
1083
|
fireSave(
|
|
1020
1084
|
/**
|
|
@@ -1045,6 +1109,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
|
|
|
1045
1109
|
): this;
|
|
1046
1110
|
/**
|
|
1047
1111
|
* Fires event {@link #event:select select} to attached listeners.
|
|
1112
|
+
*
|
|
1113
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1048
1114
|
*/
|
|
1049
1115
|
fireSelect(
|
|
1050
1116
|
/**
|
|
@@ -1059,6 +1125,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
|
|
|
1059
1125
|
): this;
|
|
1060
1126
|
/**
|
|
1061
1127
|
* Gets the currently selected variant key.
|
|
1128
|
+
*
|
|
1129
|
+
* @returns Key of the currently selected variant. In case the model is not yet set `null` will be returned.
|
|
1062
1130
|
*/
|
|
1063
1131
|
getCurrentVariantKey(): string;
|
|
1064
1132
|
/**
|
|
@@ -1073,6 +1141,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
|
|
|
1073
1141
|
* **Note:** the usage of this property is restricted to `sap.fe` components only.
|
|
1074
1142
|
*
|
|
1075
1143
|
* Default value is `empty string`.
|
|
1144
|
+
*
|
|
1145
|
+
* @returns Value of property `displayTextForExecuteOnSelectionForStandardVariant`
|
|
1076
1146
|
*/
|
|
1077
1147
|
getDisplayTextForExecuteOnSelectionForStandardVariant(): string;
|
|
1078
1148
|
/**
|
|
@@ -1082,6 +1152,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
|
|
|
1082
1152
|
* be hidden.
|
|
1083
1153
|
*
|
|
1084
1154
|
* Default value is `true`.
|
|
1155
|
+
*
|
|
1156
|
+
* @returns Value of property `editable`
|
|
1085
1157
|
*/
|
|
1086
1158
|
getEditable(): boolean;
|
|
1087
1159
|
/**
|
|
@@ -1092,6 +1164,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
|
|
|
1092
1164
|
* Determines the behavior for Apply Automatically if the standard variant is marked as the default variant.
|
|
1093
1165
|
*
|
|
1094
1166
|
* Default value is `false`.
|
|
1167
|
+
*
|
|
1168
|
+
* @returns Value of property `executeOnSelectionForStandardDefault`
|
|
1095
1169
|
*/
|
|
1096
1170
|
getExecuteOnSelectionForStandardDefault(): boolean;
|
|
1097
1171
|
/**
|
|
@@ -1106,6 +1180,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
|
|
|
1106
1180
|
* the variant is opened.
|
|
1107
1181
|
*
|
|
1108
1182
|
* Default value is `false`.
|
|
1183
|
+
*
|
|
1184
|
+
* @returns Value of property `inErrorState`
|
|
1109
1185
|
*/
|
|
1110
1186
|
getInErrorState(): boolean;
|
|
1111
1187
|
/**
|
|
@@ -1115,6 +1191,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
|
|
|
1115
1191
|
* **Note:**This flag is only used internally in the app variant scenarios.
|
|
1116
1192
|
*
|
|
1117
1193
|
* Default value is `false`.
|
|
1194
|
+
*
|
|
1195
|
+
* @returns Value of property `manualVariantKey`
|
|
1118
1196
|
*/
|
|
1119
1197
|
getManualVariantKey(): boolean;
|
|
1120
1198
|
/**
|
|
@@ -1122,15 +1200,21 @@ declare module "sap/ui/fl/variants/VariantManagement" {
|
|
|
1122
1200
|
*
|
|
1123
1201
|
* Determines the name of the model. The binding context will be defined by the current ID. **Note:**
|
|
1124
1202
|
* In a UI adaptation scenario, this property is not used at all, because the model name is `$FlexVariants`.
|
|
1203
|
+
*
|
|
1204
|
+
* @returns Value of property `modelName`
|
|
1125
1205
|
*/
|
|
1126
1206
|
getModelName(): string;
|
|
1127
1207
|
/**
|
|
1128
1208
|
* Determines if the current variant is modified.
|
|
1209
|
+
*
|
|
1210
|
+
* @returns If the current variant is modified `true`, otherwise `false`
|
|
1129
1211
|
*/
|
|
1130
1212
|
getModified(): boolean;
|
|
1131
1213
|
/**
|
|
1132
1214
|
* Required by the {@link sap.m.IOverflowToolbarContent} interface. Registers invalidations event which
|
|
1133
1215
|
* is fired when width of the control is changed.
|
|
1216
|
+
*
|
|
1217
|
+
* @returns Configuration information for the `sap.m.IOverflowToolbarContent` interface.
|
|
1134
1218
|
*/
|
|
1135
1219
|
getOverflowToolbarConfig(): object;
|
|
1136
1220
|
/**
|
|
@@ -1140,6 +1224,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
|
|
|
1140
1224
|
* context is changed.
|
|
1141
1225
|
*
|
|
1142
1226
|
* Default value is `true`.
|
|
1227
|
+
*
|
|
1228
|
+
* @returns Value of property `resetOnContextChange`
|
|
1143
1229
|
*/
|
|
1144
1230
|
getResetOnContextChange(): boolean;
|
|
1145
1231
|
/**
|
|
@@ -1148,10 +1234,14 @@ declare module "sap/ui/fl/variants/VariantManagement" {
|
|
|
1148
1234
|
* Indicates that Set as Default is visible in the Save View and the Manage Views dialogs.
|
|
1149
1235
|
*
|
|
1150
1236
|
* Default value is `true`.
|
|
1237
|
+
*
|
|
1238
|
+
* @returns Value of property `showSetAsDefault`
|
|
1151
1239
|
*/
|
|
1152
1240
|
getShowSetAsDefault(): boolean;
|
|
1153
1241
|
/**
|
|
1154
1242
|
* Returns the title control of the `VariantManagement`. This is used in the key user scenario.
|
|
1243
|
+
*
|
|
1244
|
+
* @returns Title part of the `VariantManagement` control.
|
|
1155
1245
|
*/
|
|
1156
1246
|
getTitle(): Title;
|
|
1157
1247
|
/**
|
|
@@ -1161,18 +1251,26 @@ declare module "sap/ui/fl/variants/VariantManagement" {
|
|
|
1161
1251
|
* `VariantManagement` control does not react in any way to this property.
|
|
1162
1252
|
*
|
|
1163
1253
|
* Default value is `false`.
|
|
1254
|
+
*
|
|
1255
|
+
* @returns Value of property `updateVariantInURL`
|
|
1164
1256
|
*/
|
|
1165
1257
|
getUpdateVariantInURL(): boolean;
|
|
1166
1258
|
/**
|
|
1167
1259
|
* Retrieves all variants.
|
|
1260
|
+
*
|
|
1261
|
+
* @returns All variants. In case the model is not yet set, an empty array will be returned.
|
|
1168
1262
|
*/
|
|
1169
1263
|
getVariants(): any[];
|
|
1170
1264
|
/**
|
|
1171
1265
|
* Removes all the controls in the association named {@link #getFor for}.
|
|
1266
|
+
*
|
|
1267
|
+
* @returns An array of the removed elements (might be empty)
|
|
1172
1268
|
*/
|
|
1173
1269
|
removeAllFor(): ID[];
|
|
1174
1270
|
/**
|
|
1175
1271
|
* Removes an for from the association named {@link #getFor for}.
|
|
1272
|
+
*
|
|
1273
|
+
* @returns The removed for or `null`
|
|
1176
1274
|
*/
|
|
1177
1275
|
removeFor(
|
|
1178
1276
|
/**
|
|
@@ -1182,6 +1280,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
|
|
|
1182
1280
|
): ID;
|
|
1183
1281
|
/**
|
|
1184
1282
|
* Sets the new selected variant.
|
|
1283
|
+
*
|
|
1284
|
+
* @returns Current instance of {@link sap.ui.fl.variants.VariantManagement}.
|
|
1185
1285
|
*/
|
|
1186
1286
|
setCurrentVariantKey(
|
|
1187
1287
|
/**
|
|
@@ -1203,6 +1303,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
|
|
|
1203
1303
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1204
1304
|
*
|
|
1205
1305
|
* Default value is `empty string`.
|
|
1306
|
+
*
|
|
1307
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1206
1308
|
*/
|
|
1207
1309
|
setDisplayTextForExecuteOnSelectionForStandardVariant(
|
|
1208
1310
|
/**
|
|
@@ -1219,6 +1321,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
|
|
|
1219
1321
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1220
1322
|
*
|
|
1221
1323
|
* Default value is `true`.
|
|
1324
|
+
*
|
|
1325
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1222
1326
|
*/
|
|
1223
1327
|
setEditable(
|
|
1224
1328
|
/**
|
|
@@ -1236,6 +1340,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
|
|
|
1236
1340
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1237
1341
|
*
|
|
1238
1342
|
* Default value is `false`.
|
|
1343
|
+
*
|
|
1344
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1239
1345
|
*/
|
|
1240
1346
|
setExecuteOnSelectionForStandardDefault(
|
|
1241
1347
|
/**
|
|
@@ -1252,6 +1358,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
|
|
|
1252
1358
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1253
1359
|
*
|
|
1254
1360
|
* Default value is `false`.
|
|
1361
|
+
*
|
|
1362
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1255
1363
|
*/
|
|
1256
1364
|
setInErrorState(
|
|
1257
1365
|
/**
|
|
@@ -1268,6 +1376,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
|
|
|
1268
1376
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1269
1377
|
*
|
|
1270
1378
|
* Default value is `false`.
|
|
1379
|
+
*
|
|
1380
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1271
1381
|
*/
|
|
1272
1382
|
setManualVariantKey(
|
|
1273
1383
|
/**
|
|
@@ -1282,6 +1392,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
|
|
|
1282
1392
|
* In a UI adaptation scenario, this property is not used at all, because the model name is `$FlexVariants`.
|
|
1283
1393
|
*
|
|
1284
1394
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1395
|
+
*
|
|
1396
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1285
1397
|
*/
|
|
1286
1398
|
setModelName(
|
|
1287
1399
|
/**
|
|
@@ -1298,6 +1410,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
|
|
|
1298
1410
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1299
1411
|
*
|
|
1300
1412
|
* Default value is `true`.
|
|
1413
|
+
*
|
|
1414
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1301
1415
|
*/
|
|
1302
1416
|
setResetOnContextChange(
|
|
1303
1417
|
/**
|
|
@@ -1313,6 +1427,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
|
|
|
1313
1427
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1314
1428
|
*
|
|
1315
1429
|
* Default value is `true`.
|
|
1430
|
+
*
|
|
1431
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1316
1432
|
*/
|
|
1317
1433
|
setShowSetAsDefault(
|
|
1318
1434
|
/**
|
|
@@ -1329,6 +1445,8 @@ declare module "sap/ui/fl/variants/VariantManagement" {
|
|
|
1329
1445
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1330
1446
|
*
|
|
1331
1447
|
* Default value is `false`.
|
|
1448
|
+
*
|
|
1449
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1332
1450
|
*/
|
|
1333
1451
|
setUpdateVariantInURL(
|
|
1334
1452
|
/**
|
|
@@ -1342,25 +1460,25 @@ declare module "sap/ui/fl/variants/VariantManagement" {
|
|
|
1342
1460
|
/**
|
|
1343
1461
|
* Indicates that Set as Default is visible in the Save View and the Manage Views dialogs.
|
|
1344
1462
|
*/
|
|
1345
|
-
showSetAsDefault?: boolean | PropertyBindingInfo
|
|
1463
|
+
showSetAsDefault?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
1346
1464
|
|
|
1347
1465
|
/**
|
|
1348
1466
|
* If set to `true`, the key for a vendor variant will be added manually.
|
|
1349
1467
|
* **Note:**This flag is only used internally in the app variant scenarios.
|
|
1350
1468
|
*/
|
|
1351
|
-
manualVariantKey?: boolean | PropertyBindingInfo
|
|
1469
|
+
manualVariantKey?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
1352
1470
|
|
|
1353
1471
|
/**
|
|
1354
1472
|
* Indicates that the control is in error state. If set to `true`, an error message will be displayed whenever
|
|
1355
1473
|
* the variant is opened.
|
|
1356
1474
|
*/
|
|
1357
|
-
inErrorState?: boolean | PropertyBindingInfo
|
|
1475
|
+
inErrorState?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
1358
1476
|
|
|
1359
1477
|
/**
|
|
1360
1478
|
* Indicates that the control is in edit state. If set to `false`, the footer of the Views list will
|
|
1361
1479
|
* be hidden.
|
|
1362
1480
|
*/
|
|
1363
|
-
editable?: boolean | PropertyBindingInfo
|
|
1481
|
+
editable?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
1364
1482
|
|
|
1365
1483
|
/**
|
|
1366
1484
|
* Determines the name of the model. The binding context will be defined by the current ID. **Note:**
|
|
@@ -1372,20 +1490,23 @@ declare module "sap/ui/fl/variants/VariantManagement" {
|
|
|
1372
1490
|
* Determines the intention of setting the current variant based on passed information. **Note:** The
|
|
1373
1491
|
* `VariantManagement` control does not react in any way to this property.
|
|
1374
1492
|
*/
|
|
1375
|
-
updateVariantInURL?: boolean | PropertyBindingInfo
|
|
1493
|
+
updateVariantInURL?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
1376
1494
|
|
|
1377
1495
|
/**
|
|
1378
1496
|
* When set to false, doesn't reset the `VariantManagement` control to the default variant, when its binding
|
|
1379
1497
|
* context is changed.
|
|
1380
1498
|
*/
|
|
1381
|
-
resetOnContextChange?: boolean | PropertyBindingInfo
|
|
1499
|
+
resetOnContextChange?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
1382
1500
|
|
|
1383
1501
|
/**
|
|
1384
1502
|
* @SINCE 1.80
|
|
1385
1503
|
*
|
|
1386
1504
|
* Determines the behavior for Apply Automatically if the standard variant is marked as the default variant.
|
|
1387
1505
|
*/
|
|
1388
|
-
executeOnSelectionForStandardDefault?:
|
|
1506
|
+
executeOnSelectionForStandardDefault?:
|
|
1507
|
+
| boolean
|
|
1508
|
+
| PropertyBindingInfo
|
|
1509
|
+
| `{${string}}`;
|
|
1389
1510
|
|
|
1390
1511
|
/**
|
|
1391
1512
|
* @SINCE 1.85
|
|
@@ -1448,6 +1569,8 @@ declare module "sap/ui/fl/write/_internal/fieldExtensibility/ABAPExtensibilityVa
|
|
|
1448
1569
|
* with name `sClassName` and enriches it with the information contained in `oClassInfo`.
|
|
1449
1570
|
*
|
|
1450
1571
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
|
|
1572
|
+
*
|
|
1573
|
+
* @returns Created class / constructor function
|
|
1451
1574
|
*/
|
|
1452
1575
|
extend(
|
|
1453
1576
|
/**
|
|
@@ -1466,6 +1589,8 @@ declare module "sap/ui/fl/write/_internal/fieldExtensibility/ABAPExtensibilityVa
|
|
|
1466
1589
|
): Function;
|
|
1467
1590
|
/**
|
|
1468
1591
|
* Returns a metadata object for class sap.ui.fl.write._internal.fieldExtensibility.ABAPExtensibilityVariant.
|
|
1592
|
+
*
|
|
1593
|
+
* @returns Metadata object describing this class
|
|
1469
1594
|
*/
|
|
1470
1595
|
getMetadata(): Metadata;
|
|
1471
1596
|
}
|
|
@@ -1487,6 +1612,8 @@ declare module "sap/ui/fl/write/_internal/fieldExtensibility/MultiTenantABAPExte
|
|
|
1487
1612
|
* with name `sClassName` and enriches it with the information contained in `oClassInfo`.
|
|
1488
1613
|
*
|
|
1489
1614
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.fl.write._internal.fieldExtensibility.ABAPExtensibilityVariant.extend}.
|
|
1615
|
+
*
|
|
1616
|
+
* @returns Created class / constructor function
|
|
1490
1617
|
*/
|
|
1491
1618
|
extend(
|
|
1492
1619
|
/**
|
|
@@ -1505,6 +1632,8 @@ declare module "sap/ui/fl/write/_internal/fieldExtensibility/MultiTenantABAPExte
|
|
|
1505
1632
|
): Function;
|
|
1506
1633
|
/**
|
|
1507
1634
|
* Returns a metadata object for class sap.ui.fl.write._internal.fieldExtensibility.MultiTenantABAPExtensibilityVariant.
|
|
1635
|
+
*
|
|
1636
|
+
* @returns Metadata object describing this class
|
|
1508
1637
|
*/
|
|
1509
1638
|
getMetadata(): Metadata;
|
|
1510
1639
|
}
|
|
@@ -1526,6 +1655,8 @@ declare module "sap/ui/fl/write/_internal/fieldExtensibility/SingleTenantABAPExt
|
|
|
1526
1655
|
* with name `sClassName` and enriches it with the information contained in `oClassInfo`.
|
|
1527
1656
|
*
|
|
1528
1657
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.fl.write._internal.fieldExtensibility.ABAPExtensibilityVariant.extend}.
|
|
1658
|
+
*
|
|
1659
|
+
* @returns Created class / constructor function
|
|
1529
1660
|
*/
|
|
1530
1661
|
extend(
|
|
1531
1662
|
/**
|
|
@@ -1544,6 +1675,8 @@ declare module "sap/ui/fl/write/_internal/fieldExtensibility/SingleTenantABAPExt
|
|
|
1544
1675
|
): Function;
|
|
1545
1676
|
/**
|
|
1546
1677
|
* Returns a metadata object for class sap.ui.fl.write._internal.fieldExtensibility.SingleTenantABAPExtensibilityVariant.
|
|
1678
|
+
*
|
|
1679
|
+
* @returns Metadata object describing this class
|
|
1547
1680
|
*/
|
|
1548
1681
|
getMetadata(): Metadata;
|
|
1549
1682
|
}
|
|
@@ -1573,6 +1706,8 @@ declare module "sap/ui/fl/write/api/FeaturesAPI" {
|
|
|
1573
1706
|
interface FeaturesAPI {
|
|
1574
1707
|
/**
|
|
1575
1708
|
* Checks if context sharing is enabled.
|
|
1709
|
+
*
|
|
1710
|
+
* @returns Resolves to a boolean indicating if context sharing is enabled
|
|
1576
1711
|
*/
|
|
1577
1712
|
isContextSharingEnabled(
|
|
1578
1713
|
/**
|
|
@@ -1584,10 +1719,14 @@ declare module "sap/ui/fl/write/api/FeaturesAPI" {
|
|
|
1584
1719
|
* Checks if key user rights are available for the current user. Application developers can use this API
|
|
1585
1720
|
* to decide if the key user adaptation feature should be visible to the current user. This only applies
|
|
1586
1721
|
* if key user adaptation should be handled standalone without an SAP Fiori launchpad.
|
|
1722
|
+
*
|
|
1723
|
+
* @returns Resolves to a boolean indicating if key user is available
|
|
1587
1724
|
*/
|
|
1588
1725
|
isKeyUser(): Promise<boolean>;
|
|
1589
1726
|
/**
|
|
1590
1727
|
* Checks if key user has also the admin role to enable the translation button
|
|
1728
|
+
*
|
|
1729
|
+
* @returns Resolves to a boolean indicating if the key user is also an admin
|
|
1591
1730
|
*/
|
|
1592
1731
|
isKeyUserTranslationEnabled(
|
|
1593
1732
|
/**
|
|
@@ -1597,6 +1736,8 @@ declare module "sap/ui/fl/write/api/FeaturesAPI" {
|
|
|
1597
1736
|
): Promise<boolean>;
|
|
1598
1737
|
/**
|
|
1599
1738
|
* Checks if the data storing implementation for a given layer is capable of handling versioning.
|
|
1739
|
+
*
|
|
1740
|
+
* @returns Resolves to a boolean indicating if versioning is enabled
|
|
1600
1741
|
*/
|
|
1601
1742
|
isVersioningEnabled(
|
|
1602
1743
|
/**
|