@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.
- package/LICENSE.txt +35 -0
- package/README.md +35 -0
- package/package.json +23 -0
- package/types/index.d.ts +67 -0
- package/types/sap.apf.d.ts +1026 -0
- package/types/sap.ca.ui.d.ts +14005 -0
- package/types/sap.chart.d.ts +4815 -0
- package/types/sap.collaboration.d.ts +2704 -0
- package/types/sap.esh.search.ui.d.ts +1595 -0
- package/types/sap.f.d.ts +20085 -0
- package/types/sap.fe.core.d.ts +1508 -0
- package/types/sap.fe.macros.d.ts +975 -0
- package/types/sap.fe.navigation.d.ts +917 -0
- package/types/sap.fe.templates.d.ts +522 -0
- package/types/sap.fe.test.d.ts +3533 -0
- package/types/sap.feedback.ui.d.ts +3 -0
- package/types/sap.gantt.d.ts +51684 -0
- package/types/sap.insights.d.ts +23 -0
- package/types/sap.landvisz.d.ts +7952 -0
- package/types/sap.m.d.ts +147796 -0
- package/types/sap.makit.d.ts +4533 -0
- package/types/sap.me.d.ts +3665 -0
- package/types/sap.ndc.d.ts +774 -0
- package/types/sap.ovp.d.ts +176 -0
- package/types/sap.rules.ui.d.ts +1471 -0
- package/types/sap.sac.df.d.ts +2292 -0
- package/types/sap.sac.grid.d.ts +774 -0
- package/types/sap.suite.ui.commons.d.ts +46971 -0
- package/types/sap.suite.ui.generic.template.d.ts +3431 -0
- package/types/sap.suite.ui.microchart.d.ts +12652 -0
- package/types/sap.tnt.d.ts +2227 -0
- package/types/sap.ui.codeeditor.d.ts +693 -0
- package/types/sap.ui.commons.d.ts +30235 -0
- package/types/sap.ui.comp.d.ts +37411 -0
- package/types/sap.ui.core.d.ts +78872 -0
- package/types/sap.ui.dt.d.ts +3 -0
- package/types/sap.ui.export.d.ts +843 -0
- package/types/sap.ui.fl.d.ts +1663 -0
- package/types/sap.ui.generic.app.d.ts +2683 -0
- package/types/sap.ui.generic.template.d.ts +3 -0
- package/types/sap.ui.integration.d.ts +4032 -0
- package/types/sap.ui.layout.d.ts +14472 -0
- package/types/sap.ui.mdc.d.ts +476 -0
- package/types/sap.ui.richtexteditor.d.ts +1666 -0
- package/types/sap.ui.rta.d.ts +124 -0
- package/types/sap.ui.suite.d.ts +685 -0
- package/types/sap.ui.support.d.ts +453 -0
- package/types/sap.ui.table.d.ts +9325 -0
- package/types/sap.ui.testrecorder.d.ts +9 -0
- package/types/sap.ui.unified.d.ts +20640 -0
- package/types/sap.ui.ux3.d.ts +18288 -0
- package/types/sap.ui.vbm.d.ts +17251 -0
- package/types/sap.ui.vk.d.ts +42381 -0
- package/types/sap.ui.vtm.d.ts +10547 -0
- package/types/sap.ui.webc.common.d.ts +113 -0
- package/types/sap.ui.webc.fiori.d.ts +13850 -0
- package/types/sap.ui.webc.main.d.ts +40833 -0
- package/types/sap.uiext.inbox.d.ts +4079 -0
- package/types/sap.ushell.d.ts +10255 -0
- package/types/sap.ushell_abap.d.ts +9 -0
- package/types/sap.uxap.d.ts +7636 -0
- package/types/sap.viz.d.ts +51209 -0
- package/types/sap.webanalytics.core.d.ts +3 -0
- package/types/sap.zen.commons.d.ts +1542 -0
- package/types/sap.zen.crosstab.d.ts +1159 -0
- package/types/sap.zen.dsh.d.ts +2132 -0
|
@@ -0,0 +1,1595 @@
|
|
|
1
|
+
// For Library Version: 1.113.0
|
|
2
|
+
|
|
3
|
+
declare module "sap/esh/search/ui/library" {}
|
|
4
|
+
|
|
5
|
+
declare module "sap/esh/search/ui/SearchCompositeControl" {
|
|
6
|
+
import { default as Control, $ControlSettings } from "sap/ui/core/Control";
|
|
7
|
+
|
|
8
|
+
import Event from "sap/ui/base/Event";
|
|
9
|
+
|
|
10
|
+
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
11
|
+
|
|
12
|
+
import {
|
|
13
|
+
PropertyBindingInfo,
|
|
14
|
+
AggregationBindingInfo,
|
|
15
|
+
} from "sap/ui/base/ManagedObject";
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* @SINCE 1.93.0
|
|
19
|
+
*
|
|
20
|
+
* This is the SAPUI5 composite control by the Enterprise Search Team which helps to make full use of the
|
|
21
|
+
* Enterprise Search Engine features built into ABAP and HANA. It includes a search input box including
|
|
22
|
+
* a suggestion dropdown, a result list which can have different styles including tiles and table, result
|
|
23
|
+
* facets and more. This control is ready to use with an enterprise search backend service but also allows
|
|
24
|
+
* deep modifications to match requirements of adopting applications.
|
|
25
|
+
*/
|
|
26
|
+
export default class SearchCompositeControl extends Control {
|
|
27
|
+
/**
|
|
28
|
+
* Constructs a new `SearchCompositeControl` to interact with SAP Enterprise Search Services.
|
|
29
|
+
* See:
|
|
30
|
+
* https://help.sap.com/viewer/691cb949c1034198800afde3e5be6570/2.0.05/en-US/ce86ef2fd97610149eaaaa0244ca4d36.html
|
|
31
|
+
* https://help.sap.com/viewer/6522d0462aeb4909a79c3462b090ec51/1709%20002/en-US
|
|
32
|
+
*/
|
|
33
|
+
constructor(
|
|
34
|
+
/**
|
|
35
|
+
* Initial settings for the new control
|
|
36
|
+
*/
|
|
37
|
+
mSettings?: $SearchCompositeControlSettings
|
|
38
|
+
);
|
|
39
|
+
/**
|
|
40
|
+
* Constructs a new `SearchCompositeControl` to interact with SAP Enterprise Search Services.
|
|
41
|
+
* See:
|
|
42
|
+
* https://help.sap.com/viewer/691cb949c1034198800afde3e5be6570/2.0.05/en-US/ce86ef2fd97610149eaaaa0244ca4d36.html
|
|
43
|
+
* https://help.sap.com/viewer/6522d0462aeb4909a79c3462b090ec51/1709%20002/en-US
|
|
44
|
+
*/
|
|
45
|
+
constructor(
|
|
46
|
+
/**
|
|
47
|
+
* ID for the new control, generated automatically if no ID is given
|
|
48
|
+
*/
|
|
49
|
+
sId?: string,
|
|
50
|
+
/**
|
|
51
|
+
* Initial settings for the new control
|
|
52
|
+
*/
|
|
53
|
+
mSettings?: $SearchCompositeControlSettings
|
|
54
|
+
);
|
|
55
|
+
|
|
56
|
+
/**
|
|
57
|
+
* Creates a new subclass of class sap.esh.search.ui.SearchCompositeControl with name `sClassName` and enriches
|
|
58
|
+
* it with the information contained in `oClassInfo`.
|
|
59
|
+
*
|
|
60
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
|
|
61
|
+
*
|
|
62
|
+
* @returns Created class / constructor function
|
|
63
|
+
*/
|
|
64
|
+
static extend<T extends Record<string, unknown>>(
|
|
65
|
+
/**
|
|
66
|
+
* Name of the class being created
|
|
67
|
+
*/
|
|
68
|
+
sClassName: string,
|
|
69
|
+
/**
|
|
70
|
+
* Object literal with information about the class
|
|
71
|
+
*/
|
|
72
|
+
oClassInfo?: sap.ClassInfo<T, SearchCompositeControl>,
|
|
73
|
+
/**
|
|
74
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
75
|
+
* used by this class
|
|
76
|
+
*/
|
|
77
|
+
FNMetaImpl?: Function
|
|
78
|
+
): Function;
|
|
79
|
+
/**
|
|
80
|
+
* Returns a metadata object for class sap.esh.search.ui.SearchCompositeControl.
|
|
81
|
+
*
|
|
82
|
+
* @returns Metadata object describing this class
|
|
83
|
+
*/
|
|
84
|
+
static getMetadata(): ElementMetadata;
|
|
85
|
+
/**
|
|
86
|
+
* Adds some content to the aggregation {@link #getContent content}.
|
|
87
|
+
*
|
|
88
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
89
|
+
*/
|
|
90
|
+
addContent(
|
|
91
|
+
/**
|
|
92
|
+
* The content to add; if empty, nothing is inserted
|
|
93
|
+
*/
|
|
94
|
+
oContent: Control
|
|
95
|
+
): this;
|
|
96
|
+
/**
|
|
97
|
+
* Attaches event handler `fnFunction` to the {@link #event:searchFinished searchFinished} event of this
|
|
98
|
+
* `sap.esh.search.ui.SearchCompositeControl`.
|
|
99
|
+
*
|
|
100
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
101
|
+
* otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself.
|
|
102
|
+
*
|
|
103
|
+
* Event is fired when search is finished.
|
|
104
|
+
*
|
|
105
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
106
|
+
*/
|
|
107
|
+
attachSearchFinished(
|
|
108
|
+
/**
|
|
109
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
110
|
+
* object when firing the event
|
|
111
|
+
*/
|
|
112
|
+
oData: object,
|
|
113
|
+
/**
|
|
114
|
+
* The function to be called when the event occurs
|
|
115
|
+
*/
|
|
116
|
+
fnFunction: (p1: Event) => void,
|
|
117
|
+
/**
|
|
118
|
+
* Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl`
|
|
119
|
+
* itself
|
|
120
|
+
*/
|
|
121
|
+
oListener?: object
|
|
122
|
+
): this;
|
|
123
|
+
/**
|
|
124
|
+
* Attaches event handler `fnFunction` to the {@link #event:searchFinished searchFinished} event of this
|
|
125
|
+
* `sap.esh.search.ui.SearchCompositeControl`.
|
|
126
|
+
*
|
|
127
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
128
|
+
* otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself.
|
|
129
|
+
*
|
|
130
|
+
* Event is fired when search is finished.
|
|
131
|
+
*
|
|
132
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
133
|
+
*/
|
|
134
|
+
attachSearchFinished(
|
|
135
|
+
/**
|
|
136
|
+
* The function to be called when the event occurs
|
|
137
|
+
*/
|
|
138
|
+
fnFunction: (p1: Event) => void,
|
|
139
|
+
/**
|
|
140
|
+
* Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl`
|
|
141
|
+
* itself
|
|
142
|
+
*/
|
|
143
|
+
oListener?: object
|
|
144
|
+
): this;
|
|
145
|
+
/**
|
|
146
|
+
* Attaches event handler `fnFunction` to the {@link #event:searchStarted searchStarted} event of this `sap.esh.search.ui.SearchCompositeControl`.
|
|
147
|
+
*
|
|
148
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
149
|
+
* otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself.
|
|
150
|
+
*
|
|
151
|
+
* Event is fired when search is started.
|
|
152
|
+
*
|
|
153
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
154
|
+
*/
|
|
155
|
+
attachSearchStarted(
|
|
156
|
+
/**
|
|
157
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
158
|
+
* object when firing the event
|
|
159
|
+
*/
|
|
160
|
+
oData: object,
|
|
161
|
+
/**
|
|
162
|
+
* The function to be called when the event occurs
|
|
163
|
+
*/
|
|
164
|
+
fnFunction: (p1: Event) => void,
|
|
165
|
+
/**
|
|
166
|
+
* Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl`
|
|
167
|
+
* itself
|
|
168
|
+
*/
|
|
169
|
+
oListener?: object
|
|
170
|
+
): this;
|
|
171
|
+
/**
|
|
172
|
+
* Attaches event handler `fnFunction` to the {@link #event:searchStarted searchStarted} event of this `sap.esh.search.ui.SearchCompositeControl`.
|
|
173
|
+
*
|
|
174
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
175
|
+
* otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself.
|
|
176
|
+
*
|
|
177
|
+
* Event is fired when search is started.
|
|
178
|
+
*
|
|
179
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
180
|
+
*/
|
|
181
|
+
attachSearchStarted(
|
|
182
|
+
/**
|
|
183
|
+
* The function to be called when the event occurs
|
|
184
|
+
*/
|
|
185
|
+
fnFunction: (p1: Event) => void,
|
|
186
|
+
/**
|
|
187
|
+
* Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl`
|
|
188
|
+
* itself
|
|
189
|
+
*/
|
|
190
|
+
oListener?: object
|
|
191
|
+
): this;
|
|
192
|
+
/**
|
|
193
|
+
* Destroys all the content in the aggregation {@link #getContent content}.
|
|
194
|
+
*
|
|
195
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
196
|
+
*/
|
|
197
|
+
destroyContent(): this;
|
|
198
|
+
/**
|
|
199
|
+
* Detaches event handler `fnFunction` from the {@link #event:searchFinished searchFinished} event of this
|
|
200
|
+
* `sap.esh.search.ui.SearchCompositeControl`.
|
|
201
|
+
*
|
|
202
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
203
|
+
*
|
|
204
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
205
|
+
*/
|
|
206
|
+
detachSearchFinished(
|
|
207
|
+
/**
|
|
208
|
+
* The function to be called, when the event occurs
|
|
209
|
+
*/
|
|
210
|
+
fnFunction: (p1: Event) => void,
|
|
211
|
+
/**
|
|
212
|
+
* Context object on which the given function had to be called
|
|
213
|
+
*/
|
|
214
|
+
oListener?: object
|
|
215
|
+
): this;
|
|
216
|
+
/**
|
|
217
|
+
* Detaches event handler `fnFunction` from the {@link #event:searchStarted searchStarted} event of this
|
|
218
|
+
* `sap.esh.search.ui.SearchCompositeControl`.
|
|
219
|
+
*
|
|
220
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
221
|
+
*
|
|
222
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
223
|
+
*/
|
|
224
|
+
detachSearchStarted(
|
|
225
|
+
/**
|
|
226
|
+
* The function to be called, when the event occurs
|
|
227
|
+
*/
|
|
228
|
+
fnFunction: (p1: Event) => void,
|
|
229
|
+
/**
|
|
230
|
+
* Context object on which the given function had to be called
|
|
231
|
+
*/
|
|
232
|
+
oListener?: object
|
|
233
|
+
): this;
|
|
234
|
+
/**
|
|
235
|
+
* @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
236
|
+
*
|
|
237
|
+
* Fires event {@link #event:searchFinished searchFinished} to attached listeners.
|
|
238
|
+
*
|
|
239
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
240
|
+
*/
|
|
241
|
+
fireSearchFinished(
|
|
242
|
+
/**
|
|
243
|
+
* Parameters to pass along with the event
|
|
244
|
+
*/
|
|
245
|
+
mParameters?: object
|
|
246
|
+
): this;
|
|
247
|
+
/**
|
|
248
|
+
* @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
249
|
+
*
|
|
250
|
+
* Fires event {@link #event:searchStarted searchStarted} to attached listeners.
|
|
251
|
+
*
|
|
252
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
253
|
+
*/
|
|
254
|
+
fireSearchStarted(
|
|
255
|
+
/**
|
|
256
|
+
* Parameters to pass along with the event
|
|
257
|
+
*/
|
|
258
|
+
mParameters?: object
|
|
259
|
+
): this;
|
|
260
|
+
/**
|
|
261
|
+
* @SINCE 1.108.0
|
|
262
|
+
*
|
|
263
|
+
* Gets current value of property {@link #getApplicationComponent applicationComponent}.
|
|
264
|
+
*
|
|
265
|
+
* Relevant for SAP partners and SAP, the "Application Component" you expect customers to create incidents.
|
|
266
|
+
*
|
|
267
|
+
* Default value is `"HAN-AS-INA-UI"`.
|
|
268
|
+
*
|
|
269
|
+
* @returns Value of property `applicationComponent`
|
|
270
|
+
*/
|
|
271
|
+
getApplicationComponent(): string;
|
|
272
|
+
/**
|
|
273
|
+
* @SINCE 1.106.0
|
|
274
|
+
*
|
|
275
|
+
* Gets current value of property {@link #getAutoAdjustResultViewTypeInFolderMode autoAdjustResultViewTypeInFolderMode}.
|
|
276
|
+
*
|
|
277
|
+
* In case folder mode is active: Automatically switch result view type to list in search mode and to table
|
|
278
|
+
* in folder mode.
|
|
279
|
+
*
|
|
280
|
+
* Default value is `false`.
|
|
281
|
+
*
|
|
282
|
+
* @returns Value of property `autoAdjustResultViewTypeInFolderMode`
|
|
283
|
+
*/
|
|
284
|
+
getAutoAdjustResultViewTypeInFolderMode(): boolean;
|
|
285
|
+
/**
|
|
286
|
+
* @SINCE 1.113.0
|
|
287
|
+
*
|
|
288
|
+
* Gets current value of property {@link #getBoSuggestions boSuggestions}.
|
|
289
|
+
*
|
|
290
|
+
* A boolean for enabling (business) object suggestions.
|
|
291
|
+
*
|
|
292
|
+
* Default value is `false`.
|
|
293
|
+
*
|
|
294
|
+
* @returns Value of property `boSuggestions`
|
|
295
|
+
*/
|
|
296
|
+
getBoSuggestions(): boolean;
|
|
297
|
+
/**
|
|
298
|
+
* Gets content of aggregation {@link #getContent content}.
|
|
299
|
+
*
|
|
300
|
+
* Control instances which are part of this composite control.
|
|
301
|
+
*/
|
|
302
|
+
getContent(): Control[];
|
|
303
|
+
/**
|
|
304
|
+
* @SINCE 1.93.0
|
|
305
|
+
*
|
|
306
|
+
* Gets current value of property {@link #getCssClass cssClass}.
|
|
307
|
+
*
|
|
308
|
+
* An additional CSS class to add to this control
|
|
309
|
+
*
|
|
310
|
+
* @returns Value of property `cssClass`
|
|
311
|
+
*/
|
|
312
|
+
getCssClass(): string;
|
|
313
|
+
/**
|
|
314
|
+
* @SINCE 1.98.0
|
|
315
|
+
*
|
|
316
|
+
* Gets current value of property {@link #getDataSource dataSource}.
|
|
317
|
+
*
|
|
318
|
+
* The id of the data source in which it will search right after initialization.
|
|
319
|
+
*
|
|
320
|
+
* @returns Value of property `dataSource`
|
|
321
|
+
*/
|
|
322
|
+
getDataSource(): string;
|
|
323
|
+
/**
|
|
324
|
+
* @SINCE 1.93.0
|
|
325
|
+
*
|
|
326
|
+
* Gets current value of property {@link #getDefaultDataSource defaultDataSource}.
|
|
327
|
+
*
|
|
328
|
+
* Data source id which is set when the UI is loaded or filter is reset. If dataSource is also set, dataSource
|
|
329
|
+
* will be used during UI load and this parameter will used only after filter is reset.
|
|
330
|
+
*
|
|
331
|
+
* @returns Value of property `defaultDataSource`
|
|
332
|
+
*/
|
|
333
|
+
getDefaultDataSource(): string;
|
|
334
|
+
/**
|
|
335
|
+
* @SINCE 1.113.0
|
|
336
|
+
*
|
|
337
|
+
* Gets current value of property {@link #getDisplayFacetPanelInCaseOfNoResults displayFacetPanelInCaseOfNoResults}.
|
|
338
|
+
*
|
|
339
|
+
* When set to true the facet panel is displayed also in case there are no search results.
|
|
340
|
+
*
|
|
341
|
+
* Default value is `false`.
|
|
342
|
+
*
|
|
343
|
+
* @returns Value of property `displayFacetPanelInCaseOfNoResults`
|
|
344
|
+
*/
|
|
345
|
+
getDisplayFacetPanelInCaseOfNoResults(): boolean;
|
|
346
|
+
/**
|
|
347
|
+
* @SINCE 1.107.0
|
|
348
|
+
*
|
|
349
|
+
* Gets current value of property {@link #getEnableQueryLanguage enableQueryLanguage}.
|
|
350
|
+
*
|
|
351
|
+
* Enables the query language for the hana_odata provider. With query language it is possible for the end
|
|
352
|
+
* user to enter complex search queries with logical operators.
|
|
353
|
+
*
|
|
354
|
+
* Default value is `false`.
|
|
355
|
+
*
|
|
356
|
+
* @returns Value of property `enableQueryLanguage`
|
|
357
|
+
*/
|
|
358
|
+
getEnableQueryLanguage(): boolean;
|
|
359
|
+
/**
|
|
360
|
+
* @SINCE 1.108.0
|
|
361
|
+
*
|
|
362
|
+
* Gets current value of property {@link #getFacetPanelResizable facetPanelResizable}.
|
|
363
|
+
*
|
|
364
|
+
* Display a splitter bar to resize the left hand panel, containing all facets and filter criteria.
|
|
365
|
+
*
|
|
366
|
+
* Default value is `false`.
|
|
367
|
+
*
|
|
368
|
+
* @returns Value of property `facetPanelResizable`
|
|
369
|
+
*/
|
|
370
|
+
getFacetPanelResizable(): boolean;
|
|
371
|
+
/**
|
|
372
|
+
* @SINCE 1.108.0
|
|
373
|
+
*
|
|
374
|
+
* Gets current value of property {@link #getFacetPanelWidthInPercent facetPanelWidthInPercent}.
|
|
375
|
+
*
|
|
376
|
+
* Default size (percent) of the left hand panel, containing all facets and filter criteria. If "facetPanelResizable"
|
|
377
|
+
* is true, the width of the facet panel can be changed by the user.
|
|
378
|
+
*
|
|
379
|
+
* Default value is `25`.
|
|
380
|
+
*
|
|
381
|
+
* @returns Value of property `facetPanelWidthInPercent`
|
|
382
|
+
*/
|
|
383
|
+
getFacetPanelWidthInPercent(): float;
|
|
384
|
+
/**
|
|
385
|
+
* @SINCE 1.113.0
|
|
386
|
+
*
|
|
387
|
+
* Gets current value of property {@link #getFacetVisibility facetVisibility}.
|
|
388
|
+
*
|
|
389
|
+
* A boolean which indicates whether the facet panel is initially openend or closed. This affects only the
|
|
390
|
+
* initial state of the facet panel. When not setting facetVisibility the initial state of the facet panel
|
|
391
|
+
* typically is taken from the user personalization storage.
|
|
392
|
+
*
|
|
393
|
+
* @returns Value of property `facetVisibility`
|
|
394
|
+
*/
|
|
395
|
+
getFacetVisibility(): boolean;
|
|
396
|
+
/**
|
|
397
|
+
* @SINCE 1.112.0
|
|
398
|
+
*
|
|
399
|
+
* Gets current value of property {@link #getFilterDataSources filterDataSources}.
|
|
400
|
+
*
|
|
401
|
+
* Callback for filtering the datasources displayed in the datasource dropdown listbox. The callback gets
|
|
402
|
+
* a list of datsources and returns the filtered list of datasources.
|
|
403
|
+
*
|
|
404
|
+
* @returns Value of property `filterDataSources`
|
|
405
|
+
*/
|
|
406
|
+
getFilterDataSources(): Function;
|
|
407
|
+
/**
|
|
408
|
+
* @SINCE 1.98.0
|
|
409
|
+
*
|
|
410
|
+
* Gets current value of property {@link #getFilterRootCondition filterRootCondition}.
|
|
411
|
+
*
|
|
412
|
+
* Defines the filter root condition of a filter tree which shall be applied to the search request. This
|
|
413
|
+
* control only allows filter trees which have a the following structure: complex condition (root level)
|
|
414
|
+
* \ complex condition (attribute level) \ simple condition (attribute value level) Filter root conditions
|
|
415
|
+
* which do not follow this structure won't be accepted and an error will be thrown. Please see the below
|
|
416
|
+
* for a more in-depth example.
|
|
417
|
+
*
|
|
418
|
+
* @returns Value of property `filterRootCondition`
|
|
419
|
+
*/
|
|
420
|
+
getFilterRootCondition(): object;
|
|
421
|
+
/**
|
|
422
|
+
* @SINCE 1.106.0
|
|
423
|
+
*
|
|
424
|
+
* Gets current value of property {@link #getFolderMode folderMode}.
|
|
425
|
+
*
|
|
426
|
+
* Activates the folder mode. Precondition for folder mode is 1) Search model: In the search model for the
|
|
427
|
+
* current datasource a hierarchy attribute (representing the folders) is defined 1.1) the hierarchy attribute
|
|
428
|
+
* is annotated with displayType=TREE and for the hierarchy there is a helper connector representing the
|
|
429
|
+
* hierarchy or 1.2) the current datasource is the helper datasource representing the folder hierarchy.
|
|
430
|
+
* The hierarchy attribute is annotated with displayType=FLAT 2) Search query: The folder mode is only active
|
|
431
|
+
* in case the search query has an empty search term and no filter conditions (except the hierarchy attribute)
|
|
432
|
+
* are set.
|
|
433
|
+
*
|
|
434
|
+
* In folder mode and in case a folder filter is set the result view only shows direct children of a folder.
|
|
435
|
+
* In contrast the counts in the facets are calculated by counting direct and not direct children. In case
|
|
436
|
+
* the folder mode is not active the UI uses the search mode: The result list shows direct and not direct
|
|
437
|
+
* children of a folder.
|
|
438
|
+
*
|
|
439
|
+
* @returns Value of property `folderMode`
|
|
440
|
+
*/
|
|
441
|
+
getFolderMode(): boolean;
|
|
442
|
+
/**
|
|
443
|
+
* @SINCE 1.94.0
|
|
444
|
+
*
|
|
445
|
+
* Gets current value of property {@link #getGetCustomNoResultScreen getCustomNoResultScreen}.
|
|
446
|
+
*
|
|
447
|
+
* Whenever a search has no results, a 'No Results Page' is displayed. You can provide a custom page to
|
|
448
|
+
* be more specific and add some hints, links, buttons or other content.
|
|
449
|
+
*
|
|
450
|
+
* @returns Value of property `getCustomNoResultScreen`
|
|
451
|
+
*/
|
|
452
|
+
getGetCustomNoResultScreen(): Function;
|
|
453
|
+
/**
|
|
454
|
+
* @SINCE 1.113.0
|
|
455
|
+
*
|
|
456
|
+
* Gets current value of property {@link #getInitAsync initAsync}.
|
|
457
|
+
*
|
|
458
|
+
* A callback which is called after the initialization of the search composite control.
|
|
459
|
+
*
|
|
460
|
+
* @returns Value of property `initAsync`
|
|
461
|
+
*/
|
|
462
|
+
getInitAsync(): Function;
|
|
463
|
+
/**
|
|
464
|
+
* @SINCE 1.113.0
|
|
465
|
+
*
|
|
466
|
+
* Gets current value of property {@link #getIsSearchUrl isSearchUrl}.
|
|
467
|
+
*
|
|
468
|
+
* A callback for checking whether a URL is a search URL. The callback receives a URL and returns true in
|
|
469
|
+
* case the URL is a search URL. Typically you need to register this callback in case updateUrl=true.
|
|
470
|
+
*
|
|
471
|
+
* @returns Value of property `isSearchUrl`
|
|
472
|
+
*/
|
|
473
|
+
getIsSearchUrl(): Function;
|
|
474
|
+
/**
|
|
475
|
+
* @SINCE 1.111.0
|
|
476
|
+
*
|
|
477
|
+
* Gets current value of property {@link #getOptimizeForValueHelp optimizeForValueHelp}.
|
|
478
|
+
*
|
|
479
|
+
* The layout is optimized for object selection / value help (narrow view w/o facet panel).
|
|
480
|
+
*
|
|
481
|
+
* @returns Value of property `optimizeForValueHelp`
|
|
482
|
+
*/
|
|
483
|
+
getOptimizeForValueHelp(): boolean;
|
|
484
|
+
/**
|
|
485
|
+
* @SINCE 1.93.0
|
|
486
|
+
*
|
|
487
|
+
* Gets current value of property {@link #getOverwriteBrowserTitle overwriteBrowserTitle}.
|
|
488
|
+
*
|
|
489
|
+
* Shall the window title be overwritten by this control? If true, the control will set the current search
|
|
490
|
+
* condition as window title. If false, it will not set or update the window title.
|
|
491
|
+
*
|
|
492
|
+
* @returns Value of property `overwriteBrowserTitle`
|
|
493
|
+
*/
|
|
494
|
+
getOverwriteBrowserTitle(): boolean;
|
|
495
|
+
/**
|
|
496
|
+
* @SINCE 1.113.0
|
|
497
|
+
*
|
|
498
|
+
* Gets current value of property {@link #getParseSearchUrlParameters parseSearchUrlParameters}.
|
|
499
|
+
*
|
|
500
|
+
* A callback for parsing URL parameters. The callback receices URL parameters and returns modified URL
|
|
501
|
+
* parameters. This is an optional callback. Also in case you set updateUrl=true typcically this callback
|
|
502
|
+
* is not needed.
|
|
503
|
+
*
|
|
504
|
+
* @returns Value of property `parseSearchUrlParameters`
|
|
505
|
+
*/
|
|
506
|
+
getParseSearchUrlParameters(): Function;
|
|
507
|
+
/**
|
|
508
|
+
* @SINCE 1.113.0
|
|
509
|
+
*
|
|
510
|
+
* Gets current value of property {@link #getQuickSelectDataSources quickSelectDataSources}.
|
|
511
|
+
*
|
|
512
|
+
* A list of datasources to be displayed in the facet panel in the collection area.
|
|
513
|
+
*
|
|
514
|
+
* @returns Value of property `quickSelectDataSources`
|
|
515
|
+
*/
|
|
516
|
+
getQuickSelectDataSources(): object;
|
|
517
|
+
/**
|
|
518
|
+
* @SINCE 1.113.0
|
|
519
|
+
*
|
|
520
|
+
* Gets current value of property {@link #getRenderSearchUrl renderSearchUrl}.
|
|
521
|
+
*
|
|
522
|
+
* A callback for rendering the search URL. The callback gets a list of url encoded parameters and returns
|
|
523
|
+
* the URL string. Typically you need to register this callback in case updateUrl=true.
|
|
524
|
+
*
|
|
525
|
+
* @returns Value of property `renderSearchUrl`
|
|
526
|
+
*/
|
|
527
|
+
getRenderSearchUrl(): Function;
|
|
528
|
+
/**
|
|
529
|
+
* @SINCE 1.100.0
|
|
530
|
+
*
|
|
531
|
+
* Gets current value of property {@link #getResultViewSettings resultViewSettings}.
|
|
532
|
+
*
|
|
533
|
+
* Defines a pair of search result view settings. The value is an object of properties `resultViewTypes`
|
|
534
|
+
* and `resultViewType`. An example: `{resultViewTypes: ["searchResultList", "searchResultTable"], resultViewType:
|
|
535
|
+
* "searchResultList"}` Find more detail in the definition of each child property. The value can be set/get
|
|
536
|
+
* in attached event "searchFinished". Function `setResultViewSettings` prevents incompatibility of sequential
|
|
537
|
+
* execution of functions `setResultViewTypes` and `setResultViewType`. Note: The value of `resultViewTypes`
|
|
538
|
+
* and `resultViewType` must be compatible to each other.
|
|
539
|
+
*
|
|
540
|
+
* Default value is `...see text or source`.
|
|
541
|
+
*
|
|
542
|
+
* @returns Value of property `resultViewSettings`
|
|
543
|
+
*/
|
|
544
|
+
getResultViewSettings(): string;
|
|
545
|
+
/**
|
|
546
|
+
* @SINCE 1.98.0
|
|
547
|
+
*
|
|
548
|
+
* Gets current value of property {@link #getResultViewType resultViewType}.
|
|
549
|
+
*
|
|
550
|
+
* Defines active search result view type. The value can be set/get in attach event "searchFinished", and
|
|
551
|
+
* it must be contained in resultViewTypes. Case 1, Search in Apps: result is displayed in a mandatory view
|
|
552
|
+
* type `"appSearchResult"`. Case 2.1, Search in All or other Category (configuration.isUshell !== true):
|
|
553
|
+
* result is switchable between different view types. Possible value is `"searchResultList"`, or `"searchResultGrid"`.
|
|
554
|
+
* Case 2.2, Search in All or other Category (configuration.isUshell === true): result is displayed in a
|
|
555
|
+
* mandatory view type `"searchResultList"`. Case 3, Search in Business Object: result is switchable between
|
|
556
|
+
* different view types. Possible value is `"searchResultList"`, `"searchResultTable"` or `"searchResultGrid"`.
|
|
557
|
+
* Note: The value of `resultViewTypes` and `resultViewType` must be compatible to each other.
|
|
558
|
+
*
|
|
559
|
+
* Default value is `"searchResultList"`.
|
|
560
|
+
*
|
|
561
|
+
* @returns Value of property `resultViewType`
|
|
562
|
+
*/
|
|
563
|
+
getResultViewType(): string;
|
|
564
|
+
/**
|
|
565
|
+
* @SINCE 1.98.0
|
|
566
|
+
*
|
|
567
|
+
* Gets current value of property {@link #getResultViewTypes resultViewTypes}.
|
|
568
|
+
*
|
|
569
|
+
* Defines selectable search result view types. The value can be set/get in attach event "searchFinished".
|
|
570
|
+
* Case 1: Search in Apps: result is displayed in a mandatory view type `["appSearchResult"]`, and it is
|
|
571
|
+
* not switchable. Case 2: Search in All or other Category: result is switchable between different view
|
|
572
|
+
* types. Possible values for the array items are `"searchResultList"` and `"searchResultGrid"`. Case 3,
|
|
573
|
+
* Search in Business Object: result is switchable between different view types. Possible values for the
|
|
574
|
+
* array items are `"searchResultList"`, `"searchResultTable"` and `"searchResultGrid"`. Note: The value
|
|
575
|
+
* of `resultViewTypes` and `resultViewType` must be compatible to each other.
|
|
576
|
+
*
|
|
577
|
+
* Default value is `["searchResultList", "searchResultTable"]`.
|
|
578
|
+
*
|
|
579
|
+
* @returns Value of property `resultViewTypes`
|
|
580
|
+
*/
|
|
581
|
+
getResultViewTypes(): string[];
|
|
582
|
+
/**
|
|
583
|
+
* @SINCE 1.93.0
|
|
584
|
+
*
|
|
585
|
+
* Gets current value of property {@link #getSearchOnStart searchOnStart}.
|
|
586
|
+
*
|
|
587
|
+
* Defines if the search composite control will send a search request after loading for the given term,
|
|
588
|
+
* data source and filter root condition settings.
|
|
589
|
+
*
|
|
590
|
+
* Default value is `true`.
|
|
591
|
+
*
|
|
592
|
+
* @returns Value of property `searchOnStart`
|
|
593
|
+
*/
|
|
594
|
+
getSearchOnStart(): boolean;
|
|
595
|
+
/**
|
|
596
|
+
* @SINCE 1.93.0
|
|
597
|
+
*
|
|
598
|
+
* Gets current value of property {@link #getSearchTerm searchTerm}.
|
|
599
|
+
*
|
|
600
|
+
* Defines the initial search term for the search input.
|
|
601
|
+
*
|
|
602
|
+
* Default value is `empty string`.
|
|
603
|
+
*
|
|
604
|
+
* @returns Value of property `searchTerm`
|
|
605
|
+
*/
|
|
606
|
+
getSearchTerm(): string;
|
|
607
|
+
/**
|
|
608
|
+
* @SINCE 1.113.0
|
|
609
|
+
*
|
|
610
|
+
* Gets current value of property {@link #getSelectionChange selectionChange}.
|
|
611
|
+
*
|
|
612
|
+
* A callback which is called whenever the selection of result list items changes.
|
|
613
|
+
*
|
|
614
|
+
* @returns Value of property `selectionChange`
|
|
615
|
+
*/
|
|
616
|
+
getSelectionChange(): Function;
|
|
617
|
+
/**
|
|
618
|
+
* @SINCE 1.93.0
|
|
619
|
+
*
|
|
620
|
+
* Gets current value of property {@link #getSinaConfiguration sinaConfiguration}.
|
|
621
|
+
*
|
|
622
|
+
* Configuration for the Enterprise Search Client API.
|
|
623
|
+
*
|
|
624
|
+
* @returns Value of property `sinaConfiguration`
|
|
625
|
+
*/
|
|
626
|
+
getSinaConfiguration(): object;
|
|
627
|
+
/**
|
|
628
|
+
* @SINCE 1.103.0
|
|
629
|
+
*
|
|
630
|
+
* Gets current value of property {@link #getTabStripsFormatter tabStripsFormatter}.
|
|
631
|
+
*
|
|
632
|
+
* Function callback for formatting the datasource tabstrips in the top toolbar. To the callback function
|
|
633
|
+
* a list of datasources is passed. The callback functions return a modified list of datasources to be displayed
|
|
634
|
+
* in the tabstrips.
|
|
635
|
+
*
|
|
636
|
+
* @returns Value of property `tabStripsFormatter`
|
|
637
|
+
*/
|
|
638
|
+
getTabStripsFormatter(): Function;
|
|
639
|
+
/**
|
|
640
|
+
* @SINCE 1.113.0
|
|
641
|
+
*
|
|
642
|
+
* Gets current value of property {@link #getUpdateUrl updateUrl}.
|
|
643
|
+
*
|
|
644
|
+
* A boolean indicating that the search state is written to the URL.
|
|
645
|
+
*
|
|
646
|
+
* Default value is `true`.
|
|
647
|
+
*
|
|
648
|
+
* @returns Value of property `updateUrl`
|
|
649
|
+
*/
|
|
650
|
+
getUpdateUrl(): boolean;
|
|
651
|
+
/**
|
|
652
|
+
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getContent content}. and returns
|
|
653
|
+
* its index if found or -1 otherwise.
|
|
654
|
+
*
|
|
655
|
+
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
656
|
+
*/
|
|
657
|
+
indexOfContent(
|
|
658
|
+
/**
|
|
659
|
+
* The content whose index is looked for
|
|
660
|
+
*/
|
|
661
|
+
oContent: Control
|
|
662
|
+
): int;
|
|
663
|
+
/**
|
|
664
|
+
* Inserts a content into the aggregation {@link #getContent content}.
|
|
665
|
+
*
|
|
666
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
667
|
+
*/
|
|
668
|
+
insertContent(
|
|
669
|
+
/**
|
|
670
|
+
* The content to insert; if empty, nothing is inserted
|
|
671
|
+
*/
|
|
672
|
+
oContent: Control,
|
|
673
|
+
/**
|
|
674
|
+
* The `0`-based index the content should be inserted at; for a negative value of `iIndex`, the content
|
|
675
|
+
* is inserted at position 0; for a value greater than the current size of the aggregation, the content
|
|
676
|
+
* is inserted at the last position
|
|
677
|
+
*/
|
|
678
|
+
iIndex: int
|
|
679
|
+
): this;
|
|
680
|
+
/**
|
|
681
|
+
* Removes all the controls from the aggregation {@link #getContent content}.
|
|
682
|
+
*
|
|
683
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
684
|
+
*
|
|
685
|
+
* @returns An array of the removed elements (might be empty)
|
|
686
|
+
*/
|
|
687
|
+
removeAllContent(): Control[];
|
|
688
|
+
/**
|
|
689
|
+
* Removes a content from the aggregation {@link #getContent content}.
|
|
690
|
+
*
|
|
691
|
+
* @returns The removed content or `null`
|
|
692
|
+
*/
|
|
693
|
+
removeContent(
|
|
694
|
+
/**
|
|
695
|
+
* The content to remove or its index or id
|
|
696
|
+
*/
|
|
697
|
+
vContent: int | string | Control
|
|
698
|
+
): Control | null;
|
|
699
|
+
/**
|
|
700
|
+
* @SINCE 1.108.0
|
|
701
|
+
*
|
|
702
|
+
* Sets a new value for property {@link #getApplicationComponent applicationComponent}.
|
|
703
|
+
*
|
|
704
|
+
* Relevant for SAP partners and SAP, the "Application Component" you expect customers to create incidents.
|
|
705
|
+
*
|
|
706
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
707
|
+
*
|
|
708
|
+
* Default value is `"HAN-AS-INA-UI"`.
|
|
709
|
+
*
|
|
710
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
711
|
+
*/
|
|
712
|
+
setApplicationComponent(
|
|
713
|
+
/**
|
|
714
|
+
* New value for property `applicationComponent`
|
|
715
|
+
*/
|
|
716
|
+
sApplicationComponent?: string
|
|
717
|
+
): this;
|
|
718
|
+
/**
|
|
719
|
+
* @SINCE 1.106.0
|
|
720
|
+
*
|
|
721
|
+
* Sets a new value for property {@link #getAutoAdjustResultViewTypeInFolderMode autoAdjustResultViewTypeInFolderMode}.
|
|
722
|
+
*
|
|
723
|
+
* In case folder mode is active: Automatically switch result view type to list in search mode and to table
|
|
724
|
+
* in folder mode.
|
|
725
|
+
*
|
|
726
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
727
|
+
*
|
|
728
|
+
* Default value is `false`.
|
|
729
|
+
*
|
|
730
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
731
|
+
*/
|
|
732
|
+
setAutoAdjustResultViewTypeInFolderMode(
|
|
733
|
+
/**
|
|
734
|
+
* New value for property `autoAdjustResultViewTypeInFolderMode`
|
|
735
|
+
*/
|
|
736
|
+
bAutoAdjustResultViewTypeInFolderMode?: boolean
|
|
737
|
+
): this;
|
|
738
|
+
/**
|
|
739
|
+
* @SINCE 1.113.0
|
|
740
|
+
*
|
|
741
|
+
* Sets a new value for property {@link #getBoSuggestions boSuggestions}.
|
|
742
|
+
*
|
|
743
|
+
* A boolean for enabling (business) object suggestions.
|
|
744
|
+
*
|
|
745
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
746
|
+
*
|
|
747
|
+
* Default value is `false`.
|
|
748
|
+
*
|
|
749
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
750
|
+
*/
|
|
751
|
+
setBoSuggestions(
|
|
752
|
+
/**
|
|
753
|
+
* New value for property `boSuggestions`
|
|
754
|
+
*/
|
|
755
|
+
bBoSuggestions?: boolean
|
|
756
|
+
): this;
|
|
757
|
+
/**
|
|
758
|
+
* @SINCE 1.93.0
|
|
759
|
+
*
|
|
760
|
+
* Sets a new value for property {@link #getCssClass cssClass}.
|
|
761
|
+
*
|
|
762
|
+
* An additional CSS class to add to this control
|
|
763
|
+
*
|
|
764
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
765
|
+
*
|
|
766
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
767
|
+
*/
|
|
768
|
+
setCssClass(
|
|
769
|
+
/**
|
|
770
|
+
* New value for property `cssClass`
|
|
771
|
+
*/
|
|
772
|
+
sCssClass: string
|
|
773
|
+
): this;
|
|
774
|
+
/**
|
|
775
|
+
* @SINCE 1.98.0
|
|
776
|
+
*
|
|
777
|
+
* Sets a new value for property {@link #getDataSource dataSource}.
|
|
778
|
+
*
|
|
779
|
+
* The id of the data source in which it will search right after initialization.
|
|
780
|
+
*
|
|
781
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
782
|
+
*
|
|
783
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
784
|
+
*/
|
|
785
|
+
setDataSource(
|
|
786
|
+
/**
|
|
787
|
+
* New value for property `dataSource`
|
|
788
|
+
*/
|
|
789
|
+
sDataSource: string
|
|
790
|
+
): this;
|
|
791
|
+
/**
|
|
792
|
+
* @SINCE 1.93.0
|
|
793
|
+
*
|
|
794
|
+
* Sets a new value for property {@link #getDefaultDataSource defaultDataSource}.
|
|
795
|
+
*
|
|
796
|
+
* Data source id which is set when the UI is loaded or filter is reset. If dataSource is also set, dataSource
|
|
797
|
+
* will be used during UI load and this parameter will used only after filter is reset.
|
|
798
|
+
*
|
|
799
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
800
|
+
*
|
|
801
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
802
|
+
*/
|
|
803
|
+
setDefaultDataSource(
|
|
804
|
+
/**
|
|
805
|
+
* New value for property `defaultDataSource`
|
|
806
|
+
*/
|
|
807
|
+
sDefaultDataSource: string
|
|
808
|
+
): this;
|
|
809
|
+
/**
|
|
810
|
+
* @SINCE 1.113.0
|
|
811
|
+
*
|
|
812
|
+
* Sets a new value for property {@link #getDisplayFacetPanelInCaseOfNoResults displayFacetPanelInCaseOfNoResults}.
|
|
813
|
+
*
|
|
814
|
+
* When set to true the facet panel is displayed also in case there are no search results.
|
|
815
|
+
*
|
|
816
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
817
|
+
*
|
|
818
|
+
* Default value is `false`.
|
|
819
|
+
*
|
|
820
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
821
|
+
*/
|
|
822
|
+
setDisplayFacetPanelInCaseOfNoResults(
|
|
823
|
+
/**
|
|
824
|
+
* New value for property `displayFacetPanelInCaseOfNoResults`
|
|
825
|
+
*/
|
|
826
|
+
bDisplayFacetPanelInCaseOfNoResults?: boolean
|
|
827
|
+
): this;
|
|
828
|
+
/**
|
|
829
|
+
* @SINCE 1.107.0
|
|
830
|
+
*
|
|
831
|
+
* Sets a new value for property {@link #getEnableQueryLanguage enableQueryLanguage}.
|
|
832
|
+
*
|
|
833
|
+
* Enables the query language for the hana_odata provider. With query language it is possible for the end
|
|
834
|
+
* user to enter complex search queries with logical operators.
|
|
835
|
+
*
|
|
836
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
837
|
+
*
|
|
838
|
+
* Default value is `false`.
|
|
839
|
+
*
|
|
840
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
841
|
+
*/
|
|
842
|
+
setEnableQueryLanguage(
|
|
843
|
+
/**
|
|
844
|
+
* New value for property `enableQueryLanguage`
|
|
845
|
+
*/
|
|
846
|
+
bEnableQueryLanguage?: boolean
|
|
847
|
+
): this;
|
|
848
|
+
/**
|
|
849
|
+
* @SINCE 1.108.0
|
|
850
|
+
*
|
|
851
|
+
* Sets a new value for property {@link #getFacetPanelResizable facetPanelResizable}.
|
|
852
|
+
*
|
|
853
|
+
* Display a splitter bar to resize the left hand panel, containing all facets and filter criteria.
|
|
854
|
+
*
|
|
855
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
856
|
+
*
|
|
857
|
+
* Default value is `false`.
|
|
858
|
+
*
|
|
859
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
860
|
+
*/
|
|
861
|
+
setFacetPanelResizable(
|
|
862
|
+
/**
|
|
863
|
+
* New value for property `facetPanelResizable`
|
|
864
|
+
*/
|
|
865
|
+
bFacetPanelResizable?: boolean
|
|
866
|
+
): this;
|
|
867
|
+
/**
|
|
868
|
+
* @SINCE 1.108.0
|
|
869
|
+
*
|
|
870
|
+
* Sets a new value for property {@link #getFacetPanelWidthInPercent facetPanelWidthInPercent}.
|
|
871
|
+
*
|
|
872
|
+
* Default size (percent) of the left hand panel, containing all facets and filter criteria. If "facetPanelResizable"
|
|
873
|
+
* is true, the width of the facet panel can be changed by the user.
|
|
874
|
+
*
|
|
875
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
876
|
+
*
|
|
877
|
+
* Default value is `25`.
|
|
878
|
+
*
|
|
879
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
880
|
+
*/
|
|
881
|
+
setFacetPanelWidthInPercent(
|
|
882
|
+
/**
|
|
883
|
+
* New value for property `facetPanelWidthInPercent`
|
|
884
|
+
*/
|
|
885
|
+
fFacetPanelWidthInPercent?: float
|
|
886
|
+
): this;
|
|
887
|
+
/**
|
|
888
|
+
* @SINCE 1.113.0
|
|
889
|
+
*
|
|
890
|
+
* Sets a new value for property {@link #getFacetVisibility facetVisibility}.
|
|
891
|
+
*
|
|
892
|
+
* A boolean which indicates whether the facet panel is initially openend or closed. This affects only the
|
|
893
|
+
* initial state of the facet panel. When not setting facetVisibility the initial state of the facet panel
|
|
894
|
+
* typically is taken from the user personalization storage.
|
|
895
|
+
*
|
|
896
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
897
|
+
*
|
|
898
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
899
|
+
*/
|
|
900
|
+
setFacetVisibility(
|
|
901
|
+
/**
|
|
902
|
+
* New value for property `facetVisibility`
|
|
903
|
+
*/
|
|
904
|
+
bFacetVisibility: boolean
|
|
905
|
+
): this;
|
|
906
|
+
/**
|
|
907
|
+
* @SINCE 1.112.0
|
|
908
|
+
*
|
|
909
|
+
* Sets a new value for property {@link #getFilterDataSources filterDataSources}.
|
|
910
|
+
*
|
|
911
|
+
* Callback for filtering the datasources displayed in the datasource dropdown listbox. The callback gets
|
|
912
|
+
* a list of datsources and returns the filtered list of datasources.
|
|
913
|
+
*
|
|
914
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
915
|
+
*
|
|
916
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
917
|
+
*/
|
|
918
|
+
setFilterDataSources(
|
|
919
|
+
/**
|
|
920
|
+
* New value for property `filterDataSources`
|
|
921
|
+
*/
|
|
922
|
+
fnFilterDataSources: Function
|
|
923
|
+
): this;
|
|
924
|
+
/**
|
|
925
|
+
* @SINCE 1.98.0
|
|
926
|
+
*
|
|
927
|
+
* Sets a new value for property {@link #getFilterRootCondition filterRootCondition}.
|
|
928
|
+
*
|
|
929
|
+
* Defines the filter root condition of a filter tree which shall be applied to the search request. This
|
|
930
|
+
* control only allows filter trees which have a the following structure: complex condition (root level)
|
|
931
|
+
* \ complex condition (attribute level) \ simple condition (attribute value level) Filter root conditions
|
|
932
|
+
* which do not follow this structure won't be accepted and an error will be thrown. Please see the below
|
|
933
|
+
* for a more in-depth example.
|
|
934
|
+
*
|
|
935
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
936
|
+
*
|
|
937
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
938
|
+
*/
|
|
939
|
+
setFilterRootCondition(
|
|
940
|
+
/**
|
|
941
|
+
* New value for property `filterRootCondition`
|
|
942
|
+
*/
|
|
943
|
+
oFilterRootCondition: object
|
|
944
|
+
): this;
|
|
945
|
+
/**
|
|
946
|
+
* @SINCE 1.106.0
|
|
947
|
+
*
|
|
948
|
+
* Sets a new value for property {@link #getFolderMode folderMode}.
|
|
949
|
+
*
|
|
950
|
+
* Activates the folder mode. Precondition for folder mode is 1) Search model: In the search model for the
|
|
951
|
+
* current datasource a hierarchy attribute (representing the folders) is defined 1.1) the hierarchy attribute
|
|
952
|
+
* is annotated with displayType=TREE and for the hierarchy there is a helper connector representing the
|
|
953
|
+
* hierarchy or 1.2) the current datasource is the helper datasource representing the folder hierarchy.
|
|
954
|
+
* The hierarchy attribute is annotated with displayType=FLAT 2) Search query: The folder mode is only active
|
|
955
|
+
* in case the search query has an empty search term and no filter conditions (except the hierarchy attribute)
|
|
956
|
+
* are set.
|
|
957
|
+
*
|
|
958
|
+
* In folder mode and in case a folder filter is set the result view only shows direct children of a folder.
|
|
959
|
+
* In contrast the counts in the facets are calculated by counting direct and not direct children. In case
|
|
960
|
+
* the folder mode is not active the UI uses the search mode: The result list shows direct and not direct
|
|
961
|
+
* children of a folder.
|
|
962
|
+
*
|
|
963
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
964
|
+
*/
|
|
965
|
+
setFolderMode(
|
|
966
|
+
/**
|
|
967
|
+
* New value for property `folderMode`
|
|
968
|
+
*/
|
|
969
|
+
bFolderMode?: boolean
|
|
970
|
+
): this;
|
|
971
|
+
/**
|
|
972
|
+
* @SINCE 1.94.0
|
|
973
|
+
*
|
|
974
|
+
* Sets a new value for property {@link #getGetCustomNoResultScreen getCustomNoResultScreen}.
|
|
975
|
+
*
|
|
976
|
+
* Whenever a search has no results, a 'No Results Page' is displayed. You can provide a custom page to
|
|
977
|
+
* be more specific and add some hints, links, buttons or other content.
|
|
978
|
+
*
|
|
979
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
980
|
+
*
|
|
981
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
982
|
+
*/
|
|
983
|
+
setGetCustomNoResultScreen(
|
|
984
|
+
/**
|
|
985
|
+
* New value for property `getCustomNoResultScreen`
|
|
986
|
+
*/
|
|
987
|
+
fnGetCustomNoResultScreen: Function
|
|
988
|
+
): this;
|
|
989
|
+
/**
|
|
990
|
+
* @SINCE 1.113.0
|
|
991
|
+
*
|
|
992
|
+
* Sets a new value for property {@link #getInitAsync initAsync}.
|
|
993
|
+
*
|
|
994
|
+
* A callback which is called after the initialization of the search composite control.
|
|
995
|
+
*
|
|
996
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
997
|
+
*
|
|
998
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
999
|
+
*/
|
|
1000
|
+
setInitAsync(
|
|
1001
|
+
/**
|
|
1002
|
+
* New value for property `initAsync`
|
|
1003
|
+
*/
|
|
1004
|
+
fnInitAsync: Function
|
|
1005
|
+
): this;
|
|
1006
|
+
/**
|
|
1007
|
+
* @SINCE 1.113.0
|
|
1008
|
+
*
|
|
1009
|
+
* Sets a new value for property {@link #getIsSearchUrl isSearchUrl}.
|
|
1010
|
+
*
|
|
1011
|
+
* A callback for checking whether a URL is a search URL. The callback receives a URL and returns true in
|
|
1012
|
+
* case the URL is a search URL. Typically you need to register this callback in case updateUrl=true.
|
|
1013
|
+
*
|
|
1014
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1015
|
+
*
|
|
1016
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1017
|
+
*/
|
|
1018
|
+
setIsSearchUrl(
|
|
1019
|
+
/**
|
|
1020
|
+
* New value for property `isSearchUrl`
|
|
1021
|
+
*/
|
|
1022
|
+
fnIsSearchUrl: Function
|
|
1023
|
+
): this;
|
|
1024
|
+
/**
|
|
1025
|
+
* @SINCE 1.111.0
|
|
1026
|
+
*
|
|
1027
|
+
* Sets a new value for property {@link #getOptimizeForValueHelp optimizeForValueHelp}.
|
|
1028
|
+
*
|
|
1029
|
+
* The layout is optimized for object selection / value help (narrow view w/o facet panel).
|
|
1030
|
+
*
|
|
1031
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1032
|
+
*
|
|
1033
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1034
|
+
*/
|
|
1035
|
+
setOptimizeForValueHelp(
|
|
1036
|
+
/**
|
|
1037
|
+
* New value for property `optimizeForValueHelp`
|
|
1038
|
+
*/
|
|
1039
|
+
bOptimizeForValueHelp: boolean
|
|
1040
|
+
): this;
|
|
1041
|
+
/**
|
|
1042
|
+
* @SINCE 1.93.0
|
|
1043
|
+
*
|
|
1044
|
+
* Sets a new value for property {@link #getOverwriteBrowserTitle overwriteBrowserTitle}.
|
|
1045
|
+
*
|
|
1046
|
+
* Shall the window title be overwritten by this control? If true, the control will set the current search
|
|
1047
|
+
* condition as window title. If false, it will not set or update the window title.
|
|
1048
|
+
*
|
|
1049
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1050
|
+
*
|
|
1051
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1052
|
+
*/
|
|
1053
|
+
setOverwriteBrowserTitle(
|
|
1054
|
+
/**
|
|
1055
|
+
* New value for property `overwriteBrowserTitle`
|
|
1056
|
+
*/
|
|
1057
|
+
bOverwriteBrowserTitle: boolean
|
|
1058
|
+
): this;
|
|
1059
|
+
/**
|
|
1060
|
+
* @SINCE 1.113.0
|
|
1061
|
+
*
|
|
1062
|
+
* Sets a new value for property {@link #getParseSearchUrlParameters parseSearchUrlParameters}.
|
|
1063
|
+
*
|
|
1064
|
+
* A callback for parsing URL parameters. The callback receices URL parameters and returns modified URL
|
|
1065
|
+
* parameters. This is an optional callback. Also in case you set updateUrl=true typcically this callback
|
|
1066
|
+
* is not needed.
|
|
1067
|
+
*
|
|
1068
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1069
|
+
*
|
|
1070
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1071
|
+
*/
|
|
1072
|
+
setParseSearchUrlParameters(
|
|
1073
|
+
/**
|
|
1074
|
+
* New value for property `parseSearchUrlParameters`
|
|
1075
|
+
*/
|
|
1076
|
+
fnParseSearchUrlParameters: Function
|
|
1077
|
+
): this;
|
|
1078
|
+
/**
|
|
1079
|
+
* @SINCE 1.113.0
|
|
1080
|
+
*
|
|
1081
|
+
* Sets a new value for property {@link #getQuickSelectDataSources quickSelectDataSources}.
|
|
1082
|
+
*
|
|
1083
|
+
* A list of datasources to be displayed in the facet panel in the collection area.
|
|
1084
|
+
*
|
|
1085
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1086
|
+
*
|
|
1087
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1088
|
+
*/
|
|
1089
|
+
setQuickSelectDataSources(
|
|
1090
|
+
/**
|
|
1091
|
+
* New value for property `quickSelectDataSources`
|
|
1092
|
+
*/
|
|
1093
|
+
oQuickSelectDataSources: object
|
|
1094
|
+
): this;
|
|
1095
|
+
/**
|
|
1096
|
+
* @SINCE 1.113.0
|
|
1097
|
+
*
|
|
1098
|
+
* Sets a new value for property {@link #getRenderSearchUrl renderSearchUrl}.
|
|
1099
|
+
*
|
|
1100
|
+
* A callback for rendering the search URL. The callback gets a list of url encoded parameters and returns
|
|
1101
|
+
* the URL string. Typically you need to register this callback in case updateUrl=true.
|
|
1102
|
+
*
|
|
1103
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1104
|
+
*
|
|
1105
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1106
|
+
*/
|
|
1107
|
+
setRenderSearchUrl(
|
|
1108
|
+
/**
|
|
1109
|
+
* New value for property `renderSearchUrl`
|
|
1110
|
+
*/
|
|
1111
|
+
fnRenderSearchUrl: Function
|
|
1112
|
+
): this;
|
|
1113
|
+
/**
|
|
1114
|
+
* @SINCE 1.100.0
|
|
1115
|
+
*
|
|
1116
|
+
* Sets a new value for property {@link #getResultViewSettings resultViewSettings}.
|
|
1117
|
+
*
|
|
1118
|
+
* Defines a pair of search result view settings. The value is an object of properties `resultViewTypes`
|
|
1119
|
+
* and `resultViewType`. An example: `{resultViewTypes: ["searchResultList", "searchResultTable"], resultViewType:
|
|
1120
|
+
* "searchResultList"}` Find more detail in the definition of each child property. The value can be set/get
|
|
1121
|
+
* in attached event "searchFinished". Function `setResultViewSettings` prevents incompatibility of sequential
|
|
1122
|
+
* execution of functions `setResultViewTypes` and `setResultViewType`. Note: The value of `resultViewTypes`
|
|
1123
|
+
* and `resultViewType` must be compatible to each other.
|
|
1124
|
+
*
|
|
1125
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1126
|
+
*
|
|
1127
|
+
* Default value is `...see text or source`.
|
|
1128
|
+
*
|
|
1129
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1130
|
+
*/
|
|
1131
|
+
setResultViewSettings(
|
|
1132
|
+
/**
|
|
1133
|
+
* New value for property `resultViewSettings`
|
|
1134
|
+
*/
|
|
1135
|
+
sResultViewSettings?: string
|
|
1136
|
+
): this;
|
|
1137
|
+
/**
|
|
1138
|
+
* @SINCE 1.98.0
|
|
1139
|
+
*
|
|
1140
|
+
* Sets a new value for property {@link #getResultViewType resultViewType}.
|
|
1141
|
+
*
|
|
1142
|
+
* Defines active search result view type. The value can be set/get in attach event "searchFinished", and
|
|
1143
|
+
* it must be contained in resultViewTypes. Case 1, Search in Apps: result is displayed in a mandatory view
|
|
1144
|
+
* type `"appSearchResult"`. Case 2.1, Search in All or other Category (configuration.isUshell !== true):
|
|
1145
|
+
* result is switchable between different view types. Possible value is `"searchResultList"`, or `"searchResultGrid"`.
|
|
1146
|
+
* Case 2.2, Search in All or other Category (configuration.isUshell === true): result is displayed in a
|
|
1147
|
+
* mandatory view type `"searchResultList"`. Case 3, Search in Business Object: result is switchable between
|
|
1148
|
+
* different view types. Possible value is `"searchResultList"`, `"searchResultTable"` or `"searchResultGrid"`.
|
|
1149
|
+
* Note: The value of `resultViewTypes` and `resultViewType` must be compatible to each other.
|
|
1150
|
+
*
|
|
1151
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1152
|
+
*
|
|
1153
|
+
* Default value is `"searchResultList"`.
|
|
1154
|
+
*
|
|
1155
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1156
|
+
*/
|
|
1157
|
+
setResultViewType(
|
|
1158
|
+
/**
|
|
1159
|
+
* New value for property `resultViewType`
|
|
1160
|
+
*/
|
|
1161
|
+
sResultViewType?: string
|
|
1162
|
+
): this;
|
|
1163
|
+
/**
|
|
1164
|
+
* @SINCE 1.98.0
|
|
1165
|
+
*
|
|
1166
|
+
* Sets a new value for property {@link #getResultViewTypes resultViewTypes}.
|
|
1167
|
+
*
|
|
1168
|
+
* Defines selectable search result view types. The value can be set/get in attach event "searchFinished".
|
|
1169
|
+
* Case 1: Search in Apps: result is displayed in a mandatory view type `["appSearchResult"]`, and it is
|
|
1170
|
+
* not switchable. Case 2: Search in All or other Category: result is switchable between different view
|
|
1171
|
+
* types. Possible values for the array items are `"searchResultList"` and `"searchResultGrid"`. Case 3,
|
|
1172
|
+
* Search in Business Object: result is switchable between different view types. Possible values for the
|
|
1173
|
+
* array items are `"searchResultList"`, `"searchResultTable"` and `"searchResultGrid"`. Note: The value
|
|
1174
|
+
* of `resultViewTypes` and `resultViewType` must be compatible to each other.
|
|
1175
|
+
*
|
|
1176
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1177
|
+
*
|
|
1178
|
+
* Default value is `["searchResultList", "searchResultTable"]`.
|
|
1179
|
+
*
|
|
1180
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1181
|
+
*/
|
|
1182
|
+
setResultViewTypes(
|
|
1183
|
+
/**
|
|
1184
|
+
* New value for property `resultViewTypes`
|
|
1185
|
+
*/
|
|
1186
|
+
sResultViewTypes?: string[]
|
|
1187
|
+
): this;
|
|
1188
|
+
/**
|
|
1189
|
+
* @SINCE 1.93.0
|
|
1190
|
+
*
|
|
1191
|
+
* Sets a new value for property {@link #getSearchOnStart searchOnStart}.
|
|
1192
|
+
*
|
|
1193
|
+
* Defines if the search composite control will send a search request after loading for the given term,
|
|
1194
|
+
* data source and filter root condition settings.
|
|
1195
|
+
*
|
|
1196
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1197
|
+
*
|
|
1198
|
+
* Default value is `true`.
|
|
1199
|
+
*
|
|
1200
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1201
|
+
*/
|
|
1202
|
+
setSearchOnStart(
|
|
1203
|
+
/**
|
|
1204
|
+
* New value for property `searchOnStart`
|
|
1205
|
+
*/
|
|
1206
|
+
bSearchOnStart?: boolean
|
|
1207
|
+
): this;
|
|
1208
|
+
/**
|
|
1209
|
+
* @SINCE 1.93.0
|
|
1210
|
+
*
|
|
1211
|
+
* Sets a new value for property {@link #getSearchTerm searchTerm}.
|
|
1212
|
+
*
|
|
1213
|
+
* Defines the initial search term for the search input.
|
|
1214
|
+
*
|
|
1215
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1216
|
+
*
|
|
1217
|
+
* Default value is `empty string`.
|
|
1218
|
+
*
|
|
1219
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1220
|
+
*/
|
|
1221
|
+
setSearchTerm(
|
|
1222
|
+
/**
|
|
1223
|
+
* New value for property `searchTerm`
|
|
1224
|
+
*/
|
|
1225
|
+
sSearchTerm?: string
|
|
1226
|
+
): this;
|
|
1227
|
+
/**
|
|
1228
|
+
* @SINCE 1.113.0
|
|
1229
|
+
*
|
|
1230
|
+
* Sets a new value for property {@link #getSelectionChange selectionChange}.
|
|
1231
|
+
*
|
|
1232
|
+
* A callback which is called whenever the selection of result list items changes.
|
|
1233
|
+
*
|
|
1234
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1235
|
+
*
|
|
1236
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1237
|
+
*/
|
|
1238
|
+
setSelectionChange(
|
|
1239
|
+
/**
|
|
1240
|
+
* New value for property `selectionChange`
|
|
1241
|
+
*/
|
|
1242
|
+
fnSelectionChange: Function
|
|
1243
|
+
): this;
|
|
1244
|
+
/**
|
|
1245
|
+
* @SINCE 1.93.0
|
|
1246
|
+
*
|
|
1247
|
+
* Sets a new value for property {@link #getSinaConfiguration sinaConfiguration}.
|
|
1248
|
+
*
|
|
1249
|
+
* Configuration for the Enterprise Search Client API.
|
|
1250
|
+
*
|
|
1251
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1252
|
+
*
|
|
1253
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1254
|
+
*/
|
|
1255
|
+
setSinaConfiguration(
|
|
1256
|
+
/**
|
|
1257
|
+
* New value for property `sinaConfiguration`
|
|
1258
|
+
*/
|
|
1259
|
+
oSinaConfiguration: object
|
|
1260
|
+
): this;
|
|
1261
|
+
/**
|
|
1262
|
+
* @SINCE 1.103.0
|
|
1263
|
+
*
|
|
1264
|
+
* Sets a new value for property {@link #getTabStripsFormatter tabStripsFormatter}.
|
|
1265
|
+
*
|
|
1266
|
+
* Function callback for formatting the datasource tabstrips in the top toolbar. To the callback function
|
|
1267
|
+
* a list of datasources is passed. The callback functions return a modified list of datasources to be displayed
|
|
1268
|
+
* in the tabstrips.
|
|
1269
|
+
*
|
|
1270
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1271
|
+
*
|
|
1272
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1273
|
+
*/
|
|
1274
|
+
setTabStripsFormatter(
|
|
1275
|
+
/**
|
|
1276
|
+
* New value for property `tabStripsFormatter`
|
|
1277
|
+
*/
|
|
1278
|
+
fnTabStripsFormatter: Function
|
|
1279
|
+
): this;
|
|
1280
|
+
/**
|
|
1281
|
+
* @SINCE 1.113.0
|
|
1282
|
+
*
|
|
1283
|
+
* Sets a new value for property {@link #getUpdateUrl updateUrl}.
|
|
1284
|
+
*
|
|
1285
|
+
* A boolean indicating that the search state is written to the URL.
|
|
1286
|
+
*
|
|
1287
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1288
|
+
*
|
|
1289
|
+
* Default value is `true`.
|
|
1290
|
+
*
|
|
1291
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1292
|
+
*/
|
|
1293
|
+
setUpdateUrl(
|
|
1294
|
+
/**
|
|
1295
|
+
* New value for property `updateUrl`
|
|
1296
|
+
*/
|
|
1297
|
+
bUpdateUrl?: boolean
|
|
1298
|
+
): this;
|
|
1299
|
+
}
|
|
1300
|
+
|
|
1301
|
+
export interface $SearchCompositeControlSettings extends $ControlSettings {
|
|
1302
|
+
/**
|
|
1303
|
+
* @SINCE 1.93.0
|
|
1304
|
+
*
|
|
1305
|
+
* An additional CSS class to add to this control
|
|
1306
|
+
*/
|
|
1307
|
+
cssClass?: string | PropertyBindingInfo;
|
|
1308
|
+
|
|
1309
|
+
/**
|
|
1310
|
+
* @SINCE 1.93.0
|
|
1311
|
+
*
|
|
1312
|
+
* Defines the initial search term for the search input.
|
|
1313
|
+
*/
|
|
1314
|
+
searchTerm?: string | PropertyBindingInfo;
|
|
1315
|
+
|
|
1316
|
+
/**
|
|
1317
|
+
* @SINCE 1.93.0
|
|
1318
|
+
*
|
|
1319
|
+
* Defines if the search composite control will send a search request after loading for the given term,
|
|
1320
|
+
* data source and filter root condition settings.
|
|
1321
|
+
*/
|
|
1322
|
+
searchOnStart?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
1323
|
+
|
|
1324
|
+
/**
|
|
1325
|
+
* @SINCE 1.98.0
|
|
1326
|
+
*
|
|
1327
|
+
* Defines the filter root condition of a filter tree which shall be applied to the search request. This
|
|
1328
|
+
* control only allows filter trees which have a the following structure: complex condition (root level)
|
|
1329
|
+
* \ complex condition (attribute level) \ simple condition (attribute value level) Filter root conditions
|
|
1330
|
+
* which do not follow this structure won't be accepted and an error will be thrown. Please see the below
|
|
1331
|
+
* for a more in-depth example.
|
|
1332
|
+
*/
|
|
1333
|
+
filterRootCondition?: object | PropertyBindingInfo | `{${string}}`;
|
|
1334
|
+
|
|
1335
|
+
/**
|
|
1336
|
+
* @SINCE 1.93.0
|
|
1337
|
+
*
|
|
1338
|
+
* Configuration for the Enterprise Search Client API.
|
|
1339
|
+
*/
|
|
1340
|
+
sinaConfiguration?: object | PropertyBindingInfo | `{${string}}`;
|
|
1341
|
+
|
|
1342
|
+
/**
|
|
1343
|
+
* @SINCE 1.98.0
|
|
1344
|
+
*
|
|
1345
|
+
* The id of the data source in which it will search right after initialization.
|
|
1346
|
+
*/
|
|
1347
|
+
dataSource?: string | PropertyBindingInfo;
|
|
1348
|
+
|
|
1349
|
+
/**
|
|
1350
|
+
* @SINCE 1.98.0
|
|
1351
|
+
*
|
|
1352
|
+
* Defines selectable search result view types. The value can be set/get in attach event "searchFinished".
|
|
1353
|
+
* Case 1: Search in Apps: result is displayed in a mandatory view type `["appSearchResult"]`, and it is
|
|
1354
|
+
* not switchable. Case 2: Search in All or other Category: result is switchable between different view
|
|
1355
|
+
* types. Possible values for the array items are `"searchResultList"` and `"searchResultGrid"`. Case 3,
|
|
1356
|
+
* Search in Business Object: result is switchable between different view types. Possible values for the
|
|
1357
|
+
* array items are `"searchResultList"`, `"searchResultTable"` and `"searchResultGrid"`. Note: The value
|
|
1358
|
+
* of `resultViewTypes` and `resultViewType` must be compatible to each other.
|
|
1359
|
+
*/
|
|
1360
|
+
resultViewTypes?: string[] | PropertyBindingInfo | `{${string}}`;
|
|
1361
|
+
|
|
1362
|
+
/**
|
|
1363
|
+
* @SINCE 1.98.0
|
|
1364
|
+
*
|
|
1365
|
+
* Defines active search result view type. The value can be set/get in attach event "searchFinished", and
|
|
1366
|
+
* it must be contained in resultViewTypes. Case 1, Search in Apps: result is displayed in a mandatory view
|
|
1367
|
+
* type `"appSearchResult"`. Case 2.1, Search in All or other Category (configuration.isUshell !== true):
|
|
1368
|
+
* result is switchable between different view types. Possible value is `"searchResultList"`, or `"searchResultGrid"`.
|
|
1369
|
+
* Case 2.2, Search in All or other Category (configuration.isUshell === true): result is displayed in a
|
|
1370
|
+
* mandatory view type `"searchResultList"`. Case 3, Search in Business Object: result is switchable between
|
|
1371
|
+
* different view types. Possible value is `"searchResultList"`, `"searchResultTable"` or `"searchResultGrid"`.
|
|
1372
|
+
* Note: The value of `resultViewTypes` and `resultViewType` must be compatible to each other.
|
|
1373
|
+
*/
|
|
1374
|
+
resultViewType?: string | PropertyBindingInfo;
|
|
1375
|
+
|
|
1376
|
+
/**
|
|
1377
|
+
* @SINCE 1.100.0
|
|
1378
|
+
*
|
|
1379
|
+
* Defines a pair of search result view settings. The value is an object of properties `resultViewTypes`
|
|
1380
|
+
* and `resultViewType`. An example: `{resultViewTypes: ["searchResultList", "searchResultTable"], resultViewType:
|
|
1381
|
+
* "searchResultList"}` Find more detail in the definition of each child property. The value can be set/get
|
|
1382
|
+
* in attached event "searchFinished". Function `setResultViewSettings` prevents incompatibility of sequential
|
|
1383
|
+
* execution of functions `setResultViewTypes` and `setResultViewType`. Note: The value of `resultViewTypes`
|
|
1384
|
+
* and `resultViewType` must be compatible to each other.
|
|
1385
|
+
*/
|
|
1386
|
+
resultViewSettings?: string | PropertyBindingInfo;
|
|
1387
|
+
|
|
1388
|
+
/**
|
|
1389
|
+
* @SINCE 1.103.0
|
|
1390
|
+
*
|
|
1391
|
+
* Function callback for formatting the datasource tabstrips in the top toolbar. To the callback function
|
|
1392
|
+
* a list of datasources is passed. The callback functions return a modified list of datasources to be displayed
|
|
1393
|
+
* in the tabstrips.
|
|
1394
|
+
*/
|
|
1395
|
+
tabStripsFormatter?: Function | PropertyBindingInfo | `{${string}}`;
|
|
1396
|
+
|
|
1397
|
+
/**
|
|
1398
|
+
* Activates the folder mode. Precondition for folder mode is 1) Search model: In the search model for the
|
|
1399
|
+
* current datasource a hierarchy attribute (representing the folders) is defined 1.1) the hierarchy attribute
|
|
1400
|
+
* is annotated with displayType=TREE and for the hierarchy there is a helper connector representing the
|
|
1401
|
+
* hierarchy or 1.2) the current datasource is the helper datasource representing the folder hierarchy.
|
|
1402
|
+
* The hierarchy attribute is annotated with displayType=FLAT 2) Search query: The folder mode is only active
|
|
1403
|
+
* in case the search query has an empty search term and no filter conditions (except the hierarchy attribute)
|
|
1404
|
+
* are set.
|
|
1405
|
+
*
|
|
1406
|
+
* In folder mode and in case a folder filter is set the result view only shows direct children of a folder.
|
|
1407
|
+
* In contrast the counts in the facets are calculated by counting direct and not direct children. In case
|
|
1408
|
+
* the folder mode is not active the UI uses the search mode: The result list shows direct and not direct
|
|
1409
|
+
* children of a folder. * @since 1.106.0
|
|
1410
|
+
*/
|
|
1411
|
+
folderMode?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
1412
|
+
|
|
1413
|
+
/**
|
|
1414
|
+
* @SINCE 1.106.0
|
|
1415
|
+
*
|
|
1416
|
+
* In case folder mode is active: Automatically switch result view type to list in search mode and to table
|
|
1417
|
+
* in folder mode.
|
|
1418
|
+
*/
|
|
1419
|
+
autoAdjustResultViewTypeInFolderMode?:
|
|
1420
|
+
| boolean
|
|
1421
|
+
| PropertyBindingInfo
|
|
1422
|
+
| `{${string}}`;
|
|
1423
|
+
|
|
1424
|
+
/**
|
|
1425
|
+
* @SINCE 1.107.0
|
|
1426
|
+
*
|
|
1427
|
+
* Enables the query language for the hana_odata provider. With query language it is possible for the end
|
|
1428
|
+
* user to enter complex search queries with logical operators.
|
|
1429
|
+
*/
|
|
1430
|
+
enableQueryLanguage?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
1431
|
+
|
|
1432
|
+
/**
|
|
1433
|
+
* @SINCE 1.108.0
|
|
1434
|
+
*
|
|
1435
|
+
* Relevant for SAP partners and SAP, the "Application Component" you expect customers to create incidents.
|
|
1436
|
+
*/
|
|
1437
|
+
applicationComponent?: string | PropertyBindingInfo;
|
|
1438
|
+
|
|
1439
|
+
/**
|
|
1440
|
+
* @SINCE 1.108.0
|
|
1441
|
+
*
|
|
1442
|
+
* Display a splitter bar to resize the left hand panel, containing all facets and filter criteria.
|
|
1443
|
+
*/
|
|
1444
|
+
facetPanelResizable?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
1445
|
+
|
|
1446
|
+
/**
|
|
1447
|
+
* @SINCE 1.108.0
|
|
1448
|
+
*
|
|
1449
|
+
* Default size (percent) of the left hand panel, containing all facets and filter criteria. If "facetPanelResizable"
|
|
1450
|
+
* is true, the width of the facet panel can be changed by the user.
|
|
1451
|
+
*/
|
|
1452
|
+
facetPanelWidthInPercent?: float | PropertyBindingInfo | `{${string}}`;
|
|
1453
|
+
|
|
1454
|
+
/**
|
|
1455
|
+
* @SINCE 1.94.0
|
|
1456
|
+
*
|
|
1457
|
+
* Whenever a search has no results, a 'No Results Page' is displayed. You can provide a custom page to
|
|
1458
|
+
* be more specific and add some hints, links, buttons or other content.
|
|
1459
|
+
*/
|
|
1460
|
+
getCustomNoResultScreen?: Function | PropertyBindingInfo | `{${string}}`;
|
|
1461
|
+
|
|
1462
|
+
/**
|
|
1463
|
+
* @SINCE 1.93.0
|
|
1464
|
+
*
|
|
1465
|
+
* Shall the window title be overwritten by this control? If true, the control will set the current search
|
|
1466
|
+
* condition as window title. If false, it will not set or update the window title.
|
|
1467
|
+
*/
|
|
1468
|
+
overwriteBrowserTitle?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
1469
|
+
|
|
1470
|
+
/**
|
|
1471
|
+
* @SINCE 1.93.0
|
|
1472
|
+
*
|
|
1473
|
+
* Data source id which is set when the UI is loaded or filter is reset. If dataSource is also set, dataSource
|
|
1474
|
+
* will be used during UI load and this parameter will used only after filter is reset.
|
|
1475
|
+
*/
|
|
1476
|
+
defaultDataSource?: string | PropertyBindingInfo;
|
|
1477
|
+
|
|
1478
|
+
/**
|
|
1479
|
+
* @SINCE 1.111.0
|
|
1480
|
+
*
|
|
1481
|
+
* The layout is optimized for object selection / value help (narrow view w/o facet panel).
|
|
1482
|
+
*/
|
|
1483
|
+
optimizeForValueHelp?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
1484
|
+
|
|
1485
|
+
/**
|
|
1486
|
+
* @SINCE 1.112.0
|
|
1487
|
+
*
|
|
1488
|
+
* Callback for filtering the datasources displayed in the datasource dropdown listbox. The callback gets
|
|
1489
|
+
* a list of datsources and returns the filtered list of datasources.
|
|
1490
|
+
*/
|
|
1491
|
+
filterDataSources?: Function | PropertyBindingInfo | `{${string}}`;
|
|
1492
|
+
|
|
1493
|
+
/**
|
|
1494
|
+
* @SINCE 1.113.0
|
|
1495
|
+
*
|
|
1496
|
+
* A boolean which indicates whether the facet panel is initially openend or closed. This affects only the
|
|
1497
|
+
* initial state of the facet panel. When not setting facetVisibility the initial state of the facet panel
|
|
1498
|
+
* typically is taken from the user personalization storage.
|
|
1499
|
+
*/
|
|
1500
|
+
facetVisibility?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
1501
|
+
|
|
1502
|
+
/**
|
|
1503
|
+
* @SINCE 1.113.0
|
|
1504
|
+
*
|
|
1505
|
+
* A boolean for enabling (business) object suggestions.
|
|
1506
|
+
*/
|
|
1507
|
+
boSuggestions?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
1508
|
+
|
|
1509
|
+
/**
|
|
1510
|
+
* @SINCE 1.113.0
|
|
1511
|
+
*
|
|
1512
|
+
* When set to true the facet panel is displayed also in case there are no search results.
|
|
1513
|
+
*/
|
|
1514
|
+
displayFacetPanelInCaseOfNoResults?:
|
|
1515
|
+
| boolean
|
|
1516
|
+
| PropertyBindingInfo
|
|
1517
|
+
| `{${string}}`;
|
|
1518
|
+
|
|
1519
|
+
/**
|
|
1520
|
+
* @SINCE 1.113.0
|
|
1521
|
+
*
|
|
1522
|
+
* A boolean indicating that the search state is written to the URL.
|
|
1523
|
+
*/
|
|
1524
|
+
updateUrl?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
1525
|
+
|
|
1526
|
+
/**
|
|
1527
|
+
* @SINCE 1.113.0
|
|
1528
|
+
*
|
|
1529
|
+
* A callback for rendering the search URL. The callback gets a list of url encoded parameters and returns
|
|
1530
|
+
* the URL string. Typically you need to register this callback in case updateUrl=true.
|
|
1531
|
+
*/
|
|
1532
|
+
renderSearchUrl?: Function | PropertyBindingInfo | `{${string}}`;
|
|
1533
|
+
|
|
1534
|
+
/**
|
|
1535
|
+
* @SINCE 1.113.0
|
|
1536
|
+
*
|
|
1537
|
+
* A callback for checking whether a URL is a search URL. The callback receives a URL and returns true in
|
|
1538
|
+
* case the URL is a search URL. Typically you need to register this callback in case updateUrl=true.
|
|
1539
|
+
*/
|
|
1540
|
+
isSearchUrl?: Function | PropertyBindingInfo | `{${string}}`;
|
|
1541
|
+
|
|
1542
|
+
/**
|
|
1543
|
+
* @SINCE 1.113.0
|
|
1544
|
+
*
|
|
1545
|
+
* A callback for parsing URL parameters. The callback receices URL parameters and returns modified URL
|
|
1546
|
+
* parameters. This is an optional callback. Also in case you set updateUrl=true typcically this callback
|
|
1547
|
+
* is not needed.
|
|
1548
|
+
*/
|
|
1549
|
+
parseSearchUrlParameters?: Function | PropertyBindingInfo | `{${string}}`;
|
|
1550
|
+
|
|
1551
|
+
/**
|
|
1552
|
+
* @SINCE 1.113.0
|
|
1553
|
+
*
|
|
1554
|
+
* A list of datasources to be displayed in the facet panel in the collection area.
|
|
1555
|
+
*/
|
|
1556
|
+
quickSelectDataSources?: object | PropertyBindingInfo | `{${string}}`;
|
|
1557
|
+
|
|
1558
|
+
/**
|
|
1559
|
+
* @SINCE 1.113.0
|
|
1560
|
+
*
|
|
1561
|
+
* A callback which is called whenever the selection of result list items changes.
|
|
1562
|
+
*/
|
|
1563
|
+
selectionChange?: Function | PropertyBindingInfo | `{${string}}`;
|
|
1564
|
+
|
|
1565
|
+
/**
|
|
1566
|
+
* @SINCE 1.113.0
|
|
1567
|
+
*
|
|
1568
|
+
* A callback which is called after the initialization of the search composite control.
|
|
1569
|
+
*/
|
|
1570
|
+
initAsync?: Function | PropertyBindingInfo | `{${string}}`;
|
|
1571
|
+
|
|
1572
|
+
/**
|
|
1573
|
+
* Control instances which are part of this composite control.
|
|
1574
|
+
*/
|
|
1575
|
+
content?: Control[] | Control | AggregationBindingInfo | `{${string}}`;
|
|
1576
|
+
|
|
1577
|
+
/**
|
|
1578
|
+
* Event is fired when search is started.
|
|
1579
|
+
*/
|
|
1580
|
+
searchStarted?: (oEvent: Event) => void;
|
|
1581
|
+
|
|
1582
|
+
/**
|
|
1583
|
+
* Event is fired when search is finished.
|
|
1584
|
+
*/
|
|
1585
|
+
searchFinished?: (oEvent: Event) => void;
|
|
1586
|
+
}
|
|
1587
|
+
}
|
|
1588
|
+
|
|
1589
|
+
declare namespace sap {
|
|
1590
|
+
interface IUI5DefineDependencyNames {
|
|
1591
|
+
"sap/esh/search/ui/library": undefined;
|
|
1592
|
+
|
|
1593
|
+
"sap/esh/search/ui/SearchCompositeControl": undefined;
|
|
1594
|
+
}
|
|
1595
|
+
}
|