@sapui5/ts-types-esm 1.131.1 → 1.132.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/types/index.d.ts +7 -7
- package/types/sap.apf.d.ts +1 -1
- package/types/sap.ca.ui.d.ts +1 -1
- package/types/sap.chart.d.ts +1 -1
- package/types/sap.collaboration.d.ts +1 -1
- package/types/sap.cux.home.d.ts +5 -0
- package/types/sap.esh.search.ui.d.ts +35 -1
- package/types/sap.f.d.ts +103 -197
- package/types/sap.fe.base.d.ts +1 -1
- package/types/sap.fe.controls.d.ts +1 -1
- package/types/sap.fe.core.d.ts +1 -1
- package/types/sap.fe.ina.d.ts +1 -1
- package/types/sap.fe.macros.d.ts +123 -94
- package/types/sap.fe.navigation.d.ts +1 -1
- package/types/sap.fe.placeholder.d.ts +1 -1
- package/types/sap.fe.plugins.managecache.d.ts +1 -1
- package/types/sap.fe.templates.d.ts +1 -1
- package/types/sap.fe.test.d.ts +1 -1
- package/types/sap.fe.tools.d.ts +1 -1
- package/types/sap.feedback.ui.d.ts +1 -1
- package/types/sap.gantt.d.ts +1 -1
- package/types/sap.insights.d.ts +1 -1
- package/types/{mobile-1.131.0-esm-d.ts → sap.m.d.ts} +408 -56
- package/types/sap.makit.d.ts +1 -1
- package/types/sap.me.d.ts +1 -1
- package/types/sap.ndc.d.ts +1 -1
- package/types/sap.ovp.d.ts +7 -2
- package/types/sap.rules.ui.d.ts +86 -1
- package/types/sap.sac.df.d.ts +1245 -890
- package/types/sap.suite.ui.commons.d.ts +1 -1
- package/types/sap.suite.ui.generic.template.d.ts +7 -7
- package/types/sap.suite.ui.microchart.d.ts +1 -1
- package/types/{tnt-1.131.0-esm-d.ts → sap.tnt.d.ts} +1 -1
- package/types/sap.ui.codeeditor.d.ts +1 -1
- package/types/{commons-1.131.0-esm-d.ts → sap.ui.commons.d.ts} +1 -1
- package/types/sap.ui.comp.d.ts +66 -5
- package/types/{core-1.131.0-esm-d.ts → sap.ui.core.d.ts} +363 -282
- package/types/{dt-1.131.0-esm-d.ts → sap.ui.dt.d.ts} +1 -1
- package/types/sap.ui.export.d.ts +1 -1
- package/types/sap.ui.fl.d.ts +7 -1
- package/types/sap.ui.generic.app.d.ts +5 -11
- package/types/sap.ui.generic.template.d.ts +1 -1
- package/types/sap.ui.integration.d.ts +1 -1
- package/types/sap.ui.layout.d.ts +1 -1
- package/types/{mdc-1.131.0-esm-d.ts → sap.ui.mdc.d.ts} +439 -342
- package/types/sap.ui.richtexteditor.d.ts +1 -1
- package/types/sap.ui.rta.d.ts +3 -1
- package/types/sap.ui.suite.d.ts +1 -1
- package/types/sap.ui.support.d.ts +1 -1
- package/types/sap.ui.table.d.ts +13 -1
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +25 -15
- package/types/{ux3-1.131.0-esm-d.ts → sap.ui.ux3.d.ts} +1 -1
- package/types/sap.ui.vbm.d.ts +1 -1
- package/types/sap.ui.vk.d.ts +96 -1
- package/types/sap.ui.vtm.d.ts +1 -1
- package/types/sap.ui.webc.common.d.ts +1 -1
- package/types/sap.ui.webc.fiori.d.ts +1 -1
- package/types/sap.ui.webc.main.d.ts +1 -1
- package/types/sap.uiext.inbox.d.ts +1 -1
- package/types/sap.ushell.d.ts +5 -1
- package/types/sap.ushell_abap.d.ts +1 -1
- package/types/sap.uxap.d.ts +1 -1
- package/types/sap.viz.d.ts +1 -1
- package/types/sap.webanalytics.core.d.ts +1 -1
- package/types/sap.zen.commons.d.ts +1 -1
- package/types/sap.zen.crosstab.d.ts +1 -1
- package/types/sap.zen.dsh.d.ts +1 -1
|
@@ -279,7 +279,7 @@ declare namespace sap {
|
|
|
279
279
|
"sap/ui/thirdparty/qunit-2": undefined;
|
|
280
280
|
}
|
|
281
281
|
}
|
|
282
|
-
// For Library Version: 1.
|
|
282
|
+
// For Library Version: 1.132.1
|
|
283
283
|
|
|
284
284
|
declare module "sap/base/assert" {
|
|
285
285
|
/**
|
|
@@ -1559,9 +1559,9 @@ declare module "sap/base/i18n/ResourceBundle" {
|
|
|
1559
1559
|
sKey: string,
|
|
1560
1560
|
/**
|
|
1561
1561
|
* List of parameter values which should replace the placeholders "{n}" (n is the index) in
|
|
1562
|
-
* the found locale-specific string value. Note that the replacement is done whenever `aArgs` is given
|
|
1563
|
-
* no matter whether the text contains placeholders or not and no matter whether `aArgs` contains
|
|
1564
|
-
* for n or not.
|
|
1562
|
+
* the found locale-specific string value. Note that the replacement is done whenever `aArgs` is given (not
|
|
1563
|
+
* `undefined`), no matter whether the text contains placeholders or not and no matter whether `aArgs` contains
|
|
1564
|
+
* a value for n or not.
|
|
1565
1565
|
*/
|
|
1566
1566
|
aArgs?: any[],
|
|
1567
1567
|
/**
|
|
@@ -12693,7 +12693,7 @@ declare module "sap/ui/base/Object" {
|
|
|
12693
12693
|
*
|
|
12694
12694
|
* @returns Whether the given object is an instance of the given type or of any of the given types
|
|
12695
12695
|
*/
|
|
12696
|
-
static isObjectA(
|
|
12696
|
+
static isObjectA<T extends BaseObject = BaseObject>(
|
|
12697
12697
|
/**
|
|
12698
12698
|
* Object which will be checked whether it is an instance of the given type
|
|
12699
12699
|
*/
|
|
@@ -12702,7 +12702,7 @@ declare module "sap/ui/base/Object" {
|
|
|
12702
12702
|
* Type or types to check for
|
|
12703
12703
|
*/
|
|
12704
12704
|
vTypeName: string | string[]
|
|
12705
|
-
):
|
|
12705
|
+
): oObject is T;
|
|
12706
12706
|
/**
|
|
12707
12707
|
* Destructor method for objects.
|
|
12708
12708
|
*/
|
|
@@ -14918,7 +14918,7 @@ declare module "sap/ui/core/CalendarType" {
|
|
|
14918
14918
|
/**
|
|
14919
14919
|
* The types of `Calendar`.
|
|
14920
14920
|
*
|
|
14921
|
-
* @deprecated (since 1.120) - Please use {@link module:sap/base/
|
|
14921
|
+
* @deprecated (since 1.120) - Please use {@link module:sap/base/i18n/date/CalendarType} instead.
|
|
14922
14922
|
*/
|
|
14923
14923
|
enum CalendarType {
|
|
14924
14924
|
/**
|
|
@@ -19124,11 +19124,11 @@ declare module "sap/ui/core/Control" {
|
|
|
19124
19124
|
* Note that this method can only be called when the control already has a DOM representation (it has been
|
|
19125
19125
|
* rendered before) and when the control still is assigned to a UIArea.
|
|
19126
19126
|
*
|
|
19127
|
-
* @deprecated (since 1.70) - using this method is no longer recommended, but still
|
|
19128
|
-
* updates via this method have several drawbacks: they only
|
|
19129
|
-
* (no initial rendering possible), multiple state changes
|
|
19130
|
-
* re-rendering, they might cause additional layout
|
|
19131
|
-
* async re-rendering.
|
|
19127
|
+
* @deprecated (since 1.70) - using this method is no longer recommended, but calling it still causes a
|
|
19128
|
+
* re-rendering of the control. Synchronous DOM updates via this method have several drawbacks: they only
|
|
19129
|
+
* work when the control has been rendered before (no initial rendering possible), multiple state changes
|
|
19130
|
+
* won't be combined automatically into a single re-rendering, they might cause additional layout thrashing,
|
|
19131
|
+
* standard invalidation might cause another async re-rendering.
|
|
19132
19132
|
*
|
|
19133
19133
|
* The recommended alternative is to rely on invalidation and standard re-rendering.
|
|
19134
19134
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
@@ -25064,11 +25064,11 @@ declare module "sap/ui/core/Element" {
|
|
|
25064
25064
|
/**
|
|
25065
25065
|
* This triggers immediate rerendering of its parent and thus of itself and its children.
|
|
25066
25066
|
*
|
|
25067
|
-
* @deprecated (since 1.70) - using this method is no longer recommended, but still
|
|
25068
|
-
* updates via this method have several drawbacks: they only
|
|
25069
|
-
* (no initial rendering possible), multiple state changes
|
|
25070
|
-
* re-rendering, they might cause additional layout
|
|
25071
|
-
* async re-rendering.
|
|
25067
|
+
* @deprecated (since 1.70) - using this method is no longer recommended, but calling it still causes a
|
|
25068
|
+
* re-rendering of the element. Synchronous DOM updates via this method have several drawbacks: they only
|
|
25069
|
+
* work when the control has been rendered before (no initial rendering possible), multiple state changes
|
|
25070
|
+
* won't be combined automatically into a single re-rendering, they might cause additional layout thrashing,
|
|
25071
|
+
* standard invalidation might cause another async re-rendering.
|
|
25072
25072
|
*
|
|
25073
25073
|
* The recommended alternative is to rely on invalidation and standard re-rendering.
|
|
25074
25074
|
*
|
|
@@ -26292,9 +26292,10 @@ declare module "sap/ui/core/format/DateFormat" {
|
|
|
26292
26292
|
*/
|
|
26293
26293
|
format(
|
|
26294
26294
|
/**
|
|
26295
|
-
* The date to format
|
|
26295
|
+
* The date to format. If it is `null` or `undefined` only the timezone will be formatted, any other invalid
|
|
26296
|
+
* date is formatted as empty string.
|
|
26296
26297
|
*/
|
|
26297
|
-
oJSDate
|
|
26298
|
+
oJSDate?: Date,
|
|
26298
26299
|
/**
|
|
26299
26300
|
* The IANA timezone ID in which the date will be calculated and formatted e.g. "America/New_York". If the
|
|
26300
26301
|
* parameter is omitted, `null` or an empty string, the timezone will be taken from {@link module:sap/base/i18n/Localization.getTimezone Localization.getTimezone}.
|
|
@@ -26684,6 +26685,16 @@ declare module "sap/ui/core/format/NumberFormat" {
|
|
|
26684
26685
|
* and {@link module:sap/base/i18n/Formatting.addCustomCurrencies Formatting.addCustomCurrencies}.
|
|
26685
26686
|
*/
|
|
26686
26687
|
customCurrencies?: Record<string, object>;
|
|
26688
|
+
/**
|
|
26689
|
+
* The target length of places after the decimal separator; if the number has fewer decimal places than
|
|
26690
|
+
* given in this option, it is padded with whitespaces at the end up to the target length. An additional
|
|
26691
|
+
* whitespace character for the decimal separator is added for a number without any decimals. **Note:**
|
|
26692
|
+
* This format option is only allowed if the following conditions apply:
|
|
26693
|
+
* - It has a value greater than 0.
|
|
26694
|
+
* - The `FormatOptions.showMeasure` format option is set to `false`.
|
|
26695
|
+
* - The `oFormatOptions.style` format option is **not** set to `"short"` or `"long"`.
|
|
26696
|
+
*/
|
|
26697
|
+
decimalPadding?: int;
|
|
26687
26698
|
/**
|
|
26688
26699
|
* defines the number of decimal digits
|
|
26689
26700
|
*/
|
|
@@ -26854,6 +26865,15 @@ declare module "sap/ui/core/format/NumberFormat" {
|
|
|
26854
26865
|
* to the type and locale settings are used.
|
|
26855
26866
|
*/
|
|
26856
26867
|
oFormatOptions?: {
|
|
26868
|
+
/**
|
|
26869
|
+
* The target length of places after the decimal separator; if the number has fewer decimal places than
|
|
26870
|
+
* given in this option, it is padded with whitespaces at the end up to the target length. An additional
|
|
26871
|
+
* whitespace character for the decimal separator is added for a number without any decimals. **Note:**
|
|
26872
|
+
* This format option is only allowed if the following conditions apply:
|
|
26873
|
+
* - It has a value greater than 0.
|
|
26874
|
+
* - The `oFormatOptions.style` format option is **not** set to `"short"` or `"long"`.
|
|
26875
|
+
*/
|
|
26876
|
+
decimalPadding?: int;
|
|
26857
26877
|
/**
|
|
26858
26878
|
* defines the number of decimal digits
|
|
26859
26879
|
*/
|
|
@@ -27013,6 +27033,10 @@ declare module "sap/ui/core/format/NumberFormat" {
|
|
|
27013
27033
|
* to the type and locale settings are used.
|
|
27014
27034
|
*/
|
|
27015
27035
|
oFormatOptions?: {
|
|
27036
|
+
/**
|
|
27037
|
+
* Not supported.
|
|
27038
|
+
*/
|
|
27039
|
+
decimalPadding?: int;
|
|
27016
27040
|
/**
|
|
27017
27041
|
* defines the number of decimal digits
|
|
27018
27042
|
*/
|
|
@@ -27167,6 +27191,10 @@ declare module "sap/ui/core/format/NumberFormat" {
|
|
|
27167
27191
|
* to the type and locale settings are used.
|
|
27168
27192
|
*/
|
|
27169
27193
|
oFormatOptions?: {
|
|
27194
|
+
/**
|
|
27195
|
+
* Not supported.
|
|
27196
|
+
*/
|
|
27197
|
+
decimalPadding?: int;
|
|
27170
27198
|
/**
|
|
27171
27199
|
* defines the number of decimal digits
|
|
27172
27200
|
*/
|
|
@@ -27327,6 +27355,16 @@ declare module "sap/ui/core/format/NumberFormat" {
|
|
|
27327
27355
|
* }}
|
|
27328
27356
|
*/
|
|
27329
27357
|
customUnits?: Record<string, object>;
|
|
27358
|
+
/**
|
|
27359
|
+
* The target length of places after the decimal separator; if the number has fewer decimal places than
|
|
27360
|
+
* given in this option, it is padded with whitespaces at the end up to the target length. An additional
|
|
27361
|
+
* whitespace character for the decimal separator is added for a number without any decimals. **Note:**
|
|
27362
|
+
* This format option is only allowed if the following conditions apply:
|
|
27363
|
+
* - It has a value greater than 0.
|
|
27364
|
+
* - The `FormatOptions.showMeasure` format option is set to `false`.
|
|
27365
|
+
* - The `oFormatOptions.style` format option is **not** set to `"short"` or `"long"`.
|
|
27366
|
+
*/
|
|
27367
|
+
decimalPadding?: int;
|
|
27330
27368
|
/**
|
|
27331
27369
|
* defines the number of decimal digits
|
|
27332
27370
|
*/
|
|
@@ -27733,19 +27771,26 @@ declare module "sap/ui/core/Fragment" {
|
|
|
27733
27771
|
*/
|
|
27734
27772
|
static getMetadata(): ManagedObjectMetadata;
|
|
27735
27773
|
/**
|
|
27736
|
-
* Loads and instantiates a
|
|
27774
|
+
* Loads and instantiates a fragment. Also refer to {@link https://ui5.sap.com/#/topic/04129b2798c447368f4c8922c3c33cd7 Instantiation of Fragments}.
|
|
27737
27775
|
*
|
|
27738
|
-
* The
|
|
27776
|
+
* The fragment object itself is not an entity that has any further significance beyond this factory function.
|
|
27739
27777
|
*
|
|
27740
|
-
*
|
|
27741
|
-
*
|
|
27778
|
+
* A Promise is returned, which resolves with the fragment's content.
|
|
27779
|
+
*
|
|
27780
|
+
* The Fragment types `"XML"`, `"JS"`, and `"HTML"` (type `"HTML"` is deprecated) are available by default.
|
|
27781
|
+
* Additional Fragment types can be implemented and added using the {@link sap.ui.core.Fragment.registerType }
|
|
27782
|
+
* function.
|
|
27742
27783
|
*
|
|
27743
27784
|
* Further properties may be supported by future or custom Fragment types. Any given properties will be
|
|
27744
27785
|
* forwarded to the Fragment implementation.
|
|
27745
27786
|
*
|
|
27746
|
-
* If no fixed ID is given, the
|
|
27787
|
+
* If no fixed ID is given, the fragment ID is generated. In any case, the fragment ID will be used as prefix
|
|
27747
27788
|
* for the IDs of all contained controls.
|
|
27748
27789
|
*
|
|
27790
|
+
* **Note:** In case you are embedding a Fragment into an existing View, please also have a look at the
|
|
27791
|
+
* {@link sap.ui.core.mvc.Controller.loadFragment loadFragment} factory for a closer coupling to the corresponding
|
|
27792
|
+
* Controller instance.
|
|
27793
|
+
*
|
|
27749
27794
|
* @since 1.58
|
|
27750
27795
|
*
|
|
27751
27796
|
* @returns a `Promise` resolving with the resulting control (array) after fragment parsing and instantiation
|
|
@@ -27756,34 +27801,34 @@ declare module "sap/ui/core/Fragment" {
|
|
|
27756
27801
|
*/
|
|
27757
27802
|
mOptions: {
|
|
27758
27803
|
/**
|
|
27759
|
-
* must be supplied if no
|
|
27760
|
-
* which can be loaded via the module system (fragmentName + suffix
|
|
27761
|
-
* contains the
|
|
27762
|
-
* referenced in the
|
|
27763
|
-
* to be given and certain methods to be implemented by it.
|
|
27804
|
+
* must be supplied if no `definition` parameter is given. The fragment name must correspond to an XML fragment
|
|
27805
|
+
* which can be loaded via the module system (fragmentName + suffix `.fragment.<typeExtension>`)
|
|
27806
|
+
* and which contains the fragment definition. If `mOptions.controller` is supplied, the (event handler)
|
|
27807
|
+
* methods referenced in the fragment will be called on that controller. Note that fragments may require
|
|
27808
|
+
* a controller to be given and certain methods to be implemented by it.
|
|
27764
27809
|
*/
|
|
27765
27810
|
name?: string;
|
|
27766
27811
|
/**
|
|
27767
|
-
* the
|
|
27812
|
+
* the fragment type, e.g. `"XML"`, `"JS"`, or `"HTML"` (type `"HTML"` is deprecated). Default is `"XML"`
|
|
27768
27813
|
*/
|
|
27769
27814
|
type?: string;
|
|
27770
27815
|
/**
|
|
27771
|
-
* definition of the
|
|
27816
|
+
* definition of the fragment content. When this property is supplied, the `name` parameter must not be
|
|
27772
27817
|
* used. If both are supplied, the definition has priority. Please see the above example on how to use the
|
|
27773
|
-
*
|
|
27818
|
+
* `definition` parameter.
|
|
27774
27819
|
*/
|
|
27775
27820
|
definition?: string;
|
|
27776
27821
|
/**
|
|
27777
|
-
* the ID of the
|
|
27822
|
+
* the ID of the fragment
|
|
27778
27823
|
*/
|
|
27779
27824
|
id?: string;
|
|
27780
27825
|
/**
|
|
27781
|
-
* the
|
|
27782
|
-
* may not need a
|
|
27826
|
+
* the controller or object which should be used by the controls in the fragment. Note that some fragments
|
|
27827
|
+
* may not need a controller while others may need one and certain methods to be implemented by it.
|
|
27783
27828
|
*/
|
|
27784
|
-
controller?: Controller |
|
|
27829
|
+
controller?: Controller | object;
|
|
27785
27830
|
/**
|
|
27786
|
-
* The view containing the
|
|
27831
|
+
* The view containing the fragment content. If the fragment content contains `ExtensionPoint`s, this parameter
|
|
27787
27832
|
* must be given.
|
|
27788
27833
|
*/
|
|
27789
27834
|
containingView?: View;
|
|
@@ -50503,6 +50548,10 @@ declare module "sap/ui/Device" {
|
|
|
50503
50548
|
* The version of the operating system as `float`.
|
|
50504
50549
|
*
|
|
50505
50550
|
* Might be `-1` if no version can reliably be determined.
|
|
50551
|
+
*
|
|
50552
|
+
* **Note:** The property `version` may not contain the correct version for Windows 11 onwards, depending
|
|
50553
|
+
* on the point in time, the property is accessed or the browser's capability to provide the version. In
|
|
50554
|
+
* this case the `version` property may contain `10`.
|
|
50506
50555
|
*/
|
|
50507
50556
|
export const version: float;
|
|
50508
50557
|
|
|
@@ -50510,6 +50559,10 @@ declare module "sap/ui/Device" {
|
|
|
50510
50559
|
* The version of the operating system as `string`.
|
|
50511
50560
|
*
|
|
50512
50561
|
* Might be empty if no version can reliably be determined.
|
|
50562
|
+
*
|
|
50563
|
+
* **Note:** The property `versionStr` may not contain the correct version for Windows 11 onwards, depending
|
|
50564
|
+
* on the point in time, the property is accessed or the browser's capability to provide the version. In
|
|
50565
|
+
* this case the `versionStr` property may contain `10`.
|
|
50513
50566
|
*/
|
|
50514
50567
|
export const versionStr: string;
|
|
50515
50568
|
|
|
@@ -53610,6 +53663,8 @@ declare module "sap/ui/model/Binding" {
|
|
|
53610
53663
|
* otherwise it will be bound to this `sap.ui.model.Binding` itself.
|
|
53611
53664
|
*
|
|
53612
53665
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
53666
|
+
*
|
|
53667
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
53613
53668
|
*/
|
|
53614
53669
|
attachAggregatedDataStateChange(
|
|
53615
53670
|
/**
|
|
@@ -53620,12 +53675,15 @@ declare module "sap/ui/model/Binding" {
|
|
|
53620
53675
|
* Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
|
|
53621
53676
|
*/
|
|
53622
53677
|
oListener?: object
|
|
53623
|
-
):
|
|
53678
|
+
): this;
|
|
53624
53679
|
/**
|
|
53625
53680
|
* Attaches the `fnFunction` event handler to the {@link #event:change change} event of this `sap.ui.model.Model`.
|
|
53626
53681
|
*
|
|
53627
53682
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
53628
53683
|
* otherwise it will be bound to this `sap.ui.model.Binding` itself.
|
|
53684
|
+
*
|
|
53685
|
+
*
|
|
53686
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
53629
53687
|
*/
|
|
53630
53688
|
attachChange(
|
|
53631
53689
|
/**
|
|
@@ -53636,12 +53694,15 @@ declare module "sap/ui/model/Binding" {
|
|
|
53636
53694
|
* Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
|
|
53637
53695
|
*/
|
|
53638
53696
|
oListener?: object
|
|
53639
|
-
):
|
|
53697
|
+
): this;
|
|
53640
53698
|
/**
|
|
53641
53699
|
* Attaches event handler `fnFunction` to the {@link #event:dataReceived dataReceived} event of this `sap.ui.model.Binding`.
|
|
53642
53700
|
*
|
|
53643
53701
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
53644
53702
|
* otherwise it will be bound to this `sap.ui.model.Binding` itself.
|
|
53703
|
+
*
|
|
53704
|
+
*
|
|
53705
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
53645
53706
|
*/
|
|
53646
53707
|
attachDataReceived(
|
|
53647
53708
|
/**
|
|
@@ -53652,12 +53713,15 @@ declare module "sap/ui/model/Binding" {
|
|
|
53652
53713
|
* Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
|
|
53653
53714
|
*/
|
|
53654
53715
|
oListener?: object
|
|
53655
|
-
):
|
|
53716
|
+
): this;
|
|
53656
53717
|
/**
|
|
53657
53718
|
* Attaches event handler `fnFunction` to the {@link #event:dataRequested dataRequested} event of this `sap.ui.model.Binding`.
|
|
53658
53719
|
*
|
|
53659
53720
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
53660
53721
|
* otherwise it will be bound to this `sap.ui.model.Binding` itself.
|
|
53722
|
+
*
|
|
53723
|
+
*
|
|
53724
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
53661
53725
|
*/
|
|
53662
53726
|
attachDataRequested(
|
|
53663
53727
|
/**
|
|
@@ -53668,7 +53732,7 @@ declare module "sap/ui/model/Binding" {
|
|
|
53668
53732
|
* Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
|
|
53669
53733
|
*/
|
|
53670
53734
|
oListener?: object
|
|
53671
|
-
):
|
|
53735
|
+
): this;
|
|
53672
53736
|
/**
|
|
53673
53737
|
* Attaches the `fnFunction` event handler to the {@link #event:DataStateChange DataStateChange} event of
|
|
53674
53738
|
* thi `sap.ui.model.Binding`.
|
|
@@ -53677,6 +53741,8 @@ declare module "sap/ui/model/Binding" {
|
|
|
53677
53741
|
* otherwise it will be bound to this `sap.ui.model.Binding` itself.
|
|
53678
53742
|
*
|
|
53679
53743
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
53744
|
+
*
|
|
53745
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
53680
53746
|
*/
|
|
53681
53747
|
attachDataStateChange(
|
|
53682
53748
|
/**
|
|
@@ -53687,7 +53753,7 @@ declare module "sap/ui/model/Binding" {
|
|
|
53687
53753
|
* Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
|
|
53688
53754
|
*/
|
|
53689
53755
|
oListener?: object
|
|
53690
|
-
):
|
|
53756
|
+
): this;
|
|
53691
53757
|
/**
|
|
53692
53758
|
* Attach multiple events.
|
|
53693
53759
|
*
|
|
@@ -53713,6 +53779,8 @@ declare module "sap/ui/model/Binding" {
|
|
|
53713
53779
|
* event of this `sap.ui.model.Binding`.
|
|
53714
53780
|
*
|
|
53715
53781
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
53782
|
+
*
|
|
53783
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
53716
53784
|
*/
|
|
53717
53785
|
detachAggregatedDataStateChange(
|
|
53718
53786
|
/**
|
|
@@ -53723,9 +53791,12 @@ declare module "sap/ui/model/Binding" {
|
|
|
53723
53791
|
* Context object on which the given function had to be called
|
|
53724
53792
|
*/
|
|
53725
53793
|
oListener?: object
|
|
53726
|
-
):
|
|
53794
|
+
): this;
|
|
53727
53795
|
/**
|
|
53728
53796
|
* Detaches event handler `fnFunction` from the {@link #event:change change} event of this `sap.ui.model.Binding`.
|
|
53797
|
+
*
|
|
53798
|
+
*
|
|
53799
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
53729
53800
|
*/
|
|
53730
53801
|
detachChange(
|
|
53731
53802
|
/**
|
|
@@ -53736,9 +53807,12 @@ declare module "sap/ui/model/Binding" {
|
|
|
53736
53807
|
* Context object on which the given function had to be called
|
|
53737
53808
|
*/
|
|
53738
53809
|
oListener?: object
|
|
53739
|
-
):
|
|
53810
|
+
): this;
|
|
53740
53811
|
/**
|
|
53741
53812
|
* Detaches event handler `fnFunction` from the {@link #event:dataReceived dataReceived} event of this `sap.ui.model.Binding`.
|
|
53813
|
+
*
|
|
53814
|
+
*
|
|
53815
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
53742
53816
|
*/
|
|
53743
53817
|
detachDataReceived(
|
|
53744
53818
|
/**
|
|
@@ -53749,10 +53823,13 @@ declare module "sap/ui/model/Binding" {
|
|
|
53749
53823
|
* Context object on which the given function had to be called
|
|
53750
53824
|
*/
|
|
53751
53825
|
oListener?: object
|
|
53752
|
-
):
|
|
53826
|
+
): this;
|
|
53753
53827
|
/**
|
|
53754
53828
|
* Detaches event handler `fnFunction` from the {@link #event:dataRequested dataRequested} event of this
|
|
53755
53829
|
* `sap.ui.model.Binding`.
|
|
53830
|
+
*
|
|
53831
|
+
*
|
|
53832
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
53756
53833
|
*/
|
|
53757
53834
|
detachDataRequested(
|
|
53758
53835
|
/**
|
|
@@ -53763,12 +53840,14 @@ declare module "sap/ui/model/Binding" {
|
|
|
53763
53840
|
* Context object on which the given function had to be called
|
|
53764
53841
|
*/
|
|
53765
53842
|
oListener?: object
|
|
53766
|
-
):
|
|
53843
|
+
): this;
|
|
53767
53844
|
/**
|
|
53768
53845
|
* Detaches event handler `fnFunction` from the {@link #event:DataStateChange DataStateChange} event of
|
|
53769
53846
|
* this `sap.ui.model.Binding`.
|
|
53770
53847
|
*
|
|
53771
53848
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
53849
|
+
*
|
|
53850
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
53772
53851
|
*/
|
|
53773
53852
|
detachDataStateChange(
|
|
53774
53853
|
/**
|
|
@@ -53779,7 +53858,7 @@ declare module "sap/ui/model/Binding" {
|
|
|
53779
53858
|
* Context object on which the given function had to be called
|
|
53780
53859
|
*/
|
|
53781
53860
|
oListener?: object
|
|
53782
|
-
):
|
|
53861
|
+
): this;
|
|
53783
53862
|
/**
|
|
53784
53863
|
* Detach multiple events.
|
|
53785
53864
|
*
|
|
@@ -54883,6 +54962,8 @@ declare module "sap/ui/model/CompositeBinding" {
|
|
|
54883
54962
|
* as parameter of the event contains all changes that were applied to the `DataState` in the running thread.
|
|
54884
54963
|
*
|
|
54885
54964
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
54965
|
+
*
|
|
54966
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
54886
54967
|
*/
|
|
54887
54968
|
attachAggregatedDataStateChange(
|
|
54888
54969
|
/**
|
|
@@ -54893,7 +54974,7 @@ declare module "sap/ui/model/CompositeBinding" {
|
|
|
54893
54974
|
* Object on which to call the given function
|
|
54894
54975
|
*/
|
|
54895
54976
|
oListener?: object
|
|
54896
|
-
):
|
|
54977
|
+
): this;
|
|
54897
54978
|
/**
|
|
54898
54979
|
* Attaches event handler `fnFunction` to the `change` event of this `sap.ui.model.CompositeBinding`.
|
|
54899
54980
|
*
|
|
@@ -54901,6 +54982,8 @@ declare module "sap/ui/model/CompositeBinding" {
|
|
|
54901
54982
|
* otherwise it will be bound to this `sap.ui.model.CompositeBinding` itself.
|
|
54902
54983
|
*
|
|
54903
54984
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
54985
|
+
*
|
|
54986
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
54904
54987
|
*/
|
|
54905
54988
|
attachChange(
|
|
54906
54989
|
/**
|
|
@@ -54911,7 +54994,7 @@ declare module "sap/ui/model/CompositeBinding" {
|
|
|
54911
54994
|
* Object on which to call the given function
|
|
54912
54995
|
*/
|
|
54913
54996
|
oListener?: object
|
|
54914
|
-
):
|
|
54997
|
+
): this;
|
|
54915
54998
|
/**
|
|
54916
54999
|
* Attaches event handler `fnFunction` to the `DataStateChange` event of this `sap.ui.model.CompositeBinding`.
|
|
54917
55000
|
*
|
|
@@ -54919,6 +55002,8 @@ declare module "sap/ui/model/CompositeBinding" {
|
|
|
54919
55002
|
* otherwise it will be bound to this `sap.ui.model.CompositeBinding` itself.
|
|
54920
55003
|
*
|
|
54921
55004
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
55005
|
+
*
|
|
55006
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
54922
55007
|
*/
|
|
54923
55008
|
attachDataStateChange(
|
|
54924
55009
|
/**
|
|
@@ -54929,11 +55014,13 @@ declare module "sap/ui/model/CompositeBinding" {
|
|
|
54929
55014
|
* Object on which to call the given function
|
|
54930
55015
|
*/
|
|
54931
55016
|
oListener?: object
|
|
54932
|
-
):
|
|
55017
|
+
): this;
|
|
54933
55018
|
/**
|
|
54934
55019
|
* Detaches event handler `fnFunction` from the `AggregatedDataStateChange` event of this `sap.ui.model.CompositeBinding`.
|
|
54935
55020
|
*
|
|
54936
55021
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
55022
|
+
*
|
|
55023
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
54937
55024
|
*/
|
|
54938
55025
|
detachAggregatedDataStateChange(
|
|
54939
55026
|
/**
|
|
@@ -54944,11 +55031,13 @@ declare module "sap/ui/model/CompositeBinding" {
|
|
|
54944
55031
|
* Object on which to call the given function
|
|
54945
55032
|
*/
|
|
54946
55033
|
oListener?: object
|
|
54947
|
-
):
|
|
55034
|
+
): this;
|
|
54948
55035
|
/**
|
|
54949
55036
|
* Detaches event handler `fnFunction` from the `change` event of this `sap.ui.model.CompositeBinding`.
|
|
54950
55037
|
*
|
|
54951
55038
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
55039
|
+
*
|
|
55040
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
54952
55041
|
*/
|
|
54953
55042
|
detachChange(
|
|
54954
55043
|
/**
|
|
@@ -54959,11 +55048,13 @@ declare module "sap/ui/model/CompositeBinding" {
|
|
|
54959
55048
|
* Object on which to call the given function
|
|
54960
55049
|
*/
|
|
54961
55050
|
oListener?: object
|
|
54962
|
-
):
|
|
55051
|
+
): this;
|
|
54963
55052
|
/**
|
|
54964
55053
|
* Detaches event handler `fnFunction` from the `DataStateChange` event of this `sap.ui.model.CompositeBinding`.
|
|
54965
55054
|
*
|
|
54966
55055
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
55056
|
+
*
|
|
55057
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
54967
55058
|
*/
|
|
54968
55059
|
detachDataStateChange(
|
|
54969
55060
|
/**
|
|
@@ -54974,7 +55065,7 @@ declare module "sap/ui/model/CompositeBinding" {
|
|
|
54974
55065
|
* Object on which to call the given function
|
|
54975
55066
|
*/
|
|
54976
55067
|
oListener?: object
|
|
54977
|
-
):
|
|
55068
|
+
): this;
|
|
54978
55069
|
/**
|
|
54979
55070
|
* Returns the property bindings contained in this composite binding.
|
|
54980
55071
|
*
|
|
@@ -67175,6 +67266,8 @@ declare module "sap/ui/model/odata/v2/ODataListBinding" {
|
|
|
67175
67266
|
* Attach event handler `fnFunction` to the 'createActivate' event of this binding.
|
|
67176
67267
|
*
|
|
67177
67268
|
* @since 1.98.0
|
|
67269
|
+
*
|
|
67270
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
67178
67271
|
*/
|
|
67179
67272
|
attachCreateActivate(
|
|
67180
67273
|
/**
|
|
@@ -67185,7 +67278,7 @@ declare module "sap/ui/model/odata/v2/ODataListBinding" {
|
|
|
67185
67278
|
* Object on which to call the given function
|
|
67186
67279
|
*/
|
|
67187
67280
|
oListener?: object
|
|
67188
|
-
):
|
|
67281
|
+
): this;
|
|
67189
67282
|
/**
|
|
67190
67283
|
* Creates a new entity for this binding's collection via {@link sap.ui.model.odata.v2.ODataModel#createEntry }
|
|
67191
67284
|
* using the parameters given in `mParameters` and inserts it at the list position specified by the `bAtEnd`
|
|
@@ -67256,6 +67349,8 @@ declare module "sap/ui/model/odata/v2/ODataListBinding" {
|
|
|
67256
67349
|
* Detach event handler `fnFunction` from the 'createActivate' event of this binding.
|
|
67257
67350
|
*
|
|
67258
67351
|
* @since 1.98.0
|
|
67352
|
+
*
|
|
67353
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
67259
67354
|
*/
|
|
67260
67355
|
detachCreateActivate(
|
|
67261
67356
|
/**
|
|
@@ -67266,7 +67361,7 @@ declare module "sap/ui/model/odata/v2/ODataListBinding" {
|
|
|
67266
67361
|
* Object on which to call the given function
|
|
67267
67362
|
*/
|
|
67268
67363
|
oListener?: object
|
|
67269
|
-
):
|
|
67364
|
+
): this;
|
|
67270
67365
|
/**
|
|
67271
67366
|
* Filters the list.
|
|
67272
67367
|
*
|
|
@@ -71315,7 +71410,7 @@ declare module "sap/ui/model/odata/v4/Context" {
|
|
|
71315
71410
|
*/
|
|
71316
71411
|
collapse(
|
|
71317
71412
|
/**
|
|
71318
|
-
* Whether to collapse the node and all its descendants (
|
|
71413
|
+
* Whether to collapse the node and all its descendants (since 1.132.0)
|
|
71319
71414
|
*/
|
|
71320
71415
|
bAll?: boolean
|
|
71321
71416
|
): void;
|
|
@@ -71423,8 +71518,8 @@ declare module "sap/ui/model/odata/v4/Context" {
|
|
|
71423
71518
|
*/
|
|
71424
71519
|
destroy(): void;
|
|
71425
71520
|
/**
|
|
71426
|
-
* Expands the group node that this context points to. Since 1.
|
|
71427
|
-
*
|
|
71521
|
+
* Expands the group node that this context points to. Since 1.132.0, it is possible to do a full expand,
|
|
71522
|
+
* that is to expand all levels below a node, even if a node is already partially or fully expanded.
|
|
71428
71523
|
* See:
|
|
71429
71524
|
* #collapse
|
|
71430
71525
|
* #isExpanded
|
|
@@ -71436,11 +71531,9 @@ declare module "sap/ui/model/odata/v4/Context" {
|
|
|
71436
71531
|
*/
|
|
71437
71532
|
expand(
|
|
71438
71533
|
/**
|
|
71439
|
-
*
|
|
71440
|
-
* can be used to expand all levels. If a node is expanded a second time, the expand state of the descendants
|
|
71441
|
-
* is not changed.
|
|
71534
|
+
* Whether to expand the node and all its descendants (since 1.132.0)
|
|
71442
71535
|
*/
|
|
71443
|
-
|
|
71536
|
+
bAll?: boolean
|
|
71444
71537
|
): Promise<void>;
|
|
71445
71538
|
/**
|
|
71446
71539
|
* Returns the binding this context belongs to.
|
|
@@ -71816,9 +71909,8 @@ declare module "sap/ui/model/odata/v4/Context" {
|
|
|
71816
71909
|
* @since 1.122.0
|
|
71817
71910
|
*
|
|
71818
71911
|
* @returns A promise which:
|
|
71819
|
-
*
|
|
71820
|
-
*
|
|
71821
|
-
* - Rejects with an `Error` instance otherwise
|
|
71912
|
+
* Resolves if successful with either the parent node or `null` for a root node that has no parent
|
|
71913
|
+
* Rejects with an `Error` instance otherwise
|
|
71822
71914
|
*/
|
|
71823
71915
|
requestParent(): Promise<Context | null>;
|
|
71824
71916
|
/**
|
|
@@ -72483,7 +72575,8 @@ declare module "sap/ui/model/odata/v4/ODataContextBinding" {
|
|
|
72483
72575
|
sGroupId?: string,
|
|
72484
72576
|
/**
|
|
72485
72577
|
* Whether the entity's ETag should be actively ignored (If-Match:*); supported for bound actions only,
|
|
72486
|
-
* since 1.90.0.
|
|
72578
|
+
* since 1.90.0. This parameter is ignored if there is no ETag (since 1.93.0) unless no data has been read
|
|
72579
|
+
* so far (since 1.132.0).
|
|
72487
72580
|
*/
|
|
72488
72581
|
bIgnoreETag?: boolean,
|
|
72489
72582
|
/**
|
|
@@ -73713,7 +73806,9 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
|
|
|
73713
73806
|
group?: object;
|
|
73714
73807
|
/**
|
|
73715
73808
|
* A list of groupable property names used to determine group levels. They may, but don't need to, be repeated
|
|
73716
|
-
* in `oAggregation.group`.
|
|
73809
|
+
* in `oAggregation.group`. Since 1.132.0, the last group level is interpreted as the leaf level in case
|
|
73810
|
+
* there are no other groups than those given here. In that case, {@link #getAggregation} returns a shorter
|
|
73811
|
+
* `groupLevels` list. Group levels cannot be combined with:
|
|
73717
73812
|
* filtering for aggregated properties, "$search" (since 1.93.0), the `vGroup` parameter of
|
|
73718
73813
|
* {@link sap.ui.model.Sorter} (since 1.107.0), shared requests (since 1.108.0).
|
|
73719
73814
|
*/
|
|
@@ -74807,7 +74902,9 @@ declare module "sap/ui/model/odata/v4/ODataMetaModel" {
|
|
|
74807
74902
|
* via {@link sap.ui.model.odata.v4.ODataModel#getHttpHeaders} from this meta model's data model. Since
|
|
74808
74903
|
* 1.80.0, that model's parameter "sharedRequests" is set automatically (see {@link sap.ui.model.odata.v4.ODataModel#constructor}).
|
|
74809
74904
|
* If the value list model is the data model associated with this meta model, use the binding-specific parameter
|
|
74810
|
-
* "$$sharedRequest" instead, see {@link sap.ui.model.odata.v4.ODataModel#bindList}.
|
|
74905
|
+
* "$$sharedRequest" instead, see {@link sap.ui.model.odata.v4.ODataModel#bindList}. Since 1.132.0, the
|
|
74906
|
+
* data model's {@link sap.ui.model.odata.v4.ODataModel#setRetryAfterHandler "Retry-After" handler} is reused
|
|
74907
|
+
* by default, but can of course be overwritten.
|
|
74811
74908
|
*
|
|
74812
74909
|
* For fixed values, only one mapping is expected and the qualifier is ignored. The mapping is available
|
|
74813
74910
|
* with key "" and has an additional property "$qualifier" which is the original qualifier (useful in case
|
|
@@ -79397,6 +79494,11 @@ declare module "sap/ui/model/type/Unit" {
|
|
|
79397
79494
|
* parameter is not set manually.
|
|
79398
79495
|
*/
|
|
79399
79496
|
oFormatOptions?: {
|
|
79497
|
+
/**
|
|
79498
|
+
* The number of decimals to be used for formatting the number part of the unit; defaults to **3** if none
|
|
79499
|
+
* of the format options `maxFractionDigits`, `minFractionDigits` or `decimals` is given
|
|
79500
|
+
*/
|
|
79501
|
+
decimals?: object;
|
|
79400
79502
|
/**
|
|
79401
79503
|
* By default decimals are preserved, unless `oFormatOptions.style` is given as "short" or "long"; since
|
|
79402
79504
|
* 1.89.0
|
|
@@ -86071,50 +86173,84 @@ declare namespace sap {
|
|
|
86071
86173
|
| Array<import("sap/ui/core/Control").default>
|
|
86072
86174
|
| Promise<Array<import("sap/ui/core/Control").default>>;
|
|
86073
86175
|
/**
|
|
86074
|
-
*
|
|
86075
|
-
*
|
|
86176
|
+
* Loads and instantiates a fragment. The fragment object itself is not an entity that has any further significance
|
|
86177
|
+
* beyond this factory function.
|
|
86076
86178
|
*
|
|
86077
|
-
* To instantiate
|
|
86078
|
-
*
|
|
86079
|
-
* + suffix ".fragment.[typeextension]") and which defines the Fragment content. If oController is given,
|
|
86080
|
-
* the (event handler) methods referenced in the Fragment will be called on this controller. Note that Fragments
|
|
86081
|
-
* may require a Controller to be given and certain methods to be available.
|
|
86179
|
+
* To instantiate a fragment that is already defined separately, call:
|
|
86180
|
+
* ```javascript
|
|
86082
86181
|
*
|
|
86083
|
-
*
|
|
86084
|
-
*
|
|
86182
|
+
* sap.ui.fragment(sName, sType, oController?);
|
|
86183
|
+
* ```
|
|
86085
86184
|
*
|
|
86086
|
-
* Advanced usage: To instantiate a Fragment and give further configuration options, call this method as:
|
|
86087
|
-
* sap.ui.fragment(oFragmentConfig, [oController]); The oFragmentConfig object can have the following properties:
|
|
86088
|
-
* - "fragmentName": the name of the Fragment, as above - "fragmentContent": the definition of the Fragment
|
|
86089
|
-
* content itself. When this property is given, any given name is ignored. The type of this property depends
|
|
86090
|
-
* on the Fragment type, e.g. it could be a string for XML Fragments. - "type": the type of the Fragment,
|
|
86091
|
-
* as above (mandatory) - "id": the ID of the Fragment (optional) Further properties may be supported by
|
|
86092
|
-
* future or custom Fragment types. Any given properties will be forwarded to the Fragment implementation.
|
|
86093
86185
|
*
|
|
86094
|
-
*
|
|
86095
|
-
*
|
|
86096
|
-
* Otherwise the Fragment ID is generated. In any case, the Fragment ID will be used as prefix for the ID
|
|
86097
|
-
* of all contained controls.
|
|
86186
|
+
* Advanced usage to give further configuration options:
|
|
86187
|
+
* ```javascript
|
|
86098
86188
|
*
|
|
86099
|
-
*
|
|
86189
|
+
* sap.ui.fragment(oFragmentConfig, oController?);
|
|
86190
|
+
* ```
|
|
86191
|
+
* In addition to `id` and `type`, the `oFragmentConfig` object can have either a `fragmentName` or a `fragmentContent`
|
|
86192
|
+
* property, but not both.
|
|
86193
|
+
*
|
|
86194
|
+
* To define a fragment ID, which can be used as a prefix for the created control IDs, you must use either
|
|
86195
|
+
* the above advanced version with an `id` or one of the typed factory functions like {@link sap.ui.xmlfragment }
|
|
86196
|
+
* or {@link sap.ui.jsfragment}.
|
|
86197
|
+
*
|
|
86198
|
+
* A fragment type must be given in all cases. The fragment types `"XML"`, `"JS"`, and `"HTML"` (type `"HTML"`
|
|
86199
|
+
* is deprecated) are available by default. Additional fragment types can be implemented and added using
|
|
86200
|
+
* the {@link sap.ui.core.Fragment.registerType} function.
|
|
86201
|
+
*
|
|
86202
|
+
* Custom fragment types can support further properties. Any given properties will be forwarded to the fragment
|
|
86203
|
+
* implementation.
|
|
86204
|
+
*
|
|
86205
|
+
* The optional `oController` can be either the controller of an enclosing view, a new controller instance,
|
|
86206
|
+
* or a simple object with the necessary methods attached. Note that a fragment has no runtime representation
|
|
86207
|
+
* besides its contained controls. Therefore, there is no API to retrieve the controller from the return
|
|
86208
|
+
* value. Note also that fragments may require a controller to be given and certain methods to be available.
|
|
86209
|
+
*
|
|
86210
|
+
* **Note:** In case you are embedding a Fragment into an existing View, please also have a look at the
|
|
86211
|
+
* {@link sap.ui.core.mvc.Controller.loadFragment loadFragment} factory for a closer coupling to the corresponding
|
|
86212
|
+
* Controller instance.
|
|
86100
86213
|
*
|
|
86101
|
-
* @
|
|
86214
|
+
* @deprecated (since 1.58) - Refer to {@link topic:04129b2798c447368f4c8922c3c33cd7 Instantiation of Fragments}.
|
|
86215
|
+
*
|
|
86216
|
+
* @returns the instantiated root control(s) from the fragment content
|
|
86102
86217
|
*/
|
|
86103
86218
|
function fragment(
|
|
86104
86219
|
/**
|
|
86105
|
-
* the
|
|
86220
|
+
* resource name of the fragment module in dot notation without the `.fragment.<typeExtension>`
|
|
86221
|
+
* suffix from the file name. Alternatively, a configuration object as specified below
|
|
86106
86222
|
*/
|
|
86107
|
-
|
|
86223
|
+
vName:
|
|
86224
|
+
| string
|
|
86225
|
+
| {
|
|
86226
|
+
/**
|
|
86227
|
+
* optional ID of the created fragment
|
|
86228
|
+
*/
|
|
86229
|
+
id?: string;
|
|
86230
|
+
/**
|
|
86231
|
+
* definition of the fragment content that will be used instead of loading the content from a separate file.
|
|
86232
|
+
* The type of this property depends on the fragment type. For example, it could be a string for XML fragments
|
|
86233
|
+
* or an object for JS fragments
|
|
86234
|
+
*/
|
|
86235
|
+
fragmentContent?: string | object;
|
|
86236
|
+
/**
|
|
86237
|
+
* recource name of the fragment module as specified above
|
|
86238
|
+
*/
|
|
86239
|
+
fragmentName?: string;
|
|
86240
|
+
/**
|
|
86241
|
+
* type of the fragment, for example, `"XML"`, `"JS"`, `"HTML"`, or any other type that has been implemented
|
|
86242
|
+
* additionally
|
|
86243
|
+
*/
|
|
86244
|
+
type: string;
|
|
86245
|
+
},
|
|
86108
86246
|
/**
|
|
86109
|
-
* the
|
|
86247
|
+
* type of the fragment as specified by `vName.type` or, in the advanced usage case, an optional `oController`
|
|
86110
86248
|
*/
|
|
86111
|
-
|
|
86249
|
+
vType: string | import("sap/ui/core/mvc/Controller").default | object,
|
|
86112
86250
|
/**
|
|
86113
|
-
*
|
|
86114
|
-
* may not need a Controller and other may need one - and even rely on certain methods implemented in the
|
|
86115
|
-
* Controller.
|
|
86251
|
+
* controller object to be used for methods or event handlers referenced in the fragment
|
|
86116
86252
|
*/
|
|
86117
|
-
oController?: import("sap/ui/core/mvc/Controller").default |
|
|
86253
|
+
oController?: import("sap/ui/core/mvc/Controller").default | object
|
|
86118
86254
|
):
|
|
86119
86255
|
| import("sap/ui/core/Control").default
|
|
86120
86256
|
| Array<import("sap/ui/core/Control").default>;
|
|
@@ -86160,126 +86296,103 @@ declare namespace sap {
|
|
|
86160
86296
|
}
|
|
86161
86297
|
): object | undefined | Promise<any>;
|
|
86162
86298
|
/**
|
|
86163
|
-
*
|
|
86299
|
+
* Loads and instantiates an HTML-based fragment.
|
|
86164
86300
|
*
|
|
86165
|
-
* To instantiate a fragment, call:
|
|
86301
|
+
* To instantiate a fragment that is already defined separately, call:
|
|
86166
86302
|
* ```javascript
|
|
86167
86303
|
*
|
|
86168
|
-
*
|
|
86304
|
+
* sap.ui.htmlfragment(sId?, sFragmentName, oController?);
|
|
86169
86305
|
* ```
|
|
86170
|
-
*
|
|
86171
|
-
*
|
|
86172
|
-
*
|
|
86173
|
-
* If `oController` is given, the methods referenced in the fragment will be called on this controller.
|
|
86174
|
-
* Note that fragments may require a controller to be given and certain methods to be available.
|
|
86175
|
-
*
|
|
86176
|
-
* Advanced usage:: To instantiate a fragment and optionally directly give the HTML definition instead of
|
|
86177
|
-
* loading it from a file, call:
|
|
86306
|
+
*
|
|
86307
|
+
*
|
|
86308
|
+
* Advanced usage:
|
|
86178
86309
|
* ```javascript
|
|
86179
86310
|
*
|
|
86180
|
-
*
|
|
86311
|
+
* sap.ui.htmlfragment(oFragmentConfig, oController?);
|
|
86181
86312
|
* ```
|
|
86182
|
-
*
|
|
86183
|
-
*
|
|
86184
|
-
* must be given and the fragment content definition is loaded by the module system. Again, if `oController`
|
|
86185
|
-
* is given, any methods referenced in the fragment will be called on this controller.
|
|
86313
|
+
* In addition to an `id`, the `oFragmentConfig` object can have either a `fragmentName` or a `fragmentContent`
|
|
86314
|
+
* property, but not both.
|
|
86186
86315
|
*
|
|
86187
|
-
* @deprecated (since 1.58) - use
|
|
86316
|
+
* @deprecated (since 1.58) - Additionally, use of fragments based on type `"HTML"` is deprecated since
|
|
86317
|
+
* 1.108. If you need declarative fragments, use XML fragments instead. Refer to {@link topic:04129b2798c447368f4c8922c3c33cd7 Instantiation of Fragments}.
|
|
86188
86318
|
*
|
|
86189
|
-
* @returns
|
|
86319
|
+
* @returns the instantiated root control(s) from the fragment content
|
|
86190
86320
|
*/
|
|
86191
86321
|
function htmlfragment(
|
|
86192
86322
|
/**
|
|
86193
|
-
* ID of the
|
|
86323
|
+
* ID of the created fragment which will be used as prefix to all contained control IDs. If the first argument
|
|
86324
|
+
* is not an ID, it must be either the fragment name (`sFragmentName`) or a configuration object (`oFragmentConfig`)
|
|
86325
|
+
* as specified below
|
|
86194
86326
|
*/
|
|
86195
|
-
|
|
86196
|
-
/**
|
|
86197
|
-
* Resource name of the fragment, a module name in dot notation without the '.fragment.html' suffix. Alternatively,
|
|
86198
|
-
* a configuration object can be given with the properties described below. In this case, no `sId` may be
|
|
86199
|
-
* given as first parameter, but as property `id` in the configuration object.
|
|
86200
|
-
*/
|
|
86201
|
-
vFragment:
|
|
86327
|
+
vId:
|
|
86202
86328
|
| string
|
|
86203
86329
|
| {
|
|
86204
86330
|
/**
|
|
86205
|
-
* ID of the
|
|
86331
|
+
* ID of the created fragment which will be used as prefix to all contained control IDs
|
|
86206
86332
|
*/
|
|
86207
86333
|
id?: string;
|
|
86208
86334
|
/**
|
|
86209
|
-
*
|
|
86335
|
+
* definition of the fragment content as an HTML string that will be used instead of loading the content
|
|
86336
|
+
* from a separate `.fragment.html` file. When this property is given, any given fragment name is ignored
|
|
86210
86337
|
*/
|
|
86211
|
-
|
|
86338
|
+
fragmentContent?: string;
|
|
86212
86339
|
/**
|
|
86213
|
-
*
|
|
86340
|
+
* resource name of the fragment module in dot notation without the `.fragment.html` suffix from the file
|
|
86341
|
+
* name
|
|
86214
86342
|
*/
|
|
86215
|
-
|
|
86343
|
+
fragmentName?: string;
|
|
86216
86344
|
},
|
|
86217
86345
|
/**
|
|
86218
|
-
*
|
|
86346
|
+
* resource name of the fragment module as specified by `vId.fragmentName` or, in the advanced usage case,
|
|
86347
|
+
* an optional `oController`
|
|
86348
|
+
*/
|
|
86349
|
+
vFragment: string | import("sap/ui/core/mvc/Controller").default | object,
|
|
86350
|
+
/**
|
|
86351
|
+
* controller object to be used for methods or event handlers. Can be either the controller of an enclosing
|
|
86219
86352
|
* view, a new controller instance, or a simple object with the necessary methods attached. Note that a
|
|
86220
|
-
* fragment has no runtime representation besides its contained controls.
|
|
86221
|
-
* the controller
|
|
86353
|
+
* fragment has no runtime representation besides its contained controls. Therefore, there is no API to
|
|
86354
|
+
* retrieve the controller from the return value. Note also that fragments may require a controller to be
|
|
86355
|
+
* given and certain methods to be available
|
|
86222
86356
|
*/
|
|
86223
86357
|
oController?: import("sap/ui/core/mvc/Controller").default | object
|
|
86224
86358
|
):
|
|
86225
86359
|
| import("sap/ui/core/Control").default
|
|
86226
86360
|
| Array<import("sap/ui/core/Control").default>;
|
|
86227
86361
|
/**
|
|
86228
|
-
*
|
|
86362
|
+
* Loads and instantiates an HTML-based fragment.
|
|
86229
86363
|
*
|
|
86230
|
-
* To instantiate a fragment, call:
|
|
86364
|
+
* To instantiate a fragment that is already defined separately, call:
|
|
86231
86365
|
* ```javascript
|
|
86232
86366
|
*
|
|
86233
|
-
*
|
|
86367
|
+
* sap.ui.htmlfragment(sId?, sFragmentName, oController?);
|
|
86234
86368
|
* ```
|
|
86235
|
-
*
|
|
86236
|
-
*
|
|
86237
|
-
*
|
|
86238
|
-
* If `oController` is given, the methods referenced in the fragment will be called on this controller.
|
|
86239
|
-
* Note that fragments may require a controller to be given and certain methods to be available.
|
|
86240
|
-
*
|
|
86241
|
-
* Advanced usage:: To instantiate a fragment and optionally directly give the HTML definition instead of
|
|
86242
|
-
* loading it from a file, call:
|
|
86369
|
+
*
|
|
86370
|
+
*
|
|
86371
|
+
* Advanced usage:
|
|
86243
86372
|
* ```javascript
|
|
86244
86373
|
*
|
|
86245
|
-
*
|
|
86374
|
+
* sap.ui.htmlfragment(oFragmentConfig, oController?);
|
|
86246
86375
|
* ```
|
|
86247
|
-
*
|
|
86248
|
-
*
|
|
86249
|
-
* must be given and the fragment content definition is loaded by the module system. Again, if `oController`
|
|
86250
|
-
* is given, any methods referenced in the fragment will be called on this controller.
|
|
86376
|
+
* In addition to an `id`, the `oFragmentConfig` object can have either a `fragmentName` or a `fragmentContent`
|
|
86377
|
+
* property, but not both.
|
|
86251
86378
|
*
|
|
86252
|
-
* @deprecated (since 1.58) - use
|
|
86379
|
+
* @deprecated (since 1.58) - Additionally, use of fragments based on type `"HTML"` is deprecated since
|
|
86380
|
+
* 1.108. If you need declarative fragments, use XML fragments instead. Refer to {@link topic:04129b2798c447368f4c8922c3c33cd7 Instantiation of Fragments}.
|
|
86253
86381
|
*
|
|
86254
|
-
* @returns
|
|
86382
|
+
* @returns the instantiated root control(s) from the fragment content
|
|
86255
86383
|
*/
|
|
86256
86384
|
function htmlfragment(
|
|
86257
86385
|
/**
|
|
86258
|
-
*
|
|
86259
|
-
*
|
|
86260
|
-
* given as first parameter, but as property `id` in the configuration object.
|
|
86386
|
+
* resource name of the fragment module as specified by `vId.fragmentName` or, in the advanced usage case,
|
|
86387
|
+
* an optional `oController`
|
|
86261
86388
|
*/
|
|
86262
|
-
vFragment:
|
|
86263
|
-
| string
|
|
86264
|
-
| {
|
|
86265
|
-
/**
|
|
86266
|
-
* ID of the newly created fragment; will be used as a prefix to all contained control IDs
|
|
86267
|
-
*/
|
|
86268
|
-
id?: string;
|
|
86269
|
-
/**
|
|
86270
|
-
* Resource name of the Fragment; a module name in dot notation without the '.fragment.html' suffix
|
|
86271
|
-
*/
|
|
86272
|
-
fragmentName?: string;
|
|
86273
|
-
/**
|
|
86274
|
-
* Definition of the fragment as an HTML string
|
|
86275
|
-
*/
|
|
86276
|
-
fragmentContent?: string;
|
|
86277
|
-
},
|
|
86389
|
+
vFragment: string | import("sap/ui/core/mvc/Controller").default | object,
|
|
86278
86390
|
/**
|
|
86279
|
-
*
|
|
86391
|
+
* controller object to be used for methods or event handlers. Can be either the controller of an enclosing
|
|
86280
86392
|
* view, a new controller instance, or a simple object with the necessary methods attached. Note that a
|
|
86281
|
-
* fragment has no runtime representation besides its contained controls.
|
|
86282
|
-
* the controller
|
|
86393
|
+
* fragment has no runtime representation besides its contained controls. Therefore, there is no API to
|
|
86394
|
+
* retrieve the controller from the return value. Note also that fragments may require a controller to be
|
|
86395
|
+
* given and certain methods to be available
|
|
86283
86396
|
*/
|
|
86284
86397
|
oController?: import("sap/ui/core/mvc/Controller").default | object
|
|
86285
86398
|
):
|
|
@@ -86356,71 +86469,66 @@ declare namespace sap {
|
|
|
86356
86469
|
}
|
|
86357
86470
|
): import("sap/ui/core/mvc/HTMLView").default | undefined;
|
|
86358
86471
|
/**
|
|
86359
|
-
* Defines
|
|
86472
|
+
* Defines **or** instantiates a JS-based fragment.
|
|
86360
86473
|
*
|
|
86361
86474
|
* To define a JS fragment, call:
|
|
86362
86475
|
* ```javascript
|
|
86363
86476
|
*
|
|
86364
|
-
*
|
|
86477
|
+
* sap.ui.jsfragment(sName, oFragmentDefinition);
|
|
86365
86478
|
* ```
|
|
86366
|
-
*
|
|
86367
|
-
*
|
|
86368
|
-
*
|
|
86369
|
-
* to `sName` (path + file name must be: fragmentName + ".fragment.js").
|
|
86370
|
-
* - `oFragmentDefinition` is an object at least holding the `createContent(oController)` method which
|
|
86371
|
-
* defines the fragment content. If given during instantiation, the `createContent` method receives a controller
|
|
86372
|
-
* instance (otherwise, parameter `oController` will be undefined) and the return value must be one `sap.ui.core.Control`
|
|
86373
|
-
* (which could have any number of children).
|
|
86374
|
-
*
|
|
86375
|
-
* To instantiate a JS fragment, call:
|
|
86479
|
+
*
|
|
86480
|
+
*
|
|
86481
|
+
* To instantiate a JS fragment that is already defined, call:
|
|
86376
86482
|
* ```javascript
|
|
86377
86483
|
*
|
|
86378
|
-
*
|
|
86484
|
+
* sap.ui.jsfragment(sId?, sFragmentName, oController?);
|
|
86379
86485
|
* ```
|
|
86380
|
-
*
|
|
86381
|
-
*
|
|
86382
|
-
*
|
|
86383
|
-
*
|
|
86384
|
-
*
|
|
86385
|
-
*
|
|
86386
|
-
* the fragment will be called on this controller. Note that fragments may require a controller to be given
|
|
86387
|
-
* and certain methods to be available.
|
|
86486
|
+
* Advanced usage:
|
|
86487
|
+
* ```javascript
|
|
86488
|
+
*
|
|
86489
|
+
* sap.ui.jsfragment(oFragmentConfig, oController?);
|
|
86490
|
+
* ```
|
|
86491
|
+
*
|
|
86388
86492
|
*
|
|
86389
|
-
* @deprecated (since 1.58) -
|
|
86493
|
+
* @deprecated (since 1.58) - Refer to {@link topic:04129b2798c447368f4c8922c3c33cd7 Instantiation of Fragments}.
|
|
86390
86494
|
*
|
|
86391
|
-
* @returns
|
|
86495
|
+
* @returns the instantiated root control(s) from the fragment content
|
|
86392
86496
|
*/
|
|
86393
86497
|
function jsfragment(
|
|
86394
86498
|
/**
|
|
86395
|
-
*
|
|
86396
|
-
* a fragment
|
|
86499
|
+
* when defining a fragment: name of the fragment.
|
|
86500
|
+
* When loading a fragment: fragment ID (optional), fragment name, or configuration object as specified
|
|
86501
|
+
* below
|
|
86397
86502
|
*/
|
|
86398
86503
|
vName:
|
|
86399
86504
|
| string
|
|
86400
86505
|
| {
|
|
86401
86506
|
/**
|
|
86402
|
-
* ID of the newly created fragment
|
|
86507
|
+
* ID of the newly created fragment which can be used as a prefix when creating the IDs in the JS
|
|
86508
|
+
* fragment content. Even if an `id` is given, some JS fragments may choose not to use the ID prefixing,
|
|
86509
|
+
* for example, in order to prevent the fragment from being instantiated multiple times within the lifecycle
|
|
86510
|
+
* of the existing fragment
|
|
86403
86511
|
*/
|
|
86404
86512
|
id?: string;
|
|
86405
86513
|
/**
|
|
86406
|
-
*
|
|
86407
|
-
*
|
|
86408
|
-
*
|
|
86514
|
+
* resource name of the fragment module in dot notation without the `.fragment.js` suffix from the file
|
|
86515
|
+
* name. When no fragment has been defined with that name, the name will be converted to a path by replacing
|
|
86516
|
+
* dots with slashes and appending `.fragment.js`. The corresponding resource to load is expected to have
|
|
86517
|
+
* a fragment defined with the same `fragmentName`
|
|
86409
86518
|
*/
|
|
86410
|
-
fragmentName
|
|
86519
|
+
fragmentName: string;
|
|
86411
86520
|
},
|
|
86412
86521
|
/**
|
|
86413
|
-
*
|
|
86414
|
-
*
|
|
86415
|
-
*
|
|
86416
|
-
* was a name, this parameter must be omitted.
|
|
86522
|
+
* when defining a fragment: object holding at least the `createContent(oController?)` method that returns
|
|
86523
|
+
* an instance of `sap.ui.core.Control` or an array thereof.
|
|
86524
|
+
* When loading a fragment and the first argument is an ID: the `fragmentName`
|
|
86417
86525
|
*/
|
|
86418
|
-
vFragmentDefinition
|
|
86526
|
+
vFragmentDefinition: object | string,
|
|
86419
86527
|
/**
|
|
86420
|
-
*
|
|
86528
|
+
* controller object to be used for methods or event handlers. Can be either the controller of an enclosing
|
|
86421
86529
|
* view, a new controller instance, or a simple object with the necessary methods attached. Note that a
|
|
86422
|
-
* fragment has no runtime representation besides its contained controls.
|
|
86423
|
-
* the controller
|
|
86530
|
+
* fragment has no runtime representation besides its contained controls. Therefore, there is no API to
|
|
86531
|
+
* retrieve the controller from the return value
|
|
86424
86532
|
*/
|
|
86425
86533
|
oController?: import("sap/ui/core/mvc/Controller").default | object
|
|
86426
86534
|
):
|
|
@@ -87064,128 +87172,101 @@ declare namespace sap {
|
|
|
87064
87172
|
}
|
|
87065
87173
|
): import("sap/ui/core/mvc/View").default;
|
|
87066
87174
|
/**
|
|
87067
|
-
*
|
|
87175
|
+
* Loads and instantiates an XML-based fragment.
|
|
87068
87176
|
*
|
|
87069
|
-
* To instantiate a fragment, call:
|
|
87177
|
+
* To instantiate a fragment that is already defined separately, call:
|
|
87070
87178
|
* ```javascript
|
|
87071
87179
|
*
|
|
87072
|
-
*
|
|
87180
|
+
* sap.ui.xmlfragment(sId?, sFragmentName, oController?);
|
|
87073
87181
|
* ```
|
|
87074
|
-
* The fragment instance ID is optional and will be used as prefix for the ID of all contained controls.
|
|
87075
|
-
* If no ID is passed, controls will not be prefixed. The `sFragmentName` must correspond to an XML fragment
|
|
87076
|
-
* which can be loaded via the module system (fragmentName + ".fragment.xml") and which defines the fragment.
|
|
87077
|
-
* If `oController` is given, the methods referenced in the fragment will be called on this controller.
|
|
87078
87182
|
*
|
|
87079
|
-
* Note that fragments may require a controller to be given and certain methods to be available.
|
|
87080
87183
|
*
|
|
87081
|
-
* Advanced usage
|
|
87082
|
-
* loading it from a file, call:
|
|
87184
|
+
* Advanced usage:
|
|
87083
87185
|
* ```javascript
|
|
87084
87186
|
*
|
|
87085
|
-
*
|
|
87187
|
+
* sap.ui.xmlfragment(oFragmentConfig, oController?);
|
|
87086
87188
|
* ```
|
|
87087
|
-
*
|
|
87088
|
-
*
|
|
87089
|
-
* must be given and the fragment content definition is loaded via the module system. Again, if `oController`
|
|
87090
|
-
* is given, the methods referenced in the fragment will be called on this controller.
|
|
87189
|
+
* In addition to an `id`, the `oFragmentConfig` object can have either a `fragmentName` or a `fragmentContent`
|
|
87190
|
+
* property, but not both.
|
|
87091
87191
|
*
|
|
87092
|
-
* @deprecated (since 1.58) -
|
|
87192
|
+
* @deprecated (since 1.58) - Refer to {@link topic:04129b2798c447368f4c8922c3c33cd7 Instantiation of Fragments}.
|
|
87093
87193
|
*
|
|
87094
|
-
* @returns the root
|
|
87194
|
+
* @returns the instantiated root control(s) from the fragment content
|
|
87095
87195
|
*/
|
|
87096
87196
|
function xmlfragment(
|
|
87097
87197
|
/**
|
|
87098
|
-
* ID of the
|
|
87099
|
-
|
|
87100
|
-
|
|
87101
|
-
/**
|
|
87102
|
-
* Resource name of the fragment; a module name in dot notation without the '.fragment.xml' suffix. Alternatively,
|
|
87103
|
-
* a configuration object can be given with the properties described below. In this case, no `sId` may be
|
|
87104
|
-
* given as first parameter, but as property `id` in the configuration object.
|
|
87198
|
+
* ID of the created fragment which will be used as prefix to all contained control IDs. If the first argument
|
|
87199
|
+
* is not an ID, it must be either the fragment name (`sFragmentName`) or a configuration object (`oFragmentConfig`)
|
|
87200
|
+
* as specified below
|
|
87105
87201
|
*/
|
|
87106
|
-
|
|
87202
|
+
vId:
|
|
87107
87203
|
| string
|
|
87108
87204
|
| {
|
|
87109
87205
|
/**
|
|
87110
|
-
* ID of the
|
|
87206
|
+
* ID of the created fragment which will be used as prefix to all contained control IDs
|
|
87111
87207
|
*/
|
|
87112
87208
|
id?: string;
|
|
87113
87209
|
/**
|
|
87114
|
-
*
|
|
87210
|
+
* definition of the fragment content as an XML string that will be used instead of loading the content
|
|
87211
|
+
* from a separate `.fragment.xml` file. When this property is given, any given fragment name is ignored
|
|
87115
87212
|
*/
|
|
87116
|
-
|
|
87213
|
+
fragmentContent?: string;
|
|
87117
87214
|
/**
|
|
87118
|
-
*
|
|
87215
|
+
* resource name of the fragment module in dot notation without the `.fragment.xml` suffix from the file
|
|
87216
|
+
* name
|
|
87119
87217
|
*/
|
|
87120
|
-
|
|
87218
|
+
fragmentName?: string;
|
|
87121
87219
|
},
|
|
87122
87220
|
/**
|
|
87123
|
-
*
|
|
87221
|
+
* resource name of the fragment module as specified by `vId.fragmentName` or, in the advanced usage case,
|
|
87222
|
+
* an optional `oController`
|
|
87223
|
+
*/
|
|
87224
|
+
vFragment: string | import("sap/ui/core/mvc/Controller").default | object,
|
|
87225
|
+
/**
|
|
87226
|
+
* controller object to be used for methods or event handlers. Can be either the controller of an enclosing
|
|
87124
87227
|
* view, a new controller instance, or a simple object with the necessary methods attached. Note that a
|
|
87125
|
-
* fragment has no runtime representation besides its contained controls.
|
|
87126
|
-
* the controller
|
|
87228
|
+
* fragment has no runtime representation besides its contained controls. Therefore, there is no API to
|
|
87229
|
+
* retrieve the controller from the return value. Note also that fragments may require a controller to be
|
|
87230
|
+
* given and certain methods to be available
|
|
87127
87231
|
*/
|
|
87128
87232
|
oController?: import("sap/ui/core/mvc/Controller").default | object
|
|
87129
87233
|
):
|
|
87130
87234
|
| import("sap/ui/core/Control").default
|
|
87131
87235
|
| Array<import("sap/ui/core/Control").default>;
|
|
87132
87236
|
/**
|
|
87133
|
-
*
|
|
87237
|
+
* Loads and instantiates an XML-based fragment.
|
|
87134
87238
|
*
|
|
87135
|
-
* To instantiate a fragment, call:
|
|
87239
|
+
* To instantiate a fragment that is already defined separately, call:
|
|
87136
87240
|
* ```javascript
|
|
87137
87241
|
*
|
|
87138
|
-
*
|
|
87242
|
+
* sap.ui.xmlfragment(sId?, sFragmentName, oController?);
|
|
87139
87243
|
* ```
|
|
87140
|
-
* The fragment instance ID is optional and will be used as prefix for the ID of all contained controls.
|
|
87141
|
-
* If no ID is passed, controls will not be prefixed. The `sFragmentName` must correspond to an XML fragment
|
|
87142
|
-
* which can be loaded via the module system (fragmentName + ".fragment.xml") and which defines the fragment.
|
|
87143
|
-
* If `oController` is given, the methods referenced in the fragment will be called on this controller.
|
|
87144
87244
|
*
|
|
87145
|
-
* Note that fragments may require a controller to be given and certain methods to be available.
|
|
87146
87245
|
*
|
|
87147
|
-
* Advanced usage
|
|
87148
|
-
* loading it from a file, call:
|
|
87246
|
+
* Advanced usage:
|
|
87149
87247
|
* ```javascript
|
|
87150
87248
|
*
|
|
87151
|
-
*
|
|
87249
|
+
* sap.ui.xmlfragment(oFragmentConfig, oController?);
|
|
87152
87250
|
* ```
|
|
87153
|
-
*
|
|
87154
|
-
*
|
|
87155
|
-
* must be given and the fragment content definition is loaded via the module system. Again, if `oController`
|
|
87156
|
-
* is given, the methods referenced in the fragment will be called on this controller.
|
|
87251
|
+
* In addition to an `id`, the `oFragmentConfig` object can have either a `fragmentName` or a `fragmentContent`
|
|
87252
|
+
* property, but not both.
|
|
87157
87253
|
*
|
|
87158
|
-
* @deprecated (since 1.58) -
|
|
87254
|
+
* @deprecated (since 1.58) - Refer to {@link topic:04129b2798c447368f4c8922c3c33cd7 Instantiation of Fragments}.
|
|
87159
87255
|
*
|
|
87160
|
-
* @returns the root
|
|
87256
|
+
* @returns the instantiated root control(s) from the fragment content
|
|
87161
87257
|
*/
|
|
87162
87258
|
function xmlfragment(
|
|
87163
87259
|
/**
|
|
87164
|
-
*
|
|
87165
|
-
*
|
|
87166
|
-
* given as first parameter, but as property `id` in the configuration object.
|
|
87260
|
+
* resource name of the fragment module as specified by `vId.fragmentName` or, in the advanced usage case,
|
|
87261
|
+
* an optional `oController`
|
|
87167
87262
|
*/
|
|
87168
|
-
vFragment:
|
|
87169
|
-
| string
|
|
87170
|
-
| {
|
|
87171
|
-
/**
|
|
87172
|
-
* ID of the newly created fragment; will be used as a prefix to all contained control IDs
|
|
87173
|
-
*/
|
|
87174
|
-
id?: string;
|
|
87175
|
-
/**
|
|
87176
|
-
* Resource name of the fragment; a module name in dot notation without the '.fragment.html' suffix
|
|
87177
|
-
*/
|
|
87178
|
-
fragmentName?: string;
|
|
87179
|
-
/**
|
|
87180
|
-
* Definition of the fragment as an XML string
|
|
87181
|
-
*/
|
|
87182
|
-
fragmentContent?: string;
|
|
87183
|
-
},
|
|
87263
|
+
vFragment: string | import("sap/ui/core/mvc/Controller").default | object,
|
|
87184
87264
|
/**
|
|
87185
|
-
*
|
|
87265
|
+
* controller object to be used for methods or event handlers. Can be either the controller of an enclosing
|
|
87186
87266
|
* view, a new controller instance, or a simple object with the necessary methods attached. Note that a
|
|
87187
|
-
* fragment has no runtime representation besides its contained controls.
|
|
87188
|
-
* the controller
|
|
87267
|
+
* fragment has no runtime representation besides its contained controls. Therefore, there is no API to
|
|
87268
|
+
* retrieve the controller from the return value. Note also that fragments may require a controller to be
|
|
87269
|
+
* given and certain methods to be available
|
|
87189
87270
|
*/
|
|
87190
87271
|
oController?: import("sap/ui/core/mvc/Controller").default | object
|
|
87191
87272
|
):
|