forked from cocoo/easyui-bootstrap
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcombobox.html
330 lines (310 loc) · 16.4 KB
/
combobox.html
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
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>combobox</title>
<link rel="stylesheet" type="text/css" href="css/main.css" />
<link rel="stylesheet" type="text/css" href="css/SyntaxHighlighter.css" />
<script type="text/javascript" src="js/shCore.js"></script>
<script type="text/javascript" src="js/shBrushJScript.js"></script>
<script type="text/javascript" src="js/shBrushXml.js"></script>
</head>
<body style="text-align:left">
<div style="padding:10px">
<h3>ComboBox</h3>
<p>Extend from $.fn.combo.defaults. Override defaults with $.fn.combobox.defaults.</p>
<p>
The combobox display a editable text box and drop-down list, from which the user can select one or multiple values.
The user can type text directly into the top of list, or select one or more of present values from the list.
</p>
<img src="images/combobox.png">
<h4>Dependencies</h4>
<ul>
<li>combo</li>
</ul>
<h4>Usage Example</h4>
<p>Create combobox from <select> element with a pre-defined structure.</p>
<div class="dp-highlighter"><div class="bar"><div class="tools"></div></div><ol start="1" class="dp-xml"><li class="alt"><span><span class="tag"><</span><span class="tag-name">select</span><span> </span><span class="attribute">id</span><span>=</span><span class="attribute-value">"cc"</span><span> </span><span class="attribute">class</span><span>=</span><span class="attribute-value">"easyui-combobox"</span><span> </span><span class="attribute">name</span><span>=</span><span class="attribute-value">"dept"</span><span> </span><span class="attribute">style</span><span>=</span><span class="attribute-value">"width:200px;"</span><span class="tag">></span><span> </span></span></li><li class=""><span> <span class="tag"><</span><span class="tag-name">option</span><span> </span><span class="attribute">value</span><span>=</span><span class="attribute-value">"aa"</span><span class="tag">></span><span>aitem1</span><span class="tag"></</span><span class="tag-name">option</span><span class="tag">></span><span> </span></span></li><li class="alt"><span> <span class="tag"><</span><span class="tag-name">option</span><span class="tag">></span><span>bitem2</span><span class="tag"></</span><span class="tag-name">option</span><span class="tag">></span><span> </span></span></li><li class=""><span> <span class="tag"><</span><span class="tag-name">option</span><span class="tag">></span><span>bitem3</span><span class="tag"></</span><span class="tag-name">option</span><span class="tag">></span><span> </span></span></li><li class="alt"><span> <span class="tag"><</span><span class="tag-name">option</span><span class="tag">></span><span>ditem4</span><span class="tag"></</span><span class="tag-name">option</span><span class="tag">></span><span> </span></span></li><li class=""><span> <span class="tag"><</span><span class="tag-name">option</span><span class="tag">></span><span>eitem5</span><span class="tag"></</span><span class="tag-name">option</span><span class="tag">></span><span> </span></span></li><li class="alt"><span><span class="tag"></</span><span class="tag-name">select</span><span class="tag">></span><span> </span></span></li></ol></div><textarea class="html" name="code-combobox" style="display: none;"> <select id="cc" class="easyui-combobox" name="dept" style="width:200px;">
<option value="aa">aitem1</option>
<option>bitem2</option>
<option>bitem3</option>
<option>ditem4</option>
<option>eitem5</option>
</select>
</textarea>
<p>Create combobox from <input> markup.</p>
<div class="dp-highlighter"><div class="bar"><div class="tools"></div></div><ol start="1" class="dp-xml"><li class="alt"><span><span class="tag"><</span><span class="tag-name">input</span><span> </span><span class="attribute">id</span><span>=</span><span class="attribute-value">"cc"</span><span> </span><span class="attribute">class</span><span>=</span><span class="attribute-value">"easyui-combobox"</span><span> </span><span class="attribute">name</span><span>=</span><span class="attribute-value">"dept"</span><span> </span></span></li><li class=""><span> <span class="attribute">data-options</span><span>=</span><span class="attribute-value">"valueField:'id',textField:'text',url:'get_data.php'"</span><span> </span><span class="tag">/></span><span> </span></span></li></ol></div><textarea class="html" name="code-combobox" style="display: none;"> <input id="cc" class="easyui-combobox" name="dept"
data-options="valueField:'id',textField:'text',url:'get_data.php'" />
</textarea>
<p>Create combobox using javascript.</p>
<div class="dp-highlighter"><div class="bar"><div class="tools"></div></div><ol start="1" class="dp-xml"><li class="alt"><span><span class="tag"><</span><span class="tag-name">input</span><span> </span><span class="attribute">id</span><span>=</span><span class="attribute-value">"cc"</span><span> </span><span class="attribute">name</span><span>=</span><span class="attribute-value">"dept"</span><span> </span><span class="attribute">value</span><span>=</span><span class="attribute-value">"aa"</span><span class="tag">></span><span> </span></span></li></ol></div><textarea class="html" name="code-combobox" style="display: none;"> <input id="cc" name="dept" value="aa">
</textarea>
<div class="dp-highlighter"><div class="bar"><div class="tools"></div></div><ol start="1" class="dp-c"><li class="alt"><span><span>$(</span><span class="string">'#cc'</span><span>).combobox({ </span></span></li><li class=""><span> url:<span class="string">'combobox_data.json'</span><span>, </span></span></li><li class="alt"><span> valueField:<span class="string">'id'</span><span>, </span></span></li><li class=""><span> textField:<span class="string">'text'</span><span> </span></span></li><li class="alt"><span>}); </span></li></ol></div><textarea class="js" name="code-combobox" style="display: none;"> $('#cc').combobox({
url:'combobox_data.json',
valueField:'id',
textField:'text'
});
</textarea>
<p>Create two dependent comboboxes.</p>
<div class="dp-highlighter"><div class="bar"><div class="tools"></div></div><ol start="1" class="dp-xml"><li class="alt"><span><span class="tag"><</span><span class="tag-name">input</span><span> </span><span class="attribute">id</span><span>=</span><span class="attribute-value">"cc1"</span><span> </span><span class="attribute">class</span><span>=</span><span class="attribute-value">"easyui-combobox"</span><span> </span><span class="attribute">data-options</span><span>=" </span></span></li><li class=""><span> valueField: 'id', </span></li><li class="alt"><span> textField: 'text', </span></li><li class=""><span> url: 'get_data1.php', </span></li><li class="alt"><span> onSelect: function(rec){ </span></li><li class=""><span> var <span class="attribute">url</span><span> = </span><span class="attribute-value">'get_data2.php?id='</span><span>+rec.id; </span></span></li><li class="alt"><span> $('#cc2').combobox('reload', url); </span></li><li class=""><span> }" <span class="tag">/></span><span> </span></span></li><li class="alt"><span><span class="tag"><</span><span class="tag-name">input</span><span> </span><span class="attribute">id</span><span>=</span><span class="attribute-value">"cc2"</span><span> </span><span class="attribute">class</span><span>=</span><span class="attribute-value">"easyui-combobox"</span><span> </span><span class="attribute">data-options</span><span>=</span><span class="attribute-value">"valueField:'id',textField:'text'"</span><span> </span><span class="tag">/></span><span> </span></span></li></ol></div><textarea class="html" name="code-combobox" style="display: none;"> <input id="cc1" class="easyui-combobox" data-options="
valueField: 'id',
textField: 'text',
url: 'get_data1.php',
onSelect: function(rec){
var url = 'get_data2.php?id='+rec.id;
$('#cc2').combobox('reload', url);
}" />
<input id="cc2" class="easyui-combobox" data-options="valueField:'id',textField:'text'" />
</textarea>
<p>The json data format sample:</p>
<div class="dp-highlighter"><div class="bar"><div class="tools"></div></div><ol start="1" class="dp-c"><li class="alt"><span><span>[{ </span></span></li><li class=""><span> <span class="string">"id"</span><span>:1, </span></span></li><li class="alt"><span> <span class="string">"text"</span><span>:</span><span class="string">"text1"</span><span> </span></span></li><li class=""><span>},{ </span></li><li class="alt"><span> <span class="string">"id"</span><span>:2, </span></span></li><li class=""><span> <span class="string">"text"</span><span>:</span><span class="string">"text2"</span><span> </span></span></li><li class="alt"><span>},{ </span></li><li class=""><span> <span class="string">"id"</span><span>:3, </span></span></li><li class="alt"><span> <span class="string">"text"</span><span>:</span><span class="string">"text3"</span><span>, </span></span></li><li class=""><span> <span class="string">"selected"</span><span>:</span><span class="keyword">true</span><span> </span></span></li><li class="alt"><span>},{ </span></li><li class=""><span> <span class="string">"id"</span><span>:4, </span></span></li><li class="alt"><span> <span class="string">"text"</span><span>:</span><span class="string">"text4"</span><span> </span></span></li><li class=""><span>},{ </span></li><li class="alt"><span> <span class="string">"id"</span><span>:5, </span></span></li><li class=""><span> <span class="string">"text"</span><span>:</span><span class="string">"text5"</span><span> </span></span></li><li class="alt"><span>}] </span></li></ol></div><textarea class="js" name="code-combobox" style="display: none;"> [{
"id":1,
"text":"text1"
},{
"id":2,
"text":"text2"
},{
"id":3,
"text":"text3",
"selected":true
},{
"id":4,
"text":"text4"
},{
"id":5,
"text":"text5"
}]
</textarea>
<br>
<h4>Properties</h4>
<p>The properties extend from combo, below is the added properties for combobox.</p>
<table class="doc-table">
<tbody><tr>
<th><strong>Name</strong></th>
<th><strong>Type</strong></th>
<th><strong>Description</strong></th>
<th><strong>Default</strong></th>
</tr>
<tr>
<td>valueField</td>
<td>string</td>
<td>The underlying data value name to bind to this ComboBox.</td>
<td>value</td>
</tr>
<tr>
<td>textField</td>
<td>string</td>
<td>The underlying data field name to bind to this ComboBox.</td>
<td>text</td>
</tr>
<tr>
<td>mode</td>
<td>string</td>
<td>
Defines how to load list data when text changed.
Set to 'remote' if the combobox loads from server.
When set to 'remote' mode, what the user types will be sent as the http request parameter named 'q' to server to retrieve the new data.
</td>
<td>local</td>
</tr>
<tr>
<td>url</td>
<td>string</td>
<td>A URL to load list data from remote.</td>
<td>null</td>
</tr>
<tr>
<td>method</td>
<td>string</td>
<td>The http method to retrieve data.</td>
<td>post</td>
</tr>
<tr>
<td>data</td>
<td>array</td>
<td>
The list data to be loaded.
<p>Code example:</p>
<pre><input class="easyui-combobox" data-options="
valueField: 'label',
textField: 'value',
data: [{
label: 'java',
value: 'Java'
},{
label: 'perl',
value: 'Perl'
},{
label: 'ruby',
value: 'Ruby'
}]" />
</pre>
</td>
<td>null</td>
</tr>
<tr>
<td>filter</td>
<td>function</td>
<td>Defines how to filter the local data when 'mode' is set to 'local'. The function takes two parameters:<br>
q: the user typed text.<br>
row: the list row data.<br>
Return true to allow the row to be displayed.
<p>Code example:</p>
<pre>$('#cc').combobox({
filter: function(q, row){
var opts = $(this).combobox('options');
return row[opts.textField].indexOf(q) == 0;
}
});
</pre>
</td>
<td></td>
</tr>
<tr>
<td>formatter</td>
<td>function</td>
<td>
Defineds how to render the row. The function takes one parameter: row.
<p>Code example:</p>
<pre>$('#cc').combobox({
formatter: function(row){
var opts = $(this).combobox('options');
return row[opts.textField];
}
});
</pre>
</td>
<td></td>
</tr>
<tr>
<td>loader</td>
<td>function(param,success,error)</td>
<td>
Defines how to load data from remote server. Return false can abort this action.
This function takes following parameters:<br>
param: the parameter object to pass to remote server.<br>
success(data): the callback function that will be called when retrieve data successfully.<br>
error(): the callback function that will be called when failed to retrieve data.
</td>
<td>json loader</td>
</tr>
</tbody></table>
<br>
<h4>Events</h4>
<p>The events extend from combo, below is the added events for combobox.</p>
<table class="doc-table">
<tbody><tr>
<th><strong>Name</strong></th>
<th><strong>Parameters</strong></th>
<th><strong>Description</strong></th>
</tr>
<tr>
<td>onBeforeLoad</td>
<td>param</td>
<td>
Fires before a request is made to load data, return false to cancel this load action.
<p>Code example:</p>
<pre>// change the http request parameters before load data from server
$('#cc').combobox({
onBeforeLoad: function(param){
param.id = 2;
param.language = 'js';
}
});
</pre>
</td>
</tr>
<tr>
<td>onLoadSuccess</td>
<td>none</td>
<td>Fires when remote data is loaded successfully.</td>
</tr>
<tr>
<td>onLoadError</td>
<td>none</td>
<td>Fires when remote data load error.</td>
</tr>
<tr>
<td>onSelect</td>
<td>record</td>
<td>Fires when user select a list item.</td>
</tr>
<tr>
<td>onUnselect</td>
<td>record</td>
<td>Fires when user unselect a list item.</td>
</tr>
</tbody></table>
<br>
<h4>Methods</h4>
<p>The methods extend from combo, below is the added or overridden methods for combobox.</p>
<table class="doc-table">
<tbody><tr>
<th><strong>Name</strong></th>
<th><strong>Parameter</strong></th>
<th><strong>Description</strong></th>
</tr>
<tr>
<td>options</td>
<td>none</td>
<td>Return the options object.</td>
</tr>
<tr>
<td>getData</td>
<td>none</td>
<td>Return the loaded data.</td>
</tr>
<tr>
<td>loadData</td>
<td>data</td>
<td>Load the locale list data.</td>
</tr>
<tr>
<td>reload</td>
<td>url</td>
<td>
Request the remote list data. Pass the 'url' parameter to override the original URL value.
<p>Code example:</p>
<pre>$('#cc').combobox('reload'); // reload list data using old URL
$('#cc').combobox('reload','get_data.php'); // reload list data using new URL
</pre>
</td>
</tr>
<tr>
<td>setValues</td>
<td>values</td>
<td>
Set the combobox value array.
<p>Code example:</p>
<pre>$('#cc').combobox('setValues', ['001','002']);
</pre>
</td>
</tr>
<tr>
<td>setValue</td>
<td>value</td>
<td>
Set the combobox value.
<p>Code example:</p>
<pre>$('#cc').combobox('setValues', '001');
</pre>
</td>
</tr>
<tr>
<td>clear</td>
<td>none</td>
<td>Clear the combobox value.</td>
</tr>
<tr>
<td>select</td>
<td>value</td>
<td>Select the specified item.</td>
</tr>
<tr>
<td>unselect</td>
<td>value</td>
<td>Unselect the specified item.</td>
</tr>
</tbody></table>
</div>
</body>
</html>