@sapui5/types 1.113.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.
Files changed (66) hide show
  1. package/LICENSE.txt +35 -0
  2. package/README.md +35 -0
  3. package/package.json +23 -0
  4. package/types/index.d.ts +67 -0
  5. package/types/sap.apf.d.ts +1026 -0
  6. package/types/sap.ca.ui.d.ts +14005 -0
  7. package/types/sap.chart.d.ts +4815 -0
  8. package/types/sap.collaboration.d.ts +2704 -0
  9. package/types/sap.esh.search.ui.d.ts +1595 -0
  10. package/types/sap.f.d.ts +20085 -0
  11. package/types/sap.fe.core.d.ts +1508 -0
  12. package/types/sap.fe.macros.d.ts +975 -0
  13. package/types/sap.fe.navigation.d.ts +917 -0
  14. package/types/sap.fe.templates.d.ts +522 -0
  15. package/types/sap.fe.test.d.ts +3533 -0
  16. package/types/sap.feedback.ui.d.ts +3 -0
  17. package/types/sap.gantt.d.ts +51684 -0
  18. package/types/sap.insights.d.ts +23 -0
  19. package/types/sap.landvisz.d.ts +7952 -0
  20. package/types/sap.m.d.ts +147796 -0
  21. package/types/sap.makit.d.ts +4533 -0
  22. package/types/sap.me.d.ts +3665 -0
  23. package/types/sap.ndc.d.ts +774 -0
  24. package/types/sap.ovp.d.ts +176 -0
  25. package/types/sap.rules.ui.d.ts +1471 -0
  26. package/types/sap.sac.df.d.ts +2292 -0
  27. package/types/sap.sac.grid.d.ts +774 -0
  28. package/types/sap.suite.ui.commons.d.ts +46971 -0
  29. package/types/sap.suite.ui.generic.template.d.ts +3431 -0
  30. package/types/sap.suite.ui.microchart.d.ts +12652 -0
  31. package/types/sap.tnt.d.ts +2227 -0
  32. package/types/sap.ui.codeeditor.d.ts +693 -0
  33. package/types/sap.ui.commons.d.ts +30235 -0
  34. package/types/sap.ui.comp.d.ts +37411 -0
  35. package/types/sap.ui.core.d.ts +78872 -0
  36. package/types/sap.ui.dt.d.ts +3 -0
  37. package/types/sap.ui.export.d.ts +843 -0
  38. package/types/sap.ui.fl.d.ts +1663 -0
  39. package/types/sap.ui.generic.app.d.ts +2683 -0
  40. package/types/sap.ui.generic.template.d.ts +3 -0
  41. package/types/sap.ui.integration.d.ts +4032 -0
  42. package/types/sap.ui.layout.d.ts +14472 -0
  43. package/types/sap.ui.mdc.d.ts +476 -0
  44. package/types/sap.ui.richtexteditor.d.ts +1666 -0
  45. package/types/sap.ui.rta.d.ts +124 -0
  46. package/types/sap.ui.suite.d.ts +685 -0
  47. package/types/sap.ui.support.d.ts +453 -0
  48. package/types/sap.ui.table.d.ts +9325 -0
  49. package/types/sap.ui.testrecorder.d.ts +9 -0
  50. package/types/sap.ui.unified.d.ts +20640 -0
  51. package/types/sap.ui.ux3.d.ts +18288 -0
  52. package/types/sap.ui.vbm.d.ts +17251 -0
  53. package/types/sap.ui.vk.d.ts +42381 -0
  54. package/types/sap.ui.vtm.d.ts +10547 -0
  55. package/types/sap.ui.webc.common.d.ts +113 -0
  56. package/types/sap.ui.webc.fiori.d.ts +13850 -0
  57. package/types/sap.ui.webc.main.d.ts +40833 -0
  58. package/types/sap.uiext.inbox.d.ts +4079 -0
  59. package/types/sap.ushell.d.ts +10255 -0
  60. package/types/sap.ushell_abap.d.ts +9 -0
  61. package/types/sap.uxap.d.ts +7636 -0
  62. package/types/sap.viz.d.ts +51209 -0
  63. package/types/sap.webanalytics.core.d.ts +3 -0
  64. package/types/sap.zen.commons.d.ts +1542 -0
  65. package/types/sap.zen.crosstab.d.ts +1159 -0
  66. package/types/sap.zen.dsh.d.ts +2132 -0
@@ -0,0 +1,1471 @@
1
+ // For Library Version: 1.113.0
2
+
3
+ declare module "sap/rules/ui/library" {
4
+ /**
5
+ * @deprecated (since 1.52.8) - use the property decisionTableFormat.
6
+ *
7
+ * An enumeration that defines how a cell in a decision table is formulated by the rule creator.
8
+ */
9
+ export enum DecisionTableCellFormat {
10
+ /**
11
+ * Specifies that both rule formats are available in the decision table; allowing the rule creator to choose
12
+ * whether to formulate the decision table cells in either the basic or advanced format.
13
+ */
14
+ Both = "BOTH",
15
+ /**
16
+ * Specifies that the content of the decision table cell is restricted to values relevant to the data type
17
+ * of the table column's expression.
18
+ */
19
+ Guided = "GUIDED",
20
+ /**
21
+ * Specifies that the content of the decision table cell receives all possible suggestions (relevant functions,
22
+ * attributes and values) that are relevant to the data type of the table column's expression.
23
+ */
24
+ Text = "TEXT",
25
+ }
26
+ /**
27
+ * An enumeration that decides the rendering format for decisionTable.
28
+ */
29
+ export enum DecisionTableFormat {
30
+ /**
31
+ * @deprecated (since 1.52.8) - use the attribute RuleFormat instead.
32
+ *
33
+ * Specifies that the rendering of a cell is based on cellFormat and each cell can have a different format
34
+ * during rendering
35
+ */
36
+ CellFormat = "CELLFORMAT",
37
+ /**
38
+ * Specifies that the rendering is at the rule level. The value set here is applicable for all the cells
39
+ * in the rule.
40
+ */
41
+ RuleFormat = "RULEFORMAT",
42
+ }
43
+ /**
44
+ * An enumeration that defines the different business data types for an expression
45
+ */
46
+ export enum ExpressionType {
47
+ /**
48
+ * Specifies that the expression can be of any of the supported business data types.
49
+ */
50
+ All = "All",
51
+ /**
52
+ * Specifies that the expression must represent a Boolean data type: true, false.
53
+ */
54
+ Boolean = "Boolean",
55
+ /**
56
+ * Specifies that the expression must represent a date only.
57
+ */
58
+ Date = "Date",
59
+ /**
60
+ * Specifies that the expression must represent a real number with or without dot-decimal notation.
61
+ */
62
+ Number = "Number",
63
+ /**
64
+ * Specifies that the expression must represent a single-quoted UTF-8 encoded string.
65
+ */
66
+ String = "String",
67
+ /**
68
+ * Specifies that the expression must represent a time only.
69
+ */
70
+ Time = "Time",
71
+ /**
72
+ * Specifies that the expression must represent a time difference in milliseconds.
73
+ */
74
+ TimeSpan = "TimeSpan",
75
+ /**
76
+ * Specifies that the expression must represent a date and timestamp.
77
+ */
78
+ Timestamp = "Timestamp",
79
+ }
80
+ /**
81
+ * An enumeration that defines the output when more than one rule in the decision table is matched for a
82
+ * given set of inputs.
83
+ */
84
+ export enum RuleHitPolicy {
85
+ /**
86
+ * Specifies that all conditions that match the input (each matching row in the decision table) are returned
87
+ * as an output.
88
+ */
89
+ AllMatch = "AM",
90
+ /**
91
+ * Specifies that only the first condition that matches the input (the first matching row by order in the
92
+ * decision table) is returned as an output.
93
+ */
94
+ FirstMatch = "FM",
95
+ }
96
+ /**
97
+ * An enumeration that defines whether the rule is formulated as a table with multiple rules instead of
98
+ * a rule with a single associated condition.
99
+ */
100
+ export enum RuleType {
101
+ /**
102
+ * Specifies that the rule is formulated as a table that allows complex rules to be visualized according
103
+ * to an if-then-else logic.
104
+ */
105
+ DecisionTable = "DT",
106
+ /**
107
+ * Specifies that the rule is formulated as a single condition, which is written directly in a business
108
+ * language.
109
+ */
110
+ TextRule = "TextRule",
111
+ }
112
+ }
113
+
114
+ declare module "sap/rules/ui/DecisionTableConfiguration" {
115
+ import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
116
+
117
+ import Event from "sap/ui/base/Event";
118
+
119
+ import {
120
+ DecisionTableCellFormat,
121
+ DecisionTableFormat,
122
+ RuleHitPolicy,
123
+ } from "sap/rules/ui/library";
124
+
125
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
126
+
127
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
128
+
129
+ /**
130
+ * @SINCE 1.4
131
+ *
132
+ * The `sap.rules.ui.DecisionTableConfiguration` element provides the ability to define specific properties
133
+ * that will be applied when rendering the `sap.rules.ui.RuleBuilder` in decision table mode.
134
+ */
135
+ export default class DecisionTableConfiguration extends UI5Element {
136
+ /**
137
+ * Constructor for a new DecisionTableConfiguration.
138
+ *
139
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
140
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
141
+ * of the syntax of the settings object.
142
+ */
143
+ constructor(
144
+ /**
145
+ * initial settings for the new control
146
+ */
147
+ mSettings?: $DecisionTableConfigurationSettings
148
+ );
149
+ /**
150
+ * Constructor for a new DecisionTableConfiguration.
151
+ *
152
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
153
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
154
+ * of the syntax of the settings object.
155
+ */
156
+ constructor(
157
+ /**
158
+ * id for the new control, generated automatically if no id is given
159
+ */
160
+ sId?: string,
161
+ /**
162
+ * initial settings for the new control
163
+ */
164
+ mSettings?: $DecisionTableConfigurationSettings
165
+ );
166
+
167
+ /**
168
+ * Creates a new subclass of class sap.rules.ui.DecisionTableConfiguration with name `sClassName` and enriches
169
+ * it with the information contained in `oClassInfo`.
170
+ *
171
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
172
+ *
173
+ * @returns Created class / constructor function
174
+ */
175
+ static extend<T extends Record<string, unknown>>(
176
+ /**
177
+ * Name of the class being created
178
+ */
179
+ sClassName: string,
180
+ /**
181
+ * Object literal with information about the class
182
+ */
183
+ oClassInfo?: sap.ClassInfo<T, DecisionTableConfiguration>,
184
+ /**
185
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
186
+ * used by this class
187
+ */
188
+ FNMetaImpl?: Function
189
+ ): Function;
190
+ /**
191
+ * Returns a metadata object for class sap.rules.ui.DecisionTableConfiguration.
192
+ *
193
+ * @returns Metadata object describing this class
194
+ */
195
+ static getMetadata(): ElementMetadata;
196
+ /**
197
+ * Attaches event handler `fnFunction` to the {@link #event:change change} event of this `sap.rules.ui.DecisionTableConfiguration`.
198
+ *
199
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
200
+ * otherwise it will be bound to this `sap.rules.ui.DecisionTableConfiguration` itself.
201
+ *
202
+ * @returns Reference to `this` in order to allow method chaining
203
+ */
204
+ attachChange(
205
+ /**
206
+ * An application-specific payload object that will be passed to the event handler along with the event
207
+ * object when firing the event
208
+ */
209
+ oData: object,
210
+ /**
211
+ * The function to be called when the event occurs
212
+ */
213
+ fnFunction: (p1: Event) => void,
214
+ /**
215
+ * Context object to call the event handler with. Defaults to this `sap.rules.ui.DecisionTableConfiguration`
216
+ * itself
217
+ */
218
+ oListener?: object
219
+ ): this;
220
+ /**
221
+ * Attaches event handler `fnFunction` to the {@link #event:change change} event of this `sap.rules.ui.DecisionTableConfiguration`.
222
+ *
223
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
224
+ * otherwise it will be bound to this `sap.rules.ui.DecisionTableConfiguration` itself.
225
+ *
226
+ * @returns Reference to `this` in order to allow method chaining
227
+ */
228
+ attachChange(
229
+ /**
230
+ * The function to be called when the event occurs
231
+ */
232
+ fnFunction: (p1: Event) => void,
233
+ /**
234
+ * Context object to call the event handler with. Defaults to this `sap.rules.ui.DecisionTableConfiguration`
235
+ * itself
236
+ */
237
+ oListener?: object
238
+ ): this;
239
+ /**
240
+ * Detaches event handler `fnFunction` from the {@link #event:change change} event of this `sap.rules.ui.DecisionTableConfiguration`.
241
+ *
242
+ * The passed function and listener object must match the ones used for event registration.
243
+ *
244
+ * @returns Reference to `this` in order to allow method chaining
245
+ */
246
+ detachChange(
247
+ /**
248
+ * The function to be called, when the event occurs
249
+ */
250
+ fnFunction: (p1: Event) => void,
251
+ /**
252
+ * Context object on which the given function had to be called
253
+ */
254
+ oListener?: object
255
+ ): this;
256
+ /**
257
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
258
+ *
259
+ * Fires event {@link #event:change change} to attached listeners.
260
+ *
261
+ * @returns Reference to `this` in order to allow method chaining
262
+ */
263
+ fireChange(
264
+ /**
265
+ * Parameters to pass along with the event
266
+ */
267
+ mParameters?: {
268
+ name?: any;
269
+
270
+ value?: any;
271
+ }
272
+ ): this;
273
+ /**
274
+ * @deprecated (since 1.52.8) - use the decisionTableFormat property.
275
+ *
276
+ * Gets current value of property {@link #getCellFormat cellFormat}.
277
+ *
278
+ * The value determines the user input mode for the corresponding rule cells when creating or editing a
279
+ * rule.
280
+ *
281
+ * Default value is `Both`.
282
+ *
283
+ * @returns Value of property `cellFormat`
284
+ */
285
+ getCellFormat(): DecisionTableCellFormat;
286
+ /**
287
+ * Gets current value of property {@link #getDecisionTableFormat decisionTableFormat}.
288
+ *
289
+ * The value determines whether the user can set the rendering of the decision Table to be based on cellFormat
290
+ * or rule Format
291
+ *
292
+ * Default value is `CellFormat`.
293
+ *
294
+ * @returns Value of property `decisionTableFormat`
295
+ */
296
+ getDecisionTableFormat(): DecisionTableFormat;
297
+ /**
298
+ * Gets current value of property {@link #getEnableSettingResult enableSettingResult}.
299
+ *
300
+ * Default value is `true`.
301
+ *
302
+ * @returns Value of property `enableSettingResult`
303
+ */
304
+ getEnableSettingResult(): boolean;
305
+ /**
306
+ * Gets current value of property {@link #getEnableSettings enableSettings}.
307
+ *
308
+ * The value determines whether the Settings button is displayed in a decision table when the control is
309
+ * used with S/4 HANA 17.05 (Cloud) or 17.09 (On Premise) and higher (On Premise).
310
+ *
311
+ * Default value is `false`.
312
+ *
313
+ * @returns Value of property `enableSettings`
314
+ */
315
+ getEnableSettings(): boolean;
316
+ /**
317
+ * Gets current value of property {@link #getHitPolicies hitPolicies}.
318
+ *
319
+ * The value determines how the results of the decision table are evaluated when more than one rule is matched
320
+ * for a given set of inputs.
321
+ *
322
+ * Default value is `[FirstMatch, AllMatch]`.
323
+ *
324
+ * @returns Value of property `hitPolicies`
325
+ */
326
+ getHitPolicies(): RuleHitPolicy[];
327
+ /**
328
+ * Gets current value of property {@link #getThreshold threshold}.
329
+ *
330
+ * The threshold defines how many additional (not yet visible records) shall be pre-fetched to enable smooth
331
+ * scrolling. The threshold is always added to the visibleRowCount. If the visibleRowCount is 10 and the
332
+ * threshold is 100, there will be 110 records fetched with the initial load.
333
+ *
334
+ * Default value is `30`.
335
+ *
336
+ * @returns Value of property `threshold`
337
+ */
338
+ getThreshold(): int;
339
+ /**
340
+ * Gets current value of property {@link #getVisibleRowCount visibleRowCount}.
341
+ *
342
+ * Number of visible rows of the table.
343
+ *
344
+ * Default value is `30`.
345
+ *
346
+ * @returns Value of property `visibleRowCount`
347
+ */
348
+ getVisibleRowCount(): int;
349
+ /**
350
+ * @deprecated (since 1.52.8) - use the decisionTableFormat property.
351
+ *
352
+ * Sets a new value for property {@link #getCellFormat cellFormat}.
353
+ *
354
+ * The value determines the user input mode for the corresponding rule cells when creating or editing a
355
+ * rule.
356
+ *
357
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
358
+ *
359
+ * Default value is `Both`.
360
+ *
361
+ * @returns Reference to `this` in order to allow method chaining
362
+ */
363
+ setCellFormat(
364
+ /**
365
+ * New value for property `cellFormat`
366
+ */
367
+ sCellFormat?: DecisionTableCellFormat
368
+ ): this;
369
+ /**
370
+ * Sets a new value for property {@link #getDecisionTableFormat decisionTableFormat}.
371
+ *
372
+ * The value determines whether the user can set the rendering of the decision Table to be based on cellFormat
373
+ * or rule Format
374
+ *
375
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
376
+ *
377
+ * Default value is `CellFormat`.
378
+ *
379
+ * @returns Reference to `this` in order to allow method chaining
380
+ */
381
+ setDecisionTableFormat(
382
+ /**
383
+ * New value for property `decisionTableFormat`
384
+ */
385
+ sDecisionTableFormat?: DecisionTableFormat
386
+ ): this;
387
+ /**
388
+ * Sets a new value for property {@link #getEnableSettingResult enableSettingResult}.
389
+ *
390
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
391
+ *
392
+ * Default value is `true`.
393
+ *
394
+ * @returns Reference to `this` in order to allow method chaining
395
+ */
396
+ setEnableSettingResult(
397
+ /**
398
+ * New value for property `enableSettingResult`
399
+ */
400
+ bEnableSettingResult?: boolean
401
+ ): this;
402
+ /**
403
+ * Sets a new value for property {@link #getEnableSettings enableSettings}.
404
+ *
405
+ * The value determines whether the Settings button is displayed in a decision table when the control is
406
+ * used with S/4 HANA 17.05 (Cloud) or 17.09 (On Premise) and higher (On Premise).
407
+ *
408
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
409
+ *
410
+ * Default value is `false`.
411
+ *
412
+ * @returns Reference to `this` in order to allow method chaining
413
+ */
414
+ setEnableSettings(
415
+ /**
416
+ * New value for property `enableSettings`
417
+ */
418
+ bEnableSettings?: boolean
419
+ ): this;
420
+ /**
421
+ * Sets a new value for property {@link #getHitPolicies hitPolicies}.
422
+ *
423
+ * The value determines how the results of the decision table are evaluated when more than one rule is matched
424
+ * for a given set of inputs.
425
+ *
426
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
427
+ *
428
+ * Default value is `[FirstMatch, AllMatch]`.
429
+ *
430
+ * @returns Reference to `this` in order to allow method chaining
431
+ */
432
+ setHitPolicies(
433
+ /**
434
+ * New value for property `hitPolicies`
435
+ */
436
+ sHitPolicies?: RuleHitPolicy[]
437
+ ): this;
438
+ /**
439
+ * Sets a new value for property {@link #getThreshold threshold}.
440
+ *
441
+ * The threshold defines how many additional (not yet visible records) shall be pre-fetched to enable smooth
442
+ * scrolling. The threshold is always added to the visibleRowCount. If the visibleRowCount is 10 and the
443
+ * threshold is 100, there will be 110 records fetched with the initial load.
444
+ *
445
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
446
+ *
447
+ * Default value is `30`.
448
+ *
449
+ * @returns Reference to `this` in order to allow method chaining
450
+ */
451
+ setThreshold(
452
+ /**
453
+ * New value for property `threshold`
454
+ */
455
+ iThreshold?: int
456
+ ): this;
457
+ /**
458
+ * Sets a new value for property {@link #getVisibleRowCount visibleRowCount}.
459
+ *
460
+ * Number of visible rows of the table.
461
+ *
462
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
463
+ *
464
+ * Default value is `30`.
465
+ *
466
+ * @returns Reference to `this` in order to allow method chaining
467
+ */
468
+ setVisibleRowCount(
469
+ /**
470
+ * New value for property `visibleRowCount`
471
+ */
472
+ iVisibleRowCount?: int
473
+ ): this;
474
+ }
475
+
476
+ export interface $DecisionTableConfigurationSettings
477
+ extends $ElementSettings {
478
+ /**
479
+ * @deprecated (since 1.52.8) - use the decisionTableFormat property.
480
+ *
481
+ * The value determines the user input mode for the corresponding rule cells when creating or editing a
482
+ * rule.
483
+ */
484
+ cellFormat?: DecisionTableCellFormat | PropertyBindingInfo | `{${string}}`;
485
+
486
+ /**
487
+ * The value determines how the results of the decision table are evaluated when more than one rule is matched
488
+ * for a given set of inputs.
489
+ */
490
+ hitPolicies?: RuleHitPolicy[] | PropertyBindingInfo | `{${string}}`;
491
+
492
+ /**
493
+ * The value determines whether the Settings button is displayed in a decision table when the control is
494
+ * used with S/4 HANA 17.05 (Cloud) or 17.09 (On Premise) and higher (On Premise).
495
+ */
496
+ enableSettings?: boolean | PropertyBindingInfo | `{${string}}`;
497
+
498
+ enableSettingResult?: boolean | PropertyBindingInfo | `{${string}}`;
499
+
500
+ /**
501
+ * The value determines whether the user can set the rendering of the decision Table to be based on cellFormat
502
+ * or rule Format
503
+ */
504
+ decisionTableFormat?:
505
+ | DecisionTableFormat
506
+ | PropertyBindingInfo
507
+ | `{${string}}`;
508
+
509
+ /**
510
+ * The threshold defines how many additional (not yet visible records) shall be pre-fetched to enable smooth
511
+ * scrolling. The threshold is always added to the visibleRowCount. If the visibleRowCount is 10 and the
512
+ * threshold is 100, there will be 110 records fetched with the initial load.
513
+ */
514
+ threshold?: int | PropertyBindingInfo | `{${string}}`;
515
+
516
+ /**
517
+ * Number of visible rows of the table.
518
+ */
519
+ visibleRowCount?: int | PropertyBindingInfo | `{${string}}`;
520
+
521
+ change?: (oEvent: Event) => void;
522
+ }
523
+ }
524
+
525
+ declare module "sap/rules/ui/RuleBuilder" {
526
+ import { default as Control, $ControlSettings } from "sap/ui/core/Control";
527
+
528
+ import { ID } from "sap/ui/core/library";
529
+
530
+ import DecisionTableConfiguration from "sap/rules/ui/DecisionTableConfiguration";
531
+
532
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
533
+
534
+ import TextRuleConfiguration from "sap/rules/ui/TextRuleConfiguration";
535
+
536
+ import { RuleType } from "sap/rules/ui/library";
537
+
538
+ import AstExpressionLanguage from "sap/rules/ui/services/AstExpressionLanguage";
539
+
540
+ import ExpressionLanguage from "sap/rules/ui/services/ExpressionLanguage";
541
+
542
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
543
+
544
+ /**
545
+ * The `sap.rules.ui.RuleBuilder` control allows business users to create rules using a business language.
546
+ */
547
+ export default class RuleBuilder extends Control {
548
+ /**
549
+ * Constructor for a new RuleBuilder control.
550
+ *
551
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
552
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
553
+ * of the syntax of the settings object.
554
+ */
555
+ constructor(
556
+ /**
557
+ * Initial settings for the new control.
558
+ */
559
+ mSettings?: $RuleBuilderSettings
560
+ );
561
+ /**
562
+ * Constructor for a new RuleBuilder control.
563
+ *
564
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
565
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
566
+ * of the syntax of the settings object.
567
+ */
568
+ constructor(
569
+ /**
570
+ * ID for the new control, generated automatically if no ID is given.
571
+ */
572
+ sId?: string,
573
+ /**
574
+ * Initial settings for the new control.
575
+ */
576
+ mSettings?: $RuleBuilderSettings
577
+ );
578
+
579
+ /**
580
+ * Creates a new subclass of class sap.rules.ui.RuleBuilder with name `sClassName` and enriches it with
581
+ * the information contained in `oClassInfo`.
582
+ *
583
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
584
+ *
585
+ * @returns Created class / constructor function
586
+ */
587
+ static extend<T extends Record<string, unknown>>(
588
+ /**
589
+ * Name of the class being created
590
+ */
591
+ sClassName: string,
592
+ /**
593
+ * Object literal with information about the class
594
+ */
595
+ oClassInfo?: sap.ClassInfo<T, RuleBuilder>,
596
+ /**
597
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
598
+ * used by this class
599
+ */
600
+ FNMetaImpl?: Function
601
+ ): Function;
602
+ /**
603
+ * Returns a metadata object for class sap.rules.ui.RuleBuilder.
604
+ *
605
+ * @returns Metadata object describing this class
606
+ */
607
+ static getMetadata(): ElementMetadata;
608
+ /**
609
+ * Destroys the decisionTableConfiguration in the aggregation {@link #getDecisionTableConfiguration decisionTableConfiguration}.
610
+ *
611
+ * @returns Reference to `this` in order to allow method chaining
612
+ */
613
+ destroyDecisionTableConfiguration(): this;
614
+ /**
615
+ * Destroys the textRuleConfiguration in the aggregation {@link #getTextRuleConfiguration textRuleConfiguration}.
616
+ *
617
+ * @returns Reference to `this` in order to allow method chaining
618
+ */
619
+ destroyTextRuleConfiguration(): this;
620
+ /**
621
+ * ID of the element which is the current target of the association {@link #getAstExpressionLanguage astExpressionLanguage},
622
+ * or `null`.
623
+ */
624
+ getAstExpressionLanguage(): ID;
625
+ /**
626
+ * Gets current value of property {@link #getBindingContextPath bindingContextPath}.
627
+ *
628
+ * Path to a Rule object in the model data, which is used for the definition of relative context bindings
629
+ * inside the RuleBuilder control (mandatory). Example: "/Rules(Id='0050569181751ED683EFEEC6AA2B73C5',Version='000001')"
630
+ *
631
+ * @returns Value of property `bindingContextPath`
632
+ */
633
+ getBindingContextPath(): string;
634
+ /**
635
+ * Gets content of aggregation {@link #getDecisionTableConfiguration decisionTableConfiguration}.
636
+ *
637
+ * Configuration for rule of type 'decision table'.
638
+ */
639
+ getDecisionTableConfiguration(): DecisionTableConfiguration;
640
+ /**
641
+ * Gets current value of property {@link #getEditable editable}.
642
+ *
643
+ * Indicates whether or not the controls of the RuleBuilder are editable.
644
+ *
645
+ * Default value is `true`.
646
+ *
647
+ * @returns Value of property `editable`
648
+ */
649
+ getEditable(): boolean;
650
+ /**
651
+ * ID of the element which is the current target of the association {@link #getExpressionLanguage expressionLanguage},
652
+ * or `null`.
653
+ */
654
+ getExpressionLanguage(): ID;
655
+ /**
656
+ * Gets content of aggregation {@link #getTextRuleConfiguration textRuleConfiguration}.
657
+ *
658
+ * Configuration for rule of type 'Text Rule'.
659
+ */
660
+ getTextRuleConfiguration(): TextRuleConfiguration;
661
+ /**
662
+ * Gets current value of property {@link #getTypes types}.
663
+ *
664
+ * Available types that can be created using the `sap.rules.ui.RuleBuilder` control. If empty, all rule
665
+ * types will be available for selection. If only one type exists, the Rule Builder will open it automatically.
666
+ *
667
+ * Default value is `[DecisionTable, TextRule]`.
668
+ *
669
+ * @returns Value of property `types`
670
+ */
671
+ getTypes(): RuleType[];
672
+ /**
673
+ * Sets the associated {@link #getAstExpressionLanguage astExpressionLanguage}.
674
+ *
675
+ * @returns Reference to `this` in order to allow method chaining
676
+ */
677
+ setAstExpressionLanguage(
678
+ /**
679
+ * ID of an element which becomes the new target of this astExpressionLanguage association; alternatively,
680
+ * an element instance may be given
681
+ */
682
+ oAstExpressionLanguage: ID | AstExpressionLanguage
683
+ ): this;
684
+ /**
685
+ * Sets a new value for property {@link #getBindingContextPath bindingContextPath}.
686
+ *
687
+ * Path to a Rule object in the model data, which is used for the definition of relative context bindings
688
+ * inside the RuleBuilder control (mandatory). Example: "/Rules(Id='0050569181751ED683EFEEC6AA2B73C5',Version='000001')"
689
+ *
690
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
691
+ *
692
+ * @returns Reference to `this` in order to allow method chaining
693
+ */
694
+ setBindingContextPath(
695
+ /**
696
+ * New value for property `bindingContextPath`
697
+ */
698
+ sBindingContextPath: string
699
+ ): this;
700
+ /**
701
+ * Sets the aggregated {@link #getDecisionTableConfiguration decisionTableConfiguration}.
702
+ *
703
+ * @returns Reference to `this` in order to allow method chaining
704
+ */
705
+ setDecisionTableConfiguration(
706
+ /**
707
+ * The decisionTableConfiguration to set
708
+ */
709
+ oDecisionTableConfiguration: DecisionTableConfiguration
710
+ ): this;
711
+ /**
712
+ * Sets a new value for property {@link #getEditable editable}.
713
+ *
714
+ * Indicates whether or not the controls of the RuleBuilder are editable.
715
+ *
716
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
717
+ *
718
+ * Default value is `true`.
719
+ *
720
+ * @returns Reference to `this` in order to allow method chaining
721
+ */
722
+ setEditable(
723
+ /**
724
+ * New value for property `editable`
725
+ */
726
+ bEditable?: boolean
727
+ ): this;
728
+ /**
729
+ * Sets the associated {@link #getExpressionLanguage expressionLanguage}.
730
+ *
731
+ * @returns Reference to `this` in order to allow method chaining
732
+ */
733
+ setExpressionLanguage(
734
+ /**
735
+ * ID of an element which becomes the new target of this expressionLanguage association; alternatively,
736
+ * an element instance may be given
737
+ */
738
+ oExpressionLanguage: ID | ExpressionLanguage
739
+ ): this;
740
+ /**
741
+ * Sets the aggregated {@link #getTextRuleConfiguration textRuleConfiguration}.
742
+ *
743
+ * @returns Reference to `this` in order to allow method chaining
744
+ */
745
+ setTextRuleConfiguration(
746
+ /**
747
+ * The textRuleConfiguration to set
748
+ */
749
+ oTextRuleConfiguration: TextRuleConfiguration
750
+ ): this;
751
+ /**
752
+ * Sets a new value for property {@link #getTypes types}.
753
+ *
754
+ * Available types that can be created using the `sap.rules.ui.RuleBuilder` control. If empty, all rule
755
+ * types will be available for selection. If only one type exists, the Rule Builder will open it automatically.
756
+ *
757
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
758
+ *
759
+ * Default value is `[DecisionTable, TextRule]`.
760
+ *
761
+ * @returns Reference to `this` in order to allow method chaining
762
+ */
763
+ setTypes(
764
+ /**
765
+ * New value for property `types`
766
+ */
767
+ sTypes?: RuleType[]
768
+ ): this;
769
+ }
770
+
771
+ export interface $RuleBuilderSettings extends $ControlSettings {
772
+ /**
773
+ * Available types that can be created using the `sap.rules.ui.RuleBuilder` control. If empty, all rule
774
+ * types will be available for selection. If only one type exists, the Rule Builder will open it automatically.
775
+ */
776
+ types?: RuleType[] | PropertyBindingInfo | `{${string}}`;
777
+
778
+ /**
779
+ * Path to a Rule object in the model data, which is used for the definition of relative context bindings
780
+ * inside the RuleBuilder control (mandatory). Example: "/Rules(Id='0050569181751ED683EFEEC6AA2B73C5',Version='000001')"
781
+ */
782
+ bindingContextPath?: string | PropertyBindingInfo;
783
+
784
+ /**
785
+ * Indicates whether or not the controls of the RuleBuilder are editable.
786
+ */
787
+ editable?: boolean | PropertyBindingInfo | `{${string}}`;
788
+
789
+ /**
790
+ * Configuration for rule of type 'decision table'.
791
+ */
792
+ decisionTableConfiguration?: DecisionTableConfiguration;
793
+
794
+ /**
795
+ * Configuration for rule of type 'Text Rule'.
796
+ */
797
+ textRuleConfiguration?: TextRuleConfiguration;
798
+
799
+ /**
800
+ * Expression language to model English like expressions. Should not be used when sap.rules.ui.services.AstExpressionLanguage
801
+ * is used.
802
+ */
803
+ expressionLanguage?: ExpressionLanguage | string;
804
+
805
+ /**
806
+ * Expression language to use DMN SFEEL for modelling expressions. Should not be used when sap.rules.ui.services.ExpressionLanguage
807
+ * is used.
808
+ */
809
+ astExpressionLanguage?: AstExpressionLanguage | string;
810
+ }
811
+ }
812
+
813
+ declare module "sap/rules/ui/services/AstExpressionLanguage" {
814
+ import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
815
+
816
+ import Event from "sap/ui/base/Event";
817
+
818
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
819
+
820
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
821
+
822
+ /**
823
+ * Provides the AstExpressionLanguage service functionality, such as expression validations, expression
824
+ * parsing, auto-complete suggestions, retrieving expression metadata and tokens, and performing runtime
825
+ * services (fetching data objects, outputs, etc).
826
+ */
827
+ export default class AstExpressionLanguage extends UI5Element {
828
+ /**
829
+ * Constructor for a new AstExpressionLanguage element.
830
+ */
831
+ constructor();
832
+
833
+ /**
834
+ * Creates a new subclass of class sap.rules.ui.services.AstExpressionLanguage with name `sClassName` and
835
+ * enriches it with the information contained in `oClassInfo`.
836
+ *
837
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
838
+ *
839
+ * @returns Created class / constructor function
840
+ */
841
+ static extend<T extends Record<string, unknown>>(
842
+ /**
843
+ * Name of the class being created
844
+ */
845
+ sClassName: string,
846
+ /**
847
+ * Object literal with information about the class
848
+ */
849
+ oClassInfo?: sap.ClassInfo<T, AstExpressionLanguage>,
850
+ /**
851
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
852
+ * used by this class
853
+ */
854
+ FNMetaImpl?: Function
855
+ ): Function;
856
+ /**
857
+ * Returns a metadata object for class sap.rules.ui.services.AstExpressionLanguage.
858
+ *
859
+ * @returns Metadata object describing this class
860
+ */
861
+ static getMetadata(): ElementMetadata;
862
+ /**
863
+ * Attaches event handler `fnFunction` to the {@link #event:dataChange dataChange} event of this `sap.rules.ui.services.AstExpressionLanguage`.
864
+ *
865
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
866
+ * otherwise it will be bound to this `sap.rules.ui.services.AstExpressionLanguage` itself.
867
+ *
868
+ * @returns Reference to `this` in order to allow method chaining
869
+ */
870
+ attachDataChange(
871
+ /**
872
+ * An application-specific payload object that will be passed to the event handler along with the event
873
+ * object when firing the event
874
+ */
875
+ oData: object,
876
+ /**
877
+ * The function to be called when the event occurs
878
+ */
879
+ fnFunction: (p1: Event) => void,
880
+ /**
881
+ * Context object to call the event handler with. Defaults to this `sap.rules.ui.services.AstExpressionLanguage`
882
+ * itself
883
+ */
884
+ oListener?: object
885
+ ): this;
886
+ /**
887
+ * Attaches event handler `fnFunction` to the {@link #event:dataChange dataChange} event of this `sap.rules.ui.services.AstExpressionLanguage`.
888
+ *
889
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
890
+ * otherwise it will be bound to this `sap.rules.ui.services.AstExpressionLanguage` itself.
891
+ *
892
+ * @returns Reference to `this` in order to allow method chaining
893
+ */
894
+ attachDataChange(
895
+ /**
896
+ * The function to be called when the event occurs
897
+ */
898
+ fnFunction: (p1: Event) => void,
899
+ /**
900
+ * Context object to call the event handler with. Defaults to this `sap.rules.ui.services.AstExpressionLanguage`
901
+ * itself
902
+ */
903
+ oListener?: object
904
+ ): this;
905
+ /**
906
+ * Detaches event handler `fnFunction` from the {@link #event:dataChange dataChange} event of this `sap.rules.ui.services.AstExpressionLanguage`.
907
+ *
908
+ * The passed function and listener object must match the ones used for event registration.
909
+ *
910
+ * @returns Reference to `this` in order to allow method chaining
911
+ */
912
+ detachDataChange(
913
+ /**
914
+ * The function to be called, when the event occurs
915
+ */
916
+ fnFunction: (p1: Event) => void,
917
+ /**
918
+ * Context object on which the given function had to be called
919
+ */
920
+ oListener?: object
921
+ ): this;
922
+ /**
923
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
924
+ *
925
+ * Fires event {@link #event:dataChange dataChange} to attached listeners.
926
+ *
927
+ * @returns Reference to `this` in order to allow method chaining
928
+ */
929
+ fireDataChange(
930
+ /**
931
+ * Parameters to pass along with the event
932
+ */
933
+ mParameters?: object
934
+ ): this;
935
+ /**
936
+ * Gets current value of property {@link #getBindingContextPath bindingContextPath}.
937
+ *
938
+ * Path to a Vocabulary object in the model data, which is used for the definition of relative context bindings
939
+ * inside the Ast Expression Language control (mandatory). Example: "/Vocabularies(Id='0050569181751ED683EFEEC6AA2B73C5')"
940
+ *
941
+ * @returns Value of property `bindingContextPath`
942
+ */
943
+ getBindingContextPath(): string;
944
+ /**
945
+ * Sets a new value for property {@link #getBindingContextPath bindingContextPath}.
946
+ *
947
+ * Path to a Vocabulary object in the model data, which is used for the definition of relative context bindings
948
+ * inside the Ast Expression Language control (mandatory). Example: "/Vocabularies(Id='0050569181751ED683EFEEC6AA2B73C5')"
949
+ *
950
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
951
+ *
952
+ * @returns Reference to `this` in order to allow method chaining
953
+ */
954
+ setBindingContextPath(
955
+ /**
956
+ * New value for property `bindingContextPath`
957
+ */
958
+ sBindingContextPath: string
959
+ ): this;
960
+ }
961
+
962
+ export interface $AstExpressionLanguageSettings extends $ElementSettings {
963
+ /**
964
+ * Path to a Vocabulary object in the model data, which is used for the definition of relative context bindings
965
+ * inside the Ast Expression Language control (mandatory). Example: "/Vocabularies(Id='0050569181751ED683EFEEC6AA2B73C5')"
966
+ */
967
+ bindingContextPath?: string | PropertyBindingInfo;
968
+
969
+ dataChange?: (oEvent: Event) => void;
970
+ }
971
+ }
972
+
973
+ declare module "sap/rules/ui/services/ExpressionLanguage" {
974
+ import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
975
+
976
+ import Event from "sap/ui/base/Event";
977
+
978
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
979
+
980
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
981
+
982
+ /**
983
+ * Provides the ExpressionLanguage service functionality, such as expression validations, expression parsing,
984
+ * auto-complete suggestions, retrieving expression metadata and tokens, and performing runtime services
985
+ * (fetching data objects, outputs, etc).
986
+ */
987
+ export default class ExpressionLanguage extends UI5Element {
988
+ /**
989
+ * Constructor for a new ExpressionLanguage element.
990
+ */
991
+ constructor();
992
+
993
+ /**
994
+ * Creates a new subclass of class sap.rules.ui.services.ExpressionLanguage with name `sClassName` and enriches
995
+ * it with the information contained in `oClassInfo`.
996
+ *
997
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
998
+ *
999
+ * @returns Created class / constructor function
1000
+ */
1001
+ static extend<T extends Record<string, unknown>>(
1002
+ /**
1003
+ * Name of the class being created
1004
+ */
1005
+ sClassName: string,
1006
+ /**
1007
+ * Object literal with information about the class
1008
+ */
1009
+ oClassInfo?: sap.ClassInfo<T, ExpressionLanguage>,
1010
+ /**
1011
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1012
+ * used by this class
1013
+ */
1014
+ FNMetaImpl?: Function
1015
+ ): Function;
1016
+ /**
1017
+ * Returns a metadata object for class sap.rules.ui.services.ExpressionLanguage.
1018
+ *
1019
+ * @returns Metadata object describing this class
1020
+ */
1021
+ static getMetadata(): ElementMetadata;
1022
+ /**
1023
+ * Attaches event handler `fnFunction` to the {@link #event:dataChange dataChange} event of this `sap.rules.ui.services.ExpressionLanguage`.
1024
+ *
1025
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1026
+ * otherwise it will be bound to this `sap.rules.ui.services.ExpressionLanguage` itself.
1027
+ *
1028
+ * @returns Reference to `this` in order to allow method chaining
1029
+ */
1030
+ attachDataChange(
1031
+ /**
1032
+ * An application-specific payload object that will be passed to the event handler along with the event
1033
+ * object when firing the event
1034
+ */
1035
+ oData: object,
1036
+ /**
1037
+ * The function to be called when the event occurs
1038
+ */
1039
+ fnFunction: (p1: Event) => void,
1040
+ /**
1041
+ * Context object to call the event handler with. Defaults to this `sap.rules.ui.services.ExpressionLanguage`
1042
+ * itself
1043
+ */
1044
+ oListener?: object
1045
+ ): this;
1046
+ /**
1047
+ * Attaches event handler `fnFunction` to the {@link #event:dataChange dataChange} event of this `sap.rules.ui.services.ExpressionLanguage`.
1048
+ *
1049
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1050
+ * otherwise it will be bound to this `sap.rules.ui.services.ExpressionLanguage` itself.
1051
+ *
1052
+ * @returns Reference to `this` in order to allow method chaining
1053
+ */
1054
+ attachDataChange(
1055
+ /**
1056
+ * The function to be called when the event occurs
1057
+ */
1058
+ fnFunction: (p1: Event) => void,
1059
+ /**
1060
+ * Context object to call the event handler with. Defaults to this `sap.rules.ui.services.ExpressionLanguage`
1061
+ * itself
1062
+ */
1063
+ oListener?: object
1064
+ ): this;
1065
+ /**
1066
+ * Detaches event handler `fnFunction` from the {@link #event:dataChange dataChange} event of this `sap.rules.ui.services.ExpressionLanguage`.
1067
+ *
1068
+ * The passed function and listener object must match the ones used for event registration.
1069
+ *
1070
+ * @returns Reference to `this` in order to allow method chaining
1071
+ */
1072
+ detachDataChange(
1073
+ /**
1074
+ * The function to be called, when the event occurs
1075
+ */
1076
+ fnFunction: (p1: Event) => void,
1077
+ /**
1078
+ * Context object on which the given function had to be called
1079
+ */
1080
+ oListener?: object
1081
+ ): this;
1082
+ /**
1083
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1084
+ *
1085
+ * Fires event {@link #event:dataChange dataChange} to attached listeners.
1086
+ *
1087
+ * @returns Reference to `this` in order to allow method chaining
1088
+ */
1089
+ fireDataChange(
1090
+ /**
1091
+ * Parameters to pass along with the event
1092
+ */
1093
+ mParameters?: object
1094
+ ): this;
1095
+ /**
1096
+ * Gets current value of property {@link #getBindingContextPath bindingContextPath}.
1097
+ *
1098
+ * Path to a Vocabulary object in the model data, which is used for the definition of relative context bindings
1099
+ * inside the Expression Language control (mandatory). Example: "/Vocabularies(Id='0050569181751ED683EFEEC6AA2B73C5')"
1100
+ *
1101
+ * @returns Value of property `bindingContextPath`
1102
+ */
1103
+ getBindingContextPath(): string;
1104
+ /**
1105
+ * Gets current value of property {@link #getValueHelpCallback valueHelpCallback}.
1106
+ *
1107
+ * The valueHelpCallback is a function that receives by reference an array of value help metadata and adds
1108
+ * to each item an OData model instance. The OData model is used for suggesting allowed values and for validating
1109
+ * values that are used in the rule.
1110
+ *
1111
+ * @returns Value of property `valueHelpCallback`
1112
+ */
1113
+ getValueHelpCallback(): any;
1114
+ /**
1115
+ * Sets a new value for property {@link #getBindingContextPath bindingContextPath}.
1116
+ *
1117
+ * Path to a Vocabulary object in the model data, which is used for the definition of relative context bindings
1118
+ * inside the Expression Language control (mandatory). Example: "/Vocabularies(Id='0050569181751ED683EFEEC6AA2B73C5')"
1119
+ *
1120
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1121
+ *
1122
+ * @returns Reference to `this` in order to allow method chaining
1123
+ */
1124
+ setBindingContextPath(
1125
+ /**
1126
+ * New value for property `bindingContextPath`
1127
+ */
1128
+ sBindingContextPath: string
1129
+ ): this;
1130
+ /**
1131
+ * Sets a new value for property {@link #getValueHelpCallback valueHelpCallback}.
1132
+ *
1133
+ * The valueHelpCallback is a function that receives by reference an array of value help metadata and adds
1134
+ * to each item an OData model instance. The OData model is used for suggesting allowed values and for validating
1135
+ * values that are used in the rule.
1136
+ *
1137
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1138
+ *
1139
+ * @returns Reference to `this` in order to allow method chaining
1140
+ */
1141
+ setValueHelpCallback(
1142
+ /**
1143
+ * New value for property `valueHelpCallback`
1144
+ */
1145
+ oValueHelpCallback: any
1146
+ ): this;
1147
+ }
1148
+
1149
+ export interface $ExpressionLanguageSettings extends $ElementSettings {
1150
+ /**
1151
+ * The valueHelpCallback is a function that receives by reference an array of value help metadata and adds
1152
+ * to each item an OData model instance. The OData model is used for suggesting allowed values and for validating
1153
+ * values that are used in the rule.
1154
+ */
1155
+ valueHelpCallback?: any | PropertyBindingInfo | `{${string}}`;
1156
+
1157
+ /**
1158
+ * Path to a Vocabulary object in the model data, which is used for the definition of relative context bindings
1159
+ * inside the Expression Language control (mandatory). Example: "/Vocabularies(Id='0050569181751ED683EFEEC6AA2B73C5')"
1160
+ */
1161
+ bindingContextPath?: string | PropertyBindingInfo;
1162
+
1163
+ dataChange?: (oEvent: Event) => void;
1164
+ }
1165
+ }
1166
+
1167
+ declare module "sap/rules/ui/TextRuleConfiguration" {
1168
+ import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
1169
+
1170
+ import Event from "sap/ui/base/Event";
1171
+
1172
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
1173
+
1174
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
1175
+
1176
+ /**
1177
+ * @SINCE 1.4
1178
+ *
1179
+ * The `sap.rules.ui.TextRuleConfiguration` element provides the ability to define specific properties that
1180
+ * will be applied when rendering the `sap.rules.ui.RuleBuilder` in decision table mode.
1181
+ */
1182
+ export default class TextRuleConfiguration extends UI5Element {
1183
+ /**
1184
+ * Constructor for a new TextRuleConfiguration.
1185
+ *
1186
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1187
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1188
+ * of the syntax of the settings object.
1189
+ */
1190
+ constructor(
1191
+ /**
1192
+ * initial settings for the new control
1193
+ */
1194
+ mSettings?: $TextRuleConfigurationSettings
1195
+ );
1196
+ /**
1197
+ * Constructor for a new TextRuleConfiguration.
1198
+ *
1199
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1200
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1201
+ * of the syntax of the settings object.
1202
+ */
1203
+ constructor(
1204
+ /**
1205
+ * id for the new control, generated automatically if no id is given
1206
+ */
1207
+ sId?: string,
1208
+ /**
1209
+ * initial settings for the new control
1210
+ */
1211
+ mSettings?: $TextRuleConfigurationSettings
1212
+ );
1213
+
1214
+ /**
1215
+ * Creates a new subclass of class sap.rules.ui.TextRuleConfiguration with name `sClassName` and enriches
1216
+ * it with the information contained in `oClassInfo`.
1217
+ *
1218
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
1219
+ *
1220
+ * @returns Created class / constructor function
1221
+ */
1222
+ static extend<T extends Record<string, unknown>>(
1223
+ /**
1224
+ * Name of the class being created
1225
+ */
1226
+ sClassName: string,
1227
+ /**
1228
+ * Object literal with information about the class
1229
+ */
1230
+ oClassInfo?: sap.ClassInfo<T, TextRuleConfiguration>,
1231
+ /**
1232
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1233
+ * used by this class
1234
+ */
1235
+ FNMetaImpl?: Function
1236
+ ): Function;
1237
+ /**
1238
+ * Returns a metadata object for class sap.rules.ui.TextRuleConfiguration.
1239
+ *
1240
+ * @returns Metadata object describing this class
1241
+ */
1242
+ static getMetadata(): ElementMetadata;
1243
+ /**
1244
+ * Attaches event handler `fnFunction` to the {@link #event:change change} event of this `sap.rules.ui.TextRuleConfiguration`.
1245
+ *
1246
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1247
+ * otherwise it will be bound to this `sap.rules.ui.TextRuleConfiguration` itself.
1248
+ *
1249
+ * @returns Reference to `this` in order to allow method chaining
1250
+ */
1251
+ attachChange(
1252
+ /**
1253
+ * An application-specific payload object that will be passed to the event handler along with the event
1254
+ * object when firing the event
1255
+ */
1256
+ oData: object,
1257
+ /**
1258
+ * The function to be called when the event occurs
1259
+ */
1260
+ fnFunction: (p1: Event) => void,
1261
+ /**
1262
+ * Context object to call the event handler with. Defaults to this `sap.rules.ui.TextRuleConfiguration`
1263
+ * itself
1264
+ */
1265
+ oListener?: object
1266
+ ): this;
1267
+ /**
1268
+ * Attaches event handler `fnFunction` to the {@link #event:change change} event of this `sap.rules.ui.TextRuleConfiguration`.
1269
+ *
1270
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1271
+ * otherwise it will be bound to this `sap.rules.ui.TextRuleConfiguration` itself.
1272
+ *
1273
+ * @returns Reference to `this` in order to allow method chaining
1274
+ */
1275
+ attachChange(
1276
+ /**
1277
+ * The function to be called when the event occurs
1278
+ */
1279
+ fnFunction: (p1: Event) => void,
1280
+ /**
1281
+ * Context object to call the event handler with. Defaults to this `sap.rules.ui.TextRuleConfiguration`
1282
+ * itself
1283
+ */
1284
+ oListener?: object
1285
+ ): this;
1286
+ /**
1287
+ * Detaches event handler `fnFunction` from the {@link #event:change change} event of this `sap.rules.ui.TextRuleConfiguration`.
1288
+ *
1289
+ * The passed function and listener object must match the ones used for event registration.
1290
+ *
1291
+ * @returns Reference to `this` in order to allow method chaining
1292
+ */
1293
+ detachChange(
1294
+ /**
1295
+ * The function to be called, when the event occurs
1296
+ */
1297
+ fnFunction: (p1: Event) => void,
1298
+ /**
1299
+ * Context object on which the given function had to be called
1300
+ */
1301
+ oListener?: object
1302
+ ): this;
1303
+ /**
1304
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1305
+ *
1306
+ * Fires event {@link #event:change change} to attached listeners.
1307
+ *
1308
+ * @returns Reference to `this` in order to allow method chaining
1309
+ */
1310
+ fireChange(
1311
+ /**
1312
+ * Parameters to pass along with the event
1313
+ */
1314
+ mParameters?: {
1315
+ name?: any;
1316
+
1317
+ value?: any;
1318
+ }
1319
+ ): this;
1320
+ /**
1321
+ * Gets current value of property {@link #getEnableElse enableElse}.
1322
+ *
1323
+ * The value determines whether the Else section is displayed in a Text Rule when the control is used with
1324
+ * S/4 HANA 17.05 (Cloud) or 17.09 (On Premise) and higher (On Premise).
1325
+ *
1326
+ * Default value is `true`.
1327
+ *
1328
+ * @returns Value of property `enableElse`
1329
+ */
1330
+ getEnableElse(): boolean;
1331
+ /**
1332
+ * Gets current value of property {@link #getEnableElseIf enableElseIf}.
1333
+ *
1334
+ * The value determines whether the Else If section is displayed in a Text Rule when the control is used
1335
+ * with S/4 HANA 17.05 (Cloud) or 17.09 (On Premise) and higher (On Premise).
1336
+ *
1337
+ * Default value is `true`.
1338
+ *
1339
+ * @returns Value of property `enableElseIf`
1340
+ */
1341
+ getEnableElseIf(): boolean;
1342
+ /**
1343
+ * Gets current value of property {@link #getEnableSettingResult enableSettingResult}.
1344
+ *
1345
+ * Default value is `true`.
1346
+ *
1347
+ * @returns Value of property `enableSettingResult`
1348
+ */
1349
+ getEnableSettingResult(): boolean;
1350
+ /**
1351
+ * Gets current value of property {@link #getEnableSettings enableSettings}.
1352
+ *
1353
+ * The value determines whether the Settings button is displayed in a Text Rule when the control is used
1354
+ * with S/4 HANA 17.05 (Cloud) or 17.09 (On Premise) and higher (On Premise).
1355
+ *
1356
+ * Default value is `false`.
1357
+ *
1358
+ * @returns Value of property `enableSettings`
1359
+ */
1360
+ getEnableSettings(): boolean;
1361
+ /**
1362
+ * Sets a new value for property {@link #getEnableElse enableElse}.
1363
+ *
1364
+ * The value determines whether the Else section is displayed in a Text Rule when the control is used with
1365
+ * S/4 HANA 17.05 (Cloud) or 17.09 (On Premise) and higher (On Premise).
1366
+ *
1367
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1368
+ *
1369
+ * Default value is `true`.
1370
+ *
1371
+ * @returns Reference to `this` in order to allow method chaining
1372
+ */
1373
+ setEnableElse(
1374
+ /**
1375
+ * New value for property `enableElse`
1376
+ */
1377
+ bEnableElse?: boolean
1378
+ ): this;
1379
+ /**
1380
+ * Sets a new value for property {@link #getEnableElseIf enableElseIf}.
1381
+ *
1382
+ * The value determines whether the Else If section is displayed in a Text Rule when the control is used
1383
+ * with S/4 HANA 17.05 (Cloud) or 17.09 (On Premise) and higher (On Premise).
1384
+ *
1385
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1386
+ *
1387
+ * Default value is `true`.
1388
+ *
1389
+ * @returns Reference to `this` in order to allow method chaining
1390
+ */
1391
+ setEnableElseIf(
1392
+ /**
1393
+ * New value for property `enableElseIf`
1394
+ */
1395
+ bEnableElseIf?: boolean
1396
+ ): this;
1397
+ /**
1398
+ * Sets a new value for property {@link #getEnableSettingResult enableSettingResult}.
1399
+ *
1400
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1401
+ *
1402
+ * Default value is `true`.
1403
+ *
1404
+ * @returns Reference to `this` in order to allow method chaining
1405
+ */
1406
+ setEnableSettingResult(
1407
+ /**
1408
+ * New value for property `enableSettingResult`
1409
+ */
1410
+ bEnableSettingResult?: boolean
1411
+ ): this;
1412
+ /**
1413
+ * Sets a new value for property {@link #getEnableSettings enableSettings}.
1414
+ *
1415
+ * The value determines whether the Settings button is displayed in a Text Rule when the control is used
1416
+ * with S/4 HANA 17.05 (Cloud) or 17.09 (On Premise) and higher (On Premise).
1417
+ *
1418
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1419
+ *
1420
+ * Default value is `false`.
1421
+ *
1422
+ * @returns Reference to `this` in order to allow method chaining
1423
+ */
1424
+ setEnableSettings(
1425
+ /**
1426
+ * New value for property `enableSettings`
1427
+ */
1428
+ bEnableSettings?: boolean
1429
+ ): this;
1430
+ }
1431
+
1432
+ export interface $TextRuleConfigurationSettings extends $ElementSettings {
1433
+ /**
1434
+ * The value determines whether the Settings button is displayed in a Text Rule when the control is used
1435
+ * with S/4 HANA 17.05 (Cloud) or 17.09 (On Premise) and higher (On Premise).
1436
+ */
1437
+ enableSettings?: boolean | PropertyBindingInfo | `{${string}}`;
1438
+
1439
+ enableSettingResult?: boolean | PropertyBindingInfo | `{${string}}`;
1440
+
1441
+ /**
1442
+ * The value determines whether the Else section is displayed in a Text Rule when the control is used with
1443
+ * S/4 HANA 17.05 (Cloud) or 17.09 (On Premise) and higher (On Premise).
1444
+ */
1445
+ enableElse?: boolean | PropertyBindingInfo | `{${string}}`;
1446
+
1447
+ /**
1448
+ * The value determines whether the Else If section is displayed in a Text Rule when the control is used
1449
+ * with S/4 HANA 17.05 (Cloud) or 17.09 (On Premise) and higher (On Premise).
1450
+ */
1451
+ enableElseIf?: boolean | PropertyBindingInfo | `{${string}}`;
1452
+
1453
+ change?: (oEvent: Event) => void;
1454
+ }
1455
+ }
1456
+
1457
+ declare namespace sap {
1458
+ interface IUI5DefineDependencyNames {
1459
+ "sap/rules/ui/DecisionTableConfiguration": undefined;
1460
+
1461
+ "sap/rules/ui/library": undefined;
1462
+
1463
+ "sap/rules/ui/RuleBuilder": undefined;
1464
+
1465
+ "sap/rules/ui/services/AstExpressionLanguage": undefined;
1466
+
1467
+ "sap/rules/ui/services/ExpressionLanguage": undefined;
1468
+
1469
+ "sap/rules/ui/TextRuleConfiguration": undefined;
1470
+ }
1471
+ }