@openui5/ts-types 1.98.0 → 1.101.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 +391 -88
- package/types/sap.m.d.ts +1678 -173
- 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 +1479 -758
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.fl.d.ts +11 -5
- package/types/sap.ui.integration.d.ts +29 -11
- package/types/sap.ui.layout.d.ts +4 -1
- package/types/sap.ui.mdc.d.ts +21 -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 +10 -12
- package/types/sap.ui.table.d.ts +12 -42
- 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 +7 -1
- package/types/sap.ui.webc.fiori.d.ts +2659 -755
- package/types/sap.ui.webc.main.d.ts +3303 -1032
- package/types/sap.uxap.d.ts +2 -2
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.
|
|
1
|
+
// For Library Version: 1.101.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)
|
|
@@ -155,17 +175,17 @@ declare namespace sap {
|
|
|
155
175
|
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
156
176
|
|
|
157
177
|
/**
|
|
158
|
-
* Defines the content
|
|
178
|
+
* Defines the content at the end of the bar
|
|
159
179
|
*/
|
|
160
|
-
|
|
180
|
+
endContent?:
|
|
161
181
|
| sap.ui.core.Control[]
|
|
162
182
|
| sap.ui.core.Control
|
|
163
183
|
| sap.ui.base.ManagedObject.AggregationBindingInfo;
|
|
164
184
|
|
|
165
185
|
/**
|
|
166
|
-
* Defines the content
|
|
186
|
+
* Defines the content in the middle of the bar
|
|
167
187
|
*/
|
|
168
|
-
|
|
188
|
+
middleContent?:
|
|
169
189
|
| sap.ui.core.Control[]
|
|
170
190
|
| sap.ui.core.Control
|
|
171
191
|
| sap.ui.base.ManagedObject.AggregationBindingInfo;
|
|
@@ -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,126 @@ 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 control is enabled. A disabled control can't be interacted with, and it is not in
|
|
566
|
+
* the tab chain.
|
|
567
|
+
*/
|
|
568
|
+
enabled?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
569
|
+
|
|
570
|
+
/**
|
|
571
|
+
* Determines the layout of the item container.
|
|
572
|
+
*
|
|
573
|
+
* Available options are:
|
|
574
|
+
* - `Square`
|
|
575
|
+
* - `Wide`
|
|
576
|
+
*/
|
|
577
|
+
layout?:
|
|
578
|
+
| sap.ui.webc.fiori.MediaGalleryItemLayout
|
|
579
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
580
|
+
|
|
581
|
+
/**
|
|
582
|
+
* Defines the selected state of the component.
|
|
583
|
+
*/
|
|
584
|
+
selected?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
585
|
+
|
|
586
|
+
/**
|
|
587
|
+
* Defines the content of the component.
|
|
588
|
+
*/
|
|
589
|
+
content?: sap.ui.core.Control;
|
|
590
|
+
|
|
591
|
+
/**
|
|
592
|
+
* Defines the content of the thumbnail.
|
|
593
|
+
*/
|
|
594
|
+
thumbnail?: sap.ui.core.Control;
|
|
595
|
+
}
|
|
596
|
+
|
|
346
597
|
interface $NotificationActionSettings
|
|
347
598
|
extends sap.ui.webc.common.$WebComponentSettings {
|
|
348
599
|
/**
|
|
@@ -362,11 +613,10 @@ declare namespace sap {
|
|
|
362
613
|
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
363
614
|
|
|
364
615
|
/**
|
|
365
|
-
* Defines
|
|
366
|
-
*
|
|
367
|
-
* **Note:** a disabled action can't be pressed or focused, and it is not in the tab chain.
|
|
616
|
+
* Defines whether the control is enabled. A disabled control can't be interacted with, and it is not in
|
|
617
|
+
* the tab chain.
|
|
368
618
|
*/
|
|
369
|
-
|
|
619
|
+
enabled?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
370
620
|
|
|
371
621
|
/**
|
|
372
622
|
* Defines the `icon` source URI.
|
|
@@ -618,18 +868,12 @@ declare namespace sap {
|
|
|
618
868
|
/**
|
|
619
869
|
* Defines the footer HTML Element.
|
|
620
870
|
*/
|
|
621
|
-
footer?:
|
|
622
|
-
| sap.ui.core.Control[]
|
|
623
|
-
| sap.ui.core.Control
|
|
624
|
-
| sap.ui.base.ManagedObject.AggregationBindingInfo;
|
|
871
|
+
footer?: sap.ui.webc.fiori.IBar;
|
|
625
872
|
|
|
626
873
|
/**
|
|
627
874
|
* Defines the header HTML Element.
|
|
628
875
|
*/
|
|
629
|
-
header?:
|
|
630
|
-
| sap.ui.core.Control[]
|
|
631
|
-
| sap.ui.core.Control
|
|
632
|
-
| sap.ui.base.ManagedObject.AggregationBindingInfo;
|
|
876
|
+
header?: sap.ui.webc.fiori.IBar;
|
|
633
877
|
}
|
|
634
878
|
|
|
635
879
|
interface $ProductSwitchSettings
|
|
@@ -694,6 +938,16 @@ declare namespace sap {
|
|
|
694
938
|
|
|
695
939
|
interface $ShellBarSettings
|
|
696
940
|
extends sap.ui.webc.common.$WebComponentSettings {
|
|
941
|
+
/**
|
|
942
|
+
* An object of strings that defines several additional accessibility texts for even further customization.
|
|
943
|
+
*
|
|
944
|
+
* It supports the following fields: - `profileButtonTitle`: defines the tooltip for the profile button
|
|
945
|
+
* - `logoTitle`: defines the tooltip for the logo
|
|
946
|
+
*/
|
|
947
|
+
accessibilityTexts?:
|
|
948
|
+
| object
|
|
949
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
950
|
+
|
|
697
951
|
/**
|
|
698
952
|
* Defines the `notificationsCount`, displayed in the notification icon top-right corner.
|
|
699
953
|
*/
|
|
@@ -795,7 +1049,7 @@ declare namespace sap {
|
|
|
795
1049
|
logoClick?: (oEvent: sap.ui.base.Event) => void;
|
|
796
1050
|
|
|
797
1051
|
/**
|
|
798
|
-
* Fired, when a menu item is activated **Note:** You can prevent closing of
|
|
1052
|
+
* Fired, when a menu item is activated **Note:** You can prevent closing of overflow popover by calling
|
|
799
1053
|
* `event.preventDefault()`.
|
|
800
1054
|
*/
|
|
801
1055
|
menuItemClick?: (oEvent: sap.ui.base.Event) => void;
|
|
@@ -806,7 +1060,7 @@ declare namespace sap {
|
|
|
806
1060
|
notificationsClick?: (oEvent: sap.ui.base.Event) => void;
|
|
807
1061
|
|
|
808
1062
|
/**
|
|
809
|
-
* Fired, when the product switch icon is activated. **Note:** You can prevent closing of
|
|
1063
|
+
* Fired, when the product switch icon is activated. **Note:** You can prevent closing of overflow popover
|
|
810
1064
|
* by calling `event.preventDefault()`.
|
|
811
1065
|
*/
|
|
812
1066
|
productSwitchClick?: (oEvent: sap.ui.base.Event) => void;
|
|
@@ -972,6 +1226,13 @@ declare namespace sap {
|
|
|
972
1226
|
|
|
973
1227
|
interface $TimelineSettings
|
|
974
1228
|
extends sap.ui.webc.common.$WebComponentSettings {
|
|
1229
|
+
/**
|
|
1230
|
+
* Defines the accessible aria name of the component.
|
|
1231
|
+
*/
|
|
1232
|
+
accessibleName?:
|
|
1233
|
+
| string
|
|
1234
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
1235
|
+
|
|
975
1236
|
/**
|
|
976
1237
|
* Defines the height of the control
|
|
977
1238
|
*/
|
|
@@ -1061,7 +1322,7 @@ declare namespace sap {
|
|
|
1061
1322
|
interface $UploadCollectionSettings
|
|
1062
1323
|
extends sap.ui.webc.common.$WebComponentSettings {
|
|
1063
1324
|
/**
|
|
1064
|
-
*
|
|
1325
|
+
* Defines the accessible aria name of the component.
|
|
1065
1326
|
*/
|
|
1066
1327
|
accessibleName?:
|
|
1067
1328
|
| string
|
|
@@ -1332,15 +1593,10 @@ declare namespace sap {
|
|
|
1332
1593
|
branching?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
1333
1594
|
|
|
1334
1595
|
/**
|
|
1335
|
-
* Defines
|
|
1336
|
-
*
|
|
1337
|
-
*
|
|
1338
|
-
*
|
|
1339
|
-
*
|
|
1340
|
-
* **Note:** Step can't be `selected` and `disabled` at the same time. In this case the `selected` property
|
|
1341
|
-
* would take precedence.
|
|
1596
|
+
* Defines whether the control is enabled. A disabled control can't be interacted with, and it is not in
|
|
1597
|
+
* the tab chain.
|
|
1342
1598
|
*/
|
|
1343
|
-
|
|
1599
|
+
enabled?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
1344
1600
|
|
|
1345
1601
|
/**
|
|
1346
1602
|
* Defines the `icon` of the step.
|
|
@@ -1415,8 +1671,13 @@ declare namespace sap {
|
|
|
1415
1671
|
* allow developers to style elements inside the Shadow DOM.
|
|
1416
1672
|
* The `sap.ui.webc.fiori.Bar` exposes the following CSS Shadow Parts:
|
|
1417
1673
|
* - bar - Used to style the wrapper of the content of the component
|
|
1674
|
+
*
|
|
1675
|
+
* Keyboard Handling:
|
|
1418
1676
|
*/
|
|
1419
|
-
class Bar
|
|
1677
|
+
class Bar
|
|
1678
|
+
extends sap.ui.webc.common.WebComponent
|
|
1679
|
+
implements sap.ui.webc.fiori.IBar {
|
|
1680
|
+
__implements__sap_ui_webc_fiori_IBar: boolean;
|
|
1420
1681
|
/**
|
|
1421
1682
|
* Constructor for a new `Bar`.
|
|
1422
1683
|
*
|
|
@@ -1474,22 +1735,22 @@ declare namespace sap {
|
|
|
1474
1735
|
*/
|
|
1475
1736
|
static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
|
|
1476
1737
|
/**
|
|
1477
|
-
* Adds some
|
|
1738
|
+
* Adds some endContent to the aggregation {@link #getEndContent endContent}.
|
|
1478
1739
|
*/
|
|
1479
|
-
|
|
1740
|
+
addEndContent(
|
|
1480
1741
|
/**
|
|
1481
|
-
* The
|
|
1742
|
+
* The endContent to add; if empty, nothing is inserted
|
|
1482
1743
|
*/
|
|
1483
|
-
|
|
1744
|
+
oEndContent: sap.ui.core.Control
|
|
1484
1745
|
): this;
|
|
1485
1746
|
/**
|
|
1486
|
-
* Adds some
|
|
1747
|
+
* Adds some middleContent to the aggregation {@link #getMiddleContent middleContent}.
|
|
1487
1748
|
*/
|
|
1488
|
-
|
|
1749
|
+
addMiddleContent(
|
|
1489
1750
|
/**
|
|
1490
|
-
* The
|
|
1751
|
+
* The middleContent to add; if empty, nothing is inserted
|
|
1491
1752
|
*/
|
|
1492
|
-
|
|
1753
|
+
oMiddleContent: sap.ui.core.Control
|
|
1493
1754
|
): this;
|
|
1494
1755
|
/**
|
|
1495
1756
|
* Adds some startContent to the aggregation {@link #getStartContent startContent}.
|
|
@@ -1500,24 +1761,18 @@ declare namespace sap {
|
|
|
1500
1761
|
*/
|
|
1501
1762
|
oStartContent: sap.ui.core.Control
|
|
1502
1763
|
): this;
|
|
1503
|
-
/**
|
|
1504
|
-
* Destroys all the content in the aggregation {@link #getContent content}.
|
|
1505
|
-
*/
|
|
1506
|
-
destroyContent(): this;
|
|
1507
1764
|
/**
|
|
1508
1765
|
* Destroys all the endContent in the aggregation {@link #getEndContent endContent}.
|
|
1509
1766
|
*/
|
|
1510
1767
|
destroyEndContent(): this;
|
|
1511
1768
|
/**
|
|
1512
|
-
* Destroys all the
|
|
1769
|
+
* Destroys all the middleContent in the aggregation {@link #getMiddleContent middleContent}.
|
|
1513
1770
|
*/
|
|
1514
|
-
|
|
1771
|
+
destroyMiddleContent(): this;
|
|
1515
1772
|
/**
|
|
1516
|
-
*
|
|
1517
|
-
*
|
|
1518
|
-
* Defines the content in the middle of the bar
|
|
1773
|
+
* Destroys all the startContent in the aggregation {@link #getStartContent startContent}.
|
|
1519
1774
|
*/
|
|
1520
|
-
|
|
1775
|
+
destroyStartContent(): this;
|
|
1521
1776
|
/**
|
|
1522
1777
|
* Gets current value of property {@link #getDesign design}.
|
|
1523
1778
|
*
|
|
@@ -1540,6 +1795,12 @@ declare namespace sap {
|
|
|
1540
1795
|
* Defines the content at the end of the bar
|
|
1541
1796
|
*/
|
|
1542
1797
|
getEndContent(): sap.ui.core.Control[];
|
|
1798
|
+
/**
|
|
1799
|
+
* Gets content of aggregation {@link #getMiddleContent middleContent}.
|
|
1800
|
+
*
|
|
1801
|
+
* Defines the content in the middle of the bar
|
|
1802
|
+
*/
|
|
1803
|
+
getMiddleContent(): sap.ui.core.Control[];
|
|
1543
1804
|
/**
|
|
1544
1805
|
* Gets content of aggregation {@link #getStartContent startContent}.
|
|
1545
1806
|
*
|
|
@@ -1552,16 +1813,6 @@ declare namespace sap {
|
|
|
1552
1813
|
* Defines the width of the control
|
|
1553
1814
|
*/
|
|
1554
1815
|
getWidth(): sap.ui.core.CSSSize;
|
|
1555
|
-
/**
|
|
1556
|
-
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getContent content}. and returns
|
|
1557
|
-
* its index if found or -1 otherwise.
|
|
1558
|
-
*/
|
|
1559
|
-
indexOfContent(
|
|
1560
|
-
/**
|
|
1561
|
-
* The content whose index is looked for
|
|
1562
|
-
*/
|
|
1563
|
-
oContent: sap.ui.core.Control
|
|
1564
|
-
): int;
|
|
1565
1816
|
/**
|
|
1566
1817
|
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getEndContent endContent}. and
|
|
1567
1818
|
* returns its index if found or -1 otherwise.
|
|
@@ -1572,6 +1823,16 @@ declare namespace sap {
|
|
|
1572
1823
|
*/
|
|
1573
1824
|
oEndContent: sap.ui.core.Control
|
|
1574
1825
|
): int;
|
|
1826
|
+
/**
|
|
1827
|
+
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getMiddleContent middleContent}.
|
|
1828
|
+
* and returns its index if found or -1 otherwise.
|
|
1829
|
+
*/
|
|
1830
|
+
indexOfMiddleContent(
|
|
1831
|
+
/**
|
|
1832
|
+
* The middleContent whose index is looked for
|
|
1833
|
+
*/
|
|
1834
|
+
oMiddleContent: sap.ui.core.Control
|
|
1835
|
+
): int;
|
|
1575
1836
|
/**
|
|
1576
1837
|
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getStartContent startContent}.
|
|
1577
1838
|
* and returns its index if found or -1 otherwise.
|
|
@@ -1583,31 +1844,31 @@ declare namespace sap {
|
|
|
1583
1844
|
oStartContent: sap.ui.core.Control
|
|
1584
1845
|
): int;
|
|
1585
1846
|
/**
|
|
1586
|
-
* Inserts a
|
|
1847
|
+
* Inserts a endContent into the aggregation {@link #getEndContent endContent}.
|
|
1587
1848
|
*/
|
|
1588
|
-
|
|
1849
|
+
insertEndContent(
|
|
1589
1850
|
/**
|
|
1590
|
-
* The
|
|
1851
|
+
* The endContent to insert; if empty, nothing is inserted
|
|
1591
1852
|
*/
|
|
1592
|
-
|
|
1853
|
+
oEndContent: sap.ui.core.Control,
|
|
1593
1854
|
/**
|
|
1594
|
-
* The `0`-based index the
|
|
1595
|
-
* is inserted at position 0; for a value greater than the current size of the aggregation, the
|
|
1855
|
+
* The `0`-based index the endContent should be inserted at; for a negative value of `iIndex`, the endContent
|
|
1856
|
+
* is inserted at position 0; for a value greater than the current size of the aggregation, the endContent
|
|
1596
1857
|
* is inserted at the last position
|
|
1597
1858
|
*/
|
|
1598
1859
|
iIndex: int
|
|
1599
1860
|
): this;
|
|
1600
1861
|
/**
|
|
1601
|
-
* Inserts a
|
|
1862
|
+
* Inserts a middleContent into the aggregation {@link #getMiddleContent middleContent}.
|
|
1602
1863
|
*/
|
|
1603
|
-
|
|
1864
|
+
insertMiddleContent(
|
|
1604
1865
|
/**
|
|
1605
|
-
* The
|
|
1866
|
+
* The middleContent to insert; if empty, nothing is inserted
|
|
1606
1867
|
*/
|
|
1607
|
-
|
|
1868
|
+
oMiddleContent: sap.ui.core.Control,
|
|
1608
1869
|
/**
|
|
1609
|
-
* The `0`-based index the
|
|
1610
|
-
* is inserted at position 0; for a value greater than the current size of the aggregation, the
|
|
1870
|
+
* The `0`-based index the middleContent should be inserted at; for a negative value of `iIndex`, the middleContent
|
|
1871
|
+
* is inserted at position 0; for a value greater than the current size of the aggregation, the middleContent
|
|
1611
1872
|
* is inserted at the last position
|
|
1612
1873
|
*/
|
|
1613
1874
|
iIndex: int
|
|
@@ -1628,17 +1889,17 @@ declare namespace sap {
|
|
|
1628
1889
|
iIndex: int
|
|
1629
1890
|
): this;
|
|
1630
1891
|
/**
|
|
1631
|
-
* Removes all the controls from the aggregation {@link #
|
|
1892
|
+
* Removes all the controls from the aggregation {@link #getEndContent endContent}.
|
|
1632
1893
|
*
|
|
1633
1894
|
* Additionally, it unregisters them from the hosting UIArea.
|
|
1634
1895
|
*/
|
|
1635
|
-
|
|
1896
|
+
removeAllEndContent(): sap.ui.core.Control[];
|
|
1636
1897
|
/**
|
|
1637
|
-
* Removes all the controls from the aggregation {@link #
|
|
1898
|
+
* Removes all the controls from the aggregation {@link #getMiddleContent middleContent}.
|
|
1638
1899
|
*
|
|
1639
1900
|
* Additionally, it unregisters them from the hosting UIArea.
|
|
1640
1901
|
*/
|
|
1641
|
-
|
|
1902
|
+
removeAllMiddleContent(): sap.ui.core.Control[];
|
|
1642
1903
|
/**
|
|
1643
1904
|
* Removes all the controls from the aggregation {@link #getStartContent startContent}.
|
|
1644
1905
|
*
|
|
@@ -1646,22 +1907,22 @@ declare namespace sap {
|
|
|
1646
1907
|
*/
|
|
1647
1908
|
removeAllStartContent(): sap.ui.core.Control[];
|
|
1648
1909
|
/**
|
|
1649
|
-
* Removes a
|
|
1910
|
+
* Removes a endContent from the aggregation {@link #getEndContent endContent}.
|
|
1650
1911
|
*/
|
|
1651
|
-
|
|
1912
|
+
removeEndContent(
|
|
1652
1913
|
/**
|
|
1653
|
-
* The
|
|
1914
|
+
* The endContent to remove or its index or id
|
|
1654
1915
|
*/
|
|
1655
|
-
|
|
1916
|
+
vEndContent: int | string | sap.ui.core.Control
|
|
1656
1917
|
): sap.ui.core.Control;
|
|
1657
1918
|
/**
|
|
1658
|
-
* Removes a
|
|
1919
|
+
* Removes a middleContent from the aggregation {@link #getMiddleContent middleContent}.
|
|
1659
1920
|
*/
|
|
1660
|
-
|
|
1921
|
+
removeMiddleContent(
|
|
1661
1922
|
/**
|
|
1662
|
-
* The
|
|
1923
|
+
* The middleContent to remove or its index or id
|
|
1663
1924
|
*/
|
|
1664
|
-
|
|
1925
|
+
vMiddleContent: int | string | sap.ui.core.Control
|
|
1665
1926
|
): sap.ui.core.Control;
|
|
1666
1927
|
/**
|
|
1667
1928
|
* Removes a startContent from the aggregation {@link #getStartContent startContent}.
|
|
@@ -1706,7 +1967,7 @@ declare namespace sap {
|
|
|
1706
1967
|
/**
|
|
1707
1968
|
* New value for property `width`
|
|
1708
1969
|
*/
|
|
1709
|
-
sWidth
|
|
1970
|
+
sWidth: sap.ui.core.CSSSize
|
|
1710
1971
|
): this;
|
|
1711
1972
|
}
|
|
1712
1973
|
/**
|
|
@@ -1945,19 +2206,68 @@ declare namespace sap {
|
|
|
1945
2206
|
show(): void;
|
|
1946
2207
|
}
|
|
1947
2208
|
/**
|
|
1948
|
-
* @SINCE 1.
|
|
1949
|
-
* @EXPERIMENTAL (since 1.
|
|
2209
|
+
* @SINCE 1.99.0
|
|
2210
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
1950
2211
|
*
|
|
1951
2212
|
* Overview:
|
|
1952
2213
|
*
|
|
2214
|
+
* The DynamicSideContent (`sap.ui.webc.fiori.DynamicSideContent`) is a layout component that allows additional
|
|
2215
|
+
* content to be displayed in a way that flexibly adapts to different screen sizes. The side content appears
|
|
2216
|
+
* in a container next to or directly below the main content (it doesn't overlay). When the side content
|
|
2217
|
+
* is triggered, the main content becomes narrower (if appearing side-by-side). The side content contains
|
|
2218
|
+
* a separate scrollbar when appearing next to the main content.
|
|
2219
|
+
*
|
|
1953
2220
|
* Usage:
|
|
2221
|
+
*
|
|
2222
|
+
* When to use?
|
|
2223
|
+
*
|
|
2224
|
+
* Use this component if you want to display relevant information that is not critical for users to complete
|
|
2225
|
+
* a task. Users should have access to all the key functions and critical information in the app even if
|
|
2226
|
+
* they do not see the side content. This is important because on smaller screen sizes it may be difficult
|
|
2227
|
+
* to display the side content in a way that is easily accessible for the user.
|
|
2228
|
+
*
|
|
2229
|
+
* When not to use?
|
|
2230
|
+
*
|
|
2231
|
+
* Don't use it if you want to display navigation or critical information that prevents users from completing
|
|
2232
|
+
* a task when they have no access to the side content.
|
|
2233
|
+
*
|
|
2234
|
+
* Responsive Behavior:
|
|
2235
|
+
*
|
|
2236
|
+
* Screen width > 1440px
|
|
2237
|
+
*
|
|
2238
|
+
*
|
|
2239
|
+
* - Main vs. side content ratio is 75 vs. 25 percent (with a minimum of 320px each).
|
|
2240
|
+
* - If the application defines a trigger, the side content can be hidden.
|
|
2241
|
+
*
|
|
2242
|
+
* Screen width <= 1440px and> 1024px
|
|
2243
|
+
*
|
|
2244
|
+
*
|
|
2245
|
+
* - Main vs. side content ratio is 66.666 vs. 33.333 percent (with a minimum of 320px each). If the side
|
|
2246
|
+
* content width falls below 320 px, it automatically slides under the main content, unless the app development
|
|
2247
|
+
* team specifies that it should disappear.
|
|
2248
|
+
*
|
|
2249
|
+
* Screen width <= 1024px and> 720px
|
|
2250
|
+
*
|
|
2251
|
+
*
|
|
2252
|
+
* - The side content ratio is fixed to 340px, and the main content takes the rest of the width. Only
|
|
2253
|
+
* if the `sideContentFallDown` is set to `OnMinimumWidth` and screen width is <= 960px and> 720px the side
|
|
2254
|
+
* content falls below the main content.
|
|
2255
|
+
*
|
|
2256
|
+
* Screen width <= 720px (for example on a mobile device)
|
|
2257
|
+
* - In this case, the side content automatically disappears from the screen (unless specified to stay
|
|
2258
|
+
* under the content by setting of `sideContentVisibility` property to `AlwaysShow`) and can be triggered
|
|
2259
|
+
* from a pre-set trigger (specified within the app). When the side content is triggered, it replaces the
|
|
2260
|
+
* main content. We recommend that you always place the trigger for the side content in the same location,
|
|
2261
|
+
* such as in the app footer.
|
|
2262
|
+
*
|
|
2263
|
+
* A special case allows switching the comparison mode between the main and side content. In this case,
|
|
2264
|
+
* the screen is split into 50:50 percent for main vs. side content. The responsive behavior of the equal
|
|
2265
|
+
* split is the same as in the standard view - the side content disappears on screen widths of less than
|
|
2266
|
+
* 720 px and can only be viewed by triggering it.
|
|
1954
2267
|
*/
|
|
1955
|
-
class
|
|
1956
|
-
extends sap.ui.webc.common.WebComponent
|
|
1957
|
-
implements sap.ui.webc.fiori.IFilterItem {
|
|
1958
|
-
__implements__sap_ui_webc_fiori_IFilterItem: boolean;
|
|
2268
|
+
class DynamicSideContent extends sap.ui.webc.common.WebComponent {
|
|
1959
2269
|
/**
|
|
1960
|
-
* Constructor for a new `
|
|
2270
|
+
* Constructor for a new `DynamicSideContent`.
|
|
1961
2271
|
*
|
|
1962
2272
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1963
2273
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
@@ -1967,10 +2277,10 @@ declare namespace sap {
|
|
|
1967
2277
|
/**
|
|
1968
2278
|
* Initial settings for the new control
|
|
1969
2279
|
*/
|
|
1970
|
-
mSettings?: sap.ui.webc.fiori.$
|
|
2280
|
+
mSettings?: sap.ui.webc.fiori.$DynamicSideContentSettings
|
|
1971
2281
|
);
|
|
1972
2282
|
/**
|
|
1973
|
-
* Constructor for a new `
|
|
2283
|
+
* Constructor for a new `DynamicSideContent`.
|
|
1974
2284
|
*
|
|
1975
2285
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1976
2286
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
@@ -1984,12 +2294,12 @@ declare namespace sap {
|
|
|
1984
2294
|
/**
|
|
1985
2295
|
* Initial settings for the new control
|
|
1986
2296
|
*/
|
|
1987
|
-
mSettings?: sap.ui.webc.fiori.$
|
|
2297
|
+
mSettings?: sap.ui.webc.fiori.$DynamicSideContentSettings
|
|
1988
2298
|
);
|
|
1989
2299
|
|
|
1990
2300
|
/**
|
|
1991
|
-
* Creates a new subclass of class sap.ui.webc.fiori.
|
|
1992
|
-
* the information contained in `oClassInfo`.
|
|
2301
|
+
* Creates a new subclass of class sap.ui.webc.fiori.DynamicSideContent with name `sClassName` and enriches
|
|
2302
|
+
* it with the information contained in `oClassInfo`.
|
|
1993
2303
|
*
|
|
1994
2304
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
|
|
1995
2305
|
*/
|
|
@@ -2001,7 +2311,7 @@ declare namespace sap {
|
|
|
2001
2311
|
/**
|
|
2002
2312
|
* Object literal with information about the class
|
|
2003
2313
|
*/
|
|
2004
|
-
oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.
|
|
2314
|
+
oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.DynamicSideContent>,
|
|
2005
2315
|
/**
|
|
2006
2316
|
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
2007
2317
|
* used by this class
|
|
@@ -2009,240 +2319,1415 @@ declare namespace sap {
|
|
|
2009
2319
|
FNMetaImpl?: Function
|
|
2010
2320
|
): Function;
|
|
2011
2321
|
/**
|
|
2012
|
-
* Returns a metadata object for class sap.ui.webc.fiori.
|
|
2322
|
+
* Returns a metadata object for class sap.ui.webc.fiori.DynamicSideContent.
|
|
2013
2323
|
*/
|
|
2014
2324
|
static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
|
|
2015
2325
|
/**
|
|
2016
|
-
* Adds some
|
|
2326
|
+
* Adds some content to the aggregation {@link #getContent content}.
|
|
2017
2327
|
*/
|
|
2018
|
-
|
|
2328
|
+
addContent(
|
|
2019
2329
|
/**
|
|
2020
|
-
* The
|
|
2330
|
+
* The content to add; if empty, nothing is inserted
|
|
2021
2331
|
*/
|
|
2022
|
-
|
|
2332
|
+
oContent: sap.ui.core.Control
|
|
2023
2333
|
): this;
|
|
2024
2334
|
/**
|
|
2025
|
-
*
|
|
2335
|
+
* Adds some sideContent to the aggregation {@link #getSideContent sideContent}.
|
|
2026
2336
|
*/
|
|
2027
|
-
|
|
2337
|
+
addSideContent(
|
|
2338
|
+
/**
|
|
2339
|
+
* The sideContent to add; if empty, nothing is inserted
|
|
2340
|
+
*/
|
|
2341
|
+
oSideContent: sap.ui.core.Control
|
|
2342
|
+
): this;
|
|
2028
2343
|
/**
|
|
2029
|
-
*
|
|
2030
|
-
*
|
|
2031
|
-
* Defines the text of the component.
|
|
2344
|
+
* Attaches event handler `fnFunction` to the {@link #event:layoutChange layoutChange} event of this `sap.ui.webc.fiori.DynamicSideContent`.
|
|
2032
2345
|
*
|
|
2033
|
-
*
|
|
2034
|
-
|
|
2035
|
-
getText(): string;
|
|
2036
|
-
/**
|
|
2037
|
-
* Gets content of aggregation {@link #getValues values}.
|
|
2346
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
2347
|
+
* otherwise it will be bound to this `sap.ui.webc.fiori.DynamicSideContent` itself.
|
|
2038
2348
|
*
|
|
2039
|
-
*
|
|
2040
|
-
*/
|
|
2041
|
-
getValues(): sap.ui.webc.fiori.IFilterItemOption[];
|
|
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.
|
|
2349
|
+
* Fires when the current breakpoint has been changed.
|
|
2045
2350
|
*/
|
|
2046
|
-
|
|
2351
|
+
attachLayoutChange(
|
|
2047
2352
|
/**
|
|
2048
|
-
*
|
|
2353
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
2354
|
+
* object when firing the event
|
|
2049
2355
|
*/
|
|
2050
|
-
|
|
2051
|
-
|
|
2356
|
+
oData: object,
|
|
2357
|
+
/**
|
|
2358
|
+
* The function to be called when the event occurs
|
|
2359
|
+
*/
|
|
2360
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
2361
|
+
/**
|
|
2362
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.DynamicSideContent`
|
|
2363
|
+
* itself
|
|
2364
|
+
*/
|
|
2365
|
+
oListener?: object
|
|
2366
|
+
): this;
|
|
2052
2367
|
/**
|
|
2053
|
-
*
|
|
2368
|
+
* Attaches event handler `fnFunction` to the {@link #event:layoutChange layoutChange} event of this `sap.ui.webc.fiori.DynamicSideContent`.
|
|
2369
|
+
*
|
|
2370
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
2371
|
+
* otherwise it will be bound to this `sap.ui.webc.fiori.DynamicSideContent` itself.
|
|
2372
|
+
*
|
|
2373
|
+
* Fires when the current breakpoint has been changed.
|
|
2054
2374
|
*/
|
|
2055
|
-
|
|
2375
|
+
attachLayoutChange(
|
|
2056
2376
|
/**
|
|
2057
|
-
* The
|
|
2377
|
+
* The function to be called when the event occurs
|
|
2058
2378
|
*/
|
|
2059
|
-
|
|
2379
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
2060
2380
|
/**
|
|
2061
|
-
*
|
|
2062
|
-
*
|
|
2063
|
-
* the last position
|
|
2381
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.DynamicSideContent`
|
|
2382
|
+
* itself
|
|
2064
2383
|
*/
|
|
2065
|
-
|
|
2384
|
+
oListener?: object
|
|
2066
2385
|
): this;
|
|
2067
2386
|
/**
|
|
2068
|
-
*
|
|
2069
|
-
*
|
|
2070
|
-
* Additionally, it unregisters them from the hosting UIArea.
|
|
2387
|
+
* Destroys all the content in the aggregation {@link #getContent content}.
|
|
2071
2388
|
*/
|
|
2072
|
-
|
|
2389
|
+
destroyContent(): this;
|
|
2073
2390
|
/**
|
|
2074
|
-
*
|
|
2391
|
+
* Destroys all the sideContent in the aggregation {@link #getSideContent sideContent}.
|
|
2075
2392
|
*/
|
|
2076
|
-
|
|
2077
|
-
/**
|
|
2078
|
-
* The value to remove or its index or id
|
|
2079
|
-
*/
|
|
2080
|
-
vValue: int | string | sap.ui.webc.fiori.IFilterItemOption
|
|
2081
|
-
): sap.ui.webc.fiori.IFilterItemOption;
|
|
2393
|
+
destroySideContent(): this;
|
|
2082
2394
|
/**
|
|
2083
|
-
*
|
|
2395
|
+
* Detaches event handler `fnFunction` from the {@link #event:layoutChange layoutChange} event of this `sap.ui.webc.fiori.DynamicSideContent`.
|
|
2084
2396
|
*
|
|
2085
|
-
*
|
|
2086
|
-
*
|
|
2087
|
-
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2088
|
-
*
|
|
2089
|
-
* Default value is `empty string`.
|
|
2397
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
2090
2398
|
*/
|
|
2091
|
-
|
|
2399
|
+
detachLayoutChange(
|
|
2092
2400
|
/**
|
|
2093
|
-
*
|
|
2401
|
+
* The function to be called, when the event occurs
|
|
2094
2402
|
*/
|
|
2095
|
-
|
|
2403
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
2404
|
+
/**
|
|
2405
|
+
* Context object on which the given function had to be called
|
|
2406
|
+
*/
|
|
2407
|
+
oListener?: object
|
|
2096
2408
|
): this;
|
|
2097
|
-
}
|
|
2098
|
-
/**
|
|
2099
|
-
* @SINCE 1.97.0
|
|
2100
|
-
* @EXPERIMENTAL (since 1.97.0)
|
|
2101
|
-
*
|
|
2102
|
-
* Overview:
|
|
2103
|
-
*
|
|
2104
|
-
* Usage:
|
|
2105
|
-
*/
|
|
2106
|
-
class FilterItemOption
|
|
2107
|
-
extends sap.ui.webc.common.WebComponent
|
|
2108
|
-
implements sap.ui.webc.fiori.IFilterItemOption {
|
|
2109
|
-
__implements__sap_ui_webc_fiori_IFilterItemOption: boolean;
|
|
2110
2409
|
/**
|
|
2111
|
-
*
|
|
2112
|
-
*
|
|
2113
|
-
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2114
|
-
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
2115
|
-
* of the syntax of the settings object.
|
|
2410
|
+
* Fires event {@link #event:layoutChange layoutChange} to attached listeners.
|
|
2116
2411
|
*/
|
|
2117
|
-
|
|
2412
|
+
fireLayoutChange(
|
|
2118
2413
|
/**
|
|
2119
|
-
*
|
|
2414
|
+
* Parameters to pass along with the event
|
|
2120
2415
|
*/
|
|
2121
|
-
|
|
2122
|
-
|
|
2416
|
+
mParameters?: {
|
|
2417
|
+
/**
|
|
2418
|
+
* the current breakpoint.
|
|
2419
|
+
*/
|
|
2420
|
+
currentBreakpoint?: string;
|
|
2421
|
+
/**
|
|
2422
|
+
* the breakpoint that was active before change to current breakpoint.
|
|
2423
|
+
*/
|
|
2424
|
+
previousBreakpoint?: string;
|
|
2425
|
+
/**
|
|
2426
|
+
* visibility of the main content.
|
|
2427
|
+
*/
|
|
2428
|
+
mainContentVisible?: boolean;
|
|
2429
|
+
/**
|
|
2430
|
+
* visibility of the side content.
|
|
2431
|
+
*/
|
|
2432
|
+
sideContentVisible?: boolean;
|
|
2433
|
+
}
|
|
2434
|
+
): this;
|
|
2123
2435
|
/**
|
|
2124
|
-
*
|
|
2436
|
+
* Gets content of aggregation {@link #getContent content}.
|
|
2125
2437
|
*
|
|
2126
|
-
*
|
|
2127
|
-
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
2128
|
-
* of the syntax of the settings object.
|
|
2438
|
+
* Defines the main content.
|
|
2129
2439
|
*/
|
|
2130
|
-
|
|
2131
|
-
/**
|
|
2132
|
-
* ID for the new control, generated automatically if no ID is given
|
|
2133
|
-
*/
|
|
2134
|
-
sId?: string,
|
|
2135
|
-
/**
|
|
2136
|
-
* Initial settings for the new control
|
|
2137
|
-
*/
|
|
2138
|
-
mSettings?: sap.ui.webc.fiori.$FilterItemOptionSettings
|
|
2139
|
-
);
|
|
2140
|
-
|
|
2440
|
+
getContent(): sap.ui.core.Control[];
|
|
2141
2441
|
/**
|
|
2142
|
-
*
|
|
2143
|
-
* it with the information contained in `oClassInfo`.
|
|
2442
|
+
* Gets current value of property {@link #getEqualSplit equalSplit}.
|
|
2144
2443
|
*
|
|
2145
|
-
*
|
|
2444
|
+
* Defines whether the component is in equal split mode. In this mode, the side and the main content take
|
|
2445
|
+
* 50:50 percent of the container on all screen sizes except for phone, where the main and side contents
|
|
2446
|
+
* are switching visibility using the toggle method.
|
|
2447
|
+
*
|
|
2448
|
+
* Default value is `false`.
|
|
2146
2449
|
*/
|
|
2147
|
-
|
|
2148
|
-
/**
|
|
2149
|
-
* Name of the class being created
|
|
2150
|
-
*/
|
|
2151
|
-
sClassName: string,
|
|
2152
|
-
/**
|
|
2153
|
-
* Object literal with information about the class
|
|
2154
|
-
*/
|
|
2155
|
-
oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.FilterItemOption>,
|
|
2156
|
-
/**
|
|
2157
|
-
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
2158
|
-
* used by this class
|
|
2159
|
-
*/
|
|
2160
|
-
FNMetaImpl?: Function
|
|
2161
|
-
): Function;
|
|
2450
|
+
getEqualSplit(): boolean;
|
|
2162
2451
|
/**
|
|
2163
|
-
*
|
|
2452
|
+
* Gets current value of property {@link #getHideMainContent hideMainContent}.
|
|
2453
|
+
*
|
|
2454
|
+
* Defines the visibility of the main content.
|
|
2455
|
+
*
|
|
2456
|
+
* Default value is `false`.
|
|
2164
2457
|
*/
|
|
2165
|
-
|
|
2458
|
+
getHideMainContent(): boolean;
|
|
2166
2459
|
/**
|
|
2167
|
-
* Gets current value of property {@link #
|
|
2460
|
+
* Gets current value of property {@link #getHideSideContent hideSideContent}.
|
|
2168
2461
|
*
|
|
2169
|
-
* Defines
|
|
2462
|
+
* Defines the visibility of the side content.
|
|
2170
2463
|
*
|
|
2171
2464
|
* Default value is `false`.
|
|
2172
2465
|
*/
|
|
2173
|
-
|
|
2466
|
+
getHideSideContent(): boolean;
|
|
2174
2467
|
/**
|
|
2175
|
-
* Gets
|
|
2468
|
+
* Gets content of aggregation {@link #getSideContent sideContent}.
|
|
2176
2469
|
*
|
|
2177
|
-
* Defines the
|
|
2470
|
+
* Defines the side content.
|
|
2471
|
+
*/
|
|
2472
|
+
getSideContent(): sap.ui.core.Control[];
|
|
2473
|
+
/**
|
|
2474
|
+
* Gets current value of property {@link #getSideContentFallDown sideContentFallDown}.
|
|
2178
2475
|
*
|
|
2179
|
-
*
|
|
2476
|
+
* Defines on which breakpoints the side content falls down below the main content.
|
|
2477
|
+
*
|
|
2478
|
+
*
|
|
2479
|
+
*
|
|
2480
|
+
* **The available values are:**
|
|
2481
|
+
*
|
|
2482
|
+
*
|
|
2483
|
+
* - `BelowXL`
|
|
2484
|
+
* - `BelowL`
|
|
2485
|
+
* - `BelowM`
|
|
2486
|
+
* - `OnMinimumWidth`
|
|
2487
|
+
*
|
|
2488
|
+
* Default value is `OnMinimumWidth`.
|
|
2180
2489
|
*/
|
|
2181
|
-
|
|
2490
|
+
getSideContentFallDown(): sap.ui.webc.fiori.SideContentFallDown;
|
|
2182
2491
|
/**
|
|
2183
|
-
*
|
|
2492
|
+
* Gets current value of property {@link #getSideContentPosition sideContentPosition}.
|
|
2184
2493
|
*
|
|
2185
|
-
* Defines whether the
|
|
2494
|
+
* Defines whether the side content is positioned before the main content (left side in LTR mode), or after
|
|
2495
|
+
* the the main content (right side in LTR mode).
|
|
2186
2496
|
*
|
|
2187
|
-
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2188
2497
|
*
|
|
2189
|
-
*
|
|
2498
|
+
*
|
|
2499
|
+
* **The available values are:**
|
|
2500
|
+
*
|
|
2501
|
+
*
|
|
2502
|
+
* - `Start`
|
|
2503
|
+
* - `End`
|
|
2504
|
+
*
|
|
2505
|
+
* Default value is `End`.
|
|
2190
2506
|
*/
|
|
2191
|
-
|
|
2192
|
-
/**
|
|
2193
|
-
* New value for property `selected`
|
|
2194
|
-
*/
|
|
2195
|
-
bSelected?: boolean
|
|
2196
|
-
): this;
|
|
2507
|
+
getSideContentPosition(): sap.ui.webc.fiori.SideContentPosition;
|
|
2197
2508
|
/**
|
|
2198
|
-
*
|
|
2509
|
+
* Gets current value of property {@link #getSideContentVisibility sideContentVisibility}.
|
|
2199
2510
|
*
|
|
2200
|
-
* Defines
|
|
2511
|
+
* Defines on which breakpoints the side content is visible.
|
|
2201
2512
|
*
|
|
2202
|
-
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2203
2513
|
*
|
|
2204
|
-
*
|
|
2514
|
+
*
|
|
2515
|
+
* **The available values are:**
|
|
2516
|
+
*
|
|
2517
|
+
*
|
|
2518
|
+
* - `AlwaysShow`
|
|
2519
|
+
* - `ShowAboveL`
|
|
2520
|
+
* - `ShowAboveM`
|
|
2521
|
+
* - `ShowAboveS`
|
|
2522
|
+
* - `NeverShow`
|
|
2523
|
+
*
|
|
2524
|
+
* Default value is `ShowAboveS`.
|
|
2205
2525
|
*/
|
|
2206
|
-
|
|
2207
|
-
|
|
2208
|
-
|
|
2209
|
-
|
|
2210
|
-
|
|
2526
|
+
getSideContentVisibility(): sap.ui.webc.fiori.SideContentVisibility;
|
|
2527
|
+
/**
|
|
2528
|
+
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getContent content}. and returns
|
|
2529
|
+
* its index if found or -1 otherwise.
|
|
2530
|
+
*/
|
|
2531
|
+
indexOfContent(
|
|
2532
|
+
/**
|
|
2533
|
+
* The content whose index is looked for
|
|
2534
|
+
*/
|
|
2535
|
+
oContent: sap.ui.core.Control
|
|
2536
|
+
): int;
|
|
2537
|
+
/**
|
|
2538
|
+
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getSideContent sideContent}.
|
|
2539
|
+
* and returns its index if found or -1 otherwise.
|
|
2540
|
+
*/
|
|
2541
|
+
indexOfSideContent(
|
|
2542
|
+
/**
|
|
2543
|
+
* The sideContent whose index is looked for
|
|
2544
|
+
*/
|
|
2545
|
+
oSideContent: sap.ui.core.Control
|
|
2546
|
+
): int;
|
|
2547
|
+
/**
|
|
2548
|
+
* Inserts a content into the aggregation {@link #getContent content}.
|
|
2549
|
+
*/
|
|
2550
|
+
insertContent(
|
|
2551
|
+
/**
|
|
2552
|
+
* The content to insert; if empty, nothing is inserted
|
|
2553
|
+
*/
|
|
2554
|
+
oContent: sap.ui.core.Control,
|
|
2555
|
+
/**
|
|
2556
|
+
* The `0`-based index the content should be inserted at; for a negative value of `iIndex`, the content
|
|
2557
|
+
* is inserted at position 0; for a value greater than the current size of the aggregation, the content
|
|
2558
|
+
* is inserted at the last position
|
|
2559
|
+
*/
|
|
2560
|
+
iIndex: int
|
|
2561
|
+
): this;
|
|
2562
|
+
/**
|
|
2563
|
+
* Inserts a sideContent into the aggregation {@link #getSideContent sideContent}.
|
|
2564
|
+
*/
|
|
2565
|
+
insertSideContent(
|
|
2566
|
+
/**
|
|
2567
|
+
* The sideContent to insert; if empty, nothing is inserted
|
|
2568
|
+
*/
|
|
2569
|
+
oSideContent: sap.ui.core.Control,
|
|
2570
|
+
/**
|
|
2571
|
+
* The `0`-based index the sideContent should be inserted at; for a negative value of `iIndex`, the sideContent
|
|
2572
|
+
* is inserted at position 0; for a value greater than the current size of the aggregation, the sideContent
|
|
2573
|
+
* is inserted at the last position
|
|
2574
|
+
*/
|
|
2575
|
+
iIndex: int
|
|
2576
|
+
): this;
|
|
2577
|
+
/**
|
|
2578
|
+
* Removes all the controls from the aggregation {@link #getContent content}.
|
|
2579
|
+
*
|
|
2580
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
2581
|
+
*/
|
|
2582
|
+
removeAllContent(): sap.ui.core.Control[];
|
|
2583
|
+
/**
|
|
2584
|
+
* Removes all the controls from the aggregation {@link #getSideContent sideContent}.
|
|
2585
|
+
*
|
|
2586
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
2587
|
+
*/
|
|
2588
|
+
removeAllSideContent(): sap.ui.core.Control[];
|
|
2589
|
+
/**
|
|
2590
|
+
* Removes a content from the aggregation {@link #getContent content}.
|
|
2591
|
+
*/
|
|
2592
|
+
removeContent(
|
|
2593
|
+
/**
|
|
2594
|
+
* The content to remove or its index or id
|
|
2595
|
+
*/
|
|
2596
|
+
vContent: int | string | sap.ui.core.Control
|
|
2597
|
+
): sap.ui.core.Control;
|
|
2598
|
+
/**
|
|
2599
|
+
* Removes a sideContent from the aggregation {@link #getSideContent sideContent}.
|
|
2600
|
+
*/
|
|
2601
|
+
removeSideContent(
|
|
2602
|
+
/**
|
|
2603
|
+
* The sideContent to remove or its index or id
|
|
2604
|
+
*/
|
|
2605
|
+
vSideContent: int | string | sap.ui.core.Control
|
|
2606
|
+
): sap.ui.core.Control;
|
|
2607
|
+
/**
|
|
2608
|
+
* Sets a new value for property {@link #getEqualSplit equalSplit}.
|
|
2609
|
+
*
|
|
2610
|
+
* Defines whether the component is in equal split mode. In this mode, the side and the main content take
|
|
2611
|
+
* 50:50 percent of the container on all screen sizes except for phone, where the main and side contents
|
|
2612
|
+
* are switching visibility using the toggle method.
|
|
2613
|
+
*
|
|
2614
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2615
|
+
*
|
|
2616
|
+
* Default value is `false`.
|
|
2617
|
+
*/
|
|
2618
|
+
setEqualSplit(
|
|
2619
|
+
/**
|
|
2620
|
+
* New value for property `equalSplit`
|
|
2621
|
+
*/
|
|
2622
|
+
bEqualSplit?: boolean
|
|
2623
|
+
): this;
|
|
2624
|
+
/**
|
|
2625
|
+
* Sets a new value for property {@link #getHideMainContent hideMainContent}.
|
|
2626
|
+
*
|
|
2627
|
+
* Defines the visibility of the main content.
|
|
2628
|
+
*
|
|
2629
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2630
|
+
*
|
|
2631
|
+
* Default value is `false`.
|
|
2632
|
+
*/
|
|
2633
|
+
setHideMainContent(
|
|
2634
|
+
/**
|
|
2635
|
+
* New value for property `hideMainContent`
|
|
2636
|
+
*/
|
|
2637
|
+
bHideMainContent?: boolean
|
|
2638
|
+
): this;
|
|
2639
|
+
/**
|
|
2640
|
+
* Sets a new value for property {@link #getHideSideContent hideSideContent}.
|
|
2641
|
+
*
|
|
2642
|
+
* Defines the visibility of the side content.
|
|
2643
|
+
*
|
|
2644
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2645
|
+
*
|
|
2646
|
+
* Default value is `false`.
|
|
2647
|
+
*/
|
|
2648
|
+
setHideSideContent(
|
|
2649
|
+
/**
|
|
2650
|
+
* New value for property `hideSideContent`
|
|
2651
|
+
*/
|
|
2652
|
+
bHideSideContent?: boolean
|
|
2653
|
+
): this;
|
|
2654
|
+
/**
|
|
2655
|
+
* Sets a new value for property {@link #getSideContentFallDown sideContentFallDown}.
|
|
2656
|
+
*
|
|
2657
|
+
* Defines on which breakpoints the side content falls down below the main content.
|
|
2658
|
+
*
|
|
2659
|
+
*
|
|
2660
|
+
*
|
|
2661
|
+
* **The available values are:**
|
|
2662
|
+
*
|
|
2663
|
+
*
|
|
2664
|
+
* - `BelowXL`
|
|
2665
|
+
* - `BelowL`
|
|
2666
|
+
* - `BelowM`
|
|
2667
|
+
* - `OnMinimumWidth`
|
|
2668
|
+
*
|
|
2669
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2670
|
+
*
|
|
2671
|
+
* Default value is `OnMinimumWidth`.
|
|
2672
|
+
*/
|
|
2673
|
+
setSideContentFallDown(
|
|
2674
|
+
/**
|
|
2675
|
+
* New value for property `sideContentFallDown`
|
|
2676
|
+
*/
|
|
2677
|
+
sSideContentFallDown?: sap.ui.webc.fiori.SideContentFallDown
|
|
2678
|
+
): this;
|
|
2679
|
+
/**
|
|
2680
|
+
* Sets a new value for property {@link #getSideContentPosition sideContentPosition}.
|
|
2681
|
+
*
|
|
2682
|
+
* Defines whether the side content is positioned before the main content (left side in LTR mode), or after
|
|
2683
|
+
* the the main content (right side in LTR mode).
|
|
2684
|
+
*
|
|
2685
|
+
*
|
|
2686
|
+
*
|
|
2687
|
+
* **The available values are:**
|
|
2688
|
+
*
|
|
2689
|
+
*
|
|
2690
|
+
* - `Start`
|
|
2691
|
+
* - `End`
|
|
2692
|
+
*
|
|
2693
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2694
|
+
*
|
|
2695
|
+
* Default value is `End`.
|
|
2696
|
+
*/
|
|
2697
|
+
setSideContentPosition(
|
|
2698
|
+
/**
|
|
2699
|
+
* New value for property `sideContentPosition`
|
|
2700
|
+
*/
|
|
2701
|
+
sSideContentPosition?: sap.ui.webc.fiori.SideContentPosition
|
|
2702
|
+
): this;
|
|
2703
|
+
/**
|
|
2704
|
+
* Sets a new value for property {@link #getSideContentVisibility sideContentVisibility}.
|
|
2705
|
+
*
|
|
2706
|
+
* Defines on which breakpoints the side content is visible.
|
|
2707
|
+
*
|
|
2708
|
+
*
|
|
2709
|
+
*
|
|
2710
|
+
* **The available values are:**
|
|
2711
|
+
*
|
|
2712
|
+
*
|
|
2713
|
+
* - `AlwaysShow`
|
|
2714
|
+
* - `ShowAboveL`
|
|
2715
|
+
* - `ShowAboveM`
|
|
2716
|
+
* - `ShowAboveS`
|
|
2717
|
+
* - `NeverShow`
|
|
2718
|
+
*
|
|
2719
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2720
|
+
*
|
|
2721
|
+
* Default value is `ShowAboveS`.
|
|
2722
|
+
*/
|
|
2723
|
+
setSideContentVisibility(
|
|
2724
|
+
/**
|
|
2725
|
+
* New value for property `sideContentVisibility`
|
|
2726
|
+
*/
|
|
2727
|
+
sSideContentVisibility?: sap.ui.webc.fiori.SideContentVisibility
|
|
2728
|
+
): this;
|
|
2729
|
+
/**
|
|
2730
|
+
* Toggles visibility of main and side contents on S screen size (mobile device).
|
|
2731
|
+
*/
|
|
2732
|
+
toggleContents(): void;
|
|
2733
|
+
}
|
|
2734
|
+
/**
|
|
2735
|
+
* @SINCE 1.97.0
|
|
2736
|
+
* @EXPERIMENTAL (since 1.97.0)
|
|
2737
|
+
*
|
|
2738
|
+
* Overview:
|
|
2739
|
+
*
|
|
2740
|
+
* Usage:
|
|
2741
|
+
*/
|
|
2742
|
+
class FilterItem
|
|
2743
|
+
extends sap.ui.webc.common.WebComponent
|
|
2744
|
+
implements sap.ui.webc.fiori.IFilterItem {
|
|
2745
|
+
__implements__sap_ui_webc_fiori_IFilterItem: boolean;
|
|
2746
|
+
/**
|
|
2747
|
+
* Constructor for a new `FilterItem`.
|
|
2748
|
+
*
|
|
2749
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2750
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
2751
|
+
* of the syntax of the settings object.
|
|
2752
|
+
*/
|
|
2753
|
+
constructor(
|
|
2754
|
+
/**
|
|
2755
|
+
* Initial settings for the new control
|
|
2756
|
+
*/
|
|
2757
|
+
mSettings?: sap.ui.webc.fiori.$FilterItemSettings
|
|
2758
|
+
);
|
|
2759
|
+
/**
|
|
2760
|
+
* Constructor for a new `FilterItem`.
|
|
2761
|
+
*
|
|
2762
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2763
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
2764
|
+
* of the syntax of the settings object.
|
|
2765
|
+
*/
|
|
2766
|
+
constructor(
|
|
2767
|
+
/**
|
|
2768
|
+
* ID for the new control, generated automatically if no ID is given
|
|
2769
|
+
*/
|
|
2770
|
+
sId?: string,
|
|
2771
|
+
/**
|
|
2772
|
+
* Initial settings for the new control
|
|
2773
|
+
*/
|
|
2774
|
+
mSettings?: sap.ui.webc.fiori.$FilterItemSettings
|
|
2775
|
+
);
|
|
2776
|
+
|
|
2777
|
+
/**
|
|
2778
|
+
* Creates a new subclass of class sap.ui.webc.fiori.FilterItem with name `sClassName` and enriches it with
|
|
2779
|
+
* the information contained in `oClassInfo`.
|
|
2780
|
+
*
|
|
2781
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
|
|
2782
|
+
*/
|
|
2783
|
+
static extend<T extends Record<string, unknown>>(
|
|
2784
|
+
/**
|
|
2785
|
+
* Name of the class being created
|
|
2786
|
+
*/
|
|
2787
|
+
sClassName: string,
|
|
2788
|
+
/**
|
|
2789
|
+
* Object literal with information about the class
|
|
2790
|
+
*/
|
|
2791
|
+
oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.FilterItem>,
|
|
2792
|
+
/**
|
|
2793
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
2794
|
+
* used by this class
|
|
2795
|
+
*/
|
|
2796
|
+
FNMetaImpl?: Function
|
|
2797
|
+
): Function;
|
|
2798
|
+
/**
|
|
2799
|
+
* Returns a metadata object for class sap.ui.webc.fiori.FilterItem.
|
|
2800
|
+
*/
|
|
2801
|
+
static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
|
|
2802
|
+
/**
|
|
2803
|
+
* Adds some value to the aggregation {@link #getValues values}.
|
|
2804
|
+
*/
|
|
2805
|
+
addValue(
|
|
2806
|
+
/**
|
|
2807
|
+
* The value to add; if empty, nothing is inserted
|
|
2808
|
+
*/
|
|
2809
|
+
oValue: sap.ui.webc.fiori.IFilterItemOption
|
|
2810
|
+
): this;
|
|
2811
|
+
/**
|
|
2812
|
+
* Destroys all the values in the aggregation {@link #getValues values}.
|
|
2813
|
+
*/
|
|
2814
|
+
destroyValues(): this;
|
|
2815
|
+
/**
|
|
2816
|
+
* Gets current value of property {@link #getText text}.
|
|
2817
|
+
*
|
|
2818
|
+
* Defines the text of the component.
|
|
2819
|
+
*
|
|
2820
|
+
* Default value is `empty string`.
|
|
2821
|
+
*/
|
|
2822
|
+
getText(): string;
|
|
2823
|
+
/**
|
|
2824
|
+
* Gets content of aggregation {@link #getValues values}.
|
|
2825
|
+
*
|
|
2826
|
+
* Defines the `values` list.
|
|
2827
|
+
*/
|
|
2828
|
+
getValues(): sap.ui.webc.fiori.IFilterItemOption[];
|
|
2829
|
+
/**
|
|
2830
|
+
* Checks for the provided `sap.ui.webc.fiori.IFilterItemOption` in the aggregation {@link #getValues values}.
|
|
2831
|
+
* and returns its index if found or -1 otherwise.
|
|
2832
|
+
*/
|
|
2833
|
+
indexOfValue(
|
|
2834
|
+
/**
|
|
2835
|
+
* The value whose index is looked for
|
|
2836
|
+
*/
|
|
2837
|
+
oValue: sap.ui.webc.fiori.IFilterItemOption
|
|
2838
|
+
): int;
|
|
2839
|
+
/**
|
|
2840
|
+
* Inserts a value into the aggregation {@link #getValues values}.
|
|
2841
|
+
*/
|
|
2842
|
+
insertValue(
|
|
2843
|
+
/**
|
|
2844
|
+
* The value to insert; if empty, nothing is inserted
|
|
2845
|
+
*/
|
|
2846
|
+
oValue: sap.ui.webc.fiori.IFilterItemOption,
|
|
2847
|
+
/**
|
|
2848
|
+
* The `0`-based index the value should be inserted at; for a negative value of `iIndex`, the value is inserted
|
|
2849
|
+
* at position 0; for a value greater than the current size of the aggregation, the value is inserted at
|
|
2850
|
+
* the last position
|
|
2851
|
+
*/
|
|
2852
|
+
iIndex: int
|
|
2853
|
+
): this;
|
|
2854
|
+
/**
|
|
2855
|
+
* Removes all the controls from the aggregation {@link #getValues values}.
|
|
2856
|
+
*
|
|
2857
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
2858
|
+
*/
|
|
2859
|
+
removeAllValues(): sap.ui.webc.fiori.IFilterItemOption[];
|
|
2860
|
+
/**
|
|
2861
|
+
* Removes a value from the aggregation {@link #getValues values}.
|
|
2862
|
+
*/
|
|
2863
|
+
removeValue(
|
|
2864
|
+
/**
|
|
2865
|
+
* The value to remove or its index or id
|
|
2866
|
+
*/
|
|
2867
|
+
vValue: int | string | sap.ui.webc.fiori.IFilterItemOption
|
|
2868
|
+
): sap.ui.webc.fiori.IFilterItemOption;
|
|
2869
|
+
/**
|
|
2870
|
+
* Sets a new value for property {@link #getText text}.
|
|
2871
|
+
*
|
|
2872
|
+
* Defines the text of the component.
|
|
2873
|
+
*
|
|
2874
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2875
|
+
*
|
|
2876
|
+
* Default value is `empty string`.
|
|
2877
|
+
*/
|
|
2878
|
+
setText(
|
|
2879
|
+
/**
|
|
2880
|
+
* New value for property `text`
|
|
2881
|
+
*/
|
|
2882
|
+
sText?: string
|
|
2883
|
+
): this;
|
|
2884
|
+
}
|
|
2885
|
+
/**
|
|
2886
|
+
* @SINCE 1.97.0
|
|
2887
|
+
* @EXPERIMENTAL (since 1.97.0)
|
|
2888
|
+
*
|
|
2889
|
+
* Overview:
|
|
2890
|
+
*
|
|
2891
|
+
* Usage:
|
|
2892
|
+
*/
|
|
2893
|
+
class FilterItemOption
|
|
2894
|
+
extends sap.ui.webc.common.WebComponent
|
|
2895
|
+
implements sap.ui.webc.fiori.IFilterItemOption {
|
|
2896
|
+
__implements__sap_ui_webc_fiori_IFilterItemOption: boolean;
|
|
2897
|
+
/**
|
|
2898
|
+
* Constructor for a new `FilterItemOption`.
|
|
2899
|
+
*
|
|
2900
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2901
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
2902
|
+
* of the syntax of the settings object.
|
|
2903
|
+
*/
|
|
2904
|
+
constructor(
|
|
2905
|
+
/**
|
|
2906
|
+
* Initial settings for the new control
|
|
2907
|
+
*/
|
|
2908
|
+
mSettings?: sap.ui.webc.fiori.$FilterItemOptionSettings
|
|
2909
|
+
);
|
|
2910
|
+
/**
|
|
2911
|
+
* Constructor for a new `FilterItemOption`.
|
|
2912
|
+
*
|
|
2913
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2914
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
2915
|
+
* of the syntax of the settings object.
|
|
2916
|
+
*/
|
|
2917
|
+
constructor(
|
|
2918
|
+
/**
|
|
2919
|
+
* ID for the new control, generated automatically if no ID is given
|
|
2920
|
+
*/
|
|
2921
|
+
sId?: string,
|
|
2922
|
+
/**
|
|
2923
|
+
* Initial settings for the new control
|
|
2924
|
+
*/
|
|
2925
|
+
mSettings?: sap.ui.webc.fiori.$FilterItemOptionSettings
|
|
2926
|
+
);
|
|
2927
|
+
|
|
2928
|
+
/**
|
|
2929
|
+
* Creates a new subclass of class sap.ui.webc.fiori.FilterItemOption with name `sClassName` and enriches
|
|
2930
|
+
* it with the information contained in `oClassInfo`.
|
|
2931
|
+
*
|
|
2932
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
|
|
2933
|
+
*/
|
|
2934
|
+
static extend<T extends Record<string, unknown>>(
|
|
2935
|
+
/**
|
|
2936
|
+
* Name of the class being created
|
|
2937
|
+
*/
|
|
2938
|
+
sClassName: string,
|
|
2939
|
+
/**
|
|
2940
|
+
* Object literal with information about the class
|
|
2941
|
+
*/
|
|
2942
|
+
oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.FilterItemOption>,
|
|
2943
|
+
/**
|
|
2944
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
2945
|
+
* used by this class
|
|
2946
|
+
*/
|
|
2947
|
+
FNMetaImpl?: Function
|
|
2948
|
+
): Function;
|
|
2949
|
+
/**
|
|
2950
|
+
* Returns a metadata object for class sap.ui.webc.fiori.FilterItemOption.
|
|
2951
|
+
*/
|
|
2952
|
+
static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
|
|
2953
|
+
/**
|
|
2954
|
+
* Gets current value of property {@link #getSelected selected}.
|
|
2955
|
+
*
|
|
2956
|
+
* Defines whether the option is selected
|
|
2957
|
+
*
|
|
2958
|
+
* Default value is `false`.
|
|
2959
|
+
*/
|
|
2960
|
+
getSelected(): boolean;
|
|
2961
|
+
/**
|
|
2962
|
+
* Gets current value of property {@link #getText text}.
|
|
2963
|
+
*
|
|
2964
|
+
* Defines the text of the component.
|
|
2965
|
+
*
|
|
2966
|
+
* Default value is `empty string`.
|
|
2967
|
+
*/
|
|
2968
|
+
getText(): string;
|
|
2969
|
+
/**
|
|
2970
|
+
* Sets a new value for property {@link #getSelected selected}.
|
|
2971
|
+
*
|
|
2972
|
+
* Defines whether the option is selected
|
|
2973
|
+
*
|
|
2974
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2975
|
+
*
|
|
2976
|
+
* Default value is `false`.
|
|
2977
|
+
*/
|
|
2978
|
+
setSelected(
|
|
2979
|
+
/**
|
|
2980
|
+
* New value for property `selected`
|
|
2981
|
+
*/
|
|
2982
|
+
bSelected?: boolean
|
|
2983
|
+
): this;
|
|
2984
|
+
/**
|
|
2985
|
+
* Sets a new value for property {@link #getText text}.
|
|
2986
|
+
*
|
|
2987
|
+
* Defines the text of the component.
|
|
2988
|
+
*
|
|
2989
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2990
|
+
*
|
|
2991
|
+
* Default value is `empty string`.
|
|
2992
|
+
*/
|
|
2993
|
+
setText(
|
|
2994
|
+
/**
|
|
2995
|
+
* New value for property `text`
|
|
2996
|
+
*/
|
|
2997
|
+
sText?: string
|
|
2998
|
+
): this;
|
|
2999
|
+
}
|
|
3000
|
+
/**
|
|
3001
|
+
* @SINCE 1.92.0
|
|
3002
|
+
* @EXPERIMENTAL (since 1.92.0)
|
|
3003
|
+
*
|
|
3004
|
+
* Overview:
|
|
3005
|
+
*
|
|
3006
|
+
* The `FlexibleColumnLayout` implements the master-detail-detail paradigm by displaying up to three pages
|
|
3007
|
+
* in separate columns. There are several possible layouts that can be changed either with the component
|
|
3008
|
+
* API, or by pressing the arrows, displayed between the columns.
|
|
3009
|
+
*
|
|
3010
|
+
* Usage:
|
|
3011
|
+
*
|
|
3012
|
+
* Use this component for applications that need to display several logical levels of related information
|
|
3013
|
+
* side by side (e.g. list of items, item, sub-item, etc.). The Component is flexible in a sense that the
|
|
3014
|
+
* application can focus the user's attention on one particular column.
|
|
3015
|
+
*
|
|
3016
|
+
* Responsive Behavior:
|
|
3017
|
+
*
|
|
3018
|
+
* The `FlexibleColumnLayout` automatically displays the maximum possible number of columns based on `layout`
|
|
3019
|
+
* property and the window size. The component would display 1 column for window size smaller than 599px,
|
|
3020
|
+
* up to two columns between 599px and 1023px, and 3 columns for sizes bigger than 1023px.
|
|
3021
|
+
*
|
|
3022
|
+
*
|
|
3023
|
+
*
|
|
3024
|
+
* Keyboard Handling:
|
|
3025
|
+
*/
|
|
3026
|
+
class FlexibleColumnLayout extends sap.ui.webc.common.WebComponent {
|
|
3027
|
+
/**
|
|
3028
|
+
* Constructor for a new `FlexibleColumnLayout`.
|
|
3029
|
+
*
|
|
3030
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
3031
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
3032
|
+
* of the syntax of the settings object.
|
|
3033
|
+
*/
|
|
3034
|
+
constructor(
|
|
3035
|
+
/**
|
|
3036
|
+
* Initial settings for the new control
|
|
3037
|
+
*/
|
|
3038
|
+
mSettings?: sap.ui.webc.fiori.$FlexibleColumnLayoutSettings
|
|
3039
|
+
);
|
|
3040
|
+
/**
|
|
3041
|
+
* Constructor for a new `FlexibleColumnLayout`.
|
|
3042
|
+
*
|
|
3043
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
3044
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
3045
|
+
* of the syntax of the settings object.
|
|
3046
|
+
*/
|
|
3047
|
+
constructor(
|
|
3048
|
+
/**
|
|
3049
|
+
* ID for the new control, generated automatically if no ID is given
|
|
3050
|
+
*/
|
|
3051
|
+
sId?: string,
|
|
3052
|
+
/**
|
|
3053
|
+
* Initial settings for the new control
|
|
3054
|
+
*/
|
|
3055
|
+
mSettings?: sap.ui.webc.fiori.$FlexibleColumnLayoutSettings
|
|
3056
|
+
);
|
|
3057
|
+
|
|
3058
|
+
/**
|
|
3059
|
+
* Creates a new subclass of class sap.ui.webc.fiori.FlexibleColumnLayout with name `sClassName` and enriches
|
|
3060
|
+
* it with the information contained in `oClassInfo`.
|
|
3061
|
+
*
|
|
3062
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
|
|
3063
|
+
*/
|
|
3064
|
+
static extend<T extends Record<string, unknown>>(
|
|
3065
|
+
/**
|
|
3066
|
+
* Name of the class being created
|
|
3067
|
+
*/
|
|
3068
|
+
sClassName: string,
|
|
3069
|
+
/**
|
|
3070
|
+
* Object literal with information about the class
|
|
3071
|
+
*/
|
|
3072
|
+
oClassInfo?: sap.ClassInfo<
|
|
3073
|
+
T,
|
|
3074
|
+
sap.ui.webc.fiori.FlexibleColumnLayout
|
|
3075
|
+
>,
|
|
3076
|
+
/**
|
|
3077
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
3078
|
+
* used by this class
|
|
3079
|
+
*/
|
|
3080
|
+
FNMetaImpl?: Function
|
|
3081
|
+
): Function;
|
|
3082
|
+
/**
|
|
3083
|
+
* Returns a metadata object for class sap.ui.webc.fiori.FlexibleColumnLayout.
|
|
3084
|
+
*/
|
|
3085
|
+
static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
|
|
3086
|
+
/**
|
|
3087
|
+
* Attaches event handler `fnFunction` to the {@link #event:layoutChange layoutChange} event of this `sap.ui.webc.fiori.FlexibleColumnLayout`.
|
|
3088
|
+
*
|
|
3089
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
3090
|
+
* otherwise it will be bound to this `sap.ui.webc.fiori.FlexibleColumnLayout` itself.
|
|
3091
|
+
*
|
|
3092
|
+
* Fired when the layout changes via user interaction by clicking the arrows or by changing the component
|
|
3093
|
+
* size due to resizing.
|
|
3094
|
+
*/
|
|
3095
|
+
attachLayoutChange(
|
|
3096
|
+
/**
|
|
3097
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
3098
|
+
* object when firing the event
|
|
3099
|
+
*/
|
|
3100
|
+
oData: object,
|
|
3101
|
+
/**
|
|
3102
|
+
* The function to be called when the event occurs
|
|
3103
|
+
*/
|
|
3104
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
3105
|
+
/**
|
|
3106
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.FlexibleColumnLayout`
|
|
3107
|
+
* itself
|
|
3108
|
+
*/
|
|
3109
|
+
oListener?: object
|
|
3110
|
+
): this;
|
|
3111
|
+
/**
|
|
3112
|
+
* Attaches event handler `fnFunction` to the {@link #event:layoutChange layoutChange} event of this `sap.ui.webc.fiori.FlexibleColumnLayout`.
|
|
3113
|
+
*
|
|
3114
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
3115
|
+
* otherwise it will be bound to this `sap.ui.webc.fiori.FlexibleColumnLayout` itself.
|
|
3116
|
+
*
|
|
3117
|
+
* Fired when the layout changes via user interaction by clicking the arrows or by changing the component
|
|
3118
|
+
* size due to resizing.
|
|
3119
|
+
*/
|
|
3120
|
+
attachLayoutChange(
|
|
3121
|
+
/**
|
|
3122
|
+
* The function to be called when the event occurs
|
|
3123
|
+
*/
|
|
3124
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
3125
|
+
/**
|
|
3126
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.FlexibleColumnLayout`
|
|
3127
|
+
* itself
|
|
3128
|
+
*/
|
|
3129
|
+
oListener?: object
|
|
3130
|
+
): this;
|
|
3131
|
+
/**
|
|
3132
|
+
* Destroys the endColumn in the aggregation {@link #getEndColumn endColumn}.
|
|
3133
|
+
*/
|
|
3134
|
+
destroyEndColumn(): this;
|
|
3135
|
+
/**
|
|
3136
|
+
* Destroys the midColumn in the aggregation {@link #getMidColumn midColumn}.
|
|
3137
|
+
*/
|
|
3138
|
+
destroyMidColumn(): this;
|
|
3139
|
+
/**
|
|
3140
|
+
* Destroys the startColumn in the aggregation {@link #getStartColumn startColumn}.
|
|
3141
|
+
*/
|
|
3142
|
+
destroyStartColumn(): this;
|
|
3143
|
+
/**
|
|
3144
|
+
* Detaches event handler `fnFunction` from the {@link #event:layoutChange layoutChange} event of this `sap.ui.webc.fiori.FlexibleColumnLayout`.
|
|
3145
|
+
*
|
|
3146
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
3147
|
+
*/
|
|
3148
|
+
detachLayoutChange(
|
|
3149
|
+
/**
|
|
3150
|
+
* The function to be called, when the event occurs
|
|
3151
|
+
*/
|
|
3152
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
3153
|
+
/**
|
|
3154
|
+
* Context object on which the given function had to be called
|
|
3155
|
+
*/
|
|
3156
|
+
oListener?: object
|
|
3157
|
+
): this;
|
|
3158
|
+
/**
|
|
3159
|
+
* Fires event {@link #event:layoutChange layoutChange} to attached listeners.
|
|
3160
|
+
*/
|
|
3161
|
+
fireLayoutChange(
|
|
3162
|
+
/**
|
|
3163
|
+
* Parameters to pass along with the event
|
|
3164
|
+
*/
|
|
3165
|
+
mParameters?: {
|
|
3166
|
+
/**
|
|
3167
|
+
* The current layout
|
|
3168
|
+
*/
|
|
3169
|
+
layout?: FCLLayout;
|
|
3170
|
+
/**
|
|
3171
|
+
* The effective column layout, f.e [67%, 33%, 0]
|
|
3172
|
+
*/
|
|
3173
|
+
columnLayout?: any[];
|
|
3174
|
+
/**
|
|
3175
|
+
* Indicates if the start column is currently visible
|
|
3176
|
+
*/
|
|
3177
|
+
startColumnVisible?: boolean;
|
|
3178
|
+
/**
|
|
3179
|
+
* Indicates if the middle column is currently visible
|
|
3180
|
+
*/
|
|
3181
|
+
midColumnVisible?: boolean;
|
|
3182
|
+
/**
|
|
3183
|
+
* Indicates if the end column is currently visible
|
|
3184
|
+
*/
|
|
3185
|
+
endColumnVisible?: boolean;
|
|
3186
|
+
/**
|
|
3187
|
+
* Indicates if the layout is changed via the arrows
|
|
3188
|
+
*/
|
|
3189
|
+
arrowsUsed?: boolean;
|
|
3190
|
+
/**
|
|
3191
|
+
* Indicates if the layout is changed via resizing
|
|
3192
|
+
*/
|
|
3193
|
+
resize?: boolean;
|
|
3194
|
+
}
|
|
3195
|
+
): this;
|
|
3196
|
+
/**
|
|
3197
|
+
* Gets current value of property {@link #getAccessibilityRoles accessibilityRoles}.
|
|
3198
|
+
*
|
|
3199
|
+
* An object of strings that defines additional accessibility roles for further customization.
|
|
3200
|
+
*
|
|
3201
|
+
* It supports the following fields: - `startColumnRole`: the accessibility role for the `startColumn` -
|
|
3202
|
+
* `startArrowContainerRole`: the accessibility role for the first arrow container (between the `begin`
|
|
3203
|
+
* and `mid` columns) - `midColumnRole`: the accessibility role for the `midColumn` - `endArrowContainerRole`:
|
|
3204
|
+
* the accessibility role for the second arrow container (between the `mid` and `end` columns) - `endColumnRole`:
|
|
3205
|
+
* the accessibility role for the `endColumn`
|
|
3206
|
+
*
|
|
3207
|
+
* Default value is `{}`.
|
|
3208
|
+
*/
|
|
3209
|
+
getAccessibilityRoles(): object;
|
|
3210
|
+
/**
|
|
3211
|
+
* Gets current value of property {@link #getAccessibilityTexts accessibilityTexts}.
|
|
3212
|
+
*
|
|
3213
|
+
* An object of strings that defines several additional accessibility texts for even further customization.
|
|
3214
|
+
*
|
|
3215
|
+
* It supports the following fields: - `startColumnAccessibleName`: the accessibility name for the `startColumn`
|
|
3216
|
+
* region - `midColumnAccessibleName`: the accessibility name for the `midColumn` region - `endColumnAccessibleName`:
|
|
3217
|
+
* the accessibility name for the `endColumn` region - `startArrowLeftText`: the text that the first arrow
|
|
3218
|
+
* (between the `begin` and `mid` columns) will have when pointing to the left - `startArrowRightText`:
|
|
3219
|
+
* the text that the first arrow (between the `begin` and `mid` columns) will have when pointing to the
|
|
3220
|
+
* right - `endArrowLeftText`: the text that the second arrow (between the `mid` and `end` columns) will
|
|
3221
|
+
* have when pointing to the left - `endArrowRightText`: the text that the second arrow (between the `mid`
|
|
3222
|
+
* and `end` columns) will have when pointing to the right - `startArrowContainerAccessibleName`: the text
|
|
3223
|
+
* that the first arrow container (between the `begin` and `mid` columns) will have as `aria-label` - `endArrowContainerAccessibleName`:
|
|
3224
|
+
* the text that the second arrow container (between the `mid` and `end` columns) will have as `aria-label`
|
|
3225
|
+
*
|
|
3226
|
+
* Default value is `{}`.
|
|
3227
|
+
*/
|
|
3228
|
+
getAccessibilityTexts(): object;
|
|
3229
|
+
/**
|
|
3230
|
+
* Returns the current column layout, based on both the `layout` property and the screen size.
|
|
3231
|
+
*
|
|
3232
|
+
* **For example:** ["67%", "33%", 0], ["100%", 0, 0], ["25%", "50%", "25%"], etc, where the numbers represents
|
|
3233
|
+
* the width of the start, middle and end columns.
|
|
3234
|
+
*/
|
|
3235
|
+
getColumnLayout(): void;
|
|
3236
|
+
/**
|
|
3237
|
+
* Gets content of aggregation {@link #getEndColumn endColumn}.
|
|
3238
|
+
*
|
|
3239
|
+
* Defines the content in the end column.
|
|
3240
|
+
*/
|
|
3241
|
+
getEndColumn(): sap.ui.core.Control;
|
|
3242
|
+
/**
|
|
3243
|
+
* Returns if the `end` column is visible.
|
|
3244
|
+
*/
|
|
3245
|
+
getEndColumnVisible(): void;
|
|
3246
|
+
/**
|
|
3247
|
+
* Gets current value of property {@link #getHeight height}.
|
|
3248
|
+
*
|
|
3249
|
+
* Defines the height of the control
|
|
3250
|
+
*/
|
|
3251
|
+
getHeight(): sap.ui.core.CSSSize;
|
|
3252
|
+
/**
|
|
3253
|
+
* Gets current value of property {@link #getHideArrows hideArrows}.
|
|
3254
|
+
*
|
|
3255
|
+
* Defines the visibility of the arrows, used for expanding and shrinking the columns.
|
|
3256
|
+
*
|
|
3257
|
+
* Default value is `false`.
|
|
3258
|
+
*/
|
|
3259
|
+
getHideArrows(): boolean;
|
|
3260
|
+
/**
|
|
3261
|
+
* Gets current value of property {@link #getLayout layout}.
|
|
3262
|
+
*
|
|
3263
|
+
* Defines the columns layout and their proportion.
|
|
3264
|
+
*
|
|
3265
|
+
* **Note:** The layout also depends on the screen size - one column for screens smaller than 599px, two
|
|
3266
|
+
* columns between 599px and 1023px and three columns for sizes bigger than 1023px.
|
|
3267
|
+
*
|
|
3268
|
+
* Available options are:
|
|
3269
|
+
* - `OneColumn`
|
|
3270
|
+
* - `TwoColumnsStartExpanded`
|
|
3271
|
+
* - `TwoColumnsMidExpanded`
|
|
3272
|
+
* - `ThreeColumnsMidExpanded`
|
|
3273
|
+
* - `ThreeColumnsEndExpanded`
|
|
3274
|
+
* - `ThreeColumnsStartExpandedEndHidden`
|
|
3275
|
+
* - `ThreeColumnsMidExpandedEndHidden`
|
|
3276
|
+
* - `MidColumnFullScreen`
|
|
3277
|
+
* - `EndColumnFullScreen`
|
|
3278
|
+
*
|
|
3279
|
+
* **For example:** layout=`TwoColumnsStartExpanded` means the layout will display up to two columns in
|
|
3280
|
+
* 67%/33% proportion.
|
|
3281
|
+
*
|
|
3282
|
+
* Default value is `OneColumn`.
|
|
3283
|
+
*/
|
|
3284
|
+
getLayout(): sap.ui.webc.fiori.FCLLayout;
|
|
3285
|
+
/**
|
|
3286
|
+
* Gets content of aggregation {@link #getMidColumn midColumn}.
|
|
3287
|
+
*
|
|
3288
|
+
* Defines the content in the middle column.
|
|
3289
|
+
*/
|
|
3290
|
+
getMidColumn(): sap.ui.core.Control;
|
|
3291
|
+
/**
|
|
3292
|
+
* Returns if the `middle` column is visible.
|
|
3293
|
+
*/
|
|
3294
|
+
getMidColumnVisible(): void;
|
|
3295
|
+
/**
|
|
3296
|
+
* Gets content of aggregation {@link #getStartColumn startColumn}.
|
|
3297
|
+
*
|
|
3298
|
+
* Defines the content in the start column.
|
|
3299
|
+
*/
|
|
3300
|
+
getStartColumn(): sap.ui.core.Control;
|
|
3301
|
+
/**
|
|
3302
|
+
* Returns if the `start` column is visible.
|
|
3303
|
+
*/
|
|
3304
|
+
getStartColumnVisible(): void;
|
|
3305
|
+
/**
|
|
3306
|
+
* Returns the number of currently visible columns.
|
|
3307
|
+
*/
|
|
3308
|
+
getVisibleColumns(): void;
|
|
3309
|
+
/**
|
|
3310
|
+
* Gets current value of property {@link #getWidth width}.
|
|
3311
|
+
*
|
|
3312
|
+
* Defines the width of the control
|
|
3313
|
+
*/
|
|
3314
|
+
getWidth(): sap.ui.core.CSSSize;
|
|
3315
|
+
/**
|
|
3316
|
+
* Sets a new value for property {@link #getAccessibilityRoles accessibilityRoles}.
|
|
3317
|
+
*
|
|
3318
|
+
* An object of strings that defines additional accessibility roles for further customization.
|
|
3319
|
+
*
|
|
3320
|
+
* It supports the following fields: - `startColumnRole`: the accessibility role for the `startColumn` -
|
|
3321
|
+
* `startArrowContainerRole`: the accessibility role for the first arrow container (between the `begin`
|
|
3322
|
+
* and `mid` columns) - `midColumnRole`: the accessibility role for the `midColumn` - `endArrowContainerRole`:
|
|
3323
|
+
* the accessibility role for the second arrow container (between the `mid` and `end` columns) - `endColumnRole`:
|
|
3324
|
+
* the accessibility role for the `endColumn`
|
|
3325
|
+
*
|
|
3326
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3327
|
+
*
|
|
3328
|
+
* Default value is `{}`.
|
|
3329
|
+
*/
|
|
3330
|
+
setAccessibilityRoles(
|
|
3331
|
+
/**
|
|
3332
|
+
* New value for property `accessibilityRoles`
|
|
3333
|
+
*/
|
|
3334
|
+
oAccessibilityRoles?: object
|
|
3335
|
+
): this;
|
|
3336
|
+
/**
|
|
3337
|
+
* Sets a new value for property {@link #getAccessibilityTexts accessibilityTexts}.
|
|
3338
|
+
*
|
|
3339
|
+
* An object of strings that defines several additional accessibility texts for even further customization.
|
|
3340
|
+
*
|
|
3341
|
+
* It supports the following fields: - `startColumnAccessibleName`: the accessibility name for the `startColumn`
|
|
3342
|
+
* region - `midColumnAccessibleName`: the accessibility name for the `midColumn` region - `endColumnAccessibleName`:
|
|
3343
|
+
* the accessibility name for the `endColumn` region - `startArrowLeftText`: the text that the first arrow
|
|
3344
|
+
* (between the `begin` and `mid` columns) will have when pointing to the left - `startArrowRightText`:
|
|
3345
|
+
* the text that the first arrow (between the `begin` and `mid` columns) will have when pointing to the
|
|
3346
|
+
* right - `endArrowLeftText`: the text that the second arrow (between the `mid` and `end` columns) will
|
|
3347
|
+
* have when pointing to the left - `endArrowRightText`: the text that the second arrow (between the `mid`
|
|
3348
|
+
* and `end` columns) will have when pointing to the right - `startArrowContainerAccessibleName`: the text
|
|
3349
|
+
* that the first arrow container (between the `begin` and `mid` columns) will have as `aria-label` - `endArrowContainerAccessibleName`:
|
|
3350
|
+
* the text that the second arrow container (between the `mid` and `end` columns) will have as `aria-label`
|
|
3351
|
+
*
|
|
3352
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3353
|
+
*
|
|
3354
|
+
* Default value is `{}`.
|
|
3355
|
+
*/
|
|
3356
|
+
setAccessibilityTexts(
|
|
3357
|
+
/**
|
|
3358
|
+
* New value for property `accessibilityTexts`
|
|
3359
|
+
*/
|
|
3360
|
+
oAccessibilityTexts?: object
|
|
3361
|
+
): this;
|
|
3362
|
+
/**
|
|
3363
|
+
* Sets the aggregated {@link #getEndColumn endColumn}.
|
|
3364
|
+
*/
|
|
3365
|
+
setEndColumn(
|
|
3366
|
+
/**
|
|
3367
|
+
* The endColumn to set
|
|
3368
|
+
*/
|
|
3369
|
+
oEndColumn: sap.ui.core.Control
|
|
3370
|
+
): this;
|
|
3371
|
+
/**
|
|
3372
|
+
* Sets a new value for property {@link #getHeight height}.
|
|
3373
|
+
*
|
|
3374
|
+
* Defines the height of the control
|
|
3375
|
+
*
|
|
3376
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3377
|
+
*/
|
|
3378
|
+
setHeight(
|
|
3379
|
+
/**
|
|
3380
|
+
* New value for property `height`
|
|
3381
|
+
*/
|
|
3382
|
+
sHeight: sap.ui.core.CSSSize
|
|
3383
|
+
): this;
|
|
3384
|
+
/**
|
|
3385
|
+
* Sets a new value for property {@link #getHideArrows hideArrows}.
|
|
3386
|
+
*
|
|
3387
|
+
* Defines the visibility of the arrows, used for expanding and shrinking the columns.
|
|
3388
|
+
*
|
|
3389
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3390
|
+
*
|
|
3391
|
+
* Default value is `false`.
|
|
3392
|
+
*/
|
|
3393
|
+
setHideArrows(
|
|
3394
|
+
/**
|
|
3395
|
+
* New value for property `hideArrows`
|
|
3396
|
+
*/
|
|
3397
|
+
bHideArrows?: boolean
|
|
3398
|
+
): this;
|
|
3399
|
+
/**
|
|
3400
|
+
* Sets a new value for property {@link #getLayout layout}.
|
|
3401
|
+
*
|
|
3402
|
+
* Defines the columns layout and their proportion.
|
|
3403
|
+
*
|
|
3404
|
+
* **Note:** The layout also depends on the screen size - one column for screens smaller than 599px, two
|
|
3405
|
+
* columns between 599px and 1023px and three columns for sizes bigger than 1023px.
|
|
3406
|
+
*
|
|
3407
|
+
* Available options are:
|
|
3408
|
+
* - `OneColumn`
|
|
3409
|
+
* - `TwoColumnsStartExpanded`
|
|
3410
|
+
* - `TwoColumnsMidExpanded`
|
|
3411
|
+
* - `ThreeColumnsMidExpanded`
|
|
3412
|
+
* - `ThreeColumnsEndExpanded`
|
|
3413
|
+
* - `ThreeColumnsStartExpandedEndHidden`
|
|
3414
|
+
* - `ThreeColumnsMidExpandedEndHidden`
|
|
3415
|
+
* - `MidColumnFullScreen`
|
|
3416
|
+
* - `EndColumnFullScreen`
|
|
3417
|
+
*
|
|
3418
|
+
* **For example:** layout=`TwoColumnsStartExpanded` means the layout will display up to two columns in
|
|
3419
|
+
* 67%/33% proportion.
|
|
3420
|
+
*
|
|
3421
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3422
|
+
*
|
|
3423
|
+
* Default value is `OneColumn`.
|
|
3424
|
+
*/
|
|
3425
|
+
setLayout(
|
|
3426
|
+
/**
|
|
3427
|
+
* New value for property `layout`
|
|
3428
|
+
*/
|
|
3429
|
+
sLayout?: sap.ui.webc.fiori.FCLLayout
|
|
3430
|
+
): this;
|
|
3431
|
+
/**
|
|
3432
|
+
* Sets the aggregated {@link #getMidColumn midColumn}.
|
|
3433
|
+
*/
|
|
3434
|
+
setMidColumn(
|
|
3435
|
+
/**
|
|
3436
|
+
* The midColumn to set
|
|
3437
|
+
*/
|
|
3438
|
+
oMidColumn: sap.ui.core.Control
|
|
3439
|
+
): this;
|
|
3440
|
+
/**
|
|
3441
|
+
* Sets the aggregated {@link #getStartColumn startColumn}.
|
|
3442
|
+
*/
|
|
3443
|
+
setStartColumn(
|
|
3444
|
+
/**
|
|
3445
|
+
* The startColumn to set
|
|
3446
|
+
*/
|
|
3447
|
+
oStartColumn: sap.ui.core.Control
|
|
3448
|
+
): this;
|
|
3449
|
+
/**
|
|
3450
|
+
* Sets a new value for property {@link #getWidth width}.
|
|
3451
|
+
*
|
|
3452
|
+
* Defines the width of the control
|
|
3453
|
+
*
|
|
3454
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3455
|
+
*/
|
|
3456
|
+
setWidth(
|
|
3457
|
+
/**
|
|
3458
|
+
* New value for property `width`
|
|
3459
|
+
*/
|
|
3460
|
+
sWidth: sap.ui.core.CSSSize
|
|
3461
|
+
): this;
|
|
3462
|
+
}
|
|
3463
|
+
/**
|
|
3464
|
+
* @SINCE 1.95.0
|
|
3465
|
+
* @EXPERIMENTAL (since 1.95.0)
|
|
3466
|
+
*
|
|
3467
|
+
* Overview: An IllustratedMessage is a recommended combination of a solution-oriented message, an engaging
|
|
3468
|
+
* illustration, and conversational tone to better communicate an empty or a success state than just show
|
|
3469
|
+
* a message alone.
|
|
3470
|
+
*
|
|
3471
|
+
* Each illustration has default internationalised title and subtitle texts. Also they can be managed with
|
|
3472
|
+
* `titleText` and `subtitleText` properties.
|
|
3473
|
+
*
|
|
3474
|
+
* Structure: The IllustratedMessage consists of the following elements, which are displayed below each
|
|
3475
|
+
* other in the following order:
|
|
3476
|
+
*
|
|
3477
|
+
*
|
|
3478
|
+
*
|
|
3479
|
+
* - Illustration
|
|
3480
|
+
* - Title
|
|
3481
|
+
* - Subtitle
|
|
3482
|
+
* - Actions
|
|
3483
|
+
*
|
|
3484
|
+
* Usage: `sap.ui.webc.fiori.IllustratedMessage` is meant to be used inside container component, for example
|
|
3485
|
+
* a `sap.ui.webc.main.Card`, a `sap.ui.webc.main.Dialog` or a `sap.ui.webc.fiori.Page`
|
|
3486
|
+
*/
|
|
3487
|
+
class IllustratedMessage extends sap.ui.webc.common.WebComponent {
|
|
3488
|
+
/**
|
|
3489
|
+
* Constructor for a new `IllustratedMessage`.
|
|
3490
|
+
*
|
|
3491
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
3492
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
3493
|
+
* of the syntax of the settings object.
|
|
3494
|
+
*/
|
|
3495
|
+
constructor(
|
|
3496
|
+
/**
|
|
3497
|
+
* Initial settings for the new control
|
|
3498
|
+
*/
|
|
3499
|
+
mSettings?: sap.ui.webc.fiori.$IllustratedMessageSettings
|
|
3500
|
+
);
|
|
3501
|
+
/**
|
|
3502
|
+
* Constructor for a new `IllustratedMessage`.
|
|
3503
|
+
*
|
|
3504
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
3505
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
3506
|
+
* of the syntax of the settings object.
|
|
3507
|
+
*/
|
|
3508
|
+
constructor(
|
|
3509
|
+
/**
|
|
3510
|
+
* ID for the new control, generated automatically if no ID is given
|
|
3511
|
+
*/
|
|
3512
|
+
sId?: string,
|
|
3513
|
+
/**
|
|
3514
|
+
* Initial settings for the new control
|
|
3515
|
+
*/
|
|
3516
|
+
mSettings?: sap.ui.webc.fiori.$IllustratedMessageSettings
|
|
3517
|
+
);
|
|
3518
|
+
|
|
3519
|
+
/**
|
|
3520
|
+
* Creates a new subclass of class sap.ui.webc.fiori.IllustratedMessage with name `sClassName` and enriches
|
|
3521
|
+
* it with the information contained in `oClassInfo`.
|
|
3522
|
+
*
|
|
3523
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
|
|
3524
|
+
*/
|
|
3525
|
+
static extend<T extends Record<string, unknown>>(
|
|
3526
|
+
/**
|
|
3527
|
+
* Name of the class being created
|
|
3528
|
+
*/
|
|
3529
|
+
sClassName: string,
|
|
3530
|
+
/**
|
|
3531
|
+
* Object literal with information about the class
|
|
3532
|
+
*/
|
|
3533
|
+
oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.IllustratedMessage>,
|
|
3534
|
+
/**
|
|
3535
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
3536
|
+
* used by this class
|
|
3537
|
+
*/
|
|
3538
|
+
FNMetaImpl?: Function
|
|
3539
|
+
): Function;
|
|
3540
|
+
/**
|
|
3541
|
+
* Returns a metadata object for class sap.ui.webc.fiori.IllustratedMessage.
|
|
3542
|
+
*/
|
|
3543
|
+
static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
|
|
3544
|
+
/**
|
|
3545
|
+
* Adds some action to the aggregation {@link #getActions actions}.
|
|
3546
|
+
*/
|
|
3547
|
+
addAction(
|
|
3548
|
+
/**
|
|
3549
|
+
* The action to add; if empty, nothing is inserted
|
|
3550
|
+
*/
|
|
3551
|
+
oAction: sap.ui.webc.main.IButton
|
|
3552
|
+
): this;
|
|
3553
|
+
/**
|
|
3554
|
+
* Destroys all the actions in the aggregation {@link #getActions actions}.
|
|
3555
|
+
*/
|
|
3556
|
+
destroyActions(): this;
|
|
3557
|
+
/**
|
|
3558
|
+
* Destroys the subtitle in the aggregation {@link #getSubtitle subtitle}.
|
|
3559
|
+
*/
|
|
3560
|
+
destroySubtitle(): this;
|
|
3561
|
+
/**
|
|
3562
|
+
* Gets content of aggregation {@link #getActions actions}.
|
|
3563
|
+
*
|
|
3564
|
+
* Defines the component actions.
|
|
3565
|
+
*/
|
|
3566
|
+
getActions(): sap.ui.webc.main.IButton[];
|
|
3567
|
+
/**
|
|
3568
|
+
* Gets current value of property {@link #getName name}.
|
|
3569
|
+
*
|
|
3570
|
+
* Default value is `BeforeSearch`.
|
|
3571
|
+
*/
|
|
3572
|
+
getName(): sap.ui.webc.fiori.IllustrationMessageType;
|
|
3573
|
+
/**
|
|
3574
|
+
* Gets content of aggregation {@link #getSubtitle subtitle}.
|
|
3575
|
+
*
|
|
3576
|
+
* Defines the subtitle of the component.
|
|
3577
|
+
*
|
|
3578
|
+
* **Note:** Using this slot, the default subtitle text of illustration and the value of `subtitleText`
|
|
3579
|
+
* property will be overwritten.
|
|
3580
|
+
*/
|
|
3581
|
+
getSubtitle(): sap.ui.core.Control;
|
|
3582
|
+
/**
|
|
3583
|
+
* Gets current value of property {@link #getSubtitleText subtitleText}.
|
|
3584
|
+
*
|
|
3585
|
+
* Defines the subtitle of the component.
|
|
3586
|
+
*
|
|
3587
|
+
* **Note:** Using this property, the default subtitle text of illustration will be overwritten.
|
|
3588
|
+
*
|
|
3589
|
+
* **Note:** Using `subtitle` slot, the default of this property will be overwritten.
|
|
3590
|
+
*
|
|
3591
|
+
* Default value is `empty string`.
|
|
3592
|
+
*/
|
|
3593
|
+
getSubtitleText(): string;
|
|
3594
|
+
/**
|
|
3595
|
+
* Gets current value of property {@link #getTitleText titleText}.
|
|
3596
|
+
*
|
|
3597
|
+
* Defines the title of the component.
|
|
3598
|
+
*
|
|
3599
|
+
* **Note:** Using this property, the default title text of illustration will be overwritten.
|
|
3600
|
+
*
|
|
3601
|
+
* Default value is `empty string`.
|
|
3602
|
+
*/
|
|
3603
|
+
getTitleText(): string;
|
|
3604
|
+
/**
|
|
3605
|
+
* Checks for the provided `sap.ui.webc.main.IButton` in the aggregation {@link #getActions actions}. and
|
|
3606
|
+
* returns its index if found or -1 otherwise.
|
|
3607
|
+
*/
|
|
3608
|
+
indexOfAction(
|
|
3609
|
+
/**
|
|
3610
|
+
* The action whose index is looked for
|
|
3611
|
+
*/
|
|
3612
|
+
oAction: sap.ui.webc.main.IButton
|
|
3613
|
+
): int;
|
|
3614
|
+
/**
|
|
3615
|
+
* Inserts a action into the aggregation {@link #getActions actions}.
|
|
3616
|
+
*/
|
|
3617
|
+
insertAction(
|
|
3618
|
+
/**
|
|
3619
|
+
* The action to insert; if empty, nothing is inserted
|
|
3620
|
+
*/
|
|
3621
|
+
oAction: sap.ui.webc.main.IButton,
|
|
3622
|
+
/**
|
|
3623
|
+
* The `0`-based index the action should be inserted at; for a negative value of `iIndex`, the action is
|
|
3624
|
+
* inserted at position 0; for a value greater than the current size of the aggregation, the action is inserted
|
|
3625
|
+
* at the last position
|
|
3626
|
+
*/
|
|
3627
|
+
iIndex: int
|
|
3628
|
+
): this;
|
|
3629
|
+
/**
|
|
3630
|
+
* Removes a action from the aggregation {@link #getActions actions}.
|
|
3631
|
+
*/
|
|
3632
|
+
removeAction(
|
|
3633
|
+
/**
|
|
3634
|
+
* The action to remove or its index or id
|
|
3635
|
+
*/
|
|
3636
|
+
vAction: int | string | sap.ui.webc.main.IButton
|
|
3637
|
+
): sap.ui.webc.main.IButton;
|
|
3638
|
+
/**
|
|
3639
|
+
* Removes all the controls from the aggregation {@link #getActions actions}.
|
|
3640
|
+
*
|
|
3641
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
3642
|
+
*/
|
|
3643
|
+
removeAllActions(): sap.ui.webc.main.IButton[];
|
|
3644
|
+
/**
|
|
3645
|
+
* Sets a new value for property {@link #getName name}.
|
|
3646
|
+
*
|
|
3647
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3648
|
+
*
|
|
3649
|
+
* Default value is `BeforeSearch`.
|
|
3650
|
+
*/
|
|
3651
|
+
setName(
|
|
3652
|
+
/**
|
|
3653
|
+
* New value for property `name`
|
|
3654
|
+
*/
|
|
3655
|
+
sName?: sap.ui.webc.fiori.IllustrationMessageType
|
|
3656
|
+
): this;
|
|
3657
|
+
/**
|
|
3658
|
+
* Sets the aggregated {@link #getSubtitle subtitle}.
|
|
3659
|
+
*/
|
|
3660
|
+
setSubtitle(
|
|
3661
|
+
/**
|
|
3662
|
+
* The subtitle to set
|
|
3663
|
+
*/
|
|
3664
|
+
oSubtitle: sap.ui.core.Control
|
|
3665
|
+
): this;
|
|
3666
|
+
/**
|
|
3667
|
+
* Sets a new value for property {@link #getSubtitleText subtitleText}.
|
|
3668
|
+
*
|
|
3669
|
+
* Defines the subtitle of the component.
|
|
3670
|
+
*
|
|
3671
|
+
* **Note:** Using this property, the default subtitle text of illustration will be overwritten.
|
|
3672
|
+
*
|
|
3673
|
+
* **Note:** Using `subtitle` slot, the default of this property will be overwritten.
|
|
3674
|
+
*
|
|
3675
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3676
|
+
*
|
|
3677
|
+
* Default value is `empty string`.
|
|
3678
|
+
*/
|
|
3679
|
+
setSubtitleText(
|
|
3680
|
+
/**
|
|
3681
|
+
* New value for property `subtitleText`
|
|
3682
|
+
*/
|
|
3683
|
+
sSubtitleText?: string
|
|
3684
|
+
): this;
|
|
3685
|
+
/**
|
|
3686
|
+
* Sets a new value for property {@link #getTitleText titleText}.
|
|
3687
|
+
*
|
|
3688
|
+
* Defines the title of the component.
|
|
3689
|
+
*
|
|
3690
|
+
* **Note:** Using this property, the default title text of illustration will be overwritten.
|
|
3691
|
+
*
|
|
3692
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3693
|
+
*
|
|
3694
|
+
* Default value is `empty string`.
|
|
3695
|
+
*/
|
|
3696
|
+
setTitleText(
|
|
3697
|
+
/**
|
|
3698
|
+
* New value for property `titleText`
|
|
3699
|
+
*/
|
|
3700
|
+
sTitleText?: string
|
|
2211
3701
|
): this;
|
|
2212
3702
|
}
|
|
2213
3703
|
/**
|
|
2214
|
-
* @SINCE 1.
|
|
2215
|
-
* @EXPERIMENTAL (since 1.
|
|
3704
|
+
* @SINCE 1.99.0
|
|
3705
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
2216
3706
|
*
|
|
2217
3707
|
* Overview:
|
|
2218
3708
|
*
|
|
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.
|
|
3709
|
+
* The `ui-media-gallery` component allows the user to browse through multimedia items. Currently, the supported
|
|
3710
|
+
* items are images and videos. The items should be defined using the `sap.ui.webc.fiori.MediaGalleryItem`
|
|
3711
|
+
* component.
|
|
2234
3712
|
*
|
|
3713
|
+
* The items are initially displayed as thumbnails. When the user selects a thumbnail, the corresponding
|
|
3714
|
+
* item is displayed in larger size.
|
|
3715
|
+
* The component is responsive by default and adjusts the position of the menu with respect to viewport
|
|
3716
|
+
* size, but the application is able to further customize the layout via the provided API.
|
|
2235
3717
|
*
|
|
3718
|
+
* Keyboard Handling: The `sap.ui.webc.fiori.MediaGallery` provides advanced keyboard handling.
|
|
3719
|
+
* When the thumbnails menu is focused the following keyboard shortcuts allow the user to navigate through
|
|
3720
|
+
* the thumbnail items:
|
|
2236
3721
|
*
|
|
2237
|
-
* Keyboard Handling:
|
|
2238
3722
|
*
|
|
2239
3723
|
*
|
|
2240
|
-
* - [
|
|
2241
|
-
*
|
|
3724
|
+
* - [UP/DOWN] - Navigates up and down the items
|
|
3725
|
+
* - [HOME] - Navigates to first item
|
|
3726
|
+
* - [END] - Navigates to the last item [SPACE/ENTER] - Select an item
|
|
2242
3727
|
*/
|
|
2243
|
-
class
|
|
3728
|
+
class MediaGallery extends sap.ui.webc.common.WebComponent {
|
|
2244
3729
|
/**
|
|
2245
|
-
* Constructor for a new `
|
|
3730
|
+
* Constructor for a new `MediaGallery`.
|
|
2246
3731
|
*
|
|
2247
3732
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2248
3733
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
@@ -2252,10 +3737,10 @@ declare namespace sap {
|
|
|
2252
3737
|
/**
|
|
2253
3738
|
* Initial settings for the new control
|
|
2254
3739
|
*/
|
|
2255
|
-
mSettings?: sap.ui.webc.fiori.$
|
|
3740
|
+
mSettings?: sap.ui.webc.fiori.$MediaGallerySettings
|
|
2256
3741
|
);
|
|
2257
3742
|
/**
|
|
2258
|
-
* Constructor for a new `
|
|
3743
|
+
* Constructor for a new `MediaGallery`.
|
|
2259
3744
|
*
|
|
2260
3745
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2261
3746
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
@@ -2269,12 +3754,12 @@ declare namespace sap {
|
|
|
2269
3754
|
/**
|
|
2270
3755
|
* Initial settings for the new control
|
|
2271
3756
|
*/
|
|
2272
|
-
mSettings?: sap.ui.webc.fiori.$
|
|
3757
|
+
mSettings?: sap.ui.webc.fiori.$MediaGallerySettings
|
|
2273
3758
|
);
|
|
2274
3759
|
|
|
2275
3760
|
/**
|
|
2276
|
-
* Creates a new subclass of class sap.ui.webc.fiori.
|
|
2277
|
-
*
|
|
3761
|
+
* Creates a new subclass of class sap.ui.webc.fiori.MediaGallery with name `sClassName` and enriches it
|
|
3762
|
+
* with the information contained in `oClassInfo`.
|
|
2278
3763
|
*
|
|
2279
3764
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
|
|
2280
3765
|
*/
|
|
@@ -2286,10 +3771,7 @@ declare namespace sap {
|
|
|
2286
3771
|
/**
|
|
2287
3772
|
* Object literal with information about the class
|
|
2288
3773
|
*/
|
|
2289
|
-
oClassInfo?: sap.ClassInfo<
|
|
2290
|
-
T,
|
|
2291
|
-
sap.ui.webc.fiori.FlexibleColumnLayout
|
|
2292
|
-
>,
|
|
3774
|
+
oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.MediaGallery>,
|
|
2293
3775
|
/**
|
|
2294
3776
|
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
2295
3777
|
* used by this class
|
|
@@ -2297,19 +3779,29 @@ declare namespace sap {
|
|
|
2297
3779
|
FNMetaImpl?: Function
|
|
2298
3780
|
): Function;
|
|
2299
3781
|
/**
|
|
2300
|
-
* Returns a metadata object for class sap.ui.webc.fiori.
|
|
3782
|
+
* Returns a metadata object for class sap.ui.webc.fiori.MediaGallery.
|
|
2301
3783
|
*/
|
|
2302
3784
|
static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
|
|
2303
3785
|
/**
|
|
2304
|
-
*
|
|
3786
|
+
* Adds some item to the aggregation {@link #getItems items}.
|
|
3787
|
+
*/
|
|
3788
|
+
addItem(
|
|
3789
|
+
/**
|
|
3790
|
+
* The item to add; if empty, nothing is inserted
|
|
3791
|
+
*/
|
|
3792
|
+
oItem: sap.ui.webc.fiori.IMediaGalleryItem
|
|
3793
|
+
): this;
|
|
3794
|
+
/**
|
|
3795
|
+
* Attaches event handler `fnFunction` to the {@link #event:displayAreaClick displayAreaClick} event of
|
|
3796
|
+
* this `sap.ui.webc.fiori.MediaGallery`.
|
|
2305
3797
|
*
|
|
2306
3798
|
* 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.
|
|
3799
|
+
* otherwise it will be bound to this `sap.ui.webc.fiori.MediaGallery` itself.
|
|
2308
3800
|
*
|
|
2309
|
-
* Fired when the
|
|
2310
|
-
*
|
|
3801
|
+
* Fired when the display area is clicked.
|
|
3802
|
+
* The display area is the central area that contains the enlarged content of the currently selected item.
|
|
2311
3803
|
*/
|
|
2312
|
-
|
|
3804
|
+
attachDisplayAreaClick(
|
|
2313
3805
|
/**
|
|
2314
3806
|
* An application-specific payload object that will be passed to the event handler along with the event
|
|
2315
3807
|
* object when firing the event
|
|
@@ -2320,351 +3812,423 @@ declare namespace sap {
|
|
|
2320
3812
|
*/
|
|
2321
3813
|
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
2322
3814
|
/**
|
|
2323
|
-
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.
|
|
2324
|
-
* itself
|
|
3815
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.MediaGallery` itself
|
|
2325
3816
|
*/
|
|
2326
3817
|
oListener?: object
|
|
2327
3818
|
): this;
|
|
2328
3819
|
/**
|
|
2329
|
-
* Attaches event handler `fnFunction` to the {@link #event:
|
|
3820
|
+
* Attaches event handler `fnFunction` to the {@link #event:displayAreaClick displayAreaClick} event of
|
|
3821
|
+
* this `sap.ui.webc.fiori.MediaGallery`.
|
|
2330
3822
|
*
|
|
2331
3823
|
* 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.
|
|
3824
|
+
* otherwise it will be bound to this `sap.ui.webc.fiori.MediaGallery` itself.
|
|
2333
3825
|
*
|
|
2334
|
-
* Fired when the
|
|
2335
|
-
*
|
|
3826
|
+
* Fired when the display area is clicked.
|
|
3827
|
+
* The display area is the central area that contains the enlarged content of the currently selected item.
|
|
2336
3828
|
*/
|
|
2337
|
-
|
|
3829
|
+
attachDisplayAreaClick(
|
|
2338
3830
|
/**
|
|
2339
3831
|
* The function to be called when the event occurs
|
|
2340
3832
|
*/
|
|
2341
3833
|
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
2342
3834
|
/**
|
|
2343
|
-
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.
|
|
2344
|
-
* itself
|
|
3835
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.MediaGallery` itself
|
|
2345
3836
|
*/
|
|
2346
3837
|
oListener?: object
|
|
2347
3838
|
): this;
|
|
2348
3839
|
/**
|
|
2349
|
-
*
|
|
3840
|
+
* Attaches event handler `fnFunction` to the {@link #event:overflowClick overflowClick} event of this `sap.ui.webc.fiori.MediaGallery`.
|
|
3841
|
+
*
|
|
3842
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
3843
|
+
* otherwise it will be bound to this `sap.ui.webc.fiori.MediaGallery` itself.
|
|
3844
|
+
*
|
|
3845
|
+
* Fired when the thumbnails overflow button is clicked.
|
|
2350
3846
|
*/
|
|
2351
|
-
|
|
3847
|
+
attachOverflowClick(
|
|
3848
|
+
/**
|
|
3849
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
3850
|
+
* object when firing the event
|
|
3851
|
+
*/
|
|
3852
|
+
oData: object,
|
|
3853
|
+
/**
|
|
3854
|
+
* The function to be called when the event occurs
|
|
3855
|
+
*/
|
|
3856
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
3857
|
+
/**
|
|
3858
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.MediaGallery` itself
|
|
3859
|
+
*/
|
|
3860
|
+
oListener?: object
|
|
3861
|
+
): this;
|
|
2352
3862
|
/**
|
|
2353
|
-
*
|
|
3863
|
+
* Attaches event handler `fnFunction` to the {@link #event:overflowClick overflowClick} event of this `sap.ui.webc.fiori.MediaGallery`.
|
|
3864
|
+
*
|
|
3865
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
3866
|
+
* otherwise it will be bound to this `sap.ui.webc.fiori.MediaGallery` itself.
|
|
3867
|
+
*
|
|
3868
|
+
* Fired when the thumbnails overflow button is clicked.
|
|
2354
3869
|
*/
|
|
2355
|
-
|
|
3870
|
+
attachOverflowClick(
|
|
3871
|
+
/**
|
|
3872
|
+
* The function to be called when the event occurs
|
|
3873
|
+
*/
|
|
3874
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
3875
|
+
/**
|
|
3876
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.MediaGallery` itself
|
|
3877
|
+
*/
|
|
3878
|
+
oListener?: object
|
|
3879
|
+
): this;
|
|
2356
3880
|
/**
|
|
2357
|
-
*
|
|
3881
|
+
* Attaches event handler `fnFunction` to the {@link #event:selectionChange selectionChange} event of this
|
|
3882
|
+
* `sap.ui.webc.fiori.MediaGallery`.
|
|
3883
|
+
*
|
|
3884
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
3885
|
+
* otherwise it will be bound to this `sap.ui.webc.fiori.MediaGallery` itself.
|
|
3886
|
+
*
|
|
3887
|
+
* Fired when selection is changed by user interaction.
|
|
2358
3888
|
*/
|
|
2359
|
-
|
|
3889
|
+
attachSelectionChange(
|
|
3890
|
+
/**
|
|
3891
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
3892
|
+
* object when firing the event
|
|
3893
|
+
*/
|
|
3894
|
+
oData: object,
|
|
3895
|
+
/**
|
|
3896
|
+
* The function to be called when the event occurs
|
|
3897
|
+
*/
|
|
3898
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
3899
|
+
/**
|
|
3900
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.MediaGallery` itself
|
|
3901
|
+
*/
|
|
3902
|
+
oListener?: object
|
|
3903
|
+
): this;
|
|
2360
3904
|
/**
|
|
2361
|
-
*
|
|
3905
|
+
* Attaches event handler `fnFunction` to the {@link #event:selectionChange selectionChange} event of this
|
|
3906
|
+
* `sap.ui.webc.fiori.MediaGallery`.
|
|
3907
|
+
*
|
|
3908
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
3909
|
+
* otherwise it will be bound to this `sap.ui.webc.fiori.MediaGallery` itself.
|
|
3910
|
+
*
|
|
3911
|
+
* Fired when selection is changed by user interaction.
|
|
3912
|
+
*/
|
|
3913
|
+
attachSelectionChange(
|
|
3914
|
+
/**
|
|
3915
|
+
* The function to be called when the event occurs
|
|
3916
|
+
*/
|
|
3917
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
3918
|
+
/**
|
|
3919
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.MediaGallery` itself
|
|
3920
|
+
*/
|
|
3921
|
+
oListener?: object
|
|
3922
|
+
): this;
|
|
3923
|
+
/**
|
|
3924
|
+
* Destroys all the items in the aggregation {@link #getItems items}.
|
|
3925
|
+
*/
|
|
3926
|
+
destroyItems(): this;
|
|
3927
|
+
/**
|
|
3928
|
+
* Detaches event handler `fnFunction` from the {@link #event:displayAreaClick displayAreaClick} event of
|
|
3929
|
+
* this `sap.ui.webc.fiori.MediaGallery`.
|
|
3930
|
+
*
|
|
3931
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
3932
|
+
*/
|
|
3933
|
+
detachDisplayAreaClick(
|
|
3934
|
+
/**
|
|
3935
|
+
* The function to be called, when the event occurs
|
|
3936
|
+
*/
|
|
3937
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
3938
|
+
/**
|
|
3939
|
+
* Context object on which the given function had to be called
|
|
3940
|
+
*/
|
|
3941
|
+
oListener?: object
|
|
3942
|
+
): this;
|
|
3943
|
+
/**
|
|
3944
|
+
* Detaches event handler `fnFunction` from the {@link #event:overflowClick overflowClick} event of this
|
|
3945
|
+
* `sap.ui.webc.fiori.MediaGallery`.
|
|
3946
|
+
*
|
|
3947
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
3948
|
+
*/
|
|
3949
|
+
detachOverflowClick(
|
|
3950
|
+
/**
|
|
3951
|
+
* The function to be called, when the event occurs
|
|
3952
|
+
*/
|
|
3953
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
3954
|
+
/**
|
|
3955
|
+
* Context object on which the given function had to be called
|
|
3956
|
+
*/
|
|
3957
|
+
oListener?: object
|
|
3958
|
+
): this;
|
|
3959
|
+
/**
|
|
3960
|
+
* Detaches event handler `fnFunction` from the {@link #event:selectionChange selectionChange} event of
|
|
3961
|
+
* this `sap.ui.webc.fiori.MediaGallery`.
|
|
2362
3962
|
*
|
|
2363
3963
|
* The passed function and listener object must match the ones used for event registration.
|
|
2364
3964
|
*/
|
|
2365
|
-
|
|
3965
|
+
detachSelectionChange(
|
|
3966
|
+
/**
|
|
3967
|
+
* The function to be called, when the event occurs
|
|
3968
|
+
*/
|
|
3969
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
3970
|
+
/**
|
|
3971
|
+
* Context object on which the given function had to be called
|
|
3972
|
+
*/
|
|
3973
|
+
oListener?: object
|
|
3974
|
+
): this;
|
|
3975
|
+
/**
|
|
3976
|
+
* Fires event {@link #event:displayAreaClick displayAreaClick} to attached listeners.
|
|
3977
|
+
*/
|
|
3978
|
+
fireDisplayAreaClick(
|
|
2366
3979
|
/**
|
|
2367
|
-
*
|
|
3980
|
+
* Parameters to pass along with the event
|
|
2368
3981
|
*/
|
|
2369
|
-
|
|
3982
|
+
mParameters?: object
|
|
3983
|
+
): this;
|
|
3984
|
+
/**
|
|
3985
|
+
* Fires event {@link #event:overflowClick overflowClick} to attached listeners.
|
|
3986
|
+
*/
|
|
3987
|
+
fireOverflowClick(
|
|
2370
3988
|
/**
|
|
2371
|
-
*
|
|
3989
|
+
* Parameters to pass along with the event
|
|
2372
3990
|
*/
|
|
2373
|
-
|
|
3991
|
+
mParameters?: object
|
|
2374
3992
|
): this;
|
|
2375
3993
|
/**
|
|
2376
|
-
* Fires event {@link #event:
|
|
3994
|
+
* Fires event {@link #event:selectionChange selectionChange} to attached listeners.
|
|
2377
3995
|
*/
|
|
2378
|
-
|
|
3996
|
+
fireSelectionChange(
|
|
2379
3997
|
/**
|
|
2380
3998
|
* Parameters to pass along with the event
|
|
2381
3999
|
*/
|
|
2382
4000
|
mParameters?: {
|
|
2383
4001
|
/**
|
|
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
|
|
4002
|
+
* the selected item.
|
|
2409
4003
|
*/
|
|
2410
|
-
|
|
4004
|
+
item?: HTMLElement;
|
|
2411
4005
|
}
|
|
2412
4006
|
): this;
|
|
2413
4007
|
/**
|
|
2414
|
-
* Gets current value of property {@link #
|
|
2415
|
-
*
|
|
2416
|
-
* An object of strings that defines several additional accessibility texts for even further customization.
|
|
4008
|
+
* Gets current value of property {@link #getInteractiveDisplayArea interactiveDisplayArea}.
|
|
2417
4009
|
*
|
|
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
|
|
4010
|
+
* If enabled, a `display-area-click` event is fired when the user clicks or taps on the display area.
|
|
4011
|
+
* The display area is the central area that contains the enlarged content of the currently selected item.
|
|
2426
4012
|
*
|
|
2427
|
-
* Default value is `
|
|
4013
|
+
* Default value is `false`.
|
|
2428
4014
|
*/
|
|
2429
|
-
|
|
4015
|
+
getInteractiveDisplayArea(): boolean;
|
|
2430
4016
|
/**
|
|
2431
|
-
*
|
|
4017
|
+
* Gets content of aggregation {@link #getItems items}.
|
|
2432
4018
|
*
|
|
2433
|
-
*
|
|
2434
|
-
* the width of the start, middle and end columns.
|
|
2435
|
-
*/
|
|
2436
|
-
getColumnLayout(): void;
|
|
2437
|
-
/**
|
|
2438
|
-
* Gets content of aggregation {@link #getEndColumn endColumn}.
|
|
4019
|
+
* Defines the component items.
|
|
2439
4020
|
*
|
|
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
4021
|
*
|
|
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
4022
|
*
|
|
2456
|
-
*
|
|
4023
|
+
* **Note:** Only one selected item is allowed.
|
|
2457
4024
|
*
|
|
2458
|
-
*
|
|
4025
|
+
*
|
|
4026
|
+
*
|
|
4027
|
+
* **Note:** Use the `sap.ui.webc.fiori.MediaGalleryItem` component to define the desired items.
|
|
2459
4028
|
*/
|
|
2460
|
-
|
|
4029
|
+
getItems(): sap.ui.webc.fiori.IMediaGalleryItem[];
|
|
2461
4030
|
/**
|
|
2462
4031
|
* Gets current value of property {@link #getLayout layout}.
|
|
2463
4032
|
*
|
|
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.
|
|
4033
|
+
* Determines the layout of the component.
|
|
2468
4034
|
*
|
|
2469
4035
|
* 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.
|
|
4036
|
+
* - `Auto`
|
|
4037
|
+
* - `Vertical`
|
|
4038
|
+
* - `Horizontal`
|
|
2482
4039
|
*
|
|
2483
|
-
* Default value is `
|
|
4040
|
+
* Default value is `Auto`.
|
|
2484
4041
|
*/
|
|
2485
|
-
getLayout(): sap.ui.webc.fiori.
|
|
4042
|
+
getLayout(): sap.ui.webc.fiori.MediaGalleryLayout;
|
|
2486
4043
|
/**
|
|
2487
|
-
* Gets
|
|
4044
|
+
* Gets current value of property {@link #getMenuHorizontalAlign menuHorizontalAlign}.
|
|
2488
4045
|
*
|
|
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}.
|
|
4046
|
+
* Determines the horizontal alignment of the thumbnails menu vs. the central display area.
|
|
2498
4047
|
*
|
|
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}.
|
|
4048
|
+
* Available options are:
|
|
4049
|
+
* - `Left`
|
|
4050
|
+
* - `Right`
|
|
2512
4051
|
*
|
|
2513
|
-
*
|
|
4052
|
+
* Default value is `Left`.
|
|
2514
4053
|
*/
|
|
2515
|
-
|
|
4054
|
+
getMenuHorizontalAlign(): sap.ui.webc.fiori.MediaGalleryMenuHorizontalAlign;
|
|
2516
4055
|
/**
|
|
2517
|
-
*
|
|
4056
|
+
* Gets current value of property {@link #getMenuVerticalAlign menuVerticalAlign}.
|
|
2518
4057
|
*
|
|
2519
|
-
*
|
|
4058
|
+
* Determines the vertical alignment of the thumbnails menu vs. the central display area.
|
|
2520
4059
|
*
|
|
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
|
|
4060
|
+
* Available options are:
|
|
4061
|
+
* - `Top`
|
|
4062
|
+
* - `Bottom`
|
|
2529
4063
|
*
|
|
2530
|
-
*
|
|
4064
|
+
* Default value is `Bottom`.
|
|
4065
|
+
*/
|
|
4066
|
+
getMenuVerticalAlign(): sap.ui.webc.fiori.MediaGalleryMenuVerticalAlign;
|
|
4067
|
+
/**
|
|
4068
|
+
* Gets current value of property {@link #getShowAllThumbnails showAllThumbnails}.
|
|
2531
4069
|
*
|
|
2532
|
-
*
|
|
4070
|
+
* If set to `true`, all thumbnails are rendered in a scrollable container. If `false`, only up to five
|
|
4071
|
+
* thumbnails are rendered, followed by an overflow button that shows the count of the remaining thumbnails.
|
|
4072
|
+
*
|
|
4073
|
+
* Default value is `false`.
|
|
2533
4074
|
*/
|
|
2534
|
-
|
|
4075
|
+
getShowAllThumbnails(): boolean;
|
|
4076
|
+
/**
|
|
4077
|
+
* Checks for the provided `sap.ui.webc.fiori.IMediaGalleryItem` in the aggregation {@link #getItems items}.
|
|
4078
|
+
* and returns its index if found or -1 otherwise.
|
|
4079
|
+
*/
|
|
4080
|
+
indexOfItem(
|
|
2535
4081
|
/**
|
|
2536
|
-
*
|
|
4082
|
+
* The item whose index is looked for
|
|
2537
4083
|
*/
|
|
2538
|
-
|
|
2539
|
-
):
|
|
4084
|
+
oItem: sap.ui.webc.fiori.IMediaGalleryItem
|
|
4085
|
+
): int;
|
|
2540
4086
|
/**
|
|
2541
|
-
*
|
|
4087
|
+
* Inserts a item into the aggregation {@link #getItems items}.
|
|
2542
4088
|
*/
|
|
2543
|
-
|
|
4089
|
+
insertItem(
|
|
2544
4090
|
/**
|
|
2545
|
-
* The
|
|
4091
|
+
* The item to insert; if empty, nothing is inserted
|
|
2546
4092
|
*/
|
|
2547
|
-
|
|
4093
|
+
oItem: sap.ui.webc.fiori.IMediaGalleryItem,
|
|
4094
|
+
/**
|
|
4095
|
+
* The `0`-based index the item should be inserted at; for a negative value of `iIndex`, the item is inserted
|
|
4096
|
+
* at position 0; for a value greater than the current size of the aggregation, the item is inserted at
|
|
4097
|
+
* the last position
|
|
4098
|
+
*/
|
|
4099
|
+
iIndex: int
|
|
2548
4100
|
): this;
|
|
2549
4101
|
/**
|
|
2550
|
-
*
|
|
2551
|
-
*
|
|
2552
|
-
* Defines the height of the control
|
|
4102
|
+
* Removes all the controls from the aggregation {@link #getItems items}.
|
|
2553
4103
|
*
|
|
2554
|
-
*
|
|
4104
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
2555
4105
|
*/
|
|
2556
|
-
|
|
4106
|
+
removeAllItems(): sap.ui.webc.fiori.IMediaGalleryItem[];
|
|
4107
|
+
/**
|
|
4108
|
+
* Removes a item from the aggregation {@link #getItems items}.
|
|
4109
|
+
*/
|
|
4110
|
+
removeItem(
|
|
2557
4111
|
/**
|
|
2558
|
-
*
|
|
4112
|
+
* The item to remove or its index or id
|
|
2559
4113
|
*/
|
|
2560
|
-
|
|
2561
|
-
):
|
|
4114
|
+
vItem: int | string | sap.ui.webc.fiori.IMediaGalleryItem
|
|
4115
|
+
): sap.ui.webc.fiori.IMediaGalleryItem;
|
|
2562
4116
|
/**
|
|
2563
|
-
* Sets a new value for property {@link #
|
|
4117
|
+
* Sets a new value for property {@link #getInteractiveDisplayArea interactiveDisplayArea}.
|
|
2564
4118
|
*
|
|
2565
|
-
*
|
|
4119
|
+
* If enabled, a `display-area-click` event is fired when the user clicks or taps on the display area.
|
|
4120
|
+
* The display area is the central area that contains the enlarged content of the currently selected item.
|
|
2566
4121
|
*
|
|
2567
4122
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2568
4123
|
*
|
|
2569
4124
|
* Default value is `false`.
|
|
2570
4125
|
*/
|
|
2571
|
-
|
|
4126
|
+
setInteractiveDisplayArea(
|
|
2572
4127
|
/**
|
|
2573
|
-
* New value for property `
|
|
4128
|
+
* New value for property `interactiveDisplayArea`
|
|
2574
4129
|
*/
|
|
2575
|
-
|
|
4130
|
+
bInteractiveDisplayArea?: boolean
|
|
2576
4131
|
): this;
|
|
2577
4132
|
/**
|
|
2578
4133
|
* Sets a new value for property {@link #getLayout layout}.
|
|
2579
4134
|
*
|
|
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.
|
|
4135
|
+
* Determines the layout of the component.
|
|
2584
4136
|
*
|
|
2585
4137
|
* Available options are:
|
|
2586
|
-
* - `
|
|
2587
|
-
* - `
|
|
2588
|
-
* - `
|
|
2589
|
-
* - `ThreeColumnsMidExpanded`
|
|
2590
|
-
* - `ThreeColumnsEndExpanded`
|
|
2591
|
-
* - `ThreeColumnsStartExpandedEndHidden`
|
|
2592
|
-
* - `ThreeColumnsMidExpandedEndHidden`
|
|
2593
|
-
* - `MidColumnFullScreen`
|
|
2594
|
-
* - `EndColumnFullScreen`
|
|
2595
|
-
*
|
|
2596
|
-
* **For example:** layout=`TwoColumnsStartExpanded` means the layout will display up to two columns in
|
|
2597
|
-
* 67%/33% proportion.
|
|
4138
|
+
* - `Auto`
|
|
4139
|
+
* - `Vertical`
|
|
4140
|
+
* - `Horizontal`
|
|
2598
4141
|
*
|
|
2599
4142
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2600
4143
|
*
|
|
2601
|
-
* Default value is `
|
|
4144
|
+
* Default value is `Auto`.
|
|
2602
4145
|
*/
|
|
2603
4146
|
setLayout(
|
|
2604
4147
|
/**
|
|
2605
4148
|
* New value for property `layout`
|
|
2606
4149
|
*/
|
|
2607
|
-
sLayout?: sap.ui.webc.fiori.
|
|
4150
|
+
sLayout?: sap.ui.webc.fiori.MediaGalleryLayout
|
|
2608
4151
|
): this;
|
|
2609
4152
|
/**
|
|
2610
|
-
* Sets
|
|
4153
|
+
* Sets a new value for property {@link #getMenuHorizontalAlign menuHorizontalAlign}.
|
|
4154
|
+
*
|
|
4155
|
+
* Determines the horizontal alignment of the thumbnails menu vs. the central display area.
|
|
4156
|
+
*
|
|
4157
|
+
* Available options are:
|
|
4158
|
+
* - `Left`
|
|
4159
|
+
* - `Right`
|
|
4160
|
+
*
|
|
4161
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
4162
|
+
*
|
|
4163
|
+
* Default value is `Left`.
|
|
2611
4164
|
*/
|
|
2612
|
-
|
|
4165
|
+
setMenuHorizontalAlign(
|
|
2613
4166
|
/**
|
|
2614
|
-
*
|
|
4167
|
+
* New value for property `menuHorizontalAlign`
|
|
2615
4168
|
*/
|
|
2616
|
-
|
|
4169
|
+
sMenuHorizontalAlign?: sap.ui.webc.fiori.MediaGalleryMenuHorizontalAlign
|
|
2617
4170
|
): this;
|
|
2618
4171
|
/**
|
|
2619
|
-
* Sets
|
|
4172
|
+
* Sets a new value for property {@link #getMenuVerticalAlign menuVerticalAlign}.
|
|
4173
|
+
*
|
|
4174
|
+
* Determines the vertical alignment of the thumbnails menu vs. the central display area.
|
|
4175
|
+
*
|
|
4176
|
+
* Available options are:
|
|
4177
|
+
* - `Top`
|
|
4178
|
+
* - `Bottom`
|
|
4179
|
+
*
|
|
4180
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
4181
|
+
*
|
|
4182
|
+
* Default value is `Bottom`.
|
|
2620
4183
|
*/
|
|
2621
|
-
|
|
4184
|
+
setMenuVerticalAlign(
|
|
2622
4185
|
/**
|
|
2623
|
-
*
|
|
4186
|
+
* New value for property `menuVerticalAlign`
|
|
2624
4187
|
*/
|
|
2625
|
-
|
|
4188
|
+
sMenuVerticalAlign?: sap.ui.webc.fiori.MediaGalleryMenuVerticalAlign
|
|
2626
4189
|
): this;
|
|
2627
4190
|
/**
|
|
2628
|
-
* Sets a new value for property {@link #
|
|
4191
|
+
* Sets a new value for property {@link #getShowAllThumbnails showAllThumbnails}.
|
|
2629
4192
|
*
|
|
2630
|
-
*
|
|
4193
|
+
* If set to `true`, all thumbnails are rendered in a scrollable container. If `false`, only up to five
|
|
4194
|
+
* thumbnails are rendered, followed by an overflow button that shows the count of the remaining thumbnails.
|
|
2631
4195
|
*
|
|
2632
4196
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
4197
|
+
*
|
|
4198
|
+
* Default value is `false`.
|
|
2633
4199
|
*/
|
|
2634
|
-
|
|
4200
|
+
setShowAllThumbnails(
|
|
2635
4201
|
/**
|
|
2636
|
-
* New value for property `
|
|
4202
|
+
* New value for property `showAllThumbnails`
|
|
2637
4203
|
*/
|
|
2638
|
-
|
|
4204
|
+
bShowAllThumbnails?: boolean
|
|
2639
4205
|
): this;
|
|
2640
4206
|
}
|
|
2641
4207
|
/**
|
|
2642
|
-
* @SINCE 1.
|
|
2643
|
-
* @EXPERIMENTAL (since 1.
|
|
4208
|
+
* @SINCE 1.99.0
|
|
4209
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
2644
4210
|
*
|
|
2645
|
-
* Overview:
|
|
2646
|
-
*
|
|
2647
|
-
* a message alone.
|
|
4211
|
+
* Overview: The `sap.ui.webc.fiori.MediaGalleryItem` web component represents the items displayed in the
|
|
4212
|
+
* `sap.ui.webc.fiori.MediaGallery` web component.
|
|
2648
4213
|
*
|
|
2649
|
-
*
|
|
2650
|
-
* `titleText` and `subtitleText` properties.
|
|
4214
|
+
* **Note:** `sap.ui.webc.fiori.MediaGalleryItem` is not supported when used outside of `sap.ui.webc.fiori.MediaGallery`.
|
|
2651
4215
|
*
|
|
2652
|
-
* Structure: The IllustratedMessage consists of the following elements, which are displayed below each
|
|
2653
|
-
* other in the following order:
|
|
2654
4216
|
*
|
|
2655
4217
|
*
|
|
2656
4218
|
*
|
|
2657
|
-
*
|
|
2658
|
-
*
|
|
2659
|
-
* - Subtitle
|
|
2660
|
-
* - Actions
|
|
4219
|
+
* Keyboard Handling: The `sap.ui.webc.fiori.MediaGallery` provides advanced keyboard handling. When focused,
|
|
4220
|
+
* the user can use the following keyboard shortcuts in order to perform a navigation:
|
|
2661
4221
|
*
|
|
2662
|
-
*
|
|
2663
|
-
*
|
|
4222
|
+
*
|
|
4223
|
+
*
|
|
4224
|
+
* - [SPACE/ENTER/RETURN] - Trigger `ui5-click` event
|
|
2664
4225
|
*/
|
|
2665
|
-
class
|
|
4226
|
+
class MediaGalleryItem
|
|
4227
|
+
extends sap.ui.webc.common.WebComponent
|
|
4228
|
+
implements sap.ui.webc.fiori.IMediaGalleryItem {
|
|
4229
|
+
__implements__sap_ui_webc_fiori_IMediaGalleryItem: boolean;
|
|
2666
4230
|
/**
|
|
2667
|
-
* Constructor for a new `
|
|
4231
|
+
* Constructor for a new `MediaGalleryItem`.
|
|
2668
4232
|
*
|
|
2669
4233
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2670
4234
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
@@ -2674,10 +4238,10 @@ declare namespace sap {
|
|
|
2674
4238
|
/**
|
|
2675
4239
|
* Initial settings for the new control
|
|
2676
4240
|
*/
|
|
2677
|
-
mSettings?: sap.ui.webc.fiori.$
|
|
4241
|
+
mSettings?: sap.ui.webc.fiori.$MediaGalleryItemSettings
|
|
2678
4242
|
);
|
|
2679
4243
|
/**
|
|
2680
|
-
* Constructor for a new `
|
|
4244
|
+
* Constructor for a new `MediaGalleryItem`.
|
|
2681
4245
|
*
|
|
2682
4246
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2683
4247
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
@@ -2691,11 +4255,11 @@ declare namespace sap {
|
|
|
2691
4255
|
/**
|
|
2692
4256
|
* Initial settings for the new control
|
|
2693
4257
|
*/
|
|
2694
|
-
mSettings?: sap.ui.webc.fiori.$
|
|
4258
|
+
mSettings?: sap.ui.webc.fiori.$MediaGalleryItemSettings
|
|
2695
4259
|
);
|
|
2696
4260
|
|
|
2697
4261
|
/**
|
|
2698
|
-
* Creates a new subclass of class sap.ui.webc.fiori.
|
|
4262
|
+
* Creates a new subclass of class sap.ui.webc.fiori.MediaGalleryItem with name `sClassName` and enriches
|
|
2699
4263
|
* it with the information contained in `oClassInfo`.
|
|
2700
4264
|
*
|
|
2701
4265
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
|
|
@@ -2708,7 +4272,7 @@ declare namespace sap {
|
|
|
2708
4272
|
/**
|
|
2709
4273
|
* Object literal with information about the class
|
|
2710
4274
|
*/
|
|
2711
|
-
oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.
|
|
4275
|
+
oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.MediaGalleryItem>,
|
|
2712
4276
|
/**
|
|
2713
4277
|
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
2714
4278
|
* used by this class
|
|
@@ -2716,166 +4280,125 @@ declare namespace sap {
|
|
|
2716
4280
|
FNMetaImpl?: Function
|
|
2717
4281
|
): Function;
|
|
2718
4282
|
/**
|
|
2719
|
-
* Returns a metadata object for class sap.ui.webc.fiori.
|
|
4283
|
+
* Returns a metadata object for class sap.ui.webc.fiori.MediaGalleryItem.
|
|
2720
4284
|
*/
|
|
2721
4285
|
static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
|
|
2722
4286
|
/**
|
|
2723
|
-
*
|
|
2724
|
-
*/
|
|
2725
|
-
addAction(
|
|
2726
|
-
/**
|
|
2727
|
-
* The action to add; if empty, nothing is inserted
|
|
2728
|
-
*/
|
|
2729
|
-
oAction: sap.ui.webc.main.IButton
|
|
2730
|
-
): this;
|
|
2731
|
-
/**
|
|
2732
|
-
* Destroys all the actions in the aggregation {@link #getActions actions}.
|
|
2733
|
-
*/
|
|
2734
|
-
destroyActions(): this;
|
|
2735
|
-
/**
|
|
2736
|
-
* Destroys the subtitle in the aggregation {@link #getSubtitle subtitle}.
|
|
4287
|
+
* Destroys the content in the aggregation {@link #getContent content}.
|
|
2737
4288
|
*/
|
|
2738
|
-
|
|
4289
|
+
destroyContent(): this;
|
|
2739
4290
|
/**
|
|
2740
|
-
*
|
|
2741
|
-
*
|
|
2742
|
-
* Defines the component actions.
|
|
4291
|
+
* Destroys the thumbnail in the aggregation {@link #getThumbnail thumbnail}.
|
|
2743
4292
|
*/
|
|
2744
|
-
|
|
4293
|
+
destroyThumbnail(): this;
|
|
2745
4294
|
/**
|
|
2746
|
-
* Gets
|
|
4295
|
+
* Gets content of aggregation {@link #getContent content}.
|
|
2747
4296
|
*
|
|
2748
|
-
*
|
|
4297
|
+
* Defines the content of the component.
|
|
2749
4298
|
*/
|
|
2750
|
-
|
|
4299
|
+
getContent(): sap.ui.core.Control;
|
|
2751
4300
|
/**
|
|
2752
|
-
* Gets
|
|
4301
|
+
* Gets current value of property {@link #getEnabled enabled}.
|
|
2753
4302
|
*
|
|
2754
|
-
* Defines the
|
|
4303
|
+
* Defines whether the control is enabled. A disabled control can't be interacted with, and it is not in
|
|
4304
|
+
* the tab chain.
|
|
2755
4305
|
*
|
|
2756
|
-
*
|
|
2757
|
-
* property will be overwritten.
|
|
4306
|
+
* Default value is `true`.
|
|
2758
4307
|
*/
|
|
2759
|
-
|
|
4308
|
+
getEnabled(): boolean;
|
|
2760
4309
|
/**
|
|
2761
|
-
* Gets current value of property {@link #
|
|
2762
|
-
*
|
|
2763
|
-
* Defines the subtitle of the component.
|
|
4310
|
+
* Gets current value of property {@link #getLayout layout}.
|
|
2764
4311
|
*
|
|
2765
|
-
*
|
|
4312
|
+
* Determines the layout of the item container.
|
|
2766
4313
|
*
|
|
2767
|
-
*
|
|
4314
|
+
* Available options are:
|
|
4315
|
+
* - `Square`
|
|
4316
|
+
* - `Wide`
|
|
2768
4317
|
*
|
|
2769
|
-
* Default value is `
|
|
4318
|
+
* Default value is `Square`.
|
|
2770
4319
|
*/
|
|
2771
|
-
|
|
4320
|
+
getLayout(): sap.ui.webc.fiori.MediaGalleryItemLayout;
|
|
2772
4321
|
/**
|
|
2773
|
-
* Gets current value of property {@link #
|
|
2774
|
-
*
|
|
2775
|
-
* Defines the title of the component.
|
|
4322
|
+
* Gets current value of property {@link #getSelected selected}.
|
|
2776
4323
|
*
|
|
2777
|
-
*
|
|
4324
|
+
* Defines the selected state of the component.
|
|
2778
4325
|
*
|
|
2779
|
-
* Default value is `
|
|
4326
|
+
* Default value is `false`.
|
|
2780
4327
|
*/
|
|
2781
|
-
|
|
4328
|
+
getSelected(): boolean;
|
|
2782
4329
|
/**
|
|
2783
|
-
*
|
|
2784
|
-
*
|
|
4330
|
+
* Gets content of aggregation {@link #getThumbnail thumbnail}.
|
|
4331
|
+
*
|
|
4332
|
+
* Defines the content of the thumbnail.
|
|
2785
4333
|
*/
|
|
2786
|
-
|
|
2787
|
-
/**
|
|
2788
|
-
* The action whose index is looked for
|
|
2789
|
-
*/
|
|
2790
|
-
oAction: sap.ui.webc.main.IButton
|
|
2791
|
-
): int;
|
|
4334
|
+
getThumbnail(): sap.ui.core.Control;
|
|
2792
4335
|
/**
|
|
2793
|
-
*
|
|
4336
|
+
* Sets the aggregated {@link #getContent content}.
|
|
2794
4337
|
*/
|
|
2795
|
-
|
|
2796
|
-
/**
|
|
2797
|
-
* The action to insert; if empty, nothing is inserted
|
|
2798
|
-
*/
|
|
2799
|
-
oAction: sap.ui.webc.main.IButton,
|
|
4338
|
+
setContent(
|
|
2800
4339
|
/**
|
|
2801
|
-
* The
|
|
2802
|
-
* inserted at position 0; for a value greater than the current size of the aggregation, the action is inserted
|
|
2803
|
-
* at the last position
|
|
4340
|
+
* The content to set
|
|
2804
4341
|
*/
|
|
2805
|
-
|
|
4342
|
+
oContent: sap.ui.core.Control
|
|
2806
4343
|
): this;
|
|
2807
4344
|
/**
|
|
2808
|
-
*
|
|
2809
|
-
*/
|
|
2810
|
-
removeAction(
|
|
2811
|
-
/**
|
|
2812
|
-
* The action to remove or its index or id
|
|
2813
|
-
*/
|
|
2814
|
-
vAction: int | string | sap.ui.webc.main.IButton
|
|
2815
|
-
): sap.ui.webc.main.IButton;
|
|
2816
|
-
/**
|
|
2817
|
-
* Removes all the controls from the aggregation {@link #getActions actions}.
|
|
4345
|
+
* Sets a new value for property {@link #getEnabled enabled}.
|
|
2818
4346
|
*
|
|
2819
|
-
*
|
|
2820
|
-
|
|
2821
|
-
removeAllActions(): sap.ui.webc.main.IButton[];
|
|
2822
|
-
/**
|
|
2823
|
-
* Sets a new value for property {@link #getName name}.
|
|
4347
|
+
* Defines whether the control is enabled. A disabled control can't be interacted with, and it is not in
|
|
4348
|
+
* the tab chain.
|
|
2824
4349
|
*
|
|
2825
4350
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2826
4351
|
*
|
|
2827
|
-
* Default value is `
|
|
2828
|
-
*/
|
|
2829
|
-
setName(
|
|
2830
|
-
/**
|
|
2831
|
-
* New value for property `name`
|
|
2832
|
-
*/
|
|
2833
|
-
sName?: sap.ui.webc.fiori.IllustrationMessageType
|
|
2834
|
-
): this;
|
|
2835
|
-
/**
|
|
2836
|
-
* Sets the aggregated {@link #getSubtitle subtitle}.
|
|
4352
|
+
* Default value is `true`.
|
|
2837
4353
|
*/
|
|
2838
|
-
|
|
4354
|
+
setEnabled(
|
|
2839
4355
|
/**
|
|
2840
|
-
*
|
|
4356
|
+
* New value for property `enabled`
|
|
2841
4357
|
*/
|
|
2842
|
-
|
|
4358
|
+
bEnabled?: boolean
|
|
2843
4359
|
): this;
|
|
2844
4360
|
/**
|
|
2845
|
-
* Sets a new value for property {@link #
|
|
2846
|
-
*
|
|
2847
|
-
* Defines the subtitle of the component.
|
|
4361
|
+
* Sets a new value for property {@link #getLayout layout}.
|
|
2848
4362
|
*
|
|
2849
|
-
*
|
|
4363
|
+
* Determines the layout of the item container.
|
|
2850
4364
|
*
|
|
2851
|
-
*
|
|
4365
|
+
* Available options are:
|
|
4366
|
+
* - `Square`
|
|
4367
|
+
* - `Wide`
|
|
2852
4368
|
*
|
|
2853
4369
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2854
4370
|
*
|
|
2855
|
-
* Default value is `
|
|
4371
|
+
* Default value is `Square`.
|
|
2856
4372
|
*/
|
|
2857
|
-
|
|
4373
|
+
setLayout(
|
|
2858
4374
|
/**
|
|
2859
|
-
* New value for property `
|
|
4375
|
+
* New value for property `layout`
|
|
2860
4376
|
*/
|
|
2861
|
-
|
|
4377
|
+
sLayout?: sap.ui.webc.fiori.MediaGalleryItemLayout
|
|
2862
4378
|
): this;
|
|
2863
4379
|
/**
|
|
2864
|
-
* Sets a new value for property {@link #
|
|
2865
|
-
*
|
|
2866
|
-
* Defines the title of the component.
|
|
4380
|
+
* Sets a new value for property {@link #getSelected selected}.
|
|
2867
4381
|
*
|
|
2868
|
-
*
|
|
4382
|
+
* Defines the selected state of the component.
|
|
2869
4383
|
*
|
|
2870
4384
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2871
4385
|
*
|
|
2872
|
-
* Default value is `
|
|
4386
|
+
* Default value is `false`.
|
|
2873
4387
|
*/
|
|
2874
|
-
|
|
4388
|
+
setSelected(
|
|
2875
4389
|
/**
|
|
2876
|
-
* New value for property `
|
|
4390
|
+
* New value for property `selected`
|
|
2877
4391
|
*/
|
|
2878
|
-
|
|
4392
|
+
bSelected?: boolean
|
|
4393
|
+
): this;
|
|
4394
|
+
/**
|
|
4395
|
+
* Sets the aggregated {@link #getThumbnail thumbnail}.
|
|
4396
|
+
*/
|
|
4397
|
+
setThumbnail(
|
|
4398
|
+
/**
|
|
4399
|
+
* The thumbnail to set
|
|
4400
|
+
*/
|
|
4401
|
+
oThumbnail: sap.ui.core.Control
|
|
2879
4402
|
): this;
|
|
2880
4403
|
}
|
|
2881
4404
|
/**
|
|
@@ -2963,15 +4486,14 @@ declare namespace sap {
|
|
|
2963
4486
|
*/
|
|
2964
4487
|
getDesign(): sap.ui.webc.main.ButtonDesign;
|
|
2965
4488
|
/**
|
|
2966
|
-
* Gets current value of property {@link #
|
|
4489
|
+
* Gets current value of property {@link #getEnabled enabled}.
|
|
2967
4490
|
*
|
|
2968
|
-
* Defines
|
|
4491
|
+
* Defines whether the control is enabled. A disabled control can't be interacted with, and it is not in
|
|
4492
|
+
* the tab chain.
|
|
2969
4493
|
*
|
|
2970
|
-
*
|
|
2971
|
-
*
|
|
2972
|
-
* Default value is `false`.
|
|
4494
|
+
* Default value is `true`.
|
|
2973
4495
|
*/
|
|
2974
|
-
|
|
4496
|
+
getEnabled(): boolean;
|
|
2975
4497
|
/**
|
|
2976
4498
|
* Gets current value of property {@link #getIcon icon}.
|
|
2977
4499
|
*
|
|
@@ -3016,21 +4538,20 @@ declare namespace sap {
|
|
|
3016
4538
|
sDesign?: sap.ui.webc.main.ButtonDesign
|
|
3017
4539
|
): this;
|
|
3018
4540
|
/**
|
|
3019
|
-
* Sets a new value for property {@link #
|
|
3020
|
-
*
|
|
3021
|
-
* Defines if the action is disabled.
|
|
4541
|
+
* Sets a new value for property {@link #getEnabled enabled}.
|
|
3022
4542
|
*
|
|
3023
|
-
*
|
|
4543
|
+
* Defines whether the control is enabled. A disabled control can't be interacted with, and it is not in
|
|
4544
|
+
* the tab chain.
|
|
3024
4545
|
*
|
|
3025
4546
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3026
4547
|
*
|
|
3027
|
-
* Default value is `
|
|
4548
|
+
* Default value is `true`.
|
|
3028
4549
|
*/
|
|
3029
|
-
|
|
4550
|
+
setEnabled(
|
|
3030
4551
|
/**
|
|
3031
|
-
* New value for property `
|
|
4552
|
+
* New value for property `enabled`
|
|
3032
4553
|
*/
|
|
3033
|
-
|
|
4554
|
+
bEnabled?: boolean
|
|
3034
4555
|
): this;
|
|
3035
4556
|
/**
|
|
3036
4557
|
* Sets a new value for property {@link #getIcon icon}.
|
|
@@ -4200,34 +5721,16 @@ declare namespace sap {
|
|
|
4200
5721
|
*/
|
|
4201
5722
|
oContent: sap.ui.core.Control
|
|
4202
5723
|
): 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
5724
|
/**
|
|
4222
5725
|
* Destroys all the content in the aggregation {@link #getContent content}.
|
|
4223
5726
|
*/
|
|
4224
5727
|
destroyContent(): this;
|
|
4225
5728
|
/**
|
|
4226
|
-
* Destroys
|
|
5729
|
+
* Destroys the footer in the aggregation {@link #getFooter footer}.
|
|
4227
5730
|
*/
|
|
4228
5731
|
destroyFooter(): this;
|
|
4229
5732
|
/**
|
|
4230
|
-
* Destroys
|
|
5733
|
+
* Destroys the header in the aggregation {@link #getHeader header}.
|
|
4231
5734
|
*/
|
|
4232
5735
|
destroyHeader(): this;
|
|
4233
5736
|
/**
|
|
@@ -4276,13 +5779,13 @@ declare namespace sap {
|
|
|
4276
5779
|
*
|
|
4277
5780
|
* Defines the footer HTML Element.
|
|
4278
5781
|
*/
|
|
4279
|
-
getFooter(): sap.ui.
|
|
5782
|
+
getFooter(): sap.ui.webc.fiori.IBar;
|
|
4280
5783
|
/**
|
|
4281
5784
|
* Gets content of aggregation {@link #getHeader header}.
|
|
4282
5785
|
*
|
|
4283
5786
|
* Defines the header HTML Element.
|
|
4284
5787
|
*/
|
|
4285
|
-
getHeader(): sap.ui.
|
|
5788
|
+
getHeader(): sap.ui.webc.fiori.IBar;
|
|
4286
5789
|
/**
|
|
4287
5790
|
* Gets current value of property {@link #getHeight height}.
|
|
4288
5791
|
*
|
|
@@ -4313,26 +5816,6 @@ declare namespace sap {
|
|
|
4313
5816
|
*/
|
|
4314
5817
|
oContent: sap.ui.core.Control
|
|
4315
5818
|
): 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;
|
|
4326
|
-
/**
|
|
4327
|
-
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getHeader header}. and returns
|
|
4328
|
-
* its index if found or -1 otherwise.
|
|
4329
|
-
*/
|
|
4330
|
-
indexOfHeader(
|
|
4331
|
-
/**
|
|
4332
|
-
* The header whose index is looked for
|
|
4333
|
-
*/
|
|
4334
|
-
oHeader: sap.ui.core.Control
|
|
4335
|
-
): int;
|
|
4336
5819
|
/**
|
|
4337
5820
|
* Inserts a content into the aggregation {@link #getContent content}.
|
|
4338
5821
|
*/
|
|
@@ -4348,54 +5831,12 @@ declare namespace sap {
|
|
|
4348
5831
|
*/
|
|
4349
5832
|
iIndex: int
|
|
4350
5833
|
): 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
5834
|
/**
|
|
4382
5835
|
* Removes all the controls from the aggregation {@link #getContent content}.
|
|
4383
5836
|
*
|
|
4384
5837
|
* Additionally, it unregisters them from the hosting UIArea.
|
|
4385
5838
|
*/
|
|
4386
5839
|
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
5840
|
/**
|
|
4400
5841
|
* Removes a content from the aggregation {@link #getContent content}.
|
|
4401
5842
|
*/
|
|
@@ -4405,24 +5846,6 @@ declare namespace sap {
|
|
|
4405
5846
|
*/
|
|
4406
5847
|
vContent: int | string | sap.ui.core.Control
|
|
4407
5848
|
): 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
5849
|
/**
|
|
4427
5850
|
* Sets a new value for property {@link #getBackgroundDesign backgroundDesign}.
|
|
4428
5851
|
*
|
|
@@ -4479,6 +5902,24 @@ declare namespace sap {
|
|
|
4479
5902
|
*/
|
|
4480
5903
|
bFloatingFooter?: boolean
|
|
4481
5904
|
): this;
|
|
5905
|
+
/**
|
|
5906
|
+
* Sets the aggregated {@link #getFooter footer}.
|
|
5907
|
+
*/
|
|
5908
|
+
setFooter(
|
|
5909
|
+
/**
|
|
5910
|
+
* The footer to set
|
|
5911
|
+
*/
|
|
5912
|
+
oFooter: sap.ui.webc.fiori.IBar
|
|
5913
|
+
): this;
|
|
5914
|
+
/**
|
|
5915
|
+
* Sets the aggregated {@link #getHeader header}.
|
|
5916
|
+
*/
|
|
5917
|
+
setHeader(
|
|
5918
|
+
/**
|
|
5919
|
+
* The header to set
|
|
5920
|
+
*/
|
|
5921
|
+
oHeader: sap.ui.webc.fiori.IBar
|
|
5922
|
+
): this;
|
|
4482
5923
|
/**
|
|
4483
5924
|
* Sets a new value for property {@link #getHeight height}.
|
|
4484
5925
|
*
|
|
@@ -4490,7 +5931,7 @@ declare namespace sap {
|
|
|
4490
5931
|
/**
|
|
4491
5932
|
* New value for property `height`
|
|
4492
5933
|
*/
|
|
4493
|
-
sHeight
|
|
5934
|
+
sHeight: sap.ui.core.CSSSize
|
|
4494
5935
|
): this;
|
|
4495
5936
|
/**
|
|
4496
5937
|
* Sets a new value for property {@link #getHideFooter hideFooter}.
|
|
@@ -4518,7 +5959,7 @@ declare namespace sap {
|
|
|
4518
5959
|
/**
|
|
4519
5960
|
* New value for property `width`
|
|
4520
5961
|
*/
|
|
4521
|
-
sWidth
|
|
5962
|
+
sWidth: sap.ui.core.CSSSize
|
|
4522
5963
|
): this;
|
|
4523
5964
|
}
|
|
4524
5965
|
/**
|
|
@@ -4979,6 +6420,8 @@ declare namespace sap {
|
|
|
4979
6420
|
* allow developers to style elements inside the Shadow DOM.
|
|
4980
6421
|
* The `sap.ui.webc.fiori.ShellBar` exposes the following CSS Shadow Parts:
|
|
4981
6422
|
* - root - Used to style the outermost wrapper of the `sap.ui.webc.fiori.ShellBar`
|
|
6423
|
+
*
|
|
6424
|
+
* Keyboard Handling:
|
|
4982
6425
|
*/
|
|
4983
6426
|
class ShellBar extends sap.ui.webc.common.WebComponent {
|
|
4984
6427
|
/**
|
|
@@ -5143,7 +6586,7 @@ declare namespace sap {
|
|
|
5143
6586
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
5144
6587
|
* otherwise it will be bound to this `sap.ui.webc.fiori.ShellBar` itself.
|
|
5145
6588
|
*
|
|
5146
|
-
* Fired, when a menu item is activated **Note:** You can prevent closing of
|
|
6589
|
+
* Fired, when a menu item is activated **Note:** You can prevent closing of overflow popover by calling
|
|
5147
6590
|
* `event.preventDefault()`.
|
|
5148
6591
|
*/
|
|
5149
6592
|
attachMenuItemClick(
|
|
@@ -5167,7 +6610,7 @@ declare namespace sap {
|
|
|
5167
6610
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
5168
6611
|
* otherwise it will be bound to this `sap.ui.webc.fiori.ShellBar` itself.
|
|
5169
6612
|
*
|
|
5170
|
-
* Fired, when a menu item is activated **Note:** You can prevent closing of
|
|
6613
|
+
* Fired, when a menu item is activated **Note:** You can prevent closing of overflow popover by calling
|
|
5171
6614
|
* `event.preventDefault()`.
|
|
5172
6615
|
*/
|
|
5173
6616
|
attachMenuItemClick(
|
|
@@ -5230,7 +6673,7 @@ declare namespace sap {
|
|
|
5230
6673
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
5231
6674
|
* otherwise it will be bound to this `sap.ui.webc.fiori.ShellBar` itself.
|
|
5232
6675
|
*
|
|
5233
|
-
* Fired, when the product switch icon is activated. **Note:** You can prevent closing of
|
|
6676
|
+
* Fired, when the product switch icon is activated. **Note:** You can prevent closing of overflow popover
|
|
5234
6677
|
* by calling `event.preventDefault()`.
|
|
5235
6678
|
*/
|
|
5236
6679
|
attachProductSwitchClick(
|
|
@@ -5255,7 +6698,7 @@ declare namespace sap {
|
|
|
5255
6698
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
5256
6699
|
* otherwise it will be bound to this `sap.ui.webc.fiori.ShellBar` itself.
|
|
5257
6700
|
*
|
|
5258
|
-
* Fired, when the product switch icon is activated. **Note:** You can prevent closing of
|
|
6701
|
+
* Fired, when the product switch icon is activated. **Note:** You can prevent closing of overflow popover
|
|
5259
6702
|
* by calling `event.preventDefault()`.
|
|
5260
6703
|
*/
|
|
5261
6704
|
attachProductSwitchClick(
|
|
@@ -5521,6 +6964,17 @@ declare namespace sap {
|
|
|
5521
6964
|
targetRef?: HTMLElement;
|
|
5522
6965
|
}
|
|
5523
6966
|
): this;
|
|
6967
|
+
/**
|
|
6968
|
+
* Gets current value of property {@link #getAccessibilityTexts accessibilityTexts}.
|
|
6969
|
+
*
|
|
6970
|
+
* An object of strings that defines several additional accessibility texts for even further customization.
|
|
6971
|
+
*
|
|
6972
|
+
* It supports the following fields: - `profileButtonTitle`: defines the tooltip for the profile button
|
|
6973
|
+
* - `logoTitle`: defines the tooltip for the logo
|
|
6974
|
+
*
|
|
6975
|
+
* Default value is `{}`.
|
|
6976
|
+
*/
|
|
6977
|
+
getAccessibilityTexts(): object;
|
|
5524
6978
|
/**
|
|
5525
6979
|
* Returns the `copilot` DOM ref.
|
|
5526
6980
|
*/
|
|
@@ -5719,12 +7173,30 @@ declare namespace sap {
|
|
|
5719
7173
|
/**
|
|
5720
7174
|
* Removes a menuItem from the aggregation {@link #getMenuItems menuItems}.
|
|
5721
7175
|
*/
|
|
5722
|
-
removeMenuItem(
|
|
7176
|
+
removeMenuItem(
|
|
7177
|
+
/**
|
|
7178
|
+
* The menuItem to remove or its index or id
|
|
7179
|
+
*/
|
|
7180
|
+
vMenuItem: int | string | sap.ui.webc.main.IListItem
|
|
7181
|
+
): sap.ui.webc.main.IListItem;
|
|
7182
|
+
/**
|
|
7183
|
+
* Sets a new value for property {@link #getAccessibilityTexts accessibilityTexts}.
|
|
7184
|
+
*
|
|
7185
|
+
* An object of strings that defines several additional accessibility texts for even further customization.
|
|
7186
|
+
*
|
|
7187
|
+
* It supports the following fields: - `profileButtonTitle`: defines the tooltip for the profile button
|
|
7188
|
+
* - `logoTitle`: defines the tooltip for the logo
|
|
7189
|
+
*
|
|
7190
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
7191
|
+
*
|
|
7192
|
+
* Default value is `{}`.
|
|
7193
|
+
*/
|
|
7194
|
+
setAccessibilityTexts(
|
|
5723
7195
|
/**
|
|
5724
|
-
*
|
|
7196
|
+
* New value for property `accessibilityTexts`
|
|
5725
7197
|
*/
|
|
5726
|
-
|
|
5727
|
-
):
|
|
7198
|
+
oAccessibilityTexts?: object
|
|
7199
|
+
): this;
|
|
5728
7200
|
/**
|
|
5729
7201
|
* Sets the aggregated {@link #getLogo logo}.
|
|
5730
7202
|
*/
|
|
@@ -6085,6 +7557,8 @@ declare namespace sap {
|
|
|
6085
7557
|
* components to build your menu. The items can consist of text only or an icon with text. The use or non-use
|
|
6086
7558
|
* of icons must be consistent for all items on one level. You must not combine entries with and without
|
|
6087
7559
|
* icons on the same level. We strongly recommend that you do not use icons on the second level.
|
|
7560
|
+
*
|
|
7561
|
+
* Keyboard Handling:
|
|
6088
7562
|
*/
|
|
6089
7563
|
class SideNavigation extends sap.ui.webc.common.WebComponent {
|
|
6090
7564
|
/**
|
|
@@ -6243,6 +7717,9 @@ declare namespace sap {
|
|
|
6243
7717
|
): this;
|
|
6244
7718
|
/**
|
|
6245
7719
|
* Fires event {@link #event:selectionChange selectionChange} to attached listeners.
|
|
7720
|
+
*
|
|
7721
|
+
* Listeners may prevent the default action of this event by calling the `preventDefault` method on the
|
|
7722
|
+
* event object. The return value of this method indicates whether the default action should be executed.
|
|
6246
7723
|
*/
|
|
6247
7724
|
fireSelectionChange(
|
|
6248
7725
|
/**
|
|
@@ -6254,7 +7731,7 @@ declare namespace sap {
|
|
|
6254
7731
|
*/
|
|
6255
7732
|
item?: HTMLElement;
|
|
6256
7733
|
}
|
|
6257
|
-
):
|
|
7734
|
+
): boolean;
|
|
6258
7735
|
/**
|
|
6259
7736
|
* Gets current value of property {@link #getCollapsed collapsed}.
|
|
6260
7737
|
*
|
|
@@ -7038,6 +8515,12 @@ declare namespace sap {
|
|
|
7038
8515
|
* Destroys all the items in the aggregation {@link #getItems items}.
|
|
7039
8516
|
*/
|
|
7040
8517
|
destroyItems(): this;
|
|
8518
|
+
/**
|
|
8519
|
+
* Gets current value of property {@link #getAccessibleName accessibleName}.
|
|
8520
|
+
*
|
|
8521
|
+
* Defines the accessible aria name of the component.
|
|
8522
|
+
*/
|
|
8523
|
+
getAccessibleName(): string;
|
|
7041
8524
|
/**
|
|
7042
8525
|
* Gets current value of property {@link #getHeight height}.
|
|
7043
8526
|
*
|
|
@@ -7110,6 +8593,19 @@ declare namespace sap {
|
|
|
7110
8593
|
*/
|
|
7111
8594
|
vItem: int | string | sap.ui.webc.fiori.ITimelineItem
|
|
7112
8595
|
): sap.ui.webc.fiori.ITimelineItem;
|
|
8596
|
+
/**
|
|
8597
|
+
* Sets a new value for property {@link #getAccessibleName accessibleName}.
|
|
8598
|
+
*
|
|
8599
|
+
* Defines the accessible aria name of the component.
|
|
8600
|
+
*
|
|
8601
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
8602
|
+
*/
|
|
8603
|
+
setAccessibleName(
|
|
8604
|
+
/**
|
|
8605
|
+
* New value for property `accessibleName`
|
|
8606
|
+
*/
|
|
8607
|
+
sAccessibleName: string
|
|
8608
|
+
): this;
|
|
7113
8609
|
/**
|
|
7114
8610
|
* Sets a new value for property {@link #getHeight height}.
|
|
7115
8611
|
*
|
|
@@ -7121,7 +8617,7 @@ declare namespace sap {
|
|
|
7121
8617
|
/**
|
|
7122
8618
|
* New value for property `height`
|
|
7123
8619
|
*/
|
|
7124
|
-
sHeight
|
|
8620
|
+
sHeight: sap.ui.core.CSSSize
|
|
7125
8621
|
): this;
|
|
7126
8622
|
/**
|
|
7127
8623
|
* Sets a new value for property {@link #getLayout layout}.
|
|
@@ -7155,7 +8651,7 @@ declare namespace sap {
|
|
|
7155
8651
|
/**
|
|
7156
8652
|
* New value for property `width`
|
|
7157
8653
|
*/
|
|
7158
|
-
sWidth
|
|
8654
|
+
sWidth: sap.ui.core.CSSSize
|
|
7159
8655
|
): this;
|
|
7160
8656
|
}
|
|
7161
8657
|
/**
|
|
@@ -7804,7 +9300,7 @@ declare namespace sap {
|
|
|
7804
9300
|
/**
|
|
7805
9301
|
* Gets current value of property {@link #getAccessibleName accessibleName}.
|
|
7806
9302
|
*
|
|
7807
|
-
*
|
|
9303
|
+
* Defines the accessible aria name of the component.
|
|
7808
9304
|
*
|
|
7809
9305
|
* Default value is `empty string`.
|
|
7810
9306
|
*/
|
|
@@ -7964,7 +9460,7 @@ declare namespace sap {
|
|
|
7964
9460
|
/**
|
|
7965
9461
|
* Sets a new value for property {@link #getAccessibleName accessibleName}.
|
|
7966
9462
|
*
|
|
7967
|
-
*
|
|
9463
|
+
* Defines the accessible aria name of the component.
|
|
7968
9464
|
*
|
|
7969
9465
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
7970
9466
|
*
|
|
@@ -7987,7 +9483,7 @@ declare namespace sap {
|
|
|
7987
9483
|
/**
|
|
7988
9484
|
* New value for property `height`
|
|
7989
9485
|
*/
|
|
7990
|
-
sHeight
|
|
9486
|
+
sHeight: sap.ui.core.CSSSize
|
|
7991
9487
|
): this;
|
|
7992
9488
|
/**
|
|
7993
9489
|
* Sets a new value for property {@link #getHideDragOverlay hideDragOverlay}.
|
|
@@ -8072,7 +9568,7 @@ declare namespace sap {
|
|
|
8072
9568
|
/**
|
|
8073
9569
|
* New value for property `width`
|
|
8074
9570
|
*/
|
|
8075
|
-
sWidth
|
|
9571
|
+
sWidth: sap.ui.core.CSSSize
|
|
8076
9572
|
): this;
|
|
8077
9573
|
}
|
|
8078
9574
|
/**
|
|
@@ -8933,6 +10429,18 @@ declare namespace sap {
|
|
|
8933
10429
|
* The currently selected `sap.ui.webc.fiori.SortItem` text attribute.
|
|
8934
10430
|
*/
|
|
8935
10431
|
sortBy?: string;
|
|
10432
|
+
/**
|
|
10433
|
+
* The currently selected `sap.ui.webc.fiori.SortItem`.
|
|
10434
|
+
*/
|
|
10435
|
+
sortByItem?: HTMLElement;
|
|
10436
|
+
/**
|
|
10437
|
+
* The selected sort order (true = descending, false = ascending).
|
|
10438
|
+
*/
|
|
10439
|
+
sortDescending?: boolean;
|
|
10440
|
+
/**
|
|
10441
|
+
* The selected filters items.
|
|
10442
|
+
*/
|
|
10443
|
+
filterItems?: any[];
|
|
8936
10444
|
}
|
|
8937
10445
|
): this;
|
|
8938
10446
|
/**
|
|
@@ -8951,6 +10459,18 @@ declare namespace sap {
|
|
|
8951
10459
|
* The currently selected `sap.ui.webc.fiori.SortItem` text attribute.
|
|
8952
10460
|
*/
|
|
8953
10461
|
sortBy?: string;
|
|
10462
|
+
/**
|
|
10463
|
+
* The currently selected `sap.ui.webc.fiori.SortItem`.
|
|
10464
|
+
*/
|
|
10465
|
+
sortByItem?: HTMLElement;
|
|
10466
|
+
/**
|
|
10467
|
+
* The selected sort order (true = descending, false = ascending).
|
|
10468
|
+
*/
|
|
10469
|
+
sortDescending?: boolean;
|
|
10470
|
+
/**
|
|
10471
|
+
* The selected filters items.
|
|
10472
|
+
*/
|
|
10473
|
+
filterItems?: any[];
|
|
8954
10474
|
}
|
|
8955
10475
|
): this;
|
|
8956
10476
|
/**
|
|
@@ -9090,6 +10610,16 @@ declare namespace sap {
|
|
|
9090
10610
|
* **Note:** If no selected step is defined, the first step will be auto selected.
|
|
9091
10611
|
* **Note:** If multiple selected steps are defined, the last step will be selected.
|
|
9092
10612
|
*
|
|
10613
|
+
* Keyboard Handling: The user can navigate using the following keyboard shortcuts:
|
|
10614
|
+
*
|
|
10615
|
+
*
|
|
10616
|
+
* Wizard Progress Navigation:
|
|
10617
|
+
* - [LEFT], [DOWN] - Focus moves backward to the WizardProgressNavAnchors.
|
|
10618
|
+
* - [UP], [RIGHT] - Focus moves forward to the WizardProgressNavAnchor.
|
|
10619
|
+
* - [SPACE] or [ENTER], [RETURN] - Selects an active step
|
|
10620
|
+
* - [HOME] or [PAGE UP] - Focus goes to the first step
|
|
10621
|
+
* - [END] or [PAGE DOWN] - Focus goes to the last step
|
|
10622
|
+
*
|
|
9093
10623
|
* Content: The content occupies the main part of the page. It can hold any type of HTML elements. It's
|
|
9094
10624
|
* defined by using the `sap.ui.webc.fiori.WizardStep` as slotted element within the `sap.ui.webc.fiori.Wizard`.
|
|
9095
10625
|
*
|
|
@@ -9344,7 +10874,7 @@ declare namespace sap {
|
|
|
9344
10874
|
/**
|
|
9345
10875
|
* New value for property `height`
|
|
9346
10876
|
*/
|
|
9347
|
-
sHeight
|
|
10877
|
+
sHeight: sap.ui.core.CSSSize
|
|
9348
10878
|
): this;
|
|
9349
10879
|
}
|
|
9350
10880
|
/**
|
|
@@ -9459,19 +10989,14 @@ declare namespace sap {
|
|
|
9459
10989
|
*/
|
|
9460
10990
|
getContent(): sap.ui.core.Control[];
|
|
9461
10991
|
/**
|
|
9462
|
-
* Gets current value of property {@link #
|
|
9463
|
-
*
|
|
9464
|
-
* Defines if the step is `disabled`. When disabled the step is displayed, but the user can't select the
|
|
9465
|
-
* step by clicking or navigate to it with scrolling.
|
|
10992
|
+
* Gets current value of property {@link #getEnabled enabled}.
|
|
9466
10993
|
*
|
|
10994
|
+
* Defines whether the control is enabled. A disabled control can't be interacted with, and it is not in
|
|
10995
|
+
* the tab chain.
|
|
9467
10996
|
*
|
|
9468
|
-
*
|
|
9469
|
-
* **Note:** Step can't be `selected` and `disabled` at the same time. In this case the `selected` property
|
|
9470
|
-
* would take precedence.
|
|
9471
|
-
*
|
|
9472
|
-
* Default value is `false`.
|
|
10997
|
+
* Default value is `true`.
|
|
9473
10998
|
*/
|
|
9474
|
-
|
|
10999
|
+
getEnabled(): boolean;
|
|
9475
11000
|
/**
|
|
9476
11001
|
* Gets current value of property {@link #getIcon icon}.
|
|
9477
11002
|
*
|
|
@@ -9587,25 +11112,20 @@ declare namespace sap {
|
|
|
9587
11112
|
bBranching?: boolean
|
|
9588
11113
|
): this;
|
|
9589
11114
|
/**
|
|
9590
|
-
* Sets a new value for property {@link #
|
|
9591
|
-
*
|
|
9592
|
-
* Defines if the step is `disabled`. When disabled the step is displayed, but the user can't select the
|
|
9593
|
-
* step by clicking or navigate to it with scrolling.
|
|
9594
|
-
*
|
|
11115
|
+
* Sets a new value for property {@link #getEnabled enabled}.
|
|
9595
11116
|
*
|
|
9596
|
-
*
|
|
9597
|
-
*
|
|
9598
|
-
* would take precedence.
|
|
11117
|
+
* Defines whether the control is enabled. A disabled control can't be interacted with, and it is not in
|
|
11118
|
+
* the tab chain.
|
|
9599
11119
|
*
|
|
9600
11120
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
9601
11121
|
*
|
|
9602
|
-
* Default value is `
|
|
11122
|
+
* Default value is `true`.
|
|
9603
11123
|
*/
|
|
9604
|
-
|
|
11124
|
+
setEnabled(
|
|
9605
11125
|
/**
|
|
9606
|
-
* New value for property `
|
|
11126
|
+
* New value for property `enabled`
|
|
9607
11127
|
*/
|
|
9608
|
-
|
|
11128
|
+
bEnabled?: boolean
|
|
9609
11129
|
): this;
|
|
9610
11130
|
/**
|
|
9611
11131
|
* Sets a new value for property {@link #getIcon icon}.
|
|
@@ -9794,41 +11314,241 @@ declare namespace sap {
|
|
|
9794
11314
|
*/
|
|
9795
11315
|
enum IllustrationMessageType {
|
|
9796
11316
|
/**
|
|
9797
|
-
* "
|
|
11317
|
+
* "Add Column" illustration type.
|
|
11318
|
+
*/
|
|
11319
|
+
AddColumn = "AddColumn",
|
|
11320
|
+
/**
|
|
11321
|
+
* "Add People" illustration type.
|
|
11322
|
+
*/
|
|
11323
|
+
AddPeople = "AddPeople",
|
|
11324
|
+
/**
|
|
11325
|
+
* "Balloon Sky" illustration type.
|
|
11326
|
+
*/
|
|
11327
|
+
BalloonSky = "BalloonSky",
|
|
11328
|
+
/**
|
|
11329
|
+
* "Before Search" illustration type.
|
|
9798
11330
|
*/
|
|
9799
11331
|
BeforeSearch = "BeforeSearch",
|
|
9800
11332
|
/**
|
|
9801
|
-
* "
|
|
11333
|
+
* "Connection" illustration type.
|
|
11334
|
+
*/
|
|
11335
|
+
Connection = "Connection",
|
|
11336
|
+
/**
|
|
11337
|
+
* "Empty Calendar" illustration type.
|
|
11338
|
+
*/
|
|
11339
|
+
EmptyCalendar = "EmptyCalendar",
|
|
11340
|
+
/**
|
|
11341
|
+
* "Empty List" illustration type.
|
|
11342
|
+
*/
|
|
11343
|
+
EmptyList = "EmptyList",
|
|
11344
|
+
/**
|
|
11345
|
+
* "Empty Planning Calendar" illustration type.
|
|
11346
|
+
*/
|
|
11347
|
+
EmptyPlanningCalendar = "EmptyPlanningCalendar",
|
|
11348
|
+
/**
|
|
11349
|
+
* "Error Screen" illustration type.
|
|
11350
|
+
*/
|
|
11351
|
+
ErrorScreen = "ErrorScreen",
|
|
11352
|
+
/**
|
|
11353
|
+
* "Filter Table" illustration type.
|
|
11354
|
+
*/
|
|
11355
|
+
FilterTable = "FilterTable",
|
|
11356
|
+
/**
|
|
11357
|
+
* "Group Table" illustration type.
|
|
11358
|
+
*/
|
|
11359
|
+
GroupTable = "GroupTable",
|
|
11360
|
+
/**
|
|
11361
|
+
* "No Activities" illustration type.
|
|
9802
11362
|
*/
|
|
9803
11363
|
NoActivities = "NoActivities",
|
|
9804
11364
|
/**
|
|
9805
|
-
* "
|
|
11365
|
+
* "No Data" illustration type.
|
|
9806
11366
|
*/
|
|
9807
11367
|
NoData = "NoData",
|
|
9808
11368
|
/**
|
|
9809
|
-
* "
|
|
11369
|
+
* "No Entries" illustration type.
|
|
9810
11370
|
*/
|
|
9811
11371
|
NoEntries = "NoEntries",
|
|
9812
11372
|
/**
|
|
9813
|
-
* "
|
|
11373
|
+
* "No Filter Results" illustration type.
|
|
11374
|
+
*/
|
|
11375
|
+
NoFilterResults = "NoFilterResults",
|
|
11376
|
+
/**
|
|
11377
|
+
* "No Email" illustration type.
|
|
9814
11378
|
*/
|
|
9815
11379
|
NoMail = "NoMail",
|
|
9816
11380
|
/**
|
|
9817
|
-
* "
|
|
11381
|
+
* "No Email v1" illustration type.
|
|
11382
|
+
*/
|
|
11383
|
+
NoMail_v1 = "NoMail_v1",
|
|
11384
|
+
/**
|
|
11385
|
+
* "No Notifications" illustration type.
|
|
9818
11386
|
*/
|
|
9819
11387
|
NoNotifications = "NoNotifications",
|
|
9820
11388
|
/**
|
|
9821
|
-
* "
|
|
11389
|
+
* "No Saved Items" illustration type.
|
|
9822
11390
|
*/
|
|
9823
11391
|
NoSavedItems = "NoSavedItems",
|
|
9824
11392
|
/**
|
|
9825
|
-
* "
|
|
11393
|
+
* "No Saved Items v1" illustration type.
|
|
11394
|
+
*/
|
|
11395
|
+
NoSavedItems_v1 = "NoSavedItems_v1",
|
|
11396
|
+
/**
|
|
11397
|
+
* "No Search Results" illustration type.
|
|
9826
11398
|
*/
|
|
9827
11399
|
NoSearchResults = "NoSearchResults",
|
|
9828
11400
|
/**
|
|
9829
|
-
* "
|
|
11401
|
+
* "No Tasks" illustration type.
|
|
9830
11402
|
*/
|
|
9831
11403
|
NoTasks = "NoTasks",
|
|
11404
|
+
/**
|
|
11405
|
+
* "No Tasks v1" illustration type.
|
|
11406
|
+
*/
|
|
11407
|
+
NoTasks_v1 = "NoTasks_v1",
|
|
11408
|
+
/**
|
|
11409
|
+
* "Page Not Found" illustration type.
|
|
11410
|
+
*/
|
|
11411
|
+
PageNotFound = "PageNotFound",
|
|
11412
|
+
/**
|
|
11413
|
+
* "Reload Screen" illustration type.
|
|
11414
|
+
*/
|
|
11415
|
+
ReloadScreen = "ReloadScreen",
|
|
11416
|
+
/**
|
|
11417
|
+
* "Resize Column" illustration type.
|
|
11418
|
+
*/
|
|
11419
|
+
ResizeColumn = "ResizeColumn",
|
|
11420
|
+
/**
|
|
11421
|
+
* "Search Earth" illustration type.
|
|
11422
|
+
*/
|
|
11423
|
+
SearchEarth = "SearchEarth",
|
|
11424
|
+
/**
|
|
11425
|
+
* "Search Folder" illustration type.
|
|
11426
|
+
*/
|
|
11427
|
+
SearchFolder = "SearchFolder",
|
|
11428
|
+
/**
|
|
11429
|
+
* "Simple Balloon" illustration type.
|
|
11430
|
+
*/
|
|
11431
|
+
SimpleBalloon = "SimpleBalloon",
|
|
11432
|
+
/**
|
|
11433
|
+
* "Simple Bell" illustration type.
|
|
11434
|
+
*/
|
|
11435
|
+
SimpleBell = "SimpleBell",
|
|
11436
|
+
/**
|
|
11437
|
+
* "Simple Calendar" illustration type.
|
|
11438
|
+
*/
|
|
11439
|
+
SimpleCalendar = "SimpleCalendar",
|
|
11440
|
+
/**
|
|
11441
|
+
* "Simple CheckMark" illustration type.
|
|
11442
|
+
*/
|
|
11443
|
+
SimpleCheckMark = "SimpleCheckMark",
|
|
11444
|
+
/**
|
|
11445
|
+
* "Simple Connection" illustration type.
|
|
11446
|
+
*/
|
|
11447
|
+
SimpleConnection = "SimpleConnection",
|
|
11448
|
+
/**
|
|
11449
|
+
* "Simple Empty Doc" illustration type.
|
|
11450
|
+
*/
|
|
11451
|
+
SimpleEmptyDoc = "SimpleEmptyDoc",
|
|
11452
|
+
/**
|
|
11453
|
+
* "Simple Empty List" illustration type.
|
|
11454
|
+
*/
|
|
11455
|
+
SimpleEmptyList = "SimpleEmptyList",
|
|
11456
|
+
/**
|
|
11457
|
+
* "Simple Error" illustration type.
|
|
11458
|
+
*/
|
|
11459
|
+
SimpleError = "SimpleError",
|
|
11460
|
+
/**
|
|
11461
|
+
* "Simple Magnifier" illustration type.
|
|
11462
|
+
*/
|
|
11463
|
+
SimpleMagnifier = "SimpleMagnifier",
|
|
11464
|
+
/**
|
|
11465
|
+
* "Simple Mail" illustration type.
|
|
11466
|
+
*/
|
|
11467
|
+
SimpleMail = "SimpleMail",
|
|
11468
|
+
/**
|
|
11469
|
+
* "Simple No Saved Items" illustration type.
|
|
11470
|
+
*/
|
|
11471
|
+
SimpleNoSavedItems = "SimpleNoSavedItems",
|
|
11472
|
+
/**
|
|
11473
|
+
* "Simple Not Found Magnifier" illustration type.
|
|
11474
|
+
*/
|
|
11475
|
+
SimpleNotFoundMagnifier = "SimpleNotFoundMagnifier",
|
|
11476
|
+
/**
|
|
11477
|
+
* "Simple Reload" illustration type.
|
|
11478
|
+
*/
|
|
11479
|
+
SimpleReload = "SimpleReload",
|
|
11480
|
+
/**
|
|
11481
|
+
* "Simple Task" illustration type.
|
|
11482
|
+
*/
|
|
11483
|
+
SimpleTask = "SimpleTask",
|
|
11484
|
+
/**
|
|
11485
|
+
* "Sleeping Bell" illustration type.
|
|
11486
|
+
*/
|
|
11487
|
+
SleepingBell = "SleepingBell",
|
|
11488
|
+
/**
|
|
11489
|
+
* "Sort Column" illustration type.
|
|
11490
|
+
*/
|
|
11491
|
+
SortColumn = "SortColumn",
|
|
11492
|
+
/**
|
|
11493
|
+
* "Success Balloon" illustration type.
|
|
11494
|
+
*/
|
|
11495
|
+
SuccessBalloon = "SuccessBalloon",
|
|
11496
|
+
/**
|
|
11497
|
+
* "Success CheckMark" illustration type.
|
|
11498
|
+
*/
|
|
11499
|
+
SuccessCheckMark = "SuccessCheckMark",
|
|
11500
|
+
/**
|
|
11501
|
+
* "Success HighFive" illustration type.
|
|
11502
|
+
*/
|
|
11503
|
+
SuccessHighFive = "SuccessHighFive",
|
|
11504
|
+
/**
|
|
11505
|
+
* "Success Screen" illustration type.
|
|
11506
|
+
*/
|
|
11507
|
+
SuccessScreen = "SuccessScreen",
|
|
11508
|
+
/**
|
|
11509
|
+
* "Tent" illustration type.
|
|
11510
|
+
*/
|
|
11511
|
+
Tent = "Tent",
|
|
11512
|
+
/**
|
|
11513
|
+
* "TntChartArea" illustration type.
|
|
11514
|
+
*/
|
|
11515
|
+
TntChartArea = "TntChartArea",
|
|
11516
|
+
/**
|
|
11517
|
+
* "TntChartArea2" illustration type.
|
|
11518
|
+
*/
|
|
11519
|
+
TntChartArea2 = "TntChartArea2",
|
|
11520
|
+
/**
|
|
11521
|
+
* "TntChartBar" illustration type.
|
|
11522
|
+
*/
|
|
11523
|
+
TntChartBar = "TntChartBar",
|
|
11524
|
+
/**
|
|
11525
|
+
* "TntChartBPMNFlow" illustration type.
|
|
11526
|
+
*/
|
|
11527
|
+
TntChartBPMNFlow = "TntChartBPMNFlow",
|
|
11528
|
+
/**
|
|
11529
|
+
* "TntChartBullet" illustration type.
|
|
11530
|
+
*/
|
|
11531
|
+
TntChartBullet = "TntChartBullet",
|
|
11532
|
+
/**
|
|
11533
|
+
* "TntChartDoughnut" illustration type.
|
|
11534
|
+
*/
|
|
11535
|
+
TntChartDoughnut = "TntChartDoughnut",
|
|
11536
|
+
/**
|
|
11537
|
+
* "TntChartFlow" illustration type.
|
|
11538
|
+
*/
|
|
11539
|
+
TntChartFlow = "TntChartFlow",
|
|
11540
|
+
/**
|
|
11541
|
+
* "TntChartGantt" illustration type.
|
|
11542
|
+
*/
|
|
11543
|
+
TntChartGantt = "TntChartGantt",
|
|
11544
|
+
/**
|
|
11545
|
+
* "TntChartOrg" illustration type.
|
|
11546
|
+
*/
|
|
11547
|
+
TntChartOrg = "TntChartOrg",
|
|
11548
|
+
/**
|
|
11549
|
+
* "TntChartPie" illustration type.
|
|
11550
|
+
*/
|
|
11551
|
+
TntChartPie = "TntChartPie",
|
|
9832
11552
|
/**
|
|
9833
11553
|
* "TntCodePlaceholder" illustration type.
|
|
9834
11554
|
*/
|
|
@@ -9837,6 +11557,10 @@ declare namespace sap {
|
|
|
9837
11557
|
* "TntCompany" illustration type.
|
|
9838
11558
|
*/
|
|
9839
11559
|
TntCompany = "TntCompany",
|
|
11560
|
+
/**
|
|
11561
|
+
* "TntComponents" illustration type.
|
|
11562
|
+
*/
|
|
11563
|
+
TntComponents = "TntComponents",
|
|
9840
11564
|
/**
|
|
9841
11565
|
* "TntExternalLink" illustration type.
|
|
9842
11566
|
*/
|
|
@@ -9873,6 +11597,10 @@ declare namespace sap {
|
|
|
9873
11597
|
* "TntRadar" illustration type.
|
|
9874
11598
|
*/
|
|
9875
11599
|
TntRadar = "TntRadar",
|
|
11600
|
+
/**
|
|
11601
|
+
* "TntSecrets" illustration type.
|
|
11602
|
+
*/
|
|
11603
|
+
TntSecrets = "TntSecrets",
|
|
9876
11604
|
/**
|
|
9877
11605
|
* "TntServices" illustration type.
|
|
9878
11606
|
*/
|
|
@@ -9893,6 +11621,22 @@ declare namespace sap {
|
|
|
9893
11621
|
* "TntSuccessfulAuth" illustration type.
|
|
9894
11622
|
*/
|
|
9895
11623
|
TntSuccessfulAuth = "TntSuccessfulAuth",
|
|
11624
|
+
/**
|
|
11625
|
+
* "TntSystems" illustration type.
|
|
11626
|
+
*/
|
|
11627
|
+
TntSystems = "TntSystems",
|
|
11628
|
+
/**
|
|
11629
|
+
* "TntTeams" illustration type.
|
|
11630
|
+
*/
|
|
11631
|
+
TntTeams = "TntTeams",
|
|
11632
|
+
/**
|
|
11633
|
+
* "TntTools" illustration type.
|
|
11634
|
+
*/
|
|
11635
|
+
TntTools = "TntTools",
|
|
11636
|
+
/**
|
|
11637
|
+
* "TntUnableToLoad" illustration type.
|
|
11638
|
+
*/
|
|
11639
|
+
TntUnableToLoad = "TntUnableToLoad",
|
|
9896
11640
|
/**
|
|
9897
11641
|
* "TntUnlock" illustration type.
|
|
9898
11642
|
*/
|
|
@@ -9902,13 +11646,97 @@ declare namespace sap {
|
|
|
9902
11646
|
*/
|
|
9903
11647
|
TntUnsuccessfulAuth = "TntUnsuccessfulAuth",
|
|
9904
11648
|
/**
|
|
9905
|
-
* "
|
|
11649
|
+
* "TntUser2" illustration type.
|
|
11650
|
+
*/
|
|
11651
|
+
TntUser2 = "TntUser2",
|
|
11652
|
+
/**
|
|
11653
|
+
* "Unable To Load" illustration type.
|
|
9906
11654
|
*/
|
|
9907
11655
|
UnableToLoad = "UnableToLoad",
|
|
9908
11656
|
/**
|
|
9909
|
-
* "
|
|
11657
|
+
* "Unable To Load Image" illustration type.
|
|
11658
|
+
*/
|
|
11659
|
+
UnableToLoadImage = "UnableToLoadImage",
|
|
11660
|
+
/**
|
|
11661
|
+
* "Unable To Upload" illustration type.
|
|
9910
11662
|
*/
|
|
9911
11663
|
UnableToUpload = "UnableToUpload",
|
|
11664
|
+
/**
|
|
11665
|
+
* "Upload Collection" illustration type.
|
|
11666
|
+
*/
|
|
11667
|
+
UploadCollection = "UploadCollection",
|
|
11668
|
+
}
|
|
11669
|
+
/**
|
|
11670
|
+
* @SINCE 1.99.0
|
|
11671
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
11672
|
+
*
|
|
11673
|
+
* Defines the layout of the content displayed in the `ui5-media-gallery-item`.
|
|
11674
|
+
*/
|
|
11675
|
+
enum MediaGalleryItemLayout {
|
|
11676
|
+
/**
|
|
11677
|
+
* Recommended to use when the item contains an image.
|
|
11678
|
+
* When a thumbnail is selected, it makes the corresponding enlarged content appear in a square display
|
|
11679
|
+
* area.
|
|
11680
|
+
*/
|
|
11681
|
+
Square = "Square",
|
|
11682
|
+
/**
|
|
11683
|
+
* Recommended to use when the item contains video content.
|
|
11684
|
+
* When a thumbnail is selected, it makes the corresponding enlarged content appear in a wide display area
|
|
11685
|
+
* (stretched to fill all of the available width) for optimal user experiance.
|
|
11686
|
+
*/
|
|
11687
|
+
Wide = "Wide",
|
|
11688
|
+
}
|
|
11689
|
+
/**
|
|
11690
|
+
* @SINCE 1.99.0
|
|
11691
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
11692
|
+
*
|
|
11693
|
+
* Defines the layout type of the thumbnails list of the `ui5-media-gallery` component.
|
|
11694
|
+
*/
|
|
11695
|
+
enum MediaGalleryLayout {
|
|
11696
|
+
/**
|
|
11697
|
+
* The layout is determined automatically.
|
|
11698
|
+
*/
|
|
11699
|
+
Auto = "Auto",
|
|
11700
|
+
/**
|
|
11701
|
+
* Displays the layout as a horizontal split between the thumbnails list and the selected image.
|
|
11702
|
+
*/
|
|
11703
|
+
Horizontal = "Horizontal",
|
|
11704
|
+
/**
|
|
11705
|
+
* Displays the layout as a vertical split between the thumbnails list and the selected image.
|
|
11706
|
+
*/
|
|
11707
|
+
Vertical = "Vertical",
|
|
11708
|
+
}
|
|
11709
|
+
/**
|
|
11710
|
+
* @SINCE 1.99.0
|
|
11711
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
11712
|
+
*
|
|
11713
|
+
* Defines the horizontal alignment of the thumbnails menu of the `ui5-media-gallery` component.
|
|
11714
|
+
*/
|
|
11715
|
+
enum MediaGalleryMenuHorizontalAlign {
|
|
11716
|
+
/**
|
|
11717
|
+
* Displays the menu on the left side of the target.
|
|
11718
|
+
*/
|
|
11719
|
+
Left = "Left",
|
|
11720
|
+
/**
|
|
11721
|
+
* Displays the menu on the right side of the target.
|
|
11722
|
+
*/
|
|
11723
|
+
Right = "Right",
|
|
11724
|
+
}
|
|
11725
|
+
/**
|
|
11726
|
+
* @SINCE 1.99.0
|
|
11727
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
11728
|
+
*
|
|
11729
|
+
* Types for the vertical alignment of the thumbnails menu of the `ui5-media-gallery` component.
|
|
11730
|
+
*/
|
|
11731
|
+
enum MediaGalleryMenuVerticalAlign {
|
|
11732
|
+
/**
|
|
11733
|
+
* Displays the menu at the bottom of the reference control.
|
|
11734
|
+
*/
|
|
11735
|
+
Bottom = "Bottom",
|
|
11736
|
+
/**
|
|
11737
|
+
* Displays the menu at the top of the reference control.
|
|
11738
|
+
*/
|
|
11739
|
+
Top = "Top",
|
|
9912
11740
|
}
|
|
9913
11741
|
/**
|
|
9914
11742
|
* @SINCE 1.92.0
|
|
@@ -9930,6 +11758,76 @@ declare namespace sap {
|
|
|
9930
11758
|
*/
|
|
9931
11759
|
Transparent = "Transparent",
|
|
9932
11760
|
}
|
|
11761
|
+
/**
|
|
11762
|
+
* @SINCE 1.99.0
|
|
11763
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
11764
|
+
*
|
|
11765
|
+
* SideContent FallDown options.
|
|
11766
|
+
*/
|
|
11767
|
+
enum SideContentFallDown {
|
|
11768
|
+
/**
|
|
11769
|
+
* Side content falls down on breakpoints below L
|
|
11770
|
+
*/
|
|
11771
|
+
BelowL = "BelowL",
|
|
11772
|
+
/**
|
|
11773
|
+
* Side content falls down on breakpoints below M
|
|
11774
|
+
*/
|
|
11775
|
+
BelowM = "BelowM",
|
|
11776
|
+
/**
|
|
11777
|
+
* Side content falls down on breakpoints below XL
|
|
11778
|
+
*/
|
|
11779
|
+
BelowXL = "BelowXL",
|
|
11780
|
+
/**
|
|
11781
|
+
* Side content falls down on breakpoint M and the minimum width for the side content
|
|
11782
|
+
*/
|
|
11783
|
+
OnMinimumWidth = "OnMinimumWidth",
|
|
11784
|
+
}
|
|
11785
|
+
/**
|
|
11786
|
+
* @SINCE 1.99.0
|
|
11787
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
11788
|
+
*
|
|
11789
|
+
* Side Content position options.
|
|
11790
|
+
*/
|
|
11791
|
+
enum SideContentPosition {
|
|
11792
|
+
/**
|
|
11793
|
+
* The side content is on the right side of the main container in left-to-right mode and on the left side
|
|
11794
|
+
* in right-to-left mode.
|
|
11795
|
+
*/
|
|
11796
|
+
End = "End",
|
|
11797
|
+
/**
|
|
11798
|
+
* The side content is on the left side of the main container in left-to-right mode and on the right side
|
|
11799
|
+
* in right-to-left mode.
|
|
11800
|
+
*/
|
|
11801
|
+
Start = "Start",
|
|
11802
|
+
}
|
|
11803
|
+
/**
|
|
11804
|
+
* @SINCE 1.99.0
|
|
11805
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
11806
|
+
*
|
|
11807
|
+
* Side Content visibility options.
|
|
11808
|
+
*/
|
|
11809
|
+
enum SideContentVisibility {
|
|
11810
|
+
/**
|
|
11811
|
+
* Show the side content on any breakpoint
|
|
11812
|
+
*/
|
|
11813
|
+
AlwaysShow = "AlwaysShow",
|
|
11814
|
+
/**
|
|
11815
|
+
* Don't show the side content on any breakpoints
|
|
11816
|
+
*/
|
|
11817
|
+
NeverShow = "NeverShow",
|
|
11818
|
+
/**
|
|
11819
|
+
* Show the side content on XL breakpoint
|
|
11820
|
+
*/
|
|
11821
|
+
ShowAboveL = "ShowAboveL",
|
|
11822
|
+
/**
|
|
11823
|
+
* Show the side content on L and XL breakpoints
|
|
11824
|
+
*/
|
|
11825
|
+
ShowAboveM = "ShowAboveM",
|
|
11826
|
+
/**
|
|
11827
|
+
* Show the side content on M, L and XL breakpoints
|
|
11828
|
+
*/
|
|
11829
|
+
ShowAboveS = "ShowAboveS",
|
|
11830
|
+
}
|
|
9933
11831
|
/**
|
|
9934
11832
|
* @SINCE 1.92.0
|
|
9935
11833
|
* @EXPERIMENTAL (since 1.92.0)
|
|
@@ -9979,6 +11877,8 @@ declare namespace sap {
|
|
|
9979
11877
|
|
|
9980
11878
|
"sap/ui/webc/fiori/BarcodeScannerDialog": undefined;
|
|
9981
11879
|
|
|
11880
|
+
"sap/ui/webc/fiori/DynamicSideContent": undefined;
|
|
11881
|
+
|
|
9982
11882
|
"sap/ui/webc/fiori/FilterItem": undefined;
|
|
9983
11883
|
|
|
9984
11884
|
"sap/ui/webc/fiori/FilterItemOption": undefined;
|
|
@@ -9989,6 +11889,10 @@ declare namespace sap {
|
|
|
9989
11889
|
|
|
9990
11890
|
"sap/ui/webc/fiori/library": undefined;
|
|
9991
11891
|
|
|
11892
|
+
"sap/ui/webc/fiori/MediaGallery": undefined;
|
|
11893
|
+
|
|
11894
|
+
"sap/ui/webc/fiori/MediaGalleryItem": undefined;
|
|
11895
|
+
|
|
9992
11896
|
"sap/ui/webc/fiori/NotificationAction": undefined;
|
|
9993
11897
|
|
|
9994
11898
|
"sap/ui/webc/fiori/NotificationListGroupItem": undefined;
|