@openui5/types 1.126.1 → 1.128.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.126.1
1
+ // For Library Version: 1.128.0
2
2
 
3
3
  declare module "sap/ui/unified/library" {
4
4
  /**
@@ -283,6 +283,15 @@ declare module "sap/ui/unified/library" {
283
283
  */
284
284
  Expanded = "Expanded",
285
285
  }
286
+ /**
287
+ * Interface for controls which are suitable to add as items of sap.m.Menu.
288
+ *
289
+ * @since 1.127.0
290
+ */
291
+ export interface IMenuItem {
292
+ __implements__sap_ui_unified_IMenuItem: boolean;
293
+ }
294
+
286
295
  /**
287
296
  * Marker interface for controls that process instances of `window.Blob`, such as `window.File`. The implementation
288
297
  * of this Interface should implement the following Interface methods:
@@ -309,6 +318,15 @@ declare module "sap/ui/unified/library" {
309
318
  ): Promise<Blob[]>;
310
319
  }
311
320
 
321
+ /**
322
+ * Interval types in a `RecurrenceType`.
323
+ *
324
+ * This enum is part of the 'sap/ui/unified/library' module export and must be accessed by the property
325
+ * 'RecurrenceType'.
326
+ *
327
+ * @since 1.127.0
328
+ */
329
+ export enum RecurrenceType {}
312
330
  /**
313
331
  * Standard day types visualized in a {@link sap.m.PlanningCalendarLegend}, which correspond to days in
314
332
  * a {@link sap.ui.unified.Calendar}.
@@ -9761,6 +9779,8 @@ declare module "sap/ui/unified/CalendarRow" {
9761
9779
 
9762
9780
  import { ID, CSSSize } from "sap/ui/core/library";
9763
9781
 
9782
+ import NonWorkingPeriod from "sap/ui/unified/NonWorkingPeriod";
9783
+
9764
9784
  import Event from "sap/ui/base/Event";
9765
9785
 
9766
9786
  import UI5Date from "sap/ui/core/date/UI5Date";
@@ -9886,6 +9906,19 @@ declare module "sap/ui/unified/CalendarRow" {
9886
9906
  */
9887
9907
  oIntervalHeader: CalendarAppointment
9888
9908
  ): this;
9909
+ /**
9910
+ * Adds some nonWorkingPeriod to the aggregation {@link #getNonWorkingPeriods nonWorkingPeriods}.
9911
+ *
9912
+ * @since 1.128
9913
+ *
9914
+ * @returns Reference to `this` in order to allow method chaining
9915
+ */
9916
+ addNonWorkingPeriod(
9917
+ /**
9918
+ * The nonWorkingPeriod to add; if empty, nothing is inserted
9919
+ */
9920
+ oNonWorkingPeriod: NonWorkingPeriod
9921
+ ): this;
9889
9922
  /**
9890
9923
  * Attaches event handler `fnFunction` to the {@link #event:intervalSelect intervalSelect} event of this
9891
9924
  * `sap.ui.unified.CalendarRow`.
@@ -10096,6 +10129,14 @@ declare module "sap/ui/unified/CalendarRow" {
10096
10129
  * @returns Reference to `this` in order to allow method chaining
10097
10130
  */
10098
10131
  destroyIntervalHeaders(): this;
10132
+ /**
10133
+ * Destroys all the nonWorkingPeriods in the aggregation {@link #getNonWorkingPeriods nonWorkingPeriods}.
10134
+ *
10135
+ * @since 1.128
10136
+ *
10137
+ * @returns Reference to `this` in order to allow method chaining
10138
+ */
10139
+ destroyNonWorkingPeriods(): this;
10099
10140
  /**
10100
10141
  * Detaches event handler `fnFunction` from the {@link #event:intervalSelect intervalSelect} event of this
10101
10142
  * `sap.ui.unified.CalendarRow`.
@@ -10466,6 +10507,14 @@ declare module "sap/ui/unified/CalendarRow" {
10466
10507
  * @returns Value of property `nonWorkingHours`
10467
10508
  */
10468
10509
  getNonWorkingHours(): int[];
10510
+ /**
10511
+ * Gets content of aggregation {@link #getNonWorkingPeriods nonWorkingPeriods}.
10512
+ *
10513
+ * Sets the provided period to be displayed as a non-working.
10514
+ *
10515
+ * @since 1.128
10516
+ */
10517
+ getNonWorkingPeriods(): NonWorkingPeriod[];
10469
10518
  /**
10470
10519
  * Gets current value of property {@link #getShowEmptyIntervalHeaders showEmptyIntervalHeaders}.
10471
10520
  *
@@ -10587,6 +10636,20 @@ declare module "sap/ui/unified/CalendarRow" {
10587
10636
  */
10588
10637
  oIntervalHeader: CalendarAppointment
10589
10638
  ): int;
10639
+ /**
10640
+ * Checks for the provided `sap.ui.unified.NonWorkingPeriod` in the aggregation {@link #getNonWorkingPeriods nonWorkingPeriods}.
10641
+ * and returns its index if found or -1 otherwise.
10642
+ *
10643
+ * @since 1.128
10644
+ *
10645
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
10646
+ */
10647
+ indexOfNonWorkingPeriod(
10648
+ /**
10649
+ * The nonWorkingPeriod whose index is looked for
10650
+ */
10651
+ oNonWorkingPeriod: NonWorkingPeriod
10652
+ ): int;
10590
10653
  /**
10591
10654
  * Inserts a appointment into the aggregation {@link #getAppointments appointments}.
10592
10655
  *
@@ -10623,6 +10686,25 @@ declare module "sap/ui/unified/CalendarRow" {
10623
10686
  */
10624
10687
  iIndex: int
10625
10688
  ): this;
10689
+ /**
10690
+ * Inserts a nonWorkingPeriod into the aggregation {@link #getNonWorkingPeriods nonWorkingPeriods}.
10691
+ *
10692
+ * @since 1.128
10693
+ *
10694
+ * @returns Reference to `this` in order to allow method chaining
10695
+ */
10696
+ insertNonWorkingPeriod(
10697
+ /**
10698
+ * The nonWorkingPeriod to insert; if empty, nothing is inserted
10699
+ */
10700
+ oNonWorkingPeriod: NonWorkingPeriod,
10701
+ /**
10702
+ * The `0`-based index the nonWorkingPeriod should be inserted at; for a negative value of `iIndex`, the
10703
+ * nonWorkingPeriod is inserted at position 0; for a value greater than the current size of the aggregation,
10704
+ * the nonWorkingPeriod is inserted at the last position
10705
+ */
10706
+ iIndex: int
10707
+ ): this;
10626
10708
  /**
10627
10709
  * Removes all the controls from the aggregation {@link #getAppointments appointments}.
10628
10710
  *
@@ -10648,6 +10730,16 @@ declare module "sap/ui/unified/CalendarRow" {
10648
10730
  * @returns An array of the removed elements (might be empty)
10649
10731
  */
10650
10732
  removeAllIntervalHeaders(): CalendarAppointment[];
10733
+ /**
10734
+ * Removes all the controls from the aggregation {@link #getNonWorkingPeriods nonWorkingPeriods}.
10735
+ *
10736
+ * Additionally, it unregisters them from the hosting UIArea.
10737
+ *
10738
+ * @since 1.128
10739
+ *
10740
+ * @returns An array of the removed elements (might be empty)
10741
+ */
10742
+ removeAllNonWorkingPeriods(): NonWorkingPeriod[];
10651
10743
  /**
10652
10744
  * Removes a appointment from the aggregation {@link #getAppointments appointments}.
10653
10745
  *
@@ -10684,6 +10776,19 @@ declare module "sap/ui/unified/CalendarRow" {
10684
10776
  */
10685
10777
  vIntervalHeader: int | string | CalendarAppointment
10686
10778
  ): CalendarAppointment | null;
10779
+ /**
10780
+ * Removes a nonWorkingPeriod from the aggregation {@link #getNonWorkingPeriods nonWorkingPeriods}.
10781
+ *
10782
+ * @since 1.128
10783
+ *
10784
+ * @returns The removed nonWorkingPeriod or `null`
10785
+ */
10786
+ removeNonWorkingPeriod(
10787
+ /**
10788
+ * The nonWorkingPeriod to remove or its index or id
10789
+ */
10790
+ vNonWorkingPeriod: int | string | NonWorkingPeriod
10791
+ ): NonWorkingPeriod | null;
10687
10792
  /**
10688
10793
  * Sets a new value for property {@link #getAppointmentHeight appointmentHeight}.
10689
10794
  *
@@ -11280,6 +11385,17 @@ declare module "sap/ui/unified/CalendarRow" {
11280
11385
  | AggregationBindingInfo
11281
11386
  | `{${string}}`;
11282
11387
 
11388
+ /**
11389
+ * Sets the provided period to be displayed as a non-working.
11390
+ *
11391
+ * @since 1.128
11392
+ */
11393
+ nonWorkingPeriods?:
11394
+ | NonWorkingPeriod[]
11395
+ | NonWorkingPeriod
11396
+ | AggregationBindingInfo
11397
+ | `{${string}}`;
11398
+
11283
11399
  /**
11284
11400
  * Appointments to be displayed in the top of the intervals. The `intervalHeaders` are used to visualize
11285
11401
  * public holidays and similar things.
@@ -17840,7 +17956,7 @@ declare module "sap/ui/unified/Menu" {
17840
17956
 
17841
17957
  import { IContextMenu, ID, Dock, Collision } from "sap/ui/core/library";
17842
17958
 
17843
- import MenuItemBase from "sap/ui/unified/MenuItemBase";
17959
+ import { IMenuItem } from "sap/ui/unified/library";
17844
17960
 
17845
17961
  import ElementMetadata from "sap/ui/core/ElementMetadata";
17846
17962
 
@@ -17851,6 +17967,8 @@ declare module "sap/ui/unified/Menu" {
17851
17967
  AggregationBindingInfo,
17852
17968
  } from "sap/ui/base/ManagedObject";
17853
17969
 
17970
+ import MenuItemBase from "sap/ui/unified/MenuItemBase";
17971
+
17854
17972
  import Event from "sap/ui/base/Event";
17855
17973
 
17856
17974
  /**
@@ -17947,7 +18065,7 @@ declare module "sap/ui/unified/Menu" {
17947
18065
  /**
17948
18066
  * The item to add; if empty, nothing is inserted
17949
18067
  */
17950
- oItem: MenuItemBase
18068
+ oItem: IMenuItem
17951
18069
  ): this;
17952
18070
  /**
17953
18071
  * Attaches event handler `fnFunction` to the {@link #event:itemSelect itemSelect} event of this `sap.ui.unified.Menu`.
@@ -18075,7 +18193,7 @@ declare module "sap/ui/unified/Menu" {
18075
18193
  *
18076
18194
  * The available actions to be displayed as items of the menu.
18077
18195
  */
18078
- getItems(): MenuItemBase[];
18196
+ getItems(): IMenuItem[];
18079
18197
  /**
18080
18198
  * Gets current value of property {@link #getMaxVisibleItems maxVisibleItems}.
18081
18199
  *
@@ -18108,8 +18226,18 @@ declare module "sap/ui/unified/Menu" {
18108
18226
  */
18109
18227
  getPageSize(): int;
18110
18228
  /**
18111
- * Checks for the provided `sap.ui.unified.MenuItemBase` in the aggregation {@link #getItems items}. and
18112
- * returns its index if found or -1 otherwise.
18229
+ * Returns all items that have `selected` properties set to `true`. **Note:** Only items with `selected`
18230
+ * property set that are members of `MenuItemGroup` with `ItemSelectionMode` property set to {@link sap.ui.core.ItemSelectionMode.SingleSelect }
18231
+ * or {@link sap.ui.unified.ItemSelectionMode.MultiSelect}> are taken into account.
18232
+ *
18233
+ * @since 1.127.0
18234
+ *
18235
+ * @returns Array of all selected items
18236
+ */
18237
+ getSelectedItems(): any[];
18238
+ /**
18239
+ * Checks for the provided `sap.ui.unified.IMenuItem` in the aggregation {@link #getItems items}. and returns
18240
+ * its index if found or -1 otherwise.
18113
18241
  *
18114
18242
  *
18115
18243
  * @returns The index of the provided control in the aggregation if found, or -1 otherwise
@@ -18118,7 +18246,7 @@ declare module "sap/ui/unified/Menu" {
18118
18246
  /**
18119
18247
  * The item whose index is looked for
18120
18248
  */
18121
- oItem: MenuItemBase
18249
+ oItem: IMenuItem
18122
18250
  ): int;
18123
18251
  /**
18124
18252
  * Inserts a item into the aggregation {@link #getItems items}.
@@ -18130,7 +18258,7 @@ declare module "sap/ui/unified/Menu" {
18130
18258
  /**
18131
18259
  * The item to insert; if empty, nothing is inserted
18132
18260
  */
18133
- oItem: MenuItemBase,
18261
+ oItem: IMenuItem,
18134
18262
  /**
18135
18263
  * The `0`-based index the item should be inserted at; for a negative value of `iIndex`, the item is inserted
18136
18264
  * at position 0; for a value greater than the current size of the aggregation, the item is inserted at
@@ -18215,7 +18343,7 @@ declare module "sap/ui/unified/Menu" {
18215
18343
  *
18216
18344
  * @returns An array of the removed elements (might be empty)
18217
18345
  */
18218
- removeAllItems(): MenuItemBase[];
18346
+ removeAllItems(): IMenuItem[];
18219
18347
  /**
18220
18348
  * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
18221
18349
  *
@@ -18239,8 +18367,8 @@ declare module "sap/ui/unified/Menu" {
18239
18367
  /**
18240
18368
  * The item to remove or its index or id
18241
18369
  */
18242
- vItem: int | string | MenuItemBase
18243
- ): MenuItemBase | null;
18370
+ vItem: int | string | IMenuItem
18371
+ ): IMenuItem | null;
18244
18372
  /**
18245
18373
  * Sets a new value for property {@link #getAriaDescription ariaDescription}.
18246
18374
  *
@@ -18363,11 +18491,7 @@ declare module "sap/ui/unified/Menu" {
18363
18491
  /**
18364
18492
  * The available actions to be displayed as items of the menu.
18365
18493
  */
18366
- items?:
18367
- | MenuItemBase[]
18368
- | MenuItemBase
18369
- | AggregationBindingInfo
18370
- | `{${string}}`;
18494
+ items?: IMenuItem[] | IMenuItem | AggregationBindingInfo | `{${string}}`;
18371
18495
 
18372
18496
  /**
18373
18497
  * Reference to accessible labels (ids of existing DOM elements or controls) for assistive technologies
@@ -18410,6 +18534,8 @@ declare module "sap/ui/unified/MenuItem" {
18410
18534
  $MenuItemBaseSettings,
18411
18535
  } from "sap/ui/unified/MenuItemBase";
18412
18536
 
18537
+ import { IMenuItem } from "sap/ui/unified/library";
18538
+
18413
18539
  import { ID, URI } from "sap/ui/core/library";
18414
18540
 
18415
18541
  import Control from "sap/ui/core/Control";
@@ -18424,7 +18550,8 @@ declare module "sap/ui/unified/MenuItem" {
18424
18550
  *
18425
18551
  * @since 1.21.0
18426
18552
  */
18427
- export default class MenuItem extends MenuItemBase {
18553
+ export default class MenuItem extends MenuItemBase implements IMenuItem {
18554
+ __implements__sap_ui_unified_IMenuItem: boolean;
18428
18555
  /**
18429
18556
  * Constructor for a new MenuItem element.
18430
18557
  *
@@ -18515,6 +18642,13 @@ declare module "sap/ui/unified/MenuItem" {
18515
18642
  * @returns Value of property `icon`
18516
18643
  */
18517
18644
  getIcon(): URI;
18645
+ /**
18646
+ * @since 1.127.0
18647
+ *
18648
+ * @returns Returns `true` if the `MenuItem` is selected and is part of group with single or multi selection
18649
+ * mode, `false` otherwise.
18650
+ */
18651
+ getSelected(): boolean;
18518
18652
  /**
18519
18653
  * Gets current value of property {@link #getShortcutText shortcutText}.
18520
18654
  *
@@ -18578,6 +18712,20 @@ declare module "sap/ui/unified/MenuItem" {
18578
18712
  */
18579
18713
  sIcon?: URI
18580
18714
  ): this;
18715
+ /**
18716
+ * Sets the `selected` state of the `MenuItem` and deselect other selected `MenuItem` controls if selection
18717
+ * mode is `SingleSelect`.
18718
+ *
18719
+ * @since 1.127.0
18720
+ *
18721
+ * @returns Returns `this` to allow method chaining
18722
+ */
18723
+ setSelected(
18724
+ /**
18725
+ * Whether the state is selected or not
18726
+ */
18727
+ bState: boolean
18728
+ ): this;
18581
18729
  /**
18582
18730
  * Sets a new value for property {@link #getShortcutText shortcutText}.
18583
18731
  *
@@ -18633,6 +18781,16 @@ declare module "sap/ui/unified/MenuItem" {
18633
18781
  */
18634
18782
  icon?: URI | PropertyBindingInfo | `{${string}}`;
18635
18783
 
18784
+ /**
18785
+ * Determines whether the `MenuItem` is selected (default is set to `false`). A selected `MenuItem` has
18786
+ * a check mark rendered at its end. **Note: ** selection functionality works only if the menu item is a
18787
+ * member of `MenuItemGroup` with `itemSelectionMode` set to {@link sap.ui.core.ItemSelectionMode.SingleSelect }
18788
+ * or {@link sap.ui.unified.ItemSelectionMode.MultiSelect}.
18789
+ *
18790
+ * @since 1.127.0
18791
+ */
18792
+ selected?: boolean | PropertyBindingInfo | `{${string}}`;
18793
+
18636
18794
  /**
18637
18795
  * Defines the shortcut text that should be displayed on the menu item on non-mobile devices. **Note:**
18638
18796
  * The text is only displayed and set as а value of the `aria-keyshortcuts` attribute. There is no built-in
@@ -19041,30 +19199,31 @@ declare module "sap/ui/unified/MenuItemBase" {
19041
19199
  >;
19042
19200
  }
19043
19201
 
19044
- declare module "sap/ui/unified/MenuTextFieldItem" {
19045
- import {
19046
- default as MenuItemBase,
19047
- $MenuItemBaseSettings,
19048
- } from "sap/ui/unified/MenuItemBase";
19202
+ declare module "sap/ui/unified/MenuItemGroup" {
19203
+ import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
19049
19204
 
19050
- import { URI, ValueState } from "sap/ui/core/library";
19205
+ import { IMenuItem } from "sap/ui/unified/library";
19051
19206
 
19052
- import ElementMetadata from "sap/ui/core/ElementMetadata";
19207
+ import { ItemSelectionMode } from "sap/ui/core/library";
19053
19208
 
19054
- import Menu from "sap/ui/unified/Menu";
19209
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
19055
19210
 
19056
- import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
19211
+ import {
19212
+ PropertyBindingInfo,
19213
+ AggregationBindingInfo,
19214
+ } from "sap/ui/base/ManagedObject";
19057
19215
 
19058
19216
  /**
19059
- * Special menu item which contains a label and a text field. This menu item is e.g. helpful for filter
19060
- * implementations. The aggregation `submenu` (inherited from parent class) is not supported for this type
19061
- * of menu item.
19217
+ * Group item to be used inside a menu. A menu items group represents a collection of menu items that can
19218
+ * have the same selection mode (e.g. {@link sap.ui.core.ItemSelectionMode.None}, {@link sap.ui.core.ItemSelectionMode.SingleSelect},
19219
+ * or {@link sap.ui.unified.ItemSelectionMode.MultiSelect}).
19062
19220
  *
19063
- * @since 1.21.0
19221
+ * @since 1.127.0
19064
19222
  */
19065
- export default class MenuTextFieldItem extends MenuItemBase {
19223
+ export default class MenuItemGroup extends UI5Element implements IMenuItem {
19224
+ __implements__sap_ui_unified_IMenuItem: boolean;
19066
19225
  /**
19067
- * Constructor for a new MenuTextFieldItem element.
19226
+ * Constructor for a new MenuItemGroup element.
19068
19227
  *
19069
19228
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
19070
19229
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
@@ -19074,10 +19233,10 @@ declare module "sap/ui/unified/MenuTextFieldItem" {
19074
19233
  /**
19075
19234
  * Initial settings for the new control
19076
19235
  */
19077
- mSettings?: $MenuTextFieldItemSettings
19236
+ mSettings?: $MenuItemGroupSettings
19078
19237
  );
19079
19238
  /**
19080
- * Constructor for a new MenuTextFieldItem element.
19239
+ * Constructor for a new MenuItemGroup element.
19081
19240
  *
19082
19241
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
19083
19242
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
@@ -19085,20 +19244,20 @@ declare module "sap/ui/unified/MenuTextFieldItem" {
19085
19244
  */
19086
19245
  constructor(
19087
19246
  /**
19088
- * Id for the new control, generated automatically if no id is given
19247
+ * ID for the new control, generated automatically if no ID is given
19089
19248
  */
19090
19249
  sId?: string,
19091
19250
  /**
19092
19251
  * Initial settings for the new control
19093
19252
  */
19094
- mSettings?: $MenuTextFieldItemSettings
19253
+ mSettings?: $MenuItemGroupSettings
19095
19254
  );
19096
19255
 
19097
19256
  /**
19098
- * Creates a new subclass of class sap.ui.unified.MenuTextFieldItem with name `sClassName` and enriches
19099
- * it with the information contained in `oClassInfo`.
19257
+ * Creates a new subclass of class sap.ui.unified.MenuItemGroup with name `sClassName` and enriches it with
19258
+ * the information contained in `oClassInfo`.
19100
19259
  *
19101
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.unified.MenuItemBase.extend}.
19260
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
19102
19261
  *
19103
19262
  *
19104
19263
  * @returns Created class / constructor function
@@ -19111,7 +19270,7 @@ declare module "sap/ui/unified/MenuTextFieldItem" {
19111
19270
  /**
19112
19271
  * Object literal with information about the class
19113
19272
  */
19114
- oClassInfo?: sap.ClassInfo<T, MenuTextFieldItem>,
19273
+ oClassInfo?: sap.ClassInfo<T, MenuItemGroup>,
19115
19274
  /**
19116
19275
  * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
19117
19276
  * used by this class
@@ -19119,179 +19278,719 @@ declare module "sap/ui/unified/MenuTextFieldItem" {
19119
19278
  FNMetaImpl?: Function
19120
19279
  ): Function;
19121
19280
  /**
19122
- * Returns a metadata object for class sap.ui.unified.MenuTextFieldItem.
19281
+ * Returns a metadata object for class sap.ui.unified.MenuItemGroup.
19123
19282
  *
19124
19283
  *
19125
19284
  * @returns Metadata object describing this class
19126
19285
  */
19127
19286
  static getMetadata(): ElementMetadata;
19128
19287
  /**
19129
- * The aggregation `submenu` (inherited from parent class) is not supported for this type of menu item.
19288
+ * Override of the default setter that adds a group reference to the item's `group` association.
19130
19289
  *
19131
- * @deprecated (since 1.21) - the aggregation `submenu` (inherited from parent class) is not supported for
19132
- * this type of menu item.
19133
19290
  *
19134
19291
  * @returns `this` to allow method chaining
19135
19292
  */
19136
- destroySubmenu(): this;
19137
- /**
19138
- * Gets current value of property {@link #getIcon icon}.
19139
- *
19140
- * Defines the icon of the {@link sap.ui.core.IconPool sap.ui.core.IconPool} or an image which should be
19141
- * displayed on the item.
19142
- *
19143
- *
19144
- * @returns Value of property `icon`
19145
- */
19146
- getIcon(): URI;
19293
+ addItem(
19294
+ /**
19295
+ * Menu item to be added
19296
+ */
19297
+ oItem: IMenuItem,
19298
+ /**
19299
+ * Whether to suppress the invalidation of the control
19300
+ */
19301
+ bSuppressInvalidate: boolean
19302
+ ): this;
19147
19303
  /**
19148
- * Gets current value of property {@link #getLabel label}.
19149
- *
19150
- * Defines the label of the text field of the item.
19151
- *
19304
+ * Destroys all items from `items` aggregation.
19152
19305
  *
19153
- * @returns Value of property `label`
19154
- */
19155
- getLabel(): string;
19156
- /**
19157
- * The aggregation `submenu` (inherited from parent class) is not supported for this type of menu item.
19158
19306
  *
19159
- * @deprecated (since 1.21) - the aggregation `submenu` (inherited from parent class) is not supported for
19160
- * this type of menu item.
19307
+ * @returns `this` to allow method chaining
19161
19308
  */
19162
- getSubmenu(): Menu;
19309
+ destroyItems(
19310
+ /**
19311
+ * Whether to suppress the invalidation of the control
19312
+ */
19313
+ bSuppressInvalidate: boolean
19314
+ ): this;
19163
19315
  /**
19164
- * Gets current value of property {@link #getValue value}.
19165
- *
19166
- * Defines the value of the text field of the item.
19167
- *
19316
+ * Gets content of aggregation {@link #getItems items}.
19168
19317
  *
19169
- * @returns Value of property `value`
19318
+ * The available items of the menu. **Note:** Adding MenuItemGroup as an item to the MenuItemGroup is not
19319
+ * supported.
19170
19320
  */
19171
- getValue(): string;
19321
+ getItems(): IMenuItem[];
19172
19322
  /**
19173
- * Gets current value of property {@link #getValueState valueState}.
19323
+ * Gets current value of property {@link #getItemSelectionMode itemSelectionMode}.
19174
19324
  *
19175
- * Defines the value state of the text field of the item. This allows you to visualize e.g. warnings or
19176
- * errors.
19325
+ * Defines the selection mode of the child items (e.g. `None`, `SingleSelect`, `MultiSelect`)
19177
19326
  *
19178
19327
  * Default value is `None`.
19179
19328
  *
19180
19329
  *
19181
- * @returns Value of property `valueState`
19330
+ * @returns Value of property `itemSelectionMode`
19182
19331
  */
19183
- getValueState(): ValueState | keyof typeof ValueState;
19332
+ getItemSelectionMode(): ItemSelectionMode;
19184
19333
  /**
19185
- * Sets a new value for property {@link #getIcon icon}.
19186
- *
19187
- * Defines the icon of the {@link sap.ui.core.IconPool sap.ui.core.IconPool} or an image which should be
19188
- * displayed on the item.
19189
- *
19190
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
19334
+ * Checks for the provided `sap.ui.unified.IMenuItem` in the aggregation {@link #getItems items}. and returns
19335
+ * its index if found or -1 otherwise.
19191
19336
  *
19192
19337
  *
19193
- * @returns Reference to `this` in order to allow method chaining
19338
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
19194
19339
  */
19195
- setIcon(
19340
+ indexOfItem(
19196
19341
  /**
19197
- * New value for property `icon`
19342
+ * The item whose index is looked for
19198
19343
  */
19199
- sIcon?: URI
19200
- ): this;
19344
+ oItem: IMenuItem
19345
+ ): int;
19201
19346
  /**
19202
- * Sets a new value for property {@link #getLabel label}.
19203
- *
19204
- * Defines the label of the text field of the item.
19205
- *
19206
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
19347
+ * Override of the default setter that adds a group reference to the item's `group` association.
19207
19348
  *
19208
19349
  *
19209
- * @returns Reference to `this` in order to allow method chaining
19350
+ * @returns `this` to allow method chaining
19210
19351
  */
19211
- setLabel(
19352
+ insertItem(
19212
19353
  /**
19213
- * New value for property `label`
19354
+ * Menu item to be added
19214
19355
  */
19215
- sLabel?: string
19356
+ oItem: IMenuItem,
19357
+ /**
19358
+ * Index at which the item should be inserted
19359
+ */
19360
+ iIndex: int,
19361
+ /**
19362
+ * Whether to suppress the invalidation of the control
19363
+ */
19364
+ bSuppressInvalidate: boolean
19216
19365
  ): this;
19217
19366
  /**
19218
- * The aggregation `submenu` (inherited from parent class) is not supported for this type of menu item.
19367
+ * Removes all items from `items` aggregation.
19219
19368
  *
19220
- * @deprecated (since 1.21) - the aggregation `submenu` (inherited from parent class) is not supported for
19221
- * this type of menu item.
19222
19369
  *
19223
- * @returns `this` to allow method chaining
19370
+ * @returns array containing the removed items, or null if there are no items to remove
19224
19371
  */
19225
- setSubmenu(
19372
+ removeAllItems(
19226
19373
  /**
19227
- * The menu to which the sap.ui.unified.Submenu should be set
19374
+ * Whether to suppress the invalidation of the control
19228
19375
  */
19229
- oMenu: Menu
19230
- ): this;
19376
+ bSuppressInvalidate: boolean
19377
+ ): any[] | null;
19231
19378
  /**
19232
- * Sets a new value for property {@link #getValue value}.
19233
- *
19234
- * Defines the value of the text field of the item.
19235
- *
19236
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
19379
+ * Removes an item from `items` aggregation.
19237
19380
  *
19238
19381
  *
19239
- * @returns Reference to `this` in order to allow method chaining
19382
+ * @returns the removed object, or `null` if there are no items to remove
19240
19383
  */
19241
- setValue(
19384
+ removeItem(
19242
19385
  /**
19243
- * New value for property `value`
19386
+ * Menu item to be removed (as index, ID or object)
19244
19387
  */
19245
- sValue?: string
19246
- ): this;
19388
+ vItem: int | string | IMenuItem,
19389
+ /**
19390
+ * Whether to suppress the invalidation of the control
19391
+ */
19392
+ bSuppressInvalidate: boolean
19393
+ ): IMenuItem | null;
19247
19394
  /**
19248
- * Sets a new value for property {@link #getValueState valueState}.
19249
- *
19250
- * Defines the value state of the text field of the item. This allows you to visualize e.g. warnings or
19251
- * errors.
19252
- *
19253
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
19254
- *
19255
- * Default value is `None`.
19395
+ * Override of the default setter that also ensures single selection if necessary.
19256
19396
  *
19257
19397
  *
19258
- * @returns Reference to `this` in order to allow method chaining
19398
+ * @returns `this` to allow method chaining
19259
19399
  */
19260
- setValueState(
19400
+ setItemSelectionMode(
19261
19401
  /**
19262
- * New value for property `valueState`
19402
+ * item selection mode to be set
19263
19403
  */
19264
- sValueState?: ValueState | keyof typeof ValueState
19404
+ sSelectionMode: string,
19405
+ /**
19406
+ * Whether to suppress the invalidation of the control
19407
+ */
19408
+ bSuppressInvalidate: boolean
19265
19409
  ): this;
19266
19410
  }
19267
19411
  /**
19268
- * Describes the settings that can be provided to the MenuTextFieldItem constructor.
19412
+ * Describes the settings that can be provided to the MenuItemGroup constructor.
19269
19413
  */
19270
- export interface $MenuTextFieldItemSettings extends $MenuItemBaseSettings {
19414
+ export interface $MenuItemGroupSettings extends $ElementSettings {
19271
19415
  /**
19272
- * Defines the label of the text field of the item.
19416
+ * Defines the selection mode of the child items (e.g. `None`, `SingleSelect`, `MultiSelect`)
19273
19417
  */
19274
- label?: string | PropertyBindingInfo;
19418
+ itemSelectionMode?: ItemSelectionMode | PropertyBindingInfo | `{${string}}`;
19275
19419
 
19276
19420
  /**
19277
- * Defines the icon of the {@link sap.ui.core.IconPool sap.ui.core.IconPool} or an image which should be
19278
- * displayed on the item.
19421
+ * The available items of the menu. **Note:** Adding MenuItemGroup as an item to the MenuItemGroup is not
19422
+ * supported.
19423
+ */
19424
+ items?: IMenuItem[] | IMenuItem | AggregationBindingInfo | `{${string}}`;
19425
+ }
19426
+ }
19427
+
19428
+ declare module "sap/ui/unified/MenuTextFieldItem" {
19429
+ import {
19430
+ default as MenuItemBase,
19431
+ $MenuItemBaseSettings,
19432
+ } from "sap/ui/unified/MenuItemBase";
19433
+
19434
+ import { IMenuItem } from "sap/ui/unified/library";
19435
+
19436
+ import { URI, ValueState } from "sap/ui/core/library";
19437
+
19438
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
19439
+
19440
+ import Menu from "sap/ui/unified/Menu";
19441
+
19442
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
19443
+
19444
+ /**
19445
+ * Special menu item which contains a label and a text field. This menu item is e.g. helpful for filter
19446
+ * implementations. The aggregation `submenu` (inherited from parent class) is not supported for this type
19447
+ * of menu item.
19448
+ *
19449
+ * @since 1.21.0
19450
+ */
19451
+ export default class MenuTextFieldItem
19452
+ extends MenuItemBase
19453
+ implements IMenuItem
19454
+ {
19455
+ __implements__sap_ui_unified_IMenuItem: boolean;
19456
+ /**
19457
+ * Constructor for a new MenuTextFieldItem element.
19458
+ *
19459
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
19460
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
19461
+ * of the syntax of the settings object.
19462
+ */
19463
+ constructor(
19464
+ /**
19465
+ * Initial settings for the new control
19466
+ */
19467
+ mSettings?: $MenuTextFieldItemSettings
19468
+ );
19469
+ /**
19470
+ * Constructor for a new MenuTextFieldItem element.
19471
+ *
19472
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
19473
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
19474
+ * of the syntax of the settings object.
19475
+ */
19476
+ constructor(
19477
+ /**
19478
+ * Id for the new control, generated automatically if no id is given
19479
+ */
19480
+ sId?: string,
19481
+ /**
19482
+ * Initial settings for the new control
19483
+ */
19484
+ mSettings?: $MenuTextFieldItemSettings
19485
+ );
19486
+
19487
+ /**
19488
+ * Creates a new subclass of class sap.ui.unified.MenuTextFieldItem with name `sClassName` and enriches
19489
+ * it with the information contained in `oClassInfo`.
19490
+ *
19491
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.unified.MenuItemBase.extend}.
19492
+ *
19493
+ *
19494
+ * @returns Created class / constructor function
19495
+ */
19496
+ static extend<T extends Record<string, unknown>>(
19497
+ /**
19498
+ * Name of the class being created
19499
+ */
19500
+ sClassName: string,
19501
+ /**
19502
+ * Object literal with information about the class
19503
+ */
19504
+ oClassInfo?: sap.ClassInfo<T, MenuTextFieldItem>,
19505
+ /**
19506
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
19507
+ * used by this class
19508
+ */
19509
+ FNMetaImpl?: Function
19510
+ ): Function;
19511
+ /**
19512
+ * Returns a metadata object for class sap.ui.unified.MenuTextFieldItem.
19513
+ *
19514
+ *
19515
+ * @returns Metadata object describing this class
19516
+ */
19517
+ static getMetadata(): ElementMetadata;
19518
+ /**
19519
+ * The aggregation `submenu` (inherited from parent class) is not supported for this type of menu item.
19520
+ *
19521
+ * @deprecated (since 1.21) - the aggregation `submenu` (inherited from parent class) is not supported for
19522
+ * this type of menu item.
19523
+ *
19524
+ * @returns `this` to allow method chaining
19525
+ */
19526
+ destroySubmenu(): this;
19527
+ /**
19528
+ * Gets current value of property {@link #getIcon icon}.
19529
+ *
19530
+ * Defines the icon of the {@link sap.ui.core.IconPool sap.ui.core.IconPool} or an image which should be
19531
+ * displayed on the item.
19532
+ *
19533
+ *
19534
+ * @returns Value of property `icon`
19535
+ */
19536
+ getIcon(): URI;
19537
+ /**
19538
+ * Gets current value of property {@link #getLabel label}.
19539
+ *
19540
+ * Defines the label of the text field of the item.
19541
+ *
19542
+ *
19543
+ * @returns Value of property `label`
19544
+ */
19545
+ getLabel(): string;
19546
+ /**
19547
+ * The aggregation `submenu` (inherited from parent class) is not supported for this type of menu item.
19548
+ *
19549
+ * @deprecated (since 1.21) - the aggregation `submenu` (inherited from parent class) is not supported for
19550
+ * this type of menu item.
19551
+ */
19552
+ getSubmenu(): Menu;
19553
+ /**
19554
+ * Gets current value of property {@link #getValue value}.
19555
+ *
19556
+ * Defines the value of the text field of the item.
19557
+ *
19558
+ *
19559
+ * @returns Value of property `value`
19560
+ */
19561
+ getValue(): string;
19562
+ /**
19563
+ * Gets current value of property {@link #getValueState valueState}.
19564
+ *
19565
+ * Defines the value state of the text field of the item. This allows you to visualize e.g. warnings or
19566
+ * errors.
19567
+ *
19568
+ * Default value is `None`.
19569
+ *
19570
+ *
19571
+ * @returns Value of property `valueState`
19572
+ */
19573
+ getValueState(): ValueState | keyof typeof ValueState;
19574
+ /**
19575
+ * Sets a new value for property {@link #getIcon icon}.
19576
+ *
19577
+ * Defines the icon of the {@link sap.ui.core.IconPool sap.ui.core.IconPool} or an image which should be
19578
+ * displayed on the item.
19579
+ *
19580
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
19581
+ *
19582
+ *
19583
+ * @returns Reference to `this` in order to allow method chaining
19584
+ */
19585
+ setIcon(
19586
+ /**
19587
+ * New value for property `icon`
19588
+ */
19589
+ sIcon?: URI
19590
+ ): this;
19591
+ /**
19592
+ * Sets a new value for property {@link #getLabel label}.
19593
+ *
19594
+ * Defines the label of the text field of the item.
19595
+ *
19596
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
19597
+ *
19598
+ *
19599
+ * @returns Reference to `this` in order to allow method chaining
19600
+ */
19601
+ setLabel(
19602
+ /**
19603
+ * New value for property `label`
19604
+ */
19605
+ sLabel?: string
19606
+ ): this;
19607
+ /**
19608
+ * The aggregation `submenu` (inherited from parent class) is not supported for this type of menu item.
19609
+ *
19610
+ * @deprecated (since 1.21) - the aggregation `submenu` (inherited from parent class) is not supported for
19611
+ * this type of menu item.
19612
+ *
19613
+ * @returns `this` to allow method chaining
19614
+ */
19615
+ setSubmenu(
19616
+ /**
19617
+ * The menu to which the sap.ui.unified.Submenu should be set
19618
+ */
19619
+ oMenu: Menu
19620
+ ): this;
19621
+ /**
19622
+ * Sets a new value for property {@link #getValue value}.
19623
+ *
19624
+ * Defines the value of the text field of the item.
19625
+ *
19626
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
19627
+ *
19628
+ *
19629
+ * @returns Reference to `this` in order to allow method chaining
19630
+ */
19631
+ setValue(
19632
+ /**
19633
+ * New value for property `value`
19634
+ */
19635
+ sValue?: string
19636
+ ): this;
19637
+ /**
19638
+ * Sets a new value for property {@link #getValueState valueState}.
19639
+ *
19640
+ * Defines the value state of the text field of the item. This allows you to visualize e.g. warnings or
19641
+ * errors.
19642
+ *
19643
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
19644
+ *
19645
+ * Default value is `None`.
19646
+ *
19647
+ *
19648
+ * @returns Reference to `this` in order to allow method chaining
19649
+ */
19650
+ setValueState(
19651
+ /**
19652
+ * New value for property `valueState`
19653
+ */
19654
+ sValueState?: ValueState | keyof typeof ValueState
19655
+ ): this;
19656
+ }
19657
+ /**
19658
+ * Describes the settings that can be provided to the MenuTextFieldItem constructor.
19659
+ */
19660
+ export interface $MenuTextFieldItemSettings extends $MenuItemBaseSettings {
19661
+ /**
19662
+ * Defines the label of the text field of the item.
19663
+ */
19664
+ label?: string | PropertyBindingInfo;
19665
+
19666
+ /**
19667
+ * Defines the icon of the {@link sap.ui.core.IconPool sap.ui.core.IconPool} or an image which should be
19668
+ * displayed on the item.
19279
19669
  */
19280
19670
  icon?: URI | PropertyBindingInfo | `{${string}}`;
19281
19671
 
19282
19672
  /**
19283
- * Defines the value of the text field of the item.
19673
+ * Defines the value of the text field of the item.
19674
+ */
19675
+ value?: string | PropertyBindingInfo;
19676
+
19677
+ /**
19678
+ * Defines the value state of the text field of the item. This allows you to visualize e.g. warnings or
19679
+ * errors.
19680
+ */
19681
+ valueState?:
19682
+ | (ValueState | keyof typeof ValueState)
19683
+ | PropertyBindingInfo
19684
+ | `{${string}}`;
19685
+ }
19686
+ }
19687
+
19688
+ declare module "sap/ui/unified/NonWorkingPeriod" {
19689
+ import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
19690
+
19691
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
19692
+
19693
+ import TimeRange from "sap/ui/unified/TimeRange";
19694
+
19695
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
19696
+
19697
+ /**
19698
+ * NonWorkingPeriod
19699
+ *
19700
+ * @since 1.27.0
19701
+ * @experimental (since 1.127.0)
19702
+ */
19703
+ export default class NonWorkingPeriod extends UI5Element {
19704
+ /**
19705
+ * Constructor for a new NonWorkingPeriod.
19706
+ *
19707
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
19708
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
19709
+ * of the syntax of the settings object.
19710
+ */
19711
+ constructor(
19712
+ /**
19713
+ * initial settings for the new control
19714
+ */
19715
+ mSettings?: $NonWorkingPeriodSettings
19716
+ );
19717
+ /**
19718
+ * Constructor for a new NonWorkingPeriod.
19719
+ *
19720
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
19721
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
19722
+ * of the syntax of the settings object.
19723
+ */
19724
+ constructor(
19725
+ /**
19726
+ * ID for the new control, generated automatically if no ID is given
19727
+ */
19728
+ sId?: string,
19729
+ /**
19730
+ * initial settings for the new control
19731
+ */
19732
+ mSettings?: $NonWorkingPeriodSettings
19733
+ );
19734
+
19735
+ /**
19736
+ * Creates a new subclass of class sap.ui.unified.NonWorkingPeriod with name `sClassName` and enriches it
19737
+ * with the information contained in `oClassInfo`.
19738
+ *
19739
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
19740
+ *
19741
+ *
19742
+ * @returns Created class / constructor function
19743
+ */
19744
+ static extend<T extends Record<string, unknown>>(
19745
+ /**
19746
+ * Name of the class being created
19747
+ */
19748
+ sClassName: string,
19749
+ /**
19750
+ * Object literal with information about the class
19751
+ */
19752
+ oClassInfo?: sap.ClassInfo<T, NonWorkingPeriod>,
19753
+ /**
19754
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
19755
+ * used by this class
19756
+ */
19757
+ FNMetaImpl?: Function
19758
+ ): Function;
19759
+ /**
19760
+ * Returns a metadata object for class sap.ui.unified.NonWorkingPeriod.
19761
+ *
19762
+ *
19763
+ * @returns Metadata object describing this class
19764
+ */
19765
+ static getMetadata(): ElementMetadata;
19766
+ /**
19767
+ * Destroys the timeRange in the aggregation {@link #getTimeRange timeRange}.
19768
+ *
19769
+ *
19770
+ * @returns Reference to `this` in order to allow method chaining
19771
+ */
19772
+ destroyTimeRange(): this;
19773
+ /**
19774
+ * Gets current value of property {@link #getDate date}.
19775
+ *
19776
+ * Determines the day to which the timeRange refers. This object must be a UI5Date or JavaScript Date object.
19777
+ *
19778
+ *
19779
+ * @returns Value of property `date`
19780
+ */
19781
+ getDate(): object;
19782
+ /**
19783
+ * Returns the duration of the non-working period.
19784
+ *
19785
+ *
19786
+ * @returns returns a number that represents the duration of a calendar item in minutes
19787
+ */
19788
+ getDurationInMinutes(): int;
19789
+ /**
19790
+ * Gets content of aggregation {@link #getTimeRange timeRange}.
19791
+ *
19792
+ * Defines the hours range for the non-working period.
19793
+ */
19794
+ getTimeRange(): TimeRange;
19795
+ /**
19796
+ * Sets a new value for property {@link #getDate date}.
19797
+ *
19798
+ * Determines the day to which the timeRange refers. This object must be a UI5Date or JavaScript Date object.
19799
+ *
19800
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
19801
+ *
19802
+ *
19803
+ * @returns Reference to `this` in order to allow method chaining
19804
+ */
19805
+ setDate(
19806
+ /**
19807
+ * New value for property `date`
19808
+ */
19809
+ oDate: object
19810
+ ): this;
19811
+ /**
19812
+ * Sets the aggregated {@link #getTimeRange timeRange}.
19813
+ *
19814
+ *
19815
+ * @returns Reference to `this` in order to allow method chaining
19816
+ */
19817
+ setTimeRange(
19818
+ /**
19819
+ * The timeRange to set
19820
+ */
19821
+ oTimeRange: TimeRange
19822
+ ): this;
19823
+ }
19824
+ /**
19825
+ * Describes the settings that can be provided to the NonWorkingPeriod constructor.
19826
+ *
19827
+ * @experimental (since 1.127.0)
19828
+ */
19829
+ export interface $NonWorkingPeriodSettings extends $ElementSettings {
19830
+ /**
19831
+ * Determines the day to which the timeRange refers. This object must be a UI5Date or JavaScript Date object.
19832
+ */
19833
+ date?: object | PropertyBindingInfo | `{${string}}`;
19834
+
19835
+ /**
19836
+ * Defines the hours range for the non-working period.
19284
19837
  */
19285
- value?: string | PropertyBindingInfo;
19838
+ timeRange?: TimeRange;
19839
+ }
19840
+ }
19286
19841
 
19842
+ declare module "sap/ui/unified/RecurringNonWorkingPeriod" {
19843
+ import Metadata from "sap/ui/base/Metadata";
19844
+
19845
+ import { RecurrenceType } from "sap/ui/unified/library";
19846
+
19847
+ /**
19848
+ * A `RecurringNonWorkingPeriod` for use in a `PlanningCalendar` and `SinglePlanningCalendar`.
19849
+ *
19850
+ * Applications can inherit from this element to add own fields.
19851
+ *
19852
+ * @since 1.127.0
19853
+ * @experimental (since 1.127.0)
19854
+ */
19855
+ export default class RecurringNonWorkingPeriod
19856
+ extends /* was: sap.ui.unified. */ Object
19857
+ {
19287
19858
  /**
19288
- * Defines the value state of the text field of the item. This allows you to visualize e.g. warnings or
19289
- * errors.
19859
+ * Constructor for a new `RecurringNonWorkingPeriod`.
19860
+ *
19861
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
19862
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
19863
+ * of the syntax of the settings object.
19290
19864
  */
19291
- valueState?:
19292
- | (ValueState | keyof typeof ValueState)
19293
- | PropertyBindingInfo
19294
- | `{${string}}`;
19865
+ constructor(
19866
+ /**
19867
+ * ID for the new control, generated automatically if no ID is given
19868
+ */
19869
+ sId?: string,
19870
+ /**
19871
+ * Initial settings for the new control
19872
+ */
19873
+ mSettings?: object
19874
+ );
19875
+
19876
+ /**
19877
+ * Creates a new subclass of class sap.ui.unified.RecurringNonWorkingPeriod with name `sClassName` and enriches
19878
+ * it with the information contained in `oClassInfo`.
19879
+ *
19880
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.unified..extend}.
19881
+ *
19882
+ *
19883
+ * @returns Created class / constructor function
19884
+ */
19885
+ static extend<T extends Record<string, unknown>>(
19886
+ /**
19887
+ * Name of the class being created
19888
+ */
19889
+ sClassName: string,
19890
+ /**
19891
+ * Object literal with information about the class
19892
+ */
19893
+ oClassInfo?: sap.ClassInfo<T, RecurringNonWorkingPeriod>,
19894
+ /**
19895
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
19896
+ * used by this class
19897
+ */
19898
+ FNMetaImpl?: Function
19899
+ ): Function;
19900
+ /**
19901
+ * Returns a metadata object for class sap.ui.unified.RecurringNonWorkingPeriod.
19902
+ *
19903
+ *
19904
+ * @returns Metadata object describing this class
19905
+ */
19906
+ static getMetadata(): Metadata;
19907
+ /**
19908
+ * Gets current value of property {@link #getRecurrenceEndDate recurrenceEndDate}.
19909
+ *
19910
+ * Determines the end date of the calendar item, as a UI5Date or JavaScript Date object. It is considered
19911
+ * as a local date.
19912
+ *
19913
+ *
19914
+ * @returns Value of property `recurrenceEndDate`
19915
+ */
19916
+ getRecurrenceEndDate(): object;
19917
+ /**
19918
+ * Gets current value of property {@link #getRecurrencePattern recurrencePattern}.
19919
+ *
19920
+ * The recurrencePattern is an integer value which, in combination with the recurrenceType, sets the recurrence
19921
+ * frequency for a calendar item. For example, if the recurrenceType is set to "Daily" and the recurrencePattern
19922
+ * is set to 1, it signifies that repetition is set for every day. If the recurrencePattern is set to 3,
19923
+ * this would imply the calendar item is recurring once for every three days.
19924
+ *
19925
+ * Default value is `1`.
19926
+ *
19927
+ *
19928
+ * @returns Value of property `recurrencePattern`
19929
+ */
19930
+ getRecurrencePattern(): int;
19931
+ /**
19932
+ * Gets current value of property {@link #getRecurrenceType recurrenceType}.
19933
+ *
19934
+ * The recurrenceType determines the pattern of recurrence for a given calendar item.
19935
+ *
19936
+ *
19937
+ * @returns Value of property `recurrenceType`
19938
+ */
19939
+ getRecurrenceType(): RecurrenceType | keyof typeof RecurrenceType;
19940
+ /**
19941
+ * Sets a new value for property {@link #getRecurrenceEndDate recurrenceEndDate}.
19942
+ *
19943
+ * Determines the end date of the calendar item, as a UI5Date or JavaScript Date object. It is considered
19944
+ * as a local date.
19945
+ *
19946
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
19947
+ *
19948
+ *
19949
+ * @returns Reference to `this` in order to allow method chaining
19950
+ */
19951
+ setRecurrenceEndDate(
19952
+ /**
19953
+ * New value for property `recurrenceEndDate`
19954
+ */
19955
+ oRecurrenceEndDate: object
19956
+ ): this;
19957
+ /**
19958
+ * Sets a new value for property {@link #getRecurrencePattern recurrencePattern}.
19959
+ *
19960
+ * The recurrencePattern is an integer value which, in combination with the recurrenceType, sets the recurrence
19961
+ * frequency for a calendar item. For example, if the recurrenceType is set to "Daily" and the recurrencePattern
19962
+ * is set to 1, it signifies that repetition is set for every day. If the recurrencePattern is set to 3,
19963
+ * this would imply the calendar item is recurring once for every three days.
19964
+ *
19965
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
19966
+ *
19967
+ * Default value is `1`.
19968
+ *
19969
+ *
19970
+ * @returns Reference to `this` in order to allow method chaining
19971
+ */
19972
+ setRecurrencePattern(
19973
+ /**
19974
+ * New value for property `recurrencePattern`
19975
+ */
19976
+ iRecurrencePattern?: int
19977
+ ): this;
19978
+ /**
19979
+ * Sets a new value for property {@link #getRecurrenceType recurrenceType}.
19980
+ *
19981
+ * The recurrenceType determines the pattern of recurrence for a given calendar item.
19982
+ *
19983
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
19984
+ *
19985
+ *
19986
+ * @returns Reference to `this` in order to allow method chaining
19987
+ */
19988
+ setRecurrenceType(
19989
+ /**
19990
+ * New value for property `recurrenceType`
19991
+ */
19992
+ sRecurrenceType: RecurrenceType | keyof typeof RecurrenceType
19993
+ ): this;
19295
19994
  }
19296
19995
  }
19297
19996
 
@@ -21960,6 +22659,207 @@ declare module "sap/ui/unified/SplitContainer" {
21960
22659
  }
21961
22660
  }
21962
22661
 
22662
+ declare module "sap/ui/unified/TimeRange" {
22663
+ import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
22664
+
22665
+ import UI5Date from "sap/ui/core/date/UI5Date";
22666
+
22667
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
22668
+
22669
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
22670
+
22671
+ /**
22672
+ * Time range for use in `NonWorkingPeriod`
22673
+ *
22674
+ * @since 1.127.0
22675
+ * @experimental (since 1.127.0)
22676
+ */
22677
+ export default class TimeRange extends UI5Element {
22678
+ /**
22679
+ * Constructor for a new TimeRange.
22680
+ *
22681
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
22682
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
22683
+ * of the syntax of the settings object.
22684
+ */
22685
+ constructor(
22686
+ /**
22687
+ * initial settings for the new control
22688
+ */
22689
+ mSettings?: $TimeRangeSettings
22690
+ );
22691
+ /**
22692
+ * Constructor for a new TimeRange.
22693
+ *
22694
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
22695
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
22696
+ * of the syntax of the settings object.
22697
+ */
22698
+ constructor(
22699
+ /**
22700
+ * ID for the new control, generated automatically if no ID is given
22701
+ */
22702
+ sId?: string,
22703
+ /**
22704
+ * initial settings for the new control
22705
+ */
22706
+ mSettings?: $TimeRangeSettings
22707
+ );
22708
+
22709
+ /**
22710
+ * Creates a new subclass of class sap.ui.unified.TimeRange with name `sClassName` and enriches it with
22711
+ * the information contained in `oClassInfo`.
22712
+ *
22713
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
22714
+ *
22715
+ *
22716
+ * @returns Created class / constructor function
22717
+ */
22718
+ static extend<T extends Record<string, unknown>>(
22719
+ /**
22720
+ * Name of the class being created
22721
+ */
22722
+ sClassName: string,
22723
+ /**
22724
+ * Object literal with information about the class
22725
+ */
22726
+ oClassInfo?: sap.ClassInfo<T, TimeRange>,
22727
+ /**
22728
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
22729
+ * used by this class
22730
+ */
22731
+ FNMetaImpl?: Function
22732
+ ): Function;
22733
+ /**
22734
+ * Returns a metadata object for class sap.ui.unified.TimeRange.
22735
+ *
22736
+ *
22737
+ * @returns Metadata object describing this class
22738
+ */
22739
+ static getMetadata(): ElementMetadata;
22740
+ /**
22741
+ * Gets current value of property {@link #getEnd end}.
22742
+ *
22743
+ * End time for a time range. This must be a String.
22744
+ *
22745
+ *
22746
+ * @returns Value of property `end`
22747
+ */
22748
+ getEnd(): string;
22749
+ /**
22750
+ * Get end date for a time range. From this date, only hours, minutes, seconds, and milliseconds are used.
22751
+ *
22752
+ *
22753
+ * @returns [oDate] A date instance
22754
+ */
22755
+ getEndDate(): Date | UI5Date;
22756
+ /**
22757
+ * Gets current value of property {@link #getStart start}.
22758
+ *
22759
+ * Start time for a time range. This must be a String.
22760
+ *
22761
+ *
22762
+ * @returns Value of property `start`
22763
+ */
22764
+ getStart(): string;
22765
+ /**
22766
+ * Get start date for a time range. From this date, only hours, minutes, seconds, and milliseconds are used.
22767
+ *
22768
+ *
22769
+ * @returns [oDate] A date instance
22770
+ */
22771
+ getStartDate(): Date | UI5Date;
22772
+ /**
22773
+ * Gets current value of property {@link #getValueFormat valueFormat}.
22774
+ *
22775
+ * Determines the format of the startTime and endTime
22776
+ *
22777
+ * **Note:** a time pattern in LDML format. It is not verified whether the pattern only represents a time.
22778
+ *
22779
+ * Default value is `"hh:mm"`.
22780
+ *
22781
+ *
22782
+ * @returns Value of property `valueFormat`
22783
+ */
22784
+ getValueFormat(): string;
22785
+ /**
22786
+ * Sets a new value for property {@link #getEnd end}.
22787
+ *
22788
+ * End time for a time range. This must be a String.
22789
+ *
22790
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
22791
+ *
22792
+ *
22793
+ * @returns Reference to `this` in order to allow method chaining
22794
+ */
22795
+ setEnd(
22796
+ /**
22797
+ * New value for property `end`
22798
+ */
22799
+ sEnd?: string
22800
+ ): this;
22801
+ /**
22802
+ * Sets a new value for property {@link #getStart start}.
22803
+ *
22804
+ * Start time for a time range. This must be a String.
22805
+ *
22806
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
22807
+ *
22808
+ *
22809
+ * @returns Reference to `this` in order to allow method chaining
22810
+ */
22811
+ setStart(
22812
+ /**
22813
+ * New value for property `start`
22814
+ */
22815
+ sStart?: string
22816
+ ): this;
22817
+ /**
22818
+ * Sets a new value for property {@link #getValueFormat valueFormat}.
22819
+ *
22820
+ * Determines the format of the startTime and endTime
22821
+ *
22822
+ * **Note:** a time pattern in LDML format. It is not verified whether the pattern only represents a time.
22823
+ *
22824
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
22825
+ *
22826
+ * Default value is `"hh:mm"`.
22827
+ *
22828
+ *
22829
+ * @returns Reference to `this` in order to allow method chaining
22830
+ */
22831
+ setValueFormat(
22832
+ /**
22833
+ * New value for property `valueFormat`
22834
+ */
22835
+ sValueFormat?: string
22836
+ ): this;
22837
+ }
22838
+ /**
22839
+ * Describes the settings that can be provided to the TimeRange constructor.
22840
+ *
22841
+ * @experimental (since 1.127.0)
22842
+ */
22843
+ export interface $TimeRangeSettings extends $ElementSettings {
22844
+ /**
22845
+ * Start time for a time range. This must be a String.
22846
+ */
22847
+ start?: string | PropertyBindingInfo;
22848
+
22849
+ /**
22850
+ * End time for a time range. This must be a String.
22851
+ */
22852
+ end?: string | PropertyBindingInfo;
22853
+
22854
+ /**
22855
+ * Determines the format of the startTime and endTime
22856
+ *
22857
+ * **Note:** a time pattern in LDML format. It is not verified whether the pattern only represents a time.
22858
+ */
22859
+ valueFormat?: string | PropertyBindingInfo;
22860
+ }
22861
+ }
22862
+
21963
22863
  declare namespace sap {
21964
22864
  interface IUI5DefineDependencyNames {
21965
22865
  "sap/ui/unified/Calendar": undefined;
@@ -22022,8 +22922,14 @@ declare namespace sap {
22022
22922
 
22023
22923
  "sap/ui/unified/MenuItemBase": undefined;
22024
22924
 
22925
+ "sap/ui/unified/MenuItemGroup": undefined;
22926
+
22025
22927
  "sap/ui/unified/MenuTextFieldItem": undefined;
22026
22928
 
22929
+ "sap/ui/unified/NonWorkingPeriod": undefined;
22930
+
22931
+ "sap/ui/unified/RecurringNonWorkingPeriod": undefined;
22932
+
22027
22933
  "sap/ui/unified/Shell": undefined;
22028
22934
 
22029
22935
  "sap/ui/unified/ShellHeadItem": undefined;
@@ -22035,5 +22941,7 @@ declare namespace sap {
22035
22941
  "sap/ui/unified/ShellOverlay": undefined;
22036
22942
 
22037
22943
  "sap/ui/unified/SplitContainer": undefined;
22944
+
22945
+ "sap/ui/unified/TimeRange": undefined;
22038
22946
  }
22039
22947
  }