@openui5/ts-types 1.120.7 → 1.120.9
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.f.d.ts +1491 -849
- package/types/sap.m.d.ts +12924 -8165
- package/types/sap.tnt.d.ts +192 -97
- package/types/sap.ui.codeeditor.d.ts +48 -19
- package/types/sap.ui.commons.d.ts +1991 -667
- package/types/sap.ui.core.d.ts +5278 -3344
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.fl.d.ts +80 -38
- package/types/sap.ui.integration.d.ts +446 -387
- package/types/sap.ui.layout.d.ts +1118 -636
- package/types/sap.ui.mdc.d.ts +1930 -1300
- package/types/sap.ui.rta.d.ts +7 -7
- package/types/sap.ui.suite.d.ts +44 -12
- package/types/sap.ui.support.d.ts +31 -23
- package/types/sap.ui.table.d.ts +901 -619
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +1835 -1208
- package/types/sap.ui.ux3.d.ts +1282 -480
- package/types/sap.ui.webc.common.d.ts +11 -9
- package/types/sap.ui.webc.fiori.d.ts +836 -213
- package/types/sap.ui.webc.main.d.ts +2672 -593
- package/types/sap.uxap.d.ts +573 -318
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
// For Library Version: 1.120.
|
|
1
|
+
// For Library Version: 1.120.9
|
|
2
2
|
|
|
3
3
|
declare namespace sap {
|
|
4
4
|
namespace ui {
|
|
5
5
|
/**
|
|
6
|
-
* @since 1.62
|
|
7
|
-
*
|
|
8
6
|
* SAPUI5 library with controls specialized for SAP Fiori apps.
|
|
7
|
+
*
|
|
8
|
+
* @since 1.62
|
|
9
9
|
*/
|
|
10
10
|
namespace integration {
|
|
11
11
|
namespace designtime {
|
|
@@ -13,15 +13,16 @@ declare namespace sap {
|
|
|
13
13
|
namespace propertyEditor {
|
|
14
14
|
namespace iconEditor {
|
|
15
15
|
/**
|
|
16
|
+
* Validates if the provided value belongs to the icon pool.
|
|
17
|
+
*
|
|
16
18
|
* @since 1.81
|
|
17
19
|
* @experimental - 1.81
|
|
18
|
-
*
|
|
19
|
-
* Validates if the provided value belongs to the icon pool.
|
|
20
20
|
*/
|
|
21
21
|
namespace IsInIconPool {
|
|
22
22
|
/**
|
|
23
23
|
* Validator function
|
|
24
24
|
*
|
|
25
|
+
*
|
|
25
26
|
* @returns Validation result
|
|
26
27
|
*/
|
|
27
28
|
function validate(
|
|
@@ -36,15 +37,16 @@ declare namespace sap {
|
|
|
36
37
|
|
|
37
38
|
namespace validator {
|
|
38
39
|
/**
|
|
40
|
+
* Validates if the provided value is a boolean or binding string.
|
|
41
|
+
*
|
|
39
42
|
* @since 1.81
|
|
40
43
|
* @experimental - 1.81
|
|
41
|
-
*
|
|
42
|
-
* Validates if the provided value is a boolean or binding string.
|
|
43
44
|
*/
|
|
44
45
|
interface IsBoolean {
|
|
45
46
|
/**
|
|
46
47
|
* Validator function
|
|
47
48
|
*
|
|
49
|
+
*
|
|
48
50
|
* @returns Validation result
|
|
49
51
|
*/
|
|
50
52
|
validate(
|
|
@@ -56,15 +58,16 @@ declare namespace sap {
|
|
|
56
58
|
}
|
|
57
59
|
|
|
58
60
|
/**
|
|
61
|
+
* Validates if the provided value can be parsed to a valid date.
|
|
62
|
+
*
|
|
59
63
|
* @since 1.81
|
|
60
64
|
* @experimental - 1.81
|
|
61
|
-
*
|
|
62
|
-
* Validates if the provided value can be parsed to a valid date.
|
|
63
65
|
*/
|
|
64
66
|
interface IsDate {
|
|
65
67
|
/**
|
|
66
68
|
* Validator function
|
|
67
69
|
*
|
|
70
|
+
*
|
|
68
71
|
* @returns Validation result
|
|
69
72
|
*/
|
|
70
73
|
validate(
|
|
@@ -76,15 +79,16 @@ declare namespace sap {
|
|
|
76
79
|
}
|
|
77
80
|
|
|
78
81
|
/**
|
|
82
|
+
* Validates if the provided value is an integer or binding string.
|
|
83
|
+
*
|
|
79
84
|
* @since 1.81
|
|
80
85
|
* @experimental - 1.81
|
|
81
|
-
*
|
|
82
|
-
* Validates if the provided value is an integer or binding string.
|
|
83
86
|
*/
|
|
84
87
|
interface IsInteger {
|
|
85
88
|
/**
|
|
86
89
|
* Validator function
|
|
87
90
|
*
|
|
91
|
+
*
|
|
88
92
|
* @returns Validation result
|
|
89
93
|
*/
|
|
90
94
|
validate(
|
|
@@ -96,15 +100,16 @@ declare namespace sap {
|
|
|
96
100
|
}
|
|
97
101
|
|
|
98
102
|
/**
|
|
103
|
+
* Validates if the provided value is a number or binding string.
|
|
104
|
+
*
|
|
99
105
|
* @since 1.81
|
|
100
106
|
* @experimental - 1.81
|
|
101
|
-
*
|
|
102
|
-
* Validates if the provided value is a number or binding string.
|
|
103
107
|
*/
|
|
104
108
|
interface IsNumber {
|
|
105
109
|
/**
|
|
106
110
|
* Validator function
|
|
107
111
|
*
|
|
112
|
+
*
|
|
108
113
|
* @returns Validation result
|
|
109
114
|
*/
|
|
110
115
|
validate(
|
|
@@ -116,15 +121,16 @@ declare namespace sap {
|
|
|
116
121
|
}
|
|
117
122
|
|
|
118
123
|
/**
|
|
124
|
+
* Validates if the provided value is one of the given keys.
|
|
125
|
+
*
|
|
119
126
|
* @since 1.81
|
|
120
127
|
* @experimental - 1.81
|
|
121
|
-
*
|
|
122
|
-
* Validates if the provided value is one of the given keys.
|
|
123
128
|
*/
|
|
124
129
|
interface IsSelectedKey {
|
|
125
130
|
/**
|
|
126
131
|
* Validator function
|
|
127
132
|
*
|
|
133
|
+
*
|
|
128
134
|
* @returns Validation result
|
|
129
135
|
*/
|
|
130
136
|
validate(
|
|
@@ -145,15 +151,16 @@ declare namespace sap {
|
|
|
145
151
|
}
|
|
146
152
|
|
|
147
153
|
/**
|
|
154
|
+
* Validates if none of the provided values is an invalid binding.
|
|
155
|
+
*
|
|
148
156
|
* @since 1.81
|
|
149
157
|
* @experimental - 1.81
|
|
150
|
-
*
|
|
151
|
-
* Validates if none of the provided values is an invalid binding.
|
|
152
158
|
*/
|
|
153
159
|
interface IsStringList {
|
|
154
160
|
/**
|
|
155
161
|
* Validator function
|
|
156
162
|
*
|
|
163
|
+
*
|
|
157
164
|
* @returns Validation result
|
|
158
165
|
*/
|
|
159
166
|
validate(
|
|
@@ -165,15 +172,16 @@ declare namespace sap {
|
|
|
165
172
|
}
|
|
166
173
|
|
|
167
174
|
/**
|
|
175
|
+
* Validates if the provided key is unique in a list of given keys.
|
|
176
|
+
*
|
|
168
177
|
* @since 1.81
|
|
169
178
|
* @experimental - 1.81
|
|
170
|
-
*
|
|
171
|
-
* Validates if the provided key is unique in a list of given keys.
|
|
172
179
|
*/
|
|
173
180
|
interface IsUniqueKey {
|
|
174
181
|
/**
|
|
175
182
|
* Validator function
|
|
176
183
|
*
|
|
184
|
+
*
|
|
177
185
|
* @returns Validation result
|
|
178
186
|
*/
|
|
179
187
|
validate(
|
|
@@ -198,15 +206,16 @@ declare namespace sap {
|
|
|
198
206
|
}
|
|
199
207
|
|
|
200
208
|
/**
|
|
209
|
+
* Validates if the provided list contains no duplicates.
|
|
210
|
+
*
|
|
201
211
|
* @since 1.81
|
|
202
212
|
* @experimental - 1.81
|
|
203
|
-
*
|
|
204
|
-
* Validates if the provided list contains no duplicates.
|
|
205
213
|
*/
|
|
206
214
|
interface IsUniqueList {
|
|
207
215
|
/**
|
|
208
216
|
* Validator function
|
|
209
217
|
*
|
|
218
|
+
*
|
|
210
219
|
* @returns Validation result
|
|
211
220
|
*/
|
|
212
221
|
validate(
|
|
@@ -218,15 +227,16 @@ declare namespace sap {
|
|
|
218
227
|
}
|
|
219
228
|
|
|
220
229
|
/**
|
|
230
|
+
* Validates if the provided value is a valid binding.
|
|
231
|
+
*
|
|
221
232
|
* @since 1.81
|
|
222
233
|
* @experimental - 1.81
|
|
223
|
-
*
|
|
224
|
-
* Validates if the provided value is a valid binding.
|
|
225
234
|
*/
|
|
226
235
|
interface IsValidBinding {
|
|
227
236
|
/**
|
|
228
237
|
* Validator function
|
|
229
238
|
*
|
|
239
|
+
*
|
|
230
240
|
* @returns Validation result
|
|
231
241
|
*/
|
|
232
242
|
validate(
|
|
@@ -247,15 +257,16 @@ declare namespace sap {
|
|
|
247
257
|
}
|
|
248
258
|
|
|
249
259
|
/**
|
|
260
|
+
* Validates if the provided value doesn't exceed the maximum length.
|
|
261
|
+
*
|
|
250
262
|
* @since 1.81
|
|
251
263
|
* @experimental - 1.81
|
|
252
|
-
*
|
|
253
|
-
* Validates if the provided value doesn't exceed the maximum length.
|
|
254
264
|
*/
|
|
255
265
|
interface MaxLength {
|
|
256
266
|
/**
|
|
257
267
|
* Validator function
|
|
258
268
|
*
|
|
269
|
+
*
|
|
259
270
|
* @returns Validation result
|
|
260
271
|
*/
|
|
261
272
|
validate(
|
|
@@ -267,15 +278,16 @@ declare namespace sap {
|
|
|
267
278
|
}
|
|
268
279
|
|
|
269
280
|
/**
|
|
281
|
+
* Validates if the provided value doesn't contain a binding.
|
|
282
|
+
*
|
|
270
283
|
* @since 1.81
|
|
271
284
|
* @experimental - 1.81
|
|
272
|
-
*
|
|
273
|
-
* Validates if the provided value doesn't contain a binding.
|
|
274
285
|
*/
|
|
275
286
|
interface NotABinding {
|
|
276
287
|
/**
|
|
277
288
|
* Validator function
|
|
278
289
|
*
|
|
290
|
+
*
|
|
279
291
|
* @returns Validation result
|
|
280
292
|
*/
|
|
281
293
|
validate(
|
|
@@ -291,18 +303,18 @@ declare namespace sap {
|
|
|
291
303
|
|
|
292
304
|
namespace editor {
|
|
293
305
|
/**
|
|
294
|
-
* @experimental (since 1.94)
|
|
295
|
-
*
|
|
296
306
|
* Facade of the {@link sap.ui.integration.editor.Editor} control.
|
|
307
|
+
*
|
|
308
|
+
* @experimental (since 1.94)
|
|
297
309
|
*/
|
|
298
310
|
interface EditorFacade {
|
|
299
311
|
__implements__sap_ui_integration_editor_EditorFacade: boolean;
|
|
300
312
|
|
|
301
313
|
/**
|
|
302
|
-
* @experimental (since 1.94)
|
|
303
|
-
*
|
|
304
314
|
* Performs an HTTP request using the given configuration.
|
|
305
315
|
*
|
|
316
|
+
* @experimental (since 1.94)
|
|
317
|
+
*
|
|
306
318
|
* @returns Resolves when the request is successful, rejects otherwise.
|
|
307
319
|
*/
|
|
308
320
|
request(
|
|
@@ -349,10 +361,10 @@ declare namespace sap {
|
|
|
349
361
|
extends sap.ui.integration.$ExtensionSettings {}
|
|
350
362
|
|
|
351
363
|
/**
|
|
352
|
-
* @since 1.94
|
|
353
|
-
*
|
|
354
364
|
* Brings JavaScript capabilities for an {@link sap.ui.integration.editor.Editor} where custom logic can
|
|
355
365
|
* be implemented.
|
|
366
|
+
*
|
|
367
|
+
* @since 1.94
|
|
356
368
|
*/
|
|
357
369
|
class Extension extends sap.ui.integration.Extension {
|
|
358
370
|
/**
|
|
@@ -381,6 +393,7 @@ declare namespace sap {
|
|
|
381
393
|
/**
|
|
382
394
|
* Returns an interface to the editor, which uses this extension.
|
|
383
395
|
*
|
|
396
|
+
*
|
|
384
397
|
* @returns An interface to the card.
|
|
385
398
|
*/
|
|
386
399
|
getEditor(): sap.ui.integration.widgets.CardFacade;
|
|
@@ -393,20 +406,20 @@ declare namespace sap {
|
|
|
393
406
|
|
|
394
407
|
namespace widgets {
|
|
395
408
|
/**
|
|
396
|
-
* @experimental (since 1.79)
|
|
397
|
-
*
|
|
398
409
|
* Facade of the {@link sap.ui.integration.widgets.Card} control.
|
|
410
|
+
*
|
|
411
|
+
* @experimental (since 1.79)
|
|
399
412
|
*/
|
|
400
413
|
interface CardFacade {
|
|
401
414
|
__implements__sap_ui_integration_widgets_CardFacade: boolean;
|
|
402
415
|
|
|
403
416
|
/**
|
|
417
|
+
* Adds some actionDefinition to the aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
418
|
+
*
|
|
404
419
|
* @since 1.85
|
|
405
420
|
* @experimental (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
|
|
406
421
|
* may be done before its official public release. Use at your own discretion.
|
|
407
422
|
*
|
|
408
|
-
* Adds some actionDefinition to the aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
409
|
-
*
|
|
410
423
|
* @returns Reference to `this` in order to allow method chaining
|
|
411
424
|
*/
|
|
412
425
|
addActionDefinition(
|
|
@@ -416,28 +429,26 @@ declare namespace sap {
|
|
|
416
429
|
oActionDefinition: sap.ui.integration.ActionDefinition
|
|
417
430
|
): this;
|
|
418
431
|
/**
|
|
419
|
-
* @since 1.70
|
|
420
|
-
* @experimental (since 1.70)
|
|
421
|
-
*
|
|
422
432
|
* Gets current value of property {@link #getBaseUrl baseUrl}.
|
|
423
433
|
*
|
|
424
434
|
* Defines the base URL of the card manifest. It should be used when manifest property is an object instead
|
|
425
435
|
* of a URL. If both manifest URL and base URL are defined - the base URL will be used for loading dependencies.
|
|
426
436
|
*
|
|
437
|
+
* @since 1.70
|
|
438
|
+
* @experimental (since 1.70)
|
|
439
|
+
*
|
|
427
440
|
* @returns Value of property `baseUrl`
|
|
428
441
|
*/
|
|
429
442
|
getBaseUrl(): sap.ui.core.URI;
|
|
430
443
|
/**
|
|
431
|
-
* @experimental (since 1.114)
|
|
432
|
-
*
|
|
433
444
|
* Get information about the blocking message in the card.
|
|
434
445
|
*
|
|
446
|
+
* @experimental (since 1.114)
|
|
447
|
+
*
|
|
435
448
|
* @returns Information about the message or `null`, if such isn't shown.
|
|
436
449
|
*/
|
|
437
450
|
getBlockingMessage(): sap.ui.integration.BlockingMessageSettings | null;
|
|
438
451
|
/**
|
|
439
|
-
* @experimental (since 1.77)
|
|
440
|
-
*
|
|
441
452
|
* Gets values of manifest parameters combined with the parameters from `parameters` property.
|
|
442
453
|
*
|
|
443
454
|
* **Notes**
|
|
@@ -446,16 +457,18 @@ declare namespace sap {
|
|
|
446
457
|
*
|
|
447
458
|
* - Use when developing a Component card.
|
|
448
459
|
*
|
|
460
|
+
* @experimental (since 1.77)
|
|
461
|
+
*
|
|
449
462
|
* @returns Object containing parameters in format `{parameterKey: parameterValue}`.
|
|
450
463
|
*/
|
|
451
464
|
getCombinedParameters(): Record<string, any>;
|
|
452
465
|
/**
|
|
453
|
-
* @experimental (since 1.77)
|
|
454
|
-
*
|
|
455
466
|
* Returns a value from the Manifest based on the specified path.
|
|
456
467
|
*
|
|
457
468
|
* **Note** Use this method when the manifest is ready. Check `manifestReady` event.
|
|
458
469
|
*
|
|
470
|
+
* @experimental (since 1.77)
|
|
471
|
+
*
|
|
459
472
|
* @returns The value at the specified path.
|
|
460
473
|
*/
|
|
461
474
|
getManifestEntry(
|
|
@@ -465,23 +478,23 @@ declare namespace sap {
|
|
|
465
478
|
sPath: string
|
|
466
479
|
): any;
|
|
467
480
|
/**
|
|
468
|
-
* @experimental (since 1.65) - This property might be changed in future.
|
|
469
|
-
*
|
|
470
481
|
* Gets current value of property {@link #getParameters parameters}.
|
|
471
482
|
*
|
|
472
483
|
* Overrides the default values of the parameters, which are defined in the manifest. The value is an object
|
|
473
484
|
* containing parameters in format `{parameterKey: parameterValue}`.
|
|
474
485
|
*
|
|
486
|
+
* @experimental (since 1.65) - This property might be changed in future.
|
|
487
|
+
*
|
|
475
488
|
* @returns Value of property `parameters`
|
|
476
489
|
*/
|
|
477
490
|
getParameters(): object;
|
|
478
491
|
/**
|
|
479
|
-
* @experimental (since 1.83) - The API might change.
|
|
480
|
-
*
|
|
481
492
|
* Gets translated text from the i18n properties files configured for this card.
|
|
482
493
|
*
|
|
483
494
|
* For more details see {@link module:sap/base/i18n/ResourceBundle#getText}.
|
|
484
495
|
*
|
|
496
|
+
* @experimental (since 1.83) - The API might change.
|
|
497
|
+
*
|
|
485
498
|
* @returns The value belonging to the key, if found; otherwise the key itself or `undefined` depending
|
|
486
499
|
* on `bIgnoreKeyFallback`.
|
|
487
500
|
*/
|
|
@@ -504,9 +517,9 @@ declare namespace sap {
|
|
|
504
517
|
bIgnoreKeyFallback?: boolean
|
|
505
518
|
): string;
|
|
506
519
|
/**
|
|
507
|
-
* @experimental (since 1.114)
|
|
508
|
-
*
|
|
509
520
|
* Hide the blocking message that is shown in the card by `showBlockingMessage` call.
|
|
521
|
+
*
|
|
522
|
+
* @experimental (since 1.114)
|
|
510
523
|
*/
|
|
511
524
|
hideBlockingMessage(): void;
|
|
512
525
|
/**
|
|
@@ -520,19 +533,19 @@ declare namespace sap {
|
|
|
520
533
|
eCardArea?: sap.ui.integration.CardArea
|
|
521
534
|
): void;
|
|
522
535
|
/**
|
|
523
|
-
* @experimental (since 1.117)
|
|
524
|
-
*
|
|
525
536
|
* Hides the message previously shown by showMessage.
|
|
537
|
+
*
|
|
538
|
+
* @experimental (since 1.117)
|
|
526
539
|
*/
|
|
527
540
|
hideMessage(): void;
|
|
528
541
|
/**
|
|
542
|
+
* Checks for the provided `sap.ui.integration.ActionDefinition` in the aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
543
|
+
* and returns its index if found or -1 otherwise.
|
|
544
|
+
*
|
|
529
545
|
* @since 1.85
|
|
530
546
|
* @experimental (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
|
|
531
547
|
* may be done before its official public release. Use at your own discretion.
|
|
532
548
|
*
|
|
533
|
-
* Checks for the provided `sap.ui.integration.ActionDefinition` in the aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
534
|
-
* and returns its index if found or -1 otherwise.
|
|
535
|
-
*
|
|
536
549
|
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
537
550
|
*/
|
|
538
551
|
indexOfActionDefinition(
|
|
@@ -542,12 +555,12 @@ declare namespace sap {
|
|
|
542
555
|
oActionDefinition: sap.ui.integration.ActionDefinition
|
|
543
556
|
): int;
|
|
544
557
|
/**
|
|
558
|
+
* Inserts a actionDefinition into the aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
559
|
+
*
|
|
545
560
|
* @since 1.85
|
|
546
561
|
* @experimental (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
|
|
547
562
|
* may be done before its official public release. Use at your own discretion.
|
|
548
563
|
*
|
|
549
|
-
* Inserts a actionDefinition into the aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
550
|
-
*
|
|
551
564
|
* @returns Reference to `this` in order to allow method chaining
|
|
552
565
|
*/
|
|
553
566
|
insertActionDefinition(
|
|
@@ -563,24 +576,24 @@ declare namespace sap {
|
|
|
563
576
|
iIndex: int
|
|
564
577
|
): this;
|
|
565
578
|
/**
|
|
566
|
-
* @experimental (since 1.65) - The API might change.
|
|
567
|
-
*
|
|
568
579
|
* Refreshes the card by re-applying the manifest settings and triggering all data requests.
|
|
580
|
+
*
|
|
581
|
+
* @experimental (since 1.65) - The API might change.
|
|
569
582
|
*/
|
|
570
583
|
refresh(): void;
|
|
571
584
|
/**
|
|
572
|
-
* @since 1.95
|
|
573
|
-
*
|
|
574
585
|
* Refreshes the card data by triggering all data requests.
|
|
586
|
+
*
|
|
587
|
+
* @since 1.95
|
|
575
588
|
*/
|
|
576
589
|
refreshData(): void;
|
|
577
590
|
/**
|
|
591
|
+
* Removes a actionDefinition from the aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
592
|
+
*
|
|
578
593
|
* @since 1.85
|
|
579
594
|
* @experimental (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
|
|
580
595
|
* may be done before its official public release. Use at your own discretion.
|
|
581
596
|
*
|
|
582
|
-
* Removes a actionDefinition from the aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
583
|
-
*
|
|
584
597
|
* @returns The removed actionDefinition or `null`
|
|
585
598
|
*/
|
|
586
599
|
removeActionDefinition(
|
|
@@ -593,10 +606,10 @@ declare namespace sap {
|
|
|
593
606
|
| sap.ui.integration.ActionDefinition
|
|
594
607
|
): sap.ui.integration.ActionDefinition | null;
|
|
595
608
|
/**
|
|
596
|
-
* @experimental (since 1.79)
|
|
597
|
-
*
|
|
598
609
|
* Performs an HTTP request using the given configuration.
|
|
599
610
|
*
|
|
611
|
+
* @experimental (since 1.79)
|
|
612
|
+
*
|
|
600
613
|
* @returns Resolves when the request is successful, rejects otherwise.
|
|
601
614
|
*/
|
|
602
615
|
request(
|
|
@@ -638,6 +651,7 @@ declare namespace sap {
|
|
|
638
651
|
/**
|
|
639
652
|
* Resolves the destination and returns its URL.
|
|
640
653
|
*
|
|
654
|
+
*
|
|
641
655
|
* @returns A promise which resolves with the URL of the destination.
|
|
642
656
|
*/
|
|
643
657
|
resolveDestination(
|
|
@@ -647,10 +661,10 @@ declare namespace sap {
|
|
|
647
661
|
sKey: string
|
|
648
662
|
): Promise<string>;
|
|
649
663
|
/**
|
|
650
|
-
* @experimental (since 1.114)
|
|
651
|
-
*
|
|
652
664
|
* Show blocking message in the card's content area. Should be used after the `manifestApplied` event or
|
|
653
665
|
* after the `cardReady` lifecycle hook in Component cards and Extensions.
|
|
666
|
+
*
|
|
667
|
+
* @experimental (since 1.114)
|
|
654
668
|
*/
|
|
655
669
|
showBlockingMessage(
|
|
656
670
|
/**
|
|
@@ -670,11 +684,11 @@ declare namespace sap {
|
|
|
670
684
|
eCardArea?: sap.ui.integration.CardArea
|
|
671
685
|
): void;
|
|
672
686
|
/**
|
|
673
|
-
* @experimental (since 1.81)
|
|
674
|
-
*
|
|
675
687
|
* Displays a message strip above the content with the given text. There can be only 1 message displayed.
|
|
676
688
|
* If there is a previous message, it is removed. Can be used only after the `manifestApplied` event is
|
|
677
689
|
* fired.
|
|
690
|
+
*
|
|
691
|
+
* @experimental (since 1.81)
|
|
678
692
|
*/
|
|
679
693
|
showMessage(
|
|
680
694
|
/**
|
|
@@ -687,8 +701,6 @@ declare namespace sap {
|
|
|
687
701
|
sType: sap.ui.core.MessageType
|
|
688
702
|
): void;
|
|
689
703
|
/**
|
|
690
|
-
* @experimental (since 1.84)
|
|
691
|
-
*
|
|
692
704
|
* Triggers an action inside the card.
|
|
693
705
|
*
|
|
694
706
|
* Use this method if you need to trigger an action programmatically from inside an `Extension` or from
|
|
@@ -707,6 +719,9 @@ declare namespace sap {
|
|
|
707
719
|
* }
|
|
708
720
|
* });
|
|
709
721
|
* ```
|
|
722
|
+
*
|
|
723
|
+
*
|
|
724
|
+
* @experimental (since 1.84)
|
|
710
725
|
*/
|
|
711
726
|
triggerAction(
|
|
712
727
|
/**
|
|
@@ -724,10 +739,10 @@ declare namespace sap {
|
|
|
724
739
|
}
|
|
725
740
|
): void;
|
|
726
741
|
/**
|
|
727
|
-
* @experimental
|
|
728
|
-
*
|
|
729
742
|
* Causes all of the controls within the Card that support validation to validate their data.
|
|
730
743
|
*
|
|
744
|
+
* @experimental
|
|
745
|
+
*
|
|
731
746
|
* @returns if all of the controls validated successfully; otherwise, false
|
|
732
747
|
*/
|
|
733
748
|
validateControls(): boolean;
|
|
@@ -749,10 +764,10 @@ declare namespace sap {
|
|
|
749
764
|
| `{${string}}`;
|
|
750
765
|
|
|
751
766
|
/**
|
|
752
|
-
* @experimental (since 1.65) - This property might be changed in future.
|
|
753
|
-
*
|
|
754
767
|
* Overrides the default values of the parameters, which are defined in the manifest. The value is an object
|
|
755
768
|
* containing parameters in format `{parameterKey: parameterValue}`.
|
|
769
|
+
*
|
|
770
|
+
* @experimental (since 1.65) - This property might be changed in future.
|
|
756
771
|
*/
|
|
757
772
|
parameters?:
|
|
758
773
|
| object
|
|
@@ -760,10 +775,10 @@ declare namespace sap {
|
|
|
760
775
|
| `{${string}}`;
|
|
761
776
|
|
|
762
777
|
/**
|
|
778
|
+
* Defines the state of the `Card`. When set to `Inactive`, the `Card` doesn't make requests.
|
|
779
|
+
*
|
|
763
780
|
* @since 1.65
|
|
764
781
|
* @experimental (since 1.65)
|
|
765
|
-
*
|
|
766
|
-
* Defines the state of the `Card`. When set to `Inactive`, the `Card` doesn't make requests.
|
|
767
782
|
*/
|
|
768
783
|
dataMode?:
|
|
769
784
|
| sap.ui.integration.CardDataMode
|
|
@@ -771,11 +786,11 @@ declare namespace sap {
|
|
|
771
786
|
| `{${string}}`;
|
|
772
787
|
|
|
773
788
|
/**
|
|
774
|
-
* @since 1.70
|
|
775
|
-
* @experimental (since 1.70)
|
|
776
|
-
*
|
|
777
789
|
* Defines the base URL of the card manifest. It should be used when manifest property is an object instead
|
|
778
790
|
* of a URL. If both manifest URL and base URL are defined - the base URL will be used for loading dependencies.
|
|
791
|
+
*
|
|
792
|
+
* @since 1.70
|
|
793
|
+
* @experimental (since 1.70)
|
|
779
794
|
*/
|
|
780
795
|
baseUrl?:
|
|
781
796
|
| sap.ui.core.URI
|
|
@@ -783,10 +798,6 @@ declare namespace sap {
|
|
|
783
798
|
| `{${string}}`;
|
|
784
799
|
|
|
785
800
|
/**
|
|
786
|
-
* @since 1.76
|
|
787
|
-
* @experimental (since 1.76) - This API might be removed when a permanent solution for flexibility changes
|
|
788
|
-
* is implemented.
|
|
789
|
-
*
|
|
790
801
|
* Defines a list of configuration settings, which will be merged into the original manifest.
|
|
791
802
|
*
|
|
792
803
|
* This can be a list of flexibility changes generated during designtime.
|
|
@@ -822,6 +833,11 @@ declare namespace sap {
|
|
|
822
833
|
* }
|
|
823
834
|
* ]
|
|
824
835
|
* ```
|
|
836
|
+
*
|
|
837
|
+
*
|
|
838
|
+
* @since 1.76
|
|
839
|
+
* @experimental (since 1.76) - This API might be removed when a permanent solution for flexibility changes
|
|
840
|
+
* is implemented.
|
|
825
841
|
*/
|
|
826
842
|
manifestChanges?:
|
|
827
843
|
| object[]
|
|
@@ -829,10 +845,10 @@ declare namespace sap {
|
|
|
829
845
|
| `{${string}}`;
|
|
830
846
|
|
|
831
847
|
/**
|
|
848
|
+
* Defines the design of the `Card`.
|
|
849
|
+
*
|
|
832
850
|
* @since 1.109
|
|
833
851
|
* @experimental (since 1.109)
|
|
834
|
-
*
|
|
835
|
-
* Defines the design of the `Card`.
|
|
836
852
|
*/
|
|
837
853
|
design?:
|
|
838
854
|
| sap.ui.integration.CardDesign
|
|
@@ -840,10 +856,10 @@ declare namespace sap {
|
|
|
840
856
|
| `{${string}}`;
|
|
841
857
|
|
|
842
858
|
/**
|
|
859
|
+
* Defines the display variant for card rendering and behavior.
|
|
860
|
+
*
|
|
843
861
|
* @since 1.118
|
|
844
862
|
* @experimental (since 1.118) - For usage only by Work Zone.
|
|
845
|
-
*
|
|
846
|
-
* Defines the display variant for card rendering and behavior.
|
|
847
863
|
*/
|
|
848
864
|
displayVariant?:
|
|
849
865
|
| sap.ui.integration.CardDisplayVariant
|
|
@@ -851,15 +867,15 @@ declare namespace sap {
|
|
|
851
867
|
| `{${string}}`;
|
|
852
868
|
|
|
853
869
|
/**
|
|
854
|
-
* @since 1.112
|
|
855
|
-
* @experimental (since 1.112)
|
|
856
|
-
*
|
|
857
870
|
* Preview mode of the `Card`. Helpful in scenarios when the end user is choosing or configuring a card.
|
|
858
871
|
*
|
|
859
872
|
* - When set to "MockData", the card data is loaded, using a data request, as configured in the "data/mockData"
|
|
860
873
|
* in the manifest. If such configuration is missing, then the Abstract mode will be used instead.
|
|
861
874
|
* - When set to "Abstract", the card shows abstract placeholder without loading data.
|
|
862
875
|
* - When set to "Off", the card displays real data.
|
|
876
|
+
*
|
|
877
|
+
* @since 1.112
|
|
878
|
+
* @experimental (since 1.112)
|
|
863
879
|
*/
|
|
864
880
|
previewMode?:
|
|
865
881
|
| sap.ui.integration.CardPreviewMode
|
|
@@ -867,12 +883,12 @@ declare namespace sap {
|
|
|
867
883
|
| `{${string}}`;
|
|
868
884
|
|
|
869
885
|
/**
|
|
886
|
+
* Actions definitions from which actions in the header menu of the card are created. **Note**: This aggregation
|
|
887
|
+
* is destroyed when the property `manifest` changes.
|
|
888
|
+
*
|
|
870
889
|
* @since 1.85
|
|
871
890
|
* @experimental (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
|
|
872
891
|
* may be done before its official public release. Use at your own discretion.
|
|
873
|
-
*
|
|
874
|
-
* Actions definitions from which actions in the header menu of the card are created. **Note**: This aggregation
|
|
875
|
-
* is destroyed when the property `manifest` changes.
|
|
876
892
|
*/
|
|
877
893
|
actionDefinitions?:
|
|
878
894
|
| sap.ui.integration.ActionDefinition[]
|
|
@@ -886,29 +902,29 @@ declare namespace sap {
|
|
|
886
902
|
host?: sap.ui.core.Control | string;
|
|
887
903
|
|
|
888
904
|
/**
|
|
889
|
-
* @experimental (since 1.64) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
890
|
-
* be done before its official public release. Use at your own discretion.
|
|
891
|
-
*
|
|
892
905
|
* Fired when an action is triggered on the card.
|
|
893
906
|
*
|
|
894
907
|
* When an action is triggered in the card it can be handled on several places by "action" event handlers.
|
|
895
908
|
* In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
|
|
896
909
|
* one to handle the action by calling `oEvent.preventDefault()`.
|
|
910
|
+
*
|
|
911
|
+
* @experimental (since 1.64) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
912
|
+
* be done before its official public release. Use at your own discretion.
|
|
897
913
|
*/
|
|
898
914
|
action?: (oEvent: Card$ActionEvent) => void;
|
|
899
915
|
|
|
900
916
|
/**
|
|
901
|
-
* @experimental (since 1.96)
|
|
902
|
-
*
|
|
903
917
|
* Fired when some configuration settings are changed as a result of user interaction. For example - filter
|
|
904
918
|
* value is changed.
|
|
919
|
+
*
|
|
920
|
+
* @experimental (since 1.96)
|
|
905
921
|
*/
|
|
906
922
|
configurationChange?: (oEvent: Card$ConfigurationChangeEvent) => void;
|
|
907
923
|
|
|
908
924
|
/**
|
|
909
|
-
* @experimental (since 1.72)
|
|
910
|
-
*
|
|
911
925
|
* Fired when the manifest is loaded.
|
|
926
|
+
*
|
|
927
|
+
* @experimental (since 1.72)
|
|
912
928
|
*/
|
|
913
929
|
manifestReady?: (oEvent: sap.ui.base.Event) => void;
|
|
914
930
|
|
|
@@ -921,10 +937,10 @@ declare namespace sap {
|
|
|
921
937
|
manifestApplied?: (oEvent: sap.ui.base.Event) => void;
|
|
922
938
|
|
|
923
939
|
/**
|
|
924
|
-
* @experimental (since 1.107)
|
|
925
|
-
*
|
|
926
940
|
* Fired when the state of the card is changed. For example - the card is ready, new page is selected, a
|
|
927
941
|
* filter is changed or data is refreshed.
|
|
942
|
+
*
|
|
943
|
+
* @experimental (since 1.107)
|
|
928
944
|
*/
|
|
929
945
|
stateChanged?: (oEvent: sap.ui.base.Event) => void;
|
|
930
946
|
}
|
|
@@ -974,8 +990,6 @@ declare namespace sap {
|
|
|
974
990
|
interface Card$StateChangedEventParameters {}
|
|
975
991
|
|
|
976
992
|
/**
|
|
977
|
-
* @since 1.62
|
|
978
|
-
*
|
|
979
993
|
* A control that represents a container with a header and content.
|
|
980
994
|
*
|
|
981
995
|
* Overview: Cards are small user interface elements which provide the most important information from an
|
|
@@ -1013,6 +1027,8 @@ declare namespace sap {
|
|
|
1013
1027
|
*
|
|
1014
1028
|
* - When you have to use an application model. For such cases, use: {@link sap.f.Card sap.f.Card}.
|
|
1015
1029
|
* - When you need complex behavior. For such cases, use: {@link sap.f.Card sap.f.Card}.
|
|
1030
|
+
*
|
|
1031
|
+
* @since 1.62
|
|
1016
1032
|
*/
|
|
1017
1033
|
class Card extends sap.f.CardBase {
|
|
1018
1034
|
/**
|
|
@@ -1056,6 +1072,7 @@ declare namespace sap {
|
|
|
1056
1072
|
*
|
|
1057
1073
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.f.CardBase.extend}.
|
|
1058
1074
|
*
|
|
1075
|
+
*
|
|
1059
1076
|
* @returns Created class / constructor function
|
|
1060
1077
|
*/
|
|
1061
1078
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -1076,16 +1093,17 @@ declare namespace sap {
|
|
|
1076
1093
|
/**
|
|
1077
1094
|
* Returns a metadata object for class sap.ui.integration.widgets.Card.
|
|
1078
1095
|
*
|
|
1096
|
+
*
|
|
1079
1097
|
* @returns Metadata object describing this class
|
|
1080
1098
|
*/
|
|
1081
1099
|
static getMetadata(): sap.ui.core.ElementMetadata;
|
|
1082
1100
|
/**
|
|
1101
|
+
* Adds some actionDefinition to the aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
1102
|
+
*
|
|
1083
1103
|
* @since 1.85
|
|
1084
1104
|
* @experimental (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
|
|
1085
1105
|
* may be done before its official public release. Use at your own discretion.
|
|
1086
1106
|
*
|
|
1087
|
-
* Adds some actionDefinition to the aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
1088
|
-
*
|
|
1089
1107
|
* @returns Reference to `this` in order to allow method chaining
|
|
1090
1108
|
*/
|
|
1091
1109
|
addActionDefinition(
|
|
@@ -1095,9 +1113,6 @@ declare namespace sap {
|
|
|
1095
1113
|
oActionDefinition: sap.ui.integration.ActionDefinition
|
|
1096
1114
|
): this;
|
|
1097
1115
|
/**
|
|
1098
|
-
* @experimental (since 1.64) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
1099
|
-
* be done before its official public release. Use at your own discretion.
|
|
1100
|
-
*
|
|
1101
1116
|
* Attaches event handler `fnFunction` to the {@link #event:action action} event of this `sap.ui.integration.widgets.Card`.
|
|
1102
1117
|
*
|
|
1103
1118
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
@@ -1109,6 +1124,9 @@ declare namespace sap {
|
|
|
1109
1124
|
* In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
|
|
1110
1125
|
* one to handle the action by calling `oEvent.preventDefault()`.
|
|
1111
1126
|
*
|
|
1127
|
+
* @experimental (since 1.64) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
1128
|
+
* be done before its official public release. Use at your own discretion.
|
|
1129
|
+
*
|
|
1112
1130
|
* @returns Reference to `this` in order to allow method chaining
|
|
1113
1131
|
*/
|
|
1114
1132
|
attachAction(
|
|
@@ -1127,9 +1145,6 @@ declare namespace sap {
|
|
|
1127
1145
|
oListener?: object
|
|
1128
1146
|
): this;
|
|
1129
1147
|
/**
|
|
1130
|
-
* @experimental (since 1.64) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
1131
|
-
* be done before its official public release. Use at your own discretion.
|
|
1132
|
-
*
|
|
1133
1148
|
* Attaches event handler `fnFunction` to the {@link #event:action action} event of this `sap.ui.integration.widgets.Card`.
|
|
1134
1149
|
*
|
|
1135
1150
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
@@ -1141,6 +1156,9 @@ declare namespace sap {
|
|
|
1141
1156
|
* In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
|
|
1142
1157
|
* one to handle the action by calling `oEvent.preventDefault()`.
|
|
1143
1158
|
*
|
|
1159
|
+
* @experimental (since 1.64) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
1160
|
+
* be done before its official public release. Use at your own discretion.
|
|
1161
|
+
*
|
|
1144
1162
|
* @returns Reference to `this` in order to allow method chaining
|
|
1145
1163
|
*/
|
|
1146
1164
|
attachAction(
|
|
@@ -1154,8 +1172,6 @@ declare namespace sap {
|
|
|
1154
1172
|
oListener?: object
|
|
1155
1173
|
): this;
|
|
1156
1174
|
/**
|
|
1157
|
-
* @experimental (since 1.96)
|
|
1158
|
-
*
|
|
1159
1175
|
* Attaches event handler `fnFunction` to the {@link #event:configurationChange configurationChange} event
|
|
1160
1176
|
* of this `sap.ui.integration.widgets.Card`.
|
|
1161
1177
|
*
|
|
@@ -1165,6 +1181,8 @@ declare namespace sap {
|
|
|
1165
1181
|
* Fired when some configuration settings are changed as a result of user interaction. For example - filter
|
|
1166
1182
|
* value is changed.
|
|
1167
1183
|
*
|
|
1184
|
+
* @experimental (since 1.96)
|
|
1185
|
+
*
|
|
1168
1186
|
* @returns Reference to `this` in order to allow method chaining
|
|
1169
1187
|
*/
|
|
1170
1188
|
attachConfigurationChange(
|
|
@@ -1183,8 +1201,6 @@ declare namespace sap {
|
|
|
1183
1201
|
oListener?: object
|
|
1184
1202
|
): this;
|
|
1185
1203
|
/**
|
|
1186
|
-
* @experimental (since 1.96)
|
|
1187
|
-
*
|
|
1188
1204
|
* Attaches event handler `fnFunction` to the {@link #event:configurationChange configurationChange} event
|
|
1189
1205
|
* of this `sap.ui.integration.widgets.Card`.
|
|
1190
1206
|
*
|
|
@@ -1194,6 +1210,8 @@ declare namespace sap {
|
|
|
1194
1210
|
* Fired when some configuration settings are changed as a result of user interaction. For example - filter
|
|
1195
1211
|
* value is changed.
|
|
1196
1212
|
*
|
|
1213
|
+
* @experimental (since 1.96)
|
|
1214
|
+
*
|
|
1197
1215
|
* @returns Reference to `this` in order to allow method chaining
|
|
1198
1216
|
*/
|
|
1199
1217
|
attachConfigurationChange(
|
|
@@ -1218,6 +1236,7 @@ declare namespace sap {
|
|
|
1218
1236
|
*
|
|
1219
1237
|
* Note: The card's content may not be available yet because it may depend on other resources to load.
|
|
1220
1238
|
*
|
|
1239
|
+
*
|
|
1221
1240
|
* @returns Reference to `this` in order to allow method chaining
|
|
1222
1241
|
*/
|
|
1223
1242
|
attachManifestApplied(
|
|
@@ -1247,6 +1266,7 @@ declare namespace sap {
|
|
|
1247
1266
|
*
|
|
1248
1267
|
* Note: The card's content may not be available yet because it may depend on other resources to load.
|
|
1249
1268
|
*
|
|
1269
|
+
*
|
|
1250
1270
|
* @returns Reference to `this` in order to allow method chaining
|
|
1251
1271
|
*/
|
|
1252
1272
|
attachManifestApplied(
|
|
@@ -1260,8 +1280,6 @@ declare namespace sap {
|
|
|
1260
1280
|
oListener?: object
|
|
1261
1281
|
): this;
|
|
1262
1282
|
/**
|
|
1263
|
-
* @experimental (since 1.72)
|
|
1264
|
-
*
|
|
1265
1283
|
* Attaches event handler `fnFunction` to the {@link #event:manifestReady manifestReady} event of this `sap.ui.integration.widgets.Card`.
|
|
1266
1284
|
*
|
|
1267
1285
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
@@ -1269,6 +1287,8 @@ declare namespace sap {
|
|
|
1269
1287
|
*
|
|
1270
1288
|
* Fired when the manifest is loaded.
|
|
1271
1289
|
*
|
|
1290
|
+
* @experimental (since 1.72)
|
|
1291
|
+
*
|
|
1272
1292
|
* @returns Reference to `this` in order to allow method chaining
|
|
1273
1293
|
*/
|
|
1274
1294
|
attachManifestReady(
|
|
@@ -1287,8 +1307,6 @@ declare namespace sap {
|
|
|
1287
1307
|
oListener?: object
|
|
1288
1308
|
): this;
|
|
1289
1309
|
/**
|
|
1290
|
-
* @experimental (since 1.72)
|
|
1291
|
-
*
|
|
1292
1310
|
* Attaches event handler `fnFunction` to the {@link #event:manifestReady manifestReady} event of this `sap.ui.integration.widgets.Card`.
|
|
1293
1311
|
*
|
|
1294
1312
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
@@ -1296,6 +1314,8 @@ declare namespace sap {
|
|
|
1296
1314
|
*
|
|
1297
1315
|
* Fired when the manifest is loaded.
|
|
1298
1316
|
*
|
|
1317
|
+
* @experimental (since 1.72)
|
|
1318
|
+
*
|
|
1299
1319
|
* @returns Reference to `this` in order to allow method chaining
|
|
1300
1320
|
*/
|
|
1301
1321
|
attachManifestReady(
|
|
@@ -1309,8 +1329,6 @@ declare namespace sap {
|
|
|
1309
1329
|
oListener?: object
|
|
1310
1330
|
): this;
|
|
1311
1331
|
/**
|
|
1312
|
-
* @experimental (since 1.107)
|
|
1313
|
-
*
|
|
1314
1332
|
* Attaches event handler `fnFunction` to the {@link #event:stateChanged stateChanged} event of this `sap.ui.integration.widgets.Card`.
|
|
1315
1333
|
*
|
|
1316
1334
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
@@ -1319,6 +1337,8 @@ declare namespace sap {
|
|
|
1319
1337
|
* Fired when the state of the card is changed. For example - the card is ready, new page is selected, a
|
|
1320
1338
|
* filter is changed or data is refreshed.
|
|
1321
1339
|
*
|
|
1340
|
+
* @experimental (since 1.107)
|
|
1341
|
+
*
|
|
1322
1342
|
* @returns Reference to `this` in order to allow method chaining
|
|
1323
1343
|
*/
|
|
1324
1344
|
attachStateChanged(
|
|
@@ -1337,8 +1357,6 @@ declare namespace sap {
|
|
|
1337
1357
|
oListener?: object
|
|
1338
1358
|
): this;
|
|
1339
1359
|
/**
|
|
1340
|
-
* @experimental (since 1.107)
|
|
1341
|
-
*
|
|
1342
1360
|
* Attaches event handler `fnFunction` to the {@link #event:stateChanged stateChanged} event of this `sap.ui.integration.widgets.Card`.
|
|
1343
1361
|
*
|
|
1344
1362
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
@@ -1347,6 +1365,8 @@ declare namespace sap {
|
|
|
1347
1365
|
* Fired when the state of the card is changed. For example - the card is ready, new page is selected, a
|
|
1348
1366
|
* filter is changed or data is refreshed.
|
|
1349
1367
|
*
|
|
1368
|
+
* @experimental (since 1.107)
|
|
1369
|
+
*
|
|
1350
1370
|
* @returns Reference to `this` in order to allow method chaining
|
|
1351
1371
|
*/
|
|
1352
1372
|
attachStateChanged(
|
|
@@ -1360,23 +1380,23 @@ declare namespace sap {
|
|
|
1360
1380
|
oListener?: object
|
|
1361
1381
|
): this;
|
|
1362
1382
|
/**
|
|
1383
|
+
* Destroys all the actionDefinitions in the aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
1384
|
+
*
|
|
1363
1385
|
* @since 1.85
|
|
1364
1386
|
* @experimental (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
|
|
1365
1387
|
* may be done before its official public release. Use at your own discretion.
|
|
1366
1388
|
*
|
|
1367
|
-
* Destroys all the actionDefinitions in the aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
1368
|
-
*
|
|
1369
1389
|
* @returns Reference to `this` in order to allow method chaining
|
|
1370
1390
|
*/
|
|
1371
1391
|
destroyActionDefinitions(): this;
|
|
1372
1392
|
/**
|
|
1373
|
-
* @experimental (since 1.64) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
1374
|
-
* be done before its official public release. Use at your own discretion.
|
|
1375
|
-
*
|
|
1376
1393
|
* Detaches event handler `fnFunction` from the {@link #event:action action} event of this `sap.ui.integration.widgets.Card`.
|
|
1377
1394
|
*
|
|
1378
1395
|
* The passed function and listener object must match the ones used for event registration.
|
|
1379
1396
|
*
|
|
1397
|
+
* @experimental (since 1.64) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
1398
|
+
* be done before its official public release. Use at your own discretion.
|
|
1399
|
+
*
|
|
1380
1400
|
* @returns Reference to `this` in order to allow method chaining
|
|
1381
1401
|
*/
|
|
1382
1402
|
detachAction(
|
|
@@ -1390,13 +1410,13 @@ declare namespace sap {
|
|
|
1390
1410
|
oListener?: object
|
|
1391
1411
|
): this;
|
|
1392
1412
|
/**
|
|
1393
|
-
* @experimental (since 1.96)
|
|
1394
|
-
*
|
|
1395
1413
|
* Detaches event handler `fnFunction` from the {@link #event:configurationChange configurationChange} event
|
|
1396
1414
|
* of this `sap.ui.integration.widgets.Card`.
|
|
1397
1415
|
*
|
|
1398
1416
|
* The passed function and listener object must match the ones used for event registration.
|
|
1399
1417
|
*
|
|
1418
|
+
* @experimental (since 1.96)
|
|
1419
|
+
*
|
|
1400
1420
|
* @returns Reference to `this` in order to allow method chaining
|
|
1401
1421
|
*/
|
|
1402
1422
|
detachConfigurationChange(
|
|
@@ -1415,6 +1435,7 @@ declare namespace sap {
|
|
|
1415
1435
|
*
|
|
1416
1436
|
* The passed function and listener object must match the ones used for event registration.
|
|
1417
1437
|
*
|
|
1438
|
+
*
|
|
1418
1439
|
* @returns Reference to `this` in order to allow method chaining
|
|
1419
1440
|
*/
|
|
1420
1441
|
detachManifestApplied(
|
|
@@ -1428,13 +1449,13 @@ declare namespace sap {
|
|
|
1428
1449
|
oListener?: object
|
|
1429
1450
|
): this;
|
|
1430
1451
|
/**
|
|
1431
|
-
* @experimental (since 1.72)
|
|
1432
|
-
*
|
|
1433
1452
|
* Detaches event handler `fnFunction` from the {@link #event:manifestReady manifestReady} event of this
|
|
1434
1453
|
* `sap.ui.integration.widgets.Card`.
|
|
1435
1454
|
*
|
|
1436
1455
|
* The passed function and listener object must match the ones used for event registration.
|
|
1437
1456
|
*
|
|
1457
|
+
* @experimental (since 1.72)
|
|
1458
|
+
*
|
|
1438
1459
|
* @returns Reference to `this` in order to allow method chaining
|
|
1439
1460
|
*/
|
|
1440
1461
|
detachManifestReady(
|
|
@@ -1448,12 +1469,12 @@ declare namespace sap {
|
|
|
1448
1469
|
oListener?: object
|
|
1449
1470
|
): this;
|
|
1450
1471
|
/**
|
|
1451
|
-
* @experimental (since 1.107)
|
|
1452
|
-
*
|
|
1453
1472
|
* Detaches event handler `fnFunction` from the {@link #event:stateChanged stateChanged} event of this `sap.ui.integration.widgets.Card`.
|
|
1454
1473
|
*
|
|
1455
1474
|
* The passed function and listener object must match the ones used for event registration.
|
|
1456
1475
|
*
|
|
1476
|
+
* @experimental (since 1.107)
|
|
1477
|
+
*
|
|
1457
1478
|
* @returns Reference to `this` in order to allow method chaining
|
|
1458
1479
|
*/
|
|
1459
1480
|
detachStateChanged(
|
|
@@ -1467,15 +1488,15 @@ declare namespace sap {
|
|
|
1467
1488
|
oListener?: object
|
|
1468
1489
|
): this;
|
|
1469
1490
|
/**
|
|
1470
|
-
* @experimental (since 1.64) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
1471
|
-
* be done before its official public release. Use at your own discretion.
|
|
1472
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1473
|
-
*
|
|
1474
1491
|
* Fires event {@link #event:action action} to attached listeners.
|
|
1475
1492
|
*
|
|
1476
1493
|
* Listeners may prevent the default action of this event by calling the `preventDefault` method on the
|
|
1477
1494
|
* event object. The return value of this method indicates whether the default action should be executed.
|
|
1478
1495
|
*
|
|
1496
|
+
* @experimental (since 1.64) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
1497
|
+
* be done before its official public release. Use at your own discretion.
|
|
1498
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1499
|
+
*
|
|
1479
1500
|
* @returns Whether or not to prevent the default action
|
|
1480
1501
|
*/
|
|
1481
1502
|
fireAction(
|
|
@@ -1485,11 +1506,11 @@ declare namespace sap {
|
|
|
1485
1506
|
mParameters?: sap.ui.integration.widgets.Card$ActionEventParameters
|
|
1486
1507
|
): boolean;
|
|
1487
1508
|
/**
|
|
1509
|
+
* Fires event {@link #event:configurationChange configurationChange} to attached listeners.
|
|
1510
|
+
*
|
|
1488
1511
|
* @experimental (since 1.96)
|
|
1489
1512
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1490
1513
|
*
|
|
1491
|
-
* Fires event {@link #event:configurationChange configurationChange} to attached listeners.
|
|
1492
|
-
*
|
|
1493
1514
|
* @returns Reference to `this` in order to allow method chaining
|
|
1494
1515
|
*/
|
|
1495
1516
|
fireConfigurationChange(
|
|
@@ -1499,10 +1520,10 @@ declare namespace sap {
|
|
|
1499
1520
|
mParameters?: sap.ui.integration.widgets.Card$ConfigurationChangeEventParameters
|
|
1500
1521
|
): this;
|
|
1501
1522
|
/**
|
|
1502
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1503
|
-
*
|
|
1504
1523
|
* Fires event {@link #event:manifestApplied manifestApplied} to attached listeners.
|
|
1505
1524
|
*
|
|
1525
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1526
|
+
*
|
|
1506
1527
|
* @returns Reference to `this` in order to allow method chaining
|
|
1507
1528
|
*/
|
|
1508
1529
|
fireManifestApplied(
|
|
@@ -1512,11 +1533,11 @@ declare namespace sap {
|
|
|
1512
1533
|
mParameters?: object
|
|
1513
1534
|
): this;
|
|
1514
1535
|
/**
|
|
1536
|
+
* Fires event {@link #event:manifestReady manifestReady} to attached listeners.
|
|
1537
|
+
*
|
|
1515
1538
|
* @experimental (since 1.72)
|
|
1516
1539
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1517
1540
|
*
|
|
1518
|
-
* Fires event {@link #event:manifestReady manifestReady} to attached listeners.
|
|
1519
|
-
*
|
|
1520
1541
|
* @returns Reference to `this` in order to allow method chaining
|
|
1521
1542
|
*/
|
|
1522
1543
|
fireManifestReady(
|
|
@@ -1526,11 +1547,11 @@ declare namespace sap {
|
|
|
1526
1547
|
mParameters?: object
|
|
1527
1548
|
): this;
|
|
1528
1549
|
/**
|
|
1550
|
+
* Fires event {@link #event:stateChanged stateChanged} to attached listeners.
|
|
1551
|
+
*
|
|
1529
1552
|
* @experimental (since 1.107)
|
|
1530
1553
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1531
1554
|
*
|
|
1532
|
-
* Fires event {@link #event:stateChanged stateChanged} to attached listeners.
|
|
1533
|
-
*
|
|
1534
1555
|
* @returns Reference to `this` in order to allow method chaining
|
|
1535
1556
|
*/
|
|
1536
1557
|
fireStateChanged(
|
|
@@ -1540,39 +1561,37 @@ declare namespace sap {
|
|
|
1540
1561
|
mParameters?: object
|
|
1541
1562
|
): this;
|
|
1542
1563
|
/**
|
|
1543
|
-
* @since 1.85
|
|
1544
|
-
* @experimental (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
|
|
1545
|
-
* may be done before its official public release. Use at your own discretion.
|
|
1546
|
-
*
|
|
1547
1564
|
* Gets content of aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
1548
1565
|
*
|
|
1549
1566
|
* Actions definitions from which actions in the header menu of the card are created. **Note**: This aggregation
|
|
1550
1567
|
* is destroyed when the property `manifest` changes.
|
|
1568
|
+
*
|
|
1569
|
+
* @since 1.85
|
|
1570
|
+
* @experimental (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
|
|
1571
|
+
* may be done before its official public release. Use at your own discretion.
|
|
1551
1572
|
*/
|
|
1552
1573
|
getActionDefinitions(): sap.ui.integration.ActionDefinition[];
|
|
1553
1574
|
/**
|
|
1554
|
-
* @since 1.70
|
|
1555
|
-
* @experimental (since 1.70)
|
|
1556
|
-
*
|
|
1557
1575
|
* Gets current value of property {@link #getBaseUrl baseUrl}.
|
|
1558
1576
|
*
|
|
1559
1577
|
* Defines the base URL of the card manifest. It should be used when manifest property is an object instead
|
|
1560
1578
|
* of a URL. If both manifest URL and base URL are defined - the base URL will be used for loading dependencies.
|
|
1561
1579
|
*
|
|
1580
|
+
* @since 1.70
|
|
1581
|
+
* @experimental (since 1.70)
|
|
1582
|
+
*
|
|
1562
1583
|
* @returns Value of property `baseUrl`
|
|
1563
1584
|
*/
|
|
1564
1585
|
getBaseUrl(): sap.ui.core.URI;
|
|
1565
1586
|
/**
|
|
1566
|
-
* @experimental (since 1.114)
|
|
1567
|
-
*
|
|
1568
1587
|
* Get information about the blocking message in the card.
|
|
1569
1588
|
*
|
|
1589
|
+
* @experimental (since 1.114)
|
|
1590
|
+
*
|
|
1570
1591
|
* @returns Information about the message or `null`, if such isn't shown.
|
|
1571
1592
|
*/
|
|
1572
1593
|
getBlockingMessage(): sap.ui.integration.BlockingMessageSettings | null;
|
|
1573
1594
|
/**
|
|
1574
|
-
* @experimental (since 1.77)
|
|
1575
|
-
*
|
|
1576
1595
|
* Gets values of manifest parameters combined with the parameters from `parameters` property.
|
|
1577
1596
|
*
|
|
1578
1597
|
* **Notes**
|
|
@@ -1581,53 +1600,55 @@ declare namespace sap {
|
|
|
1581
1600
|
*
|
|
1582
1601
|
* - Use when developing a Component card.
|
|
1583
1602
|
*
|
|
1603
|
+
* @experimental (since 1.77)
|
|
1604
|
+
*
|
|
1584
1605
|
* @returns Object containing parameters in format `{parameterKey: parameterValue}`.
|
|
1585
1606
|
*/
|
|
1586
1607
|
getCombinedParameters(): Record<string, any>;
|
|
1587
1608
|
/**
|
|
1588
|
-
* @since 1.65
|
|
1589
|
-
* @experimental (since 1.65)
|
|
1590
|
-
*
|
|
1591
1609
|
* Gets current value of property {@link #getDataMode dataMode}.
|
|
1592
1610
|
*
|
|
1593
1611
|
* Defines the state of the `Card`. When set to `Inactive`, the `Card` doesn't make requests.
|
|
1594
1612
|
*
|
|
1595
1613
|
* Default value is `Auto`.
|
|
1596
1614
|
*
|
|
1615
|
+
* @since 1.65
|
|
1616
|
+
* @experimental (since 1.65)
|
|
1617
|
+
*
|
|
1597
1618
|
* @returns Value of property `dataMode`
|
|
1598
1619
|
*/
|
|
1599
1620
|
getDataMode(): sap.ui.integration.CardDataMode;
|
|
1600
1621
|
/**
|
|
1601
|
-
* @since 1.109
|
|
1602
|
-
* @experimental (since 1.109)
|
|
1603
|
-
*
|
|
1604
1622
|
* Gets current value of property {@link #getDesign design}.
|
|
1605
1623
|
*
|
|
1606
1624
|
* Defines the design of the `Card`.
|
|
1607
1625
|
*
|
|
1608
1626
|
* Default value is `Solid`.
|
|
1609
1627
|
*
|
|
1628
|
+
* @since 1.109
|
|
1629
|
+
* @experimental (since 1.109)
|
|
1630
|
+
*
|
|
1610
1631
|
* @returns Value of property `design`
|
|
1611
1632
|
*/
|
|
1612
1633
|
getDesign(): sap.ui.integration.CardDesign;
|
|
1613
1634
|
/**
|
|
1614
|
-
* @since 1.118
|
|
1615
|
-
* @experimental (since 1.118) - For usage only by Work Zone.
|
|
1616
|
-
*
|
|
1617
1635
|
* Gets current value of property {@link #getDisplayVariant displayVariant}.
|
|
1618
1636
|
*
|
|
1619
1637
|
* Defines the display variant for card rendering and behavior.
|
|
1620
1638
|
*
|
|
1621
1639
|
* Default value is `Standard`.
|
|
1622
1640
|
*
|
|
1641
|
+
* @since 1.118
|
|
1642
|
+
* @experimental (since 1.118) - For usage only by Work Zone.
|
|
1643
|
+
*
|
|
1623
1644
|
* @returns Value of property `displayVariant`
|
|
1624
1645
|
*/
|
|
1625
1646
|
getDisplayVariant(): sap.ui.integration.CardDisplayVariant;
|
|
1626
1647
|
/**
|
|
1627
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1628
|
-
*
|
|
1629
1648
|
* Returns the DOM Element that should get the focus.
|
|
1630
1649
|
*
|
|
1650
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1651
|
+
*
|
|
1631
1652
|
* @returns Returns the DOM Element that should get the focus
|
|
1632
1653
|
*/
|
|
1633
1654
|
getFocusDomRef(): Element;
|
|
@@ -1636,24 +1657,21 @@ declare namespace sap {
|
|
|
1636
1657
|
*/
|
|
1637
1658
|
getHost(): sap.ui.core.ID;
|
|
1638
1659
|
/**
|
|
1639
|
-
* @experimental (since 1.77)
|
|
1640
|
-
*
|
|
1641
1660
|
* Gets the instance of the `host` association.
|
|
1642
1661
|
*
|
|
1662
|
+
* @experimental (since 1.77)
|
|
1663
|
+
*
|
|
1643
1664
|
* @returns The host object associated with this card.
|
|
1644
1665
|
*/
|
|
1645
1666
|
getHostInstance(): sap.ui.integration.Host;
|
|
1646
1667
|
/**
|
|
1647
1668
|
* Overwrites getter for card manifest.
|
|
1648
1669
|
*
|
|
1670
|
+
*
|
|
1649
1671
|
* @returns Cloned of the parameters.
|
|
1650
1672
|
*/
|
|
1651
1673
|
getManifest(): string | Object;
|
|
1652
1674
|
/**
|
|
1653
|
-
* @since 1.76
|
|
1654
|
-
* @experimental (since 1.76) - This API might be removed when a permanent solution for flexibility changes
|
|
1655
|
-
* is implemented.
|
|
1656
|
-
*
|
|
1657
1675
|
* Gets current value of property {@link #getManifestChanges manifestChanges}.
|
|
1658
1676
|
*
|
|
1659
1677
|
* Defines a list of configuration settings, which will be merged into the original manifest.
|
|
@@ -1693,16 +1711,20 @@ declare namespace sap {
|
|
|
1693
1711
|
* ```
|
|
1694
1712
|
*
|
|
1695
1713
|
*
|
|
1714
|
+
* @since 1.76
|
|
1715
|
+
* @experimental (since 1.76) - This API might be removed when a permanent solution for flexibility changes
|
|
1716
|
+
* is implemented.
|
|
1717
|
+
*
|
|
1696
1718
|
* @returns Value of property `manifestChanges`
|
|
1697
1719
|
*/
|
|
1698
1720
|
getManifestChanges(): object[];
|
|
1699
1721
|
/**
|
|
1700
|
-
* @experimental (since 1.77)
|
|
1701
|
-
*
|
|
1702
1722
|
* Returns a value from the Manifest based on the specified path.
|
|
1703
1723
|
*
|
|
1704
1724
|
* **Note** Use this method when the manifest is ready. Check `manifestReady` event.
|
|
1705
1725
|
*
|
|
1726
|
+
* @experimental (since 1.77)
|
|
1727
|
+
*
|
|
1706
1728
|
* @returns The value at the specified path.
|
|
1707
1729
|
*/
|
|
1708
1730
|
getManifestEntry(
|
|
@@ -1712,9 +1734,6 @@ declare namespace sap {
|
|
|
1712
1734
|
sPath: string
|
|
1713
1735
|
): any;
|
|
1714
1736
|
/**
|
|
1715
|
-
* @since 1.112
|
|
1716
|
-
* @experimental (since 1.112)
|
|
1717
|
-
*
|
|
1718
1737
|
* Gets current value of property {@link #getPreviewMode previewMode}.
|
|
1719
1738
|
*
|
|
1720
1739
|
* Preview mode of the `Card`. Helpful in scenarios when the end user is choosing or configuring a card.
|
|
@@ -1726,6 +1745,9 @@ declare namespace sap {
|
|
|
1726
1745
|
*
|
|
1727
1746
|
* Default value is `Off`.
|
|
1728
1747
|
*
|
|
1748
|
+
* @since 1.112
|
|
1749
|
+
* @experimental (since 1.112)
|
|
1750
|
+
*
|
|
1729
1751
|
* @returns Value of property `previewMode`
|
|
1730
1752
|
*/
|
|
1731
1753
|
getPreviewMode(): sap.ui.integration.CardPreviewMode;
|
|
@@ -1737,16 +1759,17 @@ declare namespace sap {
|
|
|
1737
1759
|
*
|
|
1738
1760
|
* Default value is `empty string`.
|
|
1739
1761
|
*
|
|
1762
|
+
*
|
|
1740
1763
|
* @returns Value of property `referenceId`
|
|
1741
1764
|
*/
|
|
1742
1765
|
getReferenceId(): string;
|
|
1743
1766
|
/**
|
|
1744
|
-
* @experimental (since 1.83) - The API might change.
|
|
1745
|
-
*
|
|
1746
1767
|
* Gets translated text from the i18n properties files configured for this card.
|
|
1747
1768
|
*
|
|
1748
1769
|
* For more details see {@link module:sap/base/i18n/ResourceBundle#getText}.
|
|
1749
1770
|
*
|
|
1771
|
+
* @experimental (since 1.83) - The API might change.
|
|
1772
|
+
*
|
|
1750
1773
|
* @returns The value belonging to the key, if found; otherwise the key itself or `undefined` depending
|
|
1751
1774
|
* on `bIgnoreKeyFallback`.
|
|
1752
1775
|
*/
|
|
@@ -1769,9 +1792,9 @@ declare namespace sap {
|
|
|
1769
1792
|
bIgnoreKeyFallback?: boolean
|
|
1770
1793
|
): string;
|
|
1771
1794
|
/**
|
|
1772
|
-
* @experimental (since 1.114)
|
|
1773
|
-
*
|
|
1774
1795
|
* Hide the blocking message that is shown in the card by `showBlockingMessage` call.
|
|
1796
|
+
*
|
|
1797
|
+
* @experimental (since 1.114)
|
|
1775
1798
|
*/
|
|
1776
1799
|
hideBlockingMessage(): void;
|
|
1777
1800
|
/**
|
|
@@ -1785,19 +1808,19 @@ declare namespace sap {
|
|
|
1785
1808
|
eCardArea?: sap.ui.integration.CardArea
|
|
1786
1809
|
): void;
|
|
1787
1810
|
/**
|
|
1788
|
-
* @experimental (since 1.117)
|
|
1789
|
-
*
|
|
1790
1811
|
* Hides the message previously shown by showMessage.
|
|
1812
|
+
*
|
|
1813
|
+
* @experimental (since 1.117)
|
|
1791
1814
|
*/
|
|
1792
1815
|
hideMessage(): void;
|
|
1793
1816
|
/**
|
|
1817
|
+
* Checks for the provided `sap.ui.integration.ActionDefinition` in the aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
1818
|
+
* and returns its index if found or -1 otherwise.
|
|
1819
|
+
*
|
|
1794
1820
|
* @since 1.85
|
|
1795
1821
|
* @experimental (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
|
|
1796
1822
|
* may be done before its official public release. Use at your own discretion.
|
|
1797
1823
|
*
|
|
1798
|
-
* Checks for the provided `sap.ui.integration.ActionDefinition` in the aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
1799
|
-
* and returns its index if found or -1 otherwise.
|
|
1800
|
-
*
|
|
1801
1824
|
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
1802
1825
|
*/
|
|
1803
1826
|
indexOfActionDefinition(
|
|
@@ -1807,12 +1830,12 @@ declare namespace sap {
|
|
|
1807
1830
|
oActionDefinition: sap.ui.integration.ActionDefinition
|
|
1808
1831
|
): int;
|
|
1809
1832
|
/**
|
|
1833
|
+
* Inserts a actionDefinition into the aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
1834
|
+
*
|
|
1810
1835
|
* @since 1.85
|
|
1811
1836
|
* @experimental (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
|
|
1812
1837
|
* may be done before its official public release. Use at your own discretion.
|
|
1813
1838
|
*
|
|
1814
|
-
* Inserts a actionDefinition into the aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
1815
|
-
*
|
|
1816
1839
|
* @returns Reference to `this` in order to allow method chaining
|
|
1817
1840
|
*/
|
|
1818
1841
|
insertActionDefinition(
|
|
@@ -1830,13 +1853,10 @@ declare namespace sap {
|
|
|
1830
1853
|
/**
|
|
1831
1854
|
* @experimental (since 1.65) - The API might change.
|
|
1832
1855
|
*
|
|
1833
|
-
*
|
|
1834
1856
|
* @returns If the card is ready or not.
|
|
1835
1857
|
*/
|
|
1836
1858
|
isReady(): boolean;
|
|
1837
1859
|
/**
|
|
1838
|
-
* @experimental (since 1.73)
|
|
1839
|
-
*
|
|
1840
1860
|
* Loads the module designtime/Card.designtime or the module given in "sap.card": { "designtime": "designtime/Own.designtime"
|
|
1841
1861
|
* } This file should contain the designtime configuration for the card.
|
|
1842
1862
|
*
|
|
@@ -1844,28 +1864,30 @@ declare namespace sap {
|
|
|
1844
1864
|
* the complete manifest json } The promise is rejected if the module cannot be loaded with an object: {
|
|
1845
1865
|
* error: "Card.designtime not found" }
|
|
1846
1866
|
*
|
|
1867
|
+
* @experimental (since 1.73)
|
|
1868
|
+
*
|
|
1847
1869
|
* @returns Promise resolves after the designtime configuration is loaded.
|
|
1848
1870
|
*/
|
|
1849
1871
|
loadDesigntime(): Promise<object>;
|
|
1850
1872
|
/**
|
|
1851
|
-
* @experimental (since 1.65) - The API might change.
|
|
1852
|
-
*
|
|
1853
1873
|
* Refreshes the card by re-applying the manifest settings and triggering all data requests.
|
|
1874
|
+
*
|
|
1875
|
+
* @experimental (since 1.65) - The API might change.
|
|
1854
1876
|
*/
|
|
1855
1877
|
refresh(): void;
|
|
1856
1878
|
/**
|
|
1857
|
-
* @since 1.95
|
|
1858
|
-
*
|
|
1859
1879
|
* Refreshes the card data by triggering all data requests.
|
|
1880
|
+
*
|
|
1881
|
+
* @since 1.95
|
|
1860
1882
|
*/
|
|
1861
1883
|
refreshData(): void;
|
|
1862
1884
|
/**
|
|
1885
|
+
* Removes a actionDefinition from the aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
1886
|
+
*
|
|
1863
1887
|
* @since 1.85
|
|
1864
1888
|
* @experimental (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
|
|
1865
1889
|
* may be done before its official public release. Use at your own discretion.
|
|
1866
1890
|
*
|
|
1867
|
-
* Removes a actionDefinition from the aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
1868
|
-
*
|
|
1869
1891
|
* @returns The removed actionDefinition or `null`
|
|
1870
1892
|
*/
|
|
1871
1893
|
removeActionDefinition(
|
|
@@ -1878,22 +1900,22 @@ declare namespace sap {
|
|
|
1878
1900
|
| sap.ui.integration.ActionDefinition
|
|
1879
1901
|
): sap.ui.integration.ActionDefinition | null;
|
|
1880
1902
|
/**
|
|
1881
|
-
* @since 1.85
|
|
1882
|
-
* @experimental (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
|
|
1883
|
-
* may be done before its official public release. Use at your own discretion.
|
|
1884
|
-
*
|
|
1885
1903
|
* Removes all the controls from the aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
1886
1904
|
*
|
|
1887
1905
|
* Additionally, it unregisters them from the hosting UIArea.
|
|
1888
1906
|
*
|
|
1907
|
+
* @since 1.85
|
|
1908
|
+
* @experimental (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
|
|
1909
|
+
* may be done before its official public release. Use at your own discretion.
|
|
1910
|
+
*
|
|
1889
1911
|
* @returns An array of the removed elements (might be empty)
|
|
1890
1912
|
*/
|
|
1891
1913
|
removeAllActionDefinitions(): sap.ui.integration.ActionDefinition[];
|
|
1892
1914
|
/**
|
|
1893
|
-
* @experimental (since 1.79)
|
|
1894
|
-
*
|
|
1895
1915
|
* Performs an HTTP request using the given configuration.
|
|
1896
1916
|
*
|
|
1917
|
+
* @experimental (since 1.79)
|
|
1918
|
+
*
|
|
1897
1919
|
* @returns Resolves when the request is successful, rejects otherwise.
|
|
1898
1920
|
*/
|
|
1899
1921
|
request(
|
|
@@ -1935,6 +1957,7 @@ declare namespace sap {
|
|
|
1935
1957
|
/**
|
|
1936
1958
|
* Resolves the destination and returns its URL.
|
|
1937
1959
|
*
|
|
1960
|
+
*
|
|
1938
1961
|
* @returns A promise which resolves with the URL of the destination.
|
|
1939
1962
|
*/
|
|
1940
1963
|
resolveDestination(
|
|
@@ -1944,9 +1967,6 @@ declare namespace sap {
|
|
|
1944
1967
|
sKey: string
|
|
1945
1968
|
): Promise<string>;
|
|
1946
1969
|
/**
|
|
1947
|
-
* @since 1.70
|
|
1948
|
-
* @experimental (since 1.70)
|
|
1949
|
-
*
|
|
1950
1970
|
* Sets a new value for property {@link #getBaseUrl baseUrl}.
|
|
1951
1971
|
*
|
|
1952
1972
|
* Defines the base URL of the card manifest. It should be used when manifest property is an object instead
|
|
@@ -1954,6 +1974,9 @@ declare namespace sap {
|
|
|
1954
1974
|
*
|
|
1955
1975
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1956
1976
|
*
|
|
1977
|
+
* @since 1.70
|
|
1978
|
+
* @experimental (since 1.70)
|
|
1979
|
+
*
|
|
1957
1980
|
* @returns Reference to `this` in order to allow method chaining
|
|
1958
1981
|
*/
|
|
1959
1982
|
setBaseUrl(
|
|
@@ -1963,11 +1986,11 @@ declare namespace sap {
|
|
|
1963
1986
|
sBaseUrl?: sap.ui.core.URI
|
|
1964
1987
|
): this;
|
|
1965
1988
|
/**
|
|
1989
|
+
* Sets a new value for the `dataMode` property.
|
|
1990
|
+
*
|
|
1966
1991
|
* @since 1.65
|
|
1967
1992
|
* @experimental (since 1.65) - API might change.
|
|
1968
1993
|
*
|
|
1969
|
-
* Sets a new value for the `dataMode` property.
|
|
1970
|
-
*
|
|
1971
1994
|
* @returns Pointer to the control instance to allow method chaining.
|
|
1972
1995
|
*/
|
|
1973
1996
|
setDataMode(
|
|
@@ -1977,9 +2000,6 @@ declare namespace sap {
|
|
|
1977
2000
|
sMode: sap.ui.integration.CardDataMode
|
|
1978
2001
|
): this;
|
|
1979
2002
|
/**
|
|
1980
|
-
* @since 1.109
|
|
1981
|
-
* @experimental (since 1.109)
|
|
1982
|
-
*
|
|
1983
2003
|
* Sets a new value for property {@link #getDesign design}.
|
|
1984
2004
|
*
|
|
1985
2005
|
* Defines the design of the `Card`.
|
|
@@ -1988,6 +2008,9 @@ declare namespace sap {
|
|
|
1988
2008
|
*
|
|
1989
2009
|
* Default value is `Solid`.
|
|
1990
2010
|
*
|
|
2011
|
+
* @since 1.109
|
|
2012
|
+
* @experimental (since 1.109)
|
|
2013
|
+
*
|
|
1991
2014
|
* @returns Reference to `this` in order to allow method chaining
|
|
1992
2015
|
*/
|
|
1993
2016
|
setDesign(
|
|
@@ -1997,9 +2020,6 @@ declare namespace sap {
|
|
|
1997
2020
|
sDesign?: sap.ui.integration.CardDesign
|
|
1998
2021
|
): this;
|
|
1999
2022
|
/**
|
|
2000
|
-
* @since 1.118
|
|
2001
|
-
* @experimental (since 1.118) - For usage only by Work Zone.
|
|
2002
|
-
*
|
|
2003
2023
|
* Sets a new value for property {@link #getDisplayVariant displayVariant}.
|
|
2004
2024
|
*
|
|
2005
2025
|
* Defines the display variant for card rendering and behavior.
|
|
@@ -2008,6 +2028,9 @@ declare namespace sap {
|
|
|
2008
2028
|
*
|
|
2009
2029
|
* Default value is `Standard`.
|
|
2010
2030
|
*
|
|
2031
|
+
* @since 1.118
|
|
2032
|
+
* @experimental (since 1.118) - For usage only by Work Zone.
|
|
2033
|
+
*
|
|
2011
2034
|
* @returns Reference to `this` in order to allow method chaining
|
|
2012
2035
|
*/
|
|
2013
2036
|
setDisplayVariant(
|
|
@@ -2019,6 +2042,7 @@ declare namespace sap {
|
|
|
2019
2042
|
/**
|
|
2020
2043
|
* Sets the associated {@link #getHost host}.
|
|
2021
2044
|
*
|
|
2045
|
+
*
|
|
2022
2046
|
* @returns Reference to `this` in order to allow method chaining
|
|
2023
2047
|
*/
|
|
2024
2048
|
setHost(
|
|
@@ -2037,6 +2061,7 @@ declare namespace sap {
|
|
|
2037
2061
|
*
|
|
2038
2062
|
* Default value is `empty string`.
|
|
2039
2063
|
*
|
|
2064
|
+
*
|
|
2040
2065
|
* @returns Reference to `this` in order to allow method chaining
|
|
2041
2066
|
*/
|
|
2042
2067
|
setManifest(
|
|
@@ -2046,10 +2071,6 @@ declare namespace sap {
|
|
|
2046
2071
|
oManifest?: any
|
|
2047
2072
|
): this;
|
|
2048
2073
|
/**
|
|
2049
|
-
* @since 1.76
|
|
2050
|
-
* @experimental (since 1.76) - This API might be removed when a permanent solution for flexibility changes
|
|
2051
|
-
* is implemented.
|
|
2052
|
-
*
|
|
2053
2074
|
* Sets a new value for property {@link #getManifestChanges manifestChanges}.
|
|
2054
2075
|
*
|
|
2055
2076
|
* Defines a list of configuration settings, which will be merged into the original manifest.
|
|
@@ -2091,6 +2112,10 @@ declare namespace sap {
|
|
|
2091
2112
|
*
|
|
2092
2113
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2093
2114
|
*
|
|
2115
|
+
* @since 1.76
|
|
2116
|
+
* @experimental (since 1.76) - This API might be removed when a permanent solution for flexibility changes
|
|
2117
|
+
* is implemented.
|
|
2118
|
+
*
|
|
2094
2119
|
* @returns Reference to `this` in order to allow method chaining
|
|
2095
2120
|
*/
|
|
2096
2121
|
setManifestChanges(
|
|
@@ -2100,9 +2125,6 @@ declare namespace sap {
|
|
|
2100
2125
|
sManifestChanges: object[]
|
|
2101
2126
|
): this;
|
|
2102
2127
|
/**
|
|
2103
|
-
* @since 1.112
|
|
2104
|
-
* @experimental (since 1.112)
|
|
2105
|
-
*
|
|
2106
2128
|
* Sets a new value for property {@link #getPreviewMode previewMode}.
|
|
2107
2129
|
*
|
|
2108
2130
|
* Preview mode of the `Card`. Helpful in scenarios when the end user is choosing or configuring a card.
|
|
@@ -2116,6 +2138,9 @@ declare namespace sap {
|
|
|
2116
2138
|
*
|
|
2117
2139
|
* Default value is `Off`.
|
|
2118
2140
|
*
|
|
2141
|
+
* @since 1.112
|
|
2142
|
+
* @experimental (since 1.112)
|
|
2143
|
+
*
|
|
2119
2144
|
* @returns Reference to `this` in order to allow method chaining
|
|
2120
2145
|
*/
|
|
2121
2146
|
setPreviewMode(
|
|
@@ -2134,6 +2159,7 @@ declare namespace sap {
|
|
|
2134
2159
|
*
|
|
2135
2160
|
* Default value is `empty string`.
|
|
2136
2161
|
*
|
|
2162
|
+
*
|
|
2137
2163
|
* @returns Reference to `this` in order to allow method chaining
|
|
2138
2164
|
*/
|
|
2139
2165
|
setReferenceId(
|
|
@@ -2143,10 +2169,10 @@ declare namespace sap {
|
|
|
2143
2169
|
sReferenceId?: string
|
|
2144
2170
|
): this;
|
|
2145
2171
|
/**
|
|
2146
|
-
* @experimental (since 1.114)
|
|
2147
|
-
*
|
|
2148
2172
|
* Show blocking message in the card's content area. Should be used after the `manifestApplied` event or
|
|
2149
2173
|
* after the `cardReady` lifecycle hook in Component cards and Extensions.
|
|
2174
|
+
*
|
|
2175
|
+
* @experimental (since 1.114)
|
|
2150
2176
|
*/
|
|
2151
2177
|
showBlockingMessage(
|
|
2152
2178
|
/**
|
|
@@ -2166,11 +2192,11 @@ declare namespace sap {
|
|
|
2166
2192
|
eCardArea?: sap.ui.integration.CardArea
|
|
2167
2193
|
): void;
|
|
2168
2194
|
/**
|
|
2169
|
-
* @experimental (since 1.81)
|
|
2170
|
-
*
|
|
2171
2195
|
* Displays a message strip above the content with the given text. There can be only 1 message displayed.
|
|
2172
2196
|
* If there is a previous message, it is removed. Can be used only after the `manifestApplied` event is
|
|
2173
2197
|
* fired.
|
|
2198
|
+
*
|
|
2199
|
+
* @experimental (since 1.81)
|
|
2174
2200
|
*/
|
|
2175
2201
|
showMessage(
|
|
2176
2202
|
/**
|
|
@@ -2183,8 +2209,6 @@ declare namespace sap {
|
|
|
2183
2209
|
sType: sap.ui.core.MessageType
|
|
2184
2210
|
): void;
|
|
2185
2211
|
/**
|
|
2186
|
-
* @experimental (since 1.84)
|
|
2187
|
-
*
|
|
2188
2212
|
* Triggers an action inside the card.
|
|
2189
2213
|
*
|
|
2190
2214
|
* Use this method if you need to trigger an action programmatically from inside an `Extension` or from
|
|
@@ -2203,6 +2227,9 @@ declare namespace sap {
|
|
|
2203
2227
|
* }
|
|
2204
2228
|
* });
|
|
2205
2229
|
* ```
|
|
2230
|
+
*
|
|
2231
|
+
*
|
|
2232
|
+
* @experimental (since 1.84)
|
|
2206
2233
|
*/
|
|
2207
2234
|
triggerAction(
|
|
2208
2235
|
/**
|
|
@@ -2220,10 +2247,10 @@ declare namespace sap {
|
|
|
2220
2247
|
}
|
|
2221
2248
|
): void;
|
|
2222
2249
|
/**
|
|
2223
|
-
* @experimental
|
|
2224
|
-
*
|
|
2225
2250
|
* Causes all of the controls within the Card that support validation to validate their data.
|
|
2226
2251
|
*
|
|
2252
|
+
* @experimental
|
|
2253
|
+
*
|
|
2227
2254
|
* @returns if all of the controls validated successfully; otherwise, false
|
|
2228
2255
|
*/
|
|
2229
2256
|
validateControls(): boolean;
|
|
@@ -2321,11 +2348,11 @@ declare namespace sap {
|
|
|
2321
2348
|
|
|
2322
2349
|
interface $ExtensionSettings extends sap.ui.base.$ManagedObjectSettings {
|
|
2323
2350
|
/**
|
|
2351
|
+
* The actions configuration.
|
|
2352
|
+
*
|
|
2324
2353
|
* @deprecated (since 1.85) - This property is replaced by the `actions` aggregation of the card;
|
|
2325
2354
|
* @experimental (since 1.75) - Disclaimer: this property is in a beta state - incompatible API changes
|
|
2326
2355
|
* may be done before its official public release. Use at your own discretion.
|
|
2327
|
-
*
|
|
2328
|
-
* The actions configuration.
|
|
2329
2356
|
*/
|
|
2330
2357
|
actions?:
|
|
2331
2358
|
| sap.ui.integration.CardMenuAction[]
|
|
@@ -2333,9 +2360,9 @@ declare namespace sap {
|
|
|
2333
2360
|
| `{${string}}`;
|
|
2334
2361
|
|
|
2335
2362
|
/**
|
|
2336
|
-
* @experimental (since 1.79)
|
|
2337
|
-
*
|
|
2338
2363
|
* The formatters that can be used in the manifest.
|
|
2364
|
+
*
|
|
2365
|
+
* @experimental (since 1.79)
|
|
2339
2366
|
*/
|
|
2340
2367
|
formatters?:
|
|
2341
2368
|
| object
|
|
@@ -2343,24 +2370,24 @@ declare namespace sap {
|
|
|
2343
2370
|
| `{${string}}`;
|
|
2344
2371
|
|
|
2345
2372
|
/**
|
|
2346
|
-
* @experimental (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
2347
|
-
* be done before its official public release. Use at your own discretion.
|
|
2348
|
-
*
|
|
2349
2373
|
* Fired when an action is triggered in the card.
|
|
2350
2374
|
*
|
|
2351
2375
|
* When an action is triggered in the card it can be handled on several places by "action" event handlers.
|
|
2352
2376
|
* In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
|
|
2353
2377
|
* one to handle the action by calling `oEvent.preventDefault()`.
|
|
2378
|
+
*
|
|
2379
|
+
* @experimental (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
2380
|
+
* be done before its official public release. Use at your own discretion.
|
|
2354
2381
|
*/
|
|
2355
2382
|
action?: (oEvent: Extension$ActionEvent) => void;
|
|
2356
2383
|
}
|
|
2357
2384
|
|
|
2358
2385
|
interface $HostSettings extends sap.ui.core.$ElementSettings {
|
|
2359
2386
|
/**
|
|
2387
|
+
* The actions configuration.
|
|
2388
|
+
*
|
|
2360
2389
|
* @experimental (since 1.75) - Disclaimer: this property is in a beta state - incompatible API changes
|
|
2361
2390
|
* may be done before its official public release. Use at your own discretion.
|
|
2362
|
-
*
|
|
2363
|
-
* The actions configuration.
|
|
2364
2391
|
*/
|
|
2365
2392
|
actions?:
|
|
2366
2393
|
| sap.ui.integration.CardMenuAction[]
|
|
@@ -2384,47 +2411,47 @@ declare namespace sap {
|
|
|
2384
2411
|
| `{${string}}`;
|
|
2385
2412
|
|
|
2386
2413
|
/**
|
|
2387
|
-
* @experimental (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
2388
|
-
* be done before its official public release. Use at your own discretion.
|
|
2389
|
-
*
|
|
2390
2414
|
* Fired when an action is triggered.
|
|
2391
2415
|
*
|
|
2392
2416
|
* When an action is triggered in the card it can be handled on several places by "action" event handlers.
|
|
2393
2417
|
* In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
|
|
2394
2418
|
* one to handle the action by calling `oEvent.preventDefault()`.
|
|
2419
|
+
*
|
|
2420
|
+
* @experimental (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
2421
|
+
* be done before its official public release. Use at your own discretion.
|
|
2395
2422
|
*/
|
|
2396
2423
|
action?: (oEvent: Host$ActionEvent) => void;
|
|
2397
2424
|
|
|
2398
2425
|
/**
|
|
2399
|
-
* @experimental (since 1.96)
|
|
2400
|
-
*
|
|
2401
2426
|
* Fired when some card configuration settings are changed as a result of user interaction. For example
|
|
2402
2427
|
* - filter value is changed.
|
|
2428
|
+
*
|
|
2429
|
+
* @experimental (since 1.96)
|
|
2403
2430
|
*/
|
|
2404
2431
|
cardConfigurationChange?: (
|
|
2405
2432
|
oEvent: Host$CardConfigurationChangeEvent
|
|
2406
2433
|
) => void;
|
|
2407
2434
|
|
|
2408
2435
|
/**
|
|
2409
|
-
* @experimental (since 1.107)
|
|
2410
|
-
*
|
|
2411
2436
|
* Fired when the state of a card is changed. For example - the card is ready, new page is selected inside
|
|
2412
2437
|
* the card, a filter is changed or data is refreshed.
|
|
2438
|
+
*
|
|
2439
|
+
* @experimental (since 1.107)
|
|
2413
2440
|
*/
|
|
2414
2441
|
cardStateChanged?: (oEvent: Host$CardStateChangedEvent) => void;
|
|
2415
2442
|
|
|
2416
2443
|
/**
|
|
2417
|
-
* @experimental (since 1.116)
|
|
2418
|
-
*
|
|
2419
2444
|
* Fired when the card is initially ready for the first time. Will not be fired for consecutive refreshes
|
|
2420
2445
|
* or data changes.
|
|
2446
|
+
*
|
|
2447
|
+
* @experimental (since 1.116)
|
|
2421
2448
|
*/
|
|
2422
2449
|
cardInitialized?: (oEvent: Host$CardInitializedEvent) => void;
|
|
2423
2450
|
|
|
2424
2451
|
/**
|
|
2425
|
-
* @experimental (since 1.91)
|
|
2426
|
-
*
|
|
2427
2452
|
* Fired when a message from channels like navigator.serviceWorker is received.
|
|
2453
|
+
*
|
|
2454
|
+
* @experimental (since 1.91)
|
|
2428
2455
|
*/
|
|
2429
2456
|
message?: (oEvent: Host$MessageEvent) => void;
|
|
2430
2457
|
}
|
|
@@ -2525,12 +2552,12 @@ declare namespace sap {
|
|
|
2525
2552
|
}
|
|
2526
2553
|
|
|
2527
2554
|
/**
|
|
2555
|
+
* Represents an action, which appears in the header of {@link sap.ui.integration.widgets.Card}. Useful
|
|
2556
|
+
* in `Component` card and `Extension`.
|
|
2557
|
+
*
|
|
2528
2558
|
* @since 1.85
|
|
2529
2559
|
* @experimental (since 1.85) - Disclaimer: this class is in a beta state - incompatible API changes may
|
|
2530
2560
|
* be done before its official public release. Use at your own discretion.
|
|
2531
|
-
*
|
|
2532
|
-
* Represents an action, which appears in the header of {@link sap.ui.integration.widgets.Card}. Useful
|
|
2533
|
-
* in `Component` card and `Extension`.
|
|
2534
2561
|
*/
|
|
2535
2562
|
class ActionDefinition extends sap.ui.core.Element {
|
|
2536
2563
|
/**
|
|
@@ -2570,6 +2597,7 @@ declare namespace sap {
|
|
|
2570
2597
|
*
|
|
2571
2598
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
|
|
2572
2599
|
*
|
|
2600
|
+
*
|
|
2573
2601
|
* @returns Created class / constructor function
|
|
2574
2602
|
*/
|
|
2575
2603
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -2590,6 +2618,7 @@ declare namespace sap {
|
|
|
2590
2618
|
/**
|
|
2591
2619
|
* Returns a metadata object for class sap.ui.integration.ActionDefinition.
|
|
2592
2620
|
*
|
|
2621
|
+
*
|
|
2593
2622
|
* @returns Metadata object describing this class
|
|
2594
2623
|
*/
|
|
2595
2624
|
static getMetadata(): sap.ui.core.ElementMetadata;
|
|
@@ -2601,6 +2630,7 @@ declare namespace sap {
|
|
|
2601
2630
|
*
|
|
2602
2631
|
* Fired when the action button is pressed.
|
|
2603
2632
|
*
|
|
2633
|
+
*
|
|
2604
2634
|
* @returns Reference to `this` in order to allow method chaining
|
|
2605
2635
|
*/
|
|
2606
2636
|
attachPress(
|
|
@@ -2627,6 +2657,7 @@ declare namespace sap {
|
|
|
2627
2657
|
*
|
|
2628
2658
|
* Fired when the action button is pressed.
|
|
2629
2659
|
*
|
|
2660
|
+
*
|
|
2630
2661
|
* @returns Reference to `this` in order to allow method chaining
|
|
2631
2662
|
*/
|
|
2632
2663
|
attachPress(
|
|
@@ -2645,6 +2676,7 @@ declare namespace sap {
|
|
|
2645
2676
|
*
|
|
2646
2677
|
* The passed function and listener object must match the ones used for event registration.
|
|
2647
2678
|
*
|
|
2679
|
+
*
|
|
2648
2680
|
* @returns Reference to `this` in order to allow method chaining
|
|
2649
2681
|
*/
|
|
2650
2682
|
detachPress(
|
|
@@ -2658,10 +2690,10 @@ declare namespace sap {
|
|
|
2658
2690
|
oListener?: object
|
|
2659
2691
|
): this;
|
|
2660
2692
|
/**
|
|
2661
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
2662
|
-
*
|
|
2663
2693
|
* Fires event {@link #event:press press} to attached listeners.
|
|
2664
2694
|
*
|
|
2695
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
2696
|
+
*
|
|
2665
2697
|
* @returns Reference to `this` in order to allow method chaining
|
|
2666
2698
|
*/
|
|
2667
2699
|
firePress(
|
|
@@ -2677,6 +2709,7 @@ declare namespace sap {
|
|
|
2677
2709
|
*
|
|
2678
2710
|
* Default value is `Transparent`.
|
|
2679
2711
|
*
|
|
2712
|
+
*
|
|
2680
2713
|
* @returns Value of property `buttonType`
|
|
2681
2714
|
*/
|
|
2682
2715
|
getButtonType(): sap.m.ButtonType;
|
|
@@ -2688,6 +2721,7 @@ declare namespace sap {
|
|
|
2688
2721
|
*
|
|
2689
2722
|
* Default value is `true`.
|
|
2690
2723
|
*
|
|
2724
|
+
*
|
|
2691
2725
|
* @returns Value of property `enabled`
|
|
2692
2726
|
*/
|
|
2693
2727
|
getEnabled(): boolean;
|
|
@@ -2696,6 +2730,7 @@ declare namespace sap {
|
|
|
2696
2730
|
*
|
|
2697
2731
|
* The icon of the action button.
|
|
2698
2732
|
*
|
|
2733
|
+
*
|
|
2699
2734
|
* @returns Value of property `icon`
|
|
2700
2735
|
*/
|
|
2701
2736
|
getIcon(): sap.ui.core.URI;
|
|
@@ -2704,6 +2739,7 @@ declare namespace sap {
|
|
|
2704
2739
|
*
|
|
2705
2740
|
* The parameters of the action.
|
|
2706
2741
|
*
|
|
2742
|
+
*
|
|
2707
2743
|
* @returns Value of property `parameters`
|
|
2708
2744
|
*/
|
|
2709
2745
|
getParameters(): object;
|
|
@@ -2714,6 +2750,7 @@ declare namespace sap {
|
|
|
2714
2750
|
*
|
|
2715
2751
|
* Default value is `empty string`.
|
|
2716
2752
|
*
|
|
2753
|
+
*
|
|
2717
2754
|
* @returns Value of property `text`
|
|
2718
2755
|
*/
|
|
2719
2756
|
getText(): string;
|
|
@@ -2722,6 +2759,7 @@ declare namespace sap {
|
|
|
2722
2759
|
*
|
|
2723
2760
|
* The type of the action.
|
|
2724
2761
|
*
|
|
2762
|
+
*
|
|
2725
2763
|
* @returns Value of property `type`
|
|
2726
2764
|
*/
|
|
2727
2765
|
getType(): sap.ui.integration.CardActionType;
|
|
@@ -2732,6 +2770,7 @@ declare namespace sap {
|
|
|
2732
2770
|
*
|
|
2733
2771
|
* Default value is `true`.
|
|
2734
2772
|
*
|
|
2773
|
+
*
|
|
2735
2774
|
* @returns Value of property `visible`
|
|
2736
2775
|
*/
|
|
2737
2776
|
getVisible(): boolean;
|
|
@@ -2744,6 +2783,7 @@ declare namespace sap {
|
|
|
2744
2783
|
*
|
|
2745
2784
|
* Default value is `Transparent`.
|
|
2746
2785
|
*
|
|
2786
|
+
*
|
|
2747
2787
|
* @returns Reference to `this` in order to allow method chaining
|
|
2748
2788
|
*/
|
|
2749
2789
|
setButtonType(
|
|
@@ -2762,6 +2802,7 @@ declare namespace sap {
|
|
|
2762
2802
|
*
|
|
2763
2803
|
* Default value is `true`.
|
|
2764
2804
|
*
|
|
2805
|
+
*
|
|
2765
2806
|
* @returns Reference to `this` in order to allow method chaining
|
|
2766
2807
|
*/
|
|
2767
2808
|
setEnabled(
|
|
@@ -2777,6 +2818,7 @@ declare namespace sap {
|
|
|
2777
2818
|
*
|
|
2778
2819
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2779
2820
|
*
|
|
2821
|
+
*
|
|
2780
2822
|
* @returns Reference to `this` in order to allow method chaining
|
|
2781
2823
|
*/
|
|
2782
2824
|
setIcon(
|
|
@@ -2792,6 +2834,7 @@ declare namespace sap {
|
|
|
2792
2834
|
*
|
|
2793
2835
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2794
2836
|
*
|
|
2837
|
+
*
|
|
2795
2838
|
* @returns Reference to `this` in order to allow method chaining
|
|
2796
2839
|
*/
|
|
2797
2840
|
setParameters(
|
|
@@ -2809,6 +2852,7 @@ declare namespace sap {
|
|
|
2809
2852
|
*
|
|
2810
2853
|
* Default value is `empty string`.
|
|
2811
2854
|
*
|
|
2855
|
+
*
|
|
2812
2856
|
* @returns Reference to `this` in order to allow method chaining
|
|
2813
2857
|
*/
|
|
2814
2858
|
setText(
|
|
@@ -2824,6 +2868,7 @@ declare namespace sap {
|
|
|
2824
2868
|
*
|
|
2825
2869
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2826
2870
|
*
|
|
2871
|
+
*
|
|
2827
2872
|
* @returns Reference to `this` in order to allow method chaining
|
|
2828
2873
|
*/
|
|
2829
2874
|
setType(
|
|
@@ -2841,6 +2886,7 @@ declare namespace sap {
|
|
|
2841
2886
|
*
|
|
2842
2887
|
* Default value is `true`.
|
|
2843
2888
|
*
|
|
2889
|
+
*
|
|
2844
2890
|
* @returns Reference to `this` in order to allow method chaining
|
|
2845
2891
|
*/
|
|
2846
2892
|
setVisible(
|
|
@@ -2851,11 +2897,11 @@ declare namespace sap {
|
|
|
2851
2897
|
): this;
|
|
2852
2898
|
}
|
|
2853
2899
|
/**
|
|
2854
|
-
* @since 1.75
|
|
2855
|
-
* @experimental (since 1.75)
|
|
2856
|
-
*
|
|
2857
2900
|
* Brings JavaScript capabilities for an {@link sap.ui.integration.widgets.Card} where custom logic can
|
|
2858
2901
|
* be implemented.
|
|
2902
|
+
*
|
|
2903
|
+
* @since 1.75
|
|
2904
|
+
* @experimental (since 1.75)
|
|
2859
2905
|
*/
|
|
2860
2906
|
class Designtime extends sap.ui.base.ManagedObject {
|
|
2861
2907
|
/**
|
|
@@ -2901,6 +2947,7 @@ declare namespace sap {
|
|
|
2901
2947
|
*
|
|
2902
2948
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.ManagedObject.extend}.
|
|
2903
2949
|
*
|
|
2950
|
+
*
|
|
2904
2951
|
* @returns Created class / constructor function
|
|
2905
2952
|
*/
|
|
2906
2953
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -2921,21 +2968,23 @@ declare namespace sap {
|
|
|
2921
2968
|
/**
|
|
2922
2969
|
* Returns a metadata object for class sap.ui.integration.Designtime.
|
|
2923
2970
|
*
|
|
2971
|
+
*
|
|
2924
2972
|
* @returns Metadata object describing this class
|
|
2925
2973
|
*/
|
|
2926
2974
|
static getMetadata(): sap.ui.base.ManagedObjectMetadata;
|
|
2927
2975
|
/**
|
|
2928
2976
|
* Returns an interface to the card, which uses this extension.
|
|
2929
2977
|
*
|
|
2978
|
+
*
|
|
2930
2979
|
* @returns An interface to the card.
|
|
2931
2980
|
*/
|
|
2932
2981
|
getCard(): sap.ui.integration.widgets.CardFacade;
|
|
2933
2982
|
}
|
|
2934
2983
|
/**
|
|
2935
|
-
* @since 1.75
|
|
2936
|
-
*
|
|
2937
2984
|
* Brings JavaScript capabilities for an {@link sap.ui.integration.widgets.Card} where custom logic can
|
|
2938
2985
|
* be implemented.
|
|
2986
|
+
*
|
|
2987
|
+
* @since 1.75
|
|
2939
2988
|
*/
|
|
2940
2989
|
class Extension extends sap.ui.base.ManagedObject {
|
|
2941
2990
|
/**
|
|
@@ -2975,6 +3024,7 @@ declare namespace sap {
|
|
|
2975
3024
|
*
|
|
2976
3025
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.ManagedObject.extend}.
|
|
2977
3026
|
*
|
|
3027
|
+
*
|
|
2978
3028
|
* @returns Created class / constructor function
|
|
2979
3029
|
*/
|
|
2980
3030
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -2995,13 +3045,11 @@ declare namespace sap {
|
|
|
2995
3045
|
/**
|
|
2996
3046
|
* Returns a metadata object for class sap.ui.integration.Extension.
|
|
2997
3047
|
*
|
|
3048
|
+
*
|
|
2998
3049
|
* @returns Metadata object describing this class
|
|
2999
3050
|
*/
|
|
3000
3051
|
static getMetadata(): sap.ui.base.ManagedObjectMetadata;
|
|
3001
3052
|
/**
|
|
3002
|
-
* @experimental (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
3003
|
-
* be done before its official public release. Use at your own discretion.
|
|
3004
|
-
*
|
|
3005
3053
|
* Attaches event handler `fnFunction` to the {@link #event:action action} event of this `sap.ui.integration.Extension`.
|
|
3006
3054
|
*
|
|
3007
3055
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
@@ -3013,6 +3061,9 @@ declare namespace sap {
|
|
|
3013
3061
|
* In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
|
|
3014
3062
|
* one to handle the action by calling `oEvent.preventDefault()`.
|
|
3015
3063
|
*
|
|
3064
|
+
* @experimental (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
3065
|
+
* be done before its official public release. Use at your own discretion.
|
|
3066
|
+
*
|
|
3016
3067
|
* @returns Reference to `this` in order to allow method chaining
|
|
3017
3068
|
*/
|
|
3018
3069
|
attachAction(
|
|
@@ -3031,9 +3082,6 @@ declare namespace sap {
|
|
|
3031
3082
|
oListener?: object
|
|
3032
3083
|
): this;
|
|
3033
3084
|
/**
|
|
3034
|
-
* @experimental (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
3035
|
-
* be done before its official public release. Use at your own discretion.
|
|
3036
|
-
*
|
|
3037
3085
|
* Attaches event handler `fnFunction` to the {@link #event:action action} event of this `sap.ui.integration.Extension`.
|
|
3038
3086
|
*
|
|
3039
3087
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
@@ -3045,6 +3093,9 @@ declare namespace sap {
|
|
|
3045
3093
|
* In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
|
|
3046
3094
|
* one to handle the action by calling `oEvent.preventDefault()`.
|
|
3047
3095
|
*
|
|
3096
|
+
* @experimental (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
3097
|
+
* be done before its official public release. Use at your own discretion.
|
|
3098
|
+
*
|
|
3048
3099
|
* @returns Reference to `this` in order to allow method chaining
|
|
3049
3100
|
*/
|
|
3050
3101
|
attachAction(
|
|
@@ -3058,13 +3109,13 @@ declare namespace sap {
|
|
|
3058
3109
|
oListener?: object
|
|
3059
3110
|
): this;
|
|
3060
3111
|
/**
|
|
3061
|
-
* @experimental (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
3062
|
-
* be done before its official public release. Use at your own discretion.
|
|
3063
|
-
*
|
|
3064
3112
|
* Detaches event handler `fnFunction` from the {@link #event:action action} event of this `sap.ui.integration.Extension`.
|
|
3065
3113
|
*
|
|
3066
3114
|
* The passed function and listener object must match the ones used for event registration.
|
|
3067
3115
|
*
|
|
3116
|
+
* @experimental (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
3117
|
+
* be done before its official public release. Use at your own discretion.
|
|
3118
|
+
*
|
|
3068
3119
|
* @returns Reference to `this` in order to allow method chaining
|
|
3069
3120
|
*/
|
|
3070
3121
|
detachAction(
|
|
@@ -3078,12 +3129,12 @@ declare namespace sap {
|
|
|
3078
3129
|
oListener?: object
|
|
3079
3130
|
): this;
|
|
3080
3131
|
/**
|
|
3081
|
-
* @experimental (since 1.113) - The API might change.
|
|
3082
|
-
*
|
|
3083
3132
|
* Starts the process of fetching a resource from the network, returning a promise that is fulfilled once
|
|
3084
3133
|
* the response is available. Use this method to override the default behavior when fetching network resources.
|
|
3085
3134
|
* Mimics the browser native Fetch API.
|
|
3086
3135
|
*
|
|
3136
|
+
* @experimental (since 1.113) - The API might change.
|
|
3137
|
+
*
|
|
3087
3138
|
* @returns A `Promise` that resolves to a `Response` object.
|
|
3088
3139
|
*/
|
|
3089
3140
|
fetch(
|
|
@@ -3102,15 +3153,15 @@ declare namespace sap {
|
|
|
3102
3153
|
mRequestSettings: object
|
|
3103
3154
|
): Promise<Response>;
|
|
3104
3155
|
/**
|
|
3105
|
-
* @experimental (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
3106
|
-
* be done before its official public release. Use at your own discretion.
|
|
3107
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
3108
|
-
*
|
|
3109
3156
|
* Fires event {@link #event:action action} to attached listeners.
|
|
3110
3157
|
*
|
|
3111
3158
|
* Listeners may prevent the default action of this event by calling the `preventDefault` method on the
|
|
3112
3159
|
* event object. The return value of this method indicates whether the default action should be executed.
|
|
3113
3160
|
*
|
|
3161
|
+
* @experimental (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
3162
|
+
* be done before its official public release. Use at your own discretion.
|
|
3163
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
3164
|
+
*
|
|
3114
3165
|
* @returns Whether or not to prevent the default action
|
|
3115
3166
|
*/
|
|
3116
3167
|
fireAction(
|
|
@@ -3120,20 +3171,21 @@ declare namespace sap {
|
|
|
3120
3171
|
mParameters?: sap.ui.integration.Extension$ActionEventParameters
|
|
3121
3172
|
): boolean;
|
|
3122
3173
|
/**
|
|
3123
|
-
* @deprecated (since 1.85) - This property is replaced by the `actions` aggregation of the card;
|
|
3124
|
-
* @experimental (since 1.75) - Disclaimer: this property is in a beta state - incompatible API changes
|
|
3125
|
-
* may be done before its official public release. Use at your own discretion.
|
|
3126
|
-
*
|
|
3127
3174
|
* Gets current value of property {@link #getActions actions}.
|
|
3128
3175
|
*
|
|
3129
3176
|
* The actions configuration.
|
|
3130
3177
|
*
|
|
3178
|
+
* @deprecated (since 1.85) - This property is replaced by the `actions` aggregation of the card;
|
|
3179
|
+
* @experimental (since 1.75) - Disclaimer: this property is in a beta state - incompatible API changes
|
|
3180
|
+
* may be done before its official public release. Use at your own discretion.
|
|
3181
|
+
*
|
|
3131
3182
|
* @returns Value of property `actions`
|
|
3132
3183
|
*/
|
|
3133
3184
|
getActions(): sap.ui.integration.CardMenuAction[];
|
|
3134
3185
|
/**
|
|
3135
3186
|
* Returns an interface to the card, which uses this extension.
|
|
3136
3187
|
*
|
|
3188
|
+
*
|
|
3137
3189
|
* @returns An interface to the card.
|
|
3138
3190
|
*/
|
|
3139
3191
|
getCard(): sap.ui.integration.widgets.CardFacade;
|
|
@@ -3142,14 +3194,15 @@ declare namespace sap {
|
|
|
3142
3194
|
*
|
|
3143
3195
|
* The formatters that can be used in the manifest.
|
|
3144
3196
|
*
|
|
3197
|
+
*
|
|
3145
3198
|
* @returns Value of property `formatters`
|
|
3146
3199
|
*/
|
|
3147
3200
|
getFormatters(): Record<string, () => void> | undefined;
|
|
3148
3201
|
/**
|
|
3149
|
-
* @experimental (since 1.108)
|
|
3150
|
-
*
|
|
3151
3202
|
* Override this method to lazy load dependencies for the extension.
|
|
3152
3203
|
*
|
|
3204
|
+
* @experimental (since 1.108)
|
|
3205
|
+
*
|
|
3153
3206
|
* @returns Returns a promise. The card will wait for this promise to be resolved before continuing with
|
|
3154
3207
|
* the initialization.
|
|
3155
3208
|
*/
|
|
@@ -3159,16 +3212,16 @@ declare namespace sap {
|
|
|
3159
3212
|
*/
|
|
3160
3213
|
onCardReady(): void;
|
|
3161
3214
|
/**
|
|
3162
|
-
* @deprecated (since 1.85) - This property is replaced by the `actions` aggregation of the card;
|
|
3163
|
-
* @experimental (since 1.75) - Disclaimer: this property is in a beta state - incompatible API changes
|
|
3164
|
-
* may be done before its official public release. Use at your own discretion.
|
|
3165
|
-
*
|
|
3166
3215
|
* Sets a new value for property {@link #getActions actions}.
|
|
3167
3216
|
*
|
|
3168
3217
|
* The actions configuration.
|
|
3169
3218
|
*
|
|
3170
3219
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3171
3220
|
*
|
|
3221
|
+
* @deprecated (since 1.85) - This property is replaced by the `actions` aggregation of the card;
|
|
3222
|
+
* @experimental (since 1.75) - Disclaimer: this property is in a beta state - incompatible API changes
|
|
3223
|
+
* may be done before its official public release. Use at your own discretion.
|
|
3224
|
+
*
|
|
3172
3225
|
* @returns Reference to `this` in order to allow method chaining
|
|
3173
3226
|
*/
|
|
3174
3227
|
setActions(
|
|
@@ -3183,6 +3236,7 @@ declare namespace sap {
|
|
|
3183
3236
|
* The formatters that can be used in the manifest. When called with a value of `null` or `undefined`, the
|
|
3184
3237
|
* default value of the property will be restored.
|
|
3185
3238
|
*
|
|
3239
|
+
*
|
|
3186
3240
|
* @returns Reference to `this` in order to allow method chaining
|
|
3187
3241
|
*/
|
|
3188
3242
|
setFormatters(
|
|
@@ -3193,12 +3247,12 @@ declare namespace sap {
|
|
|
3193
3247
|
): this;
|
|
3194
3248
|
}
|
|
3195
3249
|
/**
|
|
3196
|
-
* @since 1.75
|
|
3197
|
-
* @experimental (since 1.75)
|
|
3198
|
-
*
|
|
3199
3250
|
* Provides application-level functions and services to an integration card.
|
|
3200
3251
|
*
|
|
3201
3252
|
* Examples may include, but are not limited to options like: share a card, remove a card.
|
|
3253
|
+
*
|
|
3254
|
+
* @since 1.75
|
|
3255
|
+
* @experimental (since 1.75)
|
|
3202
3256
|
*/
|
|
3203
3257
|
class Host extends sap.ui.core.Element {
|
|
3204
3258
|
/**
|
|
@@ -3238,6 +3292,7 @@ declare namespace sap {
|
|
|
3238
3292
|
*
|
|
3239
3293
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
|
|
3240
3294
|
*
|
|
3295
|
+
*
|
|
3241
3296
|
* @returns Created class / constructor function
|
|
3242
3297
|
*/
|
|
3243
3298
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -3258,13 +3313,11 @@ declare namespace sap {
|
|
|
3258
3313
|
/**
|
|
3259
3314
|
* Returns a metadata object for class sap.ui.integration.Host.
|
|
3260
3315
|
*
|
|
3316
|
+
*
|
|
3261
3317
|
* @returns Metadata object describing this class
|
|
3262
3318
|
*/
|
|
3263
3319
|
static getMetadata(): sap.ui.core.ElementMetadata;
|
|
3264
3320
|
/**
|
|
3265
|
-
* @experimental (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
3266
|
-
* be done before its official public release. Use at your own discretion.
|
|
3267
|
-
*
|
|
3268
3321
|
* Attaches event handler `fnFunction` to the {@link #event:action action} event of this `sap.ui.integration.Host`.
|
|
3269
3322
|
*
|
|
3270
3323
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
@@ -3276,6 +3329,9 @@ declare namespace sap {
|
|
|
3276
3329
|
* In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
|
|
3277
3330
|
* one to handle the action by calling `oEvent.preventDefault()`.
|
|
3278
3331
|
*
|
|
3332
|
+
* @experimental (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
3333
|
+
* be done before its official public release. Use at your own discretion.
|
|
3334
|
+
*
|
|
3279
3335
|
* @returns Reference to `this` in order to allow method chaining
|
|
3280
3336
|
*/
|
|
3281
3337
|
attachAction(
|
|
@@ -3294,9 +3350,6 @@ declare namespace sap {
|
|
|
3294
3350
|
oListener?: object
|
|
3295
3351
|
): this;
|
|
3296
3352
|
/**
|
|
3297
|
-
* @experimental (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
3298
|
-
* be done before its official public release. Use at your own discretion.
|
|
3299
|
-
*
|
|
3300
3353
|
* Attaches event handler `fnFunction` to the {@link #event:action action} event of this `sap.ui.integration.Host`.
|
|
3301
3354
|
*
|
|
3302
3355
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
@@ -3308,6 +3361,9 @@ declare namespace sap {
|
|
|
3308
3361
|
* In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
|
|
3309
3362
|
* one to handle the action by calling `oEvent.preventDefault()`.
|
|
3310
3363
|
*
|
|
3364
|
+
* @experimental (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
3365
|
+
* be done before its official public release. Use at your own discretion.
|
|
3366
|
+
*
|
|
3311
3367
|
* @returns Reference to `this` in order to allow method chaining
|
|
3312
3368
|
*/
|
|
3313
3369
|
attachAction(
|
|
@@ -3321,8 +3377,6 @@ declare namespace sap {
|
|
|
3321
3377
|
oListener?: object
|
|
3322
3378
|
): this;
|
|
3323
3379
|
/**
|
|
3324
|
-
* @experimental (since 1.96)
|
|
3325
|
-
*
|
|
3326
3380
|
* Attaches event handler `fnFunction` to the {@link #event:cardConfigurationChange cardConfigurationChange }
|
|
3327
3381
|
* event of this `sap.ui.integration.Host`.
|
|
3328
3382
|
*
|
|
@@ -3332,6 +3386,8 @@ declare namespace sap {
|
|
|
3332
3386
|
* Fired when some card configuration settings are changed as a result of user interaction. For example
|
|
3333
3387
|
* - filter value is changed.
|
|
3334
3388
|
*
|
|
3389
|
+
* @experimental (since 1.96)
|
|
3390
|
+
*
|
|
3335
3391
|
* @returns Reference to `this` in order to allow method chaining
|
|
3336
3392
|
*/
|
|
3337
3393
|
attachCardConfigurationChange(
|
|
@@ -3350,8 +3406,6 @@ declare namespace sap {
|
|
|
3350
3406
|
oListener?: object
|
|
3351
3407
|
): this;
|
|
3352
3408
|
/**
|
|
3353
|
-
* @experimental (since 1.96)
|
|
3354
|
-
*
|
|
3355
3409
|
* Attaches event handler `fnFunction` to the {@link #event:cardConfigurationChange cardConfigurationChange }
|
|
3356
3410
|
* event of this `sap.ui.integration.Host`.
|
|
3357
3411
|
*
|
|
@@ -3361,6 +3415,8 @@ declare namespace sap {
|
|
|
3361
3415
|
* Fired when some card configuration settings are changed as a result of user interaction. For example
|
|
3362
3416
|
* - filter value is changed.
|
|
3363
3417
|
*
|
|
3418
|
+
* @experimental (since 1.96)
|
|
3419
|
+
*
|
|
3364
3420
|
* @returns Reference to `this` in order to allow method chaining
|
|
3365
3421
|
*/
|
|
3366
3422
|
attachCardConfigurationChange(
|
|
@@ -3374,8 +3430,6 @@ declare namespace sap {
|
|
|
3374
3430
|
oListener?: object
|
|
3375
3431
|
): this;
|
|
3376
3432
|
/**
|
|
3377
|
-
* @experimental (since 1.116)
|
|
3378
|
-
*
|
|
3379
3433
|
* Attaches event handler `fnFunction` to the {@link #event:cardInitialized cardInitialized} event of this
|
|
3380
3434
|
* `sap.ui.integration.Host`.
|
|
3381
3435
|
*
|
|
@@ -3385,6 +3439,8 @@ declare namespace sap {
|
|
|
3385
3439
|
* Fired when the card is initially ready for the first time. Will not be fired for consecutive refreshes
|
|
3386
3440
|
* or data changes.
|
|
3387
3441
|
*
|
|
3442
|
+
* @experimental (since 1.116)
|
|
3443
|
+
*
|
|
3388
3444
|
* @returns Reference to `this` in order to allow method chaining
|
|
3389
3445
|
*/
|
|
3390
3446
|
attachCardInitialized(
|
|
@@ -3403,8 +3459,6 @@ declare namespace sap {
|
|
|
3403
3459
|
oListener?: object
|
|
3404
3460
|
): this;
|
|
3405
3461
|
/**
|
|
3406
|
-
* @experimental (since 1.116)
|
|
3407
|
-
*
|
|
3408
3462
|
* Attaches event handler `fnFunction` to the {@link #event:cardInitialized cardInitialized} event of this
|
|
3409
3463
|
* `sap.ui.integration.Host`.
|
|
3410
3464
|
*
|
|
@@ -3414,6 +3468,8 @@ declare namespace sap {
|
|
|
3414
3468
|
* Fired when the card is initially ready for the first time. Will not be fired for consecutive refreshes
|
|
3415
3469
|
* or data changes.
|
|
3416
3470
|
*
|
|
3471
|
+
* @experimental (since 1.116)
|
|
3472
|
+
*
|
|
3417
3473
|
* @returns Reference to `this` in order to allow method chaining
|
|
3418
3474
|
*/
|
|
3419
3475
|
attachCardInitialized(
|
|
@@ -3427,8 +3483,6 @@ declare namespace sap {
|
|
|
3427
3483
|
oListener?: object
|
|
3428
3484
|
): this;
|
|
3429
3485
|
/**
|
|
3430
|
-
* @experimental (since 1.107)
|
|
3431
|
-
*
|
|
3432
3486
|
* Attaches event handler `fnFunction` to the {@link #event:cardStateChanged cardStateChanged} event of
|
|
3433
3487
|
* this `sap.ui.integration.Host`.
|
|
3434
3488
|
*
|
|
@@ -3438,6 +3492,8 @@ declare namespace sap {
|
|
|
3438
3492
|
* Fired when the state of a card is changed. For example - the card is ready, new page is selected inside
|
|
3439
3493
|
* the card, a filter is changed or data is refreshed.
|
|
3440
3494
|
*
|
|
3495
|
+
* @experimental (since 1.107)
|
|
3496
|
+
*
|
|
3441
3497
|
* @returns Reference to `this` in order to allow method chaining
|
|
3442
3498
|
*/
|
|
3443
3499
|
attachCardStateChanged(
|
|
@@ -3456,8 +3512,6 @@ declare namespace sap {
|
|
|
3456
3512
|
oListener?: object
|
|
3457
3513
|
): this;
|
|
3458
3514
|
/**
|
|
3459
|
-
* @experimental (since 1.107)
|
|
3460
|
-
*
|
|
3461
3515
|
* Attaches event handler `fnFunction` to the {@link #event:cardStateChanged cardStateChanged} event of
|
|
3462
3516
|
* this `sap.ui.integration.Host`.
|
|
3463
3517
|
*
|
|
@@ -3467,6 +3521,8 @@ declare namespace sap {
|
|
|
3467
3521
|
* Fired when the state of a card is changed. For example - the card is ready, new page is selected inside
|
|
3468
3522
|
* the card, a filter is changed or data is refreshed.
|
|
3469
3523
|
*
|
|
3524
|
+
* @experimental (since 1.107)
|
|
3525
|
+
*
|
|
3470
3526
|
* @returns Reference to `this` in order to allow method chaining
|
|
3471
3527
|
*/
|
|
3472
3528
|
attachCardStateChanged(
|
|
@@ -3480,8 +3536,6 @@ declare namespace sap {
|
|
|
3480
3536
|
oListener?: object
|
|
3481
3537
|
): this;
|
|
3482
3538
|
/**
|
|
3483
|
-
* @experimental (since 1.91)
|
|
3484
|
-
*
|
|
3485
3539
|
* Attaches event handler `fnFunction` to the {@link #event:message message} event of this `sap.ui.integration.Host`.
|
|
3486
3540
|
*
|
|
3487
3541
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
@@ -3489,6 +3543,8 @@ declare namespace sap {
|
|
|
3489
3543
|
*
|
|
3490
3544
|
* Fired when a message from channels like navigator.serviceWorker is received.
|
|
3491
3545
|
*
|
|
3546
|
+
* @experimental (since 1.91)
|
|
3547
|
+
*
|
|
3492
3548
|
* @returns Reference to `this` in order to allow method chaining
|
|
3493
3549
|
*/
|
|
3494
3550
|
attachMessage(
|
|
@@ -3507,8 +3563,6 @@ declare namespace sap {
|
|
|
3507
3563
|
oListener?: object
|
|
3508
3564
|
): this;
|
|
3509
3565
|
/**
|
|
3510
|
-
* @experimental (since 1.91)
|
|
3511
|
-
*
|
|
3512
3566
|
* Attaches event handler `fnFunction` to the {@link #event:message message} event of this `sap.ui.integration.Host`.
|
|
3513
3567
|
*
|
|
3514
3568
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
@@ -3516,6 +3570,8 @@ declare namespace sap {
|
|
|
3516
3570
|
*
|
|
3517
3571
|
* Fired when a message from channels like navigator.serviceWorker is received.
|
|
3518
3572
|
*
|
|
3573
|
+
* @experimental (since 1.91)
|
|
3574
|
+
*
|
|
3519
3575
|
* @returns Reference to `this` in order to allow method chaining
|
|
3520
3576
|
*/
|
|
3521
3577
|
attachMessage(
|
|
@@ -3529,10 +3585,10 @@ declare namespace sap {
|
|
|
3529
3585
|
oListener?: object
|
|
3530
3586
|
): this;
|
|
3531
3587
|
/**
|
|
3588
|
+
* This function is called when a CSRF token has expired.
|
|
3589
|
+
*
|
|
3532
3590
|
* @deprecated (since 1.120.0)
|
|
3533
3591
|
* @experimental (since 1.97)
|
|
3534
|
-
*
|
|
3535
|
-
* This function is called when a CSRF token has expired.
|
|
3536
3592
|
*/
|
|
3537
3593
|
csrfTokenExpired(
|
|
3538
3594
|
/**
|
|
@@ -3543,10 +3599,10 @@ declare namespace sap {
|
|
|
3543
3599
|
}
|
|
3544
3600
|
): void;
|
|
3545
3601
|
/**
|
|
3602
|
+
* This function is called when a CSRF token is fetched.
|
|
3603
|
+
*
|
|
3546
3604
|
* @deprecated (since 1.120.0)
|
|
3547
3605
|
* @experimental (since 1.97)
|
|
3548
|
-
*
|
|
3549
|
-
* This function is called when a CSRF token is fetched.
|
|
3550
3606
|
*/
|
|
3551
3607
|
csrfTokenFetched(
|
|
3552
3608
|
/**
|
|
@@ -3561,13 +3617,13 @@ declare namespace sap {
|
|
|
3561
3617
|
pCSRFTokenValuePromise: Promise<string>
|
|
3562
3618
|
): void;
|
|
3563
3619
|
/**
|
|
3564
|
-
* @experimental (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
3565
|
-
* be done before its official public release. Use at your own discretion.
|
|
3566
|
-
*
|
|
3567
3620
|
* Detaches event handler `fnFunction` from the {@link #event:action action} event of this `sap.ui.integration.Host`.
|
|
3568
3621
|
*
|
|
3569
3622
|
* The passed function and listener object must match the ones used for event registration.
|
|
3570
3623
|
*
|
|
3624
|
+
* @experimental (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
3625
|
+
* be done before its official public release. Use at your own discretion.
|
|
3626
|
+
*
|
|
3571
3627
|
* @returns Reference to `this` in order to allow method chaining
|
|
3572
3628
|
*/
|
|
3573
3629
|
detachAction(
|
|
@@ -3581,13 +3637,13 @@ declare namespace sap {
|
|
|
3581
3637
|
oListener?: object
|
|
3582
3638
|
): this;
|
|
3583
3639
|
/**
|
|
3584
|
-
* @experimental (since 1.96)
|
|
3585
|
-
*
|
|
3586
3640
|
* Detaches event handler `fnFunction` from the {@link #event:cardConfigurationChange cardConfigurationChange }
|
|
3587
3641
|
* event of this `sap.ui.integration.Host`.
|
|
3588
3642
|
*
|
|
3589
3643
|
* The passed function and listener object must match the ones used for event registration.
|
|
3590
3644
|
*
|
|
3645
|
+
* @experimental (since 1.96)
|
|
3646
|
+
*
|
|
3591
3647
|
* @returns Reference to `this` in order to allow method chaining
|
|
3592
3648
|
*/
|
|
3593
3649
|
detachCardConfigurationChange(
|
|
@@ -3601,13 +3657,13 @@ declare namespace sap {
|
|
|
3601
3657
|
oListener?: object
|
|
3602
3658
|
): this;
|
|
3603
3659
|
/**
|
|
3604
|
-
* @experimental (since 1.116)
|
|
3605
|
-
*
|
|
3606
3660
|
* Detaches event handler `fnFunction` from the {@link #event:cardInitialized cardInitialized} event of
|
|
3607
3661
|
* this `sap.ui.integration.Host`.
|
|
3608
3662
|
*
|
|
3609
3663
|
* The passed function and listener object must match the ones used for event registration.
|
|
3610
3664
|
*
|
|
3665
|
+
* @experimental (since 1.116)
|
|
3666
|
+
*
|
|
3611
3667
|
* @returns Reference to `this` in order to allow method chaining
|
|
3612
3668
|
*/
|
|
3613
3669
|
detachCardInitialized(
|
|
@@ -3621,13 +3677,13 @@ declare namespace sap {
|
|
|
3621
3677
|
oListener?: object
|
|
3622
3678
|
): this;
|
|
3623
3679
|
/**
|
|
3624
|
-
* @experimental (since 1.107)
|
|
3625
|
-
*
|
|
3626
3680
|
* Detaches event handler `fnFunction` from the {@link #event:cardStateChanged cardStateChanged} event of
|
|
3627
3681
|
* this `sap.ui.integration.Host`.
|
|
3628
3682
|
*
|
|
3629
3683
|
* The passed function and listener object must match the ones used for event registration.
|
|
3630
3684
|
*
|
|
3685
|
+
* @experimental (since 1.107)
|
|
3686
|
+
*
|
|
3631
3687
|
* @returns Reference to `this` in order to allow method chaining
|
|
3632
3688
|
*/
|
|
3633
3689
|
detachCardStateChanged(
|
|
@@ -3641,12 +3697,12 @@ declare namespace sap {
|
|
|
3641
3697
|
oListener?: object
|
|
3642
3698
|
): this;
|
|
3643
3699
|
/**
|
|
3644
|
-
* @experimental (since 1.91)
|
|
3645
|
-
*
|
|
3646
3700
|
* Detaches event handler `fnFunction` from the {@link #event:message message} event of this `sap.ui.integration.Host`.
|
|
3647
3701
|
*
|
|
3648
3702
|
* The passed function and listener object must match the ones used for event registration.
|
|
3649
3703
|
*
|
|
3704
|
+
* @experimental (since 1.91)
|
|
3705
|
+
*
|
|
3650
3706
|
* @returns Reference to `this` in order to allow method chaining
|
|
3651
3707
|
*/
|
|
3652
3708
|
detachMessage(
|
|
@@ -3660,15 +3716,15 @@ declare namespace sap {
|
|
|
3660
3716
|
oListener?: object
|
|
3661
3717
|
): this;
|
|
3662
3718
|
/**
|
|
3663
|
-
* @experimental (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
3664
|
-
* be done before its official public release. Use at your own discretion.
|
|
3665
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
3666
|
-
*
|
|
3667
3719
|
* Fires event {@link #event:action action} to attached listeners.
|
|
3668
3720
|
*
|
|
3669
3721
|
* Listeners may prevent the default action of this event by calling the `preventDefault` method on the
|
|
3670
3722
|
* event object. The return value of this method indicates whether the default action should be executed.
|
|
3671
3723
|
*
|
|
3724
|
+
* @experimental (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
3725
|
+
* be done before its official public release. Use at your own discretion.
|
|
3726
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
3727
|
+
*
|
|
3672
3728
|
* @returns Whether or not to prevent the default action
|
|
3673
3729
|
*/
|
|
3674
3730
|
fireAction(
|
|
@@ -3678,11 +3734,11 @@ declare namespace sap {
|
|
|
3678
3734
|
mParameters?: sap.ui.integration.Host$ActionEventParameters
|
|
3679
3735
|
): boolean;
|
|
3680
3736
|
/**
|
|
3737
|
+
* Fires event {@link #event:cardConfigurationChange cardConfigurationChange} to attached listeners.
|
|
3738
|
+
*
|
|
3681
3739
|
* @experimental (since 1.96)
|
|
3682
3740
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
3683
3741
|
*
|
|
3684
|
-
* Fires event {@link #event:cardConfigurationChange cardConfigurationChange} to attached listeners.
|
|
3685
|
-
*
|
|
3686
3742
|
* @returns Reference to `this` in order to allow method chaining
|
|
3687
3743
|
*/
|
|
3688
3744
|
fireCardConfigurationChange(
|
|
@@ -3692,11 +3748,11 @@ declare namespace sap {
|
|
|
3692
3748
|
mParameters?: sap.ui.integration.Host$CardConfigurationChangeEventParameters
|
|
3693
3749
|
): this;
|
|
3694
3750
|
/**
|
|
3751
|
+
* Fires event {@link #event:cardInitialized cardInitialized} to attached listeners.
|
|
3752
|
+
*
|
|
3695
3753
|
* @experimental (since 1.116)
|
|
3696
3754
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
3697
3755
|
*
|
|
3698
|
-
* Fires event {@link #event:cardInitialized cardInitialized} to attached listeners.
|
|
3699
|
-
*
|
|
3700
3756
|
* @returns Reference to `this` in order to allow method chaining
|
|
3701
3757
|
*/
|
|
3702
3758
|
fireCardInitialized(
|
|
@@ -3706,11 +3762,11 @@ declare namespace sap {
|
|
|
3706
3762
|
mParameters?: sap.ui.integration.Host$CardInitializedEventParameters
|
|
3707
3763
|
): this;
|
|
3708
3764
|
/**
|
|
3765
|
+
* Fires event {@link #event:cardStateChanged cardStateChanged} to attached listeners.
|
|
3766
|
+
*
|
|
3709
3767
|
* @experimental (since 1.107)
|
|
3710
3768
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
3711
3769
|
*
|
|
3712
|
-
* Fires event {@link #event:cardStateChanged cardStateChanged} to attached listeners.
|
|
3713
|
-
*
|
|
3714
3770
|
* @returns Reference to `this` in order to allow method chaining
|
|
3715
3771
|
*/
|
|
3716
3772
|
fireCardStateChanged(
|
|
@@ -3720,11 +3776,11 @@ declare namespace sap {
|
|
|
3720
3776
|
mParameters?: sap.ui.integration.Host$CardStateChangedEventParameters
|
|
3721
3777
|
): this;
|
|
3722
3778
|
/**
|
|
3779
|
+
* Fires event {@link #event:message message} to attached listeners.
|
|
3780
|
+
*
|
|
3723
3781
|
* @experimental (since 1.91)
|
|
3724
3782
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
3725
3783
|
*
|
|
3726
|
-
* Fires event {@link #event:message message} to attached listeners.
|
|
3727
|
-
*
|
|
3728
3784
|
* @returns Reference to `this` in order to allow method chaining
|
|
3729
3785
|
*/
|
|
3730
3786
|
fireMessage(
|
|
@@ -3734,19 +3790,17 @@ declare namespace sap {
|
|
|
3734
3790
|
mParameters?: sap.ui.integration.Host$MessageEventParameters
|
|
3735
3791
|
): this;
|
|
3736
3792
|
/**
|
|
3737
|
-
* @experimental (since 1.75) - Disclaimer: this property is in a beta state - incompatible API changes
|
|
3738
|
-
* may be done before its official public release. Use at your own discretion.
|
|
3739
|
-
*
|
|
3740
3793
|
* Gets current value of property {@link #getActions actions}.
|
|
3741
3794
|
*
|
|
3742
3795
|
* The actions configuration.
|
|
3743
3796
|
*
|
|
3797
|
+
* @experimental (since 1.75) - Disclaimer: this property is in a beta state - incompatible API changes
|
|
3798
|
+
* may be done before its official public release. Use at your own discretion.
|
|
3799
|
+
*
|
|
3744
3800
|
* @returns Value of property `actions`
|
|
3745
3801
|
*/
|
|
3746
3802
|
getActions(): sap.ui.integration.CardMenuAction[];
|
|
3747
3803
|
/**
|
|
3748
|
-
* @since 1.83
|
|
3749
|
-
*
|
|
3750
3804
|
* Returns the context object for the Card Editor design-time environment Contexts can be used to configure
|
|
3751
3805
|
* Cards with information available in the host environment. Each entry in the list should contain design-time
|
|
3752
3806
|
* information. A label, placeholder, and description should be provided.
|
|
@@ -3758,12 +3812,12 @@ declare namespace sap {
|
|
|
3758
3812
|
* The context information and texts should be translated as they appear in the design-time UI of the Card
|
|
3759
3813
|
* Editor.
|
|
3760
3814
|
*
|
|
3815
|
+
* @since 1.83
|
|
3816
|
+
*
|
|
3761
3817
|
* @returns A promise which contains the context structure.
|
|
3762
3818
|
*/
|
|
3763
3819
|
getContexts(): Promise<object>;
|
|
3764
3820
|
/**
|
|
3765
|
-
* @since 1.83
|
|
3766
|
-
*
|
|
3767
3821
|
* Resolves the value for a given path in the context of the host Contexts can be used to configure Cards
|
|
3768
3822
|
* with information available in the host environment.
|
|
3769
3823
|
*
|
|
@@ -3774,6 +3828,8 @@ declare namespace sap {
|
|
|
3774
3828
|
* Example path to the current user id of the context sPath = "sap.workzone/currentUser/id" parameter: {
|
|
3775
3829
|
* userId: { value: "{context>sap.workzone/currentUser/id}" resolves to UserId } }
|
|
3776
3830
|
*
|
|
3831
|
+
* @since 1.83
|
|
3832
|
+
*
|
|
3777
3833
|
* @returns A promise which resolves with the value of this context.
|
|
3778
3834
|
*/
|
|
3779
3835
|
getContextValue(
|
|
@@ -3783,12 +3839,12 @@ declare namespace sap {
|
|
|
3783
3839
|
sPath: string
|
|
3784
3840
|
): Promise<null>;
|
|
3785
3841
|
/**
|
|
3842
|
+
* Resolves the CSRF token and returns a Promise with its value.
|
|
3843
|
+
*
|
|
3786
3844
|
* @deprecated (since 1.120.0)
|
|
3787
3845
|
* @experimental (since 1.97)
|
|
3788
3846
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
3789
3847
|
*
|
|
3790
|
-
* Resolves the CSRF token and returns a Promise with its value.
|
|
3791
|
-
*
|
|
3792
3848
|
* @returns A promise which resolves the CSRF token to its value.
|
|
3793
3849
|
*/
|
|
3794
3850
|
getCsrfToken(
|
|
@@ -3802,6 +3858,7 @@ declare namespace sap {
|
|
|
3802
3858
|
/**
|
|
3803
3859
|
* Resolves the destination and returns its URL.
|
|
3804
3860
|
*
|
|
3861
|
+
*
|
|
3805
3862
|
* @returns A promise which resolves with the URL of the destination.
|
|
3806
3863
|
*/
|
|
3807
3864
|
getDestination(
|
|
@@ -3815,11 +3872,11 @@ declare namespace sap {
|
|
|
3815
3872
|
oCard: sap.ui.integration.widgets.Card
|
|
3816
3873
|
): Promise<string>;
|
|
3817
3874
|
/**
|
|
3818
|
-
* @since 1.83
|
|
3819
|
-
*
|
|
3820
3875
|
* Returns the list of destinations for the Card Editor design-time environment List entries are objects
|
|
3821
3876
|
* that contain at least the name. { "name": "DestinationName" }
|
|
3822
3877
|
*
|
|
3878
|
+
* @since 1.83
|
|
3879
|
+
*
|
|
3823
3880
|
* @returns A promise which resolves with the list of destinations.
|
|
3824
3881
|
*/
|
|
3825
3882
|
getDestinations(): Promise<object[]>;
|
|
@@ -3836,6 +3893,7 @@ declare namespace sap {
|
|
|
3836
3893
|
* The callback receives `destinationName` as parameter and returns a string with the URL. Or alternatively
|
|
3837
3894
|
* the callback may return a `Promise` with the URL as an argument.
|
|
3838
3895
|
*
|
|
3896
|
+
*
|
|
3839
3897
|
* @returns Value of property `resolveDestination`
|
|
3840
3898
|
*/
|
|
3841
3899
|
getResolveDestination():
|
|
@@ -3845,15 +3903,15 @@ declare namespace sap {
|
|
|
3845
3903
|
) => string | Promise<string>)
|
|
3846
3904
|
| undefined;
|
|
3847
3905
|
/**
|
|
3848
|
-
* @experimental (since 1.75) - Disclaimer: this property is in a beta state - incompatible API changes
|
|
3849
|
-
* may be done before its official public release. Use at your own discretion.
|
|
3850
|
-
*
|
|
3851
3906
|
* Sets a new value for property {@link #getActions actions}.
|
|
3852
3907
|
*
|
|
3853
3908
|
* The actions configuration.
|
|
3854
3909
|
*
|
|
3855
3910
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3856
3911
|
*
|
|
3912
|
+
* @experimental (since 1.75) - Disclaimer: this property is in a beta state - incompatible API changes
|
|
3913
|
+
* may be done before its official public release. Use at your own discretion.
|
|
3914
|
+
*
|
|
3857
3915
|
* @returns Reference to `this` in order to allow method chaining
|
|
3858
3916
|
*/
|
|
3859
3917
|
setActions(
|
|
@@ -3873,6 +3931,7 @@ declare namespace sap {
|
|
|
3873
3931
|
*
|
|
3874
3932
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3875
3933
|
*
|
|
3934
|
+
*
|
|
3876
3935
|
* @returns Reference to `this` in order to allow method chaining
|
|
3877
3936
|
*/
|
|
3878
3937
|
setResolveDestination(
|
|
@@ -3886,9 +3945,9 @@ declare namespace sap {
|
|
|
3886
3945
|
): this;
|
|
3887
3946
|
}
|
|
3888
3947
|
/**
|
|
3889
|
-
* @since 1.96
|
|
3890
|
-
*
|
|
3891
3948
|
* Defines the layout type of the List card attributes.
|
|
3949
|
+
*
|
|
3950
|
+
* @since 1.96
|
|
3892
3951
|
*/
|
|
3893
3952
|
enum AttributesLayoutType {
|
|
3894
3953
|
/**
|
|
@@ -3901,34 +3960,34 @@ declare namespace sap {
|
|
|
3901
3960
|
TwoColumns = "TwoColumns",
|
|
3902
3961
|
}
|
|
3903
3962
|
/**
|
|
3963
|
+
* Enumeration of possible card action types.
|
|
3964
|
+
*
|
|
3904
3965
|
* @experimental (since 1.64) - Disclaimer: this property is in a beta state - incompatible API changes
|
|
3905
3966
|
* may be done before its official public release. Use at your own discretion.
|
|
3906
|
-
*
|
|
3907
|
-
* Enumeration of possible card action types.
|
|
3908
3967
|
*/
|
|
3909
3968
|
enum CardActionType {
|
|
3910
3969
|
/**
|
|
3911
|
-
* @experimental (since 1.76)
|
|
3912
|
-
*
|
|
3913
3970
|
* Used for custom actions.
|
|
3971
|
+
*
|
|
3972
|
+
* @experimental (since 1.76)
|
|
3914
3973
|
*/
|
|
3915
3974
|
Custom = "Custom",
|
|
3916
3975
|
/**
|
|
3917
|
-
* @experimental (since 1.87)
|
|
3918
|
-
*
|
|
3919
3976
|
* Date selection. Available only for Calendar cards.
|
|
3977
|
+
*
|
|
3978
|
+
* @experimental (since 1.87)
|
|
3920
3979
|
*/
|
|
3921
3980
|
DateChange = "DateChange",
|
|
3922
3981
|
/**
|
|
3923
|
-
* @experimental (since 1.100)
|
|
3924
|
-
*
|
|
3925
3982
|
* Used for hiding the appeared details about the card.
|
|
3983
|
+
*
|
|
3984
|
+
* @experimental (since 1.100)
|
|
3926
3985
|
*/
|
|
3927
3986
|
HideCard = "HideCard",
|
|
3928
3987
|
/**
|
|
3929
|
-
* @experimental (since 1.87)
|
|
3930
|
-
*
|
|
3931
3988
|
* Month selection. Available only for Calendar cards.
|
|
3989
|
+
*
|
|
3990
|
+
* @experimental (since 1.87)
|
|
3932
3991
|
*/
|
|
3933
3992
|
MonthChange = "MonthChange",
|
|
3934
3993
|
/**
|
|
@@ -3936,9 +3995,9 @@ declare namespace sap {
|
|
|
3936
3995
|
*/
|
|
3937
3996
|
Navigation = "Navigation",
|
|
3938
3997
|
/**
|
|
3939
|
-
* @experimental (since 1.100)
|
|
3940
|
-
*
|
|
3941
3998
|
* Used for showing more details about the card.
|
|
3999
|
+
*
|
|
4000
|
+
* @experimental (since 1.100)
|
|
3942
4001
|
*/
|
|
3943
4002
|
ShowCard = "ShowCard",
|
|
3944
4003
|
/**
|
|
@@ -3947,9 +4006,9 @@ declare namespace sap {
|
|
|
3947
4006
|
Submit = "Submit",
|
|
3948
4007
|
}
|
|
3949
4008
|
/**
|
|
3950
|
-
* @since 1.86
|
|
3951
|
-
*
|
|
3952
4009
|
* Defines the areas in a card.
|
|
4010
|
+
*
|
|
4011
|
+
* @since 1.86
|
|
3953
4012
|
*/
|
|
3954
4013
|
enum CardArea {
|
|
3955
4014
|
/**
|
|
@@ -3966,9 +4025,9 @@ declare namespace sap {
|
|
|
3966
4025
|
Header = "Header",
|
|
3967
4026
|
}
|
|
3968
4027
|
/**
|
|
3969
|
-
* @experimental (since 1.114)
|
|
3970
|
-
*
|
|
3971
4028
|
* Card blocking message types.
|
|
4029
|
+
*
|
|
4030
|
+
* @experimental (since 1.114)
|
|
3972
4031
|
*/
|
|
3973
4032
|
enum CardBlockingMessageType {
|
|
3974
4033
|
/**
|
|
@@ -3985,10 +4044,10 @@ declare namespace sap {
|
|
|
3985
4044
|
NoData = "NoData",
|
|
3986
4045
|
}
|
|
3987
4046
|
/**
|
|
4047
|
+
* Possible data modes for `{@link sap.ui.integration.widgets.Card}`.
|
|
4048
|
+
*
|
|
3988
4049
|
* @since 1.65
|
|
3989
4050
|
* @experimental (since 1.65)
|
|
3990
|
-
*
|
|
3991
|
-
* Possible data modes for `{@link sap.ui.integration.widgets.Card}`.
|
|
3992
4051
|
*/
|
|
3993
4052
|
enum CardDataMode {
|
|
3994
4053
|
/**
|
|
@@ -4005,10 +4064,10 @@ declare namespace sap {
|
|
|
4005
4064
|
Inactive = "Inactive",
|
|
4006
4065
|
}
|
|
4007
4066
|
/**
|
|
4067
|
+
* Possible designs for `{@link sap.ui.integration.widgets.Card}`.
|
|
4068
|
+
*
|
|
4008
4069
|
* @since 1.109
|
|
4009
4070
|
* @experimental (since 1.109)
|
|
4010
|
-
*
|
|
4011
|
-
* Possible designs for `{@link sap.ui.integration.widgets.Card}`.
|
|
4012
4071
|
*/
|
|
4013
4072
|
enum CardDesign {
|
|
4014
4073
|
/**
|
|
@@ -4021,10 +4080,10 @@ declare namespace sap {
|
|
|
4021
4080
|
Transparent = "Transparent",
|
|
4022
4081
|
}
|
|
4023
4082
|
/**
|
|
4083
|
+
* Possible variants for `{@link sap.ui.integration.widgets.Card}` rendering and behavior.
|
|
4084
|
+
*
|
|
4024
4085
|
* @since 1.118
|
|
4025
4086
|
* @experimental (since 1.118) - For usage only by Work Zone.
|
|
4026
|
-
*
|
|
4027
|
-
* Possible variants for `{@link sap.ui.integration.widgets.Card}` rendering and behavior.
|
|
4028
4087
|
*/
|
|
4029
4088
|
enum CardDisplayVariant {
|
|
4030
4089
|
/**
|
|
@@ -4049,11 +4108,11 @@ declare namespace sap {
|
|
|
4049
4108
|
TileStandardWide = "TileStandardWide",
|
|
4050
4109
|
}
|
|
4051
4110
|
/**
|
|
4052
|
-
* @since 1.112
|
|
4053
|
-
* @experimental (since 1.112)
|
|
4054
|
-
*
|
|
4055
4111
|
* Preview modes for `{@link sap.ui.integration.widgets.Card}`. Helpful in scenarios when the end user is
|
|
4056
4112
|
* choosing or configuring a card.
|
|
4113
|
+
*
|
|
4114
|
+
* @since 1.112
|
|
4115
|
+
* @experimental (since 1.112)
|
|
4057
4116
|
*/
|
|
4058
4117
|
enum CardPreviewMode {
|
|
4059
4118
|
/**
|
|
@@ -4070,9 +4129,9 @@ declare namespace sap {
|
|
|
4070
4129
|
Off = "Off",
|
|
4071
4130
|
}
|
|
4072
4131
|
/**
|
|
4073
|
-
* @experimental (since 1.114)
|
|
4074
|
-
*
|
|
4075
4132
|
* Settings for blocking message that ocurred in a {@link sap.ui.integration.widgets.Card}
|
|
4133
|
+
*
|
|
4134
|
+
* @experimental (since 1.114)
|
|
4076
4135
|
*/
|
|
4077
4136
|
type BlockingMessageSettings = {
|
|
4078
4137
|
/**
|
|
@@ -4102,9 +4161,9 @@ declare namespace sap {
|
|
|
4102
4161
|
};
|
|
4103
4162
|
|
|
4104
4163
|
/**
|
|
4105
|
-
* @experimental (since 1.79)
|
|
4106
|
-
*
|
|
4107
4164
|
* An object type that represents card menu action properties.
|
|
4165
|
+
*
|
|
4166
|
+
* @experimental (since 1.79)
|
|
4108
4167
|
*/
|
|
4109
4168
|
type CardMenuAction = {
|
|
4110
4169
|
/**
|