@openui5/types 1.120.7 → 1.121.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/types/sap.f.d.ts +1605 -885
- package/types/sap.m.d.ts +14948 -8390
- package/types/sap.tnt.d.ts +904 -294
- package/types/sap.ui.codeeditor.d.ts +55 -22
- package/types/sap.ui.commons.d.ts +2084 -676
- package/types/sap.ui.core.d.ts +5771 -3523
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.fl.d.ts +184 -112
- package/types/sap.ui.integration.d.ts +496 -390
- package/types/sap.ui.layout.d.ts +1337 -668
- package/types/sap.ui.mdc.d.ts +3384 -2021
- package/types/sap.ui.rta.d.ts +7 -7
- package/types/sap.ui.suite.d.ts +44 -10
- package/types/sap.ui.support.d.ts +58 -26
- package/types/sap.ui.table.d.ts +962 -626
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +1976 -1246
- package/types/sap.ui.ux3.d.ts +1308 -488
- package/types/sap.ui.webc.common.d.ts +7 -5
- package/types/sap.ui.webc.fiori.d.ts +884 -213
- package/types/sap.ui.webc.main.d.ts +2813 -599
- package/types/sap.uxap.d.ts +621 -319
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.
|
|
1
|
+
// For Library Version: 1.121.0
|
|
2
2
|
|
|
3
3
|
declare module "sap/ui/integration/library" {
|
|
4
4
|
import { URI } from "sap/ui/core/library";
|
|
@@ -6,9 +6,12 @@ declare module "sap/ui/integration/library" {
|
|
|
6
6
|
import { ButtonType } from "sap/m/library";
|
|
7
7
|
|
|
8
8
|
/**
|
|
9
|
-
* @since 1.96
|
|
10
|
-
*
|
|
11
9
|
* Defines the layout type of the List card attributes.
|
|
10
|
+
*
|
|
11
|
+
* This enum is part of the 'sap/ui/integration/library' module export and must be accessed by the property
|
|
12
|
+
* 'AttributesLayoutType'.
|
|
13
|
+
*
|
|
14
|
+
* @since 1.96
|
|
12
15
|
*/
|
|
13
16
|
export enum AttributesLayoutType {
|
|
14
17
|
/**
|
|
@@ -21,34 +24,37 @@ declare module "sap/ui/integration/library" {
|
|
|
21
24
|
TwoColumns = "TwoColumns",
|
|
22
25
|
}
|
|
23
26
|
/**
|
|
27
|
+
* Enumeration of possible card action types.
|
|
28
|
+
*
|
|
29
|
+
* This enum is part of the 'sap/ui/integration/library' module export and must be accessed by the property
|
|
30
|
+
* 'CardActionType'.
|
|
31
|
+
*
|
|
24
32
|
* @experimental (since 1.64) - Disclaimer: this property is in a beta state - incompatible API changes
|
|
25
33
|
* may be done before its official public release. Use at your own discretion.
|
|
26
|
-
*
|
|
27
|
-
* Enumeration of possible card action types.
|
|
28
34
|
*/
|
|
29
35
|
export enum CardActionType {
|
|
30
36
|
/**
|
|
31
|
-
* @experimental (since 1.76)
|
|
32
|
-
*
|
|
33
37
|
* Used for custom actions.
|
|
38
|
+
*
|
|
39
|
+
* @experimental (since 1.76)
|
|
34
40
|
*/
|
|
35
41
|
Custom = "Custom",
|
|
36
42
|
/**
|
|
37
|
-
* @experimental (since 1.87)
|
|
38
|
-
*
|
|
39
43
|
* Date selection. Available only for Calendar cards.
|
|
44
|
+
*
|
|
45
|
+
* @experimental (since 1.87)
|
|
40
46
|
*/
|
|
41
47
|
DateChange = "DateChange",
|
|
42
48
|
/**
|
|
43
|
-
* @experimental (since 1.100)
|
|
44
|
-
*
|
|
45
49
|
* Used for hiding the appeared details about the card.
|
|
50
|
+
*
|
|
51
|
+
* @experimental (since 1.100)
|
|
46
52
|
*/
|
|
47
53
|
HideCard = "HideCard",
|
|
48
54
|
/**
|
|
49
|
-
* @experimental (since 1.87)
|
|
50
|
-
*
|
|
51
55
|
* Month selection. Available only for Calendar cards.
|
|
56
|
+
*
|
|
57
|
+
* @experimental (since 1.87)
|
|
52
58
|
*/
|
|
53
59
|
MonthChange = "MonthChange",
|
|
54
60
|
/**
|
|
@@ -56,9 +62,9 @@ declare module "sap/ui/integration/library" {
|
|
|
56
62
|
*/
|
|
57
63
|
Navigation = "Navigation",
|
|
58
64
|
/**
|
|
59
|
-
* @experimental (since 1.100)
|
|
60
|
-
*
|
|
61
65
|
* Used for showing more details about the card.
|
|
66
|
+
*
|
|
67
|
+
* @experimental (since 1.100)
|
|
62
68
|
*/
|
|
63
69
|
ShowCard = "ShowCard",
|
|
64
70
|
/**
|
|
@@ -67,9 +73,12 @@ declare module "sap/ui/integration/library" {
|
|
|
67
73
|
Submit = "Submit",
|
|
68
74
|
}
|
|
69
75
|
/**
|
|
70
|
-
* @since 1.86
|
|
71
|
-
*
|
|
72
76
|
* Defines the areas in a card.
|
|
77
|
+
*
|
|
78
|
+
* This enum is part of the 'sap/ui/integration/library' module export and must be accessed by the property
|
|
79
|
+
* 'CardArea'.
|
|
80
|
+
*
|
|
81
|
+
* @since 1.86
|
|
73
82
|
*/
|
|
74
83
|
export enum CardArea {
|
|
75
84
|
/**
|
|
@@ -86,9 +95,12 @@ declare module "sap/ui/integration/library" {
|
|
|
86
95
|
Header = "Header",
|
|
87
96
|
}
|
|
88
97
|
/**
|
|
89
|
-
* @experimental (since 1.114)
|
|
90
|
-
*
|
|
91
98
|
* Card blocking message types.
|
|
99
|
+
*
|
|
100
|
+
* This enum is part of the 'sap/ui/integration/library' module export and must be accessed by the property
|
|
101
|
+
* 'CardBlockingMessageType'.
|
|
102
|
+
*
|
|
103
|
+
* @experimental (since 1.114)
|
|
92
104
|
*/
|
|
93
105
|
export enum CardBlockingMessageType {
|
|
94
106
|
/**
|
|
@@ -105,10 +117,13 @@ declare module "sap/ui/integration/library" {
|
|
|
105
117
|
NoData = "NoData",
|
|
106
118
|
}
|
|
107
119
|
/**
|
|
120
|
+
* Possible data modes for `{@link sap.ui.integration.widgets.Card}`.
|
|
121
|
+
*
|
|
122
|
+
* This enum is part of the 'sap/ui/integration/library' module export and must be accessed by the property
|
|
123
|
+
* 'CardDataMode'.
|
|
124
|
+
*
|
|
108
125
|
* @since 1.65
|
|
109
126
|
* @experimental (since 1.65)
|
|
110
|
-
*
|
|
111
|
-
* Possible data modes for `{@link sap.ui.integration.widgets.Card}`.
|
|
112
127
|
*/
|
|
113
128
|
export enum CardDataMode {
|
|
114
129
|
/**
|
|
@@ -125,10 +140,13 @@ declare module "sap/ui/integration/library" {
|
|
|
125
140
|
Inactive = "Inactive",
|
|
126
141
|
}
|
|
127
142
|
/**
|
|
143
|
+
* Possible designs for `{@link sap.ui.integration.widgets.Card}`.
|
|
144
|
+
*
|
|
145
|
+
* This enum is part of the 'sap/ui/integration/library' module export and must be accessed by the property
|
|
146
|
+
* 'CardDesign'.
|
|
147
|
+
*
|
|
128
148
|
* @since 1.109
|
|
129
149
|
* @experimental (since 1.109)
|
|
130
|
-
*
|
|
131
|
-
* Possible designs for `{@link sap.ui.integration.widgets.Card}`.
|
|
132
150
|
*/
|
|
133
151
|
export enum CardDesign {
|
|
134
152
|
/**
|
|
@@ -141,10 +159,13 @@ declare module "sap/ui/integration/library" {
|
|
|
141
159
|
Transparent = "Transparent",
|
|
142
160
|
}
|
|
143
161
|
/**
|
|
162
|
+
* Possible variants for `{@link sap.ui.integration.widgets.Card}` rendering and behavior.
|
|
163
|
+
*
|
|
164
|
+
* This enum is part of the 'sap/ui/integration/library' module export and must be accessed by the property
|
|
165
|
+
* 'CardDisplayVariant'.
|
|
166
|
+
*
|
|
144
167
|
* @since 1.118
|
|
145
168
|
* @experimental (since 1.118) - For usage only by Work Zone.
|
|
146
|
-
*
|
|
147
|
-
* Possible variants for `{@link sap.ui.integration.widgets.Card}` rendering and behavior.
|
|
148
169
|
*/
|
|
149
170
|
export enum CardDisplayVariant {
|
|
150
171
|
/**
|
|
@@ -169,9 +190,9 @@ declare module "sap/ui/integration/library" {
|
|
|
169
190
|
TileStandardWide = "TileStandardWide",
|
|
170
191
|
}
|
|
171
192
|
/**
|
|
172
|
-
* @experimental (since 1.79)
|
|
173
|
-
*
|
|
174
193
|
* An object type that represents card menu action properties.
|
|
194
|
+
*
|
|
195
|
+
* @experimental (since 1.79)
|
|
175
196
|
*/
|
|
176
197
|
export type CardMenuAction = {
|
|
177
198
|
/**
|
|
@@ -213,11 +234,14 @@ declare module "sap/ui/integration/library" {
|
|
|
213
234
|
};
|
|
214
235
|
|
|
215
236
|
/**
|
|
216
|
-
* @since 1.112
|
|
217
|
-
* @experimental (since 1.112)
|
|
218
|
-
*
|
|
219
237
|
* Preview modes for `{@link sap.ui.integration.widgets.Card}`. Helpful in scenarios when the end user is
|
|
220
238
|
* choosing or configuring a card.
|
|
239
|
+
*
|
|
240
|
+
* This enum is part of the 'sap/ui/integration/library' module export and must be accessed by the property
|
|
241
|
+
* 'CardPreviewMode'.
|
|
242
|
+
*
|
|
243
|
+
* @since 1.112
|
|
244
|
+
* @experimental (since 1.112)
|
|
221
245
|
*/
|
|
222
246
|
export enum CardPreviewMode {
|
|
223
247
|
/**
|
|
@@ -251,12 +275,12 @@ declare module "sap/ui/integration/ActionDefinition" {
|
|
|
251
275
|
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
252
276
|
|
|
253
277
|
/**
|
|
278
|
+
* Represents an action, which appears in the header of {@link sap.ui.integration.widgets.Card}. Useful
|
|
279
|
+
* in `Component` card and `Extension`.
|
|
280
|
+
*
|
|
254
281
|
* @since 1.85
|
|
255
282
|
* @experimental (since 1.85) - Disclaimer: this class is in a beta state - incompatible API changes may
|
|
256
283
|
* be done before its official public release. Use at your own discretion.
|
|
257
|
-
*
|
|
258
|
-
* Represents an action, which appears in the header of {@link sap.ui.integration.widgets.Card}. Useful
|
|
259
|
-
* in `Component` card and `Extension`.
|
|
260
284
|
*/
|
|
261
285
|
export default class ActionDefinition extends UI5Element {
|
|
262
286
|
/**
|
|
@@ -296,6 +320,7 @@ declare module "sap/ui/integration/ActionDefinition" {
|
|
|
296
320
|
*
|
|
297
321
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
|
|
298
322
|
*
|
|
323
|
+
*
|
|
299
324
|
* @returns Created class / constructor function
|
|
300
325
|
*/
|
|
301
326
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -316,6 +341,7 @@ declare module "sap/ui/integration/ActionDefinition" {
|
|
|
316
341
|
/**
|
|
317
342
|
* Returns a metadata object for class sap.ui.integration.ActionDefinition.
|
|
318
343
|
*
|
|
344
|
+
*
|
|
319
345
|
* @returns Metadata object describing this class
|
|
320
346
|
*/
|
|
321
347
|
static getMetadata(): ElementMetadata;
|
|
@@ -327,6 +353,7 @@ declare module "sap/ui/integration/ActionDefinition" {
|
|
|
327
353
|
*
|
|
328
354
|
* Fired when the action button is pressed.
|
|
329
355
|
*
|
|
356
|
+
*
|
|
330
357
|
* @returns Reference to `this` in order to allow method chaining
|
|
331
358
|
*/
|
|
332
359
|
attachPress(
|
|
@@ -353,6 +380,7 @@ declare module "sap/ui/integration/ActionDefinition" {
|
|
|
353
380
|
*
|
|
354
381
|
* Fired when the action button is pressed.
|
|
355
382
|
*
|
|
383
|
+
*
|
|
356
384
|
* @returns Reference to `this` in order to allow method chaining
|
|
357
385
|
*/
|
|
358
386
|
attachPress(
|
|
@@ -371,6 +399,7 @@ declare module "sap/ui/integration/ActionDefinition" {
|
|
|
371
399
|
*
|
|
372
400
|
* The passed function and listener object must match the ones used for event registration.
|
|
373
401
|
*
|
|
402
|
+
*
|
|
374
403
|
* @returns Reference to `this` in order to allow method chaining
|
|
375
404
|
*/
|
|
376
405
|
detachPress(
|
|
@@ -384,10 +413,10 @@ declare module "sap/ui/integration/ActionDefinition" {
|
|
|
384
413
|
oListener?: object
|
|
385
414
|
): this;
|
|
386
415
|
/**
|
|
387
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
388
|
-
*
|
|
389
416
|
* Fires event {@link #event:press press} to attached listeners.
|
|
390
417
|
*
|
|
418
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
419
|
+
*
|
|
391
420
|
* @returns Reference to `this` in order to allow method chaining
|
|
392
421
|
*/
|
|
393
422
|
firePress(
|
|
@@ -403,6 +432,7 @@ declare module "sap/ui/integration/ActionDefinition" {
|
|
|
403
432
|
*
|
|
404
433
|
* Default value is `Transparent`.
|
|
405
434
|
*
|
|
435
|
+
*
|
|
406
436
|
* @returns Value of property `buttonType`
|
|
407
437
|
*/
|
|
408
438
|
getButtonType(): ButtonType | keyof typeof ButtonType;
|
|
@@ -414,6 +444,7 @@ declare module "sap/ui/integration/ActionDefinition" {
|
|
|
414
444
|
*
|
|
415
445
|
* Default value is `true`.
|
|
416
446
|
*
|
|
447
|
+
*
|
|
417
448
|
* @returns Value of property `enabled`
|
|
418
449
|
*/
|
|
419
450
|
getEnabled(): boolean;
|
|
@@ -422,6 +453,7 @@ declare module "sap/ui/integration/ActionDefinition" {
|
|
|
422
453
|
*
|
|
423
454
|
* The icon of the action button.
|
|
424
455
|
*
|
|
456
|
+
*
|
|
425
457
|
* @returns Value of property `icon`
|
|
426
458
|
*/
|
|
427
459
|
getIcon(): URI;
|
|
@@ -430,6 +462,7 @@ declare module "sap/ui/integration/ActionDefinition" {
|
|
|
430
462
|
*
|
|
431
463
|
* The parameters of the action.
|
|
432
464
|
*
|
|
465
|
+
*
|
|
433
466
|
* @returns Value of property `parameters`
|
|
434
467
|
*/
|
|
435
468
|
getParameters(): object;
|
|
@@ -440,6 +473,7 @@ declare module "sap/ui/integration/ActionDefinition" {
|
|
|
440
473
|
*
|
|
441
474
|
* Default value is `empty string`.
|
|
442
475
|
*
|
|
476
|
+
*
|
|
443
477
|
* @returns Value of property `text`
|
|
444
478
|
*/
|
|
445
479
|
getText(): string;
|
|
@@ -448,6 +482,7 @@ declare module "sap/ui/integration/ActionDefinition" {
|
|
|
448
482
|
*
|
|
449
483
|
* The type of the action.
|
|
450
484
|
*
|
|
485
|
+
*
|
|
451
486
|
* @returns Value of property `type`
|
|
452
487
|
*/
|
|
453
488
|
getType(): CardActionType | keyof typeof CardActionType;
|
|
@@ -458,6 +493,7 @@ declare module "sap/ui/integration/ActionDefinition" {
|
|
|
458
493
|
*
|
|
459
494
|
* Default value is `true`.
|
|
460
495
|
*
|
|
496
|
+
*
|
|
461
497
|
* @returns Value of property `visible`
|
|
462
498
|
*/
|
|
463
499
|
getVisible(): boolean;
|
|
@@ -470,6 +506,7 @@ declare module "sap/ui/integration/ActionDefinition" {
|
|
|
470
506
|
*
|
|
471
507
|
* Default value is `Transparent`.
|
|
472
508
|
*
|
|
509
|
+
*
|
|
473
510
|
* @returns Reference to `this` in order to allow method chaining
|
|
474
511
|
*/
|
|
475
512
|
setButtonType(
|
|
@@ -488,6 +525,7 @@ declare module "sap/ui/integration/ActionDefinition" {
|
|
|
488
525
|
*
|
|
489
526
|
* Default value is `true`.
|
|
490
527
|
*
|
|
528
|
+
*
|
|
491
529
|
* @returns Reference to `this` in order to allow method chaining
|
|
492
530
|
*/
|
|
493
531
|
setEnabled(
|
|
@@ -503,6 +541,7 @@ declare module "sap/ui/integration/ActionDefinition" {
|
|
|
503
541
|
*
|
|
504
542
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
505
543
|
*
|
|
544
|
+
*
|
|
506
545
|
* @returns Reference to `this` in order to allow method chaining
|
|
507
546
|
*/
|
|
508
547
|
setIcon(
|
|
@@ -518,6 +557,7 @@ declare module "sap/ui/integration/ActionDefinition" {
|
|
|
518
557
|
*
|
|
519
558
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
520
559
|
*
|
|
560
|
+
*
|
|
521
561
|
* @returns Reference to `this` in order to allow method chaining
|
|
522
562
|
*/
|
|
523
563
|
setParameters(
|
|
@@ -535,6 +575,7 @@ declare module "sap/ui/integration/ActionDefinition" {
|
|
|
535
575
|
*
|
|
536
576
|
* Default value is `empty string`.
|
|
537
577
|
*
|
|
578
|
+
*
|
|
538
579
|
* @returns Reference to `this` in order to allow method chaining
|
|
539
580
|
*/
|
|
540
581
|
setText(
|
|
@@ -550,6 +591,7 @@ declare module "sap/ui/integration/ActionDefinition" {
|
|
|
550
591
|
*
|
|
551
592
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
552
593
|
*
|
|
594
|
+
*
|
|
553
595
|
* @returns Reference to `this` in order to allow method chaining
|
|
554
596
|
*/
|
|
555
597
|
setType(
|
|
@@ -567,6 +609,7 @@ declare module "sap/ui/integration/ActionDefinition" {
|
|
|
567
609
|
*
|
|
568
610
|
* Default value is `true`.
|
|
569
611
|
*
|
|
612
|
+
*
|
|
570
613
|
* @returns Reference to `this` in order to allow method chaining
|
|
571
614
|
*/
|
|
572
615
|
setVisible(
|
|
@@ -669,9 +712,9 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
669
712
|
} from "sap/ui/base/ManagedObject";
|
|
670
713
|
|
|
671
714
|
/**
|
|
672
|
-
* @experimental (since 1.114)
|
|
673
|
-
*
|
|
674
715
|
* Settings for blocking message that ocurred in a {@link sap.ui.integration.widgets.Card}
|
|
716
|
+
*
|
|
717
|
+
* @experimental (since 1.114)
|
|
675
718
|
*/
|
|
676
719
|
export type BlockingMessageSettings = {
|
|
677
720
|
/**
|
|
@@ -700,11 +743,13 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
700
743
|
* Response object in case of a network error
|
|
701
744
|
*/
|
|
702
745
|
httpResponse?: Response;
|
|
746
|
+
/**
|
|
747
|
+
* A list of buttons placed below the description as additional content. Experimental since 1.121
|
|
748
|
+
*/
|
|
749
|
+
additionalContent?: any[];
|
|
703
750
|
};
|
|
704
751
|
|
|
705
752
|
/**
|
|
706
|
-
* @since 1.62
|
|
707
|
-
*
|
|
708
753
|
* A control that represents a container with a header and content.
|
|
709
754
|
*
|
|
710
755
|
* Overview: Cards are small user interface elements which provide the most important information from an
|
|
@@ -742,6 +787,8 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
742
787
|
*
|
|
743
788
|
* - When you have to use an application model. For such cases, use: {@link sap.f.Card sap.f.Card}.
|
|
744
789
|
* - When you need complex behavior. For such cases, use: {@link sap.f.Card sap.f.Card}.
|
|
790
|
+
*
|
|
791
|
+
* @since 1.62
|
|
745
792
|
*/
|
|
746
793
|
export default class Card extends CardBase {
|
|
747
794
|
/**
|
|
@@ -785,6 +832,7 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
785
832
|
*
|
|
786
833
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.f.CardBase.extend}.
|
|
787
834
|
*
|
|
835
|
+
*
|
|
788
836
|
* @returns Created class / constructor function
|
|
789
837
|
*/
|
|
790
838
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -805,16 +853,17 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
805
853
|
/**
|
|
806
854
|
* Returns a metadata object for class sap.ui.integration.widgets.Card.
|
|
807
855
|
*
|
|
856
|
+
*
|
|
808
857
|
* @returns Metadata object describing this class
|
|
809
858
|
*/
|
|
810
859
|
static getMetadata(): ElementMetadata;
|
|
811
860
|
/**
|
|
861
|
+
* Adds some actionDefinition to the aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
862
|
+
*
|
|
812
863
|
* @since 1.85
|
|
813
864
|
* @experimental (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
|
|
814
865
|
* may be done before its official public release. Use at your own discretion.
|
|
815
866
|
*
|
|
816
|
-
* Adds some actionDefinition to the aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
817
|
-
*
|
|
818
867
|
* @returns Reference to `this` in order to allow method chaining
|
|
819
868
|
*/
|
|
820
869
|
addActionDefinition(
|
|
@@ -824,9 +873,6 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
824
873
|
oActionDefinition: ActionDefinition
|
|
825
874
|
): this;
|
|
826
875
|
/**
|
|
827
|
-
* @experimental (since 1.64) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
828
|
-
* be done before its official public release. Use at your own discretion.
|
|
829
|
-
*
|
|
830
876
|
* Attaches event handler `fnFunction` to the {@link #event:action action} event of this `sap.ui.integration.widgets.Card`.
|
|
831
877
|
*
|
|
832
878
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
@@ -838,6 +884,9 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
838
884
|
* In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
|
|
839
885
|
* one to handle the action by calling `oEvent.preventDefault()`.
|
|
840
886
|
*
|
|
887
|
+
* @experimental (since 1.64) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
888
|
+
* be done before its official public release. Use at your own discretion.
|
|
889
|
+
*
|
|
841
890
|
* @returns Reference to `this` in order to allow method chaining
|
|
842
891
|
*/
|
|
843
892
|
attachAction(
|
|
@@ -856,9 +905,6 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
856
905
|
oListener?: object
|
|
857
906
|
): this;
|
|
858
907
|
/**
|
|
859
|
-
* @experimental (since 1.64) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
860
|
-
* be done before its official public release. Use at your own discretion.
|
|
861
|
-
*
|
|
862
908
|
* Attaches event handler `fnFunction` to the {@link #event:action action} event of this `sap.ui.integration.widgets.Card`.
|
|
863
909
|
*
|
|
864
910
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
@@ -870,6 +916,9 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
870
916
|
* In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
|
|
871
917
|
* one to handle the action by calling `oEvent.preventDefault()`.
|
|
872
918
|
*
|
|
919
|
+
* @experimental (since 1.64) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
920
|
+
* be done before its official public release. Use at your own discretion.
|
|
921
|
+
*
|
|
873
922
|
* @returns Reference to `this` in order to allow method chaining
|
|
874
923
|
*/
|
|
875
924
|
attachAction(
|
|
@@ -883,8 +932,6 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
883
932
|
oListener?: object
|
|
884
933
|
): this;
|
|
885
934
|
/**
|
|
886
|
-
* @experimental (since 1.96)
|
|
887
|
-
*
|
|
888
935
|
* Attaches event handler `fnFunction` to the {@link #event:configurationChange configurationChange} event
|
|
889
936
|
* of this `sap.ui.integration.widgets.Card`.
|
|
890
937
|
*
|
|
@@ -894,6 +941,8 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
894
941
|
* Fired when some configuration settings are changed as a result of user interaction. For example - filter
|
|
895
942
|
* value is changed.
|
|
896
943
|
*
|
|
944
|
+
* @experimental (since 1.96)
|
|
945
|
+
*
|
|
897
946
|
* @returns Reference to `this` in order to allow method chaining
|
|
898
947
|
*/
|
|
899
948
|
attachConfigurationChange(
|
|
@@ -912,8 +961,6 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
912
961
|
oListener?: object
|
|
913
962
|
): this;
|
|
914
963
|
/**
|
|
915
|
-
* @experimental (since 1.96)
|
|
916
|
-
*
|
|
917
964
|
* Attaches event handler `fnFunction` to the {@link #event:configurationChange configurationChange} event
|
|
918
965
|
* of this `sap.ui.integration.widgets.Card`.
|
|
919
966
|
*
|
|
@@ -923,6 +970,8 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
923
970
|
* Fired when some configuration settings are changed as a result of user interaction. For example - filter
|
|
924
971
|
* value is changed.
|
|
925
972
|
*
|
|
973
|
+
* @experimental (since 1.96)
|
|
974
|
+
*
|
|
926
975
|
* @returns Reference to `this` in order to allow method chaining
|
|
927
976
|
*/
|
|
928
977
|
attachConfigurationChange(
|
|
@@ -947,6 +996,7 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
947
996
|
*
|
|
948
997
|
* Note: The card's content may not be available yet because it may depend on other resources to load.
|
|
949
998
|
*
|
|
999
|
+
*
|
|
950
1000
|
* @returns Reference to `this` in order to allow method chaining
|
|
951
1001
|
*/
|
|
952
1002
|
attachManifestApplied(
|
|
@@ -976,6 +1026,7 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
976
1026
|
*
|
|
977
1027
|
* Note: The card's content may not be available yet because it may depend on other resources to load.
|
|
978
1028
|
*
|
|
1029
|
+
*
|
|
979
1030
|
* @returns Reference to `this` in order to allow method chaining
|
|
980
1031
|
*/
|
|
981
1032
|
attachManifestApplied(
|
|
@@ -989,8 +1040,6 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
989
1040
|
oListener?: object
|
|
990
1041
|
): this;
|
|
991
1042
|
/**
|
|
992
|
-
* @experimental (since 1.72)
|
|
993
|
-
*
|
|
994
1043
|
* Attaches event handler `fnFunction` to the {@link #event:manifestReady manifestReady} event of this `sap.ui.integration.widgets.Card`.
|
|
995
1044
|
*
|
|
996
1045
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
@@ -998,6 +1047,8 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
998
1047
|
*
|
|
999
1048
|
* Fired when the manifest is loaded.
|
|
1000
1049
|
*
|
|
1050
|
+
* @experimental (since 1.72)
|
|
1051
|
+
*
|
|
1001
1052
|
* @returns Reference to `this` in order to allow method chaining
|
|
1002
1053
|
*/
|
|
1003
1054
|
attachManifestReady(
|
|
@@ -1016,8 +1067,6 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1016
1067
|
oListener?: object
|
|
1017
1068
|
): this;
|
|
1018
1069
|
/**
|
|
1019
|
-
* @experimental (since 1.72)
|
|
1020
|
-
*
|
|
1021
1070
|
* Attaches event handler `fnFunction` to the {@link #event:manifestReady manifestReady} event of this `sap.ui.integration.widgets.Card`.
|
|
1022
1071
|
*
|
|
1023
1072
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
@@ -1025,6 +1074,8 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1025
1074
|
*
|
|
1026
1075
|
* Fired when the manifest is loaded.
|
|
1027
1076
|
*
|
|
1077
|
+
* @experimental (since 1.72)
|
|
1078
|
+
*
|
|
1028
1079
|
* @returns Reference to `this` in order to allow method chaining
|
|
1029
1080
|
*/
|
|
1030
1081
|
attachManifestReady(
|
|
@@ -1038,8 +1089,6 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1038
1089
|
oListener?: object
|
|
1039
1090
|
): this;
|
|
1040
1091
|
/**
|
|
1041
|
-
* @experimental (since 1.107)
|
|
1042
|
-
*
|
|
1043
1092
|
* Attaches event handler `fnFunction` to the {@link #event:stateChanged stateChanged} event of this `sap.ui.integration.widgets.Card`.
|
|
1044
1093
|
*
|
|
1045
1094
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
@@ -1048,6 +1097,8 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1048
1097
|
* Fired when the state of the card is changed. For example - the card is ready, new page is selected, a
|
|
1049
1098
|
* filter is changed or data is refreshed.
|
|
1050
1099
|
*
|
|
1100
|
+
* @experimental (since 1.107)
|
|
1101
|
+
*
|
|
1051
1102
|
* @returns Reference to `this` in order to allow method chaining
|
|
1052
1103
|
*/
|
|
1053
1104
|
attachStateChanged(
|
|
@@ -1066,8 +1117,6 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1066
1117
|
oListener?: object
|
|
1067
1118
|
): this;
|
|
1068
1119
|
/**
|
|
1069
|
-
* @experimental (since 1.107)
|
|
1070
|
-
*
|
|
1071
1120
|
* Attaches event handler `fnFunction` to the {@link #event:stateChanged stateChanged} event of this `sap.ui.integration.widgets.Card`.
|
|
1072
1121
|
*
|
|
1073
1122
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
@@ -1076,6 +1125,8 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1076
1125
|
* Fired when the state of the card is changed. For example - the card is ready, new page is selected, a
|
|
1077
1126
|
* filter is changed or data is refreshed.
|
|
1078
1127
|
*
|
|
1128
|
+
* @experimental (since 1.107)
|
|
1129
|
+
*
|
|
1079
1130
|
* @returns Reference to `this` in order to allow method chaining
|
|
1080
1131
|
*/
|
|
1081
1132
|
attachStateChanged(
|
|
@@ -1089,23 +1140,23 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1089
1140
|
oListener?: object
|
|
1090
1141
|
): this;
|
|
1091
1142
|
/**
|
|
1143
|
+
* Destroys all the actionDefinitions in the aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
1144
|
+
*
|
|
1092
1145
|
* @since 1.85
|
|
1093
1146
|
* @experimental (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
|
|
1094
1147
|
* may be done before its official public release. Use at your own discretion.
|
|
1095
1148
|
*
|
|
1096
|
-
* Destroys all the actionDefinitions in the aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
1097
|
-
*
|
|
1098
1149
|
* @returns Reference to `this` in order to allow method chaining
|
|
1099
1150
|
*/
|
|
1100
1151
|
destroyActionDefinitions(): this;
|
|
1101
1152
|
/**
|
|
1102
|
-
* @experimental (since 1.64) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
1103
|
-
* be done before its official public release. Use at your own discretion.
|
|
1104
|
-
*
|
|
1105
1153
|
* Detaches event handler `fnFunction` from the {@link #event:action action} event of this `sap.ui.integration.widgets.Card`.
|
|
1106
1154
|
*
|
|
1107
1155
|
* The passed function and listener object must match the ones used for event registration.
|
|
1108
1156
|
*
|
|
1157
|
+
* @experimental (since 1.64) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
1158
|
+
* be done before its official public release. Use at your own discretion.
|
|
1159
|
+
*
|
|
1109
1160
|
* @returns Reference to `this` in order to allow method chaining
|
|
1110
1161
|
*/
|
|
1111
1162
|
detachAction(
|
|
@@ -1119,13 +1170,13 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1119
1170
|
oListener?: object
|
|
1120
1171
|
): this;
|
|
1121
1172
|
/**
|
|
1122
|
-
* @experimental (since 1.96)
|
|
1123
|
-
*
|
|
1124
1173
|
* Detaches event handler `fnFunction` from the {@link #event:configurationChange configurationChange} event
|
|
1125
1174
|
* of this `sap.ui.integration.widgets.Card`.
|
|
1126
1175
|
*
|
|
1127
1176
|
* The passed function and listener object must match the ones used for event registration.
|
|
1128
1177
|
*
|
|
1178
|
+
* @experimental (since 1.96)
|
|
1179
|
+
*
|
|
1129
1180
|
* @returns Reference to `this` in order to allow method chaining
|
|
1130
1181
|
*/
|
|
1131
1182
|
detachConfigurationChange(
|
|
@@ -1144,6 +1195,7 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1144
1195
|
*
|
|
1145
1196
|
* The passed function and listener object must match the ones used for event registration.
|
|
1146
1197
|
*
|
|
1198
|
+
*
|
|
1147
1199
|
* @returns Reference to `this` in order to allow method chaining
|
|
1148
1200
|
*/
|
|
1149
1201
|
detachManifestApplied(
|
|
@@ -1157,13 +1209,13 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1157
1209
|
oListener?: object
|
|
1158
1210
|
): this;
|
|
1159
1211
|
/**
|
|
1160
|
-
* @experimental (since 1.72)
|
|
1161
|
-
*
|
|
1162
1212
|
* Detaches event handler `fnFunction` from the {@link #event:manifestReady manifestReady} event of this
|
|
1163
1213
|
* `sap.ui.integration.widgets.Card`.
|
|
1164
1214
|
*
|
|
1165
1215
|
* The passed function and listener object must match the ones used for event registration.
|
|
1166
1216
|
*
|
|
1217
|
+
* @experimental (since 1.72)
|
|
1218
|
+
*
|
|
1167
1219
|
* @returns Reference to `this` in order to allow method chaining
|
|
1168
1220
|
*/
|
|
1169
1221
|
detachManifestReady(
|
|
@@ -1177,12 +1229,12 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1177
1229
|
oListener?: object
|
|
1178
1230
|
): this;
|
|
1179
1231
|
/**
|
|
1180
|
-
* @experimental (since 1.107)
|
|
1181
|
-
*
|
|
1182
1232
|
* Detaches event handler `fnFunction` from the {@link #event:stateChanged stateChanged} event of this `sap.ui.integration.widgets.Card`.
|
|
1183
1233
|
*
|
|
1184
1234
|
* The passed function and listener object must match the ones used for event registration.
|
|
1185
1235
|
*
|
|
1236
|
+
* @experimental (since 1.107)
|
|
1237
|
+
*
|
|
1186
1238
|
* @returns Reference to `this` in order to allow method chaining
|
|
1187
1239
|
*/
|
|
1188
1240
|
detachStateChanged(
|
|
@@ -1196,15 +1248,15 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1196
1248
|
oListener?: object
|
|
1197
1249
|
): this;
|
|
1198
1250
|
/**
|
|
1199
|
-
* @experimental (since 1.64) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
1200
|
-
* be done before its official public release. Use at your own discretion.
|
|
1201
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1202
|
-
*
|
|
1203
1251
|
* Fires event {@link #event:action action} to attached listeners.
|
|
1204
1252
|
*
|
|
1205
1253
|
* Listeners may prevent the default action of this event by calling the `preventDefault` method on the
|
|
1206
1254
|
* event object. The return value of this method indicates whether the default action should be executed.
|
|
1207
1255
|
*
|
|
1256
|
+
* @experimental (since 1.64) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
1257
|
+
* be done before its official public release. Use at your own discretion.
|
|
1258
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1259
|
+
*
|
|
1208
1260
|
* @returns Whether or not to prevent the default action
|
|
1209
1261
|
*/
|
|
1210
1262
|
fireAction(
|
|
@@ -1214,11 +1266,11 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1214
1266
|
mParameters?: Card$ActionEventParameters
|
|
1215
1267
|
): boolean;
|
|
1216
1268
|
/**
|
|
1269
|
+
* Fires event {@link #event:configurationChange configurationChange} to attached listeners.
|
|
1270
|
+
*
|
|
1217
1271
|
* @experimental (since 1.96)
|
|
1218
1272
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1219
1273
|
*
|
|
1220
|
-
* Fires event {@link #event:configurationChange configurationChange} to attached listeners.
|
|
1221
|
-
*
|
|
1222
1274
|
* @returns Reference to `this` in order to allow method chaining
|
|
1223
1275
|
*/
|
|
1224
1276
|
fireConfigurationChange(
|
|
@@ -1228,10 +1280,10 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1228
1280
|
mParameters?: Card$ConfigurationChangeEventParameters
|
|
1229
1281
|
): this;
|
|
1230
1282
|
/**
|
|
1231
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1232
|
-
*
|
|
1233
1283
|
* Fires event {@link #event:manifestApplied manifestApplied} to attached listeners.
|
|
1234
1284
|
*
|
|
1285
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1286
|
+
*
|
|
1235
1287
|
* @returns Reference to `this` in order to allow method chaining
|
|
1236
1288
|
*/
|
|
1237
1289
|
fireManifestApplied(
|
|
@@ -1241,11 +1293,11 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1241
1293
|
mParameters?: object
|
|
1242
1294
|
): this;
|
|
1243
1295
|
/**
|
|
1296
|
+
* Fires event {@link #event:manifestReady manifestReady} to attached listeners.
|
|
1297
|
+
*
|
|
1244
1298
|
* @experimental (since 1.72)
|
|
1245
1299
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1246
1300
|
*
|
|
1247
|
-
* Fires event {@link #event:manifestReady manifestReady} to attached listeners.
|
|
1248
|
-
*
|
|
1249
1301
|
* @returns Reference to `this` in order to allow method chaining
|
|
1250
1302
|
*/
|
|
1251
1303
|
fireManifestReady(
|
|
@@ -1255,11 +1307,11 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1255
1307
|
mParameters?: object
|
|
1256
1308
|
): this;
|
|
1257
1309
|
/**
|
|
1310
|
+
* Fires event {@link #event:stateChanged stateChanged} to attached listeners.
|
|
1311
|
+
*
|
|
1258
1312
|
* @experimental (since 1.107)
|
|
1259
1313
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1260
1314
|
*
|
|
1261
|
-
* Fires event {@link #event:stateChanged stateChanged} to attached listeners.
|
|
1262
|
-
*
|
|
1263
1315
|
* @returns Reference to `this` in order to allow method chaining
|
|
1264
1316
|
*/
|
|
1265
1317
|
fireStateChanged(
|
|
@@ -1269,39 +1321,37 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1269
1321
|
mParameters?: object
|
|
1270
1322
|
): this;
|
|
1271
1323
|
/**
|
|
1272
|
-
* @since 1.85
|
|
1273
|
-
* @experimental (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
|
|
1274
|
-
* may be done before its official public release. Use at your own discretion.
|
|
1275
|
-
*
|
|
1276
1324
|
* Gets content of aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
1277
1325
|
*
|
|
1278
1326
|
* Actions definitions from which actions in the header menu of the card are created. **Note**: This aggregation
|
|
1279
1327
|
* is destroyed when the property `manifest` changes.
|
|
1328
|
+
*
|
|
1329
|
+
* @since 1.85
|
|
1330
|
+
* @experimental (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
|
|
1331
|
+
* may be done before its official public release. Use at your own discretion.
|
|
1280
1332
|
*/
|
|
1281
1333
|
getActionDefinitions(): ActionDefinition[];
|
|
1282
1334
|
/**
|
|
1283
|
-
* @since 1.70
|
|
1284
|
-
* @experimental (since 1.70)
|
|
1285
|
-
*
|
|
1286
1335
|
* Gets current value of property {@link #getBaseUrl baseUrl}.
|
|
1287
1336
|
*
|
|
1288
1337
|
* Defines the base URL of the card manifest. It should be used when manifest property is an object instead
|
|
1289
1338
|
* of a URL. If both manifest URL and base URL are defined - the base URL will be used for loading dependencies.
|
|
1290
1339
|
*
|
|
1340
|
+
* @since 1.70
|
|
1341
|
+
* @experimental (since 1.70)
|
|
1342
|
+
*
|
|
1291
1343
|
* @returns Value of property `baseUrl`
|
|
1292
1344
|
*/
|
|
1293
1345
|
getBaseUrl(): URI;
|
|
1294
1346
|
/**
|
|
1295
|
-
* @experimental (since 1.114)
|
|
1296
|
-
*
|
|
1297
1347
|
* Get information about the blocking message in the card.
|
|
1298
1348
|
*
|
|
1349
|
+
* @experimental (since 1.114)
|
|
1350
|
+
*
|
|
1299
1351
|
* @returns Information about the message or `null`, if such isn't shown.
|
|
1300
1352
|
*/
|
|
1301
1353
|
getBlockingMessage(): BlockingMessageSettings | null;
|
|
1302
1354
|
/**
|
|
1303
|
-
* @experimental (since 1.77)
|
|
1304
|
-
*
|
|
1305
1355
|
* Gets values of manifest parameters combined with the parameters from `parameters` property.
|
|
1306
1356
|
*
|
|
1307
1357
|
* **Notes**
|
|
@@ -1310,79 +1360,78 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1310
1360
|
*
|
|
1311
1361
|
* - Use when developing a Component card.
|
|
1312
1362
|
*
|
|
1363
|
+
* @experimental (since 1.77)
|
|
1364
|
+
*
|
|
1313
1365
|
* @returns Object containing parameters in format `{parameterKey: parameterValue}`.
|
|
1314
1366
|
*/
|
|
1315
1367
|
getCombinedParameters(): Record<string, any>;
|
|
1316
1368
|
/**
|
|
1317
|
-
* @since 1.65
|
|
1318
|
-
* @experimental (since 1.65)
|
|
1319
|
-
*
|
|
1320
1369
|
* Gets current value of property {@link #getDataMode dataMode}.
|
|
1321
1370
|
*
|
|
1322
1371
|
* Defines the state of the `Card`. When set to `Inactive`, the `Card` doesn't make requests.
|
|
1323
1372
|
*
|
|
1324
1373
|
* Default value is `Auto`.
|
|
1325
1374
|
*
|
|
1375
|
+
* @since 1.65
|
|
1376
|
+
* @experimental (since 1.65)
|
|
1377
|
+
*
|
|
1326
1378
|
* @returns Value of property `dataMode`
|
|
1327
1379
|
*/
|
|
1328
1380
|
getDataMode(): CardDataMode | keyof typeof CardDataMode;
|
|
1329
1381
|
/**
|
|
1330
|
-
* @since 1.109
|
|
1331
|
-
* @experimental (since 1.109)
|
|
1332
|
-
*
|
|
1333
1382
|
* Gets current value of property {@link #getDesign design}.
|
|
1334
1383
|
*
|
|
1335
1384
|
* Defines the design of the `Card`.
|
|
1336
1385
|
*
|
|
1337
1386
|
* Default value is `Solid`.
|
|
1338
1387
|
*
|
|
1388
|
+
* @since 1.109
|
|
1389
|
+
* @experimental (since 1.109)
|
|
1390
|
+
*
|
|
1339
1391
|
* @returns Value of property `design`
|
|
1340
1392
|
*/
|
|
1341
1393
|
getDesign(): CardDesign | keyof typeof CardDesign;
|
|
1342
1394
|
/**
|
|
1343
|
-
* @since 1.118
|
|
1344
|
-
* @experimental (since 1.118) - For usage only by Work Zone.
|
|
1345
|
-
*
|
|
1346
1395
|
* Gets current value of property {@link #getDisplayVariant displayVariant}.
|
|
1347
1396
|
*
|
|
1348
1397
|
* Defines the display variant for card rendering and behavior.
|
|
1349
1398
|
*
|
|
1350
1399
|
* Default value is `Standard`.
|
|
1351
1400
|
*
|
|
1401
|
+
* @since 1.118
|
|
1402
|
+
* @experimental (since 1.118) - For usage only by Work Zone.
|
|
1403
|
+
*
|
|
1352
1404
|
* @returns Value of property `displayVariant`
|
|
1353
1405
|
*/
|
|
1354
1406
|
getDisplayVariant(): CardDisplayVariant | keyof typeof CardDisplayVariant;
|
|
1355
1407
|
/**
|
|
1356
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1357
|
-
*
|
|
1358
1408
|
* Returns the DOM Element that should get the focus.
|
|
1359
1409
|
*
|
|
1410
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1411
|
+
*
|
|
1360
1412
|
* @returns Returns the DOM Element that should get the focus
|
|
1361
1413
|
*/
|
|
1362
1414
|
getFocusDomRef(): Element;
|
|
1363
1415
|
/**
|
|
1364
1416
|
* ID of the element which is the current target of the association {@link #getHost host}, or `null`.
|
|
1365
1417
|
*/
|
|
1366
|
-
getHost(): ID;
|
|
1418
|
+
getHost(): ID | null;
|
|
1367
1419
|
/**
|
|
1368
|
-
* @experimental (since 1.77)
|
|
1369
|
-
*
|
|
1370
1420
|
* Gets the instance of the `host` association.
|
|
1371
1421
|
*
|
|
1422
|
+
* @experimental (since 1.77)
|
|
1423
|
+
*
|
|
1372
1424
|
* @returns The host object associated with this card.
|
|
1373
1425
|
*/
|
|
1374
1426
|
getHostInstance(): Host;
|
|
1375
1427
|
/**
|
|
1376
1428
|
* Overwrites getter for card manifest.
|
|
1377
1429
|
*
|
|
1430
|
+
*
|
|
1378
1431
|
* @returns Cloned of the parameters.
|
|
1379
1432
|
*/
|
|
1380
1433
|
getManifest(): string | Object;
|
|
1381
1434
|
/**
|
|
1382
|
-
* @since 1.76
|
|
1383
|
-
* @experimental (since 1.76) - This API might be removed when a permanent solution for flexibility changes
|
|
1384
|
-
* is implemented.
|
|
1385
|
-
*
|
|
1386
1435
|
* Gets current value of property {@link #getManifestChanges manifestChanges}.
|
|
1387
1436
|
*
|
|
1388
1437
|
* Defines a list of configuration settings, which will be merged into the original manifest.
|
|
@@ -1422,17 +1471,21 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1422
1471
|
* ```
|
|
1423
1472
|
*
|
|
1424
1473
|
*
|
|
1474
|
+
* @since 1.76
|
|
1475
|
+
* @experimental (since 1.76) - This API might be removed when a permanent solution for flexibility changes
|
|
1476
|
+
* is implemented.
|
|
1477
|
+
*
|
|
1425
1478
|
* @returns Value of property `manifestChanges`
|
|
1426
1479
|
*/
|
|
1427
1480
|
getManifestChanges(): object[];
|
|
1428
1481
|
/**
|
|
1429
|
-
* @experimental (since 1.77)
|
|
1430
|
-
*
|
|
1431
1482
|
* Returns a value from the Manifest based on the specified path.
|
|
1432
1483
|
*
|
|
1433
1484
|
* **Note** Use this method when the manifest is ready. Check `manifestReady` event.
|
|
1434
1485
|
*
|
|
1435
|
-
* @
|
|
1486
|
+
* @experimental (since 1.77)
|
|
1487
|
+
*
|
|
1488
|
+
* @returns The value at the specified path.
|
|
1436
1489
|
*/
|
|
1437
1490
|
getManifestEntry(
|
|
1438
1491
|
/**
|
|
@@ -1441,9 +1494,6 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1441
1494
|
sPath: string
|
|
1442
1495
|
): any;
|
|
1443
1496
|
/**
|
|
1444
|
-
* @since 1.112
|
|
1445
|
-
* @experimental (since 1.112)
|
|
1446
|
-
*
|
|
1447
1497
|
* Gets current value of property {@link #getPreviewMode previewMode}.
|
|
1448
1498
|
*
|
|
1449
1499
|
* Preview mode of the `Card`. Helpful in scenarios when the end user is choosing or configuring a card.
|
|
@@ -1455,6 +1505,9 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1455
1505
|
*
|
|
1456
1506
|
* Default value is `Off`.
|
|
1457
1507
|
*
|
|
1508
|
+
* @since 1.112
|
|
1509
|
+
* @experimental (since 1.112)
|
|
1510
|
+
*
|
|
1458
1511
|
* @returns Value of property `previewMode`
|
|
1459
1512
|
*/
|
|
1460
1513
|
getPreviewMode(): CardPreviewMode | keyof typeof CardPreviewMode;
|
|
@@ -1466,16 +1519,17 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1466
1519
|
*
|
|
1467
1520
|
* Default value is `empty string`.
|
|
1468
1521
|
*
|
|
1522
|
+
*
|
|
1469
1523
|
* @returns Value of property `referenceId`
|
|
1470
1524
|
*/
|
|
1471
1525
|
getReferenceId(): string;
|
|
1472
1526
|
/**
|
|
1473
|
-
* @experimental (since 1.83) - The API might change.
|
|
1474
|
-
*
|
|
1475
1527
|
* Gets translated text from the i18n properties files configured for this card.
|
|
1476
1528
|
*
|
|
1477
1529
|
* For more details see {@link module:sap/base/i18n/ResourceBundle#getText}.
|
|
1478
1530
|
*
|
|
1531
|
+
* @experimental (since 1.83) - The API might change.
|
|
1532
|
+
*
|
|
1479
1533
|
* @returns The value belonging to the key, if found; otherwise the key itself or `undefined` depending
|
|
1480
1534
|
* on `bIgnoreKeyFallback`.
|
|
1481
1535
|
*/
|
|
@@ -1498,9 +1552,9 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1498
1552
|
bIgnoreKeyFallback?: boolean
|
|
1499
1553
|
): string;
|
|
1500
1554
|
/**
|
|
1501
|
-
* @experimental (since 1.114)
|
|
1502
|
-
*
|
|
1503
1555
|
* Hide the blocking message that is shown in the card by `showBlockingMessage` call.
|
|
1556
|
+
*
|
|
1557
|
+
* @experimental (since 1.114)
|
|
1504
1558
|
*/
|
|
1505
1559
|
hideBlockingMessage(): void;
|
|
1506
1560
|
/**
|
|
@@ -1514,19 +1568,19 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1514
1568
|
eCardArea?: CardArea | keyof typeof CardArea
|
|
1515
1569
|
): void;
|
|
1516
1570
|
/**
|
|
1517
|
-
* @experimental (since 1.117)
|
|
1518
|
-
*
|
|
1519
1571
|
* Hides the message previously shown by showMessage.
|
|
1572
|
+
*
|
|
1573
|
+
* @experimental (since 1.117)
|
|
1520
1574
|
*/
|
|
1521
1575
|
hideMessage(): void;
|
|
1522
1576
|
/**
|
|
1577
|
+
* Checks for the provided `sap.ui.integration.ActionDefinition` in the aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
1578
|
+
* and returns its index if found or -1 otherwise.
|
|
1579
|
+
*
|
|
1523
1580
|
* @since 1.85
|
|
1524
1581
|
* @experimental (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
|
|
1525
1582
|
* may be done before its official public release. Use at your own discretion.
|
|
1526
1583
|
*
|
|
1527
|
-
* Checks for the provided `sap.ui.integration.ActionDefinition` in the aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
1528
|
-
* and returns its index if found or -1 otherwise.
|
|
1529
|
-
*
|
|
1530
1584
|
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
1531
1585
|
*/
|
|
1532
1586
|
indexOfActionDefinition(
|
|
@@ -1536,12 +1590,12 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1536
1590
|
oActionDefinition: ActionDefinition
|
|
1537
1591
|
): int;
|
|
1538
1592
|
/**
|
|
1593
|
+
* Inserts a actionDefinition into the aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
1594
|
+
*
|
|
1539
1595
|
* @since 1.85
|
|
1540
1596
|
* @experimental (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
|
|
1541
1597
|
* may be done before its official public release. Use at your own discretion.
|
|
1542
1598
|
*
|
|
1543
|
-
* Inserts a actionDefinition into the aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
1544
|
-
*
|
|
1545
1599
|
* @returns Reference to `this` in order to allow method chaining
|
|
1546
1600
|
*/
|
|
1547
1601
|
insertActionDefinition(
|
|
@@ -1559,13 +1613,10 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1559
1613
|
/**
|
|
1560
1614
|
* @experimental (since 1.65) - The API might change.
|
|
1561
1615
|
*
|
|
1562
|
-
*
|
|
1563
1616
|
* @returns If the card is ready or not.
|
|
1564
1617
|
*/
|
|
1565
1618
|
isReady(): boolean;
|
|
1566
1619
|
/**
|
|
1567
|
-
* @experimental (since 1.73)
|
|
1568
|
-
*
|
|
1569
1620
|
* Loads the module designtime/Card.designtime or the module given in "sap.card": { "designtime": "designtime/Own.designtime"
|
|
1570
1621
|
* } This file should contain the designtime configuration for the card.
|
|
1571
1622
|
*
|
|
@@ -1573,28 +1624,30 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1573
1624
|
* the complete manifest json } The promise is rejected if the module cannot be loaded with an object: {
|
|
1574
1625
|
* error: "Card.designtime not found" }
|
|
1575
1626
|
*
|
|
1627
|
+
* @experimental (since 1.73)
|
|
1628
|
+
*
|
|
1576
1629
|
* @returns Promise resolves after the designtime configuration is loaded.
|
|
1577
1630
|
*/
|
|
1578
1631
|
loadDesigntime(): Promise<object>;
|
|
1579
1632
|
/**
|
|
1580
|
-
* @experimental (since 1.65) - The API might change.
|
|
1581
|
-
*
|
|
1582
1633
|
* Refreshes the card by re-applying the manifest settings and triggering all data requests.
|
|
1634
|
+
*
|
|
1635
|
+
* @experimental (since 1.65) - The API might change.
|
|
1583
1636
|
*/
|
|
1584
1637
|
refresh(): void;
|
|
1585
1638
|
/**
|
|
1586
|
-
* @since 1.95
|
|
1587
|
-
*
|
|
1588
1639
|
* Refreshes the card data by triggering all data requests.
|
|
1640
|
+
*
|
|
1641
|
+
* @since 1.95
|
|
1589
1642
|
*/
|
|
1590
1643
|
refreshData(): void;
|
|
1591
1644
|
/**
|
|
1645
|
+
* Removes a actionDefinition from the aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
1646
|
+
*
|
|
1592
1647
|
* @since 1.85
|
|
1593
1648
|
* @experimental (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
|
|
1594
1649
|
* may be done before its official public release. Use at your own discretion.
|
|
1595
1650
|
*
|
|
1596
|
-
* Removes a actionDefinition from the aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
1597
|
-
*
|
|
1598
1651
|
* @returns The removed actionDefinition or `null`
|
|
1599
1652
|
*/
|
|
1600
1653
|
removeActionDefinition(
|
|
@@ -1604,22 +1657,22 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1604
1657
|
vActionDefinition: int | string | ActionDefinition
|
|
1605
1658
|
): ActionDefinition | null;
|
|
1606
1659
|
/**
|
|
1607
|
-
* @since 1.85
|
|
1608
|
-
* @experimental (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
|
|
1609
|
-
* may be done before its official public release. Use at your own discretion.
|
|
1610
|
-
*
|
|
1611
1660
|
* Removes all the controls from the aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
1612
1661
|
*
|
|
1613
1662
|
* Additionally, it unregisters them from the hosting UIArea.
|
|
1614
1663
|
*
|
|
1664
|
+
* @since 1.85
|
|
1665
|
+
* @experimental (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
|
|
1666
|
+
* may be done before its official public release. Use at your own discretion.
|
|
1667
|
+
*
|
|
1615
1668
|
* @returns An array of the removed elements (might be empty)
|
|
1616
1669
|
*/
|
|
1617
1670
|
removeAllActionDefinitions(): ActionDefinition[];
|
|
1618
1671
|
/**
|
|
1619
|
-
* @experimental (since 1.79)
|
|
1620
|
-
*
|
|
1621
1672
|
* Performs an HTTP request using the given configuration.
|
|
1622
1673
|
*
|
|
1674
|
+
* @experimental (since 1.79)
|
|
1675
|
+
*
|
|
1623
1676
|
* @returns Resolves when the request is successful, rejects otherwise.
|
|
1624
1677
|
*/
|
|
1625
1678
|
request(
|
|
@@ -1661,6 +1714,7 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1661
1714
|
/**
|
|
1662
1715
|
* Resolves the destination and returns its URL.
|
|
1663
1716
|
*
|
|
1717
|
+
*
|
|
1664
1718
|
* @returns A promise which resolves with the URL of the destination.
|
|
1665
1719
|
*/
|
|
1666
1720
|
resolveDestination(
|
|
@@ -1670,9 +1724,6 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1670
1724
|
sKey: string
|
|
1671
1725
|
): Promise<string>;
|
|
1672
1726
|
/**
|
|
1673
|
-
* @since 1.70
|
|
1674
|
-
* @experimental (since 1.70)
|
|
1675
|
-
*
|
|
1676
1727
|
* Sets a new value for property {@link #getBaseUrl baseUrl}.
|
|
1677
1728
|
*
|
|
1678
1729
|
* Defines the base URL of the card manifest. It should be used when manifest property is an object instead
|
|
@@ -1680,6 +1731,9 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1680
1731
|
*
|
|
1681
1732
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1682
1733
|
*
|
|
1734
|
+
* @since 1.70
|
|
1735
|
+
* @experimental (since 1.70)
|
|
1736
|
+
*
|
|
1683
1737
|
* @returns Reference to `this` in order to allow method chaining
|
|
1684
1738
|
*/
|
|
1685
1739
|
setBaseUrl(
|
|
@@ -1689,11 +1743,11 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1689
1743
|
sBaseUrl?: URI
|
|
1690
1744
|
): this;
|
|
1691
1745
|
/**
|
|
1746
|
+
* Sets a new value for the `dataMode` property.
|
|
1747
|
+
*
|
|
1692
1748
|
* @since 1.65
|
|
1693
1749
|
* @experimental (since 1.65) - API might change.
|
|
1694
1750
|
*
|
|
1695
|
-
* Sets a new value for the `dataMode` property.
|
|
1696
|
-
*
|
|
1697
1751
|
* @returns Pointer to the control instance to allow method chaining.
|
|
1698
1752
|
*/
|
|
1699
1753
|
setDataMode(
|
|
@@ -1703,9 +1757,6 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1703
1757
|
sMode: CardDataMode | keyof typeof CardDataMode
|
|
1704
1758
|
): this;
|
|
1705
1759
|
/**
|
|
1706
|
-
* @since 1.109
|
|
1707
|
-
* @experimental (since 1.109)
|
|
1708
|
-
*
|
|
1709
1760
|
* Sets a new value for property {@link #getDesign design}.
|
|
1710
1761
|
*
|
|
1711
1762
|
* Defines the design of the `Card`.
|
|
@@ -1714,6 +1765,9 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1714
1765
|
*
|
|
1715
1766
|
* Default value is `Solid`.
|
|
1716
1767
|
*
|
|
1768
|
+
* @since 1.109
|
|
1769
|
+
* @experimental (since 1.109)
|
|
1770
|
+
*
|
|
1717
1771
|
* @returns Reference to `this` in order to allow method chaining
|
|
1718
1772
|
*/
|
|
1719
1773
|
setDesign(
|
|
@@ -1723,9 +1777,6 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1723
1777
|
sDesign?: CardDesign | keyof typeof CardDesign
|
|
1724
1778
|
): this;
|
|
1725
1779
|
/**
|
|
1726
|
-
* @since 1.118
|
|
1727
|
-
* @experimental (since 1.118) - For usage only by Work Zone.
|
|
1728
|
-
*
|
|
1729
1780
|
* Sets a new value for property {@link #getDisplayVariant displayVariant}.
|
|
1730
1781
|
*
|
|
1731
1782
|
* Defines the display variant for card rendering and behavior.
|
|
@@ -1734,6 +1785,9 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1734
1785
|
*
|
|
1735
1786
|
* Default value is `Standard`.
|
|
1736
1787
|
*
|
|
1788
|
+
* @since 1.118
|
|
1789
|
+
* @experimental (since 1.118) - For usage only by Work Zone.
|
|
1790
|
+
*
|
|
1737
1791
|
* @returns Reference to `this` in order to allow method chaining
|
|
1738
1792
|
*/
|
|
1739
1793
|
setDisplayVariant(
|
|
@@ -1745,6 +1799,7 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1745
1799
|
/**
|
|
1746
1800
|
* Sets the associated {@link #getHost host}.
|
|
1747
1801
|
*
|
|
1802
|
+
*
|
|
1748
1803
|
* @returns Reference to `this` in order to allow method chaining
|
|
1749
1804
|
*/
|
|
1750
1805
|
setHost(
|
|
@@ -1763,6 +1818,7 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1763
1818
|
*
|
|
1764
1819
|
* Default value is `empty string`.
|
|
1765
1820
|
*
|
|
1821
|
+
*
|
|
1766
1822
|
* @returns Reference to `this` in order to allow method chaining
|
|
1767
1823
|
*/
|
|
1768
1824
|
setManifest(
|
|
@@ -1772,10 +1828,6 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1772
1828
|
oManifest?: any
|
|
1773
1829
|
): this;
|
|
1774
1830
|
/**
|
|
1775
|
-
* @since 1.76
|
|
1776
|
-
* @experimental (since 1.76) - This API might be removed when a permanent solution for flexibility changes
|
|
1777
|
-
* is implemented.
|
|
1778
|
-
*
|
|
1779
1831
|
* Sets a new value for property {@link #getManifestChanges manifestChanges}.
|
|
1780
1832
|
*
|
|
1781
1833
|
* Defines a list of configuration settings, which will be merged into the original manifest.
|
|
@@ -1817,6 +1869,10 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1817
1869
|
*
|
|
1818
1870
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1819
1871
|
*
|
|
1872
|
+
* @since 1.76
|
|
1873
|
+
* @experimental (since 1.76) - This API might be removed when a permanent solution for flexibility changes
|
|
1874
|
+
* is implemented.
|
|
1875
|
+
*
|
|
1820
1876
|
* @returns Reference to `this` in order to allow method chaining
|
|
1821
1877
|
*/
|
|
1822
1878
|
setManifestChanges(
|
|
@@ -1826,9 +1882,24 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1826
1882
|
sManifestChanges: object[]
|
|
1827
1883
|
): this;
|
|
1828
1884
|
/**
|
|
1829
|
-
* @
|
|
1830
|
-
*
|
|
1885
|
+
* Sets a new value for property {@link #getParameters parameters}.
|
|
1886
|
+
*
|
|
1887
|
+
* Overrides the default values of the parameters, which are defined in the manifest. The value is an object
|
|
1888
|
+
* containing parameters in format `{parameterKey: parameterValue}`.
|
|
1889
|
+
*
|
|
1890
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1891
|
+
*
|
|
1892
|
+
* @experimental (since 1.65) - This property might be changed in future.
|
|
1831
1893
|
*
|
|
1894
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1895
|
+
*/
|
|
1896
|
+
setParameters(
|
|
1897
|
+
/**
|
|
1898
|
+
* New value for property `parameters`
|
|
1899
|
+
*/
|
|
1900
|
+
oParameters?: object
|
|
1901
|
+
): this;
|
|
1902
|
+
/**
|
|
1832
1903
|
* Sets a new value for property {@link #getPreviewMode previewMode}.
|
|
1833
1904
|
*
|
|
1834
1905
|
* Preview mode of the `Card`. Helpful in scenarios when the end user is choosing or configuring a card.
|
|
@@ -1842,6 +1913,9 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1842
1913
|
*
|
|
1843
1914
|
* Default value is `Off`.
|
|
1844
1915
|
*
|
|
1916
|
+
* @since 1.112
|
|
1917
|
+
* @experimental (since 1.112)
|
|
1918
|
+
*
|
|
1845
1919
|
* @returns Reference to `this` in order to allow method chaining
|
|
1846
1920
|
*/
|
|
1847
1921
|
setPreviewMode(
|
|
@@ -1860,6 +1934,7 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1860
1934
|
*
|
|
1861
1935
|
* Default value is `empty string`.
|
|
1862
1936
|
*
|
|
1937
|
+
*
|
|
1863
1938
|
* @returns Reference to `this` in order to allow method chaining
|
|
1864
1939
|
*/
|
|
1865
1940
|
setReferenceId(
|
|
@@ -1869,10 +1944,10 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1869
1944
|
sReferenceId?: string
|
|
1870
1945
|
): this;
|
|
1871
1946
|
/**
|
|
1872
|
-
* @experimental (since 1.114)
|
|
1873
|
-
*
|
|
1874
1947
|
* Show blocking message in the card's content area. Should be used after the `manifestApplied` event or
|
|
1875
1948
|
* after the `cardReady` lifecycle hook in Component cards and Extensions.
|
|
1949
|
+
*
|
|
1950
|
+
* @experimental (since 1.114)
|
|
1876
1951
|
*/
|
|
1877
1952
|
showBlockingMessage(
|
|
1878
1953
|
/**
|
|
@@ -1892,11 +1967,11 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1892
1967
|
eCardArea?: CardArea | keyof typeof CardArea
|
|
1893
1968
|
): void;
|
|
1894
1969
|
/**
|
|
1895
|
-
* @experimental (since 1.81)
|
|
1896
|
-
*
|
|
1897
1970
|
* Displays a message strip above the content with the given text. There can be only 1 message displayed.
|
|
1898
1971
|
* If there is a previous message, it is removed. Can be used only after the `manifestApplied` event is
|
|
1899
1972
|
* fired.
|
|
1973
|
+
*
|
|
1974
|
+
* @experimental (since 1.81)
|
|
1900
1975
|
*/
|
|
1901
1976
|
showMessage(
|
|
1902
1977
|
/**
|
|
@@ -1909,8 +1984,6 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1909
1984
|
sType: MessageType
|
|
1910
1985
|
): void;
|
|
1911
1986
|
/**
|
|
1912
|
-
* @experimental (since 1.84)
|
|
1913
|
-
*
|
|
1914
1987
|
* Triggers an action inside the card.
|
|
1915
1988
|
*
|
|
1916
1989
|
* Use this method if you need to trigger an action programmatically from inside an `Extension` or from
|
|
@@ -1929,6 +2002,9 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1929
2002
|
* }
|
|
1930
2003
|
* });
|
|
1931
2004
|
* ```
|
|
2005
|
+
*
|
|
2006
|
+
*
|
|
2007
|
+
* @experimental (since 1.84)
|
|
1932
2008
|
*/
|
|
1933
2009
|
triggerAction(
|
|
1934
2010
|
/**
|
|
@@ -1946,29 +2022,29 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1946
2022
|
}
|
|
1947
2023
|
): void;
|
|
1948
2024
|
/**
|
|
1949
|
-
* @experimental
|
|
1950
|
-
*
|
|
1951
2025
|
* Causes all of the controls within the Card that support validation to validate their data.
|
|
1952
2026
|
*
|
|
2027
|
+
* @experimental
|
|
2028
|
+
*
|
|
1953
2029
|
* @returns if all of the controls validated successfully; otherwise, false
|
|
1954
2030
|
*/
|
|
1955
2031
|
validateControls(): boolean;
|
|
1956
2032
|
}
|
|
1957
2033
|
/**
|
|
1958
|
-
* @experimental (since 1.79)
|
|
1959
|
-
*
|
|
1960
2034
|
* Facade of the {@link sap.ui.integration.widgets.Card} control.
|
|
2035
|
+
*
|
|
2036
|
+
* @experimental (since 1.79)
|
|
1961
2037
|
*/
|
|
1962
2038
|
export interface CardFacade {
|
|
1963
2039
|
__implements__sap_ui_integration_widgets_CardFacade: boolean;
|
|
1964
2040
|
|
|
1965
2041
|
/**
|
|
2042
|
+
* Adds some actionDefinition to the aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
2043
|
+
*
|
|
1966
2044
|
* @since 1.85
|
|
1967
2045
|
* @experimental (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
|
|
1968
2046
|
* may be done before its official public release. Use at your own discretion.
|
|
1969
2047
|
*
|
|
1970
|
-
* Adds some actionDefinition to the aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
1971
|
-
*
|
|
1972
2048
|
* @returns Reference to `this` in order to allow method chaining
|
|
1973
2049
|
*/
|
|
1974
2050
|
addActionDefinition(
|
|
@@ -1978,28 +2054,26 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
1978
2054
|
oActionDefinition: ActionDefinition
|
|
1979
2055
|
): this;
|
|
1980
2056
|
/**
|
|
1981
|
-
* @since 1.70
|
|
1982
|
-
* @experimental (since 1.70)
|
|
1983
|
-
*
|
|
1984
2057
|
* Gets current value of property {@link #getBaseUrl baseUrl}.
|
|
1985
2058
|
*
|
|
1986
2059
|
* Defines the base URL of the card manifest. It should be used when manifest property is an object instead
|
|
1987
2060
|
* of a URL. If both manifest URL and base URL are defined - the base URL will be used for loading dependencies.
|
|
1988
2061
|
*
|
|
2062
|
+
* @since 1.70
|
|
2063
|
+
* @experimental (since 1.70)
|
|
2064
|
+
*
|
|
1989
2065
|
* @returns Value of property `baseUrl`
|
|
1990
2066
|
*/
|
|
1991
2067
|
getBaseUrl(): URI;
|
|
1992
2068
|
/**
|
|
1993
|
-
* @experimental (since 1.114)
|
|
1994
|
-
*
|
|
1995
2069
|
* Get information about the blocking message in the card.
|
|
1996
2070
|
*
|
|
2071
|
+
* @experimental (since 1.114)
|
|
2072
|
+
*
|
|
1997
2073
|
* @returns Information about the message or `null`, if such isn't shown.
|
|
1998
2074
|
*/
|
|
1999
2075
|
getBlockingMessage(): BlockingMessageSettings | null;
|
|
2000
2076
|
/**
|
|
2001
|
-
* @experimental (since 1.77)
|
|
2002
|
-
*
|
|
2003
2077
|
* Gets values of manifest parameters combined with the parameters from `parameters` property.
|
|
2004
2078
|
*
|
|
2005
2079
|
* **Notes**
|
|
@@ -2008,16 +2082,18 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
2008
2082
|
*
|
|
2009
2083
|
* - Use when developing a Component card.
|
|
2010
2084
|
*
|
|
2085
|
+
* @experimental (since 1.77)
|
|
2086
|
+
*
|
|
2011
2087
|
* @returns Object containing parameters in format `{parameterKey: parameterValue}`.
|
|
2012
2088
|
*/
|
|
2013
2089
|
getCombinedParameters(): Record<string, any>;
|
|
2014
2090
|
/**
|
|
2015
|
-
* @experimental (since 1.77)
|
|
2016
|
-
*
|
|
2017
2091
|
* Returns a value from the Manifest based on the specified path.
|
|
2018
2092
|
*
|
|
2019
2093
|
* **Note** Use this method when the manifest is ready. Check `manifestReady` event.
|
|
2020
2094
|
*
|
|
2095
|
+
* @experimental (since 1.77)
|
|
2096
|
+
*
|
|
2021
2097
|
* @returns The value at the specified path.
|
|
2022
2098
|
*/
|
|
2023
2099
|
getManifestEntry(
|
|
@@ -2027,23 +2103,23 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
2027
2103
|
sPath: string
|
|
2028
2104
|
): any;
|
|
2029
2105
|
/**
|
|
2030
|
-
* @experimental (since 1.65) - This property might be changed in future.
|
|
2031
|
-
*
|
|
2032
2106
|
* Gets current value of property {@link #getParameters parameters}.
|
|
2033
2107
|
*
|
|
2034
2108
|
* Overrides the default values of the parameters, which are defined in the manifest. The value is an object
|
|
2035
2109
|
* containing parameters in format `{parameterKey: parameterValue}`.
|
|
2036
2110
|
*
|
|
2111
|
+
* @experimental (since 1.65) - This property might be changed in future.
|
|
2112
|
+
*
|
|
2037
2113
|
* @returns Value of property `parameters`
|
|
2038
2114
|
*/
|
|
2039
2115
|
getParameters(): object;
|
|
2040
2116
|
/**
|
|
2041
|
-
* @experimental (since 1.83) - The API might change.
|
|
2042
|
-
*
|
|
2043
2117
|
* Gets translated text from the i18n properties files configured for this card.
|
|
2044
2118
|
*
|
|
2045
2119
|
* For more details see {@link module:sap/base/i18n/ResourceBundle#getText}.
|
|
2046
2120
|
*
|
|
2121
|
+
* @experimental (since 1.83) - The API might change.
|
|
2122
|
+
*
|
|
2047
2123
|
* @returns The value belonging to the key, if found; otherwise the key itself or `undefined` depending
|
|
2048
2124
|
* on `bIgnoreKeyFallback`.
|
|
2049
2125
|
*/
|
|
@@ -2066,9 +2142,9 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
2066
2142
|
bIgnoreKeyFallback?: boolean
|
|
2067
2143
|
): string;
|
|
2068
2144
|
/**
|
|
2069
|
-
* @experimental (since 1.114)
|
|
2070
|
-
*
|
|
2071
2145
|
* Hide the blocking message that is shown in the card by `showBlockingMessage` call.
|
|
2146
|
+
*
|
|
2147
|
+
* @experimental (since 1.114)
|
|
2072
2148
|
*/
|
|
2073
2149
|
hideBlockingMessage(): void;
|
|
2074
2150
|
/**
|
|
@@ -2082,19 +2158,19 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
2082
2158
|
eCardArea?: CardArea | keyof typeof CardArea
|
|
2083
2159
|
): void;
|
|
2084
2160
|
/**
|
|
2085
|
-
* @experimental (since 1.117)
|
|
2086
|
-
*
|
|
2087
2161
|
* Hides the message previously shown by showMessage.
|
|
2162
|
+
*
|
|
2163
|
+
* @experimental (since 1.117)
|
|
2088
2164
|
*/
|
|
2089
2165
|
hideMessage(): void;
|
|
2090
2166
|
/**
|
|
2167
|
+
* Checks for the provided `sap.ui.integration.ActionDefinition` in the aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
2168
|
+
* and returns its index if found or -1 otherwise.
|
|
2169
|
+
*
|
|
2091
2170
|
* @since 1.85
|
|
2092
2171
|
* @experimental (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
|
|
2093
2172
|
* may be done before its official public release. Use at your own discretion.
|
|
2094
2173
|
*
|
|
2095
|
-
* Checks for the provided `sap.ui.integration.ActionDefinition` in the aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
2096
|
-
* and returns its index if found or -1 otherwise.
|
|
2097
|
-
*
|
|
2098
2174
|
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
2099
2175
|
*/
|
|
2100
2176
|
indexOfActionDefinition(
|
|
@@ -2104,12 +2180,12 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
2104
2180
|
oActionDefinition: ActionDefinition
|
|
2105
2181
|
): int;
|
|
2106
2182
|
/**
|
|
2183
|
+
* Inserts a actionDefinition into the aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
2184
|
+
*
|
|
2107
2185
|
* @since 1.85
|
|
2108
2186
|
* @experimental (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
|
|
2109
2187
|
* may be done before its official public release. Use at your own discretion.
|
|
2110
2188
|
*
|
|
2111
|
-
* Inserts a actionDefinition into the aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
2112
|
-
*
|
|
2113
2189
|
* @returns Reference to `this` in order to allow method chaining
|
|
2114
2190
|
*/
|
|
2115
2191
|
insertActionDefinition(
|
|
@@ -2125,24 +2201,24 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
2125
2201
|
iIndex: int
|
|
2126
2202
|
): this;
|
|
2127
2203
|
/**
|
|
2128
|
-
* @experimental (since 1.65) - The API might change.
|
|
2129
|
-
*
|
|
2130
2204
|
* Refreshes the card by re-applying the manifest settings and triggering all data requests.
|
|
2205
|
+
*
|
|
2206
|
+
* @experimental (since 1.65) - The API might change.
|
|
2131
2207
|
*/
|
|
2132
2208
|
refresh(): void;
|
|
2133
2209
|
/**
|
|
2134
|
-
* @since 1.95
|
|
2135
|
-
*
|
|
2136
2210
|
* Refreshes the card data by triggering all data requests.
|
|
2211
|
+
*
|
|
2212
|
+
* @since 1.95
|
|
2137
2213
|
*/
|
|
2138
2214
|
refreshData(): void;
|
|
2139
2215
|
/**
|
|
2216
|
+
* Removes a actionDefinition from the aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
2217
|
+
*
|
|
2140
2218
|
* @since 1.85
|
|
2141
2219
|
* @experimental (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
|
|
2142
2220
|
* may be done before its official public release. Use at your own discretion.
|
|
2143
2221
|
*
|
|
2144
|
-
* Removes a actionDefinition from the aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
2145
|
-
*
|
|
2146
2222
|
* @returns The removed actionDefinition or `null`
|
|
2147
2223
|
*/
|
|
2148
2224
|
removeActionDefinition(
|
|
@@ -2152,10 +2228,10 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
2152
2228
|
vActionDefinition: int | string | ActionDefinition
|
|
2153
2229
|
): ActionDefinition | null;
|
|
2154
2230
|
/**
|
|
2155
|
-
* @experimental (since 1.79)
|
|
2156
|
-
*
|
|
2157
2231
|
* Performs an HTTP request using the given configuration.
|
|
2158
2232
|
*
|
|
2233
|
+
* @experimental (since 1.79)
|
|
2234
|
+
*
|
|
2159
2235
|
* @returns Resolves when the request is successful, rejects otherwise.
|
|
2160
2236
|
*/
|
|
2161
2237
|
request(
|
|
@@ -2197,6 +2273,7 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
2197
2273
|
/**
|
|
2198
2274
|
* Resolves the destination and returns its URL.
|
|
2199
2275
|
*
|
|
2276
|
+
*
|
|
2200
2277
|
* @returns A promise which resolves with the URL of the destination.
|
|
2201
2278
|
*/
|
|
2202
2279
|
resolveDestination(
|
|
@@ -2206,10 +2283,10 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
2206
2283
|
sKey: string
|
|
2207
2284
|
): Promise<string>;
|
|
2208
2285
|
/**
|
|
2209
|
-
* @experimental (since 1.114)
|
|
2210
|
-
*
|
|
2211
2286
|
* Show blocking message in the card's content area. Should be used after the `manifestApplied` event or
|
|
2212
2287
|
* after the `cardReady` lifecycle hook in Component cards and Extensions.
|
|
2288
|
+
*
|
|
2289
|
+
* @experimental (since 1.114)
|
|
2213
2290
|
*/
|
|
2214
2291
|
showBlockingMessage(
|
|
2215
2292
|
/**
|
|
@@ -2229,11 +2306,11 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
2229
2306
|
eCardArea?: CardArea | keyof typeof CardArea
|
|
2230
2307
|
): void;
|
|
2231
2308
|
/**
|
|
2232
|
-
* @experimental (since 1.81)
|
|
2233
|
-
*
|
|
2234
2309
|
* Displays a message strip above the content with the given text. There can be only 1 message displayed.
|
|
2235
2310
|
* If there is a previous message, it is removed. Can be used only after the `manifestApplied` event is
|
|
2236
2311
|
* fired.
|
|
2312
|
+
*
|
|
2313
|
+
* @experimental (since 1.81)
|
|
2237
2314
|
*/
|
|
2238
2315
|
showMessage(
|
|
2239
2316
|
/**
|
|
@@ -2246,8 +2323,6 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
2246
2323
|
sType: MessageType
|
|
2247
2324
|
): void;
|
|
2248
2325
|
/**
|
|
2249
|
-
* @experimental (since 1.84)
|
|
2250
|
-
*
|
|
2251
2326
|
* Triggers an action inside the card.
|
|
2252
2327
|
*
|
|
2253
2328
|
* Use this method if you need to trigger an action programmatically from inside an `Extension` or from
|
|
@@ -2266,6 +2341,9 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
2266
2341
|
* }
|
|
2267
2342
|
* });
|
|
2268
2343
|
* ```
|
|
2344
|
+
*
|
|
2345
|
+
*
|
|
2346
|
+
* @experimental (since 1.84)
|
|
2269
2347
|
*/
|
|
2270
2348
|
triggerAction(
|
|
2271
2349
|
/**
|
|
@@ -2283,10 +2361,10 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
2283
2361
|
}
|
|
2284
2362
|
): void;
|
|
2285
2363
|
/**
|
|
2286
|
-
* @experimental
|
|
2287
|
-
*
|
|
2288
2364
|
* Causes all of the controls within the Card that support validation to validate their data.
|
|
2289
2365
|
*
|
|
2366
|
+
* @experimental
|
|
2367
|
+
*
|
|
2290
2368
|
* @returns if all of the controls validated successfully; otherwise, false
|
|
2291
2369
|
*/
|
|
2292
2370
|
validateControls(): boolean;
|
|
@@ -2305,18 +2383,18 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
2305
2383
|
manifest?: any | PropertyBindingInfo | `{${string}}`;
|
|
2306
2384
|
|
|
2307
2385
|
/**
|
|
2308
|
-
* @experimental (since 1.65) - This property might be changed in future.
|
|
2309
|
-
*
|
|
2310
2386
|
* Overrides the default values of the parameters, which are defined in the manifest. The value is an object
|
|
2311
2387
|
* containing parameters in format `{parameterKey: parameterValue}`.
|
|
2388
|
+
*
|
|
2389
|
+
* @experimental (since 1.65) - This property might be changed in future.
|
|
2312
2390
|
*/
|
|
2313
2391
|
parameters?: object | PropertyBindingInfo | `{${string}}`;
|
|
2314
2392
|
|
|
2315
2393
|
/**
|
|
2394
|
+
* Defines the state of the `Card`. When set to `Inactive`, the `Card` doesn't make requests.
|
|
2395
|
+
*
|
|
2316
2396
|
* @since 1.65
|
|
2317
2397
|
* @experimental (since 1.65)
|
|
2318
|
-
*
|
|
2319
|
-
* Defines the state of the `Card`. When set to `Inactive`, the `Card` doesn't make requests.
|
|
2320
2398
|
*/
|
|
2321
2399
|
dataMode?:
|
|
2322
2400
|
| (CardDataMode | keyof typeof CardDataMode)
|
|
@@ -2324,19 +2402,15 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
2324
2402
|
| `{${string}}`;
|
|
2325
2403
|
|
|
2326
2404
|
/**
|
|
2327
|
-
* @since 1.70
|
|
2328
|
-
* @experimental (since 1.70)
|
|
2329
|
-
*
|
|
2330
2405
|
* Defines the base URL of the card manifest. It should be used when manifest property is an object instead
|
|
2331
2406
|
* of a URL. If both manifest URL and base URL are defined - the base URL will be used for loading dependencies.
|
|
2407
|
+
*
|
|
2408
|
+
* @since 1.70
|
|
2409
|
+
* @experimental (since 1.70)
|
|
2332
2410
|
*/
|
|
2333
2411
|
baseUrl?: URI | PropertyBindingInfo | `{${string}}`;
|
|
2334
2412
|
|
|
2335
2413
|
/**
|
|
2336
|
-
* @since 1.76
|
|
2337
|
-
* @experimental (since 1.76) - This API might be removed when a permanent solution for flexibility changes
|
|
2338
|
-
* is implemented.
|
|
2339
|
-
*
|
|
2340
2414
|
* Defines a list of configuration settings, which will be merged into the original manifest.
|
|
2341
2415
|
*
|
|
2342
2416
|
* This can be a list of flexibility changes generated during designtime.
|
|
@@ -2372,14 +2446,19 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
2372
2446
|
* }
|
|
2373
2447
|
* ]
|
|
2374
2448
|
* ```
|
|
2449
|
+
*
|
|
2450
|
+
*
|
|
2451
|
+
* @since 1.76
|
|
2452
|
+
* @experimental (since 1.76) - This API might be removed when a permanent solution for flexibility changes
|
|
2453
|
+
* is implemented.
|
|
2375
2454
|
*/
|
|
2376
2455
|
manifestChanges?: object[] | PropertyBindingInfo | `{${string}}`;
|
|
2377
2456
|
|
|
2378
2457
|
/**
|
|
2458
|
+
* Defines the design of the `Card`.
|
|
2459
|
+
*
|
|
2379
2460
|
* @since 1.109
|
|
2380
2461
|
* @experimental (since 1.109)
|
|
2381
|
-
*
|
|
2382
|
-
* Defines the design of the `Card`.
|
|
2383
2462
|
*/
|
|
2384
2463
|
design?:
|
|
2385
2464
|
| (CardDesign | keyof typeof CardDesign)
|
|
@@ -2387,10 +2466,10 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
2387
2466
|
| `{${string}}`;
|
|
2388
2467
|
|
|
2389
2468
|
/**
|
|
2469
|
+
* Defines the display variant for card rendering and behavior.
|
|
2470
|
+
*
|
|
2390
2471
|
* @since 1.118
|
|
2391
2472
|
* @experimental (since 1.118) - For usage only by Work Zone.
|
|
2392
|
-
*
|
|
2393
|
-
* Defines the display variant for card rendering and behavior.
|
|
2394
2473
|
*/
|
|
2395
2474
|
displayVariant?:
|
|
2396
2475
|
| (CardDisplayVariant | keyof typeof CardDisplayVariant)
|
|
@@ -2398,15 +2477,15 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
2398
2477
|
| `{${string}}`;
|
|
2399
2478
|
|
|
2400
2479
|
/**
|
|
2401
|
-
* @since 1.112
|
|
2402
|
-
* @experimental (since 1.112)
|
|
2403
|
-
*
|
|
2404
2480
|
* Preview mode of the `Card`. Helpful in scenarios when the end user is choosing or configuring a card.
|
|
2405
2481
|
*
|
|
2406
2482
|
* - When set to "MockData", the card data is loaded, using a data request, as configured in the "data/mockData"
|
|
2407
2483
|
* in the manifest. If such configuration is missing, then the Abstract mode will be used instead.
|
|
2408
2484
|
* - When set to "Abstract", the card shows abstract placeholder without loading data.
|
|
2409
2485
|
* - When set to "Off", the card displays real data.
|
|
2486
|
+
*
|
|
2487
|
+
* @since 1.112
|
|
2488
|
+
* @experimental (since 1.112)
|
|
2410
2489
|
*/
|
|
2411
2490
|
previewMode?:
|
|
2412
2491
|
| (CardPreviewMode | keyof typeof CardPreviewMode)
|
|
@@ -2414,12 +2493,12 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
2414
2493
|
| `{${string}}`;
|
|
2415
2494
|
|
|
2416
2495
|
/**
|
|
2496
|
+
* Actions definitions from which actions in the header menu of the card are created. **Note**: This aggregation
|
|
2497
|
+
* is destroyed when the property `manifest` changes.
|
|
2498
|
+
*
|
|
2417
2499
|
* @since 1.85
|
|
2418
2500
|
* @experimental (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
|
|
2419
2501
|
* may be done before its official public release. Use at your own discretion.
|
|
2420
|
-
*
|
|
2421
|
-
* Actions definitions from which actions in the header menu of the card are created. **Note**: This aggregation
|
|
2422
|
-
* is destroyed when the property `manifest` changes.
|
|
2423
2502
|
*/
|
|
2424
2503
|
actionDefinitions?:
|
|
2425
2504
|
| ActionDefinition[]
|
|
@@ -2433,29 +2512,29 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
2433
2512
|
host?: Control | string;
|
|
2434
2513
|
|
|
2435
2514
|
/**
|
|
2436
|
-
* @experimental (since 1.64) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
2437
|
-
* be done before its official public release. Use at your own discretion.
|
|
2438
|
-
*
|
|
2439
2515
|
* Fired when an action is triggered on the card.
|
|
2440
2516
|
*
|
|
2441
2517
|
* When an action is triggered in the card it can be handled on several places by "action" event handlers.
|
|
2442
2518
|
* In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
|
|
2443
2519
|
* one to handle the action by calling `oEvent.preventDefault()`.
|
|
2520
|
+
*
|
|
2521
|
+
* @experimental (since 1.64) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
2522
|
+
* be done before its official public release. Use at your own discretion.
|
|
2444
2523
|
*/
|
|
2445
2524
|
action?: (oEvent: Card$ActionEvent) => void;
|
|
2446
2525
|
|
|
2447
2526
|
/**
|
|
2448
|
-
* @experimental (since 1.96)
|
|
2449
|
-
*
|
|
2450
2527
|
* Fired when some configuration settings are changed as a result of user interaction. For example - filter
|
|
2451
2528
|
* value is changed.
|
|
2529
|
+
*
|
|
2530
|
+
* @experimental (since 1.96)
|
|
2452
2531
|
*/
|
|
2453
2532
|
configurationChange?: (oEvent: Card$ConfigurationChangeEvent) => void;
|
|
2454
2533
|
|
|
2455
2534
|
/**
|
|
2456
|
-
* @experimental (since 1.72)
|
|
2457
|
-
*
|
|
2458
2535
|
* Fired when the manifest is loaded.
|
|
2536
|
+
*
|
|
2537
|
+
* @experimental (since 1.72)
|
|
2459
2538
|
*/
|
|
2460
2539
|
manifestReady?: (oEvent: Event) => void;
|
|
2461
2540
|
|
|
@@ -2468,10 +2547,10 @@ declare module "sap/ui/integration/widgets/Card" {
|
|
|
2468
2547
|
manifestApplied?: (oEvent: Event) => void;
|
|
2469
2548
|
|
|
2470
2549
|
/**
|
|
2471
|
-
* @experimental (since 1.107)
|
|
2472
|
-
*
|
|
2473
2550
|
* Fired when the state of the card is changed. For example - the card is ready, new page is selected, a
|
|
2474
2551
|
* filter is changed or data is refreshed.
|
|
2552
|
+
*
|
|
2553
|
+
* @experimental (since 1.107)
|
|
2475
2554
|
*/
|
|
2476
2555
|
stateChanged?: (oEvent: Event) => void;
|
|
2477
2556
|
}
|
|
@@ -2554,11 +2633,11 @@ declare module "sap/ui/integration/Designtime" {
|
|
|
2554
2633
|
import ManagedObjectMetadata from "sap/ui/base/ManagedObjectMetadata";
|
|
2555
2634
|
|
|
2556
2635
|
/**
|
|
2557
|
-
* @since 1.75
|
|
2558
|
-
* @experimental (since 1.75)
|
|
2559
|
-
*
|
|
2560
2636
|
* Brings JavaScript capabilities for an {@link sap.ui.integration.widgets.Card} where custom logic can
|
|
2561
2637
|
* be implemented.
|
|
2638
|
+
*
|
|
2639
|
+
* @since 1.75
|
|
2640
|
+
* @experimental (since 1.75)
|
|
2562
2641
|
*/
|
|
2563
2642
|
export default class Designtime extends ManagedObject {
|
|
2564
2643
|
/**
|
|
@@ -2604,6 +2683,7 @@ declare module "sap/ui/integration/Designtime" {
|
|
|
2604
2683
|
*
|
|
2605
2684
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.ManagedObject.extend}.
|
|
2606
2685
|
*
|
|
2686
|
+
*
|
|
2607
2687
|
* @returns Created class / constructor function
|
|
2608
2688
|
*/
|
|
2609
2689
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -2624,12 +2704,14 @@ declare module "sap/ui/integration/Designtime" {
|
|
|
2624
2704
|
/**
|
|
2625
2705
|
* Returns a metadata object for class sap.ui.integration.Designtime.
|
|
2626
2706
|
*
|
|
2707
|
+
*
|
|
2627
2708
|
* @returns Metadata object describing this class
|
|
2628
2709
|
*/
|
|
2629
2710
|
static getMetadata(): ManagedObjectMetadata;
|
|
2630
2711
|
/**
|
|
2631
2712
|
* Returns an interface to the card, which uses this extension.
|
|
2632
2713
|
*
|
|
2714
|
+
*
|
|
2633
2715
|
* @returns An interface to the card.
|
|
2634
2716
|
*/
|
|
2635
2717
|
getCard(): CardFacade;
|
|
@@ -2640,15 +2722,16 @@ declare module "sap/ui/integration/Designtime" {
|
|
|
2640
2722
|
|
|
2641
2723
|
declare module "sap/ui/integration/designtime/baseEditor/validator/IsBoolean" {
|
|
2642
2724
|
/**
|
|
2725
|
+
* Validates if the provided value is a boolean or binding string.
|
|
2726
|
+
*
|
|
2643
2727
|
* @since 1.81
|
|
2644
2728
|
* @experimental - 1.81
|
|
2645
|
-
*
|
|
2646
|
-
* Validates if the provided value is a boolean or binding string.
|
|
2647
2729
|
*/
|
|
2648
2730
|
interface IsBoolean {
|
|
2649
2731
|
/**
|
|
2650
2732
|
* Validator function
|
|
2651
2733
|
*
|
|
2734
|
+
*
|
|
2652
2735
|
* @returns Validation result
|
|
2653
2736
|
*/
|
|
2654
2737
|
validate(
|
|
@@ -2664,15 +2747,16 @@ declare module "sap/ui/integration/designtime/baseEditor/validator/IsBoolean" {
|
|
|
2664
2747
|
|
|
2665
2748
|
declare module "sap/ui/integration/designtime/baseEditor/validator/IsDate" {
|
|
2666
2749
|
/**
|
|
2750
|
+
* Validates if the provided value can be parsed to a valid date.
|
|
2751
|
+
*
|
|
2667
2752
|
* @since 1.81
|
|
2668
2753
|
* @experimental - 1.81
|
|
2669
|
-
*
|
|
2670
|
-
* Validates if the provided value can be parsed to a valid date.
|
|
2671
2754
|
*/
|
|
2672
2755
|
interface IsDate {
|
|
2673
2756
|
/**
|
|
2674
2757
|
* Validator function
|
|
2675
2758
|
*
|
|
2759
|
+
*
|
|
2676
2760
|
* @returns Validation result
|
|
2677
2761
|
*/
|
|
2678
2762
|
validate(
|
|
@@ -2688,15 +2772,16 @@ declare module "sap/ui/integration/designtime/baseEditor/validator/IsDate" {
|
|
|
2688
2772
|
|
|
2689
2773
|
declare module "sap/ui/integration/designtime/baseEditor/validator/IsInteger" {
|
|
2690
2774
|
/**
|
|
2775
|
+
* Validates if the provided value is an integer or binding string.
|
|
2776
|
+
*
|
|
2691
2777
|
* @since 1.81
|
|
2692
2778
|
* @experimental - 1.81
|
|
2693
|
-
*
|
|
2694
|
-
* Validates if the provided value is an integer or binding string.
|
|
2695
2779
|
*/
|
|
2696
2780
|
interface IsInteger {
|
|
2697
2781
|
/**
|
|
2698
2782
|
* Validator function
|
|
2699
2783
|
*
|
|
2784
|
+
*
|
|
2700
2785
|
* @returns Validation result
|
|
2701
2786
|
*/
|
|
2702
2787
|
validate(
|
|
@@ -2712,15 +2797,16 @@ declare module "sap/ui/integration/designtime/baseEditor/validator/IsInteger" {
|
|
|
2712
2797
|
|
|
2713
2798
|
declare module "sap/ui/integration/designtime/baseEditor/validator/IsNumber" {
|
|
2714
2799
|
/**
|
|
2800
|
+
* Validates if the provided value is a number or binding string.
|
|
2801
|
+
*
|
|
2715
2802
|
* @since 1.81
|
|
2716
2803
|
* @experimental - 1.81
|
|
2717
|
-
*
|
|
2718
|
-
* Validates if the provided value is a number or binding string.
|
|
2719
2804
|
*/
|
|
2720
2805
|
interface IsNumber {
|
|
2721
2806
|
/**
|
|
2722
2807
|
* Validator function
|
|
2723
2808
|
*
|
|
2809
|
+
*
|
|
2724
2810
|
* @returns Validation result
|
|
2725
2811
|
*/
|
|
2726
2812
|
validate(
|
|
@@ -2736,15 +2822,16 @@ declare module "sap/ui/integration/designtime/baseEditor/validator/IsNumber" {
|
|
|
2736
2822
|
|
|
2737
2823
|
declare module "sap/ui/integration/designtime/baseEditor/validator/IsSelectedKey" {
|
|
2738
2824
|
/**
|
|
2825
|
+
* Validates if the provided value is one of the given keys.
|
|
2826
|
+
*
|
|
2739
2827
|
* @since 1.81
|
|
2740
2828
|
* @experimental - 1.81
|
|
2741
|
-
*
|
|
2742
|
-
* Validates if the provided value is one of the given keys.
|
|
2743
2829
|
*/
|
|
2744
2830
|
interface IsSelectedKey {
|
|
2745
2831
|
/**
|
|
2746
2832
|
* Validator function
|
|
2747
2833
|
*
|
|
2834
|
+
*
|
|
2748
2835
|
* @returns Validation result
|
|
2749
2836
|
*/
|
|
2750
2837
|
validate(
|
|
@@ -2769,15 +2856,16 @@ declare module "sap/ui/integration/designtime/baseEditor/validator/IsSelectedKey
|
|
|
2769
2856
|
|
|
2770
2857
|
declare module "sap/ui/integration/designtime/baseEditor/validator/IsStringList" {
|
|
2771
2858
|
/**
|
|
2859
|
+
* Validates if none of the provided values is an invalid binding.
|
|
2860
|
+
*
|
|
2772
2861
|
* @since 1.81
|
|
2773
2862
|
* @experimental - 1.81
|
|
2774
|
-
*
|
|
2775
|
-
* Validates if none of the provided values is an invalid binding.
|
|
2776
2863
|
*/
|
|
2777
2864
|
interface IsStringList {
|
|
2778
2865
|
/**
|
|
2779
2866
|
* Validator function
|
|
2780
2867
|
*
|
|
2868
|
+
*
|
|
2781
2869
|
* @returns Validation result
|
|
2782
2870
|
*/
|
|
2783
2871
|
validate(
|
|
@@ -2793,15 +2881,16 @@ declare module "sap/ui/integration/designtime/baseEditor/validator/IsStringList"
|
|
|
2793
2881
|
|
|
2794
2882
|
declare module "sap/ui/integration/designtime/baseEditor/validator/IsUniqueKey" {
|
|
2795
2883
|
/**
|
|
2884
|
+
* Validates if the provided key is unique in a list of given keys.
|
|
2885
|
+
*
|
|
2796
2886
|
* @since 1.81
|
|
2797
2887
|
* @experimental - 1.81
|
|
2798
|
-
*
|
|
2799
|
-
* Validates if the provided key is unique in a list of given keys.
|
|
2800
2888
|
*/
|
|
2801
2889
|
interface IsUniqueKey {
|
|
2802
2890
|
/**
|
|
2803
2891
|
* Validator function
|
|
2804
2892
|
*
|
|
2893
|
+
*
|
|
2805
2894
|
* @returns Validation result
|
|
2806
2895
|
*/
|
|
2807
2896
|
validate(
|
|
@@ -2830,15 +2919,16 @@ declare module "sap/ui/integration/designtime/baseEditor/validator/IsUniqueKey"
|
|
|
2830
2919
|
|
|
2831
2920
|
declare module "sap/ui/integration/designtime/baseEditor/validator/IsUniqueList" {
|
|
2832
2921
|
/**
|
|
2922
|
+
* Validates if the provided list contains no duplicates.
|
|
2923
|
+
*
|
|
2833
2924
|
* @since 1.81
|
|
2834
2925
|
* @experimental - 1.81
|
|
2835
|
-
*
|
|
2836
|
-
* Validates if the provided list contains no duplicates.
|
|
2837
2926
|
*/
|
|
2838
2927
|
interface IsUniqueList {
|
|
2839
2928
|
/**
|
|
2840
2929
|
* Validator function
|
|
2841
2930
|
*
|
|
2931
|
+
*
|
|
2842
2932
|
* @returns Validation result
|
|
2843
2933
|
*/
|
|
2844
2934
|
validate(
|
|
@@ -2854,15 +2944,16 @@ declare module "sap/ui/integration/designtime/baseEditor/validator/IsUniqueList"
|
|
|
2854
2944
|
|
|
2855
2945
|
declare module "sap/ui/integration/designtime/baseEditor/validator/IsValidBinding" {
|
|
2856
2946
|
/**
|
|
2947
|
+
* Validates if the provided value is a valid binding.
|
|
2948
|
+
*
|
|
2857
2949
|
* @since 1.81
|
|
2858
2950
|
* @experimental - 1.81
|
|
2859
|
-
*
|
|
2860
|
-
* Validates if the provided value is a valid binding.
|
|
2861
2951
|
*/
|
|
2862
2952
|
interface IsValidBinding {
|
|
2863
2953
|
/**
|
|
2864
2954
|
* Validator function
|
|
2865
2955
|
*
|
|
2956
|
+
*
|
|
2866
2957
|
* @returns Validation result
|
|
2867
2958
|
*/
|
|
2868
2959
|
validate(
|
|
@@ -2887,15 +2978,16 @@ declare module "sap/ui/integration/designtime/baseEditor/validator/IsValidBindin
|
|
|
2887
2978
|
|
|
2888
2979
|
declare module "sap/ui/integration/designtime/baseEditor/validator/MaxLength" {
|
|
2889
2980
|
/**
|
|
2981
|
+
* Validates if the provided value doesn't exceed the maximum length.
|
|
2982
|
+
*
|
|
2890
2983
|
* @since 1.81
|
|
2891
2984
|
* @experimental - 1.81
|
|
2892
|
-
*
|
|
2893
|
-
* Validates if the provided value doesn't exceed the maximum length.
|
|
2894
2985
|
*/
|
|
2895
2986
|
interface MaxLength {
|
|
2896
2987
|
/**
|
|
2897
2988
|
* Validator function
|
|
2898
2989
|
*
|
|
2990
|
+
*
|
|
2899
2991
|
* @returns Validation result
|
|
2900
2992
|
*/
|
|
2901
2993
|
validate(
|
|
@@ -2911,15 +3003,16 @@ declare module "sap/ui/integration/designtime/baseEditor/validator/MaxLength" {
|
|
|
2911
3003
|
|
|
2912
3004
|
declare module "sap/ui/integration/designtime/baseEditor/validator/NotABinding" {
|
|
2913
3005
|
/**
|
|
3006
|
+
* Validates if the provided value doesn't contain a binding.
|
|
3007
|
+
*
|
|
2914
3008
|
* @since 1.81
|
|
2915
3009
|
* @experimental - 1.81
|
|
2916
|
-
*
|
|
2917
|
-
* Validates if the provided value doesn't contain a binding.
|
|
2918
3010
|
*/
|
|
2919
3011
|
interface NotABinding {
|
|
2920
3012
|
/**
|
|
2921
3013
|
* Validator function
|
|
2922
3014
|
*
|
|
3015
|
+
*
|
|
2923
3016
|
* @returns Validation result
|
|
2924
3017
|
*/
|
|
2925
3018
|
validate(
|
|
@@ -2934,19 +3027,19 @@ declare module "sap/ui/integration/designtime/baseEditor/validator/NotABinding"
|
|
|
2934
3027
|
}
|
|
2935
3028
|
|
|
2936
3029
|
declare module "sap/ui/integration/editor/Editor" {
|
|
2937
|
-
/**
|
|
2938
|
-
* @experimental (since 1.94)
|
|
2939
|
-
*
|
|
3030
|
+
/**
|
|
2940
3031
|
* Facade of the {@link sap.ui.integration.editor.Editor} control.
|
|
3032
|
+
*
|
|
3033
|
+
* @experimental (since 1.94)
|
|
2941
3034
|
*/
|
|
2942
3035
|
export interface EditorFacade {
|
|
2943
3036
|
__implements__sap_ui_integration_editor_EditorFacade: boolean;
|
|
2944
3037
|
|
|
2945
3038
|
/**
|
|
2946
|
-
* @experimental (since 1.94)
|
|
2947
|
-
*
|
|
2948
3039
|
* Performs an HTTP request using the given configuration.
|
|
2949
3040
|
*
|
|
3041
|
+
* @experimental (since 1.94)
|
|
3042
|
+
*
|
|
2950
3043
|
* @returns Resolves when the request is successful, rejects otherwise.
|
|
2951
3044
|
*/
|
|
2952
3045
|
request(
|
|
@@ -2999,10 +3092,10 @@ declare module "sap/ui/integration/editor/Extension" {
|
|
|
2999
3092
|
import { CardFacade } from "sap/ui/integration/widgets/Card";
|
|
3000
3093
|
|
|
3001
3094
|
/**
|
|
3002
|
-
* @since 1.94
|
|
3003
|
-
*
|
|
3004
3095
|
* Brings JavaScript capabilities for an {@link sap.ui.integration.editor.Editor} where custom logic can
|
|
3005
3096
|
* be implemented.
|
|
3097
|
+
*
|
|
3098
|
+
* @since 1.94
|
|
3006
3099
|
*/
|
|
3007
3100
|
export default class Extension extends Extension1 {
|
|
3008
3101
|
/**
|
|
@@ -3031,6 +3124,7 @@ declare module "sap/ui/integration/editor/Extension" {
|
|
|
3031
3124
|
/**
|
|
3032
3125
|
* Returns an interface to the editor, which uses this extension.
|
|
3033
3126
|
*
|
|
3127
|
+
*
|
|
3034
3128
|
* @returns An interface to the card.
|
|
3035
3129
|
*/
|
|
3036
3130
|
getEditor(): CardFacade;
|
|
@@ -3061,10 +3155,10 @@ declare module "sap/ui/integration/Extension" {
|
|
|
3061
3155
|
import Event from "sap/ui/base/Event";
|
|
3062
3156
|
|
|
3063
3157
|
/**
|
|
3064
|
-
* @since 1.75
|
|
3065
|
-
*
|
|
3066
3158
|
* Brings JavaScript capabilities for an {@link sap.ui.integration.widgets.Card} where custom logic can
|
|
3067
3159
|
* be implemented.
|
|
3160
|
+
*
|
|
3161
|
+
* @since 1.75
|
|
3068
3162
|
*/
|
|
3069
3163
|
export default class Extension extends ManagedObject {
|
|
3070
3164
|
/**
|
|
@@ -3104,6 +3198,7 @@ declare module "sap/ui/integration/Extension" {
|
|
|
3104
3198
|
*
|
|
3105
3199
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.ManagedObject.extend}.
|
|
3106
3200
|
*
|
|
3201
|
+
*
|
|
3107
3202
|
* @returns Created class / constructor function
|
|
3108
3203
|
*/
|
|
3109
3204
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -3124,13 +3219,11 @@ declare module "sap/ui/integration/Extension" {
|
|
|
3124
3219
|
/**
|
|
3125
3220
|
* Returns a metadata object for class sap.ui.integration.Extension.
|
|
3126
3221
|
*
|
|
3222
|
+
*
|
|
3127
3223
|
* @returns Metadata object describing this class
|
|
3128
3224
|
*/
|
|
3129
3225
|
static getMetadata(): ManagedObjectMetadata;
|
|
3130
3226
|
/**
|
|
3131
|
-
* @experimental (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
3132
|
-
* be done before its official public release. Use at your own discretion.
|
|
3133
|
-
*
|
|
3134
3227
|
* Attaches event handler `fnFunction` to the {@link #event:action action} event of this `sap.ui.integration.Extension`.
|
|
3135
3228
|
*
|
|
3136
3229
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
@@ -3142,6 +3235,9 @@ declare module "sap/ui/integration/Extension" {
|
|
|
3142
3235
|
* In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
|
|
3143
3236
|
* one to handle the action by calling `oEvent.preventDefault()`.
|
|
3144
3237
|
*
|
|
3238
|
+
* @experimental (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
3239
|
+
* be done before its official public release. Use at your own discretion.
|
|
3240
|
+
*
|
|
3145
3241
|
* @returns Reference to `this` in order to allow method chaining
|
|
3146
3242
|
*/
|
|
3147
3243
|
attachAction(
|
|
@@ -3160,9 +3256,6 @@ declare module "sap/ui/integration/Extension" {
|
|
|
3160
3256
|
oListener?: object
|
|
3161
3257
|
): this;
|
|
3162
3258
|
/**
|
|
3163
|
-
* @experimental (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
3164
|
-
* be done before its official public release. Use at your own discretion.
|
|
3165
|
-
*
|
|
3166
3259
|
* Attaches event handler `fnFunction` to the {@link #event:action action} event of this `sap.ui.integration.Extension`.
|
|
3167
3260
|
*
|
|
3168
3261
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
@@ -3174,6 +3267,9 @@ declare module "sap/ui/integration/Extension" {
|
|
|
3174
3267
|
* In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
|
|
3175
3268
|
* one to handle the action by calling `oEvent.preventDefault()`.
|
|
3176
3269
|
*
|
|
3270
|
+
* @experimental (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
3271
|
+
* be done before its official public release. Use at your own discretion.
|
|
3272
|
+
*
|
|
3177
3273
|
* @returns Reference to `this` in order to allow method chaining
|
|
3178
3274
|
*/
|
|
3179
3275
|
attachAction(
|
|
@@ -3187,13 +3283,13 @@ declare module "sap/ui/integration/Extension" {
|
|
|
3187
3283
|
oListener?: object
|
|
3188
3284
|
): this;
|
|
3189
3285
|
/**
|
|
3190
|
-
* @experimental (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
3191
|
-
* be done before its official public release. Use at your own discretion.
|
|
3192
|
-
*
|
|
3193
3286
|
* Detaches event handler `fnFunction` from the {@link #event:action action} event of this `sap.ui.integration.Extension`.
|
|
3194
3287
|
*
|
|
3195
3288
|
* The passed function and listener object must match the ones used for event registration.
|
|
3196
3289
|
*
|
|
3290
|
+
* @experimental (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
3291
|
+
* be done before its official public release. Use at your own discretion.
|
|
3292
|
+
*
|
|
3197
3293
|
* @returns Reference to `this` in order to allow method chaining
|
|
3198
3294
|
*/
|
|
3199
3295
|
detachAction(
|
|
@@ -3207,12 +3303,12 @@ declare module "sap/ui/integration/Extension" {
|
|
|
3207
3303
|
oListener?: object
|
|
3208
3304
|
): this;
|
|
3209
3305
|
/**
|
|
3210
|
-
* @experimental (since 1.113) - The API might change.
|
|
3211
|
-
*
|
|
3212
3306
|
* Starts the process of fetching a resource from the network, returning a promise that is fulfilled once
|
|
3213
3307
|
* the response is available. Use this method to override the default behavior when fetching network resources.
|
|
3214
3308
|
* Mimics the browser native Fetch API.
|
|
3215
3309
|
*
|
|
3310
|
+
* @experimental (since 1.113) - The API might change.
|
|
3311
|
+
*
|
|
3216
3312
|
* @returns A `Promise` that resolves to a `Response` object.
|
|
3217
3313
|
*/
|
|
3218
3314
|
fetch(
|
|
@@ -3231,15 +3327,15 @@ declare module "sap/ui/integration/Extension" {
|
|
|
3231
3327
|
mRequestSettings: object
|
|
3232
3328
|
): Promise<Response>;
|
|
3233
3329
|
/**
|
|
3234
|
-
* @experimental (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
3235
|
-
* be done before its official public release. Use at your own discretion.
|
|
3236
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
3237
|
-
*
|
|
3238
3330
|
* Fires event {@link #event:action action} to attached listeners.
|
|
3239
3331
|
*
|
|
3240
3332
|
* Listeners may prevent the default action of this event by calling the `preventDefault` method on the
|
|
3241
3333
|
* event object. The return value of this method indicates whether the default action should be executed.
|
|
3242
3334
|
*
|
|
3335
|
+
* @experimental (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
3336
|
+
* be done before its official public release. Use at your own discretion.
|
|
3337
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
3338
|
+
*
|
|
3243
3339
|
* @returns Whether or not to prevent the default action
|
|
3244
3340
|
*/
|
|
3245
3341
|
fireAction(
|
|
@@ -3249,20 +3345,21 @@ declare module "sap/ui/integration/Extension" {
|
|
|
3249
3345
|
mParameters?: Extension$ActionEventParameters
|
|
3250
3346
|
): boolean;
|
|
3251
3347
|
/**
|
|
3252
|
-
* @deprecated (since 1.85) - This property is replaced by the `actions` aggregation of the card;
|
|
3253
|
-
* @experimental (since 1.75) - Disclaimer: this property is in a beta state - incompatible API changes
|
|
3254
|
-
* may be done before its official public release. Use at your own discretion.
|
|
3255
|
-
*
|
|
3256
3348
|
* Gets current value of property {@link #getActions actions}.
|
|
3257
3349
|
*
|
|
3258
3350
|
* The actions configuration.
|
|
3259
3351
|
*
|
|
3352
|
+
* @deprecated (since 1.85) - This property is replaced by the `actions` aggregation of the card;
|
|
3353
|
+
* @experimental (since 1.75) - Disclaimer: this property is in a beta state - incompatible API changes
|
|
3354
|
+
* may be done before its official public release. Use at your own discretion.
|
|
3355
|
+
*
|
|
3260
3356
|
* @returns Value of property `actions`
|
|
3261
3357
|
*/
|
|
3262
3358
|
getActions(): CardMenuAction[];
|
|
3263
3359
|
/**
|
|
3264
3360
|
* Returns an interface to the card, which uses this extension.
|
|
3265
3361
|
*
|
|
3362
|
+
*
|
|
3266
3363
|
* @returns An interface to the card.
|
|
3267
3364
|
*/
|
|
3268
3365
|
getCard(): CardFacade;
|
|
@@ -3271,14 +3368,15 @@ declare module "sap/ui/integration/Extension" {
|
|
|
3271
3368
|
*
|
|
3272
3369
|
* The formatters that can be used in the manifest.
|
|
3273
3370
|
*
|
|
3371
|
+
*
|
|
3274
3372
|
* @returns Value of property `formatters`
|
|
3275
3373
|
*/
|
|
3276
3374
|
getFormatters(): Record<string, () => void> | undefined;
|
|
3277
3375
|
/**
|
|
3278
|
-
* @experimental (since 1.108)
|
|
3279
|
-
*
|
|
3280
3376
|
* Override this method to lazy load dependencies for the extension.
|
|
3281
3377
|
*
|
|
3378
|
+
* @experimental (since 1.108)
|
|
3379
|
+
*
|
|
3282
3380
|
* @returns Returns a promise. The card will wait for this promise to be resolved before continuing with
|
|
3283
3381
|
* the initialization.
|
|
3284
3382
|
*/
|
|
@@ -3288,16 +3386,16 @@ declare module "sap/ui/integration/Extension" {
|
|
|
3288
3386
|
*/
|
|
3289
3387
|
onCardReady(): void;
|
|
3290
3388
|
/**
|
|
3291
|
-
* @deprecated (since 1.85) - This property is replaced by the `actions` aggregation of the card;
|
|
3292
|
-
* @experimental (since 1.75) - Disclaimer: this property is in a beta state - incompatible API changes
|
|
3293
|
-
* may be done before its official public release. Use at your own discretion.
|
|
3294
|
-
*
|
|
3295
3389
|
* Sets a new value for property {@link #getActions actions}.
|
|
3296
3390
|
*
|
|
3297
3391
|
* The actions configuration.
|
|
3298
3392
|
*
|
|
3299
3393
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3300
3394
|
*
|
|
3395
|
+
* @deprecated (since 1.85) - This property is replaced by the `actions` aggregation of the card;
|
|
3396
|
+
* @experimental (since 1.75) - Disclaimer: this property is in a beta state - incompatible API changes
|
|
3397
|
+
* may be done before its official public release. Use at your own discretion.
|
|
3398
|
+
*
|
|
3301
3399
|
* @returns Reference to `this` in order to allow method chaining
|
|
3302
3400
|
*/
|
|
3303
3401
|
setActions(
|
|
@@ -3312,6 +3410,7 @@ declare module "sap/ui/integration/Extension" {
|
|
|
3312
3410
|
* The formatters that can be used in the manifest. When called with a value of `null` or `undefined`, the
|
|
3313
3411
|
* default value of the property will be restored.
|
|
3314
3412
|
*
|
|
3413
|
+
*
|
|
3315
3414
|
* @returns Reference to `this` in order to allow method chaining
|
|
3316
3415
|
*/
|
|
3317
3416
|
setFormatters(
|
|
@@ -3324,30 +3423,30 @@ declare module "sap/ui/integration/Extension" {
|
|
|
3324
3423
|
|
|
3325
3424
|
export interface $ExtensionSettings extends $ManagedObjectSettings {
|
|
3326
3425
|
/**
|
|
3426
|
+
* The actions configuration.
|
|
3427
|
+
*
|
|
3327
3428
|
* @deprecated (since 1.85) - This property is replaced by the `actions` aggregation of the card;
|
|
3328
3429
|
* @experimental (since 1.75) - Disclaimer: this property is in a beta state - incompatible API changes
|
|
3329
3430
|
* may be done before its official public release. Use at your own discretion.
|
|
3330
|
-
*
|
|
3331
|
-
* The actions configuration.
|
|
3332
3431
|
*/
|
|
3333
3432
|
actions?: CardMenuAction[] | PropertyBindingInfo | `{${string}}`;
|
|
3334
3433
|
|
|
3335
3434
|
/**
|
|
3336
|
-
* @experimental (since 1.79)
|
|
3337
|
-
*
|
|
3338
3435
|
* The formatters that can be used in the manifest.
|
|
3436
|
+
*
|
|
3437
|
+
* @experimental (since 1.79)
|
|
3339
3438
|
*/
|
|
3340
3439
|
formatters?: object | PropertyBindingInfo | `{${string}}`;
|
|
3341
3440
|
|
|
3342
3441
|
/**
|
|
3343
|
-
* @experimental (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
3344
|
-
* be done before its official public release. Use at your own discretion.
|
|
3345
|
-
*
|
|
3346
3442
|
* Fired when an action is triggered in the card.
|
|
3347
3443
|
*
|
|
3348
3444
|
* When an action is triggered in the card it can be handled on several places by "action" event handlers.
|
|
3349
3445
|
* In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
|
|
3350
3446
|
* one to handle the action by calling `oEvent.preventDefault()`.
|
|
3447
|
+
*
|
|
3448
|
+
* @experimental (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
3449
|
+
* be done before its official public release. Use at your own discretion.
|
|
3351
3450
|
*/
|
|
3352
3451
|
action?: (oEvent: Extension$ActionEvent) => void;
|
|
3353
3452
|
}
|
|
@@ -3401,12 +3500,12 @@ declare module "sap/ui/integration/Host" {
|
|
|
3401
3500
|
import Event from "sap/ui/base/Event";
|
|
3402
3501
|
|
|
3403
3502
|
/**
|
|
3404
|
-
* @since 1.75
|
|
3405
|
-
* @experimental (since 1.75)
|
|
3406
|
-
*
|
|
3407
3503
|
* Provides application-level functions and services to an integration card.
|
|
3408
3504
|
*
|
|
3409
3505
|
* Examples may include, but are not limited to options like: share a card, remove a card.
|
|
3506
|
+
*
|
|
3507
|
+
* @since 1.75
|
|
3508
|
+
* @experimental (since 1.75)
|
|
3410
3509
|
*/
|
|
3411
3510
|
export default class Host extends UI5Element {
|
|
3412
3511
|
/**
|
|
@@ -3446,6 +3545,7 @@ declare module "sap/ui/integration/Host" {
|
|
|
3446
3545
|
*
|
|
3447
3546
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
|
|
3448
3547
|
*
|
|
3548
|
+
*
|
|
3449
3549
|
* @returns Created class / constructor function
|
|
3450
3550
|
*/
|
|
3451
3551
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -3466,13 +3566,11 @@ declare module "sap/ui/integration/Host" {
|
|
|
3466
3566
|
/**
|
|
3467
3567
|
* Returns a metadata object for class sap.ui.integration.Host.
|
|
3468
3568
|
*
|
|
3569
|
+
*
|
|
3469
3570
|
* @returns Metadata object describing this class
|
|
3470
3571
|
*/
|
|
3471
3572
|
static getMetadata(): ElementMetadata;
|
|
3472
3573
|
/**
|
|
3473
|
-
* @experimental (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
3474
|
-
* be done before its official public release. Use at your own discretion.
|
|
3475
|
-
*
|
|
3476
3574
|
* Attaches event handler `fnFunction` to the {@link #event:action action} event of this `sap.ui.integration.Host`.
|
|
3477
3575
|
*
|
|
3478
3576
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
@@ -3484,6 +3582,9 @@ declare module "sap/ui/integration/Host" {
|
|
|
3484
3582
|
* In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
|
|
3485
3583
|
* one to handle the action by calling `oEvent.preventDefault()`.
|
|
3486
3584
|
*
|
|
3585
|
+
* @experimental (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
3586
|
+
* be done before its official public release. Use at your own discretion.
|
|
3587
|
+
*
|
|
3487
3588
|
* @returns Reference to `this` in order to allow method chaining
|
|
3488
3589
|
*/
|
|
3489
3590
|
attachAction(
|
|
@@ -3502,9 +3603,6 @@ declare module "sap/ui/integration/Host" {
|
|
|
3502
3603
|
oListener?: object
|
|
3503
3604
|
): this;
|
|
3504
3605
|
/**
|
|
3505
|
-
* @experimental (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
3506
|
-
* be done before its official public release. Use at your own discretion.
|
|
3507
|
-
*
|
|
3508
3606
|
* Attaches event handler `fnFunction` to the {@link #event:action action} event of this `sap.ui.integration.Host`.
|
|
3509
3607
|
*
|
|
3510
3608
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
@@ -3516,6 +3614,9 @@ declare module "sap/ui/integration/Host" {
|
|
|
3516
3614
|
* In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
|
|
3517
3615
|
* one to handle the action by calling `oEvent.preventDefault()`.
|
|
3518
3616
|
*
|
|
3617
|
+
* @experimental (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
3618
|
+
* be done before its official public release. Use at your own discretion.
|
|
3619
|
+
*
|
|
3519
3620
|
* @returns Reference to `this` in order to allow method chaining
|
|
3520
3621
|
*/
|
|
3521
3622
|
attachAction(
|
|
@@ -3529,8 +3630,6 @@ declare module "sap/ui/integration/Host" {
|
|
|
3529
3630
|
oListener?: object
|
|
3530
3631
|
): this;
|
|
3531
3632
|
/**
|
|
3532
|
-
* @experimental (since 1.96)
|
|
3533
|
-
*
|
|
3534
3633
|
* Attaches event handler `fnFunction` to the {@link #event:cardConfigurationChange cardConfigurationChange }
|
|
3535
3634
|
* event of this `sap.ui.integration.Host`.
|
|
3536
3635
|
*
|
|
@@ -3540,6 +3639,8 @@ declare module "sap/ui/integration/Host" {
|
|
|
3540
3639
|
* Fired when some card configuration settings are changed as a result of user interaction. For example
|
|
3541
3640
|
* - filter value is changed.
|
|
3542
3641
|
*
|
|
3642
|
+
* @experimental (since 1.96)
|
|
3643
|
+
*
|
|
3543
3644
|
* @returns Reference to `this` in order to allow method chaining
|
|
3544
3645
|
*/
|
|
3545
3646
|
attachCardConfigurationChange(
|
|
@@ -3558,8 +3659,6 @@ declare module "sap/ui/integration/Host" {
|
|
|
3558
3659
|
oListener?: object
|
|
3559
3660
|
): this;
|
|
3560
3661
|
/**
|
|
3561
|
-
* @experimental (since 1.96)
|
|
3562
|
-
*
|
|
3563
3662
|
* Attaches event handler `fnFunction` to the {@link #event:cardConfigurationChange cardConfigurationChange }
|
|
3564
3663
|
* event of this `sap.ui.integration.Host`.
|
|
3565
3664
|
*
|
|
@@ -3569,6 +3668,8 @@ declare module "sap/ui/integration/Host" {
|
|
|
3569
3668
|
* Fired when some card configuration settings are changed as a result of user interaction. For example
|
|
3570
3669
|
* - filter value is changed.
|
|
3571
3670
|
*
|
|
3671
|
+
* @experimental (since 1.96)
|
|
3672
|
+
*
|
|
3572
3673
|
* @returns Reference to `this` in order to allow method chaining
|
|
3573
3674
|
*/
|
|
3574
3675
|
attachCardConfigurationChange(
|
|
@@ -3582,8 +3683,6 @@ declare module "sap/ui/integration/Host" {
|
|
|
3582
3683
|
oListener?: object
|
|
3583
3684
|
): this;
|
|
3584
3685
|
/**
|
|
3585
|
-
* @experimental (since 1.116)
|
|
3586
|
-
*
|
|
3587
3686
|
* Attaches event handler `fnFunction` to the {@link #event:cardInitialized cardInitialized} event of this
|
|
3588
3687
|
* `sap.ui.integration.Host`.
|
|
3589
3688
|
*
|
|
@@ -3593,6 +3692,8 @@ declare module "sap/ui/integration/Host" {
|
|
|
3593
3692
|
* Fired when the card is initially ready for the first time. Will not be fired for consecutive refreshes
|
|
3594
3693
|
* or data changes.
|
|
3595
3694
|
*
|
|
3695
|
+
* @experimental (since 1.116)
|
|
3696
|
+
*
|
|
3596
3697
|
* @returns Reference to `this` in order to allow method chaining
|
|
3597
3698
|
*/
|
|
3598
3699
|
attachCardInitialized(
|
|
@@ -3611,8 +3712,6 @@ declare module "sap/ui/integration/Host" {
|
|
|
3611
3712
|
oListener?: object
|
|
3612
3713
|
): this;
|
|
3613
3714
|
/**
|
|
3614
|
-
* @experimental (since 1.116)
|
|
3615
|
-
*
|
|
3616
3715
|
* Attaches event handler `fnFunction` to the {@link #event:cardInitialized cardInitialized} event of this
|
|
3617
3716
|
* `sap.ui.integration.Host`.
|
|
3618
3717
|
*
|
|
@@ -3622,6 +3721,8 @@ declare module "sap/ui/integration/Host" {
|
|
|
3622
3721
|
* Fired when the card is initially ready for the first time. Will not be fired for consecutive refreshes
|
|
3623
3722
|
* or data changes.
|
|
3624
3723
|
*
|
|
3724
|
+
* @experimental (since 1.116)
|
|
3725
|
+
*
|
|
3625
3726
|
* @returns Reference to `this` in order to allow method chaining
|
|
3626
3727
|
*/
|
|
3627
3728
|
attachCardInitialized(
|
|
@@ -3635,8 +3736,6 @@ declare module "sap/ui/integration/Host" {
|
|
|
3635
3736
|
oListener?: object
|
|
3636
3737
|
): this;
|
|
3637
3738
|
/**
|
|
3638
|
-
* @experimental (since 1.107)
|
|
3639
|
-
*
|
|
3640
3739
|
* Attaches event handler `fnFunction` to the {@link #event:cardStateChanged cardStateChanged} event of
|
|
3641
3740
|
* this `sap.ui.integration.Host`.
|
|
3642
3741
|
*
|
|
@@ -3646,6 +3745,8 @@ declare module "sap/ui/integration/Host" {
|
|
|
3646
3745
|
* Fired when the state of a card is changed. For example - the card is ready, new page is selected inside
|
|
3647
3746
|
* the card, a filter is changed or data is refreshed.
|
|
3648
3747
|
*
|
|
3748
|
+
* @experimental (since 1.107)
|
|
3749
|
+
*
|
|
3649
3750
|
* @returns Reference to `this` in order to allow method chaining
|
|
3650
3751
|
*/
|
|
3651
3752
|
attachCardStateChanged(
|
|
@@ -3664,8 +3765,6 @@ declare module "sap/ui/integration/Host" {
|
|
|
3664
3765
|
oListener?: object
|
|
3665
3766
|
): this;
|
|
3666
3767
|
/**
|
|
3667
|
-
* @experimental (since 1.107)
|
|
3668
|
-
*
|
|
3669
3768
|
* Attaches event handler `fnFunction` to the {@link #event:cardStateChanged cardStateChanged} event of
|
|
3670
3769
|
* this `sap.ui.integration.Host`.
|
|
3671
3770
|
*
|
|
@@ -3675,6 +3774,8 @@ declare module "sap/ui/integration/Host" {
|
|
|
3675
3774
|
* Fired when the state of a card is changed. For example - the card is ready, new page is selected inside
|
|
3676
3775
|
* the card, a filter is changed or data is refreshed.
|
|
3677
3776
|
*
|
|
3777
|
+
* @experimental (since 1.107)
|
|
3778
|
+
*
|
|
3678
3779
|
* @returns Reference to `this` in order to allow method chaining
|
|
3679
3780
|
*/
|
|
3680
3781
|
attachCardStateChanged(
|
|
@@ -3688,8 +3789,6 @@ declare module "sap/ui/integration/Host" {
|
|
|
3688
3789
|
oListener?: object
|
|
3689
3790
|
): this;
|
|
3690
3791
|
/**
|
|
3691
|
-
* @experimental (since 1.91)
|
|
3692
|
-
*
|
|
3693
3792
|
* Attaches event handler `fnFunction` to the {@link #event:message message} event of this `sap.ui.integration.Host`.
|
|
3694
3793
|
*
|
|
3695
3794
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
@@ -3697,6 +3796,8 @@ declare module "sap/ui/integration/Host" {
|
|
|
3697
3796
|
*
|
|
3698
3797
|
* Fired when a message from channels like navigator.serviceWorker is received.
|
|
3699
3798
|
*
|
|
3799
|
+
* @experimental (since 1.91)
|
|
3800
|
+
*
|
|
3700
3801
|
* @returns Reference to `this` in order to allow method chaining
|
|
3701
3802
|
*/
|
|
3702
3803
|
attachMessage(
|
|
@@ -3715,8 +3816,6 @@ declare module "sap/ui/integration/Host" {
|
|
|
3715
3816
|
oListener?: object
|
|
3716
3817
|
): this;
|
|
3717
3818
|
/**
|
|
3718
|
-
* @experimental (since 1.91)
|
|
3719
|
-
*
|
|
3720
3819
|
* Attaches event handler `fnFunction` to the {@link #event:message message} event of this `sap.ui.integration.Host`.
|
|
3721
3820
|
*
|
|
3722
3821
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
@@ -3724,6 +3823,8 @@ declare module "sap/ui/integration/Host" {
|
|
|
3724
3823
|
*
|
|
3725
3824
|
* Fired when a message from channels like navigator.serviceWorker is received.
|
|
3726
3825
|
*
|
|
3826
|
+
* @experimental (since 1.91)
|
|
3827
|
+
*
|
|
3727
3828
|
* @returns Reference to `this` in order to allow method chaining
|
|
3728
3829
|
*/
|
|
3729
3830
|
attachMessage(
|
|
@@ -3737,10 +3838,10 @@ declare module "sap/ui/integration/Host" {
|
|
|
3737
3838
|
oListener?: object
|
|
3738
3839
|
): this;
|
|
3739
3840
|
/**
|
|
3841
|
+
* This function is called when a CSRF token has expired.
|
|
3842
|
+
*
|
|
3740
3843
|
* @deprecated (since 1.120.0)
|
|
3741
3844
|
* @experimental (since 1.97)
|
|
3742
|
-
*
|
|
3743
|
-
* This function is called when a CSRF token has expired.
|
|
3744
3845
|
*/
|
|
3745
3846
|
csrfTokenExpired(
|
|
3746
3847
|
/**
|
|
@@ -3751,10 +3852,10 @@ declare module "sap/ui/integration/Host" {
|
|
|
3751
3852
|
}
|
|
3752
3853
|
): void;
|
|
3753
3854
|
/**
|
|
3855
|
+
* This function is called when a CSRF token is fetched.
|
|
3856
|
+
*
|
|
3754
3857
|
* @deprecated (since 1.120.0)
|
|
3755
3858
|
* @experimental (since 1.97)
|
|
3756
|
-
*
|
|
3757
|
-
* This function is called when a CSRF token is fetched.
|
|
3758
3859
|
*/
|
|
3759
3860
|
csrfTokenFetched(
|
|
3760
3861
|
/**
|
|
@@ -3769,13 +3870,13 @@ declare module "sap/ui/integration/Host" {
|
|
|
3769
3870
|
pCSRFTokenValuePromise: Promise<string>
|
|
3770
3871
|
): void;
|
|
3771
3872
|
/**
|
|
3772
|
-
* @experimental (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
3773
|
-
* be done before its official public release. Use at your own discretion.
|
|
3774
|
-
*
|
|
3775
3873
|
* Detaches event handler `fnFunction` from the {@link #event:action action} event of this `sap.ui.integration.Host`.
|
|
3776
3874
|
*
|
|
3777
3875
|
* The passed function and listener object must match the ones used for event registration.
|
|
3778
3876
|
*
|
|
3877
|
+
* @experimental (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
3878
|
+
* be done before its official public release. Use at your own discretion.
|
|
3879
|
+
*
|
|
3779
3880
|
* @returns Reference to `this` in order to allow method chaining
|
|
3780
3881
|
*/
|
|
3781
3882
|
detachAction(
|
|
@@ -3789,13 +3890,13 @@ declare module "sap/ui/integration/Host" {
|
|
|
3789
3890
|
oListener?: object
|
|
3790
3891
|
): this;
|
|
3791
3892
|
/**
|
|
3792
|
-
* @experimental (since 1.96)
|
|
3793
|
-
*
|
|
3794
3893
|
* Detaches event handler `fnFunction` from the {@link #event:cardConfigurationChange cardConfigurationChange }
|
|
3795
3894
|
* event of this `sap.ui.integration.Host`.
|
|
3796
3895
|
*
|
|
3797
3896
|
* The passed function and listener object must match the ones used for event registration.
|
|
3798
3897
|
*
|
|
3898
|
+
* @experimental (since 1.96)
|
|
3899
|
+
*
|
|
3799
3900
|
* @returns Reference to `this` in order to allow method chaining
|
|
3800
3901
|
*/
|
|
3801
3902
|
detachCardConfigurationChange(
|
|
@@ -3809,13 +3910,13 @@ declare module "sap/ui/integration/Host" {
|
|
|
3809
3910
|
oListener?: object
|
|
3810
3911
|
): this;
|
|
3811
3912
|
/**
|
|
3812
|
-
* @experimental (since 1.116)
|
|
3813
|
-
*
|
|
3814
3913
|
* Detaches event handler `fnFunction` from the {@link #event:cardInitialized cardInitialized} event of
|
|
3815
3914
|
* this `sap.ui.integration.Host`.
|
|
3816
3915
|
*
|
|
3817
3916
|
* The passed function and listener object must match the ones used for event registration.
|
|
3818
3917
|
*
|
|
3918
|
+
* @experimental (since 1.116)
|
|
3919
|
+
*
|
|
3819
3920
|
* @returns Reference to `this` in order to allow method chaining
|
|
3820
3921
|
*/
|
|
3821
3922
|
detachCardInitialized(
|
|
@@ -3829,13 +3930,13 @@ declare module "sap/ui/integration/Host" {
|
|
|
3829
3930
|
oListener?: object
|
|
3830
3931
|
): this;
|
|
3831
3932
|
/**
|
|
3832
|
-
* @experimental (since 1.107)
|
|
3833
|
-
*
|
|
3834
3933
|
* Detaches event handler `fnFunction` from the {@link #event:cardStateChanged cardStateChanged} event of
|
|
3835
3934
|
* this `sap.ui.integration.Host`.
|
|
3836
3935
|
*
|
|
3837
3936
|
* The passed function and listener object must match the ones used for event registration.
|
|
3838
3937
|
*
|
|
3938
|
+
* @experimental (since 1.107)
|
|
3939
|
+
*
|
|
3839
3940
|
* @returns Reference to `this` in order to allow method chaining
|
|
3840
3941
|
*/
|
|
3841
3942
|
detachCardStateChanged(
|
|
@@ -3849,12 +3950,12 @@ declare module "sap/ui/integration/Host" {
|
|
|
3849
3950
|
oListener?: object
|
|
3850
3951
|
): this;
|
|
3851
3952
|
/**
|
|
3852
|
-
* @experimental (since 1.91)
|
|
3853
|
-
*
|
|
3854
3953
|
* Detaches event handler `fnFunction` from the {@link #event:message message} event of this `sap.ui.integration.Host`.
|
|
3855
3954
|
*
|
|
3856
3955
|
* The passed function and listener object must match the ones used for event registration.
|
|
3857
3956
|
*
|
|
3957
|
+
* @experimental (since 1.91)
|
|
3958
|
+
*
|
|
3858
3959
|
* @returns Reference to `this` in order to allow method chaining
|
|
3859
3960
|
*/
|
|
3860
3961
|
detachMessage(
|
|
@@ -3868,15 +3969,15 @@ declare module "sap/ui/integration/Host" {
|
|
|
3868
3969
|
oListener?: object
|
|
3869
3970
|
): this;
|
|
3870
3971
|
/**
|
|
3871
|
-
* @experimental (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
3872
|
-
* be done before its official public release. Use at your own discretion.
|
|
3873
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
3874
|
-
*
|
|
3875
3972
|
* Fires event {@link #event:action action} to attached listeners.
|
|
3876
3973
|
*
|
|
3877
3974
|
* Listeners may prevent the default action of this event by calling the `preventDefault` method on the
|
|
3878
3975
|
* event object. The return value of this method indicates whether the default action should be executed.
|
|
3879
3976
|
*
|
|
3977
|
+
* @experimental (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
3978
|
+
* be done before its official public release. Use at your own discretion.
|
|
3979
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
3980
|
+
*
|
|
3880
3981
|
* @returns Whether or not to prevent the default action
|
|
3881
3982
|
*/
|
|
3882
3983
|
fireAction(
|
|
@@ -3886,11 +3987,11 @@ declare module "sap/ui/integration/Host" {
|
|
|
3886
3987
|
mParameters?: Host$ActionEventParameters
|
|
3887
3988
|
): boolean;
|
|
3888
3989
|
/**
|
|
3990
|
+
* Fires event {@link #event:cardConfigurationChange cardConfigurationChange} to attached listeners.
|
|
3991
|
+
*
|
|
3889
3992
|
* @experimental (since 1.96)
|
|
3890
3993
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
3891
3994
|
*
|
|
3892
|
-
* Fires event {@link #event:cardConfigurationChange cardConfigurationChange} to attached listeners.
|
|
3893
|
-
*
|
|
3894
3995
|
* @returns Reference to `this` in order to allow method chaining
|
|
3895
3996
|
*/
|
|
3896
3997
|
fireCardConfigurationChange(
|
|
@@ -3900,11 +4001,11 @@ declare module "sap/ui/integration/Host" {
|
|
|
3900
4001
|
mParameters?: Host$CardConfigurationChangeEventParameters
|
|
3901
4002
|
): this;
|
|
3902
4003
|
/**
|
|
4004
|
+
* Fires event {@link #event:cardInitialized cardInitialized} to attached listeners.
|
|
4005
|
+
*
|
|
3903
4006
|
* @experimental (since 1.116)
|
|
3904
4007
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
3905
4008
|
*
|
|
3906
|
-
* Fires event {@link #event:cardInitialized cardInitialized} to attached listeners.
|
|
3907
|
-
*
|
|
3908
4009
|
* @returns Reference to `this` in order to allow method chaining
|
|
3909
4010
|
*/
|
|
3910
4011
|
fireCardInitialized(
|
|
@@ -3914,11 +4015,11 @@ declare module "sap/ui/integration/Host" {
|
|
|
3914
4015
|
mParameters?: Host$CardInitializedEventParameters
|
|
3915
4016
|
): this;
|
|
3916
4017
|
/**
|
|
4018
|
+
* Fires event {@link #event:cardStateChanged cardStateChanged} to attached listeners.
|
|
4019
|
+
*
|
|
3917
4020
|
* @experimental (since 1.107)
|
|
3918
4021
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
3919
4022
|
*
|
|
3920
|
-
* Fires event {@link #event:cardStateChanged cardStateChanged} to attached listeners.
|
|
3921
|
-
*
|
|
3922
4023
|
* @returns Reference to `this` in order to allow method chaining
|
|
3923
4024
|
*/
|
|
3924
4025
|
fireCardStateChanged(
|
|
@@ -3928,11 +4029,11 @@ declare module "sap/ui/integration/Host" {
|
|
|
3928
4029
|
mParameters?: Host$CardStateChangedEventParameters
|
|
3929
4030
|
): this;
|
|
3930
4031
|
/**
|
|
4032
|
+
* Fires event {@link #event:message message} to attached listeners.
|
|
4033
|
+
*
|
|
3931
4034
|
* @experimental (since 1.91)
|
|
3932
4035
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
3933
4036
|
*
|
|
3934
|
-
* Fires event {@link #event:message message} to attached listeners.
|
|
3935
|
-
*
|
|
3936
4037
|
* @returns Reference to `this` in order to allow method chaining
|
|
3937
4038
|
*/
|
|
3938
4039
|
fireMessage(
|
|
@@ -3942,19 +4043,17 @@ declare module "sap/ui/integration/Host" {
|
|
|
3942
4043
|
mParameters?: Host$MessageEventParameters
|
|
3943
4044
|
): this;
|
|
3944
4045
|
/**
|
|
3945
|
-
* @experimental (since 1.75) - Disclaimer: this property is in a beta state - incompatible API changes
|
|
3946
|
-
* may be done before its official public release. Use at your own discretion.
|
|
3947
|
-
*
|
|
3948
4046
|
* Gets current value of property {@link #getActions actions}.
|
|
3949
4047
|
*
|
|
3950
4048
|
* The actions configuration.
|
|
3951
4049
|
*
|
|
4050
|
+
* @experimental (since 1.75) - Disclaimer: this property is in a beta state - incompatible API changes
|
|
4051
|
+
* may be done before its official public release. Use at your own discretion.
|
|
4052
|
+
*
|
|
3952
4053
|
* @returns Value of property `actions`
|
|
3953
4054
|
*/
|
|
3954
4055
|
getActions(): CardMenuAction[];
|
|
3955
4056
|
/**
|
|
3956
|
-
* @since 1.83
|
|
3957
|
-
*
|
|
3958
4057
|
* Returns the context object for the Card Editor design-time environment Contexts can be used to configure
|
|
3959
4058
|
* Cards with information available in the host environment. Each entry in the list should contain design-time
|
|
3960
4059
|
* information. A label, placeholder, and description should be provided.
|
|
@@ -3966,12 +4065,12 @@ declare module "sap/ui/integration/Host" {
|
|
|
3966
4065
|
* The context information and texts should be translated as they appear in the design-time UI of the Card
|
|
3967
4066
|
* Editor.
|
|
3968
4067
|
*
|
|
4068
|
+
* @since 1.83
|
|
4069
|
+
*
|
|
3969
4070
|
* @returns A promise which contains the context structure.
|
|
3970
4071
|
*/
|
|
3971
4072
|
getContexts(): Promise<object>;
|
|
3972
4073
|
/**
|
|
3973
|
-
* @since 1.83
|
|
3974
|
-
*
|
|
3975
4074
|
* Resolves the value for a given path in the context of the host Contexts can be used to configure Cards
|
|
3976
4075
|
* with information available in the host environment.
|
|
3977
4076
|
*
|
|
@@ -3982,6 +4081,8 @@ declare module "sap/ui/integration/Host" {
|
|
|
3982
4081
|
* Example path to the current user id of the context sPath = "sap.workzone/currentUser/id" parameter: {
|
|
3983
4082
|
* userId: { value: "{context>sap.workzone/currentUser/id}" resolves to UserId } }
|
|
3984
4083
|
*
|
|
4084
|
+
* @since 1.83
|
|
4085
|
+
*
|
|
3985
4086
|
* @returns A promise which resolves with the value of this context.
|
|
3986
4087
|
*/
|
|
3987
4088
|
getContextValue(
|
|
@@ -3991,25 +4092,27 @@ declare module "sap/ui/integration/Host" {
|
|
|
3991
4092
|
sPath: string
|
|
3992
4093
|
): Promise<null>;
|
|
3993
4094
|
/**
|
|
4095
|
+
* Resolves the value of a CSRF token. Subclasses of Host can override this method to take over the default
|
|
4096
|
+
* CSRF token resolving. Applications must not call this method directly, it is called by the framework.
|
|
4097
|
+
*
|
|
3994
4098
|
* @deprecated (since 1.120.0)
|
|
3995
4099
|
* @experimental (since 1.97)
|
|
3996
4100
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
3997
4101
|
*
|
|
3998
|
-
* Resolves the CSRF token and returns a Promise with its value.
|
|
3999
|
-
*
|
|
4000
4102
|
* @returns A promise which resolves the CSRF token to its value.
|
|
4001
4103
|
*/
|
|
4002
4104
|
getCsrfToken(
|
|
4003
4105
|
/**
|
|
4004
4106
|
* The CSRF token configuration.
|
|
4005
4107
|
*/
|
|
4006
|
-
|
|
4108
|
+
csrfTokenConfig: {
|
|
4007
4109
|
data: object;
|
|
4008
4110
|
}
|
|
4009
4111
|
): Promise<string>;
|
|
4010
4112
|
/**
|
|
4011
4113
|
* Resolves the destination and returns its URL.
|
|
4012
4114
|
*
|
|
4115
|
+
*
|
|
4013
4116
|
* @returns A promise which resolves with the URL of the destination.
|
|
4014
4117
|
*/
|
|
4015
4118
|
getDestination(
|
|
@@ -4023,11 +4126,11 @@ declare module "sap/ui/integration/Host" {
|
|
|
4023
4126
|
oCard: Card
|
|
4024
4127
|
): Promise<string>;
|
|
4025
4128
|
/**
|
|
4026
|
-
* @since 1.83
|
|
4027
|
-
*
|
|
4028
4129
|
* Returns the list of destinations for the Card Editor design-time environment List entries are objects
|
|
4029
4130
|
* that contain at least the name. { "name": "DestinationName" }
|
|
4030
4131
|
*
|
|
4132
|
+
* @since 1.83
|
|
4133
|
+
*
|
|
4031
4134
|
* @returns A promise which resolves with the list of destinations.
|
|
4032
4135
|
*/
|
|
4033
4136
|
getDestinations(): Promise<object[]>;
|
|
@@ -4044,21 +4147,22 @@ declare module "sap/ui/integration/Host" {
|
|
|
4044
4147
|
* The callback receives `destinationName` as parameter and returns a string with the URL. Or alternatively
|
|
4045
4148
|
* the callback may return a `Promise` with the URL as an argument.
|
|
4046
4149
|
*
|
|
4150
|
+
*
|
|
4047
4151
|
* @returns Value of property `resolveDestination`
|
|
4048
4152
|
*/
|
|
4049
4153
|
getResolveDestination():
|
|
4050
4154
|
| ((p1: string, p2: Card) => string | Promise<string>)
|
|
4051
4155
|
| undefined;
|
|
4052
4156
|
/**
|
|
4053
|
-
* @experimental (since 1.75) - Disclaimer: this property is in a beta state - incompatible API changes
|
|
4054
|
-
* may be done before its official public release. Use at your own discretion.
|
|
4055
|
-
*
|
|
4056
4157
|
* Sets a new value for property {@link #getActions actions}.
|
|
4057
4158
|
*
|
|
4058
4159
|
* The actions configuration.
|
|
4059
4160
|
*
|
|
4060
4161
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
4061
4162
|
*
|
|
4163
|
+
* @experimental (since 1.75) - Disclaimer: this property is in a beta state - incompatible API changes
|
|
4164
|
+
* may be done before its official public release. Use at your own discretion.
|
|
4165
|
+
*
|
|
4062
4166
|
* @returns Reference to `this` in order to allow method chaining
|
|
4063
4167
|
*/
|
|
4064
4168
|
setActions(
|
|
@@ -4078,6 +4182,7 @@ declare module "sap/ui/integration/Host" {
|
|
|
4078
4182
|
*
|
|
4079
4183
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
4080
4184
|
*
|
|
4185
|
+
*
|
|
4081
4186
|
* @returns Reference to `this` in order to allow method chaining
|
|
4082
4187
|
*/
|
|
4083
4188
|
setResolveDestination(
|
|
@@ -4090,10 +4195,10 @@ declare module "sap/ui/integration/Host" {
|
|
|
4090
4195
|
|
|
4091
4196
|
export interface $HostSettings extends $ElementSettings {
|
|
4092
4197
|
/**
|
|
4198
|
+
* The actions configuration.
|
|
4199
|
+
*
|
|
4093
4200
|
* @experimental (since 1.75) - Disclaimer: this property is in a beta state - incompatible API changes
|
|
4094
4201
|
* may be done before its official public release. Use at your own discretion.
|
|
4095
|
-
*
|
|
4096
|
-
* The actions configuration.
|
|
4097
4202
|
*/
|
|
4098
4203
|
actions?: CardMenuAction[] | PropertyBindingInfo | `{${string}}`;
|
|
4099
4204
|
|
|
@@ -4111,47 +4216,47 @@ declare module "sap/ui/integration/Host" {
|
|
|
4111
4216
|
resolveDestination?: Function | PropertyBindingInfo | `{${string}}`;
|
|
4112
4217
|
|
|
4113
4218
|
/**
|
|
4114
|
-
* @experimental (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
4115
|
-
* be done before its official public release. Use at your own discretion.
|
|
4116
|
-
*
|
|
4117
4219
|
* Fired when an action is triggered.
|
|
4118
4220
|
*
|
|
4119
4221
|
* When an action is triggered in the card it can be handled on several places by "action" event handlers.
|
|
4120
4222
|
* In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
|
|
4121
4223
|
* one to handle the action by calling `oEvent.preventDefault()`.
|
|
4224
|
+
*
|
|
4225
|
+
* @experimental (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
|
|
4226
|
+
* be done before its official public release. Use at your own discretion.
|
|
4122
4227
|
*/
|
|
4123
4228
|
action?: (oEvent: Host$ActionEvent) => void;
|
|
4124
4229
|
|
|
4125
4230
|
/**
|
|
4126
|
-
* @experimental (since 1.96)
|
|
4127
|
-
*
|
|
4128
4231
|
* Fired when some card configuration settings are changed as a result of user interaction. For example
|
|
4129
4232
|
* - filter value is changed.
|
|
4233
|
+
*
|
|
4234
|
+
* @experimental (since 1.96)
|
|
4130
4235
|
*/
|
|
4131
4236
|
cardConfigurationChange?: (
|
|
4132
4237
|
oEvent: Host$CardConfigurationChangeEvent
|
|
4133
4238
|
) => void;
|
|
4134
4239
|
|
|
4135
4240
|
/**
|
|
4136
|
-
* @experimental (since 1.107)
|
|
4137
|
-
*
|
|
4138
4241
|
* Fired when the state of a card is changed. For example - the card is ready, new page is selected inside
|
|
4139
4242
|
* the card, a filter is changed or data is refreshed.
|
|
4243
|
+
*
|
|
4244
|
+
* @experimental (since 1.107)
|
|
4140
4245
|
*/
|
|
4141
4246
|
cardStateChanged?: (oEvent: Host$CardStateChangedEvent) => void;
|
|
4142
4247
|
|
|
4143
4248
|
/**
|
|
4144
|
-
* @experimental (since 1.116)
|
|
4145
|
-
*
|
|
4146
4249
|
* Fired when the card is initially ready for the first time. Will not be fired for consecutive refreshes
|
|
4147
4250
|
* or data changes.
|
|
4251
|
+
*
|
|
4252
|
+
* @experimental (since 1.116)
|
|
4148
4253
|
*/
|
|
4149
4254
|
cardInitialized?: (oEvent: Host$CardInitializedEvent) => void;
|
|
4150
4255
|
|
|
4151
4256
|
/**
|
|
4152
|
-
* @experimental (since 1.91)
|
|
4153
|
-
*
|
|
4154
4257
|
* Fired when a message from channels like navigator.serviceWorker is received.
|
|
4258
|
+
*
|
|
4259
|
+
* @experimental (since 1.91)
|
|
4155
4260
|
*/
|
|
4156
4261
|
message?: (oEvent: Host$MessageEvent) => void;
|
|
4157
4262
|
}
|
|
@@ -4245,9 +4350,9 @@ declare module "sap/ui/integration/Host" {
|
|
|
4245
4350
|
declare namespace sap {
|
|
4246
4351
|
namespace ui {
|
|
4247
4352
|
/**
|
|
4248
|
-
* @since 1.62
|
|
4249
|
-
*
|
|
4250
4353
|
* SAPUI5 library with controls specialized for SAP Fiori apps.
|
|
4354
|
+
*
|
|
4355
|
+
* @since 1.62
|
|
4251
4356
|
*/
|
|
4252
4357
|
namespace integration {
|
|
4253
4358
|
namespace designtime {
|
|
@@ -4255,15 +4360,16 @@ declare namespace sap {
|
|
|
4255
4360
|
namespace propertyEditor {
|
|
4256
4361
|
namespace iconEditor {
|
|
4257
4362
|
/**
|
|
4363
|
+
* Validates if the provided value belongs to the icon pool.
|
|
4364
|
+
*
|
|
4258
4365
|
* @since 1.81
|
|
4259
4366
|
* @experimental - 1.81
|
|
4260
|
-
*
|
|
4261
|
-
* Validates if the provided value belongs to the icon pool.
|
|
4262
4367
|
*/
|
|
4263
4368
|
namespace IsInIconPool {
|
|
4264
4369
|
/**
|
|
4265
4370
|
* Validator function
|
|
4266
4371
|
*
|
|
4372
|
+
*
|
|
4267
4373
|
* @returns Validation result
|
|
4268
4374
|
*/
|
|
4269
4375
|
function validate(
|