@openui5/types 1.120.1 → 1.120.3

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.120.1
1
+ // For Library Version: 1.120.3
2
2
 
3
3
  declare namespace sap {}
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.1
1
+ // For Library Version: 1.120.3
2
2
 
3
3
  declare module "sap/ui/fl/library" {}
4
4
 
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.1
1
+ // For Library Version: 1.120.3
2
2
 
3
3
  declare module "sap/ui/integration/library" {
4
4
  import { URI } from "sap/ui/core/library";
@@ -3737,6 +3737,7 @@ declare module "sap/ui/integration/Host" {
3737
3737
  oListener?: object
3738
3738
  ): this;
3739
3739
  /**
3740
+ * @deprecated (since 1.120.0)
3740
3741
  * @experimental (since 1.97)
3741
3742
  *
3742
3743
  * This function is called when a CSRF token has expired.
@@ -3750,6 +3751,7 @@ declare module "sap/ui/integration/Host" {
3750
3751
  }
3751
3752
  ): void;
3752
3753
  /**
3754
+ * @deprecated (since 1.120.0)
3753
3755
  * @experimental (since 1.97)
3754
3756
  *
3755
3757
  * This function is called when a CSRF token is fetched.
@@ -3989,7 +3991,9 @@ declare module "sap/ui/integration/Host" {
3989
3991
  sPath: string
3990
3992
  ): Promise<null>;
3991
3993
  /**
3994
+ * @deprecated (since 1.120.0)
3992
3995
  * @experimental (since 1.97)
3996
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
3993
3997
  *
3994
3998
  * Resolves the CSRF token and returns a Promise with its value.
3995
3999
  *
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.1
1
+ // For Library Version: 1.120.3
2
2
 
3
3
  declare module "sap/ui/layout/library" {
4
4
  import Control from "sap/ui/core/Control";
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.1
1
+ // For Library Version: 1.120.3
2
2
 
3
3
  declare module "sap/ui/mdc/AggregationBaseDelegate" {
4
4
  import BaseDelegate from "sap/ui/mdc/BaseDelegate";
@@ -40,7 +40,7 @@ declare module "sap/ui/mdc/AggregationBaseDelegate" {
40
40
  /**
41
41
  * Instance of an `sap.ui.mdc.Control`
42
42
  */
43
- oControl: Control,
43
+ oControl: Control | Element,
44
44
  /**
45
45
  * The name of the property info object/JSON
46
46
  */
@@ -50,19 +50,6 @@ declare module "sap/ui/mdc/AggregationBaseDelegate" {
50
50
  */
51
51
  mPropertyBag?: Object
52
52
  ): Promise<any>;
53
- /**
54
- * A validator to evaluate the state of an MDC control.
55
- */
56
- determineValidationState(
57
- /**
58
- * Instance of a MDC control
59
- */
60
- oControl: Control,
61
- /**
62
- * Object Describing the validation result
63
- */
64
- mValidation?: Record<string, any>
65
- ): void;
66
53
  /**
67
54
  * Retrieves the relevant metadata for a given payload and returns the property info array.
68
55
  *
@@ -80,9 +67,9 @@ declare module "sap/ui/mdc/AggregationBaseDelegate" {
80
67
  */
81
68
  onAfterXMLChangeProcessing(
82
69
  /**
83
- * Instance of an MDC control
70
+ * XML node of a mdc control
84
71
  */
85
- oControl: Record<string, Control>,
72
+ oControl: Element,
86
73
  /**
87
74
  * Property bag from SAPUI5 flexibility
88
75
  */
@@ -101,9 +88,9 @@ declare module "sap/ui/mdc/AggregationBaseDelegate" {
101
88
  */
102
89
  removeItem(
103
90
  /**
104
- * Instance of an `sap.ui.mdc.Control`
91
+ * Instance of a `sap.ui.mdc.Control`
105
92
  */
106
- oControl: Control,
93
+ oControl: Control | Element,
107
94
  /**
108
95
  * The control instance that was removed
109
96
  */
@@ -113,34 +100,6 @@ declare module "sap/ui/mdc/AggregationBaseDelegate" {
113
100
  */
114
101
  mPropertyBag?: Object
115
102
  ): Promise<any>;
116
- /**
117
- * A validator to evaluate the theoretical control state.
118
- *
119
- * @returns An object that must contain at least the `validation` attribute {@link sap.ui.core.MessageType MessageType}.
120
- * If `warning` or `error` state types have been provided, the `message` is shown in addition.
121
- */
122
- validateState(
123
- /**
124
- * Instance of an `sap.ui.mdc.Control`
125
- */
126
- oControl: Control,
127
- /**
128
- * The theoretical external state representation of an MDC control. The representation of this format is
129
- * similar as processed by {@link sap.ui.mdc.p13n.StateUtil StateUtil}
130
- */
131
- oState: Object
132
- ): Object;
133
- /**
134
- * Visualizes the validation state of an MDC control.
135
- *
136
- * @returns mValidation Describes the validation result.
137
- */
138
- visualizeValidationState(
139
- /**
140
- * Instance of a MDC control
141
- */
142
- oControl: Record<string, Control>
143
- ): Record<string, any>;
144
103
  }
145
104
  const AggregationBaseDelegate: AggregationBaseDelegate;
146
105
  export default AggregationBaseDelegate;
@@ -1144,6 +1103,179 @@ declare module "sap/ui/mdc/field/FieldBaseDelegate" {
1144
1103
  };
1145
1104
  }
1146
1105
 
1106
+ declare module "sap/ui/mdc/FilterBarDelegate" {
1107
+ import AggregationBaseDelegate from "sap/ui/mdc/AggregationBaseDelegate";
1108
+
1109
+ import { default as FilterBar, PropertyInfo } from "sap/ui/mdc/FilterBar";
1110
+
1111
+ import FilterField from "sap/ui/mdc/FilterField";
1112
+
1113
+ import FilterBarValidationStatus from "sap/ui/mdc/enums/FilterBarValidationStatus";
1114
+
1115
+ /**
1116
+ * @since 1.61.0
1117
+ *
1118
+ * Base Delegate for {@link sap.ui.mdc.FilterBar FilterBar}. Extend this object in your project to use all
1119
+ * functionalities of the {@link sap.ui.mdc.FilterBar FilterBar}. This class provides method calls, which
1120
+ * are called by the `FilterBar` at specific operations and allows to overwrite an internal behaviour..
1121
+ */
1122
+ interface FilterBarDelegate extends AggregationBaseDelegate {
1123
+ /**
1124
+ * This method is called during the appliance of the add condition change. The intention is to update the
1125
+ * {@link sap.ui.mdc.FilterBarBase#setPropertyInfo propertyInfo} property.
1126
+ *
1127
+ * @returns `Promise` that is resolved once the propertyInfo property has been updated
1128
+ */
1129
+ addCondition(
1130
+ /**
1131
+ * Instance of the {@link sap.ui.mdc.FilterBar FilterBar} control
1132
+ */
1133
+ oFilterBar: FilterBar,
1134
+ /**
1135
+ * The name of a property
1136
+ */
1137
+ sPropertyName: string,
1138
+ /**
1139
+ * Instance of a property bag from the SAPUI5 flexibility change API
1140
+ */
1141
+ mPropertyBag: Object
1142
+ ): Promise<any>;
1143
+ /**
1144
+ * Creates an instance of a filter field control. **Note:** The `addItem` hook can be used during the processing
1145
+ * of an SAPUI5 flexibility change. Consequently the parameter `mPropertyBag` is only passed during preprocessing.
1146
+ * In runtime scenarios (such as opening a personalization dialog), this method might be called without
1147
+ * the parameter `mPropertyBag`.
1148
+ *
1149
+ * @returns `Promise` that resolves with an instance of the implementing {@link sap.ui.mdc.FilterField Control}.
1150
+ * **Note:** This method always requires a return value once it has been called. If an item for a given
1151
+ * property `sPropertyName` has already been created, it must to either return the existing instance or
1152
+ * create a new instance.
1153
+ */
1154
+ addItem(
1155
+ /**
1156
+ * Instance of the {@link sap.ui.mdc.FilterBar FilterBar} control
1157
+ */
1158
+ oFilterBar: FilterBar,
1159
+ /**
1160
+ * The name of the property info object/JSON
1161
+ */
1162
+ sPropertyName: string,
1163
+ /**
1164
+ * Instance of property bag from SAPUI5 flexibility change API
1165
+ */
1166
+ mPropertyBag?: Object
1167
+ ): Promise<FilterField>;
1168
+ /**
1169
+ * This method is called when the Clear button is pressed.
1170
+ *
1171
+ * @returns `Promise` that is resolved once the action has been completed
1172
+ */
1173
+ clearFilters(
1174
+ /**
1175
+ * Instance of the {@link sap.ui.mdc.FilterBar FilterBar} control
1176
+ */
1177
+ oFilterBar: FilterBar
1178
+ ): Promise<any>;
1179
+ /**
1180
+ * A validator to evaluate the `FilterBar` state.
1181
+ *
1182
+ * @returns The inner `FilterBar` state
1183
+ */
1184
+ determineValidationState(
1185
+ /**
1186
+ * Instance of the {@link sap.ui.mdc.FilterBar FilterBar} control
1187
+ */
1188
+ oFilterBar: FilterBar,
1189
+ /**
1190
+ * Object describing the validation result. This object is only provided when called from the {@link sap.ui.mdc.FilterBar FilterBar}
1191
+ */
1192
+ mValidation?: {
1193
+ /**
1194
+ * Status of the validation {@link sap.ui.mdc.enums.FilterBarValidationStatus}
1195
+ */
1196
+ status?: string;
1197
+ }
1198
+ ): FilterBarValidationStatus;
1199
+ /**
1200
+ * Retrieves the relevant metadata for a given payload and returns the property info array.
1201
+ *
1202
+ * @returns `Promise` that resolves into an array of property info objects
1203
+ */
1204
+ fetchProperties(
1205
+ /**
1206
+ * Instance of the {@link sap.ui.mdc.FilterBar FilterBar} control
1207
+ */
1208
+ oFilterBar: FilterBar
1209
+ ): Promise<PropertyInfo[]>;
1210
+ /**
1211
+ * propertyInfo This method is called during the appliance of the remove condition change. The intention
1212
+ * is to update the {@link sap.ui.mdc.FilterBarBase#setPropertyInfo propertyInfo} property.
1213
+ *
1214
+ * @returns `Promise` that is resolved once the {@link sap.ui.mdc.FilterBarBase#setPropertyInfo propertyInfo }
1215
+ * property has been updated
1216
+ */
1217
+ removeCondition(
1218
+ /**
1219
+ * Instance of the {@link sap.ui.mdc.FilterBar FilterBar} control
1220
+ */
1221
+ oFilterBar: FilterBar,
1222
+ /**
1223
+ * The name of a property
1224
+ */
1225
+ sPropertyName: string,
1226
+ /**
1227
+ * Instance of a property bag from the SAPUI5 flexibility change API
1228
+ */
1229
+ mPropertyBag: Object
1230
+ ): Promise<any>;
1231
+ /**
1232
+ * Triggers any necessary follow-up steps that need to be taken after the removal of created items via `removeItem`.
1233
+ * The returned Boolean value inside the `Promise` can be used to prevent the default follow-up behavior
1234
+ * of the SAPUI5 flexibility handling.
1235
+ *
1236
+ * **Note:**The `removeItem` hook can be used during the processing of an SAPUI5 flexibility change. Consequently
1237
+ * the parameter `mPropertyBag` is only passed during preprocessing. In runtime scenarios (such as opening
1238
+ * a personalization dialog), this method can be called without the parameter `mPropertyBag`.
1239
+ *
1240
+ * @returns `Promise` that resolved with `true`, `false` to allow/prevent default behavior of the change
1241
+ */
1242
+ removeItem(
1243
+ /**
1244
+ * Instance of the {@link sap.ui.mdc.FilterBar FilterBar} control
1245
+ */
1246
+ oFilterBar: FilterBar,
1247
+ /**
1248
+ * The filter field instance that was removed
1249
+ */
1250
+ oFilterField: FilterField,
1251
+ /**
1252
+ * Instance of property bag from SAPUI5 flexibility
1253
+ */
1254
+ mPropertyBag?: Object
1255
+ ): Promise<boolean>;
1256
+ /**
1257
+ * Visualizes the `FilterBar` validation state.
1258
+ */
1259
+ visualizeValidationState(
1260
+ /**
1261
+ * Instance of the {@link sap.ui.mdc.FilterBar FilterBar} control
1262
+ */
1263
+ oFilterBar: FilterBar,
1264
+ /**
1265
+ * Describes the validation result. This object is only provided when called from the {@link sap.ui.mdc.FilterBar FilterBar}
1266
+ */
1267
+ mValidation: {
1268
+ /**
1269
+ * Status of the validation as returned via {@link sap.ui.mdc.filterbar.FilterBarBase#checkValidationState checkValidationState}
1270
+ */
1271
+ status: FilterBarValidationStatus;
1272
+ }
1273
+ ): void;
1274
+ }
1275
+ const FilterBarDelegate: FilterBarDelegate;
1276
+ export default FilterBarDelegate;
1277
+ }
1278
+
1147
1279
  declare module "sap/ui/mdc/LinkDelegate" {
1148
1280
  import BaseDelegate from "sap/ui/mdc/BaseDelegate";
1149
1281
 
@@ -22519,6 +22651,8 @@ declare module "sap/ui/mdc/valuehelp/base/FilterableListContent" {
22519
22651
  */
22520
22652
  getFilterBar(): FilterBar;
22521
22653
  /**
22654
+ * @deprecated (since 1.120.2) - replaced in future version by {@link sap.ui.mdc.ValueHelpDelegate.isSearchSupported isSearchSupported}
22655
+ *
22522
22656
  * Gets current value of property {@link #getFilterFields filterFields}.
22523
22657
  *
22524
22658
  * The fields based on which the table data is filtered. For filtering, the value of the `filterValue` property
@@ -22626,6 +22760,8 @@ declare module "sap/ui/mdc/valuehelp/base/FilterableListContent" {
22626
22760
  oFilterBar: FilterBar
22627
22761
  ): this;
22628
22762
  /**
22763
+ * @deprecated (since 1.120.2) - replaced in future version by {@link sap.ui.mdc.ValueHelpDelegate.isSearchSupported isSearchSupported}
22764
+ *
22629
22765
  * Sets a new value for property {@link #getFilterFields filterFields}.
22630
22766
  *
22631
22767
  * The fields based on which the table data is filtered. For filtering, the value of the `filterValue` property
@@ -22693,6 +22829,8 @@ declare module "sap/ui/mdc/valuehelp/base/FilterableListContent" {
22693
22829
 
22694
22830
  export interface $FilterableListContentSettings extends $ListContentSettings {
22695
22831
  /**
22832
+ * @deprecated (since 1.120.2) - replaced in future version by {@link sap.ui.mdc.ValueHelpDelegate.isSearchSupported isSearchSupported}
22833
+ *
22696
22834
  * The fields based on which the table data is filtered. For filtering, the value of the `filterValue` property
22697
22835
  * is used.
22698
22836
  *
@@ -24464,6 +24602,8 @@ declare namespace sap {
24464
24602
 
24465
24603
  "sap/ui/mdc/filterbar/vh/FilterBar": undefined;
24466
24604
 
24605
+ "sap/ui/mdc/FilterBarDelegate": undefined;
24606
+
24467
24607
  "sap/ui/mdc/FilterField": undefined;
24468
24608
 
24469
24609
  "sap/ui/mdc/library": undefined;
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.1
1
+ // For Library Version: 1.120.3
2
2
 
3
3
  declare module "sap/ui/rta/api/startAdaptation" {
4
4
  import Control from "sap/ui/core/Control";
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.1
1
+ // For Library Version: 1.120.3
2
2
 
3
3
  declare module "sap/ui/suite/library" {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.1
1
+ // For Library Version: 1.120.3
2
2
 
3
3
  declare module "sap/ui/support/library" {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.1
1
+ // For Library Version: 1.120.3
2
2
 
3
3
  declare module "sap/ui/table/library" {
4
4
  import TreeAutoExpandMode1 from "sap/ui/model/TreeAutoExpandMode";
@@ -2865,6 +2865,10 @@ declare module "sap/ui/table/plugins/MultiSelectionPlugin" {
2865
2865
  SelectionPlugin$SelectionChangeEventParameters,
2866
2866
  } from "sap/ui/table/plugins/SelectionPlugin";
2867
2867
 
2868
+ import Table from "sap/ui/table/Table";
2869
+
2870
+ import UI5Element from "sap/ui/core/Element";
2871
+
2868
2872
  import ElementMetadata from "sap/ui/core/ElementMetadata";
2869
2873
 
2870
2874
  import { SelectionMode } from "sap/ui/table/library";
@@ -2923,6 +2927,18 @@ declare module "sap/ui/table/plugins/MultiSelectionPlugin" {
2923
2927
  */
2924
2928
  FNMetaImpl?: Function
2925
2929
  ): Function;
2930
+ /**
2931
+ * Searches a plugin of the corresponding type in the aggregations of the given `Table` instance. The first
2932
+ * plugin that is found is returned.
2933
+ *
2934
+ * @returns The found plugin instance or `undefined` if not found
2935
+ */
2936
+ static findOn(
2937
+ /**
2938
+ * The `Table` instance to check for
2939
+ */
2940
+ oTable: Table
2941
+ ): UI5Element | undefined;
2926
2942
  /**
2927
2943
  * Returns a metadata object for class sap.ui.table.plugins.MultiSelectionPlugin.
2928
2944
  *
@@ -3346,6 +3362,8 @@ declare module "sap/ui/table/plugins/SelectionPlugin" {
3346
3362
 
3347
3363
  import Event from "sap/ui/base/Event";
3348
3364
 
3365
+ import Table from "sap/ui/table/Table";
3366
+
3349
3367
  import ElementMetadata from "sap/ui/core/ElementMetadata";
3350
3368
 
3351
3369
  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
@@ -3394,6 +3412,18 @@ declare module "sap/ui/table/plugins/SelectionPlugin" {
3394
3412
  */
3395
3413
  FNMetaImpl?: Function
3396
3414
  ): Function;
3415
+ /**
3416
+ * Searches a plugin of the corresponding type in the aggregations of the given `Table` instance. The first
3417
+ * plugin that is found is returned.
3418
+ *
3419
+ * @returns The found plugin instance or `undefined` if not found
3420
+ */
3421
+ static findOn(
3422
+ /**
3423
+ * The `Table` instance to check for
3424
+ */
3425
+ oTable: Table
3426
+ ): UI5Element | undefined;
3397
3427
  /**
3398
3428
  * Returns a metadata object for class sap.ui.table.plugins.SelectionPlugin.
3399
3429
  *
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.1
1
+ // For Library Version: 1.120.3
2
2
 
3
3
  declare module "sap/ui/testrecorder/library" {}
4
4
 
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.1
1
+ // For Library Version: 1.120.3
2
2
 
3
3
  declare module "sap/ui/unified/library" {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.1
1
+ // For Library Version: 1.120.3
2
2
 
3
3
  declare module "sap/ui/ux3/library" {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.1
1
+ // For Library Version: 1.120.3
2
2
 
3
3
  declare module "sap/ui/webc/common/library" {}
4
4
 
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.1
1
+ // For Library Version: 1.120.3
2
2
 
3
3
  declare module "sap/ui/webc/fiori/library" {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.1
1
+ // For Library Version: 1.120.3
2
2
 
3
3
  declare module "sap/ui/webc/main/library" {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.1
1
+ // For Library Version: 1.120.3
2
2
 
3
3
  declare module "sap/uxap/library" {
4
4
  /**