官方网站：http://bassistance.de/jquery-plugins/jquery-plugin-autocomplete/
当前版本：1.0.2
需要JQuery版本：1.2.6
二、使用
<script src="./jquery-1.3.2.js"></script>
<script src="./jquery.autocomplete.js"></script>
<link rel="stylesheet" href="./jquery.autocomplete.css" />
autocomplete( url or data, options ) Returns: jQuery
让一个input或textarea有autocomplete功能
例子
var emails = [
{ name: "Peter Pan", to: "[email protected]" },
{ name: "Molly", to: "[email protected]" },
{ name: "Forneria Marconi", to: "[email protected]" },
{ name: "Master <em>Sync</em>", to: "[email protected]" },
{ name: "Dr. <strong>Tech</strong> de Log", to: "[email protected]" },
{ name: "Don Corleone", to: "[email protected]" },
{ name: "Mc Chick", to: "[email protected]" },
{ name: "Donnie Darko", to: "[email protected]" },
{ name: "Quake The Net", to: "[email protected]" },
{ name: "Dr. Write", to: "[email protected]" }
];
//刚开始看的时候，不太明白这个数组的格式，在下面写到row.name和row.to的时候也是比较迷糊，可能是自己接触的太少吧。后来才明白，他是在数组的每个位置放的对象object。举个例子：
var str= [];
var obj = new Object();
obj.name = "zhangsan";
obj.password = "123";
str[0] = obj
……
下面以此类推，最终str里放了若干个obj进去，这样在下面写的时候就可以写成row.name和row.password，嗯，具体就是这个意思，当时以为row.to什么是固定写好的呢。
//emails的数组格式如上，formatItem代表的是显示的格式，formatMatch表示匹配的内容，formatResult表示结果的内容
//下面这段标注，suggest13是你text文本框组件的id，emails则是为文本框的赋值
$("#suggest13").autocomplete(emails, {
minChars: 0,
width: 310,
matchContains: true,
autoFill: false,
formatItem: function(row, i, max) {
return i + "/" + max + ": \"" + row.name + "\" [" + row.to + "]"; //这么写是当鼠标点击文本框以后或输入某个字符以后，智能提示的数据格式，如果写成return row.name的话，下拉提示就会显示上面数组的所有name的名字
},
formatMatch: function(row, i, max) {
return row.name + " " + row.to;
},
formatResult: function(row) {
return row.to; //选择一个结果后，显示在text文本框中的值，也就是写在文本框中的值
}
});
三、参数说明：
* minChars (Number):
在触发autoComplete前用户至少需要输入的字符数.Default: 1，如果设为0，在输入框内双击或者删除输入框内内容时显示列表
* width (Number):
指定下拉框的宽度. Default: input元素的宽度
* max (Number):
autoComplete下拉显示项目的个数.Default: 10
* delay (Number):
击键后激活autoComplete的延迟时间(单位毫秒).Default: 远程为400 本地10
* autoFill (Boolean):
要不要在用户选择时自动将用户当前鼠标所在的值填入到input框. Default: false
* mustMatch (Booolean):
如果设置为true,autoComplete只会允许匹配的结果出现在输入框,所有当用户输入的是非法字符时将会得不到下拉框.Default: false
* matchContains (Boolean):
决定比较时是否要在字符串内部查看匹配,如ba是否与foo bar中的ba匹配.使用缓存时比较重要.不要和autofill混用.Default: false
* selectFirst (Boolean):
如果设置成true,在用户键入tab或return键时autoComplete下拉列表的第一个值将被自动选择,尽管它没被手工选中(用键盘或鼠标).当然如果用户选中某个项目,那么就用用户选中的值. Default: true
* cacheLength (Number):
缓存的长度.即对从数据库中取到的结果集要缓存多少条记录.设成1为不缓存.Default: 10
* matchSubset (Boolean):
autoComplete可不可以使用对服务器查询的缓存,如果缓存对foo的查询结果,那么如果用户输入foo就不需要再进行检索了,直接使用缓存.通常是打开这个选项以减轻服务器的负担以提高性能.只会在缓存长度大于1时有效.Default: true
* matchCase (Boolean):
比较是否开启大小写敏感开关.使用缓存时比较重要.如果你理解上一个选项,这个也就不难理解,就好比foot要不要到FOO的缓存中去找.Default: false
* multiple (Boolean):
是否允许输入多个值即多次使用autoComplete以输入多个值. Default: false
* multipleSeparator (String):
如果是多选时,用来分开各个选择的字符. Default: ","
* scroll (Boolean):
当结果集大于默认高度时是否使用卷轴显示 Default: true
* scrollHeight (Number):
自动完成提示的卷轴高度用像素大小表示 Default: 180
* formatItem (Function):
为每个要显示的项目使用高级标签.即对结果中的每一行都会调用这个函数,返回值将用LI元素包含显示在下拉列表中. Autocompleter会提供三个参数(row, i, max): 返回的结果数组, 当前处理的行数(即第几个项目,是从1开始的自然数), 当前结果数组元素的个数即项目的个数. Default: none, 表示不指定自定义的处理函数,这样下拉列表中的每一行只包含一个值.
* formatResult (Function):
和formatItem类似,但可以将将要输入到input文本框内的值进行格式化.同样有三个参数,和formatItem一样.Default: none,表示要么是只有数据,要么是使用formatItem提供的值.
* formatMatch (Function):
对每一行数据使用此函数格式化需要查询的数据格式. 返回值是给内部搜索算法使用的. 参数值row
* extraParams (Object):
为后台(一般是服务端的脚本)提供更多的参数.和通常的作法一样是使用一个键值对对象.如果传过去的值是{ bar:4 },将会被autocompleter解析成my_autocomplete_backend.php?q=foo&bar=4 (假设当前用户输入了foo). Default: {}
* result (handler) Returns: jQuery //这个方法很有用，在你选择一个智能提示以后，会出发这个事件，这样你就可以根据自己的需要去执行其他方法
此事件会在用户选中某一项后触发，参数为：
event: 事件对象. event.type为result.
data: 选中的数据行.
formatted:formatResult函数返回的值
例如：
$("#singleBirdRemote").result(function(event, data, formatted) {
//如选择后给其他控件赋值，触发别的事件等等
});
四、注意问题：
1.网上有人说对中文的检索时处理有问题，经过测试此版本没有问题^-^
2.在使用远程地址时，它默认传入的参数是：q（输入值），limit（返回结果的最大值），可以使用extraParams传入其他的参数
3.autocomplete在使用ajax传递参数时，默认使用了get方式传递，也实在是没有找到可以通过参数提交post方式的办法。
解决方式1：在使用ajax的get方式传递中文时，使用new String(request.getParameter("q").getBytes("iso8859-1"),"utf-8")获得参数值
解决方式2：修改jquery.autocomplete.js代码，把get方式修改为post方式，然后参见之前ajax解决中文乱码的问题的
==================================我的例子====================================
主要截取一下autocomplele使用的部分
<script type="text/javascript">
var contractname = []; //数组，用来存放所有的值，后台传的
showFirst(); //在页面打开的时候，直接调用我的方法，让它直接把所有的值赋到text中
function showFirst()
{
jAjax.receiveContractName(callback); //dwr的方法
}
function callback(data)
{
for(var i=0;i<data.length;i++) //通过循环，提前把所有的值存在数组中，可以看一下我数组的格式
{
var obk = new Object();
obk.customId = data.customId;
obk.customName = data.customName;
contractname = obk;
}
//交通费
$("#scclient_jtf").autocomplete(contractname, { //调用autocomplele组件，实现赋值
minChars: 0,
width: 310,
max:10,
delay:10,
cacheLength:500,
matchContains: true,
autoFill: false,
formatItem: function(row, i, max) {
return row.customName;
},
formatMatch: function(row, i, max) {
return row.customName + " " + row.customId;
},
formatResult: function(row) {
return row.customName;
}
});
$("#scclient_jtf").result(function(event, data, formatted){
//当选中一个后，出发这个事件，我根据需要传递了一个id到我另外的一个方法showSec中
showSec(data.customId);
});
}
最后说一下，dwr好像和jquery有一些冲突，网上也有一些解决的办法，我懒，用了最简单的办法，在导入dwr三个js文件，我没有导入<script src='dwr/util.js'></script>
还有因为根据我的需要，我想要用户在光标在文本框的时候就显示智能提示，所以可以在jquery.autocomplete.js文件里搜索一下click方法，把其中的hasFocus++ > 1修改成hasFocus++ > 0，这样用户的鼠标只要一点击text文本框，就会出现智能提示了。大体上就是这么多，因为刚接触这个东西，而且jquery也不是太了解，所以感觉功能上还有很大的优化空间
最新评论