@openui5/ts-types 1.97.1 → 1.99.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/types/sap.f.d.ts +263 -636
- package/types/sap.m.d.ts +3688 -350
- package/types/sap.tnt.d.ts +31 -1
- package/types/sap.ui.codeeditor.d.ts +1 -1
- package/types/sap.ui.commons.d.ts +1 -1
- package/types/sap.ui.core.d.ts +1377 -383
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.fl.d.ts +13 -5
- package/types/sap.ui.integration.d.ts +29 -11
- package/types/sap.ui.layout.d.ts +7 -4
- package/types/sap.ui.mdc.d.ts +16 -6
- package/types/sap.ui.rta.d.ts +1 -1
- package/types/sap.ui.suite.d.ts +1 -1
- package/types/sap.ui.support.d.ts +6 -6
- package/types/sap.ui.table.d.ts +30 -1
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +1 -1
- package/types/sap.ui.ux3.d.ts +1 -1
- package/types/sap.ui.webc.common.d.ts +1 -1
- package/types/sap.ui.webc.fiori.d.ts +2523 -709
- package/types/sap.ui.webc.main.d.ts +2201 -421
- package/types/sap.uxap.d.ts +1 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.
|
|
1
|
+
// For Library Version: 1.99.1
|
|
2
2
|
|
|
3
3
|
declare namespace sap {
|
|
4
4
|
namespace ui {
|
|
@@ -10,6 +10,16 @@ declare namespace sap {
|
|
|
10
10
|
* SAPUI5 library with controls based on UI5 Web Components
|
|
11
11
|
*/
|
|
12
12
|
namespace fiori {
|
|
13
|
+
/**
|
|
14
|
+
* @SINCE 1.99.0
|
|
15
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
16
|
+
*
|
|
17
|
+
* Interface for components that may be slotted inside `ui5-page` as header and footer.
|
|
18
|
+
*/
|
|
19
|
+
interface IBar {
|
|
20
|
+
__implements__sap_ui_webc_fiori_IBar: boolean;
|
|
21
|
+
}
|
|
22
|
+
|
|
13
23
|
/**
|
|
14
24
|
* @SINCE 1.97.0
|
|
15
25
|
* @EXPERIMENTAL (since 1.97.0)
|
|
@@ -30,6 +40,16 @@ declare namespace sap {
|
|
|
30
40
|
__implements__sap_ui_webc_fiori_IFilterItemOption: boolean;
|
|
31
41
|
}
|
|
32
42
|
|
|
43
|
+
/**
|
|
44
|
+
* @SINCE 1.99.0
|
|
45
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
46
|
+
*
|
|
47
|
+
* Interface for components that can be slotted inside `ui5-media-gallery` as items.
|
|
48
|
+
*/
|
|
49
|
+
interface IMediaGalleryItem {
|
|
50
|
+
__implements__sap_ui_webc_fiori_IMediaGalleryItem: boolean;
|
|
51
|
+
}
|
|
52
|
+
|
|
33
53
|
/**
|
|
34
54
|
* @SINCE 1.92.0
|
|
35
55
|
* @EXPERIMENTAL (since 1.92.0)
|
|
@@ -192,6 +212,102 @@ declare namespace sap {
|
|
|
192
212
|
scanSuccess?: (oEvent: sap.ui.base.Event) => void;
|
|
193
213
|
}
|
|
194
214
|
|
|
215
|
+
interface $DynamicSideContentSettings
|
|
216
|
+
extends sap.ui.webc.common.$WebComponentSettings {
|
|
217
|
+
/**
|
|
218
|
+
* Defines whether the component is in equal split mode. In this mode, the side and the main content take
|
|
219
|
+
* 50:50 percent of the container on all screen sizes except for phone, where the main and side contents
|
|
220
|
+
* are switching visibility using the toggle method.
|
|
221
|
+
*/
|
|
222
|
+
equalSplit?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
223
|
+
|
|
224
|
+
/**
|
|
225
|
+
* Defines the visibility of the main content.
|
|
226
|
+
*/
|
|
227
|
+
hideMainContent?:
|
|
228
|
+
| boolean
|
|
229
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
230
|
+
|
|
231
|
+
/**
|
|
232
|
+
* Defines the visibility of the side content.
|
|
233
|
+
*/
|
|
234
|
+
hideSideContent?:
|
|
235
|
+
| boolean
|
|
236
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
237
|
+
|
|
238
|
+
/**
|
|
239
|
+
* Defines on which breakpoints the side content falls down below the main content.
|
|
240
|
+
*
|
|
241
|
+
*
|
|
242
|
+
*
|
|
243
|
+
* **The available values are:**
|
|
244
|
+
*
|
|
245
|
+
*
|
|
246
|
+
* - `BelowXL`
|
|
247
|
+
* - `BelowL`
|
|
248
|
+
* - `BelowM`
|
|
249
|
+
* - `OnMinimumWidth`
|
|
250
|
+
*/
|
|
251
|
+
sideContentFallDown?:
|
|
252
|
+
| sap.ui.webc.fiori.SideContentFallDown
|
|
253
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
254
|
+
|
|
255
|
+
/**
|
|
256
|
+
* Defines whether the side content is positioned before the main content (left side in LTR mode), or after
|
|
257
|
+
* the the main content (right side in LTR mode).
|
|
258
|
+
*
|
|
259
|
+
*
|
|
260
|
+
*
|
|
261
|
+
* **The available values are:**
|
|
262
|
+
*
|
|
263
|
+
*
|
|
264
|
+
* - `Start`
|
|
265
|
+
* - `End`
|
|
266
|
+
*/
|
|
267
|
+
sideContentPosition?:
|
|
268
|
+
| sap.ui.webc.fiori.SideContentPosition
|
|
269
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
270
|
+
|
|
271
|
+
/**
|
|
272
|
+
* Defines on which breakpoints the side content is visible.
|
|
273
|
+
*
|
|
274
|
+
*
|
|
275
|
+
*
|
|
276
|
+
* **The available values are:**
|
|
277
|
+
*
|
|
278
|
+
*
|
|
279
|
+
* - `AlwaysShow`
|
|
280
|
+
* - `ShowAboveL`
|
|
281
|
+
* - `ShowAboveM`
|
|
282
|
+
* - `ShowAboveS`
|
|
283
|
+
* - `NeverShow`
|
|
284
|
+
*/
|
|
285
|
+
sideContentVisibility?:
|
|
286
|
+
| sap.ui.webc.fiori.SideContentVisibility
|
|
287
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
288
|
+
|
|
289
|
+
/**
|
|
290
|
+
* Defines the main content.
|
|
291
|
+
*/
|
|
292
|
+
content?:
|
|
293
|
+
| sap.ui.core.Control[]
|
|
294
|
+
| sap.ui.core.Control
|
|
295
|
+
| sap.ui.base.ManagedObject.AggregationBindingInfo;
|
|
296
|
+
|
|
297
|
+
/**
|
|
298
|
+
* Defines the side content.
|
|
299
|
+
*/
|
|
300
|
+
sideContent?:
|
|
301
|
+
| sap.ui.core.Control[]
|
|
302
|
+
| sap.ui.core.Control
|
|
303
|
+
| sap.ui.base.ManagedObject.AggregationBindingInfo;
|
|
304
|
+
|
|
305
|
+
/**
|
|
306
|
+
* Fires when the current breakpoint has been changed.
|
|
307
|
+
*/
|
|
308
|
+
layoutChange?: (oEvent: sap.ui.base.Event) => void;
|
|
309
|
+
}
|
|
310
|
+
|
|
195
311
|
interface $FilterItemSettings
|
|
196
312
|
extends sap.ui.webc.common.$WebComponentSettings {
|
|
197
313
|
/**
|
|
@@ -223,6 +339,19 @@ declare namespace sap {
|
|
|
223
339
|
|
|
224
340
|
interface $FlexibleColumnLayoutSettings
|
|
225
341
|
extends sap.ui.webc.common.$WebComponentSettings {
|
|
342
|
+
/**
|
|
343
|
+
* An object of strings that defines additional accessibility roles for further customization.
|
|
344
|
+
*
|
|
345
|
+
* It supports the following fields: - `startColumnRole`: the accessibility role for the `startColumn` -
|
|
346
|
+
* `startArrowContainerRole`: the accessibility role for the first arrow container (between the `begin`
|
|
347
|
+
* and `mid` columns) - `midColumnRole`: the accessibility role for the `midColumn` - `endArrowContainerRole`:
|
|
348
|
+
* the accessibility role for the second arrow container (between the `mid` and `end` columns) - `endColumnRole`:
|
|
349
|
+
* the accessibility role for the `endColumn`
|
|
350
|
+
*/
|
|
351
|
+
accessibilityRoles?:
|
|
352
|
+
| object
|
|
353
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
354
|
+
|
|
226
355
|
/**
|
|
227
356
|
* An object of strings that defines several additional accessibility texts for even further customization.
|
|
228
357
|
*
|
|
@@ -233,7 +362,9 @@ declare namespace sap {
|
|
|
233
362
|
* the text that the first arrow (between the `begin` and `mid` columns) will have when pointing to the
|
|
234
363
|
* right - `endArrowLeftText`: the text that the second arrow (between the `mid` and `end` columns) will
|
|
235
364
|
* have when pointing to the left - `endArrowRightText`: the text that the second arrow (between the `mid`
|
|
236
|
-
* and `end` columns) will have when pointing to the right
|
|
365
|
+
* and `end` columns) will have when pointing to the right - `startArrowContainerAccessibleName`: the text
|
|
366
|
+
* that the first arrow container (between the `begin` and `mid` columns) will have as `aria-label` - `endArrowContainerAccessibleName`:
|
|
367
|
+
* the text that the second arrow container (between the `mid` and `end` columns) will have as `aria-label`
|
|
237
368
|
*/
|
|
238
369
|
accessibilityTexts?:
|
|
239
370
|
| object
|
|
@@ -343,6 +474,131 @@ declare namespace sap {
|
|
|
343
474
|
subtitle?: sap.ui.core.Control;
|
|
344
475
|
}
|
|
345
476
|
|
|
477
|
+
interface $MediaGallerySettings
|
|
478
|
+
extends sap.ui.webc.common.$WebComponentSettings {
|
|
479
|
+
/**
|
|
480
|
+
* If enabled, a `display-area-click` event is fired when the user clicks or taps on the display area.
|
|
481
|
+
* The display area is the central area that contains the enlarged content of the currently selected item.
|
|
482
|
+
*/
|
|
483
|
+
interactiveDisplayArea?:
|
|
484
|
+
| boolean
|
|
485
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
486
|
+
|
|
487
|
+
/**
|
|
488
|
+
* Determines the layout of the component.
|
|
489
|
+
*
|
|
490
|
+
* Available options are:
|
|
491
|
+
* - `Auto`
|
|
492
|
+
* - `Vertical`
|
|
493
|
+
* - `Horizontal`
|
|
494
|
+
*/
|
|
495
|
+
layout?:
|
|
496
|
+
| sap.ui.webc.fiori.MediaGalleryLayout
|
|
497
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
498
|
+
|
|
499
|
+
/**
|
|
500
|
+
* Determines the horizontal alignment of the thumbnails menu vs. the central display area.
|
|
501
|
+
*
|
|
502
|
+
* Available options are:
|
|
503
|
+
* - `Left`
|
|
504
|
+
* - `Right`
|
|
505
|
+
*/
|
|
506
|
+
menuHorizontalAlign?:
|
|
507
|
+
| sap.ui.webc.fiori.MediaGalleryMenuHorizontalAlign
|
|
508
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
509
|
+
|
|
510
|
+
/**
|
|
511
|
+
* Determines the vertical alignment of the thumbnails menu vs. the central display area.
|
|
512
|
+
*
|
|
513
|
+
* Available options are:
|
|
514
|
+
* - `Top`
|
|
515
|
+
* - `Bottom`
|
|
516
|
+
*/
|
|
517
|
+
menuVerticalAlign?:
|
|
518
|
+
| sap.ui.webc.fiori.MediaGalleryMenuVerticalAlign
|
|
519
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
520
|
+
|
|
521
|
+
/**
|
|
522
|
+
* If set to `true`, all thumbnails are rendered in a scrollable container. If `false`, only up to five
|
|
523
|
+
* thumbnails are rendered, followed by an overflow button that shows the count of the remaining thumbnails.
|
|
524
|
+
*/
|
|
525
|
+
showAllThumbnails?:
|
|
526
|
+
| boolean
|
|
527
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
528
|
+
|
|
529
|
+
/**
|
|
530
|
+
* Defines the component items.
|
|
531
|
+
*
|
|
532
|
+
*
|
|
533
|
+
*
|
|
534
|
+
* **Note:** Only one selected item is allowed.
|
|
535
|
+
*
|
|
536
|
+
*
|
|
537
|
+
*
|
|
538
|
+
* **Note:** Use the `sap.ui.webc.fiori.MediaGalleryItem` component to define the desired items.
|
|
539
|
+
*/
|
|
540
|
+
items?:
|
|
541
|
+
| sap.ui.webc.fiori.IMediaGalleryItem[]
|
|
542
|
+
| sap.ui.webc.fiori.IMediaGalleryItem
|
|
543
|
+
| sap.ui.base.ManagedObject.AggregationBindingInfo;
|
|
544
|
+
|
|
545
|
+
/**
|
|
546
|
+
* Fired when the display area is clicked.
|
|
547
|
+
* The display area is the central area that contains the enlarged content of the currently selected item.
|
|
548
|
+
*/
|
|
549
|
+
displayAreaClick?: (oEvent: sap.ui.base.Event) => void;
|
|
550
|
+
|
|
551
|
+
/**
|
|
552
|
+
* Fired when the thumbnails overflow button is clicked.
|
|
553
|
+
*/
|
|
554
|
+
overflowClick?: (oEvent: sap.ui.base.Event) => void;
|
|
555
|
+
|
|
556
|
+
/**
|
|
557
|
+
* Fired when selection is changed by user interaction.
|
|
558
|
+
*/
|
|
559
|
+
selectionChange?: (oEvent: sap.ui.base.Event) => void;
|
|
560
|
+
}
|
|
561
|
+
|
|
562
|
+
interface $MediaGalleryItemSettings
|
|
563
|
+
extends sap.ui.webc.common.$WebComponentSettings {
|
|
564
|
+
/**
|
|
565
|
+
* Defines whether the component is in disabled state.
|
|
566
|
+
*/
|
|
567
|
+
disabled?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
568
|
+
|
|
569
|
+
/**
|
|
570
|
+
* Determines the layout of the item container.
|
|
571
|
+
*
|
|
572
|
+
* Available options are:
|
|
573
|
+
* - `Square`
|
|
574
|
+
* - `Wide`
|
|
575
|
+
*/
|
|
576
|
+
layout?:
|
|
577
|
+
| sap.ui.webc.fiori.MediaGalleryItemLayout
|
|
578
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
579
|
+
|
|
580
|
+
/**
|
|
581
|
+
* Defines the selected state of the component.
|
|
582
|
+
*/
|
|
583
|
+
selected?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
584
|
+
|
|
585
|
+
/**
|
|
586
|
+
* Defines the content of the component.
|
|
587
|
+
*/
|
|
588
|
+
content?:
|
|
589
|
+
| sap.ui.core.Control[]
|
|
590
|
+
| sap.ui.core.Control
|
|
591
|
+
| sap.ui.base.ManagedObject.AggregationBindingInfo;
|
|
592
|
+
|
|
593
|
+
/**
|
|
594
|
+
* Defines the content of the thumbnail.
|
|
595
|
+
*/
|
|
596
|
+
thumbnail?:
|
|
597
|
+
| sap.ui.core.Control[]
|
|
598
|
+
| sap.ui.core.Control
|
|
599
|
+
| sap.ui.base.ManagedObject.AggregationBindingInfo;
|
|
600
|
+
}
|
|
601
|
+
|
|
346
602
|
interface $NotificationActionSettings
|
|
347
603
|
extends sap.ui.webc.common.$WebComponentSettings {
|
|
348
604
|
/**
|
|
@@ -618,18 +874,12 @@ declare namespace sap {
|
|
|
618
874
|
/**
|
|
619
875
|
* Defines the footer HTML Element.
|
|
620
876
|
*/
|
|
621
|
-
footer?:
|
|
622
|
-
| sap.ui.core.Control[]
|
|
623
|
-
| sap.ui.core.Control
|
|
624
|
-
| sap.ui.base.ManagedObject.AggregationBindingInfo;
|
|
877
|
+
footer?: sap.ui.webc.fiori.IBar;
|
|
625
878
|
|
|
626
879
|
/**
|
|
627
880
|
* Defines the header HTML Element.
|
|
628
881
|
*/
|
|
629
|
-
header?:
|
|
630
|
-
| sap.ui.core.Control[]
|
|
631
|
-
| sap.ui.core.Control
|
|
632
|
-
| sap.ui.base.ManagedObject.AggregationBindingInfo;
|
|
882
|
+
header?: sap.ui.webc.fiori.IBar;
|
|
633
883
|
}
|
|
634
884
|
|
|
635
885
|
interface $ProductSwitchSettings
|
|
@@ -694,6 +944,16 @@ declare namespace sap {
|
|
|
694
944
|
|
|
695
945
|
interface $ShellBarSettings
|
|
696
946
|
extends sap.ui.webc.common.$WebComponentSettings {
|
|
947
|
+
/**
|
|
948
|
+
* An object of strings that defines several additional accessibility texts for even further customization.
|
|
949
|
+
*
|
|
950
|
+
* It supports the following fields: - `profileButtonTitle`: defines the tooltip for the profile button
|
|
951
|
+
* - `logoTitle`: defines the tooltip for the logo
|
|
952
|
+
*/
|
|
953
|
+
accessibilityTexts?:
|
|
954
|
+
| object
|
|
955
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
956
|
+
|
|
697
957
|
/**
|
|
698
958
|
* Defines the `notificationsCount`, displayed in the notification icon top-right corner.
|
|
699
959
|
*/
|
|
@@ -795,7 +1055,7 @@ declare namespace sap {
|
|
|
795
1055
|
logoClick?: (oEvent: sap.ui.base.Event) => void;
|
|
796
1056
|
|
|
797
1057
|
/**
|
|
798
|
-
* Fired, when a menu item is activated **Note:** You can prevent closing of
|
|
1058
|
+
* Fired, when a menu item is activated **Note:** You can prevent closing of overflow popover by calling
|
|
799
1059
|
* `event.preventDefault()`.
|
|
800
1060
|
*/
|
|
801
1061
|
menuItemClick?: (oEvent: sap.ui.base.Event) => void;
|
|
@@ -806,7 +1066,7 @@ declare namespace sap {
|
|
|
806
1066
|
notificationsClick?: (oEvent: sap.ui.base.Event) => void;
|
|
807
1067
|
|
|
808
1068
|
/**
|
|
809
|
-
* Fired, when the product switch icon is activated. **Note:** You can prevent closing of
|
|
1069
|
+
* Fired, when the product switch icon is activated. **Note:** You can prevent closing of overflow popover
|
|
810
1070
|
* by calling `event.preventDefault()`.
|
|
811
1071
|
*/
|
|
812
1072
|
productSwitchClick?: (oEvent: sap.ui.base.Event) => void;
|
|
@@ -837,7 +1097,7 @@ declare namespace sap {
|
|
|
837
1097
|
/**
|
|
838
1098
|
* Fired, when the item is pressed.
|
|
839
1099
|
*/
|
|
840
|
-
|
|
1100
|
+
click?: (oEvent: sap.ui.base.Event) => void;
|
|
841
1101
|
}
|
|
842
1102
|
|
|
843
1103
|
interface $SideNavigationSettings
|
|
@@ -1294,13 +1554,6 @@ declare namespace sap {
|
|
|
1294
1554
|
|
|
1295
1555
|
interface $WizardSettings
|
|
1296
1556
|
extends sap.ui.webc.common.$WebComponentSettings {
|
|
1297
|
-
/**
|
|
1298
|
-
* Sets the accessible aria name of the component.
|
|
1299
|
-
*/
|
|
1300
|
-
accessibleName?:
|
|
1301
|
-
| string
|
|
1302
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
1303
|
-
|
|
1304
1557
|
/**
|
|
1305
1558
|
* Defines the height of the control
|
|
1306
1559
|
*/
|
|
@@ -1327,20 +1580,6 @@ declare namespace sap {
|
|
|
1327
1580
|
|
|
1328
1581
|
interface $WizardStepSettings
|
|
1329
1582
|
extends sap.ui.webc.common.$WebComponentSettings {
|
|
1330
|
-
/**
|
|
1331
|
-
* Sets the accessible aria name of the component.
|
|
1332
|
-
*/
|
|
1333
|
-
accessibleName?:
|
|
1334
|
-
| string
|
|
1335
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
1336
|
-
|
|
1337
|
-
/**
|
|
1338
|
-
* Defines the aria-labelledby of the step.
|
|
1339
|
-
*/
|
|
1340
|
-
accessibleNameRef?:
|
|
1341
|
-
| string
|
|
1342
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
1343
|
-
|
|
1344
1583
|
/**
|
|
1345
1584
|
* When `branching` is enabled a dashed line would be displayed after the step, meant to indicate that the
|
|
1346
1585
|
* next step is not yet known and depends on user choice in the current step.
|
|
@@ -1436,8 +1675,13 @@ declare namespace sap {
|
|
|
1436
1675
|
* allow developers to style elements inside the Shadow DOM.
|
|
1437
1676
|
* The `sap.ui.webc.fiori.Bar` exposes the following CSS Shadow Parts:
|
|
1438
1677
|
* - bar - Used to style the wrapper of the content of the component
|
|
1678
|
+
*
|
|
1679
|
+
* Keyboard Handling:
|
|
1439
1680
|
*/
|
|
1440
|
-
class Bar
|
|
1681
|
+
class Bar
|
|
1682
|
+
extends sap.ui.webc.common.WebComponent
|
|
1683
|
+
implements sap.ui.webc.fiori.IBar {
|
|
1684
|
+
__implements__sap_ui_webc_fiori_IBar: boolean;
|
|
1441
1685
|
/**
|
|
1442
1686
|
* Constructor for a new `Bar`.
|
|
1443
1687
|
*
|
|
@@ -1966,19 +2210,68 @@ declare namespace sap {
|
|
|
1966
2210
|
show(): void;
|
|
1967
2211
|
}
|
|
1968
2212
|
/**
|
|
1969
|
-
* @SINCE 1.
|
|
1970
|
-
* @EXPERIMENTAL (since 1.
|
|
2213
|
+
* @SINCE 1.99.0
|
|
2214
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
1971
2215
|
*
|
|
1972
2216
|
* Overview:
|
|
1973
2217
|
*
|
|
2218
|
+
* The DynamicSideContent (`sap.ui.webc.fiori.DynamicSideContent`) is a layout component that allows additional
|
|
2219
|
+
* content to be displayed in a way that flexibly adapts to different screen sizes. The side content appears
|
|
2220
|
+
* in a container next to or directly below the main content (it doesn't overlay). When the side content
|
|
2221
|
+
* is triggered, the main content becomes narrower (if appearing side-by-side). The side content contains
|
|
2222
|
+
* a separate scrollbar when appearing next to the main content.
|
|
2223
|
+
*
|
|
1974
2224
|
* Usage:
|
|
2225
|
+
*
|
|
2226
|
+
* When to use?
|
|
2227
|
+
*
|
|
2228
|
+
* Use this component if you want to display relevant information that is not critical for users to complete
|
|
2229
|
+
* a task. Users should have access to all the key functions and critical information in the app even if
|
|
2230
|
+
* they do not see the side content. This is important because on smaller screen sizes it may be difficult
|
|
2231
|
+
* to display the side content in a way that is easily accessible for the user.
|
|
2232
|
+
*
|
|
2233
|
+
* When not to use?
|
|
2234
|
+
*
|
|
2235
|
+
* Don't use it if you want to display navigation or critical information that prevents users from completing
|
|
2236
|
+
* a task when they have no access to the side content.
|
|
2237
|
+
*
|
|
2238
|
+
* Responsive Behavior:
|
|
2239
|
+
*
|
|
2240
|
+
* Screen width > 1440px
|
|
2241
|
+
*
|
|
2242
|
+
*
|
|
2243
|
+
* - Main vs. side content ratio is 75 vs. 25 percent (with a minimum of 320px each).
|
|
2244
|
+
* - If the application defines a trigger, the side content can be hidden.
|
|
2245
|
+
*
|
|
2246
|
+
* Screen width <= 1440px and> 1024px
|
|
2247
|
+
*
|
|
2248
|
+
*
|
|
2249
|
+
* - Main vs. side content ratio is 66.666 vs. 33.333 percent (with a minimum of 320px each). If the side
|
|
2250
|
+
* content width falls below 320 px, it automatically slides under the main content, unless the app development
|
|
2251
|
+
* team specifies that it should disappear.
|
|
2252
|
+
*
|
|
2253
|
+
* Screen width <= 1024px and> 720px
|
|
2254
|
+
*
|
|
2255
|
+
*
|
|
2256
|
+
* - The side content ratio is fixed to 340px, and the main content takes the rest of the width. Only
|
|
2257
|
+
* if the `sideContentFallDown` is set to `OnMinimumWidth` and screen width is <= 960px and> 720px the side
|
|
2258
|
+
* content falls below the main content.
|
|
2259
|
+
*
|
|
2260
|
+
* Screen width <= 720px (for example on a mobile device)
|
|
2261
|
+
* - In this case, the side content automatically disappears from the screen (unless specified to stay
|
|
2262
|
+
* under the content by setting of `sideContentVisibility` property to `AlwaysShow`) and can be triggered
|
|
2263
|
+
* from a pre-set trigger (specified within the app). When the side content is triggered, it replaces the
|
|
2264
|
+
* main content. We recommend that you always place the trigger for the side content in the same location,
|
|
2265
|
+
* such as in the app footer.
|
|
2266
|
+
*
|
|
2267
|
+
* A special case allows switching the comparison mode between the main and side content. In this case,
|
|
2268
|
+
* the screen is split into 50:50 percent for main vs. side content. The responsive behavior of the equal
|
|
2269
|
+
* split is the same as in the standard view - the side content disappears on screen widths of less than
|
|
2270
|
+
* 720 px and can only be viewed by triggering it.
|
|
1975
2271
|
*/
|
|
1976
|
-
class
|
|
1977
|
-
extends sap.ui.webc.common.WebComponent
|
|
1978
|
-
implements sap.ui.webc.fiori.IFilterItem {
|
|
1979
|
-
__implements__sap_ui_webc_fiori_IFilterItem: boolean;
|
|
2272
|
+
class DynamicSideContent extends sap.ui.webc.common.WebComponent {
|
|
1980
2273
|
/**
|
|
1981
|
-
* Constructor for a new `
|
|
2274
|
+
* Constructor for a new `DynamicSideContent`.
|
|
1982
2275
|
*
|
|
1983
2276
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1984
2277
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
@@ -1988,10 +2281,10 @@ declare namespace sap {
|
|
|
1988
2281
|
/**
|
|
1989
2282
|
* Initial settings for the new control
|
|
1990
2283
|
*/
|
|
1991
|
-
mSettings?: sap.ui.webc.fiori.$
|
|
2284
|
+
mSettings?: sap.ui.webc.fiori.$DynamicSideContentSettings
|
|
1992
2285
|
);
|
|
1993
2286
|
/**
|
|
1994
|
-
* Constructor for a new `
|
|
2287
|
+
* Constructor for a new `DynamicSideContent`.
|
|
1995
2288
|
*
|
|
1996
2289
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1997
2290
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
@@ -2005,12 +2298,12 @@ declare namespace sap {
|
|
|
2005
2298
|
/**
|
|
2006
2299
|
* Initial settings for the new control
|
|
2007
2300
|
*/
|
|
2008
|
-
mSettings?: sap.ui.webc.fiori.$
|
|
2301
|
+
mSettings?: sap.ui.webc.fiori.$DynamicSideContentSettings
|
|
2009
2302
|
);
|
|
2010
2303
|
|
|
2011
2304
|
/**
|
|
2012
|
-
* Creates a new subclass of class sap.ui.webc.fiori.
|
|
2013
|
-
* the information contained in `oClassInfo`.
|
|
2305
|
+
* Creates a new subclass of class sap.ui.webc.fiori.DynamicSideContent with name `sClassName` and enriches
|
|
2306
|
+
* it with the information contained in `oClassInfo`.
|
|
2014
2307
|
*
|
|
2015
2308
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
|
|
2016
2309
|
*/
|
|
@@ -2022,7 +2315,7 @@ declare namespace sap {
|
|
|
2022
2315
|
/**
|
|
2023
2316
|
* Object literal with information about the class
|
|
2024
2317
|
*/
|
|
2025
|
-
oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.
|
|
2318
|
+
oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.DynamicSideContent>,
|
|
2026
2319
|
/**
|
|
2027
2320
|
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
2028
2321
|
* used by this class
|
|
@@ -2030,106 +2323,1415 @@ declare namespace sap {
|
|
|
2030
2323
|
FNMetaImpl?: Function
|
|
2031
2324
|
): Function;
|
|
2032
2325
|
/**
|
|
2033
|
-
* Returns a metadata object for class sap.ui.webc.fiori.
|
|
2326
|
+
* Returns a metadata object for class sap.ui.webc.fiori.DynamicSideContent.
|
|
2034
2327
|
*/
|
|
2035
2328
|
static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
|
|
2036
2329
|
/**
|
|
2037
|
-
* Adds some
|
|
2330
|
+
* Adds some content to the aggregation {@link #getContent content}.
|
|
2038
2331
|
*/
|
|
2039
|
-
|
|
2332
|
+
addContent(
|
|
2040
2333
|
/**
|
|
2041
|
-
* The
|
|
2334
|
+
* The content to add; if empty, nothing is inserted
|
|
2042
2335
|
*/
|
|
2043
|
-
|
|
2336
|
+
oContent: sap.ui.core.Control
|
|
2044
2337
|
): this;
|
|
2045
2338
|
/**
|
|
2046
|
-
*
|
|
2339
|
+
* Adds some sideContent to the aggregation {@link #getSideContent sideContent}.
|
|
2047
2340
|
*/
|
|
2048
|
-
|
|
2341
|
+
addSideContent(
|
|
2342
|
+
/**
|
|
2343
|
+
* The sideContent to add; if empty, nothing is inserted
|
|
2344
|
+
*/
|
|
2345
|
+
oSideContent: sap.ui.core.Control
|
|
2346
|
+
): this;
|
|
2049
2347
|
/**
|
|
2050
|
-
*
|
|
2051
|
-
*
|
|
2052
|
-
* Defines the text of the component.
|
|
2348
|
+
* Attaches event handler `fnFunction` to the {@link #event:layoutChange layoutChange} event of this `sap.ui.webc.fiori.DynamicSideContent`.
|
|
2053
2349
|
*
|
|
2054
|
-
*
|
|
2055
|
-
|
|
2056
|
-
getText(): string;
|
|
2057
|
-
/**
|
|
2058
|
-
* Gets content of aggregation {@link #getValues values}.
|
|
2350
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
2351
|
+
* otherwise it will be bound to this `sap.ui.webc.fiori.DynamicSideContent` itself.
|
|
2059
2352
|
*
|
|
2060
|
-
*
|
|
2353
|
+
* Fires when the current breakpoint has been changed.
|
|
2061
2354
|
*/
|
|
2062
|
-
|
|
2063
|
-
|
|
2064
|
-
|
|
2065
|
-
|
|
2355
|
+
attachLayoutChange(
|
|
2356
|
+
/**
|
|
2357
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
2358
|
+
* object when firing the event
|
|
2359
|
+
*/
|
|
2360
|
+
oData: object,
|
|
2361
|
+
/**
|
|
2362
|
+
* The function to be called when the event occurs
|
|
2363
|
+
*/
|
|
2364
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
2365
|
+
/**
|
|
2366
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.DynamicSideContent`
|
|
2367
|
+
* itself
|
|
2368
|
+
*/
|
|
2369
|
+
oListener?: object
|
|
2370
|
+
): this;
|
|
2371
|
+
/**
|
|
2372
|
+
* Attaches event handler `fnFunction` to the {@link #event:layoutChange layoutChange} event of this `sap.ui.webc.fiori.DynamicSideContent`.
|
|
2373
|
+
*
|
|
2374
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
2375
|
+
* otherwise it will be bound to this `sap.ui.webc.fiori.DynamicSideContent` itself.
|
|
2376
|
+
*
|
|
2377
|
+
* Fires when the current breakpoint has been changed.
|
|
2378
|
+
*/
|
|
2379
|
+
attachLayoutChange(
|
|
2380
|
+
/**
|
|
2381
|
+
* The function to be called when the event occurs
|
|
2382
|
+
*/
|
|
2383
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
2384
|
+
/**
|
|
2385
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.DynamicSideContent`
|
|
2386
|
+
* itself
|
|
2387
|
+
*/
|
|
2388
|
+
oListener?: object
|
|
2389
|
+
): this;
|
|
2390
|
+
/**
|
|
2391
|
+
* Destroys all the content in the aggregation {@link #getContent content}.
|
|
2392
|
+
*/
|
|
2393
|
+
destroyContent(): this;
|
|
2394
|
+
/**
|
|
2395
|
+
* Destroys all the sideContent in the aggregation {@link #getSideContent sideContent}.
|
|
2396
|
+
*/
|
|
2397
|
+
destroySideContent(): this;
|
|
2398
|
+
/**
|
|
2399
|
+
* Detaches event handler `fnFunction` from the {@link #event:layoutChange layoutChange} event of this `sap.ui.webc.fiori.DynamicSideContent`.
|
|
2400
|
+
*
|
|
2401
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
2402
|
+
*/
|
|
2403
|
+
detachLayoutChange(
|
|
2404
|
+
/**
|
|
2405
|
+
* The function to be called, when the event occurs
|
|
2406
|
+
*/
|
|
2407
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
2408
|
+
/**
|
|
2409
|
+
* Context object on which the given function had to be called
|
|
2410
|
+
*/
|
|
2411
|
+
oListener?: object
|
|
2412
|
+
): this;
|
|
2413
|
+
/**
|
|
2414
|
+
* Fires event {@link #event:layoutChange layoutChange} to attached listeners.
|
|
2415
|
+
*/
|
|
2416
|
+
fireLayoutChange(
|
|
2417
|
+
/**
|
|
2418
|
+
* Parameters to pass along with the event
|
|
2419
|
+
*/
|
|
2420
|
+
mParameters?: {
|
|
2421
|
+
/**
|
|
2422
|
+
* the current breakpoint.
|
|
2423
|
+
*/
|
|
2424
|
+
currentBreakpoint?: string;
|
|
2425
|
+
/**
|
|
2426
|
+
* the breakpoint that was active before change to current breakpoint.
|
|
2427
|
+
*/
|
|
2428
|
+
previousBreakpoint?: string;
|
|
2429
|
+
/**
|
|
2430
|
+
* visibility of the main content.
|
|
2431
|
+
*/
|
|
2432
|
+
mainContentVisible?: boolean;
|
|
2433
|
+
/**
|
|
2434
|
+
* visibility of the side content.
|
|
2435
|
+
*/
|
|
2436
|
+
sideContentVisible?: boolean;
|
|
2437
|
+
}
|
|
2438
|
+
): this;
|
|
2439
|
+
/**
|
|
2440
|
+
* Gets content of aggregation {@link #getContent content}.
|
|
2441
|
+
*
|
|
2442
|
+
* Defines the main content.
|
|
2443
|
+
*/
|
|
2444
|
+
getContent(): sap.ui.core.Control[];
|
|
2445
|
+
/**
|
|
2446
|
+
* Gets current value of property {@link #getEqualSplit equalSplit}.
|
|
2447
|
+
*
|
|
2448
|
+
* Defines whether the component is in equal split mode. In this mode, the side and the main content take
|
|
2449
|
+
* 50:50 percent of the container on all screen sizes except for phone, where the main and side contents
|
|
2450
|
+
* are switching visibility using the toggle method.
|
|
2451
|
+
*
|
|
2452
|
+
* Default value is `false`.
|
|
2453
|
+
*/
|
|
2454
|
+
getEqualSplit(): boolean;
|
|
2455
|
+
/**
|
|
2456
|
+
* Gets current value of property {@link #getHideMainContent hideMainContent}.
|
|
2457
|
+
*
|
|
2458
|
+
* Defines the visibility of the main content.
|
|
2459
|
+
*
|
|
2460
|
+
* Default value is `false`.
|
|
2461
|
+
*/
|
|
2462
|
+
getHideMainContent(): boolean;
|
|
2463
|
+
/**
|
|
2464
|
+
* Gets current value of property {@link #getHideSideContent hideSideContent}.
|
|
2465
|
+
*
|
|
2466
|
+
* Defines the visibility of the side content.
|
|
2467
|
+
*
|
|
2468
|
+
* Default value is `false`.
|
|
2469
|
+
*/
|
|
2470
|
+
getHideSideContent(): boolean;
|
|
2471
|
+
/**
|
|
2472
|
+
* Gets content of aggregation {@link #getSideContent sideContent}.
|
|
2473
|
+
*
|
|
2474
|
+
* Defines the side content.
|
|
2475
|
+
*/
|
|
2476
|
+
getSideContent(): sap.ui.core.Control[];
|
|
2477
|
+
/**
|
|
2478
|
+
* Gets current value of property {@link #getSideContentFallDown sideContentFallDown}.
|
|
2479
|
+
*
|
|
2480
|
+
* Defines on which breakpoints the side content falls down below the main content.
|
|
2481
|
+
*
|
|
2482
|
+
*
|
|
2483
|
+
*
|
|
2484
|
+
* **The available values are:**
|
|
2485
|
+
*
|
|
2486
|
+
*
|
|
2487
|
+
* - `BelowXL`
|
|
2488
|
+
* - `BelowL`
|
|
2489
|
+
* - `BelowM`
|
|
2490
|
+
* - `OnMinimumWidth`
|
|
2491
|
+
*
|
|
2492
|
+
* Default value is `OnMinimumWidth`.
|
|
2493
|
+
*/
|
|
2494
|
+
getSideContentFallDown(): sap.ui.webc.fiori.SideContentFallDown;
|
|
2495
|
+
/**
|
|
2496
|
+
* Gets current value of property {@link #getSideContentPosition sideContentPosition}.
|
|
2497
|
+
*
|
|
2498
|
+
* Defines whether the side content is positioned before the main content (left side in LTR mode), or after
|
|
2499
|
+
* the the main content (right side in LTR mode).
|
|
2500
|
+
*
|
|
2501
|
+
*
|
|
2502
|
+
*
|
|
2503
|
+
* **The available values are:**
|
|
2504
|
+
*
|
|
2505
|
+
*
|
|
2506
|
+
* - `Start`
|
|
2507
|
+
* - `End`
|
|
2508
|
+
*
|
|
2509
|
+
* Default value is `End`.
|
|
2510
|
+
*/
|
|
2511
|
+
getSideContentPosition(): sap.ui.webc.fiori.SideContentPosition;
|
|
2512
|
+
/**
|
|
2513
|
+
* Gets current value of property {@link #getSideContentVisibility sideContentVisibility}.
|
|
2514
|
+
*
|
|
2515
|
+
* Defines on which breakpoints the side content is visible.
|
|
2516
|
+
*
|
|
2517
|
+
*
|
|
2518
|
+
*
|
|
2519
|
+
* **The available values are:**
|
|
2520
|
+
*
|
|
2521
|
+
*
|
|
2522
|
+
* - `AlwaysShow`
|
|
2523
|
+
* - `ShowAboveL`
|
|
2524
|
+
* - `ShowAboveM`
|
|
2525
|
+
* - `ShowAboveS`
|
|
2526
|
+
* - `NeverShow`
|
|
2527
|
+
*
|
|
2528
|
+
* Default value is `ShowAboveS`.
|
|
2529
|
+
*/
|
|
2530
|
+
getSideContentVisibility(): sap.ui.webc.fiori.SideContentVisibility;
|
|
2531
|
+
/**
|
|
2532
|
+
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getContent content}. and returns
|
|
2533
|
+
* its index if found or -1 otherwise.
|
|
2534
|
+
*/
|
|
2535
|
+
indexOfContent(
|
|
2536
|
+
/**
|
|
2537
|
+
* The content whose index is looked for
|
|
2538
|
+
*/
|
|
2539
|
+
oContent: sap.ui.core.Control
|
|
2540
|
+
): int;
|
|
2541
|
+
/**
|
|
2542
|
+
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getSideContent sideContent}.
|
|
2543
|
+
* and returns its index if found or -1 otherwise.
|
|
2544
|
+
*/
|
|
2545
|
+
indexOfSideContent(
|
|
2546
|
+
/**
|
|
2547
|
+
* The sideContent whose index is looked for
|
|
2548
|
+
*/
|
|
2549
|
+
oSideContent: sap.ui.core.Control
|
|
2550
|
+
): int;
|
|
2551
|
+
/**
|
|
2552
|
+
* Inserts a content into the aggregation {@link #getContent content}.
|
|
2553
|
+
*/
|
|
2554
|
+
insertContent(
|
|
2555
|
+
/**
|
|
2556
|
+
* The content to insert; if empty, nothing is inserted
|
|
2557
|
+
*/
|
|
2558
|
+
oContent: sap.ui.core.Control,
|
|
2559
|
+
/**
|
|
2560
|
+
* The `0`-based index the content should be inserted at; for a negative value of `iIndex`, the content
|
|
2561
|
+
* is inserted at position 0; for a value greater than the current size of the aggregation, the content
|
|
2562
|
+
* is inserted at the last position
|
|
2563
|
+
*/
|
|
2564
|
+
iIndex: int
|
|
2565
|
+
): this;
|
|
2566
|
+
/**
|
|
2567
|
+
* Inserts a sideContent into the aggregation {@link #getSideContent sideContent}.
|
|
2568
|
+
*/
|
|
2569
|
+
insertSideContent(
|
|
2570
|
+
/**
|
|
2571
|
+
* The sideContent to insert; if empty, nothing is inserted
|
|
2572
|
+
*/
|
|
2573
|
+
oSideContent: sap.ui.core.Control,
|
|
2574
|
+
/**
|
|
2575
|
+
* The `0`-based index the sideContent should be inserted at; for a negative value of `iIndex`, the sideContent
|
|
2576
|
+
* is inserted at position 0; for a value greater than the current size of the aggregation, the sideContent
|
|
2577
|
+
* is inserted at the last position
|
|
2578
|
+
*/
|
|
2579
|
+
iIndex: int
|
|
2580
|
+
): this;
|
|
2581
|
+
/**
|
|
2582
|
+
* Removes all the controls from the aggregation {@link #getContent content}.
|
|
2583
|
+
*
|
|
2584
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
2585
|
+
*/
|
|
2586
|
+
removeAllContent(): sap.ui.core.Control[];
|
|
2587
|
+
/**
|
|
2588
|
+
* Removes all the controls from the aggregation {@link #getSideContent sideContent}.
|
|
2589
|
+
*
|
|
2590
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
2591
|
+
*/
|
|
2592
|
+
removeAllSideContent(): sap.ui.core.Control[];
|
|
2593
|
+
/**
|
|
2594
|
+
* Removes a content from the aggregation {@link #getContent content}.
|
|
2595
|
+
*/
|
|
2596
|
+
removeContent(
|
|
2597
|
+
/**
|
|
2598
|
+
* The content to remove or its index or id
|
|
2599
|
+
*/
|
|
2600
|
+
vContent: int | string | sap.ui.core.Control
|
|
2601
|
+
): sap.ui.core.Control;
|
|
2602
|
+
/**
|
|
2603
|
+
* Removes a sideContent from the aggregation {@link #getSideContent sideContent}.
|
|
2604
|
+
*/
|
|
2605
|
+
removeSideContent(
|
|
2606
|
+
/**
|
|
2607
|
+
* The sideContent to remove or its index or id
|
|
2608
|
+
*/
|
|
2609
|
+
vSideContent: int | string | sap.ui.core.Control
|
|
2610
|
+
): sap.ui.core.Control;
|
|
2611
|
+
/**
|
|
2612
|
+
* Sets a new value for property {@link #getEqualSplit equalSplit}.
|
|
2613
|
+
*
|
|
2614
|
+
* Defines whether the component is in equal split mode. In this mode, the side and the main content take
|
|
2615
|
+
* 50:50 percent of the container on all screen sizes except for phone, where the main and side contents
|
|
2616
|
+
* are switching visibility using the toggle method.
|
|
2617
|
+
*
|
|
2618
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2619
|
+
*
|
|
2620
|
+
* Default value is `false`.
|
|
2621
|
+
*/
|
|
2622
|
+
setEqualSplit(
|
|
2623
|
+
/**
|
|
2624
|
+
* New value for property `equalSplit`
|
|
2625
|
+
*/
|
|
2626
|
+
bEqualSplit?: boolean
|
|
2627
|
+
): this;
|
|
2628
|
+
/**
|
|
2629
|
+
* Sets a new value for property {@link #getHideMainContent hideMainContent}.
|
|
2630
|
+
*
|
|
2631
|
+
* Defines the visibility of the main content.
|
|
2632
|
+
*
|
|
2633
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2634
|
+
*
|
|
2635
|
+
* Default value is `false`.
|
|
2636
|
+
*/
|
|
2637
|
+
setHideMainContent(
|
|
2638
|
+
/**
|
|
2639
|
+
* New value for property `hideMainContent`
|
|
2640
|
+
*/
|
|
2641
|
+
bHideMainContent?: boolean
|
|
2642
|
+
): this;
|
|
2643
|
+
/**
|
|
2644
|
+
* Sets a new value for property {@link #getHideSideContent hideSideContent}.
|
|
2645
|
+
*
|
|
2646
|
+
* Defines the visibility of the side content.
|
|
2647
|
+
*
|
|
2648
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2649
|
+
*
|
|
2650
|
+
* Default value is `false`.
|
|
2651
|
+
*/
|
|
2652
|
+
setHideSideContent(
|
|
2653
|
+
/**
|
|
2654
|
+
* New value for property `hideSideContent`
|
|
2655
|
+
*/
|
|
2656
|
+
bHideSideContent?: boolean
|
|
2657
|
+
): this;
|
|
2658
|
+
/**
|
|
2659
|
+
* Sets a new value for property {@link #getSideContentFallDown sideContentFallDown}.
|
|
2660
|
+
*
|
|
2661
|
+
* Defines on which breakpoints the side content falls down below the main content.
|
|
2662
|
+
*
|
|
2663
|
+
*
|
|
2664
|
+
*
|
|
2665
|
+
* **The available values are:**
|
|
2666
|
+
*
|
|
2667
|
+
*
|
|
2668
|
+
* - `BelowXL`
|
|
2669
|
+
* - `BelowL`
|
|
2670
|
+
* - `BelowM`
|
|
2671
|
+
* - `OnMinimumWidth`
|
|
2672
|
+
*
|
|
2673
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2674
|
+
*
|
|
2675
|
+
* Default value is `OnMinimumWidth`.
|
|
2676
|
+
*/
|
|
2677
|
+
setSideContentFallDown(
|
|
2678
|
+
/**
|
|
2679
|
+
* New value for property `sideContentFallDown`
|
|
2680
|
+
*/
|
|
2681
|
+
sSideContentFallDown?: sap.ui.webc.fiori.SideContentFallDown
|
|
2682
|
+
): this;
|
|
2683
|
+
/**
|
|
2684
|
+
* Sets a new value for property {@link #getSideContentPosition sideContentPosition}.
|
|
2685
|
+
*
|
|
2686
|
+
* Defines whether the side content is positioned before the main content (left side in LTR mode), or after
|
|
2687
|
+
* the the main content (right side in LTR mode).
|
|
2688
|
+
*
|
|
2689
|
+
*
|
|
2690
|
+
*
|
|
2691
|
+
* **The available values are:**
|
|
2692
|
+
*
|
|
2693
|
+
*
|
|
2694
|
+
* - `Start`
|
|
2695
|
+
* - `End`
|
|
2696
|
+
*
|
|
2697
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2698
|
+
*
|
|
2699
|
+
* Default value is `End`.
|
|
2700
|
+
*/
|
|
2701
|
+
setSideContentPosition(
|
|
2702
|
+
/**
|
|
2703
|
+
* New value for property `sideContentPosition`
|
|
2704
|
+
*/
|
|
2705
|
+
sSideContentPosition?: sap.ui.webc.fiori.SideContentPosition
|
|
2706
|
+
): this;
|
|
2707
|
+
/**
|
|
2708
|
+
* Sets a new value for property {@link #getSideContentVisibility sideContentVisibility}.
|
|
2709
|
+
*
|
|
2710
|
+
* Defines on which breakpoints the side content is visible.
|
|
2711
|
+
*
|
|
2712
|
+
*
|
|
2713
|
+
*
|
|
2714
|
+
* **The available values are:**
|
|
2715
|
+
*
|
|
2716
|
+
*
|
|
2717
|
+
* - `AlwaysShow`
|
|
2718
|
+
* - `ShowAboveL`
|
|
2719
|
+
* - `ShowAboveM`
|
|
2720
|
+
* - `ShowAboveS`
|
|
2721
|
+
* - `NeverShow`
|
|
2722
|
+
*
|
|
2723
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2724
|
+
*
|
|
2725
|
+
* Default value is `ShowAboveS`.
|
|
2726
|
+
*/
|
|
2727
|
+
setSideContentVisibility(
|
|
2728
|
+
/**
|
|
2729
|
+
* New value for property `sideContentVisibility`
|
|
2730
|
+
*/
|
|
2731
|
+
sSideContentVisibility?: sap.ui.webc.fiori.SideContentVisibility
|
|
2732
|
+
): this;
|
|
2733
|
+
/**
|
|
2734
|
+
* Toggles visibility of main and side contents on S screen size (mobile device).
|
|
2735
|
+
*/
|
|
2736
|
+
toggleContents(): void;
|
|
2737
|
+
}
|
|
2738
|
+
/**
|
|
2739
|
+
* @SINCE 1.97.0
|
|
2740
|
+
* @EXPERIMENTAL (since 1.97.0)
|
|
2741
|
+
*
|
|
2742
|
+
* Overview:
|
|
2743
|
+
*
|
|
2744
|
+
* Usage:
|
|
2745
|
+
*/
|
|
2746
|
+
class FilterItem
|
|
2747
|
+
extends sap.ui.webc.common.WebComponent
|
|
2748
|
+
implements sap.ui.webc.fiori.IFilterItem {
|
|
2749
|
+
__implements__sap_ui_webc_fiori_IFilterItem: boolean;
|
|
2750
|
+
/**
|
|
2751
|
+
* Constructor for a new `FilterItem`.
|
|
2752
|
+
*
|
|
2753
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2754
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
2755
|
+
* of the syntax of the settings object.
|
|
2756
|
+
*/
|
|
2757
|
+
constructor(
|
|
2758
|
+
/**
|
|
2759
|
+
* Initial settings for the new control
|
|
2760
|
+
*/
|
|
2761
|
+
mSettings?: sap.ui.webc.fiori.$FilterItemSettings
|
|
2762
|
+
);
|
|
2763
|
+
/**
|
|
2764
|
+
* Constructor for a new `FilterItem`.
|
|
2765
|
+
*
|
|
2766
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2767
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
2768
|
+
* of the syntax of the settings object.
|
|
2769
|
+
*/
|
|
2770
|
+
constructor(
|
|
2771
|
+
/**
|
|
2772
|
+
* ID for the new control, generated automatically if no ID is given
|
|
2773
|
+
*/
|
|
2774
|
+
sId?: string,
|
|
2775
|
+
/**
|
|
2776
|
+
* Initial settings for the new control
|
|
2777
|
+
*/
|
|
2778
|
+
mSettings?: sap.ui.webc.fiori.$FilterItemSettings
|
|
2779
|
+
);
|
|
2780
|
+
|
|
2781
|
+
/**
|
|
2782
|
+
* Creates a new subclass of class sap.ui.webc.fiori.FilterItem with name `sClassName` and enriches it with
|
|
2783
|
+
* the information contained in `oClassInfo`.
|
|
2784
|
+
*
|
|
2785
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
|
|
2786
|
+
*/
|
|
2787
|
+
static extend<T extends Record<string, unknown>>(
|
|
2788
|
+
/**
|
|
2789
|
+
* Name of the class being created
|
|
2790
|
+
*/
|
|
2791
|
+
sClassName: string,
|
|
2792
|
+
/**
|
|
2793
|
+
* Object literal with information about the class
|
|
2794
|
+
*/
|
|
2795
|
+
oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.FilterItem>,
|
|
2796
|
+
/**
|
|
2797
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
2798
|
+
* used by this class
|
|
2799
|
+
*/
|
|
2800
|
+
FNMetaImpl?: Function
|
|
2801
|
+
): Function;
|
|
2802
|
+
/**
|
|
2803
|
+
* Returns a metadata object for class sap.ui.webc.fiori.FilterItem.
|
|
2804
|
+
*/
|
|
2805
|
+
static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
|
|
2806
|
+
/**
|
|
2807
|
+
* Adds some value to the aggregation {@link #getValues values}.
|
|
2808
|
+
*/
|
|
2809
|
+
addValue(
|
|
2810
|
+
/**
|
|
2811
|
+
* The value to add; if empty, nothing is inserted
|
|
2812
|
+
*/
|
|
2813
|
+
oValue: sap.ui.webc.fiori.IFilterItemOption
|
|
2814
|
+
): this;
|
|
2815
|
+
/**
|
|
2816
|
+
* Destroys all the values in the aggregation {@link #getValues values}.
|
|
2817
|
+
*/
|
|
2818
|
+
destroyValues(): this;
|
|
2819
|
+
/**
|
|
2820
|
+
* Gets current value of property {@link #getText text}.
|
|
2821
|
+
*
|
|
2822
|
+
* Defines the text of the component.
|
|
2823
|
+
*
|
|
2824
|
+
* Default value is `empty string`.
|
|
2825
|
+
*/
|
|
2826
|
+
getText(): string;
|
|
2827
|
+
/**
|
|
2828
|
+
* Gets content of aggregation {@link #getValues values}.
|
|
2829
|
+
*
|
|
2830
|
+
* Defines the `values` list.
|
|
2831
|
+
*/
|
|
2832
|
+
getValues(): sap.ui.webc.fiori.IFilterItemOption[];
|
|
2833
|
+
/**
|
|
2834
|
+
* Checks for the provided `sap.ui.webc.fiori.IFilterItemOption` in the aggregation {@link #getValues values}.
|
|
2835
|
+
* and returns its index if found or -1 otherwise.
|
|
2836
|
+
*/
|
|
2837
|
+
indexOfValue(
|
|
2838
|
+
/**
|
|
2839
|
+
* The value whose index is looked for
|
|
2840
|
+
*/
|
|
2841
|
+
oValue: sap.ui.webc.fiori.IFilterItemOption
|
|
2842
|
+
): int;
|
|
2843
|
+
/**
|
|
2844
|
+
* Inserts a value into the aggregation {@link #getValues values}.
|
|
2845
|
+
*/
|
|
2846
|
+
insertValue(
|
|
2847
|
+
/**
|
|
2848
|
+
* The value to insert; if empty, nothing is inserted
|
|
2849
|
+
*/
|
|
2850
|
+
oValue: sap.ui.webc.fiori.IFilterItemOption,
|
|
2851
|
+
/**
|
|
2852
|
+
* The `0`-based index the value should be inserted at; for a negative value of `iIndex`, the value is inserted
|
|
2853
|
+
* at position 0; for a value greater than the current size of the aggregation, the value is inserted at
|
|
2854
|
+
* the last position
|
|
2855
|
+
*/
|
|
2856
|
+
iIndex: int
|
|
2857
|
+
): this;
|
|
2858
|
+
/**
|
|
2859
|
+
* Removes all the controls from the aggregation {@link #getValues values}.
|
|
2860
|
+
*
|
|
2861
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
2862
|
+
*/
|
|
2863
|
+
removeAllValues(): sap.ui.webc.fiori.IFilterItemOption[];
|
|
2864
|
+
/**
|
|
2865
|
+
* Removes a value from the aggregation {@link #getValues values}.
|
|
2866
|
+
*/
|
|
2867
|
+
removeValue(
|
|
2868
|
+
/**
|
|
2869
|
+
* The value to remove or its index or id
|
|
2870
|
+
*/
|
|
2871
|
+
vValue: int | string | sap.ui.webc.fiori.IFilterItemOption
|
|
2872
|
+
): sap.ui.webc.fiori.IFilterItemOption;
|
|
2873
|
+
/**
|
|
2874
|
+
* Sets a new value for property {@link #getText text}.
|
|
2875
|
+
*
|
|
2876
|
+
* Defines the text of the component.
|
|
2877
|
+
*
|
|
2878
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2879
|
+
*
|
|
2880
|
+
* Default value is `empty string`.
|
|
2881
|
+
*/
|
|
2882
|
+
setText(
|
|
2883
|
+
/**
|
|
2884
|
+
* New value for property `text`
|
|
2885
|
+
*/
|
|
2886
|
+
sText?: string
|
|
2887
|
+
): this;
|
|
2888
|
+
}
|
|
2889
|
+
/**
|
|
2890
|
+
* @SINCE 1.97.0
|
|
2891
|
+
* @EXPERIMENTAL (since 1.97.0)
|
|
2892
|
+
*
|
|
2893
|
+
* Overview:
|
|
2894
|
+
*
|
|
2895
|
+
* Usage:
|
|
2896
|
+
*/
|
|
2897
|
+
class FilterItemOption
|
|
2898
|
+
extends sap.ui.webc.common.WebComponent
|
|
2899
|
+
implements sap.ui.webc.fiori.IFilterItemOption {
|
|
2900
|
+
__implements__sap_ui_webc_fiori_IFilterItemOption: boolean;
|
|
2901
|
+
/**
|
|
2902
|
+
* Constructor for a new `FilterItemOption`.
|
|
2903
|
+
*
|
|
2904
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2905
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
2906
|
+
* of the syntax of the settings object.
|
|
2907
|
+
*/
|
|
2908
|
+
constructor(
|
|
2909
|
+
/**
|
|
2910
|
+
* Initial settings for the new control
|
|
2911
|
+
*/
|
|
2912
|
+
mSettings?: sap.ui.webc.fiori.$FilterItemOptionSettings
|
|
2913
|
+
);
|
|
2914
|
+
/**
|
|
2915
|
+
* Constructor for a new `FilterItemOption`.
|
|
2916
|
+
*
|
|
2917
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2918
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
2919
|
+
* of the syntax of the settings object.
|
|
2920
|
+
*/
|
|
2921
|
+
constructor(
|
|
2922
|
+
/**
|
|
2923
|
+
* ID for the new control, generated automatically if no ID is given
|
|
2924
|
+
*/
|
|
2925
|
+
sId?: string,
|
|
2926
|
+
/**
|
|
2927
|
+
* Initial settings for the new control
|
|
2928
|
+
*/
|
|
2929
|
+
mSettings?: sap.ui.webc.fiori.$FilterItemOptionSettings
|
|
2930
|
+
);
|
|
2931
|
+
|
|
2932
|
+
/**
|
|
2933
|
+
* Creates a new subclass of class sap.ui.webc.fiori.FilterItemOption with name `sClassName` and enriches
|
|
2934
|
+
* it with the information contained in `oClassInfo`.
|
|
2935
|
+
*
|
|
2936
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
|
|
2937
|
+
*/
|
|
2938
|
+
static extend<T extends Record<string, unknown>>(
|
|
2939
|
+
/**
|
|
2940
|
+
* Name of the class being created
|
|
2941
|
+
*/
|
|
2942
|
+
sClassName: string,
|
|
2943
|
+
/**
|
|
2944
|
+
* Object literal with information about the class
|
|
2945
|
+
*/
|
|
2946
|
+
oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.FilterItemOption>,
|
|
2947
|
+
/**
|
|
2948
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
2949
|
+
* used by this class
|
|
2950
|
+
*/
|
|
2951
|
+
FNMetaImpl?: Function
|
|
2952
|
+
): Function;
|
|
2953
|
+
/**
|
|
2954
|
+
* Returns a metadata object for class sap.ui.webc.fiori.FilterItemOption.
|
|
2955
|
+
*/
|
|
2956
|
+
static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
|
|
2957
|
+
/**
|
|
2958
|
+
* Gets current value of property {@link #getSelected selected}.
|
|
2959
|
+
*
|
|
2960
|
+
* Defines whether the option is selected
|
|
2961
|
+
*
|
|
2962
|
+
* Default value is `false`.
|
|
2963
|
+
*/
|
|
2964
|
+
getSelected(): boolean;
|
|
2965
|
+
/**
|
|
2966
|
+
* Gets current value of property {@link #getText text}.
|
|
2967
|
+
*
|
|
2968
|
+
* Defines the text of the component.
|
|
2969
|
+
*
|
|
2970
|
+
* Default value is `empty string`.
|
|
2971
|
+
*/
|
|
2972
|
+
getText(): string;
|
|
2973
|
+
/**
|
|
2974
|
+
* Sets a new value for property {@link #getSelected selected}.
|
|
2975
|
+
*
|
|
2976
|
+
* Defines whether the option is selected
|
|
2977
|
+
*
|
|
2978
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2979
|
+
*
|
|
2980
|
+
* Default value is `false`.
|
|
2981
|
+
*/
|
|
2982
|
+
setSelected(
|
|
2983
|
+
/**
|
|
2984
|
+
* New value for property `selected`
|
|
2985
|
+
*/
|
|
2986
|
+
bSelected?: boolean
|
|
2987
|
+
): this;
|
|
2988
|
+
/**
|
|
2989
|
+
* Sets a new value for property {@link #getText text}.
|
|
2990
|
+
*
|
|
2991
|
+
* Defines the text of the component.
|
|
2992
|
+
*
|
|
2993
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2994
|
+
*
|
|
2995
|
+
* Default value is `empty string`.
|
|
2996
|
+
*/
|
|
2997
|
+
setText(
|
|
2998
|
+
/**
|
|
2999
|
+
* New value for property `text`
|
|
3000
|
+
*/
|
|
3001
|
+
sText?: string
|
|
3002
|
+
): this;
|
|
3003
|
+
}
|
|
3004
|
+
/**
|
|
3005
|
+
* @SINCE 1.92.0
|
|
3006
|
+
* @EXPERIMENTAL (since 1.92.0)
|
|
3007
|
+
*
|
|
3008
|
+
* Overview:
|
|
3009
|
+
*
|
|
3010
|
+
* The `FlexibleColumnLayout` implements the master-detail-detail paradigm by displaying up to three pages
|
|
3011
|
+
* in separate columns. There are several possible layouts that can be changed either with the component
|
|
3012
|
+
* API, or by pressing the arrows, displayed between the columns.
|
|
3013
|
+
*
|
|
3014
|
+
* Usage:
|
|
3015
|
+
*
|
|
3016
|
+
* Use this component for applications that need to display several logical levels of related information
|
|
3017
|
+
* side by side (e.g. list of items, item, sub-item, etc.). The Component is flexible in a sense that the
|
|
3018
|
+
* application can focus the user's attention on one particular column.
|
|
3019
|
+
*
|
|
3020
|
+
* Responsive Behavior:
|
|
3021
|
+
*
|
|
3022
|
+
* The `FlexibleColumnLayout` automatically displays the maximum possible number of columns based on `layout`
|
|
3023
|
+
* property and the window size. The component would display 1 column for window size smaller than 599px,
|
|
3024
|
+
* up to two columns between 599px and 1023px, and 3 columns for sizes bigger than 1023px.
|
|
3025
|
+
*
|
|
3026
|
+
*
|
|
3027
|
+
*
|
|
3028
|
+
* Keyboard Handling:
|
|
3029
|
+
*/
|
|
3030
|
+
class FlexibleColumnLayout extends sap.ui.webc.common.WebComponent {
|
|
3031
|
+
/**
|
|
3032
|
+
* Constructor for a new `FlexibleColumnLayout`.
|
|
3033
|
+
*
|
|
3034
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
3035
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
3036
|
+
* of the syntax of the settings object.
|
|
3037
|
+
*/
|
|
3038
|
+
constructor(
|
|
3039
|
+
/**
|
|
3040
|
+
* Initial settings for the new control
|
|
3041
|
+
*/
|
|
3042
|
+
mSettings?: sap.ui.webc.fiori.$FlexibleColumnLayoutSettings
|
|
3043
|
+
);
|
|
3044
|
+
/**
|
|
3045
|
+
* Constructor for a new `FlexibleColumnLayout`.
|
|
3046
|
+
*
|
|
3047
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
3048
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
3049
|
+
* of the syntax of the settings object.
|
|
3050
|
+
*/
|
|
3051
|
+
constructor(
|
|
3052
|
+
/**
|
|
3053
|
+
* ID for the new control, generated automatically if no ID is given
|
|
3054
|
+
*/
|
|
3055
|
+
sId?: string,
|
|
3056
|
+
/**
|
|
3057
|
+
* Initial settings for the new control
|
|
3058
|
+
*/
|
|
3059
|
+
mSettings?: sap.ui.webc.fiori.$FlexibleColumnLayoutSettings
|
|
3060
|
+
);
|
|
3061
|
+
|
|
3062
|
+
/**
|
|
3063
|
+
* Creates a new subclass of class sap.ui.webc.fiori.FlexibleColumnLayout with name `sClassName` and enriches
|
|
3064
|
+
* it with the information contained in `oClassInfo`.
|
|
3065
|
+
*
|
|
3066
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
|
|
3067
|
+
*/
|
|
3068
|
+
static extend<T extends Record<string, unknown>>(
|
|
3069
|
+
/**
|
|
3070
|
+
* Name of the class being created
|
|
3071
|
+
*/
|
|
3072
|
+
sClassName: string,
|
|
3073
|
+
/**
|
|
3074
|
+
* Object literal with information about the class
|
|
3075
|
+
*/
|
|
3076
|
+
oClassInfo?: sap.ClassInfo<
|
|
3077
|
+
T,
|
|
3078
|
+
sap.ui.webc.fiori.FlexibleColumnLayout
|
|
3079
|
+
>,
|
|
3080
|
+
/**
|
|
3081
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
3082
|
+
* used by this class
|
|
3083
|
+
*/
|
|
3084
|
+
FNMetaImpl?: Function
|
|
3085
|
+
): Function;
|
|
3086
|
+
/**
|
|
3087
|
+
* Returns a metadata object for class sap.ui.webc.fiori.FlexibleColumnLayout.
|
|
3088
|
+
*/
|
|
3089
|
+
static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
|
|
3090
|
+
/**
|
|
3091
|
+
* Attaches event handler `fnFunction` to the {@link #event:layoutChange layoutChange} event of this `sap.ui.webc.fiori.FlexibleColumnLayout`.
|
|
3092
|
+
*
|
|
3093
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
3094
|
+
* otherwise it will be bound to this `sap.ui.webc.fiori.FlexibleColumnLayout` itself.
|
|
3095
|
+
*
|
|
3096
|
+
* Fired when the layout changes via user interaction by clicking the arrows or by changing the component
|
|
3097
|
+
* size due to resizing.
|
|
3098
|
+
*/
|
|
3099
|
+
attachLayoutChange(
|
|
3100
|
+
/**
|
|
3101
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
3102
|
+
* object when firing the event
|
|
3103
|
+
*/
|
|
3104
|
+
oData: object,
|
|
3105
|
+
/**
|
|
3106
|
+
* The function to be called when the event occurs
|
|
3107
|
+
*/
|
|
3108
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
3109
|
+
/**
|
|
3110
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.FlexibleColumnLayout`
|
|
3111
|
+
* itself
|
|
3112
|
+
*/
|
|
3113
|
+
oListener?: object
|
|
3114
|
+
): this;
|
|
3115
|
+
/**
|
|
3116
|
+
* Attaches event handler `fnFunction` to the {@link #event:layoutChange layoutChange} event of this `sap.ui.webc.fiori.FlexibleColumnLayout`.
|
|
3117
|
+
*
|
|
3118
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
3119
|
+
* otherwise it will be bound to this `sap.ui.webc.fiori.FlexibleColumnLayout` itself.
|
|
3120
|
+
*
|
|
3121
|
+
* Fired when the layout changes via user interaction by clicking the arrows or by changing the component
|
|
3122
|
+
* size due to resizing.
|
|
3123
|
+
*/
|
|
3124
|
+
attachLayoutChange(
|
|
3125
|
+
/**
|
|
3126
|
+
* The function to be called when the event occurs
|
|
3127
|
+
*/
|
|
3128
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
3129
|
+
/**
|
|
3130
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.FlexibleColumnLayout`
|
|
3131
|
+
* itself
|
|
3132
|
+
*/
|
|
3133
|
+
oListener?: object
|
|
3134
|
+
): this;
|
|
3135
|
+
/**
|
|
3136
|
+
* Destroys the endColumn in the aggregation {@link #getEndColumn endColumn}.
|
|
3137
|
+
*/
|
|
3138
|
+
destroyEndColumn(): this;
|
|
3139
|
+
/**
|
|
3140
|
+
* Destroys the midColumn in the aggregation {@link #getMidColumn midColumn}.
|
|
3141
|
+
*/
|
|
3142
|
+
destroyMidColumn(): this;
|
|
3143
|
+
/**
|
|
3144
|
+
* Destroys the startColumn in the aggregation {@link #getStartColumn startColumn}.
|
|
3145
|
+
*/
|
|
3146
|
+
destroyStartColumn(): this;
|
|
3147
|
+
/**
|
|
3148
|
+
* Detaches event handler `fnFunction` from the {@link #event:layoutChange layoutChange} event of this `sap.ui.webc.fiori.FlexibleColumnLayout`.
|
|
3149
|
+
*
|
|
3150
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
3151
|
+
*/
|
|
3152
|
+
detachLayoutChange(
|
|
3153
|
+
/**
|
|
3154
|
+
* The function to be called, when the event occurs
|
|
3155
|
+
*/
|
|
3156
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
3157
|
+
/**
|
|
3158
|
+
* Context object on which the given function had to be called
|
|
3159
|
+
*/
|
|
3160
|
+
oListener?: object
|
|
3161
|
+
): this;
|
|
3162
|
+
/**
|
|
3163
|
+
* Fires event {@link #event:layoutChange layoutChange} to attached listeners.
|
|
3164
|
+
*/
|
|
3165
|
+
fireLayoutChange(
|
|
3166
|
+
/**
|
|
3167
|
+
* Parameters to pass along with the event
|
|
3168
|
+
*/
|
|
3169
|
+
mParameters?: {
|
|
3170
|
+
/**
|
|
3171
|
+
* The current layout
|
|
3172
|
+
*/
|
|
3173
|
+
layout?: FCLLayout;
|
|
3174
|
+
/**
|
|
3175
|
+
* The effective column layout, f.e [67%, 33%, 0]
|
|
3176
|
+
*/
|
|
3177
|
+
columnLayout?: any[];
|
|
3178
|
+
/**
|
|
3179
|
+
* Indicates if the start column is currently visible
|
|
3180
|
+
*/
|
|
3181
|
+
startColumnVisible?: boolean;
|
|
3182
|
+
/**
|
|
3183
|
+
* Indicates if the middle column is currently visible
|
|
3184
|
+
*/
|
|
3185
|
+
midColumnVisible?: boolean;
|
|
3186
|
+
/**
|
|
3187
|
+
* Indicates if the end column is currently visible
|
|
3188
|
+
*/
|
|
3189
|
+
endColumnVisible?: boolean;
|
|
3190
|
+
/**
|
|
3191
|
+
* Indicates if the layout is changed via the arrows
|
|
3192
|
+
*/
|
|
3193
|
+
arrowsUsed?: boolean;
|
|
3194
|
+
/**
|
|
3195
|
+
* Indicates if the layout is changed via resizing
|
|
3196
|
+
*/
|
|
3197
|
+
resize?: boolean;
|
|
3198
|
+
}
|
|
3199
|
+
): this;
|
|
3200
|
+
/**
|
|
3201
|
+
* Gets current value of property {@link #getAccessibilityRoles accessibilityRoles}.
|
|
3202
|
+
*
|
|
3203
|
+
* An object of strings that defines additional accessibility roles for further customization.
|
|
3204
|
+
*
|
|
3205
|
+
* It supports the following fields: - `startColumnRole`: the accessibility role for the `startColumn` -
|
|
3206
|
+
* `startArrowContainerRole`: the accessibility role for the first arrow container (between the `begin`
|
|
3207
|
+
* and `mid` columns) - `midColumnRole`: the accessibility role for the `midColumn` - `endArrowContainerRole`:
|
|
3208
|
+
* the accessibility role for the second arrow container (between the `mid` and `end` columns) - `endColumnRole`:
|
|
3209
|
+
* the accessibility role for the `endColumn`
|
|
3210
|
+
*
|
|
3211
|
+
* Default value is `{}`.
|
|
3212
|
+
*/
|
|
3213
|
+
getAccessibilityRoles(): object;
|
|
3214
|
+
/**
|
|
3215
|
+
* Gets current value of property {@link #getAccessibilityTexts accessibilityTexts}.
|
|
3216
|
+
*
|
|
3217
|
+
* An object of strings that defines several additional accessibility texts for even further customization.
|
|
3218
|
+
*
|
|
3219
|
+
* It supports the following fields: - `startColumnAccessibleName`: the accessibility name for the `startColumn`
|
|
3220
|
+
* region - `midColumnAccessibleName`: the accessibility name for the `midColumn` region - `endColumnAccessibleName`:
|
|
3221
|
+
* the accessibility name for the `endColumn` region - `startArrowLeftText`: the text that the first arrow
|
|
3222
|
+
* (between the `begin` and `mid` columns) will have when pointing to the left - `startArrowRightText`:
|
|
3223
|
+
* the text that the first arrow (between the `begin` and `mid` columns) will have when pointing to the
|
|
3224
|
+
* right - `endArrowLeftText`: the text that the second arrow (between the `mid` and `end` columns) will
|
|
3225
|
+
* have when pointing to the left - `endArrowRightText`: the text that the second arrow (between the `mid`
|
|
3226
|
+
* and `end` columns) will have when pointing to the right - `startArrowContainerAccessibleName`: the text
|
|
3227
|
+
* that the first arrow container (between the `begin` and `mid` columns) will have as `aria-label` - `endArrowContainerAccessibleName`:
|
|
3228
|
+
* the text that the second arrow container (between the `mid` and `end` columns) will have as `aria-label`
|
|
3229
|
+
*
|
|
3230
|
+
* Default value is `{}`.
|
|
3231
|
+
*/
|
|
3232
|
+
getAccessibilityTexts(): object;
|
|
3233
|
+
/**
|
|
3234
|
+
* Returns the current column layout, based on both the `layout` property and the screen size.
|
|
3235
|
+
*
|
|
3236
|
+
* **For example:** ["67%", "33%", 0], ["100%", 0, 0], ["25%", "50%", "25%"], etc, where the numbers represents
|
|
3237
|
+
* the width of the start, middle and end columns.
|
|
3238
|
+
*/
|
|
3239
|
+
getColumnLayout(): void;
|
|
3240
|
+
/**
|
|
3241
|
+
* Gets content of aggregation {@link #getEndColumn endColumn}.
|
|
3242
|
+
*
|
|
3243
|
+
* Defines the content in the end column.
|
|
3244
|
+
*/
|
|
3245
|
+
getEndColumn(): sap.ui.core.Control;
|
|
3246
|
+
/**
|
|
3247
|
+
* Returns if the `end` column is visible.
|
|
3248
|
+
*/
|
|
3249
|
+
getEndColumnVisible(): void;
|
|
3250
|
+
/**
|
|
3251
|
+
* Gets current value of property {@link #getHeight height}.
|
|
3252
|
+
*
|
|
3253
|
+
* Defines the height of the control
|
|
3254
|
+
*/
|
|
3255
|
+
getHeight(): sap.ui.core.CSSSize;
|
|
3256
|
+
/**
|
|
3257
|
+
* Gets current value of property {@link #getHideArrows hideArrows}.
|
|
3258
|
+
*
|
|
3259
|
+
* Defines the visibility of the arrows, used for expanding and shrinking the columns.
|
|
3260
|
+
*
|
|
3261
|
+
* Default value is `false`.
|
|
3262
|
+
*/
|
|
3263
|
+
getHideArrows(): boolean;
|
|
3264
|
+
/**
|
|
3265
|
+
* Gets current value of property {@link #getLayout layout}.
|
|
3266
|
+
*
|
|
3267
|
+
* Defines the columns layout and their proportion.
|
|
3268
|
+
*
|
|
3269
|
+
* **Note:** The layout also depends on the screen size - one column for screens smaller than 599px, two
|
|
3270
|
+
* columns between 599px and 1023px and three columns for sizes bigger than 1023px.
|
|
3271
|
+
*
|
|
3272
|
+
* Available options are:
|
|
3273
|
+
* - `OneColumn`
|
|
3274
|
+
* - `TwoColumnsStartExpanded`
|
|
3275
|
+
* - `TwoColumnsMidExpanded`
|
|
3276
|
+
* - `ThreeColumnsMidExpanded`
|
|
3277
|
+
* - `ThreeColumnsEndExpanded`
|
|
3278
|
+
* - `ThreeColumnsStartExpandedEndHidden`
|
|
3279
|
+
* - `ThreeColumnsMidExpandedEndHidden`
|
|
3280
|
+
* - `MidColumnFullScreen`
|
|
3281
|
+
* - `EndColumnFullScreen`
|
|
3282
|
+
*
|
|
3283
|
+
* **For example:** layout=`TwoColumnsStartExpanded` means the layout will display up to two columns in
|
|
3284
|
+
* 67%/33% proportion.
|
|
3285
|
+
*
|
|
3286
|
+
* Default value is `OneColumn`.
|
|
3287
|
+
*/
|
|
3288
|
+
getLayout(): sap.ui.webc.fiori.FCLLayout;
|
|
3289
|
+
/**
|
|
3290
|
+
* Gets content of aggregation {@link #getMidColumn midColumn}.
|
|
3291
|
+
*
|
|
3292
|
+
* Defines the content in the middle column.
|
|
3293
|
+
*/
|
|
3294
|
+
getMidColumn(): sap.ui.core.Control;
|
|
3295
|
+
/**
|
|
3296
|
+
* Returns if the `middle` column is visible.
|
|
3297
|
+
*/
|
|
3298
|
+
getMidColumnVisible(): void;
|
|
3299
|
+
/**
|
|
3300
|
+
* Gets content of aggregation {@link #getStartColumn startColumn}.
|
|
3301
|
+
*
|
|
3302
|
+
* Defines the content in the start column.
|
|
3303
|
+
*/
|
|
3304
|
+
getStartColumn(): sap.ui.core.Control;
|
|
3305
|
+
/**
|
|
3306
|
+
* Returns if the `start` column is visible.
|
|
3307
|
+
*/
|
|
3308
|
+
getStartColumnVisible(): void;
|
|
3309
|
+
/**
|
|
3310
|
+
* Returns the number of currently visible columns.
|
|
3311
|
+
*/
|
|
3312
|
+
getVisibleColumns(): void;
|
|
3313
|
+
/**
|
|
3314
|
+
* Gets current value of property {@link #getWidth width}.
|
|
3315
|
+
*
|
|
3316
|
+
* Defines the width of the control
|
|
3317
|
+
*/
|
|
3318
|
+
getWidth(): sap.ui.core.CSSSize;
|
|
3319
|
+
/**
|
|
3320
|
+
* Sets a new value for property {@link #getAccessibilityRoles accessibilityRoles}.
|
|
3321
|
+
*
|
|
3322
|
+
* An object of strings that defines additional accessibility roles for further customization.
|
|
3323
|
+
*
|
|
3324
|
+
* It supports the following fields: - `startColumnRole`: the accessibility role for the `startColumn` -
|
|
3325
|
+
* `startArrowContainerRole`: the accessibility role for the first arrow container (between the `begin`
|
|
3326
|
+
* and `mid` columns) - `midColumnRole`: the accessibility role for the `midColumn` - `endArrowContainerRole`:
|
|
3327
|
+
* the accessibility role for the second arrow container (between the `mid` and `end` columns) - `endColumnRole`:
|
|
3328
|
+
* the accessibility role for the `endColumn`
|
|
3329
|
+
*
|
|
3330
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3331
|
+
*
|
|
3332
|
+
* Default value is `{}`.
|
|
3333
|
+
*/
|
|
3334
|
+
setAccessibilityRoles(
|
|
3335
|
+
/**
|
|
3336
|
+
* New value for property `accessibilityRoles`
|
|
3337
|
+
*/
|
|
3338
|
+
oAccessibilityRoles?: object
|
|
3339
|
+
): this;
|
|
3340
|
+
/**
|
|
3341
|
+
* Sets a new value for property {@link #getAccessibilityTexts accessibilityTexts}.
|
|
3342
|
+
*
|
|
3343
|
+
* An object of strings that defines several additional accessibility texts for even further customization.
|
|
3344
|
+
*
|
|
3345
|
+
* It supports the following fields: - `startColumnAccessibleName`: the accessibility name for the `startColumn`
|
|
3346
|
+
* region - `midColumnAccessibleName`: the accessibility name for the `midColumn` region - `endColumnAccessibleName`:
|
|
3347
|
+
* the accessibility name for the `endColumn` region - `startArrowLeftText`: the text that the first arrow
|
|
3348
|
+
* (between the `begin` and `mid` columns) will have when pointing to the left - `startArrowRightText`:
|
|
3349
|
+
* the text that the first arrow (between the `begin` and `mid` columns) will have when pointing to the
|
|
3350
|
+
* right - `endArrowLeftText`: the text that the second arrow (between the `mid` and `end` columns) will
|
|
3351
|
+
* have when pointing to the left - `endArrowRightText`: the text that the second arrow (between the `mid`
|
|
3352
|
+
* and `end` columns) will have when pointing to the right - `startArrowContainerAccessibleName`: the text
|
|
3353
|
+
* that the first arrow container (between the `begin` and `mid` columns) will have as `aria-label` - `endArrowContainerAccessibleName`:
|
|
3354
|
+
* the text that the second arrow container (between the `mid` and `end` columns) will have as `aria-label`
|
|
3355
|
+
*
|
|
3356
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3357
|
+
*
|
|
3358
|
+
* Default value is `{}`.
|
|
3359
|
+
*/
|
|
3360
|
+
setAccessibilityTexts(
|
|
3361
|
+
/**
|
|
3362
|
+
* New value for property `accessibilityTexts`
|
|
3363
|
+
*/
|
|
3364
|
+
oAccessibilityTexts?: object
|
|
3365
|
+
): this;
|
|
3366
|
+
/**
|
|
3367
|
+
* Sets the aggregated {@link #getEndColumn endColumn}.
|
|
3368
|
+
*/
|
|
3369
|
+
setEndColumn(
|
|
3370
|
+
/**
|
|
3371
|
+
* The endColumn to set
|
|
3372
|
+
*/
|
|
3373
|
+
oEndColumn: sap.ui.core.Control
|
|
3374
|
+
): this;
|
|
3375
|
+
/**
|
|
3376
|
+
* Sets a new value for property {@link #getHeight height}.
|
|
3377
|
+
*
|
|
3378
|
+
* Defines the height of the control
|
|
3379
|
+
*
|
|
3380
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3381
|
+
*/
|
|
3382
|
+
setHeight(
|
|
3383
|
+
/**
|
|
3384
|
+
* New value for property `height`
|
|
3385
|
+
*/
|
|
3386
|
+
sHeight?: sap.ui.core.CSSSize
|
|
3387
|
+
): this;
|
|
3388
|
+
/**
|
|
3389
|
+
* Sets a new value for property {@link #getHideArrows hideArrows}.
|
|
3390
|
+
*
|
|
3391
|
+
* Defines the visibility of the arrows, used for expanding and shrinking the columns.
|
|
3392
|
+
*
|
|
3393
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3394
|
+
*
|
|
3395
|
+
* Default value is `false`.
|
|
3396
|
+
*/
|
|
3397
|
+
setHideArrows(
|
|
3398
|
+
/**
|
|
3399
|
+
* New value for property `hideArrows`
|
|
3400
|
+
*/
|
|
3401
|
+
bHideArrows?: boolean
|
|
3402
|
+
): this;
|
|
3403
|
+
/**
|
|
3404
|
+
* Sets a new value for property {@link #getLayout layout}.
|
|
3405
|
+
*
|
|
3406
|
+
* Defines the columns layout and their proportion.
|
|
3407
|
+
*
|
|
3408
|
+
* **Note:** The layout also depends on the screen size - one column for screens smaller than 599px, two
|
|
3409
|
+
* columns between 599px and 1023px and three columns for sizes bigger than 1023px.
|
|
3410
|
+
*
|
|
3411
|
+
* Available options are:
|
|
3412
|
+
* - `OneColumn`
|
|
3413
|
+
* - `TwoColumnsStartExpanded`
|
|
3414
|
+
* - `TwoColumnsMidExpanded`
|
|
3415
|
+
* - `ThreeColumnsMidExpanded`
|
|
3416
|
+
* - `ThreeColumnsEndExpanded`
|
|
3417
|
+
* - `ThreeColumnsStartExpandedEndHidden`
|
|
3418
|
+
* - `ThreeColumnsMidExpandedEndHidden`
|
|
3419
|
+
* - `MidColumnFullScreen`
|
|
3420
|
+
* - `EndColumnFullScreen`
|
|
3421
|
+
*
|
|
3422
|
+
* **For example:** layout=`TwoColumnsStartExpanded` means the layout will display up to two columns in
|
|
3423
|
+
* 67%/33% proportion.
|
|
3424
|
+
*
|
|
3425
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3426
|
+
*
|
|
3427
|
+
* Default value is `OneColumn`.
|
|
2066
3428
|
*/
|
|
2067
|
-
|
|
3429
|
+
setLayout(
|
|
2068
3430
|
/**
|
|
2069
|
-
*
|
|
3431
|
+
* New value for property `layout`
|
|
2070
3432
|
*/
|
|
2071
|
-
|
|
3433
|
+
sLayout?: sap.ui.webc.fiori.FCLLayout
|
|
3434
|
+
): this;
|
|
3435
|
+
/**
|
|
3436
|
+
* Sets the aggregated {@link #getMidColumn midColumn}.
|
|
3437
|
+
*/
|
|
3438
|
+
setMidColumn(
|
|
3439
|
+
/**
|
|
3440
|
+
* The midColumn to set
|
|
3441
|
+
*/
|
|
3442
|
+
oMidColumn: sap.ui.core.Control
|
|
3443
|
+
): this;
|
|
3444
|
+
/**
|
|
3445
|
+
* Sets the aggregated {@link #getStartColumn startColumn}.
|
|
3446
|
+
*/
|
|
3447
|
+
setStartColumn(
|
|
3448
|
+
/**
|
|
3449
|
+
* The startColumn to set
|
|
3450
|
+
*/
|
|
3451
|
+
oStartColumn: sap.ui.core.Control
|
|
3452
|
+
): this;
|
|
3453
|
+
/**
|
|
3454
|
+
* Sets a new value for property {@link #getWidth width}.
|
|
3455
|
+
*
|
|
3456
|
+
* Defines the width of the control
|
|
3457
|
+
*
|
|
3458
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3459
|
+
*/
|
|
3460
|
+
setWidth(
|
|
3461
|
+
/**
|
|
3462
|
+
* New value for property `width`
|
|
3463
|
+
*/
|
|
3464
|
+
sWidth?: sap.ui.core.CSSSize
|
|
3465
|
+
): this;
|
|
3466
|
+
}
|
|
3467
|
+
/**
|
|
3468
|
+
* @SINCE 1.95.0
|
|
3469
|
+
* @EXPERIMENTAL (since 1.95.0)
|
|
3470
|
+
*
|
|
3471
|
+
* Overview: An IllustratedMessage is a recommended combination of a solution-oriented message, an engaging
|
|
3472
|
+
* illustration, and conversational tone to better communicate an empty or a success state than just show
|
|
3473
|
+
* a message alone.
|
|
3474
|
+
*
|
|
3475
|
+
* Each illustration has default internationalised title and subtitle texts. Also they can be managed with
|
|
3476
|
+
* `titleText` and `subtitleText` properties.
|
|
3477
|
+
*
|
|
3478
|
+
* Structure: The IllustratedMessage consists of the following elements, which are displayed below each
|
|
3479
|
+
* other in the following order:
|
|
3480
|
+
*
|
|
3481
|
+
*
|
|
3482
|
+
*
|
|
3483
|
+
* - Illustration
|
|
3484
|
+
* - Title
|
|
3485
|
+
* - Subtitle
|
|
3486
|
+
* - Actions
|
|
3487
|
+
*
|
|
3488
|
+
* Usage: `sap.ui.webc.fiori.IllustratedMessage` is meant to be used inside container component, for example
|
|
3489
|
+
* a `sap.ui.webc.main.Card`, a `sap.ui.webc.main.Dialog` or a `sap.ui.webc.fiori.Page`
|
|
3490
|
+
*/
|
|
3491
|
+
class IllustratedMessage extends sap.ui.webc.common.WebComponent {
|
|
3492
|
+
/**
|
|
3493
|
+
* Constructor for a new `IllustratedMessage`.
|
|
3494
|
+
*
|
|
3495
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
3496
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
3497
|
+
* of the syntax of the settings object.
|
|
3498
|
+
*/
|
|
3499
|
+
constructor(
|
|
3500
|
+
/**
|
|
3501
|
+
* Initial settings for the new control
|
|
3502
|
+
*/
|
|
3503
|
+
mSettings?: sap.ui.webc.fiori.$IllustratedMessageSettings
|
|
3504
|
+
);
|
|
3505
|
+
/**
|
|
3506
|
+
* Constructor for a new `IllustratedMessage`.
|
|
3507
|
+
*
|
|
3508
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
3509
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
3510
|
+
* of the syntax of the settings object.
|
|
3511
|
+
*/
|
|
3512
|
+
constructor(
|
|
3513
|
+
/**
|
|
3514
|
+
* ID for the new control, generated automatically if no ID is given
|
|
3515
|
+
*/
|
|
3516
|
+
sId?: string,
|
|
3517
|
+
/**
|
|
3518
|
+
* Initial settings for the new control
|
|
3519
|
+
*/
|
|
3520
|
+
mSettings?: sap.ui.webc.fiori.$IllustratedMessageSettings
|
|
3521
|
+
);
|
|
3522
|
+
|
|
3523
|
+
/**
|
|
3524
|
+
* Creates a new subclass of class sap.ui.webc.fiori.IllustratedMessage with name `sClassName` and enriches
|
|
3525
|
+
* it with the information contained in `oClassInfo`.
|
|
3526
|
+
*
|
|
3527
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
|
|
3528
|
+
*/
|
|
3529
|
+
static extend<T extends Record<string, unknown>>(
|
|
3530
|
+
/**
|
|
3531
|
+
* Name of the class being created
|
|
3532
|
+
*/
|
|
3533
|
+
sClassName: string,
|
|
3534
|
+
/**
|
|
3535
|
+
* Object literal with information about the class
|
|
3536
|
+
*/
|
|
3537
|
+
oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.IllustratedMessage>,
|
|
3538
|
+
/**
|
|
3539
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
3540
|
+
* used by this class
|
|
3541
|
+
*/
|
|
3542
|
+
FNMetaImpl?: Function
|
|
3543
|
+
): Function;
|
|
3544
|
+
/**
|
|
3545
|
+
* Returns a metadata object for class sap.ui.webc.fiori.IllustratedMessage.
|
|
3546
|
+
*/
|
|
3547
|
+
static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
|
|
3548
|
+
/**
|
|
3549
|
+
* Adds some action to the aggregation {@link #getActions actions}.
|
|
3550
|
+
*/
|
|
3551
|
+
addAction(
|
|
3552
|
+
/**
|
|
3553
|
+
* The action to add; if empty, nothing is inserted
|
|
3554
|
+
*/
|
|
3555
|
+
oAction: sap.ui.webc.main.IButton
|
|
3556
|
+
): this;
|
|
3557
|
+
/**
|
|
3558
|
+
* Destroys all the actions in the aggregation {@link #getActions actions}.
|
|
3559
|
+
*/
|
|
3560
|
+
destroyActions(): this;
|
|
3561
|
+
/**
|
|
3562
|
+
* Destroys the subtitle in the aggregation {@link #getSubtitle subtitle}.
|
|
3563
|
+
*/
|
|
3564
|
+
destroySubtitle(): this;
|
|
3565
|
+
/**
|
|
3566
|
+
* Gets content of aggregation {@link #getActions actions}.
|
|
3567
|
+
*
|
|
3568
|
+
* Defines the component actions.
|
|
3569
|
+
*/
|
|
3570
|
+
getActions(): sap.ui.webc.main.IButton[];
|
|
3571
|
+
/**
|
|
3572
|
+
* Gets current value of property {@link #getName name}.
|
|
3573
|
+
*
|
|
3574
|
+
* Default value is `BeforeSearch`.
|
|
3575
|
+
*/
|
|
3576
|
+
getName(): sap.ui.webc.fiori.IllustrationMessageType;
|
|
3577
|
+
/**
|
|
3578
|
+
* Gets content of aggregation {@link #getSubtitle subtitle}.
|
|
3579
|
+
*
|
|
3580
|
+
* Defines the subtitle of the component.
|
|
3581
|
+
*
|
|
3582
|
+
* **Note:** Using this slot, the default subtitle text of illustration and the value of `subtitleText`
|
|
3583
|
+
* property will be overwritten.
|
|
3584
|
+
*/
|
|
3585
|
+
getSubtitle(): sap.ui.core.Control;
|
|
3586
|
+
/**
|
|
3587
|
+
* Gets current value of property {@link #getSubtitleText subtitleText}.
|
|
3588
|
+
*
|
|
3589
|
+
* Defines the subtitle of the component.
|
|
3590
|
+
*
|
|
3591
|
+
* **Note:** Using this property, the default subtitle text of illustration will be overwritten.
|
|
3592
|
+
*
|
|
3593
|
+
* **Note:** Using `subtitle` slot, the default of this property will be overwritten.
|
|
3594
|
+
*
|
|
3595
|
+
* Default value is `empty string`.
|
|
3596
|
+
*/
|
|
3597
|
+
getSubtitleText(): string;
|
|
3598
|
+
/**
|
|
3599
|
+
* Gets current value of property {@link #getTitleText titleText}.
|
|
3600
|
+
*
|
|
3601
|
+
* Defines the title of the component.
|
|
3602
|
+
*
|
|
3603
|
+
* **Note:** Using this property, the default title text of illustration will be overwritten.
|
|
3604
|
+
*
|
|
3605
|
+
* Default value is `empty string`.
|
|
3606
|
+
*/
|
|
3607
|
+
getTitleText(): string;
|
|
3608
|
+
/**
|
|
3609
|
+
* Checks for the provided `sap.ui.webc.main.IButton` in the aggregation {@link #getActions actions}. and
|
|
3610
|
+
* returns its index if found or -1 otherwise.
|
|
3611
|
+
*/
|
|
3612
|
+
indexOfAction(
|
|
3613
|
+
/**
|
|
3614
|
+
* The action whose index is looked for
|
|
3615
|
+
*/
|
|
3616
|
+
oAction: sap.ui.webc.main.IButton
|
|
2072
3617
|
): int;
|
|
2073
3618
|
/**
|
|
2074
|
-
* Inserts a
|
|
3619
|
+
* Inserts a action into the aggregation {@link #getActions actions}.
|
|
2075
3620
|
*/
|
|
2076
|
-
|
|
3621
|
+
insertAction(
|
|
2077
3622
|
/**
|
|
2078
|
-
* The
|
|
3623
|
+
* The action to insert; if empty, nothing is inserted
|
|
2079
3624
|
*/
|
|
2080
|
-
|
|
3625
|
+
oAction: sap.ui.webc.main.IButton,
|
|
2081
3626
|
/**
|
|
2082
|
-
* The `0`-based index the
|
|
2083
|
-
* at position 0; for a value greater than the current size of the aggregation, the
|
|
2084
|
-
* the last position
|
|
3627
|
+
* The `0`-based index the action should be inserted at; for a negative value of `iIndex`, the action is
|
|
3628
|
+
* inserted at position 0; for a value greater than the current size of the aggregation, the action is inserted
|
|
3629
|
+
* at the last position
|
|
2085
3630
|
*/
|
|
2086
3631
|
iIndex: int
|
|
2087
3632
|
): this;
|
|
2088
3633
|
/**
|
|
2089
|
-
* Removes
|
|
3634
|
+
* Removes a action from the aggregation {@link #getActions actions}.
|
|
3635
|
+
*/
|
|
3636
|
+
removeAction(
|
|
3637
|
+
/**
|
|
3638
|
+
* The action to remove or its index or id
|
|
3639
|
+
*/
|
|
3640
|
+
vAction: int | string | sap.ui.webc.main.IButton
|
|
3641
|
+
): sap.ui.webc.main.IButton;
|
|
3642
|
+
/**
|
|
3643
|
+
* Removes all the controls from the aggregation {@link #getActions actions}.
|
|
3644
|
+
*
|
|
3645
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
3646
|
+
*/
|
|
3647
|
+
removeAllActions(): sap.ui.webc.main.IButton[];
|
|
3648
|
+
/**
|
|
3649
|
+
* Sets a new value for property {@link #getName name}.
|
|
3650
|
+
*
|
|
3651
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3652
|
+
*
|
|
3653
|
+
* Default value is `BeforeSearch`.
|
|
3654
|
+
*/
|
|
3655
|
+
setName(
|
|
3656
|
+
/**
|
|
3657
|
+
* New value for property `name`
|
|
3658
|
+
*/
|
|
3659
|
+
sName?: sap.ui.webc.fiori.IllustrationMessageType
|
|
3660
|
+
): this;
|
|
3661
|
+
/**
|
|
3662
|
+
* Sets the aggregated {@link #getSubtitle subtitle}.
|
|
3663
|
+
*/
|
|
3664
|
+
setSubtitle(
|
|
3665
|
+
/**
|
|
3666
|
+
* The subtitle to set
|
|
3667
|
+
*/
|
|
3668
|
+
oSubtitle: sap.ui.core.Control
|
|
3669
|
+
): this;
|
|
3670
|
+
/**
|
|
3671
|
+
* Sets a new value for property {@link #getSubtitleText subtitleText}.
|
|
3672
|
+
*
|
|
3673
|
+
* Defines the subtitle of the component.
|
|
3674
|
+
*
|
|
3675
|
+
* **Note:** Using this property, the default subtitle text of illustration will be overwritten.
|
|
3676
|
+
*
|
|
3677
|
+
* **Note:** Using `subtitle` slot, the default of this property will be overwritten.
|
|
3678
|
+
*
|
|
3679
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2090
3680
|
*
|
|
2091
|
-
*
|
|
2092
|
-
*/
|
|
2093
|
-
removeAllValues(): sap.ui.webc.fiori.IFilterItemOption[];
|
|
2094
|
-
/**
|
|
2095
|
-
* Removes a value from the aggregation {@link #getValues values}.
|
|
3681
|
+
* Default value is `empty string`.
|
|
2096
3682
|
*/
|
|
2097
|
-
|
|
3683
|
+
setSubtitleText(
|
|
2098
3684
|
/**
|
|
2099
|
-
*
|
|
3685
|
+
* New value for property `subtitleText`
|
|
2100
3686
|
*/
|
|
2101
|
-
|
|
2102
|
-
):
|
|
3687
|
+
sSubtitleText?: string
|
|
3688
|
+
): this;
|
|
2103
3689
|
/**
|
|
2104
|
-
* Sets a new value for property {@link #
|
|
3690
|
+
* Sets a new value for property {@link #getTitleText titleText}.
|
|
2105
3691
|
*
|
|
2106
|
-
* Defines the
|
|
3692
|
+
* Defines the title of the component.
|
|
3693
|
+
*
|
|
3694
|
+
* **Note:** Using this property, the default title text of illustration will be overwritten.
|
|
2107
3695
|
*
|
|
2108
3696
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2109
3697
|
*
|
|
2110
3698
|
* Default value is `empty string`.
|
|
2111
3699
|
*/
|
|
2112
|
-
|
|
3700
|
+
setTitleText(
|
|
2113
3701
|
/**
|
|
2114
|
-
* New value for property `
|
|
3702
|
+
* New value for property `titleText`
|
|
2115
3703
|
*/
|
|
2116
|
-
|
|
3704
|
+
sTitleText?: string
|
|
2117
3705
|
): this;
|
|
2118
3706
|
}
|
|
2119
3707
|
/**
|
|
2120
|
-
* @SINCE 1.
|
|
2121
|
-
* @EXPERIMENTAL (since 1.
|
|
3708
|
+
* @SINCE 1.99.0
|
|
3709
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
2122
3710
|
*
|
|
2123
3711
|
* Overview:
|
|
2124
3712
|
*
|
|
2125
|
-
*
|
|
3713
|
+
* The `ui-media-gallery` component allows the user to browse through multimedia items. Currently, the supported
|
|
3714
|
+
* items are images and videos. The items should be defined using the `sap.ui.webc.fiori.MediaGalleryItem`
|
|
3715
|
+
* component.
|
|
3716
|
+
*
|
|
3717
|
+
* The items are initially displayed as thumbnails. When the user selects a thumbnail, the corresponding
|
|
3718
|
+
* item is displayed in larger size.
|
|
3719
|
+
* The component is responsive by default and adjusts the position of the menu with respect to viewport
|
|
3720
|
+
* size, but the application is able to further customize the layout via the provided API.
|
|
3721
|
+
*
|
|
3722
|
+
* Keyboard Handling: The `sap.ui.webc.fiori.MediaGallery` provides advanced keyboard handling.
|
|
3723
|
+
* When the thumbnails menu is focused the following keyboard shortcuts allow the user to navigate through
|
|
3724
|
+
* the thumbnail items:
|
|
3725
|
+
*
|
|
3726
|
+
*
|
|
3727
|
+
*
|
|
3728
|
+
* - [UP/DOWN] - Navigates up and down the items
|
|
3729
|
+
* - [HOME] - Navigates to first item
|
|
3730
|
+
* - [END] - Navigates to the last item [SPACE/ENTER] - Select an item
|
|
2126
3731
|
*/
|
|
2127
|
-
class
|
|
2128
|
-
extends sap.ui.webc.common.WebComponent
|
|
2129
|
-
implements sap.ui.webc.fiori.IFilterItemOption {
|
|
2130
|
-
__implements__sap_ui_webc_fiori_IFilterItemOption: boolean;
|
|
3732
|
+
class MediaGallery extends sap.ui.webc.common.WebComponent {
|
|
2131
3733
|
/**
|
|
2132
|
-
* Constructor for a new `
|
|
3734
|
+
* Constructor for a new `MediaGallery`.
|
|
2133
3735
|
*
|
|
2134
3736
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2135
3737
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
@@ -2139,10 +3741,10 @@ declare namespace sap {
|
|
|
2139
3741
|
/**
|
|
2140
3742
|
* Initial settings for the new control
|
|
2141
3743
|
*/
|
|
2142
|
-
mSettings?: sap.ui.webc.fiori.$
|
|
3744
|
+
mSettings?: sap.ui.webc.fiori.$MediaGallerySettings
|
|
2143
3745
|
);
|
|
2144
3746
|
/**
|
|
2145
|
-
* Constructor for a new `
|
|
3747
|
+
* Constructor for a new `MediaGallery`.
|
|
2146
3748
|
*
|
|
2147
3749
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2148
3750
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
@@ -2156,12 +3758,12 @@ declare namespace sap {
|
|
|
2156
3758
|
/**
|
|
2157
3759
|
* Initial settings for the new control
|
|
2158
3760
|
*/
|
|
2159
|
-
mSettings?: sap.ui.webc.fiori.$
|
|
3761
|
+
mSettings?: sap.ui.webc.fiori.$MediaGallerySettings
|
|
2160
3762
|
);
|
|
2161
3763
|
|
|
2162
3764
|
/**
|
|
2163
|
-
* Creates a new subclass of class sap.ui.webc.fiori.
|
|
2164
|
-
*
|
|
3765
|
+
* Creates a new subclass of class sap.ui.webc.fiori.MediaGallery with name `sClassName` and enriches it
|
|
3766
|
+
* with the information contained in `oClassInfo`.
|
|
2165
3767
|
*
|
|
2166
3768
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
|
|
2167
3769
|
*/
|
|
@@ -2173,7 +3775,7 @@ declare namespace sap {
|
|
|
2173
3775
|
/**
|
|
2174
3776
|
* Object literal with information about the class
|
|
2175
3777
|
*/
|
|
2176
|
-
oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.
|
|
3778
|
+
oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.MediaGallery>,
|
|
2177
3779
|
/**
|
|
2178
3780
|
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
2179
3781
|
* used by this class
|
|
@@ -2181,156 +3783,114 @@ declare namespace sap {
|
|
|
2181
3783
|
FNMetaImpl?: Function
|
|
2182
3784
|
): Function;
|
|
2183
3785
|
/**
|
|
2184
|
-
* Returns a metadata object for class sap.ui.webc.fiori.
|
|
3786
|
+
* Returns a metadata object for class sap.ui.webc.fiori.MediaGallery.
|
|
2185
3787
|
*/
|
|
2186
3788
|
static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
|
|
2187
3789
|
/**
|
|
2188
|
-
*
|
|
2189
|
-
*
|
|
2190
|
-
* Defines whether the option is selected
|
|
2191
|
-
*
|
|
2192
|
-
* Default value is `false`.
|
|
2193
|
-
*/
|
|
2194
|
-
getSelected(): boolean;
|
|
2195
|
-
/**
|
|
2196
|
-
* Gets current value of property {@link #getText text}.
|
|
2197
|
-
*
|
|
2198
|
-
* Defines the text of the component.
|
|
2199
|
-
*
|
|
2200
|
-
* Default value is `empty string`.
|
|
3790
|
+
* Adds some item to the aggregation {@link #getItems items}.
|
|
2201
3791
|
*/
|
|
2202
|
-
|
|
3792
|
+
addItem(
|
|
3793
|
+
/**
|
|
3794
|
+
* The item to add; if empty, nothing is inserted
|
|
3795
|
+
*/
|
|
3796
|
+
oItem: sap.ui.webc.fiori.IMediaGalleryItem
|
|
3797
|
+
): this;
|
|
2203
3798
|
/**
|
|
2204
|
-
*
|
|
2205
|
-
*
|
|
2206
|
-
* Defines whether the option is selected
|
|
3799
|
+
* Attaches event handler `fnFunction` to the {@link #event:displayAreaClick displayAreaClick} event of
|
|
3800
|
+
* this `sap.ui.webc.fiori.MediaGallery`.
|
|
2207
3801
|
*
|
|
2208
|
-
* When called
|
|
3802
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
3803
|
+
* otherwise it will be bound to this `sap.ui.webc.fiori.MediaGallery` itself.
|
|
2209
3804
|
*
|
|
2210
|
-
*
|
|
3805
|
+
* Fired when the display area is clicked.
|
|
3806
|
+
* The display area is the central area that contains the enlarged content of the currently selected item.
|
|
2211
3807
|
*/
|
|
2212
|
-
|
|
3808
|
+
attachDisplayAreaClick(
|
|
2213
3809
|
/**
|
|
2214
|
-
*
|
|
3810
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
3811
|
+
* object when firing the event
|
|
2215
3812
|
*/
|
|
2216
|
-
|
|
3813
|
+
oData: object,
|
|
3814
|
+
/**
|
|
3815
|
+
* The function to be called when the event occurs
|
|
3816
|
+
*/
|
|
3817
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
3818
|
+
/**
|
|
3819
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.MediaGallery` itself
|
|
3820
|
+
*/
|
|
3821
|
+
oListener?: object
|
|
2217
3822
|
): this;
|
|
2218
3823
|
/**
|
|
2219
|
-
*
|
|
2220
|
-
*
|
|
2221
|
-
* Defines the text of the component.
|
|
3824
|
+
* Attaches event handler `fnFunction` to the {@link #event:displayAreaClick displayAreaClick} event of
|
|
3825
|
+
* this `sap.ui.webc.fiori.MediaGallery`.
|
|
2222
3826
|
*
|
|
2223
|
-
* When called
|
|
3827
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
3828
|
+
* otherwise it will be bound to this `sap.ui.webc.fiori.MediaGallery` itself.
|
|
2224
3829
|
*
|
|
2225
|
-
*
|
|
3830
|
+
* Fired when the display area is clicked.
|
|
3831
|
+
* The display area is the central area that contains the enlarged content of the currently selected item.
|
|
2226
3832
|
*/
|
|
2227
|
-
|
|
3833
|
+
attachDisplayAreaClick(
|
|
2228
3834
|
/**
|
|
2229
|
-
*
|
|
3835
|
+
* The function to be called when the event occurs
|
|
2230
3836
|
*/
|
|
2231
|
-
|
|
3837
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
3838
|
+
/**
|
|
3839
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.MediaGallery` itself
|
|
3840
|
+
*/
|
|
3841
|
+
oListener?: object
|
|
2232
3842
|
): this;
|
|
2233
|
-
}
|
|
2234
|
-
/**
|
|
2235
|
-
* @SINCE 1.92.0
|
|
2236
|
-
* @EXPERIMENTAL (since 1.92.0)
|
|
2237
|
-
*
|
|
2238
|
-
* Overview:
|
|
2239
|
-
*
|
|
2240
|
-
* The `FlexibleColumnLayout` implements the master-detail-detail paradigm by displaying up to three pages
|
|
2241
|
-
* in separate columns. There are several possible layouts that can be changed either with the component
|
|
2242
|
-
* API, or by pressing the arrows, displayed between the columns.
|
|
2243
|
-
*
|
|
2244
|
-
* Usage:
|
|
2245
|
-
*
|
|
2246
|
-
* Use this component for applications that need to display several logical levels of related information
|
|
2247
|
-
* side by side (e.g. list of items, item, sub-item, etc.). The Component is flexible in a sense that the
|
|
2248
|
-
* application can focus the user's attention on one particular column.
|
|
2249
|
-
*
|
|
2250
|
-
* Responsive Behavior:
|
|
2251
|
-
*
|
|
2252
|
-
* The `FlexibleColumnLayout` automatically displays the maximum possible number of columns based on `layout`
|
|
2253
|
-
* property and the window size. The component would display 1 column for window size smaller than 599px,
|
|
2254
|
-
* up to two columns between 599px and 1023px, and 3 columns for sizes bigger than 1023px.
|
|
2255
|
-
*
|
|
2256
|
-
*
|
|
2257
|
-
*
|
|
2258
|
-
* Keyboard Handling:
|
|
2259
|
-
*
|
|
2260
|
-
*
|
|
2261
|
-
* - [SPACE, ENTER, RETURN] - If focus is on the layout toggle button (arrow button), once activated,
|
|
2262
|
-
* it triggers the associated action (such as expand/collapse the column).
|
|
2263
|
-
*/
|
|
2264
|
-
class FlexibleColumnLayout extends sap.ui.webc.common.WebComponent {
|
|
2265
3843
|
/**
|
|
2266
|
-
*
|
|
3844
|
+
* Attaches event handler `fnFunction` to the {@link #event:overflowClick overflowClick} event of this `sap.ui.webc.fiori.MediaGallery`.
|
|
2267
3845
|
*
|
|
2268
|
-
*
|
|
2269
|
-
*
|
|
2270
|
-
*
|
|
3846
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
3847
|
+
* otherwise it will be bound to this `sap.ui.webc.fiori.MediaGallery` itself.
|
|
3848
|
+
*
|
|
3849
|
+
* Fired when the thumbnails overflow button is clicked.
|
|
2271
3850
|
*/
|
|
2272
|
-
|
|
3851
|
+
attachOverflowClick(
|
|
2273
3852
|
/**
|
|
2274
|
-
*
|
|
3853
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
3854
|
+
* object when firing the event
|
|
2275
3855
|
*/
|
|
2276
|
-
|
|
2277
|
-
);
|
|
2278
|
-
/**
|
|
2279
|
-
* Constructor for a new `FlexibleColumnLayout`.
|
|
2280
|
-
*
|
|
2281
|
-
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2282
|
-
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
2283
|
-
* of the syntax of the settings object.
|
|
2284
|
-
*/
|
|
2285
|
-
constructor(
|
|
3856
|
+
oData: object,
|
|
2286
3857
|
/**
|
|
2287
|
-
*
|
|
3858
|
+
* The function to be called when the event occurs
|
|
2288
3859
|
*/
|
|
2289
|
-
|
|
3860
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
2290
3861
|
/**
|
|
2291
|
-
*
|
|
3862
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.MediaGallery` itself
|
|
2292
3863
|
*/
|
|
2293
|
-
|
|
2294
|
-
);
|
|
2295
|
-
|
|
3864
|
+
oListener?: object
|
|
3865
|
+
): this;
|
|
2296
3866
|
/**
|
|
2297
|
-
*
|
|
2298
|
-
* it with the information contained in `oClassInfo`.
|
|
3867
|
+
* Attaches event handler `fnFunction` to the {@link #event:overflowClick overflowClick} event of this `sap.ui.webc.fiori.MediaGallery`.
|
|
2299
3868
|
*
|
|
2300
|
-
*
|
|
3869
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
3870
|
+
* otherwise it will be bound to this `sap.ui.webc.fiori.MediaGallery` itself.
|
|
3871
|
+
*
|
|
3872
|
+
* Fired when the thumbnails overflow button is clicked.
|
|
2301
3873
|
*/
|
|
2302
|
-
|
|
2303
|
-
/**
|
|
2304
|
-
* Name of the class being created
|
|
2305
|
-
*/
|
|
2306
|
-
sClassName: string,
|
|
3874
|
+
attachOverflowClick(
|
|
2307
3875
|
/**
|
|
2308
|
-
*
|
|
3876
|
+
* The function to be called when the event occurs
|
|
2309
3877
|
*/
|
|
2310
|
-
|
|
2311
|
-
T,
|
|
2312
|
-
sap.ui.webc.fiori.FlexibleColumnLayout
|
|
2313
|
-
>,
|
|
3878
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
2314
3879
|
/**
|
|
2315
|
-
*
|
|
2316
|
-
* used by this class
|
|
3880
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.MediaGallery` itself
|
|
2317
3881
|
*/
|
|
2318
|
-
|
|
2319
|
-
):
|
|
2320
|
-
/**
|
|
2321
|
-
* Returns a metadata object for class sap.ui.webc.fiori.FlexibleColumnLayout.
|
|
2322
|
-
*/
|
|
2323
|
-
static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
|
|
3882
|
+
oListener?: object
|
|
3883
|
+
): this;
|
|
2324
3884
|
/**
|
|
2325
|
-
* Attaches event handler `fnFunction` to the {@link #event:
|
|
3885
|
+
* Attaches event handler `fnFunction` to the {@link #event:selectionChange selectionChange} event of this
|
|
3886
|
+
* `sap.ui.webc.fiori.MediaGallery`.
|
|
2326
3887
|
*
|
|
2327
3888
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
2328
|
-
* otherwise it will be bound to this `sap.ui.webc.fiori.
|
|
3889
|
+
* otherwise it will be bound to this `sap.ui.webc.fiori.MediaGallery` itself.
|
|
2329
3890
|
*
|
|
2330
|
-
* Fired when
|
|
2331
|
-
* size due to resizing.
|
|
3891
|
+
* Fired when selection is changed by user interaction.
|
|
2332
3892
|
*/
|
|
2333
|
-
|
|
3893
|
+
attachSelectionChange(
|
|
2334
3894
|
/**
|
|
2335
3895
|
* An application-specific payload object that will be passed to the event handler along with the event
|
|
2336
3896
|
* object when firing the event
|
|
@@ -2341,351 +3901,338 @@ declare namespace sap {
|
|
|
2341
3901
|
*/
|
|
2342
3902
|
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
2343
3903
|
/**
|
|
2344
|
-
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.
|
|
2345
|
-
* itself
|
|
3904
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.MediaGallery` itself
|
|
2346
3905
|
*/
|
|
2347
3906
|
oListener?: object
|
|
2348
3907
|
): this;
|
|
2349
3908
|
/**
|
|
2350
|
-
* Attaches event handler `fnFunction` to the {@link #event:
|
|
3909
|
+
* Attaches event handler `fnFunction` to the {@link #event:selectionChange selectionChange} event of this
|
|
3910
|
+
* `sap.ui.webc.fiori.MediaGallery`.
|
|
2351
3911
|
*
|
|
2352
3912
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
2353
|
-
* otherwise it will be bound to this `sap.ui.webc.fiori.
|
|
3913
|
+
* otherwise it will be bound to this `sap.ui.webc.fiori.MediaGallery` itself.
|
|
2354
3914
|
*
|
|
2355
|
-
* Fired when
|
|
2356
|
-
* size due to resizing.
|
|
3915
|
+
* Fired when selection is changed by user interaction.
|
|
2357
3916
|
*/
|
|
2358
|
-
|
|
3917
|
+
attachSelectionChange(
|
|
2359
3918
|
/**
|
|
2360
3919
|
* The function to be called when the event occurs
|
|
2361
3920
|
*/
|
|
2362
3921
|
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
2363
3922
|
/**
|
|
2364
|
-
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.
|
|
2365
|
-
* itself
|
|
3923
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.MediaGallery` itself
|
|
2366
3924
|
*/
|
|
2367
3925
|
oListener?: object
|
|
2368
3926
|
): this;
|
|
2369
3927
|
/**
|
|
2370
|
-
* Destroys the
|
|
3928
|
+
* Destroys all the items in the aggregation {@link #getItems items}.
|
|
2371
3929
|
*/
|
|
2372
|
-
|
|
3930
|
+
destroyItems(): this;
|
|
2373
3931
|
/**
|
|
2374
|
-
*
|
|
3932
|
+
* Detaches event handler `fnFunction` from the {@link #event:displayAreaClick displayAreaClick} event of
|
|
3933
|
+
* this `sap.ui.webc.fiori.MediaGallery`.
|
|
3934
|
+
*
|
|
3935
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
2375
3936
|
*/
|
|
2376
|
-
|
|
3937
|
+
detachDisplayAreaClick(
|
|
3938
|
+
/**
|
|
3939
|
+
* The function to be called, when the event occurs
|
|
3940
|
+
*/
|
|
3941
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
3942
|
+
/**
|
|
3943
|
+
* Context object on which the given function had to be called
|
|
3944
|
+
*/
|
|
3945
|
+
oListener?: object
|
|
3946
|
+
): this;
|
|
2377
3947
|
/**
|
|
2378
|
-
*
|
|
3948
|
+
* Detaches event handler `fnFunction` from the {@link #event:overflowClick overflowClick} event of this
|
|
3949
|
+
* `sap.ui.webc.fiori.MediaGallery`.
|
|
3950
|
+
*
|
|
3951
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
2379
3952
|
*/
|
|
2380
|
-
|
|
3953
|
+
detachOverflowClick(
|
|
3954
|
+
/**
|
|
3955
|
+
* The function to be called, when the event occurs
|
|
3956
|
+
*/
|
|
3957
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
3958
|
+
/**
|
|
3959
|
+
* Context object on which the given function had to be called
|
|
3960
|
+
*/
|
|
3961
|
+
oListener?: object
|
|
3962
|
+
): this;
|
|
2381
3963
|
/**
|
|
2382
|
-
* Detaches event handler `fnFunction` from the {@link #event:
|
|
3964
|
+
* Detaches event handler `fnFunction` from the {@link #event:selectionChange selectionChange} event of
|
|
3965
|
+
* this `sap.ui.webc.fiori.MediaGallery`.
|
|
2383
3966
|
*
|
|
2384
3967
|
* The passed function and listener object must match the ones used for event registration.
|
|
2385
3968
|
*/
|
|
2386
|
-
|
|
3969
|
+
detachSelectionChange(
|
|
2387
3970
|
/**
|
|
2388
3971
|
* The function to be called, when the event occurs
|
|
2389
3972
|
*/
|
|
2390
3973
|
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
2391
3974
|
/**
|
|
2392
|
-
* Context object on which the given function had to be called
|
|
3975
|
+
* Context object on which the given function had to be called
|
|
3976
|
+
*/
|
|
3977
|
+
oListener?: object
|
|
3978
|
+
): this;
|
|
3979
|
+
/**
|
|
3980
|
+
* Fires event {@link #event:displayAreaClick displayAreaClick} to attached listeners.
|
|
3981
|
+
*/
|
|
3982
|
+
fireDisplayAreaClick(
|
|
3983
|
+
/**
|
|
3984
|
+
* Parameters to pass along with the event
|
|
3985
|
+
*/
|
|
3986
|
+
mParameters?: object
|
|
3987
|
+
): this;
|
|
3988
|
+
/**
|
|
3989
|
+
* Fires event {@link #event:overflowClick overflowClick} to attached listeners.
|
|
3990
|
+
*/
|
|
3991
|
+
fireOverflowClick(
|
|
3992
|
+
/**
|
|
3993
|
+
* Parameters to pass along with the event
|
|
2393
3994
|
*/
|
|
2394
|
-
|
|
3995
|
+
mParameters?: object
|
|
2395
3996
|
): this;
|
|
2396
3997
|
/**
|
|
2397
|
-
* Fires event {@link #event:
|
|
3998
|
+
* Fires event {@link #event:selectionChange selectionChange} to attached listeners.
|
|
2398
3999
|
*/
|
|
2399
|
-
|
|
4000
|
+
fireSelectionChange(
|
|
2400
4001
|
/**
|
|
2401
4002
|
* Parameters to pass along with the event
|
|
2402
4003
|
*/
|
|
2403
4004
|
mParameters?: {
|
|
2404
4005
|
/**
|
|
2405
|
-
*
|
|
2406
|
-
*/
|
|
2407
|
-
layout?: FCLLayout;
|
|
2408
|
-
/**
|
|
2409
|
-
* The effective column layout, f.e [67%, 33%, 0]
|
|
2410
|
-
*/
|
|
2411
|
-
columnLayout?: any[];
|
|
2412
|
-
/**
|
|
2413
|
-
* Indicates if the start column is currently visible
|
|
2414
|
-
*/
|
|
2415
|
-
startColumnVisible?: boolean;
|
|
2416
|
-
/**
|
|
2417
|
-
* Indicates if the middle column is currently visible
|
|
2418
|
-
*/
|
|
2419
|
-
midColumnVisible?: boolean;
|
|
2420
|
-
/**
|
|
2421
|
-
* Indicates if the end column is currently visible
|
|
2422
|
-
*/
|
|
2423
|
-
endColumnVisible?: boolean;
|
|
2424
|
-
/**
|
|
2425
|
-
* Indicates if the layout is changed via the arrows
|
|
2426
|
-
*/
|
|
2427
|
-
arrowsUsed?: boolean;
|
|
2428
|
-
/**
|
|
2429
|
-
* Indicates if the layout is changed via resizing
|
|
4006
|
+
* the selected item.
|
|
2430
4007
|
*/
|
|
2431
|
-
|
|
4008
|
+
item?: HTMLElement;
|
|
2432
4009
|
}
|
|
2433
4010
|
): this;
|
|
2434
4011
|
/**
|
|
2435
|
-
* Gets current value of property {@link #
|
|
4012
|
+
* Gets current value of property {@link #getInteractiveDisplayArea interactiveDisplayArea}.
|
|
2436
4013
|
*
|
|
2437
|
-
*
|
|
2438
|
-
*
|
|
2439
|
-
* It supports the following fields: - `startColumnAccessibleName`: the accessibility name for the `startColumn`
|
|
2440
|
-
* region - `midColumnAccessibleName`: the accessibility name for the `midColumn` region - `endColumnAccessibleName`:
|
|
2441
|
-
* the accessibility name for the `endColumn` region - `startArrowLeftText`: the text that the first arrow
|
|
2442
|
-
* (between the `begin` and `mid` columns) will have when pointing to the left - `startArrowRightText`:
|
|
2443
|
-
* the text that the first arrow (between the `begin` and `mid` columns) will have when pointing to the
|
|
2444
|
-
* right - `endArrowLeftText`: the text that the second arrow (between the `mid` and `end` columns) will
|
|
2445
|
-
* have when pointing to the left - `endArrowRightText`: the text that the second arrow (between the `mid`
|
|
2446
|
-
* and `end` columns) will have when pointing to the right
|
|
4014
|
+
* If enabled, a `display-area-click` event is fired when the user clicks or taps on the display area.
|
|
4015
|
+
* The display area is the central area that contains the enlarged content of the currently selected item.
|
|
2447
4016
|
*
|
|
2448
|
-
* Default value is `
|
|
4017
|
+
* Default value is `false`.
|
|
2449
4018
|
*/
|
|
2450
|
-
|
|
4019
|
+
getInteractiveDisplayArea(): boolean;
|
|
2451
4020
|
/**
|
|
2452
|
-
*
|
|
4021
|
+
* Gets content of aggregation {@link #getItems items}.
|
|
2453
4022
|
*
|
|
2454
|
-
*
|
|
2455
|
-
* the width of the start, middle and end columns.
|
|
2456
|
-
*/
|
|
2457
|
-
getColumnLayout(): void;
|
|
2458
|
-
/**
|
|
2459
|
-
* Gets content of aggregation {@link #getEndColumn endColumn}.
|
|
4023
|
+
* Defines the component items.
|
|
2460
4024
|
*
|
|
2461
|
-
* Defines the content in the end column.
|
|
2462
|
-
*/
|
|
2463
|
-
getEndColumn(): sap.ui.core.Control;
|
|
2464
|
-
/**
|
|
2465
|
-
* Returns if the `end` column is visible.
|
|
2466
|
-
*/
|
|
2467
|
-
getEndColumnVisible(): void;
|
|
2468
|
-
/**
|
|
2469
|
-
* Gets current value of property {@link #getHeight height}.
|
|
2470
4025
|
*
|
|
2471
|
-
* Defines the height of the control
|
|
2472
|
-
*/
|
|
2473
|
-
getHeight(): sap.ui.core.CSSSize;
|
|
2474
|
-
/**
|
|
2475
|
-
* Gets current value of property {@link #getHideArrows hideArrows}.
|
|
2476
4026
|
*
|
|
2477
|
-
*
|
|
4027
|
+
* **Note:** Only one selected item is allowed.
|
|
2478
4028
|
*
|
|
2479
|
-
*
|
|
4029
|
+
*
|
|
4030
|
+
*
|
|
4031
|
+
* **Note:** Use the `sap.ui.webc.fiori.MediaGalleryItem` component to define the desired items.
|
|
2480
4032
|
*/
|
|
2481
|
-
|
|
4033
|
+
getItems(): sap.ui.webc.fiori.IMediaGalleryItem[];
|
|
2482
4034
|
/**
|
|
2483
4035
|
* Gets current value of property {@link #getLayout layout}.
|
|
2484
4036
|
*
|
|
2485
|
-
*
|
|
2486
|
-
*
|
|
2487
|
-
* **Note:** The layout also depends on the screen size - one column for screens smaller than 599px, two
|
|
2488
|
-
* columns between 599px and 1023px and three columns for sizes bigger than 1023px.
|
|
4037
|
+
* Determines the layout of the component.
|
|
2489
4038
|
*
|
|
2490
4039
|
* Available options are:
|
|
2491
|
-
* - `
|
|
2492
|
-
* - `
|
|
2493
|
-
* - `
|
|
2494
|
-
* - `ThreeColumnsMidExpanded`
|
|
2495
|
-
* - `ThreeColumnsEndExpanded`
|
|
2496
|
-
* - `ThreeColumnsStartExpandedEndHidden`
|
|
2497
|
-
* - `ThreeColumnsMidExpandedEndHidden`
|
|
2498
|
-
* - `MidColumnFullScreen`
|
|
2499
|
-
* - `EndColumnFullScreen`
|
|
2500
|
-
*
|
|
2501
|
-
* **For example:** layout=`TwoColumnsStartExpanded` means the layout will display up to two columns in
|
|
2502
|
-
* 67%/33% proportion.
|
|
4040
|
+
* - `Auto`
|
|
4041
|
+
* - `Vertical`
|
|
4042
|
+
* - `Horizontal`
|
|
2503
4043
|
*
|
|
2504
|
-
* Default value is `
|
|
4044
|
+
* Default value is `Auto`.
|
|
2505
4045
|
*/
|
|
2506
|
-
getLayout(): sap.ui.webc.fiori.
|
|
4046
|
+
getLayout(): sap.ui.webc.fiori.MediaGalleryLayout;
|
|
2507
4047
|
/**
|
|
2508
|
-
* Gets
|
|
4048
|
+
* Gets current value of property {@link #getMenuHorizontalAlign menuHorizontalAlign}.
|
|
2509
4049
|
*
|
|
2510
|
-
*
|
|
2511
|
-
*/
|
|
2512
|
-
getMidColumn(): sap.ui.core.Control;
|
|
2513
|
-
/**
|
|
2514
|
-
* Returns if the `middle` column is visible.
|
|
2515
|
-
*/
|
|
2516
|
-
getMidColumnVisible(): void;
|
|
2517
|
-
/**
|
|
2518
|
-
* Gets content of aggregation {@link #getStartColumn startColumn}.
|
|
4050
|
+
* Determines the horizontal alignment of the thumbnails menu vs. the central display area.
|
|
2519
4051
|
*
|
|
2520
|
-
*
|
|
2521
|
-
|
|
2522
|
-
|
|
2523
|
-
/**
|
|
2524
|
-
* Returns if the `start` column is visible.
|
|
2525
|
-
*/
|
|
2526
|
-
getStartColumnVisible(): void;
|
|
2527
|
-
/**
|
|
2528
|
-
* Returns the number of currently visible columns.
|
|
2529
|
-
*/
|
|
2530
|
-
getVisibleColumns(): void;
|
|
2531
|
-
/**
|
|
2532
|
-
* Gets current value of property {@link #getWidth width}.
|
|
4052
|
+
* Available options are:
|
|
4053
|
+
* - `Left`
|
|
4054
|
+
* - `Right`
|
|
2533
4055
|
*
|
|
2534
|
-
*
|
|
4056
|
+
* Default value is `Left`.
|
|
2535
4057
|
*/
|
|
2536
|
-
|
|
4058
|
+
getMenuHorizontalAlign(): sap.ui.webc.fiori.MediaGalleryMenuHorizontalAlign;
|
|
2537
4059
|
/**
|
|
2538
|
-
*
|
|
4060
|
+
* Gets current value of property {@link #getMenuVerticalAlign menuVerticalAlign}.
|
|
2539
4061
|
*
|
|
2540
|
-
*
|
|
4062
|
+
* Determines the vertical alignment of the thumbnails menu vs. the central display area.
|
|
2541
4063
|
*
|
|
2542
|
-
*
|
|
2543
|
-
*
|
|
2544
|
-
*
|
|
2545
|
-
* (between the `begin` and `mid` columns) will have when pointing to the left - `startArrowRightText`:
|
|
2546
|
-
* the text that the first arrow (between the `begin` and `mid` columns) will have when pointing to the
|
|
2547
|
-
* right - `endArrowLeftText`: the text that the second arrow (between the `mid` and `end` columns) will
|
|
2548
|
-
* have when pointing to the left - `endArrowRightText`: the text that the second arrow (between the `mid`
|
|
2549
|
-
* and `end` columns) will have when pointing to the right
|
|
4064
|
+
* Available options are:
|
|
4065
|
+
* - `Top`
|
|
4066
|
+
* - `Bottom`
|
|
2550
4067
|
*
|
|
2551
|
-
*
|
|
4068
|
+
* Default value is `Bottom`.
|
|
4069
|
+
*/
|
|
4070
|
+
getMenuVerticalAlign(): sap.ui.webc.fiori.MediaGalleryMenuVerticalAlign;
|
|
4071
|
+
/**
|
|
4072
|
+
* Gets current value of property {@link #getShowAllThumbnails showAllThumbnails}.
|
|
2552
4073
|
*
|
|
2553
|
-
*
|
|
4074
|
+
* If set to `true`, all thumbnails are rendered in a scrollable container. If `false`, only up to five
|
|
4075
|
+
* thumbnails are rendered, followed by an overflow button that shows the count of the remaining thumbnails.
|
|
4076
|
+
*
|
|
4077
|
+
* Default value is `false`.
|
|
2554
4078
|
*/
|
|
2555
|
-
|
|
4079
|
+
getShowAllThumbnails(): boolean;
|
|
4080
|
+
/**
|
|
4081
|
+
* Checks for the provided `sap.ui.webc.fiori.IMediaGalleryItem` in the aggregation {@link #getItems items}.
|
|
4082
|
+
* and returns its index if found or -1 otherwise.
|
|
4083
|
+
*/
|
|
4084
|
+
indexOfItem(
|
|
2556
4085
|
/**
|
|
2557
|
-
*
|
|
4086
|
+
* The item whose index is looked for
|
|
2558
4087
|
*/
|
|
2559
|
-
|
|
2560
|
-
):
|
|
4088
|
+
oItem: sap.ui.webc.fiori.IMediaGalleryItem
|
|
4089
|
+
): int;
|
|
2561
4090
|
/**
|
|
2562
|
-
*
|
|
4091
|
+
* Inserts a item into the aggregation {@link #getItems items}.
|
|
2563
4092
|
*/
|
|
2564
|
-
|
|
4093
|
+
insertItem(
|
|
2565
4094
|
/**
|
|
2566
|
-
* The
|
|
4095
|
+
* The item to insert; if empty, nothing is inserted
|
|
2567
4096
|
*/
|
|
2568
|
-
|
|
4097
|
+
oItem: sap.ui.webc.fiori.IMediaGalleryItem,
|
|
4098
|
+
/**
|
|
4099
|
+
* The `0`-based index the item should be inserted at; for a negative value of `iIndex`, the item is inserted
|
|
4100
|
+
* at position 0; for a value greater than the current size of the aggregation, the item is inserted at
|
|
4101
|
+
* the last position
|
|
4102
|
+
*/
|
|
4103
|
+
iIndex: int
|
|
2569
4104
|
): this;
|
|
2570
4105
|
/**
|
|
2571
|
-
*
|
|
2572
|
-
*
|
|
2573
|
-
* Defines the height of the control
|
|
4106
|
+
* Removes all the controls from the aggregation {@link #getItems items}.
|
|
2574
4107
|
*
|
|
2575
|
-
*
|
|
4108
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
2576
4109
|
*/
|
|
2577
|
-
|
|
4110
|
+
removeAllItems(): sap.ui.webc.fiori.IMediaGalleryItem[];
|
|
4111
|
+
/**
|
|
4112
|
+
* Removes a item from the aggregation {@link #getItems items}.
|
|
4113
|
+
*/
|
|
4114
|
+
removeItem(
|
|
2578
4115
|
/**
|
|
2579
|
-
*
|
|
4116
|
+
* The item to remove or its index or id
|
|
2580
4117
|
*/
|
|
2581
|
-
|
|
2582
|
-
):
|
|
4118
|
+
vItem: int | string | sap.ui.webc.fiori.IMediaGalleryItem
|
|
4119
|
+
): sap.ui.webc.fiori.IMediaGalleryItem;
|
|
2583
4120
|
/**
|
|
2584
|
-
* Sets a new value for property {@link #
|
|
4121
|
+
* Sets a new value for property {@link #getInteractiveDisplayArea interactiveDisplayArea}.
|
|
2585
4122
|
*
|
|
2586
|
-
*
|
|
4123
|
+
* If enabled, a `display-area-click` event is fired when the user clicks or taps on the display area.
|
|
4124
|
+
* The display area is the central area that contains the enlarged content of the currently selected item.
|
|
2587
4125
|
*
|
|
2588
4126
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2589
4127
|
*
|
|
2590
4128
|
* Default value is `false`.
|
|
2591
4129
|
*/
|
|
2592
|
-
|
|
4130
|
+
setInteractiveDisplayArea(
|
|
2593
4131
|
/**
|
|
2594
|
-
* New value for property `
|
|
4132
|
+
* New value for property `interactiveDisplayArea`
|
|
2595
4133
|
*/
|
|
2596
|
-
|
|
4134
|
+
bInteractiveDisplayArea?: boolean
|
|
2597
4135
|
): this;
|
|
2598
4136
|
/**
|
|
2599
4137
|
* Sets a new value for property {@link #getLayout layout}.
|
|
2600
4138
|
*
|
|
2601
|
-
*
|
|
2602
|
-
*
|
|
2603
|
-
* **Note:** The layout also depends on the screen size - one column for screens smaller than 599px, two
|
|
2604
|
-
* columns between 599px and 1023px and three columns for sizes bigger than 1023px.
|
|
4139
|
+
* Determines the layout of the component.
|
|
2605
4140
|
*
|
|
2606
4141
|
* Available options are:
|
|
2607
|
-
* - `
|
|
2608
|
-
* - `
|
|
2609
|
-
* - `
|
|
2610
|
-
* - `ThreeColumnsMidExpanded`
|
|
2611
|
-
* - `ThreeColumnsEndExpanded`
|
|
2612
|
-
* - `ThreeColumnsStartExpandedEndHidden`
|
|
2613
|
-
* - `ThreeColumnsMidExpandedEndHidden`
|
|
2614
|
-
* - `MidColumnFullScreen`
|
|
2615
|
-
* - `EndColumnFullScreen`
|
|
2616
|
-
*
|
|
2617
|
-
* **For example:** layout=`TwoColumnsStartExpanded` means the layout will display up to two columns in
|
|
2618
|
-
* 67%/33% proportion.
|
|
4142
|
+
* - `Auto`
|
|
4143
|
+
* - `Vertical`
|
|
4144
|
+
* - `Horizontal`
|
|
2619
4145
|
*
|
|
2620
4146
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2621
4147
|
*
|
|
2622
|
-
* Default value is `
|
|
4148
|
+
* Default value is `Auto`.
|
|
2623
4149
|
*/
|
|
2624
4150
|
setLayout(
|
|
2625
4151
|
/**
|
|
2626
4152
|
* New value for property `layout`
|
|
2627
4153
|
*/
|
|
2628
|
-
sLayout?: sap.ui.webc.fiori.
|
|
4154
|
+
sLayout?: sap.ui.webc.fiori.MediaGalleryLayout
|
|
2629
4155
|
): this;
|
|
2630
4156
|
/**
|
|
2631
|
-
* Sets
|
|
4157
|
+
* Sets a new value for property {@link #getMenuHorizontalAlign menuHorizontalAlign}.
|
|
4158
|
+
*
|
|
4159
|
+
* Determines the horizontal alignment of the thumbnails menu vs. the central display area.
|
|
4160
|
+
*
|
|
4161
|
+
* Available options are:
|
|
4162
|
+
* - `Left`
|
|
4163
|
+
* - `Right`
|
|
4164
|
+
*
|
|
4165
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
4166
|
+
*
|
|
4167
|
+
* Default value is `Left`.
|
|
2632
4168
|
*/
|
|
2633
|
-
|
|
4169
|
+
setMenuHorizontalAlign(
|
|
2634
4170
|
/**
|
|
2635
|
-
*
|
|
4171
|
+
* New value for property `menuHorizontalAlign`
|
|
2636
4172
|
*/
|
|
2637
|
-
|
|
4173
|
+
sMenuHorizontalAlign?: sap.ui.webc.fiori.MediaGalleryMenuHorizontalAlign
|
|
2638
4174
|
): this;
|
|
2639
4175
|
/**
|
|
2640
|
-
* Sets
|
|
4176
|
+
* Sets a new value for property {@link #getMenuVerticalAlign menuVerticalAlign}.
|
|
4177
|
+
*
|
|
4178
|
+
* Determines the vertical alignment of the thumbnails menu vs. the central display area.
|
|
4179
|
+
*
|
|
4180
|
+
* Available options are:
|
|
4181
|
+
* - `Top`
|
|
4182
|
+
* - `Bottom`
|
|
4183
|
+
*
|
|
4184
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
4185
|
+
*
|
|
4186
|
+
* Default value is `Bottom`.
|
|
2641
4187
|
*/
|
|
2642
|
-
|
|
4188
|
+
setMenuVerticalAlign(
|
|
2643
4189
|
/**
|
|
2644
|
-
*
|
|
4190
|
+
* New value for property `menuVerticalAlign`
|
|
2645
4191
|
*/
|
|
2646
|
-
|
|
4192
|
+
sMenuVerticalAlign?: sap.ui.webc.fiori.MediaGalleryMenuVerticalAlign
|
|
2647
4193
|
): this;
|
|
2648
4194
|
/**
|
|
2649
|
-
* Sets a new value for property {@link #
|
|
4195
|
+
* Sets a new value for property {@link #getShowAllThumbnails showAllThumbnails}.
|
|
2650
4196
|
*
|
|
2651
|
-
*
|
|
4197
|
+
* If set to `true`, all thumbnails are rendered in a scrollable container. If `false`, only up to five
|
|
4198
|
+
* thumbnails are rendered, followed by an overflow button that shows the count of the remaining thumbnails.
|
|
2652
4199
|
*
|
|
2653
4200
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
4201
|
+
*
|
|
4202
|
+
* Default value is `false`.
|
|
2654
4203
|
*/
|
|
2655
|
-
|
|
4204
|
+
setShowAllThumbnails(
|
|
2656
4205
|
/**
|
|
2657
|
-
* New value for property `
|
|
4206
|
+
* New value for property `showAllThumbnails`
|
|
2658
4207
|
*/
|
|
2659
|
-
|
|
4208
|
+
bShowAllThumbnails?: boolean
|
|
2660
4209
|
): this;
|
|
2661
4210
|
}
|
|
2662
4211
|
/**
|
|
2663
|
-
* @SINCE 1.
|
|
2664
|
-
* @EXPERIMENTAL (since 1.
|
|
4212
|
+
* @SINCE 1.99.0
|
|
4213
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
2665
4214
|
*
|
|
2666
|
-
* Overview:
|
|
2667
|
-
*
|
|
2668
|
-
* a message alone.
|
|
4215
|
+
* Overview: The `sap.ui.webc.fiori.MediaGalleryItem` web component represents the items displayed in the
|
|
4216
|
+
* `sap.ui.webc.fiori.MediaGallery` web component.
|
|
2669
4217
|
*
|
|
2670
|
-
*
|
|
2671
|
-
* `titleText` and `subtitleText` properties.
|
|
4218
|
+
* **Note:** `sap.ui.webc.fiori.MediaGalleryItem` is not supported when used outside of `sap.ui.webc.fiori.MediaGallery`.
|
|
2672
4219
|
*
|
|
2673
|
-
* Structure: The IllustratedMessage consists of the following elements, which are displayed below each
|
|
2674
|
-
* other in the following order:
|
|
2675
4220
|
*
|
|
2676
4221
|
*
|
|
2677
4222
|
*
|
|
2678
|
-
*
|
|
2679
|
-
*
|
|
2680
|
-
* - Subtitle
|
|
2681
|
-
* - Actions
|
|
4223
|
+
* Keyboard Handling: The `sap.ui.webc.fiori.MediaGallery` provides advanced keyboard handling. When focused,
|
|
4224
|
+
* the user can use the following keyboard shortcuts in order to perform a navigation:
|
|
2682
4225
|
*
|
|
2683
|
-
*
|
|
2684
|
-
*
|
|
4226
|
+
*
|
|
4227
|
+
*
|
|
4228
|
+
* - [SPACE/ENTER/RETURN] - Trigger `ui5-click` event
|
|
2685
4229
|
*/
|
|
2686
|
-
class
|
|
4230
|
+
class MediaGalleryItem
|
|
4231
|
+
extends sap.ui.webc.common.WebComponent
|
|
4232
|
+
implements sap.ui.webc.fiori.IMediaGalleryItem {
|
|
4233
|
+
__implements__sap_ui_webc_fiori_IMediaGalleryItem: boolean;
|
|
2687
4234
|
/**
|
|
2688
|
-
* Constructor for a new `
|
|
4235
|
+
* Constructor for a new `MediaGalleryItem`.
|
|
2689
4236
|
*
|
|
2690
4237
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2691
4238
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
@@ -2695,10 +4242,10 @@ declare namespace sap {
|
|
|
2695
4242
|
/**
|
|
2696
4243
|
* Initial settings for the new control
|
|
2697
4244
|
*/
|
|
2698
|
-
mSettings?: sap.ui.webc.fiori.$
|
|
4245
|
+
mSettings?: sap.ui.webc.fiori.$MediaGalleryItemSettings
|
|
2699
4246
|
);
|
|
2700
4247
|
/**
|
|
2701
|
-
* Constructor for a new `
|
|
4248
|
+
* Constructor for a new `MediaGalleryItem`.
|
|
2702
4249
|
*
|
|
2703
4250
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2704
4251
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
@@ -2712,11 +4259,11 @@ declare namespace sap {
|
|
|
2712
4259
|
/**
|
|
2713
4260
|
* Initial settings for the new control
|
|
2714
4261
|
*/
|
|
2715
|
-
mSettings?: sap.ui.webc.fiori.$
|
|
4262
|
+
mSettings?: sap.ui.webc.fiori.$MediaGalleryItemSettings
|
|
2716
4263
|
);
|
|
2717
4264
|
|
|
2718
4265
|
/**
|
|
2719
|
-
* Creates a new subclass of class sap.ui.webc.fiori.
|
|
4266
|
+
* Creates a new subclass of class sap.ui.webc.fiori.MediaGalleryItem with name `sClassName` and enriches
|
|
2720
4267
|
* it with the information contained in `oClassInfo`.
|
|
2721
4268
|
*
|
|
2722
4269
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
|
|
@@ -2729,7 +4276,7 @@ declare namespace sap {
|
|
|
2729
4276
|
/**
|
|
2730
4277
|
* Object literal with information about the class
|
|
2731
4278
|
*/
|
|
2732
|
-
oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.
|
|
4279
|
+
oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.MediaGalleryItem>,
|
|
2733
4280
|
/**
|
|
2734
4281
|
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
2735
4282
|
* used by this class
|
|
@@ -2737,166 +4284,203 @@ declare namespace sap {
|
|
|
2737
4284
|
FNMetaImpl?: Function
|
|
2738
4285
|
): Function;
|
|
2739
4286
|
/**
|
|
2740
|
-
* Returns a metadata object for class sap.ui.webc.fiori.
|
|
4287
|
+
* Returns a metadata object for class sap.ui.webc.fiori.MediaGalleryItem.
|
|
2741
4288
|
*/
|
|
2742
4289
|
static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
|
|
2743
4290
|
/**
|
|
2744
|
-
* Adds some
|
|
4291
|
+
* Adds some content to the aggregation {@link #getContent content}.
|
|
2745
4292
|
*/
|
|
2746
|
-
|
|
4293
|
+
addContent(
|
|
2747
4294
|
/**
|
|
2748
|
-
* The
|
|
4295
|
+
* The content to add; if empty, nothing is inserted
|
|
2749
4296
|
*/
|
|
2750
|
-
|
|
4297
|
+
oContent: sap.ui.core.Control
|
|
2751
4298
|
): this;
|
|
2752
4299
|
/**
|
|
2753
|
-
*
|
|
4300
|
+
* Adds some thumbnail to the aggregation {@link #getThumbnail thumbnail}.
|
|
2754
4301
|
*/
|
|
2755
|
-
|
|
4302
|
+
addThumbnail(
|
|
4303
|
+
/**
|
|
4304
|
+
* The thumbnail to add; if empty, nothing is inserted
|
|
4305
|
+
*/
|
|
4306
|
+
oThumbnail: sap.ui.core.Control
|
|
4307
|
+
): this;
|
|
2756
4308
|
/**
|
|
2757
|
-
* Destroys the
|
|
4309
|
+
* Destroys all the content in the aggregation {@link #getContent content}.
|
|
2758
4310
|
*/
|
|
2759
|
-
|
|
4311
|
+
destroyContent(): this;
|
|
2760
4312
|
/**
|
|
2761
|
-
*
|
|
2762
|
-
*
|
|
2763
|
-
* Defines the component actions.
|
|
4313
|
+
* Destroys all the thumbnail in the aggregation {@link #getThumbnail thumbnail}.
|
|
2764
4314
|
*/
|
|
2765
|
-
|
|
4315
|
+
destroyThumbnail(): this;
|
|
2766
4316
|
/**
|
|
2767
|
-
* Gets
|
|
4317
|
+
* Gets content of aggregation {@link #getContent content}.
|
|
2768
4318
|
*
|
|
2769
|
-
*
|
|
4319
|
+
* Defines the content of the component.
|
|
2770
4320
|
*/
|
|
2771
|
-
|
|
4321
|
+
getContent(): sap.ui.core.Control[];
|
|
2772
4322
|
/**
|
|
2773
|
-
* Gets
|
|
4323
|
+
* Gets current value of property {@link #getDisabled disabled}.
|
|
2774
4324
|
*
|
|
2775
|
-
* Defines the
|
|
4325
|
+
* Defines whether the component is in disabled state.
|
|
2776
4326
|
*
|
|
2777
|
-
*
|
|
2778
|
-
* property will be overwritten.
|
|
4327
|
+
* Default value is `false`.
|
|
2779
4328
|
*/
|
|
2780
|
-
|
|
4329
|
+
getDisabled(): boolean;
|
|
2781
4330
|
/**
|
|
2782
|
-
* Gets current value of property {@link #
|
|
2783
|
-
*
|
|
2784
|
-
* Defines the subtitle of the component.
|
|
4331
|
+
* Gets current value of property {@link #getLayout layout}.
|
|
2785
4332
|
*
|
|
2786
|
-
*
|
|
4333
|
+
* Determines the layout of the item container.
|
|
2787
4334
|
*
|
|
2788
|
-
*
|
|
4335
|
+
* Available options are:
|
|
4336
|
+
* - `Square`
|
|
4337
|
+
* - `Wide`
|
|
2789
4338
|
*
|
|
2790
|
-
* Default value is `
|
|
4339
|
+
* Default value is `Square`.
|
|
2791
4340
|
*/
|
|
2792
|
-
|
|
4341
|
+
getLayout(): sap.ui.webc.fiori.MediaGalleryItemLayout;
|
|
2793
4342
|
/**
|
|
2794
|
-
* Gets current value of property {@link #
|
|
4343
|
+
* Gets current value of property {@link #getSelected selected}.
|
|
2795
4344
|
*
|
|
2796
|
-
* Defines the
|
|
4345
|
+
* Defines the selected state of the component.
|
|
2797
4346
|
*
|
|
2798
|
-
*
|
|
4347
|
+
* Default value is `false`.
|
|
4348
|
+
*/
|
|
4349
|
+
getSelected(): boolean;
|
|
4350
|
+
/**
|
|
4351
|
+
* Gets content of aggregation {@link #getThumbnail thumbnail}.
|
|
2799
4352
|
*
|
|
2800
|
-
*
|
|
4353
|
+
* Defines the content of the thumbnail.
|
|
2801
4354
|
*/
|
|
2802
|
-
|
|
4355
|
+
getThumbnail(): sap.ui.core.Control[];
|
|
2803
4356
|
/**
|
|
2804
|
-
* Checks for the provided `sap.ui.
|
|
4357
|
+
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getContent content}. and returns
|
|
4358
|
+
* its index if found or -1 otherwise.
|
|
4359
|
+
*/
|
|
4360
|
+
indexOfContent(
|
|
4361
|
+
/**
|
|
4362
|
+
* The content whose index is looked for
|
|
4363
|
+
*/
|
|
4364
|
+
oContent: sap.ui.core.Control
|
|
4365
|
+
): int;
|
|
4366
|
+
/**
|
|
4367
|
+
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getThumbnail thumbnail}. and
|
|
2805
4368
|
* returns its index if found or -1 otherwise.
|
|
2806
4369
|
*/
|
|
2807
|
-
|
|
4370
|
+
indexOfThumbnail(
|
|
2808
4371
|
/**
|
|
2809
|
-
* The
|
|
4372
|
+
* The thumbnail whose index is looked for
|
|
2810
4373
|
*/
|
|
2811
|
-
|
|
4374
|
+
oThumbnail: sap.ui.core.Control
|
|
2812
4375
|
): int;
|
|
2813
4376
|
/**
|
|
2814
|
-
* Inserts a
|
|
4377
|
+
* Inserts a content into the aggregation {@link #getContent content}.
|
|
2815
4378
|
*/
|
|
2816
|
-
|
|
4379
|
+
insertContent(
|
|
2817
4380
|
/**
|
|
2818
|
-
* The
|
|
4381
|
+
* The content to insert; if empty, nothing is inserted
|
|
2819
4382
|
*/
|
|
2820
|
-
|
|
4383
|
+
oContent: sap.ui.core.Control,
|
|
2821
4384
|
/**
|
|
2822
|
-
* The `0`-based index the
|
|
2823
|
-
* inserted at position 0; for a value greater than the current size of the aggregation, the
|
|
2824
|
-
* at the last position
|
|
4385
|
+
* The `0`-based index the content should be inserted at; for a negative value of `iIndex`, the content
|
|
4386
|
+
* is inserted at position 0; for a value greater than the current size of the aggregation, the content
|
|
4387
|
+
* is inserted at the last position
|
|
2825
4388
|
*/
|
|
2826
4389
|
iIndex: int
|
|
2827
4390
|
): this;
|
|
2828
4391
|
/**
|
|
2829
|
-
*
|
|
4392
|
+
* Inserts a thumbnail into the aggregation {@link #getThumbnail thumbnail}.
|
|
2830
4393
|
*/
|
|
2831
|
-
|
|
4394
|
+
insertThumbnail(
|
|
2832
4395
|
/**
|
|
2833
|
-
* The
|
|
4396
|
+
* The thumbnail to insert; if empty, nothing is inserted
|
|
2834
4397
|
*/
|
|
2835
|
-
|
|
2836
|
-
|
|
4398
|
+
oThumbnail: sap.ui.core.Control,
|
|
4399
|
+
/**
|
|
4400
|
+
* The `0`-based index the thumbnail should be inserted at; for a negative value of `iIndex`, the thumbnail
|
|
4401
|
+
* is inserted at position 0; for a value greater than the current size of the aggregation, the thumbnail
|
|
4402
|
+
* is inserted at the last position
|
|
4403
|
+
*/
|
|
4404
|
+
iIndex: int
|
|
4405
|
+
): this;
|
|
2837
4406
|
/**
|
|
2838
|
-
* Removes all the controls from the aggregation {@link #
|
|
4407
|
+
* Removes all the controls from the aggregation {@link #getContent content}.
|
|
2839
4408
|
*
|
|
2840
4409
|
* Additionally, it unregisters them from the hosting UIArea.
|
|
2841
4410
|
*/
|
|
2842
|
-
|
|
4411
|
+
removeAllContent(): sap.ui.core.Control[];
|
|
2843
4412
|
/**
|
|
2844
|
-
*
|
|
2845
|
-
*
|
|
2846
|
-
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
4413
|
+
* Removes all the controls from the aggregation {@link #getThumbnail thumbnail}.
|
|
2847
4414
|
*
|
|
2848
|
-
*
|
|
4415
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
2849
4416
|
*/
|
|
2850
|
-
|
|
4417
|
+
removeAllThumbnail(): sap.ui.core.Control[];
|
|
4418
|
+
/**
|
|
4419
|
+
* Removes a content from the aggregation {@link #getContent content}.
|
|
4420
|
+
*/
|
|
4421
|
+
removeContent(
|
|
2851
4422
|
/**
|
|
2852
|
-
*
|
|
4423
|
+
* The content to remove or its index or id
|
|
2853
4424
|
*/
|
|
2854
|
-
|
|
2855
|
-
):
|
|
4425
|
+
vContent: int | string | sap.ui.core.Control
|
|
4426
|
+
): sap.ui.core.Control;
|
|
2856
4427
|
/**
|
|
2857
|
-
*
|
|
4428
|
+
* Removes a thumbnail from the aggregation {@link #getThumbnail thumbnail}.
|
|
2858
4429
|
*/
|
|
2859
|
-
|
|
4430
|
+
removeThumbnail(
|
|
2860
4431
|
/**
|
|
2861
|
-
* The
|
|
4432
|
+
* The thumbnail to remove or its index or id
|
|
2862
4433
|
*/
|
|
2863
|
-
|
|
2864
|
-
):
|
|
4434
|
+
vThumbnail: int | string | sap.ui.core.Control
|
|
4435
|
+
): sap.ui.core.Control;
|
|
2865
4436
|
/**
|
|
2866
|
-
* Sets a new value for property {@link #
|
|
4437
|
+
* Sets a new value for property {@link #getDisabled disabled}.
|
|
2867
4438
|
*
|
|
2868
|
-
* Defines the
|
|
4439
|
+
* Defines whether the component is in disabled state.
|
|
2869
4440
|
*
|
|
2870
|
-
*
|
|
4441
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2871
4442
|
*
|
|
2872
|
-
*
|
|
4443
|
+
* Default value is `false`.
|
|
4444
|
+
*/
|
|
4445
|
+
setDisabled(
|
|
4446
|
+
/**
|
|
4447
|
+
* New value for property `disabled`
|
|
4448
|
+
*/
|
|
4449
|
+
bDisabled?: boolean
|
|
4450
|
+
): this;
|
|
4451
|
+
/**
|
|
4452
|
+
* Sets a new value for property {@link #getLayout layout}.
|
|
4453
|
+
*
|
|
4454
|
+
* Determines the layout of the item container.
|
|
4455
|
+
*
|
|
4456
|
+
* Available options are:
|
|
4457
|
+
* - `Square`
|
|
4458
|
+
* - `Wide`
|
|
2873
4459
|
*
|
|
2874
4460
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2875
4461
|
*
|
|
2876
|
-
* Default value is `
|
|
4462
|
+
* Default value is `Square`.
|
|
2877
4463
|
*/
|
|
2878
|
-
|
|
4464
|
+
setLayout(
|
|
2879
4465
|
/**
|
|
2880
|
-
* New value for property `
|
|
4466
|
+
* New value for property `layout`
|
|
2881
4467
|
*/
|
|
2882
|
-
|
|
4468
|
+
sLayout?: sap.ui.webc.fiori.MediaGalleryItemLayout
|
|
2883
4469
|
): this;
|
|
2884
4470
|
/**
|
|
2885
|
-
* Sets a new value for property {@link #
|
|
2886
|
-
*
|
|
2887
|
-
* Defines the title of the component.
|
|
4471
|
+
* Sets a new value for property {@link #getSelected selected}.
|
|
2888
4472
|
*
|
|
2889
|
-
*
|
|
4473
|
+
* Defines the selected state of the component.
|
|
2890
4474
|
*
|
|
2891
4475
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2892
4476
|
*
|
|
2893
|
-
* Default value is `
|
|
4477
|
+
* Default value is `false`.
|
|
2894
4478
|
*/
|
|
2895
|
-
|
|
4479
|
+
setSelected(
|
|
2896
4480
|
/**
|
|
2897
|
-
* New value for property `
|
|
4481
|
+
* New value for property `selected`
|
|
2898
4482
|
*/
|
|
2899
|
-
|
|
4483
|
+
bSelected?: boolean
|
|
2900
4484
|
): this;
|
|
2901
4485
|
}
|
|
2902
4486
|
/**
|
|
@@ -4221,34 +5805,16 @@ declare namespace sap {
|
|
|
4221
5805
|
*/
|
|
4222
5806
|
oContent: sap.ui.core.Control
|
|
4223
5807
|
): this;
|
|
4224
|
-
/**
|
|
4225
|
-
* Adds some footer to the aggregation {@link #getFooter footer}.
|
|
4226
|
-
*/
|
|
4227
|
-
addFooter(
|
|
4228
|
-
/**
|
|
4229
|
-
* The footer to add; if empty, nothing is inserted
|
|
4230
|
-
*/
|
|
4231
|
-
oFooter: sap.ui.core.Control
|
|
4232
|
-
): this;
|
|
4233
|
-
/**
|
|
4234
|
-
* Adds some header to the aggregation {@link #getHeader header}.
|
|
4235
|
-
*/
|
|
4236
|
-
addHeader(
|
|
4237
|
-
/**
|
|
4238
|
-
* The header to add; if empty, nothing is inserted
|
|
4239
|
-
*/
|
|
4240
|
-
oHeader: sap.ui.core.Control
|
|
4241
|
-
): this;
|
|
4242
5808
|
/**
|
|
4243
5809
|
* Destroys all the content in the aggregation {@link #getContent content}.
|
|
4244
5810
|
*/
|
|
4245
5811
|
destroyContent(): this;
|
|
4246
5812
|
/**
|
|
4247
|
-
* Destroys
|
|
5813
|
+
* Destroys the footer in the aggregation {@link #getFooter footer}.
|
|
4248
5814
|
*/
|
|
4249
5815
|
destroyFooter(): this;
|
|
4250
5816
|
/**
|
|
4251
|
-
* Destroys
|
|
5817
|
+
* Destroys the header in the aggregation {@link #getHeader header}.
|
|
4252
5818
|
*/
|
|
4253
5819
|
destroyHeader(): this;
|
|
4254
5820
|
/**
|
|
@@ -4297,13 +5863,13 @@ declare namespace sap {
|
|
|
4297
5863
|
*
|
|
4298
5864
|
* Defines the footer HTML Element.
|
|
4299
5865
|
*/
|
|
4300
|
-
getFooter(): sap.ui.
|
|
5866
|
+
getFooter(): sap.ui.webc.fiori.IBar;
|
|
4301
5867
|
/**
|
|
4302
5868
|
* Gets content of aggregation {@link #getHeader header}.
|
|
4303
5869
|
*
|
|
4304
5870
|
* Defines the header HTML Element.
|
|
4305
5871
|
*/
|
|
4306
|
-
getHeader(): sap.ui.
|
|
5872
|
+
getHeader(): sap.ui.webc.fiori.IBar;
|
|
4307
5873
|
/**
|
|
4308
5874
|
* Gets current value of property {@link #getHeight height}.
|
|
4309
5875
|
*
|
|
@@ -4334,26 +5900,6 @@ declare namespace sap {
|
|
|
4334
5900
|
*/
|
|
4335
5901
|
oContent: sap.ui.core.Control
|
|
4336
5902
|
): int;
|
|
4337
|
-
/**
|
|
4338
|
-
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getFooter footer}. and returns
|
|
4339
|
-
* its index if found or -1 otherwise.
|
|
4340
|
-
*/
|
|
4341
|
-
indexOfFooter(
|
|
4342
|
-
/**
|
|
4343
|
-
* The footer whose index is looked for
|
|
4344
|
-
*/
|
|
4345
|
-
oFooter: sap.ui.core.Control
|
|
4346
|
-
): int;
|
|
4347
|
-
/**
|
|
4348
|
-
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getHeader header}. and returns
|
|
4349
|
-
* its index if found or -1 otherwise.
|
|
4350
|
-
*/
|
|
4351
|
-
indexOfHeader(
|
|
4352
|
-
/**
|
|
4353
|
-
* The header whose index is looked for
|
|
4354
|
-
*/
|
|
4355
|
-
oHeader: sap.ui.core.Control
|
|
4356
|
-
): int;
|
|
4357
5903
|
/**
|
|
4358
5904
|
* Inserts a content into the aggregation {@link #getContent content}.
|
|
4359
5905
|
*/
|
|
@@ -4369,54 +5915,12 @@ declare namespace sap {
|
|
|
4369
5915
|
*/
|
|
4370
5916
|
iIndex: int
|
|
4371
5917
|
): this;
|
|
4372
|
-
/**
|
|
4373
|
-
* Inserts a footer into the aggregation {@link #getFooter footer}.
|
|
4374
|
-
*/
|
|
4375
|
-
insertFooter(
|
|
4376
|
-
/**
|
|
4377
|
-
* The footer to insert; if empty, nothing is inserted
|
|
4378
|
-
*/
|
|
4379
|
-
oFooter: sap.ui.core.Control,
|
|
4380
|
-
/**
|
|
4381
|
-
* The `0`-based index the footer should be inserted at; for a negative value of `iIndex`, the footer is
|
|
4382
|
-
* inserted at position 0; for a value greater than the current size of the aggregation, the footer is inserted
|
|
4383
|
-
* at the last position
|
|
4384
|
-
*/
|
|
4385
|
-
iIndex: int
|
|
4386
|
-
): this;
|
|
4387
|
-
/**
|
|
4388
|
-
* Inserts a header into the aggregation {@link #getHeader header}.
|
|
4389
|
-
*/
|
|
4390
|
-
insertHeader(
|
|
4391
|
-
/**
|
|
4392
|
-
* The header to insert; if empty, nothing is inserted
|
|
4393
|
-
*/
|
|
4394
|
-
oHeader: sap.ui.core.Control,
|
|
4395
|
-
/**
|
|
4396
|
-
* The `0`-based index the header should be inserted at; for a negative value of `iIndex`, the header is
|
|
4397
|
-
* inserted at position 0; for a value greater than the current size of the aggregation, the header is inserted
|
|
4398
|
-
* at the last position
|
|
4399
|
-
*/
|
|
4400
|
-
iIndex: int
|
|
4401
|
-
): this;
|
|
4402
5918
|
/**
|
|
4403
5919
|
* Removes all the controls from the aggregation {@link #getContent content}.
|
|
4404
5920
|
*
|
|
4405
5921
|
* Additionally, it unregisters them from the hosting UIArea.
|
|
4406
5922
|
*/
|
|
4407
5923
|
removeAllContent(): sap.ui.core.Control[];
|
|
4408
|
-
/**
|
|
4409
|
-
* Removes all the controls from the aggregation {@link #getFooter footer}.
|
|
4410
|
-
*
|
|
4411
|
-
* Additionally, it unregisters them from the hosting UIArea.
|
|
4412
|
-
*/
|
|
4413
|
-
removeAllFooter(): sap.ui.core.Control[];
|
|
4414
|
-
/**
|
|
4415
|
-
* Removes all the controls from the aggregation {@link #getHeader header}.
|
|
4416
|
-
*
|
|
4417
|
-
* Additionally, it unregisters them from the hosting UIArea.
|
|
4418
|
-
*/
|
|
4419
|
-
removeAllHeader(): sap.ui.core.Control[];
|
|
4420
5924
|
/**
|
|
4421
5925
|
* Removes a content from the aggregation {@link #getContent content}.
|
|
4422
5926
|
*/
|
|
@@ -4426,24 +5930,6 @@ declare namespace sap {
|
|
|
4426
5930
|
*/
|
|
4427
5931
|
vContent: int | string | sap.ui.core.Control
|
|
4428
5932
|
): sap.ui.core.Control;
|
|
4429
|
-
/**
|
|
4430
|
-
* Removes a footer from the aggregation {@link #getFooter footer}.
|
|
4431
|
-
*/
|
|
4432
|
-
removeFooter(
|
|
4433
|
-
/**
|
|
4434
|
-
* The footer to remove or its index or id
|
|
4435
|
-
*/
|
|
4436
|
-
vFooter: int | string | sap.ui.core.Control
|
|
4437
|
-
): sap.ui.core.Control;
|
|
4438
|
-
/**
|
|
4439
|
-
* Removes a header from the aggregation {@link #getHeader header}.
|
|
4440
|
-
*/
|
|
4441
|
-
removeHeader(
|
|
4442
|
-
/**
|
|
4443
|
-
* The header to remove or its index or id
|
|
4444
|
-
*/
|
|
4445
|
-
vHeader: int | string | sap.ui.core.Control
|
|
4446
|
-
): sap.ui.core.Control;
|
|
4447
5933
|
/**
|
|
4448
5934
|
* Sets a new value for property {@link #getBackgroundDesign backgroundDesign}.
|
|
4449
5935
|
*
|
|
@@ -4500,6 +5986,24 @@ declare namespace sap {
|
|
|
4500
5986
|
*/
|
|
4501
5987
|
bFloatingFooter?: boolean
|
|
4502
5988
|
): this;
|
|
5989
|
+
/**
|
|
5990
|
+
* Sets the aggregated {@link #getFooter footer}.
|
|
5991
|
+
*/
|
|
5992
|
+
setFooter(
|
|
5993
|
+
/**
|
|
5994
|
+
* The footer to set
|
|
5995
|
+
*/
|
|
5996
|
+
oFooter: sap.ui.webc.fiori.IBar
|
|
5997
|
+
): this;
|
|
5998
|
+
/**
|
|
5999
|
+
* Sets the aggregated {@link #getHeader header}.
|
|
6000
|
+
*/
|
|
6001
|
+
setHeader(
|
|
6002
|
+
/**
|
|
6003
|
+
* The header to set
|
|
6004
|
+
*/
|
|
6005
|
+
oHeader: sap.ui.webc.fiori.IBar
|
|
6006
|
+
): this;
|
|
4503
6007
|
/**
|
|
4504
6008
|
* Sets a new value for property {@link #getHeight height}.
|
|
4505
6009
|
*
|
|
@@ -4994,16 +6498,14 @@ declare namespace sap {
|
|
|
4994
6498
|
* - profile
|
|
4995
6499
|
* - product-switch
|
|
4996
6500
|
*
|
|
4997
|
-
* In the context of `sap.ui.webc.fiori.ShellBar`, you can provide a custom stable DOM refs for:
|
|
4998
|
-
* - Every `sap.ui.webc.fiori.ShellBarItem` that you provide. Example: `
|
|
4999
|
-
* `
|
|
5000
|
-
*
|
|
5001
6501
|
* CSS Shadow Parts:
|
|
5002
6502
|
*
|
|
5003
6503
|
* CSS Shadow Parts
|
|
5004
6504
|
* allow developers to style elements inside the Shadow DOM.
|
|
5005
6505
|
* The `sap.ui.webc.fiori.ShellBar` exposes the following CSS Shadow Parts:
|
|
5006
6506
|
* - root - Used to style the outermost wrapper of the `sap.ui.webc.fiori.ShellBar`
|
|
6507
|
+
*
|
|
6508
|
+
* Keyboard Handling:
|
|
5007
6509
|
*/
|
|
5008
6510
|
class ShellBar extends sap.ui.webc.common.WebComponent {
|
|
5009
6511
|
/**
|
|
@@ -5168,7 +6670,7 @@ declare namespace sap {
|
|
|
5168
6670
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
5169
6671
|
* otherwise it will be bound to this `sap.ui.webc.fiori.ShellBar` itself.
|
|
5170
6672
|
*
|
|
5171
|
-
* Fired, when a menu item is activated **Note:** You can prevent closing of
|
|
6673
|
+
* Fired, when a menu item is activated **Note:** You can prevent closing of overflow popover by calling
|
|
5172
6674
|
* `event.preventDefault()`.
|
|
5173
6675
|
*/
|
|
5174
6676
|
attachMenuItemClick(
|
|
@@ -5192,7 +6694,7 @@ declare namespace sap {
|
|
|
5192
6694
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
5193
6695
|
* otherwise it will be bound to this `sap.ui.webc.fiori.ShellBar` itself.
|
|
5194
6696
|
*
|
|
5195
|
-
* Fired, when a menu item is activated **Note:** You can prevent closing of
|
|
6697
|
+
* Fired, when a menu item is activated **Note:** You can prevent closing of overflow popover by calling
|
|
5196
6698
|
* `event.preventDefault()`.
|
|
5197
6699
|
*/
|
|
5198
6700
|
attachMenuItemClick(
|
|
@@ -5255,7 +6757,7 @@ declare namespace sap {
|
|
|
5255
6757
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
5256
6758
|
* otherwise it will be bound to this `sap.ui.webc.fiori.ShellBar` itself.
|
|
5257
6759
|
*
|
|
5258
|
-
* Fired, when the product switch icon is activated. **Note:** You can prevent closing of
|
|
6760
|
+
* Fired, when the product switch icon is activated. **Note:** You can prevent closing of overflow popover
|
|
5259
6761
|
* by calling `event.preventDefault()`.
|
|
5260
6762
|
*/
|
|
5261
6763
|
attachProductSwitchClick(
|
|
@@ -5280,7 +6782,7 @@ declare namespace sap {
|
|
|
5280
6782
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
5281
6783
|
* otherwise it will be bound to this `sap.ui.webc.fiori.ShellBar` itself.
|
|
5282
6784
|
*
|
|
5283
|
-
* Fired, when the product switch icon is activated. **Note:** You can prevent closing of
|
|
6785
|
+
* Fired, when the product switch icon is activated. **Note:** You can prevent closing of overflow popover
|
|
5284
6786
|
* by calling `event.preventDefault()`.
|
|
5285
6787
|
*/
|
|
5286
6788
|
attachProductSwitchClick(
|
|
@@ -5546,6 +7048,21 @@ declare namespace sap {
|
|
|
5546
7048
|
targetRef?: HTMLElement;
|
|
5547
7049
|
}
|
|
5548
7050
|
): this;
|
|
7051
|
+
/**
|
|
7052
|
+
* Gets current value of property {@link #getAccessibilityTexts accessibilityTexts}.
|
|
7053
|
+
*
|
|
7054
|
+
* An object of strings that defines several additional accessibility texts for even further customization.
|
|
7055
|
+
*
|
|
7056
|
+
* It supports the following fields: - `profileButtonTitle`: defines the tooltip for the profile button
|
|
7057
|
+
* - `logoTitle`: defines the tooltip for the logo
|
|
7058
|
+
*
|
|
7059
|
+
* Default value is `{}`.
|
|
7060
|
+
*/
|
|
7061
|
+
getAccessibilityTexts(): object;
|
|
7062
|
+
/**
|
|
7063
|
+
* Returns the `copilot` DOM ref.
|
|
7064
|
+
*/
|
|
7065
|
+
getCopilotDomRef(): void;
|
|
5549
7066
|
/**
|
|
5550
7067
|
* Gets content of aggregation {@link #getItems items}.
|
|
5551
7068
|
*
|
|
@@ -5561,6 +7078,10 @@ declare namespace sap {
|
|
|
5561
7078
|
* or `img` elements as logo.
|
|
5562
7079
|
*/
|
|
5563
7080
|
getLogo(): sap.ui.webc.main.IAvatar;
|
|
7081
|
+
/**
|
|
7082
|
+
* Returns the `logo` DOM ref.
|
|
7083
|
+
*/
|
|
7084
|
+
getLogoDomRef(): void;
|
|
5564
7085
|
/**
|
|
5565
7086
|
* Gets content of aggregation {@link #getMenuItems menuItems}.
|
|
5566
7087
|
*
|
|
@@ -5577,6 +7098,14 @@ declare namespace sap {
|
|
|
5577
7098
|
* Default value is `empty string`.
|
|
5578
7099
|
*/
|
|
5579
7100
|
getNotificationsCount(): string;
|
|
7101
|
+
/**
|
|
7102
|
+
* Returns the `notifications` icon DOM ref.
|
|
7103
|
+
*/
|
|
7104
|
+
getNotificationsDomRef(): void;
|
|
7105
|
+
/**
|
|
7106
|
+
* Returns the `overflow` icon DOM ref.
|
|
7107
|
+
*/
|
|
7108
|
+
getOverflowDomRef(): void;
|
|
5580
7109
|
/**
|
|
5581
7110
|
* Gets current value of property {@link #getPrimaryTitle primaryTitle}.
|
|
5582
7111
|
*
|
|
@@ -5587,6 +7116,10 @@ declare namespace sap {
|
|
|
5587
7116
|
* Default value is `empty string`.
|
|
5588
7117
|
*/
|
|
5589
7118
|
getPrimaryTitle(): string;
|
|
7119
|
+
/**
|
|
7120
|
+
* Returns the `product-switch` icon DOM ref.
|
|
7121
|
+
*/
|
|
7122
|
+
getProductSwitchDomRef(): void;
|
|
5590
7123
|
/**
|
|
5591
7124
|
* Gets content of aggregation {@link #getProfile profile}.
|
|
5592
7125
|
*
|
|
@@ -5597,6 +7130,10 @@ declare namespace sap {
|
|
|
5597
7130
|
* specific size by design in the context of `sap.ui.webc.fiori.ShellBar` profile.
|
|
5598
7131
|
*/
|
|
5599
7132
|
getProfile(): sap.ui.webc.main.IAvatar;
|
|
7133
|
+
/**
|
|
7134
|
+
* Returns the `profile` icon DOM ref.
|
|
7135
|
+
*/
|
|
7136
|
+
getProfileDomRef(): void;
|
|
5600
7137
|
/**
|
|
5601
7138
|
* Gets content of aggregation {@link #getSearchField searchField}.
|
|
5602
7139
|
*
|
|
@@ -5726,6 +7263,24 @@ declare namespace sap {
|
|
|
5726
7263
|
*/
|
|
5727
7264
|
vMenuItem: int | string | sap.ui.webc.main.IListItem
|
|
5728
7265
|
): sap.ui.webc.main.IListItem;
|
|
7266
|
+
/**
|
|
7267
|
+
* Sets a new value for property {@link #getAccessibilityTexts accessibilityTexts}.
|
|
7268
|
+
*
|
|
7269
|
+
* An object of strings that defines several additional accessibility texts for even further customization.
|
|
7270
|
+
*
|
|
7271
|
+
* It supports the following fields: - `profileButtonTitle`: defines the tooltip for the profile button
|
|
7272
|
+
* - `logoTitle`: defines the tooltip for the logo
|
|
7273
|
+
*
|
|
7274
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
7275
|
+
*
|
|
7276
|
+
* Default value is `{}`.
|
|
7277
|
+
*/
|
|
7278
|
+
setAccessibilityTexts(
|
|
7279
|
+
/**
|
|
7280
|
+
* New value for property `accessibilityTexts`
|
|
7281
|
+
*/
|
|
7282
|
+
oAccessibilityTexts?: object
|
|
7283
|
+
): this;
|
|
5729
7284
|
/**
|
|
5730
7285
|
* Sets the aggregated {@link #getLogo logo}.
|
|
5731
7286
|
*/
|
|
@@ -5924,14 +7479,14 @@ declare namespace sap {
|
|
|
5924
7479
|
*/
|
|
5925
7480
|
static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
|
|
5926
7481
|
/**
|
|
5927
|
-
* Attaches event handler `fnFunction` to the {@link #event:
|
|
7482
|
+
* Attaches event handler `fnFunction` to the {@link #event:click click} event of this `sap.ui.webc.fiori.ShellBarItem`.
|
|
5928
7483
|
*
|
|
5929
7484
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
5930
7485
|
* otherwise it will be bound to this `sap.ui.webc.fiori.ShellBarItem` itself.
|
|
5931
7486
|
*
|
|
5932
7487
|
* Fired, when the item is pressed.
|
|
5933
7488
|
*/
|
|
5934
|
-
|
|
7489
|
+
attachClick(
|
|
5935
7490
|
/**
|
|
5936
7491
|
* An application-specific payload object that will be passed to the event handler along with the event
|
|
5937
7492
|
* object when firing the event
|
|
@@ -5947,14 +7502,14 @@ declare namespace sap {
|
|
|
5947
7502
|
oListener?: object
|
|
5948
7503
|
): this;
|
|
5949
7504
|
/**
|
|
5950
|
-
* Attaches event handler `fnFunction` to the {@link #event:
|
|
7505
|
+
* Attaches event handler `fnFunction` to the {@link #event:click click} event of this `sap.ui.webc.fiori.ShellBarItem`.
|
|
5951
7506
|
*
|
|
5952
7507
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
5953
7508
|
* otherwise it will be bound to this `sap.ui.webc.fiori.ShellBarItem` itself.
|
|
5954
7509
|
*
|
|
5955
7510
|
* Fired, when the item is pressed.
|
|
5956
7511
|
*/
|
|
5957
|
-
|
|
7512
|
+
attachClick(
|
|
5958
7513
|
/**
|
|
5959
7514
|
* The function to be called when the event occurs
|
|
5960
7515
|
*/
|
|
@@ -5965,11 +7520,11 @@ declare namespace sap {
|
|
|
5965
7520
|
oListener?: object
|
|
5966
7521
|
): this;
|
|
5967
7522
|
/**
|
|
5968
|
-
* Detaches event handler `fnFunction` from the {@link #event:
|
|
7523
|
+
* Detaches event handler `fnFunction` from the {@link #event:click click} event of this `sap.ui.webc.fiori.ShellBarItem`.
|
|
5969
7524
|
*
|
|
5970
7525
|
* The passed function and listener object must match the ones used for event registration.
|
|
5971
7526
|
*/
|
|
5972
|
-
|
|
7527
|
+
detachClick(
|
|
5973
7528
|
/**
|
|
5974
7529
|
* The function to be called, when the event occurs
|
|
5975
7530
|
*/
|
|
@@ -5980,12 +7535,12 @@ declare namespace sap {
|
|
|
5980
7535
|
oListener?: object
|
|
5981
7536
|
): this;
|
|
5982
7537
|
/**
|
|
5983
|
-
* Fires event {@link #event:
|
|
7538
|
+
* Fires event {@link #event:click click} to attached listeners.
|
|
5984
7539
|
*
|
|
5985
7540
|
* Listeners may prevent the default action of this event by calling the `preventDefault` method on the
|
|
5986
7541
|
* event object. The return value of this method indicates whether the default action should be executed.
|
|
5987
7542
|
*/
|
|
5988
|
-
|
|
7543
|
+
fireClick(
|
|
5989
7544
|
/**
|
|
5990
7545
|
* Parameters to pass along with the event
|
|
5991
7546
|
*/
|
|
@@ -6086,6 +7641,8 @@ declare namespace sap {
|
|
|
6086
7641
|
* components to build your menu. The items can consist of text only or an icon with text. The use or non-use
|
|
6087
7642
|
* of icons must be consistent for all items on one level. You must not combine entries with and without
|
|
6088
7643
|
* icons on the same level. We strongly recommend that you do not use icons on the second level.
|
|
7644
|
+
*
|
|
7645
|
+
* Keyboard Handling:
|
|
6089
7646
|
*/
|
|
6090
7647
|
class SideNavigation extends sap.ui.webc.common.WebComponent {
|
|
6091
7648
|
/**
|
|
@@ -9091,6 +10648,16 @@ declare namespace sap {
|
|
|
9091
10648
|
* **Note:** If no selected step is defined, the first step will be auto selected.
|
|
9092
10649
|
* **Note:** If multiple selected steps are defined, the last step will be selected.
|
|
9093
10650
|
*
|
|
10651
|
+
* Keyboard Handling: The user can navigate using the following keyboard shortcuts:
|
|
10652
|
+
*
|
|
10653
|
+
*
|
|
10654
|
+
* Wizard Progress Navigation:
|
|
10655
|
+
* - [LEFT], [DOWN] - Focus moves backward to the WizardProgressNavAnchors.
|
|
10656
|
+
* - [UP], [RIGHT] - Focus moves forward to the WizardProgressNavAnchor.
|
|
10657
|
+
* - [SPACE] or [ENTER], [RETURN] - Selects an active step
|
|
10658
|
+
* - [HOME] or [PAGE UP] - Focus goes to the first step
|
|
10659
|
+
* - [END] or [PAGE DOWN] - Focus goes to the last step
|
|
10660
|
+
*
|
|
9094
10661
|
* Content: The content occupies the main part of the page. It can hold any type of HTML elements. It's
|
|
9095
10662
|
* defined by using the `sap.ui.webc.fiori.WizardStep` as slotted element within the `sap.ui.webc.fiori.Wizard`.
|
|
9096
10663
|
*
|
|
@@ -9280,14 +10847,6 @@ declare namespace sap {
|
|
|
9280
10847
|
changeWithClick?: boolean;
|
|
9281
10848
|
}
|
|
9282
10849
|
): this;
|
|
9283
|
-
/**
|
|
9284
|
-
* Gets current value of property {@link #getAccessibleName accessibleName}.
|
|
9285
|
-
*
|
|
9286
|
-
* Sets the accessible aria name of the component.
|
|
9287
|
-
*
|
|
9288
|
-
* Default value is `undefined`.
|
|
9289
|
-
*/
|
|
9290
|
-
getAccessibleName(): string;
|
|
9291
10850
|
/**
|
|
9292
10851
|
* Gets current value of property {@link #getHeight height}.
|
|
9293
10852
|
*
|
|
@@ -9342,21 +10901,6 @@ declare namespace sap {
|
|
|
9342
10901
|
*/
|
|
9343
10902
|
vStep: int | string | sap.ui.webc.fiori.IWizardStep
|
|
9344
10903
|
): sap.ui.webc.fiori.IWizardStep;
|
|
9345
|
-
/**
|
|
9346
|
-
* Sets a new value for property {@link #getAccessibleName accessibleName}.
|
|
9347
|
-
*
|
|
9348
|
-
* Sets the accessible aria name of the component.
|
|
9349
|
-
*
|
|
9350
|
-
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
9351
|
-
*
|
|
9352
|
-
* Default value is `undefined`.
|
|
9353
|
-
*/
|
|
9354
|
-
setAccessibleName(
|
|
9355
|
-
/**
|
|
9356
|
-
* New value for property `accessibleName`
|
|
9357
|
-
*/
|
|
9358
|
-
sAccessibleName?: string
|
|
9359
|
-
): this;
|
|
9360
10904
|
/**
|
|
9361
10905
|
* Sets a new value for property {@link #getHeight height}.
|
|
9362
10906
|
*
|
|
@@ -9462,22 +11006,6 @@ declare namespace sap {
|
|
|
9462
11006
|
* Destroys all the content in the aggregation {@link #getContent content}.
|
|
9463
11007
|
*/
|
|
9464
11008
|
destroyContent(): this;
|
|
9465
|
-
/**
|
|
9466
|
-
* Gets current value of property {@link #getAccessibleName accessibleName}.
|
|
9467
|
-
*
|
|
9468
|
-
* Sets the accessible aria name of the component.
|
|
9469
|
-
*
|
|
9470
|
-
* Default value is `empty string`.
|
|
9471
|
-
*/
|
|
9472
|
-
getAccessibleName(): string;
|
|
9473
|
-
/**
|
|
9474
|
-
* Gets current value of property {@link #getAccessibleNameRef accessibleNameRef}.
|
|
9475
|
-
*
|
|
9476
|
-
* Defines the aria-labelledby of the step.
|
|
9477
|
-
*
|
|
9478
|
-
* Default value is `empty string`.
|
|
9479
|
-
*/
|
|
9480
|
-
getAccessibleNameRef(): string;
|
|
9481
11009
|
/**
|
|
9482
11010
|
* Gets current value of property {@link #getBranching branching}.
|
|
9483
11011
|
*
|
|
@@ -9605,36 +11133,6 @@ declare namespace sap {
|
|
|
9605
11133
|
*/
|
|
9606
11134
|
vContent: int | string | sap.ui.core.Control
|
|
9607
11135
|
): sap.ui.core.Control;
|
|
9608
|
-
/**
|
|
9609
|
-
* Sets a new value for property {@link #getAccessibleName accessibleName}.
|
|
9610
|
-
*
|
|
9611
|
-
* Sets the accessible aria name of the component.
|
|
9612
|
-
*
|
|
9613
|
-
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
9614
|
-
*
|
|
9615
|
-
* Default value is `empty string`.
|
|
9616
|
-
*/
|
|
9617
|
-
setAccessibleName(
|
|
9618
|
-
/**
|
|
9619
|
-
* New value for property `accessibleName`
|
|
9620
|
-
*/
|
|
9621
|
-
sAccessibleName?: string
|
|
9622
|
-
): this;
|
|
9623
|
-
/**
|
|
9624
|
-
* Sets a new value for property {@link #getAccessibleNameRef accessibleNameRef}.
|
|
9625
|
-
*
|
|
9626
|
-
* Defines the aria-labelledby of the step.
|
|
9627
|
-
*
|
|
9628
|
-
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
9629
|
-
*
|
|
9630
|
-
* Default value is `empty string`.
|
|
9631
|
-
*/
|
|
9632
|
-
setAccessibleNameRef(
|
|
9633
|
-
/**
|
|
9634
|
-
* New value for property `accessibleNameRef`
|
|
9635
|
-
*/
|
|
9636
|
-
sAccessibleNameRef?: string
|
|
9637
|
-
): this;
|
|
9638
11136
|
/**
|
|
9639
11137
|
* Sets a new value for property {@link #getBranching branching}.
|
|
9640
11138
|
*
|
|
@@ -9864,41 +11362,201 @@ declare namespace sap {
|
|
|
9864
11362
|
*/
|
|
9865
11363
|
enum IllustrationMessageType {
|
|
9866
11364
|
/**
|
|
9867
|
-
* "
|
|
11365
|
+
* "Add Column" illustration type.
|
|
11366
|
+
*/
|
|
11367
|
+
AddColumn = "AddColumn",
|
|
11368
|
+
/**
|
|
11369
|
+
* "Add People" illustration type.
|
|
11370
|
+
*/
|
|
11371
|
+
AddPeople = "AddPeople",
|
|
11372
|
+
/**
|
|
11373
|
+
* "Balloon Sky" illustration type.
|
|
11374
|
+
*/
|
|
11375
|
+
BalloonSky = "BalloonSky",
|
|
11376
|
+
/**
|
|
11377
|
+
* "Before Search" illustration type.
|
|
9868
11378
|
*/
|
|
9869
11379
|
BeforeSearch = "BeforeSearch",
|
|
9870
11380
|
/**
|
|
9871
|
-
* "
|
|
11381
|
+
* "Connection" illustration type.
|
|
11382
|
+
*/
|
|
11383
|
+
Connection = "Connection",
|
|
11384
|
+
/**
|
|
11385
|
+
* "Empty Calendar" illustration type.
|
|
11386
|
+
*/
|
|
11387
|
+
EmptyCalendar = "EmptyCalendar",
|
|
11388
|
+
/**
|
|
11389
|
+
* "Empty List" illustration type.
|
|
11390
|
+
*/
|
|
11391
|
+
EmptyList = "EmptyList",
|
|
11392
|
+
/**
|
|
11393
|
+
* "Empty Planning Calendar" illustration type.
|
|
11394
|
+
*/
|
|
11395
|
+
EmptyPlanningCalendar = "EmptyPlanningCalendar",
|
|
11396
|
+
/**
|
|
11397
|
+
* "Error Screen" illustration type.
|
|
11398
|
+
*/
|
|
11399
|
+
ErrorScreen = "ErrorScreen",
|
|
11400
|
+
/**
|
|
11401
|
+
* "Filter Table" illustration type.
|
|
11402
|
+
*/
|
|
11403
|
+
FilterTable = "FilterTable",
|
|
11404
|
+
/**
|
|
11405
|
+
* "Group Table" illustration type.
|
|
11406
|
+
*/
|
|
11407
|
+
GroupTable = "GroupTable",
|
|
11408
|
+
/**
|
|
11409
|
+
* "No Activities" illustration type.
|
|
9872
11410
|
*/
|
|
9873
11411
|
NoActivities = "NoActivities",
|
|
9874
11412
|
/**
|
|
9875
|
-
* "
|
|
11413
|
+
* "No Data" illustration type.
|
|
9876
11414
|
*/
|
|
9877
11415
|
NoData = "NoData",
|
|
9878
11416
|
/**
|
|
9879
|
-
* "
|
|
11417
|
+
* "No Entries" illustration type.
|
|
9880
11418
|
*/
|
|
9881
11419
|
NoEntries = "NoEntries",
|
|
9882
11420
|
/**
|
|
9883
|
-
* "
|
|
11421
|
+
* "No Filter Results" illustration type.
|
|
11422
|
+
*/
|
|
11423
|
+
NoFilterResults = "NoFilterResults",
|
|
11424
|
+
/**
|
|
11425
|
+
* "No Email" illustration type.
|
|
9884
11426
|
*/
|
|
9885
11427
|
NoMail = "NoMail",
|
|
9886
11428
|
/**
|
|
9887
|
-
* "
|
|
11429
|
+
* "No Email v1" illustration type.
|
|
11430
|
+
*/
|
|
11431
|
+
NoMail_v1 = "NoMail_v1",
|
|
11432
|
+
/**
|
|
11433
|
+
* "No Notifications" illustration type.
|
|
9888
11434
|
*/
|
|
9889
11435
|
NoNotifications = "NoNotifications",
|
|
9890
11436
|
/**
|
|
9891
|
-
* "
|
|
11437
|
+
* "No Saved Items" illustration type.
|
|
9892
11438
|
*/
|
|
9893
11439
|
NoSavedItems = "NoSavedItems",
|
|
9894
11440
|
/**
|
|
9895
|
-
* "
|
|
11441
|
+
* "No Saved Items v1" illustration type.
|
|
11442
|
+
*/
|
|
11443
|
+
NoSavedItems_v1 = "NoSavedItems_v1",
|
|
11444
|
+
/**
|
|
11445
|
+
* "No Search Results" illustration type.
|
|
9896
11446
|
*/
|
|
9897
11447
|
NoSearchResults = "NoSearchResults",
|
|
9898
11448
|
/**
|
|
9899
|
-
* "
|
|
11449
|
+
* "No Tasks" illustration type.
|
|
9900
11450
|
*/
|
|
9901
11451
|
NoTasks = "NoTasks",
|
|
11452
|
+
/**
|
|
11453
|
+
* "No Tasks v1" illustration type.
|
|
11454
|
+
*/
|
|
11455
|
+
NoTasks_v1 = "NoTasks_v1",
|
|
11456
|
+
/**
|
|
11457
|
+
* "Page Not Found" illustration type.
|
|
11458
|
+
*/
|
|
11459
|
+
PageNotFound = "PageNotFound",
|
|
11460
|
+
/**
|
|
11461
|
+
* "Reload Screen" illustration type.
|
|
11462
|
+
*/
|
|
11463
|
+
ReloadScreen = "ReloadScreen",
|
|
11464
|
+
/**
|
|
11465
|
+
* "Resize Column" illustration type.
|
|
11466
|
+
*/
|
|
11467
|
+
ResizeColumn = "ResizeColumn",
|
|
11468
|
+
/**
|
|
11469
|
+
* "Search Earth" illustration type.
|
|
11470
|
+
*/
|
|
11471
|
+
SearchEarth = "SearchEarth",
|
|
11472
|
+
/**
|
|
11473
|
+
* "Search Folder" illustration type.
|
|
11474
|
+
*/
|
|
11475
|
+
SearchFolder = "SearchFolder",
|
|
11476
|
+
/**
|
|
11477
|
+
* "Simple Balloon" illustration type.
|
|
11478
|
+
*/
|
|
11479
|
+
SimpleBalloon = "SimpleBalloon",
|
|
11480
|
+
/**
|
|
11481
|
+
* "Simple Bell" illustration type.
|
|
11482
|
+
*/
|
|
11483
|
+
SimpleBell = "SimpleBell",
|
|
11484
|
+
/**
|
|
11485
|
+
* "Simple Calendar" illustration type.
|
|
11486
|
+
*/
|
|
11487
|
+
SimpleCalendar = "SimpleCalendar",
|
|
11488
|
+
/**
|
|
11489
|
+
* "Simple CheckMark" illustration type.
|
|
11490
|
+
*/
|
|
11491
|
+
SimpleCheckMark = "SimpleCheckMark",
|
|
11492
|
+
/**
|
|
11493
|
+
* "Simple Connection" illustration type.
|
|
11494
|
+
*/
|
|
11495
|
+
SimpleConnection = "SimpleConnection",
|
|
11496
|
+
/**
|
|
11497
|
+
* "Simple Empty Doc" illustration type.
|
|
11498
|
+
*/
|
|
11499
|
+
SimpleEmptyDoc = "SimpleEmptyDoc",
|
|
11500
|
+
/**
|
|
11501
|
+
* "Simple Empty List" illustration type.
|
|
11502
|
+
*/
|
|
11503
|
+
SimpleEmptyList = "SimpleEmptyList",
|
|
11504
|
+
/**
|
|
11505
|
+
* "Simple Error" illustration type.
|
|
11506
|
+
*/
|
|
11507
|
+
SimpleError = "SimpleError",
|
|
11508
|
+
/**
|
|
11509
|
+
* "Simple Magnifier" illustration type.
|
|
11510
|
+
*/
|
|
11511
|
+
SimpleMagnifier = "SimpleMagnifier",
|
|
11512
|
+
/**
|
|
11513
|
+
* "Simple Mail" illustration type.
|
|
11514
|
+
*/
|
|
11515
|
+
SimpleMail = "SimpleMail",
|
|
11516
|
+
/**
|
|
11517
|
+
* "Simple No Saved Items" illustration type.
|
|
11518
|
+
*/
|
|
11519
|
+
SimpleNoSavedItems = "SimpleNoSavedItems",
|
|
11520
|
+
/**
|
|
11521
|
+
* "Simple Not Found Magnifier" illustration type.
|
|
11522
|
+
*/
|
|
11523
|
+
SimpleNotFoundMagnifier = "SimpleNotFoundMagnifier",
|
|
11524
|
+
/**
|
|
11525
|
+
* "Simple Reload" illustration type.
|
|
11526
|
+
*/
|
|
11527
|
+
SimpleReload = "SimpleReload",
|
|
11528
|
+
/**
|
|
11529
|
+
* "Simple Task" illustration type.
|
|
11530
|
+
*/
|
|
11531
|
+
SimpleTask = "SimpleTask",
|
|
11532
|
+
/**
|
|
11533
|
+
* "Sleeping Bell" illustration type.
|
|
11534
|
+
*/
|
|
11535
|
+
SleepingBell = "SleepingBell",
|
|
11536
|
+
/**
|
|
11537
|
+
* "Sort Column" illustration type.
|
|
11538
|
+
*/
|
|
11539
|
+
SortColumn = "SortColumn",
|
|
11540
|
+
/**
|
|
11541
|
+
* "Success Balloon" illustration type.
|
|
11542
|
+
*/
|
|
11543
|
+
SuccessBalloon = "SuccessBalloon",
|
|
11544
|
+
/**
|
|
11545
|
+
* "Success CheckMark" illustration type.
|
|
11546
|
+
*/
|
|
11547
|
+
SuccessCheckMark = "SuccessCheckMark",
|
|
11548
|
+
/**
|
|
11549
|
+
* "Success HighFive" illustration type.
|
|
11550
|
+
*/
|
|
11551
|
+
SuccessHighFive = "SuccessHighFive",
|
|
11552
|
+
/**
|
|
11553
|
+
* "Success Screen" illustration type.
|
|
11554
|
+
*/
|
|
11555
|
+
SuccessScreen = "SuccessScreen",
|
|
11556
|
+
/**
|
|
11557
|
+
* "Tent" illustration type.
|
|
11558
|
+
*/
|
|
11559
|
+
Tent = "Tent",
|
|
9902
11560
|
/**
|
|
9903
11561
|
* "TntCodePlaceholder" illustration type.
|
|
9904
11562
|
*/
|
|
@@ -9972,13 +11630,93 @@ declare namespace sap {
|
|
|
9972
11630
|
*/
|
|
9973
11631
|
TntUnsuccessfulAuth = "TntUnsuccessfulAuth",
|
|
9974
11632
|
/**
|
|
9975
|
-
* "
|
|
11633
|
+
* "Unable To Load" illustration type.
|
|
9976
11634
|
*/
|
|
9977
11635
|
UnableToLoad = "UnableToLoad",
|
|
9978
11636
|
/**
|
|
9979
|
-
* "
|
|
11637
|
+
* "Unable To Load Image" illustration type.
|
|
11638
|
+
*/
|
|
11639
|
+
UnableToLoadImage = "UnableToLoadImage",
|
|
11640
|
+
/**
|
|
11641
|
+
* "Unable To Upload" illustration type.
|
|
9980
11642
|
*/
|
|
9981
11643
|
UnableToUpload = "UnableToUpload",
|
|
11644
|
+
/**
|
|
11645
|
+
* "Upload Collection" illustration type.
|
|
11646
|
+
*/
|
|
11647
|
+
UploadCollection = "UploadCollection",
|
|
11648
|
+
}
|
|
11649
|
+
/**
|
|
11650
|
+
* @SINCE 1.99.0
|
|
11651
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
11652
|
+
*
|
|
11653
|
+
* Defines the layout of the content displayed in the `ui5-media-gallery-item`.
|
|
11654
|
+
*/
|
|
11655
|
+
enum MediaGalleryItemLayout {
|
|
11656
|
+
/**
|
|
11657
|
+
* Recommended to use when the item contains an image.
|
|
11658
|
+
* When a thumbnail is selected, it makes the corresponding enlarged content appear in a square display
|
|
11659
|
+
* area.
|
|
11660
|
+
*/
|
|
11661
|
+
Square = "Square",
|
|
11662
|
+
/**
|
|
11663
|
+
* Recommended to use when the item contains video content.
|
|
11664
|
+
* When a thumbnail is selected, it makes the corresponding enlarged content appear in a wide display area
|
|
11665
|
+
* (stretched to fill all of the available width) for optimal user experiance.
|
|
11666
|
+
*/
|
|
11667
|
+
Wide = "Wide",
|
|
11668
|
+
}
|
|
11669
|
+
/**
|
|
11670
|
+
* @SINCE 1.99.0
|
|
11671
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
11672
|
+
*
|
|
11673
|
+
* Defines the layout type of the thumbnails list of the `ui5-media-gallery` component.
|
|
11674
|
+
*/
|
|
11675
|
+
enum MediaGalleryLayout {
|
|
11676
|
+
/**
|
|
11677
|
+
* The layout is determined automatically.
|
|
11678
|
+
*/
|
|
11679
|
+
Auto = "Auto",
|
|
11680
|
+
/**
|
|
11681
|
+
* Displays the layout as a horizontal split between the thumbnails list and the selected image.
|
|
11682
|
+
*/
|
|
11683
|
+
Horizontal = "Horizontal",
|
|
11684
|
+
/**
|
|
11685
|
+
* Displays the layout as a vertical split between the thumbnails list and the selected image.
|
|
11686
|
+
*/
|
|
11687
|
+
Vertical = "Vertical",
|
|
11688
|
+
}
|
|
11689
|
+
/**
|
|
11690
|
+
* @SINCE 1.99.0
|
|
11691
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
11692
|
+
*
|
|
11693
|
+
* Defines the horizontal alignment of the thumbnails menu of the `ui5-media-gallery` component.
|
|
11694
|
+
*/
|
|
11695
|
+
enum MediaGalleryMenuHorizontalAlign {
|
|
11696
|
+
/**
|
|
11697
|
+
* Displays the menu on the left side of the target.
|
|
11698
|
+
*/
|
|
11699
|
+
Left = "Left",
|
|
11700
|
+
/**
|
|
11701
|
+
* Displays the menu on the right side of the target.
|
|
11702
|
+
*/
|
|
11703
|
+
Right = "Right",
|
|
11704
|
+
}
|
|
11705
|
+
/**
|
|
11706
|
+
* @SINCE 1.99.0
|
|
11707
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
11708
|
+
*
|
|
11709
|
+
* Types for the vertical alignment of the thumbnails menu of the `ui5-media-gallery` component.
|
|
11710
|
+
*/
|
|
11711
|
+
enum MediaGalleryMenuVerticalAlign {
|
|
11712
|
+
/**
|
|
11713
|
+
* Displays the menu at the bottom of the reference control.
|
|
11714
|
+
*/
|
|
11715
|
+
Bottom = "Bottom",
|
|
11716
|
+
/**
|
|
11717
|
+
* Displays the menu at the top of the reference control.
|
|
11718
|
+
*/
|
|
11719
|
+
Top = "Top",
|
|
9982
11720
|
}
|
|
9983
11721
|
/**
|
|
9984
11722
|
* @SINCE 1.92.0
|
|
@@ -10000,6 +11738,76 @@ declare namespace sap {
|
|
|
10000
11738
|
*/
|
|
10001
11739
|
Transparent = "Transparent",
|
|
10002
11740
|
}
|
|
11741
|
+
/**
|
|
11742
|
+
* @SINCE 1.99.0
|
|
11743
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
11744
|
+
*
|
|
11745
|
+
* SideContent FallDown options.
|
|
11746
|
+
*/
|
|
11747
|
+
enum SideContentFallDown {
|
|
11748
|
+
/**
|
|
11749
|
+
* Side content falls down on breakpoints below L
|
|
11750
|
+
*/
|
|
11751
|
+
BelowL = "BelowL",
|
|
11752
|
+
/**
|
|
11753
|
+
* Side content falls down on breakpoints below M
|
|
11754
|
+
*/
|
|
11755
|
+
BelowM = "BelowM",
|
|
11756
|
+
/**
|
|
11757
|
+
* Side content falls down on breakpoints below XL
|
|
11758
|
+
*/
|
|
11759
|
+
BelowXL = "BelowXL",
|
|
11760
|
+
/**
|
|
11761
|
+
* Side content falls down on breakpoint M and the minimum width for the side content
|
|
11762
|
+
*/
|
|
11763
|
+
OnMinimumWidth = "OnMinimumWidth",
|
|
11764
|
+
}
|
|
11765
|
+
/**
|
|
11766
|
+
* @SINCE 1.99.0
|
|
11767
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
11768
|
+
*
|
|
11769
|
+
* Side Content position options.
|
|
11770
|
+
*/
|
|
11771
|
+
enum SideContentPosition {
|
|
11772
|
+
/**
|
|
11773
|
+
* The side content is on the right side of the main container in left-to-right mode and on the left side
|
|
11774
|
+
* in right-to-left mode.
|
|
11775
|
+
*/
|
|
11776
|
+
End = "End",
|
|
11777
|
+
/**
|
|
11778
|
+
* The side content is on the left side of the main container in left-to-right mode and on the right side
|
|
11779
|
+
* in right-to-left mode.
|
|
11780
|
+
*/
|
|
11781
|
+
Start = "Start",
|
|
11782
|
+
}
|
|
11783
|
+
/**
|
|
11784
|
+
* @SINCE 1.99.0
|
|
11785
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
11786
|
+
*
|
|
11787
|
+
* Side Content visibility options.
|
|
11788
|
+
*/
|
|
11789
|
+
enum SideContentVisibility {
|
|
11790
|
+
/**
|
|
11791
|
+
* Show the side content on any breakpoint
|
|
11792
|
+
*/
|
|
11793
|
+
AlwaysShow = "AlwaysShow",
|
|
11794
|
+
/**
|
|
11795
|
+
* Don't show the side content on any breakpoints
|
|
11796
|
+
*/
|
|
11797
|
+
NeverShow = "NeverShow",
|
|
11798
|
+
/**
|
|
11799
|
+
* Show the side content on XL breakpoint
|
|
11800
|
+
*/
|
|
11801
|
+
ShowAboveL = "ShowAboveL",
|
|
11802
|
+
/**
|
|
11803
|
+
* Show the side content on L and XL breakpoints
|
|
11804
|
+
*/
|
|
11805
|
+
ShowAboveM = "ShowAboveM",
|
|
11806
|
+
/**
|
|
11807
|
+
* Show the side content on M, L and XL breakpoints
|
|
11808
|
+
*/
|
|
11809
|
+
ShowAboveS = "ShowAboveS",
|
|
11810
|
+
}
|
|
10003
11811
|
/**
|
|
10004
11812
|
* @SINCE 1.92.0
|
|
10005
11813
|
* @EXPERIMENTAL (since 1.92.0)
|
|
@@ -10049,6 +11857,8 @@ declare namespace sap {
|
|
|
10049
11857
|
|
|
10050
11858
|
"sap/ui/webc/fiori/BarcodeScannerDialog": undefined;
|
|
10051
11859
|
|
|
11860
|
+
"sap/ui/webc/fiori/DynamicSideContent": undefined;
|
|
11861
|
+
|
|
10052
11862
|
"sap/ui/webc/fiori/FilterItem": undefined;
|
|
10053
11863
|
|
|
10054
11864
|
"sap/ui/webc/fiori/FilterItemOption": undefined;
|
|
@@ -10059,6 +11869,10 @@ declare namespace sap {
|
|
|
10059
11869
|
|
|
10060
11870
|
"sap/ui/webc/fiori/library": undefined;
|
|
10061
11871
|
|
|
11872
|
+
"sap/ui/webc/fiori/MediaGallery": undefined;
|
|
11873
|
+
|
|
11874
|
+
"sap/ui/webc/fiori/MediaGalleryItem": undefined;
|
|
11875
|
+
|
|
10062
11876
|
"sap/ui/webc/fiori/NotificationAction": undefined;
|
|
10063
11877
|
|
|
10064
11878
|
"sap/ui/webc/fiori/NotificationListGroupItem": undefined;
|