jquery.autocomplete 使用解析

頁面引用

 <script type="text/javascript" src="${base}/autocom/jquery-1.8.2.min.js"></script>
<script type="text/javascript" src="${base}/autocom/jquery.mockjax.js"></script>
<script type="text/javascript" src="${base}/autocom/jquery.autocomplete.js"></script>

這些是自動填充必須的包。

 

 

然后就開始了自動填充的路程~

剛剛下載的里面有最原始的demo 就不多說了。

還有一種簡單的

就是頁面直接定義數組

然后獲取；

簡單的demo：

<script type="text/JavaScript">
  $(function(){
 var vaArray = new Array('aaa','a11','bb');
  $('#orgNameCom').autocomplete({
        minChars: 1,
        maxHeight:300,
        lookup: vaArray,
    //  serviceUrl: '${base}/getAutoCom.action',
    //  params: { orgNameCom:$('#orgNameCom').val()},
        onSelect: function (suggestion) {
        //   immediately( document.getElementById("orgNameCom")  ,'5','orgNameCom','orgName'); // 我自己程序的方法 不需要用
        //  alert('You selected: ' + suggestion.value + ', ' + suggestion.data);
        },
        //showNoSuggestionNotice: true,
        //noSuggestionNotice: 'Sorry, no matching results'
    });
 })

</script>

                <input id="orgNameCom" name="ent.orgName" type="text" class="edit_input" value="" size="30" >

效果圖：

 

lookup: vaArray,  這句話是說使用本地的數組（如上 本地new的一個vaArray）。

 serviceUrl : 若是用ajax調用后台收取數據 就需要使用這個參數，后面跟上你的地址；

maxHeight:300,  這個是指你出來的下面的下拉框的最大高度。

//showNoSuggestionNotice: true,
//noSuggestionNotice: 'Sorry, no matching results'

這兩句是說 如果沒有匹配的，提示信息效果如下：

minChars: 1,  這個是說你輸入幾個字符后開始匹配，一般默認為1；

params 這個是傳入的參數，和ajax傳參基本一樣，不許多說；

onSelect: 這是會回調函數，就是你選中后，執行的，其中suggestion.value    ，  suggestion.data 就是你后台封裝進去的值。

 

 

 

需要特別說明的是 利用ajax獲取數據的時候

后台ajax的格式必須是：

{
                // Query is not required as of version 1.2.5
                "query": "Unit",
                "suggestions": [
                    { "value": "United Arab Emirates", "data": "AE" },
                    { "value": "United Kingdom",       "data": "UK" },
                    { "value": "United States",        "data": "US" }
                ]
            }

這樣格式的。

 

 

哦，忘記說了 query是這個js封裝的一個默認值（跟一下源碼就可以知道），他就是你input當前輸入的值。

所以需要根據當前輸入框的值去后台查詢顯示，就可以直接用query；

然后看一下我后台的寫法

 

 

public String getAutoCom() throws IOException{
      if(query!=null&&!"".equals(query)){
          List<CommonOrganization > comList  = ((BaseTransaction)Platform.getInstance().getBean("baseTransaction")).find("from CommonOrganization where orgName like '%"+query+"%' and ifDel = '1'   and ifAudit='3'");
          HttpServletResponse response = (HttpServletResponse)ActionContext.getContext().get(ServletActionContext.HTTP_RESPONSE);
          response.setContentType("application/json;charset=UTF-8");
          response.setHeader("Pragma", "No-cache");
          response.setHeader("Cache-Control", "no-cache");
          response.setDateHeader("Expires", 0);
          response.setHeader("content-type", "text/html;charset=utf-8");
          JSONObject json =new JSONObject();
         List<OrgnameCom> listOrg = new ArrayList<OrgnameCom>();
         for(  int i = 0 ; i < comList.size();i++ ){
              CommonOrganization common = comList.get(i);
             OrgnameCom com = new OrgnameCom();
             com.setValue(common.getOrgName());
             com.setData(common.getId());
             listOrg.add(com);
             if(i==9){
                 break;
             }
         }
         JSONArray jsonArray =  JSONArray.fromObject(listOrg);
         json.put("query", query);
         json.put("suggestions", jsonArray);
         response.getWriter().print(json);


      }
     return null;
 }

這是根據我自己項目寫的，最重要的是后面的，這個插件顯示的值會是你的data所以data是必須有的，query是我取的他們封裝好的，因為我只用根據用戶輸入的去取值。

 

結果如下：

 

這些數據都是我從數據庫里面獲取的。

需要說明的是，你自己輸入中文查詢的時候 發現傳到后台的是亂碼。因為他們的源碼中用了get的提交方式，

你需要改為post，

在jQuery.autocomplete.js 文件中

改為post就好了。

 

 

 

 

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

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

});

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

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

});

 

我的案例：

　　html

　　　　

<input id="yufa_type_show"  placeholder="搜索其他語法點" type="text" value="" >

　　js

$(function(){
    $('#yufa_type_show').autocomplete({
        minChars: 1,
        maxHeight:260,
        width:245,
        serviceUrl: '?m=grammar&c=index&a=new_tip_yufa_type',
        params: { orgNameCom:$('#yufa_type_show').val()},
        onSelect: function (suggestion) {
            $("#yufa_type_show").val(suggestion.data);
        },
        showNoSuggestionNotice: true,
        noSuggestionNotice: 'Sorry, no matching results'
    });
})

　php

 

　　

public function new_tip_yufa_type(){
        $k=trim($_GET["query"]);
        $sug='';
        $dat='';

        $where="ename like '%".$k."%' or cname like '%".$k."%'";

        $k12_yufa_type_db=pc_base::load_model('grammar_model');
        $rows=$k12_yufa_type_db->select($where);

        foreach($rows as $row){
            $sug="".$row["ename"]."  ".$row["cname"]."";
            $dat="".$row["id"]."";

            $val.= "{\"value\":\"".$sug."\",\"data\":\"".$dat."\"},";
        }
        $val = substr($val,0,-1);


        echo "{
            \"query\": \"".$k."\",
             \"suggestions\": [
                    ".$val."
                ]
            }";

    }