jQuery插件autocomplate的简单使用笔记

转http://phpff.com/430.html

js代码：

复制代码 代码如下:

<SCRIPT language=javascript src="../../js/jquery.js" type=text/javascript>

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

<SCRIPT language=javascript type=text/javascript>

$(document).ready(function(){

/*这里做的是一个简单的检索姓名的自动完成程序*/

$('#key_name').autocomplete('doctor_list.php',{

/*此处是请求的地址*/

width: 150,

/*此处是自动提示框的宽度*/

matchContains: true,

/*是否使用内部比较(匹配单词的一部分)*/

selectFirst: false,

/*如果这个设置为true,第一个autocomplete值将 被自动通过tab/回车选择,即使没有通过键盘或鼠标精选选择 */

extraParams: {name:function(){return $("#key_name").val();},action:"getAjaxInfo"}

/*这个extraParams是后端的附加参数，以这个为例，name是请求的地址中的参数，默认是以GET方式，action:"getAjaxInfo"这个也是GET传递的参数，完整的请求地址如下 doctor_list.php?action=getAjaxInfo&name=表单数据了*/

});

</SCRIPT>
HTML代码中只有：

<input id="key_name" style="width: 150px;" type="text" name="key_name" />

下面是php代码：

复制代码 代码如下:

if($_GET['action'] == 'getAjaxInfo'){

//这里由于我写其它应用了，如果单纯做这一个自动完成，可以写简单一点

if($_GET['name'] != ''){

$field = 'name';

}

if($field != ''){

$val = $_GET['$field'];

$sql = "select `$field` from doctor_info where $field like '%$val%'";

$rst = $aa->execute($sql);

while($row = mysql_fetch_array($rst)){

echo $row[0]."n";

}

}

exit;

}
直接运行即可实现 。

三、参数说明：

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

//如选择后给其他控件赋值，触发别的事件等等

});

下面贴出来autocomplate的一些公共用法，从别的站上面粘过来的，参考方便

属性	类型	描述	定义在
actionPrefix	string	actionsID的前缀.	CWidget
attribute	string	这个widget相关的属性.	CInputWidget
autoFill	boolean	选择一个值时自动填充textinput, 替换已经键入的或选择的值.	CAutoComplete
cacheLength	integer	存储在cache中的后台查询结果的数目.	CAutoComplete
controller	CController	返回这个小物件所属的controller.	CWidget
cssFile	mixed	这个widget使用的CSS文件.	CAutoComplete
data	array	保存在客户端提供候选选择项的数据.	CAutoComplete
delay	integer	当键入后,autocompleter等待多少毫秒激活 .	CAutoComplete
extraParams	array	后端的附加参数.	CAutoComplete
formatItem	string	为一个item提供高级标记的javascript函数.	CAutoComplete
formatMatch	string	用来限制autocomplete搜索匹配的数据的javascript函数 .	CAutoComplete
formatResult	string	在结果放入input字段前,提供格式化值的javascript函数 .	CAutoComplete
highlight	boolean|string	是否在选择框中高亮匹配.	CAutoComplete
htmlOptions	array	被渲染到input tag的附加HTML选项.	CInputWidget
id	string	返回本小物件(widget)的ID或如果请求的话生成一个新的.	CWidget
inputClass	string	input元素的CSS类.	CAutoComplete
loadingClass	string	当数据从后端载入时使用的CSS类.	CAutoComplete
matchCase	boolean	是否比较时大小写敏感.	CAutoComplete
matchContains	boolean	是否使用内部比较(匹配单词的一部分) (i.	CAutoComplete
matchSubset	boolean	是否autocompleter为更多的指定查询使用缓存 .	CAutoComplete
max	integer	select box的item数目.	CAutoComplete
methodChain	string	被附加到autocomplete构造函数后的方法链调用.	CAutoComplete
minChars	integer	用户必须键入的最少字符数 在autocompleter激活之前.	CAutoComplete
model	CModel	这个widget相关的数据模型.	CInputWidget
multiple	boolean	是否允许超过一个autocompleted-value输入.	CAutoComplete
multipleSeparator	string	当使用多个选项时,选项之间的分隔符.	CAutoComplete
mustMatch	boolean	如果设置为true,autocompleter将仅仅允许结果通过后端呈现 .	CAutoComplete
name	string	input 名称.	CInputWidget
options	array	传递到autocomplete js 对象的构造函数的附加选项.	CAutoComplete
owner	CBaseController	返回这个小物件的所有者/创造者.	CWidget
resultsClass	string	下拉列表的CSS类.	CAutoComplete
scroll	boolean	当更多的结果超过scrollHeight设置的高度时,是否滚动.	CAutoComplete
scrollHeight	integer	autocomplete的举动高度(用像素)s.	CAutoComplete
selectFirst	boolean	如果这个设置为true,第一个autocomplete值将 被自动通过tab/回车选择,即使没有通过键盘或鼠标精选选择 .	CAutoComplete
skin	mixed	这个widget使用的皮肤名称.	CWidget
textArea	boolean	是否使用一个text area显示autocomplete.	CAutoComplete
url	string|array	返回候选选项的URL.	CAutoComplete
value	string	input值	CInputWidget
viewPath	string	返回这个物件包含视图文件的目录.	CWidget
width	integer	指定select box的自定义宽度.	CAutoComplete