@openui5/ts-types 1.96.2 → 1.98.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/types/sap.f.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.96.2
1
+ // For Library Version: 1.98.0
2
2
 
3
3
  declare namespace sap {
4
4
  /**
@@ -1342,7 +1342,7 @@ declare namespace sap {
1342
1342
  * The `sap.f.routing.Router` class is intended to be used with `{@link sap.f.FlexibleColumnLayout}` as
1343
1343
  * a root control.
1344
1344
  *
1345
- * The difference to the `{@link sap.ui.core.routing.Router}` are the `viewLevel`, `transition`, and `transitionParameters`
1345
+ * The difference to the `{@link sap.ui.core.routing.Router}` are the `level`, `transition`, and `transitionParameters`
1346
1346
  * properties that you can specify in every Route or Target created by this router.
1347
1347
  *
1348
1348
  * The difference to the `{@link sap.m.routing.Router}` is the additional `layout` property that can be
@@ -1476,7 +1476,7 @@ declare namespace sap {
1476
1476
  *
1477
1477
  * The `sap.f` extension of `Targets` also handles the triggering of page navigation when the target control
1478
1478
  * is an `{@link sap.f.FlexibleColumnLayout}`. Other controls are also allowed, but the extra parameters
1479
- * `viewLevel`, `transition`, and `transitionParameters` are ignored and it behaves as `{@link sap.ui.core.routing.Targets}`.
1479
+ * `level`, `transition`, and `transitionParameters` are ignored and it behaves as `{@link sap.ui.core.routing.Targets}`.
1480
1480
  *
1481
1481
  * When a target is displayed, dialogs are being closed. To change this, use `{@link #getTargetHandler}`
1482
1482
  * and {@link sap.f.routing.TargetHandler#setCloseDialogs}.
@@ -1487,7 +1487,7 @@ declare namespace sap {
1487
1487
  */
1488
1488
  constructor(oOptions: {
1489
1489
  /**
1490
- * The views instance will create the views of all the targets defined, so if 2 targets have the same viewName,
1490
+ * the views instance will create the views of all the targets defined, so if 2 targets have the same name,
1491
1491
  * the same instance of the view will be displayed.
1492
1492
  */
1493
1493
  views: sap.ui.core.routing.Views;
@@ -1574,13 +1574,15 @@ declare namespace sap {
1574
1574
  * {
1575
1575
  * targets: {
1576
1576
  * welcome: {
1577
- * viewName: "Welcome",
1577
+ * type: "View",
1578
+ * name: "Welcome",
1578
1579
  * viewType: "XML",
1579
1580
  * ....
1580
1581
  * // Other target parameters
1581
1582
  * },
1582
1583
  * goodbye: {
1583
- * viewName: "Bye",
1584
+ * type: "View",
1585
+ * name: "Bye",
1584
1586
  * viewType: "JS",
1585
1587
  * ....
1586
1588
  * // Other target parameters
@@ -1596,8 +1598,14 @@ declare namespace sap {
1596
1598
  */
1597
1599
  anyName: {
1598
1600
  /**
1599
- * The name of a view that will be created. To place the view into a Control use the `controlAggregation`
1600
- * and `controlId`. Views are only created once per `viewName`.
1601
+ * Defines whether the target creates an instance of 'View' or 'Component'.
1602
+ */
1603
+ type: string;
1604
+ /**
1605
+ * Defines the name of the View or Component that will be created. For type 'Component', use option `usage`
1606
+ * instead if an owner component exists. To place the view or component into a Control, use the options
1607
+ * `controlAggregation` and `controlId`. Instance of View or Component will only be created once per `name`
1608
+ * or `usage` combined with `id`.
1601
1609
  * ```javascript
1602
1610
  *
1603
1611
  *
@@ -1605,14 +1613,16 @@ declare namespace sap {
1605
1613
  * targets: {
1606
1614
  * // If display("masterWelcome") is called, the master view will be placed in the 'MasterPages' of a control with the id splitContainter
1607
1615
  * masterWelcome: {
1608
- * viewName: "Welcome",
1616
+ * type: "View",
1617
+ * name: "Welcome",
1609
1618
  * controlId: "splitContainer",
1610
1619
  * controlAggregation: "masterPages"
1611
1620
  * },
1612
1621
  * // 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
1622
  * detailWelcome: {
1614
1623
  * // same view here, that's why the same instance is used
1615
- * viewName: "Welcome",
1624
+ * type: "View",
1625
+ * name: "Welcome",
1616
1626
  * controlId: "splitContainer",
1617
1627
  * controlAggregation: "detailPages"
1618
1628
  * }
@@ -1622,28 +1632,28 @@ declare namespace sap {
1622
1632
  * ```
1623
1633
  *
1624
1634
  *
1625
- * If you want to have a second instance of the welcome view you can use the following:
1635
+ * If you want to have a second instance of the welcome view you can assign the targets with different ids:
1626
1636
  *
1627
1637
  *
1628
1638
  * ```javascript
1629
1639
  *
1630
1640
  *
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
1641
  * {
1636
1642
  * targets: {
1637
- * // If display("masterWelcome") is called, the master viewName will be placed in the 'MasterPages' of a control with the id splitContainter
1643
+ * // If display("masterWelcome") is called, the "masterWelcome" view will be placed in the 'MasterPages' of a control with the id splitContainter
1638
1644
  * masterWelcome: {
1639
- * viewName: "Welcome",
1645
+ * type: "View",
1646
+ * name: "Welcome",
1647
+ * id: "masterWelcome",
1640
1648
  * controlId: "splitContainer",
1641
1649
  * controlAggregation: "masterPages"
1642
1650
  * },
1643
- * // If display("detailWelcome") is called after the masterWelcome, a second instance with an own controller instance will be added in the detail pages.
1651
+ * // If display("detailWelcome") is called after the "masterWelcome", a second instance with an own controller instance will be added in the detail pages.
1644
1652
  * detailWelcome: {
1645
- * // same viewName here, that's why the same instance is used
1646
- * viewName: "WelcomeWithAlias",
1653
+ * type: "View",
1654
+ * name: "Welcome",
1655
+ * // another instance will be created because a different id is used
1656
+ * id: "detailWelcome",
1647
1657
  * controlId: "splitContainer",
1648
1658
  * controlAggregation: "detailPages"
1649
1659
  * }
@@ -1652,7 +1662,12 @@ declare namespace sap {
1652
1662
  *
1653
1663
  * ```
1654
1664
  */
1655
- viewName: string;
1665
+ name?: string;
1666
+ /**
1667
+ * Defines the 'usage' name for 'Component' target which refers to the '/sap.ui5/componentUsages' entry
1668
+ * in the owner component's manifest.
1669
+ */
1670
+ usage?: string;
1656
1671
  /**
1657
1672
  * The type of the view that is going to be created. These are the supported types: {@link sap.ui.core.mvc.ViewType}.
1658
1673
  * You always have to provide a viewType except if `oOptions.config.viewType` is set or when using {@link
@@ -1660,17 +1675,17 @@ declare namespace sap {
1660
1675
  */
1661
1676
  viewType?: string;
1662
1677
  /**
1663
- * A prefix that is prepended in front of the `viewName`.
1678
+ * A prefix that is prepended in front of the `name`.
1664
1679
  *
1665
- * **Example:** `viewName` is set to "myView" and `viewPath` is set to "myApp" - the created viewName will
1666
- * be "myApp.myView".
1680
+ * **Example:** `name` is set to "myView" and `path` is set to "myApp" - the created view's name will be
1681
+ * "myApp.myView".
1667
1682
  */
1668
- viewPath?: string;
1683
+ path?: string;
1669
1684
  /**
1670
- * The ID of the created view. This is is prefixed with the ID of the component set to the views instance
1671
- * provided in `oOptions.views`. For details, see `{@link sap.ui.core.routing.Views#getView}`.
1685
+ * The ID of the created view or component. This is is prefixed with the ID of the component set to the
1686
+ * views instance provided in `oOptions.views`. For details, see `{@link sap.ui.core.routing.Views#getView}`.
1672
1687
  */
1673
- viewId?: string;
1688
+ id?: string;
1674
1689
  /**
1675
1690
  * The ID of the parent of the `controlId`.
1676
1691
  *
@@ -1759,11 +1774,13 @@ declare namespace sap {
1759
1774
  * // a reference to the app control in the rootView created by our UIComponent
1760
1775
  * controlId: 'myApp',
1761
1776
  * // An app has a pages aggregation where the views need to be put into
1762
- * controlAggregation: 'pages'
1777
+ * controlAggregation: 'pages',
1778
+ * // all targets have type "View"
1779
+ * type: "View"
1763
1780
  * },
1764
1781
  * targets: {
1765
1782
  * detail: {
1766
- * viewName: 'Detail'
1783
+ * name: 'Detail'
1767
1784
  * },
1768
1785
  * secondTabContent: {
1769
1786
  * // A reference to the detail target defined above
@@ -1773,7 +1790,7 @@ declare namespace sap {
1773
1790
  * // An IconTabFilter has an aggregation called content so we need to overwrite the pages set in the config as default.
1774
1791
  * controlAggregation: 'content',
1775
1792
  * // A view containing the content
1776
- * viewName: 'SecondTabContent'
1793
+ * name: 'SecondTabContent'
1777
1794
  * }
1778
1795
  * }
1779
1796
  * });
@@ -1790,11 +1807,11 @@ declare namespace sap {
1790
1807
  /**
1791
1808
  * If you are having an application that has a logical order of views (eg: a create account process, first
1792
1809
  * 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 viewLevel. The
1794
- * viewLevel has to be an integer. The user data page should have a lower number than the confirm page.
1795
- * These levels should represent the user process of your application and they do not have to match the
1796
- * container structure of your Targets. If the user navigates between views with the same viewLevel, a forward
1797
- * transition is taken. If you pass a direction into the display function, the viewLevel will be ignored.
1810
+ * navigation from the confirm to the userData page takes place. Therefore you may use the `level`. The
1811
+ * `level` has to be an integer. The user data page should have a lower number than the confirm page. These
1812
+ * levels should represent the user process of your application and they do not have to match the container
1813
+ * structure of your Targets. If the user navigates between targets with the same `level`, a forward transition
1814
+ * is taken. If you pass a direction into the display function, the `level` will be ignored.
1798
1815
  *
1799
1816
  * **Example:**
1800
1817
  *
@@ -1805,15 +1822,15 @@ declare namespace sap {
1805
1822
  * {
1806
1823
  * targets: {
1807
1824
  * startPage: {
1808
- * viewLevel: 0
1825
+ * level: 0
1809
1826
  * // more properties
1810
1827
  * },
1811
1828
  * userData: {
1812
- * viewLevel: 1
1829
+ * level: 1
1813
1830
  * // more properties
1814
1831
  * },
1815
1832
  * confirmRegistration: {
1816
- * viewLevel: 2
1833
+ * level: 2
1817
1834
  * // more properties
1818
1835
  * },
1819
1836
  * settings: {
@@ -1826,14 +1843,14 @@ declare namespace sap {
1826
1843
  *
1827
1844
  *
1828
1845
  * Currently the 'userData' target is displayed.
1829
- * - If we navigate to 'startPage' the navContainer will show a backwards navigation, since the viewLevel
1846
+ * - If we navigate to 'startPage' the navContainer will show a backwards navigation, since the `level`
1830
1847
  * is lower.
1831
- * - If we navigate to 'userData' the navContainer will show a forwards navigation, since the viewLevel
1848
+ * - If we navigate to 'userData' the navContainer will show a forwards navigation, since the `level`
1832
1849
  * is higher.
1833
- * - If we navigate to 'settings' the navContainer will show a forwards navigation, since the viewLevel
1850
+ * - If we navigate to 'settings' the navContainer will show a forwards navigation, since the `level`
1834
1851
  * is not defined and cannot be compared.
1835
1852
  */
1836
- viewLevel?: int;
1853
+ level?: int;
1837
1854
  /**
1838
1855
  * Defines which transition of the {@link sap.m.NavContainer} is applied when navigating. If it is not defined,
1839
1856
  * the `NavContainer` take its default transition.
@@ -6847,101 +6864,10 @@ declare namespace sap {
6847
6864
  | sap.ui.base.ManagedObject.AggregationBindingInfo;
6848
6865
  }
6849
6866
 
6850
- interface $IllustratedMessageSettings extends sap.ui.core.$ControlSettings {
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;
6867
+ interface $IllustratedMessageSettings
6868
+ extends sap.m.$IllustratedMessageSettings {}
6899
6869
 
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;
6937
-
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
- }
6870
+ interface $IllustrationSettings extends sap.m.$IllustrationSettings {}
6945
6871
 
6946
6872
  interface $ProductSwitchSettings extends sap.ui.core.$ControlSettings {
6947
6873
  /**
@@ -7199,70 +7125,26 @@ declare namespace sap {
7199
7125
  }
7200
7126
 
7201
7127
  /**
7202
- * @EXPERIMENTAL (since 1.88)
7128
+ * @SINCE 1.88
7129
+ * @deprecated (since 1.98) - Use the {@link sap.m.IllustrationPool} instead.
7203
7130
  *
7204
7131
  * `IllustrationPool` loads the illustration assets (SVGs) via XMLHttpRequest requests.
7205
7132
  *
7206
7133
  * The successfully loaded data is kept in the DOM (div with ID `sap-illustration-pool`) in the `sap-ui-static`
7207
7134
  * DOM element.
7208
7135
  *
7209
- * To load a given asset, register its illustration set through the {@link sap.f.IllustrationPool.registerIllustrationSet
7136
+ * To load a given asset, register its illustration set through the {@link sap.m.IllustrationPool#sap.m.IllustrationPool.registerIllustrationSet
7210
7137
  * registerIllustrationSet} API of `IllustrationPool`. The exception being the `sapIllus`, which is the
7211
7138
  * default illustration set that is registered by default.
7212
7139
  *
7213
7140
  * The default behavior of `IllustrationPool` is to load/require an asset only when it's needed by using
7214
- * the {@link sap.f.IllustrationPool.loadAsset} API. When registering the new illustration set, you are
7215
- * given the option to load all of its assets.
7141
+ * the {@link sap.m.IllustrationPool#sap.m.IllustrationPool.loadAsset loadAsset} API. When registering the
7142
+ * new illustration set, you are given the option to load all of its assets.
7216
7143
  *
7217
7144
  * 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.f.IllustrationPool.loadRestOfTheAssets} API.
7145
+ * {@link sap.m.IllustrationPool#sap.m.IllustrationPool.loadRestOfTheAssets loadRestOfTheAssets} API.
7219
7146
  */
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
- }
7147
+ interface IllustrationPool {}
7266
7148
  const IllustrationPool: IllustrationPool;
7267
7149
 
7268
7150
  /**
@@ -13776,7 +13658,7 @@ declare namespace sap {
13776
13658
  }
13777
13659
  /**
13778
13660
  * @SINCE 1.88
13779
- * @EXPERIMENTAL (since 1.88)
13661
+ * @deprecated (since 1.98) - Use the {@link sap.m.IllustratedMessage} instead.
13780
13662
  *
13781
13663
  * A combination of message and illustration to represent an empty or a success state.
13782
13664
  *
@@ -13805,13 +13687,16 @@ declare namespace sap {
13805
13687
  * and the available space of its parent container. Some of the structural elements are displayed differently
13806
13688
  * or are omitted in the different breakpoint sizes (XS, S, M, L).
13807
13689
  */
13808
- class IllustratedMessage extends sap.ui.core.Control {
13690
+ class IllustratedMessage extends sap.m.IllustratedMessage {
13809
13691
  /**
13810
13692
  * Constructor for a new `IllustratedMessage`.
13811
13693
  *
13812
13694
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
13813
13695
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
13814
13696
  * of the syntax of the settings object.
13697
+ *
13698
+ * This class does not have its own settings, but all settings applicable to the base type {@link sap.m.IllustratedMessage#constructor
13699
+ * sap.m.IllustratedMessage} can be used.
13815
13700
  */
13816
13701
  constructor(
13817
13702
  /**
@@ -13825,6 +13710,9 @@ declare namespace sap {
13825
13710
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
13826
13711
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
13827
13712
  * of the syntax of the settings object.
13713
+ *
13714
+ * This class does not have its own settings, but all settings applicable to the base type {@link sap.m.IllustratedMessage#constructor
13715
+ * sap.m.IllustratedMessage} can be used.
13828
13716
  */
13829
13717
  constructor(
13830
13718
  /**
@@ -13841,7 +13729,7 @@ declare namespace sap {
13841
13729
  * Creates a new subclass of class sap.f.IllustratedMessage with name `sClassName` and enriches it with
13842
13730
  * the information contained in `oClassInfo`.
13843
13731
  *
13844
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
13732
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.m.IllustratedMessage.extend}.
13845
13733
  */
13846
13734
  static extend<T extends Record<string, unknown>>(
13847
13735
  /**
@@ -13862,248 +13750,26 @@ declare namespace sap {
13862
13750
  * Returns a metadata object for class sap.f.IllustratedMessage.
13863
13751
  */
13864
13752
  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
13753
  }
14091
13754
  /**
14092
13755
  * @SINCE 1.88
14093
- * @EXPERIMENTAL (since 1.88)
13756
+ * @deprecated (since 1.98) - Use the {@link sap.m.Illustration} instead.
14094
13757
  *
14095
13758
  * A simple control which uses a Symbol ID to visualize an SVG which has already been loaded in the {@link
14096
13759
  * sap.f.IllustrationPool}.
14097
13760
  *
14098
13761
  * To build a Symbol ID, all of the `Illustration` properties must be populated with data.
14099
13762
  */
14100
- class Illustration extends sap.ui.core.Control {
13763
+ class Illustration extends sap.m.Illustration {
14101
13764
  /**
14102
13765
  * Constructor for a new `Illustration`.
14103
13766
  *
14104
13767
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
14105
13768
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
14106
13769
  * of the syntax of the settings object.
13770
+ *
13771
+ * This class does not have its own settings, but all settings applicable to the base type {@link sap.m.Illustration#constructor
13772
+ * sap.m.Illustration} can be used.
14107
13773
  */
14108
13774
  constructor(
14109
13775
  /**
@@ -14117,6 +13783,9 @@ declare namespace sap {
14117
13783
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
14118
13784
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
14119
13785
  * of the syntax of the settings object.
13786
+ *
13787
+ * This class does not have its own settings, but all settings applicable to the base type {@link sap.m.Illustration#constructor
13788
+ * sap.m.Illustration} can be used.
14120
13789
  */
14121
13790
  constructor(
14122
13791
  /**
@@ -14133,7 +13802,7 @@ declare namespace sap {
14133
13802
  * Creates a new subclass of class sap.f.Illustration with name `sClassName` and enriches it with the information
14134
13803
  * contained in `oClassInfo`.
14135
13804
  *
14136
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
13805
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.m.Illustration.extend}.
14137
13806
  */
14138
13807
  static extend<T extends Record<string, unknown>>(
14139
13808
  /**
@@ -14154,75 +13823,6 @@ declare namespace sap {
14154
13823
  * Returns a metadata object for class sap.f.Illustration.
14155
13824
  */
14156
13825
  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
13826
  }
14227
13827
  /**
14228
13828
  * @SINCE 1.72
@@ -16188,91 +15788,6 @@ declare namespace sap {
16188
15788
  */
16189
15789
  Middle = "Middle",
16190
15790
  }
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
15791
  /**
16277
15792
  * @SINCE 1.46
16278
15793
  *
@@ -16471,6 +15986,26 @@ declare namespace sap {
16471
15986
  * A string type that represents the shrink ratios of the areas within the `sap.f.DynamicPageTitle`.
16472
15987
  */
16473
15988
  type DynamicPageTitleShrinkRatio = string;
15989
+
15990
+ /**
15991
+ * @SINCE 1.88
15992
+ * @deprecated (since 1.98) - Use the {@link sap.m.IllustratedMessageSize} instead.
15993
+ *
15994
+ * Available `Illustration` sizes for the {@link sap.f.IllustratedMessage} control.
15995
+ *
15996
+ * This is an alias for {@link sap.m.IllustratedMessageSize} and only kept for compatibility reasons.
15997
+ */
15998
+ type IllustratedMessageSize = sap.m.IllustratedMessageSize;
15999
+
16000
+ /**
16001
+ * @SINCE 1.88
16002
+ * @deprecated (since 1.98) - Use the {@link sap.m.IllustratedMessageType} instead.
16003
+ *
16004
+ * Available `Illustration` types for the {@link sap.f.IllustratedMessage} control.
16005
+ *
16006
+ * This is an alias for {@link sap.m.IllustratedMessageType} and only kept for compatibility reasons.
16007
+ */
16008
+ type IllustratedMessageType = sap.m.IllustratedMessageType;
16474
16009
  }
16475
16010
 
16476
16011
  namespace tnt {