[技术备忘录]javascript 自动完成(jQuery方式) 安羽. 博客园

1)jQuery方式   源码下载

先看下效果

jQuery.autocomplete参数说明： 
url or data：数组或者url 
[options]：可选项，选项解释如下： 
1) minChars (Number) 
在触发autoComplete前用户至少需要输入的字符数，Default:1，如果设为0，在输入框内双击或者删除输入框内内容时显示列表。 
2) width (Number) 
指定下拉框的宽度，Default: input元素的宽度 
3) max (Number) 
autoComplete下拉显示项目的个数，Default: 10 
4) delay (Number) 
击键后激活autoComplete的延迟时间(单位毫秒)，Default: 远程为400 本地10 
5) autoFill (Boolean) 
要不要在用户选择时自动将用户当前鼠标所在的值填入到input框，Default: false 
6) mustMatch (Booolean) 
如果设置为true，autoComplete只会允许匹配的结果出现在输入框,所有当用户输入的是非法字符时将会得不到下拉框，Default:false 
7) matchContains (Boolean) 
决定比较时是否要在字符串内部查看匹配，如ba是否与foo bar中的ba匹配.使用缓存时比较重要.不要和autofill混用.Default: false 
8) selectFirst (Boolean) 
如果设置成true,在用户键入tab或return键时autoComplete下拉列表的第一个值将被自动选择,尽管它没被手工选中(用键盘或鼠标).当然如果用户选中某个项目,那么就用用户选中的值. Default: true 
9) cacheLength (Number) 
缓存的长度.即对从数据库中取到的结果集要缓存多少条记录.设成1为不缓存.Default: 10 
10) matchSubset (Boolean) 
autoComplete可不可以使用对服务器查询的缓存,如果缓存对foo的查询结果,那么如果用户输入foo就不需要再进行检索了,直接使用缓存.通常是打开这个选项以减轻服务器的负担以提高性能.只会在缓存长度大于1时有效.Default: true 
11) matchCase (Boolean) 
比较是否开启大小写敏感开关.使用缓存时比较重要.如果你理解上一个选项,这个也就不难理解,就好比foot要不要到FOO的缓存中去找.Default: false 
12) multiple (Boolean) 
是否允许输入多个值即多次使用autoComplete以输入多个值. Default:false 
13) multipleSeparator (String) 
如果是多选时,用来分开各个选择的字符. Default:"," 
14) scroll (Boolean) 
当结果集大于默认高度时是否使用卷轴显示 Default: true 
15) scrollHeight (Number) 
自动完成提示的卷轴高度用像素大小表示 Default: 180 
16) formatItem (Function) 
为每个要显示的项目使用高级标签.即对结果中的每一行都会调用这个函数,返回值将用LI元素包含显示在下拉列表中.Autocompleter会提供三个参数(row, i, max): 返回的结果数组, 当前处理的行数(即第几个项目,是从1开始的自然数), 当前结果数组元素的个数即项目的个数.Default: none, 表示不指定自定义的处理函数,这样下拉列表中的每一行只包含一个值. 
17) formatResult (Function) 
和formatItem类似,但可以将将要输入到input文本框内的值进行格式化.同样有三个参数,和formatItem一样.Default: none,表示要么是只有数据,要么是使用formatItem提供的值. 
18) formatMatch (Function) 
对每一行数据使用此函数格式化需要查询的数据格式. 返回值是给内部搜索算法使用的. 参数值row 
19) extraParams (Object) 
为后台(一般是服务端的脚本)提供更多的参数.和通常的作法一样是使用一个键值对对象.如果传过去的值是{ bar:4 },将会被autocompleter解析成my_autocomplete_backend.php?q=foo&bar=4 (假设当前用户输入了foo). Default: {} 
20) result (handler) Returns:jQuery 
此事件会在用户选中某一项后触发，参数为： 
event: 事件对象. event.type为result. 
data: 选中的数据行. 
formatted:formatResult函数返回的值 
例如： 
$("#singleBirdRemote").result(function(event, data, formatted){ 
//如选择后给其他控件赋值，触发别的事件等等 
});

页面头部:

<link href="http://www.cnblogs.com/jquery-autocomplete/jquery.autocomplete.css" rel="stylesheet" type="text/css" />
<script src="http://www.cnblogs.com/Scripts/jquery-1.4.4.js" type="text/javascript"></script>
<script src="http://www.cnblogs.com/jquery-autocomplete/jquery.autocomplete.js" type="text/javascript"></script>

javascript代码部分: 

function findValueCallback(event, data, formatted) {
            $("#content_users").html("<strong>" + (!data ? "No match!" : "Selected: " + formatted) + "</strong>");
        }

        $(function () {
//最简单的:(1个参数)
            $("#userid_easy").autocomplete("/share/userids");

//复杂点的:(2个参数)
            $("#userid").autocomplete("/share/userids", { minChars: 0,
                max: 5,
                autoFill: true,
                mustMatch: true,
                matchContains: true,
                scrollHeight: 220,
                formatItem: function (data, i, total) {
//debugger;
return "<I>" + data[0] + "</I>";
                },
                formatMatch: function (data, i, total) {
//debugger;
return data[0];
                },
                formatResult: function (data) {
//debugger;
return data[0];
                }
            }).result(function (event, data, formatted) {
                $("#content_userid").html("<strong>" + (!data ? "No match!" : "Selected: " + formatted) + "</strong>");
            });

//再复杂点的:(2个参数)
            $.get("/share/users",null, function (json, state, xhr) {
debugger;
                $("#users").autocomplete(json, { minChars: 0,
                    max: 5,
                    autoFill: true,
                    mustMatch: false,
                    matchContains: true,
                    scrollHeight: 220,
                    formatItem: function (data, i, total) {
//debugger;
return "<I>" + data.UserID + " " + data.UserName + "</I>";
                    },
                    formatMatch: function (data, i, total) {
//debugger;
return data.UserID + " " + data.UserName;
                    },
                    formatResult: function (data) {
//debugger;
return data.UserID
                    }
                });
                $("#users").result(findValueCallback);

            }, "json");

        });

 页面body部分 

<div>最简单的:(1个参数)<input id="userid_easy" type="text" /></div>

<div>复杂点的:(2个参数)<input id="userid" type="text" /><br />
<div id="content_userid" ></div>
</div>

<div>再复杂点的:(2个参数)
<input id="users" type="text" /><br />
<div id="content_users" ></div>
</div>

控制器部分:

public class ShareController : Controller
    {
private YanziMisEntities db = null;
//
// GET: /Share/
public ShareController()
        {
if(db==null) db=new YanziMisEntities();
        }

public ActionResult UserIDs()
        {
            var userIDs = from u in db.Users
                        select u.UserID.Trim();

return Json(userIDs, JsonRequestBehavior.AllowGet);
        }

public ActionResult Users()
        {
            var users = from u in db.Users
                        select new { UserID = u.UserID.Trim(), UserName = u.UserName.Trim() };

return Json(users, JsonRequestBehavior.AllowGet);
        }
    }

关于使用jquery.autocomplete插件几点注意:

通过看jquery.autocomplete源代码分析 此插件使用2种方式取得数据,并组装成为用于辅助用户自动完成输入的数据列表项.

1)第一种是javascript数组

这种方式最简单,没什么需要特别说明的,唯一的要求可能是数据类型需是javascript数组,至于能不能是指定特征字符串读者你自己看源码试下就知道了.

2)第二种是通过url的get请求服务端数据

 这种方式需要讲明的是:

      a)服务端返回json时需要求指定参数JsonRequestBehavior.AllowGet,不然提示"此请求已被阻止，因为当用在 GET 请求中时，会将敏感信息透漏给第三方网站。若要允许 GET 请求，请将 JsonRequestBehavior 设置为 AllowGet。"

      b) get请求服务端数据必需是指定分割符的字符串 看源码分析得到分割符是这样的:行分割符为"\n",行中的项的分割符为"|".所以服务端返回json时需要按要求拼接字串.如果不按要求,没有自动完成功能的也罢,可还提示有错(如下图):

使用asp.net mvc(asp.net webform) 服务端返回json时默认返回的是json对象数组,这是多么标准、优美的数据组织结构，但还要使用foreach/for循环拆开再拼接真有点不"仁道",最可恨想每个想使用自动完成功能地方用了url请求服务端的方法(或服务等)都得重写拆开再拼接的代码,还好有源码,让我们毁掉这个万恶之源的出处吧.

需要修改的位置:

function parse(data) {
var parsed = [];
var rows= data.split("\n");//修改这行

for (var i=0; i < rows.length; i++) {
var row = $.trim(rows[i]);
if (row) {
            row = row.split("|");            parsed[parsed.length] = {
                data: row,
                value: row[0],
                result: options.formatResult && options.formatResult(row, row[0]) || row[0]
            };
        }
    }
return parsed;
};

修改后的代码

function parse(data) {
var parsed = [];
var rows=$.isArray(data)?data:data.split("\n");
    for (var i=0; i < rows.length; i++) {
var row = $.trim(rows[i]);
if (row) {
                row = row.split("|");
                parsed[parsed.length] = {
                    data: row,
                    value: row[0],
                    result: options.formatResult && options.formatResult(row, row[0]) || row[0]
                };
            }
        }
return parsed;
    };

现在不用拆也不用拼接字符了,直接Json(...)或JavaScriptSerializer.Serialize(...),然后$("#inputextid").autocomplete(url);就OK的了.

提示:别只修改jquery.autocomplete.js却使用了jquery.autocomplete.min.js或jquery.autocomplete.pack.js.

还好这3个文件我均修改了,下载直接使用就好了. 

题外话:jQuery.UI也有Autocomplete插件,可惜功能不怎么样,还引用UI\UI Widget\Position这三个插件变笨重功能还不怎么样,跟asp.net ajax toolkit的autocomplete差不多.

分类: c#, jQuery, Web

绿色通道：好文要顶关注我收藏该文与我联系

安羽.
关注 - 4
粉丝 - 8

查看全文