@openui5/ts-types 1.98.0 → 1.99.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/types/sap.f.d.ts +156 -64
- package/types/sap.m.d.ts +1024 -66
- package/types/sap.tnt.d.ts +1 -1
- package/types/sap.ui.codeeditor.d.ts +1 -1
- package/types/sap.ui.commons.d.ts +1 -1
- package/types/sap.ui.core.d.ts +564 -190
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.fl.d.ts +7 -5
- package/types/sap.ui.integration.d.ts +9 -9
- package/types/sap.ui.layout.d.ts +4 -1
- package/types/sap.ui.mdc.d.ts +5 -1
- package/types/sap.ui.rta.d.ts +1 -1
- package/types/sap.ui.suite.d.ts +1 -1
- package/types/sap.ui.support.d.ts +6 -6
- package/types/sap.ui.table.d.ts +1 -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 +2438 -554
- package/types/sap.ui.webc.main.d.ts +2187 -394
- package/types/sap.uxap.d.ts +1 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.
|
|
1
|
+
// For Library Version: 1.99.0
|
|
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;
|
|
@@ -1415,8 +1675,13 @@ declare namespace sap {
|
|
|
1415
1675
|
* allow developers to style elements inside the Shadow DOM.
|
|
1416
1676
|
* The `sap.ui.webc.fiori.Bar` exposes the following CSS Shadow Parts:
|
|
1417
1677
|
* - bar - Used to style the wrapper of the content of the component
|
|
1678
|
+
*
|
|
1679
|
+
* Keyboard Handling:
|
|
1418
1680
|
*/
|
|
1419
|
-
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;
|
|
1420
1685
|
/**
|
|
1421
1686
|
* Constructor for a new `Bar`.
|
|
1422
1687
|
*
|
|
@@ -1945,19 +2210,68 @@ declare namespace sap {
|
|
|
1945
2210
|
show(): void;
|
|
1946
2211
|
}
|
|
1947
2212
|
/**
|
|
1948
|
-
* @SINCE 1.
|
|
1949
|
-
* @EXPERIMENTAL (since 1.
|
|
2213
|
+
* @SINCE 1.99.0
|
|
2214
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
1950
2215
|
*
|
|
1951
2216
|
* Overview:
|
|
1952
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
|
+
*
|
|
1953
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.
|
|
1954
2271
|
*/
|
|
1955
|
-
class
|
|
1956
|
-
extends sap.ui.webc.common.WebComponent
|
|
1957
|
-
implements sap.ui.webc.fiori.IFilterItem {
|
|
1958
|
-
__implements__sap_ui_webc_fiori_IFilterItem: boolean;
|
|
2272
|
+
class DynamicSideContent extends sap.ui.webc.common.WebComponent {
|
|
1959
2273
|
/**
|
|
1960
|
-
* Constructor for a new `
|
|
2274
|
+
* Constructor for a new `DynamicSideContent`.
|
|
1961
2275
|
*
|
|
1962
2276
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1963
2277
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
@@ -1967,10 +2281,10 @@ declare namespace sap {
|
|
|
1967
2281
|
/**
|
|
1968
2282
|
* Initial settings for the new control
|
|
1969
2283
|
*/
|
|
1970
|
-
mSettings?: sap.ui.webc.fiori.$
|
|
2284
|
+
mSettings?: sap.ui.webc.fiori.$DynamicSideContentSettings
|
|
1971
2285
|
);
|
|
1972
2286
|
/**
|
|
1973
|
-
* Constructor for a new `
|
|
2287
|
+
* Constructor for a new `DynamicSideContent`.
|
|
1974
2288
|
*
|
|
1975
2289
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1976
2290
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
@@ -1984,12 +2298,12 @@ declare namespace sap {
|
|
|
1984
2298
|
/**
|
|
1985
2299
|
* Initial settings for the new control
|
|
1986
2300
|
*/
|
|
1987
|
-
mSettings?: sap.ui.webc.fiori.$
|
|
2301
|
+
mSettings?: sap.ui.webc.fiori.$DynamicSideContentSettings
|
|
1988
2302
|
);
|
|
1989
2303
|
|
|
1990
2304
|
/**
|
|
1991
|
-
* Creates a new subclass of class sap.ui.webc.fiori.
|
|
1992
|
-
* 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`.
|
|
1993
2307
|
*
|
|
1994
2308
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
|
|
1995
2309
|
*/
|
|
@@ -2001,7 +2315,7 @@ declare namespace sap {
|
|
|
2001
2315
|
/**
|
|
2002
2316
|
* Object literal with information about the class
|
|
2003
2317
|
*/
|
|
2004
|
-
oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.
|
|
2318
|
+
oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.DynamicSideContent>,
|
|
2005
2319
|
/**
|
|
2006
2320
|
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
2007
2321
|
* used by this class
|
|
@@ -2009,91 +2323,417 @@ declare namespace sap {
|
|
|
2009
2323
|
FNMetaImpl?: Function
|
|
2010
2324
|
): Function;
|
|
2011
2325
|
/**
|
|
2012
|
-
* Returns a metadata object for class sap.ui.webc.fiori.
|
|
2326
|
+
* Returns a metadata object for class sap.ui.webc.fiori.DynamicSideContent.
|
|
2013
2327
|
*/
|
|
2014
2328
|
static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
|
|
2015
2329
|
/**
|
|
2016
|
-
* Adds some
|
|
2330
|
+
* Adds some content to the aggregation {@link #getContent content}.
|
|
2017
2331
|
*/
|
|
2018
|
-
|
|
2332
|
+
addContent(
|
|
2019
2333
|
/**
|
|
2020
|
-
* The
|
|
2334
|
+
* The content to add; if empty, nothing is inserted
|
|
2021
2335
|
*/
|
|
2022
|
-
|
|
2336
|
+
oContent: sap.ui.core.Control
|
|
2023
2337
|
): this;
|
|
2024
2338
|
/**
|
|
2025
|
-
*
|
|
2339
|
+
* Adds some sideContent to the aggregation {@link #getSideContent sideContent}.
|
|
2026
2340
|
*/
|
|
2027
|
-
|
|
2341
|
+
addSideContent(
|
|
2342
|
+
/**
|
|
2343
|
+
* The sideContent to add; if empty, nothing is inserted
|
|
2344
|
+
*/
|
|
2345
|
+
oSideContent: sap.ui.core.Control
|
|
2346
|
+
): this;
|
|
2028
2347
|
/**
|
|
2029
|
-
*
|
|
2030
|
-
*
|
|
2031
|
-
* 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`.
|
|
2032
2349
|
*
|
|
2033
|
-
*
|
|
2034
|
-
|
|
2035
|
-
getText(): string;
|
|
2036
|
-
/**
|
|
2037
|
-
* 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.
|
|
2038
2352
|
*
|
|
2039
|
-
*
|
|
2353
|
+
* Fires when the current breakpoint has been changed.
|
|
2040
2354
|
*/
|
|
2041
|
-
|
|
2042
|
-
/**
|
|
2043
|
-
* Checks for the provided `sap.ui.webc.fiori.IFilterItemOption` in the aggregation {@link #getValues values}.
|
|
2044
|
-
* and returns its index if found or -1 otherwise.
|
|
2045
|
-
*/
|
|
2046
|
-
indexOfValue(
|
|
2355
|
+
attachLayoutChange(
|
|
2047
2356
|
/**
|
|
2048
|
-
*
|
|
2357
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
2358
|
+
* object when firing the event
|
|
2049
2359
|
*/
|
|
2050
|
-
|
|
2051
|
-
): int;
|
|
2052
|
-
/**
|
|
2053
|
-
* Inserts a value into the aggregation {@link #getValues values}.
|
|
2054
|
-
*/
|
|
2055
|
-
insertValue(
|
|
2360
|
+
oData: object,
|
|
2056
2361
|
/**
|
|
2057
|
-
* The
|
|
2362
|
+
* The function to be called when the event occurs
|
|
2058
2363
|
*/
|
|
2059
|
-
|
|
2364
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
2060
2365
|
/**
|
|
2061
|
-
*
|
|
2062
|
-
*
|
|
2063
|
-
|
|
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
|
|
2064
2563
|
*/
|
|
2065
2564
|
iIndex: int
|
|
2066
2565
|
): this;
|
|
2067
2566
|
/**
|
|
2068
|
-
*
|
|
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}.
|
|
2069
2583
|
*
|
|
2070
2584
|
* Additionally, it unregisters them from the hosting UIArea.
|
|
2071
2585
|
*/
|
|
2072
|
-
|
|
2586
|
+
removeAllContent(): sap.ui.core.Control[];
|
|
2073
2587
|
/**
|
|
2074
|
-
* Removes
|
|
2588
|
+
* Removes all the controls from the aggregation {@link #getSideContent sideContent}.
|
|
2589
|
+
*
|
|
2590
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
2075
2591
|
*/
|
|
2076
|
-
|
|
2592
|
+
removeAllSideContent(): sap.ui.core.Control[];
|
|
2593
|
+
/**
|
|
2594
|
+
* Removes a content from the aggregation {@link #getContent content}.
|
|
2595
|
+
*/
|
|
2596
|
+
removeContent(
|
|
2077
2597
|
/**
|
|
2078
|
-
* The
|
|
2598
|
+
* The content to remove or its index or id
|
|
2079
2599
|
*/
|
|
2080
|
-
|
|
2081
|
-
): sap.ui.
|
|
2600
|
+
vContent: int | string | sap.ui.core.Control
|
|
2601
|
+
): sap.ui.core.Control;
|
|
2082
2602
|
/**
|
|
2083
|
-
*
|
|
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}.
|
|
2084
2613
|
*
|
|
2085
|
-
* Defines the
|
|
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.
|
|
2086
2617
|
*
|
|
2087
2618
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2088
2619
|
*
|
|
2089
|
-
* Default value is `
|
|
2620
|
+
* Default value is `false`.
|
|
2090
2621
|
*/
|
|
2091
|
-
|
|
2622
|
+
setEqualSplit(
|
|
2092
2623
|
/**
|
|
2093
|
-
* New value for property `
|
|
2624
|
+
* New value for property `equalSplit`
|
|
2094
2625
|
*/
|
|
2095
|
-
|
|
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
|
|
2096
2732
|
): this;
|
|
2733
|
+
/**
|
|
2734
|
+
* Toggles visibility of main and side contents on S screen size (mobile device).
|
|
2735
|
+
*/
|
|
2736
|
+
toggleContents(): void;
|
|
2097
2737
|
}
|
|
2098
2738
|
/**
|
|
2099
2739
|
* @SINCE 1.97.0
|
|
@@ -2103,12 +2743,12 @@ declare namespace sap {
|
|
|
2103
2743
|
*
|
|
2104
2744
|
* Usage:
|
|
2105
2745
|
*/
|
|
2106
|
-
class
|
|
2746
|
+
class FilterItem
|
|
2107
2747
|
extends sap.ui.webc.common.WebComponent
|
|
2108
|
-
implements sap.ui.webc.fiori.
|
|
2109
|
-
|
|
2748
|
+
implements sap.ui.webc.fiori.IFilterItem {
|
|
2749
|
+
__implements__sap_ui_webc_fiori_IFilterItem: boolean;
|
|
2110
2750
|
/**
|
|
2111
|
-
* Constructor for a new `
|
|
2751
|
+
* Constructor for a new `FilterItem`.
|
|
2112
2752
|
*
|
|
2113
2753
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2114
2754
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
@@ -2118,10 +2758,10 @@ declare namespace sap {
|
|
|
2118
2758
|
/**
|
|
2119
2759
|
* Initial settings for the new control
|
|
2120
2760
|
*/
|
|
2121
|
-
mSettings?: sap.ui.webc.fiori.$
|
|
2761
|
+
mSettings?: sap.ui.webc.fiori.$FilterItemSettings
|
|
2122
2762
|
);
|
|
2123
2763
|
/**
|
|
2124
|
-
* Constructor for a new `
|
|
2764
|
+
* Constructor for a new `FilterItem`.
|
|
2125
2765
|
*
|
|
2126
2766
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2127
2767
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
@@ -2135,11 +2775,753 @@ declare namespace sap {
|
|
|
2135
2775
|
/**
|
|
2136
2776
|
* Initial settings for the new control
|
|
2137
2777
|
*/
|
|
2138
|
-
mSettings?: sap.ui.webc.fiori.$
|
|
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`.
|
|
3428
|
+
*/
|
|
3429
|
+
setLayout(
|
|
3430
|
+
/**
|
|
3431
|
+
* New value for property `layout`
|
|
3432
|
+
*/
|
|
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
|
|
2139
3521
|
);
|
|
2140
3522
|
|
|
2141
3523
|
/**
|
|
2142
|
-
* Creates a new subclass of class sap.ui.webc.fiori.
|
|
3524
|
+
* Creates a new subclass of class sap.ui.webc.fiori.IllustratedMessage with name `sClassName` and enriches
|
|
2143
3525
|
* it with the information contained in `oClassInfo`.
|
|
2144
3526
|
*
|
|
2145
3527
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
|
|
@@ -2152,7 +3534,7 @@ declare namespace sap {
|
|
|
2152
3534
|
/**
|
|
2153
3535
|
* Object literal with information about the class
|
|
2154
3536
|
*/
|
|
2155
|
-
oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.
|
|
3537
|
+
oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.IllustratedMessage>,
|
|
2156
3538
|
/**
|
|
2157
3539
|
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
2158
3540
|
* used by this class
|
|
@@ -2160,89 +3542,196 @@ declare namespace sap {
|
|
|
2160
3542
|
FNMetaImpl?: Function
|
|
2161
3543
|
): Function;
|
|
2162
3544
|
/**
|
|
2163
|
-
* Returns a metadata object for class sap.ui.webc.fiori.
|
|
3545
|
+
* Returns a metadata object for class sap.ui.webc.fiori.IllustratedMessage.
|
|
2164
3546
|
*/
|
|
2165
3547
|
static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
|
|
2166
3548
|
/**
|
|
2167
|
-
*
|
|
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}.
|
|
2168
3567
|
*
|
|
2169
|
-
* Defines
|
|
3568
|
+
* Defines the component actions.
|
|
3569
|
+
*/
|
|
3570
|
+
getActions(): sap.ui.webc.main.IButton[];
|
|
3571
|
+
/**
|
|
3572
|
+
* Gets current value of property {@link #getName name}.
|
|
2170
3573
|
*
|
|
2171
|
-
* Default value is `
|
|
3574
|
+
* Default value is `BeforeSearch`.
|
|
2172
3575
|
*/
|
|
2173
|
-
|
|
3576
|
+
getName(): sap.ui.webc.fiori.IllustrationMessageType;
|
|
2174
3577
|
/**
|
|
2175
|
-
* Gets
|
|
3578
|
+
* Gets content of aggregation {@link #getSubtitle subtitle}.
|
|
2176
3579
|
*
|
|
2177
|
-
* Defines the
|
|
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.
|
|
2178
3594
|
*
|
|
2179
3595
|
* Default value is `empty string`.
|
|
2180
3596
|
*/
|
|
2181
|
-
|
|
3597
|
+
getSubtitleText(): string;
|
|
2182
3598
|
/**
|
|
2183
|
-
*
|
|
3599
|
+
* Gets current value of property {@link #getTitleText titleText}.
|
|
2184
3600
|
*
|
|
2185
|
-
* Defines
|
|
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
|
|
3617
|
+
): int;
|
|
3618
|
+
/**
|
|
3619
|
+
* Inserts a action into the aggregation {@link #getActions actions}.
|
|
3620
|
+
*/
|
|
3621
|
+
insertAction(
|
|
3622
|
+
/**
|
|
3623
|
+
* The action to insert; if empty, nothing is inserted
|
|
3624
|
+
*/
|
|
3625
|
+
oAction: sap.ui.webc.main.IButton,
|
|
3626
|
+
/**
|
|
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
|
|
3630
|
+
*/
|
|
3631
|
+
iIndex: int
|
|
3632
|
+
): this;
|
|
3633
|
+
/**
|
|
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}.
|
|
2186
3650
|
*
|
|
2187
3651
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2188
3652
|
*
|
|
2189
|
-
* Default value is `
|
|
3653
|
+
* Default value is `BeforeSearch`.
|
|
2190
3654
|
*/
|
|
2191
|
-
|
|
3655
|
+
setName(
|
|
2192
3656
|
/**
|
|
2193
|
-
* New value for property `
|
|
3657
|
+
* New value for property `name`
|
|
2194
3658
|
*/
|
|
2195
|
-
|
|
3659
|
+
sName?: sap.ui.webc.fiori.IllustrationMessageType
|
|
2196
3660
|
): this;
|
|
2197
3661
|
/**
|
|
2198
|
-
* Sets
|
|
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}.
|
|
2199
3672
|
*
|
|
2200
|
-
* Defines the
|
|
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.
|
|
2201
3678
|
*
|
|
2202
3679
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2203
3680
|
*
|
|
2204
3681
|
* Default value is `empty string`.
|
|
2205
3682
|
*/
|
|
2206
|
-
|
|
3683
|
+
setSubtitleText(
|
|
2207
3684
|
/**
|
|
2208
|
-
* New value for property `
|
|
3685
|
+
* New value for property `subtitleText`
|
|
2209
3686
|
*/
|
|
2210
|
-
|
|
3687
|
+
sSubtitleText?: string
|
|
3688
|
+
): this;
|
|
3689
|
+
/**
|
|
3690
|
+
* Sets a new value for property {@link #getTitleText titleText}.
|
|
3691
|
+
*
|
|
3692
|
+
* Defines the title of the component.
|
|
3693
|
+
*
|
|
3694
|
+
* **Note:** Using this property, the default title text of illustration will be overwritten.
|
|
3695
|
+
*
|
|
3696
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3697
|
+
*
|
|
3698
|
+
* Default value is `empty string`.
|
|
3699
|
+
*/
|
|
3700
|
+
setTitleText(
|
|
3701
|
+
/**
|
|
3702
|
+
* New value for property `titleText`
|
|
3703
|
+
*/
|
|
3704
|
+
sTitleText?: string
|
|
2211
3705
|
): this;
|
|
2212
3706
|
}
|
|
2213
3707
|
/**
|
|
2214
|
-
* @SINCE 1.
|
|
2215
|
-
* @EXPERIMENTAL (since 1.
|
|
3708
|
+
* @SINCE 1.99.0
|
|
3709
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
2216
3710
|
*
|
|
2217
3711
|
* Overview:
|
|
2218
3712
|
*
|
|
2219
|
-
* The `
|
|
2220
|
-
*
|
|
2221
|
-
*
|
|
2222
|
-
*
|
|
2223
|
-
* Usage:
|
|
2224
|
-
*
|
|
2225
|
-
* Use this component for applications that need to display several logical levels of related information
|
|
2226
|
-
* side by side (e.g. list of items, item, sub-item, etc.). The Component is flexible in a sense that the
|
|
2227
|
-
* application can focus the user's attention on one particular column.
|
|
2228
|
-
*
|
|
2229
|
-
* Responsive Behavior:
|
|
2230
|
-
*
|
|
2231
|
-
* The `FlexibleColumnLayout` automatically displays the maximum possible number of columns based on `layout`
|
|
2232
|
-
* property and the window size. The component would display 1 column for window size smaller than 599px,
|
|
2233
|
-
* up to two columns between 599px and 1023px, and 3 columns for sizes bigger than 1023px.
|
|
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.
|
|
2234
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.
|
|
2235
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:
|
|
2236
3725
|
*
|
|
2237
|
-
* Keyboard Handling:
|
|
2238
3726
|
*
|
|
2239
3727
|
*
|
|
2240
|
-
* - [
|
|
2241
|
-
*
|
|
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
|
|
2242
3731
|
*/
|
|
2243
|
-
class
|
|
3732
|
+
class MediaGallery extends sap.ui.webc.common.WebComponent {
|
|
2244
3733
|
/**
|
|
2245
|
-
* Constructor for a new `
|
|
3734
|
+
* Constructor for a new `MediaGallery`.
|
|
2246
3735
|
*
|
|
2247
3736
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2248
3737
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
@@ -2252,10 +3741,10 @@ declare namespace sap {
|
|
|
2252
3741
|
/**
|
|
2253
3742
|
* Initial settings for the new control
|
|
2254
3743
|
*/
|
|
2255
|
-
mSettings?: sap.ui.webc.fiori.$
|
|
3744
|
+
mSettings?: sap.ui.webc.fiori.$MediaGallerySettings
|
|
2256
3745
|
);
|
|
2257
3746
|
/**
|
|
2258
|
-
* Constructor for a new `
|
|
3747
|
+
* Constructor for a new `MediaGallery`.
|
|
2259
3748
|
*
|
|
2260
3749
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2261
3750
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
@@ -2269,12 +3758,12 @@ declare namespace sap {
|
|
|
2269
3758
|
/**
|
|
2270
3759
|
* Initial settings for the new control
|
|
2271
3760
|
*/
|
|
2272
|
-
mSettings?: sap.ui.webc.fiori.$
|
|
3761
|
+
mSettings?: sap.ui.webc.fiori.$MediaGallerySettings
|
|
2273
3762
|
);
|
|
2274
3763
|
|
|
2275
3764
|
/**
|
|
2276
|
-
* Creates a new subclass of class sap.ui.webc.fiori.
|
|
2277
|
-
*
|
|
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`.
|
|
2278
3767
|
*
|
|
2279
3768
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
|
|
2280
3769
|
*/
|
|
@@ -2286,10 +3775,7 @@ declare namespace sap {
|
|
|
2286
3775
|
/**
|
|
2287
3776
|
* Object literal with information about the class
|
|
2288
3777
|
*/
|
|
2289
|
-
oClassInfo?: sap.ClassInfo<
|
|
2290
|
-
T,
|
|
2291
|
-
sap.ui.webc.fiori.FlexibleColumnLayout
|
|
2292
|
-
>,
|
|
3778
|
+
oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.MediaGallery>,
|
|
2293
3779
|
/**
|
|
2294
3780
|
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
2295
3781
|
* used by this class
|
|
@@ -2297,19 +3783,114 @@ declare namespace sap {
|
|
|
2297
3783
|
FNMetaImpl?: Function
|
|
2298
3784
|
): Function;
|
|
2299
3785
|
/**
|
|
2300
|
-
* Returns a metadata object for class sap.ui.webc.fiori.
|
|
3786
|
+
* Returns a metadata object for class sap.ui.webc.fiori.MediaGallery.
|
|
2301
3787
|
*/
|
|
2302
3788
|
static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
|
|
2303
3789
|
/**
|
|
2304
|
-
*
|
|
3790
|
+
* Adds some item to the aggregation {@link #getItems items}.
|
|
3791
|
+
*/
|
|
3792
|
+
addItem(
|
|
3793
|
+
/**
|
|
3794
|
+
* The item to add; if empty, nothing is inserted
|
|
3795
|
+
*/
|
|
3796
|
+
oItem: sap.ui.webc.fiori.IMediaGalleryItem
|
|
3797
|
+
): this;
|
|
3798
|
+
/**
|
|
3799
|
+
* Attaches event handler `fnFunction` to the {@link #event:displayAreaClick displayAreaClick} event of
|
|
3800
|
+
* this `sap.ui.webc.fiori.MediaGallery`.
|
|
3801
|
+
*
|
|
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.
|
|
3804
|
+
*
|
|
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.
|
|
3807
|
+
*/
|
|
3808
|
+
attachDisplayAreaClick(
|
|
3809
|
+
/**
|
|
3810
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
3811
|
+
* object when firing the event
|
|
3812
|
+
*/
|
|
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
|
|
3822
|
+
): this;
|
|
3823
|
+
/**
|
|
3824
|
+
* Attaches event handler `fnFunction` to the {@link #event:displayAreaClick displayAreaClick} event of
|
|
3825
|
+
* this `sap.ui.webc.fiori.MediaGallery`.
|
|
3826
|
+
*
|
|
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.
|
|
3829
|
+
*
|
|
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.
|
|
3832
|
+
*/
|
|
3833
|
+
attachDisplayAreaClick(
|
|
3834
|
+
/**
|
|
3835
|
+
* The function to be called when the event occurs
|
|
3836
|
+
*/
|
|
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
|
|
3842
|
+
): this;
|
|
3843
|
+
/**
|
|
3844
|
+
* Attaches event handler `fnFunction` to the {@link #event:overflowClick overflowClick} event of this `sap.ui.webc.fiori.MediaGallery`.
|
|
3845
|
+
*
|
|
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.
|
|
3850
|
+
*/
|
|
3851
|
+
attachOverflowClick(
|
|
3852
|
+
/**
|
|
3853
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
3854
|
+
* object when firing the event
|
|
3855
|
+
*/
|
|
3856
|
+
oData: object,
|
|
3857
|
+
/**
|
|
3858
|
+
* The function to be called when the event occurs
|
|
3859
|
+
*/
|
|
3860
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
3861
|
+
/**
|
|
3862
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.MediaGallery` itself
|
|
3863
|
+
*/
|
|
3864
|
+
oListener?: object
|
|
3865
|
+
): this;
|
|
3866
|
+
/**
|
|
3867
|
+
* Attaches event handler `fnFunction` to the {@link #event:overflowClick overflowClick} event of this `sap.ui.webc.fiori.MediaGallery`.
|
|
3868
|
+
*
|
|
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.
|
|
3873
|
+
*/
|
|
3874
|
+
attachOverflowClick(
|
|
3875
|
+
/**
|
|
3876
|
+
* The function to be called when the event occurs
|
|
3877
|
+
*/
|
|
3878
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
3879
|
+
/**
|
|
3880
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.MediaGallery` itself
|
|
3881
|
+
*/
|
|
3882
|
+
oListener?: object
|
|
3883
|
+
): this;
|
|
3884
|
+
/**
|
|
3885
|
+
* Attaches event handler `fnFunction` to the {@link #event:selectionChange selectionChange} event of this
|
|
3886
|
+
* `sap.ui.webc.fiori.MediaGallery`.
|
|
2305
3887
|
*
|
|
2306
3888
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
2307
|
-
* 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.
|
|
2308
3890
|
*
|
|
2309
|
-
* Fired when
|
|
2310
|
-
* size due to resizing.
|
|
3891
|
+
* Fired when selection is changed by user interaction.
|
|
2311
3892
|
*/
|
|
2312
|
-
|
|
3893
|
+
attachSelectionChange(
|
|
2313
3894
|
/**
|
|
2314
3895
|
* An application-specific payload object that will be passed to the event handler along with the event
|
|
2315
3896
|
* object when firing the event
|
|
@@ -2320,49 +3901,72 @@ declare namespace sap {
|
|
|
2320
3901
|
*/
|
|
2321
3902
|
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
2322
3903
|
/**
|
|
2323
|
-
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.
|
|
2324
|
-
* itself
|
|
3904
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.MediaGallery` itself
|
|
2325
3905
|
*/
|
|
2326
3906
|
oListener?: object
|
|
2327
3907
|
): this;
|
|
2328
3908
|
/**
|
|
2329
|
-
* 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`.
|
|
2330
3911
|
*
|
|
2331
3912
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
2332
|
-
* 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.
|
|
2333
3914
|
*
|
|
2334
|
-
* Fired when
|
|
2335
|
-
* size due to resizing.
|
|
3915
|
+
* Fired when selection is changed by user interaction.
|
|
2336
3916
|
*/
|
|
2337
|
-
|
|
3917
|
+
attachSelectionChange(
|
|
2338
3918
|
/**
|
|
2339
3919
|
* The function to be called when the event occurs
|
|
2340
3920
|
*/
|
|
2341
3921
|
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
2342
3922
|
/**
|
|
2343
|
-
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.
|
|
2344
|
-
* itself
|
|
3923
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.MediaGallery` itself
|
|
2345
3924
|
*/
|
|
2346
3925
|
oListener?: object
|
|
2347
3926
|
): this;
|
|
2348
3927
|
/**
|
|
2349
|
-
* Destroys the
|
|
3928
|
+
* Destroys all the items in the aggregation {@link #getItems items}.
|
|
2350
3929
|
*/
|
|
2351
|
-
|
|
3930
|
+
destroyItems(): this;
|
|
2352
3931
|
/**
|
|
2353
|
-
*
|
|
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.
|
|
2354
3936
|
*/
|
|
2355
|
-
|
|
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;
|
|
2356
3947
|
/**
|
|
2357
|
-
*
|
|
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.
|
|
2358
3952
|
*/
|
|
2359
|
-
|
|
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;
|
|
2360
3963
|
/**
|
|
2361
|
-
* 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`.
|
|
2362
3966
|
*
|
|
2363
3967
|
* The passed function and listener object must match the ones used for event registration.
|
|
2364
3968
|
*/
|
|
2365
|
-
|
|
3969
|
+
detachSelectionChange(
|
|
2366
3970
|
/**
|
|
2367
3971
|
* The function to be called, when the event occurs
|
|
2368
3972
|
*/
|
|
@@ -2373,298 +3977,262 @@ declare namespace sap {
|
|
|
2373
3977
|
oListener?: object
|
|
2374
3978
|
): this;
|
|
2375
3979
|
/**
|
|
2376
|
-
* Fires event {@link #event:
|
|
3980
|
+
* Fires event {@link #event:displayAreaClick displayAreaClick} to attached listeners.
|
|
2377
3981
|
*/
|
|
2378
|
-
|
|
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
|
|
3994
|
+
*/
|
|
3995
|
+
mParameters?: object
|
|
3996
|
+
): this;
|
|
3997
|
+
/**
|
|
3998
|
+
* Fires event {@link #event:selectionChange selectionChange} to attached listeners.
|
|
3999
|
+
*/
|
|
4000
|
+
fireSelectionChange(
|
|
2379
4001
|
/**
|
|
2380
4002
|
* Parameters to pass along with the event
|
|
2381
4003
|
*/
|
|
2382
4004
|
mParameters?: {
|
|
2383
4005
|
/**
|
|
2384
|
-
*
|
|
2385
|
-
*/
|
|
2386
|
-
layout?: sap.ui.webc.fiori.FCLLayout;
|
|
2387
|
-
/**
|
|
2388
|
-
* The effective column layout, f.e [67%, 33%, 0]
|
|
2389
|
-
*/
|
|
2390
|
-
columnLayout?: any[];
|
|
2391
|
-
/**
|
|
2392
|
-
* Indicates if the start column is currently visible
|
|
2393
|
-
*/
|
|
2394
|
-
startColumnVisible?: boolean;
|
|
2395
|
-
/**
|
|
2396
|
-
* Indicates if the middle column is currently visible
|
|
2397
|
-
*/
|
|
2398
|
-
midColumnVisible?: boolean;
|
|
2399
|
-
/**
|
|
2400
|
-
* Indicates if the end column is currently visible
|
|
2401
|
-
*/
|
|
2402
|
-
endColumnVisible?: boolean;
|
|
2403
|
-
/**
|
|
2404
|
-
* Indicates if the layout is changed via the arrows
|
|
2405
|
-
*/
|
|
2406
|
-
arrowsUsed?: boolean;
|
|
2407
|
-
/**
|
|
2408
|
-
* Indicates if the layout is changed via resizing
|
|
4006
|
+
* the selected item.
|
|
2409
4007
|
*/
|
|
2410
|
-
|
|
4008
|
+
item?: HTMLElement;
|
|
2411
4009
|
}
|
|
2412
4010
|
): this;
|
|
2413
4011
|
/**
|
|
2414
|
-
* Gets current value of property {@link #
|
|
2415
|
-
*
|
|
2416
|
-
* An object of strings that defines several additional accessibility texts for even further customization.
|
|
4012
|
+
* Gets current value of property {@link #getInteractiveDisplayArea interactiveDisplayArea}.
|
|
2417
4013
|
*
|
|
2418
|
-
*
|
|
2419
|
-
*
|
|
2420
|
-
* the accessibility name for the `endColumn` region - `startArrowLeftText`: the text that the first arrow
|
|
2421
|
-
* (between the `begin` and `mid` columns) will have when pointing to the left - `startArrowRightText`:
|
|
2422
|
-
* the text that the first arrow (between the `begin` and `mid` columns) will have when pointing to the
|
|
2423
|
-
* right - `endArrowLeftText`: the text that the second arrow (between the `mid` and `end` columns) will
|
|
2424
|
-
* have when pointing to the left - `endArrowRightText`: the text that the second arrow (between the `mid`
|
|
2425
|
-
* 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.
|
|
2426
4016
|
*
|
|
2427
|
-
* Default value is `
|
|
4017
|
+
* Default value is `false`.
|
|
2428
4018
|
*/
|
|
2429
|
-
|
|
4019
|
+
getInteractiveDisplayArea(): boolean;
|
|
2430
4020
|
/**
|
|
2431
|
-
*
|
|
4021
|
+
* Gets content of aggregation {@link #getItems items}.
|
|
2432
4022
|
*
|
|
2433
|
-
*
|
|
2434
|
-
* the width of the start, middle and end columns.
|
|
2435
|
-
*/
|
|
2436
|
-
getColumnLayout(): void;
|
|
2437
|
-
/**
|
|
2438
|
-
* Gets content of aggregation {@link #getEndColumn endColumn}.
|
|
4023
|
+
* Defines the component items.
|
|
2439
4024
|
*
|
|
2440
|
-
* Defines the content in the end column.
|
|
2441
|
-
*/
|
|
2442
|
-
getEndColumn(): sap.ui.core.Control;
|
|
2443
|
-
/**
|
|
2444
|
-
* Returns if the `end` column is visible.
|
|
2445
|
-
*/
|
|
2446
|
-
getEndColumnVisible(): void;
|
|
2447
|
-
/**
|
|
2448
|
-
* Gets current value of property {@link #getHeight height}.
|
|
2449
4025
|
*
|
|
2450
|
-
* Defines the height of the control
|
|
2451
|
-
*/
|
|
2452
|
-
getHeight(): sap.ui.core.CSSSize;
|
|
2453
|
-
/**
|
|
2454
|
-
* Gets current value of property {@link #getHideArrows hideArrows}.
|
|
2455
4026
|
*
|
|
2456
|
-
*
|
|
4027
|
+
* **Note:** Only one selected item is allowed.
|
|
2457
4028
|
*
|
|
2458
|
-
*
|
|
4029
|
+
*
|
|
4030
|
+
*
|
|
4031
|
+
* **Note:** Use the `sap.ui.webc.fiori.MediaGalleryItem` component to define the desired items.
|
|
2459
4032
|
*/
|
|
2460
|
-
|
|
4033
|
+
getItems(): sap.ui.webc.fiori.IMediaGalleryItem[];
|
|
2461
4034
|
/**
|
|
2462
4035
|
* Gets current value of property {@link #getLayout layout}.
|
|
2463
4036
|
*
|
|
2464
|
-
*
|
|
2465
|
-
*
|
|
2466
|
-
* **Note:** The layout also depends on the screen size - one column for screens smaller than 599px, two
|
|
2467
|
-
* columns between 599px and 1023px and three columns for sizes bigger than 1023px.
|
|
4037
|
+
* Determines the layout of the component.
|
|
2468
4038
|
*
|
|
2469
4039
|
* Available options are:
|
|
2470
|
-
* - `
|
|
2471
|
-
* - `
|
|
2472
|
-
* - `
|
|
2473
|
-
* - `ThreeColumnsMidExpanded`
|
|
2474
|
-
* - `ThreeColumnsEndExpanded`
|
|
2475
|
-
* - `ThreeColumnsStartExpandedEndHidden`
|
|
2476
|
-
* - `ThreeColumnsMidExpandedEndHidden`
|
|
2477
|
-
* - `MidColumnFullScreen`
|
|
2478
|
-
* - `EndColumnFullScreen`
|
|
2479
|
-
*
|
|
2480
|
-
* **For example:** layout=`TwoColumnsStartExpanded` means the layout will display up to two columns in
|
|
2481
|
-
* 67%/33% proportion.
|
|
4040
|
+
* - `Auto`
|
|
4041
|
+
* - `Vertical`
|
|
4042
|
+
* - `Horizontal`
|
|
2482
4043
|
*
|
|
2483
|
-
* Default value is `
|
|
4044
|
+
* Default value is `Auto`.
|
|
2484
4045
|
*/
|
|
2485
|
-
getLayout(): sap.ui.webc.fiori.
|
|
4046
|
+
getLayout(): sap.ui.webc.fiori.MediaGalleryLayout;
|
|
2486
4047
|
/**
|
|
2487
|
-
* Gets
|
|
4048
|
+
* Gets current value of property {@link #getMenuHorizontalAlign menuHorizontalAlign}.
|
|
2488
4049
|
*
|
|
2489
|
-
*
|
|
2490
|
-
*/
|
|
2491
|
-
getMidColumn(): sap.ui.core.Control;
|
|
2492
|
-
/**
|
|
2493
|
-
* Returns if the `middle` column is visible.
|
|
2494
|
-
*/
|
|
2495
|
-
getMidColumnVisible(): void;
|
|
2496
|
-
/**
|
|
2497
|
-
* Gets content of aggregation {@link #getStartColumn startColumn}.
|
|
4050
|
+
* Determines the horizontal alignment of the thumbnails menu vs. the central display area.
|
|
2498
4051
|
*
|
|
2499
|
-
*
|
|
2500
|
-
|
|
2501
|
-
|
|
2502
|
-
/**
|
|
2503
|
-
* Returns if the `start` column is visible.
|
|
2504
|
-
*/
|
|
2505
|
-
getStartColumnVisible(): void;
|
|
2506
|
-
/**
|
|
2507
|
-
* Returns the number of currently visible columns.
|
|
2508
|
-
*/
|
|
2509
|
-
getVisibleColumns(): void;
|
|
2510
|
-
/**
|
|
2511
|
-
* Gets current value of property {@link #getWidth width}.
|
|
4052
|
+
* Available options are:
|
|
4053
|
+
* - `Left`
|
|
4054
|
+
* - `Right`
|
|
2512
4055
|
*
|
|
2513
|
-
*
|
|
4056
|
+
* Default value is `Left`.
|
|
2514
4057
|
*/
|
|
2515
|
-
|
|
4058
|
+
getMenuHorizontalAlign(): sap.ui.webc.fiori.MediaGalleryMenuHorizontalAlign;
|
|
2516
4059
|
/**
|
|
2517
|
-
*
|
|
4060
|
+
* Gets current value of property {@link #getMenuVerticalAlign menuVerticalAlign}.
|
|
2518
4061
|
*
|
|
2519
|
-
*
|
|
4062
|
+
* Determines the vertical alignment of the thumbnails menu vs. the central display area.
|
|
2520
4063
|
*
|
|
2521
|
-
*
|
|
2522
|
-
*
|
|
2523
|
-
*
|
|
2524
|
-
* (between the `begin` and `mid` columns) will have when pointing to the left - `startArrowRightText`:
|
|
2525
|
-
* the text that the first arrow (between the `begin` and `mid` columns) will have when pointing to the
|
|
2526
|
-
* right - `endArrowLeftText`: the text that the second arrow (between the `mid` and `end` columns) will
|
|
2527
|
-
* have when pointing to the left - `endArrowRightText`: the text that the second arrow (between the `mid`
|
|
2528
|
-
* and `end` columns) will have when pointing to the right
|
|
4064
|
+
* Available options are:
|
|
4065
|
+
* - `Top`
|
|
4066
|
+
* - `Bottom`
|
|
2529
4067
|
*
|
|
2530
|
-
*
|
|
4068
|
+
* Default value is `Bottom`.
|
|
4069
|
+
*/
|
|
4070
|
+
getMenuVerticalAlign(): sap.ui.webc.fiori.MediaGalleryMenuVerticalAlign;
|
|
4071
|
+
/**
|
|
4072
|
+
* Gets current value of property {@link #getShowAllThumbnails showAllThumbnails}.
|
|
2531
4073
|
*
|
|
2532
|
-
*
|
|
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`.
|
|
2533
4078
|
*/
|
|
2534
|
-
|
|
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(
|
|
2535
4085
|
/**
|
|
2536
|
-
*
|
|
4086
|
+
* The item whose index is looked for
|
|
2537
4087
|
*/
|
|
2538
|
-
|
|
2539
|
-
):
|
|
4088
|
+
oItem: sap.ui.webc.fiori.IMediaGalleryItem
|
|
4089
|
+
): int;
|
|
2540
4090
|
/**
|
|
2541
|
-
*
|
|
4091
|
+
* Inserts a item into the aggregation {@link #getItems items}.
|
|
2542
4092
|
*/
|
|
2543
|
-
|
|
4093
|
+
insertItem(
|
|
2544
4094
|
/**
|
|
2545
|
-
* The
|
|
4095
|
+
* The item to insert; if empty, nothing is inserted
|
|
2546
4096
|
*/
|
|
2547
|
-
|
|
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
|
|
2548
4104
|
): this;
|
|
2549
4105
|
/**
|
|
2550
|
-
*
|
|
2551
|
-
*
|
|
2552
|
-
* Defines the height of the control
|
|
4106
|
+
* Removes all the controls from the aggregation {@link #getItems items}.
|
|
2553
4107
|
*
|
|
2554
|
-
*
|
|
4108
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
2555
4109
|
*/
|
|
2556
|
-
|
|
4110
|
+
removeAllItems(): sap.ui.webc.fiori.IMediaGalleryItem[];
|
|
4111
|
+
/**
|
|
4112
|
+
* Removes a item from the aggregation {@link #getItems items}.
|
|
4113
|
+
*/
|
|
4114
|
+
removeItem(
|
|
2557
4115
|
/**
|
|
2558
|
-
*
|
|
4116
|
+
* The item to remove or its index or id
|
|
2559
4117
|
*/
|
|
2560
|
-
|
|
2561
|
-
):
|
|
4118
|
+
vItem: int | string | sap.ui.webc.fiori.IMediaGalleryItem
|
|
4119
|
+
): sap.ui.webc.fiori.IMediaGalleryItem;
|
|
2562
4120
|
/**
|
|
2563
|
-
* Sets a new value for property {@link #
|
|
4121
|
+
* Sets a new value for property {@link #getInteractiveDisplayArea interactiveDisplayArea}.
|
|
2564
4122
|
*
|
|
2565
|
-
*
|
|
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.
|
|
2566
4125
|
*
|
|
2567
4126
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2568
4127
|
*
|
|
2569
4128
|
* Default value is `false`.
|
|
2570
4129
|
*/
|
|
2571
|
-
|
|
4130
|
+
setInteractiveDisplayArea(
|
|
2572
4131
|
/**
|
|
2573
|
-
* New value for property `
|
|
4132
|
+
* New value for property `interactiveDisplayArea`
|
|
2574
4133
|
*/
|
|
2575
|
-
|
|
4134
|
+
bInteractiveDisplayArea?: boolean
|
|
2576
4135
|
): this;
|
|
2577
4136
|
/**
|
|
2578
4137
|
* Sets a new value for property {@link #getLayout layout}.
|
|
2579
4138
|
*
|
|
2580
|
-
*
|
|
2581
|
-
*
|
|
2582
|
-
* **Note:** The layout also depends on the screen size - one column for screens smaller than 599px, two
|
|
2583
|
-
* columns between 599px and 1023px and three columns for sizes bigger than 1023px.
|
|
2584
|
-
*
|
|
2585
|
-
* Available options are:
|
|
2586
|
-
* - `OneColumn`
|
|
2587
|
-
* - `TwoColumnsStartExpanded`
|
|
2588
|
-
* - `TwoColumnsMidExpanded`
|
|
2589
|
-
* - `ThreeColumnsMidExpanded`
|
|
2590
|
-
* - `ThreeColumnsEndExpanded`
|
|
2591
|
-
* - `ThreeColumnsStartExpandedEndHidden`
|
|
2592
|
-
* - `ThreeColumnsMidExpandedEndHidden`
|
|
2593
|
-
* - `MidColumnFullScreen`
|
|
2594
|
-
* - `EndColumnFullScreen`
|
|
4139
|
+
* Determines the layout of the component.
|
|
2595
4140
|
*
|
|
2596
|
-
*
|
|
2597
|
-
*
|
|
4141
|
+
* Available options are:
|
|
4142
|
+
* - `Auto`
|
|
4143
|
+
* - `Vertical`
|
|
4144
|
+
* - `Horizontal`
|
|
2598
4145
|
*
|
|
2599
4146
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2600
4147
|
*
|
|
2601
|
-
* Default value is `
|
|
4148
|
+
* Default value is `Auto`.
|
|
2602
4149
|
*/
|
|
2603
4150
|
setLayout(
|
|
2604
4151
|
/**
|
|
2605
4152
|
* New value for property `layout`
|
|
2606
4153
|
*/
|
|
2607
|
-
sLayout?: sap.ui.webc.fiori.
|
|
4154
|
+
sLayout?: sap.ui.webc.fiori.MediaGalleryLayout
|
|
2608
4155
|
): this;
|
|
2609
4156
|
/**
|
|
2610
|
-
* 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`.
|
|
2611
4168
|
*/
|
|
2612
|
-
|
|
4169
|
+
setMenuHorizontalAlign(
|
|
2613
4170
|
/**
|
|
2614
|
-
*
|
|
4171
|
+
* New value for property `menuHorizontalAlign`
|
|
2615
4172
|
*/
|
|
2616
|
-
|
|
4173
|
+
sMenuHorizontalAlign?: sap.ui.webc.fiori.MediaGalleryMenuHorizontalAlign
|
|
2617
4174
|
): this;
|
|
2618
4175
|
/**
|
|
2619
|
-
* 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`.
|
|
2620
4187
|
*/
|
|
2621
|
-
|
|
4188
|
+
setMenuVerticalAlign(
|
|
2622
4189
|
/**
|
|
2623
|
-
*
|
|
4190
|
+
* New value for property `menuVerticalAlign`
|
|
2624
4191
|
*/
|
|
2625
|
-
|
|
4192
|
+
sMenuVerticalAlign?: sap.ui.webc.fiori.MediaGalleryMenuVerticalAlign
|
|
2626
4193
|
): this;
|
|
2627
4194
|
/**
|
|
2628
|
-
* Sets a new value for property {@link #
|
|
4195
|
+
* Sets a new value for property {@link #getShowAllThumbnails showAllThumbnails}.
|
|
2629
4196
|
*
|
|
2630
|
-
*
|
|
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.
|
|
2631
4199
|
*
|
|
2632
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`.
|
|
2633
4203
|
*/
|
|
2634
|
-
|
|
4204
|
+
setShowAllThumbnails(
|
|
2635
4205
|
/**
|
|
2636
|
-
* New value for property `
|
|
4206
|
+
* New value for property `showAllThumbnails`
|
|
2637
4207
|
*/
|
|
2638
|
-
|
|
4208
|
+
bShowAllThumbnails?: boolean
|
|
2639
4209
|
): this;
|
|
2640
4210
|
}
|
|
2641
4211
|
/**
|
|
2642
|
-
* @SINCE 1.
|
|
2643
|
-
* @EXPERIMENTAL (since 1.
|
|
4212
|
+
* @SINCE 1.99.0
|
|
4213
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
2644
4214
|
*
|
|
2645
|
-
* Overview:
|
|
2646
|
-
*
|
|
2647
|
-
* 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.
|
|
2648
4217
|
*
|
|
2649
|
-
*
|
|
2650
|
-
* `titleText` and `subtitleText` properties.
|
|
4218
|
+
* **Note:** `sap.ui.webc.fiori.MediaGalleryItem` is not supported when used outside of `sap.ui.webc.fiori.MediaGallery`.
|
|
2651
4219
|
*
|
|
2652
|
-
* Structure: The IllustratedMessage consists of the following elements, which are displayed below each
|
|
2653
|
-
* other in the following order:
|
|
2654
4220
|
*
|
|
2655
4221
|
*
|
|
2656
4222
|
*
|
|
2657
|
-
*
|
|
2658
|
-
*
|
|
2659
|
-
* - Subtitle
|
|
2660
|
-
* - 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:
|
|
2661
4225
|
*
|
|
2662
|
-
*
|
|
2663
|
-
*
|
|
4226
|
+
*
|
|
4227
|
+
*
|
|
4228
|
+
* - [SPACE/ENTER/RETURN] - Trigger `ui5-click` event
|
|
2664
4229
|
*/
|
|
2665
|
-
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;
|
|
2666
4234
|
/**
|
|
2667
|
-
* Constructor for a new `
|
|
4235
|
+
* Constructor for a new `MediaGalleryItem`.
|
|
2668
4236
|
*
|
|
2669
4237
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2670
4238
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
@@ -2674,10 +4242,10 @@ declare namespace sap {
|
|
|
2674
4242
|
/**
|
|
2675
4243
|
* Initial settings for the new control
|
|
2676
4244
|
*/
|
|
2677
|
-
mSettings?: sap.ui.webc.fiori.$
|
|
4245
|
+
mSettings?: sap.ui.webc.fiori.$MediaGalleryItemSettings
|
|
2678
4246
|
);
|
|
2679
4247
|
/**
|
|
2680
|
-
* Constructor for a new `
|
|
4248
|
+
* Constructor for a new `MediaGalleryItem`.
|
|
2681
4249
|
*
|
|
2682
4250
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2683
4251
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
@@ -2691,11 +4259,11 @@ declare namespace sap {
|
|
|
2691
4259
|
/**
|
|
2692
4260
|
* Initial settings for the new control
|
|
2693
4261
|
*/
|
|
2694
|
-
mSettings?: sap.ui.webc.fiori.$
|
|
4262
|
+
mSettings?: sap.ui.webc.fiori.$MediaGalleryItemSettings
|
|
2695
4263
|
);
|
|
2696
4264
|
|
|
2697
4265
|
/**
|
|
2698
|
-
* 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
|
|
2699
4267
|
* it with the information contained in `oClassInfo`.
|
|
2700
4268
|
*
|
|
2701
4269
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
|
|
@@ -2708,7 +4276,7 @@ declare namespace sap {
|
|
|
2708
4276
|
/**
|
|
2709
4277
|
* Object literal with information about the class
|
|
2710
4278
|
*/
|
|
2711
|
-
oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.
|
|
4279
|
+
oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.MediaGalleryItem>,
|
|
2712
4280
|
/**
|
|
2713
4281
|
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
2714
4282
|
* used by this class
|
|
@@ -2716,166 +4284,203 @@ declare namespace sap {
|
|
|
2716
4284
|
FNMetaImpl?: Function
|
|
2717
4285
|
): Function;
|
|
2718
4286
|
/**
|
|
2719
|
-
* Returns a metadata object for class sap.ui.webc.fiori.
|
|
4287
|
+
* Returns a metadata object for class sap.ui.webc.fiori.MediaGalleryItem.
|
|
2720
4288
|
*/
|
|
2721
4289
|
static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
|
|
2722
4290
|
/**
|
|
2723
|
-
* Adds some
|
|
4291
|
+
* Adds some content to the aggregation {@link #getContent content}.
|
|
2724
4292
|
*/
|
|
2725
|
-
|
|
4293
|
+
addContent(
|
|
2726
4294
|
/**
|
|
2727
|
-
* The
|
|
4295
|
+
* The content to add; if empty, nothing is inserted
|
|
2728
4296
|
*/
|
|
2729
|
-
|
|
4297
|
+
oContent: sap.ui.core.Control
|
|
2730
4298
|
): this;
|
|
2731
4299
|
/**
|
|
2732
|
-
*
|
|
4300
|
+
* Adds some thumbnail to the aggregation {@link #getThumbnail thumbnail}.
|
|
2733
4301
|
*/
|
|
2734
|
-
|
|
4302
|
+
addThumbnail(
|
|
4303
|
+
/**
|
|
4304
|
+
* The thumbnail to add; if empty, nothing is inserted
|
|
4305
|
+
*/
|
|
4306
|
+
oThumbnail: sap.ui.core.Control
|
|
4307
|
+
): this;
|
|
2735
4308
|
/**
|
|
2736
|
-
* Destroys the
|
|
4309
|
+
* Destroys all the content in the aggregation {@link #getContent content}.
|
|
2737
4310
|
*/
|
|
2738
|
-
|
|
4311
|
+
destroyContent(): this;
|
|
2739
4312
|
/**
|
|
2740
|
-
*
|
|
2741
|
-
*
|
|
2742
|
-
* Defines the component actions.
|
|
4313
|
+
* Destroys all the thumbnail in the aggregation {@link #getThumbnail thumbnail}.
|
|
2743
4314
|
*/
|
|
2744
|
-
|
|
4315
|
+
destroyThumbnail(): this;
|
|
2745
4316
|
/**
|
|
2746
|
-
* Gets
|
|
4317
|
+
* Gets content of aggregation {@link #getContent content}.
|
|
2747
4318
|
*
|
|
2748
|
-
*
|
|
4319
|
+
* Defines the content of the component.
|
|
2749
4320
|
*/
|
|
2750
|
-
|
|
4321
|
+
getContent(): sap.ui.core.Control[];
|
|
2751
4322
|
/**
|
|
2752
|
-
* Gets
|
|
4323
|
+
* Gets current value of property {@link #getDisabled disabled}.
|
|
2753
4324
|
*
|
|
2754
|
-
* Defines the
|
|
4325
|
+
* Defines whether the component is in disabled state.
|
|
2755
4326
|
*
|
|
2756
|
-
*
|
|
2757
|
-
* property will be overwritten.
|
|
4327
|
+
* Default value is `false`.
|
|
2758
4328
|
*/
|
|
2759
|
-
|
|
4329
|
+
getDisabled(): boolean;
|
|
2760
4330
|
/**
|
|
2761
|
-
* Gets current value of property {@link #
|
|
2762
|
-
*
|
|
2763
|
-
* Defines the subtitle of the component.
|
|
4331
|
+
* Gets current value of property {@link #getLayout layout}.
|
|
2764
4332
|
*
|
|
2765
|
-
*
|
|
4333
|
+
* Determines the layout of the item container.
|
|
2766
4334
|
*
|
|
2767
|
-
*
|
|
4335
|
+
* Available options are:
|
|
4336
|
+
* - `Square`
|
|
4337
|
+
* - `Wide`
|
|
2768
4338
|
*
|
|
2769
|
-
* Default value is `
|
|
4339
|
+
* Default value is `Square`.
|
|
2770
4340
|
*/
|
|
2771
|
-
|
|
4341
|
+
getLayout(): sap.ui.webc.fiori.MediaGalleryItemLayout;
|
|
2772
4342
|
/**
|
|
2773
|
-
* Gets current value of property {@link #
|
|
4343
|
+
* Gets current value of property {@link #getSelected selected}.
|
|
2774
4344
|
*
|
|
2775
|
-
* Defines the
|
|
4345
|
+
* Defines the selected state of the component.
|
|
2776
4346
|
*
|
|
2777
|
-
*
|
|
4347
|
+
* Default value is `false`.
|
|
4348
|
+
*/
|
|
4349
|
+
getSelected(): boolean;
|
|
4350
|
+
/**
|
|
4351
|
+
* Gets content of aggregation {@link #getThumbnail thumbnail}.
|
|
2778
4352
|
*
|
|
2779
|
-
*
|
|
4353
|
+
* Defines the content of the thumbnail.
|
|
2780
4354
|
*/
|
|
2781
|
-
|
|
4355
|
+
getThumbnail(): sap.ui.core.Control[];
|
|
2782
4356
|
/**
|
|
2783
|
-
* 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
|
|
2784
4368
|
* returns its index if found or -1 otherwise.
|
|
2785
4369
|
*/
|
|
2786
|
-
|
|
4370
|
+
indexOfThumbnail(
|
|
2787
4371
|
/**
|
|
2788
|
-
* The
|
|
4372
|
+
* The thumbnail whose index is looked for
|
|
2789
4373
|
*/
|
|
2790
|
-
|
|
4374
|
+
oThumbnail: sap.ui.core.Control
|
|
2791
4375
|
): int;
|
|
2792
4376
|
/**
|
|
2793
|
-
* Inserts a
|
|
4377
|
+
* Inserts a content into the aggregation {@link #getContent content}.
|
|
2794
4378
|
*/
|
|
2795
|
-
|
|
4379
|
+
insertContent(
|
|
2796
4380
|
/**
|
|
2797
|
-
* The
|
|
4381
|
+
* The content to insert; if empty, nothing is inserted
|
|
2798
4382
|
*/
|
|
2799
|
-
|
|
4383
|
+
oContent: sap.ui.core.Control,
|
|
2800
4384
|
/**
|
|
2801
|
-
* The `0`-based index the
|
|
2802
|
-
* inserted at position 0; for a value greater than the current size of the aggregation, the
|
|
2803
|
-
* 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
|
|
2804
4388
|
*/
|
|
2805
4389
|
iIndex: int
|
|
2806
4390
|
): this;
|
|
2807
4391
|
/**
|
|
2808
|
-
*
|
|
4392
|
+
* Inserts a thumbnail into the aggregation {@link #getThumbnail thumbnail}.
|
|
2809
4393
|
*/
|
|
2810
|
-
|
|
4394
|
+
insertThumbnail(
|
|
2811
4395
|
/**
|
|
2812
|
-
* The
|
|
4396
|
+
* The thumbnail to insert; if empty, nothing is inserted
|
|
2813
4397
|
*/
|
|
2814
|
-
|
|
2815
|
-
|
|
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;
|
|
2816
4406
|
/**
|
|
2817
|
-
* Removes all the controls from the aggregation {@link #
|
|
4407
|
+
* Removes all the controls from the aggregation {@link #getContent content}.
|
|
2818
4408
|
*
|
|
2819
4409
|
* Additionally, it unregisters them from the hosting UIArea.
|
|
2820
4410
|
*/
|
|
2821
|
-
|
|
4411
|
+
removeAllContent(): sap.ui.core.Control[];
|
|
2822
4412
|
/**
|
|
2823
|
-
*
|
|
2824
|
-
*
|
|
2825
|
-
* 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}.
|
|
2826
4414
|
*
|
|
2827
|
-
*
|
|
4415
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
2828
4416
|
*/
|
|
2829
|
-
|
|
4417
|
+
removeAllThumbnail(): sap.ui.core.Control[];
|
|
4418
|
+
/**
|
|
4419
|
+
* Removes a content from the aggregation {@link #getContent content}.
|
|
4420
|
+
*/
|
|
4421
|
+
removeContent(
|
|
2830
4422
|
/**
|
|
2831
|
-
*
|
|
4423
|
+
* The content to remove or its index or id
|
|
2832
4424
|
*/
|
|
2833
|
-
|
|
2834
|
-
):
|
|
4425
|
+
vContent: int | string | sap.ui.core.Control
|
|
4426
|
+
): sap.ui.core.Control;
|
|
2835
4427
|
/**
|
|
2836
|
-
*
|
|
4428
|
+
* Removes a thumbnail from the aggregation {@link #getThumbnail thumbnail}.
|
|
2837
4429
|
*/
|
|
2838
|
-
|
|
4430
|
+
removeThumbnail(
|
|
2839
4431
|
/**
|
|
2840
|
-
* The
|
|
4432
|
+
* The thumbnail to remove or its index or id
|
|
2841
4433
|
*/
|
|
2842
|
-
|
|
2843
|
-
):
|
|
4434
|
+
vThumbnail: int | string | sap.ui.core.Control
|
|
4435
|
+
): sap.ui.core.Control;
|
|
2844
4436
|
/**
|
|
2845
|
-
* Sets a new value for property {@link #
|
|
4437
|
+
* Sets a new value for property {@link #getDisabled disabled}.
|
|
2846
4438
|
*
|
|
2847
|
-
* Defines the
|
|
4439
|
+
* Defines whether the component is in disabled state.
|
|
2848
4440
|
*
|
|
2849
|
-
*
|
|
4441
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2850
4442
|
*
|
|
2851
|
-
*
|
|
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`
|
|
2852
4459
|
*
|
|
2853
4460
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2854
4461
|
*
|
|
2855
|
-
* Default value is `
|
|
4462
|
+
* Default value is `Square`.
|
|
2856
4463
|
*/
|
|
2857
|
-
|
|
4464
|
+
setLayout(
|
|
2858
4465
|
/**
|
|
2859
|
-
* New value for property `
|
|
4466
|
+
* New value for property `layout`
|
|
2860
4467
|
*/
|
|
2861
|
-
|
|
4468
|
+
sLayout?: sap.ui.webc.fiori.MediaGalleryItemLayout
|
|
2862
4469
|
): this;
|
|
2863
4470
|
/**
|
|
2864
|
-
* Sets a new value for property {@link #
|
|
2865
|
-
*
|
|
2866
|
-
* Defines the title of the component.
|
|
4471
|
+
* Sets a new value for property {@link #getSelected selected}.
|
|
2867
4472
|
*
|
|
2868
|
-
*
|
|
4473
|
+
* Defines the selected state of the component.
|
|
2869
4474
|
*
|
|
2870
4475
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2871
4476
|
*
|
|
2872
|
-
* Default value is `
|
|
4477
|
+
* Default value is `false`.
|
|
2873
4478
|
*/
|
|
2874
|
-
|
|
4479
|
+
setSelected(
|
|
2875
4480
|
/**
|
|
2876
|
-
* New value for property `
|
|
4481
|
+
* New value for property `selected`
|
|
2877
4482
|
*/
|
|
2878
|
-
|
|
4483
|
+
bSelected?: boolean
|
|
2879
4484
|
): this;
|
|
2880
4485
|
}
|
|
2881
4486
|
/**
|
|
@@ -4200,34 +5805,16 @@ declare namespace sap {
|
|
|
4200
5805
|
*/
|
|
4201
5806
|
oContent: sap.ui.core.Control
|
|
4202
5807
|
): this;
|
|
4203
|
-
/**
|
|
4204
|
-
* Adds some footer to the aggregation {@link #getFooter footer}.
|
|
4205
|
-
*/
|
|
4206
|
-
addFooter(
|
|
4207
|
-
/**
|
|
4208
|
-
* The footer to add; if empty, nothing is inserted
|
|
4209
|
-
*/
|
|
4210
|
-
oFooter: sap.ui.core.Control
|
|
4211
|
-
): this;
|
|
4212
|
-
/**
|
|
4213
|
-
* Adds some header to the aggregation {@link #getHeader header}.
|
|
4214
|
-
*/
|
|
4215
|
-
addHeader(
|
|
4216
|
-
/**
|
|
4217
|
-
* The header to add; if empty, nothing is inserted
|
|
4218
|
-
*/
|
|
4219
|
-
oHeader: sap.ui.core.Control
|
|
4220
|
-
): this;
|
|
4221
5808
|
/**
|
|
4222
5809
|
* Destroys all the content in the aggregation {@link #getContent content}.
|
|
4223
5810
|
*/
|
|
4224
5811
|
destroyContent(): this;
|
|
4225
5812
|
/**
|
|
4226
|
-
* Destroys
|
|
5813
|
+
* Destroys the footer in the aggregation {@link #getFooter footer}.
|
|
4227
5814
|
*/
|
|
4228
5815
|
destroyFooter(): this;
|
|
4229
5816
|
/**
|
|
4230
|
-
* Destroys
|
|
5817
|
+
* Destroys the header in the aggregation {@link #getHeader header}.
|
|
4231
5818
|
*/
|
|
4232
5819
|
destroyHeader(): this;
|
|
4233
5820
|
/**
|
|
@@ -4276,13 +5863,13 @@ declare namespace sap {
|
|
|
4276
5863
|
*
|
|
4277
5864
|
* Defines the footer HTML Element.
|
|
4278
5865
|
*/
|
|
4279
|
-
getFooter(): sap.ui.
|
|
5866
|
+
getFooter(): sap.ui.webc.fiori.IBar;
|
|
4280
5867
|
/**
|
|
4281
5868
|
* Gets content of aggregation {@link #getHeader header}.
|
|
4282
5869
|
*
|
|
4283
5870
|
* Defines the header HTML Element.
|
|
4284
5871
|
*/
|
|
4285
|
-
getHeader(): sap.ui.
|
|
5872
|
+
getHeader(): sap.ui.webc.fiori.IBar;
|
|
4286
5873
|
/**
|
|
4287
5874
|
* Gets current value of property {@link #getHeight height}.
|
|
4288
5875
|
*
|
|
@@ -4300,38 +5887,18 @@ declare namespace sap {
|
|
|
4300
5887
|
/**
|
|
4301
5888
|
* Gets current value of property {@link #getWidth width}.
|
|
4302
5889
|
*
|
|
4303
|
-
* Defines the width of the control
|
|
4304
|
-
*/
|
|
4305
|
-
getWidth(): sap.ui.core.CSSSize;
|
|
4306
|
-
/**
|
|
4307
|
-
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getContent content}. and returns
|
|
4308
|
-
* its index if found or -1 otherwise.
|
|
4309
|
-
*/
|
|
4310
|
-
indexOfContent(
|
|
4311
|
-
/**
|
|
4312
|
-
* The content whose index is looked for
|
|
4313
|
-
*/
|
|
4314
|
-
oContent: sap.ui.core.Control
|
|
4315
|
-
): int;
|
|
4316
|
-
/**
|
|
4317
|
-
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getFooter footer}. and returns
|
|
4318
|
-
* its index if found or -1 otherwise.
|
|
4319
|
-
*/
|
|
4320
|
-
indexOfFooter(
|
|
4321
|
-
/**
|
|
4322
|
-
* The footer whose index is looked for
|
|
4323
|
-
*/
|
|
4324
|
-
oFooter: sap.ui.core.Control
|
|
4325
|
-
): int;
|
|
5890
|
+
* Defines the width of the control
|
|
5891
|
+
*/
|
|
5892
|
+
getWidth(): sap.ui.core.CSSSize;
|
|
4326
5893
|
/**
|
|
4327
|
-
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #
|
|
5894
|
+
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getContent content}. and returns
|
|
4328
5895
|
* its index if found or -1 otherwise.
|
|
4329
5896
|
*/
|
|
4330
|
-
|
|
5897
|
+
indexOfContent(
|
|
4331
5898
|
/**
|
|
4332
|
-
* The
|
|
5899
|
+
* The content whose index is looked for
|
|
4333
5900
|
*/
|
|
4334
|
-
|
|
5901
|
+
oContent: sap.ui.core.Control
|
|
4335
5902
|
): int;
|
|
4336
5903
|
/**
|
|
4337
5904
|
* Inserts a content into the aggregation {@link #getContent content}.
|
|
@@ -4348,54 +5915,12 @@ declare namespace sap {
|
|
|
4348
5915
|
*/
|
|
4349
5916
|
iIndex: int
|
|
4350
5917
|
): this;
|
|
4351
|
-
/**
|
|
4352
|
-
* Inserts a footer into the aggregation {@link #getFooter footer}.
|
|
4353
|
-
*/
|
|
4354
|
-
insertFooter(
|
|
4355
|
-
/**
|
|
4356
|
-
* The footer to insert; if empty, nothing is inserted
|
|
4357
|
-
*/
|
|
4358
|
-
oFooter: sap.ui.core.Control,
|
|
4359
|
-
/**
|
|
4360
|
-
* The `0`-based index the footer should be inserted at; for a negative value of `iIndex`, the footer is
|
|
4361
|
-
* inserted at position 0; for a value greater than the current size of the aggregation, the footer is inserted
|
|
4362
|
-
* at the last position
|
|
4363
|
-
*/
|
|
4364
|
-
iIndex: int
|
|
4365
|
-
): this;
|
|
4366
|
-
/**
|
|
4367
|
-
* Inserts a header into the aggregation {@link #getHeader header}.
|
|
4368
|
-
*/
|
|
4369
|
-
insertHeader(
|
|
4370
|
-
/**
|
|
4371
|
-
* The header to insert; if empty, nothing is inserted
|
|
4372
|
-
*/
|
|
4373
|
-
oHeader: sap.ui.core.Control,
|
|
4374
|
-
/**
|
|
4375
|
-
* The `0`-based index the header should be inserted at; for a negative value of `iIndex`, the header is
|
|
4376
|
-
* inserted at position 0; for a value greater than the current size of the aggregation, the header is inserted
|
|
4377
|
-
* at the last position
|
|
4378
|
-
*/
|
|
4379
|
-
iIndex: int
|
|
4380
|
-
): this;
|
|
4381
5918
|
/**
|
|
4382
5919
|
* Removes all the controls from the aggregation {@link #getContent content}.
|
|
4383
5920
|
*
|
|
4384
5921
|
* Additionally, it unregisters them from the hosting UIArea.
|
|
4385
5922
|
*/
|
|
4386
5923
|
removeAllContent(): sap.ui.core.Control[];
|
|
4387
|
-
/**
|
|
4388
|
-
* Removes all the controls from the aggregation {@link #getFooter footer}.
|
|
4389
|
-
*
|
|
4390
|
-
* Additionally, it unregisters them from the hosting UIArea.
|
|
4391
|
-
*/
|
|
4392
|
-
removeAllFooter(): sap.ui.core.Control[];
|
|
4393
|
-
/**
|
|
4394
|
-
* Removes all the controls from the aggregation {@link #getHeader header}.
|
|
4395
|
-
*
|
|
4396
|
-
* Additionally, it unregisters them from the hosting UIArea.
|
|
4397
|
-
*/
|
|
4398
|
-
removeAllHeader(): sap.ui.core.Control[];
|
|
4399
5924
|
/**
|
|
4400
5925
|
* Removes a content from the aggregation {@link #getContent content}.
|
|
4401
5926
|
*/
|
|
@@ -4405,24 +5930,6 @@ declare namespace sap {
|
|
|
4405
5930
|
*/
|
|
4406
5931
|
vContent: int | string | sap.ui.core.Control
|
|
4407
5932
|
): sap.ui.core.Control;
|
|
4408
|
-
/**
|
|
4409
|
-
* Removes a footer from the aggregation {@link #getFooter footer}.
|
|
4410
|
-
*/
|
|
4411
|
-
removeFooter(
|
|
4412
|
-
/**
|
|
4413
|
-
* The footer to remove or its index or id
|
|
4414
|
-
*/
|
|
4415
|
-
vFooter: int | string | sap.ui.core.Control
|
|
4416
|
-
): sap.ui.core.Control;
|
|
4417
|
-
/**
|
|
4418
|
-
* Removes a header from the aggregation {@link #getHeader header}.
|
|
4419
|
-
*/
|
|
4420
|
-
removeHeader(
|
|
4421
|
-
/**
|
|
4422
|
-
* The header to remove or its index or id
|
|
4423
|
-
*/
|
|
4424
|
-
vHeader: int | string | sap.ui.core.Control
|
|
4425
|
-
): sap.ui.core.Control;
|
|
4426
5933
|
/**
|
|
4427
5934
|
* Sets a new value for property {@link #getBackgroundDesign backgroundDesign}.
|
|
4428
5935
|
*
|
|
@@ -4479,6 +5986,24 @@ declare namespace sap {
|
|
|
4479
5986
|
*/
|
|
4480
5987
|
bFloatingFooter?: boolean
|
|
4481
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;
|
|
4482
6007
|
/**
|
|
4483
6008
|
* Sets a new value for property {@link #getHeight height}.
|
|
4484
6009
|
*
|
|
@@ -4979,6 +6504,8 @@ declare namespace sap {
|
|
|
4979
6504
|
* allow developers to style elements inside the Shadow DOM.
|
|
4980
6505
|
* The `sap.ui.webc.fiori.ShellBar` exposes the following CSS Shadow Parts:
|
|
4981
6506
|
* - root - Used to style the outermost wrapper of the `sap.ui.webc.fiori.ShellBar`
|
|
6507
|
+
*
|
|
6508
|
+
* Keyboard Handling:
|
|
4982
6509
|
*/
|
|
4983
6510
|
class ShellBar extends sap.ui.webc.common.WebComponent {
|
|
4984
6511
|
/**
|
|
@@ -5143,7 +6670,7 @@ declare namespace sap {
|
|
|
5143
6670
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
5144
6671
|
* otherwise it will be bound to this `sap.ui.webc.fiori.ShellBar` itself.
|
|
5145
6672
|
*
|
|
5146
|
-
* 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
|
|
5147
6674
|
* `event.preventDefault()`.
|
|
5148
6675
|
*/
|
|
5149
6676
|
attachMenuItemClick(
|
|
@@ -5167,7 +6694,7 @@ declare namespace sap {
|
|
|
5167
6694
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
5168
6695
|
* otherwise it will be bound to this `sap.ui.webc.fiori.ShellBar` itself.
|
|
5169
6696
|
*
|
|
5170
|
-
* 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
|
|
5171
6698
|
* `event.preventDefault()`.
|
|
5172
6699
|
*/
|
|
5173
6700
|
attachMenuItemClick(
|
|
@@ -5230,7 +6757,7 @@ declare namespace sap {
|
|
|
5230
6757
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
5231
6758
|
* otherwise it will be bound to this `sap.ui.webc.fiori.ShellBar` itself.
|
|
5232
6759
|
*
|
|
5233
|
-
* 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
|
|
5234
6761
|
* by calling `event.preventDefault()`.
|
|
5235
6762
|
*/
|
|
5236
6763
|
attachProductSwitchClick(
|
|
@@ -5255,7 +6782,7 @@ declare namespace sap {
|
|
|
5255
6782
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
5256
6783
|
* otherwise it will be bound to this `sap.ui.webc.fiori.ShellBar` itself.
|
|
5257
6784
|
*
|
|
5258
|
-
* 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
|
|
5259
6786
|
* by calling `event.preventDefault()`.
|
|
5260
6787
|
*/
|
|
5261
6788
|
attachProductSwitchClick(
|
|
@@ -5521,6 +7048,17 @@ declare namespace sap {
|
|
|
5521
7048
|
targetRef?: HTMLElement;
|
|
5522
7049
|
}
|
|
5523
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;
|
|
5524
7062
|
/**
|
|
5525
7063
|
* Returns the `copilot` DOM ref.
|
|
5526
7064
|
*/
|
|
@@ -5725,6 +7263,24 @@ declare namespace sap {
|
|
|
5725
7263
|
*/
|
|
5726
7264
|
vMenuItem: int | string | sap.ui.webc.main.IListItem
|
|
5727
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;
|
|
5728
7284
|
/**
|
|
5729
7285
|
* Sets the aggregated {@link #getLogo logo}.
|
|
5730
7286
|
*/
|
|
@@ -6085,6 +7641,8 @@ declare namespace sap {
|
|
|
6085
7641
|
* components to build your menu. The items can consist of text only or an icon with text. The use or non-use
|
|
6086
7642
|
* of icons must be consistent for all items on one level. You must not combine entries with and without
|
|
6087
7643
|
* icons on the same level. We strongly recommend that you do not use icons on the second level.
|
|
7644
|
+
*
|
|
7645
|
+
* Keyboard Handling:
|
|
6088
7646
|
*/
|
|
6089
7647
|
class SideNavigation extends sap.ui.webc.common.WebComponent {
|
|
6090
7648
|
/**
|
|
@@ -9090,6 +10648,16 @@ declare namespace sap {
|
|
|
9090
10648
|
* **Note:** If no selected step is defined, the first step will be auto selected.
|
|
9091
10649
|
* **Note:** If multiple selected steps are defined, the last step will be selected.
|
|
9092
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
|
+
*
|
|
9093
10661
|
* Content: The content occupies the main part of the page. It can hold any type of HTML elements. It's
|
|
9094
10662
|
* defined by using the `sap.ui.webc.fiori.WizardStep` as slotted element within the `sap.ui.webc.fiori.Wizard`.
|
|
9095
10663
|
*
|
|
@@ -9794,41 +11362,201 @@ declare namespace sap {
|
|
|
9794
11362
|
*/
|
|
9795
11363
|
enum IllustrationMessageType {
|
|
9796
11364
|
/**
|
|
9797
|
-
* "
|
|
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.
|
|
9798
11378
|
*/
|
|
9799
11379
|
BeforeSearch = "BeforeSearch",
|
|
9800
11380
|
/**
|
|
9801
|
-
* "
|
|
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.
|
|
9802
11410
|
*/
|
|
9803
11411
|
NoActivities = "NoActivities",
|
|
9804
11412
|
/**
|
|
9805
|
-
* "
|
|
11413
|
+
* "No Data" illustration type.
|
|
9806
11414
|
*/
|
|
9807
11415
|
NoData = "NoData",
|
|
9808
11416
|
/**
|
|
9809
|
-
* "
|
|
11417
|
+
* "No Entries" illustration type.
|
|
9810
11418
|
*/
|
|
9811
11419
|
NoEntries = "NoEntries",
|
|
9812
11420
|
/**
|
|
9813
|
-
* "
|
|
11421
|
+
* "No Filter Results" illustration type.
|
|
11422
|
+
*/
|
|
11423
|
+
NoFilterResults = "NoFilterResults",
|
|
11424
|
+
/**
|
|
11425
|
+
* "No Email" illustration type.
|
|
9814
11426
|
*/
|
|
9815
11427
|
NoMail = "NoMail",
|
|
9816
11428
|
/**
|
|
9817
|
-
* "
|
|
11429
|
+
* "No Email v1" illustration type.
|
|
11430
|
+
*/
|
|
11431
|
+
NoMail_v1 = "NoMail_v1",
|
|
11432
|
+
/**
|
|
11433
|
+
* "No Notifications" illustration type.
|
|
9818
11434
|
*/
|
|
9819
11435
|
NoNotifications = "NoNotifications",
|
|
9820
11436
|
/**
|
|
9821
|
-
* "
|
|
11437
|
+
* "No Saved Items" illustration type.
|
|
9822
11438
|
*/
|
|
9823
11439
|
NoSavedItems = "NoSavedItems",
|
|
9824
11440
|
/**
|
|
9825
|
-
* "
|
|
11441
|
+
* "No Saved Items v1" illustration type.
|
|
11442
|
+
*/
|
|
11443
|
+
NoSavedItems_v1 = "NoSavedItems_v1",
|
|
11444
|
+
/**
|
|
11445
|
+
* "No Search Results" illustration type.
|
|
9826
11446
|
*/
|
|
9827
11447
|
NoSearchResults = "NoSearchResults",
|
|
9828
11448
|
/**
|
|
9829
|
-
* "
|
|
11449
|
+
* "No Tasks" illustration type.
|
|
9830
11450
|
*/
|
|
9831
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",
|
|
9832
11560
|
/**
|
|
9833
11561
|
* "TntCodePlaceholder" illustration type.
|
|
9834
11562
|
*/
|
|
@@ -9902,13 +11630,93 @@ declare namespace sap {
|
|
|
9902
11630
|
*/
|
|
9903
11631
|
TntUnsuccessfulAuth = "TntUnsuccessfulAuth",
|
|
9904
11632
|
/**
|
|
9905
|
-
* "
|
|
11633
|
+
* "Unable To Load" illustration type.
|
|
9906
11634
|
*/
|
|
9907
11635
|
UnableToLoad = "UnableToLoad",
|
|
9908
11636
|
/**
|
|
9909
|
-
* "
|
|
11637
|
+
* "Unable To Load Image" illustration type.
|
|
11638
|
+
*/
|
|
11639
|
+
UnableToLoadImage = "UnableToLoadImage",
|
|
11640
|
+
/**
|
|
11641
|
+
* "Unable To Upload" illustration type.
|
|
9910
11642
|
*/
|
|
9911
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",
|
|
9912
11720
|
}
|
|
9913
11721
|
/**
|
|
9914
11722
|
* @SINCE 1.92.0
|
|
@@ -9930,6 +11738,76 @@ declare namespace sap {
|
|
|
9930
11738
|
*/
|
|
9931
11739
|
Transparent = "Transparent",
|
|
9932
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
|
+
}
|
|
9933
11811
|
/**
|
|
9934
11812
|
* @SINCE 1.92.0
|
|
9935
11813
|
* @EXPERIMENTAL (since 1.92.0)
|
|
@@ -9979,6 +11857,8 @@ declare namespace sap {
|
|
|
9979
11857
|
|
|
9980
11858
|
"sap/ui/webc/fiori/BarcodeScannerDialog": undefined;
|
|
9981
11859
|
|
|
11860
|
+
"sap/ui/webc/fiori/DynamicSideContent": undefined;
|
|
11861
|
+
|
|
9982
11862
|
"sap/ui/webc/fiori/FilterItem": undefined;
|
|
9983
11863
|
|
|
9984
11864
|
"sap/ui/webc/fiori/FilterItemOption": undefined;
|
|
@@ -9989,6 +11869,10 @@ declare namespace sap {
|
|
|
9989
11869
|
|
|
9990
11870
|
"sap/ui/webc/fiori/library": undefined;
|
|
9991
11871
|
|
|
11872
|
+
"sap/ui/webc/fiori/MediaGallery": undefined;
|
|
11873
|
+
|
|
11874
|
+
"sap/ui/webc/fiori/MediaGalleryItem": undefined;
|
|
11875
|
+
|
|
9992
11876
|
"sap/ui/webc/fiori/NotificationAction": undefined;
|
|
9993
11877
|
|
|
9994
11878
|
"sap/ui/webc/fiori/NotificationListGroupItem": undefined;
|