@sapui5/ts-types 1.146.0 → 1.147.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/types/index.d.ts +0 -3
- package/types/sap.apf.d.ts +1 -1
- package/types/sap.ca.ui.d.ts +1 -1
- package/types/sap.chart.d.ts +4 -7
- package/types/sap.collaboration.d.ts +1 -1
- package/types/sap.esh.search.ui.d.ts +1 -52
- package/types/sap.f.d.ts +144 -1
- package/types/sap.fe.ariba.d.ts +1 -1
- package/types/sap.fe.base.d.ts +1 -1
- package/types/sap.fe.controls.d.ts +1 -1
- package/types/sap.fe.core.d.ts +1 -1
- package/types/sap.fe.ina.d.ts +1 -1
- package/types/sap.fe.macros.d.ts +1666 -1005
- package/types/sap.fe.navigation.d.ts +1 -1
- package/types/sap.fe.placeholder.d.ts +1 -1
- package/types/sap.fe.plugins.managecache.d.ts +1 -1
- package/types/sap.fe.templates.d.ts +1 -1
- package/types/sap.fe.test.d.ts +49 -1
- package/types/sap.fe.tools.d.ts +1 -1
- package/types/sap.feedback.ui.d.ts +1 -1
- package/types/sap.gantt.d.ts +182 -1
- package/types/sap.insights.d.ts +14 -1
- package/types/sap.m.d.ts +376 -127
- package/types/sap.makit.d.ts +1 -1
- package/types/sap.me.d.ts +1 -1
- package/types/sap.ndc.d.ts +1 -1
- package/types/sap.ovp.d.ts +1 -1
- package/types/sap.rules.ui.d.ts +1 -1
- package/types/sap.sac.df.d.ts +1 -1
- package/types/sap.suite.ui.commons.d.ts +122 -1
- package/types/sap.suite.ui.generic.template.d.ts +79 -1
- package/types/sap.suite.ui.microchart.d.ts +1 -1
- package/types/sap.tnt.d.ts +1 -4
- package/types/sap.ui.codeeditor.d.ts +82 -46
- package/types/sap.ui.commons.d.ts +1 -1
- package/types/sap.ui.comp.d.ts +5 -15
- package/types/sap.ui.core.d.ts +175 -16
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.export.d.ts +1 -1
- package/types/sap.ui.fl.d.ts +5 -1
- package/types/sap.ui.generic.app.d.ts +5 -5
- package/types/sap.ui.generic.template.d.ts +1 -1
- package/types/sap.ui.geomap.d.ts +1 -1
- package/types/sap.ui.integration.d.ts +23 -25
- package/types/sap.ui.layout.d.ts +1 -1
- package/types/sap.ui.mdc.d.ts +107 -20
- package/types/sap.ui.richtexteditor.d.ts +1 -1
- package/types/sap.ui.rta.d.ts +1 -1
- package/types/sap.ui.suite.d.ts +1 -1
- package/types/sap.ui.support.d.ts +2 -2
- package/types/sap.ui.table.d.ts +1 -1
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +6 -9
- package/types/sap.ui.ux3.d.ts +1 -1
- package/types/sap.ui.vbm.d.ts +8 -24
- package/types/sap.ui.vk.d.ts +1 -1
- package/types/sap.ui.vtm.d.ts +1 -1
- package/types/sap.uiext.inbox.d.ts +1 -1
- package/types/sap.ushell.d.ts +407 -66
- package/types/sap.ushell_abap.d.ts +1 -1
- package/types/sap.uxap.d.ts +146 -1
- package/types/sap.viz.d.ts +4 -5
- package/types/sap.webanalytics.core.d.ts +1 -1
- package/types/sap.zen.commons.d.ts +1 -1
- package/types/sap.zen.crosstab.d.ts +1 -1
- package/types/sap.zen.dsh.d.ts +1 -1
- package/types/sap.ui.webc.common.d.ts +0 -173
- package/types/sap.ui.webc.fiori.d.ts +0 -16012
- package/types/sap.ui.webc.main.d.ts +0 -51158
package/types/sap.fe.macros.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.
|
|
1
|
+
// For Library Version: 1.147.0
|
|
2
2
|
|
|
3
3
|
declare namespace sap {
|
|
4
4
|
namespace fe {
|
|
@@ -79,7 +79,7 @@ declare namespace sap {
|
|
|
79
79
|
* Describes the settings that can be provided to the Chart constructor.
|
|
80
80
|
*
|
|
81
81
|
* @deprecated As of version 1.130. Use {@link sap.fe.macros.Chart} instead
|
|
82
|
-
* @experimental
|
|
82
|
+
* @experimental As of version 1.124.
|
|
83
83
|
*/
|
|
84
84
|
interface $ChartSettings extends sap.ui.core.$ControlSettings {
|
|
85
85
|
/**
|
|
@@ -245,7 +245,7 @@ declare namespace sap {
|
|
|
245
245
|
*
|
|
246
246
|
*
|
|
247
247
|
* @deprecated As of version 1.130. Use {@link sap.fe.macros.Chart} instead
|
|
248
|
-
* @experimental
|
|
248
|
+
* @experimental As of version 1.124.
|
|
249
249
|
*/
|
|
250
250
|
class Chart extends sap.ui.core.Control {
|
|
251
251
|
/**
|
|
@@ -695,7 +695,7 @@ declare namespace sap {
|
|
|
695
695
|
* Describes the settings that can be provided to the BuildingBlockWithTemplating constructor.
|
|
696
696
|
*
|
|
697
697
|
* @deprecated As of version 1.140.
|
|
698
|
-
* @experimental
|
|
698
|
+
* @experimental As of version 1.136.
|
|
699
699
|
*/
|
|
700
700
|
interface $BuildingBlockWithTemplatingSettings
|
|
701
701
|
extends sap.fe.core.buildingBlocks.$BuildingBlockSettings {}
|
|
@@ -722,18 +722,133 @@ declare namespace sap {
|
|
|
722
722
|
* On change of the main properties you will be able to recreate the content.
|
|
723
723
|
*
|
|
724
724
|
* @deprecated As of version 1.140.
|
|
725
|
-
* @experimental
|
|
725
|
+
* @experimental As of version 1.136.
|
|
726
726
|
*/
|
|
727
727
|
class BuildingBlockWithTemplating extends sap.fe.core.buildingBlocks
|
|
728
728
|
.BuildingBlock {}
|
|
729
729
|
}
|
|
730
730
|
|
|
731
731
|
namespace field {
|
|
732
|
+
namespace mixin {
|
|
733
|
+
/**
|
|
734
|
+
* Mixin providing control access, value getter and setter, enabled state management, and message handling
|
|
735
|
+
* for field controls.
|
|
736
|
+
* This mixin combines the following functionalities:
|
|
737
|
+
* 1. FieldControlAccessor: access to the inner control of field-based building blocks
|
|
738
|
+
* 2. FieldValueAccessor: value getter and setter and enablement getter and setter
|
|
739
|
+
* 3. FieldMessageHandler: adding and managing validation messages
|
|
740
|
+
* This mixin enables building blocks to programmatically read and write values, enabled state,
|
|
741
|
+
* and validation messages across different control types (CheckBox, Input, and MDC Field).
|
|
742
|
+
*/
|
|
743
|
+
class FieldMixin
|
|
744
|
+
implements
|
|
745
|
+
/* was: sap.fe.base.ClassSupport.IInterfaceWithMixin */ Object
|
|
746
|
+
{
|
|
747
|
+
__implements__sap_fe_base_ClassSupport_IInterfaceWithMixin: boolean;
|
|
748
|
+
|
|
749
|
+
/**
|
|
750
|
+
* Adds a validation message to the field.
|
|
751
|
+
* This method creates a new message and associates it with the field's binding path,
|
|
752
|
+
* making it visible in the field's value state and message popover.
|
|
753
|
+
*
|
|
754
|
+
*
|
|
755
|
+
* @returns The ID of the created message
|
|
756
|
+
*/
|
|
757
|
+
addMessage(
|
|
758
|
+
/**
|
|
759
|
+
* The message parameters
|
|
760
|
+
*/
|
|
761
|
+
parameters: {
|
|
762
|
+
/**
|
|
763
|
+
* Detailed message description
|
|
764
|
+
*/
|
|
765
|
+
description?: string;
|
|
766
|
+
/**
|
|
767
|
+
* Message text to display
|
|
768
|
+
*/
|
|
769
|
+
message?: string;
|
|
770
|
+
/**
|
|
771
|
+
* Whether the message persists across refreshes
|
|
772
|
+
*/
|
|
773
|
+
persistent?: boolean;
|
|
774
|
+
/**
|
|
775
|
+
* Type of the message, such as Error, Warning, Success, or Information
|
|
776
|
+
*/
|
|
777
|
+
type?: /* was: sap.ui.core.message.MessageType */ any;
|
|
778
|
+
}
|
|
779
|
+
): string;
|
|
780
|
+
/**
|
|
781
|
+
* Gets the current enabled state of the field.
|
|
782
|
+
* This method handles various control types and wrappers, returning true for controls
|
|
783
|
+
* that are always enabled, such as Text, and checking the enabled property for interactive controls.
|
|
784
|
+
*
|
|
785
|
+
*
|
|
786
|
+
* @returns Boolean value indicating if the field is enabled, or true if control is not found (graceful
|
|
787
|
+
* fallback)
|
|
788
|
+
*/
|
|
789
|
+
getEnabled(): boolean;
|
|
790
|
+
/**
|
|
791
|
+
* Gets the message manager instance from the UI5 core.
|
|
792
|
+
* The message manager is responsible for handling all messages in the application.
|
|
793
|
+
*
|
|
794
|
+
*
|
|
795
|
+
* @returns The Messaging instance
|
|
796
|
+
*/
|
|
797
|
+
getMessageManager(): /* was: sap.ui.core.Messaging */ any;
|
|
798
|
+
/**
|
|
799
|
+
* Gets the current value of the field.
|
|
800
|
+
* This method handles various control types including CheckBox, Input, Text, MDC Field,
|
|
801
|
+
* RatingIndicator, Link, Label, ObjectStatus, ObjectIdentifier, and building blocks.
|
|
802
|
+
*
|
|
803
|
+
*
|
|
804
|
+
* @returns The current value of the field or undefined if control is not found
|
|
805
|
+
*/
|
|
806
|
+
getValue(): boolean | number | string | undefined;
|
|
807
|
+
/**
|
|
808
|
+
* Removes a message from the field by its ID.
|
|
809
|
+
* This method finds the message in the message model and removes it,
|
|
810
|
+
* clearing it from the field's value state.
|
|
811
|
+
*/
|
|
812
|
+
removeMessage(
|
|
813
|
+
/**
|
|
814
|
+
* The ID of the message to remove
|
|
815
|
+
*/
|
|
816
|
+
id: string
|
|
817
|
+
): void;
|
|
818
|
+
/**
|
|
819
|
+
* Sets the current enabled state of the field.
|
|
820
|
+
* This method handles various control types, setting the appropriate property,
|
|
821
|
+
* such as enabled, active, titleActive, or edit mode based on the control type.
|
|
822
|
+
*
|
|
823
|
+
*
|
|
824
|
+
* @returns The current field reference for chaining
|
|
825
|
+
*/
|
|
826
|
+
setEnabled(
|
|
827
|
+
/**
|
|
828
|
+
* The enabled state to set
|
|
829
|
+
*/
|
|
830
|
+
enabled: boolean
|
|
831
|
+
): sap.ui.core.Control;
|
|
832
|
+
/**
|
|
833
|
+
* Sets the current value of the field.
|
|
834
|
+
* This method handles various control types including CheckBox, Input, Text, and MDC Field.
|
|
835
|
+
*
|
|
836
|
+
*
|
|
837
|
+
* @returns The current field reference for chaining
|
|
838
|
+
*/
|
|
839
|
+
setValue(
|
|
840
|
+
/**
|
|
841
|
+
* The value to set
|
|
842
|
+
*/
|
|
843
|
+
value: boolean | number | string
|
|
844
|
+
): sap.ui.core.Control;
|
|
845
|
+
}
|
|
846
|
+
}
|
|
732
847
|
/**
|
|
733
848
|
* Describes the settings that can be provided to the Field constructor.
|
|
734
849
|
*
|
|
735
850
|
* @deprecated As of version 1.135. Use {@link sap.fe.macros.Field} instead
|
|
736
|
-
* @experimental
|
|
851
|
+
* @experimental As of version 1.130.
|
|
737
852
|
*/
|
|
738
853
|
interface $FieldSettings extends sap.ui.core.$ControlSettings {
|
|
739
854
|
/**
|
|
@@ -895,7 +1010,7 @@ declare namespace sap {
|
|
|
895
1010
|
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
896
1011
|
|
|
897
1012
|
/**
|
|
898
|
-
* Defines if the date part of a date time with timezone field
|
|
1013
|
+
* Defines if the date part of a date time with timezone field is shown.
|
|
899
1014
|
*
|
|
900
1015
|
* The dateTimeOffset field must have a timezone annotation.
|
|
901
1016
|
* The default value is true.
|
|
@@ -928,7 +1043,7 @@ declare namespace sap {
|
|
|
928
1043
|
| `{${string}}`;
|
|
929
1044
|
|
|
930
1045
|
/**
|
|
931
|
-
* Defines how the full text
|
|
1046
|
+
* Defines how the full text is displayed.
|
|
932
1047
|
*
|
|
933
1048
|
* Allowed values are "InPlace" and "Popover"
|
|
934
1049
|
*/
|
|
@@ -938,17 +1053,21 @@ declare namespace sap {
|
|
|
938
1053
|
|
|
939
1054
|
/**
|
|
940
1055
|
* Maximum number of lines for multiline texts in edit mode.
|
|
1056
|
+
*
|
|
1057
|
+
* Supports int and string type.
|
|
941
1058
|
*/
|
|
942
1059
|
textLinesEdit?:
|
|
943
|
-
|
|
|
1060
|
+
| any
|
|
944
1061
|
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
945
1062
|
| `{${string}}`;
|
|
946
1063
|
|
|
947
1064
|
/**
|
|
948
1065
|
* Maximum number of characters from the beginning of the text field that are shown initially.
|
|
1066
|
+
*
|
|
1067
|
+
* Supports int and string type.
|
|
949
1068
|
*/
|
|
950
1069
|
textMaxCharactersDisplay?:
|
|
951
|
-
|
|
|
1070
|
+
| any
|
|
952
1071
|
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
953
1072
|
| `{${string}}`;
|
|
954
1073
|
|
|
@@ -957,17 +1076,21 @@ declare namespace sap {
|
|
|
957
1076
|
*
|
|
958
1077
|
* If a multiline text exceeds the maximum number of allowed characters, the counter below the input field
|
|
959
1078
|
* displays the exact number.
|
|
1079
|
+
*
|
|
1080
|
+
* Supports int and string type.
|
|
960
1081
|
*/
|
|
961
1082
|
textMaxLength?:
|
|
962
|
-
|
|
|
1083
|
+
| any
|
|
963
1084
|
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
964
1085
|
| `{${string}}`;
|
|
965
1086
|
|
|
966
1087
|
/**
|
|
967
1088
|
* Maximum number of lines that multiline texts in edit mode can grow to.
|
|
1089
|
+
*
|
|
1090
|
+
* Supports int and string type.
|
|
968
1091
|
*/
|
|
969
1092
|
textMaxLines?:
|
|
970
|
-
|
|
|
1093
|
+
| any
|
|
971
1094
|
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
972
1095
|
| `{${string}}`;
|
|
973
1096
|
}
|
|
@@ -1010,34 +1133,36 @@ declare namespace sap {
|
|
|
1010
1133
|
*
|
|
1011
1134
|
*
|
|
1012
1135
|
* @deprecated As of version 1.135. Use {@link sap.fe.macros.Field} instead
|
|
1013
|
-
* @experimental
|
|
1136
|
+
* @experimental As of version 1.130.
|
|
1014
1137
|
*/
|
|
1015
1138
|
class Field extends sap.ui.core.Control {
|
|
1016
1139
|
/**
|
|
1017
|
-
* Adds a message to the field.
|
|
1140
|
+
* Adds a validation message to the field.
|
|
1141
|
+
* This method creates a new message and associates it with the field's binding path,
|
|
1142
|
+
* making it visible in the field's value state and message popover.
|
|
1018
1143
|
*
|
|
1019
1144
|
*
|
|
1020
|
-
* @returns The
|
|
1145
|
+
* @returns The ID of the created message
|
|
1021
1146
|
*/
|
|
1022
1147
|
addMessage(
|
|
1023
1148
|
/**
|
|
1024
|
-
* The parameters
|
|
1149
|
+
* The message parameters
|
|
1025
1150
|
*/
|
|
1026
1151
|
parameters: {
|
|
1027
1152
|
/**
|
|
1028
|
-
*
|
|
1153
|
+
* Detailed message description
|
|
1029
1154
|
*/
|
|
1030
1155
|
description?: string;
|
|
1031
1156
|
/**
|
|
1032
|
-
* Message text
|
|
1157
|
+
* Message text to display
|
|
1033
1158
|
*/
|
|
1034
1159
|
message?: string;
|
|
1035
1160
|
/**
|
|
1036
|
-
*
|
|
1161
|
+
* Whether the message persists across refreshes
|
|
1037
1162
|
*/
|
|
1038
1163
|
persistent?: boolean;
|
|
1039
1164
|
/**
|
|
1040
|
-
* Type of the message
|
|
1165
|
+
* Type of the message, such as Error, Warning, Success, or Information
|
|
1041
1166
|
*/
|
|
1042
1167
|
type?: /* was: sap.ui.core.message.MessageType */ any;
|
|
1043
1168
|
}
|
|
@@ -1176,42 +1301,70 @@ declare namespace sap {
|
|
|
1176
1301
|
mParameters?: {}
|
|
1177
1302
|
): this;
|
|
1178
1303
|
/**
|
|
1179
|
-
* Gets the current
|
|
1304
|
+
* Gets the current enabled state of the field.
|
|
1305
|
+
* This method handles various control types and wrappers, returning true for controls
|
|
1306
|
+
* that are always enabled, such as Text, and checking the enabled property for interactive controls.
|
|
1180
1307
|
*
|
|
1181
1308
|
*
|
|
1182
|
-
* @returns Boolean value
|
|
1309
|
+
* @returns Boolean value indicating if the field is enabled, or true if control is not found (graceful
|
|
1310
|
+
* fallback)
|
|
1183
1311
|
*/
|
|
1184
1312
|
getEnabled(): boolean;
|
|
1185
1313
|
/**
|
|
1186
|
-
*
|
|
1314
|
+
* Gets the message manager instance from the UI5 core.
|
|
1315
|
+
* The message manager is responsible for handling all messages in the application.
|
|
1316
|
+
*
|
|
1317
|
+
*
|
|
1318
|
+
* @returns The Messaging instance
|
|
1319
|
+
*/
|
|
1320
|
+
getMessageManager(): /* was: sap.ui.core.Messaging */ any;
|
|
1321
|
+
/**
|
|
1322
|
+
* Gets the current value of the field.
|
|
1323
|
+
* This method handles various control types including CheckBox, Input, Text, MDC Field,
|
|
1324
|
+
* RatingIndicator, Link, Label, ObjectStatus, ObjectIdentifier, and building blocks.
|
|
1187
1325
|
*
|
|
1188
1326
|
*
|
|
1189
|
-
* @returns The current value of the field
|
|
1327
|
+
* @returns The current value of the field or undefined if control is not found
|
|
1190
1328
|
*/
|
|
1191
|
-
getValue(): boolean |
|
|
1329
|
+
getValue(): boolean | number | string | undefined;
|
|
1192
1330
|
/**
|
|
1193
|
-
* Removes a message from the field.
|
|
1331
|
+
* Removes a message from the field by its ID.
|
|
1332
|
+
* This method finds the message in the message model and removes it,
|
|
1333
|
+
* clearing it from the field's value state.
|
|
1194
1334
|
*/
|
|
1195
1335
|
removeMessage(
|
|
1196
1336
|
/**
|
|
1197
|
-
* The
|
|
1337
|
+
* The ID of the message to remove
|
|
1198
1338
|
*/
|
|
1199
1339
|
id: string
|
|
1200
1340
|
): void;
|
|
1201
1341
|
/**
|
|
1202
|
-
* Sets the current
|
|
1342
|
+
* Sets the current enabled state of the field.
|
|
1343
|
+
* This method handles various control types, setting the appropriate property,
|
|
1344
|
+
* such as enabled, active, titleActive, or edit mode based on the control type.
|
|
1203
1345
|
*
|
|
1204
1346
|
*
|
|
1205
|
-
* @returns The current field reference
|
|
1347
|
+
* @returns The current field reference for chaining
|
|
1206
1348
|
*/
|
|
1207
|
-
setEnabled(
|
|
1349
|
+
setEnabled(
|
|
1350
|
+
/**
|
|
1351
|
+
* The enabled state to set
|
|
1352
|
+
*/
|
|
1353
|
+
enabled: boolean
|
|
1354
|
+
): sap.ui.core.Control;
|
|
1208
1355
|
/**
|
|
1209
1356
|
* Sets the current value of the field.
|
|
1357
|
+
* This method handles various control types including CheckBox, Input, Text, and MDC Field.
|
|
1210
1358
|
*
|
|
1211
1359
|
*
|
|
1212
|
-
* @returns The current field reference
|
|
1360
|
+
* @returns The current field reference for chaining
|
|
1213
1361
|
*/
|
|
1214
|
-
setValue(
|
|
1362
|
+
setValue(
|
|
1363
|
+
/**
|
|
1364
|
+
* The value to set
|
|
1365
|
+
*/
|
|
1366
|
+
value: boolean | number | string
|
|
1367
|
+
): sap.ui.core.Control;
|
|
1215
1368
|
}
|
|
1216
1369
|
/**
|
|
1217
1370
|
* Additional format options for the field.
|
|
@@ -1240,10 +1393,9 @@ declare namespace sap {
|
|
|
1240
1393
|
/**
|
|
1241
1394
|
* Describes the settings that can be provided to the FilterBar constructor.
|
|
1242
1395
|
*
|
|
1243
|
-
* @
|
|
1396
|
+
* @deprecated As of version 1.147. Use {@link sap.fe.macros.FilterBar} instead
|
|
1244
1397
|
*/
|
|
1245
|
-
interface $FilterBarSettings
|
|
1246
|
-
extends sap.fe.macros.controls.$BuildingBlockWithTemplatingSettings {
|
|
1398
|
+
interface $FilterBarSettings extends sap.fe.macros.$FilterBarSettings {
|
|
1247
1399
|
/**
|
|
1248
1400
|
* Defines the path of the context used in the current page or block.
|
|
1249
1401
|
* This setting is defined by the framework.
|
|
@@ -1287,14 +1439,6 @@ declare namespace sap {
|
|
|
1287
1439
|
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
1288
1440
|
| `{${string}}`;
|
|
1289
1441
|
|
|
1290
|
-
/**
|
|
1291
|
-
* Parameter which sets the visibility of the FilterBar building block
|
|
1292
|
-
*/
|
|
1293
|
-
visible?:
|
|
1294
|
-
| boolean
|
|
1295
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
1296
|
-
| `{${string}}`;
|
|
1297
|
-
|
|
1298
1442
|
/**
|
|
1299
1443
|
* Aggregate filter fields of the FilterBar building block
|
|
1300
1444
|
*/
|
|
@@ -1423,17 +1567,20 @@ declare namespace sap {
|
|
|
1423
1567
|
/**
|
|
1424
1568
|
* Parameters of the FilterBar#afterClear event.
|
|
1425
1569
|
*/
|
|
1426
|
-
interface FilterBar$AfterClearEventParameters
|
|
1570
|
+
interface FilterBar$AfterClearEventParameters
|
|
1571
|
+
extends sap.fe.macros.FilterBar$AfterClearEventParameters {}
|
|
1427
1572
|
|
|
1428
1573
|
/**
|
|
1429
1574
|
* Parameters of the FilterBar#filterChanged event.
|
|
1430
1575
|
*/
|
|
1431
|
-
interface FilterBar$FilterChangedEventParameters
|
|
1576
|
+
interface FilterBar$FilterChangedEventParameters
|
|
1577
|
+
extends sap.fe.macros.FilterBar$FilterChangedEventParameters {}
|
|
1432
1578
|
|
|
1433
1579
|
/**
|
|
1434
1580
|
* Parameters of the FilterBar#search event.
|
|
1435
1581
|
*/
|
|
1436
|
-
interface FilterBar$SearchEventParameters
|
|
1582
|
+
interface FilterBar$SearchEventParameters
|
|
1583
|
+
extends sap.fe.macros.FilterBar$SearchEventParameters {}
|
|
1437
1584
|
|
|
1438
1585
|
/**
|
|
1439
1586
|
* Usage example:
|
|
@@ -1446,16 +1593,32 @@ declare namespace sap {
|
|
|
1446
1593
|
* })
|
|
1447
1594
|
* ```
|
|
1448
1595
|
*
|
|
1449
|
-
* This is
|
|
1450
|
-
*
|
|
1451
|
-
* The public method and property
|
|
1452
|
-
* usage.
|
|
1596
|
+
* This is an experimental API because the structure of the generated content has changed to be closer to
|
|
1597
|
+
* the FilterBar that you get from the templates.
|
|
1598
|
+
* The public method and property has not changed but the internal structure has changed so be careful on
|
|
1599
|
+
* your usage.
|
|
1453
1600
|
*
|
|
1454
1601
|
*
|
|
1455
|
-
* @
|
|
1602
|
+
* @deprecated As of version 1.147. Use {@link sap.fe.macros.FilterBar} instead
|
|
1456
1603
|
*/
|
|
1457
|
-
class FilterBar extends sap.fe.macros.
|
|
1458
|
-
|
|
1604
|
+
class FilterBar extends sap.fe.macros.FilterBar {
|
|
1605
|
+
/**
|
|
1606
|
+
* Adds a filterField to the FilterBar.
|
|
1607
|
+
* **Note:** When adding a custom filter field that uses a custom operator, ensure you use the correct configuration.
|
|
1608
|
+
* For more information, see {@link topic :5fb9f57fcf12401bbe39a635e9a32a4e Custom Filters with Custom Operators}.
|
|
1609
|
+
*
|
|
1610
|
+
*
|
|
1611
|
+
* @since 1.147.0
|
|
1612
|
+
* @experimental As of version 1.147.0.
|
|
1613
|
+
*
|
|
1614
|
+
* @returns Reference to this to allow method chaining
|
|
1615
|
+
*/
|
|
1616
|
+
addFilterField(
|
|
1617
|
+
/**
|
|
1618
|
+
* The filterField to add
|
|
1619
|
+
*/
|
|
1620
|
+
filterField: sap.fe.macros.filterBar.FilterField
|
|
1621
|
+
): this;
|
|
1459
1622
|
/**
|
|
1460
1623
|
*
|
|
1461
1624
|
* @returns Reference to sap.fe.macros.FilterBar
|
|
@@ -1618,8 +1781,8 @@ declare namespace sap {
|
|
|
1618
1781
|
fireAfterClear(
|
|
1619
1782
|
/**
|
|
1620
1783
|
* The parameters to pass along with the event.
|
|
1621
|
-
* See {@link .........types.EventHandler>
|
|
1622
|
-
*
|
|
1784
|
+
* See {@link .........types.EventHandler>} for the set
|
|
1785
|
+
* of parameters that are expected by the event handlers.
|
|
1623
1786
|
*/
|
|
1624
1787
|
mParameters?: {}
|
|
1625
1788
|
): this;
|
|
@@ -1652,8 +1815,8 @@ declare namespace sap {
|
|
|
1652
1815
|
fireSearch(
|
|
1653
1816
|
/**
|
|
1654
1817
|
* The parameters to pass along with the event.
|
|
1655
|
-
* See {@link .........types.EventHandler>
|
|
1656
|
-
*
|
|
1818
|
+
* See {@link .........types.EventHandler>} for the set
|
|
1819
|
+
* of parameters that are expected by the event handlers.
|
|
1657
1820
|
*/
|
|
1658
1821
|
mParameters?: {}
|
|
1659
1822
|
): this;
|
|
@@ -1713,6 +1876,20 @@ declare namespace sap {
|
|
|
1713
1876
|
* @returns A promise which resolves with a {@link sap.fe.navigation.SelectionVariant}
|
|
1714
1877
|
*/
|
|
1715
1878
|
getSelectionVariant(): Promise<sap.fe.navigation.SelectionVariant>;
|
|
1879
|
+
/**
|
|
1880
|
+
* Removes a filterField from the FilterBar.
|
|
1881
|
+
*
|
|
1882
|
+
* @since 1.147.0
|
|
1883
|
+
* @experimental As of version 1.147.0.
|
|
1884
|
+
*
|
|
1885
|
+
* @returns The removed filterField or null
|
|
1886
|
+
*/
|
|
1887
|
+
removeFilterField(
|
|
1888
|
+
/**
|
|
1889
|
+
* The filterField to remove, or its index or ID
|
|
1890
|
+
*/
|
|
1891
|
+
filterField: number | sap.fe.macros.filterBar.FilterField | string
|
|
1892
|
+
): null | sap.fe.macros.filterBar.FilterField;
|
|
1716
1893
|
/**
|
|
1717
1894
|
* Sets the new selected variant in the associated variant management.
|
|
1718
1895
|
*/
|
|
@@ -2052,7 +2229,7 @@ declare namespace sap {
|
|
|
2052
2229
|
* Describes the settings that can be provided to the MicroChart constructor.
|
|
2053
2230
|
*
|
|
2054
2231
|
* @deprecated As of version 1.130. Use {@link sap.fe.macros.MicroChart} instead
|
|
2055
|
-
* @experimental
|
|
2232
|
+
* @experimental As of version 1.124.
|
|
2056
2233
|
*/
|
|
2057
2234
|
interface $MicroChartSettings
|
|
2058
2235
|
extends sap.fe.macros.$MicroChartSettings {
|
|
@@ -2140,7 +2317,7 @@ declare namespace sap {
|
|
|
2140
2317
|
*
|
|
2141
2318
|
*
|
|
2142
2319
|
* @deprecated As of version 1.130. Use {@link sap.fe.macros.MicroChart} instead
|
|
2143
|
-
* @experimental
|
|
2320
|
+
* @experimental As of version 1.124.
|
|
2144
2321
|
*/
|
|
2145
2322
|
class MicroChart extends sap.fe.macros.MicroChart {
|
|
2146
2323
|
/**
|
|
@@ -2802,12 +2979,33 @@ declare namespace sap {
|
|
|
2802
2979
|
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
2803
2980
|
| `{${string}}`;
|
|
2804
2981
|
|
|
2982
|
+
/**
|
|
2983
|
+
* Determines the AI notice for the column.
|
|
2984
|
+
* The AI notice is used to display information related to AI features. This information is rendered as
|
|
2985
|
+
* an icon in the column header.
|
|
2986
|
+
*/
|
|
2987
|
+
aiNotice?:
|
|
2988
|
+
| string
|
|
2989
|
+
| sap.fe.macros.table.ColumnAINotice
|
|
2990
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
2991
|
+
|
|
2805
2992
|
/**
|
|
2806
2993
|
* Determines the export settings for the column.
|
|
2807
2994
|
*/
|
|
2808
2995
|
exportSettings?: sap.fe.macros.table.ColumnExportSettings;
|
|
2809
2996
|
}
|
|
2810
2997
|
|
|
2998
|
+
/**
|
|
2999
|
+
* Describes the settings that can be provided to the ColumnAINotice constructor.
|
|
3000
|
+
*/
|
|
3001
|
+
interface $ColumnAINoticeSettings
|
|
3002
|
+
extends sap.fe.macros.controls.$BuildingBlockObjectPropertySettings {
|
|
3003
|
+
/**
|
|
3004
|
+
* Determines the pop-up content of the AINotice to be displayed
|
|
3005
|
+
*/
|
|
3006
|
+
content?: sap.ui.core.Control;
|
|
3007
|
+
}
|
|
3008
|
+
|
|
2811
3009
|
/**
|
|
2812
3010
|
* Describes the settings that can be provided to the ColumnExportSettings constructor.
|
|
2813
3011
|
*/
|
|
@@ -2900,7 +3098,7 @@ declare namespace sap {
|
|
|
2900
3098
|
availability?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
2901
3099
|
|
|
2902
3100
|
/**
|
|
2903
|
-
* Determines if the column
|
|
3101
|
+
* Determines if the column is excluded from the export.
|
|
2904
3102
|
*/
|
|
2905
3103
|
disableExport?:
|
|
2906
3104
|
| boolean
|
|
@@ -2939,6 +3137,16 @@ declare namespace sap {
|
|
|
2939
3137
|
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
2940
3138
|
| `{${string}}`;
|
|
2941
3139
|
|
|
3140
|
+
/**
|
|
3141
|
+
* Determines the AI notice for the column.
|
|
3142
|
+
* The AI notice is used to display information related to AI features. This information is rendered as
|
|
3143
|
+
* an icon in the column header.
|
|
3144
|
+
*/
|
|
3145
|
+
aiNotice?:
|
|
3146
|
+
| string
|
|
3147
|
+
| sap.fe.macros.table.ColumnAINotice
|
|
3148
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
3149
|
+
|
|
2942
3150
|
/**
|
|
2943
3151
|
* Determines the export settings for the column.
|
|
2944
3152
|
*/
|
|
@@ -3181,6 +3389,19 @@ declare namespace sap {
|
|
|
3181
3389
|
| string
|
|
3182
3390
|
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
3183
3391
|
|
|
3392
|
+
/**
|
|
3393
|
+
* Indicates if the table should load data when initialized.
|
|
3394
|
+
* This property is used only if a filter bar is associated with the table and doesn't use the liveMode.
|
|
3395
|
+
* If set to `true`, the table loads data on initialization if the filter bar has no mandatory filters or
|
|
3396
|
+
* the mandatory filters are filled in.
|
|
3397
|
+
* If set to `false`, the table waits for the filter bar to be filled in before loading data.
|
|
3398
|
+
* The default value is `false`.
|
|
3399
|
+
*/
|
|
3400
|
+
initialLoad?:
|
|
3401
|
+
| boolean
|
|
3402
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
3403
|
+
| `{${string}}`;
|
|
3404
|
+
|
|
3184
3405
|
/**
|
|
3185
3406
|
* Defines whether to display the search action.
|
|
3186
3407
|
*/
|
|
@@ -3656,6 +3877,19 @@ declare namespace sap {
|
|
|
3656
3877
|
| string
|
|
3657
3878
|
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
3658
3879
|
|
|
3880
|
+
/**
|
|
3881
|
+
* Indicates if the table should load data when initialized.
|
|
3882
|
+
* This property is used only if a filter bar is associated with the table and doesn't use the liveMode.
|
|
3883
|
+
* If set to `true`, the table loads data on initialization if the filter bar has no mandatory filters or
|
|
3884
|
+
* the mandatory filters are filled in.
|
|
3885
|
+
* If set to `false`, the table waits for the filter bar to be filled in before loading data.
|
|
3886
|
+
* The default value is `false`.
|
|
3887
|
+
*/
|
|
3888
|
+
initialLoad?:
|
|
3889
|
+
| boolean
|
|
3890
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
3891
|
+
| `{${string}}`;
|
|
3892
|
+
|
|
3659
3893
|
/**
|
|
3660
3894
|
* Defines the extension point to control whether a source node can be copied to a specific parent node.
|
|
3661
3895
|
*/
|
|
@@ -4158,7 +4392,7 @@ declare namespace sap {
|
|
|
4158
4392
|
.BuildingBlockObjectProperty {}
|
|
4159
4393
|
/**
|
|
4160
4394
|
* Definition of a custom column to be used inside the table.
|
|
4161
|
-
* The template for the column
|
|
4395
|
+
* The template for the column must be provided as the default aggregation
|
|
4162
4396
|
*/
|
|
4163
4397
|
class Column
|
|
4164
4398
|
extends sap.fe.macros.controls.BuildingBlockObjectProperty
|
|
@@ -4166,6 +4400,11 @@ declare namespace sap {
|
|
|
4166
4400
|
{
|
|
4167
4401
|
__implements__sap_fe_macros_table_ITableColumn: boolean;
|
|
4168
4402
|
}
|
|
4403
|
+
/**
|
|
4404
|
+
* Definition of the AINotice applied to a column within the table.
|
|
4405
|
+
*/
|
|
4406
|
+
class ColumnAINotice extends sap.fe.macros.controls
|
|
4407
|
+
.BuildingBlockObjectProperty {}
|
|
4169
4408
|
/**
|
|
4170
4409
|
* Definition of the export settings applied to a column within the table.
|
|
4171
4410
|
*/
|
|
@@ -5240,6 +5479,61 @@ declare namespace sap {
|
|
|
5240
5479
|
TreeTable
|
|
5241
5480
|
>;
|
|
5242
5481
|
}
|
|
5482
|
+
/**
|
|
5483
|
+
* Describes the settings that can be provided to the AlwaysEditableField constructor.
|
|
5484
|
+
*/
|
|
5485
|
+
interface $AlwaysEditableFieldSettings
|
|
5486
|
+
extends sap.fe.macros.$MacroAPISettings {
|
|
5487
|
+
/**
|
|
5488
|
+
* Defines the path of the context used in the current page or block.
|
|
5489
|
+
* This setting is defined by the framework.
|
|
5490
|
+
*/
|
|
5491
|
+
contextPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
5492
|
+
|
|
5493
|
+
/**
|
|
5494
|
+
* This is used to optionally provide an external description that comes from a different model than the
|
|
5495
|
+
* oData model.
|
|
5496
|
+
* This must be used in conjunction with the value property.
|
|
5497
|
+
*/
|
|
5498
|
+
description?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
5499
|
+
|
|
5500
|
+
/**
|
|
5501
|
+
* Defines the relative path of the property in the metamodel, based on the current contextPath.
|
|
5502
|
+
* AlwaysEditableField only supports metadata paths with the Property type.
|
|
5503
|
+
*/
|
|
5504
|
+
metaPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
5505
|
+
|
|
5506
|
+
/**
|
|
5507
|
+
* This is used to optionally provide an external value that comes from a different model than the OData
|
|
5508
|
+
* model.
|
|
5509
|
+
* Typically used with JSON models for custom popup scenarios.
|
|
5510
|
+
*/
|
|
5511
|
+
value?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
5512
|
+
|
|
5513
|
+
/**
|
|
5514
|
+
* Prefix added to the generated ID of the value help used for the field.
|
|
5515
|
+
*/
|
|
5516
|
+
vhIdPrefix?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
5517
|
+
|
|
5518
|
+
/**
|
|
5519
|
+
* A set of options that can be configured.
|
|
5520
|
+
*/
|
|
5521
|
+
formatOptions?: sap.fe.macros.field.FieldFormatOptions;
|
|
5522
|
+
|
|
5523
|
+
/**
|
|
5524
|
+
* An event containing details is triggered when the value of the field is changed.
|
|
5525
|
+
*/
|
|
5526
|
+
change?: (oEvent: AlwaysEditableField$ChangeEvent) => void;
|
|
5527
|
+
|
|
5528
|
+
/**
|
|
5529
|
+
* An event containing details is triggered when the value of the field is live changed.
|
|
5530
|
+
*
|
|
5531
|
+
*
|
|
5532
|
+
* **Note:** Browsing autocomplete suggestions does not fire the event.
|
|
5533
|
+
*/
|
|
5534
|
+
liveChange?: (oEvent: sap.ui.base.Event) => void;
|
|
5535
|
+
}
|
|
5536
|
+
|
|
5243
5537
|
/**
|
|
5244
5538
|
* Describes the settings that can be provided to the Chart constructor.
|
|
5245
5539
|
*/
|
|
@@ -5501,6 +5795,84 @@ declare namespace sap {
|
|
|
5501
5795
|
liveChange?: (oEvent: sap.ui.base.Event) => void;
|
|
5502
5796
|
}
|
|
5503
5797
|
|
|
5798
|
+
/**
|
|
5799
|
+
* Describes the settings that can be provided to the FilterBar constructor.
|
|
5800
|
+
*/
|
|
5801
|
+
interface $FilterBarSettings extends sap.fe.macros.$MacroAPISettings {
|
|
5802
|
+
/**
|
|
5803
|
+
* Defines the path of the context used in the current page or block.
|
|
5804
|
+
* This setting is defined by the framework.
|
|
5805
|
+
*/
|
|
5806
|
+
contextPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
5807
|
+
|
|
5808
|
+
/**
|
|
5809
|
+
* If true, the search is triggered automatically when a filter value is changed.
|
|
5810
|
+
*/
|
|
5811
|
+
liveMode?:
|
|
5812
|
+
| boolean
|
|
5813
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
5814
|
+
| `{${string}}`;
|
|
5815
|
+
|
|
5816
|
+
/**
|
|
5817
|
+
* Defines the relative path of the property in the metamodel, based on the current contextPath.
|
|
5818
|
+
*/
|
|
5819
|
+
metaPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
5820
|
+
|
|
5821
|
+
/**
|
|
5822
|
+
* Comma separated list of navigation properties which are considered for filtering.
|
|
5823
|
+
*/
|
|
5824
|
+
navigationPropertiesForPersonalization?:
|
|
5825
|
+
| string[]
|
|
5826
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
5827
|
+
| `{${string}}`;
|
|
5828
|
+
|
|
5829
|
+
/**
|
|
5830
|
+
* Handles the visibility of the 'Clear' button on the FilterBar.
|
|
5831
|
+
*/
|
|
5832
|
+
showClearButton?:
|
|
5833
|
+
| boolean
|
|
5834
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
5835
|
+
| `{${string}}`;
|
|
5836
|
+
|
|
5837
|
+
/**
|
|
5838
|
+
* Displays possible errors during the search in a message box
|
|
5839
|
+
*/
|
|
5840
|
+
showMessages?:
|
|
5841
|
+
| boolean
|
|
5842
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
5843
|
+
| `{${string}}`;
|
|
5844
|
+
|
|
5845
|
+
/**
|
|
5846
|
+
* Aggregate filter fields of the FilterBar building block
|
|
5847
|
+
*/
|
|
5848
|
+
filterFields?:
|
|
5849
|
+
| Array<
|
|
5850
|
+
| sap.fe.macros.filterBar.FilterFieldOverride
|
|
5851
|
+
| sap.fe.macros.filterBar.FilterField
|
|
5852
|
+
>
|
|
5853
|
+
| sap.fe.macros.filterBar.FilterFieldOverride
|
|
5854
|
+
| sap.fe.macros.filterBar.FilterField
|
|
5855
|
+
| sap.ui.base.ManagedObject.AggregationBindingInfo
|
|
5856
|
+
| `{${string}}`;
|
|
5857
|
+
|
|
5858
|
+
/**
|
|
5859
|
+
* This event is fired when the 'Clear' button is pressed. This is only possible when the 'Clear' button
|
|
5860
|
+
* is enabled.
|
|
5861
|
+
*/
|
|
5862
|
+
afterClear?: (oEvent: sap.ui.base.Event) => void;
|
|
5863
|
+
|
|
5864
|
+
/**
|
|
5865
|
+
* This event is fired after either a filter value or the visibility of a filter item has been changed.
|
|
5866
|
+
* The event contains conditions that are used as filters.
|
|
5867
|
+
*/
|
|
5868
|
+
filterChanged?: (oEvent: sap.ui.base.Event) => void;
|
|
5869
|
+
|
|
5870
|
+
/**
|
|
5871
|
+
* This event is fired when the 'Go' button is pressed or after a condition change.
|
|
5872
|
+
*/
|
|
5873
|
+
search?: (oEvent: sap.ui.base.Event) => void;
|
|
5874
|
+
}
|
|
5875
|
+
|
|
5504
5876
|
/**
|
|
5505
5877
|
* Describes the settings that can be provided to the FormElement constructor.
|
|
5506
5878
|
*/
|
|
@@ -6139,6 +6511,19 @@ declare namespace sap {
|
|
|
6139
6511
|
*/
|
|
6140
6512
|
ignoredFields?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
6141
6513
|
|
|
6514
|
+
/**
|
|
6515
|
+
* Indicates if the table should load data when initialized.
|
|
6516
|
+
* This property is used only if a filter bar is associated with the table and doesn't use the liveMode.
|
|
6517
|
+
* If set to `true`, the table loads data on initialization if the filter bar has no mandatory filters or
|
|
6518
|
+
* the mandatory filters are filled in.
|
|
6519
|
+
* If set to `false`, the table waits for the filter bar to be filled in before loading data.
|
|
6520
|
+
* The default value is `false`.
|
|
6521
|
+
*/
|
|
6522
|
+
initialLoad?:
|
|
6523
|
+
| boolean
|
|
6524
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
6525
|
+
| `{${string}}`;
|
|
6526
|
+
|
|
6142
6527
|
/**
|
|
6143
6528
|
* Defines whether to display the search action.
|
|
6144
6529
|
*/
|
|
@@ -6541,11 +6926,24 @@ declare namespace sap {
|
|
|
6541
6926
|
ignoredFields?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
6542
6927
|
|
|
6543
6928
|
/**
|
|
6544
|
-
*
|
|
6929
|
+
* Indicates if the table should load data when initialized.
|
|
6930
|
+
* This property is used only if a filter bar is associated with the table and doesn't use the liveMode.
|
|
6931
|
+
* If set to `true`, the table loads data on initialization if the filter bar has no mandatory filters or
|
|
6932
|
+
* the mandatory filters are filled in.
|
|
6933
|
+
* If set to `false`, the table waits for the filter bar to be filled in before loading data.
|
|
6934
|
+
* The default value is `false`.
|
|
6545
6935
|
*/
|
|
6546
|
-
|
|
6547
|
-
|
|
|
6548
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
6936
|
+
initialLoad?:
|
|
6937
|
+
| boolean
|
|
6938
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
6939
|
+
| `{${string}}`;
|
|
6940
|
+
|
|
6941
|
+
/**
|
|
6942
|
+
* Defines the extension point to control whether a source node can be copied to a specific parent node.
|
|
6943
|
+
*/
|
|
6944
|
+
isCopyToPositionAllowed?:
|
|
6945
|
+
| string
|
|
6946
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
6549
6947
|
|
|
6550
6948
|
/**
|
|
6551
6949
|
* Defines the extension point to control whether a source node can be dropped on a specific parent node.
|
|
@@ -6846,92 +7244,6 @@ declare namespace sap {
|
|
|
6846
7244
|
interface $FlexibleColumnLayoutActionsSettings
|
|
6847
7245
|
extends sap.ui.core.$ControlSettings {}
|
|
6848
7246
|
|
|
6849
|
-
/**
|
|
6850
|
-
* Describes the settings that can be provided to the FilterBar constructor.
|
|
6851
|
-
*/
|
|
6852
|
-
interface $FilterBarSettings extends sap.fe.macros.$MacroAPISettings {
|
|
6853
|
-
/**
|
|
6854
|
-
* Defines the path of the context used in the current page or block.
|
|
6855
|
-
* This setting is defined by the framework.
|
|
6856
|
-
*/
|
|
6857
|
-
contextPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
6858
|
-
|
|
6859
|
-
/**
|
|
6860
|
-
* If true, the search is triggered automatically when a filter value is changed.
|
|
6861
|
-
*/
|
|
6862
|
-
liveMode?:
|
|
6863
|
-
| boolean
|
|
6864
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
6865
|
-
| `{${string}}`;
|
|
6866
|
-
|
|
6867
|
-
/**
|
|
6868
|
-
* Defines the relative path of the property in the metamodel, based on the current contextPath.
|
|
6869
|
-
*/
|
|
6870
|
-
metaPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
6871
|
-
|
|
6872
|
-
/**
|
|
6873
|
-
* Comma separated list of navigation properties which are considered for filtering.
|
|
6874
|
-
*/
|
|
6875
|
-
navigationPropertiesForPersonalization?:
|
|
6876
|
-
| string[]
|
|
6877
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
6878
|
-
| `{${string}}`;
|
|
6879
|
-
|
|
6880
|
-
/**
|
|
6881
|
-
* Handles the visibility of the 'Clear' button on the FilterBar.
|
|
6882
|
-
*/
|
|
6883
|
-
showClearButton?:
|
|
6884
|
-
| boolean
|
|
6885
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
6886
|
-
| `{${string}}`;
|
|
6887
|
-
|
|
6888
|
-
/**
|
|
6889
|
-
* Displays possible errors during the search in a message box
|
|
6890
|
-
*/
|
|
6891
|
-
showMessages?:
|
|
6892
|
-
| boolean
|
|
6893
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
6894
|
-
| `{${string}}`;
|
|
6895
|
-
|
|
6896
|
-
/**
|
|
6897
|
-
* Parameter which sets the visibility of the FilterBar building block
|
|
6898
|
-
*/
|
|
6899
|
-
visible?:
|
|
6900
|
-
| boolean
|
|
6901
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
6902
|
-
| `{${string}}`;
|
|
6903
|
-
|
|
6904
|
-
/**
|
|
6905
|
-
* Aggregate filter fields of the FilterBar building block
|
|
6906
|
-
*/
|
|
6907
|
-
filterFields?:
|
|
6908
|
-
| Array<
|
|
6909
|
-
| sap.fe.macros.filterBar.FilterFieldOverride
|
|
6910
|
-
| sap.fe.macros.filterBar.FilterField
|
|
6911
|
-
>
|
|
6912
|
-
| sap.fe.macros.filterBar.FilterFieldOverride
|
|
6913
|
-
| sap.fe.macros.filterBar.FilterField
|
|
6914
|
-
| sap.ui.base.ManagedObject.AggregationBindingInfo
|
|
6915
|
-
| `{${string}}`;
|
|
6916
|
-
|
|
6917
|
-
/**
|
|
6918
|
-
* This event is fired when the 'Clear' button is pressed. This is only possible when the 'Clear' button
|
|
6919
|
-
* is enabled.
|
|
6920
|
-
*/
|
|
6921
|
-
afterClear?: (oEvent: sap.ui.base.Event) => void;
|
|
6922
|
-
|
|
6923
|
-
/**
|
|
6924
|
-
* This event is fired after either a filter value or the visibility of a filter item has been changed.
|
|
6925
|
-
* The event contains conditions that are used as filters.
|
|
6926
|
-
*/
|
|
6927
|
-
filterChanged?: (oEvent: sap.ui.base.Event) => void;
|
|
6928
|
-
|
|
6929
|
-
/**
|
|
6930
|
-
* This event is fired when the 'Go' button is pressed or after a condition change.
|
|
6931
|
-
*/
|
|
6932
|
-
search?: (oEvent: sap.ui.base.Event) => void;
|
|
6933
|
-
}
|
|
6934
|
-
|
|
6935
7247
|
/**
|
|
6936
7248
|
* Describes the settings that can be provided to the Form constructor.
|
|
6937
7249
|
*/
|
|
@@ -6990,6 +7302,20 @@ declare namespace sap {
|
|
|
6990
7302
|
| `{${string}}`;
|
|
6991
7303
|
}
|
|
6992
7304
|
|
|
7305
|
+
/**
|
|
7306
|
+
* Parameters of the AlwaysEditableField#change event.
|
|
7307
|
+
*/
|
|
7308
|
+
interface AlwaysEditableField$ChangeEventParameters {
|
|
7309
|
+
value?: boolean | number | string | undefined;
|
|
7310
|
+
|
|
7311
|
+
isValid?: boolean;
|
|
7312
|
+
}
|
|
7313
|
+
|
|
7314
|
+
/**
|
|
7315
|
+
* Parameters of the AlwaysEditableField#liveChange event.
|
|
7316
|
+
*/
|
|
7317
|
+
interface AlwaysEditableField$LiveChangeEventParameters {}
|
|
7318
|
+
|
|
6993
7319
|
/**
|
|
6994
7320
|
* Parameters of the Chart#selectionChange event.
|
|
6995
7321
|
*/
|
|
@@ -7046,6 +7372,21 @@ declare namespace sap {
|
|
|
7046
7372
|
*/
|
|
7047
7373
|
interface Field$LiveChangeEventParameters {}
|
|
7048
7374
|
|
|
7375
|
+
/**
|
|
7376
|
+
* Parameters of the FilterBar#afterClear event.
|
|
7377
|
+
*/
|
|
7378
|
+
interface FilterBar$AfterClearEventParameters {}
|
|
7379
|
+
|
|
7380
|
+
/**
|
|
7381
|
+
* Parameters of the FilterBar#filterChanged event.
|
|
7382
|
+
*/
|
|
7383
|
+
interface FilterBar$FilterChangedEventParameters {}
|
|
7384
|
+
|
|
7385
|
+
/**
|
|
7386
|
+
* Parameters of the FilterBar#search event.
|
|
7387
|
+
*/
|
|
7388
|
+
interface FilterBar$SearchEventParameters {}
|
|
7389
|
+
|
|
7049
7390
|
/**
|
|
7050
7391
|
* Parameters of the KPITag#press event.
|
|
7051
7392
|
*/
|
|
@@ -7106,21 +7447,6 @@ declare namespace sap {
|
|
|
7106
7447
|
*/
|
|
7107
7448
|
interface TreeTable$SelectionChangeEventParameters {}
|
|
7108
7449
|
|
|
7109
|
-
/**
|
|
7110
|
-
* Parameters of the FilterBar#afterClear event.
|
|
7111
|
-
*/
|
|
7112
|
-
interface FilterBar$AfterClearEventParameters {}
|
|
7113
|
-
|
|
7114
|
-
/**
|
|
7115
|
-
* Parameters of the FilterBar#filterChanged event.
|
|
7116
|
-
*/
|
|
7117
|
-
interface FilterBar$FilterChangedEventParameters {}
|
|
7118
|
-
|
|
7119
|
-
/**
|
|
7120
|
-
* Parameters of the FilterBar#search event.
|
|
7121
|
-
*/
|
|
7122
|
-
interface FilterBar$SearchEventParameters {}
|
|
7123
|
-
|
|
7124
7450
|
/**
|
|
7125
7451
|
* Building block that displays a AI notice.
|
|
7126
7452
|
* It's used to display information related to AI features. This information is rendered either
|
|
@@ -7131,32 +7457,63 @@ declare namespace sap {
|
|
|
7131
7457
|
*/
|
|
7132
7458
|
class AINotice extends /* was: sap.fe.controls.AINotice */ Object {}
|
|
7133
7459
|
/**
|
|
7134
|
-
* Building block
|
|
7135
|
-
* {@link demo:sap/fe/core/fpmExplorer/index.html#/buildingBlocks/chart/chartDefault Overview of Building Blocks}
|
|
7460
|
+
* Building block for creating an always-editable field based on metadata provided by OData V4.
|
|
7136
7461
|
*
|
|
7137
7462
|
*
|
|
7138
|
-
*
|
|
7463
|
+
* This building block is designed for use with JSON model bindings in custom dialogs and popups,
|
|
7464
|
+
* where the field must always be editable regardless of OData metadata or draft status.
|
|
7139
7465
|
*
|
|
7466
|
+
*
|
|
7467
|
+
* When creating an AlwaysEditableField building block, you must provide an ID.
|
|
7140
7468
|
* Usage example:
|
|
7141
7469
|
*
|
|
7142
7470
|
* ```javascript
|
|
7143
7471
|
*
|
|
7144
|
-
* <macros:
|
|
7472
|
+
* <macros:AlwaysEditableField
|
|
7473
|
+
* id="MyAlwaysEditableField"
|
|
7474
|
+
* metaPath="MyProperty"
|
|
7475
|
+
* value="{myJSONModel>/myValue}"
|
|
7476
|
+
* description="{myJSONModel>/myDescription}" />
|
|
7145
7477
|
* ```
|
|
7146
7478
|
*/
|
|
7147
|
-
class
|
|
7148
|
-
extends sap.fe.macros.MacroAPI
|
|
7149
|
-
implements
|
|
7150
|
-
/* was: sap.fe.core.controllerextensions.viewState.IViewStateContributor */ Object
|
|
7151
|
-
{
|
|
7152
|
-
__implements__sap_fe_core_controllerextensions_viewState_IViewStateContributor: boolean;
|
|
7153
|
-
|
|
7479
|
+
class AlwaysEditableField extends sap.fe.macros.MacroAPI {
|
|
7154
7480
|
/**
|
|
7481
|
+
* Adds a validation message to the field.
|
|
7482
|
+
* This method creates a new message and associates it with the field's binding path,
|
|
7483
|
+
* making it visible in the field's value state and message popover.
|
|
7155
7484
|
*
|
|
7156
|
-
*
|
|
7157
|
-
*
|
|
7485
|
+
*
|
|
7486
|
+
* @returns The ID of the created message
|
|
7158
7487
|
*/
|
|
7159
|
-
|
|
7488
|
+
addMessage(
|
|
7489
|
+
/**
|
|
7490
|
+
* The message parameters
|
|
7491
|
+
*/
|
|
7492
|
+
parameters: {
|
|
7493
|
+
/**
|
|
7494
|
+
* Detailed message description
|
|
7495
|
+
*/
|
|
7496
|
+
description?: string;
|
|
7497
|
+
/**
|
|
7498
|
+
* Message text to display
|
|
7499
|
+
*/
|
|
7500
|
+
message?: string;
|
|
7501
|
+
/**
|
|
7502
|
+
* Whether the message persists across refreshes
|
|
7503
|
+
*/
|
|
7504
|
+
persistent?: boolean;
|
|
7505
|
+
/**
|
|
7506
|
+
* Type of the message, such as Error, Warning, Success, or Information
|
|
7507
|
+
*/
|
|
7508
|
+
type?: /* was: sap.ui.core.message.MessageType */ any;
|
|
7509
|
+
}
|
|
7510
|
+
): string;
|
|
7511
|
+
/**
|
|
7512
|
+
*
|
|
7513
|
+
* @returns Reference to sap.fe.macros.AlwaysEditableField
|
|
7514
|
+
* to allow method chaining
|
|
7515
|
+
*/
|
|
7516
|
+
attachChange(
|
|
7160
7517
|
/**
|
|
7161
7518
|
* An application-specific payload object that will be passed to the event handler along with the event
|
|
7162
7519
|
* object when firing the event
|
|
@@ -7165,7 +7522,7 @@ declare namespace sap {
|
|
|
7165
7522
|
/**
|
|
7166
7523
|
* The function to be called when the event occurs
|
|
7167
7524
|
*/
|
|
7168
|
-
fnFunction: (p1:
|
|
7525
|
+
fnFunction: (p1: AlwaysEditableField$ChangeEvent) => void,
|
|
7169
7526
|
/**
|
|
7170
7527
|
* The context object to call the event handler with. Defaults to this `this` control
|
|
7171
7528
|
*/
|
|
@@ -7173,14 +7530,14 @@ declare namespace sap {
|
|
|
7173
7530
|
): this;
|
|
7174
7531
|
/**
|
|
7175
7532
|
*
|
|
7176
|
-
* @returns Reference to sap.fe.macros.
|
|
7177
|
-
* method chaining
|
|
7533
|
+
* @returns Reference to sap.fe.macros.AlwaysEditableField
|
|
7534
|
+
* to allow method chaining
|
|
7178
7535
|
*/
|
|
7179
|
-
|
|
7536
|
+
attachChange(
|
|
7180
7537
|
/**
|
|
7181
7538
|
* The function to be called when the event occurs
|
|
7182
7539
|
*/
|
|
7183
|
-
fnFunction: (p1:
|
|
7540
|
+
fnFunction: (p1: AlwaysEditableField$ChangeEvent) => void,
|
|
7184
7541
|
/**
|
|
7185
7542
|
* The context object to call the event handler with. Defaults to this `this` control
|
|
7186
7543
|
*/
|
|
@@ -7188,59 +7545,280 @@ declare namespace sap {
|
|
|
7188
7545
|
): this;
|
|
7189
7546
|
/**
|
|
7190
7547
|
*
|
|
7191
|
-
* @returns Reference to sap.fe.macros.
|
|
7192
|
-
* method chaining
|
|
7548
|
+
* @returns Reference to sap.fe.macros.AlwaysEditableField
|
|
7549
|
+
* to allow method chaining
|
|
7193
7550
|
*/
|
|
7194
|
-
|
|
7551
|
+
attachLiveChange(
|
|
7552
|
+
/**
|
|
7553
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
7554
|
+
* object when firing the event
|
|
7555
|
+
*/
|
|
7556
|
+
oData: object,
|
|
7195
7557
|
/**
|
|
7196
7558
|
* The function to be called when the event occurs
|
|
7197
7559
|
*/
|
|
7198
|
-
fnFunction: (p1:
|
|
7560
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
7199
7561
|
/**
|
|
7200
7562
|
* The context object to call the event handler with. Defaults to this `this` control
|
|
7201
7563
|
*/
|
|
7202
7564
|
oListener?: object
|
|
7203
7565
|
): this;
|
|
7204
7566
|
/**
|
|
7205
|
-
* Fires event selectionChange
|
|
7206
|
-
* to attached listeners.
|
|
7207
|
-
*
|
|
7208
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
7209
7567
|
*
|
|
7210
|
-
* @returns Reference to sap.fe.macros.
|
|
7211
|
-
* method chaining
|
|
7568
|
+
* @returns Reference to sap.fe.macros.AlwaysEditableField
|
|
7569
|
+
* to allow method chaining
|
|
7212
7570
|
*/
|
|
7213
|
-
|
|
7571
|
+
attachLiveChange(
|
|
7214
7572
|
/**
|
|
7215
|
-
* The
|
|
7216
|
-
* See {@link types.EventHandler>} for the
|
|
7217
|
-
* set of parameters that are expected by the event handlers.
|
|
7573
|
+
* The function to be called when the event occurs
|
|
7218
7574
|
*/
|
|
7219
|
-
|
|
7575
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
7576
|
+
/**
|
|
7577
|
+
* The context object to call the event handler with. Defaults to this `this` control
|
|
7578
|
+
*/
|
|
7579
|
+
oListener?: object
|
|
7220
7580
|
): this;
|
|
7221
7581
|
/**
|
|
7222
|
-
* Gets current value of property contextPath.
|
|
7223
|
-
*
|
|
7224
7582
|
*
|
|
7225
|
-
* @returns
|
|
7583
|
+
* @returns Reference to sap.fe.macros.AlwaysEditableField
|
|
7584
|
+
* to allow method chaining
|
|
7226
7585
|
*/
|
|
7227
|
-
|
|
7586
|
+
detachChange(
|
|
7587
|
+
/**
|
|
7588
|
+
* The function to be called when the event occurs
|
|
7589
|
+
*/
|
|
7590
|
+
fnFunction: (p1: AlwaysEditableField$ChangeEvent) => void,
|
|
7591
|
+
/**
|
|
7592
|
+
* The context object to call the event handler with. Defaults to this `this` control
|
|
7593
|
+
*/
|
|
7594
|
+
oListener?: object
|
|
7595
|
+
): this;
|
|
7228
7596
|
/**
|
|
7229
|
-
* Gets the key of the current variant in the associated variant management.
|
|
7230
|
-
*
|
|
7231
7597
|
*
|
|
7232
|
-
* @returns
|
|
7598
|
+
* @returns Reference to sap.fe.macros.AlwaysEditableField
|
|
7599
|
+
* to allow method chaining
|
|
7233
7600
|
*/
|
|
7234
|
-
|
|
7601
|
+
detachLiveChange(
|
|
7602
|
+
/**
|
|
7603
|
+
* The function to be called when the event occurs
|
|
7604
|
+
*/
|
|
7605
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
7606
|
+
/**
|
|
7607
|
+
* The context object to call the event handler with. Defaults to this `this` control
|
|
7608
|
+
*/
|
|
7609
|
+
oListener?: object
|
|
7610
|
+
): this;
|
|
7235
7611
|
/**
|
|
7236
|
-
*
|
|
7612
|
+
* Fires event change
|
|
7613
|
+
* to attached listeners.
|
|
7237
7614
|
*
|
|
7615
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
7238
7616
|
*
|
|
7239
|
-
* @returns
|
|
7617
|
+
* @returns Reference to sap.fe.macros.AlwaysEditableField
|
|
7618
|
+
* to allow method chaining
|
|
7240
7619
|
*/
|
|
7241
|
-
|
|
7620
|
+
fireChange(
|
|
7621
|
+
/**
|
|
7622
|
+
* The parameters to pass along with the event.
|
|
7623
|
+
* See {@link types.EventHandler> }
|
|
7624
|
+
* for the set of parameters that are expected by the event handlers.
|
|
7625
|
+
*/
|
|
7626
|
+
mParameters?: sap.fe.macros.AlwaysEditableField$ChangeEventParameters
|
|
7627
|
+
): this;
|
|
7242
7628
|
/**
|
|
7243
|
-
*
|
|
7629
|
+
* Fires event liveChange
|
|
7630
|
+
* to attached listeners.
|
|
7631
|
+
*
|
|
7632
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
7633
|
+
*
|
|
7634
|
+
* @returns Reference to sap.fe.macros.AlwaysEditableField
|
|
7635
|
+
* to allow method chaining
|
|
7636
|
+
*/
|
|
7637
|
+
fireLiveChange(
|
|
7638
|
+
/**
|
|
7639
|
+
* The parameters to pass along with the event.
|
|
7640
|
+
* See {@link types.EventHandler>} for the set of parameters
|
|
7641
|
+
* that are expected by the event handlers.
|
|
7642
|
+
*/
|
|
7643
|
+
mParameters?: {}
|
|
7644
|
+
): this;
|
|
7645
|
+
/**
|
|
7646
|
+
* Gets the current enabled state of the field.
|
|
7647
|
+
* This method handles various control types and wrappers, returning true for controls
|
|
7648
|
+
* that are always enabled, such as Text, and checking the enabled property for interactive controls.
|
|
7649
|
+
*
|
|
7650
|
+
*
|
|
7651
|
+
* @returns Boolean value indicating if the field is enabled, or true if control is not found (graceful
|
|
7652
|
+
* fallback)
|
|
7653
|
+
*/
|
|
7654
|
+
getEnabled(): boolean;
|
|
7655
|
+
/**
|
|
7656
|
+
* Gets the message manager instance from the UI5 core.
|
|
7657
|
+
* The message manager is responsible for handling all messages in the application.
|
|
7658
|
+
*
|
|
7659
|
+
*
|
|
7660
|
+
* @returns The Messaging instance
|
|
7661
|
+
*/
|
|
7662
|
+
getMessageManager(): /* was: sap.ui.core.Messaging */ any;
|
|
7663
|
+
/**
|
|
7664
|
+
* Gets the current value of the field.
|
|
7665
|
+
* This method handles various control types including CheckBox, Input, Text, MDC Field,
|
|
7666
|
+
* RatingIndicator, Link, Label, ObjectStatus, ObjectIdentifier, and building blocks.
|
|
7667
|
+
*
|
|
7668
|
+
*
|
|
7669
|
+
* @returns The current value of the field or undefined if control is not found
|
|
7670
|
+
*/
|
|
7671
|
+
getValue(): boolean | number | string | undefined;
|
|
7672
|
+
/**
|
|
7673
|
+
* Removes a message from the field by its ID.
|
|
7674
|
+
* This method finds the message in the message model and removes it,
|
|
7675
|
+
* clearing it from the field's value state.
|
|
7676
|
+
*/
|
|
7677
|
+
removeMessage(
|
|
7678
|
+
/**
|
|
7679
|
+
* The ID of the message to remove
|
|
7680
|
+
*/
|
|
7681
|
+
id: string
|
|
7682
|
+
): void;
|
|
7683
|
+
/**
|
|
7684
|
+
* Sets the current enabled state of the field.
|
|
7685
|
+
* This method handles various control types, setting the appropriate property,
|
|
7686
|
+
* such as enabled, active, titleActive, or edit mode based on the control type.
|
|
7687
|
+
*
|
|
7688
|
+
*
|
|
7689
|
+
* @returns The current field reference for chaining
|
|
7690
|
+
*/
|
|
7691
|
+
setEnabled(
|
|
7692
|
+
/**
|
|
7693
|
+
* The enabled state to set
|
|
7694
|
+
*/
|
|
7695
|
+
enabled: boolean
|
|
7696
|
+
): sap.ui.core.Control;
|
|
7697
|
+
/**
|
|
7698
|
+
* Sets the current value of the field.
|
|
7699
|
+
* This method handles various control types including CheckBox, Input, Text, and MDC Field.
|
|
7700
|
+
*
|
|
7701
|
+
*
|
|
7702
|
+
* @returns The current field reference for chaining
|
|
7703
|
+
*/
|
|
7704
|
+
setValue(
|
|
7705
|
+
/**
|
|
7706
|
+
* The value to set
|
|
7707
|
+
*/
|
|
7708
|
+
value: boolean | number | string
|
|
7709
|
+
): sap.ui.core.Control;
|
|
7710
|
+
}
|
|
7711
|
+
/**
|
|
7712
|
+
* Building block used to create a chart based on the metadata provided by OData V4.
|
|
7713
|
+
* {@link demo:sap/fe/core/fpmExplorer/index.html#/buildingBlocks/chart/chartDefault Overview of Building Blocks}
|
|
7714
|
+
*
|
|
7715
|
+
*
|
|
7716
|
+
* Usually, a contextPath and metaPath is expected.
|
|
7717
|
+
*
|
|
7718
|
+
* Usage example:
|
|
7719
|
+
*
|
|
7720
|
+
* ```javascript
|
|
7721
|
+
*
|
|
7722
|
+
* <macros:Chart id="MyChart" contextPath="/RootEntity" metaPath="@com.sap.vocabularies.UI.v1.Chart" />
|
|
7723
|
+
* ```
|
|
7724
|
+
*/
|
|
7725
|
+
class Chart
|
|
7726
|
+
extends sap.fe.macros.MacroAPI
|
|
7727
|
+
implements
|
|
7728
|
+
/* was: sap.fe.core.controllerextensions.viewState.IViewStateContributor */ Object
|
|
7729
|
+
{
|
|
7730
|
+
__implements__sap_fe_core_controllerextensions_viewState_IViewStateContributor: boolean;
|
|
7731
|
+
|
|
7732
|
+
/**
|
|
7733
|
+
*
|
|
7734
|
+
* @returns Reference to sap.fe.macros.Chart to allow
|
|
7735
|
+
* method chaining
|
|
7736
|
+
*/
|
|
7737
|
+
attachSelectionChange(
|
|
7738
|
+
/**
|
|
7739
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
7740
|
+
* object when firing the event
|
|
7741
|
+
*/
|
|
7742
|
+
oData: object,
|
|
7743
|
+
/**
|
|
7744
|
+
* The function to be called when the event occurs
|
|
7745
|
+
*/
|
|
7746
|
+
fnFunction: (p1: Chart$SelectionChangeEvent) => void,
|
|
7747
|
+
/**
|
|
7748
|
+
* The context object to call the event handler with. Defaults to this `this` control
|
|
7749
|
+
*/
|
|
7750
|
+
oListener?: object
|
|
7751
|
+
): this;
|
|
7752
|
+
/**
|
|
7753
|
+
*
|
|
7754
|
+
* @returns Reference to sap.fe.macros.Chart to allow
|
|
7755
|
+
* method chaining
|
|
7756
|
+
*/
|
|
7757
|
+
attachSelectionChange(
|
|
7758
|
+
/**
|
|
7759
|
+
* The function to be called when the event occurs
|
|
7760
|
+
*/
|
|
7761
|
+
fnFunction: (p1: Chart$SelectionChangeEvent) => void,
|
|
7762
|
+
/**
|
|
7763
|
+
* The context object to call the event handler with. Defaults to this `this` control
|
|
7764
|
+
*/
|
|
7765
|
+
oListener?: object
|
|
7766
|
+
): this;
|
|
7767
|
+
/**
|
|
7768
|
+
*
|
|
7769
|
+
* @returns Reference to sap.fe.macros.Chart to allow
|
|
7770
|
+
* method chaining
|
|
7771
|
+
*/
|
|
7772
|
+
detachSelectionChange(
|
|
7773
|
+
/**
|
|
7774
|
+
* The function to be called when the event occurs
|
|
7775
|
+
*/
|
|
7776
|
+
fnFunction: (p1: Chart$SelectionChangeEvent) => void,
|
|
7777
|
+
/**
|
|
7778
|
+
* The context object to call the event handler with. Defaults to this `this` control
|
|
7779
|
+
*/
|
|
7780
|
+
oListener?: object
|
|
7781
|
+
): this;
|
|
7782
|
+
/**
|
|
7783
|
+
* Fires event selectionChange
|
|
7784
|
+
* to attached listeners.
|
|
7785
|
+
*
|
|
7786
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
7787
|
+
*
|
|
7788
|
+
* @returns Reference to sap.fe.macros.Chart to allow
|
|
7789
|
+
* method chaining
|
|
7790
|
+
*/
|
|
7791
|
+
fireSelectionChange(
|
|
7792
|
+
/**
|
|
7793
|
+
* The parameters to pass along with the event.
|
|
7794
|
+
* See {@link types.EventHandler>} for the
|
|
7795
|
+
* set of parameters that are expected by the event handlers.
|
|
7796
|
+
*/
|
|
7797
|
+
mParameters?: sap.fe.macros.Chart$SelectionChangeEventParameters
|
|
7798
|
+
): this;
|
|
7799
|
+
/**
|
|
7800
|
+
* Gets current value of property contextPath.
|
|
7801
|
+
*
|
|
7802
|
+
*
|
|
7803
|
+
* @returns Value of property `contextPath`
|
|
7804
|
+
*/
|
|
7805
|
+
getContextPath(): string;
|
|
7806
|
+
/**
|
|
7807
|
+
* Gets the key of the current variant in the associated variant management.
|
|
7808
|
+
*
|
|
7809
|
+
*
|
|
7810
|
+
* @returns Variant key of {@link sap.ui.fl.variants.VariantManagement} applied to the chart
|
|
7811
|
+
*/
|
|
7812
|
+
getCurrentVariantKey(): null | string;
|
|
7813
|
+
/**
|
|
7814
|
+
* Gets current value of property header.
|
|
7815
|
+
*
|
|
7816
|
+
*
|
|
7817
|
+
* @returns Value of property `header`
|
|
7818
|
+
*/
|
|
7819
|
+
getHeader(): string;
|
|
7820
|
+
/**
|
|
7821
|
+
* Gets current value of property headerVisible.
|
|
7244
7822
|
*
|
|
7245
7823
|
*
|
|
7246
7824
|
* @returns Value of property `headerVisible`
|
|
@@ -7710,30 +8288,32 @@ declare namespace sap {
|
|
|
7710
8288
|
*/
|
|
7711
8289
|
class Field extends sap.fe.macros.MacroAPI {
|
|
7712
8290
|
/**
|
|
7713
|
-
* Adds a message to the field.
|
|
8291
|
+
* Adds a validation message to the field.
|
|
8292
|
+
* This method creates a new message and associates it with the field's binding path,
|
|
8293
|
+
* making it visible in the field's value state and message popover.
|
|
7714
8294
|
*
|
|
7715
8295
|
*
|
|
7716
|
-
* @returns The
|
|
8296
|
+
* @returns The ID of the created message
|
|
7717
8297
|
*/
|
|
7718
8298
|
addMessage(
|
|
7719
8299
|
/**
|
|
7720
|
-
* The parameters
|
|
8300
|
+
* The message parameters
|
|
7721
8301
|
*/
|
|
7722
8302
|
parameters: {
|
|
7723
8303
|
/**
|
|
7724
|
-
*
|
|
8304
|
+
* Detailed message description
|
|
7725
8305
|
*/
|
|
7726
8306
|
description?: string;
|
|
7727
8307
|
/**
|
|
7728
|
-
* Message text
|
|
8308
|
+
* Message text to display
|
|
7729
8309
|
*/
|
|
7730
8310
|
message?: string;
|
|
7731
8311
|
/**
|
|
7732
|
-
*
|
|
8312
|
+
* Whether the message persists across refreshes
|
|
7733
8313
|
*/
|
|
7734
8314
|
persistent?: boolean;
|
|
7735
8315
|
/**
|
|
7736
|
-
* Type of the message
|
|
8316
|
+
* Type of the message, such as Error, Warning, Success, or Information
|
|
7737
8317
|
*/
|
|
7738
8318
|
type?: /* was: sap.ui.core.message.MessageType */ any;
|
|
7739
8319
|
}
|
|
@@ -7872,59 +8452,109 @@ declare namespace sap {
|
|
|
7872
8452
|
mParameters?: {}
|
|
7873
8453
|
): this;
|
|
7874
8454
|
/**
|
|
7875
|
-
* Gets the current
|
|
8455
|
+
* Gets the current enabled state of the field.
|
|
8456
|
+
* This method handles various control types and wrappers, returning true for controls
|
|
8457
|
+
* that are always enabled, such as Text, and checking the enabled property for interactive controls.
|
|
7876
8458
|
*
|
|
7877
8459
|
*
|
|
7878
|
-
* @returns Boolean value
|
|
8460
|
+
* @returns Boolean value indicating if the field is enabled, or true if control is not found (graceful
|
|
8461
|
+
* fallback)
|
|
7879
8462
|
*/
|
|
7880
8463
|
getEnabled(): boolean;
|
|
7881
8464
|
/**
|
|
7882
|
-
*
|
|
8465
|
+
* Gets the message manager instance from the UI5 core.
|
|
8466
|
+
* The message manager is responsible for handling all messages in the application.
|
|
8467
|
+
*
|
|
8468
|
+
*
|
|
8469
|
+
* @returns The Messaging instance
|
|
8470
|
+
*/
|
|
8471
|
+
getMessageManager(): /* was: sap.ui.core.Messaging */ any;
|
|
8472
|
+
/**
|
|
8473
|
+
* Gets the current value of the field.
|
|
8474
|
+
* This method handles various control types including CheckBox, Input, Text, MDC Field,
|
|
8475
|
+
* RatingIndicator, Link, Label, ObjectStatus, ObjectIdentifier, and building blocks.
|
|
7883
8476
|
*
|
|
7884
8477
|
*
|
|
7885
|
-
* @returns The current value of the field
|
|
8478
|
+
* @returns The current value of the field or undefined if control is not found
|
|
7886
8479
|
*/
|
|
7887
|
-
getValue(): boolean |
|
|
8480
|
+
getValue(): boolean | number | string | undefined;
|
|
7888
8481
|
/**
|
|
7889
|
-
* Removes a message from the field.
|
|
8482
|
+
* Removes a message from the field by its ID.
|
|
8483
|
+
* This method finds the message in the message model and removes it,
|
|
8484
|
+
* clearing it from the field's value state.
|
|
7890
8485
|
*/
|
|
7891
8486
|
removeMessage(
|
|
7892
8487
|
/**
|
|
7893
|
-
* The
|
|
8488
|
+
* The ID of the message to remove
|
|
7894
8489
|
*/
|
|
7895
8490
|
id: string
|
|
7896
8491
|
): void;
|
|
7897
8492
|
/**
|
|
7898
|
-
* Sets the current
|
|
8493
|
+
* Sets the current enabled state of the field.
|
|
8494
|
+
* This method handles various control types, setting the appropriate property,
|
|
8495
|
+
* such as enabled, active, titleActive, or edit mode based on the control type.
|
|
7899
8496
|
*
|
|
7900
8497
|
*
|
|
7901
|
-
* @returns The current field reference
|
|
8498
|
+
* @returns The current field reference for chaining
|
|
7902
8499
|
*/
|
|
7903
|
-
setEnabled(
|
|
8500
|
+
setEnabled(
|
|
8501
|
+
/**
|
|
8502
|
+
* The enabled state to set
|
|
8503
|
+
*/
|
|
8504
|
+
enabled: boolean
|
|
8505
|
+
): sap.ui.core.Control;
|
|
7904
8506
|
/**
|
|
7905
8507
|
* Sets the current value of the field.
|
|
8508
|
+
* This method handles various control types including CheckBox, Input, Text, and MDC Field.
|
|
7906
8509
|
*
|
|
7907
8510
|
*
|
|
7908
|
-
* @returns The current field reference
|
|
8511
|
+
* @returns The current field reference for chaining
|
|
7909
8512
|
*/
|
|
7910
|
-
setValue(
|
|
8513
|
+
setValue(
|
|
8514
|
+
/**
|
|
8515
|
+
* The value to set
|
|
8516
|
+
*/
|
|
8517
|
+
value: boolean | number | string
|
|
8518
|
+
): sap.ui.core.Control;
|
|
7911
8519
|
}
|
|
7912
8520
|
/**
|
|
7913
|
-
* Building block
|
|
8521
|
+
* Building block for creating a FilterBar based on the metadata provided by OData V4.
|
|
8522
|
+
* {@link demo:sap/fe/core/fpmExplorer/index.html#/buildingBlocks/filterBar/filterBarDefault Overview of Building Blocks}
|
|
7914
8523
|
*
|
|
7915
|
-
*
|
|
7916
|
-
|
|
7917
|
-
|
|
7918
|
-
|
|
7919
|
-
*
|
|
8524
|
+
*
|
|
8525
|
+
* Usually, a SelectionFields annotation is expected.
|
|
8526
|
+
*
|
|
8527
|
+
* Usage example:
|
|
8528
|
+
*
|
|
8529
|
+
* ```javascript
|
|
8530
|
+
*
|
|
8531
|
+
* <macros:FilterBar id="MyFilterBar" metaPath="@com.sap.vocabularies.UI.v1.SelectionFields" />
|
|
8532
|
+
* ```
|
|
7920
8533
|
*/
|
|
7921
|
-
class
|
|
8534
|
+
class FilterBar extends sap.fe.macros.MacroAPI {
|
|
7922
8535
|
/**
|
|
8536
|
+
* Adds a filterField to the FilterBar.
|
|
8537
|
+
* **Note:** When adding a custom filter field that uses a custom operator, ensure you use the correct configuration.
|
|
8538
|
+
* For more information, see {@link topic :5fb9f57fcf12401bbe39a635e9a32a4e Custom Filters with Custom Operators}.
|
|
7923
8539
|
*
|
|
7924
|
-
*
|
|
7925
|
-
*
|
|
8540
|
+
*
|
|
8541
|
+
* @since 1.147.0
|
|
8542
|
+
* @experimental As of version 1.147.0.
|
|
8543
|
+
*
|
|
8544
|
+
* @returns Reference to this to allow method chaining
|
|
7926
8545
|
*/
|
|
7927
|
-
|
|
8546
|
+
addFilterField(
|
|
8547
|
+
/**
|
|
8548
|
+
* The filterField to add
|
|
8549
|
+
*/
|
|
8550
|
+
filterField: sap.fe.macros.filterBar.FilterField
|
|
8551
|
+
): this;
|
|
8552
|
+
/**
|
|
8553
|
+
*
|
|
8554
|
+
* @returns Reference to sap.fe.macros.FilterBar
|
|
8555
|
+
* to allow method chaining
|
|
8556
|
+
*/
|
|
8557
|
+
attachAfterClear(
|
|
7928
8558
|
/**
|
|
7929
8559
|
* An application-specific payload object that will be passed to the event handler along with the event
|
|
7930
8560
|
* object when firing the event
|
|
@@ -7941,10 +8571,10 @@ declare namespace sap {
|
|
|
7941
8571
|
): this;
|
|
7942
8572
|
/**
|
|
7943
8573
|
*
|
|
7944
|
-
* @returns Reference to sap.fe.macros.
|
|
7945
|
-
* allow method chaining
|
|
8574
|
+
* @returns Reference to sap.fe.macros.FilterBar
|
|
8575
|
+
* to allow method chaining
|
|
7946
8576
|
*/
|
|
7947
|
-
|
|
8577
|
+
attachAfterClear(
|
|
7948
8578
|
/**
|
|
7949
8579
|
* The function to be called when the event occurs
|
|
7950
8580
|
*/
|
|
@@ -7956,10 +8586,15 @@ declare namespace sap {
|
|
|
7956
8586
|
): this;
|
|
7957
8587
|
/**
|
|
7958
8588
|
*
|
|
7959
|
-
* @returns Reference to sap.fe.macros.
|
|
7960
|
-
* allow method chaining
|
|
8589
|
+
* @returns Reference to sap.fe.macros.FilterBar
|
|
8590
|
+
* to allow method chaining
|
|
7961
8591
|
*/
|
|
7962
|
-
|
|
8592
|
+
attachFilterChanged(
|
|
8593
|
+
/**
|
|
8594
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
8595
|
+
* object when firing the event
|
|
8596
|
+
*/
|
|
8597
|
+
oData: object,
|
|
7963
8598
|
/**
|
|
7964
8599
|
* The function to be called when the event occurs
|
|
7965
8600
|
*/
|
|
@@ -7970,48 +8605,26 @@ declare namespace sap {
|
|
|
7970
8605
|
oListener?: object
|
|
7971
8606
|
): this;
|
|
7972
8607
|
/**
|
|
7973
|
-
* Fires event press to attached listeners.
|
|
7974
8608
|
*
|
|
7975
|
-
* @
|
|
7976
|
-
*
|
|
7977
|
-
* @returns Reference to sap.fe.macros.KPITag to
|
|
7978
|
-
* allow method chaining
|
|
8609
|
+
* @returns Reference to sap.fe.macros.FilterBar
|
|
8610
|
+
* to allow method chaining
|
|
7979
8611
|
*/
|
|
7980
|
-
|
|
8612
|
+
attachFilterChanged(
|
|
7981
8613
|
/**
|
|
7982
|
-
* The
|
|
7983
|
-
* See {@link .........types.EventHandler>} for the set of parameters that
|
|
7984
|
-
* are expected by the event handlers.
|
|
8614
|
+
* The function to be called when the event occurs
|
|
7985
8615
|
*/
|
|
7986
|
-
|
|
8616
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
8617
|
+
/**
|
|
8618
|
+
* The context object to call the event handler with. Defaults to this `this` control
|
|
8619
|
+
*/
|
|
8620
|
+
oListener?: object
|
|
7987
8621
|
): this;
|
|
7988
|
-
}
|
|
7989
|
-
/**
|
|
7990
|
-
* Base API control for building blocks.
|
|
7991
|
-
*/
|
|
7992
|
-
class MacroAPI
|
|
7993
|
-
extends sap.fe.core.buildingBlocks.BuildingBlock
|
|
7994
|
-
implements sap.ui.core.IFormContent
|
|
7995
|
-
{
|
|
7996
|
-
__implements__sap_ui_core_IFormContent: boolean;
|
|
7997
|
-
}
|
|
7998
|
-
/**
|
|
7999
|
-
* Building block used to show bound messages.
|
|
8000
|
-
* The Message Button Building Block gets the bound messages from the MessageModel.
|
|
8001
|
-
* Usage example:
|
|
8002
|
-
*
|
|
8003
|
-
* ```javascript
|
|
8004
|
-
*
|
|
8005
|
-
* <macros:MessageButton visibilityChange=".handler.onMessageButtonVisibilityChange" />
|
|
8006
|
-
* ```
|
|
8007
|
-
*/
|
|
8008
|
-
class MessageButton extends sap.fe.core.buildingBlocks.BuildingBlock {
|
|
8009
8622
|
/**
|
|
8010
8623
|
*
|
|
8011
|
-
* @returns Reference to sap.fe.macros.
|
|
8624
|
+
* @returns Reference to sap.fe.macros.FilterBar
|
|
8012
8625
|
* to allow method chaining
|
|
8013
8626
|
*/
|
|
8014
|
-
|
|
8627
|
+
attachSearch(
|
|
8015
8628
|
/**
|
|
8016
8629
|
* An application-specific payload object that will be passed to the event handler along with the event
|
|
8017
8630
|
* object when firing the event
|
|
@@ -8020,7 +8633,7 @@ declare namespace sap {
|
|
|
8020
8633
|
/**
|
|
8021
8634
|
* The function to be called when the event occurs
|
|
8022
8635
|
*/
|
|
8023
|
-
fnFunction: (p1:
|
|
8636
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
8024
8637
|
/**
|
|
8025
8638
|
* The context object to call the event handler with. Defaults to this `this` control
|
|
8026
8639
|
*/
|
|
@@ -8028,14 +8641,14 @@ declare namespace sap {
|
|
|
8028
8641
|
): this;
|
|
8029
8642
|
/**
|
|
8030
8643
|
*
|
|
8031
|
-
* @returns Reference to sap.fe.macros.
|
|
8644
|
+
* @returns Reference to sap.fe.macros.FilterBar
|
|
8032
8645
|
* to allow method chaining
|
|
8033
8646
|
*/
|
|
8034
|
-
|
|
8647
|
+
attachSearch(
|
|
8035
8648
|
/**
|
|
8036
8649
|
* The function to be called when the event occurs
|
|
8037
8650
|
*/
|
|
8038
|
-
fnFunction: (p1:
|
|
8651
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
8039
8652
|
/**
|
|
8040
8653
|
* The context object to call the event handler with. Defaults to this `this` control
|
|
8041
8654
|
*/
|
|
@@ -8043,76 +8656,25 @@ declare namespace sap {
|
|
|
8043
8656
|
): this;
|
|
8044
8657
|
/**
|
|
8045
8658
|
*
|
|
8046
|
-
* @returns Reference to sap.fe.macros.
|
|
8659
|
+
* @returns Reference to sap.fe.macros.FilterBar
|
|
8047
8660
|
* to allow method chaining
|
|
8048
8661
|
*/
|
|
8049
|
-
|
|
8662
|
+
detachAfterClear(
|
|
8050
8663
|
/**
|
|
8051
8664
|
* The function to be called when the event occurs
|
|
8052
8665
|
*/
|
|
8053
|
-
fnFunction: (p1:
|
|
8666
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
8054
8667
|
/**
|
|
8055
8668
|
* The context object to call the event handler with. Defaults to this `this` control
|
|
8056
8669
|
*/
|
|
8057
8670
|
oListener?: object
|
|
8058
8671
|
): this;
|
|
8059
|
-
/**
|
|
8060
|
-
* Fires event visibilityChange
|
|
8061
|
-
* to attached listeners.
|
|
8062
|
-
*
|
|
8063
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
8064
|
-
*
|
|
8065
|
-
* @returns Reference to sap.fe.macros.MessageButton
|
|
8066
|
-
* to allow method chaining
|
|
8067
|
-
*/
|
|
8068
|
-
fireVisibilityChange(
|
|
8069
|
-
/**
|
|
8070
|
-
* The parameters to pass along with the event.
|
|
8071
|
-
* See {@link .........types.EventHandler>} for the
|
|
8072
|
-
* set of parameters that are expected by the event handlers.
|
|
8073
|
-
*/
|
|
8074
|
-
mParameters?: sap.fe.macros.MessageButton$VisibilityChangeEventParameters
|
|
8075
|
-
): this;
|
|
8076
|
-
}
|
|
8077
|
-
/**
|
|
8078
|
-
* Building block used to create a MicroChart based on the metadata provided by OData V4.
|
|
8079
|
-
* {@link demo:sap/fe/core/fpmExplorer/index.html#/buildingBlocks/microchart/ Overview of Micro Chart Building Block}
|
|
8080
|
-
*
|
|
8081
|
-
*
|
|
8082
|
-
* Usually, a contextPath and metaPath is expected.
|
|
8083
|
-
*
|
|
8084
|
-
* Usage example:
|
|
8085
|
-
*
|
|
8086
|
-
* ```javascript
|
|
8087
|
-
*
|
|
8088
|
-
* <macros:MicroChart id="MyMicroChart" contextPath="/RootEntity" metaPath="@com.sap.vocabularies.UI.v1.Chart" />
|
|
8089
|
-
* ```
|
|
8090
|
-
*
|
|
8091
|
-
*
|
|
8092
|
-
* ```javascript
|
|
8093
|
-
*
|
|
8094
|
-
* sap.ui.require(["sap/fe/macros/MicroChart"], function(MicroChart) {
|
|
8095
|
-
* ...
|
|
8096
|
-
* new MicroChart("myMicroChart", {metaPath:"@com.sap.vocabularies.UI.v1.Chart"})
|
|
8097
|
-
* })
|
|
8098
|
-
* ```
|
|
8099
|
-
*
|
|
8100
|
-
*
|
|
8101
|
-
*
|
|
8102
|
-
* @since 1.93.0
|
|
8103
|
-
*/
|
|
8104
|
-
class MicroChart extends sap.fe.core.buildingBlocks.BuildingBlock {
|
|
8105
8672
|
/**
|
|
8106
8673
|
*
|
|
8107
|
-
* @returns Reference to sap.fe.macros.
|
|
8674
|
+
* @returns Reference to sap.fe.macros.FilterBar
|
|
8108
8675
|
* to allow method chaining
|
|
8109
8676
|
*/
|
|
8110
|
-
|
|
8111
|
-
/**
|
|
8112
|
-
* An application-specific payload object that will be passed to the event handler along with the event
|
|
8113
|
-
* object when firing the event
|
|
8114
|
-
*/
|
|
8115
|
-
oData: object,
|
|
8677
|
+
detachFilterChanged(
|
|
8116
8678
|
/**
|
|
8117
8679
|
* The function to be called when the event occurs
|
|
8118
8680
|
*/
|
|
@@ -8124,10 +8686,10 @@ declare namespace sap {
|
|
|
8124
8686
|
): this;
|
|
8125
8687
|
/**
|
|
8126
8688
|
*
|
|
8127
|
-
* @returns Reference to sap.fe.macros.
|
|
8689
|
+
* @returns Reference to sap.fe.macros.FilterBar
|
|
8128
8690
|
* to allow method chaining
|
|
8129
8691
|
*/
|
|
8130
|
-
|
|
8692
|
+
detachSearch(
|
|
8131
8693
|
/**
|
|
8132
8694
|
* The function to be called when the event occurs
|
|
8133
8695
|
*/
|
|
@@ -8138,235 +8700,236 @@ declare namespace sap {
|
|
|
8138
8700
|
oListener?: object
|
|
8139
8701
|
): this;
|
|
8140
8702
|
/**
|
|
8703
|
+
* Fires event afterClear to
|
|
8704
|
+
* attached listeners.
|
|
8141
8705
|
*
|
|
8142
|
-
* @
|
|
8706
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
8707
|
+
*
|
|
8708
|
+
* @returns Reference to sap.fe.macros.FilterBar
|
|
8143
8709
|
* to allow method chaining
|
|
8144
8710
|
*/
|
|
8145
|
-
|
|
8146
|
-
/**
|
|
8147
|
-
* The function to be called when the event occurs
|
|
8148
|
-
*/
|
|
8149
|
-
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
8711
|
+
fireAfterClear(
|
|
8150
8712
|
/**
|
|
8151
|
-
* The
|
|
8713
|
+
* The parameters to pass along with the event.
|
|
8714
|
+
* See {@link .........types.EventHandler>} for the set
|
|
8715
|
+
* of parameters that are expected by the event handlers.
|
|
8152
8716
|
*/
|
|
8153
|
-
|
|
8717
|
+
mParameters?: {}
|
|
8154
8718
|
): this;
|
|
8155
8719
|
/**
|
|
8156
|
-
* Fires event
|
|
8720
|
+
* Fires event filterChanged
|
|
8157
8721
|
* to attached listeners.
|
|
8158
8722
|
*
|
|
8159
8723
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
8160
8724
|
*
|
|
8161
|
-
* @returns Reference to sap.fe.macros.
|
|
8725
|
+
* @returns Reference to sap.fe.macros.FilterBar
|
|
8162
8726
|
* to allow method chaining
|
|
8163
8727
|
*/
|
|
8164
|
-
|
|
8728
|
+
fireFilterChanged(
|
|
8165
8729
|
/**
|
|
8166
8730
|
* The parameters to pass along with the event.
|
|
8167
|
-
* See {@link types.EventHandler>}
|
|
8168
|
-
* expected by the event handlers.
|
|
8731
|
+
* See {@link .........types.EventHandler> }
|
|
8732
|
+
* for the set of parameters that are expected by the event handlers.
|
|
8169
8733
|
*/
|
|
8170
8734
|
mParameters?: {}
|
|
8171
8735
|
): this;
|
|
8172
8736
|
/**
|
|
8173
|
-
*
|
|
8737
|
+
* Fires event search to attached
|
|
8738
|
+
* listeners.
|
|
8174
8739
|
*
|
|
8740
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
8175
8741
|
*
|
|
8176
|
-
* @returns
|
|
8742
|
+
* @returns Reference to sap.fe.macros.FilterBar
|
|
8743
|
+
* to allow method chaining
|
|
8177
8744
|
*/
|
|
8178
|
-
|
|
8745
|
+
fireSearch(
|
|
8746
|
+
/**
|
|
8747
|
+
* The parameters to pass along with the event.
|
|
8748
|
+
* See {@link .........types.EventHandler>} for the set
|
|
8749
|
+
* of parameters that are expected by the event handlers.
|
|
8750
|
+
*/
|
|
8751
|
+
mParameters?: {}
|
|
8752
|
+
): this;
|
|
8179
8753
|
/**
|
|
8180
|
-
*
|
|
8754
|
+
* Get the Active Filters Text Summary for the filter bar.
|
|
8181
8755
|
*
|
|
8182
8756
|
*
|
|
8183
|
-
* @returns
|
|
8757
|
+
* @returns Active filters summary as text
|
|
8184
8758
|
*/
|
|
8185
|
-
|
|
8759
|
+
getActiveFiltersText(): string;
|
|
8186
8760
|
/**
|
|
8187
|
-
* Gets
|
|
8761
|
+
* Gets the key of the current variant in the associated variant management.
|
|
8188
8762
|
*
|
|
8189
8763
|
*
|
|
8190
|
-
* @returns
|
|
8764
|
+
* @returns Key of the currently selected variant. In case the model is not yet set, `null` will be returned.
|
|
8191
8765
|
*/
|
|
8192
|
-
|
|
8766
|
+
getCurrentVariantKey(): null | string;
|
|
8193
8767
|
/**
|
|
8194
|
-
*
|
|
8768
|
+
* Determines whether the field is enabled or disabled.
|
|
8195
8769
|
*
|
|
8196
8770
|
*
|
|
8197
|
-
* @returns
|
|
8771
|
+
* @returns Whether the filterField is enabled or disabled.
|
|
8198
8772
|
*/
|
|
8199
|
-
|
|
8773
|
+
getFilterFieldEnabled(
|
|
8774
|
+
/**
|
|
8775
|
+
* Name of the field.
|
|
8776
|
+
*/
|
|
8777
|
+
name: string
|
|
8778
|
+
): boolean;
|
|
8200
8779
|
/**
|
|
8201
|
-
* Gets
|
|
8780
|
+
* Gets the visibility of a filter field.
|
|
8202
8781
|
*
|
|
8203
8782
|
*
|
|
8204
|
-
* @returns
|
|
8783
|
+
* @returns A {@link Promise} that resolves to check whether the filter field is visible or not.
|
|
8205
8784
|
*/
|
|
8206
|
-
|
|
8785
|
+
getFilterFieldVisible(
|
|
8786
|
+
/**
|
|
8787
|
+
* The path to the property as a condition path
|
|
8788
|
+
*/
|
|
8789
|
+
conditionPath: string
|
|
8790
|
+
): Promise<boolean>;
|
|
8207
8791
|
/**
|
|
8208
|
-
*
|
|
8792
|
+
* Provides all the filters that are currently active
|
|
8793
|
+
* along with the search expression.
|
|
8209
8794
|
*
|
|
8210
8795
|
*
|
|
8211
|
-
* @returns
|
|
8796
|
+
* @returns An array of active filters and the search expression.
|
|
8212
8797
|
*/
|
|
8213
|
-
|
|
8798
|
+
getFilters(): object;
|
|
8214
8799
|
/**
|
|
8215
|
-
*
|
|
8800
|
+
* Get the selection variant from the filter bar.
|
|
8801
|
+
* Note: This method returns all the filter values that are set in the filter bar, including the text from
|
|
8802
|
+
* the search field (with $search as the property name). However, it doesn't return any filter field condition
|
|
8803
|
+
* that uses a custom operator.
|
|
8216
8804
|
*
|
|
8217
8805
|
*
|
|
8218
|
-
* @returns
|
|
8806
|
+
* @returns A promise which resolves with a {@link sap.fe.navigation.SelectionVariant}
|
|
8219
8807
|
*/
|
|
8220
|
-
|
|
8808
|
+
getSelectionVariant(): Promise<sap.fe.navigation.SelectionVariant>;
|
|
8221
8809
|
/**
|
|
8222
|
-
*
|
|
8810
|
+
* Removes a filterField from the FilterBar.
|
|
8223
8811
|
*
|
|
8812
|
+
* @since 1.147.0
|
|
8813
|
+
* @experimental As of version 1.147.0.
|
|
8224
8814
|
*
|
|
8225
|
-
* @returns
|
|
8815
|
+
* @returns The removed filterField or null
|
|
8226
8816
|
*/
|
|
8227
|
-
|
|
8817
|
+
removeFilterField(
|
|
8818
|
+
/**
|
|
8819
|
+
* The filterField to remove, or its index or ID
|
|
8820
|
+
*/
|
|
8821
|
+
filterField: number | sap.fe.macros.filterBar.FilterField | string
|
|
8822
|
+
): null | sap.fe.macros.filterBar.FilterField;
|
|
8228
8823
|
/**
|
|
8229
|
-
*
|
|
8230
|
-
*
|
|
8231
|
-
*
|
|
8232
|
-
* @returns Value of property `hideOnNoData`
|
|
8824
|
+
* Sets the new selected variant in the associated variant management.
|
|
8233
8825
|
*/
|
|
8234
|
-
|
|
8826
|
+
setCurrentVariantKey(
|
|
8827
|
+
/**
|
|
8828
|
+
* Key of the variant that should be selected. If the passed key doesn't identify a variant, it will be
|
|
8829
|
+
* ignored.
|
|
8830
|
+
*/
|
|
8831
|
+
key: string
|
|
8832
|
+
): void;
|
|
8235
8833
|
/**
|
|
8236
|
-
*
|
|
8834
|
+
* Sets the enablement of the field.
|
|
8835
|
+
*/
|
|
8836
|
+
setFilterFieldEnabled(
|
|
8837
|
+
/**
|
|
8838
|
+
* Name of the field that should be enabled or disabled.
|
|
8839
|
+
*/
|
|
8840
|
+
name: string,
|
|
8841
|
+
/**
|
|
8842
|
+
* Whether the field should be enabled or disabled.
|
|
8843
|
+
*/
|
|
8844
|
+
enabled: boolean
|
|
8845
|
+
): void;
|
|
8846
|
+
/**
|
|
8847
|
+
* Shows or hides any filter field from the filter bar.
|
|
8848
|
+
* The property will not be hidden inside the adaptation dialog and may be re-added.
|
|
8237
8849
|
*
|
|
8238
8850
|
*
|
|
8239
|
-
* @returns
|
|
8851
|
+
* @returns A {@link Promise} resolving once the change in visibility was applied
|
|
8240
8852
|
*/
|
|
8241
|
-
|
|
8853
|
+
setFilterFieldVisible(
|
|
8854
|
+
/**
|
|
8855
|
+
* The path to the property as a condition path
|
|
8856
|
+
*/
|
|
8857
|
+
conditionPath: string,
|
|
8858
|
+
/**
|
|
8859
|
+
* Whether it should be shown or hidden
|
|
8860
|
+
*/
|
|
8861
|
+
visible: boolean
|
|
8862
|
+
): Promise<void>;
|
|
8242
8863
|
/**
|
|
8243
|
-
*
|
|
8864
|
+
* Set the filter values for the given property in the filter bar.
|
|
8865
|
+
* The filter values can be either a single value or an array of values.
|
|
8866
|
+
* Each filter value must be represented as a primitive value.
|
|
8244
8867
|
*
|
|
8245
8868
|
*
|
|
8246
|
-
* @returns
|
|
8869
|
+
* @returns A promise for asynchronous handling
|
|
8247
8870
|
*/
|
|
8248
|
-
|
|
8871
|
+
setFilterValues(
|
|
8872
|
+
/**
|
|
8873
|
+
* The path to the property as a condition path
|
|
8874
|
+
*/
|
|
8875
|
+
sConditionPath: string,
|
|
8876
|
+
/**
|
|
8877
|
+
* The operator to be used (optional) - if not set, the default operator (EQ) will be used
|
|
8878
|
+
*/
|
|
8879
|
+
sOperator: string | undefined,
|
|
8880
|
+
/**
|
|
8881
|
+
* The values to be applied
|
|
8882
|
+
*/
|
|
8883
|
+
vValues?:
|
|
8884
|
+
| boolean
|
|
8885
|
+
| boolean[]
|
|
8886
|
+
| number
|
|
8887
|
+
| number[]
|
|
8888
|
+
| string
|
|
8889
|
+
| string[]
|
|
8890
|
+
| undefined
|
|
8891
|
+
): Promise<void>;
|
|
8249
8892
|
/**
|
|
8250
|
-
*
|
|
8893
|
+
* Sets {@link sap.fe.navigation.SelectionVariant } to the filter bar. Note: setSelectionVariant will clear
|
|
8894
|
+
* existing filters and then apply the SelectionVariant values.
|
|
8895
|
+
* Note: This method cannot set the search field text or any filter field condition that relies on a custom
|
|
8896
|
+
* operator.
|
|
8251
8897
|
*
|
|
8252
8898
|
*
|
|
8253
|
-
* @returns
|
|
8899
|
+
* @returns A promise for asynchronous handling
|
|
8254
8900
|
*/
|
|
8255
|
-
|
|
8256
|
-
|
|
8257
|
-
|
|
8258
|
-
|
|
8259
|
-
|
|
8260
|
-
|
|
8261
|
-
|
|
8262
|
-
|
|
8901
|
+
setSelectionVariant(
|
|
8902
|
+
/**
|
|
8903
|
+
* The {@link sap.fe.navigation.SelectionVariant} to apply to the filter bar
|
|
8904
|
+
*/
|
|
8905
|
+
selectionVariant: sap.fe.navigation.SelectionVariant,
|
|
8906
|
+
/**
|
|
8907
|
+
* Optional. If true, we will use the associated text property values (if they're available in the selectionVariant)
|
|
8908
|
+
* to display the filter value descriptions, instead of loading them from the backend
|
|
8909
|
+
*/
|
|
8910
|
+
prefillDescriptions?: boolean
|
|
8911
|
+
): Promise<any>;
|
|
8263
8912
|
/**
|
|
8264
|
-
*
|
|
8913
|
+
* Triggers the API search on the filter bar.
|
|
8265
8914
|
*
|
|
8266
8915
|
*
|
|
8267
|
-
* @returns
|
|
8916
|
+
* @returns Returns a promise which resolves if the filter is triggered; otherwise it is rejected.
|
|
8268
8917
|
*/
|
|
8269
|
-
|
|
8918
|
+
triggerSearch(): Promise<object | undefined>;
|
|
8270
8919
|
}
|
|
8271
8920
|
/**
|
|
8272
|
-
* Building block
|
|
8273
|
-
*
|
|
8274
|
-
*
|
|
8275
|
-
* The MultiValueField can be used to display either a DataField or Property directly. It has to point to
|
|
8276
|
-
* a collection property.
|
|
8277
|
-
*
|
|
8278
|
-
*
|
|
8279
|
-
* Usage example:
|
|
8280
|
-
*
|
|
8281
|
-
* ```javascript
|
|
8282
|
-
*
|
|
8283
|
-
* <macro:MultiValueField
|
|
8284
|
-
* id="SomeUniqueIdentifier"
|
|
8285
|
-
* contextPath="{entitySet>}"
|
|
8286
|
-
* metaPath="{dataField>}"
|
|
8287
|
-
* />
|
|
8288
|
-
* ```
|
|
8289
|
-
*
|
|
8290
|
-
*
|
|
8291
|
-
* @since 1.118.0
|
|
8292
|
-
*/
|
|
8293
|
-
class MultiValueField extends sap.fe.core.buildingBlocks.BuildingBlock {}
|
|
8294
|
-
/**
|
|
8295
|
-
* Building block used to create a custom page with a title and the content. By default, the page includes
|
|
8296
|
-
* a title.
|
|
8297
|
-
*/
|
|
8298
|
-
class Page extends sap.fe.core.buildingBlocks.BuildingBlock {}
|
|
8299
|
-
/**
|
|
8300
|
-
* Building block used to create a paginator control.
|
|
8301
|
-
* Usage example:
|
|
8302
|
-
*
|
|
8303
|
-
* ```javascript
|
|
8304
|
-
*
|
|
8305
|
-
* <macros:Paginator />
|
|
8306
|
-
* ```
|
|
8307
|
-
*
|
|
8308
|
-
*
|
|
8309
|
-
*
|
|
8310
|
-
* @since 1.94.0
|
|
8311
|
-
*/
|
|
8312
|
-
class Paginator extends sap.fe.core.buildingBlocks.BuildingBlock {}
|
|
8313
|
-
/**
|
|
8314
|
-
* Building block that exposes the RichTextEditor UI5 control.
|
|
8315
|
-
* It's used to enter formatted text, and uses the third-party component called TinyMCE.
|
|
8316
|
-
*
|
|
8317
|
-
*
|
|
8318
|
-
* @since 1.117.0
|
|
8319
|
-
*/
|
|
8320
|
-
class RichTextEditor extends sap.fe.core.buildingBlocks.BuildingBlock {}
|
|
8321
|
-
/**
|
|
8322
|
-
* Metadata-driven building block that exposes the RichTextEditor UI5 control.
|
|
8323
|
-
* It's used to enter formatted text and uses the third-party component called TinyMCE.
|
|
8324
|
-
*
|
|
8325
|
-
*
|
|
8326
|
-
* @since 1.117.0
|
|
8327
|
-
*/
|
|
8328
|
-
class RichTextEditorWithMetadata extends sap.fe.macros.RichTextEditor {}
|
|
8329
|
-
/**
|
|
8330
|
-
* Building block used to create the ‘Share’ functionality.
|
|
8331
|
-
*
|
|
8332
|
-
*
|
|
8333
|
-
* Please note that the 'Share in SAP Jam' option is only available on platforms that are integrated with
|
|
8334
|
-
* SAP Jam.
|
|
8335
|
-
*
|
|
8336
|
-
*
|
|
8337
|
-
* If you are consuming this macro in an environment where the SAP Fiori launchpad is not available, then
|
|
8338
|
-
* the 'Save as Tile' option is not visible.
|
|
8339
|
-
*
|
|
8340
|
-
* Usage example:
|
|
8341
|
-
*
|
|
8342
|
-
* ```javascript
|
|
8343
|
-
*
|
|
8344
|
-
* <macros:Share
|
|
8345
|
-
* id="someID"
|
|
8346
|
-
* visible="true"
|
|
8347
|
-
* />
|
|
8348
|
-
* ```
|
|
8349
|
-
*
|
|
8350
|
-
* {@link demo:sap/fe/core/fpmExplorer/index.html#/buildingBlocks/features/shareDefault Overview of Building Blocks}
|
|
8351
|
-
*
|
|
8921
|
+
* Building block used to create a form element based on the metadata provided by OData V4.
|
|
8352
8922
|
*
|
|
8353
|
-
* @since 1.
|
|
8923
|
+
* @since 1.90.0
|
|
8354
8924
|
*/
|
|
8355
|
-
class
|
|
8925
|
+
class FormElement extends sap.ui.layout.form.FormElement {}
|
|
8356
8926
|
/**
|
|
8357
|
-
* Building block to
|
|
8358
|
-
*
|
|
8359
|
-
* @since 1.143.0
|
|
8927
|
+
* Building block used to create a KPI tag.
|
|
8360
8928
|
*/
|
|
8361
|
-
class
|
|
8362
|
-
extends sap.fe.core.buildingBlocks.BuildingBlock
|
|
8363
|
-
implements sap.ui.core.IFormContent
|
|
8364
|
-
{
|
|
8365
|
-
__implements__sap_ui_core_IFormContent: boolean;
|
|
8366
|
-
|
|
8929
|
+
class KPITag extends sap.fe.core.buildingBlocks.BuildingBlock {
|
|
8367
8930
|
/**
|
|
8368
8931
|
*
|
|
8369
|
-
* @returns Reference to sap.fe.macros.
|
|
8932
|
+
* @returns Reference to sap.fe.macros.KPITag to
|
|
8370
8933
|
* allow method chaining
|
|
8371
8934
|
*/
|
|
8372
8935
|
attachPress(
|
|
@@ -8386,7 +8949,7 @@ declare namespace sap {
|
|
|
8386
8949
|
): this;
|
|
8387
8950
|
/**
|
|
8388
8951
|
*
|
|
8389
|
-
* @returns Reference to sap.fe.macros.
|
|
8952
|
+
* @returns Reference to sap.fe.macros.KPITag to
|
|
8390
8953
|
* allow method chaining
|
|
8391
8954
|
*/
|
|
8392
8955
|
attachPress(
|
|
@@ -8401,7 +8964,7 @@ declare namespace sap {
|
|
|
8401
8964
|
): this;
|
|
8402
8965
|
/**
|
|
8403
8966
|
*
|
|
8404
|
-
* @returns Reference to sap.fe.macros.
|
|
8967
|
+
* @returns Reference to sap.fe.macros.KPITag to
|
|
8405
8968
|
* allow method chaining
|
|
8406
8969
|
*/
|
|
8407
8970
|
detachPress(
|
|
@@ -8419,112 +8982,44 @@ declare namespace sap {
|
|
|
8419
8982
|
*
|
|
8420
8983
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
8421
8984
|
*
|
|
8422
|
-
* @returns Reference to sap.fe.macros.
|
|
8985
|
+
* @returns Reference to sap.fe.macros.KPITag to
|
|
8423
8986
|
* allow method chaining
|
|
8424
8987
|
*/
|
|
8425
8988
|
firePress(
|
|
8426
8989
|
/**
|
|
8427
8990
|
* The parameters to pass along with the event.
|
|
8991
|
+
* See {@link .........types.EventHandler>} for the set of parameters that
|
|
8992
|
+
* are expected by the event handlers.
|
|
8428
8993
|
*/
|
|
8429
8994
|
mParameters?: {}
|
|
8430
8995
|
): this;
|
|
8431
8996
|
}
|
|
8432
8997
|
/**
|
|
8433
|
-
*
|
|
8434
|
-
|
|
8435
|
-
|
|
8436
|
-
|
|
8437
|
-
|
|
8438
|
-
|
|
8439
|
-
|
|
8440
|
-
|
|
8441
|
-
|
|
8442
|
-
*
|
|
8443
|
-
*
|
|
8444
|
-
* also has a UI.LineItem as the first property of the Visualizations.
|
|
8998
|
+
* Base API control for building blocks.
|
|
8999
|
+
*/
|
|
9000
|
+
class MacroAPI
|
|
9001
|
+
extends sap.fe.core.buildingBlocks.BuildingBlock
|
|
9002
|
+
implements sap.ui.core.IFormContent
|
|
9003
|
+
{
|
|
9004
|
+
__implements__sap_ui_core_IFormContent: boolean;
|
|
9005
|
+
}
|
|
9006
|
+
/**
|
|
9007
|
+
* Building block used to show bound messages.
|
|
9008
|
+
* The Message Button Building Block gets the bound messages from the MessageModel.
|
|
8445
9009
|
* Usage example:
|
|
8446
9010
|
*
|
|
8447
9011
|
* ```javascript
|
|
8448
9012
|
*
|
|
8449
|
-
* <macros:
|
|
9013
|
+
* <macros:MessageButton visibilityChange=".handler.onMessageButtonVisibilityChange" />
|
|
8450
9014
|
* ```
|
|
8451
|
-
*
|
|
8452
|
-
* {@link demo:sap/fe/core/fpmExplorer/index.html#/buildingBlocks/table/tableDefault Overview of Table Building Blocks}
|
|
8453
9015
|
*/
|
|
8454
|
-
class
|
|
8455
|
-
extends sap.fe.macros.MacroAPI
|
|
8456
|
-
implements
|
|
8457
|
-
/* was: sap.fe.core.IRowBindingInterface */ Object,
|
|
8458
|
-
/* was: sap.fe.macros.Table.ITableBlock */ Object
|
|
8459
|
-
{
|
|
8460
|
-
__implements__sap_fe_core_IRowBindingInterface: boolean;
|
|
8461
|
-
__implements__sap_fe_macros_Table_ITableBlock: boolean;
|
|
8462
|
-
|
|
8463
|
-
/**
|
|
8464
|
-
* Adds an action to the table.
|
|
8465
|
-
*
|
|
8466
|
-
* @since 1.145.0
|
|
8467
|
-
* @experimental As of version 1.145.0.
|
|
8468
|
-
*
|
|
8469
|
-
* @returns Reference to this to allow method chaining
|
|
8470
|
-
*/
|
|
8471
|
-
addAction(
|
|
8472
|
-
/**
|
|
8473
|
-
* The action to add
|
|
8474
|
-
*/
|
|
8475
|
-
action: sap.fe.macros.table.Action
|
|
8476
|
-
): this;
|
|
8477
|
-
/**
|
|
8478
|
-
* Adds a column to the table.
|
|
8479
|
-
*
|
|
8480
|
-
* @since 1.145.0
|
|
8481
|
-
* @experimental As of version 1.145.0.
|
|
8482
|
-
*
|
|
8483
|
-
* @returns Reference to this to allow method chaining
|
|
8484
|
-
*/
|
|
8485
|
-
addColumn(
|
|
8486
|
-
/**
|
|
8487
|
-
* The column to add
|
|
8488
|
-
*/
|
|
8489
|
-
column: sap.fe.macros.table.Column
|
|
8490
|
-
): this;
|
|
8491
|
-
/**
|
|
8492
|
-
* Adds a message to the table.
|
|
8493
|
-
* The message applies to the whole table and not to an individual table row.
|
|
8494
|
-
*
|
|
8495
|
-
*
|
|
8496
|
-
*
|
|
8497
|
-
* @returns Promise The ID of the message
|
|
8498
|
-
*/
|
|
8499
|
-
addMessage(
|
|
8500
|
-
/**
|
|
8501
|
-
* The parameters to create the message
|
|
8502
|
-
*/
|
|
8503
|
-
parameters: {
|
|
8504
|
-
/**
|
|
8505
|
-
* Message description
|
|
8506
|
-
*/
|
|
8507
|
-
description?: string;
|
|
8508
|
-
/**
|
|
8509
|
-
* Message text
|
|
8510
|
-
*/
|
|
8511
|
-
message?: string;
|
|
8512
|
-
/**
|
|
8513
|
-
* True if the message is persistent
|
|
8514
|
-
*/
|
|
8515
|
-
persistent?: boolean;
|
|
8516
|
-
/**
|
|
8517
|
-
* Message type
|
|
8518
|
-
*/
|
|
8519
|
-
type?: /* was: sap.ui.core.message.MessageType */ any;
|
|
8520
|
-
}
|
|
8521
|
-
): Promise<string>;
|
|
9016
|
+
class MessageButton extends sap.fe.core.buildingBlocks.BuildingBlock {
|
|
8522
9017
|
/**
|
|
8523
9018
|
*
|
|
8524
|
-
* @returns Reference to sap.fe.macros.
|
|
8525
|
-
* method chaining
|
|
9019
|
+
* @returns Reference to sap.fe.macros.MessageButton
|
|
9020
|
+
* to allow method chaining
|
|
8526
9021
|
*/
|
|
8527
|
-
|
|
9022
|
+
attachVisibilityChange(
|
|
8528
9023
|
/**
|
|
8529
9024
|
* An application-specific payload object that will be passed to the event handler along with the event
|
|
8530
9025
|
* object when firing the event
|
|
@@ -8533,7 +9028,7 @@ declare namespace sap {
|
|
|
8533
9028
|
/**
|
|
8534
9029
|
* The function to be called when the event occurs
|
|
8535
9030
|
*/
|
|
8536
|
-
fnFunction: (p1:
|
|
9031
|
+
fnFunction: (p1: MessageButton$VisibilityChangeEvent) => void,
|
|
8537
9032
|
/**
|
|
8538
9033
|
* The context object to call the event handler with. Defaults to this `this` control
|
|
8539
9034
|
*/
|
|
@@ -8541,14 +9036,14 @@ declare namespace sap {
|
|
|
8541
9036
|
): this;
|
|
8542
9037
|
/**
|
|
8543
9038
|
*
|
|
8544
|
-
* @returns Reference to sap.fe.macros.
|
|
8545
|
-
* method chaining
|
|
9039
|
+
* @returns Reference to sap.fe.macros.MessageButton
|
|
9040
|
+
* to allow method chaining
|
|
8546
9041
|
*/
|
|
8547
|
-
|
|
9042
|
+
attachVisibilityChange(
|
|
8548
9043
|
/**
|
|
8549
9044
|
* The function to be called when the event occurs
|
|
8550
9045
|
*/
|
|
8551
|
-
fnFunction: (p1:
|
|
9046
|
+
fnFunction: (p1: MessageButton$VisibilityChangeEvent) => void,
|
|
8552
9047
|
/**
|
|
8553
9048
|
* The context object to call the event handler with. Defaults to this `this` control
|
|
8554
9049
|
*/
|
|
@@ -8556,45 +9051,71 @@ declare namespace sap {
|
|
|
8556
9051
|
): this;
|
|
8557
9052
|
/**
|
|
8558
9053
|
*
|
|
8559
|
-
* @returns Reference to sap.fe.macros.
|
|
8560
|
-
* method chaining
|
|
9054
|
+
* @returns Reference to sap.fe.macros.MessageButton
|
|
9055
|
+
* to allow method chaining
|
|
8561
9056
|
*/
|
|
8562
|
-
|
|
8563
|
-
/**
|
|
8564
|
-
* An application-specific payload object that will be passed to the event handler along with the event
|
|
8565
|
-
* object when firing the event
|
|
8566
|
-
*/
|
|
8567
|
-
oData: object,
|
|
9057
|
+
detachVisibilityChange(
|
|
8568
9058
|
/**
|
|
8569
9059
|
* The function to be called when the event occurs
|
|
8570
9060
|
*/
|
|
8571
|
-
fnFunction: (p1:
|
|
9061
|
+
fnFunction: (p1: MessageButton$VisibilityChangeEvent) => void,
|
|
8572
9062
|
/**
|
|
8573
9063
|
* The context object to call the event handler with. Defaults to this `this` control
|
|
8574
9064
|
*/
|
|
8575
9065
|
oListener?: object
|
|
8576
9066
|
): this;
|
|
8577
9067
|
/**
|
|
9068
|
+
* Fires event visibilityChange
|
|
9069
|
+
* to attached listeners.
|
|
8578
9070
|
*
|
|
8579
|
-
* @
|
|
8580
|
-
*
|
|
9071
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
9072
|
+
*
|
|
9073
|
+
* @returns Reference to sap.fe.macros.MessageButton
|
|
9074
|
+
* to allow method chaining
|
|
8581
9075
|
*/
|
|
8582
|
-
|
|
8583
|
-
/**
|
|
8584
|
-
* The function to be called when the event occurs
|
|
8585
|
-
*/
|
|
8586
|
-
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
9076
|
+
fireVisibilityChange(
|
|
8587
9077
|
/**
|
|
8588
|
-
* The
|
|
9078
|
+
* The parameters to pass along with the event.
|
|
9079
|
+
* See {@link .........types.EventHandler>} for the
|
|
9080
|
+
* set of parameters that are expected by the event handlers.
|
|
8589
9081
|
*/
|
|
8590
|
-
|
|
9082
|
+
mParameters?: sap.fe.macros.MessageButton$VisibilityChangeEventParameters
|
|
8591
9083
|
): this;
|
|
9084
|
+
}
|
|
9085
|
+
/**
|
|
9086
|
+
* Building block used to create a MicroChart based on the metadata provided by OData V4.
|
|
9087
|
+
* {@link demo:sap/fe/core/fpmExplorer/index.html#/buildingBlocks/microchart/ Overview of Micro Chart Building Block}
|
|
9088
|
+
*
|
|
9089
|
+
*
|
|
9090
|
+
* Usually, a contextPath and metaPath is expected.
|
|
9091
|
+
*
|
|
9092
|
+
* Usage example:
|
|
9093
|
+
*
|
|
9094
|
+
* ```javascript
|
|
9095
|
+
*
|
|
9096
|
+
* <macros:MicroChart id="MyMicroChart" contextPath="/RootEntity" metaPath="@com.sap.vocabularies.UI.v1.Chart" />
|
|
9097
|
+
* ```
|
|
9098
|
+
*
|
|
9099
|
+
*
|
|
9100
|
+
* ```javascript
|
|
9101
|
+
*
|
|
9102
|
+
* sap.ui.require(["sap/fe/macros/MicroChart"], function(MicroChart) {
|
|
9103
|
+
* ...
|
|
9104
|
+
* new MicroChart("myMicroChart", {metaPath:"@com.sap.vocabularies.UI.v1.Chart"})
|
|
9105
|
+
* })
|
|
9106
|
+
* ```
|
|
9107
|
+
*
|
|
9108
|
+
*
|
|
9109
|
+
*
|
|
9110
|
+
* @since 1.93.0
|
|
9111
|
+
*/
|
|
9112
|
+
class MicroChart extends sap.fe.core.buildingBlocks.BuildingBlock {
|
|
8592
9113
|
/**
|
|
8593
9114
|
*
|
|
8594
|
-
* @returns Reference to sap.fe.macros.
|
|
8595
|
-
* method chaining
|
|
9115
|
+
* @returns Reference to sap.fe.macros.MicroChart
|
|
9116
|
+
* to allow method chaining
|
|
8596
9117
|
*/
|
|
8597
|
-
|
|
9118
|
+
attachTitlePress(
|
|
8598
9119
|
/**
|
|
8599
9120
|
* An application-specific payload object that will be passed to the event handler along with the event
|
|
8600
9121
|
* object when firing the event
|
|
@@ -8611,46 +9132,10 @@ declare namespace sap {
|
|
|
8611
9132
|
): this;
|
|
8612
9133
|
/**
|
|
8613
9134
|
*
|
|
8614
|
-
* @returns Reference to sap.fe.macros.
|
|
8615
|
-
* method chaining
|
|
8616
|
-
*/
|
|
8617
|
-
attachSelectionChange(
|
|
8618
|
-
/**
|
|
8619
|
-
* The function to be called when the event occurs
|
|
8620
|
-
*/
|
|
8621
|
-
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
8622
|
-
/**
|
|
8623
|
-
* The context object to call the event handler with. Defaults to this `this` control
|
|
8624
|
-
*/
|
|
8625
|
-
oListener?: object
|
|
8626
|
-
): this;
|
|
8627
|
-
/**
|
|
8628
|
-
* Clears the selection.
|
|
8629
|
-
*
|
|
8630
|
-
* @since 1.142.0
|
|
8631
|
-
*/
|
|
8632
|
-
clearSelection(): void;
|
|
8633
|
-
/**
|
|
8634
|
-
*
|
|
8635
|
-
* @returns Reference to sap.fe.macros.Table to allow
|
|
8636
|
-
* method chaining
|
|
8637
|
-
*/
|
|
8638
|
-
detachBeforeRebindTable(
|
|
8639
|
-
/**
|
|
8640
|
-
* The function to be called when the event occurs
|
|
8641
|
-
*/
|
|
8642
|
-
fnFunction: (p1: Table$BeforeRebindTableEvent) => void,
|
|
8643
|
-
/**
|
|
8644
|
-
* The context object to call the event handler with. Defaults to this `this` control
|
|
8645
|
-
*/
|
|
8646
|
-
oListener?: object
|
|
8647
|
-
): this;
|
|
8648
|
-
/**
|
|
8649
|
-
*
|
|
8650
|
-
* @returns Reference to sap.fe.macros.Table to allow
|
|
8651
|
-
* method chaining
|
|
9135
|
+
* @returns Reference to sap.fe.macros.MicroChart
|
|
9136
|
+
* to allow method chaining
|
|
8652
9137
|
*/
|
|
8653
|
-
|
|
9138
|
+
attachTitlePress(
|
|
8654
9139
|
/**
|
|
8655
9140
|
* The function to be called when the event occurs
|
|
8656
9141
|
*/
|
|
@@ -8662,10 +9147,10 @@ declare namespace sap {
|
|
|
8662
9147
|
): this;
|
|
8663
9148
|
/**
|
|
8664
9149
|
*
|
|
8665
|
-
* @returns Reference to sap.fe.macros.
|
|
8666
|
-
* method chaining
|
|
9150
|
+
* @returns Reference to sap.fe.macros.MicroChart
|
|
9151
|
+
* to allow method chaining
|
|
8667
9152
|
*/
|
|
8668
|
-
|
|
9153
|
+
detachTitlePress(
|
|
8669
9154
|
/**
|
|
8670
9155
|
* The function to be called when the event occurs
|
|
8671
9156
|
*/
|
|
@@ -8676,237 +9161,313 @@ declare namespace sap {
|
|
|
8676
9161
|
oListener?: object
|
|
8677
9162
|
): this;
|
|
8678
9163
|
/**
|
|
8679
|
-
* Fires event
|
|
9164
|
+
* Fires event titlePress
|
|
8680
9165
|
* to attached listeners.
|
|
8681
9166
|
*
|
|
8682
9167
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
8683
9168
|
*
|
|
8684
|
-
* @returns Reference to sap.fe.macros.
|
|
8685
|
-
* method chaining
|
|
9169
|
+
* @returns Reference to sap.fe.macros.MicroChart
|
|
9170
|
+
* to allow method chaining
|
|
8686
9171
|
*/
|
|
8687
|
-
|
|
9172
|
+
fireTitlePress(
|
|
8688
9173
|
/**
|
|
8689
9174
|
* The parameters to pass along with the event.
|
|
8690
|
-
* See {@link types.EventHandler>
|
|
8691
|
-
*
|
|
9175
|
+
* See {@link types.EventHandler>} for the set of parameters that are
|
|
9176
|
+
* expected by the event handlers.
|
|
8692
9177
|
*/
|
|
8693
|
-
mParameters?:
|
|
9178
|
+
mParameters?: {}
|
|
8694
9179
|
): this;
|
|
8695
9180
|
/**
|
|
8696
|
-
*
|
|
8697
|
-
* listeners.
|
|
9181
|
+
* Gets current value of property contextPath.
|
|
8698
9182
|
*
|
|
8699
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
8700
9183
|
*
|
|
8701
|
-
* @returns
|
|
8702
|
-
* method chaining
|
|
9184
|
+
* @returns Value of property `contextPath`
|
|
8703
9185
|
*/
|
|
8704
|
-
|
|
8705
|
-
/**
|
|
8706
|
-
* The parameters to pass along with the event.
|
|
8707
|
-
* See {@link types.EventHandler> }
|
|
8708
|
-
* for the set of parameters that are expected by the event handlers.
|
|
8709
|
-
*/
|
|
8710
|
-
mParameters?: {}
|
|
8711
|
-
): this;
|
|
9186
|
+
getContextPath(): string;
|
|
8712
9187
|
/**
|
|
8713
|
-
*
|
|
8714
|
-
* to attached listeners.
|
|
9188
|
+
* Gets current value of property hideOnNoData.
|
|
8715
9189
|
*
|
|
8716
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
8717
9190
|
*
|
|
8718
|
-
* @returns
|
|
8719
|
-
* method chaining
|
|
9191
|
+
* @returns Value of property `hideOnNoData`
|
|
8720
9192
|
*/
|
|
8721
|
-
|
|
8722
|
-
/**
|
|
8723
|
-
* The parameters to pass along with the event.
|
|
8724
|
-
* See {@link types.EventHandler>} for the set of parameters that
|
|
8725
|
-
* are expected by the event handlers.
|
|
8726
|
-
*/
|
|
8727
|
-
mParameters?: {}
|
|
8728
|
-
): this;
|
|
9193
|
+
getHideOnNoData(): boolean;
|
|
8729
9194
|
/**
|
|
8730
|
-
*
|
|
8731
|
-
* See also the {@link sap.ui.model.odata.v4.ODataListBinding#getAllCurrentContexts } method.
|
|
9195
|
+
* Gets current value of property linkAriaText.
|
|
8732
9196
|
*
|
|
8733
9197
|
*
|
|
8734
|
-
* @
|
|
9198
|
+
* @returns Value of property `linkAriaText`
|
|
9199
|
+
*/
|
|
9200
|
+
getLinkAriaText(): string;
|
|
9201
|
+
/**
|
|
9202
|
+
* Gets current value of property metaPath.
|
|
8735
9203
|
*
|
|
8736
|
-
*
|
|
9204
|
+
*
|
|
9205
|
+
* @returns Value of property `metaPath`
|
|
8737
9206
|
*/
|
|
8738
|
-
|
|
9207
|
+
getMetaPath(): string;
|
|
8739
9208
|
/**
|
|
8740
|
-
*
|
|
9209
|
+
* Gets current value of property showOnlyChart.
|
|
8741
9210
|
*
|
|
8742
9211
|
*
|
|
8743
|
-
* @returns
|
|
9212
|
+
* @returns Value of property `showOnlyChart`
|
|
8744
9213
|
*/
|
|
8745
|
-
|
|
9214
|
+
getShowOnlyChart(): boolean;
|
|
8746
9215
|
/**
|
|
8747
|
-
*
|
|
9216
|
+
* Gets current value of property size.
|
|
8748
9217
|
*
|
|
8749
9218
|
*
|
|
8750
|
-
* @returns
|
|
9219
|
+
* @returns Value of property `size`
|
|
8751
9220
|
*/
|
|
8752
|
-
|
|
9221
|
+
getSize(): string;
|
|
8753
9222
|
/**
|
|
8754
|
-
*
|
|
9223
|
+
* Gets current value of property titleAsLink.
|
|
8755
9224
|
*
|
|
8756
|
-
* @since 1.124.0
|
|
8757
|
-
* @experimental As of version 1.124.0.
|
|
8758
9225
|
*
|
|
8759
|
-
* @returns
|
|
9226
|
+
* @returns Value of property `titleAsLink`
|
|
8760
9227
|
*/
|
|
8761
|
-
|
|
9228
|
+
getTitleAsLink(): boolean;
|
|
8762
9229
|
/**
|
|
8763
|
-
*
|
|
9230
|
+
* Gets current value of property contextPath.
|
|
8764
9231
|
*
|
|
8765
9232
|
*
|
|
8766
|
-
* @returns
|
|
9233
|
+
* @returns Value of property `contextPath`
|
|
8767
9234
|
*/
|
|
8768
|
-
|
|
9235
|
+
setContextPath(): string;
|
|
8769
9236
|
/**
|
|
8770
|
-
* Gets
|
|
9237
|
+
* Gets current value of property hideOnNoData.
|
|
8771
9238
|
*
|
|
8772
9239
|
*
|
|
8773
|
-
* @returns
|
|
9240
|
+
* @returns Value of property `hideOnNoData`
|
|
8774
9241
|
*/
|
|
8775
|
-
|
|
9242
|
+
setHideOnNoData(): boolean;
|
|
8776
9243
|
/**
|
|
8777
|
-
*
|
|
8778
|
-
* at the control level.
|
|
9244
|
+
* Gets current value of property linkAriaText.
|
|
8779
9245
|
*
|
|
8780
9246
|
*
|
|
8781
|
-
* @returns
|
|
9247
|
+
* @returns Value of property `linkAriaText`
|
|
8782
9248
|
*/
|
|
8783
|
-
|
|
9249
|
+
setLinkAriaText(): string;
|
|
8784
9250
|
/**
|
|
8785
|
-
*
|
|
9251
|
+
* Gets current value of property metaPath.
|
|
8786
9252
|
*
|
|
8787
|
-
* @since 1.124.0
|
|
8788
|
-
* @experimental As of version 1.124.0.
|
|
8789
9253
|
*
|
|
8790
|
-
* @returns
|
|
9254
|
+
* @returns Value of property `metaPath`
|
|
8791
9255
|
*/
|
|
8792
|
-
|
|
8793
|
-
/**
|
|
8794
|
-
* The keys for the columns to hide
|
|
8795
|
-
*/
|
|
8796
|
-
columnKeys: string[]
|
|
8797
|
-
): Promise<void>;
|
|
9256
|
+
setMetaPath(): string;
|
|
8798
9257
|
/**
|
|
8799
|
-
*
|
|
9258
|
+
* Gets current value of property showOnlyChart.
|
|
9259
|
+
*
|
|
9260
|
+
*
|
|
9261
|
+
* @returns Value of property `showOnlyChart`
|
|
8800
9262
|
*/
|
|
8801
|
-
|
|
9263
|
+
setShowOnlyChart(): boolean;
|
|
8802
9264
|
/**
|
|
8803
|
-
*
|
|
9265
|
+
* Gets current value of property size.
|
|
8804
9266
|
*
|
|
8805
|
-
* @since 1.145.0
|
|
8806
|
-
* @experimental As of version 1.145.0.
|
|
8807
9267
|
*
|
|
8808
|
-
* @returns
|
|
9268
|
+
* @returns Value of property `size`
|
|
8809
9269
|
*/
|
|
8810
|
-
|
|
8811
|
-
/**
|
|
8812
|
-
* The action to remove, or its index or ID
|
|
8813
|
-
*/
|
|
8814
|
-
action: number | sap.fe.macros.table.Action | string
|
|
8815
|
-
): null | sap.fe.macros.table.Action;
|
|
9270
|
+
setSize(): string;
|
|
8816
9271
|
/**
|
|
8817
|
-
*
|
|
9272
|
+
* Gets current value of property titleAsLink.
|
|
8818
9273
|
*
|
|
8819
|
-
* @since 1.145.0
|
|
8820
|
-
* @experimental As of version 1.145.0.
|
|
8821
9274
|
*
|
|
8822
|
-
* @returns
|
|
9275
|
+
* @returns Value of property `titleAsLink`
|
|
8823
9276
|
*/
|
|
8824
|
-
|
|
8825
|
-
|
|
8826
|
-
|
|
8827
|
-
|
|
8828
|
-
|
|
8829
|
-
|
|
9277
|
+
setTitleAsLink(): boolean;
|
|
9278
|
+
}
|
|
9279
|
+
/**
|
|
9280
|
+
* Building block for creating a MultiValueField based on the metadata provided by OData V4.
|
|
9281
|
+
*
|
|
9282
|
+
*
|
|
9283
|
+
* The MultiValueField can be used to display either a DataField or Property directly. It has to point to
|
|
9284
|
+
* a collection property.
|
|
9285
|
+
*
|
|
9286
|
+
*
|
|
9287
|
+
* Usage example:
|
|
9288
|
+
*
|
|
9289
|
+
* ```javascript
|
|
9290
|
+
*
|
|
9291
|
+
* <macro:MultiValueField
|
|
9292
|
+
* id="SomeUniqueIdentifier"
|
|
9293
|
+
* contextPath="{entitySet>}"
|
|
9294
|
+
* metaPath="{dataField>}"
|
|
9295
|
+
* />
|
|
9296
|
+
* ```
|
|
9297
|
+
*
|
|
9298
|
+
*
|
|
9299
|
+
* @since 1.118.0
|
|
9300
|
+
*/
|
|
9301
|
+
class MultiValueField extends sap.fe.core.buildingBlocks.BuildingBlock {}
|
|
9302
|
+
/**
|
|
9303
|
+
* Building block used to create a custom page with a title and the content. By default, the page includes
|
|
9304
|
+
* a title.
|
|
9305
|
+
*/
|
|
9306
|
+
class Page extends sap.fe.core.buildingBlocks.BuildingBlock {}
|
|
9307
|
+
/**
|
|
9308
|
+
* Building block used to create a paginator control.
|
|
9309
|
+
* Usage example:
|
|
9310
|
+
*
|
|
9311
|
+
* ```javascript
|
|
9312
|
+
*
|
|
9313
|
+
* <macros:Paginator />
|
|
9314
|
+
* ```
|
|
9315
|
+
*
|
|
9316
|
+
*
|
|
9317
|
+
*
|
|
9318
|
+
* @since 1.94.0
|
|
9319
|
+
*/
|
|
9320
|
+
class Paginator extends sap.fe.core.buildingBlocks.BuildingBlock {}
|
|
9321
|
+
/**
|
|
9322
|
+
* Building block that exposes the RichTextEditor UI5 control.
|
|
9323
|
+
* It's used to enter formatted text, and uses the third-party component called TinyMCE.
|
|
9324
|
+
*
|
|
9325
|
+
*
|
|
9326
|
+
* @since 1.117.0
|
|
9327
|
+
*/
|
|
9328
|
+
class RichTextEditor extends sap.fe.core.buildingBlocks.BuildingBlock {}
|
|
9329
|
+
/**
|
|
9330
|
+
* Metadata-driven building block that exposes the RichTextEditor UI5 control.
|
|
9331
|
+
* It's used to enter formatted text and uses the third-party component called TinyMCE.
|
|
9332
|
+
*
|
|
9333
|
+
*
|
|
9334
|
+
* @since 1.117.0
|
|
9335
|
+
*/
|
|
9336
|
+
class RichTextEditorWithMetadata extends sap.fe.macros.RichTextEditor {}
|
|
9337
|
+
/**
|
|
9338
|
+
* Building block used to create the ‘Share’ functionality.
|
|
9339
|
+
*
|
|
9340
|
+
*
|
|
9341
|
+
* Please note that the 'Share in SAP Jam' option is only available on platforms that are integrated with
|
|
9342
|
+
* SAP Jam.
|
|
9343
|
+
*
|
|
9344
|
+
*
|
|
9345
|
+
* If you are consuming this macro in an environment where the SAP Fiori launchpad is not available, then
|
|
9346
|
+
* the 'Save as Tile' option is not visible.
|
|
9347
|
+
*
|
|
9348
|
+
* Usage example:
|
|
9349
|
+
*
|
|
9350
|
+
* ```javascript
|
|
9351
|
+
*
|
|
9352
|
+
* <macros:Share
|
|
9353
|
+
* id="someID"
|
|
9354
|
+
* visible="true"
|
|
9355
|
+
* />
|
|
9356
|
+
* ```
|
|
9357
|
+
*
|
|
9358
|
+
* {@link demo:sap/fe/core/fpmExplorer/index.html#/buildingBlocks/features/shareDefault Overview of Building Blocks}
|
|
9359
|
+
*
|
|
9360
|
+
*
|
|
9361
|
+
* @since 1.93.0
|
|
9362
|
+
*/
|
|
9363
|
+
class Share extends sap.fe.core.buildingBlocks.BuildingBlock {}
|
|
9364
|
+
/**
|
|
9365
|
+
* Building block to display a status and criticality.
|
|
9366
|
+
*
|
|
9367
|
+
* @since 1.143.0
|
|
9368
|
+
*/
|
|
9369
|
+
class Status
|
|
9370
|
+
extends sap.fe.core.buildingBlocks.BuildingBlock
|
|
9371
|
+
implements sap.ui.core.IFormContent
|
|
9372
|
+
{
|
|
9373
|
+
__implements__sap_ui_core_IFormContent: boolean;
|
|
9374
|
+
|
|
8830
9375
|
/**
|
|
8831
|
-
*
|
|
9376
|
+
*
|
|
9377
|
+
* @returns Reference to sap.fe.macros.Status to
|
|
9378
|
+
* allow method chaining
|
|
8832
9379
|
*/
|
|
8833
|
-
|
|
9380
|
+
attachPress(
|
|
8834
9381
|
/**
|
|
8835
|
-
*
|
|
9382
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
9383
|
+
* object when firing the event
|
|
8836
9384
|
*/
|
|
8837
|
-
|
|
8838
|
-
): void;
|
|
8839
|
-
/**
|
|
8840
|
-
* Set a variant management to the table.
|
|
8841
|
-
*/
|
|
8842
|
-
setCurrentVariantKey(
|
|
9385
|
+
oData: object,
|
|
8843
9386
|
/**
|
|
8844
|
-
*
|
|
8845
|
-
* ignored.
|
|
9387
|
+
* The function to be called when the event occurs
|
|
8846
9388
|
*/
|
|
8847
|
-
|
|
8848
|
-
): void;
|
|
8849
|
-
/**
|
|
8850
|
-
* Sets the fields that should be ignored when generating the table.
|
|
8851
|
-
*
|
|
8852
|
-
* @since 1.124.0
|
|
8853
|
-
* @experimental As of version 1.124.0.
|
|
8854
|
-
*
|
|
8855
|
-
* @returns Reference to this to allow method chaining
|
|
8856
|
-
*/
|
|
8857
|
-
setIgnoredFields(
|
|
9389
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
8858
9390
|
/**
|
|
8859
|
-
* The
|
|
9391
|
+
* The context object to call the event handler with. Defaults to this `this` control
|
|
8860
9392
|
*/
|
|
8861
|
-
|
|
9393
|
+
oListener?: object
|
|
8862
9394
|
): this;
|
|
8863
9395
|
/**
|
|
8864
|
-
*
|
|
9396
|
+
*
|
|
9397
|
+
* @returns Reference to sap.fe.macros.Status to
|
|
9398
|
+
* allow method chaining
|
|
8865
9399
|
*/
|
|
8866
|
-
|
|
9400
|
+
attachPress(
|
|
8867
9401
|
/**
|
|
8868
|
-
* The
|
|
9402
|
+
* The function to be called when the event occurs
|
|
8869
9403
|
*/
|
|
8870
|
-
|
|
8871
|
-
|
|
9404
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
9405
|
+
/**
|
|
9406
|
+
* The context object to call the event handler with. Defaults to this `this` control
|
|
9407
|
+
*/
|
|
9408
|
+
oListener?: object
|
|
9409
|
+
): this;
|
|
8872
9410
|
/**
|
|
8873
|
-
* Sets {@link sap.fe.navigation.SelectionVariant } to the table. Note: setSelectionVariant will clear existing
|
|
8874
|
-
* filters and then apply the SelectionVariant values.
|
|
8875
9411
|
*
|
|
8876
|
-
*
|
|
8877
|
-
*
|
|
9412
|
+
* @returns Reference to sap.fe.macros.Status to
|
|
9413
|
+
* allow method chaining
|
|
8878
9414
|
*/
|
|
8879
|
-
|
|
9415
|
+
detachPress(
|
|
8880
9416
|
/**
|
|
8881
|
-
* The
|
|
9417
|
+
* The function to be called when the event occurs
|
|
8882
9418
|
*/
|
|
8883
|
-
|
|
9419
|
+
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
8884
9420
|
/**
|
|
8885
|
-
*
|
|
8886
|
-
* to display the filter value descriptions, instead of loading them from the backend
|
|
9421
|
+
* The context object to call the event handler with. Defaults to this `this` control
|
|
8887
9422
|
*/
|
|
8888
|
-
|
|
8889
|
-
):
|
|
9423
|
+
oListener?: object
|
|
9424
|
+
): this;
|
|
8890
9425
|
/**
|
|
8891
|
-
*
|
|
9426
|
+
* Fires event press to attached listeners.
|
|
8892
9427
|
*
|
|
8893
|
-
* @
|
|
8894
|
-
* @experimental As of version 1.124.0.
|
|
9428
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
8895
9429
|
*
|
|
8896
|
-
* @returns
|
|
9430
|
+
* @returns Reference to sap.fe.macros.Status to
|
|
9431
|
+
* allow method chaining
|
|
8897
9432
|
*/
|
|
8898
|
-
|
|
9433
|
+
firePress(
|
|
8899
9434
|
/**
|
|
8900
|
-
* The
|
|
9435
|
+
* The parameters to pass along with the event.
|
|
8901
9436
|
*/
|
|
8902
|
-
|
|
8903
|
-
):
|
|
9437
|
+
mParameters?: {}
|
|
9438
|
+
): this;
|
|
8904
9439
|
}
|
|
8905
9440
|
/**
|
|
8906
|
-
* Building block used to create a
|
|
8907
|
-
*
|
|
9441
|
+
* Building block used to create a table based on the metadata provided by OData V4.
|
|
9442
|
+
*
|
|
9443
|
+
*
|
|
9444
|
+
* Usually, a LineItem, PresentationVariant, or SelectionPresentationVariant annotation is expected, but
|
|
9445
|
+
* the Table building block can also be used to display an EntitySet.
|
|
9446
|
+
*
|
|
9447
|
+
*
|
|
9448
|
+
* If a PresentationVariant is specified, then it must have UI.LineItem as the first property of the Visualizations.
|
|
9449
|
+
*
|
|
9450
|
+
*
|
|
9451
|
+
* If a SelectionPresentationVariant is specified, then it must contain a valid PresentationVariant that
|
|
9452
|
+
* also has a UI.LineItem as the first property of the Visualizations.
|
|
9453
|
+
* Usage example:
|
|
9454
|
+
*
|
|
9455
|
+
* ```javascript
|
|
9456
|
+
*
|
|
9457
|
+
* <macros:Table id="MyTable" metaPath="@com.sap.vocabularies.UI.v1.LineItem" />
|
|
9458
|
+
* ```
|
|
9459
|
+
*
|
|
9460
|
+
* {@link demo:sap/fe/core/fpmExplorer/index.html#/buildingBlocks/table/tableDefault Overview of Table Building Blocks}
|
|
8908
9461
|
*/
|
|
8909
|
-
class
|
|
9462
|
+
class Table
|
|
9463
|
+
extends sap.fe.macros.MacroAPI
|
|
9464
|
+
implements
|
|
9465
|
+
/* was: sap.fe.core.IRowBindingInterface */ Object,
|
|
9466
|
+
/* was: sap.fe.macros.Table.ITableBlock */ Object
|
|
9467
|
+
{
|
|
9468
|
+
__implements__sap_fe_core_IRowBindingInterface: boolean;
|
|
9469
|
+
__implements__sap_fe_macros_Table_ITableBlock: boolean;
|
|
9470
|
+
|
|
8910
9471
|
/**
|
|
8911
9472
|
* Adds an action to the table.
|
|
8912
9473
|
*
|
|
@@ -8980,7 +9541,7 @@ declare namespace sap {
|
|
|
8980
9541
|
/**
|
|
8981
9542
|
* The function to be called when the event occurs
|
|
8982
9543
|
*/
|
|
8983
|
-
fnFunction: (p1:
|
|
9544
|
+
fnFunction: (p1: Table$BeforeRebindTableEvent) => void,
|
|
8984
9545
|
/**
|
|
8985
9546
|
* The context object to call the event handler with. Defaults to this `this` control
|
|
8986
9547
|
*/
|
|
@@ -8995,7 +9556,7 @@ declare namespace sap {
|
|
|
8995
9556
|
/**
|
|
8996
9557
|
* The function to be called when the event occurs
|
|
8997
9558
|
*/
|
|
8998
|
-
fnFunction: (p1:
|
|
9559
|
+
fnFunction: (p1: Table$BeforeRebindTableEvent) => void,
|
|
8999
9560
|
/**
|
|
9000
9561
|
* The context object to call the event handler with. Defaults to this `this` control
|
|
9001
9562
|
*/
|
|
@@ -9086,7 +9647,7 @@ declare namespace sap {
|
|
|
9086
9647
|
/**
|
|
9087
9648
|
* The function to be called when the event occurs
|
|
9088
9649
|
*/
|
|
9089
|
-
fnFunction: (p1:
|
|
9650
|
+
fnFunction: (p1: Table$BeforeRebindTableEvent) => void,
|
|
9090
9651
|
/**
|
|
9091
9652
|
* The context object to call the event handler with. Defaults to this `this` control
|
|
9092
9653
|
*/
|
|
@@ -9137,7 +9698,7 @@ declare namespace sap {
|
|
|
9137
9698
|
* See {@link types.EventHandler> }
|
|
9138
9699
|
* for the set of parameters that are expected by the event handlers.
|
|
9139
9700
|
*/
|
|
9140
|
-
mParameters?: sap.fe.macros.
|
|
9701
|
+
mParameters?: sap.fe.macros.Table$BeforeRebindTableEventParameters
|
|
9141
9702
|
): this;
|
|
9142
9703
|
/**
|
|
9143
9704
|
* Fires event rowPress to attached
|
|
@@ -9350,57 +9911,75 @@ declare namespace sap {
|
|
|
9350
9911
|
): Promise<void>;
|
|
9351
9912
|
}
|
|
9352
9913
|
/**
|
|
9353
|
-
* Building block used to create a
|
|
9354
|
-
*
|
|
9355
|
-
*
|
|
9356
|
-
* ```javascript
|
|
9357
|
-
*
|
|
9358
|
-
* <macro:VariantManagement
|
|
9359
|
-
* id="SomeUniqueIdentifier"
|
|
9360
|
-
* for="{listOfControlIds>}"
|
|
9361
|
-
* />
|
|
9362
|
-
* ```
|
|
9363
|
-
*
|
|
9364
|
-
* {@link demo:sap/fe/core/fpmExplorer/index.html#/buildingBlocks/filterBar/filterBarVMWithTable Overview of Building Blocks}
|
|
9365
|
-
*/
|
|
9366
|
-
class VariantManagement extends sap.fe.core.buildingBlocks
|
|
9367
|
-
.BuildingBlock {}
|
|
9368
|
-
/**
|
|
9369
|
-
* Building block for adding overflow toolbar buttons to integrate into the flexible column layout support
|
|
9370
|
-
* from Fiori elements.
|
|
9371
|
-
* Usage example:
|
|
9372
|
-
*
|
|
9373
|
-
* ```javascript
|
|
9374
|
-
*
|
|
9375
|
-
* <macros:FlexibleColumnLayoutActions />
|
|
9376
|
-
* ```
|
|
9377
|
-
*
|
|
9378
|
-
*
|
|
9379
|
-
*
|
|
9380
|
-
* @since 1.93.0
|
|
9381
|
-
*/
|
|
9382
|
-
class FlexibleColumnLayoutActions extends sap.ui.core.Control {}
|
|
9383
|
-
/**
|
|
9384
|
-
* Building block for creating a FilterBar based on the metadata provided by OData V4.
|
|
9385
|
-
* {@link demo:sap/fe/core/fpmExplorer/index.html#/buildingBlocks/filterBar/filterBarDefault Overview of Building Blocks}
|
|
9386
|
-
*
|
|
9387
|
-
*
|
|
9388
|
-
* Usually, a SelectionFields annotation is expected.
|
|
9389
|
-
*
|
|
9390
|
-
* Usage example:
|
|
9391
|
-
*
|
|
9392
|
-
* ```javascript
|
|
9393
|
-
*
|
|
9394
|
-
* <macros:FilterBar id="MyFilterBar" metaPath="@com.sap.vocabularies.UI.v1.SelectionFields" />
|
|
9395
|
-
* ```
|
|
9914
|
+
* Building block used to create a tree table based on the metadata provided by OData V4.
|
|
9915
|
+
* {@link demo:sap/fe/core/fpmExplorer/index.html#/buildingBlocks/table/treeTable Overview of Tree Table Building Block}
|
|
9396
9916
|
*/
|
|
9397
|
-
class
|
|
9917
|
+
class TreeTable extends sap.fe.macros.MacroAPI {
|
|
9398
9918
|
/**
|
|
9919
|
+
* Adds an action to the table.
|
|
9399
9920
|
*
|
|
9400
|
-
* @
|
|
9401
|
-
*
|
|
9921
|
+
* @since 1.145.0
|
|
9922
|
+
* @experimental As of version 1.145.0.
|
|
9923
|
+
*
|
|
9924
|
+
* @returns Reference to this to allow method chaining
|
|
9402
9925
|
*/
|
|
9403
|
-
|
|
9926
|
+
addAction(
|
|
9927
|
+
/**
|
|
9928
|
+
* The action to add
|
|
9929
|
+
*/
|
|
9930
|
+
action: sap.fe.macros.table.Action
|
|
9931
|
+
): this;
|
|
9932
|
+
/**
|
|
9933
|
+
* Adds a column to the table.
|
|
9934
|
+
*
|
|
9935
|
+
* @since 1.145.0
|
|
9936
|
+
* @experimental As of version 1.145.0.
|
|
9937
|
+
*
|
|
9938
|
+
* @returns Reference to this to allow method chaining
|
|
9939
|
+
*/
|
|
9940
|
+
addColumn(
|
|
9941
|
+
/**
|
|
9942
|
+
* The column to add
|
|
9943
|
+
*/
|
|
9944
|
+
column: sap.fe.macros.table.Column
|
|
9945
|
+
): this;
|
|
9946
|
+
/**
|
|
9947
|
+
* Adds a message to the table.
|
|
9948
|
+
* The message applies to the whole table and not to an individual table row.
|
|
9949
|
+
*
|
|
9950
|
+
*
|
|
9951
|
+
*
|
|
9952
|
+
* @returns Promise The ID of the message
|
|
9953
|
+
*/
|
|
9954
|
+
addMessage(
|
|
9955
|
+
/**
|
|
9956
|
+
* The parameters to create the message
|
|
9957
|
+
*/
|
|
9958
|
+
parameters: {
|
|
9959
|
+
/**
|
|
9960
|
+
* Message description
|
|
9961
|
+
*/
|
|
9962
|
+
description?: string;
|
|
9963
|
+
/**
|
|
9964
|
+
* Message text
|
|
9965
|
+
*/
|
|
9966
|
+
message?: string;
|
|
9967
|
+
/**
|
|
9968
|
+
* True if the message is persistent
|
|
9969
|
+
*/
|
|
9970
|
+
persistent?: boolean;
|
|
9971
|
+
/**
|
|
9972
|
+
* Message type
|
|
9973
|
+
*/
|
|
9974
|
+
type?: /* was: sap.ui.core.message.MessageType */ any;
|
|
9975
|
+
}
|
|
9976
|
+
): Promise<string>;
|
|
9977
|
+
/**
|
|
9978
|
+
*
|
|
9979
|
+
* @returns Reference to sap.fe.macros.Table to allow
|
|
9980
|
+
* method chaining
|
|
9981
|
+
*/
|
|
9982
|
+
attachBeforeRebindTable(
|
|
9404
9983
|
/**
|
|
9405
9984
|
* An application-specific payload object that will be passed to the event handler along with the event
|
|
9406
9985
|
* object when firing the event
|
|
@@ -9409,7 +9988,7 @@ declare namespace sap {
|
|
|
9409
9988
|
/**
|
|
9410
9989
|
* The function to be called when the event occurs
|
|
9411
9990
|
*/
|
|
9412
|
-
fnFunction: (p1:
|
|
9991
|
+
fnFunction: (p1: TreeTable$BeforeRebindTableEvent) => void,
|
|
9413
9992
|
/**
|
|
9414
9993
|
* The context object to call the event handler with. Defaults to this `this` control
|
|
9415
9994
|
*/
|
|
@@ -9417,14 +9996,14 @@ declare namespace sap {
|
|
|
9417
9996
|
): this;
|
|
9418
9997
|
/**
|
|
9419
9998
|
*
|
|
9420
|
-
* @returns Reference to sap.fe.macros.
|
|
9421
|
-
*
|
|
9999
|
+
* @returns Reference to sap.fe.macros.Table to allow
|
|
10000
|
+
* method chaining
|
|
9422
10001
|
*/
|
|
9423
|
-
|
|
10002
|
+
attachBeforeRebindTable(
|
|
9424
10003
|
/**
|
|
9425
10004
|
* The function to be called when the event occurs
|
|
9426
10005
|
*/
|
|
9427
|
-
fnFunction: (p1:
|
|
10006
|
+
fnFunction: (p1: TreeTable$BeforeRebindTableEvent) => void,
|
|
9428
10007
|
/**
|
|
9429
10008
|
* The context object to call the event handler with. Defaults to this `this` control
|
|
9430
10009
|
*/
|
|
@@ -9432,10 +10011,10 @@ declare namespace sap {
|
|
|
9432
10011
|
): this;
|
|
9433
10012
|
/**
|
|
9434
10013
|
*
|
|
9435
|
-
* @returns Reference to sap.fe.macros.
|
|
9436
|
-
*
|
|
10014
|
+
* @returns Reference to sap.fe.macros.Table to allow
|
|
10015
|
+
* method chaining
|
|
9437
10016
|
*/
|
|
9438
|
-
|
|
10017
|
+
attachRowPress(
|
|
9439
10018
|
/**
|
|
9440
10019
|
* An application-specific payload object that will be passed to the event handler along with the event
|
|
9441
10020
|
* object when firing the event
|
|
@@ -9452,10 +10031,10 @@ declare namespace sap {
|
|
|
9452
10031
|
): this;
|
|
9453
10032
|
/**
|
|
9454
10033
|
*
|
|
9455
|
-
* @returns Reference to sap.fe.macros.
|
|
9456
|
-
*
|
|
10034
|
+
* @returns Reference to sap.fe.macros.Table to allow
|
|
10035
|
+
* method chaining
|
|
9457
10036
|
*/
|
|
9458
|
-
|
|
10037
|
+
attachRowPress(
|
|
9459
10038
|
/**
|
|
9460
10039
|
* The function to be called when the event occurs
|
|
9461
10040
|
*/
|
|
@@ -9467,10 +10046,10 @@ declare namespace sap {
|
|
|
9467
10046
|
): this;
|
|
9468
10047
|
/**
|
|
9469
10048
|
*
|
|
9470
|
-
* @returns Reference to sap.fe.macros.
|
|
9471
|
-
*
|
|
10049
|
+
* @returns Reference to sap.fe.macros.Table to allow
|
|
10050
|
+
* method chaining
|
|
9472
10051
|
*/
|
|
9473
|
-
|
|
10052
|
+
attachSelectionChange(
|
|
9474
10053
|
/**
|
|
9475
10054
|
* An application-specific payload object that will be passed to the event handler along with the event
|
|
9476
10055
|
* object when firing the event
|
|
@@ -9487,10 +10066,10 @@ declare namespace sap {
|
|
|
9487
10066
|
): this;
|
|
9488
10067
|
/**
|
|
9489
10068
|
*
|
|
9490
|
-
* @returns Reference to sap.fe.macros.
|
|
9491
|
-
*
|
|
10069
|
+
* @returns Reference to sap.fe.macros.Table to allow
|
|
10070
|
+
* method chaining
|
|
9492
10071
|
*/
|
|
9493
|
-
|
|
10072
|
+
attachSelectionChange(
|
|
9494
10073
|
/**
|
|
9495
10074
|
* The function to be called when the event occurs
|
|
9496
10075
|
*/
|
|
@@ -9501,15 +10080,21 @@ declare namespace sap {
|
|
|
9501
10080
|
oListener?: object
|
|
9502
10081
|
): this;
|
|
9503
10082
|
/**
|
|
10083
|
+
* Clears the selection.
|
|
9504
10084
|
*
|
|
9505
|
-
* @
|
|
9506
|
-
* to allow method chaining
|
|
10085
|
+
* @since 1.142.0
|
|
9507
10086
|
*/
|
|
9508
|
-
|
|
10087
|
+
clearSelection(): void;
|
|
10088
|
+
/**
|
|
10089
|
+
*
|
|
10090
|
+
* @returns Reference to sap.fe.macros.Table to allow
|
|
10091
|
+
* method chaining
|
|
10092
|
+
*/
|
|
10093
|
+
detachBeforeRebindTable(
|
|
9509
10094
|
/**
|
|
9510
10095
|
* The function to be called when the event occurs
|
|
9511
10096
|
*/
|
|
9512
|
-
fnFunction: (p1:
|
|
10097
|
+
fnFunction: (p1: TreeTable$BeforeRebindTableEvent) => void,
|
|
9513
10098
|
/**
|
|
9514
10099
|
* The context object to call the event handler with. Defaults to this `this` control
|
|
9515
10100
|
*/
|
|
@@ -9517,10 +10102,10 @@ declare namespace sap {
|
|
|
9517
10102
|
): this;
|
|
9518
10103
|
/**
|
|
9519
10104
|
*
|
|
9520
|
-
* @returns Reference to sap.fe.macros.
|
|
9521
|
-
*
|
|
10105
|
+
* @returns Reference to sap.fe.macros.Table to allow
|
|
10106
|
+
* method chaining
|
|
9522
10107
|
*/
|
|
9523
|
-
|
|
10108
|
+
detachRowPress(
|
|
9524
10109
|
/**
|
|
9525
10110
|
* The function to be called when the event occurs
|
|
9526
10111
|
*/
|
|
@@ -9532,10 +10117,10 @@ declare namespace sap {
|
|
|
9532
10117
|
): this;
|
|
9533
10118
|
/**
|
|
9534
10119
|
*
|
|
9535
|
-
* @returns Reference to sap.fe.macros.
|
|
9536
|
-
*
|
|
10120
|
+
* @returns Reference to sap.fe.macros.Table to allow
|
|
10121
|
+
* method chaining
|
|
9537
10122
|
*/
|
|
9538
|
-
|
|
10123
|
+
detachSelectionChange(
|
|
9539
10124
|
/**
|
|
9540
10125
|
* The function to be called when the event occurs
|
|
9541
10126
|
*/
|
|
@@ -9546,209 +10131,263 @@ declare namespace sap {
|
|
|
9546
10131
|
oListener?: object
|
|
9547
10132
|
): this;
|
|
9548
10133
|
/**
|
|
9549
|
-
* Fires event
|
|
9550
|
-
* attached listeners.
|
|
10134
|
+
* Fires event beforeRebindTable
|
|
10135
|
+
* to attached listeners.
|
|
9551
10136
|
*
|
|
9552
10137
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
9553
10138
|
*
|
|
9554
|
-
* @returns Reference to sap.fe.macros.
|
|
9555
|
-
*
|
|
10139
|
+
* @returns Reference to sap.fe.macros.Table to allow
|
|
10140
|
+
* method chaining
|
|
9556
10141
|
*/
|
|
9557
|
-
|
|
10142
|
+
fireBeforeRebindTable(
|
|
9558
10143
|
/**
|
|
9559
10144
|
* The parameters to pass along with the event.
|
|
9560
|
-
* See {@link
|
|
10145
|
+
* See {@link types.EventHandler> }
|
|
9561
10146
|
* for the set of parameters that are expected by the event handlers.
|
|
9562
10147
|
*/
|
|
9563
|
-
mParameters?:
|
|
10148
|
+
mParameters?: sap.fe.macros.TreeTable$BeforeRebindTableEventParameters
|
|
9564
10149
|
): this;
|
|
9565
10150
|
/**
|
|
9566
|
-
* Fires event
|
|
9567
|
-
*
|
|
10151
|
+
* Fires event rowPress to attached
|
|
10152
|
+
* listeners.
|
|
9568
10153
|
*
|
|
9569
10154
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
9570
10155
|
*
|
|
9571
|
-
* @returns Reference to sap.fe.macros.
|
|
9572
|
-
*
|
|
10156
|
+
* @returns Reference to sap.fe.macros.Table to allow
|
|
10157
|
+
* method chaining
|
|
9573
10158
|
*/
|
|
9574
|
-
|
|
10159
|
+
fireRowPress(
|
|
9575
10160
|
/**
|
|
9576
10161
|
* The parameters to pass along with the event.
|
|
9577
|
-
* See {@link
|
|
10162
|
+
* See {@link types.EventHandler> }
|
|
9578
10163
|
* for the set of parameters that are expected by the event handlers.
|
|
9579
10164
|
*/
|
|
9580
10165
|
mParameters?: {}
|
|
9581
10166
|
): this;
|
|
9582
10167
|
/**
|
|
9583
|
-
* Fires event
|
|
9584
|
-
* listeners.
|
|
10168
|
+
* Fires event selectionChange
|
|
10169
|
+
* to attached listeners.
|
|
9585
10170
|
*
|
|
9586
10171
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
9587
10172
|
*
|
|
9588
|
-
* @returns Reference to sap.fe.macros.
|
|
9589
|
-
*
|
|
10173
|
+
* @returns Reference to sap.fe.macros.Table to allow
|
|
10174
|
+
* method chaining
|
|
9590
10175
|
*/
|
|
9591
|
-
|
|
10176
|
+
fireSelectionChange(
|
|
9592
10177
|
/**
|
|
9593
10178
|
* The parameters to pass along with the event.
|
|
9594
|
-
* See {@link
|
|
9595
|
-
*
|
|
10179
|
+
* See {@link types.EventHandler>} for the set of parameters that
|
|
10180
|
+
* are expected by the event handlers.
|
|
9596
10181
|
*/
|
|
9597
10182
|
mParameters?: {}
|
|
9598
10183
|
): this;
|
|
9599
10184
|
/**
|
|
9600
|
-
*
|
|
10185
|
+
* Returns all contexts that are loaded in the table.
|
|
10186
|
+
* See also the {@link sap.ui.model.odata.v4.ODataListBinding#getAllCurrentContexts } method.
|
|
10187
|
+
*
|
|
10188
|
+
*
|
|
10189
|
+
* @since 1.142.0
|
|
10190
|
+
*
|
|
10191
|
+
* @returns All contexts of the table's list binding, or undefined if the table data is not yet loaded.
|
|
10192
|
+
*/
|
|
10193
|
+
getAllCurrentContexts(): sap.ui.model.odata.v4.Context[] | undefined;
|
|
10194
|
+
/**
|
|
10195
|
+
* Get the count of the row binding of the table.
|
|
10196
|
+
*
|
|
10197
|
+
*
|
|
10198
|
+
* @returns The count of the row binding
|
|
10199
|
+
*/
|
|
10200
|
+
getCount(): number | undefined;
|
|
10201
|
+
/**
|
|
10202
|
+
* Get the variant management applied to the table.
|
|
10203
|
+
*
|
|
10204
|
+
*
|
|
10205
|
+
* @returns Key of the currently selected variant. In case the model is not yet set, `null` will be returned.
|
|
10206
|
+
*/
|
|
10207
|
+
getCurrentVariantKey(): null | string;
|
|
10208
|
+
/**
|
|
10209
|
+
* Get the fields that should be ignored when generating the table.
|
|
10210
|
+
*
|
|
10211
|
+
* @since 1.124.0
|
|
10212
|
+
* @experimental As of version 1.124.0.
|
|
10213
|
+
*
|
|
10214
|
+
* @returns The value of the ignoredFields property
|
|
10215
|
+
*/
|
|
10216
|
+
getIgnoredFields(): string;
|
|
10217
|
+
/**
|
|
10218
|
+
* Get the presentation variant that is currently applied on the table.
|
|
9601
10219
|
*
|
|
9602
10220
|
*
|
|
9603
|
-
* @returns
|
|
10221
|
+
* @returns The presentation variant applied to the table
|
|
9604
10222
|
*/
|
|
9605
|
-
|
|
10223
|
+
getPresentationVariant(): Promise<sap.fe.navigation.PresentationVariant>;
|
|
9606
10224
|
/**
|
|
9607
|
-
* Gets the
|
|
10225
|
+
* Gets contexts from the table that have been selected by the user.
|
|
9608
10226
|
*
|
|
9609
10227
|
*
|
|
9610
|
-
* @returns
|
|
10228
|
+
* @returns Contexts of the rows selected by the user
|
|
9611
10229
|
*/
|
|
9612
|
-
|
|
10230
|
+
getSelectedContexts(): sap.ui.model.odata.v4.Context[];
|
|
9613
10231
|
/**
|
|
9614
|
-
*
|
|
10232
|
+
* Get the selection variant from the table. This function considers only the selection variant applied
|
|
10233
|
+
* at the control level.
|
|
9615
10234
|
*
|
|
9616
10235
|
*
|
|
9617
|
-
* @returns
|
|
10236
|
+
* @returns A promise which resolves with {@link sap.fe.navigation.SelectionVariant}
|
|
9618
10237
|
*/
|
|
9619
|
-
|
|
9620
|
-
/**
|
|
9621
|
-
* Name of the field.
|
|
9622
|
-
*/
|
|
9623
|
-
name: string
|
|
9624
|
-
): boolean;
|
|
10238
|
+
getSelectionVariant(): Promise<sap.fe.navigation.SelectionVariant>;
|
|
9625
10239
|
/**
|
|
9626
|
-
*
|
|
10240
|
+
* Hide the columns with the given column keys by setting their availability to Default.
|
|
9627
10241
|
*
|
|
10242
|
+
* @since 1.124.0
|
|
10243
|
+
* @experimental As of version 1.124.0.
|
|
9628
10244
|
*
|
|
9629
|
-
* @returns
|
|
10245
|
+
* @returns Promise
|
|
9630
10246
|
*/
|
|
9631
|
-
|
|
10247
|
+
hideColumns(
|
|
9632
10248
|
/**
|
|
9633
|
-
* The
|
|
10249
|
+
* The keys for the columns to hide
|
|
9634
10250
|
*/
|
|
9635
|
-
|
|
9636
|
-
): Promise<
|
|
10251
|
+
columnKeys: string[]
|
|
10252
|
+
): Promise<void>;
|
|
9637
10253
|
/**
|
|
9638
|
-
*
|
|
9639
|
-
|
|
10254
|
+
* Requests a refresh of the table.
|
|
10255
|
+
*/
|
|
10256
|
+
refresh(): void;
|
|
10257
|
+
/**
|
|
10258
|
+
* Removes an action from the table.
|
|
9640
10259
|
*
|
|
10260
|
+
* @since 1.145.0
|
|
10261
|
+
* @experimental As of version 1.145.0.
|
|
9641
10262
|
*
|
|
9642
|
-
* @returns
|
|
10263
|
+
* @returns The removed action or null
|
|
9643
10264
|
*/
|
|
9644
|
-
|
|
10265
|
+
removeAction(
|
|
10266
|
+
/**
|
|
10267
|
+
* The action to remove, or its index or ID
|
|
10268
|
+
*/
|
|
10269
|
+
action: number | sap.fe.macros.table.Action | string
|
|
10270
|
+
): null | sap.fe.macros.table.Action;
|
|
9645
10271
|
/**
|
|
9646
|
-
*
|
|
9647
|
-
* Note: This method returns all the filter values that are set in the filter bar, including the text from
|
|
9648
|
-
* the search field (with $search as the property name). However, it doesn't return any filter field condition
|
|
9649
|
-
* that uses a custom operator.
|
|
10272
|
+
* Removes a column from the table.
|
|
9650
10273
|
*
|
|
10274
|
+
* @since 1.145.0
|
|
10275
|
+
* @experimental As of version 1.145.0.
|
|
9651
10276
|
*
|
|
9652
|
-
* @returns
|
|
10277
|
+
* @returns The removed column or null
|
|
9653
10278
|
*/
|
|
9654
|
-
|
|
10279
|
+
removeColumn(
|
|
10280
|
+
/**
|
|
10281
|
+
* The column to remove, or its index or ID
|
|
10282
|
+
*/
|
|
10283
|
+
column: number | sap.fe.macros.table.Column | string
|
|
10284
|
+
): null | sap.fe.macros.table.Column;
|
|
9655
10285
|
/**
|
|
9656
|
-
*
|
|
10286
|
+
* Removes a message from the table.
|
|
9657
10287
|
*/
|
|
9658
|
-
|
|
10288
|
+
removeMessage(
|
|
9659
10289
|
/**
|
|
9660
|
-
*
|
|
9661
|
-
* ignored.
|
|
10290
|
+
* The id of the message
|
|
9662
10291
|
*/
|
|
9663
|
-
|
|
10292
|
+
id: string
|
|
9664
10293
|
): void;
|
|
9665
10294
|
/**
|
|
9666
|
-
*
|
|
10295
|
+
* Set a variant management to the table.
|
|
9667
10296
|
*/
|
|
9668
|
-
|
|
9669
|
-
/**
|
|
9670
|
-
* Name of the field that should be enabled or disabled.
|
|
9671
|
-
*/
|
|
9672
|
-
name: string,
|
|
10297
|
+
setCurrentVariantKey(
|
|
9673
10298
|
/**
|
|
9674
|
-
*
|
|
10299
|
+
* Key of the variant that should be selected. If the passed key doesn't identify a variant, it will be
|
|
10300
|
+
* ignored.
|
|
9675
10301
|
*/
|
|
9676
|
-
|
|
10302
|
+
key: string
|
|
9677
10303
|
): void;
|
|
9678
10304
|
/**
|
|
9679
|
-
*
|
|
9680
|
-
* The property will not be hidden inside the adaptation dialog and may be re-added.
|
|
10305
|
+
* Sets the fields that should be ignored when generating the table.
|
|
9681
10306
|
*
|
|
10307
|
+
* @since 1.124.0
|
|
10308
|
+
* @experimental As of version 1.124.0.
|
|
9682
10309
|
*
|
|
9683
|
-
* @returns
|
|
10310
|
+
* @returns Reference to this to allow method chaining
|
|
9684
10311
|
*/
|
|
9685
|
-
|
|
9686
|
-
/**
|
|
9687
|
-
* The path to the property as a condition path
|
|
9688
|
-
*/
|
|
9689
|
-
conditionPath: string,
|
|
10312
|
+
setIgnoredFields(
|
|
9690
10313
|
/**
|
|
9691
|
-
*
|
|
10314
|
+
* The fields to ignore
|
|
9692
10315
|
*/
|
|
9693
|
-
|
|
9694
|
-
):
|
|
10316
|
+
ignoredFields: string
|
|
10317
|
+
): this;
|
|
9695
10318
|
/**
|
|
9696
|
-
* Set
|
|
9697
|
-
* The filter values can be either a single value or an array of values.
|
|
9698
|
-
* Each filter value must be represented as a primitive value.
|
|
9699
|
-
*
|
|
9700
|
-
*
|
|
9701
|
-
* @returns A promise for asynchronous handling
|
|
10319
|
+
* Set a new presentation variant to the table.
|
|
9702
10320
|
*/
|
|
9703
|
-
|
|
9704
|
-
/**
|
|
9705
|
-
* The path to the property as a condition path
|
|
9706
|
-
*/
|
|
9707
|
-
sConditionPath: string,
|
|
9708
|
-
/**
|
|
9709
|
-
* The operator to be used (optional) - if not set, the default operator (EQ) will be used
|
|
9710
|
-
*/
|
|
9711
|
-
sOperator: string | undefined,
|
|
10321
|
+
setPresentationVariant(
|
|
9712
10322
|
/**
|
|
9713
|
-
* The
|
|
10323
|
+
* The new presentation variant that is to be set on the table.
|
|
9714
10324
|
*/
|
|
9715
|
-
|
|
9716
|
-
| boolean
|
|
9717
|
-
| boolean[]
|
|
9718
|
-
| number
|
|
9719
|
-
| number[]
|
|
9720
|
-
| string
|
|
9721
|
-
| string[]
|
|
9722
|
-
| undefined
|
|
10325
|
+
tablePV: sap.fe.navigation.PresentationVariant
|
|
9723
10326
|
): Promise<void>;
|
|
9724
10327
|
/**
|
|
9725
|
-
* Sets {@link sap.fe.navigation.SelectionVariant } to the
|
|
9726
|
-
*
|
|
9727
|
-
* Note: This method cannot set the search field text or any filter field condition that relies on a custom
|
|
9728
|
-
* operator.
|
|
10328
|
+
* Sets {@link sap.fe.navigation.SelectionVariant } to the table. Note: setSelectionVariant will clear existing
|
|
10329
|
+
* filters and then apply the SelectionVariant values.
|
|
9729
10330
|
*
|
|
9730
10331
|
*
|
|
9731
10332
|
* @returns A promise for asynchronous handling
|
|
9732
10333
|
*/
|
|
9733
10334
|
setSelectionVariant(
|
|
9734
10335
|
/**
|
|
9735
|
-
* The {@link sap.fe.navigation.SelectionVariant} to apply to the
|
|
10336
|
+
* The {@link sap.fe.navigation.SelectionVariant} to apply to the table
|
|
9736
10337
|
*/
|
|
9737
10338
|
selectionVariant: sap.fe.navigation.SelectionVariant,
|
|
9738
10339
|
/**
|
|
9739
|
-
* Optional. If true, we will use the associated text property values (if they're available in the
|
|
10340
|
+
* Optional. If true, we will use the associated text property values (if they're available in the SelectionVariant)
|
|
9740
10341
|
* to display the filter value descriptions, instead of loading them from the backend
|
|
9741
10342
|
*/
|
|
9742
10343
|
prefillDescriptions?: boolean
|
|
9743
10344
|
): Promise<any>;
|
|
9744
10345
|
/**
|
|
9745
|
-
*
|
|
10346
|
+
* Show the columns with the given column keys by setting their availability to Default.
|
|
9746
10347
|
*
|
|
10348
|
+
* @since 1.124.0
|
|
10349
|
+
* @experimental As of version 1.124.0.
|
|
9747
10350
|
*
|
|
9748
|
-
* @returns
|
|
10351
|
+
* @returns Promise
|
|
9749
10352
|
*/
|
|
9750
|
-
|
|
10353
|
+
showColumns(
|
|
10354
|
+
/**
|
|
10355
|
+
* The keys for the columns to show
|
|
10356
|
+
*/
|
|
10357
|
+
columnKeys: string[]
|
|
10358
|
+
): Promise<void>;
|
|
9751
10359
|
}
|
|
10360
|
+
/**
|
|
10361
|
+
* Building block used to create a Variant Management based on the metadata provided by OData V4.
|
|
10362
|
+
* Usage example:
|
|
10363
|
+
*
|
|
10364
|
+
* ```javascript
|
|
10365
|
+
*
|
|
10366
|
+
* <macro:VariantManagement
|
|
10367
|
+
* id="SomeUniqueIdentifier"
|
|
10368
|
+
* for="{listOfControlIds>}"
|
|
10369
|
+
* />
|
|
10370
|
+
* ```
|
|
10371
|
+
*
|
|
10372
|
+
* {@link demo:sap/fe/core/fpmExplorer/index.html#/buildingBlocks/filterBar/filterBarVMWithTable Overview of Building Blocks}
|
|
10373
|
+
*/
|
|
10374
|
+
class VariantManagement extends sap.fe.core.buildingBlocks
|
|
10375
|
+
.BuildingBlock {}
|
|
10376
|
+
/**
|
|
10377
|
+
* Building block for adding overflow toolbar buttons to integrate into the flexible column layout support
|
|
10378
|
+
* from Fiori elements.
|
|
10379
|
+
* Usage example:
|
|
10380
|
+
*
|
|
10381
|
+
* ```javascript
|
|
10382
|
+
*
|
|
10383
|
+
* <macros:FlexibleColumnLayoutActions />
|
|
10384
|
+
* ```
|
|
10385
|
+
*
|
|
10386
|
+
*
|
|
10387
|
+
*
|
|
10388
|
+
* @since 1.93.0
|
|
10389
|
+
*/
|
|
10390
|
+
class FlexibleColumnLayoutActions extends sap.ui.core.Control {}
|
|
9752
10391
|
/**
|
|
9753
10392
|
* Building block for creating a Form based on the metadata provided by OData V4.
|
|
9754
10393
|
*
|
|
@@ -9765,6 +10404,22 @@ declare namespace sap {
|
|
|
9765
10404
|
*/
|
|
9766
10405
|
class Form extends sap.ui.core.Control {}
|
|
9767
10406
|
|
|
10407
|
+
/**
|
|
10408
|
+
* Event object of the AlwaysEditableField#change event.
|
|
10409
|
+
*/
|
|
10410
|
+
type AlwaysEditableField$ChangeEvent = sap.ui.base.Event<
|
|
10411
|
+
AlwaysEditableField$ChangeEventParameters,
|
|
10412
|
+
AlwaysEditableField
|
|
10413
|
+
>;
|
|
10414
|
+
|
|
10415
|
+
/**
|
|
10416
|
+
* Event object of the AlwaysEditableField#liveChange event.
|
|
10417
|
+
*/
|
|
10418
|
+
type AlwaysEditableField$LiveChangeEvent = sap.ui.base.Event<
|
|
10419
|
+
AlwaysEditableField$LiveChangeEventParameters,
|
|
10420
|
+
AlwaysEditableField
|
|
10421
|
+
>;
|
|
10422
|
+
|
|
9768
10423
|
/**
|
|
9769
10424
|
* Event object of the Chart#selectionChange event.
|
|
9770
10425
|
*/
|
|
@@ -9813,6 +10468,30 @@ declare namespace sap {
|
|
|
9813
10468
|
Field
|
|
9814
10469
|
>;
|
|
9815
10470
|
|
|
10471
|
+
/**
|
|
10472
|
+
* Event object of the FilterBar#afterClear event.
|
|
10473
|
+
*/
|
|
10474
|
+
type FilterBar$AfterClearEvent = sap.ui.base.Event<
|
|
10475
|
+
FilterBar$AfterClearEventParameters,
|
|
10476
|
+
FilterBar
|
|
10477
|
+
>;
|
|
10478
|
+
|
|
10479
|
+
/**
|
|
10480
|
+
* Event object of the FilterBar#filterChanged event.
|
|
10481
|
+
*/
|
|
10482
|
+
type FilterBar$FilterChangedEvent = sap.ui.base.Event<
|
|
10483
|
+
FilterBar$FilterChangedEventParameters,
|
|
10484
|
+
FilterBar
|
|
10485
|
+
>;
|
|
10486
|
+
|
|
10487
|
+
/**
|
|
10488
|
+
* Event object of the FilterBar#search event.
|
|
10489
|
+
*/
|
|
10490
|
+
type FilterBar$SearchEvent = sap.ui.base.Event<
|
|
10491
|
+
FilterBar$SearchEventParameters,
|
|
10492
|
+
FilterBar
|
|
10493
|
+
>;
|
|
10494
|
+
|
|
9816
10495
|
/**
|
|
9817
10496
|
* Event object of the KPITag#press event.
|
|
9818
10497
|
*/
|
|
@@ -9892,36 +10571,14 @@ declare namespace sap {
|
|
|
9892
10571
|
TreeTable$SelectionChangeEventParameters,
|
|
9893
10572
|
TreeTable
|
|
9894
10573
|
>;
|
|
9895
|
-
|
|
9896
|
-
/**
|
|
9897
|
-
* Event object of the FilterBar#afterClear event.
|
|
9898
|
-
*/
|
|
9899
|
-
type FilterBar$AfterClearEvent = sap.ui.base.Event<
|
|
9900
|
-
FilterBar$AfterClearEventParameters,
|
|
9901
|
-
FilterBar
|
|
9902
|
-
>;
|
|
9903
|
-
|
|
9904
|
-
/**
|
|
9905
|
-
* Event object of the FilterBar#filterChanged event.
|
|
9906
|
-
*/
|
|
9907
|
-
type FilterBar$FilterChangedEvent = sap.ui.base.Event<
|
|
9908
|
-
FilterBar$FilterChangedEventParameters,
|
|
9909
|
-
FilterBar
|
|
9910
|
-
>;
|
|
9911
|
-
|
|
9912
|
-
/**
|
|
9913
|
-
* Event object of the FilterBar#search event.
|
|
9914
|
-
*/
|
|
9915
|
-
type FilterBar$SearchEvent = sap.ui.base.Event<
|
|
9916
|
-
FilterBar$SearchEventParameters,
|
|
9917
|
-
FilterBar
|
|
9918
|
-
>;
|
|
9919
10574
|
}
|
|
9920
10575
|
}
|
|
9921
10576
|
|
|
9922
10577
|
interface IUI5DefineDependencyNames {
|
|
9923
10578
|
"sap/fe/macros/AINotice": undefined;
|
|
9924
10579
|
|
|
10580
|
+
"sap/fe/macros/AlwaysEditableField": undefined;
|
|
10581
|
+
|
|
9925
10582
|
"sap/fe/macros/Chart": undefined;
|
|
9926
10583
|
|
|
9927
10584
|
"sap/fe/macros/chart/Action": undefined;
|
|
@@ -9956,9 +10613,11 @@ declare namespace sap {
|
|
|
9956
10613
|
|
|
9957
10614
|
"sap/fe/macros/field/FieldFormatOptions": undefined;
|
|
9958
10615
|
|
|
9959
|
-
"sap/fe/macros/
|
|
10616
|
+
"sap/fe/macros/field/mixin/FieldMixin": undefined;
|
|
10617
|
+
|
|
10618
|
+
"sap/fe/macros/FilterBar": undefined;
|
|
9960
10619
|
|
|
9961
|
-
"sap/fe/macros/filterBar/
|
|
10620
|
+
"sap/fe/macros/filterBar/FilterBar": undefined;
|
|
9962
10621
|
|
|
9963
10622
|
"sap/fe/macros/filterBar/FilterField": undefined;
|
|
9964
10623
|
|
|
@@ -10016,6 +10675,8 @@ declare namespace sap {
|
|
|
10016
10675
|
|
|
10017
10676
|
"sap/fe/macros/table/Column": undefined;
|
|
10018
10677
|
|
|
10678
|
+
"sap/fe/macros/table/ColumnAINotice": undefined;
|
|
10679
|
+
|
|
10019
10680
|
"sap/fe/macros/table/ColumnExportSettings": undefined;
|
|
10020
10681
|
|
|
10021
10682
|
"sap/fe/macros/table/ColumnOverride": undefined;
|