jQuery autoComplete插件两种使用方式及动态改变参数值的方法详解
本文实例讲述了jQueryautoComplete插件两种使用方式及动态改变参数值的方法。分享给大家供大家参考，具体如下：
一、一次加载、多次使用：
前端JS代码：
/*客户名称自动匹配*/
functioncustomerAutoComplete(){
$.ajax({
type:"GET",
url:encodeURI("/approvalajax/salesOrderApproval_findCustomerList"),
dataType:"json",
success:function(data,textStatus){
if(data!=null&&data.customerList!=null){
$("#customerFullName").autocomplete(data.customerList,{
/**加自定义表头**/
tableHead:"<div><spanstyle='width:40%'class='col-1'>客户编码</span><spanstyle='width:58%'class='col-2'>客户名称</span></div>",
minChars:0,
width:310,
matchContains:"true",
autoFill:false,
extraParams:{ledger:$("#ledger").val()},
formatItem:function(row,i,max){
return"<spanstyle='width:40%'class='col-1'>"+row.cusCode+"</span>"+"<spanstyle='width:58%'class='col-2'>"+row.cusName+"</span>";
},
formatMatch:function(row,i,max){
returnrow.cusCode+row.cusName;
},
formatResult:function(row){
returnrow.cusName;
}
}).result(function(e,data,value,sec){/**加选中后的回调函数**/
clearCustomerInfo();
$("#customerShortName").val(data.cusAbbName);
$("#customerFullName").val(data.cusName);
$("#customerCode").val(data.cusCode);
/*根据选择的客户、账套加载对应产品线、收付款协议、账期*/
setPLAndPCAndCP(data.cusCode);
/*加载存货编码*/
setInventoryAutoComplete(data.cusCode);
}).bind("unmatch",function(){
clearCustomerInfo();
});
}
}
});
}
后台JAVA代码：
/**
*异步请求结果.
*/
privateMap<String,Object>ajaxResultMap;
/**
*@Description根据账套异步加载客户列表
*@throwsException
*@returnString
*/
publicStringfindCustomerList()throwsException{
ajaxResultMap=newHashMap<String,Object>();
response.setContentType("text/html;charset=UTF-8");
response.setCharacterEncoding("UTF-8");
List<ErpCustomer>list=erpDataService.findCustomerList(ledger);
ajaxResultMap.put("customerList",list);
returnSUCCESS;
}
配置文件相关代码：
<packagename="approval-ajax"extends="json-default"namespace="/approvalajax">
<!--销售订单审批相关-->
<actionname="salesOrderApproval_*"method="{1}"class="xx.xxx.xxAction">
<resulttype="json">
<paramname="root">ajaxResultMap</param>
<paramname="contentType">text/html</param>
</result>
</action>
</package>
二、根据输入内容动态加载：
前端JS代码：
/*客户名称自动匹配*/
functioncustomerAutoComplete(){
$("#customerFullName").autocomplete(encodeURI("/approvalajax/salesOrderApproval_findCustomerList"),{
/**加自定义表头**/
tableHead:"<div><spanstyle='width:40%'class='col-1'>客户编码</span><spanstyle='width:58%'class='col-2'>客户名称</span></div>",
minChars:0,
width:310,
matchContains:"true",
autoFill:false,
extraParams:{ledger:$("#ledger").val()},
dataType:'json',
parse:function(data){
varrows=[];
if(data==null||data.customerList==null){
returnrows;
}
for(vari=0;i<data.customerList.length;i++){
rows[rows.length]={
data:data.customerList[i],//下拉框显示数据格式
value:data.customerList[i].cusName,//选定后实际数据格式
result:data.customerList[i].cusName//选定后输入框显示数据格式
};
}
returnrows;
},
formatItem:function(row,i,max){
return"<spanstyle='width:40%'class='col-1'>"+row.cusCode+"</span>"+"<spanstyle='width:58%'class='col-2'>"+row.cusName+"</span>";
},
formatMatch:function(row,i,max){
returnrow.cusCode+row.cusName;
},
formatResult:function(row){
returnrow.cusName;
}
}).result(function(e,data,value,sec){/**加选中后的回调函数**/
clearCustomerInfo();
$("#customerShortName").val(data.cusAbbName);
$("#customerFullName").val(data.cusName);
$("#customerCode").val(data.cusCode);
$("#licensecode").val(data.licensecode);
/*根据选择的客户、账套加载对应产品线、收付款协议、账期*/
setPLAndPCAndCP(data.cusCode);
/*存货编码*/
addInventoryAutoComplete($("#detailListTbody").find("input[tdTag=inventoryCode]"));
}).bind("unmatch",function(){
clearCustomerInfo();
});
}
后台JAVA代码：
/**
*@Fieldsq自动填充辅助字符
*/
privateStringq;
/**
*异步请求结果.
*/
privateMap<String,Object>ajaxResultMap;
/**
*@Description根据账套异步加载客户列表
*@throwsException
*@returnString
*/
publicStringfindCustomerList()throwsException{
ajaxResultMap=newHashMap<String,Object>();
response.setContentType("text/html;charset=UTF-8");
response.setCharacterEncoding("UTF-8");
List<ErpCustomer>list=erpDataService.findTop5CustomerList(ledger,q);
ajaxResultMap.put("customerList",list);
returnSUCCESS;
}
说明：在使用动态加载时，请求的URL中插件会自动追加q参数，用于传输输入的参数。
注：使用Jquery中的autoComplete插件实现自动匹配功能时，直接使用它来解析json对象时，会出现一个错误提示，因为它默认使用"/n"拆分行、"|"拆分字段。如果需要使用它来解析json对象，则需要自己实现其parse方法。
参数说明：
*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是否与foobar中的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){
//如选择后给其他控件赋值，触发别的事件等等
});
注：另一种方式可动态改变参数传入值。
我们知道这个插件有一个extraParams的参数，因为jquery.autoComplete只支持q和limit两个参数，假如有这样的情况，我们需要向服务器提交更多参数怎么办呢，幸好，作者为我们提供一个扩展参数，就是extraParams。extraParams好是好，可是不幸的是，它是一个死的参数，有时候，我们需要提交一个活的参数到服务器。举例说明，比如说我们有一个公司名称的自动完成功能，但我们同时需要向服务器提供一个城市的参数，正常的情况下没有问题。但当城市的名称是由用户选择的时候，就有问题了，也就说，这个城市的名称是根据用户选择而实时变化的，这个时候，现有的jquery.autoComplete就无能为力了。
这个时候我们就要考虑修改修改一下jquery.autoComplete了，我们先看一下代码，代码有一个onChange事件，这是一个解发事件，我们可以在这里添加一个回调函数来解决问题。首先我们要为options中添加一个参数叫onBegin，大致就在400行左右吧，有一行这样的代码：
$.Autocompleter.defaults=
我们在后面添加一段
onBegin:null,
然后我们找到onChange事件，约在226行，代码如下：
functiononChange(crap,skipPrevCheck)
在函数时里面添加如下代码：
if(options.onBegin){
varop=options.onBegin(options);
if(op){
$.extend(options,op);
}
}
这段代码被修改过后看起来就像这样：
functiononChange(crap,skipPrevCheck){
//2010-01-27，添加onBegin函数，以便在启动onChange的时候，可以重新设置options
if(options.onBegin){
varop=options.onBegin(options);
if(op){
$.extend(options,op);
}
}
//end
if(lastKeyPressCode==KEY.DEL){
select.hide();
return;
}
varcurrentValue=$input.val();
if(!skipPrevCheck&¤tValue==previousValue)
return;
previousValue=currentValue;
currentValue=lastWord(currentValue);
if(currentValue.length>=options.minChars){
$input.addClass(options.loadingClass);
if(!options.matchCase)
currentValue=currentValue.toLowerCase();
request(currentValue,receiveData,hideResultsNow);
}else{
stopLoading();
select.hide();
}
};
再来看调用：
/*客户名称自动匹配*/
functioncustomerAutoComplete(){
$("#customerFullName").autocomplete(encodeURI("/approvalajax/salesOrderApproval_findCustomerList"),{
/**加自定义表头**/
tableHead:"<div><spanstyle='width:40%'class='col-1'>客户编码</span><spanstyle='width:58%'class='col-2'>客户名称</span></div>",
minChars:0,
width:310,
multiple:false,
mustMatch:false,
matchContains:false,
matchSubset:false,
autoFill:false,
onBegin:function(options){//修改--用于动态改变ledger的值
options.extraParams.ledger=$("#ledger").val();
returnoptions;
},
//extraParams:{ledger:$("#ledger").val()},
dataType:'json',
parse:function(data){
varrows=[];
if(data==null||data.customerList==null){
returnrows;
}
for(vari=0;i<data.customerList.length;i++){
rows[rows.length]={
data:data.customerList[i],//下拉框显示数据格式
value:data.customerList[i].cusName,//选定后实际数据格式
result:data.customerList[i].cusName//选定后输入框显示数据格式
};
}
returnrows;
},
formatItem:function(row,i,max){
return"<spanstyle='width:40%'class='col-1'>"+row.cusCode+"</span>"+"<spanstyle='width:58%'class='col-2'>"+row.cusName+"</span>";
},
formatMatch:function(row,i,max){
returnrow.cusCode+row.cusName;
},
formatResult:function(row){
returnrow.cusName;
}
}).result(function(e,data,value,sec){/**加选中后的回调函数**/
clearCustomerInfo();
$("#customerShortName").val(data.cusAbbName);
$("#customerFullName").val(data.cusName);
$("#customerCode").val(data.cusCode);
$("#licensecode").val(data.licensecode);
/*根据选择的客户、账套加载对应产品线、收付款协议、账期*/
setPLAndPCAndCP(data.cusCode);
}).bind("unmatch",function(){
clearCustomerInfo();
});
}
其实做的只有三步：
1.在options中添加一个onBegin的参数
2.在onChange中判断onBegin是否有赋值，如果有，则调用这个函数，返回将返回值合并到options中去
3.调用的时候，在onBegin函数中添加一些业务逻辑，并可以重新设置options
就这样，我们不仅可以达到动态去添加extraParams参数，而且还可以动态地修改其它options参数，这个onBegin在用户改变输入框的值就会触发。
更多关于jQuery相关内容感兴趣的读者可查看本站专题：《jQuery窗口操作技巧总结》、《jQuery拖拽特效与技巧总结》、《jQuery常用插件及用法总结》、《jquery中Ajax用法总结》、《jQuery表格(table)操作技巧汇总》、《jQuery扩展技巧总结》、《jQuery常见经典特效汇总》、《jQuery动画与特效用法总结》及《jquery选择器用法总结》
希望本文所述对大家jQuery程序设计有所帮助。