@sapui5/types 1.120.7 → 1.120.8

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 (36) hide show
  1. package/package.json +1 -1
  2. package/types/sap.chart.d.ts +175 -43
  3. package/types/sap.f.d.ts +1484 -843
  4. package/types/sap.m.d.ts +12919 -8163
  5. package/types/sap.makit.d.ts +367 -185
  6. package/types/sap.me.d.ts +229 -35
  7. package/types/sap.ndc.d.ts +40 -9
  8. package/types/sap.suite.ui.generic.template.d.ts +201 -126
  9. package/types/sap.suite.ui.microchart.d.ts +966 -392
  10. package/types/sap.tnt.d.ts +190 -95
  11. package/types/sap.ui.codeeditor.d.ts +46 -17
  12. package/types/sap.ui.commons.d.ts +1992 -668
  13. package/types/sap.ui.comp.d.ts +3653 -2889
  14. package/types/sap.ui.core.d.ts +5281 -3347
  15. package/types/sap.ui.dt.d.ts +1 -1
  16. package/types/sap.ui.export.d.ts +73 -65
  17. package/types/sap.ui.fl.d.ts +95 -46
  18. package/types/sap.ui.integration.d.ts +446 -387
  19. package/types/sap.ui.layout.d.ts +1116 -634
  20. package/types/sap.ui.mdc.d.ts +1907 -1277
  21. package/types/sap.ui.richtexteditor.d.ts +112 -55
  22. package/types/sap.ui.rta.d.ts +7 -7
  23. package/types/sap.ui.suite.d.ts +42 -10
  24. package/types/sap.ui.support.d.ts +31 -23
  25. package/types/sap.ui.table.d.ts +898 -616
  26. package/types/sap.ui.testrecorder.d.ts +1 -1
  27. package/types/sap.ui.unified.d.ts +1834 -1207
  28. package/types/sap.ui.ux3.d.ts +1279 -477
  29. package/types/sap.ui.webc.common.d.ts +7 -5
  30. package/types/sap.ui.webc.fiori.d.ts +836 -213
  31. package/types/sap.ui.webc.main.d.ts +2670 -591
  32. package/types/sap.uiext.inbox.d.ts +207 -36
  33. package/types/sap.ushell.d.ts +1021 -779
  34. package/types/sap.ushell_abap.d.ts +1 -1
  35. package/types/sap.uxap.d.ts +571 -316
  36. package/types/sap.viz.d.ts +4030 -2318
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.6
1
+ // For Library Version: 1.120.7
2
2
 
3
3
  declare module "sap/suite/ui/generic/template/library" {
4
4
  /**
@@ -43,12 +43,12 @@ declare module "sap/suite/ui/generic/template/AnalyticalListPage/controllerFrame
43
43
  */
44
44
  interface controllerFrameworkExtensions {
45
45
  /**
46
- * @ui5-protected Do not call from applications (only from related classes in the framework)
47
- *
48
46
  * This method is called by SAP Fiori elements before triggering an external navigation. Application developers
49
47
  * can override this method and programmatically adapt the parameters which are passed to the target application.
50
48
  * Application developers can use the oObjectInfo parameter to identify the navigation context and modify
51
49
  * the oSelectionVariant which contains the navigation parameters.
50
+ *
51
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
52
52
  */
53
53
  adaptNavigationParameterExtension(
54
54
  /**
@@ -70,15 +70,13 @@ declare module "sap/suite/ui/generic/template/AnalyticalListPage/controllerFrame
70
70
  }
71
71
  ): void;
72
72
  /**
73
- * @ui5-protected Do not call from applications (only from related classes in the framework)
74
- *
75
73
  * This method is called by SAP Fiori elements whenever the busy state is switched off. Application developers
76
74
  * can override this method, access the message model and adapt the transient messages related to the component.
75
+ *
76
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
77
77
  */
78
78
  adaptTransientMessageExtension(): void;
79
79
  /**
80
- * @ui5-protected Do not call from applications (only from related classes in the framework)
81
- *
82
80
  * This method is called by SAP Fiori elements when a smart link in a table is clicked. Application developers
83
81
  * can override this method and invoke the oParams.getSourceInfo method to find out the information about
84
82
  * the clicked smart link.
@@ -86,6 +84,8 @@ declare module "sap/suite/ui/generic/template/AnalyticalListPage/controllerFrame
86
84
  * If the application expect the framework should not handle the `beforePopoverOpens` event, then this method
87
85
  * should return true. Otherwise, framework will proceed with its handling.
88
86
  *
87
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
88
+ *
89
89
  * @returns Method should return `true` if framework should not handle `beforePopoverOpens` event (that
90
90
  * means: extension code will handle the event)
91
91
  */
@@ -105,12 +105,12 @@ declare module "sap/suite/ui/generic/template/AnalyticalListPage/controllerFrame
105
105
  }
106
106
  ): boolean;
107
107
  /**
108
- * @ui5-protected Do not call from applications (only from related classes in the framework)
109
- *
110
108
  * This method is called by SAP Fiori elements before persisting the AppState. Application developers can
111
109
  * override this method for persisting the state of custom controls. State of the custom control (controls)
112
110
  * should be stored in the oCustomData passed as a parameter to this method. To make a complete functionality,
113
111
  * this method should be overridden with `restoreCustomAppStateDataExtension`.
112
+ *
113
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
114
114
  */
115
115
  getCustomAppStateDataExtension(
116
116
  /**
@@ -119,26 +119,26 @@ declare module "sap/suite/ui/generic/template/AnalyticalListPage/controllerFrame
119
119
  oCustomData: object
120
120
  ): void;
121
121
  /**
122
- * @ui5-protected Do not call from applications (only from related classes in the framework)
123
- *
124
122
  * This method is called in the AppState creation lifecycle. Application developers can override this method,
125
123
  * return an array of all selection fields set on SmartFilterBar using custom code as default and doesn't
126
124
  * really want to store as part of the AppState. SAP Fiori elements framework will remove these filter properties
127
125
  * from the selection variant.
128
126
  *
127
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
128
+ *
129
129
  * @returns - Properties which are visible and should not be stored as part of the selection variant in
130
130
  * the AppState
131
131
  */
132
132
  getVisibleSelectionsWithDefaults(): any[];
133
133
  /**
134
- * @ui5-protected Do not call from applications (only from related classes in the framework)
135
- *
136
134
  * This method is called by SAP Fiori elements in the startup life cycle of a component. Application developers
137
135
  * can override this method and modify the startup object. For an example, when the application is started,
138
136
  * the selection variant might contain some properties that are not required for this app. Such properties
139
137
  * can be removed from the selection variant. The reverse use case is also true, where some additional properties
140
138
  * needs to be added with certain fixed values. This can be achieved by adding these values to the selection
141
139
  * variant.
140
+ *
141
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
142
142
  */
143
143
  modifyStartupExtension(
144
144
  /**
@@ -156,13 +156,13 @@ declare module "sap/suite/ui/generic/template/AnalyticalListPage/controllerFrame
156
156
  }
157
157
  ): void;
158
158
  /**
159
- * @ui5-protected Do not call from applications (only from related classes in the framework)
160
- *
161
159
  * This method is called by SAP Fiori elements when the table data is getting exported. Application developers
162
160
  * can override this method to add/remove the filters in the exported file.
163
161
  *
164
162
  * To add new filter entries to the exported file, create an instance of {@link sap.ui.export.util.Filter }
165
163
  * and add it to "oExportParams.filterSettings"
164
+ *
165
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
166
166
  */
167
167
  onBeforeExportTableExtension(
168
168
  /**
@@ -181,13 +181,13 @@ declare module "sap/suite/ui/generic/template/AnalyticalListPage/controllerFrame
181
181
  }
182
182
  ): void;
183
183
  /**
184
- * @ui5-protected Do not call from applications (only from related classes in the framework)
185
- *
186
184
  * This method is called by SAP Fiori elements before binding a chart. Application developers can override
187
185
  * this method and programmatically modify parameters or filters before chart triggers a query to retrieve
188
186
  * data.
189
187
  *
190
188
  * **Note: **This method is called only when a chart is rebound, and not when it is refreshed.
189
+ *
190
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
191
191
  */
192
192
  onBeforeRebindChartExtension(
193
193
  /**
@@ -196,10 +196,10 @@ declare module "sap/suite/ui/generic/template/AnalyticalListPage/controllerFrame
196
196
  oEvent: Event
197
197
  ): void;
198
198
  /**
199
- * @ui5-protected Do not call from applications (only from related classes in the framework)
200
- *
201
199
  * This method is called by SAP Fiori elements before binding a filterable KPI. Application developers can
202
200
  * override this method to modify parameters or filters for a filterable KPI.
201
+ *
202
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
203
203
  */
204
204
  onBeforeRebindFilterableKPIExtension(
205
205
  /**
@@ -216,13 +216,13 @@ declare module "sap/suite/ui/generic/template/AnalyticalListPage/controllerFrame
216
216
  sKPIId: string
217
217
  ): void;
218
218
  /**
219
- * @ui5-protected Do not call from applications (only from related classes in the framework)
220
- *
221
219
  * This method is called by SAP Fiori elements before binding a table. Application developers can override
222
220
  * this method and programmatically modify parameters or filters before the table triggers a query to retrieve
223
221
  * data.
224
222
  *
225
223
  * **Note: **This method is called only when a table is rebound, and not when it is refreshed.
224
+ *
225
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
226
226
  */
227
227
  onBeforeRebindTableExtension(
228
228
  /**
@@ -231,12 +231,12 @@ declare module "sap/suite/ui/generic/template/AnalyticalListPage/controllerFrame
231
231
  oEvent: Event
232
232
  ): void;
233
233
  /**
234
- * @ui5-protected Do not call from applications (only from related classes in the framework)
235
- *
236
234
  * This method is called by SAP Fiori elements before binding a visual filter. Application developers can
237
235
  * override this method and programmatically modify parameters, filters, or influence sorting before the
238
236
  * chart triggers a query to retrieve data. Application developers can also access incoming navigation contexts
239
237
  * of the app through `getNavigationContext` API.
238
+ *
239
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
240
240
  */
241
241
  onBeforeRebindVisualFilterExtension(
242
242
  /**
@@ -275,13 +275,13 @@ declare module "sap/suite/ui/generic/template/AnalyticalListPage/controllerFrame
275
275
  }
276
276
  ): void;
277
277
  /**
278
- * @ui5-protected Do not call from applications (only from related classes in the framework)
279
- *
280
278
  * This method should be implemented whenever application uses onListNavigationExtension for internal navigation.
281
279
  * In this case the implementation of this method should provide an 'inverse' mapping to the transformation
282
280
  * implemented within onListNavigationExtension. More precisely, the identification of a child page instance
283
281
  * is passed to this function. The implementation of this function should provide information about the
284
282
  * list item which has triggered the opening of the child page.
283
+ *
284
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
285
285
  */
286
286
  onChildOpenedExtension(
287
287
  /**
@@ -308,10 +308,10 @@ declare module "sap/suite/ui/generic/template/AnalyticalListPage/controllerFrame
308
308
  fnSetPath: Function
309
309
  ): void;
310
310
  /**
311
- * @ui5-protected Do not call from applications (only from related classes in the framework)
312
- *
313
311
  * This method is called by SAP Fiori elements when the Clear button on the filter dialog is clicked. Application
314
312
  * developers can override this method to clear custom filters.
313
+ *
314
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
315
315
  */
316
316
  onClearFilterExtension(
317
317
  /**
@@ -320,18 +320,18 @@ declare module "sap/suite/ui/generic/template/AnalyticalListPage/controllerFrame
320
320
  oEvent: Event
321
321
  ): void;
322
322
  /**
323
- * @ui5-protected Do not call from applications (only from related classes in the framework)
324
- *
325
323
  * This method is called by Fiori elements on the initialization of View. Application developers can override
326
324
  * this method & perform internal setup in this hook.
325
+ *
326
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
327
327
  */
328
328
  onInit(): void;
329
329
  /**
330
- * @ui5-protected Do not call from applications (only from related classes in the framework)
331
- *
332
330
  * This method is called by SAP Fiori elements once the smart filter bar is initialized with a variant.
333
331
  * Application developers can override this method when there is a custom filter field bound outside the
334
332
  * standard model.
333
+ *
334
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
335
335
  */
336
336
  onInitSmartFilterBarExtension(
337
337
  /**
@@ -340,12 +340,12 @@ declare module "sap/suite/ui/generic/template/AnalyticalListPage/controllerFrame
340
340
  oEvent: Event
341
341
  ): void;
342
342
  /**
343
- * @ui5-protected Do not call from applications (only from related classes in the framework)
344
- *
345
343
  * This method is called when the user leaves the app and this page has been displayed within the same app
346
344
  * session (this is the time since last opening the app) at least once. Moreover, it is called for all pages
347
345
  * that have been displayed within some app session when the app is finally destroyed.
348
346
  *
347
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
348
+ *
349
349
  * @returns - Only relevant in case that `isDestroyed` is false. In this case Application developers can
350
350
  * provide a function to be called when the same page is opened again (after the user has navigated back
351
351
  * to the app).
@@ -358,12 +358,12 @@ declare module "sap/suite/ui/generic/template/AnalyticalListPage/controllerFrame
358
358
  bIsDestroyed: boolean
359
359
  ): Function;
360
360
  /**
361
- * @ui5-protected Do not call from applications (only from related classes in the framework)
362
- *
363
361
  * This method is called by SAP Fiori elements when a chevron navigation is triggered from a table. Application
364
362
  * developers can override this method and perform conditional (internal or external) navigation from different
365
363
  * rows of a table. Such custom navigation should be triggered via corresponding methods of {@link sap.suite.ui.generic.template.extensionAPI.NavigationController NavigationController}.
366
364
  *
365
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
366
+ *
367
367
  * @returns Method should return `true` if framework navigation should be suppressed (that means: extension
368
368
  * code has taken over navigation)
369
369
  */
@@ -384,11 +384,11 @@ declare module "sap/suite/ui/generic/template/AnalyticalListPage/controllerFrame
384
384
  bReplaceInHistory: boolean
385
385
  ): boolean;
386
386
  /**
387
- * @ui5-protected Do not call from applications (only from related classes in the framework)
388
- *
389
387
  * This method is called by SAP Fiori elements when the Share functionality is triggered. Application developers
390
388
  * can adapt the service URL passed as a parameter to this method. Adapted service URL will be used in the
391
389
  * 'Send Email' or 'Save as Tile' options.
390
+ *
391
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
392
392
  */
393
393
  onSaveAsTileExtension(
394
394
  /**
@@ -402,12 +402,12 @@ declare module "sap/suite/ui/generic/template/AnalyticalListPage/controllerFrame
402
402
  }
403
403
  ): void;
404
404
  /**
405
- * @ui5-protected Do not call from applications (only from related classes in the framework)
406
- *
407
405
  * This method is called by SAP Fiori elements while applying the AppState. This method should be overridden
408
406
  * with `getCustomAppStateDataExtension`. The custom data retrieved from the AppState will be passed as
409
407
  * a parameter to this method. Application developers can use this custom data to restore the state of the
410
408
  * custom control.
409
+ *
410
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
411
411
  */
412
412
  restoreCustomAppStateDataExtension(
413
413
  /**
@@ -444,6 +444,7 @@ declare module "sap/suite/ui/generic/template/AnalyticalListPage/extensionAPI/Ex
444
444
  *
445
445
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
446
446
  *
447
+ *
447
448
  * @returns Created class / constructor function
448
449
  */
449
450
  static extend<T extends Record<string, unknown>>(
@@ -464,6 +465,7 @@ declare module "sap/suite/ui/generic/template/AnalyticalListPage/extensionAPI/Ex
464
465
  /**
465
466
  * Returns a metadata object for class sap.suite.ui.generic.template.AnalyticalListPage.extensionAPI.ExtensionAPI.
466
467
  *
468
+ *
467
469
  * @returns Metadata object describing this class
468
470
  */
469
471
  static getMetadata(): Metadata;
@@ -481,18 +483,21 @@ declare module "sap/suite/ui/generic/template/AnalyticalListPage/extensionAPI/Ex
481
483
  /**
482
484
  * provides incoming navigation context of the app
483
485
  *
486
+ *
484
487
  * @returns Navigation context object
485
488
  */
486
489
  getNavigationContext(): Object;
487
490
  /**
488
491
  * Get the navigation controller for navigation actions
489
492
  *
493
+ *
490
494
  * @returns the navigation controller
491
495
  */
492
496
  getNavigationController(): NavigationController;
493
497
  /**
494
498
  * Get the list entries currently selected
495
499
  *
500
+ *
496
501
  * @returns contains the entries selected
497
502
  */
498
503
  getSelectedContexts(
@@ -504,6 +509,7 @@ declare module "sap/suite/ui/generic/template/AnalyticalListPage/extensionAPI/Ex
504
509
  /**
505
510
  * Invokes multiple time the action with the given name and submits changes to the back-end.
506
511
  *
512
+ *
507
513
  * @returns A `Promise` for asynchronous execution of the action, resolving to the same result as the `Promise`
508
514
  * returned from {@link sap.ui.generic.app.ApplicationController#invokeActions}
509
515
  */
@@ -554,6 +560,7 @@ declare module "sap/suite/ui/generic/template/AnalyticalListPage/extensionAPI/Ex
554
560
  * See:
555
561
  * {@link https://ui5.sap.com/#/topic/6a39150ad3e548a8b5304d32d560790a Using the SecuredExecutionMethod}
556
562
  *
563
+ *
557
564
  * @returns A `Promise` that is rejected, if execution is prohibited, and settled equivalent to the one
558
565
  * returned by fnFunction.
559
566
  */
@@ -676,6 +683,7 @@ declare module "sap/suite/ui/generic/template/Canvas/extensionAPI/ExtensionAPI"
676
683
  *
677
684
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
678
685
  *
686
+ *
679
687
  * @returns Created class / constructor function
680
688
  */
681
689
  static extend<T extends Record<string, unknown>>(
@@ -696,6 +704,7 @@ declare module "sap/suite/ui/generic/template/Canvas/extensionAPI/ExtensionAPI"
696
704
  /**
697
705
  * Returns a metadata object for class sap.suite.ui.generic.template.Canvas.extensionAPI.ExtensionAPI.
698
706
  *
707
+ *
699
708
  * @returns Metadata object describing this class
700
709
  */
701
710
  static getMetadata(): Metadata;
@@ -749,12 +758,14 @@ declare module "sap/suite/ui/generic/template/Canvas/extensionAPI/ExtensionAPI"
749
758
  /**
750
759
  * Get the Flexible Column Layout Action Buttons(Fullscreen, Exit Fullscreen and Close).
751
760
  *
761
+ *
752
762
  * @returns Flexible Column Layout Action Buttons
753
763
  */
754
764
  getFlexibleColumnLayoutActionButtons(): object;
755
765
  /**
756
766
  * Get the navigation controller for navigation actions
757
767
  *
768
+ *
758
769
  * @returns the navigation controller
759
770
  */
760
771
  getNavigationController(): NavigationController;
@@ -762,6 +773,7 @@ declare module "sap/suite/ui/generic/template/Canvas/extensionAPI/ExtensionAPI"
762
773
  * Get the transaction controller for editing actions on the page. Note that the methods provided by this
763
774
  * transaction controller depend on whether the object supports drafts or not.
764
775
  *
776
+ *
765
777
  * @returns the transaction controller
766
778
  */
767
779
  getTransactionController():
@@ -770,6 +782,7 @@ declare module "sap/suite/ui/generic/template/Canvas/extensionAPI/ExtensionAPI"
770
782
  /**
771
783
  * Invokes multiple time the action with the given name and submits changes to the back-end.
772
784
  *
785
+ *
773
786
  * @returns A `Promise` for asynchronous execution of the action, resolving to the same result as the `Promise`
774
787
  * returned from {@link sap.ui.generic.app.ApplicationController#invokeActions}
775
788
  */
@@ -829,6 +842,7 @@ declare module "sap/suite/ui/generic/template/Canvas/extensionAPI/ExtensionAPI"
829
842
  * See:
830
843
  * {@link https://ui5.sap.com/#/topic/6a39150ad3e548a8b5304d32d560790a Using the SecuredExecutionMethod}
831
844
  *
845
+ *
832
846
  * @returns A `Promise` that is rejected, if execution is prohibited, and settled equivalent to the one
833
847
  * returned by fnFunction.
834
848
  */
@@ -910,6 +924,7 @@ declare module "sap/suite/ui/generic/template/extensionAPI/extensionAPI" {
910
924
  * ...
911
925
  * });`
912
926
  *
927
+ *
913
928
  * @returns A `Promise` which resolves to the extension API for the embedding SAP Fiori elements view
914
929
  */
915
930
  getExtensionAPIPromise(
@@ -979,6 +994,7 @@ declare module "sap/suite/ui/generic/template/extensionAPI/NavigationController"
979
994
  *
980
995
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
981
996
  *
997
+ *
982
998
  * @returns Created class / constructor function
983
999
  */
984
1000
  static extend<T extends Record<string, unknown>>(
@@ -999,6 +1015,7 @@ declare module "sap/suite/ui/generic/template/extensionAPI/NavigationController"
999
1015
  /**
1000
1016
  * Returns a metadata object for class sap.suite.ui.generic.template.extensionAPI.NavigationController.
1001
1017
  *
1018
+ *
1002
1019
  * @returns Metadata object describing this class
1003
1020
  */
1004
1021
  static getMetadata(): Metadata;
@@ -1150,7 +1167,7 @@ declare module "sap/suite/ui/generic/template/lib/AppComponent" {
1150
1167
  /**
1151
1168
  * Smart Templates Application Component
1152
1169
  */
1153
- export default class AppComponent extends UIComponent {
1170
+ export default abstract class AppComponent extends UIComponent {
1154
1171
  /**
1155
1172
  * Main class used for Smart Template(Fiori elements V2) Application Component
1156
1173
  *
@@ -1166,6 +1183,7 @@ declare module "sap/suite/ui/generic/template/lib/AppComponent" {
1166
1183
  *
1167
1184
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.UIComponent.extend}.
1168
1185
  *
1186
+ *
1169
1187
  * @returns Created class / constructor function
1170
1188
  */
1171
1189
  static extend<T extends Record<string, unknown>>(
@@ -1186,6 +1204,7 @@ declare module "sap/suite/ui/generic/template/lib/AppComponent" {
1186
1204
  /**
1187
1205
  * Returns a metadata object for class sap.suite.ui.generic.template.lib.AppComponent.
1188
1206
  *
1207
+ *
1189
1208
  * @returns Metadata object describing this class
1190
1209
  */
1191
1210
  static getMetadata(): ComponentMetadata;
@@ -1196,6 +1215,7 @@ declare module "sap/suite/ui/generic/template/lib/AppComponent" {
1196
1215
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1197
1216
  * otherwise it will be bound to this `sap.suite.ui.generic.template.lib.AppComponent` itself.
1198
1217
  *
1218
+ *
1199
1219
  * @returns Reference to `this` in order to allow method chaining
1200
1220
  */
1201
1221
  attachPageDataLoaded(
@@ -1221,6 +1241,7 @@ declare module "sap/suite/ui/generic/template/lib/AppComponent" {
1221
1241
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1222
1242
  * otherwise it will be bound to this `sap.suite.ui.generic.template.lib.AppComponent` itself.
1223
1243
  *
1244
+ *
1224
1245
  * @returns Reference to `this` in order to allow method chaining
1225
1246
  */
1226
1247
  attachPageDataLoaded(
@@ -1240,6 +1261,7 @@ declare module "sap/suite/ui/generic/template/lib/AppComponent" {
1240
1261
  *
1241
1262
  * The passed function and listener object must match the ones used for event registration.
1242
1263
  *
1264
+ *
1243
1265
  * @returns Reference to `this` in order to allow method chaining
1244
1266
  */
1245
1267
  detachPageDataLoaded(
@@ -1253,10 +1275,10 @@ declare module "sap/suite/ui/generic/template/lib/AppComponent" {
1253
1275
  oListener?: object
1254
1276
  ): this;
1255
1277
  /**
1256
- * @ui5-protected Do not call from applications (only from related classes in the framework)
1257
- *
1258
1278
  * Fires event {@link #event:pageDataLoaded pageDataLoaded} to attached listeners.
1259
1279
  *
1280
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1281
+ *
1260
1282
  * @returns Reference to `this` in order to allow method chaining
1261
1283
  */
1262
1284
  firePageDataLoaded(
@@ -1270,6 +1292,7 @@ declare module "sap/suite/ui/generic/template/lib/AppComponent" {
1270
1292
  *
1271
1293
  * Default value is `...see text or source`.
1272
1294
  *
1295
+ *
1273
1296
  * @returns Value of property `collaborationSettings`
1274
1297
  */
1275
1298
  getCollaborationSettings(): object;
@@ -1278,6 +1301,7 @@ declare module "sap/suite/ui/generic/template/lib/AppComponent" {
1278
1301
  *
1279
1302
  * Default value is `false`.
1280
1303
  *
1304
+ *
1281
1305
  * @returns Value of property `considerAnalyticalParameters`
1282
1306
  */
1283
1307
  getConsiderAnalyticalParameters(): boolean;
@@ -1286,6 +1310,7 @@ declare module "sap/suite/ui/generic/template/lib/AppComponent" {
1286
1310
  *
1287
1311
  * Default value is `...see text or source`.
1288
1312
  *
1313
+ *
1289
1314
  * @returns Value of property `draftDiscardConfirmationSettings`
1290
1315
  */
1291
1316
  getDraftDiscardConfirmationSettings(): object;
@@ -1294,12 +1319,14 @@ declare module "sap/suite/ui/generic/template/lib/AppComponent" {
1294
1319
  *
1295
1320
  * Default value is `true`.
1296
1321
  *
1322
+ *
1297
1323
  * @returns Value of property `enableAutoColumnWidthForSmartTable`
1298
1324
  */
1299
1325
  getEnableAutoColumnWidthForSmartTable(): boolean;
1300
1326
  /**
1301
1327
  * Gets current value of property {@link #getFlexibleColumnLayout flexibleColumnLayout}.
1302
1328
  *
1329
+ *
1303
1330
  * @returns Value of property `flexibleColumnLayout`
1304
1331
  */
1305
1332
  getFlexibleColumnLayout(): object;
@@ -1308,18 +1335,21 @@ declare module "sap/suite/ui/generic/template/lib/AppComponent" {
1308
1335
  *
1309
1336
  * Default value is `false`.
1310
1337
  *
1338
+ *
1311
1339
  * @returns Value of property `forceGlobalRefresh`
1312
1340
  */
1313
1341
  getForceGlobalRefresh(): boolean;
1314
1342
  /**
1315
1343
  * Gets current value of property {@link #getInboundParameters inboundParameters}.
1316
1344
  *
1345
+ *
1317
1346
  * @returns Value of property `inboundParameters`
1318
1347
  */
1319
1348
  getInboundParameters(): object;
1320
1349
  /**
1321
1350
  * Gets current value of property {@link #getObjectPageColumns objectPageColumns}.
1322
1351
  *
1352
+ *
1323
1353
  * @returns Value of property `objectPageColumns`
1324
1354
  */
1325
1355
  getObjectPageColumns(): object;
@@ -1328,6 +1358,7 @@ declare module "sap/suite/ui/generic/template/lib/AppComponent" {
1328
1358
  *
1329
1359
  * Default value is `"Static"`.
1330
1360
  *
1361
+ *
1331
1362
  * @returns Value of property `objectPageHeaderType`
1332
1363
  */
1333
1364
  getObjectPageHeaderType(): string;
@@ -1336,6 +1367,7 @@ declare module "sap/suite/ui/generic/template/lib/AppComponent" {
1336
1367
  *
1337
1368
  * Default value is `"None"`.
1338
1369
  *
1370
+ *
1339
1371
  * @returns Value of property `objectPageVariantManagement`
1340
1372
  */
1341
1373
  getObjectPageVariantManagement(): string;
@@ -1344,6 +1376,7 @@ declare module "sap/suite/ui/generic/template/lib/AppComponent" {
1344
1376
  *
1345
1377
  * Default value is `true`.
1346
1378
  *
1379
+ *
1347
1380
  * @returns Value of property `showDraftToggle`
1348
1381
  */
1349
1382
  getShowDraftToggle(): boolean;
@@ -1352,6 +1385,7 @@ declare module "sap/suite/ui/generic/template/lib/AppComponent" {
1352
1385
  *
1353
1386
  * Default value is `"auto"`.
1354
1387
  *
1388
+ *
1355
1389
  * @returns Value of property `statePreservationMode`
1356
1390
  */
1357
1391
  getStatePreservationMode(): string;
@@ -1360,6 +1394,7 @@ declare module "sap/suite/ui/generic/template/lib/AppComponent" {
1360
1394
  *
1361
1395
  * Default value is `"Middle"`.
1362
1396
  *
1397
+ *
1363
1398
  * @returns Value of property `tableColumnVerticalAlignment`
1364
1399
  */
1365
1400
  getTableColumnVerticalAlignment(): string;
@@ -1368,6 +1403,7 @@ declare module "sap/suite/ui/generic/template/lib/AppComponent" {
1368
1403
  *
1369
1404
  * Default value is `true`.
1370
1405
  *
1406
+ *
1371
1407
  * @returns Value of property `useColumnLayoutForSmartForm`
1372
1408
  */
1373
1409
  getUseColumnLayoutForSmartForm(): boolean;
@@ -1378,6 +1414,7 @@ declare module "sap/suite/ui/generic/template/lib/AppComponent" {
1378
1414
  *
1379
1415
  * Default value is `...see text or source`.
1380
1416
  *
1417
+ *
1381
1418
  * @returns Reference to `this` in order to allow method chaining
1382
1419
  */
1383
1420
  setCollaborationSettings(
@@ -1393,6 +1430,7 @@ declare module "sap/suite/ui/generic/template/lib/AppComponent" {
1393
1430
  *
1394
1431
  * Default value is `false`.
1395
1432
  *
1433
+ *
1396
1434
  * @returns Reference to `this` in order to allow method chaining
1397
1435
  */
1398
1436
  setConsiderAnalyticalParameters(
@@ -1408,6 +1446,7 @@ declare module "sap/suite/ui/generic/template/lib/AppComponent" {
1408
1446
  *
1409
1447
  * Default value is `...see text or source`.
1410
1448
  *
1449
+ *
1411
1450
  * @returns Reference to `this` in order to allow method chaining
1412
1451
  */
1413
1452
  setDraftDiscardConfirmationSettings(
@@ -1423,6 +1462,7 @@ declare module "sap/suite/ui/generic/template/lib/AppComponent" {
1423
1462
  *
1424
1463
  * Default value is `true`.
1425
1464
  *
1465
+ *
1426
1466
  * @returns Reference to `this` in order to allow method chaining
1427
1467
  */
1428
1468
  setEnableAutoColumnWidthForSmartTable(
@@ -1436,6 +1476,7 @@ declare module "sap/suite/ui/generic/template/lib/AppComponent" {
1436
1476
  *
1437
1477
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1438
1478
  *
1479
+ *
1439
1480
  * @returns Reference to `this` in order to allow method chaining
1440
1481
  */
1441
1482
  setFlexibleColumnLayout(
@@ -1451,6 +1492,7 @@ declare module "sap/suite/ui/generic/template/lib/AppComponent" {
1451
1492
  *
1452
1493
  * Default value is `false`.
1453
1494
  *
1495
+ *
1454
1496
  * @returns Reference to `this` in order to allow method chaining
1455
1497
  */
1456
1498
  setForceGlobalRefresh(
@@ -1464,6 +1506,7 @@ declare module "sap/suite/ui/generic/template/lib/AppComponent" {
1464
1506
  *
1465
1507
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1466
1508
  *
1509
+ *
1467
1510
  * @returns Reference to `this` in order to allow method chaining
1468
1511
  */
1469
1512
  setInboundParameters(
@@ -1477,6 +1520,7 @@ declare module "sap/suite/ui/generic/template/lib/AppComponent" {
1477
1520
  *
1478
1521
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1479
1522
  *
1523
+ *
1480
1524
  * @returns Reference to `this` in order to allow method chaining
1481
1525
  */
1482
1526
  setObjectPageColumns(
@@ -1492,6 +1536,7 @@ declare module "sap/suite/ui/generic/template/lib/AppComponent" {
1492
1536
  *
1493
1537
  * Default value is `"Static"`.
1494
1538
  *
1539
+ *
1495
1540
  * @returns Reference to `this` in order to allow method chaining
1496
1541
  */
1497
1542
  setObjectPageHeaderType(
@@ -1507,6 +1552,7 @@ declare module "sap/suite/ui/generic/template/lib/AppComponent" {
1507
1552
  *
1508
1553
  * Default value is `"None"`.
1509
1554
  *
1555
+ *
1510
1556
  * @returns Reference to `this` in order to allow method chaining
1511
1557
  */
1512
1558
  setObjectPageVariantManagement(
@@ -1522,6 +1568,7 @@ declare module "sap/suite/ui/generic/template/lib/AppComponent" {
1522
1568
  *
1523
1569
  * Default value is `true`.
1524
1570
  *
1571
+ *
1525
1572
  * @returns Reference to `this` in order to allow method chaining
1526
1573
  */
1527
1574
  setShowDraftToggle(
@@ -1537,6 +1584,7 @@ declare module "sap/suite/ui/generic/template/lib/AppComponent" {
1537
1584
  *
1538
1585
  * Default value is `"auto"`.
1539
1586
  *
1587
+ *
1540
1588
  * @returns Reference to `this` in order to allow method chaining
1541
1589
  */
1542
1590
  setStatePreservationMode(
@@ -1552,6 +1600,7 @@ declare module "sap/suite/ui/generic/template/lib/AppComponent" {
1552
1600
  *
1553
1601
  * Default value is `"Middle"`.
1554
1602
  *
1603
+ *
1555
1604
  * @returns Reference to `this` in order to allow method chaining
1556
1605
  */
1557
1606
  setTableColumnVerticalAlignment(
@@ -1567,6 +1616,7 @@ declare module "sap/suite/ui/generic/template/lib/AppComponent" {
1567
1616
  *
1568
1617
  * Default value is `true`.
1569
1618
  *
1619
+ *
1570
1620
  * @returns Reference to `this` in order to allow method chaining
1571
1621
  */
1572
1622
  setUseColumnLayoutForSmartForm(
@@ -1643,8 +1693,6 @@ declare module "sap/suite/ui/generic/template/ListReport/controllerFrameworkExte
1643
1693
  */
1644
1694
  interface controllerFrameworkExtensions {
1645
1695
  /**
1646
- * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1647
- *
1648
1696
  * Obsolete and not called anymore. Kept here to avoid conflicts (in the very unlikely case, Fiori elements
1649
1697
  * would come up with the idea to invent a new extension method with the exact same name some day in future,
1650
1698
  * and any application would still have an implementation for this old extension).
@@ -1663,16 +1711,18 @@ declare module "sap/suite/ui/generic/template/ListReport/controllerFrameworkExte
1663
1711
  * to do that would only be found in very exceptional cases). With the newer API of SFB (getUiState and
1664
1712
  * setUiState), this problem has been overcome (esp. as setUiState overrides all filters, not only the ones
1665
1713
  * provided).)
1714
+ *
1715
+ * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1666
1716
  */
1667
1717
  getVisibleSelectionsWithDefaults: undefined;
1668
1718
 
1669
1719
  /**
1670
- * @ui5-protected Do not call from applications (only from related classes in the framework)
1671
- *
1672
1720
  * This method is called by SAP Fiori elements before triggering an external navigation. Application developers
1673
1721
  * can override this method and programmatically adapt the parameters which are passed to the target application.
1674
1722
  * Application developers can use the oObjectInfo parameter to identify the navigation context and modify
1675
1723
  * the oSelectionVariant which contains the navigation parameters.
1724
+ *
1725
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1676
1726
  */
1677
1727
  adaptNavigationParameterExtension(
1678
1728
  /**
@@ -1694,20 +1744,20 @@ declare module "sap/suite/ui/generic/template/ListReport/controllerFrameworkExte
1694
1744
  }
1695
1745
  ): void;
1696
1746
  /**
1697
- * @ui5-protected Do not call from applications (only from related classes in the framework)
1698
- *
1699
1747
  * This method is called by SAP Fiori elements whenever the busy state is switched off. Application developers
1700
1748
  * can override this method, access the message model and adapt the transient messages related to the component.
1749
+ *
1750
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1701
1751
  */
1702
1752
  adaptTransientMessageExtension(): void;
1703
1753
  /**
1704
- * @ui5-protected Do not call from applications (only from related classes in the framework)
1705
- *
1706
1754
  * This method is called by SAP Fiori elements when the delete operation is triggered. Application developers
1707
1755
  * can override this method in controller extension & perform additional checks before executing the delete
1708
1756
  * operation. Method is expected to return a Promise. To veto the delete operation, promise needs to be
1709
1757
  * rejected else resolved.
1710
1758
  *
1759
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1760
+ *
1711
1761
  * @returns - Promise object created by the extension, used for Delete operation chaining
1712
1762
  */
1713
1763
  beforeDeleteExtension(
@@ -1722,14 +1772,14 @@ declare module "sap/suite/ui/generic/template/ListReport/controllerFrameworkExte
1722
1772
  }
1723
1773
  ): Promise<any>;
1724
1774
  /**
1725
- * @ui5-protected Do not call from applications (only from related classes in the framework)
1726
- *
1727
1775
  * This method should be implemented whenever the application needs to have a custom save functionality
1728
1776
  * for multi edit scenario. The logic for save should be defined here and this method should return a promise
1729
1777
  * based on whose resolution or rejection the framework would perform cleanup tasks like closing the dialog
1730
1778
  * and refreshing the table data.There will be no chaining of multi edit save from the framework, if the
1731
1779
  * extension is implemented then the framework will only execute extension code for save.
1732
1780
  *
1781
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1782
+ *
1733
1783
  * @returns - Promise object created by the extension, used for cleanup after the promise is resolved or
1734
1784
  * rejected.
1735
1785
  */
@@ -1749,8 +1799,6 @@ declare module "sap/suite/ui/generic/template/ListReport/controllerFrameworkExte
1749
1799
  }>
1750
1800
  ): Promise<any>;
1751
1801
  /**
1752
- * @ui5-protected Do not call from applications (only from related classes in the framework)
1753
- *
1754
1802
  * This method is called by SAP Fiori elements when a smart link in a table is clicked. Application developers
1755
1803
  * can override this method and invoke the oParams.getSourceInfo method to find out the information about
1756
1804
  * the clicked smart link.
@@ -1758,6 +1806,8 @@ declare module "sap/suite/ui/generic/template/ListReport/controllerFrameworkExte
1758
1806
  * If the application expect the framework should not handle the `beforePopoverOpens` event, then this method
1759
1807
  * should return true. Otherwise, framework will proceed with its handling.
1760
1808
  *
1809
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1810
+ *
1761
1811
  * @returns Method should return `true` if framework should not handle `beforePopoverOpens` event (that
1762
1812
  * means: extension code will handle the event)
1763
1813
  */
@@ -1777,8 +1827,6 @@ declare module "sap/suite/ui/generic/template/ListReport/controllerFrameworkExte
1777
1827
  }
1778
1828
  ): boolean;
1779
1829
  /**
1780
- * @ui5-protected Do not call from applications (only from related classes in the framework)
1781
- *
1782
1830
  * This method is called by SAP Fiori elements before persisting the AppState. Application developers can
1783
1831
  * override this method for persisting the state of custom controls. State of the custom control (controls)
1784
1832
  * should be stored in the oCustomData passed as a parameter to this method. To make a complete functionality,
@@ -1798,6 +1846,8 @@ declare module "sap/suite/ui/generic/template/ListReport/controllerFrameworkExte
1798
1846
  * contained looks quite similar to the iAppState.)
1799
1847
  *
1800
1848
  * For more information, see {@link https://ui5.sap.com/#/topic/5fb9f57fcf12401bbe39a635e9a32a4e Adding Custom Fields to the Filter Bar}.
1849
+ *
1850
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1801
1851
  */
1802
1852
  getCustomAppStateDataExtension(
1803
1853
  /**
@@ -1806,8 +1856,6 @@ declare module "sap/suite/ui/generic/template/ListReport/controllerFrameworkExte
1806
1856
  oCustomData: object
1807
1857
  ): void;
1808
1858
  /**
1809
- * @ui5-protected Do not call from applications (only from related classes in the framework)
1810
- *
1811
1859
  * This method is called by SAP Fiori elements when the Create with Filters is executed. Application developers
1812
1860
  * can enable this feature in the LR component by adding createWithFilters in the settings object of the
1813
1861
  * List Report component & strategy needs to be set as `extension`. SmartFilterBar instance will be passed
@@ -1815,6 +1863,8 @@ declare module "sap/suite/ui/generic/template/ListReport/controllerFrameworkExte
1815
1863
  * the returning object map. Application developers will have complete control on properties passed to the
1816
1864
  * new instance creation.
1817
1865
  *
1866
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1867
+ *
1818
1868
  * @returns Key/Value map of the properties
1819
1869
  */
1820
1870
  getPredefinedValuesForCreateExtension(
@@ -1828,14 +1878,14 @@ declare module "sap/suite/ui/generic/template/ListReport/controllerFrameworkExte
1828
1878
  oDefaultValues: object
1829
1879
  ): Map<any, any>;
1830
1880
  /**
1831
- * @ui5-protected Do not call from applications (only from related classes in the framework)
1832
- *
1833
1881
  * This method is called by SAP Fiori elements in the startup life cycle of a component. Application developers
1834
1882
  * can override this method and modify the startup object. For an example, when the application is started,
1835
1883
  * the selection variant might contain some properties that are not required for this app. Such properties
1836
1884
  * can be removed from the selection variant. The reverse use case is also true, where some additional properties
1837
1885
  * needs to be added with certain fixed values. This can be achieved by adding these values to the selection
1838
1886
  * variant.
1887
+ *
1888
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1839
1889
  */
1840
1890
  modifyStartupExtension(
1841
1891
  /**
@@ -1861,13 +1911,13 @@ declare module "sap/suite/ui/generic/template/ListReport/controllerFrameworkExte
1861
1911
  }
1862
1912
  ): void;
1863
1913
  /**
1864
- * @ui5-protected Do not call from applications (only from related classes in the framework)
1865
- *
1866
1914
  * This method is called by SAP Fiori elements when the table data is getting exported. Application developers
1867
1915
  * can override this method to add/remove the filters in the exported file.
1868
1916
  *
1869
1917
  * To add new filter entries to the exported file, create an instance of {@link sap.ui.export.util.Filter }
1870
1918
  * and add it to "oExportParams.filterSettings"
1919
+ *
1920
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1871
1921
  */
1872
1922
  onBeforeExportTableExtension(
1873
1923
  /**
@@ -1886,8 +1936,6 @@ declare module "sap/suite/ui/generic/template/ListReport/controllerFrameworkExte
1886
1936
  }
1887
1937
  ): void;
1888
1938
  /**
1889
- * @ui5-protected Do not call from applications (only from related classes in the framework)
1890
- *
1891
1939
  * This method is called by SAP Fiori elements before binding a chart. Application developers can override
1892
1940
  * this method and programmatically modify parameters or filters before chart triggers a query to retrieve
1893
1941
  * data.
@@ -1895,6 +1943,8 @@ declare module "sap/suite/ui/generic/template/ListReport/controllerFrameworkExte
1895
1943
  * For more information, see {@link https://ui5.sap.com/#/topic/5fb9f57fcf12401bbe39a635e9a32a4e Adding Custom Fields to the Filter Bar}.
1896
1944
  *
1897
1945
  * **Note: **This method is called only when a chart is rebound, and not when it is refreshed.
1946
+ *
1947
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1898
1948
  */
1899
1949
  onBeforeRebindChartExtension(
1900
1950
  /**
@@ -1903,8 +1953,6 @@ declare module "sap/suite/ui/generic/template/ListReport/controllerFrameworkExte
1903
1953
  oEvent: Event
1904
1954
  ): void;
1905
1955
  /**
1906
- * @ui5-protected Do not call from applications (only from related classes in the framework)
1907
- *
1908
1956
  * This method is called by SAP Fiori elements before binding a table. Application developers can override
1909
1957
  * this method and programmatically modify parameters or filters before the table triggers a query to retrieve
1910
1958
  * data.
@@ -1912,6 +1960,8 @@ declare module "sap/suite/ui/generic/template/ListReport/controllerFrameworkExte
1912
1960
  * For more information, see {@link https://ui5.sap.com/#/topic/5fb9f57fcf12401bbe39a635e9a32a4e Adding Custom Fields to the Filter Bar}.
1913
1961
  *
1914
1962
  * **Note: **This method is called only when a table is rebound, and not when it is refreshed.
1963
+ *
1964
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1915
1965
  */
1916
1966
  onBeforeRebindTableExtension(
1917
1967
  /**
@@ -1920,13 +1970,13 @@ declare module "sap/suite/ui/generic/template/ListReport/controllerFrameworkExte
1920
1970
  oEvent: Event
1921
1971
  ): void;
1922
1972
  /**
1923
- * @ui5-protected Do not call from applications (only from related classes in the framework)
1924
- *
1925
1973
  * This method should be implemented whenever application uses onListNavigationExtension for internal navigation.
1926
1974
  * In this case the implementation of this method should provide an 'inverse' mapping to the transformation
1927
1975
  * implemented within onListNavigationExtension. More precisely, the identification of a child page instance
1928
1976
  * is passed to this function. The implementation of this function should provide information about the
1929
1977
  * list item which has triggered the opening of the child page.
1978
+ *
1979
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1930
1980
  */
1931
1981
  onChildOpenedExtension(
1932
1982
  /**
@@ -1953,15 +2003,13 @@ declare module "sap/suite/ui/generic/template/ListReport/controllerFrameworkExte
1953
2003
  fnSetPath: Function
1954
2004
  ): void;
1955
2005
  /**
1956
- * @ui5-protected Do not call from applications (only from related classes in the framework)
1957
- *
1958
2006
  * This method is called by SAP Fiori elements on the initialization of View. Application developers can
1959
2007
  * override this method & perform internal setup in this hook, It is only called once per View instance.
2008
+ *
2009
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1960
2010
  */
1961
2011
  onInit(): void;
1962
2012
  /**
1963
- * @ui5-protected Do not call from applications (only from related classes in the framework)
1964
- *
1965
2013
  * This method is called by SAP Fiori elements once the smart filter bar is initialized with a variant.
1966
2014
  *
1967
2015
  * Application developers can override this method when there is a custom filter field bound outside the
@@ -1971,6 +2019,8 @@ declare module "sap/suite/ui/generic/template/ListReport/controllerFrameworkExte
1971
2019
  * value according to the data type and cannot be provided in the view fragment.
1972
2020
  *
1973
2021
  * For more information, see {@link https://ui5.sap.com/#/topic/5fb9f57fcf12401bbe39a635e9a32a4e Adding Custom Fields to the Filter Bar}.
2022
+ *
2023
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1974
2024
  */
1975
2025
  onInitSmartFilterBarExtension(
1976
2026
  /**
@@ -1979,12 +2029,12 @@ declare module "sap/suite/ui/generic/template/ListReport/controllerFrameworkExte
1979
2029
  oEvent: Event
1980
2030
  ): void;
1981
2031
  /**
1982
- * @ui5-protected Do not call from applications (only from related classes in the framework)
1983
- *
1984
2032
  * This method is called when the user leaves the app and this page has been displayed within the same app
1985
2033
  * session (this is the time since last opening the app) at least once. Moreover, it is called for all pages
1986
2034
  * that have been displayed within some app session when the app is finally destroyed.
1987
2035
  *
2036
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2037
+ *
1988
2038
  * @returns - Only relevant in case that `isDestroyed` is false. In this case Application developers can
1989
2039
  * provide a function to be called when the same page is opened again (after the user has navigated back
1990
2040
  * to the app).
@@ -1997,12 +2047,12 @@ declare module "sap/suite/ui/generic/template/ListReport/controllerFrameworkExte
1997
2047
  bIsDestroyed: boolean
1998
2048
  ): Function;
1999
2049
  /**
2000
- * @ui5-protected Do not call from applications (only from related classes in the framework)
2001
- *
2002
2050
  * This method is called by SAP Fiori elements when a chevron navigation is triggered from a table. Application
2003
2051
  * developers can override this method and perform conditional (internal or external) navigation from different
2004
2052
  * rows of a table. Such custom navigation should be triggered via corresponding methods of {@link sap.suite.ui.generic.template.extensionAPI.NavigationController NavigationController}.
2005
2053
  *
2054
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2055
+ *
2006
2056
  * @returns Method should return `true` if framework navigation should be suppressed (that means: extension
2007
2057
  * code has taken over navigation)
2008
2058
  */
@@ -2023,11 +2073,11 @@ declare module "sap/suite/ui/generic/template/ListReport/controllerFrameworkExte
2023
2073
  bReplaceInHistory: boolean
2024
2074
  ): boolean;
2025
2075
  /**
2026
- * @ui5-protected Do not call from applications (only from related classes in the framework)
2027
- *
2028
2076
  * This method is called by SAP Fiori elements when the Share functionality is triggered. Application developers
2029
2077
  * can adapt the service URL passed as a parameter to this method. Adapted service URL will be used in the
2030
2078
  * 'Send Email' or 'Save as Tile' options.
2079
+ *
2080
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2031
2081
  */
2032
2082
  onSaveAsTileExtension(
2033
2083
  /**
@@ -2041,8 +2091,6 @@ declare module "sap/suite/ui/generic/template/ListReport/controllerFrameworkExte
2041
2091
  }
2042
2092
  ): void;
2043
2093
  /**
2044
- * @ui5-protected Do not call from applications (only from related classes in the framework)
2045
- *
2046
2094
  * This method is called by SAP Fiori elements while applying the AppState. This method should be overridden
2047
2095
  * in combination with `getCustomAppStateDataExtension`. The custom data retrieved from the AppState will
2048
2096
  * be passed as a parameter to this method. Application developers can use this custom data to restore the
@@ -2056,6 +2104,8 @@ declare module "sap/suite/ui/generic/template/ListReport/controllerFrameworkExte
2056
2104
  * doing anything.
2057
2105
  *
2058
2106
  * For more information, see {@link https://ui5.sap.com/#/topic/5fb9f57fcf12401bbe39a635e9a32a4e Adding Custom Fields to the Filter Bar}.
2107
+ *
2108
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2059
2109
  */
2060
2110
  restoreCustomAppStateDataExtension(
2061
2111
  /**
@@ -2094,6 +2144,7 @@ declare module "sap/suite/ui/generic/template/ListReport/extensionAPI/ExtensionA
2094
2144
  *
2095
2145
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
2096
2146
  *
2147
+ *
2097
2148
  * @returns Created class / constructor function
2098
2149
  */
2099
2150
  static extend<T extends Record<string, unknown>>(
@@ -2114,6 +2165,7 @@ declare module "sap/suite/ui/generic/template/ListReport/extensionAPI/ExtensionA
2114
2165
  /**
2115
2166
  * Returns a metadata object for class sap.suite.ui.generic.template.ListReport.extensionAPI.ExtensionAPI.
2116
2167
  *
2168
+ *
2117
2169
  * @returns Metadata object describing this class
2118
2170
  */
2119
2171
  static getMetadata(): Metadata;
@@ -2131,20 +2183,22 @@ declare module "sap/suite/ui/generic/template/ListReport/extensionAPI/ExtensionA
2131
2183
  /**
2132
2184
  * Get the navigation controller for navigation actions
2133
2185
  *
2186
+ *
2134
2187
  * @returns the navigation controller
2135
2188
  */
2136
2189
  getNavigationController(): NavigationController;
2137
2190
  /**
2138
- * @experimental
2139
- *
2140
2191
  * If switching between different table views is enabled, this function returns the selected key.
2141
2192
  *
2193
+ * @experimental
2194
+ *
2142
2195
  * @returns The key of the variant item that is currently selected.
2143
2196
  */
2144
2197
  getQuickVariantSelectionKey(): string;
2145
2198
  /**
2146
2199
  * Get the list entries currently selected for smart table
2147
2200
  *
2201
+ *
2148
2202
  * @returns contains one entry per line selected
2149
2203
  */
2150
2204
  getSelectedContexts(): Context[];
@@ -2152,12 +2206,14 @@ declare module "sap/suite/ui/generic/template/ListReport/extensionAPI/ExtensionA
2152
2206
  * Get the transaction controller for editing actions on the list. Note: Currently implemented for non draft
2153
2207
  * case
2154
2208
  *
2209
+ *
2155
2210
  * @returns the transaction controller
2156
2211
  */
2157
2212
  getTransactionController(): NonDraftTransactionController;
2158
2213
  /**
2159
2214
  * Invokes multiple time the action with the given name and submits changes to the back-end.
2160
2215
  *
2216
+ *
2161
2217
  * @returns A `Promise` for asynchronous execution of the action, resolving to the same result as the `Promise`
2162
2218
  * returned from {@link sap.ui.generic.app.ApplicationController#invokeActions}
2163
2219
  */
@@ -2219,6 +2275,7 @@ declare module "sap/suite/ui/generic/template/ListReport/extensionAPI/ExtensionA
2219
2275
  * Secured execution of the given function. Ensures that the function is only executed when certain conditions
2220
2276
  * are fulfilled. For more information, see {@link https://ui5.sap.com/#/topic/6a39150ad3e548a8b5304d32d560790a Using the SecuredExecutionMethod}.
2221
2277
  *
2278
+ *
2222
2279
  * @returns A `Promise` that is rejected, if execution is prohibited, and settled equivalent to the one
2223
2280
  * returned by fnFunction.
2224
2281
  */
@@ -2307,9 +2364,9 @@ declare module "sap/suite/ui/generic/template/ListReport/extensionAPI/ExtensionA
2307
2364
  onClose?: Function
2308
2365
  ): void;
2309
2366
  /**
2310
- * @experimental
2311
- *
2312
2367
  * If switching between different table views is enabled, this function sets the selected key.
2368
+ *
2369
+ * @experimental
2313
2370
  */
2314
2371
  setQuickVariantSelectionKey(
2315
2372
  /**
@@ -2342,6 +2399,7 @@ declare module "sap/suite/ui/generic/template/ListReport/extensionAPI/NonDraftTr
2342
2399
  *
2343
2400
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
2344
2401
  *
2402
+ *
2345
2403
  * @returns Created class / constructor function
2346
2404
  */
2347
2405
  static extend<T extends Record<string, unknown>>(
@@ -2362,6 +2420,7 @@ declare module "sap/suite/ui/generic/template/ListReport/extensionAPI/NonDraftTr
2362
2420
  /**
2363
2421
  * Returns a metadata object for class sap.suite.ui.generic.template.ListReport.extensionAPI.NonDraftTransactionController.
2364
2422
  *
2423
+ *
2365
2424
  * @returns Metadata object describing this class
2366
2425
  */
2367
2426
  static getMetadata(): Metadata;
@@ -2372,6 +2431,7 @@ declare module "sap/suite/ui/generic/template/ListReport/extensionAPI/NonDraftTr
2372
2431
  /**
2373
2432
  * This method can be called when a new entry with predefined values should be created (e.g. in a copy scenario).
2374
2433
  *
2434
+ *
2375
2435
  * @returns a context representing the object to be created. It can be passed to {@link sap.suite.ui.generic.template.extensionAPI.NavigationController#navigateInternal }
2376
2436
  * in order to visit the corresponding object page.
2377
2437
  */
@@ -2401,6 +2461,7 @@ declare module "sap/suite/ui/generic/template/ListReport/extensionAPI/NonDraftTr
2401
2461
  * and doesn't execute if application is already busy when called (i.e. don't use `ExtensionAPI.securedExecution`
2402
2462
  * to call this method).
2403
2463
  *
2464
+ *
2404
2465
  * @returns is resolved when entry is successfully saved and rejected when saving fails
2405
2466
  */
2406
2467
  save(): Promise<any>;
@@ -2424,12 +2485,12 @@ declare module "sap/suite/ui/generic/template/ObjectPage/controllerFrameworkExte
2424
2485
  */
2425
2486
  interface controllerFrameworkExtensions {
2426
2487
  /**
2427
- * @ui5-protected Do not call from applications (only from related classes in the framework)
2428
- *
2429
2488
  * This method is called by SAP Fiori elements before triggering an external navigation. Application developers
2430
2489
  * can override this method and programmatically adapt the parameters which are passed to the target application.
2431
2490
  * Application developers can use the oObjectInfo parameter to identify the navigation context and modify
2432
2491
  * the oSelectionVariant which contains the navigation parameters.
2492
+ *
2493
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2433
2494
  */
2434
2495
  adaptNavigationParameterExtension(
2435
2496
  /**
@@ -2451,21 +2512,21 @@ declare module "sap/suite/ui/generic/template/ObjectPage/controllerFrameworkExte
2451
2512
  }
2452
2513
  ): void;
2453
2514
  /**
2454
- * @ui5-protected Do not call from applications (only from related classes in the framework)
2455
- *
2456
2515
  * This method is called by SAP Fiori elements whenever the busy state is switched off. Application developers
2457
2516
  * can override this method, access the message model and adapt the transient messages related to the component.
2517
+ *
2518
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2458
2519
  */
2459
2520
  adaptTransientMessageExtension(): void;
2460
2521
  /**
2461
- * @ui5-protected Do not call from applications (only from related classes in the framework)
2462
- *
2463
2522
  * This method will be called by SAP Fiori elements while applying the AppState. The custom state object
2464
2523
  * retrieved from the AppState will be passed as a parameter to this method. Application developers can
2465
2524
  * use this custom state for restoring the state of the custom control. To make a complete functionality,
2466
2525
  * this method should be overridden with `provideCustomStateExtension`.
2467
2526
  * See:
2468
2527
  * {@link https://ui5.sap.com/#/topic/89fa878945294931b15a581a99043005 Custom State Handling for Extended Apps}
2528
+ *
2529
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2469
2530
  */
2470
2531
  applyCustomStateExtension(
2471
2532
  /**
@@ -2480,19 +2541,17 @@ declare module "sap/suite/ui/generic/template/ObjectPage/controllerFrameworkExte
2480
2541
  bIsSameAsLast: boolean
2481
2542
  ): void;
2482
2543
  /**
2483
- * @ui5-protected Do not call from applications (only from related classes in the framework)
2484
- *
2485
2544
  * This method is called by SAP Fiori element when Delete button on the Object Page is clicked. Application
2486
2545
  * developers can override this method & perform additional checks before executing the delete operation.
2487
2546
  * Method is expected to return a Promise. To veto the delete operation, promise needs to be rejected else
2488
2547
  * resolved.
2489
2548
  *
2549
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2550
+ *
2490
2551
  * @returns Promise object created by the extension, used for delete operation chaining
2491
2552
  */
2492
2553
  beforeDeleteExtension(): Promise<any>;
2493
2554
  /**
2494
- * @ui5-protected Do not call from applications (only from related classes in the framework)
2495
- *
2496
2555
  * This method is called when the Delete operation is triggered on a table in the Object Page. Application
2497
2556
  * developers can override this method & perform additional checks before executing the delete operation.
2498
2557
  * Method is expected to return a Promise. Delete operation is executed only once the returned promise is
@@ -2500,6 +2559,8 @@ declare module "sap/suite/ui/generic/template/ObjectPage/controllerFrameworkExte
2500
2559
  * Application developers can use `sUiElementId` property of the object passed as param to identify the
2501
2560
  * smart table where the Delete operation is being triggered.
2502
2561
  *
2562
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2563
+ *
2503
2564
  * @returns Promise object created by the extension, used for Delete operation chaining
2504
2565
  */
2505
2566
  beforeLineItemDeleteExtension(
@@ -2518,8 +2579,6 @@ declare module "sap/suite/ui/generic/template/ObjectPage/controllerFrameworkExte
2518
2579
  }
2519
2580
  ): Promise<any>;
2520
2581
  /**
2521
- * @ui5-protected Do not call from applications (only from related classes in the framework)
2522
- *
2523
2582
  * This method is called by SAP Fiori elements when Save button is selected. Application developers can
2524
2583
  * override this method and perform a custom operation before executing the Save operation. The method is
2525
2584
  * expected to return a Promise. The save operation will be continued only once the promise is resolved.
@@ -2529,12 +2588,12 @@ declare module "sap/suite/ui/generic/template/ObjectPage/controllerFrameworkExte
2529
2588
  * requesting the user to enter additional data or confirmation. The returned Promise would be resolved
2530
2589
  * if the user confirms the dialog and rejected if it is canceled.
2531
2590
  *
2591
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2592
+ *
2532
2593
  * @returns Promise object created by the extension, used for Save operation chaining
2533
2594
  */
2534
2595
  beforeSaveExtension(): Promise<any>;
2535
2596
  /**
2536
- * @ui5-protected Do not call from applications (only from related classes in the framework)
2537
- *
2538
2597
  * This method is called by SAP Fiori elements when a smart link in a table or form is clicked. Application
2539
2598
  * developers can override this method and invoke the oParams.getSourceInfo method to find out the information
2540
2599
  * about the clicked smart link.
@@ -2542,6 +2601,8 @@ declare module "sap/suite/ui/generic/template/ObjectPage/controllerFrameworkExte
2542
2601
  * If the application expect the framework should not handle the `beforePopoverOpens` event, then this method
2543
2602
  * should return true. Otherwise, framework will proceed with its handling.
2544
2603
  *
2604
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2605
+ *
2545
2606
  * @returns Method should return `true` if framework should not handle `beforePopoverOpens` event (that
2546
2607
  * means: extension code will handle the event)
2547
2608
  */
@@ -2561,13 +2622,13 @@ declare module "sap/suite/ui/generic/template/ObjectPage/controllerFrameworkExte
2561
2622
  }
2562
2623
  ): boolean;
2563
2624
  /**
2564
- * @ui5-protected Do not call from applications (only from related classes in the framework)
2565
- *
2566
2625
  * This method is called by SAP Fiori elements when the table data is getting exported. Application developers
2567
2626
  * can override this method to add/remove the filters in the exported file.
2568
2627
  *
2569
2628
  * To add new filter entries to the exported file, create an instance of {@link sap.ui.export.util.Filter }
2570
2629
  * and add it to "oExportParams.filterSettings"
2630
+ *
2631
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2571
2632
  */
2572
2633
  onBeforeExportTableExtension(
2573
2634
  /**
@@ -2586,13 +2647,13 @@ declare module "sap/suite/ui/generic/template/ObjectPage/controllerFrameworkExte
2586
2647
  }
2587
2648
  ): void;
2588
2649
  /**
2589
- * @ui5-protected Do not call from applications (only from related classes in the framework)
2590
- *
2591
2650
  * This method is called by SAP Fiori elements before binding a table. Application developers can override
2592
2651
  * this method and programmatically modify parameters or filters before the table triggers a query to retrieve
2593
2652
  * data. Source property of the oEvent shall be used to determine table triggering the event
2594
2653
  *
2595
2654
  * **Note: **This method is called only when a table is rebound, and not when it is refreshed.
2655
+ *
2656
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2596
2657
  */
2597
2658
  onBeforeRebindTableExtension(
2598
2659
  /**
@@ -2601,13 +2662,13 @@ declare module "sap/suite/ui/generic/template/ObjectPage/controllerFrameworkExte
2601
2662
  oEvent: Event
2602
2663
  ): void;
2603
2664
  /**
2604
- * @ui5-protected Do not call from applications (only from related classes in the framework)
2605
- *
2606
2665
  * This method should be implemented whenever application uses onListNavigationExtension for internal navigation.
2607
2666
  * In this case the implementation of this method should provide an 'inverse' mapping to the transformation
2608
2667
  * implemented within onListNavigationExtension. More precisely, the identification of a child page instance
2609
2668
  * is passed to this function. The implementation of this function should provide information about the
2610
2669
  * list item which has triggered the opening of the child page.
2670
+ *
2671
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2611
2672
  */
2612
2673
  onChildOpenedExtension(
2613
2674
  /**
@@ -2634,19 +2695,19 @@ declare module "sap/suite/ui/generic/template/ObjectPage/controllerFrameworkExte
2634
2695
  fnSetPath: Function
2635
2696
  ): void;
2636
2697
  /**
2637
- * @ui5-protected Do not call from applications (only from related classes in the framework)
2638
- *
2639
2698
  * This method is called by SAP Fiori elements on the initialization of View. Application developers can
2640
2699
  * override this method & perform internal setup in this hook.
2700
+ *
2701
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2641
2702
  */
2642
2703
  onInit(): void;
2643
2704
  /**
2644
- * @ui5-protected Do not call from applications (only from related classes in the framework)
2645
- *
2646
2705
  * This method is called when the user leaves the app and this page has been displayed within the same app
2647
2706
  * session (this is the time since last opening the app) at least once. Moreover, it is called for all pages
2648
2707
  * that have been displayed within some app session when the app is finally destroyed.
2649
2708
  *
2709
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2710
+ *
2650
2711
  * @returns - Only relevant in case that `bIsDestroyed` is false. In this case Application developers can
2651
2712
  * provide a function to be called when the same page is opened again (after the user has navigated back
2652
2713
  * to the app).
@@ -2659,12 +2720,12 @@ declare module "sap/suite/ui/generic/template/ObjectPage/controllerFrameworkExte
2659
2720
  bIsDestroyed: boolean
2660
2721
  ): Function;
2661
2722
  /**
2662
- * @ui5-protected Do not call from applications (only from related classes in the framework)
2663
- *
2664
2723
  * This method is called by SAP Fiori elements when a chevron navigation is triggered from a table. Application
2665
2724
  * developers can override this method and perform conditional (internal or external) navigation from different
2666
2725
  * rows of a table. Such custom navigation should be triggered via corresponding methods of {@link sap.suite.ui.generic.template.extensionAPI.NavigationController NavigationController}.
2667
2726
  *
2727
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2728
+ *
2668
2729
  * @returns Method should return `true` if framework navigation should be suppressed (that means: extension
2669
2730
  * code has taken over navigation)
2670
2731
  */
@@ -2685,11 +2746,11 @@ declare module "sap/suite/ui/generic/template/ObjectPage/controllerFrameworkExte
2685
2746
  bReplaceInHistory: boolean
2686
2747
  ): boolean;
2687
2748
  /**
2688
- * @ui5-protected Do not call from applications (only from related classes in the framework)
2689
- *
2690
2749
  * This method is called by SAP Fiori elements when the Share functionality is triggered. Application developers
2691
2750
  * can adapt the service URL passed as a parameter to this method. Adapted service URL will be used in the
2692
2751
  * 'Send Email' or 'Save as Tile' options.
2752
+ *
2753
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2693
2754
  */
2694
2755
  onSaveAsTileExtension(
2695
2756
  /**
@@ -2703,13 +2764,13 @@ declare module "sap/suite/ui/generic/template/ObjectPage/controllerFrameworkExte
2703
2764
  }
2704
2765
  ): void;
2705
2766
  /**
2706
- * @ui5-protected Do not call from applications (only from related classes in the framework)
2707
- *
2708
2767
  * This method is called when the SubSection enters the Viewport first time for an ObjectPage. Method would
2709
2768
  * be called again for the same SubSection only in case ObjectPage binding context is changed. Application
2710
2769
  * developers could use this method to perform specific actions on the current SubSection children. This
2711
2770
  * enables the application to perform actions relevant to a specific section when it really comes to view
2712
2771
  * port. Control specific handling should be done in this method in case View LazyLoading is enabled.
2772
+ *
2773
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2713
2774
  */
2714
2775
  onSubSectionEnteredExtension(
2715
2776
  /**
@@ -2718,14 +2779,14 @@ declare module "sap/suite/ui/generic/template/ObjectPage/controllerFrameworkExte
2718
2779
  oSubSection: ObjectPageSubSection
2719
2780
  ): void;
2720
2781
  /**
2721
- * @ui5-protected Do not call from applications (only from related classes in the framework)
2722
- *
2723
2782
  * This method will be called by SAP Fiori elements before persisting the AppState. Application developers
2724
2783
  * can override this method for persisting the state of custom controls. State of the custom controls should
2725
2784
  * be stored in the oState object passed as a parameter to this method. To make a complete functionality,
2726
2785
  * this method should be overridden with `applyCustomStateExtension`.
2727
2786
  * See:
2728
2787
  * {@link https://ui5.sap.com/#/topic/89fa878945294931b15a581a99043005 Custom State Handling for Extended Apps}
2788
+ *
2789
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2729
2790
  */
2730
2791
  provideCustomStateExtension(
2731
2792
  /**
@@ -2756,6 +2817,7 @@ declare module "sap/suite/ui/generic/template/ObjectPage/extensionAPI/DraftTrans
2756
2817
  *
2757
2818
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
2758
2819
  *
2820
+ *
2759
2821
  * @returns Created class / constructor function
2760
2822
  */
2761
2823
  static extend<T extends Record<string, unknown>>(
@@ -2776,6 +2838,7 @@ declare module "sap/suite/ui/generic/template/ObjectPage/extensionAPI/DraftTrans
2776
2838
  /**
2777
2839
  * Returns a metadata object for class sap.suite.ui.generic.template.ObjectPage.extensionAPI.DraftTransactionController.
2778
2840
  *
2841
+ *
2779
2842
  * @returns Metadata object describing this class
2780
2843
  */
2781
2844
  static getMetadata(): Metadata;
@@ -2843,22 +2906,22 @@ declare module "sap/suite/ui/generic/template/ObjectPage/extensionAPI/DraftTrans
2843
2906
  fnFunction: Function
2844
2907
  ): void;
2845
2908
  /**
2846
- * @experimental
2847
- *
2848
2909
  * Cancel the draft. Note that this method only works when you are on the root of a draft. The normal navigation
2849
2910
  * which follows the cancellation of a draft is executed. Moreover, note that executing this method will
2850
2911
  * set the App to be busy. However, it does not ensure, that the method is only called, when the App is
2851
2912
  * currently unbusy. If you want to ensure that, you have to use {@link sap.suite.ui.generic.template.ObjectPage.extensionAPI.ExtensionAPI#securedExecution}.
2852
2913
  *
2914
+ * @experimental
2915
+ *
2853
2916
  * @returns a promise that is resolved when the draft is cancelled, rejected when this is not possible.
2854
2917
  */
2855
2918
  discardDraft(): Function;
2856
2919
  /**
2857
- * @experimental
2858
- *
2859
2920
  * checks if side effects exist for the given properties or entities and executes them. if there are pending
2860
2921
  * changes in the model those pending changes are sent as a patch request with the side effect batch request.
2861
2922
  * If no source property and no source entity is passed a global side effect is executed
2923
+ *
2924
+ * @experimental
2862
2925
  */
2863
2926
  executeSideEffects(
2864
2927
  /**
@@ -2924,6 +2987,7 @@ declare module "sap/suite/ui/generic/template/ObjectPage/extensionAPI/ExtensionA
2924
2987
  *
2925
2988
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
2926
2989
  *
2990
+ *
2927
2991
  * @returns Created class / constructor function
2928
2992
  */
2929
2993
  static extend<T extends Record<string, unknown>>(
@@ -2944,6 +3008,7 @@ declare module "sap/suite/ui/generic/template/ObjectPage/extensionAPI/ExtensionA
2944
3008
  /**
2945
3009
  * Returns a metadata object for class sap.suite.ui.generic.template.ObjectPage.extensionAPI.ExtensionAPI.
2946
3010
  *
3011
+ *
2947
3012
  * @returns Metadata object describing this class
2948
3013
  */
2949
3014
  static getMetadata(): Metadata;
@@ -2982,14 +3047,15 @@ declare module "sap/suite/ui/generic/template/ObjectPage/extensionAPI/ExtensionA
2982
3047
  /**
2983
3048
  * Get the navigation controller for navigation actions
2984
3049
  *
3050
+ *
2985
3051
  * @returns the navigation controller
2986
3052
  */
2987
3053
  getNavigationController(): NavigationController;
2988
3054
  /**
2989
- * @experimental
2990
- *
2991
3055
  * This function returns the selected key of selected table of Object Page.
2992
3056
  *
3057
+ * @experimental
3058
+ *
2993
3059
  * @returns The key of variant item that is currently selected section.
2994
3060
  */
2995
3061
  getQuickVariantSelectionKey(
@@ -3001,6 +3067,7 @@ declare module "sap/suite/ui/generic/template/ObjectPage/extensionAPI/ExtensionA
3001
3067
  /**
3002
3068
  * Get the entries currently selected in one ui element (table, chart, or list)
3003
3069
  *
3070
+ *
3004
3071
  * @returns contains one entry per entry selected
3005
3072
  */
3006
3073
  getSelectedContexts(
@@ -3013,6 +3080,7 @@ declare module "sap/suite/ui/generic/template/ObjectPage/extensionAPI/ExtensionA
3013
3080
  * Get the transaction controller for editing actions on the page. Note that the methods provided by this
3014
3081
  * transaction controller depend on whether the object supports drafts or not.
3015
3082
  *
3083
+ *
3016
3084
  * @returns the transaction controller
3017
3085
  */
3018
3086
  getTransactionController():
@@ -3021,16 +3089,17 @@ declare module "sap/suite/ui/generic/template/ObjectPage/extensionAPI/ExtensionA
3021
3089
  /**
3022
3090
  * Get the id of the view this extension api belongs to
3023
3091
  *
3092
+ *
3024
3093
  * @returns the view id
3025
3094
  */
3026
3095
  getViewId(): string;
3027
3096
  /**
3028
- * @experimental
3029
- *
3030
3097
  * Hides Section and/or SubSection's title for embedded components and custom section(s), if the Section
3031
3098
  * and/or SubSection's title matches with the inner Control's title. In case the control's resolved title
3032
3099
  * is provided and is same as section's title, then the section's title is also automatically hidden. It's
3033
3100
  * meant to be invoked from the onSubSectionEnteredExtension ExtensionAPI.
3101
+ *
3102
+ * @experimental
3034
3103
  */
3035
3104
  hideDuplicateSectionOrSubSectionTitle(
3036
3105
  /**
@@ -3046,6 +3115,7 @@ declare module "sap/suite/ui/generic/template/ObjectPage/extensionAPI/ExtensionA
3046
3115
  /**
3047
3116
  * Invokes multiple time the action with the given name and submits changes to the back-end.
3048
3117
  *
3118
+ *
3049
3119
  * @returns A `Promise` for asynchronous execution of the action, resolving to the same result as the `Promise`
3050
3120
  * returned from {@link sap.ui.generic.app.ApplicationController#invokeActions}
3051
3121
  */
@@ -3079,6 +3149,7 @@ declare module "sap/suite/ui/generic/template/ObjectPage/extensionAPI/ExtensionA
3079
3149
  * See:
3080
3150
  * {@link https://ui5.sap.com/#/topic/89fa878945294931b15a581a99043005 Custom State Handling for Extended Apps}
3081
3151
  *
3152
+ *
3082
3153
  * @returns A `Promise` that is resolved when the changed state is transferred to the URL and the corresponding
3083
3154
  * busy session is ended.
3084
3155
  */
@@ -3130,6 +3201,7 @@ declare module "sap/suite/ui/generic/template/ObjectPage/extensionAPI/ExtensionA
3130
3201
  * See:
3131
3202
  * {@link https://ui5.sap.com/#/topic/6a39150ad3e548a8b5304d32d560790a Using the SecuredExecutionMethod}
3132
3203
  *
3204
+ *
3133
3205
  * @returns A `Promise` that is rejected, if execution is prohibited, and settled equivalent to the one
3134
3206
  * returned by fnFunction.
3135
3207
  */
@@ -3243,9 +3315,9 @@ declare module "sap/suite/ui/generic/template/ObjectPage/extensionAPI/ExtensionA
3243
3315
  onClose?: Function
3244
3316
  ): void;
3245
3317
  /**
3246
- * @experimental
3247
- *
3248
3318
  * This function sets the key in the selected section of the table of Object Page.
3319
+ *
3320
+ * @experimental
3249
3321
  */
3250
3322
  setQuickVariantSelectionKey(
3251
3323
  /**
@@ -3280,6 +3352,7 @@ declare module "sap/suite/ui/generic/template/ObjectPage/extensionAPI/NonDraftTr
3280
3352
  *
3281
3353
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
3282
3354
  *
3355
+ *
3283
3356
  * @returns Created class / constructor function
3284
3357
  */
3285
3358
  static extend<T extends Record<string, unknown>>(
@@ -3300,6 +3373,7 @@ declare module "sap/suite/ui/generic/template/ObjectPage/extensionAPI/NonDraftTr
3300
3373
  /**
3301
3374
  * Returns a metadata object for class sap.suite.ui.generic.template.ObjectPage.extensionAPI.NonDraftTransactionController.
3302
3375
  *
3376
+ *
3303
3377
  * @returns Metadata object describing this class
3304
3378
  */
3305
3379
  static getMetadata(): Metadata;
@@ -3348,6 +3422,7 @@ declare module "sap/suite/ui/generic/template/ObjectPage/extensionAPI/NonDraftTr
3348
3422
  /**
3349
3423
  * This method can be called when a new entry with predefined values should be created (e.g. in a copy scenario).
3350
3424
  *
3425
+ *
3351
3426
  * @returns a context representing the object to be created. It can be passed to {@link sap.suite.ui.generic.template.extensionAPI.NavigationController#navigateInternal }
3352
3427
  * in order to visit the corresponding object page.
3353
3428
  */