@openui5/ts-types 1.99.1 → 1.102.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.99.1
1
+ // For Library Version: 1.102.0
2
2
 
3
3
  declare namespace sap {
4
4
  /**
@@ -28,7 +28,8 @@ declare namespace sap {
28
28
  */
29
29
  renderMode?:
30
30
  | sap.tnt.RenderMode
31
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
31
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
32
+ | `{${string}}`;
32
33
 
33
34
  /**
34
35
  * Specifies the fill and text color of the control. Accepts a number between 1 and 10 as a value. You can
@@ -36,7 +37,10 @@ declare namespace sap {
36
37
  * you can select them according to your own preferences. **Note:** ColorScheme 10 is available only in
37
38
  * Fiori 3 theme. The default `colorScheme` is 7.
38
39
  */
39
- colorScheme?: int | sap.ui.base.ManagedObject.PropertyBindingInfo;
40
+ colorScheme?:
41
+ | int
42
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
43
+ | `{${string}}`;
40
44
 
41
45
  /**
42
46
  * Specifies the width of the `InfoLabel` control. By default, the `InfoLabel` control has the width of
@@ -44,13 +48,17 @@ declare namespace sap {
44
48
  */
45
49
  width?:
46
50
  | sap.ui.core.CSSSize
47
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
51
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
52
+ | `{${string}}`;
48
53
 
49
54
  /**
50
55
  * Determines if the `InfoLabel` is in `displayOnly` mode. When set to `true` the control size adjusts to
51
56
  * fit other controls, for example non-editable `Forms`.
52
57
  */
53
- displayOnly?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
58
+ displayOnly?:
59
+ | boolean
60
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
61
+ | `{${string}}`;
54
62
 
55
63
  /**
56
64
  * Available options for the text direction are LTR and RTL. By default the control inherits the text direction
@@ -58,7 +66,8 @@ declare namespace sap {
58
66
  */
59
67
  textDirection?:
60
68
  | sap.ui.core.TextDirection
61
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
69
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
70
+ | `{${string}}`;
62
71
 
63
72
  /**
64
73
  * @SINCE 1.74
@@ -66,7 +75,10 @@ declare namespace sap {
66
75
  * Defines the icon to be displayed as graphical element within the `InfoLabel`. It can be an icon from
67
76
  * the icon font.
68
77
  */
69
- icon?: sap.ui.core.URI | sap.ui.base.ManagedObject.PropertyBindingInfo;
78
+ icon?:
79
+ | sap.ui.core.URI
80
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
81
+ | `{${string}}`;
70
82
  }
71
83
 
72
84
  interface $NavigationListSettings extends sap.ui.core.$ControlSettings {
@@ -75,12 +87,16 @@ declare namespace sap {
75
87
  */
76
88
  width?:
77
89
  | sap.ui.core.CSSSize
78
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
90
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
91
+ | `{${string}}`;
79
92
 
80
93
  /**
81
94
  * Specifies if the control is in expanded or collapsed mode.
82
95
  */
83
- expanded?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
96
+ expanded?:
97
+ | boolean
98
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
99
+ | `{${string}}`;
84
100
 
85
101
  /**
86
102
  * @SINCE 1.62.0
@@ -95,7 +111,8 @@ declare namespace sap {
95
111
  items?:
96
112
  | sap.tnt.NavigationListItem[]
97
113
  | sap.tnt.NavigationListItem
98
- | sap.ui.base.ManagedObject.AggregationBindingInfo;
114
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
115
+ | `{${string}}`;
99
116
 
100
117
  /**
101
118
  * Association to controls / IDs, which describe this control (see WAI-ARIA attribute aria-describedby).
@@ -124,30 +141,45 @@ declare namespace sap {
124
141
  /**
125
142
  * Specifies the icon for the item.
126
143
  */
127
- icon?: sap.ui.core.URI | sap.ui.base.ManagedObject.PropertyBindingInfo;
144
+ icon?:
145
+ | sap.ui.core.URI
146
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
147
+ | `{${string}}`;
128
148
 
129
149
  /**
130
150
  * Specifies if the item is expanded.
131
151
  */
132
- expanded?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
152
+ expanded?:
153
+ | boolean
154
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
155
+ | `{${string}}`;
133
156
 
134
157
  /**
135
158
  * Specifies if the item has an expander.
136
159
  */
137
- hasExpander?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
160
+ hasExpander?:
161
+ | boolean
162
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
163
+ | `{${string}}`;
138
164
 
139
165
  /**
140
166
  * @SINCE 1.52
141
167
  *
142
168
  * Specifies if the item should be shown.
143
169
  */
144
- visible?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
170
+ visible?:
171
+ | boolean
172
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
173
+ | `{${string}}`;
145
174
 
146
175
  /**
147
176
  * Defines the link target URI. Supports standard hyperlink behavior. If a JavaScript action should be triggered,
148
177
  * this should not be set, but instead an event handler for the `select` event should be registered.
149
178
  */
150
- href?: sap.ui.core.URI | sap.ui.base.ManagedObject.PropertyBindingInfo;
179
+ href?:
180
+ | sap.ui.core.URI
181
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
182
+ | `{${string}}`;
151
183
 
152
184
  /**
153
185
  * Specifies the browsing context where the linked content will open.
@@ -164,7 +196,8 @@ declare namespace sap {
164
196
  items?:
165
197
  | sap.tnt.NavigationListItem[]
166
198
  | sap.tnt.NavigationListItem
167
- | sap.ui.base.ManagedObject.AggregationBindingInfo;
199
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
200
+ | `{${string}}`;
168
201
 
169
202
  /**
170
203
  * Fired when this item is selected.
@@ -176,7 +209,10 @@ declare namespace sap {
176
209
  /**
177
210
  * Specifies if the control is expanded.
178
211
  */
179
- expanded?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
212
+ expanded?:
213
+ | boolean
214
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
215
+ | `{${string}}`;
180
216
 
181
217
  /**
182
218
  * @SINCE 1.62.0
@@ -229,7 +265,10 @@ declare namespace sap {
229
265
  /**
230
266
  * Indicates if the side menu is expanded. Overrides the `expanded` property of the `sideContent` aggregation.
231
267
  */
232
- sideExpanded?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
268
+ sideExpanded?:
269
+ | boolean
270
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
271
+ | `{${string}}`;
233
272
 
234
273
  /**
235
274
  * The control to appear in the header area.
@@ -254,7 +293,8 @@ declare namespace sap {
254
293
  mainContents?:
255
294
  | sap.ui.core.Control[]
256
295
  | sap.ui.core.Control
257
- | sap.ui.base.ManagedObject.AggregationBindingInfo;
296
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
297
+ | `{${string}}`;
258
298
  }
259
299
 
260
300
  /**
@@ -322,6 +362,8 @@ declare namespace sap {
322
362
  * contained in `oClassInfo`.
323
363
  *
324
364
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
365
+ *
366
+ * @returns Created class / constructor function
325
367
  */
326
368
  static extend<T extends Record<string, unknown>>(
327
369
  /**
@@ -340,6 +382,8 @@ declare namespace sap {
340
382
  ): Function;
341
383
  /**
342
384
  * Returns a metadata object for class sap.tnt.InfoLabel.
385
+ *
386
+ * @returns Metadata object describing this class
343
387
  */
344
388
  static getMetadata(): sap.ui.core.ElementMetadata;
345
389
  /**
@@ -347,6 +391,8 @@ declare namespace sap {
347
391
  *
348
392
  * See {@link sap.ui.base.ManagedObject#bindProperty ManagedObject.bindProperty} for a detailed description
349
393
  * of the possible properties of `oBindingInfo`
394
+ *
395
+ * @returns Reference to `this` in order to allow method chaining
350
396
  */
351
397
  bindText(
352
398
  /**
@@ -363,6 +409,8 @@ declare namespace sap {
363
409
  * Fiori 3 theme. The default `colorScheme` is 7.
364
410
  *
365
411
  * Default value is `7`.
412
+ *
413
+ * @returns Value of property `colorScheme`
366
414
  */
367
415
  getColorScheme(): int;
368
416
  /**
@@ -372,6 +420,8 @@ declare namespace sap {
372
420
  * fit other controls, for example non-editable `Forms`.
373
421
  *
374
422
  * Default value is `false`.
423
+ *
424
+ * @returns Value of property `displayOnly`
375
425
  */
376
426
  getDisplayOnly(): boolean;
377
427
  /**
@@ -383,6 +433,8 @@ declare namespace sap {
383
433
  * the icon font.
384
434
  *
385
435
  * Default value is `empty string`.
436
+ *
437
+ * @returns Value of property `icon`
386
438
  */
387
439
  getIcon(): sap.ui.core.URI;
388
440
  /**
@@ -392,6 +444,8 @@ declare namespace sap {
392
444
  * loose. It is recommended to use narrow (smaller) paddings for numeric texts.
393
445
  *
394
446
  * Default value is `Loose`.
447
+ *
448
+ * @returns Value of property `renderMode`
395
449
  */
396
450
  getRenderMode(): sap.tnt.RenderMode;
397
451
  /**
@@ -400,6 +454,8 @@ declare namespace sap {
400
454
  * Specifies the text inside the `InfoLabel` control.
401
455
  *
402
456
  * Default value is `empty string`.
457
+ *
458
+ * @returns Value of property `text`
403
459
  */
404
460
  getText(): string;
405
461
  /**
@@ -409,6 +465,8 @@ declare namespace sap {
409
465
  * from its parent control.
410
466
  *
411
467
  * Default value is `Inherit`.
468
+ *
469
+ * @returns Value of property `textDirection`
412
470
  */
413
471
  getTextDirection(): sap.ui.core.TextDirection;
414
472
  /**
@@ -416,6 +474,8 @@ declare namespace sap {
416
474
  *
417
475
  * Specifies the width of the `InfoLabel` control. By default, the `InfoLabel` control has the width of
418
476
  * the content. Set this property to restrict the width to a custom value.
477
+ *
478
+ * @returns Value of property `width`
419
479
  */
420
480
  getWidth(): sap.ui.core.CSSSize;
421
481
  /**
@@ -429,6 +489,8 @@ declare namespace sap {
429
489
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
430
490
  *
431
491
  * Default value is `7`.
492
+ *
493
+ * @returns Reference to `this` in order to allow method chaining
432
494
  */
433
495
  setColorScheme(
434
496
  /**
@@ -445,6 +507,8 @@ declare namespace sap {
445
507
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
446
508
  *
447
509
  * Default value is `false`.
510
+ *
511
+ * @returns Reference to `this` in order to allow method chaining
448
512
  */
449
513
  setDisplayOnly(
450
514
  /**
@@ -463,6 +527,8 @@ declare namespace sap {
463
527
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
464
528
  *
465
529
  * Default value is `empty string`.
530
+ *
531
+ * @returns Reference to `this` in order to allow method chaining
466
532
  */
467
533
  setIcon(
468
534
  /**
@@ -479,6 +545,8 @@ declare namespace sap {
479
545
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
480
546
  *
481
547
  * Default value is `Loose`.
548
+ *
549
+ * @returns Reference to `this` in order to allow method chaining
482
550
  */
483
551
  setRenderMode(
484
552
  /**
@@ -494,6 +562,8 @@ declare namespace sap {
494
562
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
495
563
  *
496
564
  * Default value is `empty string`.
565
+ *
566
+ * @returns Reference to `this` in order to allow method chaining
497
567
  */
498
568
  setText(
499
569
  /**
@@ -510,6 +580,8 @@ declare namespace sap {
510
580
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
511
581
  *
512
582
  * Default value is `Inherit`.
583
+ *
584
+ * @returns Reference to `this` in order to allow method chaining
513
585
  */
514
586
  setTextDirection(
515
587
  /**
@@ -524,6 +596,8 @@ declare namespace sap {
524
596
  * the content. Set this property to restrict the width to a custom value.
525
597
  *
526
598
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
599
+ *
600
+ * @returns Reference to `this` in order to allow method chaining
527
601
  */
528
602
  setWidth(
529
603
  /**
@@ -533,6 +607,8 @@ declare namespace sap {
533
607
  ): this;
534
608
  /**
535
609
  * Unbinds property {@link #getText text} from model data.
610
+ *
611
+ * @returns Reference to `this` in order to allow method chaining
536
612
  */
537
613
  unbindText(): this;
538
614
  }
@@ -579,6 +655,8 @@ declare namespace sap {
579
655
  * information contained in `oClassInfo`.
580
656
  *
581
657
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
658
+ *
659
+ * @returns Created class / constructor function
582
660
  */
583
661
  static extend<T extends Record<string, unknown>>(
584
662
  /**
@@ -597,10 +675,14 @@ declare namespace sap {
597
675
  ): Function;
598
676
  /**
599
677
  * Returns a metadata object for class sap.tnt.NavigationList.
678
+ *
679
+ * @returns Metadata object describing this class
600
680
  */
601
681
  static getMetadata(): sap.ui.core.ElementMetadata;
602
682
  /**
603
683
  * Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
684
+ *
685
+ * @returns Reference to `this` in order to allow method chaining
604
686
  */
605
687
  addAriaDescribedBy(
606
688
  /**
@@ -610,6 +692,8 @@ declare namespace sap {
610
692
  ): this;
611
693
  /**
612
694
  * Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
695
+ *
696
+ * @returns Reference to `this` in order to allow method chaining
613
697
  */
614
698
  addAriaLabelledBy(
615
699
  /**
@@ -619,6 +703,8 @@ declare namespace sap {
619
703
  ): this;
620
704
  /**
621
705
  * Adds some item to the aggregation {@link #getItems items}.
706
+ *
707
+ * @returns Reference to `this` in order to allow method chaining
622
708
  */
623
709
  addItem(
624
710
  /**
@@ -633,6 +719,8 @@ declare namespace sap {
633
719
  * otherwise it will be bound to this `sap.tnt.NavigationList` itself.
634
720
  *
635
721
  * Fired when an item is selected.
722
+ *
723
+ * @returns Reference to `this` in order to allow method chaining
636
724
  */
637
725
  attachItemSelect(
638
726
  /**
@@ -656,6 +744,8 @@ declare namespace sap {
656
744
  * otherwise it will be bound to this `sap.tnt.NavigationList` itself.
657
745
  *
658
746
  * Fired when an item is selected.
747
+ *
748
+ * @returns Reference to `this` in order to allow method chaining
659
749
  */
660
750
  attachItemSelect(
661
751
  /**
@@ -669,12 +759,16 @@ declare namespace sap {
669
759
  ): this;
670
760
  /**
671
761
  * Destroys all the items in the aggregation {@link #getItems items}.
762
+ *
763
+ * @returns Reference to `this` in order to allow method chaining
672
764
  */
673
765
  destroyItems(): this;
674
766
  /**
675
767
  * Detaches event handler `fnFunction` from the {@link #event:itemSelect itemSelect} event of this `sap.tnt.NavigationList`.
676
768
  *
677
769
  * The passed function and listener object must match the ones used for event registration.
770
+ *
771
+ * @returns Reference to `this` in order to allow method chaining
678
772
  */
679
773
  detachItemSelect(
680
774
  /**
@@ -688,6 +782,8 @@ declare namespace sap {
688
782
  ): this;
689
783
  /**
690
784
  * Fires event {@link #event:itemSelect itemSelect} to attached listeners.
785
+ *
786
+ * @returns Reference to `this` in order to allow method chaining
691
787
  */
692
788
  fireItemSelect(
693
789
  /**
@@ -716,6 +812,8 @@ declare namespace sap {
716
812
  * Specifies if the control is in expanded or collapsed mode.
717
813
  *
718
814
  * Default value is `true`.
815
+ *
816
+ * @returns Value of property `expanded`
719
817
  */
720
818
  getExpanded(): boolean;
721
819
  /**
@@ -726,6 +824,8 @@ declare namespace sap {
726
824
  getItems(): sap.tnt.NavigationListItem[];
727
825
  /**
728
826
  * Gets the currently selected `NavigationListItem`.
827
+ *
828
+ * @returns The selected item or null if nothing is selected
729
829
  */
730
830
  getSelectedItem(): sap.tnt.NavigationListItem | null;
731
831
  /**
@@ -734,17 +834,23 @@ declare namespace sap {
734
834
  * Gets current value of property {@link #getSelectedKey selectedKey}.
735
835
  *
736
836
  * Specifies the currently selected key.
837
+ *
838
+ * @returns Value of property `selectedKey`
737
839
  */
738
840
  getSelectedKey(): string;
739
841
  /**
740
842
  * Gets current value of property {@link #getWidth width}.
741
843
  *
742
844
  * Specifies the width of the control.
845
+ *
846
+ * @returns Value of property `width`
743
847
  */
744
848
  getWidth(): sap.ui.core.CSSSize;
745
849
  /**
746
850
  * Checks for the provided `sap.tnt.NavigationListItem` in the aggregation {@link #getItems items}. and
747
851
  * returns its index if found or -1 otherwise.
852
+ *
853
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
748
854
  */
749
855
  indexOfItem(
750
856
  /**
@@ -754,6 +860,8 @@ declare namespace sap {
754
860
  ): int;
755
861
  /**
756
862
  * Inserts a item into the aggregation {@link #getItems items}.
863
+ *
864
+ * @returns Reference to `this` in order to allow method chaining
757
865
  */
758
866
  insertItem(
759
867
  /**
@@ -769,20 +877,28 @@ declare namespace sap {
769
877
  ): this;
770
878
  /**
771
879
  * Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
880
+ *
881
+ * @returns An array of the removed elements (might be empty)
772
882
  */
773
883
  removeAllAriaDescribedBy(): sap.ui.core.ID[];
774
884
  /**
775
885
  * Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
886
+ *
887
+ * @returns An array of the removed elements (might be empty)
776
888
  */
777
889
  removeAllAriaLabelledBy(): sap.ui.core.ID[];
778
890
  /**
779
891
  * Removes all the controls from the aggregation {@link #getItems items}.
780
892
  *
781
893
  * Additionally, it unregisters them from the hosting UIArea.
894
+ *
895
+ * @returns An array of the removed elements (might be empty)
782
896
  */
783
897
  removeAllItems(): sap.tnt.NavigationListItem[];
784
898
  /**
785
899
  * Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
900
+ *
901
+ * @returns The removed ariaDescribedBy or `null`
786
902
  */
787
903
  removeAriaDescribedBy(
788
904
  /**
@@ -792,6 +908,8 @@ declare namespace sap {
792
908
  ): sap.ui.core.ID;
793
909
  /**
794
910
  * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
911
+ *
912
+ * @returns The removed ariaLabelledBy or `null`
795
913
  */
796
914
  removeAriaLabelledBy(
797
915
  /**
@@ -801,6 +919,8 @@ declare namespace sap {
801
919
  ): sap.ui.core.ID;
802
920
  /**
803
921
  * Removes a item from the aggregation {@link #getItems items}.
922
+ *
923
+ * @returns The removed item or `null`
804
924
  */
805
925
  removeItem(
806
926
  /**
@@ -816,6 +936,8 @@ declare namespace sap {
816
936
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
817
937
  *
818
938
  * Default value is `true`.
939
+ *
940
+ * @returns Reference to `this` in order to allow method chaining
819
941
  */
820
942
  setExpanded(
821
943
  /**
@@ -825,6 +947,8 @@ declare namespace sap {
825
947
  ): this;
826
948
  /**
827
949
  * Sets the association for selectedItem. Set `null` to deselect.
950
+ *
951
+ * @returns The `selectedItem` association
828
952
  */
829
953
  setSelectedItem(
830
954
  /**
@@ -834,6 +958,8 @@ declare namespace sap {
834
958
  ): sap.tnt.NavigationList | null;
835
959
  /**
836
960
  * Sets the selected item based on a key.
961
+ *
962
+ * @returns this pointer for chaining
837
963
  */
838
964
  setSelectedKey(
839
965
  /**
@@ -847,6 +973,8 @@ declare namespace sap {
847
973
  * Specifies the width of the control.
848
974
  *
849
975
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
976
+ *
977
+ * @returns Reference to `this` in order to allow method chaining
850
978
  */
851
979
  setWidth(
852
980
  /**
@@ -898,6 +1026,8 @@ declare namespace sap {
898
1026
  * the information contained in `oClassInfo`.
899
1027
  *
900
1028
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Item.extend}.
1029
+ *
1030
+ * @returns Created class / constructor function
901
1031
  */
902
1032
  static extend<T extends Record<string, unknown>>(
903
1033
  /**
@@ -916,10 +1046,14 @@ declare namespace sap {
916
1046
  ): Function;
917
1047
  /**
918
1048
  * Returns a metadata object for class sap.tnt.NavigationListItem.
1049
+ *
1050
+ * @returns Metadata object describing this class
919
1051
  */
920
1052
  static getMetadata(): sap.ui.core.ElementMetadata;
921
1053
  /**
922
1054
  * Adds some item to the aggregation {@link #getItems items}.
1055
+ *
1056
+ * @returns Reference to `this` in order to allow method chaining
923
1057
  */
924
1058
  addItem(
925
1059
  /**
@@ -934,6 +1068,8 @@ declare namespace sap {
934
1068
  * otherwise it will be bound to this `sap.tnt.NavigationListItem` itself.
935
1069
  *
936
1070
  * Fired when this item is selected.
1071
+ *
1072
+ * @returns Reference to `this` in order to allow method chaining
937
1073
  */
938
1074
  attachSelect(
939
1075
  /**
@@ -957,6 +1093,8 @@ declare namespace sap {
957
1093
  * otherwise it will be bound to this `sap.tnt.NavigationListItem` itself.
958
1094
  *
959
1095
  * Fired when this item is selected.
1096
+ *
1097
+ * @returns Reference to `this` in order to allow method chaining
960
1098
  */
961
1099
  attachSelect(
962
1100
  /**
@@ -970,12 +1108,16 @@ declare namespace sap {
970
1108
  ): this;
971
1109
  /**
972
1110
  * Destroys all the items in the aggregation {@link #getItems items}.
1111
+ *
1112
+ * @returns Reference to `this` in order to allow method chaining
973
1113
  */
974
1114
  destroyItems(): this;
975
1115
  /**
976
1116
  * Detaches event handler `fnFunction` from the {@link #event:select select} event of this `sap.tnt.NavigationListItem`.
977
1117
  *
978
1118
  * The passed function and listener object must match the ones used for event registration.
1119
+ *
1120
+ * @returns Reference to `this` in order to allow method chaining
979
1121
  */
980
1122
  detachSelect(
981
1123
  /**
@@ -989,6 +1131,8 @@ declare namespace sap {
989
1131
  ): this;
990
1132
  /**
991
1133
  * Fires event {@link #event:select select} to attached listeners.
1134
+ *
1135
+ * @returns Reference to `this` in order to allow method chaining
992
1136
  */
993
1137
  fireSelect(
994
1138
  /**
@@ -1007,6 +1151,8 @@ declare namespace sap {
1007
1151
  * Specifies if the item is expanded.
1008
1152
  *
1009
1153
  * Default value is `true`.
1154
+ *
1155
+ * @returns Value of property `expanded`
1010
1156
  */
1011
1157
  getExpanded(): boolean;
1012
1158
  /**
@@ -1015,6 +1161,8 @@ declare namespace sap {
1015
1161
  * Specifies if the item has an expander.
1016
1162
  *
1017
1163
  * Default value is `true`.
1164
+ *
1165
+ * @returns Value of property `hasExpander`
1018
1166
  */
1019
1167
  getHasExpander(): boolean;
1020
1168
  /**
@@ -1022,6 +1170,8 @@ declare namespace sap {
1022
1170
  *
1023
1171
  * Defines the link target URI. Supports standard hyperlink behavior. If a JavaScript action should be triggered,
1024
1172
  * this should not be set, but instead an event handler for the `select` event should be registered.
1173
+ *
1174
+ * @returns Value of property `href`
1025
1175
  */
1026
1176
  getHref(): sap.ui.core.URI;
1027
1177
  /**
@@ -1030,6 +1180,8 @@ declare namespace sap {
1030
1180
  * Specifies the icon for the item.
1031
1181
  *
1032
1182
  * Default value is `empty string`.
1183
+ *
1184
+ * @returns Value of property `icon`
1033
1185
  */
1034
1186
  getIcon(): sap.ui.core.URI;
1035
1187
  /**
@@ -1046,6 +1198,8 @@ declare namespace sap {
1046
1198
  * Options are the standard values for window.open() supported by browsers: `_self`, `_top`, `_blank`, `_parent`,
1047
1199
  * `_search`. Alternatively, a frame name can be entered. This property is only used when the `href` property
1048
1200
  * is set.
1201
+ *
1202
+ * @returns Value of property `target`
1049
1203
  */
1050
1204
  getTarget(): string;
1051
1205
  /**
@@ -1056,11 +1210,15 @@ declare namespace sap {
1056
1210
  * Specifies if the item should be shown.
1057
1211
  *
1058
1212
  * Default value is `true`.
1213
+ *
1214
+ * @returns Value of property `visible`
1059
1215
  */
1060
1216
  getVisible(): boolean;
1061
1217
  /**
1062
1218
  * Checks for the provided `sap.tnt.NavigationListItem` in the aggregation {@link #getItems items}. and
1063
1219
  * returns its index if found or -1 otherwise.
1220
+ *
1221
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
1064
1222
  */
1065
1223
  indexOfItem(
1066
1224
  /**
@@ -1070,6 +1228,8 @@ declare namespace sap {
1070
1228
  ): int;
1071
1229
  /**
1072
1230
  * Inserts a item into the aggregation {@link #getItems items}.
1231
+ *
1232
+ * @returns Reference to `this` in order to allow method chaining
1073
1233
  */
1074
1234
  insertItem(
1075
1235
  /**
@@ -1087,10 +1247,14 @@ declare namespace sap {
1087
1247
  * Removes all the controls from the aggregation {@link #getItems items}.
1088
1248
  *
1089
1249
  * Additionally, it unregisters them from the hosting UIArea.
1250
+ *
1251
+ * @returns An array of the removed elements (might be empty)
1090
1252
  */
1091
1253
  removeAllItems(): sap.tnt.NavigationListItem[];
1092
1254
  /**
1093
1255
  * Removes a item from the aggregation {@link #getItems items}.
1256
+ *
1257
+ * @returns The removed item or `null`
1094
1258
  */
1095
1259
  removeItem(
1096
1260
  /**
@@ -1106,6 +1270,8 @@ declare namespace sap {
1106
1270
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1107
1271
  *
1108
1272
  * Default value is `true`.
1273
+ *
1274
+ * @returns Reference to `this` in order to allow method chaining
1109
1275
  */
1110
1276
  setExpanded(
1111
1277
  /**
@@ -1121,6 +1287,8 @@ declare namespace sap {
1121
1287
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1122
1288
  *
1123
1289
  * Default value is `true`.
1290
+ *
1291
+ * @returns Reference to `this` in order to allow method chaining
1124
1292
  */
1125
1293
  setHasExpander(
1126
1294
  /**
@@ -1135,6 +1303,8 @@ declare namespace sap {
1135
1303
  * this should not be set, but instead an event handler for the `select` event should be registered.
1136
1304
  *
1137
1305
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1306
+ *
1307
+ * @returns Reference to `this` in order to allow method chaining
1138
1308
  */
1139
1309
  setHref(
1140
1310
  /**
@@ -1150,6 +1320,8 @@ declare namespace sap {
1150
1320
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1151
1321
  *
1152
1322
  * Default value is `empty string`.
1323
+ *
1324
+ * @returns Reference to `this` in order to allow method chaining
1153
1325
  */
1154
1326
  setIcon(
1155
1327
  /**
@@ -1167,6 +1339,8 @@ declare namespace sap {
1167
1339
  * is set.
1168
1340
  *
1169
1341
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1342
+ *
1343
+ * @returns Reference to `this` in order to allow method chaining
1170
1344
  */
1171
1345
  setTarget(
1172
1346
  /**
@@ -1184,6 +1358,8 @@ declare namespace sap {
1184
1358
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1185
1359
  *
1186
1360
  * Default value is `true`.
1361
+ *
1362
+ * @returns Reference to `this` in order to allow method chaining
1187
1363
  */
1188
1364
  setVisible(
1189
1365
  /**
@@ -1242,6 +1418,8 @@ declare namespace sap {
1242
1418
  * information contained in `oClassInfo`.
1243
1419
  *
1244
1420
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
1421
+ *
1422
+ * @returns Created class / constructor function
1245
1423
  */
1246
1424
  static extend<T extends Record<string, unknown>>(
1247
1425
  /**
@@ -1260,6 +1438,8 @@ declare namespace sap {
1260
1438
  ): Function;
1261
1439
  /**
1262
1440
  * Returns a metadata object for class sap.tnt.SideNavigation.
1441
+ *
1442
+ * @returns Metadata object describing this class
1263
1443
  */
1264
1444
  static getMetadata(): sap.ui.core.ElementMetadata;
1265
1445
  /**
@@ -1269,6 +1449,8 @@ declare namespace sap {
1269
1449
  * otherwise it will be bound to this `sap.tnt.SideNavigation` itself.
1270
1450
  *
1271
1451
  * Fired when an item is selected.
1452
+ *
1453
+ * @returns Reference to `this` in order to allow method chaining
1272
1454
  */
1273
1455
  attachItemSelect(
1274
1456
  /**
@@ -1292,6 +1474,8 @@ declare namespace sap {
1292
1474
  * otherwise it will be bound to this `sap.tnt.SideNavigation` itself.
1293
1475
  *
1294
1476
  * Fired when an item is selected.
1477
+ *
1478
+ * @returns Reference to `this` in order to allow method chaining
1295
1479
  */
1296
1480
  attachItemSelect(
1297
1481
  /**
@@ -1308,6 +1492,8 @@ declare namespace sap {
1308
1492
  *
1309
1493
  * See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a detailed description
1310
1494
  * of the possible properties of `oBindingInfo`.
1495
+ *
1496
+ * @returns Reference to `this` in order to allow method chaining
1311
1497
  */
1312
1498
  bindItem(
1313
1499
  /**
@@ -1317,20 +1503,28 @@ declare namespace sap {
1317
1503
  ): this;
1318
1504
  /**
1319
1505
  * Destroys the fixedItem in the aggregation {@link #getFixedItem fixedItem}.
1506
+ *
1507
+ * @returns Reference to `this` in order to allow method chaining
1320
1508
  */
1321
1509
  destroyFixedItem(): this;
1322
1510
  /**
1323
1511
  * Destroys the footer in the aggregation {@link #getFooter footer}.
1512
+ *
1513
+ * @returns Reference to `this` in order to allow method chaining
1324
1514
  */
1325
1515
  destroyFooter(): this;
1326
1516
  /**
1327
1517
  * Destroys the item in the aggregation {@link #getItem item}.
1518
+ *
1519
+ * @returns Reference to `this` in order to allow method chaining
1328
1520
  */
1329
1521
  destroyItem(): this;
1330
1522
  /**
1331
1523
  * Detaches event handler `fnFunction` from the {@link #event:itemSelect itemSelect} event of this `sap.tnt.SideNavigation`.
1332
1524
  *
1333
1525
  * The passed function and listener object must match the ones used for event registration.
1526
+ *
1527
+ * @returns Reference to `this` in order to allow method chaining
1334
1528
  */
1335
1529
  detachItemSelect(
1336
1530
  /**
@@ -1344,6 +1538,8 @@ declare namespace sap {
1344
1538
  ): this;
1345
1539
  /**
1346
1540
  * Fires event {@link #event:itemSelect itemSelect} to attached listeners.
1541
+ *
1542
+ * @returns Reference to `this` in order to allow method chaining
1347
1543
  */
1348
1544
  fireItemSelect(
1349
1545
  /**
@@ -1362,6 +1558,8 @@ declare namespace sap {
1362
1558
  * Gets current value of property {@link #getAriaLabel ariaLabel}.
1363
1559
  *
1364
1560
  * Specifies an optional aria-label that can be used by the screen readers.
1561
+ *
1562
+ * @returns Value of property `ariaLabel`
1365
1563
  */
1366
1564
  getAriaLabel(): string;
1367
1565
  /**
@@ -1370,6 +1568,8 @@ declare namespace sap {
1370
1568
  * Specifies if the control is expanded.
1371
1569
  *
1372
1570
  * Default value is `true`.
1571
+ *
1572
+ * @returns Value of property `expanded`
1373
1573
  */
1374
1574
  getExpanded(): boolean;
1375
1575
  /**
@@ -1403,6 +1603,8 @@ declare namespace sap {
1403
1603
  * Gets current value of property {@link #getSelectedKey selectedKey}.
1404
1604
  *
1405
1605
  * Specifies the currently selected key.
1606
+ *
1607
+ * @returns Value of property `selectedKey`
1406
1608
  */
1407
1609
  getSelectedKey(): string;
1408
1610
  /**
@@ -1413,6 +1615,8 @@ declare namespace sap {
1413
1615
  * Specifies an optional aria-label that can be used by the screen readers.
1414
1616
  *
1415
1617
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1618
+ *
1619
+ * @returns Reference to `this` in order to allow method chaining
1416
1620
  */
1417
1621
  setAriaLabel(
1418
1622
  /**
@@ -1422,6 +1626,8 @@ declare namespace sap {
1422
1626
  ): this;
1423
1627
  /**
1424
1628
  * Sets if the control is in expanded or collapsed mode.
1629
+ *
1630
+ * @returns this SideNavigation reference for chaining.
1425
1631
  */
1426
1632
  setExpanded(
1427
1633
  /**
@@ -1431,6 +1637,8 @@ declare namespace sap {
1431
1637
  ): this;
1432
1638
  /**
1433
1639
  * Sets the aggregated {@link #getFixedItem fixedItem}.
1640
+ *
1641
+ * @returns Reference to `this` in order to allow method chaining
1434
1642
  */
1435
1643
  setFixedItem(
1436
1644
  /**
@@ -1440,6 +1648,8 @@ declare namespace sap {
1440
1648
  ): this;
1441
1649
  /**
1442
1650
  * Sets the aggregated {@link #getFooter footer}.
1651
+ *
1652
+ * @returns Reference to `this` in order to allow method chaining
1443
1653
  */
1444
1654
  setFooter(
1445
1655
  /**
@@ -1449,6 +1659,8 @@ declare namespace sap {
1449
1659
  ): this;
1450
1660
  /**
1451
1661
  * Sets the aggregated {@link #getItem item}.
1662
+ *
1663
+ * @returns Reference to `this` in order to allow method chaining
1452
1664
  */
1453
1665
  setItem(
1454
1666
  /**
@@ -1458,6 +1670,8 @@ declare namespace sap {
1458
1670
  ): this;
1459
1671
  /**
1460
1672
  * Sets the association for selectedItem
1673
+ *
1674
+ * @returns The `selectedItem` association
1461
1675
  */
1462
1676
  setSelectedItem(
1463
1677
  /**
@@ -1467,6 +1681,8 @@ declare namespace sap {
1467
1681
  ): sap.tnt.SideNavigation | null;
1468
1682
  /**
1469
1683
  * Sets the selected item based on a key.
1684
+ *
1685
+ * @returns this pointer for chaining
1470
1686
  */
1471
1687
  setSelectedKey(
1472
1688
  /**
@@ -1476,6 +1692,8 @@ declare namespace sap {
1476
1692
  ): this;
1477
1693
  /**
1478
1694
  * Unbinds aggregation {@link #getItem item} from model data.
1695
+ *
1696
+ * @returns Reference to `this` in order to allow method chaining
1479
1697
  */
1480
1698
  unbindItem(): this;
1481
1699
  }
@@ -1564,6 +1782,8 @@ declare namespace sap {
1564
1782
  * contained in `oClassInfo`.
1565
1783
  *
1566
1784
  * `oClassInfo` might contain the same kind of information as described in {@link sap.m.OverflowToolbar.extend}.
1785
+ *
1786
+ * @returns Created class / constructor function
1567
1787
  */
1568
1788
  static extend<T extends Record<string, unknown>>(
1569
1789
  /**
@@ -1582,6 +1802,8 @@ declare namespace sap {
1582
1802
  ): Function;
1583
1803
  /**
1584
1804
  * Returns a metadata object for class sap.tnt.ToolHeader.
1805
+ *
1806
+ * @returns Metadata object describing this class
1585
1807
  */
1586
1808
  static getMetadata(): sap.ui.core.ElementMetadata;
1587
1809
  }
@@ -1634,6 +1856,8 @@ declare namespace sap {
1634
1856
  * it with the information contained in `oClassInfo`.
1635
1857
  *
1636
1858
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
1859
+ *
1860
+ * @returns Created class / constructor function
1637
1861
  */
1638
1862
  static extend<T extends Record<string, unknown>>(
1639
1863
  /**
@@ -1652,6 +1876,8 @@ declare namespace sap {
1652
1876
  ): Function;
1653
1877
  /**
1654
1878
  * Returns a metadata object for class sap.tnt.ToolHeaderUtilitySeparator.
1879
+ *
1880
+ * @returns Metadata object describing this class
1655
1881
  */
1656
1882
  static getMetadata(): sap.ui.core.ElementMetadata;
1657
1883
  }
@@ -1701,6 +1927,8 @@ declare namespace sap {
1701
1927
  * contained in `oClassInfo`.
1702
1928
  *
1703
1929
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
1930
+ *
1931
+ * @returns Created class / constructor function
1704
1932
  */
1705
1933
  static extend<T extends Record<string, unknown>>(
1706
1934
  /**
@@ -1719,10 +1947,14 @@ declare namespace sap {
1719
1947
  ): Function;
1720
1948
  /**
1721
1949
  * Returns a metadata object for class sap.tnt.ToolPage.
1950
+ *
1951
+ * @returns Metadata object describing this class
1722
1952
  */
1723
1953
  static getMetadata(): sap.ui.core.ElementMetadata;
1724
1954
  /**
1725
1955
  * Adds some mainContent to the aggregation {@link #getMainContents mainContents}.
1956
+ *
1957
+ * @returns Reference to `this` in order to allow method chaining
1726
1958
  */
1727
1959
  addMainContent(
1728
1960
  /**
@@ -1732,20 +1964,28 @@ declare namespace sap {
1732
1964
  ): this;
1733
1965
  /**
1734
1966
  * Destroys the header in the aggregation {@link #getHeader header}.
1967
+ *
1968
+ * @returns Reference to `this` in order to allow method chaining
1735
1969
  */
1736
1970
  destroyHeader(): this;
1737
1971
  /**
1738
1972
  * Destroys all the mainContents in the aggregation {@link #getMainContents mainContents}.
1973
+ *
1974
+ * @returns Reference to `this` in order to allow method chaining
1739
1975
  */
1740
1976
  destroyMainContents(): this;
1741
1977
  /**
1742
1978
  * Destroys the sideContent in the aggregation {@link #getSideContent sideContent}.
1979
+ *
1980
+ * @returns Reference to `this` in order to allow method chaining
1743
1981
  */
1744
1982
  destroySideContent(): this;
1745
1983
  /**
1746
1984
  * @SINCE 1.93
1747
1985
  *
1748
1986
  * Destroys the subHeader in the aggregation {@link #getSubHeader subHeader}.
1987
+ *
1988
+ * @returns Reference to `this` in order to allow method chaining
1749
1989
  */
1750
1990
  destroySubHeader(): this;
1751
1991
  /**
@@ -1772,6 +2012,8 @@ declare namespace sap {
1772
2012
  * Indicates if the side menu is expanded. Overrides the `expanded` property of the `sideContent` aggregation.
1773
2013
  *
1774
2014
  * Default value is `true`.
2015
+ *
2016
+ * @returns Value of property `sideExpanded`
1775
2017
  */
1776
2018
  getSideExpanded(): boolean;
1777
2019
  /**
@@ -1785,6 +2027,8 @@ declare namespace sap {
1785
2027
  /**
1786
2028
  * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getMainContents mainContents}.
1787
2029
  * and returns its index if found or -1 otherwise.
2030
+ *
2031
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
1788
2032
  */
1789
2033
  indexOfMainContent(
1790
2034
  /**
@@ -1794,6 +2038,8 @@ declare namespace sap {
1794
2038
  ): int;
1795
2039
  /**
1796
2040
  * Inserts a mainContent into the aggregation {@link #getMainContents mainContents}.
2041
+ *
2042
+ * @returns Reference to `this` in order to allow method chaining
1797
2043
  */
1798
2044
  insertMainContent(
1799
2045
  /**
@@ -1811,10 +2057,14 @@ declare namespace sap {
1811
2057
  * Removes all the controls from the aggregation {@link #getMainContents mainContents}.
1812
2058
  *
1813
2059
  * Additionally, it unregisters them from the hosting UIArea.
2060
+ *
2061
+ * @returns An array of the removed elements (might be empty)
1814
2062
  */
1815
2063
  removeAllMainContents(): sap.ui.core.Control[];
1816
2064
  /**
1817
2065
  * Removes a mainContent from the aggregation {@link #getMainContents mainContents}.
2066
+ *
2067
+ * @returns The removed mainContent or `null`
1818
2068
  */
1819
2069
  removeMainContent(
1820
2070
  /**
@@ -1824,6 +2074,8 @@ declare namespace sap {
1824
2074
  ): sap.ui.core.Control;
1825
2075
  /**
1826
2076
  * Sets the aggregated {@link #getHeader header}.
2077
+ *
2078
+ * @returns Reference to `this` in order to allow method chaining
1827
2079
  */
1828
2080
  setHeader(
1829
2081
  /**
@@ -1833,6 +2085,8 @@ declare namespace sap {
1833
2085
  ): this;
1834
2086
  /**
1835
2087
  * Sets the aggregated {@link #getSideContent sideContent}.
2088
+ *
2089
+ * @returns Reference to `this` in order to allow method chaining
1836
2090
  */
1837
2091
  setSideContent(
1838
2092
  /**
@@ -1842,6 +2096,8 @@ declare namespace sap {
1842
2096
  ): this;
1843
2097
  /**
1844
2098
  * Sets the expand/collapse state of the SideContent.
2099
+ *
2100
+ * @returns Pointer to the control instance for chaining
1845
2101
  */
1846
2102
  setSideExpanded(
1847
2103
  /**
@@ -1853,6 +2109,8 @@ declare namespace sap {
1853
2109
  * @SINCE 1.93
1854
2110
  *
1855
2111
  * Sets the aggregated {@link #getSubHeader subHeader}.
2112
+ *
2113
+ * @returns Reference to `this` in order to allow method chaining
1856
2114
  */
1857
2115
  setSubHeader(
1858
2116
  /**
@@ -1862,6 +2120,8 @@ declare namespace sap {
1862
2120
  ): this;
1863
2121
  /**
1864
2122
  * Toggles the expand/collapse state of the SideContent.
2123
+ *
2124
+ * @returns Pointer to the control instance for chaining.
1865
2125
  */
1866
2126
  toggleSideContentMode(): this;
1867
2127
  }