@openui5/ts-types 1.120.7 → 1.121.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,16 +1,16 @@
1
- // For Library Version: 1.120.7
1
+ // For Library Version: 1.121.0
2
2
 
3
3
  declare namespace sap {
4
4
  /**
5
- * @since 1.36
6
- *
7
5
  * SAPUI5 library with controls specialized for administrative applications.
6
+ *
7
+ * @since 1.36
8
8
  */
9
9
  namespace tnt {
10
10
  /**
11
- * @since 1.68
12
- *
13
11
  * Interface for controls suitable for the `header` aggregation of {@link sap.tnt.ToolPage}.
12
+ *
13
+ * @since 1.68
14
14
  */
15
15
  interface IToolHeader {
16
16
  __implements__sap_tnt_IToolHeader: boolean;
@@ -71,10 +71,10 @@ declare namespace sap {
71
71
  | `{${string}}`;
72
72
 
73
73
  /**
74
- * @since 1.74
75
- *
76
74
  * Defines the icon to be displayed as graphical element within the `InfoLabel`. It can be an icon from
77
75
  * the icon font.
76
+ *
77
+ * @since 1.74
78
78
  */
79
79
  icon?:
80
80
  | sap.ui.core.URI
@@ -100,9 +100,9 @@ declare namespace sap {
100
100
  | `{${string}}`;
101
101
 
102
102
  /**
103
- * @since 1.62.0
104
- *
105
103
  * Specifies the currently selected key.
104
+ *
105
+ * @since 1.62.0
106
106
  */
107
107
  selectedKey?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
108
108
 
@@ -110,8 +110,8 @@ declare namespace sap {
110
110
  * The items displayed in the list.
111
111
  */
112
112
  items?:
113
- | sap.tnt.NavigationListItem[]
114
- | sap.tnt.NavigationListItem
113
+ | sap.tnt.NavigationListItemBase[]
114
+ | sap.tnt.NavigationListItemBase
115
115
  | sap.ui.base.ManagedObject.AggregationBindingInfo
116
116
  | `{${string}}`;
117
117
 
@@ -126,9 +126,9 @@ declare namespace sap {
126
126
  ariaLabelledBy?: Array<sap.ui.core.Control | string>;
127
127
 
128
128
  /**
129
- * @since 1.52.0
130
- *
131
129
  * The currently selected `NavigationListItem`.
130
+ *
131
+ * @since 1.52.0
132
132
  */
133
133
  selectedItem?: sap.tnt.NavigationListItem | string;
134
134
 
@@ -138,35 +138,34 @@ declare namespace sap {
138
138
  itemSelect?: (oEvent: NavigationList$ItemSelectEvent) => void;
139
139
  }
140
140
 
141
- interface $NavigationListItemSettings extends sap.ui.core.$ItemSettings {
142
- /**
143
- * Specifies the icon for the item.
144
- */
145
- icon?:
146
- | sap.ui.core.URI
147
- | sap.ui.base.ManagedObject.PropertyBindingInfo
148
- | `{${string}}`;
149
-
141
+ interface $NavigationListGroupSettings
142
+ extends sap.tnt.$NavigationListItemBaseSettings {
150
143
  /**
151
- * Specifies if the item is expanded.
144
+ * The sub items.
145
+ *
146
+ * @since 1.121.0
152
147
  */
153
- expanded?:
154
- | boolean
155
- | sap.ui.base.ManagedObject.PropertyBindingInfo
148
+ items?:
149
+ | sap.tnt.NavigationListItem[]
150
+ | sap.tnt.NavigationListItem
151
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
156
152
  | `{${string}}`;
153
+ }
157
154
 
155
+ interface $NavigationListItemSettings
156
+ extends sap.tnt.$NavigationListItemBaseSettings {
158
157
  /**
159
- * Specifies if the item has an expander.
158
+ * Specifies the icon for the item.
160
159
  */
161
- hasExpander?:
162
- | boolean
160
+ icon?:
161
+ | sap.ui.core.URI
163
162
  | sap.ui.base.ManagedObject.PropertyBindingInfo
164
163
  | `{${string}}`;
165
164
 
166
165
  /**
167
- * @since 1.52
168
- *
169
166
  * Specifies if the item should be shown.
167
+ *
168
+ * @since 1.52
170
169
  */
171
170
  visible?:
172
171
  | boolean
@@ -174,11 +173,12 @@ declare namespace sap {
174
173
  | `{${string}}`;
175
174
 
176
175
  /**
176
+ * Specifies if the item can be selected. It is recommended to set this property to `false` when the property
177
+ * `href` is also used.
178
+ *
177
179
  * @since 1.116
178
180
  * @experimental (since 1.116) - Disclaimer: this property is in a beta state - incompatible API changes
179
181
  * may be done before its official public release.
180
- *
181
- * Specifies if the item can be selected.
182
182
  */
183
183
  selectable?:
184
184
  | boolean
@@ -218,14 +218,45 @@ declare namespace sap {
218
218
  select?: (oEvent: NavigationListItem$SelectEvent) => void;
219
219
  }
220
220
 
221
- interface $SideNavigationSettings extends sap.ui.core.$ControlSettings {
221
+ interface $NavigationListItemBaseSettings
222
+ extends sap.ui.core.$ItemSettings {
222
223
  /**
223
- * @since 1.120
224
+ * Specifies if the item is expanded.
225
+ *
226
+ * @since 1.121
227
+ */
228
+ expanded?:
229
+ | boolean
230
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
231
+ | `{${string}}`;
232
+
233
+ /**
234
+ * Specifies if the item is allowed to be expanded or collapsed by the user.
235
+ */
236
+ hasExpander?:
237
+ | boolean
238
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
239
+ | `{${string}}`;
240
+
241
+ /**
242
+ * Specifies if the item should be shown.
224
243
  *
244
+ * @since 1.121
245
+ */
246
+ visible?:
247
+ | boolean
248
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
249
+ | `{${string}}`;
250
+ }
251
+
252
+ interface $SideNavigationSettings extends sap.ui.core.$ControlSettings {
253
+ /**
225
254
  * Specifies the width of the control.
226
255
  *
227
256
  * Depending on the theme, there is a minimum width set (16rem for Horizon theme). This property
228
257
  * can be used to set a bigger width.
258
+ *
259
+ * @since 1.120
229
260
  */
230
261
  width?:
231
262
  | sap.ui.core.CSSSize
@@ -241,16 +272,16 @@ declare namespace sap {
241
272
  | `{${string}}`;
242
273
 
243
274
  /**
244
- * @since 1.62.0
245
- *
246
275
  * Specifies the currently selected key.
276
+ *
277
+ * @since 1.62.0
247
278
  */
248
279
  selectedKey?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
249
280
 
250
281
  /**
251
- * @since 1.98
282
+ * Specifies an optional `aria-label` that can be used by the screen readers.
252
283
  *
253
- * Specifies an optional aria-label that can be used by the screen readers.
284
+ * @since 1.98
254
285
  */
255
286
  ariaLabel?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
256
287
 
@@ -265,16 +296,16 @@ declare namespace sap {
265
296
  fixedItem?: sap.tnt.NavigationList;
266
297
 
267
298
  /**
268
- * @deprecated (since 1.120) - Use the aggregation `fixedItem` instead.
269
- *
270
299
  * Defines the content inside the footer.
300
+ *
301
+ * @deprecated (since 1.120) - Use the aggregation `fixedItem` instead.
271
302
  */
272
303
  footer?: sap.tnt.NavigationList;
273
304
 
274
305
  /**
275
- * @since 1.52.0
276
- *
277
306
  * The selected `NavigationListItem`.
307
+ *
308
+ * @since 1.52.0
278
309
  */
279
310
  selectedItem?: sap.tnt.NavigationListItem | string;
280
311
 
@@ -299,9 +330,9 @@ declare namespace sap {
299
330
  | `{${string}}`;
300
331
 
301
332
  /**
302
- * @since 1.115
303
- *
304
333
  * Specifies the content background design.
334
+ *
335
+ * @since 1.115
305
336
  */
306
337
  contentBackgroundDesign?:
307
338
  | sap.m.PageBackgroundDesign
@@ -314,9 +345,9 @@ declare namespace sap {
314
345
  header?: sap.tnt.IToolHeader;
315
346
 
316
347
  /**
317
- * @since 1.93
318
- *
319
348
  * The control to appear in the subheader area.
349
+ *
350
+ * @since 1.93
320
351
  */
321
352
  subHeader?: sap.tnt.IToolHeader;
322
353
 
@@ -357,8 +388,6 @@ declare namespace sap {
357
388
  }
358
389
 
359
390
  /**
360
- * @since 1.54
361
- *
362
391
  * The `InfoLabel` is a small non-interactive control which contains text information and non-semantic color
363
392
  * chosen from a list of predefined color schemes. It serves the purpose to attract the user attention to
364
393
  * some piece of information (state, quantity, condition, etc.).
@@ -379,6 +408,8 @@ declare namespace sap {
379
408
  * - Colors are not semantic and have no visual representation in sap_belize_hcb, sap_belize_hcw, sap_fiori_3_hcb
380
409
  * and sap_fiori_3_hcw themes.
381
410
  * - The control shows plain text only, formatting is not visualized.
411
+ *
412
+ * @since 1.54
382
413
  */
383
414
  class InfoLabel
384
415
  extends sap.ui.core.Control
@@ -421,6 +452,7 @@ declare namespace sap {
421
452
  *
422
453
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
423
454
  *
455
+ *
424
456
  * @returns Created class / constructor function
425
457
  */
426
458
  static extend<T extends Record<string, unknown>>(
@@ -441,6 +473,7 @@ declare namespace sap {
441
473
  /**
442
474
  * Returns a metadata object for class sap.tnt.InfoLabel.
443
475
  *
476
+ *
444
477
  * @returns Metadata object describing this class
445
478
  */
446
479
  static getMetadata(): sap.ui.core.ElementMetadata;
@@ -450,6 +483,7 @@ declare namespace sap {
450
483
  * See {@link sap.ui.base.ManagedObject#bindProperty ManagedObject.bindProperty} for a detailed description
451
484
  * of the possible properties of `oBindingInfo`
452
485
  *
486
+ *
453
487
  * @returns Reference to `this` in order to allow method chaining
454
488
  */
455
489
  bindText(
@@ -468,6 +502,7 @@ declare namespace sap {
468
502
  *
469
503
  * Default value is `7`.
470
504
  *
505
+ *
471
506
  * @returns Value of property `colorScheme`
472
507
  */
473
508
  getColorScheme(): int;
@@ -479,12 +514,11 @@ declare namespace sap {
479
514
  *
480
515
  * Default value is `false`.
481
516
  *
517
+ *
482
518
  * @returns Value of property `displayOnly`
483
519
  */
484
520
  getDisplayOnly(): boolean;
485
521
  /**
486
- * @since 1.74
487
- *
488
522
  * Gets current value of property {@link #getIcon icon}.
489
523
  *
490
524
  * Defines the icon to be displayed as graphical element within the `InfoLabel`. It can be an icon from
@@ -492,6 +526,8 @@ declare namespace sap {
492
526
  *
493
527
  * Default value is `empty string`.
494
528
  *
529
+ * @since 1.74
530
+ *
495
531
  * @returns Value of property `icon`
496
532
  */
497
533
  getIcon(): sap.ui.core.URI;
@@ -504,6 +540,7 @@ declare namespace sap {
504
540
  *
505
541
  * Default value is `Loose`.
506
542
  *
543
+ *
507
544
  * @returns Value of property `renderMode`
508
545
  */
509
546
  getRenderMode(): sap.tnt.RenderMode;
@@ -514,6 +551,7 @@ declare namespace sap {
514
551
  *
515
552
  * Default value is `empty string`.
516
553
  *
554
+ *
517
555
  * @returns Value of property `text`
518
556
  */
519
557
  getText(): string;
@@ -525,6 +563,7 @@ declare namespace sap {
525
563
  *
526
564
  * Default value is `Inherit`.
527
565
  *
566
+ *
528
567
  * @returns Value of property `textDirection`
529
568
  */
530
569
  getTextDirection(): sap.ui.core.TextDirection;
@@ -534,6 +573,7 @@ declare namespace sap {
534
573
  * Specifies the width of the `InfoLabel` control. By default, the `InfoLabel` control has the width of
535
574
  * the content. Set this property to restrict the width to a custom value.
536
575
  *
576
+ *
537
577
  * @returns Value of property `width`
538
578
  */
539
579
  getWidth(): sap.ui.core.CSSSize;
@@ -549,6 +589,7 @@ declare namespace sap {
549
589
  *
550
590
  * Default value is `7`.
551
591
  *
592
+ *
552
593
  * @returns Reference to `this` in order to allow method chaining
553
594
  */
554
595
  setColorScheme(
@@ -567,6 +608,7 @@ declare namespace sap {
567
608
  *
568
609
  * Default value is `false`.
569
610
  *
611
+ *
570
612
  * @returns Reference to `this` in order to allow method chaining
571
613
  */
572
614
  setDisplayOnly(
@@ -576,8 +618,6 @@ declare namespace sap {
576
618
  bDisplayOnly?: boolean
577
619
  ): this;
578
620
  /**
579
- * @since 1.74
580
- *
581
621
  * Sets a new value for property {@link #getIcon icon}.
582
622
  *
583
623
  * Defines the icon to be displayed as graphical element within the `InfoLabel`. It can be an icon from
@@ -587,6 +627,8 @@ declare namespace sap {
587
627
  *
588
628
  * Default value is `empty string`.
589
629
  *
630
+ * @since 1.74
631
+ *
590
632
  * @returns Reference to `this` in order to allow method chaining
591
633
  */
592
634
  setIcon(
@@ -606,6 +648,7 @@ declare namespace sap {
606
648
  *
607
649
  * Default value is `Loose`.
608
650
  *
651
+ *
609
652
  * @returns Reference to `this` in order to allow method chaining
610
653
  */
611
654
  setRenderMode(
@@ -623,6 +666,7 @@ declare namespace sap {
623
666
  *
624
667
  * Default value is `empty string`.
625
668
  *
669
+ *
626
670
  * @returns Reference to `this` in order to allow method chaining
627
671
  */
628
672
  setText(
@@ -641,6 +685,7 @@ declare namespace sap {
641
685
  *
642
686
  * Default value is `Inherit`.
643
687
  *
688
+ *
644
689
  * @returns Reference to `this` in order to allow method chaining
645
690
  */
646
691
  setTextDirection(
@@ -657,6 +702,7 @@ declare namespace sap {
657
702
  *
658
703
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
659
704
  *
705
+ *
660
706
  * @returns Reference to `this` in order to allow method chaining
661
707
  */
662
708
  setWidth(
@@ -668,19 +714,20 @@ declare namespace sap {
668
714
  /**
669
715
  * Unbinds property {@link #getText text} from model data.
670
716
  *
717
+ *
671
718
  * @returns Reference to `this` in order to allow method chaining
672
719
  */
673
720
  unbindText(): this;
674
721
  }
675
722
  /**
676
- * @since 1.34
677
- *
678
723
  * The NavigationList control is an interactive control, which provides a choice of different items, ordered
679
724
  * as a list.
725
+ *
726
+ * @since 1.34
680
727
  */
681
728
  class NavigationList extends sap.ui.core.Control {
682
729
  /**
683
- * Constructor for a new NavigationList.
730
+ * Constructor for a new `NavigationList`.
684
731
  *
685
732
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
686
733
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
@@ -693,7 +740,7 @@ declare namespace sap {
693
740
  mSettings?: sap.tnt.$NavigationListSettings
694
741
  );
695
742
  /**
696
- * Constructor for a new NavigationList.
743
+ * Constructor for a new `NavigationList`.
697
744
  *
698
745
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
699
746
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
@@ -716,6 +763,7 @@ declare namespace sap {
716
763
  *
717
764
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
718
765
  *
766
+ *
719
767
  * @returns Created class / constructor function
720
768
  */
721
769
  static extend<T extends Record<string, unknown>>(
@@ -736,12 +784,14 @@ declare namespace sap {
736
784
  /**
737
785
  * Returns a metadata object for class sap.tnt.NavigationList.
738
786
  *
787
+ *
739
788
  * @returns Metadata object describing this class
740
789
  */
741
790
  static getMetadata(): sap.ui.core.ElementMetadata;
742
791
  /**
743
792
  * Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
744
793
  *
794
+ *
745
795
  * @returns Reference to `this` in order to allow method chaining
746
796
  */
747
797
  addAriaDescribedBy(
@@ -753,6 +803,7 @@ declare namespace sap {
753
803
  /**
754
804
  * Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
755
805
  *
806
+ *
756
807
  * @returns Reference to `this` in order to allow method chaining
757
808
  */
758
809
  addAriaLabelledBy(
@@ -764,13 +815,14 @@ declare namespace sap {
764
815
  /**
765
816
  * Adds some item to the aggregation {@link #getItems items}.
766
817
  *
818
+ *
767
819
  * @returns Reference to `this` in order to allow method chaining
768
820
  */
769
821
  addItem(
770
822
  /**
771
823
  * The item to add; if empty, nothing is inserted
772
824
  */
773
- oItem: sap.tnt.NavigationListItem
825
+ oItem: sap.tnt.NavigationListItemBase
774
826
  ): this;
775
827
  /**
776
828
  * Attaches event handler `fnFunction` to the {@link #event:itemSelect itemSelect} event of this `sap.tnt.NavigationList`.
@@ -780,6 +832,7 @@ declare namespace sap {
780
832
  *
781
833
  * Fired when an item is selected.
782
834
  *
835
+ *
783
836
  * @returns Reference to `this` in order to allow method chaining
784
837
  */
785
838
  attachItemSelect(
@@ -805,6 +858,7 @@ declare namespace sap {
805
858
  *
806
859
  * Fired when an item is selected.
807
860
  *
861
+ *
808
862
  * @returns Reference to `this` in order to allow method chaining
809
863
  */
810
864
  attachItemSelect(
@@ -820,6 +874,7 @@ declare namespace sap {
820
874
  /**
821
875
  * Destroys all the items in the aggregation {@link #getItems items}.
822
876
  *
877
+ *
823
878
  * @returns Reference to `this` in order to allow method chaining
824
879
  */
825
880
  destroyItems(): this;
@@ -828,6 +883,7 @@ declare namespace sap {
828
883
  *
829
884
  * The passed function and listener object must match the ones used for event registration.
830
885
  *
886
+ *
831
887
  * @returns Reference to `this` in order to allow method chaining
832
888
  */
833
889
  detachItemSelect(
@@ -841,10 +897,10 @@ declare namespace sap {
841
897
  oListener?: object
842
898
  ): this;
843
899
  /**
844
- * @ui5-protected Do not call from applications (only from related classes in the framework)
845
- *
846
900
  * Fires event {@link #event:itemSelect itemSelect} to attached listeners.
847
901
  *
902
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
903
+ *
848
904
  * @returns Reference to `this` in order to allow method chaining
849
905
  */
850
906
  fireItemSelect(
@@ -868,6 +924,7 @@ declare namespace sap {
868
924
  *
869
925
  * Default value is `true`.
870
926
  *
927
+ *
871
928
  * @returns Value of property `expanded`
872
929
  */
873
930
  getExpanded(): boolean;
@@ -876,20 +933,21 @@ declare namespace sap {
876
933
  *
877
934
  * The items displayed in the list.
878
935
  */
879
- getItems(): sap.tnt.NavigationListItem[];
936
+ getItems(): sap.tnt.NavigationListItemBase[];
880
937
  /**
881
938
  * Gets the currently selected `NavigationListItem`.
882
939
  *
940
+ *
883
941
  * @returns The selected item or `null` if nothing is selected
884
942
  */
885
943
  getSelectedItem(): sap.tnt.NavigationListItem | null;
886
944
  /**
887
- * @since 1.62.0
888
- *
889
945
  * Gets current value of property {@link #getSelectedKey selectedKey}.
890
946
  *
891
947
  * Specifies the currently selected key.
892
948
  *
949
+ * @since 1.62.0
950
+ *
893
951
  * @returns Value of property `selectedKey`
894
952
  */
895
953
  getSelectedKey(): string;
@@ -898,12 +956,14 @@ declare namespace sap {
898
956
  *
899
957
  * Specifies the width of the control.
900
958
  *
959
+ *
901
960
  * @returns Value of property `width`
902
961
  */
903
962
  getWidth(): sap.ui.core.CSSSize;
904
963
  /**
905
- * Checks for the provided `sap.tnt.NavigationListItem` in the aggregation {@link #getItems items}. and
906
- * returns its index if found or -1 otherwise.
964
+ * Checks for the provided `sap.tnt.NavigationListItemBase` in the aggregation {@link #getItems items}.
965
+ * and returns its index if found or -1 otherwise.
966
+ *
907
967
  *
908
968
  * @returns The index of the provided control in the aggregation if found, or -1 otherwise
909
969
  */
@@ -911,18 +971,19 @@ declare namespace sap {
911
971
  /**
912
972
  * The item whose index is looked for
913
973
  */
914
- oItem: sap.tnt.NavigationListItem
974
+ oItem: sap.tnt.NavigationListItemBase
915
975
  ): int;
916
976
  /**
917
977
  * Inserts a item into the aggregation {@link #getItems items}.
918
978
  *
979
+ *
919
980
  * @returns Reference to `this` in order to allow method chaining
920
981
  */
921
982
  insertItem(
922
983
  /**
923
984
  * The item to insert; if empty, nothing is inserted
924
985
  */
925
- oItem: sap.tnt.NavigationListItem,
986
+ oItem: sap.tnt.NavigationListItemBase,
926
987
  /**
927
988
  * The `0`-based index the item should be inserted at; for a negative value of `iIndex`, the item is inserted
928
989
  * at position 0; for a value greater than the current size of the aggregation, the item is inserted at
@@ -933,12 +994,14 @@ declare namespace sap {
933
994
  /**
934
995
  * Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
935
996
  *
997
+ *
936
998
  * @returns An array of the removed elements (might be empty)
937
999
  */
938
1000
  removeAllAriaDescribedBy(): sap.ui.core.ID[];
939
1001
  /**
940
1002
  * Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
941
1003
  *
1004
+ *
942
1005
  * @returns An array of the removed elements (might be empty)
943
1006
  */
944
1007
  removeAllAriaLabelledBy(): sap.ui.core.ID[];
@@ -947,12 +1010,14 @@ declare namespace sap {
947
1010
  *
948
1011
  * Additionally, it unregisters them from the hosting UIArea.
949
1012
  *
1013
+ *
950
1014
  * @returns An array of the removed elements (might be empty)
951
1015
  */
952
- removeAllItems(): sap.tnt.NavigationListItem[];
1016
+ removeAllItems(): sap.tnt.NavigationListItemBase[];
953
1017
  /**
954
1018
  * Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
955
1019
  *
1020
+ *
956
1021
  * @returns The removed ariaDescribedBy or `null`
957
1022
  */
958
1023
  removeAriaDescribedBy(
@@ -964,6 +1029,7 @@ declare namespace sap {
964
1029
  /**
965
1030
  * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
966
1031
  *
1032
+ *
967
1033
  * @returns The removed ariaLabelledBy or `null`
968
1034
  */
969
1035
  removeAriaLabelledBy(
@@ -975,14 +1041,15 @@ declare namespace sap {
975
1041
  /**
976
1042
  * Removes a item from the aggregation {@link #getItems items}.
977
1043
  *
1044
+ *
978
1045
  * @returns The removed item or `null`
979
1046
  */
980
1047
  removeItem(
981
1048
  /**
982
1049
  * The item to remove or its index or id
983
1050
  */
984
- vItem: int | string | sap.tnt.NavigationListItem
985
- ): sap.tnt.NavigationListItem | null;
1051
+ vItem: int | string | sap.tnt.NavigationListItemBase
1052
+ ): sap.tnt.NavigationListItemBase | null;
986
1053
  /**
987
1054
  * Sets a new value for property {@link #getExpanded expanded}.
988
1055
  *
@@ -992,6 +1059,7 @@ declare namespace sap {
992
1059
  *
993
1060
  * Default value is `true`.
994
1061
  *
1062
+ *
995
1063
  * @returns Reference to `this` in order to allow method chaining
996
1064
  */
997
1065
  setExpanded(
@@ -1003,24 +1071,26 @@ declare namespace sap {
1003
1071
  /**
1004
1072
  * Sets the association for selectedItem. Set `null` to deselect.
1005
1073
  *
1074
+ *
1006
1075
  * @returns The `selectedItem` association
1007
1076
  */
1008
1077
  setSelectedItem(
1009
1078
  /**
1010
1079
  * The control to be set as selected
1011
1080
  */
1012
- selectedItem: string | sap.tnt.NavigationListItem
1081
+ oItem: sap.ui.core.ID | sap.tnt.NavigationListItem
1013
1082
  ): sap.tnt.NavigationList | null;
1014
1083
  /**
1015
1084
  * Sets the selected item based on a key.
1016
1085
  *
1086
+ *
1017
1087
  * @returns this pointer for chaining
1018
1088
  */
1019
1089
  setSelectedKey(
1020
1090
  /**
1021
1091
  * The key of the item to be selected
1022
1092
  */
1023
- selectedKey: string
1093
+ sSelectedKey: string
1024
1094
  ): this;
1025
1095
  /**
1026
1096
  * Sets a new value for property {@link #getWidth width}.
@@ -1029,6 +1099,7 @@ declare namespace sap {
1029
1099
  *
1030
1100
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1031
1101
  *
1102
+ *
1032
1103
  * @returns Reference to `this` in order to allow method chaining
1033
1104
  */
1034
1105
  setWidth(
@@ -1039,14 +1110,13 @@ declare namespace sap {
1039
1110
  ): this;
1040
1111
  }
1041
1112
  /**
1042
- * @since 1.34
1113
+ * The NavigationListGroup represents a group of navigation actions, which can be selected by the user.
1043
1114
  *
1044
- * The NavigationListItem control represents an action, which can be selected by the user. It can provide
1045
- * sub items.
1115
+ * @since 1.121
1046
1116
  */
1047
- class NavigationListItem extends sap.ui.core.Item {
1117
+ class NavigationListGroup extends sap.tnt.NavigationListItemBase {
1048
1118
  /**
1049
- * Constructor for a new NavigationListItem.
1119
+ * Constructor for a new NavigationListGroup.
1050
1120
  *
1051
1121
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1052
1122
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
@@ -1056,10 +1126,10 @@ declare namespace sap {
1056
1126
  /**
1057
1127
  * Initial settings for the new control
1058
1128
  */
1059
- mSettings?: sap.tnt.$NavigationListItemSettings
1129
+ mSettings?: sap.tnt.$NavigationListGroupSettings
1060
1130
  );
1061
1131
  /**
1062
- * Constructor for a new NavigationListItem.
1132
+ * Constructor for a new NavigationListGroup.
1063
1133
  *
1064
1134
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1065
1135
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
@@ -1073,14 +1143,15 @@ declare namespace sap {
1073
1143
  /**
1074
1144
  * Initial settings for the new control
1075
1145
  */
1076
- mSettings?: sap.tnt.$NavigationListItemSettings
1146
+ mSettings?: sap.tnt.$NavigationListGroupSettings
1077
1147
  );
1078
1148
 
1079
1149
  /**
1080
- * Creates a new subclass of class sap.tnt.NavigationListItem with name `sClassName` and enriches it with
1150
+ * Creates a new subclass of class sap.tnt.NavigationListGroup with name `sClassName` and enriches it with
1081
1151
  * the information contained in `oClassInfo`.
1082
1152
  *
1083
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Item.extend}.
1153
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.tnt.NavigationListItemBase.extend}.
1154
+ *
1084
1155
  *
1085
1156
  * @returns Created class / constructor function
1086
1157
  */
@@ -1092,7 +1163,7 @@ declare namespace sap {
1092
1163
  /**
1093
1164
  * Object literal with information about the class
1094
1165
  */
1095
- oClassInfo?: sap.ClassInfo<T, sap.tnt.NavigationListItem>,
1166
+ oClassInfo?: sap.ClassInfo<T, sap.tnt.NavigationListGroup>,
1096
1167
  /**
1097
1168
  * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1098
1169
  * used by this class
@@ -1100,7 +1171,8 @@ declare namespace sap {
1100
1171
  FNMetaImpl?: Function
1101
1172
  ): Function;
1102
1173
  /**
1103
- * Returns a metadata object for class sap.tnt.NavigationListItem.
1174
+ * Returns a metadata object for class sap.tnt.NavigationListGroup.
1175
+ *
1104
1176
  *
1105
1177
  * @returns Metadata object describing this class
1106
1178
  */
@@ -1108,6 +1180,8 @@ declare namespace sap {
1108
1180
  /**
1109
1181
  * Adds some item to the aggregation {@link #getItems items}.
1110
1182
  *
1183
+ * @since 1.121.0
1184
+ *
1111
1185
  * @returns Reference to `this` in order to allow method chaining
1112
1186
  */
1113
1187
  addItem(
@@ -1117,120 +1191,251 @@ declare namespace sap {
1117
1191
  oItem: sap.tnt.NavigationListItem
1118
1192
  ): this;
1119
1193
  /**
1120
- * Attaches event handler `fnFunction` to the {@link #event:select select} event of this `sap.tnt.NavigationListItem`.
1121
- *
1122
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1123
- * otherwise it will be bound to this `sap.tnt.NavigationListItem` itself.
1194
+ * Destroys all the items in the aggregation {@link #getItems items}.
1124
1195
  *
1125
- * Fired when this item is selected.
1196
+ * @since 1.121.0
1126
1197
  *
1127
1198
  * @returns Reference to `this` in order to allow method chaining
1128
1199
  */
1129
- attachSelect(
1130
- /**
1131
- * An application-specific payload object that will be passed to the event handler along with the event
1132
- * object when firing the event
1133
- */
1134
- oData: object,
1135
- /**
1136
- * The function to be called when the event occurs
1137
- */
1138
- fnFunction: (p1: NavigationListItem$SelectEvent) => void,
1200
+ destroyItems(): this;
1201
+ /**
1202
+ * Gets content of aggregation {@link #getItems items}.
1203
+ *
1204
+ * The sub items.
1205
+ *
1206
+ * @since 1.121.0
1207
+ */
1208
+ getItems(): sap.tnt.NavigationListItem[];
1209
+ /**
1210
+ * Checks for the provided `sap.tnt.NavigationListItem` in the aggregation {@link #getItems items}. and
1211
+ * returns its index if found or -1 otherwise.
1212
+ *
1213
+ * @since 1.121.0
1214
+ *
1215
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
1216
+ */
1217
+ indexOfItem(
1139
1218
  /**
1140
- * Context object to call the event handler with. Defaults to this `sap.tnt.NavigationListItem` itself
1219
+ * The item whose index is looked for
1141
1220
  */
1142
- oListener?: object
1143
- ): this;
1221
+ oItem: sap.tnt.NavigationListItem
1222
+ ): int;
1144
1223
  /**
1145
- * Attaches event handler `fnFunction` to the {@link #event:select select} event of this `sap.tnt.NavigationListItem`.
1146
- *
1147
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1148
- * otherwise it will be bound to this `sap.tnt.NavigationListItem` itself.
1224
+ * Inserts a item into the aggregation {@link #getItems items}.
1149
1225
  *
1150
- * Fired when this item is selected.
1226
+ * @since 1.121.0
1151
1227
  *
1152
1228
  * @returns Reference to `this` in order to allow method chaining
1153
1229
  */
1154
- attachSelect(
1230
+ insertItem(
1155
1231
  /**
1156
- * The function to be called when the event occurs
1232
+ * The item to insert; if empty, nothing is inserted
1157
1233
  */
1158
- fnFunction: (p1: NavigationListItem$SelectEvent) => void,
1234
+ oItem: sap.tnt.NavigationListItem,
1159
1235
  /**
1160
- * Context object to call the event handler with. Defaults to this `sap.tnt.NavigationListItem` itself
1236
+ * The `0`-based index the item should be inserted at; for a negative value of `iIndex`, the item is inserted
1237
+ * at position 0; for a value greater than the current size of the aggregation, the item is inserted at
1238
+ * the last position
1161
1239
  */
1162
- oListener?: object
1240
+ iIndex: int
1163
1241
  ): this;
1164
1242
  /**
1165
- * Destroys all the items in the aggregation {@link #getItems items}.
1243
+ * Removes all the controls from the aggregation {@link #getItems items}.
1166
1244
  *
1167
- * @returns Reference to `this` in order to allow method chaining
1168
- */
1169
- destroyItems(): this;
1170
- /**
1171
- * Detaches event handler `fnFunction` from the {@link #event:select select} event of this `sap.tnt.NavigationListItem`.
1245
+ * Additionally, it unregisters them from the hosting UIArea.
1246
+ *
1247
+ * @since 1.121.0
1248
+ *
1249
+ * @returns An array of the removed elements (might be empty)
1250
+ */
1251
+ removeAllItems(): sap.tnt.NavigationListItem[];
1252
+ /**
1253
+ * Removes a item from the aggregation {@link #getItems items}.
1254
+ *
1255
+ * @since 1.121.0
1256
+ *
1257
+ * @returns The removed item or `null`
1258
+ */
1259
+ removeItem(
1260
+ /**
1261
+ * The item to remove or its index or id
1262
+ */
1263
+ vItem: int | string | sap.tnt.NavigationListItem
1264
+ ): sap.tnt.NavigationListItem | null;
1265
+ }
1266
+ /**
1267
+ * The NavigationListItem represents a navigation action, which can be selected by the user. It can provide
1268
+ * sub items.
1269
+ *
1270
+ * @since 1.34
1271
+ */
1272
+ class NavigationListItem extends sap.tnt.NavigationListItemBase {
1273
+ /**
1274
+ * Constructor for a new NavigationListItem.
1275
+ *
1276
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1277
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1278
+ * of the syntax of the settings object.
1279
+ */
1280
+ constructor(
1281
+ /**
1282
+ * Initial settings for the new control
1283
+ */
1284
+ mSettings?: sap.tnt.$NavigationListItemSettings
1285
+ );
1286
+ /**
1287
+ * Constructor for a new NavigationListItem.
1288
+ *
1289
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1290
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1291
+ * of the syntax of the settings object.
1292
+ */
1293
+ constructor(
1294
+ /**
1295
+ * ID for the new control, generated automatically if no ID is given
1296
+ */
1297
+ sId?: string,
1298
+ /**
1299
+ * Initial settings for the new control
1300
+ */
1301
+ mSettings?: sap.tnt.$NavigationListItemSettings
1302
+ );
1303
+
1304
+ /**
1305
+ * Creates a new subclass of class sap.tnt.NavigationListItem with name `sClassName` and enriches it with
1306
+ * the information contained in `oClassInfo`.
1307
+ *
1308
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.tnt.NavigationListItemBase.extend}.
1309
+ *
1310
+ *
1311
+ * @returns Created class / constructor function
1312
+ */
1313
+ static extend<T extends Record<string, unknown>>(
1314
+ /**
1315
+ * Name of the class being created
1316
+ */
1317
+ sClassName: string,
1318
+ /**
1319
+ * Object literal with information about the class
1320
+ */
1321
+ oClassInfo?: sap.ClassInfo<T, sap.tnt.NavigationListItem>,
1322
+ /**
1323
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1324
+ * used by this class
1325
+ */
1326
+ FNMetaImpl?: Function
1327
+ ): Function;
1328
+ /**
1329
+ * Returns a metadata object for class sap.tnt.NavigationListItem.
1330
+ *
1331
+ *
1332
+ * @returns Metadata object describing this class
1333
+ */
1334
+ static getMetadata(): sap.ui.core.ElementMetadata;
1335
+ /**
1336
+ * Adds some item to the aggregation {@link #getItems items}.
1172
1337
  *
1173
- * The passed function and listener object must match the ones used for event registration.
1174
1338
  *
1175
1339
  * @returns Reference to `this` in order to allow method chaining
1176
1340
  */
1177
- detachSelect(
1341
+ addItem(
1178
1342
  /**
1179
- * The function to be called, when the event occurs
1343
+ * The item to add; if empty, nothing is inserted
1344
+ */
1345
+ oItem: sap.tnt.NavigationListItem
1346
+ ): this;
1347
+ /**
1348
+ * Attaches event handler `fnFunction` to the {@link #event:select select} event of this `sap.tnt.NavigationListItem`.
1349
+ *
1350
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1351
+ * otherwise it will be bound to this `sap.tnt.NavigationListItem` itself.
1352
+ *
1353
+ * Fired when this item is selected.
1354
+ *
1355
+ *
1356
+ * @returns Reference to `this` in order to allow method chaining
1357
+ */
1358
+ attachSelect(
1359
+ /**
1360
+ * An application-specific payload object that will be passed to the event handler along with the event
1361
+ * object when firing the event
1362
+ */
1363
+ oData: object,
1364
+ /**
1365
+ * The function to be called when the event occurs
1180
1366
  */
1181
1367
  fnFunction: (p1: NavigationListItem$SelectEvent) => void,
1182
1368
  /**
1183
- * Context object on which the given function had to be called
1369
+ * Context object to call the event handler with. Defaults to this `sap.tnt.NavigationListItem` itself
1184
1370
  */
1185
1371
  oListener?: object
1186
1372
  ): this;
1187
1373
  /**
1188
- * @ui5-protected Do not call from applications (only from related classes in the framework)
1374
+ * Attaches event handler `fnFunction` to the {@link #event:select select} event of this `sap.tnt.NavigationListItem`.
1375
+ *
1376
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1377
+ * otherwise it will be bound to this `sap.tnt.NavigationListItem` itself.
1378
+ *
1379
+ * Fired when this item is selected.
1189
1380
  *
1190
- * Fires event {@link #event:select select} to attached listeners.
1191
1381
  *
1192
1382
  * @returns Reference to `this` in order to allow method chaining
1193
1383
  */
1194
- fireSelect(
1384
+ attachSelect(
1195
1385
  /**
1196
- * Parameters to pass along with the event
1386
+ * The function to be called when the event occurs
1197
1387
  */
1198
- mParameters?: sap.tnt.NavigationListItem$SelectEventParameters
1388
+ fnFunction: (p1: NavigationListItem$SelectEvent) => void,
1389
+ /**
1390
+ * Context object to call the event handler with. Defaults to this `sap.tnt.NavigationListItem` itself
1391
+ */
1392
+ oListener?: object
1199
1393
  ): this;
1200
1394
  /**
1201
- * Gets current value of property {@link #getExpanded expanded}.
1202
- *
1203
- * Specifies if the item is expanded.
1395
+ * Destroys all the items in the aggregation {@link #getItems items}.
1204
1396
  *
1205
- * Default value is `true`.
1206
1397
  *
1207
- * @returns Value of property `expanded`
1398
+ * @returns Reference to `this` in order to allow method chaining
1208
1399
  */
1209
- getExpanded(): boolean;
1400
+ destroyItems(): this;
1210
1401
  /**
1211
- * @ui5-protected Do not call from applications (only from related classes in the framework)
1402
+ * Detaches event handler `fnFunction` from the {@link #event:select select} event of this `sap.tnt.NavigationListItem`.
1212
1403
  *
1213
- * Returns the DOM Element that should get the focus.
1404
+ * The passed function and listener object must match the ones used for event registration.
1214
1405
  *
1215
- * @returns Returns the DOM Element that should get the focus
1406
+ *
1407
+ * @returns Reference to `this` in order to allow method chaining
1216
1408
  */
1217
- getFocusDomRef(): Element;
1409
+ detachSelect(
1410
+ /**
1411
+ * The function to be called, when the event occurs
1412
+ */
1413
+ fnFunction: (p1: NavigationListItem$SelectEvent) => void,
1414
+ /**
1415
+ * Context object on which the given function had to be called
1416
+ */
1417
+ oListener?: object
1418
+ ): this;
1218
1419
  /**
1219
- * Gets current value of property {@link #getHasExpander hasExpander}.
1220
- *
1221
- * Specifies if the item has an expander.
1420
+ * Fires event {@link #event:select select} to attached listeners.
1222
1421
  *
1223
- * Default value is `true`.
1422
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1224
1423
  *
1225
- * @returns Value of property `hasExpander`
1424
+ * @returns Reference to `this` in order to allow method chaining
1226
1425
  */
1227
- getHasExpander(): boolean;
1426
+ fireSelect(
1427
+ /**
1428
+ * Parameters to pass along with the event
1429
+ */
1430
+ mParameters?: sap.tnt.NavigationListItem$SelectEventParameters
1431
+ ): this;
1228
1432
  /**
1229
1433
  * Gets current value of property {@link #getHref href}.
1230
1434
  *
1231
1435
  * Defines the link target URI. Supports standard hyperlink behavior. If a JavaScript action should be triggered,
1232
1436
  * this should not be set, but instead an event handler for the `select` event should be registered.
1233
1437
  *
1438
+ *
1234
1439
  * @returns Value of property `href`
1235
1440
  */
1236
1441
  getHref(): sap.ui.core.URI;
@@ -1241,6 +1446,7 @@ declare namespace sap {
1241
1446
  *
1242
1447
  * Default value is `empty string`.
1243
1448
  *
1449
+ *
1244
1450
  * @returns Value of property `icon`
1245
1451
  */
1246
1452
  getIcon(): sap.ui.core.URI;
@@ -1251,16 +1457,17 @@ declare namespace sap {
1251
1457
  */
1252
1458
  getItems(): sap.tnt.NavigationListItem[];
1253
1459
  /**
1254
- * @since 1.116
1255
- * @experimental (since 1.116) - Disclaimer: this property is in a beta state - incompatible API changes
1256
- * may be done before its official public release.
1257
- *
1258
1460
  * Gets current value of property {@link #getSelectable selectable}.
1259
1461
  *
1260
- * Specifies if the item can be selected.
1462
+ * Specifies if the item can be selected. It is recommended to set this property to `false` when the property
1463
+ * `href` is also used.
1261
1464
  *
1262
1465
  * Default value is `true`.
1263
1466
  *
1467
+ * @since 1.116
1468
+ * @experimental (since 1.116) - Disclaimer: this property is in a beta state - incompatible API changes
1469
+ * may be done before its official public release.
1470
+ *
1264
1471
  * @returns Value of property `selectable`
1265
1472
  */
1266
1473
  getSelectable(): boolean;
@@ -1273,18 +1480,19 @@ declare namespace sap {
1273
1480
  * `_search`. Alternatively, a frame name can be entered. This property is only used when the `href` property
1274
1481
  * is set.
1275
1482
  *
1483
+ *
1276
1484
  * @returns Value of property `target`
1277
1485
  */
1278
1486
  getTarget(): string;
1279
1487
  /**
1280
- * @since 1.52
1281
- *
1282
1488
  * Gets current value of property {@link #getVisible visible}.
1283
1489
  *
1284
1490
  * Specifies if the item should be shown.
1285
1491
  *
1286
1492
  * Default value is `true`.
1287
1493
  *
1494
+ * @since 1.52
1495
+ *
1288
1496
  * @returns Value of property `visible`
1289
1497
  */
1290
1498
  getVisible(): boolean;
@@ -1292,6 +1500,7 @@ declare namespace sap {
1292
1500
  * Checks for the provided `sap.tnt.NavigationListItem` in the aggregation {@link #getItems items}. and
1293
1501
  * returns its index if found or -1 otherwise.
1294
1502
  *
1503
+ *
1295
1504
  * @returns The index of the provided control in the aggregation if found, or -1 otherwise
1296
1505
  */
1297
1506
  indexOfItem(
@@ -1303,6 +1512,7 @@ declare namespace sap {
1303
1512
  /**
1304
1513
  * Inserts a item into the aggregation {@link #getItems items}.
1305
1514
  *
1515
+ *
1306
1516
  * @returns Reference to `this` in order to allow method chaining
1307
1517
  */
1308
1518
  insertItem(
@@ -1322,12 +1532,14 @@ declare namespace sap {
1322
1532
  *
1323
1533
  * Additionally, it unregisters them from the hosting UIArea.
1324
1534
  *
1535
+ *
1325
1536
  * @returns An array of the removed elements (might be empty)
1326
1537
  */
1327
1538
  removeAllItems(): sap.tnt.NavigationListItem[];
1328
1539
  /**
1329
1540
  * Removes a item from the aggregation {@link #getItems items}.
1330
1541
  *
1542
+ *
1331
1543
  * @returns The removed item or `null`
1332
1544
  */
1333
1545
  removeItem(
@@ -1337,115 +1549,252 @@ declare namespace sap {
1337
1549
  vItem: int | string | sap.tnt.NavigationListItem
1338
1550
  ): sap.tnt.NavigationListItem | null;
1339
1551
  /**
1340
- * Sets a new value for property {@link #getExpanded expanded}.
1552
+ * Sets a new value for property {@link #getHref href}.
1341
1553
  *
1342
- * Specifies if the item is expanded.
1554
+ * Defines the link target URI. Supports standard hyperlink behavior. If a JavaScript action should be triggered,
1555
+ * this should not be set, but instead an event handler for the `select` event should be registered.
1343
1556
  *
1344
1557
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1345
1558
  *
1346
- * Default value is `true`.
1347
1559
  *
1348
1560
  * @returns Reference to `this` in order to allow method chaining
1349
1561
  */
1350
- setExpanded(
1562
+ setHref(
1351
1563
  /**
1352
- * New value for property `expanded`
1564
+ * New value for property `href`
1353
1565
  */
1354
- bExpanded?: boolean
1566
+ sHref?: sap.ui.core.URI
1355
1567
  ): this;
1356
1568
  /**
1357
- * Sets a new value for property {@link #getHasExpander hasExpander}.
1569
+ * Sets a new value for property {@link #getIcon icon}.
1570
+ *
1571
+ * Specifies the icon for the item.
1572
+ *
1573
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1574
+ *
1575
+ * Default value is `empty string`.
1576
+ *
1577
+ *
1578
+ * @returns Reference to `this` in order to allow method chaining
1579
+ */
1580
+ setIcon(
1581
+ /**
1582
+ * New value for property `icon`
1583
+ */
1584
+ sIcon?: sap.ui.core.URI
1585
+ ): this;
1586
+ /**
1587
+ * Sets a new value for property {@link #getSelectable selectable}.
1358
1588
  *
1359
- * Specifies if the item has an expander.
1589
+ * Specifies if the item can be selected. It is recommended to set this property to `false` when the property
1590
+ * `href` is also used.
1360
1591
  *
1361
1592
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1362
1593
  *
1363
1594
  * Default value is `true`.
1364
1595
  *
1596
+ * @since 1.116
1597
+ * @experimental (since 1.116) - Disclaimer: this property is in a beta state - incompatible API changes
1598
+ * may be done before its official public release.
1599
+ *
1365
1600
  * @returns Reference to `this` in order to allow method chaining
1366
1601
  */
1367
- setHasExpander(
1602
+ setSelectable(
1368
1603
  /**
1369
- * New value for property `hasExpander`
1604
+ * New value for property `selectable`
1370
1605
  */
1371
- bHasExpander?: boolean
1606
+ bSelectable?: boolean
1372
1607
  ): this;
1373
1608
  /**
1374
- * Sets a new value for property {@link #getHref href}.
1609
+ * Sets a new value for property {@link #getTarget target}.
1375
1610
  *
1376
- * Defines the link target URI. Supports standard hyperlink behavior. If a JavaScript action should be triggered,
1377
- * this should not be set, but instead an event handler for the `select` event should be registered.
1611
+ * Specifies the browsing context where the linked content will open.
1612
+ *
1613
+ * Options are the standard values for window.open() supported by browsers: `_self`, `_top`, `_blank`, `_parent`,
1614
+ * `_search`. Alternatively, a frame name can be entered. This property is only used when the `href` property
1615
+ * is set.
1378
1616
  *
1379
1617
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1380
1618
  *
1619
+ *
1381
1620
  * @returns Reference to `this` in order to allow method chaining
1382
1621
  */
1383
- setHref(
1622
+ setTarget(
1384
1623
  /**
1385
- * New value for property `href`
1624
+ * New value for property `target`
1386
1625
  */
1387
- sHref?: sap.ui.core.URI
1626
+ sTarget?: string
1388
1627
  ): this;
1389
1628
  /**
1390
- * Sets a new value for property {@link #getIcon icon}.
1629
+ * Sets a new value for property {@link #getVisible visible}.
1630
+ *
1631
+ * Specifies if the item should be shown.
1632
+ *
1633
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1634
+ *
1635
+ * Default value is `true`.
1636
+ *
1637
+ * @since 1.52
1638
+ *
1639
+ * @returns Reference to `this` in order to allow method chaining
1640
+ */
1641
+ setVisible(
1642
+ /**
1643
+ * New value for property `visible`
1644
+ */
1645
+ bVisible?: boolean
1646
+ ): this;
1647
+ }
1648
+ /**
1649
+ * The `NavigationListItemBase` class represents a base class for the items that are accepted by the `NavigationList`
1650
+ * control.
1651
+ *
1652
+ * @since 1.121
1653
+ */
1654
+ abstract class NavigationListItemBase extends sap.ui.core.Item {
1655
+ /**
1656
+ * Constructor for a new `NavigationListItemBase`.
1657
+ *
1658
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1659
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1660
+ * of the syntax of the settings object.
1661
+ */
1662
+ constructor(
1663
+ /**
1664
+ * Initial settings for the new control
1665
+ */
1666
+ mSettings?: sap.tnt.$NavigationListItemBaseSettings
1667
+ );
1668
+ /**
1669
+ * Constructor for a new `NavigationListItemBase`.
1670
+ *
1671
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1672
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1673
+ * of the syntax of the settings object.
1674
+ */
1675
+ constructor(
1676
+ /**
1677
+ * ID for the new control, generated automatically if no ID is given
1678
+ */
1679
+ sId?: string,
1680
+ /**
1681
+ * Initial settings for the new control
1682
+ */
1683
+ mSettings?: sap.tnt.$NavigationListItemBaseSettings
1684
+ );
1685
+
1686
+ /**
1687
+ * Creates a new subclass of class sap.tnt.NavigationListItemBase with name `sClassName` and enriches it
1688
+ * with the information contained in `oClassInfo`.
1689
+ *
1690
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Item.extend}.
1691
+ *
1692
+ *
1693
+ * @returns Created class / constructor function
1694
+ */
1695
+ static extend<T extends Record<string, unknown>>(
1696
+ /**
1697
+ * Name of the class being created
1698
+ */
1699
+ sClassName: string,
1700
+ /**
1701
+ * Object literal with information about the class
1702
+ */
1703
+ oClassInfo?: sap.ClassInfo<T, sap.tnt.NavigationListItemBase>,
1704
+ /**
1705
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1706
+ * used by this class
1707
+ */
1708
+ FNMetaImpl?: Function
1709
+ ): Function;
1710
+ /**
1711
+ * Returns a metadata object for class sap.tnt.NavigationListItemBase.
1712
+ *
1713
+ *
1714
+ * @returns Metadata object describing this class
1715
+ */
1716
+ static getMetadata(): sap.ui.core.ElementMetadata;
1717
+ /**
1718
+ * Gets current value of property {@link #getExpanded expanded}.
1719
+ *
1720
+ * Specifies if the item is expanded.
1721
+ *
1722
+ * Default value is `true`.
1723
+ *
1724
+ * @since 1.121
1725
+ *
1726
+ * @returns Value of property `expanded`
1727
+ */
1728
+ getExpanded(): boolean;
1729
+ /**
1730
+ * Returns the DOM Element that should get the focus.
1731
+ *
1732
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1733
+ *
1734
+ * @returns Returns the DOM Element that should get the focus
1735
+ */
1736
+ getFocusDomRef(): Element;
1737
+ /**
1738
+ * Gets current value of property {@link #getHasExpander hasExpander}.
1739
+ *
1740
+ * Specifies if the item is allowed to be expanded or collapsed by the user.
1741
+ *
1742
+ * Default value is `true`.
1743
+ *
1744
+ *
1745
+ * @returns Value of property `hasExpander`
1746
+ */
1747
+ getHasExpander(): boolean;
1748
+ /**
1749
+ * Gets current value of property {@link #getVisible visible}.
1391
1750
  *
1392
- * Specifies the icon for the item.
1751
+ * Specifies if the item should be shown.
1393
1752
  *
1394
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1753
+ * Default value is `true`.
1395
1754
  *
1396
- * Default value is `empty string`.
1755
+ * @since 1.121
1397
1756
  *
1398
- * @returns Reference to `this` in order to allow method chaining
1757
+ * @returns Value of property `visible`
1399
1758
  */
1400
- setIcon(
1401
- /**
1402
- * New value for property `icon`
1403
- */
1404
- sIcon?: sap.ui.core.URI
1405
- ): this;
1759
+ getVisible(): boolean;
1406
1760
  /**
1407
- * @since 1.116
1408
- * @experimental (since 1.116) - Disclaimer: this property is in a beta state - incompatible API changes
1409
- * may be done before its official public release.
1410
- *
1411
- * Sets a new value for property {@link #getSelectable selectable}.
1761
+ * Sets a new value for property {@link #getExpanded expanded}.
1412
1762
  *
1413
- * Specifies if the item can be selected.
1763
+ * Specifies if the item is expanded.
1414
1764
  *
1415
1765
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1416
1766
  *
1417
1767
  * Default value is `true`.
1418
1768
  *
1769
+ * @since 1.121
1770
+ *
1419
1771
  * @returns Reference to `this` in order to allow method chaining
1420
1772
  */
1421
- setSelectable(
1773
+ setExpanded(
1422
1774
  /**
1423
- * New value for property `selectable`
1775
+ * New value for property `expanded`
1424
1776
  */
1425
- bSelectable?: boolean
1777
+ bExpanded?: boolean
1426
1778
  ): this;
1427
1779
  /**
1428
- * Sets a new value for property {@link #getTarget target}.
1429
- *
1430
- * Specifies the browsing context where the linked content will open.
1780
+ * Sets a new value for property {@link #getHasExpander hasExpander}.
1431
1781
  *
1432
- * Options are the standard values for window.open() supported by browsers: `_self`, `_top`, `_blank`, `_parent`,
1433
- * `_search`. Alternatively, a frame name can be entered. This property is only used when the `href` property
1434
- * is set.
1782
+ * Specifies if the item is allowed to be expanded or collapsed by the user.
1435
1783
  *
1436
1784
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1437
1785
  *
1786
+ * Default value is `true`.
1787
+ *
1788
+ *
1438
1789
  * @returns Reference to `this` in order to allow method chaining
1439
1790
  */
1440
- setTarget(
1791
+ setHasExpander(
1441
1792
  /**
1442
- * New value for property `target`
1793
+ * New value for property `hasExpander`
1443
1794
  */
1444
- sTarget?: string
1795
+ bHasExpander?: boolean
1445
1796
  ): this;
1446
1797
  /**
1447
- * @since 1.52
1448
- *
1449
1798
  * Sets a new value for property {@link #getVisible visible}.
1450
1799
  *
1451
1800
  * Specifies if the item should be shown.
@@ -1454,6 +1803,8 @@ declare namespace sap {
1454
1803
  *
1455
1804
  * Default value is `true`.
1456
1805
  *
1806
+ * @since 1.121
1807
+ *
1457
1808
  * @returns Reference to `this` in order to allow method chaining
1458
1809
  */
1459
1810
  setVisible(
@@ -1464,17 +1815,17 @@ declare namespace sap {
1464
1815
  ): this;
1465
1816
  }
1466
1817
  /**
1467
- * @since 1.34
1468
- *
1469
- * The SideNavigation control is a container, which consists of flexible and fixed parts on top of each
1818
+ * The `SideNavigation` control is a container, which consists of flexible and fixed parts on top of each
1470
1819
  * other. Responsive Behavior:
1471
1820
  * - The flexible part adapts its size to the fixed one.
1472
1821
  * - The flexible part has a scrollbar when the content is larger than the available space. **Note:**
1473
- * In order for the SideNavigation to stretch properly, its parent layout control should only be the sap.tnt.ToolPage.
1822
+ * In order for the `SideNavigation` to stretch properly, its parent layout control should only be the `sap.tnt.ToolPage`.
1823
+ *
1824
+ * @since 1.34
1474
1825
  */
1475
1826
  class SideNavigation extends sap.ui.core.Control {
1476
1827
  /**
1477
- * Constructor for a new SideNavigation.
1828
+ * Constructor for a new `SideNavigation`.
1478
1829
  *
1479
1830
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1480
1831
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
@@ -1487,7 +1838,7 @@ declare namespace sap {
1487
1838
  mSettings?: sap.tnt.$SideNavigationSettings
1488
1839
  );
1489
1840
  /**
1490
- * Constructor for a new SideNavigation.
1841
+ * Constructor for a new `SideNavigation`.
1491
1842
  *
1492
1843
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1493
1844
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
@@ -1510,6 +1861,7 @@ declare namespace sap {
1510
1861
  *
1511
1862
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
1512
1863
  *
1864
+ *
1513
1865
  * @returns Created class / constructor function
1514
1866
  */
1515
1867
  static extend<T extends Record<string, unknown>>(
@@ -1530,6 +1882,7 @@ declare namespace sap {
1530
1882
  /**
1531
1883
  * Returns a metadata object for class sap.tnt.SideNavigation.
1532
1884
  *
1885
+ *
1533
1886
  * @returns Metadata object describing this class
1534
1887
  */
1535
1888
  static getMetadata(): sap.ui.core.ElementMetadata;
@@ -1541,6 +1894,7 @@ declare namespace sap {
1541
1894
  *
1542
1895
  * Fired when an item is selected.
1543
1896
  *
1897
+ *
1544
1898
  * @returns Reference to `this` in order to allow method chaining
1545
1899
  */
1546
1900
  attachItemSelect(
@@ -1566,6 +1920,7 @@ declare namespace sap {
1566
1920
  *
1567
1921
  * Fired when an item is selected.
1568
1922
  *
1923
+ *
1569
1924
  * @returns Reference to `this` in order to allow method chaining
1570
1925
  */
1571
1926
  attachItemSelect(
@@ -1584,6 +1939,7 @@ declare namespace sap {
1584
1939
  * See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a detailed description
1585
1940
  * of the possible properties of `oBindingInfo`.
1586
1941
  *
1942
+ *
1587
1943
  * @returns Reference to `this` in order to allow method chaining
1588
1944
  */
1589
1945
  bindItem(
@@ -1595,20 +1951,22 @@ declare namespace sap {
1595
1951
  /**
1596
1952
  * Destroys the fixedItem in the aggregation {@link #getFixedItem fixedItem}.
1597
1953
  *
1954
+ *
1598
1955
  * @returns Reference to `this` in order to allow method chaining
1599
1956
  */
1600
1957
  destroyFixedItem(): this;
1601
1958
  /**
1602
- * @deprecated (since 1.120) - Use the aggregation `fixedItem` instead.
1603
- *
1604
1959
  * Destroys the footer in the aggregation {@link #getFooter footer}.
1605
1960
  *
1961
+ * @deprecated (since 1.120) - Use the aggregation `fixedItem` instead.
1962
+ *
1606
1963
  * @returns Reference to `this` in order to allow method chaining
1607
1964
  */
1608
1965
  destroyFooter(): this;
1609
1966
  /**
1610
1967
  * Destroys the item in the aggregation {@link #getItem item}.
1611
1968
  *
1969
+ *
1612
1970
  * @returns Reference to `this` in order to allow method chaining
1613
1971
  */
1614
1972
  destroyItem(): this;
@@ -1617,6 +1975,7 @@ declare namespace sap {
1617
1975
  *
1618
1976
  * The passed function and listener object must match the ones used for event registration.
1619
1977
  *
1978
+ *
1620
1979
  * @returns Reference to `this` in order to allow method chaining
1621
1980
  */
1622
1981
  detachItemSelect(
@@ -1630,10 +1989,10 @@ declare namespace sap {
1630
1989
  oListener?: object
1631
1990
  ): this;
1632
1991
  /**
1633
- * @ui5-protected Do not call from applications (only from related classes in the framework)
1634
- *
1635
1992
  * Fires event {@link #event:itemSelect itemSelect} to attached listeners.
1636
1993
  *
1994
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1995
+ *
1637
1996
  * @returns Reference to `this` in order to allow method chaining
1638
1997
  */
1639
1998
  fireItemSelect(
@@ -1643,11 +2002,11 @@ declare namespace sap {
1643
2002
  mParameters?: sap.tnt.SideNavigation$ItemSelectEventParameters
1644
2003
  ): this;
1645
2004
  /**
1646
- * @since 1.98
1647
- *
1648
2005
  * Gets current value of property {@link #getAriaLabel ariaLabel}.
1649
2006
  *
1650
- * Specifies an optional aria-label that can be used by the screen readers.
2007
+ * Specifies an optional `aria-label` that can be used by the screen readers.
2008
+ *
2009
+ * @since 1.98
1651
2010
  *
1652
2011
  * @returns Value of property `ariaLabel`
1653
2012
  */
@@ -1659,6 +2018,7 @@ declare namespace sap {
1659
2018
  *
1660
2019
  * Default value is `true`.
1661
2020
  *
2021
+ *
1662
2022
  * @returns Value of property `expanded`
1663
2023
  */
1664
2024
  getExpanded(): boolean;
@@ -1669,11 +2029,11 @@ declare namespace sap {
1669
2029
  */
1670
2030
  getFixedItem(): sap.tnt.NavigationList;
1671
2031
  /**
1672
- * @deprecated (since 1.120) - Use the aggregation `fixedItem` instead.
1673
- *
1674
2032
  * Gets content of aggregation {@link #getFooter footer}.
1675
2033
  *
1676
2034
  * Defines the content inside the footer.
2035
+ *
2036
+ * @deprecated (since 1.120) - Use the aggregation `fixedItem` instead.
1677
2037
  */
1678
2038
  getFooter(): sap.tnt.NavigationList;
1679
2039
  /**
@@ -1683,25 +2043,23 @@ declare namespace sap {
1683
2043
  */
1684
2044
  getItem(): sap.tnt.NavigationList;
1685
2045
  /**
1686
- * @since 1.52.0
1687
- *
1688
2046
  * ID of the element which is the current target of the association {@link #getSelectedItem selectedItem},
1689
2047
  * or `null`.
2048
+ *
2049
+ * @since 1.52.0
1690
2050
  */
1691
- getSelectedItem(): sap.ui.core.ID;
2051
+ getSelectedItem(): sap.ui.core.ID | null;
1692
2052
  /**
1693
- * @since 1.62.0
1694
- *
1695
2053
  * Gets current value of property {@link #getSelectedKey selectedKey}.
1696
2054
  *
1697
2055
  * Specifies the currently selected key.
1698
2056
  *
2057
+ * @since 1.62.0
2058
+ *
1699
2059
  * @returns Value of property `selectedKey`
1700
2060
  */
1701
2061
  getSelectedKey(): string;
1702
2062
  /**
1703
- * @since 1.120
1704
- *
1705
2063
  * Gets current value of property {@link #getWidth width}.
1706
2064
  *
1707
2065
  * Specifies the width of the control.
@@ -1709,18 +2067,20 @@ declare namespace sap {
1709
2067
  * Depending on the theme, there is a minimum width set (16rem for Horizon theme). This property
1710
2068
  * can be used to set a bigger width.
1711
2069
  *
2070
+ * @since 1.120
2071
+ *
1712
2072
  * @returns Value of property `width`
1713
2073
  */
1714
2074
  getWidth(): sap.ui.core.CSSSize;
1715
2075
  /**
1716
- * @since 1.98
1717
- *
1718
2076
  * Sets a new value for property {@link #getAriaLabel ariaLabel}.
1719
2077
  *
1720
- * Specifies an optional aria-label that can be used by the screen readers.
2078
+ * Specifies an optional `aria-label` that can be used by the screen readers.
1721
2079
  *
1722
2080
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1723
2081
  *
2082
+ * @since 1.98
2083
+ *
1724
2084
  * @returns Reference to `this` in order to allow method chaining
1725
2085
  */
1726
2086
  setAriaLabel(
@@ -1732,17 +2092,19 @@ declare namespace sap {
1732
2092
  /**
1733
2093
  * Sets if the control is in expanded or collapsed mode.
1734
2094
  *
2095
+ *
1735
2096
  * @returns this SideNavigation reference for chaining.
1736
2097
  */
1737
2098
  setExpanded(
1738
2099
  /**
1739
2100
  * Indication if the SideNavigation is expanded.
1740
2101
  */
1741
- isExpanded: boolean
2102
+ bExpanded: boolean
1742
2103
  ): this;
1743
2104
  /**
1744
2105
  * Sets the aggregated {@link #getFixedItem fixedItem}.
1745
2106
  *
2107
+ *
1746
2108
  * @returns Reference to `this` in order to allow method chaining
1747
2109
  */
1748
2110
  setFixedItem(
@@ -1752,10 +2114,10 @@ declare namespace sap {
1752
2114
  oFixedItem: sap.tnt.NavigationList
1753
2115
  ): this;
1754
2116
  /**
1755
- * @deprecated (since 1.120) - Use the aggregation `fixedItem` instead.
1756
- *
1757
2117
  * Sets the aggregated {@link #getFooter footer}.
1758
2118
  *
2119
+ * @deprecated (since 1.120) - Use the aggregation `fixedItem` instead.
2120
+ *
1759
2121
  * @returns Reference to `this` in order to allow method chaining
1760
2122
  */
1761
2123
  setFooter(
@@ -1767,6 +2129,7 @@ declare namespace sap {
1767
2129
  /**
1768
2130
  * Sets the aggregated {@link #getItem item}.
1769
2131
  *
2132
+ *
1770
2133
  * @returns Reference to `this` in order to allow method chaining
1771
2134
  */
1772
2135
  setItem(
@@ -1776,7 +2139,8 @@ declare namespace sap {
1776
2139
  oItem: sap.tnt.NavigationList
1777
2140
  ): this;
1778
2141
  /**
1779
- * Sets the association for selectedItem
2142
+ * Sets the association for `selectedItem`.
2143
+ *
1780
2144
  *
1781
2145
  * @returns The `selectedItem` association
1782
2146
  */
@@ -1784,22 +2148,21 @@ declare namespace sap {
1784
2148
  /**
1785
2149
  * The control to be set as selected
1786
2150
  */
1787
- selectedItem: string | sap.tnt.NavigationListItem
2151
+ vSelectedItem: sap.ui.core.ID | sap.tnt.NavigationListItem
1788
2152
  ): sap.tnt.SideNavigation | null;
1789
2153
  /**
1790
2154
  * Sets the selected item based on a key.
1791
2155
  *
2156
+ *
1792
2157
  * @returns this pointer for chaining
1793
2158
  */
1794
2159
  setSelectedKey(
1795
2160
  /**
1796
2161
  * The key of the item to be selected
1797
2162
  */
1798
- selectedKey: string
2163
+ sSelectedKey: string
1799
2164
  ): this;
1800
2165
  /**
1801
- * @since 1.120
1802
- *
1803
2166
  * Sets a new value for property {@link #getWidth width}.
1804
2167
  *
1805
2168
  * Specifies the width of the control.
@@ -1809,6 +2172,8 @@ declare namespace sap {
1809
2172
  *
1810
2173
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1811
2174
  *
2175
+ * @since 1.120
2176
+ *
1812
2177
  * @returns Reference to `this` in order to allow method chaining
1813
2178
  */
1814
2179
  setWidth(
@@ -1820,13 +2185,12 @@ declare namespace sap {
1820
2185
  /**
1821
2186
  * Unbinds aggregation {@link #getItem item} from model data.
1822
2187
  *
2188
+ *
1823
2189
  * @returns Reference to `this` in order to allow method chaining
1824
2190
  */
1825
2191
  unbindItem(): this;
1826
2192
  }
1827
2193
  /**
1828
- * @since 1.34
1829
- *
1830
2194
  * The ToolHeader control is a horizontal container that is most commonly used to display buttons, texts,
1831
2195
  * and other various input controls. Overview: The ToolHeader control is based on {@link sap.m.OverflowToolbar}.
1832
2196
  * It contains clearly structured menus of commands that are available across the various apps within the
@@ -1861,6 +2225,8 @@ declare namespace sap {
1861
2225
  * in Inline mode only. Semantic colors, icons and separators. sap.f.Avatar/sap.m.Avatar
1862
2226
  * Support for default (Accent 6) color. Image avatar. - sap.m.Image
1863
2227
  * Primarily used for displaying the company logo. Interaction states
2228
+ *
2229
+ * @since 1.34
1864
2230
  */
1865
2231
  class ToolHeader
1866
2232
  extends sap.m.OverflowToolbar
@@ -1909,6 +2275,7 @@ declare namespace sap {
1909
2275
  *
1910
2276
  * `oClassInfo` might contain the same kind of information as described in {@link sap.m.OverflowToolbar.extend}.
1911
2277
  *
2278
+ *
1912
2279
  * @returns Created class / constructor function
1913
2280
  */
1914
2281
  static extend<T extends Record<string, unknown>>(
@@ -1929,15 +2296,16 @@ declare namespace sap {
1929
2296
  /**
1930
2297
  * Returns a metadata object for class sap.tnt.ToolHeader.
1931
2298
  *
2299
+ *
1932
2300
  * @returns Metadata object describing this class
1933
2301
  */
1934
2302
  static getMetadata(): sap.ui.core.ElementMetadata;
1935
2303
  }
1936
2304
  /**
1937
- * @since 1.16
1938
- *
1939
2305
  * The ToolHeaderUtilitySeparator control is used in the sap.tnt.ToolHeader control to specify where the
1940
2306
  * overflow button is placed.
2307
+ *
2308
+ * @since 1.16
1941
2309
  */
1942
2310
  class ToolHeaderUtilitySeparator extends sap.ui.core.Control {
1943
2311
  /**
@@ -1983,6 +2351,7 @@ declare namespace sap {
1983
2351
  *
1984
2352
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
1985
2353
  *
2354
+ *
1986
2355
  * @returns Created class / constructor function
1987
2356
  */
1988
2357
  static extend<T extends Record<string, unknown>>(
@@ -2003,18 +2372,19 @@ declare namespace sap {
2003
2372
  /**
2004
2373
  * Returns a metadata object for class sap.tnt.ToolHeaderUtilitySeparator.
2005
2374
  *
2375
+ *
2006
2376
  * @returns Metadata object describing this class
2007
2377
  */
2008
2378
  static getMetadata(): sap.ui.core.ElementMetadata;
2009
2379
  }
2010
2380
  /**
2011
- * @since 1.34
2012
- *
2013
2381
  * The ToolPage is a layout control, used to create a basic tools app that has a header, side navigation
2014
2382
  * and contents area. Overview: The control has three main areas - a header on top, navigation to the side
2015
2383
  * and a content area that can hold any control. The header and side navigation use custom controls - {@link sap.tnt.ToolHeader }
2016
2384
  * and {@link sap.tnt.SideNavigation}. Usage: The main usage of the sap.tnt controls is for scenarios in
2017
2385
  * the tooling or administration space.
2386
+ *
2387
+ * @since 1.34
2018
2388
  */
2019
2389
  class ToolPage extends sap.ui.core.Control {
2020
2390
  /**
@@ -2054,6 +2424,7 @@ declare namespace sap {
2054
2424
  *
2055
2425
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
2056
2426
  *
2427
+ *
2057
2428
  * @returns Created class / constructor function
2058
2429
  */
2059
2430
  static extend<T extends Record<string, unknown>>(
@@ -2074,12 +2445,14 @@ declare namespace sap {
2074
2445
  /**
2075
2446
  * Returns a metadata object for class sap.tnt.ToolPage.
2076
2447
  *
2448
+ *
2077
2449
  * @returns Metadata object describing this class
2078
2450
  */
2079
2451
  static getMetadata(): sap.ui.core.ElementMetadata;
2080
2452
  /**
2081
2453
  * Adds some mainContent to the aggregation {@link #getMainContents mainContents}.
2082
2454
  *
2455
+ *
2083
2456
  * @returns Reference to `this` in order to allow method chaining
2084
2457
  */
2085
2458
  addMainContent(
@@ -2091,38 +2464,41 @@ declare namespace sap {
2091
2464
  /**
2092
2465
  * Destroys the header in the aggregation {@link #getHeader header}.
2093
2466
  *
2467
+ *
2094
2468
  * @returns Reference to `this` in order to allow method chaining
2095
2469
  */
2096
2470
  destroyHeader(): this;
2097
2471
  /**
2098
2472
  * Destroys all the mainContents in the aggregation {@link #getMainContents mainContents}.
2099
2473
  *
2474
+ *
2100
2475
  * @returns Reference to `this` in order to allow method chaining
2101
2476
  */
2102
2477
  destroyMainContents(): this;
2103
2478
  /**
2104
2479
  * Destroys the sideContent in the aggregation {@link #getSideContent sideContent}.
2105
2480
  *
2481
+ *
2106
2482
  * @returns Reference to `this` in order to allow method chaining
2107
2483
  */
2108
2484
  destroySideContent(): this;
2109
2485
  /**
2110
- * @since 1.93
2111
- *
2112
2486
  * Destroys the subHeader in the aggregation {@link #getSubHeader subHeader}.
2113
2487
  *
2488
+ * @since 1.93
2489
+ *
2114
2490
  * @returns Reference to `this` in order to allow method chaining
2115
2491
  */
2116
2492
  destroySubHeader(): this;
2117
2493
  /**
2118
- * @since 1.115
2119
- *
2120
2494
  * Gets current value of property {@link #getContentBackgroundDesign contentBackgroundDesign}.
2121
2495
  *
2122
2496
  * Specifies the content background design.
2123
2497
  *
2124
2498
  * Default value is `Standard`.
2125
2499
  *
2500
+ * @since 1.115
2501
+ *
2126
2502
  * @returns Value of property `contentBackgroundDesign`
2127
2503
  */
2128
2504
  getContentBackgroundDesign(): sap.m.PageBackgroundDesign;
@@ -2151,21 +2527,23 @@ declare namespace sap {
2151
2527
  *
2152
2528
  * Default value is `true`.
2153
2529
  *
2530
+ *
2154
2531
  * @returns Value of property `sideExpanded`
2155
2532
  */
2156
2533
  getSideExpanded(): boolean;
2157
2534
  /**
2158
- * @since 1.93
2159
- *
2160
2535
  * Gets content of aggregation {@link #getSubHeader subHeader}.
2161
2536
  *
2162
2537
  * The control to appear in the subheader area.
2538
+ *
2539
+ * @since 1.93
2163
2540
  */
2164
2541
  getSubHeader(): sap.tnt.IToolHeader;
2165
2542
  /**
2166
2543
  * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getMainContents mainContents}.
2167
2544
  * and returns its index if found or -1 otherwise.
2168
2545
  *
2546
+ *
2169
2547
  * @returns The index of the provided control in the aggregation if found, or -1 otherwise
2170
2548
  */
2171
2549
  indexOfMainContent(
@@ -2177,6 +2555,7 @@ declare namespace sap {
2177
2555
  /**
2178
2556
  * Inserts a mainContent into the aggregation {@link #getMainContents mainContents}.
2179
2557
  *
2558
+ *
2180
2559
  * @returns Reference to `this` in order to allow method chaining
2181
2560
  */
2182
2561
  insertMainContent(
@@ -2196,12 +2575,14 @@ declare namespace sap {
2196
2575
  *
2197
2576
  * Additionally, it unregisters them from the hosting UIArea.
2198
2577
  *
2578
+ *
2199
2579
  * @returns An array of the removed elements (might be empty)
2200
2580
  */
2201
2581
  removeAllMainContents(): sap.ui.core.Control[];
2202
2582
  /**
2203
2583
  * Removes a mainContent from the aggregation {@link #getMainContents mainContents}.
2204
2584
  *
2585
+ *
2205
2586
  * @returns The removed mainContent or `null`
2206
2587
  */
2207
2588
  removeMainContent(
@@ -2211,8 +2592,6 @@ declare namespace sap {
2211
2592
  vMainContent: int | string | sap.ui.core.Control
2212
2593
  ): sap.ui.core.Control | null;
2213
2594
  /**
2214
- * @since 1.115
2215
- *
2216
2595
  * Sets a new value for property {@link #getContentBackgroundDesign contentBackgroundDesign}.
2217
2596
  *
2218
2597
  * Specifies the content background design.
@@ -2221,6 +2600,8 @@ declare namespace sap {
2221
2600
  *
2222
2601
  * Default value is `Standard`.
2223
2602
  *
2603
+ * @since 1.115
2604
+ *
2224
2605
  * @returns Reference to `this` in order to allow method chaining
2225
2606
  */
2226
2607
  setContentBackgroundDesign(
@@ -2232,6 +2613,7 @@ declare namespace sap {
2232
2613
  /**
2233
2614
  * Sets the aggregated {@link #getHeader header}.
2234
2615
  *
2616
+ *
2235
2617
  * @returns Reference to `this` in order to allow method chaining
2236
2618
  */
2237
2619
  setHeader(
@@ -2243,6 +2625,7 @@ declare namespace sap {
2243
2625
  /**
2244
2626
  * Sets the aggregated {@link #getSideContent sideContent}.
2245
2627
  *
2628
+ *
2246
2629
  * @returns Reference to `this` in order to allow method chaining
2247
2630
  */
2248
2631
  setSideContent(
@@ -2254,6 +2637,7 @@ declare namespace sap {
2254
2637
  /**
2255
2638
  * Sets the expand/collapse state of the SideContent.
2256
2639
  *
2640
+ *
2257
2641
  * @returns Pointer to the control instance for chaining
2258
2642
  */
2259
2643
  setSideExpanded(
@@ -2263,10 +2647,10 @@ declare namespace sap {
2263
2647
  bSideExpanded: boolean
2264
2648
  ): this;
2265
2649
  /**
2266
- * @since 1.93
2267
- *
2268
2650
  * Sets the aggregated {@link #getSubHeader subHeader}.
2269
2651
  *
2652
+ * @since 1.93
2653
+ *
2270
2654
  * @returns Reference to `this` in order to allow method chaining
2271
2655
  */
2272
2656
  setSubHeader(
@@ -2278,12 +2662,202 @@ declare namespace sap {
2278
2662
  /**
2279
2663
  * Toggles the expand/collapse state of the SideContent.
2280
2664
  *
2665
+ *
2281
2666
  * @returns Pointer to the control instance for chaining.
2282
2667
  */
2283
2668
  toggleSideContentMode(): this;
2284
2669
  }
2670
+ /**
2671
+ * Available TNT `Illustration` types for the {@link sap.m.IllustratedMessage} control.
2672
+ *
2673
+ * @since 1.121
2674
+ */
2675
+ enum IllustratedMessageType {
2676
+ /**
2677
+ * "Avatar" illustration type.
2678
+ */
2679
+ Avatar = "tnt-Avatar",
2680
+ /**
2681
+ * "Calculator" illustration type.
2682
+ */
2683
+ Calculator = "tnt-Calculator",
2684
+ /**
2685
+ * "ChartArea" illustration type.
2686
+ */
2687
+ ChartArea = "tnt-ChartArea",
2688
+ /**
2689
+ * "ChartArea2" illustration type.
2690
+ */
2691
+ ChartArea2 = "tnt-ChartArea2",
2692
+ /**
2693
+ * "ChartBar" illustration type.
2694
+ */
2695
+ ChartBar = "tnt-ChartBar",
2696
+ /**
2697
+ * "ChartBPMNFlow" illustration type.
2698
+ */
2699
+ ChartBPMNFlow = "tnt-ChartBPMNFlow",
2700
+ /**
2701
+ * "ChartBullet" illustration type.
2702
+ */
2703
+ ChartBullet = "tnt-ChartBullet",
2704
+ /**
2705
+ * "ChartDoughnut" illustration type.
2706
+ */
2707
+ ChartDoughnut = "tnt-ChartDoughnut",
2708
+ /**
2709
+ * "ChartFlow" illustration type.
2710
+ */
2711
+ ChartFlow = "tnt-ChartFlow",
2712
+ /**
2713
+ * "ChartGantt" illustration type.
2714
+ */
2715
+ ChartGantt = "tnt-ChartGantt",
2716
+ /**
2717
+ * "ChartOrg" illustration type.
2718
+ */
2719
+ ChartOrg = "tnt-ChartOrg",
2720
+ /**
2721
+ * "ChartPie" illustration type.
2722
+ */
2723
+ ChartPie = "tnt-ChartPie",
2724
+ /**
2725
+ * "CodePlaceholder" illustration type.
2726
+ */
2727
+ CodePlaceholder = "tnt-CodePlaceholder",
2728
+ /**
2729
+ * "Company" illustration type.
2730
+ */
2731
+ Company = "tnt-Company",
2732
+ /**
2733
+ * "Compass" illustration type.
2734
+ */
2735
+ Compass = "tnt-Compass",
2736
+ /**
2737
+ * "Components" illustration type.
2738
+ */
2739
+ Components = "tnt-Components",
2740
+ /**
2741
+ * "Dialog" illustration type.
2742
+ */
2743
+ Dialog = "tnt-Dialog",
2744
+ /**
2745
+ * "ExternalLink" illustration type.
2746
+ */
2747
+ ExternalLink = "tnt-ExternalLink",
2748
+ /**
2749
+ * "FaceID" illustration type.
2750
+ */
2751
+ FaceID = "tnt-FaceID",
2752
+ /**
2753
+ * "Fingerprint" illustration type.
2754
+ */
2755
+ Fingerprint = "tnt-Fingerprint",
2756
+ /**
2757
+ * "Handshake" illustration type.
2758
+ */
2759
+ Handshake = "tnt-Handshake",
2760
+ /**
2761
+ * "Help" illustration type.
2762
+ */
2763
+ Help = "tnt-Help",
2764
+ /**
2765
+ * "Lock" illustration type.
2766
+ */
2767
+ Lock = "tnt-Lock",
2768
+ /**
2769
+ * "Mission" illustration type.
2770
+ */
2771
+ Mission = "tnt-Mission",
2772
+ /**
2773
+ * "MissionFailed" illustration type.
2774
+ */
2775
+ MissionFailed = "tnt-MissionFailed",
2776
+ /**
2777
+ * "NoApplications" illustration type.
2778
+ */
2779
+ NoApplications = "tnt-NoApplications",
2780
+ /**
2781
+ * "NoFlows" illustration type.
2782
+ */
2783
+ NoFlows = "tnt-NoFlows",
2784
+ /**
2785
+ * "NoUsers" illustration type.
2786
+ */
2787
+ NoUsers = "tnt-NoUsers",
2788
+ /**
2789
+ * "Radar" illustration type.
2790
+ */
2791
+ Radar = "tnt-Radar",
2792
+ /**
2793
+ * "RoadMap" illustration type.
2794
+ */
2795
+ RoadMap = "tnt-RoadMap",
2796
+ /**
2797
+ * "Secrets" illustration type.
2798
+ */
2799
+ Secrets = "tnt-Secrets",
2800
+ /**
2801
+ * "Services" illustration type.
2802
+ */
2803
+ Services = "tnt-Services",
2804
+ /**
2805
+ * "SessionExpired" illustration type.
2806
+ */
2807
+ SessionExpired = "tnt-SessionExpired",
2808
+ /**
2809
+ * "SessionExpiring" illustration type.
2810
+ */
2811
+ SessionExpiring = "tnt-SessionExpiring",
2812
+ /**
2813
+ * "Settings" illustration type.
2814
+ */
2815
+ Settings = "tnt-Settings",
2816
+ /**
2817
+ * "Success" illustration type.
2818
+ */
2819
+ Success = "tnt-Success",
2820
+ /**
2821
+ * "SuccessfulAuth" illustration type.
2822
+ */
2823
+ SuccessfulAuth = "tnt-SuccessfulAuth",
2824
+ /**
2825
+ * "Systems" illustration type.
2826
+ */
2827
+ Systems = "tnt-Systems",
2828
+ /**
2829
+ * "Teams" illustration type.
2830
+ */
2831
+ Teams = "tnt-Teams",
2832
+ /**
2833
+ * "Tools" illustration type.
2834
+ */
2835
+ Tools = "tnt-Tools",
2836
+ /**
2837
+ * "Tutorials" illustration type.
2838
+ */
2839
+ Tutorials = "tnt-Tutorials",
2840
+ /**
2841
+ * "UnableToLoad" illustration type.
2842
+ */
2843
+ UnableToLoad = "tnt-UnableToLoad",
2844
+ /**
2845
+ * "Unlock" illustration type.
2846
+ */
2847
+ Unlock = "tnt-Unlock",
2848
+ /**
2849
+ * "UnsuccessfulAuth" illustration type.
2850
+ */
2851
+ UnsuccessfulAuth = "tnt-UnsuccessfulAuth",
2852
+ /**
2853
+ * "User2" illustration type.
2854
+ */
2855
+ User2 = "tnt-User2",
2856
+ }
2285
2857
  /**
2286
2858
  * Predefined types of `InfoLabel`
2859
+ *
2860
+ * This enum is part of the 'sap/tnt/library' module export and must be accessed by the property 'RenderMode'.
2287
2861
  */
2288
2862
  enum RenderMode {
2289
2863
  /**
@@ -2313,14 +2887,20 @@ declare namespace sap {
2313
2887
  }
2314
2888
 
2315
2889
  interface IUI5DefineDependencyNames {
2890
+ "sap/tnt/IllustratedMessageType": undefined;
2891
+
2316
2892
  "sap/tnt/InfoLabel": undefined;
2317
2893
 
2318
2894
  "sap/tnt/library": undefined;
2319
2895
 
2320
2896
  "sap/tnt/NavigationList": undefined;
2321
2897
 
2898
+ "sap/tnt/NavigationListGroup": undefined;
2899
+
2322
2900
  "sap/tnt/NavigationListItem": undefined;
2323
2901
 
2902
+ "sap/tnt/NavigationListItemBase": undefined;
2903
+
2324
2904
  "sap/tnt/SideNavigation": undefined;
2325
2905
 
2326
2906
  "sap/tnt/ToolHeader": undefined;