@openui5/types 1.125.0 → 1.126.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.125.0
1
+ // For Library Version: 1.126.0
2
2
 
3
3
  declare module "sap/ui/mdc/AggregationBaseDelegate" {
4
4
  import BaseDelegate from "sap/ui/mdc/BaseDelegate";
@@ -1740,21 +1740,6 @@ declare module "sap/ui/mdc/odata/TypeMap" {
1740
1740
  export default TypeMap;
1741
1741
  }
1742
1742
 
1743
- declare module "sap/ui/mdc/odata/v4/ChartDelegate" {
1744
- import ChartDelegate1 from "sap/ui/mdc/ChartDelegate";
1745
-
1746
- /**
1747
- * Delegate class for {@link sap.ui.mdc.Chart Chart} and ODataV4.
1748
- * This class provides method calls, which are called by the `Chart` at specific operations and allows
1749
- * to overwrite an internal behaviour.
1750
- *
1751
- * @since 1.88
1752
- */
1753
- interface ChartDelegate extends ChartDelegate1 {}
1754
- const ChartDelegate: ChartDelegate;
1755
- export default ChartDelegate;
1756
- }
1757
-
1758
1743
  declare module "sap/ui/mdc/odata/v4/TableDelegate" {
1759
1744
  import TableDelegate1 from "sap/ui/mdc/TableDelegate";
1760
1745
 
@@ -2457,12 +2442,12 @@ declare module "sap/ui/mdc/ValueHelpDelegate" {
2457
2442
 
2458
2443
  import ListBinding from "sap/ui/model/ListBinding";
2459
2444
 
2445
+ import { ConditionObject } from "sap/ui/mdc/condition/Condition";
2446
+
2460
2447
  import FilterableListContent from "sap/ui/mdc/valuehelp/base/FilterableListContent";
2461
2448
 
2462
2449
  import Context from "sap/ui/model/Context";
2463
2450
 
2464
- import { ConditionObject } from "sap/ui/mdc/condition/Condition";
2465
-
2466
2451
  import { util } from "sap/ui/mdc/library";
2467
2452
 
2468
2453
  import Filter from "sap/ui/model/Filter";
@@ -2507,6 +2492,28 @@ declare module "sap/ui/mdc/ValueHelpDelegate" {
2507
2492
  */
2508
2493
  iRequestedItems: int
2509
2494
  ): boolean | Promise<boolean>;
2495
+ /**
2496
+ * Allows control to customize selection behavior in valuelist scenarios
2497
+ *
2498
+ * @since 1.124.2
2499
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2500
+ *
2501
+ * @returns `true` if conditions are considered equal
2502
+ */
2503
+ compareConditions(
2504
+ /**
2505
+ * The `ValueHelp` control instance
2506
+ */
2507
+ oValueHelp: ValueHelp,
2508
+ /**
2509
+ * Condition to compare
2510
+ */
2511
+ oConditionA: ConditionObject,
2512
+ /**
2513
+ * Condition to compare
2514
+ */
2515
+ oConditionB: ConditionObject
2516
+ ): boolean;
2510
2517
  /**
2511
2518
  * Provides the possibility to convey custom data in conditions. This enables an application to enhance
2512
2519
  * conditions with data relevant for combined key or out parameter scenarios.
@@ -4699,6 +4706,8 @@ declare module "sap/ui/mdc/chart/ChartSelectionDetails" {
4699
4706
 
4700
4707
  import ElementMetadata from "sap/ui/core/ElementMetadata";
4701
4708
 
4709
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
4710
+
4702
4711
  /**
4703
4712
  * The `ChartSelectionDetails` control creates a `sap.m.SelectionDetails` popover based on metadata and
4704
4713
  * the configuration specified.
@@ -4713,9 +4722,6 @@ declare module "sap/ui/mdc/chart/ChartSelectionDetails" {
4713
4722
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
4714
4723
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
4715
4724
  * of the syntax of the settings object.
4716
- *
4717
- * This class does not have its own settings, but all settings applicable to the base type {@link sap.m.SelectionDetails#constructor sap.m.SelectionDetails }
4718
- * can be used.
4719
4725
  */
4720
4726
  constructor(
4721
4727
  /**
@@ -4729,9 +4735,6 @@ declare module "sap/ui/mdc/chart/ChartSelectionDetails" {
4729
4735
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
4730
4736
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
4731
4737
  * of the syntax of the settings object.
4732
- *
4733
- * This class does not have its own settings, but all settings applicable to the base type {@link sap.m.SelectionDetails#constructor sap.m.SelectionDetails }
4734
- * can be used.
4735
4738
  */
4736
4739
  constructor(
4737
4740
  /**
@@ -4775,6 +4778,82 @@ declare module "sap/ui/mdc/chart/ChartSelectionDetails" {
4775
4778
  * @returns Metadata object describing this class
4776
4779
  */
4777
4780
  static getMetadata(): ElementMetadata;
4781
+ /**
4782
+ * Gets current value of property {@link #getEnableNavCallback enableNavCallback}.
4783
+ *
4784
+ * Callback function that is called for each `SelectionDetailsItem` to determine if the navigation is enabled.
4785
+ * The callback is called with the following parameters:
4786
+ * - `oSelectionDetails` {@link sap.ui.mdc.chart.ChartSelectionDetails}: Instance of this `ChartSelectionDetails`
4787
+ *
4788
+ * - `oContext` {@link sap.ui.model.Context}: Binding context of the `SelectionDetailsItem` The
4789
+ * return value of the callback has to be of type `boolean`.
4790
+ *
4791
+ * @since 1.126
4792
+ *
4793
+ * @returns Value of property `enableNavCallback`
4794
+ */
4795
+ getEnableNavCallback(): Function;
4796
+ /**
4797
+ * Gets current value of property {@link #getFetchFieldInfosCallback fetchFieldInfosCallback}.
4798
+ *
4799
+ * Callback function that is called to determine navigation targets when clicking on a `SelectionDetailsItem`.
4800
+ * The callback is called with the following parameters:
4801
+ * - `oSelectionDetails` {@link sap.ui.mdc.chart.ChartSelectionDetails}: Instance of this `ChartSelectionDetails`
4802
+ *
4803
+ * - `oContext` {@link sap.ui.model.Context}: Binding context of the `SelectionDetailsItem` The
4804
+ * return value of the callback has to be of type `Promise` resolving in a `Map` containing a `string` as
4805
+ * key and a {@link sap.ui.mdc.field.FieldInfoBase} as value.
4806
+ *
4807
+ * @since 1.126
4808
+ *
4809
+ * @returns Value of property `fetchFieldInfosCallback`
4810
+ */
4811
+ getFetchFieldInfosCallback(): Function;
4812
+ /**
4813
+ * Sets a new value for property {@link #getEnableNavCallback enableNavCallback}.
4814
+ *
4815
+ * Callback function that is called for each `SelectionDetailsItem` to determine if the navigation is enabled.
4816
+ * The callback is called with the following parameters:
4817
+ * - `oSelectionDetails` {@link sap.ui.mdc.chart.ChartSelectionDetails}: Instance of this `ChartSelectionDetails`
4818
+ *
4819
+ * - `oContext` {@link sap.ui.model.Context}: Binding context of the `SelectionDetailsItem` The
4820
+ * return value of the callback has to be of type `boolean`.
4821
+ *
4822
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4823
+ *
4824
+ * @since 1.126
4825
+ *
4826
+ * @returns Reference to `this` in order to allow method chaining
4827
+ */
4828
+ setEnableNavCallback(
4829
+ /**
4830
+ * New value for property `enableNavCallback`
4831
+ */
4832
+ fnEnableNavCallback: Function
4833
+ ): this;
4834
+ /**
4835
+ * Sets a new value for property {@link #getFetchFieldInfosCallback fetchFieldInfosCallback}.
4836
+ *
4837
+ * Callback function that is called to determine navigation targets when clicking on a `SelectionDetailsItem`.
4838
+ * The callback is called with the following parameters:
4839
+ * - `oSelectionDetails` {@link sap.ui.mdc.chart.ChartSelectionDetails}: Instance of this `ChartSelectionDetails`
4840
+ *
4841
+ * - `oContext` {@link sap.ui.model.Context}: Binding context of the `SelectionDetailsItem` The
4842
+ * return value of the callback has to be of type `Promise` resolving in a `Map` containing a `string` as
4843
+ * key and a {@link sap.ui.mdc.field.FieldInfoBase} as value.
4844
+ *
4845
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4846
+ *
4847
+ * @since 1.126
4848
+ *
4849
+ * @returns Reference to `this` in order to allow method chaining
4850
+ */
4851
+ setFetchFieldInfosCallback(
4852
+ /**
4853
+ * New value for property `fetchFieldInfosCallback`
4854
+ */
4855
+ fnFetchFieldInfosCallback: Function
4856
+ ): this;
4778
4857
  }
4779
4858
  /**
4780
4859
  * Describes the settings that can be provided to the ChartSelectionDetails constructor.
@@ -4782,7 +4861,32 @@ declare module "sap/ui/mdc/chart/ChartSelectionDetails" {
4782
4861
  * @experimental (since 1.88)
4783
4862
  */
4784
4863
  export interface $ChartSelectionDetailsSettings
4785
- extends $SelectionDetailsSettings {}
4864
+ extends $SelectionDetailsSettings {
4865
+ /**
4866
+ * Callback function that is called for each `SelectionDetailsItem` to determine if the navigation is enabled.
4867
+ * The callback is called with the following parameters:
4868
+ * - `oSelectionDetails` {@link sap.ui.mdc.chart.ChartSelectionDetails}: Instance of this `ChartSelectionDetails`
4869
+ *
4870
+ * - `oContext` {@link sap.ui.model.Context}: Binding context of the `SelectionDetailsItem` The
4871
+ * return value of the callback has to be of type `boolean`.
4872
+ *
4873
+ * @since 1.126
4874
+ */
4875
+ enableNavCallback?: Function | PropertyBindingInfo | `{${string}}`;
4876
+
4877
+ /**
4878
+ * Callback function that is called to determine navigation targets when clicking on a `SelectionDetailsItem`.
4879
+ * The callback is called with the following parameters:
4880
+ * - `oSelectionDetails` {@link sap.ui.mdc.chart.ChartSelectionDetails}: Instance of this `ChartSelectionDetails`
4881
+ *
4882
+ * - `oContext` {@link sap.ui.model.Context}: Binding context of the `SelectionDetailsItem` The
4883
+ * return value of the callback has to be of type `Promise` resolving in a `Map` containing a `string` as
4884
+ * key and a {@link sap.ui.mdc.field.FieldInfoBase} as value.
4885
+ *
4886
+ * @since 1.126
4887
+ */
4888
+ fetchFieldInfosCallback?: Function | PropertyBindingInfo | `{${string}}`;
4889
+ }
4786
4890
  }
4787
4891
 
4788
4892
  declare module "sap/ui/mdc/chart/Item" {
@@ -6011,6 +6115,8 @@ declare module "sap/ui/mdc/condition/RangeOperator" {
6011
6115
  * Creates a `sap.ui.mdc.condition.RangeOperator` object. This is used in the {@link sap.ui.mdc.FilterField FilterField }
6012
6116
  * control to define which filter operators are supported.
6013
6117
  *
6118
+ * **Note:** Use this class only for filter field of type date or time related data types.
6119
+ *
6014
6120
  * If a function or property is initial, the default implementation is used.
6015
6121
  *
6016
6122
  * @since 1.74.0
@@ -6027,9 +6133,10 @@ declare module "sap/ui/mdc/condition/RangeOperator" {
6027
6133
  */
6028
6134
  label?: string;
6029
6135
  /**
6030
- * function to calculate the date range of the operation. the function returns an array of UniversalDates.
6136
+ * function to calculate the date range of the operation. The function returns an array of UniversalDates.
6137
+ * In case of a single `filterOperator` the array can return a single value.
6031
6138
  */
6032
- calcRange?: Function;
6139
+ calcRange: Function;
6033
6140
  /**
6034
6141
  * function to format the date range.
6035
6142
  */
@@ -8446,6 +8553,14 @@ declare module "sap/ui/mdc/field/ConditionType" {
8446
8553
  * set later
8447
8554
  */
8448
8555
  preventGetDescription?: boolean;
8556
+ /**
8557
+ * Provides control access to condition enhancements done by the ConditionType during formatting (e.g. description
8558
+ * retrieval for item condition)
8559
+ */
8560
+ awaitFormatCondition?: (
8561
+ p1: ConditionObject,
8562
+ p2: Promise<ConditionObject>
8563
+ ) => void;
8449
8564
  /**
8450
8565
  * Name of the default `Operator`
8451
8566
  */
@@ -9507,6 +9622,15 @@ declare module "sap/ui/mdc/field/FieldBase" {
9507
9622
  * @returns formatOptions of the field (see {@link sap.ui.mdc.field.ConditionsType ConditionsType})
9508
9623
  */
9509
9624
  getFormatOptions(): object;
9625
+ /**
9626
+ * Allows fields to wait for async formatting result processing
9627
+ *
9628
+ * @since 1.126.0
9629
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
9630
+ *
9631
+ * @returns returns a promise waiting for ongoing formatting
9632
+ */
9633
+ getFormattingPromise(): undefined | Promise<any>;
9510
9634
  /**
9511
9635
  * Gets current value of property {@link #getLabel label}.
9512
9636
  *
@@ -13291,6 +13415,7 @@ declare module "sap/ui/mdc/link/LinkItem" {
13291
13415
  * Destination link for a navigation operation in internal format provided by the SAP Fiori launchpad (used
13292
13416
  * when navigation happens programmatically). Only for internal use
13293
13417
  *
13418
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
13294
13419
  *
13295
13420
  * @returns Value of property `internalHref`
13296
13421
  */
@@ -13306,16 +13431,6 @@ declare module "sap/ui/mdc/link/LinkItem" {
13306
13431
  * @returns Value of property `key`
13307
13432
  */
13308
13433
  getKey(): string;
13309
- /**
13310
- * Gets current value of property {@link #getPress press}.
13311
- *
13312
- * Callback for `press` event.
13313
- *
13314
- * @since 1.122.0
13315
- *
13316
- * @returns Value of property `press`
13317
- */
13318
- getPress(): object;
13319
13434
  /**
13320
13435
  * Gets current value of property {@link #getTarget target}.
13321
13436
  *
@@ -13416,6 +13531,7 @@ declare module "sap/ui/mdc/link/LinkItem" {
13416
13531
  *
13417
13532
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
13418
13533
  *
13534
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
13419
13535
  *
13420
13536
  * @returns Reference to `this` in order to allow method chaining
13421
13537
  */
@@ -13443,23 +13559,6 @@ declare module "sap/ui/mdc/link/LinkItem" {
13443
13559
  */
13444
13560
  sKey?: string
13445
13561
  ): this;
13446
- /**
13447
- * Sets a new value for property {@link #getPress press}.
13448
- *
13449
- * Callback for `press` event.
13450
- *
13451
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
13452
- *
13453
- * @since 1.122.0
13454
- *
13455
- * @returns Reference to `this` in order to allow method chaining
13456
- */
13457
- setPress(
13458
- /**
13459
- * New value for property `press`
13460
- */
13461
- oPress?: object
13462
- ): this;
13463
13562
  /**
13464
13563
  * Sets a new value for property {@link #getTarget target}.
13465
13564
  *
@@ -13525,6 +13624,8 @@ declare module "sap/ui/mdc/link/LinkItem" {
13525
13624
  /**
13526
13625
  * Destination link for a navigation operation in internal format provided by the SAP Fiori launchpad (used
13527
13626
  * when navigation happens programmatically). Only for internal use
13627
+ *
13628
+ * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
13528
13629
  */
13529
13630
  internalHref?: string | PropertyBindingInfo;
13530
13631
 
@@ -13545,13 +13646,6 @@ declare module "sap/ui/mdc/link/LinkItem" {
13545
13646
  * without any personalization.
13546
13647
  */
13547
13648
  initiallyVisible?: boolean | PropertyBindingInfo | `{${string}}`;
13548
-
13549
- /**
13550
- * Callback for `press` event.
13551
- *
13552
- * @since 1.122.0
13553
- */
13554
- press?: object | PropertyBindingInfo | `{${string}}`;
13555
13649
  }
13556
13650
  }
13557
13651
 
@@ -14622,15 +14716,6 @@ declare module "sap/ui/mdc/Table" {
14622
14716
  * @returns Reference to `this` in order to allow method chaining
14623
14717
  */
14624
14718
  destroyCopyProvider(): this;
14625
- /**
14626
- * Destroys the creationRow in the aggregation {@link #getCreationRow creationRow}.
14627
- *
14628
- * @deprecated (since 1.124) - the concept has been discarded.
14629
- * @experimental - Do not use
14630
- *
14631
- * @returns Reference to `this` in order to allow method chaining
14632
- */
14633
- destroyCreationRow(): this;
14634
14719
  /**
14635
14720
  * Destroys the dataStateIndicator in the aggregation {@link #getDataStateIndicator dataStateIndicator}.
14636
14721
  *
@@ -14941,18 +15026,6 @@ declare module "sap/ui/mdc/Table" {
14941
15026
  * @since 1.114
14942
15027
  */
14943
15028
  getCopyProvider(): CopyProvider;
14944
- /**
14945
- * Gets content of aggregation {@link #getCreationRow creationRow}.
14946
- *
14947
- * This row can be used for user input to create new data if {@link sap.ui.mdc.enums.TableType TableType }
14948
- * is "`Table`".
14949
- *
14950
- * **Note:** Once the binding supports creating transient records, this aggregation will be removed.
14951
- *
14952
- * @deprecated (since 1.124) - the concept has been discarded.
14953
- * @experimental - Do not use
14954
- */
14955
- getCreationRow(): /* was: sap.ui.mdc.table.CreationRow */ any;
14956
15029
  /**
14957
15030
  * Gets content of aggregation {@link #getDataStateIndicator dataStateIndicator}.
14958
15031
  *
@@ -15077,17 +15150,6 @@ declare module "sap/ui/mdc/Table" {
15077
15150
  * @returns Value of property `headerLevel`
15078
15151
  */
15079
15152
  getHeaderLevel(): TitleLevel | keyof typeof TitleLevel;
15080
- /**
15081
- * Gets current value of property {@link #getHeaderStyle headerStyle}.
15082
- *
15083
- * Defines style of the header. For more information, see {@link sap.m.Title#setTitleStyle}.
15084
- *
15085
- * @since 1.116
15086
- * @experimental
15087
- *
15088
- * @returns Value of property `headerStyle`
15089
- */
15090
- getHeaderStyle(): TitleLevel | keyof typeof TitleLevel;
15091
15153
  /**
15092
15154
  * Gets current value of property {@link #getHeaderVisible headerVisible}.
15093
15155
  *
@@ -15450,20 +15512,6 @@ declare module "sap/ui/mdc/Table" {
15450
15512
  */
15451
15513
  oCopyProvider: CopyProvider
15452
15514
  ): this;
15453
- /**
15454
- * Sets the aggregated {@link #getCreationRow creationRow}.
15455
- *
15456
- * @deprecated (since 1.124) - the concept has been discarded.
15457
- * @experimental - Do not use
15458
- *
15459
- * @returns Reference to `this` in order to allow method chaining
15460
- */
15461
- setCreationRow(
15462
- /**
15463
- * The creationRow to set
15464
- */
15465
- oCreationRow: /* was: sap.ui.mdc.table.CreationRow */ any
15466
- ): this;
15467
15515
  /**
15468
15516
  * Sets the aggregated {@link #getDataStateIndicator dataStateIndicator}.
15469
15517
  *
@@ -15651,24 +15699,6 @@ declare module "sap/ui/mdc/Table" {
15651
15699
  */
15652
15700
  sHeaderLevel?: TitleLevel | keyof typeof TitleLevel
15653
15701
  ): this;
15654
- /**
15655
- * Sets a new value for property {@link #getHeaderStyle headerStyle}.
15656
- *
15657
- * Defines style of the header. For more information, see {@link sap.m.Title#setTitleStyle}.
15658
- *
15659
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
15660
- *
15661
- * @since 1.116
15662
- * @experimental
15663
- *
15664
- * @returns Reference to `this` in order to allow method chaining
15665
- */
15666
- setHeaderStyle(
15667
- /**
15668
- * New value for property `headerStyle`
15669
- */
15670
- sHeaderStyle: TitleLevel | keyof typeof TitleLevel
15671
- ): this;
15672
15702
  /**
15673
15703
  * Sets a new value for property {@link #getHeaderVisible headerVisible}.
15674
15704
  *
@@ -16156,17 +16186,6 @@ declare module "sap/ui/mdc/Table" {
16156
16186
  | PropertyBindingInfo
16157
16187
  | `{${string}}`;
16158
16188
 
16159
- /**
16160
- * Defines style of the header. For more information, see {@link sap.m.Title#setTitleStyle}.
16161
- *
16162
- * @since 1.116
16163
- * @experimental
16164
- */
16165
- headerStyle?:
16166
- | (TitleLevel | keyof typeof TitleLevel)
16167
- | PropertyBindingInfo
16168
- | `{${string}}`;
16169
-
16170
16189
  /**
16171
16190
  * Determines whether to bind the table automatically after the initial creation or re-creation of the table.
16172
16191
  */
@@ -16413,17 +16432,6 @@ declare module "sap/ui/mdc/Table" {
16413
16432
  */
16414
16433
  columns?: Column[] | Column | AggregationBindingInfo | `{${string}}`;
16415
16434
 
16416
- /**
16417
- * This row can be used for user input to create new data if {@link sap.ui.mdc.enums.TableType TableType }
16418
- * is "`Table`".
16419
- *
16420
- * **Note:** Once the binding supports creating transient records, this aggregation will be removed.
16421
- *
16422
- * @deprecated (since 1.124) - the concept has been discarded.
16423
- * @experimental - Do not use
16424
- */
16425
- creationRow?: /* was: sap.ui.mdc.table.CreationRow */ any;
16426
-
16427
16435
  /**
16428
16436
  * Additional actions that will be available in the toolbar.
16429
16437
  *
@@ -16836,15 +16844,6 @@ declare module "sap/ui/mdc/table/Column" {
16836
16844
  * @returns Metadata object describing this class
16837
16845
  */
16838
16846
  static getMetadata(): ElementMetadata;
16839
- /**
16840
- * Destroys the creationTemplate in the aggregation {@link #getCreationTemplate creationTemplate}.
16841
- *
16842
- * @deprecated (since 1.124) - the concept has been discarded.
16843
- * @experimental - Internal use only
16844
- *
16845
- * @returns Reference to `this` in order to allow method chaining
16846
- */
16847
- destroyCreationTemplate(): this;
16848
16847
  /**
16849
16848
  * Destroys the extendedSettings in the aggregation {@link #getExtendedSettings extendedSettings}.
16850
16849
  *
@@ -16860,17 +16859,6 @@ declare module "sap/ui/mdc/table/Column" {
16860
16859
  * @returns Reference to `this` in order to allow method chaining
16861
16860
  */
16862
16861
  destroyTemplate(): this;
16863
- /**
16864
- * Gets content of aggregation {@link #getCreationTemplate creationTemplate}.
16865
- *
16866
- * `CreationRow` template.
16867
- *
16868
- * **Note:** Once the binding supports creating transient records, this aggregation will be removed.
16869
- *
16870
- * @deprecated (since 1.124) - the concept has been discarded.
16871
- * @experimental - Internal use only
16872
- */
16873
- getCreationTemplate(): Control;
16874
16862
  /**
16875
16863
  * Gets current value of property {@link #getDataProperty dataProperty}.
16876
16864
  *
@@ -17005,20 +16993,6 @@ declare module "sap/ui/mdc/table/Column" {
17005
16993
  * @returns Value of property `width`
17006
16994
  */
17007
16995
  getWidth(): CSSSize;
17008
- /**
17009
- * Sets the aggregated {@link #getCreationTemplate creationTemplate}.
17010
- *
17011
- * @deprecated (since 1.124) - the concept has been discarded.
17012
- * @experimental - Internal use only
17013
- *
17014
- * @returns Reference to `this` in order to allow method chaining
17015
- */
17016
- setCreationTemplate(
17017
- /**
17018
- * The creationTemplate to set
17019
- */
17020
- oCreationTemplate: Control
17021
- ): this;
17022
16996
  /**
17023
16997
  * Sets a new value for property {@link #getDataProperty dataProperty}.
17024
16998
  *
@@ -17335,16 +17309,6 @@ declare module "sap/ui/mdc/table/Column" {
17335
17309
  */
17336
17310
  template?: Control;
17337
17311
 
17338
- /**
17339
- * `CreationRow` template.
17340
- *
17341
- * **Note:** Once the binding supports creating transient records, this aggregation will be removed.
17342
- *
17343
- * @deprecated (since 1.124) - the concept has been discarded.
17344
- * @experimental - Internal use only
17345
- */
17346
- creationTemplate?: Control;
17347
-
17348
17312
  /**
17349
17313
  * Defines type-specific column settings based on the used {@link sap.ui.mdc.table.TableTypeBase}.
17350
17314
  *
@@ -19105,153 +19069,63 @@ declare module "sap/ui/mdc/table/RowActionItem" {
19105
19069
  */
19106
19070
  static getMetadata(): ElementMetadata;
19107
19071
  /**
19108
- * Attaches event handler `fnFunction` to the {@link #event:press press} event of this `sap.ui.mdc.table.RowActionItem`.
19072
+ * Gets current value of property {@link #getIcon icon}.
19109
19073
  *
19110
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
19111
- * otherwise it will be bound to this `sap.ui.mdc.table.RowActionItem` itself.
19074
+ * Icon for the row action item.
19112
19075
  *
19113
- * Fired when the row action item is pressed.
19076
+ * **Note:** A custom icon cannot be set when the table type is {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}.
19077
+ *
19078
+ *
19079
+ * @returns Value of property `icon`
19080
+ */
19081
+ getIcon(): URI;
19082
+ /**
19083
+ * Gets current value of property {@link #getText text}.
19114
19084
  *
19115
- * If the table type is {@link sap.ui.mdc.table.GridTableType GridTable}, the `press` event is fired when
19116
- * a row action item is pressed.
19085
+ * Text for the row action item.
19117
19086
  *
19118
- * If the table type is {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}, the `press` event
19119
- * and the table's `rowPress` event are fired when a row with a row action item is pressed.
19087
+ * **Note:** A custom text cannot be set when the table type is {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}.
19120
19088
  *
19121
19089
  *
19122
- * @returns Reference to `this` in order to allow method chaining
19090
+ * @returns Value of property `text`
19123
19091
  */
19124
- attachPress(
19125
- /**
19126
- * An application-specific payload object that will be passed to the event handler along with the event
19127
- * object when firing the event
19128
- */
19129
- oData: object,
19130
- /**
19131
- * The function to be called when the event occurs
19132
- */
19133
- fnFunction: (p1: RowActionItem$PressEvent) => void,
19134
- /**
19135
- * Context object to call the event handler with. Defaults to this `sap.ui.mdc.table.RowActionItem` itself
19136
- */
19137
- oListener?: object
19138
- ): this;
19092
+ getText(): string;
19139
19093
  /**
19140
- * Attaches event handler `fnFunction` to the {@link #event:press press} event of this `sap.ui.mdc.table.RowActionItem`.
19094
+ * Gets current value of property {@link #getType type}.
19141
19095
  *
19142
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
19143
- * otherwise it will be bound to this `sap.ui.mdc.table.RowActionItem` itself.
19096
+ * Type of the row action item.
19097
+ *
19098
+ * Setting the type ensures default values for the properties `icon` and `text`. If an icon or text is set
19099
+ * explicitly, this setting is used.
19144
19100
  *
19145
- * Fired when the row action item is pressed.
19146
19101
  *
19147
- * If the table type is {@link sap.ui.mdc.table.GridTableType GridTable}, the `press` event is fired when
19148
- * a row action item is pressed.
19102
+ * @returns Value of property `type`
19103
+ */
19104
+ getType(): TableRowActionType | keyof typeof TableRowActionType;
19105
+ /**
19106
+ * Gets current value of property {@link #getVisible visible}.
19107
+ *
19108
+ * Whether the item should be visible on the screen.
19149
19109
  *
19150
- * If the table type is {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}, the `press` event
19151
- * and the table's `rowPress` event are fired when a row with a row action item is pressed.
19110
+ * Default value is `true`.
19152
19111
  *
19153
19112
  *
19154
- * @returns Reference to `this` in order to allow method chaining
19113
+ * @returns Value of property `visible`
19155
19114
  */
19156
- attachPress(
19157
- /**
19158
- * The function to be called when the event occurs
19159
- */
19160
- fnFunction: (p1: RowActionItem$PressEvent) => void,
19161
- /**
19162
- * Context object to call the event handler with. Defaults to this `sap.ui.mdc.table.RowActionItem` itself
19163
- */
19164
- oListener?: object
19165
- ): this;
19115
+ getVisible(): boolean;
19166
19116
  /**
19167
- * Detaches event handler `fnFunction` from the {@link #event:press press} event of this `sap.ui.mdc.table.RowActionItem`.
19117
+ * Sets a new value for property {@link #getIcon icon}.
19168
19118
  *
19169
- * The passed function and listener object must match the ones used for event registration.
19119
+ * Icon for the row action item.
19120
+ *
19121
+ * **Note:** A custom icon cannot be set when the table type is {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}.
19122
+ *
19123
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
19170
19124
  *
19171
19125
  *
19172
19126
  * @returns Reference to `this` in order to allow method chaining
19173
19127
  */
19174
- detachPress(
19175
- /**
19176
- * The function to be called, when the event occurs
19177
- */
19178
- fnFunction: (p1: RowActionItem$PressEvent) => void,
19179
- /**
19180
- * Context object on which the given function had to be called
19181
- */
19182
- oListener?: object
19183
- ): this;
19184
- /**
19185
- * Fires event {@link #event:press press} to attached listeners.
19186
- *
19187
- * @ui5-protected Do not call from applications (only from related classes in the framework)
19188
- *
19189
- * @returns Reference to `this` in order to allow method chaining
19190
- */
19191
- firePress(
19192
- /**
19193
- * Parameters to pass along with the event
19194
- */
19195
- mParameters?: RowActionItem$PressEventParameters
19196
- ): this;
19197
- /**
19198
- * Gets current value of property {@link #getIcon icon}.
19199
- *
19200
- * Icon for the row action item.
19201
- *
19202
- * **Note:** A custom icon cannot be set when the table type is {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}.
19203
- *
19204
- *
19205
- * @returns Value of property `icon`
19206
- */
19207
- getIcon(): URI;
19208
- /**
19209
- * Gets current value of property {@link #getText text}.
19210
- *
19211
- * Text for the row action item.
19212
- *
19213
- * **Note:** A custom text cannot be set when the table type is {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}.
19214
- *
19215
- *
19216
- * @returns Value of property `text`
19217
- */
19218
- getText(): string;
19219
- /**
19220
- * Gets current value of property {@link #getType type}.
19221
- *
19222
- * Type of the row action item.
19223
- *
19224
- * Setting the type ensures default values for the properties `icon` and `text`. If an icon or text is set
19225
- * explicitly, this setting is used.
19226
- *
19227
- *
19228
- * @returns Value of property `type`
19229
- */
19230
- getType(): TableRowActionType | keyof typeof TableRowActionType;
19231
- /**
19232
- * Gets current value of property {@link #getVisible visible}.
19233
- *
19234
- * Whether the item should be visible on the screen.
19235
- *
19236
- * Default value is `true`.
19237
- *
19238
- *
19239
- * @returns Value of property `visible`
19240
- */
19241
- getVisible(): boolean;
19242
- /**
19243
- * Sets a new value for property {@link #getIcon icon}.
19244
- *
19245
- * Icon for the row action item.
19246
- *
19247
- * **Note:** A custom icon cannot be set when the table type is {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}.
19248
- *
19249
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
19250
- *
19251
- *
19252
- * @returns Reference to `this` in order to allow method chaining
19253
- */
19254
- setIcon(
19128
+ setIcon(
19255
19129
  /**
19256
19130
  * New value for property `icon`
19257
19131
  */
@@ -19346,17 +19220,6 @@ declare module "sap/ui/mdc/table/RowActionItem" {
19346
19220
  * Whether the item should be visible on the screen.
19347
19221
  */
19348
19222
  visible?: boolean | PropertyBindingInfo | `{${string}}`;
19349
-
19350
- /**
19351
- * Fired when the row action item is pressed.
19352
- *
19353
- * If the table type is {@link sap.ui.mdc.table.GridTableType GridTable}, the `press` event is fired when
19354
- * a row action item is pressed.
19355
- *
19356
- * If the table type is {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}, the `press` event
19357
- * and the table's `rowPress` event are fired when a row with a row action item is pressed.
19358
- */
19359
- press?: (oEvent: RowActionItem$PressEvent) => void;
19360
19223
  }
19361
19224
 
19362
19225
  /**
@@ -20067,20 +19930,17 @@ declare module "sap/ui/mdc/ValueHelp" {
20067
19930
  oListener?: object
20068
19931
  ): this;
20069
19932
  /**
20070
- * Attaches event handler `fnFunction` to the {@link #event:disconnect disconnect} event of this `sap.ui.mdc.ValueHelp`.
19933
+ * Attaches event handler `fnFunction` to the {@link #event:open open} event of this `sap.ui.mdc.ValueHelp`.
20071
19934
  *
20072
19935
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
20073
19936
  * otherwise it will be bound to this `sap.ui.mdc.ValueHelp` itself.
20074
19937
  *
20075
- * This event is fired when the `ValueHelp` element is disconnected from a control.
20076
- *
20077
- * **Note:** This event must only be handled by the control the `ValueHelp` element belongs to, not by the
20078
- * application.
19938
+ * This event is fired as the value help opening is triggered.
20079
19939
  *
20080
19940
  *
20081
19941
  * @returns Reference to `this` in order to allow method chaining
20082
19942
  */
20083
- attachDisconnect(
19943
+ attachOpen(
20084
19944
  /**
20085
19945
  * An application-specific payload object that will be passed to the event handler along with the event
20086
19946
  * object when firing the event
@@ -20089,48 +19949,45 @@ declare module "sap/ui/mdc/ValueHelp" {
20089
19949
  /**
20090
19950
  * The function to be called when the event occurs
20091
19951
  */
20092
- fnFunction: (p1: Event) => void,
19952
+ fnFunction: (p1: ValueHelp$OpenEvent) => void,
20093
19953
  /**
20094
19954
  * Context object to call the event handler with. Defaults to this `sap.ui.mdc.ValueHelp` itself
20095
19955
  */
20096
19956
  oListener?: object
20097
19957
  ): this;
20098
19958
  /**
20099
- * Attaches event handler `fnFunction` to the {@link #event:disconnect disconnect} event of this `sap.ui.mdc.ValueHelp`.
19959
+ * Attaches event handler `fnFunction` to the {@link #event:open open} event of this `sap.ui.mdc.ValueHelp`.
20100
19960
  *
20101
19961
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
20102
19962
  * otherwise it will be bound to this `sap.ui.mdc.ValueHelp` itself.
20103
19963
  *
20104
- * This event is fired when the `ValueHelp` element is disconnected from a control.
20105
- *
20106
- * **Note:** This event must only be handled by the control the `ValueHelp` element belongs to, not by the
20107
- * application.
19964
+ * This event is fired as the value help opening is triggered.
20108
19965
  *
20109
19966
  *
20110
19967
  * @returns Reference to `this` in order to allow method chaining
20111
19968
  */
20112
- attachDisconnect(
19969
+ attachOpen(
20113
19970
  /**
20114
19971
  * The function to be called when the event occurs
20115
19972
  */
20116
- fnFunction: (p1: Event) => void,
19973
+ fnFunction: (p1: ValueHelp$OpenEvent) => void,
20117
19974
  /**
20118
19975
  * Context object to call the event handler with. Defaults to this `sap.ui.mdc.ValueHelp` itself
20119
19976
  */
20120
19977
  oListener?: object
20121
19978
  ): this;
20122
19979
  /**
20123
- * Attaches event handler `fnFunction` to the {@link #event:navigated navigated} event of this `sap.ui.mdc.ValueHelp`.
19980
+ * Attaches event handler `fnFunction` to the {@link #event:opened opened} event of this `sap.ui.mdc.ValueHelp`.
20124
19981
  *
20125
19982
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
20126
19983
  * otherwise it will be bound to this `sap.ui.mdc.ValueHelp` itself.
20127
19984
  *
20128
- * This event is fired after the user navigated, using the arrow keys, in the value help.
19985
+ * This event is fired as the value help is fully open.
20129
19986
  *
20130
19987
  *
20131
19988
  * @returns Reference to `this` in order to allow method chaining
20132
19989
  */
20133
- attachNavigated(
19990
+ attachOpened(
20134
19991
  /**
20135
19992
  * An application-specific payload object that will be passed to the event handler along with the event
20136
19993
  * object when firing the event
@@ -20139,565 +19996,341 @@ declare module "sap/ui/mdc/ValueHelp" {
20139
19996
  /**
20140
19997
  * The function to be called when the event occurs
20141
19998
  */
20142
- fnFunction: (p1: ValueHelp$NavigatedEvent) => void,
19999
+ fnFunction: (p1: ValueHelp$OpenedEvent) => void,
20143
20000
  /**
20144
20001
  * Context object to call the event handler with. Defaults to this `sap.ui.mdc.ValueHelp` itself
20145
20002
  */
20146
20003
  oListener?: object
20147
20004
  ): this;
20148
20005
  /**
20149
- * Attaches event handler `fnFunction` to the {@link #event:navigated navigated} event of this `sap.ui.mdc.ValueHelp`.
20006
+ * Attaches event handler `fnFunction` to the {@link #event:opened opened} event of this `sap.ui.mdc.ValueHelp`.
20150
20007
  *
20151
20008
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
20152
20009
  * otherwise it will be bound to this `sap.ui.mdc.ValueHelp` itself.
20153
20010
  *
20154
- * This event is fired after the user navigated, using the arrow keys, in the value help.
20011
+ * This event is fired as the value help is fully open.
20155
20012
  *
20156
20013
  *
20157
20014
  * @returns Reference to `this` in order to allow method chaining
20158
20015
  */
20159
- attachNavigated(
20016
+ attachOpened(
20160
20017
  /**
20161
20018
  * The function to be called when the event occurs
20162
20019
  */
20163
- fnFunction: (p1: ValueHelp$NavigatedEvent) => void,
20020
+ fnFunction: (p1: ValueHelp$OpenedEvent) => void,
20164
20021
  /**
20165
20022
  * Context object to call the event handler with. Defaults to this `sap.ui.mdc.ValueHelp` itself
20166
20023
  */
20167
20024
  oListener?: object
20168
20025
  ): this;
20169
20026
  /**
20170
- * Attaches event handler `fnFunction` to the {@link #event:open open} event of this `sap.ui.mdc.ValueHelp`.
20027
+ * Destroys the dialog in the aggregation {@link #getDialog dialog}.
20171
20028
  *
20172
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
20173
- * otherwise it will be bound to this `sap.ui.mdc.ValueHelp` itself.
20174
20029
  *
20175
- * This event is fired as the value help opening is triggered.
20030
+ * @returns Reference to `this` in order to allow method chaining
20031
+ */
20032
+ destroyDialog(): this;
20033
+ /**
20034
+ * Destroys the typeahead in the aggregation {@link #getTypeahead typeahead}.
20176
20035
  *
20177
20036
  *
20178
20037
  * @returns Reference to `this` in order to allow method chaining
20179
20038
  */
20180
- attachOpen(
20181
- /**
20182
- * An application-specific payload object that will be passed to the event handler along with the event
20183
- * object when firing the event
20184
- */
20185
- oData: object,
20186
- /**
20187
- * The function to be called when the event occurs
20188
- */
20189
- fnFunction: (p1: ValueHelp$OpenEvent) => void,
20190
- /**
20191
- * Context object to call the event handler with. Defaults to this `sap.ui.mdc.ValueHelp` itself
20192
- */
20193
- oListener?: object
20194
- ): this;
20039
+ destroyTypeahead(): this;
20195
20040
  /**
20196
- * Attaches event handler `fnFunction` to the {@link #event:open open} event of this `sap.ui.mdc.ValueHelp`.
20197
- *
20198
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
20199
- * otherwise it will be bound to this `sap.ui.mdc.ValueHelp` itself.
20041
+ * Detaches event handler `fnFunction` from the {@link #event:closed closed} event of this `sap.ui.mdc.ValueHelp`.
20200
20042
  *
20201
- * This event is fired as the value help opening is triggered.
20043
+ * The passed function and listener object must match the ones used for event registration.
20202
20044
  *
20203
20045
  *
20204
20046
  * @returns Reference to `this` in order to allow method chaining
20205
20047
  */
20206
- attachOpen(
20048
+ detachClosed(
20207
20049
  /**
20208
- * The function to be called when the event occurs
20050
+ * The function to be called, when the event occurs
20209
20051
  */
20210
- fnFunction: (p1: ValueHelp$OpenEvent) => void,
20052
+ fnFunction: (p1: Event) => void,
20211
20053
  /**
20212
- * Context object to call the event handler with. Defaults to this `sap.ui.mdc.ValueHelp` itself
20054
+ * Context object on which the given function had to be called
20213
20055
  */
20214
20056
  oListener?: object
20215
20057
  ): this;
20216
20058
  /**
20217
- * Attaches event handler `fnFunction` to the {@link #event:opened opened} event of this `sap.ui.mdc.ValueHelp`.
20218
- *
20219
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
20220
- * otherwise it will be bound to this `sap.ui.mdc.ValueHelp` itself.
20059
+ * Detaches event handler `fnFunction` from the {@link #event:open open} event of this `sap.ui.mdc.ValueHelp`.
20221
20060
  *
20222
- * This event is fired as the value help is fully open.
20061
+ * The passed function and listener object must match the ones used for event registration.
20223
20062
  *
20224
20063
  *
20225
20064
  * @returns Reference to `this` in order to allow method chaining
20226
20065
  */
20227
- attachOpened(
20228
- /**
20229
- * An application-specific payload object that will be passed to the event handler along with the event
20230
- * object when firing the event
20231
- */
20232
- oData: object,
20066
+ detachOpen(
20233
20067
  /**
20234
- * The function to be called when the event occurs
20068
+ * The function to be called, when the event occurs
20235
20069
  */
20236
- fnFunction: (p1: ValueHelp$OpenedEvent) => void,
20070
+ fnFunction: (p1: ValueHelp$OpenEvent) => void,
20237
20071
  /**
20238
- * Context object to call the event handler with. Defaults to this `sap.ui.mdc.ValueHelp` itself
20072
+ * Context object on which the given function had to be called
20239
20073
  */
20240
20074
  oListener?: object
20241
20075
  ): this;
20242
20076
  /**
20243
- * Attaches event handler `fnFunction` to the {@link #event:opened opened} event of this `sap.ui.mdc.ValueHelp`.
20244
- *
20245
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
20246
- * otherwise it will be bound to this `sap.ui.mdc.ValueHelp` itself.
20077
+ * Detaches event handler `fnFunction` from the {@link #event:opened opened} event of this `sap.ui.mdc.ValueHelp`.
20247
20078
  *
20248
- * This event is fired as the value help is fully open.
20079
+ * The passed function and listener object must match the ones used for event registration.
20249
20080
  *
20250
20081
  *
20251
20082
  * @returns Reference to `this` in order to allow method chaining
20252
20083
  */
20253
- attachOpened(
20084
+ detachOpened(
20254
20085
  /**
20255
- * The function to be called when the event occurs
20086
+ * The function to be called, when the event occurs
20256
20087
  */
20257
20088
  fnFunction: (p1: ValueHelp$OpenedEvent) => void,
20258
20089
  /**
20259
- * Context object to call the event handler with. Defaults to this `sap.ui.mdc.ValueHelp` itself
20090
+ * Context object on which the given function had to be called
20260
20091
  */
20261
20092
  oListener?: object
20262
20093
  ): this;
20263
20094
  /**
20264
- * Attaches event handler `fnFunction` to the {@link #event:select select} event of this `sap.ui.mdc.ValueHelp`.
20265
- *
20266
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
20267
- * otherwise it will be bound to this `sap.ui.mdc.ValueHelp` itself.
20268
- *
20269
- * This event is fired when a value is selected in the value help.
20270
- *
20271
- * **Note:** This event must only be handled by the control the `ValueHelp` element belongs to, not by the
20272
- * application.
20095
+ * Fires event {@link #event:closed closed} to attached listeners.
20273
20096
  *
20097
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
20274
20098
  *
20275
20099
  * @returns Reference to `this` in order to allow method chaining
20276
20100
  */
20277
- attachSelect(
20278
- /**
20279
- * An application-specific payload object that will be passed to the event handler along with the event
20280
- * object when firing the event
20281
- */
20282
- oData: object,
20283
- /**
20284
- * The function to be called when the event occurs
20285
- */
20286
- fnFunction: (p1: ValueHelp$SelectEvent) => void,
20101
+ fireClosed(
20287
20102
  /**
20288
- * Context object to call the event handler with. Defaults to this `sap.ui.mdc.ValueHelp` itself
20103
+ * Parameters to pass along with the event
20289
20104
  */
20290
- oListener?: object
20105
+ mParameters?: object
20291
20106
  ): this;
20292
20107
  /**
20293
- * Attaches event handler `fnFunction` to the {@link #event:select select} event of this `sap.ui.mdc.ValueHelp`.
20294
- *
20295
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
20296
- * otherwise it will be bound to this `sap.ui.mdc.ValueHelp` itself.
20297
- *
20298
- * This event is fired when a value is selected in the value help.
20299
- *
20300
- * **Note:** This event must only be handled by the control the `ValueHelp` element belongs to, not by the
20301
- * application.
20108
+ * Fires event {@link #event:open open} to attached listeners.
20302
20109
  *
20110
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
20303
20111
  *
20304
20112
  * @returns Reference to `this` in order to allow method chaining
20305
20113
  */
20306
- attachSelect(
20307
- /**
20308
- * The function to be called when the event occurs
20309
- */
20310
- fnFunction: (p1: ValueHelp$SelectEvent) => void,
20114
+ fireOpen(
20311
20115
  /**
20312
- * Context object to call the event handler with. Defaults to this `sap.ui.mdc.ValueHelp` itself
20116
+ * Parameters to pass along with the event
20313
20117
  */
20314
- oListener?: object
20118
+ mParameters?: ValueHelp$OpenEventParameters
20315
20119
  ): this;
20316
20120
  /**
20317
- * Attaches event handler `fnFunction` to the {@link #event:switchToValueHelp switchToValueHelp} event of
20318
- * this `sap.ui.mdc.ValueHelp`.
20319
- *
20320
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
20321
- * otherwise it will be bound to this `sap.ui.mdc.ValueHelp` itself.
20322
- *
20323
- * This event is fired if the user wants to switch from typeahead to value help.
20121
+ * Fires event {@link #event:opened opened} to attached listeners.
20324
20122
  *
20123
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
20325
20124
  *
20326
20125
  * @returns Reference to `this` in order to allow method chaining
20327
20126
  */
20328
- attachSwitchToValueHelp(
20329
- /**
20330
- * An application-specific payload object that will be passed to the event handler along with the event
20331
- * object when firing the event
20332
- */
20333
- oData: object,
20334
- /**
20335
- * The function to be called when the event occurs
20336
- */
20337
- fnFunction: (p1: Event) => void,
20127
+ fireOpened(
20338
20128
  /**
20339
- * Context object to call the event handler with. Defaults to this `sap.ui.mdc.ValueHelp` itself
20129
+ * Parameters to pass along with the event
20340
20130
  */
20341
- oListener?: object
20131
+ mParameters?: ValueHelp$OpenedEventParameters
20342
20132
  ): this;
20343
20133
  /**
20344
- * Attaches event handler `fnFunction` to the {@link #event:switchToValueHelp switchToValueHelp} event of
20345
- * this `sap.ui.mdc.ValueHelp`.
20134
+ * Gets current value of property {@link #getDelegate delegate}.
20346
20135
  *
20347
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
20348
- * otherwise it will be bound to this `sap.ui.mdc.ValueHelp` itself.
20136
+ * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
20137
+ * The object has the following properties:
20138
+ * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/ValueHelpDelegate ValueHelpDelegate }
20139
+ *
20140
+ * - `payload` (optional) defines application-specific information that can be used in the given delegate
20141
+ * Sample delegate object:
20142
+ * ```javascript
20143
+ * {
20144
+ * name: "sap/ui/mdc/ValueHelpDelegate",
20145
+ * payload: {}
20146
+ * }```
20147
+ * **Note:** Ensure that the related file can be requested (any required library has to be loaded before
20148
+ * that).
20149
+ * Do not bind or modify the module. This property can only be configured during control initialization.
20349
20150
  *
20350
- * This event is fired if the user wants to switch from typeahead to value help.
20151
+ * Default value is `...see text or source`.
20351
20152
  *
20352
20153
  *
20353
- * @returns Reference to `this` in order to allow method chaining
20154
+ * @returns Value of property `delegate`
20354
20155
  */
20355
- attachSwitchToValueHelp(
20356
- /**
20357
- * The function to be called when the event occurs
20358
- */
20359
- fnFunction: (p1: Event) => void,
20360
- /**
20361
- * Context object to call the event handler with. Defaults to this `sap.ui.mdc.ValueHelp` itself
20362
- */
20363
- oListener?: object
20364
- ): this;
20156
+ getDelegate(): object;
20365
20157
  /**
20366
- * Attaches event handler `fnFunction` to the {@link #event:typeaheadSuggested typeaheadSuggested} event
20367
- * of this `sap.ui.mdc.ValueHelp`.
20368
- *
20369
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
20370
- * otherwise it will be bound to this `sap.ui.mdc.ValueHelp` itself.
20371
- *
20372
- * This event is fired after a suggested item has been found for a type-ahead.
20373
- *
20374
- * @since 1.120.0
20158
+ * Gets content of aggregation {@link #getDialog dialog}.
20375
20159
  *
20376
- * @returns Reference to `this` in order to allow method chaining
20160
+ * Container that is used and opened if the value help icon of the input field is pressed.
20377
20161
  */
20378
- attachTypeaheadSuggested(
20379
- /**
20380
- * An application-specific payload object that will be passed to the event handler along with the event
20381
- * object when firing the event
20382
- */
20383
- oData: object,
20384
- /**
20385
- * The function to be called when the event occurs
20386
- */
20387
- fnFunction: (p1: ValueHelp$TypeaheadSuggestedEvent) => void,
20388
- /**
20389
- * Context object to call the event handler with. Defaults to this `sap.ui.mdc.ValueHelp` itself
20390
- */
20391
- oListener?: object
20392
- ): this;
20162
+ getDialog(): /* was: sap.ui.mdc.valuehelp.IDialogContainer */ any;
20393
20163
  /**
20394
- * Attaches event handler `fnFunction` to the {@link #event:typeaheadSuggested typeaheadSuggested} event
20395
- * of this `sap.ui.mdc.ValueHelp`.
20396
- *
20397
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
20398
- * otherwise it will be bound to this `sap.ui.mdc.ValueHelp` itself.
20399
- *
20400
- * This event is fired after a suggested item has been found for a type-ahead.
20401
- *
20402
- * @since 1.120.0
20164
+ * Gets content of aggregation {@link #getTypeahead typeahead}.
20403
20165
  *
20404
- * @returns Reference to `this` in order to allow method chaining
20166
+ * Container that is used and opened in typeahead
20405
20167
  */
20406
- attachTypeaheadSuggested(
20407
- /**
20408
- * The function to be called when the event occurs
20409
- */
20410
- fnFunction: (p1: ValueHelp$TypeaheadSuggestedEvent) => void,
20411
- /**
20412
- * Context object to call the event handler with. Defaults to this `sap.ui.mdc.ValueHelp` itself
20413
- */
20414
- oListener?: object
20415
- ): this;
20168
+ getTypeahead(): /* was: sap.ui.mdc.valuehelp.ITypeaheadContainer */ any;
20416
20169
  /**
20417
- * Destroys the dialog in the aggregation {@link #getDialog dialog}.
20170
+ * Gets current value of property {@link #getValidateInput validateInput}.
20418
20171
  *
20172
+ * If this property is set, the user input of the corresponding field is validated against the value help.
20173
+ * If no entry is found for the user input, an error is shown on the field.
20419
20174
  *
20420
- * @returns Reference to `this` in order to allow method chaining
20421
- */
20422
- destroyDialog(): this;
20423
- /**
20424
- * Destroys the typeahead in the aggregation {@link #getTypeahead typeahead}.
20175
+ * If this property is not set, the user input is still checked against the value help. But if no entry
20176
+ * is found, the user input is set to the field if the used data type allows this. (A type parsing error
20177
+ * is shown if the user input adheres to the requirements of the used data type.)
20178
+ *
20179
+ * Default value is `true`.
20425
20180
  *
20426
20181
  *
20427
- * @returns Reference to `this` in order to allow method chaining
20182
+ * @returns Value of property `validateInput`
20428
20183
  */
20429
- destroyTypeahead(): this;
20184
+ getValidateInput(): boolean;
20430
20185
  /**
20431
- * Detaches event handler `fnFunction` from the {@link #event:closed closed} event of this `sap.ui.mdc.ValueHelp`.
20186
+ * Sets a new value for property {@link #getDelegate delegate}.
20432
20187
  *
20433
- * The passed function and listener object must match the ones used for event registration.
20188
+ * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
20189
+ * The object has the following properties:
20190
+ * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/ValueHelpDelegate ValueHelpDelegate }
20434
20191
  *
20192
+ * - `payload` (optional) defines application-specific information that can be used in the given delegate
20193
+ * Sample delegate object:
20194
+ * ```javascript
20195
+ * {
20196
+ * name: "sap/ui/mdc/ValueHelpDelegate",
20197
+ * payload: {}
20198
+ * }```
20199
+ * **Note:** Ensure that the related file can be requested (any required library has to be loaded before
20200
+ * that).
20201
+ * Do not bind or modify the module. This property can only be configured during control initialization.
20435
20202
  *
20436
- * @returns Reference to `this` in order to allow method chaining
20437
- */
20438
- detachClosed(
20439
- /**
20440
- * The function to be called, when the event occurs
20441
- */
20442
- fnFunction: (p1: Event) => void,
20443
- /**
20444
- * Context object on which the given function had to be called
20445
- */
20446
- oListener?: object
20447
- ): this;
20448
- /**
20449
- * Detaches event handler `fnFunction` from the {@link #event:disconnect disconnect} event of this `sap.ui.mdc.ValueHelp`.
20203
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
20450
20204
  *
20451
- * The passed function and listener object must match the ones used for event registration.
20205
+ * Default value is `...see text or source`.
20452
20206
  *
20453
20207
  *
20454
20208
  * @returns Reference to `this` in order to allow method chaining
20455
20209
  */
20456
- detachDisconnect(
20457
- /**
20458
- * The function to be called, when the event occurs
20459
- */
20460
- fnFunction: (p1: Event) => void,
20210
+ setDelegate(
20461
20211
  /**
20462
- * Context object on which the given function had to be called
20212
+ * New value for property `delegate`
20463
20213
  */
20464
- oListener?: object
20214
+ oDelegate?: object
20465
20215
  ): this;
20466
20216
  /**
20467
- * Detaches event handler `fnFunction` from the {@link #event:navigated navigated} event of this `sap.ui.mdc.ValueHelp`.
20468
- *
20469
- * The passed function and listener object must match the ones used for event registration.
20217
+ * Sets the aggregated {@link #getDialog dialog}.
20470
20218
  *
20471
20219
  *
20472
20220
  * @returns Reference to `this` in order to allow method chaining
20473
20221
  */
20474
- detachNavigated(
20475
- /**
20476
- * The function to be called, when the event occurs
20477
- */
20478
- fnFunction: (p1: ValueHelp$NavigatedEvent) => void,
20222
+ setDialog(
20479
20223
  /**
20480
- * Context object on which the given function had to be called
20224
+ * The dialog to set
20481
20225
  */
20482
- oListener?: object
20226
+ oDialog: /* was: sap.ui.mdc.valuehelp.IDialogContainer */ any
20483
20227
  ): this;
20484
20228
  /**
20485
- * Detaches event handler `fnFunction` from the {@link #event:open open} event of this `sap.ui.mdc.ValueHelp`.
20486
- *
20487
- * The passed function and listener object must match the ones used for event registration.
20229
+ * Sets the aggregated {@link #getTypeahead typeahead}.
20488
20230
  *
20489
20231
  *
20490
20232
  * @returns Reference to `this` in order to allow method chaining
20491
20233
  */
20492
- detachOpen(
20493
- /**
20494
- * The function to be called, when the event occurs
20495
- */
20496
- fnFunction: (p1: ValueHelp$OpenEvent) => void,
20234
+ setTypeahead(
20497
20235
  /**
20498
- * Context object on which the given function had to be called
20236
+ * The typeahead to set
20499
20237
  */
20500
- oListener?: object
20238
+ oTypeahead: /* was: sap.ui.mdc.valuehelp.ITypeaheadContainer */ any
20501
20239
  ): this;
20502
20240
  /**
20503
- * Detaches event handler `fnFunction` from the {@link #event:opened opened} event of this `sap.ui.mdc.ValueHelp`.
20241
+ * Sets a new value for property {@link #getValidateInput validateInput}.
20504
20242
  *
20505
- * The passed function and listener object must match the ones used for event registration.
20243
+ * If this property is set, the user input of the corresponding field is validated against the value help.
20244
+ * If no entry is found for the user input, an error is shown on the field.
20506
20245
  *
20246
+ * If this property is not set, the user input is still checked against the value help. But if no entry
20247
+ * is found, the user input is set to the field if the used data type allows this. (A type parsing error
20248
+ * is shown if the user input adheres to the requirements of the used data type.)
20507
20249
  *
20508
- * @returns Reference to `this` in order to allow method chaining
20509
- */
20510
- detachOpened(
20511
- /**
20512
- * The function to be called, when the event occurs
20513
- */
20514
- fnFunction: (p1: ValueHelp$OpenedEvent) => void,
20515
- /**
20516
- * Context object on which the given function had to be called
20517
- */
20518
- oListener?: object
20519
- ): this;
20520
- /**
20521
- * Detaches event handler `fnFunction` from the {@link #event:select select} event of this `sap.ui.mdc.ValueHelp`.
20250
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
20522
20251
  *
20523
- * The passed function and listener object must match the ones used for event registration.
20252
+ * Default value is `true`.
20524
20253
  *
20525
20254
  *
20526
20255
  * @returns Reference to `this` in order to allow method chaining
20527
20256
  */
20528
- detachSelect(
20529
- /**
20530
- * The function to be called, when the event occurs
20531
- */
20532
- fnFunction: (p1: ValueHelp$SelectEvent) => void,
20257
+ setValidateInput(
20533
20258
  /**
20534
- * Context object on which the given function had to be called
20259
+ * New value for property `validateInput`
20535
20260
  */
20536
- oListener?: object
20261
+ bValidateInput?: boolean
20537
20262
  ): this;
20263
+ }
20264
+ /**
20265
+ * Configuration object type to determine a `ValueHelpItem` for a given value.
20266
+ */
20267
+ export type ItemForValueConfiguration = {
20538
20268
  /**
20539
- * Detaches event handler `fnFunction` from the {@link #event:switchToValueHelp switchToValueHelp} event
20540
- * of this `sap.ui.mdc.ValueHelp`.
20541
- *
20542
- * The passed function and listener object must match the ones used for event registration.
20543
- *
20544
- *
20545
- * @returns Reference to `this` in order to allow method chaining
20269
+ * Value as entered by user
20546
20270
  */
20547
- detachSwitchToValueHelp(
20548
- /**
20549
- * The function to be called, when the event occurs
20550
- */
20551
- fnFunction: (p1: Event) => void,
20552
- /**
20553
- * Context object on which the given function had to be called
20554
- */
20555
- oListener?: object
20556
- ): this;
20271
+ value: any;
20557
20272
  /**
20558
- * Detaches event handler `fnFunction` from the {@link #event:typeaheadSuggested typeaheadSuggested} event
20559
- * of this `sap.ui.mdc.ValueHelp`.
20560
- *
20561
- * The passed function and listener object must match the ones used for event registration.
20562
- *
20563
- * @since 1.120.0
20564
- *
20565
- * @returns Reference to `this` in order to allow method chaining
20273
+ * Value parsed by type of key to match the data type of the key
20274
+ */
20275
+ parsedValue?: any;
20276
+ /**
20277
+ * Value parsed by type of description to match the data type of the description
20278
+ */
20279
+ parsedDescription?: any;
20280
+ /**
20281
+ * Contextual information provided by condition `payload` or `inParameters`/`outParameters`. This is only
20282
+ * filled if the description needs to be determined for an existing condition.
20566
20283
  */
20567
- detachTypeaheadSuggested(
20284
+ context?: {
20568
20285
  /**
20569
- * The function to be called, when the event occurs
20286
+ * In parameters of the current condition (`inParameters` are not used any longer, but it might be filled
20287
+ * in older conditions stored in variants.)
20570
20288
  */
20571
- fnFunction: (p1: ValueHelp$TypeaheadSuggestedEvent) => void,
20289
+ inParameter?: object;
20572
20290
  /**
20573
- * Context object on which the given function had to be called
20291
+ * Out parameters of the current condition (`outParameters` are not used any longer, but it might be filled
20292
+ * in older conditions stored in variants.)
20574
20293
  */
20575
- oListener?: object
20576
- ): this;
20577
- /**
20578
- * Fires event {@link #event:closed closed} to attached listeners.
20579
- *
20580
- * @ui5-protected Do not call from applications (only from related classes in the framework)
20581
- *
20582
- * @returns Reference to `this` in order to allow method chaining
20583
- */
20584
- fireClosed(
20294
+ ouParameter?: object;
20585
20295
  /**
20586
- * Parameters to pass along with the event
20296
+ * Payload of the current condition
20587
20297
  */
20588
- mParameters?: object
20589
- ): this;
20298
+ payload?: object;
20299
+ };
20590
20300
  /**
20591
- * Fires event {@link #event:disconnect disconnect} to attached listeners.
20592
- *
20593
- * @ui5-protected Do not call from applications (only from related classes in the framework)
20594
- *
20595
- * @returns Reference to `this` in order to allow method chaining
20301
+ * `BindingContext` of the checked field. Inside a table, the `ValueHelp` element might be connected to
20302
+ * a different row.
20596
20303
  */
20597
- fireDisconnect(
20598
- /**
20599
- * Parameters to pass along with the event
20600
- */
20601
- mParameters?: object
20602
- ): this;
20304
+ bindingContext?: Context;
20603
20305
  /**
20604
- * Fires event {@link #event:navigated navigated} to attached listeners.
20605
- *
20606
- * @ui5-protected Do not call from applications (only from related classes in the framework)
20607
- *
20608
- * @returns Reference to `this` in order to allow method chaining
20306
+ * If set, the value help checks only if there is an item with the given key. This is set to `false` if
20307
+ * the value cannot be a valid key because of type validation.
20609
20308
  */
20610
- fireNavigated(
20611
- /**
20612
- * Parameters to pass along with the event
20613
- */
20614
- mParameters?: ValueHelp$NavigatedEventParameters
20615
- ): this;
20309
+ checkKey: boolean;
20616
20310
  /**
20617
- * Fires event {@link #event:open open} to attached listeners.
20618
- *
20619
- * @ui5-protected Do not call from applications (only from related classes in the framework)
20620
- *
20621
- * @returns Reference to `this` in order to allow method chaining
20311
+ * If set, the value help checks only if there is an item with the given description. This is set to `false`
20312
+ * if only the key is used in the field.
20622
20313
  */
20623
- fireOpen(
20624
- /**
20625
- * Parameters to pass along with the event
20626
- */
20627
- mParameters?: ValueHelp$OpenEventParameters
20628
- ): this;
20629
- /**
20630
- * Fires event {@link #event:opened opened} to attached listeners.
20631
- *
20632
- * @ui5-protected Do not call from applications (only from related classes in the framework)
20633
- *
20634
- * @returns Reference to `this` in order to allow method chaining
20635
- */
20636
- fireOpened(
20637
- /**
20638
- * Parameters to pass along with the event
20639
- */
20640
- mParameters?: ValueHelp$OpenedEventParameters
20641
- ): this;
20642
- /**
20643
- * Fires event {@link #event:select select} to attached listeners.
20644
- *
20645
- * @ui5-protected Do not call from applications (only from related classes in the framework)
20646
- *
20647
- * @returns Reference to `this` in order to allow method chaining
20648
- */
20649
- fireSelect(
20650
- /**
20651
- * Parameters to pass along with the event
20652
- */
20653
- mParameters?: ValueHelp$SelectEventParameters
20654
- ): this;
20314
+ checkDescription: boolean;
20655
20315
  /**
20656
- * Fires event {@link #event:switchToValueHelp switchToValueHelp} to attached listeners.
20657
- *
20658
- * @ui5-protected Do not call from applications (only from related classes in the framework)
20659
- *
20660
- * @returns Reference to `this` in order to allow method chaining
20316
+ * If set, the check is done case-sensitively
20661
20317
  */
20662
- fireSwitchToValueHelp(
20663
- /**
20664
- * Parameters to pass along with the event
20665
- */
20666
- mParameters?: object
20667
- ): this;
20318
+ caseSensitive?: boolean;
20668
20319
  /**
20669
- * Fires event {@link #event:typeaheadSuggested typeaheadSuggested} to attached listeners.
20670
- *
20671
- * @since 1.120.0
20672
- * @ui5-protected Do not call from applications (only from related classes in the framework)
20673
- *
20674
- * @returns Reference to `this` in order to allow method chaining
20320
+ * If set, only exact matches are requested and no suggestions
20675
20321
  */
20676
- fireTypeaheadSuggested(
20677
- /**
20678
- * Parameters to pass along with the event
20679
- */
20680
- mParameters?: ValueHelp$TypeaheadSuggestedEventParameters
20681
- ): this;
20322
+ exactMatch?: boolean;
20682
20323
  /**
20683
- * Gets current value of property {@link #getConditions conditions}.
20684
- *
20685
- * The conditions of the selected items.
20686
- *
20687
- * **Note:** This property must only be set by the control the `ValueHelp` element belongs to, not by the
20688
- * application.
20689
- *
20690
- * **Note:** A condition must have the structure of {@link sap.ui.mdc.condition.ConditionObject ConditionObject}.
20691
- *
20692
- * Default value is `[]`.
20693
- *
20694
- *
20695
- * @returns Value of property `conditions`
20324
+ * Instance of the calling control
20696
20325
  */
20697
- getConditions(): object[];
20326
+ control: Control;
20327
+ };
20328
+
20329
+ /**
20330
+ * Describes the settings that can be provided to the ValueHelp constructor.
20331
+ */
20332
+ export interface $ValueHelpSettings extends $ElementSettings {
20698
20333
  /**
20699
- * Gets current value of property {@link #getDelegate delegate}.
20700
- *
20701
20334
  * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
20702
20335
  * The object has the following properties:
20703
20336
  * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/ValueHelpDelegate ValueHelpDelegate }
@@ -20712,363 +20345,47 @@ declare module "sap/ui/mdc/ValueHelp" {
20712
20345
  * **Note:** Ensure that the related file can be requested (any required library has to be loaded before
20713
20346
  * that).
20714
20347
  * Do not bind or modify the module. This property can only be configured during control initialization.
20715
- *
20716
- * Default value is `...see text or source`.
20717
- *
20718
- *
20719
- * @returns Value of property `delegate`
20720
- */
20721
- getDelegate(): object;
20722
- /**
20723
- * Gets content of aggregation {@link #getDialog dialog}.
20724
- *
20725
- * Container that is used and opened if the value help icon of the input field is pressed.
20726
- */
20727
- getDialog(): /* was: sap.ui.mdc.valuehelp.IDialogContainer */ any;
20728
- /**
20729
- * Gets current value of property {@link #getFilterValue filterValue}.
20730
- *
20731
- * The value by which the help is filtered. Here the field provides the typed value to allow the value help
20732
- * to filter for it.
20733
- *
20734
- * **Note:** This only takes effect if the `ValueHelp` elements content supports filtering.
20735
- *
20736
- * **Note:** This property must only be set by the control the `ValueHelp` element belongs to, not by the
20737
- * application.
20738
- *
20739
- * Default value is `empty string`.
20740
- *
20741
- *
20742
- * @returns Value of property `filterValue`
20743
- */
20744
- getFilterValue(): string;
20745
- /**
20746
- * Gets content of aggregation {@link #getTypeahead typeahead}.
20747
- *
20748
- * Container that is used and opened in typeahead
20749
20348
  */
20750
- getTypeahead(): /* was: sap.ui.mdc.valuehelp.ITypeaheadContainer */ any;
20349
+ delegate?: object | PropertyBindingInfo | `{${string}}`;
20350
+
20751
20351
  /**
20752
- * Gets current value of property {@link #getValidateInput validateInput}.
20753
- *
20754
20352
  * If this property is set, the user input of the corresponding field is validated against the value help.
20755
20353
  * If no entry is found for the user input, an error is shown on the field.
20756
20354
  *
20757
20355
  * If this property is not set, the user input is still checked against the value help. But if no entry
20758
20356
  * is found, the user input is set to the field if the used data type allows this. (A type parsing error
20759
20357
  * is shown if the user input adheres to the requirements of the used data type.)
20760
- *
20761
- * Default value is `true`.
20762
- *
20763
- *
20764
- * @returns Value of property `validateInput`
20765
- */
20766
- getValidateInput(): boolean;
20767
- /**
20768
- * Sets a new value for property {@link #getConditions conditions}.
20769
- *
20770
- * The conditions of the selected items.
20771
- *
20772
- * **Note:** This property must only be set by the control the `ValueHelp` element belongs to, not by the
20773
- * application.
20774
- *
20775
- * **Note:** A condition must have the structure of {@link sap.ui.mdc.condition.ConditionObject ConditionObject}.
20776
- *
20777
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
20778
- *
20779
- * Default value is `[]`.
20780
- *
20781
- *
20782
- * @returns Reference to `this` in order to allow method chaining
20783
20358
  */
20784
- setConditions(
20785
- /**
20786
- * New value for property `conditions`
20787
- */
20788
- sConditions?: object[]
20789
- ): this;
20359
+ validateInput?: boolean | PropertyBindingInfo | `{${string}}`;
20360
+
20790
20361
  /**
20791
- * Sets a new value for property {@link #getDelegate delegate}.
20792
- *
20793
- * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
20794
- * The object has the following properties:
20795
- * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/ValueHelpDelegate ValueHelpDelegate }
20796
- *
20797
- * - `payload` (optional) defines application-specific information that can be used in the given delegate
20798
- * Sample delegate object:
20799
- * ```javascript
20800
- * {
20801
- * name: "sap/ui/mdc/ValueHelpDelegate",
20802
- * payload: {}
20803
- * }```
20804
- * **Note:** Ensure that the related file can be requested (any required library has to be loaded before
20805
- * that).
20806
- * Do not bind or modify the module. This property can only be configured during control initialization.
20807
- *
20808
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
20809
- *
20810
- * Default value is `...see text or source`.
20811
- *
20812
- *
20813
- * @returns Reference to `this` in order to allow method chaining
20362
+ * Container that is used and opened if the value help icon of the input field is pressed.
20814
20363
  */
20815
- setDelegate(
20816
- /**
20817
- * New value for property `delegate`
20818
- */
20819
- oDelegate?: object
20820
- ): this;
20364
+ dialog?: /* was: sap.ui.mdc.valuehelp.IDialogContainer */ any;
20365
+
20821
20366
  /**
20822
- * Sets the aggregated {@link #getDialog dialog}.
20823
- *
20824
- *
20825
- * @returns Reference to `this` in order to allow method chaining
20367
+ * Container that is used and opened in typeahead
20826
20368
  */
20827
- setDialog(
20828
- /**
20829
- * The dialog to set
20830
- */
20831
- oDialog: /* was: sap.ui.mdc.valuehelp.IDialogContainer */ any
20832
- ): this;
20369
+ typeahead?: /* was: sap.ui.mdc.valuehelp.ITypeaheadContainer */ any;
20370
+
20833
20371
  /**
20834
- * Sets a new value for property {@link #getFilterValue filterValue}.
20835
- *
20836
- * The value by which the help is filtered. Here the field provides the typed value to allow the value help
20837
- * to filter for it.
20838
- *
20839
- * **Note:** This only takes effect if the `ValueHelp` elements content supports filtering.
20840
- *
20841
- * **Note:** This property must only be set by the control the `ValueHelp` element belongs to, not by the
20842
- * application.
20843
- *
20844
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
20845
- *
20846
- * Default value is `empty string`.
20847
- *
20848
- *
20849
- * @returns Reference to `this` in order to allow method chaining
20372
+ * This event is fired after the value help has been closed.
20850
20373
  */
20851
- setFilterValue(
20852
- /**
20853
- * New value for property `filterValue`
20854
- */
20855
- sFilterValue?: string
20856
- ): this;
20374
+ closed?: (oEvent: Event) => void;
20375
+
20857
20376
  /**
20858
- * Sets the aggregated {@link #getTypeahead typeahead}.
20859
- *
20860
- *
20861
- * @returns Reference to `this` in order to allow method chaining
20377
+ * This event is fired as the value help opening is triggered.
20862
20378
  */
20863
- setTypeahead(
20864
- /**
20865
- * The typeahead to set
20866
- */
20867
- oTypeahead: /* was: sap.ui.mdc.valuehelp.ITypeaheadContainer */ any
20868
- ): this;
20379
+ open?: (oEvent: ValueHelp$OpenEvent) => void;
20380
+
20869
20381
  /**
20870
- * Sets a new value for property {@link #getValidateInput validateInput}.
20871
- *
20872
- * If this property is set, the user input of the corresponding field is validated against the value help.
20873
- * If no entry is found for the user input, an error is shown on the field.
20874
- *
20875
- * If this property is not set, the user input is still checked against the value help. But if no entry
20876
- * is found, the user input is set to the field if the used data type allows this. (A type parsing error
20877
- * is shown if the user input adheres to the requirements of the used data type.)
20878
- *
20879
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
20880
- *
20881
- * Default value is `true`.
20882
- *
20883
- *
20884
- * @returns Reference to `this` in order to allow method chaining
20382
+ * This event is fired as the value help is fully open.
20885
20383
  */
20886
- setValidateInput(
20887
- /**
20888
- * New value for property `validateInput`
20889
- */
20890
- bValidateInput?: boolean
20891
- ): this;
20384
+ opened?: (oEvent: ValueHelp$OpenedEvent) => void;
20892
20385
  }
20386
+
20893
20387
  /**
20894
- * Configuration object type to determine a `ValueHelpItem` for a given value.
20895
- */
20896
- export type ItemForValueConfiguration = {
20897
- /**
20898
- * Value as entered by user
20899
- */
20900
- value: any;
20901
- /**
20902
- * Value parsed by type of key to match the data type of the key
20903
- */
20904
- parsedValue?: any;
20905
- /**
20906
- * Value parsed by type of description to match the data type of the description
20907
- */
20908
- parsedDescription?: any;
20909
- /**
20910
- * Contextual information provided by condition `payload` or `inParameters`/`outParameters`. This is only
20911
- * filled if the description needs to be determined for an existing condition.
20912
- */
20913
- context?: {
20914
- /**
20915
- * In parameters of the current condition (`inParameters` are not used any longer, but it might be filled
20916
- * in older conditions stored in variants.)
20917
- */
20918
- inParameter?: object;
20919
- /**
20920
- * Out parameters of the current condition (`outParameters` are not used any longer, but it might be filled
20921
- * in older conditions stored in variants.)
20922
- */
20923
- ouParameter?: object;
20924
- /**
20925
- * Payload of the current condition
20926
- */
20927
- payload?: object;
20928
- };
20929
- /**
20930
- * `BindingContext` of the checked field. Inside a table, the `ValueHelp` element might be connected to
20931
- * a different row.
20932
- */
20933
- bindingContext?: Context;
20934
- /**
20935
- * If set, the value help checks only if there is an item with the given key. This is set to `false` if
20936
- * the value cannot be a valid key because of type validation.
20937
- */
20938
- checkKey: boolean;
20939
- /**
20940
- * If set, the value help checks only if there is an item with the given description. This is set to `false`
20941
- * if only the key is used in the field.
20942
- */
20943
- checkDescription: boolean;
20944
- /**
20945
- * If set, the check is done case-sensitively
20946
- */
20947
- caseSensitive?: boolean;
20948
- /**
20949
- * If set, only exact matches are requested and no suggestions
20950
- */
20951
- exactMatch?: boolean;
20952
- /**
20953
- * Instance of the calling control
20954
- */
20955
- control: Control;
20956
- };
20957
-
20958
- /**
20959
- * Describes the settings that can be provided to the ValueHelp constructor.
20960
- */
20961
- export interface $ValueHelpSettings extends $ElementSettings {
20962
- /**
20963
- * The conditions of the selected items.
20964
- *
20965
- * **Note:** This property must only be set by the control the `ValueHelp` element belongs to, not by the
20966
- * application.
20967
- *
20968
- * **Note:** A condition must have the structure of {@link sap.ui.mdc.condition.ConditionObject ConditionObject}.
20969
- */
20970
- conditions?: object[] | PropertyBindingInfo | `{${string}}`;
20971
-
20972
- /**
20973
- * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
20974
- * The object has the following properties:
20975
- * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/ValueHelpDelegate ValueHelpDelegate }
20976
- *
20977
- * - `payload` (optional) defines application-specific information that can be used in the given delegate
20978
- * Sample delegate object:
20979
- * ```javascript
20980
- * {
20981
- * name: "sap/ui/mdc/ValueHelpDelegate",
20982
- * payload: {}
20983
- * }```
20984
- * **Note:** Ensure that the related file can be requested (any required library has to be loaded before
20985
- * that).
20986
- * Do not bind or modify the module. This property can only be configured during control initialization.
20987
- */
20988
- delegate?: object | PropertyBindingInfo | `{${string}}`;
20989
-
20990
- /**
20991
- * The value by which the help is filtered. Here the field provides the typed value to allow the value help
20992
- * to filter for it.
20993
- *
20994
- * **Note:** This only takes effect if the `ValueHelp` elements content supports filtering.
20995
- *
20996
- * **Note:** This property must only be set by the control the `ValueHelp` element belongs to, not by the
20997
- * application.
20998
- */
20999
- filterValue?: string | PropertyBindingInfo;
21000
-
21001
- /**
21002
- * If this property is set, the user input of the corresponding field is validated against the value help.
21003
- * If no entry is found for the user input, an error is shown on the field.
21004
- *
21005
- * If this property is not set, the user input is still checked against the value help. But if no entry
21006
- * is found, the user input is set to the field if the used data type allows this. (A type parsing error
21007
- * is shown if the user input adheres to the requirements of the used data type.)
21008
- */
21009
- validateInput?: boolean | PropertyBindingInfo | `{${string}}`;
21010
-
21011
- /**
21012
- * Container that is used and opened if the value help icon of the input field is pressed.
21013
- */
21014
- dialog?: /* was: sap.ui.mdc.valuehelp.IDialogContainer */ any;
21015
-
21016
- /**
21017
- * Container that is used and opened in typeahead
21018
- */
21019
- typeahead?: /* was: sap.ui.mdc.valuehelp.ITypeaheadContainer */ any;
21020
-
21021
- /**
21022
- * This event is fired when a value is selected in the value help.
21023
- *
21024
- * **Note:** This event must only be handled by the control the `ValueHelp` element belongs to, not by the
21025
- * application.
21026
- */
21027
- select?: (oEvent: ValueHelp$SelectEvent) => void;
21028
-
21029
- /**
21030
- * This event is fired when the `ValueHelp` element is disconnected from a control.
21031
- *
21032
- * **Note:** This event must only be handled by the control the `ValueHelp` element belongs to, not by the
21033
- * application.
21034
- */
21035
- disconnect?: (oEvent: Event) => void;
21036
-
21037
- /**
21038
- * This event is fired after the value help has been closed.
21039
- */
21040
- closed?: (oEvent: Event) => void;
21041
-
21042
- /**
21043
- * This event is fired as the value help opening is triggered.
21044
- */
21045
- open?: (oEvent: ValueHelp$OpenEvent) => void;
21046
-
21047
- /**
21048
- * This event is fired as the value help is fully open.
21049
- */
21050
- opened?: (oEvent: ValueHelp$OpenedEvent) => void;
21051
-
21052
- /**
21053
- * This event is fired after the user navigated, using the arrow keys, in the value help.
21054
- */
21055
- navigated?: (oEvent: ValueHelp$NavigatedEvent) => void;
21056
-
21057
- /**
21058
- * This event is fired if the user wants to switch from typeahead to value help.
21059
- */
21060
- switchToValueHelp?: (oEvent: Event) => void;
21061
-
21062
- /**
21063
- * This event is fired after a suggested item has been found for a type-ahead.
21064
- *
21065
- * @since 1.120.0
21066
- */
21067
- typeaheadSuggested?: (oEvent: ValueHelp$TypeaheadSuggestedEvent) => void;
21068
- }
21069
-
21070
- /**
21071
- * Parameters of the ValueHelp#closed event.
20388
+ * Parameters of the ValueHelp#closed event.
21072
20389
  */
21073
20390
  export interface ValueHelp$ClosedEventParameters {}
21074
20391
 
@@ -21249,14 +20566,14 @@ declare module "sap/ui/mdc/valuehelp/base/Container" {
21249
20566
 
21250
20567
  import Content from "sap/ui/mdc/valuehelp/base/Content";
21251
20568
 
21252
- import Event from "sap/ui/base/Event";
21253
-
21254
20569
  import Control from "sap/ui/core/Control";
21255
20570
 
21256
20571
  import ElementMetadata from "sap/ui/core/ElementMetadata";
21257
20572
 
21258
20573
  import UIArea from "sap/ui/core/UIArea";
21259
20574
 
20575
+ import Event from "sap/ui/base/Event";
20576
+
21260
20577
  import {
21261
20578
  PropertyBindingInfo,
21262
20579
  AggregationBindingInfo,
@@ -21347,1985 +20664,659 @@ declare module "sap/ui/mdc/valuehelp/base/Container" {
21347
20664
  oContent: Content
21348
20665
  ): this;
21349
20666
  /**
21350
- * Attaches event handler `fnFunction` to the {@link #event:cancel cancel} event of this `sap.ui.mdc.valuehelp.base.Container`.
21351
- *
21352
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
21353
- * otherwise it will be bound to this `sap.ui.mdc.valuehelp.base.Container` itself.
21354
- *
21355
- * This event is fired if the change is cancelled.
21356
- *
20667
+ * Binds the content to the container.
21357
20668
  *
21358
- * @returns Reference to `this` in order to allow method chaining
20669
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
21359
20670
  */
21360
- attachCancel(
21361
- /**
21362
- * An application-specific payload object that will be passed to the event handler along with the event
21363
- * object when firing the event
21364
- */
21365
- oData: object,
21366
- /**
21367
- * The function to be called when the event occurs
21368
- */
21369
- fnFunction: (p1: Event) => void,
20671
+ bindContentToContainer(
21370
20672
  /**
21371
- * Context object to call the event handler with. Defaults to this `sap.ui.mdc.valuehelp.base.Container`
21372
- * itself
20673
+ * content
21373
20674
  */
21374
- oListener?: object
21375
- ): this;
20675
+ oContent: Content
20676
+ ): void;
21376
20677
  /**
21377
- * Attaches event handler `fnFunction` to the {@link #event:cancel cancel} event of this `sap.ui.mdc.valuehelp.base.Container`.
21378
- *
21379
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
21380
- * otherwise it will be bound to this `sap.ui.mdc.valuehelp.base.Container` itself.
20678
+ * Closes the container control or element.
21381
20679
  *
21382
- * This event is fired if the change is cancelled.
20680
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
20681
+ */
20682
+ closeContainer(): void;
20683
+ /**
20684
+ * Destroys all the content in the aggregation {@link #getContent content}.
21383
20685
  *
21384
20686
  *
21385
20687
  * @returns Reference to `this` in order to allow method chaining
21386
20688
  */
21387
- attachCancel(
21388
- /**
21389
- * The function to be called when the event occurs
21390
- */
21391
- fnFunction: (p1: Event) => void,
21392
- /**
21393
- * Context object to call the event handler with. Defaults to this `sap.ui.mdc.valuehelp.base.Container`
21394
- * itself
21395
- */
21396
- oListener?: object
21397
- ): this;
20689
+ destroyContent(): this;
21398
20690
  /**
21399
- * Attaches event handler `fnFunction` to the {@link #event:closed closed} event of this `sap.ui.mdc.valuehelp.base.Container`.
21400
- *
21401
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
21402
- * otherwise it will be bound to this `sap.ui.mdc.valuehelp.base.Container` itself.
21403
- *
21404
- * This event is fired if the value help is closed.
20691
+ * Gets the configuration for a specific content.
21405
20692
  *
20693
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
21406
20694
  *
21407
- * @returns Reference to `this` in order to allow method chaining
20695
+ * @returns configuration
21408
20696
  */
21409
- attachClosed(
21410
- /**
21411
- * An application-specific payload object that will be passed to the event handler along with the event
21412
- * object when firing the event
21413
- */
21414
- oData: object,
21415
- /**
21416
- * The function to be called when the event occurs
21417
- */
21418
- fnFunction: (p1: Event) => void,
20697
+ getContainerConfig(
21419
20698
  /**
21420
- * Context object to call the event handler with. Defaults to this `sap.ui.mdc.valuehelp.base.Container`
21421
- * itself
20699
+ * content
21422
20700
  */
21423
- oListener?: object
21424
- ): this;
20701
+ oContent: Content
20702
+ ): object;
21425
20703
  /**
21426
- * Attaches event handler `fnFunction` to the {@link #event:closed closed} event of this `sap.ui.mdc.valuehelp.base.Container`.
21427
- *
21428
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
21429
- * otherwise it will be bound to this `sap.ui.mdc.valuehelp.base.Container` itself.
21430
- *
21431
- * This event is fired if the value help is closed.
20704
+ * Returns the container control or element that is opened (for example, a popover or dialog).
21432
20705
  *
20706
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
20707
+ */
20708
+ getContainerControl(): void;
20709
+ /**
20710
+ * Gets content of aggregation {@link #getContent content}.
21433
20711
  *
21434
- * @returns Reference to `this` in order to allow method chaining
20712
+ * Content of the container. This aggregation holds the actual controls enabling the user to select items
20713
+ * or create conditions (for example, tables or condition panels).
21435
20714
  */
21436
- attachClosed(
21437
- /**
21438
- * The function to be called when the event occurs
21439
- */
21440
- fnFunction: (p1: Event) => void,
21441
- /**
21442
- * Context object to call the event handler with. Defaults to this `sap.ui.mdc.valuehelp.base.Container`
21443
- * itself
21444
- */
21445
- oListener?: object
21446
- ): this;
20715
+ getContent(): Content[];
21447
20716
  /**
21448
- * Attaches event handler `fnFunction` to the {@link #event:confirm confirm} event of this `sap.ui.mdc.valuehelp.base.Container`.
20717
+ * Returns control connected to value help.
21449
20718
  *
21450
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
21451
- * otherwise it will be bound to this `sap.ui.mdc.valuehelp.base.Container` itself.
20719
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
21452
20720
  *
21453
- * This event is fired if a change of the value help is confirmed.
20721
+ * @returns connected control
20722
+ */
20723
+ getControl(): Control;
20724
+ /**
20725
+ * Returns the maximum allowed number of conditions, -1 if no limit is set.
21454
20726
  *
20727
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
21455
20728
  *
21456
- * @returns Reference to `this` in order to allow method chaining
20729
+ * @returns maximum allowed number of conditions
21457
20730
  */
21458
- attachConfirm(
21459
- /**
21460
- * An application-specific payload object that will be passed to the event handler along with the event
21461
- * object when firing the event
21462
- */
21463
- oData: object,
21464
- /**
21465
- * The function to be called when the event occurs
21466
- */
21467
- fnFunction: (p1: Container$ConfirmEvent) => void,
21468
- /**
21469
- * Context object to call the event handler with. Defaults to this `sap.ui.mdc.valuehelp.base.Container`
21470
- * itself
21471
- */
21472
- oListener?: object
21473
- ): this;
20731
+ getMaxConditions(): int;
21474
20732
  /**
21475
- * Attaches event handler `fnFunction` to the {@link #event:confirm confirm} event of this `sap.ui.mdc.valuehelp.base.Container`.
20733
+ * Returns the `Promise` for content creation.
21476
20734
  *
21477
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
21478
- * otherwise it will be bound to this `sap.ui.mdc.valuehelp.base.Container` itself.
20735
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
21479
20736
  *
21480
- * This event is fired if a change of the value help is confirmed.
20737
+ * @returns `Promise` for delegate content
20738
+ */
20739
+ getRetrieveDelegateContentPromise(): Promise<any>;
20740
+ /**
20741
+ * Returns the currently used content.
21481
20742
  *
20743
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
21482
20744
  *
21483
- * @returns Reference to `this` in order to allow method chaining
20745
+ * @returns currently used content
21484
20746
  */
21485
- attachConfirm(
21486
- /**
21487
- * The function to be called when the event occurs
21488
- */
21489
- fnFunction: (p1: Container$ConfirmEvent) => void,
21490
- /**
21491
- * Context object to call the event handler with. Defaults to this `sap.ui.mdc.valuehelp.base.Container`
21492
- * itself
21493
- */
21494
- oListener?: object
21495
- ): this;
20747
+ getSelectedContent(): Content;
21496
20748
  /**
21497
- * Attaches event handler `fnFunction` to the {@link #event:navigated navigated} event of this `sap.ui.mdc.valuehelp.base.Container`.
20749
+ * Gets current value of property {@link #getTitle title}.
21498
20750
  *
21499
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
21500
- * otherwise it will be bound to this `sap.ui.mdc.valuehelp.base.Container` itself.
20751
+ * Title text that appears in the dialog or tab header.
21501
20752
  *
21502
- * This event is fired if a navigation has been executed in the content of the container.
20753
+ * Default value is `empty string`.
21503
20754
  *
21504
20755
  *
21505
- * @returns Reference to `this` in order to allow method chaining
20756
+ * @returns Value of property `title`
21506
20757
  */
21507
- attachNavigated(
21508
- /**
21509
- * An application-specific payload object that will be passed to the event handler along with the event
21510
- * object when firing the event
21511
- */
21512
- oData: object,
21513
- /**
21514
- * The function to be called when the event occurs
21515
- */
21516
- fnFunction: (p1: Container$NavigatedEvent) => void,
21517
- /**
21518
- * Context object to call the event handler with. Defaults to this `sap.ui.mdc.valuehelp.base.Container`
21519
- * itself
21520
- */
21521
- oListener?: object
21522
- ): this;
20758
+ getTitle(): string;
21523
20759
  /**
21524
- * Attaches event handler `fnFunction` to the {@link #event:navigated navigated} event of this `sap.ui.mdc.valuehelp.base.Container`.
20760
+ * Returns the `UIArea` of the content.
21525
20761
  *
21526
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
21527
- * otherwise it will be bound to this `sap.ui.mdc.valuehelp.base.Container` itself.
20762
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
21528
20763
  *
21529
- * This event is fired if a navigation has been executed in the content of the container.
20764
+ * @returns The UI area of the content or `null`
20765
+ */
20766
+ getUIAreaForContent(): UIArea | null;
20767
+ /**
20768
+ * Handles the `cancelled` event of the content.
21530
20769
  *
20770
+ * Here the {@link #event:cancel cancel} event needs to be fired.
21531
20771
  *
21532
- * @returns Reference to `this` in order to allow method chaining
20772
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
21533
20773
  */
21534
- attachNavigated(
20774
+ handleCanceled(
21535
20775
  /**
21536
- * The function to be called when the event occurs
20776
+ * event
21537
20777
  */
21538
- fnFunction: (p1: Container$NavigatedEvent) => void,
20778
+ oEvent: Event
20779
+ ): void;
20780
+ /**
20781
+ * Handles the `closed` event of the container control or element.
20782
+ *
20783
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
20784
+ */
20785
+ handleClosed(
21539
20786
  /**
21540
- * Context object to call the event handler with. Defaults to this `sap.ui.mdc.valuehelp.base.Container`
21541
- * itself
20787
+ * event
21542
20788
  */
21543
- oListener?: object
21544
- ): this;
20789
+ oEvent: Event
20790
+ ): void;
21545
20791
  /**
21546
- * Attaches event handler `fnFunction` to the {@link #event:opened opened} event of this `sap.ui.mdc.valuehelp.base.Container`.
21547
- *
21548
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
21549
- * otherwise it will be bound to this `sap.ui.mdc.valuehelp.base.Container` itself.
21550
- *
21551
- * This event is fired if the value help is opened.
20792
+ * Handles the `confirmed` event of the content.
21552
20793
  *
20794
+ * Here the {@link #event:confirm confirm} event needs to be fired.
21553
20795
  *
21554
- * @returns Reference to `this` in order to allow method chaining
20796
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
21555
20797
  */
21556
- attachOpened(
21557
- /**
21558
- * An application-specific payload object that will be passed to the event handler along with the event
21559
- * object when firing the event
21560
- */
21561
- oData: object,
20798
+ handleConfirmed(
21562
20799
  /**
21563
- * The function to be called when the event occurs
20800
+ * event
21564
20801
  */
21565
- fnFunction: (p1: Container$OpenedEvent) => void,
20802
+ oEvent: Event
20803
+ ): void;
20804
+ /**
20805
+ * Handles the `navigated` event of the content.
20806
+ *
20807
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
20808
+ */
20809
+ handleNavigated(
21566
20810
  /**
21567
- * Context object to call the event handler with. Defaults to this `sap.ui.mdc.valuehelp.base.Container`
21568
- * itself
20811
+ * event
21569
20812
  */
21570
- oListener?: object
21571
- ): this;
20813
+ oEvent: Event
20814
+ ): void;
21572
20815
  /**
21573
- * Attaches event handler `fnFunction` to the {@link #event:opened opened} event of this `sap.ui.mdc.valuehelp.base.Container`.
21574
- *
21575
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
21576
- * otherwise it will be bound to this `sap.ui.mdc.valuehelp.base.Container` itself.
21577
- *
21578
- * This event is fired if the value help is opened.
21579
- *
20816
+ * Handles the `opened` event of the container control or element.
21580
20817
  *
21581
- * @returns Reference to `this` in order to allow method chaining
20818
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
21582
20819
  */
21583
- attachOpened(
20820
+ handleOpened(
21584
20821
  /**
21585
- * The function to be called when the event occurs
20822
+ * event
21586
20823
  */
21587
- fnFunction: (p1: Container$OpenedEvent) => void,
20824
+ oEvent: Event
20825
+ ): void;
20826
+ /**
20827
+ * Handles the `requestSwitchToDialog` event of the content.
20828
+ *
20829
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
20830
+ */
20831
+ handleRequestSwitchToDialog(
21588
20832
  /**
21589
- * Context object to call the event handler with. Defaults to this `sap.ui.mdc.valuehelp.base.Container`
21590
- * itself
20833
+ * event
21591
20834
  */
21592
- oListener?: object
21593
- ): this;
20835
+ oEvent: Event
20836
+ ): void;
21594
20837
  /**
21595
- * Attaches event handler `fnFunction` to the {@link #event:requestDelegateContent requestDelegateContent }
21596
- * event of this `sap.ui.mdc.valuehelp.base.Container`.
21597
- *
21598
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
21599
- * otherwise it will be bound to this `sap.ui.mdc.valuehelp.base.Container` itself.
21600
- *
21601
- * This event is fired if the container requests the delegate content.
20838
+ * Handles the `select` event of the content.
21602
20839
  *
20840
+ * Here the {@link #event:select select} event needs to be fired.
21603
20841
  *
21604
- * @returns Reference to `this` in order to allow method chaining
20842
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
21605
20843
  */
21606
- attachRequestDelegateContent(
21607
- /**
21608
- * An application-specific payload object that will be passed to the event handler along with the event
21609
- * object when firing the event
21610
- */
21611
- oData: object,
20844
+ handleSelect(
21612
20845
  /**
21613
- * The function to be called when the event occurs
20846
+ * event
21614
20847
  */
21615
- fnFunction: (p1: Container$RequestDelegateContentEvent) => void,
20848
+ oEvent: Event
20849
+ ): void;
20850
+ /**
20851
+ * Handles the `typeaheadSuggested` event of the content.
20852
+ *
20853
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
20854
+ */
20855
+ handleTypeaheadSuggested(
21616
20856
  /**
21617
- * Context object to call the event handler with. Defaults to this `sap.ui.mdc.valuehelp.base.Container`
21618
- * itself
20857
+ * event
21619
20858
  */
21620
- oListener?: object
21621
- ): this;
20859
+ oEvent: Event
20860
+ ): void;
21622
20861
  /**
21623
- * Attaches event handler `fnFunction` to the {@link #event:requestDelegateContent requestDelegateContent }
21624
- * event of this `sap.ui.mdc.valuehelp.base.Container`.
21625
- *
21626
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
21627
- * otherwise it will be bound to this `sap.ui.mdc.valuehelp.base.Container` itself.
21628
- *
21629
- * This event is fired if the container requests the delegate content.
20862
+ * Checks for the provided `sap.ui.mdc.valuehelp.base.Content` in the aggregation {@link #getContent content}.
20863
+ * and returns its index if found or -1 otherwise.
21630
20864
  *
21631
20865
  *
21632
- * @returns Reference to `this` in order to allow method chaining
20866
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
21633
20867
  */
21634
- attachRequestDelegateContent(
21635
- /**
21636
- * The function to be called when the event occurs
21637
- */
21638
- fnFunction: (p1: Container$RequestDelegateContentEvent) => void,
20868
+ indexOfContent(
21639
20869
  /**
21640
- * Context object to call the event handler with. Defaults to this `sap.ui.mdc.valuehelp.base.Container`
21641
- * itself
20870
+ * The content whose index is looked for
21642
20871
  */
21643
- oListener?: object
21644
- ): this;
20872
+ oContent: Content
20873
+ ): int;
21645
20874
  /**
21646
- * Attaches event handler `fnFunction` to the {@link #event:requestSwitchToDialog requestSwitchToDialog }
21647
- * event of this `sap.ui.mdc.valuehelp.base.Container`.
21648
- *
21649
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
21650
- * otherwise it will be bound to this `sap.ui.mdc.valuehelp.base.Container` itself.
21651
- *
21652
- * This event is fired if the value help should switch to dialog mode.
20875
+ * Inserts a content into the aggregation {@link #getContent content}.
21653
20876
  *
21654
20877
  *
21655
20878
  * @returns Reference to `this` in order to allow method chaining
21656
20879
  */
21657
- attachRequestSwitchToDialog(
21658
- /**
21659
- * An application-specific payload object that will be passed to the event handler along with the event
21660
- * object when firing the event
21661
- */
21662
- oData: object,
20880
+ insertContent(
21663
20881
  /**
21664
- * The function to be called when the event occurs
20882
+ * The content to insert; if empty, nothing is inserted
21665
20883
  */
21666
- fnFunction: (p1: Event) => void,
20884
+ oContent: Content,
21667
20885
  /**
21668
- * Context object to call the event handler with. Defaults to this `sap.ui.mdc.valuehelp.base.Container`
21669
- * itself
20886
+ * The `0`-based index the content should be inserted at; for a negative value of `iIndex`, the content
20887
+ * is inserted at position 0; for a value greater than the current size of the aggregation, the content
20888
+ * is inserted at the last position
21670
20889
  */
21671
- oListener?: object
20890
+ iIndex: int
21672
20891
  ): this;
21673
20892
  /**
21674
- * Attaches event handler `fnFunction` to the {@link #event:requestSwitchToDialog requestSwitchToDialog }
21675
- * event of this `sap.ui.mdc.valuehelp.base.Container`.
21676
- *
21677
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
21678
- * otherwise it will be bound to this `sap.ui.mdc.valuehelp.base.Container` itself.
20893
+ * Returns if the value help is used for single selection.
21679
20894
  *
21680
- * This event is fired if the value help should switch to dialog mode.
20895
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
21681
20896
  *
20897
+ * @returns `true` id single selection
20898
+ */
20899
+ isSingleSelect(): boolean;
20900
+ /**
20901
+ * Triggers navigation in the content of the container.
21682
20902
  *
21683
- * @returns Reference to `this` in order to allow method chaining
20903
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
21684
20904
  */
21685
- attachRequestSwitchToDialog(
21686
- /**
21687
- * The function to be called when the event occurs
21688
- */
21689
- fnFunction: (p1: Event) => void,
20905
+ navigateInContent(
21690
20906
  /**
21691
- * Context object to call the event handler with. Defaults to this `sap.ui.mdc.valuehelp.base.Container`
21692
- * itself
20907
+ * Number of steps for navigation (e.g. 1 means next item, -1 means previous item)
21693
20908
  */
21694
- oListener?: object
21695
- ): this;
20909
+ iStep: int
20910
+ ): void;
21696
20911
  /**
21697
- * Attaches event handler `fnFunction` to the {@link #event:select select} event of this `sap.ui.mdc.valuehelp.base.Container`.
21698
- *
21699
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
21700
- * otherwise it will be bound to this `sap.ui.mdc.valuehelp.base.Container` itself.
21701
- *
21702
- * This event is fired if the selected condition has changed.
21703
- *
20912
+ * Observes property and aggregation changes.
21704
20913
  *
21705
- * @returns Reference to `this` in order to allow method chaining
20914
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
21706
20915
  */
21707
- attachSelect(
20916
+ observeChanges(
21708
20917
  /**
21709
- * An application-specific payload object that will be passed to the event handler along with the event
21710
- * object when firing the event
20918
+ * Change
21711
20919
  */
21712
- oData: object,
20920
+ oChanges: object
20921
+ ): void;
20922
+ /**
20923
+ * Opens the container control or element.
20924
+ *
20925
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
20926
+ */
20927
+ openContainer(
21713
20928
  /**
21714
- * The function to be called when the event occurs
20929
+ * container
21715
20930
  */
21716
- fnFunction: (p1: Container$SelectEvent) => void,
20931
+ oContainer: UI5Element,
21717
20932
  /**
21718
- * Context object to call the event handler with. Defaults to this `sap.ui.mdc.valuehelp.base.Container`
21719
- * itself
20933
+ * if set, container is opened for typeahead
21720
20934
  */
21721
- oListener?: object
21722
- ): this;
20935
+ bTypeahead: boolean
20936
+ ): void;
21723
20937
  /**
21724
- * Attaches event handler `fnFunction` to the {@link #event:select select} event of this `sap.ui.mdc.valuehelp.base.Container`.
21725
- *
21726
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
21727
- * otherwise it will be bound to this `sap.ui.mdc.valuehelp.base.Container` itself.
21728
- *
21729
- * This event is fired if the selected condition has changed.
20938
+ * Places the content into the container control or element.
21730
20939
  *
20940
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
21731
20941
  *
21732
- * @returns Reference to `this` in order to allow method chaining
20942
+ * @returns container
21733
20943
  */
21734
- attachSelect(
21735
- /**
21736
- * The function to be called when the event occurs
21737
- */
21738
- fnFunction: (p1: Container$SelectEvent) => void,
20944
+ placeContent(
21739
20945
  /**
21740
- * Context object to call the event handler with. Defaults to this `sap.ui.mdc.valuehelp.base.Container`
21741
- * itself
20946
+ * container
21742
20947
  */
21743
- oListener?: object
21744
- ): this;
20948
+ oContainer: UI5Element
20949
+ ): UI5Element;
21745
20950
  /**
21746
- * Attaches event handler `fnFunction` to the {@link #event:typeaheadSuggested typeaheadSuggested} event
21747
- * of this `sap.ui.mdc.valuehelp.base.Container`.
21748
- *
21749
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
21750
- * otherwise it will be bound to this `sap.ui.mdc.valuehelp.base.Container` itself.
20951
+ * Removes all the controls from the aggregation {@link #getContent content}.
21751
20952
  *
21752
- * This event is fired after a suggested item has been found for a type-ahead.
20953
+ * Additionally, it unregisters them from the hosting UIArea.
21753
20954
  *
21754
- * @since 1.120.0
21755
20955
  *
21756
- * @returns Reference to `this` in order to allow method chaining
20956
+ * @returns An array of the removed elements (might be empty)
21757
20957
  */
21758
- attachTypeaheadSuggested(
21759
- /**
21760
- * An application-specific payload object that will be passed to the event handler along with the event
21761
- * object when firing the event
21762
- */
21763
- oData: object,
21764
- /**
21765
- * The function to be called when the event occurs
21766
- */
21767
- fnFunction: (p1: Container$TypeaheadSuggestedEvent) => void,
20958
+ removeAllContent(): Content[];
20959
+ /**
20960
+ * Removes a content from the aggregation {@link #getContent content}.
20961
+ *
20962
+ *
20963
+ * @returns The removed content or `null`
20964
+ */
20965
+ removeContent(
21768
20966
  /**
21769
- * Context object to call the event handler with. Defaults to this `sap.ui.mdc.valuehelp.base.Container`
21770
- * itself
20967
+ * The content to remove or its index or id
21771
20968
  */
21772
- oListener?: object
21773
- ): this;
20969
+ vContent: int | string | Content
20970
+ ): Content | null;
21774
20971
  /**
21775
- * Attaches event handler `fnFunction` to the {@link #event:typeaheadSuggested typeaheadSuggested} event
21776
- * of this `sap.ui.mdc.valuehelp.base.Container`.
20972
+ * Sets a new value for property {@link #getTitle title}.
21777
20973
  *
21778
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
21779
- * otherwise it will be bound to this `sap.ui.mdc.valuehelp.base.Container` itself.
20974
+ * Title text that appears in the dialog or tab header.
20975
+ *
20976
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
21780
20977
  *
21781
- * This event is fired after a suggested item has been found for a type-ahead.
20978
+ * Default value is `empty string`.
21782
20979
  *
21783
- * @since 1.120.0
21784
20980
  *
21785
20981
  * @returns Reference to `this` in order to allow method chaining
21786
20982
  */
21787
- attachTypeaheadSuggested(
21788
- /**
21789
- * The function to be called when the event occurs
21790
- */
21791
- fnFunction: (p1: Container$TypeaheadSuggestedEvent) => void,
20983
+ setTitle(
21792
20984
  /**
21793
- * Context object to call the event handler with. Defaults to this `sap.ui.mdc.valuehelp.base.Container`
21794
- * itself
20985
+ * New value for property `title`
21795
20986
  */
21796
- oListener?: object
20987
+ sTitle?: string
21797
20988
  ): this;
21798
20989
  /**
21799
- * Binds the content to the container.
20990
+ * Unbinds the content from the container.
21800
20991
  *
21801
20992
  * @ui5-protected Do not call from applications (only from related classes in the framework)
21802
20993
  */
21803
- bindContentToContainer(
20994
+ unbindContentFromContainer(
21804
20995
  /**
21805
20996
  * content
21806
20997
  */
21807
20998
  oContent: Content
21808
20999
  ): void;
21000
+ }
21001
+ /**
21002
+ * Describes the settings that can be provided to the Container constructor.
21003
+ */
21004
+ export interface $ContainerSettings extends $ElementSettings {
21809
21005
  /**
21810
- * Closes the container control or element.
21811
- *
21812
- * @ui5-protected Do not call from applications (only from related classes in the framework)
21006
+ * Title text that appears in the dialog or tab header.
21813
21007
  */
21814
- closeContainer(): void;
21008
+ title?: string | PropertyBindingInfo;
21009
+
21815
21010
  /**
21816
- * Destroys all the content in the aggregation {@link #getContent content}.
21817
- *
21818
- *
21819
- * @returns Reference to `this` in order to allow method chaining
21011
+ * Content of the container. This aggregation holds the actual controls enabling the user to select items
21012
+ * or create conditions (for example, tables or condition panels).
21820
21013
  */
21821
- destroyContent(): this;
21014
+ content?: Content[] | Content | AggregationBindingInfo | `{${string}}`;
21015
+ }
21016
+
21017
+ /**
21018
+ * Parameters of the Container#cancel event.
21019
+ */
21020
+ export interface Container$CancelEventParameters {}
21021
+
21022
+ /**
21023
+ * Event object of the Container#cancel event.
21024
+ */
21025
+ export type Container$CancelEvent = Event<
21026
+ Container$CancelEventParameters,
21027
+ Container
21028
+ >;
21029
+
21030
+ /**
21031
+ * Parameters of the Container#closed event.
21032
+ */
21033
+ export interface Container$ClosedEventParameters {}
21034
+
21035
+ /**
21036
+ * Event object of the Container#closed event.
21037
+ */
21038
+ export type Container$ClosedEvent = Event<
21039
+ Container$ClosedEventParameters,
21040
+ Container
21041
+ >;
21042
+
21043
+ /**
21044
+ * Parameters of the Container#confirm event.
21045
+ */
21046
+ export interface Container$ConfirmEventParameters {
21822
21047
  /**
21823
- * Detaches event handler `fnFunction` from the {@link #event:cancel cancel} event of this `sap.ui.mdc.valuehelp.base.Container`.
21824
- *
21825
- * The passed function and listener object must match the ones used for event registration.
21826
- *
21827
- *
21828
- * @returns Reference to `this` in order to allow method chaining
21048
+ * `true` if the value help needs to be closed
21829
21049
  */
21830
- detachCancel(
21831
- /**
21832
- * The function to be called, when the event occurs
21833
- */
21834
- fnFunction: (p1: Event) => void,
21835
- /**
21836
- * Context object on which the given function had to be called
21837
- */
21838
- oListener?: object
21839
- ): this;
21050
+ close?: boolean;
21051
+ }
21052
+
21053
+ /**
21054
+ * Event object of the Container#confirm event.
21055
+ */
21056
+ export type Container$ConfirmEvent = Event<
21057
+ Container$ConfirmEventParameters,
21058
+ Container
21059
+ >;
21060
+
21061
+ /**
21062
+ * Parameters of the Container#navigated event.
21063
+ */
21064
+ export interface Container$NavigatedEventParameters {
21840
21065
  /**
21841
- * Detaches event handler `fnFunction` from the {@link #event:closed closed} event of this `sap.ui.mdc.valuehelp.base.Container`.
21842
- *
21843
- * The passed function and listener object must match the ones used for event registration.
21844
- *
21845
- *
21846
- * @returns Reference to `this` in order to allow method chaining
21066
+ * `true` if the focus should be set back to the field.
21847
21067
  */
21848
- detachClosed(
21849
- /**
21850
- * The function to be called, when the event occurs
21851
- */
21852
- fnFunction: (p1: Event) => void,
21853
- /**
21854
- * Context object on which the given function had to be called
21855
- */
21856
- oListener?: object
21857
- ): this;
21068
+ leaveFocus?: boolean;
21069
+
21858
21070
  /**
21859
- * Detaches event handler `fnFunction` from the {@link #event:confirm confirm} event of this `sap.ui.mdc.valuehelp.base.Container`.
21860
- *
21861
- * The passed function and listener object must match the ones used for event registration.
21862
- *
21071
+ * Navigated condition.
21863
21072
  *
21864
- * @returns Reference to `this` in order to allow method chaining
21073
+ * **Note:** A condition must have the structure of {@link sap.ui.mdc.condition.ConditionObject ConditionObject}.
21865
21074
  */
21866
- detachConfirm(
21867
- /**
21868
- * The function to be called, when the event occurs
21869
- */
21870
- fnFunction: (p1: Container$ConfirmEvent) => void,
21871
- /**
21872
- * Context object on which the given function had to be called
21873
- */
21874
- oListener?: object
21875
- ): this;
21075
+ condition?: object;
21076
+
21876
21077
  /**
21877
- * Detaches event handler `fnFunction` from the {@link #event:navigated navigated} event of this `sap.ui.mdc.valuehelp.base.Container`.
21878
- *
21879
- * The passed function and listener object must match the ones used for event registration.
21880
- *
21881
- *
21882
- * @returns Reference to `this` in order to allow method chaining
21078
+ * ID of the navigated item. (This is needed to set the corresponding aria-attribute)
21883
21079
  */
21884
- detachNavigated(
21885
- /**
21886
- * The function to be called, when the event occurs
21887
- */
21888
- fnFunction: (p1: Container$NavigatedEvent) => void,
21889
- /**
21890
- * Context object on which the given function had to be called
21891
- */
21892
- oListener?: object
21893
- ): this;
21080
+ itemId?: string;
21081
+ }
21082
+
21083
+ /**
21084
+ * Event object of the Container#navigated event.
21085
+ */
21086
+ export type Container$NavigatedEvent = Event<
21087
+ Container$NavigatedEventParameters,
21088
+ Container
21089
+ >;
21090
+
21091
+ /**
21092
+ * Parameters of the Container#opened event.
21093
+ */
21094
+ export interface Container$OpenedEventParameters {
21894
21095
  /**
21895
- * Detaches event handler `fnFunction` from the {@link #event:opened opened} event of this `sap.ui.mdc.valuehelp.base.Container`.
21896
- *
21897
- * The passed function and listener object must match the ones used for event registration.
21898
- *
21899
- *
21900
- * @returns Reference to `this` in order to allow method chaining
21096
+ * ID of the initially selected item
21901
21097
  */
21902
- detachOpened(
21903
- /**
21904
- * The function to be called, when the event occurs
21905
- */
21906
- fnFunction: (p1: Container$OpenedEvent) => void,
21907
- /**
21908
- * Context object on which the given function had to be called
21909
- */
21910
- oListener?: object
21911
- ): this;
21098
+ itemId?: string;
21099
+ }
21100
+
21101
+ /**
21102
+ * Event object of the Container#opened event.
21103
+ */
21104
+ export type Container$OpenedEvent = Event<
21105
+ Container$OpenedEventParameters,
21106
+ Container
21107
+ >;
21108
+
21109
+ /**
21110
+ * Parameters of the Container#requestDelegateContent event.
21111
+ */
21112
+ export interface Container$RequestDelegateContentEventParameters {
21912
21113
  /**
21913
- * Detaches event handler `fnFunction` from the {@link #event:requestDelegateContent requestDelegateContent }
21914
- * event of this `sap.ui.mdc.valuehelp.base.Container`.
21915
- *
21916
- * The passed function and listener object must match the ones used for event registration.
21917
- *
21918
- *
21919
- * @returns Reference to `this` in order to allow method chaining
21114
+ * Content wrapper ID for which contents are requested
21920
21115
  */
21921
- detachRequestDelegateContent(
21922
- /**
21923
- * The function to be called, when the event occurs
21924
- */
21925
- fnFunction: (p1: Container$RequestDelegateContentEvent) => void,
21926
- /**
21927
- * Context object on which the given function had to be called
21928
- */
21929
- oListener?: object
21930
- ): this;
21116
+ contentId?: string;
21117
+ }
21118
+
21119
+ /**
21120
+ * Event object of the Container#requestDelegateContent event.
21121
+ */
21122
+ export type Container$RequestDelegateContentEvent = Event<
21123
+ Container$RequestDelegateContentEventParameters,
21124
+ Container
21125
+ >;
21126
+
21127
+ /**
21128
+ * Parameters of the Container#requestSwitchToDialog event.
21129
+ */
21130
+ export interface Container$RequestSwitchToDialogEventParameters {}
21131
+
21132
+ /**
21133
+ * Event object of the Container#requestSwitchToDialog event.
21134
+ */
21135
+ export type Container$RequestSwitchToDialogEvent = Event<
21136
+ Container$RequestSwitchToDialogEventParameters,
21137
+ Container
21138
+ >;
21139
+
21140
+ /**
21141
+ * Parameters of the Container#select event.
21142
+ */
21143
+ export interface Container$SelectEventParameters {
21931
21144
  /**
21932
- * Detaches event handler `fnFunction` from the {@link #event:requestSwitchToDialog requestSwitchToDialog }
21933
- * event of this `sap.ui.mdc.valuehelp.base.Container`.
21934
- *
21935
- * The passed function and listener object must match the ones used for event registration.
21936
- *
21937
- *
21938
- * @returns Reference to `this` in order to allow method chaining
21939
- */
21940
- detachRequestSwitchToDialog(
21941
- /**
21942
- * The function to be called, when the event occurs
21943
- */
21944
- fnFunction: (p1: Event) => void,
21945
- /**
21946
- * Context object on which the given function had to be called
21947
- */
21948
- oListener?: object
21949
- ): this;
21950
- /**
21951
- * Detaches event handler `fnFunction` from the {@link #event:select select} event of this `sap.ui.mdc.valuehelp.base.Container`.
21952
- *
21953
- * The passed function and listener object must match the ones used for event registration.
21954
- *
21955
- *
21956
- * @returns Reference to `this` in order to allow method chaining
21957
- */
21958
- detachSelect(
21959
- /**
21960
- * The function to be called, when the event occurs
21961
- */
21962
- fnFunction: (p1: Container$SelectEvent) => void,
21963
- /**
21964
- * Context object on which the given function had to be called
21965
- */
21966
- oListener?: object
21967
- ): this;
21968
- /**
21969
- * Detaches event handler `fnFunction` from the {@link #event:typeaheadSuggested typeaheadSuggested} event
21970
- * of this `sap.ui.mdc.valuehelp.base.Container`.
21971
- *
21972
- * The passed function and listener object must match the ones used for event registration.
21973
- *
21974
- * @since 1.120.0
21975
- *
21976
- * @returns Reference to `this` in order to allow method chaining
21977
- */
21978
- detachTypeaheadSuggested(
21979
- /**
21980
- * The function to be called, when the event occurs
21981
- */
21982
- fnFunction: (p1: Container$TypeaheadSuggestedEvent) => void,
21983
- /**
21984
- * Context object on which the given function had to be called
21985
- */
21986
- oListener?: object
21987
- ): this;
21988
- /**
21989
- * Fires event {@link #event:cancel cancel} to attached listeners.
21990
- *
21991
- * @ui5-protected Do not call from applications (only from related classes in the framework)
21992
- *
21993
- * @returns Reference to `this` in order to allow method chaining
21994
- */
21995
- fireCancel(
21996
- /**
21997
- * Parameters to pass along with the event
21998
- */
21999
- mParameters?: object
22000
- ): this;
22001
- /**
22002
- * Fires event {@link #event:closed closed} to attached listeners.
22003
- *
22004
- * @ui5-protected Do not call from applications (only from related classes in the framework)
22005
- *
22006
- * @returns Reference to `this` in order to allow method chaining
22007
- */
22008
- fireClosed(
22009
- /**
22010
- * Parameters to pass along with the event
22011
- */
22012
- mParameters?: object
22013
- ): this;
22014
- /**
22015
- * Fires event {@link #event:confirm confirm} to attached listeners.
22016
- *
22017
- * @ui5-protected Do not call from applications (only from related classes in the framework)
22018
- *
22019
- * @returns Reference to `this` in order to allow method chaining
22020
- */
22021
- fireConfirm(
22022
- /**
22023
- * Parameters to pass along with the event
22024
- */
22025
- mParameters?: Container$ConfirmEventParameters
22026
- ): this;
22027
- /**
22028
- * Fires event {@link #event:navigated navigated} to attached listeners.
22029
- *
22030
- * @ui5-protected Do not call from applications (only from related classes in the framework)
22031
- *
22032
- * @returns Reference to `this` in order to allow method chaining
22033
- */
22034
- fireNavigated(
22035
- /**
22036
- * Parameters to pass along with the event
22037
- */
22038
- mParameters?: Container$NavigatedEventParameters
22039
- ): this;
22040
- /**
22041
- * Fires event {@link #event:opened opened} to attached listeners.
22042
- *
22043
- * @ui5-protected Do not call from applications (only from related classes in the framework)
22044
- *
22045
- * @returns Reference to `this` in order to allow method chaining
22046
- */
22047
- fireOpened(
22048
- /**
22049
- * Parameters to pass along with the event
22050
- */
22051
- mParameters?: Container$OpenedEventParameters
22052
- ): this;
22053
- /**
22054
- * Fires event {@link #event:requestDelegateContent requestDelegateContent} to attached listeners.
22055
- *
22056
- * @ui5-protected Do not call from applications (only from related classes in the framework)
22057
- *
22058
- * @returns Reference to `this` in order to allow method chaining
22059
- */
22060
- fireRequestDelegateContent(
22061
- /**
22062
- * Parameters to pass along with the event
22063
- */
22064
- mParameters?: Container$RequestDelegateContentEventParameters
22065
- ): this;
22066
- /**
22067
- * Fires event {@link #event:requestSwitchToDialog requestSwitchToDialog} to attached listeners.
22068
- *
22069
- * @ui5-protected Do not call from applications (only from related classes in the framework)
22070
- *
22071
- * @returns Reference to `this` in order to allow method chaining
22072
- */
22073
- fireRequestSwitchToDialog(
22074
- /**
22075
- * Parameters to pass along with the event
22076
- */
22077
- mParameters?: object
22078
- ): this;
22079
- /**
22080
- * Fires event {@link #event:select select} to attached listeners.
22081
- *
22082
- * @ui5-protected Do not call from applications (only from related classes in the framework)
22083
- *
22084
- * @returns Reference to `this` in order to allow method chaining
22085
- */
22086
- fireSelect(
22087
- /**
22088
- * Parameters to pass along with the event
22089
- */
22090
- mParameters?: Container$SelectEventParameters
22091
- ): this;
22092
- /**
22093
- * Fires event {@link #event:typeaheadSuggested typeaheadSuggested} to attached listeners.
22094
- *
22095
- * @since 1.120.0
22096
- * @ui5-protected Do not call from applications (only from related classes in the framework)
22097
- *
22098
- * @returns Reference to `this` in order to allow method chaining
22099
- */
22100
- fireTypeaheadSuggested(
22101
- /**
22102
- * Parameters to pass along with the event
22103
- */
22104
- mParameters?: Container$TypeaheadSuggestedEventParameters
22105
- ): this;
22106
- /**
22107
- * Gets the configuration for a specific content.
22108
- *
22109
- * @ui5-protected Do not call from applications (only from related classes in the framework)
22110
- *
22111
- * @returns configuration
22112
- */
22113
- getContainerConfig(
22114
- /**
22115
- * content
22116
- */
22117
- oContent: Content
22118
- ): object;
22119
- /**
22120
- * Returns the container control or element that is opened (for example, a popover or dialog).
22121
- *
22122
- * @ui5-protected Do not call from applications (only from related classes in the framework)
22123
- */
22124
- getContainerControl(): void;
22125
- /**
22126
- * Gets content of aggregation {@link #getContent content}.
22127
- *
22128
- * Content of the container. This aggregation holds the actual controls enabling the user to select items
22129
- * or create conditions (for example, tables or condition panels).
22130
- */
22131
- getContent(): Content[];
22132
- /**
22133
- * Returns control connected to value help.
22134
- *
22135
- * @ui5-protected Do not call from applications (only from related classes in the framework)
22136
- *
22137
- * @returns connected control
22138
- */
22139
- getControl(): Control;
22140
- /**
22141
- * Gets current value of property {@link #getLocalFilterValue localFilterValue}.
22142
- *
22143
- * This property may be used by `FilterableListContents` to share basic search states in collective search
22144
- * scenarios.
22145
- *
22146
- *
22147
- * @returns Value of property `localFilterValue`
22148
- */
22149
- getLocalFilterValue(): string;
22150
- /**
22151
- * Returns the maximum allowed number of conditions, -1 if no limit is set.
22152
- *
22153
- * @ui5-protected Do not call from applications (only from related classes in the framework)
22154
- *
22155
- * @returns maximum allowed number of conditions
22156
- */
22157
- getMaxConditions(): int;
22158
- /**
22159
- * Returns the `Promise` for content creation.
22160
- *
22161
- * @ui5-protected Do not call from applications (only from related classes in the framework)
22162
- *
22163
- * @returns `Promise` for delegate content
22164
- */
22165
- getRetrieveDelegateContentPromise(): Promise<any>;
22166
- /**
22167
- * Returns the currently used content.
22168
- *
22169
- * @ui5-protected Do not call from applications (only from related classes in the framework)
22170
- *
22171
- * @returns currently used content
22172
- */
22173
- getSelectedContent(): Content;
22174
- /**
22175
- * Gets current value of property {@link #getTitle title}.
22176
- *
22177
- * Title text that appears in the dialog or tab header.
22178
- *
22179
- * Default value is `empty string`.
22180
- *
22181
- *
22182
- * @returns Value of property `title`
22183
- */
22184
- getTitle(): string;
22185
- /**
22186
- * Returns the `UIArea` of the content.
22187
- *
22188
- * @ui5-protected Do not call from applications (only from related classes in the framework)
22189
- *
22190
- * @returns The UI area of the content or `null`
22191
- */
22192
- getUIAreaForContent(): UIArea | null;
22193
- /**
22194
- * Handles the `cancelled` event of the content.
22195
- *
22196
- * Here the {@link #event:cancel cancel} event needs to be fired.
22197
- *
22198
- * @ui5-protected Do not call from applications (only from related classes in the framework)
22199
- */
22200
- handleCanceled(
22201
- /**
22202
- * event
22203
- */
22204
- oEvent: Event
22205
- ): void;
22206
- /**
22207
- * Handles the `closed` event of the container control or element.
22208
- *
22209
- * @ui5-protected Do not call from applications (only from related classes in the framework)
22210
- */
22211
- handleClosed(
22212
- /**
22213
- * event
22214
- */
22215
- oEvent: Event
22216
- ): void;
22217
- /**
22218
- * Handles the `confirmed` event of the content.
22219
- *
22220
- * Here the {@link #event:confirm confirm} event needs to be fired.
22221
- *
22222
- * @ui5-protected Do not call from applications (only from related classes in the framework)
22223
- */
22224
- handleConfirmed(
22225
- /**
22226
- * event
22227
- */
22228
- oEvent: Event
22229
- ): void;
22230
- /**
22231
- * Handles the `navigated` event of the content.
22232
- *
22233
- * @ui5-protected Do not call from applications (only from related classes in the framework)
22234
- */
22235
- handleNavigated(
22236
- /**
22237
- * event
22238
- */
22239
- oEvent: Event
22240
- ): void;
22241
- /**
22242
- * Handles the `opened` event of the container control or element.
22243
- *
22244
- * @ui5-protected Do not call from applications (only from related classes in the framework)
22245
- */
22246
- handleOpened(
22247
- /**
22248
- * event
22249
- */
22250
- oEvent: Event
22251
- ): void;
22252
- /**
22253
- * Handles the `requestSwitchToDialog` event of the content.
22254
- *
22255
- * @ui5-protected Do not call from applications (only from related classes in the framework)
22256
- */
22257
- handleRequestSwitchToDialog(
22258
- /**
22259
- * event
22260
- */
22261
- oEvent: Event
22262
- ): void;
22263
- /**
22264
- * Handles the `select` event of the content.
22265
- *
22266
- * Here the {@link #event:select select} event needs to be fired.
22267
- *
22268
- * @ui5-protected Do not call from applications (only from related classes in the framework)
22269
- */
22270
- handleSelect(
22271
- /**
22272
- * event
22273
- */
22274
- oEvent: Event
22275
- ): void;
22276
- /**
22277
- * Handles the `typeaheadSuggested` event of the content.
22278
- *
22279
- * @ui5-protected Do not call from applications (only from related classes in the framework)
22280
- */
22281
- handleTypeaheadSuggested(
22282
- /**
22283
- * event
22284
- */
22285
- oEvent: Event
22286
- ): void;
22287
- /**
22288
- * Checks for the provided `sap.ui.mdc.valuehelp.base.Content` in the aggregation {@link #getContent content}.
22289
- * and returns its index if found or -1 otherwise.
22290
- *
22291
- *
22292
- * @returns The index of the provided control in the aggregation if found, or -1 otherwise
22293
- */
22294
- indexOfContent(
22295
- /**
22296
- * The content whose index is looked for
22297
- */
22298
- oContent: Content
22299
- ): int;
22300
- /**
22301
- * Inserts a content into the aggregation {@link #getContent content}.
22302
- *
22303
- *
22304
- * @returns Reference to `this` in order to allow method chaining
22305
- */
22306
- insertContent(
22307
- /**
22308
- * The content to insert; if empty, nothing is inserted
22309
- */
22310
- oContent: Content,
22311
- /**
22312
- * The `0`-based index the content should be inserted at; for a negative value of `iIndex`, the content
22313
- * is inserted at position 0; for a value greater than the current size of the aggregation, the content
22314
- * is inserted at the last position
22315
- */
22316
- iIndex: int
22317
- ): this;
22318
- /**
22319
- * Returns if the value help is used for single selection.
22320
- *
22321
- * @ui5-protected Do not call from applications (only from related classes in the framework)
22322
- *
22323
- * @returns `true` id single selection
22324
- */
22325
- isSingleSelect(): boolean;
22326
- /**
22327
- * Triggers navigation in the content of the container.
22328
- *
22329
- * @ui5-protected Do not call from applications (only from related classes in the framework)
22330
- */
22331
- navigateInContent(
22332
- /**
22333
- * Number of steps for navigation (e.g. 1 means next item, -1 means previous item)
22334
- */
22335
- iStep: int
22336
- ): void;
22337
- /**
22338
- * Observes property and aggregation changes.
22339
- *
22340
- * @ui5-protected Do not call from applications (only from related classes in the framework)
22341
- */
22342
- observeChanges(
22343
- /**
22344
- * Change
22345
- */
22346
- oChanges: object
22347
- ): void;
22348
- /**
22349
- * Opens the container control or element.
22350
- *
22351
- * @ui5-protected Do not call from applications (only from related classes in the framework)
22352
- */
22353
- openContainer(
22354
- /**
22355
- * container
22356
- */
22357
- oContainer: UI5Element,
22358
- /**
22359
- * if set, container is opened for typeahead
22360
- */
22361
- bTypeahead: boolean
22362
- ): void;
22363
- /**
22364
- * Places the content into the container control or element.
22365
- *
22366
- * @ui5-protected Do not call from applications (only from related classes in the framework)
22367
- *
22368
- * @returns container
22369
- */
22370
- placeContent(
22371
- /**
22372
- * container
22373
- */
22374
- oContainer: UI5Element
22375
- ): UI5Element;
22376
- /**
22377
- * Removes all the controls from the aggregation {@link #getContent content}.
22378
- *
22379
- * Additionally, it unregisters them from the hosting UIArea.
22380
- *
22381
- *
22382
- * @returns An array of the removed elements (might be empty)
22383
- */
22384
- removeAllContent(): Content[];
22385
- /**
22386
- * Removes a content from the aggregation {@link #getContent content}.
22387
- *
22388
- *
22389
- * @returns The removed content or `null`
22390
- */
22391
- removeContent(
22392
- /**
22393
- * The content to remove or its index or id
22394
- */
22395
- vContent: int | string | Content
22396
- ): Content | null;
22397
- /**
22398
- * Sets a new value for property {@link #getLocalFilterValue localFilterValue}.
22399
- *
22400
- * This property may be used by `FilterableListContents` to share basic search states in collective search
22401
- * scenarios.
22402
- *
22403
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
22404
- *
22405
- *
22406
- * @returns Reference to `this` in order to allow method chaining
22407
- */
22408
- setLocalFilterValue(
22409
- /**
22410
- * New value for property `localFilterValue`
22411
- */
22412
- sLocalFilterValue: string
22413
- ): this;
22414
- /**
22415
- * Sets a new value for property {@link #getTitle title}.
22416
- *
22417
- * Title text that appears in the dialog or tab header.
22418
- *
22419
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
22420
- *
22421
- * Default value is `empty string`.
22422
- *
22423
- *
22424
- * @returns Reference to `this` in order to allow method chaining
22425
- */
22426
- setTitle(
22427
- /**
22428
- * New value for property `title`
22429
- */
22430
- sTitle?: string
22431
- ): this;
22432
- /**
22433
- * Unbinds the content from the container.
22434
- *
22435
- * @ui5-protected Do not call from applications (only from related classes in the framework)
22436
- */
22437
- unbindContentFromContainer(
22438
- /**
22439
- * content
22440
- */
22441
- oContent: Content
22442
- ): void;
22443
- }
22444
- /**
22445
- * Describes the settings that can be provided to the Container constructor.
22446
- */
22447
- export interface $ContainerSettings extends $ElementSettings {
22448
- /**
22449
- * Title text that appears in the dialog or tab header.
22450
- */
22451
- title?: string | PropertyBindingInfo;
22452
-
22453
- /**
22454
- * This property may be used by `FilterableListContents` to share basic search states in collective search
22455
- * scenarios.
22456
- */
22457
- localFilterValue?: string | PropertyBindingInfo;
22458
-
22459
- /**
22460
- * Content of the container. This aggregation holds the actual controls enabling the user to select items
22461
- * or create conditions (for example, tables or condition panels).
22462
- */
22463
- content?: Content[] | Content | AggregationBindingInfo | `{${string}}`;
22464
-
22465
- /**
22466
- * This event is fired if the selected condition has changed.
22467
- */
22468
- select?: (oEvent: Container$SelectEvent) => void;
22469
-
22470
- /**
22471
- * This event is fired if a change of the value help is confirmed.
22472
- */
22473
- confirm?: (oEvent: Container$ConfirmEvent) => void;
22474
-
22475
- /**
22476
- * This event is fired if the value help is opened.
22477
- */
22478
- opened?: (oEvent: Container$OpenedEvent) => void;
22479
-
22480
- /**
22481
- * This event is fired if the value help is closed.
22482
- */
22483
- closed?: (oEvent: Event) => void;
22484
-
22485
- /**
22486
- * This event is fired if the change is cancelled.
22487
- */
22488
- cancel?: (oEvent: Event) => void;
22489
-
22490
- /**
22491
- * This event is fired if the container requests the delegate content.
22492
- */
22493
- requestDelegateContent?: (
22494
- oEvent: Container$RequestDelegateContentEvent
22495
- ) => void;
22496
-
22497
- /**
22498
- * This event is fired if the value help should switch to dialog mode.
22499
- */
22500
- requestSwitchToDialog?: (oEvent: Event) => void;
22501
-
22502
- /**
22503
- * This event is fired if a navigation has been executed in the content of the container.
22504
- */
22505
- navigated?: (oEvent: Container$NavigatedEvent) => void;
22506
-
22507
- /**
22508
- * This event is fired after a suggested item has been found for a type-ahead.
22509
- *
22510
- * @since 1.120.0
22511
- */
22512
- typeaheadSuggested?: (oEvent: Container$TypeaheadSuggestedEvent) => void;
22513
- }
22514
-
22515
- /**
22516
- * Parameters of the Container#cancel event.
22517
- */
22518
- export interface Container$CancelEventParameters {}
22519
-
22520
- /**
22521
- * Event object of the Container#cancel event.
22522
- */
22523
- export type Container$CancelEvent = Event<
22524
- Container$CancelEventParameters,
22525
- Container
22526
- >;
22527
-
22528
- /**
22529
- * Parameters of the Container#closed event.
22530
- */
22531
- export interface Container$ClosedEventParameters {}
22532
-
22533
- /**
22534
- * Event object of the Container#closed event.
22535
- */
22536
- export type Container$ClosedEvent = Event<
22537
- Container$ClosedEventParameters,
22538
- Container
22539
- >;
22540
-
22541
- /**
22542
- * Parameters of the Container#confirm event.
22543
- */
22544
- export interface Container$ConfirmEventParameters {
22545
- /**
22546
- * `true` if the value help needs to be closed
22547
- */
22548
- close?: boolean;
22549
- }
22550
-
22551
- /**
22552
- * Event object of the Container#confirm event.
22553
- */
22554
- export type Container$ConfirmEvent = Event<
22555
- Container$ConfirmEventParameters,
22556
- Container
22557
- >;
22558
-
22559
- /**
22560
- * Parameters of the Container#navigated event.
22561
- */
22562
- export interface Container$NavigatedEventParameters {
22563
- /**
22564
- * `true` if the focus should be set back to the field.
22565
- */
22566
- leaveFocus?: boolean;
22567
-
22568
- /**
22569
- * Navigated condition.
22570
- *
22571
- * **Note:** A condition must have the structure of {@link sap.ui.mdc.condition.ConditionObject ConditionObject}.
22572
- */
22573
- condition?: object;
22574
-
22575
- /**
22576
- * ID of the navigated item. (This is needed to set the corresponding aria-attribute)
22577
- */
22578
- itemId?: string;
22579
- }
22580
-
22581
- /**
22582
- * Event object of the Container#navigated event.
22583
- */
22584
- export type Container$NavigatedEvent = Event<
22585
- Container$NavigatedEventParameters,
22586
- Container
22587
- >;
22588
-
22589
- /**
22590
- * Parameters of the Container#opened event.
22591
- */
22592
- export interface Container$OpenedEventParameters {
22593
- /**
22594
- * ID of the initially selected item
22595
- */
22596
- itemId?: string;
22597
- }
22598
-
22599
- /**
22600
- * Event object of the Container#opened event.
22601
- */
22602
- export type Container$OpenedEvent = Event<
22603
- Container$OpenedEventParameters,
22604
- Container
22605
- >;
22606
-
22607
- /**
22608
- * Parameters of the Container#requestDelegateContent event.
22609
- */
22610
- export interface Container$RequestDelegateContentEventParameters {
22611
- /**
22612
- * Content wrapper ID for which contents are requested
22613
- */
22614
- contentId?: string;
22615
- }
22616
-
22617
- /**
22618
- * Event object of the Container#requestDelegateContent event.
22619
- */
22620
- export type Container$RequestDelegateContentEvent = Event<
22621
- Container$RequestDelegateContentEventParameters,
22622
- Container
22623
- >;
22624
-
22625
- /**
22626
- * Parameters of the Container#requestSwitchToDialog event.
22627
- */
22628
- export interface Container$RequestSwitchToDialogEventParameters {}
22629
-
22630
- /**
22631
- * Event object of the Container#requestSwitchToDialog event.
22632
- */
22633
- export type Container$RequestSwitchToDialogEvent = Event<
22634
- Container$RequestSwitchToDialogEventParameters,
22635
- Container
22636
- >;
22637
-
22638
- /**
22639
- * Parameters of the Container#select event.
22640
- */
22641
- export interface Container$SelectEventParameters {
22642
- /**
22643
- * Type of the selection change (add, remove)
22644
- */
22645
- type?: /* was: sap.ui.mdc.enums.ValueHelpSelectionType */ any;
22646
-
22647
- /**
22648
- * Changed conditions
22649
- *
22650
- * **Note:** A condition must have the structure of {@link sap.ui.mdc.condition.ConditionObject ConditionObject}.
22651
- */
22652
- conditions?: object[];
22653
- }
22654
-
22655
- /**
22656
- * Event object of the Container#select event.
22657
- */
22658
- export type Container$SelectEvent = Event<
22659
- Container$SelectEventParameters,
22660
- Container
22661
- >;
22662
-
22663
- /**
22664
- * Parameters of the Container#typeaheadSuggested event.
22665
- */
22666
- export interface Container$TypeaheadSuggestedEventParameters {
22667
- /**
22668
- * Suggested condition
22669
- *
22670
- * **Note:** A condition must have the structure of {@link sap.ui.mdc.condition.ConditionObject ConditionObject}.
22671
- */
22672
- condition?: object;
22673
-
22674
- /**
22675
- * Used filter value (as the event might fire asynchronously, and the current user input might have changed.)
22676
- */
22677
- filterValue?: string;
22678
-
22679
- /**
22680
- * ID of the suggested item (This is needed to set the corresponding ARIA attribute)
22681
- */
22682
- itemId?: string;
22683
-
22684
- /**
22685
- * If `true` the filtering was executed case sensitive
22686
- */
22687
- caseSensitive?: boolean;
22688
- }
22689
-
22690
- /**
22691
- * Event object of the Container#typeaheadSuggested event.
22692
- */
22693
- export type Container$TypeaheadSuggestedEvent = Event<
22694
- Container$TypeaheadSuggestedEventParameters,
22695
- Container
22696
- >;
22697
- }
22698
-
22699
- declare module "sap/ui/mdc/valuehelp/base/Content" {
22700
- import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
22701
-
22702
- import Event from "sap/ui/base/Event";
22703
-
22704
- import { ConditionObject } from "sap/ui/mdc/condition/Condition";
22705
-
22706
- import Control from "sap/ui/core/Control";
22707
-
22708
- import ElementMetadata from "sap/ui/core/ElementMetadata";
22709
-
22710
- import BaseDelegate from "sap/ui/mdc/BaseDelegate";
22711
-
22712
- import ValueHelp from "sap/ui/mdc/ValueHelp";
22713
-
22714
- import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
22715
-
22716
- /**
22717
- * Content for the {@link sap.ui.mdc.valuehelp.base.Container Container} element.
22718
- *
22719
- * @since 1.95.0
22720
- */
22721
- export default abstract class Content extends UI5Element {
22722
- /**
22723
- * Constructor for a new `Content`.
22724
- *
22725
- * This is the basis for various types of value help content. It cannot be used directly.
22726
- *
22727
- * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
22728
- * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
22729
- * of the syntax of the settings object.
22730
- */
22731
- constructor(
22732
- /**
22733
- * Initial settings for the new element
22734
- */
22735
- mSettings?: $ContentSettings
22736
- );
22737
- /**
22738
- * Constructor for a new `Content`.
22739
- *
22740
- * This is the basis for various types of value help content. It cannot be used directly.
22741
- *
22742
- * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
22743
- * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
22744
- * of the syntax of the settings object.
22745
- */
22746
- constructor(
22747
- /**
22748
- * ID for the new element, generated automatically if no ID is given
22749
- */
22750
- sId?: string,
22751
- /**
22752
- * Initial settings for the new element
22753
- */
22754
- mSettings?: $ContentSettings
22755
- );
22756
-
22757
- /**
22758
- * Creates a new subclass of class sap.ui.mdc.valuehelp.base.Content with name `sClassName` and enriches
22759
- * it with the information contained in `oClassInfo`.
22760
- *
22761
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
22762
- *
22763
- *
22764
- * @returns Created class / constructor function
22765
- */
22766
- static extend<T extends Record<string, unknown>>(
22767
- /**
22768
- * Name of the class being created
22769
- */
22770
- sClassName: string,
22771
- /**
22772
- * Object literal with information about the class
22773
- */
22774
- oClassInfo?: sap.ClassInfo<T, Content>,
22775
- /**
22776
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
22777
- * used by this class
22778
- */
22779
- FNMetaImpl?: Function
22780
- ): Function;
22781
- /**
22782
- * Returns a metadata object for class sap.ui.mdc.valuehelp.base.Content.
22783
- *
22784
- *
22785
- * @returns Metadata object describing this class
22786
- */
22787
- static getMetadata(): ElementMetadata;
22788
- /**
22789
- * Attaches event handler `fnFunction` to the {@link #event:cancel cancel} event of this `sap.ui.mdc.valuehelp.base.Content`.
22790
- *
22791
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
22792
- * otherwise it will be bound to this `sap.ui.mdc.valuehelp.base.Content` itself.
22793
- *
22794
- * This event is fired if the change is cancelled.
22795
- *
22796
- *
22797
- * @returns Reference to `this` in order to allow method chaining
22798
- */
22799
- attachCancel(
22800
- /**
22801
- * An application-specific payload object that will be passed to the event handler along with the event
22802
- * object when firing the event
22803
- */
22804
- oData: object,
22805
- /**
22806
- * The function to be called when the event occurs
22807
- */
22808
- fnFunction: (p1: Event) => void,
22809
- /**
22810
- * Context object to call the event handler with. Defaults to this `sap.ui.mdc.valuehelp.base.Content` itself
22811
- */
22812
- oListener?: object
22813
- ): this;
22814
- /**
22815
- * Attaches event handler `fnFunction` to the {@link #event:cancel cancel} event of this `sap.ui.mdc.valuehelp.base.Content`.
22816
- *
22817
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
22818
- * otherwise it will be bound to this `sap.ui.mdc.valuehelp.base.Content` itself.
22819
- *
22820
- * This event is fired if the change is cancelled.
22821
- *
22822
- *
22823
- * @returns Reference to `this` in order to allow method chaining
22824
- */
22825
- attachCancel(
22826
- /**
22827
- * The function to be called when the event occurs
22828
- */
22829
- fnFunction: (p1: Event) => void,
22830
- /**
22831
- * Context object to call the event handler with. Defaults to this `sap.ui.mdc.valuehelp.base.Content` itself
22832
- */
22833
- oListener?: object
22834
- ): this;
22835
- /**
22836
- * Attaches event handler `fnFunction` to the {@link #event:confirm confirm} event of this `sap.ui.mdc.valuehelp.base.Content`.
22837
- *
22838
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
22839
- * otherwise it will be bound to this `sap.ui.mdc.valuehelp.base.Content` itself.
22840
- *
22841
- * This event is fired if a change of the content is confirmed.
22842
- *
22843
- *
22844
- * @returns Reference to `this` in order to allow method chaining
22845
- */
22846
- attachConfirm(
22847
- /**
22848
- * An application-specific payload object that will be passed to the event handler along with the event
22849
- * object when firing the event
22850
- */
22851
- oData: object,
22852
- /**
22853
- * The function to be called when the event occurs
22854
- */
22855
- fnFunction: (p1: Content$ConfirmEvent) => void,
22856
- /**
22857
- * Context object to call the event handler with. Defaults to this `sap.ui.mdc.valuehelp.base.Content` itself
22858
- */
22859
- oListener?: object
22860
- ): this;
22861
- /**
22862
- * Attaches event handler `fnFunction` to the {@link #event:confirm confirm} event of this `sap.ui.mdc.valuehelp.base.Content`.
22863
- *
22864
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
22865
- * otherwise it will be bound to this `sap.ui.mdc.valuehelp.base.Content` itself.
22866
- *
22867
- * This event is fired if a change of the content is confirmed.
22868
- *
22869
- *
22870
- * @returns Reference to `this` in order to allow method chaining
22871
- */
22872
- attachConfirm(
22873
- /**
22874
- * The function to be called when the event occurs
22875
- */
22876
- fnFunction: (p1: Content$ConfirmEvent) => void,
22877
- /**
22878
- * Context object to call the event handler with. Defaults to this `sap.ui.mdc.valuehelp.base.Content` itself
22879
- */
22880
- oListener?: object
22881
- ): this;
22882
- /**
22883
- * Attaches event handler `fnFunction` to the {@link #event:navigated navigated} event of this `sap.ui.mdc.valuehelp.base.Content`.
22884
- *
22885
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
22886
- * otherwise it will be bound to this `sap.ui.mdc.valuehelp.base.Content` itself.
22887
- *
22888
- * This event is fired if a navigation has been executed in the content.
22889
- *
22890
- *
22891
- * @returns Reference to `this` in order to allow method chaining
22892
- */
22893
- attachNavigated(
22894
- /**
22895
- * An application-specific payload object that will be passed to the event handler along with the event
22896
- * object when firing the event
22897
- */
22898
- oData: object,
22899
- /**
22900
- * The function to be called when the event occurs
22901
- */
22902
- fnFunction: (p1: Content$NavigatedEvent) => void,
22903
- /**
22904
- * Context object to call the event handler with. Defaults to this `sap.ui.mdc.valuehelp.base.Content` itself
22905
- */
22906
- oListener?: object
22907
- ): this;
22908
- /**
22909
- * Attaches event handler `fnFunction` to the {@link #event:navigated navigated} event of this `sap.ui.mdc.valuehelp.base.Content`.
22910
- *
22911
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
22912
- * otherwise it will be bound to this `sap.ui.mdc.valuehelp.base.Content` itself.
22913
- *
22914
- * This event is fired if a navigation has been executed in the content.
22915
- *
22916
- *
22917
- * @returns Reference to `this` in order to allow method chaining
22918
- */
22919
- attachNavigated(
22920
- /**
22921
- * The function to be called when the event occurs
22922
- */
22923
- fnFunction: (p1: Content$NavigatedEvent) => void,
22924
- /**
22925
- * Context object to call the event handler with. Defaults to this `sap.ui.mdc.valuehelp.base.Content` itself
22926
- */
22927
- oListener?: object
22928
- ): this;
22929
- /**
22930
- * Attaches event handler `fnFunction` to the {@link #event:requestSwitchToDialog requestSwitchToDialog }
22931
- * event of this `sap.ui.mdc.valuehelp.base.Content`.
22932
- *
22933
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
22934
- * otherwise it will be bound to this `sap.ui.mdc.valuehelp.base.Content` itself.
22935
- *
22936
- * This event is fired if the value help should switch to dialog mode.
22937
- *
22938
- *
22939
- * @returns Reference to `this` in order to allow method chaining
22940
- */
22941
- attachRequestSwitchToDialog(
22942
- /**
22943
- * An application-specific payload object that will be passed to the event handler along with the event
22944
- * object when firing the event
22945
- */
22946
- oData: object,
22947
- /**
22948
- * The function to be called when the event occurs
22949
- */
22950
- fnFunction: (p1: Event) => void,
22951
- /**
22952
- * Context object to call the event handler with. Defaults to this `sap.ui.mdc.valuehelp.base.Content` itself
22953
- */
22954
- oListener?: object
22955
- ): this;
22956
- /**
22957
- * Attaches event handler `fnFunction` to the {@link #event:requestSwitchToDialog requestSwitchToDialog }
22958
- * event of this `sap.ui.mdc.valuehelp.base.Content`.
22959
- *
22960
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
22961
- * otherwise it will be bound to this `sap.ui.mdc.valuehelp.base.Content` itself.
22962
- *
22963
- * This event is fired if the value help should switch to dialog mode.
22964
- *
22965
- *
22966
- * @returns Reference to `this` in order to allow method chaining
22967
- */
22968
- attachRequestSwitchToDialog(
22969
- /**
22970
- * The function to be called when the event occurs
22971
- */
22972
- fnFunction: (p1: Event) => void,
22973
- /**
22974
- * Context object to call the event handler with. Defaults to this `sap.ui.mdc.valuehelp.base.Content` itself
22975
- */
22976
- oListener?: object
22977
- ): this;
22978
- /**
22979
- * Attaches event handler `fnFunction` to the {@link #event:select select} event of this `sap.ui.mdc.valuehelp.base.Content`.
22980
- *
22981
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
22982
- * otherwise it will be bound to this `sap.ui.mdc.valuehelp.base.Content` itself.
22983
- *
22984
- * This event is fired if the selected condition has changed.
22985
- *
22986
- *
22987
- * @returns Reference to `this` in order to allow method chaining
22988
- */
22989
- attachSelect(
22990
- /**
22991
- * An application-specific payload object that will be passed to the event handler along with the event
22992
- * object when firing the event
22993
- */
22994
- oData: object,
22995
- /**
22996
- * The function to be called when the event occurs
22997
- */
22998
- fnFunction: (p1: Content$SelectEvent) => void,
22999
- /**
23000
- * Context object to call the event handler with. Defaults to this `sap.ui.mdc.valuehelp.base.Content` itself
23001
- */
23002
- oListener?: object
23003
- ): this;
23004
- /**
23005
- * Attaches event handler `fnFunction` to the {@link #event:select select} event of this `sap.ui.mdc.valuehelp.base.Content`.
23006
- *
23007
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
23008
- * otherwise it will be bound to this `sap.ui.mdc.valuehelp.base.Content` itself.
23009
- *
23010
- * This event is fired if the selected condition has changed.
23011
- *
23012
- *
23013
- * @returns Reference to `this` in order to allow method chaining
23014
- */
23015
- attachSelect(
23016
- /**
23017
- * The function to be called when the event occurs
23018
- */
23019
- fnFunction: (p1: Content$SelectEvent) => void,
23020
- /**
23021
- * Context object to call the event handler with. Defaults to this `sap.ui.mdc.valuehelp.base.Content` itself
23022
- */
23023
- oListener?: object
23024
- ): this;
23025
- /**
23026
- * Attaches event handler `fnFunction` to the {@link #event:typeaheadSuggested typeaheadSuggested} event
23027
- * of this `sap.ui.mdc.valuehelp.base.Content`.
23028
- *
23029
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
23030
- * otherwise it will be bound to this `sap.ui.mdc.valuehelp.base.Content` itself.
23031
- *
23032
- * This event is fired after a suggested item has been found for a type-ahead.
23033
- *
23034
- * @since 1.120.0
23035
- *
23036
- * @returns Reference to `this` in order to allow method chaining
23037
- */
23038
- attachTypeaheadSuggested(
23039
- /**
23040
- * An application-specific payload object that will be passed to the event handler along with the event
23041
- * object when firing the event
23042
- */
23043
- oData: object,
23044
- /**
23045
- * The function to be called when the event occurs
23046
- */
23047
- fnFunction: (p1: Content$TypeaheadSuggestedEvent) => void,
23048
- /**
23049
- * Context object to call the event handler with. Defaults to this `sap.ui.mdc.valuehelp.base.Content` itself
23050
- */
23051
- oListener?: object
23052
- ): this;
23053
- /**
23054
- * Attaches event handler `fnFunction` to the {@link #event:typeaheadSuggested typeaheadSuggested} event
23055
- * of this `sap.ui.mdc.valuehelp.base.Content`.
23056
- *
23057
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
23058
- * otherwise it will be bound to this `sap.ui.mdc.valuehelp.base.Content` itself.
23059
- *
23060
- * This event is fired after a suggested item has been found for a type-ahead.
23061
- *
23062
- * @since 1.120.0
23063
- *
23064
- * @returns Reference to `this` in order to allow method chaining
23065
- */
23066
- attachTypeaheadSuggested(
23067
- /**
23068
- * The function to be called when the event occurs
23069
- */
23070
- fnFunction: (p1: Content$TypeaheadSuggestedEvent) => void,
23071
- /**
23072
- * Context object to call the event handler with. Defaults to this `sap.ui.mdc.valuehelp.base.Content` itself
23073
- */
23074
- oListener?: object
23075
- ): this;
23076
- /**
23077
- * Provides access to the delegate initialization `Promise` of the value help.
23078
- *
23079
- * @ui5-protected Do not call from applications (only from related classes in the framework)
23080
- *
23081
- * @returns `Promise` reflecting the delegate initialization
21145
+ * Type of the selection change (add, remove)
23082
21146
  */
23083
- awaitValueHelpDelegate(): Promise<any>;
21147
+ type?: /* was: sap.ui.mdc.enums.ValueHelpSelectionType */ any;
21148
+
23084
21149
  /**
23085
- * Creates a condition based on the used operator.
23086
- *
23087
- * @ui5-protected Do not call from applications (only from related classes in the framework)
21150
+ * Changed conditions
23088
21151
  *
23089
- * @returns The new condition object with the maintained operator along with `sKey` and `sDescription` as
23090
- * `aValues`
21152
+ * **Note:** A condition must have the structure of {@link sap.ui.mdc.condition.ConditionObject ConditionObject}.
23091
21153
  */
23092
- createCondition(
23093
- /**
23094
- * Value of the condition. For item conditions, this must be the key.
23095
- */
23096
- vValue: any,
23097
- /**
23098
- * Description of the operator
23099
- */
23100
- sDescription?: string,
23101
- /**
23102
- * Payload
23103
- */
23104
- oPayload?: object
23105
- ): ConditionObject;
21154
+ conditions?: object[];
21155
+ }
21156
+
21157
+ /**
21158
+ * Event object of the Container#select event.
21159
+ */
21160
+ export type Container$SelectEvent = Event<
21161
+ Container$SelectEventParameters,
21162
+ Container
21163
+ >;
21164
+
21165
+ /**
21166
+ * Parameters of the Container#typeaheadSuggested event.
21167
+ */
21168
+ export interface Container$TypeaheadSuggestedEventParameters {
23106
21169
  /**
23107
- * Destroys the displayContent in the aggregation {@link #getDisplayContent displayContent}.
23108
- *
21170
+ * Suggested condition
23109
21171
  *
23110
- * @returns Reference to `this` in order to allow method chaining
21172
+ * **Note:** A condition must have the structure of {@link sap.ui.mdc.condition.ConditionObject ConditionObject}.
23111
21173
  */
23112
- destroyDisplayContent(): this;
21174
+ condition?: object;
21175
+
23113
21176
  /**
23114
- * Detaches event handler `fnFunction` from the {@link #event:cancel cancel} event of this `sap.ui.mdc.valuehelp.base.Content`.
23115
- *
23116
- * The passed function and listener object must match the ones used for event registration.
23117
- *
23118
- *
23119
- * @returns Reference to `this` in order to allow method chaining
21177
+ * Used filter value (as the event might fire asynchronously, and the current user input might have changed.)
23120
21178
  */
23121
- detachCancel(
23122
- /**
23123
- * The function to be called, when the event occurs
23124
- */
23125
- fnFunction: (p1: Event) => void,
23126
- /**
23127
- * Context object on which the given function had to be called
23128
- */
23129
- oListener?: object
23130
- ): this;
21179
+ filterValue?: string;
21180
+
23131
21181
  /**
23132
- * Detaches event handler `fnFunction` from the {@link #event:confirm confirm} event of this `sap.ui.mdc.valuehelp.base.Content`.
23133
- *
23134
- * The passed function and listener object must match the ones used for event registration.
23135
- *
23136
- *
23137
- * @returns Reference to `this` in order to allow method chaining
21182
+ * ID of the suggested item (This is needed to set the corresponding ARIA attribute)
23138
21183
  */
23139
- detachConfirm(
23140
- /**
23141
- * The function to be called, when the event occurs
23142
- */
23143
- fnFunction: (p1: Content$ConfirmEvent) => void,
23144
- /**
23145
- * Context object on which the given function had to be called
23146
- */
23147
- oListener?: object
23148
- ): this;
21184
+ itemId?: string;
21185
+
23149
21186
  /**
23150
- * Detaches event handler `fnFunction` from the {@link #event:navigated navigated} event of this `sap.ui.mdc.valuehelp.base.Content`.
23151
- *
23152
- * The passed function and listener object must match the ones used for event registration.
23153
- *
23154
- *
23155
- * @returns Reference to `this` in order to allow method chaining
21187
+ * If `true` the filtering was executed case sensitive
23156
21188
  */
23157
- detachNavigated(
23158
- /**
23159
- * The function to be called, when the event occurs
23160
- */
23161
- fnFunction: (p1: Content$NavigatedEvent) => void,
23162
- /**
23163
- * Context object on which the given function had to be called
23164
- */
23165
- oListener?: object
23166
- ): this;
21189
+ caseSensitive?: boolean;
21190
+ }
21191
+
21192
+ /**
21193
+ * Event object of the Container#typeaheadSuggested event.
21194
+ */
21195
+ export type Container$TypeaheadSuggestedEvent = Event<
21196
+ Container$TypeaheadSuggestedEventParameters,
21197
+ Container
21198
+ >;
21199
+ }
21200
+
21201
+ declare module "sap/ui/mdc/valuehelp/base/Content" {
21202
+ import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
21203
+
21204
+ import { ConditionObject } from "sap/ui/mdc/condition/Condition";
21205
+
21206
+ import Control from "sap/ui/core/Control";
21207
+
21208
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
21209
+
21210
+ import BaseDelegate from "sap/ui/mdc/BaseDelegate";
21211
+
21212
+ import ValueHelp from "sap/ui/mdc/ValueHelp";
21213
+
21214
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
21215
+
21216
+ import Event from "sap/ui/base/Event";
21217
+
21218
+ /**
21219
+ * Content for the {@link sap.ui.mdc.valuehelp.base.Container Container} element.
21220
+ *
21221
+ * @since 1.95.0
21222
+ */
21223
+ export default abstract class Content extends UI5Element {
23167
21224
  /**
23168
- * Detaches event handler `fnFunction` from the {@link #event:requestSwitchToDialog requestSwitchToDialog }
23169
- * event of this `sap.ui.mdc.valuehelp.base.Content`.
23170
- *
23171
- * The passed function and listener object must match the ones used for event registration.
21225
+ * Constructor for a new `Content`.
23172
21226
  *
21227
+ * This is the basis for various types of value help content. It cannot be used directly.
23173
21228
  *
23174
- * @returns Reference to `this` in order to allow method chaining
21229
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
21230
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
21231
+ * of the syntax of the settings object.
23175
21232
  */
23176
- detachRequestSwitchToDialog(
23177
- /**
23178
- * The function to be called, when the event occurs
23179
- */
23180
- fnFunction: (p1: Event) => void,
21233
+ constructor(
23181
21234
  /**
23182
- * Context object on which the given function had to be called
21235
+ * Initial settings for the new element
23183
21236
  */
23184
- oListener?: object
23185
- ): this;
21237
+ mSettings?: $ContentSettings
21238
+ );
23186
21239
  /**
23187
- * Detaches event handler `fnFunction` from the {@link #event:select select} event of this `sap.ui.mdc.valuehelp.base.Content`.
23188
- *
23189
- * The passed function and listener object must match the ones used for event registration.
21240
+ * Constructor for a new `Content`.
23190
21241
  *
21242
+ * This is the basis for various types of value help content. It cannot be used directly.
23191
21243
  *
23192
- * @returns Reference to `this` in order to allow method chaining
21244
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
21245
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
21246
+ * of the syntax of the settings object.
23193
21247
  */
23194
- detachSelect(
21248
+ constructor(
23195
21249
  /**
23196
- * The function to be called, when the event occurs
21250
+ * ID for the new element, generated automatically if no ID is given
23197
21251
  */
23198
- fnFunction: (p1: Content$SelectEvent) => void,
21252
+ sId?: string,
23199
21253
  /**
23200
- * Context object on which the given function had to be called
21254
+ * Initial settings for the new element
23201
21255
  */
23202
- oListener?: object
23203
- ): this;
21256
+ mSettings?: $ContentSettings
21257
+ );
21258
+
23204
21259
  /**
23205
- * Detaches event handler `fnFunction` from the {@link #event:typeaheadSuggested typeaheadSuggested} event
23206
- * of this `sap.ui.mdc.valuehelp.base.Content`.
21260
+ * Creates a new subclass of class sap.ui.mdc.valuehelp.base.Content with name `sClassName` and enriches
21261
+ * it with the information contained in `oClassInfo`.
23207
21262
  *
23208
- * The passed function and listener object must match the ones used for event registration.
21263
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
23209
21264
  *
23210
- * @since 1.120.0
23211
21265
  *
23212
- * @returns Reference to `this` in order to allow method chaining
21266
+ * @returns Created class / constructor function
23213
21267
  */
23214
- detachTypeaheadSuggested(
21268
+ static extend<T extends Record<string, unknown>>(
23215
21269
  /**
23216
- * The function to be called, when the event occurs
21270
+ * Name of the class being created
23217
21271
  */
23218
- fnFunction: (p1: Content$TypeaheadSuggestedEvent) => void,
21272
+ sClassName: string,
23219
21273
  /**
23220
- * Context object on which the given function had to be called
21274
+ * Object literal with information about the class
23221
21275
  */
23222
- oListener?: object
23223
- ): this;
23224
- /**
23225
- * Fires event {@link #event:cancel cancel} to attached listeners.
23226
- *
23227
- * @ui5-protected Do not call from applications (only from related classes in the framework)
23228
- *
23229
- * @returns Reference to `this` in order to allow method chaining
23230
- */
23231
- fireCancel(
21276
+ oClassInfo?: sap.ClassInfo<T, Content>,
23232
21277
  /**
23233
- * Parameters to pass along with the event
21278
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
21279
+ * used by this class
23234
21280
  */
23235
- mParameters?: object
23236
- ): this;
21281
+ FNMetaImpl?: Function
21282
+ ): Function;
23237
21283
  /**
23238
- * Fires event {@link #event:confirm confirm} to attached listeners.
21284
+ * Returns a metadata object for class sap.ui.mdc.valuehelp.base.Content.
23239
21285
  *
23240
- * @ui5-protected Do not call from applications (only from related classes in the framework)
23241
21286
  *
23242
- * @returns Reference to `this` in order to allow method chaining
21287
+ * @returns Metadata object describing this class
23243
21288
  */
23244
- fireConfirm(
23245
- /**
23246
- * Parameters to pass along with the event
23247
- */
23248
- mParameters?: Content$ConfirmEventParameters
23249
- ): this;
21289
+ static getMetadata(): ElementMetadata;
23250
21290
  /**
23251
- * Fires event {@link #event:navigated navigated} to attached listeners.
21291
+ * Provides access to the delegate initialization `Promise` of the value help.
23252
21292
  *
23253
21293
  * @ui5-protected Do not call from applications (only from related classes in the framework)
23254
21294
  *
23255
- * @returns Reference to `this` in order to allow method chaining
21295
+ * @returns `Promise` reflecting the delegate initialization
23256
21296
  */
23257
- fireNavigated(
23258
- /**
23259
- * Parameters to pass along with the event
23260
- */
23261
- mParameters?: Content$NavigatedEventParameters
23262
- ): this;
21297
+ awaitValueHelpDelegate(): Promise<any>;
23263
21298
  /**
23264
- * Fires event {@link #event:requestSwitchToDialog requestSwitchToDialog} to attached listeners.
21299
+ * Creates a condition based on the used operator.
23265
21300
  *
23266
21301
  * @ui5-protected Do not call from applications (only from related classes in the framework)
23267
21302
  *
23268
- * @returns Reference to `this` in order to allow method chaining
21303
+ * @returns The new condition object with the maintained operator along with `sKey` and `sDescription` as
21304
+ * `aValues`
23269
21305
  */
23270
- fireRequestSwitchToDialog(
21306
+ createCondition(
23271
21307
  /**
23272
- * Parameters to pass along with the event
21308
+ * Value of the condition. For item conditions, this must be the key.
23273
21309
  */
23274
- mParameters?: object
23275
- ): this;
23276
- /**
23277
- * Fires event {@link #event:select select} to attached listeners.
23278
- *
23279
- * @ui5-protected Do not call from applications (only from related classes in the framework)
23280
- *
23281
- * @returns Reference to `this` in order to allow method chaining
23282
- */
23283
- fireSelect(
21310
+ vValue: any,
23284
21311
  /**
23285
- * Parameters to pass along with the event
21312
+ * Description of the operator
23286
21313
  */
23287
- mParameters?: Content$SelectEventParameters
23288
- ): this;
23289
- /**
23290
- * Fires event {@link #event:typeaheadSuggested typeaheadSuggested} to attached listeners.
23291
- *
23292
- * @since 1.120.0
23293
- * @ui5-protected Do not call from applications (only from related classes in the framework)
23294
- *
23295
- * @returns Reference to `this` in order to allow method chaining
23296
- */
23297
- fireTypeaheadSuggested(
21314
+ sDescription?: string,
23298
21315
  /**
23299
- * Parameters to pass along with the event
21316
+ * Payload
23300
21317
  */
23301
- mParameters?: Content$TypeaheadSuggestedEventParameters
23302
- ): this;
23303
- /**
23304
- * Gets current value of property {@link #getConditions conditions}.
23305
- *
23306
- * Conditions of the value help.
23307
- *
23308
- * **Note:** This property must not be set from outside, it must only be used by the corresponding container.
23309
- *
23310
- * Default value is `[]`.
23311
- *
23312
- *
23313
- * @returns Value of property `conditions`
23314
- */
23315
- getConditions(): object[];
23316
- /**
23317
- * Gets current value of property {@link #getConfig config}.
23318
- *
23319
- * Internal configuration.
23320
- *
23321
- * **Note:** This property must not be set from outside, it must only be used by the corresponding container.
23322
- *
23323
- * Default value is `{}`.
23324
- *
23325
- *
23326
- * @returns Value of property `config`
23327
- */
23328
- getConfig(): object;
21318
+ oPayload?: object
21319
+ ): ConditionObject;
23329
21320
  /**
23330
21321
  * Returns control connected to value help.
23331
21322
  *
@@ -23334,27 +21325,6 @@ declare module "sap/ui/mdc/valuehelp/base/Content" {
23334
21325
  * @returns Connected control
23335
21326
  */
23336
21327
  getControl(): Control;
23337
- /**
23338
- * Gets content of aggregation {@link #getDisplayContent displayContent}.
23339
- *
23340
- * Content control that is put inside the parent container
23341
- *
23342
- * **Note:** This aggregation must not be set from outside, it must only be used by the corresponding container.
23343
- */
23344
- getDisplayContent(): Control;
23345
- /**
23346
- * Gets current value of property {@link #getFilterValue filterValue}.
23347
- *
23348
- * Value for filtering ($search).
23349
- *
23350
- * **Note:** This property must not be set from outside, it must only be used by the corresponding container.
23351
- *
23352
- * Default value is `empty string`.
23353
- *
23354
- *
23355
- * @returns Value of property `filterValue`
23356
- */
23357
- getFilterValue(): string;
23358
21328
  /**
23359
21329
  * Returns the maximum allowed number of conditions, -1 if no limit is set.
23360
21330
  *
@@ -23526,78 +21496,6 @@ declare module "sap/ui/mdc/valuehelp/base/Content" {
23526
21496
  * @returns `true` if a scrolling mechanism is needed
23527
21497
  */
23528
21498
  provideScrolling(): boolean;
23529
- /**
23530
- * Sets a new value for property {@link #getConditions conditions}.
23531
- *
23532
- * Conditions of the value help.
23533
- *
23534
- * **Note:** This property must not be set from outside, it must only be used by the corresponding container.
23535
- *
23536
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
23537
- *
23538
- * Default value is `[]`.
23539
- *
23540
- *
23541
- * @returns Reference to `this` in order to allow method chaining
23542
- */
23543
- setConditions(
23544
- /**
23545
- * New value for property `conditions`
23546
- */
23547
- sConditions?: object[]
23548
- ): this;
23549
- /**
23550
- * Sets a new value for property {@link #getConfig config}.
23551
- *
23552
- * Internal configuration.
23553
- *
23554
- * **Note:** This property must not be set from outside, it must only be used by the corresponding container.
23555
- *
23556
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
23557
- *
23558
- * Default value is `{}`.
23559
- *
23560
- *
23561
- * @returns Reference to `this` in order to allow method chaining
23562
- */
23563
- setConfig(
23564
- /**
23565
- * New value for property `config`
23566
- */
23567
- oConfig?: object
23568
- ): this;
23569
- /**
23570
- * Sets the aggregated {@link #getDisplayContent displayContent}.
23571
- *
23572
- *
23573
- * @returns Reference to `this` in order to allow method chaining
23574
- */
23575
- setDisplayContent(
23576
- /**
23577
- * The displayContent to set
23578
- */
23579
- oDisplayContent: Control
23580
- ): this;
23581
- /**
23582
- * Sets a new value for property {@link #getFilterValue filterValue}.
23583
- *
23584
- * Value for filtering ($search).
23585
- *
23586
- * **Note:** This property must not be set from outside, it must only be used by the corresponding container.
23587
- *
23588
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
23589
- *
23590
- * Default value is `empty string`.
23591
- *
23592
- *
23593
- * @returns Reference to `this` in order to allow method chaining
23594
- */
23595
- setFilterValue(
23596
- /**
23597
- * New value for property `filterValue`
23598
- */
23599
- sFilterValue?: string
23600
- ): this;
23601
21499
  /**
23602
21500
  * Sets a new value for property {@link #getShortTitle shortTitle}.
23603
21501
  *
@@ -23690,70 +21588,10 @@ declare module "sap/ui/mdc/valuehelp/base/Content" {
23690
21588
  */
23691
21589
  tokenizerTitle?: string | PropertyBindingInfo;
23692
21590
 
23693
- /**
23694
- * Conditions of the value help.
23695
- *
23696
- * **Note:** This property must not be set from outside, it must only be used by the corresponding container.
23697
- */
23698
- conditions?: object[] | PropertyBindingInfo | `{${string}}`;
23699
-
23700
- /**
23701
- * Value for filtering ($search).
23702
- *
23703
- * **Note:** This property must not be set from outside, it must only be used by the corresponding container.
23704
- */
23705
- filterValue?: string | PropertyBindingInfo;
23706
-
23707
- /**
23708
- * Internal configuration.
23709
- *
23710
- * **Note:** This property must not be set from outside, it must only be used by the corresponding container.
23711
- */
23712
- config?: object | PropertyBindingInfo | `{${string}}`;
23713
-
23714
21591
  /**
23715
21592
  * Hide content temporary.
23716
21593
  */
23717
21594
  visible?: boolean | PropertyBindingInfo | `{${string}}`;
23718
-
23719
- /**
23720
- * Content control that is put inside the parent container
23721
- *
23722
- * **Note:** This aggregation must not be set from outside, it must only be used by the corresponding container.
23723
- */
23724
- displayContent?: Control;
23725
-
23726
- /**
23727
- * This event is fired if the selected condition has changed.
23728
- */
23729
- select?: (oEvent: Content$SelectEvent) => void;
23730
-
23731
- /**
23732
- * This event is fired if a change of the content is confirmed.
23733
- */
23734
- confirm?: (oEvent: Content$ConfirmEvent) => void;
23735
-
23736
- /**
23737
- * This event is fired if the change is cancelled.
23738
- */
23739
- cancel?: (oEvent: Event) => void;
23740
-
23741
- /**
23742
- * This event is fired if the value help should switch to dialog mode.
23743
- */
23744
- requestSwitchToDialog?: (oEvent: Event) => void;
23745
-
23746
- /**
23747
- * This event is fired if a navigation has been executed in the content.
23748
- */
23749
- navigated?: (oEvent: Content$NavigatedEvent) => void;
23750
-
23751
- /**
23752
- * This event is fired after a suggested item has been found for a type-ahead.
23753
- *
23754
- * @since 1.120.0
23755
- */
23756
- typeaheadSuggested?: (oEvent: Content$TypeaheadSuggestedEvent) => void;
23757
21595
  }
23758
21596
 
23759
21597
  /**