@sapui5/ts-types 1.120.7 → 1.121.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.
- package/package.json +1 -1
- package/types/index.d.ts +1 -0
- package/types/sap.apf.d.ts +50 -18
- package/types/sap.ca.ui.d.ts +1114 -546
- package/types/sap.chart.d.ts +191 -43
- package/types/sap.collaboration.d.ts +185 -64
- package/types/sap.esh.search.ui.d.ts +2 -1960
- package/types/sap.f.d.ts +1607 -886
- package/types/sap.fe.core.d.ts +212 -191
- package/types/sap.fe.macros.d.ts +371 -531
- package/types/sap.fe.navigation.d.ts +59 -26
- package/types/sap.fe.placeholder.d.ts +1 -1
- package/types/sap.fe.plugins.managecache.d.ts +7 -0
- package/types/sap.fe.templates.d.ts +16 -11
- package/types/sap.fe.test.d.ts +333 -33
- package/types/sap.fe.tools.d.ts +1 -1
- package/types/sap.feedback.ui.d.ts +1 -1
- package/types/sap.gantt.d.ts +3947 -1754
- package/types/sap.insights.d.ts +162 -43
- package/types/sap.m.d.ts +14867 -8374
- package/types/sap.makit.d.ts +379 -187
- package/types/sap.me.d.ts +237 -37
- package/types/sap.ndc.d.ts +40 -9
- package/types/sap.ovp.d.ts +9 -7
- package/types/sap.rules.ui.d.ts +134 -75
- package/types/sap.sac.df.d.ts +272 -49
- package/types/sap.suite.ui.commons.d.ts +4231 -1008
- package/types/sap.suite.ui.generic.template.d.ts +236 -171
- package/types/sap.suite.ui.microchart.d.ts +1027 -388
- package/types/sap.tnt.d.ts +827 -247
- package/types/sap.ui.codeeditor.d.ts +57 -24
- package/types/sap.ui.commons.d.ts +2075 -673
- package/types/sap.ui.comp.d.ts +3908 -2995
- package/types/sap.ui.core.d.ts +5739 -3520
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.export.d.ts +88 -67
- package/types/sap.ui.fl.d.ts +169 -104
- package/types/sap.ui.generic.app.d.ts +250 -193
- package/types/sap.ui.generic.template.d.ts +1 -1
- package/types/sap.ui.integration.d.ts +494 -388
- package/types/sap.ui.layout.d.ts +1345 -668
- package/types/sap.ui.mdc.d.ts +3395 -2036
- package/types/sap.ui.richtexteditor.d.ts +115 -55
- package/types/sap.ui.rta.d.ts +7 -7
- package/types/sap.ui.suite.d.ts +46 -12
- package/types/sap.ui.support.d.ts +58 -26
- package/types/sap.ui.table.d.ts +963 -627
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +1979 -1249
- package/types/sap.ui.ux3.d.ts +1311 -491
- package/types/sap.ui.vbm.d.ts +5300 -2517
- package/types/sap.ui.vk.d.ts +2742 -836
- package/types/sap.ui.vtm.d.ts +685 -215
- package/types/sap.ui.webc.common.d.ts +11 -9
- package/types/sap.ui.webc.fiori.d.ts +884 -213
- package/types/sap.ui.webc.main.d.ts +2815 -601
- package/types/sap.uiext.inbox.d.ts +207 -36
- package/types/sap.ushell.d.ts +1954 -1270
- package/types/sap.ushell_abap.d.ts +1 -1
- package/types/sap.uxap.d.ts +626 -321
- package/types/sap.viz.d.ts +4324 -2527
- package/types/sap.webanalytics.core.d.ts +1 -1
- package/types/sap.zen.commons.d.ts +79 -18
- package/types/sap.zen.crosstab.d.ts +83 -15
- package/types/sap.zen.dsh.d.ts +194 -143
package/types/sap.fe.core.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.
|
|
1
|
+
// For Library Version: 1.121.0
|
|
2
2
|
|
|
3
3
|
declare namespace sap {
|
|
4
4
|
/**
|
|
@@ -39,28 +39,24 @@ declare namespace sap {
|
|
|
39
39
|
}
|
|
40
40
|
|
|
41
41
|
/**
|
|
42
|
-
* @since 1.118.0
|
|
43
|
-
*
|
|
44
42
|
* A base implementation for controller extension used internally in sap.fe for central functionalities.
|
|
43
|
+
*
|
|
44
|
+
* @since 1.118.0
|
|
45
45
|
*/
|
|
46
46
|
class BaseControllerExtension extends sap.ui.core.mvc
|
|
47
|
-
.ControllerExtension {
|
|
48
|
-
constructor();
|
|
49
|
-
}
|
|
47
|
+
.ControllerExtension {}
|
|
50
48
|
/**
|
|
51
|
-
* @since 1.90.0
|
|
52
|
-
*
|
|
53
49
|
* A controller extension offering hooks into the edit flow of the application
|
|
50
|
+
*
|
|
51
|
+
* @since 1.90.0
|
|
54
52
|
*/
|
|
55
53
|
class EditFlow extends sap.fe.core.controllerextensions
|
|
56
54
|
.BaseControllerExtension {
|
|
57
|
-
constructor();
|
|
58
|
-
|
|
59
55
|
/**
|
|
60
|
-
* @since 1.90.0
|
|
61
|
-
*
|
|
62
56
|
* Submit the current set of changes and navigate back.
|
|
63
57
|
*
|
|
58
|
+
* @since 1.90.0
|
|
59
|
+
*
|
|
64
60
|
* @returns Promise resolves once the changes have been saved
|
|
65
61
|
*/
|
|
66
62
|
applyDocument(
|
|
@@ -70,10 +66,10 @@ declare namespace sap {
|
|
|
70
66
|
oContext: sap.ui.model.odata.v4.Context
|
|
71
67
|
): Promise<void>;
|
|
72
68
|
/**
|
|
73
|
-
* @since 1.90.0
|
|
74
|
-
*
|
|
75
69
|
* Discard the editable document.
|
|
76
70
|
*
|
|
71
|
+
* @since 1.90.0
|
|
72
|
+
*
|
|
77
73
|
* @returns Promise resolves once editable document has been discarded
|
|
78
74
|
*/
|
|
79
75
|
cancelDocument(
|
|
@@ -88,18 +84,18 @@ declare namespace sap {
|
|
|
88
84
|
/**
|
|
89
85
|
* This is the control used to open the discard popover
|
|
90
86
|
*/
|
|
91
|
-
control?:
|
|
87
|
+
control?: sap.m.Button;
|
|
92
88
|
/**
|
|
93
89
|
* Optional, supresses the discard popover and allows custom handling
|
|
94
90
|
*/
|
|
95
91
|
skipDiscardPopover?: boolean;
|
|
96
92
|
}
|
|
97
|
-
): Promise<
|
|
93
|
+
): Promise<sap.ui.model.odata.v4.Context | undefined>;
|
|
98
94
|
/**
|
|
99
|
-
* @since 1.90.0
|
|
100
|
-
*
|
|
101
95
|
* Creates a new document.
|
|
102
96
|
*
|
|
97
|
+
* @since 1.90.0
|
|
98
|
+
*
|
|
103
99
|
* @returns Promise resolves once the object has been created
|
|
104
100
|
*/
|
|
105
101
|
createDocument(
|
|
@@ -152,10 +148,10 @@ declare namespace sap {
|
|
|
152
148
|
}
|
|
153
149
|
): Promise<void>;
|
|
154
150
|
/**
|
|
155
|
-
* @since 1.90.0
|
|
156
|
-
*
|
|
157
151
|
* Deletes the document.
|
|
158
152
|
*
|
|
153
|
+
* @since 1.90.0
|
|
154
|
+
*
|
|
159
155
|
* @returns Promise resolves once document has been deleted
|
|
160
156
|
*/
|
|
161
157
|
deleteDocument(
|
|
@@ -166,7 +162,7 @@ declare namespace sap {
|
|
|
166
162
|
/**
|
|
167
163
|
* Can contain the following attributes:
|
|
168
164
|
*/
|
|
169
|
-
mInParameters
|
|
165
|
+
mInParameters?: {
|
|
170
166
|
/**
|
|
171
167
|
* Description of the object being deleted
|
|
172
168
|
*/
|
|
@@ -178,10 +174,10 @@ declare namespace sap {
|
|
|
178
174
|
}
|
|
179
175
|
): Promise<void>;
|
|
180
176
|
/**
|
|
181
|
-
* @since 1.90.0
|
|
182
|
-
*
|
|
183
177
|
* Creates a draft document for the existing active document.
|
|
184
178
|
*
|
|
179
|
+
* @since 1.90.0
|
|
180
|
+
*
|
|
185
181
|
* @returns Promise resolves once the editable document is available with the editable context
|
|
186
182
|
*/
|
|
187
183
|
editDocument(
|
|
@@ -191,11 +187,11 @@ declare namespace sap {
|
|
|
191
187
|
oContext: sap.ui.model.odata.v4.Context
|
|
192
188
|
): Promise<sap.ui.model.odata.v4.Context | void>;
|
|
193
189
|
/**
|
|
194
|
-
* @since 1.90.0
|
|
195
|
-
*
|
|
196
190
|
* Invokes an action (bound or unbound) and tracks the changes so that other pages can be refreshed and
|
|
197
191
|
* show the updated data upon navigation.
|
|
198
192
|
*
|
|
193
|
+
* @since 1.90.0
|
|
194
|
+
*
|
|
199
195
|
* @returns A promise which resolves once the action has been executed, providing the response
|
|
200
196
|
*/
|
|
201
197
|
invokeAction(
|
|
@@ -232,16 +228,7 @@ declare namespace sap {
|
|
|
232
228
|
/**
|
|
233
229
|
* A map of action parameter names and provided values
|
|
234
230
|
*/
|
|
235
|
-
parameterValues?:
|
|
236
|
-
/**
|
|
237
|
-
* Name of the parameter
|
|
238
|
-
*/
|
|
239
|
-
name: string;
|
|
240
|
-
/**
|
|
241
|
-
* Value of the parameter
|
|
242
|
-
*/
|
|
243
|
-
value: any;
|
|
244
|
-
};
|
|
231
|
+
parameterValues?: object[];
|
|
245
232
|
/**
|
|
246
233
|
* Boolean value indicating whether navigation is required after the action has been executed. Navigation
|
|
247
234
|
* takes place to the context returned by the action
|
|
@@ -252,16 +239,16 @@ declare namespace sap {
|
|
|
252
239
|
*/
|
|
253
240
|
skipParameterDialog?: boolean;
|
|
254
241
|
}
|
|
255
|
-
): Promise<
|
|
242
|
+
): Promise<any>;
|
|
256
243
|
/**
|
|
257
|
-
* @since 1.116.0
|
|
258
|
-
*
|
|
259
244
|
* This function can be used to execute code after the 'Create' action.
|
|
260
245
|
* You can execute custom coding in this function.
|
|
261
246
|
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
262
247
|
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
|
|
263
248
|
*
|
|
264
249
|
*
|
|
250
|
+
* @since 1.116.0
|
|
251
|
+
*
|
|
265
252
|
* @returns A promise to be returned by the overridden method.
|
|
266
253
|
*/
|
|
267
254
|
onAfterCreate(
|
|
@@ -276,14 +263,14 @@ declare namespace sap {
|
|
|
276
263
|
}
|
|
277
264
|
): Promise<void>;
|
|
278
265
|
/**
|
|
279
|
-
* @since 1.116.0
|
|
280
|
-
*
|
|
281
266
|
* This function can be used to execute code after the 'Delete' action.
|
|
282
267
|
* You can execute custom coding in this function.
|
|
283
268
|
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
284
269
|
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
|
|
285
270
|
*
|
|
286
271
|
*
|
|
272
|
+
* @since 1.116.0
|
|
273
|
+
*
|
|
287
274
|
* @returns A promise to be returned by the overridden method.
|
|
288
275
|
*/
|
|
289
276
|
onAfterDelete(
|
|
@@ -298,14 +285,14 @@ declare namespace sap {
|
|
|
298
285
|
}
|
|
299
286
|
): Promise<void>;
|
|
300
287
|
/**
|
|
301
|
-
* @since 1.116.0
|
|
302
|
-
*
|
|
303
288
|
* This function can be used to execute code after the 'Discard' action.
|
|
304
289
|
* You can execute custom coding in this function.
|
|
305
290
|
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
306
291
|
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
|
|
307
292
|
*
|
|
308
293
|
*
|
|
294
|
+
* @since 1.116.0
|
|
295
|
+
*
|
|
309
296
|
* @returns A promise to be returned by the overridden method.
|
|
310
297
|
*/
|
|
311
298
|
onAfterDiscard(
|
|
@@ -320,14 +307,14 @@ declare namespace sap {
|
|
|
320
307
|
}
|
|
321
308
|
): Promise<void>;
|
|
322
309
|
/**
|
|
323
|
-
* @since 1.116.0
|
|
324
|
-
*
|
|
325
310
|
* This function can be used to execute code after the 'Edit' action.
|
|
326
311
|
* You can execute custom coding in this function.
|
|
327
312
|
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
328
313
|
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
|
|
329
314
|
*
|
|
330
315
|
*
|
|
316
|
+
* @since 1.116.0
|
|
317
|
+
*
|
|
331
318
|
* @returns A promise to be returned by the overridden method.
|
|
332
319
|
*/
|
|
333
320
|
onAfterEdit(
|
|
@@ -342,14 +329,14 @@ declare namespace sap {
|
|
|
342
329
|
}
|
|
343
330
|
): Promise<void>;
|
|
344
331
|
/**
|
|
345
|
-
* @since 1.116.0
|
|
346
|
-
*
|
|
347
332
|
* This function can be used to execute code after the 'Save' action.
|
|
348
333
|
* You can execute custom coding in this function.
|
|
349
334
|
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
350
335
|
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
|
|
351
336
|
*
|
|
352
337
|
*
|
|
338
|
+
* @since 1.116.0
|
|
339
|
+
*
|
|
353
340
|
* @returns A promise to be returned by the overridden method.
|
|
354
341
|
*/
|
|
355
342
|
onAfterSave(
|
|
@@ -364,8 +351,6 @@ declare namespace sap {
|
|
|
364
351
|
}
|
|
365
352
|
): Promise<void>;
|
|
366
353
|
/**
|
|
367
|
-
* @since 1.98.0
|
|
368
|
-
*
|
|
369
354
|
* This function can be used to intercept the 'Create' action. You can execute custom coding in this function.
|
|
370
355
|
* The framework waits for the returned promise to be resolved before continuing the 'Create' action.
|
|
371
356
|
* If you reject the promise, the 'Create' action is stopped.
|
|
@@ -373,6 +358,8 @@ declare namespace sap {
|
|
|
373
358
|
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
|
|
374
359
|
*
|
|
375
360
|
*
|
|
361
|
+
* @since 1.98.0
|
|
362
|
+
*
|
|
376
363
|
* @returns A promise to be returned by the overridden method. If resolved, the 'Create' action is triggered.
|
|
377
364
|
* If rejected, the 'Create' action is not triggered.
|
|
378
365
|
*/
|
|
@@ -392,8 +379,6 @@ declare namespace sap {
|
|
|
392
379
|
}
|
|
393
380
|
): Promise<void>;
|
|
394
381
|
/**
|
|
395
|
-
* @since 1.98.0
|
|
396
|
-
*
|
|
397
382
|
* This function can be used to intercept the 'Delete' action. You can execute custom coding in this function.
|
|
398
383
|
* The framework waits for the returned promise to be resolved before continuing the 'Delete' action.
|
|
399
384
|
* If you reject the promise, the 'Delete' action is stopped.
|
|
@@ -401,6 +386,8 @@ declare namespace sap {
|
|
|
401
386
|
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
|
|
402
387
|
*
|
|
403
388
|
*
|
|
389
|
+
* @since 1.98.0
|
|
390
|
+
*
|
|
404
391
|
* @returns A promise to be returned by the overridden method. If resolved, the 'Delete' action is triggered.
|
|
405
392
|
* If rejected, the 'Delete' action is not triggered.
|
|
406
393
|
*/
|
|
@@ -416,8 +403,6 @@ declare namespace sap {
|
|
|
416
403
|
}
|
|
417
404
|
): Promise<void>;
|
|
418
405
|
/**
|
|
419
|
-
* @since 1.98.0
|
|
420
|
-
*
|
|
421
406
|
* This function can be used to intercept the 'Discard' action. You can execute custom coding in this function.
|
|
422
407
|
* The framework waits for the returned promise to be resolved before continuing the 'Discard' action.
|
|
423
408
|
* If you reject the promise, the 'Discard' action is stopped and the user stays in edit mode.
|
|
@@ -425,6 +410,8 @@ declare namespace sap {
|
|
|
425
410
|
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
|
|
426
411
|
*
|
|
427
412
|
*
|
|
413
|
+
* @since 1.98.0
|
|
414
|
+
*
|
|
428
415
|
* @returns A promise to be returned by the overridden method. If resolved, the 'Discard' action is triggered.
|
|
429
416
|
* If rejected, the 'Discard' action is not triggered and the user stays in edit mode.
|
|
430
417
|
*/
|
|
@@ -440,8 +427,6 @@ declare namespace sap {
|
|
|
440
427
|
}
|
|
441
428
|
): Promise<void>;
|
|
442
429
|
/**
|
|
443
|
-
* @since 1.98.0
|
|
444
|
-
*
|
|
445
430
|
* This function can be used to intercept the 'Edit' action. You can execute custom coding in this function.
|
|
446
431
|
* The framework waits for the returned promise to be resolved before continuing the 'Edit' action.
|
|
447
432
|
* If you reject the promise, the 'Edit' action is stopped and the user stays in display mode.
|
|
@@ -449,6 +434,8 @@ declare namespace sap {
|
|
|
449
434
|
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
|
|
450
435
|
*
|
|
451
436
|
*
|
|
437
|
+
* @since 1.98.0
|
|
438
|
+
*
|
|
452
439
|
* @returns A promise to be returned by the overridden method. If resolved, the 'Edit' action is triggered.
|
|
453
440
|
* If rejected, the 'Edit' action is not triggered and the user stays in display mode.
|
|
454
441
|
*/
|
|
@@ -464,8 +451,6 @@ declare namespace sap {
|
|
|
464
451
|
}
|
|
465
452
|
): Promise<void>;
|
|
466
453
|
/**
|
|
467
|
-
* @since 1.90.0
|
|
468
|
-
*
|
|
469
454
|
* This function can be used to intercept the 'Save' action. You can execute custom coding in this function.
|
|
470
455
|
* The framework waits for the returned promise to be resolved before continuing the 'Save' action.
|
|
471
456
|
* If you reject the promise, the 'Save' action is stopped and the user stays in edit mode.
|
|
@@ -473,6 +458,8 @@ declare namespace sap {
|
|
|
473
458
|
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
|
|
474
459
|
*
|
|
475
460
|
*
|
|
461
|
+
* @since 1.90.0
|
|
462
|
+
*
|
|
476
463
|
* @returns A promise to be returned by the overridden method. If resolved, the 'Save' action is triggered.
|
|
477
464
|
* If rejected, the 'Save' action is not triggered and the user stays in edit mode.
|
|
478
465
|
*/
|
|
@@ -488,10 +475,10 @@ declare namespace sap {
|
|
|
488
475
|
}
|
|
489
476
|
): Promise<void>;
|
|
490
477
|
/**
|
|
491
|
-
* @since 1.90.0
|
|
492
|
-
*
|
|
493
478
|
* Saves a new document after checking it.
|
|
494
479
|
*
|
|
480
|
+
* @since 1.90.0
|
|
481
|
+
*
|
|
495
482
|
* @returns Promise resolves once save is complete
|
|
496
483
|
*/
|
|
497
484
|
saveDocument(
|
|
@@ -501,11 +488,11 @@ declare namespace sap {
|
|
|
501
488
|
oContext: sap.ui.model.odata.v4.Context
|
|
502
489
|
): Promise<void>;
|
|
503
490
|
/**
|
|
504
|
-
* @since 1.90.0
|
|
505
|
-
*
|
|
506
491
|
* Secured execution of the given function. Ensures that the function is only executed when certain conditions
|
|
507
492
|
* are fulfilled.
|
|
508
493
|
*
|
|
494
|
+
* @since 1.90.0
|
|
495
|
+
*
|
|
509
496
|
* @returns A promise that is rejected if the execution is prohibited and resolved by the promise returned
|
|
510
497
|
* by the fnFunction.
|
|
511
498
|
*/
|
|
@@ -541,10 +528,10 @@ declare namespace sap {
|
|
|
541
528
|
}
|
|
542
529
|
): Promise<void>;
|
|
543
530
|
/**
|
|
544
|
-
* @since 1.90.0
|
|
545
|
-
*
|
|
546
531
|
* Updates the draft status and displays the error messages if there are errors during an update.
|
|
547
532
|
*
|
|
533
|
+
* @since 1.90.0
|
|
534
|
+
*
|
|
548
535
|
* @returns Promise resolves once draft status has been updated
|
|
549
536
|
*/
|
|
550
537
|
updateDocument(
|
|
@@ -560,19 +547,17 @@ declare namespace sap {
|
|
|
560
547
|
): Promise<void>;
|
|
561
548
|
}
|
|
562
549
|
/**
|
|
563
|
-
* @since 1.86.0
|
|
564
|
-
*
|
|
565
550
|
* Controller extension providing hooks for intent-based navigation
|
|
551
|
+
*
|
|
552
|
+
* @since 1.86.0
|
|
566
553
|
*/
|
|
567
554
|
class IntentBasedNavigation extends sap.ui.core.mvc
|
|
568
555
|
.ControllerExtension {
|
|
569
|
-
constructor();
|
|
570
|
-
|
|
571
556
|
/**
|
|
572
|
-
* @since 1.86.0
|
|
573
|
-
*
|
|
574
557
|
* Provides a hook to customize the {@link sap.fe.navigation.SelectionVariant } related to the intent-based
|
|
575
558
|
* navigation.
|
|
559
|
+
*
|
|
560
|
+
* @since 1.86.0
|
|
576
561
|
*/
|
|
577
562
|
adaptNavigationContext(
|
|
578
563
|
/**
|
|
@@ -594,9 +579,9 @@ declare namespace sap {
|
|
|
594
579
|
}
|
|
595
580
|
): void;
|
|
596
581
|
/**
|
|
597
|
-
* @since 1.86.0
|
|
598
|
-
*
|
|
599
582
|
* Navigates to an intent defined by an outbound definition in the manifest.
|
|
583
|
+
*
|
|
584
|
+
* @since 1.86.0
|
|
600
585
|
*/
|
|
601
586
|
navigateOutbound(
|
|
602
587
|
/**
|
|
@@ -612,22 +597,17 @@ declare namespace sap {
|
|
|
612
597
|
* If mNavigationParameters are provided, the parameters provided in the outbound definition of the manifest
|
|
613
598
|
* are ignored.
|
|
614
599
|
*/
|
|
615
|
-
mNavigationParameters
|
|
600
|
+
mNavigationParameters?: Record<string, any>
|
|
616
601
|
): void;
|
|
617
602
|
}
|
|
618
603
|
/**
|
|
604
|
+
* A controller extension offering message handling.
|
|
605
|
+
*
|
|
619
606
|
* @since 1.90.0
|
|
620
607
|
* @experimental (since 1.90.0)
|
|
621
|
-
*
|
|
622
|
-
* A controller extension offering message handling.
|
|
623
608
|
*/
|
|
624
609
|
class MessageHandler extends sap.ui.core.mvc.ControllerExtension {
|
|
625
|
-
constructor();
|
|
626
|
-
|
|
627
610
|
/**
|
|
628
|
-
* @since 1.90.0
|
|
629
|
-
* @experimental (since 1.90.0)
|
|
630
|
-
*
|
|
631
611
|
* Shows a message dialog with transition messages if there are any.
|
|
632
612
|
* The message dialog is shown as a modal dialog. Once the user confirms the dialog, all transition messages
|
|
633
613
|
* are removed from the message model. If there is more than one message, a list of messages is shown. The
|
|
@@ -636,38 +616,39 @@ declare namespace sap {
|
|
|
636
616
|
* the dialog immediately shows the details of the message. If there is just one success message, a message
|
|
637
617
|
* toast is shown instead.
|
|
638
618
|
*
|
|
619
|
+
* @since 1.90.0
|
|
620
|
+
* @experimental (since 1.90.0)
|
|
621
|
+
*
|
|
639
622
|
* @returns A promise that is resolved once the user closes the dialog. If there are no messages
|
|
640
623
|
* to be shown, the promise is resolved immediately
|
|
641
624
|
*/
|
|
642
|
-
showMessageDialog(): Promise<
|
|
625
|
+
showMessageDialog(): Promise<boolean | sap.m.Dialog>;
|
|
643
626
|
}
|
|
644
627
|
/**
|
|
645
|
-
* @since 1.94.0
|
|
646
|
-
*
|
|
647
628
|
* Controller extension providing hooks for the navigation using paginators
|
|
629
|
+
*
|
|
630
|
+
* @since 1.94.0
|
|
648
631
|
*/
|
|
649
632
|
class Paginator extends sap.ui.core.mvc.ControllerExtension {
|
|
650
|
-
constructor();
|
|
651
|
-
|
|
652
633
|
/**
|
|
653
|
-
* @since 1.94.0
|
|
654
|
-
*
|
|
655
634
|
* Initiates the paginator control.
|
|
635
|
+
*
|
|
636
|
+
* @since 1.94.0
|
|
656
637
|
*/
|
|
657
638
|
initialize(
|
|
658
639
|
/**
|
|
659
640
|
* ODataListBinding object
|
|
660
641
|
*/
|
|
661
|
-
oBinding
|
|
642
|
+
oBinding?: sap.ui.model.odata.v4.ODataListBinding,
|
|
662
643
|
/**
|
|
663
644
|
* Current context where the navigation is initiated
|
|
664
645
|
*/
|
|
665
646
|
oContext?: sap.ui.model.odata.v4.Context
|
|
666
647
|
): void;
|
|
667
648
|
/**
|
|
668
|
-
* @since 1.94.0
|
|
669
|
-
*
|
|
670
649
|
* Returns the updated context after the paginator operation.
|
|
650
|
+
*
|
|
651
|
+
* @since 1.94.0
|
|
671
652
|
*/
|
|
672
653
|
onContextUpdate(
|
|
673
654
|
/**
|
|
@@ -677,17 +658,15 @@ declare namespace sap {
|
|
|
677
658
|
): void;
|
|
678
659
|
}
|
|
679
660
|
/**
|
|
680
|
-
* @since 1.86.0
|
|
681
|
-
*
|
|
682
661
|
* A controller extension offering hooks into the routing flow of the application
|
|
662
|
+
*
|
|
663
|
+
* @since 1.86.0
|
|
683
664
|
*/
|
|
684
665
|
class Routing extends sap.ui.core.mvc.ControllerExtension {
|
|
685
|
-
constructor();
|
|
686
|
-
|
|
687
666
|
/**
|
|
688
|
-
* @since 1.90.0
|
|
689
|
-
*
|
|
690
667
|
* Allows navigation to a specific context.
|
|
668
|
+
*
|
|
669
|
+
* @since 1.90.0
|
|
691
670
|
*/
|
|
692
671
|
navigate(
|
|
693
672
|
/**
|
|
@@ -698,6 +677,7 @@ declare namespace sap {
|
|
|
698
677
|
/**
|
|
699
678
|
* Navigate to another target.
|
|
700
679
|
*
|
|
680
|
+
*
|
|
701
681
|
* @returns Promise that is resolved when the navigation is finalized
|
|
702
682
|
*/
|
|
703
683
|
navigateToRoute(
|
|
@@ -711,36 +691,36 @@ declare namespace sap {
|
|
|
711
691
|
oParameters?: object
|
|
712
692
|
): Promise<boolean>;
|
|
713
693
|
/**
|
|
714
|
-
* @since 1.90.0
|
|
715
|
-
*
|
|
716
694
|
* This function is used to intercept the routing event after binding a page.
|
|
717
695
|
* If it is declared as an extension, it allows you to intercept and change the normal flow of binding.
|
|
718
696
|
* This function is not called directly, but overridden separately by consuming controllers.
|
|
719
697
|
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
|
|
698
|
+
*
|
|
699
|
+
*
|
|
700
|
+
* @since 1.90.0
|
|
720
701
|
*/
|
|
721
702
|
onAfterBinding(
|
|
722
703
|
/**
|
|
723
704
|
* Object containing the context to be navigated
|
|
724
705
|
*/
|
|
725
|
-
oContext: object
|
|
706
|
+
oContext: null | object
|
|
726
707
|
): void;
|
|
727
708
|
/**
|
|
728
|
-
* @since 1.90.0
|
|
729
|
-
*
|
|
730
709
|
* This function is used to intercept the routing event before binding a page.
|
|
731
710
|
* If it is declared as an extension, it allows you to intercept and change the normal flow of binding.
|
|
732
711
|
* This function is not called directly, but overridden separately by consuming controllers.
|
|
733
712
|
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
|
|
713
|
+
*
|
|
714
|
+
*
|
|
715
|
+
* @since 1.90.0
|
|
734
716
|
*/
|
|
735
717
|
onBeforeBinding(
|
|
736
718
|
/**
|
|
737
719
|
* Object containing the context for the navigation
|
|
738
720
|
*/
|
|
739
|
-
oContext: object
|
|
721
|
+
oContext: null | object
|
|
740
722
|
): void;
|
|
741
723
|
/**
|
|
742
|
-
* @since 1.86.0
|
|
743
|
-
*
|
|
744
724
|
* This function can be used to intercept the routing event happening during the normal process of navigating
|
|
745
725
|
* from one page to another (like clicking on the table row to navigate, or when pagination buttons are
|
|
746
726
|
* clicked).
|
|
@@ -753,6 +733,8 @@ declare namespace sap {
|
|
|
753
733
|
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
|
|
754
734
|
*
|
|
755
735
|
*
|
|
736
|
+
* @since 1.86.0
|
|
737
|
+
*
|
|
756
738
|
* @returns `true` to prevent the default execution, false to keep the standard behavior
|
|
757
739
|
*/
|
|
758
740
|
onBeforeNavigation(
|
|
@@ -768,19 +750,17 @@ declare namespace sap {
|
|
|
768
750
|
): boolean;
|
|
769
751
|
}
|
|
770
752
|
/**
|
|
771
|
-
* @since 1.86.0
|
|
772
|
-
*
|
|
773
753
|
* A controller extension offering hooks into the routing flow of the application
|
|
754
|
+
*
|
|
755
|
+
* @since 1.86.0
|
|
774
756
|
*/
|
|
775
757
|
class Share extends sap.ui.core.mvc.ControllerExtension {
|
|
776
|
-
constructor();
|
|
777
|
-
|
|
778
758
|
/**
|
|
779
|
-
* @since 1.93.0
|
|
780
|
-
*
|
|
781
759
|
* Adapts the metadata used while sharing the page URL via 'Send Email', 'Share in SAP Jam', and 'Save as
|
|
782
760
|
* Tile'.
|
|
783
761
|
*
|
|
762
|
+
* @since 1.93.0
|
|
763
|
+
*
|
|
784
764
|
* @returns Share Metadata or a Promise resolving the Share Metadata
|
|
785
765
|
*/
|
|
786
766
|
adaptShareMetadata(
|
|
@@ -853,32 +833,32 @@ declare namespace sap {
|
|
|
853
833
|
| Promise</* was: sap.fe.core.controllerextensions.Share.ShareMetadata */ any>
|
|
854
834
|
| /* was: sap.fe.core.controllerextensions.Share.ShareMetadata */ any;
|
|
855
835
|
/**
|
|
856
|
-
* @since 1.93.0
|
|
857
|
-
*
|
|
858
836
|
* Opens the share sheet.
|
|
837
|
+
*
|
|
838
|
+
* @since 1.93.0
|
|
859
839
|
*/
|
|
860
840
|
openShareSheet(
|
|
861
841
|
/**
|
|
862
842
|
* The control to which the ActionSheet is opened.
|
|
863
843
|
*/
|
|
864
|
-
oControl:
|
|
844
|
+
oControl: sap.ui.core.Control
|
|
865
845
|
): void;
|
|
866
846
|
}
|
|
867
847
|
/**
|
|
868
|
-
* @since 1.85.0
|
|
869
|
-
*
|
|
870
848
|
* A controller extension offering hooks for state handling
|
|
871
849
|
* If you need to maintain a specific state for your application, you can use the controller extension.
|
|
850
|
+
*
|
|
851
|
+
*
|
|
852
|
+
* @since 1.85.0
|
|
872
853
|
*/
|
|
873
854
|
class ViewState extends sap.ui.core.mvc.ControllerExtension {
|
|
874
|
-
constructor();
|
|
875
|
-
|
|
876
855
|
/**
|
|
877
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
878
|
-
*
|
|
879
856
|
* This function should add all controls relevant for refreshing to the provided control array.
|
|
880
857
|
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
881
858
|
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
|
|
859
|
+
*
|
|
860
|
+
*
|
|
861
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
882
862
|
*/
|
|
883
863
|
adaptBindingRefreshControls(
|
|
884
864
|
/**
|
|
@@ -887,28 +867,30 @@ declare namespace sap {
|
|
|
887
867
|
aCollectedControls: sap.ui.base.ManagedObject[]
|
|
888
868
|
): void;
|
|
889
869
|
/**
|
|
890
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
891
|
-
*
|
|
892
870
|
* Customize the `refreshBinding` function for a certain control.
|
|
893
871
|
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
894
872
|
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
|
|
873
|
+
*
|
|
874
|
+
*
|
|
875
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
895
876
|
*/
|
|
896
877
|
adaptBindingRefreshHandler(
|
|
897
878
|
/**
|
|
898
879
|
* The control for which the refresh handler is adapted.
|
|
899
880
|
*/
|
|
900
|
-
|
|
881
|
+
_oControl: sap.ui.base.ManagedObject,
|
|
901
882
|
/**
|
|
902
883
|
* A plain object which can have one function: `refreshBinding`
|
|
903
884
|
*/
|
|
904
|
-
|
|
885
|
+
_oControlHandler: object
|
|
905
886
|
): void;
|
|
906
887
|
/**
|
|
907
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
908
|
-
*
|
|
909
888
|
* Customize the `retrieve` and `apply` functions for a certain control.
|
|
910
889
|
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
911
890
|
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
|
|
891
|
+
*
|
|
892
|
+
*
|
|
893
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
912
894
|
*/
|
|
913
895
|
adaptControlStateHandler(
|
|
914
896
|
/**
|
|
@@ -921,25 +903,27 @@ declare namespace sap {
|
|
|
921
903
|
aControlHandler: object[]
|
|
922
904
|
): void;
|
|
923
905
|
/**
|
|
924
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
925
|
-
*
|
|
926
906
|
* This function should add all controls for given view that should be considered for the state handling
|
|
927
907
|
* to the provided control array.
|
|
928
908
|
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
929
909
|
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
|
|
910
|
+
*
|
|
911
|
+
*
|
|
912
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
930
913
|
*/
|
|
931
914
|
adaptStateControls(
|
|
932
915
|
/**
|
|
933
916
|
* The collected controls
|
|
934
917
|
*/
|
|
935
|
-
|
|
918
|
+
_aCollectedControls: sap.ui.base.ManagedObject[]
|
|
936
919
|
): void;
|
|
937
920
|
/**
|
|
938
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
939
|
-
*
|
|
940
921
|
* Applying additional, not control related, states - is called only if navigation type is iAppState.
|
|
941
922
|
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
942
923
|
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
|
|
924
|
+
*
|
|
925
|
+
*
|
|
926
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
943
927
|
*/
|
|
944
928
|
applyAdditionalStates(
|
|
945
929
|
/**
|
|
@@ -952,8 +936,6 @@ declare namespace sap {
|
|
|
952
936
|
aPromises: Promise<any>
|
|
953
937
|
): void;
|
|
954
938
|
/**
|
|
955
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
956
|
-
*
|
|
957
939
|
* Defines whether the view state should only be applied once initially.
|
|
958
940
|
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
959
941
|
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.Instead }.
|
|
@@ -961,16 +943,19 @@ declare namespace sap {
|
|
|
961
943
|
* You should only override this method for custom pages and not for the standard ListReportPage and ObjectPage!
|
|
962
944
|
*
|
|
963
945
|
*
|
|
946
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
947
|
+
*
|
|
964
948
|
* @returns If `true`, only the initial view state is applied once,
|
|
965
949
|
* else any new view state is also applied on follow-up calls (default)
|
|
966
950
|
*/
|
|
967
951
|
applyInitialStateOnly(): boolean;
|
|
968
952
|
/**
|
|
969
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
970
|
-
*
|
|
971
953
|
* Apply navigation parameters is not called if the navigation type is iAppState
|
|
972
954
|
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
973
955
|
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
|
|
956
|
+
*
|
|
957
|
+
*
|
|
958
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
974
959
|
*/
|
|
975
960
|
applyNavigationParameters(
|
|
976
961
|
/**
|
|
@@ -980,7 +965,7 @@ declare namespace sap {
|
|
|
980
965
|
/**
|
|
981
966
|
* The actual navigation type
|
|
982
967
|
*/
|
|
983
|
-
navigationType:
|
|
968
|
+
navigationType: string;
|
|
984
969
|
/**
|
|
985
970
|
* Defines whether the standard variant must be used in variant management
|
|
986
971
|
*/
|
|
@@ -1002,13 +987,14 @@ declare namespace sap {
|
|
|
1002
987
|
/**
|
|
1003
988
|
* Applies the given view state to this extensions view.
|
|
1004
989
|
*
|
|
990
|
+
*
|
|
1005
991
|
* @returns Promise for async state handling
|
|
1006
992
|
*/
|
|
1007
993
|
applyViewState(
|
|
1008
994
|
/**
|
|
1009
995
|
* The view state to apply (can be undefined)
|
|
1010
996
|
*/
|
|
1011
|
-
oViewState: Record<string,
|
|
997
|
+
oViewState: Record<string, any> | undefined,
|
|
1012
998
|
/**
|
|
1013
999
|
* The current navigation parameter
|
|
1014
1000
|
*/
|
|
@@ -1019,11 +1005,12 @@ declare namespace sap {
|
|
|
1019
1005
|
skipMerge?: boolean
|
|
1020
1006
|
): Promise<void>;
|
|
1021
1007
|
/**
|
|
1022
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1023
|
-
*
|
|
1024
1008
|
* Hook to react when state for given view was applied.
|
|
1025
1009
|
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
1026
1010
|
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
|
|
1011
|
+
*
|
|
1012
|
+
*
|
|
1013
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1027
1014
|
*/
|
|
1028
1015
|
onAfterStateApplied(
|
|
1029
1016
|
/**
|
|
@@ -1032,11 +1019,12 @@ declare namespace sap {
|
|
|
1032
1019
|
aPromises: Promise<any>
|
|
1033
1020
|
): void;
|
|
1034
1021
|
/**
|
|
1035
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1036
|
-
*
|
|
1037
1022
|
* Hook to react before a state for given view is applied.
|
|
1038
1023
|
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
1039
1024
|
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
|
|
1025
|
+
*
|
|
1026
|
+
*
|
|
1027
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1040
1028
|
*/
|
|
1041
1029
|
onBeforeStateApplied(
|
|
1042
1030
|
/**
|
|
@@ -1057,12 +1045,13 @@ declare namespace sap {
|
|
|
1057
1045
|
*/
|
|
1058
1046
|
onSuspend(): void;
|
|
1059
1047
|
/**
|
|
1060
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1061
|
-
*
|
|
1062
1048
|
* Extend the map of additional states (not control bound) to be added to the current view state of the
|
|
1063
1049
|
* given view.
|
|
1064
1050
|
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
1065
1051
|
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
|
|
1052
|
+
*
|
|
1053
|
+
*
|
|
1054
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1066
1055
|
*/
|
|
1067
1056
|
retrieveAdditionalStates(
|
|
1068
1057
|
/**
|
|
@@ -1075,9 +1064,10 @@ declare namespace sap {
|
|
|
1075
1064
|
* When this function is called more than once before finishing, all but the final response will resolve
|
|
1076
1065
|
* to `undefined`.
|
|
1077
1066
|
*
|
|
1067
|
+
*
|
|
1078
1068
|
* @returns A promise resolving the view state
|
|
1079
1069
|
*/
|
|
1080
|
-
retrieveViewState(): Promise<
|
|
1070
|
+
retrieveViewState(): Promise<Record<string, any> | undefined>;
|
|
1081
1071
|
}
|
|
1082
1072
|
}
|
|
1083
1073
|
/**
|
|
@@ -1085,9 +1075,6 @@ declare namespace sap {
|
|
|
1085
1075
|
*/
|
|
1086
1076
|
namespace fpm {
|
|
1087
1077
|
/**
|
|
1088
|
-
* @since 1.92.0
|
|
1089
|
-
* @experimental (since 1.92.0)
|
|
1090
|
-
*
|
|
1091
1078
|
* Component that can be used as a wrapper component for custom pages.
|
|
1092
1079
|
* The component can be used in case you want to use SAP Fiori elements Building Blocks or XML template
|
|
1093
1080
|
* constructions. You can either extend the component and set the viewName and contextPath within your code
|
|
@@ -1109,52 +1096,63 @@ declare namespace sap {
|
|
|
1109
1096
|
* }
|
|
1110
1097
|
* }
|
|
1111
1098
|
* ```
|
|
1099
|
+
*
|
|
1100
|
+
*
|
|
1101
|
+
*
|
|
1102
|
+
* @since 1.92.0
|
|
1103
|
+
* @experimental (since 1.92.0)
|
|
1112
1104
|
*/
|
|
1113
1105
|
class Component
|
|
1114
1106
|
/* was: sap.fe.core.TemplateComponent */ extends Object {
|
|
1115
|
-
|
|
1107
|
+
/**
|
|
1108
|
+
* Returns the current AppComponent.
|
|
1109
|
+
*
|
|
1110
|
+
*
|
|
1111
|
+
* @returns The current AppComponent
|
|
1112
|
+
*/
|
|
1113
|
+
getAppComponent(): sap.fe.core.AppComponent;
|
|
1114
|
+
}
|
|
1115
|
+
}
|
|
1116
|
+
|
|
1117
|
+
namespace controls {
|
|
1118
|
+
namespace buildingBlocks {
|
|
1119
|
+
interface $BuildingBlockBaseSettings
|
|
1120
|
+
extends sap.ui.core.$ControlSettings {}
|
|
1121
|
+
|
|
1122
|
+
/**
|
|
1123
|
+
* Defines a control that will not exist in the DOM.
|
|
1124
|
+
* Instead, only its child will be there and this control will forward all DOM related instruction to it.
|
|
1125
|
+
*
|
|
1126
|
+
* @since 1.121.0
|
|
1127
|
+
* @experimental (since 1.121.0)
|
|
1128
|
+
*/
|
|
1129
|
+
class BuildingBlockBase extends sap.ui.core.Control {}
|
|
1116
1130
|
}
|
|
1117
1131
|
}
|
|
1118
1132
|
|
|
1119
1133
|
namespace rootView {
|
|
1120
1134
|
/**
|
|
1121
|
-
* @since 1.110.0
|
|
1122
|
-
*
|
|
1123
1135
|
* Base controller class for your own root view with an sap.f.FlexibleColumnLayout control.
|
|
1124
1136
|
* By using or extending this controller, you can use your own root view with the sap.fe.core.AppComponent
|
|
1125
1137
|
* and
|
|
1126
1138
|
* you can make use of SAP Fiori elements pages and SAP Fiori elements building blocks.
|
|
1139
|
+
*
|
|
1140
|
+
*
|
|
1141
|
+
* @since 1.110.0
|
|
1127
1142
|
*/
|
|
1128
1143
|
class Fcl
|
|
1129
|
-
/* was: sap.fe.core.rootView.RootViewBaseController */ extends Object {
|
|
1130
|
-
constructor();
|
|
1131
|
-
|
|
1132
|
-
/**
|
|
1133
|
-
* Method that creates a new Page to display the IllustratedMessage containing the current error.
|
|
1134
|
-
*
|
|
1135
|
-
* @returns A promise that creates a Page to display the error
|
|
1136
|
-
*/
|
|
1137
|
-
displayErrorPage(): Promise<boolean>;
|
|
1138
|
-
}
|
|
1144
|
+
/* was: sap.fe.core.rootView.RootViewBaseController */ extends Object {}
|
|
1139
1145
|
/**
|
|
1140
|
-
* @since 1.108.0
|
|
1141
|
-
*
|
|
1142
1146
|
* Base controller class for your own root view with a sap.m.NavContainer control.
|
|
1143
1147
|
* By using or extending this controller you can use your own root view with the sap.fe.core.AppComponent
|
|
1144
1148
|
* and
|
|
1145
1149
|
* you can make use of SAP Fiori elements pages and SAP Fiori elements building blocks.
|
|
1150
|
+
*
|
|
1151
|
+
*
|
|
1152
|
+
* @since 1.108.0
|
|
1146
1153
|
*/
|
|
1147
1154
|
class NavContainer
|
|
1148
|
-
/* was: sap.fe.core.rootView.RootViewBaseController */ extends Object {
|
|
1149
|
-
constructor();
|
|
1150
|
-
|
|
1151
|
-
/**
|
|
1152
|
-
* Method that creates a new Page to display the IllustratedMessage containing the current error.
|
|
1153
|
-
*
|
|
1154
|
-
* @returns A promise that creates a Page to display the error
|
|
1155
|
-
*/
|
|
1156
|
-
displayErrorPage(): Promise<boolean>;
|
|
1157
|
-
}
|
|
1155
|
+
/* was: sap.fe.core.rootView.RootViewBaseController */ extends Object {}
|
|
1158
1156
|
}
|
|
1159
1157
|
|
|
1160
1158
|
interface $AppComponentSettings
|
|
@@ -1174,8 +1172,6 @@ declare namespace sap {
|
|
|
1174
1172
|
* - sap.fe.core.rootView.Fcl when using sap.f.routing.Router (FCL use case)
|
|
1175
1173
|
*/
|
|
1176
1174
|
class AppComponent extends sap.ui.core.UIComponent {
|
|
1177
|
-
constructor();
|
|
1178
|
-
|
|
1179
1175
|
/**
|
|
1180
1176
|
* Changes the page configuration of SAP Fiori elements.
|
|
1181
1177
|
* This method enables you to change the page configuration of SAP Fiori elements.
|
|
@@ -1193,7 +1189,7 @@ declare namespace sap {
|
|
|
1193
1189
|
* The new value of the configuration. This could be a plain value like a string, or a Boolean, or a structured
|
|
1194
1190
|
* object.
|
|
1195
1191
|
*/
|
|
1196
|
-
value:
|
|
1192
|
+
value: any
|
|
1197
1193
|
): void;
|
|
1198
1194
|
/**
|
|
1199
1195
|
* Provides a hook to initialize feature toggles.
|
|
@@ -1201,40 +1197,44 @@ declare namespace sap {
|
|
|
1201
1197
|
* To change page configuration use the {@link sap.fe.core.AppComponent#changePageConfiguration } method.
|
|
1202
1198
|
*
|
|
1203
1199
|
*
|
|
1200
|
+
*
|
|
1204
1201
|
* @returns A promise without any value to allow asynchronous processes
|
|
1205
1202
|
*/
|
|
1206
1203
|
initializeFeatureToggles(): Promise<void>;
|
|
1207
1204
|
}
|
|
1208
1205
|
/**
|
|
1209
|
-
* @since 1.90.0
|
|
1210
|
-
*
|
|
1211
1206
|
* Internal base controller class for SAP Fiori elements application.
|
|
1212
1207
|
* If you want to extend a base controller for your custom page, please use for sap.fe.core.PageController.
|
|
1208
|
+
*
|
|
1209
|
+
*
|
|
1210
|
+
* @since 1.90.0
|
|
1213
1211
|
*/
|
|
1214
1212
|
class BaseController extends sap.ui.core.mvc.Controller {
|
|
1215
|
-
constructor();
|
|
1216
|
-
|
|
1217
1213
|
/**
|
|
1218
|
-
* @since 1.91.0
|
|
1219
|
-
*
|
|
1220
1214
|
* Returns the current app component.
|
|
1221
1215
|
*
|
|
1216
|
+
* @since 1.91.0
|
|
1217
|
+
*
|
|
1222
1218
|
* @returns The app component or, if not found, null
|
|
1223
1219
|
*/
|
|
1224
1220
|
getAppComponent(): sap.fe.core.AppComponent;
|
|
1225
1221
|
/**
|
|
1226
1222
|
* Convenience method provided by SAP Fiori elements to enable applications to include the view model by
|
|
1227
1223
|
* name into each controller.
|
|
1224
|
+
*
|
|
1225
|
+
*
|
|
1226
|
+
* @returns The model instance
|
|
1228
1227
|
*/
|
|
1229
1228
|
getModel(
|
|
1230
1229
|
/**
|
|
1231
1230
|
* The model name
|
|
1232
1231
|
*/
|
|
1233
1232
|
sName?: string
|
|
1234
|
-
):
|
|
1233
|
+
): sap.ui.model.Model | undefined;
|
|
1235
1234
|
/**
|
|
1236
1235
|
* Convenience method for setting the view model in every controller of the application.
|
|
1237
1236
|
*
|
|
1237
|
+
*
|
|
1238
1238
|
* @returns The view instance
|
|
1239
1239
|
*/
|
|
1240
1240
|
setModel(
|
|
@@ -1249,16 +1249,15 @@ declare namespace sap {
|
|
|
1249
1249
|
): sap.ui.core.mvc.View;
|
|
1250
1250
|
}
|
|
1251
1251
|
/**
|
|
1252
|
-
* @since 1.79.0
|
|
1253
|
-
*
|
|
1254
1252
|
* Common Extension API for all pages of SAP Fiori elements for OData V4.
|
|
1255
1253
|
* To correctly integrate your app extension coding with SAP Fiori elements, use only the extensionAPI of
|
|
1256
1254
|
* SAP Fiori elements. Don't access or manipulate controls, properties, models, or other internal objects
|
|
1257
1255
|
* created by the SAP Fiori elements framework.
|
|
1256
|
+
*
|
|
1257
|
+
*
|
|
1258
|
+
* @since 1.79.0
|
|
1258
1259
|
*/
|
|
1259
1260
|
class ExtensionAPI extends sap.ui.base.Object {
|
|
1260
|
-
constructor();
|
|
1261
|
-
|
|
1262
1261
|
/**
|
|
1263
1262
|
* Add any control as a dependent control to this SAP Fiori elements page.
|
|
1264
1263
|
*/
|
|
@@ -1272,6 +1271,7 @@ declare namespace sap {
|
|
|
1272
1271
|
* Access a control by its ID. If you attempt to access an internal control instead of the stable API, the
|
|
1273
1272
|
* method will raise an error.
|
|
1274
1273
|
*
|
|
1274
|
+
*
|
|
1275
1275
|
* @returns The requested control, if found in the view / section.
|
|
1276
1276
|
*/
|
|
1277
1277
|
byId(
|
|
@@ -1283,12 +1283,14 @@ declare namespace sap {
|
|
|
1283
1283
|
/**
|
|
1284
1284
|
* Retrieves the editFlow controller extension for this page.
|
|
1285
1285
|
*
|
|
1286
|
+
*
|
|
1286
1287
|
* @returns The editFlow controller extension
|
|
1287
1288
|
*/
|
|
1288
1289
|
getEditFlow(): sap.fe.core.controllerextensions.EditFlow;
|
|
1289
1290
|
/**
|
|
1290
1291
|
* Retrieves the intentBasedNavigation controller extension for this page.
|
|
1291
1292
|
*
|
|
1293
|
+
*
|
|
1292
1294
|
* @returns The intentBasedNavigation controller extension
|
|
1293
1295
|
*/
|
|
1294
1296
|
getIntentBasedNavigation(): sap.fe.core.controllerextensions.IntentBasedNavigation;
|
|
@@ -1311,6 +1313,7 @@ declare namespace sap {
|
|
|
1311
1313
|
* .
|
|
1312
1314
|
* editMode is deprecated and should not be used anymore. Use isEditable instead.
|
|
1313
1315
|
*
|
|
1316
|
+
*
|
|
1314
1317
|
* @returns The required model
|
|
1315
1318
|
*/
|
|
1316
1319
|
getModel(
|
|
@@ -1322,12 +1325,14 @@ declare namespace sap {
|
|
|
1322
1325
|
/**
|
|
1323
1326
|
* Retrieves the routing controller extension for this page.
|
|
1324
1327
|
*
|
|
1328
|
+
*
|
|
1325
1329
|
* @returns The routing controller extension
|
|
1326
1330
|
*/
|
|
1327
1331
|
getRouting(): sap.fe.core.controllerextensions.Routing;
|
|
1328
1332
|
/**
|
|
1329
1333
|
* Load a fragment and go through the template preprocessor with the current page context.
|
|
1330
1334
|
*
|
|
1335
|
+
*
|
|
1331
1336
|
* @returns The fragment definition
|
|
1332
1337
|
*/
|
|
1333
1338
|
loadFragment(
|
|
@@ -1366,9 +1371,9 @@ declare namespace sap {
|
|
|
1366
1371
|
*/
|
|
1367
1372
|
sTarget: string,
|
|
1368
1373
|
/**
|
|
1369
|
-
*
|
|
1374
|
+
* OData v4 context instance
|
|
1370
1375
|
*/
|
|
1371
|
-
oContext: sap.ui.model.Context
|
|
1376
|
+
oContext: sap.ui.model.odata.v4.Context
|
|
1372
1377
|
): void;
|
|
1373
1378
|
/**
|
|
1374
1379
|
* Remove a dependent control from this SAP Fiori elements page.
|
|
@@ -1379,35 +1384,49 @@ declare namespace sap {
|
|
|
1379
1384
|
*/
|
|
1380
1385
|
oControl: sap.ui.core.Control
|
|
1381
1386
|
): void;
|
|
1387
|
+
/**
|
|
1388
|
+
* Run the given function with the FPM context of the current page.
|
|
1389
|
+
* This allows to initialize all the elements required by building blocks to render correctly.
|
|
1390
|
+
*
|
|
1391
|
+
*
|
|
1392
|
+
* @returns The result of the function
|
|
1393
|
+
*/
|
|
1394
|
+
runWithFPMContext(
|
|
1395
|
+
/**
|
|
1396
|
+
* The Function to be executed
|
|
1397
|
+
*/
|
|
1398
|
+
fn: Function
|
|
1399
|
+
): any;
|
|
1382
1400
|
/**
|
|
1383
1401
|
* Triggers an update of the app state.
|
|
1384
1402
|
* Should be called if the state of a control, or any other state-relevant information, was changed.
|
|
1385
1403
|
*
|
|
1404
|
+
*
|
|
1386
1405
|
* @returns A promise that resolves with the new app state object.
|
|
1387
1406
|
*/
|
|
1388
1407
|
updateAppState(): Promise<object | void>;
|
|
1389
1408
|
}
|
|
1390
1409
|
/**
|
|
1391
|
-
* @since 1.88.0
|
|
1392
|
-
*
|
|
1393
1410
|
* Base controller class for your custom page used inside an SAP Fiori elements application.
|
|
1394
1411
|
* This controller provides preconfigured extensions that will ensure you have the basic functionalities
|
|
1395
1412
|
* required to use the building blocks.
|
|
1413
|
+
*
|
|
1414
|
+
*
|
|
1415
|
+
* @since 1.88.0
|
|
1396
1416
|
*/
|
|
1397
1417
|
class PageController extends sap.fe.core.BaseController {
|
|
1398
|
-
constructor();
|
|
1399
|
-
|
|
1400
1418
|
/**
|
|
1401
1419
|
* Get the extension API for the current page.
|
|
1402
1420
|
*
|
|
1421
|
+
*
|
|
1403
1422
|
* @returns The extension API.
|
|
1404
1423
|
*/
|
|
1405
1424
|
getExtensionAPI(): sap.fe.core.ExtensionAPI;
|
|
1406
1425
|
}
|
|
1407
1426
|
/**
|
|
1408
|
-
* @since 1.86.0
|
|
1409
|
-
*
|
|
1410
1427
|
* Possible initial load (first app startup) modes for a ListReport.
|
|
1428
|
+
*
|
|
1429
|
+
* @since 1.86.0
|
|
1411
1430
|
*/
|
|
1412
1431
|
enum InitialLoadMode {
|
|
1413
1432
|
/**
|
|
@@ -1431,6 +1450,8 @@ declare namespace sap {
|
|
|
1431
1450
|
|
|
1432
1451
|
"sap/fe/core/BaseController": undefined;
|
|
1433
1452
|
|
|
1453
|
+
"sap/fe/core/buildingBlocks/BuildingBlockBase": undefined;
|
|
1454
|
+
|
|
1434
1455
|
"sap/fe/core/controllerextensions/BaseControllerExtension": undefined;
|
|
1435
1456
|
|
|
1436
1457
|
"sap/fe/core/controllerextensions/EditFlow": undefined;
|