@sapui5/types 1.114.0 → 1.115.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/types/index.d.ts +2 -0
- package/types/sap.apf.d.ts +70 -60
- package/types/sap.ca.ui.d.ts +207 -105
- package/types/sap.chart.d.ts +213 -143
- package/types/sap.collaboration.d.ts +98 -87
- package/types/sap.esh.search.ui.d.ts +92 -2
- package/types/sap.f.d.ts +1780 -1315
- package/types/sap.fe.core.d.ts +78 -205
- package/types/sap.fe.macros.d.ts +120 -10
- package/types/sap.fe.navigation.d.ts +39 -32
- package/types/sap.fe.placeholder.d.ts +3 -0
- package/types/sap.fe.templates.d.ts +16 -292
- package/types/sap.fe.test.d.ts +40 -13
- package/types/sap.fe.tools.d.ts +3 -0
- package/types/sap.feedback.ui.d.ts +1 -1
- package/types/sap.gantt.d.ts +1987 -1251
- package/types/sap.insights.d.ts +1 -1
- package/types/sap.landvisz.d.ts +75 -29
- package/types/sap.m.d.ts +12407 -8461
- package/types/sap.makit.d.ts +88 -28
- package/types/sap.me.d.ts +167 -78
- package/types/sap.ndc.d.ts +115 -42
- package/types/sap.ovp.d.ts +3 -3
- package/types/sap.rules.ui.d.ts +53 -24
- package/types/sap.sac.df.d.ts +11 -8
- package/types/sap.suite.ui.commons.d.ts +2090 -1437
- package/types/sap.suite.ui.generic.template.d.ts +99 -97
- package/types/sap.suite.ui.microchart.d.ts +492 -322
- package/types/sap.tnt.d.ts +173 -95
- package/types/sap.ui.codeeditor.d.ts +61 -39
- package/types/sap.ui.commons.d.ts +1393 -846
- package/types/sap.ui.comp.d.ts +4159 -2878
- package/types/sap.ui.core.d.ts +6286 -3651
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.export.d.ts +76 -53
- package/types/sap.ui.fl.d.ts +160 -100
- package/types/sap.ui.generic.app.d.ts +58 -49
- package/types/sap.ui.generic.template.d.ts +1 -1
- package/types/sap.ui.integration.d.ts +502 -375
- package/types/sap.ui.layout.d.ts +603 -640
- package/types/sap.ui.mdc.d.ts +22208 -140
- package/types/sap.ui.richtexteditor.d.ts +106 -70
- package/types/sap.ui.rta.d.ts +7 -7
- package/types/sap.ui.suite.d.ts +29 -13
- package/types/sap.ui.support.d.ts +15 -16
- package/types/sap.ui.table.d.ts +907 -647
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +1765 -1179
- package/types/sap.ui.ux3.d.ts +1472 -807
- package/types/sap.ui.vbm.d.ts +1018 -760
- package/types/sap.ui.vk.d.ts +2858 -1896
- package/types/sap.ui.vtm.d.ts +650 -479
- package/types/sap.ui.webc.common.d.ts +5 -5
- package/types/sap.ui.webc.fiori.d.ts +817 -462
- package/types/sap.ui.webc.main.d.ts +2018 -1096
- package/types/sap.uiext.inbox.d.ts +168 -38
- package/types/sap.ushell.d.ts +738 -429
- package/types/sap.ushell_abap.d.ts +1 -1
- package/types/sap.uxap.d.ts +472 -348
- package/types/sap.viz.d.ts +2203 -835
- package/types/sap.webanalytics.core.d.ts +1 -1
- package/types/sap.zen.commons.d.ts +15 -10
- package/types/sap.zen.crosstab.d.ts +7 -4
- package/types/sap.zen.dsh.d.ts +143 -87
package/types/sap.fe.core.d.ts
CHANGED
|
@@ -63,7 +63,7 @@ declare module "sap/fe/core/BaseController" {
|
|
|
63
63
|
import View from "sap/ui/core/mvc/View";
|
|
64
64
|
|
|
65
65
|
/**
|
|
66
|
-
* @
|
|
66
|
+
* @since 1.90.0
|
|
67
67
|
*
|
|
68
68
|
* Internal base controller class for SAP Fiori elements application.
|
|
69
69
|
* If you want to extend a base controller for your custom page, please use for sap.fe.core.PageController.
|
|
@@ -72,7 +72,7 @@ declare module "sap/fe/core/BaseController" {
|
|
|
72
72
|
constructor();
|
|
73
73
|
|
|
74
74
|
/**
|
|
75
|
-
* @
|
|
75
|
+
* @since 1.91.0
|
|
76
76
|
*
|
|
77
77
|
* Returns the current app component.
|
|
78
78
|
*
|
|
@@ -90,7 +90,7 @@ declare module "sap/fe/core/BaseController" {
|
|
|
90
90
|
* The model name
|
|
91
91
|
*/
|
|
92
92
|
sName?: string
|
|
93
|
-
): Model;
|
|
93
|
+
): Model | undefined;
|
|
94
94
|
/**
|
|
95
95
|
* Convenience method for setting the view model in every controller of the application.
|
|
96
96
|
*
|
|
@@ -114,14 +114,20 @@ declare module "sap/fe/core/ExtensionAPI" {
|
|
|
114
114
|
|
|
115
115
|
import Control from "sap/ui/core/Control";
|
|
116
116
|
|
|
117
|
+
import EditFlow from "sap/fe/core/controllerextensions/EditFlow";
|
|
118
|
+
|
|
119
|
+
import IntentBasedNavigation from "sap/fe/core/controllerextensions/IntentBasedNavigation";
|
|
120
|
+
|
|
117
121
|
import Model from "sap/ui/model/Model";
|
|
118
122
|
|
|
123
|
+
import Routing from "sap/fe/core/controllerextensions/Routing";
|
|
124
|
+
|
|
119
125
|
import Context from "sap/ui/model/Context";
|
|
120
126
|
|
|
121
127
|
import UI5Element from "sap/ui/core/Element";
|
|
122
128
|
|
|
123
129
|
/**
|
|
124
|
-
* @
|
|
130
|
+
* @since 1.79.0
|
|
125
131
|
*
|
|
126
132
|
* Common Extension API for all pages of SAP Fiori elements for OData V4.
|
|
127
133
|
* To correctly integrate your app extension coding with SAP Fiori elements, use only the extensionAPI of
|
|
@@ -145,13 +151,13 @@ declare module "sap/fe/core/ExtensionAPI" {
|
|
|
145
151
|
*
|
|
146
152
|
* @returns The editFlow controller extension
|
|
147
153
|
*/
|
|
148
|
-
getEditFlow():
|
|
154
|
+
getEditFlow(): EditFlow;
|
|
149
155
|
/**
|
|
150
156
|
* Retrieves the intentBasedNavigation controller extension for this page.
|
|
151
157
|
*
|
|
152
158
|
* @returns The intentBasedNavigation controller extension
|
|
153
159
|
*/
|
|
154
|
-
getIntentBasedNavigation():
|
|
160
|
+
getIntentBasedNavigation(): IntentBasedNavigation;
|
|
155
161
|
/**
|
|
156
162
|
* Get access to models managed by SAP Fiori elements.
|
|
157
163
|
*
|
|
@@ -184,7 +190,7 @@ declare module "sap/fe/core/ExtensionAPI" {
|
|
|
184
190
|
*
|
|
185
191
|
* @returns The routing controller extension
|
|
186
192
|
*/
|
|
187
|
-
getRouting():
|
|
193
|
+
getRouting(): Routing;
|
|
188
194
|
/**
|
|
189
195
|
* Load a fragment and go through the template preprocessor with the current page context.
|
|
190
196
|
*
|
|
@@ -198,11 +204,11 @@ declare module "sap/fe/core/ExtensionAPI" {
|
|
|
198
204
|
/**
|
|
199
205
|
* The contextPath to be used for the templating process
|
|
200
206
|
*/
|
|
201
|
-
contextPath
|
|
207
|
+
contextPath?: string;
|
|
202
208
|
/**
|
|
203
209
|
* The controller to be attached to the fragment
|
|
204
210
|
*/
|
|
205
|
-
controller
|
|
211
|
+
controller?: object;
|
|
206
212
|
/**
|
|
207
213
|
* The ID of the fragment itself
|
|
208
214
|
*/
|
|
@@ -210,7 +216,7 @@ declare module "sap/fe/core/ExtensionAPI" {
|
|
|
210
216
|
/**
|
|
211
217
|
* The initial binding context
|
|
212
218
|
*/
|
|
213
|
-
initialBindingContext
|
|
219
|
+
initialBindingContext?: Context;
|
|
214
220
|
/**
|
|
215
221
|
* The name of the fragment to be loaded
|
|
216
222
|
*/
|
|
@@ -252,16 +258,10 @@ declare module "sap/fe/core/ExtensionAPI" {
|
|
|
252
258
|
declare module "sap/fe/core/PageController" {
|
|
253
259
|
import BaseController from "sap/fe/core/BaseController";
|
|
254
260
|
|
|
255
|
-
import AppComponent from "sap/fe/core/AppComponent";
|
|
256
|
-
|
|
257
261
|
import ExtensionAPI from "sap/fe/core/ExtensionAPI";
|
|
258
262
|
|
|
259
|
-
import Model from "sap/ui/model/Model";
|
|
260
|
-
|
|
261
|
-
import View from "sap/ui/core/mvc/View";
|
|
262
|
-
|
|
263
263
|
/**
|
|
264
|
-
* @
|
|
264
|
+
* @since 1.88.0
|
|
265
265
|
*
|
|
266
266
|
* Base controller class for your custom page used inside an SAP Fiori elements application.
|
|
267
267
|
* This controller provides preconfigured extensions that will ensure you have the basic functionalities
|
|
@@ -270,47 +270,12 @@ declare module "sap/fe/core/PageController" {
|
|
|
270
270
|
export default class PageController extends BaseController {
|
|
271
271
|
constructor();
|
|
272
272
|
|
|
273
|
-
/**
|
|
274
|
-
* @SINCE 1.91.0
|
|
275
|
-
*
|
|
276
|
-
* Returns the current app component.
|
|
277
|
-
*
|
|
278
|
-
* @returns The app component or, if not found, null
|
|
279
|
-
*/
|
|
280
|
-
getAppComponent(): AppComponent;
|
|
281
273
|
/**
|
|
282
274
|
* Get the extension API for the current page.
|
|
283
275
|
*
|
|
284
276
|
* @returns The extension API.
|
|
285
277
|
*/
|
|
286
278
|
getExtensionAPI(): ExtensionAPI;
|
|
287
|
-
/**
|
|
288
|
-
* Convenience method provided by SAP Fiori elements to enable applications to include the view model by
|
|
289
|
-
* name into each controller.
|
|
290
|
-
*
|
|
291
|
-
* @returns The model instance
|
|
292
|
-
*/
|
|
293
|
-
getModel(
|
|
294
|
-
/**
|
|
295
|
-
* The model name
|
|
296
|
-
*/
|
|
297
|
-
sName?: string
|
|
298
|
-
): Model;
|
|
299
|
-
/**
|
|
300
|
-
* Convenience method for setting the view model in every controller of the application.
|
|
301
|
-
*
|
|
302
|
-
* @returns The view instance
|
|
303
|
-
*/
|
|
304
|
-
setModel(
|
|
305
|
-
/**
|
|
306
|
-
* The model instance
|
|
307
|
-
*/
|
|
308
|
-
oModel: Model,
|
|
309
|
-
/**
|
|
310
|
-
* The model name
|
|
311
|
-
*/
|
|
312
|
-
sName: string
|
|
313
|
-
): View;
|
|
314
279
|
}
|
|
315
280
|
}
|
|
316
281
|
|
|
@@ -324,7 +289,7 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
|
|
|
324
289
|
import ODataModel from "sap/ui/model/odata/v4/ODataModel";
|
|
325
290
|
|
|
326
291
|
/**
|
|
327
|
-
* @
|
|
292
|
+
* @since 1.90.0
|
|
328
293
|
*
|
|
329
294
|
* A controller extension offering hooks into the edit flow of the application
|
|
330
295
|
*/
|
|
@@ -332,7 +297,7 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
|
|
|
332
297
|
constructor();
|
|
333
298
|
|
|
334
299
|
/**
|
|
335
|
-
* @
|
|
300
|
+
* @since 1.90.0
|
|
336
301
|
*
|
|
337
302
|
* Submit the current set of changes and navigate back.
|
|
338
303
|
*
|
|
@@ -345,7 +310,7 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
|
|
|
345
310
|
oContext: Context
|
|
346
311
|
): Promise<void>;
|
|
347
312
|
/**
|
|
348
|
-
* @
|
|
313
|
+
* @since 1.90.0
|
|
349
314
|
*
|
|
350
315
|
* Discard the editable document.
|
|
351
316
|
*
|
|
@@ -371,7 +336,7 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
|
|
|
371
336
|
}
|
|
372
337
|
): Promise<any>;
|
|
373
338
|
/**
|
|
374
|
-
* @
|
|
339
|
+
* @since 1.90.0
|
|
375
340
|
*
|
|
376
341
|
* Creates a new document.
|
|
377
342
|
*
|
|
@@ -411,7 +376,7 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
|
|
|
411
376
|
}
|
|
412
377
|
): Promise<void>;
|
|
413
378
|
/**
|
|
414
|
-
* @
|
|
379
|
+
* @since 1.90.0
|
|
415
380
|
*
|
|
416
381
|
* Deletes the document.
|
|
417
382
|
*
|
|
@@ -437,7 +402,7 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
|
|
|
437
402
|
}
|
|
438
403
|
): Promise<void>;
|
|
439
404
|
/**
|
|
440
|
-
* @
|
|
405
|
+
* @since 1.90.0
|
|
441
406
|
*
|
|
442
407
|
* Creates a draft document for an existing active document.
|
|
443
408
|
*
|
|
@@ -450,7 +415,7 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
|
|
|
450
415
|
oContext: Context
|
|
451
416
|
): Promise<void>;
|
|
452
417
|
/**
|
|
453
|
-
* @
|
|
418
|
+
* @since 1.90.0
|
|
454
419
|
*
|
|
455
420
|
* Invokes an action (bound or unbound) and tracks the changes so that other pages can be refreshed and
|
|
456
421
|
* show the updated data upon navigation.
|
|
@@ -511,7 +476,7 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
|
|
|
511
476
|
}
|
|
512
477
|
): Promise<void>;
|
|
513
478
|
/**
|
|
514
|
-
* @
|
|
479
|
+
* @since 1.98.0
|
|
515
480
|
*
|
|
516
481
|
* This function can be used to intercept the 'Create' action. You can execute custom coding in this function.
|
|
517
482
|
* The framework waits for the returned promise to be resolved before continuing the 'Create' action.
|
|
@@ -539,7 +504,7 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
|
|
|
539
504
|
}
|
|
540
505
|
): Promise<void>;
|
|
541
506
|
/**
|
|
542
|
-
* @
|
|
507
|
+
* @since 1.98.0
|
|
543
508
|
*
|
|
544
509
|
* This function can be used to intercept the 'Delete' action. You can execute custom coding in this function.
|
|
545
510
|
* The framework waits for the returned promise to be resolved before continuing the 'Delete' action.
|
|
@@ -563,7 +528,7 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
|
|
|
563
528
|
}
|
|
564
529
|
): Promise<void>;
|
|
565
530
|
/**
|
|
566
|
-
* @
|
|
531
|
+
* @since 1.98.0
|
|
567
532
|
*
|
|
568
533
|
* This function can be used to intercept the 'Discard' action. You can execute custom coding in this function.
|
|
569
534
|
* The framework waits for the returned promise to be resolved before continuing the 'Discard' action.
|
|
@@ -587,7 +552,7 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
|
|
|
587
552
|
}
|
|
588
553
|
): Promise<void>;
|
|
589
554
|
/**
|
|
590
|
-
* @
|
|
555
|
+
* @since 1.98.0
|
|
591
556
|
*
|
|
592
557
|
* This function can be used to intercept the 'Edit' action. You can execute custom coding in this function.
|
|
593
558
|
* The framework waits for the returned promise to be resolved before continuing the 'Edit' action.
|
|
@@ -611,7 +576,7 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
|
|
|
611
576
|
}
|
|
612
577
|
): Promise<void>;
|
|
613
578
|
/**
|
|
614
|
-
* @
|
|
579
|
+
* @since 1.90.0
|
|
615
580
|
*
|
|
616
581
|
* This function can be used to intercept the 'Save' action. You can execute custom coding in this function.
|
|
617
582
|
* The framework waits for the returned promise to be resolved before continuing the 'Save' action.
|
|
@@ -635,7 +600,7 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
|
|
|
635
600
|
}
|
|
636
601
|
): Promise<void>;
|
|
637
602
|
/**
|
|
638
|
-
* @
|
|
603
|
+
* @since 1.90.0
|
|
639
604
|
*
|
|
640
605
|
* Saves a new document after checking it.
|
|
641
606
|
*
|
|
@@ -648,7 +613,7 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
|
|
|
648
613
|
oContext: Context
|
|
649
614
|
): Promise<void>;
|
|
650
615
|
/**
|
|
651
|
-
* @
|
|
616
|
+
* @since 1.90.0
|
|
652
617
|
*
|
|
653
618
|
* Secured execution of the given function. Ensures that the function is only executed when certain conditions
|
|
654
619
|
* are fulfilled.
|
|
@@ -688,7 +653,7 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
|
|
|
688
653
|
}
|
|
689
654
|
): Promise<void>;
|
|
690
655
|
/**
|
|
691
|
-
* @
|
|
656
|
+
* @since 1.90.0
|
|
692
657
|
*
|
|
693
658
|
* Updates the draft status and displays the error messages if there are errors during an update.
|
|
694
659
|
*
|
|
@@ -711,8 +676,10 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
|
|
|
711
676
|
declare module "sap/fe/core/controllerextensions/IntentBasedNavigation" {
|
|
712
677
|
import ControllerExtension from "sap/ui/core/mvc/ControllerExtension";
|
|
713
678
|
|
|
679
|
+
import SelectionVariant from "sap/fe/navigation/SelectionVariant";
|
|
680
|
+
|
|
714
681
|
/**
|
|
715
|
-
* @
|
|
682
|
+
* @since 1.86.0
|
|
716
683
|
*
|
|
717
684
|
* Controller extension providing hooks for intent-based navigation
|
|
718
685
|
*/
|
|
@@ -720,7 +687,7 @@ declare module "sap/fe/core/controllerextensions/IntentBasedNavigation" {
|
|
|
720
687
|
constructor();
|
|
721
688
|
|
|
722
689
|
/**
|
|
723
|
-
* @
|
|
690
|
+
* @since 1.86.0
|
|
724
691
|
*
|
|
725
692
|
* Provides a hook to customize the {@link sap.fe.navigation.SelectionVariant} related to the intent-based
|
|
726
693
|
* navigation.
|
|
@@ -729,7 +696,7 @@ declare module "sap/fe/core/controllerextensions/IntentBasedNavigation" {
|
|
|
729
696
|
/**
|
|
730
697
|
* SelectionVariant provided by SAP Fiori elements.
|
|
731
698
|
*/
|
|
732
|
-
_oSelectionVariant:
|
|
699
|
+
_oSelectionVariant: SelectionVariant,
|
|
733
700
|
/**
|
|
734
701
|
* Object containing intent-based navigation-related info
|
|
735
702
|
*/
|
|
@@ -745,7 +712,7 @@ declare module "sap/fe/core/controllerextensions/IntentBasedNavigation" {
|
|
|
745
712
|
}
|
|
746
713
|
): void;
|
|
747
714
|
/**
|
|
748
|
-
* @
|
|
715
|
+
* @since 1.86.0
|
|
749
716
|
*
|
|
750
717
|
* Navigates to an intent defined by an outbound definition in the manifest.
|
|
751
718
|
*/
|
|
@@ -754,7 +721,7 @@ declare module "sap/fe/core/controllerextensions/IntentBasedNavigation" {
|
|
|
754
721
|
* Identifier to locate the outbound definition in the manifest.
|
|
755
722
|
* This provides the semantic object and action for the intent-based navigation.
|
|
756
723
|
* Additionally, the outbound definition can be used to provide parameters for intent-based navigation.
|
|
757
|
-
* See {@link topic
|
|
724
|
+
* See {@link https://ui5.sap.com/#/topic/be0cf40f61184b358b5faedaec98b2da Descriptor for Applications, Components, and Libraries }
|
|
758
725
|
* for more information.
|
|
759
726
|
*/
|
|
760
727
|
sOutbound: string,
|
|
@@ -772,8 +739,8 @@ declare module "sap/fe/core/controllerextensions/MessageHandler" {
|
|
|
772
739
|
import ControllerExtension from "sap/ui/core/mvc/ControllerExtension";
|
|
773
740
|
|
|
774
741
|
/**
|
|
775
|
-
* @
|
|
776
|
-
* @
|
|
742
|
+
* @since 1.90.0
|
|
743
|
+
* @experimental (since 1.90.0)
|
|
777
744
|
*
|
|
778
745
|
* A controller extension offering message handling.
|
|
779
746
|
*/
|
|
@@ -781,8 +748,8 @@ declare module "sap/fe/core/controllerextensions/MessageHandler" {
|
|
|
781
748
|
constructor();
|
|
782
749
|
|
|
783
750
|
/**
|
|
784
|
-
* @
|
|
785
|
-
* @
|
|
751
|
+
* @since 1.90.0
|
|
752
|
+
* @experimental (since 1.90.0)
|
|
786
753
|
*
|
|
787
754
|
* Shows a message dialog with transition messages if there are any.
|
|
788
755
|
* The message dialog is shown as a modal dialog. Once the user confirms the dialog, all transition messages
|
|
@@ -805,7 +772,7 @@ declare module "sap/fe/core/controllerextensions/Paginator" {
|
|
|
805
772
|
import Context from "sap/ui/model/odata/v4/Context";
|
|
806
773
|
|
|
807
774
|
/**
|
|
808
|
-
* @
|
|
775
|
+
* @since 1.94.0
|
|
809
776
|
*
|
|
810
777
|
* Controller extension providing hooks for the navigation using paginators
|
|
811
778
|
*/
|
|
@@ -813,7 +780,7 @@ declare module "sap/fe/core/controllerextensions/Paginator" {
|
|
|
813
780
|
constructor();
|
|
814
781
|
|
|
815
782
|
/**
|
|
816
|
-
* @
|
|
783
|
+
* @since 1.94.0
|
|
817
784
|
*
|
|
818
785
|
* Initiates the paginator control.
|
|
819
786
|
*/
|
|
@@ -828,7 +795,7 @@ declare module "sap/fe/core/controllerextensions/Paginator" {
|
|
|
828
795
|
oContext?: Context
|
|
829
796
|
): void;
|
|
830
797
|
/**
|
|
831
|
-
* @
|
|
798
|
+
* @since 1.94.0
|
|
832
799
|
*
|
|
833
800
|
* Returns the updated context after the paginator operation.
|
|
834
801
|
*/
|
|
@@ -847,7 +814,7 @@ declare module "sap/fe/core/controllerextensions/Routing" {
|
|
|
847
814
|
import Context from "sap/ui/model/odata/v4/Context";
|
|
848
815
|
|
|
849
816
|
/**
|
|
850
|
-
* @
|
|
817
|
+
* @since 1.86.0
|
|
851
818
|
*
|
|
852
819
|
* A controller extension offering hooks into the routing flow of the application
|
|
853
820
|
*/
|
|
@@ -855,7 +822,7 @@ declare module "sap/fe/core/controllerextensions/Routing" {
|
|
|
855
822
|
constructor();
|
|
856
823
|
|
|
857
824
|
/**
|
|
858
|
-
* @
|
|
825
|
+
* @since 1.90.0
|
|
859
826
|
*
|
|
860
827
|
* Allows navigation to a specific context.
|
|
861
828
|
*/
|
|
@@ -881,7 +848,7 @@ declare module "sap/fe/core/controllerextensions/Routing" {
|
|
|
881
848
|
oParameters?: any
|
|
882
849
|
): Promise<boolean>;
|
|
883
850
|
/**
|
|
884
|
-
* @
|
|
851
|
+
* @since 1.90.0
|
|
885
852
|
*
|
|
886
853
|
* This function is used to intercept the routing event after binding a page.
|
|
887
854
|
* If it is declared as an extension, it allows you to intercept and change the normal flow of binding.
|
|
@@ -896,7 +863,7 @@ declare module "sap/fe/core/controllerextensions/Routing" {
|
|
|
896
863
|
oContext: object
|
|
897
864
|
): void;
|
|
898
865
|
/**
|
|
899
|
-
* @
|
|
866
|
+
* @since 1.90.0
|
|
900
867
|
*
|
|
901
868
|
* This function is used to intercept the routing event before binding a page.
|
|
902
869
|
* If it is declared as an extension, it allows you to intercept and change the normal flow of binding.
|
|
@@ -911,10 +878,14 @@ declare module "sap/fe/core/controllerextensions/Routing" {
|
|
|
911
878
|
oContext: object
|
|
912
879
|
): void;
|
|
913
880
|
/**
|
|
914
|
-
* @
|
|
881
|
+
* @since 1.86.0
|
|
915
882
|
*
|
|
916
883
|
* This function can be used to intercept the routing event happening during the normal process of navigating
|
|
917
|
-
* from one page to another
|
|
884
|
+
* from one page to another (like clicking on the table row to navigate, or when pagination buttons are
|
|
885
|
+
* clicked).
|
|
886
|
+
* The function is NOT called during other means of external outbound navigation (like a navigation configured
|
|
887
|
+
* via a link, or by using navigation buttons).
|
|
888
|
+
*
|
|
918
889
|
* If declared as an extension, it allows you to intercept and change the normal navigation flow.
|
|
919
890
|
* If you decide to do your own navigation processing, you can return `true` to prevent the default routing
|
|
920
891
|
* behavior.
|
|
@@ -943,7 +914,7 @@ declare module "sap/fe/core/controllerextensions/Share" {
|
|
|
943
914
|
import ControllerExtension from "sap/ui/core/mvc/ControllerExtension";
|
|
944
915
|
|
|
945
916
|
/**
|
|
946
|
-
* @
|
|
917
|
+
* @since 1.86.0
|
|
947
918
|
*
|
|
948
919
|
* A controller extension offering hooks into the routing flow of the application
|
|
949
920
|
*/
|
|
@@ -951,7 +922,7 @@ declare module "sap/fe/core/controllerextensions/Share" {
|
|
|
951
922
|
constructor();
|
|
952
923
|
|
|
953
924
|
/**
|
|
954
|
-
* @
|
|
925
|
+
* @since 1.93.0
|
|
955
926
|
*
|
|
956
927
|
* Adapts the metadata used while sharing the page URL via 'Send Email', 'Share in SAP Jam', and 'Save as
|
|
957
928
|
* Tile'.
|
|
@@ -1026,7 +997,7 @@ declare module "sap/fe/core/controllerextensions/Share" {
|
|
|
1026
997
|
}
|
|
1027
998
|
): Promise<object> | object;
|
|
1028
999
|
/**
|
|
1029
|
-
* @
|
|
1000
|
+
* @since 1.93.0
|
|
1030
1001
|
*
|
|
1031
1002
|
* Opens the share sheet.
|
|
1032
1003
|
*/
|
|
@@ -1045,7 +1016,7 @@ declare module "sap/fe/core/controllerextensions/ViewState" {
|
|
|
1045
1016
|
import ManagedObject from "sap/ui/base/ManagedObject";
|
|
1046
1017
|
|
|
1047
1018
|
/**
|
|
1048
|
-
* @
|
|
1019
|
+
* @since 1.85.0
|
|
1049
1020
|
*
|
|
1050
1021
|
* A controller extension offering hooks for state handling
|
|
1051
1022
|
* If you need to maintain a specific state for your application, you can use the controller extension.
|
|
@@ -1054,7 +1025,7 @@ declare module "sap/fe/core/controllerextensions/ViewState" {
|
|
|
1054
1025
|
constructor();
|
|
1055
1026
|
|
|
1056
1027
|
/**
|
|
1057
|
-
* @
|
|
1028
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1058
1029
|
*
|
|
1059
1030
|
* This function should add all controls relevant for refreshing to the provided control array.
|
|
1060
1031
|
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
@@ -1067,7 +1038,7 @@ declare module "sap/fe/core/controllerextensions/ViewState" {
|
|
|
1067
1038
|
aCollectedControls: ManagedObject[]
|
|
1068
1039
|
): void;
|
|
1069
1040
|
/**
|
|
1070
|
-
* @
|
|
1041
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1071
1042
|
*
|
|
1072
1043
|
* Customize the `refreshBinding` function for a certain control.
|
|
1073
1044
|
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
@@ -1084,7 +1055,7 @@ declare module "sap/fe/core/controllerextensions/ViewState" {
|
|
|
1084
1055
|
oControlHandler: any[]
|
|
1085
1056
|
): void;
|
|
1086
1057
|
/**
|
|
1087
|
-
* @
|
|
1058
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1088
1059
|
*
|
|
1089
1060
|
* Customize the `retrieve` and `apply` functions for a certain control.
|
|
1090
1061
|
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
@@ -1101,7 +1072,7 @@ declare module "sap/fe/core/controllerextensions/ViewState" {
|
|
|
1101
1072
|
aControlHandler: object[]
|
|
1102
1073
|
): void;
|
|
1103
1074
|
/**
|
|
1104
|
-
* @
|
|
1075
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1105
1076
|
*
|
|
1106
1077
|
* This function should add all controls for given view that should be considered for the state handling
|
|
1107
1078
|
* to the provided control array.
|
|
@@ -1115,7 +1086,7 @@ declare module "sap/fe/core/controllerextensions/ViewState" {
|
|
|
1115
1086
|
aCollectedControls: ManagedObject[]
|
|
1116
1087
|
): void;
|
|
1117
1088
|
/**
|
|
1118
|
-
* @
|
|
1089
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1119
1090
|
*
|
|
1120
1091
|
* Applying additional, not control related, states - is called only if navigation type is iAppState.
|
|
1121
1092
|
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
@@ -1132,7 +1103,7 @@ declare module "sap/fe/core/controllerextensions/ViewState" {
|
|
|
1132
1103
|
aPromises: Promise<any>
|
|
1133
1104
|
): void;
|
|
1134
1105
|
/**
|
|
1135
|
-
* @
|
|
1106
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1136
1107
|
*
|
|
1137
1108
|
* Defines whether the view state should only be applied once initially.
|
|
1138
1109
|
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
@@ -1147,7 +1118,7 @@ declare module "sap/fe/core/controllerextensions/ViewState" {
|
|
|
1147
1118
|
*/
|
|
1148
1119
|
applyInitialStateOnly(): boolean;
|
|
1149
1120
|
/**
|
|
1150
|
-
* @
|
|
1121
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1151
1122
|
*
|
|
1152
1123
|
* Apply navigation parameters is not called if the navigation type is iAppState
|
|
1153
1124
|
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
@@ -1193,10 +1164,10 @@ declare module "sap/fe/core/controllerextensions/ViewState" {
|
|
|
1193
1164
|
/**
|
|
1194
1165
|
* The current navigation parameter
|
|
1195
1166
|
*/
|
|
1196
|
-
oNavParameter:
|
|
1167
|
+
oNavParameter: NavigationParameter
|
|
1197
1168
|
): Promise<any>;
|
|
1198
1169
|
/**
|
|
1199
|
-
* @
|
|
1170
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1200
1171
|
*
|
|
1201
1172
|
* Hook to react when state for given view was applied.
|
|
1202
1173
|
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
@@ -1209,7 +1180,7 @@ declare module "sap/fe/core/controllerextensions/ViewState" {
|
|
|
1209
1180
|
aPromises: Promise<any>
|
|
1210
1181
|
): void;
|
|
1211
1182
|
/**
|
|
1212
|
-
* @
|
|
1183
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1213
1184
|
*
|
|
1214
1185
|
* Hook to react before a state for given view is applied.
|
|
1215
1186
|
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
@@ -1234,7 +1205,7 @@ declare module "sap/fe/core/controllerextensions/ViewState" {
|
|
|
1234
1205
|
*/
|
|
1235
1206
|
onSuspend(): void;
|
|
1236
1207
|
/**
|
|
1237
|
-
* @
|
|
1208
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1238
1209
|
*
|
|
1239
1210
|
* Extend the map of additional states (not control bound) to be added to the current view state of the
|
|
1240
1211
|
* given view.
|
|
@@ -1281,8 +1252,8 @@ declare module "sap/fe/core/controllerextensions/ViewState" {
|
|
|
1281
1252
|
|
|
1282
1253
|
declare module "sap/fe/core/fpm/Component" {
|
|
1283
1254
|
/**
|
|
1284
|
-
* @
|
|
1285
|
-
* @
|
|
1255
|
+
* @since 1.92.0
|
|
1256
|
+
* @experimental (since 1.92.0)
|
|
1286
1257
|
*
|
|
1287
1258
|
* Component that can be used as a wrapper component for custom pages.
|
|
1288
1259
|
* The component can be used in case you want to use SAP Fiori elements Building Blocks or XML template
|
|
@@ -1315,7 +1286,7 @@ declare module "sap/fe/core/fpm/Component" {
|
|
|
1315
1286
|
|
|
1316
1287
|
declare module "sap/fe/core/library" {
|
|
1317
1288
|
/**
|
|
1318
|
-
* @
|
|
1289
|
+
* @since 1.86.0
|
|
1319
1290
|
*
|
|
1320
1291
|
* Possible initial load (first app startup) modes for a ListReport.
|
|
1321
1292
|
*/
|
|
@@ -1336,14 +1307,8 @@ declare module "sap/fe/core/library" {
|
|
|
1336
1307
|
}
|
|
1337
1308
|
|
|
1338
1309
|
declare module "sap/fe/core/rootView/Fcl.controller" {
|
|
1339
|
-
import AppComponent from "sap/fe/core/AppComponent";
|
|
1340
|
-
|
|
1341
|
-
import Model from "sap/ui/model/Model";
|
|
1342
|
-
|
|
1343
|
-
import View from "sap/ui/core/mvc/View";
|
|
1344
|
-
|
|
1345
1310
|
/**
|
|
1346
|
-
* @
|
|
1311
|
+
* @since 1.110.0
|
|
1347
1312
|
*
|
|
1348
1313
|
* Base controller class for your own root view with an sap.f.FlexibleColumnLayout control.
|
|
1349
1314
|
* By using or extending this controller, you can use your own root view with the sap.fe.core.AppComponent
|
|
@@ -1351,7 +1316,7 @@ declare module "sap/fe/core/rootView/Fcl.controller" {
|
|
|
1351
1316
|
* you can make use of SAP Fiori elements pages and SAP Fiori elements building blocks.
|
|
1352
1317
|
*/
|
|
1353
1318
|
export default class Fcl
|
|
1354
|
-
/* was: sap.fe.core.RootViewBaseController */ extends Object {
|
|
1319
|
+
/* was: sap.fe.core.rootView.RootViewBaseController */ extends Object {
|
|
1355
1320
|
constructor();
|
|
1356
1321
|
|
|
1357
1322
|
/**
|
|
@@ -1360,61 +1325,12 @@ declare module "sap/fe/core/rootView/Fcl.controller" {
|
|
|
1360
1325
|
* @returns A promise that creates a Page to display the error
|
|
1361
1326
|
*/
|
|
1362
1327
|
displayErrorPage(): Promise<boolean>;
|
|
1363
|
-
/**
|
|
1364
|
-
* @SINCE 1.91.0
|
|
1365
|
-
*
|
|
1366
|
-
* Returns the current app component.
|
|
1367
|
-
*
|
|
1368
|
-
* @returns The app component or, if not found, null
|
|
1369
|
-
*/
|
|
1370
|
-
getAppComponent(): AppComponent;
|
|
1371
|
-
/**
|
|
1372
|
-
* Convenience method provided by SAP Fiori elements to enable applications to include the view model by
|
|
1373
|
-
* name into each controller.
|
|
1374
|
-
*
|
|
1375
|
-
* @returns The model instance
|
|
1376
|
-
*/
|
|
1377
|
-
getModel(
|
|
1378
|
-
/**
|
|
1379
|
-
* The model name
|
|
1380
|
-
*/
|
|
1381
|
-
sName?: string
|
|
1382
|
-
): Model;
|
|
1383
|
-
/**
|
|
1384
|
-
* Convenience method for getting the resource bundle.
|
|
1385
|
-
*
|
|
1386
|
-
* @returns The resourceModel of the component
|
|
1387
|
-
*/
|
|
1388
|
-
getResourceBundle():
|
|
1389
|
-
| Promise</* was: sap.base.i18n.ResourceBundle */ any>
|
|
1390
|
-
| /* was: sap.base.i18n.ResourceBundle */ any;
|
|
1391
|
-
/**
|
|
1392
|
-
* Convenience method for setting the view model in every controller of the application.
|
|
1393
|
-
*
|
|
1394
|
-
* @returns The view instance
|
|
1395
|
-
*/
|
|
1396
|
-
setModel(
|
|
1397
|
-
/**
|
|
1398
|
-
* The model instance
|
|
1399
|
-
*/
|
|
1400
|
-
oModel: Model,
|
|
1401
|
-
/**
|
|
1402
|
-
* The model name
|
|
1403
|
-
*/
|
|
1404
|
-
sName: string
|
|
1405
|
-
): View;
|
|
1406
1328
|
}
|
|
1407
1329
|
}
|
|
1408
1330
|
|
|
1409
1331
|
declare module "sap/fe/core/rootView/NavContainer.controller" {
|
|
1410
|
-
import AppComponent from "sap/fe/core/AppComponent";
|
|
1411
|
-
|
|
1412
|
-
import Model from "sap/ui/model/Model";
|
|
1413
|
-
|
|
1414
|
-
import View from "sap/ui/core/mvc/View";
|
|
1415
|
-
|
|
1416
1332
|
/**
|
|
1417
|
-
* @
|
|
1333
|
+
* @since 1.108.0
|
|
1418
1334
|
*
|
|
1419
1335
|
* Base controller class for your own root view with a sap.m.NavContainer control.
|
|
1420
1336
|
* By using or extending this controller you can use your own root view with the sap.fe.core.AppComponent
|
|
@@ -1422,7 +1338,7 @@ declare module "sap/fe/core/rootView/NavContainer.controller" {
|
|
|
1422
1338
|
* you can make use of SAP Fiori elements pages and SAP Fiori elements building blocks.
|
|
1423
1339
|
*/
|
|
1424
1340
|
export default class NavContainer
|
|
1425
|
-
/* was: sap.fe.core.RootViewBaseController */ extends Object {
|
|
1341
|
+
/* was: sap.fe.core.rootView.RootViewBaseController */ extends Object {
|
|
1426
1342
|
constructor();
|
|
1427
1343
|
|
|
1428
1344
|
/**
|
|
@@ -1431,49 +1347,6 @@ declare module "sap/fe/core/rootView/NavContainer.controller" {
|
|
|
1431
1347
|
* @returns A promise that creates a Page to display the error
|
|
1432
1348
|
*/
|
|
1433
1349
|
displayErrorPage(): Promise<boolean>;
|
|
1434
|
-
/**
|
|
1435
|
-
* @SINCE 1.91.0
|
|
1436
|
-
*
|
|
1437
|
-
* Returns the current app component.
|
|
1438
|
-
*
|
|
1439
|
-
* @returns The app component or, if not found, null
|
|
1440
|
-
*/
|
|
1441
|
-
getAppComponent(): AppComponent;
|
|
1442
|
-
/**
|
|
1443
|
-
* Convenience method provided by SAP Fiori elements to enable applications to include the view model by
|
|
1444
|
-
* name into each controller.
|
|
1445
|
-
*
|
|
1446
|
-
* @returns The model instance
|
|
1447
|
-
*/
|
|
1448
|
-
getModel(
|
|
1449
|
-
/**
|
|
1450
|
-
* The model name
|
|
1451
|
-
*/
|
|
1452
|
-
sName?: string
|
|
1453
|
-
): Model;
|
|
1454
|
-
/**
|
|
1455
|
-
* Convenience method for getting the resource bundle.
|
|
1456
|
-
*
|
|
1457
|
-
* @returns The resourceModel of the component
|
|
1458
|
-
*/
|
|
1459
|
-
getResourceBundle():
|
|
1460
|
-
| Promise</* was: sap.base.i18n.ResourceBundle */ any>
|
|
1461
|
-
| /* was: sap.base.i18n.ResourceBundle */ any;
|
|
1462
|
-
/**
|
|
1463
|
-
* Convenience method for setting the view model in every controller of the application.
|
|
1464
|
-
*
|
|
1465
|
-
* @returns The view instance
|
|
1466
|
-
*/
|
|
1467
|
-
setModel(
|
|
1468
|
-
/**
|
|
1469
|
-
* The model instance
|
|
1470
|
-
*/
|
|
1471
|
-
oModel: Model,
|
|
1472
|
-
/**
|
|
1473
|
-
* The model name
|
|
1474
|
-
*/
|
|
1475
|
-
sName: string
|
|
1476
|
-
): View;
|
|
1477
1350
|
}
|
|
1478
1351
|
}
|
|
1479
1352
|
|