jQuery.Autocomplete實現(xiàn)自動完成功能（詳解）

更新時間：2010年07月13日 14:58:44 作者：

本篇文章除了介紹jquery.autocomplete基本參數(shù)外，主要說明jquery.autocomplete的數(shù)據(jù)源的格式問題。

1、jquery.autocomplete參考地址
http://bassistance.de/jquery-plugins/jquery-plugin-autocomplete/
http://docs.jquery.com/Plugins/Autocomplete
2、jquery.autocomplete詳解
語法：
autocomplete(urlor data, [options] )
參數(shù)：
url or data：數(shù)組或者url
[options]：可選項，選項解釋如下：
1) minChars (Number)
在觸發(fā)autoComplete前用戶至少需要輸入的字符數(shù)，Default:1，如果設為0，在輸入框內(nèi)雙擊或者刪除輸入框內(nèi)內(nèi)容時顯示列表。
2) width (Number)
指定下拉框的寬度，Default: input元素的寬度
3) max (Number)
autoComplete下拉顯示項目的個數(shù)，Default: 10
4) delay (Number)
擊鍵后激活autoComplete的延遲時間(單位毫秒)，Default: 遠程為400 本地10
5) autoFill (Boolean)
要不要在用戶選擇時自動將用戶當前鼠標所在的值填入到input框，Default: false
6) mustMatch (Booolean)
如果設置為true，autoComplete只會允許匹配的結(jié)果出現(xiàn)在輸入框,所有當用戶輸入的是非法字符時將會得不到下拉框，Default:false
7) matchContains (Boolean)
決定比較時是否要在字符串內(nèi)部查看匹配，如ba是否與foo bar中的ba匹配.使用緩存時比較重要.不要和autofill混用.Default: false
8) selectFirst (Boolean)
如果設置成true,在用戶鍵入tab或return鍵時autoComplete下拉列表的第一個值將被自動選擇,盡管它沒被手工選中(用鍵盤或鼠標).當然如果用戶選中某個項目,那么就用用戶選中的值. Default: true
9) cacheLength (Number)
緩存的長度.即對從數(shù)據(jù)庫中取到的結(jié)果集要緩存多少條記錄.設成1為不緩存.Default: 10
10) matchSubset (Boolean)
autoComplete可不可以使用對服務器查詢的緩存,如果緩存對foo的查詢結(jié)果,那么如果用戶輸入foo就不需要再進行檢索了,直接使用緩存.通常是打開這個選項以減輕服務器的負擔以提高性能.只會在緩存長度大于1時有效.Default: true
11) matchCase (Boolean)
比較是否開啟大小寫敏感開關.使用緩存時比較重要.如果你理解上一個選項,這個也就不難理解,就好比foot要不要到FOO的緩存中去找.Default: false
12) multiple (Boolean)
是否允許輸入多個值即多次使用autoComplete以輸入多個值. Default:false
13) multipleSeparator (String)
如果是多選時,用來分開各個選擇的字符. Default:","
14) scroll (Boolean)
當結(jié)果集大于默認高度時是否使用卷軸顯示 Default: true
15) scrollHeight (Number)
自動完成提示的卷軸高度用像素大小表示 Default: 180
16) formatItem (Function)
為每個要顯示的項目使用高級標簽.即對結(jié)果中的每一行都會調(diào)用這個函數(shù),返回值將用LI元素包含顯示在下拉列表中.Autocompleter會提供三個參數(shù)(row, i, max): 返回的結(jié)果數(shù)組, 當前處理的行數(shù)(即第幾個項目,是從1開始的自然數(shù)), 當前結(jié)果數(shù)組元素的個數(shù)即項目的個數(shù).Default: none, 表示不指定自定義的處理函數(shù),這樣下拉列表中的每一行只包含一個值.
17) formatResult (Function)
和formatItem類似,但可以將將要輸入到input文本框內(nèi)的值進行格式化.同樣有三個參數(shù),和formatItem一樣.Default: none,表示要么是只有數(shù)據(jù),要么是使用formatItem提供的值.
18) formatMatch (Function)
對每一行數(shù)據(jù)使用此函數(shù)格式化需要查詢的數(shù)據(jù)格式. 返回值是給內(nèi)部搜索算法使用的. 參數(shù)值row
19) extraParams (Object)
為后臺(一般是服務端的腳本)提供更多的參數(shù).和通常的作法一樣是使用一個鍵值對對象.如果傳過去的值是{ bar:4 },將會被autocompleter解析成my_autocomplete_backend.php?q=foo&bar=4 (假設當前用戶輸入了foo). Default: {}
20) result (handler) Returns:jQuery
此事件會在用戶選中某一項后觸發(fā)，參數(shù)為：
event: 事件對象. event.type為result.
data: 選中的數(shù)據(jù)行.
formatted:formatResult函數(shù)返回的值
例如：
$("#singleBirdRemote").result(function(event, data, formatted){
//如選擇后給其他控件賦值，觸發(fā)別的事件等等
});
3、jquery.autocomplete使用技巧
1) jquery.autocomplete需要的數(shù)據(jù)源可以為：本地數(shù)據(jù)和遠程數(shù)據(jù)
本地數(shù)據(jù)源為本地js數(shù)組或本地的json對象，如：
var data = ["c++","java", "php", "coldfusion","javascript"];
var data = [{text:'Link A', url:'/page1'}, {text:'Link B', url: '/page2'} ];
在使用遠程地址時，它默認傳入的參數(shù)是：q（輸入值），limit（返回結(jié)果的最大值），可以使用extraParams傳入其他的參數(shù)，而且遠程數(shù)據(jù)源是需要固定格式的數(shù)據(jù)，返回結(jié)果：使用“\n”分割每行數(shù)據(jù)，每行數(shù)據(jù)中使用“|”分割每個元素，如：
后臺C＃代碼：

復制代碼代碼如下:

 
string data = "c++\n java \n php \n coldfusion \n javascript"; 
string data = "{text:'LinkA', url:'/page1'} \n {text:'Link B', url: '/page2'} "; 

4、jquery.autocomplete實例
1) 本地數(shù)據(jù)源的調(diào)用方法
方法1：

復制代碼代碼如下:

 
$("#tags").autocomplete(["c++","java", "php", "coldfusion","javascript"], { 
width: 320, 
max: 4, 
highlight: false, 
multiple: true, 
multipleSeparator: "", 
scroll: true, 
scrollHeight: 300 
}); 

方法2：

復制代碼代碼如下:

 
var data = [{text:'Link A', url:'/page1'}, {text:'Link B', url: '/page2'} ]; 
$("...").autocomplete(data,{ 
formatItem: function(item) { 
return item.text; 
} 
}).result(function(event,item) { 
location.href = item.url; 
}); 

2) 遠程數(shù)據(jù)數(shù)據(jù)源的調(diào)用方法
方法1：
前臺js

復制代碼代碼如下:

 
<scripttype="text/javascript"> 
$(document).ready(function() { 
$("#Login").focus().autocomplete("/ajax/Account", { 
formatItem: function(row, i,max) { 
var obj =eval("(" + row + ")"); //轉(zhuǎn)換成js對象 
return obj.Text; 
}, 
formatResult: function(row) { 
var obj =eval("(" + row + ")"); //轉(zhuǎn)換成js對象 
return obj.Text; 
} 
}).result(function(event, item) { 
var obj = eval("(" +item + ")"); //轉(zhuǎn)換成js對象 
$("#link").attr(“href”,obj.url); 
}); 
}); 
</script> 

后臺C#（mvc）代碼：

復制代碼代碼如下:

 
public ContentResult GetUserAccount(string q) 
{ 
string strResult = ""; 
//...查詢數(shù)據(jù)操作... 
//...格式化數(shù)據(jù)... 
//格式完成的結(jié)果為 
strResult = "{text:'Link A', url:'/page1'}\n {text:'Link B', url: '/page2'} "; 
return Content(strResult); 
} 

方法2：
前臺js

復制代碼代碼如下:

 
<scripttype="text/javascript"> 
$(document).ready(function() { 
$.getJSON("/ajax/Account",function(data) { 
$("#Login").focus().autocomplete(data, { 
formatItem: function(item,i, max) { 
return item.Text; 
}, 
formatResult:function(item) { 
return item.Text; 
} 
}).result(function(event, item){ 
$("#link").attr(“href”,item.url); 
}); 
}); 
}); 
</script>

后臺C#（mvc）代碼：

復制代碼代碼如下:

publicContentResult Account(string q) 
{ 
string strResult = ""; 
//...查詢數(shù)據(jù)操作... 
//...格式化數(shù)據(jù)... 
//格式完成的結(jié)果為 
strResult = "[{\"text\":\"LinkA\", \"url\":\"/page1\"}, {\"text\":\"LinkB\", \"url\": \"/page2\"} ]"; 
return Content(strResult); 
} 

您可能感興趣的文章: