@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,2132 @@
1
+ // For Library Version: 1.113.0
2
+
3
+ declare module "sap/zen/dsh/library" {}
4
+
5
+ declare module "sap/zen/dsh/AnalyticGrid" {
6
+ import { default as Control, $ControlSettings } from "sap/ui/core/Control";
7
+
8
+ import Event from "sap/ui/base/Event";
9
+
10
+ import { CSSSize } from "sap/ui/core/library";
11
+
12
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
13
+
14
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
15
+
16
+ /**
17
+ * @SINCE 1.46
18
+ * @deprecated (since 1.89.0)
19
+ * @EXPERIMENTAL (since 1.46) - API is incomplete and may change incompatibly
20
+ *
21
+ * Control for embedding a Design Studio Analytic Grid in an S/4 HANA Fiori application
22
+ */
23
+ export default class AnalyticGrid extends Control {
24
+ /**
25
+ * Constructor for a new AnalyticGrid.
26
+ *
27
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
28
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
29
+ * of the syntax of the settings object.
30
+ */
31
+ constructor(
32
+ /**
33
+ * initial settings for the new control
34
+ */
35
+ mSettings?: $AnalyticGridSettings
36
+ );
37
+ /**
38
+ * Constructor for a new AnalyticGrid.
39
+ *
40
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
41
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
42
+ * of the syntax of the settings object.
43
+ */
44
+ constructor(
45
+ /**
46
+ * id for the new control, generated automatically if no id is given
47
+ */
48
+ sId?: string,
49
+ /**
50
+ * initial settings for the new control
51
+ */
52
+ mSettings?: $AnalyticGridSettings
53
+ );
54
+
55
+ /**
56
+ * Creates a new subclass of class sap.zen.dsh.AnalyticGrid with name `sClassName` and enriches it with
57
+ * the information contained in `oClassInfo`.
58
+ *
59
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
60
+ *
61
+ * @returns Created class / constructor function
62
+ */
63
+ static extend<T extends Record<string, unknown>>(
64
+ /**
65
+ * Name of the class being created
66
+ */
67
+ sClassName: string,
68
+ /**
69
+ * Object literal with information about the class
70
+ */
71
+ oClassInfo?: sap.ClassInfo<T, AnalyticGrid>,
72
+ /**
73
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
74
+ * used by this class
75
+ */
76
+ FNMetaImpl?: Function
77
+ ): Function;
78
+ /**
79
+ * Returns a metadata object for class sap.zen.dsh.AnalyticGrid.
80
+ *
81
+ * @returns Metadata object describing this class
82
+ */
83
+ static getMetadata(): ElementMetadata;
84
+ /**
85
+ * Attaches event handler `fnFunction` to the {@link #event:selectionChange selectionChange} event of this
86
+ * `sap.zen.dsh.AnalyticGrid`.
87
+ *
88
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
89
+ * otherwise it will be bound to this `sap.zen.dsh.AnalyticGrid` itself.
90
+ *
91
+ * Event is triggered when the selection is changed.
92
+ *
93
+ * @returns Reference to `this` in order to allow method chaining
94
+ */
95
+ attachSelectionChange(
96
+ /**
97
+ * An application-specific payload object that will be passed to the event handler along with the event
98
+ * object when firing the event
99
+ */
100
+ oData: object,
101
+ /**
102
+ * The function to be called when the event occurs
103
+ */
104
+ fnFunction: (p1: Event) => void,
105
+ /**
106
+ * Context object to call the event handler with. Defaults to this `sap.zen.dsh.AnalyticGrid` itself
107
+ */
108
+ oListener?: object
109
+ ): this;
110
+ /**
111
+ * Attaches event handler `fnFunction` to the {@link #event:selectionChange selectionChange} event of this
112
+ * `sap.zen.dsh.AnalyticGrid`.
113
+ *
114
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
115
+ * otherwise it will be bound to this `sap.zen.dsh.AnalyticGrid` itself.
116
+ *
117
+ * Event is triggered when the selection is changed.
118
+ *
119
+ * @returns Reference to `this` in order to allow method chaining
120
+ */
121
+ attachSelectionChange(
122
+ /**
123
+ * The function to be called when the event occurs
124
+ */
125
+ fnFunction: (p1: Event) => void,
126
+ /**
127
+ * Context object to call the event handler with. Defaults to this `sap.zen.dsh.AnalyticGrid` itself
128
+ */
129
+ oListener?: object
130
+ ): this;
131
+ /**
132
+ * Attaches event handler `fnFunction` to the {@link #event:stateChange stateChange} event of this `sap.zen.dsh.AnalyticGrid`.
133
+ *
134
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
135
+ * otherwise it will be bound to this `sap.zen.dsh.AnalyticGrid` itself.
136
+ *
137
+ * Event is triggered when the state of the AnalyticGrid is changed.
138
+ *
139
+ * @returns Reference to `this` in order to allow method chaining
140
+ */
141
+ attachStateChange(
142
+ /**
143
+ * An application-specific payload object that will be passed to the event handler along with the event
144
+ * object when firing the event
145
+ */
146
+ oData: object,
147
+ /**
148
+ * The function to be called when the event occurs
149
+ */
150
+ fnFunction: (p1: Event) => void,
151
+ /**
152
+ * Context object to call the event handler with. Defaults to this `sap.zen.dsh.AnalyticGrid` itself
153
+ */
154
+ oListener?: object
155
+ ): this;
156
+ /**
157
+ * Attaches event handler `fnFunction` to the {@link #event:stateChange stateChange} event of this `sap.zen.dsh.AnalyticGrid`.
158
+ *
159
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
160
+ * otherwise it will be bound to this `sap.zen.dsh.AnalyticGrid` itself.
161
+ *
162
+ * Event is triggered when the state of the AnalyticGrid is changed.
163
+ *
164
+ * @returns Reference to `this` in order to allow method chaining
165
+ */
166
+ attachStateChange(
167
+ /**
168
+ * The function to be called when the event occurs
169
+ */
170
+ fnFunction: (p1: Event) => void,
171
+ /**
172
+ * Context object to call the event handler with. Defaults to this `sap.zen.dsh.AnalyticGrid` itself
173
+ */
174
+ oListener?: object
175
+ ): this;
176
+ /**
177
+ * Detaches event handler `fnFunction` from the {@link #event:selectionChange selectionChange} event of
178
+ * this `sap.zen.dsh.AnalyticGrid`.
179
+ *
180
+ * The passed function and listener object must match the ones used for event registration.
181
+ *
182
+ * @returns Reference to `this` in order to allow method chaining
183
+ */
184
+ detachSelectionChange(
185
+ /**
186
+ * The function to be called, when the event occurs
187
+ */
188
+ fnFunction: (p1: Event) => void,
189
+ /**
190
+ * Context object on which the given function had to be called
191
+ */
192
+ oListener?: object
193
+ ): this;
194
+ /**
195
+ * Detaches event handler `fnFunction` from the {@link #event:stateChange stateChange} event of this `sap.zen.dsh.AnalyticGrid`.
196
+ *
197
+ * The passed function and listener object must match the ones used for event registration.
198
+ *
199
+ * @returns Reference to `this` in order to allow method chaining
200
+ */
201
+ detachStateChange(
202
+ /**
203
+ * The function to be called, when the event occurs
204
+ */
205
+ fnFunction: (p1: Event) => void,
206
+ /**
207
+ * Context object on which the given function had to be called
208
+ */
209
+ oListener?: object
210
+ ): this;
211
+ /**
212
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
213
+ *
214
+ * Fires event {@link #event:selectionChange selectionChange} to attached listeners.
215
+ *
216
+ * @returns Reference to `this` in order to allow method chaining
217
+ */
218
+ fireSelectionChange(
219
+ /**
220
+ * Parameters to pass along with the event
221
+ */
222
+ mParameters?: {
223
+ /**
224
+ * A SelectionVariant specifying the current selection state of the AnalyticGrid.
225
+ */
226
+ selection?: object;
227
+ }
228
+ ): this;
229
+ /**
230
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
231
+ *
232
+ * Fires event {@link #event:stateChange stateChange} to attached listeners.
233
+ *
234
+ * @returns Reference to `this` in order to allow method chaining
235
+ */
236
+ fireStateChange(
237
+ /**
238
+ * Parameters to pass along with the event
239
+ */
240
+ mParameters?: {
241
+ /**
242
+ * Serialized state string.
243
+ */
244
+ state?: string;
245
+ }
246
+ ): this;
247
+ /**
248
+ * Gets current value of property {@link #getHeight height}.
249
+ *
250
+ * Desired width of the AnalyticGrid control
251
+ *
252
+ * @returns Value of property `height`
253
+ */
254
+ getHeight(): CSSSize;
255
+ /**
256
+ * Gets current value of property {@link #getQueryName queryName}.
257
+ *
258
+ * Name of the Query to bind the AnalyticGrid to.
259
+ *
260
+ * @returns Value of property `queryName`
261
+ */
262
+ getQueryName(): string;
263
+ /**
264
+ * Gets current value of property {@link #getSelection selection}.
265
+ *
266
+ * A SelectionVariant specifying the initial selection state used by the AnalyticGrid. Depending on the
267
+ * specific query and selection variant state, this will result in setting one or more variables' values
268
+ * and setting one or more filters on the datasource.
269
+ *
270
+ * @returns Value of property `selection`
271
+ */
272
+ getSelection(): object;
273
+ /**
274
+ * Gets current value of property {@link #getState state}.
275
+ *
276
+ * A string representing the current state of the analytic grid, including data selection and navigation
277
+ * state. Intended to be used for saving and recreating inner application state in navigation scenarios,
278
+ * for example.
279
+ *
280
+ * @returns Value of property `state`
281
+ */
282
+ getState(): string;
283
+ /**
284
+ * Gets current value of property {@link #getSystemAlias systemAlias}.
285
+ *
286
+ * Target System alias for data connectivity
287
+ *
288
+ * @returns Value of property `systemAlias`
289
+ */
290
+ getSystemAlias(): string;
291
+ /**
292
+ * Gets current value of property {@link #getWidth width}.
293
+ *
294
+ * Desired width of the AnalyticGrid control
295
+ *
296
+ * @returns Value of property `width`
297
+ */
298
+ getWidth(): CSSSize;
299
+ /**
300
+ * Sets a new value for property {@link #getHeight height}.
301
+ *
302
+ * Desired width of the AnalyticGrid control
303
+ *
304
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
305
+ *
306
+ * @returns Reference to `this` in order to allow method chaining
307
+ */
308
+ setHeight(
309
+ /**
310
+ * New value for property `height`
311
+ */
312
+ sHeight?: CSSSize
313
+ ): this;
314
+ /**
315
+ * Sets a new value for property {@link #getQueryName queryName}.
316
+ *
317
+ * Name of the Query to bind the AnalyticGrid to.
318
+ *
319
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
320
+ *
321
+ * @returns Reference to `this` in order to allow method chaining
322
+ */
323
+ setQueryName(
324
+ /**
325
+ * New value for property `queryName`
326
+ */
327
+ sQueryName?: string
328
+ ): this;
329
+ /**
330
+ * Sets a new value for property {@link #getSelection selection}.
331
+ *
332
+ * A SelectionVariant specifying the initial selection state used by the AnalyticGrid. Depending on the
333
+ * specific query and selection variant state, this will result in setting one or more variables' values
334
+ * and setting one or more filters on the datasource.
335
+ *
336
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
337
+ *
338
+ * @returns Reference to `this` in order to allow method chaining
339
+ */
340
+ setSelection(
341
+ /**
342
+ * New value for property `selection`
343
+ */
344
+ oSelection?: object
345
+ ): this;
346
+ /**
347
+ * Sets a new value for property {@link #getState state}.
348
+ *
349
+ * A string representing the current state of the analytic grid, including data selection and navigation
350
+ * state. Intended to be used for saving and recreating inner application state in navigation scenarios,
351
+ * for example.
352
+ *
353
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
354
+ *
355
+ * @returns Reference to `this` in order to allow method chaining
356
+ */
357
+ setState(
358
+ /**
359
+ * New value for property `state`
360
+ */
361
+ sState?: string
362
+ ): this;
363
+ /**
364
+ * Sets a new value for property {@link #getSystemAlias systemAlias}.
365
+ *
366
+ * Target System alias for data connectivity
367
+ *
368
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
369
+ *
370
+ * @returns Reference to `this` in order to allow method chaining
371
+ */
372
+ setSystemAlias(
373
+ /**
374
+ * New value for property `systemAlias`
375
+ */
376
+ sSystemAlias?: string
377
+ ): this;
378
+ /**
379
+ * Sets a new value for property {@link #getWidth width}.
380
+ *
381
+ * Desired width of the AnalyticGrid control
382
+ *
383
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
384
+ *
385
+ * @returns Reference to `this` in order to allow method chaining
386
+ */
387
+ setWidth(
388
+ /**
389
+ * New value for property `width`
390
+ */
391
+ sWidth?: CSSSize
392
+ ): this;
393
+ }
394
+
395
+ export interface $AnalyticGridSettings extends $ControlSettings {
396
+ /**
397
+ * Desired width of the AnalyticGrid control
398
+ */
399
+ width?: CSSSize | PropertyBindingInfo | `{${string}}`;
400
+
401
+ /**
402
+ * Desired width of the AnalyticGrid control
403
+ */
404
+ height?: CSSSize | PropertyBindingInfo | `{${string}}`;
405
+
406
+ /**
407
+ * A SelectionVariant specifying the initial selection state used by the AnalyticGrid. Depending on the
408
+ * specific query and selection variant state, this will result in setting one or more variables' values
409
+ * and setting one or more filters on the datasource.
410
+ */
411
+ selection?: object | PropertyBindingInfo | `{${string}}`;
412
+
413
+ /**
414
+ * Name of the Query to bind the AnalyticGrid to.
415
+ */
416
+ queryName?: string | PropertyBindingInfo;
417
+
418
+ /**
419
+ * Target System alias for data connectivity
420
+ */
421
+ systemAlias?: string | PropertyBindingInfo;
422
+
423
+ /**
424
+ * A string representing the current state of the analytic grid, including data selection and navigation
425
+ * state. Intended to be used for saving and recreating inner application state in navigation scenarios,
426
+ * for example.
427
+ */
428
+ state?: string | PropertyBindingInfo;
429
+
430
+ /**
431
+ * Event is triggered when the state of the AnalyticGrid is changed.
432
+ */
433
+ stateChange?: (oEvent: Event) => void;
434
+
435
+ /**
436
+ * Event is triggered when the selection is changed.
437
+ */
438
+ selectionChange?: (oEvent: Event) => void;
439
+ }
440
+ }
441
+
442
+ declare module "sap/zen/dsh/Dsh" {
443
+ import { default as Control, $ControlSettings } from "sap/ui/core/Control";
444
+
445
+ import { CSSSize } from "sap/ui/core/library";
446
+
447
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
448
+
449
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
450
+
451
+ /**
452
+ * @SINCE 1.44
453
+ * @deprecated (since 1.89)
454
+ *
455
+ * Control for embedding a Design Studio application full-screen in an S/4 HANA Fiori application
456
+ */
457
+ export default class Dsh extends Control {
458
+ /**
459
+ * Constructor for a new Dsh.
460
+ *
461
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
462
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
463
+ * of the syntax of the settings object.
464
+ */
465
+ constructor(
466
+ /**
467
+ * initial settings for the new control
468
+ */
469
+ mSettings?: $DshSettings
470
+ );
471
+ /**
472
+ * Constructor for a new Dsh.
473
+ *
474
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
475
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
476
+ * of the syntax of the settings object.
477
+ */
478
+ constructor(
479
+ /**
480
+ * id for the new control, generated automatically if no id is given
481
+ */
482
+ sId?: string,
483
+ /**
484
+ * initial settings for the new control
485
+ */
486
+ mSettings?: $DshSettings
487
+ );
488
+
489
+ /**
490
+ * Creates a new subclass of class sap.zen.dsh.Dsh with name `sClassName` and enriches it with the information
491
+ * contained in `oClassInfo`.
492
+ *
493
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
494
+ *
495
+ * @returns Created class / constructor function
496
+ */
497
+ static extend<T extends Record<string, unknown>>(
498
+ /**
499
+ * Name of the class being created
500
+ */
501
+ sClassName: string,
502
+ /**
503
+ * Object literal with information about the class
504
+ */
505
+ oClassInfo?: sap.ClassInfo<T, Dsh>,
506
+ /**
507
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
508
+ * used by this class
509
+ */
510
+ FNMetaImpl?: Function
511
+ ): Function;
512
+ /**
513
+ * Returns a metadata object for class sap.zen.dsh.Dsh.
514
+ *
515
+ * @returns Metadata object describing this class
516
+ */
517
+ static getMetadata(): ElementMetadata;
518
+
519
+ addParameter(
520
+ /**
521
+ * the name of the parameter
522
+ */
523
+ sName: string,
524
+ /**
525
+ * the value of the parameter
526
+ */
527
+ sValue: string
528
+ ): string;
529
+
530
+ createPage(): void;
531
+
532
+ executeScript(
533
+ /**
534
+ * the content of the script
535
+ */
536
+ sScript: string
537
+ ): void;
538
+ /**
539
+ * Gets current value of property {@link #getAppComponent appComponent}.
540
+ *
541
+ * the application component
542
+ *
543
+ * @returns Value of property `appComponent`
544
+ */
545
+ getAppComponent(): object;
546
+ /**
547
+ * Gets current value of property {@link #getClient client}.
548
+ *
549
+ * the client
550
+ *
551
+ * @returns Value of property `client`
552
+ */
553
+ getClient(): string;
554
+
555
+ getComponent(
556
+ /**
557
+ * the Name of the Component
558
+ */
559
+ sName: string
560
+ ): object;
561
+
562
+ getDataSource(
563
+ /**
564
+ * the namw of the data source
565
+ */
566
+ sName: string
567
+ ): object;
568
+ /**
569
+ * Gets current value of property {@link #getDeferCreation deferCreation}.
570
+ *
571
+ * whether to defer the creation
572
+ *
573
+ * Default value is `false`.
574
+ *
575
+ * @returns Value of property `deferCreation`
576
+ */
577
+ getDeferCreation(): boolean;
578
+ /**
579
+ * Gets current value of property {@link #getDeployment deployment}.
580
+ *
581
+ * the type of deployment
582
+ *
583
+ * Default value is `"bw"`.
584
+ *
585
+ * @returns Value of property `deployment`
586
+ */
587
+ getDeployment(): string;
588
+ /**
589
+ * Gets current value of property {@link #getDshAppName dshAppName}.
590
+ *
591
+ * Name of the Design Studio application to be opened.
592
+ *
593
+ * Default value is `"0ANALYSIS"`.
594
+ *
595
+ * @returns Value of property `dshAppName`
596
+ */
597
+ getDshAppName(): string;
598
+ /**
599
+ * Gets current value of property {@link #getHeight height}.
600
+ *
601
+ * Desired height of the Design Studio Control
602
+ *
603
+ * @returns Value of property `height`
604
+ */
605
+ getHeight(): CSSSize;
606
+ /**
607
+ * Gets current value of property {@link #getLanguage language}.
608
+ *
609
+ * the language
610
+ *
611
+ * @returns Value of property `language`
612
+ */
613
+ getLanguage(): string;
614
+
615
+ getPage(): object;
616
+ /**
617
+ * Gets current value of property {@link #getProtocol protocol}.
618
+ *
619
+ * the protocol
620
+ *
621
+ * @returns Value of property `protocol`
622
+ */
623
+ getProtocol(): string;
624
+ /**
625
+ * Gets current value of property {@link #getRepoPath repoPath}.
626
+ *
627
+ * Path to application specified by dshAppName
628
+ *
629
+ * @returns Value of property `repoPath`
630
+ */
631
+ getRepoPath(): string;
632
+ /**
633
+ * Gets current value of property {@link #getSemanticMappings semanticMappings}.
634
+ *
635
+ * the semantic mappings
636
+ *
637
+ * @returns Value of property `semanticMappings`
638
+ */
639
+ getSemanticMappings(): object;
640
+ /**
641
+ * Gets current value of property {@link #getSystemAlias systemAlias}.
642
+ *
643
+ * the system alias
644
+ *
645
+ * @returns Value of property `systemAlias`
646
+ */
647
+ getSystemAlias(): string;
648
+ /**
649
+ * Gets current value of property {@link #getWidth width}.
650
+ *
651
+ * Desired width of the Design Studio Control
652
+ *
653
+ * @returns Value of property `width`
654
+ */
655
+ getWidth(): CSSSize;
656
+ /**
657
+ * Initialize cross-application navigation state with an AppState object
658
+ */
659
+ initializeAppState(
660
+ /**
661
+ * The AppState object from which to retrieve and apply Application State.
662
+ */
663
+ oOStartupAppState: object,
664
+ /**
665
+ * Simple Javascript object containing name-value pairs of additional navigation state to be mixed in
666
+ */
667
+ oONavParams: object
668
+ ): void;
669
+ /**
670
+ * Initialize cross-application navigation state directly with AppStateData. e.g., when calculated by sap.ui.generic.app.navigation.service.NavigationHandler
671
+ */
672
+ initializeAppStateData(
673
+ /**
674
+ * The AppStateData to apply
675
+ */
676
+ oOStateData: object,
677
+ /**
678
+ * Simple Javascript object containing name-value pairs of additional navigation state to be mixed in
679
+ */
680
+ oONavParams: object
681
+ ): void;
682
+ /**
683
+ * Sets a new value for property {@link #getAppComponent appComponent}.
684
+ *
685
+ * the application component
686
+ *
687
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
688
+ *
689
+ * @returns Reference to `this` in order to allow method chaining
690
+ */
691
+ setAppComponent(
692
+ /**
693
+ * New value for property `appComponent`
694
+ */
695
+ oAppComponent?: object
696
+ ): this;
697
+ /**
698
+ * Sets a new value for property {@link #getClient client}.
699
+ *
700
+ * the client
701
+ *
702
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
703
+ *
704
+ * @returns Reference to `this` in order to allow method chaining
705
+ */
706
+ setClient(
707
+ /**
708
+ * New value for property `client`
709
+ */
710
+ sClient?: string
711
+ ): this;
712
+ /**
713
+ * Sets a new value for property {@link #getDeferCreation deferCreation}.
714
+ *
715
+ * whether to defer the creation
716
+ *
717
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
718
+ *
719
+ * Default value is `false`.
720
+ *
721
+ * @returns Reference to `this` in order to allow method chaining
722
+ */
723
+ setDeferCreation(
724
+ /**
725
+ * New value for property `deferCreation`
726
+ */
727
+ bDeferCreation?: boolean
728
+ ): this;
729
+ /**
730
+ * Sets a new value for property {@link #getDeployment deployment}.
731
+ *
732
+ * the type of deployment
733
+ *
734
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
735
+ *
736
+ * Default value is `"bw"`.
737
+ *
738
+ * @returns Reference to `this` in order to allow method chaining
739
+ */
740
+ setDeployment(
741
+ /**
742
+ * New value for property `deployment`
743
+ */
744
+ sDeployment?: string
745
+ ): this;
746
+ /**
747
+ * Sets a new value for property {@link #getDshAppName dshAppName}.
748
+ *
749
+ * Name of the Design Studio application to be opened.
750
+ *
751
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
752
+ *
753
+ * Default value is `"0ANALYSIS"`.
754
+ *
755
+ * @returns Reference to `this` in order to allow method chaining
756
+ */
757
+ setDshAppName(
758
+ /**
759
+ * New value for property `dshAppName`
760
+ */
761
+ sDshAppName?: string
762
+ ): this;
763
+ /**
764
+ * Sets a new value for property {@link #getHeight height}.
765
+ *
766
+ * Desired height of the Design Studio Control
767
+ *
768
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
769
+ *
770
+ * @returns Reference to `this` in order to allow method chaining
771
+ */
772
+ setHeight(
773
+ /**
774
+ * New value for property `height`
775
+ */
776
+ sHeight?: CSSSize
777
+ ): this;
778
+ /**
779
+ * Sets a new value for property {@link #getLanguage language}.
780
+ *
781
+ * the language
782
+ *
783
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
784
+ *
785
+ * @returns Reference to `this` in order to allow method chaining
786
+ */
787
+ setLanguage(
788
+ /**
789
+ * New value for property `language`
790
+ */
791
+ sLanguage?: string
792
+ ): this;
793
+ /**
794
+ * Sets a new value for property {@link #getProtocol protocol}.
795
+ *
796
+ * the protocol
797
+ *
798
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
799
+ *
800
+ * @returns Reference to `this` in order to allow method chaining
801
+ */
802
+ setProtocol(
803
+ /**
804
+ * New value for property `protocol`
805
+ */
806
+ sProtocol?: string
807
+ ): this;
808
+ /**
809
+ * Sets a new value for property {@link #getRepoPath repoPath}.
810
+ *
811
+ * Path to application specified by dshAppName
812
+ *
813
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
814
+ *
815
+ * @returns Reference to `this` in order to allow method chaining
816
+ */
817
+ setRepoPath(
818
+ /**
819
+ * New value for property `repoPath`
820
+ */
821
+ sRepoPath?: string
822
+ ): this;
823
+ /**
824
+ * Sets a new value for property {@link #getSemanticMappings semanticMappings}.
825
+ *
826
+ * the semantic mappings
827
+ *
828
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
829
+ *
830
+ * @returns Reference to `this` in order to allow method chaining
831
+ */
832
+ setSemanticMappings(
833
+ /**
834
+ * New value for property `semanticMappings`
835
+ */
836
+ oSemanticMappings?: object
837
+ ): this;
838
+ /**
839
+ * Sets a new value for property {@link #getSystemAlias systemAlias}.
840
+ *
841
+ * the system alias
842
+ *
843
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
844
+ *
845
+ * @returns Reference to `this` in order to allow method chaining
846
+ */
847
+ setSystemAlias(
848
+ /**
849
+ * New value for property `systemAlias`
850
+ */
851
+ sSystemAlias?: string
852
+ ): this;
853
+ /**
854
+ * Sets a new value for property {@link #getWidth width}.
855
+ *
856
+ * Desired width of the Design Studio Control
857
+ *
858
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
859
+ *
860
+ * @returns Reference to `this` in order to allow method chaining
861
+ */
862
+ setWidth(
863
+ /**
864
+ * New value for property `width`
865
+ */
866
+ sWidth?: CSSSize
867
+ ): this;
868
+ }
869
+
870
+ export interface $DshSettings extends $ControlSettings {
871
+ /**
872
+ * Name of the Design Studio application to be opened.
873
+ */
874
+ dshAppName?: string | PropertyBindingInfo;
875
+
876
+ /**
877
+ * Path to application specified by dshAppName
878
+ */
879
+ repoPath?: string | PropertyBindingInfo;
880
+
881
+ /**
882
+ * Desired width of the Design Studio Control
883
+ */
884
+ width?: CSSSize | PropertyBindingInfo | `{${string}}`;
885
+
886
+ /**
887
+ * Desired height of the Design Studio Control
888
+ */
889
+ height?: CSSSize | PropertyBindingInfo | `{${string}}`;
890
+
891
+ /**
892
+ * the type of deployment
893
+ */
894
+ deployment?: string | PropertyBindingInfo;
895
+
896
+ /**
897
+ * the protocol
898
+ */
899
+ protocol?: string | PropertyBindingInfo;
900
+
901
+ /**
902
+ * the client
903
+ */
904
+ client?: string | PropertyBindingInfo;
905
+
906
+ /**
907
+ * the language
908
+ */
909
+ language?: string | PropertyBindingInfo;
910
+
911
+ /**
912
+ * the semantic mappings
913
+ */
914
+ semanticMappings?: object | PropertyBindingInfo | `{${string}}`;
915
+
916
+ /**
917
+ * the application component
918
+ */
919
+ appComponent?: object | PropertyBindingInfo | `{${string}}`;
920
+
921
+ /**
922
+ * whether to defer the creation
923
+ */
924
+ deferCreation?: boolean | PropertyBindingInfo | `{${string}}`;
925
+
926
+ /**
927
+ * the system alias
928
+ */
929
+ systemAlias?: string | PropertyBindingInfo;
930
+ }
931
+ }
932
+
933
+ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
934
+ import { default as Dialog, $DialogSettings } from "sap/m/Dialog";
935
+
936
+ import Event from "sap/ui/base/Event";
937
+
938
+ import Token from "sap/m/Token";
939
+
940
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
941
+
942
+ import ValueHelpRangeOperation from "sap/zen/dsh/ValueHelpRangeOperation";
943
+
944
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
945
+
946
+ import Control from "sap/ui/core/Control";
947
+
948
+ /**
949
+ * @deprecated (since 1.89)
950
+ *
951
+ * The ValueHelpDialog control can be used to implement a value help for an input field.
952
+ */
953
+ export default class ValueHelpDialog extends Dialog {
954
+ /**
955
+ * Constructor for a new valuehelpdialog/ValueHelpDialog.
956
+ *
957
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
958
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
959
+ * of the syntax of the settings object.
960
+ */
961
+ constructor(
962
+ /**
963
+ * Initial settings for the new control
964
+ */
965
+ mSettings?: $ValueHelpDialogSettings
966
+ );
967
+ /**
968
+ * Constructor for a new valuehelpdialog/ValueHelpDialog.
969
+ *
970
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
971
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
972
+ * of the syntax of the settings object.
973
+ */
974
+ constructor(
975
+ /**
976
+ * ID for the new control, generated automatically if no ID is given
977
+ */
978
+ sId?: string,
979
+ /**
980
+ * Initial settings for the new control
981
+ */
982
+ mSettings?: $ValueHelpDialogSettings
983
+ );
984
+
985
+ /**
986
+ * Creates a new subclass of class sap.zen.dsh.ValueHelpDialog with name `sClassName` and enriches it with
987
+ * the information contained in `oClassInfo`.
988
+ *
989
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.m.Dialog.extend}.
990
+ *
991
+ * @returns Created class / constructor function
992
+ */
993
+ static extend<T extends Record<string, unknown>>(
994
+ /**
995
+ * Name of the class being created
996
+ */
997
+ sClassName: string,
998
+ /**
999
+ * Object literal with information about the class
1000
+ */
1001
+ oClassInfo?: sap.ClassInfo<T, ValueHelpDialog>,
1002
+ /**
1003
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1004
+ * used by this class
1005
+ */
1006
+ FNMetaImpl?: Function
1007
+ ): Function;
1008
+ /**
1009
+ * Returns a metadata object for class sap.zen.dsh.ValueHelpDialog.
1010
+ *
1011
+ * @returns Metadata object describing this class
1012
+ */
1013
+ static getMetadata(): ElementMetadata;
1014
+ /**
1015
+ * @SINCE 1.24
1016
+ *
1017
+ * Attaches event handler `fnFunction` to the {@link #event:cancel cancel} event of this `sap.zen.dsh.ValueHelpDialog`.
1018
+ *
1019
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1020
+ * otherwise it will be bound to this `sap.zen.dsh.ValueHelpDialog` itself.
1021
+ *
1022
+ * This event is fired when the Cancel button is pressed.
1023
+ *
1024
+ * @returns Reference to `this` in order to allow method chaining
1025
+ */
1026
+ attachCancel(
1027
+ /**
1028
+ * An application-specific payload object that will be passed to the event handler along with the event
1029
+ * object when firing the event
1030
+ */
1031
+ oData: object,
1032
+ /**
1033
+ * The function to be called when the event occurs
1034
+ */
1035
+ fnFunction: (p1: Event) => void,
1036
+ /**
1037
+ * Context object to call the event handler with. Defaults to this `sap.zen.dsh.ValueHelpDialog` itself
1038
+ */
1039
+ oListener?: object
1040
+ ): this;
1041
+ /**
1042
+ * @SINCE 1.24
1043
+ *
1044
+ * Attaches event handler `fnFunction` to the {@link #event:cancel cancel} event of this `sap.zen.dsh.ValueHelpDialog`.
1045
+ *
1046
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1047
+ * otherwise it will be bound to this `sap.zen.dsh.ValueHelpDialog` itself.
1048
+ *
1049
+ * This event is fired when the Cancel button is pressed.
1050
+ *
1051
+ * @returns Reference to `this` in order to allow method chaining
1052
+ */
1053
+ attachCancel(
1054
+ /**
1055
+ * The function to be called when the event occurs
1056
+ */
1057
+ fnFunction: (p1: Event) => void,
1058
+ /**
1059
+ * Context object to call the event handler with. Defaults to this `sap.zen.dsh.ValueHelpDialog` itself
1060
+ */
1061
+ oListener?: object
1062
+ ): this;
1063
+ /**
1064
+ * @SINCE 1.24
1065
+ *
1066
+ * Attaches event handler `fnFunction` to the {@link #event:ok ok} event of this `sap.zen.dsh.ValueHelpDialog`.
1067
+ *
1068
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1069
+ * otherwise it will be bound to this `sap.zen.dsh.ValueHelpDialog` itself.
1070
+ *
1071
+ * This event is fired when the OK button is pressed.
1072
+ *
1073
+ * @returns Reference to `this` in order to allow method chaining
1074
+ */
1075
+ attachOk(
1076
+ /**
1077
+ * An application-specific payload object that will be passed to the event handler along with the event
1078
+ * object when firing the event
1079
+ */
1080
+ oData: object,
1081
+ /**
1082
+ * The function to be called when the event occurs
1083
+ */
1084
+ fnFunction: (p1: Event) => void,
1085
+ /**
1086
+ * Context object to call the event handler with. Defaults to this `sap.zen.dsh.ValueHelpDialog` itself
1087
+ */
1088
+ oListener?: object
1089
+ ): this;
1090
+ /**
1091
+ * @SINCE 1.24
1092
+ *
1093
+ * Attaches event handler `fnFunction` to the {@link #event:ok ok} event of this `sap.zen.dsh.ValueHelpDialog`.
1094
+ *
1095
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1096
+ * otherwise it will be bound to this `sap.zen.dsh.ValueHelpDialog` itself.
1097
+ *
1098
+ * This event is fired when the OK button is pressed.
1099
+ *
1100
+ * @returns Reference to `this` in order to allow method chaining
1101
+ */
1102
+ attachOk(
1103
+ /**
1104
+ * The function to be called when the event occurs
1105
+ */
1106
+ fnFunction: (p1: Event) => void,
1107
+ /**
1108
+ * Context object to call the event handler with. Defaults to this `sap.zen.dsh.ValueHelpDialog` itself
1109
+ */
1110
+ oListener?: object
1111
+ ): this;
1112
+ /**
1113
+ * @SINCE 1.32
1114
+ *
1115
+ * Attaches event handler `fnFunction` to the {@link #event:selectionChange selectionChange} event of this
1116
+ * `sap.zen.dsh.ValueHelpDialog`.
1117
+ *
1118
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1119
+ * otherwise it will be bound to this `sap.zen.dsh.ValueHelpDialog` itself.
1120
+ *
1121
+ * This event is fired when the user selects an item in the items table.
1122
+ *
1123
+ * **Note:** The event will only be raised when the dialog gets a table instance from outside via `setTable`.
1124
+ *
1125
+ * @returns Reference to `this` in order to allow method chaining
1126
+ */
1127
+ attachSelectionChange(
1128
+ /**
1129
+ * An application-specific payload object that will be passed to the event handler along with the event
1130
+ * object when firing the event
1131
+ */
1132
+ oData: object,
1133
+ /**
1134
+ * The function to be called when the event occurs
1135
+ */
1136
+ fnFunction: (p1: Event) => void,
1137
+ /**
1138
+ * Context object to call the event handler with. Defaults to this `sap.zen.dsh.ValueHelpDialog` itself
1139
+ */
1140
+ oListener?: object
1141
+ ): this;
1142
+ /**
1143
+ * @SINCE 1.32
1144
+ *
1145
+ * Attaches event handler `fnFunction` to the {@link #event:selectionChange selectionChange} event of this
1146
+ * `sap.zen.dsh.ValueHelpDialog`.
1147
+ *
1148
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1149
+ * otherwise it will be bound to this `sap.zen.dsh.ValueHelpDialog` itself.
1150
+ *
1151
+ * This event is fired when the user selects an item in the items table.
1152
+ *
1153
+ * **Note:** The event will only be raised when the dialog gets a table instance from outside via `setTable`.
1154
+ *
1155
+ * @returns Reference to `this` in order to allow method chaining
1156
+ */
1157
+ attachSelectionChange(
1158
+ /**
1159
+ * The function to be called when the event occurs
1160
+ */
1161
+ fnFunction: (p1: Event) => void,
1162
+ /**
1163
+ * Context object to call the event handler with. Defaults to this `sap.zen.dsh.ValueHelpDialog` itself
1164
+ */
1165
+ oListener?: object
1166
+ ): this;
1167
+ /**
1168
+ * @SINCE 1.32
1169
+ *
1170
+ * Attaches event handler `fnFunction` to the {@link #event:tokenRemove tokenRemove} event of this `sap.zen.dsh.ValueHelpDialog`.
1171
+ *
1172
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1173
+ * otherwise it will be bound to this `sap.zen.dsh.ValueHelpDialog` itself.
1174
+ *
1175
+ * This event is fired when the user removes one or multiple existing token(s) from the dialog.
1176
+ *
1177
+ * **Note:** The event will only be raised when the dialog gets a table instance from outside via `setTable`.
1178
+ *
1179
+ * @returns Reference to `this` in order to allow method chaining
1180
+ */
1181
+ attachTokenRemove(
1182
+ /**
1183
+ * An application-specific payload object that will be passed to the event handler along with the event
1184
+ * object when firing the event
1185
+ */
1186
+ oData: object,
1187
+ /**
1188
+ * The function to be called when the event occurs
1189
+ */
1190
+ fnFunction: (p1: Event) => void,
1191
+ /**
1192
+ * Context object to call the event handler with. Defaults to this `sap.zen.dsh.ValueHelpDialog` itself
1193
+ */
1194
+ oListener?: object
1195
+ ): this;
1196
+ /**
1197
+ * @SINCE 1.32
1198
+ *
1199
+ * Attaches event handler `fnFunction` to the {@link #event:tokenRemove tokenRemove} event of this `sap.zen.dsh.ValueHelpDialog`.
1200
+ *
1201
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1202
+ * otherwise it will be bound to this `sap.zen.dsh.ValueHelpDialog` itself.
1203
+ *
1204
+ * This event is fired when the user removes one or multiple existing token(s) from the dialog.
1205
+ *
1206
+ * **Note:** The event will only be raised when the dialog gets a table instance from outside via `setTable`.
1207
+ *
1208
+ * @returns Reference to `this` in order to allow method chaining
1209
+ */
1210
+ attachTokenRemove(
1211
+ /**
1212
+ * The function to be called when the event occurs
1213
+ */
1214
+ fnFunction: (p1: Event) => void,
1215
+ /**
1216
+ * Context object to call the event handler with. Defaults to this `sap.zen.dsh.ValueHelpDialog` itself
1217
+ */
1218
+ oListener?: object
1219
+ ): this;
1220
+ /**
1221
+ * @SINCE 1.32
1222
+ *
1223
+ * Attaches event handler `fnFunction` to the {@link #event:updateSelection updateSelection} event of this
1224
+ * `sap.zen.dsh.ValueHelpDialog`.
1225
+ *
1226
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1227
+ * otherwise it will be bound to this `sap.zen.dsh.ValueHelpDialog` itself.
1228
+ *
1229
+ * This event is fired when the table gets an update and all existing tokens must be selected in the table.
1230
+ *
1231
+ * **Note:** The event will only be raised when the dialog gets a table instance from outside via `setTable`.
1232
+ *
1233
+ * @returns Reference to `this` in order to allow method chaining
1234
+ */
1235
+ attachUpdateSelection(
1236
+ /**
1237
+ * An application-specific payload object that will be passed to the event handler along with the event
1238
+ * object when firing the event
1239
+ */
1240
+ oData: object,
1241
+ /**
1242
+ * The function to be called when the event occurs
1243
+ */
1244
+ fnFunction: (p1: Event) => void,
1245
+ /**
1246
+ * Context object to call the event handler with. Defaults to this `sap.zen.dsh.ValueHelpDialog` itself
1247
+ */
1248
+ oListener?: object
1249
+ ): this;
1250
+ /**
1251
+ * @SINCE 1.32
1252
+ *
1253
+ * Attaches event handler `fnFunction` to the {@link #event:updateSelection updateSelection} event of this
1254
+ * `sap.zen.dsh.ValueHelpDialog`.
1255
+ *
1256
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1257
+ * otherwise it will be bound to this `sap.zen.dsh.ValueHelpDialog` itself.
1258
+ *
1259
+ * This event is fired when the table gets an update and all existing tokens must be selected in the table.
1260
+ *
1261
+ * **Note:** The event will only be raised when the dialog gets a table instance from outside via `setTable`.
1262
+ *
1263
+ * @returns Reference to `this` in order to allow method chaining
1264
+ */
1265
+ attachUpdateSelection(
1266
+ /**
1267
+ * The function to be called when the event occurs
1268
+ */
1269
+ fnFunction: (p1: Event) => void,
1270
+ /**
1271
+ * Context object to call the event handler with. Defaults to this `sap.zen.dsh.ValueHelpDialog` itself
1272
+ */
1273
+ oListener?: object
1274
+ ): this;
1275
+ /**
1276
+ * Destroys the filterBar in the aggregation {@link #getFilterBar filterBar}.
1277
+ *
1278
+ * @returns Reference to `this` in order to allow method chaining
1279
+ */
1280
+ destroyFilterBar(): this;
1281
+ /**
1282
+ * @SINCE 1.24
1283
+ *
1284
+ * Detaches event handler `fnFunction` from the {@link #event:cancel cancel} event of this `sap.zen.dsh.ValueHelpDialog`.
1285
+ *
1286
+ * The passed function and listener object must match the ones used for event registration.
1287
+ *
1288
+ * @returns Reference to `this` in order to allow method chaining
1289
+ */
1290
+ detachCancel(
1291
+ /**
1292
+ * The function to be called, when the event occurs
1293
+ */
1294
+ fnFunction: (p1: Event) => void,
1295
+ /**
1296
+ * Context object on which the given function had to be called
1297
+ */
1298
+ oListener?: object
1299
+ ): this;
1300
+ /**
1301
+ * @SINCE 1.24
1302
+ *
1303
+ * Detaches event handler `fnFunction` from the {@link #event:ok ok} event of this `sap.zen.dsh.ValueHelpDialog`.
1304
+ *
1305
+ * The passed function and listener object must match the ones used for event registration.
1306
+ *
1307
+ * @returns Reference to `this` in order to allow method chaining
1308
+ */
1309
+ detachOk(
1310
+ /**
1311
+ * The function to be called, when the event occurs
1312
+ */
1313
+ fnFunction: (p1: Event) => void,
1314
+ /**
1315
+ * Context object on which the given function had to be called
1316
+ */
1317
+ oListener?: object
1318
+ ): this;
1319
+ /**
1320
+ * @SINCE 1.32
1321
+ *
1322
+ * Detaches event handler `fnFunction` from the {@link #event:selectionChange selectionChange} event of
1323
+ * this `sap.zen.dsh.ValueHelpDialog`.
1324
+ *
1325
+ * The passed function and listener object must match the ones used for event registration.
1326
+ *
1327
+ * @returns Reference to `this` in order to allow method chaining
1328
+ */
1329
+ detachSelectionChange(
1330
+ /**
1331
+ * The function to be called, when the event occurs
1332
+ */
1333
+ fnFunction: (p1: Event) => void,
1334
+ /**
1335
+ * Context object on which the given function had to be called
1336
+ */
1337
+ oListener?: object
1338
+ ): this;
1339
+ /**
1340
+ * @SINCE 1.32
1341
+ *
1342
+ * Detaches event handler `fnFunction` from the {@link #event:tokenRemove tokenRemove} event of this `sap.zen.dsh.ValueHelpDialog`.
1343
+ *
1344
+ * The passed function and listener object must match the ones used for event registration.
1345
+ *
1346
+ * @returns Reference to `this` in order to allow method chaining
1347
+ */
1348
+ detachTokenRemove(
1349
+ /**
1350
+ * The function to be called, when the event occurs
1351
+ */
1352
+ fnFunction: (p1: Event) => void,
1353
+ /**
1354
+ * Context object on which the given function had to be called
1355
+ */
1356
+ oListener?: object
1357
+ ): this;
1358
+ /**
1359
+ * @SINCE 1.32
1360
+ *
1361
+ * Detaches event handler `fnFunction` from the {@link #event:updateSelection updateSelection} event of
1362
+ * this `sap.zen.dsh.ValueHelpDialog`.
1363
+ *
1364
+ * The passed function and listener object must match the ones used for event registration.
1365
+ *
1366
+ * @returns Reference to `this` in order to allow method chaining
1367
+ */
1368
+ detachUpdateSelection(
1369
+ /**
1370
+ * The function to be called, when the event occurs
1371
+ */
1372
+ fnFunction: (p1: Event) => void,
1373
+ /**
1374
+ * Context object on which the given function had to be called
1375
+ */
1376
+ oListener?: object
1377
+ ): this;
1378
+ /**
1379
+ * @SINCE 1.24
1380
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1381
+ *
1382
+ * Fires event {@link #event:cancel cancel} to attached listeners.
1383
+ *
1384
+ * @returns Reference to `this` in order to allow method chaining
1385
+ */
1386
+ fireCancel(
1387
+ /**
1388
+ * Parameters to pass along with the event
1389
+ */
1390
+ mParameters?: object
1391
+ ): this;
1392
+ /**
1393
+ * @SINCE 1.24
1394
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1395
+ *
1396
+ * Fires event {@link #event:ok ok} to attached listeners.
1397
+ *
1398
+ * @returns Reference to `this` in order to allow method chaining
1399
+ */
1400
+ fireOk(
1401
+ /**
1402
+ * Parameters to pass along with the event
1403
+ */
1404
+ mParameters?: {
1405
+ /**
1406
+ * The array of tokens created or modified on the ValueHelpDialog.
1407
+ */
1408
+ tokens?: Token[];
1409
+ }
1410
+ ): this;
1411
+ /**
1412
+ * @SINCE 1.32
1413
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1414
+ *
1415
+ * Fires event {@link #event:selectionChange selectionChange} to attached listeners.
1416
+ *
1417
+ * @returns Reference to `this` in order to allow method chaining
1418
+ */
1419
+ fireSelectionChange(
1420
+ /**
1421
+ * Parameters to pass along with the event
1422
+ */
1423
+ mParameters?: {
1424
+ /**
1425
+ * The RowSelectionChange event parameter from the hosted table that contains the selected items.
1426
+ */
1427
+ tableSelectionParams?: object;
1428
+ /**
1429
+ * Returns an array of objects which represents all selected row tokens. The object contains the token key,
1430
+ * the row object data from the model, and the information if the token is selected. ` [{sKey, oRow, bSelect},
1431
+ * ...] `
1432
+ */
1433
+ updateTokens?: object[];
1434
+ /**
1435
+ * Can be set to `true` to execute the default behaviour of the ValueHelpDialog.
1436
+ */
1437
+ useDefault?: boolean;
1438
+ }
1439
+ ): this;
1440
+ /**
1441
+ * @SINCE 1.32
1442
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1443
+ *
1444
+ * Fires event {@link #event:tokenRemove tokenRemove} to attached listeners.
1445
+ *
1446
+ * @returns Reference to `this` in order to allow method chaining
1447
+ */
1448
+ fireTokenRemove(
1449
+ /**
1450
+ * Parameters to pass along with the event
1451
+ */
1452
+ mParameters?: {
1453
+ /**
1454
+ * The array of token keys that has been removed.
1455
+ */
1456
+ tokenKeys?: string[];
1457
+ /**
1458
+ * Can be set to true to execute the default behaviour of ValueHelpDialog.
1459
+ */
1460
+ useDefault?: boolean;
1461
+ }
1462
+ ): this;
1463
+ /**
1464
+ * @SINCE 1.32
1465
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1466
+ *
1467
+ * Fires event {@link #event:updateSelection updateSelection} to attached listeners.
1468
+ *
1469
+ * @returns Reference to `this` in order to allow method chaining
1470
+ */
1471
+ fireUpdateSelection(
1472
+ /**
1473
+ * Parameters to pass along with the event
1474
+ */
1475
+ mParameters?: {
1476
+ /**
1477
+ * The array of existing token keys for which the selection in the table has to be updated.
1478
+ */
1479
+ tokenKeys?: string[];
1480
+ /**
1481
+ * Can be set to true to execute the default behavior of ValueHelpDialog.
1482
+ */
1483
+ useDefault?: boolean;
1484
+ }
1485
+ ): this;
1486
+ /**
1487
+ * @SINCE 1.24
1488
+ *
1489
+ * Gets current value of property {@link #getBasicSearchText basicSearchText}.
1490
+ *
1491
+ * Defines the value for the basic search field. The value is set into the basic search field of the filter
1492
+ * bar used.
1493
+ *
1494
+ * Default value is `empty string`.
1495
+ *
1496
+ * @returns Value of property `basicSearchText`
1497
+ */
1498
+ getBasicSearchText(): string;
1499
+ /**
1500
+ * @SINCE 1.24
1501
+ *
1502
+ * Gets current value of property {@link #getDescriptionKey descriptionKey}.
1503
+ *
1504
+ * Defines the key of the column used for the token text.
1505
+ *
1506
+ * Default value is `empty string`.
1507
+ *
1508
+ * @returns Value of property `descriptionKey`
1509
+ */
1510
+ getDescriptionKey(): string;
1511
+ /**
1512
+ * @SINCE 1.24
1513
+ *
1514
+ * Gets current value of property {@link #getDisplayFormat displayFormat}.
1515
+ *
1516
+ * Represents the display format of the range values. With the `displayFormat` value UpperCase, the entered
1517
+ * value of the range (condition) is converted to uppercase letters.
1518
+ *
1519
+ * Default value is `empty string`.
1520
+ *
1521
+ * @returns Value of property `displayFormat`
1522
+ */
1523
+ getDisplayFormat(): string;
1524
+ /**
1525
+ * @SINCE 1.24
1526
+ *
1527
+ * Gets current value of property {@link #getFilterMode filterMode}.
1528
+ *
1529
+ * Sets the dialog into a filter mode, which only shows ranges (conditions) and hides the tokens.
1530
+ *
1531
+ * Default value is `false`.
1532
+ *
1533
+ * @returns Value of property `filterMode`
1534
+ */
1535
+ getFilterMode(): boolean;
1536
+ /**
1537
+ * @SINCE 1.24
1538
+ *
1539
+ * Gets current value of property {@link #getKey key}.
1540
+ *
1541
+ * Defines the key of the column used for the internal key handling. The value of the column is used for
1542
+ * the token key and also to identify the row in the table.
1543
+ *
1544
+ * Default value is `empty string`.
1545
+ *
1546
+ * @returns Value of property `key`
1547
+ */
1548
+ getKey(): string;
1549
+ /**
1550
+ * @SINCE 1.24
1551
+ *
1552
+ * Gets current value of property {@link #getKeys keys}.
1553
+ *
1554
+ * Defines the list of additional keys of the column used for the internal key handling.
1555
+ *
1556
+ * @returns Value of property `keys`
1557
+ */
1558
+ getKeys(): string[];
1559
+ /**
1560
+ * @SINCE 1.24
1561
+ *
1562
+ * Gets current value of property {@link #getMaxExcludeRanges maxExcludeRanges}.
1563
+ *
1564
+ * Defines the maximum number of exclude ranges.
1565
+ *
1566
+ * Default value is `"-1"`.
1567
+ *
1568
+ * @returns Value of property `maxExcludeRanges`
1569
+ */
1570
+ getMaxExcludeRanges(): string;
1571
+ /**
1572
+ * @SINCE 1.24
1573
+ *
1574
+ * Gets current value of property {@link #getMaxIncludeRanges maxIncludeRanges}.
1575
+ *
1576
+ * Defines the maximum number of include ranges.
1577
+ *
1578
+ * Default value is `"-1"`.
1579
+ *
1580
+ * @returns Value of property `maxIncludeRanges`
1581
+ */
1582
+ getMaxIncludeRanges(): string;
1583
+ /**
1584
+ * @SINCE 1.24
1585
+ *
1586
+ * Gets current value of property {@link #getSupportMultiselect supportMultiselect}.
1587
+ *
1588
+ * Enables multi-selection in the table used.
1589
+ *
1590
+ * Default value is `true`.
1591
+ *
1592
+ * @returns Value of property `supportMultiselect`
1593
+ */
1594
+ getSupportMultiselect(): boolean;
1595
+ /**
1596
+ * @SINCE 1.24
1597
+ *
1598
+ * Gets current value of property {@link #getSupportRanges supportRanges}.
1599
+ *
1600
+ * Enables the ranges (conditions) feature in the dialog.
1601
+ *
1602
+ * Default value is `false`.
1603
+ *
1604
+ * @returns Value of property `supportRanges`
1605
+ */
1606
+ getSupportRanges(): boolean;
1607
+ /**
1608
+ * @SINCE 1.24
1609
+ *
1610
+ * Gets current value of property {@link #getSupportRangesOnly supportRangesOnly}.
1611
+ *
1612
+ * If this property is set to `true`, the value help dialog only supports the ranges (conditions) feature.
1613
+ *
1614
+ * Default value is `false`.
1615
+ *
1616
+ * @returns Value of property `supportRangesOnly`
1617
+ */
1618
+ getSupportRangesOnly(): boolean;
1619
+ /**
1620
+ * @SINCE 1.28
1621
+ *
1622
+ * getTable Gives access to the internal table instance.
1623
+ *
1624
+ * @returns the used table instance
1625
+ */
1626
+ getTable(): object;
1627
+ /**
1628
+ * @SINCE 1.24
1629
+ *
1630
+ * Gets current value of property {@link #getTokenDisplayBehaviour tokenDisplayBehaviour}.
1631
+ *
1632
+ * Represents how the item token text should be displayed in ValueHelpDialog. Use one of the valid `sap.ui.comp.smartfilterbar.DisplayBehaviour`
1633
+ * values.
1634
+ *
1635
+ * Default value is `empty string`.
1636
+ *
1637
+ * @returns Value of property `tokenDisplayBehaviour`
1638
+ */
1639
+ getTokenDisplayBehaviour(): string;
1640
+ /**
1641
+ * @SINCE 1.24
1642
+ *
1643
+ * Sets a new value for property {@link #getDescriptionKey descriptionKey}.
1644
+ *
1645
+ * Defines the key of the column used for the token text.
1646
+ *
1647
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1648
+ *
1649
+ * Default value is `empty string`.
1650
+ *
1651
+ * @returns Reference to `this` in order to allow method chaining
1652
+ */
1653
+ setDescriptionKey(
1654
+ /**
1655
+ * New value for property `descriptionKey`
1656
+ */
1657
+ sDescriptionKey?: string
1658
+ ): this;
1659
+ /**
1660
+ * @SINCE 1.24
1661
+ *
1662
+ * Sets a new value for property {@link #getDisplayFormat displayFormat}.
1663
+ *
1664
+ * Represents the display format of the range values. With the `displayFormat` value UpperCase, the entered
1665
+ * value of the range (condition) is converted to uppercase letters.
1666
+ *
1667
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1668
+ *
1669
+ * Default value is `empty string`.
1670
+ *
1671
+ * @returns Reference to `this` in order to allow method chaining
1672
+ */
1673
+ setDisplayFormat(
1674
+ /**
1675
+ * New value for property `displayFormat`
1676
+ */
1677
+ sDisplayFormat?: string
1678
+ ): this;
1679
+ /**
1680
+ * @SINCE 1.24
1681
+ *
1682
+ * setExcludeRangeOperations Sets the array for the supported exclude range operations.
1683
+ */
1684
+ setExcludeRangeOperations(
1685
+ /**
1686
+ * An array of range operations
1687
+ */
1688
+ aOperation: Array<
1689
+ ValueHelpRangeOperation | keyof typeof ValueHelpRangeOperation
1690
+ >,
1691
+ /**
1692
+ * the type for which the operations are defined
1693
+ */
1694
+ sType: string
1695
+ ): void;
1696
+ /**
1697
+ * @SINCE 1.24
1698
+ *
1699
+ * Sets a new value for property {@link #getFilterMode filterMode}.
1700
+ *
1701
+ * Sets the dialog into a filter mode, which only shows ranges (conditions) and hides the tokens.
1702
+ *
1703
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1704
+ *
1705
+ * Default value is `false`.
1706
+ *
1707
+ * @returns Reference to `this` in order to allow method chaining
1708
+ */
1709
+ setFilterMode(
1710
+ /**
1711
+ * New value for property `filterMode`
1712
+ */
1713
+ bFilterMode?: boolean
1714
+ ): this;
1715
+ /**
1716
+ * @SINCE 1.24
1717
+ *
1718
+ * setIncludeRangeOperations Sets the array for the supported include range operations.
1719
+ */
1720
+ setIncludeRangeOperations(
1721
+ /**
1722
+ * An array of range operations
1723
+ */
1724
+ aOperation: Array<
1725
+ ValueHelpRangeOperation | keyof typeof ValueHelpRangeOperation
1726
+ >,
1727
+ /**
1728
+ * the type for which the operations are defined
1729
+ */
1730
+ sType: string
1731
+ ): void;
1732
+ /**
1733
+ * @SINCE 1.24
1734
+ *
1735
+ * Sets a new value for property {@link #getKey key}.
1736
+ *
1737
+ * Defines the key of the column used for the internal key handling. The value of the column is used for
1738
+ * the token key and also to identify the row in the table.
1739
+ *
1740
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1741
+ *
1742
+ * Default value is `empty string`.
1743
+ *
1744
+ * @returns Reference to `this` in order to allow method chaining
1745
+ */
1746
+ setKey(
1747
+ /**
1748
+ * New value for property `key`
1749
+ */
1750
+ sKey?: string
1751
+ ): this;
1752
+ /**
1753
+ * @SINCE 1.24
1754
+ *
1755
+ * Sets a new value for property {@link #getKeys keys}.
1756
+ *
1757
+ * Defines the list of additional keys of the column used for the internal key handling.
1758
+ *
1759
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1760
+ *
1761
+ * @returns Reference to `this` in order to allow method chaining
1762
+ */
1763
+ setKeys(
1764
+ /**
1765
+ * New value for property `keys`
1766
+ */
1767
+ sKeys?: string[]
1768
+ ): this;
1769
+ /**
1770
+ * @SINCE 1.24
1771
+ *
1772
+ * Sets a new value for property {@link #getMaxExcludeRanges maxExcludeRanges}.
1773
+ *
1774
+ * Defines the maximum number of exclude ranges.
1775
+ *
1776
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1777
+ *
1778
+ * Default value is `"-1"`.
1779
+ *
1780
+ * @returns Reference to `this` in order to allow method chaining
1781
+ */
1782
+ setMaxExcludeRanges(
1783
+ /**
1784
+ * New value for property `maxExcludeRanges`
1785
+ */
1786
+ sMaxExcludeRanges?: string
1787
+ ): this;
1788
+ /**
1789
+ * @SINCE 1.24
1790
+ *
1791
+ * Sets a new value for property {@link #getMaxIncludeRanges maxIncludeRanges}.
1792
+ *
1793
+ * Defines the maximum number of include ranges.
1794
+ *
1795
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1796
+ *
1797
+ * Default value is `"-1"`.
1798
+ *
1799
+ * @returns Reference to `this` in order to allow method chaining
1800
+ */
1801
+ setMaxIncludeRanges(
1802
+ /**
1803
+ * New value for property `maxIncludeRanges`
1804
+ */
1805
+ sMaxIncludeRanges?: string
1806
+ ): this;
1807
+ /**
1808
+ * @SINCE 1.24
1809
+ *
1810
+ * setRangeKeyFields Sets a RangeKeyFields array. This method allows you to specify the KeyFields for the
1811
+ * ranges. You can set an array of objects with Key and Label properties to define the key fields.
1812
+ */
1813
+ setRangeKeyFields(
1814
+ /**
1815
+ * An array of range KeyFields `[{key: "CompanyCode", label: "ID"}, {key:"CompanyName", label : "Name"}]`
1816
+ */
1817
+ aRangeKeyFields: object[]
1818
+ ): void;
1819
+ /**
1820
+ * @SINCE 1.32
1821
+ *
1822
+ * setTable Sets the table used in the value help dialog. If not used, the dialog creates a sap.ui.table.Table
1823
+ * or sap.m.Table instance internally.
1824
+ */
1825
+ setTable(
1826
+ /**
1827
+ * The used table control instance
1828
+ */
1829
+ oTable: object
1830
+ ): void;
1831
+ /**
1832
+ * @SINCE 1.24
1833
+ *
1834
+ * Sets a new value for property {@link #getTokenDisplayBehaviour tokenDisplayBehaviour}.
1835
+ *
1836
+ * Represents how the item token text should be displayed in ValueHelpDialog. Use one of the valid `sap.ui.comp.smartfilterbar.DisplayBehaviour`
1837
+ * values.
1838
+ *
1839
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1840
+ *
1841
+ * Default value is `empty string`.
1842
+ *
1843
+ * @returns Reference to `this` in order to allow method chaining
1844
+ */
1845
+ setTokenDisplayBehaviour(
1846
+ /**
1847
+ * New value for property `tokenDisplayBehaviour`
1848
+ */
1849
+ sTokenDisplayBehaviour?: string
1850
+ ): this;
1851
+ /**
1852
+ * @SINCE 1.24
1853
+ *
1854
+ * Sets the array of tokens. The `sap.m.Tokens` are added to the dialog tokenizer Selected Items or Excluded
1855
+ * Items. Normal tokens are added to the Selected Items tokenizer only and are selected in the table. `
1856
+ * new sap.m.Token({key: "0001", text:"SAP A.G. (0001)"}); ` Tokens with the extra data with value 'range'
1857
+ * are handled as range tokens or exclude range tokens. ` new sap.m.Token({key: "i1", text: "ID: a..z"}).data("range",
1858
+ * { "exclude": false, "operation": sap.ui.comp.valuehelpdialog.ValueHelpRangeOperation.BT, "keyField":
1859
+ * "CompanyCode", "value1": "a", "value2": "z"}); ` The selected items or range tokens are returned in the
1860
+ * event parameters of the Ok event.
1861
+ */
1862
+ setTokens(
1863
+ /**
1864
+ * An array of token controls
1865
+ */
1866
+ aTokens: Token[]
1867
+ ): void;
1868
+ /**
1869
+ * @SINCE 1.24
1870
+ *
1871
+ * Update the Control
1872
+ *
1873
+ * Updates the selection of rows in the table. This function must be called after a first binding or binding
1874
+ * update of the table. It will set a table row as selected if a token for this row exists.
1875
+ */
1876
+ update(): void;
1877
+ }
1878
+
1879
+ export interface $ValueHelpDialogSettings extends $DialogSettings {
1880
+ /**
1881
+ * @SINCE 1.24
1882
+ *
1883
+ * Defines the value for the basic search field. The value is set into the basic search field of the filter
1884
+ * bar used.
1885
+ */
1886
+ basicSearchText?: string | PropertyBindingInfo;
1887
+
1888
+ /**
1889
+ * @SINCE 1.24
1890
+ *
1891
+ * Enables multi-selection in the table used.
1892
+ */
1893
+ supportMultiselect?: boolean | PropertyBindingInfo | `{${string}}`;
1894
+
1895
+ /**
1896
+ * @SINCE 1.24
1897
+ *
1898
+ * Enables the ranges (conditions) feature in the dialog.
1899
+ */
1900
+ supportRanges?: boolean | PropertyBindingInfo | `{${string}}`;
1901
+
1902
+ /**
1903
+ * @SINCE 1.24
1904
+ *
1905
+ * If this property is set to `true`, the value help dialog only supports the ranges (conditions) feature.
1906
+ */
1907
+ supportRangesOnly?: boolean | PropertyBindingInfo | `{${string}}`;
1908
+
1909
+ /**
1910
+ * @SINCE 1.24
1911
+ *
1912
+ * Defines the key of the column used for the internal key handling. The value of the column is used for
1913
+ * the token key and also to identify the row in the table.
1914
+ */
1915
+ key?: string | PropertyBindingInfo;
1916
+
1917
+ /**
1918
+ * @SINCE 1.24
1919
+ *
1920
+ * Defines the list of additional keys of the column used for the internal key handling.
1921
+ */
1922
+ keys?: string[] | PropertyBindingInfo | `{${string}}`;
1923
+
1924
+ /**
1925
+ * @SINCE 1.24
1926
+ *
1927
+ * Defines the key of the column used for the token text.
1928
+ */
1929
+ descriptionKey?: string | PropertyBindingInfo;
1930
+
1931
+ /**
1932
+ * @SINCE 1.24
1933
+ *
1934
+ * Defines the maximum number of include ranges.
1935
+ */
1936
+ maxIncludeRanges?: string | PropertyBindingInfo;
1937
+
1938
+ /**
1939
+ * @SINCE 1.24
1940
+ *
1941
+ * Defines the maximum number of exclude ranges.
1942
+ */
1943
+ maxExcludeRanges?: string | PropertyBindingInfo;
1944
+
1945
+ /**
1946
+ * @SINCE 1.24
1947
+ *
1948
+ * Represents the display format of the range values. With the `displayFormat` value UpperCase, the entered
1949
+ * value of the range (condition) is converted to uppercase letters.
1950
+ */
1951
+ displayFormat?: string | PropertyBindingInfo;
1952
+
1953
+ /**
1954
+ * @SINCE 1.24
1955
+ *
1956
+ * Represents how the item token text should be displayed in ValueHelpDialog. Use one of the valid `sap.ui.comp.smartfilterbar.DisplayBehaviour`
1957
+ * values.
1958
+ */
1959
+ tokenDisplayBehaviour?: string | PropertyBindingInfo;
1960
+
1961
+ /**
1962
+ * @SINCE 1.24
1963
+ *
1964
+ * Sets the dialog into a filter mode, which only shows ranges (conditions) and hides the tokens.
1965
+ */
1966
+ filterMode?: boolean | PropertyBindingInfo | `{${string}}`;
1967
+
1968
+ /**
1969
+ * Allows you to add a {@link sap.ui.comp.filterbar.FilterBar FilterBar} or {@link sap.ui.comp.smartfilterbar.SmartFilterBar
1970
+ * SmartFilterBar} control to the value help dialog.
1971
+ */
1972
+ filterBar?: Control;
1973
+
1974
+ /**
1975
+ * @SINCE 1.24
1976
+ *
1977
+ * This event is fired when the OK button is pressed.
1978
+ */
1979
+ ok?: (oEvent: Event) => void;
1980
+
1981
+ /**
1982
+ * @SINCE 1.24
1983
+ *
1984
+ * This event is fired when the Cancel button is pressed.
1985
+ */
1986
+ cancel?: (oEvent: Event) => void;
1987
+
1988
+ /**
1989
+ * @SINCE 1.32
1990
+ *
1991
+ * This event is fired when the user selects an item in the items table.
1992
+ *
1993
+ * **Note:** The event will only be raised when the dialog gets a table instance from outside via `setTable`.
1994
+ */
1995
+ selectionChange?: (oEvent: Event) => void;
1996
+
1997
+ /**
1998
+ * @SINCE 1.32
1999
+ *
2000
+ * This event is fired when the user removes one or multiple existing token(s) from the dialog.
2001
+ *
2002
+ * **Note:** The event will only be raised when the dialog gets a table instance from outside via `setTable`.
2003
+ */
2004
+ tokenRemove?: (oEvent: Event) => void;
2005
+
2006
+ /**
2007
+ * @SINCE 1.32
2008
+ *
2009
+ * This event is fired when the table gets an update and all existing tokens must be selected in the table.
2010
+ *
2011
+ * **Note:** The event will only be raised when the dialog gets a table instance from outside via `setTable`.
2012
+ */
2013
+ updateSelection?: (oEvent: Event) => void;
2014
+ }
2015
+ }
2016
+
2017
+ declare module "sap/zen/dsh/ValueHelpRangeOperation" {
2018
+ /**
2019
+ * @deprecated (since 1.89)
2020
+ * @EXPERIMENTAL
2021
+ *
2022
+ * Sort Type
2023
+ */
2024
+ enum ValueHelpRangeOperation {
2025
+ /**
2026
+ * The Between operation for the ranges.
2027
+ */
2028
+ BT = "BT",
2029
+ /**
2030
+ * The Contains operation for the ranges.
2031
+ */
2032
+ Contains = "Contains",
2033
+ /**
2034
+ * The EndsWith operation for the ranges.
2035
+ */
2036
+ EndsWith = "EndsWith",
2037
+ /**
2038
+ * The Equals operation for the ranges.
2039
+ */
2040
+ EQ = "EQ",
2041
+ /**
2042
+ * The Between or equals operation for the ranges.
2043
+ */
2044
+ GE = "GE",
2045
+ /**
2046
+ * The Greater operation for the ranges.
2047
+ */
2048
+ GT = "GT",
2049
+ /**
2050
+ * The Less or equals operation for the ranges.
2051
+ */
2052
+ LE = "LE",
2053
+ /**
2054
+ * The Less operation for the ranges.
2055
+ */
2056
+ LT = "LT",
2057
+ /**
2058
+ * The StartsWith operation for the ranges.
2059
+ */
2060
+ StartsWith = "StartsWith",
2061
+ }
2062
+ export default ValueHelpRangeOperation;
2063
+ }
2064
+
2065
+ declare module "sap/zen/dsh/widgets/SDKModel" {
2066
+ import Model from "sap/ui/model/Model";
2067
+
2068
+ import Metadata from "sap/ui/base/Metadata";
2069
+
2070
+ /**
2071
+ * @deprecated (since 1.89.0)
2072
+ *
2073
+ * Model implementation for JSON format
2074
+ */
2075
+ export default class SDKModel extends Model {
2076
+ /**
2077
+ * Constructor for a new SDKModel.
2078
+ */
2079
+ constructor(
2080
+ /**
2081
+ * either the URL where to load the JSON from or a JS object
2082
+ */
2083
+ oData: object
2084
+ );
2085
+
2086
+ /**
2087
+ * Creates a new subclass of class sap.zen.dsh.widgets.SDKModel with name `sClassName` and enriches it with
2088
+ * the information contained in `oClassInfo`.
2089
+ *
2090
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.model.Model.extend}.
2091
+ *
2092
+ * @returns Created class / constructor function
2093
+ */
2094
+ static extend<T extends Record<string, unknown>>(
2095
+ /**
2096
+ * Name of the class being created
2097
+ */
2098
+ sClassName: string,
2099
+ /**
2100
+ * Object literal with information about the class
2101
+ */
2102
+ oClassInfo?: sap.ClassInfo<T, SDKModel>,
2103
+ /**
2104
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
2105
+ * used by this class
2106
+ */
2107
+ FNMetaImpl?: Function
2108
+ ): Function;
2109
+ /**
2110
+ * Returns a metadata object for class sap.zen.dsh.widgets.SDKModel.
2111
+ *
2112
+ * @returns Metadata object describing this class
2113
+ */
2114
+ static getMetadata(): Metadata;
2115
+ }
2116
+ }
2117
+
2118
+ declare namespace sap {
2119
+ interface IUI5DefineDependencyNames {
2120
+ "sap/zen/dsh/AnalyticGrid": undefined;
2121
+
2122
+ "sap/zen/dsh/Dsh": undefined;
2123
+
2124
+ "sap/zen/dsh/library": undefined;
2125
+
2126
+ "sap/zen/dsh/ValueHelpRangeOperation": undefined;
2127
+
2128
+ "sap/zen/dsh/widgets/SDKModel": undefined;
2129
+
2130
+ "sap/zen/dsh/widgets/ValueHelpDialog": undefined;
2131
+ }
2132
+ }