forked from emumanu/OpenUI5Sharp
-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathsap.f.xsd
More file actions
839 lines (738 loc) · 51.3 KB
/
sap.f.xsd
File metadata and controls
839 lines (738 loc) · 51.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:n12="sap.f" xmlns:n0="sap.ui.core" xmlns:n6="sap.m" elementFormDefault="qualified" targetNamespace="sap.f" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:import namespace="sap.ui.core" />
<xs:import namespace="sap.m" />
<xs:element name="Avatar" substitutionGroup="n0:Control" type="n12:_AvatarType">
<xs:annotation>
<xs:documentation>An image-like control that has different display options for representing images, initials, and icons.
<h3>Overview</h3>
The <code>Avatar</code> control allows the usage of different content, shapes, and sizes depending on the use case.
The content types that can be displayed are either images, icons, or initials. The shape can be circular or square. There are several predefined sizes, as well as an option to set a custom size.
<h3>Usage</h3>
Up to two Latin letters can be displayed as initials in an <code>Avatar</code>. If there are more than two letters, or if there's a non-Latin character present, a default image placeholder will be created.
There are two options for how the displayed image can fit inside the available area: <ul> <li>Cover - the image is scaled to cover all of the available area</li> <li>Contain - the image is scaled as large as possible while both its height and width fit inside the avalable area</li> </ul> <b>Note:</b> To set a custom size for the <code>Avatar</code>, you have to choose the <code>Custom</code> value for the <code>displaySize</code> property. Then, you have to set both the <code>customDisplaySize</code> and <code>customFontSize</code> properties.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="_AvatarType">
<xs:complexContent mixed="false">
<xs:extension base="n0:_ControlType">
<xs:sequence>
<xs:element minOccurs="0" name="detailBox">
<xs:annotation>
<xs:documentation>A <code>sap.m.LightBox</code> instance, that will be opened automatically when the user interacts with the <code>Avatar</code> control.
The <code>press</code> event will still be fired.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="n6:LightBox" />
<xs:element ref="n0:Fragment" />
</xs:choice>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
<xs:attribute name="src" type="n0:_URIType">
<xs:annotation>
<xs:documentation>Determines the path to the desired image or icon.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="initials" type="xs:string">
<xs:annotation>
<xs:documentation>Defines the displayed initials.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="displayShape" type="n12:_AvatarShapeType">
<xs:annotation>
<xs:documentation>Defines the shape of the <code>Avatar</code>.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="displaySize" type="n12:_AvatarSizeType">
<xs:annotation>
<xs:documentation>Sets a predefined display size of the <code>Avatar</code>.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="customDisplaySize" type="n0:_CSSSizeType">
<xs:annotation>
<xs:documentation>Specifies custom display size of the <code>Avatar</code>.
<b>Note:</b> It takes effect if the <code>displaySize</code> property is set to <code>Custom</code>.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="customFontSize" type="n0:_CSSSizeType">
<xs:annotation>
<xs:documentation>Specifies custom font size of the <code>Avatar</code>.
<b>Note:</b> It takes effect if the <code>displaySize</code> property is set to <code>Custom</code>.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="imageFitType" type="n12:_AvatarImageFitTypeType">
<xs:annotation>
<xs:documentation>Specifies how an image would fit in the <code>Avatar</code>.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="press" type="xs:string">
<xs:annotation>
<xs:documentation>Fired when the user selects the control.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="DynamicPage" substitutionGroup="n0:Control" type="n12:_DynamicPageType">
<xs:annotation>
<xs:documentation>A layout control, representing a web page, consisting of a title, header with dynamic behavior, a content area, and an optional floating footer.
<h3>Overview</h3>
The control consist of several components:
<ul><li>{@link sap.f.DynamicPageTitle DynamicPageTitle} - consists of a heading on the left side, content in the middle, and actions on the right. The displayed content changes based on the current mode of the {@link sap.f.DynamicPageHeader DynamicPageHeader}.</li> <li>{@link sap.f.DynamicPageHeader DynamicPageHeader} - a generic container, which can contain a single layout control and does not care about the content alignment and responsiveness. The header works in two modes - expanded and snapped and its behavior can be adjusted with the help of different properties.</li> <li>Content area - a generic container, which can have a single UI5 layout control and does not care about the content alignment and responsiveness.</li> <li>Footer - positioned at the bottom with a small offset and used for additional actions, the footer floats above the content. It can be any {@link sap.m.IBar} control.</li></ul>
<h3>Usage</h3>
Use the <code>DynamicPage</code> if you need to have a title, that is always visible and a header, that has configurable Expanding/Snapping functionality. If you don't need the Expanding/Snapping functionality it is better to use the {@link sap.m.Page} as a lighter control.
<ul><b>Notes:</b> <li>If you're displaying a {@link sap.m.FlexBox} with non-adaptive content (doesn't stretch to fill the available space), it is recommended to set the <code>fitContainer</code> property of the {@link sap.m.FlexBox FlexBox} to <code>false</code>.</li> <li>If you are displaying a {@link sap.ui.table.Table}, keep in mind that it is non-adaptive and may cause unpredicted behavior for the <code>DynamicPage</code> on smaller screen sizes, such as mobile.</li> <li>Snapping of the {@link sap.f.DynamicPageTitle DynamicPageTitle} is not supported in the following case: When the <code>DynamicPage</code> has a scroll bar, the control usually scrolls to the snapping point - the point, where the {@link sap.f.DynamicPageHeader DynamicPageHeader} is scrolled out completely. However, when there is a scroll bar, but not enough content to reach the snapping point, the snapping is not possible using scrolling.</li> <li>When using {@link sap.ui.layout.form.Form}, {@link sap.m.Panel}, {@link sap.m.Table} and {@link sap.m.List} controls in the content of <code>DynamicPage</code>, you need to adjust their left text offset if you want to achieve vertical alignment between the <code>sap.f.DynamicPageHeader</code>`s content and <code>DynamicPage</code>`s content. For more information, see the documentation for the <code>content</code> aggregation.</li></ul>
<h3>Responsive Behavior</h3>
The responsive behavior of the <code>DynamicPage</code> depends on the behavior of the content that is displayed. To adjust the <code>DynamicPage</code> content padding, the <code>sapUiContentPadding</code>, <code>sapUiNoContentPadding</code>, and <code>sapUiResponsiveContentPadding</code> CSS classes can be used.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="_DynamicPageType">
<xs:complexContent mixed="false">
<xs:extension base="n0:_ControlType">
<xs:sequence>
<xs:element minOccurs="0" name="title">
<xs:annotation>
<xs:documentation><code>DynamicPage</code> title.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="n12:DynamicPageTitle" />
<xs:element ref="n0:Fragment" />
</xs:choice>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element minOccurs="0" name="header">
<xs:annotation>
<xs:documentation><code>DynamicPage</code> header.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="n12:DynamicPageHeader" />
<xs:element ref="n0:Fragment" />
</xs:choice>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element minOccurs="0" name="content">
<xs:annotation>
<xs:documentation><code>DynamicPage</code> content.
<b>Note: </b> You can change the default paddings by adding the following CSS classes: <ul> <li><code>sapUiContentPadding</code></li> <li><code>sapUiNoContentPadding</code></li> <li><code>sapUiResponsiveContentPadding</code></li> </ul> For more information, see {@link topic:c71f6df62dae47ca8284310a6f5fc80a Using Container Content Padding CSS Classes}.
<b>Note:</b> The SAP Fiori Design guidelines require that the <code>DynamicPageHeader</code>'s content and the <code>DynamicPage</code>'s content are aligned vertically. When using {@link sap.ui.layout.form.Form}, {@link sap.m.Panel}, {@link sap.m.Table} and {@link sap.m.List} in the content area of <code>DynamicPage</code>, you need to adjust their left text offset to achieve the vertical alignment. To do this, apply the <code>sapFDynamicPageAlignContent</code> CSS class to them and set their <code>width</code> property to <code>auto</code> (if not set by default).
Example:
<pre>
<code> &lt;Panel class=“sapFDynamicPageAlignContent” width=“auto”&gt;&lt;/Panel&gt; </code>
</pre>
Please keep in mind that the alignment is not possible in the following cases: <ul> <li> When the controls are placed in an {@link sap.ui.layout.Grid} or other layout controls that use <code>overflow:hidden</code> CSS property</li> <li> In case any of the following CSS classes is applied to <code>DynamicPage</code>: <code>sapUiContentPadding</code>, <code>sapUiNoContentPadding</code> or <code>sapUiResponsiveContentPadding</code></li> </ul></xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="n0:Control" />
<xs:element ref="n0:Fragment" />
</xs:choice>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element minOccurs="0" name="footer">
<xs:annotation>
<xs:documentation><code>DynamicPage</code> floating footer.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="n0:Control" />
<xs:element ref="n0:Fragment" />
</xs:choice>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
<xs:attribute name="preserveHeaderStateOnScroll" type="xs:boolean">
<xs:annotation>
<xs:documentation>Preserves the current header state when scrolling. For example, if the user expands the header by clicking on the title and then scrolls down the page, the header will remain expanded.
<b>Note:</b> Based on internal rules, the value of the property is not always taken into account - for example, when the control is rendered on tablet or mobile and the control`s title and header are with height larger than the given threshold.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="headerExpanded" type="xs:boolean">
<xs:annotation>
<xs:documentation>Determines whether the header is expanded.
The header can be also expanded/collapsed by user interaction, which requires the property to be internally mutated by the control to reflect the changed state.
<b>Note:</b> As of version 1.48, you can initialize the control in collapsed header state by setting this property to <code>false</code>.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="toggleHeaderOnTitleClick" type="xs:boolean">
<xs:annotation>
<xs:documentation>Determines whether the user can switch between the expanded/collapsed states of the <code>DynamicPageHeader</code> by clicking on the <code>DynamicPageTitle</code> or by using the expand/collapse visual indicators, positioned at the bottom of the <code>DynamicPageTitle</code> and the <code>DynamicPageHeader</code>. If set to <code>false</code>, the <code>DynamicPageTitle</code> is not clickable, the visual indicators are not available and the application must provide other means for expanding/collapsing the <code>DynamicPageHeader</code>, if necessary.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="showFooter" type="xs:boolean">
<xs:annotation>
<xs:documentation>Determines whether the footer is visible.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="fitContent" type="xs:boolean">
<xs:annotation>
<xs:documentation>Optimizes <code>DynamicPage</code> responsiveness on small screens and behavior when expanding/collapsing the <code>DynamicPageHeader</code>.
<b>Note:</b> It is recommended to use this property when displaying content of adaptive controls that stretch to fill the available space. Such controls may be {@link sap.ui.table.Table} and {@link sap.ui.table.AnalyticalTable} depending on their settings.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="DynamicPageHeader" substitutionGroup="n0:Control" type="n12:_DynamicPageHeaderType">
<xs:annotation>
<xs:documentation>Header of the {@link sap.f.DynamicPage}.
<h3>Overview</h3>
The <code>DynamicPageHeader</code> control is part of the {@link sap.f.DynamicPage} family and is used to serve as header of the {@link sap.f.DynamicPage DynamicPage}.
<h3>Usage</h3>
The <code>DynamicPageHeader</code> can hold any layout control and has two states - expanded and collapsed (snapped). The switching between these states happens when:
<ul><li>the user scrolls below its bottom margin</li> <li>the user clicks on the {@link sap.f.DynamicPageTitle DynamicPageTitle}</li> <li>through the {@link sap.f.DynamicPage DynamicPage} property <code>headerExpanded</code></li></ul>
<h3>Responsive Behavior</h3>
The responsive behavior of the <code>DynamicPageHeader</code> depends on the behavior of the content that is displayed.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="_DynamicPageHeaderType">
<xs:complexContent mixed="false">
<xs:extension base="n0:_ControlType">
<xs:sequence>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="n0:Control" />
<xs:element ref="n0:Fragment" />
<xs:any namespace="http://www.w3.org/1999/xhtml" processContents="lax" />
</xs:choice>
<xs:element minOccurs="0" name="content">
<xs:annotation>
<xs:documentation>The content of the header.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="n0:Control" />
<xs:element ref="n0:Fragment" />
</xs:choice>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
<xs:attribute name="pinnable" type="xs:boolean">
<xs:annotation>
<xs:documentation>Determines whether the header is pinnable.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="backgroundDesign" type="n6:_BackgroundDesignType">
<xs:annotation>
<xs:documentation>Determines the background color of the <code>DynamicPageHeader</code>.
<b>Note:</b> The default value of <code>backgroundDesign</code> property is null. If the property is not set, the color of the background is <code>@sapUiObjectHeaderBackground</code>, which depends on the specific theme.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="content" type="xs:string" />
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="DynamicPageTitle" substitutionGroup="n0:Control" type="n12:_DynamicPageTitleType">
<xs:annotation>
<xs:documentation>Title of the {@link sap.f.DynamicPage}.
<h3>Overview</h3>
The <code>DynamicPageTitle</code> control is part of the {@link sap.f.DynamicPage} family and is used to serve as title of the {@link sap.f.DynamicPage DynamicPage}.
<h3>Usage</h3>
The <code>DynamicPageTitle</code> can hold any control and displays the most important information regarding the object that will always remain visible while scrolling.
<b>Note:</b> The <code>actions</code> aggregation accepts any UI5 control, but it`s recommended to use controls, suitable for {@link sap.m.Toolbar} and {@link sap.m.OverflowToolbar}.
If the <code>toggleHeaderOnTitleClick</code> property of the {@link sap.f.DynamicPage DynamicPage} is set to <code>true</code>, the user can switch between the expanded/collapsed states of the {@link sap.f.DynamicPageHeader DynamicPageHeader} by clicking on the <code>DynamicPageTitle</code> or by using the expand/collapse visual indicators, positioned at the bottom of the <code>DynamicPageTitle</code> and the <code>DynamicPageHeader</code>.
If set to <code>false</code>, the <code>DynamicPageTitle</code> is not clickable, the visual indicators are not available, and the app must provide other means for expanding/collapsing the <code>DynamicPageHeader</code>, if necessary.
<h3>Responsive Behavior</h3>
The responsive behavior of the <code>DynamicPageTitle</code> depends on the behavior of the content that is displayed.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="_DynamicPageTitleType">
<xs:complexContent mixed="false">
<xs:extension base="n0:_ControlType">
<xs:sequence>
<xs:element minOccurs="0" name="breadcrumbs">
<xs:annotation>
<xs:documentation>The breadcrumbs displayed in the <code>DynamicPageTitle</code> top-left area.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="n0:Control" />
<xs:element ref="n0:Fragment" />
</xs:choice>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element minOccurs="0" name="actions">
<xs:annotation>
<xs:documentation>The <code>DynamicPageTitle</code> actions. <br><b>Note:</b> The <code>actions</code> aggregation accepts any UI5 control, but it`s recommended to use controls, suitable for {@link sap.m.Toolbar} and {@link sap.m.OverflowToolbar}.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="n0:Control" />
<xs:element ref="n0:Fragment" />
</xs:choice>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element minOccurs="0" name="navigationActions">
<xs:annotation>
<xs:documentation>The <code>DynamicPageTitle</code> navigation actions.
<b>Note:</b> The <code>navigationActions</code> position depends on the control size. If the control size is 1280px or bigger, they are rendered right next to the <code>actions</code>. Otherwise, they are rendered in the top-right area, above the <code>actions</code>. If a large number of elements(buttons) are used, there could be visual degradations as the space for the <code>navigationActions</code> is limited.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="n6:Button" />
<xs:element ref="n0:Fragment" />
</xs:choice>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element minOccurs="0" name="heading">
<xs:annotation>
<xs:documentation>The <code>heading</code> is positioned in the <code>DynamicPageTitle</code> left area and is displayed in both expanded and collapsed (snapped) states of the header. Use this aggregation to display a title (or any other UI5 control that serves as a heading) that has to be present in both expanded and collapsed states of the header.
<b>Note:</b> <code>heading</code> is mutually exclusive with <code>snappedHeading</code> and <code>expandedHeading</code>. If <code>heading</code> is provided, both <code>snappedHeading</code> and <code>expandedHeading</code> are ignored. <code>heading</code> is useful when the content of <code>snappedHeading</code> and <code>expandedHeading</code> needs to be the same as it replaces them both.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="n0:Control" />
<xs:element ref="n0:Fragment" />
</xs:choice>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element minOccurs="0" name="snappedHeading">
<xs:annotation>
<xs:documentation>The <code>snappedHeading</code> is positioned in the <code>DynamicPageTitle</code> left area and is displayed when the header is in collapsed (snapped) state only. Use this aggregation to display a title (or any other UI5 control that serves as a heading) that has to be present in collapsed state only.
<b>Note:</b> In order for <code>snappedHeading</code> to be taken into account, <code>heading</code> has to be empty. Combine <code>snappedHeading</code> with <code>expandedHeading</code> to switch content when the header switches state.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="n0:Control" />
<xs:element ref="n0:Fragment" />
</xs:choice>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element minOccurs="0" name="expandedHeading">
<xs:annotation>
<xs:documentation>The <code>expandedHeading</code> is positioned in the <code>DynamicPageTitle</code> left area and is displayed when the header is in expanded state only. Use this aggregation to display a title (or any other UI5 control that serves as a heading) that has to be present in expanded state only.
<b>Note:</b> In order for <code>expandedHeading</code> to be taken into account, <code>heading</code> has to be empty. Combine <code>expandedHeading</code> with <code>snappedHeading</code> to switch content when the header switches state.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="n0:Control" />
<xs:element ref="n0:Fragment" />
</xs:choice>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element minOccurs="0" name="content">
<xs:annotation>
<xs:documentation>The content is positioned in the <code>DynamicPageTitle</code> middle area and displayed in both expanded and collapsed (snapped) states.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="n0:Control" />
<xs:element ref="n0:Fragment" />
</xs:choice>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element minOccurs="0" name="snappedContent">
<xs:annotation>
<xs:documentation>The content that is displayed in the <code>DynamicPageTitle</code> in collapsed (snapped) state.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="n0:Control" />
<xs:element ref="n0:Fragment" />
</xs:choice>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element minOccurs="0" name="expandedContent">
<xs:annotation>
<xs:documentation>The content that is displayed in the <code>DynamicPageTitle</code> in expanded state.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="n0:Control" />
<xs:element ref="n0:Fragment" />
</xs:choice>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
<xs:attribute name="primaryArea" type="n12:_DynamicPageTitleAreaType">
<xs:annotation>
<xs:documentation>Determines which of the <code>DynamicPageTitle</code> areas (Begin, Middle) is primary.
<b>Note:</b> The primary area is shrinking at lower rate, remaining visible as much as it can.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="areaShrinkRatio" type="n12:_DynamicPageTitleShrinkRatioType">
<xs:annotation>
<xs:documentation>Assigns shrinking ratio to the <code>DynamicPageTitle</code> areas (Heading, Content, Actions). The greater value a section has the faster it shrinks when the screen size is being reduced.
The value must be set in <code>Heading:Content:Actions</code> format where Title, Content and Actions are numbers greater than or equal to 0. If set to 0, the respective area will not shrink.
For example, if <code>2:7:1</code> is set, the Content area will shrink seven times faster than the Actions area. So, when all three areas have width of 500px and the available space is reduced by 100px the Title area will reduced by 20px, the Content area - by 70px and the Actions area - by 10px.
If all the areas have assigned values greater than 1, the numbers are scaled so that at least one of them is equal to 1. For example, value of <code>2:4:8</code> is equal to <code>1:2:4</code>.
<Note:> When this property is set the <code>primaryArea</code> property has no effect.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="backgroundDesign" type="n6:_BackgroundDesignType">
<xs:annotation>
<xs:documentation>Determines the background color of the <code>DynamicPageTitle</code>.
<b>Note:</b> The default value of <code>backgroundDesign</code> property is null. If the property is not set, the color of the background is <code>@sapUiObjectHeaderBackground</code>, which depends on the specific theme.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="actions" type="xs:string" />
<xs:attribute name="navigationActions" type="xs:string" />
<xs:attribute name="content" type="xs:string" />
<xs:attribute name="snappedContent" type="xs:string" />
<xs:attribute name="expandedContent" type="xs:string" />
<xs:attribute name="stateChange" type="xs:string">
<xs:annotation>
<xs:documentation>Fired when the title state (expanded/collapsed) is toggled by user interaction. For example, scrolling, title clicking/tapping, using expand/collapse button.
Also fired when the developer toggles the title state by programmatically changing the scroll position of the scrollbar of <code>DynamicPage</code>.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="FlexibleColumnLayout" substitutionGroup="n0:Control" type="n12:_FlexibleColumnLayoutType">
<xs:annotation>
<xs:documentation>Implements the master-detail-detail paradigm by displaying up to three pages in separate columns.
<h3>Overview</h3>
The control is logically similar to {@link sap.m.SplitContainer} with the difference that it capable of handling three columns (referred to as <code>Begin</code>, <code>Mid</code> and <code>End</code>) rather than two (<code>Master</code>, <code>Detail</code>). The width of the three columns is variable.
There are several possible layouts that can be changed either with the control's API, or by the user with the help of layout arrows.
Internally the control makes use of three instances of {@link sap.m.NavContainer}, thus forming the three columns.
<h3>Usage</h3>
Use this control for applications that need to display several logical levels of related information side by side (e.g. list of items, item, sub-item, etc.). The control is flexible in a sense that the application can focus the user's attention on one particular column by making it larger or even fullscreen.
The columns are accessible with the <code>beginColumnPages</code>, <code>midColumnPages</code> and <code>endColumnPages</code> aggregations.
The relative sizes and the visibility of the three columns are determined based on the value of the {@link sap.f.LayoutType layout} property.
Changes to the layout due to user interaction are communicated to the app with the <code>stateChange</code> event.
<ul><b>Notes:</b> <li>To easily implement the recommended UX design of a <code>sap.f.FlexibleColumnLayout</code>-based app, you can use the <code>sap.f.FlexibleColumnLayoutSemanticHelper</code> class.</li> <li>To facilitate the navigation and view loading, you can use the {@link sap.f.routing.Router} </li></ul>
<h3>Responsive Behavior</h3>
The control automatically displays the maximum possible number of columns based on the device size and current <code>layout</code>. The app does not need to take into consideration the current device/screen size, but only to add content to the columns and change the value of the <code>layout</code> property.
For detailed information, see {@link sap.f.LayoutType LayoutType} enumeration.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="_FlexibleColumnLayoutType">
<xs:complexContent mixed="false">
<xs:extension base="n0:_ControlType">
<xs:sequence>
<xs:element minOccurs="0" name="beginColumnPages">
<xs:annotation>
<xs:documentation>The content entities between which the <code>FlexibleColumnLayout</code> navigates in the <code>Begin</code> column.
These should be any control with page semantics. These aggregated controls will receive navigation events like {@link sap.m.NavContainerChild#beforeShow beforeShow}, they are documented in the pseudo interface {@link sap.m.NavContainerChild sap.m.NavContainerChild}.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="n0:Control" />
<xs:element ref="n0:Fragment" />
</xs:choice>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element minOccurs="0" name="midColumnPages">
<xs:annotation>
<xs:documentation>The content entities between which the <code>FlexibleColumnLayout</code> navigates in the <code>Mid</code> column.
These should be any control with page semantics. These aggregated controls will receive navigation events like {@link sap.m.NavContainerChild#beforeShow beforeShow}, they are documented in the pseudo interface {@link sap.m.NavContainerChild sap.m.NavContainerChild}.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="n0:Control" />
<xs:element ref="n0:Fragment" />
</xs:choice>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element minOccurs="0" name="endColumnPages">
<xs:annotation>
<xs:documentation>The content entities between which the <code>FlexibleColumnLayout</code> navigates in the <code>End</code> column.
These should be any control with page semantics. These aggregated controls will receive navigation events like {@link sap.m.NavContainerChild#beforeShow beforeShow}, they are documented in the pseudo interface {@link sap.m.NavContainerChild sap.m.NavContainerChild}.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="n0:Control" />
<xs:element ref="n0:Fragment" />
</xs:choice>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
<xs:attribute name="layout" type="n12:_LayoutTypeType">
<xs:annotation>
<xs:documentation>Determines the layout of the control - number of visible columns and their relative sizes.
For more details, see {@link topic:3b9f760da5b64adf8db7f95247879086 Types of Layout} in the documentation.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="defaultTransitionNameBeginColumn" type="xs:string">
<xs:annotation>
<xs:documentation>Determines the type of the transition/animation to apply for the <code>Begin</code> column when <code>to()</code> is called without defining the transition to use. The default is <code>slide</code>, other options are <code>fade</code>, <code>flip</code>, <code>show</code>, and the names of any registered custom transitions.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="defaultTransitionNameMidColumn" type="xs:string">
<xs:annotation>
<xs:documentation>Determines the type of the transition/animation to apply for the <code>Mid</code> column when <code>to()</code> is called without defining the transition to use. The default is <code>slide</code>, other options are <code>fade</code>, <code>flip</code>, <code>show</code>, and the names of any registered custom transitions.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="defaultTransitionNameEndColumn" type="xs:string">
<xs:annotation>
<xs:documentation>Determines the type of the transition/animation to apply for the <code>End</code> column when <code>to()</code> is called without defining the transition to use. The default is <code>slide</code>, other options are <code>fade</code>, <code>flip</code>, <code>show</code>, and the names of any registered custom transitions.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="backgroundDesign" type="n6:_BackgroundDesignType">
<xs:annotation>
<xs:documentation>Specifies the background color of the content. The visualization of the different options depends on the used theme.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="beginColumnPages" type="xs:string" />
<xs:attribute name="midColumnPages" type="xs:string" />
<xs:attribute name="endColumnPages" type="xs:string" />
<xs:attribute name="initialBeginColumnPage" type="xs:string">
<xs:annotation>
<xs:documentation>Sets the initial <code>Begin</code> column page, which is displayed on application launch.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="initialMidColumnPage" type="xs:string">
<xs:annotation>
<xs:documentation>Sets the initial <code>Mid</code> column page, which is displayed on application launch.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="initialEndColumnPage" type="xs:string">
<xs:annotation>
<xs:documentation>Sets the initial <code>End</code> column page, which is displayed on application launch.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="stateChange" type="xs:string">
<xs:annotation>
<xs:documentation>Fired when there is a change in the <code>layout</code> property or in the maximum number of columns that can be displayed at once. <br/></br> <ul>The interactions that may lead to a state change are: <li>the property <code>layout</code> was changed indirectly by the user clicking a layout arrow</li> <li>the user resized the browser beyond a breakpoint, thus changing the maximum number of columns that can be displayed at once.</li></ul> <br/><br/> <b>Note: </b>The event is suppressed while the control has zero width and will be fired the first time it gets a non-zero width</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="beginColumnNavigate" type="xs:string">
<xs:annotation>
<xs:documentation>Fires when navigation between two pages in the <code>Begin</code> column has been triggered. The transition (if any) to the new page has not started yet. This event can be aborted by the application with preventDefault(), which means that there will be no navigation.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="afterBeginColumnNavigate" type="xs:string">
<xs:annotation>
<xs:documentation>Fires when navigation between two pages in the <code>Begin</code> column has completed.
NOTE: In case of animated transitions this event is fired with some delay after the navigate event.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="midColumnNavigate" type="xs:string">
<xs:annotation>
<xs:documentation>Fires when navigation between two pages in the <code>Mid</code> column has been triggered. The transition (if any) to the new page has not started yet. This event can be aborted by the application with preventDefault(), which means that there will be no navigation.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="afterMidColumnNavigate" type="xs:string">
<xs:annotation>
<xs:documentation>Fires when navigation between two pages in the <code>Mid</code> column has completed.
NOTE: In case of animated transitions this event is fired with some delay after the navigate event.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="endColumnNavigate" type="xs:string">
<xs:annotation>
<xs:documentation>Fires when navigation between two pages in the <code>End</code> column has been triggered. The transition (if any) to the new page has not started yet. This event can be aborted by the application with preventDefault(), which means that there will be no navigation.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="afterEndColumnNavigate" type="xs:string">
<xs:annotation>
<xs:documentation>Fires when navigation between two pages in the <code>End</code> column has completed.
NOTE: In case of animated transitions this event is fired with some delay after the navigate event.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:simpleType name="_DynamicPageTitleShrinkRatioType">
<xs:restriction base="xs:string" />
</xs:simpleType>
<xs:simpleType name="_AvatarImageFitTypeType">
<xs:restriction base="xs:string">
<xs:enumeration value="Contain">
<xs:annotation>
<xs:documentation>The image is scaled to the largest size so that both its width and height can fit in the control area.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="Cover">
<xs:annotation>
<xs:documentation>The image is scaled to be large enough so that the control area is completely covered.</xs:documentation>
</xs:annotation>
</xs:enumeration>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="_AvatarShapeType">
<xs:restriction base="xs:string">
<xs:enumeration value="Circle">
<xs:annotation>
<xs:documentation>Circular shape.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="Square">
<xs:annotation>
<xs:documentation>Square shape.</xs:documentation>
</xs:annotation>
</xs:enumeration>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="_AvatarSizeType">
<xs:restriction base="xs:string">
<xs:enumeration value="Custom">
<xs:annotation>
<xs:documentation>Custom size</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="L">
<xs:annotation>
<xs:documentation>Control size - 5rem Font size - 2rem</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="M">
<xs:annotation>
<xs:documentation>Control size - 4rem Font size - 1.625rem</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="S">
<xs:annotation>
<xs:documentation>Control size - 3rem Font size - 1.125rem</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="XL">
<xs:annotation>
<xs:documentation>Control size - 7rem Font size - 2.75rem</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="XS">
<xs:annotation>
<xs:documentation>Control size - 2rem Font size - 0.75rem</xs:documentation>
</xs:annotation>
</xs:enumeration>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="_AvatarTypeType">
<xs:restriction base="xs:string">
<xs:enumeration value="Icon">
<xs:annotation>
<xs:documentation>The displayed content is an icon.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="Image">
<xs:annotation>
<xs:documentation>The displayed content is an image.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="Initials">
<xs:annotation>
<xs:documentation>The displayed content is initials.</xs:documentation>
</xs:annotation>
</xs:enumeration>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="_DynamicPageTitleAreaType">
<xs:restriction base="xs:string">
<xs:enumeration value="Begin">
<xs:annotation>
<xs:documentation>The area includes the <code>heading</code>, <code>expandedContent</code> and <code>snappedContent</code> aggregations, positioned in the beginning area of the {@link sap.f.DynamicPageTitle}.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="Middle">
<xs:annotation>
<xs:documentation>The area includes the <code>content</code> aggregation, positioned in the middle part of the {@link sap.f.DynamicPageTitle}.</xs:documentation>
</xs:annotation>
</xs:enumeration>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="_LayoutTypeType">
<xs:restriction base="xs:string">
<xs:enumeration value="EndColumnFullScreen">
<xs:annotation>
<xs:documentation>Desktop: -/-/100 only the End column is displayed
Tablet: -/-/100 only the End column is displayed
Phone: -/-/100 only the End column is displayed
Use to display a detail-detail page only, when the user should focus entirely on it.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="MidColumnFullScreen">
<xs:annotation>
<xs:documentation>Desktop: -/100/- only the Mid column is displayed
Tablet: -/100/- only the Mid column is displayed
Phone: -/100/- only the Mid column is displayed
Use to display a detail page only, when the user should focus entirely on it.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="OneColumn">
<xs:annotation>
<xs:documentation>Desktop: 100/-/- only the Begin column is displayed
Tablet: 100/-/- only the Begin column is displayed
Phone: 100/-/- only the Begin column is displayed
Use to start with a master page.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="ThreeColumnsBeginExpandedEndHidden">
<xs:annotation>
<xs:documentation>Desktop: 67/33/0 Begin (expanded) and Mid columns are displayed, End is accessible by layout arrows
Tablet: 67/33/0 Begin (expanded) and Mid columns are displayed, End is accessible by layout arrows
Phone: -/-/100 only the End column is displayed
Use to display the master and detail pages when the user should focus on the master. The detail-detail is still loaded and easily accessible with layout arrows.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="ThreeColumnsEndExpanded">
<xs:annotation>
<xs:documentation>Desktop: 25/25/50 Begin, Mid and End (expanded) columns are displayed
Tablet: 0/33/67 Mid and End (expanded) columns are displayed, Begin is accessible by layout arrows
Phone: -/-/100 (only the End column is displayed)
Use to display all three pages (master, detail, detail-detail) when the user should focus on the detail-detail.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="ThreeColumnsMidExpanded">
<xs:annotation>
<xs:documentation>Desktop: 25/50/25 Begin, Mid (expanded) and End columns are displayed
Tablet: 0/67/33 Mid (expanded) and End columns are displayed, Begin is accessible by a layout arrow
Phone: -/-/100 only the End column is displayed
Use to display all three pages (master, detail, detail-detail) when the user should focus on the detail.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="ThreeColumnsMidExpandedEndHidden">
<xs:annotation>
<xs:documentation>Desktop: 33/67/0 Begin and Mid (expanded) columns are displayed, End is accessible by a layout arrow
Tablet: 33/67/0 Begin and Mid (expanded) columns are displayed, End is accessible by a layout arrow
Phone: -/-/100 only the End column is displayed
Use to display the master and detail pages when the user should focus on the detail. The detail-detail is still loaded and easily accessible with a layout arrow.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="TwoColumnsBeginExpanded">
<xs:annotation>
<xs:documentation>Desktop: 67/33/- Begin (expanded) and Mid columns are displayed
Tablet: 67/33/- Begin (expanded) and Mid columns are displayed
Phone: -/100/- only the Mid column is displayed
Use to display both a master and a detail page when the user should focus on the master page.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="TwoColumnsMidExpanded">
<xs:annotation>
<xs:documentation>Desktop: 33/67/- Begin and Mid (expanded) columns are displayed
Tablet: 33/67/- Begin and Mid (expanded) columns are displayed
Phone: -/100/- only the Mid column is displayed
Use to display both a master and a detail page when the user should focus on the detail page.</xs:documentation>
</xs:annotation>
</xs:enumeration>
</xs:restriction>
</xs:simpleType>
</xs:schema>