@openui5/types 1.120.7 → 1.121.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 +1605 -885
- package/types/sap.m.d.ts +14948 -8390
- package/types/sap.tnt.d.ts +904 -294
- package/types/sap.ui.codeeditor.d.ts +55 -22
- package/types/sap.ui.commons.d.ts +2084 -676
- package/types/sap.ui.core.d.ts +5771 -3523
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.fl.d.ts +184 -112
- package/types/sap.ui.integration.d.ts +496 -390
- package/types/sap.ui.layout.d.ts +1337 -668
- package/types/sap.ui.mdc.d.ts +3384 -2021
- package/types/sap.ui.rta.d.ts +7 -7
- package/types/sap.ui.suite.d.ts +44 -10
- package/types/sap.ui.support.d.ts +58 -26
- package/types/sap.ui.table.d.ts +962 -626
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +1976 -1246
- package/types/sap.ui.ux3.d.ts +1308 -488
- package/types/sap.ui.webc.common.d.ts +7 -5
- package/types/sap.ui.webc.fiori.d.ts +884 -213
- package/types/sap.ui.webc.main.d.ts +2813 -599
- package/types/sap.uxap.d.ts +621 -319
package/types/sap.uxap.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.
|
|
1
|
+
// For Library Version: 1.121.0
|
|
2
2
|
|
|
3
3
|
declare module "sap/uxap/library" {
|
|
4
4
|
/**
|
|
@@ -11,6 +11,8 @@ declare module "sap/uxap/library" {
|
|
|
11
11
|
|
|
12
12
|
/**
|
|
13
13
|
* Used by the `BlockBase` control to define if it should do automatic adjustment of its nested forms.
|
|
14
|
+
*
|
|
15
|
+
* This enum is part of the 'sap/uxap/library' module export and must be accessed by the property 'BlockBaseFormAdjustment'.
|
|
14
16
|
*/
|
|
15
17
|
export enum BlockBaseFormAdjustment {
|
|
16
18
|
/**
|
|
@@ -28,8 +30,6 @@ declare module "sap/uxap/library" {
|
|
|
28
30
|
OneColumn = "OneColumn",
|
|
29
31
|
}
|
|
30
32
|
/**
|
|
31
|
-
* @since 1.52
|
|
32
|
-
*
|
|
33
33
|
* Interface for controls that are eligible for the `headerContent` aggregation of the `{@link sap.uxap.ObjectPageLayout}`.
|
|
34
34
|
*
|
|
35
35
|
* Controls that implement this interface:
|
|
@@ -43,14 +43,14 @@ declare module "sap/uxap/library" {
|
|
|
43
43
|
* For details regarding the differences and similarities between the available headers, see {@link https://ui5.sap.com/#/topic/9c9d94fd28284539a9a5a57e9caf82a8 Object Page Headers Comparison}.
|
|
44
44
|
* See:
|
|
45
45
|
* {@link https://ui5.sap.com/#/topic/d2ef0099542d44dc868719d908e576d0 Object Page Headers}
|
|
46
|
+
*
|
|
47
|
+
* @since 1.52
|
|
46
48
|
*/
|
|
47
49
|
export interface IHeaderContent {
|
|
48
50
|
__implements__sap_uxap_IHeaderContent: boolean;
|
|
49
51
|
}
|
|
50
52
|
|
|
51
53
|
/**
|
|
52
|
-
* @since 1.52
|
|
53
|
-
*
|
|
54
54
|
* Interface for controls that are eligible for the `headerTitle` aggregation of the `{@link sap.uxap.ObjectPageLayout}`.
|
|
55
55
|
*
|
|
56
56
|
* Controls that implement this interface:
|
|
@@ -63,15 +63,19 @@ declare module "sap/uxap/library" {
|
|
|
63
63
|
* For details regarding the differences and similarities between the available headers, see {@link https://ui5.sap.com/#/topic/9c9d94fd28284539a9a5a57e9caf82a8 Object Page Headers Comparison}.
|
|
64
64
|
* See:
|
|
65
65
|
* {@link https://ui5.sap.com/#/topic/d2ef0099542d44dc868719d908e576d0 Object Page Headers}
|
|
66
|
+
*
|
|
67
|
+
* @since 1.52
|
|
66
68
|
*/
|
|
67
69
|
export interface IHeaderTitle {
|
|
68
70
|
__implements__sap_uxap_IHeaderTitle: boolean;
|
|
69
71
|
}
|
|
70
72
|
|
|
71
73
|
/**
|
|
72
|
-
* @since 1.32.0
|
|
73
|
-
*
|
|
74
74
|
* Used by the `ObjectSectionBase` control to define the importance of the content contained in it.
|
|
75
|
+
*
|
|
76
|
+
* This enum is part of the 'sap/uxap/library' module export and must be accessed by the property 'Importance'.
|
|
77
|
+
*
|
|
78
|
+
* @since 1.32.0
|
|
75
79
|
*/
|
|
76
80
|
export enum Importance {
|
|
77
81
|
/**
|
|
@@ -89,6 +93,8 @@ declare module "sap/uxap/library" {
|
|
|
89
93
|
}
|
|
90
94
|
/**
|
|
91
95
|
* Used by the `sap.uxap.component.Component` how to initialize the `ObjectPageLayout` sections and subsections.
|
|
96
|
+
*
|
|
97
|
+
* This enum is part of the 'sap/uxap/library' module export and must be accessed by the property 'ObjectPageConfigurationMode'.
|
|
92
98
|
*/
|
|
93
99
|
export enum ObjectPageConfigurationMode {
|
|
94
100
|
/**
|
|
@@ -102,6 +108,8 @@ declare module "sap/uxap/library" {
|
|
|
102
108
|
}
|
|
103
109
|
/**
|
|
104
110
|
* Used by the `ObjectPageHeader` control to define which design to use.
|
|
111
|
+
*
|
|
112
|
+
* This enum is part of the 'sap/uxap/library' module export and must be accessed by the property 'ObjectPageHeaderDesign'.
|
|
105
113
|
*/
|
|
106
114
|
export enum ObjectPageHeaderDesign {
|
|
107
115
|
/**
|
|
@@ -115,6 +123,8 @@ declare module "sap/uxap/library" {
|
|
|
115
123
|
}
|
|
116
124
|
/**
|
|
117
125
|
* Used by the `ObjectPageHeader` control to define which shape to use for the image.
|
|
126
|
+
*
|
|
127
|
+
* This enum is part of the 'sap/uxap/library' module export and must be accessed by the property 'ObjectPageHeaderPictureShape'.
|
|
118
128
|
*/
|
|
119
129
|
export enum ObjectPageHeaderPictureShape {
|
|
120
130
|
/**
|
|
@@ -128,6 +138,8 @@ declare module "sap/uxap/library" {
|
|
|
128
138
|
}
|
|
129
139
|
/**
|
|
130
140
|
* Used by the `ObjectPagSubSection` control to define which layout to apply.
|
|
141
|
+
*
|
|
142
|
+
* This enum is part of the 'sap/uxap/library' module export and must be accessed by the property 'ObjectPageSubSectionLayout'.
|
|
131
143
|
*/
|
|
132
144
|
export enum ObjectPageSubSectionLayout {
|
|
133
145
|
/**
|
|
@@ -141,6 +153,8 @@ declare module "sap/uxap/library" {
|
|
|
141
153
|
}
|
|
142
154
|
/**
|
|
143
155
|
* Used by the `ObjectPageLayout` control to define which layout to use (either Collapsed or Expanded).
|
|
156
|
+
*
|
|
157
|
+
* This enum is part of the 'sap/uxap/library' module export and must be accessed by the property 'ObjectPageSubSectionMode'.
|
|
144
158
|
*/
|
|
145
159
|
export enum ObjectPageSubSectionMode {
|
|
146
160
|
/**
|
|
@@ -172,8 +186,6 @@ declare module "sap/uxap/AnchorBar" {
|
|
|
172
186
|
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
173
187
|
|
|
174
188
|
/**
|
|
175
|
-
* @since 1.26
|
|
176
|
-
*
|
|
177
189
|
* Displays the titles of the sections and subsections in the {@link sap.uxap.ObjectPageLayout ObjectPageLayout }
|
|
178
190
|
* and allows the user to scroll to the respective content.
|
|
179
191
|
*
|
|
@@ -182,6 +194,8 @@ declare module "sap/uxap/AnchorBar" {
|
|
|
182
194
|
* The `AnchorBar` is internally generated as a menu in the `ObjectPageLayout`. It displays the sections
|
|
183
195
|
* and subsections and allows the user to directly scroll to the respective content by selecting them, while
|
|
184
196
|
* it remains visible at the top of the page (below the page header).
|
|
197
|
+
*
|
|
198
|
+
* @since 1.26
|
|
185
199
|
*/
|
|
186
200
|
export default class AnchorBar extends Toolbar {
|
|
187
201
|
/**
|
|
@@ -225,6 +239,7 @@ declare module "sap/uxap/AnchorBar" {
|
|
|
225
239
|
*
|
|
226
240
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.m.Toolbar.extend}.
|
|
227
241
|
*
|
|
242
|
+
*
|
|
228
243
|
* @returns Created class / constructor function
|
|
229
244
|
*/
|
|
230
245
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -245,14 +260,15 @@ declare module "sap/uxap/AnchorBar" {
|
|
|
245
260
|
/**
|
|
246
261
|
* Returns a metadata object for class sap.uxap.AnchorBar.
|
|
247
262
|
*
|
|
263
|
+
*
|
|
248
264
|
* @returns Metadata object describing this class
|
|
249
265
|
*/
|
|
250
266
|
static getMetadata(): ElementMetadata;
|
|
251
267
|
/**
|
|
252
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
253
|
-
*
|
|
254
268
|
* This method is a hook for the RenderManager that gets called during the rendering of child Controls.
|
|
255
269
|
* It allows to add, remove and update existing accessibility attributes (ARIA) of those controls.
|
|
270
|
+
*
|
|
271
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
256
272
|
*/
|
|
257
273
|
enhanceAccessibilityState(
|
|
258
274
|
/**
|
|
@@ -265,8 +281,6 @@ declare module "sap/uxap/AnchorBar" {
|
|
|
265
281
|
mAriaProps: object
|
|
266
282
|
): void;
|
|
267
283
|
/**
|
|
268
|
-
* @since 1.58
|
|
269
|
-
*
|
|
270
284
|
* Gets current value of property {@link #getBackgroundDesign backgroundDesign}.
|
|
271
285
|
*
|
|
272
286
|
* Determines the background color of the `AnchorBar`.
|
|
@@ -274,12 +288,15 @@ declare module "sap/uxap/AnchorBar" {
|
|
|
274
288
|
* **Note:** The default value of `backgroundDesign` property is null. If the property is not set, the color
|
|
275
289
|
* of the background is `@sapUiObjectHeaderBackground`, which depends on the specific theme.
|
|
276
290
|
*
|
|
291
|
+
* @since 1.58
|
|
292
|
+
*
|
|
277
293
|
* @returns Value of property `backgroundDesign`
|
|
278
294
|
*/
|
|
279
295
|
getBackgroundDesign(): BackgroundDesign | keyof typeof BackgroundDesign;
|
|
280
296
|
/**
|
|
281
297
|
* Returns an sap.ui.core.delegate.ScrollEnablement object used to handle scrolling.
|
|
282
298
|
*
|
|
299
|
+
*
|
|
283
300
|
* @returns The `sap.ui.core.delegate.ScrollEnablement` instance
|
|
284
301
|
*/
|
|
285
302
|
getScrollDelegate(): ScrollEnablement;
|
|
@@ -287,7 +304,7 @@ declare module "sap/uxap/AnchorBar" {
|
|
|
287
304
|
* ID of the element which is the current target of the association {@link #getSelectedButton selectedButton},
|
|
288
305
|
* or `null`.
|
|
289
306
|
*/
|
|
290
|
-
getSelectedButton(): ID;
|
|
307
|
+
getSelectedButton(): ID | null;
|
|
291
308
|
/**
|
|
292
309
|
* Gets current value of property {@link #getShowPopover showPopover}.
|
|
293
310
|
*
|
|
@@ -296,6 +313,7 @@ declare module "sap/uxap/AnchorBar" {
|
|
|
296
313
|
*
|
|
297
314
|
* Default value is `true`.
|
|
298
315
|
*
|
|
316
|
+
*
|
|
299
317
|
* @returns Value of property `showPopover`
|
|
300
318
|
*/
|
|
301
319
|
getShowPopover(): boolean;
|
|
@@ -306,6 +324,7 @@ declare module "sap/uxap/AnchorBar" {
|
|
|
306
324
|
*
|
|
307
325
|
* Default value is `false`.
|
|
308
326
|
*
|
|
327
|
+
*
|
|
309
328
|
* @returns Value of property `upperCase`
|
|
310
329
|
*/
|
|
311
330
|
getUpperCase(): boolean;
|
|
@@ -327,8 +346,6 @@ declare module "sap/uxap/AnchorBar" {
|
|
|
327
346
|
iDuration?: int
|
|
328
347
|
): void;
|
|
329
348
|
/**
|
|
330
|
-
* @since 1.58
|
|
331
|
-
*
|
|
332
349
|
* Sets a new value for property {@link #getBackgroundDesign backgroundDesign}.
|
|
333
350
|
*
|
|
334
351
|
* Determines the background color of the `AnchorBar`.
|
|
@@ -338,6 +355,8 @@ declare module "sap/uxap/AnchorBar" {
|
|
|
338
355
|
*
|
|
339
356
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
340
357
|
*
|
|
358
|
+
* @since 1.58
|
|
359
|
+
*
|
|
341
360
|
* @returns Reference to `this` in order to allow method chaining
|
|
342
361
|
*/
|
|
343
362
|
setBackgroundDesign(
|
|
@@ -349,6 +368,7 @@ declare module "sap/uxap/AnchorBar" {
|
|
|
349
368
|
/**
|
|
350
369
|
* Sets the associated {@link #getSelectedButton selectedButton}.
|
|
351
370
|
*
|
|
371
|
+
*
|
|
352
372
|
* @returns Reference to `this` in order to allow method chaining
|
|
353
373
|
*/
|
|
354
374
|
setSelectedButton(
|
|
@@ -368,6 +388,7 @@ declare module "sap/uxap/AnchorBar" {
|
|
|
368
388
|
*
|
|
369
389
|
* Default value is `true`.
|
|
370
390
|
*
|
|
391
|
+
*
|
|
371
392
|
* @returns Reference to `this` in order to allow method chaining
|
|
372
393
|
*/
|
|
373
394
|
setShowPopover(
|
|
@@ -385,6 +406,7 @@ declare module "sap/uxap/AnchorBar" {
|
|
|
385
406
|
*
|
|
386
407
|
* Default value is `false`.
|
|
387
408
|
*
|
|
409
|
+
*
|
|
388
410
|
* @returns Reference to `this` in order to allow method chaining
|
|
389
411
|
*/
|
|
390
412
|
setUpperCase(
|
|
@@ -408,12 +430,12 @@ declare module "sap/uxap/AnchorBar" {
|
|
|
408
430
|
upperCase?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
409
431
|
|
|
410
432
|
/**
|
|
411
|
-
* @since 1.58
|
|
412
|
-
*
|
|
413
433
|
* Determines the background color of the `AnchorBar`.
|
|
414
434
|
*
|
|
415
435
|
* **Note:** The default value of `backgroundDesign` property is null. If the property is not set, the color
|
|
416
436
|
* of the background is `@sapUiObjectHeaderBackground`, which depends on the specific theme.
|
|
437
|
+
*
|
|
438
|
+
* @since 1.58
|
|
417
439
|
*/
|
|
418
440
|
backgroundDesign?:
|
|
419
441
|
| (BackgroundDesign | keyof typeof BackgroundDesign)
|
|
@@ -451,8 +473,6 @@ declare module "sap/uxap/BlockBase" {
|
|
|
451
473
|
import Event from "sap/ui/base/Event";
|
|
452
474
|
|
|
453
475
|
/**
|
|
454
|
-
* @since 1.26
|
|
455
|
-
*
|
|
456
476
|
* The main element that holds the content that is displayed in an {@link sap.uxap.ObjectPageLayout ObjectPageLayout},
|
|
457
477
|
* but not necessarily only there.
|
|
458
478
|
*
|
|
@@ -469,6 +489,8 @@ declare module "sap/uxap/BlockBase" {
|
|
|
469
489
|
* attribute (so that the controller can interact with the block). The `oParentBlock` is firstly available
|
|
470
490
|
* in `onParentBlockModeChange` method. If the controller implements the `onParentBlockModeChange` method,
|
|
471
491
|
* this method will be called with the `sMode` parameter when the view is used or reused by the block.
|
|
492
|
+
*
|
|
493
|
+
* @since 1.26
|
|
472
494
|
*/
|
|
473
495
|
export default class BlockBase extends Control {
|
|
474
496
|
/**
|
|
@@ -514,6 +536,7 @@ declare module "sap/uxap/BlockBase" {
|
|
|
514
536
|
*
|
|
515
537
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
|
|
516
538
|
*
|
|
539
|
+
*
|
|
517
540
|
* @returns Created class / constructor function
|
|
518
541
|
*/
|
|
519
542
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -534,12 +557,14 @@ declare module "sap/uxap/BlockBase" {
|
|
|
534
557
|
/**
|
|
535
558
|
* Returns a metadata object for class sap.uxap.BlockBase.
|
|
536
559
|
*
|
|
560
|
+
*
|
|
537
561
|
* @returns Metadata object describing this class
|
|
538
562
|
*/
|
|
539
563
|
static getMetadata(): ElementMetadata;
|
|
540
564
|
/**
|
|
541
565
|
* Adds some mapping to the aggregation {@link #getMappings mappings}.
|
|
542
566
|
*
|
|
567
|
+
*
|
|
543
568
|
* @returns Reference to `this` in order to allow method chaining
|
|
544
569
|
*/
|
|
545
570
|
addMapping(
|
|
@@ -549,8 +574,6 @@ declare module "sap/uxap/BlockBase" {
|
|
|
549
574
|
oMapping: ModelMapping
|
|
550
575
|
): this;
|
|
551
576
|
/**
|
|
552
|
-
* @since 1.72
|
|
553
|
-
*
|
|
554
577
|
* Attaches event handler `fnFunction` to the {@link #event:viewInit viewInit} event of this `sap.uxap.BlockBase`.
|
|
555
578
|
*
|
|
556
579
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
@@ -558,6 +581,8 @@ declare module "sap/uxap/BlockBase" {
|
|
|
558
581
|
*
|
|
559
582
|
* Fired when an aggregated view is instantiated.
|
|
560
583
|
*
|
|
584
|
+
* @since 1.72
|
|
585
|
+
*
|
|
561
586
|
* @returns Reference to `this` in order to allow method chaining
|
|
562
587
|
*/
|
|
563
588
|
attachViewInit(
|
|
@@ -576,8 +601,6 @@ declare module "sap/uxap/BlockBase" {
|
|
|
576
601
|
oListener?: object
|
|
577
602
|
): this;
|
|
578
603
|
/**
|
|
579
|
-
* @since 1.72
|
|
580
|
-
*
|
|
581
604
|
* Attaches event handler `fnFunction` to the {@link #event:viewInit viewInit} event of this `sap.uxap.BlockBase`.
|
|
582
605
|
*
|
|
583
606
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
@@ -585,6 +608,8 @@ declare module "sap/uxap/BlockBase" {
|
|
|
585
608
|
*
|
|
586
609
|
* Fired when an aggregated view is instantiated.
|
|
587
610
|
*
|
|
611
|
+
* @since 1.72
|
|
612
|
+
*
|
|
588
613
|
* @returns Reference to `this` in order to allow method chaining
|
|
589
614
|
*/
|
|
590
615
|
attachViewInit(
|
|
@@ -598,10 +623,10 @@ declare module "sap/uxap/BlockBase" {
|
|
|
598
623
|
oListener?: object
|
|
599
624
|
): this;
|
|
600
625
|
/**
|
|
601
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
602
|
-
*
|
|
603
626
|
* Creates a view.
|
|
604
627
|
*
|
|
628
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
629
|
+
*
|
|
605
630
|
* @returns A promise on the created view.
|
|
606
631
|
*/
|
|
607
632
|
createView(
|
|
@@ -617,16 +642,17 @@ declare module "sap/uxap/BlockBase" {
|
|
|
617
642
|
/**
|
|
618
643
|
* Destroys all the mappings in the aggregation {@link #getMappings mappings}.
|
|
619
644
|
*
|
|
645
|
+
*
|
|
620
646
|
* @returns Reference to `this` in order to allow method chaining
|
|
621
647
|
*/
|
|
622
648
|
destroyMappings(): this;
|
|
623
649
|
/**
|
|
624
|
-
* @since 1.72
|
|
625
|
-
*
|
|
626
650
|
* Detaches event handler `fnFunction` from the {@link #event:viewInit viewInit} event of this `sap.uxap.BlockBase`.
|
|
627
651
|
*
|
|
628
652
|
* The passed function and listener object must match the ones used for event registration.
|
|
629
653
|
*
|
|
654
|
+
* @since 1.72
|
|
655
|
+
*
|
|
630
656
|
* @returns Reference to `this` in order to allow method chaining
|
|
631
657
|
*/
|
|
632
658
|
detachViewInit(
|
|
@@ -640,11 +666,11 @@ declare module "sap/uxap/BlockBase" {
|
|
|
640
666
|
oListener?: object
|
|
641
667
|
): this;
|
|
642
668
|
/**
|
|
669
|
+
* Fires event {@link #event:viewInit viewInit} to attached listeners.
|
|
670
|
+
*
|
|
643
671
|
* @since 1.72
|
|
644
672
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
645
673
|
*
|
|
646
|
-
* Fires event {@link #event:viewInit viewInit} to attached listeners.
|
|
647
|
-
*
|
|
648
674
|
* @returns Reference to `this` in order to allow method chaining
|
|
649
675
|
*/
|
|
650
676
|
fireViewInit(
|
|
@@ -661,6 +687,7 @@ declare module "sap/uxap/BlockBase" {
|
|
|
661
687
|
*
|
|
662
688
|
* Default value is `"auto"`.
|
|
663
689
|
*
|
|
690
|
+
*
|
|
664
691
|
* @returns Value of property `columnLayout`
|
|
665
692
|
*/
|
|
666
693
|
getColumnLayout(): BlockBaseColumnLayout;
|
|
@@ -675,6 +702,7 @@ declare module "sap/uxap/BlockBase" {
|
|
|
675
702
|
*
|
|
676
703
|
* Default value is `BlockColumns`.
|
|
677
704
|
*
|
|
705
|
+
*
|
|
678
706
|
* @returns Value of property `formAdjustment`
|
|
679
707
|
*/
|
|
680
708
|
getFormAdjustment():
|
|
@@ -694,6 +722,7 @@ declare module "sap/uxap/BlockBase" {
|
|
|
694
722
|
* {@link sap.uxap.ObjectPageSubSection SubSection}. The `mode` property of `BlockBase` changes when the
|
|
695
723
|
* `mode` property of `ObjectPageSubSection` changes.
|
|
696
724
|
*
|
|
725
|
+
*
|
|
697
726
|
* @returns Value of property `mode`
|
|
698
727
|
*/
|
|
699
728
|
getMode(): string;
|
|
@@ -701,7 +730,7 @@ declare module "sap/uxap/BlockBase" {
|
|
|
701
730
|
* ID of the element which is the current target of the association {@link #getSelectedView selectedView},
|
|
702
731
|
* or `null`.
|
|
703
732
|
*/
|
|
704
|
-
getSelectedView(): ID;
|
|
733
|
+
getSelectedView(): ID | null;
|
|
705
734
|
/**
|
|
706
735
|
* Gets current value of property {@link #getShowSubSectionMore showSubSectionMore}.
|
|
707
736
|
*
|
|
@@ -712,6 +741,7 @@ declare module "sap/uxap/BlockBase" {
|
|
|
712
741
|
*
|
|
713
742
|
* Default value is `false`.
|
|
714
743
|
*
|
|
744
|
+
*
|
|
715
745
|
* @returns Value of property `showSubSectionMore`
|
|
716
746
|
*/
|
|
717
747
|
getShowSubSectionMore(): boolean;
|
|
@@ -722,6 +752,7 @@ declare module "sap/uxap/BlockBase" {
|
|
|
722
752
|
*
|
|
723
753
|
* Default value is `true`.
|
|
724
754
|
*
|
|
755
|
+
*
|
|
725
756
|
* @returns Value of property `visible`
|
|
726
757
|
*/
|
|
727
758
|
getVisible(): boolean;
|
|
@@ -729,6 +760,7 @@ declare module "sap/uxap/BlockBase" {
|
|
|
729
760
|
* Checks for the provided `sap.uxap.ModelMapping` in the aggregation {@link #getMappings mappings}. and
|
|
730
761
|
* returns its index if found or -1 otherwise.
|
|
731
762
|
*
|
|
763
|
+
*
|
|
732
764
|
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
733
765
|
*/
|
|
734
766
|
indexOfMapping(
|
|
@@ -740,6 +772,7 @@ declare module "sap/uxap/BlockBase" {
|
|
|
740
772
|
/**
|
|
741
773
|
* Inserts a mapping into the aggregation {@link #getMappings mappings}.
|
|
742
774
|
*
|
|
775
|
+
*
|
|
743
776
|
* @returns Reference to `this` in order to allow method chaining
|
|
744
777
|
*/
|
|
745
778
|
insertMapping(
|
|
@@ -759,12 +792,14 @@ declare module "sap/uxap/BlockBase" {
|
|
|
759
792
|
*
|
|
760
793
|
* Additionally, it unregisters them from the hosting UIArea.
|
|
761
794
|
*
|
|
795
|
+
*
|
|
762
796
|
* @returns An array of the removed elements (might be empty)
|
|
763
797
|
*/
|
|
764
798
|
removeAllMappings(): ModelMapping[];
|
|
765
799
|
/**
|
|
766
800
|
* Removes a mapping from the aggregation {@link #getMappings mappings}.
|
|
767
801
|
*
|
|
802
|
+
*
|
|
768
803
|
* @returns The removed mapping or `null`
|
|
769
804
|
*/
|
|
770
805
|
removeMapping(
|
|
@@ -776,6 +811,7 @@ declare module "sap/uxap/BlockBase" {
|
|
|
776
811
|
/**
|
|
777
812
|
* Set the column layout for this particular block.
|
|
778
813
|
*
|
|
814
|
+
*
|
|
779
815
|
* @returns this
|
|
780
816
|
*/
|
|
781
817
|
setColumnLayout(
|
|
@@ -797,6 +833,7 @@ declare module "sap/uxap/BlockBase" {
|
|
|
797
833
|
*
|
|
798
834
|
* Default value is `BlockColumns`.
|
|
799
835
|
*
|
|
836
|
+
*
|
|
800
837
|
* @returns Reference to `this` in order to allow method chaining
|
|
801
838
|
*/
|
|
802
839
|
setFormAdjustment(
|
|
@@ -810,6 +847,7 @@ declare module "sap/uxap/BlockBase" {
|
|
|
810
847
|
/**
|
|
811
848
|
* Set the view mode for this particular block.
|
|
812
849
|
*
|
|
850
|
+
*
|
|
813
851
|
* @returns this
|
|
814
852
|
*/
|
|
815
853
|
setMode(
|
|
@@ -821,6 +859,7 @@ declare module "sap/uxap/BlockBase" {
|
|
|
821
859
|
/**
|
|
822
860
|
* Sets the associated {@link #getSelectedView selectedView}.
|
|
823
861
|
*
|
|
862
|
+
*
|
|
824
863
|
* @returns Reference to `this` in order to allow method chaining
|
|
825
864
|
*/
|
|
826
865
|
setSelectedView(
|
|
@@ -842,6 +881,7 @@ declare module "sap/uxap/BlockBase" {
|
|
|
842
881
|
*
|
|
843
882
|
* Default value is `false`.
|
|
844
883
|
*
|
|
884
|
+
*
|
|
845
885
|
* @returns Reference to `this` in order to allow method chaining
|
|
846
886
|
*/
|
|
847
887
|
setShowSubSectionMore(
|
|
@@ -859,6 +899,7 @@ declare module "sap/uxap/BlockBase" {
|
|
|
859
899
|
*
|
|
860
900
|
* Default value is `true`.
|
|
861
901
|
*
|
|
902
|
+
*
|
|
862
903
|
* @returns Reference to `this` in order to allow method chaining
|
|
863
904
|
*/
|
|
864
905
|
setVisible(
|
|
@@ -929,9 +970,9 @@ declare module "sap/uxap/BlockBase" {
|
|
|
929
970
|
selectedView?: Control | string;
|
|
930
971
|
|
|
931
972
|
/**
|
|
932
|
-
* @since 1.72
|
|
933
|
-
*
|
|
934
973
|
* Fired when an aggregated view is instantiated.
|
|
974
|
+
*
|
|
975
|
+
* @since 1.72
|
|
935
976
|
*/
|
|
936
977
|
viewInit?: (oEvent: BlockBase$ViewInitEvent) => void;
|
|
937
978
|
}
|
|
@@ -964,8 +1005,6 @@ declare module "sap/uxap/BreadCrumbs" {
|
|
|
964
1005
|
} from "sap/ui/base/ManagedObject";
|
|
965
1006
|
|
|
966
1007
|
/**
|
|
967
|
-
* @since 1.30
|
|
968
|
-
*
|
|
969
1008
|
* Represents the navigation steps up to the current location in the app.
|
|
970
1009
|
*
|
|
971
1010
|
* Overview:
|
|
@@ -977,6 +1016,8 @@ declare module "sap/uxap/BreadCrumbs" {
|
|
|
977
1016
|
* - A trail of links followed by separators, when there's enough space for the control to fit on one
|
|
978
1017
|
* line.
|
|
979
1018
|
* - A dropdown list with the links, when the trail of links wouldn't fit on one line.
|
|
1019
|
+
*
|
|
1020
|
+
* @since 1.30
|
|
980
1021
|
*/
|
|
981
1022
|
export default class BreadCrumbs extends Control {
|
|
982
1023
|
/**
|
|
@@ -1016,6 +1057,7 @@ declare module "sap/uxap/BreadCrumbs" {
|
|
|
1016
1057
|
*
|
|
1017
1058
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
|
|
1018
1059
|
*
|
|
1060
|
+
*
|
|
1019
1061
|
* @returns Created class / constructor function
|
|
1020
1062
|
*/
|
|
1021
1063
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -1036,12 +1078,14 @@ declare module "sap/uxap/BreadCrumbs" {
|
|
|
1036
1078
|
/**
|
|
1037
1079
|
* Returns a metadata object for class sap.uxap.BreadCrumbs.
|
|
1038
1080
|
*
|
|
1081
|
+
*
|
|
1039
1082
|
* @returns Metadata object describing this class
|
|
1040
1083
|
*/
|
|
1041
1084
|
static getMetadata(): ElementMetadata;
|
|
1042
1085
|
/**
|
|
1043
1086
|
* Adds some link to the aggregation {@link #getLinks links}.
|
|
1044
1087
|
*
|
|
1088
|
+
*
|
|
1045
1089
|
* @returns Reference to `this` in order to allow method chaining
|
|
1046
1090
|
*/
|
|
1047
1091
|
addLink(
|
|
@@ -1053,12 +1097,14 @@ declare module "sap/uxap/BreadCrumbs" {
|
|
|
1053
1097
|
/**
|
|
1054
1098
|
* Destroys the currentLocation in the aggregation {@link #getCurrentLocation currentLocation}.
|
|
1055
1099
|
*
|
|
1100
|
+
*
|
|
1056
1101
|
* @returns Reference to `this` in order to allow method chaining
|
|
1057
1102
|
*/
|
|
1058
1103
|
destroyCurrentLocation(): this;
|
|
1059
1104
|
/**
|
|
1060
1105
|
* Destroys all the links in the aggregation {@link #getLinks links}.
|
|
1061
1106
|
*
|
|
1107
|
+
*
|
|
1062
1108
|
* @returns Reference to `this` in order to allow method chaining
|
|
1063
1109
|
*/
|
|
1064
1110
|
destroyLinks(): this;
|
|
@@ -1081,6 +1127,7 @@ declare module "sap/uxap/BreadCrumbs" {
|
|
|
1081
1127
|
*
|
|
1082
1128
|
* Default value is `true`.
|
|
1083
1129
|
*
|
|
1130
|
+
*
|
|
1084
1131
|
* @returns Value of property `showCurrentLocation`
|
|
1085
1132
|
*/
|
|
1086
1133
|
getShowCurrentLocation(): boolean;
|
|
@@ -1088,6 +1135,7 @@ declare module "sap/uxap/BreadCrumbs" {
|
|
|
1088
1135
|
* Checks for the provided `sap.m.Link` in the aggregation {@link #getLinks links}. and returns its index
|
|
1089
1136
|
* if found or -1 otherwise.
|
|
1090
1137
|
*
|
|
1138
|
+
*
|
|
1091
1139
|
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
1092
1140
|
*/
|
|
1093
1141
|
indexOfLink(
|
|
@@ -1099,6 +1147,7 @@ declare module "sap/uxap/BreadCrumbs" {
|
|
|
1099
1147
|
/**
|
|
1100
1148
|
* Inserts a link into the aggregation {@link #getLinks links}.
|
|
1101
1149
|
*
|
|
1150
|
+
*
|
|
1102
1151
|
* @returns Reference to `this` in order to allow method chaining
|
|
1103
1152
|
*/
|
|
1104
1153
|
insertLink(
|
|
@@ -1118,12 +1167,14 @@ declare module "sap/uxap/BreadCrumbs" {
|
|
|
1118
1167
|
*
|
|
1119
1168
|
* Additionally, it unregisters them from the hosting UIArea.
|
|
1120
1169
|
*
|
|
1170
|
+
*
|
|
1121
1171
|
* @returns An array of the removed elements (might be empty)
|
|
1122
1172
|
*/
|
|
1123
1173
|
removeAllLinks(): Link[];
|
|
1124
1174
|
/**
|
|
1125
1175
|
* Removes a link from the aggregation {@link #getLinks links}.
|
|
1126
1176
|
*
|
|
1177
|
+
*
|
|
1127
1178
|
* @returns The removed link or `null`
|
|
1128
1179
|
*/
|
|
1129
1180
|
removeLink(
|
|
@@ -1135,6 +1186,7 @@ declare module "sap/uxap/BreadCrumbs" {
|
|
|
1135
1186
|
/**
|
|
1136
1187
|
* Sets the aggregated {@link #getCurrentLocation currentLocation}.
|
|
1137
1188
|
*
|
|
1189
|
+
*
|
|
1138
1190
|
* @returns Reference to `this` in order to allow method chaining
|
|
1139
1191
|
*/
|
|
1140
1192
|
setCurrentLocation(
|
|
@@ -1152,6 +1204,7 @@ declare module "sap/uxap/BreadCrumbs" {
|
|
|
1152
1204
|
*
|
|
1153
1205
|
* Default value is `true`.
|
|
1154
1206
|
*
|
|
1207
|
+
*
|
|
1155
1208
|
* @returns Reference to `this` in order to allow method chaining
|
|
1156
1209
|
*/
|
|
1157
1210
|
setShowCurrentLocation(
|
|
@@ -1188,12 +1241,12 @@ declare module "sap/uxap/HierarchicalSelect" {
|
|
|
1188
1241
|
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
1189
1242
|
|
|
1190
1243
|
/**
|
|
1191
|
-
* @since 1.26
|
|
1192
|
-
*
|
|
1193
1244
|
* A select that displays items on a hierarchy of 2 levels.
|
|
1194
1245
|
*
|
|
1195
1246
|
* If a provided item has a custom data named `secondLevel`, then it will be displayed as a second level,
|
|
1196
1247
|
* otherwise it would be displayed as a first level.
|
|
1248
|
+
*
|
|
1249
|
+
* @since 1.26
|
|
1197
1250
|
*/
|
|
1198
1251
|
export default class HierarchicalSelect extends Select {
|
|
1199
1252
|
/**
|
|
@@ -1233,6 +1286,7 @@ declare module "sap/uxap/HierarchicalSelect" {
|
|
|
1233
1286
|
*
|
|
1234
1287
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.m.Select.extend}.
|
|
1235
1288
|
*
|
|
1289
|
+
*
|
|
1236
1290
|
* @returns Created class / constructor function
|
|
1237
1291
|
*/
|
|
1238
1292
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -1253,6 +1307,7 @@ declare module "sap/uxap/HierarchicalSelect" {
|
|
|
1253
1307
|
/**
|
|
1254
1308
|
* Returns a metadata object for class sap.uxap.HierarchicalSelect.
|
|
1255
1309
|
*
|
|
1310
|
+
*
|
|
1256
1311
|
* @returns Metadata object describing this class
|
|
1257
1312
|
*/
|
|
1258
1313
|
static getMetadata(): ElementMetadata;
|
|
@@ -1263,6 +1318,7 @@ declare module "sap/uxap/HierarchicalSelect" {
|
|
|
1263
1318
|
*
|
|
1264
1319
|
* Default value is `false`.
|
|
1265
1320
|
*
|
|
1321
|
+
*
|
|
1266
1322
|
* @returns Value of property `upperCase`
|
|
1267
1323
|
*/
|
|
1268
1324
|
getUpperCase(): boolean;
|
|
@@ -1275,6 +1331,7 @@ declare module "sap/uxap/HierarchicalSelect" {
|
|
|
1275
1331
|
*
|
|
1276
1332
|
* Default value is `false`.
|
|
1277
1333
|
*
|
|
1334
|
+
*
|
|
1278
1335
|
* @returns Reference to `this` in order to allow method chaining
|
|
1279
1336
|
*/
|
|
1280
1337
|
setUpperCase(
|
|
@@ -1301,9 +1358,9 @@ declare module "sap/uxap/ModelMapping" {
|
|
|
1301
1358
|
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
1302
1359
|
|
|
1303
1360
|
/**
|
|
1304
|
-
* @since 1.26
|
|
1305
|
-
*
|
|
1306
1361
|
* Defines the entity that will be passed to the {@link sap.uxap.ObjectPageLayout}.
|
|
1362
|
+
*
|
|
1363
|
+
* @since 1.26
|
|
1307
1364
|
*/
|
|
1308
1365
|
export default class ModelMapping extends UI5Element {
|
|
1309
1366
|
/**
|
|
@@ -1343,6 +1400,7 @@ declare module "sap/uxap/ModelMapping" {
|
|
|
1343
1400
|
*
|
|
1344
1401
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
|
|
1345
1402
|
*
|
|
1403
|
+
*
|
|
1346
1404
|
* @returns Created class / constructor function
|
|
1347
1405
|
*/
|
|
1348
1406
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -1363,6 +1421,7 @@ declare module "sap/uxap/ModelMapping" {
|
|
|
1363
1421
|
/**
|
|
1364
1422
|
* Returns a metadata object for class sap.uxap.ModelMapping.
|
|
1365
1423
|
*
|
|
1424
|
+
*
|
|
1366
1425
|
* @returns Metadata object describing this class
|
|
1367
1426
|
*/
|
|
1368
1427
|
static getMetadata(): ElementMetadata;
|
|
@@ -1371,6 +1430,7 @@ declare module "sap/uxap/ModelMapping" {
|
|
|
1371
1430
|
*
|
|
1372
1431
|
* Determines the external model name.
|
|
1373
1432
|
*
|
|
1433
|
+
*
|
|
1374
1434
|
* @returns Value of property `externalModelName`
|
|
1375
1435
|
*/
|
|
1376
1436
|
getExternalModelName(): string;
|
|
@@ -1379,6 +1439,7 @@ declare module "sap/uxap/ModelMapping" {
|
|
|
1379
1439
|
*
|
|
1380
1440
|
* Determines the external path.
|
|
1381
1441
|
*
|
|
1442
|
+
*
|
|
1382
1443
|
* @returns Value of property `externalPath`
|
|
1383
1444
|
*/
|
|
1384
1445
|
getExternalPath(): string;
|
|
@@ -1389,6 +1450,7 @@ declare module "sap/uxap/ModelMapping" {
|
|
|
1389
1450
|
*
|
|
1390
1451
|
* Default value is `"Model"`.
|
|
1391
1452
|
*
|
|
1453
|
+
*
|
|
1392
1454
|
* @returns Value of property `internalModelName`
|
|
1393
1455
|
*/
|
|
1394
1456
|
getInternalModelName(): string;
|
|
@@ -1399,6 +1461,7 @@ declare module "sap/uxap/ModelMapping" {
|
|
|
1399
1461
|
*
|
|
1400
1462
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1401
1463
|
*
|
|
1464
|
+
*
|
|
1402
1465
|
* @returns Reference to `this` in order to allow method chaining
|
|
1403
1466
|
*/
|
|
1404
1467
|
setExternalModelName(
|
|
@@ -1414,6 +1477,7 @@ declare module "sap/uxap/ModelMapping" {
|
|
|
1414
1477
|
*
|
|
1415
1478
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1416
1479
|
*
|
|
1480
|
+
*
|
|
1417
1481
|
* @returns Reference to `this` in order to allow method chaining
|
|
1418
1482
|
*/
|
|
1419
1483
|
setExternalPath(
|
|
@@ -1431,6 +1495,7 @@ declare module "sap/uxap/ModelMapping" {
|
|
|
1431
1495
|
*
|
|
1432
1496
|
* Default value is `"Model"`.
|
|
1433
1497
|
*
|
|
1498
|
+
*
|
|
1434
1499
|
* @returns Reference to `this` in order to allow method chaining
|
|
1435
1500
|
*/
|
|
1436
1501
|
setInternalModelName(
|
|
@@ -1469,11 +1534,11 @@ declare module "sap/uxap/ObjectPageAccessibleLandmarkInfo" {
|
|
|
1469
1534
|
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
1470
1535
|
|
|
1471
1536
|
/**
|
|
1472
|
-
* @since 1.61
|
|
1473
|
-
*
|
|
1474
1537
|
* Settings for accessible landmarks which can be applied to the container elements of a `sap.uxap.ObjectPageLayout`
|
|
1475
1538
|
* control. These landmarks are used by assistive technologies (such as screenreaders) to provide a meaningful
|
|
1476
1539
|
* page overview.
|
|
1540
|
+
*
|
|
1541
|
+
* @since 1.61
|
|
1477
1542
|
*/
|
|
1478
1543
|
export default class ObjectPageAccessibleLandmarkInfo extends UI5Element {
|
|
1479
1544
|
/**
|
|
@@ -1513,6 +1578,7 @@ declare module "sap/uxap/ObjectPageAccessibleLandmarkInfo" {
|
|
|
1513
1578
|
*
|
|
1514
1579
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
|
|
1515
1580
|
*
|
|
1581
|
+
*
|
|
1516
1582
|
* @returns Created class / constructor function
|
|
1517
1583
|
*/
|
|
1518
1584
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -1533,6 +1599,7 @@ declare module "sap/uxap/ObjectPageAccessibleLandmarkInfo" {
|
|
|
1533
1599
|
/**
|
|
1534
1600
|
* Returns a metadata object for class sap.uxap.ObjectPageAccessibleLandmarkInfo.
|
|
1535
1601
|
*
|
|
1602
|
+
*
|
|
1536
1603
|
* @returns Metadata object describing this class
|
|
1537
1604
|
*/
|
|
1538
1605
|
static getMetadata(): ElementMetadata;
|
|
@@ -1545,6 +1612,7 @@ declare module "sap/uxap/ObjectPageAccessibleLandmarkInfo" {
|
|
|
1545
1612
|
* If not set (and a landmark different than `sap.ui.core.AccessibleLandmarkRole.None` is defined), no label
|
|
1546
1613
|
* is set.
|
|
1547
1614
|
*
|
|
1615
|
+
*
|
|
1548
1616
|
* @returns Value of property `contentLabel`
|
|
1549
1617
|
*/
|
|
1550
1618
|
getContentLabel(): string;
|
|
@@ -1557,6 +1625,7 @@ declare module "sap/uxap/ObjectPageAccessibleLandmarkInfo" {
|
|
|
1557
1625
|
*
|
|
1558
1626
|
* Default value is `"None"`.
|
|
1559
1627
|
*
|
|
1628
|
+
*
|
|
1560
1629
|
* @returns Value of property `contentRole`
|
|
1561
1630
|
*/
|
|
1562
1631
|
getContentRole():
|
|
@@ -1571,6 +1640,7 @@ declare module "sap/uxap/ObjectPageAccessibleLandmarkInfo" {
|
|
|
1571
1640
|
* If not set (and a landmark different than `sap.ui.core.AccessibleLandmarkRole.None` is defined), no label
|
|
1572
1641
|
* is set.
|
|
1573
1642
|
*
|
|
1643
|
+
*
|
|
1574
1644
|
* @returns Value of property `footerLabel`
|
|
1575
1645
|
*/
|
|
1576
1646
|
getFooterLabel(): string;
|
|
@@ -1583,6 +1653,7 @@ declare module "sap/uxap/ObjectPageAccessibleLandmarkInfo" {
|
|
|
1583
1653
|
*
|
|
1584
1654
|
* Default value is `"Region"`.
|
|
1585
1655
|
*
|
|
1656
|
+
*
|
|
1586
1657
|
* @returns Value of property `footerRole`
|
|
1587
1658
|
*/
|
|
1588
1659
|
getFooterRole():
|
|
@@ -1597,6 +1668,7 @@ declare module "sap/uxap/ObjectPageAccessibleLandmarkInfo" {
|
|
|
1597
1668
|
* If not set (and a landmark different than `sap.ui.core.AccessibleLandmarkRole.None` is defined), no label
|
|
1598
1669
|
* is set.
|
|
1599
1670
|
*
|
|
1671
|
+
*
|
|
1600
1672
|
* @returns Value of property `headerLabel`
|
|
1601
1673
|
*/
|
|
1602
1674
|
getHeaderLabel(): string;
|
|
@@ -1609,6 +1681,7 @@ declare module "sap/uxap/ObjectPageAccessibleLandmarkInfo" {
|
|
|
1609
1681
|
*
|
|
1610
1682
|
* Default value is `"Banner"`.
|
|
1611
1683
|
*
|
|
1684
|
+
*
|
|
1612
1685
|
* @returns Value of property `headerRole`
|
|
1613
1686
|
*/
|
|
1614
1687
|
getHeaderRole():
|
|
@@ -1623,6 +1696,7 @@ declare module "sap/uxap/ObjectPageAccessibleLandmarkInfo" {
|
|
|
1623
1696
|
* If not set (and a landmark different than `sap.ui.core.AccessibleLandmarkRole.None` is defined), no label
|
|
1624
1697
|
* is set.
|
|
1625
1698
|
*
|
|
1699
|
+
*
|
|
1626
1700
|
* @returns Value of property `navigationLabel`
|
|
1627
1701
|
*/
|
|
1628
1702
|
getNavigationLabel(): string;
|
|
@@ -1635,6 +1709,7 @@ declare module "sap/uxap/ObjectPageAccessibleLandmarkInfo" {
|
|
|
1635
1709
|
*
|
|
1636
1710
|
* Default value is `"Navigation"`.
|
|
1637
1711
|
*
|
|
1712
|
+
*
|
|
1638
1713
|
* @returns Value of property `navigationRole`
|
|
1639
1714
|
*/
|
|
1640
1715
|
getNavigationRole():
|
|
@@ -1649,6 +1724,7 @@ declare module "sap/uxap/ObjectPageAccessibleLandmarkInfo" {
|
|
|
1649
1724
|
* If not set (and a landmark different than `sap.ui.core.AccessibleLandmarkRole.None` is defined), no label
|
|
1650
1725
|
* is set.
|
|
1651
1726
|
*
|
|
1727
|
+
*
|
|
1652
1728
|
* @returns Value of property `rootLabel`
|
|
1653
1729
|
*/
|
|
1654
1730
|
getRootLabel(): string;
|
|
@@ -1661,6 +1737,7 @@ declare module "sap/uxap/ObjectPageAccessibleLandmarkInfo" {
|
|
|
1661
1737
|
*
|
|
1662
1738
|
* Default value is `"Main"`.
|
|
1663
1739
|
*
|
|
1740
|
+
*
|
|
1664
1741
|
* @returns Value of property `rootRole`
|
|
1665
1742
|
*/
|
|
1666
1743
|
getRootRole(): AccessibleLandmarkRole | keyof typeof AccessibleLandmarkRole;
|
|
@@ -1675,6 +1752,7 @@ declare module "sap/uxap/ObjectPageAccessibleLandmarkInfo" {
|
|
|
1675
1752
|
*
|
|
1676
1753
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1677
1754
|
*
|
|
1755
|
+
*
|
|
1678
1756
|
* @returns Reference to `this` in order to allow method chaining
|
|
1679
1757
|
*/
|
|
1680
1758
|
setContentLabel(
|
|
@@ -1694,6 +1772,7 @@ declare module "sap/uxap/ObjectPageAccessibleLandmarkInfo" {
|
|
|
1694
1772
|
*
|
|
1695
1773
|
* Default value is `"None"`.
|
|
1696
1774
|
*
|
|
1775
|
+
*
|
|
1697
1776
|
* @returns Reference to `this` in order to allow method chaining
|
|
1698
1777
|
*/
|
|
1699
1778
|
setContentRole(
|
|
@@ -1715,6 +1794,7 @@ declare module "sap/uxap/ObjectPageAccessibleLandmarkInfo" {
|
|
|
1715
1794
|
*
|
|
1716
1795
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1717
1796
|
*
|
|
1797
|
+
*
|
|
1718
1798
|
* @returns Reference to `this` in order to allow method chaining
|
|
1719
1799
|
*/
|
|
1720
1800
|
setFooterLabel(
|
|
@@ -1734,6 +1814,7 @@ declare module "sap/uxap/ObjectPageAccessibleLandmarkInfo" {
|
|
|
1734
1814
|
*
|
|
1735
1815
|
* Default value is `"Region"`.
|
|
1736
1816
|
*
|
|
1817
|
+
*
|
|
1737
1818
|
* @returns Reference to `this` in order to allow method chaining
|
|
1738
1819
|
*/
|
|
1739
1820
|
setFooterRole(
|
|
@@ -1753,6 +1834,7 @@ declare module "sap/uxap/ObjectPageAccessibleLandmarkInfo" {
|
|
|
1753
1834
|
*
|
|
1754
1835
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1755
1836
|
*
|
|
1837
|
+
*
|
|
1756
1838
|
* @returns Reference to `this` in order to allow method chaining
|
|
1757
1839
|
*/
|
|
1758
1840
|
setHeaderLabel(
|
|
@@ -1772,6 +1854,7 @@ declare module "sap/uxap/ObjectPageAccessibleLandmarkInfo" {
|
|
|
1772
1854
|
*
|
|
1773
1855
|
* Default value is `"Banner"`.
|
|
1774
1856
|
*
|
|
1857
|
+
*
|
|
1775
1858
|
* @returns Reference to `this` in order to allow method chaining
|
|
1776
1859
|
*/
|
|
1777
1860
|
setHeaderRole(
|
|
@@ -1791,6 +1874,7 @@ declare module "sap/uxap/ObjectPageAccessibleLandmarkInfo" {
|
|
|
1791
1874
|
*
|
|
1792
1875
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1793
1876
|
*
|
|
1877
|
+
*
|
|
1794
1878
|
* @returns Reference to `this` in order to allow method chaining
|
|
1795
1879
|
*/
|
|
1796
1880
|
setNavigationLabel(
|
|
@@ -1810,6 +1894,7 @@ declare module "sap/uxap/ObjectPageAccessibleLandmarkInfo" {
|
|
|
1810
1894
|
*
|
|
1811
1895
|
* Default value is `"Navigation"`.
|
|
1812
1896
|
*
|
|
1897
|
+
*
|
|
1813
1898
|
* @returns Reference to `this` in order to allow method chaining
|
|
1814
1899
|
*/
|
|
1815
1900
|
setNavigationRole(
|
|
@@ -1831,6 +1916,7 @@ declare module "sap/uxap/ObjectPageAccessibleLandmarkInfo" {
|
|
|
1831
1916
|
*
|
|
1832
1917
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1833
1918
|
*
|
|
1919
|
+
*
|
|
1834
1920
|
* @returns Reference to `this` in order to allow method chaining
|
|
1835
1921
|
*/
|
|
1836
1922
|
setRootLabel(
|
|
@@ -1850,6 +1936,7 @@ declare module "sap/uxap/ObjectPageAccessibleLandmarkInfo" {
|
|
|
1850
1936
|
*
|
|
1851
1937
|
* Default value is `"Main"`.
|
|
1852
1938
|
*
|
|
1939
|
+
*
|
|
1853
1940
|
* @returns Reference to `this` in order to allow method chaining
|
|
1854
1941
|
*/
|
|
1855
1942
|
setRootRole(
|
|
@@ -1970,8 +2057,6 @@ declare module "sap/uxap/ObjectPageDynamicHeaderContent" {
|
|
|
1970
2057
|
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
1971
2058
|
|
|
1972
2059
|
/**
|
|
1973
|
-
* @since 1.52
|
|
1974
|
-
*
|
|
1975
2060
|
* Header content for the dynamic header of the {@link sap.uxap.ObjectPageLayout}.
|
|
1976
2061
|
*
|
|
1977
2062
|
* Overview:
|
|
@@ -1984,6 +2069,8 @@ declare module "sap/uxap/ObjectPageDynamicHeaderContent" {
|
|
|
1984
2069
|
* Documentation links:
|
|
1985
2070
|
* - {@link https://ui5.sap.com/#/topic/d2ef0099542d44dc868719d908e576d0 Object Page Headers}
|
|
1986
2071
|
* - {@link https://ui5.sap.com/#/topic/6e340c119ddd4c778b315f65a0432420 Object Page Dynamic Header}
|
|
2072
|
+
*
|
|
2073
|
+
* @since 1.52
|
|
1987
2074
|
*/
|
|
1988
2075
|
export default class ObjectPageDynamicHeaderContent
|
|
1989
2076
|
extends DynamicPageHeader
|
|
@@ -2032,6 +2119,7 @@ declare module "sap/uxap/ObjectPageDynamicHeaderContent" {
|
|
|
2032
2119
|
*
|
|
2033
2120
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.f.DynamicPageHeader.extend}.
|
|
2034
2121
|
*
|
|
2122
|
+
*
|
|
2035
2123
|
* @returns Created class / constructor function
|
|
2036
2124
|
*/
|
|
2037
2125
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -2052,6 +2140,7 @@ declare module "sap/uxap/ObjectPageDynamicHeaderContent" {
|
|
|
2052
2140
|
/**
|
|
2053
2141
|
* Returns a metadata object for class sap.uxap.ObjectPageDynamicHeaderContent.
|
|
2054
2142
|
*
|
|
2143
|
+
*
|
|
2055
2144
|
* @returns Metadata object describing this class
|
|
2056
2145
|
*/
|
|
2057
2146
|
static getMetadata(): ElementMetadata;
|
|
@@ -2072,8 +2161,6 @@ declare module "sap/uxap/ObjectPageDynamicHeaderTitle" {
|
|
|
2072
2161
|
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
2073
2162
|
|
|
2074
2163
|
/**
|
|
2075
|
-
* @since 1.52
|
|
2076
|
-
*
|
|
2077
2164
|
* Represents the static part (header title) of the dynamic header of the {@link sap.uxap.ObjectPageLayout}.
|
|
2078
2165
|
*
|
|
2079
2166
|
* Overview:
|
|
@@ -2083,6 +2170,8 @@ declare module "sap/uxap/ObjectPageDynamicHeaderTitle" {
|
|
|
2083
2170
|
*
|
|
2084
2171
|
* **Note:** The `ObjectPageDynamicHeaderTitle` is meant to be used inside the `ObjectPageLayout` control.
|
|
2085
2172
|
* Any other usage is not supported and can lead to unexpected behavior.
|
|
2173
|
+
*
|
|
2174
|
+
* @since 1.52
|
|
2086
2175
|
*/
|
|
2087
2176
|
export default class ObjectPageDynamicHeaderTitle
|
|
2088
2177
|
extends DynamicPageTitle
|
|
@@ -2139,6 +2228,7 @@ declare module "sap/uxap/ObjectPageDynamicHeaderTitle" {
|
|
|
2139
2228
|
*
|
|
2140
2229
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.f.DynamicPageTitle.extend}.
|
|
2141
2230
|
*
|
|
2231
|
+
*
|
|
2142
2232
|
* @returns Created class / constructor function
|
|
2143
2233
|
*/
|
|
2144
2234
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -2159,6 +2249,7 @@ declare module "sap/uxap/ObjectPageDynamicHeaderTitle" {
|
|
|
2159
2249
|
/**
|
|
2160
2250
|
* Returns a metadata object for class sap.uxap.ObjectPageDynamicHeaderTitle.
|
|
2161
2251
|
*
|
|
2252
|
+
*
|
|
2162
2253
|
* @returns Metadata object describing this class
|
|
2163
2254
|
*/
|
|
2164
2255
|
static getMetadata(): ElementMetadata;
|
|
@@ -2197,8 +2288,6 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2197
2288
|
import Event from "sap/ui/base/Event";
|
|
2198
2289
|
|
|
2199
2290
|
/**
|
|
2200
|
-
* @since 1.26
|
|
2201
|
-
*
|
|
2202
2291
|
* Represents the static part (header title) of the classic header of the {@link sap.uxap.ObjectPageLayout}.
|
|
2203
2292
|
*
|
|
2204
2293
|
* Overview:
|
|
@@ -2208,6 +2297,8 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2208
2297
|
*
|
|
2209
2298
|
* **Note:** The `ObjectPageHeader` is meant to be used inside the `ObjectPageLayout` control. Any other
|
|
2210
2299
|
* usage is not supported and can lead to unexpected behavior.
|
|
2300
|
+
*
|
|
2301
|
+
* @since 1.26
|
|
2211
2302
|
*/
|
|
2212
2303
|
export default class ObjectPageHeader
|
|
2213
2304
|
extends Control
|
|
@@ -2262,6 +2353,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2262
2353
|
*
|
|
2263
2354
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
|
|
2264
2355
|
*
|
|
2356
|
+
*
|
|
2265
2357
|
* @returns Created class / constructor function
|
|
2266
2358
|
*/
|
|
2267
2359
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -2282,12 +2374,14 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2282
2374
|
/**
|
|
2283
2375
|
* Returns a metadata object for class sap.uxap.ObjectPageHeader.
|
|
2284
2376
|
*
|
|
2377
|
+
*
|
|
2285
2378
|
* @returns Metadata object describing this class
|
|
2286
2379
|
*/
|
|
2287
2380
|
static getMetadata(): ElementMetadata;
|
|
2288
2381
|
/**
|
|
2289
2382
|
* Adds some action to the aggregation {@link #getActions actions}.
|
|
2290
2383
|
*
|
|
2384
|
+
*
|
|
2291
2385
|
* @returns Reference to `this` in order to allow method chaining
|
|
2292
2386
|
*/
|
|
2293
2387
|
addAction(
|
|
@@ -2297,10 +2391,10 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2297
2391
|
oAction: Control
|
|
2298
2392
|
): this;
|
|
2299
2393
|
/**
|
|
2300
|
-
* @deprecated (since 1.50) - use the `breadcrumbs` aggregation instead.
|
|
2301
|
-
*
|
|
2302
2394
|
* Adds some breadCrumbLink to the aggregation {@link #getBreadCrumbsLinks breadCrumbsLinks}.
|
|
2303
2395
|
*
|
|
2396
|
+
* @deprecated (since 1.50) - use the `breadcrumbs` aggregation instead.
|
|
2397
|
+
*
|
|
2304
2398
|
* @returns Reference to `this` in order to allow method chaining
|
|
2305
2399
|
*/
|
|
2306
2400
|
addBreadCrumbLink(
|
|
@@ -2318,6 +2412,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2318
2412
|
*
|
|
2319
2413
|
* The event is fired when the unsaved changes button is pressed
|
|
2320
2414
|
*
|
|
2415
|
+
*
|
|
2321
2416
|
* @returns Reference to `this` in order to allow method chaining
|
|
2322
2417
|
*/
|
|
2323
2418
|
attachMarkChangesPress(
|
|
@@ -2344,6 +2439,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2344
2439
|
*
|
|
2345
2440
|
* The event is fired when the unsaved changes button is pressed
|
|
2346
2441
|
*
|
|
2442
|
+
*
|
|
2347
2443
|
* @returns Reference to `this` in order to allow method chaining
|
|
2348
2444
|
*/
|
|
2349
2445
|
attachMarkChangesPress(
|
|
@@ -2365,6 +2461,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2365
2461
|
*
|
|
2366
2462
|
* The event is fired when the Locked button is pressed
|
|
2367
2463
|
*
|
|
2464
|
+
*
|
|
2368
2465
|
* @returns Reference to `this` in order to allow method chaining
|
|
2369
2466
|
*/
|
|
2370
2467
|
attachMarkLockedPress(
|
|
@@ -2391,6 +2488,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2391
2488
|
*
|
|
2392
2489
|
* The event is fired when the Locked button is pressed
|
|
2393
2490
|
*
|
|
2491
|
+
*
|
|
2394
2492
|
* @returns Reference to `this` in order to allow method chaining
|
|
2395
2493
|
*/
|
|
2396
2494
|
attachMarkLockedPress(
|
|
@@ -2412,6 +2510,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2412
2510
|
*
|
|
2413
2511
|
* The event is fired when the objectPage header title selector (down-arrow) is pressed
|
|
2414
2512
|
*
|
|
2513
|
+
*
|
|
2415
2514
|
* @returns Reference to `this` in order to allow method chaining
|
|
2416
2515
|
*/
|
|
2417
2516
|
attachTitleSelectorPress(
|
|
@@ -2438,6 +2537,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2438
2537
|
*
|
|
2439
2538
|
* The event is fired when the objectPage header title selector (down-arrow) is pressed
|
|
2440
2539
|
*
|
|
2540
|
+
*
|
|
2441
2541
|
* @returns Reference to `this` in order to allow method chaining
|
|
2442
2542
|
*/
|
|
2443
2543
|
attachTitleSelectorPress(
|
|
@@ -2453,44 +2553,46 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2453
2553
|
/**
|
|
2454
2554
|
* Destroys all the actions in the aggregation {@link #getActions actions}.
|
|
2455
2555
|
*
|
|
2556
|
+
*
|
|
2456
2557
|
* @returns Reference to `this` in order to allow method chaining
|
|
2457
2558
|
*/
|
|
2458
2559
|
destroyActions(): this;
|
|
2459
2560
|
/**
|
|
2460
|
-
* @since 1.50
|
|
2461
|
-
*
|
|
2462
2561
|
* Destroys the breadcrumbs in the aggregation {@link #getBreadcrumbs breadcrumbs}.
|
|
2463
2562
|
*
|
|
2563
|
+
* @since 1.50
|
|
2564
|
+
*
|
|
2464
2565
|
* @returns Reference to `this` in order to allow method chaining
|
|
2465
2566
|
*/
|
|
2466
2567
|
destroyBreadcrumbs(): this;
|
|
2467
2568
|
/**
|
|
2468
|
-
* @deprecated (since 1.50) - use the `breadcrumbs` aggregation instead.
|
|
2469
|
-
*
|
|
2470
2569
|
* Destroys all the breadCrumbsLinks in the aggregation {@link #getBreadCrumbsLinks breadCrumbsLinks}.
|
|
2471
2570
|
*
|
|
2571
|
+
* @deprecated (since 1.50) - use the `breadcrumbs` aggregation instead.
|
|
2572
|
+
*
|
|
2472
2573
|
* @returns Reference to `this` in order to allow method chaining
|
|
2473
2574
|
*/
|
|
2474
2575
|
destroyBreadCrumbsLinks(): this;
|
|
2475
2576
|
/**
|
|
2476
2577
|
* Destroys the navigationBar in the aggregation {@link #getNavigationBar navigationBar}.
|
|
2477
2578
|
*
|
|
2579
|
+
*
|
|
2478
2580
|
* @returns Reference to `this` in order to allow method chaining
|
|
2479
2581
|
*/
|
|
2480
2582
|
destroyNavigationBar(): this;
|
|
2481
2583
|
/**
|
|
2482
|
-
* @since 1.38.0
|
|
2483
|
-
*
|
|
2484
2584
|
* Destroys the sideContentButton in the aggregation {@link #getSideContentButton sideContentButton}.
|
|
2485
2585
|
*
|
|
2586
|
+
* @since 1.38.0
|
|
2587
|
+
*
|
|
2486
2588
|
* @returns Reference to `this` in order to allow method chaining
|
|
2487
2589
|
*/
|
|
2488
2590
|
destroySideContentButton(): this;
|
|
2489
2591
|
/**
|
|
2490
|
-
* @since 1.56
|
|
2491
|
-
*
|
|
2492
2592
|
* Destroys the titleSelectorTooltip in the aggregation {@link #getTitleSelectorTooltip titleSelectorTooltip}.
|
|
2493
2593
|
*
|
|
2594
|
+
* @since 1.56
|
|
2595
|
+
*
|
|
2494
2596
|
* @returns Reference to `this` in order to allow method chaining
|
|
2495
2597
|
*/
|
|
2496
2598
|
destroyTitleSelectorTooltip(): this;
|
|
@@ -2500,6 +2602,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2500
2602
|
*
|
|
2501
2603
|
* The passed function and listener object must match the ones used for event registration.
|
|
2502
2604
|
*
|
|
2605
|
+
*
|
|
2503
2606
|
* @returns Reference to `this` in order to allow method chaining
|
|
2504
2607
|
*/
|
|
2505
2608
|
detachMarkChangesPress(
|
|
@@ -2518,6 +2621,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2518
2621
|
*
|
|
2519
2622
|
* The passed function and listener object must match the ones used for event registration.
|
|
2520
2623
|
*
|
|
2624
|
+
*
|
|
2521
2625
|
* @returns Reference to `this` in order to allow method chaining
|
|
2522
2626
|
*/
|
|
2523
2627
|
detachMarkLockedPress(
|
|
@@ -2536,6 +2640,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2536
2640
|
*
|
|
2537
2641
|
* The passed function and listener object must match the ones used for event registration.
|
|
2538
2642
|
*
|
|
2643
|
+
*
|
|
2539
2644
|
* @returns Reference to `this` in order to allow method chaining
|
|
2540
2645
|
*/
|
|
2541
2646
|
detachTitleSelectorPress(
|
|
@@ -2549,10 +2654,10 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2549
2654
|
oListener?: object
|
|
2550
2655
|
): this;
|
|
2551
2656
|
/**
|
|
2552
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
2553
|
-
*
|
|
2554
2657
|
* Fires event {@link #event:markChangesPress markChangesPress} to attached listeners.
|
|
2555
2658
|
*
|
|
2659
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
2660
|
+
*
|
|
2556
2661
|
* @returns Reference to `this` in order to allow method chaining
|
|
2557
2662
|
*/
|
|
2558
2663
|
fireMarkChangesPress(
|
|
@@ -2562,10 +2667,10 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2562
2667
|
mParameters?: ObjectPageHeader$MarkChangesPressEventParameters
|
|
2563
2668
|
): this;
|
|
2564
2669
|
/**
|
|
2565
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
2566
|
-
*
|
|
2567
2670
|
* Fires event {@link #event:markLockedPress markLockedPress} to attached listeners.
|
|
2568
2671
|
*
|
|
2672
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
2673
|
+
*
|
|
2569
2674
|
* @returns Reference to `this` in order to allow method chaining
|
|
2570
2675
|
*/
|
|
2571
2676
|
fireMarkLockedPress(
|
|
@@ -2575,10 +2680,10 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2575
2680
|
mParameters?: ObjectPageHeader$MarkLockedPressEventParameters
|
|
2576
2681
|
): this;
|
|
2577
2682
|
/**
|
|
2578
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
2579
|
-
*
|
|
2580
2683
|
* Fires event {@link #event:titleSelectorPress titleSelectorPress} to attached listeners.
|
|
2581
2684
|
*
|
|
2685
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
2686
|
+
*
|
|
2582
2687
|
* @returns Reference to `this` in order to allow method chaining
|
|
2583
2688
|
*/
|
|
2584
2689
|
fireTitleSelectorPress(
|
|
@@ -2600,25 +2705,23 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2600
2705
|
*/
|
|
2601
2706
|
getActions(): Control[];
|
|
2602
2707
|
/**
|
|
2603
|
-
* @since 1.50
|
|
2604
|
-
*
|
|
2605
2708
|
* Gets content of aggregation {@link #getBreadcrumbs breadcrumbs}.
|
|
2606
2709
|
*
|
|
2607
2710
|
* The breadcrumbs displayed in the `ObjectPageHeader`. If this aggregation is set, the `breadCrumbsLinks`
|
|
2608
2711
|
* aggregation is omitted.
|
|
2712
|
+
*
|
|
2713
|
+
* @since 1.50
|
|
2609
2714
|
*/
|
|
2610
2715
|
getBreadcrumbs(): Breadcrumbs;
|
|
2611
2716
|
/**
|
|
2612
|
-
* @deprecated (since 1.50) - use the `breadcrumbs` aggregation instead.
|
|
2613
|
-
*
|
|
2614
2717
|
* Gets content of aggregation {@link #getBreadCrumbsLinks breadCrumbsLinks}.
|
|
2615
2718
|
*
|
|
2616
2719
|
* A list of all the active link elements in the BreadCrumbs control.
|
|
2720
|
+
*
|
|
2721
|
+
* @deprecated (since 1.50) - use the `breadcrumbs` aggregation instead.
|
|
2617
2722
|
*/
|
|
2618
2723
|
getBreadCrumbsLinks(): Link[];
|
|
2619
2724
|
/**
|
|
2620
|
-
* @deprecated (since 1.40.1)
|
|
2621
|
-
*
|
|
2622
2725
|
* Gets current value of property {@link #getHeaderDesign headerDesign}.
|
|
2623
2726
|
*
|
|
2624
2727
|
* Determines the design of the header - Light or Dark. **Note: **This property is deprecated. It will continue
|
|
@@ -2626,6 +2729,8 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2626
2729
|
*
|
|
2627
2730
|
* Default value is `Light`.
|
|
2628
2731
|
*
|
|
2732
|
+
* @deprecated (since 1.40.1)
|
|
2733
|
+
*
|
|
2629
2734
|
* @returns Value of property `headerDesign`
|
|
2630
2735
|
*/
|
|
2631
2736
|
getHeaderDesign():
|
|
@@ -2638,6 +2743,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2638
2743
|
*
|
|
2639
2744
|
* Default value is `true`.
|
|
2640
2745
|
*
|
|
2746
|
+
*
|
|
2641
2747
|
* @returns Value of property `isActionAreaAlwaysVisible`
|
|
2642
2748
|
*/
|
|
2643
2749
|
getIsActionAreaAlwaysVisible(): boolean;
|
|
@@ -2648,6 +2754,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2648
2754
|
*
|
|
2649
2755
|
* Default value is `false`.
|
|
2650
2756
|
*
|
|
2757
|
+
*
|
|
2651
2758
|
* @returns Value of property `isObjectIconAlwaysVisible`
|
|
2652
2759
|
*/
|
|
2653
2760
|
getIsObjectIconAlwaysVisible(): boolean;
|
|
@@ -2658,6 +2765,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2658
2765
|
*
|
|
2659
2766
|
* Default value is `true`.
|
|
2660
2767
|
*
|
|
2768
|
+
*
|
|
2661
2769
|
* @returns Value of property `isObjectSubtitleAlwaysVisible`
|
|
2662
2770
|
*/
|
|
2663
2771
|
getIsObjectSubtitleAlwaysVisible(): boolean;
|
|
@@ -2668,12 +2776,11 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2668
2776
|
*
|
|
2669
2777
|
* Default value is `true`.
|
|
2670
2778
|
*
|
|
2779
|
+
*
|
|
2671
2780
|
* @returns Value of property `isObjectTitleAlwaysVisible`
|
|
2672
2781
|
*/
|
|
2673
2782
|
getIsObjectTitleAlwaysVisible(): boolean;
|
|
2674
2783
|
/**
|
|
2675
|
-
* @since 1.34.0
|
|
2676
|
-
*
|
|
2677
2784
|
* Gets current value of property {@link #getMarkChanges markChanges}.
|
|
2678
2785
|
*
|
|
2679
2786
|
* Marks that there are unsaved changes in the objectPageHeader. The markChanges state cannot be used together
|
|
@@ -2681,6 +2788,8 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2681
2788
|
*
|
|
2682
2789
|
* Default value is `false`.
|
|
2683
2790
|
*
|
|
2791
|
+
* @since 1.34.0
|
|
2792
|
+
*
|
|
2684
2793
|
* @returns Value of property `markChanges`
|
|
2685
2794
|
*/
|
|
2686
2795
|
getMarkChanges(): boolean;
|
|
@@ -2692,6 +2801,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2692
2801
|
*
|
|
2693
2802
|
* Default value is `false`.
|
|
2694
2803
|
*
|
|
2804
|
+
*
|
|
2695
2805
|
* @returns Value of property `markFavorite`
|
|
2696
2806
|
*/
|
|
2697
2807
|
getMarkFavorite(): boolean;
|
|
@@ -2703,6 +2813,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2703
2813
|
*
|
|
2704
2814
|
* Default value is `false`.
|
|
2705
2815
|
*
|
|
2816
|
+
*
|
|
2706
2817
|
* @returns Value of property `markFlagged`
|
|
2707
2818
|
*/
|
|
2708
2819
|
getMarkFlagged(): boolean;
|
|
@@ -2713,6 +2824,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2713
2824
|
*
|
|
2714
2825
|
* Default value is `false`.
|
|
2715
2826
|
*
|
|
2827
|
+
*
|
|
2716
2828
|
* @returns Value of property `markLocked`
|
|
2717
2829
|
*/
|
|
2718
2830
|
getMarkLocked(): boolean;
|
|
@@ -2729,18 +2841,19 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2729
2841
|
*
|
|
2730
2842
|
* Default value is `empty string`.
|
|
2731
2843
|
*
|
|
2844
|
+
*
|
|
2732
2845
|
* @returns Value of property `objectImageAlt`
|
|
2733
2846
|
*/
|
|
2734
2847
|
getObjectImageAlt(): string;
|
|
2735
2848
|
/**
|
|
2736
|
-
* @since 1.73
|
|
2737
|
-
*
|
|
2738
2849
|
* Gets current value of property {@link #getObjectImageBackgroundColor objectImageBackgroundColor}.
|
|
2739
2850
|
*
|
|
2740
2851
|
* Determines the background color of the image placeholder or icon if valid icon URI is provided.
|
|
2741
2852
|
*
|
|
2742
2853
|
* Default value is `Accent6`.
|
|
2743
2854
|
*
|
|
2855
|
+
* @since 1.73
|
|
2856
|
+
*
|
|
2744
2857
|
* @returns Value of property `objectImageBackgroundColor`
|
|
2745
2858
|
*/
|
|
2746
2859
|
getObjectImageBackgroundColor(): AvatarColor | keyof typeof AvatarColor;
|
|
@@ -2752,6 +2865,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2752
2865
|
*
|
|
2753
2866
|
* Default value is `false`.
|
|
2754
2867
|
*
|
|
2868
|
+
*
|
|
2755
2869
|
* @returns Value of property `objectImageDensityAware`
|
|
2756
2870
|
*/
|
|
2757
2871
|
getObjectImageDensityAware(): boolean;
|
|
@@ -2762,6 +2876,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2762
2876
|
*
|
|
2763
2877
|
* Default value is `Square`.
|
|
2764
2878
|
*
|
|
2879
|
+
*
|
|
2765
2880
|
* @returns Value of property `objectImageShape`
|
|
2766
2881
|
*/
|
|
2767
2882
|
getObjectImageShape(): AvatarShape | keyof typeof AvatarShape;
|
|
@@ -2770,6 +2885,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2770
2885
|
*
|
|
2771
2886
|
* The URL of the image, representing the business object
|
|
2772
2887
|
*
|
|
2888
|
+
*
|
|
2773
2889
|
* @returns Value of property `objectImageURI`
|
|
2774
2890
|
*/
|
|
2775
2891
|
getObjectImageURI(): string;
|
|
@@ -2778,6 +2894,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2778
2894
|
*
|
|
2779
2895
|
* The description of the object
|
|
2780
2896
|
*
|
|
2897
|
+
*
|
|
2781
2898
|
* @returns Value of property `objectSubtitle`
|
|
2782
2899
|
*/
|
|
2783
2900
|
getObjectSubtitle(): string;
|
|
@@ -2786,6 +2903,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2786
2903
|
*
|
|
2787
2904
|
* The title of the object
|
|
2788
2905
|
*
|
|
2906
|
+
*
|
|
2789
2907
|
* @returns Value of property `objectTitle`
|
|
2790
2908
|
*/
|
|
2791
2909
|
getObjectTitle(): string;
|
|
@@ -2796,6 +2914,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2796
2914
|
*
|
|
2797
2915
|
* Default value is `false`.
|
|
2798
2916
|
*
|
|
2917
|
+
*
|
|
2799
2918
|
* @returns Value of property `showMarkers`
|
|
2800
2919
|
*/
|
|
2801
2920
|
getShowMarkers(): boolean;
|
|
@@ -2807,6 +2926,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2807
2926
|
*
|
|
2808
2927
|
* Default value is `false`.
|
|
2809
2928
|
*
|
|
2929
|
+
*
|
|
2810
2930
|
* @returns Value of property `showPlaceholder`
|
|
2811
2931
|
*/
|
|
2812
2932
|
getShowPlaceholder(): boolean;
|
|
@@ -2817,20 +2937,19 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2817
2937
|
*
|
|
2818
2938
|
* Default value is `false`.
|
|
2819
2939
|
*
|
|
2940
|
+
*
|
|
2820
2941
|
* @returns Value of property `showTitleSelector`
|
|
2821
2942
|
*/
|
|
2822
2943
|
getShowTitleSelector(): boolean;
|
|
2823
2944
|
/**
|
|
2824
|
-
* @since 1.38.0
|
|
2825
|
-
*
|
|
2826
2945
|
* Gets content of aggregation {@link #getSideContentButton sideContentButton}.
|
|
2827
2946
|
*
|
|
2828
2947
|
* A button that is used for opening the side content of the page or some additional content.
|
|
2948
|
+
*
|
|
2949
|
+
* @since 1.38.0
|
|
2829
2950
|
*/
|
|
2830
2951
|
getSideContentButton(): Button;
|
|
2831
2952
|
/**
|
|
2832
|
-
* @since 1.56
|
|
2833
|
-
*
|
|
2834
2953
|
* Gets content of aggregation {@link #getTitleSelectorTooltip titleSelectorTooltip}.
|
|
2835
2954
|
*
|
|
2836
2955
|
* A custom tooltip for the title selector button.
|
|
@@ -2839,12 +2958,15 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2839
2958
|
*
|
|
2840
2959
|
* **Note:** If the aggregation is destroyed or set to invalid value, the default tooltip will be set. The
|
|
2841
2960
|
* default tooltip text is "Related options".
|
|
2961
|
+
*
|
|
2962
|
+
* @since 1.56
|
|
2842
2963
|
*/
|
|
2843
2964
|
getTitleSelectorTooltip(): TooltipBase | string;
|
|
2844
2965
|
/**
|
|
2845
2966
|
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getActions actions}. and returns
|
|
2846
2967
|
* its index if found or -1 otherwise.
|
|
2847
2968
|
*
|
|
2969
|
+
*
|
|
2848
2970
|
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
2849
2971
|
*/
|
|
2850
2972
|
indexOfAction(
|
|
@@ -2854,11 +2976,11 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2854
2976
|
oAction: Control
|
|
2855
2977
|
): int;
|
|
2856
2978
|
/**
|
|
2857
|
-
* @deprecated (since 1.50) - use the `breadcrumbs` aggregation instead.
|
|
2858
|
-
*
|
|
2859
2979
|
* Checks for the provided `sap.m.Link` in the aggregation {@link #getBreadCrumbsLinks breadCrumbsLinks}.
|
|
2860
2980
|
* and returns its index if found or -1 otherwise.
|
|
2861
2981
|
*
|
|
2982
|
+
* @deprecated (since 1.50) - use the `breadcrumbs` aggregation instead.
|
|
2983
|
+
*
|
|
2862
2984
|
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
2863
2985
|
*/
|
|
2864
2986
|
indexOfBreadCrumbLink(
|
|
@@ -2870,6 +2992,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2870
2992
|
/**
|
|
2871
2993
|
* Inserts a action into the aggregation {@link #getActions actions}.
|
|
2872
2994
|
*
|
|
2995
|
+
*
|
|
2873
2996
|
* @returns Reference to `this` in order to allow method chaining
|
|
2874
2997
|
*/
|
|
2875
2998
|
insertAction(
|
|
@@ -2885,10 +3008,10 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2885
3008
|
iIndex: int
|
|
2886
3009
|
): this;
|
|
2887
3010
|
/**
|
|
2888
|
-
* @deprecated (since 1.50) - use the `breadcrumbs` aggregation instead.
|
|
2889
|
-
*
|
|
2890
3011
|
* Inserts a breadCrumbLink into the aggregation {@link #getBreadCrumbsLinks breadCrumbsLinks}.
|
|
2891
3012
|
*
|
|
3013
|
+
* @deprecated (since 1.50) - use the `breadcrumbs` aggregation instead.
|
|
3014
|
+
*
|
|
2892
3015
|
* @returns Reference to `this` in order to allow method chaining
|
|
2893
3016
|
*/
|
|
2894
3017
|
insertBreadCrumbLink(
|
|
@@ -2906,6 +3029,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2906
3029
|
/**
|
|
2907
3030
|
* Removes a action from the aggregation {@link #getActions actions}.
|
|
2908
3031
|
*
|
|
3032
|
+
*
|
|
2909
3033
|
* @returns The removed action or `null`
|
|
2910
3034
|
*/
|
|
2911
3035
|
removeAction(
|
|
@@ -2919,24 +3043,25 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2919
3043
|
*
|
|
2920
3044
|
* Additionally, it unregisters them from the hosting UIArea.
|
|
2921
3045
|
*
|
|
3046
|
+
*
|
|
2922
3047
|
* @returns An array of the removed elements (might be empty)
|
|
2923
3048
|
*/
|
|
2924
3049
|
removeAllActions(): Control[];
|
|
2925
3050
|
/**
|
|
2926
|
-
* @deprecated (since 1.50) - use the `breadcrumbs` aggregation instead.
|
|
2927
|
-
*
|
|
2928
3051
|
* Removes all the controls from the aggregation {@link #getBreadCrumbsLinks breadCrumbsLinks}.
|
|
2929
3052
|
*
|
|
2930
3053
|
* Additionally, it unregisters them from the hosting UIArea.
|
|
2931
3054
|
*
|
|
3055
|
+
* @deprecated (since 1.50) - use the `breadcrumbs` aggregation instead.
|
|
3056
|
+
*
|
|
2932
3057
|
* @returns An array of the removed elements (might be empty)
|
|
2933
3058
|
*/
|
|
2934
3059
|
removeAllBreadCrumbsLinks(): Link[];
|
|
2935
3060
|
/**
|
|
2936
|
-
* @deprecated (since 1.50) - use the `breadcrumbs` aggregation instead.
|
|
2937
|
-
*
|
|
2938
3061
|
* Removes a breadCrumbLink from the aggregation {@link #getBreadCrumbsLinks breadCrumbsLinks}.
|
|
2939
3062
|
*
|
|
3063
|
+
* @deprecated (since 1.50) - use the `breadcrumbs` aggregation instead.
|
|
3064
|
+
*
|
|
2940
3065
|
* @returns The removed breadCrumbLink or `null`
|
|
2941
3066
|
*/
|
|
2942
3067
|
removeBreadCrumbLink(
|
|
@@ -2946,10 +3071,10 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2946
3071
|
vBreadCrumbLink: int | string | Link
|
|
2947
3072
|
): Link | null;
|
|
2948
3073
|
/**
|
|
2949
|
-
* @since 1.50
|
|
2950
|
-
*
|
|
2951
3074
|
* Sets the aggregated {@link #getBreadcrumbs breadcrumbs}.
|
|
2952
3075
|
*
|
|
3076
|
+
* @since 1.50
|
|
3077
|
+
*
|
|
2953
3078
|
* @returns Reference to `this` in order to allow method chaining
|
|
2954
3079
|
*/
|
|
2955
3080
|
setBreadcrumbs(
|
|
@@ -2967,6 +3092,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2967
3092
|
*
|
|
2968
3093
|
* Default value is `true`.
|
|
2969
3094
|
*
|
|
3095
|
+
*
|
|
2970
3096
|
* @returns Reference to `this` in order to allow method chaining
|
|
2971
3097
|
*/
|
|
2972
3098
|
setIsActionAreaAlwaysVisible(
|
|
@@ -2984,6 +3110,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
2984
3110
|
*
|
|
2985
3111
|
* Default value is `false`.
|
|
2986
3112
|
*
|
|
3113
|
+
*
|
|
2987
3114
|
* @returns Reference to `this` in order to allow method chaining
|
|
2988
3115
|
*/
|
|
2989
3116
|
setIsObjectIconAlwaysVisible(
|
|
@@ -3001,6 +3128,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
3001
3128
|
*
|
|
3002
3129
|
* Default value is `true`.
|
|
3003
3130
|
*
|
|
3131
|
+
*
|
|
3004
3132
|
* @returns Reference to `this` in order to allow method chaining
|
|
3005
3133
|
*/
|
|
3006
3134
|
setIsObjectSubtitleAlwaysVisible(
|
|
@@ -3018,6 +3146,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
3018
3146
|
*
|
|
3019
3147
|
* Default value is `true`.
|
|
3020
3148
|
*
|
|
3149
|
+
*
|
|
3021
3150
|
* @returns Reference to `this` in order to allow method chaining
|
|
3022
3151
|
*/
|
|
3023
3152
|
setIsObjectTitleAlwaysVisible(
|
|
@@ -3027,8 +3156,6 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
3027
3156
|
bIsObjectTitleAlwaysVisible?: boolean
|
|
3028
3157
|
): this;
|
|
3029
3158
|
/**
|
|
3030
|
-
* @since 1.34.0
|
|
3031
|
-
*
|
|
3032
3159
|
* Sets a new value for property {@link #getMarkChanges markChanges}.
|
|
3033
3160
|
*
|
|
3034
3161
|
* Marks that there are unsaved changes in the objectPageHeader. The markChanges state cannot be used together
|
|
@@ -3038,6 +3165,8 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
3038
3165
|
*
|
|
3039
3166
|
* Default value is `false`.
|
|
3040
3167
|
*
|
|
3168
|
+
* @since 1.34.0
|
|
3169
|
+
*
|
|
3041
3170
|
* @returns Reference to `this` in order to allow method chaining
|
|
3042
3171
|
*/
|
|
3043
3172
|
setMarkChanges(
|
|
@@ -3056,6 +3185,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
3056
3185
|
*
|
|
3057
3186
|
* Default value is `false`.
|
|
3058
3187
|
*
|
|
3188
|
+
*
|
|
3059
3189
|
* @returns Reference to `this` in order to allow method chaining
|
|
3060
3190
|
*/
|
|
3061
3191
|
setMarkFavorite(
|
|
@@ -3074,6 +3204,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
3074
3204
|
*
|
|
3075
3205
|
* Default value is `false`.
|
|
3076
3206
|
*
|
|
3207
|
+
*
|
|
3077
3208
|
* @returns Reference to `this` in order to allow method chaining
|
|
3078
3209
|
*/
|
|
3079
3210
|
setMarkFlagged(
|
|
@@ -3091,6 +3222,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
3091
3222
|
*
|
|
3092
3223
|
* Default value is `false`.
|
|
3093
3224
|
*
|
|
3225
|
+
*
|
|
3094
3226
|
* @returns Reference to `this` in order to allow method chaining
|
|
3095
3227
|
*/
|
|
3096
3228
|
setMarkLocked(
|
|
@@ -3102,6 +3234,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
3102
3234
|
/**
|
|
3103
3235
|
* Sets the aggregated {@link #getNavigationBar navigationBar}.
|
|
3104
3236
|
*
|
|
3237
|
+
*
|
|
3105
3238
|
* @returns Reference to `this` in order to allow method chaining
|
|
3106
3239
|
*/
|
|
3107
3240
|
setNavigationBar(
|
|
@@ -3119,6 +3252,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
3119
3252
|
*
|
|
3120
3253
|
* Default value is `empty string`.
|
|
3121
3254
|
*
|
|
3255
|
+
*
|
|
3122
3256
|
* @returns Reference to `this` in order to allow method chaining
|
|
3123
3257
|
*/
|
|
3124
3258
|
setObjectImageAlt(
|
|
@@ -3128,8 +3262,6 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
3128
3262
|
sObjectImageAlt?: string
|
|
3129
3263
|
): this;
|
|
3130
3264
|
/**
|
|
3131
|
-
* @since 1.73
|
|
3132
|
-
*
|
|
3133
3265
|
* Sets a new value for property {@link #getObjectImageBackgroundColor objectImageBackgroundColor}.
|
|
3134
3266
|
*
|
|
3135
3267
|
* Determines the background color of the image placeholder or icon if valid icon URI is provided.
|
|
@@ -3138,6 +3270,8 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
3138
3270
|
*
|
|
3139
3271
|
* Default value is `Accent6`.
|
|
3140
3272
|
*
|
|
3273
|
+
* @since 1.73
|
|
3274
|
+
*
|
|
3141
3275
|
* @returns Reference to `this` in order to allow method chaining
|
|
3142
3276
|
*/
|
|
3143
3277
|
setObjectImageBackgroundColor(
|
|
@@ -3156,6 +3290,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
3156
3290
|
*
|
|
3157
3291
|
* Default value is `false`.
|
|
3158
3292
|
*
|
|
3293
|
+
*
|
|
3159
3294
|
* @returns Reference to `this` in order to allow method chaining
|
|
3160
3295
|
*/
|
|
3161
3296
|
setObjectImageDensityAware(
|
|
@@ -3173,6 +3308,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
3173
3308
|
*
|
|
3174
3309
|
* Default value is `Square`.
|
|
3175
3310
|
*
|
|
3311
|
+
*
|
|
3176
3312
|
* @returns Reference to `this` in order to allow method chaining
|
|
3177
3313
|
*/
|
|
3178
3314
|
setObjectImageShape(
|
|
@@ -3188,6 +3324,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
3188
3324
|
*
|
|
3189
3325
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3190
3326
|
*
|
|
3327
|
+
*
|
|
3191
3328
|
* @returns Reference to `this` in order to allow method chaining
|
|
3192
3329
|
*/
|
|
3193
3330
|
setObjectImageURI(
|
|
@@ -3203,6 +3340,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
3203
3340
|
*
|
|
3204
3341
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3205
3342
|
*
|
|
3343
|
+
*
|
|
3206
3344
|
* @returns Reference to `this` in order to allow method chaining
|
|
3207
3345
|
*/
|
|
3208
3346
|
setObjectSubtitle(
|
|
@@ -3218,6 +3356,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
3218
3356
|
*
|
|
3219
3357
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3220
3358
|
*
|
|
3359
|
+
*
|
|
3221
3360
|
* @returns Reference to `this` in order to allow method chaining
|
|
3222
3361
|
*/
|
|
3223
3362
|
setObjectTitle(
|
|
@@ -3235,6 +3374,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
3235
3374
|
*
|
|
3236
3375
|
* Default value is `false`.
|
|
3237
3376
|
*
|
|
3377
|
+
*
|
|
3238
3378
|
* @returns Reference to `this` in order to allow method chaining
|
|
3239
3379
|
*/
|
|
3240
3380
|
setShowMarkers(
|
|
@@ -3253,6 +3393,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
3253
3393
|
*
|
|
3254
3394
|
* Default value is `false`.
|
|
3255
3395
|
*
|
|
3396
|
+
*
|
|
3256
3397
|
* @returns Reference to `this` in order to allow method chaining
|
|
3257
3398
|
*/
|
|
3258
3399
|
setShowPlaceholder(
|
|
@@ -3270,6 +3411,7 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
3270
3411
|
*
|
|
3271
3412
|
* Default value is `false`.
|
|
3272
3413
|
*
|
|
3414
|
+
*
|
|
3273
3415
|
* @returns Reference to `this` in order to allow method chaining
|
|
3274
3416
|
*/
|
|
3275
3417
|
setShowTitleSelector(
|
|
@@ -3279,10 +3421,10 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
3279
3421
|
bShowTitleSelector?: boolean
|
|
3280
3422
|
): this;
|
|
3281
3423
|
/**
|
|
3282
|
-
* @since 1.38.0
|
|
3283
|
-
*
|
|
3284
3424
|
* Sets the aggregated {@link #getSideContentButton sideContentButton}.
|
|
3285
3425
|
*
|
|
3426
|
+
* @since 1.38.0
|
|
3427
|
+
*
|
|
3286
3428
|
* @returns Reference to `this` in order to allow method chaining
|
|
3287
3429
|
*/
|
|
3288
3430
|
setSideContentButton(
|
|
@@ -3292,10 +3434,10 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
3292
3434
|
oSideContentButton: Button
|
|
3293
3435
|
): this;
|
|
3294
3436
|
/**
|
|
3295
|
-
* @since 1.56
|
|
3296
|
-
*
|
|
3297
3437
|
* Sets the aggregated {@link #getTitleSelectorTooltip titleSelectorTooltip}.
|
|
3298
3438
|
*
|
|
3439
|
+
* @since 1.56
|
|
3440
|
+
*
|
|
3299
3441
|
* @returns Reference to `this` in order to allow method chaining
|
|
3300
3442
|
*/
|
|
3301
3443
|
setTitleSelectorTooltip(
|
|
@@ -3342,9 +3484,9 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
3342
3484
|
| `{${string}}`;
|
|
3343
3485
|
|
|
3344
3486
|
/**
|
|
3345
|
-
* @since 1.73
|
|
3346
|
-
*
|
|
3347
3487
|
* Determines the background color of the image placeholder or icon if valid icon URI is provided.
|
|
3488
|
+
*
|
|
3489
|
+
* @since 1.73
|
|
3348
3490
|
*/
|
|
3349
3491
|
objectImageBackgroundColor?:
|
|
3350
3492
|
| (AvatarColor | keyof typeof AvatarColor)
|
|
@@ -3375,10 +3517,10 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
3375
3517
|
isActionAreaAlwaysVisible?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
3376
3518
|
|
|
3377
3519
|
/**
|
|
3378
|
-
* @deprecated (since 1.40.1)
|
|
3379
|
-
*
|
|
3380
3520
|
* Determines the design of the header - Light or Dark. **Note: **This property is deprecated. It will continue
|
|
3381
3521
|
* to work in the Blue Crystal theme, but it will not be taken into account for the Belize themes.
|
|
3522
|
+
*
|
|
3523
|
+
* @deprecated (since 1.40.1)
|
|
3382
3524
|
*/
|
|
3383
3525
|
headerDesign?:
|
|
3384
3526
|
| (ObjectPageHeaderDesign | keyof typeof ObjectPageHeaderDesign)
|
|
@@ -3419,25 +3561,25 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
3419
3561
|
showPlaceholder?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
3420
3562
|
|
|
3421
3563
|
/**
|
|
3422
|
-
* @since 1.34.0
|
|
3423
|
-
*
|
|
3424
3564
|
* Marks that there are unsaved changes in the objectPageHeader. The markChanges state cannot be used together
|
|
3425
3565
|
* with the markLocked state. If both are set to true, only the locked state will be displayed.
|
|
3566
|
+
*
|
|
3567
|
+
* @since 1.34.0
|
|
3426
3568
|
*/
|
|
3427
3569
|
markChanges?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
3428
3570
|
|
|
3429
3571
|
/**
|
|
3430
|
-
* @since 1.50
|
|
3431
|
-
*
|
|
3432
3572
|
* The breadcrumbs displayed in the `ObjectPageHeader`. If this aggregation is set, the `breadCrumbsLinks`
|
|
3433
3573
|
* aggregation is omitted.
|
|
3574
|
+
*
|
|
3575
|
+
* @since 1.50
|
|
3434
3576
|
*/
|
|
3435
3577
|
breadcrumbs?: Breadcrumbs;
|
|
3436
3578
|
|
|
3437
3579
|
/**
|
|
3438
|
-
* @deprecated (since 1.50) - use the `breadcrumbs` aggregation instead.
|
|
3439
|
-
*
|
|
3440
3580
|
* A list of all the active link elements in the BreadCrumbs control.
|
|
3581
|
+
*
|
|
3582
|
+
* @deprecated (since 1.50) - use the `breadcrumbs` aggregation instead.
|
|
3441
3583
|
*/
|
|
3442
3584
|
breadCrumbsLinks?: Link[] | Link | AggregationBindingInfo | `{${string}}`;
|
|
3443
3585
|
|
|
@@ -3458,21 +3600,21 @@ declare module "sap/uxap/ObjectPageHeader" {
|
|
|
3458
3600
|
actions?: Control[] | Control | AggregationBindingInfo | `{${string}}`;
|
|
3459
3601
|
|
|
3460
3602
|
/**
|
|
3461
|
-
* @since 1.38.0
|
|
3462
|
-
*
|
|
3463
3603
|
* A button that is used for opening the side content of the page or some additional content.
|
|
3604
|
+
*
|
|
3605
|
+
* @since 1.38.0
|
|
3464
3606
|
*/
|
|
3465
3607
|
sideContentButton?: Button;
|
|
3466
3608
|
|
|
3467
3609
|
/**
|
|
3468
|
-
* @since 1.56
|
|
3469
|
-
*
|
|
3470
3610
|
* A custom tooltip for the title selector button.
|
|
3471
3611
|
*
|
|
3472
3612
|
* The custom tooltip will be visible if the `showTitleSelector` property is set to `true`.
|
|
3473
3613
|
*
|
|
3474
3614
|
* **Note:** If the aggregation is destroyed or set to invalid value, the default tooltip will be set. The
|
|
3475
3615
|
* default tooltip text is "Related options".
|
|
3616
|
+
*
|
|
3617
|
+
* @since 1.56
|
|
3476
3618
|
*/
|
|
3477
3619
|
titleSelectorTooltip?: string | TooltipBase | PropertyBindingInfo;
|
|
3478
3620
|
|
|
@@ -3543,12 +3685,12 @@ declare module "sap/uxap/ObjectPageHeaderActionButton" {
|
|
|
3543
3685
|
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
3544
3686
|
|
|
3545
3687
|
/**
|
|
3546
|
-
* @since 1.26
|
|
3547
|
-
*
|
|
3548
3688
|
* A Button that is used in the `actions` aggregation of the {@link sap.uxap.ObjectPageHeader}.
|
|
3549
3689
|
*
|
|
3550
3690
|
* The button is designed to be used with {@link sap.uxap.ObjectPageHeader} and any usage outside the intended
|
|
3551
3691
|
* context is not recommended.
|
|
3692
|
+
*
|
|
3693
|
+
* @since 1.26
|
|
3552
3694
|
*/
|
|
3553
3695
|
export default class ObjectPageHeaderActionButton
|
|
3554
3696
|
extends Button
|
|
@@ -3591,6 +3733,7 @@ declare module "sap/uxap/ObjectPageHeaderActionButton" {
|
|
|
3591
3733
|
*
|
|
3592
3734
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.m.Button.extend}.
|
|
3593
3735
|
*
|
|
3736
|
+
*
|
|
3594
3737
|
* @returns Created class / constructor function
|
|
3595
3738
|
*/
|
|
3596
3739
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -3611,6 +3754,7 @@ declare module "sap/uxap/ObjectPageHeaderActionButton" {
|
|
|
3611
3754
|
/**
|
|
3612
3755
|
* Returns a metadata object for class sap.uxap.ObjectPageHeaderActionButton.
|
|
3613
3756
|
*
|
|
3757
|
+
*
|
|
3614
3758
|
* @returns Metadata object describing this class
|
|
3615
3759
|
*/
|
|
3616
3760
|
static getMetadata(): ElementMetadata;
|
|
@@ -3623,6 +3767,7 @@ declare module "sap/uxap/ObjectPageHeaderActionButton" {
|
|
|
3623
3767
|
*
|
|
3624
3768
|
* Default value is `false`.
|
|
3625
3769
|
*
|
|
3770
|
+
*
|
|
3626
3771
|
* @returns Value of property `hideIcon`
|
|
3627
3772
|
*/
|
|
3628
3773
|
getHideIcon(): boolean;
|
|
@@ -3635,18 +3780,19 @@ declare module "sap/uxap/ObjectPageHeaderActionButton" {
|
|
|
3635
3780
|
*
|
|
3636
3781
|
* Default value is `true`.
|
|
3637
3782
|
*
|
|
3783
|
+
*
|
|
3638
3784
|
* @returns Value of property `hideText`
|
|
3639
3785
|
*/
|
|
3640
3786
|
getHideText(): boolean;
|
|
3641
3787
|
/**
|
|
3642
|
-
* @since 1.34.0
|
|
3643
|
-
*
|
|
3644
3788
|
* Gets current value of property {@link #getImportance importance}.
|
|
3645
3789
|
*
|
|
3646
3790
|
* Determines the order in which the button overflows.
|
|
3647
3791
|
*
|
|
3648
3792
|
* Default value is `High`.
|
|
3649
3793
|
*
|
|
3794
|
+
* @since 1.34.0
|
|
3795
|
+
*
|
|
3650
3796
|
* @returns Value of property `importance`
|
|
3651
3797
|
*/
|
|
3652
3798
|
getImportance(): Importance | keyof typeof Importance;
|
|
@@ -3661,6 +3807,7 @@ declare module "sap/uxap/ObjectPageHeaderActionButton" {
|
|
|
3661
3807
|
*
|
|
3662
3808
|
* Default value is `false`.
|
|
3663
3809
|
*
|
|
3810
|
+
*
|
|
3664
3811
|
* @returns Reference to `this` in order to allow method chaining
|
|
3665
3812
|
*/
|
|
3666
3813
|
setHideIcon(
|
|
@@ -3680,6 +3827,7 @@ declare module "sap/uxap/ObjectPageHeaderActionButton" {
|
|
|
3680
3827
|
*
|
|
3681
3828
|
* Default value is `true`.
|
|
3682
3829
|
*
|
|
3830
|
+
*
|
|
3683
3831
|
* @returns Reference to `this` in order to allow method chaining
|
|
3684
3832
|
*/
|
|
3685
3833
|
setHideText(
|
|
@@ -3689,8 +3837,6 @@ declare module "sap/uxap/ObjectPageHeaderActionButton" {
|
|
|
3689
3837
|
bHideText?: boolean
|
|
3690
3838
|
): this;
|
|
3691
3839
|
/**
|
|
3692
|
-
* @since 1.34.0
|
|
3693
|
-
*
|
|
3694
3840
|
* Sets a new value for property {@link #getImportance importance}.
|
|
3695
3841
|
*
|
|
3696
3842
|
* Determines the order in which the button overflows.
|
|
@@ -3699,6 +3845,8 @@ declare module "sap/uxap/ObjectPageHeaderActionButton" {
|
|
|
3699
3845
|
*
|
|
3700
3846
|
* Default value is `High`.
|
|
3701
3847
|
*
|
|
3848
|
+
* @since 1.34.0
|
|
3849
|
+
*
|
|
3702
3850
|
* @returns Reference to `this` in order to allow method chaining
|
|
3703
3851
|
*/
|
|
3704
3852
|
setImportance(
|
|
@@ -3726,9 +3874,9 @@ declare module "sap/uxap/ObjectPageHeaderActionButton" {
|
|
|
3726
3874
|
hideIcon?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
3727
3875
|
|
|
3728
3876
|
/**
|
|
3729
|
-
* @since 1.34.0
|
|
3730
|
-
*
|
|
3731
3877
|
* Determines the order in which the button overflows.
|
|
3878
|
+
*
|
|
3879
|
+
* @since 1.34.0
|
|
3732
3880
|
*/
|
|
3733
3881
|
importance?:
|
|
3734
3882
|
| (Importance | keyof typeof Importance)
|
|
@@ -3750,8 +3898,6 @@ declare module "sap/uxap/ObjectPageHeaderContent" {
|
|
|
3750
3898
|
} from "sap/ui/base/ManagedObject";
|
|
3751
3899
|
|
|
3752
3900
|
/**
|
|
3753
|
-
* @since 1.30
|
|
3754
|
-
*
|
|
3755
3901
|
* Header content for the classic header of the {@link sap.uxap.ObjectPageLayout}.
|
|
3756
3902
|
*
|
|
3757
3903
|
* Overview:
|
|
@@ -3765,6 +3911,8 @@ declare module "sap/uxap/ObjectPageHeaderContent" {
|
|
|
3765
3911
|
* - {@link https://ui5.sap.com/#/topic/d2ef0099542d44dc868719d908e576d0 Object Page Headers}
|
|
3766
3912
|
* - {@link https://ui5.sap.com/#/topic/0fecbce45e39406aa939bd25e89823f4 Object Page Classic Header}
|
|
3767
3913
|
* - {@link https://experience.sap.com/fiori-design-web/object-page/ UX Guidelines: Object Page}
|
|
3914
|
+
*
|
|
3915
|
+
* @since 1.30
|
|
3768
3916
|
*/
|
|
3769
3917
|
export default class ObjectPageHeaderContent
|
|
3770
3918
|
extends Control
|
|
@@ -3811,6 +3959,7 @@ declare module "sap/uxap/ObjectPageHeaderContent" {
|
|
|
3811
3959
|
*
|
|
3812
3960
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
|
|
3813
3961
|
*
|
|
3962
|
+
*
|
|
3814
3963
|
* @returns Created class / constructor function
|
|
3815
3964
|
*/
|
|
3816
3965
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -3831,12 +3980,14 @@ declare module "sap/uxap/ObjectPageHeaderContent" {
|
|
|
3831
3980
|
/**
|
|
3832
3981
|
* Returns a metadata object for class sap.uxap.ObjectPageHeaderContent.
|
|
3833
3982
|
*
|
|
3983
|
+
*
|
|
3834
3984
|
* @returns Metadata object describing this class
|
|
3835
3985
|
*/
|
|
3836
3986
|
static getMetadata(): ElementMetadata;
|
|
3837
3987
|
/**
|
|
3838
3988
|
* Adds some content to the aggregation {@link #getContent content}.
|
|
3839
3989
|
*
|
|
3990
|
+
*
|
|
3840
3991
|
* @returns Reference to `this` in order to allow method chaining
|
|
3841
3992
|
*/
|
|
3842
3993
|
addContent(
|
|
@@ -3848,6 +3999,7 @@ declare module "sap/uxap/ObjectPageHeaderContent" {
|
|
|
3848
3999
|
/**
|
|
3849
4000
|
* Destroys all the content in the aggregation {@link #getContent content}.
|
|
3850
4001
|
*
|
|
4002
|
+
*
|
|
3851
4003
|
* @returns Reference to `this` in order to allow method chaining
|
|
3852
4004
|
*/
|
|
3853
4005
|
destroyContent(): this;
|
|
@@ -3858,8 +4010,6 @@ declare module "sap/uxap/ObjectPageHeaderContent" {
|
|
|
3858
4010
|
*/
|
|
3859
4011
|
getContent(): Control[];
|
|
3860
4012
|
/**
|
|
3861
|
-
* @deprecated (since 1.40.1)
|
|
3862
|
-
*
|
|
3863
4013
|
* Gets current value of property {@link #getContentDesign contentDesign}.
|
|
3864
4014
|
*
|
|
3865
4015
|
* Determines the design of the header - Light or Dark. **Note: **This property is deprecated. It will continue
|
|
@@ -3867,6 +4017,8 @@ declare module "sap/uxap/ObjectPageHeaderContent" {
|
|
|
3867
4017
|
*
|
|
3868
4018
|
* Default value is `Light`.
|
|
3869
4019
|
*
|
|
4020
|
+
* @deprecated (since 1.40.1)
|
|
4021
|
+
*
|
|
3870
4022
|
* @returns Value of property `contentDesign`
|
|
3871
4023
|
*/
|
|
3872
4024
|
getContentDesign():
|
|
@@ -3876,6 +4028,7 @@ declare module "sap/uxap/ObjectPageHeaderContent" {
|
|
|
3876
4028
|
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getContent content}. and returns
|
|
3877
4029
|
* its index if found or -1 otherwise.
|
|
3878
4030
|
*
|
|
4031
|
+
*
|
|
3879
4032
|
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
3880
4033
|
*/
|
|
3881
4034
|
indexOfContent(
|
|
@@ -3887,6 +4040,7 @@ declare module "sap/uxap/ObjectPageHeaderContent" {
|
|
|
3887
4040
|
/**
|
|
3888
4041
|
* Inserts a content into the aggregation {@link #getContent content}.
|
|
3889
4042
|
*
|
|
4043
|
+
*
|
|
3890
4044
|
* @returns Reference to `this` in order to allow method chaining
|
|
3891
4045
|
*/
|
|
3892
4046
|
insertContent(
|
|
@@ -3906,12 +4060,14 @@ declare module "sap/uxap/ObjectPageHeaderContent" {
|
|
|
3906
4060
|
*
|
|
3907
4061
|
* Additionally, it unregisters them from the hosting UIArea.
|
|
3908
4062
|
*
|
|
4063
|
+
*
|
|
3909
4064
|
* @returns An array of the removed elements (might be empty)
|
|
3910
4065
|
*/
|
|
3911
4066
|
removeAllContent(): Control[];
|
|
3912
4067
|
/**
|
|
3913
4068
|
* Removes a content from the aggregation {@link #getContent content}.
|
|
3914
4069
|
*
|
|
4070
|
+
*
|
|
3915
4071
|
* @returns The removed content or `null`
|
|
3916
4072
|
*/
|
|
3917
4073
|
removeContent(
|
|
@@ -3921,8 +4077,6 @@ declare module "sap/uxap/ObjectPageHeaderContent" {
|
|
|
3921
4077
|
vContent: int | string | Control
|
|
3922
4078
|
): Control | null;
|
|
3923
4079
|
/**
|
|
3924
|
-
* @deprecated (since 1.40.1)
|
|
3925
|
-
*
|
|
3926
4080
|
* Sets a new value for property {@link #getContentDesign contentDesign}.
|
|
3927
4081
|
*
|
|
3928
4082
|
* Determines the design of the header - Light or Dark. **Note: **This property is deprecated. It will continue
|
|
@@ -3932,6 +4086,8 @@ declare module "sap/uxap/ObjectPageHeaderContent" {
|
|
|
3932
4086
|
*
|
|
3933
4087
|
* Default value is `Light`.
|
|
3934
4088
|
*
|
|
4089
|
+
* @deprecated (since 1.40.1)
|
|
4090
|
+
*
|
|
3935
4091
|
* @returns Reference to `this` in order to allow method chaining
|
|
3936
4092
|
*/
|
|
3937
4093
|
setContentDesign(
|
|
@@ -3946,10 +4102,10 @@ declare module "sap/uxap/ObjectPageHeaderContent" {
|
|
|
3946
4102
|
|
|
3947
4103
|
export interface $ObjectPageHeaderContentSettings extends $ControlSettings {
|
|
3948
4104
|
/**
|
|
3949
|
-
* @deprecated (since 1.40.1)
|
|
3950
|
-
*
|
|
3951
4105
|
* Determines the design of the header - Light or Dark. **Note: **This property is deprecated. It will continue
|
|
3952
4106
|
* to work in the Blue Crystal theme, but it will not be taken into account for the Belize themes.
|
|
4107
|
+
*
|
|
4108
|
+
* @deprecated (since 1.40.1)
|
|
3953
4109
|
*/
|
|
3954
4110
|
contentDesign?:
|
|
3955
4111
|
| (ObjectPageHeaderDesign | keyof typeof ObjectPageHeaderDesign)
|
|
@@ -3976,13 +4132,13 @@ declare module "sap/uxap/ObjectPageHeaderLayoutData" {
|
|
|
3976
4132
|
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
3977
4133
|
|
|
3978
4134
|
/**
|
|
3979
|
-
* @since 1.26
|
|
3980
|
-
*
|
|
3981
4135
|
* A {@link sap.ui.core.LayoutData} element that can be added to controls used in the `headerContent` aggregation
|
|
3982
4136
|
* of the `ObjectPageLayout`.
|
|
3983
4137
|
*
|
|
3984
4138
|
* **Note:** This element is only taken into account when the `sap.uxap.ObjectPageLayout` control is used
|
|
3985
4139
|
* together with `sap.uxap.ObjectPageHeader` as value of `headerTitle`.
|
|
4140
|
+
*
|
|
4141
|
+
* @since 1.26
|
|
3986
4142
|
*/
|
|
3987
4143
|
export default class ObjectPageHeaderLayoutData extends LayoutData {
|
|
3988
4144
|
/**
|
|
@@ -4022,6 +4178,7 @@ declare module "sap/uxap/ObjectPageHeaderLayoutData" {
|
|
|
4022
4178
|
*
|
|
4023
4179
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.LayoutData.extend}.
|
|
4024
4180
|
*
|
|
4181
|
+
*
|
|
4025
4182
|
* @returns Created class / constructor function
|
|
4026
4183
|
*/
|
|
4027
4184
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -4042,6 +4199,7 @@ declare module "sap/uxap/ObjectPageHeaderLayoutData" {
|
|
|
4042
4199
|
/**
|
|
4043
4200
|
* Returns a metadata object for class sap.uxap.ObjectPageHeaderLayoutData.
|
|
4044
4201
|
*
|
|
4202
|
+
*
|
|
4045
4203
|
* @returns Metadata object describing this class
|
|
4046
4204
|
*/
|
|
4047
4205
|
static getMetadata(): ElementMetadata;
|
|
@@ -4052,6 +4210,7 @@ declare module "sap/uxap/ObjectPageHeaderLayoutData" {
|
|
|
4052
4210
|
*
|
|
4053
4211
|
* Default value is `false`.
|
|
4054
4212
|
*
|
|
4213
|
+
*
|
|
4055
4214
|
* @returns Value of property `showSeparatorAfter`
|
|
4056
4215
|
*/
|
|
4057
4216
|
getShowSeparatorAfter(): boolean;
|
|
@@ -4062,6 +4221,7 @@ declare module "sap/uxap/ObjectPageHeaderLayoutData" {
|
|
|
4062
4221
|
*
|
|
4063
4222
|
* Default value is `false`.
|
|
4064
4223
|
*
|
|
4224
|
+
*
|
|
4065
4225
|
* @returns Value of property `showSeparatorBefore`
|
|
4066
4226
|
*/
|
|
4067
4227
|
getShowSeparatorBefore(): boolean;
|
|
@@ -4072,6 +4232,7 @@ declare module "sap/uxap/ObjectPageHeaderLayoutData" {
|
|
|
4072
4232
|
*
|
|
4073
4233
|
* Default value is `true`.
|
|
4074
4234
|
*
|
|
4235
|
+
*
|
|
4075
4236
|
* @returns Value of property `visibleL`
|
|
4076
4237
|
*/
|
|
4077
4238
|
getVisibleL(): boolean;
|
|
@@ -4082,6 +4243,7 @@ declare module "sap/uxap/ObjectPageHeaderLayoutData" {
|
|
|
4082
4243
|
*
|
|
4083
4244
|
* Default value is `true`.
|
|
4084
4245
|
*
|
|
4246
|
+
*
|
|
4085
4247
|
* @returns Value of property `visibleM`
|
|
4086
4248
|
*/
|
|
4087
4249
|
getVisibleM(): boolean;
|
|
@@ -4092,6 +4254,7 @@ declare module "sap/uxap/ObjectPageHeaderLayoutData" {
|
|
|
4092
4254
|
*
|
|
4093
4255
|
* Default value is `true`.
|
|
4094
4256
|
*
|
|
4257
|
+
*
|
|
4095
4258
|
* @returns Value of property `visibleS`
|
|
4096
4259
|
*/
|
|
4097
4260
|
getVisibleS(): boolean;
|
|
@@ -4102,6 +4265,7 @@ declare module "sap/uxap/ObjectPageHeaderLayoutData" {
|
|
|
4102
4265
|
*
|
|
4103
4266
|
* Default value is `'auto'`.
|
|
4104
4267
|
*
|
|
4268
|
+
*
|
|
4105
4269
|
* @returns Value of property `width`
|
|
4106
4270
|
*/
|
|
4107
4271
|
getWidth(): CSSSize;
|
|
@@ -4114,6 +4278,7 @@ declare module "sap/uxap/ObjectPageHeaderLayoutData" {
|
|
|
4114
4278
|
*
|
|
4115
4279
|
* Default value is `false`.
|
|
4116
4280
|
*
|
|
4281
|
+
*
|
|
4117
4282
|
* @returns Reference to `this` in order to allow method chaining
|
|
4118
4283
|
*/
|
|
4119
4284
|
setShowSeparatorAfter(
|
|
@@ -4131,6 +4296,7 @@ declare module "sap/uxap/ObjectPageHeaderLayoutData" {
|
|
|
4131
4296
|
*
|
|
4132
4297
|
* Default value is `false`.
|
|
4133
4298
|
*
|
|
4299
|
+
*
|
|
4134
4300
|
* @returns Reference to `this` in order to allow method chaining
|
|
4135
4301
|
*/
|
|
4136
4302
|
setShowSeparatorBefore(
|
|
@@ -4148,6 +4314,7 @@ declare module "sap/uxap/ObjectPageHeaderLayoutData" {
|
|
|
4148
4314
|
*
|
|
4149
4315
|
* Default value is `true`.
|
|
4150
4316
|
*
|
|
4317
|
+
*
|
|
4151
4318
|
* @returns Reference to `this` in order to allow method chaining
|
|
4152
4319
|
*/
|
|
4153
4320
|
setVisibleL(
|
|
@@ -4165,6 +4332,7 @@ declare module "sap/uxap/ObjectPageHeaderLayoutData" {
|
|
|
4165
4332
|
*
|
|
4166
4333
|
* Default value is `true`.
|
|
4167
4334
|
*
|
|
4335
|
+
*
|
|
4168
4336
|
* @returns Reference to `this` in order to allow method chaining
|
|
4169
4337
|
*/
|
|
4170
4338
|
setVisibleM(
|
|
@@ -4182,6 +4350,7 @@ declare module "sap/uxap/ObjectPageHeaderLayoutData" {
|
|
|
4182
4350
|
*
|
|
4183
4351
|
* Default value is `true`.
|
|
4184
4352
|
*
|
|
4353
|
+
*
|
|
4185
4354
|
* @returns Reference to `this` in order to allow method chaining
|
|
4186
4355
|
*/
|
|
4187
4356
|
setVisibleS(
|
|
@@ -4199,6 +4368,7 @@ declare module "sap/uxap/ObjectPageHeaderLayoutData" {
|
|
|
4199
4368
|
*
|
|
4200
4369
|
* Default value is `'auto'`.
|
|
4201
4370
|
*
|
|
4371
|
+
*
|
|
4202
4372
|
* @returns Reference to `this` in order to allow method chaining
|
|
4203
4373
|
*/
|
|
4204
4374
|
setWidth(
|
|
@@ -4271,8 +4441,6 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4271
4441
|
import ObjectPageSubSection from "sap/uxap/ObjectPageSubSection";
|
|
4272
4442
|
|
|
4273
4443
|
/**
|
|
4274
|
-
* @since 1.26
|
|
4275
|
-
*
|
|
4276
4444
|
* A layout that allows apps to easily display information related to a business object.
|
|
4277
4445
|
*
|
|
4278
4446
|
* Overview:
|
|
@@ -4309,6 +4477,8 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4309
4477
|
* Responsive behavior:
|
|
4310
4478
|
*
|
|
4311
4479
|
* The `ObjectPageLayout` is responsive and adapts to all screen sizes.
|
|
4480
|
+
*
|
|
4481
|
+
* @since 1.26
|
|
4312
4482
|
*/
|
|
4313
4483
|
export default class ObjectPageLayout extends Control {
|
|
4314
4484
|
/**
|
|
@@ -4366,6 +4536,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4366
4536
|
*
|
|
4367
4537
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
|
|
4368
4538
|
*
|
|
4539
|
+
*
|
|
4369
4540
|
* @returns Created class / constructor function
|
|
4370
4541
|
*/
|
|
4371
4542
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -4386,12 +4557,14 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4386
4557
|
/**
|
|
4387
4558
|
* Returns a metadata object for class sap.uxap.ObjectPageLayout.
|
|
4388
4559
|
*
|
|
4560
|
+
*
|
|
4389
4561
|
* @returns Metadata object describing this class
|
|
4390
4562
|
*/
|
|
4391
4563
|
static getMetadata(): ElementMetadata;
|
|
4392
4564
|
/**
|
|
4393
4565
|
* Adds some headerContent to the aggregation {@link #getHeaderContent headerContent}.
|
|
4394
4566
|
*
|
|
4567
|
+
*
|
|
4395
4568
|
* @returns Reference to `this` in order to allow method chaining
|
|
4396
4569
|
*/
|
|
4397
4570
|
addHeaderContent(
|
|
@@ -4403,6 +4576,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4403
4576
|
/**
|
|
4404
4577
|
* Adds some section to the aggregation {@link #getSections sections}.
|
|
4405
4578
|
*
|
|
4579
|
+
*
|
|
4406
4580
|
* @returns Reference to `this` in order to allow method chaining
|
|
4407
4581
|
*/
|
|
4408
4582
|
addSection(
|
|
@@ -4412,8 +4586,6 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4412
4586
|
oSection: ObjectPageSection
|
|
4413
4587
|
): this;
|
|
4414
4588
|
/**
|
|
4415
|
-
* @since 1.118
|
|
4416
|
-
*
|
|
4417
4589
|
* Attaches event handler `fnFunction` to the {@link #event:beforeNavigate beforeNavigate} event of this
|
|
4418
4590
|
* `sap.uxap.ObjectPageLayout`.
|
|
4419
4591
|
*
|
|
@@ -4423,6 +4595,8 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4423
4595
|
* The event is fired before the selected section is changed using the navigation. This event can be aborted
|
|
4424
4596
|
* by the application with preventDefault(), which means that there will be no navigation.
|
|
4425
4597
|
*
|
|
4598
|
+
* @since 1.118
|
|
4599
|
+
*
|
|
4426
4600
|
* @returns Reference to `this` in order to allow method chaining
|
|
4427
4601
|
*/
|
|
4428
4602
|
attachBeforeNavigate(
|
|
@@ -4441,8 +4615,6 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4441
4615
|
oListener?: object
|
|
4442
4616
|
): this;
|
|
4443
4617
|
/**
|
|
4444
|
-
* @since 1.118
|
|
4445
|
-
*
|
|
4446
4618
|
* Attaches event handler `fnFunction` to the {@link #event:beforeNavigate beforeNavigate} event of this
|
|
4447
4619
|
* `sap.uxap.ObjectPageLayout`.
|
|
4448
4620
|
*
|
|
@@ -4452,6 +4624,8 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4452
4624
|
* The event is fired before the selected section is changed using the navigation. This event can be aborted
|
|
4453
4625
|
* by the application with preventDefault(), which means that there will be no navigation.
|
|
4454
4626
|
*
|
|
4627
|
+
* @since 1.118
|
|
4628
|
+
*
|
|
4455
4629
|
* @returns Reference to `this` in order to allow method chaining
|
|
4456
4630
|
*/
|
|
4457
4631
|
attachBeforeNavigate(
|
|
@@ -4473,6 +4647,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4473
4647
|
*
|
|
4474
4648
|
* The event is fired when the Edit Header button is pressed
|
|
4475
4649
|
*
|
|
4650
|
+
*
|
|
4476
4651
|
* @returns Reference to `this` in order to allow method chaining
|
|
4477
4652
|
*/
|
|
4478
4653
|
attachEditHeaderButtonPress(
|
|
@@ -4499,6 +4674,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4499
4674
|
*
|
|
4500
4675
|
* The event is fired when the Edit Header button is pressed
|
|
4501
4676
|
*
|
|
4677
|
+
*
|
|
4502
4678
|
* @returns Reference to `this` in order to allow method chaining
|
|
4503
4679
|
*/
|
|
4504
4680
|
attachEditHeaderButtonPress(
|
|
@@ -4512,8 +4688,6 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4512
4688
|
oListener?: object
|
|
4513
4689
|
): this;
|
|
4514
4690
|
/**
|
|
4515
|
-
* @since 1.93
|
|
4516
|
-
*
|
|
4517
4691
|
* Attaches event handler `fnFunction` to the {@link #event:headerContentPinnedStateChange headerContentPinnedStateChange }
|
|
4518
4692
|
* event of this `sap.uxap.ObjectPageLayout`.
|
|
4519
4693
|
*
|
|
@@ -4522,6 +4696,8 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4522
4696
|
*
|
|
4523
4697
|
* The event is fired when the `headerContentPinned` property is changed via user interaction.
|
|
4524
4698
|
*
|
|
4699
|
+
* @since 1.93
|
|
4700
|
+
*
|
|
4525
4701
|
* @returns Reference to `this` in order to allow method chaining
|
|
4526
4702
|
*/
|
|
4527
4703
|
attachHeaderContentPinnedStateChange(
|
|
@@ -4542,8 +4718,6 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4542
4718
|
oListener?: object
|
|
4543
4719
|
): this;
|
|
4544
4720
|
/**
|
|
4545
|
-
* @since 1.93
|
|
4546
|
-
*
|
|
4547
4721
|
* Attaches event handler `fnFunction` to the {@link #event:headerContentPinnedStateChange headerContentPinnedStateChange }
|
|
4548
4722
|
* event of this `sap.uxap.ObjectPageLayout`.
|
|
4549
4723
|
*
|
|
@@ -4552,6 +4726,8 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4552
4726
|
*
|
|
4553
4727
|
* The event is fired when the `headerContentPinned` property is changed via user interaction.
|
|
4554
4728
|
*
|
|
4729
|
+
* @since 1.93
|
|
4730
|
+
*
|
|
4555
4731
|
* @returns Reference to `this` in order to allow method chaining
|
|
4556
4732
|
*/
|
|
4557
4733
|
attachHeaderContentPinnedStateChange(
|
|
@@ -4567,8 +4743,6 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4567
4743
|
oListener?: object
|
|
4568
4744
|
): this;
|
|
4569
4745
|
/**
|
|
4570
|
-
* @since 1.40
|
|
4571
|
-
*
|
|
4572
4746
|
* Attaches event handler `fnFunction` to the {@link #event:navigate navigate} event of this `sap.uxap.ObjectPageLayout`.
|
|
4573
4747
|
*
|
|
4574
4748
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
@@ -4576,6 +4750,8 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4576
4750
|
*
|
|
4577
4751
|
* The event is fired when the selected section is changed using the navigation.
|
|
4578
4752
|
*
|
|
4753
|
+
* @since 1.40
|
|
4754
|
+
*
|
|
4579
4755
|
* @returns Reference to `this` in order to allow method chaining
|
|
4580
4756
|
*/
|
|
4581
4757
|
attachNavigate(
|
|
@@ -4594,8 +4770,6 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4594
4770
|
oListener?: object
|
|
4595
4771
|
): this;
|
|
4596
4772
|
/**
|
|
4597
|
-
* @since 1.40
|
|
4598
|
-
*
|
|
4599
4773
|
* Attaches event handler `fnFunction` to the {@link #event:navigate navigate} event of this `sap.uxap.ObjectPageLayout`.
|
|
4600
4774
|
*
|
|
4601
4775
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
@@ -4603,6 +4777,8 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4603
4777
|
*
|
|
4604
4778
|
* The event is fired when the selected section is changed using the navigation.
|
|
4605
4779
|
*
|
|
4780
|
+
* @since 1.40
|
|
4781
|
+
*
|
|
4606
4782
|
* @returns Reference to `this` in order to allow method chaining
|
|
4607
4783
|
*/
|
|
4608
4784
|
attachNavigate(
|
|
@@ -4616,8 +4792,6 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4616
4792
|
oListener?: object
|
|
4617
4793
|
): this;
|
|
4618
4794
|
/**
|
|
4619
|
-
* @since 1.73
|
|
4620
|
-
*
|
|
4621
4795
|
* Attaches event handler `fnFunction` to the {@link #event:sectionChange sectionChange} event of this `sap.uxap.ObjectPageLayout`.
|
|
4622
4796
|
*
|
|
4623
4797
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
@@ -4625,6 +4799,8 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4625
4799
|
*
|
|
4626
4800
|
* Fired when the current section is changed by scrolling.
|
|
4627
4801
|
*
|
|
4802
|
+
* @since 1.73
|
|
4803
|
+
*
|
|
4628
4804
|
* @returns Reference to `this` in order to allow method chaining
|
|
4629
4805
|
*/
|
|
4630
4806
|
attachSectionChange(
|
|
@@ -4643,8 +4819,6 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4643
4819
|
oListener?: object
|
|
4644
4820
|
): this;
|
|
4645
4821
|
/**
|
|
4646
|
-
* @since 1.73
|
|
4647
|
-
*
|
|
4648
4822
|
* Attaches event handler `fnFunction` to the {@link #event:sectionChange sectionChange} event of this `sap.uxap.ObjectPageLayout`.
|
|
4649
4823
|
*
|
|
4650
4824
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
@@ -4652,6 +4826,8 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4652
4826
|
*
|
|
4653
4827
|
* Fired when the current section is changed by scrolling.
|
|
4654
4828
|
*
|
|
4829
|
+
* @since 1.73
|
|
4830
|
+
*
|
|
4655
4831
|
* @returns Reference to `this` in order to allow method chaining
|
|
4656
4832
|
*/
|
|
4657
4833
|
attachSectionChange(
|
|
@@ -4665,8 +4841,6 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4665
4841
|
oListener?: object
|
|
4666
4842
|
): this;
|
|
4667
4843
|
/**
|
|
4668
|
-
* @since 1.77
|
|
4669
|
-
*
|
|
4670
4844
|
* Attaches event handler `fnFunction` to the {@link #event:subSectionVisibilityChange subSectionVisibilityChange }
|
|
4671
4845
|
* event of this `sap.uxap.ObjectPageLayout`.
|
|
4672
4846
|
*
|
|
@@ -4675,6 +4849,8 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4675
4849
|
*
|
|
4676
4850
|
* Fired when the visibility of subsections is changed.
|
|
4677
4851
|
*
|
|
4852
|
+
* @since 1.77
|
|
4853
|
+
*
|
|
4678
4854
|
* @returns Reference to `this` in order to allow method chaining
|
|
4679
4855
|
*/
|
|
4680
4856
|
attachSubSectionVisibilityChange(
|
|
@@ -4695,8 +4871,6 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4695
4871
|
oListener?: object
|
|
4696
4872
|
): this;
|
|
4697
4873
|
/**
|
|
4698
|
-
* @since 1.77
|
|
4699
|
-
*
|
|
4700
4874
|
* Attaches event handler `fnFunction` to the {@link #event:subSectionVisibilityChange subSectionVisibilityChange }
|
|
4701
4875
|
* event of this `sap.uxap.ObjectPageLayout`.
|
|
4702
4876
|
*
|
|
@@ -4705,6 +4879,8 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4705
4879
|
*
|
|
4706
4880
|
* Fired when the visibility of subsections is changed.
|
|
4707
4881
|
*
|
|
4882
|
+
* @since 1.77
|
|
4883
|
+
*
|
|
4708
4884
|
* @returns Reference to `this` in order to allow method chaining
|
|
4709
4885
|
*/
|
|
4710
4886
|
attachSubSectionVisibilityChange(
|
|
@@ -4728,6 +4904,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4728
4904
|
*
|
|
4729
4905
|
* The event is fired when the Anchor bar is switched from moving to fixed or the other way round.
|
|
4730
4906
|
*
|
|
4907
|
+
*
|
|
4731
4908
|
* @returns Reference to `this` in order to allow method chaining
|
|
4732
4909
|
*/
|
|
4733
4910
|
attachToggleAnchorBar(
|
|
@@ -4754,6 +4931,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4754
4931
|
*
|
|
4755
4932
|
* The event is fired when the Anchor bar is switched from moving to fixed or the other way round.
|
|
4756
4933
|
*
|
|
4934
|
+
*
|
|
4757
4935
|
* @returns Reference to `this` in order to allow method chaining
|
|
4758
4936
|
*/
|
|
4759
4937
|
attachToggleAnchorBar(
|
|
@@ -4767,47 +4945,50 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4767
4945
|
oListener?: object
|
|
4768
4946
|
): this;
|
|
4769
4947
|
/**
|
|
4770
|
-
* @since 1.40
|
|
4771
|
-
*
|
|
4772
4948
|
* Destroys the footer in the aggregation {@link #getFooter footer}.
|
|
4773
4949
|
*
|
|
4950
|
+
* @since 1.40
|
|
4951
|
+
*
|
|
4774
4952
|
* @returns Reference to `this` in order to allow method chaining
|
|
4775
4953
|
*/
|
|
4776
4954
|
destroyFooter(): this;
|
|
4777
4955
|
/**
|
|
4778
4956
|
* Destroys all the headerContent in the aggregation {@link #getHeaderContent headerContent}.
|
|
4779
4957
|
*
|
|
4958
|
+
*
|
|
4780
4959
|
* @returns Reference to `this` in order to allow method chaining
|
|
4781
4960
|
*/
|
|
4782
4961
|
destroyHeaderContent(): this;
|
|
4783
4962
|
/**
|
|
4784
4963
|
* Destroys the headerTitle in the aggregation {@link #getHeaderTitle headerTitle}.
|
|
4785
4964
|
*
|
|
4965
|
+
*
|
|
4786
4966
|
* @returns Reference to `this` in order to allow method chaining
|
|
4787
4967
|
*/
|
|
4788
4968
|
destroyHeaderTitle(): this;
|
|
4789
4969
|
/**
|
|
4790
|
-
* @since 1.61
|
|
4791
|
-
*
|
|
4792
4970
|
* Destroys the landmarkInfo in the aggregation {@link #getLandmarkInfo landmarkInfo}.
|
|
4793
4971
|
*
|
|
4972
|
+
* @since 1.61
|
|
4973
|
+
*
|
|
4794
4974
|
* @returns Reference to `this` in order to allow method chaining
|
|
4795
4975
|
*/
|
|
4796
4976
|
destroyLandmarkInfo(): this;
|
|
4797
4977
|
/**
|
|
4798
4978
|
* Destroys all the sections in the aggregation {@link #getSections sections}.
|
|
4799
4979
|
*
|
|
4980
|
+
*
|
|
4800
4981
|
* @returns Reference to `this` in order to allow method chaining
|
|
4801
4982
|
*/
|
|
4802
4983
|
destroySections(): this;
|
|
4803
4984
|
/**
|
|
4804
|
-
* @since 1.118
|
|
4805
|
-
*
|
|
4806
4985
|
* Detaches event handler `fnFunction` from the {@link #event:beforeNavigate beforeNavigate} event of this
|
|
4807
4986
|
* `sap.uxap.ObjectPageLayout`.
|
|
4808
4987
|
*
|
|
4809
4988
|
* The passed function and listener object must match the ones used for event registration.
|
|
4810
4989
|
*
|
|
4990
|
+
* @since 1.118
|
|
4991
|
+
*
|
|
4811
4992
|
* @returns Reference to `this` in order to allow method chaining
|
|
4812
4993
|
*/
|
|
4813
4994
|
detachBeforeNavigate(
|
|
@@ -4826,6 +5007,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4826
5007
|
*
|
|
4827
5008
|
* The passed function and listener object must match the ones used for event registration.
|
|
4828
5009
|
*
|
|
5010
|
+
*
|
|
4829
5011
|
* @returns Reference to `this` in order to allow method chaining
|
|
4830
5012
|
*/
|
|
4831
5013
|
detachEditHeaderButtonPress(
|
|
@@ -4839,13 +5021,13 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4839
5021
|
oListener?: object
|
|
4840
5022
|
): this;
|
|
4841
5023
|
/**
|
|
4842
|
-
* @since 1.93
|
|
4843
|
-
*
|
|
4844
5024
|
* Detaches event handler `fnFunction` from the {@link #event:headerContentPinnedStateChange headerContentPinnedStateChange }
|
|
4845
5025
|
* event of this `sap.uxap.ObjectPageLayout`.
|
|
4846
5026
|
*
|
|
4847
5027
|
* The passed function and listener object must match the ones used for event registration.
|
|
4848
5028
|
*
|
|
5029
|
+
* @since 1.93
|
|
5030
|
+
*
|
|
4849
5031
|
* @returns Reference to `this` in order to allow method chaining
|
|
4850
5032
|
*/
|
|
4851
5033
|
detachHeaderContentPinnedStateChange(
|
|
@@ -4861,12 +5043,12 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4861
5043
|
oListener?: object
|
|
4862
5044
|
): this;
|
|
4863
5045
|
/**
|
|
4864
|
-
* @since 1.40
|
|
4865
|
-
*
|
|
4866
5046
|
* Detaches event handler `fnFunction` from the {@link #event:navigate navigate} event of this `sap.uxap.ObjectPageLayout`.
|
|
4867
5047
|
*
|
|
4868
5048
|
* The passed function and listener object must match the ones used for event registration.
|
|
4869
5049
|
*
|
|
5050
|
+
* @since 1.40
|
|
5051
|
+
*
|
|
4870
5052
|
* @returns Reference to `this` in order to allow method chaining
|
|
4871
5053
|
*/
|
|
4872
5054
|
detachNavigate(
|
|
@@ -4880,13 +5062,13 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4880
5062
|
oListener?: object
|
|
4881
5063
|
): this;
|
|
4882
5064
|
/**
|
|
4883
|
-
* @since 1.73
|
|
4884
|
-
*
|
|
4885
5065
|
* Detaches event handler `fnFunction` from the {@link #event:sectionChange sectionChange} event of this
|
|
4886
5066
|
* `sap.uxap.ObjectPageLayout`.
|
|
4887
5067
|
*
|
|
4888
5068
|
* The passed function and listener object must match the ones used for event registration.
|
|
4889
5069
|
*
|
|
5070
|
+
* @since 1.73
|
|
5071
|
+
*
|
|
4890
5072
|
* @returns Reference to `this` in order to allow method chaining
|
|
4891
5073
|
*/
|
|
4892
5074
|
detachSectionChange(
|
|
@@ -4900,13 +5082,13 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4900
5082
|
oListener?: object
|
|
4901
5083
|
): this;
|
|
4902
5084
|
/**
|
|
4903
|
-
* @since 1.77
|
|
4904
|
-
*
|
|
4905
5085
|
* Detaches event handler `fnFunction` from the {@link #event:subSectionVisibilityChange subSectionVisibilityChange }
|
|
4906
5086
|
* event of this `sap.uxap.ObjectPageLayout`.
|
|
4907
5087
|
*
|
|
4908
5088
|
* The passed function and listener object must match the ones used for event registration.
|
|
4909
5089
|
*
|
|
5090
|
+
* @since 1.77
|
|
5091
|
+
*
|
|
4910
5092
|
* @returns Reference to `this` in order to allow method chaining
|
|
4911
5093
|
*/
|
|
4912
5094
|
detachSubSectionVisibilityChange(
|
|
@@ -4927,6 +5109,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4927
5109
|
*
|
|
4928
5110
|
* The passed function and listener object must match the ones used for event registration.
|
|
4929
5111
|
*
|
|
5112
|
+
*
|
|
4930
5113
|
* @returns Reference to `this` in order to allow method chaining
|
|
4931
5114
|
*/
|
|
4932
5115
|
detachToggleAnchorBar(
|
|
@@ -4940,14 +5123,14 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4940
5123
|
oListener?: object
|
|
4941
5124
|
): this;
|
|
4942
5125
|
/**
|
|
4943
|
-
* @since 1.118
|
|
4944
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
4945
|
-
*
|
|
4946
5126
|
* Fires event {@link #event:beforeNavigate beforeNavigate} to attached listeners.
|
|
4947
5127
|
*
|
|
4948
5128
|
* Listeners may prevent the default action of this event by calling the `preventDefault` method on the
|
|
4949
5129
|
* event object. The return value of this method indicates whether the default action should be executed.
|
|
4950
5130
|
*
|
|
5131
|
+
* @since 1.118
|
|
5132
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
5133
|
+
*
|
|
4951
5134
|
* @returns Whether or not to prevent the default action
|
|
4952
5135
|
*/
|
|
4953
5136
|
fireBeforeNavigate(
|
|
@@ -4957,10 +5140,10 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4957
5140
|
mParameters?: ObjectPageLayout$BeforeNavigateEventParameters
|
|
4958
5141
|
): boolean;
|
|
4959
5142
|
/**
|
|
4960
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
4961
|
-
*
|
|
4962
5143
|
* Fires event {@link #event:editHeaderButtonPress editHeaderButtonPress} to attached listeners.
|
|
4963
5144
|
*
|
|
5145
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
5146
|
+
*
|
|
4964
5147
|
* @returns Reference to `this` in order to allow method chaining
|
|
4965
5148
|
*/
|
|
4966
5149
|
fireEditHeaderButtonPress(
|
|
@@ -4970,12 +5153,12 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4970
5153
|
mParameters?: object
|
|
4971
5154
|
): this;
|
|
4972
5155
|
/**
|
|
4973
|
-
* @since 1.93
|
|
4974
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
4975
|
-
*
|
|
4976
5156
|
* Fires event {@link #event:headerContentPinnedStateChange headerContentPinnedStateChange} to attached
|
|
4977
5157
|
* listeners.
|
|
4978
5158
|
*
|
|
5159
|
+
* @since 1.93
|
|
5160
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
5161
|
+
*
|
|
4979
5162
|
* @returns Reference to `this` in order to allow method chaining
|
|
4980
5163
|
*/
|
|
4981
5164
|
fireHeaderContentPinnedStateChange(
|
|
@@ -4985,11 +5168,11 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4985
5168
|
mParameters?: ObjectPageLayout$HeaderContentPinnedStateChangeEventParameters
|
|
4986
5169
|
): this;
|
|
4987
5170
|
/**
|
|
5171
|
+
* Fires event {@link #event:navigate navigate} to attached listeners.
|
|
5172
|
+
*
|
|
4988
5173
|
* @since 1.40
|
|
4989
5174
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
4990
5175
|
*
|
|
4991
|
-
* Fires event {@link #event:navigate navigate} to attached listeners.
|
|
4992
|
-
*
|
|
4993
5176
|
* @returns Reference to `this` in order to allow method chaining
|
|
4994
5177
|
*/
|
|
4995
5178
|
fireNavigate(
|
|
@@ -4999,11 +5182,11 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
4999
5182
|
mParameters?: ObjectPageLayout$NavigateEventParameters
|
|
5000
5183
|
): this;
|
|
5001
5184
|
/**
|
|
5185
|
+
* Fires event {@link #event:sectionChange sectionChange} to attached listeners.
|
|
5186
|
+
*
|
|
5002
5187
|
* @since 1.73
|
|
5003
5188
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
5004
5189
|
*
|
|
5005
|
-
* Fires event {@link #event:sectionChange sectionChange} to attached listeners.
|
|
5006
|
-
*
|
|
5007
5190
|
* @returns Reference to `this` in order to allow method chaining
|
|
5008
5191
|
*/
|
|
5009
5192
|
fireSectionChange(
|
|
@@ -5013,11 +5196,11 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5013
5196
|
mParameters?: ObjectPageLayout$SectionChangeEventParameters
|
|
5014
5197
|
): this;
|
|
5015
5198
|
/**
|
|
5199
|
+
* Fires event {@link #event:subSectionVisibilityChange subSectionVisibilityChange} to attached listeners.
|
|
5200
|
+
*
|
|
5016
5201
|
* @since 1.77
|
|
5017
5202
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
5018
5203
|
*
|
|
5019
|
-
* Fires event {@link #event:subSectionVisibilityChange subSectionVisibilityChange} to attached listeners.
|
|
5020
|
-
*
|
|
5021
5204
|
* @returns Reference to `this` in order to allow method chaining
|
|
5022
5205
|
*/
|
|
5023
5206
|
fireSubSectionVisibilityChange(
|
|
@@ -5027,10 +5210,10 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5027
5210
|
mParameters?: ObjectPageLayout$SubSectionVisibilityChangeEventParameters
|
|
5028
5211
|
): this;
|
|
5029
5212
|
/**
|
|
5030
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
5031
|
-
*
|
|
5032
5213
|
* Fires event {@link #event:toggleAnchorBar toggleAnchorBar} to attached listeners.
|
|
5033
5214
|
*
|
|
5215
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
5216
|
+
*
|
|
5034
5217
|
* @returns Reference to `this` in order to allow method chaining
|
|
5035
5218
|
*/
|
|
5036
5219
|
fireToggleAnchorBar(
|
|
@@ -5040,8 +5223,6 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5040
5223
|
mParameters?: ObjectPageLayout$ToggleAnchorBarEventParameters
|
|
5041
5224
|
): this;
|
|
5042
5225
|
/**
|
|
5043
|
-
* @since 1.34.0
|
|
5044
|
-
*
|
|
5045
5226
|
* Gets current value of property {@link #getAlwaysShowContentHeader alwaysShowContentHeader}.
|
|
5046
5227
|
*
|
|
5047
5228
|
* Determines whether Header Content will always be expanded on desktop.
|
|
@@ -5051,12 +5232,12 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5051
5232
|
*
|
|
5052
5233
|
* Default value is `false`.
|
|
5053
5234
|
*
|
|
5235
|
+
* @since 1.34.0
|
|
5236
|
+
*
|
|
5054
5237
|
* @returns Value of property `alwaysShowContentHeader`
|
|
5055
5238
|
*/
|
|
5056
5239
|
getAlwaysShowContentHeader(): boolean;
|
|
5057
5240
|
/**
|
|
5058
|
-
* @since 1.58
|
|
5059
|
-
*
|
|
5060
5241
|
* Gets current value of property {@link #getBackgroundDesignAnchorBar backgroundDesignAnchorBar}.
|
|
5061
5242
|
*
|
|
5062
5243
|
* Determines the background color of the `AnchorBar`.
|
|
@@ -5064,6 +5245,8 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5064
5245
|
* **Note:** The default value of `backgroundDesignAnchorBar` property is null. If the property is not set,
|
|
5065
5246
|
* the color of the background is `@sapUiObjectHeaderBackground`, which depends on the specific theme.
|
|
5066
5247
|
*
|
|
5248
|
+
* @since 1.58
|
|
5249
|
+
*
|
|
5067
5250
|
* @returns Value of property `backgroundDesignAnchorBar`
|
|
5068
5251
|
*/
|
|
5069
5252
|
getBackgroundDesignAnchorBar():
|
|
@@ -5076,12 +5259,11 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5076
5259
|
*
|
|
5077
5260
|
* Default value is `false`.
|
|
5078
5261
|
*
|
|
5262
|
+
*
|
|
5079
5263
|
* @returns Value of property `enableLazyLoading`
|
|
5080
5264
|
*/
|
|
5081
5265
|
getEnableLazyLoading(): boolean;
|
|
5082
5266
|
/**
|
|
5083
|
-
* @since 1.34.0
|
|
5084
|
-
*
|
|
5085
5267
|
* Gets current value of property {@link #getFlexEnabled flexEnabled}.
|
|
5086
5268
|
*
|
|
5087
5269
|
* Specifies whether the object page enables flexibility features, such as hiding and adding sections.
|
|
@@ -5089,15 +5271,17 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5089
5271
|
*
|
|
5090
5272
|
* Default value is `false`.
|
|
5091
5273
|
*
|
|
5274
|
+
* @since 1.34.0
|
|
5275
|
+
*
|
|
5092
5276
|
* @returns Value of property `flexEnabled`
|
|
5093
5277
|
*/
|
|
5094
5278
|
getFlexEnabled(): boolean;
|
|
5095
5279
|
/**
|
|
5096
|
-
* @since 1.40
|
|
5097
|
-
*
|
|
5098
5280
|
* Gets content of aggregation {@link #getFooter footer}.
|
|
5099
5281
|
*
|
|
5100
5282
|
* Object page floating footer.
|
|
5283
|
+
*
|
|
5284
|
+
* @since 1.40
|
|
5101
5285
|
*/
|
|
5102
5286
|
getFooter(): IBar;
|
|
5103
5287
|
/**
|
|
@@ -5107,8 +5291,6 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5107
5291
|
*/
|
|
5108
5292
|
getHeaderContent(): Control[];
|
|
5109
5293
|
/**
|
|
5110
|
-
* @since 1.52
|
|
5111
|
-
*
|
|
5112
5294
|
* Gets current value of property {@link #getHeaderContentPinnable headerContentPinnable}.
|
|
5113
5295
|
*
|
|
5114
5296
|
* Determines whether the Header Content area can be pinned.
|
|
@@ -5121,12 +5303,12 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5121
5303
|
*
|
|
5122
5304
|
* Default value is `true`.
|
|
5123
5305
|
*
|
|
5306
|
+
* @since 1.52
|
|
5307
|
+
*
|
|
5124
5308
|
* @returns Value of property `headerContentPinnable`
|
|
5125
5309
|
*/
|
|
5126
5310
|
getHeaderContentPinnable(): boolean;
|
|
5127
5311
|
/**
|
|
5128
|
-
* @since 1.93
|
|
5129
|
-
*
|
|
5130
5312
|
* Gets current value of property {@link #getHeaderContentPinned headerContentPinned}.
|
|
5131
5313
|
*
|
|
5132
5314
|
* Determines whether the `sap.uxap.ObjectPageDynamicHeaderContent` is pinned.
|
|
@@ -5146,6 +5328,8 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5146
5328
|
*
|
|
5147
5329
|
* Default value is `false`.
|
|
5148
5330
|
*
|
|
5331
|
+
* @since 1.93
|
|
5332
|
+
*
|
|
5149
5333
|
* @returns Value of property `headerContentPinned`
|
|
5150
5334
|
*/
|
|
5151
5335
|
getHeaderContentPinned(): boolean;
|
|
@@ -5162,12 +5346,11 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5162
5346
|
*
|
|
5163
5347
|
* Default value is `"100%"`.
|
|
5164
5348
|
*
|
|
5349
|
+
*
|
|
5165
5350
|
* @returns Value of property `height`
|
|
5166
5351
|
*/
|
|
5167
5352
|
getHeight(): CSSSize;
|
|
5168
5353
|
/**
|
|
5169
|
-
* @since 1.34.0
|
|
5170
|
-
*
|
|
5171
5354
|
* Gets current value of property {@link #getIsChildPage isChildPage}.
|
|
5172
5355
|
*
|
|
5173
5356
|
* Determines whether the page is a child page and renders it with a different design. Child pages have
|
|
@@ -5178,22 +5361,22 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5178
5361
|
*
|
|
5179
5362
|
* Default value is `false`.
|
|
5180
5363
|
*
|
|
5364
|
+
* @since 1.34.0
|
|
5365
|
+
*
|
|
5181
5366
|
* @returns Value of property `isChildPage`
|
|
5182
5367
|
*/
|
|
5183
5368
|
getIsChildPage(): boolean;
|
|
5184
5369
|
/**
|
|
5185
|
-
* @since 1.61
|
|
5186
|
-
*
|
|
5187
5370
|
* Gets content of aggregation {@link #getLandmarkInfo landmarkInfo}.
|
|
5188
5371
|
*
|
|
5189
5372
|
* Accessible landmark settings to be applied on the containers of the `sap.uxap.ObjectPageLayout` control.
|
|
5190
5373
|
*
|
|
5191
5374
|
* If not set, no landmarks will be written.
|
|
5375
|
+
*
|
|
5376
|
+
* @since 1.61
|
|
5192
5377
|
*/
|
|
5193
5378
|
getLandmarkInfo(): ObjectPageAccessibleLandmarkInfo;
|
|
5194
5379
|
/**
|
|
5195
|
-
* @since 1.52
|
|
5196
|
-
*
|
|
5197
5380
|
* Gets current value of property {@link #getPreserveHeaderStateOnScroll preserveHeaderStateOnScroll}.
|
|
5198
5381
|
*
|
|
5199
5382
|
* Preserves the current header state when scrolling. For example, if the user expands the header by clicking
|
|
@@ -5208,12 +5391,15 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5208
5391
|
*
|
|
5209
5392
|
* Default value is `false`.
|
|
5210
5393
|
*
|
|
5394
|
+
* @since 1.52
|
|
5395
|
+
*
|
|
5211
5396
|
* @returns Value of property `preserveHeaderStateOnScroll`
|
|
5212
5397
|
*/
|
|
5213
5398
|
getPreserveHeaderStateOnScroll(): boolean;
|
|
5214
5399
|
/**
|
|
5215
5400
|
* Returns the `sap.ui.core.delegate.ScrollEnablement` delegate which is used with this control.
|
|
5216
5401
|
*
|
|
5402
|
+
*
|
|
5217
5403
|
* @returns The scroll delegate instance
|
|
5218
5404
|
*/
|
|
5219
5405
|
getScrollDelegate(): ScrollEnablement;
|
|
@@ -5228,8 +5414,6 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5228
5414
|
*/
|
|
5229
5415
|
getSections(): ObjectPageSection[];
|
|
5230
5416
|
/**
|
|
5231
|
-
* @since 1.44.0
|
|
5232
|
-
*
|
|
5233
5417
|
* Gets current value of property {@link #getSectionTitleLevel sectionTitleLevel}.
|
|
5234
5418
|
*
|
|
5235
5419
|
* Determines the ARIA level of the `ObjectPageSection` and `ObjectPageSubSection` titles. The ARIA level
|
|
@@ -5254,16 +5438,18 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5254
5438
|
*
|
|
5255
5439
|
* Default value is `Auto`.
|
|
5256
5440
|
*
|
|
5441
|
+
* @since 1.44.0
|
|
5442
|
+
*
|
|
5257
5443
|
* @returns Value of property `sectionTitleLevel`
|
|
5258
5444
|
*/
|
|
5259
5445
|
getSectionTitleLevel(): TitleLevel | keyof typeof TitleLevel;
|
|
5260
5446
|
/**
|
|
5261
|
-
* @since 1.44.0
|
|
5262
|
-
*
|
|
5263
5447
|
* ID of the element which is the current target of the association {@link #getSelectedSection selectedSection},
|
|
5264
5448
|
* or `null`.
|
|
5449
|
+
*
|
|
5450
|
+
* @since 1.44.0
|
|
5265
5451
|
*/
|
|
5266
|
-
getSelectedSection(): ID;
|
|
5452
|
+
getSelectedSection(): ID | null;
|
|
5267
5453
|
/**
|
|
5268
5454
|
* Gets current value of property {@link #getShowAnchorBar showAnchorBar}.
|
|
5269
5455
|
*
|
|
@@ -5271,6 +5457,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5271
5457
|
*
|
|
5272
5458
|
* Default value is `true`.
|
|
5273
5459
|
*
|
|
5460
|
+
*
|
|
5274
5461
|
* @returns Value of property `showAnchorBar`
|
|
5275
5462
|
*/
|
|
5276
5463
|
getShowAnchorBar(): boolean;
|
|
@@ -5282,12 +5469,11 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5282
5469
|
*
|
|
5283
5470
|
* Default value is `true`.
|
|
5284
5471
|
*
|
|
5472
|
+
*
|
|
5285
5473
|
* @returns Value of property `showAnchorBarPopover`
|
|
5286
5474
|
*/
|
|
5287
5475
|
getShowAnchorBarPopover(): boolean;
|
|
5288
5476
|
/**
|
|
5289
|
-
* @since 1.34.0
|
|
5290
|
-
*
|
|
5291
5477
|
* Gets current value of property {@link #getShowEditHeaderButton showEditHeaderButton}.
|
|
5292
5478
|
*
|
|
5293
5479
|
* Determines whether an Edit button will be displayed in Header Content.
|
|
@@ -5297,18 +5483,20 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5297
5483
|
*
|
|
5298
5484
|
* Default value is `false`.
|
|
5299
5485
|
*
|
|
5486
|
+
* @since 1.34.0
|
|
5487
|
+
*
|
|
5300
5488
|
* @returns Value of property `showEditHeaderButton`
|
|
5301
5489
|
*/
|
|
5302
5490
|
getShowEditHeaderButton(): boolean;
|
|
5303
5491
|
/**
|
|
5304
|
-
* @since 1.40
|
|
5305
|
-
*
|
|
5306
5492
|
* Gets current value of property {@link #getShowFooter showFooter}.
|
|
5307
5493
|
*
|
|
5308
5494
|
* Determines whether the footer is visible.
|
|
5309
5495
|
*
|
|
5310
5496
|
* Default value is `false`.
|
|
5311
5497
|
*
|
|
5498
|
+
* @since 1.40
|
|
5499
|
+
*
|
|
5312
5500
|
* @returns Value of property `showFooter`
|
|
5313
5501
|
*/
|
|
5314
5502
|
getShowFooter(): boolean;
|
|
@@ -5319,18 +5507,19 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5319
5507
|
*
|
|
5320
5508
|
* Default value is `true`.
|
|
5321
5509
|
*
|
|
5510
|
+
*
|
|
5322
5511
|
* @returns Value of property `showHeaderContent`
|
|
5323
5512
|
*/
|
|
5324
5513
|
getShowHeaderContent(): boolean;
|
|
5325
5514
|
/**
|
|
5326
|
-
* @since 1.32.0
|
|
5327
|
-
*
|
|
5328
5515
|
* Gets current value of property {@link #getShowOnlyHighImportance showOnlyHighImportance}.
|
|
5329
5516
|
*
|
|
5330
5517
|
* Determines whether sections and subsections with importance Low and Medium are hidden even on large screens.
|
|
5331
5518
|
*
|
|
5332
5519
|
* Default value is `false`.
|
|
5333
5520
|
*
|
|
5521
|
+
* @since 1.32.0
|
|
5522
|
+
*
|
|
5334
5523
|
* @returns Value of property `showOnlyHighImportance`
|
|
5335
5524
|
*/
|
|
5336
5525
|
getShowOnlyHighImportance(): boolean;
|
|
@@ -5344,6 +5533,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5344
5533
|
*
|
|
5345
5534
|
* Default value is `false`.
|
|
5346
5535
|
*
|
|
5536
|
+
*
|
|
5347
5537
|
* @returns Value of property `showTitleInHeaderContent`
|
|
5348
5538
|
*/
|
|
5349
5539
|
getShowTitleInHeaderContent(): boolean;
|
|
@@ -5354,14 +5544,13 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5354
5544
|
*
|
|
5355
5545
|
* Default value is `TitleOnTop`.
|
|
5356
5546
|
*
|
|
5547
|
+
*
|
|
5357
5548
|
* @returns Value of property `subSectionLayout`
|
|
5358
5549
|
*/
|
|
5359
5550
|
getSubSectionLayout():
|
|
5360
5551
|
| ObjectPageSubSectionLayout
|
|
5361
5552
|
| keyof typeof ObjectPageSubSectionLayout;
|
|
5362
5553
|
/**
|
|
5363
|
-
* @since 1.52
|
|
5364
|
-
*
|
|
5365
5554
|
* Gets current value of property {@link #getToggleHeaderOnTitleClick toggleHeaderOnTitleClick}.
|
|
5366
5555
|
*
|
|
5367
5556
|
* Determines whether the user can switch between the expanded/collapsed states of the `sap.uxap.ObjectPageDynamicHeaderContent`
|
|
@@ -5374,6 +5563,8 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5374
5563
|
*
|
|
5375
5564
|
* Default value is `true`.
|
|
5376
5565
|
*
|
|
5566
|
+
* @since 1.52
|
|
5567
|
+
*
|
|
5377
5568
|
* @returns Value of property `toggleHeaderOnTitleClick`
|
|
5378
5569
|
*/
|
|
5379
5570
|
getToggleHeaderOnTitleClick(): boolean;
|
|
@@ -5384,6 +5575,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5384
5575
|
*
|
|
5385
5576
|
* Default value is `true`.
|
|
5386
5577
|
*
|
|
5578
|
+
*
|
|
5387
5579
|
* @returns Value of property `upperCaseAnchorBar`
|
|
5388
5580
|
*/
|
|
5389
5581
|
getUpperCaseAnchorBar(): boolean;
|
|
@@ -5397,6 +5589,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5397
5589
|
*
|
|
5398
5590
|
* Default value is `false`.
|
|
5399
5591
|
*
|
|
5592
|
+
*
|
|
5400
5593
|
* @returns Value of property `useIconTabBar`
|
|
5401
5594
|
*/
|
|
5402
5595
|
getUseIconTabBar(): boolean;
|
|
@@ -5407,6 +5600,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5407
5600
|
*
|
|
5408
5601
|
* Default value is `false`.
|
|
5409
5602
|
*
|
|
5603
|
+
*
|
|
5410
5604
|
* @returns Value of property `useTwoColumnsForLargeScreen`
|
|
5411
5605
|
*/
|
|
5412
5606
|
getUseTwoColumnsForLargeScreen(): boolean;
|
|
@@ -5414,6 +5608,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5414
5608
|
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getHeaderContent headerContent}.
|
|
5415
5609
|
* and returns its index if found or -1 otherwise.
|
|
5416
5610
|
*
|
|
5611
|
+
*
|
|
5417
5612
|
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
5418
5613
|
*/
|
|
5419
5614
|
indexOfHeaderContent(
|
|
@@ -5426,6 +5621,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5426
5621
|
* Checks for the provided `sap.uxap.ObjectPageSection` in the aggregation {@link #getSections sections}.
|
|
5427
5622
|
* and returns its index if found or -1 otherwise.
|
|
5428
5623
|
*
|
|
5624
|
+
*
|
|
5429
5625
|
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
5430
5626
|
*/
|
|
5431
5627
|
indexOfSection(
|
|
@@ -5437,6 +5633,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5437
5633
|
/**
|
|
5438
5634
|
* Inserts a headerContent into the aggregation {@link #getHeaderContent headerContent}.
|
|
5439
5635
|
*
|
|
5636
|
+
*
|
|
5440
5637
|
* @returns Reference to `this` in order to allow method chaining
|
|
5441
5638
|
*/
|
|
5442
5639
|
insertHeaderContent(
|
|
@@ -5454,6 +5651,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5454
5651
|
/**
|
|
5455
5652
|
* Inserts a section into the aggregation {@link #getSections sections}.
|
|
5456
5653
|
*
|
|
5654
|
+
*
|
|
5457
5655
|
* @returns Reference to `this` in order to allow method chaining
|
|
5458
5656
|
*/
|
|
5459
5657
|
insertSection(
|
|
@@ -5469,9 +5667,9 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5469
5667
|
iIndex: int
|
|
5470
5668
|
): this;
|
|
5471
5669
|
/**
|
|
5472
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
5473
|
-
*
|
|
5474
5670
|
* This triggers rerendering of itself and its children.
|
|
5671
|
+
*
|
|
5672
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
5475
5673
|
*/
|
|
5476
5674
|
invalidate(
|
|
5477
5675
|
/**
|
|
@@ -5486,6 +5684,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5486
5684
|
*
|
|
5487
5685
|
* Additionally, it unregisters them from the hosting UIArea.
|
|
5488
5686
|
*
|
|
5687
|
+
*
|
|
5489
5688
|
* @returns An array of the removed elements (might be empty)
|
|
5490
5689
|
*/
|
|
5491
5690
|
removeAllHeaderContent(): Control[];
|
|
@@ -5494,12 +5693,14 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5494
5693
|
*
|
|
5495
5694
|
* Additionally, it unregisters them from the hosting UIArea.
|
|
5496
5695
|
*
|
|
5696
|
+
*
|
|
5497
5697
|
* @returns An array of the removed elements (might be empty)
|
|
5498
5698
|
*/
|
|
5499
5699
|
removeAllSections(): ObjectPageSection[];
|
|
5500
5700
|
/**
|
|
5501
5701
|
* Removes a headerContent from the aggregation {@link #getHeaderContent headerContent}.
|
|
5502
5702
|
*
|
|
5703
|
+
*
|
|
5503
5704
|
* @returns The removed headerContent or `null`
|
|
5504
5705
|
*/
|
|
5505
5706
|
removeHeaderContent(
|
|
@@ -5511,6 +5712,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5511
5712
|
/**
|
|
5512
5713
|
* Removes a section from the aggregation {@link #getSections sections}.
|
|
5513
5714
|
*
|
|
5715
|
+
*
|
|
5514
5716
|
* @returns The removed section or `null`
|
|
5515
5717
|
*/
|
|
5516
5718
|
removeSection(
|
|
@@ -5537,8 +5739,6 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5537
5739
|
iOffset?: int
|
|
5538
5740
|
): void;
|
|
5539
5741
|
/**
|
|
5540
|
-
* @since 1.34.0
|
|
5541
|
-
*
|
|
5542
5742
|
* Sets a new value for property {@link #getAlwaysShowContentHeader alwaysShowContentHeader}.
|
|
5543
5743
|
*
|
|
5544
5744
|
* Determines whether Header Content will always be expanded on desktop.
|
|
@@ -5550,6 +5750,8 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5550
5750
|
*
|
|
5551
5751
|
* Default value is `false`.
|
|
5552
5752
|
*
|
|
5753
|
+
* @since 1.34.0
|
|
5754
|
+
*
|
|
5553
5755
|
* @returns Reference to `this` in order to allow method chaining
|
|
5554
5756
|
*/
|
|
5555
5757
|
setAlwaysShowContentHeader(
|
|
@@ -5559,10 +5761,10 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5559
5761
|
bAlwaysShowContentHeader?: boolean
|
|
5560
5762
|
): this;
|
|
5561
5763
|
/**
|
|
5562
|
-
* @since 1.58
|
|
5563
|
-
*
|
|
5564
5764
|
* Sets the value of the `backgroundDesignAnchorBar` property.
|
|
5565
5765
|
*
|
|
5766
|
+
* @since 1.58
|
|
5767
|
+
*
|
|
5566
5768
|
* @returns `this` to allow method chaining
|
|
5567
5769
|
*/
|
|
5568
5770
|
setBackgroundDesignAnchorBar(
|
|
@@ -5582,6 +5784,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5582
5784
|
*
|
|
5583
5785
|
* Default value is `false`.
|
|
5584
5786
|
*
|
|
5787
|
+
*
|
|
5585
5788
|
* @returns Reference to `this` in order to allow method chaining
|
|
5586
5789
|
*/
|
|
5587
5790
|
setEnableLazyLoading(
|
|
@@ -5591,8 +5794,6 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5591
5794
|
bEnableLazyLoading?: boolean
|
|
5592
5795
|
): this;
|
|
5593
5796
|
/**
|
|
5594
|
-
* @since 1.34.0
|
|
5595
|
-
*
|
|
5596
5797
|
* Sets a new value for property {@link #getFlexEnabled flexEnabled}.
|
|
5597
5798
|
*
|
|
5598
5799
|
* Specifies whether the object page enables flexibility features, such as hiding and adding sections.
|
|
@@ -5602,6 +5803,8 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5602
5803
|
*
|
|
5603
5804
|
* Default value is `false`.
|
|
5604
5805
|
*
|
|
5806
|
+
* @since 1.34.0
|
|
5807
|
+
*
|
|
5605
5808
|
* @returns Reference to `this` in order to allow method chaining
|
|
5606
5809
|
*/
|
|
5607
5810
|
setFlexEnabled(
|
|
@@ -5611,10 +5814,10 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5611
5814
|
bFlexEnabled?: boolean
|
|
5612
5815
|
): this;
|
|
5613
5816
|
/**
|
|
5614
|
-
* @since 1.40
|
|
5615
|
-
*
|
|
5616
5817
|
* Sets the aggregated {@link #getFooter footer}.
|
|
5617
5818
|
*
|
|
5819
|
+
* @since 1.40
|
|
5820
|
+
*
|
|
5618
5821
|
* @returns Reference to `this` in order to allow method chaining
|
|
5619
5822
|
*/
|
|
5620
5823
|
setFooter(
|
|
@@ -5624,8 +5827,6 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5624
5827
|
oFooter: IBar
|
|
5625
5828
|
): this;
|
|
5626
5829
|
/**
|
|
5627
|
-
* @since 1.52
|
|
5628
|
-
*
|
|
5629
5830
|
* Sets a new value for property {@link #getHeaderContentPinnable headerContentPinnable}.
|
|
5630
5831
|
*
|
|
5631
5832
|
* Determines whether the Header Content area can be pinned.
|
|
@@ -5640,6 +5841,8 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5640
5841
|
*
|
|
5641
5842
|
* Default value is `true`.
|
|
5642
5843
|
*
|
|
5844
|
+
* @since 1.52
|
|
5845
|
+
*
|
|
5643
5846
|
* @returns Reference to `this` in order to allow method chaining
|
|
5644
5847
|
*/
|
|
5645
5848
|
setHeaderContentPinnable(
|
|
@@ -5649,8 +5852,6 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5649
5852
|
bHeaderContentPinnable?: boolean
|
|
5650
5853
|
): this;
|
|
5651
5854
|
/**
|
|
5652
|
-
* @since 1.93
|
|
5653
|
-
*
|
|
5654
5855
|
* Sets a new value for property {@link #getHeaderContentPinned headerContentPinned}.
|
|
5655
5856
|
*
|
|
5656
5857
|
* Determines whether the `sap.uxap.ObjectPageDynamicHeaderContent` is pinned.
|
|
@@ -5672,6 +5873,8 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5672
5873
|
*
|
|
5673
5874
|
* Default value is `false`.
|
|
5674
5875
|
*
|
|
5876
|
+
* @since 1.93
|
|
5877
|
+
*
|
|
5675
5878
|
* @returns Reference to `this` in order to allow method chaining
|
|
5676
5879
|
*/
|
|
5677
5880
|
setHeaderContentPinned(
|
|
@@ -5683,6 +5886,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5683
5886
|
/**
|
|
5684
5887
|
* Sets the aggregated {@link #getHeaderTitle headerTitle}.
|
|
5685
5888
|
*
|
|
5889
|
+
*
|
|
5686
5890
|
* @returns Reference to `this` in order to allow method chaining
|
|
5687
5891
|
*/
|
|
5688
5892
|
setHeaderTitle(
|
|
@@ -5700,6 +5904,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5700
5904
|
*
|
|
5701
5905
|
* Default value is `"100%"`.
|
|
5702
5906
|
*
|
|
5907
|
+
*
|
|
5703
5908
|
* @returns Reference to `this` in order to allow method chaining
|
|
5704
5909
|
*/
|
|
5705
5910
|
setHeight(
|
|
@@ -5709,8 +5914,6 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5709
5914
|
sHeight?: CSSSize
|
|
5710
5915
|
): this;
|
|
5711
5916
|
/**
|
|
5712
|
-
* @since 1.34.0
|
|
5713
|
-
*
|
|
5714
5917
|
* Sets a new value for property {@link #getIsChildPage isChildPage}.
|
|
5715
5918
|
*
|
|
5716
5919
|
* Determines whether the page is a child page and renders it with a different design. Child pages have
|
|
@@ -5723,6 +5926,8 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5723
5926
|
*
|
|
5724
5927
|
* Default value is `false`.
|
|
5725
5928
|
*
|
|
5929
|
+
* @since 1.34.0
|
|
5930
|
+
*
|
|
5726
5931
|
* @returns Reference to `this` in order to allow method chaining
|
|
5727
5932
|
*/
|
|
5728
5933
|
setIsChildPage(
|
|
@@ -5732,10 +5937,10 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5732
5937
|
bIsChildPage?: boolean
|
|
5733
5938
|
): this;
|
|
5734
5939
|
/**
|
|
5735
|
-
* @since 1.61
|
|
5736
|
-
*
|
|
5737
5940
|
* Sets the aggregated {@link #getLandmarkInfo landmarkInfo}.
|
|
5738
5941
|
*
|
|
5942
|
+
* @since 1.61
|
|
5943
|
+
*
|
|
5739
5944
|
* @returns Reference to `this` in order to allow method chaining
|
|
5740
5945
|
*/
|
|
5741
5946
|
setLandmarkInfo(
|
|
@@ -5745,8 +5950,6 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5745
5950
|
oLandmarkInfo: ObjectPageAccessibleLandmarkInfo
|
|
5746
5951
|
): this;
|
|
5747
5952
|
/**
|
|
5748
|
-
* @since 1.52
|
|
5749
|
-
*
|
|
5750
5953
|
* Sets a new value for property {@link #getPreserveHeaderStateOnScroll preserveHeaderStateOnScroll}.
|
|
5751
5954
|
*
|
|
5752
5955
|
* Preserves the current header state when scrolling. For example, if the user expands the header by clicking
|
|
@@ -5763,6 +5966,8 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5763
5966
|
*
|
|
5764
5967
|
* Default value is `false`.
|
|
5765
5968
|
*
|
|
5969
|
+
* @since 1.52
|
|
5970
|
+
*
|
|
5766
5971
|
* @returns Reference to `this` in order to allow method chaining
|
|
5767
5972
|
*/
|
|
5768
5973
|
setPreserveHeaderStateOnScroll(
|
|
@@ -5772,8 +5977,6 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5772
5977
|
bPreserveHeaderStateOnScroll?: boolean
|
|
5773
5978
|
): this;
|
|
5774
5979
|
/**
|
|
5775
|
-
* @since 1.44.0
|
|
5776
|
-
*
|
|
5777
5980
|
* Sets a new value for property {@link #getSectionTitleLevel sectionTitleLevel}.
|
|
5778
5981
|
*
|
|
5779
5982
|
* Determines the ARIA level of the `ObjectPageSection` and `ObjectPageSubSection` titles. The ARIA level
|
|
@@ -5800,6 +6003,8 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5800
6003
|
*
|
|
5801
6004
|
* Default value is `Auto`.
|
|
5802
6005
|
*
|
|
6006
|
+
* @since 1.44.0
|
|
6007
|
+
*
|
|
5803
6008
|
* @returns Reference to `this` in order to allow method chaining
|
|
5804
6009
|
*/
|
|
5805
6010
|
setSectionTitleLevel(
|
|
@@ -5820,6 +6025,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5820
6025
|
* **Note:** Updating the `selectedSection` with a value of `null` resets the `selectedSection` to the first
|
|
5821
6026
|
* visible section and scrolls the page to the top.
|
|
5822
6027
|
*
|
|
6028
|
+
*
|
|
5823
6029
|
* @returns Returns `this` to allow method chaining
|
|
5824
6030
|
*/
|
|
5825
6031
|
setSelectedSection(
|
|
@@ -5837,6 +6043,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5837
6043
|
*
|
|
5838
6044
|
* Default value is `true`.
|
|
5839
6045
|
*
|
|
6046
|
+
*
|
|
5840
6047
|
* @returns Reference to `this` in order to allow method chaining
|
|
5841
6048
|
*/
|
|
5842
6049
|
setShowAnchorBar(
|
|
@@ -5855,6 +6062,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5855
6062
|
*
|
|
5856
6063
|
* Default value is `true`.
|
|
5857
6064
|
*
|
|
6065
|
+
*
|
|
5858
6066
|
* @returns Reference to `this` in order to allow method chaining
|
|
5859
6067
|
*/
|
|
5860
6068
|
setShowAnchorBarPopover(
|
|
@@ -5864,8 +6072,6 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5864
6072
|
bShowAnchorBarPopover?: boolean
|
|
5865
6073
|
): this;
|
|
5866
6074
|
/**
|
|
5867
|
-
* @since 1.34.0
|
|
5868
|
-
*
|
|
5869
6075
|
* Sets a new value for property {@link #getShowEditHeaderButton showEditHeaderButton}.
|
|
5870
6076
|
*
|
|
5871
6077
|
* Determines whether an Edit button will be displayed in Header Content.
|
|
@@ -5877,6 +6083,8 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5877
6083
|
*
|
|
5878
6084
|
* Default value is `false`.
|
|
5879
6085
|
*
|
|
6086
|
+
* @since 1.34.0
|
|
6087
|
+
*
|
|
5880
6088
|
* @returns Reference to `this` in order to allow method chaining
|
|
5881
6089
|
*/
|
|
5882
6090
|
setShowEditHeaderButton(
|
|
@@ -5886,8 +6094,6 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5886
6094
|
bShowEditHeaderButton?: boolean
|
|
5887
6095
|
): this;
|
|
5888
6096
|
/**
|
|
5889
|
-
* @since 1.40
|
|
5890
|
-
*
|
|
5891
6097
|
* Sets a new value for property {@link #getShowFooter showFooter}.
|
|
5892
6098
|
*
|
|
5893
6099
|
* Determines whether the footer is visible.
|
|
@@ -5896,6 +6102,8 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5896
6102
|
*
|
|
5897
6103
|
* Default value is `false`.
|
|
5898
6104
|
*
|
|
6105
|
+
* @since 1.40
|
|
6106
|
+
*
|
|
5899
6107
|
* @returns Reference to `this` in order to allow method chaining
|
|
5900
6108
|
*/
|
|
5901
6109
|
setShowFooter(
|
|
@@ -5913,6 +6121,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5913
6121
|
*
|
|
5914
6122
|
* Default value is `true`.
|
|
5915
6123
|
*
|
|
6124
|
+
*
|
|
5916
6125
|
* @returns Reference to `this` in order to allow method chaining
|
|
5917
6126
|
*/
|
|
5918
6127
|
setShowHeaderContent(
|
|
@@ -5922,8 +6131,6 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5922
6131
|
bShowHeaderContent?: boolean
|
|
5923
6132
|
): this;
|
|
5924
6133
|
/**
|
|
5925
|
-
* @since 1.32.0
|
|
5926
|
-
*
|
|
5927
6134
|
* Sets a new value for property {@link #getShowOnlyHighImportance showOnlyHighImportance}.
|
|
5928
6135
|
*
|
|
5929
6136
|
* Determines whether sections and subsections with importance Low and Medium are hidden even on large screens.
|
|
@@ -5932,6 +6139,8 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5932
6139
|
*
|
|
5933
6140
|
* Default value is `false`.
|
|
5934
6141
|
*
|
|
6142
|
+
* @since 1.32.0
|
|
6143
|
+
*
|
|
5935
6144
|
* @returns Reference to `this` in order to allow method chaining
|
|
5936
6145
|
*/
|
|
5937
6146
|
setShowOnlyHighImportance(
|
|
@@ -5952,6 +6161,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5952
6161
|
*
|
|
5953
6162
|
* Default value is `false`.
|
|
5954
6163
|
*
|
|
6164
|
+
*
|
|
5955
6165
|
* @returns Reference to `this` in order to allow method chaining
|
|
5956
6166
|
*/
|
|
5957
6167
|
setShowTitleInHeaderContent(
|
|
@@ -5969,6 +6179,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5969
6179
|
*
|
|
5970
6180
|
* Default value is `TitleOnTop`.
|
|
5971
6181
|
*
|
|
6182
|
+
*
|
|
5972
6183
|
* @returns Reference to `this` in order to allow method chaining
|
|
5973
6184
|
*/
|
|
5974
6185
|
setSubSectionLayout(
|
|
@@ -5980,8 +6191,6 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5980
6191
|
| keyof typeof ObjectPageSubSectionLayout
|
|
5981
6192
|
): this;
|
|
5982
6193
|
/**
|
|
5983
|
-
* @since 1.52
|
|
5984
|
-
*
|
|
5985
6194
|
* Sets a new value for property {@link #getToggleHeaderOnTitleClick toggleHeaderOnTitleClick}.
|
|
5986
6195
|
*
|
|
5987
6196
|
* Determines whether the user can switch between the expanded/collapsed states of the `sap.uxap.ObjectPageDynamicHeaderContent`
|
|
@@ -5996,6 +6205,8 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
5996
6205
|
*
|
|
5997
6206
|
* Default value is `true`.
|
|
5998
6207
|
*
|
|
6208
|
+
* @since 1.52
|
|
6209
|
+
*
|
|
5999
6210
|
* @returns Reference to `this` in order to allow method chaining
|
|
6000
6211
|
*/
|
|
6001
6212
|
setToggleHeaderOnTitleClick(
|
|
@@ -6013,6 +6224,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
6013
6224
|
*
|
|
6014
6225
|
* Default value is `true`.
|
|
6015
6226
|
*
|
|
6227
|
+
*
|
|
6016
6228
|
* @returns Reference to `this` in order to allow method chaining
|
|
6017
6229
|
*/
|
|
6018
6230
|
setUpperCaseAnchorBar(
|
|
@@ -6033,6 +6245,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
6033
6245
|
*
|
|
6034
6246
|
* Default value is `false`.
|
|
6035
6247
|
*
|
|
6248
|
+
*
|
|
6036
6249
|
* @returns Reference to `this` in order to allow method chaining
|
|
6037
6250
|
*/
|
|
6038
6251
|
setUseIconTabBar(
|
|
@@ -6050,6 +6263,7 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
6050
6263
|
*
|
|
6051
6264
|
* Default value is `false`.
|
|
6052
6265
|
*
|
|
6266
|
+
*
|
|
6053
6267
|
* @returns Reference to `this` in order to allow method chaining
|
|
6054
6268
|
*/
|
|
6055
6269
|
setUseTwoColumnsForLargeScreen(
|
|
@@ -6078,12 +6292,12 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
6078
6292
|
upperCaseAnchorBar?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
6079
6293
|
|
|
6080
6294
|
/**
|
|
6081
|
-
* @since 1.58
|
|
6082
|
-
*
|
|
6083
6295
|
* Determines the background color of the `AnchorBar`.
|
|
6084
6296
|
*
|
|
6085
6297
|
* **Note:** The default value of `backgroundDesignAnchorBar` property is null. If the property is not set,
|
|
6086
6298
|
* the color of the background is `@sapUiObjectHeaderBackground`, which depends on the specific theme.
|
|
6299
|
+
*
|
|
6300
|
+
* @since 1.58
|
|
6087
6301
|
*/
|
|
6088
6302
|
backgroundDesignAnchorBar?:
|
|
6089
6303
|
| (BackgroundDesign | keyof typeof BackgroundDesign)
|
|
@@ -6109,8 +6323,6 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
6109
6323
|
| `{${string}}`;
|
|
6110
6324
|
|
|
6111
6325
|
/**
|
|
6112
|
-
* @since 1.44.0
|
|
6113
|
-
*
|
|
6114
6326
|
* Determines the ARIA level of the `ObjectPageSection` and `ObjectPageSubSection` titles. The ARIA level
|
|
6115
6327
|
* is used by assisting technologies, such as screen readers, to create a hierarchical site map for faster
|
|
6116
6328
|
* navigation.
|
|
@@ -6130,6 +6342,8 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
6130
6342
|
*
|
|
6131
6343
|
* - It is possible to define a `titleLevel` on `ObjectPageSection` or `ObjectPageSubSection` level.
|
|
6132
6344
|
* In this case the value of this property will be ignored.
|
|
6345
|
+
*
|
|
6346
|
+
* @since 1.44.0
|
|
6133
6347
|
*/
|
|
6134
6348
|
sectionTitleLevel?:
|
|
6135
6349
|
| (TitleLevel | keyof typeof TitleLevel)
|
|
@@ -6163,36 +6377,34 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
6163
6377
|
showTitleInHeaderContent?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
6164
6378
|
|
|
6165
6379
|
/**
|
|
6166
|
-
* @since 1.32.0
|
|
6167
|
-
*
|
|
6168
6380
|
* Determines whether sections and subsections with importance Low and Medium are hidden even on large screens.
|
|
6381
|
+
*
|
|
6382
|
+
* @since 1.32.0
|
|
6169
6383
|
*/
|
|
6170
6384
|
showOnlyHighImportance?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
6171
6385
|
|
|
6172
6386
|
/**
|
|
6173
|
-
* @since 1.34.0
|
|
6174
|
-
*
|
|
6175
6387
|
* Determines whether the page is a child page and renders it with a different design. Child pages have
|
|
6176
6388
|
* an additional (darker/lighter) stripe on the left side of their header content area.
|
|
6177
6389
|
*
|
|
6178
6390
|
* **Note**: This property is only taken into account if an instance of `sap.uxap.ObjectPageHeader` is used
|
|
6179
6391
|
* for the `headerTitle` aggregation.
|
|
6392
|
+
*
|
|
6393
|
+
* @since 1.34.0
|
|
6180
6394
|
*/
|
|
6181
6395
|
isChildPage?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
6182
6396
|
|
|
6183
6397
|
/**
|
|
6184
|
-
* @since 1.34.0
|
|
6185
|
-
*
|
|
6186
6398
|
* Determines whether Header Content will always be expanded on desktop.
|
|
6187
6399
|
*
|
|
6188
6400
|
* **Note**: This property is only taken into account if an instance of `sap.uxap.ObjectPageHeader` is used
|
|
6189
6401
|
* for the `headerTitle` aggregation.
|
|
6402
|
+
*
|
|
6403
|
+
* @since 1.34.0
|
|
6190
6404
|
*/
|
|
6191
6405
|
alwaysShowContentHeader?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
6192
6406
|
|
|
6193
6407
|
/**
|
|
6194
|
-
* @since 1.52
|
|
6195
|
-
*
|
|
6196
6408
|
* Determines whether the Header Content area can be pinned.
|
|
6197
6409
|
*
|
|
6198
6410
|
* When set to `true`, a pin button is displayed within the Header Content area. The pin button allows the
|
|
@@ -6200,12 +6412,12 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
6200
6412
|
*
|
|
6201
6413
|
* **Note:** This property is only taken into account if an instance of `sap.uxap.ObjectPageDynamicHeaderTitle`
|
|
6202
6414
|
* is used for the `headerTitle` aggregation.
|
|
6415
|
+
*
|
|
6416
|
+
* @since 1.52
|
|
6203
6417
|
*/
|
|
6204
6418
|
headerContentPinnable?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
6205
6419
|
|
|
6206
6420
|
/**
|
|
6207
|
-
* @since 1.93
|
|
6208
|
-
*
|
|
6209
6421
|
* Determines whether the `sap.uxap.ObjectPageDynamicHeaderContent` is pinned.
|
|
6210
6422
|
*
|
|
6211
6423
|
* The property can be changed explicitly with its setter or in the occurrence of the following user interactions:
|
|
@@ -6220,12 +6432,12 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
6220
6432
|
* - The `headerContentPinnable` property is `true`
|
|
6221
6433
|
* - The `sap.uxap.ObjectPageDynamicHeaderContent` is expanded
|
|
6222
6434
|
* - The `preserveHeaderStateOnScroll` property or the rules for it to work are `false`
|
|
6435
|
+
*
|
|
6436
|
+
* @since 1.93
|
|
6223
6437
|
*/
|
|
6224
6438
|
headerContentPinned?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
6225
6439
|
|
|
6226
6440
|
/**
|
|
6227
|
-
* @since 1.52
|
|
6228
|
-
*
|
|
6229
6441
|
* Determines whether the user can switch between the expanded/collapsed states of the `sap.uxap.ObjectPageDynamicHeaderContent`
|
|
6230
6442
|
* by clicking on the `sap.uxap.ObjectPageDynamicHeaderTitle`. If set to `false`, the `sap.uxap.ObjectPageDynamicHeaderTitle`
|
|
6231
6443
|
* is not clickable and the application must provide other means for expanding/collapsing the `sap.uxap.ObjectPageDynamicHeaderContent`,
|
|
@@ -6233,12 +6445,12 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
6233
6445
|
*
|
|
6234
6446
|
* **Note:** This property is only taken into account if an instance of `sap.uxap.ObjectPageDynamicHeaderTitle`
|
|
6235
6447
|
* is used for the `headerTitle` aggregation.
|
|
6448
|
+
*
|
|
6449
|
+
* @since 1.52
|
|
6236
6450
|
*/
|
|
6237
6451
|
toggleHeaderOnTitleClick?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
6238
6452
|
|
|
6239
6453
|
/**
|
|
6240
|
-
* @since 1.52
|
|
6241
|
-
*
|
|
6242
6454
|
* Preserves the current header state when scrolling. For example, if the user expands the header by clicking
|
|
6243
6455
|
* on the title and then scrolls down the page, the header will remain expanded.
|
|
6244
6456
|
*
|
|
@@ -6248,31 +6460,33 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
6248
6460
|
* - Based on internal rules, the value of the property is not always taken into account - for example,
|
|
6249
6461
|
* when the control is rendered on tablet or mobile and the control`s title and header are with height larger
|
|
6250
6462
|
* than the given threshold.
|
|
6463
|
+
*
|
|
6464
|
+
* @since 1.52
|
|
6251
6465
|
*/
|
|
6252
6466
|
preserveHeaderStateOnScroll?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
6253
6467
|
|
|
6254
6468
|
/**
|
|
6255
|
-
* @since 1.34.0
|
|
6256
|
-
*
|
|
6257
6469
|
* Determines whether an Edit button will be displayed in Header Content.
|
|
6258
6470
|
*
|
|
6259
6471
|
* **Note**: This property is only taken into account if an instance of `sap.uxap.ObjectPageHeader` is used
|
|
6260
6472
|
* for the `headerTitle` aggregation.
|
|
6473
|
+
*
|
|
6474
|
+
* @since 1.34.0
|
|
6261
6475
|
*/
|
|
6262
6476
|
showEditHeaderButton?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
6263
6477
|
|
|
6264
6478
|
/**
|
|
6265
|
-
* @since 1.34.0
|
|
6266
|
-
*
|
|
6267
6479
|
* Specifies whether the object page enables flexibility features, such as hiding and adding sections.
|
|
6268
6480
|
* For more information about SAPUI5 flexibility, refer to the Developer Guide.
|
|
6481
|
+
*
|
|
6482
|
+
* @since 1.34.0
|
|
6269
6483
|
*/
|
|
6270
6484
|
flexEnabled?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
6271
6485
|
|
|
6272
6486
|
/**
|
|
6273
|
-
* @since 1.40
|
|
6274
|
-
*
|
|
6275
6487
|
* Determines whether the footer is visible.
|
|
6488
|
+
*
|
|
6489
|
+
* @since 1.40
|
|
6276
6490
|
*/
|
|
6277
6491
|
showFooter?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
6278
6492
|
|
|
@@ -6300,32 +6514,32 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
6300
6514
|
| `{${string}}`;
|
|
6301
6515
|
|
|
6302
6516
|
/**
|
|
6303
|
-
* @since 1.40
|
|
6304
|
-
*
|
|
6305
6517
|
* Object page floating footer.
|
|
6518
|
+
*
|
|
6519
|
+
* @since 1.40
|
|
6306
6520
|
*/
|
|
6307
6521
|
footer?: IBar;
|
|
6308
6522
|
|
|
6309
6523
|
/**
|
|
6310
|
-
* @since 1.61
|
|
6311
|
-
*
|
|
6312
6524
|
* Accessible landmark settings to be applied on the containers of the `sap.uxap.ObjectPageLayout` control.
|
|
6313
6525
|
*
|
|
6314
6526
|
* If not set, no landmarks will be written.
|
|
6527
|
+
*
|
|
6528
|
+
* @since 1.61
|
|
6315
6529
|
*/
|
|
6316
6530
|
landmarkInfo?: ObjectPageAccessibleLandmarkInfo;
|
|
6317
6531
|
|
|
6318
6532
|
/**
|
|
6319
|
-
* @since 1.44.0
|
|
6320
|
-
*
|
|
6321
6533
|
* The section that is selected by default on load.
|
|
6534
|
+
*
|
|
6535
|
+
* @since 1.44.0
|
|
6322
6536
|
*/
|
|
6323
6537
|
selectedSection?: ObjectPageSection | string;
|
|
6324
6538
|
|
|
6325
6539
|
/**
|
|
6326
|
-
* @since 1.93
|
|
6327
|
-
*
|
|
6328
6540
|
* The event is fired when the `headerContentPinned` property is changed via user interaction.
|
|
6541
|
+
*
|
|
6542
|
+
* @since 1.93
|
|
6329
6543
|
*/
|
|
6330
6544
|
headerContentPinnedStateChange?: (
|
|
6331
6545
|
oEvent: ObjectPageLayout$HeaderContentPinnedStateChangeEvent
|
|
@@ -6337,9 +6551,9 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
6337
6551
|
toggleAnchorBar?: (oEvent: ObjectPageLayout$ToggleAnchorBarEvent) => void;
|
|
6338
6552
|
|
|
6339
6553
|
/**
|
|
6340
|
-
* @since 1.73
|
|
6341
|
-
*
|
|
6342
6554
|
* Fired when the current section is changed by scrolling.
|
|
6555
|
+
*
|
|
6556
|
+
* @since 1.73
|
|
6343
6557
|
*/
|
|
6344
6558
|
sectionChange?: (oEvent: ObjectPageLayout$SectionChangeEvent) => void;
|
|
6345
6559
|
|
|
@@ -6349,24 +6563,24 @@ declare module "sap/uxap/ObjectPageLayout" {
|
|
|
6349
6563
|
editHeaderButtonPress?: (oEvent: Event) => void;
|
|
6350
6564
|
|
|
6351
6565
|
/**
|
|
6352
|
-
* @since 1.118
|
|
6353
|
-
*
|
|
6354
6566
|
* The event is fired before the selected section is changed using the navigation. This event can be aborted
|
|
6355
6567
|
* by the application with preventDefault(), which means that there will be no navigation.
|
|
6568
|
+
*
|
|
6569
|
+
* @since 1.118
|
|
6356
6570
|
*/
|
|
6357
6571
|
beforeNavigate?: (oEvent: ObjectPageLayout$BeforeNavigateEvent) => void;
|
|
6358
6572
|
|
|
6359
6573
|
/**
|
|
6360
|
-
* @since 1.40
|
|
6361
|
-
*
|
|
6362
6574
|
* The event is fired when the selected section is changed using the navigation.
|
|
6575
|
+
*
|
|
6576
|
+
* @since 1.40
|
|
6363
6577
|
*/
|
|
6364
6578
|
navigate?: (oEvent: ObjectPageLayout$NavigateEvent) => void;
|
|
6365
6579
|
|
|
6366
6580
|
/**
|
|
6367
|
-
* @since 1.77
|
|
6368
|
-
*
|
|
6369
6581
|
* Fired when the visibility of subsections is changed.
|
|
6582
|
+
*
|
|
6583
|
+
* @since 1.77
|
|
6370
6584
|
*/
|
|
6371
6585
|
subSectionVisibilityChange?: (
|
|
6372
6586
|
oEvent: ObjectPageLayout$SubSectionVisibilityChangeEvent
|
|
@@ -6479,8 +6693,6 @@ declare module "sap/uxap/ObjectPageLazyLoader" {
|
|
|
6479
6693
|
import { AggregationBindingInfo } from "sap/ui/base/ManagedObject";
|
|
6480
6694
|
|
|
6481
6695
|
/**
|
|
6482
|
-
* @since 1.38
|
|
6483
|
-
*
|
|
6484
6696
|
* A helper element that enables a "stashed-based" lazy loading approach for the content of the {@link sap.uxap.ObjectPageSubSection }
|
|
6485
6697
|
* control.
|
|
6486
6698
|
*
|
|
@@ -6493,6 +6705,8 @@ declare module "sap/uxap/ObjectPageLazyLoader" {
|
|
|
6493
6705
|
* with `stashed=true` will make the content unstash automatically as the user scrolls.
|
|
6494
6706
|
*
|
|
6495
6707
|
* **Note:** Subsections are required to have an ID when used with `ObjectPageLazyLoader`.
|
|
6708
|
+
*
|
|
6709
|
+
* @since 1.38
|
|
6496
6710
|
*/
|
|
6497
6711
|
export default class ObjectPageLazyLoader extends UI5Element {
|
|
6498
6712
|
/**
|
|
@@ -6532,6 +6746,7 @@ declare module "sap/uxap/ObjectPageLazyLoader" {
|
|
|
6532
6746
|
*
|
|
6533
6747
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
|
|
6534
6748
|
*
|
|
6749
|
+
*
|
|
6535
6750
|
* @returns Created class / constructor function
|
|
6536
6751
|
*/
|
|
6537
6752
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -6552,12 +6767,14 @@ declare module "sap/uxap/ObjectPageLazyLoader" {
|
|
|
6552
6767
|
/**
|
|
6553
6768
|
* Returns a metadata object for class sap.uxap.ObjectPageLazyLoader.
|
|
6554
6769
|
*
|
|
6770
|
+
*
|
|
6555
6771
|
* @returns Metadata object describing this class
|
|
6556
6772
|
*/
|
|
6557
6773
|
static getMetadata(): ElementMetadata;
|
|
6558
6774
|
/**
|
|
6559
6775
|
* Adds some content to the aggregation {@link #getContent content}.
|
|
6560
6776
|
*
|
|
6777
|
+
*
|
|
6561
6778
|
* @returns Reference to `this` in order to allow method chaining
|
|
6562
6779
|
*/
|
|
6563
6780
|
addContent(
|
|
@@ -6569,6 +6786,7 @@ declare module "sap/uxap/ObjectPageLazyLoader" {
|
|
|
6569
6786
|
/**
|
|
6570
6787
|
* Destroys all the content in the aggregation {@link #getContent content}.
|
|
6571
6788
|
*
|
|
6789
|
+
*
|
|
6572
6790
|
* @returns Reference to `this` in order to allow method chaining
|
|
6573
6791
|
*/
|
|
6574
6792
|
destroyContent(): this;
|
|
@@ -6582,6 +6800,7 @@ declare module "sap/uxap/ObjectPageLazyLoader" {
|
|
|
6582
6800
|
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getContent content}. and returns
|
|
6583
6801
|
* its index if found or -1 otherwise.
|
|
6584
6802
|
*
|
|
6803
|
+
*
|
|
6585
6804
|
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
6586
6805
|
*/
|
|
6587
6806
|
indexOfContent(
|
|
@@ -6593,6 +6812,7 @@ declare module "sap/uxap/ObjectPageLazyLoader" {
|
|
|
6593
6812
|
/**
|
|
6594
6813
|
* Inserts a content into the aggregation {@link #getContent content}.
|
|
6595
6814
|
*
|
|
6815
|
+
*
|
|
6596
6816
|
* @returns Reference to `this` in order to allow method chaining
|
|
6597
6817
|
*/
|
|
6598
6818
|
insertContent(
|
|
@@ -6612,12 +6832,14 @@ declare module "sap/uxap/ObjectPageLazyLoader" {
|
|
|
6612
6832
|
*
|
|
6613
6833
|
* Additionally, it unregisters them from the hosting UIArea.
|
|
6614
6834
|
*
|
|
6835
|
+
*
|
|
6615
6836
|
* @returns An array of the removed elements (might be empty)
|
|
6616
6837
|
*/
|
|
6617
6838
|
removeAllContent(): Control[];
|
|
6618
6839
|
/**
|
|
6619
6840
|
* Removes a content from the aggregation {@link #getContent content}.
|
|
6620
6841
|
*
|
|
6842
|
+
*
|
|
6621
6843
|
* @returns The removed content or `null`
|
|
6622
6844
|
*/
|
|
6623
6845
|
removeContent(
|
|
@@ -6656,13 +6878,13 @@ declare module "sap/uxap/ObjectPageSection" {
|
|
|
6656
6878
|
} from "sap/ui/base/ManagedObject";
|
|
6657
6879
|
|
|
6658
6880
|
/**
|
|
6659
|
-
* @since 1.26
|
|
6660
|
-
*
|
|
6661
6881
|
* Top-level information container of an {@link sap.uxap.ObjectPageLayout}.
|
|
6662
6882
|
*
|
|
6663
6883
|
* The `ObjectPageSection`'s purpose is to aggregate subsections.
|
|
6664
6884
|
*
|
|
6665
6885
|
* **Note:** This control is intended to be used only as part of the `ObjectPageLayout`.
|
|
6886
|
+
*
|
|
6887
|
+
* @since 1.26
|
|
6666
6888
|
*/
|
|
6667
6889
|
export default class ObjectPageSection extends ObjectPageSectionBase {
|
|
6668
6890
|
/**
|
|
@@ -6702,6 +6924,7 @@ declare module "sap/uxap/ObjectPageSection" {
|
|
|
6702
6924
|
*
|
|
6703
6925
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.uxap.ObjectPageSectionBase.extend}.
|
|
6704
6926
|
*
|
|
6927
|
+
*
|
|
6705
6928
|
* @returns Created class / constructor function
|
|
6706
6929
|
*/
|
|
6707
6930
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -6722,12 +6945,14 @@ declare module "sap/uxap/ObjectPageSection" {
|
|
|
6722
6945
|
/**
|
|
6723
6946
|
* Returns a metadata object for class sap.uxap.ObjectPageSection.
|
|
6724
6947
|
*
|
|
6948
|
+
*
|
|
6725
6949
|
* @returns Metadata object describing this class
|
|
6726
6950
|
*/
|
|
6727
6951
|
static getMetadata(): ElementMetadata;
|
|
6728
6952
|
/**
|
|
6729
6953
|
* Adds some subSection to the aggregation {@link #getSubSections subSections}.
|
|
6730
6954
|
*
|
|
6955
|
+
*
|
|
6731
6956
|
* @returns Reference to `this` in order to allow method chaining
|
|
6732
6957
|
*/
|
|
6733
6958
|
addSubSection(
|
|
@@ -6737,34 +6962,35 @@ declare module "sap/uxap/ObjectPageSection" {
|
|
|
6737
6962
|
oSubSection: ObjectPageSubSection
|
|
6738
6963
|
): this;
|
|
6739
6964
|
/**
|
|
6740
|
-
* @since 1.106
|
|
6741
|
-
*
|
|
6742
6965
|
* Destroys the heading in the aggregation {@link #getHeading heading}.
|
|
6743
6966
|
*
|
|
6967
|
+
* @since 1.106
|
|
6968
|
+
*
|
|
6744
6969
|
* @returns Reference to `this` in order to allow method chaining
|
|
6745
6970
|
*/
|
|
6746
6971
|
destroyHeading(): this;
|
|
6747
6972
|
/**
|
|
6748
6973
|
* Destroys all the subSections in the aggregation {@link #getSubSections subSections}.
|
|
6749
6974
|
*
|
|
6975
|
+
*
|
|
6750
6976
|
* @returns Reference to `this` in order to allow method chaining
|
|
6751
6977
|
*/
|
|
6752
6978
|
destroySubSections(): this;
|
|
6753
6979
|
/**
|
|
6754
|
-
* @since 1.106
|
|
6755
|
-
*
|
|
6756
6980
|
* Gets content of aggregation {@link #getHeading heading}.
|
|
6757
6981
|
*
|
|
6758
6982
|
* Section heading content.
|
|
6759
6983
|
*
|
|
6760
6984
|
* Note: For some accessibility concerns we encourage you to use non-focusable elements.
|
|
6985
|
+
*
|
|
6986
|
+
* @since 1.106
|
|
6761
6987
|
*/
|
|
6762
6988
|
getHeading(): Control;
|
|
6763
6989
|
/**
|
|
6764
6990
|
* ID of the element which is the current target of the association {@link #getSelectedSubSection selectedSubSection},
|
|
6765
6991
|
* or `null`.
|
|
6766
6992
|
*/
|
|
6767
|
-
getSelectedSubSection(): ID;
|
|
6993
|
+
getSelectedSubSection(): ID | null;
|
|
6768
6994
|
/**
|
|
6769
6995
|
* Gets current value of property {@link #getShowTitle showTitle}.
|
|
6770
6996
|
*
|
|
@@ -6772,6 +6998,7 @@ declare module "sap/uxap/ObjectPageSection" {
|
|
|
6772
6998
|
*
|
|
6773
6999
|
* Default value is `true`.
|
|
6774
7000
|
*
|
|
7001
|
+
*
|
|
6775
7002
|
* @returns Value of property `showTitle`
|
|
6776
7003
|
*/
|
|
6777
7004
|
getShowTitle(): boolean;
|
|
@@ -6788,6 +7015,7 @@ declare module "sap/uxap/ObjectPageSection" {
|
|
|
6788
7015
|
*
|
|
6789
7016
|
* Default value is `true`.
|
|
6790
7017
|
*
|
|
7018
|
+
*
|
|
6791
7019
|
* @returns Value of property `titleUppercase`
|
|
6792
7020
|
*/
|
|
6793
7021
|
getTitleUppercase(): boolean;
|
|
@@ -6798,6 +7026,7 @@ declare module "sap/uxap/ObjectPageSection" {
|
|
|
6798
7026
|
*
|
|
6799
7027
|
* Default value is `false`.
|
|
6800
7028
|
*
|
|
7029
|
+
*
|
|
6801
7030
|
* @returns Value of property `wrapTitle`
|
|
6802
7031
|
*/
|
|
6803
7032
|
getWrapTitle(): boolean;
|
|
@@ -6805,6 +7034,7 @@ declare module "sap/uxap/ObjectPageSection" {
|
|
|
6805
7034
|
* Checks for the provided `sap.uxap.ObjectPageSubSection` in the aggregation {@link #getSubSections subSections}.
|
|
6806
7035
|
* and returns its index if found or -1 otherwise.
|
|
6807
7036
|
*
|
|
7037
|
+
*
|
|
6808
7038
|
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
6809
7039
|
*/
|
|
6810
7040
|
indexOfSubSection(
|
|
@@ -6816,6 +7046,7 @@ declare module "sap/uxap/ObjectPageSection" {
|
|
|
6816
7046
|
/**
|
|
6817
7047
|
* Inserts a subSection into the aggregation {@link #getSubSections subSections}.
|
|
6818
7048
|
*
|
|
7049
|
+
*
|
|
6819
7050
|
* @returns Reference to `this` in order to allow method chaining
|
|
6820
7051
|
*/
|
|
6821
7052
|
insertSubSection(
|
|
@@ -6835,12 +7066,14 @@ declare module "sap/uxap/ObjectPageSection" {
|
|
|
6835
7066
|
*
|
|
6836
7067
|
* Additionally, it unregisters them from the hosting UIArea.
|
|
6837
7068
|
*
|
|
7069
|
+
*
|
|
6838
7070
|
* @returns An array of the removed elements (might be empty)
|
|
6839
7071
|
*/
|
|
6840
7072
|
removeAllSubSections(): ObjectPageSubSection[];
|
|
6841
7073
|
/**
|
|
6842
7074
|
* Removes a subSection from the aggregation {@link #getSubSections subSections}.
|
|
6843
7075
|
*
|
|
7076
|
+
*
|
|
6844
7077
|
* @returns The removed subSection or `null`
|
|
6845
7078
|
*/
|
|
6846
7079
|
removeSubSection(
|
|
@@ -6850,10 +7083,10 @@ declare module "sap/uxap/ObjectPageSection" {
|
|
|
6850
7083
|
vSubSection: int | string | ObjectPageSubSection
|
|
6851
7084
|
): ObjectPageSubSection | null;
|
|
6852
7085
|
/**
|
|
6853
|
-
* @since 1.106
|
|
6854
|
-
*
|
|
6855
7086
|
* Sets the aggregated {@link #getHeading heading}.
|
|
6856
7087
|
*
|
|
7088
|
+
* @since 1.106
|
|
7089
|
+
*
|
|
6857
7090
|
* @returns Reference to `this` in order to allow method chaining
|
|
6858
7091
|
*/
|
|
6859
7092
|
setHeading(
|
|
@@ -6865,6 +7098,7 @@ declare module "sap/uxap/ObjectPageSection" {
|
|
|
6865
7098
|
/**
|
|
6866
7099
|
* Sets the associated {@link #getSelectedSubSection selectedSubSection}.
|
|
6867
7100
|
*
|
|
7101
|
+
*
|
|
6868
7102
|
* @returns Reference to `this` in order to allow method chaining
|
|
6869
7103
|
*/
|
|
6870
7104
|
setSelectedSubSection(
|
|
@@ -6883,6 +7117,7 @@ declare module "sap/uxap/ObjectPageSection" {
|
|
|
6883
7117
|
*
|
|
6884
7118
|
* Default value is `true`.
|
|
6885
7119
|
*
|
|
7120
|
+
*
|
|
6886
7121
|
* @returns Reference to `this` in order to allow method chaining
|
|
6887
7122
|
*/
|
|
6888
7123
|
setShowTitle(
|
|
@@ -6900,6 +7135,7 @@ declare module "sap/uxap/ObjectPageSection" {
|
|
|
6900
7135
|
*
|
|
6901
7136
|
* Default value is `true`.
|
|
6902
7137
|
*
|
|
7138
|
+
*
|
|
6903
7139
|
* @returns Reference to `this` in order to allow method chaining
|
|
6904
7140
|
*/
|
|
6905
7141
|
setTitleUppercase(
|
|
@@ -6917,6 +7153,7 @@ declare module "sap/uxap/ObjectPageSection" {
|
|
|
6917
7153
|
*
|
|
6918
7154
|
* Default value is `false`.
|
|
6919
7155
|
*
|
|
7156
|
+
*
|
|
6920
7157
|
* @returns Reference to `this` in order to allow method chaining
|
|
6921
7158
|
*/
|
|
6922
7159
|
setWrapTitle(
|
|
@@ -6954,11 +7191,11 @@ declare module "sap/uxap/ObjectPageSection" {
|
|
|
6954
7191
|
| `{${string}}`;
|
|
6955
7192
|
|
|
6956
7193
|
/**
|
|
6957
|
-
* @since 1.106
|
|
6958
|
-
*
|
|
6959
7194
|
* Section heading content.
|
|
6960
7195
|
*
|
|
6961
7196
|
* Note: For some accessibility concerns we encourage you to use non-focusable elements.
|
|
7197
|
+
*
|
|
7198
|
+
* @since 1.106
|
|
6962
7199
|
*/
|
|
6963
7200
|
heading?: Control;
|
|
6964
7201
|
|
|
@@ -6983,11 +7220,11 @@ declare module "sap/uxap/ObjectPageSectionBase" {
|
|
|
6983
7220
|
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
6984
7221
|
|
|
6985
7222
|
/**
|
|
6986
|
-
* @since 1.26
|
|
6987
|
-
*
|
|
6988
7223
|
* An abstract container for sections and subsections in the {@link sap.uxap.ObjectPageLayout}.
|
|
7224
|
+
*
|
|
7225
|
+
* @since 1.26
|
|
6989
7226
|
*/
|
|
6990
|
-
export default class ObjectPageSectionBase extends Control {
|
|
7227
|
+
export default abstract class ObjectPageSectionBase extends Control {
|
|
6991
7228
|
/**
|
|
6992
7229
|
* Constructor for a new `ObjectPageSectionBase`.
|
|
6993
7230
|
*
|
|
@@ -7025,6 +7262,7 @@ declare module "sap/uxap/ObjectPageSectionBase" {
|
|
|
7025
7262
|
*
|
|
7026
7263
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
|
|
7027
7264
|
*
|
|
7265
|
+
*
|
|
7028
7266
|
* @returns Created class / constructor function
|
|
7029
7267
|
*/
|
|
7030
7268
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -7045,6 +7283,7 @@ declare module "sap/uxap/ObjectPageSectionBase" {
|
|
|
7045
7283
|
/**
|
|
7046
7284
|
* Returns a metadata object for class sap.uxap.ObjectPageSectionBase.
|
|
7047
7285
|
*
|
|
7286
|
+
*
|
|
7048
7287
|
* @returns Metadata object describing this class
|
|
7049
7288
|
*/
|
|
7050
7289
|
static getMetadata(): ElementMetadata;
|
|
@@ -7055,6 +7294,7 @@ declare module "sap/uxap/ObjectPageSectionBase" {
|
|
|
7055
7294
|
/**
|
|
7056
7295
|
* Destroys the customAnchorBarButton in the aggregation {@link #getCustomAnchorBarButton customAnchorBarButton}.
|
|
7057
7296
|
*
|
|
7297
|
+
*
|
|
7058
7298
|
* @returns Reference to `this` in order to allow method chaining
|
|
7059
7299
|
*/
|
|
7060
7300
|
destroyCustomAnchorBarButton(): this;
|
|
@@ -7070,24 +7310,24 @@ declare module "sap/uxap/ObjectPageSectionBase" {
|
|
|
7070
7310
|
*/
|
|
7071
7311
|
getCustomAnchorBarButton(): Button;
|
|
7072
7312
|
/**
|
|
7073
|
-
* @since 1.32.0
|
|
7074
|
-
*
|
|
7075
7313
|
* Gets current value of property {@link #getImportance importance}.
|
|
7076
7314
|
*
|
|
7077
7315
|
* Determines whether the section will be hidden on low resolutions.
|
|
7078
7316
|
*
|
|
7079
7317
|
* Default value is `High`.
|
|
7080
7318
|
*
|
|
7319
|
+
* @since 1.32.0
|
|
7320
|
+
*
|
|
7081
7321
|
* @returns Value of property `importance`
|
|
7082
7322
|
*/
|
|
7083
7323
|
getImportance(): Importance | keyof typeof Importance;
|
|
7084
7324
|
/**
|
|
7085
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
7086
|
-
*
|
|
7087
7325
|
* Returns the control name text.
|
|
7088
7326
|
*
|
|
7089
7327
|
* To be overwritten by the specific control method.
|
|
7090
7328
|
*
|
|
7329
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
7330
|
+
*
|
|
7091
7331
|
* @returns control name text
|
|
7092
7332
|
*/
|
|
7093
7333
|
getSectionText(): string;
|
|
@@ -7100,12 +7340,11 @@ declare module "sap/uxap/ObjectPageSectionBase" {
|
|
|
7100
7340
|
* instead of the section title. This behavior is true even if the `showTitle` propeprty of {@link sap.uxap.ObjectPageSubSection }
|
|
7101
7341
|
* is set to `false`.
|
|
7102
7342
|
*
|
|
7343
|
+
*
|
|
7103
7344
|
* @returns Value of property `title`
|
|
7104
7345
|
*/
|
|
7105
7346
|
getTitle(): string;
|
|
7106
7347
|
/**
|
|
7107
|
-
* @since 1.44.0
|
|
7108
|
-
*
|
|
7109
7348
|
* Gets current value of property {@link #getTitleLevel titleLevel}.
|
|
7110
7349
|
*
|
|
7111
7350
|
* Determines the ARIA level of the `ObjectPageSectionBase` title. The ARIA level is used by assisting technologies,
|
|
@@ -7118,9 +7357,27 @@ declare module "sap/uxap/ObjectPageSectionBase" {
|
|
|
7118
7357
|
*
|
|
7119
7358
|
* Default value is `Auto`.
|
|
7120
7359
|
*
|
|
7360
|
+
* @since 1.44.0
|
|
7361
|
+
*
|
|
7121
7362
|
* @returns Value of property `titleLevel`
|
|
7122
7363
|
*/
|
|
7123
7364
|
getTitleLevel(): TitleLevel | keyof typeof TitleLevel;
|
|
7365
|
+
/**
|
|
7366
|
+
* Gets current value of property {@link #getTitleVisible titleVisible}.
|
|
7367
|
+
*
|
|
7368
|
+
* Defines the actual visibility of the title of `ObjectPageSectionBase`.
|
|
7369
|
+
*
|
|
7370
|
+
* **Note:** This property is read-only. The `ObjectPageSectionBase` updates it, according to internal rules,
|
|
7371
|
+
* based on UX specifications. You can only read the value of `titleVisible` property and use it in your
|
|
7372
|
+
* binding to determine the aria-levels of the inner Controls.
|
|
7373
|
+
*
|
|
7374
|
+
* Default value is `true`.
|
|
7375
|
+
*
|
|
7376
|
+
* @since 1.121.0
|
|
7377
|
+
*
|
|
7378
|
+
* @returns Value of property `titleVisible`
|
|
7379
|
+
*/
|
|
7380
|
+
getTitleVisible(): boolean;
|
|
7124
7381
|
/**
|
|
7125
7382
|
* Gets current value of property {@link #getVisible visible}.
|
|
7126
7383
|
*
|
|
@@ -7128,12 +7385,14 @@ declare module "sap/uxap/ObjectPageSectionBase" {
|
|
|
7128
7385
|
*
|
|
7129
7386
|
* Default value is `true`.
|
|
7130
7387
|
*
|
|
7388
|
+
*
|
|
7131
7389
|
* @returns Value of property `visible`
|
|
7132
7390
|
*/
|
|
7133
7391
|
getVisible(): boolean;
|
|
7134
7392
|
/**
|
|
7135
7393
|
* Sets the aggregated {@link #getCustomAnchorBarButton customAnchorBarButton}.
|
|
7136
7394
|
*
|
|
7395
|
+
*
|
|
7137
7396
|
* @returns Reference to `this` in order to allow method chaining
|
|
7138
7397
|
*/
|
|
7139
7398
|
setCustomAnchorBarButton(
|
|
@@ -7143,8 +7402,6 @@ declare module "sap/uxap/ObjectPageSectionBase" {
|
|
|
7143
7402
|
oCustomAnchorBarButton: Button
|
|
7144
7403
|
): this;
|
|
7145
7404
|
/**
|
|
7146
|
-
* @since 1.32.0
|
|
7147
|
-
*
|
|
7148
7405
|
* Sets a new value for property {@link #getImportance importance}.
|
|
7149
7406
|
*
|
|
7150
7407
|
* Determines whether the section will be hidden on low resolutions.
|
|
@@ -7153,6 +7410,8 @@ declare module "sap/uxap/ObjectPageSectionBase" {
|
|
|
7153
7410
|
*
|
|
7154
7411
|
* Default value is `High`.
|
|
7155
7412
|
*
|
|
7413
|
+
* @since 1.32.0
|
|
7414
|
+
*
|
|
7156
7415
|
* @returns Reference to `this` in order to allow method chaining
|
|
7157
7416
|
*/
|
|
7158
7417
|
setImportance(
|
|
@@ -7172,6 +7431,7 @@ declare module "sap/uxap/ObjectPageSectionBase" {
|
|
|
7172
7431
|
*
|
|
7173
7432
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
7174
7433
|
*
|
|
7434
|
+
*
|
|
7175
7435
|
* @returns Reference to `this` in order to allow method chaining
|
|
7176
7436
|
*/
|
|
7177
7437
|
setTitle(
|
|
@@ -7181,8 +7441,6 @@ declare module "sap/uxap/ObjectPageSectionBase" {
|
|
|
7181
7441
|
sTitle?: string
|
|
7182
7442
|
): this;
|
|
7183
7443
|
/**
|
|
7184
|
-
* @since 1.44.0
|
|
7185
|
-
*
|
|
7186
7444
|
* Sets a new value for property {@link #getTitleLevel titleLevel}.
|
|
7187
7445
|
*
|
|
7188
7446
|
* Determines the ARIA level of the `ObjectPageSectionBase` title. The ARIA level is used by assisting technologies,
|
|
@@ -7197,6 +7455,8 @@ declare module "sap/uxap/ObjectPageSectionBase" {
|
|
|
7197
7455
|
*
|
|
7198
7456
|
* Default value is `Auto`.
|
|
7199
7457
|
*
|
|
7458
|
+
* @since 1.44.0
|
|
7459
|
+
*
|
|
7200
7460
|
* @returns Reference to `this` in order to allow method chaining
|
|
7201
7461
|
*/
|
|
7202
7462
|
setTitleLevel(
|
|
@@ -7205,6 +7465,12 @@ declare module "sap/uxap/ObjectPageSectionBase" {
|
|
|
7205
7465
|
*/
|
|
7206
7466
|
sTitleLevel?: TitleLevel | keyof typeof TitleLevel
|
|
7207
7467
|
): this;
|
|
7468
|
+
/**
|
|
7469
|
+
* Sets title visibility
|
|
7470
|
+
*
|
|
7471
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
7472
|
+
*/
|
|
7473
|
+
setTitleVisible(bVisible: boolean): void;
|
|
7208
7474
|
/**
|
|
7209
7475
|
* Sets a new value for property {@link #getVisible visible}.
|
|
7210
7476
|
*
|
|
@@ -7214,6 +7480,7 @@ declare module "sap/uxap/ObjectPageSectionBase" {
|
|
|
7214
7480
|
*
|
|
7215
7481
|
* Default value is `true`.
|
|
7216
7482
|
*
|
|
7483
|
+
*
|
|
7217
7484
|
* @returns Reference to `this` in order to allow method chaining
|
|
7218
7485
|
*/
|
|
7219
7486
|
setVisible(
|
|
@@ -7223,11 +7490,11 @@ declare module "sap/uxap/ObjectPageSectionBase" {
|
|
|
7223
7490
|
bVisible?: boolean
|
|
7224
7491
|
): this;
|
|
7225
7492
|
/**
|
|
7226
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
7227
|
-
*
|
|
7228
7493
|
* Performs the update of the invisible text label. This method is called for example when the section title
|
|
7229
7494
|
* is changed.
|
|
7230
7495
|
*
|
|
7496
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
7497
|
+
*
|
|
7231
7498
|
* @returns this for chaining
|
|
7232
7499
|
*/
|
|
7233
7500
|
updateInvisibleTextLabelValue(): this;
|
|
@@ -7244,8 +7511,6 @@ declare module "sap/uxap/ObjectPageSectionBase" {
|
|
|
7244
7511
|
title?: string | PropertyBindingInfo;
|
|
7245
7512
|
|
|
7246
7513
|
/**
|
|
7247
|
-
* @since 1.44.0
|
|
7248
|
-
*
|
|
7249
7514
|
* Determines the ARIA level of the `ObjectPageSectionBase` title. The ARIA level is used by assisting technologies,
|
|
7250
7515
|
* such as screen readers, to create a hierarchical site map for faster navigation.
|
|
7251
7516
|
*
|
|
@@ -7253,6 +7518,8 @@ declare module "sap/uxap/ObjectPageSectionBase" {
|
|
|
7253
7518
|
* `ObjectPageSectionBase` title HTML tag from H1 to H6.
|
|
7254
7519
|
* For example: if `titleLevel` is `TitleLevel.H1`, it will result as aria-level of 1 added to the `ObjectPageSectionBase`
|
|
7255
7520
|
* title.
|
|
7521
|
+
*
|
|
7522
|
+
* @since 1.44.0
|
|
7256
7523
|
*/
|
|
7257
7524
|
titleLevel?:
|
|
7258
7525
|
| (TitleLevel | keyof typeof TitleLevel)
|
|
@@ -7265,9 +7532,20 @@ declare module "sap/uxap/ObjectPageSectionBase" {
|
|
|
7265
7532
|
visible?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
7266
7533
|
|
|
7267
7534
|
/**
|
|
7268
|
-
*
|
|
7535
|
+
* Defines the actual visibility of the title of `ObjectPageSectionBase`.
|
|
7536
|
+
*
|
|
7537
|
+
* **Note:** This property is read-only. The `ObjectPageSectionBase` updates it, according to internal rules,
|
|
7538
|
+
* based on UX specifications. You can only read the value of `titleVisible` property and use it in your
|
|
7539
|
+
* binding to determine the aria-levels of the inner Controls.
|
|
7269
7540
|
*
|
|
7541
|
+
* @since 1.121.0
|
|
7542
|
+
*/
|
|
7543
|
+
titleVisible?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
7544
|
+
|
|
7545
|
+
/**
|
|
7270
7546
|
* Determines whether the section will be hidden on low resolutions.
|
|
7547
|
+
*
|
|
7548
|
+
* @since 1.32.0
|
|
7271
7549
|
*/
|
|
7272
7550
|
importance?:
|
|
7273
7551
|
| (Importance | keyof typeof Importance)
|
|
@@ -7306,8 +7584,6 @@ declare module "sap/uxap/ObjectPageSubSection" {
|
|
|
7306
7584
|
} from "sap/ui/base/ManagedObject";
|
|
7307
7585
|
|
|
7308
7586
|
/**
|
|
7309
|
-
* @since 1.26
|
|
7310
|
-
*
|
|
7311
7587
|
* Second-level information container of an {@link sap.uxap.ObjectPageLayout}.
|
|
7312
7588
|
*
|
|
7313
7589
|
* An `ObjectPageSubSection` may only be used within sections in the `ObjectPageLayout`. Subsections are
|
|
@@ -7321,6 +7597,8 @@ declare module "sap/uxap/ObjectPageSubSection" {
|
|
|
7321
7597
|
* `visibleRowCountMode` set to `Auto`.
|
|
7322
7598
|
*
|
|
7323
7599
|
* **Note:** This control is intended to be used only as part of the `ObjectPageLayout`.
|
|
7600
|
+
*
|
|
7601
|
+
* @since 1.26
|
|
7324
7602
|
*/
|
|
7325
7603
|
export default class ObjectPageSubSection extends ObjectPageSectionBase {
|
|
7326
7604
|
/**
|
|
@@ -7360,6 +7638,7 @@ declare module "sap/uxap/ObjectPageSubSection" {
|
|
|
7360
7638
|
*
|
|
7361
7639
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.uxap.ObjectPageSectionBase.extend}.
|
|
7362
7640
|
*
|
|
7641
|
+
*
|
|
7363
7642
|
* @returns Created class / constructor function
|
|
7364
7643
|
*/
|
|
7365
7644
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -7380,12 +7659,14 @@ declare module "sap/uxap/ObjectPageSubSection" {
|
|
|
7380
7659
|
/**
|
|
7381
7660
|
* Returns a metadata object for class sap.uxap.ObjectPageSubSection.
|
|
7382
7661
|
*
|
|
7662
|
+
*
|
|
7383
7663
|
* @returns Metadata object describing this class
|
|
7384
7664
|
*/
|
|
7385
7665
|
static getMetadata(): ElementMetadata;
|
|
7386
7666
|
/**
|
|
7387
7667
|
* Adds some action to the aggregation {@link #getActions actions}.
|
|
7388
7668
|
*
|
|
7669
|
+
*
|
|
7389
7670
|
* @returns Reference to `this` in order to allow method chaining
|
|
7390
7671
|
*/
|
|
7391
7672
|
addAction(
|
|
@@ -7397,6 +7678,7 @@ declare module "sap/uxap/ObjectPageSubSection" {
|
|
|
7397
7678
|
/**
|
|
7398
7679
|
* Adds some block to the aggregation {@link #getBlocks blocks}.
|
|
7399
7680
|
*
|
|
7681
|
+
*
|
|
7400
7682
|
* @returns Reference to `this` in order to allow method chaining
|
|
7401
7683
|
*/
|
|
7402
7684
|
addBlock(
|
|
@@ -7408,6 +7690,7 @@ declare module "sap/uxap/ObjectPageSubSection" {
|
|
|
7408
7690
|
/**
|
|
7409
7691
|
* Adds some moreBlock to the aggregation {@link #getMoreBlocks moreBlocks}.
|
|
7410
7692
|
*
|
|
7693
|
+
*
|
|
7411
7694
|
* @returns Reference to `this` in order to allow method chaining
|
|
7412
7695
|
*/
|
|
7413
7696
|
addMoreBlock(
|
|
@@ -7419,18 +7702,21 @@ declare module "sap/uxap/ObjectPageSubSection" {
|
|
|
7419
7702
|
/**
|
|
7420
7703
|
* Destroys all the actions in the aggregation {@link #getActions actions}.
|
|
7421
7704
|
*
|
|
7705
|
+
*
|
|
7422
7706
|
* @returns Reference to `this` in order to allow method chaining
|
|
7423
7707
|
*/
|
|
7424
7708
|
destroyActions(): this;
|
|
7425
7709
|
/**
|
|
7426
7710
|
* Destroys all the blocks in the aggregation {@link #getBlocks blocks}.
|
|
7427
7711
|
*
|
|
7712
|
+
*
|
|
7428
7713
|
* @returns Reference to `this` in order to allow method chaining
|
|
7429
7714
|
*/
|
|
7430
7715
|
destroyBlocks(): this;
|
|
7431
7716
|
/**
|
|
7432
7717
|
* Destroys all the moreBlocks in the aggregation {@link #getMoreBlocks moreBlocks}.
|
|
7433
7718
|
*
|
|
7719
|
+
*
|
|
7434
7720
|
* @returns Reference to `this` in order to allow method chaining
|
|
7435
7721
|
*/
|
|
7436
7722
|
destroyMoreBlocks(): this;
|
|
@@ -7480,6 +7766,7 @@ declare module "sap/uxap/ObjectPageSubSection" {
|
|
|
7480
7766
|
*
|
|
7481
7767
|
* Default value is `Collapsed`.
|
|
7482
7768
|
*
|
|
7769
|
+
*
|
|
7483
7770
|
* @returns Value of property `mode`
|
|
7484
7771
|
*/
|
|
7485
7772
|
getMode(): ObjectPageSubSectionMode | keyof typeof ObjectPageSubSectionMode;
|
|
@@ -7490,8 +7777,6 @@ declare module "sap/uxap/ObjectPageSubSection" {
|
|
|
7490
7777
|
*/
|
|
7491
7778
|
getMoreBlocks(): Control[];
|
|
7492
7779
|
/**
|
|
7493
|
-
* @since 1.77
|
|
7494
|
-
*
|
|
7495
7780
|
* Gets current value of property {@link #getShowTitle showTitle}.
|
|
7496
7781
|
*
|
|
7497
7782
|
* Determines whether to display the `SubSection` title or not.
|
|
@@ -7503,6 +7788,8 @@ declare module "sap/uxap/ObjectPageSubSection" {
|
|
|
7503
7788
|
*
|
|
7504
7789
|
* Default value is `true`.
|
|
7505
7790
|
*
|
|
7791
|
+
* @since 1.77
|
|
7792
|
+
*
|
|
7506
7793
|
* @returns Value of property `showTitle`
|
|
7507
7794
|
*/
|
|
7508
7795
|
getShowTitle(): boolean;
|
|
@@ -7513,6 +7800,7 @@ declare module "sap/uxap/ObjectPageSubSection" {
|
|
|
7513
7800
|
*
|
|
7514
7801
|
* Default value is `false`.
|
|
7515
7802
|
*
|
|
7803
|
+
*
|
|
7516
7804
|
* @returns Value of property `titleUppercase`
|
|
7517
7805
|
*/
|
|
7518
7806
|
getTitleUppercase(): boolean;
|
|
@@ -7520,6 +7808,7 @@ declare module "sap/uxap/ObjectPageSubSection" {
|
|
|
7520
7808
|
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getActions actions}. and returns
|
|
7521
7809
|
* its index if found or -1 otherwise.
|
|
7522
7810
|
*
|
|
7811
|
+
*
|
|
7523
7812
|
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
7524
7813
|
*/
|
|
7525
7814
|
indexOfAction(
|
|
@@ -7532,6 +7821,7 @@ declare module "sap/uxap/ObjectPageSubSection" {
|
|
|
7532
7821
|
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getBlocks blocks}. and returns
|
|
7533
7822
|
* its index if found or -1 otherwise.
|
|
7534
7823
|
*
|
|
7824
|
+
*
|
|
7535
7825
|
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
7536
7826
|
*/
|
|
7537
7827
|
indexOfBlock(
|
|
@@ -7544,6 +7834,7 @@ declare module "sap/uxap/ObjectPageSubSection" {
|
|
|
7544
7834
|
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getMoreBlocks moreBlocks}. and
|
|
7545
7835
|
* returns its index if found or -1 otherwise.
|
|
7546
7836
|
*
|
|
7837
|
+
*
|
|
7547
7838
|
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
7548
7839
|
*/
|
|
7549
7840
|
indexOfMoreBlock(
|
|
@@ -7555,6 +7846,7 @@ declare module "sap/uxap/ObjectPageSubSection" {
|
|
|
7555
7846
|
/**
|
|
7556
7847
|
* Inserts a action into the aggregation {@link #getActions actions}.
|
|
7557
7848
|
*
|
|
7849
|
+
*
|
|
7558
7850
|
* @returns Reference to `this` in order to allow method chaining
|
|
7559
7851
|
*/
|
|
7560
7852
|
insertAction(
|
|
@@ -7575,6 +7867,7 @@ declare module "sap/uxap/ObjectPageSubSection" {
|
|
|
7575
7867
|
* **Note:** The `insertBlock` method is not supported by design. If used, it works as an `addBlock`, adding
|
|
7576
7868
|
* a single block to the end of the `blocks` aggregation.
|
|
7577
7869
|
*
|
|
7870
|
+
*
|
|
7578
7871
|
* @returns The `sap.uxap.ObjectPageSubSection` instance
|
|
7579
7872
|
*/
|
|
7580
7873
|
insertBlock(
|
|
@@ -7593,6 +7886,7 @@ declare module "sap/uxap/ObjectPageSubSection" {
|
|
|
7593
7886
|
* **Note:** The `insertMoreBlock` method is not supported by design. If used, it works as an `addMoreBlock`,
|
|
7594
7887
|
* adding a single block to the end of the `moreBlocks` aggregation.
|
|
7595
7888
|
*
|
|
7889
|
+
*
|
|
7596
7890
|
* @returns The `sap.uxap.ObjectPageSubSection` instance
|
|
7597
7891
|
*/
|
|
7598
7892
|
insertMoreBlock(
|
|
@@ -7608,6 +7902,7 @@ declare module "sap/uxap/ObjectPageSubSection" {
|
|
|
7608
7902
|
/**
|
|
7609
7903
|
* Removes a action from the aggregation {@link #getActions actions}.
|
|
7610
7904
|
*
|
|
7905
|
+
*
|
|
7611
7906
|
* @returns The removed action or `null`
|
|
7612
7907
|
*/
|
|
7613
7908
|
removeAction(
|
|
@@ -7621,6 +7916,7 @@ declare module "sap/uxap/ObjectPageSubSection" {
|
|
|
7621
7916
|
*
|
|
7622
7917
|
* Additionally, it unregisters them from the hosting UIArea.
|
|
7623
7918
|
*
|
|
7919
|
+
*
|
|
7624
7920
|
* @returns An array of the removed elements (might be empty)
|
|
7625
7921
|
*/
|
|
7626
7922
|
removeAllActions(): Control[];
|
|
@@ -7629,6 +7925,7 @@ declare module "sap/uxap/ObjectPageSubSection" {
|
|
|
7629
7925
|
*
|
|
7630
7926
|
* Additionally, it unregisters them from the hosting UIArea.
|
|
7631
7927
|
*
|
|
7928
|
+
*
|
|
7632
7929
|
* @returns An array of the removed elements (might be empty)
|
|
7633
7930
|
*/
|
|
7634
7931
|
removeAllBlocks(): Control[];
|
|
@@ -7637,12 +7934,14 @@ declare module "sap/uxap/ObjectPageSubSection" {
|
|
|
7637
7934
|
*
|
|
7638
7935
|
* Additionally, it unregisters them from the hosting UIArea.
|
|
7639
7936
|
*
|
|
7937
|
+
*
|
|
7640
7938
|
* @returns An array of the removed elements (might be empty)
|
|
7641
7939
|
*/
|
|
7642
7940
|
removeAllMoreBlocks(): Control[];
|
|
7643
7941
|
/**
|
|
7644
7942
|
* Removes a block from the aggregation {@link #getBlocks blocks}.
|
|
7645
7943
|
*
|
|
7944
|
+
*
|
|
7646
7945
|
* @returns The removed block or `null`
|
|
7647
7946
|
*/
|
|
7648
7947
|
removeBlock(
|
|
@@ -7654,6 +7953,7 @@ declare module "sap/uxap/ObjectPageSubSection" {
|
|
|
7654
7953
|
/**
|
|
7655
7954
|
* Removes a moreBlock from the aggregation {@link #getMoreBlocks moreBlocks}.
|
|
7656
7955
|
*
|
|
7956
|
+
*
|
|
7657
7957
|
* @returns The removed moreBlock or `null`
|
|
7658
7958
|
*/
|
|
7659
7959
|
removeMoreBlock(
|
|
@@ -7672,6 +7972,7 @@ declare module "sap/uxap/ObjectPageSubSection" {
|
|
|
7672
7972
|
*
|
|
7673
7973
|
* Default value is `Collapsed`.
|
|
7674
7974
|
*
|
|
7975
|
+
*
|
|
7675
7976
|
* @returns Reference to `this` in order to allow method chaining
|
|
7676
7977
|
*/
|
|
7677
7978
|
setMode(
|
|
@@ -7681,8 +7982,6 @@ declare module "sap/uxap/ObjectPageSubSection" {
|
|
|
7681
7982
|
sMode?: ObjectPageSubSectionMode | keyof typeof ObjectPageSubSectionMode
|
|
7682
7983
|
): this;
|
|
7683
7984
|
/**
|
|
7684
|
-
* @since 1.77
|
|
7685
|
-
*
|
|
7686
7985
|
* Sets a new value for property {@link #getShowTitle showTitle}.
|
|
7687
7986
|
*
|
|
7688
7987
|
* Determines whether to display the `SubSection` title or not.
|
|
@@ -7696,6 +7995,8 @@ declare module "sap/uxap/ObjectPageSubSection" {
|
|
|
7696
7995
|
*
|
|
7697
7996
|
* Default value is `true`.
|
|
7698
7997
|
*
|
|
7998
|
+
* @since 1.77
|
|
7999
|
+
*
|
|
7699
8000
|
* @returns Reference to `this` in order to allow method chaining
|
|
7700
8001
|
*/
|
|
7701
8002
|
setShowTitle(
|
|
@@ -7713,6 +8014,7 @@ declare module "sap/uxap/ObjectPageSubSection" {
|
|
|
7713
8014
|
*
|
|
7714
8015
|
* Default value is `false`.
|
|
7715
8016
|
*
|
|
8017
|
+
*
|
|
7716
8018
|
* @returns Reference to `this` in order to allow method chaining
|
|
7717
8019
|
*/
|
|
7718
8020
|
setTitleUppercase(
|
|
@@ -7726,14 +8028,14 @@ declare module "sap/uxap/ObjectPageSubSection" {
|
|
|
7726
8028
|
export interface $ObjectPageSubSectionSettings
|
|
7727
8029
|
extends $ObjectPageSectionBaseSettings {
|
|
7728
8030
|
/**
|
|
7729
|
-
* @since 1.77
|
|
7730
|
-
*
|
|
7731
8031
|
* Determines whether to display the `SubSection` title or not.
|
|
7732
8032
|
*
|
|
7733
8033
|
* **Note:** If a subsection is the only one (or the only one visible) within a section, its title is displayed
|
|
7734
8034
|
* instead of the section title even if this property is set to `false`. To hide the title of a subsection
|
|
7735
8035
|
* which is the only one (or the only one visible), you need to set the `showTitle` properties to `false`
|
|
7736
8036
|
* for both the section and its subsection.
|
|
8037
|
+
*
|
|
8038
|
+
* @since 1.77
|
|
7737
8039
|
*/
|
|
7738
8040
|
showTitle?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
7739
8041
|
|