@sapui5/ts-types-esm 1.139.0 → 1.140.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.
Files changed (69) hide show
  1. package/package.json +1 -1
  2. package/types/sap.apf.d.ts +1 -1
  3. package/types/sap.ca.ui.d.ts +1 -1
  4. package/types/sap.chart.d.ts +1 -1
  5. package/types/sap.collaboration.d.ts +1 -1
  6. package/types/sap.cux.home.d.ts +0 -1623
  7. package/types/sap.esh.search.ui.d.ts +1 -2297
  8. package/types/sap.f.d.ts +59 -11
  9. package/types/sap.fe.ariba.d.ts +1 -1
  10. package/types/sap.fe.base.d.ts +1 -5
  11. package/types/sap.fe.controls.d.ts +1 -1
  12. package/types/sap.fe.core.d.ts +15 -8
  13. package/types/sap.fe.ina.d.ts +1 -1
  14. package/types/sap.fe.macros.d.ts +3 -10
  15. package/types/sap.fe.navigation.d.ts +1 -1
  16. package/types/sap.fe.placeholder.d.ts +1 -1
  17. package/types/sap.fe.plugins.managecache.d.ts +1 -1
  18. package/types/sap.fe.templates.d.ts +1 -1
  19. package/types/sap.fe.test.d.ts +1 -1
  20. package/types/sap.fe.tools.d.ts +1 -1
  21. package/types/sap.feedback.ui.d.ts +1 -1
  22. package/types/sap.gantt.d.ts +41 -11
  23. package/types/sap.insights.d.ts +130 -2
  24. package/types/sap.m.d.ts +645 -274
  25. package/types/sap.makit.d.ts +1 -1
  26. package/types/sap.me.d.ts +1 -1
  27. package/types/sap.ndc.d.ts +1 -1
  28. package/types/sap.ovp.d.ts +1 -1
  29. package/types/sap.rules.ui.d.ts +1 -1
  30. package/types/sap.sac.df.d.ts +99 -1
  31. package/types/sap.suite.ui.commons.d.ts +1 -1
  32. package/types/sap.suite.ui.generic.template.d.ts +1 -1
  33. package/types/sap.suite.ui.microchart.d.ts +1 -1
  34. package/types/sap.tnt.d.ts +5 -1
  35. package/types/sap.ui.codeeditor.d.ts +1 -1
  36. package/types/sap.ui.commons.d.ts +1 -1
  37. package/types/sap.ui.comp.d.ts +16 -1
  38. package/types/sap.ui.core.d.ts +402 -97
  39. package/types/sap.ui.dt.d.ts +1 -1
  40. package/types/sap.ui.export.d.ts +1 -1
  41. package/types/sap.ui.fl.d.ts +1 -7
  42. package/types/sap.ui.generic.app.d.ts +1 -1
  43. package/types/sap.ui.generic.template.d.ts +1 -1
  44. package/types/sap.ui.integration.d.ts +13 -13
  45. package/types/sap.ui.layout.d.ts +1 -1
  46. package/types/sap.ui.mdc.d.ts +80 -28
  47. package/types/sap.ui.richtexteditor.d.ts +1 -1
  48. package/types/sap.ui.rta.d.ts +1 -1
  49. package/types/sap.ui.suite.d.ts +1 -1
  50. package/types/sap.ui.support.d.ts +1 -1
  51. package/types/sap.ui.table.d.ts +568 -1
  52. package/types/sap.ui.testrecorder.d.ts +1 -1
  53. package/types/sap.ui.unified.d.ts +1 -1
  54. package/types/sap.ui.ux3.d.ts +1 -1
  55. package/types/sap.ui.vbm.d.ts +1 -1
  56. package/types/sap.ui.vk.d.ts +307 -6
  57. package/types/sap.ui.vtm.d.ts +1 -1
  58. package/types/sap.ui.webc.common.d.ts +1 -1
  59. package/types/sap.ui.webc.fiori.d.ts +1 -1
  60. package/types/sap.ui.webc.main.d.ts +1 -1
  61. package/types/sap.uiext.inbox.d.ts +1 -1
  62. package/types/sap.ushell.d.ts +10 -6
  63. package/types/sap.ushell_abap.d.ts +3 -1
  64. package/types/sap.uxap.d.ts +1 -1
  65. package/types/sap.viz.d.ts +1 -1
  66. package/types/sap.webanalytics.core.d.ts +1 -1
  67. package/types/sap.zen.commons.d.ts +1 -1
  68. package/types/sap.zen.crosstab.d.ts +1 -1
  69. package/types/sap.zen.dsh.d.ts +1 -1
package/types/sap.m.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.139.0
1
+ // For Library Version: 1.140.0
2
2
 
3
3
  declare module "sap/f/library" {
4
4
  export interface IShellBar {
@@ -10,6 +10,353 @@ declare module "sap/f/library" {
10
10
  }
11
11
  }
12
12
 
13
+ declare module "sap/m/p13n/Engine" {
14
+ import Control from "sap/ui/core/Control";
15
+
16
+ import { FilterStateItem } from "sap/m/p13n/FilterController";
17
+
18
+ import Event from "sap/ui/base/Event";
19
+
20
+ import Metadata from "sap/ui/base/Metadata";
21
+
22
+ import Popup from "sap/m/p13n/Popup";
23
+
24
+ import MetadataHelper from "sap/m/p13n/MetadataHelper";
25
+
26
+ import SelectionController from "sap/m/p13n/SelectionController";
27
+
28
+ /**
29
+ * The personalization state change event.
30
+ *
31
+ * @since 1.140.0
32
+ */
33
+ export type Engine$StateChangeEvent = {
34
+ /**
35
+ * Control for which the state change event was fired.
36
+ */
37
+ control?: Control;
38
+ /**
39
+ * Changed (delta) state of the control. The keys of the object refer to the controller keys used in the
40
+ * `Engine` registration. The values can be an array of any of the following types:
41
+ * - {@link module:sap/m/p13n/Engine$StateChangeEventSelectionState StateChangeEventSelectionState}
42
+ * - {@link module:sap/m/p13n/Engine$StateChangeEventSortState StateChangeEventSortState}
43
+ * - {@link module:sap/m/p13n/Engine$StateChangeEventGroupState StateChangeEventGroupState}
44
+ * - {@link module:sap/m/p13n/Engine$StateChangeEventFilterState StateChangeEventFilterState}
45
+ * - Custom controller state definitions
46
+ */
47
+ state?: Record<
48
+ string,
49
+ | Engine$StateChangeEventSelectionState[]
50
+ | Engine$StateChangeEventSortState[]
51
+ | Engine$StateChangeEventGroupState[]
52
+ | Engine$StateChangeEventFilterState[]
53
+ | any[]
54
+ >;
55
+ };
56
+
57
+ /**
58
+ * The state for changes of the `FilterController`. The keys of the object are the filter keys used in the
59
+ * `Engine` registration. The values are arrays of {@link sap.ui.mdc.condition.ConditionObject ConditionObject}.
60
+ *
61
+ * @since 1.140.0
62
+ */
63
+ export type Engine$StateChangeEventFilterState = Record<
64
+ string,
65
+ FilterStateItem[]
66
+ >;
67
+
68
+ /**
69
+ * The state for changes of the `GroupController`.
70
+ *
71
+ * @since 1.140.0
72
+ */
73
+ export type Engine$StateChangeEventGroupState = {
74
+ /**
75
+ * The key of the affected group order
76
+ */
77
+ key: string;
78
+ /**
79
+ * The position of the group order
80
+ */
81
+ index: number;
82
+ };
83
+
84
+ /**
85
+ * The state for changes of the `SelectionController`.
86
+ *
87
+ * @since 1.140.0
88
+ */
89
+ export type Engine$StateChangeEventSelectionState = {
90
+ /**
91
+ * The key of the item affected
92
+ */
93
+ key: string;
94
+ };
95
+
96
+ /**
97
+ * The state for changes of the `SortController`.
98
+ *
99
+ * @since 1.140.0
100
+ */
101
+ export type Engine$StateChangeEventSortState = {
102
+ /**
103
+ * The key of the affected sort order
104
+ */
105
+ key: string;
106
+ /**
107
+ * The position of the sort order
108
+ */
109
+ index: number;
110
+ /**
111
+ * Indicates whether the sort order is descending
112
+ */
113
+ descending: boolean;
114
+ };
115
+
116
+ /**
117
+ * The `Engine` entity offers personalization capabilities by registering a control instance for modification,
118
+ * such as:
119
+ *
120
+ *
121
+ * - `sap.m.p13n.Popup` initialization
122
+ * - Storing personalization states by choosing the desired persistence layer
123
+ * - State appliance considering the persistence layer
124
+ *
125
+ * The Engine must be used whenever personalization should be enabled by taking a certain persistence layer
126
+ * into account. Available controller implementations for the registration process are:
127
+ *
128
+ *
129
+ * - {@link sap.m.p13n.SelectionController SelectionController}: Used to define a list of selectable entries
130
+ *
131
+ * - {@link sap.m.p13n.SortController SortController}: Used to define a list of sortable properties
132
+ * - {@link sap.m.p13n.GroupController GroupController}: Used to define a list of groupable properties
133
+ *
134
+ *
135
+ * Can be used in combination with `sap.ui.fl.variants.VariantManagement` to persist a state in variants
136
+ * using `sap.ui.fl` capabilities.
137
+ *
138
+ * @since 1.104
139
+ */
140
+ export default class Engine
141
+ extends /* was: sap.m.p13n.modules.AdaptationProvider */ Object
142
+ {
143
+ /**
144
+ * See:
145
+ * {@link https://ui5.sap.com/#/topic/75c08fdebf784575947927e052712bab Personalization}
146
+ */
147
+ constructor();
148
+
149
+ /**
150
+ * Creates a new subclass of class sap.m.p13n.Engine with name `sClassName` and enriches it with the information
151
+ * contained in `oClassInfo`.
152
+ *
153
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.m.p13n.modules.AdaptationProvider.extend}.
154
+ *
155
+ *
156
+ * @returns Created class / constructor function
157
+ */
158
+ static extend<T extends Record<string, unknown>>(
159
+ /**
160
+ * Name of the class being created
161
+ */
162
+ sClassName: string,
163
+ /**
164
+ * Object literal with information about the class
165
+ */
166
+ oClassInfo?: sap.ClassInfo<T, Engine>,
167
+ /**
168
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
169
+ * used by this class
170
+ */
171
+ FNMetaImpl?: Function
172
+ ): Function;
173
+ /**
174
+ * This method is the central point of access to the Engine Singleton.
175
+ *
176
+ *
177
+ * @returns The Engine instance
178
+ */
179
+ static getInstance(): Engine;
180
+ /**
181
+ * Returns a metadata object for class sap.m.p13n.Engine.
182
+ *
183
+ *
184
+ * @returns Metadata object describing this class
185
+ */
186
+ static getMetadata(): Metadata;
187
+ /**
188
+ * Applies a state to a control by passing an object that contains the registered controller key and an
189
+ * object matching the inner subcontroller logic.
190
+ *
191
+ *
192
+ * @returns A Promise resolving after the state has been applied
193
+ */
194
+ applyState(
195
+ /**
196
+ * The registered control instance
197
+ */
198
+ oControl: Control,
199
+ /**
200
+ * The state object
201
+ */
202
+ oState: State
203
+ ): Promise<State>;
204
+ /**
205
+ * Attaches an event handler to the `StateHandlerRegistry` class. The event handler is fired every time
206
+ * a user triggers a personalization change for a control instance during runtime.
207
+ *
208
+ *
209
+ * @returns Returns `this` to allow method chaining
210
+ */
211
+ attachStateChange(
212
+ /**
213
+ * The handler function to call when the event occurs
214
+ */
215
+ fnStateEventHandler: (p1: Engine$StateChangeEvent) => void,
216
+ /**
217
+ * The context object to call the event handler with (value of `this` in the event handler function).
218
+ */
219
+ oListener?: object
220
+ ): this;
221
+ /**
222
+ * Unregisters a registered control. By unregistering a control the control is removed from the `Engine`
223
+ * registry, and all instance-specific submodules, such as the registered controllers, are destroyed.
224
+ */
225
+ deregister(
226
+ /**
227
+ * The registered control instance
228
+ */
229
+ oControl: Control
230
+ ): void;
231
+ /**
232
+ * Removes a previously attached state change event handler from the `StateHandlerRegistry` class. The passed
233
+ * parameters must match those used for registration with {@link sap.m.p13n.Engine#attachStateChange} beforehand.
234
+ *
235
+ *
236
+ * @returns Returns `this` to allow method chaining
237
+ */
238
+ detachStateChange(
239
+ /**
240
+ * The handler function to detach from the event
241
+ */
242
+ fnStateEventHandler: (p1: Event) => void,
243
+ /**
244
+ * The context object to call the event handler with (value of `this` in the event handler function).
245
+ */
246
+ oListener?: object
247
+ ): this;
248
+
249
+ register(
250
+ /**
251
+ * The control instance to be registered for adaptation
252
+ */
253
+ oControl: Control,
254
+ /**
255
+ * The Engine registration configuration
256
+ */
257
+ oConfig: EngineRegistrationConfig
258
+ ): void;
259
+ /**
260
+ * This method can be used to trigger a reset to the provided control instance.
261
+ *
262
+ *
263
+ * @returns A Promise resolving once the reset is completed
264
+ */
265
+ reset(
266
+ /**
267
+ * The related control instance
268
+ */
269
+ oControl: Control,
270
+ /**
271
+ * The key for the affected configuration
272
+ */
273
+ aKeys: string
274
+ ): Promise<null>;
275
+ /**
276
+ * Retrieves the state for a given control instance after all necessary changes have been applied (e.g.
277
+ * modification handler appliance). After the returned `Promise` has been resolved, the returned state is
278
+ * in sync with the related state object of the control.
279
+ *
280
+ *
281
+ * @returns A Promise resolving in the current control state
282
+ */
283
+ retrieveState(
284
+ /**
285
+ * The control instance implementing IxState to retrieve the externalized state
286
+ */
287
+ oControl: Control
288
+ ): Promise<State>;
289
+ /**
290
+ * Opens the personalization dialog.
291
+ *
292
+ *
293
+ * @returns Promise resolving in the `sap.m.p13n.Popup` instance
294
+ */
295
+ show(
296
+ /**
297
+ * The control instance that is personalized
298
+ */
299
+ oControl: Control,
300
+ /**
301
+ * The affected panels that are added to the `sap.m.p13n.Popup`
302
+ */
303
+ vPanelKeys: string | string[],
304
+ /**
305
+ * The settings object for the personalization
306
+ */
307
+ mSettings: {
308
+ /**
309
+ * The title for the `sap.m.p13n.Popup` control
310
+ */
311
+ title?: string;
312
+ /**
313
+ * The source control to be used by the `sap.m.p13n.Popup` control (only necessary if the mode is set to
314
+ * `ResponsivePopover`)
315
+ */
316
+ source?: Control;
317
+ /**
318
+ * The mode is used by the `sap.m.p13n.Popup` control
319
+ */
320
+ mode?: object;
321
+ /**
322
+ * Height configuration for the related popup container
323
+ */
324
+ contentHeight?: object;
325
+ /**
326
+ * Width configuration for the related popup container
327
+ */
328
+ contentWidth?: object;
329
+ }
330
+ ): Promise<Popup>;
331
+ }
332
+ /**
333
+ * The central registration for personalization functionality. The registration is a precondition for using
334
+ * `Engine` functionality for a control instance. Once the control instance has been registered, it can
335
+ * be passed to the related `Engine` methods that always expect a control instance as parameter. Only registered
336
+ * control instances can be used for personalization through the `Engine`.
337
+ */
338
+ export type EngineRegistrationConfig = {
339
+ /**
340
+ * The `{@link sap.m.p13n.MetadataHelper MetadataHelper}` to provide metadata-specific information. It may
341
+ * be used to define more granular information for the selection of items.
342
+ */
343
+ helper: MetadataHelper;
344
+ /**
345
+ * A map of arbitrary keys that contain a controller instance as value. The key must be unique and needs
346
+ * to be provided for later access when using `Engine` functionality specific for one controller type.
347
+ */
348
+ controller: Record<string, SelectionController>;
349
+ };
350
+
351
+ export type State = {
352
+ /**
353
+ * A map of arbitrary keys that contain a controller instance as value. The key must be unique and needs
354
+ * to be provided for later access when using `Engine` functionality specific for one controller type.
355
+ */
356
+ controller: Record<string, Object[]>;
357
+ };
358
+ }
359
+
13
360
  declare module "sap/m/library" {
14
361
  import Control from "sap/ui/core/Control";
15
362
 
@@ -2869,6 +3216,27 @@ declare module "sap/m/library" {
2869
3216
  */
2870
3217
  None = "None",
2871
3218
  }
3219
+ /**
3220
+ * Enumeration for different separators for two columns layout when Select is in read-only mode.
3221
+ *
3222
+ * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'SelectTwoColumnSeparator'.
3223
+ *
3224
+ * @since 1.140
3225
+ */
3226
+ export enum SelectTwoColumnSeparator {
3227
+ /**
3228
+ * Will show bullet(·) as separator on two columns layout when Select is in read-only mode.
3229
+ */
3230
+ Bullet = "Bullet",
3231
+ /**
3232
+ * Will show N-dash(–) as separator on two columns layout when Select is in read-only mode.
3233
+ */
3234
+ Dash = "Dash",
3235
+ /**
3236
+ * Will show vertical line(|) as separator on two columns layout when Select is in read-only mode.
3237
+ */
3238
+ VerticalLine = "VerticalLine",
3239
+ }
2872
3240
  /**
2873
3241
  * Enumeration for different Select types.
2874
3242
  *
@@ -8010,6 +8378,66 @@ declare module "sap/m/AvatarBadgeColor" {
8010
8378
  * Accent 9
8011
8379
  */
8012
8380
  Accent9 = "Accent9",
8381
+ /**
8382
+ * Indication 1
8383
+ *
8384
+ * @since 1.140.0
8385
+ */
8386
+ Indication1 = "Indication1",
8387
+ /**
8388
+ * Indication 10
8389
+ *
8390
+ * @since 1.140.0
8391
+ */
8392
+ Indication10 = "Indication10",
8393
+ /**
8394
+ * Indication 2
8395
+ *
8396
+ * @since 1.140.0
8397
+ */
8398
+ Indication2 = "Indication2",
8399
+ /**
8400
+ * Indication 3
8401
+ *
8402
+ * @since 1.140.0
8403
+ */
8404
+ Indication3 = "Indication3",
8405
+ /**
8406
+ * Indication 4
8407
+ *
8408
+ * @since 1.140.0
8409
+ */
8410
+ Indication4 = "Indication4",
8411
+ /**
8412
+ * Indication 5
8413
+ *
8414
+ * @since 1.140.0
8415
+ */
8416
+ Indication5 = "Indication5",
8417
+ /**
8418
+ * Indication 6
8419
+ *
8420
+ * @since 1.140.0
8421
+ */
8422
+ Indication6 = "Indication6",
8423
+ /**
8424
+ * Indication 7
8425
+ *
8426
+ * @since 1.140.0
8427
+ */
8428
+ Indication7 = "Indication7",
8429
+ /**
8430
+ * Indication 8
8431
+ *
8432
+ * @since 1.140.0
8433
+ */
8434
+ Indication8 = "Indication8",
8435
+ /**
8436
+ * Indication 9
8437
+ *
8438
+ * @since 1.140.0
8439
+ */
8440
+ Indication9 = "Indication9",
8013
8441
  }
8014
8442
  export default AvatarBadgeColor;
8015
8443
  }
@@ -51589,12 +52017,12 @@ declare module "sap/m/ListBase" {
51589
52017
  * for the `selected` property of the item is not used. It also needs to be turned off if the binding context
51590
52018
  * of the item does not always point to the same entry in the model, for example, if the order of the data
51591
52019
  * in the `JSONModel` is changed. **Note:** This feature leverages the built-in selection mechanism of the
51592
- * corresponding binding context when the OData V4 model is used. Therefore, all binding-relevant limitations
52020
+ * corresponding binding context if the OData V4 model is used. Therefore, all binding-relevant limitations
51593
52021
  * apply in this context as well. For more details, see the {@link sap.ui.model.odata.v4.Context#setSelected setSelected},
51594
52022
  * the {@link sap.ui.model.odata.v4.ODataModel#bindList bindList}, and the {@link sap.ui.model.odata.v4.ODataMetaModel#requestValueListInfo requestValueListInfo }
51595
- * API documentation. Do not enable this feature when `$$SharedRequests` or `$$clearSelectionOnFilter` is
51596
- * active. **Note:** If this property is set to `false`, a possible binding context update of items (for
51597
- * example, filtering or sorting the list binding) would clear the selection of the items.
52023
+ * API documentation. Do not enable this feature if `$$sharedRequest` or `$$clearSelectionOnFilter` is active.
52024
+ * **Note:** If this property is set to `false`, a possible binding context update of items (for example,
52025
+ * filtering or sorting the list binding) would clear the selection of the items.
51598
52026
  *
51599
52027
  * Default value is `true`.
51600
52028
  *
@@ -52292,12 +52720,12 @@ declare module "sap/m/ListBase" {
52292
52720
  * for the `selected` property of the item is not used. It also needs to be turned off if the binding context
52293
52721
  * of the item does not always point to the same entry in the model, for example, if the order of the data
52294
52722
  * in the `JSONModel` is changed. **Note:** This feature leverages the built-in selection mechanism of the
52295
- * corresponding binding context when the OData V4 model is used. Therefore, all binding-relevant limitations
52723
+ * corresponding binding context if the OData V4 model is used. Therefore, all binding-relevant limitations
52296
52724
  * apply in this context as well. For more details, see the {@link sap.ui.model.odata.v4.Context#setSelected setSelected},
52297
52725
  * the {@link sap.ui.model.odata.v4.ODataModel#bindList bindList}, and the {@link sap.ui.model.odata.v4.ODataMetaModel#requestValueListInfo requestValueListInfo }
52298
- * API documentation. Do not enable this feature when `$$SharedRequests` or `$$clearSelectionOnFilter` is
52299
- * active. **Note:** If this property is set to `false`, a possible binding context update of items (for
52300
- * example, filtering or sorting the list binding) would clear the selection of the items.
52726
+ * API documentation. Do not enable this feature if `$$sharedRequest` or `$$clearSelectionOnFilter` is active.
52727
+ * **Note:** If this property is set to `false`, a possible binding context update of items (for example,
52728
+ * filtering or sorting the list binding) would clear the selection of the items.
52301
52729
  *
52302
52730
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
52303
52731
  *
@@ -52669,12 +53097,12 @@ declare module "sap/m/ListBase" {
52669
53097
  * for the `selected` property of the item is not used. It also needs to be turned off if the binding context
52670
53098
  * of the item does not always point to the same entry in the model, for example, if the order of the data
52671
53099
  * in the `JSONModel` is changed. **Note:** This feature leverages the built-in selection mechanism of the
52672
- * corresponding binding context when the OData V4 model is used. Therefore, all binding-relevant limitations
53100
+ * corresponding binding context if the OData V4 model is used. Therefore, all binding-relevant limitations
52673
53101
  * apply in this context as well. For more details, see the {@link sap.ui.model.odata.v4.Context#setSelected setSelected},
52674
53102
  * the {@link sap.ui.model.odata.v4.ODataModel#bindList bindList}, and the {@link sap.ui.model.odata.v4.ODataMetaModel#requestValueListInfo requestValueListInfo }
52675
- * API documentation. Do not enable this feature when `$$SharedRequests` or `$$clearSelectionOnFilter` is
52676
- * active. **Note:** If this property is set to `false`, a possible binding context update of items (for
52677
- * example, filtering or sorting the list binding) would clear the selection of the items.
53103
+ * API documentation. Do not enable this feature if `$$sharedRequest` or `$$clearSelectionOnFilter` is active.
53104
+ * **Note:** If this property is set to `false`, a possible binding context update of items (for example,
53105
+ * filtering or sorting the list binding) would clear the selection of the items.
52678
53106
  *
52679
53107
  * @since 1.16.6
52680
53108
  */
@@ -62163,6 +62591,12 @@ declare module "sap/m/MessageView" {
62163
62591
  */
62164
62592
  mSettings?: $MessageViewSettings
62165
62593
  );
62594
+ /**
62595
+ * Defines whether the custom header of details page will be shown.
62596
+ *
62597
+ * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
62598
+ */
62599
+ _bShowCustomHeader: boolean;
62166
62600
 
62167
62601
  /**
62168
62602
  * Creates a new subclass of class sap.m.MessageView with name `sClassName` and enriches it with the information
@@ -62470,6 +62904,55 @@ declare module "sap/m/MessageView" {
62470
62904
  */
62471
62905
  oListener?: object
62472
62906
  ): this;
62907
+ /**
62908
+ * Attaches event handler `fnFunction` to the {@link #event:onClose onClose} event of this `sap.m.MessageView`.
62909
+ *
62910
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
62911
+ * otherwise it will be bound to this `sap.m.MessageView` itself.
62912
+ *
62913
+ * Event fired when the close button in custom header is clicked.
62914
+ *
62915
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
62916
+ *
62917
+ * @returns Reference to `this` in order to allow method chaining
62918
+ */
62919
+ attachOnClose(
62920
+ /**
62921
+ * An application-specific payload object that will be passed to the event handler along with the event
62922
+ * object when firing the event
62923
+ */
62924
+ oData: object,
62925
+ /**
62926
+ * The function to be called when the event occurs
62927
+ */
62928
+ fnFunction: (p1: Event) => void,
62929
+ /**
62930
+ * Context object to call the event handler with. Defaults to this `sap.m.MessageView` itself
62931
+ */
62932
+ oListener?: object
62933
+ ): this;
62934
+ /**
62935
+ * Attaches event handler `fnFunction` to the {@link #event:onClose onClose} event of this `sap.m.MessageView`.
62936
+ *
62937
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
62938
+ * otherwise it will be bound to this `sap.m.MessageView` itself.
62939
+ *
62940
+ * Event fired when the close button in custom header is clicked.
62941
+ *
62942
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
62943
+ *
62944
+ * @returns Reference to `this` in order to allow method chaining
62945
+ */
62946
+ attachOnClose(
62947
+ /**
62948
+ * The function to be called when the event occurs
62949
+ */
62950
+ fnFunction: (p1: Event) => void,
62951
+ /**
62952
+ * Context object to call the event handler with. Defaults to this `sap.m.MessageView` itself
62953
+ */
62954
+ oListener?: object
62955
+ ): this;
62473
62956
  /**
62474
62957
  * Attaches event handler `fnFunction` to the {@link #event:urlValidated urlValidated} event of this `sap.m.MessageView`.
62475
62958
  *
@@ -62625,6 +63108,25 @@ declare module "sap/m/MessageView" {
62625
63108
  */
62626
63109
  oListener?: object
62627
63110
  ): this;
63111
+ /**
63112
+ * Detaches event handler `fnFunction` from the {@link #event:onClose onClose} event of this `sap.m.MessageView`.
63113
+ *
63114
+ * The passed function and listener object must match the ones used for event registration.
63115
+ *
63116
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
63117
+ *
63118
+ * @returns Reference to `this` in order to allow method chaining
63119
+ */
63120
+ detachOnClose(
63121
+ /**
63122
+ * The function to be called, when the event occurs
63123
+ */
63124
+ fnFunction: (p1: Event) => void,
63125
+ /**
63126
+ * Context object on which the given function had to be called
63127
+ */
63128
+ oListener?: object
63129
+ ): this;
62628
63130
  /**
62629
63131
  * Detaches event handler `fnFunction` from the {@link #event:urlValidated urlValidated} event of this `sap.m.MessageView`.
62630
63132
  *
@@ -62710,6 +63212,19 @@ declare module "sap/m/MessageView" {
62710
63212
  */
62711
63213
  mParameters?: object
62712
63214
  ): this;
63215
+ /**
63216
+ * Fires event {@link #event:onClose onClose} to attached listeners.
63217
+ *
63218
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
63219
+ *
63220
+ * @returns Reference to `this` in order to allow method chaining
63221
+ */
63222
+ fireOnClose(
63223
+ /**
63224
+ * Parameters to pass along with the event
63225
+ */
63226
+ mParameters?: object
63227
+ ): this;
62713
63228
  /**
62714
63229
  * Fires event {@link #event:urlValidated urlValidated} to attached listeners.
62715
63230
  *
@@ -62743,6 +63258,15 @@ declare module "sap/m/MessageView" {
62743
63258
  * @returns Value of property `asyncURLHandler`
62744
63259
  */
62745
63260
  getAsyncURLHandler(): Function;
63261
+ /**
63262
+ * Returns the close button used in the header of the MessageView. The button is only visible on non-phone
63263
+ * devices and triggers the `onClose` event when pressed.
63264
+ *
63265
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
63266
+ *
63267
+ * @returns The close button instance.
63268
+ */
63269
+ getCloseBtn(): Button;
62746
63270
  /**
62747
63271
  * Gets current value of property {@link #getGroupItems groupItems}.
62748
63272
  *
@@ -62809,6 +63333,17 @@ declare module "sap/m/MessageView" {
62809
63333
  */
62810
63334
  iIndex: int
62811
63335
  ): this;
63336
+ /**
63337
+ * Inserts a title into the given title container of the MessageView's header.
63338
+ *
63339
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
63340
+ */
63341
+ insertTitle(
63342
+ /**
63343
+ * The parent control where the title should be inserted.
63344
+ */
63345
+ oTitleParent: Control
63346
+ ): void;
62812
63347
  /**
62813
63348
  * Navigates back to the list page
62814
63349
  */
@@ -62916,6 +63451,13 @@ declare module "sap/m/MessageView" {
62916
63451
  */
62917
63452
  bShowDetailsPageHeader?: boolean
62918
63453
  ): this;
63454
+ /**
63455
+ * Sets up the header for the MessageView's ListPage based on the current configuration. If `showCustomHeader`
63456
+ * is enabled, a custom header and a sub-header are applied. Otherwise, a standard list header is used.
63457
+ *
63458
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
63459
+ */
63460
+ setupCustomHeader(): void;
62919
63461
  }
62920
63462
  /**
62921
63463
  * Describes the settings that can be provided to the MessageView constructor.
@@ -62991,6 +63533,13 @@ declare module "sap/m/MessageView" {
62991
63533
  * @since 1.58
62992
63534
  */
62993
63535
  activeTitlePress?: (oEvent: MessageView$ActiveTitlePressEvent) => void;
63536
+
63537
+ /**
63538
+ * Event fired when the close button in custom header is clicked.
63539
+ *
63540
+ * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
63541
+ */
63542
+ onClose?: (oEvent: Event) => void;
62994
63543
  }
62995
63544
 
62996
63545
  /**
@@ -63087,6 +63636,19 @@ declare module "sap/m/MessageView" {
63087
63636
  MessageView
63088
63637
  >;
63089
63638
 
63639
+ /**
63640
+ * Parameters of the MessageView#onClose event.
63641
+ */
63642
+ export interface MessageView$OnCloseEventParameters {}
63643
+
63644
+ /**
63645
+ * Event object of the MessageView#onClose event.
63646
+ */
63647
+ export type MessageView$OnCloseEvent = Event<
63648
+ MessageView$OnCloseEventParameters,
63649
+ MessageView
63650
+ >;
63651
+
63090
63652
  /**
63091
63653
  * Parameters of the MessageView#urlValidated event.
63092
63654
  */
@@ -76114,263 +76676,6 @@ declare module "sap/m/p13n/BasePanel" {
76114
76676
  >;
76115
76677
  }
76116
76678
 
76117
- declare module "sap/m/p13n/Engine" {
76118
- import Control from "sap/ui/core/Control";
76119
-
76120
- import Event from "sap/ui/base/Event";
76121
-
76122
- import Metadata from "sap/ui/base/Metadata";
76123
-
76124
- import Popup from "sap/m/p13n/Popup";
76125
-
76126
- import MetadataHelper from "sap/m/p13n/MetadataHelper";
76127
-
76128
- import SelectionController from "sap/m/p13n/SelectionController";
76129
-
76130
- /**
76131
- * The `Engine` entity offers personalization capabilities by registering a control instance for modification,
76132
- * such as:
76133
- *
76134
- *
76135
- * - `sap.m.p13n.Popup` initialization
76136
- * - Storing personalization states by choosing the desired persistence layer
76137
- * - State appliance considering the persistence layer
76138
- *
76139
- * The Engine must be used whenever personalization should be enabled by taking a certain persistence layer
76140
- * into account. Available controller implementations for the registration process are:
76141
- *
76142
- *
76143
- * - {@link sap.m.p13n.SelectionController SelectionController}: Used to define a list of selectable entries
76144
- *
76145
- * - {@link sap.m.p13n.SortController SortController}: Used to define a list of sortable properties
76146
- * - {@link sap.m.p13n.GroupController GroupController}: Used to define a list of groupable properties
76147
- *
76148
- *
76149
- * Can be used in combination with `sap.ui.fl.variants.VariantManagement` to persist a state in variants
76150
- * using `sap.ui.fl` capabilities.
76151
- *
76152
- * @since 1.104
76153
- */
76154
- export default class Engine
76155
- extends /* was: sap.m.p13n.modules.AdaptationProvider */ Object
76156
- {
76157
- /**
76158
- * See:
76159
- * {@link https://ui5.sap.com/#/topic/75c08fdebf784575947927e052712bab Personalization}
76160
- */
76161
- constructor();
76162
-
76163
- /**
76164
- * Creates a new subclass of class sap.m.p13n.Engine with name `sClassName` and enriches it with the information
76165
- * contained in `oClassInfo`.
76166
- *
76167
- * `oClassInfo` might contain the same kind of information as described in {@link sap.m.p13n.modules.AdaptationProvider.extend}.
76168
- *
76169
- *
76170
- * @returns Created class / constructor function
76171
- */
76172
- static extend<T extends Record<string, unknown>>(
76173
- /**
76174
- * Name of the class being created
76175
- */
76176
- sClassName: string,
76177
- /**
76178
- * Object literal with information about the class
76179
- */
76180
- oClassInfo?: sap.ClassInfo<T, Engine>,
76181
- /**
76182
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
76183
- * used by this class
76184
- */
76185
- FNMetaImpl?: Function
76186
- ): Function;
76187
- /**
76188
- * This method is the central point of access to the Engine Singleton.
76189
- *
76190
- *
76191
- * @returns The Engine instance
76192
- */
76193
- static getInstance(): Engine;
76194
- /**
76195
- * Returns a metadata object for class sap.m.p13n.Engine.
76196
- *
76197
- *
76198
- * @returns Metadata object describing this class
76199
- */
76200
- static getMetadata(): Metadata;
76201
- /**
76202
- * Applies a state to a control by passing an object that contains the registered controller key and an
76203
- * object matching the inner subcontroller logic.
76204
- *
76205
- *
76206
- * @returns A Promise resolving after the state has been applied
76207
- */
76208
- applyState(
76209
- /**
76210
- * The registered control instance
76211
- */
76212
- oControl: Control,
76213
- /**
76214
- * The state object
76215
- */
76216
- oState: State
76217
- ): Promise<State>;
76218
- /**
76219
- * Attaches an event handler to the `StateHandlerRegistry` class. The event handler is fired every time
76220
- * a user triggers a personalization change for a control instance during runtime.
76221
- *
76222
- *
76223
- * @returns Returns `this` to allow method chaining
76224
- */
76225
- attachStateChange(
76226
- /**
76227
- * The handler function to call when the event occurs
76228
- */
76229
- fnStateEventHandler: (p1: Event) => void,
76230
- /**
76231
- * The context object to call the event handler with (value of `this` in the event handler function).
76232
- */
76233
- oListener?: object
76234
- ): this;
76235
- /**
76236
- * Unregisters a registered control. By unregistering a control the control is removed from the `Engine`
76237
- * registry, and all instance-specific submodules, such as the registered controllers, are destroyed.
76238
- */
76239
- deregister(
76240
- /**
76241
- * The registered control instance
76242
- */
76243
- oControl: Control
76244
- ): void;
76245
- /**
76246
- * Removes a previously attached state change event handler from the `StateHandlerRegistry` class. The passed
76247
- * parameters must match those used for registration with {@link sap.m.p13n.Engine#attachStateChange} beforehand.
76248
- *
76249
- *
76250
- * @returns Returns `this` to allow method chaining
76251
- */
76252
- detachStateChange(
76253
- /**
76254
- * The handler function to detach from the event
76255
- */
76256
- fnStateEventHandler: (p1: Event) => void,
76257
- /**
76258
- * The context object to call the event handler with (value of `this` in the event handler function).
76259
- */
76260
- oListener?: object
76261
- ): this;
76262
-
76263
- register(
76264
- /**
76265
- * The control instance to be registered for adaptation
76266
- */
76267
- oControl: Control,
76268
- /**
76269
- * The Engine registration configuration
76270
- */
76271
- oConfig: EngineRegistrationConfig
76272
- ): void;
76273
- /**
76274
- * This method can be used to trigger a reset to the provided control instance.
76275
- *
76276
- *
76277
- * @returns A Promise resolving once the reset is completed
76278
- */
76279
- reset(
76280
- /**
76281
- * The related control instance
76282
- */
76283
- oControl: Control,
76284
- /**
76285
- * The key for the affected configuration
76286
- */
76287
- aKeys: string
76288
- ): Promise<null>;
76289
- /**
76290
- * Retrieves the state for a given control instance after all necessary changes have been applied (e.g.
76291
- * modification handler appliance). After the returned `Promise` has been resolved, the returned state is
76292
- * in sync with the related state object of the control.
76293
- *
76294
- *
76295
- * @returns A Promise resolving in the current control state
76296
- */
76297
- retrieveState(
76298
- /**
76299
- * The control instance implementing IxState to retrieve the externalized state
76300
- */
76301
- oControl: Control
76302
- ): Promise<State>;
76303
- /**
76304
- * Opens the personalization dialog.
76305
- *
76306
- *
76307
- * @returns Promise resolving in the `sap.m.p13n.Popup` instance
76308
- */
76309
- show(
76310
- /**
76311
- * The control instance that is personalized
76312
- */
76313
- oControl: Control,
76314
- /**
76315
- * The affected panels that are added to the `sap.m.p13n.Popup`
76316
- */
76317
- vPanelKeys: string | string[],
76318
- /**
76319
- * The settings object for the personalization
76320
- */
76321
- mSettings: {
76322
- /**
76323
- * The title for the `sap.m.p13n.Popup` control
76324
- */
76325
- title?: string;
76326
- /**
76327
- * The source control to be used by the `sap.m.p13n.Popup` control (only necessary if the mode is set to
76328
- * `ResponsivePopover`)
76329
- */
76330
- source?: Control;
76331
- /**
76332
- * The mode is used by the `sap.m.p13n.Popup` control
76333
- */
76334
- mode?: object;
76335
- /**
76336
- * Height configuration for the related popup container
76337
- */
76338
- contentHeight?: object;
76339
- /**
76340
- * Width configuration for the related popup container
76341
- */
76342
- contentWidth?: object;
76343
- }
76344
- ): Promise<Popup>;
76345
- }
76346
- /**
76347
- * The central registration for personalization functionality. The registration is a precondition for using
76348
- * `Engine` functionality for a control instance. Once the control instance has been registered, it can
76349
- * be passed to the related `Engine` methods that always expect a control instance as parameter. Only registered
76350
- * control instances can be used for personalization through the `Engine`.
76351
- */
76352
- export type EngineRegistrationConfig = {
76353
- /**
76354
- * The `{@link sap.m.p13n.MetadataHelper MetadataHelper}` to provide metadata-specific information. It may
76355
- * be used to define more granular information for the selection of items.
76356
- */
76357
- helper: MetadataHelper;
76358
- /**
76359
- * A map of arbitrary keys that contain a controller instance as value. The key must be unique and needs
76360
- * to be provided for later access when using `Engine` functionality specific for one controller type.
76361
- */
76362
- controller: Record<string, SelectionController>;
76363
- };
76364
-
76365
- export type State = {
76366
- /**
76367
- * A map of arbitrary keys that contain a controller instance as value. The key must be unique and needs
76368
- * to be provided for later access when using `Engine` functionality specific for one controller type.
76369
- */
76370
- controller: Record<string, Object[]>;
76371
- };
76372
- }
76373
-
76374
76679
  declare module "sap/m/p13n/FilterController" {
76375
76680
  import SelectionController from "sap/m/p13n/SelectionController";
76376
76681
 
@@ -95518,6 +95823,9 @@ declare module "sap/m/plugins/CopyProvider" {
95518
95823
  * This can be useful for maintaining the original structure of the data when it is pasted into a new location
95519
95824
  * (e.g. spreadsheets).
95520
95825
  *
95826
+ * **Note:** Sparse copying must not be enabled in combination with `sap.ui.table.plugins.ODataV4MultiSelection`
95827
+ * or the `sap.ui.mdc.Table` with the `sap.ui.mdc.odata.v4.TableDelegate`.
95828
+ *
95521
95829
  * Default value is `false`.
95522
95830
  *
95523
95831
  *
@@ -95632,6 +95940,9 @@ declare module "sap/m/plugins/CopyProvider" {
95632
95940
  * This can be useful for maintaining the original structure of the data when it is pasted into a new location
95633
95941
  * (e.g. spreadsheets).
95634
95942
  *
95943
+ * **Note:** Sparse copying must not be enabled in combination with `sap.ui.table.plugins.ODataV4MultiSelection`
95944
+ * or the `sap.ui.mdc.Table` with the `sap.ui.mdc.odata.v4.TableDelegate`.
95945
+ *
95635
95946
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
95636
95947
  *
95637
95948
  * Default value is `false`.
@@ -95804,6 +96115,9 @@ declare module "sap/m/plugins/CopyProvider" {
95804
96115
  *
95805
96116
  * This can be useful for maintaining the original structure of the data when it is pasted into a new location
95806
96117
  * (e.g. spreadsheets).
96118
+ *
96119
+ * **Note:** Sparse copying must not be enabled in combination with `sap.ui.table.plugins.ODataV4MultiSelection`
96120
+ * or the `sap.ui.mdc.Table` with the `sap.ui.mdc.odata.v4.TableDelegate`.
95807
96121
  */
95808
96122
  copySparse?: boolean | PropertyBindingInfo | `{${string}}`;
95809
96123
 
@@ -108419,15 +108733,26 @@ declare module "sap/m/routing/Router" {
108419
108733
  import TargetHandler from "sap/m/routing/TargetHandler";
108420
108734
 
108421
108735
  /**
108422
- * SAPUI5 mobile `Router`. The difference to the {@link sap.ui.core.routing.Router} are the `level`, `transition`,
108423
- * and `transitionParameters` properties that you can specify in every Route or Target created by this router.
108736
+ * The `sap.m.routing.Router` is a specialized extension of `{@link sap.ui.core.routing.Router}`, designed
108737
+ * specifically for the following containers in the `sap.m` library: `sap.m.App`, `sap.m.SplitApp`, or `sap.m.NavContainer`.
108738
+ *
108739
+ * It provides additional target and route configuration options that are optimized for the containers,
108740
+ * including support for animated transitions and navigation hierarchy levels.
108741
+ *
108742
+ * Compared to `{@link sap.ui.core.routing.Router}`, it adds support for additional Target properties:
108743
+ *
108744
+ * - `level`: Defines the hierarchical level of the target view for proper history and back navigation
108745
+ * handling
108746
+ * - `transition`: Specifies the type of transition animation between views (e.g., `slide`, `fade`)
108747
+ * - `transitionParameters`: Custom parameters for transitions
108748
+ *
108749
+ * For constructor parameters, see `{@link sap.ui.core.routing.Router#constructor}`.
108424
108750
  *
108425
108751
  * @since 1.28.1
108426
108752
  */
108427
108753
  export default class Router extends Router1 {
108428
108754
  /**
108429
- * Constructor for a new `sap.m.routing.Router`. See `{@link sap.ui.core.routing.Router}` for the constructor
108430
- * arguments.
108755
+ * Constructor for a new `sap.m.routing.Router`.
108431
108756
  */
108432
108757
  constructor(
108433
108758
  /**
@@ -112056,6 +112381,7 @@ declare module "sap/m/Select" {
112056
112381
  IToolbarInteractiveControl,
112057
112382
  SelectColumnRatio,
112058
112383
  OverflowToolbarConfig,
112384
+ SelectTwoColumnSeparator,
112059
112385
  SelectType,
112060
112386
  } from "sap/m/library";
112061
112387
 
@@ -112794,6 +113120,18 @@ declare module "sap/m/Select" {
112794
113120
  * @returns Value of property `textDirection`
112795
113121
  */
112796
113122
  getTextDirection(): TextDirection;
113123
+ /**
113124
+ * Gets current value of property {@link #getTwoColumnSeparator twoColumnSeparator}.
113125
+ *
113126
+ * Defines the separator type for the two columns layout when Select is in read-only mode.
113127
+ *
113128
+ * Default value is `Dash`.
113129
+ *
113130
+ * @since 1.140
113131
+ *
113132
+ * @returns Value of property `twoColumnSeparator`
113133
+ */
113134
+ getTwoColumnSeparator(): SelectTwoColumnSeparator;
112797
113135
  /**
112798
113136
  * Gets current value of property {@link #getType type}.
112799
113137
  *
@@ -113282,6 +113620,27 @@ declare module "sap/m/Select" {
113282
113620
  */
113283
113621
  sTextDirection?: TextDirection | keyof typeof TextDirection
113284
113622
  ): this;
113623
+ /**
113624
+ * Sets a new value for property {@link #getTwoColumnSeparator twoColumnSeparator}.
113625
+ *
113626
+ * Defines the separator type for the two columns layout when Select is in read-only mode.
113627
+ *
113628
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
113629
+ *
113630
+ * Default value is `Dash`.
113631
+ *
113632
+ * @since 1.140
113633
+ *
113634
+ * @returns Reference to `this` in order to allow method chaining
113635
+ */
113636
+ setTwoColumnSeparator(
113637
+ /**
113638
+ * New value for property `twoColumnSeparator`
113639
+ */
113640
+ sTwoColumnSeparator?:
113641
+ | SelectTwoColumnSeparator
113642
+ | keyof typeof SelectTwoColumnSeparator
113643
+ ): this;
113285
113644
  /**
113286
113645
  * Sets a new value for property {@link #getType type}.
113287
113646
  *
@@ -113566,6 +113925,16 @@ declare module "sap/m/Select" {
113566
113925
  */
113567
113926
  required?: boolean | PropertyBindingInfo | `{${string}}`;
113568
113927
 
113928
+ /**
113929
+ * Defines the separator type for the two columns layout when Select is in read-only mode.
113930
+ *
113931
+ * @since 1.140
113932
+ */
113933
+ twoColumnSeparator?:
113934
+ | (SelectTwoColumnSeparator | keyof typeof SelectTwoColumnSeparator)
113935
+ | PropertyBindingInfo
113936
+ | `{${string}}`;
113937
+
113569
113938
  /**
113570
113939
  * Defines the items contained within this control.
113571
113940
  *
@@ -169202,6 +169571,8 @@ declare module "sap/m/VariantManagement" {
169202
169571
  ): this;
169203
169572
  /**
169204
169573
  * Enables the programmatic selection of a variant.
169574
+ *
169575
+ * @since 1.121
169205
169576
  */
169206
169577
  setCurrentVariantKey(
169207
169578
  /**