@openui5/ts-types-esm 1.146.0 → 1.147.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.
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.146.0
1
+ // For Library Version: 1.147.0
2
2
 
3
3
  declare module "sap/ui/integration/library" {
4
4
  import { URI } from "sap/ui/core/library";
@@ -1449,11 +1449,15 @@ declare module "sap/ui/integration/widgets/Card" {
1449
1449
  /**
1450
1450
  * Gets current value of property {@link #getBaseUrl baseUrl}.
1451
1451
  *
1452
- * Defines the base URL of the card manifest. It should be used when manifest property is an object instead
1453
- * of a URL. If both manifest URL and base URL are defined - the base URL will be used for loading dependencies.
1454
- * If both manifest URL and base URL are not defined - relative resources might not be loaded correctly.
1452
+ * Defines the base URL of the card manifest. It must be provided when the manifest is an object and not
1453
+ * a URL. The base URL is used to load relatively referenced resources.
1454
+ *
1455
+ * If the base URL is not defined and the manifest URL is defined, the manifest URL is used as the base
1456
+ * URL.
1457
+ * - If both the manifest URL and the base URL are defined, the base URL is used.
1458
+ * - If neither the manifest URL nor the base URL is defined, relative resources will not load correctly.
1459
+ *
1455
1460
  *
1456
- * @experimental As of version 1.70.
1457
1461
  *
1458
1462
  * @returns Value of property `baseUrl`
1459
1463
  */
@@ -1878,13 +1882,17 @@ declare module "sap/ui/integration/widgets/Card" {
1878
1882
  /**
1879
1883
  * Sets a new value for property {@link #getBaseUrl baseUrl}.
1880
1884
  *
1881
- * Defines the base URL of the card manifest. It should be used when manifest property is an object instead
1882
- * of a URL. If both manifest URL and base URL are defined - the base URL will be used for loading dependencies.
1883
- * If both manifest URL and base URL are not defined - relative resources might not be loaded correctly.
1885
+ * Defines the base URL of the card manifest. It must be provided when the manifest is an object and not
1886
+ * a URL. The base URL is used to load relatively referenced resources.
1887
+ *
1888
+ * If the base URL is not defined and the manifest URL is defined, the manifest URL is used as the base
1889
+ * URL.
1890
+ * - If both the manifest URL and the base URL are defined, the base URL is used.
1891
+ * - If neither the manifest URL nor the base URL is defined, relative resources will not load correctly.
1892
+ *
1884
1893
  *
1885
1894
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1886
1895
  *
1887
- * @experimental As of version 1.70.
1888
1896
  *
1889
1897
  * @returns Reference to `this` in order to allow method chaining
1890
1898
  */
@@ -2248,18 +2256,6 @@ declare module "sap/ui/integration/widgets/Card" {
2248
2256
  * @experimental As of version 1.85.
2249
2257
  */
2250
2258
  getActionDefinitions(): ActionDefinition[];
2251
- /**
2252
- * Gets current value of property {@link #getBaseUrl baseUrl}.
2253
- *
2254
- * Defines the base URL of the card manifest. It should be used when manifest property is an object instead
2255
- * of a URL. If both manifest URL and base URL are defined - the base URL will be used for loading dependencies.
2256
- * If both manifest URL and base URL are not defined - relative resources might not be loaded correctly.
2257
- *
2258
- * @experimental As of version 1.70.
2259
- *
2260
- * @returns Value of property `baseUrl`
2261
- */
2262
- getBaseUrl(): URI;
2263
2259
  /**
2264
2260
  * Get information about the blocking message in the card.
2265
2261
  *
@@ -2632,11 +2628,13 @@ declare module "sap/ui/integration/widgets/Card" {
2632
2628
  | `{${string}}`;
2633
2629
 
2634
2630
  /**
2635
- * Defines the base URL of the card manifest. It should be used when manifest property is an object instead
2636
- * of a URL. If both manifest URL and base URL are defined - the base URL will be used for loading dependencies.
2637
- * If both manifest URL and base URL are not defined - relative resources might not be loaded correctly.
2631
+ * Defines the base URL of the card manifest. It must be provided when the manifest is an object and not
2632
+ * a URL. The base URL is used to load relatively referenced resources.
2638
2633
  *
2639
- * @experimental As of version 1.70.
2634
+ * If the base URL is not defined and the manifest URL is defined, the manifest URL is used as the base
2635
+ * URL.
2636
+ * - If both the manifest URL and the base URL are defined, the base URL is used.
2637
+ * - If neither the manifest URL nor the base URL is defined, relative resources will not load correctly.
2640
2638
  */
2641
2639
  baseUrl?: URI | PropertyBindingInfo | `{${string}}`;
2642
2640
 
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.146.0
1
+ // For Library Version: 1.147.0
2
2
 
3
3
  declare module "sap/ui/layout/library" {
4
4
  import Control from "sap/ui/core/Control";
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.146.0
1
+ // For Library Version: 1.147.0
2
2
 
3
3
  declare module "sap/ui/mdc/AggregationBaseDelegate" {
4
4
  import BaseDelegate from "sap/ui/mdc/BaseDelegate";
@@ -3767,6 +3767,17 @@ declare module "sap/ui/mdc/library" {
3767
3767
 
3768
3768
  import ParseException from "sap/ui/model/ParseException";
3769
3769
 
3770
+ export type DelegateConfig = {
3771
+ /**
3772
+ * Delegate module path
3773
+ */
3774
+ name: string;
3775
+ /**
3776
+ * defines application-specific information that can be used in the given delegate
3777
+ */
3778
+ payload?: any;
3779
+ };
3780
+
3770
3781
  /**
3771
3782
  * Acts a subset of the `FilterBarDelegate` that can be used in {@link module:sap/ui/mdc/TableDelegate.getFilterDelegate TableDelegate.getFilterDelegate }
3772
3783
  * or {@link module:sap/ui/mdc/ChartDelegate.getFilterDelegate Chart.getFilterDelegate} to enable inbuilt
@@ -4819,8 +4830,10 @@ declare module "sap/ui/mdc/Chart" {
4819
4830
  * Gets current value of property {@link #getDelegate delegate}.
4820
4831
  *
4821
4832
  * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
4822
- * The object has the following properties:
4823
- * - `name` defines the path to the `Delegate` module
4833
+ * The object has the following properties (see {@link sap.ui.mdc.DelegateConfig DelegateConfig}):
4834
+ *
4835
+ * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/ChartDelegate ChartDelegate}.
4836
+ *
4824
4837
  * - `payload` (optional) defines application-specific information that can be used in the given delegate
4825
4838
  * Sample delegate object:
4826
4839
  * ```javascript
@@ -5152,8 +5165,10 @@ declare module "sap/ui/mdc/Chart" {
5152
5165
  * Sets a new value for property {@link #getDelegate delegate}.
5153
5166
  *
5154
5167
  * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
5155
- * The object has the following properties:
5156
- * - `name` defines the path to the `Delegate` module
5168
+ * The object has the following properties (see {@link sap.ui.mdc.DelegateConfig DelegateConfig}):
5169
+ *
5170
+ * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/ChartDelegate ChartDelegate}.
5171
+ *
5157
5172
  * - `payload` (optional) defines application-specific information that can be used in the given delegate
5158
5173
  * Sample delegate object:
5159
5174
  * ```javascript
@@ -5518,8 +5533,10 @@ declare module "sap/ui/mdc/Chart" {
5518
5533
 
5519
5534
  /**
5520
5535
  * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
5521
- * The object has the following properties:
5522
- * - `name` defines the path to the `Delegate` module
5536
+ * The object has the following properties (see {@link sap.ui.mdc.DelegateConfig DelegateConfig}):
5537
+ *
5538
+ * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/ChartDelegate ChartDelegate}.
5539
+ *
5523
5540
  * - `payload` (optional) defines application-specific information that can be used in the given delegate
5524
5541
  * Sample delegate object:
5525
5542
  * ```javascript
@@ -7769,7 +7786,8 @@ declare module "sap/ui/mdc/Control" {
7769
7786
  export interface $ControlSettings extends $ControlSettings1 {
7770
7787
  /**
7771
7788
  * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
7772
- * The object has the following properties:
7789
+ * The object has the following properties (see {@link sap.ui.mdc.DelegateConfig DelegateConfig}):
7790
+ *
7773
7791
  * - `name` defines the path to the `Delegate` module
7774
7792
  * - `payload` (optional) defines application-specific information that can be used in the given delegate
7775
7793
  * Sample delegate object:
@@ -7991,7 +8009,8 @@ declare module "sap/ui/mdc/Element" {
7991
8009
  export interface $ElementSettings extends $ElementSettings1 {
7992
8010
  /**
7993
8011
  * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
7994
- * The object has the following properties:
8012
+ * The object has the following properties (see {@link sap.ui.mdc.DelegateConfig DelegateConfig}):
8013
+ *
7995
8014
  * - `name` defines the path to the `Delegate` module
7996
8015
  * - `payload` (optional) defines application-specific information that can be used in the given delegate
7997
8016
  * Sample delegate object:
@@ -13483,13 +13502,17 @@ declare module "sap/ui/mdc/filterbar/FilterBarBase" {
13483
13502
 
13484
13503
  import InvisibleText from "sap/ui/core/InvisibleText";
13485
13504
 
13505
+ import { MessageType, ID } from "sap/ui/core/library";
13506
+
13507
+ import Message from "sap/ui/core/message/Message";
13508
+
13486
13509
  import FilterBarValidationStatus from "sap/ui/mdc/enums/FilterBarValidationStatus";
13487
13510
 
13488
13511
  import FilterField from "sap/ui/mdc/FilterField";
13489
13512
 
13490
13513
  import ElementMetadata from "sap/ui/core/ElementMetadata";
13491
13514
 
13492
- import { ID } from "sap/ui/core/library";
13515
+ import Message1 from "sap/ui/core/Message";
13493
13516
 
13494
13517
  import VariantManagement from "sap/ui/fl/variants/VariantManagement";
13495
13518
 
@@ -13588,6 +13611,28 @@ declare module "sap/ui/mdc/filterbar/FilterBarBase" {
13588
13611
  */
13589
13612
  oInvisibleText: InvisibleText
13590
13613
  ): void;
13614
+ /**
13615
+ * Adds a message to the {@link sap.ui.model.message.MessageModel MessageModel} for a `propertyKey`. The
13616
+ * message is displayed on the corresponding {@link sap.ui.mdc.FilterField FilterField}.
13617
+ *
13618
+ * @since 1.147
13619
+ *
13620
+ * @returns The created message object
13621
+ */
13622
+ addMessage(
13623
+ /**
13624
+ * The `propertyKey` of the {@link sap.ui.mdc.FilterField FilterField}
13625
+ */
13626
+ sPropertyKey: string,
13627
+ /**
13628
+ * The message text
13629
+ */
13630
+ sMessage: string,
13631
+ /**
13632
+ * The message type
13633
+ */
13634
+ sMessageType: MessageType | keyof typeof MessageType
13635
+ ): Message;
13591
13636
  /**
13592
13637
  * Attaches event handler `fnFunction` to the {@link #event:filtersChanged filtersChanged} event of this
13593
13638
  * `sap.ui.mdc.filterbar.FilterBarBase`.
@@ -13834,8 +13879,10 @@ declare module "sap/ui/mdc/filterbar/FilterBarBase" {
13834
13879
  * Gets current value of property {@link #getDelegate delegate}.
13835
13880
  *
13836
13881
  * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
13837
- * The object has the following properties:
13838
- * - `name` defines the path to the `Delegate` module
13882
+ * The object has the following properties (see {@link sap.ui.mdc.DelegateConfig DelegateConfig}):
13883
+ *
13884
+ * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/FilterBarDelegate FilterBarDelegate}.
13885
+ *
13839
13886
  * - `payload` (optional) defines application-specific information that can be used in the given delegate
13840
13887
  * Sample delegate object:
13841
13888
  * ```javascript
@@ -13893,6 +13940,19 @@ declare module "sap/ui/mdc/filterbar/FilterBarBase" {
13893
13940
  * @returns Value of property `liveMode`
13894
13941
  */
13895
13942
  getLiveMode(): boolean;
13943
+ /**
13944
+ * Returns all messages associated with the given `propertyKey` from the {@link sap.ui.model.message.MessageModel MessageModel}.
13945
+ *
13946
+ * @since 1.147
13947
+ *
13948
+ * @returns Array of messages for the given `propertyKey`
13949
+ */
13950
+ getMessages(
13951
+ /**
13952
+ * The `propertyKey` of the {@link sap.ui.mdc.FilterField FilterField}
13953
+ */
13954
+ sPropertyKey: string
13955
+ ): Message[];
13896
13956
  /**
13897
13957
  * Gets the value of the basic search condition.
13898
13958
  *
@@ -13970,6 +14030,30 @@ declare module "sap/ui/mdc/filterbar/FilterBarBase" {
13970
14030
  * @returns Resolves after the initial filters have been applied and the metadata has been obtained
13971
14031
  */
13972
14032
  initializedWithMetadata(): Promise<any>;
14033
+ /**
14034
+ * Removes a given message from the {@link sap.ui.model.message.MessageModel MessageModel}. The message
14035
+ * is removed from the corresponding {@link sap.ui.mdc.FilterField FilterField}.
14036
+ *
14037
+ * @since 1.147
14038
+ */
14039
+ removeMessage(
14040
+ /**
14041
+ * The message to remove
14042
+ */
14043
+ oMessage: Message1
14044
+ ): void;
14045
+ /**
14046
+ * Removes all messages for the given `propertyKey` from the {@link sap.ui.model.message.MessageModel MessageModel}.
14047
+ * Clears the messages from the corresponding {@link sap.ui.mdc.FilterField FilterField}.
14048
+ *
14049
+ * @since 1.147
14050
+ */
14051
+ removeMessages(
14052
+ /**
14053
+ * The `propertyKey` of the {@link sap.ui.mdc.FilterField FilterField}
14054
+ */
14055
+ sPropertyKey: string
14056
+ ): void;
13973
14057
  /**
13974
14058
  * Sets the aggregated {@link #getBasicSearchField basicSearchField}.
13975
14059
  *
@@ -13986,8 +14070,10 @@ declare module "sap/ui/mdc/filterbar/FilterBarBase" {
13986
14070
  * Sets a new value for property {@link #getDelegate delegate}.
13987
14071
  *
13988
14072
  * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
13989
- * The object has the following properties:
13990
- * - `name` defines the path to the `Delegate` module
14073
+ * The object has the following properties (see {@link sap.ui.mdc.DelegateConfig DelegateConfig}):
14074
+ *
14075
+ * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/FilterBarDelegate FilterBarDelegate}.
14076
+ *
13991
14077
  * - `payload` (optional) defines application-specific information that can be used in the given delegate
13992
14078
  * Sample delegate object:
13993
14079
  * ```javascript
@@ -14141,8 +14227,10 @@ declare module "sap/ui/mdc/filterbar/FilterBarBase" {
14141
14227
  export interface $FilterBarBaseSettings extends $ControlSettings {
14142
14228
  /**
14143
14229
  * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
14144
- * The object has the following properties:
14145
- * - `name` defines the path to the `Delegate` module
14230
+ * The object has the following properties (see {@link sap.ui.mdc.DelegateConfig DelegateConfig}):
14231
+ *
14232
+ * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/FilterBarDelegate FilterBarDelegate}.
14233
+ *
14146
14234
  * - `payload` (optional) defines application-specific information that can be used in the given delegate
14147
14235
  * Sample delegate object:
14148
14236
  * ```javascript
@@ -14198,8 +14286,8 @@ declare module "sap/ui/mdc/filterbar/FilterBarBase" {
14198
14286
  * aggregation) should be specified here, rather than in the `FilterField` configuration.
14199
14287
  * **Note**: This property must not be bound.
14200
14288
  * **Node**: Please check {@link sap.ui.mdc.filterbar.PropertyInfo} for more information about the supported
14201
- * inner elements. **Note**: Existing properties (set via `sap.ui.mdc.filterbar.FilterBarBase#setPropertyInfo`)
14202
- * must not be removed and their attributes must not be changed during the {@link module:sap/ui/mdc/FilterBarDelegate.fetchProperties fetchProperties }
14289
+ * inner elements. **Note**: Existing properties (set via {@link #setPropertyInfo setPropertyInfo}) must
14290
+ * not be removed and their attributes must not be changed during the {@link module:sap/ui/mdc/FilterBarDelegate.fetchProperties fetchProperties }
14203
14291
  * callback. Otherwise validation errors might occur whenever personalization-related control features (such
14204
14292
  * as the opening of any personalization dialog) are activated.
14205
14293
  *
@@ -18088,7 +18176,8 @@ declare module "sap/ui/mdc/Table" {
18088
18176
  *
18089
18177
  * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
18090
18178
  *
18091
- * The object has the following properties:
18179
+ * The object has the following properties (see {@link sap.ui.mdc.DelegateConfig DelegateConfig}):
18180
+ *
18092
18181
  * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/TableDelegate TableDelegate}.
18093
18182
  *
18094
18183
  * - `payload` (optional) defines application-specific information that can be used in the given delegate
@@ -18649,7 +18738,8 @@ declare module "sap/ui/mdc/Table" {
18649
18738
  *
18650
18739
  * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
18651
18740
  *
18652
- * The object has the following properties:
18741
+ * The object has the following properties (see {@link sap.ui.mdc.DelegateConfig DelegateConfig}):
18742
+ *
18653
18743
  * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/TableDelegate TableDelegate}.
18654
18744
  *
18655
18745
  * - `payload` (optional) defines application-specific information that can be used in the given delegate
@@ -19325,7 +19415,8 @@ declare module "sap/ui/mdc/Table" {
19325
19415
  /**
19326
19416
  * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
19327
19417
  *
19328
- * The object has the following properties:
19418
+ * The object has the following properties (see {@link sap.ui.mdc.DelegateConfig DelegateConfig}):
19419
+ *
19329
19420
  * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/TableDelegate TableDelegate}.
19330
19421
  *
19331
19422
  * - `payload` (optional) defines application-specific information that can be used in the given delegate
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.146.0
1
+ // For Library Version: 1.147.0
2
2
 
3
3
  declare module "sap/ui/rta/api/startAdaptation" {
4
4
  import Control from "sap/ui/core/Control";
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.146.0
1
+ // For Library Version: 1.147.0
2
2
 
3
3
  declare module "sap/ui/suite/library" {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.146.0
1
+ // For Library Version: 1.147.0
2
2
 
3
3
  declare module "sap/ui/support/library" {
4
4
  /**
@@ -166,7 +166,7 @@ declare module "sap/ui/support/library" {
166
166
  /**
167
167
  * Preset to find usages of deprecated controls, properties, aggregations and others.
168
168
  *
169
- * @experimental As of version 1.120.
169
+ * @since 1.120
170
170
  */
171
171
  Deprecations = "undefined",
172
172
  }
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.146.0
1
+ // For Library Version: 1.147.0
2
2
 
3
3
  declare module "sap/ui/table/library" {
4
4
  import TreeAutoExpandMode1 from "sap/ui/model/TreeAutoExpandMode";
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.146.0
1
+ // For Library Version: 1.147.0
2
2
 
3
3
  declare module "sap/ui/testrecorder/library" {}
4
4
 
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.146.0
1
+ // For Library Version: 1.147.0
2
2
 
3
3
  declare module "sap/ui/unified/library" {
4
4
  /**
@@ -33,7 +33,6 @@ declare module "sap/ui/unified/library" {
33
33
  * This enum is part of the 'sap/ui/unified/library' module export and must be accessed by the property
34
34
  * 'CalendarAppointmentRoundWidth'.
35
35
  *
36
- * @since 1.81.0
37
36
  * @experimental As of version 1.81.0.
38
37
  */
39
38
  export enum CalendarAppointmentRoundWidth {
@@ -232,8 +231,9 @@ declare module "sap/ui/unified/library" {
232
231
  * This enum is part of the 'sap/ui/unified/library' module export and must be accessed by the property
233
232
  * 'ContentSwitcherAnimation'.
234
233
  *
235
- * @since 1.16.0
236
- * @experimental As of version 1.16.0. API is not yet finished and might change completely
234
+ * @deprecated As of version 1.147.0. the concept has been discarded. API is not yet finished and might
235
+ * change completely
236
+ * @experimental As of version 1.16.0.
237
237
  */
238
238
  export enum ContentSwitcherAnimation {
239
239
  /**
@@ -20245,7 +20245,6 @@ declare module "sap/ui/unified/NonWorkingPeriod" {
20245
20245
  /**
20246
20246
  * NonWorkingPeriod
20247
20247
  *
20248
- * @since 1.27.0
20249
20248
  * @experimental As of version 1.127.0.
20250
20249
  */
20251
20250
  export default class NonWorkingPeriod extends UI5Element {
@@ -20404,7 +20403,6 @@ declare module "sap/ui/unified/RecurringNonWorkingPeriod" {
20404
20403
  *
20405
20404
  * Applications can inherit from this element to add own fields.
20406
20405
  *
20407
- * @since 1.127.0
20408
20406
  * @experimental As of version 1.127.0.
20409
20407
  */
20410
20408
  export default class RecurringNonWorkingPeriod extends NonWorkingPeriod {
@@ -23266,8 +23264,7 @@ declare module "sap/ui/unified/TimeRange" {
23266
23264
  /**
23267
23265
  * Time range for use in `NonWorkingPeriod`
23268
23266
  *
23269
- * @since 1.127.0
23270
- * @experimental As of version 1.127.0.
23267
+ * @experimental As of version 1.127.
23271
23268
  */
23272
23269
  export default class TimeRange extends UI5Element {
23273
23270
  /**
@@ -23433,7 +23430,7 @@ declare module "sap/ui/unified/TimeRange" {
23433
23430
  /**
23434
23431
  * Describes the settings that can be provided to the TimeRange constructor.
23435
23432
  *
23436
- * @experimental As of version 1.127.0.
23433
+ * @experimental As of version 1.127.
23437
23434
  */
23438
23435
  export interface $TimeRangeSettings extends $ElementSettings {
23439
23436
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.146.0
1
+ // For Library Version: 1.147.0
2
2
 
3
3
  declare module "sap/ui/ux3/library" {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.146.0
1
+ // For Library Version: 1.147.0
2
2
 
3
3
  declare module "sap/uxap/library" {
4
4
  /**
@@ -136,6 +136,31 @@ declare module "sap/uxap/library" {
136
136
  */
137
137
  Square = "Square",
138
138
  }
139
+ /**
140
+ * Defines the media breakpoints for ObjectPageLayout.
141
+ *
142
+ * This enum is part of the 'sap/uxap/library' module export and must be accessed by the property 'ObjectPageLayoutMediaRange'.
143
+ *
144
+ * @since 1.147
145
+ */
146
+ export enum ObjectPageLayoutMediaRange {
147
+ /**
148
+ * Desktop breakpoint (1025px to 1439px).
149
+ */
150
+ Desktop = "Desktop",
151
+ /**
152
+ * Extra large desktop breakpoint (1440px and above).
153
+ */
154
+ DesktopExtraLarge = "DesktopExtraLarge",
155
+ /**
156
+ * Phone breakpoint (up to 600px).
157
+ */
158
+ Phone = "Phone",
159
+ /**
160
+ * Tablet breakpoint (601px to 1024px).
161
+ */
162
+ Tablet = "Tablet",
163
+ }
139
164
  /**
140
165
  * Used by the `ObjectPagSubSection` control to define which layout to apply.
141
166
  *
@@ -4504,7 +4529,11 @@ declare module "sap/uxap/ObjectPageLayout" {
4504
4529
 
4505
4530
  import { BackgroundDesign, IBar } from "sap/m/library";
4506
4531
 
4507
- import { IHeaderTitle, ObjectPageSubSectionLayout } from "sap/uxap/library";
4532
+ import {
4533
+ IHeaderTitle,
4534
+ ObjectPageSubSectionLayout,
4535
+ ObjectPageLayoutMediaRange,
4536
+ } from "sap/uxap/library";
4508
4537
 
4509
4538
  import { CSSSize, TitleLevel, ID } from "sap/ui/core/library";
4510
4539
 
@@ -4720,6 +4749,59 @@ declare module "sap/uxap/ObjectPageLayout" {
4720
4749
  */
4721
4750
  oListener?: object
4722
4751
  ): this;
4752
+ /**
4753
+ * Attaches event handler `fnFunction` to the {@link #event:breakpointChange breakpointChange} event of
4754
+ * this `sap.uxap.ObjectPageLayout`.
4755
+ *
4756
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
4757
+ * otherwise it will be bound to this `sap.uxap.ObjectPageLayout` itself.
4758
+ *
4759
+ * Fired when the media range of the control changes, allowing the application to adjust the UI accordingly
4760
+ * (e.g., change Avatar sizes responsively).
4761
+ *
4762
+ * @since 1.147
4763
+ *
4764
+ * @returns Reference to `this` in order to allow method chaining
4765
+ */
4766
+ attachBreakpointChange(
4767
+ /**
4768
+ * An application-specific payload object that will be passed to the event handler along with the event
4769
+ * object when firing the event
4770
+ */
4771
+ oData: object,
4772
+ /**
4773
+ * The function to be called when the event occurs
4774
+ */
4775
+ fnFunction: (p1: ObjectPageLayout$BreakpointChangeEvent) => void,
4776
+ /**
4777
+ * Context object to call the event handler with. Defaults to this `sap.uxap.ObjectPageLayout` itself
4778
+ */
4779
+ oListener?: object
4780
+ ): this;
4781
+ /**
4782
+ * Attaches event handler `fnFunction` to the {@link #event:breakpointChange breakpointChange} event of
4783
+ * this `sap.uxap.ObjectPageLayout`.
4784
+ *
4785
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
4786
+ * otherwise it will be bound to this `sap.uxap.ObjectPageLayout` itself.
4787
+ *
4788
+ * Fired when the media range of the control changes, allowing the application to adjust the UI accordingly
4789
+ * (e.g., change Avatar sizes responsively).
4790
+ *
4791
+ * @since 1.147
4792
+ *
4793
+ * @returns Reference to `this` in order to allow method chaining
4794
+ */
4795
+ attachBreakpointChange(
4796
+ /**
4797
+ * The function to be called when the event occurs
4798
+ */
4799
+ fnFunction: (p1: ObjectPageLayout$BreakpointChangeEvent) => void,
4800
+ /**
4801
+ * Context object to call the event handler with. Defaults to this `sap.uxap.ObjectPageLayout` itself
4802
+ */
4803
+ oListener?: object
4804
+ ): this;
4723
4805
  /**
4724
4806
  * Attaches event handler `fnFunction` to the {@link #event:editHeaderButtonPress editHeaderButtonPress }
4725
4807
  * event of this `sap.uxap.ObjectPageLayout`.
@@ -5083,6 +5165,26 @@ declare module "sap/uxap/ObjectPageLayout" {
5083
5165
  */
5084
5166
  oListener?: object
5085
5167
  ): this;
5168
+ /**
5169
+ * Detaches event handler `fnFunction` from the {@link #event:breakpointChange breakpointChange} event of
5170
+ * this `sap.uxap.ObjectPageLayout`.
5171
+ *
5172
+ * The passed function and listener object must match the ones used for event registration.
5173
+ *
5174
+ * @since 1.147
5175
+ *
5176
+ * @returns Reference to `this` in order to allow method chaining
5177
+ */
5178
+ detachBreakpointChange(
5179
+ /**
5180
+ * The function to be called, when the event occurs
5181
+ */
5182
+ fnFunction: (p1: ObjectPageLayout$BreakpointChangeEvent) => void,
5183
+ /**
5184
+ * Context object on which the given function had to be called
5185
+ */
5186
+ oListener?: object
5187
+ ): this;
5086
5188
  /**
5087
5189
  * Detaches event handler `fnFunction` from the {@link #event:editHeaderButtonPress editHeaderButtonPress }
5088
5190
  * event of this `sap.uxap.ObjectPageLayout`.
@@ -5221,6 +5323,20 @@ declare module "sap/uxap/ObjectPageLayout" {
5221
5323
  */
5222
5324
  mParameters?: ObjectPageLayout$BeforeNavigateEventParameters
5223
5325
  ): boolean;
5326
+ /**
5327
+ * Fires event {@link #event:breakpointChange breakpointChange} to attached listeners.
5328
+ *
5329
+ * @since 1.147
5330
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
5331
+ *
5332
+ * @returns Reference to `this` in order to allow method chaining
5333
+ */
5334
+ fireBreakpointChange(
5335
+ /**
5336
+ * Parameters to pass along with the event
5337
+ */
5338
+ mParameters?: ObjectPageLayout$BreakpointChangeEventParameters
5339
+ ): this;
5224
5340
  /**
5225
5341
  * Fires event {@link #event:editHeaderButtonPress editHeaderButtonPress} to attached listeners.
5226
5342
  *
@@ -6665,6 +6781,14 @@ declare module "sap/uxap/ObjectPageLayout" {
6665
6781
  subSectionVisibilityChange?: (
6666
6782
  oEvent: ObjectPageLayout$SubSectionVisibilityChangeEvent
6667
6783
  ) => void;
6784
+
6785
+ /**
6786
+ * Fired when the media range of the control changes, allowing the application to adjust the UI accordingly
6787
+ * (e.g., change Avatar sizes responsively).
6788
+ *
6789
+ * @since 1.147
6790
+ */
6791
+ breakpointChange?: (oEvent: ObjectPageLayout$BreakpointChangeEvent) => void;
6668
6792
  }
6669
6793
 
6670
6794
  /**
@@ -6690,6 +6814,31 @@ declare module "sap/uxap/ObjectPageLayout" {
6690
6814
  ObjectPageLayout
6691
6815
  >;
6692
6816
 
6817
+ /**
6818
+ * Parameters of the ObjectPageLayout#breakpointChange event.
6819
+ */
6820
+ export interface ObjectPageLayout$BreakpointChangeEventParameters {
6821
+ /**
6822
+ * The name of the current media range ("Phone", "Tablet", "Desktop", or "DesktopExtraLarge").
6823
+ */
6824
+ currentRange?:
6825
+ | ObjectPageLayoutMediaRange
6826
+ | keyof typeof ObjectPageLayoutMediaRange;
6827
+
6828
+ /**
6829
+ * The current width of the control in pixels.
6830
+ */
6831
+ currentWidth?: int;
6832
+ }
6833
+
6834
+ /**
6835
+ * Event object of the ObjectPageLayout#breakpointChange event.
6836
+ */
6837
+ export type ObjectPageLayout$BreakpointChangeEvent = Event<
6838
+ ObjectPageLayout$BreakpointChangeEventParameters,
6839
+ ObjectPageLayout
6840
+ >;
6841
+
6693
6842
  /**
6694
6843
  * Parameters of the ObjectPageLayout#editHeaderButtonPress event.
6695
6844
  */