@openui5/types 1.113.0 → 1.115.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/types/sap.f.d.ts +1416 -1005
- package/types/sap.m.d.ts +7415 -5818
- package/types/sap.tnt.d.ts +138 -67
- package/types/sap.ui.codeeditor.d.ts +37 -30
- package/types/sap.ui.commons.d.ts +936 -708
- package/types/sap.ui.core.d.ts +6435 -3941
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.fl.d.ts +102 -82
- package/types/sap.ui.integration.d.ts +2489 -2327
- package/types/sap.ui.layout.d.ts +378 -398
- package/types/sap.ui.mdc.d.ts +22041 -115
- package/types/sap.ui.rta.d.ts +1 -1
- package/types/sap.ui.suite.d.ts +13 -11
- package/types/sap.ui.support.d.ts +7 -7
- package/types/sap.ui.table.d.ts +628 -478
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +1013 -723
- package/types/sap.ui.ux3.d.ts +847 -592
- package/types/sap.ui.webc.common.d.ts +5 -3
- package/types/sap.ui.webc.fiori.d.ts +530 -345
- package/types/sap.ui.webc.main.d.ts +1114 -835
- package/types/sap.uxap.d.ts +309 -222
package/types/sap.uxap.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.
|
|
1
|
+
// For Library Version: 1.115.0
|
|
2
2
|
|
|
3
3
|
declare module "sap/uxap/library" {
|
|
4
4
|
/**
|
|
@@ -38,12 +38,11 @@ declare module "sap/uxap/library" {
|
|
|
38
38
|
*
|
|
39
39
|
*
|
|
40
40
|
* For more information on the types of header available for the `{@link sap.uxap.ObjectPageLayout ObjectPageLayout}`,
|
|
41
|
-
* see {@link topic
|
|
41
|
+
* see {@link https://ui5.sap.com/#/topic/d2ef0099542d44dc868719d908e576d0 Object Page Headers}.
|
|
42
42
|
*
|
|
43
|
-
* For details regarding the differences and similarities between the available headers, see {@link topic
|
|
44
|
-
* Object Page Headers Comparison}.
|
|
43
|
+
* For details regarding the differences and similarities between the available headers, see {@link https://ui5.sap.com/#/topic/9c9d94fd28284539a9a5a57e9caf82a8 Object Page Headers Comparison}.
|
|
45
44
|
* See:
|
|
46
|
-
* {@link topic
|
|
45
|
+
* {@link https://ui5.sap.com/#/topic/d2ef0099542d44dc868719d908e576d0 Object Page Headers}
|
|
47
46
|
*/
|
|
48
47
|
export interface IHeaderContent {
|
|
49
48
|
__implements__sap_uxap_IHeaderContent: boolean;
|
|
@@ -59,12 +58,11 @@ declare module "sap/uxap/library" {
|
|
|
59
58
|
* - `{@link sap.uxap.ObjectPageDynamicHeaderTitle}` - `ObjectPageLayout`'s dynamic header
|
|
60
59
|
*
|
|
61
60
|
* For more information on the types of header available for the `{@link sap.uxap.ObjectPageLayout ObjectPageLayout}`,
|
|
62
|
-
* see {@link topic
|
|
61
|
+
* see {@link https://ui5.sap.com/#/topic/d2ef0099542d44dc868719d908e576d0 Object Page Headers}.
|
|
63
62
|
*
|
|
64
|
-
* For details regarding the differences and similarities between the available headers, see {@link topic
|
|
65
|
-
* Object Page Headers Comparison}.
|
|
63
|
+
* For details regarding the differences and similarities between the available headers, see {@link https://ui5.sap.com/#/topic/9c9d94fd28284539a9a5a57e9caf82a8 Object Page Headers Comparison}.
|
|
66
64
|
* See:
|
|
67
|
-
* {@link topic
|
|
65
|
+
* {@link https://ui5.sap.com/#/topic/d2ef0099542d44dc868719d908e576d0 Object Page Headers}
|
|
68
66
|
*/
|
|
69
67
|
export interface IHeaderTitle {
|
|
70
68
|
__implements__sap_uxap_IHeaderTitle: boolean;
|
|
@@ -176,7 +174,7 @@ declare module "sap/uxap/AnchorBar" {
|
|
|
176
174
|
/**
|
|
177
175
|
* @SINCE 1.26
|
|
178
176
|
*
|
|
179
|
-
* Displays the titles of the sections and subsections in the {@link sap.uxap.ObjectPageLayout ObjectPageLayout}
|
|
177
|
+
* Displays the titles of the sections and subsections in the {@link sap.uxap.ObjectPageLayout ObjectPageLayout }
|
|
180
178
|
* and allows the user to scroll to the respective content.
|
|
181
179
|
*
|
|
182
180
|
* Overview:
|
|
@@ -185,7 +183,7 @@ declare module "sap/uxap/AnchorBar" {
|
|
|
185
183
|
* and subsections and allows the user to directly scroll to the respective content by selecting them, while
|
|
186
184
|
* it remains visible at the top of the page (below the page header).
|
|
187
185
|
*/
|
|
188
|
-
|
|
186
|
+
class AnchorBar extends Toolbar {
|
|
189
187
|
/**
|
|
190
188
|
* Constructor for a new `AnchorBar`.
|
|
191
189
|
*
|
|
@@ -193,7 +191,7 @@ declare module "sap/uxap/AnchorBar" {
|
|
|
193
191
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
194
192
|
* of the syntax of the settings object.
|
|
195
193
|
* See:
|
|
196
|
-
* {@link topic
|
|
194
|
+
* {@link https://ui5.sap.com/#/topic/370b67986497463187336fa130aebbf1 Anchor Bar}
|
|
197
195
|
*/
|
|
198
196
|
constructor(
|
|
199
197
|
/**
|
|
@@ -208,7 +206,7 @@ declare module "sap/uxap/AnchorBar" {
|
|
|
208
206
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
209
207
|
* of the syntax of the settings object.
|
|
210
208
|
* See:
|
|
211
|
-
* {@link topic
|
|
209
|
+
* {@link https://ui5.sap.com/#/topic/370b67986497463187336fa130aebbf1 Anchor Bar}
|
|
212
210
|
*/
|
|
213
211
|
constructor(
|
|
214
212
|
/**
|
|
@@ -396,6 +394,7 @@ declare module "sap/uxap/AnchorBar" {
|
|
|
396
394
|
bUpperCase?: boolean
|
|
397
395
|
): this;
|
|
398
396
|
}
|
|
397
|
+
export default AnchorBar;
|
|
399
398
|
|
|
400
399
|
export interface $AnchorBarSettings extends $ToolbarSettings {
|
|
401
400
|
/**
|
|
@@ -464,7 +463,7 @@ declare module "sap/uxap/BlockBase" {
|
|
|
464
463
|
*
|
|
465
464
|
* A block is a control that:
|
|
466
465
|
* - Has modes and a view associated to each mode. At rendering time, the view associated to the mode
|
|
467
|
-
*
|
|
466
|
+
* is rendered.
|
|
468
467
|
* - Can use all view types for storing its internal control tree (XML, JS, JSON, HTML)
|
|
469
468
|
*
|
|
470
469
|
* As any UI5 view, the XML view can have a controller which automatically comes with a `this.oParentBlock`
|
|
@@ -472,7 +471,7 @@ declare module "sap/uxap/BlockBase" {
|
|
|
472
471
|
* in `onParentBlockModeChange` method. If the controller implements the `onParentBlockModeChange` method,
|
|
473
472
|
* this method will be called with the `sMode` parameter when the view is used or reused by the block.
|
|
474
473
|
*/
|
|
475
|
-
|
|
474
|
+
class BlockBase extends Control {
|
|
476
475
|
/**
|
|
477
476
|
* Constructor for a new `BlockBase`.
|
|
478
477
|
*
|
|
@@ -480,8 +479,8 @@ declare module "sap/uxap/BlockBase" {
|
|
|
480
479
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
481
480
|
* of the syntax of the settings object.
|
|
482
481
|
* See:
|
|
483
|
-
* {@link topic
|
|
484
|
-
* {@link topic
|
|
482
|
+
* {@link https://ui5.sap.com/#/topic/4527729576cb4a4888275b6935aad03a Block Base}
|
|
483
|
+
* {@link https://ui5.sap.com/#/topic/2978f6064742456ebed31c5ccf4d051d Creating Blocks}
|
|
485
484
|
*/
|
|
486
485
|
constructor(
|
|
487
486
|
/**
|
|
@@ -496,8 +495,8 @@ declare module "sap/uxap/BlockBase" {
|
|
|
496
495
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
497
496
|
* of the syntax of the settings object.
|
|
498
497
|
* See:
|
|
499
|
-
* {@link topic
|
|
500
|
-
* {@link topic
|
|
498
|
+
* {@link https://ui5.sap.com/#/topic/4527729576cb4a4888275b6935aad03a Block Base}
|
|
499
|
+
* {@link https://ui5.sap.com/#/topic/2978f6064742456ebed31c5ccf4d051d Creating Blocks}
|
|
501
500
|
*/
|
|
502
501
|
constructor(
|
|
503
502
|
/**
|
|
@@ -571,7 +570,7 @@ declare module "sap/uxap/BlockBase" {
|
|
|
571
570
|
/**
|
|
572
571
|
* The function to be called when the event occurs
|
|
573
572
|
*/
|
|
574
|
-
fnFunction: (p1: Event) => void,
|
|
573
|
+
fnFunction: (p1: Event<$BlockBaseViewInitEventParameters>) => void,
|
|
575
574
|
/**
|
|
576
575
|
* Context object to call the event handler with. Defaults to this `sap.uxap.BlockBase` itself
|
|
577
576
|
*/
|
|
@@ -593,7 +592,7 @@ declare module "sap/uxap/BlockBase" {
|
|
|
593
592
|
/**
|
|
594
593
|
* The function to be called when the event occurs
|
|
595
594
|
*/
|
|
596
|
-
fnFunction: (p1: Event) => void,
|
|
595
|
+
fnFunction: (p1: Event<$BlockBaseViewInitEventParameters>) => void,
|
|
597
596
|
/**
|
|
598
597
|
* Context object to call the event handler with. Defaults to this `sap.uxap.BlockBase` itself
|
|
599
598
|
*/
|
|
@@ -635,7 +634,7 @@ declare module "sap/uxap/BlockBase" {
|
|
|
635
634
|
/**
|
|
636
635
|
* The function to be called, when the event occurs
|
|
637
636
|
*/
|
|
638
|
-
fnFunction: (p1: Event) => void,
|
|
637
|
+
fnFunction: (p1: Event<$BlockBaseViewInitEventParameters>) => void,
|
|
639
638
|
/**
|
|
640
639
|
* Context object on which the given function had to be called
|
|
641
640
|
*/
|
|
@@ -653,12 +652,7 @@ declare module "sap/uxap/BlockBase" {
|
|
|
653
652
|
/**
|
|
654
653
|
* Parameters to pass along with the event
|
|
655
654
|
*/
|
|
656
|
-
mParameters?:
|
|
657
|
-
/**
|
|
658
|
-
* The initialized view.
|
|
659
|
-
*/
|
|
660
|
-
view?: View;
|
|
661
|
-
}
|
|
655
|
+
mParameters?: $BlockBaseViewInitEventParameters
|
|
662
656
|
): this;
|
|
663
657
|
/**
|
|
664
658
|
* Gets current value of property {@link #getColumnLayout columnLayout}.
|
|
@@ -875,6 +869,7 @@ declare module "sap/uxap/BlockBase" {
|
|
|
875
869
|
bVisible?: boolean
|
|
876
870
|
): this;
|
|
877
871
|
}
|
|
872
|
+
export default BlockBase;
|
|
878
873
|
|
|
879
874
|
export interface $BlockBaseSettings extends $ControlSettings {
|
|
880
875
|
/**
|
|
@@ -940,7 +935,14 @@ declare module "sap/uxap/BlockBase" {
|
|
|
940
935
|
*
|
|
941
936
|
* Fired when an aggregated view is instantiated.
|
|
942
937
|
*/
|
|
943
|
-
viewInit?: (oEvent: Event) => void;
|
|
938
|
+
viewInit?: (oEvent: Event<$BlockBaseViewInitEventParameters>) => void;
|
|
939
|
+
}
|
|
940
|
+
|
|
941
|
+
export interface $BlockBaseViewInitEventParameters {
|
|
942
|
+
/**
|
|
943
|
+
* The initialized view.
|
|
944
|
+
*/
|
|
945
|
+
view?: View;
|
|
944
946
|
}
|
|
945
947
|
}
|
|
946
948
|
|
|
@@ -970,10 +972,10 @@ declare module "sap/uxap/BreadCrumbs" {
|
|
|
970
972
|
*
|
|
971
973
|
* It has two main modes of operation:
|
|
972
974
|
* - A trail of links followed by separators, when there's enough space for the control to fit on one
|
|
973
|
-
*
|
|
975
|
+
* line.
|
|
974
976
|
* - A dropdown list with the links, when the trail of links wouldn't fit on one line.
|
|
975
977
|
*/
|
|
976
|
-
|
|
978
|
+
class BreadCrumbs extends Control {
|
|
977
979
|
/**
|
|
978
980
|
* Constructor for a new `BreadCrumbs`.
|
|
979
981
|
*
|
|
@@ -1156,6 +1158,7 @@ declare module "sap/uxap/BreadCrumbs" {
|
|
|
1156
1158
|
bShowCurrentLocation?: boolean
|
|
1157
1159
|
): this;
|
|
1158
1160
|
}
|
|
1161
|
+
export default BreadCrumbs;
|
|
1159
1162
|
|
|
1160
1163
|
export interface $BreadCrumbsSettings extends $ControlSettings {
|
|
1161
1164
|
/**
|
|
@@ -1190,7 +1193,7 @@ declare module "sap/uxap/HierarchicalSelect" {
|
|
|
1190
1193
|
* If a provided item has a custom data named `secondLevel`, then it will be displayed as a second level,
|
|
1191
1194
|
* otherwise it would be displayed as a first level.
|
|
1192
1195
|
*/
|
|
1193
|
-
|
|
1196
|
+
class HierarchicalSelect extends Select {
|
|
1194
1197
|
/**
|
|
1195
1198
|
* Constructor for a new `HierarchicalSelect`.
|
|
1196
1199
|
*
|
|
@@ -1279,6 +1282,7 @@ declare module "sap/uxap/HierarchicalSelect" {
|
|
|
1279
1282
|
bUpperCase?: boolean
|
|
1280
1283
|
): this;
|
|
1281
1284
|
}
|
|
1285
|
+
export default HierarchicalSelect;
|
|
1282
1286
|
|
|
1283
1287
|
export interface $HierarchicalSelectSettings extends $SelectSettings {
|
|
1284
1288
|
/**
|
|
@@ -1300,7 +1304,7 @@ declare module "sap/uxap/ModelMapping" {
|
|
|
1300
1304
|
*
|
|
1301
1305
|
* Defines the entity that will be passed to the {@link sap.uxap.ObjectPageLayout}.
|
|
1302
1306
|
*/
|
|
1303
|
-
|
|
1307
|
+
class ModelMapping extends UI5Element {
|
|
1304
1308
|
/**
|
|
1305
1309
|
* Constructor for a new `ModelMapping`.
|
|
1306
1310
|
*
|
|
@@ -1435,6 +1439,7 @@ declare module "sap/uxap/ModelMapping" {
|
|
|
1435
1439
|
sInternalModelName?: string
|
|
1436
1440
|
): this;
|
|
1437
1441
|
}
|
|
1442
|
+
export default ModelMapping;
|
|
1438
1443
|
|
|
1439
1444
|
export interface $ModelMappingSettings extends $ElementSettings {
|
|
1440
1445
|
/**
|
|
@@ -1470,7 +1475,7 @@ declare module "sap/uxap/ObjectPageAccessibleLandmarkInfo" {
|
|
|
1470
1475
|
* control. These landmarks are used by assistive technologies (such as screenreaders) to provide a meaningful
|
|
1471
1476
|
* page overview.
|
|
1472
1477
|
*/
|
|
1473
|
-
|
|
1478
|
+
class ObjectPageAccessibleLandmarkInfo extends UI5Element {
|
|
1474
1479
|
/**
|
|
1475
1480
|
* Constructor for a new `sap.uxap.ObjectPageAccessibleLandmarkInfo` element.
|
|
1476
1481
|
*
|
|
@@ -1854,6 +1859,7 @@ declare module "sap/uxap/ObjectPageAccessibleLandmarkInfo" {
|
|
|
1854
1859
|
sRootRole?: AccessibleLandmarkRole | keyof typeof AccessibleLandmarkRole
|
|
1855
1860
|
): this;
|
|
1856
1861
|
}
|
|
1862
|
+
export default ObjectPageAccessibleLandmarkInfo;
|
|
1857
1863
|
|
|
1858
1864
|
export interface $ObjectPageAccessibleLandmarkInfoSettings
|
|
1859
1865
|
extends $ElementSettings {
|
|
@@ -1977,10 +1983,10 @@ declare module "sap/uxap/ObjectPageDynamicHeaderContent" {
|
|
|
1977
1983
|
* all the additional information of the object.
|
|
1978
1984
|
*
|
|
1979
1985
|
* Documentation links:
|
|
1980
|
-
* - {@link topic
|
|
1981
|
-
* - {@link topic
|
|
1986
|
+
* - {@link https://ui5.sap.com/#/topic/d2ef0099542d44dc868719d908e576d0 Object Page Headers}
|
|
1987
|
+
* - {@link https://ui5.sap.com/#/topic/6e340c119ddd4c778b315f65a0432420 Object Page Dynamic Header}
|
|
1982
1988
|
*/
|
|
1983
|
-
|
|
1989
|
+
class ObjectPageDynamicHeaderContent
|
|
1984
1990
|
extends DynamicPageHeader
|
|
1985
1991
|
implements IHeaderContent {
|
|
1986
1992
|
__implements__sap_uxap_IHeaderContent: boolean;
|
|
@@ -1991,8 +1997,8 @@ declare module "sap/uxap/ObjectPageDynamicHeaderContent" {
|
|
|
1991
1997
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
1992
1998
|
* of the syntax of the settings object.
|
|
1993
1999
|
*
|
|
1994
|
-
* This class does not have its own settings, but all settings applicable to the base type {@link sap.f.DynamicPageHeader#constructor
|
|
1995
|
-
*
|
|
2000
|
+
* This class does not have its own settings, but all settings applicable to the base type {@link sap.f.DynamicPageHeader#constructor sap.f.DynamicPageHeader }
|
|
2001
|
+
* can be used.
|
|
1996
2002
|
*/
|
|
1997
2003
|
constructor(
|
|
1998
2004
|
/**
|
|
@@ -2007,8 +2013,8 @@ declare module "sap/uxap/ObjectPageDynamicHeaderContent" {
|
|
|
2007
2013
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
2008
2014
|
* of the syntax of the settings object.
|
|
2009
2015
|
*
|
|
2010
|
-
* This class does not have its own settings, but all settings applicable to the base type {@link sap.f.DynamicPageHeader#constructor
|
|
2011
|
-
*
|
|
2016
|
+
* This class does not have its own settings, but all settings applicable to the base type {@link sap.f.DynamicPageHeader#constructor sap.f.DynamicPageHeader }
|
|
2017
|
+
* can be used.
|
|
2012
2018
|
*/
|
|
2013
2019
|
constructor(
|
|
2014
2020
|
/**
|
|
@@ -2051,6 +2057,7 @@ declare module "sap/uxap/ObjectPageDynamicHeaderContent" {
|
|
|
2051
2057
|
*/
|
|
2052
2058
|
static getMetadata(): ElementMetadata;
|
|
2053
2059
|
}
|
|
2060
|
+
export default ObjectPageDynamicHeaderContent;
|
|
2054
2061
|
|
|
2055
2062
|
export interface $ObjectPageDynamicHeaderContentSettings
|
|
2056
2063
|
extends $DynamicPageHeaderSettings {}
|
|
@@ -2079,7 +2086,7 @@ declare module "sap/uxap/ObjectPageDynamicHeaderTitle" {
|
|
|
2079
2086
|
* **Note:** The `ObjectPageDynamicHeaderTitle` is meant to be used inside the `ObjectPageLayout` control.
|
|
2080
2087
|
* Any other usage is not supported and can lead to unexpected behavior.
|
|
2081
2088
|
*/
|
|
2082
|
-
|
|
2089
|
+
class ObjectPageDynamicHeaderTitle
|
|
2083
2090
|
extends DynamicPageTitle
|
|
2084
2091
|
implements IHeaderTitle {
|
|
2085
2092
|
__implements__sap_uxap_IHeaderTitle: boolean;
|
|
@@ -2090,12 +2097,12 @@ declare module "sap/uxap/ObjectPageDynamicHeaderTitle" {
|
|
|
2090
2097
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
2091
2098
|
* of the syntax of the settings object.
|
|
2092
2099
|
*
|
|
2093
|
-
* This class does not have its own settings, but all settings applicable to the base type {@link sap.f.DynamicPageTitle#constructor
|
|
2094
|
-
*
|
|
2100
|
+
* This class does not have its own settings, but all settings applicable to the base type {@link sap.f.DynamicPageTitle#constructor sap.f.DynamicPageTitle }
|
|
2101
|
+
* can be used.
|
|
2095
2102
|
* See:
|
|
2096
|
-
* {@link topic
|
|
2097
|
-
* {@link topic
|
|
2098
|
-
* {@link topic
|
|
2103
|
+
* {@link https://ui5.sap.com/#/topic/6e340c119ddd4c778b315f65a0432420 Object Page Dynamic Header}
|
|
2104
|
+
* {@link https://ui5.sap.com/#/topic/d2ef0099542d44dc868719d908e576d0 Object Page Headers}
|
|
2105
|
+
* {@link https://ui5.sap.com/#/topic/9c9d94fd28284539a9a5a57e9caf82a8 Object Page Headers Comparison}
|
|
2099
2106
|
*/
|
|
2100
2107
|
constructor(
|
|
2101
2108
|
/**
|
|
@@ -2110,12 +2117,12 @@ declare module "sap/uxap/ObjectPageDynamicHeaderTitle" {
|
|
|
2110
2117
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
2111
2118
|
* of the syntax of the settings object.
|
|
2112
2119
|
*
|
|
2113
|
-
* This class does not have its own settings, but all settings applicable to the base type {@link sap.f.DynamicPageTitle#constructor
|
|
2114
|
-
*
|
|
2120
|
+
* This class does not have its own settings, but all settings applicable to the base type {@link sap.f.DynamicPageTitle#constructor sap.f.DynamicPageTitle }
|
|
2121
|
+
* can be used.
|
|
2115
2122
|
* See:
|
|
2116
|
-
* {@link topic
|
|
2117
|
-
* {@link topic
|
|
2118
|
-
* {@link topic
|
|
2123
|
+
* {@link https://ui5.sap.com/#/topic/6e340c119ddd4c778b315f65a0432420 Object Page Dynamic Header}
|
|
2124
|
+
* {@link https://ui5.sap.com/#/topic/d2ef0099542d44dc868719d908e576d0 Object Page Headers}
|
|
2125
|
+
* {@link https://ui5.sap.com/#/topic/9c9d94fd28284539a9a5a57e9caf82a8 Object Page Headers Comparison}
|
|
2119
2126
|
*/
|
|
2120
2127
|
constructor(
|
|
2121
2128
|
/**
|
|
@@ -2158,6 +2165,7 @@ declare module "sap/uxap/ObjectPageDynamicHeaderTitle" {
|
|
|
2158
2165
|
*/
|
|
2159
2166
|
static getMetadata(): ElementMetadata;
|
|
2160
2167
|
}
|
|
2168
|
+
export default ObjectPageDynamicHeaderTitle;
|
|
2161
2169
|
|
|
2162
2170
|
export interface $ObjectPageDynamicHeaderTitleSettings
|
|
2163
2171
|
extends $DynamicPageTitleSettings {}
|
|
@@ -2204,9 +2212,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2204
2212
|
* **Note:** The `ObjectPageHeader` is meant to be used inside the `ObjectPageLayout` control. Any other
|
|
2205
2213
|
* usage is not supported and can lead to unexpected behavior.
|
|
2206
2214
|
*/
|
|
2207
|
-
|
|
2208
|
-
extends Control
|
|
2209
|
-
implements IHeaderTitle {
|
|
2215
|
+
class ObjectPageHeader extends Control implements IHeaderTitle {
|
|
2210
2216
|
__implements__sap_uxap_IHeaderTitle: boolean;
|
|
2211
2217
|
/**
|
|
2212
2218
|
* Constructor for a new `ObjectPageHeader`.
|
|
@@ -2215,9 +2221,9 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2215
2221
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
2216
2222
|
* of the syntax of the settings object.
|
|
2217
2223
|
* See:
|
|
2218
|
-
* {@link topic
|
|
2219
|
-
* {@link topic
|
|
2220
|
-
* {@link topic
|
|
2224
|
+
* {@link https://ui5.sap.com/#/topic/0fecbce45e39406aa939bd25e89823f4 Object Page Classic Header}
|
|
2225
|
+
* {@link https://ui5.sap.com/#/topic/d2ef0099542d44dc868719d908e576d0 Object Page Headers}
|
|
2226
|
+
* {@link https://ui5.sap.com/#/topic/9c9d94fd28284539a9a5a57e9caf82a8 Object Page Headers Comparison}
|
|
2221
2227
|
* {@link fiori:https://experience.sap.com/fiori-design-web/snapping-header/ Object Page Header}
|
|
2222
2228
|
* {@link fiori:https://experience.sap.com/fiori-design-web/object-page/ UX Guidelines: Object Page}
|
|
2223
2229
|
*/
|
|
@@ -2234,9 +2240,9 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2234
2240
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
2235
2241
|
* of the syntax of the settings object.
|
|
2236
2242
|
* See:
|
|
2237
|
-
* {@link topic
|
|
2238
|
-
* {@link topic
|
|
2239
|
-
* {@link topic
|
|
2243
|
+
* {@link https://ui5.sap.com/#/topic/0fecbce45e39406aa939bd25e89823f4 Object Page Classic Header}
|
|
2244
|
+
* {@link https://ui5.sap.com/#/topic/d2ef0099542d44dc868719d908e576d0 Object Page Headers}
|
|
2245
|
+
* {@link https://ui5.sap.com/#/topic/9c9d94fd28284539a9a5a57e9caf82a8 Object Page Headers Comparison}
|
|
2240
2246
|
* {@link fiori:https://experience.sap.com/fiori-design-web/snapping-header/ Object Page Header}
|
|
2241
2247
|
* {@link fiori:https://experience.sap.com/fiori-design-web/object-page/ UX Guidelines: Object Page}
|
|
2242
2248
|
*/
|
|
@@ -2324,7 +2330,9 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2324
2330
|
/**
|
|
2325
2331
|
* The function to be called when the event occurs
|
|
2326
2332
|
*/
|
|
2327
|
-
fnFunction: (
|
|
2333
|
+
fnFunction: (
|
|
2334
|
+
p1: Event<$ObjectPageHeaderMarkChangesPressEventParameters>
|
|
2335
|
+
) => void,
|
|
2328
2336
|
/**
|
|
2329
2337
|
* Context object to call the event handler with. Defaults to this `sap.uxap.ObjectPageHeader` itself
|
|
2330
2338
|
*/
|
|
@@ -2345,7 +2353,9 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2345
2353
|
/**
|
|
2346
2354
|
* The function to be called when the event occurs
|
|
2347
2355
|
*/
|
|
2348
|
-
fnFunction: (
|
|
2356
|
+
fnFunction: (
|
|
2357
|
+
p1: Event<$ObjectPageHeaderMarkChangesPressEventParameters>
|
|
2358
|
+
) => void,
|
|
2349
2359
|
/**
|
|
2350
2360
|
* Context object to call the event handler with. Defaults to this `sap.uxap.ObjectPageHeader` itself
|
|
2351
2361
|
*/
|
|
@@ -2371,7 +2381,9 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2371
2381
|
/**
|
|
2372
2382
|
* The function to be called when the event occurs
|
|
2373
2383
|
*/
|
|
2374
|
-
fnFunction: (
|
|
2384
|
+
fnFunction: (
|
|
2385
|
+
p1: Event<$ObjectPageHeaderMarkLockedPressEventParameters>
|
|
2386
|
+
) => void,
|
|
2375
2387
|
/**
|
|
2376
2388
|
* Context object to call the event handler with. Defaults to this `sap.uxap.ObjectPageHeader` itself
|
|
2377
2389
|
*/
|
|
@@ -2392,7 +2404,9 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2392
2404
|
/**
|
|
2393
2405
|
* The function to be called when the event occurs
|
|
2394
2406
|
*/
|
|
2395
|
-
fnFunction: (
|
|
2407
|
+
fnFunction: (
|
|
2408
|
+
p1: Event<$ObjectPageHeaderMarkLockedPressEventParameters>
|
|
2409
|
+
) => void,
|
|
2396
2410
|
/**
|
|
2397
2411
|
* Context object to call the event handler with. Defaults to this `sap.uxap.ObjectPageHeader` itself
|
|
2398
2412
|
*/
|
|
@@ -2418,7 +2432,9 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2418
2432
|
/**
|
|
2419
2433
|
* The function to be called when the event occurs
|
|
2420
2434
|
*/
|
|
2421
|
-
fnFunction: (
|
|
2435
|
+
fnFunction: (
|
|
2436
|
+
p1: Event<$ObjectPageHeaderTitleSelectorPressEventParameters>
|
|
2437
|
+
) => void,
|
|
2422
2438
|
/**
|
|
2423
2439
|
* Context object to call the event handler with. Defaults to this `sap.uxap.ObjectPageHeader` itself
|
|
2424
2440
|
*/
|
|
@@ -2439,7 +2455,9 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2439
2455
|
/**
|
|
2440
2456
|
* The function to be called when the event occurs
|
|
2441
2457
|
*/
|
|
2442
|
-
fnFunction: (
|
|
2458
|
+
fnFunction: (
|
|
2459
|
+
p1: Event<$ObjectPageHeaderTitleSelectorPressEventParameters>
|
|
2460
|
+
) => void,
|
|
2443
2461
|
/**
|
|
2444
2462
|
* Context object to call the event handler with. Defaults to this `sap.uxap.ObjectPageHeader` itself
|
|
2445
2463
|
*/
|
|
@@ -2501,7 +2519,9 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2501
2519
|
/**
|
|
2502
2520
|
* The function to be called, when the event occurs
|
|
2503
2521
|
*/
|
|
2504
|
-
fnFunction: (
|
|
2522
|
+
fnFunction: (
|
|
2523
|
+
p1: Event<$ObjectPageHeaderMarkChangesPressEventParameters>
|
|
2524
|
+
) => void,
|
|
2505
2525
|
/**
|
|
2506
2526
|
* Context object on which the given function had to be called
|
|
2507
2527
|
*/
|
|
@@ -2519,7 +2539,9 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2519
2539
|
/**
|
|
2520
2540
|
* The function to be called, when the event occurs
|
|
2521
2541
|
*/
|
|
2522
|
-
fnFunction: (
|
|
2542
|
+
fnFunction: (
|
|
2543
|
+
p1: Event<$ObjectPageHeaderMarkLockedPressEventParameters>
|
|
2544
|
+
) => void,
|
|
2523
2545
|
/**
|
|
2524
2546
|
* Context object on which the given function had to be called
|
|
2525
2547
|
*/
|
|
@@ -2537,7 +2559,9 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2537
2559
|
/**
|
|
2538
2560
|
* The function to be called, when the event occurs
|
|
2539
2561
|
*/
|
|
2540
|
-
fnFunction: (
|
|
2562
|
+
fnFunction: (
|
|
2563
|
+
p1: Event<$ObjectPageHeaderTitleSelectorPressEventParameters>
|
|
2564
|
+
) => void,
|
|
2541
2565
|
/**
|
|
2542
2566
|
* Context object on which the given function had to be called
|
|
2543
2567
|
*/
|
|
@@ -2554,12 +2578,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2554
2578
|
/**
|
|
2555
2579
|
* Parameters to pass along with the event
|
|
2556
2580
|
*/
|
|
2557
|
-
mParameters?:
|
|
2558
|
-
/**
|
|
2559
|
-
* DOM reference of the changed item's icon to be used for positioning.
|
|
2560
|
-
*/
|
|
2561
|
-
domRef?: string;
|
|
2562
|
-
}
|
|
2581
|
+
mParameters?: $ObjectPageHeaderMarkChangesPressEventParameters
|
|
2563
2582
|
): this;
|
|
2564
2583
|
/**
|
|
2565
2584
|
* @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
@@ -2572,12 +2591,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2572
2591
|
/**
|
|
2573
2592
|
* Parameters to pass along with the event
|
|
2574
2593
|
*/
|
|
2575
|
-
mParameters?:
|
|
2576
|
-
/**
|
|
2577
|
-
* DOM reference of the lock item's icon to be used for positioning.
|
|
2578
|
-
*/
|
|
2579
|
-
domRef?: string;
|
|
2580
|
-
}
|
|
2594
|
+
mParameters?: $ObjectPageHeaderMarkLockedPressEventParameters
|
|
2581
2595
|
): this;
|
|
2582
2596
|
/**
|
|
2583
2597
|
* @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
@@ -2590,12 +2604,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2590
2604
|
/**
|
|
2591
2605
|
* Parameters to pass along with the event
|
|
2592
2606
|
*/
|
|
2593
|
-
mParameters?:
|
|
2594
|
-
/**
|
|
2595
|
-
* DOM reference of the title item's icon to be used for positioning.
|
|
2596
|
-
*/
|
|
2597
|
-
domRef?: string;
|
|
2598
|
-
}
|
|
2607
|
+
mParameters?: $ObjectPageHeaderTitleSelectorPressEventParameters
|
|
2599
2608
|
): this;
|
|
2600
2609
|
/**
|
|
2601
2610
|
* Gets content of aggregation {@link #getActions actions}.
|
|
@@ -3315,6 +3324,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
3315
3324
|
vTitleSelectorTooltip: TooltipBase | string
|
|
3316
3325
|
): this;
|
|
3317
3326
|
}
|
|
3327
|
+
export default ObjectPageHeader;
|
|
3318
3328
|
|
|
3319
3329
|
export interface $ObjectPageHeaderSettings extends $ControlSettings {
|
|
3320
3330
|
/**
|
|
@@ -3489,17 +3499,44 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
3489
3499
|
/**
|
|
3490
3500
|
* The event is fired when the objectPage header title selector (down-arrow) is pressed
|
|
3491
3501
|
*/
|
|
3492
|
-
titleSelectorPress?: (
|
|
3502
|
+
titleSelectorPress?: (
|
|
3503
|
+
oEvent: Event<$ObjectPageHeaderTitleSelectorPressEventParameters>
|
|
3504
|
+
) => void;
|
|
3493
3505
|
|
|
3494
3506
|
/**
|
|
3495
3507
|
* The event is fired when the Locked button is pressed
|
|
3496
3508
|
*/
|
|
3497
|
-
markLockedPress?: (
|
|
3509
|
+
markLockedPress?: (
|
|
3510
|
+
oEvent: Event<$ObjectPageHeaderMarkLockedPressEventParameters>
|
|
3511
|
+
) => void;
|
|
3498
3512
|
|
|
3499
3513
|
/**
|
|
3500
3514
|
* The event is fired when the unsaved changes button is pressed
|
|
3501
3515
|
*/
|
|
3502
|
-
markChangesPress?: (
|
|
3516
|
+
markChangesPress?: (
|
|
3517
|
+
oEvent: Event<$ObjectPageHeaderMarkChangesPressEventParameters>
|
|
3518
|
+
) => void;
|
|
3519
|
+
}
|
|
3520
|
+
|
|
3521
|
+
export interface $ObjectPageHeaderMarkChangesPressEventParameters {
|
|
3522
|
+
/**
|
|
3523
|
+
* DOM reference of the changed item's icon to be used for positioning.
|
|
3524
|
+
*/
|
|
3525
|
+
domRef?: string;
|
|
3526
|
+
}
|
|
3527
|
+
|
|
3528
|
+
export interface $ObjectPageHeaderMarkLockedPressEventParameters {
|
|
3529
|
+
/**
|
|
3530
|
+
* DOM reference of the lock item's icon to be used for positioning.
|
|
3531
|
+
*/
|
|
3532
|
+
domRef?: string;
|
|
3533
|
+
}
|
|
3534
|
+
|
|
3535
|
+
export interface $ObjectPageHeaderTitleSelectorPressEventParameters {
|
|
3536
|
+
/**
|
|
3537
|
+
* DOM reference of the title item's icon to be used for positioning.
|
|
3538
|
+
*/
|
|
3539
|
+
domRef?: string;
|
|
3503
3540
|
}
|
|
3504
3541
|
}
|
|
3505
3542
|
|
|
@@ -3522,7 +3559,7 @@ declare module "sap/uxap/ObjectPageHeaderActionButton" {
|
|
|
3522
3559
|
* The button is designed to be used with {@link sap.uxap.ObjectPageHeader} and any usage outside the intended
|
|
3523
3560
|
* context is not recommended.
|
|
3524
3561
|
*/
|
|
3525
|
-
|
|
3562
|
+
class ObjectPageHeaderActionButton
|
|
3526
3563
|
extends Button
|
|
3527
3564
|
implements IOverflowToolbarContent {
|
|
3528
3565
|
__implements__sap_m_IOverflowToolbarContent: boolean;
|
|
@@ -3680,6 +3717,7 @@ declare module "sap/uxap/ObjectPageHeaderActionButton" {
|
|
|
3680
3717
|
sImportance?: Importance | keyof typeof Importance
|
|
3681
3718
|
): this;
|
|
3682
3719
|
}
|
|
3720
|
+
export default ObjectPageHeaderActionButton;
|
|
3683
3721
|
|
|
3684
3722
|
export interface $ObjectPageHeaderActionButtonSettings
|
|
3685
3723
|
extends $ButtonSettings {
|
|
@@ -3734,13 +3772,11 @@ declare module "sap/uxap/ObjectPageHeaderContent" {
|
|
|
3734
3772
|
* additional information of the object.
|
|
3735
3773
|
*
|
|
3736
3774
|
* Documentation links:
|
|
3737
|
-
* - {@link topic
|
|
3738
|
-
* - {@link topic
|
|
3775
|
+
* - {@link https://ui5.sap.com/#/topic/d2ef0099542d44dc868719d908e576d0 Object Page Headers}
|
|
3776
|
+
* - {@link https://ui5.sap.com/#/topic/0fecbce45e39406aa939bd25e89823f4 Object Page Classic Header}
|
|
3739
3777
|
* - {@link https://experience.sap.com/fiori-design-web/object-page/ UX Guidelines: Object Page}
|
|
3740
3778
|
*/
|
|
3741
|
-
|
|
3742
|
-
extends Control
|
|
3743
|
-
implements IHeaderContent {
|
|
3779
|
+
class ObjectPageHeaderContent extends Control implements IHeaderContent {
|
|
3744
3780
|
__implements__sap_uxap_IHeaderContent: boolean;
|
|
3745
3781
|
/**
|
|
3746
3782
|
* Constructor for a new `ObjectPageHeaderContent`.
|
|
@@ -3749,8 +3785,7 @@ declare module "sap/uxap/ObjectPageHeaderContent" {
|
|
|
3749
3785
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
3750
3786
|
* of the syntax of the settings object.
|
|
3751
3787
|
* See:
|
|
3752
|
-
* {@link fiori:https://experience.sap.com/fiori-design-web/snapping-header/#header-content Object Page
|
|
3753
|
-
* Header Content}
|
|
3788
|
+
* {@link fiori:https://experience.sap.com/fiori-design-web/snapping-header/#header-content Object Page Header Content}
|
|
3754
3789
|
*/
|
|
3755
3790
|
constructor(
|
|
3756
3791
|
/**
|
|
@@ -3765,8 +3800,7 @@ declare module "sap/uxap/ObjectPageHeaderContent" {
|
|
|
3765
3800
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
3766
3801
|
* of the syntax of the settings object.
|
|
3767
3802
|
* See:
|
|
3768
|
-
* {@link fiori:https://experience.sap.com/fiori-design-web/snapping-header/#header-content Object Page
|
|
3769
|
-
* Header Content}
|
|
3803
|
+
* {@link fiori:https://experience.sap.com/fiori-design-web/snapping-header/#header-content Object Page Header Content}
|
|
3770
3804
|
*/
|
|
3771
3805
|
constructor(
|
|
3772
3806
|
/**
|
|
@@ -3917,6 +3951,7 @@ declare module "sap/uxap/ObjectPageHeaderContent" {
|
|
|
3917
3951
|
| keyof typeof ObjectPageHeaderDesign
|
|
3918
3952
|
): this;
|
|
3919
3953
|
}
|
|
3954
|
+
export default ObjectPageHeaderContent;
|
|
3920
3955
|
|
|
3921
3956
|
export interface $ObjectPageHeaderContentSettings extends $ControlSettings {
|
|
3922
3957
|
/**
|
|
@@ -3958,7 +3993,7 @@ declare module "sap/uxap/ObjectPageHeaderLayoutData" {
|
|
|
3958
3993
|
* **Note:** This element is only taken into account when the `sap.uxap.ObjectPageLayout` control is used
|
|
3959
3994
|
* together with `sap.uxap.ObjectPageHeader` as value of `headerTitle`.
|
|
3960
3995
|
*/
|
|
3961
|
-
|
|
3996
|
+
class ObjectPageHeaderLayoutData extends LayoutData {
|
|
3962
3997
|
/**
|
|
3963
3998
|
* Constructor for a new `ObjectPageHeaderLayoutData`.
|
|
3964
3999
|
*
|
|
@@ -4182,6 +4217,7 @@ declare module "sap/uxap/ObjectPageHeaderLayoutData" {
|
|
|
4182
4217
|
sWidth?: CSSSize
|
|
4183
4218
|
): this;
|
|
4184
4219
|
}
|
|
4220
|
+
export default ObjectPageHeaderLayoutData;
|
|
4185
4221
|
|
|
4186
4222
|
export interface $ObjectPageHeaderLayoutDataSettings
|
|
4187
4223
|
extends $LayoutDataSettings {
|
|
@@ -4224,8 +4260,6 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4224
4260
|
|
|
4225
4261
|
import Event from "sap/ui/base/Event";
|
|
4226
4262
|
|
|
4227
|
-
import ObjectPageSubSection from "sap/uxap/ObjectPageSubSection";
|
|
4228
|
-
|
|
4229
4263
|
import { BackgroundDesign, IBar } from "sap/m/library";
|
|
4230
4264
|
|
|
4231
4265
|
import { IHeaderTitle, ObjectPageSubSectionLayout } from "sap/uxap/library";
|
|
@@ -4244,6 +4278,8 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4244
4278
|
AggregationBindingInfo,
|
|
4245
4279
|
} from "sap/ui/base/ManagedObject";
|
|
4246
4280
|
|
|
4281
|
+
import ObjectPageSubSection from "sap/uxap/ObjectPageSubSection";
|
|
4282
|
+
|
|
4247
4283
|
/**
|
|
4248
4284
|
* @SINCE 1.26
|
|
4249
4285
|
*
|
|
@@ -4284,7 +4320,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4284
4320
|
*
|
|
4285
4321
|
* The `ObjectPageLayout` is responsive and adapts to all screen sizes.
|
|
4286
4322
|
*/
|
|
4287
|
-
|
|
4323
|
+
class ObjectPageLayout extends Control {
|
|
4288
4324
|
/**
|
|
4289
4325
|
* Constructor for a new `ObjectPageLayout`.
|
|
4290
4326
|
*
|
|
@@ -4292,15 +4328,14 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4292
4328
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
4293
4329
|
* of the syntax of the settings object.
|
|
4294
4330
|
* See:
|
|
4295
|
-
* {@link topic
|
|
4296
|
-
* {@link topic
|
|
4297
|
-
* {@link topic
|
|
4298
|
-
* {@link topic
|
|
4299
|
-
* {@link topic
|
|
4300
|
-
* {@link topic
|
|
4331
|
+
* {@link https://ui5.sap.com/#/topic/2e61ab6c68a2480eb666c1927a707658 Object Page Layout}
|
|
4332
|
+
* {@link https://ui5.sap.com/#/topic/d2ef0099542d44dc868719d908e576d0 Object Page Headers}
|
|
4333
|
+
* {@link https://ui5.sap.com/#/topic/370b67986497463187336fa130aebbf1 Anchor Bar}
|
|
4334
|
+
* {@link https://ui5.sap.com/#/topic/4527729576cb4a4888275b6935aad03a Object Page Blocks}
|
|
4335
|
+
* {@link https://ui5.sap.com/#/topic/2978f6064742456ebed31c5ccf4d051d Creating Blocks}
|
|
4336
|
+
* {@link https://ui5.sap.com/#/topic/bc410e94e46540efa02857e15aae583f Object Page Scrolling}
|
|
4301
4337
|
* {@link fiori:https://experience.sap.com/fiori-design-web/object-page/ Object Page Layout}
|
|
4302
|
-
* {@link fiori:https://experience.sap.com/fiori-design-web/snapping-header/ UX Guidelines: Object Page
|
|
4303
|
-
* - Snapping Header}
|
|
4338
|
+
* {@link fiori:https://experience.sap.com/fiori-design-web/snapping-header/ UX Guidelines: Object Page - Snapping Header}
|
|
4304
4339
|
*/
|
|
4305
4340
|
constructor(
|
|
4306
4341
|
/**
|
|
@@ -4315,15 +4350,14 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4315
4350
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
4316
4351
|
* of the syntax of the settings object.
|
|
4317
4352
|
* See:
|
|
4318
|
-
* {@link topic
|
|
4319
|
-
* {@link topic
|
|
4320
|
-
* {@link topic
|
|
4321
|
-
* {@link topic
|
|
4322
|
-
* {@link topic
|
|
4323
|
-
* {@link topic
|
|
4353
|
+
* {@link https://ui5.sap.com/#/topic/2e61ab6c68a2480eb666c1927a707658 Object Page Layout}
|
|
4354
|
+
* {@link https://ui5.sap.com/#/topic/d2ef0099542d44dc868719d908e576d0 Object Page Headers}
|
|
4355
|
+
* {@link https://ui5.sap.com/#/topic/370b67986497463187336fa130aebbf1 Anchor Bar}
|
|
4356
|
+
* {@link https://ui5.sap.com/#/topic/4527729576cb4a4888275b6935aad03a Object Page Blocks}
|
|
4357
|
+
* {@link https://ui5.sap.com/#/topic/2978f6064742456ebed31c5ccf4d051d Creating Blocks}
|
|
4358
|
+
* {@link https://ui5.sap.com/#/topic/bc410e94e46540efa02857e15aae583f Object Page Scrolling}
|
|
4324
4359
|
* {@link fiori:https://experience.sap.com/fiori-design-web/object-page/ Object Page Layout}
|
|
4325
|
-
* {@link fiori:https://experience.sap.com/fiori-design-web/snapping-header/ UX Guidelines: Object Page
|
|
4326
|
-
* - Snapping Header}
|
|
4360
|
+
* {@link fiori:https://experience.sap.com/fiori-design-web/snapping-header/ UX Guidelines: Object Page - Snapping Header}
|
|
4327
4361
|
*/
|
|
4328
4362
|
constructor(
|
|
4329
4363
|
/**
|
|
@@ -4388,7 +4422,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4388
4422
|
oSection: ObjectPageSection
|
|
4389
4423
|
): this;
|
|
4390
4424
|
/**
|
|
4391
|
-
* Attaches event handler `fnFunction` to the {@link #event:editHeaderButtonPress editHeaderButtonPress}
|
|
4425
|
+
* Attaches event handler `fnFunction` to the {@link #event:editHeaderButtonPress editHeaderButtonPress }
|
|
4392
4426
|
* event of this `sap.uxap.ObjectPageLayout`.
|
|
4393
4427
|
*
|
|
4394
4428
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
@@ -4414,7 +4448,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4414
4448
|
oListener?: object
|
|
4415
4449
|
): this;
|
|
4416
4450
|
/**
|
|
4417
|
-
* Attaches event handler `fnFunction` to the {@link #event:editHeaderButtonPress editHeaderButtonPress}
|
|
4451
|
+
* Attaches event handler `fnFunction` to the {@link #event:editHeaderButtonPress editHeaderButtonPress }
|
|
4418
4452
|
* event of this `sap.uxap.ObjectPageLayout`.
|
|
4419
4453
|
*
|
|
4420
4454
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
@@ -4437,7 +4471,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4437
4471
|
/**
|
|
4438
4472
|
* @SINCE 1.93
|
|
4439
4473
|
*
|
|
4440
|
-
* Attaches event handler `fnFunction` to the {@link #event:headerContentPinnedStateChange headerContentPinnedStateChange}
|
|
4474
|
+
* Attaches event handler `fnFunction` to the {@link #event:headerContentPinnedStateChange headerContentPinnedStateChange }
|
|
4441
4475
|
* event of this `sap.uxap.ObjectPageLayout`.
|
|
4442
4476
|
*
|
|
4443
4477
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
@@ -4456,7 +4490,9 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4456
4490
|
/**
|
|
4457
4491
|
* The function to be called when the event occurs
|
|
4458
4492
|
*/
|
|
4459
|
-
fnFunction: (
|
|
4493
|
+
fnFunction: (
|
|
4494
|
+
p1: Event<$ObjectPageLayoutHeaderContentPinnedStateChangeEventParameters>
|
|
4495
|
+
) => void,
|
|
4460
4496
|
/**
|
|
4461
4497
|
* Context object to call the event handler with. Defaults to this `sap.uxap.ObjectPageLayout` itself
|
|
4462
4498
|
*/
|
|
@@ -4465,7 +4501,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4465
4501
|
/**
|
|
4466
4502
|
* @SINCE 1.93
|
|
4467
4503
|
*
|
|
4468
|
-
* Attaches event handler `fnFunction` to the {@link #event:headerContentPinnedStateChange headerContentPinnedStateChange}
|
|
4504
|
+
* Attaches event handler `fnFunction` to the {@link #event:headerContentPinnedStateChange headerContentPinnedStateChange }
|
|
4469
4505
|
* event of this `sap.uxap.ObjectPageLayout`.
|
|
4470
4506
|
*
|
|
4471
4507
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
@@ -4479,7 +4515,9 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4479
4515
|
/**
|
|
4480
4516
|
* The function to be called when the event occurs
|
|
4481
4517
|
*/
|
|
4482
|
-
fnFunction: (
|
|
4518
|
+
fnFunction: (
|
|
4519
|
+
p1: Event<$ObjectPageLayoutHeaderContentPinnedStateChangeEventParameters>
|
|
4520
|
+
) => void,
|
|
4483
4521
|
/**
|
|
4484
4522
|
* Context object to call the event handler with. Defaults to this `sap.uxap.ObjectPageLayout` itself
|
|
4485
4523
|
*/
|
|
@@ -4506,7 +4544,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4506
4544
|
/**
|
|
4507
4545
|
* The function to be called when the event occurs
|
|
4508
4546
|
*/
|
|
4509
|
-
fnFunction: (p1: Event) => void,
|
|
4547
|
+
fnFunction: (p1: Event<$ObjectPageLayoutNavigateEventParameters>) => void,
|
|
4510
4548
|
/**
|
|
4511
4549
|
* Context object to call the event handler with. Defaults to this `sap.uxap.ObjectPageLayout` itself
|
|
4512
4550
|
*/
|
|
@@ -4528,7 +4566,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4528
4566
|
/**
|
|
4529
4567
|
* The function to be called when the event occurs
|
|
4530
4568
|
*/
|
|
4531
|
-
fnFunction: (p1: Event) => void,
|
|
4569
|
+
fnFunction: (p1: Event<$ObjectPageLayoutNavigateEventParameters>) => void,
|
|
4532
4570
|
/**
|
|
4533
4571
|
* Context object to call the event handler with. Defaults to this `sap.uxap.ObjectPageLayout` itself
|
|
4534
4572
|
*/
|
|
@@ -4555,7 +4593,9 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4555
4593
|
/**
|
|
4556
4594
|
* The function to be called when the event occurs
|
|
4557
4595
|
*/
|
|
4558
|
-
fnFunction: (
|
|
4596
|
+
fnFunction: (
|
|
4597
|
+
p1: Event<$ObjectPageLayoutSectionChangeEventParameters>
|
|
4598
|
+
) => void,
|
|
4559
4599
|
/**
|
|
4560
4600
|
* Context object to call the event handler with. Defaults to this `sap.uxap.ObjectPageLayout` itself
|
|
4561
4601
|
*/
|
|
@@ -4577,7 +4617,9 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4577
4617
|
/**
|
|
4578
4618
|
* The function to be called when the event occurs
|
|
4579
4619
|
*/
|
|
4580
|
-
fnFunction: (
|
|
4620
|
+
fnFunction: (
|
|
4621
|
+
p1: Event<$ObjectPageLayoutSectionChangeEventParameters>
|
|
4622
|
+
) => void,
|
|
4581
4623
|
/**
|
|
4582
4624
|
* Context object to call the event handler with. Defaults to this `sap.uxap.ObjectPageLayout` itself
|
|
4583
4625
|
*/
|
|
@@ -4586,7 +4628,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4586
4628
|
/**
|
|
4587
4629
|
* @SINCE 1.77
|
|
4588
4630
|
*
|
|
4589
|
-
* Attaches event handler `fnFunction` to the {@link #event:subSectionVisibilityChange subSectionVisibilityChange}
|
|
4631
|
+
* Attaches event handler `fnFunction` to the {@link #event:subSectionVisibilityChange subSectionVisibilityChange }
|
|
4590
4632
|
* event of this `sap.uxap.ObjectPageLayout`.
|
|
4591
4633
|
*
|
|
4592
4634
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
@@ -4605,7 +4647,9 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4605
4647
|
/**
|
|
4606
4648
|
* The function to be called when the event occurs
|
|
4607
4649
|
*/
|
|
4608
|
-
fnFunction: (
|
|
4650
|
+
fnFunction: (
|
|
4651
|
+
p1: Event<$ObjectPageLayoutSubSectionVisibilityChangeEventParameters>
|
|
4652
|
+
) => void,
|
|
4609
4653
|
/**
|
|
4610
4654
|
* Context object to call the event handler with. Defaults to this `sap.uxap.ObjectPageLayout` itself
|
|
4611
4655
|
*/
|
|
@@ -4614,7 +4658,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4614
4658
|
/**
|
|
4615
4659
|
* @SINCE 1.77
|
|
4616
4660
|
*
|
|
4617
|
-
* Attaches event handler `fnFunction` to the {@link #event:subSectionVisibilityChange subSectionVisibilityChange}
|
|
4661
|
+
* Attaches event handler `fnFunction` to the {@link #event:subSectionVisibilityChange subSectionVisibilityChange }
|
|
4618
4662
|
* event of this `sap.uxap.ObjectPageLayout`.
|
|
4619
4663
|
*
|
|
4620
4664
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
@@ -4628,7 +4672,9 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4628
4672
|
/**
|
|
4629
4673
|
* The function to be called when the event occurs
|
|
4630
4674
|
*/
|
|
4631
|
-
fnFunction: (
|
|
4675
|
+
fnFunction: (
|
|
4676
|
+
p1: Event<$ObjectPageLayoutSubSectionVisibilityChangeEventParameters>
|
|
4677
|
+
) => void,
|
|
4632
4678
|
/**
|
|
4633
4679
|
* Context object to call the event handler with. Defaults to this `sap.uxap.ObjectPageLayout` itself
|
|
4634
4680
|
*/
|
|
@@ -4654,7 +4700,9 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4654
4700
|
/**
|
|
4655
4701
|
* The function to be called when the event occurs
|
|
4656
4702
|
*/
|
|
4657
|
-
fnFunction: (
|
|
4703
|
+
fnFunction: (
|
|
4704
|
+
p1: Event<$ObjectPageLayoutToggleAnchorBarEventParameters>
|
|
4705
|
+
) => void,
|
|
4658
4706
|
/**
|
|
4659
4707
|
* Context object to call the event handler with. Defaults to this `sap.uxap.ObjectPageLayout` itself
|
|
4660
4708
|
*/
|
|
@@ -4675,7 +4723,9 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4675
4723
|
/**
|
|
4676
4724
|
* The function to be called when the event occurs
|
|
4677
4725
|
*/
|
|
4678
|
-
fnFunction: (
|
|
4726
|
+
fnFunction: (
|
|
4727
|
+
p1: Event<$ObjectPageLayoutToggleAnchorBarEventParameters>
|
|
4728
|
+
) => void,
|
|
4679
4729
|
/**
|
|
4680
4730
|
* Context object to call the event handler with. Defaults to this `sap.uxap.ObjectPageLayout` itself
|
|
4681
4731
|
*/
|
|
@@ -4716,7 +4766,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4716
4766
|
*/
|
|
4717
4767
|
destroySections(): this;
|
|
4718
4768
|
/**
|
|
4719
|
-
* Detaches event handler `fnFunction` from the {@link #event:editHeaderButtonPress editHeaderButtonPress}
|
|
4769
|
+
* Detaches event handler `fnFunction` from the {@link #event:editHeaderButtonPress editHeaderButtonPress }
|
|
4720
4770
|
* event of this `sap.uxap.ObjectPageLayout`.
|
|
4721
4771
|
*
|
|
4722
4772
|
* The passed function and listener object must match the ones used for event registration.
|
|
@@ -4736,7 +4786,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4736
4786
|
/**
|
|
4737
4787
|
* @SINCE 1.93
|
|
4738
4788
|
*
|
|
4739
|
-
* Detaches event handler `fnFunction` from the {@link #event:headerContentPinnedStateChange headerContentPinnedStateChange}
|
|
4789
|
+
* Detaches event handler `fnFunction` from the {@link #event:headerContentPinnedStateChange headerContentPinnedStateChange }
|
|
4740
4790
|
* event of this `sap.uxap.ObjectPageLayout`.
|
|
4741
4791
|
*
|
|
4742
4792
|
* The passed function and listener object must match the ones used for event registration.
|
|
@@ -4747,7 +4797,9 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4747
4797
|
/**
|
|
4748
4798
|
* The function to be called, when the event occurs
|
|
4749
4799
|
*/
|
|
4750
|
-
fnFunction: (
|
|
4800
|
+
fnFunction: (
|
|
4801
|
+
p1: Event<$ObjectPageLayoutHeaderContentPinnedStateChangeEventParameters>
|
|
4802
|
+
) => void,
|
|
4751
4803
|
/**
|
|
4752
4804
|
* Context object on which the given function had to be called
|
|
4753
4805
|
*/
|
|
@@ -4766,7 +4818,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4766
4818
|
/**
|
|
4767
4819
|
* The function to be called, when the event occurs
|
|
4768
4820
|
*/
|
|
4769
|
-
fnFunction: (p1: Event) => void,
|
|
4821
|
+
fnFunction: (p1: Event<$ObjectPageLayoutNavigateEventParameters>) => void,
|
|
4770
4822
|
/**
|
|
4771
4823
|
* Context object on which the given function had to be called
|
|
4772
4824
|
*/
|
|
@@ -4786,7 +4838,9 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4786
4838
|
/**
|
|
4787
4839
|
* The function to be called, when the event occurs
|
|
4788
4840
|
*/
|
|
4789
|
-
fnFunction: (
|
|
4841
|
+
fnFunction: (
|
|
4842
|
+
p1: Event<$ObjectPageLayoutSectionChangeEventParameters>
|
|
4843
|
+
) => void,
|
|
4790
4844
|
/**
|
|
4791
4845
|
* Context object on which the given function had to be called
|
|
4792
4846
|
*/
|
|
@@ -4795,7 +4849,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4795
4849
|
/**
|
|
4796
4850
|
* @SINCE 1.77
|
|
4797
4851
|
*
|
|
4798
|
-
* Detaches event handler `fnFunction` from the {@link #event:subSectionVisibilityChange subSectionVisibilityChange}
|
|
4852
|
+
* Detaches event handler `fnFunction` from the {@link #event:subSectionVisibilityChange subSectionVisibilityChange }
|
|
4799
4853
|
* event of this `sap.uxap.ObjectPageLayout`.
|
|
4800
4854
|
*
|
|
4801
4855
|
* The passed function and listener object must match the ones used for event registration.
|
|
@@ -4806,7 +4860,9 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4806
4860
|
/**
|
|
4807
4861
|
* The function to be called, when the event occurs
|
|
4808
4862
|
*/
|
|
4809
|
-
fnFunction: (
|
|
4863
|
+
fnFunction: (
|
|
4864
|
+
p1: Event<$ObjectPageLayoutSubSectionVisibilityChangeEventParameters>
|
|
4865
|
+
) => void,
|
|
4810
4866
|
/**
|
|
4811
4867
|
* Context object on which the given function had to be called
|
|
4812
4868
|
*/
|
|
@@ -4824,7 +4880,9 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4824
4880
|
/**
|
|
4825
4881
|
* The function to be called, when the event occurs
|
|
4826
4882
|
*/
|
|
4827
|
-
fnFunction: (
|
|
4883
|
+
fnFunction: (
|
|
4884
|
+
p1: Event<$ObjectPageLayoutToggleAnchorBarEventParameters>
|
|
4885
|
+
) => void,
|
|
4828
4886
|
/**
|
|
4829
4887
|
* Context object on which the given function had to be called
|
|
4830
4888
|
*/
|
|
@@ -4856,12 +4914,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4856
4914
|
/**
|
|
4857
4915
|
* Parameters to pass along with the event
|
|
4858
4916
|
*/
|
|
4859
|
-
mParameters?:
|
|
4860
|
-
/**
|
|
4861
|
-
* False or True values indicate the new pinned property value.
|
|
4862
|
-
*/
|
|
4863
|
-
pinned?: boolean;
|
|
4864
|
-
}
|
|
4917
|
+
mParameters?: $ObjectPageLayoutHeaderContentPinnedStateChangeEventParameters
|
|
4865
4918
|
): this;
|
|
4866
4919
|
/**
|
|
4867
4920
|
* @SINCE 1.40
|
|
@@ -4875,16 +4928,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4875
4928
|
/**
|
|
4876
4929
|
* Parameters to pass along with the event
|
|
4877
4930
|
*/
|
|
4878
|
-
mParameters?:
|
|
4879
|
-
/**
|
|
4880
|
-
* The selected section object.
|
|
4881
|
-
*/
|
|
4882
|
-
section?: ObjectPageSection;
|
|
4883
|
-
/**
|
|
4884
|
-
* The selected subsection object.
|
|
4885
|
-
*/
|
|
4886
|
-
subSection?: ObjectPageSubSection;
|
|
4887
|
-
}
|
|
4931
|
+
mParameters?: $ObjectPageLayoutNavigateEventParameters
|
|
4888
4932
|
): this;
|
|
4889
4933
|
/**
|
|
4890
4934
|
* @SINCE 1.73
|
|
@@ -4898,16 +4942,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4898
4942
|
/**
|
|
4899
4943
|
* Parameters to pass along with the event
|
|
4900
4944
|
*/
|
|
4901
|
-
mParameters?:
|
|
4902
|
-
/**
|
|
4903
|
-
* The section which the layout is scrolled to.
|
|
4904
|
-
*/
|
|
4905
|
-
section?: ObjectPageSection;
|
|
4906
|
-
/**
|
|
4907
|
-
* The subsection which the layout is scrolled to.
|
|
4908
|
-
*/
|
|
4909
|
-
subSection?: ObjectPageSubSection;
|
|
4910
|
-
}
|
|
4945
|
+
mParameters?: $ObjectPageLayoutSectionChangeEventParameters
|
|
4911
4946
|
): this;
|
|
4912
4947
|
/**
|
|
4913
4948
|
* @SINCE 1.77
|
|
@@ -4921,12 +4956,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4921
4956
|
/**
|
|
4922
4957
|
* Parameters to pass along with the event
|
|
4923
4958
|
*/
|
|
4924
|
-
mParameters?:
|
|
4925
|
-
/**
|
|
4926
|
-
* Object whose keys are the visible SubSection IDs and their values are the SubSection instances
|
|
4927
|
-
*/
|
|
4928
|
-
visibleSubSections?: object;
|
|
4929
|
-
}
|
|
4959
|
+
mParameters?: $ObjectPageLayoutSubSectionVisibilityChangeEventParameters
|
|
4930
4960
|
): this;
|
|
4931
4961
|
/**
|
|
4932
4962
|
* @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
@@ -4939,13 +4969,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4939
4969
|
/**
|
|
4940
4970
|
* Parameters to pass along with the event
|
|
4941
4971
|
*/
|
|
4942
|
-
mParameters?:
|
|
4943
|
-
/**
|
|
4944
|
-
* False indicates that the Anchor bar has just detached from the Header and became part of the scrolling
|
|
4945
|
-
* area. True means that the Anchor bar has just snapped to the Header.
|
|
4946
|
-
*/
|
|
4947
|
-
fixed?: boolean;
|
|
4948
|
-
}
|
|
4972
|
+
mParameters?: $ObjectPageLayoutToggleAnchorBarEventParameters
|
|
4949
4973
|
): this;
|
|
4950
4974
|
/**
|
|
4951
4975
|
* @SINCE 1.34.0
|
|
@@ -5109,10 +5133,10 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5109
5133
|
*
|
|
5110
5134
|
* **Notes:**
|
|
5111
5135
|
* - This property is only taken into account if an instance of `sap.uxap.ObjectPageDynamicHeaderTitle`
|
|
5112
|
-
*
|
|
5136
|
+
* is used for the `headerTitle` aggregation.
|
|
5113
5137
|
* - Based on internal rules, the value of the property is not always taken into account - for example,
|
|
5114
|
-
*
|
|
5115
|
-
*
|
|
5138
|
+
* when the control is rendered on tablet or mobile and the control`s title and header are with height larger
|
|
5139
|
+
* than the given threshold.
|
|
5116
5140
|
*
|
|
5117
5141
|
* Default value is `false`.
|
|
5118
5142
|
*
|
|
@@ -5147,18 +5171,18 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5147
5171
|
*
|
|
5148
5172
|
* **Note:**
|
|
5149
5173
|
* - Defining a `sectionTitleLevel` will add `aria-level` attribute from 1 to 6 instead of changing the
|
|
5150
|
-
*
|
|
5174
|
+
* titles` HTML tag from H1 to H6.
|
|
5151
5175
|
* For example: if `sectionTitleLevel` is `TitleLevel.H1`, it will result as aria-level of 1 added to the
|
|
5152
5176
|
* `ObjectPageSection` title.
|
|
5153
5177
|
*
|
|
5154
5178
|
*
|
|
5155
5179
|
* - The `ObjectPageSubSection` title would have `aria-level` one level lower than the defined. For example:
|
|
5156
|
-
*
|
|
5157
|
-
*
|
|
5180
|
+
* if `sectionTitleLevel` is `TitleLevel.H1`, it will result as aria-level of 2 added to the `ObjectPageSubSection`
|
|
5181
|
+
* title.
|
|
5158
5182
|
*
|
|
5159
5183
|
*
|
|
5160
5184
|
* - It is possible to define a `titleLevel` on `ObjectPageSection` or `ObjectPageSubSection` level.
|
|
5161
|
-
*
|
|
5185
|
+
* In this case the value of this property will be ignored.
|
|
5162
5186
|
*
|
|
5163
5187
|
* Default value is `Auto`.
|
|
5164
5188
|
*
|
|
@@ -5662,10 +5686,10 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5662
5686
|
*
|
|
5663
5687
|
* **Notes:**
|
|
5664
5688
|
* - This property is only taken into account if an instance of `sap.uxap.ObjectPageDynamicHeaderTitle`
|
|
5665
|
-
*
|
|
5689
|
+
* is used for the `headerTitle` aggregation.
|
|
5666
5690
|
* - Based on internal rules, the value of the property is not always taken into account - for example,
|
|
5667
|
-
*
|
|
5668
|
-
*
|
|
5691
|
+
* when the control is rendered on tablet or mobile and the control`s title and header are with height larger
|
|
5692
|
+
* than the given threshold.
|
|
5669
5693
|
*
|
|
5670
5694
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
5671
5695
|
*
|
|
@@ -5691,18 +5715,18 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5691
5715
|
*
|
|
5692
5716
|
* **Note:**
|
|
5693
5717
|
* - Defining a `sectionTitleLevel` will add `aria-level` attribute from 1 to 6 instead of changing the
|
|
5694
|
-
*
|
|
5718
|
+
* titles` HTML tag from H1 to H6.
|
|
5695
5719
|
* For example: if `sectionTitleLevel` is `TitleLevel.H1`, it will result as aria-level of 1 added to the
|
|
5696
5720
|
* `ObjectPageSection` title.
|
|
5697
5721
|
*
|
|
5698
5722
|
*
|
|
5699
5723
|
* - The `ObjectPageSubSection` title would have `aria-level` one level lower than the defined. For example:
|
|
5700
|
-
*
|
|
5701
|
-
*
|
|
5724
|
+
* if `sectionTitleLevel` is `TitleLevel.H1`, it will result as aria-level of 2 added to the `ObjectPageSubSection`
|
|
5725
|
+
* title.
|
|
5702
5726
|
*
|
|
5703
5727
|
*
|
|
5704
5728
|
* - It is possible to define a `titleLevel` on `ObjectPageSection` or `ObjectPageSubSection` level.
|
|
5705
|
-
*
|
|
5729
|
+
* In this case the value of this property will be ignored.
|
|
5706
5730
|
*
|
|
5707
5731
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
5708
5732
|
*
|
|
@@ -5967,6 +5991,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5967
5991
|
bUseTwoColumnsForLargeScreen?: boolean
|
|
5968
5992
|
): this;
|
|
5969
5993
|
}
|
|
5994
|
+
export default ObjectPageLayout;
|
|
5970
5995
|
|
|
5971
5996
|
export interface $ObjectPageLayoutSettings extends $ControlSettings {
|
|
5972
5997
|
/**
|
|
@@ -6026,18 +6051,18 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
6026
6051
|
*
|
|
6027
6052
|
* **Note:**
|
|
6028
6053
|
* - Defining a `sectionTitleLevel` will add `aria-level` attribute from 1 to 6 instead of changing the
|
|
6029
|
-
*
|
|
6054
|
+
* titles` HTML tag from H1 to H6.
|
|
6030
6055
|
* For example: if `sectionTitleLevel` is `TitleLevel.H1`, it will result as aria-level of 1 added to the
|
|
6031
6056
|
* `ObjectPageSection` title.
|
|
6032
6057
|
*
|
|
6033
6058
|
*
|
|
6034
6059
|
* - The `ObjectPageSubSection` title would have `aria-level` one level lower than the defined. For example:
|
|
6035
|
-
*
|
|
6036
|
-
*
|
|
6060
|
+
* if `sectionTitleLevel` is `TitleLevel.H1`, it will result as aria-level of 2 added to the `ObjectPageSubSection`
|
|
6061
|
+
* title.
|
|
6037
6062
|
*
|
|
6038
6063
|
*
|
|
6039
6064
|
* - It is possible to define a `titleLevel` on `ObjectPageSection` or `ObjectPageSubSection` level.
|
|
6040
|
-
*
|
|
6065
|
+
* In this case the value of this property will be ignored.
|
|
6041
6066
|
*/
|
|
6042
6067
|
sectionTitleLevel?:
|
|
6043
6068
|
| (TitleLevel | keyof typeof TitleLevel)
|
|
@@ -6152,10 +6177,10 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
6152
6177
|
*
|
|
6153
6178
|
* **Notes:**
|
|
6154
6179
|
* - This property is only taken into account if an instance of `sap.uxap.ObjectPageDynamicHeaderTitle`
|
|
6155
|
-
*
|
|
6180
|
+
* is used for the `headerTitle` aggregation.
|
|
6156
6181
|
* - Based on internal rules, the value of the property is not always taken into account - for example,
|
|
6157
|
-
*
|
|
6158
|
-
*
|
|
6182
|
+
* when the control is rendered on tablet or mobile and the control`s title and header are with height larger
|
|
6183
|
+
* than the given threshold.
|
|
6159
6184
|
*/
|
|
6160
6185
|
preserveHeaderStateOnScroll?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
6161
6186
|
|
|
@@ -6235,19 +6260,25 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
6235
6260
|
*
|
|
6236
6261
|
* The event is fired when the `headerContentPinned` property is changed via user interaction.
|
|
6237
6262
|
*/
|
|
6238
|
-
headerContentPinnedStateChange?: (
|
|
6263
|
+
headerContentPinnedStateChange?: (
|
|
6264
|
+
oEvent: Event<$ObjectPageLayoutHeaderContentPinnedStateChangeEventParameters>
|
|
6265
|
+
) => void;
|
|
6239
6266
|
|
|
6240
6267
|
/**
|
|
6241
6268
|
* The event is fired when the Anchor bar is switched from moving to fixed or the other way round.
|
|
6242
6269
|
*/
|
|
6243
|
-
toggleAnchorBar?: (
|
|
6270
|
+
toggleAnchorBar?: (
|
|
6271
|
+
oEvent: Event<$ObjectPageLayoutToggleAnchorBarEventParameters>
|
|
6272
|
+
) => void;
|
|
6244
6273
|
|
|
6245
6274
|
/**
|
|
6246
6275
|
* @SINCE 1.73
|
|
6247
6276
|
*
|
|
6248
6277
|
* Fired when the current section is changed by scrolling.
|
|
6249
6278
|
*/
|
|
6250
|
-
sectionChange?: (
|
|
6279
|
+
sectionChange?: (
|
|
6280
|
+
oEvent: Event<$ObjectPageLayoutSectionChangeEventParameters>
|
|
6281
|
+
) => void;
|
|
6251
6282
|
|
|
6252
6283
|
/**
|
|
6253
6284
|
* The event is fired when the Edit Header button is pressed
|
|
@@ -6259,14 +6290,66 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
6259
6290
|
*
|
|
6260
6291
|
* The event is fired when the selected section is changed using the navigation.
|
|
6261
6292
|
*/
|
|
6262
|
-
navigate?: (
|
|
6293
|
+
navigate?: (
|
|
6294
|
+
oEvent: Event<$ObjectPageLayoutNavigateEventParameters>
|
|
6295
|
+
) => void;
|
|
6263
6296
|
|
|
6264
6297
|
/**
|
|
6265
6298
|
* @SINCE 1.77
|
|
6266
6299
|
*
|
|
6267
6300
|
* Fired when the visibility of subsections is changed.
|
|
6268
6301
|
*/
|
|
6269
|
-
subSectionVisibilityChange?: (
|
|
6302
|
+
subSectionVisibilityChange?: (
|
|
6303
|
+
oEvent: Event<$ObjectPageLayoutSubSectionVisibilityChangeEventParameters>
|
|
6304
|
+
) => void;
|
|
6305
|
+
}
|
|
6306
|
+
|
|
6307
|
+
export interface $ObjectPageLayoutEditHeaderButtonPressEventParameters {}
|
|
6308
|
+
|
|
6309
|
+
export interface $ObjectPageLayoutHeaderContentPinnedStateChangeEventParameters {
|
|
6310
|
+
/**
|
|
6311
|
+
* False or True values indicate the new pinned property value.
|
|
6312
|
+
*/
|
|
6313
|
+
pinned?: boolean;
|
|
6314
|
+
}
|
|
6315
|
+
|
|
6316
|
+
export interface $ObjectPageLayoutNavigateEventParameters {
|
|
6317
|
+
/**
|
|
6318
|
+
* The selected section object.
|
|
6319
|
+
*/
|
|
6320
|
+
section?: ObjectPageSection;
|
|
6321
|
+
|
|
6322
|
+
/**
|
|
6323
|
+
* The selected subsection object.
|
|
6324
|
+
*/
|
|
6325
|
+
subSection?: ObjectPageSubSection;
|
|
6326
|
+
}
|
|
6327
|
+
|
|
6328
|
+
export interface $ObjectPageLayoutSectionChangeEventParameters {
|
|
6329
|
+
/**
|
|
6330
|
+
* The section which the layout is scrolled to.
|
|
6331
|
+
*/
|
|
6332
|
+
section?: ObjectPageSection;
|
|
6333
|
+
|
|
6334
|
+
/**
|
|
6335
|
+
* The subsection which the layout is scrolled to.
|
|
6336
|
+
*/
|
|
6337
|
+
subSection?: ObjectPageSubSection;
|
|
6338
|
+
}
|
|
6339
|
+
|
|
6340
|
+
export interface $ObjectPageLayoutSubSectionVisibilityChangeEventParameters {
|
|
6341
|
+
/**
|
|
6342
|
+
* Object whose keys are the visible SubSection IDs and their values are the SubSection instances
|
|
6343
|
+
*/
|
|
6344
|
+
visibleSubSections?: object;
|
|
6345
|
+
}
|
|
6346
|
+
|
|
6347
|
+
export interface $ObjectPageLayoutToggleAnchorBarEventParameters {
|
|
6348
|
+
/**
|
|
6349
|
+
* False indicates that the Anchor bar has just detached from the Header and became part of the scrolling
|
|
6350
|
+
* area. True means that the Anchor bar has just snapped to the Header.
|
|
6351
|
+
*/
|
|
6352
|
+
fixed?: boolean;
|
|
6270
6353
|
}
|
|
6271
6354
|
}
|
|
6272
6355
|
|
|
@@ -6282,7 +6365,7 @@ declare module "sap/uxap/ObjectPageLazyLoader" {
|
|
|
6282
6365
|
/**
|
|
6283
6366
|
* @SINCE 1.38
|
|
6284
6367
|
*
|
|
6285
|
-
* A helper element that enables a "stashed-based" lazy loading approach for the content of the {@link sap.uxap.ObjectPageSubSection}
|
|
6368
|
+
* A helper element that enables a "stashed-based" lazy loading approach for the content of the {@link sap.uxap.ObjectPageSubSection }
|
|
6286
6369
|
* control.
|
|
6287
6370
|
*
|
|
6288
6371
|
* `ObjectPageLazyLoader` is intended to be used in a declarative way only (for example, in a view) with
|
|
@@ -6295,7 +6378,7 @@ declare module "sap/uxap/ObjectPageLazyLoader" {
|
|
|
6295
6378
|
*
|
|
6296
6379
|
* **Note:** Subsections are required to have an ID when used with `ObjectPageLazyLoader`.
|
|
6297
6380
|
*/
|
|
6298
|
-
|
|
6381
|
+
class ObjectPageLazyLoader extends UI5Element {
|
|
6299
6382
|
/**
|
|
6300
6383
|
* Constructor for a new `ObjectPageLazyLoader`.
|
|
6301
6384
|
*
|
|
@@ -6428,6 +6511,7 @@ declare module "sap/uxap/ObjectPageLazyLoader" {
|
|
|
6428
6511
|
vContent: int | string | Control
|
|
6429
6512
|
): Control | null;
|
|
6430
6513
|
}
|
|
6514
|
+
export default ObjectPageLazyLoader;
|
|
6431
6515
|
|
|
6432
6516
|
export interface $ObjectPageLazyLoaderSettings extends $ElementSettings {
|
|
6433
6517
|
/**
|
|
@@ -6465,7 +6549,7 @@ declare module "sap/uxap/ObjectPageSection" {
|
|
|
6465
6549
|
*
|
|
6466
6550
|
* **Note:** This control is intended to be used only as part of the `ObjectPageLayout`.
|
|
6467
6551
|
*/
|
|
6468
|
-
|
|
6552
|
+
class ObjectPageSection extends ObjectPageSectionBase {
|
|
6469
6553
|
/**
|
|
6470
6554
|
* Constructor for a new `ObjectPageSection`.
|
|
6471
6555
|
*
|
|
@@ -6727,6 +6811,7 @@ declare module "sap/uxap/ObjectPageSection" {
|
|
|
6727
6811
|
bWrapTitle?: boolean
|
|
6728
6812
|
): this;
|
|
6729
6813
|
}
|
|
6814
|
+
export default ObjectPageSection;
|
|
6730
6815
|
|
|
6731
6816
|
export interface $ObjectPageSectionSettings
|
|
6732
6817
|
extends $ObjectPageSectionBaseSettings {
|
|
@@ -6788,7 +6873,7 @@ declare module "sap/uxap/ObjectPageSectionBase" {
|
|
|
6788
6873
|
*
|
|
6789
6874
|
* An abstract container for sections and subsections in the {@link sap.uxap.ObjectPageLayout}.
|
|
6790
6875
|
*/
|
|
6791
|
-
|
|
6876
|
+
class ObjectPageSectionBase extends Control {
|
|
6792
6877
|
/**
|
|
6793
6878
|
* Constructor for a new `ObjectPageSectionBase`.
|
|
6794
6879
|
*
|
|
@@ -6898,7 +6983,7 @@ declare module "sap/uxap/ObjectPageSectionBase" {
|
|
|
6898
6983
|
* Defines the title of the respective section/subsection.
|
|
6899
6984
|
*
|
|
6900
6985
|
* **Note:** If a subsection is the only one (or the only one visible) within a section, its title is displayed
|
|
6901
|
-
* instead of the section title. This behavior is true even if the `showTitle` propeprty of {@link sap.uxap.ObjectPageSubSection}
|
|
6986
|
+
* instead of the section title. This behavior is true even if the `showTitle` propeprty of {@link sap.uxap.ObjectPageSubSection }
|
|
6902
6987
|
* is set to `false`.
|
|
6903
6988
|
*
|
|
6904
6989
|
* @returns Value of property `title`
|
|
@@ -6968,7 +7053,7 @@ declare module "sap/uxap/ObjectPageSectionBase" {
|
|
|
6968
7053
|
* Defines the title of the respective section/subsection.
|
|
6969
7054
|
*
|
|
6970
7055
|
* **Note:** If a subsection is the only one (or the only one visible) within a section, its title is displayed
|
|
6971
|
-
* instead of the section title. This behavior is true even if the `showTitle` propeprty of {@link sap.uxap.ObjectPageSubSection}
|
|
7056
|
+
* instead of the section title. This behavior is true even if the `showTitle` propeprty of {@link sap.uxap.ObjectPageSubSection }
|
|
6972
7057
|
* is set to `false`.
|
|
6973
7058
|
*
|
|
6974
7059
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
@@ -7033,13 +7118,14 @@ declare module "sap/uxap/ObjectPageSectionBase" {
|
|
|
7033
7118
|
*/
|
|
7034
7119
|
updateInvisibleTextLabelValue(): this;
|
|
7035
7120
|
}
|
|
7121
|
+
export default ObjectPageSectionBase;
|
|
7036
7122
|
|
|
7037
7123
|
export interface $ObjectPageSectionBaseSettings extends $ControlSettings {
|
|
7038
7124
|
/**
|
|
7039
7125
|
* Defines the title of the respective section/subsection.
|
|
7040
7126
|
*
|
|
7041
7127
|
* **Note:** If a subsection is the only one (or the only one visible) within a section, its title is displayed
|
|
7042
|
-
* instead of the section title. This behavior is true even if the `showTitle` propeprty of {@link sap.uxap.ObjectPageSubSection}
|
|
7128
|
+
* instead of the section title. This behavior is true even if the `showTitle` propeprty of {@link sap.uxap.ObjectPageSubSection }
|
|
7043
7129
|
* is set to `false`.
|
|
7044
7130
|
*/
|
|
7045
7131
|
title?: string | PropertyBindingInfo;
|
|
@@ -7123,7 +7209,7 @@ declare module "sap/uxap/ObjectPageSubSection" {
|
|
|
7123
7209
|
*
|
|
7124
7210
|
* **Note:** This control is intended to be used only as part of the `ObjectPageLayout`.
|
|
7125
7211
|
*/
|
|
7126
|
-
|
|
7212
|
+
class ObjectPageSubSection extends ObjectPageSectionBase {
|
|
7127
7213
|
/**
|
|
7128
7214
|
* Constructor for a new `ObjectPageSubSection`.
|
|
7129
7215
|
*
|
|
@@ -7262,9 +7348,9 @@ declare module "sap/uxap/ObjectPageSubSection" {
|
|
|
7262
7348
|
*
|
|
7263
7349
|
* Don't use the `sapUxAPObjectPageSubSectionAlignContent` CSS class in the following cases:
|
|
7264
7350
|
* - In combination with `ResponsiveLayout`, because `ResponsiveLayout` applies custom paddings. To align
|
|
7265
|
-
*
|
|
7351
|
+
* items with `sapUxAPObjectPageSubSectionAlignContent`, use `ColumnLayout`.
|
|
7266
7352
|
* - If there are multiple controls in the same `ObjectPageSubSection`, because the CSS class interferes
|
|
7267
|
-
*
|
|
7353
|
+
* with their alignment. Example:
|
|
7268
7354
|
*
|
|
7269
7355
|
*
|
|
7270
7356
|
* ```javascript
|
|
@@ -7523,6 +7609,7 @@ declare module "sap/uxap/ObjectPageSubSection" {
|
|
|
7523
7609
|
bTitleUppercase?: boolean
|
|
7524
7610
|
): this;
|
|
7525
7611
|
}
|
|
7612
|
+
export default ObjectPageSubSection;
|
|
7526
7613
|
|
|
7527
7614
|
export interface $ObjectPageSubSectionSettings
|
|
7528
7615
|
extends $ObjectPageSectionBaseSettings {
|
|
@@ -7564,9 +7651,9 @@ declare module "sap/uxap/ObjectPageSubSection" {
|
|
|
7564
7651
|
*
|
|
7565
7652
|
* Don't use the `sapUxAPObjectPageSubSectionAlignContent` CSS class in the following cases:
|
|
7566
7653
|
* - In combination with `ResponsiveLayout`, because `ResponsiveLayout` applies custom paddings. To align
|
|
7567
|
-
*
|
|
7654
|
+
* items with `sapUxAPObjectPageSubSectionAlignContent`, use `ColumnLayout`.
|
|
7568
7655
|
* - If there are multiple controls in the same `ObjectPageSubSection`, because the CSS class interferes
|
|
7569
|
-
*
|
|
7656
|
+
* with their alignment. Example:
|
|
7570
7657
|
*
|
|
7571
7658
|
*
|
|
7572
7659
|
* ```javascript
|