jquery autocomplete參數說明

jquery-autocomplete學習

1、用前必備

官方網站：http://bassistance.de/jquery-plugins/jquery-plugin-autocomplete/

當前版本：1.0.2

須要JQuery版本：1.2.6

2、使用

<script src="./jquery-1.3.2.js" type="text/javascript"></script>

<script src="./jquery.autocomplete.js" type="text/javascript"></script>

<link rel="stylesheet" href="./jquery.autocomplete.css" />

autocomplete( url or data, options ) Returns: jQuery

讓一個input或textarea有autocomplete功能

例子

Js代碼

var data = "Core Selectors Attributes Traversing Manipulation CSS Events Effects Ajax Utilities".split(" ");  

$("#example").autocomplete(data);

以上的例子就是爲id爲example添加autocomplete

var emails = [

    { name: "Peter Pan", to: "peter@pan.de" },

    { name: "Molly", to: "molly@yahoo.com" },

    { name: "Forneria Marconi", 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" }

];

//emails的數組格式如上，formatItem表明的是顯示的格式，formatMatch表示匹配的內容，formatResult表示結果的內容

$("#suggest13").autocomplete(emails, {

    minChars: 0,

    width: 310,

    matchContains: true,

    autoFill: false,

    formatItem: function(row, i, max) {

        return i + "/" + max + ": \"" + row.name + "\" [" + row.to + "]";

    },

    formatMatch: function(row, i, max) {

        return row.name + " " + row.to;

    },

    formatResult: function(row) {

        return row.to;

    }

});

3、參數說明：

* 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) {

//如選擇後給其餘控件賦值，觸發別的事件等等

});

4、注意問題：

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解決中文亂碼的問題的