@openui5/ts-types-esm 1.97.1 → 1.100.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 +6 -2
- package/types/sap.f.d.ts +265 -641
- package/types/sap.m.d.ts +6567 -2769
- package/types/sap.tnt.d.ts +31 -1
- package/types/sap.ui.codeeditor.d.ts +1 -1
- package/types/sap.ui.commons.d.ts +1 -1
- package/types/sap.ui.core.d.ts +2135 -843
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.fl.d.ts +18 -6
- package/types/sap.ui.integration.d.ts +49 -13
- package/types/sap.ui.layout.d.ts +7 -4
- package/types/sap.ui.mdc.d.ts +67 -13
- package/types/sap.ui.rta.d.ts +1 -1
- package/types/sap.ui.suite.d.ts +1 -1
- package/types/sap.ui.support.d.ts +6 -12
- package/types/sap.ui.table.d.ts +24 -2
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +1 -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 +2852 -940
- package/types/sap.ui.webc.main.d.ts +3185 -999
- package/types/sap.uxap.d.ts +1 -1
package/types/sap.f.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.
|
|
1
|
+
// For Library Version: 1.100.0
|
|
2
2
|
|
|
3
3
|
declare module "sap/tnt/library" {
|
|
4
4
|
export interface IToolHeader {
|
|
@@ -19,6 +19,10 @@ declare module "sap/f/library" {
|
|
|
19
19
|
|
|
20
20
|
import Control from "sap/ui/core/Control";
|
|
21
21
|
|
|
22
|
+
import IllustratedMessageSize1 from "sap/m/IllustratedMessageSize";
|
|
23
|
+
|
|
24
|
+
import IllustratedMessageType1 from "sap/m/IllustratedMessageType";
|
|
25
|
+
|
|
22
26
|
/**
|
|
23
27
|
* @SINCE 1.69
|
|
24
28
|
* @deprecated (since 1.73) - Use the {@link sap.m.AvatarColor} instead.
|
|
@@ -169,90 +173,25 @@ declare module "sap/f/library" {
|
|
|
169
173
|
}
|
|
170
174
|
|
|
171
175
|
/**
|
|
172
|
-
* @
|
|
176
|
+
* @SINCE 1.88
|
|
177
|
+
* @deprecated (since 1.98) - Use the {@link sap.m.IllustratedMessageSize} instead.
|
|
173
178
|
*
|
|
174
179
|
* Available `Illustration` sizes for the {@link sap.f.IllustratedMessage} control.
|
|
180
|
+
*
|
|
181
|
+
* This is an alias for {@link sap.m.IllustratedMessageSize} and only kept for compatibility reasons.
|
|
175
182
|
*/
|
|
176
|
-
export
|
|
177
|
-
|
|
178
|
-
* Automatically decides the `Illustration` size (`Base`, `Spot`, `Dialog`, or `Scene`) depending on the
|
|
179
|
-
* `IllustratedMessage` container width.
|
|
180
|
-
*
|
|
181
|
-
* **Note:** `Auto` is the only option where the illustration size is changed according to the available
|
|
182
|
-
* container width. If any other `IllustratedMessageSize` is chosen, it remains until changed by the app
|
|
183
|
-
* developer.
|
|
184
|
-
*/
|
|
185
|
-
Auto = "Auto",
|
|
186
|
-
/**
|
|
187
|
-
* Base `Illustration` size (XS breakpoint). Suitable for cards (two columns).
|
|
188
|
-
*
|
|
189
|
-
* **Note:** When `Base` is in use, no illustration is displayed.
|
|
190
|
-
*/
|
|
191
|
-
Base = "Base",
|
|
192
|
-
/**
|
|
193
|
-
* Dialog `Illustration` size (M breakpoint). Suitable for dialogs.
|
|
194
|
-
*/
|
|
195
|
-
Dialog = "Dialog",
|
|
196
|
-
/**
|
|
197
|
-
* Scene `Illustration` size (L breakpoint). Suitable for a `Page` or a table.
|
|
198
|
-
*/
|
|
199
|
-
Scene = "Scene",
|
|
200
|
-
/**
|
|
201
|
-
* Spot `Illustration` size (S breakpoint). Suitable for cards (four columns).
|
|
202
|
-
*/
|
|
203
|
-
Spot = "Spot",
|
|
204
|
-
}
|
|
183
|
+
export type IllustratedMessageSize = IllustratedMessageSize1;
|
|
184
|
+
|
|
205
185
|
/**
|
|
206
|
-
* @
|
|
186
|
+
* @SINCE 1.88
|
|
187
|
+
* @deprecated (since 1.98) - Use the {@link sap.m.IllustratedMessageType} instead.
|
|
207
188
|
*
|
|
208
189
|
* Available `Illustration` types for the {@link sap.f.IllustratedMessage} control.
|
|
190
|
+
*
|
|
191
|
+
* This is an alias for {@link sap.m.IllustratedMessageType} and only kept for compatibility reasons.
|
|
209
192
|
*/
|
|
210
|
-
export
|
|
211
|
-
|
|
212
|
-
* "Before Search" illustration type.
|
|
213
|
-
*/
|
|
214
|
-
BeforeSearch = "sapIllus-BeforeSearch",
|
|
215
|
-
/**
|
|
216
|
-
* "No Activities" illustration type.
|
|
217
|
-
*/
|
|
218
|
-
NoActivities = "sapIllus-NoActivities",
|
|
219
|
-
/**
|
|
220
|
-
* "No Data" illustration type.
|
|
221
|
-
*/
|
|
222
|
-
NoData = "sapIllus-NoData",
|
|
223
|
-
/**
|
|
224
|
-
* "No Entries" illustration type.
|
|
225
|
-
*/
|
|
226
|
-
NoEntries = "sapIllus-NoEntries",
|
|
227
|
-
/**
|
|
228
|
-
* "No Email" illustration type.
|
|
229
|
-
*/
|
|
230
|
-
NoMail = "sapIllus-NoMail",
|
|
231
|
-
/**
|
|
232
|
-
* "No Notifications" illustration type.
|
|
233
|
-
*/
|
|
234
|
-
NoNotifications = "sapIllus-NoNotifications",
|
|
235
|
-
/**
|
|
236
|
-
* "No Saved Items" illustration type.
|
|
237
|
-
*/
|
|
238
|
-
NoSavedItems = "sapIllus-NoSavedItems",
|
|
239
|
-
/**
|
|
240
|
-
* "No Search Results" illustration type.
|
|
241
|
-
*/
|
|
242
|
-
NoSearchResults = "sapIllus-NoSearchResults",
|
|
243
|
-
/**
|
|
244
|
-
* "No Tasks" illustration type.
|
|
245
|
-
*/
|
|
246
|
-
NoTasks = "sapIllus-NoTasks",
|
|
247
|
-
/**
|
|
248
|
-
* "Unable To Load" illustration type.
|
|
249
|
-
*/
|
|
250
|
-
UnableToLoad = "sapIllus-UnableToLoad",
|
|
251
|
-
/**
|
|
252
|
-
* "Unable To Upload" illustration type.
|
|
253
|
-
*/
|
|
254
|
-
UnableToUpload = "sapIllus-UnableToUpload",
|
|
255
|
-
}
|
|
193
|
+
export type IllustratedMessageType = IllustratedMessageType1;
|
|
194
|
+
|
|
256
195
|
/**
|
|
257
196
|
* @SINCE 1.63
|
|
258
197
|
* @EXPERIMENTAL (since 1.63)
|
|
@@ -7550,72 +7489,14 @@ declare module "sap/f/FlexibleColumnLayoutSemanticHelper" {
|
|
|
7550
7489
|
oSettings?: object
|
|
7551
7490
|
): FlexibleColumnLayoutSemanticHelper;
|
|
7552
7491
|
/**
|
|
7553
|
-
* Returns an object
|
|
7492
|
+
* Returns an object describing the current state of the control and the expected action buttons for each
|
|
7554
7493
|
* column.
|
|
7555
7494
|
*
|
|
7556
|
-
* The returned object has the following structure:
|
|
7557
|
-
* - layout - the value of the `layout` property
|
|
7558
|
-
* - maxColumnsCount - the maximum number of columns that can be displayed at once based on the control
|
|
7559
|
-
* width. See {@link sap.f.FlexibleColumnLayout#getMaxColumnsCount}
|
|
7560
|
-
* - columnsSizes - an object with fields `beginColumn, midColumn, endColumn`, representing the relative
|
|
7561
|
-
* percentage sizes of the three columns as integers
|
|
7562
|
-
* - columnsVisibility - an object with fields `beginColumn, midColumn, endColumn`, representing the visibility
|
|
7563
|
-
* of the three columns
|
|
7564
|
-
* - isFullScreen - `true` if only one column is visible at the moment, `false` otherwise **Note:** This
|
|
7565
|
-
* may be due to small screen size (phone) or due to a layout, for which a single column takes up the whole
|
|
7566
|
-
* width
|
|
7567
|
-
* - isLogicallyFullScreen - `true` if the current `layout` is one of the following: `sap.f.LayoutType.OneColumn,
|
|
7568
|
-
* sap.f.LayoutType.MidColumnFullScreen, sap.f.LayoutType.EndColumnFullScreen`, `false` otherwise **Note:**
|
|
7569
|
-
* While `isFullScreen` can be `true` for any layout, due to small screen size, `isLogicallyFullScreen`
|
|
7570
|
-
* will only be `true` for the layout values, listed above.
|
|
7571
|
-
* - actionButtonsInfo - an object with fields `midColumn, endColumn`, each containing an object, telling
|
|
7572
|
-
* whether action buttons should be shown in the `mid` and `end` columns, and what value of the `layout`
|
|
7573
|
-
* property should be set upon clicking these buttons. Each of these objects has the following fields: `closeColumn,
|
|
7574
|
-
* fullScreen, exitFullScreen`. If `null`, then the respective action button should not be shown, otherwise
|
|
7575
|
-
* provides the value of `layout` property for the action button.
|
|
7576
|
-
*
|
|
7577
7495
|
* **Note:** This method relies on the internal `FlexibleColumnLayout` reference to be rendered in the DOM
|
|
7578
7496
|
* tree. For convenience, use methods {@link sap.f.FlexibleColumnLayoutSemanticHelper#isDOMReady} and {@link
|
|
7579
7497
|
* sap.f.FlexibleColumnLayoutSemanticHelper#whenDOMReady}.
|
|
7580
|
-
|
|
7581
|
-
|
|
7582
|
-
*
|
|
7583
|
-
*
|
|
7584
|
-
* ```javascript
|
|
7585
|
-
*
|
|
7586
|
-
*
|
|
7587
|
-
* {
|
|
7588
|
-
* "layout":"ThreeColumnsMidExpanded",
|
|
7589
|
-
* "maxColumnsCount":3,
|
|
7590
|
-
* "columnsSizes":{
|
|
7591
|
-
* "beginColumn":25,
|
|
7592
|
-
* "midColumn":50,
|
|
7593
|
-
* "endColumn":25
|
|
7594
|
-
* },
|
|
7595
|
-
* "columnsVisibility":{
|
|
7596
|
-
* "beginColumn":true,
|
|
7597
|
-
* "midColumn":true,
|
|
7598
|
-
* "endColumn":true
|
|
7599
|
-
* },
|
|
7600
|
-
* "isFullScreen":false,
|
|
7601
|
-
* "isLogicallyFullScreen":false,
|
|
7602
|
-
* "actionButtonsInfo":{
|
|
7603
|
-
* "midColumn":{
|
|
7604
|
-
* "fullScreen":null,
|
|
7605
|
-
* "exitFullScreen":null,
|
|
7606
|
-
* "closeColumn":null
|
|
7607
|
-
* },
|
|
7608
|
-
* "endColumn":{
|
|
7609
|
-
* "fullScreen":"EndColumnFullScreen",
|
|
7610
|
-
* "exitFullScreen":null,
|
|
7611
|
-
* "closeColumn":"TwoColumnsBeginExpanded"
|
|
7612
|
-
* }
|
|
7613
|
-
* }
|
|
7614
|
-
* }
|
|
7615
|
-
*
|
|
7616
|
-
* ```
|
|
7617
|
-
*/
|
|
7618
|
-
getCurrentUIState(): object;
|
|
7498
|
+
*/
|
|
7499
|
+
getCurrentUIState(): UIState;
|
|
7619
7500
|
/**
|
|
7620
7501
|
* Returns the default layout types for the different numbers of columns.
|
|
7621
7502
|
*
|
|
@@ -7631,8 +7512,6 @@ declare module "sap/f/FlexibleColumnLayoutSemanticHelper" {
|
|
|
7631
7512
|
/**
|
|
7632
7513
|
* Returns an object, describing the state that the control will have after navigating to a different view
|
|
7633
7514
|
* level.
|
|
7634
|
-
*
|
|
7635
|
-
* About the format of return value, see: {@link sap.f.FlexibleColumnLayoutSemanticHelper#getCurrentUIState}
|
|
7636
7515
|
*/
|
|
7637
7516
|
getNextUIState(
|
|
7638
7517
|
/**
|
|
@@ -7640,7 +7519,7 @@ declare module "sap/f/FlexibleColumnLayoutSemanticHelper" {
|
|
|
7640
7519
|
* 3 and above - subsequent views
|
|
7641
7520
|
*/
|
|
7642
7521
|
iNextLevel: int
|
|
7643
|
-
):
|
|
7522
|
+
): UIState;
|
|
7644
7523
|
/**
|
|
7645
7524
|
* @SINCE 1.72
|
|
7646
7525
|
*
|
|
@@ -7669,6 +7548,155 @@ declare module "sap/f/FlexibleColumnLayoutSemanticHelper" {
|
|
|
7669
7548
|
*/
|
|
7670
7549
|
whenReady(): Promise<any>;
|
|
7671
7550
|
}
|
|
7551
|
+
/**
|
|
7552
|
+
* The configuration of the navigation actions in the columns.
|
|
7553
|
+
*/
|
|
7554
|
+
export type ColumnsNavigationActions = {
|
|
7555
|
+
/**
|
|
7556
|
+
* Configuration of the navigation actions of the mid column.
|
|
7557
|
+
*/
|
|
7558
|
+
midColumn?: NavigationActionsTargets;
|
|
7559
|
+
/**
|
|
7560
|
+
* Configuration of the navigation actions of the end column.
|
|
7561
|
+
*/
|
|
7562
|
+
endColumn?: NavigationActionsTargets;
|
|
7563
|
+
};
|
|
7564
|
+
|
|
7565
|
+
/**
|
|
7566
|
+
* Represents the relative percentage sizes of all columns as integers.
|
|
7567
|
+
*/
|
|
7568
|
+
export type ColumnsSizes = {
|
|
7569
|
+
/**
|
|
7570
|
+
* The relative percentage width of the begin column as integer.
|
|
7571
|
+
*/
|
|
7572
|
+
beginColumn?: number;
|
|
7573
|
+
/**
|
|
7574
|
+
* The relative percentage width of the mid column as integer.
|
|
7575
|
+
*/
|
|
7576
|
+
midColumn?: number;
|
|
7577
|
+
/**
|
|
7578
|
+
* The relative percentage width of the end column as integer.
|
|
7579
|
+
*/
|
|
7580
|
+
endColumn?: number;
|
|
7581
|
+
};
|
|
7582
|
+
|
|
7583
|
+
/**
|
|
7584
|
+
* Represents the visibility of the columns.
|
|
7585
|
+
*/
|
|
7586
|
+
export type ColumnsVisibility = {
|
|
7587
|
+
/**
|
|
7588
|
+
* The visibility of the begin column.
|
|
7589
|
+
*/
|
|
7590
|
+
beginColumn?: boolean;
|
|
7591
|
+
/**
|
|
7592
|
+
* The visibility of the mid column.
|
|
7593
|
+
*/
|
|
7594
|
+
midColumn?: boolean;
|
|
7595
|
+
/**
|
|
7596
|
+
* The visibility of the end column.
|
|
7597
|
+
*/
|
|
7598
|
+
endColumn?: boolean;
|
|
7599
|
+
};
|
|
7600
|
+
|
|
7601
|
+
/**
|
|
7602
|
+
* Configures the target layouts of the navigation acion buttons in a column.
|
|
7603
|
+
*/
|
|
7604
|
+
export type NavigationActionsTargets = {
|
|
7605
|
+
/**
|
|
7606
|
+
* The target {@link sap.f.FlexibleColumnLayout#getLayout layout} when the `fullscreen` navigation action
|
|
7607
|
+
* button is pressed. If null, then the respective action button should not be shown.
|
|
7608
|
+
*/
|
|
7609
|
+
fullScreen?: string | null;
|
|
7610
|
+
/**
|
|
7611
|
+
* The target {@link sap.f.FlexibleColumnLayout#getLayout layout} when the `exitFullScreen` navigation action
|
|
7612
|
+
* button is pressed. If null, then the respective action button should not be shown.
|
|
7613
|
+
*/
|
|
7614
|
+
exitFullScreen?: string | null;
|
|
7615
|
+
/**
|
|
7616
|
+
* The target {@link sap.f.FlexibleColumnLayout#getLayout layout} when the `closeColumn` navigation action
|
|
7617
|
+
* button is pressed. If null, then the respective action button should not be shown.
|
|
7618
|
+
*/
|
|
7619
|
+
closeColumn?: string | null;
|
|
7620
|
+
};
|
|
7621
|
+
|
|
7622
|
+
/**
|
|
7623
|
+
* Configuration of the state of the `FlexibleColumnLayout` control and the expected action buttons for
|
|
7624
|
+
* each column.
|
|
7625
|
+
*
|
|
7626
|
+
* Example value:
|
|
7627
|
+
*
|
|
7628
|
+
*
|
|
7629
|
+
* ```javascript
|
|
7630
|
+
*
|
|
7631
|
+
*
|
|
7632
|
+
* {
|
|
7633
|
+
* "layout":"ThreeColumnsMidExpanded",
|
|
7634
|
+
* "maxColumnsCount":3,
|
|
7635
|
+
* "columnsSizes":{
|
|
7636
|
+
* "beginColumn":25,
|
|
7637
|
+
* "midColumn":50,
|
|
7638
|
+
* "endColumn":25
|
|
7639
|
+
* },
|
|
7640
|
+
* "columnsVisibility":{
|
|
7641
|
+
* "beginColumn":true,
|
|
7642
|
+
* "midColumn":true,
|
|
7643
|
+
* "endColumn":true
|
|
7644
|
+
* },
|
|
7645
|
+
* "isFullScreen":false,
|
|
7646
|
+
* "isLogicallyFullScreen":false,
|
|
7647
|
+
* "actionButtonsInfo":{
|
|
7648
|
+
* "midColumn":{
|
|
7649
|
+
* "fullScreen":null,
|
|
7650
|
+
* "exitFullScreen":null,
|
|
7651
|
+
* "closeColumn":null
|
|
7652
|
+
* },
|
|
7653
|
+
* "endColumn":{
|
|
7654
|
+
* "fullScreen":"EndColumnFullScreen",
|
|
7655
|
+
* "exitFullScreen":null,
|
|
7656
|
+
* "closeColumn":"TwoColumnsBeginExpanded"
|
|
7657
|
+
* }
|
|
7658
|
+
* }
|
|
7659
|
+
* }
|
|
7660
|
+
*
|
|
7661
|
+
* ```
|
|
7662
|
+
*/
|
|
7663
|
+
export type UIState = {
|
|
7664
|
+
/**
|
|
7665
|
+
* The value of the {@link sap.f.FlexibleColumnLayout#getLayout layout} property.
|
|
7666
|
+
*/
|
|
7667
|
+
layout?: string;
|
|
7668
|
+
/**
|
|
7669
|
+
* The maximum number of columns that can be displayed at once based on the control width. See {@link sap.f.FlexibleColumnLayout#getMaxColumnsCount}
|
|
7670
|
+
*/
|
|
7671
|
+
maxColumnsCount?: number;
|
|
7672
|
+
/**
|
|
7673
|
+
* Represents the relative percentage sizes of all columns as integers.
|
|
7674
|
+
*/
|
|
7675
|
+
columnsSizes?: ColumnsSizes;
|
|
7676
|
+
/**
|
|
7677
|
+
* Represents the visibility of the columns.
|
|
7678
|
+
*/
|
|
7679
|
+
columnsVisibility?: ColumnsVisibility;
|
|
7680
|
+
/**
|
|
7681
|
+
* The value is `true` if only one column is visible at the moment, `false` otherwise.
|
|
7682
|
+
*
|
|
7683
|
+
* **Note:** This may be due to small screen size (phone) or due to a layout, for which a single column
|
|
7684
|
+
* takes up the whole width.
|
|
7685
|
+
*/
|
|
7686
|
+
isFullScreen?: boolean;
|
|
7687
|
+
/**
|
|
7688
|
+
* The value is `true` if the current `layout` is one of the following: `sap.f.LayoutType.OneColumn, sap.f.LayoutType.MidColumnFullScreen,
|
|
7689
|
+
* sap.f.LayoutType.EndColumnFullScreen`, `false` otherwise.
|
|
7690
|
+
*
|
|
7691
|
+
* **Note:** While `isFullScreen` can be `true` for any layout, due to small screen size, `isLogicallyFullScreen`
|
|
7692
|
+
* will only be `true` for the layout values, listed above.
|
|
7693
|
+
*/
|
|
7694
|
+
isLogicallyFullScreen?: boolean;
|
|
7695
|
+
/**
|
|
7696
|
+
* The configuration of the navigation actions in the columns.
|
|
7697
|
+
*/
|
|
7698
|
+
actionButtonsInfo?: ColumnsNavigationActions;
|
|
7699
|
+
};
|
|
7672
7700
|
}
|
|
7673
7701
|
|
|
7674
7702
|
declare module "sap/f/GridContainer" {
|
|
@@ -9489,22 +9517,16 @@ declare module "sap/f/GridListItem" {
|
|
|
9489
9517
|
}
|
|
9490
9518
|
|
|
9491
9519
|
declare module "sap/f/IllustratedMessage" {
|
|
9492
|
-
import {
|
|
9493
|
-
|
|
9494
|
-
|
|
9495
|
-
|
|
9496
|
-
import { IllustratedMessageSize } from "sap/f/library";
|
|
9520
|
+
import {
|
|
9521
|
+
default as IllustratedMessage1,
|
|
9522
|
+
$IllustratedMessageSettings as $IllustratedMessageSettings1,
|
|
9523
|
+
} from "sap/m/IllustratedMessage";
|
|
9497
9524
|
|
|
9498
9525
|
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
9499
9526
|
|
|
9500
|
-
import {
|
|
9501
|
-
PropertyBindingInfo,
|
|
9502
|
-
AggregationBindingInfo,
|
|
9503
|
-
} from "sap/ui/base/ManagedObject";
|
|
9504
|
-
|
|
9505
9527
|
/**
|
|
9506
9528
|
* @SINCE 1.88
|
|
9507
|
-
* @
|
|
9529
|
+
* @deprecated (since 1.98) - Use the {@link sap.m.IllustratedMessage} instead.
|
|
9508
9530
|
*
|
|
9509
9531
|
* A combination of message and illustration to represent an empty or a success state.
|
|
9510
9532
|
*
|
|
@@ -9533,13 +9555,16 @@ declare module "sap/f/IllustratedMessage" {
|
|
|
9533
9555
|
* and the available space of its parent container. Some of the structural elements are displayed differently
|
|
9534
9556
|
* or are omitted in the different breakpoint sizes (XS, S, M, L).
|
|
9535
9557
|
*/
|
|
9536
|
-
export default class IllustratedMessage extends
|
|
9558
|
+
export default class IllustratedMessage extends IllustratedMessage1 {
|
|
9537
9559
|
/**
|
|
9538
9560
|
* Constructor for a new `IllustratedMessage`.
|
|
9539
9561
|
*
|
|
9540
9562
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
9541
9563
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
9542
9564
|
* of the syntax of the settings object.
|
|
9565
|
+
*
|
|
9566
|
+
* This class does not have its own settings, but all settings applicable to the base type {@link sap.m.IllustratedMessage#constructor
|
|
9567
|
+
* sap.m.IllustratedMessage} can be used.
|
|
9543
9568
|
*/
|
|
9544
9569
|
constructor(
|
|
9545
9570
|
/**
|
|
@@ -9553,6 +9578,9 @@ declare module "sap/f/IllustratedMessage" {
|
|
|
9553
9578
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
9554
9579
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
9555
9580
|
* of the syntax of the settings object.
|
|
9581
|
+
*
|
|
9582
|
+
* This class does not have its own settings, but all settings applicable to the base type {@link sap.m.IllustratedMessage#constructor
|
|
9583
|
+
* sap.m.IllustratedMessage} can be used.
|
|
9556
9584
|
*/
|
|
9557
9585
|
constructor(
|
|
9558
9586
|
/**
|
|
@@ -9569,7 +9597,7 @@ declare module "sap/f/IllustratedMessage" {
|
|
|
9569
9597
|
* Creates a new subclass of class sap.f.IllustratedMessage with name `sClassName` and enriches it with
|
|
9570
9598
|
* the information contained in `oClassInfo`.
|
|
9571
9599
|
*
|
|
9572
|
-
* `oClassInfo` might contain the same kind of information as described in {@link sap.
|
|
9600
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.m.IllustratedMessage.extend}.
|
|
9573
9601
|
*/
|
|
9574
9602
|
static extend<T extends Record<string, unknown>>(
|
|
9575
9603
|
/**
|
|
@@ -9590,329 +9618,39 @@ declare module "sap/f/IllustratedMessage" {
|
|
|
9590
9618
|
* Returns a metadata object for class sap.f.IllustratedMessage.
|
|
9591
9619
|
*/
|
|
9592
9620
|
static getMetadata(): ElementMetadata;
|
|
9593
|
-
/**
|
|
9594
|
-
* @SINCE 1.88
|
|
9595
|
-
*
|
|
9596
|
-
* Adds some additionalContent to the aggregation {@link #getAdditionalContent additionalContent}.
|
|
9597
|
-
*/
|
|
9598
|
-
addAdditionalContent(
|
|
9599
|
-
/**
|
|
9600
|
-
* The additionalContent to add; if empty, nothing is inserted
|
|
9601
|
-
*/
|
|
9602
|
-
oAdditionalContent: Button
|
|
9603
|
-
): this;
|
|
9604
|
-
/**
|
|
9605
|
-
* @SINCE 1.88
|
|
9606
|
-
*
|
|
9607
|
-
* Destroys all the additionalContent in the aggregation {@link #getAdditionalContent additionalContent}.
|
|
9608
|
-
*/
|
|
9609
|
-
destroyAdditionalContent(): this;
|
|
9610
|
-
/**
|
|
9611
|
-
* @SINCE 1.88
|
|
9612
|
-
*
|
|
9613
|
-
* Gets content of aggregation {@link #getAdditionalContent additionalContent}.
|
|
9614
|
-
*
|
|
9615
|
-
* Defines the controls placed below the description as additional content.
|
|
9616
|
-
*
|
|
9617
|
-
* **Note:** Not displayed when `illustrationSize` is set to `Base`.
|
|
9618
|
-
*/
|
|
9619
|
-
getAdditionalContent(): Button[];
|
|
9620
|
-
/**
|
|
9621
|
-
* @SINCE 1.88
|
|
9622
|
-
*
|
|
9623
|
-
* Gets current value of property {@link #getDescription description}.
|
|
9624
|
-
*
|
|
9625
|
-
* Defines the description displayed below the title.
|
|
9626
|
-
*
|
|
9627
|
-
* If there is no initial input from the app developer and the default illustration set is being used, a
|
|
9628
|
-
* default description for the current illustration type is going to be displayed. The default description
|
|
9629
|
-
* is stored in the `sap.f` resource bundle.
|
|
9630
|
-
*
|
|
9631
|
-
* Default value is `empty string`.
|
|
9632
|
-
*/
|
|
9633
|
-
getDescription(): string;
|
|
9634
|
-
/**
|
|
9635
|
-
* @SINCE 1.88
|
|
9636
|
-
*
|
|
9637
|
-
* Gets current value of property {@link #getEnableFormattedText enableFormattedText}.
|
|
9638
|
-
*
|
|
9639
|
-
* Defines whether the value set in the `description` property is displayed as formatted text in HTML format.
|
|
9640
|
-
*
|
|
9641
|
-
* For details regarding supported HTML tags, see {@link sap.m.FormattedText}.
|
|
9642
|
-
*
|
|
9643
|
-
* Default value is `false`.
|
|
9644
|
-
*/
|
|
9645
|
-
getEnableFormattedText(): boolean;
|
|
9646
|
-
/**
|
|
9647
|
-
* @SINCE 1.88
|
|
9648
|
-
*
|
|
9649
|
-
* Gets current value of property {@link #getIllustrationSize illustrationSize}.
|
|
9650
|
-
*
|
|
9651
|
-
* Determines which illustration breakpoint variant is used.
|
|
9652
|
-
*
|
|
9653
|
-
* As `IllustratedMessage` adapts itself around the `Illustration`, the other elements of the control are
|
|
9654
|
-
* displayed differently on the different breakpoints/illustration sizes.
|
|
9655
|
-
*
|
|
9656
|
-
* Default value is `Auto`.
|
|
9657
|
-
*/
|
|
9658
|
-
getIllustrationSize():
|
|
9659
|
-
| IllustratedMessageSize
|
|
9660
|
-
| keyof typeof IllustratedMessageSize;
|
|
9661
|
-
/**
|
|
9662
|
-
* @SINCE 1.88
|
|
9663
|
-
*
|
|
9664
|
-
* Gets current value of property {@link #getIllustrationType illustrationType}.
|
|
9665
|
-
*
|
|
9666
|
-
* Determines which illustration type is displayed.
|
|
9667
|
-
*
|
|
9668
|
-
* **Note:** The {@link sap.f.IllustratedMessageType} enumeration contains a default illustration set. If
|
|
9669
|
-
* you want to use another illustration set, you have to register it in the {@link sap.f.IllustrationPool}.
|
|
9670
|
-
*
|
|
9671
|
-
* Example input for the `illustrationType` property is `sapIllus-UnableToLoad`. The logic behind this format
|
|
9672
|
-
* is as follows:
|
|
9673
|
-
* - First is the the illustration set - sapIllus
|
|
9674
|
-
* - Second is the illustration type - UnableToLoad
|
|
9675
|
-
*
|
|
9676
|
-
* Default value is `IllustratedMessageType.NoSearchResults`.
|
|
9677
|
-
*/
|
|
9678
|
-
getIllustrationType(): string;
|
|
9679
|
-
/**
|
|
9680
|
-
* @SINCE 1.88
|
|
9681
|
-
*
|
|
9682
|
-
* Gets current value of property {@link #getTitle title}.
|
|
9683
|
-
*
|
|
9684
|
-
* Defines the title that is displayed below the illustration.
|
|
9685
|
-
*
|
|
9686
|
-
* If there is no initial input from the app developer and the default illustration set is being used, a
|
|
9687
|
-
* default title is displayed corresponding to the current `illustrationType`.
|
|
9688
|
-
*
|
|
9689
|
-
* Default value is `empty string`.
|
|
9690
|
-
*/
|
|
9691
|
-
getTitle(): string;
|
|
9692
|
-
/**
|
|
9693
|
-
* @SINCE 1.88
|
|
9694
|
-
*
|
|
9695
|
-
* Checks for the provided `sap.m.Button` in the aggregation {@link #getAdditionalContent additionalContent}.
|
|
9696
|
-
* and returns its index if found or -1 otherwise.
|
|
9697
|
-
*/
|
|
9698
|
-
indexOfAdditionalContent(
|
|
9699
|
-
/**
|
|
9700
|
-
* The additionalContent whose index is looked for
|
|
9701
|
-
*/
|
|
9702
|
-
oAdditionalContent: Button
|
|
9703
|
-
): int;
|
|
9704
|
-
/**
|
|
9705
|
-
* @SINCE 1.88
|
|
9706
|
-
*
|
|
9707
|
-
* Inserts a additionalContent into the aggregation {@link #getAdditionalContent additionalContent}.
|
|
9708
|
-
*/
|
|
9709
|
-
insertAdditionalContent(
|
|
9710
|
-
/**
|
|
9711
|
-
* The additionalContent to insert; if empty, nothing is inserted
|
|
9712
|
-
*/
|
|
9713
|
-
oAdditionalContent: Button,
|
|
9714
|
-
/**
|
|
9715
|
-
* The `0`-based index the additionalContent should be inserted at; for a negative value of `iIndex`, the
|
|
9716
|
-
* additionalContent is inserted at position 0; for a value greater than the current size of the aggregation,
|
|
9717
|
-
* the additionalContent is inserted at the last position
|
|
9718
|
-
*/
|
|
9719
|
-
iIndex: int
|
|
9720
|
-
): this;
|
|
9721
|
-
/**
|
|
9722
|
-
* @SINCE 1.88
|
|
9723
|
-
*
|
|
9724
|
-
* Removes a additionalContent from the aggregation {@link #getAdditionalContent additionalContent}.
|
|
9725
|
-
*/
|
|
9726
|
-
removeAdditionalContent(
|
|
9727
|
-
/**
|
|
9728
|
-
* The additionalContent to remove or its index or id
|
|
9729
|
-
*/
|
|
9730
|
-
vAdditionalContent: int | string | Button
|
|
9731
|
-
): Button;
|
|
9732
|
-
/**
|
|
9733
|
-
* @SINCE 1.88
|
|
9734
|
-
*
|
|
9735
|
-
* Removes all the controls from the aggregation {@link #getAdditionalContent additionalContent}.
|
|
9736
|
-
*
|
|
9737
|
-
* Additionally, it unregisters them from the hosting UIArea.
|
|
9738
|
-
*/
|
|
9739
|
-
removeAllAdditionalContent(): Button[];
|
|
9740
|
-
/**
|
|
9741
|
-
* @SINCE 1.88
|
|
9742
|
-
*
|
|
9743
|
-
* Sets a new value for property {@link #getDescription description}.
|
|
9744
|
-
*
|
|
9745
|
-
* Defines the description displayed below the title.
|
|
9746
|
-
*
|
|
9747
|
-
* If there is no initial input from the app developer and the default illustration set is being used, a
|
|
9748
|
-
* default description for the current illustration type is going to be displayed. The default description
|
|
9749
|
-
* is stored in the `sap.f` resource bundle.
|
|
9750
|
-
*
|
|
9751
|
-
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
9752
|
-
*
|
|
9753
|
-
* Default value is `empty string`.
|
|
9754
|
-
*/
|
|
9755
|
-
setDescription(
|
|
9756
|
-
/**
|
|
9757
|
-
* New value for property `description`
|
|
9758
|
-
*/
|
|
9759
|
-
sDescription?: string
|
|
9760
|
-
): this;
|
|
9761
|
-
/**
|
|
9762
|
-
* @SINCE 1.88
|
|
9763
|
-
*
|
|
9764
|
-
* Sets a new value for property {@link #getEnableFormattedText enableFormattedText}.
|
|
9765
|
-
*
|
|
9766
|
-
* Defines whether the value set in the `description` property is displayed as formatted text in HTML format.
|
|
9767
|
-
*
|
|
9768
|
-
* For details regarding supported HTML tags, see {@link sap.m.FormattedText}.
|
|
9769
|
-
*
|
|
9770
|
-
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
9771
|
-
*
|
|
9772
|
-
* Default value is `false`.
|
|
9773
|
-
*/
|
|
9774
|
-
setEnableFormattedText(
|
|
9775
|
-
/**
|
|
9776
|
-
* New value for property `enableFormattedText`
|
|
9777
|
-
*/
|
|
9778
|
-
bEnableFormattedText?: boolean
|
|
9779
|
-
): this;
|
|
9780
|
-
/**
|
|
9781
|
-
* @SINCE 1.88
|
|
9782
|
-
*
|
|
9783
|
-
* Sets a new value for property {@link #getIllustrationSize illustrationSize}.
|
|
9784
|
-
*
|
|
9785
|
-
* Determines which illustration breakpoint variant is used.
|
|
9786
|
-
*
|
|
9787
|
-
* As `IllustratedMessage` adapts itself around the `Illustration`, the other elements of the control are
|
|
9788
|
-
* displayed differently on the different breakpoints/illustration sizes.
|
|
9789
|
-
*
|
|
9790
|
-
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
9791
|
-
*
|
|
9792
|
-
* Default value is `Auto`.
|
|
9793
|
-
*/
|
|
9794
|
-
setIllustrationSize(
|
|
9795
|
-
/**
|
|
9796
|
-
* New value for property `illustrationSize`
|
|
9797
|
-
*/
|
|
9798
|
-
sIllustrationSize?:
|
|
9799
|
-
| IllustratedMessageSize
|
|
9800
|
-
| keyof typeof IllustratedMessageSize
|
|
9801
|
-
): this;
|
|
9802
|
-
/**
|
|
9803
|
-
* @SINCE 1.88
|
|
9804
|
-
*
|
|
9805
|
-
* Sets a new value for property {@link #getTitle title}.
|
|
9806
|
-
*
|
|
9807
|
-
* Defines the title that is displayed below the illustration.
|
|
9808
|
-
*
|
|
9809
|
-
* If there is no initial input from the app developer and the default illustration set is being used, a
|
|
9810
|
-
* default title is displayed corresponding to the current `illustrationType`.
|
|
9811
|
-
*
|
|
9812
|
-
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
9813
|
-
*
|
|
9814
|
-
* Default value is `empty string`.
|
|
9815
|
-
*/
|
|
9816
|
-
setTitle(
|
|
9817
|
-
/**
|
|
9818
|
-
* New value for property `title`
|
|
9819
|
-
*/
|
|
9820
|
-
sTitle?: string
|
|
9821
|
-
): this;
|
|
9822
9621
|
}
|
|
9823
9622
|
|
|
9824
|
-
export interface $IllustratedMessageSettings
|
|
9825
|
-
|
|
9826
|
-
* @SINCE 1.88
|
|
9827
|
-
*
|
|
9828
|
-
* Defines the description displayed below the title.
|
|
9829
|
-
*
|
|
9830
|
-
* If there is no initial input from the app developer and the default illustration set is being used, a
|
|
9831
|
-
* default description for the current illustration type is going to be displayed. The default description
|
|
9832
|
-
* is stored in the `sap.f` resource bundle.
|
|
9833
|
-
*/
|
|
9834
|
-
description?: string | PropertyBindingInfo;
|
|
9835
|
-
|
|
9836
|
-
/**
|
|
9837
|
-
* @SINCE 1.88
|
|
9838
|
-
*
|
|
9839
|
-
* Defines whether the value set in the `description` property is displayed as formatted text in HTML format.
|
|
9840
|
-
*
|
|
9841
|
-
* For details regarding supported HTML tags, see {@link sap.m.FormattedText}.
|
|
9842
|
-
*/
|
|
9843
|
-
enableFormattedText?: boolean | PropertyBindingInfo;
|
|
9844
|
-
|
|
9845
|
-
/**
|
|
9846
|
-
* @SINCE 1.88
|
|
9847
|
-
*
|
|
9848
|
-
* Determines which illustration breakpoint variant is used.
|
|
9849
|
-
*
|
|
9850
|
-
* As `IllustratedMessage` adapts itself around the `Illustration`, the other elements of the control are
|
|
9851
|
-
* displayed differently on the different breakpoints/illustration sizes.
|
|
9852
|
-
*/
|
|
9853
|
-
illustrationSize?:
|
|
9854
|
-
| (IllustratedMessageSize | keyof typeof IllustratedMessageSize)
|
|
9855
|
-
| PropertyBindingInfo;
|
|
9856
|
-
|
|
9857
|
-
/**
|
|
9858
|
-
* @SINCE 1.88
|
|
9859
|
-
*
|
|
9860
|
-
* Determines which illustration type is displayed.
|
|
9861
|
-
*
|
|
9862
|
-
* **Note:** The {@link sap.f.IllustratedMessageType} enumeration contains a default illustration set. If
|
|
9863
|
-
* you want to use another illustration set, you have to register it in the {@link sap.f.IllustrationPool}.
|
|
9864
|
-
*
|
|
9865
|
-
* Example input for the `illustrationType` property is `sapIllus-UnableToLoad`. The logic behind this format
|
|
9866
|
-
* is as follows:
|
|
9867
|
-
* - First is the the illustration set - sapIllus
|
|
9868
|
-
* - Second is the illustration type - UnableToLoad
|
|
9869
|
-
*/
|
|
9870
|
-
illustrationType?: string | PropertyBindingInfo;
|
|
9871
|
-
|
|
9872
|
-
/**
|
|
9873
|
-
* @SINCE 1.88
|
|
9874
|
-
*
|
|
9875
|
-
* Defines the title that is displayed below the illustration.
|
|
9876
|
-
*
|
|
9877
|
-
* If there is no initial input from the app developer and the default illustration set is being used, a
|
|
9878
|
-
* default title is displayed corresponding to the current `illustrationType`.
|
|
9879
|
-
*/
|
|
9880
|
-
title?: string | PropertyBindingInfo;
|
|
9881
|
-
|
|
9882
|
-
/**
|
|
9883
|
-
* @SINCE 1.88
|
|
9884
|
-
*
|
|
9885
|
-
* Defines the controls placed below the description as additional content.
|
|
9886
|
-
*
|
|
9887
|
-
* **Note:** Not displayed when `illustrationSize` is set to `Base`.
|
|
9888
|
-
*/
|
|
9889
|
-
additionalContent?: Button[] | Button | AggregationBindingInfo;
|
|
9890
|
-
}
|
|
9623
|
+
export interface $IllustratedMessageSettings
|
|
9624
|
+
extends $IllustratedMessageSettings1 {}
|
|
9891
9625
|
}
|
|
9892
9626
|
|
|
9893
9627
|
declare module "sap/f/Illustration" {
|
|
9894
|
-
import {
|
|
9628
|
+
import {
|
|
9629
|
+
default as Illustration1,
|
|
9630
|
+
$IllustrationSettings as $IllustrationSettings1,
|
|
9631
|
+
} from "sap/m/Illustration";
|
|
9895
9632
|
|
|
9896
9633
|
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
9897
9634
|
|
|
9898
|
-
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
9899
|
-
|
|
9900
9635
|
/**
|
|
9901
9636
|
* @SINCE 1.88
|
|
9902
|
-
* @
|
|
9637
|
+
* @deprecated (since 1.98) - Use the {@link sap.m.Illustration} instead.
|
|
9903
9638
|
*
|
|
9904
9639
|
* A simple control which uses a Symbol ID to visualize an SVG which has already been loaded in the {@link
|
|
9905
9640
|
* sap.f.IllustrationPool}.
|
|
9906
9641
|
*
|
|
9907
9642
|
* To build a Symbol ID, all of the `Illustration` properties must be populated with data.
|
|
9908
9643
|
*/
|
|
9909
|
-
export default class Illustration extends
|
|
9644
|
+
export default class Illustration extends Illustration1 {
|
|
9910
9645
|
/**
|
|
9911
9646
|
* Constructor for a new `Illustration`.
|
|
9912
9647
|
*
|
|
9913
9648
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
9914
9649
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
9915
9650
|
* of the syntax of the settings object.
|
|
9651
|
+
*
|
|
9652
|
+
* This class does not have its own settings, but all settings applicable to the base type {@link sap.m.Illustration#constructor
|
|
9653
|
+
* sap.m.Illustration} can be used.
|
|
9916
9654
|
*/
|
|
9917
9655
|
constructor(
|
|
9918
9656
|
/**
|
|
@@ -9926,6 +9664,9 @@ declare module "sap/f/Illustration" {
|
|
|
9926
9664
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
9927
9665
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
9928
9666
|
* of the syntax of the settings object.
|
|
9667
|
+
*
|
|
9668
|
+
* This class does not have its own settings, but all settings applicable to the base type {@link sap.m.Illustration#constructor
|
|
9669
|
+
* sap.m.Illustration} can be used.
|
|
9929
9670
|
*/
|
|
9930
9671
|
constructor(
|
|
9931
9672
|
/**
|
|
@@ -9942,7 +9683,7 @@ declare module "sap/f/Illustration" {
|
|
|
9942
9683
|
* Creates a new subclass of class sap.f.Illustration with name `sClassName` and enriches it with the information
|
|
9943
9684
|
* contained in `oClassInfo`.
|
|
9944
9685
|
*
|
|
9945
|
-
* `oClassInfo` might contain the same kind of information as described in {@link sap.
|
|
9686
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.m.Illustration.extend}.
|
|
9946
9687
|
*/
|
|
9947
9688
|
static extend<T extends Record<string, unknown>>(
|
|
9948
9689
|
/**
|
|
@@ -9963,167 +9704,33 @@ declare module "sap/f/Illustration" {
|
|
|
9963
9704
|
* Returns a metadata object for class sap.f.Illustration.
|
|
9964
9705
|
*/
|
|
9965
9706
|
static getMetadata(): ElementMetadata;
|
|
9966
|
-
/**
|
|
9967
|
-
* @SINCE 1.88
|
|
9968
|
-
*
|
|
9969
|
-
* Gets current value of property {@link #getMedia media}.
|
|
9970
|
-
*
|
|
9971
|
-
* Defines which media/breakpoint should be used when building the Symbol ID.
|
|
9972
|
-
*/
|
|
9973
|
-
getMedia(): string;
|
|
9974
|
-
/**
|
|
9975
|
-
* @SINCE 1.88
|
|
9976
|
-
*
|
|
9977
|
-
* Gets current value of property {@link #getSet set}.
|
|
9978
|
-
*
|
|
9979
|
-
* Defines which illustration set should be used when building the Symbol ID.
|
|
9980
|
-
*/
|
|
9981
|
-
getSet(): string;
|
|
9982
|
-
/**
|
|
9983
|
-
* @SINCE 1.88
|
|
9984
|
-
*
|
|
9985
|
-
* Gets current value of property {@link #getType type}.
|
|
9986
|
-
*
|
|
9987
|
-
* Defines which illustration type should be used when building the Symbol ID.
|
|
9988
|
-
*/
|
|
9989
|
-
getType(): string;
|
|
9990
|
-
/**
|
|
9991
|
-
* @SINCE 1.88
|
|
9992
|
-
*
|
|
9993
|
-
* Sets a new value for property {@link #getMedia media}.
|
|
9994
|
-
*
|
|
9995
|
-
* Defines which media/breakpoint should be used when building the Symbol ID.
|
|
9996
|
-
*
|
|
9997
|
-
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
9998
|
-
*/
|
|
9999
|
-
setMedia(
|
|
10000
|
-
/**
|
|
10001
|
-
* New value for property `media`
|
|
10002
|
-
*/
|
|
10003
|
-
sMedia?: string
|
|
10004
|
-
): this;
|
|
10005
|
-
/**
|
|
10006
|
-
* @SINCE 1.88
|
|
10007
|
-
*
|
|
10008
|
-
* Sets a new value for property {@link #getSet set}.
|
|
10009
|
-
*
|
|
10010
|
-
* Defines which illustration set should be used when building the Symbol ID.
|
|
10011
|
-
*
|
|
10012
|
-
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
10013
|
-
*/
|
|
10014
|
-
setSet(
|
|
10015
|
-
/**
|
|
10016
|
-
* New value for property `set`
|
|
10017
|
-
*/
|
|
10018
|
-
sSet?: string
|
|
10019
|
-
): this;
|
|
10020
|
-
/**
|
|
10021
|
-
* @SINCE 1.88
|
|
10022
|
-
*
|
|
10023
|
-
* Sets a new value for property {@link #getType type}.
|
|
10024
|
-
*
|
|
10025
|
-
* Defines which illustration type should be used when building the Symbol ID.
|
|
10026
|
-
*
|
|
10027
|
-
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
10028
|
-
*/
|
|
10029
|
-
setType(
|
|
10030
|
-
/**
|
|
10031
|
-
* New value for property `type`
|
|
10032
|
-
*/
|
|
10033
|
-
sType?: string
|
|
10034
|
-
): this;
|
|
10035
9707
|
}
|
|
10036
9708
|
|
|
10037
|
-
export interface $IllustrationSettings extends $
|
|
10038
|
-
/**
|
|
10039
|
-
* @SINCE 1.88
|
|
10040
|
-
*
|
|
10041
|
-
* Defines which illustration set should be used when building the Symbol ID.
|
|
10042
|
-
*/
|
|
10043
|
-
set?: string | PropertyBindingInfo;
|
|
10044
|
-
|
|
10045
|
-
/**
|
|
10046
|
-
* @SINCE 1.88
|
|
10047
|
-
*
|
|
10048
|
-
* Defines which media/breakpoint should be used when building the Symbol ID.
|
|
10049
|
-
*/
|
|
10050
|
-
media?: string | PropertyBindingInfo;
|
|
10051
|
-
|
|
10052
|
-
/**
|
|
10053
|
-
* @SINCE 1.88
|
|
10054
|
-
*
|
|
10055
|
-
* Defines which illustration type should be used when building the Symbol ID.
|
|
10056
|
-
*/
|
|
10057
|
-
type?: string | PropertyBindingInfo;
|
|
10058
|
-
}
|
|
9709
|
+
export interface $IllustrationSettings extends $IllustrationSettings1 {}
|
|
10059
9710
|
}
|
|
10060
9711
|
|
|
10061
9712
|
declare module "sap/f/IllustrationPool" {
|
|
10062
9713
|
/**
|
|
10063
|
-
* @
|
|
9714
|
+
* @SINCE 1.88
|
|
9715
|
+
* @deprecated (since 1.98) - Use the {@link sap.m.IllustrationPool} instead.
|
|
10064
9716
|
*
|
|
10065
9717
|
* `IllustrationPool` loads the illustration assets (SVGs) via XMLHttpRequest requests.
|
|
10066
9718
|
*
|
|
10067
9719
|
* The successfully loaded data is kept in the DOM (div with ID `sap-illustration-pool`) in the `sap-ui-static`
|
|
10068
9720
|
* DOM element.
|
|
10069
9721
|
*
|
|
10070
|
-
* To load a given asset, register its illustration set through the {@link sap.
|
|
9722
|
+
* To load a given asset, register its illustration set through the {@link sap.m.IllustrationPool#sap.m.IllustrationPool.registerIllustrationSet
|
|
10071
9723
|
* registerIllustrationSet} API of `IllustrationPool`. The exception being the `sapIllus`, which is the
|
|
10072
9724
|
* default illustration set that is registered by default.
|
|
10073
9725
|
*
|
|
10074
9726
|
* The default behavior of `IllustrationPool` is to load/require an asset only when it's needed by using
|
|
10075
|
-
* the {@link sap.
|
|
10076
|
-
* given the option to load all of its assets.
|
|
9727
|
+
* the {@link sap.m.IllustrationPool#sap.m.IllustrationPool.loadAsset loadAsset} API. When registering the
|
|
9728
|
+
* new illustration set, you are given the option to load all of its assets.
|
|
10077
9729
|
*
|
|
10078
9730
|
* If some of the assets are not loaded initially, you can load the rest of them on a later state with the
|
|
10079
|
-
* {@link sap.
|
|
9731
|
+
* {@link sap.m.IllustrationPool#sap.m.IllustrationPool.loadRestOfTheAssets loadRestOfTheAssets} API.
|
|
10080
9732
|
*/
|
|
10081
|
-
interface IllustrationPool {
|
|
10082
|
-
/**
|
|
10083
|
-
* Loads an SVG asset depending on the input asset ID.
|
|
10084
|
-
*/
|
|
10085
|
-
loadAsset(
|
|
10086
|
-
/**
|
|
10087
|
-
* The string ID of the asset being loaded
|
|
10088
|
-
*/
|
|
10089
|
-
sAssetId: string,
|
|
10090
|
-
/**
|
|
10091
|
-
* the ID of the Illustration instance which is requiring the asset
|
|
10092
|
-
*/
|
|
10093
|
-
sInstanceId: string
|
|
10094
|
-
): void;
|
|
10095
|
-
/**
|
|
10096
|
-
* Loads the rest of the SVG assets for a given illustration set.
|
|
10097
|
-
*/
|
|
10098
|
-
loadRestOfTheAssets(
|
|
10099
|
-
/**
|
|
10100
|
-
* The illustration set, the rest of the assets should be loaded for
|
|
10101
|
-
*/
|
|
10102
|
-
sIllustrationSet: string
|
|
10103
|
-
): void;
|
|
10104
|
-
/**
|
|
10105
|
-
* Registers an illustration set, which is needed before loading any of its assets.
|
|
10106
|
-
*/
|
|
10107
|
-
registerIllustrationSet(
|
|
10108
|
-
/**
|
|
10109
|
-
* object containing the name and the path of the Illustration Set
|
|
10110
|
-
*/
|
|
10111
|
-
oConfig: {
|
|
10112
|
-
/**
|
|
10113
|
-
* Name of the Illustration Set
|
|
10114
|
-
*/
|
|
10115
|
-
setFamily: string;
|
|
10116
|
-
/**
|
|
10117
|
-
* URL Path of the Illustration Set
|
|
10118
|
-
*/
|
|
10119
|
-
setURI: string;
|
|
10120
|
-
},
|
|
10121
|
-
/**
|
|
10122
|
-
* whether or not all of the assets for the Illustration Set should be loaded once the metadata is loaded
|
|
10123
|
-
*/
|
|
10124
|
-
bLoadAllResources: boolean
|
|
10125
|
-
): void;
|
|
10126
|
-
}
|
|
9733
|
+
interface IllustrationPool {}
|
|
10127
9734
|
const IllustrationPool: IllustrationPool;
|
|
10128
9735
|
export default IllustrationPool;
|
|
10129
9736
|
}
|
|
@@ -10595,7 +10202,7 @@ declare module "sap/f/routing/Router" {
|
|
|
10595
10202
|
* The `sap.f.routing.Router` class is intended to be used with `{@link sap.f.FlexibleColumnLayout}` as
|
|
10596
10203
|
* a root control.
|
|
10597
10204
|
*
|
|
10598
|
-
* The difference to the `{@link sap.ui.core.routing.Router}` are the `
|
|
10205
|
+
* The difference to the `{@link sap.ui.core.routing.Router}` are the `level`, `transition`, and `transitionParameters`
|
|
10599
10206
|
* properties that you can specify in every Route or Target created by this router.
|
|
10600
10207
|
*
|
|
10601
10208
|
* The difference to the `{@link sap.m.routing.Router}` is the additional `layout` property that can be
|
|
@@ -10747,7 +10354,7 @@ declare module "sap/f/routing/Targets" {
|
|
|
10747
10354
|
*
|
|
10748
10355
|
* The `sap.f` extension of `Targets` also handles the triggering of page navigation when the target control
|
|
10749
10356
|
* is an `{@link sap.f.FlexibleColumnLayout}`. Other controls are also allowed, but the extra parameters
|
|
10750
|
-
* `
|
|
10357
|
+
* `level`, `transition`, and `transitionParameters` are ignored and it behaves as `{@link sap.ui.core.routing.Targets}`.
|
|
10751
10358
|
*
|
|
10752
10359
|
* When a target is displayed, dialogs are being closed. To change this, use `{@link #getTargetHandler}`
|
|
10753
10360
|
* and {@link sap.f.routing.TargetHandler#setCloseDialogs}.
|
|
@@ -10758,7 +10365,7 @@ declare module "sap/f/routing/Targets" {
|
|
|
10758
10365
|
*/
|
|
10759
10366
|
constructor(oOptions: {
|
|
10760
10367
|
/**
|
|
10761
|
-
*
|
|
10368
|
+
* the views instance will create the views of all the targets defined, so if 2 targets have the same name,
|
|
10762
10369
|
* the same instance of the view will be displayed.
|
|
10763
10370
|
*/
|
|
10764
10371
|
views: Views;
|
|
@@ -10845,13 +10452,15 @@ declare module "sap/f/routing/Targets" {
|
|
|
10845
10452
|
* {
|
|
10846
10453
|
* targets: {
|
|
10847
10454
|
* welcome: {
|
|
10848
|
-
*
|
|
10455
|
+
* type: "View",
|
|
10456
|
+
* name: "Welcome",
|
|
10849
10457
|
* viewType: "XML",
|
|
10850
10458
|
* ....
|
|
10851
10459
|
* // Other target parameters
|
|
10852
10460
|
* },
|
|
10853
10461
|
* goodbye: {
|
|
10854
|
-
*
|
|
10462
|
+
* type: "View",
|
|
10463
|
+
* name: "Bye",
|
|
10855
10464
|
* viewType: "JS",
|
|
10856
10465
|
* ....
|
|
10857
10466
|
* // Other target parameters
|
|
@@ -10867,8 +10476,14 @@ declare module "sap/f/routing/Targets" {
|
|
|
10867
10476
|
*/
|
|
10868
10477
|
anyName: {
|
|
10869
10478
|
/**
|
|
10870
|
-
*
|
|
10871
|
-
|
|
10479
|
+
* Defines whether the target creates an instance of 'View' or 'Component'.
|
|
10480
|
+
*/
|
|
10481
|
+
type: string;
|
|
10482
|
+
/**
|
|
10483
|
+
* Defines the name of the View or Component that will be created. For type 'Component', use option `usage`
|
|
10484
|
+
* instead if an owner component exists. To place the view or component into a Control, use the options
|
|
10485
|
+
* `controlAggregation` and `controlId`. Instance of View or Component will only be created once per `name`
|
|
10486
|
+
* or `usage` combined with `id`.
|
|
10872
10487
|
* ```javascript
|
|
10873
10488
|
*
|
|
10874
10489
|
*
|
|
@@ -10876,14 +10491,16 @@ declare module "sap/f/routing/Targets" {
|
|
|
10876
10491
|
* targets: {
|
|
10877
10492
|
* // If display("masterWelcome") is called, the master view will be placed in the 'MasterPages' of a control with the id splitContainter
|
|
10878
10493
|
* masterWelcome: {
|
|
10879
|
-
*
|
|
10494
|
+
* type: "View",
|
|
10495
|
+
* name: "Welcome",
|
|
10880
10496
|
* controlId: "splitContainer",
|
|
10881
10497
|
* controlAggregation: "masterPages"
|
|
10882
10498
|
* },
|
|
10883
10499
|
* // If display("detailWelcome") is called after the masterWelcome, the view will be removed from the master pages and added to the detail pages, since the same instance is used. Also the controls inside of the view will have the same state.
|
|
10884
10500
|
* detailWelcome: {
|
|
10885
10501
|
* // same view here, that's why the same instance is used
|
|
10886
|
-
*
|
|
10502
|
+
* type: "View",
|
|
10503
|
+
* name: "Welcome",
|
|
10887
10504
|
* controlId: "splitContainer",
|
|
10888
10505
|
* controlAggregation: "detailPages"
|
|
10889
10506
|
* }
|
|
@@ -10893,28 +10510,28 @@ declare module "sap/f/routing/Targets" {
|
|
|
10893
10510
|
* ```
|
|
10894
10511
|
*
|
|
10895
10512
|
*
|
|
10896
|
-
* If you want to have a second instance of the welcome view you can
|
|
10513
|
+
* If you want to have a second instance of the welcome view you can assign the targets with different ids:
|
|
10897
10514
|
*
|
|
10898
10515
|
*
|
|
10899
10516
|
* ```javascript
|
|
10900
10517
|
*
|
|
10901
10518
|
*
|
|
10902
|
-
* // Some code you execute before you display the target named 'detailWelcome':
|
|
10903
|
-
* var oView = sap.ui.view(({ viewName : "Welcome", type : sap.ui.core.mvc.ViewType.XML});
|
|
10904
|
-
* oTargets.getViews().setView("WelcomeWithAlias", oView)
|
|
10905
|
-
*
|
|
10906
10519
|
* {
|
|
10907
10520
|
* targets: {
|
|
10908
|
-
* // If display("masterWelcome") is called, the
|
|
10521
|
+
* // If display("masterWelcome") is called, the "masterWelcome" view will be placed in the 'MasterPages' of a control with the id splitContainter
|
|
10909
10522
|
* masterWelcome: {
|
|
10910
|
-
*
|
|
10523
|
+
* type: "View",
|
|
10524
|
+
* name: "Welcome",
|
|
10525
|
+
* id: "masterWelcome",
|
|
10911
10526
|
* controlId: "splitContainer",
|
|
10912
10527
|
* controlAggregation: "masterPages"
|
|
10913
10528
|
* },
|
|
10914
|
-
* // If display("detailWelcome") is called after the masterWelcome, a second instance with an own controller instance will be added in the detail pages.
|
|
10529
|
+
* // If display("detailWelcome") is called after the "masterWelcome", a second instance with an own controller instance will be added in the detail pages.
|
|
10915
10530
|
* detailWelcome: {
|
|
10916
|
-
*
|
|
10917
|
-
*
|
|
10531
|
+
* type: "View",
|
|
10532
|
+
* name: "Welcome",
|
|
10533
|
+
* // another instance will be created because a different id is used
|
|
10534
|
+
* id: "detailWelcome",
|
|
10918
10535
|
* controlId: "splitContainer",
|
|
10919
10536
|
* controlAggregation: "detailPages"
|
|
10920
10537
|
* }
|
|
@@ -10923,7 +10540,12 @@ declare module "sap/f/routing/Targets" {
|
|
|
10923
10540
|
*
|
|
10924
10541
|
* ```
|
|
10925
10542
|
*/
|
|
10926
|
-
|
|
10543
|
+
name?: string;
|
|
10544
|
+
/**
|
|
10545
|
+
* Defines the 'usage' name for 'Component' target which refers to the '/sap.ui5/componentUsages' entry
|
|
10546
|
+
* in the owner component's manifest.
|
|
10547
|
+
*/
|
|
10548
|
+
usage?: string;
|
|
10927
10549
|
/**
|
|
10928
10550
|
* The type of the view that is going to be created. These are the supported types: {@link sap.ui.core.mvc.ViewType}.
|
|
10929
10551
|
* You always have to provide a viewType except if `oOptions.config.viewType` is set or when using {@link
|
|
@@ -10931,17 +10553,17 @@ declare module "sap/f/routing/Targets" {
|
|
|
10931
10553
|
*/
|
|
10932
10554
|
viewType?: string;
|
|
10933
10555
|
/**
|
|
10934
|
-
* A prefix that is prepended in front of the `
|
|
10556
|
+
* A prefix that is prepended in front of the `name`.
|
|
10935
10557
|
*
|
|
10936
|
-
* **Example:** `
|
|
10937
|
-
*
|
|
10558
|
+
* **Example:** `name` is set to "myView" and `path` is set to "myApp" - the created view's name will be
|
|
10559
|
+
* "myApp.myView".
|
|
10938
10560
|
*/
|
|
10939
|
-
|
|
10561
|
+
path?: string;
|
|
10940
10562
|
/**
|
|
10941
|
-
* The ID of the created view. This is is prefixed with the ID of the component set to the
|
|
10942
|
-
* provided in `oOptions.views`. For details, see `{@link sap.ui.core.routing.Views#getView}`.
|
|
10563
|
+
* The ID of the created view or component. This is is prefixed with the ID of the component set to the
|
|
10564
|
+
* views instance provided in `oOptions.views`. For details, see `{@link sap.ui.core.routing.Views#getView}`.
|
|
10943
10565
|
*/
|
|
10944
|
-
|
|
10566
|
+
id?: string;
|
|
10945
10567
|
/**
|
|
10946
10568
|
* The ID of the parent of the `controlId`.
|
|
10947
10569
|
*
|
|
@@ -11030,11 +10652,13 @@ declare module "sap/f/routing/Targets" {
|
|
|
11030
10652
|
* // a reference to the app control in the rootView created by our UIComponent
|
|
11031
10653
|
* controlId: 'myApp',
|
|
11032
10654
|
* // An app has a pages aggregation where the views need to be put into
|
|
11033
|
-
* controlAggregation: 'pages'
|
|
10655
|
+
* controlAggregation: 'pages',
|
|
10656
|
+
* // all targets have type "View"
|
|
10657
|
+
* type: "View"
|
|
11034
10658
|
* },
|
|
11035
10659
|
* targets: {
|
|
11036
10660
|
* detail: {
|
|
11037
|
-
*
|
|
10661
|
+
* name: 'Detail'
|
|
11038
10662
|
* },
|
|
11039
10663
|
* secondTabContent: {
|
|
11040
10664
|
* // A reference to the detail target defined above
|
|
@@ -11044,7 +10668,7 @@ declare module "sap/f/routing/Targets" {
|
|
|
11044
10668
|
* // An IconTabFilter has an aggregation called content so we need to overwrite the pages set in the config as default.
|
|
11045
10669
|
* controlAggregation: 'content',
|
|
11046
10670
|
* // A view containing the content
|
|
11047
|
-
*
|
|
10671
|
+
* name: 'SecondTabContent'
|
|
11048
10672
|
* }
|
|
11049
10673
|
* }
|
|
11050
10674
|
* });
|
|
@@ -11061,11 +10685,11 @@ declare module "sap/f/routing/Targets" {
|
|
|
11061
10685
|
/**
|
|
11062
10686
|
* If you are having an application that has a logical order of views (eg: a create account process, first
|
|
11063
10687
|
* provide user data, then review and confirm them). You always want to show a backwards transition if a
|
|
11064
|
-
* navigation from the confirm to the userData page takes place. Therefore you may use the
|
|
11065
|
-
*
|
|
11066
|
-
*
|
|
11067
|
-
*
|
|
11068
|
-
*
|
|
10688
|
+
* navigation from the confirm to the userData page takes place. Therefore you may use the `level`. The
|
|
10689
|
+
* `level` has to be an integer. The user data page should have a lower number than the confirm page. These
|
|
10690
|
+
* levels should represent the user process of your application and they do not have to match the container
|
|
10691
|
+
* structure of your Targets. If the user navigates between targets with the same `level`, a forward transition
|
|
10692
|
+
* is taken. If you pass a direction into the display function, the `level` will be ignored.
|
|
11069
10693
|
*
|
|
11070
10694
|
* **Example:**
|
|
11071
10695
|
*
|
|
@@ -11076,15 +10700,15 @@ declare module "sap/f/routing/Targets" {
|
|
|
11076
10700
|
* {
|
|
11077
10701
|
* targets: {
|
|
11078
10702
|
* startPage: {
|
|
11079
|
-
*
|
|
10703
|
+
* level: 0
|
|
11080
10704
|
* // more properties
|
|
11081
10705
|
* },
|
|
11082
10706
|
* userData: {
|
|
11083
|
-
*
|
|
10707
|
+
* level: 1
|
|
11084
10708
|
* // more properties
|
|
11085
10709
|
* },
|
|
11086
10710
|
* confirmRegistration: {
|
|
11087
|
-
*
|
|
10711
|
+
* level: 2
|
|
11088
10712
|
* // more properties
|
|
11089
10713
|
* },
|
|
11090
10714
|
* settings: {
|
|
@@ -11097,14 +10721,14 @@ declare module "sap/f/routing/Targets" {
|
|
|
11097
10721
|
*
|
|
11098
10722
|
*
|
|
11099
10723
|
* Currently the 'userData' target is displayed.
|
|
11100
|
-
* - If we navigate to 'startPage' the navContainer will show a backwards navigation, since the
|
|
10724
|
+
* - If we navigate to 'startPage' the navContainer will show a backwards navigation, since the `level`
|
|
11101
10725
|
* is lower.
|
|
11102
|
-
* - If we navigate to 'userData' the navContainer will show a forwards navigation, since the
|
|
10726
|
+
* - If we navigate to 'userData' the navContainer will show a forwards navigation, since the `level`
|
|
11103
10727
|
* is higher.
|
|
11104
|
-
* - If we navigate to 'settings' the navContainer will show a forwards navigation, since the
|
|
10728
|
+
* - If we navigate to 'settings' the navContainer will show a forwards navigation, since the `level`
|
|
11105
10729
|
* is not defined and cannot be compared.
|
|
11106
10730
|
*/
|
|
11107
|
-
|
|
10731
|
+
level?: int;
|
|
11108
10732
|
/**
|
|
11109
10733
|
* Defines which transition of the {@link sap.m.NavContainer} is applied when navigating. If it is not defined,
|
|
11110
10734
|
* the `NavContainer` take its default transition.
|