@openui5/types 1.114.0 → 1.115.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.114.0
1
+ // For Library Version: 1.115.0
2
2
 
3
3
  declare module "sap/tnt/library" {
4
4
  /**
@@ -59,14 +59,14 @@ declare module "sap/tnt/InfoLabel" {
59
59
  *
60
60
  * Usage Guidelines:
61
61
  * - If the text is longer than the width of the control, it doesn’t wrap. Instead, it’s represented as
62
- * ellipsis.
62
+ * ellipsis.
63
63
  * - When truncated, the full text in the control is not visible. Therefore, it’s recommended to make
64
- * more space for longer items to be fully displayed.
64
+ * more space for longer items to be fully displayed.
65
65
  * - Colors are not semantic and have no visual representation in sap_belize_hcb and sap_belize_hcw themes.
66
66
  *
67
67
  * - The control shows plain text only, formatting is not visualized.
68
68
  */
69
- export default class InfoLabel extends Control implements IFormContent {
69
+ class InfoLabel extends Control implements IFormContent {
70
70
  __implements__sap_ui_core_IFormContent: boolean;
71
71
  /**
72
72
  * Constructor for a new `InfoLabel`.
@@ -354,6 +354,7 @@ declare module "sap/tnt/InfoLabel" {
354
354
  */
355
355
  unbindText(): this;
356
356
  }
357
+ export default InfoLabel;
357
358
 
358
359
  export interface $InfoLabelSettings extends $ControlSettings {
359
360
  /**
@@ -418,8 +419,6 @@ declare module "sap/tnt/NavigationList" {
418
419
 
419
420
  import Event from "sap/ui/base/Event";
420
421
 
421
- import Item from "sap/ui/core/Item";
422
-
423
422
  import ElementMetadata from "sap/ui/core/ElementMetadata";
424
423
 
425
424
  import {
@@ -427,13 +426,15 @@ declare module "sap/tnt/NavigationList" {
427
426
  AggregationBindingInfo,
428
427
  } from "sap/ui/base/ManagedObject";
429
428
 
429
+ import Item from "sap/ui/core/Item";
430
+
430
431
  /**
431
432
  * @SINCE 1.34
432
433
  *
433
434
  * The NavigationList control is an interactive control, which provides a choice of different items, ordered
434
435
  * as a list.
435
436
  */
436
- export default class NavigationList extends Control {
437
+ class NavigationList extends Control {
437
438
  /**
438
439
  * Constructor for a new NavigationList.
439
440
  *
@@ -546,7 +547,7 @@ declare module "sap/tnt/NavigationList" {
546
547
  /**
547
548
  * The function to be called when the event occurs
548
549
  */
549
- fnFunction: (p1: Event) => void,
550
+ fnFunction: (p1: Event<$NavigationListItemSelectEventParameters>) => void,
550
551
  /**
551
552
  * Context object to call the event handler with. Defaults to this `sap.tnt.NavigationList` itself
552
553
  */
@@ -566,7 +567,7 @@ declare module "sap/tnt/NavigationList" {
566
567
  /**
567
568
  * The function to be called when the event occurs
568
569
  */
569
- fnFunction: (p1: Event) => void,
570
+ fnFunction: (p1: Event<$NavigationListItemSelectEventParameters>) => void,
570
571
  /**
571
572
  * Context object to call the event handler with. Defaults to this `sap.tnt.NavigationList` itself
572
573
  */
@@ -589,7 +590,7 @@ declare module "sap/tnt/NavigationList" {
589
590
  /**
590
591
  * The function to be called, when the event occurs
591
592
  */
592
- fnFunction: (p1: Event) => void,
593
+ fnFunction: (p1: Event<$NavigationListItemSelectEventParameters>) => void,
593
594
  /**
594
595
  * Context object on which the given function had to be called
595
596
  */
@@ -606,21 +607,14 @@ declare module "sap/tnt/NavigationList" {
606
607
  /**
607
608
  * Parameters to pass along with the event
608
609
  */
609
- mParameters?: {
610
- /**
611
- * The selected item.
612
- */
613
- item?: Item;
614
- }
610
+ mParameters?: $NavigationListItemSelectEventParameters
615
611
  ): this;
616
612
  /**
617
- * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy
618
- * ariaDescribedBy}.
613
+ * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}.
619
614
  */
620
615
  getAriaDescribedBy(): ID[];
621
616
  /**
622
- * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy
623
- * ariaLabelledBy}.
617
+ * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
624
618
  */
625
619
  getAriaLabelledBy(): ID[];
626
620
  /**
@@ -800,6 +794,7 @@ declare module "sap/tnt/NavigationList" {
800
794
  sWidth: CSSSize
801
795
  ): this;
802
796
  }
797
+ export default NavigationList;
803
798
 
804
799
  export interface $NavigationListSettings extends $ControlSettings {
805
800
  /**
@@ -848,7 +843,16 @@ declare module "sap/tnt/NavigationList" {
848
843
  /**
849
844
  * Fired when an item is selected.
850
845
  */
851
- itemSelect?: (oEvent: Event) => void;
846
+ itemSelect?: (
847
+ oEvent: Event<$NavigationListItemSelectEventParameters>
848
+ ) => void;
849
+ }
850
+
851
+ export interface $NavigationListItemSelectEventParameters {
852
+ /**
853
+ * The selected item.
854
+ */
855
+ item?: Item;
852
856
  }
853
857
  }
854
858
 
@@ -872,7 +876,7 @@ declare module "sap/tnt/NavigationListItem" {
872
876
  * The NavigationListItem control represents an action, which can be selected by the user. It can provide
873
877
  * sub items.
874
878
  */
875
- export default class NavigationListItem extends Item {
879
+ class NavigationListItem extends Item {
876
880
  /**
877
881
  * Constructor for a new NavigationListItem.
878
882
  *
@@ -963,7 +967,7 @@ declare module "sap/tnt/NavigationListItem" {
963
967
  /**
964
968
  * The function to be called when the event occurs
965
969
  */
966
- fnFunction: (p1: Event) => void,
970
+ fnFunction: (p1: Event<$NavigationListItemSelectEventParameters>) => void,
967
971
  /**
968
972
  * Context object to call the event handler with. Defaults to this `sap.tnt.NavigationListItem` itself
969
973
  */
@@ -983,7 +987,7 @@ declare module "sap/tnt/NavigationListItem" {
983
987
  /**
984
988
  * The function to be called when the event occurs
985
989
  */
986
- fnFunction: (p1: Event) => void,
990
+ fnFunction: (p1: Event<$NavigationListItemSelectEventParameters>) => void,
987
991
  /**
988
992
  * Context object to call the event handler with. Defaults to this `sap.tnt.NavigationListItem` itself
989
993
  */
@@ -1006,7 +1010,7 @@ declare module "sap/tnt/NavigationListItem" {
1006
1010
  /**
1007
1011
  * The function to be called, when the event occurs
1008
1012
  */
1009
- fnFunction: (p1: Event) => void,
1013
+ fnFunction: (p1: Event<$NavigationListItemSelectEventParameters>) => void,
1010
1014
  /**
1011
1015
  * Context object on which the given function had to be called
1012
1016
  */
@@ -1023,12 +1027,7 @@ declare module "sap/tnt/NavigationListItem" {
1023
1027
  /**
1024
1028
  * Parameters to pass along with the event
1025
1029
  */
1026
- mParameters?: {
1027
- /**
1028
- * The selected item.
1029
- */
1030
- item?: Item;
1031
- }
1030
+ mParameters?: $NavigationListItemSelectEventParameters
1032
1031
  ): this;
1033
1032
  /**
1034
1033
  * Gets current value of property {@link #getExpanded expanded}.
@@ -1040,6 +1039,14 @@ declare module "sap/tnt/NavigationListItem" {
1040
1039
  * @returns Value of property `expanded`
1041
1040
  */
1042
1041
  getExpanded(): boolean;
1042
+ /**
1043
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1044
+ *
1045
+ * Returns the DOM Element that should get the focus.
1046
+ *
1047
+ * @returns Returns the DOM Element that should get the focus
1048
+ */
1049
+ getFocusDomRef(): Element;
1043
1050
  /**
1044
1051
  * Gets current value of property {@link #getHasExpander hasExpander}.
1045
1052
  *
@@ -1253,6 +1260,7 @@ declare module "sap/tnt/NavigationListItem" {
1253
1260
  bVisible?: boolean
1254
1261
  ): this;
1255
1262
  }
1263
+ export default NavigationListItem;
1256
1264
 
1257
1265
  export interface $NavigationListItemSettings extends $ItemSettings {
1258
1266
  /**
@@ -1304,7 +1312,14 @@ declare module "sap/tnt/NavigationListItem" {
1304
1312
  /**
1305
1313
  * Fired when this item is selected.
1306
1314
  */
1307
- select?: (oEvent: Event) => void;
1315
+ select?: (oEvent: Event<$NavigationListItemSelectEventParameters>) => void;
1316
+ }
1317
+
1318
+ export interface $NavigationListItemSelectEventParameters {
1319
+ /**
1320
+ * The selected item.
1321
+ */
1322
+ item?: Item;
1308
1323
  }
1309
1324
  }
1310
1325
 
@@ -1318,8 +1333,6 @@ declare module "sap/tnt/SideNavigation" {
1318
1333
  PropertyBindingInfo,
1319
1334
  } from "sap/ui/base/ManagedObject";
1320
1335
 
1321
- import Item from "sap/ui/core/Item";
1322
-
1323
1336
  import NavigationList from "sap/tnt/NavigationList";
1324
1337
 
1325
1338
  import ElementMetadata from "sap/ui/core/ElementMetadata";
@@ -1328,6 +1341,8 @@ declare module "sap/tnt/SideNavigation" {
1328
1341
 
1329
1342
  import NavigationListItem from "sap/tnt/NavigationListItem";
1330
1343
 
1344
+ import Item from "sap/ui/core/Item";
1345
+
1331
1346
  /**
1332
1347
  * @SINCE 1.34
1333
1348
  *
@@ -1335,9 +1350,9 @@ declare module "sap/tnt/SideNavigation" {
1335
1350
  * other. Responsive Behavior:
1336
1351
  * - The flexible part adapts its size to the fixed one.
1337
1352
  * - The flexible part has a scrollbar when the content is larger than the available space. **Note:**
1338
- * In order for the SideNavigation to stretch properly, its parent layout control should only be the sap.tnt.ToolPage.
1353
+ * In order for the SideNavigation to stretch properly, its parent layout control should only be the sap.tnt.ToolPage.
1339
1354
  */
1340
- export default class SideNavigation extends Control {
1355
+ class SideNavigation extends Control {
1341
1356
  /**
1342
1357
  * Constructor for a new SideNavigation.
1343
1358
  *
@@ -1421,7 +1436,7 @@ declare module "sap/tnt/SideNavigation" {
1421
1436
  /**
1422
1437
  * The function to be called when the event occurs
1423
1438
  */
1424
- fnFunction: (p1: Event) => void,
1439
+ fnFunction: (p1: Event<$SideNavigationItemSelectEventParameters>) => void,
1425
1440
  /**
1426
1441
  * Context object to call the event handler with. Defaults to this `sap.tnt.SideNavigation` itself
1427
1442
  */
@@ -1441,7 +1456,7 @@ declare module "sap/tnt/SideNavigation" {
1441
1456
  /**
1442
1457
  * The function to be called when the event occurs
1443
1458
  */
1444
- fnFunction: (p1: Event) => void,
1459
+ fnFunction: (p1: Event<$SideNavigationItemSelectEventParameters>) => void,
1445
1460
  /**
1446
1461
  * Context object to call the event handler with. Defaults to this `sap.tnt.SideNavigation` itself
1447
1462
  */
@@ -1490,7 +1505,7 @@ declare module "sap/tnt/SideNavigation" {
1490
1505
  /**
1491
1506
  * The function to be called, when the event occurs
1492
1507
  */
1493
- fnFunction: (p1: Event) => void,
1508
+ fnFunction: (p1: Event<$SideNavigationItemSelectEventParameters>) => void,
1494
1509
  /**
1495
1510
  * Context object on which the given function had to be called
1496
1511
  */
@@ -1507,12 +1522,7 @@ declare module "sap/tnt/SideNavigation" {
1507
1522
  /**
1508
1523
  * Parameters to pass along with the event
1509
1524
  */
1510
- mParameters?: {
1511
- /**
1512
- * The selected item.
1513
- */
1514
- item?: Item;
1515
- }
1525
+ mParameters?: $SideNavigationItemSelectEventParameters
1516
1526
  ): this;
1517
1527
  /**
1518
1528
  * @SINCE 1.98
@@ -1659,6 +1669,7 @@ declare module "sap/tnt/SideNavigation" {
1659
1669
  */
1660
1670
  unbindItem(): this;
1661
1671
  }
1672
+ export default SideNavigation;
1662
1673
 
1663
1674
  export interface $SideNavigationSettings extends $ControlSettings {
1664
1675
  /**
@@ -1705,7 +1716,16 @@ declare module "sap/tnt/SideNavigation" {
1705
1716
  /**
1706
1717
  * Fired when an item is selected.
1707
1718
  */
1708
- itemSelect?: (oEvent: Event) => void;
1719
+ itemSelect?: (
1720
+ oEvent: Event<$SideNavigationItemSelectEventParameters>
1721
+ ) => void;
1722
+ }
1723
+
1724
+ export interface $SideNavigationItemSelectEventParameters {
1725
+ /**
1726
+ * The selected item.
1727
+ */
1728
+ item?: Item;
1709
1729
  }
1710
1730
  }
1711
1731
 
@@ -1722,16 +1742,19 @@ declare module "sap/tnt/ToolHeader" {
1722
1742
  /**
1723
1743
  * @SINCE 1.34
1724
1744
  *
1725
- * The ToolHeader control is a horizontal container that is most commonly used to display buttons, labels,
1745
+ * The ToolHeader control is a horizontal container that is most commonly used to display buttons, texts,
1726
1746
  * and other various input controls. Overview: The ToolHeader control is based on {@link sap.m.OverflowToolbar}.
1727
1747
  * It contains clearly structured menus of commands that are available across the various apps within the
1728
1748
  * same tool layout. Usage:
1749
+ * - This control is specialized for administrative applications. For other types of applications use:
1750
+ * {@link sap.m.Shell}
1729
1751
  * - If an app implements side navigation in addition to the tool header menu, the menu icon must be the
1730
- * first item on the left-hand side of the tool header.
1752
+ * first item on the left-hand side of the tool header.
1731
1753
  * - The app menu and the side navigation must not have any dependencies and must work independently.
1732
- * Fiori 3 theme specifics: In Fiori 3 Default theme the ToolHeader is with dark design unlike most
1733
- * of the other controls. This defines the usage of limited controls inside it, which will result in good
1734
- * design combination.
1754
+ * Horizon theme specifics: Only the following controls are supported: sap.m.Button, sap.m.Image,
1755
+ * sap.m.Title, sap.m.Text, sap.m.SearchField, sap.m.Avatar. Fiori 3 theme specifics: In Fiori 3 Default
1756
+ * theme the ToolHeader is with dark design unlike most of the other controls. This defines the usage of
1757
+ * limited controls inside it, which will result in good design combination.
1735
1758
  * The ToolHeader stylizes the contained controls with the Shell color parameters, to match the dark design
1736
1759
  * requirement. However, that's not a dark theme.
1737
1760
  *
@@ -1754,9 +1777,7 @@ declare module "sap/tnt/ToolHeader" {
1754
1777
  * Support for default (Accent 6) color. Image avatar. - sap.m.Image
1755
1778
  * Primarily used for displaying the company logo. Interaction states
1756
1779
  */
1757
- export default class ToolHeader
1758
- extends OverflowToolbar
1759
- implements IToolHeader {
1780
+ class ToolHeader extends OverflowToolbar implements IToolHeader {
1760
1781
  __implements__sap_tnt_IToolHeader: boolean;
1761
1782
  /**
1762
1783
  * Constructor for a new ToolHeader.
@@ -1765,8 +1786,8 @@ declare module "sap/tnt/ToolHeader" {
1765
1786
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1766
1787
  * of the syntax of the settings object.
1767
1788
  *
1768
- * This class does not have its own settings, but all settings applicable to the base type {@link sap.m.OverflowToolbar#constructor
1769
- * sap.m.OverflowToolbar} can be used.
1789
+ * This class does not have its own settings, but all settings applicable to the base type {@link sap.m.OverflowToolbar#constructor sap.m.OverflowToolbar }
1790
+ * can be used.
1770
1791
  * See:
1771
1792
  * {@link fiori:https://experience.sap.com/fiori-design-web/tool-header/ Tool Header}
1772
1793
  */
@@ -1783,8 +1804,8 @@ declare module "sap/tnt/ToolHeader" {
1783
1804
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1784
1805
  * of the syntax of the settings object.
1785
1806
  *
1786
- * This class does not have its own settings, but all settings applicable to the base type {@link sap.m.OverflowToolbar#constructor
1787
- * sap.m.OverflowToolbar} can be used.
1807
+ * This class does not have its own settings, but all settings applicable to the base type {@link sap.m.OverflowToolbar#constructor sap.m.OverflowToolbar }
1808
+ * can be used.
1788
1809
  * See:
1789
1810
  * {@link fiori:https://experience.sap.com/fiori-design-web/tool-header/ Tool Header}
1790
1811
  */
@@ -1829,6 +1850,7 @@ declare module "sap/tnt/ToolHeader" {
1829
1850
  */
1830
1851
  static getMetadata(): ElementMetadata;
1831
1852
  }
1853
+ export default ToolHeader;
1832
1854
 
1833
1855
  export interface $ToolHeaderSettings extends $OverflowToolbarSettings {}
1834
1856
  }
@@ -1844,7 +1866,7 @@ declare module "sap/tnt/ToolHeaderUtilitySeparator" {
1844
1866
  * The ToolHeaderUtilitySeparator control is used in the sap.tnt.ToolHeader control to specify where the
1845
1867
  * overflow button is placed.
1846
1868
  */
1847
- export default class ToolHeaderUtilitySeparator extends Control {
1869
+ class ToolHeaderUtilitySeparator extends Control {
1848
1870
  /**
1849
1871
  * Constructor for a new ToolHeaderUtilitySeparator.
1850
1872
  *
@@ -1852,8 +1874,8 @@ declare module "sap/tnt/ToolHeaderUtilitySeparator" {
1852
1874
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1853
1875
  * of the syntax of the settings object.
1854
1876
  *
1855
- * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.core.Control#constructor
1856
- * sap.ui.core.Control} can be used.
1877
+ * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.core.Control#constructor sap.ui.core.Control }
1878
+ * can be used.
1857
1879
  */
1858
1880
  constructor(
1859
1881
  /**
@@ -1868,8 +1890,8 @@ declare module "sap/tnt/ToolHeaderUtilitySeparator" {
1868
1890
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1869
1891
  * of the syntax of the settings object.
1870
1892
  *
1871
- * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.core.Control#constructor
1872
- * sap.ui.core.Control} can be used.
1893
+ * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.core.Control#constructor sap.ui.core.Control }
1894
+ * can be used.
1873
1895
  */
1874
1896
  constructor(
1875
1897
  /**
@@ -1912,6 +1934,7 @@ declare module "sap/tnt/ToolHeaderUtilitySeparator" {
1912
1934
  */
1913
1935
  static getMetadata(): ElementMetadata;
1914
1936
  }
1937
+ export default ToolHeaderUtilitySeparator;
1915
1938
 
1916
1939
  export interface $ToolHeaderUtilitySeparatorSettings
1917
1940
  extends $ControlSettings {}
@@ -1920,6 +1943,8 @@ declare module "sap/tnt/ToolHeaderUtilitySeparator" {
1920
1943
  declare module "sap/tnt/ToolPage" {
1921
1944
  import { default as Control, $ControlSettings } from "sap/ui/core/Control";
1922
1945
 
1946
+ import { PageBackgroundDesign } from "sap/m/library";
1947
+
1923
1948
  import { IToolHeader } from "sap/tnt/library";
1924
1949
 
1925
1950
  import ElementMetadata from "sap/ui/core/ElementMetadata";
@@ -1936,11 +1961,11 @@ declare module "sap/tnt/ToolPage" {
1936
1961
  *
1937
1962
  * The ToolPage is a layout control, used to create a basic tools app that has a header, side navigation
1938
1963
  * and contents area. Overview: The control has three main areas - a header on top, navigation to the side
1939
- * and a content area that can hold any control. The header and side navigation use custom controls - {@link
1940
- * sap.tnt.ToolHeader} and {@link sap.tnt.SideNavigation}. Usage: The main usage of the sap.tnt controls
1941
- * is for scenarios in the tooling or administration space.
1964
+ * and a content area that can hold any control. The header and side navigation use custom controls - {@link sap.tnt.ToolHeader }
1965
+ * and {@link sap.tnt.SideNavigation}. Usage: The main usage of the sap.tnt controls is for scenarios in
1966
+ * the tooling or administration space.
1942
1967
  */
1943
- export default class ToolPage extends Control {
1968
+ class ToolPage extends Control {
1944
1969
  /**
1945
1970
  * Constructor for a new ToolPage.
1946
1971
  *
@@ -2038,6 +2063,20 @@ declare module "sap/tnt/ToolPage" {
2038
2063
  * @returns Reference to `this` in order to allow method chaining
2039
2064
  */
2040
2065
  destroySubHeader(): this;
2066
+ /**
2067
+ * @SINCE 1.115
2068
+ *
2069
+ * Gets current value of property {@link #getContentBackgroundDesign contentBackgroundDesign}.
2070
+ *
2071
+ * Specifies the content background design.
2072
+ *
2073
+ * Default value is `Standard`.
2074
+ *
2075
+ * @returns Value of property `contentBackgroundDesign`
2076
+ */
2077
+ getContentBackgroundDesign():
2078
+ | PageBackgroundDesign
2079
+ | keyof typeof PageBackgroundDesign;
2041
2080
  /**
2042
2081
  * Gets content of aggregation {@link #getHeader header}.
2043
2082
  *
@@ -2122,6 +2161,27 @@ declare module "sap/tnt/ToolPage" {
2122
2161
  */
2123
2162
  vMainContent: int | string | Control
2124
2163
  ): Control | null;
2164
+ /**
2165
+ * @SINCE 1.115
2166
+ *
2167
+ * Sets a new value for property {@link #getContentBackgroundDesign contentBackgroundDesign}.
2168
+ *
2169
+ * Specifies the content background design.
2170
+ *
2171
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2172
+ *
2173
+ * Default value is `Standard`.
2174
+ *
2175
+ * @returns Reference to `this` in order to allow method chaining
2176
+ */
2177
+ setContentBackgroundDesign(
2178
+ /**
2179
+ * New value for property `contentBackgroundDesign`
2180
+ */
2181
+ sContentBackgroundDesign?:
2182
+ | PageBackgroundDesign
2183
+ | keyof typeof PageBackgroundDesign
2184
+ ): this;
2125
2185
  /**
2126
2186
  * Sets the aggregated {@link #getHeader header}.
2127
2187
  *
@@ -2175,6 +2235,7 @@ declare module "sap/tnt/ToolPage" {
2175
2235
  */
2176
2236
  toggleSideContentMode(): this;
2177
2237
  }
2238
+ export default ToolPage;
2178
2239
 
2179
2240
  export interface $ToolPageSettings extends $ControlSettings {
2180
2241
  /**
@@ -2182,6 +2243,16 @@ declare module "sap/tnt/ToolPage" {
2182
2243
  */
2183
2244
  sideExpanded?: boolean | PropertyBindingInfo | `{${string}}`;
2184
2245
 
2246
+ /**
2247
+ * @SINCE 1.115
2248
+ *
2249
+ * Specifies the content background design.
2250
+ */
2251
+ contentBackgroundDesign?:
2252
+ | (PageBackgroundDesign | keyof typeof PageBackgroundDesign)
2253
+ | PropertyBindingInfo
2254
+ | `{${string}}`;
2255
+
2185
2256
  /**
2186
2257
  * The control to appear in the header area.
2187
2258
  */
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.114.0
1
+ // For Library Version: 1.115.0
2
2
 
3
3
  declare module "sap/ui/codeeditor/library" {}
4
4
 
@@ -20,7 +20,7 @@ declare module "sap/ui/codeeditor/CodeEditor" {
20
20
  * read only mode. Use this control in scenarios where the user should be able to inspect and edit source
21
21
  * code. The control currently uses the third-party code editor Ace.
22
22
  */
23
- export default class CodeEditor extends Control {
23
+ class CodeEditor extends Control {
24
24
  /**
25
25
  * Constructor for a new CodeEditor.
26
26
  *
@@ -115,7 +115,7 @@ declare module "sap/ui/codeeditor/CodeEditor" {
115
115
  /**
116
116
  * The function to be called when the event occurs
117
117
  */
118
- fnFunction: (p1: Event) => void,
118
+ fnFunction: (p1: Event<$CodeEditorChangeEventParameters>) => void,
119
119
  /**
120
120
  * Context object to call the event handler with. Defaults to this `sap.ui.codeeditor.CodeEditor` itself
121
121
  */
@@ -135,7 +135,7 @@ declare module "sap/ui/codeeditor/CodeEditor" {
135
135
  /**
136
136
  * The function to be called when the event occurs
137
137
  */
138
- fnFunction: (p1: Event) => void,
138
+ fnFunction: (p1: Event<$CodeEditorChangeEventParameters>) => void,
139
139
  /**
140
140
  * Context object to call the event handler with. Defaults to this `sap.ui.codeeditor.CodeEditor` itself
141
141
  */
@@ -160,7 +160,7 @@ declare module "sap/ui/codeeditor/CodeEditor" {
160
160
  /**
161
161
  * The function to be called when the event occurs
162
162
  */
163
- fnFunction: (p1: Event) => void,
163
+ fnFunction: (p1: Event<$CodeEditorLiveChangeEventParameters>) => void,
164
164
  /**
165
165
  * Context object to call the event handler with. Defaults to this `sap.ui.codeeditor.CodeEditor` itself
166
166
  */
@@ -180,7 +180,7 @@ declare module "sap/ui/codeeditor/CodeEditor" {
180
180
  /**
181
181
  * The function to be called when the event occurs
182
182
  */
183
- fnFunction: (p1: Event) => void,
183
+ fnFunction: (p1: Event<$CodeEditorLiveChangeEventParameters>) => void,
184
184
  /**
185
185
  * Context object to call the event handler with. Defaults to this `sap.ui.codeeditor.CodeEditor` itself
186
186
  */
@@ -197,7 +197,7 @@ declare module "sap/ui/codeeditor/CodeEditor" {
197
197
  /**
198
198
  * The function to be called, when the event occurs
199
199
  */
200
- fnFunction: (p1: Event) => void,
200
+ fnFunction: (p1: Event<$CodeEditorChangeEventParameters>) => void,
201
201
  /**
202
202
  * Context object on which the given function had to be called
203
203
  */
@@ -214,7 +214,7 @@ declare module "sap/ui/codeeditor/CodeEditor" {
214
214
  /**
215
215
  * The function to be called, when the event occurs
216
216
  */
217
- fnFunction: (p1: Event) => void,
217
+ fnFunction: (p1: Event<$CodeEditorLiveChangeEventParameters>) => void,
218
218
  /**
219
219
  * Context object on which the given function had to be called
220
220
  */
@@ -231,16 +231,7 @@ declare module "sap/ui/codeeditor/CodeEditor" {
231
231
  /**
232
232
  * Parameters to pass along with the event
233
233
  */
234
- mParameters?: {
235
- /**
236
- * The current value of the code editor.
237
- */
238
- value?: string;
239
- /**
240
- * The old value of the code editor.
241
- */
242
- oldValue?: string;
243
- }
234
+ mParameters?: $CodeEditorChangeEventParameters
244
235
  ): this;
245
236
  /**
246
237
  * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
@@ -253,16 +244,7 @@ declare module "sap/ui/codeeditor/CodeEditor" {
253
244
  /**
254
245
  * Parameters to pass along with the event
255
246
  */
256
- mParameters?: {
257
- /**
258
- * The current value of the code editor.
259
- */
260
- value?: string;
261
- /**
262
- * The underlying change event of the third-party code editor.
263
- */
264
- editorEvent?: object;
265
- }
247
+ mParameters?: $CodeEditorLiveChangeEventParameters
266
248
  ): this;
267
249
  /**
268
250
  * Sets the focus to the code editor
@@ -597,6 +579,7 @@ declare module "sap/ui/codeeditor/CodeEditor" {
597
579
  sWidth?: CSSSize
598
580
  ): this;
599
581
  }
582
+ export default CodeEditor;
600
583
 
601
584
  export interface $CodeEditorSettings extends $ControlSettings {
602
585
  /**
@@ -675,12 +658,36 @@ declare module "sap/ui/codeeditor/CodeEditor" {
675
658
  /**
676
659
  * Fired when the value is changed by user interaction - each keystroke, delete, paste, etc.
677
660
  */
678
- liveChange?: (oEvent: Event) => void;
661
+ liveChange?: (oEvent: Event<$CodeEditorLiveChangeEventParameters>) => void;
679
662
 
680
663
  /**
681
664
  * Fired when the value has changed and the focus leaves the code editor.
682
665
  */
683
- change?: (oEvent: Event) => void;
666
+ change?: (oEvent: Event<$CodeEditorChangeEventParameters>) => void;
667
+ }
668
+
669
+ export interface $CodeEditorChangeEventParameters {
670
+ /**
671
+ * The current value of the code editor.
672
+ */
673
+ value?: string;
674
+
675
+ /**
676
+ * The old value of the code editor.
677
+ */
678
+ oldValue?: string;
679
+ }
680
+
681
+ export interface $CodeEditorLiveChangeEventParameters {
682
+ /**
683
+ * The current value of the code editor.
684
+ */
685
+ value?: string;
686
+
687
+ /**
688
+ * The underlying change event of the third-party code editor.
689
+ */
690
+ editorEvent?: object;
684
691
  }
685
692
  }
686
693