@openui5/ts-types-esm 1.98.0 → 1.101.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +6 -2
- package/types/sap.f.d.ts +389 -89
- package/types/sap.m.d.ts +1692 -176
- package/types/sap.tnt.d.ts +1 -1
- package/types/sap.ui.codeeditor.d.ts +1 -1
- package/types/sap.ui.commons.d.ts +1 -1
- package/types/sap.ui.core.d.ts +1489 -752
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.fl.d.ts +11 -5
- package/types/sap.ui.integration.d.ts +29 -11
- package/types/sap.ui.layout.d.ts +4 -1
- package/types/sap.ui.mdc.d.ts +64 -8
- package/types/sap.ui.rta.d.ts +1 -1
- package/types/sap.ui.suite.d.ts +1 -1
- package/types/sap.ui.support.d.ts +10 -12
- package/types/sap.ui.table.d.ts +13 -49
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +1 -1
- package/types/sap.ui.ux3.d.ts +1 -1
- package/types/sap.ui.webc.common.d.ts +1 -1
- package/types/sap.ui.webc.fiori.d.ts +2836 -860
- package/types/sap.ui.webc.main.d.ts +3346 -1034
- package/types/sap.uxap.d.ts +2 -2
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.
|
|
1
|
+
// For Library Version: 1.101.0
|
|
2
2
|
|
|
3
3
|
declare module "sap/ui/webc/fiori/library" {
|
|
4
4
|
/**
|
|
@@ -98,6 +98,16 @@ declare module "sap/ui/webc/fiori/library" {
|
|
|
98
98
|
*/
|
|
99
99
|
TwoColumnsStartExpanded = "TwoColumnsStartExpanded",
|
|
100
100
|
}
|
|
101
|
+
/**
|
|
102
|
+
* @SINCE 1.99.0
|
|
103
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
104
|
+
*
|
|
105
|
+
* Interface for components that may be slotted inside `ui5-page` as header and footer.
|
|
106
|
+
*/
|
|
107
|
+
export interface IBar {
|
|
108
|
+
__implements__sap_ui_webc_fiori_IBar: boolean;
|
|
109
|
+
}
|
|
110
|
+
|
|
101
111
|
/**
|
|
102
112
|
* @SINCE 1.97.0
|
|
103
113
|
* @EXPERIMENTAL (since 1.97.0)
|
|
@@ -126,41 +136,241 @@ declare module "sap/ui/webc/fiori/library" {
|
|
|
126
136
|
*/
|
|
127
137
|
export enum IllustrationMessageType {
|
|
128
138
|
/**
|
|
129
|
-
* "
|
|
139
|
+
* "Add Column" illustration type.
|
|
140
|
+
*/
|
|
141
|
+
AddColumn = "AddColumn",
|
|
142
|
+
/**
|
|
143
|
+
* "Add People" illustration type.
|
|
144
|
+
*/
|
|
145
|
+
AddPeople = "AddPeople",
|
|
146
|
+
/**
|
|
147
|
+
* "Balloon Sky" illustration type.
|
|
148
|
+
*/
|
|
149
|
+
BalloonSky = "BalloonSky",
|
|
150
|
+
/**
|
|
151
|
+
* "Before Search" illustration type.
|
|
130
152
|
*/
|
|
131
153
|
BeforeSearch = "BeforeSearch",
|
|
132
154
|
/**
|
|
133
|
-
* "
|
|
155
|
+
* "Connection" illustration type.
|
|
156
|
+
*/
|
|
157
|
+
Connection = "Connection",
|
|
158
|
+
/**
|
|
159
|
+
* "Empty Calendar" illustration type.
|
|
160
|
+
*/
|
|
161
|
+
EmptyCalendar = "EmptyCalendar",
|
|
162
|
+
/**
|
|
163
|
+
* "Empty List" illustration type.
|
|
164
|
+
*/
|
|
165
|
+
EmptyList = "EmptyList",
|
|
166
|
+
/**
|
|
167
|
+
* "Empty Planning Calendar" illustration type.
|
|
168
|
+
*/
|
|
169
|
+
EmptyPlanningCalendar = "EmptyPlanningCalendar",
|
|
170
|
+
/**
|
|
171
|
+
* "Error Screen" illustration type.
|
|
172
|
+
*/
|
|
173
|
+
ErrorScreen = "ErrorScreen",
|
|
174
|
+
/**
|
|
175
|
+
* "Filter Table" illustration type.
|
|
176
|
+
*/
|
|
177
|
+
FilterTable = "FilterTable",
|
|
178
|
+
/**
|
|
179
|
+
* "Group Table" illustration type.
|
|
180
|
+
*/
|
|
181
|
+
GroupTable = "GroupTable",
|
|
182
|
+
/**
|
|
183
|
+
* "No Activities" illustration type.
|
|
134
184
|
*/
|
|
135
185
|
NoActivities = "NoActivities",
|
|
136
186
|
/**
|
|
137
|
-
* "
|
|
187
|
+
* "No Data" illustration type.
|
|
138
188
|
*/
|
|
139
189
|
NoData = "NoData",
|
|
140
190
|
/**
|
|
141
|
-
* "
|
|
191
|
+
* "No Entries" illustration type.
|
|
142
192
|
*/
|
|
143
193
|
NoEntries = "NoEntries",
|
|
144
194
|
/**
|
|
145
|
-
* "
|
|
195
|
+
* "No Filter Results" illustration type.
|
|
196
|
+
*/
|
|
197
|
+
NoFilterResults = "NoFilterResults",
|
|
198
|
+
/**
|
|
199
|
+
* "No Email" illustration type.
|
|
146
200
|
*/
|
|
147
201
|
NoMail = "NoMail",
|
|
148
202
|
/**
|
|
149
|
-
* "
|
|
203
|
+
* "No Email v1" illustration type.
|
|
204
|
+
*/
|
|
205
|
+
NoMail_v1 = "NoMail_v1",
|
|
206
|
+
/**
|
|
207
|
+
* "No Notifications" illustration type.
|
|
150
208
|
*/
|
|
151
209
|
NoNotifications = "NoNotifications",
|
|
152
210
|
/**
|
|
153
|
-
* "
|
|
211
|
+
* "No Saved Items" illustration type.
|
|
154
212
|
*/
|
|
155
213
|
NoSavedItems = "NoSavedItems",
|
|
156
214
|
/**
|
|
157
|
-
* "
|
|
215
|
+
* "No Saved Items v1" illustration type.
|
|
216
|
+
*/
|
|
217
|
+
NoSavedItems_v1 = "NoSavedItems_v1",
|
|
218
|
+
/**
|
|
219
|
+
* "No Search Results" illustration type.
|
|
158
220
|
*/
|
|
159
221
|
NoSearchResults = "NoSearchResults",
|
|
160
222
|
/**
|
|
161
|
-
* "
|
|
223
|
+
* "No Tasks" illustration type.
|
|
162
224
|
*/
|
|
163
225
|
NoTasks = "NoTasks",
|
|
226
|
+
/**
|
|
227
|
+
* "No Tasks v1" illustration type.
|
|
228
|
+
*/
|
|
229
|
+
NoTasks_v1 = "NoTasks_v1",
|
|
230
|
+
/**
|
|
231
|
+
* "Page Not Found" illustration type.
|
|
232
|
+
*/
|
|
233
|
+
PageNotFound = "PageNotFound",
|
|
234
|
+
/**
|
|
235
|
+
* "Reload Screen" illustration type.
|
|
236
|
+
*/
|
|
237
|
+
ReloadScreen = "ReloadScreen",
|
|
238
|
+
/**
|
|
239
|
+
* "Resize Column" illustration type.
|
|
240
|
+
*/
|
|
241
|
+
ResizeColumn = "ResizeColumn",
|
|
242
|
+
/**
|
|
243
|
+
* "Search Earth" illustration type.
|
|
244
|
+
*/
|
|
245
|
+
SearchEarth = "SearchEarth",
|
|
246
|
+
/**
|
|
247
|
+
* "Search Folder" illustration type.
|
|
248
|
+
*/
|
|
249
|
+
SearchFolder = "SearchFolder",
|
|
250
|
+
/**
|
|
251
|
+
* "Simple Balloon" illustration type.
|
|
252
|
+
*/
|
|
253
|
+
SimpleBalloon = "SimpleBalloon",
|
|
254
|
+
/**
|
|
255
|
+
* "Simple Bell" illustration type.
|
|
256
|
+
*/
|
|
257
|
+
SimpleBell = "SimpleBell",
|
|
258
|
+
/**
|
|
259
|
+
* "Simple Calendar" illustration type.
|
|
260
|
+
*/
|
|
261
|
+
SimpleCalendar = "SimpleCalendar",
|
|
262
|
+
/**
|
|
263
|
+
* "Simple CheckMark" illustration type.
|
|
264
|
+
*/
|
|
265
|
+
SimpleCheckMark = "SimpleCheckMark",
|
|
266
|
+
/**
|
|
267
|
+
* "Simple Connection" illustration type.
|
|
268
|
+
*/
|
|
269
|
+
SimpleConnection = "SimpleConnection",
|
|
270
|
+
/**
|
|
271
|
+
* "Simple Empty Doc" illustration type.
|
|
272
|
+
*/
|
|
273
|
+
SimpleEmptyDoc = "SimpleEmptyDoc",
|
|
274
|
+
/**
|
|
275
|
+
* "Simple Empty List" illustration type.
|
|
276
|
+
*/
|
|
277
|
+
SimpleEmptyList = "SimpleEmptyList",
|
|
278
|
+
/**
|
|
279
|
+
* "Simple Error" illustration type.
|
|
280
|
+
*/
|
|
281
|
+
SimpleError = "SimpleError",
|
|
282
|
+
/**
|
|
283
|
+
* "Simple Magnifier" illustration type.
|
|
284
|
+
*/
|
|
285
|
+
SimpleMagnifier = "SimpleMagnifier",
|
|
286
|
+
/**
|
|
287
|
+
* "Simple Mail" illustration type.
|
|
288
|
+
*/
|
|
289
|
+
SimpleMail = "SimpleMail",
|
|
290
|
+
/**
|
|
291
|
+
* "Simple No Saved Items" illustration type.
|
|
292
|
+
*/
|
|
293
|
+
SimpleNoSavedItems = "SimpleNoSavedItems",
|
|
294
|
+
/**
|
|
295
|
+
* "Simple Not Found Magnifier" illustration type.
|
|
296
|
+
*/
|
|
297
|
+
SimpleNotFoundMagnifier = "SimpleNotFoundMagnifier",
|
|
298
|
+
/**
|
|
299
|
+
* "Simple Reload" illustration type.
|
|
300
|
+
*/
|
|
301
|
+
SimpleReload = "SimpleReload",
|
|
302
|
+
/**
|
|
303
|
+
* "Simple Task" illustration type.
|
|
304
|
+
*/
|
|
305
|
+
SimpleTask = "SimpleTask",
|
|
306
|
+
/**
|
|
307
|
+
* "Sleeping Bell" illustration type.
|
|
308
|
+
*/
|
|
309
|
+
SleepingBell = "SleepingBell",
|
|
310
|
+
/**
|
|
311
|
+
* "Sort Column" illustration type.
|
|
312
|
+
*/
|
|
313
|
+
SortColumn = "SortColumn",
|
|
314
|
+
/**
|
|
315
|
+
* "Success Balloon" illustration type.
|
|
316
|
+
*/
|
|
317
|
+
SuccessBalloon = "SuccessBalloon",
|
|
318
|
+
/**
|
|
319
|
+
* "Success CheckMark" illustration type.
|
|
320
|
+
*/
|
|
321
|
+
SuccessCheckMark = "SuccessCheckMark",
|
|
322
|
+
/**
|
|
323
|
+
* "Success HighFive" illustration type.
|
|
324
|
+
*/
|
|
325
|
+
SuccessHighFive = "SuccessHighFive",
|
|
326
|
+
/**
|
|
327
|
+
* "Success Screen" illustration type.
|
|
328
|
+
*/
|
|
329
|
+
SuccessScreen = "SuccessScreen",
|
|
330
|
+
/**
|
|
331
|
+
* "Tent" illustration type.
|
|
332
|
+
*/
|
|
333
|
+
Tent = "Tent",
|
|
334
|
+
/**
|
|
335
|
+
* "TntChartArea" illustration type.
|
|
336
|
+
*/
|
|
337
|
+
TntChartArea = "TntChartArea",
|
|
338
|
+
/**
|
|
339
|
+
* "TntChartArea2" illustration type.
|
|
340
|
+
*/
|
|
341
|
+
TntChartArea2 = "TntChartArea2",
|
|
342
|
+
/**
|
|
343
|
+
* "TntChartBar" illustration type.
|
|
344
|
+
*/
|
|
345
|
+
TntChartBar = "TntChartBar",
|
|
346
|
+
/**
|
|
347
|
+
* "TntChartBPMNFlow" illustration type.
|
|
348
|
+
*/
|
|
349
|
+
TntChartBPMNFlow = "TntChartBPMNFlow",
|
|
350
|
+
/**
|
|
351
|
+
* "TntChartBullet" illustration type.
|
|
352
|
+
*/
|
|
353
|
+
TntChartBullet = "TntChartBullet",
|
|
354
|
+
/**
|
|
355
|
+
* "TntChartDoughnut" illustration type.
|
|
356
|
+
*/
|
|
357
|
+
TntChartDoughnut = "TntChartDoughnut",
|
|
358
|
+
/**
|
|
359
|
+
* "TntChartFlow" illustration type.
|
|
360
|
+
*/
|
|
361
|
+
TntChartFlow = "TntChartFlow",
|
|
362
|
+
/**
|
|
363
|
+
* "TntChartGantt" illustration type.
|
|
364
|
+
*/
|
|
365
|
+
TntChartGantt = "TntChartGantt",
|
|
366
|
+
/**
|
|
367
|
+
* "TntChartOrg" illustration type.
|
|
368
|
+
*/
|
|
369
|
+
TntChartOrg = "TntChartOrg",
|
|
370
|
+
/**
|
|
371
|
+
* "TntChartPie" illustration type.
|
|
372
|
+
*/
|
|
373
|
+
TntChartPie = "TntChartPie",
|
|
164
374
|
/**
|
|
165
375
|
* "TntCodePlaceholder" illustration type.
|
|
166
376
|
*/
|
|
@@ -169,6 +379,10 @@ declare module "sap/ui/webc/fiori/library" {
|
|
|
169
379
|
* "TntCompany" illustration type.
|
|
170
380
|
*/
|
|
171
381
|
TntCompany = "TntCompany",
|
|
382
|
+
/**
|
|
383
|
+
* "TntComponents" illustration type.
|
|
384
|
+
*/
|
|
385
|
+
TntComponents = "TntComponents",
|
|
172
386
|
/**
|
|
173
387
|
* "TntExternalLink" illustration type.
|
|
174
388
|
*/
|
|
@@ -205,6 +419,10 @@ declare module "sap/ui/webc/fiori/library" {
|
|
|
205
419
|
* "TntRadar" illustration type.
|
|
206
420
|
*/
|
|
207
421
|
TntRadar = "TntRadar",
|
|
422
|
+
/**
|
|
423
|
+
* "TntSecrets" illustration type.
|
|
424
|
+
*/
|
|
425
|
+
TntSecrets = "TntSecrets",
|
|
208
426
|
/**
|
|
209
427
|
* "TntServices" illustration type.
|
|
210
428
|
*/
|
|
@@ -225,6 +443,22 @@ declare module "sap/ui/webc/fiori/library" {
|
|
|
225
443
|
* "TntSuccessfulAuth" illustration type.
|
|
226
444
|
*/
|
|
227
445
|
TntSuccessfulAuth = "TntSuccessfulAuth",
|
|
446
|
+
/**
|
|
447
|
+
* "TntSystems" illustration type.
|
|
448
|
+
*/
|
|
449
|
+
TntSystems = "TntSystems",
|
|
450
|
+
/**
|
|
451
|
+
* "TntTeams" illustration type.
|
|
452
|
+
*/
|
|
453
|
+
TntTeams = "TntTeams",
|
|
454
|
+
/**
|
|
455
|
+
* "TntTools" illustration type.
|
|
456
|
+
*/
|
|
457
|
+
TntTools = "TntTools",
|
|
458
|
+
/**
|
|
459
|
+
* "TntUnableToLoad" illustration type.
|
|
460
|
+
*/
|
|
461
|
+
TntUnableToLoad = "TntUnableToLoad",
|
|
228
462
|
/**
|
|
229
463
|
* "TntUnlock" illustration type.
|
|
230
464
|
*/
|
|
@@ -234,14 +468,36 @@ declare module "sap/ui/webc/fiori/library" {
|
|
|
234
468
|
*/
|
|
235
469
|
TntUnsuccessfulAuth = "TntUnsuccessfulAuth",
|
|
236
470
|
/**
|
|
237
|
-
* "
|
|
471
|
+
* "TntUser2" illustration type.
|
|
472
|
+
*/
|
|
473
|
+
TntUser2 = "TntUser2",
|
|
474
|
+
/**
|
|
475
|
+
* "Unable To Load" illustration type.
|
|
238
476
|
*/
|
|
239
477
|
UnableToLoad = "UnableToLoad",
|
|
240
478
|
/**
|
|
241
|
-
* "
|
|
479
|
+
* "Unable To Load Image" illustration type.
|
|
480
|
+
*/
|
|
481
|
+
UnableToLoadImage = "UnableToLoadImage",
|
|
482
|
+
/**
|
|
483
|
+
* "Unable To Upload" illustration type.
|
|
242
484
|
*/
|
|
243
485
|
UnableToUpload = "UnableToUpload",
|
|
486
|
+
/**
|
|
487
|
+
* "Upload Collection" illustration type.
|
|
488
|
+
*/
|
|
489
|
+
UploadCollection = "UploadCollection",
|
|
490
|
+
}
|
|
491
|
+
/**
|
|
492
|
+
* @SINCE 1.99.0
|
|
493
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
494
|
+
*
|
|
495
|
+
* Interface for components that can be slotted inside `ui5-media-gallery` as items.
|
|
496
|
+
*/
|
|
497
|
+
export interface IMediaGalleryItem {
|
|
498
|
+
__implements__sap_ui_webc_fiori_IMediaGalleryItem: boolean;
|
|
244
499
|
}
|
|
500
|
+
|
|
245
501
|
/**
|
|
246
502
|
* @SINCE 1.92.0
|
|
247
503
|
* @EXPERIMENTAL (since 1.92.0)
|
|
@@ -342,6 +598,78 @@ declare module "sap/ui/webc/fiori/library" {
|
|
|
342
598
|
__implements__sap_ui_webc_fiori_IWizardStep: boolean;
|
|
343
599
|
}
|
|
344
600
|
|
|
601
|
+
/**
|
|
602
|
+
* @SINCE 1.99.0
|
|
603
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
604
|
+
*
|
|
605
|
+
* Defines the layout of the content displayed in the `ui5-media-gallery-item`.
|
|
606
|
+
*/
|
|
607
|
+
export enum MediaGalleryItemLayout {
|
|
608
|
+
/**
|
|
609
|
+
* Recommended to use when the item contains an image.
|
|
610
|
+
* When a thumbnail is selected, it makes the corresponding enlarged content appear in a square display
|
|
611
|
+
* area.
|
|
612
|
+
*/
|
|
613
|
+
Square = "Square",
|
|
614
|
+
/**
|
|
615
|
+
* Recommended to use when the item contains video content.
|
|
616
|
+
* When a thumbnail is selected, it makes the corresponding enlarged content appear in a wide display area
|
|
617
|
+
* (stretched to fill all of the available width) for optimal user experiance.
|
|
618
|
+
*/
|
|
619
|
+
Wide = "Wide",
|
|
620
|
+
}
|
|
621
|
+
/**
|
|
622
|
+
* @SINCE 1.99.0
|
|
623
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
624
|
+
*
|
|
625
|
+
* Defines the layout type of the thumbnails list of the `ui5-media-gallery` component.
|
|
626
|
+
*/
|
|
627
|
+
export enum MediaGalleryLayout {
|
|
628
|
+
/**
|
|
629
|
+
* The layout is determined automatically.
|
|
630
|
+
*/
|
|
631
|
+
Auto = "Auto",
|
|
632
|
+
/**
|
|
633
|
+
* Displays the layout as a horizontal split between the thumbnails list and the selected image.
|
|
634
|
+
*/
|
|
635
|
+
Horizontal = "Horizontal",
|
|
636
|
+
/**
|
|
637
|
+
* Displays the layout as a vertical split between the thumbnails list and the selected image.
|
|
638
|
+
*/
|
|
639
|
+
Vertical = "Vertical",
|
|
640
|
+
}
|
|
641
|
+
/**
|
|
642
|
+
* @SINCE 1.99.0
|
|
643
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
644
|
+
*
|
|
645
|
+
* Defines the horizontal alignment of the thumbnails menu of the `ui5-media-gallery` component.
|
|
646
|
+
*/
|
|
647
|
+
export enum MediaGalleryMenuHorizontalAlign {
|
|
648
|
+
/**
|
|
649
|
+
* Displays the menu on the left side of the target.
|
|
650
|
+
*/
|
|
651
|
+
Left = "Left",
|
|
652
|
+
/**
|
|
653
|
+
* Displays the menu on the right side of the target.
|
|
654
|
+
*/
|
|
655
|
+
Right = "Right",
|
|
656
|
+
}
|
|
657
|
+
/**
|
|
658
|
+
* @SINCE 1.99.0
|
|
659
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
660
|
+
*
|
|
661
|
+
* Types for the vertical alignment of the thumbnails menu of the `ui5-media-gallery` component.
|
|
662
|
+
*/
|
|
663
|
+
export enum MediaGalleryMenuVerticalAlign {
|
|
664
|
+
/**
|
|
665
|
+
* Displays the menu at the bottom of the reference control.
|
|
666
|
+
*/
|
|
667
|
+
Bottom = "Bottom",
|
|
668
|
+
/**
|
|
669
|
+
* Displays the menu at the top of the reference control.
|
|
670
|
+
*/
|
|
671
|
+
Top = "Top",
|
|
672
|
+
}
|
|
345
673
|
/**
|
|
346
674
|
* @SINCE 1.92.0
|
|
347
675
|
* @EXPERIMENTAL (since 1.92.0)
|
|
@@ -362,6 +690,76 @@ declare module "sap/ui/webc/fiori/library" {
|
|
|
362
690
|
*/
|
|
363
691
|
Transparent = "Transparent",
|
|
364
692
|
}
|
|
693
|
+
/**
|
|
694
|
+
* @SINCE 1.99.0
|
|
695
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
696
|
+
*
|
|
697
|
+
* SideContent FallDown options.
|
|
698
|
+
*/
|
|
699
|
+
export enum SideContentFallDown {
|
|
700
|
+
/**
|
|
701
|
+
* Side content falls down on breakpoints below L
|
|
702
|
+
*/
|
|
703
|
+
BelowL = "BelowL",
|
|
704
|
+
/**
|
|
705
|
+
* Side content falls down on breakpoints below M
|
|
706
|
+
*/
|
|
707
|
+
BelowM = "BelowM",
|
|
708
|
+
/**
|
|
709
|
+
* Side content falls down on breakpoints below XL
|
|
710
|
+
*/
|
|
711
|
+
BelowXL = "BelowXL",
|
|
712
|
+
/**
|
|
713
|
+
* Side content falls down on breakpoint M and the minimum width for the side content
|
|
714
|
+
*/
|
|
715
|
+
OnMinimumWidth = "OnMinimumWidth",
|
|
716
|
+
}
|
|
717
|
+
/**
|
|
718
|
+
* @SINCE 1.99.0
|
|
719
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
720
|
+
*
|
|
721
|
+
* Side Content position options.
|
|
722
|
+
*/
|
|
723
|
+
export enum SideContentPosition {
|
|
724
|
+
/**
|
|
725
|
+
* The side content is on the right side of the main container in left-to-right mode and on the left side
|
|
726
|
+
* in right-to-left mode.
|
|
727
|
+
*/
|
|
728
|
+
End = "End",
|
|
729
|
+
/**
|
|
730
|
+
* The side content is on the left side of the main container in left-to-right mode and on the right side
|
|
731
|
+
* in right-to-left mode.
|
|
732
|
+
*/
|
|
733
|
+
Start = "Start",
|
|
734
|
+
}
|
|
735
|
+
/**
|
|
736
|
+
* @SINCE 1.99.0
|
|
737
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
738
|
+
*
|
|
739
|
+
* Side Content visibility options.
|
|
740
|
+
*/
|
|
741
|
+
export enum SideContentVisibility {
|
|
742
|
+
/**
|
|
743
|
+
* Show the side content on any breakpoint
|
|
744
|
+
*/
|
|
745
|
+
AlwaysShow = "AlwaysShow",
|
|
746
|
+
/**
|
|
747
|
+
* Don't show the side content on any breakpoints
|
|
748
|
+
*/
|
|
749
|
+
NeverShow = "NeverShow",
|
|
750
|
+
/**
|
|
751
|
+
* Show the side content on XL breakpoint
|
|
752
|
+
*/
|
|
753
|
+
ShowAboveL = "ShowAboveL",
|
|
754
|
+
/**
|
|
755
|
+
* Show the side content on L and XL breakpoints
|
|
756
|
+
*/
|
|
757
|
+
ShowAboveM = "ShowAboveM",
|
|
758
|
+
/**
|
|
759
|
+
* Show the side content on M, L and XL breakpoints
|
|
760
|
+
*/
|
|
761
|
+
ShowAboveS = "ShowAboveS",
|
|
762
|
+
}
|
|
365
763
|
/**
|
|
366
764
|
* @SINCE 1.92.0
|
|
367
765
|
* @EXPERIMENTAL (since 1.92.0)
|
|
@@ -410,9 +808,9 @@ declare module "sap/ui/webc/fiori/Bar" {
|
|
|
410
808
|
$WebComponentSettings,
|
|
411
809
|
} from "sap/ui/webc/common/WebComponent";
|
|
412
810
|
|
|
413
|
-
import
|
|
811
|
+
import { IBar, BarDesign } from "sap/ui/webc/fiori/library";
|
|
414
812
|
|
|
415
|
-
import
|
|
813
|
+
import Control from "sap/ui/core/Control";
|
|
416
814
|
|
|
417
815
|
import WebComponentMetadata from "sap/ui/webc/common/WebComponentMetadata";
|
|
418
816
|
|
|
@@ -446,8 +844,11 @@ declare module "sap/ui/webc/fiori/Bar" {
|
|
|
446
844
|
* allow developers to style elements inside the Shadow DOM.
|
|
447
845
|
* The `sap.ui.webc.fiori.Bar` exposes the following CSS Shadow Parts:
|
|
448
846
|
* - bar - Used to style the wrapper of the content of the component
|
|
847
|
+
*
|
|
848
|
+
* Keyboard Handling:
|
|
449
849
|
*/
|
|
450
|
-
export default class Bar extends WebComponent {
|
|
850
|
+
export default class Bar extends WebComponent implements IBar {
|
|
851
|
+
__implements__sap_ui_webc_fiori_IBar: boolean;
|
|
451
852
|
/**
|
|
452
853
|
* Constructor for a new `Bar`.
|
|
453
854
|
*
|
|
@@ -505,22 +906,22 @@ declare module "sap/ui/webc/fiori/Bar" {
|
|
|
505
906
|
*/
|
|
506
907
|
static getMetadata(): WebComponentMetadata;
|
|
507
908
|
/**
|
|
508
|
-
* Adds some
|
|
909
|
+
* Adds some endContent to the aggregation {@link #getEndContent endContent}.
|
|
509
910
|
*/
|
|
510
|
-
|
|
911
|
+
addEndContent(
|
|
511
912
|
/**
|
|
512
|
-
* The
|
|
913
|
+
* The endContent to add; if empty, nothing is inserted
|
|
513
914
|
*/
|
|
514
|
-
|
|
915
|
+
oEndContent: Control
|
|
515
916
|
): this;
|
|
516
917
|
/**
|
|
517
|
-
* Adds some
|
|
918
|
+
* Adds some middleContent to the aggregation {@link #getMiddleContent middleContent}.
|
|
518
919
|
*/
|
|
519
|
-
|
|
920
|
+
addMiddleContent(
|
|
520
921
|
/**
|
|
521
|
-
* The
|
|
922
|
+
* The middleContent to add; if empty, nothing is inserted
|
|
522
923
|
*/
|
|
523
|
-
|
|
924
|
+
oMiddleContent: Control
|
|
524
925
|
): this;
|
|
525
926
|
/**
|
|
526
927
|
* Adds some startContent to the aggregation {@link #getStartContent startContent}.
|
|
@@ -531,24 +932,18 @@ declare module "sap/ui/webc/fiori/Bar" {
|
|
|
531
932
|
*/
|
|
532
933
|
oStartContent: Control
|
|
533
934
|
): this;
|
|
534
|
-
/**
|
|
535
|
-
* Destroys all the content in the aggregation {@link #getContent content}.
|
|
536
|
-
*/
|
|
537
|
-
destroyContent(): this;
|
|
538
935
|
/**
|
|
539
936
|
* Destroys all the endContent in the aggregation {@link #getEndContent endContent}.
|
|
540
937
|
*/
|
|
541
938
|
destroyEndContent(): this;
|
|
542
939
|
/**
|
|
543
|
-
* Destroys all the
|
|
940
|
+
* Destroys all the middleContent in the aggregation {@link #getMiddleContent middleContent}.
|
|
544
941
|
*/
|
|
545
|
-
|
|
942
|
+
destroyMiddleContent(): this;
|
|
546
943
|
/**
|
|
547
|
-
*
|
|
548
|
-
*
|
|
549
|
-
* Defines the content in the middle of the bar
|
|
944
|
+
* Destroys all the startContent in the aggregation {@link #getStartContent startContent}.
|
|
550
945
|
*/
|
|
551
|
-
|
|
946
|
+
destroyStartContent(): this;
|
|
552
947
|
/**
|
|
553
948
|
* Gets current value of property {@link #getDesign design}.
|
|
554
949
|
*
|
|
@@ -571,6 +966,12 @@ declare module "sap/ui/webc/fiori/Bar" {
|
|
|
571
966
|
* Defines the content at the end of the bar
|
|
572
967
|
*/
|
|
573
968
|
getEndContent(): Control[];
|
|
969
|
+
/**
|
|
970
|
+
* Gets content of aggregation {@link #getMiddleContent middleContent}.
|
|
971
|
+
*
|
|
972
|
+
* Defines the content in the middle of the bar
|
|
973
|
+
*/
|
|
974
|
+
getMiddleContent(): Control[];
|
|
574
975
|
/**
|
|
575
976
|
* Gets content of aggregation {@link #getStartContent startContent}.
|
|
576
977
|
*
|
|
@@ -583,16 +984,6 @@ declare module "sap/ui/webc/fiori/Bar" {
|
|
|
583
984
|
* Defines the width of the control
|
|
584
985
|
*/
|
|
585
986
|
getWidth(): CSSSize;
|
|
586
|
-
/**
|
|
587
|
-
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getContent content}. and returns
|
|
588
|
-
* its index if found or -1 otherwise.
|
|
589
|
-
*/
|
|
590
|
-
indexOfContent(
|
|
591
|
-
/**
|
|
592
|
-
* The content whose index is looked for
|
|
593
|
-
*/
|
|
594
|
-
oContent: Control
|
|
595
|
-
): int;
|
|
596
987
|
/**
|
|
597
988
|
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getEndContent endContent}. and
|
|
598
989
|
* returns its index if found or -1 otherwise.
|
|
@@ -603,6 +994,16 @@ declare module "sap/ui/webc/fiori/Bar" {
|
|
|
603
994
|
*/
|
|
604
995
|
oEndContent: Control
|
|
605
996
|
): int;
|
|
997
|
+
/**
|
|
998
|
+
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getMiddleContent middleContent}.
|
|
999
|
+
* and returns its index if found or -1 otherwise.
|
|
1000
|
+
*/
|
|
1001
|
+
indexOfMiddleContent(
|
|
1002
|
+
/**
|
|
1003
|
+
* The middleContent whose index is looked for
|
|
1004
|
+
*/
|
|
1005
|
+
oMiddleContent: Control
|
|
1006
|
+
): int;
|
|
606
1007
|
/**
|
|
607
1008
|
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getStartContent startContent}.
|
|
608
1009
|
* and returns its index if found or -1 otherwise.
|
|
@@ -614,31 +1015,31 @@ declare module "sap/ui/webc/fiori/Bar" {
|
|
|
614
1015
|
oStartContent: Control
|
|
615
1016
|
): int;
|
|
616
1017
|
/**
|
|
617
|
-
* Inserts a
|
|
1018
|
+
* Inserts a endContent into the aggregation {@link #getEndContent endContent}.
|
|
618
1019
|
*/
|
|
619
|
-
|
|
1020
|
+
insertEndContent(
|
|
620
1021
|
/**
|
|
621
|
-
* The
|
|
1022
|
+
* The endContent to insert; if empty, nothing is inserted
|
|
622
1023
|
*/
|
|
623
|
-
|
|
1024
|
+
oEndContent: Control,
|
|
624
1025
|
/**
|
|
625
|
-
* The `0`-based index the
|
|
626
|
-
* is inserted at position 0; for a value greater than the current size of the aggregation, the
|
|
627
|
-
* is inserted at the last position
|
|
1026
|
+
* The `0`-based index the endContent should be inserted at; for a negative value of `iIndex`, the endContent
|
|
1027
|
+
* is inserted at position 0; for a value greater than the current size of the aggregation, the endContent
|
|
1028
|
+
* is inserted at the last position
|
|
628
1029
|
*/
|
|
629
1030
|
iIndex: int
|
|
630
1031
|
): this;
|
|
631
1032
|
/**
|
|
632
|
-
* Inserts a
|
|
1033
|
+
* Inserts a middleContent into the aggregation {@link #getMiddleContent middleContent}.
|
|
633
1034
|
*/
|
|
634
|
-
|
|
1035
|
+
insertMiddleContent(
|
|
635
1036
|
/**
|
|
636
|
-
* The
|
|
1037
|
+
* The middleContent to insert; if empty, nothing is inserted
|
|
637
1038
|
*/
|
|
638
|
-
|
|
1039
|
+
oMiddleContent: Control,
|
|
639
1040
|
/**
|
|
640
|
-
* The `0`-based index the
|
|
641
|
-
* is inserted at position 0; for a value greater than the current size of the aggregation, the
|
|
1041
|
+
* The `0`-based index the middleContent should be inserted at; for a negative value of `iIndex`, the middleContent
|
|
1042
|
+
* is inserted at position 0; for a value greater than the current size of the aggregation, the middleContent
|
|
642
1043
|
* is inserted at the last position
|
|
643
1044
|
*/
|
|
644
1045
|
iIndex: int
|
|
@@ -659,17 +1060,17 @@ declare module "sap/ui/webc/fiori/Bar" {
|
|
|
659
1060
|
iIndex: int
|
|
660
1061
|
): this;
|
|
661
1062
|
/**
|
|
662
|
-
* Removes all the controls from the aggregation {@link #
|
|
1063
|
+
* Removes all the controls from the aggregation {@link #getEndContent endContent}.
|
|
663
1064
|
*
|
|
664
1065
|
* Additionally, it unregisters them from the hosting UIArea.
|
|
665
1066
|
*/
|
|
666
|
-
|
|
1067
|
+
removeAllEndContent(): Control[];
|
|
667
1068
|
/**
|
|
668
|
-
* Removes all the controls from the aggregation {@link #
|
|
1069
|
+
* Removes all the controls from the aggregation {@link #getMiddleContent middleContent}.
|
|
669
1070
|
*
|
|
670
1071
|
* Additionally, it unregisters them from the hosting UIArea.
|
|
671
1072
|
*/
|
|
672
|
-
|
|
1073
|
+
removeAllMiddleContent(): Control[];
|
|
673
1074
|
/**
|
|
674
1075
|
* Removes all the controls from the aggregation {@link #getStartContent startContent}.
|
|
675
1076
|
*
|
|
@@ -677,22 +1078,22 @@ declare module "sap/ui/webc/fiori/Bar" {
|
|
|
677
1078
|
*/
|
|
678
1079
|
removeAllStartContent(): Control[];
|
|
679
1080
|
/**
|
|
680
|
-
* Removes a
|
|
1081
|
+
* Removes a endContent from the aggregation {@link #getEndContent endContent}.
|
|
681
1082
|
*/
|
|
682
|
-
|
|
1083
|
+
removeEndContent(
|
|
683
1084
|
/**
|
|
684
|
-
* The
|
|
1085
|
+
* The endContent to remove or its index or id
|
|
685
1086
|
*/
|
|
686
|
-
|
|
1087
|
+
vEndContent: int | string | Control
|
|
687
1088
|
): Control;
|
|
688
1089
|
/**
|
|
689
|
-
* Removes a
|
|
1090
|
+
* Removes a middleContent from the aggregation {@link #getMiddleContent middleContent}.
|
|
690
1091
|
*/
|
|
691
|
-
|
|
1092
|
+
removeMiddleContent(
|
|
692
1093
|
/**
|
|
693
|
-
* The
|
|
1094
|
+
* The middleContent to remove or its index or id
|
|
694
1095
|
*/
|
|
695
|
-
|
|
1096
|
+
vMiddleContent: int | string | Control
|
|
696
1097
|
): Control;
|
|
697
1098
|
/**
|
|
698
1099
|
* Removes a startContent from the aggregation {@link #getStartContent startContent}.
|
|
@@ -737,7 +1138,7 @@ declare module "sap/ui/webc/fiori/Bar" {
|
|
|
737
1138
|
/**
|
|
738
1139
|
* New value for property `width`
|
|
739
1140
|
*/
|
|
740
|
-
sWidth
|
|
1141
|
+
sWidth: CSSSize
|
|
741
1142
|
): this;
|
|
742
1143
|
}
|
|
743
1144
|
|
|
@@ -761,14 +1162,14 @@ declare module "sap/ui/webc/fiori/Bar" {
|
|
|
761
1162
|
width?: CSSSize | PropertyBindingInfo;
|
|
762
1163
|
|
|
763
1164
|
/**
|
|
764
|
-
* Defines the content
|
|
1165
|
+
* Defines the content at the end of the bar
|
|
765
1166
|
*/
|
|
766
|
-
|
|
1167
|
+
endContent?: Control[] | Control | AggregationBindingInfo;
|
|
767
1168
|
|
|
768
1169
|
/**
|
|
769
|
-
* Defines the content
|
|
1170
|
+
* Defines the content in the middle of the bar
|
|
770
1171
|
*/
|
|
771
|
-
|
|
1172
|
+
middleContent?: Control[] | Control | AggregationBindingInfo;
|
|
772
1173
|
|
|
773
1174
|
/**
|
|
774
1175
|
* Defines the content at the start of the bar
|
|
@@ -1033,33 +1434,92 @@ declare module "sap/ui/webc/fiori/BarcodeScannerDialog" {
|
|
|
1033
1434
|
}
|
|
1034
1435
|
}
|
|
1035
1436
|
|
|
1036
|
-
declare module "sap/ui/webc/fiori/
|
|
1437
|
+
declare module "sap/ui/webc/fiori/DynamicSideContent" {
|
|
1037
1438
|
import {
|
|
1038
1439
|
default as WebComponent,
|
|
1039
1440
|
$WebComponentSettings,
|
|
1040
1441
|
} from "sap/ui/webc/common/WebComponent";
|
|
1041
1442
|
|
|
1042
|
-
import
|
|
1443
|
+
import Control from "sap/ui/core/Control";
|
|
1444
|
+
|
|
1445
|
+
import Event from "sap/ui/base/Event";
|
|
1043
1446
|
|
|
1044
1447
|
import WebComponentMetadata from "sap/ui/webc/common/WebComponentMetadata";
|
|
1045
1448
|
|
|
1449
|
+
import {
|
|
1450
|
+
SideContentFallDown,
|
|
1451
|
+
SideContentPosition,
|
|
1452
|
+
SideContentVisibility,
|
|
1453
|
+
} from "sap/ui/webc/fiori/library";
|
|
1454
|
+
|
|
1046
1455
|
import {
|
|
1047
1456
|
PropertyBindingInfo,
|
|
1048
1457
|
AggregationBindingInfo,
|
|
1049
1458
|
} from "sap/ui/base/ManagedObject";
|
|
1050
1459
|
|
|
1051
1460
|
/**
|
|
1052
|
-
* @SINCE 1.
|
|
1053
|
-
* @EXPERIMENTAL (since 1.
|
|
1461
|
+
* @SINCE 1.99.0
|
|
1462
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
1054
1463
|
*
|
|
1055
1464
|
* Overview:
|
|
1056
1465
|
*
|
|
1466
|
+
* The DynamicSideContent (`sap.ui.webc.fiori.DynamicSideContent`) is a layout component that allows additional
|
|
1467
|
+
* content to be displayed in a way that flexibly adapts to different screen sizes. The side content appears
|
|
1468
|
+
* in a container next to or directly below the main content (it doesn't overlay). When the side content
|
|
1469
|
+
* is triggered, the main content becomes narrower (if appearing side-by-side). The side content contains
|
|
1470
|
+
* a separate scrollbar when appearing next to the main content.
|
|
1471
|
+
*
|
|
1057
1472
|
* Usage:
|
|
1473
|
+
*
|
|
1474
|
+
* When to use?
|
|
1475
|
+
*
|
|
1476
|
+
* Use this component if you want to display relevant information that is not critical for users to complete
|
|
1477
|
+
* a task. Users should have access to all the key functions and critical information in the app even if
|
|
1478
|
+
* they do not see the side content. This is important because on smaller screen sizes it may be difficult
|
|
1479
|
+
* to display the side content in a way that is easily accessible for the user.
|
|
1480
|
+
*
|
|
1481
|
+
* When not to use?
|
|
1482
|
+
*
|
|
1483
|
+
* Don't use it if you want to display navigation or critical information that prevents users from completing
|
|
1484
|
+
* a task when they have no access to the side content.
|
|
1485
|
+
*
|
|
1486
|
+
* Responsive Behavior:
|
|
1487
|
+
*
|
|
1488
|
+
* Screen width > 1440px
|
|
1489
|
+
*
|
|
1490
|
+
*
|
|
1491
|
+
* - Main vs. side content ratio is 75 vs. 25 percent (with a minimum of 320px each).
|
|
1492
|
+
* - If the application defines a trigger, the side content can be hidden.
|
|
1493
|
+
*
|
|
1494
|
+
* Screen width <= 1440px and> 1024px
|
|
1495
|
+
*
|
|
1496
|
+
*
|
|
1497
|
+
* - Main vs. side content ratio is 66.666 vs. 33.333 percent (with a minimum of 320px each). If the side
|
|
1498
|
+
* content width falls below 320 px, it automatically slides under the main content, unless the app development
|
|
1499
|
+
* team specifies that it should disappear.
|
|
1500
|
+
*
|
|
1501
|
+
* Screen width <= 1024px and> 720px
|
|
1502
|
+
*
|
|
1503
|
+
*
|
|
1504
|
+
* - The side content ratio is fixed to 340px, and the main content takes the rest of the width. Only
|
|
1505
|
+
* if the `sideContentFallDown` is set to `OnMinimumWidth` and screen width is <= 960px and> 720px the side
|
|
1506
|
+
* content falls below the main content.
|
|
1507
|
+
*
|
|
1508
|
+
* Screen width <= 720px (for example on a mobile device)
|
|
1509
|
+
* - In this case, the side content automatically disappears from the screen (unless specified to stay
|
|
1510
|
+
* under the content by setting of `sideContentVisibility` property to `AlwaysShow`) and can be triggered
|
|
1511
|
+
* from a pre-set trigger (specified within the app). When the side content is triggered, it replaces the
|
|
1512
|
+
* main content. We recommend that you always place the trigger for the side content in the same location,
|
|
1513
|
+
* such as in the app footer.
|
|
1514
|
+
*
|
|
1515
|
+
* A special case allows switching the comparison mode between the main and side content. In this case,
|
|
1516
|
+
* the screen is split into 50:50 percent for main vs. side content. The responsive behavior of the equal
|
|
1517
|
+
* split is the same as in the standard view - the side content disappears on screen widths of less than
|
|
1518
|
+
* 720 px and can only be viewed by triggering it.
|
|
1058
1519
|
*/
|
|
1059
|
-
export default class
|
|
1060
|
-
__implements__sap_ui_webc_fiori_IFilterItem: boolean;
|
|
1520
|
+
export default class DynamicSideContent extends WebComponent {
|
|
1061
1521
|
/**
|
|
1062
|
-
* Constructor for a new `
|
|
1522
|
+
* Constructor for a new `DynamicSideContent`.
|
|
1063
1523
|
*
|
|
1064
1524
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1065
1525
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
@@ -1069,10 +1529,10 @@ declare module "sap/ui/webc/fiori/FilterItem" {
|
|
|
1069
1529
|
/**
|
|
1070
1530
|
* Initial settings for the new control
|
|
1071
1531
|
*/
|
|
1072
|
-
mSettings?: $
|
|
1532
|
+
mSettings?: $DynamicSideContentSettings
|
|
1073
1533
|
);
|
|
1074
1534
|
/**
|
|
1075
|
-
* Constructor for a new `
|
|
1535
|
+
* Constructor for a new `DynamicSideContent`.
|
|
1076
1536
|
*
|
|
1077
1537
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1078
1538
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
@@ -1086,12 +1546,12 @@ declare module "sap/ui/webc/fiori/FilterItem" {
|
|
|
1086
1546
|
/**
|
|
1087
1547
|
* Initial settings for the new control
|
|
1088
1548
|
*/
|
|
1089
|
-
mSettings?: $
|
|
1549
|
+
mSettings?: $DynamicSideContentSettings
|
|
1090
1550
|
);
|
|
1091
1551
|
|
|
1092
1552
|
/**
|
|
1093
|
-
* Creates a new subclass of class sap.ui.webc.fiori.
|
|
1094
|
-
* the information contained in `oClassInfo`.
|
|
1553
|
+
* Creates a new subclass of class sap.ui.webc.fiori.DynamicSideContent with name `sClassName` and enriches
|
|
1554
|
+
* it with the information contained in `oClassInfo`.
|
|
1095
1555
|
*
|
|
1096
1556
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
|
|
1097
1557
|
*/
|
|
@@ -1103,7 +1563,7 @@ declare module "sap/ui/webc/fiori/FilterItem" {
|
|
|
1103
1563
|
/**
|
|
1104
1564
|
* Object literal with information about the class
|
|
1105
1565
|
*/
|
|
1106
|
-
oClassInfo?: sap.ClassInfo<T,
|
|
1566
|
+
oClassInfo?: sap.ClassInfo<T, DynamicSideContent>,
|
|
1107
1567
|
/**
|
|
1108
1568
|
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
1109
1569
|
* used by this class
|
|
@@ -1111,298 +1571,1749 @@ declare module "sap/ui/webc/fiori/FilterItem" {
|
|
|
1111
1571
|
FNMetaImpl?: Function
|
|
1112
1572
|
): Function;
|
|
1113
1573
|
/**
|
|
1114
|
-
* Returns a metadata object for class sap.ui.webc.fiori.
|
|
1574
|
+
* Returns a metadata object for class sap.ui.webc.fiori.DynamicSideContent.
|
|
1115
1575
|
*/
|
|
1116
1576
|
static getMetadata(): WebComponentMetadata;
|
|
1117
1577
|
/**
|
|
1118
|
-
* Adds some
|
|
1578
|
+
* Adds some content to the aggregation {@link #getContent content}.
|
|
1119
1579
|
*/
|
|
1120
|
-
|
|
1580
|
+
addContent(
|
|
1121
1581
|
/**
|
|
1122
|
-
* The
|
|
1582
|
+
* The content to add; if empty, nothing is inserted
|
|
1123
1583
|
*/
|
|
1124
|
-
|
|
1584
|
+
oContent: Control
|
|
1125
1585
|
): this;
|
|
1126
1586
|
/**
|
|
1127
|
-
*
|
|
1587
|
+
* Adds some sideContent to the aggregation {@link #getSideContent sideContent}.
|
|
1128
1588
|
*/
|
|
1129
|
-
|
|
1589
|
+
addSideContent(
|
|
1590
|
+
/**
|
|
1591
|
+
* The sideContent to add; if empty, nothing is inserted
|
|
1592
|
+
*/
|
|
1593
|
+
oSideContent: Control
|
|
1594
|
+
): this;
|
|
1130
1595
|
/**
|
|
1131
|
-
*
|
|
1132
|
-
*
|
|
1133
|
-
* Defines the text of the component.
|
|
1596
|
+
* Attaches event handler `fnFunction` to the {@link #event:layoutChange layoutChange} event of this `sap.ui.webc.fiori.DynamicSideContent`.
|
|
1134
1597
|
*
|
|
1135
|
-
*
|
|
1136
|
-
|
|
1137
|
-
getText(): string;
|
|
1138
|
-
/**
|
|
1139
|
-
* Gets content of aggregation {@link #getValues values}.
|
|
1598
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
1599
|
+
* otherwise it will be bound to this `sap.ui.webc.fiori.DynamicSideContent` itself.
|
|
1140
1600
|
*
|
|
1141
|
-
*
|
|
1601
|
+
* Fires when the current breakpoint has been changed.
|
|
1142
1602
|
*/
|
|
1143
|
-
|
|
1144
|
-
/**
|
|
1145
|
-
* Checks for the provided `sap.ui.webc.fiori.IFilterItemOption` in the aggregation {@link #getValues values}.
|
|
1146
|
-
* and returns its index if found or -1 otherwise.
|
|
1147
|
-
*/
|
|
1148
|
-
indexOfValue(
|
|
1603
|
+
attachLayoutChange(
|
|
1149
1604
|
/**
|
|
1150
|
-
*
|
|
1605
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
1606
|
+
* object when firing the event
|
|
1151
1607
|
*/
|
|
1152
|
-
|
|
1153
|
-
): int;
|
|
1154
|
-
/**
|
|
1155
|
-
* Inserts a value into the aggregation {@link #getValues values}.
|
|
1156
|
-
*/
|
|
1157
|
-
insertValue(
|
|
1608
|
+
oData: object,
|
|
1158
1609
|
/**
|
|
1159
|
-
* The
|
|
1610
|
+
* The function to be called when the event occurs
|
|
1160
1611
|
*/
|
|
1161
|
-
|
|
1612
|
+
fnFunction: (p1: Event) => void,
|
|
1162
1613
|
/**
|
|
1163
|
-
*
|
|
1164
|
-
*
|
|
1165
|
-
* the last position
|
|
1614
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.DynamicSideContent`
|
|
1615
|
+
* itself
|
|
1166
1616
|
*/
|
|
1167
|
-
|
|
1617
|
+
oListener?: object
|
|
1168
1618
|
): this;
|
|
1169
1619
|
/**
|
|
1170
|
-
*
|
|
1620
|
+
* Attaches event handler `fnFunction` to the {@link #event:layoutChange layoutChange} event of this `sap.ui.webc.fiori.DynamicSideContent`.
|
|
1171
1621
|
*
|
|
1172
|
-
*
|
|
1173
|
-
|
|
1174
|
-
|
|
1175
|
-
|
|
1176
|
-
* Removes a value from the aggregation {@link #getValues values}.
|
|
1622
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
1623
|
+
* otherwise it will be bound to this `sap.ui.webc.fiori.DynamicSideContent` itself.
|
|
1624
|
+
*
|
|
1625
|
+
* Fires when the current breakpoint has been changed.
|
|
1177
1626
|
*/
|
|
1178
|
-
|
|
1627
|
+
attachLayoutChange(
|
|
1179
1628
|
/**
|
|
1180
|
-
* The
|
|
1629
|
+
* The function to be called when the event occurs
|
|
1181
1630
|
*/
|
|
1182
|
-
|
|
1183
|
-
): IFilterItemOption;
|
|
1184
|
-
/**
|
|
1185
|
-
* Sets a new value for property {@link #getText text}.
|
|
1186
|
-
*
|
|
1187
|
-
* Defines the text of the component.
|
|
1188
|
-
*
|
|
1189
|
-
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1190
|
-
*
|
|
1191
|
-
* Default value is `empty string`.
|
|
1192
|
-
*/
|
|
1193
|
-
setText(
|
|
1631
|
+
fnFunction: (p1: Event) => void,
|
|
1194
1632
|
/**
|
|
1195
|
-
*
|
|
1633
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.DynamicSideContent`
|
|
1634
|
+
* itself
|
|
1196
1635
|
*/
|
|
1197
|
-
|
|
1636
|
+
oListener?: object
|
|
1198
1637
|
): this;
|
|
1199
|
-
}
|
|
1200
|
-
|
|
1201
|
-
export interface $FilterItemSettings extends $WebComponentSettings {
|
|
1202
|
-
/**
|
|
1203
|
-
* Defines the text of the component.
|
|
1204
|
-
*/
|
|
1205
|
-
text?: string | PropertyBindingInfo;
|
|
1206
|
-
|
|
1207
1638
|
/**
|
|
1208
|
-
*
|
|
1639
|
+
* Destroys all the content in the aggregation {@link #getContent content}.
|
|
1209
1640
|
*/
|
|
1210
|
-
|
|
1211
|
-
}
|
|
1212
|
-
}
|
|
1213
|
-
|
|
1214
|
-
declare module "sap/ui/webc/fiori/FilterItemOption" {
|
|
1215
|
-
import {
|
|
1216
|
-
default as WebComponent,
|
|
1217
|
-
$WebComponentSettings,
|
|
1218
|
-
} from "sap/ui/webc/common/WebComponent";
|
|
1219
|
-
|
|
1220
|
-
import { IFilterItemOption } from "sap/ui/webc/fiori/library";
|
|
1221
|
-
|
|
1222
|
-
import WebComponentMetadata from "sap/ui/webc/common/WebComponentMetadata";
|
|
1223
|
-
|
|
1224
|
-
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
1225
|
-
|
|
1226
|
-
/**
|
|
1227
|
-
* @SINCE 1.97.0
|
|
1228
|
-
* @EXPERIMENTAL (since 1.97.0)
|
|
1229
|
-
*
|
|
1230
|
-
* Overview:
|
|
1231
|
-
*
|
|
1232
|
-
* Usage:
|
|
1233
|
-
*/
|
|
1234
|
-
export default class FilterItemOption
|
|
1235
|
-
extends WebComponent
|
|
1236
|
-
implements IFilterItemOption {
|
|
1237
|
-
__implements__sap_ui_webc_fiori_IFilterItemOption: boolean;
|
|
1641
|
+
destroyContent(): this;
|
|
1238
1642
|
/**
|
|
1239
|
-
*
|
|
1240
|
-
*
|
|
1241
|
-
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1242
|
-
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
1243
|
-
* of the syntax of the settings object.
|
|
1643
|
+
* Destroys all the sideContent in the aggregation {@link #getSideContent sideContent}.
|
|
1244
1644
|
*/
|
|
1245
|
-
|
|
1246
|
-
/**
|
|
1247
|
-
* Initial settings for the new control
|
|
1248
|
-
*/
|
|
1249
|
-
mSettings?: $FilterItemOptionSettings
|
|
1250
|
-
);
|
|
1645
|
+
destroySideContent(): this;
|
|
1251
1646
|
/**
|
|
1252
|
-
*
|
|
1647
|
+
* Detaches event handler `fnFunction` from the {@link #event:layoutChange layoutChange} event of this `sap.ui.webc.fiori.DynamicSideContent`.
|
|
1253
1648
|
*
|
|
1254
|
-
*
|
|
1255
|
-
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
1256
|
-
* of the syntax of the settings object.
|
|
1649
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
1257
1650
|
*/
|
|
1258
|
-
|
|
1651
|
+
detachLayoutChange(
|
|
1259
1652
|
/**
|
|
1260
|
-
*
|
|
1653
|
+
* The function to be called, when the event occurs
|
|
1261
1654
|
*/
|
|
1262
|
-
|
|
1655
|
+
fnFunction: (p1: Event) => void,
|
|
1263
1656
|
/**
|
|
1264
|
-
*
|
|
1657
|
+
* Context object on which the given function had to be called
|
|
1265
1658
|
*/
|
|
1266
|
-
|
|
1267
|
-
);
|
|
1268
|
-
|
|
1659
|
+
oListener?: object
|
|
1660
|
+
): this;
|
|
1269
1661
|
/**
|
|
1270
|
-
*
|
|
1271
|
-
* it with the information contained in `oClassInfo`.
|
|
1272
|
-
*
|
|
1273
|
-
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
|
|
1662
|
+
* Fires event {@link #event:layoutChange layoutChange} to attached listeners.
|
|
1274
1663
|
*/
|
|
1275
|
-
|
|
1276
|
-
/**
|
|
1277
|
-
* Name of the class being created
|
|
1278
|
-
*/
|
|
1279
|
-
sClassName: string,
|
|
1280
|
-
/**
|
|
1281
|
-
* Object literal with information about the class
|
|
1282
|
-
*/
|
|
1283
|
-
oClassInfo?: sap.ClassInfo<T, FilterItemOption>,
|
|
1664
|
+
fireLayoutChange(
|
|
1284
1665
|
/**
|
|
1285
|
-
*
|
|
1286
|
-
* used by this class
|
|
1666
|
+
* Parameters to pass along with the event
|
|
1287
1667
|
*/
|
|
1288
|
-
|
|
1289
|
-
|
|
1668
|
+
mParameters?: {
|
|
1669
|
+
/**
|
|
1670
|
+
* the current breakpoint.
|
|
1671
|
+
*/
|
|
1672
|
+
currentBreakpoint?: string;
|
|
1673
|
+
/**
|
|
1674
|
+
* the breakpoint that was active before change to current breakpoint.
|
|
1675
|
+
*/
|
|
1676
|
+
previousBreakpoint?: string;
|
|
1677
|
+
/**
|
|
1678
|
+
* visibility of the main content.
|
|
1679
|
+
*/
|
|
1680
|
+
mainContentVisible?: boolean;
|
|
1681
|
+
/**
|
|
1682
|
+
* visibility of the side content.
|
|
1683
|
+
*/
|
|
1684
|
+
sideContentVisible?: boolean;
|
|
1685
|
+
}
|
|
1686
|
+
): this;
|
|
1290
1687
|
/**
|
|
1291
|
-
*
|
|
1688
|
+
* Gets content of aggregation {@link #getContent content}.
|
|
1689
|
+
*
|
|
1690
|
+
* Defines the main content.
|
|
1292
1691
|
*/
|
|
1293
|
-
|
|
1692
|
+
getContent(): Control[];
|
|
1693
|
+
/**
|
|
1694
|
+
* Gets current value of property {@link #getEqualSplit equalSplit}.
|
|
1695
|
+
*
|
|
1696
|
+
* Defines whether the component is in equal split mode. In this mode, the side and the main content take
|
|
1697
|
+
* 50:50 percent of the container on all screen sizes except for phone, where the main and side contents
|
|
1698
|
+
* are switching visibility using the toggle method.
|
|
1699
|
+
*
|
|
1700
|
+
* Default value is `false`.
|
|
1701
|
+
*/
|
|
1702
|
+
getEqualSplit(): boolean;
|
|
1703
|
+
/**
|
|
1704
|
+
* Gets current value of property {@link #getHideMainContent hideMainContent}.
|
|
1705
|
+
*
|
|
1706
|
+
* Defines the visibility of the main content.
|
|
1707
|
+
*
|
|
1708
|
+
* Default value is `false`.
|
|
1709
|
+
*/
|
|
1710
|
+
getHideMainContent(): boolean;
|
|
1711
|
+
/**
|
|
1712
|
+
* Gets current value of property {@link #getHideSideContent hideSideContent}.
|
|
1713
|
+
*
|
|
1714
|
+
* Defines the visibility of the side content.
|
|
1715
|
+
*
|
|
1716
|
+
* Default value is `false`.
|
|
1717
|
+
*/
|
|
1718
|
+
getHideSideContent(): boolean;
|
|
1719
|
+
/**
|
|
1720
|
+
* Gets content of aggregation {@link #getSideContent sideContent}.
|
|
1721
|
+
*
|
|
1722
|
+
* Defines the side content.
|
|
1723
|
+
*/
|
|
1724
|
+
getSideContent(): Control[];
|
|
1725
|
+
/**
|
|
1726
|
+
* Gets current value of property {@link #getSideContentFallDown sideContentFallDown}.
|
|
1727
|
+
*
|
|
1728
|
+
* Defines on which breakpoints the side content falls down below the main content.
|
|
1729
|
+
*
|
|
1730
|
+
*
|
|
1731
|
+
*
|
|
1732
|
+
* **The available values are:**
|
|
1733
|
+
*
|
|
1734
|
+
*
|
|
1735
|
+
* - `BelowXL`
|
|
1736
|
+
* - `BelowL`
|
|
1737
|
+
* - `BelowM`
|
|
1738
|
+
* - `OnMinimumWidth`
|
|
1739
|
+
*
|
|
1740
|
+
* Default value is `OnMinimumWidth`.
|
|
1741
|
+
*/
|
|
1742
|
+
getSideContentFallDown():
|
|
1743
|
+
| SideContentFallDown
|
|
1744
|
+
| keyof typeof SideContentFallDown;
|
|
1745
|
+
/**
|
|
1746
|
+
* Gets current value of property {@link #getSideContentPosition sideContentPosition}.
|
|
1747
|
+
*
|
|
1748
|
+
* Defines whether the side content is positioned before the main content (left side in LTR mode), or after
|
|
1749
|
+
* the the main content (right side in LTR mode).
|
|
1750
|
+
*
|
|
1751
|
+
*
|
|
1752
|
+
*
|
|
1753
|
+
* **The available values are:**
|
|
1754
|
+
*
|
|
1755
|
+
*
|
|
1756
|
+
* - `Start`
|
|
1757
|
+
* - `End`
|
|
1758
|
+
*
|
|
1759
|
+
* Default value is `End`.
|
|
1760
|
+
*/
|
|
1761
|
+
getSideContentPosition():
|
|
1762
|
+
| SideContentPosition
|
|
1763
|
+
| keyof typeof SideContentPosition;
|
|
1764
|
+
/**
|
|
1765
|
+
* Gets current value of property {@link #getSideContentVisibility sideContentVisibility}.
|
|
1766
|
+
*
|
|
1767
|
+
* Defines on which breakpoints the side content is visible.
|
|
1768
|
+
*
|
|
1769
|
+
*
|
|
1770
|
+
*
|
|
1771
|
+
* **The available values are:**
|
|
1772
|
+
*
|
|
1773
|
+
*
|
|
1774
|
+
* - `AlwaysShow`
|
|
1775
|
+
* - `ShowAboveL`
|
|
1776
|
+
* - `ShowAboveM`
|
|
1777
|
+
* - `ShowAboveS`
|
|
1778
|
+
* - `NeverShow`
|
|
1779
|
+
*
|
|
1780
|
+
* Default value is `ShowAboveS`.
|
|
1781
|
+
*/
|
|
1782
|
+
getSideContentVisibility():
|
|
1783
|
+
| SideContentVisibility
|
|
1784
|
+
| keyof typeof SideContentVisibility;
|
|
1785
|
+
/**
|
|
1786
|
+
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getContent content}. and returns
|
|
1787
|
+
* its index if found or -1 otherwise.
|
|
1788
|
+
*/
|
|
1789
|
+
indexOfContent(
|
|
1790
|
+
/**
|
|
1791
|
+
* The content whose index is looked for
|
|
1792
|
+
*/
|
|
1793
|
+
oContent: Control
|
|
1794
|
+
): int;
|
|
1795
|
+
/**
|
|
1796
|
+
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getSideContent sideContent}.
|
|
1797
|
+
* and returns its index if found or -1 otherwise.
|
|
1798
|
+
*/
|
|
1799
|
+
indexOfSideContent(
|
|
1800
|
+
/**
|
|
1801
|
+
* The sideContent whose index is looked for
|
|
1802
|
+
*/
|
|
1803
|
+
oSideContent: Control
|
|
1804
|
+
): int;
|
|
1805
|
+
/**
|
|
1806
|
+
* Inserts a content into the aggregation {@link #getContent content}.
|
|
1807
|
+
*/
|
|
1808
|
+
insertContent(
|
|
1809
|
+
/**
|
|
1810
|
+
* The content to insert; if empty, nothing is inserted
|
|
1811
|
+
*/
|
|
1812
|
+
oContent: Control,
|
|
1813
|
+
/**
|
|
1814
|
+
* The `0`-based index the content should be inserted at; for a negative value of `iIndex`, the content
|
|
1815
|
+
* is inserted at position 0; for a value greater than the current size of the aggregation, the content
|
|
1816
|
+
* is inserted at the last position
|
|
1817
|
+
*/
|
|
1818
|
+
iIndex: int
|
|
1819
|
+
): this;
|
|
1820
|
+
/**
|
|
1821
|
+
* Inserts a sideContent into the aggregation {@link #getSideContent sideContent}.
|
|
1822
|
+
*/
|
|
1823
|
+
insertSideContent(
|
|
1824
|
+
/**
|
|
1825
|
+
* The sideContent to insert; if empty, nothing is inserted
|
|
1826
|
+
*/
|
|
1827
|
+
oSideContent: Control,
|
|
1828
|
+
/**
|
|
1829
|
+
* The `0`-based index the sideContent should be inserted at; for a negative value of `iIndex`, the sideContent
|
|
1830
|
+
* is inserted at position 0; for a value greater than the current size of the aggregation, the sideContent
|
|
1831
|
+
* is inserted at the last position
|
|
1832
|
+
*/
|
|
1833
|
+
iIndex: int
|
|
1834
|
+
): this;
|
|
1835
|
+
/**
|
|
1836
|
+
* Removes all the controls from the aggregation {@link #getContent content}.
|
|
1837
|
+
*
|
|
1838
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
1839
|
+
*/
|
|
1840
|
+
removeAllContent(): Control[];
|
|
1841
|
+
/**
|
|
1842
|
+
* Removes all the controls from the aggregation {@link #getSideContent sideContent}.
|
|
1843
|
+
*
|
|
1844
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
1845
|
+
*/
|
|
1846
|
+
removeAllSideContent(): Control[];
|
|
1847
|
+
/**
|
|
1848
|
+
* Removes a content from the aggregation {@link #getContent content}.
|
|
1849
|
+
*/
|
|
1850
|
+
removeContent(
|
|
1851
|
+
/**
|
|
1852
|
+
* The content to remove or its index or id
|
|
1853
|
+
*/
|
|
1854
|
+
vContent: int | string | Control
|
|
1855
|
+
): Control;
|
|
1856
|
+
/**
|
|
1857
|
+
* Removes a sideContent from the aggregation {@link #getSideContent sideContent}.
|
|
1858
|
+
*/
|
|
1859
|
+
removeSideContent(
|
|
1860
|
+
/**
|
|
1861
|
+
* The sideContent to remove or its index or id
|
|
1862
|
+
*/
|
|
1863
|
+
vSideContent: int | string | Control
|
|
1864
|
+
): Control;
|
|
1865
|
+
/**
|
|
1866
|
+
* Sets a new value for property {@link #getEqualSplit equalSplit}.
|
|
1867
|
+
*
|
|
1868
|
+
* Defines whether the component is in equal split mode. In this mode, the side and the main content take
|
|
1869
|
+
* 50:50 percent of the container on all screen sizes except for phone, where the main and side contents
|
|
1870
|
+
* are switching visibility using the toggle method.
|
|
1871
|
+
*
|
|
1872
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1873
|
+
*
|
|
1874
|
+
* Default value is `false`.
|
|
1875
|
+
*/
|
|
1876
|
+
setEqualSplit(
|
|
1877
|
+
/**
|
|
1878
|
+
* New value for property `equalSplit`
|
|
1879
|
+
*/
|
|
1880
|
+
bEqualSplit?: boolean
|
|
1881
|
+
): this;
|
|
1882
|
+
/**
|
|
1883
|
+
* Sets a new value for property {@link #getHideMainContent hideMainContent}.
|
|
1884
|
+
*
|
|
1885
|
+
* Defines the visibility of the main content.
|
|
1886
|
+
*
|
|
1887
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1888
|
+
*
|
|
1889
|
+
* Default value is `false`.
|
|
1890
|
+
*/
|
|
1891
|
+
setHideMainContent(
|
|
1892
|
+
/**
|
|
1893
|
+
* New value for property `hideMainContent`
|
|
1894
|
+
*/
|
|
1895
|
+
bHideMainContent?: boolean
|
|
1896
|
+
): this;
|
|
1897
|
+
/**
|
|
1898
|
+
* Sets a new value for property {@link #getHideSideContent hideSideContent}.
|
|
1899
|
+
*
|
|
1900
|
+
* Defines the visibility of the side content.
|
|
1901
|
+
*
|
|
1902
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1903
|
+
*
|
|
1904
|
+
* Default value is `false`.
|
|
1905
|
+
*/
|
|
1906
|
+
setHideSideContent(
|
|
1907
|
+
/**
|
|
1908
|
+
* New value for property `hideSideContent`
|
|
1909
|
+
*/
|
|
1910
|
+
bHideSideContent?: boolean
|
|
1911
|
+
): this;
|
|
1912
|
+
/**
|
|
1913
|
+
* Sets a new value for property {@link #getSideContentFallDown sideContentFallDown}.
|
|
1914
|
+
*
|
|
1915
|
+
* Defines on which breakpoints the side content falls down below the main content.
|
|
1916
|
+
*
|
|
1917
|
+
*
|
|
1918
|
+
*
|
|
1919
|
+
* **The available values are:**
|
|
1920
|
+
*
|
|
1921
|
+
*
|
|
1922
|
+
* - `BelowXL`
|
|
1923
|
+
* - `BelowL`
|
|
1924
|
+
* - `BelowM`
|
|
1925
|
+
* - `OnMinimumWidth`
|
|
1926
|
+
*
|
|
1927
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1928
|
+
*
|
|
1929
|
+
* Default value is `OnMinimumWidth`.
|
|
1930
|
+
*/
|
|
1931
|
+
setSideContentFallDown(
|
|
1932
|
+
/**
|
|
1933
|
+
* New value for property `sideContentFallDown`
|
|
1934
|
+
*/
|
|
1935
|
+
sSideContentFallDown?:
|
|
1936
|
+
| SideContentFallDown
|
|
1937
|
+
| keyof typeof SideContentFallDown
|
|
1938
|
+
): this;
|
|
1939
|
+
/**
|
|
1940
|
+
* Sets a new value for property {@link #getSideContentPosition sideContentPosition}.
|
|
1941
|
+
*
|
|
1942
|
+
* Defines whether the side content is positioned before the main content (left side in LTR mode), or after
|
|
1943
|
+
* the the main content (right side in LTR mode).
|
|
1944
|
+
*
|
|
1945
|
+
*
|
|
1946
|
+
*
|
|
1947
|
+
* **The available values are:**
|
|
1948
|
+
*
|
|
1949
|
+
*
|
|
1950
|
+
* - `Start`
|
|
1951
|
+
* - `End`
|
|
1952
|
+
*
|
|
1953
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1954
|
+
*
|
|
1955
|
+
* Default value is `End`.
|
|
1956
|
+
*/
|
|
1957
|
+
setSideContentPosition(
|
|
1958
|
+
/**
|
|
1959
|
+
* New value for property `sideContentPosition`
|
|
1960
|
+
*/
|
|
1961
|
+
sSideContentPosition?:
|
|
1962
|
+
| SideContentPosition
|
|
1963
|
+
| keyof typeof SideContentPosition
|
|
1964
|
+
): this;
|
|
1965
|
+
/**
|
|
1966
|
+
* Sets a new value for property {@link #getSideContentVisibility sideContentVisibility}.
|
|
1967
|
+
*
|
|
1968
|
+
* Defines on which breakpoints the side content is visible.
|
|
1969
|
+
*
|
|
1970
|
+
*
|
|
1971
|
+
*
|
|
1972
|
+
* **The available values are:**
|
|
1973
|
+
*
|
|
1974
|
+
*
|
|
1975
|
+
* - `AlwaysShow`
|
|
1976
|
+
* - `ShowAboveL`
|
|
1977
|
+
* - `ShowAboveM`
|
|
1978
|
+
* - `ShowAboveS`
|
|
1979
|
+
* - `NeverShow`
|
|
1980
|
+
*
|
|
1981
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1982
|
+
*
|
|
1983
|
+
* Default value is `ShowAboveS`.
|
|
1984
|
+
*/
|
|
1985
|
+
setSideContentVisibility(
|
|
1986
|
+
/**
|
|
1987
|
+
* New value for property `sideContentVisibility`
|
|
1988
|
+
*/
|
|
1989
|
+
sSideContentVisibility?:
|
|
1990
|
+
| SideContentVisibility
|
|
1991
|
+
| keyof typeof SideContentVisibility
|
|
1992
|
+
): this;
|
|
1993
|
+
/**
|
|
1994
|
+
* Toggles visibility of main and side contents on S screen size (mobile device).
|
|
1995
|
+
*/
|
|
1996
|
+
toggleContents(): void;
|
|
1997
|
+
}
|
|
1998
|
+
|
|
1999
|
+
export interface $DynamicSideContentSettings extends $WebComponentSettings {
|
|
2000
|
+
/**
|
|
2001
|
+
* Defines whether the component is in equal split mode. In this mode, the side and the main content take
|
|
2002
|
+
* 50:50 percent of the container on all screen sizes except for phone, where the main and side contents
|
|
2003
|
+
* are switching visibility using the toggle method.
|
|
2004
|
+
*/
|
|
2005
|
+
equalSplit?: boolean | PropertyBindingInfo;
|
|
2006
|
+
|
|
2007
|
+
/**
|
|
2008
|
+
* Defines the visibility of the main content.
|
|
2009
|
+
*/
|
|
2010
|
+
hideMainContent?: boolean | PropertyBindingInfo;
|
|
2011
|
+
|
|
2012
|
+
/**
|
|
2013
|
+
* Defines the visibility of the side content.
|
|
2014
|
+
*/
|
|
2015
|
+
hideSideContent?: boolean | PropertyBindingInfo;
|
|
2016
|
+
|
|
2017
|
+
/**
|
|
2018
|
+
* Defines on which breakpoints the side content falls down below the main content.
|
|
2019
|
+
*
|
|
2020
|
+
*
|
|
2021
|
+
*
|
|
2022
|
+
* **The available values are:**
|
|
2023
|
+
*
|
|
2024
|
+
*
|
|
2025
|
+
* - `BelowXL`
|
|
2026
|
+
* - `BelowL`
|
|
2027
|
+
* - `BelowM`
|
|
2028
|
+
* - `OnMinimumWidth`
|
|
2029
|
+
*/
|
|
2030
|
+
sideContentFallDown?:
|
|
2031
|
+
| (SideContentFallDown | keyof typeof SideContentFallDown)
|
|
2032
|
+
| PropertyBindingInfo;
|
|
2033
|
+
|
|
2034
|
+
/**
|
|
2035
|
+
* Defines whether the side content is positioned before the main content (left side in LTR mode), or after
|
|
2036
|
+
* the the main content (right side in LTR mode).
|
|
2037
|
+
*
|
|
2038
|
+
*
|
|
2039
|
+
*
|
|
2040
|
+
* **The available values are:**
|
|
2041
|
+
*
|
|
2042
|
+
*
|
|
2043
|
+
* - `Start`
|
|
2044
|
+
* - `End`
|
|
2045
|
+
*/
|
|
2046
|
+
sideContentPosition?:
|
|
2047
|
+
| (SideContentPosition | keyof typeof SideContentPosition)
|
|
2048
|
+
| PropertyBindingInfo;
|
|
2049
|
+
|
|
2050
|
+
/**
|
|
2051
|
+
* Defines on which breakpoints the side content is visible.
|
|
2052
|
+
*
|
|
2053
|
+
*
|
|
2054
|
+
*
|
|
2055
|
+
* **The available values are:**
|
|
2056
|
+
*
|
|
2057
|
+
*
|
|
2058
|
+
* - `AlwaysShow`
|
|
2059
|
+
* - `ShowAboveL`
|
|
2060
|
+
* - `ShowAboveM`
|
|
2061
|
+
* - `ShowAboveS`
|
|
2062
|
+
* - `NeverShow`
|
|
2063
|
+
*/
|
|
2064
|
+
sideContentVisibility?:
|
|
2065
|
+
| (SideContentVisibility | keyof typeof SideContentVisibility)
|
|
2066
|
+
| PropertyBindingInfo;
|
|
2067
|
+
|
|
2068
|
+
/**
|
|
2069
|
+
* Defines the main content.
|
|
2070
|
+
*/
|
|
2071
|
+
content?: Control[] | Control | AggregationBindingInfo;
|
|
2072
|
+
|
|
2073
|
+
/**
|
|
2074
|
+
* Defines the side content.
|
|
2075
|
+
*/
|
|
2076
|
+
sideContent?: Control[] | Control | AggregationBindingInfo;
|
|
2077
|
+
|
|
2078
|
+
/**
|
|
2079
|
+
* Fires when the current breakpoint has been changed.
|
|
2080
|
+
*/
|
|
2081
|
+
layoutChange?: (oEvent: Event) => void;
|
|
2082
|
+
}
|
|
2083
|
+
}
|
|
2084
|
+
|
|
2085
|
+
declare module "sap/ui/webc/fiori/FilterItem" {
|
|
2086
|
+
import {
|
|
2087
|
+
default as WebComponent,
|
|
2088
|
+
$WebComponentSettings,
|
|
2089
|
+
} from "sap/ui/webc/common/WebComponent";
|
|
2090
|
+
|
|
2091
|
+
import { IFilterItem, IFilterItemOption } from "sap/ui/webc/fiori/library";
|
|
2092
|
+
|
|
2093
|
+
import WebComponentMetadata from "sap/ui/webc/common/WebComponentMetadata";
|
|
2094
|
+
|
|
2095
|
+
import {
|
|
2096
|
+
PropertyBindingInfo,
|
|
2097
|
+
AggregationBindingInfo,
|
|
2098
|
+
} from "sap/ui/base/ManagedObject";
|
|
2099
|
+
|
|
2100
|
+
/**
|
|
2101
|
+
* @SINCE 1.97.0
|
|
2102
|
+
* @EXPERIMENTAL (since 1.97.0)
|
|
2103
|
+
*
|
|
2104
|
+
* Overview:
|
|
2105
|
+
*
|
|
2106
|
+
* Usage:
|
|
2107
|
+
*/
|
|
2108
|
+
export default class FilterItem extends WebComponent implements IFilterItem {
|
|
2109
|
+
__implements__sap_ui_webc_fiori_IFilterItem: boolean;
|
|
2110
|
+
/**
|
|
2111
|
+
* Constructor for a new `FilterItem`.
|
|
2112
|
+
*
|
|
2113
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2114
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
2115
|
+
* of the syntax of the settings object.
|
|
2116
|
+
*/
|
|
2117
|
+
constructor(
|
|
2118
|
+
/**
|
|
2119
|
+
* Initial settings for the new control
|
|
2120
|
+
*/
|
|
2121
|
+
mSettings?: $FilterItemSettings
|
|
2122
|
+
);
|
|
2123
|
+
/**
|
|
2124
|
+
* Constructor for a new `FilterItem`.
|
|
2125
|
+
*
|
|
2126
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2127
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
2128
|
+
* of the syntax of the settings object.
|
|
2129
|
+
*/
|
|
2130
|
+
constructor(
|
|
2131
|
+
/**
|
|
2132
|
+
* ID for the new control, generated automatically if no ID is given
|
|
2133
|
+
*/
|
|
2134
|
+
sId?: string,
|
|
2135
|
+
/**
|
|
2136
|
+
* Initial settings for the new control
|
|
2137
|
+
*/
|
|
2138
|
+
mSettings?: $FilterItemSettings
|
|
2139
|
+
);
|
|
2140
|
+
|
|
2141
|
+
/**
|
|
2142
|
+
* Creates a new subclass of class sap.ui.webc.fiori.FilterItem with name `sClassName` and enriches it with
|
|
2143
|
+
* the information contained in `oClassInfo`.
|
|
2144
|
+
*
|
|
2145
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
|
|
2146
|
+
*/
|
|
2147
|
+
static extend<T extends Record<string, unknown>>(
|
|
2148
|
+
/**
|
|
2149
|
+
* Name of the class being created
|
|
2150
|
+
*/
|
|
2151
|
+
sClassName: string,
|
|
2152
|
+
/**
|
|
2153
|
+
* Object literal with information about the class
|
|
2154
|
+
*/
|
|
2155
|
+
oClassInfo?: sap.ClassInfo<T, FilterItem>,
|
|
2156
|
+
/**
|
|
2157
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
2158
|
+
* used by this class
|
|
2159
|
+
*/
|
|
2160
|
+
FNMetaImpl?: Function
|
|
2161
|
+
): Function;
|
|
2162
|
+
/**
|
|
2163
|
+
* Returns a metadata object for class sap.ui.webc.fiori.FilterItem.
|
|
2164
|
+
*/
|
|
2165
|
+
static getMetadata(): WebComponentMetadata;
|
|
2166
|
+
/**
|
|
2167
|
+
* Adds some value to the aggregation {@link #getValues values}.
|
|
2168
|
+
*/
|
|
2169
|
+
addValue(
|
|
2170
|
+
/**
|
|
2171
|
+
* The value to add; if empty, nothing is inserted
|
|
2172
|
+
*/
|
|
2173
|
+
oValue: IFilterItemOption
|
|
2174
|
+
): this;
|
|
2175
|
+
/**
|
|
2176
|
+
* Destroys all the values in the aggregation {@link #getValues values}.
|
|
2177
|
+
*/
|
|
2178
|
+
destroyValues(): this;
|
|
2179
|
+
/**
|
|
2180
|
+
* Gets current value of property {@link #getText text}.
|
|
2181
|
+
*
|
|
2182
|
+
* Defines the text of the component.
|
|
2183
|
+
*
|
|
2184
|
+
* Default value is `empty string`.
|
|
2185
|
+
*/
|
|
2186
|
+
getText(): string;
|
|
2187
|
+
/**
|
|
2188
|
+
* Gets content of aggregation {@link #getValues values}.
|
|
2189
|
+
*
|
|
2190
|
+
* Defines the `values` list.
|
|
2191
|
+
*/
|
|
2192
|
+
getValues(): IFilterItemOption[];
|
|
2193
|
+
/**
|
|
2194
|
+
* Checks for the provided `sap.ui.webc.fiori.IFilterItemOption` in the aggregation {@link #getValues values}.
|
|
2195
|
+
* and returns its index if found or -1 otherwise.
|
|
2196
|
+
*/
|
|
2197
|
+
indexOfValue(
|
|
2198
|
+
/**
|
|
2199
|
+
* The value whose index is looked for
|
|
2200
|
+
*/
|
|
2201
|
+
oValue: IFilterItemOption
|
|
2202
|
+
): int;
|
|
2203
|
+
/**
|
|
2204
|
+
* Inserts a value into the aggregation {@link #getValues values}.
|
|
2205
|
+
*/
|
|
2206
|
+
insertValue(
|
|
2207
|
+
/**
|
|
2208
|
+
* The value to insert; if empty, nothing is inserted
|
|
2209
|
+
*/
|
|
2210
|
+
oValue: IFilterItemOption,
|
|
2211
|
+
/**
|
|
2212
|
+
* The `0`-based index the value should be inserted at; for a negative value of `iIndex`, the value is inserted
|
|
2213
|
+
* at position 0; for a value greater than the current size of the aggregation, the value is inserted at
|
|
2214
|
+
* the last position
|
|
2215
|
+
*/
|
|
2216
|
+
iIndex: int
|
|
2217
|
+
): this;
|
|
2218
|
+
/**
|
|
2219
|
+
* Removes all the controls from the aggregation {@link #getValues values}.
|
|
2220
|
+
*
|
|
2221
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
2222
|
+
*/
|
|
2223
|
+
removeAllValues(): IFilterItemOption[];
|
|
2224
|
+
/**
|
|
2225
|
+
* Removes a value from the aggregation {@link #getValues values}.
|
|
2226
|
+
*/
|
|
2227
|
+
removeValue(
|
|
2228
|
+
/**
|
|
2229
|
+
* The value to remove or its index or id
|
|
2230
|
+
*/
|
|
2231
|
+
vValue: int | string | IFilterItemOption
|
|
2232
|
+
): IFilterItemOption;
|
|
2233
|
+
/**
|
|
2234
|
+
* Sets a new value for property {@link #getText text}.
|
|
2235
|
+
*
|
|
2236
|
+
* Defines the text of the component.
|
|
2237
|
+
*
|
|
2238
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2239
|
+
*
|
|
2240
|
+
* Default value is `empty string`.
|
|
2241
|
+
*/
|
|
2242
|
+
setText(
|
|
2243
|
+
/**
|
|
2244
|
+
* New value for property `text`
|
|
2245
|
+
*/
|
|
2246
|
+
sText?: string
|
|
2247
|
+
): this;
|
|
2248
|
+
}
|
|
2249
|
+
|
|
2250
|
+
export interface $FilterItemSettings extends $WebComponentSettings {
|
|
2251
|
+
/**
|
|
2252
|
+
* Defines the text of the component.
|
|
2253
|
+
*/
|
|
2254
|
+
text?: string | PropertyBindingInfo;
|
|
2255
|
+
|
|
2256
|
+
/**
|
|
2257
|
+
* Defines the `values` list.
|
|
2258
|
+
*/
|
|
2259
|
+
values?: IFilterItemOption[] | IFilterItemOption | AggregationBindingInfo;
|
|
2260
|
+
}
|
|
2261
|
+
}
|
|
2262
|
+
|
|
2263
|
+
declare module "sap/ui/webc/fiori/FilterItemOption" {
|
|
2264
|
+
import {
|
|
2265
|
+
default as WebComponent,
|
|
2266
|
+
$WebComponentSettings,
|
|
2267
|
+
} from "sap/ui/webc/common/WebComponent";
|
|
2268
|
+
|
|
2269
|
+
import { IFilterItemOption } from "sap/ui/webc/fiori/library";
|
|
2270
|
+
|
|
2271
|
+
import WebComponentMetadata from "sap/ui/webc/common/WebComponentMetadata";
|
|
2272
|
+
|
|
2273
|
+
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
2274
|
+
|
|
2275
|
+
/**
|
|
2276
|
+
* @SINCE 1.97.0
|
|
2277
|
+
* @EXPERIMENTAL (since 1.97.0)
|
|
2278
|
+
*
|
|
2279
|
+
* Overview:
|
|
2280
|
+
*
|
|
2281
|
+
* Usage:
|
|
2282
|
+
*/
|
|
2283
|
+
export default class FilterItemOption
|
|
2284
|
+
extends WebComponent
|
|
2285
|
+
implements IFilterItemOption {
|
|
2286
|
+
__implements__sap_ui_webc_fiori_IFilterItemOption: boolean;
|
|
2287
|
+
/**
|
|
2288
|
+
* Constructor for a new `FilterItemOption`.
|
|
2289
|
+
*
|
|
2290
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2291
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
2292
|
+
* of the syntax of the settings object.
|
|
2293
|
+
*/
|
|
2294
|
+
constructor(
|
|
2295
|
+
/**
|
|
2296
|
+
* Initial settings for the new control
|
|
2297
|
+
*/
|
|
2298
|
+
mSettings?: $FilterItemOptionSettings
|
|
2299
|
+
);
|
|
2300
|
+
/**
|
|
2301
|
+
* Constructor for a new `FilterItemOption`.
|
|
2302
|
+
*
|
|
2303
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2304
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
2305
|
+
* of the syntax of the settings object.
|
|
2306
|
+
*/
|
|
2307
|
+
constructor(
|
|
2308
|
+
/**
|
|
2309
|
+
* ID for the new control, generated automatically if no ID is given
|
|
2310
|
+
*/
|
|
2311
|
+
sId?: string,
|
|
2312
|
+
/**
|
|
2313
|
+
* Initial settings for the new control
|
|
2314
|
+
*/
|
|
2315
|
+
mSettings?: $FilterItemOptionSettings
|
|
2316
|
+
);
|
|
2317
|
+
|
|
2318
|
+
/**
|
|
2319
|
+
* Creates a new subclass of class sap.ui.webc.fiori.FilterItemOption with name `sClassName` and enriches
|
|
2320
|
+
* it with the information contained in `oClassInfo`.
|
|
2321
|
+
*
|
|
2322
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
|
|
2323
|
+
*/
|
|
2324
|
+
static extend<T extends Record<string, unknown>>(
|
|
2325
|
+
/**
|
|
2326
|
+
* Name of the class being created
|
|
2327
|
+
*/
|
|
2328
|
+
sClassName: string,
|
|
2329
|
+
/**
|
|
2330
|
+
* Object literal with information about the class
|
|
2331
|
+
*/
|
|
2332
|
+
oClassInfo?: sap.ClassInfo<T, FilterItemOption>,
|
|
2333
|
+
/**
|
|
2334
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
2335
|
+
* used by this class
|
|
2336
|
+
*/
|
|
2337
|
+
FNMetaImpl?: Function
|
|
2338
|
+
): Function;
|
|
2339
|
+
/**
|
|
2340
|
+
* Returns a metadata object for class sap.ui.webc.fiori.FilterItemOption.
|
|
2341
|
+
*/
|
|
2342
|
+
static getMetadata(): WebComponentMetadata;
|
|
1294
2343
|
/**
|
|
1295
2344
|
* Gets current value of property {@link #getSelected selected}.
|
|
1296
2345
|
*
|
|
1297
|
-
* Defines whether the option is selected
|
|
2346
|
+
* Defines whether the option is selected
|
|
2347
|
+
*
|
|
2348
|
+
* Default value is `false`.
|
|
2349
|
+
*/
|
|
2350
|
+
getSelected(): boolean;
|
|
2351
|
+
/**
|
|
2352
|
+
* Gets current value of property {@link #getText text}.
|
|
2353
|
+
*
|
|
2354
|
+
* Defines the text of the component.
|
|
2355
|
+
*
|
|
2356
|
+
* Default value is `empty string`.
|
|
2357
|
+
*/
|
|
2358
|
+
getText(): string;
|
|
2359
|
+
/**
|
|
2360
|
+
* Sets a new value for property {@link #getSelected selected}.
|
|
2361
|
+
*
|
|
2362
|
+
* Defines whether the option is selected
|
|
2363
|
+
*
|
|
2364
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2365
|
+
*
|
|
2366
|
+
* Default value is `false`.
|
|
2367
|
+
*/
|
|
2368
|
+
setSelected(
|
|
2369
|
+
/**
|
|
2370
|
+
* New value for property `selected`
|
|
2371
|
+
*/
|
|
2372
|
+
bSelected?: boolean
|
|
2373
|
+
): this;
|
|
2374
|
+
/**
|
|
2375
|
+
* Sets a new value for property {@link #getText text}.
|
|
2376
|
+
*
|
|
2377
|
+
* Defines the text of the component.
|
|
2378
|
+
*
|
|
2379
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2380
|
+
*
|
|
2381
|
+
* Default value is `empty string`.
|
|
2382
|
+
*/
|
|
2383
|
+
setText(
|
|
2384
|
+
/**
|
|
2385
|
+
* New value for property `text`
|
|
2386
|
+
*/
|
|
2387
|
+
sText?: string
|
|
2388
|
+
): this;
|
|
2389
|
+
}
|
|
2390
|
+
|
|
2391
|
+
export interface $FilterItemOptionSettings extends $WebComponentSettings {
|
|
2392
|
+
/**
|
|
2393
|
+
* Defines whether the option is selected
|
|
2394
|
+
*/
|
|
2395
|
+
selected?: boolean | PropertyBindingInfo;
|
|
2396
|
+
|
|
2397
|
+
/**
|
|
2398
|
+
* Defines the text of the component.
|
|
2399
|
+
*/
|
|
2400
|
+
text?: string | PropertyBindingInfo;
|
|
2401
|
+
}
|
|
2402
|
+
}
|
|
2403
|
+
|
|
2404
|
+
declare module "sap/ui/webc/fiori/FlexibleColumnLayout" {
|
|
2405
|
+
import {
|
|
2406
|
+
default as WebComponent,
|
|
2407
|
+
$WebComponentSettings,
|
|
2408
|
+
} from "sap/ui/webc/common/WebComponent";
|
|
2409
|
+
|
|
2410
|
+
import Event from "sap/ui/base/Event";
|
|
2411
|
+
|
|
2412
|
+
import Control from "sap/ui/core/Control";
|
|
2413
|
+
|
|
2414
|
+
import { CSSSize } from "sap/ui/core/library";
|
|
2415
|
+
|
|
2416
|
+
import { FCLLayout } from "sap/ui/webc/fiori/library";
|
|
2417
|
+
|
|
2418
|
+
import WebComponentMetadata from "sap/ui/webc/common/WebComponentMetadata";
|
|
2419
|
+
|
|
2420
|
+
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
2421
|
+
|
|
2422
|
+
/**
|
|
2423
|
+
* @SINCE 1.92.0
|
|
2424
|
+
* @EXPERIMENTAL (since 1.92.0)
|
|
2425
|
+
*
|
|
2426
|
+
* Overview:
|
|
2427
|
+
*
|
|
2428
|
+
* The `FlexibleColumnLayout` implements the master-detail-detail paradigm by displaying up to three pages
|
|
2429
|
+
* in separate columns. There are several possible layouts that can be changed either with the component
|
|
2430
|
+
* API, or by pressing the arrows, displayed between the columns.
|
|
2431
|
+
*
|
|
2432
|
+
* Usage:
|
|
2433
|
+
*
|
|
2434
|
+
* Use this component for applications that need to display several logical levels of related information
|
|
2435
|
+
* side by side (e.g. list of items, item, sub-item, etc.). The Component is flexible in a sense that the
|
|
2436
|
+
* application can focus the user's attention on one particular column.
|
|
2437
|
+
*
|
|
2438
|
+
* Responsive Behavior:
|
|
2439
|
+
*
|
|
2440
|
+
* The `FlexibleColumnLayout` automatically displays the maximum possible number of columns based on `layout`
|
|
2441
|
+
* property and the window size. The component would display 1 column for window size smaller than 599px,
|
|
2442
|
+
* up to two columns between 599px and 1023px, and 3 columns for sizes bigger than 1023px.
|
|
2443
|
+
*
|
|
2444
|
+
*
|
|
2445
|
+
*
|
|
2446
|
+
* Keyboard Handling:
|
|
2447
|
+
*/
|
|
2448
|
+
export default class FlexibleColumnLayout extends WebComponent {
|
|
2449
|
+
/**
|
|
2450
|
+
* Constructor for a new `FlexibleColumnLayout`.
|
|
2451
|
+
*
|
|
2452
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2453
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
2454
|
+
* of the syntax of the settings object.
|
|
2455
|
+
*/
|
|
2456
|
+
constructor(
|
|
2457
|
+
/**
|
|
2458
|
+
* Initial settings for the new control
|
|
2459
|
+
*/
|
|
2460
|
+
mSettings?: $FlexibleColumnLayoutSettings
|
|
2461
|
+
);
|
|
2462
|
+
/**
|
|
2463
|
+
* Constructor for a new `FlexibleColumnLayout`.
|
|
2464
|
+
*
|
|
2465
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2466
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
2467
|
+
* of the syntax of the settings object.
|
|
2468
|
+
*/
|
|
2469
|
+
constructor(
|
|
2470
|
+
/**
|
|
2471
|
+
* ID for the new control, generated automatically if no ID is given
|
|
2472
|
+
*/
|
|
2473
|
+
sId?: string,
|
|
2474
|
+
/**
|
|
2475
|
+
* Initial settings for the new control
|
|
2476
|
+
*/
|
|
2477
|
+
mSettings?: $FlexibleColumnLayoutSettings
|
|
2478
|
+
);
|
|
2479
|
+
|
|
2480
|
+
/**
|
|
2481
|
+
* Creates a new subclass of class sap.ui.webc.fiori.FlexibleColumnLayout with name `sClassName` and enriches
|
|
2482
|
+
* it with the information contained in `oClassInfo`.
|
|
2483
|
+
*
|
|
2484
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
|
|
2485
|
+
*/
|
|
2486
|
+
static extend<T extends Record<string, unknown>>(
|
|
2487
|
+
/**
|
|
2488
|
+
* Name of the class being created
|
|
2489
|
+
*/
|
|
2490
|
+
sClassName: string,
|
|
2491
|
+
/**
|
|
2492
|
+
* Object literal with information about the class
|
|
2493
|
+
*/
|
|
2494
|
+
oClassInfo?: sap.ClassInfo<T, FlexibleColumnLayout>,
|
|
2495
|
+
/**
|
|
2496
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
2497
|
+
* used by this class
|
|
2498
|
+
*/
|
|
2499
|
+
FNMetaImpl?: Function
|
|
2500
|
+
): Function;
|
|
2501
|
+
/**
|
|
2502
|
+
* Returns a metadata object for class sap.ui.webc.fiori.FlexibleColumnLayout.
|
|
2503
|
+
*/
|
|
2504
|
+
static getMetadata(): WebComponentMetadata;
|
|
2505
|
+
/**
|
|
2506
|
+
* Attaches event handler `fnFunction` to the {@link #event:layoutChange layoutChange} event of this `sap.ui.webc.fiori.FlexibleColumnLayout`.
|
|
2507
|
+
*
|
|
2508
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
2509
|
+
* otherwise it will be bound to this `sap.ui.webc.fiori.FlexibleColumnLayout` itself.
|
|
2510
|
+
*
|
|
2511
|
+
* Fired when the layout changes via user interaction by clicking the arrows or by changing the component
|
|
2512
|
+
* size due to resizing.
|
|
2513
|
+
*/
|
|
2514
|
+
attachLayoutChange(
|
|
2515
|
+
/**
|
|
2516
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
2517
|
+
* object when firing the event
|
|
2518
|
+
*/
|
|
2519
|
+
oData: object,
|
|
2520
|
+
/**
|
|
2521
|
+
* The function to be called when the event occurs
|
|
2522
|
+
*/
|
|
2523
|
+
fnFunction: (p1: Event) => void,
|
|
2524
|
+
/**
|
|
2525
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.FlexibleColumnLayout`
|
|
2526
|
+
* itself
|
|
2527
|
+
*/
|
|
2528
|
+
oListener?: object
|
|
2529
|
+
): this;
|
|
2530
|
+
/**
|
|
2531
|
+
* Attaches event handler `fnFunction` to the {@link #event:layoutChange layoutChange} event of this `sap.ui.webc.fiori.FlexibleColumnLayout`.
|
|
2532
|
+
*
|
|
2533
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
2534
|
+
* otherwise it will be bound to this `sap.ui.webc.fiori.FlexibleColumnLayout` itself.
|
|
2535
|
+
*
|
|
2536
|
+
* Fired when the layout changes via user interaction by clicking the arrows or by changing the component
|
|
2537
|
+
* size due to resizing.
|
|
2538
|
+
*/
|
|
2539
|
+
attachLayoutChange(
|
|
2540
|
+
/**
|
|
2541
|
+
* The function to be called when the event occurs
|
|
2542
|
+
*/
|
|
2543
|
+
fnFunction: (p1: Event) => void,
|
|
2544
|
+
/**
|
|
2545
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.FlexibleColumnLayout`
|
|
2546
|
+
* itself
|
|
2547
|
+
*/
|
|
2548
|
+
oListener?: object
|
|
2549
|
+
): this;
|
|
2550
|
+
/**
|
|
2551
|
+
* Destroys the endColumn in the aggregation {@link #getEndColumn endColumn}.
|
|
2552
|
+
*/
|
|
2553
|
+
destroyEndColumn(): this;
|
|
2554
|
+
/**
|
|
2555
|
+
* Destroys the midColumn in the aggregation {@link #getMidColumn midColumn}.
|
|
2556
|
+
*/
|
|
2557
|
+
destroyMidColumn(): this;
|
|
2558
|
+
/**
|
|
2559
|
+
* Destroys the startColumn in the aggregation {@link #getStartColumn startColumn}.
|
|
2560
|
+
*/
|
|
2561
|
+
destroyStartColumn(): this;
|
|
2562
|
+
/**
|
|
2563
|
+
* Detaches event handler `fnFunction` from the {@link #event:layoutChange layoutChange} event of this `sap.ui.webc.fiori.FlexibleColumnLayout`.
|
|
2564
|
+
*
|
|
2565
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
2566
|
+
*/
|
|
2567
|
+
detachLayoutChange(
|
|
2568
|
+
/**
|
|
2569
|
+
* The function to be called, when the event occurs
|
|
2570
|
+
*/
|
|
2571
|
+
fnFunction: (p1: Event) => void,
|
|
2572
|
+
/**
|
|
2573
|
+
* Context object on which the given function had to be called
|
|
2574
|
+
*/
|
|
2575
|
+
oListener?: object
|
|
2576
|
+
): this;
|
|
2577
|
+
/**
|
|
2578
|
+
* Fires event {@link #event:layoutChange layoutChange} to attached listeners.
|
|
2579
|
+
*/
|
|
2580
|
+
fireLayoutChange(
|
|
2581
|
+
/**
|
|
2582
|
+
* Parameters to pass along with the event
|
|
2583
|
+
*/
|
|
2584
|
+
mParameters?: {
|
|
2585
|
+
/**
|
|
2586
|
+
* The current layout
|
|
2587
|
+
*/
|
|
2588
|
+
layout?: FCLLayout;
|
|
2589
|
+
/**
|
|
2590
|
+
* The effective column layout, f.e [67%, 33%, 0]
|
|
2591
|
+
*/
|
|
2592
|
+
columnLayout?: any[];
|
|
2593
|
+
/**
|
|
2594
|
+
* Indicates if the start column is currently visible
|
|
2595
|
+
*/
|
|
2596
|
+
startColumnVisible?: boolean;
|
|
2597
|
+
/**
|
|
2598
|
+
* Indicates if the middle column is currently visible
|
|
2599
|
+
*/
|
|
2600
|
+
midColumnVisible?: boolean;
|
|
2601
|
+
/**
|
|
2602
|
+
* Indicates if the end column is currently visible
|
|
2603
|
+
*/
|
|
2604
|
+
endColumnVisible?: boolean;
|
|
2605
|
+
/**
|
|
2606
|
+
* Indicates if the layout is changed via the arrows
|
|
2607
|
+
*/
|
|
2608
|
+
arrowsUsed?: boolean;
|
|
2609
|
+
/**
|
|
2610
|
+
* Indicates if the layout is changed via resizing
|
|
2611
|
+
*/
|
|
2612
|
+
resize?: boolean;
|
|
2613
|
+
}
|
|
2614
|
+
): this;
|
|
2615
|
+
/**
|
|
2616
|
+
* Gets current value of property {@link #getAccessibilityRoles accessibilityRoles}.
|
|
2617
|
+
*
|
|
2618
|
+
* An object of strings that defines additional accessibility roles for further customization.
|
|
2619
|
+
*
|
|
2620
|
+
* It supports the following fields: - `startColumnRole`: the accessibility role for the `startColumn` -
|
|
2621
|
+
* `startArrowContainerRole`: the accessibility role for the first arrow container (between the `begin`
|
|
2622
|
+
* and `mid` columns) - `midColumnRole`: the accessibility role for the `midColumn` - `endArrowContainerRole`:
|
|
2623
|
+
* the accessibility role for the second arrow container (between the `mid` and `end` columns) - `endColumnRole`:
|
|
2624
|
+
* the accessibility role for the `endColumn`
|
|
2625
|
+
*
|
|
2626
|
+
* Default value is `{}`.
|
|
2627
|
+
*/
|
|
2628
|
+
getAccessibilityRoles(): object;
|
|
2629
|
+
/**
|
|
2630
|
+
* Gets current value of property {@link #getAccessibilityTexts accessibilityTexts}.
|
|
2631
|
+
*
|
|
2632
|
+
* An object of strings that defines several additional accessibility texts for even further customization.
|
|
2633
|
+
*
|
|
2634
|
+
* It supports the following fields: - `startColumnAccessibleName`: the accessibility name for the `startColumn`
|
|
2635
|
+
* region - `midColumnAccessibleName`: the accessibility name for the `midColumn` region - `endColumnAccessibleName`:
|
|
2636
|
+
* the accessibility name for the `endColumn` region - `startArrowLeftText`: the text that the first arrow
|
|
2637
|
+
* (between the `begin` and `mid` columns) will have when pointing to the left - `startArrowRightText`:
|
|
2638
|
+
* the text that the first arrow (between the `begin` and `mid` columns) will have when pointing to the
|
|
2639
|
+
* right - `endArrowLeftText`: the text that the second arrow (between the `mid` and `end` columns) will
|
|
2640
|
+
* have when pointing to the left - `endArrowRightText`: the text that the second arrow (between the `mid`
|
|
2641
|
+
* and `end` columns) will have when pointing to the right - `startArrowContainerAccessibleName`: the text
|
|
2642
|
+
* that the first arrow container (between the `begin` and `mid` columns) will have as `aria-label` - `endArrowContainerAccessibleName`:
|
|
2643
|
+
* the text that the second arrow container (between the `mid` and `end` columns) will have as `aria-label`
|
|
2644
|
+
*
|
|
2645
|
+
* Default value is `{}`.
|
|
2646
|
+
*/
|
|
2647
|
+
getAccessibilityTexts(): object;
|
|
2648
|
+
/**
|
|
2649
|
+
* Returns the current column layout, based on both the `layout` property and the screen size.
|
|
2650
|
+
*
|
|
2651
|
+
* **For example:** ["67%", "33%", 0], ["100%", 0, 0], ["25%", "50%", "25%"], etc, where the numbers represents
|
|
2652
|
+
* the width of the start, middle and end columns.
|
|
2653
|
+
*/
|
|
2654
|
+
getColumnLayout(): void;
|
|
2655
|
+
/**
|
|
2656
|
+
* Gets content of aggregation {@link #getEndColumn endColumn}.
|
|
2657
|
+
*
|
|
2658
|
+
* Defines the content in the end column.
|
|
2659
|
+
*/
|
|
2660
|
+
getEndColumn(): Control;
|
|
2661
|
+
/**
|
|
2662
|
+
* Returns if the `end` column is visible.
|
|
2663
|
+
*/
|
|
2664
|
+
getEndColumnVisible(): void;
|
|
2665
|
+
/**
|
|
2666
|
+
* Gets current value of property {@link #getHeight height}.
|
|
2667
|
+
*
|
|
2668
|
+
* Defines the height of the control
|
|
2669
|
+
*/
|
|
2670
|
+
getHeight(): CSSSize;
|
|
2671
|
+
/**
|
|
2672
|
+
* Gets current value of property {@link #getHideArrows hideArrows}.
|
|
2673
|
+
*
|
|
2674
|
+
* Defines the visibility of the arrows, used for expanding and shrinking the columns.
|
|
2675
|
+
*
|
|
2676
|
+
* Default value is `false`.
|
|
2677
|
+
*/
|
|
2678
|
+
getHideArrows(): boolean;
|
|
2679
|
+
/**
|
|
2680
|
+
* Gets current value of property {@link #getLayout layout}.
|
|
2681
|
+
*
|
|
2682
|
+
* Defines the columns layout and their proportion.
|
|
2683
|
+
*
|
|
2684
|
+
* **Note:** The layout also depends on the screen size - one column for screens smaller than 599px, two
|
|
2685
|
+
* columns between 599px and 1023px and three columns for sizes bigger than 1023px.
|
|
2686
|
+
*
|
|
2687
|
+
* Available options are:
|
|
2688
|
+
* - `OneColumn`
|
|
2689
|
+
* - `TwoColumnsStartExpanded`
|
|
2690
|
+
* - `TwoColumnsMidExpanded`
|
|
2691
|
+
* - `ThreeColumnsMidExpanded`
|
|
2692
|
+
* - `ThreeColumnsEndExpanded`
|
|
2693
|
+
* - `ThreeColumnsStartExpandedEndHidden`
|
|
2694
|
+
* - `ThreeColumnsMidExpandedEndHidden`
|
|
2695
|
+
* - `MidColumnFullScreen`
|
|
2696
|
+
* - `EndColumnFullScreen`
|
|
2697
|
+
*
|
|
2698
|
+
* **For example:** layout=`TwoColumnsStartExpanded` means the layout will display up to two columns in
|
|
2699
|
+
* 67%/33% proportion.
|
|
2700
|
+
*
|
|
2701
|
+
* Default value is `OneColumn`.
|
|
2702
|
+
*/
|
|
2703
|
+
getLayout(): FCLLayout | keyof typeof FCLLayout;
|
|
2704
|
+
/**
|
|
2705
|
+
* Gets content of aggregation {@link #getMidColumn midColumn}.
|
|
2706
|
+
*
|
|
2707
|
+
* Defines the content in the middle column.
|
|
2708
|
+
*/
|
|
2709
|
+
getMidColumn(): Control;
|
|
2710
|
+
/**
|
|
2711
|
+
* Returns if the `middle` column is visible.
|
|
2712
|
+
*/
|
|
2713
|
+
getMidColumnVisible(): void;
|
|
2714
|
+
/**
|
|
2715
|
+
* Gets content of aggregation {@link #getStartColumn startColumn}.
|
|
2716
|
+
*
|
|
2717
|
+
* Defines the content in the start column.
|
|
2718
|
+
*/
|
|
2719
|
+
getStartColumn(): Control;
|
|
2720
|
+
/**
|
|
2721
|
+
* Returns if the `start` column is visible.
|
|
2722
|
+
*/
|
|
2723
|
+
getStartColumnVisible(): void;
|
|
2724
|
+
/**
|
|
2725
|
+
* Returns the number of currently visible columns.
|
|
2726
|
+
*/
|
|
2727
|
+
getVisibleColumns(): void;
|
|
2728
|
+
/**
|
|
2729
|
+
* Gets current value of property {@link #getWidth width}.
|
|
2730
|
+
*
|
|
2731
|
+
* Defines the width of the control
|
|
2732
|
+
*/
|
|
2733
|
+
getWidth(): CSSSize;
|
|
2734
|
+
/**
|
|
2735
|
+
* Sets a new value for property {@link #getAccessibilityRoles accessibilityRoles}.
|
|
2736
|
+
*
|
|
2737
|
+
* An object of strings that defines additional accessibility roles for further customization.
|
|
2738
|
+
*
|
|
2739
|
+
* It supports the following fields: - `startColumnRole`: the accessibility role for the `startColumn` -
|
|
2740
|
+
* `startArrowContainerRole`: the accessibility role for the first arrow container (between the `begin`
|
|
2741
|
+
* and `mid` columns) - `midColumnRole`: the accessibility role for the `midColumn` - `endArrowContainerRole`:
|
|
2742
|
+
* the accessibility role for the second arrow container (between the `mid` and `end` columns) - `endColumnRole`:
|
|
2743
|
+
* the accessibility role for the `endColumn`
|
|
2744
|
+
*
|
|
2745
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2746
|
+
*
|
|
2747
|
+
* Default value is `{}`.
|
|
2748
|
+
*/
|
|
2749
|
+
setAccessibilityRoles(
|
|
2750
|
+
/**
|
|
2751
|
+
* New value for property `accessibilityRoles`
|
|
2752
|
+
*/
|
|
2753
|
+
oAccessibilityRoles?: object
|
|
2754
|
+
): this;
|
|
2755
|
+
/**
|
|
2756
|
+
* Sets a new value for property {@link #getAccessibilityTexts accessibilityTexts}.
|
|
2757
|
+
*
|
|
2758
|
+
* An object of strings that defines several additional accessibility texts for even further customization.
|
|
2759
|
+
*
|
|
2760
|
+
* It supports the following fields: - `startColumnAccessibleName`: the accessibility name for the `startColumn`
|
|
2761
|
+
* region - `midColumnAccessibleName`: the accessibility name for the `midColumn` region - `endColumnAccessibleName`:
|
|
2762
|
+
* the accessibility name for the `endColumn` region - `startArrowLeftText`: the text that the first arrow
|
|
2763
|
+
* (between the `begin` and `mid` columns) will have when pointing to the left - `startArrowRightText`:
|
|
2764
|
+
* the text that the first arrow (between the `begin` and `mid` columns) will have when pointing to the
|
|
2765
|
+
* right - `endArrowLeftText`: the text that the second arrow (between the `mid` and `end` columns) will
|
|
2766
|
+
* have when pointing to the left - `endArrowRightText`: the text that the second arrow (between the `mid`
|
|
2767
|
+
* and `end` columns) will have when pointing to the right - `startArrowContainerAccessibleName`: the text
|
|
2768
|
+
* that the first arrow container (between the `begin` and `mid` columns) will have as `aria-label` - `endArrowContainerAccessibleName`:
|
|
2769
|
+
* the text that the second arrow container (between the `mid` and `end` columns) will have as `aria-label`
|
|
2770
|
+
*
|
|
2771
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2772
|
+
*
|
|
2773
|
+
* Default value is `{}`.
|
|
2774
|
+
*/
|
|
2775
|
+
setAccessibilityTexts(
|
|
2776
|
+
/**
|
|
2777
|
+
* New value for property `accessibilityTexts`
|
|
2778
|
+
*/
|
|
2779
|
+
oAccessibilityTexts?: object
|
|
2780
|
+
): this;
|
|
2781
|
+
/**
|
|
2782
|
+
* Sets the aggregated {@link #getEndColumn endColumn}.
|
|
2783
|
+
*/
|
|
2784
|
+
setEndColumn(
|
|
2785
|
+
/**
|
|
2786
|
+
* The endColumn to set
|
|
2787
|
+
*/
|
|
2788
|
+
oEndColumn: Control
|
|
2789
|
+
): this;
|
|
2790
|
+
/**
|
|
2791
|
+
* Sets a new value for property {@link #getHeight height}.
|
|
2792
|
+
*
|
|
2793
|
+
* Defines the height of the control
|
|
2794
|
+
*
|
|
2795
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2796
|
+
*/
|
|
2797
|
+
setHeight(
|
|
2798
|
+
/**
|
|
2799
|
+
* New value for property `height`
|
|
2800
|
+
*/
|
|
2801
|
+
sHeight: CSSSize
|
|
2802
|
+
): this;
|
|
2803
|
+
/**
|
|
2804
|
+
* Sets a new value for property {@link #getHideArrows hideArrows}.
|
|
2805
|
+
*
|
|
2806
|
+
* Defines the visibility of the arrows, used for expanding and shrinking the columns.
|
|
2807
|
+
*
|
|
2808
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2809
|
+
*
|
|
2810
|
+
* Default value is `false`.
|
|
2811
|
+
*/
|
|
2812
|
+
setHideArrows(
|
|
2813
|
+
/**
|
|
2814
|
+
* New value for property `hideArrows`
|
|
2815
|
+
*/
|
|
2816
|
+
bHideArrows?: boolean
|
|
2817
|
+
): this;
|
|
2818
|
+
/**
|
|
2819
|
+
* Sets a new value for property {@link #getLayout layout}.
|
|
2820
|
+
*
|
|
2821
|
+
* Defines the columns layout and their proportion.
|
|
2822
|
+
*
|
|
2823
|
+
* **Note:** The layout also depends on the screen size - one column for screens smaller than 599px, two
|
|
2824
|
+
* columns between 599px and 1023px and three columns for sizes bigger than 1023px.
|
|
2825
|
+
*
|
|
2826
|
+
* Available options are:
|
|
2827
|
+
* - `OneColumn`
|
|
2828
|
+
* - `TwoColumnsStartExpanded`
|
|
2829
|
+
* - `TwoColumnsMidExpanded`
|
|
2830
|
+
* - `ThreeColumnsMidExpanded`
|
|
2831
|
+
* - `ThreeColumnsEndExpanded`
|
|
2832
|
+
* - `ThreeColumnsStartExpandedEndHidden`
|
|
2833
|
+
* - `ThreeColumnsMidExpandedEndHidden`
|
|
2834
|
+
* - `MidColumnFullScreen`
|
|
2835
|
+
* - `EndColumnFullScreen`
|
|
2836
|
+
*
|
|
2837
|
+
* **For example:** layout=`TwoColumnsStartExpanded` means the layout will display up to two columns in
|
|
2838
|
+
* 67%/33% proportion.
|
|
2839
|
+
*
|
|
2840
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2841
|
+
*
|
|
2842
|
+
* Default value is `OneColumn`.
|
|
2843
|
+
*/
|
|
2844
|
+
setLayout(
|
|
2845
|
+
/**
|
|
2846
|
+
* New value for property `layout`
|
|
2847
|
+
*/
|
|
2848
|
+
sLayout?: FCLLayout | keyof typeof FCLLayout
|
|
2849
|
+
): this;
|
|
2850
|
+
/**
|
|
2851
|
+
* Sets the aggregated {@link #getMidColumn midColumn}.
|
|
2852
|
+
*/
|
|
2853
|
+
setMidColumn(
|
|
2854
|
+
/**
|
|
2855
|
+
* The midColumn to set
|
|
2856
|
+
*/
|
|
2857
|
+
oMidColumn: Control
|
|
2858
|
+
): this;
|
|
2859
|
+
/**
|
|
2860
|
+
* Sets the aggregated {@link #getStartColumn startColumn}.
|
|
2861
|
+
*/
|
|
2862
|
+
setStartColumn(
|
|
2863
|
+
/**
|
|
2864
|
+
* The startColumn to set
|
|
2865
|
+
*/
|
|
2866
|
+
oStartColumn: Control
|
|
2867
|
+
): this;
|
|
2868
|
+
/**
|
|
2869
|
+
* Sets a new value for property {@link #getWidth width}.
|
|
2870
|
+
*
|
|
2871
|
+
* Defines the width of the control
|
|
2872
|
+
*
|
|
2873
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2874
|
+
*/
|
|
2875
|
+
setWidth(
|
|
2876
|
+
/**
|
|
2877
|
+
* New value for property `width`
|
|
2878
|
+
*/
|
|
2879
|
+
sWidth: CSSSize
|
|
2880
|
+
): this;
|
|
2881
|
+
}
|
|
2882
|
+
|
|
2883
|
+
export interface $FlexibleColumnLayoutSettings extends $WebComponentSettings {
|
|
2884
|
+
/**
|
|
2885
|
+
* An object of strings that defines additional accessibility roles for further customization.
|
|
2886
|
+
*
|
|
2887
|
+
* It supports the following fields: - `startColumnRole`: the accessibility role for the `startColumn` -
|
|
2888
|
+
* `startArrowContainerRole`: the accessibility role for the first arrow container (between the `begin`
|
|
2889
|
+
* and `mid` columns) - `midColumnRole`: the accessibility role for the `midColumn` - `endArrowContainerRole`:
|
|
2890
|
+
* the accessibility role for the second arrow container (between the `mid` and `end` columns) - `endColumnRole`:
|
|
2891
|
+
* the accessibility role for the `endColumn`
|
|
2892
|
+
*/
|
|
2893
|
+
accessibilityRoles?: object | PropertyBindingInfo;
|
|
2894
|
+
|
|
2895
|
+
/**
|
|
2896
|
+
* An object of strings that defines several additional accessibility texts for even further customization.
|
|
2897
|
+
*
|
|
2898
|
+
* It supports the following fields: - `startColumnAccessibleName`: the accessibility name for the `startColumn`
|
|
2899
|
+
* region - `midColumnAccessibleName`: the accessibility name for the `midColumn` region - `endColumnAccessibleName`:
|
|
2900
|
+
* the accessibility name for the `endColumn` region - `startArrowLeftText`: the text that the first arrow
|
|
2901
|
+
* (between the `begin` and `mid` columns) will have when pointing to the left - `startArrowRightText`:
|
|
2902
|
+
* the text that the first arrow (between the `begin` and `mid` columns) will have when pointing to the
|
|
2903
|
+
* right - `endArrowLeftText`: the text that the second arrow (between the `mid` and `end` columns) will
|
|
2904
|
+
* have when pointing to the left - `endArrowRightText`: the text that the second arrow (between the `mid`
|
|
2905
|
+
* and `end` columns) will have when pointing to the right - `startArrowContainerAccessibleName`: the text
|
|
2906
|
+
* that the first arrow container (between the `begin` and `mid` columns) will have as `aria-label` - `endArrowContainerAccessibleName`:
|
|
2907
|
+
* the text that the second arrow container (between the `mid` and `end` columns) will have as `aria-label`
|
|
2908
|
+
*/
|
|
2909
|
+
accessibilityTexts?: object | PropertyBindingInfo;
|
|
2910
|
+
|
|
2911
|
+
/**
|
|
2912
|
+
* Defines the height of the control
|
|
2913
|
+
*/
|
|
2914
|
+
height?: CSSSize | PropertyBindingInfo;
|
|
2915
|
+
|
|
2916
|
+
/**
|
|
2917
|
+
* Defines the visibility of the arrows, used for expanding and shrinking the columns.
|
|
2918
|
+
*/
|
|
2919
|
+
hideArrows?: boolean | PropertyBindingInfo;
|
|
2920
|
+
|
|
2921
|
+
/**
|
|
2922
|
+
* Defines the columns layout and their proportion.
|
|
2923
|
+
*
|
|
2924
|
+
* **Note:** The layout also depends on the screen size - one column for screens smaller than 599px, two
|
|
2925
|
+
* columns between 599px and 1023px and three columns for sizes bigger than 1023px.
|
|
2926
|
+
*
|
|
2927
|
+
* Available options are:
|
|
2928
|
+
* - `OneColumn`
|
|
2929
|
+
* - `TwoColumnsStartExpanded`
|
|
2930
|
+
* - `TwoColumnsMidExpanded`
|
|
2931
|
+
* - `ThreeColumnsMidExpanded`
|
|
2932
|
+
* - `ThreeColumnsEndExpanded`
|
|
2933
|
+
* - `ThreeColumnsStartExpandedEndHidden`
|
|
2934
|
+
* - `ThreeColumnsMidExpandedEndHidden`
|
|
2935
|
+
* - `MidColumnFullScreen`
|
|
2936
|
+
* - `EndColumnFullScreen`
|
|
2937
|
+
*
|
|
2938
|
+
* **For example:** layout=`TwoColumnsStartExpanded` means the layout will display up to two columns in
|
|
2939
|
+
* 67%/33% proportion.
|
|
2940
|
+
*/
|
|
2941
|
+
layout?: (FCLLayout | keyof typeof FCLLayout) | PropertyBindingInfo;
|
|
2942
|
+
|
|
2943
|
+
/**
|
|
2944
|
+
* Defines the width of the control
|
|
2945
|
+
*/
|
|
2946
|
+
width?: CSSSize | PropertyBindingInfo;
|
|
2947
|
+
|
|
2948
|
+
/**
|
|
2949
|
+
* Defines the content in the end column.
|
|
2950
|
+
*/
|
|
2951
|
+
endColumn?: Control;
|
|
2952
|
+
|
|
2953
|
+
/**
|
|
2954
|
+
* Defines the content in the middle column.
|
|
2955
|
+
*/
|
|
2956
|
+
midColumn?: Control;
|
|
2957
|
+
|
|
2958
|
+
/**
|
|
2959
|
+
* Defines the content in the start column.
|
|
2960
|
+
*/
|
|
2961
|
+
startColumn?: Control;
|
|
2962
|
+
|
|
2963
|
+
/**
|
|
2964
|
+
* Fired when the layout changes via user interaction by clicking the arrows or by changing the component
|
|
2965
|
+
* size due to resizing.
|
|
2966
|
+
*/
|
|
2967
|
+
layoutChange?: (oEvent: Event) => void;
|
|
2968
|
+
}
|
|
2969
|
+
}
|
|
2970
|
+
|
|
2971
|
+
declare module "sap/ui/webc/fiori/IllustratedMessage" {
|
|
2972
|
+
import {
|
|
2973
|
+
default as WebComponent,
|
|
2974
|
+
$WebComponentSettings,
|
|
2975
|
+
} from "sap/ui/webc/common/WebComponent";
|
|
2976
|
+
|
|
2977
|
+
import { IButton } from "sap/ui/webc/main/library";
|
|
2978
|
+
|
|
2979
|
+
import WebComponentMetadata from "sap/ui/webc/common/WebComponentMetadata";
|
|
2980
|
+
|
|
2981
|
+
import { IllustrationMessageType } from "sap/ui/webc/fiori/library";
|
|
2982
|
+
|
|
2983
|
+
import Control from "sap/ui/core/Control";
|
|
2984
|
+
|
|
2985
|
+
import {
|
|
2986
|
+
PropertyBindingInfo,
|
|
2987
|
+
AggregationBindingInfo,
|
|
2988
|
+
} from "sap/ui/base/ManagedObject";
|
|
2989
|
+
|
|
2990
|
+
/**
|
|
2991
|
+
* @SINCE 1.95.0
|
|
2992
|
+
* @EXPERIMENTAL (since 1.95.0)
|
|
2993
|
+
*
|
|
2994
|
+
* Overview: An IllustratedMessage is a recommended combination of a solution-oriented message, an engaging
|
|
2995
|
+
* illustration, and conversational tone to better communicate an empty or a success state than just show
|
|
2996
|
+
* a message alone.
|
|
2997
|
+
*
|
|
2998
|
+
* Each illustration has default internationalised title and subtitle texts. Also they can be managed with
|
|
2999
|
+
* `titleText` and `subtitleText` properties.
|
|
3000
|
+
*
|
|
3001
|
+
* Structure: The IllustratedMessage consists of the following elements, which are displayed below each
|
|
3002
|
+
* other in the following order:
|
|
3003
|
+
*
|
|
3004
|
+
*
|
|
3005
|
+
*
|
|
3006
|
+
* - Illustration
|
|
3007
|
+
* - Title
|
|
3008
|
+
* - Subtitle
|
|
3009
|
+
* - Actions
|
|
3010
|
+
*
|
|
3011
|
+
* Usage: `sap.ui.webc.fiori.IllustratedMessage` is meant to be used inside container component, for example
|
|
3012
|
+
* a `sap.ui.webc.main.Card`, a `sap.ui.webc.main.Dialog` or a `sap.ui.webc.fiori.Page`
|
|
3013
|
+
*/
|
|
3014
|
+
export default class IllustratedMessage extends WebComponent {
|
|
3015
|
+
/**
|
|
3016
|
+
* Constructor for a new `IllustratedMessage`.
|
|
3017
|
+
*
|
|
3018
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
3019
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
3020
|
+
* of the syntax of the settings object.
|
|
3021
|
+
*/
|
|
3022
|
+
constructor(
|
|
3023
|
+
/**
|
|
3024
|
+
* Initial settings for the new control
|
|
3025
|
+
*/
|
|
3026
|
+
mSettings?: $IllustratedMessageSettings
|
|
3027
|
+
);
|
|
3028
|
+
/**
|
|
3029
|
+
* Constructor for a new `IllustratedMessage`.
|
|
3030
|
+
*
|
|
3031
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
3032
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
3033
|
+
* of the syntax of the settings object.
|
|
3034
|
+
*/
|
|
3035
|
+
constructor(
|
|
3036
|
+
/**
|
|
3037
|
+
* ID for the new control, generated automatically if no ID is given
|
|
3038
|
+
*/
|
|
3039
|
+
sId?: string,
|
|
3040
|
+
/**
|
|
3041
|
+
* Initial settings for the new control
|
|
3042
|
+
*/
|
|
3043
|
+
mSettings?: $IllustratedMessageSettings
|
|
3044
|
+
);
|
|
3045
|
+
|
|
3046
|
+
/**
|
|
3047
|
+
* Creates a new subclass of class sap.ui.webc.fiori.IllustratedMessage with name `sClassName` and enriches
|
|
3048
|
+
* it with the information contained in `oClassInfo`.
|
|
3049
|
+
*
|
|
3050
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
|
|
3051
|
+
*/
|
|
3052
|
+
static extend<T extends Record<string, unknown>>(
|
|
3053
|
+
/**
|
|
3054
|
+
* Name of the class being created
|
|
3055
|
+
*/
|
|
3056
|
+
sClassName: string,
|
|
3057
|
+
/**
|
|
3058
|
+
* Object literal with information about the class
|
|
3059
|
+
*/
|
|
3060
|
+
oClassInfo?: sap.ClassInfo<T, IllustratedMessage>,
|
|
3061
|
+
/**
|
|
3062
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
3063
|
+
* used by this class
|
|
3064
|
+
*/
|
|
3065
|
+
FNMetaImpl?: Function
|
|
3066
|
+
): Function;
|
|
3067
|
+
/**
|
|
3068
|
+
* Returns a metadata object for class sap.ui.webc.fiori.IllustratedMessage.
|
|
3069
|
+
*/
|
|
3070
|
+
static getMetadata(): WebComponentMetadata;
|
|
3071
|
+
/**
|
|
3072
|
+
* Adds some action to the aggregation {@link #getActions actions}.
|
|
3073
|
+
*/
|
|
3074
|
+
addAction(
|
|
3075
|
+
/**
|
|
3076
|
+
* The action to add; if empty, nothing is inserted
|
|
3077
|
+
*/
|
|
3078
|
+
oAction: IButton
|
|
3079
|
+
): this;
|
|
3080
|
+
/**
|
|
3081
|
+
* Destroys all the actions in the aggregation {@link #getActions actions}.
|
|
3082
|
+
*/
|
|
3083
|
+
destroyActions(): this;
|
|
3084
|
+
/**
|
|
3085
|
+
* Destroys the subtitle in the aggregation {@link #getSubtitle subtitle}.
|
|
3086
|
+
*/
|
|
3087
|
+
destroySubtitle(): this;
|
|
3088
|
+
/**
|
|
3089
|
+
* Gets content of aggregation {@link #getActions actions}.
|
|
3090
|
+
*
|
|
3091
|
+
* Defines the component actions.
|
|
3092
|
+
*/
|
|
3093
|
+
getActions(): IButton[];
|
|
3094
|
+
/**
|
|
3095
|
+
* Gets current value of property {@link #getName name}.
|
|
3096
|
+
*
|
|
3097
|
+
* Default value is `BeforeSearch`.
|
|
3098
|
+
*/
|
|
3099
|
+
getName(): IllustrationMessageType | keyof typeof IllustrationMessageType;
|
|
3100
|
+
/**
|
|
3101
|
+
* Gets content of aggregation {@link #getSubtitle subtitle}.
|
|
3102
|
+
*
|
|
3103
|
+
* Defines the subtitle of the component.
|
|
3104
|
+
*
|
|
3105
|
+
* **Note:** Using this slot, the default subtitle text of illustration and the value of `subtitleText`
|
|
3106
|
+
* property will be overwritten.
|
|
3107
|
+
*/
|
|
3108
|
+
getSubtitle(): Control;
|
|
3109
|
+
/**
|
|
3110
|
+
* Gets current value of property {@link #getSubtitleText subtitleText}.
|
|
3111
|
+
*
|
|
3112
|
+
* Defines the subtitle of the component.
|
|
3113
|
+
*
|
|
3114
|
+
* **Note:** Using this property, the default subtitle text of illustration will be overwritten.
|
|
3115
|
+
*
|
|
3116
|
+
* **Note:** Using `subtitle` slot, the default of this property will be overwritten.
|
|
1298
3117
|
*
|
|
1299
|
-
* Default value is `
|
|
3118
|
+
* Default value is `empty string`.
|
|
1300
3119
|
*/
|
|
1301
|
-
|
|
3120
|
+
getSubtitleText(): string;
|
|
1302
3121
|
/**
|
|
1303
|
-
* Gets current value of property {@link #
|
|
3122
|
+
* Gets current value of property {@link #getTitleText titleText}.
|
|
1304
3123
|
*
|
|
1305
|
-
* Defines the
|
|
3124
|
+
* Defines the title of the component.
|
|
3125
|
+
*
|
|
3126
|
+
* **Note:** Using this property, the default title text of illustration will be overwritten.
|
|
1306
3127
|
*
|
|
1307
3128
|
* Default value is `empty string`.
|
|
1308
3129
|
*/
|
|
1309
|
-
|
|
3130
|
+
getTitleText(): string;
|
|
1310
3131
|
/**
|
|
1311
|
-
*
|
|
3132
|
+
* Checks for the provided `sap.ui.webc.main.IButton` in the aggregation {@link #getActions actions}. and
|
|
3133
|
+
* returns its index if found or -1 otherwise.
|
|
3134
|
+
*/
|
|
3135
|
+
indexOfAction(
|
|
3136
|
+
/**
|
|
3137
|
+
* The action whose index is looked for
|
|
3138
|
+
*/
|
|
3139
|
+
oAction: IButton
|
|
3140
|
+
): int;
|
|
3141
|
+
/**
|
|
3142
|
+
* Inserts a action into the aggregation {@link #getActions actions}.
|
|
3143
|
+
*/
|
|
3144
|
+
insertAction(
|
|
3145
|
+
/**
|
|
3146
|
+
* The action to insert; if empty, nothing is inserted
|
|
3147
|
+
*/
|
|
3148
|
+
oAction: IButton,
|
|
3149
|
+
/**
|
|
3150
|
+
* The `0`-based index the action should be inserted at; for a negative value of `iIndex`, the action is
|
|
3151
|
+
* inserted at position 0; for a value greater than the current size of the aggregation, the action is inserted
|
|
3152
|
+
* at the last position
|
|
3153
|
+
*/
|
|
3154
|
+
iIndex: int
|
|
3155
|
+
): this;
|
|
3156
|
+
/**
|
|
3157
|
+
* Removes a action from the aggregation {@link #getActions actions}.
|
|
3158
|
+
*/
|
|
3159
|
+
removeAction(
|
|
3160
|
+
/**
|
|
3161
|
+
* The action to remove or its index or id
|
|
3162
|
+
*/
|
|
3163
|
+
vAction: int | string | IButton
|
|
3164
|
+
): IButton;
|
|
3165
|
+
/**
|
|
3166
|
+
* Removes all the controls from the aggregation {@link #getActions actions}.
|
|
1312
3167
|
*
|
|
1313
|
-
*
|
|
3168
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
3169
|
+
*/
|
|
3170
|
+
removeAllActions(): IButton[];
|
|
3171
|
+
/**
|
|
3172
|
+
* Sets a new value for property {@link #getName name}.
|
|
1314
3173
|
*
|
|
1315
3174
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1316
3175
|
*
|
|
1317
|
-
* Default value is `
|
|
3176
|
+
* Default value is `BeforeSearch`.
|
|
1318
3177
|
*/
|
|
1319
|
-
|
|
3178
|
+
setName(
|
|
1320
3179
|
/**
|
|
1321
|
-
* New value for property `
|
|
3180
|
+
* New value for property `name`
|
|
1322
3181
|
*/
|
|
1323
|
-
|
|
3182
|
+
sName?: IllustrationMessageType | keyof typeof IllustrationMessageType
|
|
1324
3183
|
): this;
|
|
1325
3184
|
/**
|
|
1326
|
-
* Sets
|
|
3185
|
+
* Sets the aggregated {@link #getSubtitle subtitle}.
|
|
3186
|
+
*/
|
|
3187
|
+
setSubtitle(
|
|
3188
|
+
/**
|
|
3189
|
+
* The subtitle to set
|
|
3190
|
+
*/
|
|
3191
|
+
oSubtitle: Control
|
|
3192
|
+
): this;
|
|
3193
|
+
/**
|
|
3194
|
+
* Sets a new value for property {@link #getSubtitleText subtitleText}.
|
|
1327
3195
|
*
|
|
1328
|
-
* Defines the
|
|
3196
|
+
* Defines the subtitle of the component.
|
|
3197
|
+
*
|
|
3198
|
+
* **Note:** Using this property, the default subtitle text of illustration will be overwritten.
|
|
3199
|
+
*
|
|
3200
|
+
* **Note:** Using `subtitle` slot, the default of this property will be overwritten.
|
|
1329
3201
|
*
|
|
1330
3202
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1331
3203
|
*
|
|
1332
3204
|
* Default value is `empty string`.
|
|
1333
3205
|
*/
|
|
1334
|
-
|
|
3206
|
+
setSubtitleText(
|
|
1335
3207
|
/**
|
|
1336
|
-
* New value for property `
|
|
3208
|
+
* New value for property `subtitleText`
|
|
1337
3209
|
*/
|
|
1338
|
-
|
|
3210
|
+
sSubtitleText?: string
|
|
3211
|
+
): this;
|
|
3212
|
+
/**
|
|
3213
|
+
* Sets a new value for property {@link #getTitleText titleText}.
|
|
3214
|
+
*
|
|
3215
|
+
* Defines the title of the component.
|
|
3216
|
+
*
|
|
3217
|
+
* **Note:** Using this property, the default title text of illustration will be overwritten.
|
|
3218
|
+
*
|
|
3219
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3220
|
+
*
|
|
3221
|
+
* Default value is `empty string`.
|
|
3222
|
+
*/
|
|
3223
|
+
setTitleText(
|
|
3224
|
+
/**
|
|
3225
|
+
* New value for property `titleText`
|
|
3226
|
+
*/
|
|
3227
|
+
sTitleText?: string
|
|
1339
3228
|
): this;
|
|
1340
3229
|
}
|
|
1341
3230
|
|
|
1342
|
-
export interface $
|
|
3231
|
+
export interface $IllustratedMessageSettings extends $WebComponentSettings {
|
|
3232
|
+
name?:
|
|
3233
|
+
| (IllustrationMessageType | keyof typeof IllustrationMessageType)
|
|
3234
|
+
| PropertyBindingInfo;
|
|
3235
|
+
|
|
1343
3236
|
/**
|
|
1344
|
-
* Defines
|
|
3237
|
+
* Defines the subtitle of the component.
|
|
3238
|
+
*
|
|
3239
|
+
* **Note:** Using this property, the default subtitle text of illustration will be overwritten.
|
|
3240
|
+
*
|
|
3241
|
+
* **Note:** Using `subtitle` slot, the default of this property will be overwritten.
|
|
1345
3242
|
*/
|
|
1346
|
-
|
|
3243
|
+
subtitleText?: string | PropertyBindingInfo;
|
|
1347
3244
|
|
|
1348
3245
|
/**
|
|
1349
|
-
* Defines the
|
|
3246
|
+
* Defines the title of the component.
|
|
3247
|
+
*
|
|
3248
|
+
* **Note:** Using this property, the default title text of illustration will be overwritten.
|
|
1350
3249
|
*/
|
|
1351
|
-
|
|
3250
|
+
titleText?: string | PropertyBindingInfo;
|
|
3251
|
+
|
|
3252
|
+
/**
|
|
3253
|
+
* Defines the component actions.
|
|
3254
|
+
*/
|
|
3255
|
+
actions?: IButton[] | IButton | AggregationBindingInfo;
|
|
3256
|
+
|
|
3257
|
+
/**
|
|
3258
|
+
* Defines the subtitle of the component.
|
|
3259
|
+
*
|
|
3260
|
+
* **Note:** Using this slot, the default subtitle text of illustration and the value of `subtitleText`
|
|
3261
|
+
* property will be overwritten.
|
|
3262
|
+
*/
|
|
3263
|
+
subtitle?: Control;
|
|
1352
3264
|
}
|
|
1353
3265
|
}
|
|
1354
3266
|
|
|
1355
|
-
declare module "sap/ui/webc/fiori/
|
|
3267
|
+
declare module "sap/ui/webc/fiori/MediaGallery" {
|
|
1356
3268
|
import {
|
|
1357
3269
|
default as WebComponent,
|
|
1358
3270
|
$WebComponentSettings,
|
|
1359
3271
|
} from "sap/ui/webc/common/WebComponent";
|
|
1360
3272
|
|
|
1361
|
-
import
|
|
1362
|
-
|
|
1363
|
-
|
|
1364
|
-
|
|
1365
|
-
|
|
3273
|
+
import {
|
|
3274
|
+
IMediaGalleryItem,
|
|
3275
|
+
MediaGalleryLayout,
|
|
3276
|
+
MediaGalleryMenuHorizontalAlign,
|
|
3277
|
+
MediaGalleryMenuVerticalAlign,
|
|
3278
|
+
} from "sap/ui/webc/fiori/library";
|
|
1366
3279
|
|
|
1367
|
-
import
|
|
3280
|
+
import Event from "sap/ui/base/Event";
|
|
1368
3281
|
|
|
1369
3282
|
import WebComponentMetadata from "sap/ui/webc/common/WebComponentMetadata";
|
|
1370
3283
|
|
|
1371
|
-
import {
|
|
3284
|
+
import {
|
|
3285
|
+
PropertyBindingInfo,
|
|
3286
|
+
AggregationBindingInfo,
|
|
3287
|
+
} from "sap/ui/base/ManagedObject";
|
|
1372
3288
|
|
|
1373
3289
|
/**
|
|
1374
|
-
* @SINCE 1.
|
|
1375
|
-
* @EXPERIMENTAL (since 1.
|
|
3290
|
+
* @SINCE 1.99.0
|
|
3291
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
1376
3292
|
*
|
|
1377
3293
|
* Overview:
|
|
1378
3294
|
*
|
|
1379
|
-
* The `
|
|
1380
|
-
*
|
|
1381
|
-
*
|
|
1382
|
-
*
|
|
1383
|
-
* Usage:
|
|
1384
|
-
*
|
|
1385
|
-
* Use this component for applications that need to display several logical levels of related information
|
|
1386
|
-
* side by side (e.g. list of items, item, sub-item, etc.). The Component is flexible in a sense that the
|
|
1387
|
-
* application can focus the user's attention on one particular column.
|
|
1388
|
-
*
|
|
1389
|
-
* Responsive Behavior:
|
|
1390
|
-
*
|
|
1391
|
-
* The `FlexibleColumnLayout` automatically displays the maximum possible number of columns based on `layout`
|
|
1392
|
-
* property and the window size. The component would display 1 column for window size smaller than 599px,
|
|
1393
|
-
* up to two columns between 599px and 1023px, and 3 columns for sizes bigger than 1023px.
|
|
3295
|
+
* The `ui-media-gallery` component allows the user to browse through multimedia items. Currently, the supported
|
|
3296
|
+
* items are images and videos. The items should be defined using the `sap.ui.webc.fiori.MediaGalleryItem`
|
|
3297
|
+
* component.
|
|
1394
3298
|
*
|
|
3299
|
+
* The items are initially displayed as thumbnails. When the user selects a thumbnail, the corresponding
|
|
3300
|
+
* item is displayed in larger size.
|
|
3301
|
+
* The component is responsive by default and adjusts the position of the menu with respect to viewport
|
|
3302
|
+
* size, but the application is able to further customize the layout via the provided API.
|
|
1395
3303
|
*
|
|
3304
|
+
* Keyboard Handling: The `sap.ui.webc.fiori.MediaGallery` provides advanced keyboard handling.
|
|
3305
|
+
* When the thumbnails menu is focused the following keyboard shortcuts allow the user to navigate through
|
|
3306
|
+
* the thumbnail items:
|
|
1396
3307
|
*
|
|
1397
|
-
* Keyboard Handling:
|
|
1398
3308
|
*
|
|
1399
3309
|
*
|
|
1400
|
-
* - [
|
|
1401
|
-
*
|
|
3310
|
+
* - [UP/DOWN] - Navigates up and down the items
|
|
3311
|
+
* - [HOME] - Navigates to first item
|
|
3312
|
+
* - [END] - Navigates to the last item [SPACE/ENTER] - Select an item
|
|
1402
3313
|
*/
|
|
1403
|
-
export default class
|
|
3314
|
+
export default class MediaGallery extends WebComponent {
|
|
1404
3315
|
/**
|
|
1405
|
-
* Constructor for a new `
|
|
3316
|
+
* Constructor for a new `MediaGallery`.
|
|
1406
3317
|
*
|
|
1407
3318
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1408
3319
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
@@ -1412,10 +3323,10 @@ declare module "sap/ui/webc/fiori/FlexibleColumnLayout" {
|
|
|
1412
3323
|
/**
|
|
1413
3324
|
* Initial settings for the new control
|
|
1414
3325
|
*/
|
|
1415
|
-
mSettings?: $
|
|
3326
|
+
mSettings?: $MediaGallerySettings
|
|
1416
3327
|
);
|
|
1417
3328
|
/**
|
|
1418
|
-
* Constructor for a new `
|
|
3329
|
+
* Constructor for a new `MediaGallery`.
|
|
1419
3330
|
*
|
|
1420
3331
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1421
3332
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
@@ -1429,44 +3340,139 @@ declare module "sap/ui/webc/fiori/FlexibleColumnLayout" {
|
|
|
1429
3340
|
/**
|
|
1430
3341
|
* Initial settings for the new control
|
|
1431
3342
|
*/
|
|
1432
|
-
mSettings?: $
|
|
3343
|
+
mSettings?: $MediaGallerySettings
|
|
1433
3344
|
);
|
|
1434
3345
|
|
|
1435
3346
|
/**
|
|
1436
|
-
* Creates a new subclass of class sap.ui.webc.fiori.
|
|
1437
|
-
*
|
|
3347
|
+
* Creates a new subclass of class sap.ui.webc.fiori.MediaGallery with name `sClassName` and enriches it
|
|
3348
|
+
* with the information contained in `oClassInfo`.
|
|
3349
|
+
*
|
|
3350
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
|
|
3351
|
+
*/
|
|
3352
|
+
static extend<T extends Record<string, unknown>>(
|
|
3353
|
+
/**
|
|
3354
|
+
* Name of the class being created
|
|
3355
|
+
*/
|
|
3356
|
+
sClassName: string,
|
|
3357
|
+
/**
|
|
3358
|
+
* Object literal with information about the class
|
|
3359
|
+
*/
|
|
3360
|
+
oClassInfo?: sap.ClassInfo<T, MediaGallery>,
|
|
3361
|
+
/**
|
|
3362
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
3363
|
+
* used by this class
|
|
3364
|
+
*/
|
|
3365
|
+
FNMetaImpl?: Function
|
|
3366
|
+
): Function;
|
|
3367
|
+
/**
|
|
3368
|
+
* Returns a metadata object for class sap.ui.webc.fiori.MediaGallery.
|
|
3369
|
+
*/
|
|
3370
|
+
static getMetadata(): WebComponentMetadata;
|
|
3371
|
+
/**
|
|
3372
|
+
* Adds some item to the aggregation {@link #getItems items}.
|
|
3373
|
+
*/
|
|
3374
|
+
addItem(
|
|
3375
|
+
/**
|
|
3376
|
+
* The item to add; if empty, nothing is inserted
|
|
3377
|
+
*/
|
|
3378
|
+
oItem: IMediaGalleryItem
|
|
3379
|
+
): this;
|
|
3380
|
+
/**
|
|
3381
|
+
* Attaches event handler `fnFunction` to the {@link #event:displayAreaClick displayAreaClick} event of
|
|
3382
|
+
* this `sap.ui.webc.fiori.MediaGallery`.
|
|
3383
|
+
*
|
|
3384
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
3385
|
+
* otherwise it will be bound to this `sap.ui.webc.fiori.MediaGallery` itself.
|
|
3386
|
+
*
|
|
3387
|
+
* Fired when the display area is clicked.
|
|
3388
|
+
* The display area is the central area that contains the enlarged content of the currently selected item.
|
|
3389
|
+
*/
|
|
3390
|
+
attachDisplayAreaClick(
|
|
3391
|
+
/**
|
|
3392
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
3393
|
+
* object when firing the event
|
|
3394
|
+
*/
|
|
3395
|
+
oData: object,
|
|
3396
|
+
/**
|
|
3397
|
+
* The function to be called when the event occurs
|
|
3398
|
+
*/
|
|
3399
|
+
fnFunction: (p1: Event) => void,
|
|
3400
|
+
/**
|
|
3401
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.MediaGallery` itself
|
|
3402
|
+
*/
|
|
3403
|
+
oListener?: object
|
|
3404
|
+
): this;
|
|
3405
|
+
/**
|
|
3406
|
+
* Attaches event handler `fnFunction` to the {@link #event:displayAreaClick displayAreaClick} event of
|
|
3407
|
+
* this `sap.ui.webc.fiori.MediaGallery`.
|
|
3408
|
+
*
|
|
3409
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
3410
|
+
* otherwise it will be bound to this `sap.ui.webc.fiori.MediaGallery` itself.
|
|
3411
|
+
*
|
|
3412
|
+
* Fired when the display area is clicked.
|
|
3413
|
+
* The display area is the central area that contains the enlarged content of the currently selected item.
|
|
3414
|
+
*/
|
|
3415
|
+
attachDisplayAreaClick(
|
|
3416
|
+
/**
|
|
3417
|
+
* The function to be called when the event occurs
|
|
3418
|
+
*/
|
|
3419
|
+
fnFunction: (p1: Event) => void,
|
|
3420
|
+
/**
|
|
3421
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.MediaGallery` itself
|
|
3422
|
+
*/
|
|
3423
|
+
oListener?: object
|
|
3424
|
+
): this;
|
|
3425
|
+
/**
|
|
3426
|
+
* Attaches event handler `fnFunction` to the {@link #event:overflowClick overflowClick} event of this `sap.ui.webc.fiori.MediaGallery`.
|
|
3427
|
+
*
|
|
3428
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
3429
|
+
* otherwise it will be bound to this `sap.ui.webc.fiori.MediaGallery` itself.
|
|
3430
|
+
*
|
|
3431
|
+
* Fired when the thumbnails overflow button is clicked.
|
|
3432
|
+
*/
|
|
3433
|
+
attachOverflowClick(
|
|
3434
|
+
/**
|
|
3435
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
3436
|
+
* object when firing the event
|
|
3437
|
+
*/
|
|
3438
|
+
oData: object,
|
|
3439
|
+
/**
|
|
3440
|
+
* The function to be called when the event occurs
|
|
3441
|
+
*/
|
|
3442
|
+
fnFunction: (p1: Event) => void,
|
|
3443
|
+
/**
|
|
3444
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.MediaGallery` itself
|
|
3445
|
+
*/
|
|
3446
|
+
oListener?: object
|
|
3447
|
+
): this;
|
|
3448
|
+
/**
|
|
3449
|
+
* Attaches event handler `fnFunction` to the {@link #event:overflowClick overflowClick} event of this `sap.ui.webc.fiori.MediaGallery`.
|
|
3450
|
+
*
|
|
3451
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
3452
|
+
* otherwise it will be bound to this `sap.ui.webc.fiori.MediaGallery` itself.
|
|
1438
3453
|
*
|
|
1439
|
-
*
|
|
3454
|
+
* Fired when the thumbnails overflow button is clicked.
|
|
1440
3455
|
*/
|
|
1441
|
-
|
|
1442
|
-
/**
|
|
1443
|
-
* Name of the class being created
|
|
1444
|
-
*/
|
|
1445
|
-
sClassName: string,
|
|
3456
|
+
attachOverflowClick(
|
|
1446
3457
|
/**
|
|
1447
|
-
*
|
|
3458
|
+
* The function to be called when the event occurs
|
|
1448
3459
|
*/
|
|
1449
|
-
|
|
3460
|
+
fnFunction: (p1: Event) => void,
|
|
1450
3461
|
/**
|
|
1451
|
-
*
|
|
1452
|
-
* used by this class
|
|
3462
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.MediaGallery` itself
|
|
1453
3463
|
*/
|
|
1454
|
-
|
|
1455
|
-
):
|
|
1456
|
-
/**
|
|
1457
|
-
* Returns a metadata object for class sap.ui.webc.fiori.FlexibleColumnLayout.
|
|
1458
|
-
*/
|
|
1459
|
-
static getMetadata(): WebComponentMetadata;
|
|
3464
|
+
oListener?: object
|
|
3465
|
+
): this;
|
|
1460
3466
|
/**
|
|
1461
|
-
* Attaches event handler `fnFunction` to the {@link #event:
|
|
3467
|
+
* Attaches event handler `fnFunction` to the {@link #event:selectionChange selectionChange} event of this
|
|
3468
|
+
* `sap.ui.webc.fiori.MediaGallery`.
|
|
1462
3469
|
*
|
|
1463
3470
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
1464
|
-
* otherwise it will be bound to this `sap.ui.webc.fiori.
|
|
3471
|
+
* otherwise it will be bound to this `sap.ui.webc.fiori.MediaGallery` itself.
|
|
1465
3472
|
*
|
|
1466
|
-
* Fired when
|
|
1467
|
-
* size due to resizing.
|
|
3473
|
+
* Fired when selection is changed by user interaction.
|
|
1468
3474
|
*/
|
|
1469
|
-
|
|
3475
|
+
attachSelectionChange(
|
|
1470
3476
|
/**
|
|
1471
3477
|
* An application-specific payload object that will be passed to the event handler along with the event
|
|
1472
3478
|
* object when firing the event
|
|
@@ -1477,49 +3483,72 @@ declare module "sap/ui/webc/fiori/FlexibleColumnLayout" {
|
|
|
1477
3483
|
*/
|
|
1478
3484
|
fnFunction: (p1: Event) => void,
|
|
1479
3485
|
/**
|
|
1480
|
-
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.
|
|
1481
|
-
* itself
|
|
3486
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.MediaGallery` itself
|
|
1482
3487
|
*/
|
|
1483
3488
|
oListener?: object
|
|
1484
3489
|
): this;
|
|
1485
3490
|
/**
|
|
1486
|
-
* Attaches event handler `fnFunction` to the {@link #event:
|
|
3491
|
+
* Attaches event handler `fnFunction` to the {@link #event:selectionChange selectionChange} event of this
|
|
3492
|
+
* `sap.ui.webc.fiori.MediaGallery`.
|
|
1487
3493
|
*
|
|
1488
3494
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
1489
|
-
* otherwise it will be bound to this `sap.ui.webc.fiori.
|
|
3495
|
+
* otherwise it will be bound to this `sap.ui.webc.fiori.MediaGallery` itself.
|
|
1490
3496
|
*
|
|
1491
|
-
* Fired when
|
|
1492
|
-
* size due to resizing.
|
|
3497
|
+
* Fired when selection is changed by user interaction.
|
|
1493
3498
|
*/
|
|
1494
|
-
|
|
3499
|
+
attachSelectionChange(
|
|
1495
3500
|
/**
|
|
1496
3501
|
* The function to be called when the event occurs
|
|
1497
3502
|
*/
|
|
1498
3503
|
fnFunction: (p1: Event) => void,
|
|
1499
3504
|
/**
|
|
1500
|
-
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.
|
|
1501
|
-
* itself
|
|
3505
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.MediaGallery` itself
|
|
1502
3506
|
*/
|
|
1503
3507
|
oListener?: object
|
|
1504
3508
|
): this;
|
|
1505
3509
|
/**
|
|
1506
|
-
* Destroys the
|
|
3510
|
+
* Destroys all the items in the aggregation {@link #getItems items}.
|
|
1507
3511
|
*/
|
|
1508
|
-
|
|
3512
|
+
destroyItems(): this;
|
|
1509
3513
|
/**
|
|
1510
|
-
*
|
|
3514
|
+
* Detaches event handler `fnFunction` from the {@link #event:displayAreaClick displayAreaClick} event of
|
|
3515
|
+
* this `sap.ui.webc.fiori.MediaGallery`.
|
|
3516
|
+
*
|
|
3517
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
1511
3518
|
*/
|
|
1512
|
-
|
|
3519
|
+
detachDisplayAreaClick(
|
|
3520
|
+
/**
|
|
3521
|
+
* The function to be called, when the event occurs
|
|
3522
|
+
*/
|
|
3523
|
+
fnFunction: (p1: Event) => void,
|
|
3524
|
+
/**
|
|
3525
|
+
* Context object on which the given function had to be called
|
|
3526
|
+
*/
|
|
3527
|
+
oListener?: object
|
|
3528
|
+
): this;
|
|
1513
3529
|
/**
|
|
1514
|
-
*
|
|
3530
|
+
* Detaches event handler `fnFunction` from the {@link #event:overflowClick overflowClick} event of this
|
|
3531
|
+
* `sap.ui.webc.fiori.MediaGallery`.
|
|
3532
|
+
*
|
|
3533
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
1515
3534
|
*/
|
|
1516
|
-
|
|
3535
|
+
detachOverflowClick(
|
|
3536
|
+
/**
|
|
3537
|
+
* The function to be called, when the event occurs
|
|
3538
|
+
*/
|
|
3539
|
+
fnFunction: (p1: Event) => void,
|
|
3540
|
+
/**
|
|
3541
|
+
* Context object on which the given function had to be called
|
|
3542
|
+
*/
|
|
3543
|
+
oListener?: object
|
|
3544
|
+
): this;
|
|
1517
3545
|
/**
|
|
1518
|
-
* Detaches event handler `fnFunction` from the {@link #event:
|
|
3546
|
+
* Detaches event handler `fnFunction` from the {@link #event:selectionChange selectionChange} event of
|
|
3547
|
+
* this `sap.ui.webc.fiori.MediaGallery`.
|
|
1519
3548
|
*
|
|
1520
3549
|
* The passed function and listener object must match the ones used for event registration.
|
|
1521
3550
|
*/
|
|
1522
|
-
|
|
3551
|
+
detachSelectionChange(
|
|
1523
3552
|
/**
|
|
1524
3553
|
* The function to be called, when the event occurs
|
|
1525
3554
|
*/
|
|
@@ -1530,393 +3559,372 @@ declare module "sap/ui/webc/fiori/FlexibleColumnLayout" {
|
|
|
1530
3559
|
oListener?: object
|
|
1531
3560
|
): this;
|
|
1532
3561
|
/**
|
|
1533
|
-
* Fires event {@link #event:
|
|
3562
|
+
* Fires event {@link #event:displayAreaClick displayAreaClick} to attached listeners.
|
|
1534
3563
|
*/
|
|
1535
|
-
|
|
3564
|
+
fireDisplayAreaClick(
|
|
3565
|
+
/**
|
|
3566
|
+
* Parameters to pass along with the event
|
|
3567
|
+
*/
|
|
3568
|
+
mParameters?: object
|
|
3569
|
+
): this;
|
|
3570
|
+
/**
|
|
3571
|
+
* Fires event {@link #event:overflowClick overflowClick} to attached listeners.
|
|
3572
|
+
*/
|
|
3573
|
+
fireOverflowClick(
|
|
3574
|
+
/**
|
|
3575
|
+
* Parameters to pass along with the event
|
|
3576
|
+
*/
|
|
3577
|
+
mParameters?: object
|
|
3578
|
+
): this;
|
|
3579
|
+
/**
|
|
3580
|
+
* Fires event {@link #event:selectionChange selectionChange} to attached listeners.
|
|
3581
|
+
*/
|
|
3582
|
+
fireSelectionChange(
|
|
1536
3583
|
/**
|
|
1537
3584
|
* Parameters to pass along with the event
|
|
1538
3585
|
*/
|
|
1539
3586
|
mParameters?: {
|
|
1540
3587
|
/**
|
|
1541
|
-
*
|
|
1542
|
-
*/
|
|
1543
|
-
layout?: FCLLayout | keyof typeof FCLLayout;
|
|
1544
|
-
/**
|
|
1545
|
-
* The effective column layout, f.e [67%, 33%, 0]
|
|
1546
|
-
*/
|
|
1547
|
-
columnLayout?: any[];
|
|
1548
|
-
/**
|
|
1549
|
-
* Indicates if the start column is currently visible
|
|
1550
|
-
*/
|
|
1551
|
-
startColumnVisible?: boolean;
|
|
1552
|
-
/**
|
|
1553
|
-
* Indicates if the middle column is currently visible
|
|
1554
|
-
*/
|
|
1555
|
-
midColumnVisible?: boolean;
|
|
1556
|
-
/**
|
|
1557
|
-
* Indicates if the end column is currently visible
|
|
1558
|
-
*/
|
|
1559
|
-
endColumnVisible?: boolean;
|
|
1560
|
-
/**
|
|
1561
|
-
* Indicates if the layout is changed via the arrows
|
|
1562
|
-
*/
|
|
1563
|
-
arrowsUsed?: boolean;
|
|
1564
|
-
/**
|
|
1565
|
-
* Indicates if the layout is changed via resizing
|
|
3588
|
+
* the selected item.
|
|
1566
3589
|
*/
|
|
1567
|
-
|
|
3590
|
+
item?: HTMLElement;
|
|
1568
3591
|
}
|
|
1569
3592
|
): this;
|
|
1570
3593
|
/**
|
|
1571
|
-
* Gets current value of property {@link #
|
|
1572
|
-
*
|
|
1573
|
-
* An object of strings that defines several additional accessibility texts for even further customization.
|
|
3594
|
+
* Gets current value of property {@link #getInteractiveDisplayArea interactiveDisplayArea}.
|
|
1574
3595
|
*
|
|
1575
|
-
*
|
|
1576
|
-
*
|
|
1577
|
-
* the accessibility name for the `endColumn` region - `startArrowLeftText`: the text that the first arrow
|
|
1578
|
-
* (between the `begin` and `mid` columns) will have when pointing to the left - `startArrowRightText`:
|
|
1579
|
-
* the text that the first arrow (between the `begin` and `mid` columns) will have when pointing to the
|
|
1580
|
-
* right - `endArrowLeftText`: the text that the second arrow (between the `mid` and `end` columns) will
|
|
1581
|
-
* have when pointing to the left - `endArrowRightText`: the text that the second arrow (between the `mid`
|
|
1582
|
-
* and `end` columns) will have when pointing to the right
|
|
3596
|
+
* If enabled, a `display-area-click` event is fired when the user clicks or taps on the display area.
|
|
3597
|
+
* The display area is the central area that contains the enlarged content of the currently selected item.
|
|
1583
3598
|
*
|
|
1584
|
-
* Default value is `
|
|
3599
|
+
* Default value is `false`.
|
|
1585
3600
|
*/
|
|
1586
|
-
|
|
3601
|
+
getInteractiveDisplayArea(): boolean;
|
|
1587
3602
|
/**
|
|
1588
|
-
*
|
|
3603
|
+
* Gets content of aggregation {@link #getItems items}.
|
|
1589
3604
|
*
|
|
1590
|
-
*
|
|
1591
|
-
* the width of the start, middle and end columns.
|
|
1592
|
-
*/
|
|
1593
|
-
getColumnLayout(): void;
|
|
1594
|
-
/**
|
|
1595
|
-
* Gets content of aggregation {@link #getEndColumn endColumn}.
|
|
3605
|
+
* Defines the component items.
|
|
1596
3606
|
*
|
|
1597
|
-
* Defines the content in the end column.
|
|
1598
|
-
*/
|
|
1599
|
-
getEndColumn(): Control;
|
|
1600
|
-
/**
|
|
1601
|
-
* Returns if the `end` column is visible.
|
|
1602
|
-
*/
|
|
1603
|
-
getEndColumnVisible(): void;
|
|
1604
|
-
/**
|
|
1605
|
-
* Gets current value of property {@link #getHeight height}.
|
|
1606
3607
|
*
|
|
1607
|
-
* Defines the height of the control
|
|
1608
|
-
*/
|
|
1609
|
-
getHeight(): CSSSize;
|
|
1610
|
-
/**
|
|
1611
|
-
* Gets current value of property {@link #getHideArrows hideArrows}.
|
|
1612
3608
|
*
|
|
1613
|
-
*
|
|
3609
|
+
* **Note:** Only one selected item is allowed.
|
|
1614
3610
|
*
|
|
1615
|
-
*
|
|
3611
|
+
*
|
|
3612
|
+
*
|
|
3613
|
+
* **Note:** Use the `sap.ui.webc.fiori.MediaGalleryItem` component to define the desired items.
|
|
1616
3614
|
*/
|
|
1617
|
-
|
|
3615
|
+
getItems(): IMediaGalleryItem[];
|
|
1618
3616
|
/**
|
|
1619
3617
|
* Gets current value of property {@link #getLayout layout}.
|
|
1620
3618
|
*
|
|
1621
|
-
*
|
|
1622
|
-
*
|
|
1623
|
-
* **Note:** The layout also depends on the screen size - one column for screens smaller than 599px, two
|
|
1624
|
-
* columns between 599px and 1023px and three columns for sizes bigger than 1023px.
|
|
3619
|
+
* Determines the layout of the component.
|
|
1625
3620
|
*
|
|
1626
3621
|
* Available options are:
|
|
1627
|
-
* - `
|
|
1628
|
-
* - `
|
|
1629
|
-
* - `
|
|
1630
|
-
* - `ThreeColumnsMidExpanded`
|
|
1631
|
-
* - `ThreeColumnsEndExpanded`
|
|
1632
|
-
* - `ThreeColumnsStartExpandedEndHidden`
|
|
1633
|
-
* - `ThreeColumnsMidExpandedEndHidden`
|
|
1634
|
-
* - `MidColumnFullScreen`
|
|
1635
|
-
* - `EndColumnFullScreen`
|
|
1636
|
-
*
|
|
1637
|
-
* **For example:** layout=`TwoColumnsStartExpanded` means the layout will display up to two columns in
|
|
1638
|
-
* 67%/33% proportion.
|
|
3622
|
+
* - `Auto`
|
|
3623
|
+
* - `Vertical`
|
|
3624
|
+
* - `Horizontal`
|
|
1639
3625
|
*
|
|
1640
|
-
* Default value is `
|
|
3626
|
+
* Default value is `Auto`.
|
|
1641
3627
|
*/
|
|
1642
|
-
getLayout():
|
|
3628
|
+
getLayout(): MediaGalleryLayout | keyof typeof MediaGalleryLayout;
|
|
1643
3629
|
/**
|
|
1644
|
-
* Gets
|
|
3630
|
+
* Gets current value of property {@link #getMenuHorizontalAlign menuHorizontalAlign}.
|
|
1645
3631
|
*
|
|
1646
|
-
*
|
|
1647
|
-
*/
|
|
1648
|
-
getMidColumn(): Control;
|
|
1649
|
-
/**
|
|
1650
|
-
* Returns if the `middle` column is visible.
|
|
1651
|
-
*/
|
|
1652
|
-
getMidColumnVisible(): void;
|
|
1653
|
-
/**
|
|
1654
|
-
* Gets content of aggregation {@link #getStartColumn startColumn}.
|
|
3632
|
+
* Determines the horizontal alignment of the thumbnails menu vs. the central display area.
|
|
1655
3633
|
*
|
|
1656
|
-
*
|
|
1657
|
-
|
|
1658
|
-
|
|
1659
|
-
/**
|
|
1660
|
-
* Returns if the `start` column is visible.
|
|
1661
|
-
*/
|
|
1662
|
-
getStartColumnVisible(): void;
|
|
1663
|
-
/**
|
|
1664
|
-
* Returns the number of currently visible columns.
|
|
1665
|
-
*/
|
|
1666
|
-
getVisibleColumns(): void;
|
|
1667
|
-
/**
|
|
1668
|
-
* Gets current value of property {@link #getWidth width}.
|
|
3634
|
+
* Available options are:
|
|
3635
|
+
* - `Left`
|
|
3636
|
+
* - `Right`
|
|
1669
3637
|
*
|
|
1670
|
-
*
|
|
3638
|
+
* Default value is `Left`.
|
|
1671
3639
|
*/
|
|
1672
|
-
|
|
3640
|
+
getMenuHorizontalAlign():
|
|
3641
|
+
| MediaGalleryMenuHorizontalAlign
|
|
3642
|
+
| keyof typeof MediaGalleryMenuHorizontalAlign;
|
|
1673
3643
|
/**
|
|
1674
|
-
*
|
|
3644
|
+
* Gets current value of property {@link #getMenuVerticalAlign menuVerticalAlign}.
|
|
1675
3645
|
*
|
|
1676
|
-
*
|
|
3646
|
+
* Determines the vertical alignment of the thumbnails menu vs. the central display area.
|
|
1677
3647
|
*
|
|
1678
|
-
*
|
|
1679
|
-
*
|
|
1680
|
-
*
|
|
1681
|
-
* (between the `begin` and `mid` columns) will have when pointing to the left - `startArrowRightText`:
|
|
1682
|
-
* the text that the first arrow (between the `begin` and `mid` columns) will have when pointing to the
|
|
1683
|
-
* right - `endArrowLeftText`: the text that the second arrow (between the `mid` and `end` columns) will
|
|
1684
|
-
* have when pointing to the left - `endArrowRightText`: the text that the second arrow (between the `mid`
|
|
1685
|
-
* and `end` columns) will have when pointing to the right
|
|
3648
|
+
* Available options are:
|
|
3649
|
+
* - `Top`
|
|
3650
|
+
* - `Bottom`
|
|
1686
3651
|
*
|
|
1687
|
-
*
|
|
3652
|
+
* Default value is `Bottom`.
|
|
3653
|
+
*/
|
|
3654
|
+
getMenuVerticalAlign():
|
|
3655
|
+
| MediaGalleryMenuVerticalAlign
|
|
3656
|
+
| keyof typeof MediaGalleryMenuVerticalAlign;
|
|
3657
|
+
/**
|
|
3658
|
+
* Gets current value of property {@link #getShowAllThumbnails showAllThumbnails}.
|
|
1688
3659
|
*
|
|
1689
|
-
*
|
|
3660
|
+
* If set to `true`, all thumbnails are rendered in a scrollable container. If `false`, only up to five
|
|
3661
|
+
* thumbnails are rendered, followed by an overflow button that shows the count of the remaining thumbnails.
|
|
3662
|
+
*
|
|
3663
|
+
* Default value is `false`.
|
|
1690
3664
|
*/
|
|
1691
|
-
|
|
3665
|
+
getShowAllThumbnails(): boolean;
|
|
3666
|
+
/**
|
|
3667
|
+
* Checks for the provided `sap.ui.webc.fiori.IMediaGalleryItem` in the aggregation {@link #getItems items}.
|
|
3668
|
+
* and returns its index if found or -1 otherwise.
|
|
3669
|
+
*/
|
|
3670
|
+
indexOfItem(
|
|
1692
3671
|
/**
|
|
1693
|
-
*
|
|
3672
|
+
* The item whose index is looked for
|
|
1694
3673
|
*/
|
|
1695
|
-
|
|
1696
|
-
):
|
|
3674
|
+
oItem: IMediaGalleryItem
|
|
3675
|
+
): int;
|
|
1697
3676
|
/**
|
|
1698
|
-
*
|
|
3677
|
+
* Inserts a item into the aggregation {@link #getItems items}.
|
|
1699
3678
|
*/
|
|
1700
|
-
|
|
3679
|
+
insertItem(
|
|
1701
3680
|
/**
|
|
1702
|
-
* The
|
|
3681
|
+
* The item to insert; if empty, nothing is inserted
|
|
1703
3682
|
*/
|
|
1704
|
-
|
|
3683
|
+
oItem: IMediaGalleryItem,
|
|
3684
|
+
/**
|
|
3685
|
+
* The `0`-based index the item should be inserted at; for a negative value of `iIndex`, the item is inserted
|
|
3686
|
+
* at position 0; for a value greater than the current size of the aggregation, the item is inserted at
|
|
3687
|
+
* the last position
|
|
3688
|
+
*/
|
|
3689
|
+
iIndex: int
|
|
1705
3690
|
): this;
|
|
1706
3691
|
/**
|
|
1707
|
-
*
|
|
1708
|
-
*
|
|
1709
|
-
* Defines the height of the control
|
|
3692
|
+
* Removes all the controls from the aggregation {@link #getItems items}.
|
|
1710
3693
|
*
|
|
1711
|
-
*
|
|
3694
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
1712
3695
|
*/
|
|
1713
|
-
|
|
3696
|
+
removeAllItems(): IMediaGalleryItem[];
|
|
3697
|
+
/**
|
|
3698
|
+
* Removes a item from the aggregation {@link #getItems items}.
|
|
3699
|
+
*/
|
|
3700
|
+
removeItem(
|
|
1714
3701
|
/**
|
|
1715
|
-
*
|
|
3702
|
+
* The item to remove or its index or id
|
|
1716
3703
|
*/
|
|
1717
|
-
|
|
1718
|
-
):
|
|
3704
|
+
vItem: int | string | IMediaGalleryItem
|
|
3705
|
+
): IMediaGalleryItem;
|
|
1719
3706
|
/**
|
|
1720
|
-
* Sets a new value for property {@link #
|
|
3707
|
+
* Sets a new value for property {@link #getInteractiveDisplayArea interactiveDisplayArea}.
|
|
1721
3708
|
*
|
|
1722
|
-
*
|
|
3709
|
+
* If enabled, a `display-area-click` event is fired when the user clicks or taps on the display area.
|
|
3710
|
+
* The display area is the central area that contains the enlarged content of the currently selected item.
|
|
1723
3711
|
*
|
|
1724
3712
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1725
3713
|
*
|
|
1726
3714
|
* Default value is `false`.
|
|
1727
3715
|
*/
|
|
1728
|
-
|
|
3716
|
+
setInteractiveDisplayArea(
|
|
1729
3717
|
/**
|
|
1730
|
-
* New value for property `
|
|
3718
|
+
* New value for property `interactiveDisplayArea`
|
|
1731
3719
|
*/
|
|
1732
|
-
|
|
3720
|
+
bInteractiveDisplayArea?: boolean
|
|
1733
3721
|
): this;
|
|
1734
3722
|
/**
|
|
1735
3723
|
* Sets a new value for property {@link #getLayout layout}.
|
|
1736
3724
|
*
|
|
1737
|
-
*
|
|
1738
|
-
*
|
|
1739
|
-
* **Note:** The layout also depends on the screen size - one column for screens smaller than 599px, two
|
|
1740
|
-
* columns between 599px and 1023px and three columns for sizes bigger than 1023px.
|
|
3725
|
+
* Determines the layout of the component.
|
|
1741
3726
|
*
|
|
1742
3727
|
* Available options are:
|
|
1743
|
-
* - `
|
|
1744
|
-
* - `
|
|
1745
|
-
* - `
|
|
1746
|
-
* - `ThreeColumnsMidExpanded`
|
|
1747
|
-
* - `ThreeColumnsEndExpanded`
|
|
1748
|
-
* - `ThreeColumnsStartExpandedEndHidden`
|
|
1749
|
-
* - `ThreeColumnsMidExpandedEndHidden`
|
|
1750
|
-
* - `MidColumnFullScreen`
|
|
1751
|
-
* - `EndColumnFullScreen`
|
|
1752
|
-
*
|
|
1753
|
-
* **For example:** layout=`TwoColumnsStartExpanded` means the layout will display up to two columns in
|
|
1754
|
-
* 67%/33% proportion.
|
|
3728
|
+
* - `Auto`
|
|
3729
|
+
* - `Vertical`
|
|
3730
|
+
* - `Horizontal`
|
|
1755
3731
|
*
|
|
1756
3732
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1757
3733
|
*
|
|
1758
|
-
* Default value is `
|
|
3734
|
+
* Default value is `Auto`.
|
|
1759
3735
|
*/
|
|
1760
3736
|
setLayout(
|
|
1761
3737
|
/**
|
|
1762
3738
|
* New value for property `layout`
|
|
1763
3739
|
*/
|
|
1764
|
-
sLayout?:
|
|
3740
|
+
sLayout?: MediaGalleryLayout | keyof typeof MediaGalleryLayout
|
|
1765
3741
|
): this;
|
|
1766
3742
|
/**
|
|
1767
|
-
* Sets
|
|
3743
|
+
* Sets a new value for property {@link #getMenuHorizontalAlign menuHorizontalAlign}.
|
|
3744
|
+
*
|
|
3745
|
+
* Determines the horizontal alignment of the thumbnails menu vs. the central display area.
|
|
3746
|
+
*
|
|
3747
|
+
* Available options are:
|
|
3748
|
+
* - `Left`
|
|
3749
|
+
* - `Right`
|
|
3750
|
+
*
|
|
3751
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3752
|
+
*
|
|
3753
|
+
* Default value is `Left`.
|
|
1768
3754
|
*/
|
|
1769
|
-
|
|
3755
|
+
setMenuHorizontalAlign(
|
|
1770
3756
|
/**
|
|
1771
|
-
*
|
|
3757
|
+
* New value for property `menuHorizontalAlign`
|
|
1772
3758
|
*/
|
|
1773
|
-
|
|
3759
|
+
sMenuHorizontalAlign?:
|
|
3760
|
+
| MediaGalleryMenuHorizontalAlign
|
|
3761
|
+
| keyof typeof MediaGalleryMenuHorizontalAlign
|
|
1774
3762
|
): this;
|
|
1775
3763
|
/**
|
|
1776
|
-
* Sets
|
|
3764
|
+
* Sets a new value for property {@link #getMenuVerticalAlign menuVerticalAlign}.
|
|
3765
|
+
*
|
|
3766
|
+
* Determines the vertical alignment of the thumbnails menu vs. the central display area.
|
|
3767
|
+
*
|
|
3768
|
+
* Available options are:
|
|
3769
|
+
* - `Top`
|
|
3770
|
+
* - `Bottom`
|
|
3771
|
+
*
|
|
3772
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3773
|
+
*
|
|
3774
|
+
* Default value is `Bottom`.
|
|
1777
3775
|
*/
|
|
1778
|
-
|
|
3776
|
+
setMenuVerticalAlign(
|
|
1779
3777
|
/**
|
|
1780
|
-
*
|
|
3778
|
+
* New value for property `menuVerticalAlign`
|
|
1781
3779
|
*/
|
|
1782
|
-
|
|
3780
|
+
sMenuVerticalAlign?:
|
|
3781
|
+
| MediaGalleryMenuVerticalAlign
|
|
3782
|
+
| keyof typeof MediaGalleryMenuVerticalAlign
|
|
1783
3783
|
): this;
|
|
1784
3784
|
/**
|
|
1785
|
-
* Sets a new value for property {@link #
|
|
3785
|
+
* Sets a new value for property {@link #getShowAllThumbnails showAllThumbnails}.
|
|
1786
3786
|
*
|
|
1787
|
-
*
|
|
3787
|
+
* If set to `true`, all thumbnails are rendered in a scrollable container. If `false`, only up to five
|
|
3788
|
+
* thumbnails are rendered, followed by an overflow button that shows the count of the remaining thumbnails.
|
|
1788
3789
|
*
|
|
1789
3790
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3791
|
+
*
|
|
3792
|
+
* Default value is `false`.
|
|
1790
3793
|
*/
|
|
1791
|
-
|
|
3794
|
+
setShowAllThumbnails(
|
|
1792
3795
|
/**
|
|
1793
|
-
* New value for property `
|
|
3796
|
+
* New value for property `showAllThumbnails`
|
|
1794
3797
|
*/
|
|
1795
|
-
|
|
3798
|
+
bShowAllThumbnails?: boolean
|
|
1796
3799
|
): this;
|
|
1797
3800
|
}
|
|
1798
3801
|
|
|
1799
|
-
export interface $
|
|
3802
|
+
export interface $MediaGallerySettings extends $WebComponentSettings {
|
|
1800
3803
|
/**
|
|
1801
|
-
*
|
|
1802
|
-
*
|
|
1803
|
-
* It supports the following fields: - `startColumnAccessibleName`: the accessibility name for the `startColumn`
|
|
1804
|
-
* region - `midColumnAccessibleName`: the accessibility name for the `midColumn` region - `endColumnAccessibleName`:
|
|
1805
|
-
* the accessibility name for the `endColumn` region - `startArrowLeftText`: the text that the first arrow
|
|
1806
|
-
* (between the `begin` and `mid` columns) will have when pointing to the left - `startArrowRightText`:
|
|
1807
|
-
* the text that the first arrow (between the `begin` and `mid` columns) will have when pointing to the
|
|
1808
|
-
* right - `endArrowLeftText`: the text that the second arrow (between the `mid` and `end` columns) will
|
|
1809
|
-
* have when pointing to the left - `endArrowRightText`: the text that the second arrow (between the `mid`
|
|
1810
|
-
* and `end` columns) will have when pointing to the right
|
|
3804
|
+
* If enabled, a `display-area-click` event is fired when the user clicks or taps on the display area.
|
|
3805
|
+
* The display area is the central area that contains the enlarged content of the currently selected item.
|
|
1811
3806
|
*/
|
|
1812
|
-
|
|
3807
|
+
interactiveDisplayArea?: boolean | PropertyBindingInfo;
|
|
1813
3808
|
|
|
1814
3809
|
/**
|
|
1815
|
-
*
|
|
3810
|
+
* Determines the layout of the component.
|
|
3811
|
+
*
|
|
3812
|
+
* Available options are:
|
|
3813
|
+
* - `Auto`
|
|
3814
|
+
* - `Vertical`
|
|
3815
|
+
* - `Horizontal`
|
|
1816
3816
|
*/
|
|
1817
|
-
|
|
3817
|
+
layout?:
|
|
3818
|
+
| (MediaGalleryLayout | keyof typeof MediaGalleryLayout)
|
|
3819
|
+
| PropertyBindingInfo;
|
|
1818
3820
|
|
|
1819
3821
|
/**
|
|
1820
|
-
*
|
|
1821
|
-
|
|
1822
|
-
|
|
3822
|
+
* Determines the horizontal alignment of the thumbnails menu vs. the central display area.
|
|
3823
|
+
*
|
|
3824
|
+
* Available options are:
|
|
3825
|
+
* - `Left`
|
|
3826
|
+
* - `Right`
|
|
3827
|
+
*/
|
|
3828
|
+
menuHorizontalAlign?:
|
|
3829
|
+
| (
|
|
3830
|
+
| MediaGalleryMenuHorizontalAlign
|
|
3831
|
+
| keyof typeof MediaGalleryMenuHorizontalAlign
|
|
3832
|
+
)
|
|
3833
|
+
| PropertyBindingInfo;
|
|
1823
3834
|
|
|
1824
3835
|
/**
|
|
1825
|
-
*
|
|
1826
|
-
*
|
|
1827
|
-
* **Note:** The layout also depends on the screen size - one column for screens smaller than 599px, two
|
|
1828
|
-
* columns between 599px and 1023px and three columns for sizes bigger than 1023px.
|
|
3836
|
+
* Determines the vertical alignment of the thumbnails menu vs. the central display area.
|
|
1829
3837
|
*
|
|
1830
3838
|
* Available options are:
|
|
1831
|
-
* - `
|
|
1832
|
-
* - `
|
|
1833
|
-
|
|
1834
|
-
|
|
1835
|
-
|
|
1836
|
-
|
|
1837
|
-
|
|
1838
|
-
|
|
1839
|
-
|
|
1840
|
-
*
|
|
1841
|
-
* **For example:** layout=`TwoColumnsStartExpanded` means the layout will display up to two columns in
|
|
1842
|
-
* 67%/33% proportion.
|
|
1843
|
-
*/
|
|
1844
|
-
layout?: (FCLLayout | keyof typeof FCLLayout) | PropertyBindingInfo;
|
|
3839
|
+
* - `Top`
|
|
3840
|
+
* - `Bottom`
|
|
3841
|
+
*/
|
|
3842
|
+
menuVerticalAlign?:
|
|
3843
|
+
| (
|
|
3844
|
+
| MediaGalleryMenuVerticalAlign
|
|
3845
|
+
| keyof typeof MediaGalleryMenuVerticalAlign
|
|
3846
|
+
)
|
|
3847
|
+
| PropertyBindingInfo;
|
|
1845
3848
|
|
|
1846
3849
|
/**
|
|
1847
|
-
*
|
|
3850
|
+
* If set to `true`, all thumbnails are rendered in a scrollable container. If `false`, only up to five
|
|
3851
|
+
* thumbnails are rendered, followed by an overflow button that shows the count of the remaining thumbnails.
|
|
1848
3852
|
*/
|
|
1849
|
-
|
|
3853
|
+
showAllThumbnails?: boolean | PropertyBindingInfo;
|
|
1850
3854
|
|
|
1851
3855
|
/**
|
|
1852
|
-
* Defines the
|
|
3856
|
+
* Defines the component items.
|
|
3857
|
+
*
|
|
3858
|
+
*
|
|
3859
|
+
*
|
|
3860
|
+
* **Note:** Only one selected item is allowed.
|
|
3861
|
+
*
|
|
3862
|
+
*
|
|
3863
|
+
*
|
|
3864
|
+
* **Note:** Use the `sap.ui.webc.fiori.MediaGalleryItem` component to define the desired items.
|
|
1853
3865
|
*/
|
|
1854
|
-
|
|
3866
|
+
items?: IMediaGalleryItem[] | IMediaGalleryItem | AggregationBindingInfo;
|
|
1855
3867
|
|
|
1856
3868
|
/**
|
|
1857
|
-
*
|
|
3869
|
+
* Fired when the display area is clicked.
|
|
3870
|
+
* The display area is the central area that contains the enlarged content of the currently selected item.
|
|
1858
3871
|
*/
|
|
1859
|
-
|
|
3872
|
+
displayAreaClick?: (oEvent: Event) => void;
|
|
1860
3873
|
|
|
1861
3874
|
/**
|
|
1862
|
-
*
|
|
3875
|
+
* Fired when the thumbnails overflow button is clicked.
|
|
1863
3876
|
*/
|
|
1864
|
-
|
|
3877
|
+
overflowClick?: (oEvent: Event) => void;
|
|
1865
3878
|
|
|
1866
3879
|
/**
|
|
1867
|
-
* Fired when
|
|
1868
|
-
* size due to resizing.
|
|
3880
|
+
* Fired when selection is changed by user interaction.
|
|
1869
3881
|
*/
|
|
1870
|
-
|
|
3882
|
+
selectionChange?: (oEvent: Event) => void;
|
|
1871
3883
|
}
|
|
1872
3884
|
}
|
|
1873
3885
|
|
|
1874
|
-
declare module "sap/ui/webc/fiori/
|
|
3886
|
+
declare module "sap/ui/webc/fiori/MediaGalleryItem" {
|
|
1875
3887
|
import {
|
|
1876
3888
|
default as WebComponent,
|
|
1877
3889
|
$WebComponentSettings,
|
|
1878
3890
|
} from "sap/ui/webc/common/WebComponent";
|
|
1879
3891
|
|
|
1880
|
-
import {
|
|
1881
|
-
|
|
1882
|
-
|
|
1883
|
-
|
|
1884
|
-
import { IllustrationMessageType } from "sap/ui/webc/fiori/library";
|
|
3892
|
+
import {
|
|
3893
|
+
IMediaGalleryItem,
|
|
3894
|
+
MediaGalleryItemLayout,
|
|
3895
|
+
} from "sap/ui/webc/fiori/library";
|
|
1885
3896
|
|
|
1886
3897
|
import Control from "sap/ui/core/Control";
|
|
1887
3898
|
|
|
1888
|
-
import
|
|
1889
|
-
|
|
1890
|
-
|
|
1891
|
-
} from "sap/ui/base/ManagedObject";
|
|
3899
|
+
import WebComponentMetadata from "sap/ui/webc/common/WebComponentMetadata";
|
|
3900
|
+
|
|
3901
|
+
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
1892
3902
|
|
|
1893
3903
|
/**
|
|
1894
|
-
* @SINCE 1.
|
|
1895
|
-
* @EXPERIMENTAL (since 1.
|
|
3904
|
+
* @SINCE 1.99.0
|
|
3905
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
1896
3906
|
*
|
|
1897
|
-
* Overview:
|
|
1898
|
-
*
|
|
1899
|
-
* a message alone.
|
|
3907
|
+
* Overview: The `sap.ui.webc.fiori.MediaGalleryItem` web component represents the items displayed in the
|
|
3908
|
+
* `sap.ui.webc.fiori.MediaGallery` web component.
|
|
1900
3909
|
*
|
|
1901
|
-
*
|
|
1902
|
-
* `titleText` and `subtitleText` properties.
|
|
3910
|
+
* **Note:** `sap.ui.webc.fiori.MediaGalleryItem` is not supported when used outside of `sap.ui.webc.fiori.MediaGallery`.
|
|
1903
3911
|
*
|
|
1904
|
-
* Structure: The IllustratedMessage consists of the following elements, which are displayed below each
|
|
1905
|
-
* other in the following order:
|
|
1906
3912
|
*
|
|
1907
3913
|
*
|
|
1908
3914
|
*
|
|
1909
|
-
*
|
|
1910
|
-
*
|
|
1911
|
-
* - Subtitle
|
|
1912
|
-
* - Actions
|
|
3915
|
+
* Keyboard Handling: The `sap.ui.webc.fiori.MediaGallery` provides advanced keyboard handling. When focused,
|
|
3916
|
+
* the user can use the following keyboard shortcuts in order to perform a navigation:
|
|
1913
3917
|
*
|
|
1914
|
-
*
|
|
1915
|
-
*
|
|
3918
|
+
*
|
|
3919
|
+
*
|
|
3920
|
+
* - [SPACE/ENTER/RETURN] - Trigger `ui5-click` event
|
|
1916
3921
|
*/
|
|
1917
|
-
export default class
|
|
3922
|
+
export default class MediaGalleryItem
|
|
3923
|
+
extends WebComponent
|
|
3924
|
+
implements IMediaGalleryItem {
|
|
3925
|
+
__implements__sap_ui_webc_fiori_IMediaGalleryItem: boolean;
|
|
1918
3926
|
/**
|
|
1919
|
-
* Constructor for a new `
|
|
3927
|
+
* Constructor for a new `MediaGalleryItem`.
|
|
1920
3928
|
*
|
|
1921
3929
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1922
3930
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
@@ -1926,10 +3934,10 @@ declare module "sap/ui/webc/fiori/IllustratedMessage" {
|
|
|
1926
3934
|
/**
|
|
1927
3935
|
* Initial settings for the new control
|
|
1928
3936
|
*/
|
|
1929
|
-
mSettings?: $
|
|
3937
|
+
mSettings?: $MediaGalleryItemSettings
|
|
1930
3938
|
);
|
|
1931
3939
|
/**
|
|
1932
|
-
* Constructor for a new `
|
|
3940
|
+
* Constructor for a new `MediaGalleryItem`.
|
|
1933
3941
|
*
|
|
1934
3942
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1935
3943
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
@@ -1943,11 +3951,11 @@ declare module "sap/ui/webc/fiori/IllustratedMessage" {
|
|
|
1943
3951
|
/**
|
|
1944
3952
|
* Initial settings for the new control
|
|
1945
3953
|
*/
|
|
1946
|
-
mSettings?: $
|
|
3954
|
+
mSettings?: $MediaGalleryItemSettings
|
|
1947
3955
|
);
|
|
1948
3956
|
|
|
1949
3957
|
/**
|
|
1950
|
-
* Creates a new subclass of class sap.ui.webc.fiori.
|
|
3958
|
+
* Creates a new subclass of class sap.ui.webc.fiori.MediaGalleryItem with name `sClassName` and enriches
|
|
1951
3959
|
* it with the information contained in `oClassInfo`.
|
|
1952
3960
|
*
|
|
1953
3961
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
|
|
@@ -1960,7 +3968,7 @@ declare module "sap/ui/webc/fiori/IllustratedMessage" {
|
|
|
1960
3968
|
/**
|
|
1961
3969
|
* Object literal with information about the class
|
|
1962
3970
|
*/
|
|
1963
|
-
oClassInfo?: sap.ClassInfo<T,
|
|
3971
|
+
oClassInfo?: sap.ClassInfo<T, MediaGalleryItem>,
|
|
1964
3972
|
/**
|
|
1965
3973
|
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
1966
3974
|
* used by this class
|
|
@@ -1968,202 +3976,160 @@ declare module "sap/ui/webc/fiori/IllustratedMessage" {
|
|
|
1968
3976
|
FNMetaImpl?: Function
|
|
1969
3977
|
): Function;
|
|
1970
3978
|
/**
|
|
1971
|
-
* Returns a metadata object for class sap.ui.webc.fiori.
|
|
3979
|
+
* Returns a metadata object for class sap.ui.webc.fiori.MediaGalleryItem.
|
|
1972
3980
|
*/
|
|
1973
3981
|
static getMetadata(): WebComponentMetadata;
|
|
1974
3982
|
/**
|
|
1975
|
-
*
|
|
1976
|
-
*/
|
|
1977
|
-
addAction(
|
|
1978
|
-
/**
|
|
1979
|
-
* The action to add; if empty, nothing is inserted
|
|
1980
|
-
*/
|
|
1981
|
-
oAction: IButton
|
|
1982
|
-
): this;
|
|
1983
|
-
/**
|
|
1984
|
-
* Destroys all the actions in the aggregation {@link #getActions actions}.
|
|
1985
|
-
*/
|
|
1986
|
-
destroyActions(): this;
|
|
1987
|
-
/**
|
|
1988
|
-
* Destroys the subtitle in the aggregation {@link #getSubtitle subtitle}.
|
|
3983
|
+
* Destroys the content in the aggregation {@link #getContent content}.
|
|
1989
3984
|
*/
|
|
1990
|
-
|
|
3985
|
+
destroyContent(): this;
|
|
1991
3986
|
/**
|
|
1992
|
-
*
|
|
1993
|
-
*
|
|
1994
|
-
* Defines the component actions.
|
|
3987
|
+
* Destroys the thumbnail in the aggregation {@link #getThumbnail thumbnail}.
|
|
1995
3988
|
*/
|
|
1996
|
-
|
|
3989
|
+
destroyThumbnail(): this;
|
|
1997
3990
|
/**
|
|
1998
|
-
* Gets
|
|
3991
|
+
* Gets content of aggregation {@link #getContent content}.
|
|
1999
3992
|
*
|
|
2000
|
-
*
|
|
3993
|
+
* Defines the content of the component.
|
|
2001
3994
|
*/
|
|
2002
|
-
|
|
3995
|
+
getContent(): Control;
|
|
2003
3996
|
/**
|
|
2004
|
-
* Gets
|
|
3997
|
+
* Gets current value of property {@link #getEnabled enabled}.
|
|
2005
3998
|
*
|
|
2006
|
-
* Defines the
|
|
3999
|
+
* Defines whether the control is enabled. A disabled control can't be interacted with, and it is not in
|
|
4000
|
+
* the tab chain.
|
|
2007
4001
|
*
|
|
2008
|
-
*
|
|
2009
|
-
* property will be overwritten.
|
|
4002
|
+
* Default value is `true`.
|
|
2010
4003
|
*/
|
|
2011
|
-
|
|
4004
|
+
getEnabled(): boolean;
|
|
2012
4005
|
/**
|
|
2013
|
-
* Gets current value of property {@link #
|
|
2014
|
-
*
|
|
2015
|
-
* Defines the subtitle of the component.
|
|
4006
|
+
* Gets current value of property {@link #getLayout layout}.
|
|
2016
4007
|
*
|
|
2017
|
-
*
|
|
4008
|
+
* Determines the layout of the item container.
|
|
2018
4009
|
*
|
|
2019
|
-
*
|
|
4010
|
+
* Available options are:
|
|
4011
|
+
* - `Square`
|
|
4012
|
+
* - `Wide`
|
|
2020
4013
|
*
|
|
2021
|
-
* Default value is `
|
|
4014
|
+
* Default value is `Square`.
|
|
2022
4015
|
*/
|
|
2023
|
-
|
|
4016
|
+
getLayout(): MediaGalleryItemLayout | keyof typeof MediaGalleryItemLayout;
|
|
2024
4017
|
/**
|
|
2025
|
-
* Gets current value of property {@link #
|
|
2026
|
-
*
|
|
2027
|
-
* Defines the title of the component.
|
|
4018
|
+
* Gets current value of property {@link #getSelected selected}.
|
|
2028
4019
|
*
|
|
2029
|
-
*
|
|
4020
|
+
* Defines the selected state of the component.
|
|
2030
4021
|
*
|
|
2031
|
-
* Default value is `
|
|
4022
|
+
* Default value is `false`.
|
|
2032
4023
|
*/
|
|
2033
|
-
|
|
4024
|
+
getSelected(): boolean;
|
|
2034
4025
|
/**
|
|
2035
|
-
*
|
|
2036
|
-
*
|
|
4026
|
+
* Gets content of aggregation {@link #getThumbnail thumbnail}.
|
|
4027
|
+
*
|
|
4028
|
+
* Defines the content of the thumbnail.
|
|
2037
4029
|
*/
|
|
2038
|
-
|
|
2039
|
-
/**
|
|
2040
|
-
* The action whose index is looked for
|
|
2041
|
-
*/
|
|
2042
|
-
oAction: IButton
|
|
2043
|
-
): int;
|
|
4030
|
+
getThumbnail(): Control;
|
|
2044
4031
|
/**
|
|
2045
|
-
*
|
|
4032
|
+
* Sets the aggregated {@link #getContent content}.
|
|
2046
4033
|
*/
|
|
2047
|
-
|
|
2048
|
-
/**
|
|
2049
|
-
* The action to insert; if empty, nothing is inserted
|
|
2050
|
-
*/
|
|
2051
|
-
oAction: IButton,
|
|
4034
|
+
setContent(
|
|
2052
4035
|
/**
|
|
2053
|
-
* The
|
|
2054
|
-
* inserted at position 0; for a value greater than the current size of the aggregation, the action is inserted
|
|
2055
|
-
* at the last position
|
|
4036
|
+
* The content to set
|
|
2056
4037
|
*/
|
|
2057
|
-
|
|
4038
|
+
oContent: Control
|
|
2058
4039
|
): this;
|
|
2059
4040
|
/**
|
|
2060
|
-
*
|
|
2061
|
-
*/
|
|
2062
|
-
removeAction(
|
|
2063
|
-
/**
|
|
2064
|
-
* The action to remove or its index or id
|
|
2065
|
-
*/
|
|
2066
|
-
vAction: int | string | IButton
|
|
2067
|
-
): IButton;
|
|
2068
|
-
/**
|
|
2069
|
-
* Removes all the controls from the aggregation {@link #getActions actions}.
|
|
4041
|
+
* Sets a new value for property {@link #getEnabled enabled}.
|
|
2070
4042
|
*
|
|
2071
|
-
*
|
|
2072
|
-
|
|
2073
|
-
removeAllActions(): IButton[];
|
|
2074
|
-
/**
|
|
2075
|
-
* Sets a new value for property {@link #getName name}.
|
|
4043
|
+
* Defines whether the control is enabled. A disabled control can't be interacted with, and it is not in
|
|
4044
|
+
* the tab chain.
|
|
2076
4045
|
*
|
|
2077
4046
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2078
4047
|
*
|
|
2079
|
-
* Default value is `
|
|
2080
|
-
*/
|
|
2081
|
-
setName(
|
|
2082
|
-
/**
|
|
2083
|
-
* New value for property `name`
|
|
2084
|
-
*/
|
|
2085
|
-
sName?: IllustrationMessageType | keyof typeof IllustrationMessageType
|
|
2086
|
-
): this;
|
|
2087
|
-
/**
|
|
2088
|
-
* Sets the aggregated {@link #getSubtitle subtitle}.
|
|
4048
|
+
* Default value is `true`.
|
|
2089
4049
|
*/
|
|
2090
|
-
|
|
4050
|
+
setEnabled(
|
|
2091
4051
|
/**
|
|
2092
|
-
*
|
|
4052
|
+
* New value for property `enabled`
|
|
2093
4053
|
*/
|
|
2094
|
-
|
|
4054
|
+
bEnabled?: boolean
|
|
2095
4055
|
): this;
|
|
2096
4056
|
/**
|
|
2097
|
-
* Sets a new value for property {@link #
|
|
2098
|
-
*
|
|
2099
|
-
* Defines the subtitle of the component.
|
|
4057
|
+
* Sets a new value for property {@link #getLayout layout}.
|
|
2100
4058
|
*
|
|
2101
|
-
*
|
|
4059
|
+
* Determines the layout of the item container.
|
|
2102
4060
|
*
|
|
2103
|
-
*
|
|
4061
|
+
* Available options are:
|
|
4062
|
+
* - `Square`
|
|
4063
|
+
* - `Wide`
|
|
2104
4064
|
*
|
|
2105
4065
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2106
4066
|
*
|
|
2107
|
-
* Default value is `
|
|
4067
|
+
* Default value is `Square`.
|
|
2108
4068
|
*/
|
|
2109
|
-
|
|
4069
|
+
setLayout(
|
|
2110
4070
|
/**
|
|
2111
|
-
* New value for property `
|
|
4071
|
+
* New value for property `layout`
|
|
2112
4072
|
*/
|
|
2113
|
-
|
|
4073
|
+
sLayout?: MediaGalleryItemLayout | keyof typeof MediaGalleryItemLayout
|
|
2114
4074
|
): this;
|
|
2115
4075
|
/**
|
|
2116
|
-
* Sets a new value for property {@link #
|
|
2117
|
-
*
|
|
2118
|
-
* Defines the title of the component.
|
|
4076
|
+
* Sets a new value for property {@link #getSelected selected}.
|
|
2119
4077
|
*
|
|
2120
|
-
*
|
|
4078
|
+
* Defines the selected state of the component.
|
|
2121
4079
|
*
|
|
2122
4080
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2123
4081
|
*
|
|
2124
|
-
* Default value is `
|
|
4082
|
+
* Default value is `false`.
|
|
2125
4083
|
*/
|
|
2126
|
-
|
|
4084
|
+
setSelected(
|
|
2127
4085
|
/**
|
|
2128
|
-
* New value for property `
|
|
4086
|
+
* New value for property `selected`
|
|
2129
4087
|
*/
|
|
2130
|
-
|
|
4088
|
+
bSelected?: boolean
|
|
4089
|
+
): this;
|
|
4090
|
+
/**
|
|
4091
|
+
* Sets the aggregated {@link #getThumbnail thumbnail}.
|
|
4092
|
+
*/
|
|
4093
|
+
setThumbnail(
|
|
4094
|
+
/**
|
|
4095
|
+
* The thumbnail to set
|
|
4096
|
+
*/
|
|
4097
|
+
oThumbnail: Control
|
|
2131
4098
|
): this;
|
|
2132
4099
|
}
|
|
2133
4100
|
|
|
2134
|
-
export interface $
|
|
2135
|
-
|
|
2136
|
-
|
|
2137
|
-
|
|
4101
|
+
export interface $MediaGalleryItemSettings extends $WebComponentSettings {
|
|
4102
|
+
/**
|
|
4103
|
+
* Defines whether the control is enabled. A disabled control can't be interacted with, and it is not in
|
|
4104
|
+
* the tab chain.
|
|
4105
|
+
*/
|
|
4106
|
+
enabled?: boolean | PropertyBindingInfo;
|
|
2138
4107
|
|
|
2139
4108
|
/**
|
|
2140
|
-
*
|
|
2141
|
-
*
|
|
2142
|
-
* **Note:** Using this property, the default subtitle text of illustration will be overwritten.
|
|
4109
|
+
* Determines the layout of the item container.
|
|
2143
4110
|
*
|
|
2144
|
-
*
|
|
4111
|
+
* Available options are:
|
|
4112
|
+
* - `Square`
|
|
4113
|
+
* - `Wide`
|
|
2145
4114
|
*/
|
|
2146
|
-
|
|
4115
|
+
layout?:
|
|
4116
|
+
| (MediaGalleryItemLayout | keyof typeof MediaGalleryItemLayout)
|
|
4117
|
+
| PropertyBindingInfo;
|
|
2147
4118
|
|
|
2148
4119
|
/**
|
|
2149
|
-
* Defines the
|
|
2150
|
-
*
|
|
2151
|
-
* **Note:** Using this property, the default title text of illustration will be overwritten.
|
|
4120
|
+
* Defines the selected state of the component.
|
|
2152
4121
|
*/
|
|
2153
|
-
|
|
4122
|
+
selected?: boolean | PropertyBindingInfo;
|
|
2154
4123
|
|
|
2155
4124
|
/**
|
|
2156
|
-
* Defines the component
|
|
4125
|
+
* Defines the content of the component.
|
|
2157
4126
|
*/
|
|
2158
|
-
|
|
4127
|
+
content?: Control;
|
|
2159
4128
|
|
|
2160
4129
|
/**
|
|
2161
|
-
* Defines the
|
|
2162
|
-
*
|
|
2163
|
-
* **Note:** Using this slot, the default subtitle text of illustration and the value of `subtitleText`
|
|
2164
|
-
* property will be overwritten.
|
|
4130
|
+
* Defines the content of the thumbnail.
|
|
2165
4131
|
*/
|
|
2166
|
-
|
|
4132
|
+
thumbnail?: Control;
|
|
2167
4133
|
}
|
|
2168
4134
|
}
|
|
2169
4135
|
|
|
@@ -2266,15 +4232,14 @@ declare module "sap/ui/webc/fiori/NotificationAction" {
|
|
|
2266
4232
|
*/
|
|
2267
4233
|
getDesign(): ButtonDesign | keyof typeof ButtonDesign;
|
|
2268
4234
|
/**
|
|
2269
|
-
* Gets current value of property {@link #
|
|
2270
|
-
*
|
|
2271
|
-
* Defines if the action is disabled.
|
|
4235
|
+
* Gets current value of property {@link #getEnabled enabled}.
|
|
2272
4236
|
*
|
|
2273
|
-
*
|
|
4237
|
+
* Defines whether the control is enabled. A disabled control can't be interacted with, and it is not in
|
|
4238
|
+
* the tab chain.
|
|
2274
4239
|
*
|
|
2275
|
-
* Default value is `
|
|
4240
|
+
* Default value is `true`.
|
|
2276
4241
|
*/
|
|
2277
|
-
|
|
4242
|
+
getEnabled(): boolean;
|
|
2278
4243
|
/**
|
|
2279
4244
|
* Gets current value of property {@link #getIcon icon}.
|
|
2280
4245
|
*
|
|
@@ -2319,21 +4284,20 @@ declare module "sap/ui/webc/fiori/NotificationAction" {
|
|
|
2319
4284
|
sDesign?: ButtonDesign | keyof typeof ButtonDesign
|
|
2320
4285
|
): this;
|
|
2321
4286
|
/**
|
|
2322
|
-
* Sets a new value for property {@link #
|
|
4287
|
+
* Sets a new value for property {@link #getEnabled enabled}.
|
|
2323
4288
|
*
|
|
2324
|
-
* Defines
|
|
2325
|
-
*
|
|
2326
|
-
* **Note:** a disabled action can't be pressed or focused, and it is not in the tab chain.
|
|
4289
|
+
* Defines whether the control is enabled. A disabled control can't be interacted with, and it is not in
|
|
4290
|
+
* the tab chain.
|
|
2327
4291
|
*
|
|
2328
4292
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2329
4293
|
*
|
|
2330
|
-
* Default value is `
|
|
4294
|
+
* Default value is `true`.
|
|
2331
4295
|
*/
|
|
2332
|
-
|
|
4296
|
+
setEnabled(
|
|
2333
4297
|
/**
|
|
2334
|
-
* New value for property `
|
|
4298
|
+
* New value for property `enabled`
|
|
2335
4299
|
*/
|
|
2336
|
-
|
|
4300
|
+
bEnabled?: boolean
|
|
2337
4301
|
): this;
|
|
2338
4302
|
/**
|
|
2339
4303
|
* Sets a new value for property {@link #getIcon icon}.
|
|
@@ -2386,11 +4350,10 @@ declare module "sap/ui/webc/fiori/NotificationAction" {
|
|
|
2386
4350
|
design?: (ButtonDesign | keyof typeof ButtonDesign) | PropertyBindingInfo;
|
|
2387
4351
|
|
|
2388
4352
|
/**
|
|
2389
|
-
* Defines
|
|
2390
|
-
*
|
|
2391
|
-
* **Note:** a disabled action can't be pressed or focused, and it is not in the tab chain.
|
|
4353
|
+
* Defines whether the control is enabled. A disabled control can't be interacted with, and it is not in
|
|
4354
|
+
* the tab chain.
|
|
2392
4355
|
*/
|
|
2393
|
-
|
|
4356
|
+
enabled?: boolean | PropertyBindingInfo;
|
|
2394
4357
|
|
|
2395
4358
|
/**
|
|
2396
4359
|
* Defines the `icon` source URI.
|
|
@@ -3676,7 +5639,7 @@ declare module "sap/ui/webc/fiori/Page" {
|
|
|
3676
5639
|
|
|
3677
5640
|
import Control from "sap/ui/core/Control";
|
|
3678
5641
|
|
|
3679
|
-
import { PageBackgroundDesign } from "sap/ui/webc/fiori/library";
|
|
5642
|
+
import { PageBackgroundDesign, IBar } from "sap/ui/webc/fiori/library";
|
|
3680
5643
|
|
|
3681
5644
|
import { CSSSize } from "sap/ui/core/library";
|
|
3682
5645
|
|
|
@@ -3771,34 +5734,16 @@ declare module "sap/ui/webc/fiori/Page" {
|
|
|
3771
5734
|
*/
|
|
3772
5735
|
oContent: Control
|
|
3773
5736
|
): this;
|
|
3774
|
-
/**
|
|
3775
|
-
* Adds some footer to the aggregation {@link #getFooter footer}.
|
|
3776
|
-
*/
|
|
3777
|
-
addFooter(
|
|
3778
|
-
/**
|
|
3779
|
-
* The footer to add; if empty, nothing is inserted
|
|
3780
|
-
*/
|
|
3781
|
-
oFooter: Control
|
|
3782
|
-
): this;
|
|
3783
|
-
/**
|
|
3784
|
-
* Adds some header to the aggregation {@link #getHeader header}.
|
|
3785
|
-
*/
|
|
3786
|
-
addHeader(
|
|
3787
|
-
/**
|
|
3788
|
-
* The header to add; if empty, nothing is inserted
|
|
3789
|
-
*/
|
|
3790
|
-
oHeader: Control
|
|
3791
|
-
): this;
|
|
3792
5737
|
/**
|
|
3793
5738
|
* Destroys all the content in the aggregation {@link #getContent content}.
|
|
3794
5739
|
*/
|
|
3795
5740
|
destroyContent(): this;
|
|
3796
5741
|
/**
|
|
3797
|
-
* Destroys
|
|
5742
|
+
* Destroys the footer in the aggregation {@link #getFooter footer}.
|
|
3798
5743
|
*/
|
|
3799
5744
|
destroyFooter(): this;
|
|
3800
5745
|
/**
|
|
3801
|
-
* Destroys
|
|
5746
|
+
* Destroys the header in the aggregation {@link #getHeader header}.
|
|
3802
5747
|
*/
|
|
3803
5748
|
destroyHeader(): this;
|
|
3804
5749
|
/**
|
|
@@ -3849,13 +5794,13 @@ declare module "sap/ui/webc/fiori/Page" {
|
|
|
3849
5794
|
*
|
|
3850
5795
|
* Defines the footer HTML Element.
|
|
3851
5796
|
*/
|
|
3852
|
-
getFooter():
|
|
5797
|
+
getFooter(): IBar;
|
|
3853
5798
|
/**
|
|
3854
5799
|
* Gets content of aggregation {@link #getHeader header}.
|
|
3855
5800
|
*
|
|
3856
5801
|
* Defines the header HTML Element.
|
|
3857
5802
|
*/
|
|
3858
|
-
getHeader():
|
|
5803
|
+
getHeader(): IBar;
|
|
3859
5804
|
/**
|
|
3860
5805
|
* Gets current value of property {@link #getHeight height}.
|
|
3861
5806
|
*
|
|
@@ -3886,26 +5831,6 @@ declare module "sap/ui/webc/fiori/Page" {
|
|
|
3886
5831
|
*/
|
|
3887
5832
|
oContent: Control
|
|
3888
5833
|
): int;
|
|
3889
|
-
/**
|
|
3890
|
-
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getFooter footer}. and returns
|
|
3891
|
-
* its index if found or -1 otherwise.
|
|
3892
|
-
*/
|
|
3893
|
-
indexOfFooter(
|
|
3894
|
-
/**
|
|
3895
|
-
* The footer whose index is looked for
|
|
3896
|
-
*/
|
|
3897
|
-
oFooter: Control
|
|
3898
|
-
): int;
|
|
3899
|
-
/**
|
|
3900
|
-
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getHeader header}. and returns
|
|
3901
|
-
* its index if found or -1 otherwise.
|
|
3902
|
-
*/
|
|
3903
|
-
indexOfHeader(
|
|
3904
|
-
/**
|
|
3905
|
-
* The header whose index is looked for
|
|
3906
|
-
*/
|
|
3907
|
-
oHeader: Control
|
|
3908
|
-
): int;
|
|
3909
5834
|
/**
|
|
3910
5835
|
* Inserts a content into the aggregation {@link #getContent content}.
|
|
3911
5836
|
*/
|
|
@@ -3921,54 +5846,12 @@ declare module "sap/ui/webc/fiori/Page" {
|
|
|
3921
5846
|
*/
|
|
3922
5847
|
iIndex: int
|
|
3923
5848
|
): this;
|
|
3924
|
-
/**
|
|
3925
|
-
* Inserts a footer into the aggregation {@link #getFooter footer}.
|
|
3926
|
-
*/
|
|
3927
|
-
insertFooter(
|
|
3928
|
-
/**
|
|
3929
|
-
* The footer to insert; if empty, nothing is inserted
|
|
3930
|
-
*/
|
|
3931
|
-
oFooter: Control,
|
|
3932
|
-
/**
|
|
3933
|
-
* The `0`-based index the footer should be inserted at; for a negative value of `iIndex`, the footer is
|
|
3934
|
-
* inserted at position 0; for a value greater than the current size of the aggregation, the footer is inserted
|
|
3935
|
-
* at the last position
|
|
3936
|
-
*/
|
|
3937
|
-
iIndex: int
|
|
3938
|
-
): this;
|
|
3939
|
-
/**
|
|
3940
|
-
* Inserts a header into the aggregation {@link #getHeader header}.
|
|
3941
|
-
*/
|
|
3942
|
-
insertHeader(
|
|
3943
|
-
/**
|
|
3944
|
-
* The header to insert; if empty, nothing is inserted
|
|
3945
|
-
*/
|
|
3946
|
-
oHeader: Control,
|
|
3947
|
-
/**
|
|
3948
|
-
* The `0`-based index the header should be inserted at; for a negative value of `iIndex`, the header is
|
|
3949
|
-
* inserted at position 0; for a value greater than the current size of the aggregation, the header is inserted
|
|
3950
|
-
* at the last position
|
|
3951
|
-
*/
|
|
3952
|
-
iIndex: int
|
|
3953
|
-
): this;
|
|
3954
5849
|
/**
|
|
3955
5850
|
* Removes all the controls from the aggregation {@link #getContent content}.
|
|
3956
5851
|
*
|
|
3957
5852
|
* Additionally, it unregisters them from the hosting UIArea.
|
|
3958
5853
|
*/
|
|
3959
5854
|
removeAllContent(): Control[];
|
|
3960
|
-
/**
|
|
3961
|
-
* Removes all the controls from the aggregation {@link #getFooter footer}.
|
|
3962
|
-
*
|
|
3963
|
-
* Additionally, it unregisters them from the hosting UIArea.
|
|
3964
|
-
*/
|
|
3965
|
-
removeAllFooter(): Control[];
|
|
3966
|
-
/**
|
|
3967
|
-
* Removes all the controls from the aggregation {@link #getHeader header}.
|
|
3968
|
-
*
|
|
3969
|
-
* Additionally, it unregisters them from the hosting UIArea.
|
|
3970
|
-
*/
|
|
3971
|
-
removeAllHeader(): Control[];
|
|
3972
5855
|
/**
|
|
3973
5856
|
* Removes a content from the aggregation {@link #getContent content}.
|
|
3974
5857
|
*/
|
|
@@ -3978,24 +5861,6 @@ declare module "sap/ui/webc/fiori/Page" {
|
|
|
3978
5861
|
*/
|
|
3979
5862
|
vContent: int | string | Control
|
|
3980
5863
|
): Control;
|
|
3981
|
-
/**
|
|
3982
|
-
* Removes a footer from the aggregation {@link #getFooter footer}.
|
|
3983
|
-
*/
|
|
3984
|
-
removeFooter(
|
|
3985
|
-
/**
|
|
3986
|
-
* The footer to remove or its index or id
|
|
3987
|
-
*/
|
|
3988
|
-
vFooter: int | string | Control
|
|
3989
|
-
): Control;
|
|
3990
|
-
/**
|
|
3991
|
-
* Removes a header from the aggregation {@link #getHeader header}.
|
|
3992
|
-
*/
|
|
3993
|
-
removeHeader(
|
|
3994
|
-
/**
|
|
3995
|
-
* The header to remove or its index or id
|
|
3996
|
-
*/
|
|
3997
|
-
vHeader: int | string | Control
|
|
3998
|
-
): Control;
|
|
3999
5864
|
/**
|
|
4000
5865
|
* Sets a new value for property {@link #getBackgroundDesign backgroundDesign}.
|
|
4001
5866
|
*
|
|
@@ -4054,6 +5919,24 @@ declare module "sap/ui/webc/fiori/Page" {
|
|
|
4054
5919
|
*/
|
|
4055
5920
|
bFloatingFooter?: boolean
|
|
4056
5921
|
): this;
|
|
5922
|
+
/**
|
|
5923
|
+
* Sets the aggregated {@link #getFooter footer}.
|
|
5924
|
+
*/
|
|
5925
|
+
setFooter(
|
|
5926
|
+
/**
|
|
5927
|
+
* The footer to set
|
|
5928
|
+
*/
|
|
5929
|
+
oFooter: IBar
|
|
5930
|
+
): this;
|
|
5931
|
+
/**
|
|
5932
|
+
* Sets the aggregated {@link #getHeader header}.
|
|
5933
|
+
*/
|
|
5934
|
+
setHeader(
|
|
5935
|
+
/**
|
|
5936
|
+
* The header to set
|
|
5937
|
+
*/
|
|
5938
|
+
oHeader: IBar
|
|
5939
|
+
): this;
|
|
4057
5940
|
/**
|
|
4058
5941
|
* Sets a new value for property {@link #getHeight height}.
|
|
4059
5942
|
*
|
|
@@ -4065,7 +5948,7 @@ declare module "sap/ui/webc/fiori/Page" {
|
|
|
4065
5948
|
/**
|
|
4066
5949
|
* New value for property `height`
|
|
4067
5950
|
*/
|
|
4068
|
-
sHeight
|
|
5951
|
+
sHeight: CSSSize
|
|
4069
5952
|
): this;
|
|
4070
5953
|
/**
|
|
4071
5954
|
* Sets a new value for property {@link #getHideFooter hideFooter}.
|
|
@@ -4093,7 +5976,7 @@ declare module "sap/ui/webc/fiori/Page" {
|
|
|
4093
5976
|
/**
|
|
4094
5977
|
* New value for property `width`
|
|
4095
5978
|
*/
|
|
4096
|
-
sWidth
|
|
5979
|
+
sWidth: CSSSize
|
|
4097
5980
|
): this;
|
|
4098
5981
|
}
|
|
4099
5982
|
|
|
@@ -4149,12 +6032,12 @@ declare module "sap/ui/webc/fiori/Page" {
|
|
|
4149
6032
|
/**
|
|
4150
6033
|
* Defines the footer HTML Element.
|
|
4151
6034
|
*/
|
|
4152
|
-
footer?:
|
|
6035
|
+
footer?: IBar;
|
|
4153
6036
|
|
|
4154
6037
|
/**
|
|
4155
6038
|
* Defines the header HTML Element.
|
|
4156
6039
|
*/
|
|
4157
|
-
header?:
|
|
6040
|
+
header?: IBar;
|
|
4158
6041
|
}
|
|
4159
6042
|
}
|
|
4160
6043
|
|
|
@@ -4725,6 +6608,8 @@ declare module "sap/ui/webc/fiori/ShellBar" {
|
|
|
4725
6608
|
* allow developers to style elements inside the Shadow DOM.
|
|
4726
6609
|
* The `sap.ui.webc.fiori.ShellBar` exposes the following CSS Shadow Parts:
|
|
4727
6610
|
* - root - Used to style the outermost wrapper of the `sap.ui.webc.fiori.ShellBar`
|
|
6611
|
+
*
|
|
6612
|
+
* Keyboard Handling:
|
|
4728
6613
|
*/
|
|
4729
6614
|
export default class ShellBar extends WebComponent {
|
|
4730
6615
|
/**
|
|
@@ -4889,7 +6774,7 @@ declare module "sap/ui/webc/fiori/ShellBar" {
|
|
|
4889
6774
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
4890
6775
|
* otherwise it will be bound to this `sap.ui.webc.fiori.ShellBar` itself.
|
|
4891
6776
|
*
|
|
4892
|
-
* Fired, when a menu item is activated **Note:** You can prevent closing of
|
|
6777
|
+
* Fired, when a menu item is activated **Note:** You can prevent closing of overflow popover by calling
|
|
4893
6778
|
* `event.preventDefault()`.
|
|
4894
6779
|
*/
|
|
4895
6780
|
attachMenuItemClick(
|
|
@@ -4913,7 +6798,7 @@ declare module "sap/ui/webc/fiori/ShellBar" {
|
|
|
4913
6798
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
4914
6799
|
* otherwise it will be bound to this `sap.ui.webc.fiori.ShellBar` itself.
|
|
4915
6800
|
*
|
|
4916
|
-
* Fired, when a menu item is activated **Note:** You can prevent closing of
|
|
6801
|
+
* Fired, when a menu item is activated **Note:** You can prevent closing of overflow popover by calling
|
|
4917
6802
|
* `event.preventDefault()`.
|
|
4918
6803
|
*/
|
|
4919
6804
|
attachMenuItemClick(
|
|
@@ -4976,7 +6861,7 @@ declare module "sap/ui/webc/fiori/ShellBar" {
|
|
|
4976
6861
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
4977
6862
|
* otherwise it will be bound to this `sap.ui.webc.fiori.ShellBar` itself.
|
|
4978
6863
|
*
|
|
4979
|
-
* Fired, when the product switch icon is activated. **Note:** You can prevent closing of
|
|
6864
|
+
* Fired, when the product switch icon is activated. **Note:** You can prevent closing of overflow popover
|
|
4980
6865
|
* by calling `event.preventDefault()`.
|
|
4981
6866
|
*/
|
|
4982
6867
|
attachProductSwitchClick(
|
|
@@ -5001,7 +6886,7 @@ declare module "sap/ui/webc/fiori/ShellBar" {
|
|
|
5001
6886
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
5002
6887
|
* otherwise it will be bound to this `sap.ui.webc.fiori.ShellBar` itself.
|
|
5003
6888
|
*
|
|
5004
|
-
* Fired, when the product switch icon is activated. **Note:** You can prevent closing of
|
|
6889
|
+
* Fired, when the product switch icon is activated. **Note:** You can prevent closing of overflow popover
|
|
5005
6890
|
* by calling `event.preventDefault()`.
|
|
5006
6891
|
*/
|
|
5007
6892
|
attachProductSwitchClick(
|
|
@@ -5267,6 +7152,17 @@ declare module "sap/ui/webc/fiori/ShellBar" {
|
|
|
5267
7152
|
targetRef?: HTMLElement;
|
|
5268
7153
|
}
|
|
5269
7154
|
): this;
|
|
7155
|
+
/**
|
|
7156
|
+
* Gets current value of property {@link #getAccessibilityTexts accessibilityTexts}.
|
|
7157
|
+
*
|
|
7158
|
+
* An object of strings that defines several additional accessibility texts for even further customization.
|
|
7159
|
+
*
|
|
7160
|
+
* It supports the following fields: - `profileButtonTitle`: defines the tooltip for the profile button
|
|
7161
|
+
* - `logoTitle`: defines the tooltip for the logo
|
|
7162
|
+
*
|
|
7163
|
+
* Default value is `{}`.
|
|
7164
|
+
*/
|
|
7165
|
+
getAccessibilityTexts(): object;
|
|
5270
7166
|
/**
|
|
5271
7167
|
* Returns the `copilot` DOM ref.
|
|
5272
7168
|
*/
|
|
@@ -5471,6 +7367,24 @@ declare module "sap/ui/webc/fiori/ShellBar" {
|
|
|
5471
7367
|
*/
|
|
5472
7368
|
vMenuItem: int | string | IListItem
|
|
5473
7369
|
): IListItem;
|
|
7370
|
+
/**
|
|
7371
|
+
* Sets a new value for property {@link #getAccessibilityTexts accessibilityTexts}.
|
|
7372
|
+
*
|
|
7373
|
+
* An object of strings that defines several additional accessibility texts for even further customization.
|
|
7374
|
+
*
|
|
7375
|
+
* It supports the following fields: - `profileButtonTitle`: defines the tooltip for the profile button
|
|
7376
|
+
* - `logoTitle`: defines the tooltip for the logo
|
|
7377
|
+
*
|
|
7378
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
7379
|
+
*
|
|
7380
|
+
* Default value is `{}`.
|
|
7381
|
+
*/
|
|
7382
|
+
setAccessibilityTexts(
|
|
7383
|
+
/**
|
|
7384
|
+
* New value for property `accessibilityTexts`
|
|
7385
|
+
*/
|
|
7386
|
+
oAccessibilityTexts?: object
|
|
7387
|
+
): this;
|
|
5474
7388
|
/**
|
|
5475
7389
|
* Sets the aggregated {@link #getLogo logo}.
|
|
5476
7390
|
*/
|
|
@@ -5606,6 +7520,14 @@ declare module "sap/ui/webc/fiori/ShellBar" {
|
|
|
5606
7520
|
}
|
|
5607
7521
|
|
|
5608
7522
|
export interface $ShellBarSettings extends $WebComponentSettings {
|
|
7523
|
+
/**
|
|
7524
|
+
* An object of strings that defines several additional accessibility texts for even further customization.
|
|
7525
|
+
*
|
|
7526
|
+
* It supports the following fields: - `profileButtonTitle`: defines the tooltip for the profile button
|
|
7527
|
+
* - `logoTitle`: defines the tooltip for the logo
|
|
7528
|
+
*/
|
|
7529
|
+
accessibilityTexts?: object | PropertyBindingInfo;
|
|
7530
|
+
|
|
5609
7531
|
/**
|
|
5610
7532
|
* Defines the `notificationsCount`, displayed in the notification icon top-right corner.
|
|
5611
7533
|
*/
|
|
@@ -5693,7 +7615,7 @@ declare module "sap/ui/webc/fiori/ShellBar" {
|
|
|
5693
7615
|
logoClick?: (oEvent: Event) => void;
|
|
5694
7616
|
|
|
5695
7617
|
/**
|
|
5696
|
-
* Fired, when a menu item is activated **Note:** You can prevent closing of
|
|
7618
|
+
* Fired, when a menu item is activated **Note:** You can prevent closing of overflow popover by calling
|
|
5697
7619
|
* `event.preventDefault()`.
|
|
5698
7620
|
*/
|
|
5699
7621
|
menuItemClick?: (oEvent: Event) => void;
|
|
@@ -5704,7 +7626,7 @@ declare module "sap/ui/webc/fiori/ShellBar" {
|
|
|
5704
7626
|
notificationsClick?: (oEvent: Event) => void;
|
|
5705
7627
|
|
|
5706
7628
|
/**
|
|
5707
|
-
* Fired, when the product switch icon is activated. **Note:** You can prevent closing of
|
|
7629
|
+
* Fired, when the product switch icon is activated. **Note:** You can prevent closing of overflow popover
|
|
5708
7630
|
* by calling `event.preventDefault()`.
|
|
5709
7631
|
*/
|
|
5710
7632
|
productSwitchClick?: (oEvent: Event) => void;
|
|
@@ -6000,6 +7922,8 @@ declare module "sap/ui/webc/fiori/SideNavigation" {
|
|
|
6000
7922
|
* components to build your menu. The items can consist of text only or an icon with text. The use or non-use
|
|
6001
7923
|
* of icons must be consistent for all items on one level. You must not combine entries with and without
|
|
6002
7924
|
* icons on the same level. We strongly recommend that you do not use icons on the second level.
|
|
7925
|
+
*
|
|
7926
|
+
* Keyboard Handling:
|
|
6003
7927
|
*/
|
|
6004
7928
|
export default class SideNavigation extends WebComponent {
|
|
6005
7929
|
/**
|
|
@@ -6158,6 +8082,9 @@ declare module "sap/ui/webc/fiori/SideNavigation" {
|
|
|
6158
8082
|
): this;
|
|
6159
8083
|
/**
|
|
6160
8084
|
* Fires event {@link #event:selectionChange selectionChange} to attached listeners.
|
|
8085
|
+
*
|
|
8086
|
+
* Listeners may prevent the default action of this event by calling the `preventDefault` method on the
|
|
8087
|
+
* event object. The return value of this method indicates whether the default action should be executed.
|
|
6161
8088
|
*/
|
|
6162
8089
|
fireSelectionChange(
|
|
6163
8090
|
/**
|
|
@@ -6169,7 +8096,7 @@ declare module "sap/ui/webc/fiori/SideNavigation" {
|
|
|
6169
8096
|
*/
|
|
6170
8097
|
item?: HTMLElement;
|
|
6171
8098
|
}
|
|
6172
|
-
):
|
|
8099
|
+
): boolean;
|
|
6173
8100
|
/**
|
|
6174
8101
|
* Gets current value of property {@link #getCollapsed collapsed}.
|
|
6175
8102
|
*
|
|
@@ -7137,6 +9064,12 @@ declare module "sap/ui/webc/fiori/Timeline" {
|
|
|
7137
9064
|
* Destroys all the items in the aggregation {@link #getItems items}.
|
|
7138
9065
|
*/
|
|
7139
9066
|
destroyItems(): this;
|
|
9067
|
+
/**
|
|
9068
|
+
* Gets current value of property {@link #getAccessibleName accessibleName}.
|
|
9069
|
+
*
|
|
9070
|
+
* Defines the accessible aria name of the component.
|
|
9071
|
+
*/
|
|
9072
|
+
getAccessibleName(): string;
|
|
7140
9073
|
/**
|
|
7141
9074
|
* Gets current value of property {@link #getHeight height}.
|
|
7142
9075
|
*
|
|
@@ -7209,6 +9142,19 @@ declare module "sap/ui/webc/fiori/Timeline" {
|
|
|
7209
9142
|
*/
|
|
7210
9143
|
vItem: int | string | ITimelineItem
|
|
7211
9144
|
): ITimelineItem;
|
|
9145
|
+
/**
|
|
9146
|
+
* Sets a new value for property {@link #getAccessibleName accessibleName}.
|
|
9147
|
+
*
|
|
9148
|
+
* Defines the accessible aria name of the component.
|
|
9149
|
+
*
|
|
9150
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
9151
|
+
*/
|
|
9152
|
+
setAccessibleName(
|
|
9153
|
+
/**
|
|
9154
|
+
* New value for property `accessibleName`
|
|
9155
|
+
*/
|
|
9156
|
+
sAccessibleName: string
|
|
9157
|
+
): this;
|
|
7212
9158
|
/**
|
|
7213
9159
|
* Sets a new value for property {@link #getHeight height}.
|
|
7214
9160
|
*
|
|
@@ -7220,7 +9166,7 @@ declare module "sap/ui/webc/fiori/Timeline" {
|
|
|
7220
9166
|
/**
|
|
7221
9167
|
* New value for property `height`
|
|
7222
9168
|
*/
|
|
7223
|
-
sHeight
|
|
9169
|
+
sHeight: CSSSize
|
|
7224
9170
|
): this;
|
|
7225
9171
|
/**
|
|
7226
9172
|
* Sets a new value for property {@link #getLayout layout}.
|
|
@@ -7254,11 +9200,16 @@ declare module "sap/ui/webc/fiori/Timeline" {
|
|
|
7254
9200
|
/**
|
|
7255
9201
|
* New value for property `width`
|
|
7256
9202
|
*/
|
|
7257
|
-
sWidth
|
|
9203
|
+
sWidth: CSSSize
|
|
7258
9204
|
): this;
|
|
7259
9205
|
}
|
|
7260
9206
|
|
|
7261
9207
|
export interface $TimelineSettings extends $WebComponentSettings {
|
|
9208
|
+
/**
|
|
9209
|
+
* Defines the accessible aria name of the component.
|
|
9210
|
+
*/
|
|
9211
|
+
accessibleName?: string | PropertyBindingInfo;
|
|
9212
|
+
|
|
7262
9213
|
/**
|
|
7263
9214
|
* Defines the height of the control
|
|
7264
9215
|
*/
|
|
@@ -8023,7 +9974,7 @@ declare module "sap/ui/webc/fiori/UploadCollection" {
|
|
|
8023
9974
|
/**
|
|
8024
9975
|
* Gets current value of property {@link #getAccessibleName accessibleName}.
|
|
8025
9976
|
*
|
|
8026
|
-
*
|
|
9977
|
+
* Defines the accessible aria name of the component.
|
|
8027
9978
|
*
|
|
8028
9979
|
* Default value is `empty string`.
|
|
8029
9980
|
*/
|
|
@@ -8183,7 +10134,7 @@ declare module "sap/ui/webc/fiori/UploadCollection" {
|
|
|
8183
10134
|
/**
|
|
8184
10135
|
* Sets a new value for property {@link #getAccessibleName accessibleName}.
|
|
8185
10136
|
*
|
|
8186
|
-
*
|
|
10137
|
+
* Defines the accessible aria name of the component.
|
|
8187
10138
|
*
|
|
8188
10139
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
8189
10140
|
*
|
|
@@ -8206,7 +10157,7 @@ declare module "sap/ui/webc/fiori/UploadCollection" {
|
|
|
8206
10157
|
/**
|
|
8207
10158
|
* New value for property `height`
|
|
8208
10159
|
*/
|
|
8209
|
-
sHeight
|
|
10160
|
+
sHeight: CSSSize
|
|
8210
10161
|
): this;
|
|
8211
10162
|
/**
|
|
8212
10163
|
* Sets a new value for property {@link #getHideDragOverlay hideDragOverlay}.
|
|
@@ -8291,13 +10242,13 @@ declare module "sap/ui/webc/fiori/UploadCollection" {
|
|
|
8291
10242
|
/**
|
|
8292
10243
|
* New value for property `width`
|
|
8293
10244
|
*/
|
|
8294
|
-
sWidth
|
|
10245
|
+
sWidth: CSSSize
|
|
8295
10246
|
): this;
|
|
8296
10247
|
}
|
|
8297
10248
|
|
|
8298
10249
|
export interface $UploadCollectionSettings extends $WebComponentSettings {
|
|
8299
10250
|
/**
|
|
8300
|
-
*
|
|
10251
|
+
* Defines the accessible aria name of the component.
|
|
8301
10252
|
*/
|
|
8302
10253
|
accessibleName?: string | PropertyBindingInfo;
|
|
8303
10254
|
|
|
@@ -9368,6 +11319,18 @@ declare module "sap/ui/webc/fiori/ViewSettingsDialog" {
|
|
|
9368
11319
|
* The currently selected `sap.ui.webc.fiori.SortItem` text attribute.
|
|
9369
11320
|
*/
|
|
9370
11321
|
sortBy?: string;
|
|
11322
|
+
/**
|
|
11323
|
+
* The currently selected `sap.ui.webc.fiori.SortItem`.
|
|
11324
|
+
*/
|
|
11325
|
+
sortByItem?: HTMLElement;
|
|
11326
|
+
/**
|
|
11327
|
+
* The selected sort order (true = descending, false = ascending).
|
|
11328
|
+
*/
|
|
11329
|
+
sortDescending?: boolean;
|
|
11330
|
+
/**
|
|
11331
|
+
* The selected filters items.
|
|
11332
|
+
*/
|
|
11333
|
+
filterItems?: any[];
|
|
9371
11334
|
}
|
|
9372
11335
|
): this;
|
|
9373
11336
|
/**
|
|
@@ -9386,6 +11349,18 @@ declare module "sap/ui/webc/fiori/ViewSettingsDialog" {
|
|
|
9386
11349
|
* The currently selected `sap.ui.webc.fiori.SortItem` text attribute.
|
|
9387
11350
|
*/
|
|
9388
11351
|
sortBy?: string;
|
|
11352
|
+
/**
|
|
11353
|
+
* The currently selected `sap.ui.webc.fiori.SortItem`.
|
|
11354
|
+
*/
|
|
11355
|
+
sortByItem?: HTMLElement;
|
|
11356
|
+
/**
|
|
11357
|
+
* The selected sort order (true = descending, false = ascending).
|
|
11358
|
+
*/
|
|
11359
|
+
sortDescending?: boolean;
|
|
11360
|
+
/**
|
|
11361
|
+
* The selected filters items.
|
|
11362
|
+
*/
|
|
11363
|
+
filterItems?: any[];
|
|
9389
11364
|
}
|
|
9390
11365
|
): this;
|
|
9391
11366
|
/**
|
|
@@ -9567,6 +11542,16 @@ declare module "sap/ui/webc/fiori/Wizard" {
|
|
|
9567
11542
|
* **Note:** If no selected step is defined, the first step will be auto selected.
|
|
9568
11543
|
* **Note:** If multiple selected steps are defined, the last step will be selected.
|
|
9569
11544
|
*
|
|
11545
|
+
* Keyboard Handling: The user can navigate using the following keyboard shortcuts:
|
|
11546
|
+
*
|
|
11547
|
+
*
|
|
11548
|
+
* Wizard Progress Navigation:
|
|
11549
|
+
* - [LEFT], [DOWN] - Focus moves backward to the WizardProgressNavAnchors.
|
|
11550
|
+
* - [UP], [RIGHT] - Focus moves forward to the WizardProgressNavAnchor.
|
|
11551
|
+
* - [SPACE] or [ENTER], [RETURN] - Selects an active step
|
|
11552
|
+
* - [HOME] or [PAGE UP] - Focus goes to the first step
|
|
11553
|
+
* - [END] or [PAGE DOWN] - Focus goes to the last step
|
|
11554
|
+
*
|
|
9570
11555
|
* Content: The content occupies the main part of the page. It can hold any type of HTML elements. It's
|
|
9571
11556
|
* defined by using the `sap.ui.webc.fiori.WizardStep` as slotted element within the `sap.ui.webc.fiori.Wizard`.
|
|
9572
11557
|
*
|
|
@@ -9821,7 +11806,7 @@ declare module "sap/ui/webc/fiori/Wizard" {
|
|
|
9821
11806
|
/**
|
|
9822
11807
|
* New value for property `height`
|
|
9823
11808
|
*/
|
|
9824
|
-
sHeight
|
|
11809
|
+
sHeight: CSSSize
|
|
9825
11810
|
): this;
|
|
9826
11811
|
}
|
|
9827
11812
|
|
|
@@ -9973,19 +11958,14 @@ declare module "sap/ui/webc/fiori/WizardStep" {
|
|
|
9973
11958
|
*/
|
|
9974
11959
|
getContent(): Control[];
|
|
9975
11960
|
/**
|
|
9976
|
-
* Gets current value of property {@link #
|
|
9977
|
-
*
|
|
9978
|
-
* Defines if the step is `disabled`. When disabled the step is displayed, but the user can't select the
|
|
9979
|
-
* step by clicking or navigate to it with scrolling.
|
|
9980
|
-
*
|
|
11961
|
+
* Gets current value of property {@link #getEnabled enabled}.
|
|
9981
11962
|
*
|
|
11963
|
+
* Defines whether the control is enabled. A disabled control can't be interacted with, and it is not in
|
|
11964
|
+
* the tab chain.
|
|
9982
11965
|
*
|
|
9983
|
-
*
|
|
9984
|
-
* would take precedence.
|
|
9985
|
-
*
|
|
9986
|
-
* Default value is `false`.
|
|
11966
|
+
* Default value is `true`.
|
|
9987
11967
|
*/
|
|
9988
|
-
|
|
11968
|
+
getEnabled(): boolean;
|
|
9989
11969
|
/**
|
|
9990
11970
|
* Gets current value of property {@link #getIcon icon}.
|
|
9991
11971
|
*
|
|
@@ -10101,25 +12081,20 @@ declare module "sap/ui/webc/fiori/WizardStep" {
|
|
|
10101
12081
|
bBranching?: boolean
|
|
10102
12082
|
): this;
|
|
10103
12083
|
/**
|
|
10104
|
-
* Sets a new value for property {@link #
|
|
10105
|
-
*
|
|
10106
|
-
* Defines if the step is `disabled`. When disabled the step is displayed, but the user can't select the
|
|
10107
|
-
* step by clicking or navigate to it with scrolling.
|
|
10108
|
-
*
|
|
10109
|
-
*
|
|
12084
|
+
* Sets a new value for property {@link #getEnabled enabled}.
|
|
10110
12085
|
*
|
|
10111
|
-
*
|
|
10112
|
-
*
|
|
12086
|
+
* Defines whether the control is enabled. A disabled control can't be interacted with, and it is not in
|
|
12087
|
+
* the tab chain.
|
|
10113
12088
|
*
|
|
10114
12089
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
10115
12090
|
*
|
|
10116
|
-
* Default value is `
|
|
12091
|
+
* Default value is `true`.
|
|
10117
12092
|
*/
|
|
10118
|
-
|
|
12093
|
+
setEnabled(
|
|
10119
12094
|
/**
|
|
10120
|
-
* New value for property `
|
|
12095
|
+
* New value for property `enabled`
|
|
10121
12096
|
*/
|
|
10122
|
-
|
|
12097
|
+
bEnabled?: boolean
|
|
10123
12098
|
): this;
|
|
10124
12099
|
/**
|
|
10125
12100
|
* Sets a new value for property {@link #getIcon icon}.
|
|
@@ -10217,15 +12192,10 @@ declare module "sap/ui/webc/fiori/WizardStep" {
|
|
|
10217
12192
|
branching?: boolean | PropertyBindingInfo;
|
|
10218
12193
|
|
|
10219
12194
|
/**
|
|
10220
|
-
* Defines
|
|
10221
|
-
*
|
|
10222
|
-
*
|
|
10223
|
-
*
|
|
10224
|
-
*
|
|
10225
|
-
* **Note:** Step can't be `selected` and `disabled` at the same time. In this case the `selected` property
|
|
10226
|
-
* would take precedence.
|
|
12195
|
+
* Defines whether the control is enabled. A disabled control can't be interacted with, and it is not in
|
|
12196
|
+
* the tab chain.
|
|
10227
12197
|
*/
|
|
10228
|
-
|
|
12198
|
+
enabled?: boolean | PropertyBindingInfo;
|
|
10229
12199
|
|
|
10230
12200
|
/**
|
|
10231
12201
|
* Defines the `icon` of the step.
|
|
@@ -10281,6 +12251,8 @@ declare namespace sap {
|
|
|
10281
12251
|
|
|
10282
12252
|
"sap/ui/webc/fiori/BarcodeScannerDialog": undefined;
|
|
10283
12253
|
|
|
12254
|
+
"sap/ui/webc/fiori/DynamicSideContent": undefined;
|
|
12255
|
+
|
|
10284
12256
|
"sap/ui/webc/fiori/FilterItem": undefined;
|
|
10285
12257
|
|
|
10286
12258
|
"sap/ui/webc/fiori/FilterItemOption": undefined;
|
|
@@ -10291,6 +12263,10 @@ declare namespace sap {
|
|
|
10291
12263
|
|
|
10292
12264
|
"sap/ui/webc/fiori/library": undefined;
|
|
10293
12265
|
|
|
12266
|
+
"sap/ui/webc/fiori/MediaGallery": undefined;
|
|
12267
|
+
|
|
12268
|
+
"sap/ui/webc/fiori/MediaGalleryItem": undefined;
|
|
12269
|
+
|
|
10294
12270
|
"sap/ui/webc/fiori/NotificationAction": undefined;
|
|
10295
12271
|
|
|
10296
12272
|
"sap/ui/webc/fiori/NotificationListGroupItem": undefined;
|