@openui5/ts-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 namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.1
1
+ // For Library Version: 1.120.3
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -3529,6 +3529,7 @@ declare namespace sap {
3529
3529
  oListener?: object
3530
3530
  ): this;
3531
3531
  /**
3532
+ * @deprecated (since 1.120.0)
3532
3533
  * @experimental (since 1.97)
3533
3534
  *
3534
3535
  * This function is called when a CSRF token has expired.
@@ -3542,6 +3543,7 @@ declare namespace sap {
3542
3543
  }
3543
3544
  ): void;
3544
3545
  /**
3546
+ * @deprecated (since 1.120.0)
3545
3547
  * @experimental (since 1.97)
3546
3548
  *
3547
3549
  * This function is called when a CSRF token is fetched.
@@ -3781,7 +3783,9 @@ declare namespace sap {
3781
3783
  sPath: string
3782
3784
  ): Promise<null>;
3783
3785
  /**
3786
+ * @deprecated (since 1.120.0)
3784
3787
  * @experimental (since 1.97)
3788
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
3785
3789
  *
3786
3790
  * Resolves the CSRF token and returns a Promise with its value.
3787
3791
  *
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.1
1
+ // For Library Version: 1.120.3
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -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";
@@ -36,7 +36,7 @@ declare module "sap/ui/mdc/AggregationBaseDelegate" {
36
36
  /**
37
37
  * Instance of an `sap.ui.mdc.Control`
38
38
  */
39
- oControl: sap.ui.mdc.Control,
39
+ oControl: sap.ui.mdc.Control | Element,
40
40
  /**
41
41
  * The name of the property info object/JSON
42
42
  */
@@ -46,19 +46,6 @@ declare module "sap/ui/mdc/AggregationBaseDelegate" {
46
46
  */
47
47
  mPropertyBag?: Object
48
48
  ): Promise<any>;
49
- /**
50
- * A validator to evaluate the state of an MDC control.
51
- */
52
- determineValidationState(
53
- /**
54
- * Instance of a MDC control
55
- */
56
- oControl: sap.ui.mdc.Control,
57
- /**
58
- * Object Describing the validation result
59
- */
60
- mValidation?: Record<string, any>
61
- ): void;
62
49
  /**
63
50
  * Retrieves the relevant metadata for a given payload and returns the property info array.
64
51
  *
@@ -76,9 +63,9 @@ declare module "sap/ui/mdc/AggregationBaseDelegate" {
76
63
  */
77
64
  onAfterXMLChangeProcessing(
78
65
  /**
79
- * Instance of an MDC control
66
+ * XML node of a mdc control
80
67
  */
81
- oControl: Record<string, sap.ui.mdc.Control>,
68
+ oControl: Element,
82
69
  /**
83
70
  * Property bag from SAPUI5 flexibility
84
71
  */
@@ -97,9 +84,9 @@ declare module "sap/ui/mdc/AggregationBaseDelegate" {
97
84
  */
98
85
  removeItem(
99
86
  /**
100
- * Instance of an `sap.ui.mdc.Control`
87
+ * Instance of a `sap.ui.mdc.Control`
101
88
  */
102
- oControl: sap.ui.mdc.Control,
89
+ oControl: sap.ui.mdc.Control | Element,
103
90
  /**
104
91
  * The control instance that was removed
105
92
  */
@@ -109,34 +96,6 @@ declare module "sap/ui/mdc/AggregationBaseDelegate" {
109
96
  */
110
97
  mPropertyBag?: Object
111
98
  ): Promise<any>;
112
- /**
113
- * A validator to evaluate the theoretical control state.
114
- *
115
- * @returns An object that must contain at least the `validation` attribute {@link sap.ui.core.MessageType MessageType}.
116
- * If `warning` or `error` state types have been provided, the `message` is shown in addition.
117
- */
118
- validateState(
119
- /**
120
- * Instance of an `sap.ui.mdc.Control`
121
- */
122
- oControl: sap.ui.mdc.Control,
123
- /**
124
- * The theoretical external state representation of an MDC control. The representation of this format is
125
- * similar as processed by {@link sap.ui.mdc.p13n.StateUtil StateUtil}
126
- */
127
- oState: Object
128
- ): Object;
129
- /**
130
- * Visualizes the validation state of an MDC control.
131
- *
132
- * @returns mValidation Describes the validation result.
133
- */
134
- visualizeValidationState(
135
- /**
136
- * Instance of a MDC control
137
- */
138
- oControl: Record<string, sap.ui.mdc.Control>
139
- ): Record<string, any>;
140
99
  }
141
100
  const AggregationBaseDelegate: AggregationBaseDelegate;
142
101
  export default AggregationBaseDelegate;
@@ -1028,6 +987,173 @@ declare module "sap/ui/mdc/field/FieldBaseDelegate" {
1028
987
  export default FieldBaseDelegate;
1029
988
  }
1030
989
 
990
+ declare module "sap/ui/mdc/FilterBarDelegate" {
991
+ import AggregationBaseDelegate from "sap/ui/mdc/AggregationBaseDelegate";
992
+
993
+ /**
994
+ * @since 1.61.0
995
+ *
996
+ * Base Delegate for {@link sap.ui.mdc.FilterBar FilterBar}. Extend this object in your project to use all
997
+ * functionalities of the {@link sap.ui.mdc.FilterBar FilterBar}. This class provides method calls, which
998
+ * are called by the `FilterBar` at specific operations and allows to overwrite an internal behaviour..
999
+ */
1000
+ interface FilterBarDelegate extends AggregationBaseDelegate {
1001
+ /**
1002
+ * This method is called during the appliance of the add condition change. The intention is to update the
1003
+ * {@link sap.ui.mdc.FilterBarBase#setPropertyInfo propertyInfo} property.
1004
+ *
1005
+ * @returns `Promise` that is resolved once the propertyInfo property has been updated
1006
+ */
1007
+ addCondition(
1008
+ /**
1009
+ * Instance of the {@link sap.ui.mdc.FilterBar FilterBar} control
1010
+ */
1011
+ oFilterBar: sap.ui.mdc.FilterBar,
1012
+ /**
1013
+ * The name of a property
1014
+ */
1015
+ sPropertyName: string,
1016
+ /**
1017
+ * Instance of a property bag from the SAPUI5 flexibility change API
1018
+ */
1019
+ mPropertyBag: Object
1020
+ ): Promise<any>;
1021
+ /**
1022
+ * Creates an instance of a filter field control. **Note:** The `addItem` hook can be used during the processing
1023
+ * of an SAPUI5 flexibility change. Consequently the parameter `mPropertyBag` is only passed during preprocessing.
1024
+ * In runtime scenarios (such as opening a personalization dialog), this method might be called without
1025
+ * the parameter `mPropertyBag`.
1026
+ *
1027
+ * @returns `Promise` that resolves with an instance of the implementing {@link sap.ui.mdc.FilterField Control}.
1028
+ * **Note:** This method always requires a return value once it has been called. If an item for a given
1029
+ * property `sPropertyName` has already been created, it must to either return the existing instance or
1030
+ * create a new instance.
1031
+ */
1032
+ addItem(
1033
+ /**
1034
+ * Instance of the {@link sap.ui.mdc.FilterBar FilterBar} control
1035
+ */
1036
+ oFilterBar: sap.ui.mdc.FilterBar,
1037
+ /**
1038
+ * The name of the property info object/JSON
1039
+ */
1040
+ sPropertyName: string,
1041
+ /**
1042
+ * Instance of property bag from SAPUI5 flexibility change API
1043
+ */
1044
+ mPropertyBag?: Object
1045
+ ): Promise<sap.ui.mdc.FilterField>;
1046
+ /**
1047
+ * This method is called when the Clear button is pressed.
1048
+ *
1049
+ * @returns `Promise` that is resolved once the action has been completed
1050
+ */
1051
+ clearFilters(
1052
+ /**
1053
+ * Instance of the {@link sap.ui.mdc.FilterBar FilterBar} control
1054
+ */
1055
+ oFilterBar: sap.ui.mdc.FilterBar
1056
+ ): Promise<any>;
1057
+ /**
1058
+ * A validator to evaluate the `FilterBar` state.
1059
+ *
1060
+ * @returns The inner `FilterBar` state
1061
+ */
1062
+ determineValidationState(
1063
+ /**
1064
+ * Instance of the {@link sap.ui.mdc.FilterBar FilterBar} control
1065
+ */
1066
+ oFilterBar: sap.ui.mdc.FilterBar,
1067
+ /**
1068
+ * Object describing the validation result. This object is only provided when called from the {@link sap.ui.mdc.FilterBar FilterBar}
1069
+ */
1070
+ mValidation?: {
1071
+ /**
1072
+ * Status of the validation {@link sap.ui.mdc.enums.FilterBarValidationStatus}
1073
+ */
1074
+ status?: string;
1075
+ }
1076
+ ): sap.ui.mdc.enums.FilterBarValidationStatus;
1077
+ /**
1078
+ * Retrieves the relevant metadata for a given payload and returns the property info array.
1079
+ *
1080
+ * @returns `Promise` that resolves into an array of property info objects
1081
+ */
1082
+ fetchProperties(
1083
+ /**
1084
+ * Instance of the {@link sap.ui.mdc.FilterBar FilterBar} control
1085
+ */
1086
+ oFilterBar: sap.ui.mdc.FilterBar
1087
+ ): Promise<sap.ui.mdc.filterbar.PropertyInfo[]>;
1088
+ /**
1089
+ * propertyInfo This method is called during the appliance of the remove condition change. The intention
1090
+ * is to update the {@link sap.ui.mdc.FilterBarBase#setPropertyInfo propertyInfo} property.
1091
+ *
1092
+ * @returns `Promise` that is resolved once the {@link sap.ui.mdc.FilterBarBase#setPropertyInfo propertyInfo }
1093
+ * property has been updated
1094
+ */
1095
+ removeCondition(
1096
+ /**
1097
+ * Instance of the {@link sap.ui.mdc.FilterBar FilterBar} control
1098
+ */
1099
+ oFilterBar: sap.ui.mdc.FilterBar,
1100
+ /**
1101
+ * The name of a property
1102
+ */
1103
+ sPropertyName: string,
1104
+ /**
1105
+ * Instance of a property bag from the SAPUI5 flexibility change API
1106
+ */
1107
+ mPropertyBag: Object
1108
+ ): Promise<any>;
1109
+ /**
1110
+ * Triggers any necessary follow-up steps that need to be taken after the removal of created items via `removeItem`.
1111
+ * The returned Boolean value inside the `Promise` can be used to prevent the default follow-up behavior
1112
+ * of the SAPUI5 flexibility handling.
1113
+ *
1114
+ * **Note:**The `removeItem` hook can be used during the processing of an SAPUI5 flexibility change. Consequently
1115
+ * the parameter `mPropertyBag` is only passed during preprocessing. In runtime scenarios (such as opening
1116
+ * a personalization dialog), this method can be called without the parameter `mPropertyBag`.
1117
+ *
1118
+ * @returns `Promise` that resolved with `true`, `false` to allow/prevent default behavior of the change
1119
+ */
1120
+ removeItem(
1121
+ /**
1122
+ * Instance of the {@link sap.ui.mdc.FilterBar FilterBar} control
1123
+ */
1124
+ oFilterBar: sap.ui.mdc.FilterBar,
1125
+ /**
1126
+ * The filter field instance that was removed
1127
+ */
1128
+ oFilterField: sap.ui.mdc.FilterField,
1129
+ /**
1130
+ * Instance of property bag from SAPUI5 flexibility
1131
+ */
1132
+ mPropertyBag?: Object
1133
+ ): Promise<boolean>;
1134
+ /**
1135
+ * Visualizes the `FilterBar` validation state.
1136
+ */
1137
+ visualizeValidationState(
1138
+ /**
1139
+ * Instance of the {@link sap.ui.mdc.FilterBar FilterBar} control
1140
+ */
1141
+ oFilterBar: sap.ui.mdc.FilterBar,
1142
+ /**
1143
+ * Describes the validation result. This object is only provided when called from the {@link sap.ui.mdc.FilterBar FilterBar}
1144
+ */
1145
+ mValidation: {
1146
+ /**
1147
+ * Status of the validation as returned via {@link sap.ui.mdc.filterbar.FilterBarBase#checkValidationState checkValidationState}
1148
+ */
1149
+ status: sap.ui.mdc.enums.FilterBarValidationStatus;
1150
+ }
1151
+ ): void;
1152
+ }
1153
+ const FilterBarDelegate: FilterBarDelegate;
1154
+ export default FilterBarDelegate;
1155
+ }
1156
+
1031
1157
  declare module "sap/ui/mdc/LinkDelegate" {
1032
1158
  import BaseDelegate from "sap/ui/mdc/BaseDelegate";
1033
1159
 
@@ -8820,6 +8946,8 @@ declare namespace sap {
8820
8946
  interface $FilterableListContentSettings
8821
8947
  extends sap.ui.mdc.valuehelp.base.$ListContentSettings {
8822
8948
  /**
8949
+ * @deprecated (since 1.120.2) - replaced in future version by {@link sap.ui.mdc.ValueHelpDelegate.isSearchSupported isSearchSupported}
8950
+ *
8823
8951
  * The fields based on which the table data is filtered. For filtering, the value of the `filterValue` property
8824
8952
  * is used.
8825
8953
  *
@@ -11236,6 +11364,8 @@ declare namespace sap {
11236
11364
  */
11237
11365
  getFilterBar(): sap.ui.mdc.filterbar.vh.FilterBar;
11238
11366
  /**
11367
+ * @deprecated (since 1.120.2) - replaced in future version by {@link sap.ui.mdc.ValueHelpDelegate.isSearchSupported isSearchSupported}
11368
+ *
11239
11369
  * Gets current value of property {@link #getFilterFields filterFields}.
11240
11370
  *
11241
11371
  * The fields based on which the table data is filtered. For filtering, the value of the `filterValue` property
@@ -11343,6 +11473,8 @@ declare namespace sap {
11343
11473
  oFilterBar: sap.ui.mdc.filterbar.vh.FilterBar
11344
11474
  ): this;
11345
11475
  /**
11476
+ * @deprecated (since 1.120.2) - replaced in future version by {@link sap.ui.mdc.ValueHelpDelegate.isSearchSupported isSearchSupported}
11477
+ *
11346
11478
  * Sets a new value for property {@link #getFilterFields filterFields}.
11347
11479
  *
11348
11480
  * The fields based on which the table data is filtered. For filtering, the value of the `filterValue` property
@@ -24038,6 +24170,8 @@ declare namespace sap {
24038
24170
 
24039
24171
  "sap/ui/mdc/filterbar/vh/FilterBar": undefined;
24040
24172
 
24173
+ "sap/ui/mdc/FilterBarDelegate": undefined;
24174
+
24041
24175
  "sap/ui/mdc/FilterField": undefined;
24042
24176
 
24043
24177
  "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
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.1
1
+ // For Library Version: 1.120.3
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.1
1
+ // For Library Version: 1.120.3
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.1
1
+ // For Library Version: 1.120.3
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -156,6 +156,18 @@ declare namespace sap {
156
156
  */
157
157
  FNMetaImpl?: Function
158
158
  ): Function;
159
+ /**
160
+ * Searches a plugin of the corresponding type in the aggregations of the given `Table` instance. The first
161
+ * plugin that is found is returned.
162
+ *
163
+ * @returns The found plugin instance or `undefined` if not found
164
+ */
165
+ static findOn(
166
+ /**
167
+ * The `Table` instance to check for
168
+ */
169
+ oTable: sap.ui.table.Table
170
+ ): sap.ui.core.Element | undefined;
159
171
  /**
160
172
  * Returns a metadata object for class sap.ui.table.plugins.MultiSelectionPlugin.
161
173
  *
@@ -546,6 +558,18 @@ declare namespace sap {
546
558
  */
547
559
  FNMetaImpl?: Function
548
560
  ): Function;
561
+ /**
562
+ * Searches a plugin of the corresponding type in the aggregations of the given `Table` instance. The first
563
+ * plugin that is found is returned.
564
+ *
565
+ * @returns The found plugin instance or `undefined` if not found
566
+ */
567
+ static findOn(
568
+ /**
569
+ * The `Table` instance to check for
570
+ */
571
+ oTable: sap.ui.table.Table
572
+ ): sap.ui.core.Element | undefined;
549
573
  /**
550
574
  * Returns a metadata object for class sap.ui.table.plugins.SelectionPlugin.
551
575
  *
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.1
1
+ // For Library Version: 1.120.3
2
2
 
3
3
  declare namespace sap {
4
4
  interface IUI5DefineDependencyNames {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.1
1
+ // For Library Version: 1.120.3
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.1
1
+ // For Library Version: 1.120.3
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.1
1
+ // For Library Version: 1.120.3
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.1
1
+ // For Library Version: 1.120.3
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.1
1
+ // For Library Version: 1.120.3
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.1
1
+ // For Library Version: 1.120.3
2
2
 
3
3
  declare namespace sap {
4
4
  /**