@sapui5/ts-types 1.104.1 → 1.105.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (64) hide show
  1. package/package.json +1 -1
  2. package/types/sap.apf.d.ts +1 -1
  3. package/types/sap.ca.ui.d.ts +1 -1
  4. package/types/sap.chart.d.ts +2 -2
  5. package/types/sap.collaboration.d.ts +1 -1
  6. package/types/sap.esh.search.ui.d.ts +829 -1
  7. package/types/sap.f.d.ts +1 -1
  8. package/types/sap.fe.common.d.ts +1 -1
  9. package/types/sap.fe.core.d.ts +2 -2
  10. package/types/sap.fe.macros.d.ts +8 -4
  11. package/types/sap.fe.navigation.d.ts +53 -5
  12. package/types/sap.fe.templates.d.ts +2 -2
  13. package/types/sap.fe.test.d.ts +1 -1
  14. package/types/sap.feedback.ui.d.ts +1 -1
  15. package/types/sap.gantt.d.ts +66 -54
  16. package/types/sap.insights.d.ts +1 -1
  17. package/types/sap.landvisz.d.ts +1 -1
  18. package/types/sap.m.d.ts +197 -47
  19. package/types/sap.makit.d.ts +1 -1
  20. package/types/sap.me.d.ts +1 -1
  21. package/types/sap.ndc.d.ts +68 -3
  22. package/types/sap.ovp.d.ts +1 -1
  23. package/types/sap.rules.ui.d.ts +1 -1
  24. package/types/sap.sac.df.d.ts +122 -179
  25. package/types/sap.sac.grid.d.ts +1 -1
  26. package/types/sap.suite.ui.commons.d.ts +97 -6
  27. package/types/sap.suite.ui.generic.template.d.ts +1 -1
  28. package/types/sap.suite.ui.microchart.d.ts +1 -1
  29. package/types/sap.tnt.d.ts +1 -1
  30. package/types/sap.ui.codeeditor.d.ts +1 -1
  31. package/types/sap.ui.commons.d.ts +1 -1
  32. package/types/sap.ui.comp.d.ts +73 -22
  33. package/types/sap.ui.core.d.ts +195 -43
  34. package/types/sap.ui.dt.d.ts +1 -1
  35. package/types/sap.ui.export.d.ts +3 -3
  36. package/types/sap.ui.fl.d.ts +1117 -5
  37. package/types/sap.ui.generic.app.d.ts +9 -10
  38. package/types/sap.ui.generic.template.d.ts +1 -1
  39. package/types/sap.ui.integration.d.ts +59 -7
  40. package/types/sap.ui.layout.d.ts +1 -1
  41. package/types/sap.ui.mdc.d.ts +3 -1
  42. package/types/sap.ui.richtexteditor.d.ts +1 -1
  43. package/types/sap.ui.rta.d.ts +1 -1
  44. package/types/sap.ui.suite.d.ts +1 -1
  45. package/types/sap.ui.support.d.ts +1 -1
  46. package/types/sap.ui.table.d.ts +1 -1
  47. package/types/sap.ui.testrecorder.d.ts +1 -1
  48. package/types/sap.ui.unified.d.ts +51 -4
  49. package/types/sap.ui.ux3.d.ts +1 -1
  50. package/types/sap.ui.vbm.d.ts +1 -1
  51. package/types/sap.ui.vk.d.ts +272 -19
  52. package/types/sap.ui.vtm.d.ts +1 -1
  53. package/types/sap.ui.webc.common.d.ts +1 -1
  54. package/types/sap.ui.webc.fiori.d.ts +209 -16
  55. package/types/sap.ui.webc.main.d.ts +524 -62
  56. package/types/sap.uiext.inbox.d.ts +1 -1
  57. package/types/sap.ushell.d.ts +6 -8
  58. package/types/sap.ushell_abap.d.ts +1 -215
  59. package/types/sap.uxap.d.ts +1 -1
  60. package/types/sap.viz.d.ts +1 -1
  61. package/types/sap.webanalytics.core.d.ts +1 -1
  62. package/types/sap.zen.commons.d.ts +1 -1
  63. package/types/sap.zen.crosstab.d.ts +1 -1
  64. package/types/sap.zen.dsh.d.ts +1 -1
@@ -1,7 +1,835 @@
1
- // For Library Version: 1.104.0
1
+ // For Library Version: 1.105.1
2
2
 
3
3
  declare namespace sap {
4
+ namespace esh {
5
+ namespace search {
6
+ /**
7
+ * UI5 library: sap.esh.search.ui.
8
+ */
9
+ namespace ui {
10
+ interface $SearchCompositeControlSettings
11
+ extends sap.ui.core.$ControlSettings {
12
+ /**
13
+ * @SINCE 1.93.0
14
+ *
15
+ * An additional CSS class to add to this control
16
+ */
17
+ cssClass?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
18
+
19
+ /**
20
+ * @SINCE 1.93.0
21
+ *
22
+ * Defines the initial search term for the search input.
23
+ */
24
+ searchTerm?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
25
+
26
+ /**
27
+ * @SINCE 1.93.0
28
+ *
29
+ * Defines if the search control will search for the given term right on control instantiation.
30
+ */
31
+ searchOnStart?:
32
+ | boolean
33
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
34
+ | `{${string}}`;
35
+
36
+ /**
37
+ * @SINCE 1.98.0
38
+ *
39
+ * Defines the filter root condition of a filter tree which shall be applied to the search request. This
40
+ * control only allows filter trees which have a the following structure: complex condition (root level)
41
+ * \ complex condition (attribute level) \ simple condition (attribute value level) Filter root conditions
42
+ * which do not follow this structure won't be accepted and an error will be thrown. Please see the below
43
+ * for a more in-depth example.
44
+ */
45
+ filterRootCondition?:
46
+ | object
47
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
48
+ | `{${string}}`;
49
+
50
+ /**
51
+ * @SINCE 1.93.0
52
+ *
53
+ * Configuration for the Enterprise Search Client API.
54
+ */
55
+ sinaConfiguration?:
56
+ | object
57
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
58
+ | `{${string}}`;
59
+
60
+ /**
61
+ * @SINCE 1.98.0
62
+ *
63
+ * The id of the data source in which it will search right after initialization.
64
+ */
65
+ dataSource?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
66
+
67
+ /**
68
+ * @SINCE 1.98.0
69
+ *
70
+ * Defines selectable search result view types. The value can be set/get in attach event "searchFinished".
71
+ * Case 1, Search in Apps: result is displayed in a mandatory view type `["appSearchResult"]`, and it is
72
+ * not switchable. Case 2.1, Search in All or other Category (configuration.isUshell !== true): result is
73
+ * switchable between different view types. Possible values for the array items are `"searchResultList"`
74
+ * and `"searchResultGrid"`. Case 2.2, Search in All or other Category (configuration.isUshell === true):
75
+ * result is displayed in a mandatory view type `["searchResultList"]`. Case 3, Search in Business Object:
76
+ * result is switchable between different view types. Possible values for the array items are `"searchResultList"`,
77
+ * `"searchResultTable"` and `"searchResultGrid"`. Note: The value of `resultViewTypes` and `resultViewType`
78
+ * must be compatible to each other.
79
+ */
80
+ resultViewTypes?:
81
+ | string[]
82
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
83
+ | `{${string}}`;
84
+
85
+ /**
86
+ * @SINCE 1.98.0
87
+ *
88
+ * Defines active search result view type. The value can be set/get in attach event "searchFinished", and
89
+ * it must be contained in resultViewTypes. Case 1, Search in Apps: result is displayed in a mandatory view
90
+ * type `"appSearchResult"`. Case 2.1, Search in All or other Category (configuration.isUshell !== true):
91
+ * result is switchable between different view types. Possible value is `"searchResultList"`, or `"searchResultGrid"`.
92
+ * Case 2.2, Search in All or other Category (configuration.isUshell === true): result is displayed in a
93
+ * mandatory view type `"searchResultList"`. Case 3, Search in Business Object: result is switchable between
94
+ * different view types. Possible value is `"searchResultList"`, `"searchResultTable"` or `"searchResultGrid"`.
95
+ * Note: The value of `resultViewTypes` and `resultViewType` must be compatible to each other.
96
+ */
97
+ resultViewType?:
98
+ | string
99
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
100
+
101
+ /**
102
+ * @SINCE 1.100.0
103
+ *
104
+ * Defines a pair of search result view settings. The value is an object of properties `resultViewTypes`
105
+ * and `resultViewType`. An example: `{resultViewTypes: ["searchResultList", "searchResultTable"], resultViewType:
106
+ * "searchResultList"}` Find more detail in the definition of each child property. The value can be set/get
107
+ * in attached event "searchFinished". Function `setResultViewSettings` prevents incompatibility of sequential
108
+ * execution of functions `setResultViewTypes` and `setResultViewType`. Note: The value of `resultViewTypes`
109
+ * and `resultViewType` must be compatible to each other.
110
+ */
111
+ resultViewSettings?:
112
+ | string
113
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
114
+
115
+ /**
116
+ * @SINCE 1.103.0
117
+ *
118
+ * Function callback for formatting the datasource tabstrips in the top toolbar. To the callback function
119
+ * a list of datasources is passed. The callback functions return a modified list of datasources to be displayed
120
+ * in the tabstrips.
121
+ */
122
+ tabStripsFormatter?:
123
+ | Function
124
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
125
+ | `{${string}}`;
126
+
127
+ /**
128
+ * @SINCE 1.103.0
129
+ *
130
+ * Function callback for assembling the search count breadcumbs. The function callback shall return a control
131
+ * which is displayed on the top of the result list. Typically this is used for displaying the total count.
132
+ */
133
+ assembleSearchCountBreadcrumbs?:
134
+ | Function
135
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
136
+ | `{${string}}`;
137
+
138
+ /**
139
+ * Control instances which are part of this composite control.
140
+ */
141
+ content?:
142
+ | sap.ui.core.Control[]
143
+ | sap.ui.core.Control
144
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
145
+ | `{${string}}`;
146
+
147
+ /**
148
+ * Event is fired when search is started.
149
+ */
150
+ searchStarted?: (oEvent: sap.ui.base.Event) => void;
151
+
152
+ /**
153
+ * Event is fired when search is finished.
154
+ */
155
+ searchFinished?: (oEvent: sap.ui.base.Event) => void;
156
+ }
157
+
158
+ /**
159
+ * @SINCE 1.93.0
160
+ *
161
+ * This is the SAPUI5 composite control by the Enterprise Search Team which helps to make full use of the
162
+ * Enterprise Search Engine features built into ABAP and HANA. It includes a search input box including
163
+ * a suggestion dropdown, a result list which can have different styles including tiles and table, result
164
+ * facets and more. This control is ready to use with an enterprise search backend service but also allows
165
+ * deep modifications to match requirements of adopting applications.
166
+ */
167
+ class SearchCompositeControl extends sap.ui.core.Control {
168
+ /**
169
+ * Constructs a new `SearchCompositeControl` to interact with SAP Enterprise Search Services.
170
+ * See:
171
+ * https://help.sap.com/viewer/691cb949c1034198800afde3e5be6570/2.0.05/en-US/ce86ef2fd97610149eaaaa0244ca4d36.html
172
+ * https://help.sap.com/viewer/6522d0462aeb4909a79c3462b090ec51/1709%20002/en-US
173
+ */
174
+ constructor(
175
+ /**
176
+ * Initial settings for the new control
177
+ */
178
+ mSettings?: sap.esh.search.ui.$SearchCompositeControlSettings
179
+ );
180
+ /**
181
+ * Constructs a new `SearchCompositeControl` to interact with SAP Enterprise Search Services.
182
+ * See:
183
+ * https://help.sap.com/viewer/691cb949c1034198800afde3e5be6570/2.0.05/en-US/ce86ef2fd97610149eaaaa0244ca4d36.html
184
+ * https://help.sap.com/viewer/6522d0462aeb4909a79c3462b090ec51/1709%20002/en-US
185
+ */
186
+ constructor(
187
+ /**
188
+ * ID for the new control, generated automatically if no ID is given
189
+ */
190
+ sId?: string,
191
+ /**
192
+ * Initial settings for the new control
193
+ */
194
+ mSettings?: sap.esh.search.ui.$SearchCompositeControlSettings
195
+ );
196
+
197
+ /**
198
+ * Creates a new subclass of class sap.esh.search.ui.SearchCompositeControl with name `sClassName` and enriches
199
+ * it with the information contained in `oClassInfo`.
200
+ *
201
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
202
+ *
203
+ * @returns Created class / constructor function
204
+ */
205
+ static extend<T extends Record<string, unknown>>(
206
+ /**
207
+ * Name of the class being created
208
+ */
209
+ sClassName: string,
210
+ /**
211
+ * Object literal with information about the class
212
+ */
213
+ oClassInfo?: sap.ClassInfo<
214
+ T,
215
+ sap.esh.search.ui.SearchCompositeControl
216
+ >,
217
+ /**
218
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
219
+ * used by this class
220
+ */
221
+ FNMetaImpl?: Function
222
+ ): Function;
223
+ /**
224
+ * Returns a metadata object for class sap.esh.search.ui.SearchCompositeControl.
225
+ *
226
+ * @returns Metadata object describing this class
227
+ */
228
+ static getMetadata(): sap.ui.core.ElementMetadata;
229
+ /**
230
+ * Adds some content to the aggregation {@link #getContent content}.
231
+ *
232
+ * @returns Reference to `this` in order to allow method chaining
233
+ */
234
+ addContent(
235
+ /**
236
+ * The content to add; if empty, nothing is inserted
237
+ */
238
+ oContent: sap.ui.core.Control
239
+ ): this;
240
+ /**
241
+ * Attaches event handler `fnFunction` to the {@link #event:searchFinished searchFinished} event of this
242
+ * `sap.esh.search.ui.SearchCompositeControl`.
243
+ *
244
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
245
+ * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself.
246
+ *
247
+ * Event is fired when search is finished.
248
+ *
249
+ * @returns Reference to `this` in order to allow method chaining
250
+ */
251
+ attachSearchFinished(
252
+ /**
253
+ * An application-specific payload object that will be passed to the event handler along with the event
254
+ * object when firing the event
255
+ */
256
+ oData: object,
257
+ /**
258
+ * The function to be called when the event occurs
259
+ */
260
+ fnFunction: (p1: sap.ui.base.Event) => void,
261
+ /**
262
+ * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl`
263
+ * itself
264
+ */
265
+ oListener?: object
266
+ ): this;
267
+ /**
268
+ * Attaches event handler `fnFunction` to the {@link #event:searchFinished searchFinished} event of this
269
+ * `sap.esh.search.ui.SearchCompositeControl`.
270
+ *
271
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
272
+ * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself.
273
+ *
274
+ * Event is fired when search is finished.
275
+ *
276
+ * @returns Reference to `this` in order to allow method chaining
277
+ */
278
+ attachSearchFinished(
279
+ /**
280
+ * The function to be called when the event occurs
281
+ */
282
+ fnFunction: (p1: sap.ui.base.Event) => void,
283
+ /**
284
+ * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl`
285
+ * itself
286
+ */
287
+ oListener?: object
288
+ ): this;
289
+ /**
290
+ * Attaches event handler `fnFunction` to the {@link #event:searchStarted searchStarted} event of this `sap.esh.search.ui.SearchCompositeControl`.
291
+ *
292
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
293
+ * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself.
294
+ *
295
+ * Event is fired when search is started.
296
+ *
297
+ * @returns Reference to `this` in order to allow method chaining
298
+ */
299
+ attachSearchStarted(
300
+ /**
301
+ * An application-specific payload object that will be passed to the event handler along with the event
302
+ * object when firing the event
303
+ */
304
+ oData: object,
305
+ /**
306
+ * The function to be called when the event occurs
307
+ */
308
+ fnFunction: (p1: sap.ui.base.Event) => void,
309
+ /**
310
+ * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl`
311
+ * itself
312
+ */
313
+ oListener?: object
314
+ ): this;
315
+ /**
316
+ * Attaches event handler `fnFunction` to the {@link #event:searchStarted searchStarted} event of this `sap.esh.search.ui.SearchCompositeControl`.
317
+ *
318
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
319
+ * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself.
320
+ *
321
+ * Event is fired when search is started.
322
+ *
323
+ * @returns Reference to `this` in order to allow method chaining
324
+ */
325
+ attachSearchStarted(
326
+ /**
327
+ * The function to be called when the event occurs
328
+ */
329
+ fnFunction: (p1: sap.ui.base.Event) => void,
330
+ /**
331
+ * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl`
332
+ * itself
333
+ */
334
+ oListener?: object
335
+ ): this;
336
+ /**
337
+ * Destroys all the content in the aggregation {@link #getContent content}.
338
+ *
339
+ * @returns Reference to `this` in order to allow method chaining
340
+ */
341
+ destroyContent(): this;
342
+ /**
343
+ * Detaches event handler `fnFunction` from the {@link #event:searchFinished searchFinished} event of this
344
+ * `sap.esh.search.ui.SearchCompositeControl`.
345
+ *
346
+ * The passed function and listener object must match the ones used for event registration.
347
+ *
348
+ * @returns Reference to `this` in order to allow method chaining
349
+ */
350
+ detachSearchFinished(
351
+ /**
352
+ * The function to be called, when the event occurs
353
+ */
354
+ fnFunction: (p1: sap.ui.base.Event) => void,
355
+ /**
356
+ * Context object on which the given function had to be called
357
+ */
358
+ oListener?: object
359
+ ): this;
360
+ /**
361
+ * Detaches event handler `fnFunction` from the {@link #event:searchStarted searchStarted} event of this
362
+ * `sap.esh.search.ui.SearchCompositeControl`.
363
+ *
364
+ * The passed function and listener object must match the ones used for event registration.
365
+ *
366
+ * @returns Reference to `this` in order to allow method chaining
367
+ */
368
+ detachSearchStarted(
369
+ /**
370
+ * The function to be called, when the event occurs
371
+ */
372
+ fnFunction: (p1: sap.ui.base.Event) => void,
373
+ /**
374
+ * Context object on which the given function had to be called
375
+ */
376
+ oListener?: object
377
+ ): this;
378
+ /**
379
+ * Fires event {@link #event:searchFinished searchFinished} to attached listeners.
380
+ *
381
+ * @returns Reference to `this` in order to allow method chaining
382
+ */
383
+ fireSearchFinished(
384
+ /**
385
+ * Parameters to pass along with the event
386
+ */
387
+ mParameters?: object
388
+ ): this;
389
+ /**
390
+ * Fires event {@link #event:searchStarted searchStarted} to attached listeners.
391
+ *
392
+ * @returns Reference to `this` in order to allow method chaining
393
+ */
394
+ fireSearchStarted(
395
+ /**
396
+ * Parameters to pass along with the event
397
+ */
398
+ mParameters?: object
399
+ ): this;
400
+ /**
401
+ * @SINCE 1.103.0
402
+ *
403
+ * Gets current value of property {@link #getAssembleSearchCountBreadcrumbs assembleSearchCountBreadcrumbs}.
404
+ *
405
+ * Function callback for assembling the search count breadcumbs. The function callback shall return a control
406
+ * which is displayed on the top of the result list. Typically this is used for displaying the total count.
407
+ *
408
+ * @returns Value of property `assembleSearchCountBreadcrumbs`
409
+ */
410
+ getAssembleSearchCountBreadcrumbs(): Function;
411
+ /**
412
+ * Gets content of aggregation {@link #getContent content}.
413
+ *
414
+ * Control instances which are part of this composite control.
415
+ */
416
+ getContent(): sap.ui.core.Control[];
417
+ /**
418
+ * @SINCE 1.93.0
419
+ *
420
+ * Gets current value of property {@link #getCssClass cssClass}.
421
+ *
422
+ * An additional CSS class to add to this control
423
+ *
424
+ * @returns Value of property `cssClass`
425
+ */
426
+ getCssClass(): string;
427
+ /**
428
+ * @SINCE 1.98.0
429
+ *
430
+ * Gets current value of property {@link #getDataSource dataSource}.
431
+ *
432
+ * The id of the data source in which it will search right after initialization.
433
+ *
434
+ * @returns Value of property `dataSource`
435
+ */
436
+ getDataSource(): string;
437
+ /**
438
+ * @SINCE 1.98.0
439
+ *
440
+ * Gets current value of property {@link #getFilterRootCondition filterRootCondition}.
441
+ *
442
+ * Defines the filter root condition of a filter tree which shall be applied to the search request. This
443
+ * control only allows filter trees which have a the following structure: complex condition (root level)
444
+ * \ complex condition (attribute level) \ simple condition (attribute value level) Filter root conditions
445
+ * which do not follow this structure won't be accepted and an error will be thrown. Please see the below
446
+ * for a more in-depth example.
447
+ *
448
+ * @returns Value of property `filterRootCondition`
449
+ */
450
+ getFilterRootCondition(): object;
451
+ /**
452
+ * @SINCE 1.100.0
453
+ *
454
+ * Gets current value of property {@link #getResultViewSettings resultViewSettings}.
455
+ *
456
+ * Defines a pair of search result view settings. The value is an object of properties `resultViewTypes`
457
+ * and `resultViewType`. An example: `{resultViewTypes: ["searchResultList", "searchResultTable"], resultViewType:
458
+ * "searchResultList"}` Find more detail in the definition of each child property. The value can be set/get
459
+ * in attached event "searchFinished". Function `setResultViewSettings` prevents incompatibility of sequential
460
+ * execution of functions `setResultViewTypes` and `setResultViewType`. Note: The value of `resultViewTypes`
461
+ * and `resultViewType` must be compatible to each other.
462
+ *
463
+ * Default value is `...see text or source`.
464
+ *
465
+ * @returns Value of property `resultViewSettings`
466
+ */
467
+ getResultViewSettings(): string;
468
+ /**
469
+ * @SINCE 1.98.0
470
+ *
471
+ * Gets current value of property {@link #getResultViewType resultViewType}.
472
+ *
473
+ * Defines active search result view type. The value can be set/get in attach event "searchFinished", and
474
+ * it must be contained in resultViewTypes. Case 1, Search in Apps: result is displayed in a mandatory view
475
+ * type `"appSearchResult"`. Case 2.1, Search in All or other Category (configuration.isUshell !== true):
476
+ * result is switchable between different view types. Possible value is `"searchResultList"`, or `"searchResultGrid"`.
477
+ * Case 2.2, Search in All or other Category (configuration.isUshell === true): result is displayed in a
478
+ * mandatory view type `"searchResultList"`. Case 3, Search in Business Object: result is switchable between
479
+ * different view types. Possible value is `"searchResultList"`, `"searchResultTable"` or `"searchResultGrid"`.
480
+ * Note: The value of `resultViewTypes` and `resultViewType` must be compatible to each other.
481
+ *
482
+ * Default value is `"searchResultList"`.
483
+ *
484
+ * @returns Value of property `resultViewType`
485
+ */
486
+ getResultViewType(): string;
487
+ /**
488
+ * @SINCE 1.98.0
489
+ *
490
+ * Gets current value of property {@link #getResultViewTypes resultViewTypes}.
491
+ *
492
+ * Defines selectable search result view types. The value can be set/get in attach event "searchFinished".
493
+ * Case 1, Search in Apps: result is displayed in a mandatory view type `["appSearchResult"]`, and it is
494
+ * not switchable. Case 2.1, Search in All or other Category (configuration.isUshell !== true): result is
495
+ * switchable between different view types. Possible values for the array items are `"searchResultList"`
496
+ * and `"searchResultGrid"`. Case 2.2, Search in All or other Category (configuration.isUshell === true):
497
+ * result is displayed in a mandatory view type `["searchResultList"]`. Case 3, Search in Business Object:
498
+ * result is switchable between different view types. Possible values for the array items are `"searchResultList"`,
499
+ * `"searchResultTable"` and `"searchResultGrid"`. Note: The value of `resultViewTypes` and `resultViewType`
500
+ * must be compatible to each other.
501
+ *
502
+ * Default value is `["searchResultList", "searchResultTable"]`.
503
+ *
504
+ * @returns Value of property `resultViewTypes`
505
+ */
506
+ getResultViewTypes(): string[];
507
+ /**
508
+ * @SINCE 1.93.0
509
+ *
510
+ * Gets current value of property {@link #getSearchOnStart searchOnStart}.
511
+ *
512
+ * Defines if the search control will search for the given term right on control instantiation.
513
+ *
514
+ * Default value is `true`.
515
+ *
516
+ * @returns Value of property `searchOnStart`
517
+ */
518
+ getSearchOnStart(): boolean;
519
+ /**
520
+ * @SINCE 1.93.0
521
+ *
522
+ * Gets current value of property {@link #getSearchTerm searchTerm}.
523
+ *
524
+ * Defines the initial search term for the search input.
525
+ *
526
+ * Default value is `empty string`.
527
+ *
528
+ * @returns Value of property `searchTerm`
529
+ */
530
+ getSearchTerm(): string;
531
+ /**
532
+ * @SINCE 1.93.0
533
+ *
534
+ * Gets current value of property {@link #getSinaConfiguration sinaConfiguration}.
535
+ *
536
+ * Configuration for the Enterprise Search Client API.
537
+ *
538
+ * @returns Value of property `sinaConfiguration`
539
+ */
540
+ getSinaConfiguration(): object;
541
+ /**
542
+ * @SINCE 1.103.0
543
+ *
544
+ * Gets current value of property {@link #getTabStripsFormatter tabStripsFormatter}.
545
+ *
546
+ * Function callback for formatting the datasource tabstrips in the top toolbar. To the callback function
547
+ * a list of datasources is passed. The callback functions return a modified list of datasources to be displayed
548
+ * in the tabstrips.
549
+ *
550
+ * @returns Value of property `tabStripsFormatter`
551
+ */
552
+ getTabStripsFormatter(): Function;
553
+ /**
554
+ * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getContent content}. and returns
555
+ * its index if found or -1 otherwise.
556
+ *
557
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
558
+ */
559
+ indexOfContent(
560
+ /**
561
+ * The content whose index is looked for
562
+ */
563
+ oContent: sap.ui.core.Control
564
+ ): int;
565
+ /**
566
+ * Inserts a content into the aggregation {@link #getContent content}.
567
+ *
568
+ * @returns Reference to `this` in order to allow method chaining
569
+ */
570
+ insertContent(
571
+ /**
572
+ * The content to insert; if empty, nothing is inserted
573
+ */
574
+ oContent: sap.ui.core.Control,
575
+ /**
576
+ * The `0`-based index the content should be inserted at; for a negative value of `iIndex`, the content
577
+ * is inserted at position 0; for a value greater than the current size of the aggregation, the content
578
+ * is inserted at the last position
579
+ */
580
+ iIndex: int
581
+ ): this;
582
+ /**
583
+ * Removes all the controls from the aggregation {@link #getContent content}.
584
+ *
585
+ * Additionally, it unregisters them from the hosting UIArea.
586
+ *
587
+ * @returns An array of the removed elements (might be empty)
588
+ */
589
+ removeAllContent(): sap.ui.core.Control[];
590
+ /**
591
+ * Removes a content from the aggregation {@link #getContent content}.
592
+ *
593
+ * @returns The removed content or `null`
594
+ */
595
+ removeContent(
596
+ /**
597
+ * The content to remove or its index or id
598
+ */
599
+ vContent: int | string | sap.ui.core.Control
600
+ ): sap.ui.core.Control | null;
601
+ /**
602
+ * @SINCE 1.103.0
603
+ *
604
+ * Sets a new value for property {@link #getAssembleSearchCountBreadcrumbs assembleSearchCountBreadcrumbs}.
605
+ *
606
+ * Function callback for assembling the search count breadcumbs. The function callback shall return a control
607
+ * which is displayed on the top of the result list. Typically this is used for displaying the total count.
608
+ *
609
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
610
+ *
611
+ * @returns Reference to `this` in order to allow method chaining
612
+ */
613
+ setAssembleSearchCountBreadcrumbs(
614
+ /**
615
+ * New value for property `assembleSearchCountBreadcrumbs`
616
+ */
617
+ fnAssembleSearchCountBreadcrumbs: Function
618
+ ): this;
619
+ /**
620
+ * @SINCE 1.93.0
621
+ *
622
+ * Sets a new value for property {@link #getCssClass cssClass}.
623
+ *
624
+ * An additional CSS class to add to this control
625
+ *
626
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
627
+ *
628
+ * @returns Reference to `this` in order to allow method chaining
629
+ */
630
+ setCssClass(
631
+ /**
632
+ * New value for property `cssClass`
633
+ */
634
+ sCssClass: string
635
+ ): this;
636
+ /**
637
+ * @SINCE 1.98.0
638
+ *
639
+ * Sets a new value for property {@link #getDataSource dataSource}.
640
+ *
641
+ * The id of the data source in which it will search right after initialization.
642
+ *
643
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
644
+ *
645
+ * @returns Reference to `this` in order to allow method chaining
646
+ */
647
+ setDataSource(
648
+ /**
649
+ * New value for property `dataSource`
650
+ */
651
+ sDataSource: string
652
+ ): this;
653
+ /**
654
+ * @SINCE 1.98.0
655
+ *
656
+ * Sets a new value for property {@link #getFilterRootCondition filterRootCondition}.
657
+ *
658
+ * Defines the filter root condition of a filter tree which shall be applied to the search request. This
659
+ * control only allows filter trees which have a the following structure: complex condition (root level)
660
+ * \ complex condition (attribute level) \ simple condition (attribute value level) Filter root conditions
661
+ * which do not follow this structure won't be accepted and an error will be thrown. Please see the below
662
+ * for a more in-depth example.
663
+ *
664
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
665
+ *
666
+ * @returns Reference to `this` in order to allow method chaining
667
+ */
668
+ setFilterRootCondition(
669
+ /**
670
+ * New value for property `filterRootCondition`
671
+ */
672
+ oFilterRootCondition: object
673
+ ): this;
674
+ /**
675
+ * @SINCE 1.100.0
676
+ *
677
+ * Sets a new value for property {@link #getResultViewSettings resultViewSettings}.
678
+ *
679
+ * Defines a pair of search result view settings. The value is an object of properties `resultViewTypes`
680
+ * and `resultViewType`. An example: `{resultViewTypes: ["searchResultList", "searchResultTable"], resultViewType:
681
+ * "searchResultList"}` Find more detail in the definition of each child property. The value can be set/get
682
+ * in attached event "searchFinished". Function `setResultViewSettings` prevents incompatibility of sequential
683
+ * execution of functions `setResultViewTypes` and `setResultViewType`. Note: The value of `resultViewTypes`
684
+ * and `resultViewType` must be compatible to each other.
685
+ *
686
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
687
+ *
688
+ * Default value is `...see text or source`.
689
+ *
690
+ * @returns Reference to `this` in order to allow method chaining
691
+ */
692
+ setResultViewSettings(
693
+ /**
694
+ * New value for property `resultViewSettings`
695
+ */
696
+ sResultViewSettings?: string
697
+ ): this;
698
+ /**
699
+ * @SINCE 1.98.0
700
+ *
701
+ * Sets a new value for property {@link #getResultViewType resultViewType}.
702
+ *
703
+ * Defines active search result view type. The value can be set/get in attach event "searchFinished", and
704
+ * it must be contained in resultViewTypes. Case 1, Search in Apps: result is displayed in a mandatory view
705
+ * type `"appSearchResult"`. Case 2.1, Search in All or other Category (configuration.isUshell !== true):
706
+ * result is switchable between different view types. Possible value is `"searchResultList"`, or `"searchResultGrid"`.
707
+ * Case 2.2, Search in All or other Category (configuration.isUshell === true): result is displayed in a
708
+ * mandatory view type `"searchResultList"`. Case 3, Search in Business Object: result is switchable between
709
+ * different view types. Possible value is `"searchResultList"`, `"searchResultTable"` or `"searchResultGrid"`.
710
+ * Note: The value of `resultViewTypes` and `resultViewType` must be compatible to each other.
711
+ *
712
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
713
+ *
714
+ * Default value is `"searchResultList"`.
715
+ *
716
+ * @returns Reference to `this` in order to allow method chaining
717
+ */
718
+ setResultViewType(
719
+ /**
720
+ * New value for property `resultViewType`
721
+ */
722
+ sResultViewType?: string
723
+ ): this;
724
+ /**
725
+ * @SINCE 1.98.0
726
+ *
727
+ * Sets a new value for property {@link #getResultViewTypes resultViewTypes}.
728
+ *
729
+ * Defines selectable search result view types. The value can be set/get in attach event "searchFinished".
730
+ * Case 1, Search in Apps: result is displayed in a mandatory view type `["appSearchResult"]`, and it is
731
+ * not switchable. Case 2.1, Search in All or other Category (configuration.isUshell !== true): result is
732
+ * switchable between different view types. Possible values for the array items are `"searchResultList"`
733
+ * and `"searchResultGrid"`. Case 2.2, Search in All or other Category (configuration.isUshell === true):
734
+ * result is displayed in a mandatory view type `["searchResultList"]`. Case 3, Search in Business Object:
735
+ * result is switchable between different view types. Possible values for the array items are `"searchResultList"`,
736
+ * `"searchResultTable"` and `"searchResultGrid"`. Note: The value of `resultViewTypes` and `resultViewType`
737
+ * must be compatible to each other.
738
+ *
739
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
740
+ *
741
+ * Default value is `["searchResultList", "searchResultTable"]`.
742
+ *
743
+ * @returns Reference to `this` in order to allow method chaining
744
+ */
745
+ setResultViewTypes(
746
+ /**
747
+ * New value for property `resultViewTypes`
748
+ */
749
+ sResultViewTypes?: string[]
750
+ ): this;
751
+ /**
752
+ * @SINCE 1.93.0
753
+ *
754
+ * Sets a new value for property {@link #getSearchOnStart searchOnStart}.
755
+ *
756
+ * Defines if the search control will search for the given term right on control instantiation.
757
+ *
758
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
759
+ *
760
+ * Default value is `true`.
761
+ *
762
+ * @returns Reference to `this` in order to allow method chaining
763
+ */
764
+ setSearchOnStart(
765
+ /**
766
+ * New value for property `searchOnStart`
767
+ */
768
+ bSearchOnStart?: boolean
769
+ ): this;
770
+ /**
771
+ * @SINCE 1.93.0
772
+ *
773
+ * Sets a new value for property {@link #getSearchTerm searchTerm}.
774
+ *
775
+ * Defines the initial search term for the search input.
776
+ *
777
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
778
+ *
779
+ * Default value is `empty string`.
780
+ *
781
+ * @returns Reference to `this` in order to allow method chaining
782
+ */
783
+ setSearchTerm(
784
+ /**
785
+ * New value for property `searchTerm`
786
+ */
787
+ sSearchTerm?: string
788
+ ): this;
789
+ /**
790
+ * @SINCE 1.93.0
791
+ *
792
+ * Sets a new value for property {@link #getSinaConfiguration sinaConfiguration}.
793
+ *
794
+ * Configuration for the Enterprise Search Client API.
795
+ *
796
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
797
+ *
798
+ * @returns Reference to `this` in order to allow method chaining
799
+ */
800
+ setSinaConfiguration(
801
+ /**
802
+ * New value for property `sinaConfiguration`
803
+ */
804
+ oSinaConfiguration: object
805
+ ): this;
806
+ /**
807
+ * @SINCE 1.103.0
808
+ *
809
+ * Sets a new value for property {@link #getTabStripsFormatter tabStripsFormatter}.
810
+ *
811
+ * Function callback for formatting the datasource tabstrips in the top toolbar. To the callback function
812
+ * a list of datasources is passed. The callback functions return a modified list of datasources to be displayed
813
+ * in the tabstrips.
814
+ *
815
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
816
+ *
817
+ * @returns Reference to `this` in order to allow method chaining
818
+ */
819
+ setTabStripsFormatter(
820
+ /**
821
+ * New value for property `tabStripsFormatter`
822
+ */
823
+ fnTabStripsFormatter: Function
824
+ ): this;
825
+ }
826
+ }
827
+ }
828
+ }
829
+
4
830
  interface IUI5DefineDependencyNames {
5
831
  "sap/esh/search/ui/library": undefined;
832
+
833
+ "sap/esh/search/ui/SearchCompositeControl": undefined;
6
834
  }
7
835
  }