@sapui5/ts-types 1.99.0 → 1.100.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/types/sap.apf.d.ts +1 -1
- package/types/sap.ca.ui.d.ts +1 -1
- package/types/sap.chart.d.ts +1 -1
- package/types/sap.collaboration.d.ts +1 -1
- package/types/sap.esh.search.ui.d.ts +1 -1
- package/types/sap.f.d.ts +1 -1
- package/types/sap.fe.common.d.ts +2 -6
- package/types/sap.fe.core.d.ts +282 -333
- package/types/sap.fe.macros.d.ts +566 -47
- package/types/sap.fe.navigation.d.ts +1 -1
- package/types/sap.fe.templates.d.ts +1 -1
- package/types/sap.fe.test.d.ts +1 -1
- package/types/sap.feedback.ui.d.ts +1 -1
- package/types/sap.gantt.d.ts +709 -12
- package/types/sap.landvisz.d.ts +1 -1
- package/types/sap.m.d.ts +462 -86
- package/types/sap.makit.d.ts +1 -1
- package/types/sap.me.d.ts +1 -1
- package/types/sap.ndc.d.ts +1 -1
- package/types/sap.ovp.d.ts +1 -1
- package/types/sap.rules.ui.d.ts +1 -1
- package/types/sap.sac.grid.d.ts +1 -1
- package/types/sap.suite.ui.commons.d.ts +1 -1
- package/types/sap.suite.ui.generic.template.d.ts +1 -1
- package/types/sap.suite.ui.microchart.d.ts +5 -5
- package/types/sap.tnt.d.ts +1 -1
- package/types/sap.ui.codeeditor.d.ts +1 -1
- package/types/sap.ui.commons.d.ts +1 -1
- package/types/sap.ui.comp.d.ts +47 -33
- package/types/sap.ui.core.d.ts +771 -470
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.export.d.ts +3 -3
- package/types/sap.ui.fl.d.ts +5 -1
- package/types/sap.ui.generic.app.d.ts +4 -3
- package/types/sap.ui.generic.template.d.ts +1 -1
- package/types/sap.ui.integration.d.ts +21 -3
- package/types/sap.ui.layout.d.ts +1 -1
- package/types/sap.ui.mdc.d.ts +9 -1
- package/types/sap.ui.richtexteditor.d.ts +1 -1
- package/types/sap.ui.rta.d.ts +1 -1
- package/types/sap.ui.suite.d.ts +1 -1
- package/types/sap.ui.support.d.ts +6 -12
- package/types/sap.ui.table.d.ts +2 -9
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +1 -1
- package/types/sap.ui.ux3.d.ts +1 -1
- package/types/sap.ui.vbm.d.ts +1 -1
- package/types/sap.ui.vk.d.ts +61 -1
- package/types/sap.ui.vtm.d.ts +1 -1
- package/types/sap.uiext.inbox.d.ts +2 -2
- package/types/sap.ushell.d.ts +4419 -4850
- package/types/sap.ushell_abap.d.ts +1 -1
- package/types/sap.uxap.d.ts +1 -1
- package/types/sap.viz.d.ts +105 -231
- package/types/sap.webanalytics.core.d.ts +1 -1
- package/types/sap.zen.commons.d.ts +1 -1
- package/types/sap.zen.crosstab.d.ts +1 -1
- package/types/sap.zen.dsh.d.ts +2 -2
package/types/sap.fe.core.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.
|
|
1
|
+
// For Library Version: 1.100.0
|
|
2
2
|
|
|
3
3
|
declare namespace sap {
|
|
4
4
|
/**
|
|
@@ -17,42 +17,16 @@ declare namespace sap {
|
|
|
17
17
|
/**
|
|
18
18
|
* @SINCE 1.90.0
|
|
19
19
|
*
|
|
20
|
+
*
|
|
20
21
|
* A controller extension offering hooks into the edit flow of the application
|
|
21
22
|
*/
|
|
22
23
|
class EditFlow extends sap.ui.core.mvc.ControllerExtension {
|
|
23
24
|
constructor();
|
|
24
25
|
|
|
25
|
-
/**
|
|
26
|
-
* Creates a new subclass of class sap.fe.core.controllerextensions.EditFlow with name `sClassName` and
|
|
27
|
-
* enriches it with the information contained in `oClassInfo`.
|
|
28
|
-
*
|
|
29
|
-
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.mvc.ControllerExtension.extend}.
|
|
30
|
-
*/
|
|
31
|
-
static extend<T extends Record<string, unknown>>(
|
|
32
|
-
/**
|
|
33
|
-
* Name of the class being created
|
|
34
|
-
*/
|
|
35
|
-
sClassName: string,
|
|
36
|
-
/**
|
|
37
|
-
* Object literal with information about the class
|
|
38
|
-
*/
|
|
39
|
-
oClassInfo?: sap.ClassInfo<
|
|
40
|
-
T,
|
|
41
|
-
sap.fe.core.controllerextensions.EditFlow
|
|
42
|
-
>,
|
|
43
|
-
/**
|
|
44
|
-
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
45
|
-
* used by this class
|
|
46
|
-
*/
|
|
47
|
-
FNMetaImpl?: Function
|
|
48
|
-
): Function;
|
|
49
|
-
/**
|
|
50
|
-
* Returns a metadata object for class sap.fe.core.controllerextensions.EditFlow.
|
|
51
|
-
*/
|
|
52
|
-
static getMetadata(): sap.ui.base.Metadata;
|
|
53
26
|
/**
|
|
54
27
|
* @SINCE 1.90.0
|
|
55
28
|
*
|
|
29
|
+
*
|
|
56
30
|
* Submit the current set of changes and navigate back.
|
|
57
31
|
*/
|
|
58
32
|
applyDocument(
|
|
@@ -64,6 +38,7 @@ declare namespace sap {
|
|
|
64
38
|
/**
|
|
65
39
|
* @SINCE 1.90.0
|
|
66
40
|
*
|
|
41
|
+
*
|
|
67
42
|
* Discard the editable document.
|
|
68
43
|
*/
|
|
69
44
|
cancelDocument(
|
|
@@ -88,77 +63,74 @@ declare namespace sap {
|
|
|
88
63
|
/**
|
|
89
64
|
* @SINCE 1.90.0
|
|
90
65
|
*
|
|
66
|
+
*
|
|
91
67
|
* Creates a new document.
|
|
92
68
|
*/
|
|
93
69
|
createDocument(
|
|
94
70
|
/**
|
|
95
71
|
* ODataListBinding object or the binding path for a temporary list binding
|
|
96
72
|
*/
|
|
97
|
-
vListBinding: sap.ui.model.odata.v4.ODataListBinding
|
|
73
|
+
vListBinding: string | sap.ui.model.odata.v4.ODataListBinding,
|
|
98
74
|
/**
|
|
99
75
|
* Contains the following attributes:
|
|
100
76
|
*/
|
|
101
|
-
|
|
77
|
+
mInParameters: {
|
|
78
|
+
/**
|
|
79
|
+
* Specifies if the new entry should be created at the top or bottom of a table in case of creationMode
|
|
80
|
+
* 'Inline'
|
|
81
|
+
*/
|
|
82
|
+
createAtEnd?: boolean;
|
|
102
83
|
/**
|
|
103
|
-
* The creation mode using one of the following:
|
|
104
|
-
*
|
|
105
|
-
*
|
|
84
|
+
* The creation mode using one of the following:
|
|
85
|
+
* NewPage - the created document is shown in a new page, depending on whether metadata
|
|
86
|
+
* 'Sync', 'Async' or 'Deferred' is used
|
|
87
|
+
* Inline - The creation is done inline (in a table)
|
|
88
|
+
* External - The creation is done in a different application specified via the parameter
|
|
89
|
+
* 'outbound'
|
|
106
90
|
*/
|
|
107
91
|
creationMode: string;
|
|
108
92
|
/**
|
|
109
93
|
* The navigation target where the document is created in case of creationMode 'External'
|
|
110
94
|
*/
|
|
111
95
|
outbound?: string;
|
|
112
|
-
/**
|
|
113
|
-
* Specifies if the new entry should be created at the top or bottom of a table in case of creationMode
|
|
114
|
-
* 'Inline'
|
|
115
|
-
*/
|
|
116
|
-
createAtEnd?: boolean;
|
|
117
96
|
}
|
|
118
97
|
): Promise<any>;
|
|
119
98
|
/**
|
|
120
99
|
* @SINCE 1.90.0
|
|
121
100
|
*
|
|
101
|
+
*
|
|
122
102
|
* Deletes the document.
|
|
123
103
|
*/
|
|
124
104
|
deleteDocument(
|
|
125
105
|
/**
|
|
126
106
|
* Context of the document
|
|
127
107
|
*/
|
|
128
|
-
oContext:
|
|
108
|
+
oContext: sap.ui.model.odata.v4.Context,
|
|
129
109
|
/**
|
|
130
110
|
* Can contain the following attributes:
|
|
131
111
|
*/
|
|
132
|
-
|
|
133
|
-
/**
|
|
134
|
-
* Title of the object being deleted
|
|
135
|
-
*/
|
|
136
|
-
title: string;
|
|
112
|
+
mInParameters: {
|
|
137
113
|
/**
|
|
138
114
|
* Description of the object being deleted
|
|
139
115
|
*/
|
|
140
116
|
description: string;
|
|
117
|
+
/**
|
|
118
|
+
* Title of the object being deleted
|
|
119
|
+
*/
|
|
120
|
+
title: string;
|
|
141
121
|
}
|
|
142
122
|
): Promise<any>;
|
|
143
123
|
/**
|
|
144
124
|
* @SINCE 1.90.0
|
|
145
125
|
*
|
|
126
|
+
*
|
|
146
127
|
* Creates a draft document for an existing active document.
|
|
147
128
|
*/
|
|
148
129
|
editDocument(
|
|
149
130
|
/**
|
|
150
131
|
* Context of the active document
|
|
151
132
|
*/
|
|
152
|
-
oContext:
|
|
153
|
-
/**
|
|
154
|
-
* Contains the following attributes:
|
|
155
|
-
*/
|
|
156
|
-
mParameters?: {
|
|
157
|
-
/**
|
|
158
|
-
* For a service with a prepare action, this parameter decides if the action is to be executed
|
|
159
|
-
*/
|
|
160
|
-
prepareOnEdit?: boolean;
|
|
161
|
-
}
|
|
133
|
+
oContext: sap.ui.model.odata.v4.Context
|
|
162
134
|
): Promise<any>;
|
|
163
135
|
/**
|
|
164
136
|
* @SINCE 1.90.0
|
|
@@ -174,21 +146,19 @@ declare namespace sap {
|
|
|
174
146
|
/**
|
|
175
147
|
* Contains the following attributes:
|
|
176
148
|
*/
|
|
177
|
-
|
|
149
|
+
mInParameters?: {
|
|
178
150
|
/**
|
|
179
151
|
* For a bound action, a context or an array with contexts for which the action is to be called must be
|
|
180
152
|
* provided
|
|
181
153
|
*/
|
|
182
|
-
contexts?:
|
|
154
|
+
contexts?:
|
|
155
|
+
| sap.ui.model.odata.v4.Context
|
|
156
|
+
| sap.ui.model.odata.v4.Context[];
|
|
183
157
|
/**
|
|
184
|
-
*
|
|
185
|
-
|
|
186
|
-
model?: sap.ui.model.odata.v4.ODataModel;
|
|
187
|
-
/**
|
|
188
|
-
* Boolean value indicating whether navigation is required after the action has been executed. Navigation
|
|
189
|
-
* takes place to the context returned by the action
|
|
158
|
+
* Mode how actions are to be called: 'ChangeSet' to put all action calls into one changeset, 'Isolated'
|
|
159
|
+
* to put them into separate changesets
|
|
190
160
|
*/
|
|
191
|
-
|
|
161
|
+
invocationGrouping?: string;
|
|
192
162
|
/**
|
|
193
163
|
* A human-readable label for the action. This is needed in case the action has a parameter and a parameter
|
|
194
164
|
* dialog is shown to the user. The label will be used for the title of the dialog and for the confirmation
|
|
@@ -196,20 +166,25 @@ declare namespace sap {
|
|
|
196
166
|
*/
|
|
197
167
|
label?: string;
|
|
198
168
|
/**
|
|
199
|
-
*
|
|
200
|
-
* to put them into separate changesets
|
|
169
|
+
* For an unbound action, an instance of an OData V4 model must be provided
|
|
201
170
|
*/
|
|
202
|
-
|
|
171
|
+
model?: sap.ui.model.odata.v4.ODataModel;
|
|
172
|
+
/**
|
|
173
|
+
* Boolean value indicating whether navigation is required after the action has been executed. Navigation
|
|
174
|
+
* takes place to the context returned by the action
|
|
175
|
+
*/
|
|
176
|
+
requiresNavigation?: boolean;
|
|
203
177
|
}
|
|
204
178
|
): Promise<any>;
|
|
205
179
|
/**
|
|
206
180
|
* @SINCE 1.98.0
|
|
207
|
-
* @EXPERIMENTAL (since 1.98.0)
|
|
208
181
|
*
|
|
209
|
-
*
|
|
210
|
-
*
|
|
211
|
-
* you reject the promise, the 'Create' action is stopped.
|
|
182
|
+
* @EXPERIMENTAL (since 1.98.0
|
|
183
|
+
* )
|
|
212
184
|
*
|
|
185
|
+
* This function can be used to intercept the 'Create' action. You can execute custom coding in this function.
|
|
186
|
+
* The framework waits for the returned promise to be resolved before continuing the 'Create' action.
|
|
187
|
+
* If you reject the promise, the 'Create' action is stopped.
|
|
213
188
|
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
214
189
|
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
|
|
215
190
|
*/
|
|
@@ -230,12 +205,13 @@ declare namespace sap {
|
|
|
230
205
|
): Promise<any>;
|
|
231
206
|
/**
|
|
232
207
|
* @SINCE 1.98.0
|
|
233
|
-
* @EXPERIMENTAL (since 1.98.0)
|
|
234
208
|
*
|
|
235
|
-
*
|
|
236
|
-
*
|
|
237
|
-
* you reject the promise, the 'Delete' action is stopped.
|
|
209
|
+
* @EXPERIMENTAL (since 1.98.0
|
|
210
|
+
* )
|
|
238
211
|
*
|
|
212
|
+
* This function can be used to intercept the 'Delete' action. You can execute custom coding in this function.
|
|
213
|
+
* The framework waits for the returned promise to be resolved before continuing the 'Delete' action.
|
|
214
|
+
* If you reject the promise, the 'Delete' action is stopped.
|
|
239
215
|
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
240
216
|
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
|
|
241
217
|
*/
|
|
@@ -247,17 +223,18 @@ declare namespace sap {
|
|
|
247
223
|
/**
|
|
248
224
|
* An array of contexts that are going to be deleted
|
|
249
225
|
*/
|
|
250
|
-
contexts?:
|
|
226
|
+
contexts?: sap.ui.model.odata.v4.Context[];
|
|
251
227
|
}
|
|
252
228
|
): Promise<any>;
|
|
253
229
|
/**
|
|
254
230
|
* @SINCE 1.98.0
|
|
255
|
-
* @EXPERIMENTAL (since 1.98.0)
|
|
256
231
|
*
|
|
257
|
-
*
|
|
258
|
-
*
|
|
259
|
-
* you reject the promise, the 'Discard' action is stopped and the user stays in edit mode.
|
|
232
|
+
* @EXPERIMENTAL (since 1.98.0
|
|
233
|
+
* )
|
|
260
234
|
*
|
|
235
|
+
* This function can be used to intercept the 'Discard' action. You can execute custom coding in this function.
|
|
236
|
+
* The framework waits for the returned promise to be resolved before continuing the 'Discard' action.
|
|
237
|
+
* If you reject the promise, the 'Discard' action is stopped and the user stays in edit mode.
|
|
261
238
|
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
262
239
|
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
|
|
263
240
|
*/
|
|
@@ -274,12 +251,13 @@ declare namespace sap {
|
|
|
274
251
|
): Promise<any>;
|
|
275
252
|
/**
|
|
276
253
|
* @SINCE 1.98.0
|
|
277
|
-
* @EXPERIMENTAL (since 1.98.0)
|
|
278
254
|
*
|
|
279
|
-
*
|
|
280
|
-
*
|
|
281
|
-
* reject the promise, the 'Edit' action is stopped and the user stays in display mode.
|
|
255
|
+
* @EXPERIMENTAL (since 1.98.0
|
|
256
|
+
* )
|
|
282
257
|
*
|
|
258
|
+
* This function can be used to intercept the 'Edit' action. You can execute custom coding in this function.
|
|
259
|
+
* The framework waits for the returned promise to be resolved before continuing the 'Edit' action.
|
|
260
|
+
* If you reject the promise, the 'Edit' action is stopped and the user stays in display mode.
|
|
283
261
|
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
284
262
|
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
|
|
285
263
|
*/
|
|
@@ -296,12 +274,13 @@ declare namespace sap {
|
|
|
296
274
|
): Promise<any>;
|
|
297
275
|
/**
|
|
298
276
|
* @SINCE 1.90.0
|
|
299
|
-
* @EXPERIMENTAL (since 1.90.0)
|
|
300
277
|
*
|
|
301
|
-
*
|
|
302
|
-
*
|
|
303
|
-
* reject the promise, the 'Save' action is stopped and the user stays in edit mode.
|
|
278
|
+
* @EXPERIMENTAL (since 1.90.0
|
|
279
|
+
* )
|
|
304
280
|
*
|
|
281
|
+
* This function can be used to intercept the 'Save' action. You can execute custom coding in this function.
|
|
282
|
+
* The framework waits for the returned promise to be resolved before continuing the 'Save' action.
|
|
283
|
+
* If you reject the promise, the 'Save' action is stopped and the user stays in edit mode.
|
|
305
284
|
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
306
285
|
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
|
|
307
286
|
*/
|
|
@@ -319,17 +298,24 @@ declare namespace sap {
|
|
|
319
298
|
/**
|
|
320
299
|
* @SINCE 1.90.0
|
|
321
300
|
*
|
|
301
|
+
*
|
|
322
302
|
* Saves a new document after checking it.
|
|
323
303
|
*/
|
|
324
304
|
saveDocument(
|
|
325
305
|
/**
|
|
326
306
|
* Context of the editable document
|
|
327
307
|
*/
|
|
328
|
-
oContext:
|
|
308
|
+
oContext: sap.ui.model.odata.v4.Context,
|
|
309
|
+
/**
|
|
310
|
+
* undefined
|
|
311
|
+
*/
|
|
312
|
+
mParameters: any
|
|
329
313
|
): Promise<any>;
|
|
330
314
|
/**
|
|
331
315
|
* @SINCE 1.90.0
|
|
332
|
-
*
|
|
316
|
+
*
|
|
317
|
+
* @EXPERIMENTAL (since 1.90.0
|
|
318
|
+
* )
|
|
333
319
|
*
|
|
334
320
|
* Secured execution of the given function. Ensures that the function is only executed when certain conditions
|
|
335
321
|
* are fulfilled.
|
|
@@ -348,14 +334,14 @@ declare namespace sap {
|
|
|
348
334
|
* Defines the busy indicator
|
|
349
335
|
*/
|
|
350
336
|
busy?: {
|
|
351
|
-
/**
|
|
352
|
-
* Triggers a busy indicator when the function is executed.
|
|
353
|
-
*/
|
|
354
|
-
set?: boolean;
|
|
355
337
|
/**
|
|
356
338
|
* Executes function only if application isn't busy.
|
|
357
339
|
*/
|
|
358
340
|
check?: boolean;
|
|
341
|
+
/**
|
|
342
|
+
* Triggers a busy indicator when the function is executed.
|
|
343
|
+
*/
|
|
344
|
+
set?: boolean;
|
|
359
345
|
};
|
|
360
346
|
/**
|
|
361
347
|
* This operation updates the current document without using the bound model and context. As a result, the
|
|
@@ -368,6 +354,7 @@ declare namespace sap {
|
|
|
368
354
|
/**
|
|
369
355
|
* @SINCE 1.90.0
|
|
370
356
|
*
|
|
357
|
+
*
|
|
371
358
|
* Updates the draft status and displays the error messages if there are errors during an update.
|
|
372
359
|
*/
|
|
373
360
|
updateDocument(
|
|
@@ -379,12 +366,13 @@ declare namespace sap {
|
|
|
379
366
|
* Promise to determine when the update operation is completed. The promise should be resolved when the
|
|
380
367
|
* update operation is completed, so the draft status can be updated.
|
|
381
368
|
*/
|
|
382
|
-
oPromise:
|
|
369
|
+
oPromise: Promise<any>
|
|
383
370
|
): Promise<any>;
|
|
384
371
|
}
|
|
385
372
|
/**
|
|
386
373
|
* @SINCE 1.86.0
|
|
387
374
|
*
|
|
375
|
+
*
|
|
388
376
|
* Controller extension providing hooks for intent-based navigation
|
|
389
377
|
*/
|
|
390
378
|
class IntentBasedNavigation extends sap.ui.core.mvc
|
|
@@ -394,6 +382,7 @@ declare namespace sap {
|
|
|
394
382
|
/**
|
|
395
383
|
* @SINCE 1.86.0
|
|
396
384
|
*
|
|
385
|
+
*
|
|
397
386
|
* Provides a hook to customize the {@link sap.fe.navigation.SelectionVariant} related to the intent-based
|
|
398
387
|
* navigation.
|
|
399
388
|
*/
|
|
@@ -401,25 +390,49 @@ declare namespace sap {
|
|
|
401
390
|
/**
|
|
402
391
|
* SelectionVariant provided by SAP Fiori elements.
|
|
403
392
|
*/
|
|
404
|
-
oSelectionVariant: sap.fe.navigation.SelectionVariant,
|
|
393
|
+
oSelectionVariant: /* was: sap.fe.core.sap.fe.navigation.SelectionVariant */ any,
|
|
405
394
|
/**
|
|
406
395
|
* Object containing intent-based navigation-related info
|
|
407
396
|
*/
|
|
408
397
|
oNavigationInfo: {
|
|
409
|
-
/**
|
|
410
|
-
* Semantic object related to the intent
|
|
411
|
-
*/
|
|
412
|
-
semanticObject: string;
|
|
413
398
|
/**
|
|
414
399
|
* Action related to the intent
|
|
415
400
|
*/
|
|
416
401
|
action: string;
|
|
402
|
+
/**
|
|
403
|
+
* Semantic object related to the intent
|
|
404
|
+
*/
|
|
405
|
+
semanticObject: string;
|
|
417
406
|
}
|
|
418
407
|
): void;
|
|
408
|
+
/**
|
|
409
|
+
* @SINCE 1.86.0
|
|
410
|
+
*
|
|
411
|
+
*
|
|
412
|
+
* Navigates to an intent defined by an outbound definition in the manifest.
|
|
413
|
+
*/
|
|
414
|
+
navigateOutbound(
|
|
415
|
+
/**
|
|
416
|
+
* Identifier to locate the outbound definition in the manifest.
|
|
417
|
+
* This provides the semantic object and action for the intent-based navigation.
|
|
418
|
+
* Additionally, the outbound definition can be used to provide parameters for intent-based navigation.
|
|
419
|
+
* See {@link topic:be0cf40f61184b358b5faedaec98b2da Descriptor for Applications, Components, and Libraries}
|
|
420
|
+
* for more information.
|
|
421
|
+
*/
|
|
422
|
+
sOutbound: string,
|
|
423
|
+
/**
|
|
424
|
+
* Optional map containing key/value pairs to be passed to the intent.
|
|
425
|
+
* If mNavigationParameters are provided, the parameters provided in the outbound definition of the manifest
|
|
426
|
+
* are ignored.
|
|
427
|
+
*/
|
|
428
|
+
mNavigationParameters: object
|
|
429
|
+
): void;
|
|
419
430
|
}
|
|
420
431
|
/**
|
|
421
432
|
* @SINCE 1.90.0
|
|
422
|
-
*
|
|
433
|
+
*
|
|
434
|
+
* @EXPERIMENTAL (since 1.90.0
|
|
435
|
+
* )
|
|
423
436
|
*
|
|
424
437
|
* A controller extension offering message handling.
|
|
425
438
|
*/
|
|
@@ -428,82 +441,62 @@ declare namespace sap {
|
|
|
428
441
|
|
|
429
442
|
/**
|
|
430
443
|
* @SINCE 1.90.0
|
|
431
|
-
* @EXPERIMENTAL (since 1.90.0)
|
|
432
444
|
*
|
|
433
|
-
*
|
|
434
|
-
*
|
|
435
|
-
*
|
|
436
|
-
*
|
|
437
|
-
*
|
|
445
|
+
* @EXPERIMENTAL (since 1.90.0
|
|
446
|
+
* )
|
|
447
|
+
*
|
|
448
|
+
* Shows a message dialog with transition messages if there are any.
|
|
449
|
+
* The message dialog is shown as a modal dialog. Once the user confirms the dialog, all transition messages
|
|
450
|
+
* are removed from the message model. If there is more than one message, a list of messages is shown. The
|
|
451
|
+
* user
|
|
452
|
+
* can filter on message types and can display details as well as the long text. If there is one message,
|
|
453
|
+
* the dialog immediately shows the details of the message. If there is just one success message, a message
|
|
454
|
+
* toast is shown instead.
|
|
438
455
|
*/
|
|
439
456
|
showMessageDialog(): Promise<any>;
|
|
440
457
|
}
|
|
441
458
|
/**
|
|
442
459
|
* @SINCE 1.94.0
|
|
443
460
|
*
|
|
461
|
+
*
|
|
444
462
|
* Controller extension providing hooks for the navigation using paginators
|
|
445
463
|
*/
|
|
446
464
|
class Paginator extends sap.ui.core.mvc.ControllerExtension {
|
|
447
465
|
constructor();
|
|
448
466
|
|
|
449
|
-
/**
|
|
450
|
-
* Creates a new subclass of class sap.fe.core.controllerextensions.Paginator with name `sClassName` and
|
|
451
|
-
* enriches it with the information contained in `oClassInfo`.
|
|
452
|
-
*
|
|
453
|
-
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.mvc.ControllerExtension.extend}.
|
|
454
|
-
*/
|
|
455
|
-
static extend<T extends Record<string, unknown>>(
|
|
456
|
-
/**
|
|
457
|
-
* Name of the class being created
|
|
458
|
-
*/
|
|
459
|
-
sClassName: string,
|
|
460
|
-
/**
|
|
461
|
-
* Object literal with information about the class
|
|
462
|
-
*/
|
|
463
|
-
oClassInfo?: sap.ClassInfo<
|
|
464
|
-
T,
|
|
465
|
-
sap.fe.core.controllerextensions.Paginator
|
|
466
|
-
>,
|
|
467
|
-
/**
|
|
468
|
-
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
469
|
-
* used by this class
|
|
470
|
-
*/
|
|
471
|
-
FNMetaImpl?: Function
|
|
472
|
-
): Function;
|
|
473
|
-
/**
|
|
474
|
-
* Returns a metadata object for class sap.fe.core.controllerextensions.Paginator.
|
|
475
|
-
*/
|
|
476
|
-
static getMetadata(): sap.ui.base.Metadata;
|
|
477
467
|
/**
|
|
478
468
|
* @SINCE 1.94.0
|
|
479
469
|
*
|
|
470
|
+
*
|
|
480
471
|
* Initiates the paginator control.
|
|
481
472
|
*/
|
|
482
473
|
initialize(
|
|
483
474
|
/**
|
|
484
475
|
* ODataListBinding object
|
|
485
476
|
*/
|
|
486
|
-
oBinding:
|
|
477
|
+
oBinding: any,
|
|
487
478
|
/**
|
|
488
479
|
* Current context where the navigation is initiated
|
|
489
480
|
*/
|
|
490
|
-
oContext:
|
|
481
|
+
oContext: sap.ui.model.odata.v4.Context
|
|
491
482
|
): void;
|
|
492
483
|
/**
|
|
493
484
|
* @SINCE 1.94.0
|
|
494
485
|
*
|
|
486
|
+
*
|
|
495
487
|
* Returns the updated context after the paginator operation.
|
|
496
488
|
*/
|
|
497
489
|
onContextUpdate(
|
|
498
490
|
/**
|
|
499
491
|
* Final context returned after the paginator action
|
|
500
492
|
*/
|
|
501
|
-
oContext:
|
|
493
|
+
oContext: sap.ui.model.odata.v4.Context
|
|
502
494
|
): void;
|
|
503
495
|
}
|
|
504
496
|
/**
|
|
505
497
|
* @SINCE 1.86.0
|
|
506
498
|
*
|
|
499
|
+
*
|
|
507
500
|
* A controller extension offering hooks into the routing flow of the application
|
|
508
501
|
*/
|
|
509
502
|
class Routing extends sap.ui.core.mvc.ControllerExtension {
|
|
@@ -512,6 +505,7 @@ declare namespace sap {
|
|
|
512
505
|
/**
|
|
513
506
|
* @SINCE 1.90.0
|
|
514
507
|
*
|
|
508
|
+
*
|
|
515
509
|
* Allows navigation to a specific context.
|
|
516
510
|
*/
|
|
517
511
|
navigate(
|
|
@@ -531,17 +525,17 @@ declare namespace sap {
|
|
|
531
525
|
/**
|
|
532
526
|
* Parameters to be used with route to create the target hash
|
|
533
527
|
*/
|
|
534
|
-
oParameters?:
|
|
528
|
+
oParameters?: any
|
|
535
529
|
): Promise<any>;
|
|
536
530
|
/**
|
|
537
531
|
* @SINCE 1.90.0
|
|
538
532
|
*
|
|
539
|
-
* This function is used to intercept the routing event after binding a page.
|
|
540
533
|
*
|
|
534
|
+
* This function is used to intercept the routing event after binding a page.
|
|
541
535
|
* If it is declared as an extension, it allows you to intercept and change the normal flow of binding.
|
|
542
536
|
*
|
|
543
|
-
* This function is not called directly, but overridden separately by consuming controllers.
|
|
544
|
-
* execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
|
|
537
|
+
* This function is not called directly, but overridden separately by consuming controllers.
|
|
538
|
+
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
|
|
545
539
|
*/
|
|
546
540
|
onAfterBinding(
|
|
547
541
|
/**
|
|
@@ -552,12 +546,12 @@ declare namespace sap {
|
|
|
552
546
|
/**
|
|
553
547
|
* @SINCE 1.90.0
|
|
554
548
|
*
|
|
555
|
-
* This function is used to intercept the routing event before binding a page.
|
|
556
549
|
*
|
|
550
|
+
* This function is used to intercept the routing event before binding a page.
|
|
557
551
|
* If it is declared as an extension, it allows you to intercept and change the normal flow of binding.
|
|
558
552
|
*
|
|
559
|
-
* This function is not called directly, but overridden separately by consuming controllers.
|
|
560
|
-
* execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
|
|
553
|
+
* This function is not called directly, but overridden separately by consuming controllers.
|
|
554
|
+
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
|
|
561
555
|
*/
|
|
562
556
|
onBeforeBinding(
|
|
563
557
|
/**
|
|
@@ -568,11 +562,12 @@ declare namespace sap {
|
|
|
568
562
|
/**
|
|
569
563
|
* @SINCE 1.86.0
|
|
570
564
|
*
|
|
565
|
+
*
|
|
571
566
|
* This function can be used to intercept the routing event happening during the normal process of navigating
|
|
572
567
|
* from one page to another.
|
|
573
|
-
*
|
|
574
|
-
* If
|
|
575
|
-
*
|
|
568
|
+
* If declared as an extension, it allows you to intercept and change the normal navigation flow.
|
|
569
|
+
* If you decide to do your own navigation processing, you can return `true` to prevent the default routing
|
|
570
|
+
* behavior.
|
|
576
571
|
*
|
|
577
572
|
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
578
573
|
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
|
|
@@ -590,9 +585,10 @@ declare namespace sap {
|
|
|
590
585
|
): boolean;
|
|
591
586
|
}
|
|
592
587
|
/**
|
|
593
|
-
* @SINCE 1.
|
|
588
|
+
* @SINCE 1.86.0
|
|
589
|
+
*
|
|
594
590
|
*
|
|
595
|
-
* A controller extension offering hooks into the
|
|
591
|
+
* A controller extension offering hooks into the routing flow of the application
|
|
596
592
|
*/
|
|
597
593
|
class Share extends sap.ui.core.mvc.ControllerExtension {
|
|
598
594
|
constructor();
|
|
@@ -600,6 +596,7 @@ declare namespace sap {
|
|
|
600
596
|
/**
|
|
601
597
|
* @SINCE 1.93.0
|
|
602
598
|
*
|
|
599
|
+
*
|
|
603
600
|
* Adapts the metadata used while sharing the page URL via 'Send Email', 'Share in SAP Jam', and 'Save as
|
|
604
601
|
* Tile'.
|
|
605
602
|
*/
|
|
@@ -608,71 +605,72 @@ declare namespace sap {
|
|
|
608
605
|
* Object containing the share metadata.
|
|
609
606
|
*/
|
|
610
607
|
oShareMetadata: {
|
|
611
|
-
/**
|
|
612
|
-
* Default URL that will be used via 'Send Email', 'Share in SAP Jam', and 'Save as Tile'
|
|
613
|
-
*/
|
|
614
|
-
url: string;
|
|
615
|
-
/**
|
|
616
|
-
* Default title that will be used as 'email subject' in 'Send Email', 'share text' in 'Share in SAP Jam'
|
|
617
|
-
* and 'title' in 'Save as Tile'
|
|
618
|
-
*/
|
|
619
|
-
title: string;
|
|
620
608
|
/**
|
|
621
609
|
* Email-specific metadata.
|
|
622
610
|
*/
|
|
623
611
|
email?: {
|
|
624
|
-
/**
|
|
625
|
-
* URL that will be used specifically for 'Send Email'. This takes precedence over oShareMetadata.url.
|
|
626
|
-
*/
|
|
627
|
-
url: string;
|
|
628
612
|
/**
|
|
629
613
|
* Title that will be used as "email subject" in 'Send Email'. This takes precedence over oShareMetadata.title.
|
|
630
614
|
*/
|
|
631
615
|
title: string;
|
|
616
|
+
/**
|
|
617
|
+
* URL that will be used specifically for 'Send Email'. This takes precedence over oShareMetadata.url.
|
|
618
|
+
*/
|
|
619
|
+
url: string;
|
|
632
620
|
};
|
|
633
621
|
/**
|
|
634
622
|
* SAP Jam-specific metadata.
|
|
635
623
|
*/
|
|
636
624
|
jam?: {
|
|
637
|
-
/**
|
|
638
|
-
* URL that will be used specifically for 'Share in SAP Jam'. This takes precedence over oShareMetadata.url.
|
|
639
|
-
*/
|
|
640
|
-
url: string;
|
|
641
625
|
/**
|
|
642
626
|
* Title that will be used as 'share text' in 'Share in SAP Jam'. This takes precedence over oShareMetadata.title.
|
|
643
627
|
*/
|
|
644
628
|
title: string;
|
|
629
|
+
/**
|
|
630
|
+
* URL that will be used specifically for 'Share in SAP Jam'. This takes precedence over oShareMetadata.url.
|
|
631
|
+
*/
|
|
632
|
+
url: string;
|
|
645
633
|
};
|
|
646
634
|
/**
|
|
647
635
|
* Save as Tile-specific metadata.
|
|
648
636
|
*/
|
|
649
637
|
tile?: {
|
|
650
638
|
/**
|
|
651
|
-
*
|
|
639
|
+
* Icon to be used for the tile.
|
|
652
640
|
*/
|
|
653
|
-
|
|
641
|
+
icon: string;
|
|
654
642
|
/**
|
|
655
|
-
*
|
|
643
|
+
* Query URL of an OData service from which data for a dynamic tile is read.
|
|
656
644
|
*/
|
|
657
|
-
|
|
645
|
+
queryUrl: string;
|
|
658
646
|
/**
|
|
659
647
|
* Subtitle to be used for the tile.
|
|
660
648
|
*/
|
|
661
649
|
subtitle: string;
|
|
662
650
|
/**
|
|
663
|
-
*
|
|
651
|
+
* Title to be used for the tile. This takes precedence over oShareMetadata.title.
|
|
664
652
|
*/
|
|
665
|
-
|
|
653
|
+
title: string;
|
|
666
654
|
/**
|
|
667
|
-
*
|
|
655
|
+
* URL that will be used specifically for 'Save as Tile'. This takes precedence over oShareMetadata.url.
|
|
668
656
|
*/
|
|
669
|
-
|
|
657
|
+
url: string;
|
|
670
658
|
};
|
|
659
|
+
/**
|
|
660
|
+
* Default title that will be used as 'email subject' in 'Send Email', 'share text' in 'Share in SAP Jam'
|
|
661
|
+
* and 'title' in 'Save as Tile'
|
|
662
|
+
*/
|
|
663
|
+
title: string;
|
|
664
|
+
/**
|
|
665
|
+
* Default URL that will be used via 'Send Email', 'Share in SAP Jam', and 'Save as Tile'
|
|
666
|
+
*/
|
|
667
|
+
url: string;
|
|
671
668
|
}
|
|
672
|
-
): object | Promise<
|
|
669
|
+
): object | Promise<any>;
|
|
673
670
|
/**
|
|
674
671
|
* @SINCE 1.93.0
|
|
675
672
|
*
|
|
673
|
+
*
|
|
676
674
|
* Opens the share sheet.
|
|
677
675
|
*/
|
|
678
676
|
openShareSheet(
|
|
@@ -685,8 +683,8 @@ declare namespace sap {
|
|
|
685
683
|
/**
|
|
686
684
|
* @SINCE 1.85.0
|
|
687
685
|
*
|
|
688
|
-
* A controller extension offering hooks for state handling
|
|
689
686
|
*
|
|
687
|
+
* A controller extension offering hooks for state handling
|
|
690
688
|
* If you need to maintain a specific state for your application, you can use the controller extension.
|
|
691
689
|
*/
|
|
692
690
|
class ViewState extends sap.ui.core.mvc.ControllerExtension {
|
|
@@ -694,7 +692,6 @@ declare namespace sap {
|
|
|
694
692
|
|
|
695
693
|
/**
|
|
696
694
|
* This function should add all controls relevant for refreshing to the provided control array.
|
|
697
|
-
*
|
|
698
695
|
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
699
696
|
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
|
|
700
697
|
*/
|
|
@@ -706,7 +703,6 @@ declare namespace sap {
|
|
|
706
703
|
): void;
|
|
707
704
|
/**
|
|
708
705
|
* Customize the `refreshBinding` function for a certain control.
|
|
709
|
-
*
|
|
710
706
|
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
711
707
|
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
|
|
712
708
|
*/
|
|
@@ -718,11 +714,10 @@ declare namespace sap {
|
|
|
718
714
|
/**
|
|
719
715
|
* A plain object which can have one function: `refreshBinding`
|
|
720
716
|
*/
|
|
721
|
-
oControlHandler:
|
|
717
|
+
oControlHandler: any[]
|
|
722
718
|
): void;
|
|
723
719
|
/**
|
|
724
720
|
* Customize the `retrieve` and `apply` functions for a certain control.
|
|
725
|
-
*
|
|
726
721
|
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
727
722
|
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
|
|
728
723
|
*/
|
|
@@ -739,7 +734,6 @@ declare namespace sap {
|
|
|
739
734
|
/**
|
|
740
735
|
* This function should add all controls for given view that should be considered for the state handling
|
|
741
736
|
* to the provided control array.
|
|
742
|
-
*
|
|
743
737
|
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
744
738
|
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
|
|
745
739
|
*/
|
|
@@ -751,7 +745,6 @@ declare namespace sap {
|
|
|
751
745
|
): void;
|
|
752
746
|
/**
|
|
753
747
|
* Applying additional, not control related, states - is called only if navigation type is iAppState.
|
|
754
|
-
*
|
|
755
748
|
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
756
749
|
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
|
|
757
750
|
*/
|
|
@@ -767,17 +760,15 @@ declare namespace sap {
|
|
|
767
760
|
): void;
|
|
768
761
|
/**
|
|
769
762
|
* Defines whether the view state should only be applied once initially.
|
|
770
|
-
*
|
|
771
763
|
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
772
764
|
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.Instead}.
|
|
773
765
|
*
|
|
774
|
-
* Important:
|
|
775
|
-
* and ObjectPage!
|
|
766
|
+
* Important:
|
|
767
|
+
* You should only override this method for custom pages and not for the standard ListReportPage and ObjectPage!
|
|
776
768
|
*/
|
|
777
769
|
applyInitialStateOnly(): boolean;
|
|
778
770
|
/**
|
|
779
771
|
* Apply navigation parameters - is called only if navigation type is not iAppState.
|
|
780
|
-
*
|
|
781
772
|
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
782
773
|
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
|
|
783
774
|
*/
|
|
@@ -789,7 +780,11 @@ declare namespace sap {
|
|
|
789
780
|
/**
|
|
790
781
|
* The actual navigation type
|
|
791
782
|
*/
|
|
792
|
-
navigationType:
|
|
783
|
+
navigationType: any;
|
|
784
|
+
/**
|
|
785
|
+
* Defines whether standard variant must be used in VM
|
|
786
|
+
*/
|
|
787
|
+
requiresStandardVariant?: boolean;
|
|
793
788
|
/**
|
|
794
789
|
* The selectionVariant from the navigation
|
|
795
790
|
*/
|
|
@@ -798,10 +793,6 @@ declare namespace sap {
|
|
|
798
793
|
* The selectionVariant defaults from the navigation
|
|
799
794
|
*/
|
|
800
795
|
selectionVariantDefaults?: object;
|
|
801
|
-
/**
|
|
802
|
-
* Defines whether standard variant must be used in VM
|
|
803
|
-
*/
|
|
804
|
-
requiresStandardVariant?: boolean;
|
|
805
796
|
},
|
|
806
797
|
/**
|
|
807
798
|
* Extensible array of promises to be resolved before continuing
|
|
@@ -815,7 +806,7 @@ declare namespace sap {
|
|
|
815
806
|
/**
|
|
816
807
|
* The view state to apply (can be undefined)
|
|
817
808
|
*/
|
|
818
|
-
oViewState:
|
|
809
|
+
oViewState: any,
|
|
819
810
|
/**
|
|
820
811
|
* The current navigation parameter
|
|
821
812
|
*/
|
|
@@ -823,7 +814,11 @@ declare namespace sap {
|
|
|
823
814
|
/**
|
|
824
815
|
* The actual navigation type
|
|
825
816
|
*/
|
|
826
|
-
navigationType:
|
|
817
|
+
navigationType: any;
|
|
818
|
+
/**
|
|
819
|
+
* Defines whether standard variant must be used in VM
|
|
820
|
+
*/
|
|
821
|
+
requiresStandardVariant?: boolean;
|
|
827
822
|
/**
|
|
828
823
|
* The selectionVariant from the navigation
|
|
829
824
|
*/
|
|
@@ -832,15 +827,10 @@ declare namespace sap {
|
|
|
832
827
|
* The selectionVariant defaults from the navigation
|
|
833
828
|
*/
|
|
834
829
|
selectionVariantDefaults?: object;
|
|
835
|
-
/**
|
|
836
|
-
* Defines whether standard variant must be used in VM
|
|
837
|
-
*/
|
|
838
|
-
requiresStandardVariant?: boolean;
|
|
839
830
|
}
|
|
840
831
|
): Promise<any>;
|
|
841
832
|
/**
|
|
842
833
|
* Hook to react when state for given view was applied.
|
|
843
|
-
*
|
|
844
834
|
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
845
835
|
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
|
|
846
836
|
*/
|
|
@@ -852,7 +842,6 @@ declare namespace sap {
|
|
|
852
842
|
): void;
|
|
853
843
|
/**
|
|
854
844
|
* Hook to react before a state for given view is applied.
|
|
855
|
-
*
|
|
856
845
|
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
857
846
|
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
|
|
858
847
|
*/
|
|
@@ -873,7 +862,6 @@ declare namespace sap {
|
|
|
873
862
|
/**
|
|
874
863
|
* Extend the map of additional states (not control bound) to be added to the current view state of the
|
|
875
864
|
* given view.
|
|
876
|
-
*
|
|
877
865
|
* This function is meant to be individually overridden by consuming controllers, but not to be called directly.
|
|
878
866
|
* The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
|
|
879
867
|
*/
|
|
@@ -884,8 +872,9 @@ declare namespace sap {
|
|
|
884
872
|
mAdditionalStates: object
|
|
885
873
|
): void;
|
|
886
874
|
/**
|
|
887
|
-
* Retrieve the view state of this extensions view.
|
|
888
|
-
* all but the final response will resolve
|
|
875
|
+
* Retrieve the view state of this extensions view.
|
|
876
|
+
* When this function is called more than once before finishing, all but the final response will resolve
|
|
877
|
+
* to `undefined`.
|
|
889
878
|
*/
|
|
890
879
|
retrieveViewState(): Promise<any>;
|
|
891
880
|
}
|
|
@@ -975,123 +964,71 @@ declare namespace sap {
|
|
|
975
964
|
}
|
|
976
965
|
}
|
|
977
966
|
|
|
978
|
-
namespace ExtensionAPI {
|
|
979
|
-
/**
|
|
980
|
-
* @SINCE 1.86.0
|
|
981
|
-
*
|
|
982
|
-
* ExtensionAPI for intent-based navigation
|
|
983
|
-
*/
|
|
984
|
-
interface intentBasedNavigation {
|
|
985
|
-
/**
|
|
986
|
-
* Navigates to an intent defined by an outbound definition in the manifest.
|
|
987
|
-
*/
|
|
988
|
-
navigateOutbound(
|
|
989
|
-
/**
|
|
990
|
-
* Identifier to locate the outbound definition in the manifest. This provides the semantic object and action
|
|
991
|
-
* for the intent-based navigation. Additionally, the outbound definition can be used to provide parameters
|
|
992
|
-
* for intent-based navigation. See {@link topic:be0cf40f61184b358b5faedaec98b2da Descriptor for Applications,
|
|
993
|
-
* Components, and Libraries} for more information.
|
|
994
|
-
*/
|
|
995
|
-
sOutbound: string,
|
|
996
|
-
/**
|
|
997
|
-
* Optional map containing key/value pairs to be passed to the intent. If mNavigationParameters are provided,
|
|
998
|
-
* the parameters provided in the outbound definition of the manifest are ignored.
|
|
999
|
-
*/
|
|
1000
|
-
mNavigationParameters: object
|
|
1001
|
-
): void;
|
|
1002
|
-
}
|
|
1003
|
-
const intentBasedNavigation: intentBasedNavigation;
|
|
1004
|
-
}
|
|
1005
|
-
|
|
1006
967
|
interface $AppComponentSettings
|
|
1007
968
|
extends sap.ui.core.$UIComponentSettings {}
|
|
1008
969
|
|
|
1009
970
|
/**
|
|
1010
971
|
* Main class for components used for an application in SAP Fiori elements.
|
|
1011
|
-
*
|
|
1012
972
|
* Application developers using the templates and building blocks provided by SAP Fiori elements should
|
|
1013
|
-
* create their apps by extending this component.
|
|
1014
|
-
* need for the building blocks and templates to work
|
|
973
|
+
* create their apps by extending this component.
|
|
974
|
+
* This ensures that all the necessary services that you need for the building blocks and templates to work
|
|
975
|
+
* properly are started.
|
|
1015
976
|
*
|
|
1016
977
|
* When you use sap.fe.core.AppComponent as the base component, you also need to use a rootView. SAP Fiori
|
|
1017
978
|
* elements provides two options:
|
|
979
|
+
*
|
|
1018
980
|
* - sap.fe.templates.RootContainer.view.NavContainer when using sap.m.routing.Router
|
|
981
|
+
*
|
|
1019
982
|
* - sap.fe.templates.RootContainer.view.Fcl when using sap.f.routing.Router (FCL use case)
|
|
1020
983
|
*/
|
|
1021
|
-
class AppComponent
|
|
1022
|
-
extends sap.ui.core.UIComponent
|
|
1023
|
-
implements sap.ui.core.IAsyncContentCreation {
|
|
1024
|
-
__implements__sap_ui_core_IAsyncContentCreation: boolean;
|
|
1025
|
-
|
|
984
|
+
class AppComponent extends sap.ui.core.UIComponent {
|
|
1026
985
|
constructor();
|
|
1027
|
-
|
|
1028
|
-
/**
|
|
1029
|
-
* Creates a new subclass of class sap.fe.core.AppComponent with name `sClassName` and enriches it with
|
|
1030
|
-
* the information contained in `oClassInfo`.
|
|
1031
|
-
*
|
|
1032
|
-
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.UIComponent.extend}.
|
|
1033
|
-
*/
|
|
1034
|
-
static extend<T extends Record<string, unknown>>(
|
|
1035
|
-
/**
|
|
1036
|
-
* Name of the class being created
|
|
1037
|
-
*/
|
|
1038
|
-
sClassName: string,
|
|
1039
|
-
/**
|
|
1040
|
-
* Object literal with information about the class
|
|
1041
|
-
*/
|
|
1042
|
-
oClassInfo?: sap.ClassInfo<T, sap.fe.core.AppComponent>,
|
|
1043
|
-
/**
|
|
1044
|
-
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
1045
|
-
* used by this class
|
|
1046
|
-
*/
|
|
1047
|
-
FNMetaImpl?: Function
|
|
1048
|
-
): Function;
|
|
1049
986
|
}
|
|
1050
987
|
/**
|
|
1051
988
|
* @SINCE 1.90.0
|
|
1052
989
|
*
|
|
1053
|
-
* Internal base controller class for SAP Fiori elements application.
|
|
1054
990
|
*
|
|
991
|
+
* Internal base controller class for SAP Fiori elements application.
|
|
1055
992
|
* If you want to extend a base controller for your custom page, please use for sap.fe.core.PageController.
|
|
1056
993
|
*/
|
|
1057
994
|
class BaseController extends sap.ui.core.mvc.Controller {
|
|
1058
995
|
constructor();
|
|
1059
996
|
|
|
1060
997
|
/**
|
|
1061
|
-
*
|
|
1062
|
-
*
|
|
998
|
+
* @SINCE 1.91.0
|
|
999
|
+
*
|
|
1063
1000
|
*
|
|
1064
|
-
*
|
|
1001
|
+
* Returns the current app component.
|
|
1065
1002
|
*/
|
|
1066
|
-
|
|
1003
|
+
getAppComponent(): sap.fe.core.AppComponent;
|
|
1004
|
+
/**
|
|
1005
|
+
* Convenience method provided by SAP Fiori elements to enable applications to include the view model by
|
|
1006
|
+
* name into each controller.
|
|
1007
|
+
*/
|
|
1008
|
+
getModel(
|
|
1067
1009
|
/**
|
|
1068
|
-
*
|
|
1010
|
+
* The model name
|
|
1069
1011
|
*/
|
|
1070
|
-
|
|
1012
|
+
sName?: string
|
|
1013
|
+
): sap.ui.model.Model;
|
|
1014
|
+
/**
|
|
1015
|
+
* Convenience method for setting the view model in every controller of the application.
|
|
1016
|
+
*/
|
|
1017
|
+
setModel(
|
|
1071
1018
|
/**
|
|
1072
|
-
*
|
|
1019
|
+
* The model instance
|
|
1073
1020
|
*/
|
|
1074
|
-
|
|
1021
|
+
oModel: sap.ui.model.Model,
|
|
1075
1022
|
/**
|
|
1076
|
-
*
|
|
1077
|
-
* used by this class
|
|
1023
|
+
* The model name
|
|
1078
1024
|
*/
|
|
1079
|
-
|
|
1080
|
-
):
|
|
1081
|
-
/**
|
|
1082
|
-
* Returns a metadata object for class sap.fe.core.BaseController.
|
|
1083
|
-
*/
|
|
1084
|
-
static getMetadata(): sap.ui.base.Metadata;
|
|
1085
|
-
/**
|
|
1086
|
-
* @SINCE 1.91.0
|
|
1087
|
-
*
|
|
1088
|
-
* Returns the current app component.
|
|
1089
|
-
*/
|
|
1090
|
-
getAppComponent(): sap.fe.core.AppComponent;
|
|
1025
|
+
sName: string
|
|
1026
|
+
): sap.ui.core.mvc.View;
|
|
1091
1027
|
}
|
|
1092
1028
|
/**
|
|
1093
1029
|
* @SINCE 1.79.0
|
|
1094
1030
|
*
|
|
1031
|
+
*
|
|
1095
1032
|
* Common Extension API for all pages of SAP Fiori elements for OData V4.
|
|
1096
1033
|
*/
|
|
1097
1034
|
class ExtensionAPI extends sap.ui.base.Object {
|
|
@@ -1106,29 +1043,30 @@ declare namespace sap {
|
|
|
1106
1043
|
*/
|
|
1107
1044
|
oControl: sap.ui.core.Control
|
|
1108
1045
|
): void;
|
|
1109
|
-
/**
|
|
1110
|
-
* ID of the element which is the current target of the association {@link #getEditFlow editFlow}, or `null`.
|
|
1111
|
-
*/
|
|
1112
|
-
getEditFlow(): sap.ui.core.ID;
|
|
1113
1046
|
/**
|
|
1114
1047
|
* Get access to models managed by SAP Fiori elements.
|
|
1115
|
-
*
|
|
1048
|
+
*
|
|
1049
|
+
* The following models can be accessed:
|
|
1050
|
+
*
|
|
1051
|
+
*
|
|
1116
1052
|
* - undefined: the undefined model returns the SAPUI5 OData V4 model bound to this page
|
|
1053
|
+
*
|
|
1117
1054
|
* - i18n / further data models defined in the manifest
|
|
1118
|
-
*
|
|
1119
|
-
*
|
|
1120
|
-
*
|
|
1055
|
+
* ui: returns a SAPUI5 JSON model containing UI information.
|
|
1056
|
+
* Only the following properties are public and supported:
|
|
1057
|
+
*
|
|
1058
|
+
*
|
|
1059
|
+
* - editMode: contains either 'Editable' or 'Display'
|
|
1060
|
+
*
|
|
1061
|
+
*
|
|
1062
|
+
* .
|
|
1121
1063
|
*/
|
|
1122
1064
|
getModel(
|
|
1123
1065
|
/**
|
|
1124
1066
|
* Name of the model
|
|
1125
1067
|
*/
|
|
1126
|
-
sModelName
|
|
1127
|
-
): sap.ui.model.Model;
|
|
1128
|
-
/**
|
|
1129
|
-
* ID of the element which is the current target of the association {@link #getRouting routing}, or `null`.
|
|
1130
|
-
*/
|
|
1131
|
-
getRouting(): sap.ui.core.ID;
|
|
1068
|
+
sModelName?: string
|
|
1069
|
+
): undefined | sap.ui.model.Model;
|
|
1132
1070
|
/**
|
|
1133
1071
|
* Load a fragment and go through the template preprocessor with the current page context.
|
|
1134
1072
|
*/
|
|
@@ -1138,27 +1076,27 @@ declare namespace sap {
|
|
|
1138
1076
|
*/
|
|
1139
1077
|
mSettings: {
|
|
1140
1078
|
/**
|
|
1141
|
-
* The
|
|
1142
|
-
*/
|
|
1143
|
-
id: string;
|
|
1144
|
-
/**
|
|
1145
|
-
* The name of the fragment to be loaded
|
|
1079
|
+
* The contextPath to be used for the templating process
|
|
1146
1080
|
*/
|
|
1147
|
-
|
|
1081
|
+
contextPath: string;
|
|
1148
1082
|
/**
|
|
1149
1083
|
* The controller to be attached to the fragment
|
|
1150
1084
|
*/
|
|
1151
1085
|
controller: object;
|
|
1152
1086
|
/**
|
|
1153
|
-
* The
|
|
1087
|
+
* The ID of the fragment itself
|
|
1154
1088
|
*/
|
|
1155
|
-
|
|
1089
|
+
id: string;
|
|
1156
1090
|
/**
|
|
1157
1091
|
* The initial binding context
|
|
1158
1092
|
*/
|
|
1159
1093
|
initialBindingContext: sap.ui.model.Context;
|
|
1094
|
+
/**
|
|
1095
|
+
* The name of the fragment to be loaded
|
|
1096
|
+
*/
|
|
1097
|
+
name: string;
|
|
1160
1098
|
}
|
|
1161
|
-
): Promise<
|
|
1099
|
+
): Promise<any>;
|
|
1162
1100
|
/**
|
|
1163
1101
|
* Navigate to another target.
|
|
1164
1102
|
*/
|
|
@@ -1170,8 +1108,8 @@ declare namespace sap {
|
|
|
1170
1108
|
/**
|
|
1171
1109
|
* Context instance
|
|
1172
1110
|
*/
|
|
1173
|
-
oContext
|
|
1174
|
-
):
|
|
1111
|
+
oContext: sap.ui.model.Context
|
|
1112
|
+
): void;
|
|
1175
1113
|
/**
|
|
1176
1114
|
* Remove a dependent control from this SAP Fiori elements page.
|
|
1177
1115
|
*/
|
|
@@ -1182,41 +1120,52 @@ declare namespace sap {
|
|
|
1182
1120
|
oControl: sap.ui.core.Control
|
|
1183
1121
|
): void;
|
|
1184
1122
|
/**
|
|
1185
|
-
*
|
|
1186
|
-
|
|
1187
|
-
setEditFlow(
|
|
1188
|
-
/**
|
|
1189
|
-
* ID of an element which becomes the new target of this editFlow association; alternatively, an element
|
|
1190
|
-
* instance may be given
|
|
1191
|
-
*/
|
|
1192
|
-
oEditFlow: sap.ui.core.ID | sap.fe.core.controllerextensions.EditFlow
|
|
1193
|
-
): this;
|
|
1194
|
-
/**
|
|
1195
|
-
* Sets the associated {@link #getRouting routing}.
|
|
1196
|
-
*/
|
|
1197
|
-
setRouting(
|
|
1198
|
-
/**
|
|
1199
|
-
* ID of an element which becomes the new target of this routing association; alternatively, an element
|
|
1200
|
-
* instance may be given
|
|
1201
|
-
*/
|
|
1202
|
-
oRouting: sap.ui.core.ID | sap.fe.core.controllerextensions.Routing
|
|
1203
|
-
): this;
|
|
1204
|
-
/**
|
|
1205
|
-
* Triggers an update of the app state. Should be called if the state of a control, or any other state-relevant
|
|
1206
|
-
* information, was changed.
|
|
1123
|
+
* Triggers an update of the app state.
|
|
1124
|
+
* Should be called if the state of a control, or any other state-relevant information, was changed.
|
|
1207
1125
|
*/
|
|
1208
|
-
updateAppState(): Promise<any>;
|
|
1126
|
+
updateAppState(): undefined | Promise<any>;
|
|
1209
1127
|
}
|
|
1210
1128
|
/**
|
|
1211
1129
|
* @SINCE 1.88.0
|
|
1212
1130
|
*
|
|
1213
|
-
* Base controller class for your custom page used inside an SAP Fiori elements application.
|
|
1214
1131
|
*
|
|
1132
|
+
* Base controller class for your custom page used inside an SAP Fiori elements application.
|
|
1215
1133
|
* This controller provides preconfigured extensions that will ensure you have the basic functionalities
|
|
1216
1134
|
* required to use the building blocks.
|
|
1217
1135
|
*/
|
|
1218
1136
|
class PageController extends sap.fe.core.BaseController {
|
|
1219
1137
|
constructor();
|
|
1138
|
+
|
|
1139
|
+
/**
|
|
1140
|
+
* @SINCE 1.91.0
|
|
1141
|
+
*
|
|
1142
|
+
*
|
|
1143
|
+
* Returns the current app component.
|
|
1144
|
+
*/
|
|
1145
|
+
getAppComponent(): sap.fe.core.AppComponent;
|
|
1146
|
+
/**
|
|
1147
|
+
* Convenience method provided by SAP Fiori elements to enable applications to include the view model by
|
|
1148
|
+
* name into each controller.
|
|
1149
|
+
*/
|
|
1150
|
+
getModel(
|
|
1151
|
+
/**
|
|
1152
|
+
* The model name
|
|
1153
|
+
*/
|
|
1154
|
+
sName?: string
|
|
1155
|
+
): sap.ui.model.Model;
|
|
1156
|
+
/**
|
|
1157
|
+
* Convenience method for setting the view model in every controller of the application.
|
|
1158
|
+
*/
|
|
1159
|
+
setModel(
|
|
1160
|
+
/**
|
|
1161
|
+
* The model instance
|
|
1162
|
+
*/
|
|
1163
|
+
oModel: sap.ui.model.Model,
|
|
1164
|
+
/**
|
|
1165
|
+
* The model name
|
|
1166
|
+
*/
|
|
1167
|
+
sName: string
|
|
1168
|
+
): sap.ui.core.mvc.View;
|
|
1220
1169
|
}
|
|
1221
1170
|
/**
|
|
1222
1171
|
* @SINCE 1.86.0
|