@openui5/ts-types-esm 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 module "sap/tnt/library" {
4
4
  /**
@@ -104,6 +104,8 @@ declare module "sap/tnt/InfoLabel" {
104
104
  * contained in `oClassInfo`.
105
105
  *
106
106
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
107
+ *
108
+ * @returns Created class / constructor function
107
109
  */
108
110
  static extend<T extends Record<string, unknown>>(
109
111
  /**
@@ -122,6 +124,8 @@ declare module "sap/tnt/InfoLabel" {
122
124
  ): Function;
123
125
  /**
124
126
  * Returns a metadata object for class sap.tnt.InfoLabel.
127
+ *
128
+ * @returns Metadata object describing this class
125
129
  */
126
130
  static getMetadata(): ElementMetadata;
127
131
  /**
@@ -129,6 +133,8 @@ declare module "sap/tnt/InfoLabel" {
129
133
  *
130
134
  * See {@link sap.ui.base.ManagedObject#bindProperty ManagedObject.bindProperty} for a detailed description
131
135
  * of the possible properties of `oBindingInfo`
136
+ *
137
+ * @returns Reference to `this` in order to allow method chaining
132
138
  */
133
139
  bindText(
134
140
  /**
@@ -145,6 +151,8 @@ declare module "sap/tnt/InfoLabel" {
145
151
  * Fiori 3 theme. The default `colorScheme` is 7.
146
152
  *
147
153
  * Default value is `7`.
154
+ *
155
+ * @returns Value of property `colorScheme`
148
156
  */
149
157
  getColorScheme(): int;
150
158
  /**
@@ -154,6 +162,8 @@ declare module "sap/tnt/InfoLabel" {
154
162
  * fit other controls, for example non-editable `Forms`.
155
163
  *
156
164
  * Default value is `false`.
165
+ *
166
+ * @returns Value of property `displayOnly`
157
167
  */
158
168
  getDisplayOnly(): boolean;
159
169
  /**
@@ -165,6 +175,8 @@ declare module "sap/tnt/InfoLabel" {
165
175
  * the icon font.
166
176
  *
167
177
  * Default value is `empty string`.
178
+ *
179
+ * @returns Value of property `icon`
168
180
  */
169
181
  getIcon(): URI;
170
182
  /**
@@ -174,6 +186,8 @@ declare module "sap/tnt/InfoLabel" {
174
186
  * loose. It is recommended to use narrow (smaller) paddings for numeric texts.
175
187
  *
176
188
  * Default value is `Loose`.
189
+ *
190
+ * @returns Value of property `renderMode`
177
191
  */
178
192
  getRenderMode(): RenderMode | keyof typeof RenderMode;
179
193
  /**
@@ -182,6 +196,8 @@ declare module "sap/tnt/InfoLabel" {
182
196
  * Specifies the text inside the `InfoLabel` control.
183
197
  *
184
198
  * Default value is `empty string`.
199
+ *
200
+ * @returns Value of property `text`
185
201
  */
186
202
  getText(): string;
187
203
  /**
@@ -191,6 +207,8 @@ declare module "sap/tnt/InfoLabel" {
191
207
  * from its parent control.
192
208
  *
193
209
  * Default value is `Inherit`.
210
+ *
211
+ * @returns Value of property `textDirection`
194
212
  */
195
213
  getTextDirection(): TextDirection | keyof typeof TextDirection;
196
214
  /**
@@ -198,6 +216,8 @@ declare module "sap/tnt/InfoLabel" {
198
216
  *
199
217
  * Specifies the width of the `InfoLabel` control. By default, the `InfoLabel` control has the width of
200
218
  * the content. Set this property to restrict the width to a custom value.
219
+ *
220
+ * @returns Value of property `width`
201
221
  */
202
222
  getWidth(): CSSSize;
203
223
  /**
@@ -211,6 +231,8 @@ declare module "sap/tnt/InfoLabel" {
211
231
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
212
232
  *
213
233
  * Default value is `7`.
234
+ *
235
+ * @returns Reference to `this` in order to allow method chaining
214
236
  */
215
237
  setColorScheme(
216
238
  /**
@@ -227,6 +249,8 @@ declare module "sap/tnt/InfoLabel" {
227
249
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
228
250
  *
229
251
  * Default value is `false`.
252
+ *
253
+ * @returns Reference to `this` in order to allow method chaining
230
254
  */
231
255
  setDisplayOnly(
232
256
  /**
@@ -245,6 +269,8 @@ declare module "sap/tnt/InfoLabel" {
245
269
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
246
270
  *
247
271
  * Default value is `empty string`.
272
+ *
273
+ * @returns Reference to `this` in order to allow method chaining
248
274
  */
249
275
  setIcon(
250
276
  /**
@@ -261,6 +287,8 @@ declare module "sap/tnt/InfoLabel" {
261
287
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
262
288
  *
263
289
  * Default value is `Loose`.
290
+ *
291
+ * @returns Reference to `this` in order to allow method chaining
264
292
  */
265
293
  setRenderMode(
266
294
  /**
@@ -276,6 +304,8 @@ declare module "sap/tnt/InfoLabel" {
276
304
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
277
305
  *
278
306
  * Default value is `empty string`.
307
+ *
308
+ * @returns Reference to `this` in order to allow method chaining
279
309
  */
280
310
  setText(
281
311
  /**
@@ -292,6 +322,8 @@ declare module "sap/tnt/InfoLabel" {
292
322
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
293
323
  *
294
324
  * Default value is `Inherit`.
325
+ *
326
+ * @returns Reference to `this` in order to allow method chaining
295
327
  */
296
328
  setTextDirection(
297
329
  /**
@@ -306,6 +338,8 @@ declare module "sap/tnt/InfoLabel" {
306
338
  * the content. Set this property to restrict the width to a custom value.
307
339
  *
308
340
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
341
+ *
342
+ * @returns Reference to `this` in order to allow method chaining
309
343
  */
310
344
  setWidth(
311
345
  /**
@@ -315,6 +349,8 @@ declare module "sap/tnt/InfoLabel" {
315
349
  ): this;
316
350
  /**
317
351
  * Unbinds property {@link #getText text} from model data.
352
+ *
353
+ * @returns Reference to `this` in order to allow method chaining
318
354
  */
319
355
  unbindText(): this;
320
356
  }
@@ -329,7 +365,10 @@ declare module "sap/tnt/InfoLabel" {
329
365
  * Specifies the type of the `InfoLabel` paddings - loose or narrow. **Note:** By default the padding is
330
366
  * loose. It is recommended to use narrow (smaller) paddings for numeric texts.
331
367
  */
332
- renderMode?: (RenderMode | keyof typeof RenderMode) | PropertyBindingInfo;
368
+ renderMode?:
369
+ | (RenderMode | keyof typeof RenderMode)
370
+ | PropertyBindingInfo
371
+ | `{${string}}`;
333
372
 
334
373
  /**
335
374
  * Specifies the fill and text color of the control. Accepts a number between 1 and 10 as a value. You can
@@ -337,19 +376,19 @@ declare module "sap/tnt/InfoLabel" {
337
376
  * you can select them according to your own preferences. **Note:** ColorScheme 10 is available only in
338
377
  * Fiori 3 theme. The default `colorScheme` is 7.
339
378
  */
340
- colorScheme?: int | PropertyBindingInfo;
379
+ colorScheme?: int | PropertyBindingInfo | `{${string}}`;
341
380
 
342
381
  /**
343
382
  * Specifies the width of the `InfoLabel` control. By default, the `InfoLabel` control has the width of
344
383
  * the content. Set this property to restrict the width to a custom value.
345
384
  */
346
- width?: CSSSize | PropertyBindingInfo;
385
+ width?: CSSSize | PropertyBindingInfo | `{${string}}`;
347
386
 
348
387
  /**
349
388
  * Determines if the `InfoLabel` is in `displayOnly` mode. When set to `true` the control size adjusts to
350
389
  * fit other controls, for example non-editable `Forms`.
351
390
  */
352
- displayOnly?: boolean | PropertyBindingInfo;
391
+ displayOnly?: boolean | PropertyBindingInfo | `{${string}}`;
353
392
 
354
393
  /**
355
394
  * Available options for the text direction are LTR and RTL. By default the control inherits the text direction
@@ -357,7 +396,8 @@ declare module "sap/tnt/InfoLabel" {
357
396
  */
358
397
  textDirection?:
359
398
  | (TextDirection | keyof typeof TextDirection)
360
- | PropertyBindingInfo;
399
+ | PropertyBindingInfo
400
+ | `{${string}}`;
361
401
 
362
402
  /**
363
403
  * @SINCE 1.74
@@ -365,7 +405,7 @@ declare module "sap/tnt/InfoLabel" {
365
405
  * Defines the icon to be displayed as graphical element within the `InfoLabel`. It can be an icon from
366
406
  * the icon font.
367
407
  */
368
- icon?: URI | PropertyBindingInfo;
408
+ icon?: URI | PropertyBindingInfo | `{${string}}`;
369
409
  }
370
410
  }
371
411
 
@@ -430,6 +470,8 @@ declare module "sap/tnt/NavigationList" {
430
470
  * information contained in `oClassInfo`.
431
471
  *
432
472
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
473
+ *
474
+ * @returns Created class / constructor function
433
475
  */
434
476
  static extend<T extends Record<string, unknown>>(
435
477
  /**
@@ -448,10 +490,14 @@ declare module "sap/tnt/NavigationList" {
448
490
  ): Function;
449
491
  /**
450
492
  * Returns a metadata object for class sap.tnt.NavigationList.
493
+ *
494
+ * @returns Metadata object describing this class
451
495
  */
452
496
  static getMetadata(): ElementMetadata;
453
497
  /**
454
498
  * Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
499
+ *
500
+ * @returns Reference to `this` in order to allow method chaining
455
501
  */
456
502
  addAriaDescribedBy(
457
503
  /**
@@ -461,6 +507,8 @@ declare module "sap/tnt/NavigationList" {
461
507
  ): this;
462
508
  /**
463
509
  * Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
510
+ *
511
+ * @returns Reference to `this` in order to allow method chaining
464
512
  */
465
513
  addAriaLabelledBy(
466
514
  /**
@@ -470,6 +518,8 @@ declare module "sap/tnt/NavigationList" {
470
518
  ): this;
471
519
  /**
472
520
  * Adds some item to the aggregation {@link #getItems items}.
521
+ *
522
+ * @returns Reference to `this` in order to allow method chaining
473
523
  */
474
524
  addItem(
475
525
  /**
@@ -484,6 +534,8 @@ declare module "sap/tnt/NavigationList" {
484
534
  * otherwise it will be bound to this `sap.tnt.NavigationList` itself.
485
535
  *
486
536
  * Fired when an item is selected.
537
+ *
538
+ * @returns Reference to `this` in order to allow method chaining
487
539
  */
488
540
  attachItemSelect(
489
541
  /**
@@ -507,6 +559,8 @@ declare module "sap/tnt/NavigationList" {
507
559
  * otherwise it will be bound to this `sap.tnt.NavigationList` itself.
508
560
  *
509
561
  * Fired when an item is selected.
562
+ *
563
+ * @returns Reference to `this` in order to allow method chaining
510
564
  */
511
565
  attachItemSelect(
512
566
  /**
@@ -520,12 +574,16 @@ declare module "sap/tnt/NavigationList" {
520
574
  ): this;
521
575
  /**
522
576
  * Destroys all the items in the aggregation {@link #getItems items}.
577
+ *
578
+ * @returns Reference to `this` in order to allow method chaining
523
579
  */
524
580
  destroyItems(): this;
525
581
  /**
526
582
  * Detaches event handler `fnFunction` from the {@link #event:itemSelect itemSelect} event of this `sap.tnt.NavigationList`.
527
583
  *
528
584
  * The passed function and listener object must match the ones used for event registration.
585
+ *
586
+ * @returns Reference to `this` in order to allow method chaining
529
587
  */
530
588
  detachItemSelect(
531
589
  /**
@@ -539,6 +597,8 @@ declare module "sap/tnt/NavigationList" {
539
597
  ): this;
540
598
  /**
541
599
  * Fires event {@link #event:itemSelect itemSelect} to attached listeners.
600
+ *
601
+ * @returns Reference to `this` in order to allow method chaining
542
602
  */
543
603
  fireItemSelect(
544
604
  /**
@@ -567,6 +627,8 @@ declare module "sap/tnt/NavigationList" {
567
627
  * Specifies if the control is in expanded or collapsed mode.
568
628
  *
569
629
  * Default value is `true`.
630
+ *
631
+ * @returns Value of property `expanded`
570
632
  */
571
633
  getExpanded(): boolean;
572
634
  /**
@@ -577,6 +639,8 @@ declare module "sap/tnt/NavigationList" {
577
639
  getItems(): NavigationListItem[];
578
640
  /**
579
641
  * Gets the currently selected `NavigationListItem`.
642
+ *
643
+ * @returns The selected item or null if nothing is selected
580
644
  */
581
645
  getSelectedItem(): NavigationListItem | null;
582
646
  /**
@@ -585,17 +649,23 @@ declare module "sap/tnt/NavigationList" {
585
649
  * Gets current value of property {@link #getSelectedKey selectedKey}.
586
650
  *
587
651
  * Specifies the currently selected key.
652
+ *
653
+ * @returns Value of property `selectedKey`
588
654
  */
589
655
  getSelectedKey(): string;
590
656
  /**
591
657
  * Gets current value of property {@link #getWidth width}.
592
658
  *
593
659
  * Specifies the width of the control.
660
+ *
661
+ * @returns Value of property `width`
594
662
  */
595
663
  getWidth(): CSSSize;
596
664
  /**
597
665
  * Checks for the provided `sap.tnt.NavigationListItem` in the aggregation {@link #getItems items}. and
598
666
  * returns its index if found or -1 otherwise.
667
+ *
668
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
599
669
  */
600
670
  indexOfItem(
601
671
  /**
@@ -605,6 +675,8 @@ declare module "sap/tnt/NavigationList" {
605
675
  ): int;
606
676
  /**
607
677
  * Inserts a item into the aggregation {@link #getItems items}.
678
+ *
679
+ * @returns Reference to `this` in order to allow method chaining
608
680
  */
609
681
  insertItem(
610
682
  /**
@@ -620,20 +692,28 @@ declare module "sap/tnt/NavigationList" {
620
692
  ): this;
621
693
  /**
622
694
  * Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
695
+ *
696
+ * @returns An array of the removed elements (might be empty)
623
697
  */
624
698
  removeAllAriaDescribedBy(): ID[];
625
699
  /**
626
700
  * Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
701
+ *
702
+ * @returns An array of the removed elements (might be empty)
627
703
  */
628
704
  removeAllAriaLabelledBy(): ID[];
629
705
  /**
630
706
  * Removes all the controls from the aggregation {@link #getItems items}.
631
707
  *
632
708
  * Additionally, it unregisters them from the hosting UIArea.
709
+ *
710
+ * @returns An array of the removed elements (might be empty)
633
711
  */
634
712
  removeAllItems(): NavigationListItem[];
635
713
  /**
636
714
  * Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
715
+ *
716
+ * @returns The removed ariaDescribedBy or `null`
637
717
  */
638
718
  removeAriaDescribedBy(
639
719
  /**
@@ -643,6 +723,8 @@ declare module "sap/tnt/NavigationList" {
643
723
  ): ID;
644
724
  /**
645
725
  * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
726
+ *
727
+ * @returns The removed ariaLabelledBy or `null`
646
728
  */
647
729
  removeAriaLabelledBy(
648
730
  /**
@@ -652,6 +734,8 @@ declare module "sap/tnt/NavigationList" {
652
734
  ): ID;
653
735
  /**
654
736
  * Removes a item from the aggregation {@link #getItems items}.
737
+ *
738
+ * @returns The removed item or `null`
655
739
  */
656
740
  removeItem(
657
741
  /**
@@ -667,6 +751,8 @@ declare module "sap/tnt/NavigationList" {
667
751
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
668
752
  *
669
753
  * Default value is `true`.
754
+ *
755
+ * @returns Reference to `this` in order to allow method chaining
670
756
  */
671
757
  setExpanded(
672
758
  /**
@@ -676,6 +762,8 @@ declare module "sap/tnt/NavigationList" {
676
762
  ): this;
677
763
  /**
678
764
  * Sets the association for selectedItem. Set `null` to deselect.
765
+ *
766
+ * @returns The `selectedItem` association
679
767
  */
680
768
  setSelectedItem(
681
769
  /**
@@ -685,6 +773,8 @@ declare module "sap/tnt/NavigationList" {
685
773
  ): NavigationList | null;
686
774
  /**
687
775
  * Sets the selected item based on a key.
776
+ *
777
+ * @returns this pointer for chaining
688
778
  */
689
779
  setSelectedKey(
690
780
  /**
@@ -698,6 +788,8 @@ declare module "sap/tnt/NavigationList" {
698
788
  * Specifies the width of the control.
699
789
  *
700
790
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
791
+ *
792
+ * @returns Reference to `this` in order to allow method chaining
701
793
  */
702
794
  setWidth(
703
795
  /**
@@ -711,12 +803,12 @@ declare module "sap/tnt/NavigationList" {
711
803
  /**
712
804
  * Specifies the width of the control.
713
805
  */
714
- width?: CSSSize | PropertyBindingInfo;
806
+ width?: CSSSize | PropertyBindingInfo | `{${string}}`;
715
807
 
716
808
  /**
717
809
  * Specifies if the control is in expanded or collapsed mode.
718
810
  */
719
- expanded?: boolean | PropertyBindingInfo;
811
+ expanded?: boolean | PropertyBindingInfo | `{${string}}`;
720
812
 
721
813
  /**
722
814
  * @SINCE 1.62.0
@@ -728,7 +820,11 @@ declare module "sap/tnt/NavigationList" {
728
820
  /**
729
821
  * The items displayed in the list.
730
822
  */
731
- items?: NavigationListItem[] | NavigationListItem | AggregationBindingInfo;
823
+ items?:
824
+ | NavigationListItem[]
825
+ | NavigationListItem
826
+ | AggregationBindingInfo
827
+ | `{${string}}`;
732
828
 
733
829
  /**
734
830
  * Association to controls / IDs, which describe this control (see WAI-ARIA attribute aria-describedby).
@@ -811,6 +907,8 @@ declare module "sap/tnt/NavigationListItem" {
811
907
  * the information contained in `oClassInfo`.
812
908
  *
813
909
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Item.extend}.
910
+ *
911
+ * @returns Created class / constructor function
814
912
  */
815
913
  static extend<T extends Record<string, unknown>>(
816
914
  /**
@@ -829,10 +927,14 @@ declare module "sap/tnt/NavigationListItem" {
829
927
  ): Function;
830
928
  /**
831
929
  * Returns a metadata object for class sap.tnt.NavigationListItem.
930
+ *
931
+ * @returns Metadata object describing this class
832
932
  */
833
933
  static getMetadata(): ElementMetadata;
834
934
  /**
835
935
  * Adds some item to the aggregation {@link #getItems items}.
936
+ *
937
+ * @returns Reference to `this` in order to allow method chaining
836
938
  */
837
939
  addItem(
838
940
  /**
@@ -847,6 +949,8 @@ declare module "sap/tnt/NavigationListItem" {
847
949
  * otherwise it will be bound to this `sap.tnt.NavigationListItem` itself.
848
950
  *
849
951
  * Fired when this item is selected.
952
+ *
953
+ * @returns Reference to `this` in order to allow method chaining
850
954
  */
851
955
  attachSelect(
852
956
  /**
@@ -870,6 +974,8 @@ declare module "sap/tnt/NavigationListItem" {
870
974
  * otherwise it will be bound to this `sap.tnt.NavigationListItem` itself.
871
975
  *
872
976
  * Fired when this item is selected.
977
+ *
978
+ * @returns Reference to `this` in order to allow method chaining
873
979
  */
874
980
  attachSelect(
875
981
  /**
@@ -883,12 +989,16 @@ declare module "sap/tnt/NavigationListItem" {
883
989
  ): this;
884
990
  /**
885
991
  * Destroys all the items in the aggregation {@link #getItems items}.
992
+ *
993
+ * @returns Reference to `this` in order to allow method chaining
886
994
  */
887
995
  destroyItems(): this;
888
996
  /**
889
997
  * Detaches event handler `fnFunction` from the {@link #event:select select} event of this `sap.tnt.NavigationListItem`.
890
998
  *
891
999
  * The passed function and listener object must match the ones used for event registration.
1000
+ *
1001
+ * @returns Reference to `this` in order to allow method chaining
892
1002
  */
893
1003
  detachSelect(
894
1004
  /**
@@ -902,6 +1012,8 @@ declare module "sap/tnt/NavigationListItem" {
902
1012
  ): this;
903
1013
  /**
904
1014
  * Fires event {@link #event:select select} to attached listeners.
1015
+ *
1016
+ * @returns Reference to `this` in order to allow method chaining
905
1017
  */
906
1018
  fireSelect(
907
1019
  /**
@@ -920,6 +1032,8 @@ declare module "sap/tnt/NavigationListItem" {
920
1032
  * Specifies if the item is expanded.
921
1033
  *
922
1034
  * Default value is `true`.
1035
+ *
1036
+ * @returns Value of property `expanded`
923
1037
  */
924
1038
  getExpanded(): boolean;
925
1039
  /**
@@ -928,6 +1042,8 @@ declare module "sap/tnt/NavigationListItem" {
928
1042
  * Specifies if the item has an expander.
929
1043
  *
930
1044
  * Default value is `true`.
1045
+ *
1046
+ * @returns Value of property `hasExpander`
931
1047
  */
932
1048
  getHasExpander(): boolean;
933
1049
  /**
@@ -935,6 +1051,8 @@ declare module "sap/tnt/NavigationListItem" {
935
1051
  *
936
1052
  * Defines the link target URI. Supports standard hyperlink behavior. If a JavaScript action should be triggered,
937
1053
  * this should not be set, but instead an event handler for the `select` event should be registered.
1054
+ *
1055
+ * @returns Value of property `href`
938
1056
  */
939
1057
  getHref(): URI;
940
1058
  /**
@@ -943,6 +1061,8 @@ declare module "sap/tnt/NavigationListItem" {
943
1061
  * Specifies the icon for the item.
944
1062
  *
945
1063
  * Default value is `empty string`.
1064
+ *
1065
+ * @returns Value of property `icon`
946
1066
  */
947
1067
  getIcon(): URI;
948
1068
  /**
@@ -959,6 +1079,8 @@ declare module "sap/tnt/NavigationListItem" {
959
1079
  * Options are the standard values for window.open() supported by browsers: `_self`, `_top`, `_blank`, `_parent`,
960
1080
  * `_search`. Alternatively, a frame name can be entered. This property is only used when the `href` property
961
1081
  * is set.
1082
+ *
1083
+ * @returns Value of property `target`
962
1084
  */
963
1085
  getTarget(): string;
964
1086
  /**
@@ -969,11 +1091,15 @@ declare module "sap/tnt/NavigationListItem" {
969
1091
  * Specifies if the item should be shown.
970
1092
  *
971
1093
  * Default value is `true`.
1094
+ *
1095
+ * @returns Value of property `visible`
972
1096
  */
973
1097
  getVisible(): boolean;
974
1098
  /**
975
1099
  * Checks for the provided `sap.tnt.NavigationListItem` in the aggregation {@link #getItems items}. and
976
1100
  * returns its index if found or -1 otherwise.
1101
+ *
1102
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
977
1103
  */
978
1104
  indexOfItem(
979
1105
  /**
@@ -983,6 +1109,8 @@ declare module "sap/tnt/NavigationListItem" {
983
1109
  ): int;
984
1110
  /**
985
1111
  * Inserts a item into the aggregation {@link #getItems items}.
1112
+ *
1113
+ * @returns Reference to `this` in order to allow method chaining
986
1114
  */
987
1115
  insertItem(
988
1116
  /**
@@ -1000,10 +1128,14 @@ declare module "sap/tnt/NavigationListItem" {
1000
1128
  * Removes all the controls from the aggregation {@link #getItems items}.
1001
1129
  *
1002
1130
  * Additionally, it unregisters them from the hosting UIArea.
1131
+ *
1132
+ * @returns An array of the removed elements (might be empty)
1003
1133
  */
1004
1134
  removeAllItems(): NavigationListItem[];
1005
1135
  /**
1006
1136
  * Removes a item from the aggregation {@link #getItems items}.
1137
+ *
1138
+ * @returns The removed item or `null`
1007
1139
  */
1008
1140
  removeItem(
1009
1141
  /**
@@ -1019,6 +1151,8 @@ declare module "sap/tnt/NavigationListItem" {
1019
1151
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1020
1152
  *
1021
1153
  * Default value is `true`.
1154
+ *
1155
+ * @returns Reference to `this` in order to allow method chaining
1022
1156
  */
1023
1157
  setExpanded(
1024
1158
  /**
@@ -1034,6 +1168,8 @@ declare module "sap/tnt/NavigationListItem" {
1034
1168
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1035
1169
  *
1036
1170
  * Default value is `true`.
1171
+ *
1172
+ * @returns Reference to `this` in order to allow method chaining
1037
1173
  */
1038
1174
  setHasExpander(
1039
1175
  /**
@@ -1048,6 +1184,8 @@ declare module "sap/tnt/NavigationListItem" {
1048
1184
  * this should not be set, but instead an event handler for the `select` event should be registered.
1049
1185
  *
1050
1186
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1187
+ *
1188
+ * @returns Reference to `this` in order to allow method chaining
1051
1189
  */
1052
1190
  setHref(
1053
1191
  /**
@@ -1063,6 +1201,8 @@ declare module "sap/tnt/NavigationListItem" {
1063
1201
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1064
1202
  *
1065
1203
  * Default value is `empty string`.
1204
+ *
1205
+ * @returns Reference to `this` in order to allow method chaining
1066
1206
  */
1067
1207
  setIcon(
1068
1208
  /**
@@ -1080,6 +1220,8 @@ declare module "sap/tnt/NavigationListItem" {
1080
1220
  * is set.
1081
1221
  *
1082
1222
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1223
+ *
1224
+ * @returns Reference to `this` in order to allow method chaining
1083
1225
  */
1084
1226
  setTarget(
1085
1227
  /**
@@ -1097,6 +1239,8 @@ declare module "sap/tnt/NavigationListItem" {
1097
1239
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1098
1240
  *
1099
1241
  * Default value is `true`.
1242
+ *
1243
+ * @returns Reference to `this` in order to allow method chaining
1100
1244
  */
1101
1245
  setVisible(
1102
1246
  /**
@@ -1110,30 +1254,30 @@ declare module "sap/tnt/NavigationListItem" {
1110
1254
  /**
1111
1255
  * Specifies the icon for the item.
1112
1256
  */
1113
- icon?: URI | PropertyBindingInfo;
1257
+ icon?: URI | PropertyBindingInfo | `{${string}}`;
1114
1258
 
1115
1259
  /**
1116
1260
  * Specifies if the item is expanded.
1117
1261
  */
1118
- expanded?: boolean | PropertyBindingInfo;
1262
+ expanded?: boolean | PropertyBindingInfo | `{${string}}`;
1119
1263
 
1120
1264
  /**
1121
1265
  * Specifies if the item has an expander.
1122
1266
  */
1123
- hasExpander?: boolean | PropertyBindingInfo;
1267
+ hasExpander?: boolean | PropertyBindingInfo | `{${string}}`;
1124
1268
 
1125
1269
  /**
1126
1270
  * @SINCE 1.52
1127
1271
  *
1128
1272
  * Specifies if the item should be shown.
1129
1273
  */
1130
- visible?: boolean | PropertyBindingInfo;
1274
+ visible?: boolean | PropertyBindingInfo | `{${string}}`;
1131
1275
 
1132
1276
  /**
1133
1277
  * Defines the link target URI. Supports standard hyperlink behavior. If a JavaScript action should be triggered,
1134
1278
  * this should not be set, but instead an event handler for the `select` event should be registered.
1135
1279
  */
1136
- href?: URI | PropertyBindingInfo;
1280
+ href?: URI | PropertyBindingInfo | `{${string}}`;
1137
1281
 
1138
1282
  /**
1139
1283
  * Specifies the browsing context where the linked content will open.
@@ -1147,7 +1291,11 @@ declare module "sap/tnt/NavigationListItem" {
1147
1291
  /**
1148
1292
  * The sub items.
1149
1293
  */
1150
- items?: NavigationListItem[] | NavigationListItem | AggregationBindingInfo;
1294
+ items?:
1295
+ | NavigationListItem[]
1296
+ | NavigationListItem
1297
+ | AggregationBindingInfo
1298
+ | `{${string}}`;
1151
1299
 
1152
1300
  /**
1153
1301
  * Fired when this item is selected.
@@ -1226,6 +1374,8 @@ declare module "sap/tnt/SideNavigation" {
1226
1374
  * information contained in `oClassInfo`.
1227
1375
  *
1228
1376
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
1377
+ *
1378
+ * @returns Created class / constructor function
1229
1379
  */
1230
1380
  static extend<T extends Record<string, unknown>>(
1231
1381
  /**
@@ -1244,6 +1394,8 @@ declare module "sap/tnt/SideNavigation" {
1244
1394
  ): Function;
1245
1395
  /**
1246
1396
  * Returns a metadata object for class sap.tnt.SideNavigation.
1397
+ *
1398
+ * @returns Metadata object describing this class
1247
1399
  */
1248
1400
  static getMetadata(): ElementMetadata;
1249
1401
  /**
@@ -1253,6 +1405,8 @@ declare module "sap/tnt/SideNavigation" {
1253
1405
  * otherwise it will be bound to this `sap.tnt.SideNavigation` itself.
1254
1406
  *
1255
1407
  * Fired when an item is selected.
1408
+ *
1409
+ * @returns Reference to `this` in order to allow method chaining
1256
1410
  */
1257
1411
  attachItemSelect(
1258
1412
  /**
@@ -1276,6 +1430,8 @@ declare module "sap/tnt/SideNavigation" {
1276
1430
  * otherwise it will be bound to this `sap.tnt.SideNavigation` itself.
1277
1431
  *
1278
1432
  * Fired when an item is selected.
1433
+ *
1434
+ * @returns Reference to `this` in order to allow method chaining
1279
1435
  */
1280
1436
  attachItemSelect(
1281
1437
  /**
@@ -1292,6 +1448,8 @@ declare module "sap/tnt/SideNavigation" {
1292
1448
  *
1293
1449
  * See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a detailed description
1294
1450
  * of the possible properties of `oBindingInfo`.
1451
+ *
1452
+ * @returns Reference to `this` in order to allow method chaining
1295
1453
  */
1296
1454
  bindItem(
1297
1455
  /**
@@ -1301,20 +1459,28 @@ declare module "sap/tnt/SideNavigation" {
1301
1459
  ): this;
1302
1460
  /**
1303
1461
  * Destroys the fixedItem in the aggregation {@link #getFixedItem fixedItem}.
1462
+ *
1463
+ * @returns Reference to `this` in order to allow method chaining
1304
1464
  */
1305
1465
  destroyFixedItem(): this;
1306
1466
  /**
1307
1467
  * Destroys the footer in the aggregation {@link #getFooter footer}.
1468
+ *
1469
+ * @returns Reference to `this` in order to allow method chaining
1308
1470
  */
1309
1471
  destroyFooter(): this;
1310
1472
  /**
1311
1473
  * Destroys the item in the aggregation {@link #getItem item}.
1474
+ *
1475
+ * @returns Reference to `this` in order to allow method chaining
1312
1476
  */
1313
1477
  destroyItem(): this;
1314
1478
  /**
1315
1479
  * Detaches event handler `fnFunction` from the {@link #event:itemSelect itemSelect} event of this `sap.tnt.SideNavigation`.
1316
1480
  *
1317
1481
  * The passed function and listener object must match the ones used for event registration.
1482
+ *
1483
+ * @returns Reference to `this` in order to allow method chaining
1318
1484
  */
1319
1485
  detachItemSelect(
1320
1486
  /**
@@ -1328,6 +1494,8 @@ declare module "sap/tnt/SideNavigation" {
1328
1494
  ): this;
1329
1495
  /**
1330
1496
  * Fires event {@link #event:itemSelect itemSelect} to attached listeners.
1497
+ *
1498
+ * @returns Reference to `this` in order to allow method chaining
1331
1499
  */
1332
1500
  fireItemSelect(
1333
1501
  /**
@@ -1346,6 +1514,8 @@ declare module "sap/tnt/SideNavigation" {
1346
1514
  * Gets current value of property {@link #getAriaLabel ariaLabel}.
1347
1515
  *
1348
1516
  * Specifies an optional aria-label that can be used by the screen readers.
1517
+ *
1518
+ * @returns Value of property `ariaLabel`
1349
1519
  */
1350
1520
  getAriaLabel(): string;
1351
1521
  /**
@@ -1354,6 +1524,8 @@ declare module "sap/tnt/SideNavigation" {
1354
1524
  * Specifies if the control is expanded.
1355
1525
  *
1356
1526
  * Default value is `true`.
1527
+ *
1528
+ * @returns Value of property `expanded`
1357
1529
  */
1358
1530
  getExpanded(): boolean;
1359
1531
  /**
@@ -1387,6 +1559,8 @@ declare module "sap/tnt/SideNavigation" {
1387
1559
  * Gets current value of property {@link #getSelectedKey selectedKey}.
1388
1560
  *
1389
1561
  * Specifies the currently selected key.
1562
+ *
1563
+ * @returns Value of property `selectedKey`
1390
1564
  */
1391
1565
  getSelectedKey(): string;
1392
1566
  /**
@@ -1397,6 +1571,8 @@ declare module "sap/tnt/SideNavigation" {
1397
1571
  * Specifies an optional aria-label that can be used by the screen readers.
1398
1572
  *
1399
1573
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1574
+ *
1575
+ * @returns Reference to `this` in order to allow method chaining
1400
1576
  */
1401
1577
  setAriaLabel(
1402
1578
  /**
@@ -1406,6 +1582,8 @@ declare module "sap/tnt/SideNavigation" {
1406
1582
  ): this;
1407
1583
  /**
1408
1584
  * Sets if the control is in expanded or collapsed mode.
1585
+ *
1586
+ * @returns this SideNavigation reference for chaining.
1409
1587
  */
1410
1588
  setExpanded(
1411
1589
  /**
@@ -1415,6 +1593,8 @@ declare module "sap/tnt/SideNavigation" {
1415
1593
  ): this;
1416
1594
  /**
1417
1595
  * Sets the aggregated {@link #getFixedItem fixedItem}.
1596
+ *
1597
+ * @returns Reference to `this` in order to allow method chaining
1418
1598
  */
1419
1599
  setFixedItem(
1420
1600
  /**
@@ -1424,6 +1604,8 @@ declare module "sap/tnt/SideNavigation" {
1424
1604
  ): this;
1425
1605
  /**
1426
1606
  * Sets the aggregated {@link #getFooter footer}.
1607
+ *
1608
+ * @returns Reference to `this` in order to allow method chaining
1427
1609
  */
1428
1610
  setFooter(
1429
1611
  /**
@@ -1433,6 +1615,8 @@ declare module "sap/tnt/SideNavigation" {
1433
1615
  ): this;
1434
1616
  /**
1435
1617
  * Sets the aggregated {@link #getItem item}.
1618
+ *
1619
+ * @returns Reference to `this` in order to allow method chaining
1436
1620
  */
1437
1621
  setItem(
1438
1622
  /**
@@ -1442,6 +1626,8 @@ declare module "sap/tnt/SideNavigation" {
1442
1626
  ): this;
1443
1627
  /**
1444
1628
  * Sets the association for selectedItem
1629
+ *
1630
+ * @returns The `selectedItem` association
1445
1631
  */
1446
1632
  setSelectedItem(
1447
1633
  /**
@@ -1451,6 +1637,8 @@ declare module "sap/tnt/SideNavigation" {
1451
1637
  ): SideNavigation | null;
1452
1638
  /**
1453
1639
  * Sets the selected item based on a key.
1640
+ *
1641
+ * @returns this pointer for chaining
1454
1642
  */
1455
1643
  setSelectedKey(
1456
1644
  /**
@@ -1460,6 +1648,8 @@ declare module "sap/tnt/SideNavigation" {
1460
1648
  ): this;
1461
1649
  /**
1462
1650
  * Unbinds aggregation {@link #getItem item} from model data.
1651
+ *
1652
+ * @returns Reference to `this` in order to allow method chaining
1463
1653
  */
1464
1654
  unbindItem(): this;
1465
1655
  }
@@ -1468,7 +1658,7 @@ declare module "sap/tnt/SideNavigation" {
1468
1658
  /**
1469
1659
  * Specifies if the control is expanded.
1470
1660
  */
1471
- expanded?: boolean | PropertyBindingInfo;
1661
+ expanded?: boolean | PropertyBindingInfo | `{${string}}`;
1472
1662
 
1473
1663
  /**
1474
1664
  * @SINCE 1.62.0
@@ -1608,6 +1798,8 @@ declare module "sap/tnt/ToolHeader" {
1608
1798
  * contained in `oClassInfo`.
1609
1799
  *
1610
1800
  * `oClassInfo` might contain the same kind of information as described in {@link sap.m.OverflowToolbar.extend}.
1801
+ *
1802
+ * @returns Created class / constructor function
1611
1803
  */
1612
1804
  static extend<T extends Record<string, unknown>>(
1613
1805
  /**
@@ -1626,6 +1818,8 @@ declare module "sap/tnt/ToolHeader" {
1626
1818
  ): Function;
1627
1819
  /**
1628
1820
  * Returns a metadata object for class sap.tnt.ToolHeader.
1821
+ *
1822
+ * @returns Metadata object describing this class
1629
1823
  */
1630
1824
  static getMetadata(): ElementMetadata;
1631
1825
  }
@@ -1687,6 +1881,8 @@ declare module "sap/tnt/ToolHeaderUtilitySeparator" {
1687
1881
  * it with the information contained in `oClassInfo`.
1688
1882
  *
1689
1883
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
1884
+ *
1885
+ * @returns Created class / constructor function
1690
1886
  */
1691
1887
  static extend<T extends Record<string, unknown>>(
1692
1888
  /**
@@ -1705,6 +1901,8 @@ declare module "sap/tnt/ToolHeaderUtilitySeparator" {
1705
1901
  ): Function;
1706
1902
  /**
1707
1903
  * Returns a metadata object for class sap.tnt.ToolHeaderUtilitySeparator.
1904
+ *
1905
+ * @returns Metadata object describing this class
1708
1906
  */
1709
1907
  static getMetadata(): ElementMetadata;
1710
1908
  }
@@ -1773,6 +1971,8 @@ declare module "sap/tnt/ToolPage" {
1773
1971
  * contained in `oClassInfo`.
1774
1972
  *
1775
1973
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
1974
+ *
1975
+ * @returns Created class / constructor function
1776
1976
  */
1777
1977
  static extend<T extends Record<string, unknown>>(
1778
1978
  /**
@@ -1791,10 +1991,14 @@ declare module "sap/tnt/ToolPage" {
1791
1991
  ): Function;
1792
1992
  /**
1793
1993
  * Returns a metadata object for class sap.tnt.ToolPage.
1994
+ *
1995
+ * @returns Metadata object describing this class
1794
1996
  */
1795
1997
  static getMetadata(): ElementMetadata;
1796
1998
  /**
1797
1999
  * Adds some mainContent to the aggregation {@link #getMainContents mainContents}.
2000
+ *
2001
+ * @returns Reference to `this` in order to allow method chaining
1798
2002
  */
1799
2003
  addMainContent(
1800
2004
  /**
@@ -1804,20 +2008,28 @@ declare module "sap/tnt/ToolPage" {
1804
2008
  ): this;
1805
2009
  /**
1806
2010
  * Destroys the header in the aggregation {@link #getHeader header}.
2011
+ *
2012
+ * @returns Reference to `this` in order to allow method chaining
1807
2013
  */
1808
2014
  destroyHeader(): this;
1809
2015
  /**
1810
2016
  * Destroys all the mainContents in the aggregation {@link #getMainContents mainContents}.
2017
+ *
2018
+ * @returns Reference to `this` in order to allow method chaining
1811
2019
  */
1812
2020
  destroyMainContents(): this;
1813
2021
  /**
1814
2022
  * Destroys the sideContent in the aggregation {@link #getSideContent sideContent}.
2023
+ *
2024
+ * @returns Reference to `this` in order to allow method chaining
1815
2025
  */
1816
2026
  destroySideContent(): this;
1817
2027
  /**
1818
2028
  * @SINCE 1.93
1819
2029
  *
1820
2030
  * Destroys the subHeader in the aggregation {@link #getSubHeader subHeader}.
2031
+ *
2032
+ * @returns Reference to `this` in order to allow method chaining
1821
2033
  */
1822
2034
  destroySubHeader(): this;
1823
2035
  /**
@@ -1844,6 +2056,8 @@ declare module "sap/tnt/ToolPage" {
1844
2056
  * Indicates if the side menu is expanded. Overrides the `expanded` property of the `sideContent` aggregation.
1845
2057
  *
1846
2058
  * Default value is `true`.
2059
+ *
2060
+ * @returns Value of property `sideExpanded`
1847
2061
  */
1848
2062
  getSideExpanded(): boolean;
1849
2063
  /**
@@ -1857,6 +2071,8 @@ declare module "sap/tnt/ToolPage" {
1857
2071
  /**
1858
2072
  * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getMainContents mainContents}.
1859
2073
  * and returns its index if found or -1 otherwise.
2074
+ *
2075
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
1860
2076
  */
1861
2077
  indexOfMainContent(
1862
2078
  /**
@@ -1866,6 +2082,8 @@ declare module "sap/tnt/ToolPage" {
1866
2082
  ): int;
1867
2083
  /**
1868
2084
  * Inserts a mainContent into the aggregation {@link #getMainContents mainContents}.
2085
+ *
2086
+ * @returns Reference to `this` in order to allow method chaining
1869
2087
  */
1870
2088
  insertMainContent(
1871
2089
  /**
@@ -1883,10 +2101,14 @@ declare module "sap/tnt/ToolPage" {
1883
2101
  * Removes all the controls from the aggregation {@link #getMainContents mainContents}.
1884
2102
  *
1885
2103
  * Additionally, it unregisters them from the hosting UIArea.
2104
+ *
2105
+ * @returns An array of the removed elements (might be empty)
1886
2106
  */
1887
2107
  removeAllMainContents(): Control[];
1888
2108
  /**
1889
2109
  * Removes a mainContent from the aggregation {@link #getMainContents mainContents}.
2110
+ *
2111
+ * @returns The removed mainContent or `null`
1890
2112
  */
1891
2113
  removeMainContent(
1892
2114
  /**
@@ -1896,6 +2118,8 @@ declare module "sap/tnt/ToolPage" {
1896
2118
  ): Control;
1897
2119
  /**
1898
2120
  * Sets the aggregated {@link #getHeader header}.
2121
+ *
2122
+ * @returns Reference to `this` in order to allow method chaining
1899
2123
  */
1900
2124
  setHeader(
1901
2125
  /**
@@ -1905,6 +2129,8 @@ declare module "sap/tnt/ToolPage" {
1905
2129
  ): this;
1906
2130
  /**
1907
2131
  * Sets the aggregated {@link #getSideContent sideContent}.
2132
+ *
2133
+ * @returns Reference to `this` in order to allow method chaining
1908
2134
  */
1909
2135
  setSideContent(
1910
2136
  /**
@@ -1914,6 +2140,8 @@ declare module "sap/tnt/ToolPage" {
1914
2140
  ): this;
1915
2141
  /**
1916
2142
  * Sets the expand/collapse state of the SideContent.
2143
+ *
2144
+ * @returns Pointer to the control instance for chaining
1917
2145
  */
1918
2146
  setSideExpanded(
1919
2147
  /**
@@ -1925,6 +2153,8 @@ declare module "sap/tnt/ToolPage" {
1925
2153
  * @SINCE 1.93
1926
2154
  *
1927
2155
  * Sets the aggregated {@link #getSubHeader subHeader}.
2156
+ *
2157
+ * @returns Reference to `this` in order to allow method chaining
1928
2158
  */
1929
2159
  setSubHeader(
1930
2160
  /**
@@ -1934,6 +2164,8 @@ declare module "sap/tnt/ToolPage" {
1934
2164
  ): this;
1935
2165
  /**
1936
2166
  * Toggles the expand/collapse state of the SideContent.
2167
+ *
2168
+ * @returns Pointer to the control instance for chaining.
1937
2169
  */
1938
2170
  toggleSideContentMode(): this;
1939
2171
  }
@@ -1942,7 +2174,7 @@ declare module "sap/tnt/ToolPage" {
1942
2174
  /**
1943
2175
  * Indicates if the side menu is expanded. Overrides the `expanded` property of the `sideContent` aggregation.
1944
2176
  */
1945
- sideExpanded?: boolean | PropertyBindingInfo;
2177
+ sideExpanded?: boolean | PropertyBindingInfo | `{${string}}`;
1946
2178
 
1947
2179
  /**
1948
2180
  * The control to appear in the header area.
@@ -1964,7 +2196,7 @@ declare module "sap/tnt/ToolPage" {
1964
2196
  /**
1965
2197
  * The content section.
1966
2198
  */
1967
- mainContents?: Control[] | Control | AggregationBindingInfo;
2199
+ mainContents?: Control[] | Control | AggregationBindingInfo | `{${string}}`;
1968
2200
  }
1969
2201
  }
1970
2202