簡單用法:
<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title></title>
<link rel="stylesheet" type="text/css" href="../css/autocomplete/jquery.autocomplete.css"/>
<script type="text/javascript" src="../js/jquery-1.4.2.min.js"></script>
<script type="text/javascript" src="../js/autocomplete/jquery.autocomplete.js"></script>
<script type="text/javascript">
$(function(){
var data = "the People's Republic of China".split(" ");
$("#autocomplete").autocomplete(data,{minChars:0}).result(function(event,data,formatted){
alert(data);
});
});
</script>
</head>
<body>
<input type="text" id="autocomplete"/>
</body>
</html>
更多參數說明:
第一個參數除了本地數據外,還可以是url請求路徑。
配置項參數說明:
dataType(String):數據類型.Default:text,如果第一個參數是url地址,並且返回的是json數據,則設置此配置屬性為'json'即可;
minChars(Number):在觸發autoComplete前用戶至少需要輸入的字符數.Default: 1,如果設為0,在輸入框內雙擊或者刪除輸入框內內容時顯示列表;
max(Number):autoComplete下拉顯示項目的個數.Default: 10;
width(Number):指定下拉框的寬度. Default: input元素的寬度;
delay(Number):擊鍵后激活autoComplete的延遲時間(單位毫秒).Default: 遠程為400 本地10;
autoFill(Boolean):要不要在用戶選擇時自動將用戶當前鼠標所在的值填入到input框. Default: false;
mustMatch(Boolean):如果設置為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, 表示不指定自定義的處理函數,這樣下拉列表中的每一行只包含一個值;
formatMatch(Function):對每一行數據使用此函數格式化需要查詢的數據格式. 返回值是給內部搜索算法使用的. 參數值row i max;
formatResult(Function):和formatItem類似,但可以將將要輸入到input文本框內的值進行格式化.同樣有三個參 數,和formatItem一樣.Default: none,表示要么是只有數據,要么是使用formatItem提供的值;
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) {
//如選擇后給其他控件賦值,觸發別的事件等等
});
一個稍微復雜點的例子:
<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title></title>
<link rel="stylesheet" type="text/css" href="../css/autocomplete/jquery.autocomplete.css"/>
<script type="text/javascript" src="../js/jquery-1.4.2.min.js"></script>
<script type="text/javascript" src="../js/autocomplete/jquery.autocomplete.js"></script>
<script type="text/javascript">
$(function(){
var emails = [
{ name: "Peter", to: "peter@pan.de" },
{ name: "Molly", to: "molly@yahoo.com" },
{ name: "Forneria", to: "live@japan.jp" },
{ name: "Master <em>Sync</em>", to: "205bw@samsung.com" },
{ name: "Dr. <strong>Tech</strong> de Log", to: "g15@logitech.com" },
{ name: "Don Corleone", to: "don@vegas.com" },
{ name: "Mc Chick", to: "info@donalds.org" },
{ name: "Donnie Darko", to: "dd@timeshift.info" },
{ name: "Quake The Net", to: "webmaster@quakenet.org" },
{ name: "Dr. Write", to: "write@writable.com" },
{ name: "GG Bond", to: "Bond@qq.com" },
{ name: "Zhuzhu Xia", to: "zhuzhu@qq.com" }
];
$("#autocomplete").autocomplete(emails,{
minChars: 0,//自動完成激活之前填入的最小字符
max:12,//列表條目數
width: 400,//提示的寬度
scrollHeight: 300,//提示的高度
matchContains: true,//是否只要包含文本框里的就可以
autoFill:false,//自動填充
formatItem: function(data, i, max) {//格式化列表中的條目 row:條目對象,i:當前條目數,max:總條目數
return i + '/' + max + ':"' + data.name + '"[' + data.to + ']';
},
formatMatch: function(data, i, max) {//配合formatItem使用,作用在於,由於使用了formatItem,所以條目中的內容有所改變,而我們要匹配的是原始的數據,所以用formatMatch做一個調整,使之匹配原始數據
return data.name + data.to;
},
formatResult: function(data) {//定義最終返回的數據,比如我們還是要返回原始數據,而不是formatItem過的數據
return data.to;
}
}).result(function(event,data,formatted){
alert(data.to);
});
});
</script>
</head>
<body>
<input type="text" id="autocomplete"/>
</body>
</html>
中文支持:
在對中文輸入法打開時,firefox3.0中是對中文拼音的自動匹配,而對輸入后的中文無法及時觸發匹配;而在我的IE6.0下,則無此問題。
原因分析:
Autocomplete插件對用戶輸入字符的觸發自動匹配是通過”keydown”事件進行的(可分析 jquery.autocomplete.js第92行),在IE6中,當輸入法打開時,輸入的字符是不會觸發”keydown”的,只有中文輸入完畢才 觸發之,所以中文輸入和latin文沒有區別的;但在firefox3.0下,無論輸入法打開否,按鍵都會觸發”keydown”事件,所以造成中文輸入 完畢,自動匹配的是剛才打出的部分中文拼音字母。
解決方法:
網上查到的最多做法是修改jquery.autocomplete.js第92行,將”keydown”替換為”keyup”, 但這個不是根本辦法,雖然這樣改后可在firefox中及時對輸入的中文進行自動匹配,但將原插件中回車、tab等重要的事件機制破壞了,比如這樣改后, 如果你的input是在一個form里的話,回車從原來的將選定項輸入到input中變為了直接提交form表單了,這並不是我們想要的。
我的方法原理是,補充一個原插件觸發查詢的事件,就是當input輸入欄發生字符變化時,重新進行查詢(調用其內部的onChange函數),這里 主要針對firefox而言,因為我們的系統訪問最多的是IE和firefox。而恰好firefox有一個input變化的事件就是oninput,那么我們只要在原jquery.autocomplete.js第199行(即$input.bind方法的末尾),插入如下代碼:
.bind("input", function() {
onChange(0, true);
})
來愈: