@openui5/ts-types 1.101.0 → 1.102.2

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.
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.101.0
1
+ // For Library Version: 1.102.2
2
2
 
3
3
  declare namespace sap {
4
4
  /**
@@ -55,12 +55,18 @@ declare namespace sap {
55
55
  * Determines whether to show a Popover with Subsection links when clicking on Section links in the Anchor
56
56
  * bar.
57
57
  */
58
- showPopover?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
58
+ showPopover?:
59
+ | boolean
60
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
61
+ | `{${string}}`;
59
62
 
60
63
  /**
61
64
  * Determines whether the Anchor bar items are displayed in upper case.
62
65
  */
63
- upperCase?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
66
+ upperCase?:
67
+ | boolean
68
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
69
+ | `{${string}}`;
64
70
 
65
71
  /**
66
72
  * @SINCE 1.58
@@ -72,7 +78,8 @@ declare namespace sap {
72
78
  */
73
79
  backgroundDesign?:
74
80
  | sap.m.BackgroundDesign
75
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
81
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
82
+ | `{${string}}`;
76
83
 
77
84
  /**
78
85
  * The button that represents the Section being scrolled by the user.
@@ -92,7 +99,10 @@ declare namespace sap {
92
99
  /**
93
100
  * Determines the visibility of the block.
94
101
  */
95
- visible?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
102
+ visible?:
103
+ | boolean
104
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
105
+ | `{${string}}`;
96
106
 
97
107
  /**
98
108
  * Determines on how many columns the layout will be rendered. Allowed values are integers from 1 to 4 and
@@ -100,7 +110,8 @@ declare namespace sap {
100
110
  */
101
111
  columnLayout?:
102
112
  | sap.uxap.BlockBaseColumnLayout
103
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
113
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
114
+ | `{${string}}`;
104
115
 
105
116
  /**
106
117
  * Determines if the block should automatically adjust its inner forms. Allowed values are "BlockColumns"
@@ -111,7 +122,8 @@ declare namespace sap {
111
122
  */
112
123
  formAdjustment?:
113
124
  | sap.uxap.BlockBaseFormAdjustment
114
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
125
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
126
+ | `{${string}}`;
115
127
 
116
128
  /**
117
129
  * Determines whether the show more button should be shown.
@@ -121,7 +133,8 @@ declare namespace sap {
121
133
  */
122
134
  showSubSectionMore?:
123
135
  | boolean
124
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
136
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
137
+ | `{${string}}`;
125
138
 
126
139
  /**
127
140
  * Map external UI5 model and internal Block model
@@ -129,7 +142,8 @@ declare namespace sap {
129
142
  mappings?:
130
143
  | sap.uxap.ModelMapping[]
131
144
  | sap.uxap.ModelMapping
132
- | sap.ui.base.ManagedObject.AggregationBindingInfo;
145
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
146
+ | `{${string}}`;
133
147
 
134
148
  /**
135
149
  * The current view. Corresponds to the currently specified `mode` of the sap.uxap.BlockBase.
@@ -155,7 +169,8 @@ declare namespace sap {
155
169
  */
156
170
  showCurrentLocation?:
157
171
  | boolean
158
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
172
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
173
+ | `{${string}}`;
159
174
 
160
175
  /**
161
176
  * A list of all the active link elements in the BreadCrumbs control.
@@ -163,7 +178,8 @@ declare namespace sap {
163
178
  links?:
164
179
  | sap.m.Link[]
165
180
  | sap.m.Link
166
- | sap.ui.base.ManagedObject.AggregationBindingInfo;
181
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
182
+ | `{${string}}`;
167
183
 
168
184
  /**
169
185
  * The current/last element in the BreadCrumbs path.
@@ -175,7 +191,10 @@ declare namespace sap {
175
191
  /**
176
192
  * Determines whether the HierarchicalSelect items are displayed in upper case.
177
193
  */
178
- upperCase?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
194
+ upperCase?:
195
+ | boolean
196
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
197
+ | `{${string}}`;
179
198
  }
180
199
 
181
200
  interface $ModelMappingSettings extends sap.ui.core.$ElementSettings {
@@ -208,7 +227,8 @@ declare namespace sap {
208
227
  */
209
228
  rootRole?:
210
229
  | sap.ui.core.AccessibleLandmarkRole
211
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
230
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
231
+ | `{${string}}`;
212
232
 
213
233
  /**
214
234
  * Texts which describe the landmark of the root container of the corresponding `sap.uxap.ObjectPageLayout`
@@ -226,7 +246,8 @@ declare namespace sap {
226
246
  */
227
247
  contentRole?:
228
248
  | sap.ui.core.AccessibleLandmarkRole
229
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
249
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
250
+ | `{${string}}`;
230
251
 
231
252
  /**
232
253
  * Texts which describe the landmark of the content container of the corresponding `sap.uxap.ObjectPageLayout`
@@ -244,7 +265,8 @@ declare namespace sap {
244
265
  */
245
266
  navigationRole?:
246
267
  | sap.ui.core.AccessibleLandmarkRole
247
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
268
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
269
+ | `{${string}}`;
248
270
 
249
271
  /**
250
272
  * Texts which describe the landmark of the navigation container of the corresponding `sap.uxap.ObjectPageLayout`
@@ -262,7 +284,8 @@ declare namespace sap {
262
284
  */
263
285
  headerRole?:
264
286
  | sap.ui.core.AccessibleLandmarkRole
265
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
287
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
288
+ | `{${string}}`;
266
289
 
267
290
  /**
268
291
  * Texts which describe the landmark of the header container of the corresponding `sap.uxap.ObjectPageLayout`
@@ -280,7 +303,8 @@ declare namespace sap {
280
303
  */
281
304
  footerRole?:
282
305
  | sap.ui.core.AccessibleLandmarkRole
283
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
306
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
307
+ | `{${string}}`;
284
308
 
285
309
  /**
286
310
  * Texts which describe the landmark of the header container of the corresponding `sap.uxap.ObjectPageLayout`
@@ -315,7 +339,8 @@ declare namespace sap {
315
339
  */
316
340
  objectImageDensityAware?:
317
341
  | boolean
318
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
342
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
343
+ | `{${string}}`;
319
344
 
320
345
  /**
321
346
  * The title of the object
@@ -332,7 +357,8 @@ declare namespace sap {
332
357
  */
333
358
  objectImageShape?:
334
359
  | sap.m.AvatarShape
335
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
360
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
361
+ | `{${string}}`;
336
362
 
337
363
  /**
338
364
  * @SINCE 1.73
@@ -341,35 +367,40 @@ declare namespace sap {
341
367
  */
342
368
  objectImageBackgroundColor?:
343
369
  | sap.m.AvatarColor
344
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
370
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
371
+ | `{${string}}`;
345
372
 
346
373
  /**
347
374
  * Determines whether the icon should always be visible or visible only when the header is snapped.
348
375
  */
349
376
  isObjectIconAlwaysVisible?:
350
377
  | boolean
351
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
378
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
379
+ | `{${string}}`;
352
380
 
353
381
  /**
354
382
  * Determines whether the title should always be visible or visible only when the header is snapped.
355
383
  */
356
384
  isObjectTitleAlwaysVisible?:
357
385
  | boolean
358
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
386
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
387
+ | `{${string}}`;
359
388
 
360
389
  /**
361
390
  * Determines whether the subtitle should always be visible or visible only when the header is snapped.
362
391
  */
363
392
  isObjectSubtitleAlwaysVisible?:
364
393
  | boolean
365
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
394
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
395
+ | `{${string}}`;
366
396
 
367
397
  /**
368
398
  * Determines whether the action buttons should always be visible or visible only when the header is snapped.
369
399
  */
370
400
  isActionAreaAlwaysVisible?:
371
401
  | boolean
372
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
402
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
403
+ | `{${string}}`;
373
404
 
374
405
  /**
375
406
  * @deprecated (since 1.40.1)
@@ -379,42 +410,59 @@ declare namespace sap {
379
410
  */
380
411
  headerDesign?:
381
412
  | sap.uxap.ObjectPageHeaderDesign
382
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
413
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
414
+ | `{${string}}`;
383
415
 
384
416
  /**
385
417
  * When set to true, the selector arrow icon/image is shown and can be pressed.
386
418
  */
387
419
  showTitleSelector?:
388
420
  | boolean
389
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
421
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
422
+ | `{${string}}`;
390
423
 
391
424
  /**
392
425
  * Set the favorite state to true or false. The showMarkers property must be true for this property to take
393
426
  * effect.
394
427
  */
395
- markFavorite?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
428
+ markFavorite?:
429
+ | boolean
430
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
431
+ | `{${string}}`;
396
432
 
397
433
  /**
398
434
  * Set the flagged state to true or false. The showMarkers property must be true for this property to take
399
435
  * effect.
400
436
  */
401
- markFlagged?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
437
+ markFlagged?:
438
+ | boolean
439
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
440
+ | `{${string}}`;
402
441
 
403
442
  /**
404
443
  * Indicates if object page header title supports showing markers such as flagged and favorite.
405
444
  */
406
- showMarkers?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
445
+ showMarkers?:
446
+ | boolean
447
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
448
+ | `{${string}}`;
407
449
 
408
450
  /**
409
451
  * Set the locked state of the objectPageHeader.
410
452
  */
411
- markLocked?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
453
+ markLocked?:
454
+ | boolean
455
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
456
+ | `{${string}}`;
412
457
 
413
458
  /**
414
459
  * Enables support of a placeholder image in case no image is specified or the URL of the provided image
415
460
  * is invalid.
416
461
  */
417
- showPlaceholder?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
462
+ showPlaceholder?:
463
+ | boolean
464
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
465
+ | `{${string}}`;
418
466
 
419
467
  /**
420
468
  * @SINCE 1.34.0
@@ -422,7 +470,10 @@ declare namespace sap {
422
470
  * Marks that there are unsaved changes in the objectPageHeader. The markChanges state cannot be used together
423
471
  * with the markLocked state. If both are set to true, only the locked state will be displayed.
424
472
  */
425
- markChanges?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
473
+ markChanges?:
474
+ | boolean
475
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
476
+ | `{${string}}`;
426
477
 
427
478
  /**
428
479
  * @SINCE 1.50
@@ -440,7 +491,8 @@ declare namespace sap {
440
491
  breadCrumbsLinks?:
441
492
  | sap.m.Link[]
442
493
  | sap.m.Link
443
- | sap.ui.base.ManagedObject.AggregationBindingInfo;
494
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
495
+ | `{${string}}`;
444
496
 
445
497
  /**
446
498
  * An instance of sap.m.Bar to be embedded in the header
@@ -459,7 +511,8 @@ declare namespace sap {
459
511
  actions?:
460
512
  | sap.ui.core.Control[]
461
513
  | sap.ui.core.Control
462
- | sap.ui.base.ManagedObject.AggregationBindingInfo;
514
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
515
+ | `{${string}}`;
463
516
 
464
517
  /**
465
518
  * @SINCE 1.38.0
@@ -506,14 +559,20 @@ declare namespace sap {
506
559
  * if you want to display icons only in the headerTitle part but still want to display text + icon in the
507
560
  * actionSheet that appears when not enough space is available on the screen for displaying all actions.
508
561
  */
509
- hideText?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
562
+ hideText?:
563
+ | boolean
564
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
565
+ | `{${string}}`;
510
566
 
511
567
  /**
512
568
  * Hide the button icon when rendered into the headerTitle part of the ObjectPageLayout. This is useful
513
569
  * if you want to display texts only in the headerTitle part but still want to display text + icon in the
514
570
  * actionSheet that appears when not enough space is available on the screen for displaying all actions.
515
571
  */
516
- hideIcon?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
572
+ hideIcon?:
573
+ | boolean
574
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
575
+ | `{${string}}`;
517
576
 
518
577
  /**
519
578
  * @SINCE 1.34.0
@@ -522,7 +581,8 @@ declare namespace sap {
522
581
  */
523
582
  importance?:
524
583
  | sap.uxap.Importance
525
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
584
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
585
+ | `{${string}}`;
526
586
  }
527
587
 
528
588
  interface $ObjectPageHeaderContentSettings
@@ -535,7 +595,8 @@ declare namespace sap {
535
595
  */
536
596
  contentDesign?:
537
597
  | sap.uxap.ObjectPageHeaderDesign
538
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
598
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
599
+ | `{${string}}`;
539
600
 
540
601
  /**
541
602
  * The list of Objects of type sap.ui.core.Control.
@@ -543,7 +604,8 @@ declare namespace sap {
543
604
  content?:
544
605
  | sap.ui.core.Control[]
545
606
  | sap.ui.core.Control
546
- | sap.ui.base.ManagedObject.AggregationBindingInfo;
607
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
608
+ | `{${string}}`;
547
609
  }
548
610
 
549
611
  interface $ObjectPageHeaderLayoutDataSettings
@@ -551,45 +613,60 @@ declare namespace sap {
551
613
  /**
552
614
  * If this property is set the control will be visible (or not) in a small sized layout.
553
615
  */
554
- visibleS?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
616
+ visibleS?:
617
+ | boolean
618
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
619
+ | `{${string}}`;
555
620
 
556
621
  /**
557
622
  * If this property is set the control will be visible (or not) in a medium sized layout.
558
623
  */
559
- visibleM?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
624
+ visibleM?:
625
+ | boolean
626
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
627
+ | `{${string}}`;
560
628
 
561
629
  /**
562
630
  * If this property is set the control will be visible (or not) in a large sized layout.
563
631
  */
564
- visibleL?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
632
+ visibleL?:
633
+ | boolean
634
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
635
+ | `{${string}}`;
565
636
 
566
637
  /**
567
638
  * If this property is set the control will display a separator before it.
568
639
  */
569
640
  showSeparatorBefore?:
570
641
  | boolean
571
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
642
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
643
+ | `{${string}}`;
572
644
 
573
645
  /**
574
646
  * If this property is set the control will display a separator after it.
575
647
  */
576
648
  showSeparatorAfter?:
577
649
  | boolean
578
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
650
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
651
+ | `{${string}}`;
579
652
 
580
653
  /**
581
654
  * If this property is set the control will take the provided size.
582
655
  */
583
656
  width?:
584
657
  | sap.ui.core.CSSSize
585
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
658
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
659
+ | `{${string}}`;
586
660
  }
587
661
 
588
662
  interface $ObjectPageLayoutSettings extends sap.ui.core.$ControlSettings {
589
663
  /**
590
664
  * Determines whether the Navigation bar (Anchor bar) is displayed.
591
665
  */
592
- showAnchorBar?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
666
+ showAnchorBar?:
667
+ | boolean
668
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
669
+ | `{${string}}`;
593
670
 
594
671
  /**
595
672
  * Determines whether to show a Popover with Subsection links when clicking on Section links in the Anchor
@@ -597,14 +674,16 @@ declare namespace sap {
597
674
  */
598
675
  showAnchorBarPopover?:
599
676
  | boolean
600
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
677
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
678
+ | `{${string}}`;
601
679
 
602
680
  /**
603
681
  * Determines whether the Anchor bar items are displayed in upper case.
604
682
  */
605
683
  upperCaseAnchorBar?:
606
684
  | boolean
607
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
685
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
686
+ | `{${string}}`;
608
687
 
609
688
  /**
610
689
  * @SINCE 1.58
@@ -616,28 +695,32 @@ declare namespace sap {
616
695
  */
617
696
  backgroundDesignAnchorBar?:
618
697
  | sap.m.BackgroundDesign
619
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
698
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
699
+ | `{${string}}`;
620
700
 
621
701
  /**
622
702
  * Determines the height of the ObjectPage.
623
703
  */
624
704
  height?:
625
705
  | sap.ui.core.CSSSize
626
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
706
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
707
+ | `{${string}}`;
627
708
 
628
709
  /**
629
710
  * Enable lazy loading for the Object page Subsections.
630
711
  */
631
712
  enableLazyLoading?:
632
713
  | boolean
633
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
714
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
715
+ | `{${string}}`;
634
716
 
635
717
  /**
636
718
  * Determines whether Subsection titles are displayed on top or to the left of the Subsection content.
637
719
  */
638
720
  subSectionLayout?:
639
721
  | sap.uxap.ObjectPageSubSectionLayout
640
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
722
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
723
+ | `{${string}}`;
641
724
 
642
725
  /**
643
726
  * @SINCE 1.44.0
@@ -664,7 +747,8 @@ declare namespace sap {
664
747
  */
665
748
  sectionTitleLevel?:
666
749
  | sap.ui.core.TitleLevel
667
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
750
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
751
+ | `{${string}}`;
668
752
 
669
753
  /**
670
754
  * Determines whether the navigation mode is tab-based instead of the default anchor bar. If enabled, the
@@ -672,21 +756,26 @@ declare namespace sap {
672
756
  *
673
757
  * **Note:** Keep in mind that the `sap.m.IconTabBar` control is no longer used for the tab navigation mode.
674
758
  */
675
- useIconTabBar?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
759
+ useIconTabBar?:
760
+ | boolean
761
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
762
+ | `{${string}}`;
676
763
 
677
764
  /**
678
765
  * Determines the visibility of the Header content (headerContent aggregation).
679
766
  */
680
767
  showHeaderContent?:
681
768
  | boolean
682
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
769
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
770
+ | `{${string}}`;
683
771
 
684
772
  /**
685
773
  * Determines whether the to use two column layout for the L screen size.
686
774
  */
687
775
  useTwoColumnsForLargeScreen?:
688
776
  | boolean
689
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
777
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
778
+ | `{${string}}`;
690
779
 
691
780
  /**
692
781
  * Determines whether the title, image, markers and selectTitleArrow are shown in the Header content area.
@@ -696,7 +785,8 @@ declare namespace sap {
696
785
  */
697
786
  showTitleInHeaderContent?:
698
787
  | boolean
699
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
788
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
789
+ | `{${string}}`;
700
790
 
701
791
  /**
702
792
  * @SINCE 1.32.0
@@ -705,7 +795,8 @@ declare namespace sap {
705
795
  */
706
796
  showOnlyHighImportance?:
707
797
  | boolean
708
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
798
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
799
+ | `{${string}}`;
709
800
 
710
801
  /**
711
802
  * @SINCE 1.34.0
@@ -716,7 +807,10 @@ declare namespace sap {
716
807
  * **Note**: This property is only taken into account if an instance of `sap.uxap.ObjectPageHeader` is used
717
808
  * for the `headerTitle` aggregation.
718
809
  */
719
- isChildPage?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
810
+ isChildPage?:
811
+ | boolean
812
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
813
+ | `{${string}}`;
720
814
 
721
815
  /**
722
816
  * @SINCE 1.34.0
@@ -728,7 +822,8 @@ declare namespace sap {
728
822
  */
729
823
  alwaysShowContentHeader?:
730
824
  | boolean
731
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
825
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
826
+ | `{${string}}`;
732
827
 
733
828
  /**
734
829
  * @SINCE 1.52
@@ -743,7 +838,8 @@ declare namespace sap {
743
838
  */
744
839
  headerContentPinnable?:
745
840
  | boolean
746
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
841
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
842
+ | `{${string}}`;
747
843
 
748
844
  /**
749
845
  * @SINCE 1.93
@@ -765,7 +861,8 @@ declare namespace sap {
765
861
  */
766
862
  headerContentPinned?:
767
863
  | boolean
768
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
864
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
865
+ | `{${string}}`;
769
866
 
770
867
  /**
771
868
  * @SINCE 1.52
@@ -780,7 +877,8 @@ declare namespace sap {
780
877
  */
781
878
  toggleHeaderOnTitleClick?:
782
879
  | boolean
783
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
880
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
881
+ | `{${string}}`;
784
882
 
785
883
  /**
786
884
  * @SINCE 1.52
@@ -797,7 +895,8 @@ declare namespace sap {
797
895
  */
798
896
  preserveHeaderStateOnScroll?:
799
897
  | boolean
800
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
898
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
899
+ | `{${string}}`;
801
900
 
802
901
  /**
803
902
  * @SINCE 1.34.0
@@ -809,7 +908,8 @@ declare namespace sap {
809
908
  */
810
909
  showEditHeaderButton?:
811
910
  | boolean
812
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
911
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
912
+ | `{${string}}`;
813
913
 
814
914
  /**
815
915
  * @SINCE 1.34.0
@@ -817,14 +917,20 @@ declare namespace sap {
817
917
  * Specifies whether the object page enables flexibility features, such as hiding and adding sections.
818
918
  * For more information about SAPUI5 flexibility, refer to the Developer Guide.
819
919
  */
820
- flexEnabled?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
920
+ flexEnabled?:
921
+ | boolean
922
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
923
+ | `{${string}}`;
821
924
 
822
925
  /**
823
926
  * @SINCE 1.40
824
927
  *
825
928
  * Determines whether the footer is visible.
826
929
  */
827
- showFooter?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
930
+ showFooter?:
931
+ | boolean
932
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
933
+ | `{${string}}`;
828
934
 
829
935
  /**
830
936
  * The sections that make up the Object page content area.
@@ -832,7 +938,8 @@ declare namespace sap {
832
938
  sections?:
833
939
  | sap.uxap.ObjectPageSection[]
834
940
  | sap.uxap.ObjectPageSection
835
- | sap.ui.base.ManagedObject.AggregationBindingInfo;
941
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
942
+ | `{${string}}`;
836
943
 
837
944
  /**
838
945
  * Object page header title - the upper, always static, part of the Object page header.
@@ -845,7 +952,8 @@ declare namespace sap {
845
952
  headerContent?:
846
953
  | sap.ui.core.Control[]
847
954
  | sap.ui.core.Control
848
- | sap.ui.base.ManagedObject.AggregationBindingInfo;
955
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
956
+ | `{${string}}`;
849
957
 
850
958
  /**
851
959
  * @SINCE 1.40
@@ -917,7 +1025,8 @@ declare namespace sap {
917
1025
  content?:
918
1026
  | sap.ui.core.Control[]
919
1027
  | sap.ui.core.Control
920
- | sap.ui.base.ManagedObject.AggregationBindingInfo;
1028
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
1029
+ | `{${string}}`;
921
1030
  }
922
1031
 
923
1032
  interface $ObjectPageSectionSettings
@@ -925,12 +1034,18 @@ declare namespace sap {
925
1034
  /**
926
1035
  * Determines whether to display the Section title or not.
927
1036
  */
928
- showTitle?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
1037
+ showTitle?:
1038
+ | boolean
1039
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1040
+ | `{${string}}`;
929
1041
 
930
1042
  /**
931
1043
  * Determines whether the Section title is displayed in upper case.
932
1044
  */
933
- titleUppercase?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
1045
+ titleUppercase?:
1046
+ | boolean
1047
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1048
+ | `{${string}}`;
934
1049
 
935
1050
  /**
936
1051
  * The list of Subsections.
@@ -938,7 +1053,8 @@ declare namespace sap {
938
1053
  subSections?:
939
1054
  | sap.uxap.ObjectPageSubSection[]
940
1055
  | sap.uxap.ObjectPageSubSection
941
- | sap.ui.base.ManagedObject.AggregationBindingInfo;
1056
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
1057
+ | `{${string}}`;
942
1058
 
943
1059
  /**
944
1060
  * The most recently selected Subsection by the user.
@@ -970,12 +1086,16 @@ declare namespace sap {
970
1086
  */
971
1087
  titleLevel?:
972
1088
  | sap.ui.core.TitleLevel
973
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1089
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1090
+ | `{${string}}`;
974
1091
 
975
1092
  /**
976
1093
  * Invisible ObjectPageSectionBase are not rendered
977
1094
  */
978
- visible?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
1095
+ visible?:
1096
+ | boolean
1097
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1098
+ | `{${string}}`;
979
1099
 
980
1100
  /**
981
1101
  * @SINCE 1.32.0
@@ -984,7 +1104,8 @@ declare namespace sap {
984
1104
  */
985
1105
  importance?:
986
1106
  | sap.uxap.Importance
987
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1107
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1108
+ | `{${string}}`;
988
1109
 
989
1110
  /**
990
1111
  * The custom button that will provide a link to the section in the ObjectPageLayout anchor bar. This button
@@ -1009,7 +1130,10 @@ declare namespace sap {
1009
1130
  * which is the only one (or the only one visible), you need to set the `showTitle` properties to `false`
1010
1131
  * for both the section and its subsection.
1011
1132
  */
1012
- showTitle?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
1133
+ showTitle?:
1134
+ | boolean
1135
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1136
+ | `{${string}}`;
1013
1137
 
1014
1138
  /**
1015
1139
  * A mode property that will be passed to the controls in the blocks and moreBlocks aggregations. Only relevant
@@ -1017,12 +1141,16 @@ declare namespace sap {
1017
1141
  */
1018
1142
  mode?:
1019
1143
  | sap.uxap.ObjectPageSubSectionMode
1020
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1144
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1145
+ | `{${string}}`;
1021
1146
 
1022
1147
  /**
1023
1148
  * Determines whether the Subsection title is displayed in upper case.
1024
1149
  */
1025
- titleUppercase?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
1150
+ titleUppercase?:
1151
+ | boolean
1152
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1153
+ | `{${string}}`;
1026
1154
 
1027
1155
  /**
1028
1156
  * Controls to be displayed in the subsection
@@ -1049,7 +1177,8 @@ declare namespace sap {
1049
1177
  blocks?:
1050
1178
  | sap.ui.core.Control[]
1051
1179
  | sap.ui.core.Control
1052
- | sap.ui.base.ManagedObject.AggregationBindingInfo;
1180
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
1181
+ | `{${string}}`;
1053
1182
 
1054
1183
  /**
1055
1184
  * Additional controls to display when the Show more / See all / (...) button is pressed
@@ -1057,7 +1186,8 @@ declare namespace sap {
1057
1186
  moreBlocks?:
1058
1187
  | sap.ui.core.Control[]
1059
1188
  | sap.ui.core.Control
1060
- | sap.ui.base.ManagedObject.AggregationBindingInfo;
1189
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
1190
+ | `{${string}}`;
1061
1191
 
1062
1192
  /**
1063
1193
  * Actions available for this subsection.
@@ -1072,7 +1202,8 @@ declare namespace sap {
1072
1202
  actions?:
1073
1203
  | sap.ui.core.Control[]
1074
1204
  | sap.ui.core.Control
1075
- | sap.ui.base.ManagedObject.AggregationBindingInfo;
1205
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
1206
+ | `{${string}}`;
1076
1207
  }
1077
1208
 
1078
1209
  /**
@@ -1128,6 +1259,8 @@ declare namespace sap {
1128
1259
  * contained in `oClassInfo`.
1129
1260
  *
1130
1261
  * `oClassInfo` might contain the same kind of information as described in {@link sap.m.Toolbar.extend}.
1262
+ *
1263
+ * @returns Created class / constructor function
1131
1264
  */
1132
1265
  static extend<T extends Record<string, unknown>>(
1133
1266
  /**
@@ -1146,6 +1279,8 @@ declare namespace sap {
1146
1279
  ): Function;
1147
1280
  /**
1148
1281
  * Returns a metadata object for class sap.uxap.AnchorBar.
1282
+ *
1283
+ * @returns Metadata object describing this class
1149
1284
  */
1150
1285
  static getMetadata(): sap.ui.core.ElementMetadata;
1151
1286
  /**
@@ -1171,10 +1306,14 @@ declare namespace sap {
1171
1306
  *
1172
1307
  * **Note:** The default value of `backgroundDesign` property is null. If the property is not set, the color
1173
1308
  * of the background is `@sapUiObjectHeaderBackground`, which depends on the specific theme.
1309
+ *
1310
+ * @returns Value of property `backgroundDesign`
1174
1311
  */
1175
1312
  getBackgroundDesign(): sap.m.BackgroundDesign;
1176
1313
  /**
1177
1314
  * Returns an sap.ui.core.delegate.ScrollEnablement object used to handle scrolling.
1315
+ *
1316
+ * @returns The `sap.ui.core.delegate.ScrollEnablement` instance
1178
1317
  */
1179
1318
  getScrollDelegate(): sap.ui.core.delegate.ScrollEnablement;
1180
1319
  /**
@@ -1189,6 +1328,8 @@ declare namespace sap {
1189
1328
  * bar.
1190
1329
  *
1191
1330
  * Default value is `true`.
1331
+ *
1332
+ * @returns Value of property `showPopover`
1192
1333
  */
1193
1334
  getShowPopover(): boolean;
1194
1335
  /**
@@ -1197,8 +1338,14 @@ declare namespace sap {
1197
1338
  * Determines whether the Anchor bar items are displayed in upper case.
1198
1339
  *
1199
1340
  * Default value is `false`.
1341
+ *
1342
+ * @returns Value of property `upperCase`
1200
1343
  */
1201
1344
  getUpperCase(): boolean;
1345
+ /**
1346
+ * Scrolls to the currently selected Section tab, when the header titles is snapped/unsnapped
1347
+ */
1348
+ scrollToCurrentlySelectedSection(): void;
1202
1349
  /**
1203
1350
  * Scroll to a specific Section.
1204
1351
  */
@@ -1223,6 +1370,8 @@ declare namespace sap {
1223
1370
  * of the background is `@sapUiObjectHeaderBackground`, which depends on the specific theme.
1224
1371
  *
1225
1372
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1373
+ *
1374
+ * @returns Reference to `this` in order to allow method chaining
1226
1375
  */
1227
1376
  setBackgroundDesign(
1228
1377
  /**
@@ -1232,6 +1381,8 @@ declare namespace sap {
1232
1381
  ): this;
1233
1382
  /**
1234
1383
  * Sets the associated {@link #getSelectedButton selectedButton}.
1384
+ *
1385
+ * @returns Reference to `this` in order to allow method chaining
1235
1386
  */
1236
1387
  setSelectedButton(
1237
1388
  /**
@@ -1249,6 +1400,8 @@ declare namespace sap {
1249
1400
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1250
1401
  *
1251
1402
  * Default value is `true`.
1403
+ *
1404
+ * @returns Reference to `this` in order to allow method chaining
1252
1405
  */
1253
1406
  setShowPopover(
1254
1407
  /**
@@ -1264,6 +1417,8 @@ declare namespace sap {
1264
1417
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1265
1418
  *
1266
1419
  * Default value is `false`.
1420
+ *
1421
+ * @returns Reference to `this` in order to allow method chaining
1267
1422
  */
1268
1423
  setUpperCase(
1269
1424
  /**
@@ -1335,6 +1490,8 @@ declare namespace sap {
1335
1490
  * contained in `oClassInfo`.
1336
1491
  *
1337
1492
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
1493
+ *
1494
+ * @returns Created class / constructor function
1338
1495
  */
1339
1496
  static extend<T extends Record<string, unknown>>(
1340
1497
  /**
@@ -1353,10 +1510,14 @@ declare namespace sap {
1353
1510
  ): Function;
1354
1511
  /**
1355
1512
  * Returns a metadata object for class sap.uxap.BlockBase.
1513
+ *
1514
+ * @returns Metadata object describing this class
1356
1515
  */
1357
1516
  static getMetadata(): sap.ui.core.ElementMetadata;
1358
1517
  /**
1359
1518
  * Adds some mapping to the aggregation {@link #getMappings mappings}.
1519
+ *
1520
+ * @returns Reference to `this` in order to allow method chaining
1360
1521
  */
1361
1522
  addMapping(
1362
1523
  /**
@@ -1373,6 +1534,8 @@ declare namespace sap {
1373
1534
  * otherwise it will be bound to this `sap.uxap.BlockBase` itself.
1374
1535
  *
1375
1536
  * Fired when an aggregated view is instantiated.
1537
+ *
1538
+ * @returns Reference to `this` in order to allow method chaining
1376
1539
  */
1377
1540
  attachViewInit(
1378
1541
  /**
@@ -1398,6 +1561,8 @@ declare namespace sap {
1398
1561
  * otherwise it will be bound to this `sap.uxap.BlockBase` itself.
1399
1562
  *
1400
1563
  * Fired when an aggregated view is instantiated.
1564
+ *
1565
+ * @returns Reference to `this` in order to allow method chaining
1401
1566
  */
1402
1567
  attachViewInit(
1403
1568
  /**
@@ -1411,6 +1576,8 @@ declare namespace sap {
1411
1576
  ): this;
1412
1577
  /**
1413
1578
  * Creates a view.
1579
+ *
1580
+ * @returns A promise on the created view.
1414
1581
  */
1415
1582
  createView(
1416
1583
  /**
@@ -1424,6 +1591,8 @@ declare namespace sap {
1424
1591
  ): Promise<sap.ui.core.mvc.View>;
1425
1592
  /**
1426
1593
  * Destroys all the mappings in the aggregation {@link #getMappings mappings}.
1594
+ *
1595
+ * @returns Reference to `this` in order to allow method chaining
1427
1596
  */
1428
1597
  destroyMappings(): this;
1429
1598
  /**
@@ -1432,6 +1601,8 @@ declare namespace sap {
1432
1601
  * Detaches event handler `fnFunction` from the {@link #event:viewInit viewInit} event of this `sap.uxap.BlockBase`.
1433
1602
  *
1434
1603
  * The passed function and listener object must match the ones used for event registration.
1604
+ *
1605
+ * @returns Reference to `this` in order to allow method chaining
1435
1606
  */
1436
1607
  detachViewInit(
1437
1608
  /**
@@ -1447,6 +1618,8 @@ declare namespace sap {
1447
1618
  * @SINCE 1.72
1448
1619
  *
1449
1620
  * Fires event {@link #event:viewInit viewInit} to attached listeners.
1621
+ *
1622
+ * @returns Reference to `this` in order to allow method chaining
1450
1623
  */
1451
1624
  fireViewInit(
1452
1625
  /**
@@ -1466,6 +1639,8 @@ declare namespace sap {
1466
1639
  * "auto".
1467
1640
  *
1468
1641
  * Default value is `"auto"`.
1642
+ *
1643
+ * @returns Value of property `columnLayout`
1469
1644
  */
1470
1645
  getColumnLayout(): sap.uxap.BlockBaseColumnLayout;
1471
1646
  /**
@@ -1478,6 +1653,8 @@ declare namespace sap {
1478
1653
  * inner forms will be made and the form will keep its original column count.
1479
1654
  *
1480
1655
  * Default value is `BlockColumns`.
1656
+ *
1657
+ * @returns Value of property `formAdjustment`
1481
1658
  */
1482
1659
  getFormAdjustment(): sap.uxap.BlockBaseFormAdjustment;
1483
1660
  /**
@@ -1493,6 +1670,8 @@ declare namespace sap {
1493
1670
  * When `BlockBase` is used inside an `ObjectPageLayout`, the `mode` property is inherited from the respective
1494
1671
  * {@link sap.uxap.ObjectPageSubSection SubSection}. The `mode` property of `BlockBase` changes when the
1495
1672
  * `mode` property of `ObjectPageSubSection` changes.
1673
+ *
1674
+ * @returns Value of property `mode`
1496
1675
  */
1497
1676
  getMode(): string;
1498
1677
  /**
@@ -1509,6 +1688,8 @@ declare namespace sap {
1509
1688
  * be ignored in case the `BlockBase` is nested inside another `BlockBase`.
1510
1689
  *
1511
1690
  * Default value is `false`.
1691
+ *
1692
+ * @returns Value of property `showSubSectionMore`
1512
1693
  */
1513
1694
  getShowSubSectionMore(): boolean;
1514
1695
  /**
@@ -1517,11 +1698,15 @@ declare namespace sap {
1517
1698
  * Determines the visibility of the block.
1518
1699
  *
1519
1700
  * Default value is `true`.
1701
+ *
1702
+ * @returns Value of property `visible`
1520
1703
  */
1521
1704
  getVisible(): boolean;
1522
1705
  /**
1523
1706
  * Checks for the provided `sap.uxap.ModelMapping` in the aggregation {@link #getMappings mappings}. and
1524
1707
  * returns its index if found or -1 otherwise.
1708
+ *
1709
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
1525
1710
  */
1526
1711
  indexOfMapping(
1527
1712
  /**
@@ -1531,6 +1716,8 @@ declare namespace sap {
1531
1716
  ): int;
1532
1717
  /**
1533
1718
  * Inserts a mapping into the aggregation {@link #getMappings mappings}.
1719
+ *
1720
+ * @returns Reference to `this` in order to allow method chaining
1534
1721
  */
1535
1722
  insertMapping(
1536
1723
  /**
@@ -1548,10 +1735,14 @@ declare namespace sap {
1548
1735
  * Removes all the controls from the aggregation {@link #getMappings mappings}.
1549
1736
  *
1550
1737
  * Additionally, it unregisters them from the hosting UIArea.
1738
+ *
1739
+ * @returns An array of the removed elements (might be empty)
1551
1740
  */
1552
1741
  removeAllMappings(): sap.uxap.ModelMapping[];
1553
1742
  /**
1554
1743
  * Removes a mapping from the aggregation {@link #getMappings mappings}.
1744
+ *
1745
+ * @returns The removed mapping or `null`
1555
1746
  */
1556
1747
  removeMapping(
1557
1748
  /**
@@ -1561,6 +1752,8 @@ declare namespace sap {
1561
1752
  ): sap.uxap.ModelMapping;
1562
1753
  /**
1563
1754
  * Set the column layout for this particular block.
1755
+ *
1756
+ * @returns this
1564
1757
  */
1565
1758
  setColumnLayout(
1566
1759
  /**
@@ -1580,6 +1773,8 @@ declare namespace sap {
1580
1773
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1581
1774
  *
1582
1775
  * Default value is `BlockColumns`.
1776
+ *
1777
+ * @returns Reference to `this` in order to allow method chaining
1583
1778
  */
1584
1779
  setFormAdjustment(
1585
1780
  /**
@@ -1589,6 +1784,8 @@ declare namespace sap {
1589
1784
  ): this;
1590
1785
  /**
1591
1786
  * Set the view mode for this particular block.
1787
+ *
1788
+ * @returns this
1592
1789
  */
1593
1790
  setMode(
1594
1791
  /**
@@ -1598,6 +1795,8 @@ declare namespace sap {
1598
1795
  ): any;
1599
1796
  /**
1600
1797
  * Sets the associated {@link #getSelectedView selectedView}.
1798
+ *
1799
+ * @returns Reference to `this` in order to allow method chaining
1601
1800
  */
1602
1801
  setSelectedView(
1603
1802
  /**
@@ -1617,6 +1816,8 @@ declare namespace sap {
1617
1816
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1618
1817
  *
1619
1818
  * Default value is `false`.
1819
+ *
1820
+ * @returns Reference to `this` in order to allow method chaining
1620
1821
  */
1621
1822
  setShowSubSectionMore(
1622
1823
  /**
@@ -1632,6 +1833,8 @@ declare namespace sap {
1632
1833
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1633
1834
  *
1634
1835
  * Default value is `true`.
1836
+ *
1837
+ * @returns Reference to `this` in order to allow method chaining
1635
1838
  */
1636
1839
  setVisible(
1637
1840
  /**
@@ -1692,6 +1895,8 @@ declare namespace sap {
1692
1895
  * information contained in `oClassInfo`.
1693
1896
  *
1694
1897
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
1898
+ *
1899
+ * @returns Created class / constructor function
1695
1900
  */
1696
1901
  static extend<T extends Record<string, unknown>>(
1697
1902
  /**
@@ -1710,10 +1915,14 @@ declare namespace sap {
1710
1915
  ): Function;
1711
1916
  /**
1712
1917
  * Returns a metadata object for class sap.uxap.BreadCrumbs.
1918
+ *
1919
+ * @returns Metadata object describing this class
1713
1920
  */
1714
1921
  static getMetadata(): sap.ui.core.ElementMetadata;
1715
1922
  /**
1716
1923
  * Adds some link to the aggregation {@link #getLinks links}.
1924
+ *
1925
+ * @returns Reference to `this` in order to allow method chaining
1717
1926
  */
1718
1927
  addLink(
1719
1928
  /**
@@ -1723,10 +1932,14 @@ declare namespace sap {
1723
1932
  ): this;
1724
1933
  /**
1725
1934
  * Destroys the currentLocation in the aggregation {@link #getCurrentLocation currentLocation}.
1935
+ *
1936
+ * @returns Reference to `this` in order to allow method chaining
1726
1937
  */
1727
1938
  destroyCurrentLocation(): this;
1728
1939
  /**
1729
1940
  * Destroys all the links in the aggregation {@link #getLinks links}.
1941
+ *
1942
+ * @returns Reference to `this` in order to allow method chaining
1730
1943
  */
1731
1944
  destroyLinks(): this;
1732
1945
  /**
@@ -1747,11 +1960,15 @@ declare namespace sap {
1747
1960
  * Sets the visibility of the current/last element in the BreadCrumbs path.
1748
1961
  *
1749
1962
  * Default value is `true`.
1963
+ *
1964
+ * @returns Value of property `showCurrentLocation`
1750
1965
  */
1751
1966
  getShowCurrentLocation(): boolean;
1752
1967
  /**
1753
1968
  * Checks for the provided `sap.m.Link` in the aggregation {@link #getLinks links}. and returns its index
1754
1969
  * if found or -1 otherwise.
1970
+ *
1971
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
1755
1972
  */
1756
1973
  indexOfLink(
1757
1974
  /**
@@ -1761,6 +1978,8 @@ declare namespace sap {
1761
1978
  ): int;
1762
1979
  /**
1763
1980
  * Inserts a link into the aggregation {@link #getLinks links}.
1981
+ *
1982
+ * @returns Reference to `this` in order to allow method chaining
1764
1983
  */
1765
1984
  insertLink(
1766
1985
  /**
@@ -1778,10 +1997,14 @@ declare namespace sap {
1778
1997
  * Removes all the controls from the aggregation {@link #getLinks links}.
1779
1998
  *
1780
1999
  * Additionally, it unregisters them from the hosting UIArea.
2000
+ *
2001
+ * @returns An array of the removed elements (might be empty)
1781
2002
  */
1782
2003
  removeAllLinks(): sap.m.Link[];
1783
2004
  /**
1784
2005
  * Removes a link from the aggregation {@link #getLinks links}.
2006
+ *
2007
+ * @returns The removed link or `null`
1785
2008
  */
1786
2009
  removeLink(
1787
2010
  /**
@@ -1791,6 +2014,8 @@ declare namespace sap {
1791
2014
  ): sap.m.Link;
1792
2015
  /**
1793
2016
  * Sets the aggregated {@link #getCurrentLocation currentLocation}.
2017
+ *
2018
+ * @returns Reference to `this` in order to allow method chaining
1794
2019
  */
1795
2020
  setCurrentLocation(
1796
2021
  /**
@@ -1806,6 +2031,8 @@ declare namespace sap {
1806
2031
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1807
2032
  *
1808
2033
  * Default value is `true`.
2034
+ *
2035
+ * @returns Reference to `this` in order to allow method chaining
1809
2036
  */
1810
2037
  setShowCurrentLocation(
1811
2038
  /**
@@ -1859,6 +2086,8 @@ declare namespace sap {
1859
2086
  * the information contained in `oClassInfo`.
1860
2087
  *
1861
2088
  * `oClassInfo` might contain the same kind of information as described in {@link sap.m.Select.extend}.
2089
+ *
2090
+ * @returns Created class / constructor function
1862
2091
  */
1863
2092
  static extend<T extends Record<string, unknown>>(
1864
2093
  /**
@@ -1877,6 +2106,8 @@ declare namespace sap {
1877
2106
  ): Function;
1878
2107
  /**
1879
2108
  * Returns a metadata object for class sap.uxap.HierarchicalSelect.
2109
+ *
2110
+ * @returns Metadata object describing this class
1880
2111
  */
1881
2112
  static getMetadata(): sap.ui.core.ElementMetadata;
1882
2113
  /**
@@ -1885,6 +2116,8 @@ declare namespace sap {
1885
2116
  * Determines whether the HierarchicalSelect items are displayed in upper case.
1886
2117
  *
1887
2118
  * Default value is `false`.
2119
+ *
2120
+ * @returns Value of property `upperCase`
1888
2121
  */
1889
2122
  getUpperCase(): boolean;
1890
2123
  /**
@@ -1895,6 +2128,8 @@ declare namespace sap {
1895
2128
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1896
2129
  *
1897
2130
  * Default value is `false`.
2131
+ *
2132
+ * @returns Reference to `this` in order to allow method chaining
1898
2133
  */
1899
2134
  setUpperCase(
1900
2135
  /**
@@ -1945,6 +2180,8 @@ declare namespace sap {
1945
2180
  * information contained in `oClassInfo`.
1946
2181
  *
1947
2182
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
2183
+ *
2184
+ * @returns Created class / constructor function
1948
2185
  */
1949
2186
  static extend<T extends Record<string, unknown>>(
1950
2187
  /**
@@ -1963,18 +2200,24 @@ declare namespace sap {
1963
2200
  ): Function;
1964
2201
  /**
1965
2202
  * Returns a metadata object for class sap.uxap.ModelMapping.
2203
+ *
2204
+ * @returns Metadata object describing this class
1966
2205
  */
1967
2206
  static getMetadata(): sap.ui.core.ElementMetadata;
1968
2207
  /**
1969
2208
  * Gets current value of property {@link #getExternalModelName externalModelName}.
1970
2209
  *
1971
2210
  * Determines the external model name.
2211
+ *
2212
+ * @returns Value of property `externalModelName`
1972
2213
  */
1973
2214
  getExternalModelName(): string;
1974
2215
  /**
1975
2216
  * Gets current value of property {@link #getExternalPath externalPath}.
1976
2217
  *
1977
2218
  * Determines the external path.
2219
+ *
2220
+ * @returns Value of property `externalPath`
1978
2221
  */
1979
2222
  getExternalPath(): string;
1980
2223
  /**
@@ -1983,6 +2226,8 @@ declare namespace sap {
1983
2226
  * Determines the internal model name.
1984
2227
  *
1985
2228
  * Default value is `"Model"`.
2229
+ *
2230
+ * @returns Value of property `internalModelName`
1986
2231
  */
1987
2232
  getInternalModelName(): string;
1988
2233
  /**
@@ -1991,6 +2236,8 @@ declare namespace sap {
1991
2236
  * Determines the external model name.
1992
2237
  *
1993
2238
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2239
+ *
2240
+ * @returns Reference to `this` in order to allow method chaining
1994
2241
  */
1995
2242
  setExternalModelName(
1996
2243
  /**
@@ -2004,6 +2251,8 @@ declare namespace sap {
2004
2251
  * Determines the external path.
2005
2252
  *
2006
2253
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2254
+ *
2255
+ * @returns Reference to `this` in order to allow method chaining
2007
2256
  */
2008
2257
  setExternalPath(
2009
2258
  /**
@@ -2019,6 +2268,8 @@ declare namespace sap {
2019
2268
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2020
2269
  *
2021
2270
  * Default value is `"Model"`.
2271
+ *
2272
+ * @returns Reference to `this` in order to allow method chaining
2022
2273
  */
2023
2274
  setInternalModelName(
2024
2275
  /**
@@ -2071,6 +2322,8 @@ declare namespace sap {
2071
2322
  * enriches it with the information contained in `oClassInfo`.
2072
2323
  *
2073
2324
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
2325
+ *
2326
+ * @returns Created class / constructor function
2074
2327
  */
2075
2328
  static extend<T extends Record<string, unknown>>(
2076
2329
  /**
@@ -2092,6 +2345,8 @@ declare namespace sap {
2092
2345
  ): Function;
2093
2346
  /**
2094
2347
  * Returns a metadata object for class sap.uxap.ObjectPageAccessibleLandmarkInfo.
2348
+ *
2349
+ * @returns Metadata object describing this class
2095
2350
  */
2096
2351
  static getMetadata(): sap.ui.core.ElementMetadata;
2097
2352
  /**
@@ -2102,6 +2357,8 @@ declare namespace sap {
2102
2357
  *
2103
2358
  * If not set (and a landmark different than `sap.ui.core.AccessibleLandmarkRole.None` is defined), no label
2104
2359
  * is set.
2360
+ *
2361
+ * @returns Value of property `contentLabel`
2105
2362
  */
2106
2363
  getContentLabel(): string;
2107
2364
  /**
@@ -2112,6 +2369,8 @@ declare namespace sap {
2112
2369
  * If set to `sap.ui.core.AccessibleLandmarkRole.None`, no landmark will be added to the container.
2113
2370
  *
2114
2371
  * Default value is `"None"`.
2372
+ *
2373
+ * @returns Value of property `contentRole`
2115
2374
  */
2116
2375
  getContentRole(): sap.ui.core.AccessibleLandmarkRole;
2117
2376
  /**
@@ -2122,6 +2381,8 @@ declare namespace sap {
2122
2381
  *
2123
2382
  * If not set (and a landmark different than `sap.ui.core.AccessibleLandmarkRole.None` is defined), no label
2124
2383
  * is set.
2384
+ *
2385
+ * @returns Value of property `footerLabel`
2125
2386
  */
2126
2387
  getFooterLabel(): string;
2127
2388
  /**
@@ -2132,6 +2393,8 @@ declare namespace sap {
2132
2393
  * If set to `sap.ui.core.AccessibleLandmarkRole.None`, no landmark will be added to the container.
2133
2394
  *
2134
2395
  * Default value is `"Region"`.
2396
+ *
2397
+ * @returns Value of property `footerRole`
2135
2398
  */
2136
2399
  getFooterRole(): sap.ui.core.AccessibleLandmarkRole;
2137
2400
  /**
@@ -2142,6 +2405,8 @@ declare namespace sap {
2142
2405
  *
2143
2406
  * If not set (and a landmark different than `sap.ui.core.AccessibleLandmarkRole.None` is defined), no label
2144
2407
  * is set.
2408
+ *
2409
+ * @returns Value of property `headerLabel`
2145
2410
  */
2146
2411
  getHeaderLabel(): string;
2147
2412
  /**
@@ -2152,6 +2417,8 @@ declare namespace sap {
2152
2417
  * If set to `sap.ui.core.AccessibleLandmarkRole.None`, no landmark will be added to the container.
2153
2418
  *
2154
2419
  * Default value is `"Banner"`.
2420
+ *
2421
+ * @returns Value of property `headerRole`
2155
2422
  */
2156
2423
  getHeaderRole(): sap.ui.core.AccessibleLandmarkRole;
2157
2424
  /**
@@ -2162,6 +2429,8 @@ declare namespace sap {
2162
2429
  *
2163
2430
  * If not set (and a landmark different than `sap.ui.core.AccessibleLandmarkRole.None` is defined), no label
2164
2431
  * is set.
2432
+ *
2433
+ * @returns Value of property `navigationLabel`
2165
2434
  */
2166
2435
  getNavigationLabel(): string;
2167
2436
  /**
@@ -2172,6 +2441,8 @@ declare namespace sap {
2172
2441
  * If set to `sap.ui.core.AccessibleLandmarkRole.None`, no landmark will be added to the container.
2173
2442
  *
2174
2443
  * Default value is `"Navigation"`.
2444
+ *
2445
+ * @returns Value of property `navigationRole`
2175
2446
  */
2176
2447
  getNavigationRole(): sap.ui.core.AccessibleLandmarkRole;
2177
2448
  /**
@@ -2182,6 +2453,8 @@ declare namespace sap {
2182
2453
  *
2183
2454
  * If not set (and a landmark different than `sap.ui.core.AccessibleLandmarkRole.None` is defined), no label
2184
2455
  * is set.
2456
+ *
2457
+ * @returns Value of property `rootLabel`
2185
2458
  */
2186
2459
  getRootLabel(): string;
2187
2460
  /**
@@ -2192,6 +2465,8 @@ declare namespace sap {
2192
2465
  * If set to `sap.ui.core.AccessibleLandmarkRole.None`, no landmark will be added to the container.
2193
2466
  *
2194
2467
  * Default value is `"Main"`.
2468
+ *
2469
+ * @returns Value of property `rootRole`
2195
2470
  */
2196
2471
  getRootRole(): sap.ui.core.AccessibleLandmarkRole;
2197
2472
  /**
@@ -2204,6 +2479,8 @@ declare namespace sap {
2204
2479
  * is set.
2205
2480
  *
2206
2481
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2482
+ *
2483
+ * @returns Reference to `this` in order to allow method chaining
2207
2484
  */
2208
2485
  setContentLabel(
2209
2486
  /**
@@ -2221,6 +2498,8 @@ declare namespace sap {
2221
2498
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2222
2499
  *
2223
2500
  * Default value is `"None"`.
2501
+ *
2502
+ * @returns Reference to `this` in order to allow method chaining
2224
2503
  */
2225
2504
  setContentRole(
2226
2505
  /**
@@ -2238,6 +2517,8 @@ declare namespace sap {
2238
2517
  * is set.
2239
2518
  *
2240
2519
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2520
+ *
2521
+ * @returns Reference to `this` in order to allow method chaining
2241
2522
  */
2242
2523
  setFooterLabel(
2243
2524
  /**
@@ -2255,6 +2536,8 @@ declare namespace sap {
2255
2536
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2256
2537
  *
2257
2538
  * Default value is `"Region"`.
2539
+ *
2540
+ * @returns Reference to `this` in order to allow method chaining
2258
2541
  */
2259
2542
  setFooterRole(
2260
2543
  /**
@@ -2272,6 +2555,8 @@ declare namespace sap {
2272
2555
  * is set.
2273
2556
  *
2274
2557
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2558
+ *
2559
+ * @returns Reference to `this` in order to allow method chaining
2275
2560
  */
2276
2561
  setHeaderLabel(
2277
2562
  /**
@@ -2289,6 +2574,8 @@ declare namespace sap {
2289
2574
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2290
2575
  *
2291
2576
  * Default value is `"Banner"`.
2577
+ *
2578
+ * @returns Reference to `this` in order to allow method chaining
2292
2579
  */
2293
2580
  setHeaderRole(
2294
2581
  /**
@@ -2306,6 +2593,8 @@ declare namespace sap {
2306
2593
  * is set.
2307
2594
  *
2308
2595
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2596
+ *
2597
+ * @returns Reference to `this` in order to allow method chaining
2309
2598
  */
2310
2599
  setNavigationLabel(
2311
2600
  /**
@@ -2323,6 +2612,8 @@ declare namespace sap {
2323
2612
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2324
2613
  *
2325
2614
  * Default value is `"Navigation"`.
2615
+ *
2616
+ * @returns Reference to `this` in order to allow method chaining
2326
2617
  */
2327
2618
  setNavigationRole(
2328
2619
  /**
@@ -2340,6 +2631,8 @@ declare namespace sap {
2340
2631
  * is set.
2341
2632
  *
2342
2633
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2634
+ *
2635
+ * @returns Reference to `this` in order to allow method chaining
2343
2636
  */
2344
2637
  setRootLabel(
2345
2638
  /**
@@ -2357,6 +2650,8 @@ declare namespace sap {
2357
2650
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2358
2651
  *
2359
2652
  * Default value is `"Main"`.
2653
+ *
2654
+ * @returns Reference to `this` in order to allow method chaining
2360
2655
  */
2361
2656
  setRootRole(
2362
2657
  /**
@@ -2427,6 +2722,8 @@ declare namespace sap {
2427
2722
  * it with the information contained in `oClassInfo`.
2428
2723
  *
2429
2724
  * `oClassInfo` might contain the same kind of information as described in {@link sap.f.DynamicPageHeader.extend}.
2725
+ *
2726
+ * @returns Created class / constructor function
2430
2727
  */
2431
2728
  static extend<T extends Record<string, unknown>>(
2432
2729
  /**
@@ -2445,6 +2742,8 @@ declare namespace sap {
2445
2742
  ): Function;
2446
2743
  /**
2447
2744
  * Returns a metadata object for class sap.uxap.ObjectPageDynamicHeaderContent.
2745
+ *
2746
+ * @returns Metadata object describing this class
2448
2747
  */
2449
2748
  static getMetadata(): sap.ui.core.ElementMetadata;
2450
2749
  }
@@ -2515,6 +2814,8 @@ declare namespace sap {
2515
2814
  * it with the information contained in `oClassInfo`.
2516
2815
  *
2517
2816
  * `oClassInfo` might contain the same kind of information as described in {@link sap.f.DynamicPageTitle.extend}.
2817
+ *
2818
+ * @returns Created class / constructor function
2518
2819
  */
2519
2820
  static extend<T extends Record<string, unknown>>(
2520
2821
  /**
@@ -2533,6 +2834,8 @@ declare namespace sap {
2533
2834
  ): Function;
2534
2835
  /**
2535
2836
  * Returns a metadata object for class sap.uxap.ObjectPageDynamicHeaderTitle.
2837
+ *
2838
+ * @returns Metadata object describing this class
2536
2839
  */
2537
2840
  static getMetadata(): sap.ui.core.ElementMetadata;
2538
2841
  }
@@ -2601,6 +2904,8 @@ declare namespace sap {
2601
2904
  * the information contained in `oClassInfo`.
2602
2905
  *
2603
2906
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
2907
+ *
2908
+ * @returns Created class / constructor function
2604
2909
  */
2605
2910
  static extend<T extends Record<string, unknown>>(
2606
2911
  /**
@@ -2619,10 +2924,14 @@ declare namespace sap {
2619
2924
  ): Function;
2620
2925
  /**
2621
2926
  * Returns a metadata object for class sap.uxap.ObjectPageHeader.
2927
+ *
2928
+ * @returns Metadata object describing this class
2622
2929
  */
2623
2930
  static getMetadata(): sap.ui.core.ElementMetadata;
2624
2931
  /**
2625
2932
  * Adds some action to the aggregation {@link #getActions actions}.
2933
+ *
2934
+ * @returns Reference to `this` in order to allow method chaining
2626
2935
  */
2627
2936
  addAction(
2628
2937
  /**
@@ -2634,6 +2943,8 @@ declare namespace sap {
2634
2943
  * @deprecated (since 1.50) - use the `breadcrumbs` aggregation instead.
2635
2944
  *
2636
2945
  * Adds some breadCrumbLink to the aggregation {@link #getBreadCrumbsLinks breadCrumbsLinks}.
2946
+ *
2947
+ * @returns Reference to `this` in order to allow method chaining
2637
2948
  */
2638
2949
  addBreadCrumbLink(
2639
2950
  /**
@@ -2649,6 +2960,8 @@ declare namespace sap {
2649
2960
  * otherwise it will be bound to this `sap.uxap.ObjectPageHeader` itself.
2650
2961
  *
2651
2962
  * The event is fired when the unsaved changes button is pressed
2963
+ *
2964
+ * @returns Reference to `this` in order to allow method chaining
2652
2965
  */
2653
2966
  attachMarkChangesPress(
2654
2967
  /**
@@ -2673,6 +2986,8 @@ declare namespace sap {
2673
2986
  * otherwise it will be bound to this `sap.uxap.ObjectPageHeader` itself.
2674
2987
  *
2675
2988
  * The event is fired when the unsaved changes button is pressed
2989
+ *
2990
+ * @returns Reference to `this` in order to allow method chaining
2676
2991
  */
2677
2992
  attachMarkChangesPress(
2678
2993
  /**
@@ -2692,6 +3007,8 @@ declare namespace sap {
2692
3007
  * otherwise it will be bound to this `sap.uxap.ObjectPageHeader` itself.
2693
3008
  *
2694
3009
  * The event is fired when the Locked button is pressed
3010
+ *
3011
+ * @returns Reference to `this` in order to allow method chaining
2695
3012
  */
2696
3013
  attachMarkLockedPress(
2697
3014
  /**
@@ -2716,6 +3033,8 @@ declare namespace sap {
2716
3033
  * otherwise it will be bound to this `sap.uxap.ObjectPageHeader` itself.
2717
3034
  *
2718
3035
  * The event is fired when the Locked button is pressed
3036
+ *
3037
+ * @returns Reference to `this` in order to allow method chaining
2719
3038
  */
2720
3039
  attachMarkLockedPress(
2721
3040
  /**
@@ -2735,6 +3054,8 @@ declare namespace sap {
2735
3054
  * otherwise it will be bound to this `sap.uxap.ObjectPageHeader` itself.
2736
3055
  *
2737
3056
  * The event is fired when the objectPage header title selector (down-arrow) is pressed
3057
+ *
3058
+ * @returns Reference to `this` in order to allow method chaining
2738
3059
  */
2739
3060
  attachTitleSelectorPress(
2740
3061
  /**
@@ -2759,6 +3080,8 @@ declare namespace sap {
2759
3080
  * otherwise it will be bound to this `sap.uxap.ObjectPageHeader` itself.
2760
3081
  *
2761
3082
  * The event is fired when the objectPage header title selector (down-arrow) is pressed
3083
+ *
3084
+ * @returns Reference to `this` in order to allow method chaining
2762
3085
  */
2763
3086
  attachTitleSelectorPress(
2764
3087
  /**
@@ -2772,34 +3095,46 @@ declare namespace sap {
2772
3095
  ): this;
2773
3096
  /**
2774
3097
  * Destroys all the actions in the aggregation {@link #getActions actions}.
3098
+ *
3099
+ * @returns Reference to `this` in order to allow method chaining
2775
3100
  */
2776
3101
  destroyActions(): this;
2777
3102
  /**
2778
3103
  * @SINCE 1.50
2779
3104
  *
2780
3105
  * Destroys the breadcrumbs in the aggregation {@link #getBreadcrumbs breadcrumbs}.
3106
+ *
3107
+ * @returns Reference to `this` in order to allow method chaining
2781
3108
  */
2782
3109
  destroyBreadcrumbs(): this;
2783
3110
  /**
2784
3111
  * @deprecated (since 1.50) - use the `breadcrumbs` aggregation instead.
2785
3112
  *
2786
3113
  * Destroys all the breadCrumbsLinks in the aggregation {@link #getBreadCrumbsLinks breadCrumbsLinks}.
3114
+ *
3115
+ * @returns Reference to `this` in order to allow method chaining
2787
3116
  */
2788
3117
  destroyBreadCrumbsLinks(): this;
2789
3118
  /**
2790
3119
  * Destroys the navigationBar in the aggregation {@link #getNavigationBar navigationBar}.
3120
+ *
3121
+ * @returns Reference to `this` in order to allow method chaining
2791
3122
  */
2792
3123
  destroyNavigationBar(): this;
2793
3124
  /**
2794
3125
  * @SINCE 1.38.0
2795
3126
  *
2796
3127
  * Destroys the sideContentButton in the aggregation {@link #getSideContentButton sideContentButton}.
3128
+ *
3129
+ * @returns Reference to `this` in order to allow method chaining
2797
3130
  */
2798
3131
  destroySideContentButton(): this;
2799
3132
  /**
2800
3133
  * @SINCE 1.56
2801
3134
  *
2802
3135
  * Destroys the titleSelectorTooltip in the aggregation {@link #getTitleSelectorTooltip titleSelectorTooltip}.
3136
+ *
3137
+ * @returns Reference to `this` in order to allow method chaining
2803
3138
  */
2804
3139
  destroyTitleSelectorTooltip(): this;
2805
3140
  /**
@@ -2807,6 +3142,8 @@ declare namespace sap {
2807
3142
  * this `sap.uxap.ObjectPageHeader`.
2808
3143
  *
2809
3144
  * The passed function and listener object must match the ones used for event registration.
3145
+ *
3146
+ * @returns Reference to `this` in order to allow method chaining
2810
3147
  */
2811
3148
  detachMarkChangesPress(
2812
3149
  /**
@@ -2823,6 +3160,8 @@ declare namespace sap {
2823
3160
  * this `sap.uxap.ObjectPageHeader`.
2824
3161
  *
2825
3162
  * The passed function and listener object must match the ones used for event registration.
3163
+ *
3164
+ * @returns Reference to `this` in order to allow method chaining
2826
3165
  */
2827
3166
  detachMarkLockedPress(
2828
3167
  /**
@@ -2839,6 +3178,8 @@ declare namespace sap {
2839
3178
  * of this `sap.uxap.ObjectPageHeader`.
2840
3179
  *
2841
3180
  * The passed function and listener object must match the ones used for event registration.
3181
+ *
3182
+ * @returns Reference to `this` in order to allow method chaining
2842
3183
  */
2843
3184
  detachTitleSelectorPress(
2844
3185
  /**
@@ -2852,6 +3193,8 @@ declare namespace sap {
2852
3193
  ): this;
2853
3194
  /**
2854
3195
  * Fires event {@link #event:markChangesPress markChangesPress} to attached listeners.
3196
+ *
3197
+ * @returns Reference to `this` in order to allow method chaining
2855
3198
  */
2856
3199
  fireMarkChangesPress(
2857
3200
  /**
@@ -2866,6 +3209,8 @@ declare namespace sap {
2866
3209
  ): this;
2867
3210
  /**
2868
3211
  * Fires event {@link #event:markLockedPress markLockedPress} to attached listeners.
3212
+ *
3213
+ * @returns Reference to `this` in order to allow method chaining
2869
3214
  */
2870
3215
  fireMarkLockedPress(
2871
3216
  /**
@@ -2880,6 +3225,8 @@ declare namespace sap {
2880
3225
  ): this;
2881
3226
  /**
2882
3227
  * Fires event {@link #event:titleSelectorPress titleSelectorPress} to attached listeners.
3228
+ *
3229
+ * @returns Reference to `this` in order to allow method chaining
2883
3230
  */
2884
3231
  fireTitleSelectorPress(
2885
3232
  /**
@@ -2930,6 +3277,8 @@ declare namespace sap {
2930
3277
  * to work in the Blue Crystal theme, but it will not be taken into account for the Belize themes.
2931
3278
  *
2932
3279
  * Default value is `Light`.
3280
+ *
3281
+ * @returns Value of property `headerDesign`
2933
3282
  */
2934
3283
  getHeaderDesign(): sap.uxap.ObjectPageHeaderDesign;
2935
3284
  /**
@@ -2938,6 +3287,8 @@ declare namespace sap {
2938
3287
  * Determines whether the action buttons should always be visible or visible only when the header is snapped.
2939
3288
  *
2940
3289
  * Default value is `true`.
3290
+ *
3291
+ * @returns Value of property `isActionAreaAlwaysVisible`
2941
3292
  */
2942
3293
  getIsActionAreaAlwaysVisible(): boolean;
2943
3294
  /**
@@ -2946,6 +3297,8 @@ declare namespace sap {
2946
3297
  * Determines whether the icon should always be visible or visible only when the header is snapped.
2947
3298
  *
2948
3299
  * Default value is `false`.
3300
+ *
3301
+ * @returns Value of property `isObjectIconAlwaysVisible`
2949
3302
  */
2950
3303
  getIsObjectIconAlwaysVisible(): boolean;
2951
3304
  /**
@@ -2954,6 +3307,8 @@ declare namespace sap {
2954
3307
  * Determines whether the subtitle should always be visible or visible only when the header is snapped.
2955
3308
  *
2956
3309
  * Default value is `true`.
3310
+ *
3311
+ * @returns Value of property `isObjectSubtitleAlwaysVisible`
2957
3312
  */
2958
3313
  getIsObjectSubtitleAlwaysVisible(): boolean;
2959
3314
  /**
@@ -2962,6 +3317,8 @@ declare namespace sap {
2962
3317
  * Determines whether the title should always be visible or visible only when the header is snapped.
2963
3318
  *
2964
3319
  * Default value is `true`.
3320
+ *
3321
+ * @returns Value of property `isObjectTitleAlwaysVisible`
2965
3322
  */
2966
3323
  getIsObjectTitleAlwaysVisible(): boolean;
2967
3324
  /**
@@ -2973,6 +3330,8 @@ declare namespace sap {
2973
3330
  * with the markLocked state. If both are set to true, only the locked state will be displayed.
2974
3331
  *
2975
3332
  * Default value is `false`.
3333
+ *
3334
+ * @returns Value of property `markChanges`
2976
3335
  */
2977
3336
  getMarkChanges(): boolean;
2978
3337
  /**
@@ -2982,6 +3341,8 @@ declare namespace sap {
2982
3341
  * effect.
2983
3342
  *
2984
3343
  * Default value is `false`.
3344
+ *
3345
+ * @returns Value of property `markFavorite`
2985
3346
  */
2986
3347
  getMarkFavorite(): boolean;
2987
3348
  /**
@@ -2991,6 +3352,8 @@ declare namespace sap {
2991
3352
  * effect.
2992
3353
  *
2993
3354
  * Default value is `false`.
3355
+ *
3356
+ * @returns Value of property `markFlagged`
2994
3357
  */
2995
3358
  getMarkFlagged(): boolean;
2996
3359
  /**
@@ -2999,6 +3362,8 @@ declare namespace sap {
2999
3362
  * Set the locked state of the objectPageHeader.
3000
3363
  *
3001
3364
  * Default value is `false`.
3365
+ *
3366
+ * @returns Value of property `markLocked`
3002
3367
  */
3003
3368
  getMarkLocked(): boolean;
3004
3369
  /**
@@ -3013,6 +3378,8 @@ declare namespace sap {
3013
3378
  * The text to be used for the Alt and Tooltip attribute of the image, supplied via the objectImageURI property
3014
3379
  *
3015
3380
  * Default value is `empty string`.
3381
+ *
3382
+ * @returns Value of property `objectImageAlt`
3016
3383
  */
3017
3384
  getObjectImageAlt(): string;
3018
3385
  /**
@@ -3023,6 +3390,8 @@ declare namespace sap {
3023
3390
  * Determines the background color of the image placeholder or icon if valid icon URI is provided.
3024
3391
  *
3025
3392
  * Default value is `Accent6`.
3393
+ *
3394
+ * @returns Value of property `objectImageBackgroundColor`
3026
3395
  */
3027
3396
  getObjectImageBackgroundColor(): sap.m.AvatarColor;
3028
3397
  /**
@@ -3032,6 +3401,8 @@ declare namespace sap {
3032
3401
  * more details on densityAware.
3033
3402
  *
3034
3403
  * Default value is `false`.
3404
+ *
3405
+ * @returns Value of property `objectImageDensityAware`
3035
3406
  */
3036
3407
  getObjectImageDensityAware(): boolean;
3037
3408
  /**
@@ -3040,24 +3411,32 @@ declare namespace sap {
3040
3411
  * Determines whether the picture should be displayed in a square or with a circle-shaped mask.
3041
3412
  *
3042
3413
  * Default value is `Square`.
3414
+ *
3415
+ * @returns Value of property `objectImageShape`
3043
3416
  */
3044
3417
  getObjectImageShape(): sap.m.AvatarShape;
3045
3418
  /**
3046
3419
  * Gets current value of property {@link #getObjectImageURI objectImageURI}.
3047
3420
  *
3048
3421
  * The URL of the image, representing the business object
3422
+ *
3423
+ * @returns Value of property `objectImageURI`
3049
3424
  */
3050
3425
  getObjectImageURI(): string;
3051
3426
  /**
3052
3427
  * Gets current value of property {@link #getObjectSubtitle objectSubtitle}.
3053
3428
  *
3054
3429
  * The description of the object
3430
+ *
3431
+ * @returns Value of property `objectSubtitle`
3055
3432
  */
3056
3433
  getObjectSubtitle(): string;
3057
3434
  /**
3058
3435
  * Gets current value of property {@link #getObjectTitle objectTitle}.
3059
3436
  *
3060
3437
  * The title of the object
3438
+ *
3439
+ * @returns Value of property `objectTitle`
3061
3440
  */
3062
3441
  getObjectTitle(): string;
3063
3442
  /**
@@ -3066,6 +3445,8 @@ declare namespace sap {
3066
3445
  * Indicates if object page header title supports showing markers such as flagged and favorite.
3067
3446
  *
3068
3447
  * Default value is `false`.
3448
+ *
3449
+ * @returns Value of property `showMarkers`
3069
3450
  */
3070
3451
  getShowMarkers(): boolean;
3071
3452
  /**
@@ -3075,6 +3456,8 @@ declare namespace sap {
3075
3456
  * is invalid.
3076
3457
  *
3077
3458
  * Default value is `false`.
3459
+ *
3460
+ * @returns Value of property `showPlaceholder`
3078
3461
  */
3079
3462
  getShowPlaceholder(): boolean;
3080
3463
  /**
@@ -3083,6 +3466,8 @@ declare namespace sap {
3083
3466
  * When set to true, the selector arrow icon/image is shown and can be pressed.
3084
3467
  *
3085
3468
  * Default value is `false`.
3469
+ *
3470
+ * @returns Value of property `showTitleSelector`
3086
3471
  */
3087
3472
  getShowTitleSelector(): boolean;
3088
3473
  /**
@@ -3109,6 +3494,8 @@ declare namespace sap {
3109
3494
  /**
3110
3495
  * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getActions actions}. and returns
3111
3496
  * its index if found or -1 otherwise.
3497
+ *
3498
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
3112
3499
  */
3113
3500
  indexOfAction(
3114
3501
  /**
@@ -3121,6 +3508,8 @@ declare namespace sap {
3121
3508
  *
3122
3509
  * Checks for the provided `sap.m.Link` in the aggregation {@link #getBreadCrumbsLinks breadCrumbsLinks}.
3123
3510
  * and returns its index if found or -1 otherwise.
3511
+ *
3512
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
3124
3513
  */
3125
3514
  indexOfBreadCrumbLink(
3126
3515
  /**
@@ -3130,6 +3519,8 @@ declare namespace sap {
3130
3519
  ): int;
3131
3520
  /**
3132
3521
  * Inserts a action into the aggregation {@link #getActions actions}.
3522
+ *
3523
+ * @returns Reference to `this` in order to allow method chaining
3133
3524
  */
3134
3525
  insertAction(
3135
3526
  /**
@@ -3147,6 +3538,8 @@ declare namespace sap {
3147
3538
  * @deprecated (since 1.50) - use the `breadcrumbs` aggregation instead.
3148
3539
  *
3149
3540
  * Inserts a breadCrumbLink into the aggregation {@link #getBreadCrumbsLinks breadCrumbsLinks}.
3541
+ *
3542
+ * @returns Reference to `this` in order to allow method chaining
3150
3543
  */
3151
3544
  insertBreadCrumbLink(
3152
3545
  /**
@@ -3162,6 +3555,8 @@ declare namespace sap {
3162
3555
  ): this;
3163
3556
  /**
3164
3557
  * Removes a action from the aggregation {@link #getActions actions}.
3558
+ *
3559
+ * @returns The removed action or `null`
3165
3560
  */
3166
3561
  removeAction(
3167
3562
  /**
@@ -3173,6 +3568,8 @@ declare namespace sap {
3173
3568
  * Removes all the controls from the aggregation {@link #getActions actions}.
3174
3569
  *
3175
3570
  * Additionally, it unregisters them from the hosting UIArea.
3571
+ *
3572
+ * @returns An array of the removed elements (might be empty)
3176
3573
  */
3177
3574
  removeAllActions(): sap.ui.core.Control[];
3178
3575
  /**
@@ -3181,12 +3578,16 @@ declare namespace sap {
3181
3578
  * Removes all the controls from the aggregation {@link #getBreadCrumbsLinks breadCrumbsLinks}.
3182
3579
  *
3183
3580
  * Additionally, it unregisters them from the hosting UIArea.
3581
+ *
3582
+ * @returns An array of the removed elements (might be empty)
3184
3583
  */
3185
3584
  removeAllBreadCrumbsLinks(): sap.m.Link[];
3186
3585
  /**
3187
3586
  * @deprecated (since 1.50) - use the `breadcrumbs` aggregation instead.
3188
3587
  *
3189
3588
  * Removes a breadCrumbLink from the aggregation {@link #getBreadCrumbsLinks breadCrumbsLinks}.
3589
+ *
3590
+ * @returns The removed breadCrumbLink or `null`
3190
3591
  */
3191
3592
  removeBreadCrumbLink(
3192
3593
  /**
@@ -3198,6 +3599,8 @@ declare namespace sap {
3198
3599
  * @SINCE 1.50
3199
3600
  *
3200
3601
  * Sets the aggregated {@link #getBreadcrumbs breadcrumbs}.
3602
+ *
3603
+ * @returns Reference to `this` in order to allow method chaining
3201
3604
  */
3202
3605
  setBreadcrumbs(
3203
3606
  /**
@@ -3216,6 +3619,8 @@ declare namespace sap {
3216
3619
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3217
3620
  *
3218
3621
  * Default value is `Light`.
3622
+ *
3623
+ * @returns Reference to `this` in order to allow method chaining
3219
3624
  */
3220
3625
  setHeaderDesign(
3221
3626
  /**
@@ -3231,6 +3636,8 @@ declare namespace sap {
3231
3636
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3232
3637
  *
3233
3638
  * Default value is `true`.
3639
+ *
3640
+ * @returns Reference to `this` in order to allow method chaining
3234
3641
  */
3235
3642
  setIsActionAreaAlwaysVisible(
3236
3643
  /**
@@ -3246,6 +3653,8 @@ declare namespace sap {
3246
3653
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3247
3654
  *
3248
3655
  * Default value is `false`.
3656
+ *
3657
+ * @returns Reference to `this` in order to allow method chaining
3249
3658
  */
3250
3659
  setIsObjectIconAlwaysVisible(
3251
3660
  /**
@@ -3261,6 +3670,8 @@ declare namespace sap {
3261
3670
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3262
3671
  *
3263
3672
  * Default value is `true`.
3673
+ *
3674
+ * @returns Reference to `this` in order to allow method chaining
3264
3675
  */
3265
3676
  setIsObjectSubtitleAlwaysVisible(
3266
3677
  /**
@@ -3276,6 +3687,8 @@ declare namespace sap {
3276
3687
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3277
3688
  *
3278
3689
  * Default value is `true`.
3690
+ *
3691
+ * @returns Reference to `this` in order to allow method chaining
3279
3692
  */
3280
3693
  setIsObjectTitleAlwaysVisible(
3281
3694
  /**
@@ -3294,6 +3707,8 @@ declare namespace sap {
3294
3707
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3295
3708
  *
3296
3709
  * Default value is `false`.
3710
+ *
3711
+ * @returns Reference to `this` in order to allow method chaining
3297
3712
  */
3298
3713
  setMarkChanges(
3299
3714
  /**
@@ -3310,6 +3725,8 @@ declare namespace sap {
3310
3725
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3311
3726
  *
3312
3727
  * Default value is `false`.
3728
+ *
3729
+ * @returns Reference to `this` in order to allow method chaining
3313
3730
  */
3314
3731
  setMarkFavorite(
3315
3732
  /**
@@ -3326,6 +3743,8 @@ declare namespace sap {
3326
3743
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3327
3744
  *
3328
3745
  * Default value is `false`.
3746
+ *
3747
+ * @returns Reference to `this` in order to allow method chaining
3329
3748
  */
3330
3749
  setMarkFlagged(
3331
3750
  /**
@@ -3341,6 +3760,8 @@ declare namespace sap {
3341
3760
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3342
3761
  *
3343
3762
  * Default value is `false`.
3763
+ *
3764
+ * @returns Reference to `this` in order to allow method chaining
3344
3765
  */
3345
3766
  setMarkLocked(
3346
3767
  /**
@@ -3350,6 +3771,8 @@ declare namespace sap {
3350
3771
  ): this;
3351
3772
  /**
3352
3773
  * Sets the aggregated {@link #getNavigationBar navigationBar}.
3774
+ *
3775
+ * @returns Reference to `this` in order to allow method chaining
3353
3776
  */
3354
3777
  setNavigationBar(
3355
3778
  /**
@@ -3365,6 +3788,8 @@ declare namespace sap {
3365
3788
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3366
3789
  *
3367
3790
  * Default value is `empty string`.
3791
+ *
3792
+ * @returns Reference to `this` in order to allow method chaining
3368
3793
  */
3369
3794
  setObjectImageAlt(
3370
3795
  /**
@@ -3382,6 +3807,8 @@ declare namespace sap {
3382
3807
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3383
3808
  *
3384
3809
  * Default value is `Accent6`.
3810
+ *
3811
+ * @returns Reference to `this` in order to allow method chaining
3385
3812
  */
3386
3813
  setObjectImageBackgroundColor(
3387
3814
  /**
@@ -3398,6 +3825,8 @@ declare namespace sap {
3398
3825
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3399
3826
  *
3400
3827
  * Default value is `false`.
3828
+ *
3829
+ * @returns Reference to `this` in order to allow method chaining
3401
3830
  */
3402
3831
  setObjectImageDensityAware(
3403
3832
  /**
@@ -3413,6 +3842,8 @@ declare namespace sap {
3413
3842
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3414
3843
  *
3415
3844
  * Default value is `Square`.
3845
+ *
3846
+ * @returns Reference to `this` in order to allow method chaining
3416
3847
  */
3417
3848
  setObjectImageShape(
3418
3849
  /**
@@ -3426,6 +3857,8 @@ declare namespace sap {
3426
3857
  * The URL of the image, representing the business object
3427
3858
  *
3428
3859
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3860
+ *
3861
+ * @returns Reference to `this` in order to allow method chaining
3429
3862
  */
3430
3863
  setObjectImageURI(
3431
3864
  /**
@@ -3439,6 +3872,8 @@ declare namespace sap {
3439
3872
  * The description of the object
3440
3873
  *
3441
3874
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3875
+ *
3876
+ * @returns Reference to `this` in order to allow method chaining
3442
3877
  */
3443
3878
  setObjectSubtitle(
3444
3879
  /**
@@ -3452,6 +3887,8 @@ declare namespace sap {
3452
3887
  * The title of the object
3453
3888
  *
3454
3889
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3890
+ *
3891
+ * @returns Reference to `this` in order to allow method chaining
3455
3892
  */
3456
3893
  setObjectTitle(
3457
3894
  /**
@@ -3467,6 +3904,8 @@ declare namespace sap {
3467
3904
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3468
3905
  *
3469
3906
  * Default value is `false`.
3907
+ *
3908
+ * @returns Reference to `this` in order to allow method chaining
3470
3909
  */
3471
3910
  setShowMarkers(
3472
3911
  /**
@@ -3483,6 +3922,8 @@ declare namespace sap {
3483
3922
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3484
3923
  *
3485
3924
  * Default value is `false`.
3925
+ *
3926
+ * @returns Reference to `this` in order to allow method chaining
3486
3927
  */
3487
3928
  setShowPlaceholder(
3488
3929
  /**
@@ -3498,6 +3939,8 @@ declare namespace sap {
3498
3939
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3499
3940
  *
3500
3941
  * Default value is `false`.
3942
+ *
3943
+ * @returns Reference to `this` in order to allow method chaining
3501
3944
  */
3502
3945
  setShowTitleSelector(
3503
3946
  /**
@@ -3509,6 +3952,8 @@ declare namespace sap {
3509
3952
  * @SINCE 1.38.0
3510
3953
  *
3511
3954
  * Sets the aggregated {@link #getSideContentButton sideContentButton}.
3955
+ *
3956
+ * @returns Reference to `this` in order to allow method chaining
3512
3957
  */
3513
3958
  setSideContentButton(
3514
3959
  /**
@@ -3520,6 +3965,8 @@ declare namespace sap {
3520
3965
  * @SINCE 1.56
3521
3966
  *
3522
3967
  * Sets the aggregated {@link #getTitleSelectorTooltip titleSelectorTooltip}.
3968
+ *
3969
+ * @returns Reference to `this` in order to allow method chaining
3523
3970
  */
3524
3971
  setTitleSelectorTooltip(
3525
3972
  /**
@@ -3576,6 +4023,8 @@ declare namespace sap {
3576
4023
  * it with the information contained in `oClassInfo`.
3577
4024
  *
3578
4025
  * `oClassInfo` might contain the same kind of information as described in {@link sap.m.Button.extend}.
4026
+ *
4027
+ * @returns Created class / constructor function
3579
4028
  */
3580
4029
  static extend<T extends Record<string, unknown>>(
3581
4030
  /**
@@ -3594,6 +4043,8 @@ declare namespace sap {
3594
4043
  ): Function;
3595
4044
  /**
3596
4045
  * Returns a metadata object for class sap.uxap.ObjectPageHeaderActionButton.
4046
+ *
4047
+ * @returns Metadata object describing this class
3597
4048
  */
3598
4049
  static getMetadata(): sap.ui.core.ElementMetadata;
3599
4050
  /**
@@ -3604,6 +4055,8 @@ declare namespace sap {
3604
4055
  * actionSheet that appears when not enough space is available on the screen for displaying all actions.
3605
4056
  *
3606
4057
  * Default value is `false`.
4058
+ *
4059
+ * @returns Value of property `hideIcon`
3607
4060
  */
3608
4061
  getHideIcon(): boolean;
3609
4062
  /**
@@ -3614,6 +4067,8 @@ declare namespace sap {
3614
4067
  * actionSheet that appears when not enough space is available on the screen for displaying all actions.
3615
4068
  *
3616
4069
  * Default value is `true`.
4070
+ *
4071
+ * @returns Value of property `hideText`
3617
4072
  */
3618
4073
  getHideText(): boolean;
3619
4074
  /**
@@ -3624,6 +4079,8 @@ declare namespace sap {
3624
4079
  * Determines the order in which the button overflows.
3625
4080
  *
3626
4081
  * Default value is `High`.
4082
+ *
4083
+ * @returns Value of property `importance`
3627
4084
  */
3628
4085
  getImportance(): sap.uxap.Importance;
3629
4086
  /**
@@ -3636,6 +4093,8 @@ declare namespace sap {
3636
4093
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3637
4094
  *
3638
4095
  * Default value is `false`.
4096
+ *
4097
+ * @returns Reference to `this` in order to allow method chaining
3639
4098
  */
3640
4099
  setHideIcon(
3641
4100
  /**
@@ -3653,6 +4112,8 @@ declare namespace sap {
3653
4112
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3654
4113
  *
3655
4114
  * Default value is `true`.
4115
+ *
4116
+ * @returns Reference to `this` in order to allow method chaining
3656
4117
  */
3657
4118
  setHideText(
3658
4119
  /**
@@ -3670,6 +4131,8 @@ declare namespace sap {
3670
4131
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3671
4132
  *
3672
4133
  * Default value is `High`.
4134
+ *
4135
+ * @returns Reference to `this` in order to allow method chaining
3673
4136
  */
3674
4137
  setImportance(
3675
4138
  /**
@@ -3741,6 +4204,8 @@ declare namespace sap {
3741
4204
  * it with the information contained in `oClassInfo`.
3742
4205
  *
3743
4206
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
4207
+ *
4208
+ * @returns Created class / constructor function
3744
4209
  */
3745
4210
  static extend<T extends Record<string, unknown>>(
3746
4211
  /**
@@ -3759,10 +4224,14 @@ declare namespace sap {
3759
4224
  ): Function;
3760
4225
  /**
3761
4226
  * Returns a metadata object for class sap.uxap.ObjectPageHeaderContent.
4227
+ *
4228
+ * @returns Metadata object describing this class
3762
4229
  */
3763
4230
  static getMetadata(): sap.ui.core.ElementMetadata;
3764
4231
  /**
3765
4232
  * Adds some content to the aggregation {@link #getContent content}.
4233
+ *
4234
+ * @returns Reference to `this` in order to allow method chaining
3766
4235
  */
3767
4236
  addContent(
3768
4237
  /**
@@ -3772,6 +4241,8 @@ declare namespace sap {
3772
4241
  ): this;
3773
4242
  /**
3774
4243
  * Destroys all the content in the aggregation {@link #getContent content}.
4244
+ *
4245
+ * @returns Reference to `this` in order to allow method chaining
3775
4246
  */
3776
4247
  destroyContent(): this;
3777
4248
  /**
@@ -3789,11 +4260,15 @@ declare namespace sap {
3789
4260
  * to work in the Blue Crystal theme, but it will not be taken into account for the Belize themes.
3790
4261
  *
3791
4262
  * Default value is `Light`.
4263
+ *
4264
+ * @returns Value of property `contentDesign`
3792
4265
  */
3793
4266
  getContentDesign(): sap.uxap.ObjectPageHeaderDesign;
3794
4267
  /**
3795
4268
  * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getContent content}. and returns
3796
4269
  * its index if found or -1 otherwise.
4270
+ *
4271
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
3797
4272
  */
3798
4273
  indexOfContent(
3799
4274
  /**
@@ -3803,6 +4278,8 @@ declare namespace sap {
3803
4278
  ): int;
3804
4279
  /**
3805
4280
  * Inserts a content into the aggregation {@link #getContent content}.
4281
+ *
4282
+ * @returns Reference to `this` in order to allow method chaining
3806
4283
  */
3807
4284
  insertContent(
3808
4285
  /**
@@ -3820,10 +4297,14 @@ declare namespace sap {
3820
4297
  * Removes all the controls from the aggregation {@link #getContent content}.
3821
4298
  *
3822
4299
  * Additionally, it unregisters them from the hosting UIArea.
4300
+ *
4301
+ * @returns An array of the removed elements (might be empty)
3823
4302
  */
3824
4303
  removeAllContent(): sap.ui.core.Control[];
3825
4304
  /**
3826
4305
  * Removes a content from the aggregation {@link #getContent content}.
4306
+ *
4307
+ * @returns The removed content or `null`
3827
4308
  */
3828
4309
  removeContent(
3829
4310
  /**
@@ -3842,6 +4323,8 @@ declare namespace sap {
3842
4323
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3843
4324
  *
3844
4325
  * Default value is `Light`.
4326
+ *
4327
+ * @returns Reference to `this` in order to allow method chaining
3845
4328
  */
3846
4329
  setContentDesign(
3847
4330
  /**
@@ -3896,6 +4379,8 @@ declare namespace sap {
3896
4379
  * it with the information contained in `oClassInfo`.
3897
4380
  *
3898
4381
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.LayoutData.extend}.
4382
+ *
4383
+ * @returns Created class / constructor function
3899
4384
  */
3900
4385
  static extend<T extends Record<string, unknown>>(
3901
4386
  /**
@@ -3914,6 +4399,8 @@ declare namespace sap {
3914
4399
  ): Function;
3915
4400
  /**
3916
4401
  * Returns a metadata object for class sap.uxap.ObjectPageHeaderLayoutData.
4402
+ *
4403
+ * @returns Metadata object describing this class
3917
4404
  */
3918
4405
  static getMetadata(): sap.ui.core.ElementMetadata;
3919
4406
  /**
@@ -3922,6 +4409,8 @@ declare namespace sap {
3922
4409
  * If this property is set the control will display a separator after it.
3923
4410
  *
3924
4411
  * Default value is `false`.
4412
+ *
4413
+ * @returns Value of property `showSeparatorAfter`
3925
4414
  */
3926
4415
  getShowSeparatorAfter(): boolean;
3927
4416
  /**
@@ -3930,6 +4419,8 @@ declare namespace sap {
3930
4419
  * If this property is set the control will display a separator before it.
3931
4420
  *
3932
4421
  * Default value is `false`.
4422
+ *
4423
+ * @returns Value of property `showSeparatorBefore`
3933
4424
  */
3934
4425
  getShowSeparatorBefore(): boolean;
3935
4426
  /**
@@ -3938,6 +4429,8 @@ declare namespace sap {
3938
4429
  * If this property is set the control will be visible (or not) in a large sized layout.
3939
4430
  *
3940
4431
  * Default value is `true`.
4432
+ *
4433
+ * @returns Value of property `visibleL`
3941
4434
  */
3942
4435
  getVisibleL(): boolean;
3943
4436
  /**
@@ -3946,6 +4439,8 @@ declare namespace sap {
3946
4439
  * If this property is set the control will be visible (or not) in a medium sized layout.
3947
4440
  *
3948
4441
  * Default value is `true`.
4442
+ *
4443
+ * @returns Value of property `visibleM`
3949
4444
  */
3950
4445
  getVisibleM(): boolean;
3951
4446
  /**
@@ -3954,6 +4449,8 @@ declare namespace sap {
3954
4449
  * If this property is set the control will be visible (or not) in a small sized layout.
3955
4450
  *
3956
4451
  * Default value is `true`.
4452
+ *
4453
+ * @returns Value of property `visibleS`
3957
4454
  */
3958
4455
  getVisibleS(): boolean;
3959
4456
  /**
@@ -3962,6 +4459,8 @@ declare namespace sap {
3962
4459
  * If this property is set the control will take the provided size.
3963
4460
  *
3964
4461
  * Default value is `'auto'`.
4462
+ *
4463
+ * @returns Value of property `width`
3965
4464
  */
3966
4465
  getWidth(): sap.ui.core.CSSSize;
3967
4466
  /**
@@ -3972,6 +4471,8 @@ declare namespace sap {
3972
4471
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3973
4472
  *
3974
4473
  * Default value is `false`.
4474
+ *
4475
+ * @returns Reference to `this` in order to allow method chaining
3975
4476
  */
3976
4477
  setShowSeparatorAfter(
3977
4478
  /**
@@ -3987,6 +4488,8 @@ declare namespace sap {
3987
4488
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3988
4489
  *
3989
4490
  * Default value is `false`.
4491
+ *
4492
+ * @returns Reference to `this` in order to allow method chaining
3990
4493
  */
3991
4494
  setShowSeparatorBefore(
3992
4495
  /**
@@ -4002,6 +4505,8 @@ declare namespace sap {
4002
4505
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4003
4506
  *
4004
4507
  * Default value is `true`.
4508
+ *
4509
+ * @returns Reference to `this` in order to allow method chaining
4005
4510
  */
4006
4511
  setVisibleL(
4007
4512
  /**
@@ -4017,6 +4522,8 @@ declare namespace sap {
4017
4522
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4018
4523
  *
4019
4524
  * Default value is `true`.
4525
+ *
4526
+ * @returns Reference to `this` in order to allow method chaining
4020
4527
  */
4021
4528
  setVisibleM(
4022
4529
  /**
@@ -4032,6 +4539,8 @@ declare namespace sap {
4032
4539
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4033
4540
  *
4034
4541
  * Default value is `true`.
4542
+ *
4543
+ * @returns Reference to `this` in order to allow method chaining
4035
4544
  */
4036
4545
  setVisibleS(
4037
4546
  /**
@@ -4047,6 +4556,8 @@ declare namespace sap {
4047
4556
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4048
4557
  *
4049
4558
  * Default value is `'auto'`.
4559
+ *
4560
+ * @returns Reference to `this` in order to allow method chaining
4050
4561
  */
4051
4562
  setWidth(
4052
4563
  /**
@@ -4152,6 +4663,8 @@ declare namespace sap {
4152
4663
  * the information contained in `oClassInfo`.
4153
4664
  *
4154
4665
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
4666
+ *
4667
+ * @returns Created class / constructor function
4155
4668
  */
4156
4669
  static extend<T extends Record<string, unknown>>(
4157
4670
  /**
@@ -4170,10 +4683,14 @@ declare namespace sap {
4170
4683
  ): Function;
4171
4684
  /**
4172
4685
  * Returns a metadata object for class sap.uxap.ObjectPageLayout.
4686
+ *
4687
+ * @returns Metadata object describing this class
4173
4688
  */
4174
4689
  static getMetadata(): sap.ui.core.ElementMetadata;
4175
4690
  /**
4176
4691
  * Adds some headerContent to the aggregation {@link #getHeaderContent headerContent}.
4692
+ *
4693
+ * @returns Reference to `this` in order to allow method chaining
4177
4694
  */
4178
4695
  addHeaderContent(
4179
4696
  /**
@@ -4183,6 +4700,8 @@ declare namespace sap {
4183
4700
  ): this;
4184
4701
  /**
4185
4702
  * Adds some section to the aggregation {@link #getSections sections}.
4703
+ *
4704
+ * @returns Reference to `this` in order to allow method chaining
4186
4705
  */
4187
4706
  addSection(
4188
4707
  /**
@@ -4198,6 +4717,8 @@ declare namespace sap {
4198
4717
  * otherwise it will be bound to this `sap.uxap.ObjectPageLayout` itself.
4199
4718
  *
4200
4719
  * The event is fired when the Edit Header button is pressed
4720
+ *
4721
+ * @returns Reference to `this` in order to allow method chaining
4201
4722
  */
4202
4723
  attachEditHeaderButtonPress(
4203
4724
  /**
@@ -4222,6 +4743,8 @@ declare namespace sap {
4222
4743
  * otherwise it will be bound to this `sap.uxap.ObjectPageLayout` itself.
4223
4744
  *
4224
4745
  * The event is fired when the Edit Header button is pressed
4746
+ *
4747
+ * @returns Reference to `this` in order to allow method chaining
4225
4748
  */
4226
4749
  attachEditHeaderButtonPress(
4227
4750
  /**
@@ -4243,6 +4766,8 @@ declare namespace sap {
4243
4766
  * otherwise it will be bound to this `sap.uxap.ObjectPageLayout` itself.
4244
4767
  *
4245
4768
  * The event is fired when the `headerContentPinned` property is changed via user interaction.
4769
+ *
4770
+ * @returns Reference to `this` in order to allow method chaining
4246
4771
  */
4247
4772
  attachHeaderContentPinnedStateChange(
4248
4773
  /**
@@ -4269,6 +4794,8 @@ declare namespace sap {
4269
4794
  * otherwise it will be bound to this `sap.uxap.ObjectPageLayout` itself.
4270
4795
  *
4271
4796
  * The event is fired when the `headerContentPinned` property is changed via user interaction.
4797
+ *
4798
+ * @returns Reference to `this` in order to allow method chaining
4272
4799
  */
4273
4800
  attachHeaderContentPinnedStateChange(
4274
4801
  /**
@@ -4289,6 +4816,8 @@ declare namespace sap {
4289
4816
  * otherwise it will be bound to this `sap.uxap.ObjectPageLayout` itself.
4290
4817
  *
4291
4818
  * The event is fired when the selected section is changed using the navigation.
4819
+ *
4820
+ * @returns Reference to `this` in order to allow method chaining
4292
4821
  */
4293
4822
  attachNavigate(
4294
4823
  /**
@@ -4314,6 +4843,8 @@ declare namespace sap {
4314
4843
  * otherwise it will be bound to this `sap.uxap.ObjectPageLayout` itself.
4315
4844
  *
4316
4845
  * The event is fired when the selected section is changed using the navigation.
4846
+ *
4847
+ * @returns Reference to `this` in order to allow method chaining
4317
4848
  */
4318
4849
  attachNavigate(
4319
4850
  /**
@@ -4334,6 +4865,8 @@ declare namespace sap {
4334
4865
  * otherwise it will be bound to this `sap.uxap.ObjectPageLayout` itself.
4335
4866
  *
4336
4867
  * Fired when the current section is changed by scrolling.
4868
+ *
4869
+ * @returns Reference to `this` in order to allow method chaining
4337
4870
  */
4338
4871
  attachSectionChange(
4339
4872
  /**
@@ -4359,6 +4892,8 @@ declare namespace sap {
4359
4892
  * otherwise it will be bound to this `sap.uxap.ObjectPageLayout` itself.
4360
4893
  *
4361
4894
  * Fired when the current section is changed by scrolling.
4895
+ *
4896
+ * @returns Reference to `this` in order to allow method chaining
4362
4897
  */
4363
4898
  attachSectionChange(
4364
4899
  /**
@@ -4380,6 +4915,8 @@ declare namespace sap {
4380
4915
  * otherwise it will be bound to this `sap.uxap.ObjectPageLayout` itself.
4381
4916
  *
4382
4917
  * Fired when the visibility of subsections is changed.
4918
+ *
4919
+ * @returns Reference to `this` in order to allow method chaining
4383
4920
  */
4384
4921
  attachSubSectionVisibilityChange(
4385
4922
  /**
@@ -4406,6 +4943,8 @@ declare namespace sap {
4406
4943
  * otherwise it will be bound to this `sap.uxap.ObjectPageLayout` itself.
4407
4944
  *
4408
4945
  * Fired when the visibility of subsections is changed.
4946
+ *
4947
+ * @returns Reference to `this` in order to allow method chaining
4409
4948
  */
4410
4949
  attachSubSectionVisibilityChange(
4411
4950
  /**
@@ -4425,6 +4964,8 @@ declare namespace sap {
4425
4964
  * otherwise it will be bound to this `sap.uxap.ObjectPageLayout` itself.
4426
4965
  *
4427
4966
  * The event is fired when the Anchor bar is switched from moving to fixed or the other way round.
4967
+ *
4968
+ * @returns Reference to `this` in order to allow method chaining
4428
4969
  */
4429
4970
  attachToggleAnchorBar(
4430
4971
  /**
@@ -4449,6 +4990,8 @@ declare namespace sap {
4449
4990
  * otherwise it will be bound to this `sap.uxap.ObjectPageLayout` itself.
4450
4991
  *
4451
4992
  * The event is fired when the Anchor bar is switched from moving to fixed or the other way round.
4993
+ *
4994
+ * @returns Reference to `this` in order to allow method chaining
4452
4995
  */
4453
4996
  attachToggleAnchorBar(
4454
4997
  /**
@@ -4464,24 +5007,34 @@ declare namespace sap {
4464
5007
  * @SINCE 1.40
4465
5008
  *
4466
5009
  * Destroys the footer in the aggregation {@link #getFooter footer}.
5010
+ *
5011
+ * @returns Reference to `this` in order to allow method chaining
4467
5012
  */
4468
5013
  destroyFooter(): this;
4469
5014
  /**
4470
5015
  * Destroys all the headerContent in the aggregation {@link #getHeaderContent headerContent}.
5016
+ *
5017
+ * @returns Reference to `this` in order to allow method chaining
4471
5018
  */
4472
5019
  destroyHeaderContent(): this;
4473
5020
  /**
4474
5021
  * Destroys the headerTitle in the aggregation {@link #getHeaderTitle headerTitle}.
5022
+ *
5023
+ * @returns Reference to `this` in order to allow method chaining
4475
5024
  */
4476
5025
  destroyHeaderTitle(): this;
4477
5026
  /**
4478
5027
  * @SINCE 1.61
4479
5028
  *
4480
5029
  * Destroys the landmarkInfo in the aggregation {@link #getLandmarkInfo landmarkInfo}.
5030
+ *
5031
+ * @returns Reference to `this` in order to allow method chaining
4481
5032
  */
4482
5033
  destroyLandmarkInfo(): this;
4483
5034
  /**
4484
5035
  * Destroys all the sections in the aggregation {@link #getSections sections}.
5036
+ *
5037
+ * @returns Reference to `this` in order to allow method chaining
4485
5038
  */
4486
5039
  destroySections(): this;
4487
5040
  /**
@@ -4489,6 +5042,8 @@ declare namespace sap {
4489
5042
  * event of this `sap.uxap.ObjectPageLayout`.
4490
5043
  *
4491
5044
  * The passed function and listener object must match the ones used for event registration.
5045
+ *
5046
+ * @returns Reference to `this` in order to allow method chaining
4492
5047
  */
4493
5048
  detachEditHeaderButtonPress(
4494
5049
  /**
@@ -4507,6 +5062,8 @@ declare namespace sap {
4507
5062
  * event of this `sap.uxap.ObjectPageLayout`.
4508
5063
  *
4509
5064
  * The passed function and listener object must match the ones used for event registration.
5065
+ *
5066
+ * @returns Reference to `this` in order to allow method chaining
4510
5067
  */
4511
5068
  detachHeaderContentPinnedStateChange(
4512
5069
  /**
@@ -4524,6 +5081,8 @@ declare namespace sap {
4524
5081
  * Detaches event handler `fnFunction` from the {@link #event:navigate navigate} event of this `sap.uxap.ObjectPageLayout`.
4525
5082
  *
4526
5083
  * The passed function and listener object must match the ones used for event registration.
5084
+ *
5085
+ * @returns Reference to `this` in order to allow method chaining
4527
5086
  */
4528
5087
  detachNavigate(
4529
5088
  /**
@@ -4542,6 +5101,8 @@ declare namespace sap {
4542
5101
  * `sap.uxap.ObjectPageLayout`.
4543
5102
  *
4544
5103
  * The passed function and listener object must match the ones used for event registration.
5104
+ *
5105
+ * @returns Reference to `this` in order to allow method chaining
4545
5106
  */
4546
5107
  detachSectionChange(
4547
5108
  /**
@@ -4560,6 +5121,8 @@ declare namespace sap {
4560
5121
  * event of this `sap.uxap.ObjectPageLayout`.
4561
5122
  *
4562
5123
  * The passed function and listener object must match the ones used for event registration.
5124
+ *
5125
+ * @returns Reference to `this` in order to allow method chaining
4563
5126
  */
4564
5127
  detachSubSectionVisibilityChange(
4565
5128
  /**
@@ -4576,6 +5139,8 @@ declare namespace sap {
4576
5139
  * this `sap.uxap.ObjectPageLayout`.
4577
5140
  *
4578
5141
  * The passed function and listener object must match the ones used for event registration.
5142
+ *
5143
+ * @returns Reference to `this` in order to allow method chaining
4579
5144
  */
4580
5145
  detachToggleAnchorBar(
4581
5146
  /**
@@ -4589,6 +5154,8 @@ declare namespace sap {
4589
5154
  ): this;
4590
5155
  /**
4591
5156
  * Fires event {@link #event:editHeaderButtonPress editHeaderButtonPress} to attached listeners.
5157
+ *
5158
+ * @returns Reference to `this` in order to allow method chaining
4592
5159
  */
4593
5160
  fireEditHeaderButtonPress(
4594
5161
  /**
@@ -4601,6 +5168,8 @@ declare namespace sap {
4601
5168
  *
4602
5169
  * Fires event {@link #event:headerContentPinnedStateChange headerContentPinnedStateChange} to attached
4603
5170
  * listeners.
5171
+ *
5172
+ * @returns Reference to `this` in order to allow method chaining
4604
5173
  */
4605
5174
  fireHeaderContentPinnedStateChange(
4606
5175
  /**
@@ -4617,6 +5186,8 @@ declare namespace sap {
4617
5186
  * @SINCE 1.40
4618
5187
  *
4619
5188
  * Fires event {@link #event:navigate navigate} to attached listeners.
5189
+ *
5190
+ * @returns Reference to `this` in order to allow method chaining
4620
5191
  */
4621
5192
  fireNavigate(
4622
5193
  /**
@@ -4637,6 +5208,8 @@ declare namespace sap {
4637
5208
  * @SINCE 1.73
4638
5209
  *
4639
5210
  * Fires event {@link #event:sectionChange sectionChange} to attached listeners.
5211
+ *
5212
+ * @returns Reference to `this` in order to allow method chaining
4640
5213
  */
4641
5214
  fireSectionChange(
4642
5215
  /**
@@ -4657,6 +5230,8 @@ declare namespace sap {
4657
5230
  * @SINCE 1.77
4658
5231
  *
4659
5232
  * Fires event {@link #event:subSectionVisibilityChange subSectionVisibilityChange} to attached listeners.
5233
+ *
5234
+ * @returns Reference to `this` in order to allow method chaining
4660
5235
  */
4661
5236
  fireSubSectionVisibilityChange(
4662
5237
  /**
@@ -4671,6 +5246,8 @@ declare namespace sap {
4671
5246
  ): this;
4672
5247
  /**
4673
5248
  * Fires event {@link #event:toggleAnchorBar toggleAnchorBar} to attached listeners.
5249
+ *
5250
+ * @returns Reference to `this` in order to allow method chaining
4674
5251
  */
4675
5252
  fireToggleAnchorBar(
4676
5253
  /**
@@ -4695,6 +5272,8 @@ declare namespace sap {
4695
5272
  * for the `headerTitle` aggregation.
4696
5273
  *
4697
5274
  * Default value is `false`.
5275
+ *
5276
+ * @returns Value of property `alwaysShowContentHeader`
4698
5277
  */
4699
5278
  getAlwaysShowContentHeader(): boolean;
4700
5279
  /**
@@ -4706,6 +5285,8 @@ declare namespace sap {
4706
5285
  *
4707
5286
  * **Note:** The default value of `backgroundDesignAnchorBar` property is null. If the property is not set,
4708
5287
  * the color of the background is `@sapUiObjectHeaderBackground`, which depends on the specific theme.
5288
+ *
5289
+ * @returns Value of property `backgroundDesignAnchorBar`
4709
5290
  */
4710
5291
  getBackgroundDesignAnchorBar(): sap.m.BackgroundDesign;
4711
5292
  /**
@@ -4714,6 +5295,8 @@ declare namespace sap {
4714
5295
  * Enable lazy loading for the Object page Subsections.
4715
5296
  *
4716
5297
  * Default value is `false`.
5298
+ *
5299
+ * @returns Value of property `enableLazyLoading`
4717
5300
  */
4718
5301
  getEnableLazyLoading(): boolean;
4719
5302
  /**
@@ -4725,6 +5308,8 @@ declare namespace sap {
4725
5308
  * For more information about SAPUI5 flexibility, refer to the Developer Guide.
4726
5309
  *
4727
5310
  * Default value is `false`.
5311
+ *
5312
+ * @returns Value of property `flexEnabled`
4728
5313
  */
4729
5314
  getFlexEnabled(): boolean;
4730
5315
  /**
@@ -4755,6 +5340,8 @@ declare namespace sap {
4755
5340
  * is used for the `headerTitle` aggregation.
4756
5341
  *
4757
5342
  * Default value is `true`.
5343
+ *
5344
+ * @returns Value of property `headerContentPinnable`
4758
5345
  */
4759
5346
  getHeaderContentPinnable(): boolean;
4760
5347
  /**
@@ -4778,6 +5365,8 @@ declare namespace sap {
4778
5365
  * - The `preserveHeaderStateOnScroll` property or the rules for it to work are `false`
4779
5366
  *
4780
5367
  * Default value is `false`.
5368
+ *
5369
+ * @returns Value of property `headerContentPinned`
4781
5370
  */
4782
5371
  getHeaderContentPinned(): boolean;
4783
5372
  /**
@@ -4792,6 +5381,8 @@ declare namespace sap {
4792
5381
  * Determines the height of the ObjectPage.
4793
5382
  *
4794
5383
  * Default value is `"100%"`.
5384
+ *
5385
+ * @returns Value of property `height`
4795
5386
  */
4796
5387
  getHeight(): sap.ui.core.CSSSize;
4797
5388
  /**
@@ -4806,6 +5397,8 @@ declare namespace sap {
4806
5397
  * for the `headerTitle` aggregation.
4807
5398
  *
4808
5399
  * Default value is `false`.
5400
+ *
5401
+ * @returns Value of property `isChildPage`
4809
5402
  */
4810
5403
  getIsChildPage(): boolean;
4811
5404
  /**
@@ -4834,10 +5427,14 @@ declare namespace sap {
4834
5427
  * than the given threshold.
4835
5428
  *
4836
5429
  * Default value is `false`.
5430
+ *
5431
+ * @returns Value of property `preserveHeaderStateOnScroll`
4837
5432
  */
4838
5433
  getPreserveHeaderStateOnScroll(): boolean;
4839
5434
  /**
4840
5435
  * Returns the `sap.ui.core.ScrollEnablement` delegate which is used with this control.
5436
+ *
5437
+ * @returns The scroll delegate instance
4841
5438
  */
4842
5439
  getScrollDelegate(): sap.ui.core.delegate.ScrollEnablement;
4843
5440
  /**
@@ -4876,6 +5473,8 @@ declare namespace sap {
4876
5473
  * In this case the value of this property will be ignored.
4877
5474
  *
4878
5475
  * Default value is `Auto`.
5476
+ *
5477
+ * @returns Value of property `sectionTitleLevel`
4879
5478
  */
4880
5479
  getSectionTitleLevel(): sap.ui.core.TitleLevel;
4881
5480
  /**
@@ -4891,6 +5490,8 @@ declare namespace sap {
4891
5490
  * Determines whether the Navigation bar (Anchor bar) is displayed.
4892
5491
  *
4893
5492
  * Default value is `true`.
5493
+ *
5494
+ * @returns Value of property `showAnchorBar`
4894
5495
  */
4895
5496
  getShowAnchorBar(): boolean;
4896
5497
  /**
@@ -4900,6 +5501,8 @@ declare namespace sap {
4900
5501
  * bar.
4901
5502
  *
4902
5503
  * Default value is `true`.
5504
+ *
5505
+ * @returns Value of property `showAnchorBarPopover`
4903
5506
  */
4904
5507
  getShowAnchorBarPopover(): boolean;
4905
5508
  /**
@@ -4913,6 +5516,8 @@ declare namespace sap {
4913
5516
  * for the `headerTitle` aggregation.
4914
5517
  *
4915
5518
  * Default value is `false`.
5519
+ *
5520
+ * @returns Value of property `showEditHeaderButton`
4916
5521
  */
4917
5522
  getShowEditHeaderButton(): boolean;
4918
5523
  /**
@@ -4923,6 +5528,8 @@ declare namespace sap {
4923
5528
  * Determines whether the footer is visible.
4924
5529
  *
4925
5530
  * Default value is `false`.
5531
+ *
5532
+ * @returns Value of property `showFooter`
4926
5533
  */
4927
5534
  getShowFooter(): boolean;
4928
5535
  /**
@@ -4931,6 +5538,8 @@ declare namespace sap {
4931
5538
  * Determines the visibility of the Header content (headerContent aggregation).
4932
5539
  *
4933
5540
  * Default value is `true`.
5541
+ *
5542
+ * @returns Value of property `showHeaderContent`
4934
5543
  */
4935
5544
  getShowHeaderContent(): boolean;
4936
5545
  /**
@@ -4941,6 +5550,8 @@ declare namespace sap {
4941
5550
  * Determines whether sections and subsections with importance Low and Medium are hidden even on large screens.
4942
5551
  *
4943
5552
  * Default value is `false`.
5553
+ *
5554
+ * @returns Value of property `showOnlyHighImportance`
4944
5555
  */
4945
5556
  getShowOnlyHighImportance(): boolean;
4946
5557
  /**
@@ -4952,6 +5563,8 @@ declare namespace sap {
4952
5563
  * for the `headerTitle` aggregation.
4953
5564
  *
4954
5565
  * Default value is `false`.
5566
+ *
5567
+ * @returns Value of property `showTitleInHeaderContent`
4955
5568
  */
4956
5569
  getShowTitleInHeaderContent(): boolean;
4957
5570
  /**
@@ -4960,6 +5573,8 @@ declare namespace sap {
4960
5573
  * Determines whether Subsection titles are displayed on top or to the left of the Subsection content.
4961
5574
  *
4962
5575
  * Default value is `TitleOnTop`.
5576
+ *
5577
+ * @returns Value of property `subSectionLayout`
4963
5578
  */
4964
5579
  getSubSectionLayout(): sap.uxap.ObjectPageSubSectionLayout;
4965
5580
  /**
@@ -4976,6 +5591,8 @@ declare namespace sap {
4976
5591
  * is used for the `headerTitle` aggregation.
4977
5592
  *
4978
5593
  * Default value is `true`.
5594
+ *
5595
+ * @returns Value of property `toggleHeaderOnTitleClick`
4979
5596
  */
4980
5597
  getToggleHeaderOnTitleClick(): boolean;
4981
5598
  /**
@@ -4984,6 +5601,8 @@ declare namespace sap {
4984
5601
  * Determines whether the Anchor bar items are displayed in upper case.
4985
5602
  *
4986
5603
  * Default value is `true`.
5604
+ *
5605
+ * @returns Value of property `upperCaseAnchorBar`
4987
5606
  */
4988
5607
  getUpperCaseAnchorBar(): boolean;
4989
5608
  /**
@@ -4995,6 +5614,8 @@ declare namespace sap {
4995
5614
  * **Note:** Keep in mind that the `sap.m.IconTabBar` control is no longer used for the tab navigation mode.
4996
5615
  *
4997
5616
  * Default value is `false`.
5617
+ *
5618
+ * @returns Value of property `useIconTabBar`
4998
5619
  */
4999
5620
  getUseIconTabBar(): boolean;
5000
5621
  /**
@@ -5003,11 +5624,15 @@ declare namespace sap {
5003
5624
  * Determines whether the to use two column layout for the L screen size.
5004
5625
  *
5005
5626
  * Default value is `false`.
5627
+ *
5628
+ * @returns Value of property `useTwoColumnsForLargeScreen`
5006
5629
  */
5007
5630
  getUseTwoColumnsForLargeScreen(): boolean;
5008
5631
  /**
5009
5632
  * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getHeaderContent headerContent}.
5010
5633
  * and returns its index if found or -1 otherwise.
5634
+ *
5635
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
5011
5636
  */
5012
5637
  indexOfHeaderContent(
5013
5638
  /**
@@ -5018,6 +5643,8 @@ declare namespace sap {
5018
5643
  /**
5019
5644
  * Checks for the provided `sap.uxap.ObjectPageSection` in the aggregation {@link #getSections sections}.
5020
5645
  * and returns its index if found or -1 otherwise.
5646
+ *
5647
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
5021
5648
  */
5022
5649
  indexOfSection(
5023
5650
  /**
@@ -5027,6 +5654,8 @@ declare namespace sap {
5027
5654
  ): int;
5028
5655
  /**
5029
5656
  * Inserts a headerContent into the aggregation {@link #getHeaderContent headerContent}.
5657
+ *
5658
+ * @returns Reference to `this` in order to allow method chaining
5030
5659
  */
5031
5660
  insertHeaderContent(
5032
5661
  /**
@@ -5042,6 +5671,8 @@ declare namespace sap {
5042
5671
  ): this;
5043
5672
  /**
5044
5673
  * Inserts a section into the aggregation {@link #getSections sections}.
5674
+ *
5675
+ * @returns Reference to `this` in order to allow method chaining
5045
5676
  */
5046
5677
  insertSection(
5047
5678
  /**
@@ -5070,16 +5701,22 @@ declare namespace sap {
5070
5701
  * Removes all the controls from the aggregation {@link #getHeaderContent headerContent}.
5071
5702
  *
5072
5703
  * Additionally, it unregisters them from the hosting UIArea.
5704
+ *
5705
+ * @returns An array of the removed elements (might be empty)
5073
5706
  */
5074
5707
  removeAllHeaderContent(): sap.ui.core.Control[];
5075
5708
  /**
5076
5709
  * Removes all the controls from the aggregation {@link #getSections sections}.
5077
5710
  *
5078
5711
  * Additionally, it unregisters them from the hosting UIArea.
5712
+ *
5713
+ * @returns An array of the removed elements (might be empty)
5079
5714
  */
5080
5715
  removeAllSections(): sap.uxap.ObjectPageSection[];
5081
5716
  /**
5082
5717
  * Removes a headerContent from the aggregation {@link #getHeaderContent headerContent}.
5718
+ *
5719
+ * @returns The removed headerContent or `null`
5083
5720
  */
5084
5721
  removeHeaderContent(
5085
5722
  /**
@@ -5089,6 +5726,8 @@ declare namespace sap {
5089
5726
  ): sap.ui.core.Control;
5090
5727
  /**
5091
5728
  * Removes a section from the aggregation {@link #getSections sections}.
5729
+ *
5730
+ * @returns The removed section or `null`
5092
5731
  */
5093
5732
  removeSection(
5094
5733
  /**
@@ -5126,6 +5765,8 @@ declare namespace sap {
5126
5765
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5127
5766
  *
5128
5767
  * Default value is `false`.
5768
+ *
5769
+ * @returns Reference to `this` in order to allow method chaining
5129
5770
  */
5130
5771
  setAlwaysShowContentHeader(
5131
5772
  /**
@@ -5137,6 +5778,8 @@ declare namespace sap {
5137
5778
  * @SINCE 1.58
5138
5779
  *
5139
5780
  * Sets the value of the `backgroundDesignAnchorBar` property.
5781
+ *
5782
+ * @returns `this` to allow method chaining
5140
5783
  */
5141
5784
  setBackgroundDesignAnchorBar(
5142
5785
  /**
@@ -5152,6 +5795,8 @@ declare namespace sap {
5152
5795
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5153
5796
  *
5154
5797
  * Default value is `false`.
5798
+ *
5799
+ * @returns Reference to `this` in order to allow method chaining
5155
5800
  */
5156
5801
  setEnableLazyLoading(
5157
5802
  /**
@@ -5170,6 +5815,8 @@ declare namespace sap {
5170
5815
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5171
5816
  *
5172
5817
  * Default value is `false`.
5818
+ *
5819
+ * @returns Reference to `this` in order to allow method chaining
5173
5820
  */
5174
5821
  setFlexEnabled(
5175
5822
  /**
@@ -5181,6 +5828,8 @@ declare namespace sap {
5181
5828
  * @SINCE 1.40
5182
5829
  *
5183
5830
  * Sets the aggregated {@link #getFooter footer}.
5831
+ *
5832
+ * @returns Reference to `this` in order to allow method chaining
5184
5833
  */
5185
5834
  setFooter(
5186
5835
  /**
@@ -5204,6 +5853,8 @@ declare namespace sap {
5204
5853
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5205
5854
  *
5206
5855
  * Default value is `true`.
5856
+ *
5857
+ * @returns Reference to `this` in order to allow method chaining
5207
5858
  */
5208
5859
  setHeaderContentPinnable(
5209
5860
  /**
@@ -5234,6 +5885,8 @@ declare namespace sap {
5234
5885
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5235
5886
  *
5236
5887
  * Default value is `false`.
5888
+ *
5889
+ * @returns Reference to `this` in order to allow method chaining
5237
5890
  */
5238
5891
  setHeaderContentPinned(
5239
5892
  /**
@@ -5243,6 +5896,8 @@ declare namespace sap {
5243
5896
  ): this;
5244
5897
  /**
5245
5898
  * Sets the aggregated {@link #getHeaderTitle headerTitle}.
5899
+ *
5900
+ * @returns Reference to `this` in order to allow method chaining
5246
5901
  */
5247
5902
  setHeaderTitle(
5248
5903
  /**
@@ -5258,6 +5913,8 @@ declare namespace sap {
5258
5913
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5259
5914
  *
5260
5915
  * Default value is `"100%"`.
5916
+ *
5917
+ * @returns Reference to `this` in order to allow method chaining
5261
5918
  */
5262
5919
  setHeight(
5263
5920
  /**
@@ -5279,6 +5936,8 @@ declare namespace sap {
5279
5936
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5280
5937
  *
5281
5938
  * Default value is `false`.
5939
+ *
5940
+ * @returns Reference to `this` in order to allow method chaining
5282
5941
  */
5283
5942
  setIsChildPage(
5284
5943
  /**
@@ -5290,6 +5949,8 @@ declare namespace sap {
5290
5949
  * @SINCE 1.61
5291
5950
  *
5292
5951
  * Sets the aggregated {@link #getLandmarkInfo landmarkInfo}.
5952
+ *
5953
+ * @returns Reference to `this` in order to allow method chaining
5293
5954
  */
5294
5955
  setLandmarkInfo(
5295
5956
  /**
@@ -5315,6 +5976,8 @@ declare namespace sap {
5315
5976
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5316
5977
  *
5317
5978
  * Default value is `false`.
5979
+ *
5980
+ * @returns Reference to `this` in order to allow method chaining
5318
5981
  */
5319
5982
  setPreserveHeaderStateOnScroll(
5320
5983
  /**
@@ -5350,6 +6013,8 @@ declare namespace sap {
5350
6013
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5351
6014
  *
5352
6015
  * Default value is `Auto`.
6016
+ *
6017
+ * @returns Reference to `this` in order to allow method chaining
5353
6018
  */
5354
6019
  setSectionTitleLevel(
5355
6020
  /**
@@ -5362,14 +6027,18 @@ declare namespace sap {
5362
6027
  *
5363
6028
  * The section can either be given by itself or by its id.
5364
6029
  *
5365
- * Note that an argument of `null` will cause the first visible section be set as `selectedSection`. This
5366
- * is because the `sap.uxap.ObjectPageLayout` should always have one of its sections selected (unless it
5367
- * has 0 visible sections).
6030
+ * If left unspecified, then the page automatically sets the value to the first visible section before rendering.
6031
+ * The value never remains empty because `sap.uxap.ObjectPageLayout` should always have one of its sections
6032
+ * selected (unless it has 0 visible sections).
6033
+ *
6034
+ * **Note:** Updating the `selectedSection` with a value of `null` resets the `selectedSection` to the first
6035
+ * visible section and scrolls the page to the top.
6036
+ *
6037
+ * @returns Returns `this` to allow method chaining
5368
6038
  */
5369
6039
  setSelectedSection(
5370
6040
  /**
5371
- * The ID or the section instance that should be selected Note that `null` or `undefined` are not valid
5372
- * arguments
6041
+ * The ID or the section instance that should be selected Note that `undefined` is not a valid argument
5373
6042
  */
5374
6043
  sId: string | sap.uxap.ObjectPageSection
5375
6044
  ): this;
@@ -5381,6 +6050,8 @@ declare namespace sap {
5381
6050
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5382
6051
  *
5383
6052
  * Default value is `true`.
6053
+ *
6054
+ * @returns Reference to `this` in order to allow method chaining
5384
6055
  */
5385
6056
  setShowAnchorBar(
5386
6057
  /**
@@ -5397,6 +6068,8 @@ declare namespace sap {
5397
6068
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5398
6069
  *
5399
6070
  * Default value is `true`.
6071
+ *
6072
+ * @returns Reference to `this` in order to allow method chaining
5400
6073
  */
5401
6074
  setShowAnchorBarPopover(
5402
6075
  /**
@@ -5417,6 +6090,8 @@ declare namespace sap {
5417
6090
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5418
6091
  *
5419
6092
  * Default value is `false`.
6093
+ *
6094
+ * @returns Reference to `this` in order to allow method chaining
5420
6095
  */
5421
6096
  setShowEditHeaderButton(
5422
6097
  /**
@@ -5434,6 +6109,8 @@ declare namespace sap {
5434
6109
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5435
6110
  *
5436
6111
  * Default value is `false`.
6112
+ *
6113
+ * @returns Reference to `this` in order to allow method chaining
5437
6114
  */
5438
6115
  setShowFooter(
5439
6116
  /**
@@ -5449,6 +6126,8 @@ declare namespace sap {
5449
6126
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5450
6127
  *
5451
6128
  * Default value is `true`.
6129
+ *
6130
+ * @returns Reference to `this` in order to allow method chaining
5452
6131
  */
5453
6132
  setShowHeaderContent(
5454
6133
  /**
@@ -5466,6 +6145,8 @@ declare namespace sap {
5466
6145
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5467
6146
  *
5468
6147
  * Default value is `false`.
6148
+ *
6149
+ * @returns Reference to `this` in order to allow method chaining
5469
6150
  */
5470
6151
  setShowOnlyHighImportance(
5471
6152
  /**
@@ -5484,6 +6165,8 @@ declare namespace sap {
5484
6165
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5485
6166
  *
5486
6167
  * Default value is `false`.
6168
+ *
6169
+ * @returns Reference to `this` in order to allow method chaining
5487
6170
  */
5488
6171
  setShowTitleInHeaderContent(
5489
6172
  /**
@@ -5499,6 +6182,8 @@ declare namespace sap {
5499
6182
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5500
6183
  *
5501
6184
  * Default value is `TitleOnTop`.
6185
+ *
6186
+ * @returns Reference to `this` in order to allow method chaining
5502
6187
  */
5503
6188
  setSubSectionLayout(
5504
6189
  /**
@@ -5522,6 +6207,8 @@ declare namespace sap {
5522
6207
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5523
6208
  *
5524
6209
  * Default value is `true`.
6210
+ *
6211
+ * @returns Reference to `this` in order to allow method chaining
5525
6212
  */
5526
6213
  setToggleHeaderOnTitleClick(
5527
6214
  /**
@@ -5537,6 +6224,8 @@ declare namespace sap {
5537
6224
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5538
6225
  *
5539
6226
  * Default value is `true`.
6227
+ *
6228
+ * @returns Reference to `this` in order to allow method chaining
5540
6229
  */
5541
6230
  setUpperCaseAnchorBar(
5542
6231
  /**
@@ -5555,6 +6244,8 @@ declare namespace sap {
5555
6244
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5556
6245
  *
5557
6246
  * Default value is `false`.
6247
+ *
6248
+ * @returns Reference to `this` in order to allow method chaining
5558
6249
  */
5559
6250
  setUseIconTabBar(
5560
6251
  /**
@@ -5570,6 +6261,8 @@ declare namespace sap {
5570
6261
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5571
6262
  *
5572
6263
  * Default value is `false`.
6264
+ *
6265
+ * @returns Reference to `this` in order to allow method chaining
5573
6266
  */
5574
6267
  setUseTwoColumnsForLargeScreen(
5575
6268
  /**
@@ -5631,6 +6324,8 @@ declare namespace sap {
5631
6324
  * with the information contained in `oClassInfo`.
5632
6325
  *
5633
6326
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
6327
+ *
6328
+ * @returns Created class / constructor function
5634
6329
  */
5635
6330
  static extend<T extends Record<string, unknown>>(
5636
6331
  /**
@@ -5649,10 +6344,14 @@ declare namespace sap {
5649
6344
  ): Function;
5650
6345
  /**
5651
6346
  * Returns a metadata object for class sap.uxap.ObjectPageLazyLoader.
6347
+ *
6348
+ * @returns Metadata object describing this class
5652
6349
  */
5653
6350
  static getMetadata(): sap.ui.core.ElementMetadata;
5654
6351
  /**
5655
6352
  * Adds some content to the aggregation {@link #getContent content}.
6353
+ *
6354
+ * @returns Reference to `this` in order to allow method chaining
5656
6355
  */
5657
6356
  addContent(
5658
6357
  /**
@@ -5662,6 +6361,8 @@ declare namespace sap {
5662
6361
  ): this;
5663
6362
  /**
5664
6363
  * Destroys all the content in the aggregation {@link #getContent content}.
6364
+ *
6365
+ * @returns Reference to `this` in order to allow method chaining
5665
6366
  */
5666
6367
  destroyContent(): this;
5667
6368
  /**
@@ -5673,6 +6374,8 @@ declare namespace sap {
5673
6374
  /**
5674
6375
  * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getContent content}. and returns
5675
6376
  * its index if found or -1 otherwise.
6377
+ *
6378
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
5676
6379
  */
5677
6380
  indexOfContent(
5678
6381
  /**
@@ -5682,6 +6385,8 @@ declare namespace sap {
5682
6385
  ): int;
5683
6386
  /**
5684
6387
  * Inserts a content into the aggregation {@link #getContent content}.
6388
+ *
6389
+ * @returns Reference to `this` in order to allow method chaining
5685
6390
  */
5686
6391
  insertContent(
5687
6392
  /**
@@ -5699,10 +6404,14 @@ declare namespace sap {
5699
6404
  * Removes all the controls from the aggregation {@link #getContent content}.
5700
6405
  *
5701
6406
  * Additionally, it unregisters them from the hosting UIArea.
6407
+ *
6408
+ * @returns An array of the removed elements (might be empty)
5702
6409
  */
5703
6410
  removeAllContent(): sap.ui.core.Control[];
5704
6411
  /**
5705
6412
  * Removes a content from the aggregation {@link #getContent content}.
6413
+ *
6414
+ * @returns The removed content or `null`
5706
6415
  */
5707
6416
  removeContent(
5708
6417
  /**
@@ -5757,6 +6466,8 @@ declare namespace sap {
5757
6466
  * the information contained in `oClassInfo`.
5758
6467
  *
5759
6468
  * `oClassInfo` might contain the same kind of information as described in {@link sap.uxap.ObjectPageSectionBase.extend}.
6469
+ *
6470
+ * @returns Created class / constructor function
5760
6471
  */
5761
6472
  static extend<T extends Record<string, unknown>>(
5762
6473
  /**
@@ -5775,10 +6486,14 @@ declare namespace sap {
5775
6486
  ): Function;
5776
6487
  /**
5777
6488
  * Returns a metadata object for class sap.uxap.ObjectPageSection.
6489
+ *
6490
+ * @returns Metadata object describing this class
5778
6491
  */
5779
6492
  static getMetadata(): sap.ui.core.ElementMetadata;
5780
6493
  /**
5781
6494
  * Adds some subSection to the aggregation {@link #getSubSections subSections}.
6495
+ *
6496
+ * @returns Reference to `this` in order to allow method chaining
5782
6497
  */
5783
6498
  addSubSection(
5784
6499
  /**
@@ -5788,6 +6503,8 @@ declare namespace sap {
5788
6503
  ): this;
5789
6504
  /**
5790
6505
  * Destroys all the subSections in the aggregation {@link #getSubSections subSections}.
6506
+ *
6507
+ * @returns Reference to `this` in order to allow method chaining
5791
6508
  */
5792
6509
  destroySubSections(): this;
5793
6510
  /**
@@ -5801,6 +6518,8 @@ declare namespace sap {
5801
6518
  * Determines whether to display the Section title or not.
5802
6519
  *
5803
6520
  * Default value is `true`.
6521
+ *
6522
+ * @returns Value of property `showTitle`
5804
6523
  */
5805
6524
  getShowTitle(): boolean;
5806
6525
  /**
@@ -5815,11 +6534,15 @@ declare namespace sap {
5815
6534
  * Determines whether the Section title is displayed in upper case.
5816
6535
  *
5817
6536
  * Default value is `true`.
6537
+ *
6538
+ * @returns Value of property `titleUppercase`
5818
6539
  */
5819
6540
  getTitleUppercase(): boolean;
5820
6541
  /**
5821
6542
  * Checks for the provided `sap.uxap.ObjectPageSubSection` in the aggregation {@link #getSubSections subSections}.
5822
6543
  * and returns its index if found or -1 otherwise.
6544
+ *
6545
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
5823
6546
  */
5824
6547
  indexOfSubSection(
5825
6548
  /**
@@ -5829,6 +6552,8 @@ declare namespace sap {
5829
6552
  ): int;
5830
6553
  /**
5831
6554
  * Inserts a subSection into the aggregation {@link #getSubSections subSections}.
6555
+ *
6556
+ * @returns Reference to `this` in order to allow method chaining
5832
6557
  */
5833
6558
  insertSubSection(
5834
6559
  /**
@@ -5846,10 +6571,14 @@ declare namespace sap {
5846
6571
  * Removes all the controls from the aggregation {@link #getSubSections subSections}.
5847
6572
  *
5848
6573
  * Additionally, it unregisters them from the hosting UIArea.
6574
+ *
6575
+ * @returns An array of the removed elements (might be empty)
5849
6576
  */
5850
6577
  removeAllSubSections(): sap.uxap.ObjectPageSubSection[];
5851
6578
  /**
5852
6579
  * Removes a subSection from the aggregation {@link #getSubSections subSections}.
6580
+ *
6581
+ * @returns The removed subSection or `null`
5853
6582
  */
5854
6583
  removeSubSection(
5855
6584
  /**
@@ -5859,6 +6588,8 @@ declare namespace sap {
5859
6588
  ): sap.uxap.ObjectPageSubSection;
5860
6589
  /**
5861
6590
  * Sets the associated {@link #getSelectedSubSection selectedSubSection}.
6591
+ *
6592
+ * @returns Reference to `this` in order to allow method chaining
5862
6593
  */
5863
6594
  setSelectedSubSection(
5864
6595
  /**
@@ -5875,6 +6606,8 @@ declare namespace sap {
5875
6606
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5876
6607
  *
5877
6608
  * Default value is `true`.
6609
+ *
6610
+ * @returns Reference to `this` in order to allow method chaining
5878
6611
  */
5879
6612
  setShowTitle(
5880
6613
  /**
@@ -5890,6 +6623,8 @@ declare namespace sap {
5890
6623
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5891
6624
  *
5892
6625
  * Default value is `true`.
6626
+ *
6627
+ * @returns Reference to `this` in order to allow method chaining
5893
6628
  */
5894
6629
  setTitleUppercase(
5895
6630
  /**
@@ -5940,6 +6675,8 @@ declare namespace sap {
5940
6675
  * with the information contained in `oClassInfo`.
5941
6676
  *
5942
6677
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
6678
+ *
6679
+ * @returns Created class / constructor function
5943
6680
  */
5944
6681
  static extend<T extends Record<string, unknown>>(
5945
6682
  /**
@@ -5958,6 +6695,8 @@ declare namespace sap {
5958
6695
  ): Function;
5959
6696
  /**
5960
6697
  * Returns a metadata object for class sap.uxap.ObjectPageSectionBase.
6698
+ *
6699
+ * @returns Metadata object describing this class
5961
6700
  */
5962
6701
  static getMetadata(): sap.ui.core.ElementMetadata;
5963
6702
  /**
@@ -5966,6 +6705,8 @@ declare namespace sap {
5966
6705
  connectToModels(): void;
5967
6706
  /**
5968
6707
  * Destroys the customAnchorBarButton in the aggregation {@link #getCustomAnchorBarButton customAnchorBarButton}.
6708
+ *
6709
+ * @returns Reference to `this` in order to allow method chaining
5969
6710
  */
5970
6711
  destroyCustomAnchorBarButton(): this;
5971
6712
  /**
@@ -5987,12 +6728,16 @@ declare namespace sap {
5987
6728
  * Determines whether the section will be hidden on low resolutions.
5988
6729
  *
5989
6730
  * Default value is `High`.
6731
+ *
6732
+ * @returns Value of property `importance`
5990
6733
  */
5991
6734
  getImportance(): sap.uxap.Importance;
5992
6735
  /**
5993
6736
  * Returns the control name text.
5994
6737
  *
5995
6738
  * To be overwritten by the specific control method.
6739
+ *
6740
+ * @returns control name text
5996
6741
  */
5997
6742
  getSectionText(): string;
5998
6743
  /**
@@ -6003,6 +6748,8 @@ declare namespace sap {
6003
6748
  * **Note:** If a subsection is the only one (or the only one visible) within a section, its title is displayed
6004
6749
  * instead of the section title. This behavior is true even if the `showTitle` propeprty of {@link sap.uxap.ObjectPageSubSection}
6005
6750
  * is set to `false`.
6751
+ *
6752
+ * @returns Value of property `title`
6006
6753
  */
6007
6754
  getTitle(): string;
6008
6755
  /**
@@ -6019,6 +6766,8 @@ declare namespace sap {
6019
6766
  * title.
6020
6767
  *
6021
6768
  * Default value is `Auto`.
6769
+ *
6770
+ * @returns Value of property `titleLevel`
6022
6771
  */
6023
6772
  getTitleLevel(): sap.ui.core.TitleLevel;
6024
6773
  /**
@@ -6027,10 +6776,14 @@ declare namespace sap {
6027
6776
  * Invisible ObjectPageSectionBase are not rendered
6028
6777
  *
6029
6778
  * Default value is `true`.
6779
+ *
6780
+ * @returns Value of property `visible`
6030
6781
  */
6031
6782
  getVisible(): boolean;
6032
6783
  /**
6033
6784
  * Sets the aggregated {@link #getCustomAnchorBarButton customAnchorBarButton}.
6785
+ *
6786
+ * @returns Reference to `this` in order to allow method chaining
6034
6787
  */
6035
6788
  setCustomAnchorBarButton(
6036
6789
  /**
@@ -6048,6 +6801,8 @@ declare namespace sap {
6048
6801
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6049
6802
  *
6050
6803
  * Default value is `High`.
6804
+ *
6805
+ * @returns Reference to `this` in order to allow method chaining
6051
6806
  */
6052
6807
  setImportance(
6053
6808
  /**
@@ -6059,6 +6814,8 @@ declare namespace sap {
6059
6814
  * Returns the DOM Element that should get the focus.
6060
6815
  *
6061
6816
  * To be overwritten by the specific control method.
6817
+ *
6818
+ * @returns this for chaining
6062
6819
  */
6063
6820
  setInvisibleTextLabelValue(): this;
6064
6821
  /**
@@ -6071,6 +6828,8 @@ declare namespace sap {
6071
6828
  * is set to `false`.
6072
6829
  *
6073
6830
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6831
+ *
6832
+ * @returns Reference to `this` in order to allow method chaining
6074
6833
  */
6075
6834
  setTitle(
6076
6835
  /**
@@ -6094,6 +6853,8 @@ declare namespace sap {
6094
6853
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6095
6854
  *
6096
6855
  * Default value is `Auto`.
6856
+ *
6857
+ * @returns Reference to `this` in order to allow method chaining
6097
6858
  */
6098
6859
  setTitleLevel(
6099
6860
  /**
@@ -6109,6 +6870,8 @@ declare namespace sap {
6109
6870
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6110
6871
  *
6111
6872
  * Default value is `true`.
6873
+ *
6874
+ * @returns Reference to `this` in order to allow method chaining
6112
6875
  */
6113
6876
  setVisible(
6114
6877
  /**
@@ -6171,6 +6934,8 @@ declare namespace sap {
6171
6934
  * with the information contained in `oClassInfo`.
6172
6935
  *
6173
6936
  * `oClassInfo` might contain the same kind of information as described in {@link sap.uxap.ObjectPageSectionBase.extend}.
6937
+ *
6938
+ * @returns Created class / constructor function
6174
6939
  */
6175
6940
  static extend<T extends Record<string, unknown>>(
6176
6941
  /**
@@ -6189,10 +6954,14 @@ declare namespace sap {
6189
6954
  ): Function;
6190
6955
  /**
6191
6956
  * Returns a metadata object for class sap.uxap.ObjectPageSubSection.
6957
+ *
6958
+ * @returns Metadata object describing this class
6192
6959
  */
6193
6960
  static getMetadata(): sap.ui.core.ElementMetadata;
6194
6961
  /**
6195
6962
  * Adds some action to the aggregation {@link #getActions actions}.
6963
+ *
6964
+ * @returns Reference to `this` in order to allow method chaining
6196
6965
  */
6197
6966
  addAction(
6198
6967
  /**
@@ -6202,6 +6971,8 @@ declare namespace sap {
6202
6971
  ): this;
6203
6972
  /**
6204
6973
  * Adds some block to the aggregation {@link #getBlocks blocks}.
6974
+ *
6975
+ * @returns Reference to `this` in order to allow method chaining
6205
6976
  */
6206
6977
  addBlock(
6207
6978
  /**
@@ -6211,6 +6982,8 @@ declare namespace sap {
6211
6982
  ): this;
6212
6983
  /**
6213
6984
  * Adds some moreBlock to the aggregation {@link #getMoreBlocks moreBlocks}.
6985
+ *
6986
+ * @returns Reference to `this` in order to allow method chaining
6214
6987
  */
6215
6988
  addMoreBlock(
6216
6989
  /**
@@ -6220,14 +6993,20 @@ declare namespace sap {
6220
6993
  ): this;
6221
6994
  /**
6222
6995
  * Destroys all the actions in the aggregation {@link #getActions actions}.
6996
+ *
6997
+ * @returns Reference to `this` in order to allow method chaining
6223
6998
  */
6224
6999
  destroyActions(): this;
6225
7000
  /**
6226
7001
  * Destroys all the blocks in the aggregation {@link #getBlocks blocks}.
7002
+ *
7003
+ * @returns Reference to `this` in order to allow method chaining
6227
7004
  */
6228
7005
  destroyBlocks(): this;
6229
7006
  /**
6230
7007
  * Destroys all the moreBlocks in the aggregation {@link #getMoreBlocks moreBlocks}.
7008
+ *
7009
+ * @returns Reference to `this` in order to allow method chaining
6231
7010
  */
6232
7011
  destroyMoreBlocks(): this;
6233
7012
  /**
@@ -6275,6 +7054,8 @@ declare namespace sap {
6275
7054
  * if these aggregations use Object page blocks.
6276
7055
  *
6277
7056
  * Default value is `Collapsed`.
7057
+ *
7058
+ * @returns Value of property `mode`
6278
7059
  */
6279
7060
  getMode(): sap.uxap.ObjectPageSubSectionMode;
6280
7061
  /**
@@ -6296,6 +7077,8 @@ declare namespace sap {
6296
7077
  * for both the section and its subsection.
6297
7078
  *
6298
7079
  * Default value is `true`.
7080
+ *
7081
+ * @returns Value of property `showTitle`
6299
7082
  */
6300
7083
  getShowTitle(): boolean;
6301
7084
  /**
@@ -6304,11 +7087,15 @@ declare namespace sap {
6304
7087
  * Determines whether the Subsection title is displayed in upper case.
6305
7088
  *
6306
7089
  * Default value is `false`.
7090
+ *
7091
+ * @returns Value of property `titleUppercase`
6307
7092
  */
6308
7093
  getTitleUppercase(): boolean;
6309
7094
  /**
6310
7095
  * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getActions actions}. and returns
6311
7096
  * its index if found or -1 otherwise.
7097
+ *
7098
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
6312
7099
  */
6313
7100
  indexOfAction(
6314
7101
  /**
@@ -6319,6 +7106,8 @@ declare namespace sap {
6319
7106
  /**
6320
7107
  * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getBlocks blocks}. and returns
6321
7108
  * its index if found or -1 otherwise.
7109
+ *
7110
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
6322
7111
  */
6323
7112
  indexOfBlock(
6324
7113
  /**
@@ -6329,6 +7118,8 @@ declare namespace sap {
6329
7118
  /**
6330
7119
  * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getMoreBlocks moreBlocks}. and
6331
7120
  * returns its index if found or -1 otherwise.
7121
+ *
7122
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
6332
7123
  */
6333
7124
  indexOfMoreBlock(
6334
7125
  /**
@@ -6338,6 +7129,8 @@ declare namespace sap {
6338
7129
  ): int;
6339
7130
  /**
6340
7131
  * Inserts a action into the aggregation {@link #getActions actions}.
7132
+ *
7133
+ * @returns Reference to `this` in order to allow method chaining
6341
7134
  */
6342
7135
  insertAction(
6343
7136
  /**
@@ -6356,6 +7149,8 @@ declare namespace sap {
6356
7149
  *
6357
7150
  * **Note:** The `insertBlock` method is not supported by design. If used, it works as an `addBlock`, adding
6358
7151
  * a single block to the end of the `blocks` aggregation.
7152
+ *
7153
+ * @returns The `sap.uxap.ObjectPageSubSection` instance
6359
7154
  */
6360
7155
  insertBlock(
6361
7156
  /**
@@ -6372,6 +7167,8 @@ declare namespace sap {
6372
7167
  *
6373
7168
  * **Note:** The `insertMoreBlock` method is not supported by design. If used, it works as an `addMoreBlock`,
6374
7169
  * adding a single block to the end of the `moreBlocks` aggregation.
7170
+ *
7171
+ * @returns The `sap.uxap.ObjectPageSubSection` instance
6375
7172
  */
6376
7173
  insertMoreBlock(
6377
7174
  /**
@@ -6385,6 +7182,8 @@ declare namespace sap {
6385
7182
  ): this;
6386
7183
  /**
6387
7184
  * Removes a action from the aggregation {@link #getActions actions}.
7185
+ *
7186
+ * @returns The removed action or `null`
6388
7187
  */
6389
7188
  removeAction(
6390
7189
  /**
@@ -6396,22 +7195,30 @@ declare namespace sap {
6396
7195
  * Removes all the controls from the aggregation {@link #getActions actions}.
6397
7196
  *
6398
7197
  * Additionally, it unregisters them from the hosting UIArea.
7198
+ *
7199
+ * @returns An array of the removed elements (might be empty)
6399
7200
  */
6400
7201
  removeAllActions(): sap.ui.core.Control[];
6401
7202
  /**
6402
7203
  * Removes all the controls from the aggregation {@link #getBlocks blocks}.
6403
7204
  *
6404
7205
  * Additionally, it unregisters them from the hosting UIArea.
7206
+ *
7207
+ * @returns An array of the removed elements (might be empty)
6405
7208
  */
6406
7209
  removeAllBlocks(): sap.ui.core.Control[];
6407
7210
  /**
6408
7211
  * Removes all the controls from the aggregation {@link #getMoreBlocks moreBlocks}.
6409
7212
  *
6410
7213
  * Additionally, it unregisters them from the hosting UIArea.
7214
+ *
7215
+ * @returns An array of the removed elements (might be empty)
6411
7216
  */
6412
7217
  removeAllMoreBlocks(): sap.ui.core.Control[];
6413
7218
  /**
6414
7219
  * Removes a block from the aggregation {@link #getBlocks blocks}.
7220
+ *
7221
+ * @returns The removed block or `null`
6415
7222
  */
6416
7223
  removeBlock(
6417
7224
  /**
@@ -6421,6 +7228,8 @@ declare namespace sap {
6421
7228
  ): sap.ui.core.Control;
6422
7229
  /**
6423
7230
  * Removes a moreBlock from the aggregation {@link #getMoreBlocks moreBlocks}.
7231
+ *
7232
+ * @returns The removed moreBlock or `null`
6424
7233
  */
6425
7234
  removeMoreBlock(
6426
7235
  /**
@@ -6437,6 +7246,8 @@ declare namespace sap {
6437
7246
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6438
7247
  *
6439
7248
  * Default value is `Collapsed`.
7249
+ *
7250
+ * @returns Reference to `this` in order to allow method chaining
6440
7251
  */
6441
7252
  setMode(
6442
7253
  /**
@@ -6459,6 +7270,8 @@ declare namespace sap {
6459
7270
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6460
7271
  *
6461
7272
  * Default value is `true`.
7273
+ *
7274
+ * @returns Reference to `this` in order to allow method chaining
6462
7275
  */
6463
7276
  setShowTitle(
6464
7277
  /**
@@ -6474,6 +7287,8 @@ declare namespace sap {
6474
7287
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6475
7288
  *
6476
7289
  * Default value is `false`.
7290
+ *
7291
+ * @returns Reference to `this` in order to allow method chaining
6477
7292
  */
6478
7293
  setTitleUppercase(
6479
7294
  /**