@openui5/types 1.114.0 → 1.115.1
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 +1780 -1315
- package/types/sap.m.d.ts +12407 -8461
- package/types/sap.tnt.d.ts +173 -95
- package/types/sap.ui.codeeditor.d.ts +61 -39
- package/types/sap.ui.commons.d.ts +1393 -846
- package/types/sap.ui.core.d.ts +6286 -3651
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.fl.d.ts +160 -100
- package/types/sap.ui.integration.d.ts +502 -375
- package/types/sap.ui.layout.d.ts +603 -640
- package/types/sap.ui.mdc.d.ts +22208 -140
- package/types/sap.ui.rta.d.ts +7 -7
- package/types/sap.ui.suite.d.ts +29 -13
- package/types/sap.ui.support.d.ts +15 -16
- package/types/sap.ui.table.d.ts +907 -647
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +1765 -1179
- package/types/sap.ui.ux3.d.ts +1472 -807
- package/types/sap.ui.webc.common.d.ts +5 -5
- package/types/sap.ui.webc.fiori.d.ts +817 -462
- package/types/sap.ui.webc.main.d.ts +2018 -1096
- package/types/sap.uxap.d.ts +472 -348
package/types/sap.tnt.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
// For Library Version: 1.
|
|
1
|
+
// For Library Version: 1.115.1
|
|
2
2
|
|
|
3
3
|
declare module "sap/tnt/library" {
|
|
4
4
|
/**
|
|
5
|
-
* @
|
|
5
|
+
* @since 1.68
|
|
6
6
|
*
|
|
7
7
|
* Interface for controls suitable for the `header` aggregation of {@link sap.tnt.ToolPage}.
|
|
8
8
|
*/
|
|
@@ -42,7 +42,7 @@ declare module "sap/tnt/InfoLabel" {
|
|
|
42
42
|
import { RenderMode } from "sap/tnt/library";
|
|
43
43
|
|
|
44
44
|
/**
|
|
45
|
-
* @
|
|
45
|
+
* @since 1.54
|
|
46
46
|
*
|
|
47
47
|
* The `InfoLabel` is a small non-interactive control which contains text information and non-semantic color
|
|
48
48
|
* chosen from a list of predefined color schemes. It serves the purpose to attract the user attention to
|
|
@@ -59,9 +59,9 @@ declare module "sap/tnt/InfoLabel" {
|
|
|
59
59
|
*
|
|
60
60
|
* Usage Guidelines:
|
|
61
61
|
* - If the text is longer than the width of the control, it doesn’t wrap. Instead, it’s represented as
|
|
62
|
-
*
|
|
62
|
+
* ellipsis.
|
|
63
63
|
* - When truncated, the full text in the control is not visible. Therefore, it’s recommended to make
|
|
64
|
-
*
|
|
64
|
+
* more space for longer items to be fully displayed.
|
|
65
65
|
* - Colors are not semantic and have no visual representation in sap_belize_hcb and sap_belize_hcw themes.
|
|
66
66
|
*
|
|
67
67
|
* - The control shows plain text only, formatting is not visualized.
|
|
@@ -167,7 +167,7 @@ declare module "sap/tnt/InfoLabel" {
|
|
|
167
167
|
*/
|
|
168
168
|
getDisplayOnly(): boolean;
|
|
169
169
|
/**
|
|
170
|
-
* @
|
|
170
|
+
* @since 1.74
|
|
171
171
|
*
|
|
172
172
|
* Gets current value of property {@link #getIcon icon}.
|
|
173
173
|
*
|
|
@@ -259,7 +259,7 @@ declare module "sap/tnt/InfoLabel" {
|
|
|
259
259
|
bDisplayOnly?: boolean
|
|
260
260
|
): this;
|
|
261
261
|
/**
|
|
262
|
-
* @
|
|
262
|
+
* @since 1.74
|
|
263
263
|
*
|
|
264
264
|
* Sets a new value for property {@link #getIcon icon}.
|
|
265
265
|
*
|
|
@@ -400,7 +400,7 @@ declare module "sap/tnt/InfoLabel" {
|
|
|
400
400
|
| `{${string}}`;
|
|
401
401
|
|
|
402
402
|
/**
|
|
403
|
-
* @
|
|
403
|
+
* @since 1.74
|
|
404
404
|
*
|
|
405
405
|
* Defines the icon to be displayed as graphical element within the `InfoLabel`. It can be an icon from
|
|
406
406
|
* the icon font.
|
|
@@ -416,10 +416,6 @@ declare module "sap/tnt/NavigationList" {
|
|
|
416
416
|
|
|
417
417
|
import NavigationListItem from "sap/tnt/NavigationListItem";
|
|
418
418
|
|
|
419
|
-
import Event from "sap/ui/base/Event";
|
|
420
|
-
|
|
421
|
-
import Item from "sap/ui/core/Item";
|
|
422
|
-
|
|
423
419
|
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
424
420
|
|
|
425
421
|
import {
|
|
@@ -427,8 +423,12 @@ declare module "sap/tnt/NavigationList" {
|
|
|
427
423
|
AggregationBindingInfo,
|
|
428
424
|
} from "sap/ui/base/ManagedObject";
|
|
429
425
|
|
|
426
|
+
import Event from "sap/ui/base/Event";
|
|
427
|
+
|
|
428
|
+
import Item from "sap/ui/core/Item";
|
|
429
|
+
|
|
430
430
|
/**
|
|
431
|
-
* @
|
|
431
|
+
* @since 1.34
|
|
432
432
|
*
|
|
433
433
|
* The NavigationList control is an interactive control, which provides a choice of different items, ordered
|
|
434
434
|
* as a list.
|
|
@@ -546,7 +546,7 @@ declare module "sap/tnt/NavigationList" {
|
|
|
546
546
|
/**
|
|
547
547
|
* The function to be called when the event occurs
|
|
548
548
|
*/
|
|
549
|
-
fnFunction: (p1:
|
|
549
|
+
fnFunction: (p1: NavigationList$ItemSelectEvent) => void,
|
|
550
550
|
/**
|
|
551
551
|
* Context object to call the event handler with. Defaults to this `sap.tnt.NavigationList` itself
|
|
552
552
|
*/
|
|
@@ -566,7 +566,7 @@ declare module "sap/tnt/NavigationList" {
|
|
|
566
566
|
/**
|
|
567
567
|
* The function to be called when the event occurs
|
|
568
568
|
*/
|
|
569
|
-
fnFunction: (p1:
|
|
569
|
+
fnFunction: (p1: NavigationList$ItemSelectEvent) => void,
|
|
570
570
|
/**
|
|
571
571
|
* Context object to call the event handler with. Defaults to this `sap.tnt.NavigationList` itself
|
|
572
572
|
*/
|
|
@@ -589,14 +589,14 @@ declare module "sap/tnt/NavigationList" {
|
|
|
589
589
|
/**
|
|
590
590
|
* The function to be called, when the event occurs
|
|
591
591
|
*/
|
|
592
|
-
fnFunction: (p1:
|
|
592
|
+
fnFunction: (p1: NavigationList$ItemSelectEvent) => void,
|
|
593
593
|
/**
|
|
594
594
|
* Context object on which the given function had to be called
|
|
595
595
|
*/
|
|
596
596
|
oListener?: object
|
|
597
597
|
): this;
|
|
598
598
|
/**
|
|
599
|
-
* @
|
|
599
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
600
600
|
*
|
|
601
601
|
* Fires event {@link #event:itemSelect itemSelect} to attached listeners.
|
|
602
602
|
*
|
|
@@ -606,21 +606,14 @@ declare module "sap/tnt/NavigationList" {
|
|
|
606
606
|
/**
|
|
607
607
|
* Parameters to pass along with the event
|
|
608
608
|
*/
|
|
609
|
-
mParameters?:
|
|
610
|
-
/**
|
|
611
|
-
* The selected item.
|
|
612
|
-
*/
|
|
613
|
-
item?: Item;
|
|
614
|
-
}
|
|
609
|
+
mParameters?: NavigationList$ItemSelectEventParameters
|
|
615
610
|
): this;
|
|
616
611
|
/**
|
|
617
|
-
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy
|
|
618
|
-
* ariaDescribedBy}.
|
|
612
|
+
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}.
|
|
619
613
|
*/
|
|
620
614
|
getAriaDescribedBy(): ID[];
|
|
621
615
|
/**
|
|
622
|
-
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy
|
|
623
|
-
* ariaLabelledBy}.
|
|
616
|
+
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
|
|
624
617
|
*/
|
|
625
618
|
getAriaLabelledBy(): ID[];
|
|
626
619
|
/**
|
|
@@ -646,7 +639,7 @@ declare module "sap/tnt/NavigationList" {
|
|
|
646
639
|
*/
|
|
647
640
|
getSelectedItem(): NavigationListItem | null;
|
|
648
641
|
/**
|
|
649
|
-
* @
|
|
642
|
+
* @since 1.62.0
|
|
650
643
|
*
|
|
651
644
|
* Gets current value of property {@link #getSelectedKey selectedKey}.
|
|
652
645
|
*
|
|
@@ -813,7 +806,7 @@ declare module "sap/tnt/NavigationList" {
|
|
|
813
806
|
expanded?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
814
807
|
|
|
815
808
|
/**
|
|
816
|
-
* @
|
|
809
|
+
* @since 1.62.0
|
|
817
810
|
*
|
|
818
811
|
* Specifies the currently selected key.
|
|
819
812
|
*/
|
|
@@ -839,7 +832,7 @@ declare module "sap/tnt/NavigationList" {
|
|
|
839
832
|
ariaLabelledBy?: Array<Control | string>;
|
|
840
833
|
|
|
841
834
|
/**
|
|
842
|
-
* @
|
|
835
|
+
* @since 1.52.0
|
|
843
836
|
*
|
|
844
837
|
* The currently selected `NavigationListItem`.
|
|
845
838
|
*/
|
|
@@ -848,15 +841,24 @@ declare module "sap/tnt/NavigationList" {
|
|
|
848
841
|
/**
|
|
849
842
|
* Fired when an item is selected.
|
|
850
843
|
*/
|
|
851
|
-
itemSelect?: (
|
|
844
|
+
itemSelect?: (
|
|
845
|
+
oEvent: Event<NavigationList$ItemSelectEventParameters>
|
|
846
|
+
) => void;
|
|
852
847
|
}
|
|
848
|
+
|
|
849
|
+
export interface NavigationList$ItemSelectEventParameters {
|
|
850
|
+
/**
|
|
851
|
+
* The selected item.
|
|
852
|
+
*/
|
|
853
|
+
item?: Item;
|
|
854
|
+
}
|
|
855
|
+
|
|
856
|
+
export type NavigationList$ItemSelectEvent = Event<NavigationList$ItemSelectEventParameters>;
|
|
853
857
|
}
|
|
854
858
|
|
|
855
859
|
declare module "sap/tnt/NavigationListItem" {
|
|
856
860
|
import { default as Item, $ItemSettings } from "sap/ui/core/Item";
|
|
857
861
|
|
|
858
|
-
import Event from "sap/ui/base/Event";
|
|
859
|
-
|
|
860
862
|
import { URI } from "sap/ui/core/library";
|
|
861
863
|
|
|
862
864
|
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
@@ -866,8 +868,10 @@ declare module "sap/tnt/NavigationListItem" {
|
|
|
866
868
|
AggregationBindingInfo,
|
|
867
869
|
} from "sap/ui/base/ManagedObject";
|
|
868
870
|
|
|
871
|
+
import Event from "sap/ui/base/Event";
|
|
872
|
+
|
|
869
873
|
/**
|
|
870
|
-
* @
|
|
874
|
+
* @since 1.34
|
|
871
875
|
*
|
|
872
876
|
* The NavigationListItem control represents an action, which can be selected by the user. It can provide
|
|
873
877
|
* sub items.
|
|
@@ -963,7 +967,7 @@ declare module "sap/tnt/NavigationListItem" {
|
|
|
963
967
|
/**
|
|
964
968
|
* The function to be called when the event occurs
|
|
965
969
|
*/
|
|
966
|
-
fnFunction: (p1:
|
|
970
|
+
fnFunction: (p1: NavigationListItem$SelectEvent) => void,
|
|
967
971
|
/**
|
|
968
972
|
* Context object to call the event handler with. Defaults to this `sap.tnt.NavigationListItem` itself
|
|
969
973
|
*/
|
|
@@ -983,7 +987,7 @@ declare module "sap/tnt/NavigationListItem" {
|
|
|
983
987
|
/**
|
|
984
988
|
* The function to be called when the event occurs
|
|
985
989
|
*/
|
|
986
|
-
fnFunction: (p1:
|
|
990
|
+
fnFunction: (p1: NavigationListItem$SelectEvent) => void,
|
|
987
991
|
/**
|
|
988
992
|
* Context object to call the event handler with. Defaults to this `sap.tnt.NavigationListItem` itself
|
|
989
993
|
*/
|
|
@@ -1006,14 +1010,14 @@ declare module "sap/tnt/NavigationListItem" {
|
|
|
1006
1010
|
/**
|
|
1007
1011
|
* The function to be called, when the event occurs
|
|
1008
1012
|
*/
|
|
1009
|
-
fnFunction: (p1:
|
|
1013
|
+
fnFunction: (p1: NavigationListItem$SelectEvent) => void,
|
|
1010
1014
|
/**
|
|
1011
1015
|
* Context object on which the given function had to be called
|
|
1012
1016
|
*/
|
|
1013
1017
|
oListener?: object
|
|
1014
1018
|
): this;
|
|
1015
1019
|
/**
|
|
1016
|
-
* @
|
|
1020
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1017
1021
|
*
|
|
1018
1022
|
* Fires event {@link #event:select select} to attached listeners.
|
|
1019
1023
|
*
|
|
@@ -1023,12 +1027,7 @@ declare module "sap/tnt/NavigationListItem" {
|
|
|
1023
1027
|
/**
|
|
1024
1028
|
* Parameters to pass along with the event
|
|
1025
1029
|
*/
|
|
1026
|
-
mParameters?:
|
|
1027
|
-
/**
|
|
1028
|
-
* The selected item.
|
|
1029
|
-
*/
|
|
1030
|
-
item?: Item;
|
|
1031
|
-
}
|
|
1030
|
+
mParameters?: NavigationListItem$SelectEventParameters
|
|
1032
1031
|
): this;
|
|
1033
1032
|
/**
|
|
1034
1033
|
* Gets current value of property {@link #getExpanded expanded}.
|
|
@@ -1040,6 +1039,14 @@ declare module "sap/tnt/NavigationListItem" {
|
|
|
1040
1039
|
* @returns Value of property `expanded`
|
|
1041
1040
|
*/
|
|
1042
1041
|
getExpanded(): boolean;
|
|
1042
|
+
/**
|
|
1043
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1044
|
+
*
|
|
1045
|
+
* Returns the DOM Element that should get the focus.
|
|
1046
|
+
*
|
|
1047
|
+
* @returns Returns the DOM Element that should get the focus
|
|
1048
|
+
*/
|
|
1049
|
+
getFocusDomRef(): Element;
|
|
1043
1050
|
/**
|
|
1044
1051
|
* Gets current value of property {@link #getHasExpander hasExpander}.
|
|
1045
1052
|
*
|
|
@@ -1088,7 +1095,7 @@ declare module "sap/tnt/NavigationListItem" {
|
|
|
1088
1095
|
*/
|
|
1089
1096
|
getTarget(): string;
|
|
1090
1097
|
/**
|
|
1091
|
-
* @
|
|
1098
|
+
* @since 1.52
|
|
1092
1099
|
*
|
|
1093
1100
|
* Gets current value of property {@link #getVisible visible}.
|
|
1094
1101
|
*
|
|
@@ -1234,7 +1241,7 @@ declare module "sap/tnt/NavigationListItem" {
|
|
|
1234
1241
|
sTarget?: string
|
|
1235
1242
|
): this;
|
|
1236
1243
|
/**
|
|
1237
|
-
* @
|
|
1244
|
+
* @since 1.52
|
|
1238
1245
|
*
|
|
1239
1246
|
* Sets a new value for property {@link #getVisible visible}.
|
|
1240
1247
|
*
|
|
@@ -1271,7 +1278,7 @@ declare module "sap/tnt/NavigationListItem" {
|
|
|
1271
1278
|
hasExpander?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
1272
1279
|
|
|
1273
1280
|
/**
|
|
1274
|
-
* @
|
|
1281
|
+
* @since 1.52
|
|
1275
1282
|
*
|
|
1276
1283
|
* Specifies if the item should be shown.
|
|
1277
1284
|
*/
|
|
@@ -1304,22 +1311,27 @@ declare module "sap/tnt/NavigationListItem" {
|
|
|
1304
1311
|
/**
|
|
1305
1312
|
* Fired when this item is selected.
|
|
1306
1313
|
*/
|
|
1307
|
-
select?: (oEvent: Event) => void;
|
|
1314
|
+
select?: (oEvent: Event<NavigationListItem$SelectEventParameters>) => void;
|
|
1308
1315
|
}
|
|
1316
|
+
|
|
1317
|
+
export interface NavigationListItem$SelectEventParameters {
|
|
1318
|
+
/**
|
|
1319
|
+
* The selected item.
|
|
1320
|
+
*/
|
|
1321
|
+
item?: Item;
|
|
1322
|
+
}
|
|
1323
|
+
|
|
1324
|
+
export type NavigationListItem$SelectEvent = Event<NavigationListItem$SelectEventParameters>;
|
|
1309
1325
|
}
|
|
1310
1326
|
|
|
1311
1327
|
declare module "sap/tnt/SideNavigation" {
|
|
1312
1328
|
import { default as Control, $ControlSettings } from "sap/ui/core/Control";
|
|
1313
1329
|
|
|
1314
|
-
import Event from "sap/ui/base/Event";
|
|
1315
|
-
|
|
1316
1330
|
import {
|
|
1317
1331
|
AggregationBindingInfo,
|
|
1318
1332
|
PropertyBindingInfo,
|
|
1319
1333
|
} from "sap/ui/base/ManagedObject";
|
|
1320
1334
|
|
|
1321
|
-
import Item from "sap/ui/core/Item";
|
|
1322
|
-
|
|
1323
1335
|
import NavigationList from "sap/tnt/NavigationList";
|
|
1324
1336
|
|
|
1325
1337
|
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
@@ -1328,14 +1340,18 @@ declare module "sap/tnt/SideNavigation" {
|
|
|
1328
1340
|
|
|
1329
1341
|
import NavigationListItem from "sap/tnt/NavigationListItem";
|
|
1330
1342
|
|
|
1343
|
+
import Event from "sap/ui/base/Event";
|
|
1344
|
+
|
|
1345
|
+
import Item from "sap/ui/core/Item";
|
|
1346
|
+
|
|
1331
1347
|
/**
|
|
1332
|
-
* @
|
|
1348
|
+
* @since 1.34
|
|
1333
1349
|
*
|
|
1334
1350
|
* The SideNavigation control is a container, which consists of flexible and fixed parts on top of each
|
|
1335
1351
|
* other. Responsive Behavior:
|
|
1336
1352
|
* - The flexible part adapts its size to the fixed one.
|
|
1337
1353
|
* - The flexible part has a scrollbar when the content is larger than the available space. **Note:**
|
|
1338
|
-
*
|
|
1354
|
+
* In order for the SideNavigation to stretch properly, its parent layout control should only be the sap.tnt.ToolPage.
|
|
1339
1355
|
*/
|
|
1340
1356
|
export default class SideNavigation extends Control {
|
|
1341
1357
|
/**
|
|
@@ -1421,7 +1437,7 @@ declare module "sap/tnt/SideNavigation" {
|
|
|
1421
1437
|
/**
|
|
1422
1438
|
* The function to be called when the event occurs
|
|
1423
1439
|
*/
|
|
1424
|
-
fnFunction: (p1:
|
|
1440
|
+
fnFunction: (p1: SideNavigation$ItemSelectEvent) => void,
|
|
1425
1441
|
/**
|
|
1426
1442
|
* Context object to call the event handler with. Defaults to this `sap.tnt.SideNavigation` itself
|
|
1427
1443
|
*/
|
|
@@ -1441,7 +1457,7 @@ declare module "sap/tnt/SideNavigation" {
|
|
|
1441
1457
|
/**
|
|
1442
1458
|
* The function to be called when the event occurs
|
|
1443
1459
|
*/
|
|
1444
|
-
fnFunction: (p1:
|
|
1460
|
+
fnFunction: (p1: SideNavigation$ItemSelectEvent) => void,
|
|
1445
1461
|
/**
|
|
1446
1462
|
* Context object to call the event handler with. Defaults to this `sap.tnt.SideNavigation` itself
|
|
1447
1463
|
*/
|
|
@@ -1490,14 +1506,14 @@ declare module "sap/tnt/SideNavigation" {
|
|
|
1490
1506
|
/**
|
|
1491
1507
|
* The function to be called, when the event occurs
|
|
1492
1508
|
*/
|
|
1493
|
-
fnFunction: (p1:
|
|
1509
|
+
fnFunction: (p1: SideNavigation$ItemSelectEvent) => void,
|
|
1494
1510
|
/**
|
|
1495
1511
|
* Context object on which the given function had to be called
|
|
1496
1512
|
*/
|
|
1497
1513
|
oListener?: object
|
|
1498
1514
|
): this;
|
|
1499
1515
|
/**
|
|
1500
|
-
* @
|
|
1516
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1501
1517
|
*
|
|
1502
1518
|
* Fires event {@link #event:itemSelect itemSelect} to attached listeners.
|
|
1503
1519
|
*
|
|
@@ -1507,15 +1523,10 @@ declare module "sap/tnt/SideNavigation" {
|
|
|
1507
1523
|
/**
|
|
1508
1524
|
* Parameters to pass along with the event
|
|
1509
1525
|
*/
|
|
1510
|
-
mParameters?:
|
|
1511
|
-
/**
|
|
1512
|
-
* The selected item.
|
|
1513
|
-
*/
|
|
1514
|
-
item?: Item;
|
|
1515
|
-
}
|
|
1526
|
+
mParameters?: SideNavigation$ItemSelectEventParameters
|
|
1516
1527
|
): this;
|
|
1517
1528
|
/**
|
|
1518
|
-
* @
|
|
1529
|
+
* @since 1.98
|
|
1519
1530
|
*
|
|
1520
1531
|
* Gets current value of property {@link #getAriaLabel ariaLabel}.
|
|
1521
1532
|
*
|
|
@@ -1553,14 +1564,14 @@ declare module "sap/tnt/SideNavigation" {
|
|
|
1553
1564
|
*/
|
|
1554
1565
|
getItem(): NavigationList;
|
|
1555
1566
|
/**
|
|
1556
|
-
* @
|
|
1567
|
+
* @since 1.52.0
|
|
1557
1568
|
*
|
|
1558
1569
|
* ID of the element which is the current target of the association {@link #getSelectedItem selectedItem},
|
|
1559
1570
|
* or `null`.
|
|
1560
1571
|
*/
|
|
1561
1572
|
getSelectedItem(): ID;
|
|
1562
1573
|
/**
|
|
1563
|
-
* @
|
|
1574
|
+
* @since 1.62.0
|
|
1564
1575
|
*
|
|
1565
1576
|
* Gets current value of property {@link #getSelectedKey selectedKey}.
|
|
1566
1577
|
*
|
|
@@ -1570,7 +1581,7 @@ declare module "sap/tnt/SideNavigation" {
|
|
|
1570
1581
|
*/
|
|
1571
1582
|
getSelectedKey(): string;
|
|
1572
1583
|
/**
|
|
1573
|
-
* @
|
|
1584
|
+
* @since 1.98
|
|
1574
1585
|
*
|
|
1575
1586
|
* Sets a new value for property {@link #getAriaLabel ariaLabel}.
|
|
1576
1587
|
*
|
|
@@ -1667,14 +1678,14 @@ declare module "sap/tnt/SideNavigation" {
|
|
|
1667
1678
|
expanded?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
1668
1679
|
|
|
1669
1680
|
/**
|
|
1670
|
-
* @
|
|
1681
|
+
* @since 1.62.0
|
|
1671
1682
|
*
|
|
1672
1683
|
* Specifies the currently selected key.
|
|
1673
1684
|
*/
|
|
1674
1685
|
selectedKey?: string | PropertyBindingInfo;
|
|
1675
1686
|
|
|
1676
1687
|
/**
|
|
1677
|
-
* @
|
|
1688
|
+
* @since 1.98
|
|
1678
1689
|
*
|
|
1679
1690
|
* Specifies an optional aria-label that can be used by the screen readers.
|
|
1680
1691
|
*/
|
|
@@ -1696,7 +1707,7 @@ declare module "sap/tnt/SideNavigation" {
|
|
|
1696
1707
|
footer?: NavigationList;
|
|
1697
1708
|
|
|
1698
1709
|
/**
|
|
1699
|
-
* @
|
|
1710
|
+
* @since 1.52.0
|
|
1700
1711
|
*
|
|
1701
1712
|
* The selected `NavigationListItem`.
|
|
1702
1713
|
*/
|
|
@@ -1705,8 +1716,25 @@ declare module "sap/tnt/SideNavigation" {
|
|
|
1705
1716
|
/**
|
|
1706
1717
|
* Fired when an item is selected.
|
|
1707
1718
|
*/
|
|
1708
|
-
itemSelect?: (
|
|
1719
|
+
itemSelect?: (
|
|
1720
|
+
oEvent: Event<SideNavigation$ItemSelectEventParameters>
|
|
1721
|
+
) => void;
|
|
1709
1722
|
}
|
|
1723
|
+
|
|
1724
|
+
export interface SideNavigation$ItemSelectEventParameters {
|
|
1725
|
+
/**
|
|
1726
|
+
* The selected item.
|
|
1727
|
+
*/
|
|
1728
|
+
item?: Item;
|
|
1729
|
+
}
|
|
1730
|
+
|
|
1731
|
+
/**
|
|
1732
|
+
* @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'SideNavigation$ItemSelectEventParameters'
|
|
1733
|
+
* in 1.115.1 and any later releases.
|
|
1734
|
+
*/
|
|
1735
|
+
export type $SideNavigationItemSelectEventParameters = SideNavigation$ItemSelectEventParameters;
|
|
1736
|
+
|
|
1737
|
+
export type SideNavigation$ItemSelectEvent = Event<SideNavigation$ItemSelectEventParameters>;
|
|
1710
1738
|
}
|
|
1711
1739
|
|
|
1712
1740
|
declare module "sap/tnt/ToolHeader" {
|
|
@@ -1720,18 +1748,21 @@ declare module "sap/tnt/ToolHeader" {
|
|
|
1720
1748
|
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
1721
1749
|
|
|
1722
1750
|
/**
|
|
1723
|
-
* @
|
|
1751
|
+
* @since 1.34
|
|
1724
1752
|
*
|
|
1725
|
-
* The ToolHeader control is a horizontal container that is most commonly used to display buttons,
|
|
1753
|
+
* The ToolHeader control is a horizontal container that is most commonly used to display buttons, texts,
|
|
1726
1754
|
* and other various input controls. Overview: The ToolHeader control is based on {@link sap.m.OverflowToolbar}.
|
|
1727
1755
|
* It contains clearly structured menus of commands that are available across the various apps within the
|
|
1728
1756
|
* same tool layout. Usage:
|
|
1757
|
+
* - This control is specialized for administrative applications. For other types of applications use:
|
|
1758
|
+
* {@link sap.m.Shell}
|
|
1729
1759
|
* - If an app implements side navigation in addition to the tool header menu, the menu icon must be the
|
|
1730
|
-
*
|
|
1760
|
+
* first item on the left-hand side of the tool header.
|
|
1731
1761
|
* - The app menu and the side navigation must not have any dependencies and must work independently.
|
|
1732
|
-
*
|
|
1733
|
-
*
|
|
1734
|
-
*
|
|
1762
|
+
* Horizon theme specifics: Only the following controls are supported: sap.m.Button, sap.m.Image,
|
|
1763
|
+
* sap.m.Title, sap.m.Text, sap.m.SearchField, sap.m.Avatar. Fiori 3 theme specifics: In Fiori 3 Default
|
|
1764
|
+
* theme the ToolHeader is with dark design unlike most of the other controls. This defines the usage of
|
|
1765
|
+
* limited controls inside it, which will result in good design combination.
|
|
1735
1766
|
* The ToolHeader stylizes the contained controls with the Shell color parameters, to match the dark design
|
|
1736
1767
|
* requirement. However, that's not a dark theme.
|
|
1737
1768
|
*
|
|
@@ -1765,8 +1796,8 @@ declare module "sap/tnt/ToolHeader" {
|
|
|
1765
1796
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
1766
1797
|
* of the syntax of the settings object.
|
|
1767
1798
|
*
|
|
1768
|
-
* This class does not have its own settings, but all settings applicable to the base type {@link sap.m.OverflowToolbar#constructor
|
|
1769
|
-
*
|
|
1799
|
+
* This class does not have its own settings, but all settings applicable to the base type {@link sap.m.OverflowToolbar#constructor sap.m.OverflowToolbar }
|
|
1800
|
+
* can be used.
|
|
1770
1801
|
* See:
|
|
1771
1802
|
* {@link fiori:https://experience.sap.com/fiori-design-web/tool-header/ Tool Header}
|
|
1772
1803
|
*/
|
|
@@ -1783,8 +1814,8 @@ declare module "sap/tnt/ToolHeader" {
|
|
|
1783
1814
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
1784
1815
|
* of the syntax of the settings object.
|
|
1785
1816
|
*
|
|
1786
|
-
* This class does not have its own settings, but all settings applicable to the base type {@link sap.m.OverflowToolbar#constructor
|
|
1787
|
-
*
|
|
1817
|
+
* This class does not have its own settings, but all settings applicable to the base type {@link sap.m.OverflowToolbar#constructor sap.m.OverflowToolbar }
|
|
1818
|
+
* can be used.
|
|
1788
1819
|
* See:
|
|
1789
1820
|
* {@link fiori:https://experience.sap.com/fiori-design-web/tool-header/ Tool Header}
|
|
1790
1821
|
*/
|
|
@@ -1839,7 +1870,7 @@ declare module "sap/tnt/ToolHeaderUtilitySeparator" {
|
|
|
1839
1870
|
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
1840
1871
|
|
|
1841
1872
|
/**
|
|
1842
|
-
* @
|
|
1873
|
+
* @since 1.16
|
|
1843
1874
|
*
|
|
1844
1875
|
* The ToolHeaderUtilitySeparator control is used in the sap.tnt.ToolHeader control to specify where the
|
|
1845
1876
|
* overflow button is placed.
|
|
@@ -1852,8 +1883,8 @@ declare module "sap/tnt/ToolHeaderUtilitySeparator" {
|
|
|
1852
1883
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
1853
1884
|
* of the syntax of the settings object.
|
|
1854
1885
|
*
|
|
1855
|
-
* This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.core.Control#constructor
|
|
1856
|
-
*
|
|
1886
|
+
* This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.core.Control#constructor sap.ui.core.Control }
|
|
1887
|
+
* can be used.
|
|
1857
1888
|
*/
|
|
1858
1889
|
constructor(
|
|
1859
1890
|
/**
|
|
@@ -1868,8 +1899,8 @@ declare module "sap/tnt/ToolHeaderUtilitySeparator" {
|
|
|
1868
1899
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
1869
1900
|
* of the syntax of the settings object.
|
|
1870
1901
|
*
|
|
1871
|
-
* This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.core.Control#constructor
|
|
1872
|
-
*
|
|
1902
|
+
* This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.core.Control#constructor sap.ui.core.Control }
|
|
1903
|
+
* can be used.
|
|
1873
1904
|
*/
|
|
1874
1905
|
constructor(
|
|
1875
1906
|
/**
|
|
@@ -1920,6 +1951,8 @@ declare module "sap/tnt/ToolHeaderUtilitySeparator" {
|
|
|
1920
1951
|
declare module "sap/tnt/ToolPage" {
|
|
1921
1952
|
import { default as Control, $ControlSettings } from "sap/ui/core/Control";
|
|
1922
1953
|
|
|
1954
|
+
import { PageBackgroundDesign } from "sap/m/library";
|
|
1955
|
+
|
|
1923
1956
|
import { IToolHeader } from "sap/tnt/library";
|
|
1924
1957
|
|
|
1925
1958
|
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
@@ -1932,13 +1965,13 @@ declare module "sap/tnt/ToolPage" {
|
|
|
1932
1965
|
} from "sap/ui/base/ManagedObject";
|
|
1933
1966
|
|
|
1934
1967
|
/**
|
|
1935
|
-
* @
|
|
1968
|
+
* @since 1.34
|
|
1936
1969
|
*
|
|
1937
1970
|
* The ToolPage is a layout control, used to create a basic tools app that has a header, side navigation
|
|
1938
1971
|
* and contents area. Overview: The control has three main areas - a header on top, navigation to the side
|
|
1939
|
-
* and a content area that can hold any control. The header and side navigation use custom controls - {@link
|
|
1940
|
-
*
|
|
1941
|
-
*
|
|
1972
|
+
* and a content area that can hold any control. The header and side navigation use custom controls - {@link sap.tnt.ToolHeader }
|
|
1973
|
+
* and {@link sap.tnt.SideNavigation}. Usage: The main usage of the sap.tnt controls is for scenarios in
|
|
1974
|
+
* the tooling or administration space.
|
|
1942
1975
|
*/
|
|
1943
1976
|
export default class ToolPage extends Control {
|
|
1944
1977
|
/**
|
|
@@ -2031,13 +2064,27 @@ declare module "sap/tnt/ToolPage" {
|
|
|
2031
2064
|
*/
|
|
2032
2065
|
destroySideContent(): this;
|
|
2033
2066
|
/**
|
|
2034
|
-
* @
|
|
2067
|
+
* @since 1.93
|
|
2035
2068
|
*
|
|
2036
2069
|
* Destroys the subHeader in the aggregation {@link #getSubHeader subHeader}.
|
|
2037
2070
|
*
|
|
2038
2071
|
* @returns Reference to `this` in order to allow method chaining
|
|
2039
2072
|
*/
|
|
2040
2073
|
destroySubHeader(): this;
|
|
2074
|
+
/**
|
|
2075
|
+
* @since 1.115
|
|
2076
|
+
*
|
|
2077
|
+
* Gets current value of property {@link #getContentBackgroundDesign contentBackgroundDesign}.
|
|
2078
|
+
*
|
|
2079
|
+
* Specifies the content background design.
|
|
2080
|
+
*
|
|
2081
|
+
* Default value is `Standard`.
|
|
2082
|
+
*
|
|
2083
|
+
* @returns Value of property `contentBackgroundDesign`
|
|
2084
|
+
*/
|
|
2085
|
+
getContentBackgroundDesign():
|
|
2086
|
+
| PageBackgroundDesign
|
|
2087
|
+
| keyof typeof PageBackgroundDesign;
|
|
2041
2088
|
/**
|
|
2042
2089
|
* Gets content of aggregation {@link #getHeader header}.
|
|
2043
2090
|
*
|
|
@@ -2067,7 +2114,7 @@ declare module "sap/tnt/ToolPage" {
|
|
|
2067
2114
|
*/
|
|
2068
2115
|
getSideExpanded(): boolean;
|
|
2069
2116
|
/**
|
|
2070
|
-
* @
|
|
2117
|
+
* @since 1.93
|
|
2071
2118
|
*
|
|
2072
2119
|
* Gets content of aggregation {@link #getSubHeader subHeader}.
|
|
2073
2120
|
*
|
|
@@ -2122,6 +2169,27 @@ declare module "sap/tnt/ToolPage" {
|
|
|
2122
2169
|
*/
|
|
2123
2170
|
vMainContent: int | string | Control
|
|
2124
2171
|
): Control | null;
|
|
2172
|
+
/**
|
|
2173
|
+
* @since 1.115
|
|
2174
|
+
*
|
|
2175
|
+
* Sets a new value for property {@link #getContentBackgroundDesign contentBackgroundDesign}.
|
|
2176
|
+
*
|
|
2177
|
+
* Specifies the content background design.
|
|
2178
|
+
*
|
|
2179
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2180
|
+
*
|
|
2181
|
+
* Default value is `Standard`.
|
|
2182
|
+
*
|
|
2183
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2184
|
+
*/
|
|
2185
|
+
setContentBackgroundDesign(
|
|
2186
|
+
/**
|
|
2187
|
+
* New value for property `contentBackgroundDesign`
|
|
2188
|
+
*/
|
|
2189
|
+
sContentBackgroundDesign?:
|
|
2190
|
+
| PageBackgroundDesign
|
|
2191
|
+
| keyof typeof PageBackgroundDesign
|
|
2192
|
+
): this;
|
|
2125
2193
|
/**
|
|
2126
2194
|
* Sets the aggregated {@link #getHeader header}.
|
|
2127
2195
|
*
|
|
@@ -2156,7 +2224,7 @@ declare module "sap/tnt/ToolPage" {
|
|
|
2156
2224
|
bSideExpanded: boolean
|
|
2157
2225
|
): this;
|
|
2158
2226
|
/**
|
|
2159
|
-
* @
|
|
2227
|
+
* @since 1.93
|
|
2160
2228
|
*
|
|
2161
2229
|
* Sets the aggregated {@link #getSubHeader subHeader}.
|
|
2162
2230
|
*
|
|
@@ -2182,13 +2250,23 @@ declare module "sap/tnt/ToolPage" {
|
|
|
2182
2250
|
*/
|
|
2183
2251
|
sideExpanded?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
2184
2252
|
|
|
2253
|
+
/**
|
|
2254
|
+
* @since 1.115
|
|
2255
|
+
*
|
|
2256
|
+
* Specifies the content background design.
|
|
2257
|
+
*/
|
|
2258
|
+
contentBackgroundDesign?:
|
|
2259
|
+
| (PageBackgroundDesign | keyof typeof PageBackgroundDesign)
|
|
2260
|
+
| PropertyBindingInfo
|
|
2261
|
+
| `{${string}}`;
|
|
2262
|
+
|
|
2185
2263
|
/**
|
|
2186
2264
|
* The control to appear in the header area.
|
|
2187
2265
|
*/
|
|
2188
2266
|
header?: IToolHeader;
|
|
2189
2267
|
|
|
2190
2268
|
/**
|
|
2191
|
-
* @
|
|
2269
|
+
* @since 1.93
|
|
2192
2270
|
*
|
|
2193
2271
|
* The control to appear in the subheader area.
|
|
2194
2272
|
*/
|