YAHOO.widget.DS_JSFunction.html
16.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<title>API: autocomplete YAHOO.widget.DS_JSFunction (YUI Library)</title>
<link rel="stylesheet" type="text/css" href="assets/api.css">
<script type="text/javascript" src="assets/api-js"></script>
<script type="text/javascript" src="assets/ac-js"></script>
</head>
<body id="yahoo-com">
<div id="doc3" class="yui-t2">
<div id="hd">
<a href="http://developer.yahoo.com/yui/"><h1>Yahoo! UI Library</h1></a>
<h3>AutoComplete Widget <span class="subtitle">2.3.1</span></h3>
<p>
<a href="./index.html">Yahoo! UI Library</a>
> <a href="./module_autocomplete.html">autocomplete</a>
> YAHOO.widget.DS_JSFunction
</p>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<form name="yui-classopts-form">
<span id="classopts"><input type="checkbox" name="showprivate" id="showprivate" /> Show Private</span>
<span id="classopts"><input type="checkbox" name="showprotected" id="showprotected" /> Show Protected</span>
</form>
<h2>
Class <b>YAHOO.widget.DS_JSFunction</b>
<span class="extends">
- extends <a href="YAHOO.widget.DataSource.html">YAHOO.widget.DataSource</a>
</span>
<span class="extends">
</span>
</code>
</h2>
<!-- class tree goes here -->
<div class="summary description">
Implementation of YAHOO.widget.DataSource using a native Javascript function as
its live data source.
</div>
<div class="section constructor details">
<h3 id="constructor">Constructor</h3>
<div class="content">
<div class="detail">
<strong>YAHOO.widget.DS_JSFunction</strong>
<code>
(
oFunction
,
oConfigs
)
</code>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oFunction
<HTMLFunction>
</code>
In-memory Javascript function that returns query results as an array of objects.
</dd>
<dd>
<code>oConfigs
<Object>
</code>
(optional) Object literal of config params.
</dd>
</dl>
</div>
</div>
</div>
</div>
<div class="section field details">
<h3 id="properties">Properties</h3>
<div class="content">
<div class="">
<h4><a name="dataFunction">dataFunction</a>
<code>- HTMLFunction</code>
</h4>
<div class="detail">
<div class="description">
In-memory Javascript function that returns query results.
</div>
</div>
<hr />
</div>
</div>
</div>
<div class="section field inheritance">
<h4>Properties inherited from <a href="YAHOO.widget.DataSource.html">YAHOO.widget.DataSource</a>:</h4>
<div class="content">
<code>
<a class="private" href="YAHOO.widget.DataSource.html#_aCache">_aCache</a><span class="private">,</span>
<a class="private" href="YAHOO.widget.DataSource.html#_sName">_sName</a><span class="private">,</span>
<a class="" href="YAHOO.widget.DataSource.html#maxCacheEntries">maxCacheEntries</a><span class="">,</span>
<a class="" href="YAHOO.widget.DataSource.html#queryMatchCase">queryMatchCase</a><span class="">,</span>
<a class="" href="YAHOO.widget.DataSource.html#queryMatchContains">queryMatchContains</a><span class="">,</span>
<a class="" href="YAHOO.widget.DataSource.html#queryMatchSubset">queryMatchSubset</a>
</code>
</div>
</div>
<div class="section method details">
<h3 id="methods">Methods</h3>
<div class="content">
<div class="">
<h4>
<a name="doQuery">doQuery</a></h4>
<div class="detail">
<code>
void
<strong>doQuery</strong>
(
oCallbackFn
,
sQuery
,
oParent
)
</code>
<div class="description">
Queries the live data source defined by function for results. Results are
passed back to a callback function.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oCallbackFn <HTMLFunction></code>
Callback function defined by oParent object to which to return results.
</dd>
<dd>
<code>sQuery <String></code>
Query string.
</dd>
<dd>
<code>oParent <Object></code>
The object instance that has requested data.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
</div>
</div>
<div class="section field inheritance">
<h4>Methods inherited from <a href="YAHOO.widget.DataSource.html">YAHOO.widget.DataSource</a>:</h4>
<div class="content">
<code>
<a class="private" href="YAHOO.widget.DataSource.html#_addCacheElem">_addCacheElem</a><span class="private">,</span> <a class="private" href="YAHOO.widget.DataSource.html#_doQueryCache">_doQueryCache</a><span class="private">,</span> <a class="private" href="YAHOO.widget.DataSource.html#_init">_init</a><span class="private">,</span> <a class="" href="YAHOO.widget.DataSource.html#doQuery">doQuery</a><span class="">,</span> <a class="" href="YAHOO.widget.DataSource.html#flushCache">flushCache</a><span class="">,</span> <a class="" href="YAHOO.widget.DataSource.html#getResults">getResults</a><span class="">,</span> <a class="" href="YAHOO.widget.DataSource.html#toString">toString</a>
</code>
</div>
</div>
<div class="section field inheritance">
<h4>Events inherited from <a href="YAHOO.widget.DataSource.html">YAHOO.widget.DataSource</a>:</h4>
<div class="content">
<code>
<a class="" href="YAHOO.widget.DataSource.html#cacheFlushEvent">cacheFlushEvent</a><span class="">,</span> <a class="" href="YAHOO.widget.DataSource.html#cacheQueryEvent">cacheQueryEvent</a><span class="">,</span> <a class="" href="YAHOO.widget.DataSource.html#dataErrorEvent">dataErrorEvent</a><span class="">,</span> <a class="" href="YAHOO.widget.DataSource.html#getCachedResultsEvent">getCachedResultsEvent</a> <a class="" href="YAHOO.widget.DataSource.html#getResultsEvent">getResultsEvent</a> <a class="" href="YAHOO.widget.DataSource.html#queryEvent">queryEvent</a>
</code>
</div>
</div>
</div>
</div>
<div class="yui-b">
<div class="nav">
<div class="module">
<h4>Modules</h4>
<ul class="content">
<li class=""><a href="module_animation.html">animation</a></li>
<li class="selected"><a href="module_autocomplete.html">autocomplete</a></li>
<li class=""><a href="module_button.html">button</a></li>
<li class=""><a href="module_calendar.html">calendar</a></li>
<li class=""><a href="module_colorpicker.html">colorpicker</a></li>
<li class=""><a href="module_connection.html">connection</a></li>
<li class=""><a href="module_container.html">container</a></li>
<li class=""><a href="module_datasource.html">datasource</a></li>
<li class=""><a href="module_datatable.html">datatable</a></li>
<li class=""><a href="module_dom.html">dom</a></li>
<li class=""><a href="module_dragdrop.html">dragdrop</a></li>
<li class=""><a href="module_editor.html">editor</a></li>
<li class=""><a href="module_element.html">element</a></li>
<li class=""><a href="module_event.html">event</a></li>
<li class=""><a href="module_history.html">history</a></li>
<li class=""><a href="module_imageloader.html">imageloader</a></li>
<li class=""><a href="module_logger.html">logger</a></li>
<li class=""><a href="module_menu.html">menu</a></li>
<li class=""><a href="module_slider.html">slider</a></li>
<li class=""><a href="module_tabview.html">tabview</a></li>
<li class=""><a href="module_treeview.html">treeview</a></li>
<li class=""><a href="module_yahoo.html">yahoo</a></li>
<li class=""><a href="module_yuiloader.html">yuiloader</a></li>
<li class=""><a href="module_yuitest.html">yuitest</a></li>
</ul>
</div>
<div class="module">
<h4>Classes</h4>
<ul class="content">
<li class=""><a href="YAHOO.widget.AutoComplete.html">YAHOO.widget.AutoComplete</a></li>
<li class=""><a href="YAHOO.widget.DataSource.html">YAHOO.widget.DataSource</a></li>
<li class=""><a href="YAHOO.widget.DS_JSArray.html">YAHOO.widget.DS_JSArray</a></li>
<li class="selected"><a href="YAHOO.widget.DS_JSFunction.html">YAHOO.widget.DS_JSFunction</a></li>
<li class=""><a href="YAHOO.widget.DS_XHR.html">YAHOO.widget.DS_XHR</a></li>
</ul>
</div>
<div class="module">
<h4>Files</h4>
<ul class="content">
<li class=""><a href="AutoComplete.js.html">AutoComplete.js</a></li>
<li class=""><a href="DataSource.js.html">DataSource.js</a></li>
</ul>
</div>
<div class="module">
<h4>Properties</h4>
<ul class="content">
<li class=""><a href="#dataFunction">dataFunction</a>
<!--<code><HTMLFunction></code>-->
</li>
</ul>
</div>
<div class="module">
<h4>Methods</h4>
<ul class="content">
<li class=""><!--<code>void</code>-->
<a href="#doQuery">doQuery</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div id="ft">
<hr />
Copyright © 2007 Yahoo! Inc. All rights reserved.
</div>
</div>
</body>
</html>