@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/package.json +1 -1
- package/types/index.d.ts +1 -1
- package/types/sap.f.d.ts +108 -573
- package/types/sap.m.d.ts +3169 -344
- package/types/sap.tnt.d.ts +31 -1
- 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 +1202 -358
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.fl.d.ts +7 -3
- package/types/sap.ui.integration.d.ts +60 -1
- package/types/sap.ui.layout.d.ts +4 -4
- package/types/sap.ui.mdc.d.ts +31 -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 +794 -244
- package/types/sap.ui.webc.main.d.ts +1059 -552
- package/types/sap.uxap.d.ts +1 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.
|
|
1
|
+
// For Library Version: 1.98.0
|
|
2
2
|
|
|
3
3
|
declare namespace sap {
|
|
4
4
|
namespace ui {
|
|
@@ -22,8 +22,8 @@ declare namespace sap {
|
|
|
22
22
|
}
|
|
23
23
|
|
|
24
24
|
/**
|
|
25
|
-
* @SINCE 1.
|
|
26
|
-
* @EXPERIMENTAL (since 1.
|
|
25
|
+
* @SINCE 1.95.0
|
|
26
|
+
* @EXPERIMENTAL (since 1.95.0)
|
|
27
27
|
*
|
|
28
28
|
* Interface for components that may be slotted inside `ui5-breadcrumbs` as options
|
|
29
29
|
*/
|
|
@@ -122,8 +122,8 @@ declare namespace sap {
|
|
|
122
122
|
}
|
|
123
123
|
|
|
124
124
|
/**
|
|
125
|
-
* @SINCE 1.
|
|
126
|
-
* @EXPERIMENTAL (since 1.
|
|
125
|
+
* @SINCE 1.95.0
|
|
126
|
+
* @EXPERIMENTAL (since 1.95.0)
|
|
127
127
|
*
|
|
128
128
|
* Interface for components that may be slotted inside `ui5-segmented-button` as items
|
|
129
129
|
*/
|
|
@@ -512,7 +512,7 @@ declare namespace sap {
|
|
|
512
512
|
*
|
|
513
513
|
*
|
|
514
514
|
*
|
|
515
|
-
* **
|
|
515
|
+
* **The available values are:**
|
|
516
516
|
*
|
|
517
517
|
*
|
|
518
518
|
* - `Default`
|
|
@@ -527,8 +527,8 @@ declare namespace sap {
|
|
|
527
527
|
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
528
528
|
|
|
529
529
|
/**
|
|
530
|
-
* Defines whether the component is disabled
|
|
531
|
-
*
|
|
530
|
+
* Defines whether the component is disabled. A disabled component can't be pressed or focused, and it is
|
|
531
|
+
* not in the tab chain.
|
|
532
532
|
*/
|
|
533
533
|
disabled?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
534
534
|
|
|
@@ -604,7 +604,7 @@ declare namespace sap {
|
|
|
604
604
|
maxDate?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
605
605
|
|
|
606
606
|
/**
|
|
607
|
-
* Determines the
|
|
607
|
+
* Determines the minimum date available for selection.
|
|
608
608
|
*/
|
|
609
609
|
minDate?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
610
610
|
|
|
@@ -663,6 +663,21 @@ declare namespace sap {
|
|
|
663
663
|
|
|
664
664
|
interface $CardSettings
|
|
665
665
|
extends sap.ui.webc.common.$WebComponentSettings {
|
|
666
|
+
/**
|
|
667
|
+
* Defines the accessible name of the component, which is used as the name of the card region and should
|
|
668
|
+
* be unique per card. **Note:** `accessibleName` should be always set, unless `accessibleNameRef` is set.
|
|
669
|
+
*/
|
|
670
|
+
accessibleName?:
|
|
671
|
+
| string
|
|
672
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
673
|
+
|
|
674
|
+
/**
|
|
675
|
+
* Defines the IDs of the elements that label the component.
|
|
676
|
+
*/
|
|
677
|
+
accessibleNameRef?:
|
|
678
|
+
| string
|
|
679
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
680
|
+
|
|
666
681
|
/**
|
|
667
682
|
* Defines the height of the control
|
|
668
683
|
*/
|
|
@@ -909,7 +924,7 @@ declare namespace sap {
|
|
|
909
924
|
interface $ColorPaletteSettings
|
|
910
925
|
extends sap.ui.webc.common.$WebComponentSettings {
|
|
911
926
|
/**
|
|
912
|
-
* Defines the `sap.ui.webc.main.ColorPaletteItem`
|
|
927
|
+
* Defines the `sap.ui.webc.main.ColorPaletteItem` elements.
|
|
913
928
|
*/
|
|
914
929
|
colors?:
|
|
915
930
|
| sap.ui.webc.main.IColorPaletteItem[]
|
|
@@ -934,6 +949,52 @@ declare namespace sap {
|
|
|
934
949
|
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
935
950
|
}
|
|
936
951
|
|
|
952
|
+
interface $ColorPalettePopoverSettings
|
|
953
|
+
extends sap.ui.webc.common.$WebComponentSettings {
|
|
954
|
+
/**
|
|
955
|
+
* Defines the default color of the component. **Note:** The default color should be a part of the ColorPalette
|
|
956
|
+
* colors
|
|
957
|
+
*/
|
|
958
|
+
defaultColor?:
|
|
959
|
+
| sap.ui.core.CSSColor
|
|
960
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
961
|
+
|
|
962
|
+
/**
|
|
963
|
+
* Defines whether the user can choose the default color from a button.
|
|
964
|
+
*/
|
|
965
|
+
showDefaultColor?:
|
|
966
|
+
| boolean
|
|
967
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
968
|
+
|
|
969
|
+
/**
|
|
970
|
+
* Defines whether the user can choose a custom color from a component. **Note:** In order to use this property
|
|
971
|
+
* you need to import the following module: `"@ui5/webcomponents/dist/features/ColorPaletteMoreColors.js"`
|
|
972
|
+
*/
|
|
973
|
+
showMoreColors?:
|
|
974
|
+
| boolean
|
|
975
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
976
|
+
|
|
977
|
+
/**
|
|
978
|
+
* Defines whether the user can see the last used colors in the bottom of the component
|
|
979
|
+
*/
|
|
980
|
+
showRecentColors?:
|
|
981
|
+
| boolean
|
|
982
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
983
|
+
|
|
984
|
+
/**
|
|
985
|
+
* Defines the content of the component.
|
|
986
|
+
*/
|
|
987
|
+
content?:
|
|
988
|
+
| sap.ui.core.Control[]
|
|
989
|
+
| sap.ui.core.Control
|
|
990
|
+
| sap.ui.base.ManagedObject.AggregationBindingInfo;
|
|
991
|
+
|
|
992
|
+
/**
|
|
993
|
+
* Fired when the user selects a color.
|
|
994
|
+
*/
|
|
995
|
+
itemClick?: (oEvent: sap.ui.base.Event) => void;
|
|
996
|
+
}
|
|
997
|
+
|
|
937
998
|
interface $ColorPickerSettings
|
|
938
999
|
extends sap.ui.webc.common.$WebComponentSettings {
|
|
939
1000
|
/**
|
|
@@ -941,7 +1002,9 @@ declare namespace sap {
|
|
|
941
1002
|
*
|
|
942
1003
|
* **Note**: use HEX, RGB, RGBA, HSV formats or a CSS color name when modifying this property.
|
|
943
1004
|
*/
|
|
944
|
-
color?:
|
|
1005
|
+
color?:
|
|
1006
|
+
| sap.ui.core.CSSColor
|
|
1007
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
945
1008
|
|
|
946
1009
|
/**
|
|
947
1010
|
* Fired when the the selected color is changed
|
|
@@ -968,7 +1031,7 @@ declare namespace sap {
|
|
|
968
1031
|
/**
|
|
969
1032
|
* Defines whether the component is in disabled state.
|
|
970
1033
|
*
|
|
971
|
-
* **Note:** A disabled component is completely
|
|
1034
|
+
* **Note:** A disabled component is completely noninteractive.
|
|
972
1035
|
*/
|
|
973
1036
|
disabled?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
974
1037
|
|
|
@@ -989,7 +1052,7 @@ declare namespace sap {
|
|
|
989
1052
|
placeholder?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
990
1053
|
|
|
991
1054
|
/**
|
|
992
|
-
* Defines whether the component is
|
|
1055
|
+
* Defines whether the component is read-only.
|
|
993
1056
|
*
|
|
994
1057
|
* **Note:** A read-only component is not editable, but still provides visual feedback upon user interaction.
|
|
995
1058
|
*/
|
|
@@ -1164,8 +1227,8 @@ declare namespace sap {
|
|
|
1164
1227
|
*
|
|
1165
1228
|
*
|
|
1166
1229
|
*
|
|
1167
|
-
* Note
|
|
1168
|
-
*
|
|
1230
|
+
* **Note:** For calendars other than Gregorian, the week numbers are not displayed regardless of what is
|
|
1231
|
+
* set.
|
|
1169
1232
|
*/
|
|
1170
1233
|
hideWeekNumbers?:
|
|
1171
1234
|
| boolean
|
|
@@ -1177,7 +1240,7 @@ declare namespace sap {
|
|
|
1177
1240
|
maxDate?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
1178
1241
|
|
|
1179
1242
|
/**
|
|
1180
|
-
* Determines the
|
|
1243
|
+
* Determines the minimum date available for selection.
|
|
1181
1244
|
*/
|
|
1182
1245
|
minDate?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
1183
1246
|
|
|
@@ -1313,8 +1376,8 @@ declare namespace sap {
|
|
|
1313
1376
|
*
|
|
1314
1377
|
*
|
|
1315
1378
|
*
|
|
1316
|
-
* Note
|
|
1317
|
-
*
|
|
1379
|
+
* **Note:** For calendars other than Gregorian, the week numbers are not displayed regardless of what is
|
|
1380
|
+
* set.
|
|
1318
1381
|
*/
|
|
1319
1382
|
hideWeekNumbers?:
|
|
1320
1383
|
| boolean
|
|
@@ -1326,7 +1389,7 @@ declare namespace sap {
|
|
|
1326
1389
|
maxDate?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
1327
1390
|
|
|
1328
1391
|
/**
|
|
1329
|
-
* Determines the
|
|
1392
|
+
* Determines the minimum date available for selection.
|
|
1330
1393
|
*/
|
|
1331
1394
|
minDate?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
1332
1395
|
|
|
@@ -1456,8 +1519,8 @@ declare namespace sap {
|
|
|
1456
1519
|
*
|
|
1457
1520
|
*
|
|
1458
1521
|
*
|
|
1459
|
-
* Note
|
|
1460
|
-
*
|
|
1522
|
+
* **Note:** For calendars other than Gregorian, the week numbers are not displayed regardless of what is
|
|
1523
|
+
* set.
|
|
1461
1524
|
*/
|
|
1462
1525
|
hideWeekNumbers?:
|
|
1463
1526
|
| boolean
|
|
@@ -1469,7 +1532,7 @@ declare namespace sap {
|
|
|
1469
1532
|
maxDate?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
1470
1533
|
|
|
1471
1534
|
/**
|
|
1472
|
-
* Determines the
|
|
1535
|
+
* Determines the minimum date available for selection.
|
|
1473
1536
|
*/
|
|
1474
1537
|
minDate?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
1475
1538
|
|
|
@@ -1696,7 +1759,7 @@ declare namespace sap {
|
|
|
1696
1759
|
/**
|
|
1697
1760
|
* Defines whether the component is in disabled state.
|
|
1698
1761
|
*
|
|
1699
|
-
* **Note:** A
|
|
1762
|
+
* **Note:** A disabled component is completely noninteractive.
|
|
1700
1763
|
*/
|
|
1701
1764
|
disabled?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
1702
1765
|
|
|
@@ -1888,7 +1951,7 @@ declare namespace sap {
|
|
|
1888
1951
|
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
1889
1952
|
|
|
1890
1953
|
/**
|
|
1891
|
-
* Receives id(or many ids) of the elements that label the input
|
|
1954
|
+
* Receives id(or many ids) of the elements that label the input.
|
|
1892
1955
|
*/
|
|
1893
1956
|
accessibleNameRef?:
|
|
1894
1957
|
| string
|
|
@@ -1992,7 +2055,10 @@ declare namespace sap {
|
|
|
1992
2055
|
/**
|
|
1993
2056
|
* Defines the icon to be displayed in the component.
|
|
1994
2057
|
*/
|
|
1995
|
-
icon?:
|
|
2058
|
+
icon?:
|
|
2059
|
+
| sap.ui.webc.main.IIcon[]
|
|
2060
|
+
| sap.ui.webc.main.IIcon
|
|
2061
|
+
| sap.ui.base.ManagedObject.AggregationBindingInfo;
|
|
1996
2062
|
|
|
1997
2063
|
suggestionItems?:
|
|
1998
2064
|
| sap.ui.webc.main.IInputSuggestionItem[]
|
|
@@ -2020,11 +2086,6 @@ declare namespace sap {
|
|
|
2020
2086
|
* Fired when a suggestion item, that is displayed in the suggestion popup, is selected.
|
|
2021
2087
|
*/
|
|
2022
2088
|
suggestionItemSelect?: (oEvent: sap.ui.base.Event) => void;
|
|
2023
|
-
|
|
2024
|
-
/**
|
|
2025
|
-
* Fired when the user scrolls the suggestion popover.
|
|
2026
|
-
*/
|
|
2027
|
-
suggestionScroll?: (oEvent: sap.ui.base.Event) => void;
|
|
2028
2089
|
}
|
|
2029
2090
|
|
|
2030
2091
|
interface $LabelSettings
|
|
@@ -2044,7 +2105,7 @@ declare namespace sap {
|
|
|
2044
2105
|
required?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
2045
2106
|
|
|
2046
2107
|
/**
|
|
2047
|
-
* Defines whether
|
|
2108
|
+
* Defines whether colon is added to the component text.
|
|
2048
2109
|
*
|
|
2049
2110
|
* **Note:** Usually used in forms.
|
|
2050
2111
|
*/
|
|
@@ -2094,7 +2155,7 @@ declare namespace sap {
|
|
|
2094
2155
|
/**
|
|
2095
2156
|
* Defines whether the component is disabled.
|
|
2096
2157
|
*
|
|
2097
|
-
* **Note:** When disabled, the
|
|
2158
|
+
* **Note:** When disabled, the click event cannot be triggered by the user.
|
|
2098
2159
|
*/
|
|
2099
2160
|
disabled?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
2100
2161
|
|
|
@@ -2145,14 +2206,14 @@ declare namespace sap {
|
|
|
2145
2206
|
interface $ListSettings
|
|
2146
2207
|
extends sap.ui.webc.common.$WebComponentSettings {
|
|
2147
2208
|
/**
|
|
2148
|
-
*
|
|
2209
|
+
* Defines the accessible name of the component.
|
|
2149
2210
|
*/
|
|
2150
2211
|
accessibleName?:
|
|
2151
2212
|
| string
|
|
2152
2213
|
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
2153
2214
|
|
|
2154
2215
|
/**
|
|
2155
|
-
*
|
|
2216
|
+
* Defines the IDs of the elements that label the input.
|
|
2156
2217
|
*/
|
|
2157
2218
|
accessibleNameRef?:
|
|
2158
2219
|
| string
|
|
@@ -2160,9 +2221,6 @@ declare namespace sap {
|
|
|
2160
2221
|
|
|
2161
2222
|
/**
|
|
2162
2223
|
* Defines the accessible role of the component.
|
|
2163
|
-
*
|
|
2164
|
-
* **Note:** If you use notification list items, it's recommended to set `accessible-role="list"` for better
|
|
2165
|
-
* accessibility.
|
|
2166
2224
|
*/
|
|
2167
2225
|
accessibleRole?:
|
|
2168
2226
|
| string
|
|
@@ -2198,7 +2256,7 @@ declare namespace sap {
|
|
|
2198
2256
|
*
|
|
2199
2257
|
*
|
|
2200
2258
|
*
|
|
2201
|
-
* **
|
|
2259
|
+
* **Restrictions:** `growing="Scroll"` is not supported for Internet Explorer, on IE the component will
|
|
2202
2260
|
* fallback to `growing="Button"`.
|
|
2203
2261
|
*/
|
|
2204
2262
|
growing?:
|
|
@@ -2220,7 +2278,7 @@ declare namespace sap {
|
|
|
2220
2278
|
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
2221
2279
|
|
|
2222
2280
|
/**
|
|
2223
|
-
* Determines whether the
|
|
2281
|
+
* Determines whether the component is indented.
|
|
2224
2282
|
*/
|
|
2225
2283
|
indent?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
2226
2284
|
|
|
@@ -2340,7 +2398,7 @@ declare namespace sap {
|
|
|
2340
2398
|
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
2341
2399
|
|
|
2342
2400
|
/**
|
|
2343
|
-
* Defines whether the MessageStrip renders close
|
|
2401
|
+
* Defines whether the MessageStrip renders close button.
|
|
2344
2402
|
*/
|
|
2345
2403
|
hideCloseButton?:
|
|
2346
2404
|
| boolean
|
|
@@ -2517,7 +2575,7 @@ declare namespace sap {
|
|
|
2517
2575
|
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
2518
2576
|
|
|
2519
2577
|
/**
|
|
2520
|
-
* Receives id(or many ids) of the elements that label the input
|
|
2578
|
+
* Receives id(or many ids) of the elements that label the input.
|
|
2521
2579
|
*/
|
|
2522
2580
|
accessibleNameRef?:
|
|
2523
2581
|
| string
|
|
@@ -2573,8 +2631,8 @@ declare namespace sap {
|
|
|
2573
2631
|
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
2574
2632
|
|
|
2575
2633
|
/**
|
|
2576
|
-
* Determines whether a value help icon will be
|
|
2577
|
-
* `value-help-trigger` event.
|
|
2634
|
+
* Determines whether a value help icon will be visualized in the end of the input. Pressing the icon will
|
|
2635
|
+
* fire `value-help-trigger` event.
|
|
2578
2636
|
*/
|
|
2579
2637
|
showValueHelpIcon?:
|
|
2580
2638
|
| boolean
|
|
@@ -2629,7 +2687,10 @@ declare namespace sap {
|
|
|
2629
2687
|
/**
|
|
2630
2688
|
* Defines the icon to be displayed in the component.
|
|
2631
2689
|
*/
|
|
2632
|
-
icon?:
|
|
2690
|
+
icon?:
|
|
2691
|
+
| sap.ui.webc.main.IIcon[]
|
|
2692
|
+
| sap.ui.webc.main.IIcon
|
|
2693
|
+
| sap.ui.base.ManagedObject.AggregationBindingInfo;
|
|
2633
2694
|
|
|
2634
2695
|
suggestionItems?:
|
|
2635
2696
|
| sap.ui.webc.main.IInputSuggestionItem[]
|
|
@@ -2666,11 +2727,6 @@ declare namespace sap {
|
|
|
2666
2727
|
*/
|
|
2667
2728
|
suggestionItemSelect?: (oEvent: sap.ui.base.Event) => void;
|
|
2668
2729
|
|
|
2669
|
-
/**
|
|
2670
|
-
* Fired when the user scrolls the suggestion popover.
|
|
2671
|
-
*/
|
|
2672
|
-
suggestionScroll?: (oEvent: sap.ui.base.Event) => void;
|
|
2673
|
-
|
|
2674
2730
|
/**
|
|
2675
2731
|
* Fired when a token is about to be deleted.
|
|
2676
2732
|
*/
|
|
@@ -2965,6 +3021,15 @@ declare namespace sap {
|
|
|
2965
3021
|
*/
|
|
2966
3022
|
disabled?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
2967
3023
|
|
|
3024
|
+
/**
|
|
3025
|
+
* Specifies the text value to be displayed in the bar.
|
|
3026
|
+
*
|
|
3027
|
+
* **Note:**
|
|
3028
|
+
* - If there is no value provided or the value is empty, the default percentage value is shown.
|
|
3029
|
+
* - If `hideValue` property is `true` both the `displayValue` and `value` property values are not shown.
|
|
3030
|
+
*/
|
|
3031
|
+
displayValue?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
3032
|
+
|
|
2968
3033
|
/**
|
|
2969
3034
|
* Defines whether the component value is shown.
|
|
2970
3035
|
*/
|
|
@@ -3094,17 +3159,17 @@ declare namespace sap {
|
|
|
3094
3159
|
labelInterval?: int | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
3095
3160
|
|
|
3096
3161
|
/**
|
|
3097
|
-
* Defines the maximum value of the slider
|
|
3162
|
+
* Defines the maximum value of the slider.
|
|
3098
3163
|
*/
|
|
3099
3164
|
max?: float | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
3100
3165
|
|
|
3101
3166
|
/**
|
|
3102
|
-
* Defines the minimum value of the slider
|
|
3167
|
+
* Defines the minimum value of the slider.
|
|
3103
3168
|
*/
|
|
3104
3169
|
min?: float | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
3105
3170
|
|
|
3106
3171
|
/**
|
|
3107
|
-
* Enables
|
|
3172
|
+
* Enables tickmarks visualization for each step.
|
|
3108
3173
|
*
|
|
3109
3174
|
* **Note:** The step must be a positive number.
|
|
3110
3175
|
*/
|
|
@@ -3168,7 +3233,7 @@ declare namespace sap {
|
|
|
3168
3233
|
disabled?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
3169
3234
|
|
|
3170
3235
|
/**
|
|
3171
|
-
* The number of displayed rating symbols
|
|
3236
|
+
* The number of displayed rating symbols.
|
|
3172
3237
|
*/
|
|
3173
3238
|
max?: int | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
3174
3239
|
|
|
@@ -3180,7 +3245,7 @@ declare namespace sap {
|
|
|
3180
3245
|
readonly?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
3181
3246
|
|
|
3182
3247
|
/**
|
|
3183
|
-
* The indicated value of the rating
|
|
3248
|
+
* The indicated value of the rating.
|
|
3184
3249
|
*
|
|
3185
3250
|
* **Note:** If you set a number which is not round, it would be shown as follows:
|
|
3186
3251
|
* - 1.0 - 1.2 -> 1
|
|
@@ -3371,8 +3436,8 @@ declare namespace sap {
|
|
|
3371
3436
|
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
3372
3437
|
|
|
3373
3438
|
/**
|
|
3374
|
-
* Defines whether the component is disabled
|
|
3375
|
-
*
|
|
3439
|
+
* Defines whether the component is disabled. A disabled component can't be pressed or focused, and it is
|
|
3440
|
+
* not in the tab chain.
|
|
3376
3441
|
*/
|
|
3377
3442
|
disabled?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
3378
3443
|
|
|
@@ -3519,17 +3584,17 @@ declare namespace sap {
|
|
|
3519
3584
|
labelInterval?: int | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
3520
3585
|
|
|
3521
3586
|
/**
|
|
3522
|
-
* Defines the maximum value of the slider
|
|
3587
|
+
* Defines the maximum value of the slider.
|
|
3523
3588
|
*/
|
|
3524
3589
|
max?: float | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
3525
3590
|
|
|
3526
3591
|
/**
|
|
3527
|
-
* Defines the minimum value of the slider
|
|
3592
|
+
* Defines the minimum value of the slider.
|
|
3528
3593
|
*/
|
|
3529
3594
|
min?: float | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
3530
3595
|
|
|
3531
3596
|
/**
|
|
3532
|
-
* Enables
|
|
3597
|
+
* Enables tickmarks visualization for each step.
|
|
3533
3598
|
*
|
|
3534
3599
|
* **Note:** The step must be a positive number.
|
|
3535
3600
|
*/
|
|
@@ -3774,7 +3839,7 @@ declare namespace sap {
|
|
|
3774
3839
|
/**
|
|
3775
3840
|
* Defines the state of the `additionalText`.
|
|
3776
3841
|
*
|
|
3777
|
-
* Available options are: `"None"` (by default), `"Success"`, `"Warning"` and `"Erorr"`.
|
|
3842
|
+
* Available options are: `"None"` (by default), `"Success"`, `"Information"`, `"Warning"` and `"Erorr"`.
|
|
3778
3843
|
*/
|
|
3779
3844
|
additionalTextState?:
|
|
3780
3845
|
| sap.ui.core.ValueState
|
|
@@ -3853,7 +3918,8 @@ declare namespace sap {
|
|
|
3853
3918
|
/**
|
|
3854
3919
|
* Defines the text, displayed when the component is not checked.
|
|
3855
3920
|
*
|
|
3856
|
-
* **Note:** We recommend using short texts, up to 3 letters (larger texts would be cut off).
|
|
3921
|
+
* **Note:** We recommend using short texts, up to 3 letters (larger texts would be cut off). **Note:**
|
|
3922
|
+
* This property will have no effect if the theme is set to `sap_horizon`.
|
|
3857
3923
|
*/
|
|
3858
3924
|
textOff?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
3859
3925
|
|
|
@@ -3862,7 +3928,8 @@ declare namespace sap {
|
|
|
3862
3928
|
*
|
|
3863
3929
|
*
|
|
3864
3930
|
*
|
|
3865
|
-
* **Note:** We recommend using short texts, up to 3 letters (larger texts would be cut off).
|
|
3931
|
+
* **Note:** We recommend using short texts, up to 3 letters (larger texts would be cut off). **Note:**
|
|
3932
|
+
* This property will have no effect if the theme is set to `sap_horizon`.
|
|
3866
3933
|
*/
|
|
3867
3934
|
textOn?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
3868
3935
|
|
|
@@ -4037,7 +4104,7 @@ declare namespace sap {
|
|
|
4037
4104
|
*
|
|
4038
4105
|
*
|
|
4039
4106
|
*
|
|
4040
|
-
* **
|
|
4107
|
+
* **Restrictions:** `growing="Scroll"` is not supported for Internet Explorer, and the component will fallback
|
|
4041
4108
|
* to `growing="Button"`.
|
|
4042
4109
|
*/
|
|
4043
4110
|
growing?:
|
|
@@ -4101,7 +4168,7 @@ declare namespace sap {
|
|
|
4101
4168
|
* Determines whether the column headers remain fixed at the top of the page during vertical scrolling as
|
|
4102
4169
|
* long as the Web Component is in the viewport.
|
|
4103
4170
|
*
|
|
4104
|
-
* **
|
|
4171
|
+
* **Restrictions:**
|
|
4105
4172
|
* - Browsers that do not support this feature:
|
|
4106
4173
|
* Internet Explorer
|
|
4107
4174
|
* - Microsoft Edge lower than version 41 (EdgeHTML 16)
|
|
@@ -4273,7 +4340,7 @@ declare namespace sap {
|
|
|
4273
4340
|
/**
|
|
4274
4341
|
* Indicates whether the user can interact with the component or not.
|
|
4275
4342
|
*
|
|
4276
|
-
* **Note:**
|
|
4343
|
+
* **Note:** A disabled component is completely noninteractive.
|
|
4277
4344
|
*/
|
|
4278
4345
|
disabled?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
4279
4346
|
|
|
@@ -4285,7 +4352,7 @@ declare namespace sap {
|
|
|
4285
4352
|
growing?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
4286
4353
|
|
|
4287
4354
|
/**
|
|
4288
|
-
* Defines the maximum number of lines that the
|
|
4355
|
+
* Defines the maximum number of lines that the component can grow.
|
|
4289
4356
|
*/
|
|
4290
4357
|
growingMaxLines?: int | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
4291
4358
|
|
|
@@ -4351,7 +4418,7 @@ declare namespace sap {
|
|
|
4351
4418
|
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
4352
4419
|
|
|
4353
4420
|
/**
|
|
4354
|
-
* Defines the value of the
|
|
4421
|
+
* Defines the value of the component.
|
|
4355
4422
|
*/
|
|
4356
4423
|
value?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
4357
4424
|
|
|
@@ -4577,7 +4644,7 @@ declare namespace sap {
|
|
|
4577
4644
|
*
|
|
4578
4645
|
*
|
|
4579
4646
|
*
|
|
4580
|
-
* **
|
|
4647
|
+
* **The available values are:**
|
|
4581
4648
|
*
|
|
4582
4649
|
*
|
|
4583
4650
|
* - `Default`
|
|
@@ -4592,8 +4659,8 @@ declare namespace sap {
|
|
|
4592
4659
|
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
4593
4660
|
|
|
4594
4661
|
/**
|
|
4595
|
-
* Defines whether the component is disabled
|
|
4596
|
-
*
|
|
4662
|
+
* Defines whether the component is disabled. A disabled component can't be pressed or focused, and it is
|
|
4663
|
+
* not in the tab chain.
|
|
4597
4664
|
*/
|
|
4598
4665
|
disabled?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
4599
4666
|
|
|
@@ -4661,7 +4728,7 @@ declare namespace sap {
|
|
|
4661
4728
|
|
|
4662
4729
|
/**
|
|
4663
4730
|
* Defines the close icon for the token. If nothing is provided to this slot, the default close icon will
|
|
4664
|
-
* be used. Accepts `sap.ui.webc.main.Icon
|
|
4731
|
+
* be used. Accepts `sap.ui.webc.main.Icon`.
|
|
4665
4732
|
*/
|
|
4666
4733
|
closeIcon?: sap.ui.webc.main.IIcon;
|
|
4667
4734
|
|
|
@@ -4756,6 +4823,16 @@ declare namespace sap {
|
|
|
4756
4823
|
*/
|
|
4757
4824
|
itemDelete?: (oEvent: sap.ui.base.Event) => void;
|
|
4758
4825
|
|
|
4826
|
+
/**
|
|
4827
|
+
* Fired when the mouse cursor leaves the tree item borders.
|
|
4828
|
+
*/
|
|
4829
|
+
itemMouseout?: (oEvent: sap.ui.base.Event) => void;
|
|
4830
|
+
|
|
4831
|
+
/**
|
|
4832
|
+
* Fired when the mouse cursor enters the tree item borders.
|
|
4833
|
+
*/
|
|
4834
|
+
itemMouseover?: (oEvent: sap.ui.base.Event) => void;
|
|
4835
|
+
|
|
4759
4836
|
/**
|
|
4760
4837
|
* Fired when a tree item is expanded or collapsed. Note: You can call `preventDefault()` on the
|
|
4761
4838
|
* event object to suppress the event, if needed. This may be handy for example if you want to dynamically
|
|
@@ -4846,8 +4923,8 @@ declare namespace sap {
|
|
|
4846
4923
|
*
|
|
4847
4924
|
*
|
|
4848
4925
|
* - [SPACE, ENTER, RETURN] - Fires the `click` event if the `interactive` property is set to true.
|
|
4849
|
-
* - [SHIFT] - If [SPACE]
|
|
4850
|
-
*
|
|
4926
|
+
* - [SHIFT] - If [SPACE] is pressed, pressing [SHIFT] releases the component without triggering the click
|
|
4927
|
+
* event.
|
|
4851
4928
|
*/
|
|
4852
4929
|
class Avatar
|
|
4853
4930
|
extends sap.ui.webc.common.WebComponent
|
|
@@ -5690,8 +5767,8 @@ declare namespace sap {
|
|
|
5690
5767
|
): this;
|
|
5691
5768
|
}
|
|
5692
5769
|
/**
|
|
5693
|
-
* @SINCE 1.
|
|
5694
|
-
* @EXPERIMENTAL (since 1.
|
|
5770
|
+
* @SINCE 1.95.0
|
|
5771
|
+
* @EXPERIMENTAL (since 1.95.0)
|
|
5695
5772
|
*
|
|
5696
5773
|
* Overview: Enables users to navigate between items by providing a list of links to previous steps in the
|
|
5697
5774
|
* user's navigation path. It helps the user to be aware of their location within the application and allows
|
|
@@ -5983,8 +6060,8 @@ declare namespace sap {
|
|
|
5983
6060
|
): this;
|
|
5984
6061
|
}
|
|
5985
6062
|
/**
|
|
5986
|
-
* @SINCE 1.
|
|
5987
|
-
* @EXPERIMENTAL (since 1.
|
|
6063
|
+
* @SINCE 1.95.0
|
|
6064
|
+
* @EXPERIMENTAL (since 1.95.0)
|
|
5988
6065
|
*
|
|
5989
6066
|
* Overview:
|
|
5990
6067
|
*
|
|
@@ -6630,7 +6707,7 @@ declare namespace sap {
|
|
|
6630
6707
|
*
|
|
6631
6708
|
*
|
|
6632
6709
|
*
|
|
6633
|
-
* **
|
|
6710
|
+
* **The available values are:**
|
|
6634
6711
|
*
|
|
6635
6712
|
*
|
|
6636
6713
|
* - `Default`
|
|
@@ -6646,8 +6723,8 @@ declare namespace sap {
|
|
|
6646
6723
|
/**
|
|
6647
6724
|
* Gets current value of property {@link #getDisabled disabled}.
|
|
6648
6725
|
*
|
|
6649
|
-
* Defines whether the component is disabled
|
|
6650
|
-
*
|
|
6726
|
+
* Defines whether the component is disabled. A disabled component can't be pressed or focused, and it is
|
|
6727
|
+
* not in the tab chain.
|
|
6651
6728
|
*
|
|
6652
6729
|
* Default value is `false`.
|
|
6653
6730
|
*/
|
|
@@ -6722,7 +6799,7 @@ declare namespace sap {
|
|
|
6722
6799
|
*
|
|
6723
6800
|
*
|
|
6724
6801
|
*
|
|
6725
|
-
* **
|
|
6802
|
+
* **The available values are:**
|
|
6726
6803
|
*
|
|
6727
6804
|
*
|
|
6728
6805
|
* - `Default`
|
|
@@ -6745,8 +6822,8 @@ declare namespace sap {
|
|
|
6745
6822
|
/**
|
|
6746
6823
|
* Sets a new value for property {@link #getDisabled disabled}.
|
|
6747
6824
|
*
|
|
6748
|
-
* Defines whether the component is disabled
|
|
6749
|
-
*
|
|
6825
|
+
* Defines whether the component is disabled. A disabled component can't be pressed or focused, and it is
|
|
6826
|
+
* not in the tab chain.
|
|
6750
6827
|
*
|
|
6751
6828
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
6752
6829
|
*
|
|
@@ -6904,8 +6981,8 @@ declare namespace sap {
|
|
|
6904
6981
|
*
|
|
6905
6982
|
*
|
|
6906
6983
|
*
|
|
6907
|
-
* - [PAGEUP] - Navigate to the previous
|
|
6908
|
-
* - [PAGEDOWN] - Navigate to the next
|
|
6984
|
+
* - [PAGEUP] - Navigate to the previous year
|
|
6985
|
+
* - [PAGEDOWN] - Navigate to the next year
|
|
6909
6986
|
* - [HOME] - Navigate to the first month of the current row
|
|
6910
6987
|
* - [END] - Navigate to the last month of the current row
|
|
6911
6988
|
* - [CTRL] + [HOME] - Navigate to the first month of the current year
|
|
@@ -7126,7 +7203,7 @@ declare namespace sap {
|
|
|
7126
7203
|
/**
|
|
7127
7204
|
* Gets current value of property {@link #getMinDate minDate}.
|
|
7128
7205
|
*
|
|
7129
|
-
* Determines the
|
|
7206
|
+
* Determines the minimum date available for selection.
|
|
7130
7207
|
*
|
|
7131
7208
|
* Default value is `empty string`.
|
|
7132
7209
|
*/
|
|
@@ -7252,7 +7329,7 @@ declare namespace sap {
|
|
|
7252
7329
|
/**
|
|
7253
7330
|
* Sets a new value for property {@link #getMinDate minDate}.
|
|
7254
7331
|
*
|
|
7255
|
-
* Determines the
|
|
7332
|
+
* Determines the minimum date available for selection.
|
|
7256
7333
|
*
|
|
7257
7334
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
7258
7335
|
*
|
|
@@ -7506,6 +7583,23 @@ declare namespace sap {
|
|
|
7506
7583
|
* Destroys all the header in the aggregation {@link #getHeader header}.
|
|
7507
7584
|
*/
|
|
7508
7585
|
destroyHeader(): this;
|
|
7586
|
+
/**
|
|
7587
|
+
* Gets current value of property {@link #getAccessibleName accessibleName}.
|
|
7588
|
+
*
|
|
7589
|
+
* Defines the accessible name of the component, which is used as the name of the card region and should
|
|
7590
|
+
* be unique per card. **Note:** `accessibleName` should be always set, unless `accessibleNameRef` is set.
|
|
7591
|
+
*
|
|
7592
|
+
* Default value is `empty string`.
|
|
7593
|
+
*/
|
|
7594
|
+
getAccessibleName(): string;
|
|
7595
|
+
/**
|
|
7596
|
+
* Gets current value of property {@link #getAccessibleNameRef accessibleNameRef}.
|
|
7597
|
+
*
|
|
7598
|
+
* Defines the IDs of the elements that label the component.
|
|
7599
|
+
*
|
|
7600
|
+
* Default value is `empty string`.
|
|
7601
|
+
*/
|
|
7602
|
+
getAccessibleNameRef(): string;
|
|
7509
7603
|
/**
|
|
7510
7604
|
* Gets content of aggregation {@link #getContent content}.
|
|
7511
7605
|
*
|
|
@@ -7612,6 +7706,37 @@ declare namespace sap {
|
|
|
7612
7706
|
*/
|
|
7613
7707
|
vHeader: int | string | sap.ui.core.Control
|
|
7614
7708
|
): sap.ui.core.Control;
|
|
7709
|
+
/**
|
|
7710
|
+
* Sets a new value for property {@link #getAccessibleName accessibleName}.
|
|
7711
|
+
*
|
|
7712
|
+
* Defines the accessible name of the component, which is used as the name of the card region and should
|
|
7713
|
+
* be unique per card. **Note:** `accessibleName` should be always set, unless `accessibleNameRef` is set.
|
|
7714
|
+
*
|
|
7715
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
7716
|
+
*
|
|
7717
|
+
* Default value is `empty string`.
|
|
7718
|
+
*/
|
|
7719
|
+
setAccessibleName(
|
|
7720
|
+
/**
|
|
7721
|
+
* New value for property `accessibleName`
|
|
7722
|
+
*/
|
|
7723
|
+
sAccessibleName?: string
|
|
7724
|
+
): this;
|
|
7725
|
+
/**
|
|
7726
|
+
* Sets a new value for property {@link #getAccessibleNameRef accessibleNameRef}.
|
|
7727
|
+
*
|
|
7728
|
+
* Defines the IDs of the elements that label the component.
|
|
7729
|
+
*
|
|
7730
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
7731
|
+
*
|
|
7732
|
+
* Default value is `empty string`.
|
|
7733
|
+
*/
|
|
7734
|
+
setAccessibleNameRef(
|
|
7735
|
+
/**
|
|
7736
|
+
* New value for property `accessibleNameRef`
|
|
7737
|
+
*/
|
|
7738
|
+
sAccessibleNameRef?: string
|
|
7739
|
+
): this;
|
|
7615
7740
|
/**
|
|
7616
7741
|
* Sets a new value for property {@link #getHeight height}.
|
|
7617
7742
|
*
|
|
@@ -7640,8 +7765,8 @@ declare namespace sap {
|
|
|
7640
7765
|
): this;
|
|
7641
7766
|
}
|
|
7642
7767
|
/**
|
|
7643
|
-
* @SINCE 1.
|
|
7644
|
-
* @EXPERIMENTAL (since 1.
|
|
7768
|
+
* @SINCE 1.95.0
|
|
7769
|
+
* @EXPERIMENTAL (since 1.95.0)
|
|
7645
7770
|
*
|
|
7646
7771
|
* Overview:
|
|
7647
7772
|
*
|
|
@@ -8834,13 +8959,14 @@ declare namespace sap {
|
|
|
8834
8959
|
* @SINCE 1.92.0
|
|
8835
8960
|
* @EXPERIMENTAL (since 1.92.0)
|
|
8836
8961
|
*
|
|
8837
|
-
* Overview: The ColorPalette provides the users with a range of predefined colors. The
|
|
8838
|
-
* and do not change with the theme.
|
|
8962
|
+
* Overview: The `sap.ui.webc.main.ColorPalette` provides the users with a range of predefined colors. The
|
|
8963
|
+
* colors are fixed and do not change with the theme.
|
|
8839
8964
|
*
|
|
8840
8965
|
* Usage:
|
|
8841
8966
|
*
|
|
8842
|
-
* The
|
|
8843
|
-
* colors, use the `sap.ui.webc.main.ColorPaletteItem` component inside the default slot
|
|
8967
|
+
* The `sap.ui.webc.main.ColorPalette` is meant for users that need to select a color from a predefined
|
|
8968
|
+
* set. To define the colors, use the `sap.ui.webc.main.ColorPaletteItem` component inside the default slot
|
|
8969
|
+
* of the `sap.ui.webc.main.ColorPalette`.
|
|
8844
8970
|
*/
|
|
8845
8971
|
class ColorPalette extends sap.ui.webc.common.WebComponent {
|
|
8846
8972
|
/**
|
|
@@ -8985,7 +9111,7 @@ declare namespace sap {
|
|
|
8985
9111
|
/**
|
|
8986
9112
|
* Gets content of aggregation {@link #getColors colors}.
|
|
8987
9113
|
*
|
|
8988
|
-
* Defines the `sap.ui.webc.main.ColorPaletteItem`
|
|
9114
|
+
* Defines the `sap.ui.webc.main.ColorPaletteItem` elements.
|
|
8989
9115
|
*/
|
|
8990
9116
|
getColors(): sap.ui.webc.main.IColorPaletteItem[];
|
|
8991
9117
|
/**
|
|
@@ -9122,23 +9248,26 @@ declare namespace sap {
|
|
|
9122
9248
|
): this;
|
|
9123
9249
|
}
|
|
9124
9250
|
/**
|
|
9125
|
-
* @SINCE 1.
|
|
9126
|
-
* @EXPERIMENTAL (since 1.
|
|
9251
|
+
* @SINCE 1.97.0
|
|
9252
|
+
* @EXPERIMENTAL (since 1.97.0)
|
|
9127
9253
|
*
|
|
9128
|
-
* Overview:
|
|
9129
|
-
* colors.
|
|
9254
|
+
* Overview: Represents a predefined range of colors for easier selection.
|
|
9130
9255
|
*
|
|
9131
|
-
*
|
|
9256
|
+
* Overview The ColorPalettePopover provides the users with a slot to predefine colors.
|
|
9132
9257
|
*
|
|
9133
|
-
*
|
|
9134
|
-
*
|
|
9258
|
+
* You can customize them with the use of the colors property. You can specify a defaultColor and display
|
|
9259
|
+
* a "Default color" button for the user to choose directly. You can display a "More colors..." button that
|
|
9260
|
+
* opens an additional color picker for the user to choose specific colors that are not present in the predefined
|
|
9261
|
+
* range.
|
|
9135
9262
|
*
|
|
9136
|
-
*
|
|
9137
|
-
*
|
|
9263
|
+
* Usage:
|
|
9264
|
+
*
|
|
9265
|
+
* The palette is intended for users, who don't want to check and remember the different values of the colors
|
|
9266
|
+
* and spend large amount of time to configure the right color through the color picker.
|
|
9138
9267
|
*/
|
|
9139
|
-
class
|
|
9268
|
+
class ColorPalettePopover extends sap.ui.webc.common.WebComponent {
|
|
9140
9269
|
/**
|
|
9141
|
-
* Constructor for a new `
|
|
9270
|
+
* Constructor for a new `ColorPalettePopover`.
|
|
9142
9271
|
*
|
|
9143
9272
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
9144
9273
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
@@ -9148,10 +9277,10 @@ declare namespace sap {
|
|
|
9148
9277
|
/**
|
|
9149
9278
|
* Initial settings for the new control
|
|
9150
9279
|
*/
|
|
9151
|
-
mSettings?: sap.ui.webc.main.$
|
|
9280
|
+
mSettings?: sap.ui.webc.main.$ColorPalettePopoverSettings
|
|
9152
9281
|
);
|
|
9153
9282
|
/**
|
|
9154
|
-
* Constructor for a new `
|
|
9283
|
+
* Constructor for a new `ColorPalettePopover`.
|
|
9155
9284
|
*
|
|
9156
9285
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
9157
9286
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
@@ -9165,12 +9294,12 @@ declare namespace sap {
|
|
|
9165
9294
|
/**
|
|
9166
9295
|
* Initial settings for the new control
|
|
9167
9296
|
*/
|
|
9168
|
-
mSettings?: sap.ui.webc.main.$
|
|
9297
|
+
mSettings?: sap.ui.webc.main.$ColorPalettePopoverSettings
|
|
9169
9298
|
);
|
|
9170
9299
|
|
|
9171
9300
|
/**
|
|
9172
|
-
* Creates a new subclass of class sap.ui.webc.main.
|
|
9173
|
-
* the information contained in `oClassInfo`.
|
|
9301
|
+
* Creates a new subclass of class sap.ui.webc.main.ColorPalettePopover with name `sClassName` and enriches
|
|
9302
|
+
* it with the information contained in `oClassInfo`.
|
|
9174
9303
|
*
|
|
9175
9304
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
|
|
9176
9305
|
*/
|
|
@@ -9182,7 +9311,7 @@ declare namespace sap {
|
|
|
9182
9311
|
/**
|
|
9183
9312
|
* Object literal with information about the class
|
|
9184
9313
|
*/
|
|
9185
|
-
oClassInfo?: sap.ClassInfo<T, sap.ui.webc.main.
|
|
9314
|
+
oClassInfo?: sap.ClassInfo<T, sap.ui.webc.main.ColorPalettePopover>,
|
|
9186
9315
|
/**
|
|
9187
9316
|
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
9188
9317
|
* used by this class
|
|
@@ -9190,18 +9319,27 @@ declare namespace sap {
|
|
|
9190
9319
|
FNMetaImpl?: Function
|
|
9191
9320
|
): Function;
|
|
9192
9321
|
/**
|
|
9193
|
-
* Returns a metadata object for class sap.ui.webc.main.
|
|
9322
|
+
* Returns a metadata object for class sap.ui.webc.main.ColorPalettePopover.
|
|
9194
9323
|
*/
|
|
9195
9324
|
static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
|
|
9196
9325
|
/**
|
|
9197
|
-
*
|
|
9326
|
+
* Adds some content to the aggregation {@link #getContent content}.
|
|
9327
|
+
*/
|
|
9328
|
+
addContent(
|
|
9329
|
+
/**
|
|
9330
|
+
* The content to add; if empty, nothing is inserted
|
|
9331
|
+
*/
|
|
9332
|
+
oContent: sap.ui.core.Control
|
|
9333
|
+
): this;
|
|
9334
|
+
/**
|
|
9335
|
+
* Attaches event handler `fnFunction` to the {@link #event:itemClick itemClick} event of this `sap.ui.webc.main.ColorPalettePopover`.
|
|
9198
9336
|
*
|
|
9199
9337
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
9200
|
-
* otherwise it will be bound to this `sap.ui.webc.main.
|
|
9338
|
+
* otherwise it will be bound to this `sap.ui.webc.main.ColorPalettePopover` itself.
|
|
9201
9339
|
*
|
|
9202
|
-
* Fired when the
|
|
9340
|
+
* Fired when the user selects a color.
|
|
9203
9341
|
*/
|
|
9204
|
-
|
|
9342
|
+
attachItemClick(
|
|
9205
9343
|
/**
|
|
9206
9344
|
* An application-specific payload object that will be passed to the event handler along with the event
|
|
9207
9345
|
* object when firing the event
|
|
@@ -9212,34 +9350,40 @@ declare namespace sap {
|
|
|
9212
9350
|
*/
|
|
9213
9351
|
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
9214
9352
|
/**
|
|
9215
|
-
* Context object to call the event handler with. Defaults to this `sap.ui.webc.main.
|
|
9353
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.main.ColorPalettePopover`
|
|
9354
|
+
* itself
|
|
9216
9355
|
*/
|
|
9217
9356
|
oListener?: object
|
|
9218
9357
|
): this;
|
|
9219
9358
|
/**
|
|
9220
|
-
* Attaches event handler `fnFunction` to the {@link #event:
|
|
9359
|
+
* Attaches event handler `fnFunction` to the {@link #event:itemClick itemClick} event of this `sap.ui.webc.main.ColorPalettePopover`.
|
|
9221
9360
|
*
|
|
9222
9361
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
9223
|
-
* otherwise it will be bound to this `sap.ui.webc.main.
|
|
9362
|
+
* otherwise it will be bound to this `sap.ui.webc.main.ColorPalettePopover` itself.
|
|
9224
9363
|
*
|
|
9225
|
-
* Fired when the
|
|
9364
|
+
* Fired when the user selects a color.
|
|
9226
9365
|
*/
|
|
9227
|
-
|
|
9366
|
+
attachItemClick(
|
|
9228
9367
|
/**
|
|
9229
9368
|
* The function to be called when the event occurs
|
|
9230
9369
|
*/
|
|
9231
9370
|
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
9232
9371
|
/**
|
|
9233
|
-
* Context object to call the event handler with. Defaults to this `sap.ui.webc.main.
|
|
9372
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.main.ColorPalettePopover`
|
|
9373
|
+
* itself
|
|
9234
9374
|
*/
|
|
9235
9375
|
oListener?: object
|
|
9236
9376
|
): this;
|
|
9237
9377
|
/**
|
|
9238
|
-
*
|
|
9378
|
+
* Destroys all the content in the aggregation {@link #getContent content}.
|
|
9379
|
+
*/
|
|
9380
|
+
destroyContent(): this;
|
|
9381
|
+
/**
|
|
9382
|
+
* Detaches event handler `fnFunction` from the {@link #event:itemClick itemClick} event of this `sap.ui.webc.main.ColorPalettePopover`.
|
|
9239
9383
|
*
|
|
9240
9384
|
* The passed function and listener object must match the ones used for event registration.
|
|
9241
9385
|
*/
|
|
9242
|
-
|
|
9386
|
+
detachItemClick(
|
|
9243
9387
|
/**
|
|
9244
9388
|
* The function to be called, when the event occurs
|
|
9245
9389
|
*/
|
|
@@ -9250,67 +9394,348 @@ declare namespace sap {
|
|
|
9250
9394
|
oListener?: object
|
|
9251
9395
|
): this;
|
|
9252
9396
|
/**
|
|
9253
|
-
* Fires event {@link #event:
|
|
9397
|
+
* Fires event {@link #event:itemClick itemClick} to attached listeners.
|
|
9254
9398
|
*/
|
|
9255
|
-
|
|
9399
|
+
fireItemClick(
|
|
9256
9400
|
/**
|
|
9257
9401
|
* Parameters to pass along with the event
|
|
9258
9402
|
*/
|
|
9259
|
-
mParameters?:
|
|
9403
|
+
mParameters?: {
|
|
9404
|
+
/**
|
|
9405
|
+
* the selected color
|
|
9406
|
+
*/
|
|
9407
|
+
color?: string;
|
|
9408
|
+
}
|
|
9260
9409
|
): this;
|
|
9261
9410
|
/**
|
|
9262
|
-
* Gets
|
|
9411
|
+
* Gets content of aggregation {@link #getContent content}.
|
|
9263
9412
|
*
|
|
9264
|
-
* Defines the
|
|
9413
|
+
* Defines the content of the component.
|
|
9414
|
+
*/
|
|
9415
|
+
getContent(): sap.ui.core.Control[];
|
|
9416
|
+
/**
|
|
9417
|
+
* Gets current value of property {@link #getDefaultColor defaultColor}.
|
|
9265
9418
|
*
|
|
9266
|
-
*
|
|
9419
|
+
* Defines the default color of the component. **Note:** The default color should be a part of the ColorPalette
|
|
9420
|
+
* colors
|
|
9267
9421
|
*/
|
|
9268
|
-
|
|
9422
|
+
getDefaultColor(): sap.ui.core.CSSColor;
|
|
9269
9423
|
/**
|
|
9270
|
-
*
|
|
9424
|
+
* Gets current value of property {@link #getShowDefaultColor showDefaultColor}.
|
|
9271
9425
|
*
|
|
9272
|
-
* Defines the
|
|
9426
|
+
* Defines whether the user can choose the default color from a button.
|
|
9273
9427
|
*
|
|
9274
|
-
*
|
|
9428
|
+
* Default value is `false`.
|
|
9429
|
+
*/
|
|
9430
|
+
getShowDefaultColor(): boolean;
|
|
9431
|
+
/**
|
|
9432
|
+
* Gets current value of property {@link #getShowMoreColors showMoreColors}.
|
|
9275
9433
|
*
|
|
9276
|
-
*
|
|
9434
|
+
* Defines whether the user can choose a custom color from a component. **Note:** In order to use this property
|
|
9435
|
+
* you need to import the following module: `"@ui5/webcomponents/dist/features/ColorPaletteMoreColors.js"`
|
|
9436
|
+
*
|
|
9437
|
+
* Default value is `false`.
|
|
9277
9438
|
*/
|
|
9278
|
-
|
|
9279
|
-
/**
|
|
9280
|
-
* New value for property `color`
|
|
9281
|
-
*/
|
|
9282
|
-
sColor: string
|
|
9283
|
-
): this;
|
|
9284
|
-
}
|
|
9285
|
-
/**
|
|
9286
|
-
* @SINCE 1.92.0
|
|
9287
|
-
* @EXPERIMENTAL (since 1.92.0)
|
|
9288
|
-
*
|
|
9289
|
-
* Overview:
|
|
9290
|
-
*
|
|
9291
|
-
* The `sap.ui.webc.main.ComboBox` component represents a drop-down menu with a list of the available options
|
|
9292
|
-
* and a text input field to narrow down the options.
|
|
9293
|
-
*
|
|
9294
|
-
* It is commonly used to enable users to select one or more options from a predefined list. Structure:
|
|
9295
|
-
* The `sap.ui.webc.main.ComboBox` consists of the following elements:
|
|
9296
|
-
* - Input field - displays the selected option or a custom user entry. Users can type to narrow down
|
|
9297
|
-
* the list or enter their own value. Drop-down arrow - expands\collapses the option list.
|
|
9298
|
-
* - Option list - the list of available options. Keyboard Handling:
|
|
9299
|
-
*
|
|
9300
|
-
* The `sap.ui.webc.main.ComboBox` provides advanced keyboard handling.
|
|
9301
|
-
*
|
|
9302
|
-
* Picker: If the `sap.ui.webc.main.ComboBox` is focused, you can open or close the drop-down by pressing
|
|
9303
|
-
* `F4`, `ALT+UP` or `ALT+DOWN` keys.
|
|
9304
|
-
*/
|
|
9305
|
-
class ComboBox extends sap.ui.webc.common.WebComponent {
|
|
9439
|
+
getShowMoreColors(): boolean;
|
|
9306
9440
|
/**
|
|
9307
|
-
*
|
|
9441
|
+
* Gets current value of property {@link #getShowRecentColors showRecentColors}.
|
|
9308
9442
|
*
|
|
9309
|
-
*
|
|
9310
|
-
*
|
|
9311
|
-
*
|
|
9443
|
+
* Defines whether the user can see the last used colors in the bottom of the component
|
|
9444
|
+
*
|
|
9445
|
+
* Default value is `false`.
|
|
9312
9446
|
*/
|
|
9313
|
-
|
|
9447
|
+
getShowRecentColors(): boolean;
|
|
9448
|
+
/**
|
|
9449
|
+
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getContent content}. and returns
|
|
9450
|
+
* its index if found or -1 otherwise.
|
|
9451
|
+
*/
|
|
9452
|
+
indexOfContent(
|
|
9453
|
+
/**
|
|
9454
|
+
* The content whose index is looked for
|
|
9455
|
+
*/
|
|
9456
|
+
oContent: sap.ui.core.Control
|
|
9457
|
+
): int;
|
|
9458
|
+
/**
|
|
9459
|
+
* Inserts a content into the aggregation {@link #getContent content}.
|
|
9460
|
+
*/
|
|
9461
|
+
insertContent(
|
|
9462
|
+
/**
|
|
9463
|
+
* The content to insert; if empty, nothing is inserted
|
|
9464
|
+
*/
|
|
9465
|
+
oContent: sap.ui.core.Control,
|
|
9466
|
+
/**
|
|
9467
|
+
* The `0`-based index the content should be inserted at; for a negative value of `iIndex`, the content
|
|
9468
|
+
* is inserted at position 0; for a value greater than the current size of the aggregation, the content
|
|
9469
|
+
* is inserted at the last position
|
|
9470
|
+
*/
|
|
9471
|
+
iIndex: int
|
|
9472
|
+
): this;
|
|
9473
|
+
/**
|
|
9474
|
+
* Removes all the controls from the aggregation {@link #getContent content}.
|
|
9475
|
+
*
|
|
9476
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
9477
|
+
*/
|
|
9478
|
+
removeAllContent(): sap.ui.core.Control[];
|
|
9479
|
+
/**
|
|
9480
|
+
* Removes a content from the aggregation {@link #getContent content}.
|
|
9481
|
+
*/
|
|
9482
|
+
removeContent(
|
|
9483
|
+
/**
|
|
9484
|
+
* The content to remove or its index or id
|
|
9485
|
+
*/
|
|
9486
|
+
vContent: int | string | sap.ui.core.Control
|
|
9487
|
+
): sap.ui.core.Control;
|
|
9488
|
+
/**
|
|
9489
|
+
* Sets a new value for property {@link #getDefaultColor defaultColor}.
|
|
9490
|
+
*
|
|
9491
|
+
* Defines the default color of the component. **Note:** The default color should be a part of the ColorPalette
|
|
9492
|
+
* colors
|
|
9493
|
+
*
|
|
9494
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
9495
|
+
*/
|
|
9496
|
+
setDefaultColor(
|
|
9497
|
+
/**
|
|
9498
|
+
* New value for property `defaultColor`
|
|
9499
|
+
*/
|
|
9500
|
+
sDefaultColor: sap.ui.core.CSSColor
|
|
9501
|
+
): this;
|
|
9502
|
+
/**
|
|
9503
|
+
* Sets a new value for property {@link #getShowDefaultColor showDefaultColor}.
|
|
9504
|
+
*
|
|
9505
|
+
* Defines whether the user can choose the default color from a button.
|
|
9506
|
+
*
|
|
9507
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
9508
|
+
*
|
|
9509
|
+
* Default value is `false`.
|
|
9510
|
+
*/
|
|
9511
|
+
setShowDefaultColor(
|
|
9512
|
+
/**
|
|
9513
|
+
* New value for property `showDefaultColor`
|
|
9514
|
+
*/
|
|
9515
|
+
bShowDefaultColor?: boolean
|
|
9516
|
+
): this;
|
|
9517
|
+
/**
|
|
9518
|
+
* Sets a new value for property {@link #getShowMoreColors showMoreColors}.
|
|
9519
|
+
*
|
|
9520
|
+
* Defines whether the user can choose a custom color from a component. **Note:** In order to use this property
|
|
9521
|
+
* you need to import the following module: `"@ui5/webcomponents/dist/features/ColorPaletteMoreColors.js"`
|
|
9522
|
+
*
|
|
9523
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
9524
|
+
*
|
|
9525
|
+
* Default value is `false`.
|
|
9526
|
+
*/
|
|
9527
|
+
setShowMoreColors(
|
|
9528
|
+
/**
|
|
9529
|
+
* New value for property `showMoreColors`
|
|
9530
|
+
*/
|
|
9531
|
+
bShowMoreColors?: boolean
|
|
9532
|
+
): this;
|
|
9533
|
+
/**
|
|
9534
|
+
* Sets a new value for property {@link #getShowRecentColors showRecentColors}.
|
|
9535
|
+
*
|
|
9536
|
+
* Defines whether the user can see the last used colors in the bottom of the component
|
|
9537
|
+
*
|
|
9538
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
9539
|
+
*
|
|
9540
|
+
* Default value is `false`.
|
|
9541
|
+
*/
|
|
9542
|
+
setShowRecentColors(
|
|
9543
|
+
/**
|
|
9544
|
+
* New value for property `showRecentColors`
|
|
9545
|
+
*/
|
|
9546
|
+
bShowRecentColors?: boolean
|
|
9547
|
+
): this;
|
|
9548
|
+
}
|
|
9549
|
+
/**
|
|
9550
|
+
* @SINCE 1.92.0
|
|
9551
|
+
* @EXPERIMENTAL (since 1.92.0)
|
|
9552
|
+
*
|
|
9553
|
+
* Overview: The `sap.ui.webc.main.ColorPicker` allows users to choose any color and provides different
|
|
9554
|
+
* input options for selecting colors.
|
|
9555
|
+
*
|
|
9556
|
+
* Usage:
|
|
9557
|
+
*
|
|
9558
|
+
* When to use:
|
|
9559
|
+
* - users need to select any color freely.
|
|
9560
|
+
*
|
|
9561
|
+
* When not to use::
|
|
9562
|
+
* - Users need to select one color from a predefined set of colors. Use the ColorPalette component instead.
|
|
9563
|
+
*/
|
|
9564
|
+
class ColorPicker extends sap.ui.webc.common.WebComponent {
|
|
9565
|
+
/**
|
|
9566
|
+
* Constructor for a new `ColorPicker`.
|
|
9567
|
+
*
|
|
9568
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
9569
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
9570
|
+
* of the syntax of the settings object.
|
|
9571
|
+
*/
|
|
9572
|
+
constructor(
|
|
9573
|
+
/**
|
|
9574
|
+
* Initial settings for the new control
|
|
9575
|
+
*/
|
|
9576
|
+
mSettings?: sap.ui.webc.main.$ColorPickerSettings
|
|
9577
|
+
);
|
|
9578
|
+
/**
|
|
9579
|
+
* Constructor for a new `ColorPicker`.
|
|
9580
|
+
*
|
|
9581
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
9582
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
9583
|
+
* of the syntax of the settings object.
|
|
9584
|
+
*/
|
|
9585
|
+
constructor(
|
|
9586
|
+
/**
|
|
9587
|
+
* ID for the new control, generated automatically if no ID is given
|
|
9588
|
+
*/
|
|
9589
|
+
sId?: string,
|
|
9590
|
+
/**
|
|
9591
|
+
* Initial settings for the new control
|
|
9592
|
+
*/
|
|
9593
|
+
mSettings?: sap.ui.webc.main.$ColorPickerSettings
|
|
9594
|
+
);
|
|
9595
|
+
|
|
9596
|
+
/**
|
|
9597
|
+
* Creates a new subclass of class sap.ui.webc.main.ColorPicker with name `sClassName` and enriches it with
|
|
9598
|
+
* the information contained in `oClassInfo`.
|
|
9599
|
+
*
|
|
9600
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
|
|
9601
|
+
*/
|
|
9602
|
+
static extend<T extends Record<string, unknown>>(
|
|
9603
|
+
/**
|
|
9604
|
+
* Name of the class being created
|
|
9605
|
+
*/
|
|
9606
|
+
sClassName: string,
|
|
9607
|
+
/**
|
|
9608
|
+
* Object literal with information about the class
|
|
9609
|
+
*/
|
|
9610
|
+
oClassInfo?: sap.ClassInfo<T, sap.ui.webc.main.ColorPicker>,
|
|
9611
|
+
/**
|
|
9612
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
9613
|
+
* used by this class
|
|
9614
|
+
*/
|
|
9615
|
+
FNMetaImpl?: Function
|
|
9616
|
+
): Function;
|
|
9617
|
+
/**
|
|
9618
|
+
* Returns a metadata object for class sap.ui.webc.main.ColorPicker.
|
|
9619
|
+
*/
|
|
9620
|
+
static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
|
|
9621
|
+
/**
|
|
9622
|
+
* Attaches event handler `fnFunction` to the {@link #event:change change} event of this `sap.ui.webc.main.ColorPicker`.
|
|
9623
|
+
*
|
|
9624
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
9625
|
+
* otherwise it will be bound to this `sap.ui.webc.main.ColorPicker` itself.
|
|
9626
|
+
*
|
|
9627
|
+
* Fired when the the selected color is changed
|
|
9628
|
+
*/
|
|
9629
|
+
attachChange(
|
|
9630
|
+
/**
|
|
9631
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
9632
|
+
* object when firing the event
|
|
9633
|
+
*/
|
|
9634
|
+
oData: object,
|
|
9635
|
+
/**
|
|
9636
|
+
* The function to be called when the event occurs
|
|
9637
|
+
*/
|
|
9638
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
9639
|
+
/**
|
|
9640
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.main.ColorPicker` itself
|
|
9641
|
+
*/
|
|
9642
|
+
oListener?: object
|
|
9643
|
+
): this;
|
|
9644
|
+
/**
|
|
9645
|
+
* Attaches event handler `fnFunction` to the {@link #event:change change} event of this `sap.ui.webc.main.ColorPicker`.
|
|
9646
|
+
*
|
|
9647
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
9648
|
+
* otherwise it will be bound to this `sap.ui.webc.main.ColorPicker` itself.
|
|
9649
|
+
*
|
|
9650
|
+
* Fired when the the selected color is changed
|
|
9651
|
+
*/
|
|
9652
|
+
attachChange(
|
|
9653
|
+
/**
|
|
9654
|
+
* The function to be called when the event occurs
|
|
9655
|
+
*/
|
|
9656
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
9657
|
+
/**
|
|
9658
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.main.ColorPicker` itself
|
|
9659
|
+
*/
|
|
9660
|
+
oListener?: object
|
|
9661
|
+
): this;
|
|
9662
|
+
/**
|
|
9663
|
+
* Detaches event handler `fnFunction` from the {@link #event:change change} event of this `sap.ui.webc.main.ColorPicker`.
|
|
9664
|
+
*
|
|
9665
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
9666
|
+
*/
|
|
9667
|
+
detachChange(
|
|
9668
|
+
/**
|
|
9669
|
+
* The function to be called, when the event occurs
|
|
9670
|
+
*/
|
|
9671
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
9672
|
+
/**
|
|
9673
|
+
* Context object on which the given function had to be called
|
|
9674
|
+
*/
|
|
9675
|
+
oListener?: object
|
|
9676
|
+
): this;
|
|
9677
|
+
/**
|
|
9678
|
+
* Fires event {@link #event:change change} to attached listeners.
|
|
9679
|
+
*/
|
|
9680
|
+
fireChange(
|
|
9681
|
+
/**
|
|
9682
|
+
* Parameters to pass along with the event
|
|
9683
|
+
*/
|
|
9684
|
+
mParameters?: object
|
|
9685
|
+
): this;
|
|
9686
|
+
/**
|
|
9687
|
+
* Gets current value of property {@link #getColor color}.
|
|
9688
|
+
*
|
|
9689
|
+
* Defines the currently selected color of the component.
|
|
9690
|
+
*
|
|
9691
|
+
* **Note**: use HEX, RGB, RGBA, HSV formats or a CSS color name when modifying this property.
|
|
9692
|
+
*/
|
|
9693
|
+
getColor(): sap.ui.core.CSSColor;
|
|
9694
|
+
/**
|
|
9695
|
+
* Sets a new value for property {@link #getColor color}.
|
|
9696
|
+
*
|
|
9697
|
+
* Defines the currently selected color of the component.
|
|
9698
|
+
*
|
|
9699
|
+
* **Note**: use HEX, RGB, RGBA, HSV formats or a CSS color name when modifying this property.
|
|
9700
|
+
*
|
|
9701
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
9702
|
+
*/
|
|
9703
|
+
setColor(
|
|
9704
|
+
/**
|
|
9705
|
+
* New value for property `color`
|
|
9706
|
+
*/
|
|
9707
|
+
sColor: sap.ui.core.CSSColor
|
|
9708
|
+
): this;
|
|
9709
|
+
}
|
|
9710
|
+
/**
|
|
9711
|
+
* @SINCE 1.92.0
|
|
9712
|
+
* @EXPERIMENTAL (since 1.92.0)
|
|
9713
|
+
*
|
|
9714
|
+
* Overview:
|
|
9715
|
+
*
|
|
9716
|
+
* The `sap.ui.webc.main.ComboBox` component represents a drop-down menu with a list of the available options
|
|
9717
|
+
* and a text input field to narrow down the options.
|
|
9718
|
+
*
|
|
9719
|
+
* It is commonly used to enable users to select an option from a predefined list. Structure: The `sap.ui.webc.main.ComboBox`
|
|
9720
|
+
* consists of the following elements:
|
|
9721
|
+
* - Input field - displays the selected option or a custom user entry. Users can type to narrow down
|
|
9722
|
+
* the list or enter their own value. Drop-down arrow - expands\collapses the option list.
|
|
9723
|
+
* - Option list - the list of available options. Keyboard Handling:
|
|
9724
|
+
*
|
|
9725
|
+
* The `sap.ui.webc.main.ComboBox` provides advanced keyboard handling.
|
|
9726
|
+
*
|
|
9727
|
+
* Picker: If the `sap.ui.webc.main.ComboBox` is focused, you can open or close the drop-down by pressing
|
|
9728
|
+
* `F4`, `ALT+UP` or `ALT+DOWN` keys.
|
|
9729
|
+
*/
|
|
9730
|
+
class ComboBox extends sap.ui.webc.common.WebComponent {
|
|
9731
|
+
/**
|
|
9732
|
+
* Constructor for a new `ComboBox`.
|
|
9733
|
+
*
|
|
9734
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
9735
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
9736
|
+
* of the syntax of the settings object.
|
|
9737
|
+
*/
|
|
9738
|
+
constructor(
|
|
9314
9739
|
/**
|
|
9315
9740
|
* Initial settings for the new control
|
|
9316
9741
|
*/
|
|
@@ -9602,7 +10027,7 @@ declare namespace sap {
|
|
|
9602
10027
|
*
|
|
9603
10028
|
* Defines whether the component is in disabled state.
|
|
9604
10029
|
*
|
|
9605
|
-
* **Note:** A disabled component is completely
|
|
10030
|
+
* **Note:** A disabled component is completely noninteractive.
|
|
9606
10031
|
*
|
|
9607
10032
|
* Default value is `false`.
|
|
9608
10033
|
*/
|
|
@@ -9647,7 +10072,7 @@ declare namespace sap {
|
|
|
9647
10072
|
/**
|
|
9648
10073
|
* Gets current value of property {@link #getReadonly readonly}.
|
|
9649
10074
|
*
|
|
9650
|
-
* Defines whether the component is
|
|
10075
|
+
* Defines whether the component is read-only.
|
|
9651
10076
|
*
|
|
9652
10077
|
* **Note:** A read-only component is not editable, but still provides visual feedback upon user interaction.
|
|
9653
10078
|
*
|
|
@@ -9776,7 +10201,7 @@ declare namespace sap {
|
|
|
9776
10201
|
*
|
|
9777
10202
|
* Defines whether the component is in disabled state.
|
|
9778
10203
|
*
|
|
9779
|
-
* **Note:** A disabled component is completely
|
|
10204
|
+
* **Note:** A disabled component is completely noninteractive.
|
|
9780
10205
|
*
|
|
9781
10206
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
9782
10207
|
*
|
|
@@ -9846,7 +10271,7 @@ declare namespace sap {
|
|
|
9846
10271
|
/**
|
|
9847
10272
|
* Sets a new value for property {@link #getReadonly readonly}.
|
|
9848
10273
|
*
|
|
9849
|
-
* Defines whether the component is
|
|
10274
|
+
* Defines whether the component is read-only.
|
|
9850
10275
|
*
|
|
9851
10276
|
* **Note:** A read-only component is not editable, but still provides visual feedback upon user interaction.
|
|
9852
10277
|
*
|
|
@@ -9946,8 +10371,8 @@ declare namespace sap {
|
|
|
9946
10371
|
): this;
|
|
9947
10372
|
}
|
|
9948
10373
|
/**
|
|
9949
|
-
* @SINCE 1.
|
|
9950
|
-
* @EXPERIMENTAL (since 1.
|
|
10374
|
+
* @SINCE 1.95.0
|
|
10375
|
+
* @EXPERIMENTAL (since 1.95.0)
|
|
9951
10376
|
*
|
|
9952
10377
|
* The `ui5-combobox-group-item` is type of suggestion item, that can be used to split the `sap.ui.webc.main.ComboBox`
|
|
9953
10378
|
* suggestions into groups.
|
|
@@ -10438,7 +10863,7 @@ declare namespace sap {
|
|
|
10438
10863
|
* - Using the calendar that opens in a popup
|
|
10439
10864
|
* - Typing it in directly in the input field
|
|
10440
10865
|
*
|
|
10441
|
-
* When the user makes an entry and
|
|
10866
|
+
* When the user makes an entry and presses the enter key, the calendar shows the corresponding date. When
|
|
10442
10867
|
* the user directly triggers the calendar display, the actual date is displayed.
|
|
10443
10868
|
*
|
|
10444
10869
|
* Formatting:
|
|
@@ -10480,11 +10905,13 @@ declare namespace sap {
|
|
|
10480
10905
|
*
|
|
10481
10906
|
*
|
|
10482
10907
|
* Or, you can use the global configuration and set the `calendarType` key:
|
|
10483
|
-
*
|
|
10908
|
+
*
|
|
10909
|
+
* ```javascript
|
|
10910
|
+
* <script data-id="sap-ui-config" type="application/json">
|
|
10484
10911
|
* {
|
|
10485
10912
|
* "calendarType": "Japanese"
|
|
10486
10913
|
* }
|
|
10487
|
-
* </script
|
|
10914
|
+
* </script>```
|
|
10488
10915
|
*/
|
|
10489
10916
|
class DatePicker extends sap.ui.webc.common.WebComponent {
|
|
10490
10917
|
/**
|
|
@@ -10752,8 +11179,8 @@ declare namespace sap {
|
|
|
10752
11179
|
*
|
|
10753
11180
|
*
|
|
10754
11181
|
*
|
|
10755
|
-
* Note
|
|
10756
|
-
*
|
|
11182
|
+
* **Note:** For calendars other than Gregorian, the week numbers are not displayed regardless of what is
|
|
11183
|
+
* set.
|
|
10757
11184
|
*
|
|
10758
11185
|
* Default value is `false`.
|
|
10759
11186
|
*/
|
|
@@ -10769,7 +11196,7 @@ declare namespace sap {
|
|
|
10769
11196
|
/**
|
|
10770
11197
|
* Gets current value of property {@link #getMinDate minDate}.
|
|
10771
11198
|
*
|
|
10772
|
-
* Determines the
|
|
11199
|
+
* Determines the minimum date available for selection.
|
|
10773
11200
|
*
|
|
10774
11201
|
* Default value is `empty string`.
|
|
10775
11202
|
*/
|
|
@@ -10963,8 +11390,8 @@ declare namespace sap {
|
|
|
10963
11390
|
*
|
|
10964
11391
|
*
|
|
10965
11392
|
*
|
|
10966
|
-
* Note
|
|
10967
|
-
*
|
|
11393
|
+
* **Note:** For calendars other than Gregorian, the week numbers are not displayed regardless of what is
|
|
11394
|
+
* set.
|
|
10968
11395
|
*
|
|
10969
11396
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
10970
11397
|
*
|
|
@@ -10994,7 +11421,7 @@ declare namespace sap {
|
|
|
10994
11421
|
/**
|
|
10995
11422
|
* Sets a new value for property {@link #getMinDate minDate}.
|
|
10996
11423
|
*
|
|
10997
|
-
* Determines the
|
|
11424
|
+
* Determines the minimum date available for selection.
|
|
10998
11425
|
*
|
|
10999
11426
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
11000
11427
|
*
|
|
@@ -11475,8 +11902,8 @@ declare namespace sap {
|
|
|
11475
11902
|
*
|
|
11476
11903
|
*
|
|
11477
11904
|
*
|
|
11478
|
-
* Note
|
|
11479
|
-
*
|
|
11905
|
+
* **Note:** For calendars other than Gregorian, the week numbers are not displayed regardless of what is
|
|
11906
|
+
* set.
|
|
11480
11907
|
*
|
|
11481
11908
|
* Default value is `false`.
|
|
11482
11909
|
*/
|
|
@@ -11492,7 +11919,7 @@ declare namespace sap {
|
|
|
11492
11919
|
/**
|
|
11493
11920
|
* Gets current value of property {@link #getMinDate minDate}.
|
|
11494
11921
|
*
|
|
11495
|
-
* Determines the
|
|
11922
|
+
* Determines the minimum date available for selection.
|
|
11496
11923
|
*
|
|
11497
11924
|
* Default value is `empty string`.
|
|
11498
11925
|
*/
|
|
@@ -11704,8 +12131,8 @@ declare namespace sap {
|
|
|
11704
12131
|
*
|
|
11705
12132
|
*
|
|
11706
12133
|
*
|
|
11707
|
-
* Note
|
|
11708
|
-
*
|
|
12134
|
+
* **Note:** For calendars other than Gregorian, the week numbers are not displayed regardless of what is
|
|
12135
|
+
* set.
|
|
11709
12136
|
*
|
|
11710
12137
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
11711
12138
|
*
|
|
@@ -11735,7 +12162,7 @@ declare namespace sap {
|
|
|
11735
12162
|
/**
|
|
11736
12163
|
* Sets a new value for property {@link #getMinDate minDate}.
|
|
11737
12164
|
*
|
|
11738
|
-
* Determines the
|
|
12165
|
+
* Determines the minimum date available for selection.
|
|
11739
12166
|
*
|
|
11740
12167
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
11741
12168
|
*
|
|
@@ -11935,9 +12362,6 @@ declare namespace sap {
|
|
|
11935
12362
|
*
|
|
11936
12363
|
* Programatically, to set date/time for the `DateTimePicker`, use the `value` property
|
|
11937
12364
|
*
|
|
11938
|
-
* As most of the input based components, the `DateTimePicker` supports properties, such as: `disabled`,
|
|
11939
|
-
* `readonly`, `valueState` and `placeholder`.
|
|
11940
|
-
*
|
|
11941
12365
|
* Formatting:
|
|
11942
12366
|
*
|
|
11943
12367
|
* The value entered by typing into the input field must fit to the used date/time format.
|
|
@@ -12242,8 +12666,8 @@ declare namespace sap {
|
|
|
12242
12666
|
*
|
|
12243
12667
|
*
|
|
12244
12668
|
*
|
|
12245
|
-
* Note
|
|
12246
|
-
*
|
|
12669
|
+
* **Note:** For calendars other than Gregorian, the week numbers are not displayed regardless of what is
|
|
12670
|
+
* set.
|
|
12247
12671
|
*
|
|
12248
12672
|
* Default value is `false`.
|
|
12249
12673
|
*/
|
|
@@ -12259,7 +12683,7 @@ declare namespace sap {
|
|
|
12259
12683
|
/**
|
|
12260
12684
|
* Gets current value of property {@link #getMinDate minDate}.
|
|
12261
12685
|
*
|
|
12262
|
-
* Determines the
|
|
12686
|
+
* Determines the minimum date available for selection.
|
|
12263
12687
|
*
|
|
12264
12688
|
* Default value is `empty string`.
|
|
12265
12689
|
*/
|
|
@@ -12453,8 +12877,8 @@ declare namespace sap {
|
|
|
12453
12877
|
*
|
|
12454
12878
|
*
|
|
12455
12879
|
*
|
|
12456
|
-
* Note
|
|
12457
|
-
*
|
|
12880
|
+
* **Note:** For calendars other than Gregorian, the week numbers are not displayed regardless of what is
|
|
12881
|
+
* set.
|
|
12458
12882
|
*
|
|
12459
12883
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
12460
12884
|
*
|
|
@@ -12484,7 +12908,7 @@ declare namespace sap {
|
|
|
12484
12908
|
/**
|
|
12485
12909
|
* Sets a new value for property {@link #getMinDate minDate}.
|
|
12486
12910
|
*
|
|
12487
|
-
* Determines the
|
|
12911
|
+
* Determines the minimum date available for selection.
|
|
12488
12912
|
*
|
|
12489
12913
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
12490
12914
|
*
|
|
@@ -13632,7 +14056,7 @@ declare namespace sap {
|
|
|
13632
14056
|
*
|
|
13633
14057
|
* Defines whether the component is in disabled state.
|
|
13634
14058
|
*
|
|
13635
|
-
* **Note:** A
|
|
14059
|
+
* **Note:** A disabled component is completely noninteractive.
|
|
13636
14060
|
*
|
|
13637
14061
|
* Default value is `false`.
|
|
13638
14062
|
*/
|
|
@@ -13783,7 +14207,7 @@ declare namespace sap {
|
|
|
13783
14207
|
*
|
|
13784
14208
|
* Defines whether the component is in disabled state.
|
|
13785
14209
|
*
|
|
13786
|
-
* **Note:** A
|
|
14210
|
+
* **Note:** A disabled component is completely noninteractive.
|
|
13787
14211
|
*
|
|
13788
14212
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
13789
14213
|
*
|
|
@@ -14437,7 +14861,7 @@ declare namespace sap {
|
|
|
14437
14861
|
*
|
|
14438
14862
|
*
|
|
14439
14863
|
* The text field can be editable or read-only (`readonly` property), and it can be enabled or disabled
|
|
14440
|
-
* (`
|
|
14864
|
+
* (`disabled` property). To visualize semantic states, such as "error" or "warning", the `valueState` property
|
|
14441
14865
|
* is provided. When the user makes changes to the text, the change event is fired, which enables you to
|
|
14442
14866
|
* react on any text change.
|
|
14443
14867
|
*
|
|
@@ -14505,6 +14929,15 @@ declare namespace sap {
|
|
|
14505
14929
|
* Returns a metadata object for class sap.ui.webc.main.Input.
|
|
14506
14930
|
*/
|
|
14507
14931
|
static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
|
|
14932
|
+
/**
|
|
14933
|
+
* Adds some icon to the aggregation {@link #getIcon icon}.
|
|
14934
|
+
*/
|
|
14935
|
+
addIcon(
|
|
14936
|
+
/**
|
|
14937
|
+
* The icon to add; if empty, nothing is inserted
|
|
14938
|
+
*/
|
|
14939
|
+
oIcon: sap.ui.webc.main.IIcon
|
|
14940
|
+
): this;
|
|
14508
14941
|
/**
|
|
14509
14942
|
* Adds some suggestionItem to the aggregation {@link #getSuggestionItems suggestionItems}.
|
|
14510
14943
|
*/
|
|
@@ -14687,50 +15120,7 @@ declare namespace sap {
|
|
|
14687
15120
|
oListener?: object
|
|
14688
15121
|
): this;
|
|
14689
15122
|
/**
|
|
14690
|
-
*
|
|
14691
|
-
* this `sap.ui.webc.main.Input`.
|
|
14692
|
-
*
|
|
14693
|
-
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
14694
|
-
* otherwise it will be bound to this `sap.ui.webc.main.Input` itself.
|
|
14695
|
-
*
|
|
14696
|
-
* Fired when the user scrolls the suggestion popover.
|
|
14697
|
-
*/
|
|
14698
|
-
attachSuggestionScroll(
|
|
14699
|
-
/**
|
|
14700
|
-
* An application-specific payload object that will be passed to the event handler along with the event
|
|
14701
|
-
* object when firing the event
|
|
14702
|
-
*/
|
|
14703
|
-
oData: object,
|
|
14704
|
-
/**
|
|
14705
|
-
* The function to be called when the event occurs
|
|
14706
|
-
*/
|
|
14707
|
-
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
14708
|
-
/**
|
|
14709
|
-
* Context object to call the event handler with. Defaults to this `sap.ui.webc.main.Input` itself
|
|
14710
|
-
*/
|
|
14711
|
-
oListener?: object
|
|
14712
|
-
): this;
|
|
14713
|
-
/**
|
|
14714
|
-
* Attaches event handler `fnFunction` to the {@link #event:suggestionScroll suggestionScroll} event of
|
|
14715
|
-
* this `sap.ui.webc.main.Input`.
|
|
14716
|
-
*
|
|
14717
|
-
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
14718
|
-
* otherwise it will be bound to this `sap.ui.webc.main.Input` itself.
|
|
14719
|
-
*
|
|
14720
|
-
* Fired when the user scrolls the suggestion popover.
|
|
14721
|
-
*/
|
|
14722
|
-
attachSuggestionScroll(
|
|
14723
|
-
/**
|
|
14724
|
-
* The function to be called when the event occurs
|
|
14725
|
-
*/
|
|
14726
|
-
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
14727
|
-
/**
|
|
14728
|
-
* Context object to call the event handler with. Defaults to this `sap.ui.webc.main.Input` itself
|
|
14729
|
-
*/
|
|
14730
|
-
oListener?: object
|
|
14731
|
-
): this;
|
|
14732
|
-
/**
|
|
14733
|
-
* Destroys the icon in the aggregation {@link #getIcon icon}.
|
|
15123
|
+
* Destroys all the icon in the aggregation {@link #getIcon icon}.
|
|
14734
15124
|
*/
|
|
14735
15125
|
destroyIcon(): this;
|
|
14736
15126
|
/**
|
|
@@ -14799,22 +15189,6 @@ declare namespace sap {
|
|
|
14799
15189
|
*/
|
|
14800
15190
|
oListener?: object
|
|
14801
15191
|
): this;
|
|
14802
|
-
/**
|
|
14803
|
-
* Detaches event handler `fnFunction` from the {@link #event:suggestionScroll suggestionScroll} event of
|
|
14804
|
-
* this `sap.ui.webc.main.Input`.
|
|
14805
|
-
*
|
|
14806
|
-
* The passed function and listener object must match the ones used for event registration.
|
|
14807
|
-
*/
|
|
14808
|
-
detachSuggestionScroll(
|
|
14809
|
-
/**
|
|
14810
|
-
* The function to be called, when the event occurs
|
|
14811
|
-
*/
|
|
14812
|
-
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
14813
|
-
/**
|
|
14814
|
-
* Context object on which the given function had to be called
|
|
14815
|
-
*/
|
|
14816
|
-
oListener?: object
|
|
14817
|
-
): this;
|
|
14818
15192
|
/**
|
|
14819
15193
|
* Fires event {@link #event:change change} to attached listeners.
|
|
14820
15194
|
*/
|
|
@@ -14842,7 +15216,7 @@ declare namespace sap {
|
|
|
14842
15216
|
*/
|
|
14843
15217
|
mParameters?: {
|
|
14844
15218
|
/**
|
|
14845
|
-
* The previewed suggestion item
|
|
15219
|
+
* The previewed suggestion item.
|
|
14846
15220
|
*/
|
|
14847
15221
|
item?: HTMLElement;
|
|
14848
15222
|
/**
|
|
@@ -14860,29 +15234,11 @@ declare namespace sap {
|
|
|
14860
15234
|
*/
|
|
14861
15235
|
mParameters?: {
|
|
14862
15236
|
/**
|
|
14863
|
-
* The selected item
|
|
15237
|
+
* The selected item.
|
|
14864
15238
|
*/
|
|
14865
15239
|
item?: HTMLElement;
|
|
14866
15240
|
}
|
|
14867
15241
|
): this;
|
|
14868
|
-
/**
|
|
14869
|
-
* Fires event {@link #event:suggestionScroll suggestionScroll} to attached listeners.
|
|
14870
|
-
*/
|
|
14871
|
-
fireSuggestionScroll(
|
|
14872
|
-
/**
|
|
14873
|
-
* Parameters to pass along with the event
|
|
14874
|
-
*/
|
|
14875
|
-
mParameters?: {
|
|
14876
|
-
/**
|
|
14877
|
-
* The current scroll position
|
|
14878
|
-
*/
|
|
14879
|
-
scrollTop?: int;
|
|
14880
|
-
/**
|
|
14881
|
-
* The scroll container
|
|
14882
|
-
*/
|
|
14883
|
-
scrollContainer?: HTMLElement;
|
|
14884
|
-
}
|
|
14885
|
-
): this;
|
|
14886
15242
|
/**
|
|
14887
15243
|
* Gets current value of property {@link #getAccessibleName accessibleName}.
|
|
14888
15244
|
*
|
|
@@ -14892,7 +15248,7 @@ declare namespace sap {
|
|
|
14892
15248
|
/**
|
|
14893
15249
|
* Gets current value of property {@link #getAccessibleNameRef accessibleNameRef}.
|
|
14894
15250
|
*
|
|
14895
|
-
* Receives id(or many ids) of the elements that label the input
|
|
15251
|
+
* Receives id(or many ids) of the elements that label the input.
|
|
14896
15252
|
*
|
|
14897
15253
|
* Default value is `empty string`.
|
|
14898
15254
|
*/
|
|
@@ -14912,7 +15268,7 @@ declare namespace sap {
|
|
|
14912
15268
|
*
|
|
14913
15269
|
* Defines the icon to be displayed in the component.
|
|
14914
15270
|
*/
|
|
14915
|
-
getIcon(): sap.ui.webc.main.IIcon;
|
|
15271
|
+
getIcon(): sap.ui.webc.main.IIcon[];
|
|
14916
15272
|
/**
|
|
14917
15273
|
* Gets current value of property {@link #getMaxlength maxlength}.
|
|
14918
15274
|
*
|
|
@@ -15029,6 +15385,16 @@ declare namespace sap {
|
|
|
15029
15385
|
* Default value is `empty string`.
|
|
15030
15386
|
*/
|
|
15031
15387
|
getValueStateMessage(): string;
|
|
15388
|
+
/**
|
|
15389
|
+
* Checks for the provided `sap.ui.webc.main.IIcon` in the aggregation {@link #getIcon icon}. and returns
|
|
15390
|
+
* its index if found or -1 otherwise.
|
|
15391
|
+
*/
|
|
15392
|
+
indexOfIcon(
|
|
15393
|
+
/**
|
|
15394
|
+
* The icon whose index is looked for
|
|
15395
|
+
*/
|
|
15396
|
+
oIcon: sap.ui.webc.main.IIcon
|
|
15397
|
+
): int;
|
|
15032
15398
|
/**
|
|
15033
15399
|
* Checks for the provided `sap.ui.webc.main.IInputSuggestionItem` in the aggregation {@link #getSuggestionItems
|
|
15034
15400
|
* suggestionItems}. and returns its index if found or -1 otherwise.
|
|
@@ -15039,6 +15405,21 @@ declare namespace sap {
|
|
|
15039
15405
|
*/
|
|
15040
15406
|
oSuggestionItem: sap.ui.webc.main.IInputSuggestionItem
|
|
15041
15407
|
): int;
|
|
15408
|
+
/**
|
|
15409
|
+
* Inserts a icon into the aggregation {@link #getIcon icon}.
|
|
15410
|
+
*/
|
|
15411
|
+
insertIcon(
|
|
15412
|
+
/**
|
|
15413
|
+
* The icon to insert; if empty, nothing is inserted
|
|
15414
|
+
*/
|
|
15415
|
+
oIcon: sap.ui.webc.main.IIcon,
|
|
15416
|
+
/**
|
|
15417
|
+
* The `0`-based index the icon should be inserted at; for a negative value of `iIndex`, the icon is inserted
|
|
15418
|
+
* at position 0; for a value greater than the current size of the aggregation, the icon is inserted at
|
|
15419
|
+
* the last position
|
|
15420
|
+
*/
|
|
15421
|
+
iIndex: int
|
|
15422
|
+
): this;
|
|
15042
15423
|
/**
|
|
15043
15424
|
* Inserts a suggestionItem into the aggregation {@link #getSuggestionItems suggestionItems}.
|
|
15044
15425
|
*/
|
|
@@ -15054,12 +15435,27 @@ declare namespace sap {
|
|
|
15054
15435
|
*/
|
|
15055
15436
|
iIndex: int
|
|
15056
15437
|
): this;
|
|
15438
|
+
/**
|
|
15439
|
+
* Removes all the controls from the aggregation {@link #getIcon icon}.
|
|
15440
|
+
*
|
|
15441
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
15442
|
+
*/
|
|
15443
|
+
removeAllIcon(): sap.ui.webc.main.IIcon[];
|
|
15057
15444
|
/**
|
|
15058
15445
|
* Removes all the controls from the aggregation {@link #getSuggestionItems suggestionItems}.
|
|
15059
15446
|
*
|
|
15060
15447
|
* Additionally, it unregisters them from the hosting UIArea.
|
|
15061
15448
|
*/
|
|
15062
15449
|
removeAllSuggestionItems(): sap.ui.webc.main.IInputSuggestionItem[];
|
|
15450
|
+
/**
|
|
15451
|
+
* Removes a icon from the aggregation {@link #getIcon icon}.
|
|
15452
|
+
*/
|
|
15453
|
+
removeIcon(
|
|
15454
|
+
/**
|
|
15455
|
+
* The icon to remove or its index or id
|
|
15456
|
+
*/
|
|
15457
|
+
vIcon: int | string | sap.ui.webc.main.IIcon
|
|
15458
|
+
): sap.ui.webc.main.IIcon;
|
|
15063
15459
|
/**
|
|
15064
15460
|
* Removes a suggestionItem from the aggregation {@link #getSuggestionItems suggestionItems}.
|
|
15065
15461
|
*/
|
|
@@ -15088,7 +15484,7 @@ declare namespace sap {
|
|
|
15088
15484
|
/**
|
|
15089
15485
|
* Sets a new value for property {@link #getAccessibleNameRef accessibleNameRef}.
|
|
15090
15486
|
*
|
|
15091
|
-
* Receives id(or many ids) of the elements that label the input
|
|
15487
|
+
* Receives id(or many ids) of the elements that label the input.
|
|
15092
15488
|
*
|
|
15093
15489
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
15094
15490
|
*
|
|
@@ -15117,15 +15513,6 @@ declare namespace sap {
|
|
|
15117
15513
|
*/
|
|
15118
15514
|
bDisabled?: boolean
|
|
15119
15515
|
): this;
|
|
15120
|
-
/**
|
|
15121
|
-
* Sets the aggregated {@link #getIcon icon}.
|
|
15122
|
-
*/
|
|
15123
|
-
setIcon(
|
|
15124
|
-
/**
|
|
15125
|
-
* The icon to set
|
|
15126
|
-
*/
|
|
15127
|
-
oIcon: sap.ui.webc.main.IIcon
|
|
15128
|
-
): this;
|
|
15129
15516
|
/**
|
|
15130
15517
|
* Sets a new value for property {@link #getMaxlength maxlength}.
|
|
15131
15518
|
*
|
|
@@ -15399,7 +15786,7 @@ declare namespace sap {
|
|
|
15399
15786
|
/**
|
|
15400
15787
|
* Gets current value of property {@link #getShowColon showColon}.
|
|
15401
15788
|
*
|
|
15402
|
-
* Defines whether
|
|
15789
|
+
* Defines whether colon is added to the component text.
|
|
15403
15790
|
*
|
|
15404
15791
|
* **Note:** Usually used in forms.
|
|
15405
15792
|
*
|
|
@@ -15468,7 +15855,7 @@ declare namespace sap {
|
|
|
15468
15855
|
/**
|
|
15469
15856
|
* Sets a new value for property {@link #getShowColon showColon}.
|
|
15470
15857
|
*
|
|
15471
|
-
* Defines whether
|
|
15858
|
+
* Defines whether colon is added to the component text.
|
|
15472
15859
|
*
|
|
15473
15860
|
* **Note:** Usually used in forms.
|
|
15474
15861
|
*
|
|
@@ -15699,7 +16086,7 @@ declare namespace sap {
|
|
|
15699
16086
|
*
|
|
15700
16087
|
* Defines whether the component is disabled.
|
|
15701
16088
|
*
|
|
15702
|
-
* **Note:** When disabled, the
|
|
16089
|
+
* **Note:** When disabled, the click event cannot be triggered by the user.
|
|
15703
16090
|
*
|
|
15704
16091
|
* Default value is `false`.
|
|
15705
16092
|
*/
|
|
@@ -15789,7 +16176,7 @@ declare namespace sap {
|
|
|
15789
16176
|
*
|
|
15790
16177
|
* Defines whether the component is disabled.
|
|
15791
16178
|
*
|
|
15792
|
-
* **Note:** When disabled, the
|
|
16179
|
+
* **Note:** When disabled, the click event cannot be triggered by the user.
|
|
15793
16180
|
*
|
|
15794
16181
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
15795
16182
|
*
|
|
@@ -15887,7 +16274,7 @@ declare namespace sap {
|
|
|
15887
16274
|
* The `sap.ui.webc.main.List` component allows displaying a list of items, advanced keyboard handling support
|
|
15888
16275
|
* for navigating between items, and predefined modes to improve the development efficiency.
|
|
15889
16276
|
*
|
|
15890
|
-
* The `sap.ui.webc.main.List` is
|
|
16277
|
+
* The `sap.ui.webc.main.List` is a container for the available list items:
|
|
15891
16278
|
* - `sap.ui.webc.main.StandardListItem`
|
|
15892
16279
|
* - `sap.ui.webc.main.CustomListItem`
|
|
15893
16280
|
* - `sap.ui.webc.main.GroupHeaderListItem`
|
|
@@ -16442,7 +16829,7 @@ declare namespace sap {
|
|
|
16442
16829
|
/**
|
|
16443
16830
|
* Gets current value of property {@link #getAccessibleName accessibleName}.
|
|
16444
16831
|
*
|
|
16445
|
-
*
|
|
16832
|
+
* Defines the accessible name of the component.
|
|
16446
16833
|
*
|
|
16447
16834
|
* Default value is `empty string`.
|
|
16448
16835
|
*/
|
|
@@ -16450,7 +16837,7 @@ declare namespace sap {
|
|
|
16450
16837
|
/**
|
|
16451
16838
|
* Gets current value of property {@link #getAccessibleNameRef accessibleNameRef}.
|
|
16452
16839
|
*
|
|
16453
|
-
*
|
|
16840
|
+
* Defines the IDs of the elements that label the input.
|
|
16454
16841
|
*
|
|
16455
16842
|
* Default value is `empty string`.
|
|
16456
16843
|
*/
|
|
@@ -16460,10 +16847,9 @@ declare namespace sap {
|
|
|
16460
16847
|
*
|
|
16461
16848
|
* Defines the accessible role of the component.
|
|
16462
16849
|
*
|
|
16463
|
-
* **Note:** If you use notification list items, it's recommended to set `accessible-role="list"` for better
|
|
16464
|
-
* accessibility.
|
|
16465
16850
|
*
|
|
16466
|
-
*
|
|
16851
|
+
*
|
|
16852
|
+
* Default value is `"list"`.
|
|
16467
16853
|
*/
|
|
16468
16854
|
getAccessibleRole(): string;
|
|
16469
16855
|
/**
|
|
@@ -16507,7 +16893,7 @@ declare namespace sap {
|
|
|
16507
16893
|
*
|
|
16508
16894
|
*
|
|
16509
16895
|
*
|
|
16510
|
-
* **
|
|
16896
|
+
* **Restrictions:** `growing="Scroll"` is not supported for Internet Explorer, on IE the component will
|
|
16511
16897
|
* fallback to `growing="Button"`.
|
|
16512
16898
|
*
|
|
16513
16899
|
* Default value is `None`.
|
|
@@ -16540,7 +16926,7 @@ declare namespace sap {
|
|
|
16540
16926
|
/**
|
|
16541
16927
|
* Gets current value of property {@link #getIndent indent}.
|
|
16542
16928
|
*
|
|
16543
|
-
* Determines whether the
|
|
16929
|
+
* Determines whether the component is indented.
|
|
16544
16930
|
*
|
|
16545
16931
|
* Default value is `false`.
|
|
16546
16932
|
*/
|
|
@@ -16676,7 +17062,7 @@ declare namespace sap {
|
|
|
16676
17062
|
/**
|
|
16677
17063
|
* Sets a new value for property {@link #getAccessibleName accessibleName}.
|
|
16678
17064
|
*
|
|
16679
|
-
*
|
|
17065
|
+
* Defines the accessible name of the component.
|
|
16680
17066
|
*
|
|
16681
17067
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
16682
17068
|
*
|
|
@@ -16691,7 +17077,7 @@ declare namespace sap {
|
|
|
16691
17077
|
/**
|
|
16692
17078
|
* Sets a new value for property {@link #getAccessibleNameRef accessibleNameRef}.
|
|
16693
17079
|
*
|
|
16694
|
-
*
|
|
17080
|
+
* Defines the IDs of the elements that label the input.
|
|
16695
17081
|
*
|
|
16696
17082
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
16697
17083
|
*
|
|
@@ -16708,12 +17094,11 @@ declare namespace sap {
|
|
|
16708
17094
|
*
|
|
16709
17095
|
* Defines the accessible role of the component.
|
|
16710
17096
|
*
|
|
16711
|
-
*
|
|
16712
|
-
* accessibility.
|
|
17097
|
+
*
|
|
16713
17098
|
*
|
|
16714
17099
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
16715
17100
|
*
|
|
16716
|
-
* Default value is `"
|
|
17101
|
+
* Default value is `"list"`.
|
|
16717
17102
|
*/
|
|
16718
17103
|
setAccessibleRole(
|
|
16719
17104
|
/**
|
|
@@ -16783,7 +17168,7 @@ declare namespace sap {
|
|
|
16783
17168
|
*
|
|
16784
17169
|
*
|
|
16785
17170
|
*
|
|
16786
|
-
* **
|
|
17171
|
+
* **Restrictions:** `growing="Scroll"` is not supported for Internet Explorer, on IE the component will
|
|
16787
17172
|
* fallback to `growing="Button"`.
|
|
16788
17173
|
*
|
|
16789
17174
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
@@ -16829,7 +17214,7 @@ declare namespace sap {
|
|
|
16829
17214
|
/**
|
|
16830
17215
|
* Sets a new value for property {@link #getIndent indent}.
|
|
16831
17216
|
*
|
|
16832
|
-
* Determines whether the
|
|
17217
|
+
* Determines whether the component is indented.
|
|
16833
17218
|
*
|
|
16834
17219
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
16835
17220
|
*
|
|
@@ -17069,7 +17454,7 @@ declare namespace sap {
|
|
|
17069
17454
|
/**
|
|
17070
17455
|
* Gets current value of property {@link #getHideCloseButton hideCloseButton}.
|
|
17071
17456
|
*
|
|
17072
|
-
* Defines whether the MessageStrip renders close
|
|
17457
|
+
* Defines whether the MessageStrip renders close button.
|
|
17073
17458
|
*
|
|
17074
17459
|
* Default value is `false`.
|
|
17075
17460
|
*/
|
|
@@ -17143,7 +17528,7 @@ declare namespace sap {
|
|
|
17143
17528
|
/**
|
|
17144
17529
|
* Sets a new value for property {@link #getHideCloseButton hideCloseButton}.
|
|
17145
17530
|
*
|
|
17146
|
-
* Defines whether the MessageStrip renders close
|
|
17531
|
+
* Defines whether the MessageStrip renders close button.
|
|
17147
17532
|
*
|
|
17148
17533
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
17149
17534
|
*
|
|
@@ -17215,13 +17600,13 @@ declare namespace sap {
|
|
|
17215
17600
|
*
|
|
17216
17601
|
* Overview:
|
|
17217
17602
|
*
|
|
17218
|
-
* The `sap.ui.webc.main.MultiComboBox` component
|
|
17219
|
-
* the user to either type a value directly into the
|
|
17603
|
+
* The `sap.ui.webc.main.MultiComboBox` component consists of a list box with items and a text field allowing
|
|
17604
|
+
* the user to either type a value directly into the text field, or choose from the list of existing items.
|
|
17220
17605
|
*
|
|
17221
|
-
*
|
|
17222
|
-
*
|
|
17223
|
-
*
|
|
17224
|
-
* multi-selection. Entered values are displayed as tokens. Structure: The `sap.ui.webc.main.MultiComboBox`
|
|
17606
|
+
* The drop-down list is used for selecting and filtering values, it enables users to select one or more
|
|
17607
|
+
* options from a predefined list. The control provides an editable input field to filter the list, and
|
|
17608
|
+
* a dropdown arrow to expand/collapse the list of available options. The options in the list have checkboxes
|
|
17609
|
+
* that permit multi-selection. Entered values are displayed as tokens. Structure: The `sap.ui.webc.main.MultiComboBox`
|
|
17225
17610
|
* consists of the following elements:
|
|
17226
17611
|
* - Tokenizer - a list of tokens with selected options. Input field - displays the selected option/s
|
|
17227
17612
|
* as token/s. Users can type to filter the list. Drop-down arrow - expands\collapses the option list.
|
|
@@ -17242,11 +17627,6 @@ declare namespace sap {
|
|
|
17242
17627
|
* - Delete - deletes the token and focuses the previous token.
|
|
17243
17628
|
* - Backspace - deletes the token and focus the next token.
|
|
17244
17629
|
*
|
|
17245
|
-
* In the context of `sap.ui.webc.main.MultiComboBox`, you can provide a custom stable DOM ref for:
|
|
17246
|
-
*
|
|
17247
|
-
* - Every `sap.ui.webc.main.MultiComboBoxItem` that you provide. Example: `
|
|
17248
|
-
* `
|
|
17249
|
-
*
|
|
17250
17630
|
* CSS Shadow Parts:
|
|
17251
17631
|
*
|
|
17252
17632
|
* CSS Shadow Parts
|
|
@@ -18110,6 +18490,15 @@ declare namespace sap {
|
|
|
18110
18490
|
* Returns a metadata object for class sap.ui.webc.main.MultiInput.
|
|
18111
18491
|
*/
|
|
18112
18492
|
static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
|
|
18493
|
+
/**
|
|
18494
|
+
* Adds some icon to the aggregation {@link #getIcon icon}.
|
|
18495
|
+
*/
|
|
18496
|
+
addIcon(
|
|
18497
|
+
/**
|
|
18498
|
+
* The icon to add; if empty, nothing is inserted
|
|
18499
|
+
*/
|
|
18500
|
+
oIcon: sap.ui.webc.main.IIcon
|
|
18501
|
+
): this;
|
|
18113
18502
|
/**
|
|
18114
18503
|
* Adds some suggestionItem to the aggregation {@link #getSuggestionItems suggestionItems}.
|
|
18115
18504
|
*/
|
|
@@ -18200,54 +18589,9 @@ declare namespace sap {
|
|
|
18200
18589
|
* otherwise it will be bound to this `sap.ui.webc.main.MultiInput` itself.
|
|
18201
18590
|
*
|
|
18202
18591
|
* Fired when the value of the component changes at each keystroke, and when a suggestion item has been
|
|
18203
|
-
* selected.
|
|
18204
|
-
*/
|
|
18205
|
-
attachInput(
|
|
18206
|
-
/**
|
|
18207
|
-
* The function to be called when the event occurs
|
|
18208
|
-
*/
|
|
18209
|
-
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
18210
|
-
/**
|
|
18211
|
-
* Context object to call the event handler with. Defaults to this `sap.ui.webc.main.MultiInput` itself
|
|
18212
|
-
*/
|
|
18213
|
-
oListener?: object
|
|
18214
|
-
): this;
|
|
18215
|
-
/**
|
|
18216
|
-
* Attaches event handler `fnFunction` to the {@link #event:suggestionItemPreview suggestionItemPreview}
|
|
18217
|
-
* event of this `sap.ui.webc.main.MultiInput`.
|
|
18218
|
-
*
|
|
18219
|
-
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
18220
|
-
* otherwise it will be bound to this `sap.ui.webc.main.MultiInput` itself.
|
|
18221
|
-
*
|
|
18222
|
-
* Fired when the user navigates to a suggestion item via the ARROW keys, as a preview, before the final
|
|
18223
|
-
* selection.
|
|
18224
|
-
*/
|
|
18225
|
-
attachSuggestionItemPreview(
|
|
18226
|
-
/**
|
|
18227
|
-
* An application-specific payload object that will be passed to the event handler along with the event
|
|
18228
|
-
* object when firing the event
|
|
18229
|
-
*/
|
|
18230
|
-
oData: object,
|
|
18231
|
-
/**
|
|
18232
|
-
* The function to be called when the event occurs
|
|
18233
|
-
*/
|
|
18234
|
-
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
18235
|
-
/**
|
|
18236
|
-
* Context object to call the event handler with. Defaults to this `sap.ui.webc.main.MultiInput` itself
|
|
18237
|
-
*/
|
|
18238
|
-
oListener?: object
|
|
18239
|
-
): this;
|
|
18240
|
-
/**
|
|
18241
|
-
* Attaches event handler `fnFunction` to the {@link #event:suggestionItemPreview suggestionItemPreview}
|
|
18242
|
-
* event of this `sap.ui.webc.main.MultiInput`.
|
|
18243
|
-
*
|
|
18244
|
-
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
18245
|
-
* otherwise it will be bound to this `sap.ui.webc.main.MultiInput` itself.
|
|
18246
|
-
*
|
|
18247
|
-
* Fired when the user navigates to a suggestion item via the ARROW keys, as a preview, before the final
|
|
18248
|
-
* selection.
|
|
18592
|
+
* selected.
|
|
18249
18593
|
*/
|
|
18250
|
-
|
|
18594
|
+
attachInput(
|
|
18251
18595
|
/**
|
|
18252
18596
|
* The function to be called when the event occurs
|
|
18253
18597
|
*/
|
|
@@ -18258,15 +18602,16 @@ declare namespace sap {
|
|
|
18258
18602
|
oListener?: object
|
|
18259
18603
|
): this;
|
|
18260
18604
|
/**
|
|
18261
|
-
* Attaches event handler `fnFunction` to the {@link #event:
|
|
18262
|
-
* of this `sap.ui.webc.main.MultiInput`.
|
|
18605
|
+
* Attaches event handler `fnFunction` to the {@link #event:suggestionItemPreview suggestionItemPreview}
|
|
18606
|
+
* event of this `sap.ui.webc.main.MultiInput`.
|
|
18263
18607
|
*
|
|
18264
18608
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
18265
18609
|
* otherwise it will be bound to this `sap.ui.webc.main.MultiInput` itself.
|
|
18266
18610
|
*
|
|
18267
|
-
* Fired when a suggestion item
|
|
18611
|
+
* Fired when the user navigates to a suggestion item via the ARROW keys, as a preview, before the final
|
|
18612
|
+
* selection.
|
|
18268
18613
|
*/
|
|
18269
|
-
|
|
18614
|
+
attachSuggestionItemPreview(
|
|
18270
18615
|
/**
|
|
18271
18616
|
* An application-specific payload object that will be passed to the event handler along with the event
|
|
18272
18617
|
* object when firing the event
|
|
@@ -18282,15 +18627,16 @@ declare namespace sap {
|
|
|
18282
18627
|
oListener?: object
|
|
18283
18628
|
): this;
|
|
18284
18629
|
/**
|
|
18285
|
-
* Attaches event handler `fnFunction` to the {@link #event:
|
|
18286
|
-
* of this `sap.ui.webc.main.MultiInput`.
|
|
18630
|
+
* Attaches event handler `fnFunction` to the {@link #event:suggestionItemPreview suggestionItemPreview}
|
|
18631
|
+
* event of this `sap.ui.webc.main.MultiInput`.
|
|
18287
18632
|
*
|
|
18288
18633
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
18289
18634
|
* otherwise it will be bound to this `sap.ui.webc.main.MultiInput` itself.
|
|
18290
18635
|
*
|
|
18291
|
-
* Fired when a suggestion item
|
|
18636
|
+
* Fired when the user navigates to a suggestion item via the ARROW keys, as a preview, before the final
|
|
18637
|
+
* selection.
|
|
18292
18638
|
*/
|
|
18293
|
-
|
|
18639
|
+
attachSuggestionItemPreview(
|
|
18294
18640
|
/**
|
|
18295
18641
|
* The function to be called when the event occurs
|
|
18296
18642
|
*/
|
|
@@ -18301,15 +18647,15 @@ declare namespace sap {
|
|
|
18301
18647
|
oListener?: object
|
|
18302
18648
|
): this;
|
|
18303
18649
|
/**
|
|
18304
|
-
* Attaches event handler `fnFunction` to the {@link #event:
|
|
18305
|
-
* this `sap.ui.webc.main.MultiInput`.
|
|
18650
|
+
* Attaches event handler `fnFunction` to the {@link #event:suggestionItemSelect suggestionItemSelect} event
|
|
18651
|
+
* of this `sap.ui.webc.main.MultiInput`.
|
|
18306
18652
|
*
|
|
18307
18653
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
18308
18654
|
* otherwise it will be bound to this `sap.ui.webc.main.MultiInput` itself.
|
|
18309
18655
|
*
|
|
18310
|
-
* Fired when
|
|
18656
|
+
* Fired when a suggestion item, that is displayed in the suggestion popup, is selected.
|
|
18311
18657
|
*/
|
|
18312
|
-
|
|
18658
|
+
attachSuggestionItemSelect(
|
|
18313
18659
|
/**
|
|
18314
18660
|
* An application-specific payload object that will be passed to the event handler along with the event
|
|
18315
18661
|
* object when firing the event
|
|
@@ -18325,15 +18671,15 @@ declare namespace sap {
|
|
|
18325
18671
|
oListener?: object
|
|
18326
18672
|
): this;
|
|
18327
18673
|
/**
|
|
18328
|
-
* Attaches event handler `fnFunction` to the {@link #event:
|
|
18329
|
-
* this `sap.ui.webc.main.MultiInput`.
|
|
18674
|
+
* Attaches event handler `fnFunction` to the {@link #event:suggestionItemSelect suggestionItemSelect} event
|
|
18675
|
+
* of this `sap.ui.webc.main.MultiInput`.
|
|
18330
18676
|
*
|
|
18331
18677
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
18332
18678
|
* otherwise it will be bound to this `sap.ui.webc.main.MultiInput` itself.
|
|
18333
18679
|
*
|
|
18334
|
-
* Fired when
|
|
18680
|
+
* Fired when a suggestion item, that is displayed in the suggestion popup, is selected.
|
|
18335
18681
|
*/
|
|
18336
|
-
|
|
18682
|
+
attachSuggestionItemSelect(
|
|
18337
18683
|
/**
|
|
18338
18684
|
* The function to be called when the event occurs
|
|
18339
18685
|
*/
|
|
@@ -18430,7 +18776,7 @@ declare namespace sap {
|
|
|
18430
18776
|
oListener?: object
|
|
18431
18777
|
): this;
|
|
18432
18778
|
/**
|
|
18433
|
-
* Destroys the icon in the aggregation {@link #getIcon icon}.
|
|
18779
|
+
* Destroys all the icon in the aggregation {@link #getIcon icon}.
|
|
18434
18780
|
*/
|
|
18435
18781
|
destroyIcon(): this;
|
|
18436
18782
|
/**
|
|
@@ -18503,22 +18849,6 @@ declare namespace sap {
|
|
|
18503
18849
|
*/
|
|
18504
18850
|
oListener?: object
|
|
18505
18851
|
): this;
|
|
18506
|
-
/**
|
|
18507
|
-
* Detaches event handler `fnFunction` from the {@link #event:suggestionScroll suggestionScroll} event of
|
|
18508
|
-
* this `sap.ui.webc.main.MultiInput`.
|
|
18509
|
-
*
|
|
18510
|
-
* The passed function and listener object must match the ones used for event registration.
|
|
18511
|
-
*/
|
|
18512
|
-
detachSuggestionScroll(
|
|
18513
|
-
/**
|
|
18514
|
-
* The function to be called, when the event occurs
|
|
18515
|
-
*/
|
|
18516
|
-
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
18517
|
-
/**
|
|
18518
|
-
* Context object on which the given function had to be called
|
|
18519
|
-
*/
|
|
18520
|
-
oListener?: object
|
|
18521
|
-
): this;
|
|
18522
18852
|
/**
|
|
18523
18853
|
* Detaches event handler `fnFunction` from the {@link #event:tokenDelete tokenDelete} event of this `sap.ui.webc.main.MultiInput`.
|
|
18524
18854
|
*
|
|
@@ -18577,7 +18907,7 @@ declare namespace sap {
|
|
|
18577
18907
|
*/
|
|
18578
18908
|
mParameters?: {
|
|
18579
18909
|
/**
|
|
18580
|
-
* The previewed suggestion item
|
|
18910
|
+
* The previewed suggestion item.
|
|
18581
18911
|
*/
|
|
18582
18912
|
item?: HTMLElement;
|
|
18583
18913
|
/**
|
|
@@ -18595,29 +18925,11 @@ declare namespace sap {
|
|
|
18595
18925
|
*/
|
|
18596
18926
|
mParameters?: {
|
|
18597
18927
|
/**
|
|
18598
|
-
* The selected item
|
|
18928
|
+
* The selected item.
|
|
18599
18929
|
*/
|
|
18600
18930
|
item?: HTMLElement;
|
|
18601
18931
|
}
|
|
18602
18932
|
): this;
|
|
18603
|
-
/**
|
|
18604
|
-
* Fires event {@link #event:suggestionScroll suggestionScroll} to attached listeners.
|
|
18605
|
-
*/
|
|
18606
|
-
fireSuggestionScroll(
|
|
18607
|
-
/**
|
|
18608
|
-
* Parameters to pass along with the event
|
|
18609
|
-
*/
|
|
18610
|
-
mParameters?: {
|
|
18611
|
-
/**
|
|
18612
|
-
* The current scroll position
|
|
18613
|
-
*/
|
|
18614
|
-
scrollTop?: int;
|
|
18615
|
-
/**
|
|
18616
|
-
* The scroll container
|
|
18617
|
-
*/
|
|
18618
|
-
scrollContainer?: HTMLElement;
|
|
18619
|
-
}
|
|
18620
|
-
): this;
|
|
18621
18933
|
/**
|
|
18622
18934
|
* Fires event {@link #event:tokenDelete tokenDelete} to attached listeners.
|
|
18623
18935
|
*/
|
|
@@ -18650,7 +18962,7 @@ declare namespace sap {
|
|
|
18650
18962
|
/**
|
|
18651
18963
|
* Gets current value of property {@link #getAccessibleNameRef accessibleNameRef}.
|
|
18652
18964
|
*
|
|
18653
|
-
* Receives id(or many ids) of the elements that label the input
|
|
18965
|
+
* Receives id(or many ids) of the elements that label the input.
|
|
18654
18966
|
*
|
|
18655
18967
|
* Default value is `empty string`.
|
|
18656
18968
|
*/
|
|
@@ -18670,7 +18982,7 @@ declare namespace sap {
|
|
|
18670
18982
|
*
|
|
18671
18983
|
* Defines the icon to be displayed in the component.
|
|
18672
18984
|
*/
|
|
18673
|
-
getIcon(): sap.ui.webc.main.IIcon;
|
|
18985
|
+
getIcon(): sap.ui.webc.main.IIcon[];
|
|
18674
18986
|
/**
|
|
18675
18987
|
* Gets current value of property {@link #getMaxlength maxlength}.
|
|
18676
18988
|
*
|
|
@@ -18734,8 +19046,8 @@ declare namespace sap {
|
|
|
18734
19046
|
/**
|
|
18735
19047
|
* Gets current value of property {@link #getShowValueHelpIcon showValueHelpIcon}.
|
|
18736
19048
|
*
|
|
18737
|
-
* Determines whether a value help icon will be
|
|
18738
|
-
* `value-help-trigger` event.
|
|
19049
|
+
* Determines whether a value help icon will be visualized in the end of the input. Pressing the icon will
|
|
19050
|
+
* fire `value-help-trigger` event.
|
|
18739
19051
|
*
|
|
18740
19052
|
* Default value is `false`.
|
|
18741
19053
|
*/
|
|
@@ -18802,6 +19114,16 @@ declare namespace sap {
|
|
|
18802
19114
|
* Default value is `empty string`.
|
|
18803
19115
|
*/
|
|
18804
19116
|
getValueStateMessage(): string;
|
|
19117
|
+
/**
|
|
19118
|
+
* Checks for the provided `sap.ui.webc.main.IIcon` in the aggregation {@link #getIcon icon}. and returns
|
|
19119
|
+
* its index if found or -1 otherwise.
|
|
19120
|
+
*/
|
|
19121
|
+
indexOfIcon(
|
|
19122
|
+
/**
|
|
19123
|
+
* The icon whose index is looked for
|
|
19124
|
+
*/
|
|
19125
|
+
oIcon: sap.ui.webc.main.IIcon
|
|
19126
|
+
): int;
|
|
18805
19127
|
/**
|
|
18806
19128
|
* Checks for the provided `sap.ui.webc.main.IInputSuggestionItem` in the aggregation {@link #getSuggestionItems
|
|
18807
19129
|
* suggestionItems}. and returns its index if found or -1 otherwise.
|
|
@@ -18822,6 +19144,21 @@ declare namespace sap {
|
|
|
18822
19144
|
*/
|
|
18823
19145
|
oToken: sap.ui.webc.main.IToken
|
|
18824
19146
|
): int;
|
|
19147
|
+
/**
|
|
19148
|
+
* Inserts a icon into the aggregation {@link #getIcon icon}.
|
|
19149
|
+
*/
|
|
19150
|
+
insertIcon(
|
|
19151
|
+
/**
|
|
19152
|
+
* The icon to insert; if empty, nothing is inserted
|
|
19153
|
+
*/
|
|
19154
|
+
oIcon: sap.ui.webc.main.IIcon,
|
|
19155
|
+
/**
|
|
19156
|
+
* The `0`-based index the icon should be inserted at; for a negative value of `iIndex`, the icon is inserted
|
|
19157
|
+
* at position 0; for a value greater than the current size of the aggregation, the icon is inserted at
|
|
19158
|
+
* the last position
|
|
19159
|
+
*/
|
|
19160
|
+
iIndex: int
|
|
19161
|
+
): this;
|
|
18825
19162
|
/**
|
|
18826
19163
|
* Inserts a suggestionItem into the aggregation {@link #getSuggestionItems suggestionItems}.
|
|
18827
19164
|
*/
|
|
@@ -18852,6 +19189,12 @@ declare namespace sap {
|
|
|
18852
19189
|
*/
|
|
18853
19190
|
iIndex: int
|
|
18854
19191
|
): this;
|
|
19192
|
+
/**
|
|
19193
|
+
* Removes all the controls from the aggregation {@link #getIcon icon}.
|
|
19194
|
+
*
|
|
19195
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
19196
|
+
*/
|
|
19197
|
+
removeAllIcon(): sap.ui.webc.main.IIcon[];
|
|
18855
19198
|
/**
|
|
18856
19199
|
* Removes all the controls from the aggregation {@link #getSuggestionItems suggestionItems}.
|
|
18857
19200
|
*
|
|
@@ -18864,6 +19207,15 @@ declare namespace sap {
|
|
|
18864
19207
|
* Additionally, it unregisters them from the hosting UIArea.
|
|
18865
19208
|
*/
|
|
18866
19209
|
removeAllTokens(): sap.ui.webc.main.IToken[];
|
|
19210
|
+
/**
|
|
19211
|
+
* Removes a icon from the aggregation {@link #getIcon icon}.
|
|
19212
|
+
*/
|
|
19213
|
+
removeIcon(
|
|
19214
|
+
/**
|
|
19215
|
+
* The icon to remove or its index or id
|
|
19216
|
+
*/
|
|
19217
|
+
vIcon: int | string | sap.ui.webc.main.IIcon
|
|
19218
|
+
): sap.ui.webc.main.IIcon;
|
|
18867
19219
|
/**
|
|
18868
19220
|
* Removes a suggestionItem from the aggregation {@link #getSuggestionItems suggestionItems}.
|
|
18869
19221
|
*/
|
|
@@ -18901,7 +19253,7 @@ declare namespace sap {
|
|
|
18901
19253
|
/**
|
|
18902
19254
|
* Sets a new value for property {@link #getAccessibleNameRef accessibleNameRef}.
|
|
18903
19255
|
*
|
|
18904
|
-
* Receives id(or many ids) of the elements that label the input
|
|
19256
|
+
* Receives id(or many ids) of the elements that label the input.
|
|
18905
19257
|
*
|
|
18906
19258
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
18907
19259
|
*
|
|
@@ -18930,15 +19282,6 @@ declare namespace sap {
|
|
|
18930
19282
|
*/
|
|
18931
19283
|
bDisabled?: boolean
|
|
18932
19284
|
): this;
|
|
18933
|
-
/**
|
|
18934
|
-
* Sets the aggregated {@link #getIcon icon}.
|
|
18935
|
-
*/
|
|
18936
|
-
setIcon(
|
|
18937
|
-
/**
|
|
18938
|
-
* The icon to set
|
|
18939
|
-
*/
|
|
18940
|
-
oIcon: sap.ui.webc.main.IIcon
|
|
18941
|
-
): this;
|
|
18942
19285
|
/**
|
|
18943
19286
|
* Sets a new value for property {@link #getMaxlength maxlength}.
|
|
18944
19287
|
*
|
|
@@ -19040,8 +19383,8 @@ declare namespace sap {
|
|
|
19040
19383
|
/**
|
|
19041
19384
|
* Sets a new value for property {@link #getShowValueHelpIcon showValueHelpIcon}.
|
|
19042
19385
|
*
|
|
19043
|
-
* Determines whether a value help icon will be
|
|
19044
|
-
* `value-help-trigger` event.
|
|
19386
|
+
* Determines whether a value help icon will be visualized in the end of the input. Pressing the icon will
|
|
19387
|
+
* fire `value-help-trigger` event.
|
|
19045
19388
|
*
|
|
19046
19389
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
19047
19390
|
*
|
|
@@ -19335,13 +19678,13 @@ declare namespace sap {
|
|
|
19335
19678
|
* - Nesting two or more panels is not recommended.
|
|
19336
19679
|
* - Do not stack too many panels on one page.
|
|
19337
19680
|
*
|
|
19338
|
-
* Structure:
|
|
19339
|
-
* The
|
|
19340
|
-
*
|
|
19341
|
-
*
|
|
19681
|
+
* Structure: The panel's header area consists of a title bar with a header text or custom header.
|
|
19682
|
+
* The header is clickable and can be used to toggle between the expanded and collapsed state. It includes
|
|
19683
|
+
* an icon which rotates depending on the state.
|
|
19342
19684
|
* The custom header can be set through the `header` slot and it may contain arbitraray content, such as:
|
|
19343
19685
|
* title, buttons or any other HTML elements.
|
|
19344
|
-
*
|
|
19686
|
+
* The content area can contain an arbitrary set of controls.
|
|
19687
|
+
* **Note:** The custom header is not clickable out of the box, but in this case the icon is interactive
|
|
19345
19688
|
* and allows to show/hide the content area.
|
|
19346
19689
|
*
|
|
19347
19690
|
* Responsive Behavior:
|
|
@@ -20781,6 +21124,16 @@ declare namespace sap {
|
|
|
20781
21124
|
* Default value is `false`.
|
|
20782
21125
|
*/
|
|
20783
21126
|
getDisabled(): boolean;
|
|
21127
|
+
/**
|
|
21128
|
+
* Gets current value of property {@link #getDisplayValue displayValue}.
|
|
21129
|
+
*
|
|
21130
|
+
* Specifies the text value to be displayed in the bar.
|
|
21131
|
+
*
|
|
21132
|
+
* **Note:**
|
|
21133
|
+
* - If there is no value provided or the value is empty, the default percentage value is shown.
|
|
21134
|
+
* - If `hideValue` property is `true` both the `displayValue` and `value` property values are not shown.
|
|
21135
|
+
*/
|
|
21136
|
+
getDisplayValue(): string;
|
|
20784
21137
|
/**
|
|
20785
21138
|
* Gets current value of property {@link #getHideValue hideValue}.
|
|
20786
21139
|
*
|
|
@@ -20830,6 +21183,24 @@ declare namespace sap {
|
|
|
20830
21183
|
*/
|
|
20831
21184
|
bDisabled?: boolean
|
|
20832
21185
|
): this;
|
|
21186
|
+
/**
|
|
21187
|
+
* Sets a new value for property {@link #getDisplayValue displayValue}.
|
|
21188
|
+
*
|
|
21189
|
+
* Specifies the text value to be displayed in the bar.
|
|
21190
|
+
*
|
|
21191
|
+
* **Note:**
|
|
21192
|
+
* - If there is no value provided or the value is empty, the default percentage value is shown.
|
|
21193
|
+
* - If `hideValue` property is `true` both the `displayValue` and `value` property values are not shown.
|
|
21194
|
+
*
|
|
21195
|
+
*
|
|
21196
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
21197
|
+
*/
|
|
21198
|
+
setDisplayValue(
|
|
21199
|
+
/**
|
|
21200
|
+
* New value for property `displayValue`
|
|
21201
|
+
*/
|
|
21202
|
+
sDisplayValue: string
|
|
21203
|
+
): this;
|
|
20833
21204
|
/**
|
|
20834
21205
|
* Sets a new value for property {@link #getHideValue hideValue}.
|
|
20835
21206
|
*
|
|
@@ -21275,17 +21646,16 @@ declare namespace sap {
|
|
|
21275
21646
|
* @SINCE 1.92.0
|
|
21276
21647
|
* @EXPERIMENTAL (since 1.92.0)
|
|
21277
21648
|
*
|
|
21278
|
-
* Represents a numerical interval and two handles (grips) to select a sub-range within it.
|
|
21279
|
-
*
|
|
21280
|
-
* Overview: The purpose of the component to enable visual selection of sub-ranges within a given interval.
|
|
21649
|
+
* Overview: Represents a numerical interval and two handles (grips) to select a sub-range within it. The
|
|
21650
|
+
* purpose of the component to enable visual selection of sub-ranges within a given interval.
|
|
21281
21651
|
*
|
|
21282
21652
|
* Structure: The most important properties of the Range Slider are:
|
|
21283
|
-
* - min - The minimum value of the slider range
|
|
21284
|
-
* - max - The maximum value of the slider range
|
|
21285
|
-
* - value - The current value of the slider
|
|
21286
|
-
* - step - Determines the increments in which the slider will move
|
|
21287
|
-
* - showTooltip - Determines if a tooltip should be displayed above the handle
|
|
21288
|
-
* - showTickmarks - Displays a visual divider between the step values
|
|
21653
|
+
* - min - The minimum value of the slider range.
|
|
21654
|
+
* - max - The maximum value of the slider range.
|
|
21655
|
+
* - value - The current value of the slider.
|
|
21656
|
+
* - step - Determines the increments in which the slider will move.
|
|
21657
|
+
* - showTooltip - Determines if a tooltip should be displayed above the handle.
|
|
21658
|
+
* - showTickmarks - Displays a visual divider between the step values.
|
|
21289
21659
|
* - labelInterval - Labels some or all of the tickmarks with their values. Notes::
|
|
21290
21660
|
* - The right and left handle can be moved individually and their positions could therefore switch.
|
|
21291
21661
|
* - The entire range can be moved along the interval. Usage: The most common use case is to select
|
|
@@ -21303,13 +21673,13 @@ declare namespace sap {
|
|
|
21303
21673
|
* step equal to 1/10th of the entire range;
|
|
21304
21674
|
* - `Right or Up Arrow + Ctrl/Cmd` - Moves a component's handle to the right or the entire range with
|
|
21305
21675
|
* step equal to 1/10th of the entire range;
|
|
21306
|
-
* - `Plus` - Same as `Right or Up Arrow
|
|
21307
|
-
* - `Minus` - Same as `Left or Down Arrow
|
|
21676
|
+
* - `Plus` - Same as `Right or Up Arrow`;
|
|
21677
|
+
* - `Minus` - Same as `Left or Down Arrow`;
|
|
21308
21678
|
* - `Home` - Moves the entire selection or the selected handle to the beginning of the component's range;
|
|
21309
21679
|
*
|
|
21310
21680
|
* - `End` - Moves the entire selection or the selected handle to the end of the component's range;
|
|
21311
|
-
* - `Page Up` - Same as `Right or Up Arrow + Ctrl/Cmd
|
|
21312
|
-
* - `Page Down` - Same as `Left or Down Arrow + Ctrl/Cmd
|
|
21681
|
+
* - `Page Up` - Same as `Right or Up Arrow + Ctrl/Cmd`;
|
|
21682
|
+
* - `Page Down` - Same as `Left or Down Arrow + Ctrl/Cmd`;
|
|
21313
21683
|
* - `Escape` - Resets the `startValue` and `endValue` properties to the values prior the component focusing;
|
|
21314
21684
|
*/
|
|
21315
21685
|
class RangeSlider extends sap.ui.webc.common.WebComponent {
|
|
@@ -21532,7 +21902,7 @@ declare namespace sap {
|
|
|
21532
21902
|
/**
|
|
21533
21903
|
* Gets current value of property {@link #getMax max}.
|
|
21534
21904
|
*
|
|
21535
|
-
* Defines the maximum value of the slider
|
|
21905
|
+
* Defines the maximum value of the slider.
|
|
21536
21906
|
*
|
|
21537
21907
|
* Default value is `100`.
|
|
21538
21908
|
*/
|
|
@@ -21540,7 +21910,7 @@ declare namespace sap {
|
|
|
21540
21910
|
/**
|
|
21541
21911
|
* Gets current value of property {@link #getMin min}.
|
|
21542
21912
|
*
|
|
21543
|
-
* Defines the minimum value of the slider
|
|
21913
|
+
* Defines the minimum value of the slider.
|
|
21544
21914
|
*
|
|
21545
21915
|
* Default value is `0`.
|
|
21546
21916
|
*/
|
|
@@ -21548,7 +21918,7 @@ declare namespace sap {
|
|
|
21548
21918
|
/**
|
|
21549
21919
|
* Gets current value of property {@link #getShowTickmarks showTickmarks}.
|
|
21550
21920
|
*
|
|
21551
|
-
* Enables
|
|
21921
|
+
* Enables tickmarks visualization for each step.
|
|
21552
21922
|
*
|
|
21553
21923
|
* **Note:** The step must be a positive number.
|
|
21554
21924
|
*
|
|
@@ -21645,7 +22015,7 @@ declare namespace sap {
|
|
|
21645
22015
|
/**
|
|
21646
22016
|
* Sets a new value for property {@link #getMax max}.
|
|
21647
22017
|
*
|
|
21648
|
-
* Defines the maximum value of the slider
|
|
22018
|
+
* Defines the maximum value of the slider.
|
|
21649
22019
|
*
|
|
21650
22020
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
21651
22021
|
*
|
|
@@ -21660,7 +22030,7 @@ declare namespace sap {
|
|
|
21660
22030
|
/**
|
|
21661
22031
|
* Sets a new value for property {@link #getMin min}.
|
|
21662
22032
|
*
|
|
21663
|
-
* Defines the minimum value of the slider
|
|
22033
|
+
* Defines the minimum value of the slider.
|
|
21664
22034
|
*
|
|
21665
22035
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
21666
22036
|
*
|
|
@@ -21675,7 +22045,7 @@ declare namespace sap {
|
|
|
21675
22045
|
/**
|
|
21676
22046
|
* Sets a new value for property {@link #getShowTickmarks showTickmarks}.
|
|
21677
22047
|
*
|
|
21678
|
-
* Enables
|
|
22048
|
+
* Enables tickmarks visualization for each step.
|
|
21679
22049
|
*
|
|
21680
22050
|
* **Note:** The step must be a positive number.
|
|
21681
22051
|
*
|
|
@@ -21758,7 +22128,7 @@ declare namespace sap {
|
|
|
21758
22128
|
* @SINCE 1.92.0
|
|
21759
22129
|
* @EXPERIMENTAL (since 1.92.0)
|
|
21760
22130
|
*
|
|
21761
|
-
* Overview: The
|
|
22131
|
+
* Overview: The Rating Indicator is used to display a specific number of icons that are used to rate an
|
|
21762
22132
|
* item. Additionally, it is also used to display the average and overall ratings.
|
|
21763
22133
|
*
|
|
21764
22134
|
* Usage: The recommended number of icons is between 5 and 7.
|
|
@@ -21910,7 +22280,7 @@ declare namespace sap {
|
|
|
21910
22280
|
/**
|
|
21911
22281
|
* Gets current value of property {@link #getMax max}.
|
|
21912
22282
|
*
|
|
21913
|
-
* The number of displayed rating symbols
|
|
22283
|
+
* The number of displayed rating symbols.
|
|
21914
22284
|
*
|
|
21915
22285
|
* Default value is `5`.
|
|
21916
22286
|
*/
|
|
@@ -21928,7 +22298,7 @@ declare namespace sap {
|
|
|
21928
22298
|
/**
|
|
21929
22299
|
* Gets current value of property {@link #getValue value}.
|
|
21930
22300
|
*
|
|
21931
|
-
* The indicated value of the rating
|
|
22301
|
+
* The indicated value of the rating.
|
|
21932
22302
|
*
|
|
21933
22303
|
* **Note:** If you set a number which is not round, it would be shown as follows:
|
|
21934
22304
|
* - 1.0 - 1.2 -> 1
|
|
@@ -21973,7 +22343,7 @@ declare namespace sap {
|
|
|
21973
22343
|
/**
|
|
21974
22344
|
* Sets a new value for property {@link #getMax max}.
|
|
21975
22345
|
*
|
|
21976
|
-
* The number of displayed rating symbols
|
|
22346
|
+
* The number of displayed rating symbols.
|
|
21977
22347
|
*
|
|
21978
22348
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
21979
22349
|
*
|
|
@@ -22005,7 +22375,7 @@ declare namespace sap {
|
|
|
22005
22375
|
/**
|
|
22006
22376
|
* Sets a new value for property {@link #getValue value}.
|
|
22007
22377
|
*
|
|
22008
|
-
* The indicated value of the rating
|
|
22378
|
+
* The indicated value of the rating.
|
|
22009
22379
|
*
|
|
22010
22380
|
* **Note:** If you set a number which is not round, it would be shown as follows:
|
|
22011
22381
|
* - 1.0 - 1.2 -> 1
|
|
@@ -23081,8 +23451,8 @@ declare namespace sap {
|
|
|
23081
23451
|
): sap.ui.webc.main.ISegmentedButtonItem;
|
|
23082
23452
|
}
|
|
23083
23453
|
/**
|
|
23084
|
-
* @SINCE 1.
|
|
23085
|
-
* @EXPERIMENTAL (since 1.
|
|
23454
|
+
* @SINCE 1.95.0
|
|
23455
|
+
* @EXPERIMENTAL (since 1.95.0)
|
|
23086
23456
|
*
|
|
23087
23457
|
* Overview:
|
|
23088
23458
|
*
|
|
@@ -23241,8 +23611,8 @@ declare namespace sap {
|
|
|
23241
23611
|
/**
|
|
23242
23612
|
* Gets current value of property {@link #getDisabled disabled}.
|
|
23243
23613
|
*
|
|
23244
|
-
* Defines whether the component is disabled
|
|
23245
|
-
*
|
|
23614
|
+
* Defines whether the component is disabled. A disabled component can't be pressed or focused, and it is
|
|
23615
|
+
* not in the tab chain.
|
|
23246
23616
|
*
|
|
23247
23617
|
* Default value is `false`.
|
|
23248
23618
|
*/
|
|
@@ -23323,8 +23693,8 @@ declare namespace sap {
|
|
|
23323
23693
|
/**
|
|
23324
23694
|
* Sets a new value for property {@link #getDisabled disabled}.
|
|
23325
23695
|
*
|
|
23326
|
-
* Defines whether the component is disabled
|
|
23327
|
-
*
|
|
23696
|
+
* Defines whether the component is disabled. A disabled component can't be pressed or focused, and it is
|
|
23697
|
+
* not in the tab chain.
|
|
23328
23698
|
*
|
|
23329
23699
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
23330
23700
|
*
|
|
@@ -23435,13 +23805,6 @@ declare namespace sap {
|
|
|
23435
23805
|
* - [ESC] - Closes the drop-down without changing the selection.
|
|
23436
23806
|
* - [HOME] - Navigates to first option
|
|
23437
23807
|
* - [END] - Navigates to the last option
|
|
23438
|
-
*
|
|
23439
|
-
*
|
|
23440
|
-
* Stable DOM Refs:
|
|
23441
|
-
*
|
|
23442
|
-
* In the context of `sap.ui.webc.main.Select`, you can provide a custom stable DOM ref for:
|
|
23443
|
-
* - Every `sap.ui.webc.main.Option` that you provide. Example: `
|
|
23444
|
-
* `
|
|
23445
23808
|
*/
|
|
23446
23809
|
class Select extends sap.ui.webc.common.WebComponent {
|
|
23447
23810
|
/**
|
|
@@ -23848,33 +24211,33 @@ declare namespace sap {
|
|
|
23848
24211
|
* is to enable visual selection of a value in a continuous numerical range by moving an adjustable handle.
|
|
23849
24212
|
*
|
|
23850
24213
|
* Structure: The most important properties of the Slider are:
|
|
23851
|
-
* - min - The minimum value of the slider range
|
|
23852
|
-
* - max - The maximum value of the slider range
|
|
23853
|
-
* - value - The current value of the slider
|
|
23854
|
-
* - step - Determines the increments in which the slider will move
|
|
23855
|
-
* - showTooltip - Determines if a tooltip should be displayed above the handle
|
|
23856
|
-
* - showTickmarks - Displays a visual divider between the step values
|
|
24214
|
+
* - min - The minimum value of the slider range.
|
|
24215
|
+
* - max - The maximum value of the slider range.
|
|
24216
|
+
* - value - The current value of the slider range.
|
|
24217
|
+
* - step - Determines the increments in which the slider will move.
|
|
24218
|
+
* - showTooltip - Determines if a tooltip should be displayed above the handle.
|
|
24219
|
+
* - showTickmarks - Displays a visual divider between the step values.
|
|
23857
24220
|
* - labelInterval - Labels some or all of the tickmarks with their values.
|
|
23858
24221
|
*
|
|
23859
|
-
* Usage: The most common
|
|
24222
|
+
* Usage: The most common use case is to select values on a continuous numerical scale (e.g. temperature,
|
|
23860
24223
|
* volume, etc. ).
|
|
23861
24224
|
*
|
|
23862
24225
|
* Responsive Behavior: The `sap.ui.webc.main.Slider` component adjusts to the size of its parent container
|
|
23863
24226
|
* by recalculating and resizing the width of the control. You can move the slider handle in several different
|
|
23864
24227
|
* ways:
|
|
23865
|
-
* - Drag and drop to the desired value
|
|
23866
|
-
* - Click/tap on the range bar to move the handle to that location
|
|
24228
|
+
* - Drag and drop the handle to the desired value.
|
|
24229
|
+
* - Click/tap on the range bar to move the handle to that location.
|
|
23867
24230
|
*
|
|
23868
24231
|
* CSS Shadow Parts:
|
|
23869
24232
|
*
|
|
23870
24233
|
* CSS Shadow Parts
|
|
23871
24234
|
* allow developers to style elements inside the Shadow DOM.
|
|
23872
24235
|
* The `sap.ui.webc.main.Slider` exposes the following CSS Shadow Parts:
|
|
23873
|
-
* - progress-container - Used to style the progress container(the
|
|
23874
|
-
*
|
|
23875
|
-
* - progress-bar - Used to style the progress bar, which shows the progress of the `sap.ui.webc.main.Slider
|
|
24236
|
+
* - progress-container - Used to style the progress container(the horizontal bar which visually represents
|
|
24237
|
+
* the range between the minimum and maximum value) of the `sap.ui.webc.main.Slider`.
|
|
24238
|
+
* - progress-bar - Used to style the progress bar, which shows the progress of the `sap.ui.webc.main.Slider`.
|
|
23876
24239
|
*
|
|
23877
|
-
* - handle - Used to style the handle of the `sap.ui.webc.main.Slider
|
|
24240
|
+
* - handle - Used to style the handle of the `sap.ui.webc.main.Slider`.
|
|
23878
24241
|
*
|
|
23879
24242
|
* Keyboard Handling:
|
|
23880
24243
|
*
|
|
@@ -23887,12 +24250,12 @@ declare namespace sap {
|
|
|
23887
24250
|
* range, effectively decreasing the component's value by 1/10th of the range;
|
|
23888
24251
|
* - `Right or Up Arrow + Ctrl/Cmd` - Moves the handle to the right with step equal to 1/10th of the entire
|
|
23889
24252
|
* range, effectively increasing the component's value by 1/10th of the range;
|
|
23890
|
-
* - `Plus` - Same as `Right or Up Arrow
|
|
23891
|
-
* - `Minus` - Same as `Left or Down Arrow
|
|
24253
|
+
* - `Plus` - Same as `Right or Up Arrow`;
|
|
24254
|
+
* - `Minus` - Same as `Left or Down Arrow`;
|
|
23892
24255
|
* - `Home` - Moves the handle to the beginning of the range;
|
|
23893
24256
|
* - `End` - Moves the handle to the end of the range;
|
|
23894
|
-
* - `Page Up` - Same as `Right or Up + Ctrl/Cmd
|
|
23895
|
-
* - `Page Down` - Same as `Left or Down + Ctrl/Cmd
|
|
24257
|
+
* - `Page Up` - Same as `Right or Up + Ctrl/Cmd`;
|
|
24258
|
+
* - `Page Down` - Same as `Left or Down + Ctrl/Cmd`;
|
|
23896
24259
|
* - `Escape` - Resets the value property after interaction, to the position prior the component's focusing;
|
|
23897
24260
|
*/
|
|
23898
24261
|
class Slider extends sap.ui.webc.common.WebComponent {
|
|
@@ -24105,7 +24468,7 @@ declare namespace sap {
|
|
|
24105
24468
|
/**
|
|
24106
24469
|
* Gets current value of property {@link #getMax max}.
|
|
24107
24470
|
*
|
|
24108
|
-
* Defines the maximum value of the slider
|
|
24471
|
+
* Defines the maximum value of the slider.
|
|
24109
24472
|
*
|
|
24110
24473
|
* Default value is `100`.
|
|
24111
24474
|
*/
|
|
@@ -24113,7 +24476,7 @@ declare namespace sap {
|
|
|
24113
24476
|
/**
|
|
24114
24477
|
* Gets current value of property {@link #getMin min}.
|
|
24115
24478
|
*
|
|
24116
|
-
* Defines the minimum value of the slider
|
|
24479
|
+
* Defines the minimum value of the slider.
|
|
24117
24480
|
*
|
|
24118
24481
|
* Default value is `0`.
|
|
24119
24482
|
*/
|
|
@@ -24121,7 +24484,7 @@ declare namespace sap {
|
|
|
24121
24484
|
/**
|
|
24122
24485
|
* Gets current value of property {@link #getShowTickmarks showTickmarks}.
|
|
24123
24486
|
*
|
|
24124
|
-
* Enables
|
|
24487
|
+
* Enables tickmarks visualization for each step.
|
|
24125
24488
|
*
|
|
24126
24489
|
* **Note:** The step must be a positive number.
|
|
24127
24490
|
*
|
|
@@ -24193,7 +24556,7 @@ declare namespace sap {
|
|
|
24193
24556
|
/**
|
|
24194
24557
|
* Sets a new value for property {@link #getMax max}.
|
|
24195
24558
|
*
|
|
24196
|
-
* Defines the maximum value of the slider
|
|
24559
|
+
* Defines the maximum value of the slider.
|
|
24197
24560
|
*
|
|
24198
24561
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
24199
24562
|
*
|
|
@@ -24208,7 +24571,7 @@ declare namespace sap {
|
|
|
24208
24571
|
/**
|
|
24209
24572
|
* Sets a new value for property {@link #getMin min}.
|
|
24210
24573
|
*
|
|
24211
|
-
* Defines the minimum value of the slider
|
|
24574
|
+
* Defines the minimum value of the slider.
|
|
24212
24575
|
*
|
|
24213
24576
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
24214
24577
|
*
|
|
@@ -24223,7 +24586,7 @@ declare namespace sap {
|
|
|
24223
24586
|
/**
|
|
24224
24587
|
* Sets a new value for property {@link #getShowTickmarks showTickmarks}.
|
|
24225
24588
|
*
|
|
24226
|
-
* Enables
|
|
24589
|
+
* Enables tickmarks visualization for each step.
|
|
24227
24590
|
*
|
|
24228
24591
|
* **Note:** The step must be a positive number.
|
|
24229
24592
|
*
|
|
@@ -25181,8 +25544,8 @@ declare namespace sap {
|
|
|
25181
25544
|
): this;
|
|
25182
25545
|
}
|
|
25183
25546
|
/**
|
|
25184
|
-
* @SINCE 1.
|
|
25185
|
-
* @EXPERIMENTAL (since 1.
|
|
25547
|
+
* @SINCE 1.95.0
|
|
25548
|
+
* @EXPERIMENTAL (since 1.95.0)
|
|
25186
25549
|
*
|
|
25187
25550
|
* The `sap.ui.webc.main.SuggestionGroupItem` is type of suggestion item, that can be used to split the
|
|
25188
25551
|
* `sap.ui.webc.main.Input` suggestions into groups.
|
|
@@ -25348,7 +25711,7 @@ declare namespace sap {
|
|
|
25348
25711
|
*
|
|
25349
25712
|
* Defines the state of the `additionalText`.
|
|
25350
25713
|
*
|
|
25351
|
-
* Available options are: `"None"` (by default), `"Success"`, `"Warning"` and `"Erorr"`.
|
|
25714
|
+
* Available options are: `"None"` (by default), `"Success"`, `"Information"`, `"Warning"` and `"Erorr"`.
|
|
25352
25715
|
*
|
|
25353
25716
|
* Default value is `None`.
|
|
25354
25717
|
*/
|
|
@@ -25424,7 +25787,7 @@ declare namespace sap {
|
|
|
25424
25787
|
*
|
|
25425
25788
|
* Defines the state of the `additionalText`.
|
|
25426
25789
|
*
|
|
25427
|
-
* Available options are: `"None"` (by default), `"Success"`, `"Warning"` and `"Erorr"`.
|
|
25790
|
+
* Available options are: `"None"` (by default), `"Success"`, `"Information"`, `"Warning"` and `"Erorr"`.
|
|
25428
25791
|
*
|
|
25429
25792
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
25430
25793
|
*
|
|
@@ -25551,8 +25914,8 @@ declare namespace sap {
|
|
|
25551
25914
|
* allow developers to style elements inside the Shadow DOM.
|
|
25552
25915
|
* The `sap.ui.webc.main.Switch` exposes the following CSS Shadow Parts:
|
|
25553
25916
|
* - slider - Used to style the track, where the handle is being slid
|
|
25554
|
-
* - text-on - Used to style the
|
|
25555
|
-
* - text-off - Used to style the
|
|
25917
|
+
* - text-on - Used to style the `textOn` property text
|
|
25918
|
+
* - text-off - Used to style the `textOff` property text
|
|
25556
25919
|
* - handle - Used to style the handle of the switch
|
|
25557
25920
|
*/
|
|
25558
25921
|
class Switch extends sap.ui.webc.common.WebComponent {
|
|
@@ -25713,7 +26076,8 @@ declare namespace sap {
|
|
|
25713
26076
|
*
|
|
25714
26077
|
* Defines the text, displayed when the component is not checked.
|
|
25715
26078
|
*
|
|
25716
|
-
* **Note:** We recommend using short texts, up to 3 letters (larger texts would be cut off).
|
|
26079
|
+
* **Note:** We recommend using short texts, up to 3 letters (larger texts would be cut off). **Note:**
|
|
26080
|
+
* This property will have no effect if the theme is set to `sap_horizon`.
|
|
25717
26081
|
*
|
|
25718
26082
|
* Default value is `empty string`.
|
|
25719
26083
|
*/
|
|
@@ -25725,7 +26089,8 @@ declare namespace sap {
|
|
|
25725
26089
|
*
|
|
25726
26090
|
*
|
|
25727
26091
|
*
|
|
25728
|
-
* **Note:** We recommend using short texts, up to 3 letters (larger texts would be cut off).
|
|
26092
|
+
* **Note:** We recommend using short texts, up to 3 letters (larger texts would be cut off). **Note:**
|
|
26093
|
+
* This property will have no effect if the theme is set to `sap_horizon`.
|
|
25729
26094
|
*
|
|
25730
26095
|
* Default value is `empty string`.
|
|
25731
26096
|
*/
|
|
@@ -25787,7 +26152,8 @@ declare namespace sap {
|
|
|
25787
26152
|
*
|
|
25788
26153
|
* Defines the text, displayed when the component is not checked.
|
|
25789
26154
|
*
|
|
25790
|
-
* **Note:** We recommend using short texts, up to 3 letters (larger texts would be cut off).
|
|
26155
|
+
* **Note:** We recommend using short texts, up to 3 letters (larger texts would be cut off). **Note:**
|
|
26156
|
+
* This property will have no effect if the theme is set to `sap_horizon`.
|
|
25791
26157
|
*
|
|
25792
26158
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
25793
26159
|
*
|
|
@@ -25806,7 +26172,8 @@ declare namespace sap {
|
|
|
25806
26172
|
*
|
|
25807
26173
|
*
|
|
25808
26174
|
*
|
|
25809
|
-
* **Note:** We recommend using short texts, up to 3 letters (larger texts would be cut off).
|
|
26175
|
+
* **Note:** We recommend using short texts, up to 3 letters (larger texts would be cut off). **Note:**
|
|
26176
|
+
* This property will have no effect if the theme is set to `sap_horizon`.
|
|
25810
26177
|
*
|
|
25811
26178
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
25812
26179
|
*
|
|
@@ -25960,6 +26327,11 @@ declare namespace sap {
|
|
|
25960
26327
|
* Default value is `false`.
|
|
25961
26328
|
*/
|
|
25962
26329
|
getSelected(): boolean;
|
|
26330
|
+
/**
|
|
26331
|
+
* Returns the DOM reference of the tab that is placed in the header. **Note:** If you need a DOM ref to
|
|
26332
|
+
* the tab content please use the `getDomRef` method.
|
|
26333
|
+
*/
|
|
26334
|
+
getTabInStripDomRef(): void;
|
|
25963
26335
|
/**
|
|
25964
26336
|
* Gets current value of property {@link #getText text}.
|
|
25965
26337
|
*
|
|
@@ -26128,12 +26500,6 @@ declare namespace sap {
|
|
|
26128
26500
|
* The `sap.ui.webc.main.TabContainer` can hold two types of entities:
|
|
26129
26501
|
* - `sap.ui.webc.main.Tab` - contains all the information on an item (text and icon)
|
|
26130
26502
|
* - `sap.ui.webc.main.TabSeparator` - used to separate tabs with a vertical line
|
|
26131
|
-
*
|
|
26132
|
-
* Stable DOM Refs:
|
|
26133
|
-
*
|
|
26134
|
-
* In the context of `sap.ui.webc.main.TabContainer`, you can provide a custom stable DOM refs for:
|
|
26135
|
-
*
|
|
26136
|
-
* - Each `sap.ui.webc.main.Tab` Example: ` `
|
|
26137
26503
|
*/
|
|
26138
26504
|
class TabContainer extends sap.ui.webc.common.WebComponent {
|
|
26139
26505
|
/**
|
|
@@ -26953,7 +27319,7 @@ declare namespace sap {
|
|
|
26953
27319
|
*
|
|
26954
27320
|
*
|
|
26955
27321
|
*
|
|
26956
|
-
* **
|
|
27322
|
+
* **Restrictions:** `growing="Scroll"` is not supported for Internet Explorer, and the component will fallback
|
|
26957
27323
|
* to `growing="Button"`.
|
|
26958
27324
|
*
|
|
26959
27325
|
* Default value is `None`.
|
|
@@ -27034,7 +27400,7 @@ declare namespace sap {
|
|
|
27034
27400
|
* Determines whether the column headers remain fixed at the top of the page during vertical scrolling as
|
|
27035
27401
|
* long as the Web Component is in the viewport.
|
|
27036
27402
|
*
|
|
27037
|
-
* **
|
|
27403
|
+
* **Restrictions:**
|
|
27038
27404
|
* - Browsers that do not support this feature:
|
|
27039
27405
|
* Internet Explorer
|
|
27040
27406
|
* - Microsoft Edge lower than version 41 (EdgeHTML 16)
|
|
@@ -27183,7 +27549,7 @@ declare namespace sap {
|
|
|
27183
27549
|
*
|
|
27184
27550
|
*
|
|
27185
27551
|
*
|
|
27186
|
-
* **
|
|
27552
|
+
* **Restrictions:** `growing="Scroll"` is not supported for Internet Explorer, and the component will fallback
|
|
27187
27553
|
* to `growing="Button"`.
|
|
27188
27554
|
*
|
|
27189
27555
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
@@ -27305,7 +27671,7 @@ declare namespace sap {
|
|
|
27305
27671
|
* Determines whether the column headers remain fixed at the top of the page during vertical scrolling as
|
|
27306
27672
|
* long as the Web Component is in the viewport.
|
|
27307
27673
|
*
|
|
27308
|
-
* **
|
|
27674
|
+
* **Restrictions:**
|
|
27309
27675
|
* - Browsers that do not support this feature:
|
|
27310
27676
|
* Internet Explorer
|
|
27311
27677
|
* - Microsoft Edge lower than version 41 (EdgeHTML 16)
|
|
@@ -27695,8 +28061,8 @@ declare namespace sap {
|
|
|
27695
28061
|
): this;
|
|
27696
28062
|
}
|
|
27697
28063
|
/**
|
|
27698
|
-
* @SINCE 1.
|
|
27699
|
-
* @EXPERIMENTAL (since 1.
|
|
28064
|
+
* @SINCE 1.95.0
|
|
28065
|
+
* @EXPERIMENTAL (since 1.95.0)
|
|
27700
28066
|
*
|
|
27701
28067
|
* Overview:
|
|
27702
28068
|
*
|
|
@@ -27707,7 +28073,7 @@ declare namespace sap {
|
|
|
27707
28073
|
* CSS Shadow Parts
|
|
27708
28074
|
* allow developers to style elements inside the Shadow DOM.
|
|
27709
28075
|
* The `sap.ui.webc.main.TableGroupRow` exposes the following CSS Shadow Parts:
|
|
27710
|
-
* - group-row - Used to style the native `tr`
|
|
28076
|
+
* - group-row - Used to style the native `tr` element.
|
|
27711
28077
|
*/
|
|
27712
28078
|
class TableGroupRow
|
|
27713
28079
|
extends sap.ui.webc.common.WebComponent
|
|
@@ -28070,9 +28436,7 @@ declare namespace sap {
|
|
|
28070
28436
|
*
|
|
28071
28437
|
* Overview:
|
|
28072
28438
|
*
|
|
28073
|
-
* The `sap.ui.webc.main.TextArea` component
|
|
28074
|
-
* rows. It has the functionality of the `TextField` with the additional functionality for multiline texts.
|
|
28075
|
-
*
|
|
28439
|
+
* The `sap.ui.webc.main.TextArea` component is used to enter multiple lines of text.
|
|
28076
28440
|
*
|
|
28077
28441
|
* When empty, it can hold a placeholder similar to a `sap.ui.webc.main.Input`. You can define the rows
|
|
28078
28442
|
* of the `sap.ui.webc.main.TextArea` and also determine specific behavior when handling long texts.
|
|
@@ -28290,7 +28654,7 @@ declare namespace sap {
|
|
|
28290
28654
|
*
|
|
28291
28655
|
* Indicates whether the user can interact with the component or not.
|
|
28292
28656
|
*
|
|
28293
|
-
* **Note:**
|
|
28657
|
+
* **Note:** A disabled component is completely noninteractive.
|
|
28294
28658
|
*
|
|
28295
28659
|
* Default value is `false`.
|
|
28296
28660
|
*/
|
|
@@ -28308,7 +28672,7 @@ declare namespace sap {
|
|
|
28308
28672
|
/**
|
|
28309
28673
|
* Gets current value of property {@link #getGrowingMaxLines growingMaxLines}.
|
|
28310
28674
|
*
|
|
28311
|
-
* Defines the maximum number of lines that the
|
|
28675
|
+
* Defines the maximum number of lines that the component can grow.
|
|
28312
28676
|
*
|
|
28313
28677
|
* Default value is `0`.
|
|
28314
28678
|
*/
|
|
@@ -28393,7 +28757,7 @@ declare namespace sap {
|
|
|
28393
28757
|
/**
|
|
28394
28758
|
* Gets current value of property {@link #getValue value}.
|
|
28395
28759
|
*
|
|
28396
|
-
* Defines the value of the
|
|
28760
|
+
* Defines the value of the component.
|
|
28397
28761
|
*
|
|
28398
28762
|
* Default value is `empty string`.
|
|
28399
28763
|
*/
|
|
@@ -28467,7 +28831,7 @@ declare namespace sap {
|
|
|
28467
28831
|
*
|
|
28468
28832
|
* Indicates whether the user can interact with the component or not.
|
|
28469
28833
|
*
|
|
28470
|
-
* **Note:**
|
|
28834
|
+
* **Note:** A disabled component is completely noninteractive.
|
|
28471
28835
|
*
|
|
28472
28836
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
28473
28837
|
*
|
|
@@ -28499,7 +28863,7 @@ declare namespace sap {
|
|
|
28499
28863
|
/**
|
|
28500
28864
|
* Sets a new value for property {@link #getGrowingMaxLines growingMaxLines}.
|
|
28501
28865
|
*
|
|
28502
|
-
* Defines the maximum number of lines that the
|
|
28866
|
+
* Defines the maximum number of lines that the component can grow.
|
|
28503
28867
|
*
|
|
28504
28868
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
28505
28869
|
*
|
|
@@ -28647,7 +29011,7 @@ declare namespace sap {
|
|
|
28647
29011
|
/**
|
|
28648
29012
|
* Sets a new value for property {@link #getValue value}.
|
|
28649
29013
|
*
|
|
28650
|
-
* Defines the value of the
|
|
29014
|
+
* Defines the value of the component.
|
|
28651
29015
|
*
|
|
28652
29016
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
28653
29017
|
*
|
|
@@ -28722,11 +29086,11 @@ declare namespace sap {
|
|
|
28722
29086
|
* @EXPERIMENTAL (since 1.92.0)
|
|
28723
29087
|
*
|
|
28724
29088
|
* Overview: The `sap.ui.webc.main.TimePicker` component provides an input field with assigned sliders which
|
|
28725
|
-
*
|
|
28726
|
-
* touch, mouse, or keyboard input. It consists of two parts: the time input field and the sliders.
|
|
29089
|
+
* are opened on user action. The `sap.ui.webc.main.TimePicker` allows users to select a localized time
|
|
29090
|
+
* using touch, mouse, or keyboard input. It consists of two parts: the time input field and the sliders.
|
|
28727
29091
|
*
|
|
28728
29092
|
* Usage: The user can enter a time by:
|
|
28729
|
-
* - Using the sliders that
|
|
29093
|
+
* - Using the sliders that are displayed in a popup
|
|
28730
29094
|
* - Typing it in directly in the input field
|
|
28731
29095
|
*
|
|
28732
29096
|
* When the user makes an entry and chooses the enter key, the sliders shows the corresponding time. When
|
|
@@ -29747,7 +30111,7 @@ declare namespace sap {
|
|
|
29747
30111
|
*
|
|
29748
30112
|
*
|
|
29749
30113
|
*
|
|
29750
|
-
* **
|
|
30114
|
+
* **The available values are:**
|
|
29751
30115
|
*
|
|
29752
30116
|
*
|
|
29753
30117
|
* - `Default`
|
|
@@ -29763,8 +30127,8 @@ declare namespace sap {
|
|
|
29763
30127
|
/**
|
|
29764
30128
|
* Gets current value of property {@link #getDisabled disabled}.
|
|
29765
30129
|
*
|
|
29766
|
-
* Defines whether the component is disabled
|
|
29767
|
-
*
|
|
30130
|
+
* Defines whether the component is disabled. A disabled component can't be pressed or focused, and it is
|
|
30131
|
+
* not in the tab chain.
|
|
29768
30132
|
*
|
|
29769
30133
|
* Default value is `false`.
|
|
29770
30134
|
*/
|
|
@@ -29838,7 +30202,7 @@ declare namespace sap {
|
|
|
29838
30202
|
*
|
|
29839
30203
|
*
|
|
29840
30204
|
*
|
|
29841
|
-
* **
|
|
30205
|
+
* **The available values are:**
|
|
29842
30206
|
*
|
|
29843
30207
|
*
|
|
29844
30208
|
* - `Default`
|
|
@@ -29861,8 +30225,8 @@ declare namespace sap {
|
|
|
29861
30225
|
/**
|
|
29862
30226
|
* Sets a new value for property {@link #getDisabled disabled}.
|
|
29863
30227
|
*
|
|
29864
|
-
* Defines whether the component is disabled
|
|
29865
|
-
*
|
|
30228
|
+
* Defines whether the component is disabled. A disabled component can't be pressed or focused, and it is
|
|
30229
|
+
* not in the tab chain.
|
|
29866
30230
|
*
|
|
29867
30231
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
29868
30232
|
*
|
|
@@ -30108,7 +30472,7 @@ declare namespace sap {
|
|
|
30108
30472
|
* Gets content of aggregation {@link #getCloseIcon closeIcon}.
|
|
30109
30473
|
*
|
|
30110
30474
|
* Defines the close icon for the token. If nothing is provided to this slot, the default close icon will
|
|
30111
|
-
* be used. Accepts `sap.ui.webc.main.Icon
|
|
30475
|
+
* be used. Accepts `sap.ui.webc.main.Icon`.
|
|
30112
30476
|
*/
|
|
30113
30477
|
getCloseIcon(): sap.ui.webc.main.IIcon;
|
|
30114
30478
|
/**
|
|
@@ -30381,6 +30745,88 @@ declare namespace sap {
|
|
|
30381
30745
|
*/
|
|
30382
30746
|
oListener?: object
|
|
30383
30747
|
): this;
|
|
30748
|
+
/**
|
|
30749
|
+
* Attaches event handler `fnFunction` to the {@link #event:itemMouseout itemMouseout} event of this `sap.ui.webc.main.Tree`.
|
|
30750
|
+
*
|
|
30751
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
30752
|
+
* otherwise it will be bound to this `sap.ui.webc.main.Tree` itself.
|
|
30753
|
+
*
|
|
30754
|
+
* Fired when the mouse cursor leaves the tree item borders.
|
|
30755
|
+
*/
|
|
30756
|
+
attachItemMouseout(
|
|
30757
|
+
/**
|
|
30758
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
30759
|
+
* object when firing the event
|
|
30760
|
+
*/
|
|
30761
|
+
oData: object,
|
|
30762
|
+
/**
|
|
30763
|
+
* The function to be called when the event occurs
|
|
30764
|
+
*/
|
|
30765
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
30766
|
+
/**
|
|
30767
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.main.Tree` itself
|
|
30768
|
+
*/
|
|
30769
|
+
oListener?: object
|
|
30770
|
+
): this;
|
|
30771
|
+
/**
|
|
30772
|
+
* Attaches event handler `fnFunction` to the {@link #event:itemMouseout itemMouseout} event of this `sap.ui.webc.main.Tree`.
|
|
30773
|
+
*
|
|
30774
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
30775
|
+
* otherwise it will be bound to this `sap.ui.webc.main.Tree` itself.
|
|
30776
|
+
*
|
|
30777
|
+
* Fired when the mouse cursor leaves the tree item borders.
|
|
30778
|
+
*/
|
|
30779
|
+
attachItemMouseout(
|
|
30780
|
+
/**
|
|
30781
|
+
* The function to be called when the event occurs
|
|
30782
|
+
*/
|
|
30783
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
30784
|
+
/**
|
|
30785
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.main.Tree` itself
|
|
30786
|
+
*/
|
|
30787
|
+
oListener?: object
|
|
30788
|
+
): this;
|
|
30789
|
+
/**
|
|
30790
|
+
* Attaches event handler `fnFunction` to the {@link #event:itemMouseover itemMouseover} event of this `sap.ui.webc.main.Tree`.
|
|
30791
|
+
*
|
|
30792
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
30793
|
+
* otherwise it will be bound to this `sap.ui.webc.main.Tree` itself.
|
|
30794
|
+
*
|
|
30795
|
+
* Fired when the mouse cursor enters the tree item borders.
|
|
30796
|
+
*/
|
|
30797
|
+
attachItemMouseover(
|
|
30798
|
+
/**
|
|
30799
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
30800
|
+
* object when firing the event
|
|
30801
|
+
*/
|
|
30802
|
+
oData: object,
|
|
30803
|
+
/**
|
|
30804
|
+
* The function to be called when the event occurs
|
|
30805
|
+
*/
|
|
30806
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
30807
|
+
/**
|
|
30808
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.main.Tree` itself
|
|
30809
|
+
*/
|
|
30810
|
+
oListener?: object
|
|
30811
|
+
): this;
|
|
30812
|
+
/**
|
|
30813
|
+
* Attaches event handler `fnFunction` to the {@link #event:itemMouseover itemMouseover} event of this `sap.ui.webc.main.Tree`.
|
|
30814
|
+
*
|
|
30815
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
30816
|
+
* otherwise it will be bound to this `sap.ui.webc.main.Tree` itself.
|
|
30817
|
+
*
|
|
30818
|
+
* Fired when the mouse cursor enters the tree item borders.
|
|
30819
|
+
*/
|
|
30820
|
+
attachItemMouseover(
|
|
30821
|
+
/**
|
|
30822
|
+
* The function to be called when the event occurs
|
|
30823
|
+
*/
|
|
30824
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
30825
|
+
/**
|
|
30826
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.webc.main.Tree` itself
|
|
30827
|
+
*/
|
|
30828
|
+
oListener?: object
|
|
30829
|
+
): this;
|
|
30384
30830
|
/**
|
|
30385
30831
|
* Attaches event handler `fnFunction` to the {@link #event:itemToggle itemToggle} event of this `sap.ui.webc.main.Tree`.
|
|
30386
30832
|
*
|
|
@@ -30511,6 +30957,37 @@ declare namespace sap {
|
|
|
30511
30957
|
*/
|
|
30512
30958
|
oListener?: object
|
|
30513
30959
|
): this;
|
|
30960
|
+
/**
|
|
30961
|
+
* Detaches event handler `fnFunction` from the {@link #event:itemMouseout itemMouseout} event of this `sap.ui.webc.main.Tree`.
|
|
30962
|
+
*
|
|
30963
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
30964
|
+
*/
|
|
30965
|
+
detachItemMouseout(
|
|
30966
|
+
/**
|
|
30967
|
+
* The function to be called, when the event occurs
|
|
30968
|
+
*/
|
|
30969
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
30970
|
+
/**
|
|
30971
|
+
* Context object on which the given function had to be called
|
|
30972
|
+
*/
|
|
30973
|
+
oListener?: object
|
|
30974
|
+
): this;
|
|
30975
|
+
/**
|
|
30976
|
+
* Detaches event handler `fnFunction` from the {@link #event:itemMouseover itemMouseover} event of this
|
|
30977
|
+
* `sap.ui.webc.main.Tree`.
|
|
30978
|
+
*
|
|
30979
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
30980
|
+
*/
|
|
30981
|
+
detachItemMouseover(
|
|
30982
|
+
/**
|
|
30983
|
+
* The function to be called, when the event occurs
|
|
30984
|
+
*/
|
|
30985
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
30986
|
+
/**
|
|
30987
|
+
* Context object on which the given function had to be called
|
|
30988
|
+
*/
|
|
30989
|
+
oListener?: object
|
|
30990
|
+
): this;
|
|
30514
30991
|
/**
|
|
30515
30992
|
* Detaches event handler `fnFunction` from the {@link #event:itemToggle itemToggle} event of this `sap.ui.webc.main.Tree`.
|
|
30516
30993
|
*
|
|
@@ -30570,6 +31047,34 @@ declare namespace sap {
|
|
|
30570
31047
|
item?: HTMLElement;
|
|
30571
31048
|
}
|
|
30572
31049
|
): this;
|
|
31050
|
+
/**
|
|
31051
|
+
* Fires event {@link #event:itemMouseout itemMouseout} to attached listeners.
|
|
31052
|
+
*/
|
|
31053
|
+
fireItemMouseout(
|
|
31054
|
+
/**
|
|
31055
|
+
* Parameters to pass along with the event
|
|
31056
|
+
*/
|
|
31057
|
+
mParameters?: {
|
|
31058
|
+
/**
|
|
31059
|
+
* the hovered item.
|
|
31060
|
+
*/
|
|
31061
|
+
item?: HTMLElement;
|
|
31062
|
+
}
|
|
31063
|
+
): this;
|
|
31064
|
+
/**
|
|
31065
|
+
* Fires event {@link #event:itemMouseover itemMouseover} to attached listeners.
|
|
31066
|
+
*/
|
|
31067
|
+
fireItemMouseover(
|
|
31068
|
+
/**
|
|
31069
|
+
* Parameters to pass along with the event
|
|
31070
|
+
*/
|
|
31071
|
+
mParameters?: {
|
|
31072
|
+
/**
|
|
31073
|
+
* the hovered item.
|
|
31074
|
+
*/
|
|
31075
|
+
item?: HTMLElement;
|
|
31076
|
+
}
|
|
31077
|
+
): this;
|
|
30573
31078
|
/**
|
|
30574
31079
|
* Fires event {@link #event:itemToggle itemToggle} to attached listeners.
|
|
30575
31080
|
*
|
|
@@ -31270,8 +31775,8 @@ declare namespace sap {
|
|
|
31270
31775
|
XS = "XS",
|
|
31271
31776
|
}
|
|
31272
31777
|
/**
|
|
31273
|
-
* @SINCE 1.
|
|
31274
|
-
* @EXPERIMENTAL (since 1.
|
|
31778
|
+
* @SINCE 1.95.0
|
|
31779
|
+
* @EXPERIMENTAL (since 1.95.0)
|
|
31275
31780
|
*
|
|
31276
31781
|
* Different types of `Breadcrumbs`.
|
|
31277
31782
|
*/
|
|
@@ -31287,8 +31792,8 @@ declare namespace sap {
|
|
|
31287
31792
|
Standard = "Standard",
|
|
31288
31793
|
}
|
|
31289
31794
|
/**
|
|
31290
|
-
* @SINCE 1.
|
|
31291
|
-
* @EXPERIMENTAL (since 1.
|
|
31795
|
+
* @SINCE 1.95.0
|
|
31796
|
+
* @EXPERIMENTAL (since 1.95.0)
|
|
31292
31797
|
*
|
|
31293
31798
|
* Different types of `Breadcrumbs` separator.
|
|
31294
31799
|
*/
|
|
@@ -31933,6 +32438,8 @@ declare namespace sap {
|
|
|
31933
32438
|
|
|
31934
32439
|
"sap/ui/webc/main/ColorPaletteItem": undefined;
|
|
31935
32440
|
|
|
32441
|
+
"sap/ui/webc/main/ColorPalettePopover": undefined;
|
|
32442
|
+
|
|
31936
32443
|
"sap/ui/webc/main/ColorPicker": undefined;
|
|
31937
32444
|
|
|
31938
32445
|
"sap/ui/webc/main/ComboBox": undefined;
|