@openui5/ts-types-esm 1.92.0 → 1.93.3

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.
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.92.0
1
+ // For Library Version: 1.93.3
2
2
 
3
3
  declare module "sap/uxap/library" {
4
4
  /**
@@ -221,20 +221,6 @@ declare module "sap/uxap/AnchorBar" {
221
221
  mSettings?: $AnchorBarSettings
222
222
  );
223
223
 
224
- /**
225
- * This method is a hook for the RenderManager that gets called during the rendering of child Controls.
226
- * It allows to add, remove and update existing accessibility attributes (ARIA) of those controls.
227
- */
228
- enhanceAccessibilityState(
229
- /**
230
- * The Control that gets rendered by the RenderManager
231
- */
232
- oElement: Control,
233
- /**
234
- * The mapping of "aria-" prefixed attributes
235
- */
236
- mAriaProps: object
237
- ): void;
238
224
  /**
239
225
  * Creates a new subclass of class sap.uxap.AnchorBar with name `sClassName` and enriches it with the information
240
226
  * contained in `oClassInfo`.
@@ -256,6 +242,24 @@ declare module "sap/uxap/AnchorBar" {
256
242
  */
257
243
  FNMetaImpl?: Function
258
244
  ): Function;
245
+ /**
246
+ * Returns a metadata object for class sap.uxap.AnchorBar.
247
+ */
248
+ static getMetadata(): ElementMetadata;
249
+ /**
250
+ * This method is a hook for the RenderManager that gets called during the rendering of child Controls.
251
+ * It allows to add, remove and update existing accessibility attributes (ARIA) of those controls.
252
+ */
253
+ enhanceAccessibilityState(
254
+ /**
255
+ * The Control that gets rendered by the RenderManager
256
+ */
257
+ oElement: Control,
258
+ /**
259
+ * The mapping of "aria-" prefixed attributes
260
+ */
261
+ mAriaProps: object
262
+ ): void;
259
263
  /**
260
264
  * @SINCE 1.58
261
265
  *
@@ -267,10 +271,6 @@ declare module "sap/uxap/AnchorBar" {
267
271
  * of the background is `@sapUiObjectHeaderBackground`, which depends on the specific theme.
268
272
  */
269
273
  getBackgroundDesign(): BackgroundDesign | keyof typeof BackgroundDesign;
270
- /**
271
- * Returns a metadata object for class sap.uxap.AnchorBar.
272
- */
273
- static getMetadata(): ElementMetadata;
274
274
  /**
275
275
  * Returns an sap.ui.core.delegate.ScrollEnablement object used to handle scrolling.
276
276
  */
@@ -483,6 +483,31 @@ declare module "sap/uxap/BlockBase" {
483
483
  mSettings?: $BlockBaseSettings
484
484
  );
485
485
 
486
+ /**
487
+ * Creates a new subclass of class sap.uxap.BlockBase with name `sClassName` and enriches it with the information
488
+ * contained in `oClassInfo`.
489
+ *
490
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
491
+ */
492
+ static extend<T extends Record<string, unknown>>(
493
+ /**
494
+ * Name of the class being created
495
+ */
496
+ sClassName: string,
497
+ /**
498
+ * Object literal with information about the class
499
+ */
500
+ oClassInfo?: sap.ClassInfo<T, BlockBase>,
501
+ /**
502
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
503
+ * used by this class
504
+ */
505
+ FNMetaImpl?: Function
506
+ ): Function;
507
+ /**
508
+ * Returns a metadata object for class sap.uxap.BlockBase.
509
+ */
510
+ static getMetadata(): ElementMetadata;
486
511
  /**
487
512
  * Adds some mapping to the aggregation {@link #getMappings mappings}.
488
513
  */
@@ -571,27 +596,6 @@ declare module "sap/uxap/BlockBase" {
571
596
  */
572
597
  oListener?: object
573
598
  ): this;
574
- /**
575
- * Creates a new subclass of class sap.uxap.BlockBase with name `sClassName` and enriches it with the information
576
- * contained in `oClassInfo`.
577
- *
578
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
579
- */
580
- static extend<T extends Record<string, unknown>>(
581
- /**
582
- * Name of the class being created
583
- */
584
- sClassName: string,
585
- /**
586
- * Object literal with information about the class
587
- */
588
- oClassInfo?: sap.ClassInfo<T, BlockBase>,
589
- /**
590
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
591
- * used by this class
592
- */
593
- FNMetaImpl?: Function
594
- ): Function;
595
599
  /**
596
600
  * @SINCE 1.72
597
601
  *
@@ -637,10 +641,6 @@ declare module "sap/uxap/BlockBase" {
637
641
  * Map external UI5 model and internal Block model
638
642
  */
639
643
  getMappings(): ModelMapping[];
640
- /**
641
- * Returns a metadata object for class sap.uxap.BlockBase.
642
- */
643
- static getMetadata(): ElementMetadata;
644
644
  /**
645
645
  * Gets current value of property {@link #getMode mode}.
646
646
  *
@@ -857,7 +857,7 @@ declare module "sap/uxap/BlockBase" {
857
857
  *
858
858
  * Fired when an aggregated view is instantiated.
859
859
  */
860
- viewInit?: Function;
860
+ viewInit?: (oEvent: Event) => void;
861
861
  }
862
862
  }
863
863
 
@@ -922,23 +922,6 @@ declare module "sap/uxap/BreadCrumbs" {
922
922
  mSettings?: $BreadCrumbsSettings
923
923
  );
924
924
 
925
- /**
926
- * Adds some link to the aggregation {@link #getLinks links}.
927
- */
928
- addLink(
929
- /**
930
- * The link to add; if empty, nothing is inserted
931
- */
932
- oLink: Link
933
- ): this;
934
- /**
935
- * Destroys the currentLocation in the aggregation {@link #getCurrentLocation currentLocation}.
936
- */
937
- destroyCurrentLocation(): this;
938
- /**
939
- * Destroys all the links in the aggregation {@link #getLinks links}.
940
- */
941
- destroyLinks(): this;
942
925
  /**
943
926
  * Creates a new subclass of class sap.uxap.BreadCrumbs with name `sClassName` and enriches it with the
944
927
  * information contained in `oClassInfo`.
@@ -960,6 +943,27 @@ declare module "sap/uxap/BreadCrumbs" {
960
943
  */
961
944
  FNMetaImpl?: Function
962
945
  ): Function;
946
+ /**
947
+ * Returns a metadata object for class sap.uxap.BreadCrumbs.
948
+ */
949
+ static getMetadata(): ElementMetadata;
950
+ /**
951
+ * Adds some link to the aggregation {@link #getLinks links}.
952
+ */
953
+ addLink(
954
+ /**
955
+ * The link to add; if empty, nothing is inserted
956
+ */
957
+ oLink: Link
958
+ ): this;
959
+ /**
960
+ * Destroys the currentLocation in the aggregation {@link #getCurrentLocation currentLocation}.
961
+ */
962
+ destroyCurrentLocation(): this;
963
+ /**
964
+ * Destroys all the links in the aggregation {@link #getLinks links}.
965
+ */
966
+ destroyLinks(): this;
963
967
  /**
964
968
  * Gets content of aggregation {@link #getCurrentLocation currentLocation}.
965
969
  *
@@ -972,10 +976,6 @@ declare module "sap/uxap/BreadCrumbs" {
972
976
  * A list of all the active link elements in the BreadCrumbs control.
973
977
  */
974
978
  getLinks(): Link[];
975
- /**
976
- * Returns a metadata object for class sap.uxap.BreadCrumbs.
977
- */
978
- static getMetadata(): ElementMetadata;
979
979
  /**
980
980
  * Gets current value of property {@link #getShowCurrentLocation showCurrentLocation}.
981
981
  *
@@ -1238,6 +1238,10 @@ declare module "sap/uxap/ModelMapping" {
1238
1238
  */
1239
1239
  FNMetaImpl?: Function
1240
1240
  ): Function;
1241
+ /**
1242
+ * Returns a metadata object for class sap.uxap.ModelMapping.
1243
+ */
1244
+ static getMetadata(): ElementMetadata;
1241
1245
  /**
1242
1246
  * Gets current value of property {@link #getExternalModelName externalModelName}.
1243
1247
  *
@@ -1258,10 +1262,6 @@ declare module "sap/uxap/ModelMapping" {
1258
1262
  * Default value is `"Model"`.
1259
1263
  */
1260
1264
  getInternalModelName(): string;
1261
- /**
1262
- * Returns a metadata object for class sap.uxap.ModelMapping.
1263
- */
1264
- static getMetadata(): ElementMetadata;
1265
1265
  /**
1266
1266
  * Sets a new value for property {@link #getExternalModelName externalModelName}.
1267
1267
  *
@@ -1392,6 +1392,10 @@ declare module "sap/uxap/ObjectPageAccessibleLandmarkInfo" {
1392
1392
  */
1393
1393
  FNMetaImpl?: Function
1394
1394
  ): Function;
1395
+ /**
1396
+ * Returns a metadata object for class sap.uxap.ObjectPageAccessibleLandmarkInfo.
1397
+ */
1398
+ static getMetadata(): ElementMetadata;
1395
1399
  /**
1396
1400
  * Gets current value of property {@link #getContentLabel contentLabel}.
1397
1401
  *
@@ -1458,10 +1462,6 @@ declare module "sap/uxap/ObjectPageAccessibleLandmarkInfo" {
1458
1462
  getHeaderRole():
1459
1463
  | AccessibleLandmarkRole
1460
1464
  | keyof typeof AccessibleLandmarkRole;
1461
- /**
1462
- * Returns a metadata object for class sap.uxap.ObjectPageAccessibleLandmarkInfo.
1463
- */
1464
- static getMetadata(): ElementMetadata;
1465
1465
  /**
1466
1466
  * Gets current value of property {@link #getNavigationLabel navigationLabel}.
1467
1467
  *
@@ -2063,6 +2063,31 @@ declare module "sap/uxap/ObjectPageHeader" {
2063
2063
  mSettings?: $ObjectPageHeaderSettings
2064
2064
  );
2065
2065
 
2066
+ /**
2067
+ * Creates a new subclass of class sap.uxap.ObjectPageHeader with name `sClassName` and enriches it with
2068
+ * the information contained in `oClassInfo`.
2069
+ *
2070
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
2071
+ */
2072
+ static extend<T extends Record<string, unknown>>(
2073
+ /**
2074
+ * Name of the class being created
2075
+ */
2076
+ sClassName: string,
2077
+ /**
2078
+ * Object literal with information about the class
2079
+ */
2080
+ oClassInfo?: sap.ClassInfo<T, ObjectPageHeader>,
2081
+ /**
2082
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
2083
+ * used by this class
2084
+ */
2085
+ FNMetaImpl?: Function
2086
+ ): Function;
2087
+ /**
2088
+ * Returns a metadata object for class sap.uxap.ObjectPageHeader.
2089
+ */
2090
+ static getMetadata(): ElementMetadata;
2066
2091
  /**
2067
2092
  * Adds some action to the aggregation {@link #getActions actions}.
2068
2093
  */
@@ -2292,27 +2317,6 @@ declare module "sap/uxap/ObjectPageHeader" {
2292
2317
  */
2293
2318
  oListener?: object
2294
2319
  ): this;
2295
- /**
2296
- * Creates a new subclass of class sap.uxap.ObjectPageHeader with name `sClassName` and enriches it with
2297
- * the information contained in `oClassInfo`.
2298
- *
2299
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
2300
- */
2301
- static extend<T extends Record<string, unknown>>(
2302
- /**
2303
- * Name of the class being created
2304
- */
2305
- sClassName: string,
2306
- /**
2307
- * Object literal with information about the class
2308
- */
2309
- oClassInfo?: sap.ClassInfo<T, ObjectPageHeader>,
2310
- /**
2311
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
2312
- * used by this class
2313
- */
2314
- FNMetaImpl?: Function
2315
- ): Function;
2316
2320
  /**
2317
2321
  * Fires event {@link #event:markChangesPress markChangesPress} to attached listeners.
2318
2322
  */
@@ -2466,10 +2470,6 @@ declare module "sap/uxap/ObjectPageHeader" {
2466
2470
  * Default value is `false`.
2467
2471
  */
2468
2472
  getMarkLocked(): boolean;
2469
- /**
2470
- * Returns a metadata object for class sap.uxap.ObjectPageHeader.
2471
- */
2472
- static getMetadata(): ElementMetadata;
2473
2473
  /**
2474
2474
  * Gets content of aggregation {@link #getNavigationBar navigationBar}.
2475
2475
  *
@@ -3167,17 +3167,17 @@ declare module "sap/uxap/ObjectPageHeader" {
3167
3167
  /**
3168
3168
  * The event is fired when the objectPage header title selector (down-arrow) is pressed
3169
3169
  */
3170
- titleSelectorPress?: Function;
3170
+ titleSelectorPress?: (oEvent: Event) => void;
3171
3171
 
3172
3172
  /**
3173
3173
  * The event is fired when the Locked button is pressed
3174
3174
  */
3175
- markLockedPress?: Function;
3175
+ markLockedPress?: (oEvent: Event) => void;
3176
3176
 
3177
3177
  /**
3178
3178
  * The event is fired when the unsaved changes button is pressed
3179
3179
  */
3180
- markChangesPress?: Function;
3180
+ markChangesPress?: (oEvent: Event) => void;
3181
3181
  }
3182
3182
  }
3183
3183
 
@@ -3256,6 +3256,10 @@ declare module "sap/uxap/ObjectPageHeaderActionButton" {
3256
3256
  */
3257
3257
  FNMetaImpl?: Function
3258
3258
  ): Function;
3259
+ /**
3260
+ * Returns a metadata object for class sap.uxap.ObjectPageHeaderActionButton.
3261
+ */
3262
+ static getMetadata(): ElementMetadata;
3259
3263
  /**
3260
3264
  * Gets current value of property {@link #getHideIcon hideIcon}.
3261
3265
  *
@@ -3286,10 +3290,6 @@ declare module "sap/uxap/ObjectPageHeaderActionButton" {
3286
3290
  * Default value is `High`.
3287
3291
  */
3288
3292
  getImportance(): Importance | keyof typeof Importance;
3289
- /**
3290
- * Returns a metadata object for class sap.uxap.ObjectPageHeaderActionButton.
3291
- */
3292
- static getMetadata(): ElementMetadata;
3293
3293
  /**
3294
3294
  * Sets a new value for property {@link #getHideIcon hideIcon}.
3295
3295
  *
@@ -3438,19 +3438,6 @@ declare module "sap/uxap/ObjectPageHeaderContent" {
3438
3438
  mSettings?: $ObjectPageHeaderContentSettings
3439
3439
  );
3440
3440
 
3441
- /**
3442
- * Adds some content to the aggregation {@link #getContent content}.
3443
- */
3444
- addContent(
3445
- /**
3446
- * The content to add; if empty, nothing is inserted
3447
- */
3448
- oContent: Control
3449
- ): this;
3450
- /**
3451
- * Destroys all the content in the aggregation {@link #getContent content}.
3452
- */
3453
- destroyContent(): this;
3454
3441
  /**
3455
3442
  * Creates a new subclass of class sap.uxap.ObjectPageHeaderContent with name `sClassName` and enriches
3456
3443
  * it with the information contained in `oClassInfo`.
@@ -3472,6 +3459,23 @@ declare module "sap/uxap/ObjectPageHeaderContent" {
3472
3459
  */
3473
3460
  FNMetaImpl?: Function
3474
3461
  ): Function;
3462
+ /**
3463
+ * Returns a metadata object for class sap.uxap.ObjectPageHeaderContent.
3464
+ */
3465
+ static getMetadata(): ElementMetadata;
3466
+ /**
3467
+ * Adds some content to the aggregation {@link #getContent content}.
3468
+ */
3469
+ addContent(
3470
+ /**
3471
+ * The content to add; if empty, nothing is inserted
3472
+ */
3473
+ oContent: Control
3474
+ ): this;
3475
+ /**
3476
+ * Destroys all the content in the aggregation {@link #getContent content}.
3477
+ */
3478
+ destroyContent(): this;
3475
3479
  /**
3476
3480
  * Gets content of aggregation {@link #getContent content}.
3477
3481
  *
@@ -3491,10 +3495,6 @@ declare module "sap/uxap/ObjectPageHeaderContent" {
3491
3495
  getContentDesign():
3492
3496
  | ObjectPageHeaderDesign
3493
3497
  | keyof typeof ObjectPageHeaderDesign;
3494
- /**
3495
- * Returns a metadata object for class sap.uxap.ObjectPageHeaderContent.
3496
- */
3497
- static getMetadata(): ElementMetadata;
3498
3498
  /**
3499
3499
  * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getContent content}. and returns
3500
3500
  * its index if found or -1 otherwise.
@@ -3947,23 +3947,48 @@ declare module "sap/uxap/ObjectPageLayout" {
3947
3947
  );
3948
3948
 
3949
3949
  /**
3950
- * Adds some headerContent to the aggregation {@link #getHeaderContent headerContent}.
3950
+ * Creates a new subclass of class sap.uxap.ObjectPageLayout with name `sClassName` and enriches it with
3951
+ * the information contained in `oClassInfo`.
3952
+ *
3953
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
3951
3954
  */
3952
- addHeaderContent(
3955
+ static extend<T extends Record<string, unknown>>(
3953
3956
  /**
3954
- * The headerContent to add; if empty, nothing is inserted
3957
+ * Name of the class being created
3955
3958
  */
3956
- oHeaderContent: Control
3957
- ): this;
3958
- /**
3959
- * Adds some section to the aggregation {@link #getSections sections}.
3960
- */
3961
- addSection(
3959
+ sClassName: string,
3962
3960
  /**
3963
- * The section to add; if empty, nothing is inserted
3961
+ * Object literal with information about the class
3964
3962
  */
3965
- oSection: ObjectPageSection
3966
- ): this;
3963
+ oClassInfo?: sap.ClassInfo<T, ObjectPageLayout>,
3964
+ /**
3965
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
3966
+ * used by this class
3967
+ */
3968
+ FNMetaImpl?: Function
3969
+ ): Function;
3970
+ /**
3971
+ * Returns a metadata object for class sap.uxap.ObjectPageLayout.
3972
+ */
3973
+ static getMetadata(): ElementMetadata;
3974
+ /**
3975
+ * Adds some headerContent to the aggregation {@link #getHeaderContent headerContent}.
3976
+ */
3977
+ addHeaderContent(
3978
+ /**
3979
+ * The headerContent to add; if empty, nothing is inserted
3980
+ */
3981
+ oHeaderContent: Control
3982
+ ): this;
3983
+ /**
3984
+ * Adds some section to the aggregation {@link #getSections sections}.
3985
+ */
3986
+ addSection(
3987
+ /**
3988
+ * The section to add; if empty, nothing is inserted
3989
+ */
3990
+ oSection: ObjectPageSection
3991
+ ): this;
3967
3992
  /**
3968
3993
  * Attaches event handler `fnFunction` to the {@link #event:editHeaderButtonPress editHeaderButtonPress}
3969
3994
  * event of this `sap.uxap.ObjectPageLayout`.
@@ -4007,6 +4032,53 @@ declare module "sap/uxap/ObjectPageLayout" {
4007
4032
  */
4008
4033
  oListener?: object
4009
4034
  ): this;
4035
+ /**
4036
+ * @SINCE 1.93
4037
+ *
4038
+ * Attaches event handler `fnFunction` to the {@link #event:headerContentPinnedStateChange headerContentPinnedStateChange}
4039
+ * event of this `sap.uxap.ObjectPageLayout`.
4040
+ *
4041
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
4042
+ * otherwise it will be bound to this `sap.uxap.ObjectPageLayout` itself.
4043
+ *
4044
+ * The event is fired when the `headerContentPinned` property is changed via user interaction.
4045
+ */
4046
+ attachHeaderContentPinnedStateChange(
4047
+ /**
4048
+ * An application-specific payload object that will be passed to the event handler along with the event
4049
+ * object when firing the event
4050
+ */
4051
+ oData: object,
4052
+ /**
4053
+ * The function to be called when the event occurs
4054
+ */
4055
+ fnFunction: (p1: Event) => void,
4056
+ /**
4057
+ * Context object to call the event handler with. Defaults to this `sap.uxap.ObjectPageLayout` itself
4058
+ */
4059
+ oListener?: object
4060
+ ): this;
4061
+ /**
4062
+ * @SINCE 1.93
4063
+ *
4064
+ * Attaches event handler `fnFunction` to the {@link #event:headerContentPinnedStateChange headerContentPinnedStateChange}
4065
+ * event of this `sap.uxap.ObjectPageLayout`.
4066
+ *
4067
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
4068
+ * otherwise it will be bound to this `sap.uxap.ObjectPageLayout` itself.
4069
+ *
4070
+ * The event is fired when the `headerContentPinned` property is changed via user interaction.
4071
+ */
4072
+ attachHeaderContentPinnedStateChange(
4073
+ /**
4074
+ * The function to be called when the event occurs
4075
+ */
4076
+ fnFunction: (p1: Event) => void,
4077
+ /**
4078
+ * Context object to call the event handler with. Defaults to this `sap.uxap.ObjectPageLayout` itself
4079
+ */
4080
+ oListener?: object
4081
+ ): this;
4010
4082
  /**
4011
4083
  * @SINCE 1.40
4012
4084
  *
@@ -4227,6 +4299,24 @@ declare module "sap/uxap/ObjectPageLayout" {
4227
4299
  */
4228
4300
  oListener?: object
4229
4301
  ): this;
4302
+ /**
4303
+ * @SINCE 1.93
4304
+ *
4305
+ * Detaches event handler `fnFunction` from the {@link #event:headerContentPinnedStateChange headerContentPinnedStateChange}
4306
+ * event of this `sap.uxap.ObjectPageLayout`.
4307
+ *
4308
+ * The passed function and listener object must match the ones used for event registration.
4309
+ */
4310
+ detachHeaderContentPinnedStateChange(
4311
+ /**
4312
+ * The function to be called, when the event occurs
4313
+ */
4314
+ fnFunction: (p1: Event) => void,
4315
+ /**
4316
+ * Context object on which the given function had to be called
4317
+ */
4318
+ oListener?: object
4319
+ ): this;
4230
4320
  /**
4231
4321
  * @SINCE 1.40
4232
4322
  *
@@ -4297,34 +4387,30 @@ declare module "sap/uxap/ObjectPageLayout" {
4297
4387
  oListener?: object
4298
4388
  ): this;
4299
4389
  /**
4300
- * Creates a new subclass of class sap.uxap.ObjectPageLayout with name `sClassName` and enriches it with
4301
- * the information contained in `oClassInfo`.
4302
- *
4303
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
4390
+ * Fires event {@link #event:editHeaderButtonPress editHeaderButtonPress} to attached listeners.
4304
4391
  */
4305
- static extend<T extends Record<string, unknown>>(
4306
- /**
4307
- * Name of the class being created
4308
- */
4309
- sClassName: string,
4310
- /**
4311
- * Object literal with information about the class
4312
- */
4313
- oClassInfo?: sap.ClassInfo<T, ObjectPageLayout>,
4392
+ fireEditHeaderButtonPress(
4314
4393
  /**
4315
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
4316
- * used by this class
4394
+ * Parameters to pass along with the event
4317
4395
  */
4318
- FNMetaImpl?: Function
4319
- ): Function;
4396
+ mParameters?: object
4397
+ ): this;
4320
4398
  /**
4321
- * Fires event {@link #event:editHeaderButtonPress editHeaderButtonPress} to attached listeners.
4399
+ * @SINCE 1.93
4400
+ *
4401
+ * Fires event {@link #event:headerContentPinnedStateChange headerContentPinnedStateChange} to attached
4402
+ * listeners.
4322
4403
  */
4323
- fireEditHeaderButtonPress(
4404
+ fireHeaderContentPinnedStateChange(
4324
4405
  /**
4325
4406
  * Parameters to pass along with the event
4326
4407
  */
4327
- mParameters?: object
4408
+ mParameters?: {
4409
+ /**
4410
+ * False or True values indicate the new pinned property value.
4411
+ */
4412
+ pinned?: boolean;
4413
+ }
4328
4414
  ): this;
4329
4415
  /**
4330
4416
  * @SINCE 1.40
@@ -4472,6 +4558,29 @@ declare module "sap/uxap/ObjectPageLayout" {
4472
4558
  * Default value is `true`.
4473
4559
  */
4474
4560
  getHeaderContentPinnable(): boolean;
4561
+ /**
4562
+ * @SINCE 1.93
4563
+ *
4564
+ * Gets current value of property {@link #getHeaderContentPinned headerContentPinned}.
4565
+ *
4566
+ * Determines whether the `sap.uxap.ObjectPageDynamicHeaderContent` is pinned.
4567
+ *
4568
+ * The property can be changed explicitly with its setter or in the occurrence of the following user interactions:
4569
+ *
4570
+ * - Toggling the pin/unpin button of `sap.uxap.ObjectPageDynamicHeaderContent`
4571
+ * - Snapping the `sap.uxap.ObjectPageDynamicHeaderContent` by explicitly clicking on the `sap.uxap.ObjectPageDynamicHeaderTitle`
4572
+ *
4573
+ *
4574
+ * **Note: ** The property will only apply if the following rules are currently in use:
4575
+ * - An instance of `sap.uxap.ObjectPageDynamicHeaderTitle` is used for the `headerTitle` aggregation.
4576
+ *
4577
+ * - The `headerContentPinnable` property is `true`
4578
+ * - The `sap.uxap.ObjectPageDynamicHeaderContent` is expanded
4579
+ * - The `preserveHeaderStateOnScroll` property or the rules for it to work are `false`
4580
+ *
4581
+ * Default value is `false`.
4582
+ */
4583
+ getHeaderContentPinned(): boolean;
4475
4584
  /**
4476
4585
  * Gets content of aggregation {@link #getHeaderTitle headerTitle}.
4477
4586
  *
@@ -4510,10 +4619,6 @@ declare module "sap/uxap/ObjectPageLayout" {
4510
4619
  * If not set, no landmarks will be written.
4511
4620
  */
4512
4621
  getLandmarkInfo(): ObjectPageAccessibleLandmarkInfo;
4513
- /**
4514
- * Returns a metadata object for class sap.uxap.ObjectPageLayout.
4515
- */
4516
- static getMetadata(): ElementMetadata;
4517
4622
  /**
4518
4623
  * @SINCE 1.52
4519
4624
  *
@@ -4911,6 +5016,36 @@ declare module "sap/uxap/ObjectPageLayout" {
4911
5016
  */
4912
5017
  bHeaderContentPinnable?: boolean
4913
5018
  ): this;
5019
+ /**
5020
+ * @SINCE 1.93
5021
+ *
5022
+ * Sets a new value for property {@link #getHeaderContentPinned headerContentPinned}.
5023
+ *
5024
+ * Determines whether the `sap.uxap.ObjectPageDynamicHeaderContent` is pinned.
5025
+ *
5026
+ * The property can be changed explicitly with its setter or in the occurrence of the following user interactions:
5027
+ *
5028
+ * - Toggling the pin/unpin button of `sap.uxap.ObjectPageDynamicHeaderContent`
5029
+ * - Snapping the `sap.uxap.ObjectPageDynamicHeaderContent` by explicitly clicking on the `sap.uxap.ObjectPageDynamicHeaderTitle`
5030
+ *
5031
+ *
5032
+ * **Note: ** The property will only apply if the following rules are currently in use:
5033
+ * - An instance of `sap.uxap.ObjectPageDynamicHeaderTitle` is used for the `headerTitle` aggregation.
5034
+ *
5035
+ * - The `headerContentPinnable` property is `true`
5036
+ * - The `sap.uxap.ObjectPageDynamicHeaderContent` is expanded
5037
+ * - The `preserveHeaderStateOnScroll` property or the rules for it to work are `false`
5038
+ *
5039
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5040
+ *
5041
+ * Default value is `false`.
5042
+ */
5043
+ setHeaderContentPinned(
5044
+ /**
5045
+ * New value for property `headerContentPinned`
5046
+ */
5047
+ bHeaderContentPinned?: boolean
5048
+ ): this;
4914
5049
  /**
4915
5050
  * Sets the aggregated {@link #getHeaderTitle headerTitle}.
4916
5051
  */
@@ -5391,6 +5526,26 @@ declare module "sap/uxap/ObjectPageLayout" {
5391
5526
  */
5392
5527
  headerContentPinnable?: boolean | PropertyBindingInfo;
5393
5528
 
5529
+ /**
5530
+ * @SINCE 1.93
5531
+ *
5532
+ * Determines whether the `sap.uxap.ObjectPageDynamicHeaderContent` is pinned.
5533
+ *
5534
+ * The property can be changed explicitly with its setter or in the occurrence of the following user interactions:
5535
+ *
5536
+ * - Toggling the pin/unpin button of `sap.uxap.ObjectPageDynamicHeaderContent`
5537
+ * - Snapping the `sap.uxap.ObjectPageDynamicHeaderContent` by explicitly clicking on the `sap.uxap.ObjectPageDynamicHeaderTitle`
5538
+ *
5539
+ *
5540
+ * **Note: ** The property will only apply if the following rules are currently in use:
5541
+ * - An instance of `sap.uxap.ObjectPageDynamicHeaderTitle` is used for the `headerTitle` aggregation.
5542
+ *
5543
+ * - The `headerContentPinnable` property is `true`
5544
+ * - The `sap.uxap.ObjectPageDynamicHeaderContent` is expanded
5545
+ * - The `preserveHeaderStateOnScroll` property or the rules for it to work are `false`
5546
+ */
5547
+ headerContentPinned?: boolean | PropertyBindingInfo;
5548
+
5394
5549
  /**
5395
5550
  * @SINCE 1.52
5396
5551
  *
@@ -5482,36 +5637,43 @@ declare module "sap/uxap/ObjectPageLayout" {
5482
5637
  */
5483
5638
  selectedSection?: ObjectPageSection | string;
5484
5639
 
5640
+ /**
5641
+ * @SINCE 1.93
5642
+ *
5643
+ * The event is fired when the `headerContentPinned` property is changed via user interaction.
5644
+ */
5645
+ headerContentPinnedStateChange?: (oEvent: Event) => void;
5646
+
5485
5647
  /**
5486
5648
  * The event is fired when the Anchor bar is switched from moving to fixed or the other way round.
5487
5649
  */
5488
- toggleAnchorBar?: Function;
5650
+ toggleAnchorBar?: (oEvent: Event) => void;
5489
5651
 
5490
5652
  /**
5491
5653
  * @SINCE 1.73
5492
5654
  *
5493
5655
  * Fired when the current section is changed by scrolling.
5494
5656
  */
5495
- sectionChange?: Function;
5657
+ sectionChange?: (oEvent: Event) => void;
5496
5658
 
5497
5659
  /**
5498
5660
  * The event is fired when the Edit Header button is pressed
5499
5661
  */
5500
- editHeaderButtonPress?: Function;
5662
+ editHeaderButtonPress?: (oEvent: Event) => void;
5501
5663
 
5502
5664
  /**
5503
5665
  * @SINCE 1.40
5504
5666
  *
5505
5667
  * The event is fired when the selected section is changed using the navigation.
5506
5668
  */
5507
- navigate?: Function;
5669
+ navigate?: (oEvent: Event) => void;
5508
5670
 
5509
5671
  /**
5510
5672
  * @SINCE 1.77
5511
5673
  *
5512
5674
  * Fired when the visibility of subsections is changed.
5513
5675
  */
5514
- subSectionVisibilityChange?: Function;
5676
+ subSectionVisibilityChange?: (oEvent: Event) => void;
5515
5677
  }
5516
5678
  }
5517
5679
 
@@ -5572,19 +5734,6 @@ declare module "sap/uxap/ObjectPageLazyLoader" {
5572
5734
  mSettings?: $ObjectPageLazyLoaderSettings
5573
5735
  );
5574
5736
 
5575
- /**
5576
- * Adds some content to the aggregation {@link #getContent content}.
5577
- */
5578
- addContent(
5579
- /**
5580
- * The content to add; if empty, nothing is inserted
5581
- */
5582
- oContent: Control
5583
- ): this;
5584
- /**
5585
- * Destroys all the content in the aggregation {@link #getContent content}.
5586
- */
5587
- destroyContent(): this;
5588
5737
  /**
5589
5738
  * Creates a new subclass of class sap.uxap.ObjectPageLazyLoader with name `sClassName` and enriches it
5590
5739
  * with the information contained in `oClassInfo`.
@@ -5606,16 +5755,29 @@ declare module "sap/uxap/ObjectPageLazyLoader" {
5606
5755
  */
5607
5756
  FNMetaImpl?: Function
5608
5757
  ): Function;
5758
+ /**
5759
+ * Returns a metadata object for class sap.uxap.ObjectPageLazyLoader.
5760
+ */
5761
+ static getMetadata(): ElementMetadata;
5762
+ /**
5763
+ * Adds some content to the aggregation {@link #getContent content}.
5764
+ */
5765
+ addContent(
5766
+ /**
5767
+ * The content to add; if empty, nothing is inserted
5768
+ */
5769
+ oContent: Control
5770
+ ): this;
5771
+ /**
5772
+ * Destroys all the content in the aggregation {@link #getContent content}.
5773
+ */
5774
+ destroyContent(): this;
5609
5775
  /**
5610
5776
  * Gets content of aggregation {@link #getContent content}.
5611
5777
  *
5612
5778
  * Controls to be displayed after this element is unstashed
5613
5779
  */
5614
5780
  getContent(): Control[];
5615
- /**
5616
- * Returns a metadata object for class sap.uxap.ObjectPageLazyLoader.
5617
- */
5618
- static getMetadata(): ElementMetadata;
5619
5781
  /**
5620
5782
  * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getContent content}. and returns
5621
5783
  * its index if found or -1 otherwise.
@@ -5724,19 +5886,6 @@ declare module "sap/uxap/ObjectPageSection" {
5724
5886
  mSettings?: $ObjectPageSectionSettings
5725
5887
  );
5726
5888
 
5727
- /**
5728
- * Adds some subSection to the aggregation {@link #getSubSections subSections}.
5729
- */
5730
- addSubSection(
5731
- /**
5732
- * The subSection to add; if empty, nothing is inserted
5733
- */
5734
- oSubSection: ObjectPageSubSection
5735
- ): this;
5736
- /**
5737
- * Destroys all the subSections in the aggregation {@link #getSubSections subSections}.
5738
- */
5739
- destroySubSections(): this;
5740
5889
  /**
5741
5890
  * Creates a new subclass of class sap.uxap.ObjectPageSection with name `sClassName` and enriches it with
5742
5891
  * the information contained in `oClassInfo`.
@@ -5762,6 +5911,19 @@ declare module "sap/uxap/ObjectPageSection" {
5762
5911
  * Returns a metadata object for class sap.uxap.ObjectPageSection.
5763
5912
  */
5764
5913
  static getMetadata(): ElementMetadata;
5914
+ /**
5915
+ * Adds some subSection to the aggregation {@link #getSubSections subSections}.
5916
+ */
5917
+ addSubSection(
5918
+ /**
5919
+ * The subSection to add; if empty, nothing is inserted
5920
+ */
5921
+ oSubSection: ObjectPageSubSection
5922
+ ): this;
5923
+ /**
5924
+ * Destroys all the subSections in the aggregation {@link #getSubSections subSections}.
5925
+ */
5926
+ destroySubSections(): this;
5765
5927
  /**
5766
5928
  * ID of the element which is the current target of the association {@link #getSelectedSubSection selectedSubSection},
5767
5929
  * or `null`.
@@ -5948,14 +6110,6 @@ declare module "sap/uxap/ObjectPageSectionBase" {
5948
6110
  mSettings?: $ObjectPageSectionBaseSettings
5949
6111
  );
5950
6112
 
5951
- /**
5952
- * Explicitly ask to connect to the UI5 model tree
5953
- */
5954
- connectToModels(): void;
5955
- /**
5956
- * Destroys the customAnchorBarButton in the aggregation {@link #getCustomAnchorBarButton customAnchorBarButton}.
5957
- */
5958
- destroyCustomAnchorBarButton(): this;
5959
6113
  /**
5960
6114
  * Creates a new subclass of class sap.uxap.ObjectPageSectionBase with name `sClassName` and enriches it
5961
6115
  * with the information contained in `oClassInfo`.
@@ -5977,6 +6131,18 @@ declare module "sap/uxap/ObjectPageSectionBase" {
5977
6131
  */
5978
6132
  FNMetaImpl?: Function
5979
6133
  ): Function;
6134
+ /**
6135
+ * Returns a metadata object for class sap.uxap.ObjectPageSectionBase.
6136
+ */
6137
+ static getMetadata(): ElementMetadata;
6138
+ /**
6139
+ * Explicitly ask to connect to the UI5 model tree
6140
+ */
6141
+ connectToModels(): void;
6142
+ /**
6143
+ * Destroys the customAnchorBarButton in the aggregation {@link #getCustomAnchorBarButton customAnchorBarButton}.
6144
+ */
6145
+ destroyCustomAnchorBarButton(): this;
5980
6146
  /**
5981
6147
  * Gets content of aggregation {@link #getCustomAnchorBarButton customAnchorBarButton}.
5982
6148
  *
@@ -5998,10 +6164,6 @@ declare module "sap/uxap/ObjectPageSectionBase" {
5998
6164
  * Default value is `High`.
5999
6165
  */
6000
6166
  getImportance(): Importance | keyof typeof Importance;
6001
- /**
6002
- * Returns a metadata object for class sap.uxap.ObjectPageSectionBase.
6003
- */
6004
- static getMetadata(): ElementMetadata;
6005
6167
  /**
6006
6168
  * Returns the control name text.
6007
6169
  *
@@ -6246,6 +6408,31 @@ declare module "sap/uxap/ObjectPageSubSection" {
6246
6408
  mSettings?: $ObjectPageSubSectionSettings
6247
6409
  );
6248
6410
 
6411
+ /**
6412
+ * Creates a new subclass of class sap.uxap.ObjectPageSubSection with name `sClassName` and enriches it
6413
+ * with the information contained in `oClassInfo`.
6414
+ *
6415
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.uxap.ObjectPageSectionBase.extend}.
6416
+ */
6417
+ static extend<T extends Record<string, unknown>>(
6418
+ /**
6419
+ * Name of the class being created
6420
+ */
6421
+ sClassName: string,
6422
+ /**
6423
+ * Object literal with information about the class
6424
+ */
6425
+ oClassInfo?: sap.ClassInfo<T, ObjectPageSubSection>,
6426
+ /**
6427
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
6428
+ * used by this class
6429
+ */
6430
+ FNMetaImpl?: Function
6431
+ ): Function;
6432
+ /**
6433
+ * Returns a metadata object for class sap.uxap.ObjectPageSubSection.
6434
+ */
6435
+ static getMetadata(): ElementMetadata;
6249
6436
  /**
6250
6437
  * Adds some action to the aggregation {@link #getActions actions}.
6251
6438
  */
@@ -6285,27 +6472,6 @@ declare module "sap/uxap/ObjectPageSubSection" {
6285
6472
  * Destroys all the moreBlocks in the aggregation {@link #getMoreBlocks moreBlocks}.
6286
6473
  */
6287
6474
  destroyMoreBlocks(): this;
6288
- /**
6289
- * Creates a new subclass of class sap.uxap.ObjectPageSubSection with name `sClassName` and enriches it
6290
- * with the information contained in `oClassInfo`.
6291
- *
6292
- * `oClassInfo` might contain the same kind of information as described in {@link sap.uxap.ObjectPageSectionBase.extend}.
6293
- */
6294
- static extend<T extends Record<string, unknown>>(
6295
- /**
6296
- * Name of the class being created
6297
- */
6298
- sClassName: string,
6299
- /**
6300
- * Object literal with information about the class
6301
- */
6302
- oClassInfo?: sap.ClassInfo<T, ObjectPageSubSection>,
6303
- /**
6304
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
6305
- * used by this class
6306
- */
6307
- FNMetaImpl?: Function
6308
- ): Function;
6309
6475
  /**
6310
6476
  * Gets content of aggregation {@link #getActions actions}.
6311
6477
  *
@@ -6344,10 +6510,6 @@ declare module "sap/uxap/ObjectPageSubSection" {
6344
6510
  * ```
6345
6511
  */
6346
6512
  getBlocks(): Control[];
6347
- /**
6348
- * Returns a metadata object for class sap.uxap.ObjectPageSubSection.
6349
- */
6350
- static getMetadata(): ElementMetadata;
6351
6513
  /**
6352
6514
  * Gets current value of property {@link #getMode mode}.
6353
6515
  *