@openui5/ts-types 1.120.7 → 1.120.9
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.
- package/package.json +1 -1
- package/types/sap.f.d.ts +1491 -849
- package/types/sap.m.d.ts +12924 -8165
- package/types/sap.tnt.d.ts +192 -97
- package/types/sap.ui.codeeditor.d.ts +48 -19
- package/types/sap.ui.commons.d.ts +1991 -667
- package/types/sap.ui.core.d.ts +5278 -3344
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.fl.d.ts +80 -38
- package/types/sap.ui.integration.d.ts +446 -387
- package/types/sap.ui.layout.d.ts +1118 -636
- package/types/sap.ui.mdc.d.ts +1930 -1300
- package/types/sap.ui.rta.d.ts +7 -7
- package/types/sap.ui.suite.d.ts +44 -12
- package/types/sap.ui.support.d.ts +31 -23
- package/types/sap.ui.table.d.ts +901 -619
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +1835 -1208
- package/types/sap.ui.ux3.d.ts +1282 -480
- package/types/sap.ui.webc.common.d.ts +11 -9
- package/types/sap.ui.webc.fiori.d.ts +836 -213
- package/types/sap.ui.webc.main.d.ts +2672 -593
- package/types/sap.uxap.d.ts +573 -318
package/types/sap.tnt.d.ts
CHANGED
|
@@ -1,16 +1,16 @@
|
|
|
1
|
-
// For Library Version: 1.120.
|
|
1
|
+
// For Library Version: 1.120.9
|
|
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
|
|
|
@@ -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
|
|
|
@@ -164,9 +164,9 @@ declare namespace sap {
|
|
|
164
164
|
| `{${string}}`;
|
|
165
165
|
|
|
166
166
|
/**
|
|
167
|
-
* @since 1.52
|
|
168
|
-
*
|
|
169
167
|
* Specifies if the item should be shown.
|
|
168
|
+
*
|
|
169
|
+
* @since 1.52
|
|
170
170
|
*/
|
|
171
171
|
visible?:
|
|
172
172
|
| boolean
|
|
@@ -174,11 +174,11 @@ declare namespace sap {
|
|
|
174
174
|
| `{${string}}`;
|
|
175
175
|
|
|
176
176
|
/**
|
|
177
|
+
* Specifies if the item can be selected.
|
|
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
|
|
@@ -220,12 +220,12 @@ declare namespace sap {
|
|
|
220
220
|
|
|
221
221
|
interface $SideNavigationSettings extends sap.ui.core.$ControlSettings {
|
|
222
222
|
/**
|
|
223
|
-
* @since 1.120
|
|
224
|
-
*
|
|
225
223
|
* Specifies the width of the control.
|
|
226
224
|
*
|
|
227
225
|
* Depending on the theme, there is a minimum width set (16rem for Horizon theme). This property
|
|
228
226
|
* can be used to set a bigger width.
|
|
227
|
+
*
|
|
228
|
+
* @since 1.120
|
|
229
229
|
*/
|
|
230
230
|
width?:
|
|
231
231
|
| sap.ui.core.CSSSize
|
|
@@ -241,16 +241,16 @@ declare namespace sap {
|
|
|
241
241
|
| `{${string}}`;
|
|
242
242
|
|
|
243
243
|
/**
|
|
244
|
-
* @since 1.62.0
|
|
245
|
-
*
|
|
246
244
|
* Specifies the currently selected key.
|
|
245
|
+
*
|
|
246
|
+
* @since 1.62.0
|
|
247
247
|
*/
|
|
248
248
|
selectedKey?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
249
249
|
|
|
250
250
|
/**
|
|
251
|
-
* @since 1.98
|
|
252
|
-
*
|
|
253
251
|
* Specifies an optional aria-label that can be used by the screen readers.
|
|
252
|
+
*
|
|
253
|
+
* @since 1.98
|
|
254
254
|
*/
|
|
255
255
|
ariaLabel?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
256
256
|
|
|
@@ -265,16 +265,16 @@ declare namespace sap {
|
|
|
265
265
|
fixedItem?: sap.tnt.NavigationList;
|
|
266
266
|
|
|
267
267
|
/**
|
|
268
|
-
* @deprecated (since 1.120) - Use the aggregation `fixedItem` instead.
|
|
269
|
-
*
|
|
270
268
|
* Defines the content inside the footer.
|
|
269
|
+
*
|
|
270
|
+
* @deprecated (since 1.120) - Use the aggregation `fixedItem` instead.
|
|
271
271
|
*/
|
|
272
272
|
footer?: sap.tnt.NavigationList;
|
|
273
273
|
|
|
274
274
|
/**
|
|
275
|
-
* @since 1.52.0
|
|
276
|
-
*
|
|
277
275
|
* The selected `NavigationListItem`.
|
|
276
|
+
*
|
|
277
|
+
* @since 1.52.0
|
|
278
278
|
*/
|
|
279
279
|
selectedItem?: sap.tnt.NavigationListItem | string;
|
|
280
280
|
|
|
@@ -299,9 +299,9 @@ declare namespace sap {
|
|
|
299
299
|
| `{${string}}`;
|
|
300
300
|
|
|
301
301
|
/**
|
|
302
|
-
* @since 1.115
|
|
303
|
-
*
|
|
304
302
|
* Specifies the content background design.
|
|
303
|
+
*
|
|
304
|
+
* @since 1.115
|
|
305
305
|
*/
|
|
306
306
|
contentBackgroundDesign?:
|
|
307
307
|
| sap.m.PageBackgroundDesign
|
|
@@ -314,9 +314,9 @@ declare namespace sap {
|
|
|
314
314
|
header?: sap.tnt.IToolHeader;
|
|
315
315
|
|
|
316
316
|
/**
|
|
317
|
-
* @since 1.93
|
|
318
|
-
*
|
|
319
317
|
* The control to appear in the subheader area.
|
|
318
|
+
*
|
|
319
|
+
* @since 1.93
|
|
320
320
|
*/
|
|
321
321
|
subHeader?: sap.tnt.IToolHeader;
|
|
322
322
|
|
|
@@ -357,8 +357,6 @@ declare namespace sap {
|
|
|
357
357
|
}
|
|
358
358
|
|
|
359
359
|
/**
|
|
360
|
-
* @since 1.54
|
|
361
|
-
*
|
|
362
360
|
* The `InfoLabel` is a small non-interactive control which contains text information and non-semantic color
|
|
363
361
|
* chosen from a list of predefined color schemes. It serves the purpose to attract the user attention to
|
|
364
362
|
* some piece of information (state, quantity, condition, etc.).
|
|
@@ -379,6 +377,8 @@ declare namespace sap {
|
|
|
379
377
|
* - Colors are not semantic and have no visual representation in sap_belize_hcb, sap_belize_hcw, sap_fiori_3_hcb
|
|
380
378
|
* and sap_fiori_3_hcw themes.
|
|
381
379
|
* - The control shows plain text only, formatting is not visualized.
|
|
380
|
+
*
|
|
381
|
+
* @since 1.54
|
|
382
382
|
*/
|
|
383
383
|
class InfoLabel
|
|
384
384
|
extends sap.ui.core.Control
|
|
@@ -421,6 +421,7 @@ declare namespace sap {
|
|
|
421
421
|
*
|
|
422
422
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
|
|
423
423
|
*
|
|
424
|
+
*
|
|
424
425
|
* @returns Created class / constructor function
|
|
425
426
|
*/
|
|
426
427
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -441,6 +442,7 @@ declare namespace sap {
|
|
|
441
442
|
/**
|
|
442
443
|
* Returns a metadata object for class sap.tnt.InfoLabel.
|
|
443
444
|
*
|
|
445
|
+
*
|
|
444
446
|
* @returns Metadata object describing this class
|
|
445
447
|
*/
|
|
446
448
|
static getMetadata(): sap.ui.core.ElementMetadata;
|
|
@@ -450,6 +452,7 @@ declare namespace sap {
|
|
|
450
452
|
* See {@link sap.ui.base.ManagedObject#bindProperty ManagedObject.bindProperty} for a detailed description
|
|
451
453
|
* of the possible properties of `oBindingInfo`
|
|
452
454
|
*
|
|
455
|
+
*
|
|
453
456
|
* @returns Reference to `this` in order to allow method chaining
|
|
454
457
|
*/
|
|
455
458
|
bindText(
|
|
@@ -468,6 +471,7 @@ declare namespace sap {
|
|
|
468
471
|
*
|
|
469
472
|
* Default value is `7`.
|
|
470
473
|
*
|
|
474
|
+
*
|
|
471
475
|
* @returns Value of property `colorScheme`
|
|
472
476
|
*/
|
|
473
477
|
getColorScheme(): int;
|
|
@@ -479,12 +483,11 @@ declare namespace sap {
|
|
|
479
483
|
*
|
|
480
484
|
* Default value is `false`.
|
|
481
485
|
*
|
|
486
|
+
*
|
|
482
487
|
* @returns Value of property `displayOnly`
|
|
483
488
|
*/
|
|
484
489
|
getDisplayOnly(): boolean;
|
|
485
490
|
/**
|
|
486
|
-
* @since 1.74
|
|
487
|
-
*
|
|
488
491
|
* Gets current value of property {@link #getIcon icon}.
|
|
489
492
|
*
|
|
490
493
|
* Defines the icon to be displayed as graphical element within the `InfoLabel`. It can be an icon from
|
|
@@ -492,6 +495,8 @@ declare namespace sap {
|
|
|
492
495
|
*
|
|
493
496
|
* Default value is `empty string`.
|
|
494
497
|
*
|
|
498
|
+
* @since 1.74
|
|
499
|
+
*
|
|
495
500
|
* @returns Value of property `icon`
|
|
496
501
|
*/
|
|
497
502
|
getIcon(): sap.ui.core.URI;
|
|
@@ -504,6 +509,7 @@ declare namespace sap {
|
|
|
504
509
|
*
|
|
505
510
|
* Default value is `Loose`.
|
|
506
511
|
*
|
|
512
|
+
*
|
|
507
513
|
* @returns Value of property `renderMode`
|
|
508
514
|
*/
|
|
509
515
|
getRenderMode(): sap.tnt.RenderMode;
|
|
@@ -514,6 +520,7 @@ declare namespace sap {
|
|
|
514
520
|
*
|
|
515
521
|
* Default value is `empty string`.
|
|
516
522
|
*
|
|
523
|
+
*
|
|
517
524
|
* @returns Value of property `text`
|
|
518
525
|
*/
|
|
519
526
|
getText(): string;
|
|
@@ -525,6 +532,7 @@ declare namespace sap {
|
|
|
525
532
|
*
|
|
526
533
|
* Default value is `Inherit`.
|
|
527
534
|
*
|
|
535
|
+
*
|
|
528
536
|
* @returns Value of property `textDirection`
|
|
529
537
|
*/
|
|
530
538
|
getTextDirection(): sap.ui.core.TextDirection;
|
|
@@ -534,6 +542,7 @@ declare namespace sap {
|
|
|
534
542
|
* Specifies the width of the `InfoLabel` control. By default, the `InfoLabel` control has the width of
|
|
535
543
|
* the content. Set this property to restrict the width to a custom value.
|
|
536
544
|
*
|
|
545
|
+
*
|
|
537
546
|
* @returns Value of property `width`
|
|
538
547
|
*/
|
|
539
548
|
getWidth(): sap.ui.core.CSSSize;
|
|
@@ -549,6 +558,7 @@ declare namespace sap {
|
|
|
549
558
|
*
|
|
550
559
|
* Default value is `7`.
|
|
551
560
|
*
|
|
561
|
+
*
|
|
552
562
|
* @returns Reference to `this` in order to allow method chaining
|
|
553
563
|
*/
|
|
554
564
|
setColorScheme(
|
|
@@ -567,6 +577,7 @@ declare namespace sap {
|
|
|
567
577
|
*
|
|
568
578
|
* Default value is `false`.
|
|
569
579
|
*
|
|
580
|
+
*
|
|
570
581
|
* @returns Reference to `this` in order to allow method chaining
|
|
571
582
|
*/
|
|
572
583
|
setDisplayOnly(
|
|
@@ -576,8 +587,6 @@ declare namespace sap {
|
|
|
576
587
|
bDisplayOnly?: boolean
|
|
577
588
|
): this;
|
|
578
589
|
/**
|
|
579
|
-
* @since 1.74
|
|
580
|
-
*
|
|
581
590
|
* Sets a new value for property {@link #getIcon icon}.
|
|
582
591
|
*
|
|
583
592
|
* Defines the icon to be displayed as graphical element within the `InfoLabel`. It can be an icon from
|
|
@@ -587,6 +596,8 @@ declare namespace sap {
|
|
|
587
596
|
*
|
|
588
597
|
* Default value is `empty string`.
|
|
589
598
|
*
|
|
599
|
+
* @since 1.74
|
|
600
|
+
*
|
|
590
601
|
* @returns Reference to `this` in order to allow method chaining
|
|
591
602
|
*/
|
|
592
603
|
setIcon(
|
|
@@ -606,6 +617,7 @@ declare namespace sap {
|
|
|
606
617
|
*
|
|
607
618
|
* Default value is `Loose`.
|
|
608
619
|
*
|
|
620
|
+
*
|
|
609
621
|
* @returns Reference to `this` in order to allow method chaining
|
|
610
622
|
*/
|
|
611
623
|
setRenderMode(
|
|
@@ -623,6 +635,7 @@ declare namespace sap {
|
|
|
623
635
|
*
|
|
624
636
|
* Default value is `empty string`.
|
|
625
637
|
*
|
|
638
|
+
*
|
|
626
639
|
* @returns Reference to `this` in order to allow method chaining
|
|
627
640
|
*/
|
|
628
641
|
setText(
|
|
@@ -641,6 +654,7 @@ declare namespace sap {
|
|
|
641
654
|
*
|
|
642
655
|
* Default value is `Inherit`.
|
|
643
656
|
*
|
|
657
|
+
*
|
|
644
658
|
* @returns Reference to `this` in order to allow method chaining
|
|
645
659
|
*/
|
|
646
660
|
setTextDirection(
|
|
@@ -657,6 +671,7 @@ declare namespace sap {
|
|
|
657
671
|
*
|
|
658
672
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
659
673
|
*
|
|
674
|
+
*
|
|
660
675
|
* @returns Reference to `this` in order to allow method chaining
|
|
661
676
|
*/
|
|
662
677
|
setWidth(
|
|
@@ -668,15 +683,16 @@ declare namespace sap {
|
|
|
668
683
|
/**
|
|
669
684
|
* Unbinds property {@link #getText text} from model data.
|
|
670
685
|
*
|
|
686
|
+
*
|
|
671
687
|
* @returns Reference to `this` in order to allow method chaining
|
|
672
688
|
*/
|
|
673
689
|
unbindText(): this;
|
|
674
690
|
}
|
|
675
691
|
/**
|
|
676
|
-
* @since 1.34
|
|
677
|
-
*
|
|
678
692
|
* The NavigationList control is an interactive control, which provides a choice of different items, ordered
|
|
679
693
|
* as a list.
|
|
694
|
+
*
|
|
695
|
+
* @since 1.34
|
|
680
696
|
*/
|
|
681
697
|
class NavigationList extends sap.ui.core.Control {
|
|
682
698
|
/**
|
|
@@ -716,6 +732,7 @@ declare namespace sap {
|
|
|
716
732
|
*
|
|
717
733
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
|
|
718
734
|
*
|
|
735
|
+
*
|
|
719
736
|
* @returns Created class / constructor function
|
|
720
737
|
*/
|
|
721
738
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -736,12 +753,14 @@ declare namespace sap {
|
|
|
736
753
|
/**
|
|
737
754
|
* Returns a metadata object for class sap.tnt.NavigationList.
|
|
738
755
|
*
|
|
756
|
+
*
|
|
739
757
|
* @returns Metadata object describing this class
|
|
740
758
|
*/
|
|
741
759
|
static getMetadata(): sap.ui.core.ElementMetadata;
|
|
742
760
|
/**
|
|
743
761
|
* Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
|
|
744
762
|
*
|
|
763
|
+
*
|
|
745
764
|
* @returns Reference to `this` in order to allow method chaining
|
|
746
765
|
*/
|
|
747
766
|
addAriaDescribedBy(
|
|
@@ -753,6 +772,7 @@ declare namespace sap {
|
|
|
753
772
|
/**
|
|
754
773
|
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
|
|
755
774
|
*
|
|
775
|
+
*
|
|
756
776
|
* @returns Reference to `this` in order to allow method chaining
|
|
757
777
|
*/
|
|
758
778
|
addAriaLabelledBy(
|
|
@@ -764,6 +784,7 @@ declare namespace sap {
|
|
|
764
784
|
/**
|
|
765
785
|
* Adds some item to the aggregation {@link #getItems items}.
|
|
766
786
|
*
|
|
787
|
+
*
|
|
767
788
|
* @returns Reference to `this` in order to allow method chaining
|
|
768
789
|
*/
|
|
769
790
|
addItem(
|
|
@@ -780,6 +801,7 @@ declare namespace sap {
|
|
|
780
801
|
*
|
|
781
802
|
* Fired when an item is selected.
|
|
782
803
|
*
|
|
804
|
+
*
|
|
783
805
|
* @returns Reference to `this` in order to allow method chaining
|
|
784
806
|
*/
|
|
785
807
|
attachItemSelect(
|
|
@@ -805,6 +827,7 @@ declare namespace sap {
|
|
|
805
827
|
*
|
|
806
828
|
* Fired when an item is selected.
|
|
807
829
|
*
|
|
830
|
+
*
|
|
808
831
|
* @returns Reference to `this` in order to allow method chaining
|
|
809
832
|
*/
|
|
810
833
|
attachItemSelect(
|
|
@@ -820,6 +843,7 @@ declare namespace sap {
|
|
|
820
843
|
/**
|
|
821
844
|
* Destroys all the items in the aggregation {@link #getItems items}.
|
|
822
845
|
*
|
|
846
|
+
*
|
|
823
847
|
* @returns Reference to `this` in order to allow method chaining
|
|
824
848
|
*/
|
|
825
849
|
destroyItems(): this;
|
|
@@ -828,6 +852,7 @@ declare namespace sap {
|
|
|
828
852
|
*
|
|
829
853
|
* The passed function and listener object must match the ones used for event registration.
|
|
830
854
|
*
|
|
855
|
+
*
|
|
831
856
|
* @returns Reference to `this` in order to allow method chaining
|
|
832
857
|
*/
|
|
833
858
|
detachItemSelect(
|
|
@@ -841,10 +866,10 @@ declare namespace sap {
|
|
|
841
866
|
oListener?: object
|
|
842
867
|
): this;
|
|
843
868
|
/**
|
|
844
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
845
|
-
*
|
|
846
869
|
* Fires event {@link #event:itemSelect itemSelect} to attached listeners.
|
|
847
870
|
*
|
|
871
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
872
|
+
*
|
|
848
873
|
* @returns Reference to `this` in order to allow method chaining
|
|
849
874
|
*/
|
|
850
875
|
fireItemSelect(
|
|
@@ -868,6 +893,7 @@ declare namespace sap {
|
|
|
868
893
|
*
|
|
869
894
|
* Default value is `true`.
|
|
870
895
|
*
|
|
896
|
+
*
|
|
871
897
|
* @returns Value of property `expanded`
|
|
872
898
|
*/
|
|
873
899
|
getExpanded(): boolean;
|
|
@@ -880,16 +906,17 @@ declare namespace sap {
|
|
|
880
906
|
/**
|
|
881
907
|
* Gets the currently selected `NavigationListItem`.
|
|
882
908
|
*
|
|
909
|
+
*
|
|
883
910
|
* @returns The selected item or `null` if nothing is selected
|
|
884
911
|
*/
|
|
885
912
|
getSelectedItem(): sap.tnt.NavigationListItem | null;
|
|
886
913
|
/**
|
|
887
|
-
* @since 1.62.0
|
|
888
|
-
*
|
|
889
914
|
* Gets current value of property {@link #getSelectedKey selectedKey}.
|
|
890
915
|
*
|
|
891
916
|
* Specifies the currently selected key.
|
|
892
917
|
*
|
|
918
|
+
* @since 1.62.0
|
|
919
|
+
*
|
|
893
920
|
* @returns Value of property `selectedKey`
|
|
894
921
|
*/
|
|
895
922
|
getSelectedKey(): string;
|
|
@@ -898,6 +925,7 @@ declare namespace sap {
|
|
|
898
925
|
*
|
|
899
926
|
* Specifies the width of the control.
|
|
900
927
|
*
|
|
928
|
+
*
|
|
901
929
|
* @returns Value of property `width`
|
|
902
930
|
*/
|
|
903
931
|
getWidth(): sap.ui.core.CSSSize;
|
|
@@ -905,6 +933,7 @@ declare namespace sap {
|
|
|
905
933
|
* Checks for the provided `sap.tnt.NavigationListItem` in the aggregation {@link #getItems items}. and
|
|
906
934
|
* returns its index if found or -1 otherwise.
|
|
907
935
|
*
|
|
936
|
+
*
|
|
908
937
|
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
909
938
|
*/
|
|
910
939
|
indexOfItem(
|
|
@@ -916,6 +945,7 @@ declare namespace sap {
|
|
|
916
945
|
/**
|
|
917
946
|
* Inserts a item into the aggregation {@link #getItems items}.
|
|
918
947
|
*
|
|
948
|
+
*
|
|
919
949
|
* @returns Reference to `this` in order to allow method chaining
|
|
920
950
|
*/
|
|
921
951
|
insertItem(
|
|
@@ -933,12 +963,14 @@ declare namespace sap {
|
|
|
933
963
|
/**
|
|
934
964
|
* Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
|
|
935
965
|
*
|
|
966
|
+
*
|
|
936
967
|
* @returns An array of the removed elements (might be empty)
|
|
937
968
|
*/
|
|
938
969
|
removeAllAriaDescribedBy(): sap.ui.core.ID[];
|
|
939
970
|
/**
|
|
940
971
|
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
|
|
941
972
|
*
|
|
973
|
+
*
|
|
942
974
|
* @returns An array of the removed elements (might be empty)
|
|
943
975
|
*/
|
|
944
976
|
removeAllAriaLabelledBy(): sap.ui.core.ID[];
|
|
@@ -947,12 +979,14 @@ declare namespace sap {
|
|
|
947
979
|
*
|
|
948
980
|
* Additionally, it unregisters them from the hosting UIArea.
|
|
949
981
|
*
|
|
982
|
+
*
|
|
950
983
|
* @returns An array of the removed elements (might be empty)
|
|
951
984
|
*/
|
|
952
985
|
removeAllItems(): sap.tnt.NavigationListItem[];
|
|
953
986
|
/**
|
|
954
987
|
* Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
|
|
955
988
|
*
|
|
989
|
+
*
|
|
956
990
|
* @returns The removed ariaDescribedBy or `null`
|
|
957
991
|
*/
|
|
958
992
|
removeAriaDescribedBy(
|
|
@@ -964,6 +998,7 @@ declare namespace sap {
|
|
|
964
998
|
/**
|
|
965
999
|
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
|
|
966
1000
|
*
|
|
1001
|
+
*
|
|
967
1002
|
* @returns The removed ariaLabelledBy or `null`
|
|
968
1003
|
*/
|
|
969
1004
|
removeAriaLabelledBy(
|
|
@@ -975,6 +1010,7 @@ declare namespace sap {
|
|
|
975
1010
|
/**
|
|
976
1011
|
* Removes a item from the aggregation {@link #getItems items}.
|
|
977
1012
|
*
|
|
1013
|
+
*
|
|
978
1014
|
* @returns The removed item or `null`
|
|
979
1015
|
*/
|
|
980
1016
|
removeItem(
|
|
@@ -992,6 +1028,7 @@ declare namespace sap {
|
|
|
992
1028
|
*
|
|
993
1029
|
* Default value is `true`.
|
|
994
1030
|
*
|
|
1031
|
+
*
|
|
995
1032
|
* @returns Reference to `this` in order to allow method chaining
|
|
996
1033
|
*/
|
|
997
1034
|
setExpanded(
|
|
@@ -1003,6 +1040,7 @@ declare namespace sap {
|
|
|
1003
1040
|
/**
|
|
1004
1041
|
* Sets the association for selectedItem. Set `null` to deselect.
|
|
1005
1042
|
*
|
|
1043
|
+
*
|
|
1006
1044
|
* @returns The `selectedItem` association
|
|
1007
1045
|
*/
|
|
1008
1046
|
setSelectedItem(
|
|
@@ -1014,6 +1052,7 @@ declare namespace sap {
|
|
|
1014
1052
|
/**
|
|
1015
1053
|
* Sets the selected item based on a key.
|
|
1016
1054
|
*
|
|
1055
|
+
*
|
|
1017
1056
|
* @returns this pointer for chaining
|
|
1018
1057
|
*/
|
|
1019
1058
|
setSelectedKey(
|
|
@@ -1029,6 +1068,7 @@ declare namespace sap {
|
|
|
1029
1068
|
*
|
|
1030
1069
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1031
1070
|
*
|
|
1071
|
+
*
|
|
1032
1072
|
* @returns Reference to `this` in order to allow method chaining
|
|
1033
1073
|
*/
|
|
1034
1074
|
setWidth(
|
|
@@ -1039,10 +1079,10 @@ declare namespace sap {
|
|
|
1039
1079
|
): this;
|
|
1040
1080
|
}
|
|
1041
1081
|
/**
|
|
1042
|
-
* @since 1.34
|
|
1043
|
-
*
|
|
1044
1082
|
* The NavigationListItem control represents an action, which can be selected by the user. It can provide
|
|
1045
1083
|
* sub items.
|
|
1084
|
+
*
|
|
1085
|
+
* @since 1.34
|
|
1046
1086
|
*/
|
|
1047
1087
|
class NavigationListItem extends sap.ui.core.Item {
|
|
1048
1088
|
/**
|
|
@@ -1082,6 +1122,7 @@ declare namespace sap {
|
|
|
1082
1122
|
*
|
|
1083
1123
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Item.extend}.
|
|
1084
1124
|
*
|
|
1125
|
+
*
|
|
1085
1126
|
* @returns Created class / constructor function
|
|
1086
1127
|
*/
|
|
1087
1128
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -1102,12 +1143,14 @@ declare namespace sap {
|
|
|
1102
1143
|
/**
|
|
1103
1144
|
* Returns a metadata object for class sap.tnt.NavigationListItem.
|
|
1104
1145
|
*
|
|
1146
|
+
*
|
|
1105
1147
|
* @returns Metadata object describing this class
|
|
1106
1148
|
*/
|
|
1107
1149
|
static getMetadata(): sap.ui.core.ElementMetadata;
|
|
1108
1150
|
/**
|
|
1109
1151
|
* Adds some item to the aggregation {@link #getItems items}.
|
|
1110
1152
|
*
|
|
1153
|
+
*
|
|
1111
1154
|
* @returns Reference to `this` in order to allow method chaining
|
|
1112
1155
|
*/
|
|
1113
1156
|
addItem(
|
|
@@ -1124,6 +1167,7 @@ declare namespace sap {
|
|
|
1124
1167
|
*
|
|
1125
1168
|
* Fired when this item is selected.
|
|
1126
1169
|
*
|
|
1170
|
+
*
|
|
1127
1171
|
* @returns Reference to `this` in order to allow method chaining
|
|
1128
1172
|
*/
|
|
1129
1173
|
attachSelect(
|
|
@@ -1149,6 +1193,7 @@ declare namespace sap {
|
|
|
1149
1193
|
*
|
|
1150
1194
|
* Fired when this item is selected.
|
|
1151
1195
|
*
|
|
1196
|
+
*
|
|
1152
1197
|
* @returns Reference to `this` in order to allow method chaining
|
|
1153
1198
|
*/
|
|
1154
1199
|
attachSelect(
|
|
@@ -1164,6 +1209,7 @@ declare namespace sap {
|
|
|
1164
1209
|
/**
|
|
1165
1210
|
* Destroys all the items in the aggregation {@link #getItems items}.
|
|
1166
1211
|
*
|
|
1212
|
+
*
|
|
1167
1213
|
* @returns Reference to `this` in order to allow method chaining
|
|
1168
1214
|
*/
|
|
1169
1215
|
destroyItems(): this;
|
|
@@ -1172,6 +1218,7 @@ declare namespace sap {
|
|
|
1172
1218
|
*
|
|
1173
1219
|
* The passed function and listener object must match the ones used for event registration.
|
|
1174
1220
|
*
|
|
1221
|
+
*
|
|
1175
1222
|
* @returns Reference to `this` in order to allow method chaining
|
|
1176
1223
|
*/
|
|
1177
1224
|
detachSelect(
|
|
@@ -1185,10 +1232,10 @@ declare namespace sap {
|
|
|
1185
1232
|
oListener?: object
|
|
1186
1233
|
): this;
|
|
1187
1234
|
/**
|
|
1188
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1189
|
-
*
|
|
1190
1235
|
* Fires event {@link #event:select select} to attached listeners.
|
|
1191
1236
|
*
|
|
1237
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1238
|
+
*
|
|
1192
1239
|
* @returns Reference to `this` in order to allow method chaining
|
|
1193
1240
|
*/
|
|
1194
1241
|
fireSelect(
|
|
@@ -1204,14 +1251,15 @@ declare namespace sap {
|
|
|
1204
1251
|
*
|
|
1205
1252
|
* Default value is `true`.
|
|
1206
1253
|
*
|
|
1254
|
+
*
|
|
1207
1255
|
* @returns Value of property `expanded`
|
|
1208
1256
|
*/
|
|
1209
1257
|
getExpanded(): boolean;
|
|
1210
1258
|
/**
|
|
1211
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1212
|
-
*
|
|
1213
1259
|
* Returns the DOM Element that should get the focus.
|
|
1214
1260
|
*
|
|
1261
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1262
|
+
*
|
|
1215
1263
|
* @returns Returns the DOM Element that should get the focus
|
|
1216
1264
|
*/
|
|
1217
1265
|
getFocusDomRef(): Element;
|
|
@@ -1222,6 +1270,7 @@ declare namespace sap {
|
|
|
1222
1270
|
*
|
|
1223
1271
|
* Default value is `true`.
|
|
1224
1272
|
*
|
|
1273
|
+
*
|
|
1225
1274
|
* @returns Value of property `hasExpander`
|
|
1226
1275
|
*/
|
|
1227
1276
|
getHasExpander(): boolean;
|
|
@@ -1231,6 +1280,7 @@ declare namespace sap {
|
|
|
1231
1280
|
* Defines the link target URI. Supports standard hyperlink behavior. If a JavaScript action should be triggered,
|
|
1232
1281
|
* this should not be set, but instead an event handler for the `select` event should be registered.
|
|
1233
1282
|
*
|
|
1283
|
+
*
|
|
1234
1284
|
* @returns Value of property `href`
|
|
1235
1285
|
*/
|
|
1236
1286
|
getHref(): sap.ui.core.URI;
|
|
@@ -1241,6 +1291,7 @@ declare namespace sap {
|
|
|
1241
1291
|
*
|
|
1242
1292
|
* Default value is `empty string`.
|
|
1243
1293
|
*
|
|
1294
|
+
*
|
|
1244
1295
|
* @returns Value of property `icon`
|
|
1245
1296
|
*/
|
|
1246
1297
|
getIcon(): sap.ui.core.URI;
|
|
@@ -1251,16 +1302,16 @@ declare namespace sap {
|
|
|
1251
1302
|
*/
|
|
1252
1303
|
getItems(): sap.tnt.NavigationListItem[];
|
|
1253
1304
|
/**
|
|
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
1305
|
* Gets current value of property {@link #getSelectable selectable}.
|
|
1259
1306
|
*
|
|
1260
1307
|
* Specifies if the item can be selected.
|
|
1261
1308
|
*
|
|
1262
1309
|
* Default value is `true`.
|
|
1263
1310
|
*
|
|
1311
|
+
* @since 1.116
|
|
1312
|
+
* @experimental (since 1.116) - Disclaimer: this property is in a beta state - incompatible API changes
|
|
1313
|
+
* may be done before its official public release.
|
|
1314
|
+
*
|
|
1264
1315
|
* @returns Value of property `selectable`
|
|
1265
1316
|
*/
|
|
1266
1317
|
getSelectable(): boolean;
|
|
@@ -1273,18 +1324,19 @@ declare namespace sap {
|
|
|
1273
1324
|
* `_search`. Alternatively, a frame name can be entered. This property is only used when the `href` property
|
|
1274
1325
|
* is set.
|
|
1275
1326
|
*
|
|
1327
|
+
*
|
|
1276
1328
|
* @returns Value of property `target`
|
|
1277
1329
|
*/
|
|
1278
1330
|
getTarget(): string;
|
|
1279
1331
|
/**
|
|
1280
|
-
* @since 1.52
|
|
1281
|
-
*
|
|
1282
1332
|
* Gets current value of property {@link #getVisible visible}.
|
|
1283
1333
|
*
|
|
1284
1334
|
* Specifies if the item should be shown.
|
|
1285
1335
|
*
|
|
1286
1336
|
* Default value is `true`.
|
|
1287
1337
|
*
|
|
1338
|
+
* @since 1.52
|
|
1339
|
+
*
|
|
1288
1340
|
* @returns Value of property `visible`
|
|
1289
1341
|
*/
|
|
1290
1342
|
getVisible(): boolean;
|
|
@@ -1292,6 +1344,7 @@ declare namespace sap {
|
|
|
1292
1344
|
* Checks for the provided `sap.tnt.NavigationListItem` in the aggregation {@link #getItems items}. and
|
|
1293
1345
|
* returns its index if found or -1 otherwise.
|
|
1294
1346
|
*
|
|
1347
|
+
*
|
|
1295
1348
|
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
1296
1349
|
*/
|
|
1297
1350
|
indexOfItem(
|
|
@@ -1303,6 +1356,7 @@ declare namespace sap {
|
|
|
1303
1356
|
/**
|
|
1304
1357
|
* Inserts a item into the aggregation {@link #getItems items}.
|
|
1305
1358
|
*
|
|
1359
|
+
*
|
|
1306
1360
|
* @returns Reference to `this` in order to allow method chaining
|
|
1307
1361
|
*/
|
|
1308
1362
|
insertItem(
|
|
@@ -1322,12 +1376,14 @@ declare namespace sap {
|
|
|
1322
1376
|
*
|
|
1323
1377
|
* Additionally, it unregisters them from the hosting UIArea.
|
|
1324
1378
|
*
|
|
1379
|
+
*
|
|
1325
1380
|
* @returns An array of the removed elements (might be empty)
|
|
1326
1381
|
*/
|
|
1327
1382
|
removeAllItems(): sap.tnt.NavigationListItem[];
|
|
1328
1383
|
/**
|
|
1329
1384
|
* Removes a item from the aggregation {@link #getItems items}.
|
|
1330
1385
|
*
|
|
1386
|
+
*
|
|
1331
1387
|
* @returns The removed item or `null`
|
|
1332
1388
|
*/
|
|
1333
1389
|
removeItem(
|
|
@@ -1345,6 +1401,7 @@ declare namespace sap {
|
|
|
1345
1401
|
*
|
|
1346
1402
|
* Default value is `true`.
|
|
1347
1403
|
*
|
|
1404
|
+
*
|
|
1348
1405
|
* @returns Reference to `this` in order to allow method chaining
|
|
1349
1406
|
*/
|
|
1350
1407
|
setExpanded(
|
|
@@ -1362,6 +1419,7 @@ declare namespace sap {
|
|
|
1362
1419
|
*
|
|
1363
1420
|
* Default value is `true`.
|
|
1364
1421
|
*
|
|
1422
|
+
*
|
|
1365
1423
|
* @returns Reference to `this` in order to allow method chaining
|
|
1366
1424
|
*/
|
|
1367
1425
|
setHasExpander(
|
|
@@ -1378,6 +1436,7 @@ declare namespace sap {
|
|
|
1378
1436
|
*
|
|
1379
1437
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1380
1438
|
*
|
|
1439
|
+
*
|
|
1381
1440
|
* @returns Reference to `this` in order to allow method chaining
|
|
1382
1441
|
*/
|
|
1383
1442
|
setHref(
|
|
@@ -1395,6 +1454,7 @@ declare namespace sap {
|
|
|
1395
1454
|
*
|
|
1396
1455
|
* Default value is `empty string`.
|
|
1397
1456
|
*
|
|
1457
|
+
*
|
|
1398
1458
|
* @returns Reference to `this` in order to allow method chaining
|
|
1399
1459
|
*/
|
|
1400
1460
|
setIcon(
|
|
@@ -1404,10 +1464,6 @@ declare namespace sap {
|
|
|
1404
1464
|
sIcon?: sap.ui.core.URI
|
|
1405
1465
|
): this;
|
|
1406
1466
|
/**
|
|
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
1467
|
* Sets a new value for property {@link #getSelectable selectable}.
|
|
1412
1468
|
*
|
|
1413
1469
|
* Specifies if the item can be selected.
|
|
@@ -1416,6 +1472,10 @@ declare namespace sap {
|
|
|
1416
1472
|
*
|
|
1417
1473
|
* Default value is `true`.
|
|
1418
1474
|
*
|
|
1475
|
+
* @since 1.116
|
|
1476
|
+
* @experimental (since 1.116) - Disclaimer: this property is in a beta state - incompatible API changes
|
|
1477
|
+
* may be done before its official public release.
|
|
1478
|
+
*
|
|
1419
1479
|
* @returns Reference to `this` in order to allow method chaining
|
|
1420
1480
|
*/
|
|
1421
1481
|
setSelectable(
|
|
@@ -1435,6 +1495,7 @@ declare namespace sap {
|
|
|
1435
1495
|
*
|
|
1436
1496
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1437
1497
|
*
|
|
1498
|
+
*
|
|
1438
1499
|
* @returns Reference to `this` in order to allow method chaining
|
|
1439
1500
|
*/
|
|
1440
1501
|
setTarget(
|
|
@@ -1444,8 +1505,6 @@ declare namespace sap {
|
|
|
1444
1505
|
sTarget?: string
|
|
1445
1506
|
): this;
|
|
1446
1507
|
/**
|
|
1447
|
-
* @since 1.52
|
|
1448
|
-
*
|
|
1449
1508
|
* Sets a new value for property {@link #getVisible visible}.
|
|
1450
1509
|
*
|
|
1451
1510
|
* Specifies if the item should be shown.
|
|
@@ -1454,6 +1513,8 @@ declare namespace sap {
|
|
|
1454
1513
|
*
|
|
1455
1514
|
* Default value is `true`.
|
|
1456
1515
|
*
|
|
1516
|
+
* @since 1.52
|
|
1517
|
+
*
|
|
1457
1518
|
* @returns Reference to `this` in order to allow method chaining
|
|
1458
1519
|
*/
|
|
1459
1520
|
setVisible(
|
|
@@ -1464,13 +1525,13 @@ declare namespace sap {
|
|
|
1464
1525
|
): this;
|
|
1465
1526
|
}
|
|
1466
1527
|
/**
|
|
1467
|
-
* @since 1.34
|
|
1468
|
-
*
|
|
1469
1528
|
* The SideNavigation control is a container, which consists of flexible and fixed parts on top of each
|
|
1470
1529
|
* other. Responsive Behavior:
|
|
1471
1530
|
* - The flexible part adapts its size to the fixed one.
|
|
1472
1531
|
* - The flexible part has a scrollbar when the content is larger than the available space. **Note:**
|
|
1473
1532
|
* In order for the SideNavigation to stretch properly, its parent layout control should only be the sap.tnt.ToolPage.
|
|
1533
|
+
*
|
|
1534
|
+
* @since 1.34
|
|
1474
1535
|
*/
|
|
1475
1536
|
class SideNavigation extends sap.ui.core.Control {
|
|
1476
1537
|
/**
|
|
@@ -1510,6 +1571,7 @@ declare namespace sap {
|
|
|
1510
1571
|
*
|
|
1511
1572
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
|
|
1512
1573
|
*
|
|
1574
|
+
*
|
|
1513
1575
|
* @returns Created class / constructor function
|
|
1514
1576
|
*/
|
|
1515
1577
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -1530,6 +1592,7 @@ declare namespace sap {
|
|
|
1530
1592
|
/**
|
|
1531
1593
|
* Returns a metadata object for class sap.tnt.SideNavigation.
|
|
1532
1594
|
*
|
|
1595
|
+
*
|
|
1533
1596
|
* @returns Metadata object describing this class
|
|
1534
1597
|
*/
|
|
1535
1598
|
static getMetadata(): sap.ui.core.ElementMetadata;
|
|
@@ -1541,6 +1604,7 @@ declare namespace sap {
|
|
|
1541
1604
|
*
|
|
1542
1605
|
* Fired when an item is selected.
|
|
1543
1606
|
*
|
|
1607
|
+
*
|
|
1544
1608
|
* @returns Reference to `this` in order to allow method chaining
|
|
1545
1609
|
*/
|
|
1546
1610
|
attachItemSelect(
|
|
@@ -1566,6 +1630,7 @@ declare namespace sap {
|
|
|
1566
1630
|
*
|
|
1567
1631
|
* Fired when an item is selected.
|
|
1568
1632
|
*
|
|
1633
|
+
*
|
|
1569
1634
|
* @returns Reference to `this` in order to allow method chaining
|
|
1570
1635
|
*/
|
|
1571
1636
|
attachItemSelect(
|
|
@@ -1584,6 +1649,7 @@ declare namespace sap {
|
|
|
1584
1649
|
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a detailed description
|
|
1585
1650
|
* of the possible properties of `oBindingInfo`.
|
|
1586
1651
|
*
|
|
1652
|
+
*
|
|
1587
1653
|
* @returns Reference to `this` in order to allow method chaining
|
|
1588
1654
|
*/
|
|
1589
1655
|
bindItem(
|
|
@@ -1595,20 +1661,22 @@ declare namespace sap {
|
|
|
1595
1661
|
/**
|
|
1596
1662
|
* Destroys the fixedItem in the aggregation {@link #getFixedItem fixedItem}.
|
|
1597
1663
|
*
|
|
1664
|
+
*
|
|
1598
1665
|
* @returns Reference to `this` in order to allow method chaining
|
|
1599
1666
|
*/
|
|
1600
1667
|
destroyFixedItem(): this;
|
|
1601
1668
|
/**
|
|
1602
|
-
* @deprecated (since 1.120) - Use the aggregation `fixedItem` instead.
|
|
1603
|
-
*
|
|
1604
1669
|
* Destroys the footer in the aggregation {@link #getFooter footer}.
|
|
1605
1670
|
*
|
|
1671
|
+
* @deprecated (since 1.120) - Use the aggregation `fixedItem` instead.
|
|
1672
|
+
*
|
|
1606
1673
|
* @returns Reference to `this` in order to allow method chaining
|
|
1607
1674
|
*/
|
|
1608
1675
|
destroyFooter(): this;
|
|
1609
1676
|
/**
|
|
1610
1677
|
* Destroys the item in the aggregation {@link #getItem item}.
|
|
1611
1678
|
*
|
|
1679
|
+
*
|
|
1612
1680
|
* @returns Reference to `this` in order to allow method chaining
|
|
1613
1681
|
*/
|
|
1614
1682
|
destroyItem(): this;
|
|
@@ -1617,6 +1685,7 @@ declare namespace sap {
|
|
|
1617
1685
|
*
|
|
1618
1686
|
* The passed function and listener object must match the ones used for event registration.
|
|
1619
1687
|
*
|
|
1688
|
+
*
|
|
1620
1689
|
* @returns Reference to `this` in order to allow method chaining
|
|
1621
1690
|
*/
|
|
1622
1691
|
detachItemSelect(
|
|
@@ -1630,10 +1699,10 @@ declare namespace sap {
|
|
|
1630
1699
|
oListener?: object
|
|
1631
1700
|
): this;
|
|
1632
1701
|
/**
|
|
1633
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1634
|
-
*
|
|
1635
1702
|
* Fires event {@link #event:itemSelect itemSelect} to attached listeners.
|
|
1636
1703
|
*
|
|
1704
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1705
|
+
*
|
|
1637
1706
|
* @returns Reference to `this` in order to allow method chaining
|
|
1638
1707
|
*/
|
|
1639
1708
|
fireItemSelect(
|
|
@@ -1643,12 +1712,12 @@ declare namespace sap {
|
|
|
1643
1712
|
mParameters?: sap.tnt.SideNavigation$ItemSelectEventParameters
|
|
1644
1713
|
): this;
|
|
1645
1714
|
/**
|
|
1646
|
-
* @since 1.98
|
|
1647
|
-
*
|
|
1648
1715
|
* Gets current value of property {@link #getAriaLabel ariaLabel}.
|
|
1649
1716
|
*
|
|
1650
1717
|
* Specifies an optional aria-label that can be used by the screen readers.
|
|
1651
1718
|
*
|
|
1719
|
+
* @since 1.98
|
|
1720
|
+
*
|
|
1652
1721
|
* @returns Value of property `ariaLabel`
|
|
1653
1722
|
*/
|
|
1654
1723
|
getAriaLabel(): string;
|
|
@@ -1659,6 +1728,7 @@ declare namespace sap {
|
|
|
1659
1728
|
*
|
|
1660
1729
|
* Default value is `true`.
|
|
1661
1730
|
*
|
|
1731
|
+
*
|
|
1662
1732
|
* @returns Value of property `expanded`
|
|
1663
1733
|
*/
|
|
1664
1734
|
getExpanded(): boolean;
|
|
@@ -1669,11 +1739,11 @@ declare namespace sap {
|
|
|
1669
1739
|
*/
|
|
1670
1740
|
getFixedItem(): sap.tnt.NavigationList;
|
|
1671
1741
|
/**
|
|
1672
|
-
* @deprecated (since 1.120) - Use the aggregation `fixedItem` instead.
|
|
1673
|
-
*
|
|
1674
1742
|
* Gets content of aggregation {@link #getFooter footer}.
|
|
1675
1743
|
*
|
|
1676
1744
|
* Defines the content inside the footer.
|
|
1745
|
+
*
|
|
1746
|
+
* @deprecated (since 1.120) - Use the aggregation `fixedItem` instead.
|
|
1677
1747
|
*/
|
|
1678
1748
|
getFooter(): sap.tnt.NavigationList;
|
|
1679
1749
|
/**
|
|
@@ -1683,25 +1753,23 @@ declare namespace sap {
|
|
|
1683
1753
|
*/
|
|
1684
1754
|
getItem(): sap.tnt.NavigationList;
|
|
1685
1755
|
/**
|
|
1686
|
-
* @since 1.52.0
|
|
1687
|
-
*
|
|
1688
1756
|
* ID of the element which is the current target of the association {@link #getSelectedItem selectedItem},
|
|
1689
1757
|
* or `null`.
|
|
1758
|
+
*
|
|
1759
|
+
* @since 1.52.0
|
|
1690
1760
|
*/
|
|
1691
1761
|
getSelectedItem(): sap.ui.core.ID;
|
|
1692
1762
|
/**
|
|
1693
|
-
* @since 1.62.0
|
|
1694
|
-
*
|
|
1695
1763
|
* Gets current value of property {@link #getSelectedKey selectedKey}.
|
|
1696
1764
|
*
|
|
1697
1765
|
* Specifies the currently selected key.
|
|
1698
1766
|
*
|
|
1767
|
+
* @since 1.62.0
|
|
1768
|
+
*
|
|
1699
1769
|
* @returns Value of property `selectedKey`
|
|
1700
1770
|
*/
|
|
1701
1771
|
getSelectedKey(): string;
|
|
1702
1772
|
/**
|
|
1703
|
-
* @since 1.120
|
|
1704
|
-
*
|
|
1705
1773
|
* Gets current value of property {@link #getWidth width}.
|
|
1706
1774
|
*
|
|
1707
1775
|
* Specifies the width of the control.
|
|
@@ -1709,18 +1777,20 @@ declare namespace sap {
|
|
|
1709
1777
|
* Depending on the theme, there is a minimum width set (16rem for Horizon theme). This property
|
|
1710
1778
|
* can be used to set a bigger width.
|
|
1711
1779
|
*
|
|
1780
|
+
* @since 1.120
|
|
1781
|
+
*
|
|
1712
1782
|
* @returns Value of property `width`
|
|
1713
1783
|
*/
|
|
1714
1784
|
getWidth(): sap.ui.core.CSSSize;
|
|
1715
1785
|
/**
|
|
1716
|
-
* @since 1.98
|
|
1717
|
-
*
|
|
1718
1786
|
* Sets a new value for property {@link #getAriaLabel ariaLabel}.
|
|
1719
1787
|
*
|
|
1720
1788
|
* Specifies an optional aria-label that can be used by the screen readers.
|
|
1721
1789
|
*
|
|
1722
1790
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1723
1791
|
*
|
|
1792
|
+
* @since 1.98
|
|
1793
|
+
*
|
|
1724
1794
|
* @returns Reference to `this` in order to allow method chaining
|
|
1725
1795
|
*/
|
|
1726
1796
|
setAriaLabel(
|
|
@@ -1732,6 +1802,7 @@ declare namespace sap {
|
|
|
1732
1802
|
/**
|
|
1733
1803
|
* Sets if the control is in expanded or collapsed mode.
|
|
1734
1804
|
*
|
|
1805
|
+
*
|
|
1735
1806
|
* @returns this SideNavigation reference for chaining.
|
|
1736
1807
|
*/
|
|
1737
1808
|
setExpanded(
|
|
@@ -1743,6 +1814,7 @@ declare namespace sap {
|
|
|
1743
1814
|
/**
|
|
1744
1815
|
* Sets the aggregated {@link #getFixedItem fixedItem}.
|
|
1745
1816
|
*
|
|
1817
|
+
*
|
|
1746
1818
|
* @returns Reference to `this` in order to allow method chaining
|
|
1747
1819
|
*/
|
|
1748
1820
|
setFixedItem(
|
|
@@ -1752,10 +1824,10 @@ declare namespace sap {
|
|
|
1752
1824
|
oFixedItem: sap.tnt.NavigationList
|
|
1753
1825
|
): this;
|
|
1754
1826
|
/**
|
|
1755
|
-
* @deprecated (since 1.120) - Use the aggregation `fixedItem` instead.
|
|
1756
|
-
*
|
|
1757
1827
|
* Sets the aggregated {@link #getFooter footer}.
|
|
1758
1828
|
*
|
|
1829
|
+
* @deprecated (since 1.120) - Use the aggregation `fixedItem` instead.
|
|
1830
|
+
*
|
|
1759
1831
|
* @returns Reference to `this` in order to allow method chaining
|
|
1760
1832
|
*/
|
|
1761
1833
|
setFooter(
|
|
@@ -1767,6 +1839,7 @@ declare namespace sap {
|
|
|
1767
1839
|
/**
|
|
1768
1840
|
* Sets the aggregated {@link #getItem item}.
|
|
1769
1841
|
*
|
|
1842
|
+
*
|
|
1770
1843
|
* @returns Reference to `this` in order to allow method chaining
|
|
1771
1844
|
*/
|
|
1772
1845
|
setItem(
|
|
@@ -1778,6 +1851,7 @@ declare namespace sap {
|
|
|
1778
1851
|
/**
|
|
1779
1852
|
* Sets the association for selectedItem
|
|
1780
1853
|
*
|
|
1854
|
+
*
|
|
1781
1855
|
* @returns The `selectedItem` association
|
|
1782
1856
|
*/
|
|
1783
1857
|
setSelectedItem(
|
|
@@ -1789,6 +1863,7 @@ declare namespace sap {
|
|
|
1789
1863
|
/**
|
|
1790
1864
|
* Sets the selected item based on a key.
|
|
1791
1865
|
*
|
|
1866
|
+
*
|
|
1792
1867
|
* @returns this pointer for chaining
|
|
1793
1868
|
*/
|
|
1794
1869
|
setSelectedKey(
|
|
@@ -1798,8 +1873,6 @@ declare namespace sap {
|
|
|
1798
1873
|
selectedKey: string
|
|
1799
1874
|
): this;
|
|
1800
1875
|
/**
|
|
1801
|
-
* @since 1.120
|
|
1802
|
-
*
|
|
1803
1876
|
* Sets a new value for property {@link #getWidth width}.
|
|
1804
1877
|
*
|
|
1805
1878
|
* Specifies the width of the control.
|
|
@@ -1809,6 +1882,8 @@ declare namespace sap {
|
|
|
1809
1882
|
*
|
|
1810
1883
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1811
1884
|
*
|
|
1885
|
+
* @since 1.120
|
|
1886
|
+
*
|
|
1812
1887
|
* @returns Reference to `this` in order to allow method chaining
|
|
1813
1888
|
*/
|
|
1814
1889
|
setWidth(
|
|
@@ -1820,13 +1895,12 @@ declare namespace sap {
|
|
|
1820
1895
|
/**
|
|
1821
1896
|
* Unbinds aggregation {@link #getItem item} from model data.
|
|
1822
1897
|
*
|
|
1898
|
+
*
|
|
1823
1899
|
* @returns Reference to `this` in order to allow method chaining
|
|
1824
1900
|
*/
|
|
1825
1901
|
unbindItem(): this;
|
|
1826
1902
|
}
|
|
1827
1903
|
/**
|
|
1828
|
-
* @since 1.34
|
|
1829
|
-
*
|
|
1830
1904
|
* The ToolHeader control is a horizontal container that is most commonly used to display buttons, texts,
|
|
1831
1905
|
* and other various input controls. Overview: The ToolHeader control is based on {@link sap.m.OverflowToolbar}.
|
|
1832
1906
|
* It contains clearly structured menus of commands that are available across the various apps within the
|
|
@@ -1861,6 +1935,8 @@ declare namespace sap {
|
|
|
1861
1935
|
* in Inline mode only. Semantic colors, icons and separators. sap.f.Avatar/sap.m.Avatar
|
|
1862
1936
|
* Support for default (Accent 6) color. Image avatar. - sap.m.Image
|
|
1863
1937
|
* Primarily used for displaying the company logo. Interaction states
|
|
1938
|
+
*
|
|
1939
|
+
* @since 1.34
|
|
1864
1940
|
*/
|
|
1865
1941
|
class ToolHeader
|
|
1866
1942
|
extends sap.m.OverflowToolbar
|
|
@@ -1909,6 +1985,7 @@ declare namespace sap {
|
|
|
1909
1985
|
*
|
|
1910
1986
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.m.OverflowToolbar.extend}.
|
|
1911
1987
|
*
|
|
1988
|
+
*
|
|
1912
1989
|
* @returns Created class / constructor function
|
|
1913
1990
|
*/
|
|
1914
1991
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -1929,15 +2006,16 @@ declare namespace sap {
|
|
|
1929
2006
|
/**
|
|
1930
2007
|
* Returns a metadata object for class sap.tnt.ToolHeader.
|
|
1931
2008
|
*
|
|
2009
|
+
*
|
|
1932
2010
|
* @returns Metadata object describing this class
|
|
1933
2011
|
*/
|
|
1934
2012
|
static getMetadata(): sap.ui.core.ElementMetadata;
|
|
1935
2013
|
}
|
|
1936
2014
|
/**
|
|
1937
|
-
* @since 1.16
|
|
1938
|
-
*
|
|
1939
2015
|
* The ToolHeaderUtilitySeparator control is used in the sap.tnt.ToolHeader control to specify where the
|
|
1940
2016
|
* overflow button is placed.
|
|
2017
|
+
*
|
|
2018
|
+
* @since 1.16
|
|
1941
2019
|
*/
|
|
1942
2020
|
class ToolHeaderUtilitySeparator extends sap.ui.core.Control {
|
|
1943
2021
|
/**
|
|
@@ -1983,6 +2061,7 @@ declare namespace sap {
|
|
|
1983
2061
|
*
|
|
1984
2062
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
|
|
1985
2063
|
*
|
|
2064
|
+
*
|
|
1986
2065
|
* @returns Created class / constructor function
|
|
1987
2066
|
*/
|
|
1988
2067
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -2003,18 +2082,19 @@ declare namespace sap {
|
|
|
2003
2082
|
/**
|
|
2004
2083
|
* Returns a metadata object for class sap.tnt.ToolHeaderUtilitySeparator.
|
|
2005
2084
|
*
|
|
2085
|
+
*
|
|
2006
2086
|
* @returns Metadata object describing this class
|
|
2007
2087
|
*/
|
|
2008
2088
|
static getMetadata(): sap.ui.core.ElementMetadata;
|
|
2009
2089
|
}
|
|
2010
2090
|
/**
|
|
2011
|
-
* @since 1.34
|
|
2012
|
-
*
|
|
2013
2091
|
* The ToolPage is a layout control, used to create a basic tools app that has a header, side navigation
|
|
2014
2092
|
* and contents area. Overview: The control has three main areas - a header on top, navigation to the side
|
|
2015
2093
|
* and a content area that can hold any control. The header and side navigation use custom controls - {@link sap.tnt.ToolHeader }
|
|
2016
2094
|
* and {@link sap.tnt.SideNavigation}. Usage: The main usage of the sap.tnt controls is for scenarios in
|
|
2017
2095
|
* the tooling or administration space.
|
|
2096
|
+
*
|
|
2097
|
+
* @since 1.34
|
|
2018
2098
|
*/
|
|
2019
2099
|
class ToolPage extends sap.ui.core.Control {
|
|
2020
2100
|
/**
|
|
@@ -2054,6 +2134,7 @@ declare namespace sap {
|
|
|
2054
2134
|
*
|
|
2055
2135
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
|
|
2056
2136
|
*
|
|
2137
|
+
*
|
|
2057
2138
|
* @returns Created class / constructor function
|
|
2058
2139
|
*/
|
|
2059
2140
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -2074,12 +2155,14 @@ declare namespace sap {
|
|
|
2074
2155
|
/**
|
|
2075
2156
|
* Returns a metadata object for class sap.tnt.ToolPage.
|
|
2076
2157
|
*
|
|
2158
|
+
*
|
|
2077
2159
|
* @returns Metadata object describing this class
|
|
2078
2160
|
*/
|
|
2079
2161
|
static getMetadata(): sap.ui.core.ElementMetadata;
|
|
2080
2162
|
/**
|
|
2081
2163
|
* Adds some mainContent to the aggregation {@link #getMainContents mainContents}.
|
|
2082
2164
|
*
|
|
2165
|
+
*
|
|
2083
2166
|
* @returns Reference to `this` in order to allow method chaining
|
|
2084
2167
|
*/
|
|
2085
2168
|
addMainContent(
|
|
@@ -2091,38 +2174,41 @@ declare namespace sap {
|
|
|
2091
2174
|
/**
|
|
2092
2175
|
* Destroys the header in the aggregation {@link #getHeader header}.
|
|
2093
2176
|
*
|
|
2177
|
+
*
|
|
2094
2178
|
* @returns Reference to `this` in order to allow method chaining
|
|
2095
2179
|
*/
|
|
2096
2180
|
destroyHeader(): this;
|
|
2097
2181
|
/**
|
|
2098
2182
|
* Destroys all the mainContents in the aggregation {@link #getMainContents mainContents}.
|
|
2099
2183
|
*
|
|
2184
|
+
*
|
|
2100
2185
|
* @returns Reference to `this` in order to allow method chaining
|
|
2101
2186
|
*/
|
|
2102
2187
|
destroyMainContents(): this;
|
|
2103
2188
|
/**
|
|
2104
2189
|
* Destroys the sideContent in the aggregation {@link #getSideContent sideContent}.
|
|
2105
2190
|
*
|
|
2191
|
+
*
|
|
2106
2192
|
* @returns Reference to `this` in order to allow method chaining
|
|
2107
2193
|
*/
|
|
2108
2194
|
destroySideContent(): this;
|
|
2109
2195
|
/**
|
|
2110
|
-
* @since 1.93
|
|
2111
|
-
*
|
|
2112
2196
|
* Destroys the subHeader in the aggregation {@link #getSubHeader subHeader}.
|
|
2113
2197
|
*
|
|
2198
|
+
* @since 1.93
|
|
2199
|
+
*
|
|
2114
2200
|
* @returns Reference to `this` in order to allow method chaining
|
|
2115
2201
|
*/
|
|
2116
2202
|
destroySubHeader(): this;
|
|
2117
2203
|
/**
|
|
2118
|
-
* @since 1.115
|
|
2119
|
-
*
|
|
2120
2204
|
* Gets current value of property {@link #getContentBackgroundDesign contentBackgroundDesign}.
|
|
2121
2205
|
*
|
|
2122
2206
|
* Specifies the content background design.
|
|
2123
2207
|
*
|
|
2124
2208
|
* Default value is `Standard`.
|
|
2125
2209
|
*
|
|
2210
|
+
* @since 1.115
|
|
2211
|
+
*
|
|
2126
2212
|
* @returns Value of property `contentBackgroundDesign`
|
|
2127
2213
|
*/
|
|
2128
2214
|
getContentBackgroundDesign(): sap.m.PageBackgroundDesign;
|
|
@@ -2151,21 +2237,23 @@ declare namespace sap {
|
|
|
2151
2237
|
*
|
|
2152
2238
|
* Default value is `true`.
|
|
2153
2239
|
*
|
|
2240
|
+
*
|
|
2154
2241
|
* @returns Value of property `sideExpanded`
|
|
2155
2242
|
*/
|
|
2156
2243
|
getSideExpanded(): boolean;
|
|
2157
2244
|
/**
|
|
2158
|
-
* @since 1.93
|
|
2159
|
-
*
|
|
2160
2245
|
* Gets content of aggregation {@link #getSubHeader subHeader}.
|
|
2161
2246
|
*
|
|
2162
2247
|
* The control to appear in the subheader area.
|
|
2248
|
+
*
|
|
2249
|
+
* @since 1.93
|
|
2163
2250
|
*/
|
|
2164
2251
|
getSubHeader(): sap.tnt.IToolHeader;
|
|
2165
2252
|
/**
|
|
2166
2253
|
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getMainContents mainContents}.
|
|
2167
2254
|
* and returns its index if found or -1 otherwise.
|
|
2168
2255
|
*
|
|
2256
|
+
*
|
|
2169
2257
|
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
2170
2258
|
*/
|
|
2171
2259
|
indexOfMainContent(
|
|
@@ -2177,6 +2265,7 @@ declare namespace sap {
|
|
|
2177
2265
|
/**
|
|
2178
2266
|
* Inserts a mainContent into the aggregation {@link #getMainContents mainContents}.
|
|
2179
2267
|
*
|
|
2268
|
+
*
|
|
2180
2269
|
* @returns Reference to `this` in order to allow method chaining
|
|
2181
2270
|
*/
|
|
2182
2271
|
insertMainContent(
|
|
@@ -2196,12 +2285,14 @@ declare namespace sap {
|
|
|
2196
2285
|
*
|
|
2197
2286
|
* Additionally, it unregisters them from the hosting UIArea.
|
|
2198
2287
|
*
|
|
2288
|
+
*
|
|
2199
2289
|
* @returns An array of the removed elements (might be empty)
|
|
2200
2290
|
*/
|
|
2201
2291
|
removeAllMainContents(): sap.ui.core.Control[];
|
|
2202
2292
|
/**
|
|
2203
2293
|
* Removes a mainContent from the aggregation {@link #getMainContents mainContents}.
|
|
2204
2294
|
*
|
|
2295
|
+
*
|
|
2205
2296
|
* @returns The removed mainContent or `null`
|
|
2206
2297
|
*/
|
|
2207
2298
|
removeMainContent(
|
|
@@ -2211,8 +2302,6 @@ declare namespace sap {
|
|
|
2211
2302
|
vMainContent: int | string | sap.ui.core.Control
|
|
2212
2303
|
): sap.ui.core.Control | null;
|
|
2213
2304
|
/**
|
|
2214
|
-
* @since 1.115
|
|
2215
|
-
*
|
|
2216
2305
|
* Sets a new value for property {@link #getContentBackgroundDesign contentBackgroundDesign}.
|
|
2217
2306
|
*
|
|
2218
2307
|
* Specifies the content background design.
|
|
@@ -2221,6 +2310,8 @@ declare namespace sap {
|
|
|
2221
2310
|
*
|
|
2222
2311
|
* Default value is `Standard`.
|
|
2223
2312
|
*
|
|
2313
|
+
* @since 1.115
|
|
2314
|
+
*
|
|
2224
2315
|
* @returns Reference to `this` in order to allow method chaining
|
|
2225
2316
|
*/
|
|
2226
2317
|
setContentBackgroundDesign(
|
|
@@ -2232,6 +2323,7 @@ declare namespace sap {
|
|
|
2232
2323
|
/**
|
|
2233
2324
|
* Sets the aggregated {@link #getHeader header}.
|
|
2234
2325
|
*
|
|
2326
|
+
*
|
|
2235
2327
|
* @returns Reference to `this` in order to allow method chaining
|
|
2236
2328
|
*/
|
|
2237
2329
|
setHeader(
|
|
@@ -2243,6 +2335,7 @@ declare namespace sap {
|
|
|
2243
2335
|
/**
|
|
2244
2336
|
* Sets the aggregated {@link #getSideContent sideContent}.
|
|
2245
2337
|
*
|
|
2338
|
+
*
|
|
2246
2339
|
* @returns Reference to `this` in order to allow method chaining
|
|
2247
2340
|
*/
|
|
2248
2341
|
setSideContent(
|
|
@@ -2254,6 +2347,7 @@ declare namespace sap {
|
|
|
2254
2347
|
/**
|
|
2255
2348
|
* Sets the expand/collapse state of the SideContent.
|
|
2256
2349
|
*
|
|
2350
|
+
*
|
|
2257
2351
|
* @returns Pointer to the control instance for chaining
|
|
2258
2352
|
*/
|
|
2259
2353
|
setSideExpanded(
|
|
@@ -2263,10 +2357,10 @@ declare namespace sap {
|
|
|
2263
2357
|
bSideExpanded: boolean
|
|
2264
2358
|
): this;
|
|
2265
2359
|
/**
|
|
2266
|
-
* @since 1.93
|
|
2267
|
-
*
|
|
2268
2360
|
* Sets the aggregated {@link #getSubHeader subHeader}.
|
|
2269
2361
|
*
|
|
2362
|
+
* @since 1.93
|
|
2363
|
+
*
|
|
2270
2364
|
* @returns Reference to `this` in order to allow method chaining
|
|
2271
2365
|
*/
|
|
2272
2366
|
setSubHeader(
|
|
@@ -2278,6 +2372,7 @@ declare namespace sap {
|
|
|
2278
2372
|
/**
|
|
2279
2373
|
* Toggles the expand/collapse state of the SideContent.
|
|
2280
2374
|
*
|
|
2375
|
+
*
|
|
2281
2376
|
* @returns Pointer to the control instance for chaining.
|
|
2282
2377
|
*/
|
|
2283
2378
|
toggleSideContentMode(): this;
|