@openui5/types 1.127.1 → 1.129.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.127.1
1
+ // For Library Version: 1.129.0
2
2
 
3
3
  declare module "sap/ui/unified/library" {
4
4
  /**
@@ -318,6 +318,15 @@ declare module "sap/ui/unified/library" {
318
318
  ): Promise<Blob[]>;
319
319
  }
320
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 {}
321
330
  /**
322
331
  * Standard day types visualized in a {@link sap.m.PlanningCalendarLegend}, which correspond to days in
323
332
  * a {@link sap.ui.unified.Calendar}.
@@ -9770,6 +9779,8 @@ declare module "sap/ui/unified/CalendarRow" {
9770
9779
 
9771
9780
  import { ID, CSSSize } from "sap/ui/core/library";
9772
9781
 
9782
+ import NonWorkingPeriod from "sap/ui/unified/NonWorkingPeriod";
9783
+
9773
9784
  import Event from "sap/ui/base/Event";
9774
9785
 
9775
9786
  import UI5Date from "sap/ui/core/date/UI5Date";
@@ -9895,6 +9906,19 @@ declare module "sap/ui/unified/CalendarRow" {
9895
9906
  */
9896
9907
  oIntervalHeader: CalendarAppointment
9897
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;
9898
9922
  /**
9899
9923
  * Attaches event handler `fnFunction` to the {@link #event:intervalSelect intervalSelect} event of this
9900
9924
  * `sap.ui.unified.CalendarRow`.
@@ -10105,6 +10129,14 @@ declare module "sap/ui/unified/CalendarRow" {
10105
10129
  * @returns Reference to `this` in order to allow method chaining
10106
10130
  */
10107
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;
10108
10140
  /**
10109
10141
  * Detaches event handler `fnFunction` from the {@link #event:intervalSelect intervalSelect} event of this
10110
10142
  * `sap.ui.unified.CalendarRow`.
@@ -10475,6 +10507,14 @@ declare module "sap/ui/unified/CalendarRow" {
10475
10507
  * @returns Value of property `nonWorkingHours`
10476
10508
  */
10477
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[];
10478
10518
  /**
10479
10519
  * Gets current value of property {@link #getShowEmptyIntervalHeaders showEmptyIntervalHeaders}.
10480
10520
  *
@@ -10596,6 +10636,20 @@ declare module "sap/ui/unified/CalendarRow" {
10596
10636
  */
10597
10637
  oIntervalHeader: CalendarAppointment
10598
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;
10599
10653
  /**
10600
10654
  * Inserts a appointment into the aggregation {@link #getAppointments appointments}.
10601
10655
  *
@@ -10632,6 +10686,25 @@ declare module "sap/ui/unified/CalendarRow" {
10632
10686
  */
10633
10687
  iIndex: int
10634
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;
10635
10708
  /**
10636
10709
  * Removes all the controls from the aggregation {@link #getAppointments appointments}.
10637
10710
  *
@@ -10657,6 +10730,16 @@ declare module "sap/ui/unified/CalendarRow" {
10657
10730
  * @returns An array of the removed elements (might be empty)
10658
10731
  */
10659
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[];
10660
10743
  /**
10661
10744
  * Removes a appointment from the aggregation {@link #getAppointments appointments}.
10662
10745
  *
@@ -10693,6 +10776,19 @@ declare module "sap/ui/unified/CalendarRow" {
10693
10776
  */
10694
10777
  vIntervalHeader: int | string | CalendarAppointment
10695
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;
10696
10792
  /**
10697
10793
  * Sets a new value for property {@link #getAppointmentHeight appointmentHeight}.
10698
10794
  *
@@ -11289,6 +11385,17 @@ declare module "sap/ui/unified/CalendarRow" {
11289
11385
  | AggregationBindingInfo
11290
11386
  | `{${string}}`;
11291
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
+
11292
11399
  /**
11293
11400
  * Appointments to be displayed in the top of the intervals. The `intervalHeaders` are used to visualize
11294
11401
  * public holidays and similar things.
@@ -17851,6 +17958,8 @@ declare module "sap/ui/unified/Menu" {
17851
17958
 
17852
17959
  import { IMenuItem } from "sap/ui/unified/library";
17853
17960
 
17961
+ import Event from "sap/ui/base/Event";
17962
+
17854
17963
  import ElementMetadata from "sap/ui/core/ElementMetadata";
17855
17964
 
17856
17965
  import UI5Element from "sap/ui/core/Element";
@@ -17862,8 +17971,6 @@ declare module "sap/ui/unified/Menu" {
17862
17971
 
17863
17972
  import MenuItemBase from "sap/ui/unified/MenuItemBase";
17864
17973
 
17865
- import Event from "sap/ui/base/Event";
17866
-
17867
17974
  /**
17868
17975
  * A menu is an interactive element which provides a choice of different actions to the user. These actions
17869
17976
  * (items) can also be organized in submenus. Like other dialog-like controls, the menu is not rendered
@@ -17960,6 +18067,55 @@ declare module "sap/ui/unified/Menu" {
17960
18067
  */
17961
18068
  oItem: IMenuItem
17962
18069
  ): this;
18070
+ /**
18071
+ * Attaches event handler `fnFunction` to the {@link #event:closed closed} event of this `sap.ui.unified.Menu`.
18072
+ *
18073
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
18074
+ * otherwise it will be bound to this `sap.ui.unified.Menu` itself.
18075
+ *
18076
+ * Fired when the menu is closed.
18077
+ *
18078
+ * @since 1.129
18079
+ *
18080
+ * @returns Reference to `this` in order to allow method chaining
18081
+ */
18082
+ attachClosed(
18083
+ /**
18084
+ * An application-specific payload object that will be passed to the event handler along with the event
18085
+ * object when firing the event
18086
+ */
18087
+ oData: object,
18088
+ /**
18089
+ * The function to be called when the event occurs
18090
+ */
18091
+ fnFunction: (p1: Event) => void,
18092
+ /**
18093
+ * Context object to call the event handler with. Defaults to this `sap.ui.unified.Menu` itself
18094
+ */
18095
+ oListener?: object
18096
+ ): this;
18097
+ /**
18098
+ * Attaches event handler `fnFunction` to the {@link #event:closed closed} event of this `sap.ui.unified.Menu`.
18099
+ *
18100
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
18101
+ * otherwise it will be bound to this `sap.ui.unified.Menu` itself.
18102
+ *
18103
+ * Fired when the menu is closed.
18104
+ *
18105
+ * @since 1.129
18106
+ *
18107
+ * @returns Reference to `this` in order to allow method chaining
18108
+ */
18109
+ attachClosed(
18110
+ /**
18111
+ * The function to be called when the event occurs
18112
+ */
18113
+ fnFunction: (p1: Event) => void,
18114
+ /**
18115
+ * Context object to call the event handler with. Defaults to this `sap.ui.unified.Menu` itself
18116
+ */
18117
+ oListener?: object
18118
+ ): this;
17963
18119
  /**
17964
18120
  * Attaches event handler `fnFunction` to the {@link #event:itemSelect itemSelect} event of this `sap.ui.unified.Menu`.
17965
18121
  *
@@ -18022,6 +18178,25 @@ declare module "sap/ui/unified/Menu" {
18022
18178
  * @returns Reference to `this` in order to allow method chaining
18023
18179
  */
18024
18180
  destroyItems(): this;
18181
+ /**
18182
+ * Detaches event handler `fnFunction` from the {@link #event:closed closed} event of this `sap.ui.unified.Menu`.
18183
+ *
18184
+ * The passed function and listener object must match the ones used for event registration.
18185
+ *
18186
+ * @since 1.129
18187
+ *
18188
+ * @returns Reference to `this` in order to allow method chaining
18189
+ */
18190
+ detachClosed(
18191
+ /**
18192
+ * The function to be called, when the event occurs
18193
+ */
18194
+ fnFunction: (p1: Event) => void,
18195
+ /**
18196
+ * Context object on which the given function had to be called
18197
+ */
18198
+ oListener?: object
18199
+ ): this;
18025
18200
  /**
18026
18201
  * Detaches event handler `fnFunction` from the {@link #event:itemSelect itemSelect} event of this `sap.ui.unified.Menu`.
18027
18202
  *
@@ -18040,6 +18215,20 @@ declare module "sap/ui/unified/Menu" {
18040
18215
  */
18041
18216
  oListener?: object
18042
18217
  ): this;
18218
+ /**
18219
+ * Fires event {@link #event:closed closed} to attached listeners.
18220
+ *
18221
+ * @since 1.129
18222
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
18223
+ *
18224
+ * @returns Reference to `this` in order to allow method chaining
18225
+ */
18226
+ fireClosed(
18227
+ /**
18228
+ * Parameters to pass along with the event
18229
+ */
18230
+ mParameters?: object
18231
+ ): this;
18043
18232
  /**
18044
18233
  * Fires event {@link #event:itemSelect itemSelect} to attached listeners.
18045
18234
  *
@@ -18400,8 +18589,25 @@ declare module "sap/ui/unified/Menu" {
18400
18589
  * menu item. This event and the event of the menu items are redundant.
18401
18590
  */
18402
18591
  itemSelect?: (oEvent: Menu$ItemSelectEvent) => void;
18592
+
18593
+ /**
18594
+ * Fired when the menu is closed.
18595
+ *
18596
+ * @since 1.129
18597
+ */
18598
+ closed?: (oEvent: Event) => void;
18403
18599
  }
18404
18600
 
18601
+ /**
18602
+ * Parameters of the Menu#closed event.
18603
+ */
18604
+ export interface Menu$ClosedEventParameters {}
18605
+
18606
+ /**
18607
+ * Event object of the Menu#closed event.
18608
+ */
18609
+ export type Menu$ClosedEvent = Event<Menu$ClosedEventParameters, Menu>;
18610
+
18405
18611
  /**
18406
18612
  * Parameters of the Menu#itemSelect event.
18407
18613
  */
@@ -19578,39 +19784,24 @@ declare module "sap/ui/unified/MenuTextFieldItem" {
19578
19784
  }
19579
19785
  }
19580
19786
 
19581
- declare module "sap/ui/unified/Shell" {
19582
- import {
19583
- default as ShellLayout,
19584
- $ShellLayoutSettings,
19585
- } from "sap/ui/unified/ShellLayout";
19586
-
19587
- import Control from "sap/ui/core/Control";
19588
-
19589
- import ShellHeadItem from "sap/ui/unified/ShellHeadItem";
19590
-
19591
- import { URI } from "sap/ui/core/library";
19787
+ declare module "sap/ui/unified/NonWorkingPeriod" {
19788
+ import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
19592
19789
 
19593
19790
  import ElementMetadata from "sap/ui/core/ElementMetadata";
19594
19791
 
19595
- import ShellHeadUserItem from "sap/ui/unified/ShellHeadUserItem";
19792
+ import TimeRange from "sap/ui/unified/TimeRange";
19596
19793
 
19597
- import {
19598
- PropertyBindingInfo,
19599
- AggregationBindingInfo,
19600
- } from "sap/ui/base/ManagedObject";
19794
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
19601
19795
 
19602
19796
  /**
19603
- * The shell control is meant as root control (full-screen) of an application. It was build as root control
19604
- * of the Fiori Launchpad application and provides the basic capabilities for this purpose. Do not use this
19605
- * control within applications which run inside the Fiori Lauchpad and do not use it for other scenarios
19606
- * than the root control usecase.
19797
+ * NonWorkingPeriod
19607
19798
  *
19608
- * @since 1.15.1
19609
- * @deprecated (since 1.44.0) - the concept has been discarded.
19799
+ * @since 1.27.0
19800
+ * @experimental (since 1.127.0)
19610
19801
  */
19611
- export default class Shell extends ShellLayout {
19802
+ export default class NonWorkingPeriod extends UI5Element {
19612
19803
  /**
19613
- * Constructor for a new Shell.
19804
+ * Constructor for a new NonWorkingPeriod.
19614
19805
  *
19615
19806
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
19616
19807
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
@@ -19620,10 +19811,10 @@ declare module "sap/ui/unified/Shell" {
19620
19811
  /**
19621
19812
  * initial settings for the new control
19622
19813
  */
19623
- mSettings?: $ShellSettings
19814
+ mSettings?: $NonWorkingPeriodSettings
19624
19815
  );
19625
19816
  /**
19626
- * Constructor for a new Shell.
19817
+ * Constructor for a new NonWorkingPeriod.
19627
19818
  *
19628
19819
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
19629
19820
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
@@ -19631,20 +19822,20 @@ declare module "sap/ui/unified/Shell" {
19631
19822
  */
19632
19823
  constructor(
19633
19824
  /**
19634
- * id for the new control, generated automatically if no id is given
19825
+ * ID for the new control, generated automatically if no ID is given
19635
19826
  */
19636
19827
  sId?: string,
19637
19828
  /**
19638
19829
  * initial settings for the new control
19639
19830
  */
19640
- mSettings?: $ShellSettings
19831
+ mSettings?: $NonWorkingPeriodSettings
19641
19832
  );
19642
19833
 
19643
19834
  /**
19644
- * Creates a new subclass of class sap.ui.unified.Shell with name `sClassName` and enriches it with the
19645
- * information contained in `oClassInfo`.
19835
+ * Creates a new subclass of class sap.ui.unified.NonWorkingPeriod with name `sClassName` and enriches it
19836
+ * with the information contained in `oClassInfo`.
19646
19837
  *
19647
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.unified.ShellLayout.extend}.
19838
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
19648
19839
  *
19649
19840
  *
19650
19841
  * @returns Created class / constructor function
@@ -19657,7 +19848,7 @@ declare module "sap/ui/unified/Shell" {
19657
19848
  /**
19658
19849
  * Object literal with information about the class
19659
19850
  */
19660
- oClassInfo?: sap.ClassInfo<T, Shell>,
19851
+ oClassInfo?: sap.ClassInfo<T, NonWorkingPeriod>,
19661
19852
  /**
19662
19853
  * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
19663
19854
  * used by this class
@@ -19665,92 +19856,416 @@ declare module "sap/ui/unified/Shell" {
19665
19856
  FNMetaImpl?: Function
19666
19857
  ): Function;
19667
19858
  /**
19668
- * Returns a metadata object for class sap.ui.unified.Shell.
19859
+ * Returns a metadata object for class sap.ui.unified.NonWorkingPeriod.
19669
19860
  *
19670
19861
  *
19671
19862
  * @returns Metadata object describing this class
19672
19863
  */
19673
19864
  static getMetadata(): ElementMetadata;
19674
19865
  /**
19675
- * Adds some curtainContent to the aggregation {@link #getCurtainContent curtainContent}.
19866
+ * Destroys the timeRange in the aggregation {@link #getTimeRange timeRange}.
19676
19867
  *
19677
19868
  *
19678
19869
  * @returns Reference to `this` in order to allow method chaining
19679
19870
  */
19680
- addCurtainContent(
19681
- /**
19682
- * The curtainContent to add; if empty, nothing is inserted
19683
- */
19684
- oCurtainContent: Control
19685
- ): this;
19871
+ destroyTimeRange(): this;
19686
19872
  /**
19687
- * Adds some curtainPaneContent to the aggregation {@link #getCurtainPaneContent curtainPaneContent}.
19873
+ * Gets current value of property {@link #getDate date}.
19688
19874
  *
19875
+ * Determines the day to which the timeRange refers. This object must be a UI5Date or JavaScript Date object.
19689
19876
  *
19690
- * @returns Reference to `this` in order to allow method chaining
19877
+ *
19878
+ * @returns Value of property `date`
19691
19879
  */
19692
- addCurtainPaneContent(
19693
- /**
19694
- * The curtainPaneContent to add; if empty, nothing is inserted
19695
- */
19696
- oCurtainPaneContent: Control
19697
- ): this;
19880
+ getDate(): object;
19698
19881
  /**
19699
- * Adds some headEndItem to the aggregation {@link #getHeadEndItems headEndItems}.
19882
+ * Returns the duration of the non-working period.
19700
19883
  *
19701
19884
  *
19702
- * @returns Reference to `this` in order to allow method chaining
19885
+ * @returns returns a number that represents the duration of a calendar item in minutes
19703
19886
  */
19704
- addHeadEndItem(
19705
- /**
19706
- * The headEndItem to add; if empty, nothing is inserted
19707
- */
19708
- oHeadEndItem: ShellHeadItem
19709
- ): this;
19887
+ getDurationInMinutes(): int;
19710
19888
  /**
19711
- * Adds some headItem to the aggregation {@link #getHeadItems headItems}.
19712
- *
19889
+ * Gets content of aggregation {@link #getTimeRange timeRange}.
19713
19890
  *
19714
- * @returns Reference to `this` in order to allow method chaining
19891
+ * Defines the hours range for the non-working period.
19715
19892
  */
19716
- addHeadItem(
19717
- /**
19718
- * The headItem to add; if empty, nothing is inserted
19719
- */
19720
- oHeadItem: ShellHeadItem
19721
- ): this;
19893
+ getTimeRange(): TimeRange;
19722
19894
  /**
19723
- * Destroys all the curtainContent in the aggregation {@link #getCurtainContent curtainContent}.
19895
+ * Sets a new value for property {@link #getDate date}.
19724
19896
  *
19897
+ * Determines the day to which the timeRange refers. This object must be a UI5Date or JavaScript Date object.
19725
19898
  *
19726
- * @returns Reference to `this` in order to allow method chaining
19727
- */
19728
- destroyCurtainContent(): this;
19729
- /**
19730
- * Destroys all the curtainPaneContent in the aggregation {@link #getCurtainPaneContent curtainPaneContent}.
19899
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
19731
19900
  *
19732
19901
  *
19733
19902
  * @returns Reference to `this` in order to allow method chaining
19734
19903
  */
19735
- destroyCurtainPaneContent(): this;
19904
+ setDate(
19905
+ /**
19906
+ * New value for property `date`
19907
+ */
19908
+ oDate: object
19909
+ ): this;
19736
19910
  /**
19737
- * Destroys all the headEndItems in the aggregation {@link #getHeadEndItems headEndItems}.
19911
+ * Sets the aggregated {@link #getTimeRange timeRange}.
19738
19912
  *
19739
19913
  *
19740
19914
  * @returns Reference to `this` in order to allow method chaining
19741
19915
  */
19742
- destroyHeadEndItems(): this;
19916
+ setTimeRange(
19917
+ /**
19918
+ * The timeRange to set
19919
+ */
19920
+ oTimeRange: TimeRange
19921
+ ): this;
19922
+ }
19923
+ /**
19924
+ * Describes the settings that can be provided to the NonWorkingPeriod constructor.
19925
+ *
19926
+ * @experimental (since 1.127.0)
19927
+ */
19928
+ export interface $NonWorkingPeriodSettings extends $ElementSettings {
19743
19929
  /**
19744
- * Destroys the header in the aggregation named `header`, but only if a custom header is set. The default
19745
- * header can not be destroyed.
19746
- *
19747
- *
19748
- * @returns `this` to allow method chaining
19930
+ * Determines the day to which the timeRange refers. This object must be a UI5Date or JavaScript Date object.
19749
19931
  */
19750
- destroyHeader(): this;
19932
+ date?: object | PropertyBindingInfo | `{${string}}`;
19933
+
19751
19934
  /**
19752
- * Destroys all the headItems in the aggregation {@link #getHeadItems headItems}.
19753
- *
19935
+ * Defines the hours range for the non-working period.
19936
+ */
19937
+ timeRange?: TimeRange;
19938
+ }
19939
+ }
19940
+
19941
+ declare module "sap/ui/unified/RecurringNonWorkingPeriod" {
19942
+ import Metadata from "sap/ui/base/Metadata";
19943
+
19944
+ import { RecurrenceType } from "sap/ui/unified/library";
19945
+
19946
+ /**
19947
+ * A `RecurringNonWorkingPeriod` for use in a `PlanningCalendar` and `SinglePlanningCalendar`.
19948
+ *
19949
+ * Applications can inherit from this element to add own fields.
19950
+ *
19951
+ * @since 1.127.0
19952
+ * @experimental (since 1.127.0)
19953
+ */
19954
+ export default class RecurringNonWorkingPeriod
19955
+ extends /* was: sap.ui.unified. */ Object
19956
+ {
19957
+ /**
19958
+ * Constructor for a new `RecurringNonWorkingPeriod`.
19959
+ *
19960
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
19961
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
19962
+ * of the syntax of the settings object.
19963
+ */
19964
+ constructor(
19965
+ /**
19966
+ * ID for the new control, generated automatically if no ID is given
19967
+ */
19968
+ sId?: string,
19969
+ /**
19970
+ * Initial settings for the new control
19971
+ */
19972
+ mSettings?: object
19973
+ );
19974
+
19975
+ /**
19976
+ * Creates a new subclass of class sap.ui.unified.RecurringNonWorkingPeriod with name `sClassName` and enriches
19977
+ * it with the information contained in `oClassInfo`.
19978
+ *
19979
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.unified..extend}.
19980
+ *
19981
+ *
19982
+ * @returns Created class / constructor function
19983
+ */
19984
+ static extend<T extends Record<string, unknown>>(
19985
+ /**
19986
+ * Name of the class being created
19987
+ */
19988
+ sClassName: string,
19989
+ /**
19990
+ * Object literal with information about the class
19991
+ */
19992
+ oClassInfo?: sap.ClassInfo<T, RecurringNonWorkingPeriod>,
19993
+ /**
19994
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
19995
+ * used by this class
19996
+ */
19997
+ FNMetaImpl?: Function
19998
+ ): Function;
19999
+ /**
20000
+ * Returns a metadata object for class sap.ui.unified.RecurringNonWorkingPeriod.
20001
+ *
20002
+ *
20003
+ * @returns Metadata object describing this class
20004
+ */
20005
+ static getMetadata(): Metadata;
20006
+ /**
20007
+ * Gets current value of property {@link #getRecurrenceEndDate recurrenceEndDate}.
20008
+ *
20009
+ * Determines the end date of the calendar item, as a UI5Date or JavaScript Date object. It is considered
20010
+ * as a local date.
20011
+ *
20012
+ *
20013
+ * @returns Value of property `recurrenceEndDate`
20014
+ */
20015
+ getRecurrenceEndDate(): object;
20016
+ /**
20017
+ * Gets current value of property {@link #getRecurrencePattern recurrencePattern}.
20018
+ *
20019
+ * The recurrencePattern is an integer value which, in combination with the recurrenceType, sets the recurrence
20020
+ * frequency for a calendar item. For example, if the recurrenceType is set to "Daily" and the recurrencePattern
20021
+ * is set to 1, it signifies that repetition is set for every day. If the recurrencePattern is set to 3,
20022
+ * this would imply the calendar item is recurring once for every three days.
20023
+ *
20024
+ * Default value is `1`.
20025
+ *
20026
+ *
20027
+ * @returns Value of property `recurrencePattern`
20028
+ */
20029
+ getRecurrencePattern(): int;
20030
+ /**
20031
+ * Gets current value of property {@link #getRecurrenceType recurrenceType}.
20032
+ *
20033
+ * The recurrenceType determines the pattern of recurrence for a given calendar item.
20034
+ *
20035
+ *
20036
+ * @returns Value of property `recurrenceType`
20037
+ */
20038
+ getRecurrenceType(): RecurrenceType | keyof typeof RecurrenceType;
20039
+ /**
20040
+ * Sets a new value for property {@link #getRecurrenceEndDate recurrenceEndDate}.
20041
+ *
20042
+ * Determines the end date of the calendar item, as a UI5Date or JavaScript Date object. It is considered
20043
+ * as a local date.
20044
+ *
20045
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
20046
+ *
20047
+ *
20048
+ * @returns Reference to `this` in order to allow method chaining
20049
+ */
20050
+ setRecurrenceEndDate(
20051
+ /**
20052
+ * New value for property `recurrenceEndDate`
20053
+ */
20054
+ oRecurrenceEndDate: object
20055
+ ): this;
20056
+ /**
20057
+ * Sets a new value for property {@link #getRecurrencePattern recurrencePattern}.
20058
+ *
20059
+ * The recurrencePattern is an integer value which, in combination with the recurrenceType, sets the recurrence
20060
+ * frequency for a calendar item. For example, if the recurrenceType is set to "Daily" and the recurrencePattern
20061
+ * is set to 1, it signifies that repetition is set for every day. If the recurrencePattern is set to 3,
20062
+ * this would imply the calendar item is recurring once for every three days.
20063
+ *
20064
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
20065
+ *
20066
+ * Default value is `1`.
20067
+ *
20068
+ *
20069
+ * @returns Reference to `this` in order to allow method chaining
20070
+ */
20071
+ setRecurrencePattern(
20072
+ /**
20073
+ * New value for property `recurrencePattern`
20074
+ */
20075
+ iRecurrencePattern?: int
20076
+ ): this;
20077
+ /**
20078
+ * Sets a new value for property {@link #getRecurrenceType recurrenceType}.
20079
+ *
20080
+ * The recurrenceType determines the pattern of recurrence for a given calendar item.
20081
+ *
20082
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
20083
+ *
20084
+ *
20085
+ * @returns Reference to `this` in order to allow method chaining
20086
+ */
20087
+ setRecurrenceType(
20088
+ /**
20089
+ * New value for property `recurrenceType`
20090
+ */
20091
+ sRecurrenceType: RecurrenceType | keyof typeof RecurrenceType
20092
+ ): this;
20093
+ }
20094
+ }
20095
+
20096
+ declare module "sap/ui/unified/Shell" {
20097
+ import {
20098
+ default as ShellLayout,
20099
+ $ShellLayoutSettings,
20100
+ } from "sap/ui/unified/ShellLayout";
20101
+
20102
+ import Control from "sap/ui/core/Control";
20103
+
20104
+ import ShellHeadItem from "sap/ui/unified/ShellHeadItem";
20105
+
20106
+ import { URI } from "sap/ui/core/library";
20107
+
20108
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
20109
+
20110
+ import ShellHeadUserItem from "sap/ui/unified/ShellHeadUserItem";
20111
+
20112
+ import {
20113
+ PropertyBindingInfo,
20114
+ AggregationBindingInfo,
20115
+ } from "sap/ui/base/ManagedObject";
20116
+
20117
+ /**
20118
+ * The shell control is meant as root control (full-screen) of an application. It was build as root control
20119
+ * of the Fiori Launchpad application and provides the basic capabilities for this purpose. Do not use this
20120
+ * control within applications which run inside the Fiori Lauchpad and do not use it for other scenarios
20121
+ * than the root control usecase.
20122
+ *
20123
+ * @since 1.15.1
20124
+ * @deprecated (since 1.44.0) - the concept has been discarded.
20125
+ */
20126
+ export default class Shell extends ShellLayout {
20127
+ /**
20128
+ * Constructor for a new Shell.
20129
+ *
20130
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
20131
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
20132
+ * of the syntax of the settings object.
20133
+ */
20134
+ constructor(
20135
+ /**
20136
+ * initial settings for the new control
20137
+ */
20138
+ mSettings?: $ShellSettings
20139
+ );
20140
+ /**
20141
+ * Constructor for a new Shell.
20142
+ *
20143
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
20144
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
20145
+ * of the syntax of the settings object.
20146
+ */
20147
+ constructor(
20148
+ /**
20149
+ * id for the new control, generated automatically if no id is given
20150
+ */
20151
+ sId?: string,
20152
+ /**
20153
+ * initial settings for the new control
20154
+ */
20155
+ mSettings?: $ShellSettings
20156
+ );
20157
+
20158
+ /**
20159
+ * Creates a new subclass of class sap.ui.unified.Shell with name `sClassName` and enriches it with the
20160
+ * information contained in `oClassInfo`.
20161
+ *
20162
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.unified.ShellLayout.extend}.
20163
+ *
20164
+ *
20165
+ * @returns Created class / constructor function
20166
+ */
20167
+ static extend<T extends Record<string, unknown>>(
20168
+ /**
20169
+ * Name of the class being created
20170
+ */
20171
+ sClassName: string,
20172
+ /**
20173
+ * Object literal with information about the class
20174
+ */
20175
+ oClassInfo?: sap.ClassInfo<T, Shell>,
20176
+ /**
20177
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
20178
+ * used by this class
20179
+ */
20180
+ FNMetaImpl?: Function
20181
+ ): Function;
20182
+ /**
20183
+ * Returns a metadata object for class sap.ui.unified.Shell.
20184
+ *
20185
+ *
20186
+ * @returns Metadata object describing this class
20187
+ */
20188
+ static getMetadata(): ElementMetadata;
20189
+ /**
20190
+ * Adds some curtainContent to the aggregation {@link #getCurtainContent curtainContent}.
20191
+ *
20192
+ *
20193
+ * @returns Reference to `this` in order to allow method chaining
20194
+ */
20195
+ addCurtainContent(
20196
+ /**
20197
+ * The curtainContent to add; if empty, nothing is inserted
20198
+ */
20199
+ oCurtainContent: Control
20200
+ ): this;
20201
+ /**
20202
+ * Adds some curtainPaneContent to the aggregation {@link #getCurtainPaneContent curtainPaneContent}.
20203
+ *
20204
+ *
20205
+ * @returns Reference to `this` in order to allow method chaining
20206
+ */
20207
+ addCurtainPaneContent(
20208
+ /**
20209
+ * The curtainPaneContent to add; if empty, nothing is inserted
20210
+ */
20211
+ oCurtainPaneContent: Control
20212
+ ): this;
20213
+ /**
20214
+ * Adds some headEndItem to the aggregation {@link #getHeadEndItems headEndItems}.
20215
+ *
20216
+ *
20217
+ * @returns Reference to `this` in order to allow method chaining
20218
+ */
20219
+ addHeadEndItem(
20220
+ /**
20221
+ * The headEndItem to add; if empty, nothing is inserted
20222
+ */
20223
+ oHeadEndItem: ShellHeadItem
20224
+ ): this;
20225
+ /**
20226
+ * Adds some headItem to the aggregation {@link #getHeadItems headItems}.
20227
+ *
20228
+ *
20229
+ * @returns Reference to `this` in order to allow method chaining
20230
+ */
20231
+ addHeadItem(
20232
+ /**
20233
+ * The headItem to add; if empty, nothing is inserted
20234
+ */
20235
+ oHeadItem: ShellHeadItem
20236
+ ): this;
20237
+ /**
20238
+ * Destroys all the curtainContent in the aggregation {@link #getCurtainContent curtainContent}.
20239
+ *
20240
+ *
20241
+ * @returns Reference to `this` in order to allow method chaining
20242
+ */
20243
+ destroyCurtainContent(): this;
20244
+ /**
20245
+ * Destroys all the curtainPaneContent in the aggregation {@link #getCurtainPaneContent curtainPaneContent}.
20246
+ *
20247
+ *
20248
+ * @returns Reference to `this` in order to allow method chaining
20249
+ */
20250
+ destroyCurtainPaneContent(): this;
20251
+ /**
20252
+ * Destroys all the headEndItems in the aggregation {@link #getHeadEndItems headEndItems}.
20253
+ *
20254
+ *
20255
+ * @returns Reference to `this` in order to allow method chaining
20256
+ */
20257
+ destroyHeadEndItems(): this;
20258
+ /**
20259
+ * Destroys the header in the aggregation named `header`, but only if a custom header is set. The default
20260
+ * header can not be destroyed.
20261
+ *
20262
+ *
20263
+ * @returns `this` to allow method chaining
20264
+ */
20265
+ destroyHeader(): this;
20266
+ /**
20267
+ * Destroys all the headItems in the aggregation {@link #getHeadItems headItems}.
20268
+ *
19754
20269
  *
19755
20270
  * @returns Reference to `this` in order to allow method chaining
19756
20271
  */
@@ -22243,6 +22758,207 @@ declare module "sap/ui/unified/SplitContainer" {
22243
22758
  }
22244
22759
  }
22245
22760
 
22761
+ declare module "sap/ui/unified/TimeRange" {
22762
+ import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
22763
+
22764
+ import UI5Date from "sap/ui/core/date/UI5Date";
22765
+
22766
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
22767
+
22768
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
22769
+
22770
+ /**
22771
+ * Time range for use in `NonWorkingPeriod`
22772
+ *
22773
+ * @since 1.127.0
22774
+ * @experimental (since 1.127.0)
22775
+ */
22776
+ export default class TimeRange extends UI5Element {
22777
+ /**
22778
+ * Constructor for a new TimeRange.
22779
+ *
22780
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
22781
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
22782
+ * of the syntax of the settings object.
22783
+ */
22784
+ constructor(
22785
+ /**
22786
+ * initial settings for the new control
22787
+ */
22788
+ mSettings?: $TimeRangeSettings
22789
+ );
22790
+ /**
22791
+ * Constructor for a new TimeRange.
22792
+ *
22793
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
22794
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
22795
+ * of the syntax of the settings object.
22796
+ */
22797
+ constructor(
22798
+ /**
22799
+ * ID for the new control, generated automatically if no ID is given
22800
+ */
22801
+ sId?: string,
22802
+ /**
22803
+ * initial settings for the new control
22804
+ */
22805
+ mSettings?: $TimeRangeSettings
22806
+ );
22807
+
22808
+ /**
22809
+ * Creates a new subclass of class sap.ui.unified.TimeRange with name `sClassName` and enriches it with
22810
+ * the information contained in `oClassInfo`.
22811
+ *
22812
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
22813
+ *
22814
+ *
22815
+ * @returns Created class / constructor function
22816
+ */
22817
+ static extend<T extends Record<string, unknown>>(
22818
+ /**
22819
+ * Name of the class being created
22820
+ */
22821
+ sClassName: string,
22822
+ /**
22823
+ * Object literal with information about the class
22824
+ */
22825
+ oClassInfo?: sap.ClassInfo<T, TimeRange>,
22826
+ /**
22827
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
22828
+ * used by this class
22829
+ */
22830
+ FNMetaImpl?: Function
22831
+ ): Function;
22832
+ /**
22833
+ * Returns a metadata object for class sap.ui.unified.TimeRange.
22834
+ *
22835
+ *
22836
+ * @returns Metadata object describing this class
22837
+ */
22838
+ static getMetadata(): ElementMetadata;
22839
+ /**
22840
+ * Gets current value of property {@link #getEnd end}.
22841
+ *
22842
+ * End time for a time range. This must be a String.
22843
+ *
22844
+ *
22845
+ * @returns Value of property `end`
22846
+ */
22847
+ getEnd(): string;
22848
+ /**
22849
+ * Get end date for a time range. From this date, only hours, minutes, seconds, and milliseconds are used.
22850
+ *
22851
+ *
22852
+ * @returns [oDate] A date instance
22853
+ */
22854
+ getEndDate(): Date | UI5Date;
22855
+ /**
22856
+ * Gets current value of property {@link #getStart start}.
22857
+ *
22858
+ * Start time for a time range. This must be a String.
22859
+ *
22860
+ *
22861
+ * @returns Value of property `start`
22862
+ */
22863
+ getStart(): string;
22864
+ /**
22865
+ * Get start date for a time range. From this date, only hours, minutes, seconds, and milliseconds are used.
22866
+ *
22867
+ *
22868
+ * @returns [oDate] A date instance
22869
+ */
22870
+ getStartDate(): Date | UI5Date;
22871
+ /**
22872
+ * Gets current value of property {@link #getValueFormat valueFormat}.
22873
+ *
22874
+ * Determines the format of the startTime and endTime
22875
+ *
22876
+ * **Note:** a time pattern in LDML format. It is not verified whether the pattern only represents a time.
22877
+ *
22878
+ * Default value is `"hh:mm"`.
22879
+ *
22880
+ *
22881
+ * @returns Value of property `valueFormat`
22882
+ */
22883
+ getValueFormat(): string;
22884
+ /**
22885
+ * Sets a new value for property {@link #getEnd end}.
22886
+ *
22887
+ * End time for a time range. This must be a String.
22888
+ *
22889
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
22890
+ *
22891
+ *
22892
+ * @returns Reference to `this` in order to allow method chaining
22893
+ */
22894
+ setEnd(
22895
+ /**
22896
+ * New value for property `end`
22897
+ */
22898
+ sEnd?: string
22899
+ ): this;
22900
+ /**
22901
+ * Sets a new value for property {@link #getStart start}.
22902
+ *
22903
+ * Start time for a time range. This must be a String.
22904
+ *
22905
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
22906
+ *
22907
+ *
22908
+ * @returns Reference to `this` in order to allow method chaining
22909
+ */
22910
+ setStart(
22911
+ /**
22912
+ * New value for property `start`
22913
+ */
22914
+ sStart?: string
22915
+ ): this;
22916
+ /**
22917
+ * Sets a new value for property {@link #getValueFormat valueFormat}.
22918
+ *
22919
+ * Determines the format of the startTime and endTime
22920
+ *
22921
+ * **Note:** a time pattern in LDML format. It is not verified whether the pattern only represents a time.
22922
+ *
22923
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
22924
+ *
22925
+ * Default value is `"hh:mm"`.
22926
+ *
22927
+ *
22928
+ * @returns Reference to `this` in order to allow method chaining
22929
+ */
22930
+ setValueFormat(
22931
+ /**
22932
+ * New value for property `valueFormat`
22933
+ */
22934
+ sValueFormat?: string
22935
+ ): this;
22936
+ }
22937
+ /**
22938
+ * Describes the settings that can be provided to the TimeRange constructor.
22939
+ *
22940
+ * @experimental (since 1.127.0)
22941
+ */
22942
+ export interface $TimeRangeSettings extends $ElementSettings {
22943
+ /**
22944
+ * Start time for a time range. This must be a String.
22945
+ */
22946
+ start?: string | PropertyBindingInfo;
22947
+
22948
+ /**
22949
+ * End time for a time range. This must be a String.
22950
+ */
22951
+ end?: string | PropertyBindingInfo;
22952
+
22953
+ /**
22954
+ * Determines the format of the startTime and endTime
22955
+ *
22956
+ * **Note:** a time pattern in LDML format. It is not verified whether the pattern only represents a time.
22957
+ */
22958
+ valueFormat?: string | PropertyBindingInfo;
22959
+ }
22960
+ }
22961
+
22246
22962
  declare namespace sap {
22247
22963
  interface IUI5DefineDependencyNames {
22248
22964
  "sap/ui/unified/Calendar": undefined;
@@ -22309,6 +23025,10 @@ declare namespace sap {
22309
23025
 
22310
23026
  "sap/ui/unified/MenuTextFieldItem": undefined;
22311
23027
 
23028
+ "sap/ui/unified/NonWorkingPeriod": undefined;
23029
+
23030
+ "sap/ui/unified/RecurringNonWorkingPeriod": undefined;
23031
+
22312
23032
  "sap/ui/unified/Shell": undefined;
22313
23033
 
22314
23034
  "sap/ui/unified/ShellHeadItem": undefined;
@@ -22320,5 +23040,7 @@ declare namespace sap {
22320
23040
  "sap/ui/unified/ShellOverlay": undefined;
22321
23041
 
22322
23042
  "sap/ui/unified/SplitContainer": undefined;
23043
+
23044
+ "sap/ui/unified/TimeRange": undefined;
22323
23045
  }
22324
23046
  }