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