jQuery Autocomplete

<p style="text-indent: 2em;">一、用前必备</p>
<p style="text-indent: 2em;">官方网站：<span style="color: #e79a0f;">http://bassistance.de/jquery-plugins/jquery-plugin-autocomplete/</span></p>
<p style="text-indent: 2em;">当前版本：1.0.2</p>
<p style="text-indent: 2em;">需要JQuery版本：1.2.6</p>
<p style="text-indent: 2em;">二、使用</p>
<p style="text-indent: 2em;">&lt;script src="./jquery-1.3.2.js" type="text/javascript"&gt;&lt;/script&gt;</p>
<p style="text-indent: 2em;">&lt;script src="./jquery.autocomplete.js" type="text/javascript"&gt;&lt;/script&gt;</p>
<p style="text-indent: 2em;">&lt;link rel="stylesheet" href="./jquery.autocomplete.css" /&gt;</p>
<p style="text-indent: 2em;">autocomplete( url or data, options ) Returns: jQuery</p>
<p style="text-indent: 2em;">让一个input或textarea有autocomplete功能</p>
<p style="text-indent: 2em;">例子</p>
<p style="text-indent: 2em;">Js代码</p>
<p style="text-indent: 2em;">var data = "Core Selectors Attributes Traversing Manipulation CSS Events Effects Ajax Utilities".split(" ");</p>
<p style="text-indent: 2em;">$("#example").autocomplete(data);</p>
<p style="text-indent: 2em;">以上的例子就是为id为example添加autocomplete</p>
<p style="text-indent: 2em;">var emails = [</p>
<p style="text-indent: 2em;"> { name: "Peter Pan", to: "<span style="color: #e79a0f;">[e-mail]</span>" },</p>
<p style="text-indent: 2em;"> { name: "Molly", to: "<span style="color: #e79a0f;">[e-mail]</span>" },</p>
<p style="text-indent: 2em;"> { name: "Forneria Marconi", to: "<span style="color: #e79a0f;">[e-mail]</span>" },</p>
<p style="text-indent: 2em;"> { name: "Master &lt;em&gt;Sync&lt;/em&gt;", to: "<span style="color: #e79a0f;">[e-mail]</span>" },</p>
<p style="text-indent: 2em;"> { name: "Dr. &lt;strong&gt;Tech&lt;/strong&gt; de Log", to: "<span style="color: #e79a0f;">[e-mail]</span>" },</p>
<p style="text-indent: 2em;"> { name: "Don Corleone", to: "<span style="color: #e79a0f;">[e-mail]</span>" },</p>
<p style="text-indent: 2em;"> { name: "Mc Chick", to: "<span style="color: #e79a0f;">[e-mail]</span>" },</p>
<p style="text-indent: 2em;"> { name: "Donnie Darko", to: "<span style="color: #e79a0f;">[e-mail]</span>" },</p>
<p style="text-indent: 2em;"> { name: "Quake The Net", to: "<span style="color: #e79a0f;">[e-mail]</span>" },</p>
<p style="text-indent: 2em;"> { name: "Dr. Write", to: "<span style="color: #e79a0f;">[e-mail]</span>" }</p>
<p style="text-indent: 2em;">];</p>
<p style="text-indent: 2em;">//emails的数组格式如上，formatItem代表的是显示的格式，formatMatch表示匹配的内容，formatResult表示结果的内容</p>
<p style="text-indent: 2em;">$("#suggest13").autocomplete(emails, {</p>
<p style="text-indent: 2em;"> minChars: 0,</p>
<p style="text-indent: 2em;"> width: 310,</p>
<p style="text-indent: 2em;"> matchContains: true,</p>
<p style="text-indent: 2em;"> autoFill: false,</p>
<p style="text-indent: 2em;"> formatItem: function(row, i, max) {</p>
<p style="text-indent: 2em;"> return i + "/" + max + ": /"" + row.name + "/" [" + row.to + "]";</p>
<p style="text-indent: 2em;"> },</p>
<p style="text-indent: 2em;"> formatMatch: function(row, i, max) {</p>
<p style="text-indent: 2em;"> return row.name + " " + row.to;</p>
<p style="text-indent: 2em;"> },</p>
<p style="text-indent: 2em;"> formatResult: function(row) {</p>
<p style="text-indent: 2em;"> return row.to;</p>
<p style="text-indent: 2em;"> }</p>
<p style="text-indent: 2em;">});</p>
<p style="text-indent: 2em;">三、参数说明：</p>
<p style="text-indent: 2em;">* minChars (Number):</p>
<p style="text-indent: 2em;"> 在触发autoComplete前用户至少需要输入的字符数.Default: 1，如果设为0，在输入框内双击或者删除输入框内内容时显示列表</p>
<p style="text-indent: 2em;">* width (Number):</p>
<p style="text-indent: 2em;"> 指定下拉框的宽度. Default: input元素的宽度</p>
<p style="text-indent: 2em;">* max (Number):</p>
<p style="text-indent: 2em;"> autoComplete下拉显示项目的个数.Default: 10</p>
<p style="text-indent: 2em;">* delay (Number):</p>
<p style="text-indent: 2em;"> 击键后激活autoComplete的延迟时间(单位毫秒).Default: 远程为400 本地10</p>
<p style="text-indent: 2em;">* autoFill (Boolean):</p>
<p style="text-indent: 2em;"> 要不要在用户选择时自动将用户当前鼠标所在的值填入到input框. Default: false</p>
<p style="text-indent: 2em;">* mustMatch (Booolean):</p>
<p style="text-indent: 2em;"> 如果设置为true,autoComplete只会允许匹配的结果出现在输入框,所有当用户输入的是非法字符时将会得不到下拉框.Default: false</p>
<p style="text-indent: 2em;">* matchContains (Boolean):</p>
<p style="text-indent: 2em;"> 决定比较时是否要在字符串内部查看匹配,如ba是否与foo bar中的ba匹配.使用缓存时比较重要.不要和autofill混用.Default: false</p>
<p style="text-indent: 2em;">* selectFirst (Boolean):</p>
<p style="text-indent: 2em;"> 如果设置成true,在用户键入tab或return键时autoComplete下拉列表的第一个值将被自动选择,尽管它没被手工选中(用键盘或鼠标).当然如果用户选中某个项目,那么就用用户选中的值. Default: true</p>
<p style="text-indent: 2em;">* cacheLength (Number):</p>
<p style="text-indent: 2em;"> 缓存的长度.即对从数据库中取到的结果集要缓存多少条记录.设成1为不缓存.Default: 10</p>
<p style="text-indent: 2em;">* matchSubset (Boolean):</p>
<p style="text-indent: 2em;"> autoComplete可不可以使用对服务器查询的缓存,如果缓存对foo的查询结果,那么如果用户输入foo就不需要再进行检索了,直接使用缓存.通常是打开这个选项以减轻服务器的负担以提高性能.只会在缓存长度大于1时有效.Default: true</p>
<p style="text-indent: 2em;">* matchCase (Boolean):</p>
<p style="text-indent: 2em;"> 比较是否开启大小写敏感开关.使用缓存时比较重要.如果你理解上一个选项,这个也就不难理解,就好比foot要不要到FOO的缓存中去找.Default: false</p>
<p style="text-indent: 2em;">* multiple (Boolean):</p>
<p style="text-indent: 2em;"> 是否允许输入多个值即多次使用autoComplete以输入多个值. Default: false</p>
<p style="text-indent: 2em;">* multipleSeparator (String):</p>
<p style="text-indent: 2em;"> 如果是多选时,用来分开各个选择的字符. Default: ","</p>
<p style="text-indent: 2em;">* scroll (Boolean):</p>
<p style="text-indent: 2em;"> 当结果集大于默认高度时是否使用卷轴显示 Default: true</p>
<p style="text-indent: 2em;">* scrollHeight (Number):</p>
<p style="text-indent: 2em;"> 自动完成提示的卷轴高度用像素大小表示 Default: 180</p>
<p style="text-indent: 2em;">* formatItem (Function):</p>
<p style="text-indent: 2em;"> 为每个要显示的项目使用高级标签.即对结果中的每一行都会调用这个函数,返回值将用LI元素包含显示在下拉列表中. Autocompleter会提供三个参数(row, i, max): 返回的结果数组, 当前处理的行数(即第几个项目,是从1开始的自然数), 当前结果数组元素的个数即项目的个数. Default: none, 表示不指定自定义的处理函数,这样下拉列表中的每一行只包含一个值.</p>
<p style="text-indent: 2em;">* formatResult (Function):</p>
<p style="text-indent: 2em;"> 和formatItem类似,但可以将将要输入到input文本框内的值进行格式化.同样有三个参数,和formatItem一样.Default: none,表示要么是只有数据,要么是使用formatItem提供的值.</p>
<p style="text-indent: 2em;">* formatMatch (Function):</p>
<p style="text-indent: 2em;"> 对每一行数据使用此函数格式化需要查询的数据格式. 返回值是给内部搜索算法使用的. 参数值row</p>
<p style="text-indent: 2em;">* extraParams (Object):</p>
<p style="text-indent: 2em;"> 为后台(一般是服务端的脚本)提供更多的参数.和通常的作法一样是使用一个键值对对象.如果传过去的值是{ bar:4 },将会被autocompleter解析成my_autocomplete_backend.php?q=foo&amp;bar=4 (假设当前用户输入了foo). Default: {}</p>
<p style="text-indent: 2em;">* result (handler) Returns: jQuery</p>
<p style="text-indent: 2em;"> 此事件会在用户选中某一项后触发，参数为：</p>
<p style="text-indent: 2em;"> event: 事件对象. event.type为result.</p>
<p style="text-indent: 2em;"> data: 选中的数据行.</p>
<p style="text-indent: 2em;"> formatted:formatResult函数返回的值</p>
<p style="text-indent: 2em;"> 例如：</p>
<p style="text-indent: 2em;"> $("#singleBirdRemote").result(function(event, data, formatted) {</p>
<p style="text-indent: 2em;">//如选择后给其他控件赋值，触发别的事件等等</p>
<p style="text-indent: 2em;">});</p>
<p style="text-indent: 2em;">四、注意问题：</p>
<p style="text-indent: 2em;">1.网上有人说对中文的检索时处理有问题，经过测试此版本没有问题^-^</p>
<p style="text-indent: 2em;">2.在使用远程地址时，它默认传入的参数是：q（输入值），limit（返回结果的最大值），可以使用extraParams传入其他的参数</p>
<p style="text-indent: 2em;">3.autocomplete在使用ajax传递参数时，默认使用了get方式传递，也实在是没有找到可以通过参数提交post方式的办法。</p>
<p style="text-indent: 2em;">解决方式1：在使用ajax的get方式传递中文时，使用new String(request.getParameter("q").getBytes("iso8859-1"),"utf-8")获得参数值</p>
<p style="text-indent: 2em;">解决方式2：修改jquery.autocomplete.js代码，把get方式修改为post方式，然后参见之前ajax解决中文乱码的问题的</p>
<p style="text-indent: 2em;"></p>