@openui5/types 1.120.10 → 1.121.1
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.
- package/package.json +1 -1
- package/types/sap.f.d.ts +124 -45
- package/types/sap.m.d.ts +2103 -312
- package/types/sap.tnt.d.ts +628 -113
- package/types/sap.ui.codeeditor.d.ts +10 -6
- package/types/sap.ui.commons.d.ts +92 -8
- package/types/sap.ui.core.d.ts +500 -186
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.fl.d.ts +91 -68
- package/types/sap.ui.integration.d.ts +51 -4
- package/types/sap.ui.layout.d.ts +214 -27
- package/types/sap.ui.mdc.d.ts +1544 -811
- package/types/sap.ui.rta.d.ts +1 -1
- package/types/sap.ui.suite.d.ts +3 -1
- package/types/sap.ui.support.d.ts +28 -4
- package/types/sap.ui.table.d.ts +57 -7
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +157 -54
- package/types/sap.ui.ux3.d.ts +30 -12
- package/types/sap.ui.webc.common.d.ts +1 -1
- package/types/sap.ui.webc.fiori.d.ts +49 -1
- package/types/sap.ui.webc.main.d.ts +144 -9
- package/types/sap.uxap.d.ts +52 -5
package/types/sap.ui.mdc.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.
|
|
1
|
+
// For Library Version: 1.121.1
|
|
2
2
|
|
|
3
3
|
declare module "sap/ui/mdc/AggregationBaseDelegate" {
|
|
4
4
|
import BaseDelegate from "sap/ui/mdc/BaseDelegate";
|
|
@@ -25,34 +25,30 @@ declare module "sap/ui/mdc/AggregationBaseDelegate" {
|
|
|
25
25
|
*/
|
|
26
26
|
interface AggregationBaseDelegate extends BaseDelegate {
|
|
27
27
|
/**
|
|
28
|
-
*
|
|
28
|
+
* Central hook to add items to the provided control instance. This method must return a promise that resolves
|
|
29
|
+
* with an instance of the implementing {@link sap.ui.mdc.Control Control} default aggregation.
|
|
29
30
|
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
* a personalization dialog), this method might be called without the parameter `mPropertyBag`.
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
* @returns Promise that resolves with an instance of the implementing {@link sap.ui.mdc.Control Control }
|
|
36
|
-
* default aggregation. **Note:** This method always requires a return value once it has been called. If
|
|
37
|
-
* an item for a given property `sPropertyName` has already been created, it is required to either return
|
|
38
|
-
* the existing instance or create a new instance.
|
|
31
|
+
* Consequently the parameter `mPropertyBag` is only passed during preprocessing. In runtime scenarios (such
|
|
32
|
+
* as opening a personalization dialog), this method might be called without the parameter `mPropertyBag`.
|
|
39
33
|
*/
|
|
40
34
|
addItem(
|
|
41
35
|
/**
|
|
42
|
-
* Instance of an `sap.ui.mdc.Control`
|
|
36
|
+
* Instance of an `sap.ui.mdc.Control`. **Note:** The `addItem` hook can be used during the processing of
|
|
37
|
+
* an SAPUI5 flexibility change.
|
|
43
38
|
*/
|
|
44
39
|
oControl: Control | Element,
|
|
45
40
|
/**
|
|
46
|
-
* The name of the property info object
|
|
41
|
+
* The name of the property info object
|
|
47
42
|
*/
|
|
48
43
|
sPropertyName: string,
|
|
49
44
|
/**
|
|
50
45
|
* Instance of property bag from SAPUI5 flexibility change API
|
|
51
46
|
*/
|
|
52
47
|
mPropertyBag?: Object
|
|
53
|
-
):
|
|
48
|
+
): void;
|
|
54
49
|
/**
|
|
55
50
|
* Retrieves the relevant metadata for a given payload and returns the property info array.
|
|
51
|
+
* By default, this method returns a `Promise` that resolves into `[]`.
|
|
56
52
|
*
|
|
57
53
|
*
|
|
58
54
|
* @returns Once resolved, an array of property info objects is returned
|
|
@@ -81,13 +77,16 @@ declare module "sap/ui/mdc/AggregationBaseDelegate" {
|
|
|
81
77
|
* Triggers any necessary follow-up steps that need to be taken after the removal of created items via `removeItem`.
|
|
82
78
|
* The returned Boolean value inside the `Promise` can be used to prevent the default follow-up behavior
|
|
83
79
|
* of the SAPUI5 flexibility handling.
|
|
80
|
+
* By default, this method returns a `Promise` that resolves into `true`. This will ensure, that the item
|
|
81
|
+
* will be destroyed subsequentially after it has been removed by the control.
|
|
84
82
|
*
|
|
85
83
|
* **Note:** The `removeItem` hook can be used during the processing of an SAPUI5 flexibility change. Consequently
|
|
86
84
|
* the parameter `mPropertyBag` is only passed during preprocessing. In runtime scenarios (such as opening
|
|
87
85
|
* a personalization dialog), this method might be called without the parameter `mPropertyBag`.
|
|
88
86
|
*
|
|
89
87
|
*
|
|
90
|
-
* @returns Promise
|
|
88
|
+
* @returns Promise resolving in a boolean, deciding whether the item should be destroyed (`true`) or kept
|
|
89
|
+
* (`false`) after removing it from the control aggregation.
|
|
91
90
|
*/
|
|
92
91
|
removeItem(
|
|
93
92
|
/**
|
|
@@ -102,7 +101,7 @@ declare module "sap/ui/mdc/AggregationBaseDelegate" {
|
|
|
102
101
|
* Instance of property bag from SAPUI5 flexibility
|
|
103
102
|
*/
|
|
104
103
|
mPropertyBag?: Object
|
|
105
|
-
): Promise<
|
|
104
|
+
): Promise<boolean>;
|
|
106
105
|
}
|
|
107
106
|
const AggregationBaseDelegate: AggregationBaseDelegate;
|
|
108
107
|
export default AggregationBaseDelegate;
|
|
@@ -119,8 +118,8 @@ declare module "sap/ui/mdc/BaseDelegate" {
|
|
|
119
118
|
*
|
|
120
119
|
* All delegate implementations for MDC controls must be derived directly or indirectly from this entity.
|
|
121
120
|
* Applications should implement {@link module:sap/ui/mdc/BaseDelegate.getTypeMap getTypeMap} to provide
|
|
122
|
-
* type mappings based on their model usage. Please also see the following extensible presets: {@link sap.ui.mdc.DefaultTypeMap},
|
|
123
|
-
* {@link sap.ui.mdc.odata.TypeMap}, {@link sap.ui.mdc.odata.v4.TypeMap}
|
|
121
|
+
* type mappings based on their model usage. Please also see the following extensible presets: {@link module:sap/ui/mdc/DefaultTypeMap sap.ui.mdc.DefaultTypeMap},
|
|
122
|
+
* {@link module:sap/ui/mdc/odata/TypeMap sap.ui.mdc.odata.TypeMap}, {@link module:sap/ui/mdc/odata/v4/TypeMap sap.ui.mdc.odata.v4.TypeMap}
|
|
124
123
|
*
|
|
125
124
|
* @since 1.79.0
|
|
126
125
|
*/
|
|
@@ -155,6 +154,8 @@ declare module "sap/ui/mdc/ChartDelegate" {
|
|
|
155
154
|
|
|
156
155
|
import FilterField from "sap/ui/mdc/FilterField";
|
|
157
156
|
|
|
157
|
+
import Filter from "sap/ui/model/Filter";
|
|
158
|
+
|
|
158
159
|
import Control from "sap/ui/core/Control";
|
|
159
160
|
|
|
160
161
|
import { URI } from "sap/ui/core/library";
|
|
@@ -321,6 +322,21 @@ declare module "sap/ui/mdc/ChartDelegate" {
|
|
|
321
322
|
getFilterDelegate(): {
|
|
322
323
|
addItem: (p1: Chart, p2: string) => Promise<FilterField>;
|
|
323
324
|
};
|
|
325
|
+
/**
|
|
326
|
+
* Returns filters to be applied when updating the chart's binding based on the filter conditions of the
|
|
327
|
+
* chart itself and it's associated {@link sap.ui.mdc.IFilterSource IFilterSource}.
|
|
328
|
+
*
|
|
329
|
+
* @since 1.121
|
|
330
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
331
|
+
*
|
|
332
|
+
* @returns Array of filters
|
|
333
|
+
*/
|
|
334
|
+
getFilters(
|
|
335
|
+
/**
|
|
336
|
+
* Reference to the chart
|
|
337
|
+
*/
|
|
338
|
+
oChart: Chart
|
|
339
|
+
): Filter[];
|
|
324
340
|
/**
|
|
325
341
|
* Returns the instance of the inner chart.
|
|
326
342
|
*
|
|
@@ -429,6 +445,7 @@ declare module "sap/ui/mdc/ChartDelegate" {
|
|
|
429
445
|
): ZoomState;
|
|
430
446
|
/**
|
|
431
447
|
* Loads the required libraries and creates the inner chart.
|
|
448
|
+
* By default, the method returns `Promise.reject()`.
|
|
432
449
|
*
|
|
433
450
|
*
|
|
434
451
|
* @returns Resolved once the inner chart has been initialized
|
|
@@ -577,6 +594,8 @@ declare module "sap/ui/mdc/ChartDelegate" {
|
|
|
577
594
|
): void;
|
|
578
595
|
/**
|
|
579
596
|
* Updates the binding info with the relevant filters.
|
|
597
|
+
* By default, this method updates a given {@link sap.ui.base.ManagedObject.AggregationBindingInfo AggregationBindingInfo }
|
|
598
|
+
* with the return value from the delegate's own {@link module:sap/ui/mdc/ChartDelegate.getFilters getFilters}.
|
|
580
599
|
*/
|
|
581
600
|
updateBindingInfo(
|
|
582
601
|
/**
|
|
@@ -679,9 +698,9 @@ declare module "sap/ui/mdc/DefaultTypeMap" {
|
|
|
679
698
|
import TypeMap from "sap/ui/mdc/util/TypeMap";
|
|
680
699
|
|
|
681
700
|
/**
|
|
682
|
-
* Generic {@link sap
|
|
701
|
+
* Generic {@link module:sap/ui/mdc/util/TypeMap TypeMap} configuration for simple use cases.
|
|
683
702
|
*
|
|
684
|
-
* **Note:** This {@link sap
|
|
703
|
+
* **Note:** This {@link module:sap/ui/mdc/util/TypeMap TypeMap} implementation contains the following types:
|
|
685
704
|
*
|
|
686
705
|
*
|
|
687
706
|
* - {@link sap.ui.model.type.Boolean} (alias `Boolean`)
|
|
@@ -734,6 +753,8 @@ declare module "sap/ui/mdc/field/FieldBaseDelegate" {
|
|
|
734
753
|
/**
|
|
735
754
|
* Enables applications to control condition updates based on `value` / `additionalvalue` property changes.
|
|
736
755
|
*
|
|
756
|
+
* By default, this method returns a condition with an `EQ` operator.
|
|
757
|
+
*
|
|
737
758
|
* **Note:** Custom implementations of this method may lead to intransparency as a field's condition may
|
|
738
759
|
* then differ from the state of the `value` / `additionalvalue` properties. Avoid expensive operations,
|
|
739
760
|
* as this can delay the rendering of the output.
|
|
@@ -763,6 +784,8 @@ declare module "sap/ui/mdc/field/FieldBaseDelegate" {
|
|
|
763
784
|
/**
|
|
764
785
|
* Enables applications to control condition updates based on `value` / `additionalvalue` property changes.
|
|
765
786
|
*
|
|
787
|
+
* By default, this method returns a condition with an `EQ` operator.
|
|
788
|
+
*
|
|
766
789
|
* **Note:** Custom implementations of this method may lead to intransparency as a field's condition may
|
|
767
790
|
* then differ from the state of the `value` / `additionalvalue` properties. Avoid expensive operations,
|
|
768
791
|
* as this can delay the rendering of the output.
|
|
@@ -825,17 +848,69 @@ declare module "sap/ui/mdc/field/FieldBaseDelegate" {
|
|
|
825
848
|
*/
|
|
826
849
|
aValues: any[]
|
|
827
850
|
): undefined | object;
|
|
851
|
+
/**
|
|
852
|
+
* Determines the text for the autocomplete functionality.
|
|
853
|
+
*
|
|
854
|
+
* This function is called during a user's type-ahead into a {@link sap.ui.mdc.Field Field}, {@link sap.ui.mdc.FilterField FilterField},
|
|
855
|
+
* or {@link sap.ui.mdc.MultiValueField MultiValueField} control.
|
|
856
|
+
*
|
|
857
|
+
* The returned text will be shown as selected after the user input ends.
|
|
858
|
+
*
|
|
859
|
+
* By Default this method uses the {@link sap.ui.mdc.field.FieldBase#getDisplay display} property of the
|
|
860
|
+
* {@link sap.ui.mdc.Field Field}, {@link sap.ui.mdc.FilterField FilterField}, or {@link sap.ui.mdc.MultiValueField MultiValueField }
|
|
861
|
+
* control to determine what text (key or description) is used as autocomplete-text. A text is only used
|
|
862
|
+
* if it matches the user input. If set to `Value`, the key is used. If set to `Description`, the description
|
|
863
|
+
* is used. If set to `ValueDescription`, the key is used, if it maps, otherwise the description. If set
|
|
864
|
+
* to `DescriptionValue`, the description is used, if it maps, otherwise the key.
|
|
865
|
+
*
|
|
866
|
+
* **Note:** Whatever this function returns, the user input will not be overwritten, only the text after
|
|
867
|
+
* the user input will be added and shown as selected. Otherwise the cursor position might change or the
|
|
868
|
+
* user input changes while typing what would lead to confusion.
|
|
869
|
+
*
|
|
870
|
+
*
|
|
871
|
+
* @returns Output text
|
|
872
|
+
*/
|
|
873
|
+
getAutocompleteOutput(
|
|
874
|
+
/**
|
|
875
|
+
* `Field` control instance
|
|
876
|
+
*/
|
|
877
|
+
oField: FieldBase,
|
|
878
|
+
/**
|
|
879
|
+
* Condition
|
|
880
|
+
*/
|
|
881
|
+
oCondition: ConditionObject,
|
|
882
|
+
/**
|
|
883
|
+
* Formatted text of the key (value)
|
|
884
|
+
*/
|
|
885
|
+
sKey: string,
|
|
886
|
+
/**
|
|
887
|
+
* FormattedText of the description
|
|
888
|
+
*/
|
|
889
|
+
sDescription: string,
|
|
890
|
+
/**
|
|
891
|
+
* If `true` the key matches to the user input
|
|
892
|
+
*/
|
|
893
|
+
bKeyMatch: boolean,
|
|
894
|
+
/**
|
|
895
|
+
* If `true` the description matches to the user input
|
|
896
|
+
*/
|
|
897
|
+
bDescriptionMatch: boolean
|
|
898
|
+
): string;
|
|
828
899
|
/**
|
|
829
900
|
* Determines the description for a given key.
|
|
901
|
+
* By default, this method calls the {@link sap.ui.mdc.ValueHelp#getItemForValue getItemForValue} function
|
|
902
|
+
* of the assigned {@link sap.ui.mdc.ValueHelp ValueHelp}.
|
|
830
903
|
*
|
|
831
|
-
* This function is called while formatting the output of a {@link sap.ui.mdc.Field Field}
|
|
832
|
-
* control if a description should be displayed but
|
|
904
|
+
* This function is called while formatting the output of a {@link sap.ui.mdc.Field Field}, {@link sap.ui.mdc.FilterField FilterField},
|
|
905
|
+
* or {@link sap.ui.mdc.MultiValueField MultiValueField} control if a description should be displayed but
|
|
906
|
+
* only a key is given.
|
|
833
907
|
*
|
|
834
908
|
* If this needs to be determined asynchronously, a `Promise` is returned.
|
|
835
909
|
*
|
|
836
910
|
* As the key might change (uppercase), an object with key and description can be returned.
|
|
837
911
|
*
|
|
838
|
-
* If the description cannot be determined, a corresponding FormatException
|
|
912
|
+
* If the description cannot be determined, a corresponding {@link sap.ui.model.FormatException FormatException }
|
|
913
|
+
* is thrown.
|
|
839
914
|
*
|
|
840
915
|
*
|
|
841
916
|
* @returns Description for key or object containing description, key, and payload. If it is not available
|
|
@@ -847,8 +922,8 @@ declare module "sap/ui/mdc/field/FieldBaseDelegate" {
|
|
|
847
922
|
*/
|
|
848
923
|
oField: FieldBase,
|
|
849
924
|
/**
|
|
850
|
-
* Field help assigned to the {@link sap.ui.mdc.Field Field}
|
|
851
|
-
* control
|
|
925
|
+
* Field help assigned to the {@link sap.ui.mdc.Field Field}, {@link sap.ui.mdc.FilterField FilterField},
|
|
926
|
+
* or {@link sap.ui.mdc.MultiValueField MultiValueField} control
|
|
852
927
|
*/
|
|
853
928
|
oValueHelp: ValueHelp,
|
|
854
929
|
/**
|
|
@@ -894,15 +969,19 @@ declare module "sap/ui/mdc/field/FieldBaseDelegate" {
|
|
|
894
969
|
| Promise<string | /* was: sap.ui.mdc.valuehelp.ValueHelpItem */ any>;
|
|
895
970
|
/**
|
|
896
971
|
* Determines the description for a given key.
|
|
972
|
+
* By default, this method calls the {@link sap.ui.mdc.ValueHelp#getItemForValue getItemForValue} function
|
|
973
|
+
* of the assigned {@link sap.ui.mdc.ValueHelp ValueHelp}.
|
|
897
974
|
*
|
|
898
|
-
* This function is called while formatting the output of a {@link sap.ui.mdc.Field Field}
|
|
899
|
-
* control if a description should be displayed but
|
|
975
|
+
* This function is called while formatting the output of a {@link sap.ui.mdc.Field Field}, {@link sap.ui.mdc.FilterField FilterField},
|
|
976
|
+
* or {@link sap.ui.mdc.MultiValueField MultiValueField} control if a description should be displayed but
|
|
977
|
+
* only a key is given.
|
|
900
978
|
*
|
|
901
979
|
* If this needs to be determined asynchronously, a `Promise` is returned.
|
|
902
980
|
*
|
|
903
981
|
* As the key might change (uppercase), an object with key and description can be returned.
|
|
904
982
|
*
|
|
905
|
-
* If the description cannot be determined, a corresponding FormatException
|
|
983
|
+
* If the description cannot be determined, a corresponding {@link sap.ui.model.FormatException FormatException }
|
|
984
|
+
* is thrown.
|
|
906
985
|
*
|
|
907
986
|
*
|
|
908
987
|
* @returns Description for key or object containing description, key, and payload. If it is not available
|
|
@@ -914,8 +993,8 @@ declare module "sap/ui/mdc/field/FieldBaseDelegate" {
|
|
|
914
993
|
*/
|
|
915
994
|
oField: FieldBase,
|
|
916
995
|
/**
|
|
917
|
-
* Field help assigned to the {@link sap.ui.mdc.Field Field}
|
|
918
|
-
* control
|
|
996
|
+
* Field help assigned to the {@link sap.ui.mdc.Field Field}, {@link sap.ui.mdc.FilterField FilterField},
|
|
997
|
+
* or {@link sap.ui.mdc.MultiValueField MultiValueField} control
|
|
919
998
|
*/
|
|
920
999
|
oValueHelp: ValueHelp,
|
|
921
1000
|
/**
|
|
@@ -957,15 +1036,19 @@ declare module "sap/ui/mdc/field/FieldBaseDelegate" {
|
|
|
957
1036
|
| Promise<string | /* was: sap.ui.mdc.valuehelp.ValueHelpItem */ any>;
|
|
958
1037
|
/**
|
|
959
1038
|
* Determines the description for a given key.
|
|
1039
|
+
* By default, this method calls the {@link sap.ui.mdc.ValueHelp#getItemForValue getItemForValue} function
|
|
1040
|
+
* of the assigned {@link sap.ui.mdc.ValueHelp ValueHelp}.
|
|
960
1041
|
*
|
|
961
|
-
* This function is called while formatting the output of a {@link sap.ui.mdc.Field Field}
|
|
962
|
-
* control if a description should be displayed but
|
|
1042
|
+
* This function is called while formatting the output of a {@link sap.ui.mdc.Field Field}, {@link sap.ui.mdc.FilterField FilterField},
|
|
1043
|
+
* or {@link sap.ui.mdc.MultiValueField MultiValueField} control if a description should be displayed but
|
|
1044
|
+
* only a key is given.
|
|
963
1045
|
*
|
|
964
1046
|
* If this needs to be determined asynchronously, a `Promise` is returned.
|
|
965
1047
|
*
|
|
966
1048
|
* As the key might change (uppercase), an object with key and description can be returned.
|
|
967
1049
|
*
|
|
968
|
-
* If the description cannot be determined, a corresponding FormatException
|
|
1050
|
+
* If the description cannot be determined, a corresponding {@link sap.ui.model.FormatException FormatException }
|
|
1051
|
+
* is thrown.
|
|
969
1052
|
*
|
|
970
1053
|
*
|
|
971
1054
|
* @returns Description for key or object containing description, key, and payload. If it is not available
|
|
@@ -977,8 +1060,8 @@ declare module "sap/ui/mdc/field/FieldBaseDelegate" {
|
|
|
977
1060
|
*/
|
|
978
1061
|
oField: FieldBase,
|
|
979
1062
|
/**
|
|
980
|
-
* Field help assigned to the {@link sap.ui.mdc.Field Field}
|
|
981
|
-
* control
|
|
1063
|
+
* Field help assigned to the {@link sap.ui.mdc.Field Field}, {@link sap.ui.mdc.FilterField FilterField},
|
|
1064
|
+
* or {@link sap.ui.mdc.MultiValueField MultiValueField} control
|
|
982
1065
|
*/
|
|
983
1066
|
oValueHelp: ValueHelp,
|
|
984
1067
|
/**
|
|
@@ -1020,15 +1103,19 @@ declare module "sap/ui/mdc/field/FieldBaseDelegate" {
|
|
|
1020
1103
|
| Promise<string | /* was: sap.ui.mdc.valuehelp.ValueHelpItem */ any>;
|
|
1021
1104
|
/**
|
|
1022
1105
|
* Determines the description for a given key.
|
|
1106
|
+
* By default, this method calls the {@link sap.ui.mdc.ValueHelp#getItemForValue getItemForValue} function
|
|
1107
|
+
* of the assigned {@link sap.ui.mdc.ValueHelp ValueHelp}.
|
|
1023
1108
|
*
|
|
1024
|
-
* This function is called while formatting the output of a {@link sap.ui.mdc.Field Field}
|
|
1025
|
-
* control if a description should be displayed but
|
|
1109
|
+
* This function is called while formatting the output of a {@link sap.ui.mdc.Field Field}, {@link sap.ui.mdc.FilterField FilterField},
|
|
1110
|
+
* or {@link sap.ui.mdc.MultiValueField MultiValueField} control if a description should be displayed but
|
|
1111
|
+
* only a key is given.
|
|
1026
1112
|
*
|
|
1027
1113
|
* If this needs to be determined asynchronously, a `Promise` is returned.
|
|
1028
1114
|
*
|
|
1029
1115
|
* As the key might change (uppercase), an object with key and description can be returned.
|
|
1030
1116
|
*
|
|
1031
|
-
* If the description cannot be determined, a corresponding FormatException
|
|
1117
|
+
* If the description cannot be determined, a corresponding {@link sap.ui.model.FormatException FormatException }
|
|
1118
|
+
* is thrown.
|
|
1032
1119
|
*
|
|
1033
1120
|
*
|
|
1034
1121
|
* @returns Description for key or object containing description, key, and payload. If it is not available
|
|
@@ -1040,8 +1127,8 @@ declare module "sap/ui/mdc/field/FieldBaseDelegate" {
|
|
|
1040
1127
|
*/
|
|
1041
1128
|
oField: FieldBase,
|
|
1042
1129
|
/**
|
|
1043
|
-
* Field help assigned to the {@link sap.ui.mdc.Field Field}
|
|
1044
|
-
* control
|
|
1130
|
+
* Field help assigned to the {@link sap.ui.mdc.Field Field}, {@link sap.ui.mdc.FilterField FilterField},
|
|
1131
|
+
* or {@link sap.ui.mdc.MultiValueField MultiValueField} control
|
|
1045
1132
|
*/
|
|
1046
1133
|
oValueHelp: ValueHelp,
|
|
1047
1134
|
/**
|
|
@@ -1079,10 +1166,13 @@ declare module "sap/ui/mdc/field/FieldBaseDelegate" {
|
|
|
1079
1166
|
| Promise<string | /* was: sap.ui.mdc.valuehelp.ValueHelpItem */ any>;
|
|
1080
1167
|
/**
|
|
1081
1168
|
* Determines the key, description, and payload of a user input.
|
|
1169
|
+
* By default, this method calls the {@link sap.ui.mdc.ValueHelp#getItemForValue getItemForValue} function
|
|
1170
|
+
* of the assigned {@link sap.ui.mdc.ValueHelp ValueHelp}.
|
|
1082
1171
|
*
|
|
1083
1172
|
* If this needs to be determined asynchronously, a `Promise` is returned.
|
|
1084
1173
|
*
|
|
1085
|
-
* If the item cannot be determined, a corresponding ParseException
|
|
1174
|
+
* If the item cannot be determined, a corresponding {@link sap.ui.model.ParseException ParseException }
|
|
1175
|
+
* is thrown.
|
|
1086
1176
|
*
|
|
1087
1177
|
*
|
|
1088
1178
|
* @returns Object containing description, key, and payload. If it is not available right now (must be requested),
|
|
@@ -1094,8 +1184,8 @@ declare module "sap/ui/mdc/field/FieldBaseDelegate" {
|
|
|
1094
1184
|
*/
|
|
1095
1185
|
oField: FieldBase,
|
|
1096
1186
|
/**
|
|
1097
|
-
* Field help assigned to the {@link sap.ui.mdc.Field Field}
|
|
1098
|
-
* control
|
|
1187
|
+
* Field help assigned to the {@link sap.ui.mdc.Field Field}, {@link sap.ui.mdc.FilterField FilterField},
|
|
1188
|
+
* or {@link sap.ui.mdc.MultiValueField MultiValueField} control
|
|
1099
1189
|
*/
|
|
1100
1190
|
oValueHelp: ValueHelp,
|
|
1101
1191
|
/**
|
|
@@ -1105,27 +1195,82 @@ declare module "sap/ui/mdc/field/FieldBaseDelegate" {
|
|
|
1105
1195
|
): /* was: sap.ui.mdc.valuehelp.ValueHelpItem */
|
|
1106
1196
|
| any
|
|
1107
1197
|
| Promise</* was: sap.ui.mdc.valuehelp.ValueHelpItem */ any>;
|
|
1198
|
+
/**
|
|
1199
|
+
* Checks if entered text matches text found from value help
|
|
1200
|
+
*
|
|
1201
|
+
* This function is called during a user's type-ahead into a {@link sap.ui.mdc.Field Field}, {@link sap.ui.mdc.FilterField FilterField},
|
|
1202
|
+
* or {@link sap.ui.mdc.MultiValueField MultiValueField} control.
|
|
1203
|
+
*
|
|
1204
|
+
* By Default this method checks if the text starts with the user input. Depending of the `bCaseSensitive`
|
|
1205
|
+
* parameter this check is performed case sensitive.
|
|
1206
|
+
*
|
|
1207
|
+
*
|
|
1208
|
+
* @returns `true` if text matches user input
|
|
1209
|
+
*/
|
|
1210
|
+
isInputMatchingText(
|
|
1211
|
+
/**
|
|
1212
|
+
* `Field` control instance
|
|
1213
|
+
*/
|
|
1214
|
+
oField: FieldBase,
|
|
1215
|
+
/**
|
|
1216
|
+
* Currently typed text (Could be changed when the type-ahed result is returned asynchronously.)
|
|
1217
|
+
*/
|
|
1218
|
+
sUserInput: string,
|
|
1219
|
+
/**
|
|
1220
|
+
* Text to be checked
|
|
1221
|
+
*/
|
|
1222
|
+
sText: string,
|
|
1223
|
+
/**
|
|
1224
|
+
* If `true` this text is the description
|
|
1225
|
+
*/
|
|
1226
|
+
bDescription: boolean,
|
|
1227
|
+
/**
|
|
1228
|
+
* If `true` the filtering was done case sensitive
|
|
1229
|
+
*/
|
|
1230
|
+
bCaseSensitive: boolean
|
|
1231
|
+
): boolean;
|
|
1108
1232
|
}
|
|
1109
1233
|
const FieldBaseDelegate: FieldBaseDelegate;
|
|
1110
1234
|
export default FieldBaseDelegate;
|
|
1235
|
+
}
|
|
1236
|
+
|
|
1237
|
+
declare module "sap/ui/mdc/field/MultiValueFieldDelegate" {
|
|
1238
|
+
import FieldBaseDelegate from "sap/ui/mdc/field/FieldBaseDelegate";
|
|
1239
|
+
|
|
1240
|
+
import { ConditionObject } from "sap/ui/mdc/condition/Condition";
|
|
1241
|
+
|
|
1242
|
+
import MultiValueField from "sap/ui/mdc/MultiValueField";
|
|
1111
1243
|
|
|
1112
1244
|
/**
|
|
1113
|
-
*
|
|
1245
|
+
* Delegate for {@link sap.ui.mdc.MultiValueField MultiValueField}.
|
|
1246
|
+
*
|
|
1247
|
+
* @since 1.93.0
|
|
1114
1248
|
*/
|
|
1115
|
-
|
|
1249
|
+
interface MultiValueFieldDelegate extends FieldBaseDelegate {
|
|
1116
1250
|
/**
|
|
1117
|
-
*
|
|
1118
|
-
|
|
1119
|
-
|
|
1120
|
-
|
|
1121
|
-
* Start of the selected text
|
|
1122
|
-
*/
|
|
1123
|
-
selectionStart: int;
|
|
1124
|
-
/**
|
|
1125
|
-
* End of the selected text
|
|
1251
|
+
* Implements the model-specific logic to update items after conditions have been updated.
|
|
1252
|
+
*
|
|
1253
|
+
* Items can be removed, updated, or added. Use the binding information of the `MultiValueField` control
|
|
1254
|
+
* to update the data in the model.
|
|
1126
1255
|
*/
|
|
1127
|
-
|
|
1128
|
-
|
|
1256
|
+
updateItems(
|
|
1257
|
+
/**
|
|
1258
|
+
* Payload for delegate
|
|
1259
|
+
*/
|
|
1260
|
+
oPayload: object,
|
|
1261
|
+
/**
|
|
1262
|
+
* Current conditions of the `MultiValueField` control
|
|
1263
|
+
*/
|
|
1264
|
+
aConditions: ConditionObject[],
|
|
1265
|
+
/**
|
|
1266
|
+
* Current `MultiValueField` control to determine binding information to update the values of the corresponding
|
|
1267
|
+
* model
|
|
1268
|
+
*/
|
|
1269
|
+
oMultiValueField: MultiValueField
|
|
1270
|
+
): void;
|
|
1271
|
+
}
|
|
1272
|
+
const MultiValueFieldDelegate: MultiValueFieldDelegate;
|
|
1273
|
+
export default MultiValueFieldDelegate;
|
|
1129
1274
|
}
|
|
1130
1275
|
|
|
1131
1276
|
declare module "sap/ui/mdc/FilterBarDelegate" {
|
|
@@ -1331,9 +1476,11 @@ declare module "sap/ui/mdc/LinkDelegate" {
|
|
|
1331
1476
|
interface LinkDelegate extends BaseDelegate {
|
|
1332
1477
|
/**
|
|
1333
1478
|
* Allows for interception before the actual navigation takes place.
|
|
1479
|
+
* By default, this method returns a `Promise` that resolves into `true`.
|
|
1334
1480
|
*
|
|
1335
1481
|
*
|
|
1336
|
-
* @returns Once resolved,
|
|
1482
|
+
* @returns Once resolved, this method returns a boolean value that determines whether the navigation
|
|
1483
|
+
* takes place
|
|
1337
1484
|
*/
|
|
1338
1485
|
beforeNavigationCallback(
|
|
1339
1486
|
/**
|
|
@@ -1347,6 +1494,7 @@ declare module "sap/ui/mdc/LinkDelegate" {
|
|
|
1347
1494
|
): Promise<boolean>;
|
|
1348
1495
|
/**
|
|
1349
1496
|
* Retrieves and returns the relevant `additionalContent` for the `Link` control as an array.
|
|
1497
|
+
* By default, this method returns a `Promise` that resolves into an empty array.
|
|
1350
1498
|
*
|
|
1351
1499
|
*
|
|
1352
1500
|
* @returns Once resolved, an array of {@link sap.ui.core.Control} is returned
|
|
@@ -1359,6 +1507,7 @@ declare module "sap/ui/mdc/LinkDelegate" {
|
|
|
1359
1507
|
): Promise<Control[]>;
|
|
1360
1508
|
/**
|
|
1361
1509
|
* Retrieves and returns the relevant {@link sap.ui.mdc.link.LinkItem} for the `Link` control.
|
|
1510
|
+
* By default, this method returns a `Promise` that resolves into `null`.
|
|
1362
1511
|
*
|
|
1363
1512
|
*
|
|
1364
1513
|
* @returns Once resolved, `null` or an array of {@link sap.ui.mdc.link.LinkItem} is returned If `null`
|
|
@@ -1380,6 +1529,10 @@ declare module "sap/ui/mdc/LinkDelegate" {
|
|
|
1380
1529
|
): Promise<null | LinkItem[]>;
|
|
1381
1530
|
/**
|
|
1382
1531
|
* Calculates and returns the type of link that is displayed.
|
|
1532
|
+
* By default, this method returns a `Promise` that resolves into a {@link sap.ui.mdc.link.LinkTypeWrapper LinkTypeWrapper}.
|
|
1533
|
+
* The {@link sap.ui.mdc.link.LinkTypeWrapper LinkTypeWrapper} contains an `initialType` and a `runtimeType`
|
|
1534
|
+
* {@link sap.ui.mdc.link.LinkType LinkType}. The `initialType` has a `type` property of type `Popover`
|
|
1535
|
+
* and a `directLink` property of type `undefined`. The `runtimeType` is of type `null`.
|
|
1383
1536
|
*
|
|
1384
1537
|
*
|
|
1385
1538
|
* @returns Once resolved, a {@link sap.ui.mdc.link.LinkTypeWrapper} containing an initial {@link sap.ui.mdc.link.LinkType }
|
|
@@ -1393,9 +1546,42 @@ declare module "sap/ui/mdc/LinkDelegate" {
|
|
|
1393
1546
|
*/
|
|
1394
1547
|
oLink: Link
|
|
1395
1548
|
): Promise<LinkTypeWrapper>;
|
|
1549
|
+
/**
|
|
1550
|
+
* Enables the modification of the {@link sap.m.ResponsivePopover#title} property and setting which `Control`
|
|
1551
|
+
* should be added to the `ariaLabelledBy` association.
|
|
1552
|
+
*
|
|
1553
|
+
*
|
|
1554
|
+
* @returns Once resolved, an `Object` containing the title string and an `Control` which is referenced
|
|
1555
|
+
* as arialabelledBy.
|
|
1556
|
+
*/
|
|
1557
|
+
fetchPopoverTitle(
|
|
1558
|
+
/**
|
|
1559
|
+
* Instance of the `Link`
|
|
1560
|
+
*/
|
|
1561
|
+
oLink: Link,
|
|
1562
|
+
/**
|
|
1563
|
+
* Instance of the `Panel`
|
|
1564
|
+
*/
|
|
1565
|
+
oPanel: /* was: sap.ui.mdc.link.Panel */ any
|
|
1566
|
+
): any;
|
|
1567
|
+
/**
|
|
1568
|
+
* Allows to differenciate the created `Panel` of multiple `Link` instances for personalization reasons.
|
|
1569
|
+
* Please provide different IDs for each `Link` as otherwise the personalization will have problems keeping
|
|
1570
|
+
* the `Panel` controls apart.
|
|
1571
|
+
*
|
|
1572
|
+
*
|
|
1573
|
+
* @returns The ID of the `Panel` that is created by the `Link`
|
|
1574
|
+
*/
|
|
1575
|
+
getPanelId(
|
|
1576
|
+
/**
|
|
1577
|
+
* Instance of the `Link`
|
|
1578
|
+
*/
|
|
1579
|
+
oLink: Link
|
|
1580
|
+
): string;
|
|
1396
1581
|
/**
|
|
1397
1582
|
* Enables the modification of the {@link sap.ui.mdc.link.LinkItem} instances before the popover opens.
|
|
1398
1583
|
* This enables additional parameters to be added to the link.
|
|
1584
|
+
* By default, this method returns a `Promise` that resolves into the passed `aLinkItems` array.
|
|
1399
1585
|
*
|
|
1400
1586
|
*
|
|
1401
1587
|
* @returns Once resolved, an array of link items is returned
|
|
@@ -1410,9 +1596,9 @@ declare module "sap/ui/mdc/LinkDelegate" {
|
|
|
1410
1596
|
*/
|
|
1411
1597
|
oBindingContext: Context | null | undefined,
|
|
1412
1598
|
/**
|
|
1413
|
-
*
|
|
1599
|
+
* Array of {@link sap.ui.mdc.link.LinkItem} instances of the link that can be modified
|
|
1414
1600
|
*/
|
|
1415
|
-
aLinkItems: LinkItem
|
|
1601
|
+
aLinkItems: LinkItem[]
|
|
1416
1602
|
): Promise<LinkItem[]>;
|
|
1417
1603
|
}
|
|
1418
1604
|
const LinkDelegate: LinkDelegate;
|
|
@@ -1423,9 +1609,9 @@ declare module "sap/ui/mdc/odata/TypeMap" {
|
|
|
1423
1609
|
import DefaultTypeMap from "sap/ui/mdc/DefaultTypeMap";
|
|
1424
1610
|
|
|
1425
1611
|
/**
|
|
1426
|
-
* OData-specific {@link sap
|
|
1612
|
+
* OData-specific {@link module:sap/ui/mdc/util/TypeMap TypeMap} configuration.
|
|
1427
1613
|
*
|
|
1428
|
-
* **Note:** This
|
|
1614
|
+
* **Note:** This `TypeMap` implementation contains the following types:
|
|
1429
1615
|
*
|
|
1430
1616
|
*
|
|
1431
1617
|
* - {@link sap.ui.model.type.Boolean} (alias `Boolean`)
|
|
@@ -1489,19 +1675,31 @@ declare module "sap/ui/mdc/odata/v4/TableDelegate" {
|
|
|
1489
1675
|
import ListBinding from "sap/ui/model/ListBinding";
|
|
1490
1676
|
|
|
1491
1677
|
/**
|
|
1492
|
-
*
|
|
1678
|
+
* Base delegate for {@link sap.ui.mdc.Table} and `ODataV4`.
|
|
1679
|
+
*
|
|
1680
|
+
* Extend this object in your project to use all functionalities of the table. For more information, please
|
|
1681
|
+
* see {@link module:sap/ui/mdc/TableDelegate}.
|
|
1682
|
+
*
|
|
1683
|
+
* **Note:** This base delegate supports the `p13nMode` `Aggregate` only if the table type is {@link sap.ui.mdc.table.GridTableType GridTable},
|
|
1684
|
+
* and the `p13nMode` `Group` is not supported if the table type is {@link sap.ui.mdc.table.TreeTableType TreeTable}.
|
|
1685
|
+
* This cannot be changed in your delegate implementation.
|
|
1493
1686
|
*
|
|
1494
1687
|
* @since 1.85
|
|
1495
1688
|
*/
|
|
1496
1689
|
interface TableDelegate extends TableDelegate1 {
|
|
1497
1690
|
/**
|
|
1498
|
-
* Updates the
|
|
1691
|
+
* Updates the binding of the table with the binding info object returned from {@link module:sap/ui/mdc/TableDelegate.updateBindingInfo updateBindingInfo}.
|
|
1692
|
+
* If an update is not possible, it rebinds the table.
|
|
1499
1693
|
*
|
|
1500
|
-
* Compares the current and previous state of the table to detect whether rebinding is necessary
|
|
1501
|
-
*
|
|
1502
|
-
*
|
|
1503
|
-
*
|
|
1504
|
-
*
|
|
1694
|
+
* Compares the current and previous state of the table to detect whether rebinding is necessary. The diffing
|
|
1695
|
+
* is done for the sorters, filters, aggregation, parameters, and the path of the binding. Other {@link sap.ui.base.ManagedObject.AggregationBindingInfo binding info }
|
|
1696
|
+
* keys, such as `events` or `model`, must be provided in `updateBindingInfo`, and those keys must not be
|
|
1697
|
+
* changed conditionally.
|
|
1698
|
+
*
|
|
1699
|
+
* **Note:** To remove a binding info parameter, the value must be set to `undefined` in `updateBindingInfo`.
|
|
1700
|
+
* For more information, see {@link sap.ui.model.odata.v4.ODataListBinding#changeParameters}.
|
|
1701
|
+
* See:
|
|
1702
|
+
* rebind
|
|
1505
1703
|
*
|
|
1506
1704
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1507
1705
|
*/
|
|
@@ -1511,11 +1709,11 @@ declare module "sap/ui/mdc/odata/v4/TableDelegate" {
|
|
|
1511
1709
|
*/
|
|
1512
1710
|
oTable: Table,
|
|
1513
1711
|
/**
|
|
1514
|
-
* The binding info object to be used to bind the table
|
|
1712
|
+
* The binding info object to be used to bind the table
|
|
1515
1713
|
*/
|
|
1516
1714
|
oBindingInfo: AggregationBindingInfo,
|
|
1517
1715
|
/**
|
|
1518
|
-
* The binding instance of the table
|
|
1716
|
+
* The binding instance of the table that can be used to update the binding and avoid a rebind
|
|
1519
1717
|
*/
|
|
1520
1718
|
oBinding?: ListBinding,
|
|
1521
1719
|
/**
|
|
@@ -1523,7 +1721,7 @@ declare module "sap/ui/mdc/odata/v4/TableDelegate" {
|
|
|
1523
1721
|
*/
|
|
1524
1722
|
mSettings?: {
|
|
1525
1723
|
/**
|
|
1526
|
-
* Indicates that the binding has to be refreshed even if
|
|
1724
|
+
* Indicates that the binding has to be refreshed even if the binding info has not changed
|
|
1527
1725
|
*/
|
|
1528
1726
|
forceRefresh?: boolean;
|
|
1529
1727
|
}
|
|
@@ -1537,10 +1735,9 @@ declare module "sap/ui/mdc/odata/v4/TypeMap" {
|
|
|
1537
1735
|
import TypeMap1 from "sap/ui/mdc/odata/TypeMap";
|
|
1538
1736
|
|
|
1539
1737
|
/**
|
|
1540
|
-
* ODataV4-specific {@link sap
|
|
1738
|
+
* ODataV4-specific {@link module:sap/ui/mdc/util/TypeMap TypeMap} configuration.
|
|
1541
1739
|
*
|
|
1542
|
-
* **Note:** This
|
|
1543
|
-
* ODataV4-specific configuration:
|
|
1740
|
+
* **Note:** This `TypeMap` implementation contains the following types including ODataV4-specific configuration:
|
|
1544
1741
|
*
|
|
1545
1742
|
*
|
|
1546
1743
|
* - {@link sap.ui.model.type.Boolean} (alias `Boolean`)
|
|
@@ -1582,7 +1779,9 @@ declare module "sap/ui/mdc/odata/v4/TypeMap" {
|
|
|
1582
1779
|
declare module "sap/ui/mdc/TableDelegate" {
|
|
1583
1780
|
import AggregationBaseDelegate from "sap/ui/mdc/AggregationBaseDelegate";
|
|
1584
1781
|
|
|
1585
|
-
import Table from "sap/ui/mdc/Table";
|
|
1782
|
+
import { default as Table, PropertyInfo } from "sap/ui/mdc/Table";
|
|
1783
|
+
|
|
1784
|
+
import Column from "sap/ui/mdc/table/Column";
|
|
1586
1785
|
|
|
1587
1786
|
import Context from "sap/ui/model/Context";
|
|
1588
1787
|
|
|
@@ -1597,56 +1796,115 @@ declare module "sap/ui/mdc/TableDelegate" {
|
|
|
1597
1796
|
import ListBinding from "sap/ui/model/ListBinding";
|
|
1598
1797
|
|
|
1599
1798
|
/**
|
|
1600
|
-
* Base delegate for {@link sap.ui.mdc.Table}.
|
|
1799
|
+
* Base delegate for {@link sap.ui.mdc.Table}. Extend this object in your project to use all functionalities
|
|
1800
|
+
* of the table. This base delegate already meets some requirements of certain features. Others need to
|
|
1801
|
+
* be met by your delegate implementation.
|
|
1802
|
+
*
|
|
1803
|
+
* The following methods need to be added or overridden in your delegate. Please also see the documentation
|
|
1804
|
+
* of the methods to learn about their default implementation and what you need to implement.
|
|
1805
|
+
* - `Basic prerequisites`
|
|
1806
|
+
* - {@link module:sap/ui/mdc/TableDelegate.fetchProperties fetchProperties}
|
|
1807
|
+
* - {@link module:sap/ui/mdc/TableDelegate.updateBindingInfo updateBindingInfo}
|
|
1808
|
+
* - Column personalization (related to `p13nMode` `Column`)
|
|
1809
|
+
* - {@link module:sap/ui/mdc/TableDelegate.addItem addItem}
|
|
1810
|
+
* - Filter personalization (related to `p13nMode` `Filter`)
|
|
1811
|
+
* - {@link module:sap/ui/mdc/TableDelegate.getFilterDelegate getFilterDelegate}
|
|
1812
|
+
*
|
|
1813
|
+
* **Note:** This base delegate does not support the `p13nMode` `Aggregate`, and the `p13nMode` `Group`
|
|
1814
|
+
* is only supported if the table type is {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}.
|
|
1815
|
+
* This cannot be changed in your delegate implementation.
|
|
1601
1816
|
*
|
|
1602
1817
|
* @since 1.60
|
|
1603
1818
|
*/
|
|
1604
1819
|
interface TableDelegate extends AggregationBaseDelegate {
|
|
1605
1820
|
/**
|
|
1606
|
-
*
|
|
1821
|
+
* Central hook that is called to add columns to the table when the state is applied, for example, when
|
|
1822
|
+
* SAPUI5 flexibility changes are applied. During preprocessing, this method is called without the `mPropertyBag`
|
|
1823
|
+
* parameter, and `oTable` is an XML node.
|
|
1824
|
+
*
|
|
1825
|
+
* By default, this method does not create a column and just returns a `Promise` that resolves without a
|
|
1826
|
+
* value.
|
|
1827
|
+
*
|
|
1828
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1829
|
+
*
|
|
1830
|
+
* @returns A `Promise` that resolves with a column
|
|
1831
|
+
*/
|
|
1832
|
+
addItem(
|
|
1833
|
+
/**
|
|
1834
|
+
* Instance of the table or an XML node representing the table during preprocessing
|
|
1835
|
+
*/
|
|
1836
|
+
oTable: Table | Element,
|
|
1837
|
+
/**
|
|
1838
|
+
* The property name
|
|
1839
|
+
*/
|
|
1840
|
+
sPropertyName: string,
|
|
1841
|
+
/**
|
|
1842
|
+
* Instance of a property bag from the SAPUI5 flexibility API
|
|
1843
|
+
*/
|
|
1844
|
+
mPropertyBag?: Object
|
|
1845
|
+
): Promise<Column>;
|
|
1846
|
+
/**
|
|
1847
|
+
* Collapses all rows.
|
|
1607
1848
|
*
|
|
1608
1849
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1609
1850
|
*/
|
|
1610
|
-
|
|
1851
|
+
collapseAllRows(
|
|
1611
1852
|
/**
|
|
1612
|
-
* Instance of the
|
|
1853
|
+
* Instance of the table
|
|
1613
1854
|
*/
|
|
1614
1855
|
oTable: Table
|
|
1615
1856
|
): void;
|
|
1616
1857
|
/**
|
|
1617
|
-
* Expands all
|
|
1858
|
+
* Expands all rows.
|
|
1618
1859
|
*
|
|
1619
1860
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1620
1861
|
*/
|
|
1621
|
-
|
|
1862
|
+
expandAllRows(
|
|
1622
1863
|
/**
|
|
1623
|
-
* Instance of the
|
|
1864
|
+
* Instance of the table
|
|
1624
1865
|
*/
|
|
1625
1866
|
oTable: Table
|
|
1626
1867
|
): void;
|
|
1627
1868
|
/**
|
|
1628
|
-
* Returns the feature set for exporting data in the
|
|
1869
|
+
* Returns the feature set for exporting data in the table.
|
|
1870
|
+
*
|
|
1871
|
+
* By default, this method returns basic `sap.ui.export.FileType.XLSX` capabilities.
|
|
1629
1872
|
*
|
|
1630
1873
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1631
1874
|
*
|
|
1632
|
-
* @returns
|
|
1875
|
+
* @returns A `Promise` that resolves with an object as specified in {@link sap.ui.export.ExportHandler}
|
|
1633
1876
|
*/
|
|
1634
1877
|
fetchExportCapabilities(
|
|
1635
1878
|
/**
|
|
1636
|
-
* Instance of the
|
|
1879
|
+
* Instance of the table
|
|
1637
1880
|
*/
|
|
1638
1881
|
oTable: Table
|
|
1639
|
-
): Promise<
|
|
1882
|
+
): Promise<object>;
|
|
1883
|
+
/**
|
|
1884
|
+
* Retrieves information about the relevant properties.
|
|
1885
|
+
*
|
|
1886
|
+
* By default, this method returns a `Promise` that resolves with an empty array.
|
|
1887
|
+
*
|
|
1888
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1889
|
+
*
|
|
1890
|
+
* @returns A `Promise` that resolves with the property information
|
|
1891
|
+
*/
|
|
1892
|
+
fetchProperties(
|
|
1893
|
+
/**
|
|
1894
|
+
* Instance of the table
|
|
1895
|
+
*/
|
|
1896
|
+
oTable: Table
|
|
1897
|
+
): Promise<PropertyInfo[]>;
|
|
1640
1898
|
/**
|
|
1641
1899
|
* Formats the title text of a group header row of the table.
|
|
1642
1900
|
*
|
|
1643
1901
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1644
1902
|
*
|
|
1645
|
-
* @returns The group header title
|
|
1903
|
+
* @returns The group header title
|
|
1646
1904
|
*/
|
|
1647
1905
|
formatGroupHeader(
|
|
1648
1906
|
/**
|
|
1649
|
-
* Instance of the
|
|
1907
|
+
* Instance of the table
|
|
1650
1908
|
*/
|
|
1651
1909
|
oTable: Table,
|
|
1652
1910
|
/**
|
|
@@ -1654,14 +1912,17 @@ declare module "sap/ui/mdc/TableDelegate" {
|
|
|
1654
1912
|
*/
|
|
1655
1913
|
oContext: Context,
|
|
1656
1914
|
/**
|
|
1657
|
-
*
|
|
1915
|
+
* Name of the grouped property
|
|
1658
1916
|
*/
|
|
1659
1917
|
sProperty: string
|
|
1660
|
-
): string
|
|
1918
|
+
): string;
|
|
1661
1919
|
/**
|
|
1662
1920
|
* Returns the filter delegate of the table that provides basic filter functionality, such as adding filter
|
|
1663
|
-
* fields.
|
|
1664
|
-
*
|
|
1921
|
+
* fields.
|
|
1922
|
+
*
|
|
1923
|
+
* **Note:** The functionality provided in this delegate acts as a subset of a `FilterBarDelegate` to enable
|
|
1924
|
+
* the table for inbuilt filtering.
|
|
1925
|
+
*
|
|
1665
1926
|
*
|
|
1666
1927
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1667
1928
|
*
|
|
@@ -1671,8 +1932,10 @@ declare module "sap/ui/mdc/TableDelegate" {
|
|
|
1671
1932
|
addItem: (p1: Table, p2: string) => Promise<FilterField>;
|
|
1672
1933
|
};
|
|
1673
1934
|
/**
|
|
1674
|
-
* Returns filters
|
|
1675
|
-
*
|
|
1935
|
+
* Returns filters to be applied when updating the table's binding based on the filter conditions of the
|
|
1936
|
+
* table itself and its associated {@link sap.ui.mdc.IFilterSource IFilterSource}.
|
|
1937
|
+
*
|
|
1938
|
+
* By default, filters for the associated filter source are only generated for a `sap.ui.mdc.FilterBar`.
|
|
1676
1939
|
*
|
|
1677
1940
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1678
1941
|
*
|
|
@@ -1685,43 +1948,49 @@ declare module "sap/ui/mdc/TableDelegate" {
|
|
|
1685
1948
|
oTable: Table
|
|
1686
1949
|
): Filter[];
|
|
1687
1950
|
/**
|
|
1688
|
-
*
|
|
1951
|
+
* Returns a sorter for the grouping functionality to be applied when updating the table's binding based
|
|
1952
|
+
* on the group conditions of the table.
|
|
1953
|
+
*
|
|
1954
|
+
* **Note:** No sorter must be returned if the table type, for example, {@link sap.ui.mdc.table.GridTableType GridTable},
|
|
1955
|
+
* cannot be grouped this way.
|
|
1689
1956
|
*
|
|
1690
1957
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1691
1958
|
*
|
|
1692
|
-
* @returns
|
|
1959
|
+
* @returns The sorter or `undefined` if there is no group condition or if it cannot be applied
|
|
1693
1960
|
*/
|
|
1694
1961
|
getGroupSorter(
|
|
1695
1962
|
/**
|
|
1696
|
-
* Instance of the
|
|
1963
|
+
* Instance of the table
|
|
1697
1964
|
*/
|
|
1698
1965
|
oTable: Table
|
|
1699
1966
|
): Sorter | undefined;
|
|
1700
1967
|
/**
|
|
1701
|
-
* Returns
|
|
1968
|
+
* Returns sorters to be applied when updating the table's binding based on the sort conditions of the table.
|
|
1702
1969
|
*
|
|
1703
1970
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1704
1971
|
*
|
|
1705
|
-
* @returns
|
|
1972
|
+
* @returns Array of sorters
|
|
1706
1973
|
*/
|
|
1707
1974
|
getSorters(
|
|
1708
1975
|
/**
|
|
1709
|
-
* Instance of the
|
|
1976
|
+
* Instance of the table
|
|
1710
1977
|
*/
|
|
1711
1978
|
oTable: Table
|
|
1712
1979
|
): Sorter[];
|
|
1713
1980
|
/**
|
|
1714
|
-
* Rebinds the table.
|
|
1981
|
+
* Rebinds the table with the binding info object returned from {@link module:sap/ui/mdc/TableDelegate.updateBindingInfo updateBindingInfo}.
|
|
1982
|
+
* See:
|
|
1983
|
+
* updateBinding
|
|
1715
1984
|
*
|
|
1716
1985
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1717
1986
|
*/
|
|
1718
1987
|
rebind(
|
|
1719
1988
|
/**
|
|
1720
|
-
* Instance of the
|
|
1989
|
+
* Instance of the table
|
|
1721
1990
|
*/
|
|
1722
1991
|
oTable: Table,
|
|
1723
1992
|
/**
|
|
1724
|
-
* The binding info object
|
|
1993
|
+
* The binding info object used to bind the table
|
|
1725
1994
|
*/
|
|
1726
1995
|
oBindingInfo: AggregationBindingInfo
|
|
1727
1996
|
): void;
|
|
@@ -1757,17 +2026,24 @@ declare module "sap/ui/mdc/TableDelegate" {
|
|
|
1757
2026
|
}
|
|
1758
2027
|
): void;
|
|
1759
2028
|
/**
|
|
1760
|
-
*
|
|
2029
|
+
* Updates the binding info object that is used to bind the table in {@link module:sap/ui/mdc/TableDelegate.updateBinding updateBinding}.
|
|
2030
|
+
*
|
|
2031
|
+
* By default, filters and sorters are added to the binding info. Please see {@link module:sap/ui/mdc/TableDelegate.getFilters getFilters},
|
|
2032
|
+
* {@link module:sap/ui/mdc/TableDelegate.getSorters getSorters}, and {@link module:sap/ui/mdc/TableDelegate.getGroupSorter getGroupSorter }
|
|
2033
|
+
* for more details.
|
|
2034
|
+
*
|
|
2035
|
+
* **Note:** Any other required information, such as the path, must be additionally provided by your delegate
|
|
2036
|
+
* implementation.
|
|
1761
2037
|
*
|
|
1762
2038
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1763
2039
|
*/
|
|
1764
2040
|
updateBindingInfo(
|
|
1765
2041
|
/**
|
|
1766
|
-
* Instance of the
|
|
2042
|
+
* Instance of the table
|
|
1767
2043
|
*/
|
|
1768
2044
|
oTable: Table,
|
|
1769
2045
|
/**
|
|
1770
|
-
* The binding info
|
|
2046
|
+
* The binding info
|
|
1771
2047
|
*/
|
|
1772
2048
|
oBindingInfo: AggregationBindingInfo
|
|
1773
2049
|
): void;
|
|
@@ -1782,7 +2058,7 @@ declare module "sap/ui/mdc/util/TypeMap" {
|
|
|
1782
2058
|
import BaseType from "sap/ui/mdc/enums/BaseType";
|
|
1783
2059
|
|
|
1784
2060
|
/**
|
|
1785
|
-
* Configuration class for type
|
|
2061
|
+
* Configuration class for type handling in delegates. Allows mapping of model types to {@link sap.ui.mdc.enums.BaseType }
|
|
1786
2062
|
* and enables model-specific type configuration.
|
|
1787
2063
|
*
|
|
1788
2064
|
* **Note:** This utility is experimental and the API/behavior is not finalized. Hence, it should not be
|
|
@@ -1792,7 +2068,7 @@ declare module "sap/ui/mdc/util/TypeMap" {
|
|
|
1792
2068
|
*/
|
|
1793
2069
|
interface TypeMap {
|
|
1794
2070
|
/**
|
|
1795
|
-
* Exports the
|
|
2071
|
+
* Exports the current data of the `TypeMap`.
|
|
1796
2072
|
*
|
|
1797
2073
|
*
|
|
1798
2074
|
* @returns `Array` created from this `TypeMap`'s internal `Map`
|
|
@@ -1803,7 +2079,7 @@ declare module "sap/ui/mdc/util/TypeMap" {
|
|
|
1803
2079
|
*
|
|
1804
2080
|
* The value is not checked for validity. The used values must be compatible with the used basic type.
|
|
1805
2081
|
*
|
|
1806
|
-
* **Note:** Number types are not converted, the number conversion is done by the SAPUI5
|
|
2082
|
+
* **Note:** Number types are not converted, the number conversion is done by the SAPUI5 flexibility handling.
|
|
1807
2083
|
*
|
|
1808
2084
|
*
|
|
1809
2085
|
* @returns Converted value
|
|
@@ -1827,18 +2103,19 @@ declare module "sap/ui/mdc/util/TypeMap" {
|
|
|
1827
2103
|
oConstraints?: object
|
|
1828
2104
|
): string;
|
|
1829
2105
|
/**
|
|
1830
|
-
* Prevents further
|
|
2106
|
+
* Prevents further modification of the data of a `TypeMap`.
|
|
1831
2107
|
*/
|
|
1832
2108
|
freeze(): void;
|
|
1833
2109
|
/**
|
|
1834
|
-
* To determine which internal controls to render, the {@link sap.ui.mdc.Field Field}, {@link sap.ui.mdc.MultiValueField MultiValueField},
|
|
1835
|
-
* or {@link sap.ui.mdc.FilterField FilterField}
|
|
1836
|
-
* a `number`, or another {@link sap.ui.mdc.enums.BaseType BaseType}.
|
|
2110
|
+
* To determine which internal controls to render, either the {@link sap.ui.mdc.Field Field}, the {@link sap.ui.mdc.MultiValueField MultiValueField},
|
|
2111
|
+
* or the {@link sap.ui.mdc.FilterField FilterField} control needs information about whether the type represents
|
|
2112
|
+
* a `date`, a `number`, or another {@link sap.ui.mdc.enums.BaseType BaseType}.
|
|
1837
2113
|
*
|
|
1838
2114
|
* As default, `string` is returned.
|
|
1839
2115
|
*
|
|
1840
2116
|
*
|
|
1841
|
-
* @returns Corresponding {@link sap.ui.mdc.enums.BaseType BaseType},
|
|
2117
|
+
* @returns Corresponding {@link sap.ui.mdc.enums.BaseType BaseType}, for example, `Date`, `DateTime` or
|
|
2118
|
+
* `Time`
|
|
1842
2119
|
*/
|
|
1843
2120
|
getBaseType(
|
|
1844
2121
|
/**
|
|
@@ -1858,7 +2135,8 @@ declare module "sap/ui/mdc/util/TypeMap" {
|
|
|
1858
2135
|
* Convenience method to retrieve the `BaseType` for a given {@link sap.ui.model.SimpleType SimpleType}.
|
|
1859
2136
|
*
|
|
1860
2137
|
*
|
|
1861
|
-
* @returns Corresponding {@link sap.ui.mdc.enums.BaseType BaseType},
|
|
2138
|
+
* @returns Corresponding {@link sap.ui.mdc.enums.BaseType BaseType}, for example, `Date`, `DateTime` or
|
|
2139
|
+
* `Time`
|
|
1862
2140
|
*/
|
|
1863
2141
|
getBaseTypeForType(
|
|
1864
2142
|
/**
|
|
@@ -1888,7 +2166,7 @@ declare module "sap/ui/mdc/util/TypeMap" {
|
|
|
1888
2166
|
*/
|
|
1889
2167
|
getDataTypeClassName(
|
|
1890
2168
|
/**
|
|
1891
|
-
* Given model
|
|
2169
|
+
* Given model-specific type
|
|
1892
2170
|
*/
|
|
1893
2171
|
sType: string
|
|
1894
2172
|
): string;
|
|
@@ -1937,11 +2215,11 @@ declare module "sap/ui/mdc/util/TypeMap" {
|
|
|
1937
2215
|
oConstraints?: object
|
|
1938
2216
|
): /* was: sap.ui.mdc.TypeConfig */ any;
|
|
1939
2217
|
/**
|
|
1940
|
-
* Imports a `TypeMap`
|
|
2218
|
+
* Imports the data of a `TypeMap` into another `TypeMap`.
|
|
1941
2219
|
*/
|
|
1942
2220
|
import(
|
|
1943
2221
|
/**
|
|
1944
|
-
* `TypeMap`
|
|
2222
|
+
* `TypeMap` that gets imported
|
|
1945
2223
|
*/
|
|
1946
2224
|
oTypeMap: TypeMap
|
|
1947
2225
|
): void;
|
|
@@ -1950,7 +2228,7 @@ declare module "sap/ui/mdc/util/TypeMap" {
|
|
|
1950
2228
|
*
|
|
1951
2229
|
* The value is not checked for validity. The used values must be compatible with the used basic type.
|
|
1952
2230
|
*
|
|
1953
|
-
* **Note:** Number types are not converted. The number conversion is done by the SAPUI5
|
|
2231
|
+
* **Note:** Number types are not converted. The number conversion is done by the SAPUI5 flexibility handling.
|
|
1954
2232
|
*
|
|
1955
2233
|
*
|
|
1956
2234
|
* @returns Converted value
|
|
@@ -1977,7 +2255,7 @@ declare module "sap/ui/mdc/util/TypeMap" {
|
|
|
1977
2255
|
* Sets a {@link sap.ui.mdc.enums.BaseType BaseType} and an optional model- or scenario-specific configuration
|
|
1978
2256
|
* method for a given {@link sap.ui.model.SimpleType} `ObjectPath` `string`.
|
|
1979
2257
|
*
|
|
1980
|
-
* As default `string` is returned.
|
|
2258
|
+
* As default, `string` is returned.
|
|
1981
2259
|
*/
|
|
1982
2260
|
set(
|
|
1983
2261
|
/**
|
|
@@ -1990,13 +2268,13 @@ declare module "sap/ui/mdc/util/TypeMap" {
|
|
|
1990
2268
|
*/
|
|
1991
2269
|
vBaseType: (BaseType | keyof typeof BaseType) | Function,
|
|
1992
2270
|
/**
|
|
1993
|
-
* Optional customizing method for format options and constraints. See {@link sap
|
|
2271
|
+
* Optional customizing method for format options and constraints. See {@link module:sap/ui/mdc/DefaultTypeMap DefaultTypeMap }
|
|
1994
2272
|
* for examples.
|
|
1995
2273
|
*/
|
|
1996
2274
|
fnOptions?: Function
|
|
1997
2275
|
): void;
|
|
1998
2276
|
/**
|
|
1999
|
-
* Allows alternative identifiers for types, such as
|
|
2277
|
+
* Allows alternative identifiers for types, such as a Boolean for {@link sap.ui.model.type.Boolean}.
|
|
2000
2278
|
*/
|
|
2001
2279
|
setAlias(
|
|
2002
2280
|
/**
|
|
@@ -2029,7 +2307,9 @@ declare module "sap/ui/mdc/ValueHelpDelegate" {
|
|
|
2029
2307
|
|
|
2030
2308
|
import { ConditionObject } from "sap/ui/mdc/condition/Condition";
|
|
2031
2309
|
|
|
2032
|
-
import
|
|
2310
|
+
import { util } from "sap/ui/mdc/library";
|
|
2311
|
+
|
|
2312
|
+
import Filter from "sap/ui/model/Filter";
|
|
2033
2313
|
|
|
2034
2314
|
import ListContent from "sap/ui/mdc/valuehelp/base/ListContent";
|
|
2035
2315
|
|
|
@@ -2042,16 +2322,20 @@ declare module "sap/ui/mdc/ValueHelpDelegate" {
|
|
|
2042
2322
|
import { AggregationBindingInfo } from "sap/ui/base/ManagedObject";
|
|
2043
2323
|
|
|
2044
2324
|
/**
|
|
2045
|
-
* Delegate for {@link sap.ui.mdc.ValueHelp
|
|
2046
|
-
*
|
|
2047
|
-
*
|
|
2325
|
+
* Delegate for {@link sap.ui.mdc.ValueHelp}.
|
|
2326
|
+
*
|
|
2327
|
+
* **Note:** The class is experimental and the API/behavior is not finalized and hence this should not be
|
|
2328
|
+
* used for productive usage.
|
|
2048
2329
|
*
|
|
2049
2330
|
* @since 1.95.0
|
|
2050
2331
|
*/
|
|
2051
2332
|
interface ValueHelpDelegate extends BaseDelegate {
|
|
2052
2333
|
/**
|
|
2053
2334
|
* Checks if the `ListBinding` is waiting for an update. As long as the context has not been set for `ListBinding`,
|
|
2054
|
-
* `ValueHelp` needs to wait.
|
|
2335
|
+
* the `ValueHelp` needs to wait.
|
|
2336
|
+
* By default, this method returns `false` if no {@link sap.ui.model.ListBinding ListBinding} is available
|
|
2337
|
+
* or the given `ListBinding` is suspended. Otherwise, it returns a `Promise` that resolves into a `boolean`
|
|
2338
|
+
* value indicating that at least one context is available after retrieval.
|
|
2055
2339
|
*
|
|
2056
2340
|
*
|
|
2057
2341
|
* @returns `Promise` that is resolved once `ListBinding` has been updated
|
|
@@ -2073,6 +2357,7 @@ declare module "sap/ui/mdc/ValueHelpDelegate" {
|
|
|
2073
2357
|
/**
|
|
2074
2358
|
* Provides the possibility to convey custom data in conditions. This enables an application to enhance
|
|
2075
2359
|
* conditions with data relevant for combined key or out parameter scenarios.
|
|
2360
|
+
* By default, this method returns `undefined`.
|
|
2076
2361
|
*
|
|
2077
2362
|
* @since 1.101.0
|
|
2078
2363
|
*
|
|
@@ -2098,6 +2383,7 @@ declare module "sap/ui/mdc/ValueHelpDelegate" {
|
|
|
2098
2383
|
): undefined | object;
|
|
2099
2384
|
/**
|
|
2100
2385
|
* Executes a filter in a `ListBinding`.
|
|
2386
|
+
* By default, this method returns a `Promise` that resolves into the given `ListBinding`.
|
|
2101
2387
|
*
|
|
2102
2388
|
*
|
|
2103
2389
|
* @returns `Promise` that is resolved if search is executed
|
|
@@ -2117,10 +2403,11 @@ declare module "sap/ui/mdc/ValueHelpDelegate" {
|
|
|
2117
2403
|
iRequestedItems: int
|
|
2118
2404
|
): Promise<ListBinding>;
|
|
2119
2405
|
/**
|
|
2120
|
-
*
|
|
2121
|
-
* default, only
|
|
2406
|
+
* Finds all conditions that are represented by the given context for 'Select from list' scenarios.
|
|
2407
|
+
* By default, this method only takes {@link sap.ui.mdc.condition.ConditionObject Condition} keys into consideration.
|
|
2408
|
+
* This can be extended with payload-dependent filters.
|
|
2122
2409
|
*
|
|
2123
|
-
* Note
|
|
2410
|
+
* **Note:** This method replaces the former `isFilterableListItemSelected`.
|
|
2124
2411
|
*
|
|
2125
2412
|
* @since 1.118.0
|
|
2126
2413
|
*
|
|
@@ -2145,15 +2432,16 @@ declare module "sap/ui/mdc/ValueHelpDelegate" {
|
|
|
2145
2432
|
aConditions: ConditionObject[]
|
|
2146
2433
|
): ConditionObject[];
|
|
2147
2434
|
/**
|
|
2148
|
-
* Provides
|
|
2149
|
-
*
|
|
2150
|
-
*
|
|
2151
|
-
*
|
|
2152
|
-
*
|
|
2435
|
+
* Provides an object of conditions per binding path.
|
|
2436
|
+
* By default, this method returns an empty `object`.
|
|
2437
|
+
*
|
|
2438
|
+
* This method provides the initial set of conditions applied every time value help content is shown for
|
|
2439
|
+
* the first time after opening its container. It is also relevant for `getItemForValue` scenarios that
|
|
2440
|
+
* allow you to find a specific value help item (indicated by the availability of the `oConfig` argument).
|
|
2153
2441
|
*
|
|
2154
2442
|
* @since 1.106.0
|
|
2155
2443
|
*
|
|
2156
|
-
* @returns Returns a map
|
|
2444
|
+
* @returns Returns a map-like object containing conditions suitable for `Filter` creation
|
|
2157
2445
|
*/
|
|
2158
2446
|
getFilterConditions(
|
|
2159
2447
|
/**
|
|
@@ -2167,59 +2455,33 @@ declare module "sap/ui/mdc/ValueHelpDelegate" {
|
|
|
2167
2455
|
/**
|
|
2168
2456
|
* Configuration
|
|
2169
2457
|
*/
|
|
2170
|
-
oConfig?:
|
|
2171
|
-
|
|
2172
|
-
|
|
2173
|
-
|
|
2174
|
-
|
|
2175
|
-
|
|
2176
|
-
|
|
2177
|
-
|
|
2178
|
-
|
|
2179
|
-
|
|
2180
|
-
|
|
2181
|
-
|
|
2182
|
-
|
|
2183
|
-
|
|
2184
|
-
|
|
2185
|
-
|
|
2186
|
-
|
|
2187
|
-
|
|
2188
|
-
|
|
2189
|
-
|
|
2190
|
-
|
|
2191
|
-
|
|
2192
|
-
|
|
2193
|
-
ouParameter?: object;
|
|
2194
|
-
/**
|
|
2195
|
-
* Payload of the current condition
|
|
2196
|
-
*/
|
|
2197
|
-
payload?: object;
|
|
2198
|
-
};
|
|
2199
|
-
/**
|
|
2200
|
-
* Instance of the calling control
|
|
2201
|
-
*/
|
|
2202
|
-
control: Control;
|
|
2203
|
-
/**
|
|
2204
|
-
* `BindingContext` of the checked field. Inside a table, the `ValueHelp` element might be connected to
|
|
2205
|
-
* a different row.
|
|
2206
|
-
*/
|
|
2207
|
-
bindingContext?: Context;
|
|
2208
|
-
/**
|
|
2209
|
-
* If set, the value help checks only if there is an item with the given key. This is set to `false` if
|
|
2210
|
-
* the value cannot be a valid key because of type validation.
|
|
2211
|
-
*/
|
|
2212
|
-
checkKey: boolean;
|
|
2213
|
-
/**
|
|
2214
|
-
* If set, the value help checks only if there is an item with the given description. This is set to `false`
|
|
2215
|
-
* if only the key is used in the field.
|
|
2216
|
-
*/
|
|
2217
|
-
checkDescription: boolean;
|
|
2218
|
-
}
|
|
2219
|
-
): Promise<object> | object;
|
|
2458
|
+
oConfig?: ItemForValueConfiguration
|
|
2459
|
+
): Promise<util.FilterConditionMap> | util.FilterConditionMap;
|
|
2460
|
+
/**
|
|
2461
|
+
* Returns filters that are used when updating the binding of the `ValueHelp`.
|
|
2462
|
+
* By default, this method returns a set of {@link sap.ui.model.Filter Filters} originating from an available
|
|
2463
|
+
* {@link sap.ui.mdc.FilterBar FilterBar}, the delegate's own {@link #getFilterConditions}, and/or the {@link sap.ui.mdc.valuehelp.base.FilterableListContent#getFilterFields filterFields }
|
|
2464
|
+
* configuration of the given {@link sap.ui.mdc.valuehelp.base.FilterableListContent FilterableListContent}.
|
|
2465
|
+
*
|
|
2466
|
+
* @since 1.121
|
|
2467
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
2468
|
+
*
|
|
2469
|
+
* @returns Array of filters
|
|
2470
|
+
*/
|
|
2471
|
+
getFilters(
|
|
2472
|
+
/**
|
|
2473
|
+
* The `ValueHelp` control instance
|
|
2474
|
+
*/
|
|
2475
|
+
oValueHelp: ValueHelp,
|
|
2476
|
+
/**
|
|
2477
|
+
* `ValueHelp` content requesting conditions configuration
|
|
2478
|
+
*/
|
|
2479
|
+
oContent: FilterableListContent
|
|
2480
|
+
): Filter[];
|
|
2220
2481
|
/**
|
|
2221
2482
|
* Returns the content that is used for the autocomplete feature and for user input, if the entered text
|
|
2222
2483
|
* leads to more than one filter result.
|
|
2484
|
+
* By default, this method returns the first entry of a set of relevant contexts of the given {@link sap.ui.mdc.valuehelp.base.ListContent ListContent}.
|
|
2223
2485
|
*
|
|
2224
2486
|
* @since 1.120.0
|
|
2225
2487
|
*
|
|
@@ -2241,6 +2503,8 @@ declare module "sap/ui/mdc/ValueHelpDelegate" {
|
|
|
2241
2503
|
): Context;
|
|
2242
2504
|
/**
|
|
2243
2505
|
* Provides type information for list content filtering.
|
|
2506
|
+
* By default, this method returns an object of types per binding path, extracted from a binding template
|
|
2507
|
+
* of the given {@link sap.ui.mdc.valuehelp.base.FilterableListContent FilterableListContent}.
|
|
2244
2508
|
*
|
|
2245
2509
|
* @since 1.101.0
|
|
2246
2510
|
*
|
|
@@ -2259,9 +2523,63 @@ declare module "sap/ui/mdc/ValueHelpDelegate" {
|
|
|
2259
2523
|
* Set of conditions to create filters for
|
|
2260
2524
|
*/
|
|
2261
2525
|
oConditions: object
|
|
2262
|
-
):
|
|
2526
|
+
): util.FilterTypeConfig;
|
|
2527
|
+
/**
|
|
2528
|
+
* Provides the possibility to customize selections in 'Select from list' scenarios.
|
|
2529
|
+
* By default, this method only takes {@link sap.ui.mdc.condition.ConditionObject Condition} keys into consideration.
|
|
2530
|
+
* This might be extended with payload-dependent filters.
|
|
2531
|
+
*
|
|
2532
|
+
* @since 1.101.0
|
|
2533
|
+
* @deprecated - (since 1.118.0) - replaced by {@link module:sap/ui/mdc/ValueHelpDelegate.findConditionsForContext findConditionsForContext}
|
|
2534
|
+
*
|
|
2535
|
+
* @returns `true` if item is selected
|
|
2536
|
+
*/
|
|
2537
|
+
isFilterableListItemSelected(
|
|
2538
|
+
/**
|
|
2539
|
+
* The `ValueHelp` control instance
|
|
2540
|
+
*/
|
|
2541
|
+
oValueHelp: ValueHelp,
|
|
2542
|
+
/**
|
|
2543
|
+
* `ValueHelp` content instance
|
|
2544
|
+
*/
|
|
2545
|
+
oContent: FilterableListContent,
|
|
2546
|
+
/**
|
|
2547
|
+
* Entry of a given list
|
|
2548
|
+
*/
|
|
2549
|
+
oItem: {
|
|
2550
|
+
/**
|
|
2551
|
+
* Get the binding context of this object for the given model name.
|
|
2552
|
+
*/
|
|
2553
|
+
getBindingContext: Function;
|
|
2554
|
+
},
|
|
2555
|
+
/**
|
|
2556
|
+
* current conditions
|
|
2557
|
+
*/
|
|
2558
|
+
aConditions: ConditionObject[]
|
|
2559
|
+
): boolean;
|
|
2560
|
+
/**
|
|
2561
|
+
* Determines is the filtering used for type-ahead is case sensitive.
|
|
2562
|
+
* By default the value of the {@link sap.ui.mdc.base.ListContent#getCaseSensitive CaseSensitive} property
|
|
2563
|
+
* of the content instance is returned. If `$search` or other methods are used this might depend on the
|
|
2564
|
+
* backend logic.
|
|
2565
|
+
*
|
|
2566
|
+
* @since 1.121.0
|
|
2567
|
+
*
|
|
2568
|
+
* @returns If `true` the filtering is case sensitive
|
|
2569
|
+
*/
|
|
2570
|
+
isFilteringCaseSensitive(
|
|
2571
|
+
/**
|
|
2572
|
+
* The `ValueHelp` control instance
|
|
2573
|
+
*/
|
|
2574
|
+
oValueHelp: ValueHelp,
|
|
2575
|
+
/**
|
|
2576
|
+
* `ValueHelp` content instance
|
|
2577
|
+
*/
|
|
2578
|
+
oContent: ListContent
|
|
2579
|
+
): boolean;
|
|
2263
2580
|
/**
|
|
2264
2581
|
* Checks if a `ListBinding` supports `$search`.
|
|
2582
|
+
* By default, this method returns `false`.
|
|
2265
2583
|
*
|
|
2266
2584
|
*
|
|
2267
2585
|
* @returns `true` if `$search` is supported
|
|
@@ -2283,6 +2601,7 @@ declare module "sap/ui/mdc/ValueHelpDelegate" {
|
|
|
2283
2601
|
/**
|
|
2284
2602
|
* Provides the possibility to customize selection events in 'Select from list' scenarios. This enables
|
|
2285
2603
|
* an application to reuse conditions in collective search scenarios, instead of always creating new ones.
|
|
2604
|
+
* By default, this method returns given changes without modification.
|
|
2286
2605
|
*
|
|
2287
2606
|
* @since 1.101.0
|
|
2288
2607
|
*
|
|
@@ -2314,6 +2633,7 @@ declare module "sap/ui/mdc/ValueHelpDelegate" {
|
|
|
2314
2633
|
/**
|
|
2315
2634
|
* Callback invoked every time a {@link sap.ui.mdc.ValueHelp ValueHelp} fires a `select` event or the value
|
|
2316
2635
|
* of the corresponding field changes. This callback can be used to update external fields.
|
|
2636
|
+
* By default, this method is empty.
|
|
2317
2637
|
*
|
|
2318
2638
|
* @since 1.101.0
|
|
2319
2639
|
*/
|
|
@@ -2334,13 +2654,14 @@ declare module "sap/ui/mdc/ValueHelpDelegate" {
|
|
|
2334
2654
|
oConfig: object
|
|
2335
2655
|
): void;
|
|
2336
2656
|
/**
|
|
2337
|
-
* Requests
|
|
2657
|
+
* Requests additional content for the value help.
|
|
2338
2658
|
*
|
|
2339
2659
|
* This function is called when the value help is opened or a key or description is requested.
|
|
2340
2660
|
*
|
|
2341
|
-
* So depending on the value help
|
|
2342
|
-
* they are assigned and the data is set, the returned `Promise` needs
|
|
2343
|
-
* value help continue opening or reading data.
|
|
2661
|
+
* So depending on the value help {@link sap.ui.mdc.valuehelp.base.Content Content} used, all content controls
|
|
2662
|
+
* and data need to be assigned. Once they are assigned and the data is set, the returned `Promise` needs
|
|
2663
|
+
* to be resolved. Only then does the value help continue opening or reading data.
|
|
2664
|
+
* By default, this method returns a `Promise` that resolves into `undefined`.
|
|
2344
2665
|
*
|
|
2345
2666
|
*
|
|
2346
2667
|
* @returns `Promise` that is resolved if all content is available
|
|
@@ -2359,12 +2680,58 @@ declare module "sap/ui/mdc/ValueHelpDelegate" {
|
|
|
2359
2680
|
*/
|
|
2360
2681
|
sContentId: string
|
|
2361
2682
|
): Promise<any>;
|
|
2683
|
+
/**
|
|
2684
|
+
* Determines if the value help is opened when the user clicks into the connected control.
|
|
2685
|
+
* By default, the value of the {@link sap.ui.mdc.valuehelp.Popover#getOpensOnClick opensOnClick} property
|
|
2686
|
+
* is returned, if set, or the content configuration is checked.
|
|
2687
|
+
*
|
|
2688
|
+
* Currently this is only supported for the type-ahead container.
|
|
2689
|
+
*
|
|
2690
|
+
* @since 1.121.0
|
|
2691
|
+
*
|
|
2692
|
+
* @returns If `true`, the value help is opened when user clicks into the connected field control
|
|
2693
|
+
*/
|
|
2694
|
+
shouldOpenOnClick(
|
|
2695
|
+
/**
|
|
2696
|
+
* The `ValueHelp` control instance
|
|
2697
|
+
*/
|
|
2698
|
+
oValueHelp: ValueHelp,
|
|
2699
|
+
/**
|
|
2700
|
+
* Container instance
|
|
2701
|
+
*/
|
|
2702
|
+
oContainer: Container
|
|
2703
|
+
): Promise<boolean>;
|
|
2704
|
+
/**
|
|
2705
|
+
* Determines if the value help is opened when the user focuses on the connected control.
|
|
2706
|
+
* By default, the value of the {@link sap.ui.mdc.valuehelp.Popover#getOpensOnFocus opensOnFocus} property
|
|
2707
|
+
* is returned.
|
|
2708
|
+
*
|
|
2709
|
+
* Currently this is only supported for the type-ahead container.
|
|
2710
|
+
*
|
|
2711
|
+
* @since 1.121.0
|
|
2712
|
+
*
|
|
2713
|
+
* @returns If `true`, the value help is opened when user focuses on the connected field control
|
|
2714
|
+
*/
|
|
2715
|
+
shouldOpenOnFocus(
|
|
2716
|
+
/**
|
|
2717
|
+
* The `ValueHelp` control instance
|
|
2718
|
+
*/
|
|
2719
|
+
oValueHelp: ValueHelp,
|
|
2720
|
+
/**
|
|
2721
|
+
* Container instance
|
|
2722
|
+
*/
|
|
2723
|
+
oContainer: Container
|
|
2724
|
+
): Promise<boolean>;
|
|
2362
2725
|
/**
|
|
2363
2726
|
* Controls if a type-ahead is opened or closed.
|
|
2727
|
+
* By default, this method returns `false` if a given content is a {@link sap.ui.mdc.valuehelp.base.FilterableListContent FilterableListContent }
|
|
2728
|
+
* but no (truthy) `filterValue` is applied. Otherwise, if the given content is either a {@link sap.ui.mdc.valuehelp.base.ListContent ListContent }
|
|
2729
|
+
* with available contexts or any other type of {@link sap.ui.mdc.valuehelp.base.Content Content}, `true`
|
|
2730
|
+
* is returned.
|
|
2364
2731
|
*
|
|
2365
2732
|
* @since 1.110.0
|
|
2366
2733
|
*
|
|
2367
|
-
* @returns Boolean or `Promise`
|
|
2734
|
+
* @returns Boolean or `Promise` that resolves into a `boolean` indicating the desired behavior
|
|
2368
2735
|
*/
|
|
2369
2736
|
showTypeahead(
|
|
2370
2737
|
/**
|
|
@@ -2375,9 +2742,12 @@ declare module "sap/ui/mdc/ValueHelpDelegate" {
|
|
|
2375
2742
|
* `ValueHelp` Content requesting conditions configuration
|
|
2376
2743
|
*/
|
|
2377
2744
|
oContent: Content
|
|
2378
|
-
): Promise<
|
|
2745
|
+
): Promise<boolean> | boolean;
|
|
2379
2746
|
/**
|
|
2380
2747
|
* Executes a filter in a `ListBinding` and resumes it, if suspended.
|
|
2748
|
+
* By default, this method applies `filters` found in the given {@link sap.ui.base.ManagedObject.AggregationBindingInfo AggregationBindingInfo }
|
|
2749
|
+
* to the given {@link sap.ui.model.ListBinding ListBinding}. A suspended `ListBinding` is also resumed
|
|
2750
|
+
* afterwards.
|
|
2381
2751
|
*
|
|
2382
2752
|
* @since 1.110.0
|
|
2383
2753
|
*/
|
|
@@ -2401,6 +2771,8 @@ declare module "sap/ui/mdc/ValueHelpDelegate" {
|
|
|
2401
2771
|
): void;
|
|
2402
2772
|
/**
|
|
2403
2773
|
* Adjustable filtering for list-based contents.
|
|
2774
|
+
* By default, this method updates a given {@link sap.ui.base.ManagedObject.AggregationBindingInfo AggregationBindingInfo }
|
|
2775
|
+
* with the return value from the delegate's own {@link module:sap/ui/mdc/ValueHelpDelegate.getFilters getFilters}.
|
|
2404
2776
|
*
|
|
2405
2777
|
* @since 1.110.0
|
|
2406
2778
|
*/
|
|
@@ -2424,6 +2796,12 @@ declare module "sap/ui/mdc/ValueHelpDelegate" {
|
|
|
2424
2796
|
}
|
|
2425
2797
|
|
|
2426
2798
|
declare module "sap/ui/mdc/library" {
|
|
2799
|
+
import { ConditionObject } from "sap/ui/mdc/condition/Condition";
|
|
2800
|
+
|
|
2801
|
+
import Type from "sap/ui/model/Type";
|
|
2802
|
+
|
|
2803
|
+
import BaseType from "sap/ui/mdc/enums/BaseType";
|
|
2804
|
+
|
|
2427
2805
|
/**
|
|
2428
2806
|
* Interface for controls or entities which can serve as filters in the `sap.ui.mdc.Table` & `sap.ui.mdc.Chart`.
|
|
2429
2807
|
*
|
|
@@ -2601,6 +2979,51 @@ declare module "sap/ui/mdc/library" {
|
|
|
2601
2979
|
values: any[];
|
|
2602
2980
|
};
|
|
2603
2981
|
}
|
|
2982
|
+
|
|
2983
|
+
export namespace util {
|
|
2984
|
+
/**
|
|
2985
|
+
* Map-like configuration object for filter creation.
|
|
2986
|
+
* The keys for this object must be aligned with any {@link sap.ui.mdc.util.FilterTypeConfig} the `FilterConditionMap`
|
|
2987
|
+
* is combined with during filter creation.
|
|
2988
|
+
*
|
|
2989
|
+
*
|
|
2990
|
+
* **Structure:** Object.<string, {@link sap.ui.mdc.condition.ConditionObject sap.ui.mdc.condition.ConditionObject[]}>
|
|
2991
|
+
*
|
|
2992
|
+
* @since 1.121.0
|
|
2993
|
+
*/
|
|
2994
|
+
type FilterConditionMap = Record<string, ConditionObject[]>;
|
|
2995
|
+
|
|
2996
|
+
/**
|
|
2997
|
+
* Map-like configuration object for filter creation.
|
|
2998
|
+
* The keys for this object must be aligned with any {@link sap.ui.mdc.util.FilterConditionMap} the `FilterTypeConfig`
|
|
2999
|
+
* is combined with during filter creation.
|
|
3000
|
+
*
|
|
3001
|
+
* **Structure:** Object.<string, {@link sap.ui.mdc.util.FilterTypeConfigEntry}>
|
|
3002
|
+
*
|
|
3003
|
+
* @since 1.121.0
|
|
3004
|
+
*/
|
|
3005
|
+
type FilterTypeConfig = Record<string, FilterTypeConfigEntry>;
|
|
3006
|
+
|
|
3007
|
+
/**
|
|
3008
|
+
* Configuration object for filter creation.
|
|
3009
|
+
*
|
|
3010
|
+
* @since 1.121.0
|
|
3011
|
+
*/
|
|
3012
|
+
type FilterTypeConfigEntry = {
|
|
3013
|
+
/**
|
|
3014
|
+
* Type instance
|
|
3015
|
+
*/
|
|
3016
|
+
type: Type;
|
|
3017
|
+
/**
|
|
3018
|
+
* Indicates if a created filter is case-sensitive
|
|
3019
|
+
*/
|
|
3020
|
+
caseSensitive?: boolean;
|
|
3021
|
+
/**
|
|
3022
|
+
* BaseType configuration for the given type useful for externalization/internalization of filter values
|
|
3023
|
+
*/
|
|
3024
|
+
baseType?: BaseType | keyof typeof BaseType;
|
|
3025
|
+
};
|
|
3026
|
+
}
|
|
2604
3027
|
}
|
|
2605
3028
|
|
|
2606
3029
|
declare module "sap/ui/mdc/ActionToolbar" {
|
|
@@ -3168,6 +3591,17 @@ declare module "sap/ui/mdc/actiontoolbar/ActionToolbarAction" {
|
|
|
3168
3591
|
* @returns Value of property `layoutInformation`
|
|
3169
3592
|
*/
|
|
3170
3593
|
getLayoutInformation(): object;
|
|
3594
|
+
/**
|
|
3595
|
+
* Observes changes in `Action` aggregation.
|
|
3596
|
+
*
|
|
3597
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
3598
|
+
*/
|
|
3599
|
+
observeChanges(
|
|
3600
|
+
/**
|
|
3601
|
+
* Changes
|
|
3602
|
+
*/
|
|
3603
|
+
oChanges: object
|
|
3604
|
+
): void;
|
|
3171
3605
|
/**
|
|
3172
3606
|
* Sets the aggregated {@link #getAction action}.
|
|
3173
3607
|
*
|
|
@@ -3234,6 +3668,8 @@ declare module "sap/ui/mdc/Chart" {
|
|
|
3234
3668
|
|
|
3235
3669
|
import VariantManagement from "sap/ui/fl/variants/VariantManagement";
|
|
3236
3670
|
|
|
3671
|
+
import { PropertyInfo as PropertyInfo1 } from "sap/ui/mdc/util/PropertyHelper";
|
|
3672
|
+
|
|
3237
3673
|
import {
|
|
3238
3674
|
PropertyBindingInfo,
|
|
3239
3675
|
AggregationBindingInfo,
|
|
@@ -3455,13 +3891,6 @@ declare module "sap/ui/mdc/Chart" {
|
|
|
3455
3891
|
* @returns Value of property `chartType`
|
|
3456
3892
|
*/
|
|
3457
3893
|
getChartType(): string;
|
|
3458
|
-
/**
|
|
3459
|
-
* Retrieves the chart type layout configuration. **Note:** This is only used inside personalization.
|
|
3460
|
-
*
|
|
3461
|
-
*
|
|
3462
|
-
* @returns Layout configuration
|
|
3463
|
-
*/
|
|
3464
|
-
getChartTypeLayoutConfig(): object;
|
|
3465
3894
|
/**
|
|
3466
3895
|
* Getter for `Conditions` set in the personalization settings.
|
|
3467
3896
|
*
|
|
@@ -3472,10 +3901,23 @@ declare module "sap/ui/mdc/Chart" {
|
|
|
3472
3901
|
/**
|
|
3473
3902
|
* Gets current value of property {@link #getDelegate delegate}.
|
|
3474
3903
|
*
|
|
3475
|
-
*
|
|
3904
|
+
* Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
|
|
3905
|
+
* The object has the following properties:
|
|
3906
|
+
* - `name` defines the path to the `Delegate` module
|
|
3907
|
+
* - `payload` (optional) defines application-specific information that can be used in the given delegate
|
|
3908
|
+
* Sample delegate object:
|
|
3909
|
+
* ```javascript
|
|
3910
|
+
* {
|
|
3911
|
+
* name: "sap/ui/mdc/BaseDelegate",
|
|
3912
|
+
* payload: {}
|
|
3913
|
+
* }```
|
|
3914
|
+
* **Note:** Ensure that the related file can be requested (any required library has to be loaded before
|
|
3915
|
+
* that).
|
|
3916
|
+
* Do not bind or modify the module. This property can only be configured during control initialization.
|
|
3476
3917
|
*
|
|
3477
3918
|
* Default value is `...see text or source`.
|
|
3478
3919
|
*
|
|
3920
|
+
* @experimental
|
|
3479
3921
|
*
|
|
3480
3922
|
* @returns Value of property `delegate`
|
|
3481
3923
|
*/
|
|
@@ -3485,7 +3927,7 @@ declare module "sap/ui/mdc/Chart" {
|
|
|
3485
3927
|
*
|
|
3486
3928
|
* @since 1.88
|
|
3487
3929
|
*/
|
|
3488
|
-
getFilter(): ID;
|
|
3930
|
+
getFilter(): ID | null;
|
|
3489
3931
|
/**
|
|
3490
3932
|
* Gets current value of property {@link #getHeader header}.
|
|
3491
3933
|
*
|
|
@@ -3643,13 +4085,6 @@ declare module "sap/ui/mdc/Chart" {
|
|
|
3643
4085
|
* For more information, see {@link sap.ui.mdc.chart.SelectionDetailsActions SelectionDetailsActions}.
|
|
3644
4086
|
*/
|
|
3645
4087
|
getSelectionDetailsActions(): SelectionDetailsActions;
|
|
3646
|
-
/**
|
|
3647
|
-
* Retrieves the selection handler of the inner chart.
|
|
3648
|
-
*
|
|
3649
|
-
*
|
|
3650
|
-
* @returns Selection handler of the inner chart
|
|
3651
|
-
*/
|
|
3652
|
-
getSelectionHandler(): object;
|
|
3653
4088
|
/**
|
|
3654
4089
|
* Gets current value of property {@link #getShowChartTooltip showChartTooltip}.
|
|
3655
4090
|
*
|
|
@@ -3739,12 +4174,25 @@ declare module "sap/ui/mdc/Chart" {
|
|
|
3739
4174
|
/**
|
|
3740
4175
|
* Sets a new value for property {@link #getDelegate delegate}.
|
|
3741
4176
|
*
|
|
3742
|
-
*
|
|
4177
|
+
* Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
|
|
4178
|
+
* The object has the following properties:
|
|
4179
|
+
* - `name` defines the path to the `Delegate` module
|
|
4180
|
+
* - `payload` (optional) defines application-specific information that can be used in the given delegate
|
|
4181
|
+
* Sample delegate object:
|
|
4182
|
+
* ```javascript
|
|
4183
|
+
* {
|
|
4184
|
+
* name: "sap/ui/mdc/BaseDelegate",
|
|
4185
|
+
* payload: {}
|
|
4186
|
+
* }```
|
|
4187
|
+
* **Note:** Ensure that the related file can be requested (any required library has to be loaded before
|
|
4188
|
+
* that).
|
|
4189
|
+
* Do not bind or modify the module. This property can only be configured during control initialization.
|
|
3743
4190
|
*
|
|
3744
4191
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3745
4192
|
*
|
|
3746
4193
|
* Default value is `...see text or source`.
|
|
3747
4194
|
*
|
|
4195
|
+
* @experimental
|
|
3748
4196
|
*
|
|
3749
4197
|
* @returns Reference to `this` in order to allow method chaining
|
|
3750
4198
|
*/
|
|
@@ -4054,46 +4502,14 @@ declare module "sap/ui/mdc/Chart" {
|
|
|
4054
4502
|
*
|
|
4055
4503
|
* When specifying the `PropertyInfo` objects in the {@link sap.ui.mdc.Chart#getPropertyInfo propertyInfo }
|
|
4056
4504
|
* property, the following attributes need to be specified:
|
|
4505
|
+
* - `key`
|
|
4057
4506
|
* - `label`
|
|
4058
|
-
* - `
|
|
4507
|
+
* - `groupable`
|
|
4508
|
+
* - `aggregatable`
|
|
4509
|
+
* - `role`
|
|
4510
|
+
* - `dataType`
|
|
4059
4511
|
*/
|
|
4060
|
-
export type PropertyInfo = {
|
|
4061
|
-
/**
|
|
4062
|
-
* The path to the property in the back end
|
|
4063
|
-
*/
|
|
4064
|
-
propertyPath: string;
|
|
4065
|
-
/**
|
|
4066
|
-
* The identifier of the property
|
|
4067
|
-
*/
|
|
4068
|
-
name?: string;
|
|
4069
|
-
/**
|
|
4070
|
-
* The label of the identifier
|
|
4071
|
-
*/
|
|
4072
|
-
label: string;
|
|
4073
|
-
/**
|
|
4074
|
-
* The tooltip of the identifier
|
|
4075
|
-
*/
|
|
4076
|
-
tooltip?: string;
|
|
4077
|
-
/**
|
|
4078
|
-
* The name of the data type of the property
|
|
4079
|
-
*/
|
|
4080
|
-
datatype: string;
|
|
4081
|
-
/**
|
|
4082
|
-
* Defines constraints for the data type of the property
|
|
4083
|
-
*/
|
|
4084
|
-
constraints?: object;
|
|
4085
|
-
/**
|
|
4086
|
-
* Defines formatting options for the data type of the property
|
|
4087
|
-
*/
|
|
4088
|
-
formatOptions?: object;
|
|
4089
|
-
/**
|
|
4090
|
-
* Defines if the filter is mandatory
|
|
4091
|
-
*/
|
|
4092
|
-
required?: boolean;
|
|
4093
|
-
/**
|
|
4094
|
-
* Defines if the filter supports multiple values `-1` or single values `1`
|
|
4095
|
-
*/
|
|
4096
|
-
maxConditions: int;
|
|
4512
|
+
export type PropertyInfo = PropertyInfo1 & {
|
|
4097
4513
|
/**
|
|
4098
4514
|
* Defines whether the property is groupable and is selectable as a dimension in the chart
|
|
4099
4515
|
*/
|
|
@@ -4122,6 +4538,15 @@ declare module "sap/ui/mdc/Chart" {
|
|
|
4122
4538
|
* The text property used for the dimension
|
|
4123
4539
|
*/
|
|
4124
4540
|
textProperty?: string;
|
|
4541
|
+
/**
|
|
4542
|
+
* The text formatter object which can be used to format the textProperty
|
|
4543
|
+
*/
|
|
4544
|
+
textFormatter?: object;
|
|
4545
|
+
/**
|
|
4546
|
+
* The name of the unit property which will be used to display and format measure values with a unit value
|
|
4547
|
+
* on a selectionDetails popover
|
|
4548
|
+
*/
|
|
4549
|
+
unitPath?: object;
|
|
4125
4550
|
};
|
|
4126
4551
|
|
|
4127
4552
|
export interface $ChartSettings extends $ControlSettings {
|
|
@@ -4136,7 +4561,21 @@ declare module "sap/ui/mdc/Chart" {
|
|
|
4136
4561
|
height?: CSSSize | PropertyBindingInfo | `{${string}}`;
|
|
4137
4562
|
|
|
4138
4563
|
/**
|
|
4139
|
-
*
|
|
4564
|
+
* Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
|
|
4565
|
+
* The object has the following properties:
|
|
4566
|
+
* - `name` defines the path to the `Delegate` module
|
|
4567
|
+
* - `payload` (optional) defines application-specific information that can be used in the given delegate
|
|
4568
|
+
* Sample delegate object:
|
|
4569
|
+
* ```javascript
|
|
4570
|
+
* {
|
|
4571
|
+
* name: "sap/ui/mdc/BaseDelegate",
|
|
4572
|
+
* payload: {}
|
|
4573
|
+
* }```
|
|
4574
|
+
* **Note:** Ensure that the related file can be requested (any required library has to be loaded before
|
|
4575
|
+
* that).
|
|
4576
|
+
* Do not bind or modify the module. This property can only be configured during control initialization.
|
|
4577
|
+
*
|
|
4578
|
+
* @experimental
|
|
4140
4579
|
*/
|
|
4141
4580
|
delegate?: object | PropertyBindingInfo | `{${string}}`;
|
|
4142
4581
|
|
|
@@ -4315,8 +4754,10 @@ declare module "sap/ui/mdc/Chart" {
|
|
|
4315
4754
|
noData?: Control1;
|
|
4316
4755
|
|
|
4317
4756
|
/**
|
|
4318
|
-
* Control or object that enables the chart to do filtering, such as {@link sap.ui.mdc.FilterBar}.
|
|
4319
|
-
*
|
|
4757
|
+
* Control or object that enables the chart to do filtering, such as {@link sap.ui.mdc.FilterBar}. See also
|
|
4758
|
+
* {@link sap.ui.mdc.IFilter}.
|
|
4759
|
+
*
|
|
4760
|
+
* Automatic filter generation only works in combination with a `sap.ui.mdc.FilterBar`.
|
|
4320
4761
|
*
|
|
4321
4762
|
* @since 1.88
|
|
4322
4763
|
*/
|
|
@@ -4454,7 +4895,7 @@ declare module "sap/ui/mdc/chart/ChartImplementationContainer" {
|
|
|
4454
4895
|
* ID of the element which is the current target of the association {@link #getChartNoDataContent chartNoDataContent},
|
|
4455
4896
|
* or `null`.
|
|
4456
4897
|
*/
|
|
4457
|
-
getChartNoDataContent(): ID;
|
|
4898
|
+
getChartNoDataContent(): ID | null;
|
|
4458
4899
|
/**
|
|
4459
4900
|
* Gets content of aggregation {@link #getContent content}.
|
|
4460
4901
|
*
|
|
@@ -4466,7 +4907,7 @@ declare module "sap/ui/mdc/chart/ChartImplementationContainer" {
|
|
|
4466
4907
|
*
|
|
4467
4908
|
* Control that is shown when there is no data available inside the chart.
|
|
4468
4909
|
* This can be used if the standard behavior of the used chart control needs to be overriden.
|
|
4469
|
-
* To show this `noDataContent`, set {@link
|
|
4910
|
+
* To show this `noDataContent`, set {@link #getShowNoDataStruct showNoDataStruct}.
|
|
4470
4911
|
*/
|
|
4471
4912
|
getNoDataContent(): Control;
|
|
4472
4913
|
/**
|
|
@@ -4497,7 +4938,7 @@ declare module "sap/ui/mdc/chart/ChartImplementationContainer" {
|
|
|
4497
4938
|
/**
|
|
4498
4939
|
* Control that is shown when there is no data available inside the chart.
|
|
4499
4940
|
* This can be used if the standard behavior of the used chart control needs to be overriden.
|
|
4500
|
-
* To show this `noDataContent`, set {@link
|
|
4941
|
+
* To show this `noDataContent`, set {@link #getShowNoDataStruct showNoDataStruct}.
|
|
4501
4942
|
*/
|
|
4502
4943
|
noDataContent?: Control;
|
|
4503
4944
|
|
|
@@ -6040,7 +6481,16 @@ declare module "sap/ui/mdc/Control" {
|
|
|
6040
6481
|
|
|
6041
6482
|
export interface $ControlSettings extends $ControlSettings1 {
|
|
6042
6483
|
/**
|
|
6043
|
-
*
|
|
6484
|
+
* Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
|
|
6485
|
+
* The object has the following properties:
|
|
6486
|
+
* - `name` defines the path to the `Delegate` module
|
|
6487
|
+
* - `payload` (optional) defines application-specific information that can be used in the given delegate
|
|
6488
|
+
* Sample delegate object:
|
|
6489
|
+
* ```javascript
|
|
6490
|
+
* {
|
|
6491
|
+
* name: "sap/ui/mdc/BaseDelegate",
|
|
6492
|
+
* payload: {}
|
|
6493
|
+
* }```
|
|
6044
6494
|
* **Note:** Ensure that the related file can be requested (any required library has to be loaded before
|
|
6045
6495
|
* that).
|
|
6046
6496
|
* Do not bind or modify the module. This property can only be configured during control initialization.
|
|
@@ -6254,7 +6704,16 @@ declare module "sap/ui/mdc/Element" {
|
|
|
6254
6704
|
|
|
6255
6705
|
export interface $ElementSettings extends $ElementSettings1 {
|
|
6256
6706
|
/**
|
|
6257
|
-
*
|
|
6707
|
+
* Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
|
|
6708
|
+
* The object has the following properties:
|
|
6709
|
+
* - `name` defines the path to the `Delegate` module
|
|
6710
|
+
* - `payload` (optional) defines application-specific information that can be used in the given delegate
|
|
6711
|
+
* Sample delegate object:
|
|
6712
|
+
* ```javascript
|
|
6713
|
+
* {
|
|
6714
|
+
* name: "sap/ui/mdc/BaseDelegate",
|
|
6715
|
+
* payload: {}
|
|
6716
|
+
* }```
|
|
6258
6717
|
* **Note:** Ensure that the related file can be requested (any required library has to be loaded before
|
|
6259
6718
|
* that).
|
|
6260
6719
|
* Do not bind or modify the module. This property can only be configured during control initialization.
|
|
@@ -6366,10 +6825,6 @@ declare module "sap/ui/mdc/enums/ChartToolbarActionType" {
|
|
|
6366
6825
|
* Drill-down and drill-up action.
|
|
6367
6826
|
*/
|
|
6368
6827
|
DrillDownUp = "DrillDownUp",
|
|
6369
|
-
/**
|
|
6370
|
-
* Full screen action.
|
|
6371
|
-
*/
|
|
6372
|
-
FullScreen = "FullScreen",
|
|
6373
6828
|
/**
|
|
6374
6829
|
* Legend action.
|
|
6375
6830
|
*/
|
|
@@ -6613,7 +7068,7 @@ declare module "sap/ui/mdc/enums/OperatorName" {
|
|
|
6613
7068
|
* "equal to" operator
|
|
6614
7069
|
*
|
|
6615
7070
|
* Depending on the used `DisplayFormat`, the key, the description, or both are used as output of formatting
|
|
6616
|
-
* during parsing.
|
|
7071
|
+
* and during parsing.
|
|
6617
7072
|
*
|
|
6618
7073
|
* The operator is available for all data types.
|
|
6619
7074
|
*
|
|
@@ -7164,21 +7619,22 @@ declare module "sap/ui/mdc/enums/OperatorValueType" {
|
|
|
7164
7619
|
|
|
7165
7620
|
declare module "sap/ui/mdc/enums/TableGrowingMode" {
|
|
7166
7621
|
/**
|
|
7167
|
-
*
|
|
7622
|
+
* Growing mode of the table.
|
|
7168
7623
|
*
|
|
7169
7624
|
* @since 1.115
|
|
7170
7625
|
*/
|
|
7171
7626
|
enum TableGrowingMode {
|
|
7172
7627
|
/**
|
|
7173
|
-
*
|
|
7628
|
+
* A More is shown with which the user can request to load more rows
|
|
7174
7629
|
*/
|
|
7175
7630
|
Basic = "Basic",
|
|
7176
7631
|
/**
|
|
7177
|
-
*
|
|
7632
|
+
* A fixed number of rows is shown
|
|
7178
7633
|
*/
|
|
7179
7634
|
None = "None",
|
|
7180
7635
|
/**
|
|
7181
|
-
*
|
|
7636
|
+
* Either the user requests to load more rows by scrolling down, or the More button is displayed if no scrolling
|
|
7637
|
+
* is required because the table is fully visible
|
|
7182
7638
|
*/
|
|
7183
7639
|
Scroll = "Scroll",
|
|
7184
7640
|
}
|
|
@@ -7187,63 +7643,63 @@ declare module "sap/ui/mdc/enums/TableGrowingMode" {
|
|
|
7187
7643
|
|
|
7188
7644
|
declare module "sap/ui/mdc/enums/TableP13nMode" {
|
|
7189
7645
|
/**
|
|
7190
|
-
*
|
|
7646
|
+
* Personalization mode of the table.
|
|
7191
7647
|
*
|
|
7192
7648
|
* @since 1.115
|
|
7193
7649
|
*/
|
|
7194
7650
|
enum TableP13nMode {
|
|
7195
7651
|
/**
|
|
7196
|
-
*
|
|
7652
|
+
* The table can be aggregated
|
|
7197
7653
|
*/
|
|
7198
7654
|
Aggregate = "Aggregate",
|
|
7199
7655
|
/**
|
|
7200
|
-
*
|
|
7656
|
+
* Columns can be shown, hidden and reordered
|
|
7201
7657
|
*/
|
|
7202
7658
|
Column = "Column",
|
|
7203
7659
|
/**
|
|
7204
|
-
*
|
|
7660
|
+
* The table can be filtered
|
|
7205
7661
|
*/
|
|
7206
7662
|
Filter = "Filter",
|
|
7207
7663
|
/**
|
|
7208
|
-
*
|
|
7664
|
+
* The table can be grouped
|
|
7209
7665
|
*/
|
|
7210
7666
|
Group = "Group",
|
|
7211
7667
|
/**
|
|
7212
|
-
*
|
|
7668
|
+
* The table can be sorted
|
|
7213
7669
|
*/
|
|
7214
7670
|
Sort = "Sort",
|
|
7215
7671
|
}
|
|
7216
7672
|
export default TableP13nMode;
|
|
7217
7673
|
}
|
|
7218
7674
|
|
|
7219
|
-
declare module "sap/ui/mdc/enums/
|
|
7675
|
+
declare module "sap/ui/mdc/enums/TableRowActionType" {
|
|
7220
7676
|
/**
|
|
7221
|
-
*
|
|
7677
|
+
* Type of a table row action.
|
|
7222
7678
|
*
|
|
7223
7679
|
* @since 1.115
|
|
7224
7680
|
*/
|
|
7225
|
-
enum
|
|
7681
|
+
enum TableRowActionType {
|
|
7226
7682
|
/**
|
|
7227
|
-
* Navigation arrow (chevron) is shown
|
|
7683
|
+
* Navigation arrow (chevron) is shown
|
|
7228
7684
|
*/
|
|
7229
7685
|
Navigation = "Navigation",
|
|
7230
7686
|
}
|
|
7231
|
-
export default
|
|
7687
|
+
export default TableRowActionType;
|
|
7232
7688
|
}
|
|
7233
7689
|
|
|
7234
7690
|
declare module "sap/ui/mdc/enums/TableRowCountMode" {
|
|
7235
7691
|
/**
|
|
7236
|
-
*
|
|
7692
|
+
* Row count mode of the table.
|
|
7237
7693
|
*
|
|
7238
7694
|
* @since 1.115
|
|
7239
7695
|
*/
|
|
7240
7696
|
enum TableRowCountMode {
|
|
7241
7697
|
/**
|
|
7242
|
-
* The table automatically fills the height of the surrounding container
|
|
7698
|
+
* The table automatically fills the height of the surrounding container
|
|
7243
7699
|
*/
|
|
7244
7700
|
Auto = "Auto",
|
|
7245
7701
|
/**
|
|
7246
|
-
*
|
|
7702
|
+
* A fixed number of rows is shown
|
|
7247
7703
|
*/
|
|
7248
7704
|
Fixed = "Fixed",
|
|
7249
7705
|
}
|
|
@@ -7252,26 +7708,28 @@ declare module "sap/ui/mdc/enums/TableRowCountMode" {
|
|
|
7252
7708
|
|
|
7253
7709
|
declare module "sap/ui/mdc/enums/TableSelectionMode" {
|
|
7254
7710
|
/**
|
|
7255
|
-
*
|
|
7711
|
+
* Selection mode of the table.
|
|
7256
7712
|
*
|
|
7257
7713
|
* @since 1.115
|
|
7258
7714
|
*/
|
|
7259
7715
|
enum TableSelectionMode {
|
|
7260
7716
|
/**
|
|
7261
|
-
* Multiple rows
|
|
7717
|
+
* Multiple rows can be selected at a time
|
|
7262
7718
|
*/
|
|
7263
7719
|
Multi = "Multi",
|
|
7264
7720
|
/**
|
|
7265
|
-
* No
|
|
7721
|
+
* No row selection available
|
|
7266
7722
|
*/
|
|
7267
7723
|
None = "None",
|
|
7268
7724
|
/**
|
|
7269
|
-
* Only one row
|
|
7725
|
+
* Only one row can be selected at a time
|
|
7270
7726
|
*/
|
|
7271
7727
|
Single = "Single",
|
|
7272
7728
|
/**
|
|
7273
|
-
* Only one row
|
|
7274
|
-
*
|
|
7729
|
+
* Only one row can be selected at a time. The selection column is not shown. Instead, the user can press
|
|
7730
|
+
* the row to select it.
|
|
7731
|
+
*
|
|
7732
|
+
* **Note:** If this selection mode is used, the table does not fire the `rowPress` event
|
|
7275
7733
|
*/
|
|
7276
7734
|
SingleMaster = "SingleMaster",
|
|
7277
7735
|
}
|
|
@@ -7280,17 +7738,17 @@ declare module "sap/ui/mdc/enums/TableSelectionMode" {
|
|
|
7280
7738
|
|
|
7281
7739
|
declare module "sap/ui/mdc/enums/TableType" {
|
|
7282
7740
|
/**
|
|
7283
|
-
*
|
|
7741
|
+
* Type of the table.
|
|
7284
7742
|
*
|
|
7285
7743
|
* @since 1.115
|
|
7286
7744
|
*/
|
|
7287
7745
|
enum TableType {
|
|
7288
7746
|
/**
|
|
7289
|
-
*
|
|
7747
|
+
* Equivalent to the default configuration of {@link sap.ui.mdc.table.ResponsiveTableType}
|
|
7290
7748
|
*/
|
|
7291
7749
|
ResponsiveTable = "ResponsiveTable",
|
|
7292
7750
|
/**
|
|
7293
|
-
*
|
|
7751
|
+
* Equivalent to the default configuration of {@link sap.ui.mdc.table.GridTableType}
|
|
7294
7752
|
*/
|
|
7295
7753
|
Table = "Table",
|
|
7296
7754
|
}
|
|
@@ -8967,7 +9425,12 @@ declare module "sap/ui/mdc/field/FieldBase" {
|
|
|
8967
9425
|
/**
|
|
8968
9426
|
* @since 1.98 Further control-specific setting of the focus target within the control
|
|
8969
9427
|
*/
|
|
8970
|
-
targetInfo?:
|
|
9428
|
+
targetInfo?: {
|
|
9429
|
+
/**
|
|
9430
|
+
* @since 1.114 Suppresses typeahead opening
|
|
9431
|
+
*/
|
|
9432
|
+
silent?: boolean;
|
|
9433
|
+
};
|
|
8971
9434
|
}
|
|
8972
9435
|
): void;
|
|
8973
9436
|
/**
|
|
@@ -9093,6 +9556,8 @@ declare module "sap/ui/mdc/field/FieldBase" {
|
|
|
9093
9556
|
*/
|
|
9094
9557
|
getContentEdit(): Control1;
|
|
9095
9558
|
/**
|
|
9559
|
+
* Returns the `ContentFactory` used to manage the internal content control.
|
|
9560
|
+
*
|
|
9096
9561
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
9097
9562
|
*
|
|
9098
9563
|
* @returns oContentFactory the ContentFactory of the Field
|
|
@@ -9111,6 +9576,9 @@ declare module "sap/ui/mdc/field/FieldBase" {
|
|
|
9111
9576
|
*
|
|
9112
9577
|
* The type of data handled by the field. This type is used to parse, format, and validate the value.
|
|
9113
9578
|
*
|
|
9579
|
+
* **Note:** The module of the data type should be loaded before it is assigned to the field. Otherwise
|
|
9580
|
+
* the asynchronous loading of the module might lead to unwanted side effects.
|
|
9581
|
+
*
|
|
9114
9582
|
* Default value is `'sap.ui.model.type.String'`.
|
|
9115
9583
|
*
|
|
9116
9584
|
*
|
|
@@ -9138,15 +9606,23 @@ declare module "sap/ui/mdc/field/FieldBase" {
|
|
|
9138
9606
|
/**
|
|
9139
9607
|
* Gets current value of property {@link #getDelegate delegate}.
|
|
9140
9608
|
*
|
|
9141
|
-
*
|
|
9609
|
+
* Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
|
|
9610
|
+
* The object has the following properties:
|
|
9611
|
+
* - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/field/FieldBaseDelegate FieldBaseDelegate }
|
|
9612
|
+
*
|
|
9613
|
+
* - `payload` (optional) defines application-specific information that can be used in the given delegate
|
|
9614
|
+
* Sample delegate object:
|
|
9615
|
+
* ```javascript
|
|
9616
|
+
* {
|
|
9617
|
+
* name: "sap/ui/mdc/field/FieldBaseDelegate",
|
|
9618
|
+
* payload: {}
|
|
9619
|
+
* }```
|
|
9142
9620
|
* **Note:** Ensure that the related file can be requested (any required library has to be loaded before
|
|
9143
9621
|
* that).
|
|
9144
|
-
* Do not bind or modify the module.
|
|
9145
|
-
* needed any longer.
|
|
9622
|
+
* Do not bind or modify the module. This property can only be configured during control initialization.
|
|
9146
9623
|
*
|
|
9147
9624
|
* Default value is `...see text or source`.
|
|
9148
9625
|
*
|
|
9149
|
-
* @since 1.72.0
|
|
9150
9626
|
* @experimental
|
|
9151
9627
|
*
|
|
9152
9628
|
* @returns Value of property `delegate`
|
|
@@ -9180,7 +9656,7 @@ declare module "sap/ui/mdc/field/FieldBase" {
|
|
|
9180
9656
|
*
|
|
9181
9657
|
* @deprecated (since 1.114.0) - replaced by {@link #setValueHelp valueHelp} association
|
|
9182
9658
|
*/
|
|
9183
|
-
getFieldHelp(): ID;
|
|
9659
|
+
getFieldHelp(): ID | null;
|
|
9184
9660
|
/**
|
|
9185
9661
|
* Gets content of aggregation {@link #getFieldInfo fieldInfo}.
|
|
9186
9662
|
*
|
|
@@ -9360,7 +9836,7 @@ declare module "sap/ui/mdc/field/FieldBase" {
|
|
|
9360
9836
|
* ID of the element which is the current target of the association {@link #getValueHelp valueHelp}, or
|
|
9361
9837
|
* `null`.
|
|
9362
9838
|
*/
|
|
9363
|
-
getValueHelp(): ID;
|
|
9839
|
+
getValueHelp(): ID | null;
|
|
9364
9840
|
/**
|
|
9365
9841
|
* Gets current value of property {@link #getValueState valueState}.
|
|
9366
9842
|
*
|
|
@@ -9596,6 +10072,9 @@ declare module "sap/ui/mdc/field/FieldBase" {
|
|
|
9596
10072
|
*
|
|
9597
10073
|
* The type of data handled by the field. This type is used to parse, format, and validate the value.
|
|
9598
10074
|
*
|
|
10075
|
+
* **Note:** The module of the data type should be loaded before it is assigned to the field. Otherwise
|
|
10076
|
+
* the asynchronous loading of the module might lead to unwanted side effects.
|
|
10077
|
+
*
|
|
9599
10078
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
9600
10079
|
*
|
|
9601
10080
|
* Default value is `'sap.ui.model.type.String'`.
|
|
@@ -9644,17 +10123,25 @@ declare module "sap/ui/mdc/field/FieldBase" {
|
|
|
9644
10123
|
/**
|
|
9645
10124
|
* Sets a new value for property {@link #getDelegate delegate}.
|
|
9646
10125
|
*
|
|
9647
|
-
*
|
|
10126
|
+
* Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
|
|
10127
|
+
* The object has the following properties:
|
|
10128
|
+
* - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/field/FieldBaseDelegate FieldBaseDelegate }
|
|
10129
|
+
*
|
|
10130
|
+
* - `payload` (optional) defines application-specific information that can be used in the given delegate
|
|
10131
|
+
* Sample delegate object:
|
|
10132
|
+
* ```javascript
|
|
10133
|
+
* {
|
|
10134
|
+
* name: "sap/ui/mdc/field/FieldBaseDelegate",
|
|
10135
|
+
* payload: {}
|
|
10136
|
+
* }```
|
|
9648
10137
|
* **Note:** Ensure that the related file can be requested (any required library has to be loaded before
|
|
9649
10138
|
* that).
|
|
9650
|
-
* Do not bind or modify the module.
|
|
9651
|
-
* needed any longer.
|
|
10139
|
+
* Do not bind or modify the module. This property can only be configured during control initialization.
|
|
9652
10140
|
*
|
|
9653
10141
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
9654
10142
|
*
|
|
9655
10143
|
* Default value is `...see text or source`.
|
|
9656
10144
|
*
|
|
9657
|
-
* @since 1.72.0
|
|
9658
10145
|
* @experimental
|
|
9659
10146
|
*
|
|
9660
10147
|
* @returns Reference to `this` in order to allow method chaining
|
|
@@ -9996,6 +10483,9 @@ declare module "sap/ui/mdc/field/FieldBase" {
|
|
|
9996
10483
|
export interface $FieldBaseSettings extends $ControlSettings {
|
|
9997
10484
|
/**
|
|
9998
10485
|
* The type of data handled by the field. This type is used to parse, format, and validate the value.
|
|
10486
|
+
*
|
|
10487
|
+
* **Note:** The module of the data type should be loaded before it is assigned to the field. Otherwise
|
|
10488
|
+
* the asynchronous loading of the module might lead to unwanted side effects.
|
|
9999
10489
|
*/
|
|
10000
10490
|
dataType?: string | PropertyBindingInfo;
|
|
10001
10491
|
|
|
@@ -10131,13 +10621,21 @@ declare module "sap/ui/mdc/field/FieldBase" {
|
|
|
10131
10621
|
label?: string | PropertyBindingInfo;
|
|
10132
10622
|
|
|
10133
10623
|
/**
|
|
10134
|
-
*
|
|
10624
|
+
* Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
|
|
10625
|
+
* The object has the following properties:
|
|
10626
|
+
* - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/field/FieldBaseDelegate FieldBaseDelegate }
|
|
10627
|
+
*
|
|
10628
|
+
* - `payload` (optional) defines application-specific information that can be used in the given delegate
|
|
10629
|
+
* Sample delegate object:
|
|
10630
|
+
* ```javascript
|
|
10631
|
+
* {
|
|
10632
|
+
* name: "sap/ui/mdc/field/FieldBaseDelegate",
|
|
10633
|
+
* payload: {}
|
|
10634
|
+
* }```
|
|
10135
10635
|
* **Note:** Ensure that the related file can be requested (any required library has to be loaded before
|
|
10136
10636
|
* that).
|
|
10137
|
-
* Do not bind or modify the module.
|
|
10138
|
-
* needed any longer.
|
|
10637
|
+
* Do not bind or modify the module. This property can only be configured during control initialization.
|
|
10139
10638
|
*
|
|
10140
|
-
* @since 1.72.0
|
|
10141
10639
|
* @experimental
|
|
10142
10640
|
*/
|
|
10143
10641
|
delegate?: object | PropertyBindingInfo | `{${string}}`;
|
|
@@ -10633,9 +11131,14 @@ declare module "sap/ui/mdc/field/FieldInfoBase" {
|
|
|
10633
11131
|
*/
|
|
10634
11132
|
open(
|
|
10635
11133
|
/**
|
|
10636
|
-
* Optional control reference to which the popover is
|
|
11134
|
+
* Optional control reference to which the popover is
|
|
10637
11135
|
*/
|
|
10638
|
-
oControl: Control
|
|
11136
|
+
oControl: Control,
|
|
11137
|
+
/**
|
|
11138
|
+
* Object of the event that gets fired by the `onPress` event of the link in `Field` attached. By default
|
|
11139
|
+
* the parent is used as reference.
|
|
11140
|
+
*/
|
|
11141
|
+
oEvent: Event
|
|
10639
11142
|
): Promise<any>;
|
|
10640
11143
|
}
|
|
10641
11144
|
|
|
@@ -10666,44 +11169,6 @@ declare module "sap/ui/mdc/field/FieldInfoBase" {
|
|
|
10666
11169
|
>;
|
|
10667
11170
|
}
|
|
10668
11171
|
|
|
10669
|
-
declare module "sap/ui/mdc/field/MultiValueFieldDelegate" {
|
|
10670
|
-
import { ConditionObject } from "sap/ui/mdc/condition/Condition";
|
|
10671
|
-
|
|
10672
|
-
import MultiValueField from "sap/ui/mdc/MultiValueField";
|
|
10673
|
-
|
|
10674
|
-
/**
|
|
10675
|
-
* Delegate class for `sap.ui.mdc.MultiValueField`.
|
|
10676
|
-
*
|
|
10677
|
-
*
|
|
10678
|
-
* @since 1.93.0
|
|
10679
|
-
*/
|
|
10680
|
-
export default class MultiValueFieldDelegate {
|
|
10681
|
-
constructor();
|
|
10682
|
-
|
|
10683
|
-
/**
|
|
10684
|
-
* Implements the model-specific logic to update items after conditions have been updated.
|
|
10685
|
-
*
|
|
10686
|
-
* Items can be removed, updated, or added. Use the binding information of the `MultiValueField` control
|
|
10687
|
-
* to update the data in the model.
|
|
10688
|
-
*/
|
|
10689
|
-
static updateItems(
|
|
10690
|
-
/**
|
|
10691
|
-
* Payload for delegate
|
|
10692
|
-
*/
|
|
10693
|
-
oPayload: object,
|
|
10694
|
-
/**
|
|
10695
|
-
* Current conditions of the `MultiValueField` control
|
|
10696
|
-
*/
|
|
10697
|
-
aConditions: ConditionObject[],
|
|
10698
|
-
/**
|
|
10699
|
-
* Current `MultiValueField` control to determine binding information to update the values of the corresponding
|
|
10700
|
-
* model
|
|
10701
|
-
*/
|
|
10702
|
-
oMultiValueField: MultiValueField
|
|
10703
|
-
): void;
|
|
10704
|
-
}
|
|
10705
|
-
}
|
|
10706
|
-
|
|
10707
11172
|
declare module "sap/ui/mdc/field/MultiValueFieldItem" {
|
|
10708
11173
|
import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
|
|
10709
11174
|
|
|
@@ -10861,8 +11326,6 @@ declare module "sap/ui/mdc/FilterBar" {
|
|
|
10861
11326
|
|
|
10862
11327
|
import { PropertyInfo as PropertyInfo1 } from "sap/ui/mdc/util/PropertyHelper";
|
|
10863
11328
|
|
|
10864
|
-
import FieldDisplay from "sap/ui/mdc/enums/FieldDisplay";
|
|
10865
|
-
|
|
10866
11329
|
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
10867
11330
|
|
|
10868
11331
|
/**
|
|
@@ -10871,8 +11334,8 @@ declare module "sap/ui/mdc/FilterBar" {
|
|
|
10871
11334
|
* and the width of the filters. The Go button fires the search event, and the Adapt Filters button shows
|
|
10872
11335
|
* the filter dialog.
|
|
10873
11336
|
* The `FilterBar` control creates and handles the filters based on the provided metadata information.
|
|
10874
|
-
* The metadata information is provided via the {@link sap
|
|
10875
|
-
* This implementation has to be provided by the application.
|
|
11337
|
+
* The metadata information is provided via the {@link module:sap/ui/mdc/FilterBarDelegate FilterBarDelegate }
|
|
11338
|
+
* implementation. This implementation has to be provided by the application.
|
|
10876
11339
|
*
|
|
10877
11340
|
* @since 1.61.0
|
|
10878
11341
|
* @experimental (since 1.61.0)
|
|
@@ -11036,64 +11499,19 @@ declare module "sap/ui/mdc/FilterBar" {
|
|
|
11036
11499
|
*
|
|
11037
11500
|
* @since 1.108
|
|
11038
11501
|
*
|
|
11039
|
-
* @returns Reference to `this` in order to allow method chaining
|
|
11040
|
-
*/
|
|
11041
|
-
setShowClearButton(
|
|
11042
|
-
/**
|
|
11043
|
-
* New value for property `showClearButton`
|
|
11044
|
-
*/
|
|
11045
|
-
bShowClearButton?: boolean
|
|
11046
|
-
): this;
|
|
11047
|
-
}
|
|
11048
|
-
/**
|
|
11049
|
-
* @since 1.112.0
|
|
11050
|
-
*/
|
|
11051
|
-
export type PropertyInfo = PropertyInfo1 & {
|
|
11052
|
-
/**
|
|
11053
|
-
* The identifier of the property
|
|
11054
|
-
*/
|
|
11055
|
-
path: string;
|
|
11056
|
-
/**
|
|
11057
|
-
* The alternative identifier of the property. Either `path` or `name` property can be used. The `path`
|
|
11058
|
-
* is the preferred property.
|
|
11059
|
-
*/
|
|
11060
|
-
name?: string;
|
|
11061
|
-
/**
|
|
11062
|
-
* The label of the identifier
|
|
11063
|
-
*/
|
|
11064
|
-
label: string;
|
|
11065
|
-
/**
|
|
11066
|
-
* The tooltip of the identifier
|
|
11067
|
-
*/
|
|
11068
|
-
tooltip?: string;
|
|
11069
|
-
/**
|
|
11070
|
-
* The data type of the property
|
|
11071
|
-
*/
|
|
11072
|
-
dataType: string;
|
|
11073
|
-
/**
|
|
11074
|
-
* Defines constraints for the data type of the property
|
|
11075
|
-
*/
|
|
11076
|
-
constraints?: object;
|
|
11077
|
-
/**
|
|
11078
|
-
* Defines format options for the data type of the property
|
|
11079
|
-
*/
|
|
11080
|
-
formatOptions?: object;
|
|
11081
|
-
/**
|
|
11082
|
-
* The group identifier to which the property belongs
|
|
11083
|
-
*/
|
|
11084
|
-
group?: string;
|
|
11085
|
-
/**
|
|
11086
|
-
* The group name of the group identifier
|
|
11087
|
-
*/
|
|
11088
|
-
groupLabel?: string;
|
|
11089
|
-
/**
|
|
11090
|
-
* If set to `true`, the filter value is treated as case-sensitive
|
|
11091
|
-
*/
|
|
11092
|
-
caseSensitive?: boolean;
|
|
11093
|
-
/**
|
|
11094
|
-
* Describes how the value will be presented to the user
|
|
11502
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
11095
11503
|
*/
|
|
11096
|
-
|
|
11504
|
+
setShowClearButton(
|
|
11505
|
+
/**
|
|
11506
|
+
* New value for property `showClearButton`
|
|
11507
|
+
*/
|
|
11508
|
+
bShowClearButton?: boolean
|
|
11509
|
+
): this;
|
|
11510
|
+
}
|
|
11511
|
+
/**
|
|
11512
|
+
* @since 1.112.0
|
|
11513
|
+
*/
|
|
11514
|
+
export type PropertyInfo = PropertyInfo1 & {
|
|
11097
11515
|
/**
|
|
11098
11516
|
* If set to `false`, the filter is visible in the `FilterBar`
|
|
11099
11517
|
*/
|
|
@@ -11102,10 +11520,6 @@ declare module "sap/ui/mdc/FilterBar" {
|
|
|
11102
11520
|
* If set to `true`, the filter is mandatory
|
|
11103
11521
|
*/
|
|
11104
11522
|
required?: boolean;
|
|
11105
|
-
/**
|
|
11106
|
-
* Defines if the filter supports multiple values `-1` or single values `1`
|
|
11107
|
-
*/
|
|
11108
|
-
maxConditions?: int;
|
|
11109
11523
|
};
|
|
11110
11524
|
|
|
11111
11525
|
export interface $FilterBarSettings extends $FilterBarBaseSettings {
|
|
@@ -11460,16 +11874,23 @@ declare module "sap/ui/mdc/filterbar/FilterBarBase" {
|
|
|
11460
11874
|
/**
|
|
11461
11875
|
* Gets current value of property {@link #getDelegate delegate}.
|
|
11462
11876
|
*
|
|
11463
|
-
*
|
|
11464
|
-
*
|
|
11465
|
-
* the
|
|
11877
|
+
* Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
|
|
11878
|
+
* The object has the following properties:
|
|
11879
|
+
* - `name` defines the path to the `Delegate` module
|
|
11880
|
+
* - `payload` (optional) defines application-specific information that can be used in the given delegate
|
|
11881
|
+
* Sample delegate object:
|
|
11882
|
+
* ```javascript
|
|
11883
|
+
* {
|
|
11884
|
+
* name: "sap/ui/mdc/BaseDelegate",
|
|
11885
|
+
* payload: {}
|
|
11886
|
+
* }```
|
|
11466
11887
|
* **Note:** Ensure that the related file can be requested (any required library has to be loaded before
|
|
11467
11888
|
* that).
|
|
11468
|
-
*
|
|
11889
|
+
* Do not bind or modify the module. This property can only be configured during control initialization.
|
|
11469
11890
|
*
|
|
11470
11891
|
* Default value is `...see text or source`.
|
|
11471
11892
|
*
|
|
11472
|
-
* @
|
|
11893
|
+
* @experimental
|
|
11473
11894
|
*
|
|
11474
11895
|
* @returns Value of property `delegate`
|
|
11475
11896
|
*/
|
|
@@ -11547,7 +11968,7 @@ declare module "sap/ui/mdc/filterbar/FilterBarBase" {
|
|
|
11547
11968
|
* ID of the element which is the current target of the association {@link #getVariantBackreference variantBackreference},
|
|
11548
11969
|
* or `null`.
|
|
11549
11970
|
*/
|
|
11550
|
-
getVariantBackreference(): ID;
|
|
11971
|
+
getVariantBackreference(): ID | null;
|
|
11551
11972
|
/**
|
|
11552
11973
|
* Checks for the provided `sap.ui.mdc.FilterField` in the aggregation {@link #getFilterItems filterItems}.
|
|
11553
11974
|
* and returns its index if found or -1 otherwise.
|
|
@@ -11590,18 +12011,25 @@ declare module "sap/ui/mdc/filterbar/FilterBarBase" {
|
|
|
11590
12011
|
/**
|
|
11591
12012
|
* Sets a new value for property {@link #getDelegate delegate}.
|
|
11592
12013
|
*
|
|
11593
|
-
*
|
|
11594
|
-
*
|
|
11595
|
-
* the
|
|
12014
|
+
* Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
|
|
12015
|
+
* The object has the following properties:
|
|
12016
|
+
* - `name` defines the path to the `Delegate` module
|
|
12017
|
+
* - `payload` (optional) defines application-specific information that can be used in the given delegate
|
|
12018
|
+
* Sample delegate object:
|
|
12019
|
+
* ```javascript
|
|
12020
|
+
* {
|
|
12021
|
+
* name: "sap/ui/mdc/BaseDelegate",
|
|
12022
|
+
* payload: {}
|
|
12023
|
+
* }```
|
|
11596
12024
|
* **Note:** Ensure that the related file can be requested (any required library has to be loaded before
|
|
11597
12025
|
* that).
|
|
11598
|
-
*
|
|
12026
|
+
* Do not bind or modify the module. This property can only be configured during control initialization.
|
|
11599
12027
|
*
|
|
11600
12028
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
11601
12029
|
*
|
|
11602
12030
|
* Default value is `...see text or source`.
|
|
11603
12031
|
*
|
|
11604
|
-
* @
|
|
12032
|
+
* @experimental
|
|
11605
12033
|
*
|
|
11606
12034
|
* @returns Reference to `this` in order to allow method chaining
|
|
11607
12035
|
*/
|
|
@@ -11709,8 +12137,8 @@ declare module "sap/ui/mdc/filterbar/FilterBarBase" {
|
|
|
11709
12137
|
* Triggers the search.
|
|
11710
12138
|
*
|
|
11711
12139
|
*
|
|
11712
|
-
* @returns If the {@link sap.ui.mdc.FilterBarBase#setSuspendSelection suspendSelection} property
|
|
11713
|
-
* to `true`, the method will be immediately resolved, otherwise it returns the result of the {@link sap.ui.mdc.FilterBarBase#validate }
|
|
12140
|
+
* @returns If the {@link sap.ui.mdc.filterbar.FilterBarBase#setSuspendSelection suspendSelection} property
|
|
12141
|
+
* is set to `true`, the method will be immediately resolved, otherwise it returns the result of the {@link sap.ui.mdc.filterbar.FilterBarBase#validate }
|
|
11714
12142
|
* call.
|
|
11715
12143
|
*/
|
|
11716
12144
|
triggerSearch(): Promise<any>;
|
|
@@ -11730,14 +12158,21 @@ declare module "sap/ui/mdc/filterbar/FilterBarBase" {
|
|
|
11730
12158
|
|
|
11731
12159
|
export interface $FilterBarBaseSettings extends $ControlSettings {
|
|
11732
12160
|
/**
|
|
11733
|
-
*
|
|
11734
|
-
*
|
|
11735
|
-
* the
|
|
12161
|
+
* Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
|
|
12162
|
+
* The object has the following properties:
|
|
12163
|
+
* - `name` defines the path to the `Delegate` module
|
|
12164
|
+
* - `payload` (optional) defines application-specific information that can be used in the given delegate
|
|
12165
|
+
* Sample delegate object:
|
|
12166
|
+
* ```javascript
|
|
12167
|
+
* {
|
|
12168
|
+
* name: "sap/ui/mdc/BaseDelegate",
|
|
12169
|
+
* payload: {}
|
|
12170
|
+
* }```
|
|
11736
12171
|
* **Note:** Ensure that the related file can be requested (any required library has to be loaded before
|
|
11737
12172
|
* that).
|
|
11738
|
-
*
|
|
12173
|
+
* Do not bind or modify the module. This property can only be configured during control initialization.
|
|
11739
12174
|
*
|
|
11740
|
-
* @
|
|
12175
|
+
* @experimental
|
|
11741
12176
|
*/
|
|
11742
12177
|
delegate?: object | PropertyBindingInfo | `{${string}}`;
|
|
11743
12178
|
|
|
@@ -11950,8 +12385,8 @@ declare module "sap/ui/mdc/filterbar/vh/FilterBar" {
|
|
|
11950
12385
|
* and the width of the filters. The Go button triggers the search event, and the Show Filters button shows
|
|
11951
12386
|
* the additional filter field.
|
|
11952
12387
|
* The `FilterBar` control creates and handles the filters based on the provided metadata information.
|
|
11953
|
-
* The metadata information is provided via the {@link sap
|
|
11954
|
-
* This implementation has to be provided by the application.
|
|
12388
|
+
* The metadata information is provided via the {@link module:sap/ui/mdc/FilterBarDelegate FilterBarDelegate }
|
|
12389
|
+
* implementation. This implementation has to be provided by the application.
|
|
11955
12390
|
* **Note:** The `FilterBar` can only be used for a {@link sap.ui.mdc.valuehelp.Dialog Dialog} and not
|
|
11956
12391
|
* on its own.
|
|
11957
12392
|
*
|
|
@@ -12020,31 +12455,19 @@ declare module "sap/ui/mdc/filterbar/vh/FilterBar" {
|
|
|
12020
12455
|
* @returns Metadata object describing this class
|
|
12021
12456
|
*/
|
|
12022
12457
|
static getMetadata(): ElementMetadata;
|
|
12023
|
-
/**
|
|
12024
|
-
* Destroys the {@link sap.ui.mdc.filterbar.vh.CollectiveSearchSelect CollectiveSearchSelect} control.
|
|
12025
|
-
*
|
|
12026
|
-
* **Note:** This must only be used by the corresponding value help, not from outside.
|
|
12027
|
-
*
|
|
12028
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
12029
|
-
*
|
|
12030
|
-
* @returns Reference to `this` to allow method chaining
|
|
12031
|
-
*/
|
|
12032
|
-
destroyCollectiveSearch(): this;
|
|
12033
|
-
/**
|
|
12034
|
-
* Gets the {@link sap.ui.mdc.filterbar.vh.CollectiveSearchSelect CollectiveSearchSelect} control
|
|
12035
|
-
*
|
|
12036
|
-
* **Note:** This must only be used by the corresponding value help, not from outside.
|
|
12037
|
-
*
|
|
12038
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
12039
|
-
*
|
|
12040
|
-
* @returns Instance of the {@link sap.ui.mdc.filterbar.vh.CollectiveSearchSelect CollectiveSearchSelect }
|
|
12041
|
-
* control
|
|
12042
|
-
*/
|
|
12043
|
-
getCollectiveSearch(): /* was: sap.ui.mdc.filterbar.vh.CollectiveSearchSelect */ any;
|
|
12044
12458
|
/**
|
|
12045
12459
|
* Gets current value of property {@link #getDelegate delegate}.
|
|
12046
12460
|
*
|
|
12047
|
-
*
|
|
12461
|
+
* Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
|
|
12462
|
+
* The object has the following properties:
|
|
12463
|
+
* - `name` defines the path to the `Delegate` module
|
|
12464
|
+
* - `payload` (optional) defines application-specific information that can be used in the given delegate
|
|
12465
|
+
* Sample delegate object:
|
|
12466
|
+
* ```javascript
|
|
12467
|
+
* {
|
|
12468
|
+
* name: "sap/ui/mdc/BaseDelegate",
|
|
12469
|
+
* payload: {}
|
|
12470
|
+
* }```
|
|
12048
12471
|
* **Note:** Ensure that the related file can be requested (any required library has to be loaded before
|
|
12049
12472
|
* that).
|
|
12050
12473
|
* Do not bind or modify the module. This property can only be configured during control initialization.
|
|
@@ -12080,25 +12503,19 @@ declare module "sap/ui/mdc/filterbar/vh/FilterBar" {
|
|
|
12080
12503
|
* @returns Value of property `filterFieldThreshold`
|
|
12081
12504
|
*/
|
|
12082
12505
|
getFilterFieldThreshold(): int;
|
|
12083
|
-
/**
|
|
12084
|
-
* Sets the {@link sap.ui.mdc.filterbar.vh.CollectiveSearchSelect CollectiveSearchSelect} control.
|
|
12085
|
-
*
|
|
12086
|
-
* **Note:** This must only be done by the corresponding value help, not from outside.
|
|
12087
|
-
*
|
|
12088
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
12089
|
-
*
|
|
12090
|
-
* @returns Reference to `this` to allow method chaining
|
|
12091
|
-
*/
|
|
12092
|
-
setCollectiveSearch(
|
|
12093
|
-
/**
|
|
12094
|
-
* Instance of the {@link sap.ui.mdc.filterbar.vh.CollectiveSearchSelect CollectiveSearchSelect} control
|
|
12095
|
-
*/
|
|
12096
|
-
oCollectiveSearch: /* was: sap.ui.mdc.filterbar.vh.CollectiveSearchSelect */ any
|
|
12097
|
-
): this;
|
|
12098
12506
|
/**
|
|
12099
12507
|
* Sets a new value for property {@link #getDelegate delegate}.
|
|
12100
12508
|
*
|
|
12101
|
-
*
|
|
12509
|
+
* Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
|
|
12510
|
+
* The object has the following properties:
|
|
12511
|
+
* - `name` defines the path to the `Delegate` module
|
|
12512
|
+
* - `payload` (optional) defines application-specific information that can be used in the given delegate
|
|
12513
|
+
* Sample delegate object:
|
|
12514
|
+
* ```javascript
|
|
12515
|
+
* {
|
|
12516
|
+
* name: "sap/ui/mdc/BaseDelegate",
|
|
12517
|
+
* payload: {}
|
|
12518
|
+
* }```
|
|
12102
12519
|
* **Note:** Ensure that the related file can be requested (any required library has to be loaded before
|
|
12103
12520
|
* that).
|
|
12104
12521
|
* Do not bind or modify the module. This property can only be configured during control initialization.
|
|
@@ -12159,7 +12576,16 @@ declare module "sap/ui/mdc/filterbar/vh/FilterBar" {
|
|
|
12159
12576
|
|
|
12160
12577
|
export interface $FilterBarSettings extends $FilterBarBaseSettings {
|
|
12161
12578
|
/**
|
|
12162
|
-
*
|
|
12579
|
+
* Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
|
|
12580
|
+
* The object has the following properties:
|
|
12581
|
+
* - `name` defines the path to the `Delegate` module
|
|
12582
|
+
* - `payload` (optional) defines application-specific information that can be used in the given delegate
|
|
12583
|
+
* Sample delegate object:
|
|
12584
|
+
* ```javascript
|
|
12585
|
+
* {
|
|
12586
|
+
* name: "sap/ui/mdc/BaseDelegate",
|
|
12587
|
+
* payload: {}
|
|
12588
|
+
* }```
|
|
12163
12589
|
* **Note:** Ensure that the related file can be requested (any required library has to be loaded before
|
|
12164
12590
|
* that).
|
|
12165
12591
|
* Do not bind or modify the module. This property can only be configured during control initialization.
|
|
@@ -12443,6 +12869,12 @@ declare module "sap/ui/mdc/FilterField" {
|
|
|
12443
12869
|
* If empty, default operators depending on used data type are taken. The standard operators are mentioned
|
|
12444
12870
|
* in {@link sap.ui.mdc.enums.OperatorName OperatorName}.
|
|
12445
12871
|
*
|
|
12872
|
+
* **Note:** If a custom control is used as {@link sap.ui.mdc.field.FieldBase#setContent Content}, {@link sap.ui.mdc.field.FieldBase#setContentEdit ContentEdit},
|
|
12873
|
+
* or {@link sap.ui.mdc.field.FieldBase#setContentDisplay ContentDisplay}, and the custom control only supports
|
|
12874
|
+
* one operator (as no operator can be shown), only the required operator must be set. So the user input
|
|
12875
|
+
* into the custom control creates a condition with the set operator, and a condition with this operator
|
|
12876
|
+
* provides the value the custom control needs.
|
|
12877
|
+
*
|
|
12446
12878
|
* Default value is `[]`.
|
|
12447
12879
|
*
|
|
12448
12880
|
* @since 1.73.0
|
|
@@ -12536,6 +12968,12 @@ declare module "sap/ui/mdc/FilterField" {
|
|
|
12536
12968
|
* If empty, default operators depending on used data type are taken. The standard operators are mentioned
|
|
12537
12969
|
* in {@link sap.ui.mdc.enums.OperatorName OperatorName}.
|
|
12538
12970
|
*
|
|
12971
|
+
* **Note:** If a custom control is used as {@link sap.ui.mdc.field.FieldBase#setContent Content}, {@link sap.ui.mdc.field.FieldBase#setContentEdit ContentEdit},
|
|
12972
|
+
* or {@link sap.ui.mdc.field.FieldBase#setContentDisplay ContentDisplay}, and the custom control only supports
|
|
12973
|
+
* one operator (as no operator can be shown), only the required operator must be set. So the user input
|
|
12974
|
+
* into the custom control creates a condition with the set operator, and a condition with this operator
|
|
12975
|
+
* provides the value the custom control needs.
|
|
12976
|
+
*
|
|
12539
12977
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
12540
12978
|
*
|
|
12541
12979
|
* Default value is `[]`.
|
|
@@ -12578,6 +13016,12 @@ declare module "sap/ui/mdc/FilterField" {
|
|
|
12578
13016
|
* If empty, default operators depending on used data type are taken. The standard operators are mentioned
|
|
12579
13017
|
* in {@link sap.ui.mdc.enums.OperatorName OperatorName}.
|
|
12580
13018
|
*
|
|
13019
|
+
* **Note:** If a custom control is used as {@link sap.ui.mdc.field.FieldBase#setContent Content}, {@link sap.ui.mdc.field.FieldBase#setContentEdit ContentEdit},
|
|
13020
|
+
* or {@link sap.ui.mdc.field.FieldBase#setContentDisplay ContentDisplay}, and the custom control only supports
|
|
13021
|
+
* one operator (as no operator can be shown), only the required operator must be set. So the user input
|
|
13022
|
+
* into the custom control creates a condition with the set operator, and a condition with this operator
|
|
13023
|
+
* provides the value the custom control needs.
|
|
13024
|
+
*
|
|
12581
13025
|
* @since 1.73.0
|
|
12582
13026
|
*/
|
|
12583
13027
|
operators?: string[] | PropertyBindingInfo | `{${string}}`;
|
|
@@ -12773,11 +13217,19 @@ declare module "sap/ui/mdc/Link" {
|
|
|
12773
13217
|
/**
|
|
12774
13218
|
* Gets current value of property {@link #getDelegate delegate}.
|
|
12775
13219
|
*
|
|
12776
|
-
*
|
|
13220
|
+
* Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
|
|
13221
|
+
* The object has the following properties:
|
|
13222
|
+
* - `name` defines the path to the `Delegate` module
|
|
13223
|
+
* - `payload` (optional) defines application-specific information that can be used in the given delegate
|
|
13224
|
+
* Sample delegate object:
|
|
13225
|
+
* ```javascript
|
|
13226
|
+
* {
|
|
13227
|
+
* name: "sap/ui/mdc/BaseDelegate",
|
|
13228
|
+
* payload: {}
|
|
13229
|
+
* }```
|
|
12777
13230
|
* **Note:** Ensure that the related file can be requested (any required library has to be loaded before
|
|
12778
13231
|
* that).
|
|
12779
|
-
* Do not bind or modify the module.
|
|
12780
|
-
* needed any longer.
|
|
13232
|
+
* Do not bind or modify the module. This property can only be configured during control initialization.
|
|
12781
13233
|
*
|
|
12782
13234
|
* Default value is `...see text or source`.
|
|
12783
13235
|
*
|
|
@@ -12801,7 +13253,7 @@ declare module "sap/ui/mdc/Link" {
|
|
|
12801
13253
|
* ID of the element which is the current target of the association {@link #getSourceControl sourceControl},
|
|
12802
13254
|
* or `null`.
|
|
12803
13255
|
*/
|
|
12804
|
-
getSourceControl(): ID;
|
|
13256
|
+
getSourceControl(): ID | null;
|
|
12805
13257
|
/**
|
|
12806
13258
|
* Retrieves the `AdditionalContent` objects depending on the given `LinkDelegate`. Caches the returned
|
|
12807
13259
|
* objects for further usage.
|
|
@@ -12827,11 +13279,19 @@ declare module "sap/ui/mdc/Link" {
|
|
|
12827
13279
|
/**
|
|
12828
13280
|
* Sets a new value for property {@link #getDelegate delegate}.
|
|
12829
13281
|
*
|
|
12830
|
-
*
|
|
13282
|
+
* Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
|
|
13283
|
+
* The object has the following properties:
|
|
13284
|
+
* - `name` defines the path to the `Delegate` module
|
|
13285
|
+
* - `payload` (optional) defines application-specific information that can be used in the given delegate
|
|
13286
|
+
* Sample delegate object:
|
|
13287
|
+
* ```javascript
|
|
13288
|
+
* {
|
|
13289
|
+
* name: "sap/ui/mdc/BaseDelegate",
|
|
13290
|
+
* payload: {}
|
|
13291
|
+
* }```
|
|
12831
13292
|
* **Note:** Ensure that the related file can be requested (any required library has to be loaded before
|
|
12832
13293
|
* that).
|
|
12833
|
-
* Do not bind or modify the module.
|
|
12834
|
-
* needed any longer.
|
|
13294
|
+
* Do not bind or modify the module. This property can only be configured during control initialization.
|
|
12835
13295
|
*
|
|
12836
13296
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
12837
13297
|
*
|
|
@@ -12944,11 +13404,19 @@ declare module "sap/ui/mdc/Link" {
|
|
|
12944
13404
|
enablePersonalization?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
12945
13405
|
|
|
12946
13406
|
/**
|
|
12947
|
-
*
|
|
13407
|
+
* Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
|
|
13408
|
+
* The object has the following properties:
|
|
13409
|
+
* - `name` defines the path to the `Delegate` module
|
|
13410
|
+
* - `payload` (optional) defines application-specific information that can be used in the given delegate
|
|
13411
|
+
* Sample delegate object:
|
|
13412
|
+
* ```javascript
|
|
13413
|
+
* {
|
|
13414
|
+
* name: "sap/ui/mdc/BaseDelegate",
|
|
13415
|
+
* payload: {}
|
|
13416
|
+
* }```
|
|
12948
13417
|
* **Note:** Ensure that the related file can be requested (any required library has to be loaded before
|
|
12949
13418
|
* that).
|
|
12950
|
-
* Do not bind or modify the module.
|
|
12951
|
-
* needed any longer.
|
|
13419
|
+
* Do not bind or modify the module. This property can only be configured during control initialization.
|
|
12952
13420
|
*
|
|
12953
13421
|
* @experimental
|
|
12954
13422
|
*/
|
|
@@ -13587,12 +14055,19 @@ declare module "sap/ui/mdc/MultiValueField" {
|
|
|
13587
14055
|
/**
|
|
13588
14056
|
* Gets current value of property {@link #getDelegate delegate}.
|
|
13589
14057
|
*
|
|
13590
|
-
*
|
|
13591
|
-
*
|
|
14058
|
+
* Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
|
|
14059
|
+
* The object has the following properties:
|
|
14060
|
+
* - `name` defines the path to the `Delegate` module
|
|
14061
|
+
* - `payload` (optional) defines application-specific information that can be used in the given delegate
|
|
14062
|
+
* Sample delegate object:
|
|
14063
|
+
* ```javascript
|
|
14064
|
+
* {
|
|
14065
|
+
* name: "sap/ui/mdc/BaseDelegate",
|
|
14066
|
+
* payload: {}
|
|
14067
|
+
* }```
|
|
13592
14068
|
* **Note:** Ensure that the related file can be requested (any required library has to be loaded before
|
|
13593
14069
|
* that).
|
|
13594
|
-
* Do not bind or modify the module.
|
|
13595
|
-
* needed any longer.
|
|
14070
|
+
* Do not bind or modify the module. This property can only be configured during control initialization.
|
|
13596
14071
|
*
|
|
13597
14072
|
* Default value is `...see text or source`.
|
|
13598
14073
|
*
|
|
@@ -13738,12 +14213,19 @@ declare module "sap/ui/mdc/MultiValueField" {
|
|
|
13738
14213
|
/**
|
|
13739
14214
|
* Sets a new value for property {@link #getDelegate delegate}.
|
|
13740
14215
|
*
|
|
13741
|
-
*
|
|
13742
|
-
*
|
|
14216
|
+
* Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
|
|
14217
|
+
* The object has the following properties:
|
|
14218
|
+
* - `name` defines the path to the `Delegate` module
|
|
14219
|
+
* - `payload` (optional) defines application-specific information that can be used in the given delegate
|
|
14220
|
+
* Sample delegate object:
|
|
14221
|
+
* ```javascript
|
|
14222
|
+
* {
|
|
14223
|
+
* name: "sap/ui/mdc/BaseDelegate",
|
|
14224
|
+
* payload: {}
|
|
14225
|
+
* }```
|
|
13743
14226
|
* **Note:** Ensure that the related file can be requested (any required library has to be loaded before
|
|
13744
14227
|
* that).
|
|
13745
|
-
* Do not bind or modify the module.
|
|
13746
|
-
* needed any longer.
|
|
14228
|
+
* Do not bind or modify the module. This property can only be configured during control initialization.
|
|
13747
14229
|
*
|
|
13748
14230
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
13749
14231
|
*
|
|
@@ -13806,12 +14288,19 @@ declare module "sap/ui/mdc/MultiValueField" {
|
|
|
13806
14288
|
|
|
13807
14289
|
export interface $MultiValueFieldSettings extends $FieldBaseSettings {
|
|
13808
14290
|
/**
|
|
13809
|
-
*
|
|
13810
|
-
*
|
|
14291
|
+
* Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
|
|
14292
|
+
* The object has the following properties:
|
|
14293
|
+
* - `name` defines the path to the `Delegate` module
|
|
14294
|
+
* - `payload` (optional) defines application-specific information that can be used in the given delegate
|
|
14295
|
+
* Sample delegate object:
|
|
14296
|
+
* ```javascript
|
|
14297
|
+
* {
|
|
14298
|
+
* name: "sap/ui/mdc/BaseDelegate",
|
|
14299
|
+
* payload: {}
|
|
14300
|
+
* }```
|
|
13811
14301
|
* **Note:** Ensure that the related file can be requested (any required library has to be loaded before
|
|
13812
14302
|
* that).
|
|
13813
|
-
* Do not bind or modify the module.
|
|
13814
|
-
* needed any longer.
|
|
14303
|
+
* Do not bind or modify the module. This property can only be configured during control initialization.
|
|
13815
14304
|
*
|
|
13816
14305
|
* @experimental
|
|
13817
14306
|
*/
|
|
@@ -13908,11 +14397,11 @@ declare module "sap/ui/mdc/Table" {
|
|
|
13908
14397
|
import Event from "sap/ui/base/Event";
|
|
13909
14398
|
|
|
13910
14399
|
/**
|
|
13911
|
-
* An object literal describing a data property in the context of a {@link sap.ui.mdc.Table} with {@link module:sap/ui/mdc/odata/v4/TableDelegate}.
|
|
14400
|
+
* An object literal describing a data property in the context of a {@link sap.ui.mdc.Table} with {@link module:sap/ui/mdc/odata/v4/TableDelegate sap/ui/mdc/odata/v4/TableDelegate}.
|
|
13912
14401
|
*
|
|
13913
14402
|
* When specifying the `PropertyInfo` objects in the {@link sap.ui.mdc.Table#getPropertyInfo propertyInfo }
|
|
13914
14403
|
* property, the following attributes need to be specified:
|
|
13915
|
-
* - `
|
|
14404
|
+
* - `key`
|
|
13916
14405
|
* - `path`
|
|
13917
14406
|
* - `dataType`
|
|
13918
14407
|
* - `formatOptions`
|
|
@@ -13922,7 +14411,7 @@ declare module "sap/ui/mdc/Table" {
|
|
|
13922
14411
|
* - `visualSettings.widthCalculation`
|
|
13923
14412
|
* - `propertyInfos`
|
|
13924
14413
|
* - `groupable`
|
|
13925
|
-
* - `
|
|
14414
|
+
* - `isKey`
|
|
13926
14415
|
* - `unit`
|
|
13927
14416
|
* - `text`
|
|
13928
14417
|
* - `aggregatable`
|
|
@@ -13932,7 +14421,7 @@ declare module "sap/ui/mdc/Table" {
|
|
|
13932
14421
|
* - `extension.customAggregate.contextDefiningProperties`
|
|
13933
14422
|
*
|
|
13934
14423
|
* If the property is complex, the following attributes need to be specified:
|
|
13935
|
-
* - `
|
|
14424
|
+
* - `key`
|
|
13936
14425
|
* - `visualSettings.widthCalculation`
|
|
13937
14426
|
* - `propertyInfos` (all referenced properties must be specified)
|
|
13938
14427
|
*/
|
|
@@ -13973,6 +14462,10 @@ declare module "sap/ui/mdc/Table" {
|
|
|
13973
14462
|
* controls. The metadata needs to be provided via the {@link module:sap/ui/mdc/TableDelegate TableDelegate }
|
|
13974
14463
|
* implementation as {@link sap.ui.mdc.table.PropertyInfo}.
|
|
13975
14464
|
*
|
|
14465
|
+
* **Note:** Read and write access to internal elements is not permitted. Such elements are, for example,
|
|
14466
|
+
* the inner table including its children. This is independent of how access was gained. Internal elements
|
|
14467
|
+
* and their types are subject to change without notice.
|
|
14468
|
+
*
|
|
13976
14469
|
* @since 1.58
|
|
13977
14470
|
* @experimental (since 1.58.0)
|
|
13978
14471
|
*/
|
|
@@ -13980,7 +14473,7 @@ declare module "sap/ui/mdc/Table" {
|
|
|
13980
14473
|
__implements__sap_ui_mdc_IFilterSource: boolean;
|
|
13981
14474
|
__implements__sap_ui_mdc_IxState: boolean;
|
|
13982
14475
|
/**
|
|
13983
|
-
* Constructor for a new `
|
|
14476
|
+
* Constructor for a new `Table`.
|
|
13984
14477
|
*
|
|
13985
14478
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
13986
14479
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
@@ -13993,7 +14486,7 @@ declare module "sap/ui/mdc/Table" {
|
|
|
13993
14486
|
mSettings?: $TableSettings
|
|
13994
14487
|
);
|
|
13995
14488
|
/**
|
|
13996
|
-
* Constructor for a new `
|
|
14489
|
+
* Constructor for a new `Table`.
|
|
13997
14490
|
*
|
|
13998
14491
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
13999
14492
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
@@ -14199,7 +14692,7 @@ declare module "sap/ui/mdc/Table" {
|
|
|
14199
14692
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
14200
14693
|
* otherwise it will be bound to this `sap.ui.mdc.Table` itself.
|
|
14201
14694
|
*
|
|
14202
|
-
* This event is fired when a row
|
|
14695
|
+
* This event is fired when a row is pressed.
|
|
14203
14696
|
*
|
|
14204
14697
|
*
|
|
14205
14698
|
* @returns Reference to `this` in order to allow method chaining
|
|
@@ -14225,7 +14718,7 @@ declare module "sap/ui/mdc/Table" {
|
|
|
14225
14718
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
14226
14719
|
* otherwise it will be bound to this `sap.ui.mdc.Table` itself.
|
|
14227
14720
|
*
|
|
14228
|
-
* This event is fired when a row
|
|
14721
|
+
* This event is fired when a row is pressed.
|
|
14229
14722
|
*
|
|
14230
14723
|
*
|
|
14231
14724
|
* @returns Reference to `this` in order to allow method chaining
|
|
@@ -14247,7 +14740,7 @@ declare module "sap/ui/mdc/Table" {
|
|
|
14247
14740
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
14248
14741
|
* otherwise it will be bound to this `sap.ui.mdc.Table` itself.
|
|
14249
14742
|
*
|
|
14250
|
-
* This event is fired when the selection
|
|
14743
|
+
* This event is fired when the selection is changed.
|
|
14251
14744
|
*
|
|
14252
14745
|
*
|
|
14253
14746
|
* @returns Reference to `this` in order to allow method chaining
|
|
@@ -14274,7 +14767,7 @@ declare module "sap/ui/mdc/Table" {
|
|
|
14274
14767
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
14275
14768
|
* otherwise it will be bound to this `sap.ui.mdc.Table` itself.
|
|
14276
14769
|
*
|
|
14277
|
-
* This event is fired when the selection
|
|
14770
|
+
* This event is fired when the selection is changed.
|
|
14278
14771
|
*
|
|
14279
14772
|
*
|
|
14280
14773
|
* @returns Reference to `this` in order to allow method chaining
|
|
@@ -14557,10 +15050,11 @@ declare module "sap/ui/mdc/Table" {
|
|
|
14557
15050
|
/**
|
|
14558
15051
|
* Gets content of aggregation {@link #getActions actions}.
|
|
14559
15052
|
*
|
|
14560
|
-
* Additional
|
|
14561
|
-
*
|
|
14562
|
-
*
|
|
14563
|
-
*
|
|
15053
|
+
* Additional actions that will be available in the toolbar.
|
|
15054
|
+
*
|
|
15055
|
+
* **Note:** This aggregation is managed by the control, can only be populated during the definition in
|
|
15056
|
+
* the XML view, and is not bindable. Any changes of the initial aggregation content might result in undesired
|
|
15057
|
+
* effects. Changes of the aggregation have to be made with the {@link sap.ui.mdc.p13n.StateUtil StateUtil}.
|
|
14564
15058
|
*/
|
|
14565
15059
|
getActions(): Control1[];
|
|
14566
15060
|
/**
|
|
@@ -14588,11 +15082,10 @@ declare module "sap/ui/mdc/Table" {
|
|
|
14588
15082
|
/**
|
|
14589
15083
|
* Gets content of aggregation {@link #getCellSelector cellSelector}.
|
|
14590
15084
|
*
|
|
14591
|
-
* Defines an aggregation for the `CellSelector` plugin that provides cell selection capabilities
|
|
14592
|
-
* table.
|
|
15085
|
+
* Defines an aggregation for the `CellSelector` plugin that provides cell selection capabilities.
|
|
14593
15086
|
*
|
|
14594
|
-
* **Note:** The `CellSelector` is currently only available in combination with the
|
|
14595
|
-
* refer to {@link sap.m.plugins.CellSelector}
|
|
15087
|
+
* **Note:** The `CellSelector` is currently only available in combination with the {@link sap.ui.mdc.table.GridTableType GridTable}.
|
|
15088
|
+
* Please refer to {@link sap.m.plugins.CellSelector} for additional restrictions.
|
|
14596
15089
|
*
|
|
14597
15090
|
* @since 1.119
|
|
14598
15091
|
*/
|
|
@@ -14600,15 +15093,17 @@ declare module "sap/ui/mdc/Table" {
|
|
|
14600
15093
|
/**
|
|
14601
15094
|
* Gets content of aggregation {@link #getColumns columns}.
|
|
14602
15095
|
*
|
|
14603
|
-
* Columns of the table.
|
|
14604
|
-
*
|
|
14605
|
-
*
|
|
15096
|
+
* Columns of the table.
|
|
15097
|
+
*
|
|
15098
|
+
* **Note:** This aggregation is managed by the control, can only be populated during the definition in
|
|
15099
|
+
* the XML view, and is not bindable. Any changes of the initial aggregation content might result in unwanted
|
|
15100
|
+
* effects. Changes of the aggregation have to be made with the {@link sap.ui.mdc.p13n.StateUtil StateUtil}.
|
|
14606
15101
|
*/
|
|
14607
15102
|
getColumns(): Column[];
|
|
14608
15103
|
/**
|
|
14609
15104
|
* Gets content of aggregation {@link #getContextMenu contextMenu}.
|
|
14610
15105
|
*
|
|
14611
|
-
* Defines the context menu for the
|
|
15106
|
+
* Defines the context menu for the rows.
|
|
14612
15107
|
*
|
|
14613
15108
|
* @since 1.118
|
|
14614
15109
|
*/
|
|
@@ -14617,15 +15112,15 @@ declare module "sap/ui/mdc/Table" {
|
|
|
14617
15112
|
* Gets content of aggregation {@link #getCopyProvider copyProvider}.
|
|
14618
15113
|
*
|
|
14619
15114
|
* Defines an aggregation for the `CopyProvider` plugin that provides copy to clipboard capabilities for
|
|
14620
|
-
* the selected rows
|
|
14621
|
-
*
|
|
14622
|
-
*
|
|
14623
|
-
*
|
|
15115
|
+
* the selected rows and creates a Copy button for the toolbar. To disable the copy function, including
|
|
15116
|
+
* the Copy button in the toolbar, the `enabled` property of the `CopyProvider` must be set to `false`.
|
|
15117
|
+
* To hide the Copy button from the toolbar, the `visible` property of the `CopyProvider` must be set to
|
|
15118
|
+
* `false`.
|
|
14624
15119
|
*
|
|
14625
15120
|
* **Note:** The {@link sap.m.plugins.CopyProvider#extractData extractData} property of the `CopyProvider`
|
|
14626
|
-
* must not be managed by the application.
|
|
14627
|
-
* the clipboard API. If the context is not secure,
|
|
14628
|
-
* not be generated.
|
|
15121
|
+
* must not be managed by the application.
|
|
15122
|
+
* The `CopyProvider` requires a secure context to access the clipboard API. If the context is not secure,
|
|
15123
|
+
* the plugin will not be added, and the Copy button will not be generated.
|
|
14629
15124
|
*
|
|
14630
15125
|
* @since 1.114
|
|
14631
15126
|
*/
|
|
@@ -14634,8 +15129,9 @@ declare module "sap/ui/mdc/Table" {
|
|
|
14634
15129
|
* Gets content of aggregation {@link #getCreationRow creationRow}.
|
|
14635
15130
|
*
|
|
14636
15131
|
* This row can be used for user input to create new data if {@link sap.ui.mdc.enums.TableType TableType }
|
|
14637
|
-
* is "`Table`".
|
|
14638
|
-
*
|
|
15132
|
+
* is "`Table`".
|
|
15133
|
+
*
|
|
15134
|
+
* **Note:** Once the binding supports creating transient records, this aggregation will be removed.
|
|
14639
15135
|
*
|
|
14640
15136
|
* @experimental - Do not use
|
|
14641
15137
|
*/
|
|
@@ -14654,11 +15150,22 @@ declare module "sap/ui/mdc/Table" {
|
|
|
14654
15150
|
/**
|
|
14655
15151
|
* Gets current value of property {@link #getDelegate delegate}.
|
|
14656
15152
|
*
|
|
14657
|
-
*
|
|
14658
|
-
*
|
|
15153
|
+
* Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
|
|
15154
|
+
* The object has the following properties:
|
|
15155
|
+
* - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/TableDelegate TableDelegate}.
|
|
15156
|
+
*
|
|
15157
|
+
* - `payload` (optional) defines application-specific information that can be used in the given delegate
|
|
15158
|
+
* Sample delegate object:
|
|
15159
|
+
* ```javascript
|
|
15160
|
+
* {
|
|
15161
|
+
* name: "sap/ui/mdc/TableDelegate",
|
|
15162
|
+
* payload: {}
|
|
15163
|
+
* }```
|
|
15164
|
+
*
|
|
15165
|
+
*
|
|
15166
|
+
* **Note:** Ensure that the related file can be requested (any required library has to be loaded before
|
|
14659
15167
|
* that).
|
|
14660
|
-
* Do not bind or modify the module.
|
|
14661
|
-
* needed any longer.
|
|
15168
|
+
* Do not bind or modify the module. This property can only be configured during control initialization.
|
|
14662
15169
|
*
|
|
14663
15170
|
* Default value is `...see text or source`.
|
|
14664
15171
|
*
|
|
@@ -14670,16 +15177,18 @@ declare module "sap/ui/mdc/Table" {
|
|
|
14670
15177
|
/**
|
|
14671
15178
|
* Gets current value of property {@link #getEnableAutoColumnWidth enableAutoColumnWidth}.
|
|
14672
15179
|
*
|
|
14673
|
-
* Enables automatic column width calculation
|
|
14674
|
-
*
|
|
14675
|
-
*
|
|
14676
|
-
*
|
|
14677
|
-
*
|
|
15180
|
+
* Enables automatic column width calculation. The column width calculation takes the type, column label,
|
|
15181
|
+
* referenced properties, and other information into account. The calculated column widths can have a minimum
|
|
15182
|
+
* of 3rem and a maximum of 20rem.
|
|
15183
|
+
*
|
|
15184
|
+
* The delegate can customize the automatic column width calculation with the `visualSettings.widthSettings`
|
|
15185
|
+
* field in the {@link sap.ui.mdc.table.PropertyInfo PropertyInfo}. To disable the heuristic column width
|
|
15186
|
+
* calculation for a particular column, the `visualSettings.widthSettings` field can be set to `null`. Providing
|
|
15187
|
+
* a more precise `maxLength` value for the `String` type or `precision` value for numeric types can help
|
|
15188
|
+
* the algorithm to produce better results.
|
|
14678
15189
|
*
|
|
14679
|
-
* **Note:**
|
|
14680
|
-
*
|
|
14681
|
-
* the `visualSettings.widthSettings` key of the `PropertyInfo` must be set to `null`. This feature has
|
|
14682
|
-
* no effect if the `width` property of the column is bound or its value is set.
|
|
15190
|
+
* **Note:** The column width is not calculated if the `width` property of the column is bound or its value
|
|
15191
|
+
* is set.
|
|
14683
15192
|
*
|
|
14684
15193
|
* Default value is `false`.
|
|
14685
15194
|
*
|
|
@@ -14703,8 +15212,12 @@ declare module "sap/ui/mdc/Table" {
|
|
|
14703
15212
|
/**
|
|
14704
15213
|
* Gets current value of property {@link #getEnableExport enableExport}.
|
|
14705
15214
|
*
|
|
14706
|
-
* Determines whether the
|
|
14707
|
-
*
|
|
15215
|
+
* Determines whether the data export is enabled.
|
|
15216
|
+
*
|
|
15217
|
+
* The delegate can customize the export result with the `exportSettings` field in the {@link sap.ui.mdc.table.PropertyInfo PropertyInfo}.
|
|
15218
|
+
*
|
|
15219
|
+
* **Note:** To use the export functionality, the {@link sap.ui.export} library is required, otherwise an
|
|
15220
|
+
* error message is displayed when the user presses the Export button.
|
|
14708
15221
|
*
|
|
14709
15222
|
* Default value is `false`.
|
|
14710
15223
|
*
|
|
@@ -14728,11 +15241,12 @@ declare module "sap/ui/mdc/Table" {
|
|
|
14728
15241
|
/**
|
|
14729
15242
|
* ID of the element which is the current target of the association {@link #getFilter filter}, or `null`.
|
|
14730
15243
|
*/
|
|
14731
|
-
getFilter(): ID;
|
|
15244
|
+
getFilter(): ID | null;
|
|
14732
15245
|
/**
|
|
14733
15246
|
* Gets current value of property {@link #getHeader header}.
|
|
14734
15247
|
*
|
|
14735
|
-
* Header text that is shown in the table.
|
|
15248
|
+
* Header text that is shown in the table. The header must always be set to comply with accessibility standards,
|
|
15249
|
+
* even if other settings make the header invisible.
|
|
14736
15250
|
*
|
|
14737
15251
|
*
|
|
14738
15252
|
* @returns Value of property `header`
|
|
@@ -14777,24 +15291,52 @@ declare module "sap/ui/mdc/Table" {
|
|
|
14777
15291
|
/**
|
|
14778
15292
|
* Gets current value of property {@link #getHeight height}.
|
|
14779
15293
|
*
|
|
14780
|
-
* This property has no effect and will be
|
|
15294
|
+
* This property has no effect and will be removed soon.
|
|
14781
15295
|
*
|
|
14782
|
-
* @deprecated
|
|
15296
|
+
* @deprecated (since 1.115)
|
|
14783
15297
|
*
|
|
14784
15298
|
* @returns Value of property `height`
|
|
14785
15299
|
*/
|
|
14786
15300
|
getHeight(): CSSSize;
|
|
14787
15301
|
/**
|
|
14788
|
-
* Gets current value of property {@link #
|
|
15302
|
+
* Gets current value of property {@link #getHideToolbar hideToolbar}.
|
|
15303
|
+
*
|
|
15304
|
+
* Determines whether the toolbar is visible.
|
|
15305
|
+
*
|
|
15306
|
+
* **Note:** Hiding the toolbar limits the functionality of the table in the following ways:
|
|
15307
|
+
*
|
|
15308
|
+
* - The `showRowCount` property **must** be set to `false`.
|
|
15309
|
+
* - The export **must** be disabled by setting the `enableExport` property to `false`.
|
|
15310
|
+
* - For {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}, show and hide details won't be
|
|
15311
|
+
* visible as the table will always run in "Show Details" mode.
|
|
15312
|
+
* - Copy and paste will only work via keyboard.
|
|
15313
|
+
* - For {@link sap.ui.mdc.table.TreeTableType TreeTable}, "Collapse All" and "Expand All" won't be possible.
|
|
15314
|
+
*
|
|
15315
|
+
* - The `actions` and the `quickFilter` aggregations and a table-related {@link sap.ui.fl.variants.VariantManagement }
|
|
15316
|
+
* **must not** be used.
|
|
15317
|
+
* - The table title will not be displayed but will be replaced by an `InvisibleText`. The `header` property
|
|
15318
|
+
* **must** be set. In addition, `headerVisible` **must** be set to `false` to ensure accessibility compatibility.
|
|
15319
|
+
*
|
|
15320
|
+
* - Personalization (`p13nMode`) can still be used via the column headers. If the option to show or hide
|
|
15321
|
+
* columns is activated, it is recommended to use an {@link sap.m.IllustratedMessage} for the `nodata` display.
|
|
15322
|
+
* It ensures that columns can be made visible again when the user has accidentally hidden them all.
|
|
14789
15323
|
*
|
|
14790
|
-
*
|
|
14791
|
-
*
|
|
14792
|
-
*
|
|
15324
|
+
* Default value is `false`.
|
|
15325
|
+
*
|
|
15326
|
+
* @since 1.121
|
|
15327
|
+
*
|
|
15328
|
+
* @returns Value of property `hideToolbar`
|
|
15329
|
+
*/
|
|
15330
|
+
getHideToolbar(): boolean;
|
|
15331
|
+
/**
|
|
15332
|
+
* Gets current value of property {@link #getMultiSelectMode multiSelectMode}.
|
|
14793
15333
|
*
|
|
14794
|
-
*
|
|
15334
|
+
* Defines the multi-selection mode.
|
|
14795
15335
|
*
|
|
14796
|
-
* **Note:** This property has
|
|
14797
|
-
* is
|
|
15336
|
+
* **Note:** This property has no effect in the following cases:
|
|
15337
|
+
* - Table type is not {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}. This is subject to
|
|
15338
|
+
* change in the future.
|
|
15339
|
+
* - Selection mode is not `Multi`.
|
|
14798
15340
|
*
|
|
14799
15341
|
* Default value is `Default`.
|
|
14800
15342
|
*
|
|
@@ -14806,7 +15348,7 @@ declare module "sap/ui/mdc/Table" {
|
|
|
14806
15348
|
/**
|
|
14807
15349
|
* Gets content of aggregation {@link #getNoData noData}.
|
|
14808
15350
|
*
|
|
14809
|
-
* Defines the custom visualization if there is no data to show
|
|
15351
|
+
* Defines the custom visualization if there is no data to show.
|
|
14810
15352
|
*
|
|
14811
15353
|
* **Note:** If {@link sap.m.IllustratedMessage} control is set for the `noData` aggregation and its {@link sap.m.IllustratedMessage#getTitle title }
|
|
14812
15354
|
* property is not set then the table automatically offers a no data text with fitting {@link sap.m.IllustratedMessage.IllustratedMessageType illustration}.
|
|
@@ -14818,7 +15360,10 @@ declare module "sap/ui/mdc/Table" {
|
|
|
14818
15360
|
* Gets current value of property {@link #getP13nMode p13nMode}.
|
|
14819
15361
|
*
|
|
14820
15362
|
* Personalization options for the table.
|
|
14821
|
-
*
|
|
15363
|
+
*
|
|
15364
|
+
* **Note:** Whether a personalization option is supported depends on the used delegate. Please refer to
|
|
15365
|
+
* the documentation of the individual delegates. The order of the provided options does not influence their
|
|
15366
|
+
* order on the UI.
|
|
14822
15367
|
*
|
|
14823
15368
|
* Default value is `[]`.
|
|
14824
15369
|
*
|
|
@@ -14830,7 +15375,7 @@ declare module "sap/ui/mdc/Table" {
|
|
|
14830
15375
|
/**
|
|
14831
15376
|
* Gets content of aggregation {@link #getQuickFilter quickFilter}.
|
|
14832
15377
|
*
|
|
14833
|
-
* Additional
|
|
15378
|
+
* Additional control for filtering that will be available in the toolbar.
|
|
14834
15379
|
*/
|
|
14835
15380
|
getQuickFilter(): Control1;
|
|
14836
15381
|
/**
|
|
@@ -14855,9 +15400,9 @@ declare module "sap/ui/mdc/Table" {
|
|
|
14855
15400
|
* Selection mode of the table. Specifies whether single or multiple rows can be selected and how the selection
|
|
14856
15401
|
* can be extended. It may also influence the visual appearance.
|
|
14857
15402
|
*
|
|
14858
|
-
* With the {@link sap.ui.mdc.table.GridTableType
|
|
14859
|
-
* including Select All, only work properly if the count is known.
|
|
14860
|
-
*
|
|
15403
|
+
* **Note:** With the {@link sap.ui.mdc.table.GridTableType GridTable} and server-side models, range selections,
|
|
15404
|
+
* including Select All, only work properly if the count is known. Please refer to the documentation of
|
|
15405
|
+
* the used model for information on requesting the count, for example, {@link sap.ui.model.odata.v4.ODataModel}.
|
|
14861
15406
|
*
|
|
14862
15407
|
* Default value is `None`.
|
|
14863
15408
|
*
|
|
@@ -14880,12 +15425,11 @@ declare module "sap/ui/mdc/Table" {
|
|
|
14880
15425
|
/**
|
|
14881
15426
|
* Gets current value of property {@link #getShowRowCount showRowCount}.
|
|
14882
15427
|
*
|
|
14883
|
-
* Determines whether the number of rows is shown along with the header text.
|
|
14884
|
-
*
|
|
14885
|
-
*
|
|
14886
|
-
*
|
|
14887
|
-
*
|
|
14888
|
-
* This property can only be used if the back-end service supports row count.
|
|
15428
|
+
* Determines whether the number of rows is shown along with the header text.
|
|
15429
|
+
*
|
|
15430
|
+
* **Note:** Whether this feature can be used depends on whether the model used and the data service can
|
|
15431
|
+
* provide a count. Please refer to the documentation of the used model for information on requesting the
|
|
15432
|
+
* count, for example, {@link sap.ui.model.odata.v4.ODataModel}.
|
|
14889
15433
|
*
|
|
14890
15434
|
* Default value is `true`.
|
|
14891
15435
|
*
|
|
@@ -14896,12 +15440,19 @@ declare module "sap/ui/mdc/Table" {
|
|
|
14896
15440
|
/**
|
|
14897
15441
|
* Gets current value of property {@link #getThreshold threshold}.
|
|
14898
15442
|
*
|
|
14899
|
-
* Number of records to be requested from the model.
|
|
14900
|
-
*
|
|
14901
|
-
* If the
|
|
14902
|
-
*
|
|
14903
|
-
*
|
|
14904
|
-
*
|
|
15443
|
+
* Number of records to be requested from the model.
|
|
15444
|
+
*
|
|
15445
|
+
* If the table type is {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}, the threshold defines
|
|
15446
|
+
* the number of rows that are displayed initially, and the number of rows that are added when the table
|
|
15447
|
+
* grows ({@link sap.ui.mdc.table.ResponsiveTableType#getGrowingMode growingMode}).
|
|
15448
|
+
*
|
|
15449
|
+
* If the table type is {@link sap.ui.mdc.table.GridTableType GridTable}, the threshold defines how many
|
|
15450
|
+
* additional (not yet visible) data records from the back-end system are pre-fetched. If the `threshold`
|
|
15451
|
+
* is lower than the number of visible rows, the number of visible rows is used as the `threshold`. If the
|
|
15452
|
+
* value is 0, thresholding is disabled.
|
|
15453
|
+
*
|
|
15454
|
+
* **Note:** This property only takes effect if it is set to a positive integer value. Otherwise the table
|
|
15455
|
+
* uses a type-dependent default value.
|
|
14905
15456
|
*
|
|
14906
15457
|
* Default value is `-1`.
|
|
14907
15458
|
*
|
|
@@ -14971,8 +15522,8 @@ declare module "sap/ui/mdc/Table" {
|
|
|
14971
15522
|
oColumn: Column
|
|
14972
15523
|
): int;
|
|
14973
15524
|
/**
|
|
14974
|
-
* Returns a `Promise` that resolves
|
|
14975
|
-
*
|
|
15525
|
+
* Returns a `Promise` that resolves after the table has been initialized, and after it has been created
|
|
15526
|
+
* or its type has been changed.
|
|
14976
15527
|
*
|
|
14977
15528
|
*
|
|
14978
15529
|
* @returns A `Promise` that resolves after the table has been initialized
|
|
@@ -14994,7 +15545,7 @@ declare module "sap/ui/mdc/Table" {
|
|
|
14994
15545
|
*
|
|
14995
15546
|
* @since 1.76
|
|
14996
15547
|
*
|
|
14997
|
-
* @returns A `Promise` that resolves after the table
|
|
15548
|
+
* @returns A `Promise` that resolves after the table has been scrolled to the row with the given index
|
|
14998
15549
|
*/
|
|
14999
15550
|
scrollToIndex(
|
|
15000
15551
|
/**
|
|
@@ -15106,11 +15657,22 @@ declare module "sap/ui/mdc/Table" {
|
|
|
15106
15657
|
/**
|
|
15107
15658
|
* Sets a new value for property {@link #getDelegate delegate}.
|
|
15108
15659
|
*
|
|
15109
|
-
*
|
|
15110
|
-
*
|
|
15660
|
+
* Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
|
|
15661
|
+
* The object has the following properties:
|
|
15662
|
+
* - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/TableDelegate TableDelegate}.
|
|
15663
|
+
*
|
|
15664
|
+
* - `payload` (optional) defines application-specific information that can be used in the given delegate
|
|
15665
|
+
* Sample delegate object:
|
|
15666
|
+
* ```javascript
|
|
15667
|
+
* {
|
|
15668
|
+
* name: "sap/ui/mdc/TableDelegate",
|
|
15669
|
+
* payload: {}
|
|
15670
|
+
* }```
|
|
15671
|
+
*
|
|
15672
|
+
*
|
|
15673
|
+
* **Note:** Ensure that the related file can be requested (any required library has to be loaded before
|
|
15111
15674
|
* that).
|
|
15112
|
-
* Do not bind or modify the module.
|
|
15113
|
-
* needed any longer.
|
|
15675
|
+
* Do not bind or modify the module. This property can only be configured during control initialization.
|
|
15114
15676
|
*
|
|
15115
15677
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
15116
15678
|
*
|
|
@@ -15129,16 +15691,18 @@ declare module "sap/ui/mdc/Table" {
|
|
|
15129
15691
|
/**
|
|
15130
15692
|
* Sets a new value for property {@link #getEnableAutoColumnWidth enableAutoColumnWidth}.
|
|
15131
15693
|
*
|
|
15132
|
-
* Enables automatic column width calculation
|
|
15133
|
-
*
|
|
15134
|
-
*
|
|
15135
|
-
* numeric types can help this algorithm to produce better results. The calculated column widths can have
|
|
15136
|
-
* a minimum of 3rem and a maximum of 20rem.
|
|
15694
|
+
* Enables automatic column width calculation. The column width calculation takes the type, column label,
|
|
15695
|
+
* referenced properties, and other information into account. The calculated column widths can have a minimum
|
|
15696
|
+
* of 3rem and a maximum of 20rem.
|
|
15137
15697
|
*
|
|
15138
|
-
*
|
|
15139
|
-
*
|
|
15140
|
-
* the `visualSettings.widthSettings`
|
|
15141
|
-
*
|
|
15698
|
+
* The delegate can customize the automatic column width calculation with the `visualSettings.widthSettings`
|
|
15699
|
+
* field in the {@link sap.ui.mdc.table.PropertyInfo PropertyInfo}. To disable the heuristic column width
|
|
15700
|
+
* calculation for a particular column, the `visualSettings.widthSettings` field can be set to `null`. Providing
|
|
15701
|
+
* a more precise `maxLength` value for the `String` type or `precision` value for numeric types can help
|
|
15702
|
+
* the algorithm to produce better results.
|
|
15703
|
+
*
|
|
15704
|
+
* **Note:** The column width is not calculated if the `width` property of the column is bound or its value
|
|
15705
|
+
* is set.
|
|
15142
15706
|
*
|
|
15143
15707
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
15144
15708
|
*
|
|
@@ -15176,8 +15740,12 @@ declare module "sap/ui/mdc/Table" {
|
|
|
15176
15740
|
/**
|
|
15177
15741
|
* Sets a new value for property {@link #getEnableExport enableExport}.
|
|
15178
15742
|
*
|
|
15179
|
-
* Determines whether the
|
|
15180
|
-
*
|
|
15743
|
+
* Determines whether the data export is enabled.
|
|
15744
|
+
*
|
|
15745
|
+
* The delegate can customize the export result with the `exportSettings` field in the {@link sap.ui.mdc.table.PropertyInfo PropertyInfo}.
|
|
15746
|
+
*
|
|
15747
|
+
* **Note:** To use the export functionality, the {@link sap.ui.export} library is required, otherwise an
|
|
15748
|
+
* error message is displayed when the user presses the Export button.
|
|
15181
15749
|
*
|
|
15182
15750
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
15183
15751
|
*
|
|
@@ -15228,7 +15796,8 @@ declare module "sap/ui/mdc/Table" {
|
|
|
15228
15796
|
/**
|
|
15229
15797
|
* Sets a new value for property {@link #getHeader header}.
|
|
15230
15798
|
*
|
|
15231
|
-
* Header text that is shown in the table.
|
|
15799
|
+
* Header text that is shown in the table. The header must always be set to comply with accessibility standards,
|
|
15800
|
+
* even if other settings make the header invisible.
|
|
15232
15801
|
*
|
|
15233
15802
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
15234
15803
|
*
|
|
@@ -15301,11 +15870,11 @@ declare module "sap/ui/mdc/Table" {
|
|
|
15301
15870
|
/**
|
|
15302
15871
|
* Sets a new value for property {@link #getHeight height}.
|
|
15303
15872
|
*
|
|
15304
|
-
* This property has no effect and will be
|
|
15873
|
+
* This property has no effect and will be removed soon.
|
|
15305
15874
|
*
|
|
15306
15875
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
15307
15876
|
*
|
|
15308
|
-
* @deprecated
|
|
15877
|
+
* @deprecated (since 1.115)
|
|
15309
15878
|
*
|
|
15310
15879
|
* @returns Reference to `this` in order to allow method chaining
|
|
15311
15880
|
*/
|
|
@@ -15316,16 +15885,51 @@ declare module "sap/ui/mdc/Table" {
|
|
|
15316
15885
|
sHeight?: CSSSize
|
|
15317
15886
|
): this;
|
|
15318
15887
|
/**
|
|
15319
|
-
* Sets a new value for property {@link #
|
|
15888
|
+
* Sets a new value for property {@link #getHideToolbar hideToolbar}.
|
|
15889
|
+
*
|
|
15890
|
+
* Determines whether the toolbar is visible.
|
|
15891
|
+
*
|
|
15892
|
+
* **Note:** Hiding the toolbar limits the functionality of the table in the following ways:
|
|
15893
|
+
*
|
|
15894
|
+
* - The `showRowCount` property **must** be set to `false`.
|
|
15895
|
+
* - The export **must** be disabled by setting the `enableExport` property to `false`.
|
|
15896
|
+
* - For {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}, show and hide details won't be
|
|
15897
|
+
* visible as the table will always run in "Show Details" mode.
|
|
15898
|
+
* - Copy and paste will only work via keyboard.
|
|
15899
|
+
* - For {@link sap.ui.mdc.table.TreeTableType TreeTable}, "Collapse All" and "Expand All" won't be possible.
|
|
15900
|
+
*
|
|
15901
|
+
* - The `actions` and the `quickFilter` aggregations and a table-related {@link sap.ui.fl.variants.VariantManagement }
|
|
15902
|
+
* **must not** be used.
|
|
15903
|
+
* - The table title will not be displayed but will be replaced by an `InvisibleText`. The `header` property
|
|
15904
|
+
* **must** be set. In addition, `headerVisible` **must** be set to `false` to ensure accessibility compatibility.
|
|
15905
|
+
*
|
|
15906
|
+
* - Personalization (`p13nMode`) can still be used via the column headers. If the option to show or hide
|
|
15907
|
+
* columns is activated, it is recommended to use an {@link sap.m.IllustratedMessage} for the `nodata` display.
|
|
15908
|
+
* It ensures that columns can be made visible again when the user has accidentally hidden them all.
|
|
15909
|
+
*
|
|
15910
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
15911
|
+
*
|
|
15912
|
+
* Default value is `false`.
|
|
15913
|
+
*
|
|
15914
|
+
* @since 1.121
|
|
15320
15915
|
*
|
|
15321
|
-
*
|
|
15322
|
-
|
|
15323
|
-
|
|
15916
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
15917
|
+
*/
|
|
15918
|
+
setHideToolbar(
|
|
15919
|
+
/**
|
|
15920
|
+
* New value for property `hideToolbar`
|
|
15921
|
+
*/
|
|
15922
|
+
bHideToolbar?: boolean
|
|
15923
|
+
): this;
|
|
15924
|
+
/**
|
|
15925
|
+
* Sets a new value for property {@link #getMultiSelectMode multiSelectMode}.
|
|
15324
15926
|
*
|
|
15325
|
-
*
|
|
15927
|
+
* Defines the multi-selection mode.
|
|
15326
15928
|
*
|
|
15327
|
-
* **Note:** This property has
|
|
15328
|
-
* is
|
|
15929
|
+
* **Note:** This property has no effect in the following cases:
|
|
15930
|
+
* - Table type is not {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}. This is subject to
|
|
15931
|
+
* change in the future.
|
|
15932
|
+
* - Selection mode is not `Multi`.
|
|
15329
15933
|
*
|
|
15330
15934
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
15331
15935
|
*
|
|
@@ -15358,7 +15962,10 @@ declare module "sap/ui/mdc/Table" {
|
|
|
15358
15962
|
* Sets a new value for property {@link #getP13nMode p13nMode}.
|
|
15359
15963
|
*
|
|
15360
15964
|
* Personalization options for the table.
|
|
15361
|
-
*
|
|
15965
|
+
*
|
|
15966
|
+
* **Note:** Whether a personalization option is supported depends on the used delegate. Please refer to
|
|
15967
|
+
* the documentation of the individual delegates. The order of the provided options does not influence their
|
|
15968
|
+
* order on the UI.
|
|
15362
15969
|
*
|
|
15363
15970
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
15364
15971
|
*
|
|
@@ -15404,9 +16011,9 @@ declare module "sap/ui/mdc/Table" {
|
|
|
15404
16011
|
* Selection mode of the table. Specifies whether single or multiple rows can be selected and how the selection
|
|
15405
16012
|
* can be extended. It may also influence the visual appearance.
|
|
15406
16013
|
*
|
|
15407
|
-
* With the {@link sap.ui.mdc.table.GridTableType
|
|
15408
|
-
* including Select All, only work properly if the count is known.
|
|
15409
|
-
*
|
|
16014
|
+
* **Note:** With the {@link sap.ui.mdc.table.GridTableType GridTable} and server-side models, range selections,
|
|
16015
|
+
* including Select All, only work properly if the count is known. Please refer to the documentation of
|
|
16016
|
+
* the used model for information on requesting the count, for example, {@link sap.ui.model.odata.v4.ODataModel}.
|
|
15410
16017
|
*
|
|
15411
16018
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
15412
16019
|
*
|
|
@@ -15443,12 +16050,11 @@ declare module "sap/ui/mdc/Table" {
|
|
|
15443
16050
|
/**
|
|
15444
16051
|
* Sets a new value for property {@link #getShowRowCount showRowCount}.
|
|
15445
16052
|
*
|
|
15446
|
-
* Determines whether the number of rows is shown along with the header text.
|
|
15447
|
-
*
|
|
15448
|
-
*
|
|
15449
|
-
*
|
|
15450
|
-
*
|
|
15451
|
-
* This property can only be used if the back-end service supports row count.
|
|
16053
|
+
* Determines whether the number of rows is shown along with the header text.
|
|
16054
|
+
*
|
|
16055
|
+
* **Note:** Whether this feature can be used depends on whether the model used and the data service can
|
|
16056
|
+
* provide a count. Please refer to the documentation of the used model for information on requesting the
|
|
16057
|
+
* count, for example, {@link sap.ui.model.odata.v4.ODataModel}.
|
|
15452
16058
|
*
|
|
15453
16059
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
15454
16060
|
*
|
|
@@ -15466,12 +16072,19 @@ declare module "sap/ui/mdc/Table" {
|
|
|
15466
16072
|
/**
|
|
15467
16073
|
* Sets a new value for property {@link #getThreshold threshold}.
|
|
15468
16074
|
*
|
|
15469
|
-
* Number of records to be requested from the model.
|
|
15470
|
-
*
|
|
15471
|
-
* If the
|
|
15472
|
-
*
|
|
15473
|
-
*
|
|
15474
|
-
*
|
|
16075
|
+
* Number of records to be requested from the model.
|
|
16076
|
+
*
|
|
16077
|
+
* If the table type is {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}, the threshold defines
|
|
16078
|
+
* the number of rows that are displayed initially, and the number of rows that are added when the table
|
|
16079
|
+
* grows ({@link sap.ui.mdc.table.ResponsiveTableType#getGrowingMode growingMode}).
|
|
16080
|
+
*
|
|
16081
|
+
* If the table type is {@link sap.ui.mdc.table.GridTableType GridTable}, the threshold defines how many
|
|
16082
|
+
* additional (not yet visible) data records from the back-end system are pre-fetched. If the `threshold`
|
|
16083
|
+
* is lower than the number of visible rows, the number of visible rows is used as the `threshold`. If the
|
|
16084
|
+
* value is 0, thresholding is disabled.
|
|
16085
|
+
*
|
|
16086
|
+
* **Note:** This property only takes effect if it is set to a positive integer value. Otherwise the table
|
|
16087
|
+
* uses a type-dependent default value.
|
|
15475
16088
|
*
|
|
15476
16089
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
15477
16090
|
*
|
|
@@ -15553,7 +16166,7 @@ declare module "sap/ui/mdc/Table" {
|
|
|
15553
16166
|
*
|
|
15554
16167
|
* When specifying the `PropertyInfo` objects in the {@link sap.ui.mdc.Table#getPropertyInfo propertyInfo }
|
|
15555
16168
|
* property, the following attributes need to be specified:
|
|
15556
|
-
* - `
|
|
16169
|
+
* - `key`
|
|
15557
16170
|
* - `path`
|
|
15558
16171
|
* - `dataType`
|
|
15559
16172
|
* - `formatOptions`
|
|
@@ -15563,12 +16176,12 @@ declare module "sap/ui/mdc/Table" {
|
|
|
15563
16176
|
* - `visualSettings.widthCalculation`
|
|
15564
16177
|
* - `propertyInfos`
|
|
15565
16178
|
* - `groupable`
|
|
15566
|
-
* - `
|
|
16179
|
+
* - `isKey`
|
|
15567
16180
|
* - `unit`
|
|
15568
16181
|
* - `text`
|
|
15569
16182
|
*
|
|
15570
16183
|
* If the property is complex, the following attributes need to be specified:
|
|
15571
|
-
* - `
|
|
16184
|
+
* - `key`
|
|
15572
16185
|
* - `visualSettings.widthCalculation`
|
|
15573
16186
|
* - `propertyInfos` (all referenced properties must be specified)
|
|
15574
16187
|
*/
|
|
@@ -15588,7 +16201,7 @@ declare module "sap/ui/mdc/Table" {
|
|
|
15588
16201
|
/**
|
|
15589
16202
|
* Defines whether a property is a key or part of a key in the data.
|
|
15590
16203
|
*/
|
|
15591
|
-
|
|
16204
|
+
isKey?: boolean;
|
|
15592
16205
|
/**
|
|
15593
16206
|
* Name of the unit property that is related to this property.
|
|
15594
16207
|
*/
|
|
@@ -15668,15 +16281,18 @@ declare module "sap/ui/mdc/Table" {
|
|
|
15668
16281
|
width?: CSSSize | PropertyBindingInfo | `{${string}}`;
|
|
15669
16282
|
|
|
15670
16283
|
/**
|
|
15671
|
-
* This property has no effect and will be
|
|
16284
|
+
* This property has no effect and will be removed soon.
|
|
15672
16285
|
*
|
|
15673
|
-
* @deprecated
|
|
16286
|
+
* @deprecated (since 1.115)
|
|
15674
16287
|
*/
|
|
15675
16288
|
height?: CSSSize | PropertyBindingInfo | `{${string}}`;
|
|
15676
16289
|
|
|
15677
16290
|
/**
|
|
15678
16291
|
* Personalization options for the table.
|
|
15679
|
-
*
|
|
16292
|
+
*
|
|
16293
|
+
* **Note:** Whether a personalization option is supported depends on the used delegate. Please refer to
|
|
16294
|
+
* the documentation of the individual delegates. The order of the provided options does not influence their
|
|
16295
|
+
* order on the UI.
|
|
15680
16296
|
*
|
|
15681
16297
|
* @since 1.62
|
|
15682
16298
|
*/
|
|
@@ -15686,11 +16302,22 @@ declare module "sap/ui/mdc/Table" {
|
|
|
15686
16302
|
| `{${string}}`;
|
|
15687
16303
|
|
|
15688
16304
|
/**
|
|
15689
|
-
*
|
|
15690
|
-
*
|
|
16305
|
+
* Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
|
|
16306
|
+
* The object has the following properties:
|
|
16307
|
+
* - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/TableDelegate TableDelegate}.
|
|
16308
|
+
*
|
|
16309
|
+
* - `payload` (optional) defines application-specific information that can be used in the given delegate
|
|
16310
|
+
* Sample delegate object:
|
|
16311
|
+
* ```javascript
|
|
16312
|
+
* {
|
|
16313
|
+
* name: "sap/ui/mdc/TableDelegate",
|
|
16314
|
+
* payload: {}
|
|
16315
|
+
* }```
|
|
16316
|
+
*
|
|
16317
|
+
*
|
|
16318
|
+
* **Note:** Ensure that the related file can be requested (any required library has to be loaded before
|
|
15691
16319
|
* that).
|
|
15692
|
-
* Do not bind or modify the module.
|
|
15693
|
-
* needed any longer.
|
|
16320
|
+
* Do not bind or modify the module. This property can only be configured during control initialization.
|
|
15694
16321
|
*
|
|
15695
16322
|
* @experimental
|
|
15696
16323
|
*/
|
|
@@ -15723,7 +16350,8 @@ declare module "sap/ui/mdc/Table" {
|
|
|
15723
16350
|
autoBindOnInit?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
15724
16351
|
|
|
15725
16352
|
/**
|
|
15726
|
-
* Header text that is shown in the table.
|
|
16353
|
+
* Header text that is shown in the table. The header must always be set to comply with accessibility standards,
|
|
16354
|
+
* even if other settings make the header invisible.
|
|
15727
16355
|
*/
|
|
15728
16356
|
header?: string | PropertyBindingInfo;
|
|
15729
16357
|
|
|
@@ -15747,9 +16375,9 @@ declare module "sap/ui/mdc/Table" {
|
|
|
15747
16375
|
* Selection mode of the table. Specifies whether single or multiple rows can be selected and how the selection
|
|
15748
16376
|
* can be extended. It may also influence the visual appearance.
|
|
15749
16377
|
*
|
|
15750
|
-
* With the {@link sap.ui.mdc.table.GridTableType
|
|
15751
|
-
* including Select All, only work properly if the count is known.
|
|
15752
|
-
*
|
|
16378
|
+
* **Note:** With the {@link sap.ui.mdc.table.GridTableType GridTable} and server-side models, range selections,
|
|
16379
|
+
* including Select All, only work properly if the count is known. Please refer to the documentation of
|
|
16380
|
+
* the used model for information on requesting the count, for example, {@link sap.ui.model.odata.v4.ODataModel}.
|
|
15753
16381
|
*/
|
|
15754
16382
|
selectionMode?:
|
|
15755
16383
|
| (TableSelectionMode | keyof typeof TableSelectionMode)
|
|
@@ -15757,22 +16385,28 @@ declare module "sap/ui/mdc/Table" {
|
|
|
15757
16385
|
| `{${string}}`;
|
|
15758
16386
|
|
|
15759
16387
|
/**
|
|
15760
|
-
* Determines whether the number of rows is shown along with the header text.
|
|
15761
|
-
*
|
|
15762
|
-
*
|
|
15763
|
-
*
|
|
15764
|
-
*
|
|
15765
|
-
* This property can only be used if the back-end service supports row count.
|
|
16388
|
+
* Determines whether the number of rows is shown along with the header text.
|
|
16389
|
+
*
|
|
16390
|
+
* **Note:** Whether this feature can be used depends on whether the model used and the data service can
|
|
16391
|
+
* provide a count. Please refer to the documentation of the used model for information on requesting the
|
|
16392
|
+
* count, for example, {@link sap.ui.model.odata.v4.ODataModel}.
|
|
15766
16393
|
*/
|
|
15767
16394
|
showRowCount?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
15768
16395
|
|
|
15769
16396
|
/**
|
|
15770
|
-
* Number of records to be requested from the model.
|
|
15771
|
-
*
|
|
15772
|
-
* If the
|
|
15773
|
-
*
|
|
15774
|
-
*
|
|
15775
|
-
*
|
|
16397
|
+
* Number of records to be requested from the model.
|
|
16398
|
+
*
|
|
16399
|
+
* If the table type is {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}, the threshold defines
|
|
16400
|
+
* the number of rows that are displayed initially, and the number of rows that are added when the table
|
|
16401
|
+
* grows ({@link sap.ui.mdc.table.ResponsiveTableType#getGrowingMode growingMode}).
|
|
16402
|
+
*
|
|
16403
|
+
* If the table type is {@link sap.ui.mdc.table.GridTableType GridTable}, the threshold defines how many
|
|
16404
|
+
* additional (not yet visible) data records from the back-end system are pre-fetched. If the `threshold`
|
|
16405
|
+
* is lower than the number of visible rows, the number of visible rows is used as the `threshold`. If the
|
|
16406
|
+
* value is 0, thresholding is disabled.
|
|
16407
|
+
*
|
|
16408
|
+
* **Note:** This property only takes effect if it is set to a positive integer value. Otherwise the table
|
|
16409
|
+
* uses a type-dependent default value.
|
|
15776
16410
|
*
|
|
15777
16411
|
* @since 1.63
|
|
15778
16412
|
*/
|
|
@@ -15781,8 +16415,8 @@ declare module "sap/ui/mdc/Table" {
|
|
|
15781
16415
|
/**
|
|
15782
16416
|
* Defines the sort conditions.
|
|
15783
16417
|
*
|
|
15784
|
-
* **Note
|
|
15785
|
-
*
|
|
16418
|
+
* **Note:** This property must not be bound.
|
|
16419
|
+
* This property is used exclusively for handling SAPUI5 flexibility changes. Do not use it otherwise.
|
|
15786
16420
|
*
|
|
15787
16421
|
* @since 1.73
|
|
15788
16422
|
*/
|
|
@@ -15791,8 +16425,8 @@ declare module "sap/ui/mdc/Table" {
|
|
|
15791
16425
|
/**
|
|
15792
16426
|
* Defines the filter conditions.
|
|
15793
16427
|
*
|
|
15794
|
-
* **Note
|
|
15795
|
-
*
|
|
16428
|
+
* **Note:** This property must not be bound.
|
|
16429
|
+
* This property is used exclusively for handling SAPUI5 flexibility changes. Do not use it otherwise.
|
|
15796
16430
|
*
|
|
15797
16431
|
* @since 1.80.0
|
|
15798
16432
|
*/
|
|
@@ -15801,8 +16435,8 @@ declare module "sap/ui/mdc/Table" {
|
|
|
15801
16435
|
/**
|
|
15802
16436
|
* Defines the group conditions.
|
|
15803
16437
|
*
|
|
15804
|
-
* **Note
|
|
15805
|
-
*
|
|
16438
|
+
* **Note:** This property must not be bound.
|
|
16439
|
+
* This property is used exclusively for handling SAPUI5 flexibility changes. Do not use it otherwise.
|
|
15806
16440
|
*
|
|
15807
16441
|
* @since 1.87
|
|
15808
16442
|
*/
|
|
@@ -15811,16 +16445,20 @@ declare module "sap/ui/mdc/Table" {
|
|
|
15811
16445
|
/**
|
|
15812
16446
|
* Defines the aggregate conditions.
|
|
15813
16447
|
*
|
|
15814
|
-
* **Note
|
|
15815
|
-
*
|
|
16448
|
+
* **Note:** This property must not be bound.
|
|
16449
|
+
* This property is exclusively used for handling SAPUI5 flexibility changes. Do not use it otherwise.
|
|
15816
16450
|
*
|
|
15817
16451
|
* @since 1.87
|
|
15818
16452
|
*/
|
|
15819
16453
|
aggregateConditions?: object | PropertyBindingInfo | `{${string}}`;
|
|
15820
16454
|
|
|
15821
16455
|
/**
|
|
15822
|
-
* Determines whether the
|
|
15823
|
-
*
|
|
16456
|
+
* Determines whether the data export is enabled.
|
|
16457
|
+
*
|
|
16458
|
+
* The delegate can customize the export result with the `exportSettings` field in the {@link sap.ui.mdc.table.PropertyInfo PropertyInfo}.
|
|
16459
|
+
*
|
|
16460
|
+
* **Note:** To use the export functionality, the {@link sap.ui.export} library is required, otherwise an
|
|
16461
|
+
* error message is displayed when the user presses the Export button.
|
|
15824
16462
|
*
|
|
15825
16463
|
* @since 1.75
|
|
15826
16464
|
*/
|
|
@@ -15853,14 +16491,12 @@ declare module "sap/ui/mdc/Table" {
|
|
|
15853
16491
|
enablePaste?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
15854
16492
|
|
|
15855
16493
|
/**
|
|
15856
|
-
* Defines the multi-selection mode
|
|
15857
|
-
* `ResponsiveTable` type control renders the Select All checkbox in the column header, otherwise the Deselect
|
|
15858
|
-
* All icon is rendered.
|
|
16494
|
+
* Defines the multi-selection mode.
|
|
15859
16495
|
*
|
|
15860
|
-
* This property
|
|
15861
|
-
*
|
|
15862
|
-
*
|
|
15863
|
-
*
|
|
16496
|
+
* **Note:** This property has no effect in the following cases:
|
|
16497
|
+
* - Table type is not {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}. This is subject to
|
|
16498
|
+
* change in the future.
|
|
16499
|
+
* - Selection mode is not `Multi`.
|
|
15864
16500
|
*
|
|
15865
16501
|
* @since 1.93
|
|
15866
16502
|
*/
|
|
@@ -15870,16 +16506,18 @@ declare module "sap/ui/mdc/Table" {
|
|
|
15870
16506
|
| `{${string}}`;
|
|
15871
16507
|
|
|
15872
16508
|
/**
|
|
15873
|
-
* Enables automatic column width calculation
|
|
15874
|
-
*
|
|
15875
|
-
*
|
|
15876
|
-
*
|
|
15877
|
-
*
|
|
16509
|
+
* Enables automatic column width calculation. The column width calculation takes the type, column label,
|
|
16510
|
+
* referenced properties, and other information into account. The calculated column widths can have a minimum
|
|
16511
|
+
* of 3rem and a maximum of 20rem.
|
|
16512
|
+
*
|
|
16513
|
+
* The delegate can customize the automatic column width calculation with the `visualSettings.widthSettings`
|
|
16514
|
+
* field in the {@link sap.ui.mdc.table.PropertyInfo PropertyInfo}. To disable the heuristic column width
|
|
16515
|
+
* calculation for a particular column, the `visualSettings.widthSettings` field can be set to `null`. Providing
|
|
16516
|
+
* a more precise `maxLength` value for the `String` type or `precision` value for numeric types can help
|
|
16517
|
+
* the algorithm to produce better results.
|
|
15878
16518
|
*
|
|
15879
|
-
* **Note:**
|
|
15880
|
-
*
|
|
15881
|
-
* the `visualSettings.widthSettings` key of the `PropertyInfo` must be set to `null`. This feature has
|
|
15882
|
-
* no effect if the `width` property of the column is bound or its value is set.
|
|
16519
|
+
* **Note:** The column width is not calculated if the `width` property of the column is bound or its value
|
|
16520
|
+
* is set.
|
|
15883
16521
|
*
|
|
15884
16522
|
* @since 1.95
|
|
15885
16523
|
*/
|
|
@@ -15907,7 +16545,32 @@ declare module "sap/ui/mdc/Table" {
|
|
|
15907
16545
|
*
|
|
15908
16546
|
* @since 1.111
|
|
15909
16547
|
*/
|
|
15910
|
-
propertyInfo?: object | PropertyBindingInfo | `{${string}}`;
|
|
16548
|
+
propertyInfo?: object[] | PropertyBindingInfo | `{${string}}`;
|
|
16549
|
+
|
|
16550
|
+
/**
|
|
16551
|
+
* Determines whether the toolbar is visible.
|
|
16552
|
+
*
|
|
16553
|
+
* **Note:** Hiding the toolbar limits the functionality of the table in the following ways:
|
|
16554
|
+
*
|
|
16555
|
+
* - The `showRowCount` property **must** be set to `false`.
|
|
16556
|
+
* - The export **must** be disabled by setting the `enableExport` property to `false`.
|
|
16557
|
+
* - For {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}, show and hide details won't be
|
|
16558
|
+
* visible as the table will always run in "Show Details" mode.
|
|
16559
|
+
* - Copy and paste will only work via keyboard.
|
|
16560
|
+
* - For {@link sap.ui.mdc.table.TreeTableType TreeTable}, "Collapse All" and "Expand All" won't be possible.
|
|
16561
|
+
*
|
|
16562
|
+
* - The `actions` and the `quickFilter` aggregations and a table-related {@link sap.ui.fl.variants.VariantManagement }
|
|
16563
|
+
* **must not** be used.
|
|
16564
|
+
* - The table title will not be displayed but will be replaced by an `InvisibleText`. The `header` property
|
|
16565
|
+
* **must** be set. In addition, `headerVisible` **must** be set to `false` to ensure accessibility compatibility.
|
|
16566
|
+
*
|
|
16567
|
+
* - Personalization (`p13nMode`) can still be used via the column headers. If the option to show or hide
|
|
16568
|
+
* columns is activated, it is recommended to use an {@link sap.m.IllustratedMessage} for the `nodata` display.
|
|
16569
|
+
* It ensures that columns can be made visible again when the user has accidentally hidden them all.
|
|
16570
|
+
*
|
|
16571
|
+
* @since 1.121
|
|
16572
|
+
*/
|
|
16573
|
+
hideToolbar?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
15911
16574
|
|
|
15912
16575
|
/**
|
|
15913
16576
|
* Type of the table.
|
|
@@ -15919,26 +16582,30 @@ declare module "sap/ui/mdc/Table" {
|
|
|
15919
16582
|
| `{${string}}`;
|
|
15920
16583
|
|
|
15921
16584
|
/**
|
|
15922
|
-
* Columns of the table.
|
|
15923
|
-
*
|
|
15924
|
-
*
|
|
16585
|
+
* Columns of the table.
|
|
16586
|
+
*
|
|
16587
|
+
* **Note:** This aggregation is managed by the control, can only be populated during the definition in
|
|
16588
|
+
* the XML view, and is not bindable. Any changes of the initial aggregation content might result in unwanted
|
|
16589
|
+
* effects. Changes of the aggregation have to be made with the {@link sap.ui.mdc.p13n.StateUtil StateUtil}.
|
|
15925
16590
|
*/
|
|
15926
16591
|
columns?: Column[] | Column | AggregationBindingInfo | `{${string}}`;
|
|
15927
16592
|
|
|
15928
16593
|
/**
|
|
15929
16594
|
* This row can be used for user input to create new data if {@link sap.ui.mdc.enums.TableType TableType }
|
|
15930
|
-
* is "`Table`".
|
|
15931
|
-
*
|
|
16595
|
+
* is "`Table`".
|
|
16596
|
+
*
|
|
16597
|
+
* **Note:** Once the binding supports creating transient records, this aggregation will be removed.
|
|
15932
16598
|
*
|
|
15933
16599
|
* @experimental - Do not use
|
|
15934
16600
|
*/
|
|
15935
16601
|
creationRow?: /* was: sap.ui.mdc.table.CreationRow */ any;
|
|
15936
16602
|
|
|
15937
16603
|
/**
|
|
15938
|
-
* Additional
|
|
15939
|
-
*
|
|
15940
|
-
*
|
|
15941
|
-
*
|
|
16604
|
+
* Additional actions that will be available in the toolbar.
|
|
16605
|
+
*
|
|
16606
|
+
* **Note:** This aggregation is managed by the control, can only be populated during the definition in
|
|
16607
|
+
* the XML view, and is not bindable. Any changes of the initial aggregation content might result in undesired
|
|
16608
|
+
* effects. Changes of the aggregation have to be made with the {@link sap.ui.mdc.p13n.StateUtil StateUtil}.
|
|
15942
16609
|
*/
|
|
15943
16610
|
actions?: Control1[] | Control1 | AggregationBindingInfo | `{${string}}`;
|
|
15944
16611
|
|
|
@@ -15948,7 +16615,7 @@ declare module "sap/ui/mdc/Table" {
|
|
|
15948
16615
|
variant?: VariantManagement;
|
|
15949
16616
|
|
|
15950
16617
|
/**
|
|
15951
|
-
* Additional
|
|
16618
|
+
* Additional control for filtering that will be available in the toolbar.
|
|
15952
16619
|
*/
|
|
15953
16620
|
quickFilter?: Control1;
|
|
15954
16621
|
|
|
@@ -15971,7 +16638,7 @@ declare module "sap/ui/mdc/Table" {
|
|
|
15971
16638
|
dataStateIndicator?: DataStateIndicator;
|
|
15972
16639
|
|
|
15973
16640
|
/**
|
|
15974
|
-
* Defines the custom visualization if there is no data to show
|
|
16641
|
+
* Defines the custom visualization if there is no data to show.
|
|
15975
16642
|
*
|
|
15976
16643
|
* **Note:** If {@link sap.m.IllustratedMessage} control is set for the `noData` aggregation and its {@link sap.m.IllustratedMessage#getTitle title }
|
|
15977
16644
|
* property is not set then the table automatically offers a no data text with fitting {@link sap.m.IllustratedMessage.IllustratedMessageType illustration}.
|
|
@@ -15982,33 +16649,32 @@ declare module "sap/ui/mdc/Table" {
|
|
|
15982
16649
|
|
|
15983
16650
|
/**
|
|
15984
16651
|
* Defines an aggregation for the `CopyProvider` plugin that provides copy to clipboard capabilities for
|
|
15985
|
-
* the selected rows
|
|
15986
|
-
*
|
|
15987
|
-
*
|
|
15988
|
-
*
|
|
16652
|
+
* the selected rows and creates a Copy button for the toolbar. To disable the copy function, including
|
|
16653
|
+
* the Copy button in the toolbar, the `enabled` property of the `CopyProvider` must be set to `false`.
|
|
16654
|
+
* To hide the Copy button from the toolbar, the `visible` property of the `CopyProvider` must be set to
|
|
16655
|
+
* `false`.
|
|
15989
16656
|
*
|
|
15990
16657
|
* **Note:** The {@link sap.m.plugins.CopyProvider#extractData extractData} property of the `CopyProvider`
|
|
15991
|
-
* must not be managed by the application.
|
|
15992
|
-
* the clipboard API. If the context is not secure,
|
|
15993
|
-
* not be generated.
|
|
16658
|
+
* must not be managed by the application.
|
|
16659
|
+
* The `CopyProvider` requires a secure context to access the clipboard API. If the context is not secure,
|
|
16660
|
+
* the plugin will not be added, and the Copy button will not be generated.
|
|
15994
16661
|
*
|
|
15995
16662
|
* @since 1.114
|
|
15996
16663
|
*/
|
|
15997
16664
|
copyProvider?: CopyProvider;
|
|
15998
16665
|
|
|
15999
16666
|
/**
|
|
16000
|
-
* Defines the context menu for the
|
|
16667
|
+
* Defines the context menu for the rows.
|
|
16001
16668
|
*
|
|
16002
16669
|
* @since 1.118
|
|
16003
16670
|
*/
|
|
16004
16671
|
contextMenu?: IContextMenu;
|
|
16005
16672
|
|
|
16006
16673
|
/**
|
|
16007
|
-
* Defines an aggregation for the `CellSelector` plugin that provides cell selection capabilities
|
|
16008
|
-
* table.
|
|
16674
|
+
* Defines an aggregation for the `CellSelector` plugin that provides cell selection capabilities.
|
|
16009
16675
|
*
|
|
16010
|
-
* **Note:** The `CellSelector` is currently only available in combination with the
|
|
16011
|
-
* refer to {@link sap.m.plugins.CellSelector}
|
|
16676
|
+
* **Note:** The `CellSelector` is currently only available in combination with the {@link sap.ui.mdc.table.GridTableType GridTable}.
|
|
16677
|
+
* Please refer to {@link sap.m.plugins.CellSelector} for additional restrictions.
|
|
16012
16678
|
*
|
|
16013
16679
|
* @since 1.119
|
|
16014
16680
|
*/
|
|
@@ -16018,17 +16684,18 @@ declare module "sap/ui/mdc/Table" {
|
|
|
16018
16684
|
* Control or object that enables the table to do filtering, such as {@link sap.ui.mdc.FilterBar}. See also
|
|
16019
16685
|
* {@link sap.ui.mdc.IFilter}.
|
|
16020
16686
|
*
|
|
16021
|
-
*
|
|
16687
|
+
* **Note:** By default, automatic filter generation only works in combination with a `sap.ui.mdc.FilterBar`,
|
|
16688
|
+
* see also {@link module:sap/ui/mdc/TableDelegate.getFilters}.
|
|
16022
16689
|
*/
|
|
16023
16690
|
filter?: IFilter | string;
|
|
16024
16691
|
|
|
16025
16692
|
/**
|
|
16026
|
-
* This event is fired when a row
|
|
16693
|
+
* This event is fired when a row is pressed.
|
|
16027
16694
|
*/
|
|
16028
16695
|
rowPress?: (oEvent: Table$RowPressEvent) => void;
|
|
16029
16696
|
|
|
16030
16697
|
/**
|
|
16031
|
-
* This event is fired when the selection
|
|
16698
|
+
* This event is fired when the selection is changed.
|
|
16032
16699
|
*/
|
|
16033
16700
|
selectionChange?: (oEvent: Table$SelectionChangeEvent) => void;
|
|
16034
16701
|
|
|
@@ -16086,8 +16753,10 @@ declare module "sap/ui/mdc/Table" {
|
|
|
16086
16753
|
bindingContext?: Context;
|
|
16087
16754
|
|
|
16088
16755
|
/**
|
|
16089
|
-
* The column used for the context menu
|
|
16090
|
-
*
|
|
16756
|
+
* The column used for the context menu
|
|
16757
|
+
*
|
|
16758
|
+
* **Note:** This parameter can be undefined if the area where the context menu opens is not related to
|
|
16759
|
+
* a column instance.
|
|
16091
16760
|
*/
|
|
16092
16761
|
column?: Column;
|
|
16093
16762
|
}
|
|
@@ -16824,8 +17493,6 @@ declare module "sap/ui/mdc/table/ColumnSettings" {
|
|
|
16824
17493
|
/**
|
|
16825
17494
|
* Constructor for a new `ColumnSettings`.
|
|
16826
17495
|
*
|
|
16827
|
-
* Provides a number of general settings that are supported by both {@link sap.m.Column} and {@link sap.ui.table.Column}.
|
|
16828
|
-
*
|
|
16829
17496
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
16830
17497
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
16831
17498
|
* of the syntax of the settings object.
|
|
@@ -16842,8 +17509,6 @@ declare module "sap/ui/mdc/table/ColumnSettings" {
|
|
|
16842
17509
|
/**
|
|
16843
17510
|
* Constructor for a new `ColumnSettings`.
|
|
16844
17511
|
*
|
|
16845
|
-
* Provides a number of general settings that are supported by both {@link sap.m.Column} and {@link sap.ui.table.Column}.
|
|
16846
|
-
*
|
|
16847
17512
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
16848
17513
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
16849
17514
|
* of the syntax of the settings object.
|
|
@@ -17750,7 +18415,7 @@ declare module "sap/ui/mdc/table/GridTableType" {
|
|
|
17750
18415
|
/**
|
|
17751
18416
|
* Gets current value of property {@link #getFixedColumnCount fixedColumnCount}.
|
|
17752
18417
|
*
|
|
17753
|
-
* Defines the number of fixed columns
|
|
18418
|
+
* Defines the number of fixed columns.
|
|
17754
18419
|
*
|
|
17755
18420
|
* Default value is `0`.
|
|
17756
18421
|
*
|
|
@@ -17817,7 +18482,7 @@ declare module "sap/ui/mdc/table/GridTableType" {
|
|
|
17817
18482
|
/**
|
|
17818
18483
|
* Sets a new value for property {@link #getFixedColumnCount fixedColumnCount}.
|
|
17819
18484
|
*
|
|
17820
|
-
* Defines the number of fixed columns
|
|
18485
|
+
* Defines the number of fixed columns.
|
|
17821
18486
|
*
|
|
17822
18487
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
17823
18488
|
*
|
|
@@ -17955,7 +18620,7 @@ declare module "sap/ui/mdc/table/GridTableType" {
|
|
|
17955
18620
|
showHeaderSelector?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
17956
18621
|
|
|
17957
18622
|
/**
|
|
17958
|
-
* Defines the number of fixed columns
|
|
18623
|
+
* Defines the number of fixed columns.
|
|
17959
18624
|
*/
|
|
17960
18625
|
fixedColumnCount?: int | PropertyBindingInfo | `{${string}}`;
|
|
17961
18626
|
}
|
|
@@ -18034,9 +18699,10 @@ declare module "sap/ui/mdc/table/ResponsiveColumnSettings" {
|
|
|
18034
18699
|
*
|
|
18035
18700
|
* Defines the column importance.
|
|
18036
18701
|
*
|
|
18037
|
-
*
|
|
18038
|
-
*
|
|
18039
|
-
*
|
|
18702
|
+
* Columns are moved to the pop-in area in the following order:
|
|
18703
|
+
* - With importance `High`: moved last
|
|
18704
|
+
* - With importance `Medium` or `None`: moved second
|
|
18705
|
+
* - With importance `Low`: moved first
|
|
18040
18706
|
*
|
|
18041
18707
|
* Default value is `"None"`.
|
|
18042
18708
|
*
|
|
@@ -18048,12 +18714,11 @@ declare module "sap/ui/mdc/table/ResponsiveColumnSettings" {
|
|
|
18048
18714
|
/**
|
|
18049
18715
|
* Gets current value of property {@link #getMergeFunction mergeFunction}.
|
|
18050
18716
|
*
|
|
18051
|
-
* Defines the control serialization function to merge duplicate cells into one cell block.
|
|
18052
|
-
*
|
|
18717
|
+
* Defines the control serialization function to merge duplicate cells into one cell block. This function
|
|
18718
|
+
* is used to compare values of two cells.
|
|
18053
18719
|
*
|
|
18054
|
-
* **Note:**
|
|
18055
|
-
*
|
|
18056
|
-
* set this property for cells for which the content provides a user interaction, such as `sap.m.Link`.
|
|
18720
|
+
* **Note:** Don't set this property for cells for which the content provides a user interaction, such as
|
|
18721
|
+
* `sap.m.Link`.
|
|
18057
18722
|
*
|
|
18058
18723
|
* @since 1.110
|
|
18059
18724
|
*
|
|
@@ -18065,9 +18730,10 @@ declare module "sap/ui/mdc/table/ResponsiveColumnSettings" {
|
|
|
18065
18730
|
*
|
|
18066
18731
|
* Defines the column importance.
|
|
18067
18732
|
*
|
|
18068
|
-
*
|
|
18069
|
-
*
|
|
18070
|
-
*
|
|
18733
|
+
* Columns are moved to the pop-in area in the following order:
|
|
18734
|
+
* - With importance `High`: moved last
|
|
18735
|
+
* - With importance `Medium` or `None`: moved second
|
|
18736
|
+
* - With importance `Low`: moved first
|
|
18071
18737
|
*
|
|
18072
18738
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
18073
18739
|
*
|
|
@@ -18086,12 +18752,11 @@ declare module "sap/ui/mdc/table/ResponsiveColumnSettings" {
|
|
|
18086
18752
|
/**
|
|
18087
18753
|
* Sets a new value for property {@link #getMergeFunction mergeFunction}.
|
|
18088
18754
|
*
|
|
18089
|
-
* Defines the control serialization function to merge duplicate cells into one cell block.
|
|
18090
|
-
*
|
|
18755
|
+
* Defines the control serialization function to merge duplicate cells into one cell block. This function
|
|
18756
|
+
* is used to compare values of two cells.
|
|
18091
18757
|
*
|
|
18092
|
-
* **Note:**
|
|
18093
|
-
*
|
|
18094
|
-
* set this property for cells for which the content provides a user interaction, such as `sap.m.Link`.
|
|
18758
|
+
* **Note:** Don't set this property for cells for which the content provides a user interaction, such as
|
|
18759
|
+
* `sap.m.Link`.
|
|
18095
18760
|
*
|
|
18096
18761
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
18097
18762
|
*
|
|
@@ -18112,9 +18777,10 @@ declare module "sap/ui/mdc/table/ResponsiveColumnSettings" {
|
|
|
18112
18777
|
/**
|
|
18113
18778
|
* Defines the column importance.
|
|
18114
18779
|
*
|
|
18115
|
-
*
|
|
18116
|
-
*
|
|
18117
|
-
*
|
|
18780
|
+
* Columns are moved to the pop-in area in the following order:
|
|
18781
|
+
* - With importance `High`: moved last
|
|
18782
|
+
* - With importance `Medium` or `None`: moved second
|
|
18783
|
+
* - With importance `Low`: moved first
|
|
18118
18784
|
*
|
|
18119
18785
|
* @since 1.110
|
|
18120
18786
|
*/
|
|
@@ -18124,12 +18790,11 @@ declare module "sap/ui/mdc/table/ResponsiveColumnSettings" {
|
|
|
18124
18790
|
| `{${string}}`;
|
|
18125
18791
|
|
|
18126
18792
|
/**
|
|
18127
|
-
* Defines the control serialization function to merge duplicate cells into one cell block.
|
|
18128
|
-
*
|
|
18793
|
+
* Defines the control serialization function to merge duplicate cells into one cell block. This function
|
|
18794
|
+
* is used to compare values of two cells.
|
|
18129
18795
|
*
|
|
18130
|
-
* **Note:**
|
|
18131
|
-
*
|
|
18132
|
-
* set this property for cells for which the content provides a user interaction, such as `sap.m.Link`.
|
|
18796
|
+
* **Note:** Don't set this property for cells for which the content provides a user interaction, such as
|
|
18797
|
+
* `sap.m.Link`.
|
|
18133
18798
|
*
|
|
18134
18799
|
* @since 1.110
|
|
18135
18800
|
*/
|
|
@@ -18225,13 +18890,12 @@ declare module "sap/ui/mdc/table/ResponsiveTableType" {
|
|
|
18225
18890
|
* Gets current value of property {@link #getDetailsButtonSetting detailsButtonSetting}.
|
|
18226
18891
|
*
|
|
18227
18892
|
* Defines which columns are hidden instead of moved into the pop-in area depending on their importance.
|
|
18228
|
-
* See {@link sap.
|
|
18893
|
+
* See {@link sap.ui.mdc.table.ResponsiveColumnSettings#getImportance} for more details.
|
|
18229
18894
|
*
|
|
18230
|
-
* **Note:** To hide columns based on their importance, it's mandatory to set `showDetailsButton
|
|
18231
|
-
* If no
|
|
18232
|
-
* is
|
|
18233
|
-
*
|
|
18234
|
-
* when the Show / Hide Details button is pressed a second time.
|
|
18895
|
+
* **Note:** To hide columns based on their importance, it's mandatory to set `showDetailsButton` to `true`.
|
|
18896
|
+
* If no importance is given, a device-dependent default configuration is used.
|
|
18897
|
+
* If this property is changed after the table has been initialized, the new changes take effect only when
|
|
18898
|
+
* the Show / Hide Details button is pressed a second time.
|
|
18235
18899
|
*
|
|
18236
18900
|
* @since 1.86
|
|
18237
18901
|
*
|
|
@@ -18264,7 +18928,7 @@ declare module "sap/ui/mdc/table/ResponsiveTableType" {
|
|
|
18264
18928
|
/**
|
|
18265
18929
|
* Gets current value of property {@link #getShowDetailsButton showDetailsButton}.
|
|
18266
18930
|
*
|
|
18267
|
-
* Specifies whether the Show / Hide Details button
|
|
18931
|
+
* Specifies whether the Show / Hide Details button is shown.
|
|
18268
18932
|
*
|
|
18269
18933
|
* If the available screen space gets too narrow, the columns configured with `High` and `Medium` importance
|
|
18270
18934
|
* move to the pop-in area, while the columns with `Low` importance are hidden.
|
|
@@ -18283,13 +18947,12 @@ declare module "sap/ui/mdc/table/ResponsiveTableType" {
|
|
|
18283
18947
|
* Sets a new value for property {@link #getDetailsButtonSetting detailsButtonSetting}.
|
|
18284
18948
|
*
|
|
18285
18949
|
* Defines which columns are hidden instead of moved into the pop-in area depending on their importance.
|
|
18286
|
-
* See {@link sap.
|
|
18950
|
+
* See {@link sap.ui.mdc.table.ResponsiveColumnSettings#getImportance} for more details.
|
|
18287
18951
|
*
|
|
18288
|
-
* **Note:** To hide columns based on their importance, it's mandatory to set `showDetailsButton
|
|
18289
|
-
* If no
|
|
18290
|
-
* is
|
|
18291
|
-
*
|
|
18292
|
-
* when the Show / Hide Details button is pressed a second time.
|
|
18952
|
+
* **Note:** To hide columns based on their importance, it's mandatory to set `showDetailsButton` to `true`.
|
|
18953
|
+
* If no importance is given, a device-dependent default configuration is used.
|
|
18954
|
+
* If this property is changed after the table has been initialized, the new changes take effect only when
|
|
18955
|
+
* the Show / Hide Details button is pressed a second time.
|
|
18293
18956
|
*
|
|
18294
18957
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
18295
18958
|
*
|
|
@@ -18343,7 +19006,7 @@ declare module "sap/ui/mdc/table/ResponsiveTableType" {
|
|
|
18343
19006
|
/**
|
|
18344
19007
|
* Sets a new value for property {@link #getShowDetailsButton showDetailsButton}.
|
|
18345
19008
|
*
|
|
18346
|
-
* Specifies whether the Show / Hide Details button
|
|
19009
|
+
* Specifies whether the Show / Hide Details button is shown.
|
|
18347
19010
|
*
|
|
18348
19011
|
* If the available screen space gets too narrow, the columns configured with `High` and `Medium` importance
|
|
18349
19012
|
* move to the pop-in area, while the columns with `Low` importance are hidden.
|
|
@@ -18377,7 +19040,7 @@ declare module "sap/ui/mdc/table/ResponsiveTableType" {
|
|
|
18377
19040
|
| `{${string}}`;
|
|
18378
19041
|
|
|
18379
19042
|
/**
|
|
18380
|
-
* Specifies whether the Show / Hide Details button
|
|
19043
|
+
* Specifies whether the Show / Hide Details button is shown.
|
|
18381
19044
|
*
|
|
18382
19045
|
* If the available screen space gets too narrow, the columns configured with `High` and `Medium` importance
|
|
18383
19046
|
* move to the pop-in area, while the columns with `Low` importance are hidden.
|
|
@@ -18391,13 +19054,12 @@ declare module "sap/ui/mdc/table/ResponsiveTableType" {
|
|
|
18391
19054
|
|
|
18392
19055
|
/**
|
|
18393
19056
|
* Defines which columns are hidden instead of moved into the pop-in area depending on their importance.
|
|
18394
|
-
* See {@link sap.
|
|
19057
|
+
* See {@link sap.ui.mdc.table.ResponsiveColumnSettings#getImportance} for more details.
|
|
18395
19058
|
*
|
|
18396
|
-
* **Note:** To hide columns based on their importance, it's mandatory to set `showDetailsButton
|
|
18397
|
-
* If no
|
|
18398
|
-
* is
|
|
18399
|
-
*
|
|
18400
|
-
* when the Show / Hide Details button is pressed a second time.
|
|
19059
|
+
* **Note:** To hide columns based on their importance, it's mandatory to set `showDetailsButton` to `true`.
|
|
19060
|
+
* If no importance is given, a device-dependent default configuration is used.
|
|
19061
|
+
* If this property is changed after the table has been initialized, the new changes take effect only when
|
|
19062
|
+
* the Show / Hide Details button is pressed a second time.
|
|
18401
19063
|
*
|
|
18402
19064
|
* @since 1.86
|
|
18403
19065
|
*/
|
|
@@ -18425,7 +19087,7 @@ declare module "sap/ui/mdc/table/RowActionItem" {
|
|
|
18425
19087
|
|
|
18426
19088
|
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
18427
19089
|
|
|
18428
|
-
import
|
|
19090
|
+
import TableRowActionType from "sap/ui/mdc/enums/TableRowActionType";
|
|
18429
19091
|
|
|
18430
19092
|
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
18431
19093
|
|
|
@@ -18508,10 +19170,11 @@ declare module "sap/ui/mdc/table/RowActionItem" {
|
|
|
18508
19170
|
*
|
|
18509
19171
|
* Fired when the row action item is pressed.
|
|
18510
19172
|
*
|
|
18511
|
-
*
|
|
19173
|
+
* If the table type is {@link sap.ui.mdc.table.GridTableType GridTable}, the `press` event is fired when
|
|
19174
|
+
* a row action item is pressed.
|
|
18512
19175
|
*
|
|
18513
|
-
*
|
|
18514
|
-
* `rowPress` event
|
|
19176
|
+
* If the table type is {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}, the `press` event
|
|
19177
|
+
* and the table's `rowPress` event are fired when a row with a row action item is pressed.
|
|
18515
19178
|
*
|
|
18516
19179
|
*
|
|
18517
19180
|
* @returns Reference to `this` in order to allow method chaining
|
|
@@ -18539,10 +19202,11 @@ declare module "sap/ui/mdc/table/RowActionItem" {
|
|
|
18539
19202
|
*
|
|
18540
19203
|
* Fired when the row action item is pressed.
|
|
18541
19204
|
*
|
|
18542
|
-
*
|
|
19205
|
+
* If the table type is {@link sap.ui.mdc.table.GridTableType GridTable}, the `press` event is fired when
|
|
19206
|
+
* a row action item is pressed.
|
|
18543
19207
|
*
|
|
18544
|
-
*
|
|
18545
|
-
* `rowPress` event
|
|
19208
|
+
* If the table type is {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}, the `press` event
|
|
19209
|
+
* and the table's `rowPress` event are fired when a row with a row action item is pressed.
|
|
18546
19210
|
*
|
|
18547
19211
|
*
|
|
18548
19212
|
* @returns Reference to `this` in order to allow method chaining
|
|
@@ -18593,7 +19257,7 @@ declare module "sap/ui/mdc/table/RowActionItem" {
|
|
|
18593
19257
|
*
|
|
18594
19258
|
* Icon for the row action item.
|
|
18595
19259
|
*
|
|
18596
|
-
* A custom icon cannot be set when
|
|
19260
|
+
* **Note:** A custom icon cannot be set when the table type is {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}.
|
|
18597
19261
|
*
|
|
18598
19262
|
*
|
|
18599
19263
|
* @returns Value of property `icon`
|
|
@@ -18604,7 +19268,7 @@ declare module "sap/ui/mdc/table/RowActionItem" {
|
|
|
18604
19268
|
*
|
|
18605
19269
|
* Text for the row action item.
|
|
18606
19270
|
*
|
|
18607
|
-
*
|
|
19271
|
+
* **Note:** A custom text cannot be set when the table type is {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}.
|
|
18608
19272
|
*
|
|
18609
19273
|
*
|
|
18610
19274
|
* @returns Value of property `text`
|
|
@@ -18615,14 +19279,13 @@ declare module "sap/ui/mdc/table/RowActionItem" {
|
|
|
18615
19279
|
*
|
|
18616
19280
|
* Type of the row action item.
|
|
18617
19281
|
*
|
|
18618
|
-
*
|
|
18619
|
-
*
|
|
18620
|
-
* is used.
|
|
19282
|
+
* Setting the type ensures default values for the properties `icon` and `text`. If an icon or text is set
|
|
19283
|
+
* explicitly, this setting is used.
|
|
18621
19284
|
*
|
|
18622
19285
|
*
|
|
18623
19286
|
* @returns Value of property `type`
|
|
18624
19287
|
*/
|
|
18625
|
-
getType():
|
|
19288
|
+
getType(): TableRowActionType | keyof typeof TableRowActionType;
|
|
18626
19289
|
/**
|
|
18627
19290
|
* Gets current value of property {@link #getVisible visible}.
|
|
18628
19291
|
*
|
|
@@ -18639,7 +19302,7 @@ declare module "sap/ui/mdc/table/RowActionItem" {
|
|
|
18639
19302
|
*
|
|
18640
19303
|
* Icon for the row action item.
|
|
18641
19304
|
*
|
|
18642
|
-
* A custom icon cannot be set when
|
|
19305
|
+
* **Note:** A custom icon cannot be set when the table type is {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}.
|
|
18643
19306
|
*
|
|
18644
19307
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
18645
19308
|
*
|
|
@@ -18657,7 +19320,7 @@ declare module "sap/ui/mdc/table/RowActionItem" {
|
|
|
18657
19320
|
*
|
|
18658
19321
|
* Text for the row action item.
|
|
18659
19322
|
*
|
|
18660
|
-
*
|
|
19323
|
+
* **Note:** A custom text cannot be set when the table type is {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}.
|
|
18661
19324
|
*
|
|
18662
19325
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
18663
19326
|
*
|
|
@@ -18675,9 +19338,8 @@ declare module "sap/ui/mdc/table/RowActionItem" {
|
|
|
18675
19338
|
*
|
|
18676
19339
|
* Type of the row action item.
|
|
18677
19340
|
*
|
|
18678
|
-
*
|
|
18679
|
-
*
|
|
18680
|
-
* is used.
|
|
19341
|
+
* Setting the type ensures default values for the properties `icon` and `text`. If an icon or text is set
|
|
19342
|
+
* explicitly, this setting is used.
|
|
18681
19343
|
*
|
|
18682
19344
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
18683
19345
|
*
|
|
@@ -18688,7 +19350,7 @@ declare module "sap/ui/mdc/table/RowActionItem" {
|
|
|
18688
19350
|
/**
|
|
18689
19351
|
* New value for property `type`
|
|
18690
19352
|
*/
|
|
18691
|
-
sType:
|
|
19353
|
+
sType: TableRowActionType | keyof typeof TableRowActionType
|
|
18692
19354
|
): this;
|
|
18693
19355
|
/**
|
|
18694
19356
|
* Sets a new value for property {@link #getVisible visible}.
|
|
@@ -18714,26 +19376,25 @@ declare module "sap/ui/mdc/table/RowActionItem" {
|
|
|
18714
19376
|
/**
|
|
18715
19377
|
* Type of the row action item.
|
|
18716
19378
|
*
|
|
18717
|
-
*
|
|
18718
|
-
*
|
|
18719
|
-
* is used.
|
|
19379
|
+
* Setting the type ensures default values for the properties `icon` and `text`. If an icon or text is set
|
|
19380
|
+
* explicitly, this setting is used.
|
|
18720
19381
|
*/
|
|
18721
19382
|
type?:
|
|
18722
|
-
| (
|
|
19383
|
+
| (TableRowActionType | keyof typeof TableRowActionType)
|
|
18723
19384
|
| PropertyBindingInfo
|
|
18724
19385
|
| `{${string}}`;
|
|
18725
19386
|
|
|
18726
19387
|
/**
|
|
18727
19388
|
* Text for the row action item.
|
|
18728
19389
|
*
|
|
18729
|
-
*
|
|
19390
|
+
* **Note:** A custom text cannot be set when the table type is {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}.
|
|
18730
19391
|
*/
|
|
18731
19392
|
text?: string | PropertyBindingInfo;
|
|
18732
19393
|
|
|
18733
19394
|
/**
|
|
18734
19395
|
* Icon for the row action item.
|
|
18735
19396
|
*
|
|
18736
|
-
* A custom icon cannot be set when
|
|
19397
|
+
* **Note:** A custom icon cannot be set when the table type is {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}.
|
|
18737
19398
|
*/
|
|
18738
19399
|
icon?: URI | PropertyBindingInfo | `{${string}}`;
|
|
18739
19400
|
|
|
@@ -18745,10 +19406,11 @@ declare module "sap/ui/mdc/table/RowActionItem" {
|
|
|
18745
19406
|
/**
|
|
18746
19407
|
* Fired when the row action item is pressed.
|
|
18747
19408
|
*
|
|
18748
|
-
*
|
|
19409
|
+
* If the table type is {@link sap.ui.mdc.table.GridTableType GridTable}, the `press` event is fired when
|
|
19410
|
+
* a row action item is pressed.
|
|
18749
19411
|
*
|
|
18750
|
-
*
|
|
18751
|
-
* `rowPress` event
|
|
19412
|
+
* If the table type is {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}, the `press` event
|
|
19413
|
+
* and the table's `rowPress` event are fired when a row with a row action item is pressed.
|
|
18752
19414
|
*/
|
|
18753
19415
|
press?: (oEvent: RowActionItem$PressEvent) => void;
|
|
18754
19416
|
}
|
|
@@ -18879,7 +19541,7 @@ declare module "sap/ui/mdc/table/RowSettings" {
|
|
|
18879
19541
|
* highlights are visible. Valid values for the `highlight` property are values of the enumerations {@link sap.ui.core.MessageType }
|
|
18880
19542
|
* or {@link sap.ui.core.IndicationColor}.
|
|
18881
19543
|
*
|
|
18882
|
-
* Accessibility support is provided
|
|
19544
|
+
* Accessibility support is provided with the {@link sap.ui.mdc.table.RowSettings#setHighlightText highlightText }
|
|
18883
19545
|
* property. If the `highlight` property is set to a value of {@link sap.ui.core.MessageType}, the `highlightText`
|
|
18884
19546
|
* property does not need to be set because a default text is used. However, the default text can be overridden
|
|
18885
19547
|
* by setting the `highlightText` property. In all other cases the `highlightText` property must be set.
|
|
@@ -18905,9 +19567,7 @@ declare module "sap/ui/mdc/table/RowSettings" {
|
|
|
18905
19567
|
/**
|
|
18906
19568
|
* Gets current value of property {@link #getNavigated navigated}.
|
|
18907
19569
|
*
|
|
18908
|
-
* The navigated state of a row.
|
|
18909
|
-
*
|
|
18910
|
-
* If set to `true`, a navigation indicator is displayed at the end of the row.
|
|
19570
|
+
* The navigated state of a row. The navigation indicator is displayed at the end of a row.
|
|
18911
19571
|
*
|
|
18912
19572
|
* Default value is `false`.
|
|
18913
19573
|
*
|
|
@@ -18918,10 +19578,11 @@ declare module "sap/ui/mdc/table/RowSettings" {
|
|
|
18918
19578
|
/**
|
|
18919
19579
|
* Gets content of aggregation {@link #getRowActions rowActions}.
|
|
18920
19580
|
*
|
|
18921
|
-
* The
|
|
19581
|
+
* The actions that appear at the end of a row.
|
|
18922
19582
|
*
|
|
18923
|
-
*
|
|
18924
|
-
*
|
|
19583
|
+
* **Note:** This aggregation cannot be bound with a factory.
|
|
19584
|
+
* If the table type is {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}, only the `Navigation`
|
|
19585
|
+
* row action type is supported.
|
|
18925
19586
|
*/
|
|
18926
19587
|
getRowActions(): RowActionItem[];
|
|
18927
19588
|
/**
|
|
@@ -18985,7 +19646,7 @@ declare module "sap/ui/mdc/table/RowSettings" {
|
|
|
18985
19646
|
* highlights are visible. Valid values for the `highlight` property are values of the enumerations {@link sap.ui.core.MessageType }
|
|
18986
19647
|
* or {@link sap.ui.core.IndicationColor}.
|
|
18987
19648
|
*
|
|
18988
|
-
* Accessibility support is provided
|
|
19649
|
+
* Accessibility support is provided with the {@link sap.ui.mdc.table.RowSettings#setHighlightText highlightText }
|
|
18989
19650
|
* property. If the `highlight` property is set to a value of {@link sap.ui.core.MessageType}, the `highlightText`
|
|
18990
19651
|
* property does not need to be set because a default text is used. However, the default text can be overridden
|
|
18991
19652
|
* by setting the `highlightText` property. In all other cases the `highlightText` property must be set.
|
|
@@ -19025,9 +19686,7 @@ declare module "sap/ui/mdc/table/RowSettings" {
|
|
|
19025
19686
|
/**
|
|
19026
19687
|
* Sets a new value for property {@link #getNavigated navigated}.
|
|
19027
19688
|
*
|
|
19028
|
-
* The navigated state of a row.
|
|
19029
|
-
*
|
|
19030
|
-
* If set to `true`, a navigation indicator is displayed at the end of the row.
|
|
19689
|
+
* The navigated state of a row. The navigation indicator is displayed at the end of a row.
|
|
19031
19690
|
*
|
|
19032
19691
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
19033
19692
|
*
|
|
@@ -19052,7 +19711,7 @@ declare module "sap/ui/mdc/table/RowSettings" {
|
|
|
19052
19711
|
* highlights are visible. Valid values for the `highlight` property are values of the enumerations {@link sap.ui.core.MessageType }
|
|
19053
19712
|
* or {@link sap.ui.core.IndicationColor}.
|
|
19054
19713
|
*
|
|
19055
|
-
* Accessibility support is provided
|
|
19714
|
+
* Accessibility support is provided with the {@link sap.ui.mdc.table.RowSettings#setHighlightText highlightText }
|
|
19056
19715
|
* property. If the `highlight` property is set to a value of {@link sap.ui.core.MessageType}, the `highlightText`
|
|
19057
19716
|
* property does not need to be set because a default text is used. However, the default text can be overridden
|
|
19058
19717
|
* by setting the `highlightText` property. In all other cases the `highlightText` property must be set.
|
|
@@ -19066,17 +19725,16 @@ declare module "sap/ui/mdc/table/RowSettings" {
|
|
|
19066
19725
|
highlightText?: string | PropertyBindingInfo;
|
|
19067
19726
|
|
|
19068
19727
|
/**
|
|
19069
|
-
* The navigated state of a row.
|
|
19070
|
-
*
|
|
19071
|
-
* If set to `true`, a navigation indicator is displayed at the end of the row.
|
|
19728
|
+
* The navigated state of a row. The navigation indicator is displayed at the end of a row.
|
|
19072
19729
|
*/
|
|
19073
19730
|
navigated?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
19074
19731
|
|
|
19075
19732
|
/**
|
|
19076
|
-
* The
|
|
19733
|
+
* The actions that appear at the end of a row.
|
|
19077
19734
|
*
|
|
19078
|
-
*
|
|
19079
|
-
*
|
|
19735
|
+
* **Note:** This aggregation cannot be bound with a factory.
|
|
19736
|
+
* If the table type is {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}, only the `Navigation`
|
|
19737
|
+
* row action type is supported.
|
|
19080
19738
|
*/
|
|
19081
19739
|
rowActions?:
|
|
19082
19740
|
| RowActionItem[]
|
|
@@ -19265,9 +19923,10 @@ declare module "sap/ui/mdc/util/PropertyHelper" {
|
|
|
19265
19923
|
/**
|
|
19266
19924
|
* Unique, stable key for the property. It must only contain characters allowed for IDs, see {@link sap.ui.core.ID}.
|
|
19267
19925
|
* Does not have to be an existing attribute in the data model or the technical name of an attribute in
|
|
19268
|
-
* the data model.
|
|
19926
|
+
* the data model. **Note:** 'key' replaces the deprecated 'name' attribute, which will also be interpolated
|
|
19927
|
+
* by the PropertyHelper for legacy code support.
|
|
19269
19928
|
*/
|
|
19270
|
-
|
|
19929
|
+
key: string;
|
|
19271
19930
|
/**
|
|
19272
19931
|
* The technical path for a data source property.
|
|
19273
19932
|
*/
|
|
@@ -20085,7 +20744,17 @@ declare module "sap/ui/mdc/ValueHelp" {
|
|
|
20085
20744
|
/**
|
|
20086
20745
|
* Gets current value of property {@link #getDelegate delegate}.
|
|
20087
20746
|
*
|
|
20088
|
-
*
|
|
20747
|
+
* Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
|
|
20748
|
+
* The object has the following properties:
|
|
20749
|
+
* - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/ValueHelpDelegate ValueHelpDelegate }
|
|
20750
|
+
*
|
|
20751
|
+
* - `payload` (optional) defines application-specific information that can be used in the given delegate
|
|
20752
|
+
* Sample delegate object:
|
|
20753
|
+
* ```javascript
|
|
20754
|
+
* {
|
|
20755
|
+
* name: "sap/ui/mdc/ValueHelpDelegate",
|
|
20756
|
+
* payload: {}
|
|
20757
|
+
* }```
|
|
20089
20758
|
* **Note:** Ensure that the related file can be requested (any required library has to be loaded before
|
|
20090
20759
|
* that).
|
|
20091
20760
|
* Do not bind or modify the module. This property can only be configured during control initialization.
|
|
@@ -20168,7 +20837,17 @@ declare module "sap/ui/mdc/ValueHelp" {
|
|
|
20168
20837
|
/**
|
|
20169
20838
|
* Sets a new value for property {@link #getDelegate delegate}.
|
|
20170
20839
|
*
|
|
20171
|
-
*
|
|
20840
|
+
* Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
|
|
20841
|
+
* The object has the following properties:
|
|
20842
|
+
* - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/ValueHelpDelegate ValueHelpDelegate }
|
|
20843
|
+
*
|
|
20844
|
+
* - `payload` (optional) defines application-specific information that can be used in the given delegate
|
|
20845
|
+
* Sample delegate object:
|
|
20846
|
+
* ```javascript
|
|
20847
|
+
* {
|
|
20848
|
+
* name: "sap/ui/mdc/ValueHelpDelegate",
|
|
20849
|
+
* payload: {}
|
|
20850
|
+
* }```
|
|
20172
20851
|
* **Note:** Ensure that the related file can be requested (any required library has to be loaded before
|
|
20173
20852
|
* that).
|
|
20174
20853
|
* Do not bind or modify the module. This property can only be configured during control initialization.
|
|
@@ -20332,7 +21011,17 @@ declare module "sap/ui/mdc/ValueHelp" {
|
|
|
20332
21011
|
conditions?: object[] | PropertyBindingInfo | `{${string}}`;
|
|
20333
21012
|
|
|
20334
21013
|
/**
|
|
20335
|
-
*
|
|
21014
|
+
* Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
|
|
21015
|
+
* The object has the following properties:
|
|
21016
|
+
* - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/ValueHelpDelegate ValueHelpDelegate }
|
|
21017
|
+
*
|
|
21018
|
+
* - `payload` (optional) defines application-specific information that can be used in the given delegate
|
|
21019
|
+
* Sample delegate object:
|
|
21020
|
+
* ```javascript
|
|
21021
|
+
* {
|
|
21022
|
+
* name: "sap/ui/mdc/ValueHelpDelegate",
|
|
21023
|
+
* payload: {}
|
|
21024
|
+
* }```
|
|
20336
21025
|
* **Note:** Ensure that the related file can be requested (any required library has to be loaded before
|
|
20337
21026
|
* that).
|
|
20338
21027
|
* Do not bind or modify the module. This property can only be configured during control initialization.
|
|
@@ -20537,6 +21226,11 @@ declare module "sap/ui/mdc/ValueHelp" {
|
|
|
20537
21226
|
* ID of the suggested item (This is needed to set the corresponding ARIA attribute)
|
|
20538
21227
|
*/
|
|
20539
21228
|
itemId?: string;
|
|
21229
|
+
|
|
21230
|
+
/**
|
|
21231
|
+
* If `true` the filtering was executed case sensitive
|
|
21232
|
+
*/
|
|
21233
|
+
caseSensitive?: boolean;
|
|
20540
21234
|
}
|
|
20541
21235
|
|
|
20542
21236
|
export type ValueHelp$TypeaheadSuggestedEvent = Event<
|
|
@@ -21928,6 +22622,11 @@ declare module "sap/ui/mdc/valuehelp/base/Container" {
|
|
|
21928
22622
|
* ID of the suggested item (This is needed to set the corresponding ARIA attribute)
|
|
21929
22623
|
*/
|
|
21930
22624
|
itemId?: string;
|
|
22625
|
+
|
|
22626
|
+
/**
|
|
22627
|
+
* If `true` the filtering was executed case sensitive
|
|
22628
|
+
*/
|
|
22629
|
+
caseSensitive?: boolean;
|
|
21931
22630
|
}
|
|
21932
22631
|
|
|
21933
22632
|
export type Container$TypeaheadSuggestedEvent = Event<
|
|
@@ -23080,6 +23779,11 @@ declare module "sap/ui/mdc/valuehelp/base/Content" {
|
|
|
23080
23779
|
* ID of the suggested item (This is needed to set the corresponding ARIA attribute)
|
|
23081
23780
|
*/
|
|
23082
23781
|
itemId?: string;
|
|
23782
|
+
|
|
23783
|
+
/**
|
|
23784
|
+
* If `true` the filtering was executed case sensitive
|
|
23785
|
+
*/
|
|
23786
|
+
caseSensitive?: boolean;
|
|
23083
23787
|
}
|
|
23084
23788
|
|
|
23085
23789
|
export type Content$TypeaheadSuggestedEvent = Event<
|
|
@@ -23105,6 +23809,8 @@ declare module "sap/ui/mdc/valuehelp/base/FilterableListContent" {
|
|
|
23105
23809
|
|
|
23106
23810
|
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
23107
23811
|
|
|
23812
|
+
import { ConditionObject } from "sap/ui/mdc/condition/Condition";
|
|
23813
|
+
|
|
23108
23814
|
/**
|
|
23109
23815
|
* Content for the {@link sap.ui.mdc.valuehelp.base.Container Container} element.
|
|
23110
23816
|
*
|
|
@@ -23209,6 +23915,14 @@ declare module "sap/ui/mdc/valuehelp/base/FilterableListContent" {
|
|
|
23209
23915
|
* @returns Reference to `this` in order to allow method chaining
|
|
23210
23916
|
*/
|
|
23211
23917
|
destroyFilterBar(): this;
|
|
23918
|
+
/**
|
|
23919
|
+
* Gets the currently used `FilterBar` control.
|
|
23920
|
+
*
|
|
23921
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
23922
|
+
*
|
|
23923
|
+
* @returns FilterBar
|
|
23924
|
+
*/
|
|
23925
|
+
getActiveFilterBar(): FilterBar;
|
|
23212
23926
|
/**
|
|
23213
23927
|
* Gets current value of property {@link #getDescriptionPath descriptionPath}.
|
|
23214
23928
|
*
|
|
@@ -23244,7 +23958,7 @@ declare module "sap/ui/mdc/valuehelp/base/FilterableListContent" {
|
|
|
23244
23958
|
*
|
|
23245
23959
|
* Default value is `empty string`.
|
|
23246
23960
|
*
|
|
23247
|
-
* @deprecated (since 1.120.2) -
|
|
23961
|
+
* @deprecated (since 1.120.2) - please see `{@link module:sap/ui/mdc/ValueHelpDelegate.isSearchSupported isSearchSupported}`
|
|
23248
23962
|
*
|
|
23249
23963
|
* @returns Value of property `filterFields`
|
|
23250
23964
|
*/
|
|
@@ -23299,6 +24013,14 @@ declare module "sap/ui/mdc/valuehelp/base/FilterableListContent" {
|
|
|
23299
24013
|
* @returns `ListBindingInfo`
|
|
23300
24014
|
*/
|
|
23301
24015
|
getListBindingInfo(): AggregationBindingInfo;
|
|
24016
|
+
/**
|
|
24017
|
+
* Gets the currently used filter value.
|
|
24018
|
+
*
|
|
24019
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
24020
|
+
*
|
|
24021
|
+
* @returns filter value
|
|
24022
|
+
*/
|
|
24023
|
+
getSearch(): string;
|
|
23302
24024
|
/**
|
|
23303
24025
|
* Gets the conditions that are selectable from list content.
|
|
23304
24026
|
*
|
|
@@ -23306,9 +24028,9 @@ declare module "sap/ui/mdc/valuehelp/base/FilterableListContent" {
|
|
|
23306
24028
|
*
|
|
23307
24029
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
23308
24030
|
*
|
|
23309
|
-
* @returns
|
|
24031
|
+
* @returns Conditions
|
|
23310
24032
|
*/
|
|
23311
|
-
getSelectableConditions():
|
|
24033
|
+
getSelectableConditions(): ConditionObject[];
|
|
23312
24034
|
/**
|
|
23313
24035
|
* Sets a new value for property {@link #getDescriptionPath descriptionPath}.
|
|
23314
24036
|
*
|
|
@@ -23359,7 +24081,7 @@ declare module "sap/ui/mdc/valuehelp/base/FilterableListContent" {
|
|
|
23359
24081
|
*
|
|
23360
24082
|
* Default value is `empty string`.
|
|
23361
24083
|
*
|
|
23362
|
-
* @deprecated (since 1.120.2) -
|
|
24084
|
+
* @deprecated (since 1.120.2) - please see `{@link module:sap/ui/mdc/ValueHelpDelegate.isSearchSupported isSearchSupported}`
|
|
23363
24085
|
*
|
|
23364
24086
|
* @returns Reference to `this` in order to allow method chaining
|
|
23365
24087
|
*/
|
|
@@ -23424,7 +24146,7 @@ declare module "sap/ui/mdc/valuehelp/base/FilterableListContent" {
|
|
|
23424
24146
|
*
|
|
23425
24147
|
* If it is empty, no suggestion is available.
|
|
23426
24148
|
*
|
|
23427
|
-
* @deprecated (since 1.120.2) -
|
|
24149
|
+
* @deprecated (since 1.120.2) - please see `{@link module:sap/ui/mdc/ValueHelpDelegate.isSearchSupported isSearchSupported}`
|
|
23428
24150
|
*/
|
|
23429
24151
|
filterFields?: string | PropertyBindingInfo;
|
|
23430
24152
|
|
|
@@ -23572,7 +24294,12 @@ declare module "sap/ui/mdc/valuehelp/base/ListContent" {
|
|
|
23572
24294
|
*
|
|
23573
24295
|
* @returns `BindingContexts`
|
|
23574
24296
|
*/
|
|
23575
|
-
getRelevantContexts(
|
|
24297
|
+
getRelevantContexts(
|
|
24298
|
+
/**
|
|
24299
|
+
* Configuration
|
|
24300
|
+
*/
|
|
24301
|
+
oConfig: ItemForValueConfiguration
|
|
24302
|
+
): Context[];
|
|
23576
24303
|
/**
|
|
23577
24304
|
* Gets current value of property {@link #getUseAsValueHelp useAsValueHelp}.
|
|
23578
24305
|
*
|
|
@@ -23590,7 +24317,7 @@ declare module "sap/ui/mdc/valuehelp/base/ListContent" {
|
|
|
23590
24317
|
* If set, `getItemForValue` returns the first item that matches the text.
|
|
23591
24318
|
*
|
|
23592
24319
|
* In the default implementation, this is the first item that matches the entered text. Which item is used
|
|
23593
|
-
* can be determined by implementing {@link sap
|
|
24320
|
+
* can be determined by implementing {@link module:sap/ui/mdc/ValueHelpDelegate.getFirstMatch getFirstMatch}.
|
|
23594
24321
|
*
|
|
23595
24322
|
* The matching item is returned in the `typeaheadSuggested` event and used for the autocomplete feature
|
|
23596
24323
|
* in the connected field.
|
|
@@ -23647,7 +24374,7 @@ declare module "sap/ui/mdc/valuehelp/base/ListContent" {
|
|
|
23647
24374
|
* If set, `getItemForValue` returns the first item that matches the text.
|
|
23648
24375
|
*
|
|
23649
24376
|
* In the default implementation, this is the first item that matches the entered text. Which item is used
|
|
23650
|
-
* can be determined by implementing {@link sap
|
|
24377
|
+
* can be determined by implementing {@link module:sap/ui/mdc/ValueHelpDelegate.getFirstMatch getFirstMatch}.
|
|
23651
24378
|
*
|
|
23652
24379
|
* The matching item is returned in the `typeaheadSuggested` event and used for the autocomplete feature
|
|
23653
24380
|
* in the connected field.
|
|
@@ -23681,7 +24408,7 @@ declare module "sap/ui/mdc/valuehelp/base/ListContent" {
|
|
|
23681
24408
|
* If set, `getItemForValue` returns the first item that matches the text.
|
|
23682
24409
|
*
|
|
23683
24410
|
* In the default implementation, this is the first item that matches the entered text. Which item is used
|
|
23684
|
-
* can be determined by implementing {@link sap
|
|
24411
|
+
* can be determined by implementing {@link module:sap/ui/mdc/ValueHelpDelegate.getFirstMatch getFirstMatch}.
|
|
23685
24412
|
*
|
|
23686
24413
|
* The matching item is returned in the `typeaheadSuggested` event and used for the autocomplete feature
|
|
23687
24414
|
* in the connected field.
|
|
@@ -23783,7 +24510,7 @@ declare module "sap/ui/mdc/valuehelp/content/Conditions" {
|
|
|
23783
24510
|
*
|
|
23784
24511
|
* @deprecated (since 1.114.0) - replaced by {@link #setValueHelp valueHelp} association
|
|
23785
24512
|
*/
|
|
23786
|
-
getFieldHelp(): ID;
|
|
24513
|
+
getFieldHelp(): ID | null;
|
|
23787
24514
|
/**
|
|
23788
24515
|
* Gets current value of property {@link #getLabel label}.
|
|
23789
24516
|
*
|
|
@@ -23797,7 +24524,7 @@ declare module "sap/ui/mdc/valuehelp/content/Conditions" {
|
|
|
23797
24524
|
* ID of the element which is the current target of the association {@link #getValueHelp valueHelp}, or
|
|
23798
24525
|
* `null`.
|
|
23799
24526
|
*/
|
|
23800
|
-
getValueHelp(): ID;
|
|
24527
|
+
getValueHelp(): ID | null;
|
|
23801
24528
|
/**
|
|
23802
24529
|
* Sets the associated {@link #getFieldHelp fieldHelp}.
|
|
23803
24530
|
*
|
|
@@ -24946,11 +25673,12 @@ declare module "sap/ui/mdc/valuehelp/Popover" {
|
|
|
24946
25673
|
*
|
|
24947
25674
|
* **Note:** By default, a type-ahead is only shown to provide suggestions when users enter input in a connected
|
|
24948
25675
|
* control. This property enables scenarios where popovers need to be shown earlier (for example, recommendations
|
|
24949
|
-
* or recently entered values). See also {@link sap
|
|
25676
|
+
* or recently entered values). See also {@link module:sap/ui/mdc/ValueHelpDelegate.showTypeahead showTypeahead}
|
|
24950
25677
|
*
|
|
24951
25678
|
* Default value is `false`.
|
|
24952
25679
|
*
|
|
24953
25680
|
* @since 1.110.0
|
|
25681
|
+
* @deprecated (since 1.121.0) - replaced by {@link module:sap/ui/mdc/ValueHelpDelegate.shouldOpenOnClick shouldOpenOnClick}
|
|
24954
25682
|
*
|
|
24955
25683
|
* @returns Value of property `opensOnClick`
|
|
24956
25684
|
*/
|
|
@@ -24962,11 +25690,12 @@ declare module "sap/ui/mdc/valuehelp/Popover" {
|
|
|
24962
25690
|
*
|
|
24963
25691
|
* **Note:** By default, a type-ahead is only shown to provide suggestions when users enter input in a connected
|
|
24964
25692
|
* control. This property enables scenarios where popovers need to be shown earlier (for example, recommendations
|
|
24965
|
-
* or recently entered values). See also {@link sap
|
|
25693
|
+
* or recently entered values). See also {@link module:sap/ui/mdc/ValueHelpDelegate.showTypeahead showTypeahead}
|
|
24966
25694
|
*
|
|
24967
25695
|
* Default value is `false`.
|
|
24968
25696
|
*
|
|
24969
25697
|
* @since 1.112.0
|
|
25698
|
+
* @deprecated (since 1.121.0) - replaced by {@link module:sap/ui/mdc/ValueHelpDelegate.shouldOpenOnFocus shouldOpenOnFocus}
|
|
24970
25699
|
*
|
|
24971
25700
|
* @returns Value of property `opensOnFocus`
|
|
24972
25701
|
*/
|
|
@@ -24979,13 +25708,14 @@ declare module "sap/ui/mdc/valuehelp/Popover" {
|
|
|
24979
25708
|
*
|
|
24980
25709
|
* **Note:** By default, a type-ahead is only shown to provide suggestions when users enter input in a connected
|
|
24981
25710
|
* control. This property enables scenarios where popovers need to be shown earlier (for example, recommendations
|
|
24982
|
-
* or recently entered values). See also {@link sap
|
|
25711
|
+
* or recently entered values). See also {@link module:sap/ui/mdc/ValueHelpDelegate.showTypeahead showTypeahead}
|
|
24983
25712
|
*
|
|
24984
25713
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
24985
25714
|
*
|
|
24986
25715
|
* Default value is `false`.
|
|
24987
25716
|
*
|
|
24988
25717
|
* @since 1.110.0
|
|
25718
|
+
* @deprecated (since 1.121.0) - replaced by {@link module:sap/ui/mdc/ValueHelpDelegate.shouldOpenOnClick shouldOpenOnClick}
|
|
24989
25719
|
*
|
|
24990
25720
|
* @returns Reference to `this` in order to allow method chaining
|
|
24991
25721
|
*/
|
|
@@ -25002,13 +25732,14 @@ declare module "sap/ui/mdc/valuehelp/Popover" {
|
|
|
25002
25732
|
*
|
|
25003
25733
|
* **Note:** By default, a type-ahead is only shown to provide suggestions when users enter input in a connected
|
|
25004
25734
|
* control. This property enables scenarios where popovers need to be shown earlier (for example, recommendations
|
|
25005
|
-
* or recently entered values). See also {@link sap
|
|
25735
|
+
* or recently entered values). See also {@link module:sap/ui/mdc/ValueHelpDelegate.showTypeahead showTypeahead}
|
|
25006
25736
|
*
|
|
25007
25737
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
25008
25738
|
*
|
|
25009
25739
|
* Default value is `false`.
|
|
25010
25740
|
*
|
|
25011
25741
|
* @since 1.112.0
|
|
25742
|
+
* @deprecated (since 1.121.0) - replaced by {@link module:sap/ui/mdc/ValueHelpDelegate.shouldOpenOnFocus shouldOpenOnFocus}
|
|
25012
25743
|
*
|
|
25013
25744
|
* @returns Reference to `this` in order to allow method chaining
|
|
25014
25745
|
*/
|
|
@@ -25027,9 +25758,10 @@ declare module "sap/ui/mdc/valuehelp/Popover" {
|
|
|
25027
25758
|
*
|
|
25028
25759
|
* **Note:** By default, a type-ahead is only shown to provide suggestions when users enter input in a connected
|
|
25029
25760
|
* control. This property enables scenarios where popovers need to be shown earlier (for example, recommendations
|
|
25030
|
-
* or recently entered values). See also {@link sap
|
|
25761
|
+
* or recently entered values). See also {@link module:sap/ui/mdc/ValueHelpDelegate.showTypeahead showTypeahead}
|
|
25031
25762
|
*
|
|
25032
25763
|
* @since 1.110.0
|
|
25764
|
+
* @deprecated (since 1.121.0) - replaced by {@link module:sap/ui/mdc/ValueHelpDelegate.shouldOpenOnClick shouldOpenOnClick}
|
|
25033
25765
|
*/
|
|
25034
25766
|
opensOnClick?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
25035
25767
|
|
|
@@ -25038,9 +25770,10 @@ declare module "sap/ui/mdc/valuehelp/Popover" {
|
|
|
25038
25770
|
*
|
|
25039
25771
|
* **Note:** By default, a type-ahead is only shown to provide suggestions when users enter input in a connected
|
|
25040
25772
|
* control. This property enables scenarios where popovers need to be shown earlier (for example, recommendations
|
|
25041
|
-
* or recently entered values). See also {@link sap
|
|
25773
|
+
* or recently entered values). See also {@link module:sap/ui/mdc/ValueHelpDelegate.showTypeahead showTypeahead}
|
|
25042
25774
|
*
|
|
25043
25775
|
* @since 1.112.0
|
|
25776
|
+
* @deprecated (since 1.121.0) - replaced by {@link module:sap/ui/mdc/ValueHelpDelegate.shouldOpenOnFocus shouldOpenOnFocus}
|
|
25044
25777
|
*/
|
|
25045
25778
|
opensOnFocus?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
25046
25779
|
}
|
|
@@ -25160,7 +25893,7 @@ declare namespace sap {
|
|
|
25160
25893
|
|
|
25161
25894
|
"sap/ui/mdc/enums/TableP13nMode": undefined;
|
|
25162
25895
|
|
|
25163
|
-
"sap/ui/mdc/enums/
|
|
25896
|
+
"sap/ui/mdc/enums/TableRowActionType": undefined;
|
|
25164
25897
|
|
|
25165
25898
|
"sap/ui/mdc/enums/TableRowCountMode": undefined;
|
|
25166
25899
|
|