@openui5/ts-types 1.135.0 → 1.136.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.135.0
1
+ // For Library Version: 1.136.0
2
2
 
3
3
  declare module "sap/ui/mdc/AggregationBaseDelegate" {
4
4
  import BaseDelegate from "sap/ui/mdc/BaseDelegate";
@@ -2794,10 +2794,36 @@ declare module "sap/ui/mdc/ValueHelpDelegate" {
2794
2794
  */
2795
2795
  oConfig: object
2796
2796
  ): void;
2797
+ /**
2798
+ * Provides a hook to run time-critical tasks once a control connects to a value help.
2799
+ *
2800
+ * This method allows for working around any delays that might occur during user interaction treatment of
2801
+ * the connecting `control`. For example, `setTimeout` or `debouncing` are used in {@link sap.ui.mdc.field.FieldBase FieldBase }
2802
+ * to prevent triggering value help requests too early/often.
2803
+ *
2804
+ * @since 1.136
2805
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2806
+ */
2807
+ onControlConnect(
2808
+ /**
2809
+ * The `ValueHelp` control instance
2810
+ */
2811
+ oValueHelp: sap.ui.mdc.ValueHelp,
2812
+ /**
2813
+ * Control to which the `ValueHelp` element is connected
2814
+ */
2815
+ oControl: sap.ui.core.Control,
2816
+ /**
2817
+ * Connect configuration object
2818
+ */
2819
+ oConfig?: /* was: sap.ui.mdc.valuehelp.base.ConnectConfig */ any
2820
+ ): void;
2797
2821
  /**
2798
2822
  * Requests additional content for the value help.
2799
2823
  *
2800
- * This function is called when the value help is opened or a key or description is requested.
2824
+ * This method is called during the opening phase of a `ValueHelp`, if a new content is displayed for a
2825
+ * `CollectiveSearch` dialog or if one of the following methods is called: {@link sap.ui.mdc.ValueHelp#getItemForValue getItemForValue},
2826
+ * {@link sap.ui.mdc.ValueHelp#requestShowTypeahead requestShowTypeahead}, {@link sap.ui.mdc.ValueHelp#requestShowValueHelp requestShowValueHelp}
2801
2827
  *
2802
2828
  * So depending on the value help {@link sap.ui.mdc.valuehelp.base.Content Content} used, all content controls
2803
2829
  * and data need to be assigned. Once they are assigned and the data is set, the returned `Promise` needs
@@ -5676,6 +5702,42 @@ declare namespace sap {
5676
5702
  */
5677
5703
  Variant = "Variant",
5678
5704
  }
5705
+ /**
5706
+ * Enumeration of the possible triggers for {@link sap.ui.mdc.ValueHelp ValueHelp}
5707
+ *
5708
+ * @since 1.136
5709
+ */
5710
+ enum RequestShowContainerReason {
5711
+ /**
5712
+ * Content may have been filtered during it's {@link sap.ui.mdc.valuehelp.base.FilterableListContent#onBeforeShow onBeforeShow }
5713
+ * phase or a `filterValue` change occured while the `ValueHelp` was already open.
5714
+ */
5715
+ Filter = "Filter",
5716
+ /**
5717
+ * A connected control receives focus.
5718
+ */
5719
+ Focus = "Focus",
5720
+ /**
5721
+ * {@link sap.ui.mdc.ValueHelp#navigate ValueHelp arrow-navigation} was triggered.
5722
+ */
5723
+ Navigate = "Navigate",
5724
+ /**
5725
+ * A connected control was focused using the Tab key.
5726
+ */
5727
+ Tab = "Tab",
5728
+ /**
5729
+ * A connected control was activated through a click or tap action.
5730
+ */
5731
+ Tap = "Tap",
5732
+ /**
5733
+ * Text was entered or modified in a connected control.
5734
+ */
5735
+ Typing = "Typing",
5736
+ /**
5737
+ * A connected control fired a {@link sap.m.Input.valueHelpRequest valueHelpRequest}.
5738
+ */
5739
+ ValueHelpRequest = "ValueHelpRequest",
5740
+ }
5679
5741
  /**
5680
5742
  * Growing mode of the table.
5681
5743
  *
@@ -12490,7 +12552,7 @@ declare namespace sap {
12490
12552
  * small lists, all values are meant to be shown, independent of the typing in the connected field. In this
12491
12553
  * case this property must be set to `false`.
12492
12554
  *
12493
- * If not set, the list opens if the user clicks into the connected field.
12555
+ * By default, if not set, the list opens if the user clicks into the connected field.
12494
12556
  */
12495
12557
  filterList?:
12496
12558
  | boolean
@@ -12841,7 +12903,7 @@ declare namespace sap {
12841
12903
  * small lists, all values are meant to be shown, independent of the typing in the connected field. In this
12842
12904
  * case this property must be set to `false`.
12843
12905
  *
12844
- * If not set, the list opens if the user clicks into the connected field.
12906
+ * By default, if not set, the list opens if the user clicks into the connected field.
12845
12907
  *
12846
12908
  * Default value is `true`.
12847
12909
  *
@@ -12933,7 +12995,7 @@ declare namespace sap {
12933
12995
  * small lists, all values are meant to be shown, independent of the typing in the connected field. In this
12934
12996
  * case this property must be set to `false`.
12935
12997
  *
12936
- * If not set, the list opens if the user clicks into the connected field.
12998
+ * By default, if not set, the list opens if the user clicks into the connected field.
12937
12999
  *
12938
13000
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
12939
13001
  *
@@ -14057,7 +14119,8 @@ declare namespace sap {
14057
14119
  interface $ActionToolbarActionSettings
14058
14120
  extends sap.ui.core.$ControlSettings {
14059
14121
  /**
14060
- * Contains the information where the action is displayed on the `ActionToolbar`.
14122
+ * Contains the information where the action is displayed on the `ActionToolbar`. The `layoutInformation`
14123
+ * has to be of type {@link sap.ui.mdc.actiontoolbar.ActionToolbarActionLayoutInformation}.
14061
14124
  */
14062
14125
  layoutInformation?:
14063
14126
  | object
@@ -14162,7 +14225,8 @@ declare namespace sap {
14162
14225
  /**
14163
14226
  * Gets current value of property {@link #getLayoutInformation layoutInformation}.
14164
14227
  *
14165
- * Contains the information where the action is displayed on the `ActionToolbar`.
14228
+ * Contains the information where the action is displayed on the `ActionToolbar`. The `layoutInformation`
14229
+ * has to be of type {@link sap.ui.mdc.actiontoolbar.ActionToolbarActionLayoutInformation}.
14166
14230
  *
14167
14231
  * Default value is `...see text or source`.
14168
14232
  *
@@ -14196,7 +14260,8 @@ declare namespace sap {
14196
14260
  /**
14197
14261
  * Sets a new value for property {@link #getLayoutInformation layoutInformation}.
14198
14262
  *
14199
- * Contains the information where the action is displayed on the `ActionToolbar`.
14263
+ * Contains the information where the action is displayed on the `ActionToolbar`. The `layoutInformation`
14264
+ * has to be of type {@link sap.ui.mdc.actiontoolbar.ActionToolbarActionLayoutInformation}.
14200
14265
  *
14201
14266
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
14202
14267
  *
@@ -14212,6 +14277,17 @@ declare namespace sap {
14212
14277
  oLayoutInformation?: object
14213
14278
  ): this;
14214
14279
  }
14280
+
14281
+ type ActionToolbarActionLayoutInformation = {
14282
+ /**
14283
+ * The name of the aggregation where the action is displayed. Currently only `end` is supported.
14284
+ */
14285
+ aggregationName: string;
14286
+ /**
14287
+ * The alignment of the action defining if it's displayed before or after the aggregation.
14288
+ */
14289
+ alignment: sap.ui.mdc.enums.ActionToolbarActionAlignment;
14290
+ };
14215
14291
  }
14216
14292
 
14217
14293
  namespace link {
@@ -15144,6 +15220,16 @@ declare namespace sap {
15144
15220
  | sap.ui.base.ManagedObject.PropertyBindingInfo
15145
15221
  | `{${string}}`;
15146
15222
 
15223
+ /**
15224
+ * Determines whether the number of fixed columns is configurable via the column menu.
15225
+ *
15226
+ * @since 1.136
15227
+ */
15228
+ enableColumnFreeze?:
15229
+ | boolean
15230
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
15231
+ | `{${string}}`;
15232
+
15147
15233
  /**
15148
15234
  * Defines the number of fixed columns.
15149
15235
  */
@@ -16670,6 +16756,18 @@ declare namespace sap {
16670
16756
  * @returns Metadata object describing this class
16671
16757
  */
16672
16758
  static getMetadata(): sap.ui.core.ElementMetadata;
16759
+ /**
16760
+ * Gets current value of property {@link #getEnableColumnFreeze enableColumnFreeze}.
16761
+ *
16762
+ * Determines whether the number of fixed columns is configurable via the column menu.
16763
+ *
16764
+ * Default value is `false`.
16765
+ *
16766
+ * @since 1.136
16767
+ *
16768
+ * @returns Value of property `enableColumnFreeze`
16769
+ */
16770
+ getEnableColumnFreeze(): boolean;
16673
16771
  /**
16674
16772
  * Gets current value of property {@link #getFixedColumnCount fixedColumnCount}.
16675
16773
  *
@@ -16758,6 +16856,25 @@ declare namespace sap {
16758
16856
  * @returns Value of property `showHeaderSelector`
16759
16857
  */
16760
16858
  getShowHeaderSelector(): boolean;
16859
+ /**
16860
+ * Sets a new value for property {@link #getEnableColumnFreeze enableColumnFreeze}.
16861
+ *
16862
+ * Determines whether the number of fixed columns is configurable via the column menu.
16863
+ *
16864
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
16865
+ *
16866
+ * Default value is `false`.
16867
+ *
16868
+ * @since 1.136
16869
+ *
16870
+ * @returns Reference to `this` in order to allow method chaining
16871
+ */
16872
+ setEnableColumnFreeze(
16873
+ /**
16874
+ * New value for property `enableColumnFreeze`
16875
+ */
16876
+ bEnableColumnFreeze?: boolean
16877
+ ): this;
16761
16878
  /**
16762
16879
  * Sets a new value for property {@link #getFixedColumnCount fixedColumnCount}.
16763
16880
  *
@@ -24982,6 +25099,8 @@ declare namespace sap {
24982
25099
 
24983
25100
  "sap/ui/mdc/enums/ReasonMode": undefined;
24984
25101
 
25102
+ "sap/ui/mdc/enums/RequestShowContainerReason": undefined;
25103
+
24985
25104
  "sap/ui/mdc/enums/TableGrowingMode": undefined;
24986
25105
 
24987
25106
  "sap/ui/mdc/enums/TableMultiSelectMode": undefined;
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.135.0
1
+ // For Library Version: 1.136.0
2
2
 
3
3
  declare module "sap/ui/rta/api/startAdaptation" {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.135.0
1
+ // For Library Version: 1.136.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.135.0
1
+ // For Library Version: 1.136.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.135.0
1
+ // For Library Version: 1.136.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -2122,6 +2122,9 @@ declare namespace sap {
2122
2122
  * Labels of the column which are displayed in the column header. Define a control for each header row in
2123
2123
  * the table. Use this aggregation if you want to use multiple headers per column.
2124
2124
  *
2125
+ * The {@link sap.m.plugins.ColumnAIAction ColumnAIAction} plugin is not compatible with multi
2126
+ * labels.
2127
+ *
2125
2128
  * @since 1.13.1
2126
2129
  */
2127
2130
  multiLabels?:
@@ -4968,6 +4971,9 @@ declare namespace sap {
4968
4971
  * Labels of the column which are displayed in the column header. Define a control for each header row in
4969
4972
  * the table. Use this aggregation if you want to use multiple headers per column.
4970
4973
  *
4974
+ * The {@link sap.m.plugins.ColumnAIAction ColumnAIAction} plugin is not compatible with multi
4975
+ * labels.
4976
+ *
4971
4977
  * @since 1.13.1
4972
4978
  */
4973
4979
  getMultiLabels(): sap.ui.core.Control[];
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.135.0
1
+ // For Library Version: 1.136.0
2
2
 
3
3
  declare namespace sap {
4
4
  interface IUI5DefineDependencyNames {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.135.0
1
+ // For Library Version: 1.136.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -3653,26 +3653,16 @@ declare namespace sap {
3653
3653
  iColumns?: int
3654
3654
  ): this;
3655
3655
  /**
3656
- * Sets a new value for property {@link #getIntervalSelection intervalSelection}.
3657
- *
3658
- * Determines if an interval of dates can be selected.
3659
- *
3660
- * **Note:** This property should be set to `false` if `_singleSelection` is set to `false`, as selecting
3661
- * multiple intervals is not supported.
3656
+ * Setter for the property `intervalSelection`. If set to `true`, an interval of months can be selected.
3662
3657
  *
3663
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3664
3658
  *
3665
- * Default value is `false`.
3666
- *
3667
- * @since 1.74
3668
- *
3669
- * @returns Reference to `this` in order to allow method chaining
3659
+ * @returns Reference to `this` for method chaining
3670
3660
  */
3671
3661
  setIntervalSelection(
3672
3662
  /**
3673
- * New value for property `intervalSelection`
3663
+ * Indicates if `intervalSelection` should be enabled
3674
3664
  */
3675
- bIntervalSelection?: boolean
3665
+ bEnabled: boolean
3676
3666
  ): this;
3677
3667
  /**
3678
3668
  * sets a minimum and maximum month
@@ -5541,26 +5531,16 @@ declare namespace sap {
5541
5531
  oDate: Date | import("sap/ui/core/date/UI5Date").default
5542
5532
  ): this;
5543
5533
  /**
5544
- * Sets a new value for property {@link #getIntervalSelection intervalSelection}.
5545
- *
5546
- * Determines if an interval of dates can be selected.
5547
- *
5548
- * **Note:** This property should be set to `false` if `_singleSelection` is set to `false`, as selecting
5549
- * multiple intervals is not supported.
5534
+ * Setter for the property `intervalSelection`. If set to `true`, an interval of years can be selected.
5550
5535
  *
5551
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5552
5536
  *
5553
- * Default value is `false`.
5554
- *
5555
- * @since 1.74
5556
- *
5557
- * @returns Reference to `this` in order to allow method chaining
5537
+ * @returns Reference to `this` for method chaining
5558
5538
  */
5559
5539
  setIntervalSelection(
5560
5540
  /**
5561
- * New value for property `intervalSelection`
5541
+ * Indicates if `intervalSelection` should be enabled
5562
5542
  */
5563
- bIntervalSelection?: boolean
5543
+ bEnabled: boolean
5564
5544
  ): this;
5565
5545
  /**
5566
5546
  * Sets a new value for property {@link #getPrimaryCalendarType primaryCalendarType}.
@@ -18614,11 +18594,11 @@ declare namespace sap {
18614
18594
  /**
18615
18595
  * The reference docking location of the menu for positioning the menu on the screen
18616
18596
  */
18617
- my: sap.ui.core.Dock,
18597
+ my: sap.ui.core.Popup.Dock,
18618
18598
  /**
18619
18599
  * The 'of' element's reference docking location for positioning the menu on the screen
18620
18600
  */
18621
- at: sap.ui.core.Dock,
18601
+ at: sap.ui.core.Popup.Dock,
18622
18602
  /**
18623
18603
  * The menu is positioned relatively to this element based on the given dock locations
18624
18604
  */
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.135.0
1
+ // For Library Version: 1.136.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.135.0
1
+ // For Library Version: 1.136.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.135.0
1
+ // For Library Version: 1.136.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.135.0
1
+ // For Library Version: 1.136.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.135.0
1
+ // For Library Version: 1.136.0
2
2
 
3
3
  declare namespace sap {
4
4
  /**
@@ -7390,16 +7390,6 @@ declare namespace sap {
7390
7390
  * @returns Value of property `importance`
7391
7391
  */
7392
7392
  getImportance(): sap.uxap.Importance;
7393
- /**
7394
- * Returns the control name text.
7395
- *
7396
- * To be overwritten by the specific control method.
7397
- *
7398
- * @ui5-protected Do not call from applications (only from related classes in the framework)
7399
- *
7400
- * @returns control name text
7401
- */
7402
- getSectionText(): string;
7403
7393
  /**
7404
7394
  * Gets current value of property {@link #getTitle title}.
7405
7395
  *
@@ -7540,7 +7530,7 @@ declare namespace sap {
7540
7530
  *
7541
7531
  * @ui5-protected Do not call from applications (only from related classes in the framework)
7542
7532
  */
7543
- setTitleVisible(bVisible: boolean): void;
7533
+ setTitleVisible(): void;
7544
7534
  /**
7545
7535
  * Sets a new value for property {@link #getVisible visible}.
7546
7536
  *
@@ -7559,15 +7549,6 @@ declare namespace sap {
7559
7549
  */
7560
7550
  bVisible?: boolean
7561
7551
  ): this;
7562
- /**
7563
- * Performs the update of the invisible text label. This method is called for example when the section title
7564
- * is changed.
7565
- *
7566
- * @ui5-protected Do not call from applications (only from related classes in the framework)
7567
- *
7568
- * @returns this for chaining
7569
- */
7570
- updateInvisibleTextLabelValue(): this;
7571
7552
  }
7572
7553
  /**
7573
7554
  * Second-level information container of an {@link sap.uxap.ObjectPageLayout}.