@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.
Files changed (65) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +1 -0
  3. package/types/sap.apf.d.ts +50 -18
  4. package/types/sap.ca.ui.d.ts +1114 -546
  5. package/types/sap.chart.d.ts +191 -43
  6. package/types/sap.collaboration.d.ts +185 -64
  7. package/types/sap.esh.search.ui.d.ts +2 -1960
  8. package/types/sap.f.d.ts +1607 -886
  9. package/types/sap.fe.core.d.ts +212 -191
  10. package/types/sap.fe.macros.d.ts +371 -531
  11. package/types/sap.fe.navigation.d.ts +59 -26
  12. package/types/sap.fe.placeholder.d.ts +1 -1
  13. package/types/sap.fe.plugins.managecache.d.ts +7 -0
  14. package/types/sap.fe.templates.d.ts +16 -11
  15. package/types/sap.fe.test.d.ts +333 -33
  16. package/types/sap.fe.tools.d.ts +1 -1
  17. package/types/sap.feedback.ui.d.ts +1 -1
  18. package/types/sap.gantt.d.ts +3947 -1754
  19. package/types/sap.insights.d.ts +162 -43
  20. package/types/sap.m.d.ts +14867 -8374
  21. package/types/sap.makit.d.ts +379 -187
  22. package/types/sap.me.d.ts +237 -37
  23. package/types/sap.ndc.d.ts +40 -9
  24. package/types/sap.ovp.d.ts +9 -7
  25. package/types/sap.rules.ui.d.ts +134 -75
  26. package/types/sap.sac.df.d.ts +272 -49
  27. package/types/sap.suite.ui.commons.d.ts +4231 -1008
  28. package/types/sap.suite.ui.generic.template.d.ts +236 -171
  29. package/types/sap.suite.ui.microchart.d.ts +1027 -388
  30. package/types/sap.tnt.d.ts +827 -247
  31. package/types/sap.ui.codeeditor.d.ts +57 -24
  32. package/types/sap.ui.commons.d.ts +2075 -673
  33. package/types/sap.ui.comp.d.ts +3908 -2995
  34. package/types/sap.ui.core.d.ts +5739 -3520
  35. package/types/sap.ui.dt.d.ts +1 -1
  36. package/types/sap.ui.export.d.ts +88 -67
  37. package/types/sap.ui.fl.d.ts +169 -104
  38. package/types/sap.ui.generic.app.d.ts +250 -193
  39. package/types/sap.ui.generic.template.d.ts +1 -1
  40. package/types/sap.ui.integration.d.ts +494 -388
  41. package/types/sap.ui.layout.d.ts +1345 -668
  42. package/types/sap.ui.mdc.d.ts +3395 -2036
  43. package/types/sap.ui.richtexteditor.d.ts +115 -55
  44. package/types/sap.ui.rta.d.ts +7 -7
  45. package/types/sap.ui.suite.d.ts +46 -12
  46. package/types/sap.ui.support.d.ts +58 -26
  47. package/types/sap.ui.table.d.ts +963 -627
  48. package/types/sap.ui.testrecorder.d.ts +1 -1
  49. package/types/sap.ui.unified.d.ts +1979 -1249
  50. package/types/sap.ui.ux3.d.ts +1311 -491
  51. package/types/sap.ui.vbm.d.ts +5300 -2517
  52. package/types/sap.ui.vk.d.ts +2742 -836
  53. package/types/sap.ui.vtm.d.ts +685 -215
  54. package/types/sap.ui.webc.common.d.ts +11 -9
  55. package/types/sap.ui.webc.fiori.d.ts +884 -213
  56. package/types/sap.ui.webc.main.d.ts +2815 -601
  57. package/types/sap.uiext.inbox.d.ts +207 -36
  58. package/types/sap.ushell.d.ts +1954 -1270
  59. package/types/sap.ushell_abap.d.ts +1 -1
  60. package/types/sap.uxap.d.ts +626 -321
  61. package/types/sap.viz.d.ts +4324 -2527
  62. package/types/sap.webanalytics.core.d.ts +1 -1
  63. package/types/sap.zen.commons.d.ts +79 -18
  64. package/types/sap.zen.crosstab.d.ts +83 -15
  65. package/types/sap.zen.dsh.d.ts +194 -143
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.6
1
+ // For Library Version: 1.121.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace suite {
@@ -23,6 +23,7 @@ declare namespace sap {
23
23
  *
24
24
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
25
25
  *
26
+ *
26
27
  * @returns Created class / constructor function
27
28
  */
28
29
  static extend<T extends Record<string, unknown>>(
@@ -46,6 +47,7 @@ declare namespace sap {
46
47
  /**
47
48
  * Returns a metadata object for class sap.suite.ui.generic.template.AnalyticalListPage.extensionAPI.ExtensionAPI.
48
49
  *
50
+ *
49
51
  * @returns Metadata object describing this class
50
52
  */
51
53
  static getMetadata(): sap.ui.base.Metadata;
@@ -63,18 +65,21 @@ declare namespace sap {
63
65
  /**
64
66
  * provides incoming navigation context of the app
65
67
  *
68
+ *
66
69
  * @returns Navigation context object
67
70
  */
68
71
  getNavigationContext(): Object;
69
72
  /**
70
73
  * Get the navigation controller for navigation actions
71
74
  *
75
+ *
72
76
  * @returns the navigation controller
73
77
  */
74
78
  getNavigationController(): sap.suite.ui.generic.template.extensionAPI.NavigationController;
75
79
  /**
76
80
  * Get the list entries currently selected
77
81
  *
82
+ *
78
83
  * @returns contains the entries selected
79
84
  */
80
85
  getSelectedContexts(
@@ -86,6 +91,7 @@ declare namespace sap {
86
91
  /**
87
92
  * Invokes multiple time the action with the given name and submits changes to the back-end.
88
93
  *
94
+ *
89
95
  * @returns A `Promise` for asynchronous execution of the action, resolving to the same result as the `Promise`
90
96
  * returned from {@link sap.ui.generic.app.ApplicationController#invokeActions}
91
97
  */
@@ -136,6 +142,7 @@ declare namespace sap {
136
142
  * See:
137
143
  * {@link https://ui5.sap.com/#/topic/6a39150ad3e548a8b5304d32d560790a Using the SecuredExecutionMethod}
138
144
  *
145
+ *
139
146
  * @returns A `Promise` that is rejected, if execution is prohibited, and settled equivalent to the one
140
147
  * returned by fnFunction.
141
148
  */
@@ -231,12 +238,12 @@ declare namespace sap {
231
238
  */
232
239
  interface controllerFrameworkExtensions {
233
240
  /**
234
- * @ui5-protected Do not call from applications (only from related classes in the framework)
235
- *
236
241
  * This method is called by SAP Fiori elements before triggering an external navigation. Application developers
237
242
  * can override this method and programmatically adapt the parameters which are passed to the target application.
238
243
  * Application developers can use the oObjectInfo parameter to identify the navigation context and modify
239
244
  * the oSelectionVariant which contains the navigation parameters.
245
+ *
246
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
240
247
  */
241
248
  adaptNavigationParameterExtension(
242
249
  /**
@@ -258,15 +265,13 @@ declare namespace sap {
258
265
  }
259
266
  ): void;
260
267
  /**
261
- * @ui5-protected Do not call from applications (only from related classes in the framework)
262
- *
263
268
  * This method is called by SAP Fiori elements whenever the busy state is switched off. Application developers
264
269
  * can override this method, access the message model and adapt the transient messages related to the component.
270
+ *
271
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
265
272
  */
266
273
  adaptTransientMessageExtension(): void;
267
274
  /**
268
- * @ui5-protected Do not call from applications (only from related classes in the framework)
269
- *
270
275
  * This method is called by SAP Fiori elements when a smart link in a table is clicked. Application developers
271
276
  * can override this method and invoke the oParams.getSourceInfo method to find out the information about
272
277
  * the clicked smart link.
@@ -274,6 +279,8 @@ declare namespace sap {
274
279
  * If the application expect the framework should not handle the `beforePopoverOpens` event, then this method
275
280
  * should return true. Otherwise, framework will proceed with its handling.
276
281
  *
282
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
283
+ *
277
284
  * @returns Method should return `true` if framework should not handle `beforePopoverOpens` event (that
278
285
  * means: extension code will handle the event)
279
286
  */
@@ -293,12 +300,12 @@ declare namespace sap {
293
300
  }
294
301
  ): boolean;
295
302
  /**
296
- * @ui5-protected Do not call from applications (only from related classes in the framework)
297
- *
298
303
  * This method is called by SAP Fiori elements before persisting the AppState. Application developers can
299
304
  * override this method for persisting the state of custom controls. State of the custom control (controls)
300
305
  * should be stored in the oCustomData passed as a parameter to this method. To make a complete functionality,
301
306
  * this method should be overridden with `restoreCustomAppStateDataExtension`.
307
+ *
308
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
302
309
  */
303
310
  getCustomAppStateDataExtension(
304
311
  /**
@@ -307,26 +314,26 @@ declare namespace sap {
307
314
  oCustomData: object
308
315
  ): void;
309
316
  /**
310
- * @ui5-protected Do not call from applications (only from related classes in the framework)
311
- *
312
317
  * This method is called in the AppState creation lifecycle. Application developers can override this method,
313
318
  * return an array of all selection fields set on SmartFilterBar using custom code as default and doesn't
314
319
  * really want to store as part of the AppState. SAP Fiori elements framework will remove these filter properties
315
320
  * from the selection variant.
316
321
  *
322
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
323
+ *
317
324
  * @returns - Properties which are visible and should not be stored as part of the selection variant in
318
325
  * the AppState
319
326
  */
320
327
  getVisibleSelectionsWithDefaults(): any[];
321
328
  /**
322
- * @ui5-protected Do not call from applications (only from related classes in the framework)
323
- *
324
329
  * This method is called by SAP Fiori elements in the startup life cycle of a component. Application developers
325
330
  * can override this method and modify the startup object. For an example, when the application is started,
326
331
  * the selection variant might contain some properties that are not required for this app. Such properties
327
332
  * can be removed from the selection variant. The reverse use case is also true, where some additional properties
328
333
  * needs to be added with certain fixed values. This can be achieved by adding these values to the selection
329
334
  * variant.
335
+ *
336
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
330
337
  */
331
338
  modifyStartupExtension(
332
339
  /**
@@ -344,13 +351,13 @@ declare namespace sap {
344
351
  }
345
352
  ): void;
346
353
  /**
347
- * @ui5-protected Do not call from applications (only from related classes in the framework)
348
- *
349
354
  * This method is called by SAP Fiori elements when the table data is getting exported. Application developers
350
355
  * can override this method to add/remove the filters in the exported file.
351
356
  *
352
357
  * To add new filter entries to the exported file, create an instance of {@link sap.ui.export.util.Filter }
353
358
  * and add it to "oExportParams.filterSettings"
359
+ *
360
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
354
361
  */
355
362
  onBeforeExportTableExtension(
356
363
  /**
@@ -369,13 +376,13 @@ declare namespace sap {
369
376
  }
370
377
  ): void;
371
378
  /**
372
- * @ui5-protected Do not call from applications (only from related classes in the framework)
373
- *
374
379
  * This method is called by SAP Fiori elements before binding a chart. Application developers can override
375
380
  * this method and programmatically modify parameters or filters before chart triggers a query to retrieve
376
381
  * data.
377
382
  *
378
383
  * **Note: **This method is called only when a chart is rebound, and not when it is refreshed.
384
+ *
385
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
379
386
  */
380
387
  onBeforeRebindChartExtension(
381
388
  /**
@@ -384,10 +391,10 @@ declare namespace sap {
384
391
  oEvent: sap.ui.base.Event
385
392
  ): void;
386
393
  /**
387
- * @ui5-protected Do not call from applications (only from related classes in the framework)
388
- *
389
394
  * This method is called by SAP Fiori elements before binding a filterable KPI. Application developers can
390
395
  * override this method to modify parameters or filters for a filterable KPI.
396
+ *
397
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
391
398
  */
392
399
  onBeforeRebindFilterableKPIExtension(
393
400
  /**
@@ -404,13 +411,13 @@ declare namespace sap {
404
411
  sKPIId: string
405
412
  ): void;
406
413
  /**
407
- * @ui5-protected Do not call from applications (only from related classes in the framework)
408
- *
409
414
  * This method is called by SAP Fiori elements before binding a table. Application developers can override
410
415
  * this method and programmatically modify parameters or filters before the table triggers a query to retrieve
411
416
  * data.
412
417
  *
413
418
  * **Note: **This method is called only when a table is rebound, and not when it is refreshed.
419
+ *
420
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
414
421
  */
415
422
  onBeforeRebindTableExtension(
416
423
  /**
@@ -419,12 +426,12 @@ declare namespace sap {
419
426
  oEvent: sap.ui.base.Event
420
427
  ): void;
421
428
  /**
422
- * @ui5-protected Do not call from applications (only from related classes in the framework)
423
- *
424
429
  * This method is called by SAP Fiori elements before binding a visual filter. Application developers can
425
430
  * override this method and programmatically modify parameters, filters, or influence sorting before the
426
431
  * chart triggers a query to retrieve data. Application developers can also access incoming navigation contexts
427
432
  * of the app through `getNavigationContext` API.
433
+ *
434
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
428
435
  */
429
436
  onBeforeRebindVisualFilterExtension(
430
437
  /**
@@ -463,13 +470,13 @@ declare namespace sap {
463
470
  }
464
471
  ): void;
465
472
  /**
466
- * @ui5-protected Do not call from applications (only from related classes in the framework)
467
- *
468
473
  * This method should be implemented whenever application uses onListNavigationExtension for internal navigation.
469
474
  * In this case the implementation of this method should provide an 'inverse' mapping to the transformation
470
475
  * implemented within onListNavigationExtension. More precisely, the identification of a child page instance
471
476
  * is passed to this function. The implementation of this function should provide information about the
472
477
  * list item which has triggered the opening of the child page.
478
+ *
479
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
473
480
  */
474
481
  onChildOpenedExtension(
475
482
  /**
@@ -496,10 +503,10 @@ declare namespace sap {
496
503
  fnSetPath: Function
497
504
  ): void;
498
505
  /**
499
- * @ui5-protected Do not call from applications (only from related classes in the framework)
500
- *
501
506
  * This method is called by SAP Fiori elements when the Clear button on the filter dialog is clicked. Application
502
507
  * developers can override this method to clear custom filters.
508
+ *
509
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
503
510
  */
504
511
  onClearFilterExtension(
505
512
  /**
@@ -508,18 +515,18 @@ declare namespace sap {
508
515
  oEvent: sap.ui.base.Event
509
516
  ): void;
510
517
  /**
511
- * @ui5-protected Do not call from applications (only from related classes in the framework)
512
- *
513
518
  * This method is called by Fiori elements on the initialization of View. Application developers can override
514
519
  * this method & perform internal setup in this hook.
520
+ *
521
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
515
522
  */
516
523
  onInit(): void;
517
524
  /**
518
- * @ui5-protected Do not call from applications (only from related classes in the framework)
519
- *
520
525
  * This method is called by SAP Fiori elements once the smart filter bar is initialized with a variant.
521
526
  * Application developers can override this method when there is a custom filter field bound outside the
522
527
  * standard model.
528
+ *
529
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
523
530
  */
524
531
  onInitSmartFilterBarExtension(
525
532
  /**
@@ -528,12 +535,12 @@ declare namespace sap {
528
535
  oEvent: sap.ui.base.Event
529
536
  ): void;
530
537
  /**
531
- * @ui5-protected Do not call from applications (only from related classes in the framework)
532
- *
533
538
  * This method is called when the user leaves the app and this page has been displayed within the same app
534
539
  * session (this is the time since last opening the app) at least once. Moreover, it is called for all pages
535
540
  * that have been displayed within some app session when the app is finally destroyed.
536
541
  *
542
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
543
+ *
537
544
  * @returns - Only relevant in case that `isDestroyed` is false. In this case Application developers can
538
545
  * provide a function to be called when the same page is opened again (after the user has navigated back
539
546
  * to the app).
@@ -546,12 +553,12 @@ declare namespace sap {
546
553
  bIsDestroyed: boolean
547
554
  ): Function;
548
555
  /**
549
- * @ui5-protected Do not call from applications (only from related classes in the framework)
550
- *
551
556
  * This method is called by SAP Fiori elements when a chevron navigation is triggered from a table. Application
552
557
  * developers can override this method and perform conditional (internal or external) navigation from different
553
558
  * rows of a table. Such custom navigation should be triggered via corresponding methods of {@link sap.suite.ui.generic.template.extensionAPI.NavigationController NavigationController}.
554
559
  *
560
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
561
+ *
555
562
  * @returns Method should return `true` if framework navigation should be suppressed (that means: extension
556
563
  * code has taken over navigation)
557
564
  */
@@ -572,11 +579,11 @@ declare namespace sap {
572
579
  bReplaceInHistory: boolean
573
580
  ): boolean;
574
581
  /**
575
- * @ui5-protected Do not call from applications (only from related classes in the framework)
576
- *
577
582
  * This method is called by SAP Fiori elements when the Share functionality is triggered. Application developers
578
583
  * can adapt the service URL passed as a parameter to this method. Adapted service URL will be used in the
579
584
  * 'Send Email' or 'Save as Tile' options.
585
+ *
586
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
580
587
  */
581
588
  onSaveAsTileExtension(
582
589
  /**
@@ -590,12 +597,12 @@ declare namespace sap {
590
597
  }
591
598
  ): void;
592
599
  /**
593
- * @ui5-protected Do not call from applications (only from related classes in the framework)
594
- *
595
600
  * This method is called by SAP Fiori elements while applying the AppState. This method should be overridden
596
601
  * with `getCustomAppStateDataExtension`. The custom data retrieved from the AppState will be passed as
597
602
  * a parameter to this method. Application developers can use this custom data to restore the state of the
598
603
  * custom control.
604
+ *
605
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
599
606
  */
600
607
  restoreCustomAppStateDataExtension(
601
608
  /**
@@ -621,6 +628,7 @@ declare namespace sap {
621
628
  *
622
629
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
623
630
  *
631
+ *
624
632
  * @returns Created class / constructor function
625
633
  */
626
634
  static extend<T extends Record<string, unknown>>(
@@ -644,13 +652,14 @@ declare namespace sap {
644
652
  /**
645
653
  * Returns a metadata object for class sap.suite.ui.generic.template.Canvas.extensionAPI.ExtensionAPI.
646
654
  *
655
+ *
647
656
  * @returns Metadata object describing this class
648
657
  */
649
658
  static getMetadata(): sap.ui.base.Metadata;
650
659
  /**
651
660
  * Can be used to add the standard footer bar for detail pages to this canvas page. It also allows to pass
652
661
  * an array of buttons to be added to the footer. Note that the usage of the standard footer bar must have
653
- * been switched on in the settings of the page
662
+ * been switched on in the settings of the page.
654
663
  */
655
664
  addFooterBarToPage(
656
665
  /**
@@ -695,14 +704,19 @@ declare namespace sap {
695
704
  fnFunction: Function
696
705
  ): void;
697
706
  /**
698
- * Get the Flexible Column Layout Action Buttons(Fullscreen, Exit Fullscreen and Close).
707
+ * Get the Flexible Column Layout Action Buttons (Fullscreen, Exit Fullscreen and Close). Note that the
708
+ * usage of the Flexible Column Layout Action Buttons must have been switched on in the settings of the
709
+ * page.
710
+ *
699
711
  *
700
- * @returns Flexible Column Layout Action Buttons
712
+ * @returns Flexible Column Layout Action Buttons (resp. `undefined` when no FCL Action Buttons should be
713
+ * shown on this page)
701
714
  */
702
715
  getFlexibleColumnLayoutActionButtons(): object;
703
716
  /**
704
717
  * Get the navigation controller for navigation actions
705
718
  *
719
+ *
706
720
  * @returns the navigation controller
707
721
  */
708
722
  getNavigationController(): sap.suite.ui.generic.template.extensionAPI.NavigationController;
@@ -710,6 +724,7 @@ declare namespace sap {
710
724
  * Get the transaction controller for editing actions on the page. Note that the methods provided by this
711
725
  * transaction controller depend on whether the object supports drafts or not.
712
726
  *
727
+ *
713
728
  * @returns the transaction controller
714
729
  */
715
730
  getTransactionController():
@@ -718,6 +733,7 @@ declare namespace sap {
718
733
  /**
719
734
  * Invokes multiple time the action with the given name and submits changes to the back-end.
720
735
  *
736
+ *
721
737
  * @returns A `Promise` for asynchronous execution of the action, resolving to the same result as the `Promise`
722
738
  * returned from {@link sap.ui.generic.app.ApplicationController#invokeActions}
723
739
  */
@@ -777,6 +793,7 @@ declare namespace sap {
777
793
  * See:
778
794
  * {@link https://ui5.sap.com/#/topic/6a39150ad3e548a8b5304d32d560790a Using the SecuredExecutionMethod}
779
795
  *
796
+ *
780
797
  * @returns A `Promise` that is rejected, if execution is prohibited, and settled equivalent to the one
781
798
  * returned by fnFunction.
782
799
  */
@@ -857,6 +874,7 @@ declare namespace sap {
857
874
  * ...
858
875
  * });`
859
876
  *
877
+ *
860
878
  * @returns A `Promise` which resolves to the extension API for the embedding SAP Fiori elements view
861
879
  */
862
880
  getExtensionAPIPromise(
@@ -958,6 +976,7 @@ declare namespace sap {
958
976
  *
959
977
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
960
978
  *
979
+ *
961
980
  * @returns Created class / constructor function
962
981
  */
963
982
  static extend<T extends Record<string, unknown>>(
@@ -981,6 +1000,7 @@ declare namespace sap {
981
1000
  /**
982
1001
  * Returns a metadata object for class sap.suite.ui.generic.template.extensionAPI.NavigationController.
983
1002
  *
1003
+ *
984
1004
  * @returns Metadata object describing this class
985
1005
  */
986
1006
  static getMetadata(): sap.ui.base.Metadata;
@@ -1147,7 +1167,7 @@ declare namespace sap {
1147
1167
  /**
1148
1168
  * Smart Templates Application Component
1149
1169
  */
1150
- class AppComponent extends sap.ui.core.UIComponent {
1170
+ abstract class AppComponent extends sap.ui.core.UIComponent {
1151
1171
  /**
1152
1172
  * Main class used for Smart Template(Fiori elements V2) Application Component
1153
1173
  *
@@ -1163,6 +1183,7 @@ declare namespace sap {
1163
1183
  *
1164
1184
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.UIComponent.extend}.
1165
1185
  *
1186
+ *
1166
1187
  * @returns Created class / constructor function
1167
1188
  */
1168
1189
  static extend<T extends Record<string, unknown>>(
@@ -1186,6 +1207,7 @@ declare namespace sap {
1186
1207
  /**
1187
1208
  * Returns a metadata object for class sap.suite.ui.generic.template.lib.AppComponent.
1188
1209
  *
1210
+ *
1189
1211
  * @returns Metadata object describing this class
1190
1212
  */
1191
1213
  static getMetadata(): sap.ui.core.ComponentMetadata;
@@ -1196,6 +1218,7 @@ declare namespace sap {
1196
1218
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1197
1219
  * otherwise it will be bound to this `sap.suite.ui.generic.template.lib.AppComponent` itself.
1198
1220
  *
1221
+ *
1199
1222
  * @returns Reference to `this` in order to allow method chaining
1200
1223
  */
1201
1224
  attachPageDataLoaded(
@@ -1221,6 +1244,7 @@ declare namespace sap {
1221
1244
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1222
1245
  * otherwise it will be bound to this `sap.suite.ui.generic.template.lib.AppComponent` itself.
1223
1246
  *
1247
+ *
1224
1248
  * @returns Reference to `this` in order to allow method chaining
1225
1249
  */
1226
1250
  attachPageDataLoaded(
@@ -1240,6 +1264,7 @@ declare namespace sap {
1240
1264
  *
1241
1265
  * The passed function and listener object must match the ones used for event registration.
1242
1266
  *
1267
+ *
1243
1268
  * @returns Reference to `this` in order to allow method chaining
1244
1269
  */
1245
1270
  detachPageDataLoaded(
@@ -1253,10 +1278,10 @@ declare namespace sap {
1253
1278
  oListener?: object
1254
1279
  ): this;
1255
1280
  /**
1256
- * @ui5-protected Do not call from applications (only from related classes in the framework)
1257
- *
1258
1281
  * Fires event {@link #event:pageDataLoaded pageDataLoaded} to attached listeners.
1259
1282
  *
1283
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1284
+ *
1260
1285
  * @returns Reference to `this` in order to allow method chaining
1261
1286
  */
1262
1287
  firePageDataLoaded(
@@ -1270,6 +1295,7 @@ declare namespace sap {
1270
1295
  *
1271
1296
  * Default value is `...see text or source`.
1272
1297
  *
1298
+ *
1273
1299
  * @returns Value of property `collaborationSettings`
1274
1300
  */
1275
1301
  getCollaborationSettings(): object;
@@ -1278,6 +1304,7 @@ declare namespace sap {
1278
1304
  *
1279
1305
  * Default value is `false`.
1280
1306
  *
1307
+ *
1281
1308
  * @returns Value of property `considerAnalyticalParameters`
1282
1309
  */
1283
1310
  getConsiderAnalyticalParameters(): boolean;
@@ -1286,6 +1313,7 @@ declare namespace sap {
1286
1313
  *
1287
1314
  * Default value is `...see text or source`.
1288
1315
  *
1316
+ *
1289
1317
  * @returns Value of property `draftDiscardConfirmationSettings`
1290
1318
  */
1291
1319
  getDraftDiscardConfirmationSettings(): object;
@@ -1294,12 +1322,14 @@ declare namespace sap {
1294
1322
  *
1295
1323
  * Default value is `true`.
1296
1324
  *
1325
+ *
1297
1326
  * @returns Value of property `enableAutoColumnWidthForSmartTable`
1298
1327
  */
1299
1328
  getEnableAutoColumnWidthForSmartTable(): boolean;
1300
1329
  /**
1301
1330
  * Gets current value of property {@link #getFlexibleColumnLayout flexibleColumnLayout}.
1302
1331
  *
1332
+ *
1303
1333
  * @returns Value of property `flexibleColumnLayout`
1304
1334
  */
1305
1335
  getFlexibleColumnLayout(): object;
@@ -1308,18 +1338,21 @@ declare namespace sap {
1308
1338
  *
1309
1339
  * Default value is `false`.
1310
1340
  *
1341
+ *
1311
1342
  * @returns Value of property `forceGlobalRefresh`
1312
1343
  */
1313
1344
  getForceGlobalRefresh(): boolean;
1314
1345
  /**
1315
1346
  * Gets current value of property {@link #getInboundParameters inboundParameters}.
1316
1347
  *
1348
+ *
1317
1349
  * @returns Value of property `inboundParameters`
1318
1350
  */
1319
1351
  getInboundParameters(): object;
1320
1352
  /**
1321
1353
  * Gets current value of property {@link #getObjectPageColumns objectPageColumns}.
1322
1354
  *
1355
+ *
1323
1356
  * @returns Value of property `objectPageColumns`
1324
1357
  */
1325
1358
  getObjectPageColumns(): object;
@@ -1328,6 +1361,7 @@ declare namespace sap {
1328
1361
  *
1329
1362
  * Default value is `"Static"`.
1330
1363
  *
1364
+ *
1331
1365
  * @returns Value of property `objectPageHeaderType`
1332
1366
  */
1333
1367
  getObjectPageHeaderType(): string;
@@ -1336,6 +1370,7 @@ declare namespace sap {
1336
1370
  *
1337
1371
  * Default value is `"None"`.
1338
1372
  *
1373
+ *
1339
1374
  * @returns Value of property `objectPageVariantManagement`
1340
1375
  */
1341
1376
  getObjectPageVariantManagement(): string;
@@ -1344,6 +1379,7 @@ declare namespace sap {
1344
1379
  *
1345
1380
  * Default value is `true`.
1346
1381
  *
1382
+ *
1347
1383
  * @returns Value of property `showDraftToggle`
1348
1384
  */
1349
1385
  getShowDraftToggle(): boolean;
@@ -1352,6 +1388,7 @@ declare namespace sap {
1352
1388
  *
1353
1389
  * Default value is `"auto"`.
1354
1390
  *
1391
+ *
1355
1392
  * @returns Value of property `statePreservationMode`
1356
1393
  */
1357
1394
  getStatePreservationMode(): string;
@@ -1360,6 +1397,7 @@ declare namespace sap {
1360
1397
  *
1361
1398
  * Default value is `"Middle"`.
1362
1399
  *
1400
+ *
1363
1401
  * @returns Value of property `tableColumnVerticalAlignment`
1364
1402
  */
1365
1403
  getTableColumnVerticalAlignment(): string;
@@ -1368,6 +1406,7 @@ declare namespace sap {
1368
1406
  *
1369
1407
  * Default value is `true`.
1370
1408
  *
1409
+ *
1371
1410
  * @returns Value of property `useColumnLayoutForSmartForm`
1372
1411
  */
1373
1412
  getUseColumnLayoutForSmartForm(): boolean;
@@ -1378,6 +1417,7 @@ declare namespace sap {
1378
1417
  *
1379
1418
  * Default value is `...see text or source`.
1380
1419
  *
1420
+ *
1381
1421
  * @returns Reference to `this` in order to allow method chaining
1382
1422
  */
1383
1423
  setCollaborationSettings(
@@ -1393,6 +1433,7 @@ declare namespace sap {
1393
1433
  *
1394
1434
  * Default value is `false`.
1395
1435
  *
1436
+ *
1396
1437
  * @returns Reference to `this` in order to allow method chaining
1397
1438
  */
1398
1439
  setConsiderAnalyticalParameters(
@@ -1408,6 +1449,7 @@ declare namespace sap {
1408
1449
  *
1409
1450
  * Default value is `...see text or source`.
1410
1451
  *
1452
+ *
1411
1453
  * @returns Reference to `this` in order to allow method chaining
1412
1454
  */
1413
1455
  setDraftDiscardConfirmationSettings(
@@ -1423,6 +1465,7 @@ declare namespace sap {
1423
1465
  *
1424
1466
  * Default value is `true`.
1425
1467
  *
1468
+ *
1426
1469
  * @returns Reference to `this` in order to allow method chaining
1427
1470
  */
1428
1471
  setEnableAutoColumnWidthForSmartTable(
@@ -1436,6 +1479,7 @@ declare namespace sap {
1436
1479
  *
1437
1480
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1438
1481
  *
1482
+ *
1439
1483
  * @returns Reference to `this` in order to allow method chaining
1440
1484
  */
1441
1485
  setFlexibleColumnLayout(
@@ -1451,6 +1495,7 @@ declare namespace sap {
1451
1495
  *
1452
1496
  * Default value is `false`.
1453
1497
  *
1498
+ *
1454
1499
  * @returns Reference to `this` in order to allow method chaining
1455
1500
  */
1456
1501
  setForceGlobalRefresh(
@@ -1464,6 +1509,7 @@ declare namespace sap {
1464
1509
  *
1465
1510
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1466
1511
  *
1512
+ *
1467
1513
  * @returns Reference to `this` in order to allow method chaining
1468
1514
  */
1469
1515
  setInboundParameters(
@@ -1477,6 +1523,7 @@ declare namespace sap {
1477
1523
  *
1478
1524
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1479
1525
  *
1526
+ *
1480
1527
  * @returns Reference to `this` in order to allow method chaining
1481
1528
  */
1482
1529
  setObjectPageColumns(
@@ -1492,6 +1539,7 @@ declare namespace sap {
1492
1539
  *
1493
1540
  * Default value is `"Static"`.
1494
1541
  *
1542
+ *
1495
1543
  * @returns Reference to `this` in order to allow method chaining
1496
1544
  */
1497
1545
  setObjectPageHeaderType(
@@ -1507,6 +1555,7 @@ declare namespace sap {
1507
1555
  *
1508
1556
  * Default value is `"None"`.
1509
1557
  *
1558
+ *
1510
1559
  * @returns Reference to `this` in order to allow method chaining
1511
1560
  */
1512
1561
  setObjectPageVariantManagement(
@@ -1522,6 +1571,7 @@ declare namespace sap {
1522
1571
  *
1523
1572
  * Default value is `true`.
1524
1573
  *
1574
+ *
1525
1575
  * @returns Reference to `this` in order to allow method chaining
1526
1576
  */
1527
1577
  setShowDraftToggle(
@@ -1537,6 +1587,7 @@ declare namespace sap {
1537
1587
  *
1538
1588
  * Default value is `"auto"`.
1539
1589
  *
1590
+ *
1540
1591
  * @returns Reference to `this` in order to allow method chaining
1541
1592
  */
1542
1593
  setStatePreservationMode(
@@ -1552,6 +1603,7 @@ declare namespace sap {
1552
1603
  *
1553
1604
  * Default value is `"Middle"`.
1554
1605
  *
1606
+ *
1555
1607
  * @returns Reference to `this` in order to allow method chaining
1556
1608
  */
1557
1609
  setTableColumnVerticalAlignment(
@@ -1567,6 +1619,7 @@ declare namespace sap {
1567
1619
  *
1568
1620
  * Default value is `true`.
1569
1621
  *
1622
+ *
1570
1623
  * @returns Reference to `this` in order to allow method chaining
1571
1624
  */
1572
1625
  setUseColumnLayoutForSmartForm(
@@ -1598,6 +1651,7 @@ declare namespace sap {
1598
1651
  *
1599
1652
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
1600
1653
  *
1654
+ *
1601
1655
  * @returns Created class / constructor function
1602
1656
  */
1603
1657
  static extend<T extends Record<string, unknown>>(
@@ -1621,6 +1675,7 @@ declare namespace sap {
1621
1675
  /**
1622
1676
  * Returns a metadata object for class sap.suite.ui.generic.template.ListReport.extensionAPI.ExtensionAPI.
1623
1677
  *
1678
+ *
1624
1679
  * @returns Metadata object describing this class
1625
1680
  */
1626
1681
  static getMetadata(): sap.ui.base.Metadata;
@@ -1638,20 +1693,22 @@ declare namespace sap {
1638
1693
  /**
1639
1694
  * Get the navigation controller for navigation actions
1640
1695
  *
1696
+ *
1641
1697
  * @returns the navigation controller
1642
1698
  */
1643
1699
  getNavigationController(): sap.suite.ui.generic.template.extensionAPI.NavigationController;
1644
1700
  /**
1645
- * @experimental
1646
- *
1647
1701
  * If switching between different table views is enabled, this function returns the selected key.
1648
1702
  *
1703
+ * @experimental
1704
+ *
1649
1705
  * @returns The key of the variant item that is currently selected.
1650
1706
  */
1651
1707
  getQuickVariantSelectionKey(): string;
1652
1708
  /**
1653
1709
  * Get the list entries currently selected for smart table
1654
1710
  *
1711
+ *
1655
1712
  * @returns contains one entry per line selected
1656
1713
  */
1657
1714
  getSelectedContexts(): sap.ui.model.Context[];
@@ -1659,12 +1716,14 @@ declare namespace sap {
1659
1716
  * Get the transaction controller for editing actions on the list. Note: Currently implemented for non draft
1660
1717
  * case
1661
1718
  *
1719
+ *
1662
1720
  * @returns the transaction controller
1663
1721
  */
1664
1722
  getTransactionController(): sap.suite.ui.generic.template.ListReport.extensionAPI.NonDraftTransactionController;
1665
1723
  /**
1666
1724
  * Invokes multiple time the action with the given name and submits changes to the back-end.
1667
1725
  *
1726
+ *
1668
1727
  * @returns A `Promise` for asynchronous execution of the action, resolving to the same result as the `Promise`
1669
1728
  * returned from {@link sap.ui.generic.app.ApplicationController#invokeActions}
1670
1729
  */
@@ -1726,6 +1785,7 @@ declare namespace sap {
1726
1785
  * Secured execution of the given function. Ensures that the function is only executed when certain conditions
1727
1786
  * are fulfilled. For more information, see {@link https://ui5.sap.com/#/topic/6a39150ad3e548a8b5304d32d560790a Using the SecuredExecutionMethod}.
1728
1787
  *
1788
+ *
1729
1789
  * @returns A `Promise` that is rejected, if execution is prohibited, and settled equivalent to the one
1730
1790
  * returned by fnFunction.
1731
1791
  */
@@ -1814,9 +1874,9 @@ declare namespace sap {
1814
1874
  onClose?: Function
1815
1875
  ): void;
1816
1876
  /**
1817
- * @experimental
1818
- *
1819
1877
  * If switching between different table views is enabled, this function sets the selected key.
1878
+ *
1879
+ * @experimental
1820
1880
  */
1821
1881
  setQuickVariantSelectionKey(
1822
1882
  /**
@@ -1841,6 +1901,7 @@ declare namespace sap {
1841
1901
  *
1842
1902
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
1843
1903
  *
1904
+ *
1844
1905
  * @returns Created class / constructor function
1845
1906
  */
1846
1907
  static extend<T extends Record<string, unknown>>(
@@ -1864,6 +1925,7 @@ declare namespace sap {
1864
1925
  /**
1865
1926
  * Returns a metadata object for class sap.suite.ui.generic.template.ListReport.extensionAPI.NonDraftTransactionController.
1866
1927
  *
1928
+ *
1867
1929
  * @returns Metadata object describing this class
1868
1930
  */
1869
1931
  static getMetadata(): sap.ui.base.Metadata;
@@ -1874,6 +1936,7 @@ declare namespace sap {
1874
1936
  /**
1875
1937
  * This method can be called when a new entry with predefined values should be created (e.g. in a copy scenario).
1876
1938
  *
1939
+ *
1877
1940
  * @returns a context representing the object to be created. It can be passed to {@link sap.suite.ui.generic.template.extensionAPI.NavigationController#navigateInternal }
1878
1941
  * in order to visit the corresponding object page.
1879
1942
  */
@@ -1903,6 +1966,7 @@ declare namespace sap {
1903
1966
  * and doesn't execute if application is already busy when called (i.e. don't use `ExtensionAPI.securedExecution`
1904
1967
  * to call this method).
1905
1968
  *
1969
+ *
1906
1970
  * @returns is resolved when entry is successfully saved and rejected when saving fails
1907
1971
  */
1908
1972
  save(): Promise<any>;
@@ -1914,8 +1978,6 @@ declare namespace sap {
1914
1978
  */
1915
1979
  interface controllerFrameworkExtensions {
1916
1980
  /**
1917
- * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1918
- *
1919
1981
  * Obsolete and not called anymore. Kept here to avoid conflicts (in the very unlikely case, Fiori elements
1920
1982
  * would come up with the idea to invent a new extension method with the exact same name some day in future,
1921
1983
  * and any application would still have an implementation for this old extension).
@@ -1934,16 +1996,18 @@ declare namespace sap {
1934
1996
  * to do that would only be found in very exceptional cases). With the newer API of SFB (getUiState and
1935
1997
  * setUiState), this problem has been overcome (esp. as setUiState overrides all filters, not only the ones
1936
1998
  * provided).)
1999
+ *
2000
+ * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1937
2001
  */
1938
2002
  getVisibleSelectionsWithDefaults: undefined;
1939
2003
 
1940
2004
  /**
1941
- * @ui5-protected Do not call from applications (only from related classes in the framework)
1942
- *
1943
2005
  * This method is called by SAP Fiori elements before triggering an external navigation. Application developers
1944
2006
  * can override this method and programmatically adapt the parameters which are passed to the target application.
1945
2007
  * Application developers can use the oObjectInfo parameter to identify the navigation context and modify
1946
2008
  * the oSelectionVariant which contains the navigation parameters.
2009
+ *
2010
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1947
2011
  */
1948
2012
  adaptNavigationParameterExtension(
1949
2013
  /**
@@ -1965,20 +2029,20 @@ declare namespace sap {
1965
2029
  }
1966
2030
  ): void;
1967
2031
  /**
1968
- * @ui5-protected Do not call from applications (only from related classes in the framework)
1969
- *
1970
2032
  * This method is called by SAP Fiori elements whenever the busy state is switched off. Application developers
1971
2033
  * can override this method, access the message model and adapt the transient messages related to the component.
2034
+ *
2035
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1972
2036
  */
1973
2037
  adaptTransientMessageExtension(): void;
1974
2038
  /**
1975
- * @ui5-protected Do not call from applications (only from related classes in the framework)
1976
- *
1977
2039
  * This method is called by SAP Fiori elements when the delete operation is triggered. Application developers
1978
2040
  * can override this method in controller extension & perform additional checks before executing the delete
1979
2041
  * operation. Method is expected to return a Promise. To veto the delete operation, promise needs to be
1980
2042
  * rejected else resolved.
1981
2043
  *
2044
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2045
+ *
1982
2046
  * @returns - Promise object created by the extension, used for Delete operation chaining
1983
2047
  */
1984
2048
  beforeDeleteExtension(
@@ -1993,14 +2057,14 @@ declare namespace sap {
1993
2057
  }
1994
2058
  ): Promise<any>;
1995
2059
  /**
1996
- * @ui5-protected Do not call from applications (only from related classes in the framework)
1997
- *
1998
2060
  * This method should be implemented whenever the application needs to have a custom save functionality
1999
2061
  * for multi edit scenario. The logic for save should be defined here and this method should return a promise
2000
2062
  * based on whose resolution or rejection the framework would perform cleanup tasks like closing the dialog
2001
2063
  * and refreshing the table data.There will be no chaining of multi edit save from the framework, if the
2002
2064
  * extension is implemented then the framework will only execute extension code for save.
2003
2065
  *
2066
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2067
+ *
2004
2068
  * @returns - Promise object created by the extension, used for cleanup after the promise is resolved or
2005
2069
  * rejected.
2006
2070
  */
@@ -2020,8 +2084,6 @@ declare namespace sap {
2020
2084
  }>
2021
2085
  ): Promise<any>;
2022
2086
  /**
2023
- * @ui5-protected Do not call from applications (only from related classes in the framework)
2024
- *
2025
2087
  * This method is called by SAP Fiori elements when a smart link in a table is clicked. Application developers
2026
2088
  * can override this method and invoke the oParams.getSourceInfo method to find out the information about
2027
2089
  * the clicked smart link.
@@ -2029,6 +2091,8 @@ declare namespace sap {
2029
2091
  * If the application expect the framework should not handle the `beforePopoverOpens` event, then this method
2030
2092
  * should return true. Otherwise, framework will proceed with its handling.
2031
2093
  *
2094
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2095
+ *
2032
2096
  * @returns Method should return `true` if framework should not handle `beforePopoverOpens` event (that
2033
2097
  * means: extension code will handle the event)
2034
2098
  */
@@ -2048,8 +2112,6 @@ declare namespace sap {
2048
2112
  }
2049
2113
  ): boolean;
2050
2114
  /**
2051
- * @ui5-protected Do not call from applications (only from related classes in the framework)
2052
- *
2053
2115
  * This method is called by SAP Fiori elements before persisting the AppState. Application developers can
2054
2116
  * override this method for persisting the state of custom controls. State of the custom control (controls)
2055
2117
  * should be stored in the oCustomData passed as a parameter to this method. To make a complete functionality,
@@ -2069,6 +2131,8 @@ declare namespace sap {
2069
2131
  * contained looks quite similar to the iAppState.)
2070
2132
  *
2071
2133
  * For more information, see {@link https://ui5.sap.com/#/topic/5fb9f57fcf12401bbe39a635e9a32a4e Adding Custom Fields to the Filter Bar}.
2134
+ *
2135
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2072
2136
  */
2073
2137
  getCustomAppStateDataExtension(
2074
2138
  /**
@@ -2077,8 +2141,6 @@ declare namespace sap {
2077
2141
  oCustomData: object
2078
2142
  ): void;
2079
2143
  /**
2080
- * @ui5-protected Do not call from applications (only from related classes in the framework)
2081
- *
2082
2144
  * This method is called by SAP Fiori elements when the Create with Filters is executed. Application developers
2083
2145
  * can enable this feature in the LR component by adding createWithFilters in the settings object of the
2084
2146
  * List Report component & strategy needs to be set as `extension`. SmartFilterBar instance will be passed
@@ -2086,6 +2148,8 @@ declare namespace sap {
2086
2148
  * the returning object map. Application developers will have complete control on properties passed to the
2087
2149
  * new instance creation.
2088
2150
  *
2151
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2152
+ *
2089
2153
  * @returns Key/Value map of the properties
2090
2154
  */
2091
2155
  getPredefinedValuesForCreateExtension(
@@ -2099,14 +2163,14 @@ declare namespace sap {
2099
2163
  oDefaultValues: object
2100
2164
  ): Map<any, any>;
2101
2165
  /**
2102
- * @ui5-protected Do not call from applications (only from related classes in the framework)
2103
- *
2104
2166
  * This method is called by SAP Fiori elements in the startup life cycle of a component. Application developers
2105
2167
  * can override this method and modify the startup object. For an example, when the application is started,
2106
2168
  * the selection variant might contain some properties that are not required for this app. Such properties
2107
2169
  * can be removed from the selection variant. The reverse use case is also true, where some additional properties
2108
2170
  * needs to be added with certain fixed values. This can be achieved by adding these values to the selection
2109
2171
  * variant.
2172
+ *
2173
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2110
2174
  */
2111
2175
  modifyStartupExtension(
2112
2176
  /**
@@ -2132,13 +2196,13 @@ declare namespace sap {
2132
2196
  }
2133
2197
  ): void;
2134
2198
  /**
2135
- * @ui5-protected Do not call from applications (only from related classes in the framework)
2136
- *
2137
2199
  * This method is called by SAP Fiori elements when the table data is getting exported. Application developers
2138
2200
  * can override this method to add/remove the filters in the exported file.
2139
2201
  *
2140
2202
  * To add new filter entries to the exported file, create an instance of {@link sap.ui.export.util.Filter }
2141
2203
  * and add it to "oExportParams.filterSettings"
2204
+ *
2205
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2142
2206
  */
2143
2207
  onBeforeExportTableExtension(
2144
2208
  /**
@@ -2157,8 +2221,6 @@ declare namespace sap {
2157
2221
  }
2158
2222
  ): void;
2159
2223
  /**
2160
- * @ui5-protected Do not call from applications (only from related classes in the framework)
2161
- *
2162
2224
  * This method is called by SAP Fiori elements before binding a chart. Application developers can override
2163
2225
  * this method and programmatically modify parameters or filters before chart triggers a query to retrieve
2164
2226
  * data.
@@ -2166,6 +2228,8 @@ declare namespace sap {
2166
2228
  * For more information, see {@link https://ui5.sap.com/#/topic/5fb9f57fcf12401bbe39a635e9a32a4e Adding Custom Fields to the Filter Bar}.
2167
2229
  *
2168
2230
  * **Note: **This method is called only when a chart is rebound, and not when it is refreshed.
2231
+ *
2232
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2169
2233
  */
2170
2234
  onBeforeRebindChartExtension(
2171
2235
  /**
@@ -2174,8 +2238,6 @@ declare namespace sap {
2174
2238
  oEvent: sap.ui.base.Event
2175
2239
  ): void;
2176
2240
  /**
2177
- * @ui5-protected Do not call from applications (only from related classes in the framework)
2178
- *
2179
2241
  * This method is called by SAP Fiori elements before binding a table. Application developers can override
2180
2242
  * this method and programmatically modify parameters or filters before the table triggers a query to retrieve
2181
2243
  * data.
@@ -2183,6 +2245,8 @@ declare namespace sap {
2183
2245
  * For more information, see {@link https://ui5.sap.com/#/topic/5fb9f57fcf12401bbe39a635e9a32a4e Adding Custom Fields to the Filter Bar}.
2184
2246
  *
2185
2247
  * **Note: **This method is called only when a table is rebound, and not when it is refreshed.
2248
+ *
2249
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2186
2250
  */
2187
2251
  onBeforeRebindTableExtension(
2188
2252
  /**
@@ -2191,13 +2255,13 @@ declare namespace sap {
2191
2255
  oEvent: sap.ui.base.Event
2192
2256
  ): void;
2193
2257
  /**
2194
- * @ui5-protected Do not call from applications (only from related classes in the framework)
2195
- *
2196
2258
  * This method should be implemented whenever application uses onListNavigationExtension for internal navigation.
2197
2259
  * In this case the implementation of this method should provide an 'inverse' mapping to the transformation
2198
2260
  * implemented within onListNavigationExtension. More precisely, the identification of a child page instance
2199
2261
  * is passed to this function. The implementation of this function should provide information about the
2200
2262
  * list item which has triggered the opening of the child page.
2263
+ *
2264
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2201
2265
  */
2202
2266
  onChildOpenedExtension(
2203
2267
  /**
@@ -2224,15 +2288,13 @@ declare namespace sap {
2224
2288
  fnSetPath: Function
2225
2289
  ): void;
2226
2290
  /**
2227
- * @ui5-protected Do not call from applications (only from related classes in the framework)
2228
- *
2229
2291
  * This method is called by SAP Fiori elements on the initialization of View. Application developers can
2230
2292
  * override this method & perform internal setup in this hook, It is only called once per View instance.
2293
+ *
2294
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2231
2295
  */
2232
2296
  onInit(): void;
2233
2297
  /**
2234
- * @ui5-protected Do not call from applications (only from related classes in the framework)
2235
- *
2236
2298
  * This method is called by SAP Fiori elements once the smart filter bar is initialized with a variant.
2237
2299
  *
2238
2300
  * Application developers can override this method when there is a custom filter field bound outside the
@@ -2242,6 +2304,8 @@ declare namespace sap {
2242
2304
  * value according to the data type and cannot be provided in the view fragment.
2243
2305
  *
2244
2306
  * For more information, see {@link https://ui5.sap.com/#/topic/5fb9f57fcf12401bbe39a635e9a32a4e Adding Custom Fields to the Filter Bar}.
2307
+ *
2308
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2245
2309
  */
2246
2310
  onInitSmartFilterBarExtension(
2247
2311
  /**
@@ -2250,12 +2314,12 @@ declare namespace sap {
2250
2314
  oEvent: sap.ui.base.Event
2251
2315
  ): void;
2252
2316
  /**
2253
- * @ui5-protected Do not call from applications (only from related classes in the framework)
2254
- *
2255
2317
  * This method is called when the user leaves the app and this page has been displayed within the same app
2256
2318
  * session (this is the time since last opening the app) at least once. Moreover, it is called for all pages
2257
2319
  * that have been displayed within some app session when the app is finally destroyed.
2258
2320
  *
2321
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2322
+ *
2259
2323
  * @returns - Only relevant in case that `isDestroyed` is false. In this case Application developers can
2260
2324
  * provide a function to be called when the same page is opened again (after the user has navigated back
2261
2325
  * to the app).
@@ -2268,12 +2332,12 @@ declare namespace sap {
2268
2332
  bIsDestroyed: boolean
2269
2333
  ): Function;
2270
2334
  /**
2271
- * @ui5-protected Do not call from applications (only from related classes in the framework)
2272
- *
2273
2335
  * This method is called by SAP Fiori elements when a chevron navigation is triggered from a table. Application
2274
2336
  * developers can override this method and perform conditional (internal or external) navigation from different
2275
2337
  * rows of a table. Such custom navigation should be triggered via corresponding methods of {@link sap.suite.ui.generic.template.extensionAPI.NavigationController NavigationController}.
2276
2338
  *
2339
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2340
+ *
2277
2341
  * @returns Method should return `true` if framework navigation should be suppressed (that means: extension
2278
2342
  * code has taken over navigation)
2279
2343
  */
@@ -2294,11 +2358,11 @@ declare namespace sap {
2294
2358
  bReplaceInHistory: boolean
2295
2359
  ): boolean;
2296
2360
  /**
2297
- * @ui5-protected Do not call from applications (only from related classes in the framework)
2298
- *
2299
2361
  * This method is called by SAP Fiori elements when the Share functionality is triggered. Application developers
2300
2362
  * can adapt the service URL passed as a parameter to this method. Adapted service URL will be used in the
2301
2363
  * 'Send Email' or 'Save as Tile' options.
2364
+ *
2365
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2302
2366
  */
2303
2367
  onSaveAsTileExtension(
2304
2368
  /**
@@ -2312,8 +2376,6 @@ declare namespace sap {
2312
2376
  }
2313
2377
  ): void;
2314
2378
  /**
2315
- * @ui5-protected Do not call from applications (only from related classes in the framework)
2316
- *
2317
2379
  * This method is called by SAP Fiori elements while applying the AppState. This method should be overridden
2318
2380
  * in combination with `getCustomAppStateDataExtension`. The custom data retrieved from the AppState will
2319
2381
  * be passed as a parameter to this method. Application developers can use this custom data to restore the
@@ -2327,6 +2389,8 @@ declare namespace sap {
2327
2389
  * doing anything.
2328
2390
  *
2329
2391
  * For more information, see {@link https://ui5.sap.com/#/topic/5fb9f57fcf12401bbe39a635e9a32a4e Adding Custom Fields to the Filter Bar}.
2392
+ *
2393
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2330
2394
  */
2331
2395
  restoreCustomAppStateDataExtension(
2332
2396
  /**
@@ -2352,6 +2416,7 @@ declare namespace sap {
2352
2416
  *
2353
2417
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
2354
2418
  *
2419
+ *
2355
2420
  * @returns Created class / constructor function
2356
2421
  */
2357
2422
  static extend<T extends Record<string, unknown>>(
@@ -2375,6 +2440,7 @@ declare namespace sap {
2375
2440
  /**
2376
2441
  * Returns a metadata object for class sap.suite.ui.generic.template.ObjectPage.extensionAPI.DraftTransactionController.
2377
2442
  *
2443
+ *
2378
2444
  * @returns Metadata object describing this class
2379
2445
  */
2380
2446
  static getMetadata(): sap.ui.base.Metadata;
@@ -2442,22 +2508,22 @@ declare namespace sap {
2442
2508
  fnFunction: Function
2443
2509
  ): void;
2444
2510
  /**
2445
- * @experimental
2446
- *
2447
2511
  * Cancel the draft. Note that this method only works when you are on the root of a draft. The normal navigation
2448
2512
  * which follows the cancellation of a draft is executed. Moreover, note that executing this method will
2449
2513
  * set the App to be busy. However, it does not ensure, that the method is only called, when the App is
2450
2514
  * currently unbusy. If you want to ensure that, you have to use {@link sap.suite.ui.generic.template.ObjectPage.extensionAPI.ExtensionAPI#securedExecution}.
2451
2515
  *
2516
+ * @experimental
2517
+ *
2452
2518
  * @returns a promise that is resolved when the draft is cancelled, rejected when this is not possible.
2453
2519
  */
2454
2520
  discardDraft(): Function;
2455
2521
  /**
2456
- * @experimental
2457
- *
2458
2522
  * checks if side effects exist for the given properties or entities and executes them. if there are pending
2459
2523
  * changes in the model those pending changes are sent as a patch request with the side effect batch request.
2460
2524
  * If no source property and no source entity is passed a global side effect is executed
2525
+ *
2526
+ * @experimental
2461
2527
  */
2462
2528
  executeSideEffects(
2463
2529
  /**
@@ -2507,6 +2573,7 @@ declare namespace sap {
2507
2573
  *
2508
2574
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
2509
2575
  *
2576
+ *
2510
2577
  * @returns Created class / constructor function
2511
2578
  */
2512
2579
  static extend<T extends Record<string, unknown>>(
@@ -2530,6 +2597,7 @@ declare namespace sap {
2530
2597
  /**
2531
2598
  * Returns a metadata object for class sap.suite.ui.generic.template.ObjectPage.extensionAPI.ExtensionAPI.
2532
2599
  *
2600
+ *
2533
2601
  * @returns Metadata object describing this class
2534
2602
  */
2535
2603
  static getMetadata(): sap.ui.base.Metadata;
@@ -2568,14 +2636,15 @@ declare namespace sap {
2568
2636
  /**
2569
2637
  * Get the navigation controller for navigation actions
2570
2638
  *
2639
+ *
2571
2640
  * @returns the navigation controller
2572
2641
  */
2573
2642
  getNavigationController(): sap.suite.ui.generic.template.extensionAPI.NavigationController;
2574
2643
  /**
2575
- * @experimental
2576
- *
2577
2644
  * This function returns the selected key of selected table of Object Page.
2578
2645
  *
2646
+ * @experimental
2647
+ *
2579
2648
  * @returns The key of variant item that is currently selected section.
2580
2649
  */
2581
2650
  getQuickVariantSelectionKey(
@@ -2587,6 +2656,7 @@ declare namespace sap {
2587
2656
  /**
2588
2657
  * Get the entries currently selected in one ui element (table, chart, or list)
2589
2658
  *
2659
+ *
2590
2660
  * @returns contains one entry per entry selected
2591
2661
  */
2592
2662
  getSelectedContexts(
@@ -2599,6 +2669,7 @@ declare namespace sap {
2599
2669
  * Get the transaction controller for editing actions on the page. Note that the methods provided by this
2600
2670
  * transaction controller depend on whether the object supports drafts or not.
2601
2671
  *
2672
+ *
2602
2673
  * @returns the transaction controller
2603
2674
  */
2604
2675
  getTransactionController():
@@ -2607,31 +2678,14 @@ declare namespace sap {
2607
2678
  /**
2608
2679
  * Get the id of the view this extension api belongs to
2609
2680
  *
2681
+ *
2610
2682
  * @returns the view id
2611
2683
  */
2612
2684
  getViewId(): string;
2613
- /**
2614
- * @experimental
2615
- *
2616
- * Hides Section and/or SubSection's title for embedded components and custom section(s), if the Section
2617
- * and/or SubSection's title matches with the inner Control's title. In case the control's resolved title
2618
- * is provided and is same as section's title, then the section's title is also automatically hidden. It's
2619
- * meant to be invoked from the onSubSectionEnteredExtension ExtensionAPI.
2620
- */
2621
- hideDuplicateSectionOrSubSectionTitle(
2622
- /**
2623
- * the ID identifying the Sub-Section to which you want to hide the title
2624
- */
2625
- sSubSectionId: string,
2626
- /**
2627
- * Optional parameter which represents the resolved title of the inner conrol defined in the Resue Component
2628
- * or Custom Section/SubSection
2629
- */
2630
- sTitle?: string
2631
- ): void;
2632
2685
  /**
2633
2686
  * Invokes multiple time the action with the given name and submits changes to the back-end.
2634
2687
  *
2688
+ *
2635
2689
  * @returns A `Promise` for asynchronous execution of the action, resolving to the same result as the `Promise`
2636
2690
  * returned from {@link sap.ui.generic.app.ApplicationController#invokeActions}
2637
2691
  */
@@ -2665,6 +2719,7 @@ declare namespace sap {
2665
2719
  * See:
2666
2720
  * {@link https://ui5.sap.com/#/topic/89fa878945294931b15a581a99043005 Custom State Handling for Extended Apps}
2667
2721
  *
2722
+ *
2668
2723
  * @returns A `Promise` that is resolved when the changed state is transferred to the URL and the corresponding
2669
2724
  * busy session is ended.
2670
2725
  */
@@ -2716,6 +2771,7 @@ declare namespace sap {
2716
2771
  * See:
2717
2772
  * {@link https://ui5.sap.com/#/topic/6a39150ad3e548a8b5304d32d560790a Using the SecuredExecutionMethod}
2718
2773
  *
2774
+ *
2719
2775
  * @returns A `Promise` that is rejected, if execution is prohibited, and settled equivalent to the one
2720
2776
  * returned by fnFunction.
2721
2777
  */
@@ -2772,14 +2828,38 @@ declare namespace sap {
2772
2828
  }
2773
2829
  ): Promise<any>;
2774
2830
  /**
2775
- * Provide an option for showing an own message in the message bar above an OP table
2831
+ * Defines a control to be the **title owner** for its subsection. As the title owners of standard subsections
2832
+ * are determined automatically it is recommended to use this function for custom subsections and embedded
2833
+ * components only. The title owner should be a control possessing properties header and headerLevel
2834
+ * and headerStyle (like {@link sap.ui.comp.smarttable.SmartTable} and {@link sap.ui.comp.smartchart.SmartChart})
2835
+ * or text and level and titleStyle (like {@link sap.m.Title}). The framework will
2836
+ * adapt the values of these properties to be aligned with the title which is shown in the anchor bar (or
2837
+ * icon tab bar) for the subsection. Moreover, the title of the subsection (and if applicable also of the
2838
+ * section) will be hidden in order to prevent redundant titles if the subsection possesses a title owner.
2839
+ * Note that this method should only be used in case that there exists one single suitable control which
2840
+ * represents the complete content of the subsection or embedded component.
2841
+ */
2842
+ setAsTitleOwner(
2843
+ /**
2844
+ * title owner of the subsection containing this control. The control must possess properties header
2845
+ * and headerLevel and headerStyle or text and level and titleStyle.
2846
+ * As a special case you can also pass a subsection itself which would remove a potential title owner from
2847
+ * this subsection.
2848
+ */
2849
+ the: sap.ui.core.Control
2850
+ ): void;
2851
+ /**
2852
+ * Provide an option for showing an own message in the message bar above an OP table or page header.
2853
+ *
2854
+ * If you want to display message on page header then you should pass `oMessage` only keeping all other
2855
+ * parameter as empty Note - Message bar on Page header will be shown only in display mode for dynamic header
2776
2856
  */
2777
2857
  setCustomMessage(
2778
2858
  /**
2779
2859
  * custom message along with type to set on table. If this parameter is faulty an existing message will
2780
2860
  * be removed.
2781
2861
  */
2782
- oMessage: {
2862
+ oMessage?: {
2783
2863
  /**
2784
2864
  * message string to display
2785
2865
  */
@@ -2791,9 +2871,9 @@ declare namespace sap {
2791
2871
  type: string;
2792
2872
  },
2793
2873
  /**
2794
- * Id of the table for which message should be set
2874
+ * Id of the table for which message should be set.
2795
2875
  */
2796
- sSmartTableId: string,
2876
+ sSmartTableId?: string,
2797
2877
  /**
2798
2878
  * If switching between different table views is enabled, this parameter can be used to identify the views
2799
2879
  * which are affected by this call. Faulty values indicate that all views should be affected. Otherwise
@@ -2808,30 +2888,9 @@ declare namespace sap {
2808
2888
  onClose?: Function
2809
2889
  ): void;
2810
2890
  /**
2811
- * Provide an option for showing an own message in the message bar above an OP table
2812
- */
2813
- setCustomMessage(
2814
- /**
2815
- * Id of the table for which message should be set
2816
- */
2817
- sSmartTableId: string,
2818
- /**
2819
- * If switching between different table views is enabled, this parameter can be used to identify the views
2820
- * which are affected by this call. Faulty values indicate that all views should be affected. Otherwise
2821
- * the value should either be one string or an array of strings identifying the affected variant items.
2822
- */
2823
- vTabKey?: any[] | string,
2824
- /**
2825
- * A function that is called when the user closes the message bar. Note that the messages for all tabs specified
2826
- * via `vTabKey` will be considered to be obsolete when the user closes the message bar while one of them
2827
- * is active.
2828
- */
2829
- onClose?: Function
2830
- ): void;
2831
- /**
2832
- * @experimental
2833
- *
2834
2891
  * This function sets the key in the selected section of the table of Object Page.
2892
+ *
2893
+ * @experimental
2835
2894
  */
2836
2895
  setQuickVariantSelectionKey(
2837
2896
  /**
@@ -2858,6 +2917,7 @@ declare namespace sap {
2858
2917
  *
2859
2918
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
2860
2919
  *
2920
+ *
2861
2921
  * @returns Created class / constructor function
2862
2922
  */
2863
2923
  static extend<T extends Record<string, unknown>>(
@@ -2881,6 +2941,7 @@ declare namespace sap {
2881
2941
  /**
2882
2942
  * Returns a metadata object for class sap.suite.ui.generic.template.ObjectPage.extensionAPI.NonDraftTransactionController.
2883
2943
  *
2944
+ *
2884
2945
  * @returns Metadata object describing this class
2885
2946
  */
2886
2947
  static getMetadata(): sap.ui.base.Metadata;
@@ -2929,6 +2990,7 @@ declare namespace sap {
2929
2990
  /**
2930
2991
  * This method can be called when a new entry with predefined values should be created (e.g. in a copy scenario).
2931
2992
  *
2993
+ *
2932
2994
  * @returns a context representing the object to be created. It can be passed to {@link sap.suite.ui.generic.template.extensionAPI.NavigationController#navigateInternal }
2933
2995
  * in order to visit the corresponding object page.
2934
2996
  */
@@ -2987,12 +3049,12 @@ declare namespace sap {
2987
3049
  */
2988
3050
  interface controllerFrameworkExtensions {
2989
3051
  /**
2990
- * @ui5-protected Do not call from applications (only from related classes in the framework)
2991
- *
2992
3052
  * This method is called by SAP Fiori elements before triggering an external navigation. Application developers
2993
3053
  * can override this method and programmatically adapt the parameters which are passed to the target application.
2994
3054
  * Application developers can use the oObjectInfo parameter to identify the navigation context and modify
2995
3055
  * the oSelectionVariant which contains the navigation parameters.
3056
+ *
3057
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2996
3058
  */
2997
3059
  adaptNavigationParameterExtension(
2998
3060
  /**
@@ -3014,21 +3076,21 @@ declare namespace sap {
3014
3076
  }
3015
3077
  ): void;
3016
3078
  /**
3017
- * @ui5-protected Do not call from applications (only from related classes in the framework)
3018
- *
3019
3079
  * This method is called by SAP Fiori elements whenever the busy state is switched off. Application developers
3020
3080
  * can override this method, access the message model and adapt the transient messages related to the component.
3081
+ *
3082
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
3021
3083
  */
3022
3084
  adaptTransientMessageExtension(): void;
3023
3085
  /**
3024
- * @ui5-protected Do not call from applications (only from related classes in the framework)
3025
- *
3026
3086
  * This method will be called by SAP Fiori elements while applying the AppState. The custom state object
3027
3087
  * retrieved from the AppState will be passed as a parameter to this method. Application developers can
3028
3088
  * use this custom state for restoring the state of the custom control. To make a complete functionality,
3029
3089
  * this method should be overridden with `provideCustomStateExtension`.
3030
3090
  * See:
3031
3091
  * {@link https://ui5.sap.com/#/topic/89fa878945294931b15a581a99043005 Custom State Handling for Extended Apps}
3092
+ *
3093
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
3032
3094
  */
3033
3095
  applyCustomStateExtension(
3034
3096
  /**
@@ -3043,19 +3105,17 @@ declare namespace sap {
3043
3105
  bIsSameAsLast: boolean
3044
3106
  ): void;
3045
3107
  /**
3046
- * @ui5-protected Do not call from applications (only from related classes in the framework)
3047
- *
3048
3108
  * This method is called by SAP Fiori element when Delete button on the Object Page is clicked. Application
3049
3109
  * developers can override this method & perform additional checks before executing the delete operation.
3050
3110
  * Method is expected to return a Promise. To veto the delete operation, promise needs to be rejected else
3051
3111
  * resolved.
3052
3112
  *
3113
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
3114
+ *
3053
3115
  * @returns Promise object created by the extension, used for delete operation chaining
3054
3116
  */
3055
3117
  beforeDeleteExtension(): Promise<any>;
3056
3118
  /**
3057
- * @ui5-protected Do not call from applications (only from related classes in the framework)
3058
- *
3059
3119
  * This method is called when the Delete operation is triggered on a table in the Object Page. Application
3060
3120
  * developers can override this method & perform additional checks before executing the delete operation.
3061
3121
  * Method is expected to return a Promise. Delete operation is executed only once the returned promise is
@@ -3063,6 +3123,8 @@ declare namespace sap {
3063
3123
  * Application developers can use `sUiElementId` property of the object passed as param to identify the
3064
3124
  * smart table where the Delete operation is being triggered.
3065
3125
  *
3126
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
3127
+ *
3066
3128
  * @returns Promise object created by the extension, used for Delete operation chaining
3067
3129
  */
3068
3130
  beforeLineItemDeleteExtension(
@@ -3081,8 +3143,6 @@ declare namespace sap {
3081
3143
  }
3082
3144
  ): Promise<any>;
3083
3145
  /**
3084
- * @ui5-protected Do not call from applications (only from related classes in the framework)
3085
- *
3086
3146
  * This method is called by SAP Fiori elements when Save button is selected. Application developers can
3087
3147
  * override this method and perform a custom operation before executing the Save operation. The method is
3088
3148
  * expected to return a Promise. The save operation will be continued only once the promise is resolved.
@@ -3092,12 +3152,12 @@ declare namespace sap {
3092
3152
  * requesting the user to enter additional data or confirmation. The returned Promise would be resolved
3093
3153
  * if the user confirms the dialog and rejected if it is canceled.
3094
3154
  *
3155
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
3156
+ *
3095
3157
  * @returns Promise object created by the extension, used for Save operation chaining
3096
3158
  */
3097
3159
  beforeSaveExtension(): Promise<any>;
3098
3160
  /**
3099
- * @ui5-protected Do not call from applications (only from related classes in the framework)
3100
- *
3101
3161
  * This method is called by SAP Fiori elements when a smart link in a table or form is clicked. Application
3102
3162
  * developers can override this method and invoke the oParams.getSourceInfo method to find out the information
3103
3163
  * about the clicked smart link.
@@ -3105,6 +3165,8 @@ declare namespace sap {
3105
3165
  * If the application expect the framework should not handle the `beforePopoverOpens` event, then this method
3106
3166
  * should return true. Otherwise, framework will proceed with its handling.
3107
3167
  *
3168
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
3169
+ *
3108
3170
  * @returns Method should return `true` if framework should not handle `beforePopoverOpens` event (that
3109
3171
  * means: extension code will handle the event)
3110
3172
  */
@@ -3124,13 +3186,13 @@ declare namespace sap {
3124
3186
  }
3125
3187
  ): boolean;
3126
3188
  /**
3127
- * @ui5-protected Do not call from applications (only from related classes in the framework)
3128
- *
3129
3189
  * This method is called by SAP Fiori elements when the table data is getting exported. Application developers
3130
3190
  * can override this method to add/remove the filters in the exported file.
3131
3191
  *
3132
3192
  * To add new filter entries to the exported file, create an instance of {@link sap.ui.export.util.Filter }
3133
3193
  * and add it to "oExportParams.filterSettings"
3194
+ *
3195
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
3134
3196
  */
3135
3197
  onBeforeExportTableExtension(
3136
3198
  /**
@@ -3149,13 +3211,13 @@ declare namespace sap {
3149
3211
  }
3150
3212
  ): void;
3151
3213
  /**
3152
- * @ui5-protected Do not call from applications (only from related classes in the framework)
3153
- *
3154
3214
  * This method is called by SAP Fiori elements before binding a table. Application developers can override
3155
3215
  * this method and programmatically modify parameters or filters before the table triggers a query to retrieve
3156
3216
  * data. Source property of the oEvent shall be used to determine table triggering the event
3157
3217
  *
3158
3218
  * **Note: **This method is called only when a table is rebound, and not when it is refreshed.
3219
+ *
3220
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
3159
3221
  */
3160
3222
  onBeforeRebindTableExtension(
3161
3223
  /**
@@ -3164,13 +3226,13 @@ declare namespace sap {
3164
3226
  oEvent: sap.ui.base.Event
3165
3227
  ): void;
3166
3228
  /**
3167
- * @ui5-protected Do not call from applications (only from related classes in the framework)
3168
- *
3169
3229
  * This method should be implemented whenever application uses onListNavigationExtension for internal navigation.
3170
3230
  * In this case the implementation of this method should provide an 'inverse' mapping to the transformation
3171
3231
  * implemented within onListNavigationExtension. More precisely, the identification of a child page instance
3172
3232
  * is passed to this function. The implementation of this function should provide information about the
3173
3233
  * list item which has triggered the opening of the child page.
3234
+ *
3235
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
3174
3236
  */
3175
3237
  onChildOpenedExtension(
3176
3238
  /**
@@ -3197,19 +3259,19 @@ declare namespace sap {
3197
3259
  fnSetPath: Function
3198
3260
  ): void;
3199
3261
  /**
3200
- * @ui5-protected Do not call from applications (only from related classes in the framework)
3201
- *
3202
3262
  * This method is called by SAP Fiori elements on the initialization of View. Application developers can
3203
3263
  * override this method & perform internal setup in this hook.
3264
+ *
3265
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
3204
3266
  */
3205
3267
  onInit(): void;
3206
3268
  /**
3207
- * @ui5-protected Do not call from applications (only from related classes in the framework)
3208
- *
3209
3269
  * This method is called when the user leaves the app and this page has been displayed within the same app
3210
3270
  * session (this is the time since last opening the app) at least once. Moreover, it is called for all pages
3211
3271
  * that have been displayed within some app session when the app is finally destroyed.
3212
3272
  *
3273
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
3274
+ *
3213
3275
  * @returns - Only relevant in case that `bIsDestroyed` is false. In this case Application developers can
3214
3276
  * provide a function to be called when the same page is opened again (after the user has navigated back
3215
3277
  * to the app).
@@ -3222,12 +3284,12 @@ declare namespace sap {
3222
3284
  bIsDestroyed: boolean
3223
3285
  ): Function;
3224
3286
  /**
3225
- * @ui5-protected Do not call from applications (only from related classes in the framework)
3226
- *
3227
3287
  * This method is called by SAP Fiori elements when a chevron navigation is triggered from a table. Application
3228
3288
  * developers can override this method and perform conditional (internal or external) navigation from different
3229
3289
  * rows of a table. Such custom navigation should be triggered via corresponding methods of {@link sap.suite.ui.generic.template.extensionAPI.NavigationController NavigationController}.
3230
3290
  *
3291
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
3292
+ *
3231
3293
  * @returns Method should return `true` if framework navigation should be suppressed (that means: extension
3232
3294
  * code has taken over navigation)
3233
3295
  */
@@ -3248,11 +3310,11 @@ declare namespace sap {
3248
3310
  bReplaceInHistory: boolean
3249
3311
  ): boolean;
3250
3312
  /**
3251
- * @ui5-protected Do not call from applications (only from related classes in the framework)
3252
- *
3253
3313
  * This method is called by SAP Fiori elements when the Share functionality is triggered. Application developers
3254
3314
  * can adapt the service URL passed as a parameter to this method. Adapted service URL will be used in the
3255
3315
  * 'Send Email' or 'Save as Tile' options.
3316
+ *
3317
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
3256
3318
  */
3257
3319
  onSaveAsTileExtension(
3258
3320
  /**
@@ -3266,13 +3328,13 @@ declare namespace sap {
3266
3328
  }
3267
3329
  ): void;
3268
3330
  /**
3269
- * @ui5-protected Do not call from applications (only from related classes in the framework)
3270
- *
3271
3331
  * This method is called when the SubSection enters the Viewport first time for an ObjectPage. Method would
3272
3332
  * be called again for the same SubSection only in case ObjectPage binding context is changed. Application
3273
3333
  * developers could use this method to perform specific actions on the current SubSection children. This
3274
3334
  * enables the application to perform actions relevant to a specific section when it really comes to view
3275
3335
  * port. Control specific handling should be done in this method in case View LazyLoading is enabled.
3336
+ *
3337
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
3276
3338
  */
3277
3339
  onSubSectionEnteredExtension(
3278
3340
  /**
@@ -3281,14 +3343,14 @@ declare namespace sap {
3281
3343
  oSubSection: sap.uxap.ObjectPageSubSection
3282
3344
  ): void;
3283
3345
  /**
3284
- * @ui5-protected Do not call from applications (only from related classes in the framework)
3285
- *
3286
3346
  * This method will be called by SAP Fiori elements before persisting the AppState. Application developers
3287
3347
  * can override this method for persisting the state of custom controls. State of the custom controls should
3288
3348
  * be stored in the oState object passed as a parameter to this method. To make a complete functionality,
3289
3349
  * this method should be overridden with `applyCustomStateExtension`.
3290
3350
  * See:
3291
3351
  * {@link https://ui5.sap.com/#/topic/89fa878945294931b15a581a99043005 Custom State Handling for Extended Apps}
3352
+ *
3353
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
3292
3354
  */
3293
3355
  provideCustomStateExtension(
3294
3356
  /**
@@ -3301,6 +3363,9 @@ declare namespace sap {
3301
3363
 
3302
3364
  /**
3303
3365
  * A static enumeration type which indicates the mode of targeted page while using navigateInternal extensionAPI
3366
+ *
3367
+ * This enum is part of the 'sap/suite/ui/generic/template/library' module export and must be accessed by
3368
+ * the property 'displayMode'.
3304
3369
  */
3305
3370
  enum displayMode {
3306
3371
  /**