@openui5/ts-types 1.96.5 → 1.99.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.
- package/package.json +1 -1
- package/types/sap.f.d.ts +263 -636
- package/types/sap.m.d.ts +4057 -318
- package/types/sap.tnt.d.ts +4 -4
- package/types/sap.ui.codeeditor.d.ts +7 -1
- package/types/sap.ui.commons.d.ts +1 -1
- package/types/sap.ui.core.d.ts +1709 -490
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.fl.d.ts +13 -7
- package/types/sap.ui.integration.d.ts +68 -9
- package/types/sap.ui.layout.d.ts +7 -4
- package/types/sap.ui.mdc.d.ts +35 -15
- package/types/sap.ui.rta.d.ts +5 -11
- package/types/sap.ui.suite.d.ts +1 -1
- package/types/sap.ui.support.d.ts +6 -6
- package/types/sap.ui.table.d.ts +32 -3
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +43 -1
- package/types/sap.ui.ux3.d.ts +1 -1
- package/types/sap.ui.webc.common.d.ts +1 -1
- package/types/sap.ui.webc.fiori.d.ts +3015 -581
- package/types/sap.ui.webc.main.d.ts +3286 -986
- package/types/sap.uxap.d.ts +1 -1
package/types/sap.f.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.
|
|
1
|
+
// For Library Version: 1.99.0
|
|
2
2
|
|
|
3
3
|
declare namespace sap {
|
|
4
4
|
/**
|
|
@@ -1335,6 +1335,158 @@ declare namespace sap {
|
|
|
1335
1335
|
}
|
|
1336
1336
|
}
|
|
1337
1337
|
|
|
1338
|
+
namespace FlexibleColumnLayoutSemanticHelper {
|
|
1339
|
+
/**
|
|
1340
|
+
* The configuration of the navigation actions in the columns.
|
|
1341
|
+
*/
|
|
1342
|
+
type ColumnsNavigationActions = {
|
|
1343
|
+
/**
|
|
1344
|
+
* Configuration of the navigation actions of the mid column.
|
|
1345
|
+
*/
|
|
1346
|
+
midColumn?: sap.f.FlexibleColumnLayoutSemanticHelper.NavigationActionsTargets;
|
|
1347
|
+
/**
|
|
1348
|
+
* Configuration of the navigation actions of the end column.
|
|
1349
|
+
*/
|
|
1350
|
+
endColumn?: sap.f.FlexibleColumnLayoutSemanticHelper.NavigationActionsTargets;
|
|
1351
|
+
};
|
|
1352
|
+
|
|
1353
|
+
/**
|
|
1354
|
+
* Represents the relative percentage sizes of all columns as integers.
|
|
1355
|
+
*/
|
|
1356
|
+
type ColumnsSizes = {
|
|
1357
|
+
/**
|
|
1358
|
+
* The relative percentage width of the begin column as integer.
|
|
1359
|
+
*/
|
|
1360
|
+
beginColumn?: number;
|
|
1361
|
+
/**
|
|
1362
|
+
* The relative percentage width of the mid column as integer.
|
|
1363
|
+
*/
|
|
1364
|
+
midColumn?: number;
|
|
1365
|
+
/**
|
|
1366
|
+
* The relative percentage width of the end column as integer.
|
|
1367
|
+
*/
|
|
1368
|
+
endColumn?: number;
|
|
1369
|
+
};
|
|
1370
|
+
|
|
1371
|
+
/**
|
|
1372
|
+
* Represents the visibility of the columns.
|
|
1373
|
+
*/
|
|
1374
|
+
type ColumnsVisibility = {
|
|
1375
|
+
/**
|
|
1376
|
+
* The visibility of the begin column.
|
|
1377
|
+
*/
|
|
1378
|
+
beginColumn?: boolean;
|
|
1379
|
+
/**
|
|
1380
|
+
* The visibility of the mid column.
|
|
1381
|
+
*/
|
|
1382
|
+
midColumn?: boolean;
|
|
1383
|
+
/**
|
|
1384
|
+
* The visibility of the end column.
|
|
1385
|
+
*/
|
|
1386
|
+
endColumn?: boolean;
|
|
1387
|
+
};
|
|
1388
|
+
|
|
1389
|
+
/**
|
|
1390
|
+
* Configures the target layouts of the navigation acion buttons in a column.
|
|
1391
|
+
*/
|
|
1392
|
+
type NavigationActionsTargets = {
|
|
1393
|
+
/**
|
|
1394
|
+
* The target {@link sap.f.FlexibleColumnLayout#getLayout layout} when the `fullscreen` navigation action
|
|
1395
|
+
* button is pressed. If null, then the respective action button should not be shown.
|
|
1396
|
+
*/
|
|
1397
|
+
fullScreen?: string | null;
|
|
1398
|
+
/**
|
|
1399
|
+
* The target {@link sap.f.FlexibleColumnLayout#getLayout layout} when the `exitFullScreen` navigation action
|
|
1400
|
+
* button is pressed. If null, then the respective action button should not be shown.
|
|
1401
|
+
*/
|
|
1402
|
+
exitFullScreen?: string | null;
|
|
1403
|
+
/**
|
|
1404
|
+
* The target {@link sap.f.FlexibleColumnLayout#getLayout layout} when the `closeColumn` navigation action
|
|
1405
|
+
* button is pressed. If null, then the respective action button should not be shown.
|
|
1406
|
+
*/
|
|
1407
|
+
closeColumn?: string | null;
|
|
1408
|
+
};
|
|
1409
|
+
|
|
1410
|
+
/**
|
|
1411
|
+
* Configuration of the state of the `FlexibleColumnLayout` control and the expected action buttons for
|
|
1412
|
+
* each column.
|
|
1413
|
+
*
|
|
1414
|
+
* Example value:
|
|
1415
|
+
*
|
|
1416
|
+
*
|
|
1417
|
+
* ```javascript
|
|
1418
|
+
*
|
|
1419
|
+
*
|
|
1420
|
+
* {
|
|
1421
|
+
* "layout":"ThreeColumnsMidExpanded",
|
|
1422
|
+
* "maxColumnsCount":3,
|
|
1423
|
+
* "columnsSizes":{
|
|
1424
|
+
* "beginColumn":25,
|
|
1425
|
+
* "midColumn":50,
|
|
1426
|
+
* "endColumn":25
|
|
1427
|
+
* },
|
|
1428
|
+
* "columnsVisibility":{
|
|
1429
|
+
* "beginColumn":true,
|
|
1430
|
+
* "midColumn":true,
|
|
1431
|
+
* "endColumn":true
|
|
1432
|
+
* },
|
|
1433
|
+
* "isFullScreen":false,
|
|
1434
|
+
* "isLogicallyFullScreen":false,
|
|
1435
|
+
* "actionButtonsInfo":{
|
|
1436
|
+
* "midColumn":{
|
|
1437
|
+
* "fullScreen":null,
|
|
1438
|
+
* "exitFullScreen":null,
|
|
1439
|
+
* "closeColumn":null
|
|
1440
|
+
* },
|
|
1441
|
+
* "endColumn":{
|
|
1442
|
+
* "fullScreen":"EndColumnFullScreen",
|
|
1443
|
+
* "exitFullScreen":null,
|
|
1444
|
+
* "closeColumn":"TwoColumnsBeginExpanded"
|
|
1445
|
+
* }
|
|
1446
|
+
* }
|
|
1447
|
+
* }
|
|
1448
|
+
*
|
|
1449
|
+
* ```
|
|
1450
|
+
*/
|
|
1451
|
+
type UIState = {
|
|
1452
|
+
/**
|
|
1453
|
+
* The value of the {@link sap.f.FlexibleColumnLayout#getLayout layout} property.
|
|
1454
|
+
*/
|
|
1455
|
+
layout?: string;
|
|
1456
|
+
/**
|
|
1457
|
+
* The maximum number of columns that can be displayed at once based on the control width. See {@link sap.f.FlexibleColumnLayout#getMaxColumnsCount}
|
|
1458
|
+
*/
|
|
1459
|
+
maxColumnsCount?: number;
|
|
1460
|
+
/**
|
|
1461
|
+
* Represents the relative percentage sizes of all columns as integers.
|
|
1462
|
+
*/
|
|
1463
|
+
columnsSizes?: sap.f.FlexibleColumnLayoutSemanticHelper.ColumnsSizes;
|
|
1464
|
+
/**
|
|
1465
|
+
* Represents the visibility of the columns.
|
|
1466
|
+
*/
|
|
1467
|
+
columnsVisibility?: sap.f.FlexibleColumnLayoutSemanticHelper.ColumnsVisibility;
|
|
1468
|
+
/**
|
|
1469
|
+
* The value is `true` if only one column is visible at the moment, `false` otherwise.
|
|
1470
|
+
*
|
|
1471
|
+
* **Note:** This may be due to small screen size (phone) or due to a layout, for which a single column
|
|
1472
|
+
* takes up the whole width.
|
|
1473
|
+
*/
|
|
1474
|
+
isFullScreen?: boolean;
|
|
1475
|
+
/**
|
|
1476
|
+
* The value is `true` if the current `layout` is one of the following: `sap.f.LayoutType.OneColumn, sap.f.LayoutType.MidColumnFullScreen,
|
|
1477
|
+
* sap.f.LayoutType.EndColumnFullScreen`, `false` otherwise.
|
|
1478
|
+
*
|
|
1479
|
+
* **Note:** While `isFullScreen` can be `true` for any layout, due to small screen size, `isLogicallyFullScreen`
|
|
1480
|
+
* will only be `true` for the layout values, listed above.
|
|
1481
|
+
*/
|
|
1482
|
+
isLogicallyFullScreen?: boolean;
|
|
1483
|
+
/**
|
|
1484
|
+
* The configuration of the navigation actions in the columns.
|
|
1485
|
+
*/
|
|
1486
|
+
actionButtonsInfo?: sap.f.FlexibleColumnLayoutSemanticHelper.ColumnsNavigationActions;
|
|
1487
|
+
};
|
|
1488
|
+
}
|
|
1489
|
+
|
|
1338
1490
|
namespace routing {
|
|
1339
1491
|
/**
|
|
1340
1492
|
* @SINCE 1.46
|
|
@@ -1342,7 +1494,7 @@ declare namespace sap {
|
|
|
1342
1494
|
* The `sap.f.routing.Router` class is intended to be used with `{@link sap.f.FlexibleColumnLayout}` as
|
|
1343
1495
|
* a root control.
|
|
1344
1496
|
*
|
|
1345
|
-
* The difference to the `{@link sap.ui.core.routing.Router}` are the `
|
|
1497
|
+
* The difference to the `{@link sap.ui.core.routing.Router}` are the `level`, `transition`, and `transitionParameters`
|
|
1346
1498
|
* properties that you can specify in every Route or Target created by this router.
|
|
1347
1499
|
*
|
|
1348
1500
|
* The difference to the `{@link sap.m.routing.Router}` is the additional `layout` property that can be
|
|
@@ -1476,7 +1628,7 @@ declare namespace sap {
|
|
|
1476
1628
|
*
|
|
1477
1629
|
* The `sap.f` extension of `Targets` also handles the triggering of page navigation when the target control
|
|
1478
1630
|
* is an `{@link sap.f.FlexibleColumnLayout}`. Other controls are also allowed, but the extra parameters
|
|
1479
|
-
* `
|
|
1631
|
+
* `level`, `transition`, and `transitionParameters` are ignored and it behaves as `{@link sap.ui.core.routing.Targets}`.
|
|
1480
1632
|
*
|
|
1481
1633
|
* When a target is displayed, dialogs are being closed. To change this, use `{@link #getTargetHandler}`
|
|
1482
1634
|
* and {@link sap.f.routing.TargetHandler#setCloseDialogs}.
|
|
@@ -1487,7 +1639,7 @@ declare namespace sap {
|
|
|
1487
1639
|
*/
|
|
1488
1640
|
constructor(oOptions: {
|
|
1489
1641
|
/**
|
|
1490
|
-
*
|
|
1642
|
+
* the views instance will create the views of all the targets defined, so if 2 targets have the same name,
|
|
1491
1643
|
* the same instance of the view will be displayed.
|
|
1492
1644
|
*/
|
|
1493
1645
|
views: sap.ui.core.routing.Views;
|
|
@@ -1574,13 +1726,15 @@ declare namespace sap {
|
|
|
1574
1726
|
* {
|
|
1575
1727
|
* targets: {
|
|
1576
1728
|
* welcome: {
|
|
1577
|
-
*
|
|
1729
|
+
* type: "View",
|
|
1730
|
+
* name: "Welcome",
|
|
1578
1731
|
* viewType: "XML",
|
|
1579
1732
|
* ....
|
|
1580
1733
|
* // Other target parameters
|
|
1581
1734
|
* },
|
|
1582
1735
|
* goodbye: {
|
|
1583
|
-
*
|
|
1736
|
+
* type: "View",
|
|
1737
|
+
* name: "Bye",
|
|
1584
1738
|
* viewType: "JS",
|
|
1585
1739
|
* ....
|
|
1586
1740
|
* // Other target parameters
|
|
@@ -1596,8 +1750,14 @@ declare namespace sap {
|
|
|
1596
1750
|
*/
|
|
1597
1751
|
anyName: {
|
|
1598
1752
|
/**
|
|
1599
|
-
*
|
|
1600
|
-
|
|
1753
|
+
* Defines whether the target creates an instance of 'View' or 'Component'.
|
|
1754
|
+
*/
|
|
1755
|
+
type: string;
|
|
1756
|
+
/**
|
|
1757
|
+
* Defines the name of the View or Component that will be created. For type 'Component', use option `usage`
|
|
1758
|
+
* instead if an owner component exists. To place the view or component into a Control, use the options
|
|
1759
|
+
* `controlAggregation` and `controlId`. Instance of View or Component will only be created once per `name`
|
|
1760
|
+
* or `usage` combined with `id`.
|
|
1601
1761
|
* ```javascript
|
|
1602
1762
|
*
|
|
1603
1763
|
*
|
|
@@ -1605,14 +1765,16 @@ declare namespace sap {
|
|
|
1605
1765
|
* targets: {
|
|
1606
1766
|
* // If display("masterWelcome") is called, the master view will be placed in the 'MasterPages' of a control with the id splitContainter
|
|
1607
1767
|
* masterWelcome: {
|
|
1608
|
-
*
|
|
1768
|
+
* type: "View",
|
|
1769
|
+
* name: "Welcome",
|
|
1609
1770
|
* controlId: "splitContainer",
|
|
1610
1771
|
* controlAggregation: "masterPages"
|
|
1611
1772
|
* },
|
|
1612
1773
|
* // If display("detailWelcome") is called after the masterWelcome, the view will be removed from the master pages and added to the detail pages, since the same instance is used. Also the controls inside of the view will have the same state.
|
|
1613
1774
|
* detailWelcome: {
|
|
1614
1775
|
* // same view here, that's why the same instance is used
|
|
1615
|
-
*
|
|
1776
|
+
* type: "View",
|
|
1777
|
+
* name: "Welcome",
|
|
1616
1778
|
* controlId: "splitContainer",
|
|
1617
1779
|
* controlAggregation: "detailPages"
|
|
1618
1780
|
* }
|
|
@@ -1622,28 +1784,28 @@ declare namespace sap {
|
|
|
1622
1784
|
* ```
|
|
1623
1785
|
*
|
|
1624
1786
|
*
|
|
1625
|
-
* If you want to have a second instance of the welcome view you can
|
|
1787
|
+
* If you want to have a second instance of the welcome view you can assign the targets with different ids:
|
|
1626
1788
|
*
|
|
1627
1789
|
*
|
|
1628
1790
|
* ```javascript
|
|
1629
1791
|
*
|
|
1630
1792
|
*
|
|
1631
|
-
* // Some code you execute before you display the target named 'detailWelcome':
|
|
1632
|
-
* var oView = sap.ui.view(({ viewName : "Welcome", type : sap.ui.core.mvc.ViewType.XML});
|
|
1633
|
-
* oTargets.getViews().setView("WelcomeWithAlias", oView)
|
|
1634
|
-
*
|
|
1635
1793
|
* {
|
|
1636
1794
|
* targets: {
|
|
1637
|
-
* // If display("masterWelcome") is called, the
|
|
1795
|
+
* // If display("masterWelcome") is called, the "masterWelcome" view will be placed in the 'MasterPages' of a control with the id splitContainter
|
|
1638
1796
|
* masterWelcome: {
|
|
1639
|
-
*
|
|
1797
|
+
* type: "View",
|
|
1798
|
+
* name: "Welcome",
|
|
1799
|
+
* id: "masterWelcome",
|
|
1640
1800
|
* controlId: "splitContainer",
|
|
1641
1801
|
* controlAggregation: "masterPages"
|
|
1642
1802
|
* },
|
|
1643
|
-
* // If display("detailWelcome") is called after the masterWelcome, a second instance with an own controller instance will be added in the detail pages.
|
|
1803
|
+
* // If display("detailWelcome") is called after the "masterWelcome", a second instance with an own controller instance will be added in the detail pages.
|
|
1644
1804
|
* detailWelcome: {
|
|
1645
|
-
*
|
|
1646
|
-
*
|
|
1805
|
+
* type: "View",
|
|
1806
|
+
* name: "Welcome",
|
|
1807
|
+
* // another instance will be created because a different id is used
|
|
1808
|
+
* id: "detailWelcome",
|
|
1647
1809
|
* controlId: "splitContainer",
|
|
1648
1810
|
* controlAggregation: "detailPages"
|
|
1649
1811
|
* }
|
|
@@ -1652,7 +1814,12 @@ declare namespace sap {
|
|
|
1652
1814
|
*
|
|
1653
1815
|
* ```
|
|
1654
1816
|
*/
|
|
1655
|
-
|
|
1817
|
+
name?: string;
|
|
1818
|
+
/**
|
|
1819
|
+
* Defines the 'usage' name for 'Component' target which refers to the '/sap.ui5/componentUsages' entry
|
|
1820
|
+
* in the owner component's manifest.
|
|
1821
|
+
*/
|
|
1822
|
+
usage?: string;
|
|
1656
1823
|
/**
|
|
1657
1824
|
* The type of the view that is going to be created. These are the supported types: {@link sap.ui.core.mvc.ViewType}.
|
|
1658
1825
|
* You always have to provide a viewType except if `oOptions.config.viewType` is set or when using {@link
|
|
@@ -1660,17 +1827,17 @@ declare namespace sap {
|
|
|
1660
1827
|
*/
|
|
1661
1828
|
viewType?: string;
|
|
1662
1829
|
/**
|
|
1663
|
-
* A prefix that is prepended in front of the `
|
|
1830
|
+
* A prefix that is prepended in front of the `name`.
|
|
1664
1831
|
*
|
|
1665
|
-
* **Example:** `
|
|
1666
|
-
*
|
|
1832
|
+
* **Example:** `name` is set to "myView" and `path` is set to "myApp" - the created view's name will be
|
|
1833
|
+
* "myApp.myView".
|
|
1667
1834
|
*/
|
|
1668
|
-
|
|
1835
|
+
path?: string;
|
|
1669
1836
|
/**
|
|
1670
|
-
* The ID of the created view. This is is prefixed with the ID of the component set to the
|
|
1671
|
-
* provided in `oOptions.views`. For details, see `{@link sap.ui.core.routing.Views#getView}`.
|
|
1837
|
+
* The ID of the created view or component. This is is prefixed with the ID of the component set to the
|
|
1838
|
+
* views instance provided in `oOptions.views`. For details, see `{@link sap.ui.core.routing.Views#getView}`.
|
|
1672
1839
|
*/
|
|
1673
|
-
|
|
1840
|
+
id?: string;
|
|
1674
1841
|
/**
|
|
1675
1842
|
* The ID of the parent of the `controlId`.
|
|
1676
1843
|
*
|
|
@@ -1759,11 +1926,13 @@ declare namespace sap {
|
|
|
1759
1926
|
* // a reference to the app control in the rootView created by our UIComponent
|
|
1760
1927
|
* controlId: 'myApp',
|
|
1761
1928
|
* // An app has a pages aggregation where the views need to be put into
|
|
1762
|
-
* controlAggregation: 'pages'
|
|
1929
|
+
* controlAggregation: 'pages',
|
|
1930
|
+
* // all targets have type "View"
|
|
1931
|
+
* type: "View"
|
|
1763
1932
|
* },
|
|
1764
1933
|
* targets: {
|
|
1765
1934
|
* detail: {
|
|
1766
|
-
*
|
|
1935
|
+
* name: 'Detail'
|
|
1767
1936
|
* },
|
|
1768
1937
|
* secondTabContent: {
|
|
1769
1938
|
* // A reference to the detail target defined above
|
|
@@ -1773,7 +1942,7 @@ declare namespace sap {
|
|
|
1773
1942
|
* // An IconTabFilter has an aggregation called content so we need to overwrite the pages set in the config as default.
|
|
1774
1943
|
* controlAggregation: 'content',
|
|
1775
1944
|
* // A view containing the content
|
|
1776
|
-
*
|
|
1945
|
+
* name: 'SecondTabContent'
|
|
1777
1946
|
* }
|
|
1778
1947
|
* }
|
|
1779
1948
|
* });
|
|
@@ -1790,11 +1959,11 @@ declare namespace sap {
|
|
|
1790
1959
|
/**
|
|
1791
1960
|
* If you are having an application that has a logical order of views (eg: a create account process, first
|
|
1792
1961
|
* provide user data, then review and confirm them). You always want to show a backwards transition if a
|
|
1793
|
-
* navigation from the confirm to the userData page takes place. Therefore you may use the
|
|
1794
|
-
*
|
|
1795
|
-
*
|
|
1796
|
-
*
|
|
1797
|
-
*
|
|
1962
|
+
* navigation from the confirm to the userData page takes place. Therefore you may use the `level`. The
|
|
1963
|
+
* `level` has to be an integer. The user data page should have a lower number than the confirm page. These
|
|
1964
|
+
* levels should represent the user process of your application and they do not have to match the container
|
|
1965
|
+
* structure of your Targets. If the user navigates between targets with the same `level`, a forward transition
|
|
1966
|
+
* is taken. If you pass a direction into the display function, the `level` will be ignored.
|
|
1798
1967
|
*
|
|
1799
1968
|
* **Example:**
|
|
1800
1969
|
*
|
|
@@ -1805,15 +1974,15 @@ declare namespace sap {
|
|
|
1805
1974
|
* {
|
|
1806
1975
|
* targets: {
|
|
1807
1976
|
* startPage: {
|
|
1808
|
-
*
|
|
1977
|
+
* level: 0
|
|
1809
1978
|
* // more properties
|
|
1810
1979
|
* },
|
|
1811
1980
|
* userData: {
|
|
1812
|
-
*
|
|
1981
|
+
* level: 1
|
|
1813
1982
|
* // more properties
|
|
1814
1983
|
* },
|
|
1815
1984
|
* confirmRegistration: {
|
|
1816
|
-
*
|
|
1985
|
+
* level: 2
|
|
1817
1986
|
* // more properties
|
|
1818
1987
|
* },
|
|
1819
1988
|
* settings: {
|
|
@@ -1826,14 +1995,14 @@ declare namespace sap {
|
|
|
1826
1995
|
*
|
|
1827
1996
|
*
|
|
1828
1997
|
* Currently the 'userData' target is displayed.
|
|
1829
|
-
* - If we navigate to 'startPage' the navContainer will show a backwards navigation, since the
|
|
1998
|
+
* - If we navigate to 'startPage' the navContainer will show a backwards navigation, since the `level`
|
|
1830
1999
|
* is lower.
|
|
1831
|
-
* - If we navigate to 'userData' the navContainer will show a forwards navigation, since the
|
|
2000
|
+
* - If we navigate to 'userData' the navContainer will show a forwards navigation, since the `level`
|
|
1832
2001
|
* is higher.
|
|
1833
|
-
* - If we navigate to 'settings' the navContainer will show a forwards navigation, since the
|
|
2002
|
+
* - If we navigate to 'settings' the navContainer will show a forwards navigation, since the `level`
|
|
1834
2003
|
* is not defined and cannot be compared.
|
|
1835
2004
|
*/
|
|
1836
|
-
|
|
2005
|
+
level?: int;
|
|
1837
2006
|
/**
|
|
1838
2007
|
* Defines which transition of the {@link sap.m.NavContainer} is applied when navigating. If it is not defined,
|
|
1839
2008
|
* the `NavContainer` take its default transition.
|
|
@@ -6847,101 +7016,10 @@ declare namespace sap {
|
|
|
6847
7016
|
| sap.ui.base.ManagedObject.AggregationBindingInfo;
|
|
6848
7017
|
}
|
|
6849
7018
|
|
|
6850
|
-
interface $IllustratedMessageSettings
|
|
6851
|
-
|
|
6852
|
-
* @SINCE 1.88
|
|
6853
|
-
*
|
|
6854
|
-
* Defines the description displayed below the title.
|
|
6855
|
-
*
|
|
6856
|
-
* If there is no initial input from the app developer and the default illustration set is being used, a
|
|
6857
|
-
* default description for the current illustration type is going to be displayed. The default description
|
|
6858
|
-
* is stored in the `sap.f` resource bundle.
|
|
6859
|
-
*/
|
|
6860
|
-
description?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
6861
|
-
|
|
6862
|
-
/**
|
|
6863
|
-
* @SINCE 1.88
|
|
6864
|
-
*
|
|
6865
|
-
* Defines whether the value set in the `description` property is displayed as formatted text in HTML format.
|
|
6866
|
-
*
|
|
6867
|
-
* For details regarding supported HTML tags, see {@link sap.m.FormattedText}.
|
|
6868
|
-
*/
|
|
6869
|
-
enableFormattedText?:
|
|
6870
|
-
| boolean
|
|
6871
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
6872
|
-
|
|
6873
|
-
/**
|
|
6874
|
-
* @SINCE 1.88
|
|
6875
|
-
*
|
|
6876
|
-
* Determines which illustration breakpoint variant is used.
|
|
6877
|
-
*
|
|
6878
|
-
* As `IllustratedMessage` adapts itself around the `Illustration`, the other elements of the control are
|
|
6879
|
-
* displayed differently on the different breakpoints/illustration sizes.
|
|
6880
|
-
*/
|
|
6881
|
-
illustrationSize?:
|
|
6882
|
-
| sap.f.IllustratedMessageSize
|
|
6883
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
6884
|
-
|
|
6885
|
-
/**
|
|
6886
|
-
* @SINCE 1.88
|
|
6887
|
-
*
|
|
6888
|
-
* Determines which illustration type is displayed.
|
|
6889
|
-
*
|
|
6890
|
-
* **Note:** The {@link sap.f.IllustratedMessageType} enumeration contains a default illustration set. If
|
|
6891
|
-
* you want to use another illustration set, you have to register it in the {@link sap.f.IllustrationPool}.
|
|
6892
|
-
*
|
|
6893
|
-
* Example input for the `illustrationType` property is `sapIllus-UnableToLoad`. The logic behind this format
|
|
6894
|
-
* is as follows:
|
|
6895
|
-
* - First is the the illustration set - sapIllus
|
|
6896
|
-
* - Second is the illustration type - UnableToLoad
|
|
6897
|
-
*/
|
|
6898
|
-
illustrationType?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
6899
|
-
|
|
6900
|
-
/**
|
|
6901
|
-
* @SINCE 1.88
|
|
6902
|
-
*
|
|
6903
|
-
* Defines the title that is displayed below the illustration.
|
|
6904
|
-
*
|
|
6905
|
-
* If there is no initial input from the app developer and the default illustration set is being used, a
|
|
6906
|
-
* default title is displayed corresponding to the current `illustrationType`.
|
|
6907
|
-
*/
|
|
6908
|
-
title?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
6909
|
-
|
|
6910
|
-
/**
|
|
6911
|
-
* @SINCE 1.88
|
|
6912
|
-
*
|
|
6913
|
-
* Defines the controls placed below the description as additional content.
|
|
6914
|
-
*
|
|
6915
|
-
* **Note:** Not displayed when `illustrationSize` is set to `Base`.
|
|
6916
|
-
*/
|
|
6917
|
-
additionalContent?:
|
|
6918
|
-
| sap.m.Button[]
|
|
6919
|
-
| sap.m.Button
|
|
6920
|
-
| sap.ui.base.ManagedObject.AggregationBindingInfo;
|
|
6921
|
-
}
|
|
6922
|
-
|
|
6923
|
-
interface $IllustrationSettings extends sap.ui.core.$ControlSettings {
|
|
6924
|
-
/**
|
|
6925
|
-
* @SINCE 1.88
|
|
6926
|
-
*
|
|
6927
|
-
* Defines which illustration set should be used when building the Symbol ID.
|
|
6928
|
-
*/
|
|
6929
|
-
set?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
6930
|
-
|
|
6931
|
-
/**
|
|
6932
|
-
* @SINCE 1.88
|
|
6933
|
-
*
|
|
6934
|
-
* Defines which media/breakpoint should be used when building the Symbol ID.
|
|
6935
|
-
*/
|
|
6936
|
-
media?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
7019
|
+
interface $IllustratedMessageSettings
|
|
7020
|
+
extends sap.m.$IllustratedMessageSettings {}
|
|
6937
7021
|
|
|
6938
|
-
|
|
6939
|
-
* @SINCE 1.88
|
|
6940
|
-
*
|
|
6941
|
-
* Defines which illustration type should be used when building the Symbol ID.
|
|
6942
|
-
*/
|
|
6943
|
-
type?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
6944
|
-
}
|
|
7022
|
+
interface $IllustrationSettings extends sap.m.$IllustrationSettings {}
|
|
6945
7023
|
|
|
6946
7024
|
interface $ProductSwitchSettings extends sap.ui.core.$ControlSettings {
|
|
6947
7025
|
/**
|
|
@@ -7199,70 +7277,26 @@ declare namespace sap {
|
|
|
7199
7277
|
}
|
|
7200
7278
|
|
|
7201
7279
|
/**
|
|
7202
|
-
* @
|
|
7280
|
+
* @SINCE 1.88
|
|
7281
|
+
* @deprecated (since 1.98) - Use the {@link sap.m.IllustrationPool} instead.
|
|
7203
7282
|
*
|
|
7204
7283
|
* `IllustrationPool` loads the illustration assets (SVGs) via XMLHttpRequest requests.
|
|
7205
7284
|
*
|
|
7206
7285
|
* The successfully loaded data is kept in the DOM (div with ID `sap-illustration-pool`) in the `sap-ui-static`
|
|
7207
7286
|
* DOM element.
|
|
7208
7287
|
*
|
|
7209
|
-
* To load a given asset, register its illustration set through the {@link sap.
|
|
7288
|
+
* To load a given asset, register its illustration set through the {@link sap.m.IllustrationPool#sap.m.IllustrationPool.registerIllustrationSet
|
|
7210
7289
|
* registerIllustrationSet} API of `IllustrationPool`. The exception being the `sapIllus`, which is the
|
|
7211
7290
|
* default illustration set that is registered by default.
|
|
7212
7291
|
*
|
|
7213
7292
|
* The default behavior of `IllustrationPool` is to load/require an asset only when it's needed by using
|
|
7214
|
-
* the {@link sap.
|
|
7215
|
-
* given the option to load all of its assets.
|
|
7293
|
+
* the {@link sap.m.IllustrationPool#sap.m.IllustrationPool.loadAsset loadAsset} API. When registering the
|
|
7294
|
+
* new illustration set, you are given the option to load all of its assets.
|
|
7216
7295
|
*
|
|
7217
7296
|
* If some of the assets are not loaded initially, you can load the rest of them on a later state with the
|
|
7218
|
-
* {@link sap.
|
|
7297
|
+
* {@link sap.m.IllustrationPool#sap.m.IllustrationPool.loadRestOfTheAssets loadRestOfTheAssets} API.
|
|
7219
7298
|
*/
|
|
7220
|
-
interface IllustrationPool {
|
|
7221
|
-
/**
|
|
7222
|
-
* Loads an SVG asset depending on the input asset ID.
|
|
7223
|
-
*/
|
|
7224
|
-
loadAsset(
|
|
7225
|
-
/**
|
|
7226
|
-
* The string ID of the asset being loaded
|
|
7227
|
-
*/
|
|
7228
|
-
sAssetId: string,
|
|
7229
|
-
/**
|
|
7230
|
-
* the ID of the Illustration instance which is requiring the asset
|
|
7231
|
-
*/
|
|
7232
|
-
sInstanceId: string
|
|
7233
|
-
): void;
|
|
7234
|
-
/**
|
|
7235
|
-
* Loads the rest of the SVG assets for a given illustration set.
|
|
7236
|
-
*/
|
|
7237
|
-
loadRestOfTheAssets(
|
|
7238
|
-
/**
|
|
7239
|
-
* The illustration set, the rest of the assets should be loaded for
|
|
7240
|
-
*/
|
|
7241
|
-
sIllustrationSet: string
|
|
7242
|
-
): void;
|
|
7243
|
-
/**
|
|
7244
|
-
* Registers an illustration set, which is needed before loading any of its assets.
|
|
7245
|
-
*/
|
|
7246
|
-
registerIllustrationSet(
|
|
7247
|
-
/**
|
|
7248
|
-
* object containing the name and the path of the Illustration Set
|
|
7249
|
-
*/
|
|
7250
|
-
oConfig: {
|
|
7251
|
-
/**
|
|
7252
|
-
* Name of the Illustration Set
|
|
7253
|
-
*/
|
|
7254
|
-
setFamily: string;
|
|
7255
|
-
/**
|
|
7256
|
-
* URL Path of the Illustration Set
|
|
7257
|
-
*/
|
|
7258
|
-
setURI: string;
|
|
7259
|
-
},
|
|
7260
|
-
/**
|
|
7261
|
-
* whether or not all of the assets for the Illustration Set should be loaded once the metadata is loaded
|
|
7262
|
-
*/
|
|
7263
|
-
bLoadAllResources: boolean
|
|
7264
|
-
): void;
|
|
7265
|
-
}
|
|
7299
|
+
interface IllustrationPool {}
|
|
7266
7300
|
const IllustrationPool: IllustrationPool;
|
|
7267
7301
|
|
|
7268
7302
|
/**
|
|
@@ -12109,72 +12143,14 @@ declare namespace sap {
|
|
|
12109
12143
|
oSettings?: object
|
|
12110
12144
|
): sap.f.FlexibleColumnLayoutSemanticHelper;
|
|
12111
12145
|
/**
|
|
12112
|
-
* Returns an object
|
|
12146
|
+
* Returns an object describing the current state of the control and the expected action buttons for each
|
|
12113
12147
|
* column.
|
|
12114
12148
|
*
|
|
12115
|
-
* The returned object has the following structure:
|
|
12116
|
-
* - layout - the value of the `layout` property
|
|
12117
|
-
* - maxColumnsCount - the maximum number of columns that can be displayed at once based on the control
|
|
12118
|
-
* width. See {@link sap.f.FlexibleColumnLayout#getMaxColumnsCount}
|
|
12119
|
-
* - columnsSizes - an object with fields `beginColumn, midColumn, endColumn`, representing the relative
|
|
12120
|
-
* percentage sizes of the three columns as integers
|
|
12121
|
-
* - columnsVisibility - an object with fields `beginColumn, midColumn, endColumn`, representing the visibility
|
|
12122
|
-
* of the three columns
|
|
12123
|
-
* - isFullScreen - `true` if only one column is visible at the moment, `false` otherwise **Note:** This
|
|
12124
|
-
* may be due to small screen size (phone) or due to a layout, for which a single column takes up the whole
|
|
12125
|
-
* width
|
|
12126
|
-
* - isLogicallyFullScreen - `true` if the current `layout` is one of the following: `sap.f.LayoutType.OneColumn,
|
|
12127
|
-
* sap.f.LayoutType.MidColumnFullScreen, sap.f.LayoutType.EndColumnFullScreen`, `false` otherwise **Note:**
|
|
12128
|
-
* While `isFullScreen` can be `true` for any layout, due to small screen size, `isLogicallyFullScreen`
|
|
12129
|
-
* will only be `true` for the layout values, listed above.
|
|
12130
|
-
* - actionButtonsInfo - an object with fields `midColumn, endColumn`, each containing an object, telling
|
|
12131
|
-
* whether action buttons should be shown in the `mid` and `end` columns, and what value of the `layout`
|
|
12132
|
-
* property should be set upon clicking these buttons. Each of these objects has the following fields: `closeColumn,
|
|
12133
|
-
* fullScreen, exitFullScreen`. If `null`, then the respective action button should not be shown, otherwise
|
|
12134
|
-
* provides the value of `layout` property for the action button.
|
|
12135
|
-
*
|
|
12136
12149
|
* **Note:** This method relies on the internal `FlexibleColumnLayout` reference to be rendered in the DOM
|
|
12137
12150
|
* tree. For convenience, use methods {@link sap.f.FlexibleColumnLayoutSemanticHelper#isDOMReady} and {@link
|
|
12138
12151
|
* sap.f.FlexibleColumnLayoutSemanticHelper#whenDOMReady}.
|
|
12139
|
-
*
|
|
12140
|
-
* Example value:
|
|
12141
|
-
*
|
|
12142
|
-
*
|
|
12143
|
-
* ```javascript
|
|
12144
|
-
*
|
|
12145
|
-
*
|
|
12146
|
-
* {
|
|
12147
|
-
* "layout":"ThreeColumnsMidExpanded",
|
|
12148
|
-
* "maxColumnsCount":3,
|
|
12149
|
-
* "columnsSizes":{
|
|
12150
|
-
* "beginColumn":25,
|
|
12151
|
-
* "midColumn":50,
|
|
12152
|
-
* "endColumn":25
|
|
12153
|
-
* },
|
|
12154
|
-
* "columnsVisibility":{
|
|
12155
|
-
* "beginColumn":true,
|
|
12156
|
-
* "midColumn":true,
|
|
12157
|
-
* "endColumn":true
|
|
12158
|
-
* },
|
|
12159
|
-
* "isFullScreen":false,
|
|
12160
|
-
* "isLogicallyFullScreen":false,
|
|
12161
|
-
* "actionButtonsInfo":{
|
|
12162
|
-
* "midColumn":{
|
|
12163
|
-
* "fullScreen":null,
|
|
12164
|
-
* "exitFullScreen":null,
|
|
12165
|
-
* "closeColumn":null
|
|
12166
|
-
* },
|
|
12167
|
-
* "endColumn":{
|
|
12168
|
-
* "fullScreen":"EndColumnFullScreen",
|
|
12169
|
-
* "exitFullScreen":null,
|
|
12170
|
-
* "closeColumn":"TwoColumnsBeginExpanded"
|
|
12171
|
-
* }
|
|
12172
|
-
* }
|
|
12173
|
-
* }
|
|
12174
|
-
*
|
|
12175
|
-
* ```
|
|
12176
12152
|
*/
|
|
12177
|
-
getCurrentUIState():
|
|
12153
|
+
getCurrentUIState(): sap.f.FlexibleColumnLayoutSemanticHelper.UIState;
|
|
12178
12154
|
/**
|
|
12179
12155
|
* Returns the default layout types for the different numbers of columns.
|
|
12180
12156
|
*
|
|
@@ -12190,8 +12166,6 @@ declare namespace sap {
|
|
|
12190
12166
|
/**
|
|
12191
12167
|
* Returns an object, describing the state that the control will have after navigating to a different view
|
|
12192
12168
|
* level.
|
|
12193
|
-
*
|
|
12194
|
-
* About the format of return value, see: {@link sap.f.FlexibleColumnLayoutSemanticHelper#getCurrentUIState}
|
|
12195
12169
|
*/
|
|
12196
12170
|
getNextUIState(
|
|
12197
12171
|
/**
|
|
@@ -12199,7 +12173,7 @@ declare namespace sap {
|
|
|
12199
12173
|
* 3 and above - subsequent views
|
|
12200
12174
|
*/
|
|
12201
12175
|
iNextLevel: int
|
|
12202
|
-
):
|
|
12176
|
+
): sap.f.FlexibleColumnLayoutSemanticHelper.UIState;
|
|
12203
12177
|
/**
|
|
12204
12178
|
* @SINCE 1.72
|
|
12205
12179
|
*
|
|
@@ -13776,7 +13750,7 @@ declare namespace sap {
|
|
|
13776
13750
|
}
|
|
13777
13751
|
/**
|
|
13778
13752
|
* @SINCE 1.88
|
|
13779
|
-
* @
|
|
13753
|
+
* @deprecated (since 1.98) - Use the {@link sap.m.IllustratedMessage} instead.
|
|
13780
13754
|
*
|
|
13781
13755
|
* A combination of message and illustration to represent an empty or a success state.
|
|
13782
13756
|
*
|
|
@@ -13805,13 +13779,16 @@ declare namespace sap {
|
|
|
13805
13779
|
* and the available space of its parent container. Some of the structural elements are displayed differently
|
|
13806
13780
|
* or are omitted in the different breakpoint sizes (XS, S, M, L).
|
|
13807
13781
|
*/
|
|
13808
|
-
class IllustratedMessage extends sap.
|
|
13782
|
+
class IllustratedMessage extends sap.m.IllustratedMessage {
|
|
13809
13783
|
/**
|
|
13810
13784
|
* Constructor for a new `IllustratedMessage`.
|
|
13811
13785
|
*
|
|
13812
13786
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
13813
13787
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
13814
13788
|
* of the syntax of the settings object.
|
|
13789
|
+
*
|
|
13790
|
+
* This class does not have its own settings, but all settings applicable to the base type {@link sap.m.IllustratedMessage#constructor
|
|
13791
|
+
* sap.m.IllustratedMessage} can be used.
|
|
13815
13792
|
*/
|
|
13816
13793
|
constructor(
|
|
13817
13794
|
/**
|
|
@@ -13825,6 +13802,9 @@ declare namespace sap {
|
|
|
13825
13802
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
13826
13803
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
13827
13804
|
* of the syntax of the settings object.
|
|
13805
|
+
*
|
|
13806
|
+
* This class does not have its own settings, but all settings applicable to the base type {@link sap.m.IllustratedMessage#constructor
|
|
13807
|
+
* sap.m.IllustratedMessage} can be used.
|
|
13828
13808
|
*/
|
|
13829
13809
|
constructor(
|
|
13830
13810
|
/**
|
|
@@ -13841,7 +13821,7 @@ declare namespace sap {
|
|
|
13841
13821
|
* Creates a new subclass of class sap.f.IllustratedMessage with name `sClassName` and enriches it with
|
|
13842
13822
|
* the information contained in `oClassInfo`.
|
|
13843
13823
|
*
|
|
13844
|
-
* `oClassInfo` might contain the same kind of information as described in {@link sap.
|
|
13824
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.m.IllustratedMessage.extend}.
|
|
13845
13825
|
*/
|
|
13846
13826
|
static extend<T extends Record<string, unknown>>(
|
|
13847
13827
|
/**
|
|
@@ -13862,248 +13842,26 @@ declare namespace sap {
|
|
|
13862
13842
|
* Returns a metadata object for class sap.f.IllustratedMessage.
|
|
13863
13843
|
*/
|
|
13864
13844
|
static getMetadata(): sap.ui.core.ElementMetadata;
|
|
13865
|
-
/**
|
|
13866
|
-
* @SINCE 1.88
|
|
13867
|
-
*
|
|
13868
|
-
* Adds some additionalContent to the aggregation {@link #getAdditionalContent additionalContent}.
|
|
13869
|
-
*/
|
|
13870
|
-
addAdditionalContent(
|
|
13871
|
-
/**
|
|
13872
|
-
* The additionalContent to add; if empty, nothing is inserted
|
|
13873
|
-
*/
|
|
13874
|
-
oAdditionalContent: sap.m.Button
|
|
13875
|
-
): this;
|
|
13876
|
-
/**
|
|
13877
|
-
* @SINCE 1.88
|
|
13878
|
-
*
|
|
13879
|
-
* Destroys all the additionalContent in the aggregation {@link #getAdditionalContent additionalContent}.
|
|
13880
|
-
*/
|
|
13881
|
-
destroyAdditionalContent(): this;
|
|
13882
|
-
/**
|
|
13883
|
-
* @SINCE 1.88
|
|
13884
|
-
*
|
|
13885
|
-
* Gets content of aggregation {@link #getAdditionalContent additionalContent}.
|
|
13886
|
-
*
|
|
13887
|
-
* Defines the controls placed below the description as additional content.
|
|
13888
|
-
*
|
|
13889
|
-
* **Note:** Not displayed when `illustrationSize` is set to `Base`.
|
|
13890
|
-
*/
|
|
13891
|
-
getAdditionalContent(): sap.m.Button[];
|
|
13892
|
-
/**
|
|
13893
|
-
* @SINCE 1.88
|
|
13894
|
-
*
|
|
13895
|
-
* Gets current value of property {@link #getDescription description}.
|
|
13896
|
-
*
|
|
13897
|
-
* Defines the description displayed below the title.
|
|
13898
|
-
*
|
|
13899
|
-
* If there is no initial input from the app developer and the default illustration set is being used, a
|
|
13900
|
-
* default description for the current illustration type is going to be displayed. The default description
|
|
13901
|
-
* is stored in the `sap.f` resource bundle.
|
|
13902
|
-
*
|
|
13903
|
-
* Default value is `empty string`.
|
|
13904
|
-
*/
|
|
13905
|
-
getDescription(): string;
|
|
13906
|
-
/**
|
|
13907
|
-
* @SINCE 1.88
|
|
13908
|
-
*
|
|
13909
|
-
* Gets current value of property {@link #getEnableFormattedText enableFormattedText}.
|
|
13910
|
-
*
|
|
13911
|
-
* Defines whether the value set in the `description` property is displayed as formatted text in HTML format.
|
|
13912
|
-
*
|
|
13913
|
-
* For details regarding supported HTML tags, see {@link sap.m.FormattedText}.
|
|
13914
|
-
*
|
|
13915
|
-
* Default value is `false`.
|
|
13916
|
-
*/
|
|
13917
|
-
getEnableFormattedText(): boolean;
|
|
13918
|
-
/**
|
|
13919
|
-
* @SINCE 1.88
|
|
13920
|
-
*
|
|
13921
|
-
* Gets current value of property {@link #getIllustrationSize illustrationSize}.
|
|
13922
|
-
*
|
|
13923
|
-
* Determines which illustration breakpoint variant is used.
|
|
13924
|
-
*
|
|
13925
|
-
* As `IllustratedMessage` adapts itself around the `Illustration`, the other elements of the control are
|
|
13926
|
-
* displayed differently on the different breakpoints/illustration sizes.
|
|
13927
|
-
*
|
|
13928
|
-
* Default value is `Auto`.
|
|
13929
|
-
*/
|
|
13930
|
-
getIllustrationSize(): sap.f.IllustratedMessageSize;
|
|
13931
|
-
/**
|
|
13932
|
-
* @SINCE 1.88
|
|
13933
|
-
*
|
|
13934
|
-
* Gets current value of property {@link #getIllustrationType illustrationType}.
|
|
13935
|
-
*
|
|
13936
|
-
* Determines which illustration type is displayed.
|
|
13937
|
-
*
|
|
13938
|
-
* **Note:** The {@link sap.f.IllustratedMessageType} enumeration contains a default illustration set. If
|
|
13939
|
-
* you want to use another illustration set, you have to register it in the {@link sap.f.IllustrationPool}.
|
|
13940
|
-
*
|
|
13941
|
-
* Example input for the `illustrationType` property is `sapIllus-UnableToLoad`. The logic behind this format
|
|
13942
|
-
* is as follows:
|
|
13943
|
-
* - First is the the illustration set - sapIllus
|
|
13944
|
-
* - Second is the illustration type - UnableToLoad
|
|
13945
|
-
*
|
|
13946
|
-
* Default value is `IllustratedMessageType.NoSearchResults`.
|
|
13947
|
-
*/
|
|
13948
|
-
getIllustrationType(): string;
|
|
13949
|
-
/**
|
|
13950
|
-
* @SINCE 1.88
|
|
13951
|
-
*
|
|
13952
|
-
* Gets current value of property {@link #getTitle title}.
|
|
13953
|
-
*
|
|
13954
|
-
* Defines the title that is displayed below the illustration.
|
|
13955
|
-
*
|
|
13956
|
-
* If there is no initial input from the app developer and the default illustration set is being used, a
|
|
13957
|
-
* default title is displayed corresponding to the current `illustrationType`.
|
|
13958
|
-
*
|
|
13959
|
-
* Default value is `empty string`.
|
|
13960
|
-
*/
|
|
13961
|
-
getTitle(): string;
|
|
13962
|
-
/**
|
|
13963
|
-
* @SINCE 1.88
|
|
13964
|
-
*
|
|
13965
|
-
* Checks for the provided `sap.m.Button` in the aggregation {@link #getAdditionalContent additionalContent}.
|
|
13966
|
-
* and returns its index if found or -1 otherwise.
|
|
13967
|
-
*/
|
|
13968
|
-
indexOfAdditionalContent(
|
|
13969
|
-
/**
|
|
13970
|
-
* The additionalContent whose index is looked for
|
|
13971
|
-
*/
|
|
13972
|
-
oAdditionalContent: sap.m.Button
|
|
13973
|
-
): int;
|
|
13974
|
-
/**
|
|
13975
|
-
* @SINCE 1.88
|
|
13976
|
-
*
|
|
13977
|
-
* Inserts a additionalContent into the aggregation {@link #getAdditionalContent additionalContent}.
|
|
13978
|
-
*/
|
|
13979
|
-
insertAdditionalContent(
|
|
13980
|
-
/**
|
|
13981
|
-
* The additionalContent to insert; if empty, nothing is inserted
|
|
13982
|
-
*/
|
|
13983
|
-
oAdditionalContent: sap.m.Button,
|
|
13984
|
-
/**
|
|
13985
|
-
* The `0`-based index the additionalContent should be inserted at; for a negative value of `iIndex`, the
|
|
13986
|
-
* additionalContent is inserted at position 0; for a value greater than the current size of the aggregation,
|
|
13987
|
-
* the additionalContent is inserted at the last position
|
|
13988
|
-
*/
|
|
13989
|
-
iIndex: int
|
|
13990
|
-
): this;
|
|
13991
|
-
/**
|
|
13992
|
-
* @SINCE 1.88
|
|
13993
|
-
*
|
|
13994
|
-
* Removes a additionalContent from the aggregation {@link #getAdditionalContent additionalContent}.
|
|
13995
|
-
*/
|
|
13996
|
-
removeAdditionalContent(
|
|
13997
|
-
/**
|
|
13998
|
-
* The additionalContent to remove or its index or id
|
|
13999
|
-
*/
|
|
14000
|
-
vAdditionalContent: int | string | sap.m.Button
|
|
14001
|
-
): sap.m.Button;
|
|
14002
|
-
/**
|
|
14003
|
-
* @SINCE 1.88
|
|
14004
|
-
*
|
|
14005
|
-
* Removes all the controls from the aggregation {@link #getAdditionalContent additionalContent}.
|
|
14006
|
-
*
|
|
14007
|
-
* Additionally, it unregisters them from the hosting UIArea.
|
|
14008
|
-
*/
|
|
14009
|
-
removeAllAdditionalContent(): sap.m.Button[];
|
|
14010
|
-
/**
|
|
14011
|
-
* @SINCE 1.88
|
|
14012
|
-
*
|
|
14013
|
-
* Sets a new value for property {@link #getDescription description}.
|
|
14014
|
-
*
|
|
14015
|
-
* Defines the description displayed below the title.
|
|
14016
|
-
*
|
|
14017
|
-
* If there is no initial input from the app developer and the default illustration set is being used, a
|
|
14018
|
-
* default description for the current illustration type is going to be displayed. The default description
|
|
14019
|
-
* is stored in the `sap.f` resource bundle.
|
|
14020
|
-
*
|
|
14021
|
-
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
14022
|
-
*
|
|
14023
|
-
* Default value is `empty string`.
|
|
14024
|
-
*/
|
|
14025
|
-
setDescription(
|
|
14026
|
-
/**
|
|
14027
|
-
* New value for property `description`
|
|
14028
|
-
*/
|
|
14029
|
-
sDescription?: string
|
|
14030
|
-
): this;
|
|
14031
|
-
/**
|
|
14032
|
-
* @SINCE 1.88
|
|
14033
|
-
*
|
|
14034
|
-
* Sets a new value for property {@link #getEnableFormattedText enableFormattedText}.
|
|
14035
|
-
*
|
|
14036
|
-
* Defines whether the value set in the `description` property is displayed as formatted text in HTML format.
|
|
14037
|
-
*
|
|
14038
|
-
* For details regarding supported HTML tags, see {@link sap.m.FormattedText}.
|
|
14039
|
-
*
|
|
14040
|
-
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
14041
|
-
*
|
|
14042
|
-
* Default value is `false`.
|
|
14043
|
-
*/
|
|
14044
|
-
setEnableFormattedText(
|
|
14045
|
-
/**
|
|
14046
|
-
* New value for property `enableFormattedText`
|
|
14047
|
-
*/
|
|
14048
|
-
bEnableFormattedText?: boolean
|
|
14049
|
-
): this;
|
|
14050
|
-
/**
|
|
14051
|
-
* @SINCE 1.88
|
|
14052
|
-
*
|
|
14053
|
-
* Sets a new value for property {@link #getIllustrationSize illustrationSize}.
|
|
14054
|
-
*
|
|
14055
|
-
* Determines which illustration breakpoint variant is used.
|
|
14056
|
-
*
|
|
14057
|
-
* As `IllustratedMessage` adapts itself around the `Illustration`, the other elements of the control are
|
|
14058
|
-
* displayed differently on the different breakpoints/illustration sizes.
|
|
14059
|
-
*
|
|
14060
|
-
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
14061
|
-
*
|
|
14062
|
-
* Default value is `Auto`.
|
|
14063
|
-
*/
|
|
14064
|
-
setIllustrationSize(
|
|
14065
|
-
/**
|
|
14066
|
-
* New value for property `illustrationSize`
|
|
14067
|
-
*/
|
|
14068
|
-
sIllustrationSize?: sap.f.IllustratedMessageSize
|
|
14069
|
-
): this;
|
|
14070
|
-
/**
|
|
14071
|
-
* @SINCE 1.88
|
|
14072
|
-
*
|
|
14073
|
-
* Sets a new value for property {@link #getTitle title}.
|
|
14074
|
-
*
|
|
14075
|
-
* Defines the title that is displayed below the illustration.
|
|
14076
|
-
*
|
|
14077
|
-
* If there is no initial input from the app developer and the default illustration set is being used, a
|
|
14078
|
-
* default title is displayed corresponding to the current `illustrationType`.
|
|
14079
|
-
*
|
|
14080
|
-
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
14081
|
-
*
|
|
14082
|
-
* Default value is `empty string`.
|
|
14083
|
-
*/
|
|
14084
|
-
setTitle(
|
|
14085
|
-
/**
|
|
14086
|
-
* New value for property `title`
|
|
14087
|
-
*/
|
|
14088
|
-
sTitle?: string
|
|
14089
|
-
): this;
|
|
14090
13845
|
}
|
|
14091
13846
|
/**
|
|
14092
13847
|
* @SINCE 1.88
|
|
14093
|
-
* @
|
|
13848
|
+
* @deprecated (since 1.98) - Use the {@link sap.m.Illustration} instead.
|
|
14094
13849
|
*
|
|
14095
13850
|
* A simple control which uses a Symbol ID to visualize an SVG which has already been loaded in the {@link
|
|
14096
13851
|
* sap.f.IllustrationPool}.
|
|
14097
13852
|
*
|
|
14098
13853
|
* To build a Symbol ID, all of the `Illustration` properties must be populated with data.
|
|
14099
13854
|
*/
|
|
14100
|
-
class Illustration extends sap.
|
|
13855
|
+
class Illustration extends sap.m.Illustration {
|
|
14101
13856
|
/**
|
|
14102
13857
|
* Constructor for a new `Illustration`.
|
|
14103
13858
|
*
|
|
14104
13859
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
14105
13860
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
14106
13861
|
* of the syntax of the settings object.
|
|
13862
|
+
*
|
|
13863
|
+
* This class does not have its own settings, but all settings applicable to the base type {@link sap.m.Illustration#constructor
|
|
13864
|
+
* sap.m.Illustration} can be used.
|
|
14107
13865
|
*/
|
|
14108
13866
|
constructor(
|
|
14109
13867
|
/**
|
|
@@ -14117,6 +13875,9 @@ declare namespace sap {
|
|
|
14117
13875
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
14118
13876
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
14119
13877
|
* of the syntax of the settings object.
|
|
13878
|
+
*
|
|
13879
|
+
* This class does not have its own settings, but all settings applicable to the base type {@link sap.m.Illustration#constructor
|
|
13880
|
+
* sap.m.Illustration} can be used.
|
|
14120
13881
|
*/
|
|
14121
13882
|
constructor(
|
|
14122
13883
|
/**
|
|
@@ -14133,7 +13894,7 @@ declare namespace sap {
|
|
|
14133
13894
|
* Creates a new subclass of class sap.f.Illustration with name `sClassName` and enriches it with the information
|
|
14134
13895
|
* contained in `oClassInfo`.
|
|
14135
13896
|
*
|
|
14136
|
-
* `oClassInfo` might contain the same kind of information as described in {@link sap.
|
|
13897
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.m.Illustration.extend}.
|
|
14137
13898
|
*/
|
|
14138
13899
|
static extend<T extends Record<string, unknown>>(
|
|
14139
13900
|
/**
|
|
@@ -14154,75 +13915,6 @@ declare namespace sap {
|
|
|
14154
13915
|
* Returns a metadata object for class sap.f.Illustration.
|
|
14155
13916
|
*/
|
|
14156
13917
|
static getMetadata(): sap.ui.core.ElementMetadata;
|
|
14157
|
-
/**
|
|
14158
|
-
* @SINCE 1.88
|
|
14159
|
-
*
|
|
14160
|
-
* Gets current value of property {@link #getMedia media}.
|
|
14161
|
-
*
|
|
14162
|
-
* Defines which media/breakpoint should be used when building the Symbol ID.
|
|
14163
|
-
*/
|
|
14164
|
-
getMedia(): string;
|
|
14165
|
-
/**
|
|
14166
|
-
* @SINCE 1.88
|
|
14167
|
-
*
|
|
14168
|
-
* Gets current value of property {@link #getSet set}.
|
|
14169
|
-
*
|
|
14170
|
-
* Defines which illustration set should be used when building the Symbol ID.
|
|
14171
|
-
*/
|
|
14172
|
-
getSet(): string;
|
|
14173
|
-
/**
|
|
14174
|
-
* @SINCE 1.88
|
|
14175
|
-
*
|
|
14176
|
-
* Gets current value of property {@link #getType type}.
|
|
14177
|
-
*
|
|
14178
|
-
* Defines which illustration type should be used when building the Symbol ID.
|
|
14179
|
-
*/
|
|
14180
|
-
getType(): string;
|
|
14181
|
-
/**
|
|
14182
|
-
* @SINCE 1.88
|
|
14183
|
-
*
|
|
14184
|
-
* Sets a new value for property {@link #getMedia media}.
|
|
14185
|
-
*
|
|
14186
|
-
* Defines which media/breakpoint should be used when building the Symbol ID.
|
|
14187
|
-
*
|
|
14188
|
-
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
14189
|
-
*/
|
|
14190
|
-
setMedia(
|
|
14191
|
-
/**
|
|
14192
|
-
* New value for property `media`
|
|
14193
|
-
*/
|
|
14194
|
-
sMedia?: string
|
|
14195
|
-
): this;
|
|
14196
|
-
/**
|
|
14197
|
-
* @SINCE 1.88
|
|
14198
|
-
*
|
|
14199
|
-
* Sets a new value for property {@link #getSet set}.
|
|
14200
|
-
*
|
|
14201
|
-
* Defines which illustration set should be used when building the Symbol ID.
|
|
14202
|
-
*
|
|
14203
|
-
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
14204
|
-
*/
|
|
14205
|
-
setSet(
|
|
14206
|
-
/**
|
|
14207
|
-
* New value for property `set`
|
|
14208
|
-
*/
|
|
14209
|
-
sSet?: string
|
|
14210
|
-
): this;
|
|
14211
|
-
/**
|
|
14212
|
-
* @SINCE 1.88
|
|
14213
|
-
*
|
|
14214
|
-
* Sets a new value for property {@link #getType type}.
|
|
14215
|
-
*
|
|
14216
|
-
* Defines which illustration type should be used when building the Symbol ID.
|
|
14217
|
-
*
|
|
14218
|
-
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
14219
|
-
*/
|
|
14220
|
-
setType(
|
|
14221
|
-
/**
|
|
14222
|
-
* New value for property `type`
|
|
14223
|
-
*/
|
|
14224
|
-
sType?: string
|
|
14225
|
-
): this;
|
|
14226
13918
|
}
|
|
14227
13919
|
/**
|
|
14228
13920
|
* @SINCE 1.72
|
|
@@ -16188,91 +15880,6 @@ declare namespace sap {
|
|
|
16188
15880
|
*/
|
|
16189
15881
|
Middle = "Middle",
|
|
16190
15882
|
}
|
|
16191
|
-
/**
|
|
16192
|
-
* @EXPERIMENTAL (since 1.88)
|
|
16193
|
-
*
|
|
16194
|
-
* Available `Illustration` sizes for the {@link sap.f.IllustratedMessage} control.
|
|
16195
|
-
*/
|
|
16196
|
-
enum IllustratedMessageSize {
|
|
16197
|
-
/**
|
|
16198
|
-
* Automatically decides the `Illustration` size (`Base`, `Spot`, `Dialog`, or `Scene`) depending on the
|
|
16199
|
-
* `IllustratedMessage` container width.
|
|
16200
|
-
*
|
|
16201
|
-
* **Note:** `Auto` is the only option where the illustration size is changed according to the available
|
|
16202
|
-
* container width. If any other `IllustratedMessageSize` is chosen, it remains until changed by the app
|
|
16203
|
-
* developer.
|
|
16204
|
-
*/
|
|
16205
|
-
Auto = "Auto",
|
|
16206
|
-
/**
|
|
16207
|
-
* Base `Illustration` size (XS breakpoint). Suitable for cards (two columns).
|
|
16208
|
-
*
|
|
16209
|
-
* **Note:** When `Base` is in use, no illustration is displayed.
|
|
16210
|
-
*/
|
|
16211
|
-
Base = "Base",
|
|
16212
|
-
/**
|
|
16213
|
-
* Dialog `Illustration` size (M breakpoint). Suitable for dialogs.
|
|
16214
|
-
*/
|
|
16215
|
-
Dialog = "Dialog",
|
|
16216
|
-
/**
|
|
16217
|
-
* Scene `Illustration` size (L breakpoint). Suitable for a `Page` or a table.
|
|
16218
|
-
*/
|
|
16219
|
-
Scene = "Scene",
|
|
16220
|
-
/**
|
|
16221
|
-
* Spot `Illustration` size (S breakpoint). Suitable for cards (four columns).
|
|
16222
|
-
*/
|
|
16223
|
-
Spot = "Spot",
|
|
16224
|
-
}
|
|
16225
|
-
/**
|
|
16226
|
-
* @EXPERIMENTAL (since 1.88)
|
|
16227
|
-
*
|
|
16228
|
-
* Available `Illustration` types for the {@link sap.f.IllustratedMessage} control.
|
|
16229
|
-
*/
|
|
16230
|
-
enum IllustratedMessageType {
|
|
16231
|
-
/**
|
|
16232
|
-
* "Before Search" illustration type.
|
|
16233
|
-
*/
|
|
16234
|
-
BeforeSearch = "sapIllus-BeforeSearch",
|
|
16235
|
-
/**
|
|
16236
|
-
* "No Activities" illustration type.
|
|
16237
|
-
*/
|
|
16238
|
-
NoActivities = "sapIllus-NoActivities",
|
|
16239
|
-
/**
|
|
16240
|
-
* "No Data" illustration type.
|
|
16241
|
-
*/
|
|
16242
|
-
NoData = "sapIllus-NoData",
|
|
16243
|
-
/**
|
|
16244
|
-
* "No Entries" illustration type.
|
|
16245
|
-
*/
|
|
16246
|
-
NoEntries = "sapIllus-NoEntries",
|
|
16247
|
-
/**
|
|
16248
|
-
* "No Email" illustration type.
|
|
16249
|
-
*/
|
|
16250
|
-
NoMail = "sapIllus-NoMail",
|
|
16251
|
-
/**
|
|
16252
|
-
* "No Notifications" illustration type.
|
|
16253
|
-
*/
|
|
16254
|
-
NoNotifications = "sapIllus-NoNotifications",
|
|
16255
|
-
/**
|
|
16256
|
-
* "No Saved Items" illustration type.
|
|
16257
|
-
*/
|
|
16258
|
-
NoSavedItems = "sapIllus-NoSavedItems",
|
|
16259
|
-
/**
|
|
16260
|
-
* "No Search Results" illustration type.
|
|
16261
|
-
*/
|
|
16262
|
-
NoSearchResults = "sapIllus-NoSearchResults",
|
|
16263
|
-
/**
|
|
16264
|
-
* "No Tasks" illustration type.
|
|
16265
|
-
*/
|
|
16266
|
-
NoTasks = "sapIllus-NoTasks",
|
|
16267
|
-
/**
|
|
16268
|
-
* "Unable To Load" illustration type.
|
|
16269
|
-
*/
|
|
16270
|
-
UnableToLoad = "sapIllus-UnableToLoad",
|
|
16271
|
-
/**
|
|
16272
|
-
* "Unable To Upload" illustration type.
|
|
16273
|
-
*/
|
|
16274
|
-
UnableToUpload = "sapIllus-UnableToUpload",
|
|
16275
|
-
}
|
|
16276
15883
|
/**
|
|
16277
15884
|
* @SINCE 1.46
|
|
16278
15885
|
*
|
|
@@ -16471,6 +16078,26 @@ declare namespace sap {
|
|
|
16471
16078
|
* A string type that represents the shrink ratios of the areas within the `sap.f.DynamicPageTitle`.
|
|
16472
16079
|
*/
|
|
16473
16080
|
type DynamicPageTitleShrinkRatio = string;
|
|
16081
|
+
|
|
16082
|
+
/**
|
|
16083
|
+
* @SINCE 1.88
|
|
16084
|
+
* @deprecated (since 1.98) - Use the {@link sap.m.IllustratedMessageSize} instead.
|
|
16085
|
+
*
|
|
16086
|
+
* Available `Illustration` sizes for the {@link sap.f.IllustratedMessage} control.
|
|
16087
|
+
*
|
|
16088
|
+
* This is an alias for {@link sap.m.IllustratedMessageSize} and only kept for compatibility reasons.
|
|
16089
|
+
*/
|
|
16090
|
+
type IllustratedMessageSize = sap.m.IllustratedMessageSize;
|
|
16091
|
+
|
|
16092
|
+
/**
|
|
16093
|
+
* @SINCE 1.88
|
|
16094
|
+
* @deprecated (since 1.98) - Use the {@link sap.m.IllustratedMessageType} instead.
|
|
16095
|
+
*
|
|
16096
|
+
* Available `Illustration` types for the {@link sap.f.IllustratedMessage} control.
|
|
16097
|
+
*
|
|
16098
|
+
* This is an alias for {@link sap.m.IllustratedMessageType} and only kept for compatibility reasons.
|
|
16099
|
+
*/
|
|
16100
|
+
type IllustratedMessageType = sap.m.IllustratedMessageType;
|
|
16474
16101
|
}
|
|
16475
16102
|
|
|
16476
16103
|
namespace tnt {
|