@openui5/ts-types 1.96.5 → 1.99.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/types/sap.f.d.ts +263 -636
- package/types/sap.m.d.ts +4057 -318
- package/types/sap.tnt.d.ts +4 -4
- package/types/sap.ui.codeeditor.d.ts +7 -1
- package/types/sap.ui.commons.d.ts +1 -1
- package/types/sap.ui.core.d.ts +1709 -490
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.fl.d.ts +13 -7
- package/types/sap.ui.integration.d.ts +68 -9
- package/types/sap.ui.layout.d.ts +7 -4
- package/types/sap.ui.mdc.d.ts +35 -15
- package/types/sap.ui.rta.d.ts +5 -11
- package/types/sap.ui.suite.d.ts +1 -1
- package/types/sap.ui.support.d.ts +6 -6
- package/types/sap.ui.table.d.ts +32 -3
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +43 -1
- package/types/sap.ui.ux3.d.ts +1 -1
- package/types/sap.ui.webc.common.d.ts +1 -1
- package/types/sap.ui.webc.fiori.d.ts +3015 -581
- package/types/sap.ui.webc.main.d.ts +3286 -986
- package/types/sap.uxap.d.ts +1 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.
|
|
1
|
+
// For Library Version: 1.99.0
|
|
2
2
|
|
|
3
3
|
declare namespace sap {
|
|
4
4
|
namespace ui {
|
|
@@ -10,6 +10,46 @@ 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
|
+
|
|
23
|
+
/**
|
|
24
|
+
* @SINCE 1.97.0
|
|
25
|
+
* @EXPERIMENTAL (since 1.97.0)
|
|
26
|
+
*
|
|
27
|
+
* Interface for components that may be slotted inside `ui5-view-settings-dialog` as filter items
|
|
28
|
+
*/
|
|
29
|
+
interface IFilterItem {
|
|
30
|
+
__implements__sap_ui_webc_fiori_IFilterItem: boolean;
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
/**
|
|
34
|
+
* @SINCE 1.97.0
|
|
35
|
+
* @EXPERIMENTAL (since 1.97.0)
|
|
36
|
+
*
|
|
37
|
+
* Interface for components that may be slotted inside `ui5-filter-item` as values
|
|
38
|
+
*/
|
|
39
|
+
interface IFilterItemOption {
|
|
40
|
+
__implements__sap_ui_webc_fiori_IFilterItemOption: boolean;
|
|
41
|
+
}
|
|
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
|
+
|
|
13
53
|
/**
|
|
14
54
|
* @SINCE 1.92.0
|
|
15
55
|
* @EXPERIMENTAL (since 1.92.0)
|
|
@@ -70,6 +110,16 @@ declare namespace sap {
|
|
|
70
110
|
__implements__sap_ui_webc_fiori_ISideNavigationSubItem: boolean;
|
|
71
111
|
}
|
|
72
112
|
|
|
113
|
+
/**
|
|
114
|
+
* @SINCE 1.97.0
|
|
115
|
+
* @EXPERIMENTAL (since 1.97.0)
|
|
116
|
+
*
|
|
117
|
+
* Interface for components that may be slotted inside `ui5-view-settings-dialog` as sort items
|
|
118
|
+
*/
|
|
119
|
+
interface ISortItem {
|
|
120
|
+
__implements__sap_ui_webc_fiori_ISortItem: boolean;
|
|
121
|
+
}
|
|
122
|
+
|
|
73
123
|
/**
|
|
74
124
|
* @SINCE 1.92.0
|
|
75
125
|
* @EXPERIMENTAL (since 1.92.0)
|
|
@@ -162,10 +212,148 @@ declare namespace sap {
|
|
|
162
212
|
scanSuccess?: (oEvent: sap.ui.base.Event) => void;
|
|
163
213
|
}
|
|
164
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
|
+
|
|
311
|
+
interface $FilterItemSettings
|
|
312
|
+
extends sap.ui.webc.common.$WebComponentSettings {
|
|
313
|
+
/**
|
|
314
|
+
* Defines the text of the component.
|
|
315
|
+
*/
|
|
316
|
+
text?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
317
|
+
|
|
318
|
+
/**
|
|
319
|
+
* Defines the `values` list.
|
|
320
|
+
*/
|
|
321
|
+
values?:
|
|
322
|
+
| sap.ui.webc.fiori.IFilterItemOption[]
|
|
323
|
+
| sap.ui.webc.fiori.IFilterItemOption
|
|
324
|
+
| sap.ui.base.ManagedObject.AggregationBindingInfo;
|
|
325
|
+
}
|
|
326
|
+
|
|
327
|
+
interface $FilterItemOptionSettings
|
|
328
|
+
extends sap.ui.webc.common.$WebComponentSettings {
|
|
329
|
+
/**
|
|
330
|
+
* Defines whether the option is selected
|
|
331
|
+
*/
|
|
332
|
+
selected?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
333
|
+
|
|
334
|
+
/**
|
|
335
|
+
* Defines the text of the component.
|
|
336
|
+
*/
|
|
337
|
+
text?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
338
|
+
}
|
|
339
|
+
|
|
165
340
|
interface $FlexibleColumnLayoutSettings
|
|
166
341
|
extends sap.ui.webc.common.$WebComponentSettings {
|
|
167
342
|
/**
|
|
168
|
-
*
|
|
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
|
+
|
|
355
|
+
/**
|
|
356
|
+
* An object of strings that defines several additional accessibility texts for even further customization.
|
|
169
357
|
*
|
|
170
358
|
* It supports the following fields: - `startColumnAccessibleName`: the accessibility name for the `startColumn`
|
|
171
359
|
* region - `midColumnAccessibleName`: the accessibility name for the `midColumn` region - `endColumnAccessibleName`:
|
|
@@ -174,7 +362,9 @@ declare namespace sap {
|
|
|
174
362
|
* the text that the first arrow (between the `begin` and `mid` columns) will have when pointing to the
|
|
175
363
|
* right - `endArrowLeftText`: the text that the second arrow (between the `mid` and `end` columns) will
|
|
176
364
|
* have when pointing to the left - `endArrowRightText`: the text that the second arrow (between the `mid`
|
|
177
|
-
* 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`
|
|
178
368
|
*/
|
|
179
369
|
accessibilityTexts?:
|
|
180
370
|
| object
|
|
@@ -284,6 +474,131 @@ declare namespace sap {
|
|
|
284
474
|
subtitle?: sap.ui.core.Control;
|
|
285
475
|
}
|
|
286
476
|
|
|
477
|
+
interface $MediaGallerySettings
|
|
478
|
+
extends sap.ui.webc.common.$WebComponentSettings {
|
|
479
|
+
/**
|
|
480
|
+
* If enabled, a `display-area-click` event is fired when the user clicks or taps on the display area.
|
|
481
|
+
* The display area is the central area that contains the enlarged content of the currently selected item.
|
|
482
|
+
*/
|
|
483
|
+
interactiveDisplayArea?:
|
|
484
|
+
| boolean
|
|
485
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
486
|
+
|
|
487
|
+
/**
|
|
488
|
+
* Determines the layout of the component.
|
|
489
|
+
*
|
|
490
|
+
* Available options are:
|
|
491
|
+
* - `Auto`
|
|
492
|
+
* - `Vertical`
|
|
493
|
+
* - `Horizontal`
|
|
494
|
+
*/
|
|
495
|
+
layout?:
|
|
496
|
+
| sap.ui.webc.fiori.MediaGalleryLayout
|
|
497
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
498
|
+
|
|
499
|
+
/**
|
|
500
|
+
* Determines the horizontal alignment of the thumbnails menu vs. the central display area.
|
|
501
|
+
*
|
|
502
|
+
* Available options are:
|
|
503
|
+
* - `Left`
|
|
504
|
+
* - `Right`
|
|
505
|
+
*/
|
|
506
|
+
menuHorizontalAlign?:
|
|
507
|
+
| sap.ui.webc.fiori.MediaGalleryMenuHorizontalAlign
|
|
508
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
509
|
+
|
|
510
|
+
/**
|
|
511
|
+
* Determines the vertical alignment of the thumbnails menu vs. the central display area.
|
|
512
|
+
*
|
|
513
|
+
* Available options are:
|
|
514
|
+
* - `Top`
|
|
515
|
+
* - `Bottom`
|
|
516
|
+
*/
|
|
517
|
+
menuVerticalAlign?:
|
|
518
|
+
| sap.ui.webc.fiori.MediaGalleryMenuVerticalAlign
|
|
519
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
520
|
+
|
|
521
|
+
/**
|
|
522
|
+
* If set to `true`, all thumbnails are rendered in a scrollable container. If `false`, only up to five
|
|
523
|
+
* thumbnails are rendered, followed by an overflow button that shows the count of the remaining thumbnails.
|
|
524
|
+
*/
|
|
525
|
+
showAllThumbnails?:
|
|
526
|
+
| boolean
|
|
527
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
528
|
+
|
|
529
|
+
/**
|
|
530
|
+
* Defines the component items.
|
|
531
|
+
*
|
|
532
|
+
*
|
|
533
|
+
*
|
|
534
|
+
* **Note:** Only one selected item is allowed.
|
|
535
|
+
*
|
|
536
|
+
*
|
|
537
|
+
*
|
|
538
|
+
* **Note:** Use the `sap.ui.webc.fiori.MediaGalleryItem` component to define the desired items.
|
|
539
|
+
*/
|
|
540
|
+
items?:
|
|
541
|
+
| sap.ui.webc.fiori.IMediaGalleryItem[]
|
|
542
|
+
| sap.ui.webc.fiori.IMediaGalleryItem
|
|
543
|
+
| sap.ui.base.ManagedObject.AggregationBindingInfo;
|
|
544
|
+
|
|
545
|
+
/**
|
|
546
|
+
* Fired when the display area is clicked.
|
|
547
|
+
* The display area is the central area that contains the enlarged content of the currently selected item.
|
|
548
|
+
*/
|
|
549
|
+
displayAreaClick?: (oEvent: sap.ui.base.Event) => void;
|
|
550
|
+
|
|
551
|
+
/**
|
|
552
|
+
* Fired when the thumbnails overflow button is clicked.
|
|
553
|
+
*/
|
|
554
|
+
overflowClick?: (oEvent: sap.ui.base.Event) => void;
|
|
555
|
+
|
|
556
|
+
/**
|
|
557
|
+
* Fired when selection is changed by user interaction.
|
|
558
|
+
*/
|
|
559
|
+
selectionChange?: (oEvent: sap.ui.base.Event) => void;
|
|
560
|
+
}
|
|
561
|
+
|
|
562
|
+
interface $MediaGalleryItemSettings
|
|
563
|
+
extends sap.ui.webc.common.$WebComponentSettings {
|
|
564
|
+
/**
|
|
565
|
+
* Defines whether the component is in disabled state.
|
|
566
|
+
*/
|
|
567
|
+
disabled?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
568
|
+
|
|
569
|
+
/**
|
|
570
|
+
* Determines the layout of the item container.
|
|
571
|
+
*
|
|
572
|
+
* Available options are:
|
|
573
|
+
* - `Square`
|
|
574
|
+
* - `Wide`
|
|
575
|
+
*/
|
|
576
|
+
layout?:
|
|
577
|
+
| sap.ui.webc.fiori.MediaGalleryItemLayout
|
|
578
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
579
|
+
|
|
580
|
+
/**
|
|
581
|
+
* Defines the selected state of the component.
|
|
582
|
+
*/
|
|
583
|
+
selected?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
584
|
+
|
|
585
|
+
/**
|
|
586
|
+
* Defines the content of the component.
|
|
587
|
+
*/
|
|
588
|
+
content?:
|
|
589
|
+
| sap.ui.core.Control[]
|
|
590
|
+
| sap.ui.core.Control
|
|
591
|
+
| sap.ui.base.ManagedObject.AggregationBindingInfo;
|
|
592
|
+
|
|
593
|
+
/**
|
|
594
|
+
* Defines the content of the thumbnail.
|
|
595
|
+
*/
|
|
596
|
+
thumbnail?:
|
|
597
|
+
| sap.ui.core.Control[]
|
|
598
|
+
| sap.ui.core.Control
|
|
599
|
+
| sap.ui.base.ManagedObject.AggregationBindingInfo;
|
|
600
|
+
}
|
|
601
|
+
|
|
287
602
|
interface $NotificationActionSettings
|
|
288
603
|
extends sap.ui.webc.common.$WebComponentSettings {
|
|
289
604
|
/**
|
|
@@ -559,18 +874,12 @@ declare namespace sap {
|
|
|
559
874
|
/**
|
|
560
875
|
* Defines the footer HTML Element.
|
|
561
876
|
*/
|
|
562
|
-
footer?:
|
|
563
|
-
| sap.ui.core.Control[]
|
|
564
|
-
| sap.ui.core.Control
|
|
565
|
-
| sap.ui.base.ManagedObject.AggregationBindingInfo;
|
|
877
|
+
footer?: sap.ui.webc.fiori.IBar;
|
|
566
878
|
|
|
567
879
|
/**
|
|
568
880
|
* Defines the header HTML Element.
|
|
569
881
|
*/
|
|
570
|
-
header?:
|
|
571
|
-
| sap.ui.core.Control[]
|
|
572
|
-
| sap.ui.core.Control
|
|
573
|
-
| sap.ui.base.ManagedObject.AggregationBindingInfo;
|
|
882
|
+
header?: sap.ui.webc.fiori.IBar;
|
|
574
883
|
}
|
|
575
884
|
|
|
576
885
|
interface $ProductSwitchSettings
|
|
@@ -635,6 +944,16 @@ declare namespace sap {
|
|
|
635
944
|
|
|
636
945
|
interface $ShellBarSettings
|
|
637
946
|
extends sap.ui.webc.common.$WebComponentSettings {
|
|
947
|
+
/**
|
|
948
|
+
* An object of strings that defines several additional accessibility texts for even further customization.
|
|
949
|
+
*
|
|
950
|
+
* It supports the following fields: - `profileButtonTitle`: defines the tooltip for the profile button
|
|
951
|
+
* - `logoTitle`: defines the tooltip for the logo
|
|
952
|
+
*/
|
|
953
|
+
accessibilityTexts?:
|
|
954
|
+
| object
|
|
955
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
956
|
+
|
|
638
957
|
/**
|
|
639
958
|
* Defines the `notificationsCount`, displayed in the notification icon top-right corner.
|
|
640
959
|
*/
|
|
@@ -736,7 +1055,7 @@ declare namespace sap {
|
|
|
736
1055
|
logoClick?: (oEvent: sap.ui.base.Event) => void;
|
|
737
1056
|
|
|
738
1057
|
/**
|
|
739
|
-
* Fired, when a menu item is activated **Note:** You can prevent closing of
|
|
1058
|
+
* Fired, when a menu item is activated **Note:** You can prevent closing of overflow popover by calling
|
|
740
1059
|
* `event.preventDefault()`.
|
|
741
1060
|
*/
|
|
742
1061
|
menuItemClick?: (oEvent: sap.ui.base.Event) => void;
|
|
@@ -747,7 +1066,7 @@ declare namespace sap {
|
|
|
747
1066
|
notificationsClick?: (oEvent: sap.ui.base.Event) => void;
|
|
748
1067
|
|
|
749
1068
|
/**
|
|
750
|
-
* Fired, when the product switch icon is activated. **Note:** You can prevent closing of
|
|
1069
|
+
* Fired, when the product switch icon is activated. **Note:** You can prevent closing of overflow popover
|
|
751
1070
|
* by calling `event.preventDefault()`.
|
|
752
1071
|
*/
|
|
753
1072
|
productSwitchClick?: (oEvent: sap.ui.base.Event) => void;
|
|
@@ -778,7 +1097,7 @@ declare namespace sap {
|
|
|
778
1097
|
/**
|
|
779
1098
|
* Fired, when the item is pressed.
|
|
780
1099
|
*/
|
|
781
|
-
|
|
1100
|
+
click?: (oEvent: sap.ui.base.Event) => void;
|
|
782
1101
|
}
|
|
783
1102
|
|
|
784
1103
|
interface $SideNavigationSettings
|
|
@@ -898,6 +1217,19 @@ declare namespace sap {
|
|
|
898
1217
|
text?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
899
1218
|
}
|
|
900
1219
|
|
|
1220
|
+
interface $SortItemSettings
|
|
1221
|
+
extends sap.ui.webc.common.$WebComponentSettings {
|
|
1222
|
+
/**
|
|
1223
|
+
* Defines if the component is selected.
|
|
1224
|
+
*/
|
|
1225
|
+
selected?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
1226
|
+
|
|
1227
|
+
/**
|
|
1228
|
+
* Defines the text of the component.
|
|
1229
|
+
*/
|
|
1230
|
+
text?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
1231
|
+
}
|
|
1232
|
+
|
|
901
1233
|
interface $TimelineSettings
|
|
902
1234
|
extends sap.ui.webc.common.$WebComponentSettings {
|
|
903
1235
|
/**
|
|
@@ -988,6 +1320,13 @@ declare namespace sap {
|
|
|
988
1320
|
|
|
989
1321
|
interface $UploadCollectionSettings
|
|
990
1322
|
extends sap.ui.webc.common.$WebComponentSettings {
|
|
1323
|
+
/**
|
|
1324
|
+
* Sets the accessible aria name of the component.
|
|
1325
|
+
*/
|
|
1326
|
+
accessibleName?:
|
|
1327
|
+
| string
|
|
1328
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
1329
|
+
|
|
991
1330
|
/**
|
|
992
1331
|
* Defines the height of the control
|
|
993
1332
|
*/
|
|
@@ -1042,6 +1381,9 @@ declare namespace sap {
|
|
|
1042
1381
|
|
|
1043
1382
|
/**
|
|
1044
1383
|
* Defines the `sap.ui.webc.fiori.UploadCollection` header.
|
|
1384
|
+
*
|
|
1385
|
+
* **Note:** If `header` slot is provided, the labelling of the `UploadCollection` is a responsibility
|
|
1386
|
+
* of the application developer. `accessibleName` should be used.
|
|
1045
1387
|
*/
|
|
1046
1388
|
header?:
|
|
1047
1389
|
| sap.ui.core.Control[]
|
|
@@ -1189,12 +1531,14 @@ declare namespace sap {
|
|
|
1189
1531
|
| boolean
|
|
1190
1532
|
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
1191
1533
|
|
|
1192
|
-
|
|
1193
|
-
|
|
1194
|
-
|
|
1534
|
+
filterItems?:
|
|
1535
|
+
| sap.ui.webc.fiori.IFilterItem[]
|
|
1536
|
+
| sap.ui.webc.fiori.IFilterItem
|
|
1537
|
+
| sap.ui.base.ManagedObject.AggregationBindingInfo;
|
|
1538
|
+
|
|
1195
1539
|
sortItems?:
|
|
1196
|
-
| sap.ui.webc.
|
|
1197
|
-
| sap.ui.webc.
|
|
1540
|
+
| sap.ui.webc.fiori.ISortItem[]
|
|
1541
|
+
| sap.ui.webc.fiori.ISortItem
|
|
1198
1542
|
| sap.ui.base.ManagedObject.AggregationBindingInfo;
|
|
1199
1543
|
|
|
1200
1544
|
/**
|
|
@@ -1210,13 +1554,6 @@ declare namespace sap {
|
|
|
1210
1554
|
|
|
1211
1555
|
interface $WizardSettings
|
|
1212
1556
|
extends sap.ui.webc.common.$WebComponentSettings {
|
|
1213
|
-
/**
|
|
1214
|
-
* Sets the accessible aria name of the component.
|
|
1215
|
-
*/
|
|
1216
|
-
accessibleName?:
|
|
1217
|
-
| string
|
|
1218
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
1219
|
-
|
|
1220
1557
|
/**
|
|
1221
1558
|
* Defines the height of the control
|
|
1222
1559
|
*/
|
|
@@ -1243,20 +1580,6 @@ declare namespace sap {
|
|
|
1243
1580
|
|
|
1244
1581
|
interface $WizardStepSettings
|
|
1245
1582
|
extends sap.ui.webc.common.$WebComponentSettings {
|
|
1246
|
-
/**
|
|
1247
|
-
* Sets the accessible aria name of the component.
|
|
1248
|
-
*/
|
|
1249
|
-
accessibleName?:
|
|
1250
|
-
| string
|
|
1251
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
1252
|
-
|
|
1253
|
-
/**
|
|
1254
|
-
* Defines the aria-labelledby of the step.
|
|
1255
|
-
*/
|
|
1256
|
-
accessibleNameRef?:
|
|
1257
|
-
| string
|
|
1258
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
1259
|
-
|
|
1260
1583
|
/**
|
|
1261
1584
|
* When `branching` is enabled a dashed line would be displayed after the step, meant to indicate that the
|
|
1262
1585
|
* next step is not yet known and depends on user choice in the current step.
|
|
@@ -1284,7 +1607,7 @@ declare namespace sap {
|
|
|
1284
1607
|
*
|
|
1285
1608
|
*
|
|
1286
1609
|
*
|
|
1287
|
-
* **Note:**
|
|
1610
|
+
* **Note:** The icon is displayed in the `sap.ui.webc.fiori.Wizard` navigation header.
|
|
1288
1611
|
*
|
|
1289
1612
|
*
|
|
1290
1613
|
*
|
|
@@ -1308,7 +1631,6 @@ declare namespace sap {
|
|
|
1308
1631
|
*
|
|
1309
1632
|
*
|
|
1310
1633
|
* **Note:** the text is displayed in the `sap.ui.webc.fiori.Wizard` navigation header.
|
|
1311
|
-
* **Note:** the text will hide on small sizes (about 559 px).
|
|
1312
1634
|
*/
|
|
1313
1635
|
subtitleText?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
1314
1636
|
|
|
@@ -1317,8 +1639,7 @@ declare namespace sap {
|
|
|
1317
1639
|
*
|
|
1318
1640
|
*
|
|
1319
1641
|
*
|
|
1320
|
-
* **Note:**
|
|
1321
|
-
* **Note:** the text will hide on small sizes (about 559 px).
|
|
1642
|
+
* **Note:** The text is displayed in the `sap.ui.webc.fiori.Wizard` navigation header.
|
|
1322
1643
|
*/
|
|
1323
1644
|
titleText?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
1324
1645
|
|
|
@@ -1354,8 +1675,13 @@ declare namespace sap {
|
|
|
1354
1675
|
* allow developers to style elements inside the Shadow DOM.
|
|
1355
1676
|
* The `sap.ui.webc.fiori.Bar` exposes the following CSS Shadow Parts:
|
|
1356
1677
|
* - bar - Used to style the wrapper of the content of the component
|
|
1678
|
+
*
|
|
1679
|
+
* Keyboard Handling:
|
|
1357
1680
|
*/
|
|
1358
|
-
class Bar
|
|
1681
|
+
class Bar
|
|
1682
|
+
extends sap.ui.webc.common.WebComponent
|
|
1683
|
+
implements sap.ui.webc.fiori.IBar {
|
|
1684
|
+
__implements__sap_ui_webc_fiori_IBar: boolean;
|
|
1359
1685
|
/**
|
|
1360
1686
|
* Constructor for a new `Bar`.
|
|
1361
1687
|
*
|
|
@@ -1649,8 +1975,8 @@ declare namespace sap {
|
|
|
1649
1975
|
): this;
|
|
1650
1976
|
}
|
|
1651
1977
|
/**
|
|
1652
|
-
* @SINCE 1.
|
|
1653
|
-
* @EXPERIMENTAL (since 1.
|
|
1978
|
+
* @SINCE 1.95.0
|
|
1979
|
+
* @EXPERIMENTAL (since 1.95.0)
|
|
1654
1980
|
*
|
|
1655
1981
|
* Overview:
|
|
1656
1982
|
*
|
|
@@ -1884,38 +2210,68 @@ declare namespace sap {
|
|
|
1884
2210
|
show(): void;
|
|
1885
2211
|
}
|
|
1886
2212
|
/**
|
|
1887
|
-
* @SINCE 1.
|
|
1888
|
-
* @EXPERIMENTAL (since 1.
|
|
2213
|
+
* @SINCE 1.99.0
|
|
2214
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
1889
2215
|
*
|
|
1890
2216
|
* Overview:
|
|
1891
2217
|
*
|
|
1892
|
-
* The `
|
|
1893
|
-
*
|
|
1894
|
-
*
|
|
2218
|
+
* The DynamicSideContent (`sap.ui.webc.fiori.DynamicSideContent`) is a layout component that allows additional
|
|
2219
|
+
* content to be displayed in a way that flexibly adapts to different screen sizes. The side content appears
|
|
2220
|
+
* in a container next to or directly below the main content (it doesn't overlay). When the side content
|
|
2221
|
+
* is triggered, the main content becomes narrower (if appearing side-by-side). The side content contains
|
|
2222
|
+
* a separate scrollbar when appearing next to the main content.
|
|
1895
2223
|
*
|
|
1896
2224
|
* Usage:
|
|
1897
2225
|
*
|
|
1898
|
-
*
|
|
1899
|
-
*
|
|
1900
|
-
*
|
|
2226
|
+
* When to use?
|
|
2227
|
+
*
|
|
2228
|
+
* Use this component if you want to display relevant information that is not critical for users to complete
|
|
2229
|
+
* a task. Users should have access to all the key functions and critical information in the app even if
|
|
2230
|
+
* they do not see the side content. This is important because on smaller screen sizes it may be difficult
|
|
2231
|
+
* to display the side content in a way that is easily accessible for the user.
|
|
2232
|
+
*
|
|
2233
|
+
* When not to use?
|
|
2234
|
+
*
|
|
2235
|
+
* Don't use it if you want to display navigation or critical information that prevents users from completing
|
|
2236
|
+
* a task when they have no access to the side content.
|
|
1901
2237
|
*
|
|
1902
2238
|
* Responsive Behavior:
|
|
1903
2239
|
*
|
|
1904
|
-
*
|
|
1905
|
-
* property and the window size. The component would display 1 column for window size smaller than 599px,
|
|
1906
|
-
* up to two columns between 599px and 1023px, and 3 columns for sizes bigger than 1023px.
|
|
2240
|
+
* Screen width > 1440px
|
|
1907
2241
|
*
|
|
1908
2242
|
*
|
|
2243
|
+
* - Main vs. side content ratio is 75 vs. 25 percent (with a minimum of 320px each).
|
|
2244
|
+
* - If the application defines a trigger, the side content can be hidden.
|
|
1909
2245
|
*
|
|
1910
|
-
*
|
|
2246
|
+
* Screen width <= 1440px and> 1024px
|
|
1911
2247
|
*
|
|
1912
2248
|
*
|
|
1913
|
-
* -
|
|
1914
|
-
* it
|
|
2249
|
+
* - Main vs. side content ratio is 66.666 vs. 33.333 percent (with a minimum of 320px each). If the side
|
|
2250
|
+
* content width falls below 320 px, it automatically slides under the main content, unless the app development
|
|
2251
|
+
* team specifies that it should disappear.
|
|
2252
|
+
*
|
|
2253
|
+
* Screen width <= 1024px and> 720px
|
|
2254
|
+
*
|
|
2255
|
+
*
|
|
2256
|
+
* - The side content ratio is fixed to 340px, and the main content takes the rest of the width. Only
|
|
2257
|
+
* if the `sideContentFallDown` is set to `OnMinimumWidth` and screen width is <= 960px and> 720px the side
|
|
2258
|
+
* content falls below the main content.
|
|
2259
|
+
*
|
|
2260
|
+
* Screen width <= 720px (for example on a mobile device)
|
|
2261
|
+
* - In this case, the side content automatically disappears from the screen (unless specified to stay
|
|
2262
|
+
* under the content by setting of `sideContentVisibility` property to `AlwaysShow`) and can be triggered
|
|
2263
|
+
* from a pre-set trigger (specified within the app). When the side content is triggered, it replaces the
|
|
2264
|
+
* main content. We recommend that you always place the trigger for the side content in the same location,
|
|
2265
|
+
* such as in the app footer.
|
|
2266
|
+
*
|
|
2267
|
+
* A special case allows switching the comparison mode between the main and side content. In this case,
|
|
2268
|
+
* the screen is split into 50:50 percent for main vs. side content. The responsive behavior of the equal
|
|
2269
|
+
* split is the same as in the standard view - the side content disappears on screen widths of less than
|
|
2270
|
+
* 720 px and can only be viewed by triggering it.
|
|
1915
2271
|
*/
|
|
1916
|
-
class
|
|
2272
|
+
class DynamicSideContent extends sap.ui.webc.common.WebComponent {
|
|
1917
2273
|
/**
|
|
1918
|
-
* Constructor for a new `
|
|
2274
|
+
* Constructor for a new `DynamicSideContent`.
|
|
1919
2275
|
*
|
|
1920
2276
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1921
2277
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
@@ -1925,10 +2281,10 @@ declare namespace sap {
|
|
|
1925
2281
|
/**
|
|
1926
2282
|
* Initial settings for the new control
|
|
1927
2283
|
*/
|
|
1928
|
-
mSettings?: sap.ui.webc.fiori.$
|
|
2284
|
+
mSettings?: sap.ui.webc.fiori.$DynamicSideContentSettings
|
|
1929
2285
|
);
|
|
1930
2286
|
/**
|
|
1931
|
-
* Constructor for a new `
|
|
2287
|
+
* Constructor for a new `DynamicSideContent`.
|
|
1932
2288
|
*
|
|
1933
2289
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1934
2290
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
@@ -1942,11 +2298,11 @@ declare namespace sap {
|
|
|
1942
2298
|
/**
|
|
1943
2299
|
* Initial settings for the new control
|
|
1944
2300
|
*/
|
|
1945
|
-
mSettings?: sap.ui.webc.fiori.$
|
|
2301
|
+
mSettings?: sap.ui.webc.fiori.$DynamicSideContentSettings
|
|
1946
2302
|
);
|
|
1947
2303
|
|
|
1948
2304
|
/**
|
|
1949
|
-
* Creates a new subclass of class sap.ui.webc.fiori.
|
|
2305
|
+
* Creates a new subclass of class sap.ui.webc.fiori.DynamicSideContent with name `sClassName` and enriches
|
|
1950
2306
|
* it with the information contained in `oClassInfo`.
|
|
1951
2307
|
*
|
|
1952
2308
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
|
|
@@ -1959,10 +2315,7 @@ declare namespace sap {
|
|
|
1959
2315
|
/**
|
|
1960
2316
|
* Object literal with information about the class
|
|
1961
2317
|
*/
|
|
1962
|
-
oClassInfo?: sap.ClassInfo<
|
|
1963
|
-
T,
|
|
1964
|
-
sap.ui.webc.fiori.FlexibleColumnLayout
|
|
1965
|
-
>,
|
|
2318
|
+
oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.DynamicSideContent>,
|
|
1966
2319
|
/**
|
|
1967
2320
|
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
1968
2321
|
* used by this class
|
|
@@ -1970,17 +2323,34 @@ declare namespace sap {
|
|
|
1970
2323
|
FNMetaImpl?: Function
|
|
1971
2324
|
): Function;
|
|
1972
2325
|
/**
|
|
1973
|
-
* Returns a metadata object for class sap.ui.webc.fiori.
|
|
2326
|
+
* Returns a metadata object for class sap.ui.webc.fiori.DynamicSideContent.
|
|
1974
2327
|
*/
|
|
1975
2328
|
static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
|
|
1976
2329
|
/**
|
|
1977
|
-
*
|
|
2330
|
+
* Adds some content to the aggregation {@link #getContent content}.
|
|
2331
|
+
*/
|
|
2332
|
+
addContent(
|
|
2333
|
+
/**
|
|
2334
|
+
* The content to add; if empty, nothing is inserted
|
|
2335
|
+
*/
|
|
2336
|
+
oContent: sap.ui.core.Control
|
|
2337
|
+
): this;
|
|
2338
|
+
/**
|
|
2339
|
+
* Adds some sideContent to the aggregation {@link #getSideContent sideContent}.
|
|
2340
|
+
*/
|
|
2341
|
+
addSideContent(
|
|
2342
|
+
/**
|
|
2343
|
+
* The sideContent to add; if empty, nothing is inserted
|
|
2344
|
+
*/
|
|
2345
|
+
oSideContent: sap.ui.core.Control
|
|
2346
|
+
): this;
|
|
2347
|
+
/**
|
|
2348
|
+
* Attaches event handler `fnFunction` to the {@link #event:layoutChange layoutChange} event of this `sap.ui.webc.fiori.DynamicSideContent`.
|
|
1978
2349
|
*
|
|
1979
2350
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
1980
|
-
* otherwise it will be bound to this `sap.ui.webc.fiori.
|
|
2351
|
+
* otherwise it will be bound to this `sap.ui.webc.fiori.DynamicSideContent` itself.
|
|
1981
2352
|
*
|
|
1982
|
-
*
|
|
1983
|
-
* size due to resizing.
|
|
2353
|
+
* Fires when the current breakpoint has been changed.
|
|
1984
2354
|
*/
|
|
1985
2355
|
attachLayoutChange(
|
|
1986
2356
|
/**
|
|
@@ -1993,19 +2363,18 @@ declare namespace sap {
|
|
|
1993
2363
|
*/
|
|
1994
2364
|
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
1995
2365
|
/**
|
|
1996
|
-
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.
|
|
2366
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.DynamicSideContent`
|
|
1997
2367
|
* itself
|
|
1998
2368
|
*/
|
|
1999
2369
|
oListener?: object
|
|
2000
2370
|
): this;
|
|
2001
2371
|
/**
|
|
2002
|
-
* Attaches event handler `fnFunction` to the {@link #event:layoutChange layoutChange} event of this `sap.ui.webc.fiori.
|
|
2372
|
+
* Attaches event handler `fnFunction` to the {@link #event:layoutChange layoutChange} event of this `sap.ui.webc.fiori.DynamicSideContent`.
|
|
2003
2373
|
*
|
|
2004
2374
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
2005
|
-
* otherwise it will be bound to this `sap.ui.webc.fiori.
|
|
2375
|
+
* otherwise it will be bound to this `sap.ui.webc.fiori.DynamicSideContent` itself.
|
|
2006
2376
|
*
|
|
2007
|
-
*
|
|
2008
|
-
* size due to resizing.
|
|
2377
|
+
* Fires when the current breakpoint has been changed.
|
|
2009
2378
|
*/
|
|
2010
2379
|
attachLayoutChange(
|
|
2011
2380
|
/**
|
|
@@ -2013,25 +2382,21 @@ declare namespace sap {
|
|
|
2013
2382
|
*/
|
|
2014
2383
|
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
2015
2384
|
/**
|
|
2016
|
-
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.
|
|
2385
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.DynamicSideContent`
|
|
2017
2386
|
* itself
|
|
2018
2387
|
*/
|
|
2019
2388
|
oListener?: object
|
|
2020
2389
|
): this;
|
|
2021
2390
|
/**
|
|
2022
|
-
* Destroys the
|
|
2023
|
-
*/
|
|
2024
|
-
destroyEndColumn(): this;
|
|
2025
|
-
/**
|
|
2026
|
-
* Destroys the midColumn in the aggregation {@link #getMidColumn midColumn}.
|
|
2391
|
+
* Destroys all the content in the aggregation {@link #getContent content}.
|
|
2027
2392
|
*/
|
|
2028
|
-
|
|
2393
|
+
destroyContent(): this;
|
|
2029
2394
|
/**
|
|
2030
|
-
* Destroys the
|
|
2395
|
+
* Destroys all the sideContent in the aggregation {@link #getSideContent sideContent}.
|
|
2031
2396
|
*/
|
|
2032
|
-
|
|
2397
|
+
destroySideContent(): this;
|
|
2033
2398
|
/**
|
|
2034
|
-
* Detaches event handler `fnFunction` from the {@link #event:layoutChange layoutChange} event of this `sap.ui.webc.fiori.
|
|
2399
|
+
* Detaches event handler `fnFunction` from the {@link #event:layoutChange layoutChange} event of this `sap.ui.webc.fiori.DynamicSideContent`.
|
|
2035
2400
|
*
|
|
2036
2401
|
* The passed function and listener object must match the ones used for event registration.
|
|
2037
2402
|
*/
|
|
@@ -2054,209 +2419,997 @@ declare namespace sap {
|
|
|
2054
2419
|
*/
|
|
2055
2420
|
mParameters?: {
|
|
2056
2421
|
/**
|
|
2057
|
-
*
|
|
2058
|
-
*/
|
|
2059
|
-
layout?: FCLLayout;
|
|
2060
|
-
/**
|
|
2061
|
-
* The effective column layout, f.e [67%, 33%, 0]
|
|
2062
|
-
*/
|
|
2063
|
-
columnLayout?: any[];
|
|
2064
|
-
/**
|
|
2065
|
-
* Indicates if the start column is currently visible
|
|
2066
|
-
*/
|
|
2067
|
-
startColumnVisible?: boolean;
|
|
2068
|
-
/**
|
|
2069
|
-
* Indicates if the middle column is currently visible
|
|
2422
|
+
* the current breakpoint.
|
|
2070
2423
|
*/
|
|
2071
|
-
|
|
2424
|
+
currentBreakpoint?: string;
|
|
2072
2425
|
/**
|
|
2073
|
-
*
|
|
2426
|
+
* the breakpoint that was active before change to current breakpoint.
|
|
2074
2427
|
*/
|
|
2075
|
-
|
|
2428
|
+
previousBreakpoint?: string;
|
|
2076
2429
|
/**
|
|
2077
|
-
*
|
|
2430
|
+
* visibility of the main content.
|
|
2078
2431
|
*/
|
|
2079
|
-
|
|
2432
|
+
mainContentVisible?: boolean;
|
|
2080
2433
|
/**
|
|
2081
|
-
*
|
|
2434
|
+
* visibility of the side content.
|
|
2082
2435
|
*/
|
|
2083
|
-
|
|
2436
|
+
sideContentVisible?: boolean;
|
|
2084
2437
|
}
|
|
2085
2438
|
): this;
|
|
2086
2439
|
/**
|
|
2087
|
-
* Gets
|
|
2088
|
-
*
|
|
2089
|
-
* On object of strings that defines several additional accessibility texts for even further customization.
|
|
2090
|
-
*
|
|
2091
|
-
* It supports the following fields: - `startColumnAccessibleName`: the accessibility name for the `startColumn`
|
|
2092
|
-
* region - `midColumnAccessibleName`: the accessibility name for the `midColumn` region - `endColumnAccessibleName`:
|
|
2093
|
-
* the accessibility name for the `endColumn` region - `startArrowLeftText`: the text that the first arrow
|
|
2094
|
-
* (between the `begin` and `mid` columns) will have when pointing to the left - `startArrowRightText`:
|
|
2095
|
-
* the text that the first arrow (between the `begin` and `mid` columns) will have when pointing to the
|
|
2096
|
-
* right - `endArrowLeftText`: the text that the second arrow (between the `mid` and `end` columns) will
|
|
2097
|
-
* have when pointing to the left - `endArrowRightText`: the text that the second arrow (between the `mid`
|
|
2098
|
-
* and `end` columns) will have when pointing to the right
|
|
2440
|
+
* Gets content of aggregation {@link #getContent content}.
|
|
2099
2441
|
*
|
|
2100
|
-
*
|
|
2442
|
+
* Defines the main content.
|
|
2101
2443
|
*/
|
|
2102
|
-
|
|
2444
|
+
getContent(): sap.ui.core.Control[];
|
|
2103
2445
|
/**
|
|
2104
|
-
*
|
|
2446
|
+
* Gets current value of property {@link #getEqualSplit equalSplit}.
|
|
2105
2447
|
*
|
|
2106
|
-
*
|
|
2107
|
-
*
|
|
2448
|
+
* Defines whether the component is in equal split mode. In this mode, the side and the main content take
|
|
2449
|
+
* 50:50 percent of the container on all screen sizes except for phone, where the main and side contents
|
|
2450
|
+
* are switching visibility using the toggle method.
|
|
2451
|
+
*
|
|
2452
|
+
* Default value is `false`.
|
|
2108
2453
|
*/
|
|
2109
|
-
|
|
2454
|
+
getEqualSplit(): boolean;
|
|
2110
2455
|
/**
|
|
2111
|
-
* Gets
|
|
2456
|
+
* Gets current value of property {@link #getHideMainContent hideMainContent}.
|
|
2112
2457
|
*
|
|
2113
|
-
* Defines the
|
|
2458
|
+
* Defines the visibility of the main content.
|
|
2459
|
+
*
|
|
2460
|
+
* Default value is `false`.
|
|
2114
2461
|
*/
|
|
2115
|
-
|
|
2462
|
+
getHideMainContent(): boolean;
|
|
2116
2463
|
/**
|
|
2117
|
-
*
|
|
2464
|
+
* Gets current value of property {@link #getHideSideContent hideSideContent}.
|
|
2465
|
+
*
|
|
2466
|
+
* Defines the visibility of the side content.
|
|
2467
|
+
*
|
|
2468
|
+
* Default value is `false`.
|
|
2118
2469
|
*/
|
|
2119
|
-
|
|
2470
|
+
getHideSideContent(): boolean;
|
|
2120
2471
|
/**
|
|
2121
|
-
* Gets
|
|
2472
|
+
* Gets content of aggregation {@link #getSideContent sideContent}.
|
|
2122
2473
|
*
|
|
2123
|
-
* Defines the
|
|
2474
|
+
* Defines the side content.
|
|
2124
2475
|
*/
|
|
2125
|
-
|
|
2476
|
+
getSideContent(): sap.ui.core.Control[];
|
|
2126
2477
|
/**
|
|
2127
|
-
* Gets current value of property {@link #
|
|
2478
|
+
* Gets current value of property {@link #getSideContentFallDown sideContentFallDown}.
|
|
2128
2479
|
*
|
|
2129
|
-
* Defines
|
|
2480
|
+
* Defines on which breakpoints the side content falls down below the main content.
|
|
2130
2481
|
*
|
|
2131
|
-
*
|
|
2482
|
+
*
|
|
2483
|
+
*
|
|
2484
|
+
* **The available values are:**
|
|
2485
|
+
*
|
|
2486
|
+
*
|
|
2487
|
+
* - `BelowXL`
|
|
2488
|
+
* - `BelowL`
|
|
2489
|
+
* - `BelowM`
|
|
2490
|
+
* - `OnMinimumWidth`
|
|
2491
|
+
*
|
|
2492
|
+
* Default value is `OnMinimumWidth`.
|
|
2132
2493
|
*/
|
|
2133
|
-
|
|
2494
|
+
getSideContentFallDown(): sap.ui.webc.fiori.SideContentFallDown;
|
|
2134
2495
|
/**
|
|
2135
|
-
* Gets current value of property {@link #
|
|
2496
|
+
* Gets current value of property {@link #getSideContentPosition sideContentPosition}.
|
|
2136
2497
|
*
|
|
2137
|
-
* Defines the
|
|
2498
|
+
* Defines whether the side content is positioned before the main content (left side in LTR mode), or after
|
|
2499
|
+
* the the main content (right side in LTR mode).
|
|
2138
2500
|
*
|
|
2139
|
-
* **Note:** The layout also depends on the screen size - one column for screens smaller than 599px, two
|
|
2140
|
-
* columns between 599px and 1023px and three columns for sizes bigger than 1023px.
|
|
2141
2501
|
*
|
|
2142
|
-
* Available options are:
|
|
2143
|
-
* - `OneColumn`
|
|
2144
|
-
* - `TwoColumnsStartExpanded`
|
|
2145
|
-
* - `TwoColumnsMidExpanded`
|
|
2146
|
-
* - `ThreeColumnsMidExpanded`
|
|
2147
|
-
* - `ThreeColumnsEndExpanded`
|
|
2148
|
-
* - `ThreeColumnsStartExpandedEndHidden`
|
|
2149
|
-
* - `ThreeColumnsMidExpandedEndHidden`
|
|
2150
|
-
* - `MidColumnFullScreen`
|
|
2151
|
-
* - `EndColumnFullScreen`
|
|
2152
2502
|
*
|
|
2153
|
-
* **
|
|
2154
|
-
* 67%/33% proportion.
|
|
2503
|
+
* **The available values are:**
|
|
2155
2504
|
*
|
|
2156
|
-
*
|
|
2505
|
+
*
|
|
2506
|
+
* - `Start`
|
|
2507
|
+
* - `End`
|
|
2508
|
+
*
|
|
2509
|
+
* Default value is `End`.
|
|
2157
2510
|
*/
|
|
2158
|
-
|
|
2511
|
+
getSideContentPosition(): sap.ui.webc.fiori.SideContentPosition;
|
|
2159
2512
|
/**
|
|
2160
|
-
* Gets
|
|
2513
|
+
* Gets current value of property {@link #getSideContentVisibility sideContentVisibility}.
|
|
2161
2514
|
*
|
|
2162
|
-
* Defines
|
|
2515
|
+
* Defines on which breakpoints the side content is visible.
|
|
2516
|
+
*
|
|
2517
|
+
*
|
|
2518
|
+
*
|
|
2519
|
+
* **The available values are:**
|
|
2520
|
+
*
|
|
2521
|
+
*
|
|
2522
|
+
* - `AlwaysShow`
|
|
2523
|
+
* - `ShowAboveL`
|
|
2524
|
+
* - `ShowAboveM`
|
|
2525
|
+
* - `ShowAboveS`
|
|
2526
|
+
* - `NeverShow`
|
|
2527
|
+
*
|
|
2528
|
+
* Default value is `ShowAboveS`.
|
|
2163
2529
|
*/
|
|
2164
|
-
|
|
2530
|
+
getSideContentVisibility(): sap.ui.webc.fiori.SideContentVisibility;
|
|
2165
2531
|
/**
|
|
2166
|
-
*
|
|
2532
|
+
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getContent content}. and returns
|
|
2533
|
+
* its index if found or -1 otherwise.
|
|
2167
2534
|
*/
|
|
2168
|
-
|
|
2535
|
+
indexOfContent(
|
|
2536
|
+
/**
|
|
2537
|
+
* The content whose index is looked for
|
|
2538
|
+
*/
|
|
2539
|
+
oContent: sap.ui.core.Control
|
|
2540
|
+
): int;
|
|
2169
2541
|
/**
|
|
2170
|
-
*
|
|
2171
|
-
*
|
|
2172
|
-
* Defines the content in the start column.
|
|
2542
|
+
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getSideContent sideContent}.
|
|
2543
|
+
* and returns its index if found or -1 otherwise.
|
|
2173
2544
|
*/
|
|
2174
|
-
|
|
2545
|
+
indexOfSideContent(
|
|
2546
|
+
/**
|
|
2547
|
+
* The sideContent whose index is looked for
|
|
2548
|
+
*/
|
|
2549
|
+
oSideContent: sap.ui.core.Control
|
|
2550
|
+
): int;
|
|
2175
2551
|
/**
|
|
2176
|
-
*
|
|
2552
|
+
* Inserts a content into the aggregation {@link #getContent content}.
|
|
2177
2553
|
*/
|
|
2178
|
-
|
|
2554
|
+
insertContent(
|
|
2555
|
+
/**
|
|
2556
|
+
* The content to insert; if empty, nothing is inserted
|
|
2557
|
+
*/
|
|
2558
|
+
oContent: sap.ui.core.Control,
|
|
2559
|
+
/**
|
|
2560
|
+
* The `0`-based index the content should be inserted at; for a negative value of `iIndex`, the content
|
|
2561
|
+
* is inserted at position 0; for a value greater than the current size of the aggregation, the content
|
|
2562
|
+
* is inserted at the last position
|
|
2563
|
+
*/
|
|
2564
|
+
iIndex: int
|
|
2565
|
+
): this;
|
|
2179
2566
|
/**
|
|
2180
|
-
*
|
|
2567
|
+
* Inserts a sideContent into the aggregation {@link #getSideContent sideContent}.
|
|
2181
2568
|
*/
|
|
2182
|
-
|
|
2569
|
+
insertSideContent(
|
|
2570
|
+
/**
|
|
2571
|
+
* The sideContent to insert; if empty, nothing is inserted
|
|
2572
|
+
*/
|
|
2573
|
+
oSideContent: sap.ui.core.Control,
|
|
2574
|
+
/**
|
|
2575
|
+
* The `0`-based index the sideContent should be inserted at; for a negative value of `iIndex`, the sideContent
|
|
2576
|
+
* is inserted at position 0; for a value greater than the current size of the aggregation, the sideContent
|
|
2577
|
+
* is inserted at the last position
|
|
2578
|
+
*/
|
|
2579
|
+
iIndex: int
|
|
2580
|
+
): this;
|
|
2183
2581
|
/**
|
|
2184
|
-
*
|
|
2582
|
+
* Removes all the controls from the aggregation {@link #getContent content}.
|
|
2185
2583
|
*
|
|
2186
|
-
*
|
|
2584
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
2187
2585
|
*/
|
|
2188
|
-
|
|
2586
|
+
removeAllContent(): sap.ui.core.Control[];
|
|
2189
2587
|
/**
|
|
2190
|
-
*
|
|
2191
|
-
*
|
|
2192
|
-
* On object of strings that defines several additional accessibility texts for even further customization.
|
|
2588
|
+
* Removes all the controls from the aggregation {@link #getSideContent sideContent}.
|
|
2193
2589
|
*
|
|
2194
|
-
*
|
|
2195
|
-
* region - `midColumnAccessibleName`: the accessibility name for the `midColumn` region - `endColumnAccessibleName`:
|
|
2196
|
-
* the accessibility name for the `endColumn` region - `startArrowLeftText`: the text that the first arrow
|
|
2197
|
-
* (between the `begin` and `mid` columns) will have when pointing to the left - `startArrowRightText`:
|
|
2198
|
-
* the text that the first arrow (between the `begin` and `mid` columns) will have when pointing to the
|
|
2199
|
-
* right - `endArrowLeftText`: the text that the second arrow (between the `mid` and `end` columns) will
|
|
2200
|
-
* have when pointing to the left - `endArrowRightText`: the text that the second arrow (between the `mid`
|
|
2201
|
-
* and `end` columns) will have when pointing to the right
|
|
2202
|
-
*
|
|
2203
|
-
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2204
|
-
*
|
|
2205
|
-
* Default value is `{}`.
|
|
2590
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
2206
2591
|
*/
|
|
2207
|
-
|
|
2592
|
+
removeAllSideContent(): sap.ui.core.Control[];
|
|
2593
|
+
/**
|
|
2594
|
+
* Removes a content from the aggregation {@link #getContent content}.
|
|
2595
|
+
*/
|
|
2596
|
+
removeContent(
|
|
2208
2597
|
/**
|
|
2209
|
-
*
|
|
2598
|
+
* The content to remove or its index or id
|
|
2210
2599
|
*/
|
|
2211
|
-
|
|
2212
|
-
):
|
|
2600
|
+
vContent: int | string | sap.ui.core.Control
|
|
2601
|
+
): sap.ui.core.Control;
|
|
2213
2602
|
/**
|
|
2214
|
-
*
|
|
2603
|
+
* Removes a sideContent from the aggregation {@link #getSideContent sideContent}.
|
|
2215
2604
|
*/
|
|
2216
|
-
|
|
2605
|
+
removeSideContent(
|
|
2217
2606
|
/**
|
|
2218
|
-
* The
|
|
2607
|
+
* The sideContent to remove or its index or id
|
|
2219
2608
|
*/
|
|
2220
|
-
|
|
2221
|
-
):
|
|
2609
|
+
vSideContent: int | string | sap.ui.core.Control
|
|
2610
|
+
): sap.ui.core.Control;
|
|
2222
2611
|
/**
|
|
2223
|
-
* Sets a new value for property {@link #
|
|
2612
|
+
* Sets a new value for property {@link #getEqualSplit equalSplit}.
|
|
2224
2613
|
*
|
|
2225
|
-
* Defines the
|
|
2614
|
+
* Defines whether the component is in equal split mode. In this mode, the side and the main content take
|
|
2615
|
+
* 50:50 percent of the container on all screen sizes except for phone, where the main and side contents
|
|
2616
|
+
* are switching visibility using the toggle method.
|
|
2226
2617
|
*
|
|
2227
2618
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2619
|
+
*
|
|
2620
|
+
* Default value is `false`.
|
|
2228
2621
|
*/
|
|
2229
|
-
|
|
2622
|
+
setEqualSplit(
|
|
2230
2623
|
/**
|
|
2231
|
-
* New value for property `
|
|
2624
|
+
* New value for property `equalSplit`
|
|
2232
2625
|
*/
|
|
2233
|
-
|
|
2626
|
+
bEqualSplit?: boolean
|
|
2234
2627
|
): this;
|
|
2235
2628
|
/**
|
|
2236
|
-
* Sets a new value for property {@link #
|
|
2629
|
+
* Sets a new value for property {@link #getHideMainContent hideMainContent}.
|
|
2237
2630
|
*
|
|
2238
|
-
* Defines the visibility of the
|
|
2631
|
+
* Defines the visibility of the main content.
|
|
2239
2632
|
*
|
|
2240
2633
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2241
2634
|
*
|
|
2242
2635
|
* Default value is `false`.
|
|
2243
2636
|
*/
|
|
2244
|
-
|
|
2637
|
+
setHideMainContent(
|
|
2245
2638
|
/**
|
|
2246
|
-
* New value for property `
|
|
2639
|
+
* New value for property `hideMainContent`
|
|
2247
2640
|
*/
|
|
2248
|
-
|
|
2641
|
+
bHideMainContent?: boolean
|
|
2249
2642
|
): this;
|
|
2250
2643
|
/**
|
|
2251
|
-
* Sets a new value for property {@link #
|
|
2644
|
+
* Sets a new value for property {@link #getHideSideContent hideSideContent}.
|
|
2252
2645
|
*
|
|
2253
|
-
* Defines the
|
|
2646
|
+
* Defines the visibility of the side content.
|
|
2254
2647
|
*
|
|
2255
|
-
*
|
|
2256
|
-
* columns between 599px and 1023px and three columns for sizes bigger than 1023px.
|
|
2648
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2257
2649
|
*
|
|
2258
|
-
*
|
|
2259
|
-
|
|
2650
|
+
* Default value is `false`.
|
|
2651
|
+
*/
|
|
2652
|
+
setHideSideContent(
|
|
2653
|
+
/**
|
|
2654
|
+
* New value for property `hideSideContent`
|
|
2655
|
+
*/
|
|
2656
|
+
bHideSideContent?: boolean
|
|
2657
|
+
): this;
|
|
2658
|
+
/**
|
|
2659
|
+
* Sets a new value for property {@link #getSideContentFallDown sideContentFallDown}.
|
|
2660
|
+
*
|
|
2661
|
+
* Defines on which breakpoints the side content falls down below the main content.
|
|
2662
|
+
*
|
|
2663
|
+
*
|
|
2664
|
+
*
|
|
2665
|
+
* **The available values are:**
|
|
2666
|
+
*
|
|
2667
|
+
*
|
|
2668
|
+
* - `BelowXL`
|
|
2669
|
+
* - `BelowL`
|
|
2670
|
+
* - `BelowM`
|
|
2671
|
+
* - `OnMinimumWidth`
|
|
2672
|
+
*
|
|
2673
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2674
|
+
*
|
|
2675
|
+
* Default value is `OnMinimumWidth`.
|
|
2676
|
+
*/
|
|
2677
|
+
setSideContentFallDown(
|
|
2678
|
+
/**
|
|
2679
|
+
* New value for property `sideContentFallDown`
|
|
2680
|
+
*/
|
|
2681
|
+
sSideContentFallDown?: sap.ui.webc.fiori.SideContentFallDown
|
|
2682
|
+
): this;
|
|
2683
|
+
/**
|
|
2684
|
+
* Sets a new value for property {@link #getSideContentPosition sideContentPosition}.
|
|
2685
|
+
*
|
|
2686
|
+
* Defines whether the side content is positioned before the main content (left side in LTR mode), or after
|
|
2687
|
+
* the the main content (right side in LTR mode).
|
|
2688
|
+
*
|
|
2689
|
+
*
|
|
2690
|
+
*
|
|
2691
|
+
* **The available values are:**
|
|
2692
|
+
*
|
|
2693
|
+
*
|
|
2694
|
+
* - `Start`
|
|
2695
|
+
* - `End`
|
|
2696
|
+
*
|
|
2697
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2698
|
+
*
|
|
2699
|
+
* Default value is `End`.
|
|
2700
|
+
*/
|
|
2701
|
+
setSideContentPosition(
|
|
2702
|
+
/**
|
|
2703
|
+
* New value for property `sideContentPosition`
|
|
2704
|
+
*/
|
|
2705
|
+
sSideContentPosition?: sap.ui.webc.fiori.SideContentPosition
|
|
2706
|
+
): this;
|
|
2707
|
+
/**
|
|
2708
|
+
* Sets a new value for property {@link #getSideContentVisibility sideContentVisibility}.
|
|
2709
|
+
*
|
|
2710
|
+
* Defines on which breakpoints the side content is visible.
|
|
2711
|
+
*
|
|
2712
|
+
*
|
|
2713
|
+
*
|
|
2714
|
+
* **The available values are:**
|
|
2715
|
+
*
|
|
2716
|
+
*
|
|
2717
|
+
* - `AlwaysShow`
|
|
2718
|
+
* - `ShowAboveL`
|
|
2719
|
+
* - `ShowAboveM`
|
|
2720
|
+
* - `ShowAboveS`
|
|
2721
|
+
* - `NeverShow`
|
|
2722
|
+
*
|
|
2723
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2724
|
+
*
|
|
2725
|
+
* Default value is `ShowAboveS`.
|
|
2726
|
+
*/
|
|
2727
|
+
setSideContentVisibility(
|
|
2728
|
+
/**
|
|
2729
|
+
* New value for property `sideContentVisibility`
|
|
2730
|
+
*/
|
|
2731
|
+
sSideContentVisibility?: sap.ui.webc.fiori.SideContentVisibility
|
|
2732
|
+
): this;
|
|
2733
|
+
/**
|
|
2734
|
+
* Toggles visibility of main and side contents on S screen size (mobile device).
|
|
2735
|
+
*/
|
|
2736
|
+
toggleContents(): void;
|
|
2737
|
+
}
|
|
2738
|
+
/**
|
|
2739
|
+
* @SINCE 1.97.0
|
|
2740
|
+
* @EXPERIMENTAL (since 1.97.0)
|
|
2741
|
+
*
|
|
2742
|
+
* Overview:
|
|
2743
|
+
*
|
|
2744
|
+
* Usage:
|
|
2745
|
+
*/
|
|
2746
|
+
class FilterItem
|
|
2747
|
+
extends sap.ui.webc.common.WebComponent
|
|
2748
|
+
implements sap.ui.webc.fiori.IFilterItem {
|
|
2749
|
+
__implements__sap_ui_webc_fiori_IFilterItem: boolean;
|
|
2750
|
+
/**
|
|
2751
|
+
* Constructor for a new `FilterItem`.
|
|
2752
|
+
*
|
|
2753
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2754
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
2755
|
+
* of the syntax of the settings object.
|
|
2756
|
+
*/
|
|
2757
|
+
constructor(
|
|
2758
|
+
/**
|
|
2759
|
+
* Initial settings for the new control
|
|
2760
|
+
*/
|
|
2761
|
+
mSettings?: sap.ui.webc.fiori.$FilterItemSettings
|
|
2762
|
+
);
|
|
2763
|
+
/**
|
|
2764
|
+
* Constructor for a new `FilterItem`.
|
|
2765
|
+
*
|
|
2766
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2767
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
2768
|
+
* of the syntax of the settings object.
|
|
2769
|
+
*/
|
|
2770
|
+
constructor(
|
|
2771
|
+
/**
|
|
2772
|
+
* ID for the new control, generated automatically if no ID is given
|
|
2773
|
+
*/
|
|
2774
|
+
sId?: string,
|
|
2775
|
+
/**
|
|
2776
|
+
* Initial settings for the new control
|
|
2777
|
+
*/
|
|
2778
|
+
mSettings?: sap.ui.webc.fiori.$FilterItemSettings
|
|
2779
|
+
);
|
|
2780
|
+
|
|
2781
|
+
/**
|
|
2782
|
+
* Creates a new subclass of class sap.ui.webc.fiori.FilterItem with name `sClassName` and enriches it with
|
|
2783
|
+
* the information contained in `oClassInfo`.
|
|
2784
|
+
*
|
|
2785
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
|
|
2786
|
+
*/
|
|
2787
|
+
static extend<T extends Record<string, unknown>>(
|
|
2788
|
+
/**
|
|
2789
|
+
* Name of the class being created
|
|
2790
|
+
*/
|
|
2791
|
+
sClassName: string,
|
|
2792
|
+
/**
|
|
2793
|
+
* Object literal with information about the class
|
|
2794
|
+
*/
|
|
2795
|
+
oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.FilterItem>,
|
|
2796
|
+
/**
|
|
2797
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
2798
|
+
* used by this class
|
|
2799
|
+
*/
|
|
2800
|
+
FNMetaImpl?: Function
|
|
2801
|
+
): Function;
|
|
2802
|
+
/**
|
|
2803
|
+
* Returns a metadata object for class sap.ui.webc.fiori.FilterItem.
|
|
2804
|
+
*/
|
|
2805
|
+
static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
|
|
2806
|
+
/**
|
|
2807
|
+
* Adds some value to the aggregation {@link #getValues values}.
|
|
2808
|
+
*/
|
|
2809
|
+
addValue(
|
|
2810
|
+
/**
|
|
2811
|
+
* The value to add; if empty, nothing is inserted
|
|
2812
|
+
*/
|
|
2813
|
+
oValue: sap.ui.webc.fiori.IFilterItemOption
|
|
2814
|
+
): this;
|
|
2815
|
+
/**
|
|
2816
|
+
* Destroys all the values in the aggregation {@link #getValues values}.
|
|
2817
|
+
*/
|
|
2818
|
+
destroyValues(): this;
|
|
2819
|
+
/**
|
|
2820
|
+
* Gets current value of property {@link #getText text}.
|
|
2821
|
+
*
|
|
2822
|
+
* Defines the text of the component.
|
|
2823
|
+
*
|
|
2824
|
+
* Default value is `empty string`.
|
|
2825
|
+
*/
|
|
2826
|
+
getText(): string;
|
|
2827
|
+
/**
|
|
2828
|
+
* Gets content of aggregation {@link #getValues values}.
|
|
2829
|
+
*
|
|
2830
|
+
* Defines the `values` list.
|
|
2831
|
+
*/
|
|
2832
|
+
getValues(): sap.ui.webc.fiori.IFilterItemOption[];
|
|
2833
|
+
/**
|
|
2834
|
+
* Checks for the provided `sap.ui.webc.fiori.IFilterItemOption` in the aggregation {@link #getValues values}.
|
|
2835
|
+
* and returns its index if found or -1 otherwise.
|
|
2836
|
+
*/
|
|
2837
|
+
indexOfValue(
|
|
2838
|
+
/**
|
|
2839
|
+
* The value whose index is looked for
|
|
2840
|
+
*/
|
|
2841
|
+
oValue: sap.ui.webc.fiori.IFilterItemOption
|
|
2842
|
+
): int;
|
|
2843
|
+
/**
|
|
2844
|
+
* Inserts a value into the aggregation {@link #getValues values}.
|
|
2845
|
+
*/
|
|
2846
|
+
insertValue(
|
|
2847
|
+
/**
|
|
2848
|
+
* The value to insert; if empty, nothing is inserted
|
|
2849
|
+
*/
|
|
2850
|
+
oValue: sap.ui.webc.fiori.IFilterItemOption,
|
|
2851
|
+
/**
|
|
2852
|
+
* The `0`-based index the value should be inserted at; for a negative value of `iIndex`, the value is inserted
|
|
2853
|
+
* at position 0; for a value greater than the current size of the aggregation, the value is inserted at
|
|
2854
|
+
* the last position
|
|
2855
|
+
*/
|
|
2856
|
+
iIndex: int
|
|
2857
|
+
): this;
|
|
2858
|
+
/**
|
|
2859
|
+
* Removes all the controls from the aggregation {@link #getValues values}.
|
|
2860
|
+
*
|
|
2861
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
2862
|
+
*/
|
|
2863
|
+
removeAllValues(): sap.ui.webc.fiori.IFilterItemOption[];
|
|
2864
|
+
/**
|
|
2865
|
+
* Removes a value from the aggregation {@link #getValues values}.
|
|
2866
|
+
*/
|
|
2867
|
+
removeValue(
|
|
2868
|
+
/**
|
|
2869
|
+
* The value to remove or its index or id
|
|
2870
|
+
*/
|
|
2871
|
+
vValue: int | string | sap.ui.webc.fiori.IFilterItemOption
|
|
2872
|
+
): sap.ui.webc.fiori.IFilterItemOption;
|
|
2873
|
+
/**
|
|
2874
|
+
* Sets a new value for property {@link #getText text}.
|
|
2875
|
+
*
|
|
2876
|
+
* Defines the text of the component.
|
|
2877
|
+
*
|
|
2878
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2879
|
+
*
|
|
2880
|
+
* Default value is `empty string`.
|
|
2881
|
+
*/
|
|
2882
|
+
setText(
|
|
2883
|
+
/**
|
|
2884
|
+
* New value for property `text`
|
|
2885
|
+
*/
|
|
2886
|
+
sText?: string
|
|
2887
|
+
): this;
|
|
2888
|
+
}
|
|
2889
|
+
/**
|
|
2890
|
+
* @SINCE 1.97.0
|
|
2891
|
+
* @EXPERIMENTAL (since 1.97.0)
|
|
2892
|
+
*
|
|
2893
|
+
* Overview:
|
|
2894
|
+
*
|
|
2895
|
+
* Usage:
|
|
2896
|
+
*/
|
|
2897
|
+
class FilterItemOption
|
|
2898
|
+
extends sap.ui.webc.common.WebComponent
|
|
2899
|
+
implements sap.ui.webc.fiori.IFilterItemOption {
|
|
2900
|
+
__implements__sap_ui_webc_fiori_IFilterItemOption: boolean;
|
|
2901
|
+
/**
|
|
2902
|
+
* Constructor for a new `FilterItemOption`.
|
|
2903
|
+
*
|
|
2904
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2905
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
2906
|
+
* of the syntax of the settings object.
|
|
2907
|
+
*/
|
|
2908
|
+
constructor(
|
|
2909
|
+
/**
|
|
2910
|
+
* Initial settings for the new control
|
|
2911
|
+
*/
|
|
2912
|
+
mSettings?: sap.ui.webc.fiori.$FilterItemOptionSettings
|
|
2913
|
+
);
|
|
2914
|
+
/**
|
|
2915
|
+
* Constructor for a new `FilterItemOption`.
|
|
2916
|
+
*
|
|
2917
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2918
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
2919
|
+
* of the syntax of the settings object.
|
|
2920
|
+
*/
|
|
2921
|
+
constructor(
|
|
2922
|
+
/**
|
|
2923
|
+
* ID for the new control, generated automatically if no ID is given
|
|
2924
|
+
*/
|
|
2925
|
+
sId?: string,
|
|
2926
|
+
/**
|
|
2927
|
+
* Initial settings for the new control
|
|
2928
|
+
*/
|
|
2929
|
+
mSettings?: sap.ui.webc.fiori.$FilterItemOptionSettings
|
|
2930
|
+
);
|
|
2931
|
+
|
|
2932
|
+
/**
|
|
2933
|
+
* Creates a new subclass of class sap.ui.webc.fiori.FilterItemOption with name `sClassName` and enriches
|
|
2934
|
+
* it with the information contained in `oClassInfo`.
|
|
2935
|
+
*
|
|
2936
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
|
|
2937
|
+
*/
|
|
2938
|
+
static extend<T extends Record<string, unknown>>(
|
|
2939
|
+
/**
|
|
2940
|
+
* Name of the class being created
|
|
2941
|
+
*/
|
|
2942
|
+
sClassName: string,
|
|
2943
|
+
/**
|
|
2944
|
+
* Object literal with information about the class
|
|
2945
|
+
*/
|
|
2946
|
+
oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.FilterItemOption>,
|
|
2947
|
+
/**
|
|
2948
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
2949
|
+
* used by this class
|
|
2950
|
+
*/
|
|
2951
|
+
FNMetaImpl?: Function
|
|
2952
|
+
): Function;
|
|
2953
|
+
/**
|
|
2954
|
+
* Returns a metadata object for class sap.ui.webc.fiori.FilterItemOption.
|
|
2955
|
+
*/
|
|
2956
|
+
static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
|
|
2957
|
+
/**
|
|
2958
|
+
* Gets current value of property {@link #getSelected selected}.
|
|
2959
|
+
*
|
|
2960
|
+
* Defines whether the option is selected
|
|
2961
|
+
*
|
|
2962
|
+
* Default value is `false`.
|
|
2963
|
+
*/
|
|
2964
|
+
getSelected(): boolean;
|
|
2965
|
+
/**
|
|
2966
|
+
* Gets current value of property {@link #getText text}.
|
|
2967
|
+
*
|
|
2968
|
+
* Defines the text of the component.
|
|
2969
|
+
*
|
|
2970
|
+
* Default value is `empty string`.
|
|
2971
|
+
*/
|
|
2972
|
+
getText(): string;
|
|
2973
|
+
/**
|
|
2974
|
+
* Sets a new value for property {@link #getSelected selected}.
|
|
2975
|
+
*
|
|
2976
|
+
* Defines whether the option is selected
|
|
2977
|
+
*
|
|
2978
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2979
|
+
*
|
|
2980
|
+
* Default value is `false`.
|
|
2981
|
+
*/
|
|
2982
|
+
setSelected(
|
|
2983
|
+
/**
|
|
2984
|
+
* New value for property `selected`
|
|
2985
|
+
*/
|
|
2986
|
+
bSelected?: boolean
|
|
2987
|
+
): this;
|
|
2988
|
+
/**
|
|
2989
|
+
* Sets a new value for property {@link #getText text}.
|
|
2990
|
+
*
|
|
2991
|
+
* Defines the text of the component.
|
|
2992
|
+
*
|
|
2993
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2994
|
+
*
|
|
2995
|
+
* Default value is `empty string`.
|
|
2996
|
+
*/
|
|
2997
|
+
setText(
|
|
2998
|
+
/**
|
|
2999
|
+
* New value for property `text`
|
|
3000
|
+
*/
|
|
3001
|
+
sText?: string
|
|
3002
|
+
): this;
|
|
3003
|
+
}
|
|
3004
|
+
/**
|
|
3005
|
+
* @SINCE 1.92.0
|
|
3006
|
+
* @EXPERIMENTAL (since 1.92.0)
|
|
3007
|
+
*
|
|
3008
|
+
* Overview:
|
|
3009
|
+
*
|
|
3010
|
+
* The `FlexibleColumnLayout` implements the master-detail-detail paradigm by displaying up to three pages
|
|
3011
|
+
* in separate columns. There are several possible layouts that can be changed either with the component
|
|
3012
|
+
* API, or by pressing the arrows, displayed between the columns.
|
|
3013
|
+
*
|
|
3014
|
+
* Usage:
|
|
3015
|
+
*
|
|
3016
|
+
* Use this component for applications that need to display several logical levels of related information
|
|
3017
|
+
* side by side (e.g. list of items, item, sub-item, etc.). The Component is flexible in a sense that the
|
|
3018
|
+
* application can focus the user's attention on one particular column.
|
|
3019
|
+
*
|
|
3020
|
+
* Responsive Behavior:
|
|
3021
|
+
*
|
|
3022
|
+
* The `FlexibleColumnLayout` automatically displays the maximum possible number of columns based on `layout`
|
|
3023
|
+
* property and the window size. The component would display 1 column for window size smaller than 599px,
|
|
3024
|
+
* up to two columns between 599px and 1023px, and 3 columns for sizes bigger than 1023px.
|
|
3025
|
+
*
|
|
3026
|
+
*
|
|
3027
|
+
*
|
|
3028
|
+
* Keyboard Handling:
|
|
3029
|
+
*/
|
|
3030
|
+
class FlexibleColumnLayout extends sap.ui.webc.common.WebComponent {
|
|
3031
|
+
/**
|
|
3032
|
+
* Constructor for a new `FlexibleColumnLayout`.
|
|
3033
|
+
*
|
|
3034
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
3035
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
3036
|
+
* of the syntax of the settings object.
|
|
3037
|
+
*/
|
|
3038
|
+
constructor(
|
|
3039
|
+
/**
|
|
3040
|
+
* Initial settings for the new control
|
|
3041
|
+
*/
|
|
3042
|
+
mSettings?: sap.ui.webc.fiori.$FlexibleColumnLayoutSettings
|
|
3043
|
+
);
|
|
3044
|
+
/**
|
|
3045
|
+
* Constructor for a new `FlexibleColumnLayout`.
|
|
3046
|
+
*
|
|
3047
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
3048
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
3049
|
+
* of the syntax of the settings object.
|
|
3050
|
+
*/
|
|
3051
|
+
constructor(
|
|
3052
|
+
/**
|
|
3053
|
+
* ID for the new control, generated automatically if no ID is given
|
|
3054
|
+
*/
|
|
3055
|
+
sId?: string,
|
|
3056
|
+
/**
|
|
3057
|
+
* Initial settings for the new control
|
|
3058
|
+
*/
|
|
3059
|
+
mSettings?: sap.ui.webc.fiori.$FlexibleColumnLayoutSettings
|
|
3060
|
+
);
|
|
3061
|
+
|
|
3062
|
+
/**
|
|
3063
|
+
* Creates a new subclass of class sap.ui.webc.fiori.FlexibleColumnLayout with name `sClassName` and enriches
|
|
3064
|
+
* it with the information contained in `oClassInfo`.
|
|
3065
|
+
*
|
|
3066
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
|
|
3067
|
+
*/
|
|
3068
|
+
static extend<T extends Record<string, unknown>>(
|
|
3069
|
+
/**
|
|
3070
|
+
* Name of the class being created
|
|
3071
|
+
*/
|
|
3072
|
+
sClassName: string,
|
|
3073
|
+
/**
|
|
3074
|
+
* Object literal with information about the class
|
|
3075
|
+
*/
|
|
3076
|
+
oClassInfo?: sap.ClassInfo<
|
|
3077
|
+
T,
|
|
3078
|
+
sap.ui.webc.fiori.FlexibleColumnLayout
|
|
3079
|
+
>,
|
|
3080
|
+
/**
|
|
3081
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
3082
|
+
* used by this class
|
|
3083
|
+
*/
|
|
3084
|
+
FNMetaImpl?: Function
|
|
3085
|
+
): Function;
|
|
3086
|
+
/**
|
|
3087
|
+
* Returns a metadata object for class sap.ui.webc.fiori.FlexibleColumnLayout.
|
|
3088
|
+
*/
|
|
3089
|
+
static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
|
|
3090
|
+
/**
|
|
3091
|
+
* Attaches event handler `fnFunction` to the {@link #event:layoutChange layoutChange} event of this `sap.ui.webc.fiori.FlexibleColumnLayout`.
|
|
3092
|
+
*
|
|
3093
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
3094
|
+
* otherwise it will be bound to this `sap.ui.webc.fiori.FlexibleColumnLayout` itself.
|
|
3095
|
+
*
|
|
3096
|
+
* Fired when the layout changes via user interaction by clicking the arrows or by changing the component
|
|
3097
|
+
* size due to resizing.
|
|
3098
|
+
*/
|
|
3099
|
+
attachLayoutChange(
|
|
3100
|
+
/**
|
|
3101
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
3102
|
+
* object when firing the event
|
|
3103
|
+
*/
|
|
3104
|
+
oData: object,
|
|
3105
|
+
/**
|
|
3106
|
+
* The function to be called when the event occurs
|
|
3107
|
+
*/
|
|
3108
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
3109
|
+
/**
|
|
3110
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.FlexibleColumnLayout`
|
|
3111
|
+
* itself
|
|
3112
|
+
*/
|
|
3113
|
+
oListener?: object
|
|
3114
|
+
): this;
|
|
3115
|
+
/**
|
|
3116
|
+
* Attaches event handler `fnFunction` to the {@link #event:layoutChange layoutChange} event of this `sap.ui.webc.fiori.FlexibleColumnLayout`.
|
|
3117
|
+
*
|
|
3118
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
3119
|
+
* otherwise it will be bound to this `sap.ui.webc.fiori.FlexibleColumnLayout` itself.
|
|
3120
|
+
*
|
|
3121
|
+
* Fired when the layout changes via user interaction by clicking the arrows or by changing the component
|
|
3122
|
+
* size due to resizing.
|
|
3123
|
+
*/
|
|
3124
|
+
attachLayoutChange(
|
|
3125
|
+
/**
|
|
3126
|
+
* The function to be called when the event occurs
|
|
3127
|
+
*/
|
|
3128
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
3129
|
+
/**
|
|
3130
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.FlexibleColumnLayout`
|
|
3131
|
+
* itself
|
|
3132
|
+
*/
|
|
3133
|
+
oListener?: object
|
|
3134
|
+
): this;
|
|
3135
|
+
/**
|
|
3136
|
+
* Destroys the endColumn in the aggregation {@link #getEndColumn endColumn}.
|
|
3137
|
+
*/
|
|
3138
|
+
destroyEndColumn(): this;
|
|
3139
|
+
/**
|
|
3140
|
+
* Destroys the midColumn in the aggregation {@link #getMidColumn midColumn}.
|
|
3141
|
+
*/
|
|
3142
|
+
destroyMidColumn(): this;
|
|
3143
|
+
/**
|
|
3144
|
+
* Destroys the startColumn in the aggregation {@link #getStartColumn startColumn}.
|
|
3145
|
+
*/
|
|
3146
|
+
destroyStartColumn(): this;
|
|
3147
|
+
/**
|
|
3148
|
+
* Detaches event handler `fnFunction` from the {@link #event:layoutChange layoutChange} event of this `sap.ui.webc.fiori.FlexibleColumnLayout`.
|
|
3149
|
+
*
|
|
3150
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
3151
|
+
*/
|
|
3152
|
+
detachLayoutChange(
|
|
3153
|
+
/**
|
|
3154
|
+
* The function to be called, when the event occurs
|
|
3155
|
+
*/
|
|
3156
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
3157
|
+
/**
|
|
3158
|
+
* Context object on which the given function had to be called
|
|
3159
|
+
*/
|
|
3160
|
+
oListener?: object
|
|
3161
|
+
): this;
|
|
3162
|
+
/**
|
|
3163
|
+
* Fires event {@link #event:layoutChange layoutChange} to attached listeners.
|
|
3164
|
+
*/
|
|
3165
|
+
fireLayoutChange(
|
|
3166
|
+
/**
|
|
3167
|
+
* Parameters to pass along with the event
|
|
3168
|
+
*/
|
|
3169
|
+
mParameters?: {
|
|
3170
|
+
/**
|
|
3171
|
+
* The current layout
|
|
3172
|
+
*/
|
|
3173
|
+
layout?: FCLLayout;
|
|
3174
|
+
/**
|
|
3175
|
+
* The effective column layout, f.e [67%, 33%, 0]
|
|
3176
|
+
*/
|
|
3177
|
+
columnLayout?: any[];
|
|
3178
|
+
/**
|
|
3179
|
+
* Indicates if the start column is currently visible
|
|
3180
|
+
*/
|
|
3181
|
+
startColumnVisible?: boolean;
|
|
3182
|
+
/**
|
|
3183
|
+
* Indicates if the middle column is currently visible
|
|
3184
|
+
*/
|
|
3185
|
+
midColumnVisible?: boolean;
|
|
3186
|
+
/**
|
|
3187
|
+
* Indicates if the end column is currently visible
|
|
3188
|
+
*/
|
|
3189
|
+
endColumnVisible?: boolean;
|
|
3190
|
+
/**
|
|
3191
|
+
* Indicates if the layout is changed via the arrows
|
|
3192
|
+
*/
|
|
3193
|
+
arrowsUsed?: boolean;
|
|
3194
|
+
/**
|
|
3195
|
+
* Indicates if the layout is changed via resizing
|
|
3196
|
+
*/
|
|
3197
|
+
resize?: boolean;
|
|
3198
|
+
}
|
|
3199
|
+
): this;
|
|
3200
|
+
/**
|
|
3201
|
+
* Gets current value of property {@link #getAccessibilityRoles accessibilityRoles}.
|
|
3202
|
+
*
|
|
3203
|
+
* An object of strings that defines additional accessibility roles for further customization.
|
|
3204
|
+
*
|
|
3205
|
+
* It supports the following fields: - `startColumnRole`: the accessibility role for the `startColumn` -
|
|
3206
|
+
* `startArrowContainerRole`: the accessibility role for the first arrow container (between the `begin`
|
|
3207
|
+
* and `mid` columns) - `midColumnRole`: the accessibility role for the `midColumn` - `endArrowContainerRole`:
|
|
3208
|
+
* the accessibility role for the second arrow container (between the `mid` and `end` columns) - `endColumnRole`:
|
|
3209
|
+
* the accessibility role for the `endColumn`
|
|
3210
|
+
*
|
|
3211
|
+
* Default value is `{}`.
|
|
3212
|
+
*/
|
|
3213
|
+
getAccessibilityRoles(): object;
|
|
3214
|
+
/**
|
|
3215
|
+
* Gets current value of property {@link #getAccessibilityTexts accessibilityTexts}.
|
|
3216
|
+
*
|
|
3217
|
+
* An object of strings that defines several additional accessibility texts for even further customization.
|
|
3218
|
+
*
|
|
3219
|
+
* It supports the following fields: - `startColumnAccessibleName`: the accessibility name for the `startColumn`
|
|
3220
|
+
* region - `midColumnAccessibleName`: the accessibility name for the `midColumn` region - `endColumnAccessibleName`:
|
|
3221
|
+
* the accessibility name for the `endColumn` region - `startArrowLeftText`: the text that the first arrow
|
|
3222
|
+
* (between the `begin` and `mid` columns) will have when pointing to the left - `startArrowRightText`:
|
|
3223
|
+
* the text that the first arrow (between the `begin` and `mid` columns) will have when pointing to the
|
|
3224
|
+
* right - `endArrowLeftText`: the text that the second arrow (between the `mid` and `end` columns) will
|
|
3225
|
+
* have when pointing to the left - `endArrowRightText`: the text that the second arrow (between the `mid`
|
|
3226
|
+
* and `end` columns) will have when pointing to the right - `startArrowContainerAccessibleName`: the text
|
|
3227
|
+
* that the first arrow container (between the `begin` and `mid` columns) will have as `aria-label` - `endArrowContainerAccessibleName`:
|
|
3228
|
+
* the text that the second arrow container (between the `mid` and `end` columns) will have as `aria-label`
|
|
3229
|
+
*
|
|
3230
|
+
* Default value is `{}`.
|
|
3231
|
+
*/
|
|
3232
|
+
getAccessibilityTexts(): object;
|
|
3233
|
+
/**
|
|
3234
|
+
* Returns the current column layout, based on both the `layout` property and the screen size.
|
|
3235
|
+
*
|
|
3236
|
+
* **For example:** ["67%", "33%", 0], ["100%", 0, 0], ["25%", "50%", "25%"], etc, where the numbers represents
|
|
3237
|
+
* the width of the start, middle and end columns.
|
|
3238
|
+
*/
|
|
3239
|
+
getColumnLayout(): void;
|
|
3240
|
+
/**
|
|
3241
|
+
* Gets content of aggregation {@link #getEndColumn endColumn}.
|
|
3242
|
+
*
|
|
3243
|
+
* Defines the content in the end column.
|
|
3244
|
+
*/
|
|
3245
|
+
getEndColumn(): sap.ui.core.Control;
|
|
3246
|
+
/**
|
|
3247
|
+
* Returns if the `end` column is visible.
|
|
3248
|
+
*/
|
|
3249
|
+
getEndColumnVisible(): void;
|
|
3250
|
+
/**
|
|
3251
|
+
* Gets current value of property {@link #getHeight height}.
|
|
3252
|
+
*
|
|
3253
|
+
* Defines the height of the control
|
|
3254
|
+
*/
|
|
3255
|
+
getHeight(): sap.ui.core.CSSSize;
|
|
3256
|
+
/**
|
|
3257
|
+
* Gets current value of property {@link #getHideArrows hideArrows}.
|
|
3258
|
+
*
|
|
3259
|
+
* Defines the visibility of the arrows, used for expanding and shrinking the columns.
|
|
3260
|
+
*
|
|
3261
|
+
* Default value is `false`.
|
|
3262
|
+
*/
|
|
3263
|
+
getHideArrows(): boolean;
|
|
3264
|
+
/**
|
|
3265
|
+
* Gets current value of property {@link #getLayout layout}.
|
|
3266
|
+
*
|
|
3267
|
+
* Defines the columns layout and their proportion.
|
|
3268
|
+
*
|
|
3269
|
+
* **Note:** The layout also depends on the screen size - one column for screens smaller than 599px, two
|
|
3270
|
+
* columns between 599px and 1023px and three columns for sizes bigger than 1023px.
|
|
3271
|
+
*
|
|
3272
|
+
* Available options are:
|
|
3273
|
+
* - `OneColumn`
|
|
3274
|
+
* - `TwoColumnsStartExpanded`
|
|
3275
|
+
* - `TwoColumnsMidExpanded`
|
|
3276
|
+
* - `ThreeColumnsMidExpanded`
|
|
3277
|
+
* - `ThreeColumnsEndExpanded`
|
|
3278
|
+
* - `ThreeColumnsStartExpandedEndHidden`
|
|
3279
|
+
* - `ThreeColumnsMidExpandedEndHidden`
|
|
3280
|
+
* - `MidColumnFullScreen`
|
|
3281
|
+
* - `EndColumnFullScreen`
|
|
3282
|
+
*
|
|
3283
|
+
* **For example:** layout=`TwoColumnsStartExpanded` means the layout will display up to two columns in
|
|
3284
|
+
* 67%/33% proportion.
|
|
3285
|
+
*
|
|
3286
|
+
* Default value is `OneColumn`.
|
|
3287
|
+
*/
|
|
3288
|
+
getLayout(): sap.ui.webc.fiori.FCLLayout;
|
|
3289
|
+
/**
|
|
3290
|
+
* Gets content of aggregation {@link #getMidColumn midColumn}.
|
|
3291
|
+
*
|
|
3292
|
+
* Defines the content in the middle column.
|
|
3293
|
+
*/
|
|
3294
|
+
getMidColumn(): sap.ui.core.Control;
|
|
3295
|
+
/**
|
|
3296
|
+
* Returns if the `middle` column is visible.
|
|
3297
|
+
*/
|
|
3298
|
+
getMidColumnVisible(): void;
|
|
3299
|
+
/**
|
|
3300
|
+
* Gets content of aggregation {@link #getStartColumn startColumn}.
|
|
3301
|
+
*
|
|
3302
|
+
* Defines the content in the start column.
|
|
3303
|
+
*/
|
|
3304
|
+
getStartColumn(): sap.ui.core.Control;
|
|
3305
|
+
/**
|
|
3306
|
+
* Returns if the `start` column is visible.
|
|
3307
|
+
*/
|
|
3308
|
+
getStartColumnVisible(): void;
|
|
3309
|
+
/**
|
|
3310
|
+
* Returns the number of currently visible columns.
|
|
3311
|
+
*/
|
|
3312
|
+
getVisibleColumns(): void;
|
|
3313
|
+
/**
|
|
3314
|
+
* Gets current value of property {@link #getWidth width}.
|
|
3315
|
+
*
|
|
3316
|
+
* Defines the width of the control
|
|
3317
|
+
*/
|
|
3318
|
+
getWidth(): sap.ui.core.CSSSize;
|
|
3319
|
+
/**
|
|
3320
|
+
* Sets a new value for property {@link #getAccessibilityRoles accessibilityRoles}.
|
|
3321
|
+
*
|
|
3322
|
+
* An object of strings that defines additional accessibility roles for further customization.
|
|
3323
|
+
*
|
|
3324
|
+
* It supports the following fields: - `startColumnRole`: the accessibility role for the `startColumn` -
|
|
3325
|
+
* `startArrowContainerRole`: the accessibility role for the first arrow container (between the `begin`
|
|
3326
|
+
* and `mid` columns) - `midColumnRole`: the accessibility role for the `midColumn` - `endArrowContainerRole`:
|
|
3327
|
+
* the accessibility role for the second arrow container (between the `mid` and `end` columns) - `endColumnRole`:
|
|
3328
|
+
* the accessibility role for the `endColumn`
|
|
3329
|
+
*
|
|
3330
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3331
|
+
*
|
|
3332
|
+
* Default value is `{}`.
|
|
3333
|
+
*/
|
|
3334
|
+
setAccessibilityRoles(
|
|
3335
|
+
/**
|
|
3336
|
+
* New value for property `accessibilityRoles`
|
|
3337
|
+
*/
|
|
3338
|
+
oAccessibilityRoles?: object
|
|
3339
|
+
): this;
|
|
3340
|
+
/**
|
|
3341
|
+
* Sets a new value for property {@link #getAccessibilityTexts accessibilityTexts}.
|
|
3342
|
+
*
|
|
3343
|
+
* An object of strings that defines several additional accessibility texts for even further customization.
|
|
3344
|
+
*
|
|
3345
|
+
* It supports the following fields: - `startColumnAccessibleName`: the accessibility name for the `startColumn`
|
|
3346
|
+
* region - `midColumnAccessibleName`: the accessibility name for the `midColumn` region - `endColumnAccessibleName`:
|
|
3347
|
+
* the accessibility name for the `endColumn` region - `startArrowLeftText`: the text that the first arrow
|
|
3348
|
+
* (between the `begin` and `mid` columns) will have when pointing to the left - `startArrowRightText`:
|
|
3349
|
+
* the text that the first arrow (between the `begin` and `mid` columns) will have when pointing to the
|
|
3350
|
+
* right - `endArrowLeftText`: the text that the second arrow (between the `mid` and `end` columns) will
|
|
3351
|
+
* have when pointing to the left - `endArrowRightText`: the text that the second arrow (between the `mid`
|
|
3352
|
+
* and `end` columns) will have when pointing to the right - `startArrowContainerAccessibleName`: the text
|
|
3353
|
+
* that the first arrow container (between the `begin` and `mid` columns) will have as `aria-label` - `endArrowContainerAccessibleName`:
|
|
3354
|
+
* the text that the second arrow container (between the `mid` and `end` columns) will have as `aria-label`
|
|
3355
|
+
*
|
|
3356
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3357
|
+
*
|
|
3358
|
+
* Default value is `{}`.
|
|
3359
|
+
*/
|
|
3360
|
+
setAccessibilityTexts(
|
|
3361
|
+
/**
|
|
3362
|
+
* New value for property `accessibilityTexts`
|
|
3363
|
+
*/
|
|
3364
|
+
oAccessibilityTexts?: object
|
|
3365
|
+
): this;
|
|
3366
|
+
/**
|
|
3367
|
+
* Sets the aggregated {@link #getEndColumn endColumn}.
|
|
3368
|
+
*/
|
|
3369
|
+
setEndColumn(
|
|
3370
|
+
/**
|
|
3371
|
+
* The endColumn to set
|
|
3372
|
+
*/
|
|
3373
|
+
oEndColumn: sap.ui.core.Control
|
|
3374
|
+
): this;
|
|
3375
|
+
/**
|
|
3376
|
+
* Sets a new value for property {@link #getHeight height}.
|
|
3377
|
+
*
|
|
3378
|
+
* Defines the height of the control
|
|
3379
|
+
*
|
|
3380
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3381
|
+
*/
|
|
3382
|
+
setHeight(
|
|
3383
|
+
/**
|
|
3384
|
+
* New value for property `height`
|
|
3385
|
+
*/
|
|
3386
|
+
sHeight?: sap.ui.core.CSSSize
|
|
3387
|
+
): this;
|
|
3388
|
+
/**
|
|
3389
|
+
* Sets a new value for property {@link #getHideArrows hideArrows}.
|
|
3390
|
+
*
|
|
3391
|
+
* Defines the visibility of the arrows, used for expanding and shrinking the columns.
|
|
3392
|
+
*
|
|
3393
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3394
|
+
*
|
|
3395
|
+
* Default value is `false`.
|
|
3396
|
+
*/
|
|
3397
|
+
setHideArrows(
|
|
3398
|
+
/**
|
|
3399
|
+
* New value for property `hideArrows`
|
|
3400
|
+
*/
|
|
3401
|
+
bHideArrows?: boolean
|
|
3402
|
+
): this;
|
|
3403
|
+
/**
|
|
3404
|
+
* Sets a new value for property {@link #getLayout layout}.
|
|
3405
|
+
*
|
|
3406
|
+
* Defines the columns layout and their proportion.
|
|
3407
|
+
*
|
|
3408
|
+
* **Note:** The layout also depends on the screen size - one column for screens smaller than 599px, two
|
|
3409
|
+
* columns between 599px and 1023px and three columns for sizes bigger than 1023px.
|
|
3410
|
+
*
|
|
3411
|
+
* Available options are:
|
|
3412
|
+
* - `OneColumn`
|
|
2260
3413
|
* - `TwoColumnsStartExpanded`
|
|
2261
3414
|
* - `TwoColumnsMidExpanded`
|
|
2262
3415
|
* - `ThreeColumnsMidExpanded`
|
|
@@ -2266,78 +3419,820 @@ declare namespace sap {
|
|
|
2266
3419
|
* - `MidColumnFullScreen`
|
|
2267
3420
|
* - `EndColumnFullScreen`
|
|
2268
3421
|
*
|
|
2269
|
-
* **For example:** layout=`TwoColumnsStartExpanded` means the layout will display up to two columns in
|
|
2270
|
-
* 67%/33% proportion.
|
|
3422
|
+
* **For example:** layout=`TwoColumnsStartExpanded` means the layout will display up to two columns in
|
|
3423
|
+
* 67%/33% proportion.
|
|
3424
|
+
*
|
|
3425
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3426
|
+
*
|
|
3427
|
+
* Default value is `OneColumn`.
|
|
3428
|
+
*/
|
|
3429
|
+
setLayout(
|
|
3430
|
+
/**
|
|
3431
|
+
* New value for property `layout`
|
|
3432
|
+
*/
|
|
3433
|
+
sLayout?: sap.ui.webc.fiori.FCLLayout
|
|
3434
|
+
): this;
|
|
3435
|
+
/**
|
|
3436
|
+
* Sets the aggregated {@link #getMidColumn midColumn}.
|
|
3437
|
+
*/
|
|
3438
|
+
setMidColumn(
|
|
3439
|
+
/**
|
|
3440
|
+
* The midColumn to set
|
|
3441
|
+
*/
|
|
3442
|
+
oMidColumn: sap.ui.core.Control
|
|
3443
|
+
): this;
|
|
3444
|
+
/**
|
|
3445
|
+
* Sets the aggregated {@link #getStartColumn startColumn}.
|
|
3446
|
+
*/
|
|
3447
|
+
setStartColumn(
|
|
3448
|
+
/**
|
|
3449
|
+
* The startColumn to set
|
|
3450
|
+
*/
|
|
3451
|
+
oStartColumn: sap.ui.core.Control
|
|
3452
|
+
): this;
|
|
3453
|
+
/**
|
|
3454
|
+
* Sets a new value for property {@link #getWidth width}.
|
|
3455
|
+
*
|
|
3456
|
+
* Defines the width of the control
|
|
3457
|
+
*
|
|
3458
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3459
|
+
*/
|
|
3460
|
+
setWidth(
|
|
3461
|
+
/**
|
|
3462
|
+
* New value for property `width`
|
|
3463
|
+
*/
|
|
3464
|
+
sWidth?: sap.ui.core.CSSSize
|
|
3465
|
+
): this;
|
|
3466
|
+
}
|
|
3467
|
+
/**
|
|
3468
|
+
* @SINCE 1.95.0
|
|
3469
|
+
* @EXPERIMENTAL (since 1.95.0)
|
|
3470
|
+
*
|
|
3471
|
+
* Overview: An IllustratedMessage is a recommended combination of a solution-oriented message, an engaging
|
|
3472
|
+
* illustration, and conversational tone to better communicate an empty or a success state than just show
|
|
3473
|
+
* a message alone.
|
|
3474
|
+
*
|
|
3475
|
+
* Each illustration has default internationalised title and subtitle texts. Also they can be managed with
|
|
3476
|
+
* `titleText` and `subtitleText` properties.
|
|
3477
|
+
*
|
|
3478
|
+
* Structure: The IllustratedMessage consists of the following elements, which are displayed below each
|
|
3479
|
+
* other in the following order:
|
|
3480
|
+
*
|
|
3481
|
+
*
|
|
3482
|
+
*
|
|
3483
|
+
* - Illustration
|
|
3484
|
+
* - Title
|
|
3485
|
+
* - Subtitle
|
|
3486
|
+
* - Actions
|
|
3487
|
+
*
|
|
3488
|
+
* Usage: `sap.ui.webc.fiori.IllustratedMessage` is meant to be used inside container component, for example
|
|
3489
|
+
* a `sap.ui.webc.main.Card`, a `sap.ui.webc.main.Dialog` or a `sap.ui.webc.fiori.Page`
|
|
3490
|
+
*/
|
|
3491
|
+
class IllustratedMessage extends sap.ui.webc.common.WebComponent {
|
|
3492
|
+
/**
|
|
3493
|
+
* Constructor for a new `IllustratedMessage`.
|
|
3494
|
+
*
|
|
3495
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
3496
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
3497
|
+
* of the syntax of the settings object.
|
|
3498
|
+
*/
|
|
3499
|
+
constructor(
|
|
3500
|
+
/**
|
|
3501
|
+
* Initial settings for the new control
|
|
3502
|
+
*/
|
|
3503
|
+
mSettings?: sap.ui.webc.fiori.$IllustratedMessageSettings
|
|
3504
|
+
);
|
|
3505
|
+
/**
|
|
3506
|
+
* Constructor for a new `IllustratedMessage`.
|
|
3507
|
+
*
|
|
3508
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
3509
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
3510
|
+
* of the syntax of the settings object.
|
|
3511
|
+
*/
|
|
3512
|
+
constructor(
|
|
3513
|
+
/**
|
|
3514
|
+
* ID for the new control, generated automatically if no ID is given
|
|
3515
|
+
*/
|
|
3516
|
+
sId?: string,
|
|
3517
|
+
/**
|
|
3518
|
+
* Initial settings for the new control
|
|
3519
|
+
*/
|
|
3520
|
+
mSettings?: sap.ui.webc.fiori.$IllustratedMessageSettings
|
|
3521
|
+
);
|
|
3522
|
+
|
|
3523
|
+
/**
|
|
3524
|
+
* Creates a new subclass of class sap.ui.webc.fiori.IllustratedMessage with name `sClassName` and enriches
|
|
3525
|
+
* it with the information contained in `oClassInfo`.
|
|
3526
|
+
*
|
|
3527
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
|
|
3528
|
+
*/
|
|
3529
|
+
static extend<T extends Record<string, unknown>>(
|
|
3530
|
+
/**
|
|
3531
|
+
* Name of the class being created
|
|
3532
|
+
*/
|
|
3533
|
+
sClassName: string,
|
|
3534
|
+
/**
|
|
3535
|
+
* Object literal with information about the class
|
|
3536
|
+
*/
|
|
3537
|
+
oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.IllustratedMessage>,
|
|
3538
|
+
/**
|
|
3539
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
3540
|
+
* used by this class
|
|
3541
|
+
*/
|
|
3542
|
+
FNMetaImpl?: Function
|
|
3543
|
+
): Function;
|
|
3544
|
+
/**
|
|
3545
|
+
* Returns a metadata object for class sap.ui.webc.fiori.IllustratedMessage.
|
|
3546
|
+
*/
|
|
3547
|
+
static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
|
|
3548
|
+
/**
|
|
3549
|
+
* Adds some action to the aggregation {@link #getActions actions}.
|
|
3550
|
+
*/
|
|
3551
|
+
addAction(
|
|
3552
|
+
/**
|
|
3553
|
+
* The action to add; if empty, nothing is inserted
|
|
3554
|
+
*/
|
|
3555
|
+
oAction: sap.ui.webc.main.IButton
|
|
3556
|
+
): this;
|
|
3557
|
+
/**
|
|
3558
|
+
* Destroys all the actions in the aggregation {@link #getActions actions}.
|
|
3559
|
+
*/
|
|
3560
|
+
destroyActions(): this;
|
|
3561
|
+
/**
|
|
3562
|
+
* Destroys the subtitle in the aggregation {@link #getSubtitle subtitle}.
|
|
3563
|
+
*/
|
|
3564
|
+
destroySubtitle(): this;
|
|
3565
|
+
/**
|
|
3566
|
+
* Gets content of aggregation {@link #getActions actions}.
|
|
3567
|
+
*
|
|
3568
|
+
* Defines the component actions.
|
|
3569
|
+
*/
|
|
3570
|
+
getActions(): sap.ui.webc.main.IButton[];
|
|
3571
|
+
/**
|
|
3572
|
+
* Gets current value of property {@link #getName name}.
|
|
3573
|
+
*
|
|
3574
|
+
* Default value is `BeforeSearch`.
|
|
3575
|
+
*/
|
|
3576
|
+
getName(): sap.ui.webc.fiori.IllustrationMessageType;
|
|
3577
|
+
/**
|
|
3578
|
+
* Gets content of aggregation {@link #getSubtitle subtitle}.
|
|
3579
|
+
*
|
|
3580
|
+
* Defines the subtitle of the component.
|
|
3581
|
+
*
|
|
3582
|
+
* **Note:** Using this slot, the default subtitle text of illustration and the value of `subtitleText`
|
|
3583
|
+
* property will be overwritten.
|
|
3584
|
+
*/
|
|
3585
|
+
getSubtitle(): sap.ui.core.Control;
|
|
3586
|
+
/**
|
|
3587
|
+
* Gets current value of property {@link #getSubtitleText subtitleText}.
|
|
3588
|
+
*
|
|
3589
|
+
* Defines the subtitle of the component.
|
|
3590
|
+
*
|
|
3591
|
+
* **Note:** Using this property, the default subtitle text of illustration will be overwritten.
|
|
3592
|
+
*
|
|
3593
|
+
* **Note:** Using `subtitle` slot, the default of this property will be overwritten.
|
|
3594
|
+
*
|
|
3595
|
+
* Default value is `empty string`.
|
|
3596
|
+
*/
|
|
3597
|
+
getSubtitleText(): string;
|
|
3598
|
+
/**
|
|
3599
|
+
* Gets current value of property {@link #getTitleText titleText}.
|
|
3600
|
+
*
|
|
3601
|
+
* Defines the title of the component.
|
|
3602
|
+
*
|
|
3603
|
+
* **Note:** Using this property, the default title text of illustration will be overwritten.
|
|
3604
|
+
*
|
|
3605
|
+
* Default value is `empty string`.
|
|
3606
|
+
*/
|
|
3607
|
+
getTitleText(): string;
|
|
3608
|
+
/**
|
|
3609
|
+
* Checks for the provided `sap.ui.webc.main.IButton` in the aggregation {@link #getActions actions}. and
|
|
3610
|
+
* returns its index if found or -1 otherwise.
|
|
3611
|
+
*/
|
|
3612
|
+
indexOfAction(
|
|
3613
|
+
/**
|
|
3614
|
+
* The action whose index is looked for
|
|
3615
|
+
*/
|
|
3616
|
+
oAction: sap.ui.webc.main.IButton
|
|
3617
|
+
): int;
|
|
3618
|
+
/**
|
|
3619
|
+
* Inserts a action into the aggregation {@link #getActions actions}.
|
|
3620
|
+
*/
|
|
3621
|
+
insertAction(
|
|
3622
|
+
/**
|
|
3623
|
+
* The action to insert; if empty, nothing is inserted
|
|
3624
|
+
*/
|
|
3625
|
+
oAction: sap.ui.webc.main.IButton,
|
|
3626
|
+
/**
|
|
3627
|
+
* The `0`-based index the action should be inserted at; for a negative value of `iIndex`, the action is
|
|
3628
|
+
* inserted at position 0; for a value greater than the current size of the aggregation, the action is inserted
|
|
3629
|
+
* at the last position
|
|
3630
|
+
*/
|
|
3631
|
+
iIndex: int
|
|
3632
|
+
): this;
|
|
3633
|
+
/**
|
|
3634
|
+
* Removes a action from the aggregation {@link #getActions actions}.
|
|
3635
|
+
*/
|
|
3636
|
+
removeAction(
|
|
3637
|
+
/**
|
|
3638
|
+
* The action to remove or its index or id
|
|
3639
|
+
*/
|
|
3640
|
+
vAction: int | string | sap.ui.webc.main.IButton
|
|
3641
|
+
): sap.ui.webc.main.IButton;
|
|
3642
|
+
/**
|
|
3643
|
+
* Removes all the controls from the aggregation {@link #getActions actions}.
|
|
3644
|
+
*
|
|
3645
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
3646
|
+
*/
|
|
3647
|
+
removeAllActions(): sap.ui.webc.main.IButton[];
|
|
3648
|
+
/**
|
|
3649
|
+
* Sets a new value for property {@link #getName name}.
|
|
3650
|
+
*
|
|
3651
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3652
|
+
*
|
|
3653
|
+
* Default value is `BeforeSearch`.
|
|
3654
|
+
*/
|
|
3655
|
+
setName(
|
|
3656
|
+
/**
|
|
3657
|
+
* New value for property `name`
|
|
3658
|
+
*/
|
|
3659
|
+
sName?: sap.ui.webc.fiori.IllustrationMessageType
|
|
3660
|
+
): this;
|
|
3661
|
+
/**
|
|
3662
|
+
* Sets the aggregated {@link #getSubtitle subtitle}.
|
|
3663
|
+
*/
|
|
3664
|
+
setSubtitle(
|
|
3665
|
+
/**
|
|
3666
|
+
* The subtitle to set
|
|
3667
|
+
*/
|
|
3668
|
+
oSubtitle: sap.ui.core.Control
|
|
3669
|
+
): this;
|
|
3670
|
+
/**
|
|
3671
|
+
* Sets a new value for property {@link #getSubtitleText subtitleText}.
|
|
3672
|
+
*
|
|
3673
|
+
* Defines the subtitle of the component.
|
|
3674
|
+
*
|
|
3675
|
+
* **Note:** Using this property, the default subtitle text of illustration will be overwritten.
|
|
3676
|
+
*
|
|
3677
|
+
* **Note:** Using `subtitle` slot, the default of this property will be overwritten.
|
|
3678
|
+
*
|
|
3679
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3680
|
+
*
|
|
3681
|
+
* Default value is `empty string`.
|
|
3682
|
+
*/
|
|
3683
|
+
setSubtitleText(
|
|
3684
|
+
/**
|
|
3685
|
+
* New value for property `subtitleText`
|
|
3686
|
+
*/
|
|
3687
|
+
sSubtitleText?: string
|
|
3688
|
+
): this;
|
|
3689
|
+
/**
|
|
3690
|
+
* Sets a new value for property {@link #getTitleText titleText}.
|
|
3691
|
+
*
|
|
3692
|
+
* Defines the title of the component.
|
|
3693
|
+
*
|
|
3694
|
+
* **Note:** Using this property, the default title text of illustration will be overwritten.
|
|
3695
|
+
*
|
|
3696
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3697
|
+
*
|
|
3698
|
+
* Default value is `empty string`.
|
|
3699
|
+
*/
|
|
3700
|
+
setTitleText(
|
|
3701
|
+
/**
|
|
3702
|
+
* New value for property `titleText`
|
|
3703
|
+
*/
|
|
3704
|
+
sTitleText?: string
|
|
3705
|
+
): this;
|
|
3706
|
+
}
|
|
3707
|
+
/**
|
|
3708
|
+
* @SINCE 1.99.0
|
|
3709
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
3710
|
+
*
|
|
3711
|
+
* Overview:
|
|
3712
|
+
*
|
|
3713
|
+
* The `ui-media-gallery` component allows the user to browse through multimedia items. Currently, the supported
|
|
3714
|
+
* items are images and videos. The items should be defined using the `sap.ui.webc.fiori.MediaGalleryItem`
|
|
3715
|
+
* component.
|
|
3716
|
+
*
|
|
3717
|
+
* The items are initially displayed as thumbnails. When the user selects a thumbnail, the corresponding
|
|
3718
|
+
* item is displayed in larger size.
|
|
3719
|
+
* The component is responsive by default and adjusts the position of the menu with respect to viewport
|
|
3720
|
+
* size, but the application is able to further customize the layout via the provided API.
|
|
3721
|
+
*
|
|
3722
|
+
* Keyboard Handling: The `sap.ui.webc.fiori.MediaGallery` provides advanced keyboard handling.
|
|
3723
|
+
* When the thumbnails menu is focused the following keyboard shortcuts allow the user to navigate through
|
|
3724
|
+
* the thumbnail items:
|
|
3725
|
+
*
|
|
3726
|
+
*
|
|
3727
|
+
*
|
|
3728
|
+
* - [UP/DOWN] - Navigates up and down the items
|
|
3729
|
+
* - [HOME] - Navigates to first item
|
|
3730
|
+
* - [END] - Navigates to the last item [SPACE/ENTER] - Select an item
|
|
3731
|
+
*/
|
|
3732
|
+
class MediaGallery extends sap.ui.webc.common.WebComponent {
|
|
3733
|
+
/**
|
|
3734
|
+
* Constructor for a new `MediaGallery`.
|
|
3735
|
+
*
|
|
3736
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
3737
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
3738
|
+
* of the syntax of the settings object.
|
|
3739
|
+
*/
|
|
3740
|
+
constructor(
|
|
3741
|
+
/**
|
|
3742
|
+
* Initial settings for the new control
|
|
3743
|
+
*/
|
|
3744
|
+
mSettings?: sap.ui.webc.fiori.$MediaGallerySettings
|
|
3745
|
+
);
|
|
3746
|
+
/**
|
|
3747
|
+
* Constructor for a new `MediaGallery`.
|
|
3748
|
+
*
|
|
3749
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
3750
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
3751
|
+
* of the syntax of the settings object.
|
|
3752
|
+
*/
|
|
3753
|
+
constructor(
|
|
3754
|
+
/**
|
|
3755
|
+
* ID for the new control, generated automatically if no ID is given
|
|
3756
|
+
*/
|
|
3757
|
+
sId?: string,
|
|
3758
|
+
/**
|
|
3759
|
+
* Initial settings for the new control
|
|
3760
|
+
*/
|
|
3761
|
+
mSettings?: sap.ui.webc.fiori.$MediaGallerySettings
|
|
3762
|
+
);
|
|
3763
|
+
|
|
3764
|
+
/**
|
|
3765
|
+
* Creates a new subclass of class sap.ui.webc.fiori.MediaGallery with name `sClassName` and enriches it
|
|
3766
|
+
* with the information contained in `oClassInfo`.
|
|
3767
|
+
*
|
|
3768
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
|
|
3769
|
+
*/
|
|
3770
|
+
static extend<T extends Record<string, unknown>>(
|
|
3771
|
+
/**
|
|
3772
|
+
* Name of the class being created
|
|
3773
|
+
*/
|
|
3774
|
+
sClassName: string,
|
|
3775
|
+
/**
|
|
3776
|
+
* Object literal with information about the class
|
|
3777
|
+
*/
|
|
3778
|
+
oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.MediaGallery>,
|
|
3779
|
+
/**
|
|
3780
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
3781
|
+
* used by this class
|
|
3782
|
+
*/
|
|
3783
|
+
FNMetaImpl?: Function
|
|
3784
|
+
): Function;
|
|
3785
|
+
/**
|
|
3786
|
+
* Returns a metadata object for class sap.ui.webc.fiori.MediaGallery.
|
|
3787
|
+
*/
|
|
3788
|
+
static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
|
|
3789
|
+
/**
|
|
3790
|
+
* Adds some item to the aggregation {@link #getItems items}.
|
|
3791
|
+
*/
|
|
3792
|
+
addItem(
|
|
3793
|
+
/**
|
|
3794
|
+
* The item to add; if empty, nothing is inserted
|
|
3795
|
+
*/
|
|
3796
|
+
oItem: sap.ui.webc.fiori.IMediaGalleryItem
|
|
3797
|
+
): this;
|
|
3798
|
+
/**
|
|
3799
|
+
* Attaches event handler `fnFunction` to the {@link #event:displayAreaClick displayAreaClick} event of
|
|
3800
|
+
* this `sap.ui.webc.fiori.MediaGallery`.
|
|
3801
|
+
*
|
|
3802
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
3803
|
+
* otherwise it will be bound to this `sap.ui.webc.fiori.MediaGallery` itself.
|
|
3804
|
+
*
|
|
3805
|
+
* Fired when the display area is clicked.
|
|
3806
|
+
* The display area is the central area that contains the enlarged content of the currently selected item.
|
|
3807
|
+
*/
|
|
3808
|
+
attachDisplayAreaClick(
|
|
3809
|
+
/**
|
|
3810
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
3811
|
+
* object when firing the event
|
|
3812
|
+
*/
|
|
3813
|
+
oData: object,
|
|
3814
|
+
/**
|
|
3815
|
+
* The function to be called when the event occurs
|
|
3816
|
+
*/
|
|
3817
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
3818
|
+
/**
|
|
3819
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.MediaGallery` itself
|
|
3820
|
+
*/
|
|
3821
|
+
oListener?: object
|
|
3822
|
+
): this;
|
|
3823
|
+
/**
|
|
3824
|
+
* Attaches event handler `fnFunction` to the {@link #event:displayAreaClick displayAreaClick} event of
|
|
3825
|
+
* this `sap.ui.webc.fiori.MediaGallery`.
|
|
3826
|
+
*
|
|
3827
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
3828
|
+
* otherwise it will be bound to this `sap.ui.webc.fiori.MediaGallery` itself.
|
|
3829
|
+
*
|
|
3830
|
+
* Fired when the display area is clicked.
|
|
3831
|
+
* The display area is the central area that contains the enlarged content of the currently selected item.
|
|
3832
|
+
*/
|
|
3833
|
+
attachDisplayAreaClick(
|
|
3834
|
+
/**
|
|
3835
|
+
* The function to be called when the event occurs
|
|
3836
|
+
*/
|
|
3837
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
3838
|
+
/**
|
|
3839
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.MediaGallery` itself
|
|
3840
|
+
*/
|
|
3841
|
+
oListener?: object
|
|
3842
|
+
): this;
|
|
3843
|
+
/**
|
|
3844
|
+
* Attaches event handler `fnFunction` to the {@link #event:overflowClick overflowClick} event of this `sap.ui.webc.fiori.MediaGallery`.
|
|
3845
|
+
*
|
|
3846
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
3847
|
+
* otherwise it will be bound to this `sap.ui.webc.fiori.MediaGallery` itself.
|
|
3848
|
+
*
|
|
3849
|
+
* Fired when the thumbnails overflow button is clicked.
|
|
3850
|
+
*/
|
|
3851
|
+
attachOverflowClick(
|
|
3852
|
+
/**
|
|
3853
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
3854
|
+
* object when firing the event
|
|
3855
|
+
*/
|
|
3856
|
+
oData: object,
|
|
3857
|
+
/**
|
|
3858
|
+
* The function to be called when the event occurs
|
|
3859
|
+
*/
|
|
3860
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
3861
|
+
/**
|
|
3862
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.MediaGallery` itself
|
|
3863
|
+
*/
|
|
3864
|
+
oListener?: object
|
|
3865
|
+
): this;
|
|
3866
|
+
/**
|
|
3867
|
+
* Attaches event handler `fnFunction` to the {@link #event:overflowClick overflowClick} event of this `sap.ui.webc.fiori.MediaGallery`.
|
|
3868
|
+
*
|
|
3869
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
3870
|
+
* otherwise it will be bound to this `sap.ui.webc.fiori.MediaGallery` itself.
|
|
3871
|
+
*
|
|
3872
|
+
* Fired when the thumbnails overflow button is clicked.
|
|
3873
|
+
*/
|
|
3874
|
+
attachOverflowClick(
|
|
3875
|
+
/**
|
|
3876
|
+
* The function to be called when the event occurs
|
|
3877
|
+
*/
|
|
3878
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
3879
|
+
/**
|
|
3880
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.MediaGallery` itself
|
|
3881
|
+
*/
|
|
3882
|
+
oListener?: object
|
|
3883
|
+
): this;
|
|
3884
|
+
/**
|
|
3885
|
+
* Attaches event handler `fnFunction` to the {@link #event:selectionChange selectionChange} event of this
|
|
3886
|
+
* `sap.ui.webc.fiori.MediaGallery`.
|
|
3887
|
+
*
|
|
3888
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
3889
|
+
* otherwise it will be bound to this `sap.ui.webc.fiori.MediaGallery` itself.
|
|
3890
|
+
*
|
|
3891
|
+
* Fired when selection is changed by user interaction.
|
|
3892
|
+
*/
|
|
3893
|
+
attachSelectionChange(
|
|
3894
|
+
/**
|
|
3895
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
3896
|
+
* object when firing the event
|
|
3897
|
+
*/
|
|
3898
|
+
oData: object,
|
|
3899
|
+
/**
|
|
3900
|
+
* The function to be called when the event occurs
|
|
3901
|
+
*/
|
|
3902
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
3903
|
+
/**
|
|
3904
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.MediaGallery` itself
|
|
3905
|
+
*/
|
|
3906
|
+
oListener?: object
|
|
3907
|
+
): this;
|
|
3908
|
+
/**
|
|
3909
|
+
* Attaches event handler `fnFunction` to the {@link #event:selectionChange selectionChange} event of this
|
|
3910
|
+
* `sap.ui.webc.fiori.MediaGallery`.
|
|
3911
|
+
*
|
|
3912
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
3913
|
+
* otherwise it will be bound to this `sap.ui.webc.fiori.MediaGallery` itself.
|
|
3914
|
+
*
|
|
3915
|
+
* Fired when selection is changed by user interaction.
|
|
3916
|
+
*/
|
|
3917
|
+
attachSelectionChange(
|
|
3918
|
+
/**
|
|
3919
|
+
* The function to be called when the event occurs
|
|
3920
|
+
*/
|
|
3921
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
3922
|
+
/**
|
|
3923
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.MediaGallery` itself
|
|
3924
|
+
*/
|
|
3925
|
+
oListener?: object
|
|
3926
|
+
): this;
|
|
3927
|
+
/**
|
|
3928
|
+
* Destroys all the items in the aggregation {@link #getItems items}.
|
|
3929
|
+
*/
|
|
3930
|
+
destroyItems(): this;
|
|
3931
|
+
/**
|
|
3932
|
+
* Detaches event handler `fnFunction` from the {@link #event:displayAreaClick displayAreaClick} event of
|
|
3933
|
+
* this `sap.ui.webc.fiori.MediaGallery`.
|
|
3934
|
+
*
|
|
3935
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
3936
|
+
*/
|
|
3937
|
+
detachDisplayAreaClick(
|
|
3938
|
+
/**
|
|
3939
|
+
* The function to be called, when the event occurs
|
|
3940
|
+
*/
|
|
3941
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
3942
|
+
/**
|
|
3943
|
+
* Context object on which the given function had to be called
|
|
3944
|
+
*/
|
|
3945
|
+
oListener?: object
|
|
3946
|
+
): this;
|
|
3947
|
+
/**
|
|
3948
|
+
* Detaches event handler `fnFunction` from the {@link #event:overflowClick overflowClick} event of this
|
|
3949
|
+
* `sap.ui.webc.fiori.MediaGallery`.
|
|
3950
|
+
*
|
|
3951
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
3952
|
+
*/
|
|
3953
|
+
detachOverflowClick(
|
|
3954
|
+
/**
|
|
3955
|
+
* The function to be called, when the event occurs
|
|
3956
|
+
*/
|
|
3957
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
3958
|
+
/**
|
|
3959
|
+
* Context object on which the given function had to be called
|
|
3960
|
+
*/
|
|
3961
|
+
oListener?: object
|
|
3962
|
+
): this;
|
|
3963
|
+
/**
|
|
3964
|
+
* Detaches event handler `fnFunction` from the {@link #event:selectionChange selectionChange} event of
|
|
3965
|
+
* this `sap.ui.webc.fiori.MediaGallery`.
|
|
3966
|
+
*
|
|
3967
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
3968
|
+
*/
|
|
3969
|
+
detachSelectionChange(
|
|
3970
|
+
/**
|
|
3971
|
+
* The function to be called, when the event occurs
|
|
3972
|
+
*/
|
|
3973
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
3974
|
+
/**
|
|
3975
|
+
* Context object on which the given function had to be called
|
|
3976
|
+
*/
|
|
3977
|
+
oListener?: object
|
|
3978
|
+
): this;
|
|
3979
|
+
/**
|
|
3980
|
+
* Fires event {@link #event:displayAreaClick displayAreaClick} to attached listeners.
|
|
3981
|
+
*/
|
|
3982
|
+
fireDisplayAreaClick(
|
|
3983
|
+
/**
|
|
3984
|
+
* Parameters to pass along with the event
|
|
3985
|
+
*/
|
|
3986
|
+
mParameters?: object
|
|
3987
|
+
): this;
|
|
3988
|
+
/**
|
|
3989
|
+
* Fires event {@link #event:overflowClick overflowClick} to attached listeners.
|
|
3990
|
+
*/
|
|
3991
|
+
fireOverflowClick(
|
|
3992
|
+
/**
|
|
3993
|
+
* Parameters to pass along with the event
|
|
3994
|
+
*/
|
|
3995
|
+
mParameters?: object
|
|
3996
|
+
): this;
|
|
3997
|
+
/**
|
|
3998
|
+
* Fires event {@link #event:selectionChange selectionChange} to attached listeners.
|
|
3999
|
+
*/
|
|
4000
|
+
fireSelectionChange(
|
|
4001
|
+
/**
|
|
4002
|
+
* Parameters to pass along with the event
|
|
4003
|
+
*/
|
|
4004
|
+
mParameters?: {
|
|
4005
|
+
/**
|
|
4006
|
+
* the selected item.
|
|
4007
|
+
*/
|
|
4008
|
+
item?: HTMLElement;
|
|
4009
|
+
}
|
|
4010
|
+
): this;
|
|
4011
|
+
/**
|
|
4012
|
+
* Gets current value of property {@link #getInteractiveDisplayArea interactiveDisplayArea}.
|
|
4013
|
+
*
|
|
4014
|
+
* If enabled, a `display-area-click` event is fired when the user clicks or taps on the display area.
|
|
4015
|
+
* The display area is the central area that contains the enlarged content of the currently selected item.
|
|
4016
|
+
*
|
|
4017
|
+
* Default value is `false`.
|
|
4018
|
+
*/
|
|
4019
|
+
getInteractiveDisplayArea(): boolean;
|
|
4020
|
+
/**
|
|
4021
|
+
* Gets content of aggregation {@link #getItems items}.
|
|
4022
|
+
*
|
|
4023
|
+
* Defines the component items.
|
|
4024
|
+
*
|
|
4025
|
+
*
|
|
4026
|
+
*
|
|
4027
|
+
* **Note:** Only one selected item is allowed.
|
|
4028
|
+
*
|
|
4029
|
+
*
|
|
4030
|
+
*
|
|
4031
|
+
* **Note:** Use the `sap.ui.webc.fiori.MediaGalleryItem` component to define the desired items.
|
|
4032
|
+
*/
|
|
4033
|
+
getItems(): sap.ui.webc.fiori.IMediaGalleryItem[];
|
|
4034
|
+
/**
|
|
4035
|
+
* Gets current value of property {@link #getLayout layout}.
|
|
4036
|
+
*
|
|
4037
|
+
* Determines the layout of the component.
|
|
4038
|
+
*
|
|
4039
|
+
* Available options are:
|
|
4040
|
+
* - `Auto`
|
|
4041
|
+
* - `Vertical`
|
|
4042
|
+
* - `Horizontal`
|
|
4043
|
+
*
|
|
4044
|
+
* Default value is `Auto`.
|
|
4045
|
+
*/
|
|
4046
|
+
getLayout(): sap.ui.webc.fiori.MediaGalleryLayout;
|
|
4047
|
+
/**
|
|
4048
|
+
* Gets current value of property {@link #getMenuHorizontalAlign menuHorizontalAlign}.
|
|
4049
|
+
*
|
|
4050
|
+
* Determines the horizontal alignment of the thumbnails menu vs. the central display area.
|
|
4051
|
+
*
|
|
4052
|
+
* Available options are:
|
|
4053
|
+
* - `Left`
|
|
4054
|
+
* - `Right`
|
|
4055
|
+
*
|
|
4056
|
+
* Default value is `Left`.
|
|
4057
|
+
*/
|
|
4058
|
+
getMenuHorizontalAlign(): sap.ui.webc.fiori.MediaGalleryMenuHorizontalAlign;
|
|
4059
|
+
/**
|
|
4060
|
+
* Gets current value of property {@link #getMenuVerticalAlign menuVerticalAlign}.
|
|
4061
|
+
*
|
|
4062
|
+
* Determines the vertical alignment of the thumbnails menu vs. the central display area.
|
|
4063
|
+
*
|
|
4064
|
+
* Available options are:
|
|
4065
|
+
* - `Top`
|
|
4066
|
+
* - `Bottom`
|
|
4067
|
+
*
|
|
4068
|
+
* Default value is `Bottom`.
|
|
4069
|
+
*/
|
|
4070
|
+
getMenuVerticalAlign(): sap.ui.webc.fiori.MediaGalleryMenuVerticalAlign;
|
|
4071
|
+
/**
|
|
4072
|
+
* Gets current value of property {@link #getShowAllThumbnails showAllThumbnails}.
|
|
4073
|
+
*
|
|
4074
|
+
* If set to `true`, all thumbnails are rendered in a scrollable container. If `false`, only up to five
|
|
4075
|
+
* thumbnails are rendered, followed by an overflow button that shows the count of the remaining thumbnails.
|
|
4076
|
+
*
|
|
4077
|
+
* Default value is `false`.
|
|
4078
|
+
*/
|
|
4079
|
+
getShowAllThumbnails(): boolean;
|
|
4080
|
+
/**
|
|
4081
|
+
* Checks for the provided `sap.ui.webc.fiori.IMediaGalleryItem` in the aggregation {@link #getItems items}.
|
|
4082
|
+
* and returns its index if found or -1 otherwise.
|
|
4083
|
+
*/
|
|
4084
|
+
indexOfItem(
|
|
4085
|
+
/**
|
|
4086
|
+
* The item whose index is looked for
|
|
4087
|
+
*/
|
|
4088
|
+
oItem: sap.ui.webc.fiori.IMediaGalleryItem
|
|
4089
|
+
): int;
|
|
4090
|
+
/**
|
|
4091
|
+
* Inserts a item into the aggregation {@link #getItems items}.
|
|
4092
|
+
*/
|
|
4093
|
+
insertItem(
|
|
4094
|
+
/**
|
|
4095
|
+
* The item to insert; if empty, nothing is inserted
|
|
4096
|
+
*/
|
|
4097
|
+
oItem: sap.ui.webc.fiori.IMediaGalleryItem,
|
|
4098
|
+
/**
|
|
4099
|
+
* The `0`-based index the item should be inserted at; for a negative value of `iIndex`, the item is inserted
|
|
4100
|
+
* at position 0; for a value greater than the current size of the aggregation, the item is inserted at
|
|
4101
|
+
* the last position
|
|
4102
|
+
*/
|
|
4103
|
+
iIndex: int
|
|
4104
|
+
): this;
|
|
4105
|
+
/**
|
|
4106
|
+
* Removes all the controls from the aggregation {@link #getItems items}.
|
|
4107
|
+
*
|
|
4108
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
4109
|
+
*/
|
|
4110
|
+
removeAllItems(): sap.ui.webc.fiori.IMediaGalleryItem[];
|
|
4111
|
+
/**
|
|
4112
|
+
* Removes a item from the aggregation {@link #getItems items}.
|
|
4113
|
+
*/
|
|
4114
|
+
removeItem(
|
|
4115
|
+
/**
|
|
4116
|
+
* The item to remove or its index or id
|
|
4117
|
+
*/
|
|
4118
|
+
vItem: int | string | sap.ui.webc.fiori.IMediaGalleryItem
|
|
4119
|
+
): sap.ui.webc.fiori.IMediaGalleryItem;
|
|
4120
|
+
/**
|
|
4121
|
+
* Sets a new value for property {@link #getInteractiveDisplayArea interactiveDisplayArea}.
|
|
4122
|
+
*
|
|
4123
|
+
* If enabled, a `display-area-click` event is fired when the user clicks or taps on the display area.
|
|
4124
|
+
* The display area is the central area that contains the enlarged content of the currently selected item.
|
|
2271
4125
|
*
|
|
2272
4126
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2273
4127
|
*
|
|
2274
|
-
* Default value is `
|
|
4128
|
+
* Default value is `false`.
|
|
4129
|
+
*/
|
|
4130
|
+
setInteractiveDisplayArea(
|
|
4131
|
+
/**
|
|
4132
|
+
* New value for property `interactiveDisplayArea`
|
|
4133
|
+
*/
|
|
4134
|
+
bInteractiveDisplayArea?: boolean
|
|
4135
|
+
): this;
|
|
4136
|
+
/**
|
|
4137
|
+
* Sets a new value for property {@link #getLayout layout}.
|
|
4138
|
+
*
|
|
4139
|
+
* Determines the layout of the component.
|
|
4140
|
+
*
|
|
4141
|
+
* Available options are:
|
|
4142
|
+
* - `Auto`
|
|
4143
|
+
* - `Vertical`
|
|
4144
|
+
* - `Horizontal`
|
|
4145
|
+
*
|
|
4146
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
4147
|
+
*
|
|
4148
|
+
* Default value is `Auto`.
|
|
2275
4149
|
*/
|
|
2276
4150
|
setLayout(
|
|
2277
4151
|
/**
|
|
2278
4152
|
* New value for property `layout`
|
|
2279
4153
|
*/
|
|
2280
|
-
sLayout?: sap.ui.webc.fiori.
|
|
4154
|
+
sLayout?: sap.ui.webc.fiori.MediaGalleryLayout
|
|
2281
4155
|
): this;
|
|
2282
4156
|
/**
|
|
2283
|
-
* Sets
|
|
4157
|
+
* Sets a new value for property {@link #getMenuHorizontalAlign menuHorizontalAlign}.
|
|
4158
|
+
*
|
|
4159
|
+
* Determines the horizontal alignment of the thumbnails menu vs. the central display area.
|
|
4160
|
+
*
|
|
4161
|
+
* Available options are:
|
|
4162
|
+
* - `Left`
|
|
4163
|
+
* - `Right`
|
|
4164
|
+
*
|
|
4165
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
4166
|
+
*
|
|
4167
|
+
* Default value is `Left`.
|
|
2284
4168
|
*/
|
|
2285
|
-
|
|
4169
|
+
setMenuHorizontalAlign(
|
|
2286
4170
|
/**
|
|
2287
|
-
*
|
|
4171
|
+
* New value for property `menuHorizontalAlign`
|
|
2288
4172
|
*/
|
|
2289
|
-
|
|
4173
|
+
sMenuHorizontalAlign?: sap.ui.webc.fiori.MediaGalleryMenuHorizontalAlign
|
|
2290
4174
|
): this;
|
|
2291
4175
|
/**
|
|
2292
|
-
* Sets
|
|
4176
|
+
* Sets a new value for property {@link #getMenuVerticalAlign menuVerticalAlign}.
|
|
4177
|
+
*
|
|
4178
|
+
* Determines the vertical alignment of the thumbnails menu vs. the central display area.
|
|
4179
|
+
*
|
|
4180
|
+
* Available options are:
|
|
4181
|
+
* - `Top`
|
|
4182
|
+
* - `Bottom`
|
|
4183
|
+
*
|
|
4184
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
4185
|
+
*
|
|
4186
|
+
* Default value is `Bottom`.
|
|
2293
4187
|
*/
|
|
2294
|
-
|
|
4188
|
+
setMenuVerticalAlign(
|
|
2295
4189
|
/**
|
|
2296
|
-
*
|
|
4190
|
+
* New value for property `menuVerticalAlign`
|
|
2297
4191
|
*/
|
|
2298
|
-
|
|
4192
|
+
sMenuVerticalAlign?: sap.ui.webc.fiori.MediaGalleryMenuVerticalAlign
|
|
2299
4193
|
): this;
|
|
2300
4194
|
/**
|
|
2301
|
-
* Sets a new value for property {@link #
|
|
4195
|
+
* Sets a new value for property {@link #getShowAllThumbnails showAllThumbnails}.
|
|
2302
4196
|
*
|
|
2303
|
-
*
|
|
4197
|
+
* If set to `true`, all thumbnails are rendered in a scrollable container. If `false`, only up to five
|
|
4198
|
+
* thumbnails are rendered, followed by an overflow button that shows the count of the remaining thumbnails.
|
|
2304
4199
|
*
|
|
2305
4200
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
4201
|
+
*
|
|
4202
|
+
* Default value is `false`.
|
|
2306
4203
|
*/
|
|
2307
|
-
|
|
4204
|
+
setShowAllThumbnails(
|
|
2308
4205
|
/**
|
|
2309
|
-
* New value for property `
|
|
4206
|
+
* New value for property `showAllThumbnails`
|
|
2310
4207
|
*/
|
|
2311
|
-
|
|
4208
|
+
bShowAllThumbnails?: boolean
|
|
2312
4209
|
): this;
|
|
2313
4210
|
}
|
|
2314
4211
|
/**
|
|
2315
|
-
* @SINCE 1.
|
|
2316
|
-
* @EXPERIMENTAL (since 1.
|
|
4212
|
+
* @SINCE 1.99.0
|
|
4213
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
2317
4214
|
*
|
|
2318
|
-
* Overview:
|
|
2319
|
-
*
|
|
2320
|
-
* a message alone.
|
|
4215
|
+
* Overview: The `sap.ui.webc.fiori.MediaGalleryItem` web component represents the items displayed in the
|
|
4216
|
+
* `sap.ui.webc.fiori.MediaGallery` web component.
|
|
2321
4217
|
*
|
|
2322
|
-
*
|
|
2323
|
-
* `titleText` and `subtitleText` properties.
|
|
4218
|
+
* **Note:** `sap.ui.webc.fiori.MediaGalleryItem` is not supported when used outside of `sap.ui.webc.fiori.MediaGallery`.
|
|
2324
4219
|
*
|
|
2325
|
-
* Structure: The IllustratedMessage consists of the following elements, which are displayed below each
|
|
2326
|
-
* other in the following order:
|
|
2327
4220
|
*
|
|
2328
4221
|
*
|
|
2329
4222
|
*
|
|
2330
|
-
*
|
|
2331
|
-
*
|
|
2332
|
-
* - Subtitle
|
|
2333
|
-
* - Actions
|
|
4223
|
+
* Keyboard Handling: The `sap.ui.webc.fiori.MediaGallery` provides advanced keyboard handling. When focused,
|
|
4224
|
+
* the user can use the following keyboard shortcuts in order to perform a navigation:
|
|
2334
4225
|
*
|
|
2335
|
-
*
|
|
2336
|
-
*
|
|
4226
|
+
*
|
|
4227
|
+
*
|
|
4228
|
+
* - [SPACE/ENTER/RETURN] - Trigger `ui5-click` event
|
|
2337
4229
|
*/
|
|
2338
|
-
class
|
|
4230
|
+
class MediaGalleryItem
|
|
4231
|
+
extends sap.ui.webc.common.WebComponent
|
|
4232
|
+
implements sap.ui.webc.fiori.IMediaGalleryItem {
|
|
4233
|
+
__implements__sap_ui_webc_fiori_IMediaGalleryItem: boolean;
|
|
2339
4234
|
/**
|
|
2340
|
-
* Constructor for a new `
|
|
4235
|
+
* Constructor for a new `MediaGalleryItem`.
|
|
2341
4236
|
*
|
|
2342
4237
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2343
4238
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
@@ -2347,10 +4242,10 @@ declare namespace sap {
|
|
|
2347
4242
|
/**
|
|
2348
4243
|
* Initial settings for the new control
|
|
2349
4244
|
*/
|
|
2350
|
-
mSettings?: sap.ui.webc.fiori.$
|
|
4245
|
+
mSettings?: sap.ui.webc.fiori.$MediaGalleryItemSettings
|
|
2351
4246
|
);
|
|
2352
4247
|
/**
|
|
2353
|
-
* Constructor for a new `
|
|
4248
|
+
* Constructor for a new `MediaGalleryItem`.
|
|
2354
4249
|
*
|
|
2355
4250
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2356
4251
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
@@ -2364,11 +4259,11 @@ declare namespace sap {
|
|
|
2364
4259
|
/**
|
|
2365
4260
|
* Initial settings for the new control
|
|
2366
4261
|
*/
|
|
2367
|
-
mSettings?: sap.ui.webc.fiori.$
|
|
4262
|
+
mSettings?: sap.ui.webc.fiori.$MediaGalleryItemSettings
|
|
2368
4263
|
);
|
|
2369
4264
|
|
|
2370
4265
|
/**
|
|
2371
|
-
* Creates a new subclass of class sap.ui.webc.fiori.
|
|
4266
|
+
* Creates a new subclass of class sap.ui.webc.fiori.MediaGalleryItem with name `sClassName` and enriches
|
|
2372
4267
|
* it with the information contained in `oClassInfo`.
|
|
2373
4268
|
*
|
|
2374
4269
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
|
|
@@ -2381,7 +4276,7 @@ declare namespace sap {
|
|
|
2381
4276
|
/**
|
|
2382
4277
|
* Object literal with information about the class
|
|
2383
4278
|
*/
|
|
2384
|
-
oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.
|
|
4279
|
+
oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.MediaGalleryItem>,
|
|
2385
4280
|
/**
|
|
2386
4281
|
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
2387
4282
|
* used by this class
|
|
@@ -2389,166 +4284,203 @@ declare namespace sap {
|
|
|
2389
4284
|
FNMetaImpl?: Function
|
|
2390
4285
|
): Function;
|
|
2391
4286
|
/**
|
|
2392
|
-
* Returns a metadata object for class sap.ui.webc.fiori.
|
|
4287
|
+
* Returns a metadata object for class sap.ui.webc.fiori.MediaGalleryItem.
|
|
2393
4288
|
*/
|
|
2394
4289
|
static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
|
|
2395
4290
|
/**
|
|
2396
|
-
* Adds some
|
|
4291
|
+
* Adds some content to the aggregation {@link #getContent content}.
|
|
2397
4292
|
*/
|
|
2398
|
-
|
|
4293
|
+
addContent(
|
|
2399
4294
|
/**
|
|
2400
|
-
* The
|
|
4295
|
+
* The content to add; if empty, nothing is inserted
|
|
2401
4296
|
*/
|
|
2402
|
-
|
|
4297
|
+
oContent: sap.ui.core.Control
|
|
2403
4298
|
): this;
|
|
2404
4299
|
/**
|
|
2405
|
-
*
|
|
4300
|
+
* Adds some thumbnail to the aggregation {@link #getThumbnail thumbnail}.
|
|
2406
4301
|
*/
|
|
2407
|
-
|
|
4302
|
+
addThumbnail(
|
|
4303
|
+
/**
|
|
4304
|
+
* The thumbnail to add; if empty, nothing is inserted
|
|
4305
|
+
*/
|
|
4306
|
+
oThumbnail: sap.ui.core.Control
|
|
4307
|
+
): this;
|
|
2408
4308
|
/**
|
|
2409
|
-
* Destroys the
|
|
4309
|
+
* Destroys all the content in the aggregation {@link #getContent content}.
|
|
2410
4310
|
*/
|
|
2411
|
-
|
|
4311
|
+
destroyContent(): this;
|
|
2412
4312
|
/**
|
|
2413
|
-
*
|
|
2414
|
-
*
|
|
2415
|
-
* Defines the component actions.
|
|
4313
|
+
* Destroys all the thumbnail in the aggregation {@link #getThumbnail thumbnail}.
|
|
2416
4314
|
*/
|
|
2417
|
-
|
|
4315
|
+
destroyThumbnail(): this;
|
|
2418
4316
|
/**
|
|
2419
|
-
* Gets
|
|
4317
|
+
* Gets content of aggregation {@link #getContent content}.
|
|
2420
4318
|
*
|
|
2421
|
-
*
|
|
4319
|
+
* Defines the content of the component.
|
|
2422
4320
|
*/
|
|
2423
|
-
|
|
4321
|
+
getContent(): sap.ui.core.Control[];
|
|
2424
4322
|
/**
|
|
2425
|
-
* Gets
|
|
4323
|
+
* Gets current value of property {@link #getDisabled disabled}.
|
|
2426
4324
|
*
|
|
2427
|
-
* Defines the
|
|
4325
|
+
* Defines whether the component is in disabled state.
|
|
2428
4326
|
*
|
|
2429
|
-
*
|
|
2430
|
-
* property will be overwritten.
|
|
4327
|
+
* Default value is `false`.
|
|
2431
4328
|
*/
|
|
2432
|
-
|
|
4329
|
+
getDisabled(): boolean;
|
|
2433
4330
|
/**
|
|
2434
|
-
* Gets current value of property {@link #
|
|
2435
|
-
*
|
|
2436
|
-
* Defines the subtitle of the component.
|
|
4331
|
+
* Gets current value of property {@link #getLayout layout}.
|
|
2437
4332
|
*
|
|
2438
|
-
*
|
|
4333
|
+
* Determines the layout of the item container.
|
|
2439
4334
|
*
|
|
2440
|
-
*
|
|
4335
|
+
* Available options are:
|
|
4336
|
+
* - `Square`
|
|
4337
|
+
* - `Wide`
|
|
2441
4338
|
*
|
|
2442
|
-
* Default value is `
|
|
4339
|
+
* Default value is `Square`.
|
|
2443
4340
|
*/
|
|
2444
|
-
|
|
4341
|
+
getLayout(): sap.ui.webc.fiori.MediaGalleryItemLayout;
|
|
2445
4342
|
/**
|
|
2446
|
-
* Gets current value of property {@link #
|
|
4343
|
+
* Gets current value of property {@link #getSelected selected}.
|
|
2447
4344
|
*
|
|
2448
|
-
* Defines the
|
|
4345
|
+
* Defines the selected state of the component.
|
|
2449
4346
|
*
|
|
2450
|
-
*
|
|
4347
|
+
* Default value is `false`.
|
|
4348
|
+
*/
|
|
4349
|
+
getSelected(): boolean;
|
|
4350
|
+
/**
|
|
4351
|
+
* Gets content of aggregation {@link #getThumbnail thumbnail}.
|
|
2451
4352
|
*
|
|
2452
|
-
*
|
|
4353
|
+
* Defines the content of the thumbnail.
|
|
2453
4354
|
*/
|
|
2454
|
-
|
|
4355
|
+
getThumbnail(): sap.ui.core.Control[];
|
|
2455
4356
|
/**
|
|
2456
|
-
* Checks for the provided `sap.ui.
|
|
4357
|
+
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getContent content}. and returns
|
|
4358
|
+
* its index if found or -1 otherwise.
|
|
4359
|
+
*/
|
|
4360
|
+
indexOfContent(
|
|
4361
|
+
/**
|
|
4362
|
+
* The content whose index is looked for
|
|
4363
|
+
*/
|
|
4364
|
+
oContent: sap.ui.core.Control
|
|
4365
|
+
): int;
|
|
4366
|
+
/**
|
|
4367
|
+
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getThumbnail thumbnail}. and
|
|
2457
4368
|
* returns its index if found or -1 otherwise.
|
|
2458
4369
|
*/
|
|
2459
|
-
|
|
4370
|
+
indexOfThumbnail(
|
|
2460
4371
|
/**
|
|
2461
|
-
* The
|
|
4372
|
+
* The thumbnail whose index is looked for
|
|
2462
4373
|
*/
|
|
2463
|
-
|
|
4374
|
+
oThumbnail: sap.ui.core.Control
|
|
2464
4375
|
): int;
|
|
2465
4376
|
/**
|
|
2466
|
-
* Inserts a
|
|
4377
|
+
* Inserts a content into the aggregation {@link #getContent content}.
|
|
2467
4378
|
*/
|
|
2468
|
-
|
|
4379
|
+
insertContent(
|
|
2469
4380
|
/**
|
|
2470
|
-
* The
|
|
4381
|
+
* The content to insert; if empty, nothing is inserted
|
|
2471
4382
|
*/
|
|
2472
|
-
|
|
4383
|
+
oContent: sap.ui.core.Control,
|
|
2473
4384
|
/**
|
|
2474
|
-
* The `0`-based index the
|
|
2475
|
-
* inserted at position 0; for a value greater than the current size of the aggregation, the
|
|
2476
|
-
* at the last position
|
|
4385
|
+
* The `0`-based index the content should be inserted at; for a negative value of `iIndex`, the content
|
|
4386
|
+
* is inserted at position 0; for a value greater than the current size of the aggregation, the content
|
|
4387
|
+
* is inserted at the last position
|
|
2477
4388
|
*/
|
|
2478
4389
|
iIndex: int
|
|
2479
4390
|
): this;
|
|
2480
4391
|
/**
|
|
2481
|
-
*
|
|
4392
|
+
* Inserts a thumbnail into the aggregation {@link #getThumbnail thumbnail}.
|
|
2482
4393
|
*/
|
|
2483
|
-
|
|
4394
|
+
insertThumbnail(
|
|
2484
4395
|
/**
|
|
2485
|
-
* The
|
|
4396
|
+
* The thumbnail to insert; if empty, nothing is inserted
|
|
2486
4397
|
*/
|
|
2487
|
-
|
|
2488
|
-
|
|
4398
|
+
oThumbnail: sap.ui.core.Control,
|
|
4399
|
+
/**
|
|
4400
|
+
* The `0`-based index the thumbnail should be inserted at; for a negative value of `iIndex`, the thumbnail
|
|
4401
|
+
* is inserted at position 0; for a value greater than the current size of the aggregation, the thumbnail
|
|
4402
|
+
* is inserted at the last position
|
|
4403
|
+
*/
|
|
4404
|
+
iIndex: int
|
|
4405
|
+
): this;
|
|
2489
4406
|
/**
|
|
2490
|
-
* Removes all the controls from the aggregation {@link #
|
|
4407
|
+
* Removes all the controls from the aggregation {@link #getContent content}.
|
|
2491
4408
|
*
|
|
2492
4409
|
* Additionally, it unregisters them from the hosting UIArea.
|
|
2493
4410
|
*/
|
|
2494
|
-
|
|
4411
|
+
removeAllContent(): sap.ui.core.Control[];
|
|
2495
4412
|
/**
|
|
2496
|
-
*
|
|
2497
|
-
*
|
|
2498
|
-
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
4413
|
+
* Removes all the controls from the aggregation {@link #getThumbnail thumbnail}.
|
|
2499
4414
|
*
|
|
2500
|
-
*
|
|
4415
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
2501
4416
|
*/
|
|
2502
|
-
|
|
4417
|
+
removeAllThumbnail(): sap.ui.core.Control[];
|
|
4418
|
+
/**
|
|
4419
|
+
* Removes a content from the aggregation {@link #getContent content}.
|
|
4420
|
+
*/
|
|
4421
|
+
removeContent(
|
|
2503
4422
|
/**
|
|
2504
|
-
*
|
|
4423
|
+
* The content to remove or its index or id
|
|
2505
4424
|
*/
|
|
2506
|
-
|
|
2507
|
-
):
|
|
4425
|
+
vContent: int | string | sap.ui.core.Control
|
|
4426
|
+
): sap.ui.core.Control;
|
|
2508
4427
|
/**
|
|
2509
|
-
*
|
|
4428
|
+
* Removes a thumbnail from the aggregation {@link #getThumbnail thumbnail}.
|
|
2510
4429
|
*/
|
|
2511
|
-
|
|
4430
|
+
removeThumbnail(
|
|
2512
4431
|
/**
|
|
2513
|
-
* The
|
|
4432
|
+
* The thumbnail to remove or its index or id
|
|
2514
4433
|
*/
|
|
2515
|
-
|
|
2516
|
-
):
|
|
4434
|
+
vThumbnail: int | string | sap.ui.core.Control
|
|
4435
|
+
): sap.ui.core.Control;
|
|
2517
4436
|
/**
|
|
2518
|
-
* Sets a new value for property {@link #
|
|
4437
|
+
* Sets a new value for property {@link #getDisabled disabled}.
|
|
2519
4438
|
*
|
|
2520
|
-
* Defines the
|
|
4439
|
+
* Defines whether the component is in disabled state.
|
|
2521
4440
|
*
|
|
2522
|
-
*
|
|
4441
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2523
4442
|
*
|
|
2524
|
-
*
|
|
4443
|
+
* Default value is `false`.
|
|
4444
|
+
*/
|
|
4445
|
+
setDisabled(
|
|
4446
|
+
/**
|
|
4447
|
+
* New value for property `disabled`
|
|
4448
|
+
*/
|
|
4449
|
+
bDisabled?: boolean
|
|
4450
|
+
): this;
|
|
4451
|
+
/**
|
|
4452
|
+
* Sets a new value for property {@link #getLayout layout}.
|
|
4453
|
+
*
|
|
4454
|
+
* Determines the layout of the item container.
|
|
4455
|
+
*
|
|
4456
|
+
* Available options are:
|
|
4457
|
+
* - `Square`
|
|
4458
|
+
* - `Wide`
|
|
2525
4459
|
*
|
|
2526
4460
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2527
4461
|
*
|
|
2528
|
-
* Default value is `
|
|
4462
|
+
* Default value is `Square`.
|
|
2529
4463
|
*/
|
|
2530
|
-
|
|
4464
|
+
setLayout(
|
|
2531
4465
|
/**
|
|
2532
|
-
* New value for property `
|
|
4466
|
+
* New value for property `layout`
|
|
2533
4467
|
*/
|
|
2534
|
-
|
|
4468
|
+
sLayout?: sap.ui.webc.fiori.MediaGalleryItemLayout
|
|
2535
4469
|
): this;
|
|
2536
4470
|
/**
|
|
2537
|
-
* Sets a new value for property {@link #
|
|
2538
|
-
*
|
|
2539
|
-
* Defines the title of the component.
|
|
4471
|
+
* Sets a new value for property {@link #getSelected selected}.
|
|
2540
4472
|
*
|
|
2541
|
-
*
|
|
4473
|
+
* Defines the selected state of the component.
|
|
2542
4474
|
*
|
|
2543
4475
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2544
4476
|
*
|
|
2545
|
-
* Default value is `
|
|
4477
|
+
* Default value is `false`.
|
|
2546
4478
|
*/
|
|
2547
|
-
|
|
4479
|
+
setSelected(
|
|
2548
4480
|
/**
|
|
2549
|
-
* New value for property `
|
|
4481
|
+
* New value for property `selected`
|
|
2550
4482
|
*/
|
|
2551
|
-
|
|
4483
|
+
bSelected?: boolean
|
|
2552
4484
|
): this;
|
|
2553
4485
|
}
|
|
2554
4486
|
/**
|
|
@@ -3873,34 +5805,16 @@ declare namespace sap {
|
|
|
3873
5805
|
*/
|
|
3874
5806
|
oContent: sap.ui.core.Control
|
|
3875
5807
|
): this;
|
|
3876
|
-
/**
|
|
3877
|
-
* Adds some footer to the aggregation {@link #getFooter footer}.
|
|
3878
|
-
*/
|
|
3879
|
-
addFooter(
|
|
3880
|
-
/**
|
|
3881
|
-
* The footer to add; if empty, nothing is inserted
|
|
3882
|
-
*/
|
|
3883
|
-
oFooter: sap.ui.core.Control
|
|
3884
|
-
): this;
|
|
3885
|
-
/**
|
|
3886
|
-
* Adds some header to the aggregation {@link #getHeader header}.
|
|
3887
|
-
*/
|
|
3888
|
-
addHeader(
|
|
3889
|
-
/**
|
|
3890
|
-
* The header to add; if empty, nothing is inserted
|
|
3891
|
-
*/
|
|
3892
|
-
oHeader: sap.ui.core.Control
|
|
3893
|
-
): this;
|
|
3894
5808
|
/**
|
|
3895
5809
|
* Destroys all the content in the aggregation {@link #getContent content}.
|
|
3896
5810
|
*/
|
|
3897
5811
|
destroyContent(): this;
|
|
3898
5812
|
/**
|
|
3899
|
-
* Destroys
|
|
5813
|
+
* Destroys the footer in the aggregation {@link #getFooter footer}.
|
|
3900
5814
|
*/
|
|
3901
5815
|
destroyFooter(): this;
|
|
3902
5816
|
/**
|
|
3903
|
-
* Destroys
|
|
5817
|
+
* Destroys the header in the aggregation {@link #getHeader header}.
|
|
3904
5818
|
*/
|
|
3905
5819
|
destroyHeader(): this;
|
|
3906
5820
|
/**
|
|
@@ -3949,13 +5863,13 @@ declare namespace sap {
|
|
|
3949
5863
|
*
|
|
3950
5864
|
* Defines the footer HTML Element.
|
|
3951
5865
|
*/
|
|
3952
|
-
getFooter(): sap.ui.
|
|
5866
|
+
getFooter(): sap.ui.webc.fiori.IBar;
|
|
3953
5867
|
/**
|
|
3954
5868
|
* Gets content of aggregation {@link #getHeader header}.
|
|
3955
5869
|
*
|
|
3956
5870
|
* Defines the header HTML Element.
|
|
3957
5871
|
*/
|
|
3958
|
-
getHeader(): sap.ui.
|
|
5872
|
+
getHeader(): sap.ui.webc.fiori.IBar;
|
|
3959
5873
|
/**
|
|
3960
5874
|
* Gets current value of property {@link #getHeight height}.
|
|
3961
5875
|
*
|
|
@@ -3986,26 +5900,6 @@ declare namespace sap {
|
|
|
3986
5900
|
*/
|
|
3987
5901
|
oContent: sap.ui.core.Control
|
|
3988
5902
|
): int;
|
|
3989
|
-
/**
|
|
3990
|
-
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getFooter footer}. and returns
|
|
3991
|
-
* its index if found or -1 otherwise.
|
|
3992
|
-
*/
|
|
3993
|
-
indexOfFooter(
|
|
3994
|
-
/**
|
|
3995
|
-
* The footer whose index is looked for
|
|
3996
|
-
*/
|
|
3997
|
-
oFooter: sap.ui.core.Control
|
|
3998
|
-
): int;
|
|
3999
|
-
/**
|
|
4000
|
-
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getHeader header}. and returns
|
|
4001
|
-
* its index if found or -1 otherwise.
|
|
4002
|
-
*/
|
|
4003
|
-
indexOfHeader(
|
|
4004
|
-
/**
|
|
4005
|
-
* The header whose index is looked for
|
|
4006
|
-
*/
|
|
4007
|
-
oHeader: sap.ui.core.Control
|
|
4008
|
-
): int;
|
|
4009
5903
|
/**
|
|
4010
5904
|
* Inserts a content into the aggregation {@link #getContent content}.
|
|
4011
5905
|
*/
|
|
@@ -4015,39 +5909,9 @@ declare namespace sap {
|
|
|
4015
5909
|
*/
|
|
4016
5910
|
oContent: sap.ui.core.Control,
|
|
4017
5911
|
/**
|
|
4018
|
-
* The `0`-based index the content should be inserted at; for a negative value of `iIndex`, the content
|
|
4019
|
-
* is inserted at position 0; for a value greater than the current size of the aggregation, the content
|
|
4020
|
-
* is inserted at the last position
|
|
4021
|
-
*/
|
|
4022
|
-
iIndex: int
|
|
4023
|
-
): this;
|
|
4024
|
-
/**
|
|
4025
|
-
* Inserts a footer into the aggregation {@link #getFooter footer}.
|
|
4026
|
-
*/
|
|
4027
|
-
insertFooter(
|
|
4028
|
-
/**
|
|
4029
|
-
* The footer to insert; if empty, nothing is inserted
|
|
4030
|
-
*/
|
|
4031
|
-
oFooter: sap.ui.core.Control,
|
|
4032
|
-
/**
|
|
4033
|
-
* The `0`-based index the footer should be inserted at; for a negative value of `iIndex`, the footer is
|
|
4034
|
-
* inserted at position 0; for a value greater than the current size of the aggregation, the footer is inserted
|
|
4035
|
-
* at the last position
|
|
4036
|
-
*/
|
|
4037
|
-
iIndex: int
|
|
4038
|
-
): this;
|
|
4039
|
-
/**
|
|
4040
|
-
* Inserts a header into the aggregation {@link #getHeader header}.
|
|
4041
|
-
*/
|
|
4042
|
-
insertHeader(
|
|
4043
|
-
/**
|
|
4044
|
-
* The header to insert; if empty, nothing is inserted
|
|
4045
|
-
*/
|
|
4046
|
-
oHeader: sap.ui.core.Control,
|
|
4047
|
-
/**
|
|
4048
|
-
* The `0`-based index the header should be inserted at; for a negative value of `iIndex`, the header is
|
|
4049
|
-
* inserted at position 0; for a value greater than the current size of the aggregation, the header is inserted
|
|
4050
|
-
* at the last position
|
|
5912
|
+
* The `0`-based index the content should be inserted at; for a negative value of `iIndex`, the content
|
|
5913
|
+
* is inserted at position 0; for a value greater than the current size of the aggregation, the content
|
|
5914
|
+
* is inserted at the last position
|
|
4051
5915
|
*/
|
|
4052
5916
|
iIndex: int
|
|
4053
5917
|
): this;
|
|
@@ -4057,18 +5921,6 @@ declare namespace sap {
|
|
|
4057
5921
|
* Additionally, it unregisters them from the hosting UIArea.
|
|
4058
5922
|
*/
|
|
4059
5923
|
removeAllContent(): sap.ui.core.Control[];
|
|
4060
|
-
/**
|
|
4061
|
-
* Removes all the controls from the aggregation {@link #getFooter footer}.
|
|
4062
|
-
*
|
|
4063
|
-
* Additionally, it unregisters them from the hosting UIArea.
|
|
4064
|
-
*/
|
|
4065
|
-
removeAllFooter(): sap.ui.core.Control[];
|
|
4066
|
-
/**
|
|
4067
|
-
* Removes all the controls from the aggregation {@link #getHeader header}.
|
|
4068
|
-
*
|
|
4069
|
-
* Additionally, it unregisters them from the hosting UIArea.
|
|
4070
|
-
*/
|
|
4071
|
-
removeAllHeader(): sap.ui.core.Control[];
|
|
4072
5924
|
/**
|
|
4073
5925
|
* Removes a content from the aggregation {@link #getContent content}.
|
|
4074
5926
|
*/
|
|
@@ -4078,24 +5930,6 @@ declare namespace sap {
|
|
|
4078
5930
|
*/
|
|
4079
5931
|
vContent: int | string | sap.ui.core.Control
|
|
4080
5932
|
): sap.ui.core.Control;
|
|
4081
|
-
/**
|
|
4082
|
-
* Removes a footer from the aggregation {@link #getFooter footer}.
|
|
4083
|
-
*/
|
|
4084
|
-
removeFooter(
|
|
4085
|
-
/**
|
|
4086
|
-
* The footer to remove or its index or id
|
|
4087
|
-
*/
|
|
4088
|
-
vFooter: int | string | sap.ui.core.Control
|
|
4089
|
-
): sap.ui.core.Control;
|
|
4090
|
-
/**
|
|
4091
|
-
* Removes a header from the aggregation {@link #getHeader header}.
|
|
4092
|
-
*/
|
|
4093
|
-
removeHeader(
|
|
4094
|
-
/**
|
|
4095
|
-
* The header to remove or its index or id
|
|
4096
|
-
*/
|
|
4097
|
-
vHeader: int | string | sap.ui.core.Control
|
|
4098
|
-
): sap.ui.core.Control;
|
|
4099
5933
|
/**
|
|
4100
5934
|
* Sets a new value for property {@link #getBackgroundDesign backgroundDesign}.
|
|
4101
5935
|
*
|
|
@@ -4152,6 +5986,24 @@ declare namespace sap {
|
|
|
4152
5986
|
*/
|
|
4153
5987
|
bFloatingFooter?: boolean
|
|
4154
5988
|
): this;
|
|
5989
|
+
/**
|
|
5990
|
+
* Sets the aggregated {@link #getFooter footer}.
|
|
5991
|
+
*/
|
|
5992
|
+
setFooter(
|
|
5993
|
+
/**
|
|
5994
|
+
* The footer to set
|
|
5995
|
+
*/
|
|
5996
|
+
oFooter: sap.ui.webc.fiori.IBar
|
|
5997
|
+
): this;
|
|
5998
|
+
/**
|
|
5999
|
+
* Sets the aggregated {@link #getHeader header}.
|
|
6000
|
+
*/
|
|
6001
|
+
setHeader(
|
|
6002
|
+
/**
|
|
6003
|
+
* The header to set
|
|
6004
|
+
*/
|
|
6005
|
+
oHeader: sap.ui.webc.fiori.IBar
|
|
6006
|
+
): this;
|
|
4155
6007
|
/**
|
|
4156
6008
|
* Sets a new value for property {@link #getHeight height}.
|
|
4157
6009
|
*
|
|
@@ -4646,16 +6498,14 @@ declare namespace sap {
|
|
|
4646
6498
|
* - profile
|
|
4647
6499
|
* - product-switch
|
|
4648
6500
|
*
|
|
4649
|
-
* In the context of `sap.ui.webc.fiori.ShellBar`, you can provide a custom stable DOM refs for:
|
|
4650
|
-
* - Every `sap.ui.webc.fiori.ShellBarItem` that you provide. Example: `
|
|
4651
|
-
* `
|
|
4652
|
-
*
|
|
4653
6501
|
* CSS Shadow Parts:
|
|
4654
6502
|
*
|
|
4655
6503
|
* CSS Shadow Parts
|
|
4656
6504
|
* allow developers to style elements inside the Shadow DOM.
|
|
4657
6505
|
* The `sap.ui.webc.fiori.ShellBar` exposes the following CSS Shadow Parts:
|
|
4658
6506
|
* - root - Used to style the outermost wrapper of the `sap.ui.webc.fiori.ShellBar`
|
|
6507
|
+
*
|
|
6508
|
+
* Keyboard Handling:
|
|
4659
6509
|
*/
|
|
4660
6510
|
class ShellBar extends sap.ui.webc.common.WebComponent {
|
|
4661
6511
|
/**
|
|
@@ -4820,7 +6670,7 @@ declare namespace sap {
|
|
|
4820
6670
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
4821
6671
|
* otherwise it will be bound to this `sap.ui.webc.fiori.ShellBar` itself.
|
|
4822
6672
|
*
|
|
4823
|
-
* Fired, when a menu item is activated **Note:** You can prevent closing of
|
|
6673
|
+
* Fired, when a menu item is activated **Note:** You can prevent closing of overflow popover by calling
|
|
4824
6674
|
* `event.preventDefault()`.
|
|
4825
6675
|
*/
|
|
4826
6676
|
attachMenuItemClick(
|
|
@@ -4844,7 +6694,7 @@ declare namespace sap {
|
|
|
4844
6694
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
4845
6695
|
* otherwise it will be bound to this `sap.ui.webc.fiori.ShellBar` itself.
|
|
4846
6696
|
*
|
|
4847
|
-
* Fired, when a menu item is activated **Note:** You can prevent closing of
|
|
6697
|
+
* Fired, when a menu item is activated **Note:** You can prevent closing of overflow popover by calling
|
|
4848
6698
|
* `event.preventDefault()`.
|
|
4849
6699
|
*/
|
|
4850
6700
|
attachMenuItemClick(
|
|
@@ -4907,7 +6757,7 @@ declare namespace sap {
|
|
|
4907
6757
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
4908
6758
|
* otherwise it will be bound to this `sap.ui.webc.fiori.ShellBar` itself.
|
|
4909
6759
|
*
|
|
4910
|
-
* Fired, when the product switch icon is activated. **Note:** You can prevent closing of
|
|
6760
|
+
* Fired, when the product switch icon is activated. **Note:** You can prevent closing of overflow popover
|
|
4911
6761
|
* by calling `event.preventDefault()`.
|
|
4912
6762
|
*/
|
|
4913
6763
|
attachProductSwitchClick(
|
|
@@ -4932,7 +6782,7 @@ declare namespace sap {
|
|
|
4932
6782
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
4933
6783
|
* otherwise it will be bound to this `sap.ui.webc.fiori.ShellBar` itself.
|
|
4934
6784
|
*
|
|
4935
|
-
* Fired, when the product switch icon is activated. **Note:** You can prevent closing of
|
|
6785
|
+
* Fired, when the product switch icon is activated. **Note:** You can prevent closing of overflow popover
|
|
4936
6786
|
* by calling `event.preventDefault()`.
|
|
4937
6787
|
*/
|
|
4938
6788
|
attachProductSwitchClick(
|
|
@@ -5198,6 +7048,21 @@ declare namespace sap {
|
|
|
5198
7048
|
targetRef?: HTMLElement;
|
|
5199
7049
|
}
|
|
5200
7050
|
): this;
|
|
7051
|
+
/**
|
|
7052
|
+
* Gets current value of property {@link #getAccessibilityTexts accessibilityTexts}.
|
|
7053
|
+
*
|
|
7054
|
+
* An object of strings that defines several additional accessibility texts for even further customization.
|
|
7055
|
+
*
|
|
7056
|
+
* It supports the following fields: - `profileButtonTitle`: defines the tooltip for the profile button
|
|
7057
|
+
* - `logoTitle`: defines the tooltip for the logo
|
|
7058
|
+
*
|
|
7059
|
+
* Default value is `{}`.
|
|
7060
|
+
*/
|
|
7061
|
+
getAccessibilityTexts(): object;
|
|
7062
|
+
/**
|
|
7063
|
+
* Returns the `copilot` DOM ref.
|
|
7064
|
+
*/
|
|
7065
|
+
getCopilotDomRef(): void;
|
|
5201
7066
|
/**
|
|
5202
7067
|
* Gets content of aggregation {@link #getItems items}.
|
|
5203
7068
|
*
|
|
@@ -5213,6 +7078,10 @@ declare namespace sap {
|
|
|
5213
7078
|
* or `img` elements as logo.
|
|
5214
7079
|
*/
|
|
5215
7080
|
getLogo(): sap.ui.webc.main.IAvatar;
|
|
7081
|
+
/**
|
|
7082
|
+
* Returns the `logo` DOM ref.
|
|
7083
|
+
*/
|
|
7084
|
+
getLogoDomRef(): void;
|
|
5216
7085
|
/**
|
|
5217
7086
|
* Gets content of aggregation {@link #getMenuItems menuItems}.
|
|
5218
7087
|
*
|
|
@@ -5229,6 +7098,14 @@ declare namespace sap {
|
|
|
5229
7098
|
* Default value is `empty string`.
|
|
5230
7099
|
*/
|
|
5231
7100
|
getNotificationsCount(): string;
|
|
7101
|
+
/**
|
|
7102
|
+
* Returns the `notifications` icon DOM ref.
|
|
7103
|
+
*/
|
|
7104
|
+
getNotificationsDomRef(): void;
|
|
7105
|
+
/**
|
|
7106
|
+
* Returns the `overflow` icon DOM ref.
|
|
7107
|
+
*/
|
|
7108
|
+
getOverflowDomRef(): void;
|
|
5232
7109
|
/**
|
|
5233
7110
|
* Gets current value of property {@link #getPrimaryTitle primaryTitle}.
|
|
5234
7111
|
*
|
|
@@ -5239,6 +7116,10 @@ declare namespace sap {
|
|
|
5239
7116
|
* Default value is `empty string`.
|
|
5240
7117
|
*/
|
|
5241
7118
|
getPrimaryTitle(): string;
|
|
7119
|
+
/**
|
|
7120
|
+
* Returns the `product-switch` icon DOM ref.
|
|
7121
|
+
*/
|
|
7122
|
+
getProductSwitchDomRef(): void;
|
|
5242
7123
|
/**
|
|
5243
7124
|
* Gets content of aggregation {@link #getProfile profile}.
|
|
5244
7125
|
*
|
|
@@ -5249,6 +7130,10 @@ declare namespace sap {
|
|
|
5249
7130
|
* specific size by design in the context of `sap.ui.webc.fiori.ShellBar` profile.
|
|
5250
7131
|
*/
|
|
5251
7132
|
getProfile(): sap.ui.webc.main.IAvatar;
|
|
7133
|
+
/**
|
|
7134
|
+
* Returns the `profile` icon DOM ref.
|
|
7135
|
+
*/
|
|
7136
|
+
getProfileDomRef(): void;
|
|
5252
7137
|
/**
|
|
5253
7138
|
* Gets content of aggregation {@link #getSearchField searchField}.
|
|
5254
7139
|
*
|
|
@@ -5378,6 +7263,24 @@ declare namespace sap {
|
|
|
5378
7263
|
*/
|
|
5379
7264
|
vMenuItem: int | string | sap.ui.webc.main.IListItem
|
|
5380
7265
|
): sap.ui.webc.main.IListItem;
|
|
7266
|
+
/**
|
|
7267
|
+
* Sets a new value for property {@link #getAccessibilityTexts accessibilityTexts}.
|
|
7268
|
+
*
|
|
7269
|
+
* An object of strings that defines several additional accessibility texts for even further customization.
|
|
7270
|
+
*
|
|
7271
|
+
* It supports the following fields: - `profileButtonTitle`: defines the tooltip for the profile button
|
|
7272
|
+
* - `logoTitle`: defines the tooltip for the logo
|
|
7273
|
+
*
|
|
7274
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
7275
|
+
*
|
|
7276
|
+
* Default value is `{}`.
|
|
7277
|
+
*/
|
|
7278
|
+
setAccessibilityTexts(
|
|
7279
|
+
/**
|
|
7280
|
+
* New value for property `accessibilityTexts`
|
|
7281
|
+
*/
|
|
7282
|
+
oAccessibilityTexts?: object
|
|
7283
|
+
): this;
|
|
5381
7284
|
/**
|
|
5382
7285
|
* Sets the aggregated {@link #getLogo logo}.
|
|
5383
7286
|
*/
|
|
@@ -5576,14 +7479,14 @@ declare namespace sap {
|
|
|
5576
7479
|
*/
|
|
5577
7480
|
static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
|
|
5578
7481
|
/**
|
|
5579
|
-
* Attaches event handler `fnFunction` to the {@link #event:
|
|
7482
|
+
* Attaches event handler `fnFunction` to the {@link #event:click click} event of this `sap.ui.webc.fiori.ShellBarItem`.
|
|
5580
7483
|
*
|
|
5581
7484
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
5582
7485
|
* otherwise it will be bound to this `sap.ui.webc.fiori.ShellBarItem` itself.
|
|
5583
7486
|
*
|
|
5584
7487
|
* Fired, when the item is pressed.
|
|
5585
7488
|
*/
|
|
5586
|
-
|
|
7489
|
+
attachClick(
|
|
5587
7490
|
/**
|
|
5588
7491
|
* An application-specific payload object that will be passed to the event handler along with the event
|
|
5589
7492
|
* object when firing the event
|
|
@@ -5599,14 +7502,14 @@ declare namespace sap {
|
|
|
5599
7502
|
oListener?: object
|
|
5600
7503
|
): this;
|
|
5601
7504
|
/**
|
|
5602
|
-
* Attaches event handler `fnFunction` to the {@link #event:
|
|
7505
|
+
* Attaches event handler `fnFunction` to the {@link #event:click click} event of this `sap.ui.webc.fiori.ShellBarItem`.
|
|
5603
7506
|
*
|
|
5604
7507
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
5605
7508
|
* otherwise it will be bound to this `sap.ui.webc.fiori.ShellBarItem` itself.
|
|
5606
7509
|
*
|
|
5607
7510
|
* Fired, when the item is pressed.
|
|
5608
7511
|
*/
|
|
5609
|
-
|
|
7512
|
+
attachClick(
|
|
5610
7513
|
/**
|
|
5611
7514
|
* The function to be called when the event occurs
|
|
5612
7515
|
*/
|
|
@@ -5617,11 +7520,11 @@ declare namespace sap {
|
|
|
5617
7520
|
oListener?: object
|
|
5618
7521
|
): this;
|
|
5619
7522
|
/**
|
|
5620
|
-
* Detaches event handler `fnFunction` from the {@link #event:
|
|
7523
|
+
* Detaches event handler `fnFunction` from the {@link #event:click click} event of this `sap.ui.webc.fiori.ShellBarItem`.
|
|
5621
7524
|
*
|
|
5622
7525
|
* The passed function and listener object must match the ones used for event registration.
|
|
5623
7526
|
*/
|
|
5624
|
-
|
|
7527
|
+
detachClick(
|
|
5625
7528
|
/**
|
|
5626
7529
|
* The function to be called, when the event occurs
|
|
5627
7530
|
*/
|
|
@@ -5632,12 +7535,12 @@ declare namespace sap {
|
|
|
5632
7535
|
oListener?: object
|
|
5633
7536
|
): this;
|
|
5634
7537
|
/**
|
|
5635
|
-
* Fires event {@link #event:
|
|
7538
|
+
* Fires event {@link #event:click click} to attached listeners.
|
|
5636
7539
|
*
|
|
5637
7540
|
* Listeners may prevent the default action of this event by calling the `preventDefault` method on the
|
|
5638
7541
|
* event object. The return value of this method indicates whether the default action should be executed.
|
|
5639
7542
|
*/
|
|
5640
|
-
|
|
7543
|
+
fireClick(
|
|
5641
7544
|
/**
|
|
5642
7545
|
* Parameters to pass along with the event
|
|
5643
7546
|
*/
|
|
@@ -5738,6 +7641,8 @@ declare namespace sap {
|
|
|
5738
7641
|
* components to build your menu. The items can consist of text only or an icon with text. The use or non-use
|
|
5739
7642
|
* of icons must be consistent for all items on one level. You must not combine entries with and without
|
|
5740
7643
|
* icons on the same level. We strongly recommend that you do not use icons on the second level.
|
|
7644
|
+
*
|
|
7645
|
+
* Keyboard Handling:
|
|
5741
7646
|
*/
|
|
5742
7647
|
class SideNavigation extends sap.ui.webc.common.WebComponent {
|
|
5743
7648
|
/**
|
|
@@ -6493,6 +8398,121 @@ declare namespace sap {
|
|
|
6493
8398
|
sText?: string
|
|
6494
8399
|
): this;
|
|
6495
8400
|
}
|
|
8401
|
+
/**
|
|
8402
|
+
* @SINCE 1.97.0
|
|
8403
|
+
* @EXPERIMENTAL (since 1.97.0)
|
|
8404
|
+
*
|
|
8405
|
+
* Overview:
|
|
8406
|
+
*
|
|
8407
|
+
* Usage:
|
|
8408
|
+
*/
|
|
8409
|
+
class SortItem
|
|
8410
|
+
extends sap.ui.webc.common.WebComponent
|
|
8411
|
+
implements sap.ui.webc.fiori.ISortItem {
|
|
8412
|
+
__implements__sap_ui_webc_fiori_ISortItem: boolean;
|
|
8413
|
+
/**
|
|
8414
|
+
* Constructor for a new `SortItem`.
|
|
8415
|
+
*
|
|
8416
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
8417
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
8418
|
+
* of the syntax of the settings object.
|
|
8419
|
+
*/
|
|
8420
|
+
constructor(
|
|
8421
|
+
/**
|
|
8422
|
+
* Initial settings for the new control
|
|
8423
|
+
*/
|
|
8424
|
+
mSettings?: sap.ui.webc.fiori.$SortItemSettings
|
|
8425
|
+
);
|
|
8426
|
+
/**
|
|
8427
|
+
* Constructor for a new `SortItem`.
|
|
8428
|
+
*
|
|
8429
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
8430
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
8431
|
+
* of the syntax of the settings object.
|
|
8432
|
+
*/
|
|
8433
|
+
constructor(
|
|
8434
|
+
/**
|
|
8435
|
+
* ID for the new control, generated automatically if no ID is given
|
|
8436
|
+
*/
|
|
8437
|
+
sId?: string,
|
|
8438
|
+
/**
|
|
8439
|
+
* Initial settings for the new control
|
|
8440
|
+
*/
|
|
8441
|
+
mSettings?: sap.ui.webc.fiori.$SortItemSettings
|
|
8442
|
+
);
|
|
8443
|
+
|
|
8444
|
+
/**
|
|
8445
|
+
* Creates a new subclass of class sap.ui.webc.fiori.SortItem with name `sClassName` and enriches it with
|
|
8446
|
+
* the information contained in `oClassInfo`.
|
|
8447
|
+
*
|
|
8448
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
|
|
8449
|
+
*/
|
|
8450
|
+
static extend<T extends Record<string, unknown>>(
|
|
8451
|
+
/**
|
|
8452
|
+
* Name of the class being created
|
|
8453
|
+
*/
|
|
8454
|
+
sClassName: string,
|
|
8455
|
+
/**
|
|
8456
|
+
* Object literal with information about the class
|
|
8457
|
+
*/
|
|
8458
|
+
oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.SortItem>,
|
|
8459
|
+
/**
|
|
8460
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
8461
|
+
* used by this class
|
|
8462
|
+
*/
|
|
8463
|
+
FNMetaImpl?: Function
|
|
8464
|
+
): Function;
|
|
8465
|
+
/**
|
|
8466
|
+
* Returns a metadata object for class sap.ui.webc.fiori.SortItem.
|
|
8467
|
+
*/
|
|
8468
|
+
static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
|
|
8469
|
+
/**
|
|
8470
|
+
* Gets current value of property {@link #getSelected selected}.
|
|
8471
|
+
*
|
|
8472
|
+
* Defines if the component is selected.
|
|
8473
|
+
*
|
|
8474
|
+
* Default value is `false`.
|
|
8475
|
+
*/
|
|
8476
|
+
getSelected(): boolean;
|
|
8477
|
+
/**
|
|
8478
|
+
* Gets current value of property {@link #getText text}.
|
|
8479
|
+
*
|
|
8480
|
+
* Defines the text of the component.
|
|
8481
|
+
*
|
|
8482
|
+
* Default value is `empty string`.
|
|
8483
|
+
*/
|
|
8484
|
+
getText(): string;
|
|
8485
|
+
/**
|
|
8486
|
+
* Sets a new value for property {@link #getSelected selected}.
|
|
8487
|
+
*
|
|
8488
|
+
* Defines if the component is selected.
|
|
8489
|
+
*
|
|
8490
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
8491
|
+
*
|
|
8492
|
+
* Default value is `false`.
|
|
8493
|
+
*/
|
|
8494
|
+
setSelected(
|
|
8495
|
+
/**
|
|
8496
|
+
* New value for property `selected`
|
|
8497
|
+
*/
|
|
8498
|
+
bSelected?: boolean
|
|
8499
|
+
): this;
|
|
8500
|
+
/**
|
|
8501
|
+
* Sets a new value for property {@link #getText text}.
|
|
8502
|
+
*
|
|
8503
|
+
* Defines the text of the component.
|
|
8504
|
+
*
|
|
8505
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
8506
|
+
*
|
|
8507
|
+
* Default value is `empty string`.
|
|
8508
|
+
*/
|
|
8509
|
+
setText(
|
|
8510
|
+
/**
|
|
8511
|
+
* New value for property `text`
|
|
8512
|
+
*/
|
|
8513
|
+
sText?: string
|
|
8514
|
+
): this;
|
|
8515
|
+
}
|
|
6496
8516
|
/**
|
|
6497
8517
|
* @SINCE 1.92.0
|
|
6498
8518
|
* @EXPERIMENTAL (since 1.92.0)
|
|
@@ -7339,10 +9359,21 @@ declare namespace sap {
|
|
|
7339
9359
|
selectedItems?: any[];
|
|
7340
9360
|
}
|
|
7341
9361
|
): this;
|
|
9362
|
+
/**
|
|
9363
|
+
* Gets current value of property {@link #getAccessibleName accessibleName}.
|
|
9364
|
+
*
|
|
9365
|
+
* Sets the accessible aria name of the component.
|
|
9366
|
+
*
|
|
9367
|
+
* Default value is `empty string`.
|
|
9368
|
+
*/
|
|
9369
|
+
getAccessibleName(): string;
|
|
7342
9370
|
/**
|
|
7343
9371
|
* Gets content of aggregation {@link #getHeader header}.
|
|
7344
9372
|
*
|
|
7345
9373
|
* Defines the `sap.ui.webc.fiori.UploadCollection` header.
|
|
9374
|
+
*
|
|
9375
|
+
* **Note:** If `header` slot is provided, the labelling of the `UploadCollection` is a responsibility
|
|
9376
|
+
* of the application developer. `accessibleName` should be used.
|
|
7346
9377
|
*/
|
|
7347
9378
|
getHeader(): sap.ui.core.Control[];
|
|
7348
9379
|
/**
|
|
@@ -7488,6 +9519,21 @@ declare namespace sap {
|
|
|
7488
9519
|
*/
|
|
7489
9520
|
vItem: int | string | sap.ui.webc.fiori.IUploadCollectionItem
|
|
7490
9521
|
): sap.ui.webc.fiori.IUploadCollectionItem;
|
|
9522
|
+
/**
|
|
9523
|
+
* Sets a new value for property {@link #getAccessibleName accessibleName}.
|
|
9524
|
+
*
|
|
9525
|
+
* Sets the accessible aria name of the component.
|
|
9526
|
+
*
|
|
9527
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
9528
|
+
*
|
|
9529
|
+
* Default value is `empty string`.
|
|
9530
|
+
*/
|
|
9531
|
+
setAccessibleName(
|
|
9532
|
+
/**
|
|
9533
|
+
* New value for property `accessibleName`
|
|
9534
|
+
*/
|
|
9535
|
+
sAccessibleName?: string
|
|
9536
|
+
): this;
|
|
7491
9537
|
/**
|
|
7492
9538
|
* Sets a new value for property {@link #getHeight height}.
|
|
7493
9539
|
*
|
|
@@ -8213,12 +10259,13 @@ declare namespace sap {
|
|
|
8213
10259
|
): this;
|
|
8214
10260
|
}
|
|
8215
10261
|
/**
|
|
8216
|
-
* @SINCE 1.
|
|
8217
|
-
* @EXPERIMENTAL (since 1.
|
|
10262
|
+
* @SINCE 1.95.0
|
|
10263
|
+
* @EXPERIMENTAL (since 1.95.0)
|
|
8218
10264
|
*
|
|
8219
10265
|
* Overview: The `sap.ui.webc.fiori.ViewSettingsDialog` component helps the user to sort data within a list
|
|
8220
|
-
* or a table. It consists of several lists like `Sort order` which is built-in and `Sort By`
|
|
8221
|
-
*
|
|
10266
|
+
* or a table. It consists of several lists like `Sort order` which is built-in and `Sort By` and `Filter
|
|
10267
|
+
* By` lists, for which you must be provide items(`sap.ui.webc.fiori.SortItem` & `sap.ui.webc.fiori.FilterItem`
|
|
10268
|
+
* respectively) These options can be used to create sorters for a table.
|
|
8222
10269
|
*
|
|
8223
10270
|
* The `sap.ui.webc.fiori.ViewSettingsDialog` interrupts the current application processing as it is the
|
|
8224
10271
|
* only focused UI element and the main screen is dimmed/blocked. The `sap.ui.webc.fiori.ViewSettingsDialog`
|
|
@@ -8286,6 +10333,15 @@ declare namespace sap {
|
|
|
8286
10333
|
* Returns a metadata object for class sap.ui.webc.fiori.ViewSettingsDialog.
|
|
8287
10334
|
*/
|
|
8288
10335
|
static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
|
|
10336
|
+
/**
|
|
10337
|
+
* Adds some filterItem to the aggregation {@link #getFilterItems filterItems}.
|
|
10338
|
+
*/
|
|
10339
|
+
addFilterItem(
|
|
10340
|
+
/**
|
|
10341
|
+
* The filterItem to add; if empty, nothing is inserted
|
|
10342
|
+
*/
|
|
10343
|
+
oFilterItem: sap.ui.webc.fiori.IFilterItem
|
|
10344
|
+
): this;
|
|
8289
10345
|
/**
|
|
8290
10346
|
* Adds some sortItem to the aggregation {@link #getSortItems sortItems}.
|
|
8291
10347
|
*/
|
|
@@ -8293,7 +10349,7 @@ declare namespace sap {
|
|
|
8293
10349
|
/**
|
|
8294
10350
|
* The sortItem to add; if empty, nothing is inserted
|
|
8295
10351
|
*/
|
|
8296
|
-
oSortItem: sap.ui.webc.
|
|
10352
|
+
oSortItem: sap.ui.webc.fiori.ISortItem
|
|
8297
10353
|
): this;
|
|
8298
10354
|
/**
|
|
8299
10355
|
* Attaches event handler `fnFunction` to the {@link #event:cancel cancel} event of this `sap.ui.webc.fiori.ViewSettingsDialog`.
|
|
@@ -8381,6 +10437,10 @@ declare namespace sap {
|
|
|
8381
10437
|
*/
|
|
8382
10438
|
oListener?: object
|
|
8383
10439
|
): this;
|
|
10440
|
+
/**
|
|
10441
|
+
* Destroys all the filterItems in the aggregation {@link #getFilterItems filterItems}.
|
|
10442
|
+
*/
|
|
10443
|
+
destroyFilterItems(): this;
|
|
8384
10444
|
/**
|
|
8385
10445
|
* Destroys all the sortItems in the aggregation {@link #getSortItems sortItems}.
|
|
8386
10446
|
*/
|
|
@@ -8428,7 +10488,7 @@ declare namespace sap {
|
|
|
8428
10488
|
*/
|
|
8429
10489
|
sortOrder?: string;
|
|
8430
10490
|
/**
|
|
8431
|
-
* The
|
|
10491
|
+
* The currently selected `sap.ui.webc.fiori.SortItem` text attribute.
|
|
8432
10492
|
*/
|
|
8433
10493
|
sortBy?: string;
|
|
8434
10494
|
}
|
|
@@ -8446,11 +10506,15 @@ declare namespace sap {
|
|
|
8446
10506
|
*/
|
|
8447
10507
|
sortOrder?: string;
|
|
8448
10508
|
/**
|
|
8449
|
-
* The
|
|
10509
|
+
* The currently selected `sap.ui.webc.fiori.SortItem` text attribute.
|
|
8450
10510
|
*/
|
|
8451
10511
|
sortBy?: string;
|
|
8452
10512
|
}
|
|
8453
10513
|
): this;
|
|
10514
|
+
/**
|
|
10515
|
+
* Gets content of aggregation {@link #getFilterItems filterItems}.
|
|
10516
|
+
*/
|
|
10517
|
+
getFilterItems(): sap.ui.webc.fiori.IFilterItem[];
|
|
8454
10518
|
/**
|
|
8455
10519
|
* Gets current value of property {@link #getSortDescending sortDescending}.
|
|
8456
10520
|
*
|
|
@@ -8461,20 +10525,43 @@ declare namespace sap {
|
|
|
8461
10525
|
getSortDescending(): boolean;
|
|
8462
10526
|
/**
|
|
8463
10527
|
* Gets content of aggregation {@link #getSortItems sortItems}.
|
|
8464
|
-
*
|
|
8465
|
-
* Defines the `sortItems` list.
|
|
8466
10528
|
*/
|
|
8467
|
-
getSortItems(): sap.ui.webc.
|
|
10529
|
+
getSortItems(): sap.ui.webc.fiori.ISortItem[];
|
|
10530
|
+
/**
|
|
10531
|
+
* Checks for the provided `sap.ui.webc.fiori.IFilterItem` in the aggregation {@link #getFilterItems filterItems}.
|
|
10532
|
+
* and returns its index if found or -1 otherwise.
|
|
10533
|
+
*/
|
|
10534
|
+
indexOfFilterItem(
|
|
10535
|
+
/**
|
|
10536
|
+
* The filterItem whose index is looked for
|
|
10537
|
+
*/
|
|
10538
|
+
oFilterItem: sap.ui.webc.fiori.IFilterItem
|
|
10539
|
+
): int;
|
|
8468
10540
|
/**
|
|
8469
|
-
* Checks for the provided `sap.ui.webc.
|
|
10541
|
+
* Checks for the provided `sap.ui.webc.fiori.ISortItem` in the aggregation {@link #getSortItems sortItems}.
|
|
8470
10542
|
* and returns its index if found or -1 otherwise.
|
|
8471
10543
|
*/
|
|
8472
10544
|
indexOfSortItem(
|
|
8473
10545
|
/**
|
|
8474
10546
|
* The sortItem whose index is looked for
|
|
8475
10547
|
*/
|
|
8476
|
-
oSortItem: sap.ui.webc.
|
|
10548
|
+
oSortItem: sap.ui.webc.fiori.ISortItem
|
|
8477
10549
|
): int;
|
|
10550
|
+
/**
|
|
10551
|
+
* Inserts a filterItem into the aggregation {@link #getFilterItems filterItems}.
|
|
10552
|
+
*/
|
|
10553
|
+
insertFilterItem(
|
|
10554
|
+
/**
|
|
10555
|
+
* The filterItem to insert; if empty, nothing is inserted
|
|
10556
|
+
*/
|
|
10557
|
+
oFilterItem: sap.ui.webc.fiori.IFilterItem,
|
|
10558
|
+
/**
|
|
10559
|
+
* The `0`-based index the filterItem should be inserted at; for a negative value of `iIndex`, the filterItem
|
|
10560
|
+
* is inserted at position 0; for a value greater than the current size of the aggregation, the filterItem
|
|
10561
|
+
* is inserted at the last position
|
|
10562
|
+
*/
|
|
10563
|
+
iIndex: int
|
|
10564
|
+
): this;
|
|
8478
10565
|
/**
|
|
8479
10566
|
* Inserts a sortItem into the aggregation {@link #getSortItems sortItems}.
|
|
8480
10567
|
*/
|
|
@@ -8482,7 +10569,7 @@ declare namespace sap {
|
|
|
8482
10569
|
/**
|
|
8483
10570
|
* The sortItem to insert; if empty, nothing is inserted
|
|
8484
10571
|
*/
|
|
8485
|
-
oSortItem: sap.ui.webc.
|
|
10572
|
+
oSortItem: sap.ui.webc.fiori.ISortItem,
|
|
8486
10573
|
/**
|
|
8487
10574
|
* The `0`-based index the sortItem should be inserted at; for a negative value of `iIndex`, the sortItem
|
|
8488
10575
|
* is inserted at position 0; for a value greater than the current size of the aggregation, the sortItem
|
|
@@ -8490,12 +10577,27 @@ declare namespace sap {
|
|
|
8490
10577
|
*/
|
|
8491
10578
|
iIndex: int
|
|
8492
10579
|
): this;
|
|
10580
|
+
/**
|
|
10581
|
+
* Removes all the controls from the aggregation {@link #getFilterItems filterItems}.
|
|
10582
|
+
*
|
|
10583
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
10584
|
+
*/
|
|
10585
|
+
removeAllFilterItems(): sap.ui.webc.fiori.IFilterItem[];
|
|
8493
10586
|
/**
|
|
8494
10587
|
* Removes all the controls from the aggregation {@link #getSortItems sortItems}.
|
|
8495
10588
|
*
|
|
8496
10589
|
* Additionally, it unregisters them from the hosting UIArea.
|
|
8497
10590
|
*/
|
|
8498
|
-
removeAllSortItems(): sap.ui.webc.
|
|
10591
|
+
removeAllSortItems(): sap.ui.webc.fiori.ISortItem[];
|
|
10592
|
+
/**
|
|
10593
|
+
* Removes a filterItem from the aggregation {@link #getFilterItems filterItems}.
|
|
10594
|
+
*/
|
|
10595
|
+
removeFilterItem(
|
|
10596
|
+
/**
|
|
10597
|
+
* The filterItem to remove or its index or id
|
|
10598
|
+
*/
|
|
10599
|
+
vFilterItem: int | string | sap.ui.webc.fiori.IFilterItem
|
|
10600
|
+
): sap.ui.webc.fiori.IFilterItem;
|
|
8499
10601
|
/**
|
|
8500
10602
|
* Removes a sortItem from the aggregation {@link #getSortItems sortItems}.
|
|
8501
10603
|
*/
|
|
@@ -8503,8 +10605,8 @@ declare namespace sap {
|
|
|
8503
10605
|
/**
|
|
8504
10606
|
* The sortItem to remove or its index or id
|
|
8505
10607
|
*/
|
|
8506
|
-
vSortItem: int | string | sap.ui.webc.
|
|
8507
|
-
): sap.ui.webc.
|
|
10608
|
+
vSortItem: int | string | sap.ui.webc.fiori.ISortItem
|
|
10609
|
+
): sap.ui.webc.fiori.ISortItem;
|
|
8508
10610
|
/**
|
|
8509
10611
|
* Sets a new value for property {@link #getSortDescending sortDescending}.
|
|
8510
10612
|
*
|
|
@@ -8531,21 +10633,31 @@ declare namespace sap {
|
|
|
8531
10633
|
*
|
|
8532
10634
|
* Overview:
|
|
8533
10635
|
*
|
|
8534
|
-
* The `sap.ui.webc.fiori.Wizard` helps users complete a complex task by dividing it into sections and
|
|
8535
|
-
*
|
|
8536
|
-
* a content area below it.
|
|
10636
|
+
* The `sap.ui.webc.fiori.Wizard` helps users to complete a complex task by dividing it into sections and
|
|
10637
|
+
* guiding them through it. It has two main areas - a navigation area at the top showing the step sequence
|
|
10638
|
+
* and a content area below it.
|
|
8537
10639
|
*
|
|
8538
10640
|
* Structure: Navigation area: The top most area of the `sap.ui.webc.fiori.Wizard` is occupied by the navigation
|
|
8539
10641
|
* area. It shows the sequence of steps, where the recommended number of steps is between 3 and 8 steps.
|
|
8540
10642
|
*
|
|
8541
10643
|
* - Steps can have different visual representations - numbers or icons. Steps might have labels
|
|
8542
10644
|
* for better readability - titleText and subTitleText.
|
|
8543
|
-
* - Steps are defined by using the `sap.ui.webc.fiori.WizardStep` as slotted element within the `sap.ui.webc.fiori.Wizard
|
|
10645
|
+
* - Steps are defined by using the `sap.ui.webc.fiori.WizardStep` as slotted element within the `sap.ui.webc.fiori.Wizard`.
|
|
8544
10646
|
*
|
|
8545
10647
|
*
|
|
8546
10648
|
* **Note:** If no selected step is defined, the first step will be auto selected.
|
|
8547
10649
|
* **Note:** If multiple selected steps are defined, the last step will be selected.
|
|
8548
10650
|
*
|
|
10651
|
+
* Keyboard Handling: The user can navigate using the following keyboard shortcuts:
|
|
10652
|
+
*
|
|
10653
|
+
*
|
|
10654
|
+
* Wizard Progress Navigation:
|
|
10655
|
+
* - [LEFT], [DOWN] - Focus moves backward to the WizardProgressNavAnchors.
|
|
10656
|
+
* - [UP], [RIGHT] - Focus moves forward to the WizardProgressNavAnchor.
|
|
10657
|
+
* - [SPACE] or [ENTER], [RETURN] - Selects an active step
|
|
10658
|
+
* - [HOME] or [PAGE UP] - Focus goes to the first step
|
|
10659
|
+
* - [END] or [PAGE DOWN] - Focus goes to the last step
|
|
10660
|
+
*
|
|
8549
10661
|
* Content: The content occupies the main part of the page. It can hold any type of HTML elements. It's
|
|
8550
10662
|
* defined by using the `sap.ui.webc.fiori.WizardStep` as slotted element within the `sap.ui.webc.fiori.Wizard`.
|
|
8551
10663
|
*
|
|
@@ -8567,7 +10679,7 @@ declare namespace sap {
|
|
|
8567
10679
|
*
|
|
8568
10680
|
* Moving to next step: The `sap.ui.webc.fiori.WizardStep` provides the necessary API and it's up to the
|
|
8569
10681
|
* user of the component to use it to move to the next step. You have to set its `selected` property (and
|
|
8570
|
-
* remove the `disabled` one if set) to `true`.
|
|
10682
|
+
* remove the `disabled` one if set) to `true`. The `sap.ui.webc.fiori.Wizard` will automatically scroll
|
|
8571
10683
|
* to the content of the newly selected step.
|
|
8572
10684
|
*
|
|
8573
10685
|
*
|
|
@@ -8576,13 +10688,14 @@ declare namespace sap {
|
|
|
8576
10688
|
* or any other type of element to trigger step change, inside the `sap.ui.webc.fiori.WizardStep`, and show/hide
|
|
8577
10689
|
* it when certain fields are filled or user defined criteria is met.
|
|
8578
10690
|
*
|
|
8579
|
-
* Usage: When to use:: When the user has to accomplish a long
|
|
10691
|
+
* Usage: When to use:: When the user has to accomplish a long or unfamiliar task.
|
|
8580
10692
|
*
|
|
8581
10693
|
* When not to use:: When the task has less than 3 steps.
|
|
8582
10694
|
*
|
|
8583
10695
|
* Responsive Behavior: On small widths the step's titleText, subtitleText and separators in the navigation
|
|
8584
|
-
* area
|
|
8585
|
-
*
|
|
10696
|
+
* area shrink and from particular point the steps are grouped together and overlap. Tapping on them will
|
|
10697
|
+
* show a popover to select the step to navigate to. On mobile device, the grouped steps are presented within
|
|
10698
|
+
* a dialog.
|
|
8586
10699
|
*/
|
|
8587
10700
|
class Wizard extends sap.ui.webc.common.WebComponent {
|
|
8588
10701
|
/**
|
|
@@ -8721,27 +10834,19 @@ declare namespace sap {
|
|
|
8721
10834
|
*/
|
|
8722
10835
|
mParameters?: {
|
|
8723
10836
|
/**
|
|
8724
|
-
*
|
|
10837
|
+
* The new step.
|
|
8725
10838
|
*/
|
|
8726
10839
|
step?: HTMLElement;
|
|
8727
10840
|
/**
|
|
8728
|
-
*
|
|
10841
|
+
* The previous step.
|
|
8729
10842
|
*/
|
|
8730
10843
|
previousStep?: HTMLElement;
|
|
8731
10844
|
/**
|
|
8732
|
-
*
|
|
8733
|
-
*/
|
|
8734
|
-
changeWithClick?: boolean;
|
|
8735
|
-
}
|
|
8736
|
-
): this;
|
|
8737
|
-
/**
|
|
8738
|
-
* Gets current value of property {@link #getAccessibleName accessibleName}.
|
|
8739
|
-
*
|
|
8740
|
-
* Sets the accessible aria name of the component.
|
|
8741
|
-
*
|
|
8742
|
-
* Default value is `undefined`.
|
|
8743
|
-
*/
|
|
8744
|
-
getAccessibleName(): string;
|
|
10845
|
+
* The step change occurs due to user's click or 'Enter'/'Space' key press on step within the navigation.
|
|
10846
|
+
*/
|
|
10847
|
+
changeWithClick?: boolean;
|
|
10848
|
+
}
|
|
10849
|
+
): this;
|
|
8745
10850
|
/**
|
|
8746
10851
|
* Gets current value of property {@link #getHeight height}.
|
|
8747
10852
|
*
|
|
@@ -8796,21 +10901,6 @@ declare namespace sap {
|
|
|
8796
10901
|
*/
|
|
8797
10902
|
vStep: int | string | sap.ui.webc.fiori.IWizardStep
|
|
8798
10903
|
): sap.ui.webc.fiori.IWizardStep;
|
|
8799
|
-
/**
|
|
8800
|
-
* Sets a new value for property {@link #getAccessibleName accessibleName}.
|
|
8801
|
-
*
|
|
8802
|
-
* Sets the accessible aria name of the component.
|
|
8803
|
-
*
|
|
8804
|
-
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
8805
|
-
*
|
|
8806
|
-
* Default value is `undefined`.
|
|
8807
|
-
*/
|
|
8808
|
-
setAccessibleName(
|
|
8809
|
-
/**
|
|
8810
|
-
* New value for property `accessibleName`
|
|
8811
|
-
*/
|
|
8812
|
-
sAccessibleName?: string
|
|
8813
|
-
): this;
|
|
8814
10904
|
/**
|
|
8815
10905
|
* Sets a new value for property {@link #getHeight height}.
|
|
8816
10906
|
*
|
|
@@ -8832,13 +10922,13 @@ declare namespace sap {
|
|
|
8832
10922
|
* Overview:
|
|
8833
10923
|
*
|
|
8834
10924
|
* A component that represents a logical step as part of the `sap.ui.webc.fiori.Wizard`. It is meant to
|
|
8835
|
-
* aggregate arbitrary HTML elements that
|
|
10925
|
+
* aggregate arbitrary HTML elements that form the content of a single step.
|
|
8836
10926
|
*
|
|
8837
10927
|
* Structure:
|
|
8838
|
-
* - Each wizard step has arbitrary content
|
|
8839
|
-
* - Each wizard step might have texts - defined by the `titleText` and `subtitleText` properties
|
|
8840
|
-
* - Each wizard step might have an icon - defined by the `icon` property
|
|
8841
|
-
* - Each wizard step might display a number in place of the `icon`, when it's missing
|
|
10928
|
+
* - Each wizard step has arbitrary content.
|
|
10929
|
+
* - Each wizard step might have texts - defined by the `titleText` and `subtitleText` properties.
|
|
10930
|
+
* - Each wizard step might have an icon - defined by the `icon` property.
|
|
10931
|
+
* - Each wizard step might display a number in place of the `icon`, when it's missing.
|
|
8842
10932
|
*
|
|
8843
10933
|
* Usage: The `sap.ui.webc.fiori.WizardStep` component should be used only as slot of the `sap.ui.webc.fiori.Wizard`
|
|
8844
10934
|
* component and should not be used standalone.
|
|
@@ -8916,22 +11006,6 @@ declare namespace sap {
|
|
|
8916
11006
|
* Destroys all the content in the aggregation {@link #getContent content}.
|
|
8917
11007
|
*/
|
|
8918
11008
|
destroyContent(): this;
|
|
8919
|
-
/**
|
|
8920
|
-
* Gets current value of property {@link #getAccessibleName accessibleName}.
|
|
8921
|
-
*
|
|
8922
|
-
* Sets the accessible aria name of the component.
|
|
8923
|
-
*
|
|
8924
|
-
* Default value is `empty string`.
|
|
8925
|
-
*/
|
|
8926
|
-
getAccessibleName(): string;
|
|
8927
|
-
/**
|
|
8928
|
-
* Gets current value of property {@link #getAccessibleNameRef accessibleNameRef}.
|
|
8929
|
-
*
|
|
8930
|
-
* Defines the aria-labelledby of the step.
|
|
8931
|
-
*
|
|
8932
|
-
* Default value is `empty string`.
|
|
8933
|
-
*/
|
|
8934
|
-
getAccessibleNameRef(): string;
|
|
8935
11009
|
/**
|
|
8936
11010
|
* Gets current value of property {@link #getBranching branching}.
|
|
8937
11011
|
*
|
|
@@ -8973,7 +11047,7 @@ declare namespace sap {
|
|
|
8973
11047
|
*
|
|
8974
11048
|
*
|
|
8975
11049
|
*
|
|
8976
|
-
* **Note:**
|
|
11050
|
+
* **Note:** The icon is displayed in the `sap.ui.webc.fiori.Wizard` navigation header.
|
|
8977
11051
|
*
|
|
8978
11052
|
*
|
|
8979
11053
|
*
|
|
@@ -9003,7 +11077,6 @@ declare namespace sap {
|
|
|
9003
11077
|
*
|
|
9004
11078
|
*
|
|
9005
11079
|
* **Note:** the text is displayed in the `sap.ui.webc.fiori.Wizard` navigation header.
|
|
9006
|
-
* **Note:** the text will hide on small sizes (about 559 px).
|
|
9007
11080
|
*
|
|
9008
11081
|
* Default value is `empty string`.
|
|
9009
11082
|
*/
|
|
@@ -9015,8 +11088,7 @@ declare namespace sap {
|
|
|
9015
11088
|
*
|
|
9016
11089
|
*
|
|
9017
11090
|
*
|
|
9018
|
-
* **Note:**
|
|
9019
|
-
* **Note:** the text will hide on small sizes (about 559 px).
|
|
11091
|
+
* **Note:** The text is displayed in the `sap.ui.webc.fiori.Wizard` navigation header.
|
|
9020
11092
|
*
|
|
9021
11093
|
* Default value is `empty string`.
|
|
9022
11094
|
*/
|
|
@@ -9061,36 +11133,6 @@ declare namespace sap {
|
|
|
9061
11133
|
*/
|
|
9062
11134
|
vContent: int | string | sap.ui.core.Control
|
|
9063
11135
|
): sap.ui.core.Control;
|
|
9064
|
-
/**
|
|
9065
|
-
* Sets a new value for property {@link #getAccessibleName accessibleName}.
|
|
9066
|
-
*
|
|
9067
|
-
* Sets the accessible aria name of the component.
|
|
9068
|
-
*
|
|
9069
|
-
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
9070
|
-
*
|
|
9071
|
-
* Default value is `empty string`.
|
|
9072
|
-
*/
|
|
9073
|
-
setAccessibleName(
|
|
9074
|
-
/**
|
|
9075
|
-
* New value for property `accessibleName`
|
|
9076
|
-
*/
|
|
9077
|
-
sAccessibleName?: string
|
|
9078
|
-
): this;
|
|
9079
|
-
/**
|
|
9080
|
-
* Sets a new value for property {@link #getAccessibleNameRef accessibleNameRef}.
|
|
9081
|
-
*
|
|
9082
|
-
* Defines the aria-labelledby of the step.
|
|
9083
|
-
*
|
|
9084
|
-
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
9085
|
-
*
|
|
9086
|
-
* Default value is `empty string`.
|
|
9087
|
-
*/
|
|
9088
|
-
setAccessibleNameRef(
|
|
9089
|
-
/**
|
|
9090
|
-
* New value for property `accessibleNameRef`
|
|
9091
|
-
*/
|
|
9092
|
-
sAccessibleNameRef?: string
|
|
9093
|
-
): this;
|
|
9094
11136
|
/**
|
|
9095
11137
|
* Sets a new value for property {@link #getBranching branching}.
|
|
9096
11138
|
*
|
|
@@ -9140,7 +11182,7 @@ declare namespace sap {
|
|
|
9140
11182
|
*
|
|
9141
11183
|
*
|
|
9142
11184
|
*
|
|
9143
|
-
* **Note:**
|
|
11185
|
+
* **Note:** The icon is displayed in the `sap.ui.webc.fiori.Wizard` navigation header.
|
|
9144
11186
|
*
|
|
9145
11187
|
*
|
|
9146
11188
|
*
|
|
@@ -9184,7 +11226,6 @@ declare namespace sap {
|
|
|
9184
11226
|
*
|
|
9185
11227
|
*
|
|
9186
11228
|
* **Note:** the text is displayed in the `sap.ui.webc.fiori.Wizard` navigation header.
|
|
9187
|
-
* **Note:** the text will hide on small sizes (about 559 px).
|
|
9188
11229
|
*
|
|
9189
11230
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
9190
11231
|
*
|
|
@@ -9203,8 +11244,7 @@ declare namespace sap {
|
|
|
9203
11244
|
*
|
|
9204
11245
|
*
|
|
9205
11246
|
*
|
|
9206
|
-
* **Note:**
|
|
9207
|
-
* **Note:** the text will hide on small sizes (about 559 px).
|
|
11247
|
+
* **Note:** The text is displayed in the `sap.ui.webc.fiori.Wizard` navigation header.
|
|
9208
11248
|
*
|
|
9209
11249
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
9210
11250
|
*
|
|
@@ -9315,56 +11355,368 @@ declare namespace sap {
|
|
|
9315
11355
|
TwoColumnsStartExpanded = "TwoColumnsStartExpanded",
|
|
9316
11356
|
}
|
|
9317
11357
|
/**
|
|
9318
|
-
* @SINCE 1.
|
|
9319
|
-
* @EXPERIMENTAL (since 1.
|
|
11358
|
+
* @SINCE 1.95.0
|
|
11359
|
+
* @EXPERIMENTAL (since 1.95.0)
|
|
9320
11360
|
*
|
|
9321
11361
|
* Different illustration types of Illustrated Message.
|
|
9322
11362
|
*/
|
|
9323
11363
|
enum IllustrationMessageType {
|
|
9324
11364
|
/**
|
|
9325
|
-
* "
|
|
11365
|
+
* "Add Column" illustration type.
|
|
11366
|
+
*/
|
|
11367
|
+
AddColumn = "AddColumn",
|
|
11368
|
+
/**
|
|
11369
|
+
* "Add People" illustration type.
|
|
11370
|
+
*/
|
|
11371
|
+
AddPeople = "AddPeople",
|
|
11372
|
+
/**
|
|
11373
|
+
* "Balloon Sky" illustration type.
|
|
11374
|
+
*/
|
|
11375
|
+
BalloonSky = "BalloonSky",
|
|
11376
|
+
/**
|
|
11377
|
+
* "Before Search" illustration type.
|
|
9326
11378
|
*/
|
|
9327
11379
|
BeforeSearch = "BeforeSearch",
|
|
9328
11380
|
/**
|
|
9329
|
-
* "
|
|
11381
|
+
* "Connection" illustration type.
|
|
11382
|
+
*/
|
|
11383
|
+
Connection = "Connection",
|
|
11384
|
+
/**
|
|
11385
|
+
* "Empty Calendar" illustration type.
|
|
11386
|
+
*/
|
|
11387
|
+
EmptyCalendar = "EmptyCalendar",
|
|
11388
|
+
/**
|
|
11389
|
+
* "Empty List" illustration type.
|
|
11390
|
+
*/
|
|
11391
|
+
EmptyList = "EmptyList",
|
|
11392
|
+
/**
|
|
11393
|
+
* "Empty Planning Calendar" illustration type.
|
|
11394
|
+
*/
|
|
11395
|
+
EmptyPlanningCalendar = "EmptyPlanningCalendar",
|
|
11396
|
+
/**
|
|
11397
|
+
* "Error Screen" illustration type.
|
|
11398
|
+
*/
|
|
11399
|
+
ErrorScreen = "ErrorScreen",
|
|
11400
|
+
/**
|
|
11401
|
+
* "Filter Table" illustration type.
|
|
11402
|
+
*/
|
|
11403
|
+
FilterTable = "FilterTable",
|
|
11404
|
+
/**
|
|
11405
|
+
* "Group Table" illustration type.
|
|
11406
|
+
*/
|
|
11407
|
+
GroupTable = "GroupTable",
|
|
11408
|
+
/**
|
|
11409
|
+
* "No Activities" illustration type.
|
|
9330
11410
|
*/
|
|
9331
11411
|
NoActivities = "NoActivities",
|
|
9332
11412
|
/**
|
|
9333
|
-
* "
|
|
11413
|
+
* "No Data" illustration type.
|
|
9334
11414
|
*/
|
|
9335
11415
|
NoData = "NoData",
|
|
9336
11416
|
/**
|
|
9337
|
-
* "
|
|
11417
|
+
* "No Entries" illustration type.
|
|
9338
11418
|
*/
|
|
9339
11419
|
NoEntries = "NoEntries",
|
|
9340
11420
|
/**
|
|
9341
|
-
* "
|
|
11421
|
+
* "No Filter Results" illustration type.
|
|
11422
|
+
*/
|
|
11423
|
+
NoFilterResults = "NoFilterResults",
|
|
11424
|
+
/**
|
|
11425
|
+
* "No Email" illustration type.
|
|
9342
11426
|
*/
|
|
9343
11427
|
NoMail = "NoMail",
|
|
9344
11428
|
/**
|
|
9345
|
-
* "
|
|
11429
|
+
* "No Email v1" illustration type.
|
|
11430
|
+
*/
|
|
11431
|
+
NoMail_v1 = "NoMail_v1",
|
|
11432
|
+
/**
|
|
11433
|
+
* "No Notifications" illustration type.
|
|
9346
11434
|
*/
|
|
9347
11435
|
NoNotifications = "NoNotifications",
|
|
9348
11436
|
/**
|
|
9349
|
-
* "
|
|
11437
|
+
* "No Saved Items" illustration type.
|
|
9350
11438
|
*/
|
|
9351
11439
|
NoSavedItems = "NoSavedItems",
|
|
9352
11440
|
/**
|
|
9353
|
-
* "
|
|
11441
|
+
* "No Saved Items v1" illustration type.
|
|
11442
|
+
*/
|
|
11443
|
+
NoSavedItems_v1 = "NoSavedItems_v1",
|
|
11444
|
+
/**
|
|
11445
|
+
* "No Search Results" illustration type.
|
|
9354
11446
|
*/
|
|
9355
11447
|
NoSearchResults = "NoSearchResults",
|
|
9356
11448
|
/**
|
|
9357
|
-
* "
|
|
11449
|
+
* "No Tasks" illustration type.
|
|
9358
11450
|
*/
|
|
9359
11451
|
NoTasks = "NoTasks",
|
|
9360
11452
|
/**
|
|
9361
|
-
* "
|
|
11453
|
+
* "No Tasks v1" illustration type.
|
|
11454
|
+
*/
|
|
11455
|
+
NoTasks_v1 = "NoTasks_v1",
|
|
11456
|
+
/**
|
|
11457
|
+
* "Page Not Found" illustration type.
|
|
11458
|
+
*/
|
|
11459
|
+
PageNotFound = "PageNotFound",
|
|
11460
|
+
/**
|
|
11461
|
+
* "Reload Screen" illustration type.
|
|
11462
|
+
*/
|
|
11463
|
+
ReloadScreen = "ReloadScreen",
|
|
11464
|
+
/**
|
|
11465
|
+
* "Resize Column" illustration type.
|
|
11466
|
+
*/
|
|
11467
|
+
ResizeColumn = "ResizeColumn",
|
|
11468
|
+
/**
|
|
11469
|
+
* "Search Earth" illustration type.
|
|
11470
|
+
*/
|
|
11471
|
+
SearchEarth = "SearchEarth",
|
|
11472
|
+
/**
|
|
11473
|
+
* "Search Folder" illustration type.
|
|
11474
|
+
*/
|
|
11475
|
+
SearchFolder = "SearchFolder",
|
|
11476
|
+
/**
|
|
11477
|
+
* "Simple Balloon" illustration type.
|
|
11478
|
+
*/
|
|
11479
|
+
SimpleBalloon = "SimpleBalloon",
|
|
11480
|
+
/**
|
|
11481
|
+
* "Simple Bell" illustration type.
|
|
11482
|
+
*/
|
|
11483
|
+
SimpleBell = "SimpleBell",
|
|
11484
|
+
/**
|
|
11485
|
+
* "Simple Calendar" illustration type.
|
|
11486
|
+
*/
|
|
11487
|
+
SimpleCalendar = "SimpleCalendar",
|
|
11488
|
+
/**
|
|
11489
|
+
* "Simple CheckMark" illustration type.
|
|
11490
|
+
*/
|
|
11491
|
+
SimpleCheckMark = "SimpleCheckMark",
|
|
11492
|
+
/**
|
|
11493
|
+
* "Simple Connection" illustration type.
|
|
11494
|
+
*/
|
|
11495
|
+
SimpleConnection = "SimpleConnection",
|
|
11496
|
+
/**
|
|
11497
|
+
* "Simple Empty Doc" illustration type.
|
|
11498
|
+
*/
|
|
11499
|
+
SimpleEmptyDoc = "SimpleEmptyDoc",
|
|
11500
|
+
/**
|
|
11501
|
+
* "Simple Empty List" illustration type.
|
|
11502
|
+
*/
|
|
11503
|
+
SimpleEmptyList = "SimpleEmptyList",
|
|
11504
|
+
/**
|
|
11505
|
+
* "Simple Error" illustration type.
|
|
11506
|
+
*/
|
|
11507
|
+
SimpleError = "SimpleError",
|
|
11508
|
+
/**
|
|
11509
|
+
* "Simple Magnifier" illustration type.
|
|
11510
|
+
*/
|
|
11511
|
+
SimpleMagnifier = "SimpleMagnifier",
|
|
11512
|
+
/**
|
|
11513
|
+
* "Simple Mail" illustration type.
|
|
11514
|
+
*/
|
|
11515
|
+
SimpleMail = "SimpleMail",
|
|
11516
|
+
/**
|
|
11517
|
+
* "Simple No Saved Items" illustration type.
|
|
11518
|
+
*/
|
|
11519
|
+
SimpleNoSavedItems = "SimpleNoSavedItems",
|
|
11520
|
+
/**
|
|
11521
|
+
* "Simple Not Found Magnifier" illustration type.
|
|
11522
|
+
*/
|
|
11523
|
+
SimpleNotFoundMagnifier = "SimpleNotFoundMagnifier",
|
|
11524
|
+
/**
|
|
11525
|
+
* "Simple Reload" illustration type.
|
|
11526
|
+
*/
|
|
11527
|
+
SimpleReload = "SimpleReload",
|
|
11528
|
+
/**
|
|
11529
|
+
* "Simple Task" illustration type.
|
|
11530
|
+
*/
|
|
11531
|
+
SimpleTask = "SimpleTask",
|
|
11532
|
+
/**
|
|
11533
|
+
* "Sleeping Bell" illustration type.
|
|
11534
|
+
*/
|
|
11535
|
+
SleepingBell = "SleepingBell",
|
|
11536
|
+
/**
|
|
11537
|
+
* "Sort Column" illustration type.
|
|
11538
|
+
*/
|
|
11539
|
+
SortColumn = "SortColumn",
|
|
11540
|
+
/**
|
|
11541
|
+
* "Success Balloon" illustration type.
|
|
11542
|
+
*/
|
|
11543
|
+
SuccessBalloon = "SuccessBalloon",
|
|
11544
|
+
/**
|
|
11545
|
+
* "Success CheckMark" illustration type.
|
|
11546
|
+
*/
|
|
11547
|
+
SuccessCheckMark = "SuccessCheckMark",
|
|
11548
|
+
/**
|
|
11549
|
+
* "Success HighFive" illustration type.
|
|
11550
|
+
*/
|
|
11551
|
+
SuccessHighFive = "SuccessHighFive",
|
|
11552
|
+
/**
|
|
11553
|
+
* "Success Screen" illustration type.
|
|
11554
|
+
*/
|
|
11555
|
+
SuccessScreen = "SuccessScreen",
|
|
11556
|
+
/**
|
|
11557
|
+
* "Tent" illustration type.
|
|
11558
|
+
*/
|
|
11559
|
+
Tent = "Tent",
|
|
11560
|
+
/**
|
|
11561
|
+
* "TntCodePlaceholder" illustration type.
|
|
11562
|
+
*/
|
|
11563
|
+
TntCodePlaceholder = "TntCodePlaceholder",
|
|
11564
|
+
/**
|
|
11565
|
+
* "TntCompany" illustration type.
|
|
11566
|
+
*/
|
|
11567
|
+
TntCompany = "TntCompany",
|
|
11568
|
+
/**
|
|
11569
|
+
* "TntExternalLink" illustration type.
|
|
11570
|
+
*/
|
|
11571
|
+
TntExternalLink = "TntExternalLink",
|
|
11572
|
+
/**
|
|
11573
|
+
* "TntFaceID" illustration type.
|
|
11574
|
+
*/
|
|
11575
|
+
TntFaceID = "TntFaceID",
|
|
11576
|
+
/**
|
|
11577
|
+
* "TntFingerprint" illustration type.
|
|
11578
|
+
*/
|
|
11579
|
+
TntFingerprint = "TntFingerprint",
|
|
11580
|
+
/**
|
|
11581
|
+
* "TntLock" illustration type.
|
|
11582
|
+
*/
|
|
11583
|
+
TntLock = "TntLock",
|
|
11584
|
+
/**
|
|
11585
|
+
* "TntMission" illustration type.
|
|
11586
|
+
*/
|
|
11587
|
+
TntMission = "TntMission",
|
|
11588
|
+
/**
|
|
11589
|
+
* "TntNoApplications" illustration type.
|
|
11590
|
+
*/
|
|
11591
|
+
TntNoApplications = "TntNoApplications",
|
|
11592
|
+
/**
|
|
11593
|
+
* "TntNoFlows" illustration type.
|
|
11594
|
+
*/
|
|
11595
|
+
TntNoFlows = "TntNoFlows",
|
|
11596
|
+
/**
|
|
11597
|
+
* "TntNoUsers" illustration type.
|
|
11598
|
+
*/
|
|
11599
|
+
TntNoUsers = "TntNoUsers",
|
|
11600
|
+
/**
|
|
11601
|
+
* "TntRadar" illustration type.
|
|
11602
|
+
*/
|
|
11603
|
+
TntRadar = "TntRadar",
|
|
11604
|
+
/**
|
|
11605
|
+
* "TntServices" illustration type.
|
|
11606
|
+
*/
|
|
11607
|
+
TntServices = "TntServices",
|
|
11608
|
+
/**
|
|
11609
|
+
* "TntSessionExpired" illustration type.
|
|
11610
|
+
*/
|
|
11611
|
+
TntSessionExpired = "TntSessionExpired",
|
|
11612
|
+
/**
|
|
11613
|
+
* "TntSessionExpiring" illustration type.
|
|
11614
|
+
*/
|
|
11615
|
+
TntSessionExpiring = "TntSessionExpiring",
|
|
11616
|
+
/**
|
|
11617
|
+
* "TntSuccess" illustration type.
|
|
11618
|
+
*/
|
|
11619
|
+
TntSuccess = "TntSuccess",
|
|
11620
|
+
/**
|
|
11621
|
+
* "TntSuccessfulAuth" illustration type.
|
|
11622
|
+
*/
|
|
11623
|
+
TntSuccessfulAuth = "TntSuccessfulAuth",
|
|
11624
|
+
/**
|
|
11625
|
+
* "TntUnlock" illustration type.
|
|
11626
|
+
*/
|
|
11627
|
+
TntUnlock = "TntUnlock",
|
|
11628
|
+
/**
|
|
11629
|
+
* "TntUnsuccessfulAuth" illustration type.
|
|
11630
|
+
*/
|
|
11631
|
+
TntUnsuccessfulAuth = "TntUnsuccessfulAuth",
|
|
11632
|
+
/**
|
|
11633
|
+
* "Unable To Load" illustration type.
|
|
9362
11634
|
*/
|
|
9363
11635
|
UnableToLoad = "UnableToLoad",
|
|
9364
11636
|
/**
|
|
9365
|
-
* "
|
|
11637
|
+
* "Unable To Load Image" illustration type.
|
|
11638
|
+
*/
|
|
11639
|
+
UnableToLoadImage = "UnableToLoadImage",
|
|
11640
|
+
/**
|
|
11641
|
+
* "Unable To Upload" illustration type.
|
|
9366
11642
|
*/
|
|
9367
11643
|
UnableToUpload = "UnableToUpload",
|
|
11644
|
+
/**
|
|
11645
|
+
* "Upload Collection" illustration type.
|
|
11646
|
+
*/
|
|
11647
|
+
UploadCollection = "UploadCollection",
|
|
11648
|
+
}
|
|
11649
|
+
/**
|
|
11650
|
+
* @SINCE 1.99.0
|
|
11651
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
11652
|
+
*
|
|
11653
|
+
* Defines the layout of the content displayed in the `ui5-media-gallery-item`.
|
|
11654
|
+
*/
|
|
11655
|
+
enum MediaGalleryItemLayout {
|
|
11656
|
+
/**
|
|
11657
|
+
* Recommended to use when the item contains an image.
|
|
11658
|
+
* When a thumbnail is selected, it makes the corresponding enlarged content appear in a square display
|
|
11659
|
+
* area.
|
|
11660
|
+
*/
|
|
11661
|
+
Square = "Square",
|
|
11662
|
+
/**
|
|
11663
|
+
* Recommended to use when the item contains video content.
|
|
11664
|
+
* When a thumbnail is selected, it makes the corresponding enlarged content appear in a wide display area
|
|
11665
|
+
* (stretched to fill all of the available width) for optimal user experiance.
|
|
11666
|
+
*/
|
|
11667
|
+
Wide = "Wide",
|
|
11668
|
+
}
|
|
11669
|
+
/**
|
|
11670
|
+
* @SINCE 1.99.0
|
|
11671
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
11672
|
+
*
|
|
11673
|
+
* Defines the layout type of the thumbnails list of the `ui5-media-gallery` component.
|
|
11674
|
+
*/
|
|
11675
|
+
enum MediaGalleryLayout {
|
|
11676
|
+
/**
|
|
11677
|
+
* The layout is determined automatically.
|
|
11678
|
+
*/
|
|
11679
|
+
Auto = "Auto",
|
|
11680
|
+
/**
|
|
11681
|
+
* Displays the layout as a horizontal split between the thumbnails list and the selected image.
|
|
11682
|
+
*/
|
|
11683
|
+
Horizontal = "Horizontal",
|
|
11684
|
+
/**
|
|
11685
|
+
* Displays the layout as a vertical split between the thumbnails list and the selected image.
|
|
11686
|
+
*/
|
|
11687
|
+
Vertical = "Vertical",
|
|
11688
|
+
}
|
|
11689
|
+
/**
|
|
11690
|
+
* @SINCE 1.99.0
|
|
11691
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
11692
|
+
*
|
|
11693
|
+
* Defines the horizontal alignment of the thumbnails menu of the `ui5-media-gallery` component.
|
|
11694
|
+
*/
|
|
11695
|
+
enum MediaGalleryMenuHorizontalAlign {
|
|
11696
|
+
/**
|
|
11697
|
+
* Displays the menu on the left side of the target.
|
|
11698
|
+
*/
|
|
11699
|
+
Left = "Left",
|
|
11700
|
+
/**
|
|
11701
|
+
* Displays the menu on the right side of the target.
|
|
11702
|
+
*/
|
|
11703
|
+
Right = "Right",
|
|
11704
|
+
}
|
|
11705
|
+
/**
|
|
11706
|
+
* @SINCE 1.99.0
|
|
11707
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
11708
|
+
*
|
|
11709
|
+
* Types for the vertical alignment of the thumbnails menu of the `ui5-media-gallery` component.
|
|
11710
|
+
*/
|
|
11711
|
+
enum MediaGalleryMenuVerticalAlign {
|
|
11712
|
+
/**
|
|
11713
|
+
* Displays the menu at the bottom of the reference control.
|
|
11714
|
+
*/
|
|
11715
|
+
Bottom = "Bottom",
|
|
11716
|
+
/**
|
|
11717
|
+
* Displays the menu at the top of the reference control.
|
|
11718
|
+
*/
|
|
11719
|
+
Top = "Top",
|
|
9368
11720
|
}
|
|
9369
11721
|
/**
|
|
9370
11722
|
* @SINCE 1.92.0
|
|
@@ -9386,6 +11738,76 @@ declare namespace sap {
|
|
|
9386
11738
|
*/
|
|
9387
11739
|
Transparent = "Transparent",
|
|
9388
11740
|
}
|
|
11741
|
+
/**
|
|
11742
|
+
* @SINCE 1.99.0
|
|
11743
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
11744
|
+
*
|
|
11745
|
+
* SideContent FallDown options.
|
|
11746
|
+
*/
|
|
11747
|
+
enum SideContentFallDown {
|
|
11748
|
+
/**
|
|
11749
|
+
* Side content falls down on breakpoints below L
|
|
11750
|
+
*/
|
|
11751
|
+
BelowL = "BelowL",
|
|
11752
|
+
/**
|
|
11753
|
+
* Side content falls down on breakpoints below M
|
|
11754
|
+
*/
|
|
11755
|
+
BelowM = "BelowM",
|
|
11756
|
+
/**
|
|
11757
|
+
* Side content falls down on breakpoints below XL
|
|
11758
|
+
*/
|
|
11759
|
+
BelowXL = "BelowXL",
|
|
11760
|
+
/**
|
|
11761
|
+
* Side content falls down on breakpoint M and the minimum width for the side content
|
|
11762
|
+
*/
|
|
11763
|
+
OnMinimumWidth = "OnMinimumWidth",
|
|
11764
|
+
}
|
|
11765
|
+
/**
|
|
11766
|
+
* @SINCE 1.99.0
|
|
11767
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
11768
|
+
*
|
|
11769
|
+
* Side Content position options.
|
|
11770
|
+
*/
|
|
11771
|
+
enum SideContentPosition {
|
|
11772
|
+
/**
|
|
11773
|
+
* The side content is on the right side of the main container in left-to-right mode and on the left side
|
|
11774
|
+
* in right-to-left mode.
|
|
11775
|
+
*/
|
|
11776
|
+
End = "End",
|
|
11777
|
+
/**
|
|
11778
|
+
* The side content is on the left side of the main container in left-to-right mode and on the right side
|
|
11779
|
+
* in right-to-left mode.
|
|
11780
|
+
*/
|
|
11781
|
+
Start = "Start",
|
|
11782
|
+
}
|
|
11783
|
+
/**
|
|
11784
|
+
* @SINCE 1.99.0
|
|
11785
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
11786
|
+
*
|
|
11787
|
+
* Side Content visibility options.
|
|
11788
|
+
*/
|
|
11789
|
+
enum SideContentVisibility {
|
|
11790
|
+
/**
|
|
11791
|
+
* Show the side content on any breakpoint
|
|
11792
|
+
*/
|
|
11793
|
+
AlwaysShow = "AlwaysShow",
|
|
11794
|
+
/**
|
|
11795
|
+
* Don't show the side content on any breakpoints
|
|
11796
|
+
*/
|
|
11797
|
+
NeverShow = "NeverShow",
|
|
11798
|
+
/**
|
|
11799
|
+
* Show the side content on XL breakpoint
|
|
11800
|
+
*/
|
|
11801
|
+
ShowAboveL = "ShowAboveL",
|
|
11802
|
+
/**
|
|
11803
|
+
* Show the side content on L and XL breakpoints
|
|
11804
|
+
*/
|
|
11805
|
+
ShowAboveM = "ShowAboveM",
|
|
11806
|
+
/**
|
|
11807
|
+
* Show the side content on M, L and XL breakpoints
|
|
11808
|
+
*/
|
|
11809
|
+
ShowAboveS = "ShowAboveS",
|
|
11810
|
+
}
|
|
9389
11811
|
/**
|
|
9390
11812
|
* @SINCE 1.92.0
|
|
9391
11813
|
* @EXPERIMENTAL (since 1.92.0)
|
|
@@ -9435,12 +11857,22 @@ declare namespace sap {
|
|
|
9435
11857
|
|
|
9436
11858
|
"sap/ui/webc/fiori/BarcodeScannerDialog": undefined;
|
|
9437
11859
|
|
|
11860
|
+
"sap/ui/webc/fiori/DynamicSideContent": undefined;
|
|
11861
|
+
|
|
11862
|
+
"sap/ui/webc/fiori/FilterItem": undefined;
|
|
11863
|
+
|
|
11864
|
+
"sap/ui/webc/fiori/FilterItemOption": undefined;
|
|
11865
|
+
|
|
9438
11866
|
"sap/ui/webc/fiori/FlexibleColumnLayout": undefined;
|
|
9439
11867
|
|
|
9440
11868
|
"sap/ui/webc/fiori/IllustratedMessage": undefined;
|
|
9441
11869
|
|
|
9442
11870
|
"sap/ui/webc/fiori/library": undefined;
|
|
9443
11871
|
|
|
11872
|
+
"sap/ui/webc/fiori/MediaGallery": undefined;
|
|
11873
|
+
|
|
11874
|
+
"sap/ui/webc/fiori/MediaGalleryItem": undefined;
|
|
11875
|
+
|
|
9444
11876
|
"sap/ui/webc/fiori/NotificationAction": undefined;
|
|
9445
11877
|
|
|
9446
11878
|
"sap/ui/webc/fiori/NotificationListGroupItem": undefined;
|
|
@@ -9463,6 +11895,8 @@ declare namespace sap {
|
|
|
9463
11895
|
|
|
9464
11896
|
"sap/ui/webc/fiori/SideNavigationSubItem": undefined;
|
|
9465
11897
|
|
|
11898
|
+
"sap/ui/webc/fiori/SortItem": undefined;
|
|
11899
|
+
|
|
9466
11900
|
"sap/ui/webc/fiori/Timeline": undefined;
|
|
9467
11901
|
|
|
9468
11902
|
"sap/ui/webc/fiori/TimelineItem": undefined;
|