@openui5/ts-types 1.130.0 → 1.131.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.130.0
1
+ // For Library Version: 1.131.0
2
2
 
3
3
  declare module "sap/ui/rta/api/startAdaptation" {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.130.0
1
+ // For Library Version: 1.131.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.130.0
1
+ // For Library Version: 1.131.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.130.0
1
+ // For Library Version: 1.131.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -2275,7 +2275,8 @@ declare namespace sap {
2275
2275
  *
2276
2276
  * If the highlight is set to {@link sap.ui.core.MessageType sap.ui.core.MessageType.None} (default), no
2277
2277
  * highlights are visible. Valid values for the `highlight` property are values of the enumerations {@link sap.ui.core.MessageType }
2278
- * or {@link sap.ui.core.IndicationColor}.
2278
+ * or {@link sap.ui.core.IndicationColor} (only values of `Indication01` to `Indication10` are supported
2279
+ * for accessibility contrast reasons).
2279
2280
  *
2280
2281
  * Accessibility support is provided through the associated {@link sap.ui.table.RowSettings#setHighlightText highlightText }
2281
2282
  * property. If the `highlight` property is set to a value of {@link sap.ui.core.MessageType}, the `highlightText`
@@ -6427,7 +6428,8 @@ declare namespace sap {
6427
6428
  *
6428
6429
  * If the highlight is set to {@link sap.ui.core.MessageType sap.ui.core.MessageType.None} (default), no
6429
6430
  * highlights are visible. Valid values for the `highlight` property are values of the enumerations {@link sap.ui.core.MessageType }
6430
- * or {@link sap.ui.core.IndicationColor}.
6431
+ * or {@link sap.ui.core.IndicationColor} (only values of `Indication01` to `Indication10` are supported
6432
+ * for accessibility contrast reasons).
6431
6433
  *
6432
6434
  * Accessibility support is provided through the associated {@link sap.ui.table.RowSettings#setHighlightText highlightText }
6433
6435
  * property. If the `highlight` property is set to a value of {@link sap.ui.core.MessageType}, the `highlightText`
@@ -6477,7 +6479,8 @@ declare namespace sap {
6477
6479
  *
6478
6480
  * If the highlight is set to {@link sap.ui.core.MessageType sap.ui.core.MessageType.None} (default), no
6479
6481
  * highlights are visible. Valid values for the `highlight` property are values of the enumerations {@link sap.ui.core.MessageType }
6480
- * or {@link sap.ui.core.IndicationColor}.
6482
+ * or {@link sap.ui.core.IndicationColor} (only values of `Indication01` to `Indication10` are supported
6483
+ * for accessibility contrast reasons).
6481
6484
  *
6482
6485
  * Accessibility support is provided through the associated {@link sap.ui.table.RowSettings#setHighlightText highlightText }
6483
6486
  * property. If the `highlight` property is set to a value of {@link sap.ui.core.MessageType}, the `highlightText`
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.130.0
1
+ // For Library Version: 1.131.0
2
2
 
3
3
  declare namespace sap {
4
4
  interface IUI5DefineDependencyNames {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.130.0
1
+ // For Library Version: 1.131.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -7651,6 +7651,12 @@ declare namespace sap {
7651
7651
  * @since 1.129
7652
7652
  */
7653
7653
  closed?: (oEvent: sap.ui.base.Event) => void;
7654
+
7655
+ /**
7656
+ * Fired before the menu is closed. This event can be prevented which effectively prevents the menu from
7657
+ * closing. sinnce 1.131
7658
+ */
7659
+ beforeClose?: (oEvent: sap.ui.base.Event) => void;
7654
7660
  }
7655
7661
 
7656
7662
  /**
@@ -7692,6 +7698,19 @@ declare namespace sap {
7692
7698
  */
7693
7699
  shortcutText?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
7694
7700
 
7701
+ /**
7702
+ * Defines the content that is displayed at the end of a menu item. This aggregation allows for the addition
7703
+ * of custom elements, such as icons and buttons.
7704
+ *
7705
+ * @since 1.131
7706
+ * @experimental
7707
+ */
7708
+ endContent?:
7709
+ | sap.ui.core.Control[]
7710
+ | sap.ui.core.Control
7711
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
7712
+ | `{${string}}`;
7713
+
7695
7714
  /**
7696
7715
  * Association to controls / IDs which label this control (see WAI-ARIA attribute aria-labelledby).
7697
7716
  */
@@ -7818,6 +7837,42 @@ declare namespace sap {
7818
7837
  timeRange?: sap.ui.unified.TimeRange;
7819
7838
  }
7820
7839
 
7840
+ /**
7841
+ * Describes the settings that can be provided to the RecurringNonWorkingPeriod constructor.
7842
+ *
7843
+ * @experimental (since 1.127.0)
7844
+ */
7845
+ interface $RecurringNonWorkingPeriodSettings
7846
+ extends sap.ui.unified.$NonWorkingPeriodSettings {
7847
+ /**
7848
+ * The recurrenceType determines the pattern of recurrence for a given calendar item.
7849
+ */
7850
+ recurrenceType?:
7851
+ | sap.ui.unified.RecurrenceType
7852
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
7853
+ | `{${string}}`;
7854
+
7855
+ /**
7856
+ * Determines the end date of the calendar item, as a UI5Date or JavaScript Date object. It is considered
7857
+ * as a local date.
7858
+ */
7859
+ recurrenceEndDate?:
7860
+ | object
7861
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
7862
+ | `{${string}}`;
7863
+
7864
+ /**
7865
+ * The recurrencePattern is an integer value which, in combination with the recurrenceType, sets the recurrence
7866
+ * frequency for a calendar item. For example, if the recurrenceType is set to "Daily" and the recurrencePattern
7867
+ * is set to 1, it signifies that repetition is set for every day. If the recurrencePattern is set to 3,
7868
+ * this would imply the calendar item is recurring once for every three days.
7869
+ */
7870
+ recurrencePattern?:
7871
+ | int
7872
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
7873
+ | `{${string}}`;
7874
+ }
7875
+
7821
7876
  /**
7822
7877
  * Describes the settings that can be provided to the Shell constructor.
7823
7878
  *
@@ -8760,6 +8815,11 @@ declare namespace sap {
8760
8815
  requestHeaders?: object[];
8761
8816
  }
8762
8817
 
8818
+ /**
8819
+ * Parameters of the Menu#beforeClose event.
8820
+ */
8821
+ interface Menu$BeforeCloseEventParameters {}
8822
+
8763
8823
  /**
8764
8824
  * Parameters of the Menu#closed event.
8765
8825
  */
@@ -18121,6 +18181,55 @@ declare namespace sap {
18121
18181
  */
18122
18182
  oItem: sap.ui.unified.IMenuItem
18123
18183
  ): this;
18184
+ /**
18185
+ * Attaches event handler `fnFunction` to the {@link #event:beforeClose beforeClose} event of this `sap.ui.unified.Menu`.
18186
+ *
18187
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
18188
+ * otherwise it will be bound to this `sap.ui.unified.Menu` itself.
18189
+ *
18190
+ * Fired before the menu is closed. This event can be prevented which effectively prevents the menu from
18191
+ * closing. sinnce 1.131
18192
+ *
18193
+ *
18194
+ * @returns Reference to `this` in order to allow method chaining
18195
+ */
18196
+ attachBeforeClose(
18197
+ /**
18198
+ * An application-specific payload object that will be passed to the event handler along with the event
18199
+ * object when firing the event
18200
+ */
18201
+ oData: object,
18202
+ /**
18203
+ * The function to be called when the event occurs
18204
+ */
18205
+ fnFunction: (p1: sap.ui.base.Event) => void,
18206
+ /**
18207
+ * Context object to call the event handler with. Defaults to this `sap.ui.unified.Menu` itself
18208
+ */
18209
+ oListener?: object
18210
+ ): this;
18211
+ /**
18212
+ * Attaches event handler `fnFunction` to the {@link #event:beforeClose beforeClose} event of this `sap.ui.unified.Menu`.
18213
+ *
18214
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
18215
+ * otherwise it will be bound to this `sap.ui.unified.Menu` itself.
18216
+ *
18217
+ * Fired before the menu is closed. This event can be prevented which effectively prevents the menu from
18218
+ * closing. sinnce 1.131
18219
+ *
18220
+ *
18221
+ * @returns Reference to `this` in order to allow method chaining
18222
+ */
18223
+ attachBeforeClose(
18224
+ /**
18225
+ * The function to be called when the event occurs
18226
+ */
18227
+ fnFunction: (p1: sap.ui.base.Event) => void,
18228
+ /**
18229
+ * Context object to call the event handler with. Defaults to this `sap.ui.unified.Menu` itself
18230
+ */
18231
+ oListener?: object
18232
+ ): this;
18124
18233
  /**
18125
18234
  * Attaches event handler `fnFunction` to the {@link #event:closed closed} event of this `sap.ui.unified.Menu`.
18126
18235
  *
@@ -18232,6 +18341,24 @@ declare namespace sap {
18232
18341
  * @returns Reference to `this` in order to allow method chaining
18233
18342
  */
18234
18343
  destroyItems(): this;
18344
+ /**
18345
+ * Detaches event handler `fnFunction` from the {@link #event:beforeClose beforeClose} event of this `sap.ui.unified.Menu`.
18346
+ *
18347
+ * The passed function and listener object must match the ones used for event registration.
18348
+ *
18349
+ *
18350
+ * @returns Reference to `this` in order to allow method chaining
18351
+ */
18352
+ detachBeforeClose(
18353
+ /**
18354
+ * The function to be called, when the event occurs
18355
+ */
18356
+ fnFunction: (p1: sap.ui.base.Event) => void,
18357
+ /**
18358
+ * Context object on which the given function had to be called
18359
+ */
18360
+ oListener?: object
18361
+ ): this;
18235
18362
  /**
18236
18363
  * Detaches event handler `fnFunction` from the {@link #event:closed closed} event of this `sap.ui.unified.Menu`.
18237
18364
  *
@@ -18269,6 +18396,22 @@ declare namespace sap {
18269
18396
  */
18270
18397
  oListener?: object
18271
18398
  ): this;
18399
+ /**
18400
+ * Fires event {@link #event:beforeClose beforeClose} to attached listeners.
18401
+ *
18402
+ * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
18403
+ * event object. The return value of this method indicates whether the default action should be executed.
18404
+ *
18405
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
18406
+ *
18407
+ * @returns Whether or not to prevent the default action
18408
+ */
18409
+ fireBeforeClose(
18410
+ /**
18411
+ * Parameters to pass along with the event
18412
+ */
18413
+ mParameters?: object
18414
+ ): boolean;
18272
18415
  /**
18273
18416
  * Fires event {@link #event:closed closed} to attached listeners.
18274
18417
  *
@@ -18672,10 +18815,43 @@ declare namespace sap {
18672
18815
  */
18673
18816
  vAriaLabelledBy: sap.ui.core.ID | sap.ui.core.Control
18674
18817
  ): this;
18818
+ /**
18819
+ * Adds some endContent to the aggregation {@link #getEndContent endContent}.
18820
+ *
18821
+ * @since 1.131
18822
+ * @experimental
18823
+ *
18824
+ * @returns Reference to `this` in order to allow method chaining
18825
+ */
18826
+ addEndContent(
18827
+ /**
18828
+ * The endContent to add; if empty, nothing is inserted
18829
+ */
18830
+ oEndContent: sap.ui.core.Control
18831
+ ): this;
18832
+ /**
18833
+ * Destroys all the endContent in the aggregation {@link #getEndContent endContent}.
18834
+ *
18835
+ * @since 1.131
18836
+ * @experimental
18837
+ *
18838
+ * @returns Reference to `this` in order to allow method chaining
18839
+ */
18840
+ destroyEndContent(): this;
18675
18841
  /**
18676
18842
  * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
18677
18843
  */
18678
18844
  getAriaLabelledBy(): sap.ui.core.ID[];
18845
+ /**
18846
+ * Gets content of aggregation {@link #getEndContent endContent}.
18847
+ *
18848
+ * Defines the content that is displayed at the end of a menu item. This aggregation allows for the addition
18849
+ * of custom elements, such as icons and buttons.
18850
+ *
18851
+ * @since 1.131
18852
+ * @experimental
18853
+ */
18854
+ getEndContent(): sap.ui.core.Control[];
18679
18855
  /**
18680
18856
  * Gets current value of property {@link #getIcon icon}.
18681
18857
  *
@@ -18720,6 +18896,41 @@ declare namespace sap {
18720
18896
  * @returns Value of property `text`
18721
18897
  */
18722
18898
  getText(): string;
18899
+ /**
18900
+ * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getEndContent endContent}. and
18901
+ * returns its index if found or -1 otherwise.
18902
+ *
18903
+ * @since 1.131
18904
+ * @experimental
18905
+ *
18906
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
18907
+ */
18908
+ indexOfEndContent(
18909
+ /**
18910
+ * The endContent whose index is looked for
18911
+ */
18912
+ oEndContent: sap.ui.core.Control
18913
+ ): int;
18914
+ /**
18915
+ * Inserts a endContent into the aggregation {@link #getEndContent endContent}.
18916
+ *
18917
+ * @since 1.131
18918
+ * @experimental
18919
+ *
18920
+ * @returns Reference to `this` in order to allow method chaining
18921
+ */
18922
+ insertEndContent(
18923
+ /**
18924
+ * The endContent to insert; if empty, nothing is inserted
18925
+ */
18926
+ oEndContent: sap.ui.core.Control,
18927
+ /**
18928
+ * The `0`-based index the endContent should be inserted at; for a negative value of `iIndex`, the endContent
18929
+ * is inserted at position 0; for a value greater than the current size of the aggregation, the endContent
18930
+ * is inserted at the last position
18931
+ */
18932
+ iIndex: int
18933
+ ): this;
18723
18934
  /**
18724
18935
  * Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
18725
18936
  *
@@ -18727,6 +18938,17 @@ declare namespace sap {
18727
18938
  * @returns An array of the removed elements (might be empty)
18728
18939
  */
18729
18940
  removeAllAriaLabelledBy(): sap.ui.core.ID[];
18941
+ /**
18942
+ * Removes all the controls from the aggregation {@link #getEndContent endContent}.
18943
+ *
18944
+ * Additionally, it unregisters them from the hosting UIArea.
18945
+ *
18946
+ * @since 1.131
18947
+ * @experimental
18948
+ *
18949
+ * @returns An array of the removed elements (might be empty)
18950
+ */
18951
+ removeAllEndContent(): sap.ui.core.Control[];
18730
18952
  /**
18731
18953
  * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
18732
18954
  *
@@ -18739,6 +18961,20 @@ declare namespace sap {
18739
18961
  */
18740
18962
  vAriaLabelledBy: int | sap.ui.core.ID | sap.ui.core.Control
18741
18963
  ): sap.ui.core.ID | null;
18964
+ /**
18965
+ * Removes a endContent from the aggregation {@link #getEndContent endContent}.
18966
+ *
18967
+ * @since 1.131
18968
+ * @experimental
18969
+ *
18970
+ * @returns The removed endContent or `null`
18971
+ */
18972
+ removeEndContent(
18973
+ /**
18974
+ * The endContent to remove or its index or id
18975
+ */
18976
+ vEndContent: int | string | sap.ui.core.Control
18977
+ ): sap.ui.core.Control | null;
18742
18978
  /**
18743
18979
  * Sets a new value for property {@link #getIcon icon}.
18744
18980
  *
@@ -19685,9 +19921,20 @@ declare namespace sap {
19685
19921
  * @since 1.127.0
19686
19922
  * @experimental (since 1.127.0)
19687
19923
  */
19688
- class RecurringNonWorkingPeriod
19689
- extends /* was: sap.ui.unified. */ Object
19690
- {
19924
+ class RecurringNonWorkingPeriod extends sap.ui.unified.NonWorkingPeriod {
19925
+ /**
19926
+ * Constructor for a new `RecurringNonWorkingPeriod`.
19927
+ *
19928
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
19929
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
19930
+ * of the syntax of the settings object.
19931
+ */
19932
+ constructor(
19933
+ /**
19934
+ * Initial settings for the new control
19935
+ */
19936
+ mSettings?: sap.ui.unified.$RecurringNonWorkingPeriodSettings
19937
+ );
19691
19938
  /**
19692
19939
  * Constructor for a new `RecurringNonWorkingPeriod`.
19693
19940
  *
@@ -19703,14 +19950,14 @@ declare namespace sap {
19703
19950
  /**
19704
19951
  * Initial settings for the new control
19705
19952
  */
19706
- mSettings?: object
19953
+ mSettings?: sap.ui.unified.$RecurringNonWorkingPeriodSettings
19707
19954
  );
19708
19955
 
19709
19956
  /**
19710
19957
  * Creates a new subclass of class sap.ui.unified.RecurringNonWorkingPeriod with name `sClassName` and enriches
19711
19958
  * it with the information contained in `oClassInfo`.
19712
19959
  *
19713
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.unified..extend}.
19960
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.unified.NonWorkingPeriod.extend}.
19714
19961
  *
19715
19962
  *
19716
19963
  * @returns Created class / constructor function
@@ -19739,7 +19986,7 @@ declare namespace sap {
19739
19986
  *
19740
19987
  * @returns Metadata object describing this class
19741
19988
  */
19742
- static getMetadata(): sap.ui.base.Metadata;
19989
+ static getMetadata(): sap.ui.core.ElementMetadata;
19743
19990
  /**
19744
19991
  * Gets current value of property {@link #getRecurrenceEndDate recurrenceEndDate}.
19745
19992
  *
@@ -22819,6 +23066,14 @@ declare namespace sap {
22819
23066
  FileUploader
22820
23067
  >;
22821
23068
 
23069
+ /**
23070
+ * Event object of the Menu#beforeClose event.
23071
+ */
23072
+ type Menu$BeforeCloseEvent = sap.ui.base.Event<
23073
+ Menu$BeforeCloseEventParameters,
23074
+ Menu
23075
+ >;
23076
+
22822
23077
  /**
22823
23078
  * Event object of the Menu#closed event.
22824
23079
  */
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.130.0
1
+ // For Library Version: 1.131.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.130.0
1
+ // For Library Version: 1.131.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.130.0
1
+ // For Library Version: 1.131.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.130.0
1
+ // For Library Version: 1.131.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.130.0
1
+ // For Library Version: 1.131.0
2
2
 
3
3
  declare namespace sap {
4
4
  /**