@openui5/ts-types 1.96.2 → 1.97.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/types/sap.f.d.ts +1 -1
- package/types/sap.m.d.ts +490 -45
- package/types/sap.tnt.d.ts +1 -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 +389 -165
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.fl.d.ts +1 -3
- package/types/sap.ui.integration.d.ts +42 -1
- package/types/sap.ui.layout.d.ts +1 -1
- package/types/sap.ui.mdc.d.ts +20 -10
- 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 +3 -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 +679 -59
- package/types/sap.ui.webc.main.d.ts +1026 -506
- package/types/sap.uxap.d.ts +1 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.
|
|
1
|
+
// For Library Version: 1.97.0
|
|
2
2
|
|
|
3
3
|
declare namespace sap {
|
|
4
4
|
namespace ui {
|
|
@@ -10,6 +10,26 @@ declare namespace sap {
|
|
|
10
10
|
* SAPUI5 library with controls based on UI5 Web Components
|
|
11
11
|
*/
|
|
12
12
|
namespace fiori {
|
|
13
|
+
/**
|
|
14
|
+
* @SINCE 1.97.0
|
|
15
|
+
* @EXPERIMENTAL (since 1.97.0)
|
|
16
|
+
*
|
|
17
|
+
* Interface for components that may be slotted inside `ui5-view-settings-dialog` as filter items
|
|
18
|
+
*/
|
|
19
|
+
interface IFilterItem {
|
|
20
|
+
__implements__sap_ui_webc_fiori_IFilterItem: boolean;
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
/**
|
|
24
|
+
* @SINCE 1.97.0
|
|
25
|
+
* @EXPERIMENTAL (since 1.97.0)
|
|
26
|
+
*
|
|
27
|
+
* Interface for components that may be slotted inside `ui5-filter-item` as values
|
|
28
|
+
*/
|
|
29
|
+
interface IFilterItemOption {
|
|
30
|
+
__implements__sap_ui_webc_fiori_IFilterItemOption: boolean;
|
|
31
|
+
}
|
|
32
|
+
|
|
13
33
|
/**
|
|
14
34
|
* @SINCE 1.92.0
|
|
15
35
|
* @EXPERIMENTAL (since 1.92.0)
|
|
@@ -70,6 +90,16 @@ declare namespace sap {
|
|
|
70
90
|
__implements__sap_ui_webc_fiori_ISideNavigationSubItem: boolean;
|
|
71
91
|
}
|
|
72
92
|
|
|
93
|
+
/**
|
|
94
|
+
* @SINCE 1.97.0
|
|
95
|
+
* @EXPERIMENTAL (since 1.97.0)
|
|
96
|
+
*
|
|
97
|
+
* Interface for components that may be slotted inside `ui5-view-settings-dialog` as sort items
|
|
98
|
+
*/
|
|
99
|
+
interface ISortItem {
|
|
100
|
+
__implements__sap_ui_webc_fiori_ISortItem: boolean;
|
|
101
|
+
}
|
|
102
|
+
|
|
73
103
|
/**
|
|
74
104
|
* @SINCE 1.92.0
|
|
75
105
|
* @EXPERIMENTAL (since 1.92.0)
|
|
@@ -162,10 +192,39 @@ declare namespace sap {
|
|
|
162
192
|
scanSuccess?: (oEvent: sap.ui.base.Event) => void;
|
|
163
193
|
}
|
|
164
194
|
|
|
195
|
+
interface $FilterItemSettings
|
|
196
|
+
extends sap.ui.webc.common.$WebComponentSettings {
|
|
197
|
+
/**
|
|
198
|
+
* Defines the text of the component.
|
|
199
|
+
*/
|
|
200
|
+
text?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
201
|
+
|
|
202
|
+
/**
|
|
203
|
+
* Defines the `values` list.
|
|
204
|
+
*/
|
|
205
|
+
values?:
|
|
206
|
+
| sap.ui.webc.fiori.IFilterItemOption[]
|
|
207
|
+
| sap.ui.webc.fiori.IFilterItemOption
|
|
208
|
+
| sap.ui.base.ManagedObject.AggregationBindingInfo;
|
|
209
|
+
}
|
|
210
|
+
|
|
211
|
+
interface $FilterItemOptionSettings
|
|
212
|
+
extends sap.ui.webc.common.$WebComponentSettings {
|
|
213
|
+
/**
|
|
214
|
+
* Defines whether the option is selected
|
|
215
|
+
*/
|
|
216
|
+
selected?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
217
|
+
|
|
218
|
+
/**
|
|
219
|
+
* Defines the text of the component.
|
|
220
|
+
*/
|
|
221
|
+
text?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
222
|
+
}
|
|
223
|
+
|
|
165
224
|
interface $FlexibleColumnLayoutSettings
|
|
166
225
|
extends sap.ui.webc.common.$WebComponentSettings {
|
|
167
226
|
/**
|
|
168
|
-
*
|
|
227
|
+
* An object of strings that defines several additional accessibility texts for even further customization.
|
|
169
228
|
*
|
|
170
229
|
* It supports the following fields: - `startColumnAccessibleName`: the accessibility name for the `startColumn`
|
|
171
230
|
* region - `midColumnAccessibleName`: the accessibility name for the `midColumn` region - `endColumnAccessibleName`:
|
|
@@ -898,6 +957,19 @@ declare namespace sap {
|
|
|
898
957
|
text?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
899
958
|
}
|
|
900
959
|
|
|
960
|
+
interface $SortItemSettings
|
|
961
|
+
extends sap.ui.webc.common.$WebComponentSettings {
|
|
962
|
+
/**
|
|
963
|
+
* Defines if the component is selected.
|
|
964
|
+
*/
|
|
965
|
+
selected?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
966
|
+
|
|
967
|
+
/**
|
|
968
|
+
* Defines the text of the component.
|
|
969
|
+
*/
|
|
970
|
+
text?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
971
|
+
}
|
|
972
|
+
|
|
901
973
|
interface $TimelineSettings
|
|
902
974
|
extends sap.ui.webc.common.$WebComponentSettings {
|
|
903
975
|
/**
|
|
@@ -988,6 +1060,13 @@ declare namespace sap {
|
|
|
988
1060
|
|
|
989
1061
|
interface $UploadCollectionSettings
|
|
990
1062
|
extends sap.ui.webc.common.$WebComponentSettings {
|
|
1063
|
+
/**
|
|
1064
|
+
* Sets the accessible aria name of the component.
|
|
1065
|
+
*/
|
|
1066
|
+
accessibleName?:
|
|
1067
|
+
| string
|
|
1068
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
1069
|
+
|
|
991
1070
|
/**
|
|
992
1071
|
* Defines the height of the control
|
|
993
1072
|
*/
|
|
@@ -1042,6 +1121,9 @@ declare namespace sap {
|
|
|
1042
1121
|
|
|
1043
1122
|
/**
|
|
1044
1123
|
* Defines the `sap.ui.webc.fiori.UploadCollection` header.
|
|
1124
|
+
*
|
|
1125
|
+
* **Note:** If `header` slot is provided, the labelling of the `UploadCollection` is a responsibility
|
|
1126
|
+
* of the application developer. `accessibleName` should be used.
|
|
1045
1127
|
*/
|
|
1046
1128
|
header?:
|
|
1047
1129
|
| sap.ui.core.Control[]
|
|
@@ -1189,12 +1271,14 @@ declare namespace sap {
|
|
|
1189
1271
|
| boolean
|
|
1190
1272
|
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
1191
1273
|
|
|
1192
|
-
|
|
1193
|
-
|
|
1194
|
-
|
|
1274
|
+
filterItems?:
|
|
1275
|
+
| sap.ui.webc.fiori.IFilterItem[]
|
|
1276
|
+
| sap.ui.webc.fiori.IFilterItem
|
|
1277
|
+
| sap.ui.base.ManagedObject.AggregationBindingInfo;
|
|
1278
|
+
|
|
1195
1279
|
sortItems?:
|
|
1196
|
-
| sap.ui.webc.
|
|
1197
|
-
| sap.ui.webc.
|
|
1280
|
+
| sap.ui.webc.fiori.ISortItem[]
|
|
1281
|
+
| sap.ui.webc.fiori.ISortItem
|
|
1198
1282
|
| sap.ui.base.ManagedObject.AggregationBindingInfo;
|
|
1199
1283
|
|
|
1200
1284
|
/**
|
|
@@ -1284,7 +1368,7 @@ declare namespace sap {
|
|
|
1284
1368
|
*
|
|
1285
1369
|
*
|
|
1286
1370
|
*
|
|
1287
|
-
* **Note:**
|
|
1371
|
+
* **Note:** The icon is displayed in the `sap.ui.webc.fiori.Wizard` navigation header.
|
|
1288
1372
|
*
|
|
1289
1373
|
*
|
|
1290
1374
|
*
|
|
@@ -1308,7 +1392,6 @@ declare namespace sap {
|
|
|
1308
1392
|
*
|
|
1309
1393
|
*
|
|
1310
1394
|
* **Note:** the text is displayed in the `sap.ui.webc.fiori.Wizard` navigation header.
|
|
1311
|
-
* **Note:** the text will hide on small sizes (about 559 px).
|
|
1312
1395
|
*/
|
|
1313
1396
|
subtitleText?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
1314
1397
|
|
|
@@ -1317,8 +1400,7 @@ declare namespace sap {
|
|
|
1317
1400
|
*
|
|
1318
1401
|
*
|
|
1319
1402
|
*
|
|
1320
|
-
* **Note:**
|
|
1321
|
-
* **Note:** the text will hide on small sizes (about 559 px).
|
|
1403
|
+
* **Note:** The text is displayed in the `sap.ui.webc.fiori.Wizard` navigation header.
|
|
1322
1404
|
*/
|
|
1323
1405
|
titleText?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
1324
1406
|
|
|
@@ -1649,8 +1731,8 @@ declare namespace sap {
|
|
|
1649
1731
|
): this;
|
|
1650
1732
|
}
|
|
1651
1733
|
/**
|
|
1652
|
-
* @SINCE 1.
|
|
1653
|
-
* @EXPERIMENTAL (since 1.
|
|
1734
|
+
* @SINCE 1.95.0
|
|
1735
|
+
* @EXPERIMENTAL (since 1.95.0)
|
|
1654
1736
|
*
|
|
1655
1737
|
* Overview:
|
|
1656
1738
|
*
|
|
@@ -1883,6 +1965,272 @@ declare namespace sap {
|
|
|
1883
1965
|
*/
|
|
1884
1966
|
show(): void;
|
|
1885
1967
|
}
|
|
1968
|
+
/**
|
|
1969
|
+
* @SINCE 1.97.0
|
|
1970
|
+
* @EXPERIMENTAL (since 1.97.0)
|
|
1971
|
+
*
|
|
1972
|
+
* Overview:
|
|
1973
|
+
*
|
|
1974
|
+
* Usage:
|
|
1975
|
+
*/
|
|
1976
|
+
class FilterItem
|
|
1977
|
+
extends sap.ui.webc.common.WebComponent
|
|
1978
|
+
implements sap.ui.webc.fiori.IFilterItem {
|
|
1979
|
+
__implements__sap_ui_webc_fiori_IFilterItem: boolean;
|
|
1980
|
+
/**
|
|
1981
|
+
* Constructor for a new `FilterItem`.
|
|
1982
|
+
*
|
|
1983
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1984
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
1985
|
+
* of the syntax of the settings object.
|
|
1986
|
+
*/
|
|
1987
|
+
constructor(
|
|
1988
|
+
/**
|
|
1989
|
+
* Initial settings for the new control
|
|
1990
|
+
*/
|
|
1991
|
+
mSettings?: sap.ui.webc.fiori.$FilterItemSettings
|
|
1992
|
+
);
|
|
1993
|
+
/**
|
|
1994
|
+
* Constructor for a new `FilterItem`.
|
|
1995
|
+
*
|
|
1996
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1997
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
1998
|
+
* of the syntax of the settings object.
|
|
1999
|
+
*/
|
|
2000
|
+
constructor(
|
|
2001
|
+
/**
|
|
2002
|
+
* ID for the new control, generated automatically if no ID is given
|
|
2003
|
+
*/
|
|
2004
|
+
sId?: string,
|
|
2005
|
+
/**
|
|
2006
|
+
* Initial settings for the new control
|
|
2007
|
+
*/
|
|
2008
|
+
mSettings?: sap.ui.webc.fiori.$FilterItemSettings
|
|
2009
|
+
);
|
|
2010
|
+
|
|
2011
|
+
/**
|
|
2012
|
+
* Creates a new subclass of class sap.ui.webc.fiori.FilterItem with name `sClassName` and enriches it with
|
|
2013
|
+
* the information contained in `oClassInfo`.
|
|
2014
|
+
*
|
|
2015
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
|
|
2016
|
+
*/
|
|
2017
|
+
static extend<T extends Record<string, unknown>>(
|
|
2018
|
+
/**
|
|
2019
|
+
* Name of the class being created
|
|
2020
|
+
*/
|
|
2021
|
+
sClassName: string,
|
|
2022
|
+
/**
|
|
2023
|
+
* Object literal with information about the class
|
|
2024
|
+
*/
|
|
2025
|
+
oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.FilterItem>,
|
|
2026
|
+
/**
|
|
2027
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
2028
|
+
* used by this class
|
|
2029
|
+
*/
|
|
2030
|
+
FNMetaImpl?: Function
|
|
2031
|
+
): Function;
|
|
2032
|
+
/**
|
|
2033
|
+
* Returns a metadata object for class sap.ui.webc.fiori.FilterItem.
|
|
2034
|
+
*/
|
|
2035
|
+
static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
|
|
2036
|
+
/**
|
|
2037
|
+
* Adds some value to the aggregation {@link #getValues values}.
|
|
2038
|
+
*/
|
|
2039
|
+
addValue(
|
|
2040
|
+
/**
|
|
2041
|
+
* The value to add; if empty, nothing is inserted
|
|
2042
|
+
*/
|
|
2043
|
+
oValue: sap.ui.webc.fiori.IFilterItemOption
|
|
2044
|
+
): this;
|
|
2045
|
+
/**
|
|
2046
|
+
* Destroys all the values in the aggregation {@link #getValues values}.
|
|
2047
|
+
*/
|
|
2048
|
+
destroyValues(): this;
|
|
2049
|
+
/**
|
|
2050
|
+
* Gets current value of property {@link #getText text}.
|
|
2051
|
+
*
|
|
2052
|
+
* Defines the text of the component.
|
|
2053
|
+
*
|
|
2054
|
+
* Default value is `empty string`.
|
|
2055
|
+
*/
|
|
2056
|
+
getText(): string;
|
|
2057
|
+
/**
|
|
2058
|
+
* Gets content of aggregation {@link #getValues values}.
|
|
2059
|
+
*
|
|
2060
|
+
* Defines the `values` list.
|
|
2061
|
+
*/
|
|
2062
|
+
getValues(): sap.ui.webc.fiori.IFilterItemOption[];
|
|
2063
|
+
/**
|
|
2064
|
+
* Checks for the provided `sap.ui.webc.fiori.IFilterItemOption` in the aggregation {@link #getValues values}.
|
|
2065
|
+
* and returns its index if found or -1 otherwise.
|
|
2066
|
+
*/
|
|
2067
|
+
indexOfValue(
|
|
2068
|
+
/**
|
|
2069
|
+
* The value whose index is looked for
|
|
2070
|
+
*/
|
|
2071
|
+
oValue: sap.ui.webc.fiori.IFilterItemOption
|
|
2072
|
+
): int;
|
|
2073
|
+
/**
|
|
2074
|
+
* Inserts a value into the aggregation {@link #getValues values}.
|
|
2075
|
+
*/
|
|
2076
|
+
insertValue(
|
|
2077
|
+
/**
|
|
2078
|
+
* The value to insert; if empty, nothing is inserted
|
|
2079
|
+
*/
|
|
2080
|
+
oValue: sap.ui.webc.fiori.IFilterItemOption,
|
|
2081
|
+
/**
|
|
2082
|
+
* The `0`-based index the value should be inserted at; for a negative value of `iIndex`, the value is inserted
|
|
2083
|
+
* at position 0; for a value greater than the current size of the aggregation, the value is inserted at
|
|
2084
|
+
* the last position
|
|
2085
|
+
*/
|
|
2086
|
+
iIndex: int
|
|
2087
|
+
): this;
|
|
2088
|
+
/**
|
|
2089
|
+
* Removes all the controls from the aggregation {@link #getValues values}.
|
|
2090
|
+
*
|
|
2091
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
2092
|
+
*/
|
|
2093
|
+
removeAllValues(): sap.ui.webc.fiori.IFilterItemOption[];
|
|
2094
|
+
/**
|
|
2095
|
+
* Removes a value from the aggregation {@link #getValues values}.
|
|
2096
|
+
*/
|
|
2097
|
+
removeValue(
|
|
2098
|
+
/**
|
|
2099
|
+
* The value to remove or its index or id
|
|
2100
|
+
*/
|
|
2101
|
+
vValue: int | string | sap.ui.webc.fiori.IFilterItemOption
|
|
2102
|
+
): sap.ui.webc.fiori.IFilterItemOption;
|
|
2103
|
+
/**
|
|
2104
|
+
* Sets a new value for property {@link #getText text}.
|
|
2105
|
+
*
|
|
2106
|
+
* Defines the text of the component.
|
|
2107
|
+
*
|
|
2108
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2109
|
+
*
|
|
2110
|
+
* Default value is `empty string`.
|
|
2111
|
+
*/
|
|
2112
|
+
setText(
|
|
2113
|
+
/**
|
|
2114
|
+
* New value for property `text`
|
|
2115
|
+
*/
|
|
2116
|
+
sText?: string
|
|
2117
|
+
): this;
|
|
2118
|
+
}
|
|
2119
|
+
/**
|
|
2120
|
+
* @SINCE 1.97.0
|
|
2121
|
+
* @EXPERIMENTAL (since 1.97.0)
|
|
2122
|
+
*
|
|
2123
|
+
* Overview:
|
|
2124
|
+
*
|
|
2125
|
+
* Usage:
|
|
2126
|
+
*/
|
|
2127
|
+
class FilterItemOption
|
|
2128
|
+
extends sap.ui.webc.common.WebComponent
|
|
2129
|
+
implements sap.ui.webc.fiori.IFilterItemOption {
|
|
2130
|
+
__implements__sap_ui_webc_fiori_IFilterItemOption: boolean;
|
|
2131
|
+
/**
|
|
2132
|
+
* Constructor for a new `FilterItemOption`.
|
|
2133
|
+
*
|
|
2134
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2135
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
2136
|
+
* of the syntax of the settings object.
|
|
2137
|
+
*/
|
|
2138
|
+
constructor(
|
|
2139
|
+
/**
|
|
2140
|
+
* Initial settings for the new control
|
|
2141
|
+
*/
|
|
2142
|
+
mSettings?: sap.ui.webc.fiori.$FilterItemOptionSettings
|
|
2143
|
+
);
|
|
2144
|
+
/**
|
|
2145
|
+
* Constructor for a new `FilterItemOption`.
|
|
2146
|
+
*
|
|
2147
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2148
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
2149
|
+
* of the syntax of the settings object.
|
|
2150
|
+
*/
|
|
2151
|
+
constructor(
|
|
2152
|
+
/**
|
|
2153
|
+
* ID for the new control, generated automatically if no ID is given
|
|
2154
|
+
*/
|
|
2155
|
+
sId?: string,
|
|
2156
|
+
/**
|
|
2157
|
+
* Initial settings for the new control
|
|
2158
|
+
*/
|
|
2159
|
+
mSettings?: sap.ui.webc.fiori.$FilterItemOptionSettings
|
|
2160
|
+
);
|
|
2161
|
+
|
|
2162
|
+
/**
|
|
2163
|
+
* Creates a new subclass of class sap.ui.webc.fiori.FilterItemOption with name `sClassName` and enriches
|
|
2164
|
+
* it with the information contained in `oClassInfo`.
|
|
2165
|
+
*
|
|
2166
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
|
|
2167
|
+
*/
|
|
2168
|
+
static extend<T extends Record<string, unknown>>(
|
|
2169
|
+
/**
|
|
2170
|
+
* Name of the class being created
|
|
2171
|
+
*/
|
|
2172
|
+
sClassName: string,
|
|
2173
|
+
/**
|
|
2174
|
+
* Object literal with information about the class
|
|
2175
|
+
*/
|
|
2176
|
+
oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.FilterItemOption>,
|
|
2177
|
+
/**
|
|
2178
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
2179
|
+
* used by this class
|
|
2180
|
+
*/
|
|
2181
|
+
FNMetaImpl?: Function
|
|
2182
|
+
): Function;
|
|
2183
|
+
/**
|
|
2184
|
+
* Returns a metadata object for class sap.ui.webc.fiori.FilterItemOption.
|
|
2185
|
+
*/
|
|
2186
|
+
static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
|
|
2187
|
+
/**
|
|
2188
|
+
* Gets current value of property {@link #getSelected selected}.
|
|
2189
|
+
*
|
|
2190
|
+
* Defines whether the option is selected
|
|
2191
|
+
*
|
|
2192
|
+
* Default value is `false`.
|
|
2193
|
+
*/
|
|
2194
|
+
getSelected(): boolean;
|
|
2195
|
+
/**
|
|
2196
|
+
* Gets current value of property {@link #getText text}.
|
|
2197
|
+
*
|
|
2198
|
+
* Defines the text of the component.
|
|
2199
|
+
*
|
|
2200
|
+
* Default value is `empty string`.
|
|
2201
|
+
*/
|
|
2202
|
+
getText(): string;
|
|
2203
|
+
/**
|
|
2204
|
+
* Sets a new value for property {@link #getSelected selected}.
|
|
2205
|
+
*
|
|
2206
|
+
* Defines whether the option is selected
|
|
2207
|
+
*
|
|
2208
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2209
|
+
*
|
|
2210
|
+
* Default value is `false`.
|
|
2211
|
+
*/
|
|
2212
|
+
setSelected(
|
|
2213
|
+
/**
|
|
2214
|
+
* New value for property `selected`
|
|
2215
|
+
*/
|
|
2216
|
+
bSelected?: boolean
|
|
2217
|
+
): this;
|
|
2218
|
+
/**
|
|
2219
|
+
* Sets a new value for property {@link #getText text}.
|
|
2220
|
+
*
|
|
2221
|
+
* Defines the text of the component.
|
|
2222
|
+
*
|
|
2223
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2224
|
+
*
|
|
2225
|
+
* Default value is `empty string`.
|
|
2226
|
+
*/
|
|
2227
|
+
setText(
|
|
2228
|
+
/**
|
|
2229
|
+
* New value for property `text`
|
|
2230
|
+
*/
|
|
2231
|
+
sText?: string
|
|
2232
|
+
): this;
|
|
2233
|
+
}
|
|
1886
2234
|
/**
|
|
1887
2235
|
* @SINCE 1.92.0
|
|
1888
2236
|
* @EXPERIMENTAL (since 1.92.0)
|
|
@@ -2086,7 +2434,7 @@ declare namespace sap {
|
|
|
2086
2434
|
/**
|
|
2087
2435
|
* Gets current value of property {@link #getAccessibilityTexts accessibilityTexts}.
|
|
2088
2436
|
*
|
|
2089
|
-
*
|
|
2437
|
+
* An object of strings that defines several additional accessibility texts for even further customization.
|
|
2090
2438
|
*
|
|
2091
2439
|
* It supports the following fields: - `startColumnAccessibleName`: the accessibility name for the `startColumn`
|
|
2092
2440
|
* region - `midColumnAccessibleName`: the accessibility name for the `midColumn` region - `endColumnAccessibleName`:
|
|
@@ -2189,7 +2537,7 @@ declare namespace sap {
|
|
|
2189
2537
|
/**
|
|
2190
2538
|
* Sets a new value for property {@link #getAccessibilityTexts accessibilityTexts}.
|
|
2191
2539
|
*
|
|
2192
|
-
*
|
|
2540
|
+
* An object of strings that defines several additional accessibility texts for even further customization.
|
|
2193
2541
|
*
|
|
2194
2542
|
* It supports the following fields: - `startColumnAccessibleName`: the accessibility name for the `startColumn`
|
|
2195
2543
|
* region - `midColumnAccessibleName`: the accessibility name for the `midColumn` region - `endColumnAccessibleName`:
|
|
@@ -2312,8 +2660,8 @@ declare namespace sap {
|
|
|
2312
2660
|
): this;
|
|
2313
2661
|
}
|
|
2314
2662
|
/**
|
|
2315
|
-
* @SINCE 1.
|
|
2316
|
-
* @EXPERIMENTAL (since 1.
|
|
2663
|
+
* @SINCE 1.95.0
|
|
2664
|
+
* @EXPERIMENTAL (since 1.95.0)
|
|
2317
2665
|
*
|
|
2318
2666
|
* Overview: An IllustratedMessage is a recommended combination of a solution-oriented message, an engaging
|
|
2319
2667
|
* illustration, and conversational tone to better communicate an empty or a success state than just show
|
|
@@ -6493,6 +6841,121 @@ declare namespace sap {
|
|
|
6493
6841
|
sText?: string
|
|
6494
6842
|
): this;
|
|
6495
6843
|
}
|
|
6844
|
+
/**
|
|
6845
|
+
* @SINCE 1.97.0
|
|
6846
|
+
* @EXPERIMENTAL (since 1.97.0)
|
|
6847
|
+
*
|
|
6848
|
+
* Overview:
|
|
6849
|
+
*
|
|
6850
|
+
* Usage:
|
|
6851
|
+
*/
|
|
6852
|
+
class SortItem
|
|
6853
|
+
extends sap.ui.webc.common.WebComponent
|
|
6854
|
+
implements sap.ui.webc.fiori.ISortItem {
|
|
6855
|
+
__implements__sap_ui_webc_fiori_ISortItem: boolean;
|
|
6856
|
+
/**
|
|
6857
|
+
* Constructor for a new `SortItem`.
|
|
6858
|
+
*
|
|
6859
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
6860
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
6861
|
+
* of the syntax of the settings object.
|
|
6862
|
+
*/
|
|
6863
|
+
constructor(
|
|
6864
|
+
/**
|
|
6865
|
+
* Initial settings for the new control
|
|
6866
|
+
*/
|
|
6867
|
+
mSettings?: sap.ui.webc.fiori.$SortItemSettings
|
|
6868
|
+
);
|
|
6869
|
+
/**
|
|
6870
|
+
* Constructor for a new `SortItem`.
|
|
6871
|
+
*
|
|
6872
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
6873
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
6874
|
+
* of the syntax of the settings object.
|
|
6875
|
+
*/
|
|
6876
|
+
constructor(
|
|
6877
|
+
/**
|
|
6878
|
+
* ID for the new control, generated automatically if no ID is given
|
|
6879
|
+
*/
|
|
6880
|
+
sId?: string,
|
|
6881
|
+
/**
|
|
6882
|
+
* Initial settings for the new control
|
|
6883
|
+
*/
|
|
6884
|
+
mSettings?: sap.ui.webc.fiori.$SortItemSettings
|
|
6885
|
+
);
|
|
6886
|
+
|
|
6887
|
+
/**
|
|
6888
|
+
* Creates a new subclass of class sap.ui.webc.fiori.SortItem with name `sClassName` and enriches it with
|
|
6889
|
+
* the information contained in `oClassInfo`.
|
|
6890
|
+
*
|
|
6891
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
|
|
6892
|
+
*/
|
|
6893
|
+
static extend<T extends Record<string, unknown>>(
|
|
6894
|
+
/**
|
|
6895
|
+
* Name of the class being created
|
|
6896
|
+
*/
|
|
6897
|
+
sClassName: string,
|
|
6898
|
+
/**
|
|
6899
|
+
* Object literal with information about the class
|
|
6900
|
+
*/
|
|
6901
|
+
oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.SortItem>,
|
|
6902
|
+
/**
|
|
6903
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
6904
|
+
* used by this class
|
|
6905
|
+
*/
|
|
6906
|
+
FNMetaImpl?: Function
|
|
6907
|
+
): Function;
|
|
6908
|
+
/**
|
|
6909
|
+
* Returns a metadata object for class sap.ui.webc.fiori.SortItem.
|
|
6910
|
+
*/
|
|
6911
|
+
static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
|
|
6912
|
+
/**
|
|
6913
|
+
* Gets current value of property {@link #getSelected selected}.
|
|
6914
|
+
*
|
|
6915
|
+
* Defines if the component is selected.
|
|
6916
|
+
*
|
|
6917
|
+
* Default value is `false`.
|
|
6918
|
+
*/
|
|
6919
|
+
getSelected(): boolean;
|
|
6920
|
+
/**
|
|
6921
|
+
* Gets current value of property {@link #getText text}.
|
|
6922
|
+
*
|
|
6923
|
+
* Defines the text of the component.
|
|
6924
|
+
*
|
|
6925
|
+
* Default value is `empty string`.
|
|
6926
|
+
*/
|
|
6927
|
+
getText(): string;
|
|
6928
|
+
/**
|
|
6929
|
+
* Sets a new value for property {@link #getSelected selected}.
|
|
6930
|
+
*
|
|
6931
|
+
* Defines if the component is selected.
|
|
6932
|
+
*
|
|
6933
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
6934
|
+
*
|
|
6935
|
+
* Default value is `false`.
|
|
6936
|
+
*/
|
|
6937
|
+
setSelected(
|
|
6938
|
+
/**
|
|
6939
|
+
* New value for property `selected`
|
|
6940
|
+
*/
|
|
6941
|
+
bSelected?: boolean
|
|
6942
|
+
): this;
|
|
6943
|
+
/**
|
|
6944
|
+
* Sets a new value for property {@link #getText text}.
|
|
6945
|
+
*
|
|
6946
|
+
* Defines the text of the component.
|
|
6947
|
+
*
|
|
6948
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
6949
|
+
*
|
|
6950
|
+
* Default value is `empty string`.
|
|
6951
|
+
*/
|
|
6952
|
+
setText(
|
|
6953
|
+
/**
|
|
6954
|
+
* New value for property `text`
|
|
6955
|
+
*/
|
|
6956
|
+
sText?: string
|
|
6957
|
+
): this;
|
|
6958
|
+
}
|
|
6496
6959
|
/**
|
|
6497
6960
|
* @SINCE 1.92.0
|
|
6498
6961
|
* @EXPERIMENTAL (since 1.92.0)
|
|
@@ -7339,10 +7802,21 @@ declare namespace sap {
|
|
|
7339
7802
|
selectedItems?: any[];
|
|
7340
7803
|
}
|
|
7341
7804
|
): this;
|
|
7805
|
+
/**
|
|
7806
|
+
* Gets current value of property {@link #getAccessibleName accessibleName}.
|
|
7807
|
+
*
|
|
7808
|
+
* Sets the accessible aria name of the component.
|
|
7809
|
+
*
|
|
7810
|
+
* Default value is `empty string`.
|
|
7811
|
+
*/
|
|
7812
|
+
getAccessibleName(): string;
|
|
7342
7813
|
/**
|
|
7343
7814
|
* Gets content of aggregation {@link #getHeader header}.
|
|
7344
7815
|
*
|
|
7345
7816
|
* Defines the `sap.ui.webc.fiori.UploadCollection` header.
|
|
7817
|
+
*
|
|
7818
|
+
* **Note:** If `header` slot is provided, the labelling of the `UploadCollection` is a responsibility
|
|
7819
|
+
* of the application developer. `accessibleName` should be used.
|
|
7346
7820
|
*/
|
|
7347
7821
|
getHeader(): sap.ui.core.Control[];
|
|
7348
7822
|
/**
|
|
@@ -7488,6 +7962,21 @@ declare namespace sap {
|
|
|
7488
7962
|
*/
|
|
7489
7963
|
vItem: int | string | sap.ui.webc.fiori.IUploadCollectionItem
|
|
7490
7964
|
): sap.ui.webc.fiori.IUploadCollectionItem;
|
|
7965
|
+
/**
|
|
7966
|
+
* Sets a new value for property {@link #getAccessibleName accessibleName}.
|
|
7967
|
+
*
|
|
7968
|
+
* Sets the accessible aria name of the component.
|
|
7969
|
+
*
|
|
7970
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
7971
|
+
*
|
|
7972
|
+
* Default value is `empty string`.
|
|
7973
|
+
*/
|
|
7974
|
+
setAccessibleName(
|
|
7975
|
+
/**
|
|
7976
|
+
* New value for property `accessibleName`
|
|
7977
|
+
*/
|
|
7978
|
+
sAccessibleName?: string
|
|
7979
|
+
): this;
|
|
7491
7980
|
/**
|
|
7492
7981
|
* Sets a new value for property {@link #getHeight height}.
|
|
7493
7982
|
*
|
|
@@ -8213,12 +8702,13 @@ declare namespace sap {
|
|
|
8213
8702
|
): this;
|
|
8214
8703
|
}
|
|
8215
8704
|
/**
|
|
8216
|
-
* @SINCE 1.
|
|
8217
|
-
* @EXPERIMENTAL (since 1.
|
|
8705
|
+
* @SINCE 1.95.0
|
|
8706
|
+
* @EXPERIMENTAL (since 1.95.0)
|
|
8218
8707
|
*
|
|
8219
8708
|
* Overview: The `sap.ui.webc.fiori.ViewSettingsDialog` component helps the user to sort data within a list
|
|
8220
|
-
* or a table. It consists of several lists like `Sort order` which is built-in and `Sort By`
|
|
8221
|
-
*
|
|
8709
|
+
* or a table. It consists of several lists like `Sort order` which is built-in and `Sort By` and `Filter
|
|
8710
|
+
* By` lists, for which you must be provide items(`sap.ui.webc.fiori.SortItem` & `sap.ui.webc.fiori.FilterItem`
|
|
8711
|
+
* respectively) These options can be used to create sorters for a table.
|
|
8222
8712
|
*
|
|
8223
8713
|
* The `sap.ui.webc.fiori.ViewSettingsDialog` interrupts the current application processing as it is the
|
|
8224
8714
|
* only focused UI element and the main screen is dimmed/blocked. The `sap.ui.webc.fiori.ViewSettingsDialog`
|
|
@@ -8286,6 +8776,15 @@ declare namespace sap {
|
|
|
8286
8776
|
* Returns a metadata object for class sap.ui.webc.fiori.ViewSettingsDialog.
|
|
8287
8777
|
*/
|
|
8288
8778
|
static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
|
|
8779
|
+
/**
|
|
8780
|
+
* Adds some filterItem to the aggregation {@link #getFilterItems filterItems}.
|
|
8781
|
+
*/
|
|
8782
|
+
addFilterItem(
|
|
8783
|
+
/**
|
|
8784
|
+
* The filterItem to add; if empty, nothing is inserted
|
|
8785
|
+
*/
|
|
8786
|
+
oFilterItem: sap.ui.webc.fiori.IFilterItem
|
|
8787
|
+
): this;
|
|
8289
8788
|
/**
|
|
8290
8789
|
* Adds some sortItem to the aggregation {@link #getSortItems sortItems}.
|
|
8291
8790
|
*/
|
|
@@ -8293,7 +8792,7 @@ declare namespace sap {
|
|
|
8293
8792
|
/**
|
|
8294
8793
|
* The sortItem to add; if empty, nothing is inserted
|
|
8295
8794
|
*/
|
|
8296
|
-
oSortItem: sap.ui.webc.
|
|
8795
|
+
oSortItem: sap.ui.webc.fiori.ISortItem
|
|
8297
8796
|
): this;
|
|
8298
8797
|
/**
|
|
8299
8798
|
* Attaches event handler `fnFunction` to the {@link #event:cancel cancel} event of this `sap.ui.webc.fiori.ViewSettingsDialog`.
|
|
@@ -8381,6 +8880,10 @@ declare namespace sap {
|
|
|
8381
8880
|
*/
|
|
8382
8881
|
oListener?: object
|
|
8383
8882
|
): this;
|
|
8883
|
+
/**
|
|
8884
|
+
* Destroys all the filterItems in the aggregation {@link #getFilterItems filterItems}.
|
|
8885
|
+
*/
|
|
8886
|
+
destroyFilterItems(): this;
|
|
8384
8887
|
/**
|
|
8385
8888
|
* Destroys all the sortItems in the aggregation {@link #getSortItems sortItems}.
|
|
8386
8889
|
*/
|
|
@@ -8428,7 +8931,7 @@ declare namespace sap {
|
|
|
8428
8931
|
*/
|
|
8429
8932
|
sortOrder?: string;
|
|
8430
8933
|
/**
|
|
8431
|
-
* The
|
|
8934
|
+
* The currently selected `sap.ui.webc.fiori.SortItem` text attribute.
|
|
8432
8935
|
*/
|
|
8433
8936
|
sortBy?: string;
|
|
8434
8937
|
}
|
|
@@ -8446,11 +8949,15 @@ declare namespace sap {
|
|
|
8446
8949
|
*/
|
|
8447
8950
|
sortOrder?: string;
|
|
8448
8951
|
/**
|
|
8449
|
-
* The
|
|
8952
|
+
* The currently selected `sap.ui.webc.fiori.SortItem` text attribute.
|
|
8450
8953
|
*/
|
|
8451
8954
|
sortBy?: string;
|
|
8452
8955
|
}
|
|
8453
8956
|
): this;
|
|
8957
|
+
/**
|
|
8958
|
+
* Gets content of aggregation {@link #getFilterItems filterItems}.
|
|
8959
|
+
*/
|
|
8960
|
+
getFilterItems(): sap.ui.webc.fiori.IFilterItem[];
|
|
8454
8961
|
/**
|
|
8455
8962
|
* Gets current value of property {@link #getSortDescending sortDescending}.
|
|
8456
8963
|
*
|
|
@@ -8461,20 +8968,43 @@ declare namespace sap {
|
|
|
8461
8968
|
getSortDescending(): boolean;
|
|
8462
8969
|
/**
|
|
8463
8970
|
* Gets content of aggregation {@link #getSortItems sortItems}.
|
|
8464
|
-
*
|
|
8465
|
-
* Defines the `sortItems` list.
|
|
8466
8971
|
*/
|
|
8467
|
-
getSortItems(): sap.ui.webc.
|
|
8972
|
+
getSortItems(): sap.ui.webc.fiori.ISortItem[];
|
|
8468
8973
|
/**
|
|
8469
|
-
* Checks for the provided `sap.ui.webc.
|
|
8974
|
+
* Checks for the provided `sap.ui.webc.fiori.IFilterItem` in the aggregation {@link #getFilterItems filterItems}.
|
|
8975
|
+
* and returns its index if found or -1 otherwise.
|
|
8976
|
+
*/
|
|
8977
|
+
indexOfFilterItem(
|
|
8978
|
+
/**
|
|
8979
|
+
* The filterItem whose index is looked for
|
|
8980
|
+
*/
|
|
8981
|
+
oFilterItem: sap.ui.webc.fiori.IFilterItem
|
|
8982
|
+
): int;
|
|
8983
|
+
/**
|
|
8984
|
+
* Checks for the provided `sap.ui.webc.fiori.ISortItem` in the aggregation {@link #getSortItems sortItems}.
|
|
8470
8985
|
* and returns its index if found or -1 otherwise.
|
|
8471
8986
|
*/
|
|
8472
8987
|
indexOfSortItem(
|
|
8473
8988
|
/**
|
|
8474
8989
|
* The sortItem whose index is looked for
|
|
8475
8990
|
*/
|
|
8476
|
-
oSortItem: sap.ui.webc.
|
|
8991
|
+
oSortItem: sap.ui.webc.fiori.ISortItem
|
|
8477
8992
|
): int;
|
|
8993
|
+
/**
|
|
8994
|
+
* Inserts a filterItem into the aggregation {@link #getFilterItems filterItems}.
|
|
8995
|
+
*/
|
|
8996
|
+
insertFilterItem(
|
|
8997
|
+
/**
|
|
8998
|
+
* The filterItem to insert; if empty, nothing is inserted
|
|
8999
|
+
*/
|
|
9000
|
+
oFilterItem: sap.ui.webc.fiori.IFilterItem,
|
|
9001
|
+
/**
|
|
9002
|
+
* The `0`-based index the filterItem should be inserted at; for a negative value of `iIndex`, the filterItem
|
|
9003
|
+
* is inserted at position 0; for a value greater than the current size of the aggregation, the filterItem
|
|
9004
|
+
* is inserted at the last position
|
|
9005
|
+
*/
|
|
9006
|
+
iIndex: int
|
|
9007
|
+
): this;
|
|
8478
9008
|
/**
|
|
8479
9009
|
* Inserts a sortItem into the aggregation {@link #getSortItems sortItems}.
|
|
8480
9010
|
*/
|
|
@@ -8482,7 +9012,7 @@ declare namespace sap {
|
|
|
8482
9012
|
/**
|
|
8483
9013
|
* The sortItem to insert; if empty, nothing is inserted
|
|
8484
9014
|
*/
|
|
8485
|
-
oSortItem: sap.ui.webc.
|
|
9015
|
+
oSortItem: sap.ui.webc.fiori.ISortItem,
|
|
8486
9016
|
/**
|
|
8487
9017
|
* The `0`-based index the sortItem should be inserted at; for a negative value of `iIndex`, the sortItem
|
|
8488
9018
|
* is inserted at position 0; for a value greater than the current size of the aggregation, the sortItem
|
|
@@ -8490,12 +9020,27 @@ declare namespace sap {
|
|
|
8490
9020
|
*/
|
|
8491
9021
|
iIndex: int
|
|
8492
9022
|
): this;
|
|
9023
|
+
/**
|
|
9024
|
+
* Removes all the controls from the aggregation {@link #getFilterItems filterItems}.
|
|
9025
|
+
*
|
|
9026
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
9027
|
+
*/
|
|
9028
|
+
removeAllFilterItems(): sap.ui.webc.fiori.IFilterItem[];
|
|
8493
9029
|
/**
|
|
8494
9030
|
* Removes all the controls from the aggregation {@link #getSortItems sortItems}.
|
|
8495
9031
|
*
|
|
8496
9032
|
* Additionally, it unregisters them from the hosting UIArea.
|
|
8497
9033
|
*/
|
|
8498
|
-
removeAllSortItems(): sap.ui.webc.
|
|
9034
|
+
removeAllSortItems(): sap.ui.webc.fiori.ISortItem[];
|
|
9035
|
+
/**
|
|
9036
|
+
* Removes a filterItem from the aggregation {@link #getFilterItems filterItems}.
|
|
9037
|
+
*/
|
|
9038
|
+
removeFilterItem(
|
|
9039
|
+
/**
|
|
9040
|
+
* The filterItem to remove or its index or id
|
|
9041
|
+
*/
|
|
9042
|
+
vFilterItem: int | string | sap.ui.webc.fiori.IFilterItem
|
|
9043
|
+
): sap.ui.webc.fiori.IFilterItem;
|
|
8499
9044
|
/**
|
|
8500
9045
|
* Removes a sortItem from the aggregation {@link #getSortItems sortItems}.
|
|
8501
9046
|
*/
|
|
@@ -8503,8 +9048,8 @@ declare namespace sap {
|
|
|
8503
9048
|
/**
|
|
8504
9049
|
* The sortItem to remove or its index or id
|
|
8505
9050
|
*/
|
|
8506
|
-
vSortItem: int | string | sap.ui.webc.
|
|
8507
|
-
): sap.ui.webc.
|
|
9051
|
+
vSortItem: int | string | sap.ui.webc.fiori.ISortItem
|
|
9052
|
+
): sap.ui.webc.fiori.ISortItem;
|
|
8508
9053
|
/**
|
|
8509
9054
|
* Sets a new value for property {@link #getSortDescending sortDescending}.
|
|
8510
9055
|
*
|
|
@@ -8531,16 +9076,16 @@ declare namespace sap {
|
|
|
8531
9076
|
*
|
|
8532
9077
|
* Overview:
|
|
8533
9078
|
*
|
|
8534
|
-
* The `sap.ui.webc.fiori.Wizard` helps users complete a complex task by dividing it into sections and
|
|
8535
|
-
*
|
|
8536
|
-
* a content area below it.
|
|
9079
|
+
* The `sap.ui.webc.fiori.Wizard` helps users to complete a complex task by dividing it into sections and
|
|
9080
|
+
* guiding them through it. It has two main areas - a navigation area at the top showing the step sequence
|
|
9081
|
+
* and a content area below it.
|
|
8537
9082
|
*
|
|
8538
9083
|
* Structure: Navigation area: The top most area of the `sap.ui.webc.fiori.Wizard` is occupied by the navigation
|
|
8539
9084
|
* area. It shows the sequence of steps, where the recommended number of steps is between 3 and 8 steps.
|
|
8540
9085
|
*
|
|
8541
9086
|
* - Steps can have different visual representations - numbers or icons. Steps might have labels
|
|
8542
9087
|
* for better readability - titleText and subTitleText.
|
|
8543
|
-
* - Steps are defined by using the `sap.ui.webc.fiori.WizardStep` as slotted element within the `sap.ui.webc.fiori.Wizard
|
|
9088
|
+
* - Steps are defined by using the `sap.ui.webc.fiori.WizardStep` as slotted element within the `sap.ui.webc.fiori.Wizard`.
|
|
8544
9089
|
*
|
|
8545
9090
|
*
|
|
8546
9091
|
* **Note:** If no selected step is defined, the first step will be auto selected.
|
|
@@ -8567,7 +9112,7 @@ declare namespace sap {
|
|
|
8567
9112
|
*
|
|
8568
9113
|
* Moving to next step: The `sap.ui.webc.fiori.WizardStep` provides the necessary API and it's up to the
|
|
8569
9114
|
* user of the component to use it to move to the next step. You have to set its `selected` property (and
|
|
8570
|
-
* remove the `disabled` one if set) to `true`.
|
|
9115
|
+
* remove the `disabled` one if set) to `true`. The `sap.ui.webc.fiori.Wizard` will automatically scroll
|
|
8571
9116
|
* to the content of the newly selected step.
|
|
8572
9117
|
*
|
|
8573
9118
|
*
|
|
@@ -8576,13 +9121,14 @@ declare namespace sap {
|
|
|
8576
9121
|
* or any other type of element to trigger step change, inside the `sap.ui.webc.fiori.WizardStep`, and show/hide
|
|
8577
9122
|
* it when certain fields are filled or user defined criteria is met.
|
|
8578
9123
|
*
|
|
8579
|
-
* Usage: When to use:: When the user has to accomplish a long
|
|
9124
|
+
* Usage: When to use:: When the user has to accomplish a long or unfamiliar task.
|
|
8580
9125
|
*
|
|
8581
9126
|
* When not to use:: When the task has less than 3 steps.
|
|
8582
9127
|
*
|
|
8583
9128
|
* Responsive Behavior: On small widths the step's titleText, subtitleText and separators in the navigation
|
|
8584
|
-
* area
|
|
8585
|
-
*
|
|
9129
|
+
* area shrink and from particular point the steps are grouped together and overlap. Tapping on them will
|
|
9130
|
+
* show a popover to select the step to navigate to. On mobile device, the grouped steps are presented within
|
|
9131
|
+
* a dialog.
|
|
8586
9132
|
*/
|
|
8587
9133
|
class Wizard extends sap.ui.webc.common.WebComponent {
|
|
8588
9134
|
/**
|
|
@@ -8721,15 +9267,15 @@ declare namespace sap {
|
|
|
8721
9267
|
*/
|
|
8722
9268
|
mParameters?: {
|
|
8723
9269
|
/**
|
|
8724
|
-
*
|
|
9270
|
+
* The new step.
|
|
8725
9271
|
*/
|
|
8726
9272
|
step?: HTMLElement;
|
|
8727
9273
|
/**
|
|
8728
|
-
*
|
|
9274
|
+
* The previous step.
|
|
8729
9275
|
*/
|
|
8730
9276
|
previousStep?: HTMLElement;
|
|
8731
9277
|
/**
|
|
8732
|
-
*
|
|
9278
|
+
* The step change occurs due to user's click or 'Enter'/'Space' key press on step within the navigation.
|
|
8733
9279
|
*/
|
|
8734
9280
|
changeWithClick?: boolean;
|
|
8735
9281
|
}
|
|
@@ -8832,13 +9378,13 @@ declare namespace sap {
|
|
|
8832
9378
|
* Overview:
|
|
8833
9379
|
*
|
|
8834
9380
|
* A component that represents a logical step as part of the `sap.ui.webc.fiori.Wizard`. It is meant to
|
|
8835
|
-
* aggregate arbitrary HTML elements that
|
|
9381
|
+
* aggregate arbitrary HTML elements that form the content of a single step.
|
|
8836
9382
|
*
|
|
8837
9383
|
* Structure:
|
|
8838
|
-
* - Each wizard step has arbitrary content
|
|
8839
|
-
* - Each wizard step might have texts - defined by the `titleText` and `subtitleText` properties
|
|
8840
|
-
* - Each wizard step might have an icon - defined by the `icon` property
|
|
8841
|
-
* - Each wizard step might display a number in place of the `icon`, when it's missing
|
|
9384
|
+
* - Each wizard step has arbitrary content.
|
|
9385
|
+
* - Each wizard step might have texts - defined by the `titleText` and `subtitleText` properties.
|
|
9386
|
+
* - Each wizard step might have an icon - defined by the `icon` property.
|
|
9387
|
+
* - Each wizard step might display a number in place of the `icon`, when it's missing.
|
|
8842
9388
|
*
|
|
8843
9389
|
* Usage: The `sap.ui.webc.fiori.WizardStep` component should be used only as slot of the `sap.ui.webc.fiori.Wizard`
|
|
8844
9390
|
* component and should not be used standalone.
|
|
@@ -8973,7 +9519,7 @@ declare namespace sap {
|
|
|
8973
9519
|
*
|
|
8974
9520
|
*
|
|
8975
9521
|
*
|
|
8976
|
-
* **Note:**
|
|
9522
|
+
* **Note:** The icon is displayed in the `sap.ui.webc.fiori.Wizard` navigation header.
|
|
8977
9523
|
*
|
|
8978
9524
|
*
|
|
8979
9525
|
*
|
|
@@ -9003,7 +9549,6 @@ declare namespace sap {
|
|
|
9003
9549
|
*
|
|
9004
9550
|
*
|
|
9005
9551
|
* **Note:** the text is displayed in the `sap.ui.webc.fiori.Wizard` navigation header.
|
|
9006
|
-
* **Note:** the text will hide on small sizes (about 559 px).
|
|
9007
9552
|
*
|
|
9008
9553
|
* Default value is `empty string`.
|
|
9009
9554
|
*/
|
|
@@ -9015,8 +9560,7 @@ declare namespace sap {
|
|
|
9015
9560
|
*
|
|
9016
9561
|
*
|
|
9017
9562
|
*
|
|
9018
|
-
* **Note:**
|
|
9019
|
-
* **Note:** the text will hide on small sizes (about 559 px).
|
|
9563
|
+
* **Note:** The text is displayed in the `sap.ui.webc.fiori.Wizard` navigation header.
|
|
9020
9564
|
*
|
|
9021
9565
|
* Default value is `empty string`.
|
|
9022
9566
|
*/
|
|
@@ -9140,7 +9684,7 @@ declare namespace sap {
|
|
|
9140
9684
|
*
|
|
9141
9685
|
*
|
|
9142
9686
|
*
|
|
9143
|
-
* **Note:**
|
|
9687
|
+
* **Note:** The icon is displayed in the `sap.ui.webc.fiori.Wizard` navigation header.
|
|
9144
9688
|
*
|
|
9145
9689
|
*
|
|
9146
9690
|
*
|
|
@@ -9184,7 +9728,6 @@ declare namespace sap {
|
|
|
9184
9728
|
*
|
|
9185
9729
|
*
|
|
9186
9730
|
* **Note:** the text is displayed in the `sap.ui.webc.fiori.Wizard` navigation header.
|
|
9187
|
-
* **Note:** the text will hide on small sizes (about 559 px).
|
|
9188
9731
|
*
|
|
9189
9732
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
9190
9733
|
*
|
|
@@ -9203,8 +9746,7 @@ declare namespace sap {
|
|
|
9203
9746
|
*
|
|
9204
9747
|
*
|
|
9205
9748
|
*
|
|
9206
|
-
* **Note:**
|
|
9207
|
-
* **Note:** the text will hide on small sizes (about 559 px).
|
|
9749
|
+
* **Note:** The text is displayed in the `sap.ui.webc.fiori.Wizard` navigation header.
|
|
9208
9750
|
*
|
|
9209
9751
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
9210
9752
|
*
|
|
@@ -9315,8 +9857,8 @@ declare namespace sap {
|
|
|
9315
9857
|
TwoColumnsStartExpanded = "TwoColumnsStartExpanded",
|
|
9316
9858
|
}
|
|
9317
9859
|
/**
|
|
9318
|
-
* @SINCE 1.
|
|
9319
|
-
* @EXPERIMENTAL (since 1.
|
|
9860
|
+
* @SINCE 1.95.0
|
|
9861
|
+
* @EXPERIMENTAL (since 1.95.0)
|
|
9320
9862
|
*
|
|
9321
9863
|
* Different illustration types of Illustrated Message.
|
|
9322
9864
|
*/
|
|
@@ -9357,6 +9899,78 @@ declare namespace sap {
|
|
|
9357
9899
|
* "NoTasks" illustration type.
|
|
9358
9900
|
*/
|
|
9359
9901
|
NoTasks = "NoTasks",
|
|
9902
|
+
/**
|
|
9903
|
+
* "TntCodePlaceholder" illustration type.
|
|
9904
|
+
*/
|
|
9905
|
+
TntCodePlaceholder = "TntCodePlaceholder",
|
|
9906
|
+
/**
|
|
9907
|
+
* "TntCompany" illustration type.
|
|
9908
|
+
*/
|
|
9909
|
+
TntCompany = "TntCompany",
|
|
9910
|
+
/**
|
|
9911
|
+
* "TntExternalLink" illustration type.
|
|
9912
|
+
*/
|
|
9913
|
+
TntExternalLink = "TntExternalLink",
|
|
9914
|
+
/**
|
|
9915
|
+
* "TntFaceID" illustration type.
|
|
9916
|
+
*/
|
|
9917
|
+
TntFaceID = "TntFaceID",
|
|
9918
|
+
/**
|
|
9919
|
+
* "TntFingerprint" illustration type.
|
|
9920
|
+
*/
|
|
9921
|
+
TntFingerprint = "TntFingerprint",
|
|
9922
|
+
/**
|
|
9923
|
+
* "TntLock" illustration type.
|
|
9924
|
+
*/
|
|
9925
|
+
TntLock = "TntLock",
|
|
9926
|
+
/**
|
|
9927
|
+
* "TntMission" illustration type.
|
|
9928
|
+
*/
|
|
9929
|
+
TntMission = "TntMission",
|
|
9930
|
+
/**
|
|
9931
|
+
* "TntNoApplications" illustration type.
|
|
9932
|
+
*/
|
|
9933
|
+
TntNoApplications = "TntNoApplications",
|
|
9934
|
+
/**
|
|
9935
|
+
* "TntNoFlows" illustration type.
|
|
9936
|
+
*/
|
|
9937
|
+
TntNoFlows = "TntNoFlows",
|
|
9938
|
+
/**
|
|
9939
|
+
* "TntNoUsers" illustration type.
|
|
9940
|
+
*/
|
|
9941
|
+
TntNoUsers = "TntNoUsers",
|
|
9942
|
+
/**
|
|
9943
|
+
* "TntRadar" illustration type.
|
|
9944
|
+
*/
|
|
9945
|
+
TntRadar = "TntRadar",
|
|
9946
|
+
/**
|
|
9947
|
+
* "TntServices" illustration type.
|
|
9948
|
+
*/
|
|
9949
|
+
TntServices = "TntServices",
|
|
9950
|
+
/**
|
|
9951
|
+
* "TntSessionExpired" illustration type.
|
|
9952
|
+
*/
|
|
9953
|
+
TntSessionExpired = "TntSessionExpired",
|
|
9954
|
+
/**
|
|
9955
|
+
* "TntSessionExpiring" illustration type.
|
|
9956
|
+
*/
|
|
9957
|
+
TntSessionExpiring = "TntSessionExpiring",
|
|
9958
|
+
/**
|
|
9959
|
+
* "TntSuccess" illustration type.
|
|
9960
|
+
*/
|
|
9961
|
+
TntSuccess = "TntSuccess",
|
|
9962
|
+
/**
|
|
9963
|
+
* "TntSuccessfulAuth" illustration type.
|
|
9964
|
+
*/
|
|
9965
|
+
TntSuccessfulAuth = "TntSuccessfulAuth",
|
|
9966
|
+
/**
|
|
9967
|
+
* "TntUnlock" illustration type.
|
|
9968
|
+
*/
|
|
9969
|
+
TntUnlock = "TntUnlock",
|
|
9970
|
+
/**
|
|
9971
|
+
* "TntUnsuccessfulAuth" illustration type.
|
|
9972
|
+
*/
|
|
9973
|
+
TntUnsuccessfulAuth = "TntUnsuccessfulAuth",
|
|
9360
9974
|
/**
|
|
9361
9975
|
* "UnableToLoad" illustration type.
|
|
9362
9976
|
*/
|
|
@@ -9435,6 +10049,10 @@ declare namespace sap {
|
|
|
9435
10049
|
|
|
9436
10050
|
"sap/ui/webc/fiori/BarcodeScannerDialog": undefined;
|
|
9437
10051
|
|
|
10052
|
+
"sap/ui/webc/fiori/FilterItem": undefined;
|
|
10053
|
+
|
|
10054
|
+
"sap/ui/webc/fiori/FilterItemOption": undefined;
|
|
10055
|
+
|
|
9438
10056
|
"sap/ui/webc/fiori/FlexibleColumnLayout": undefined;
|
|
9439
10057
|
|
|
9440
10058
|
"sap/ui/webc/fiori/IllustratedMessage": undefined;
|
|
@@ -9463,6 +10081,8 @@ declare namespace sap {
|
|
|
9463
10081
|
|
|
9464
10082
|
"sap/ui/webc/fiori/SideNavigationSubItem": undefined;
|
|
9465
10083
|
|
|
10084
|
+
"sap/ui/webc/fiori/SortItem": undefined;
|
|
10085
|
+
|
|
9466
10086
|
"sap/ui/webc/fiori/Timeline": undefined;
|
|
9467
10087
|
|
|
9468
10088
|
"sap/ui/webc/fiori/TimelineItem": undefined;
|