Jquery ui autocomplete简单api

重要说明：与配置选项类似，Autocomplete插件的方法也不是直接调用，而且通过autocomplete()方法进行间接调用。例如：

$("#title").autocomplete( "方法名", "参数1", "参数2" );

 

Autocomplete的方法列表

close()

 

关闭自动完成显示的菜单。

$( "#title" ).autocomplete( "close" );

 

destroy()

完全移除自动完成功能。

$( "#title" ).autocomplete( "destroy" );

 

disable()

禁用Autocomplete。

$( "#title" ).autocomplete( "disable" );

 

enable()

启用Autocomplete。

$( "#title" ).autocomplete( "enable" );

 

instance()

返回Autocomplete的对象实例。如果指定元素没有关联的实例，则返回undefined。

$( "#title" ).autocomplete( "instance" );

 

option( [ optionName [, value ] ] )

设置或返回Autocomplete的配置选项。该方法有以下4种形式：

// 形式一：以对象形式返回所有配置选项。
var options = $( "#title" ).autocomplete( "option" );

// 形式二：根据选项名称获取单个配置选项
var isDisabled= $( "#title" ).autocomplete( "option", "disabled" );

// 形式三：设置指定配置选项的值
$( "#title" ).autocomplete( "option", "disabled", true );

// 形式四：以对象形式同时设置一个或多个配置选项的值
$( "#title" ).autocomplete( "option", { "disabled": true, "delay": 500 } );

 

search( [ value ] )

触发search事件，如果该事件未被取消的话，Autocomplete将调用数据源来显示菜单。如果没有为其指定value参数，它将当前输入元素的值(指定了的话，就使用指定的value值)。

$( "#title" ).autocomplete( "search", "Chin" );

 

widget()

返回匹配菜单元素的jQuery对象(实际匹配一个div元素，该div内用于放置显示菜单的html内容)。尽管菜单项是即时创建和销毁的，但菜单元素本身并不会重复创建和销毁。它在初始化时被创建，然后一直被重复使用。

$( "#title" ).autocomplete( "widget" );

 

 

 

jQuery UI Autocomplete支持事件处理，我们可以通过为事件绑定处理函数，从而监听并处理对应的事件。

Autocomplete的事件均可以在初始化的时候，以配置选项的形式设置，例如：

$( "#title" ).autocomplete({
  change: function( event, ui ) { /* 这里是函数内的代码 */ }
});

 

你也可以通过jQuery的事件绑定方法，为Autocomplete的指定事件添加处理函数。这使得Autocomplete的事件可以像常见的click、mouseover事件一样，通过jQuery的事件方法进行处理。例如：

// autocompletechange 就是autocomplete插件的change事件
// autocomplete的事件全名均为 "autocomplete"+"具体事件名"

$( "#title" ).on("autocompletechange", function( event, ui ) {
    /* 这里是函数内的代码 */ 
} );

 

Autocomplete的事件列表

change 事件

当输入框失去焦点时，如果其输入内容发生改变，则触发该事件。其事件全名为autocompletechange。

$( "#title" ).autocomplete({
    change: function( event, ui ) {
        // event 是当前事件对象
        
        // ui对象仅有一个item属性，它表示当前选择的菜单项对应的数据源对象
        // 该对象具有label和value属性，以及其它自定义(如果有的话)的属性
        // 如果当前没有选择的菜单项，这item属性为null
    }
});

 

close 事件

当菜单被隐藏(关闭)时触发该事件。其事件全名为autocompleteclose。并不是每一个change事件都伴随着一个close事件。

$( "#title" ).autocomplete({
    close: function( event, ui ) {
        // event 是当前事件对象
        
        // ui对象是空的，只是为了和其他事件的参数签名保持一致
    }
});

 

create 事件

当Autocomplete被创建时触发该事件。其事件全名为autocompletecreate。

$( "#title" ).autocomplete({
    create: function( event, ui ) {
        // event 是当前事件对象
        
        // ui对象是空的，只是为了和其他事件的参数签名保持一致
    }
});

 

focus 事件

当任一菜单项获得焦点时触发该事件，该事件只会在通过键盘交互方式使菜单项获得焦点时触发。其事件全名为autocompletefocus。其默认行为是将输入框的文本内容更改为当前选中项的value属性值。

取消该事件的默认行为( event.preventDefault() )，可以阻止输入框的值被更改，但不会阻止菜单项获得焦点。

$( "#title" ).autocomplete({
    focus: function( event, ui ) {
        // event 是当前事件对象
        
        // ui对象仅有一个item属性，它表示当前获取焦点的菜单项对应的数据源对象
        // 该对象具有label和value属性，以及其它自定义(如果有的话)的属性
    }
});

 

open 事件

当菜单显示(打开)或被更新时触发该事件。其事件全名为autocompleteopen。

$( "#title" ).autocomplete({
    open: function( event, ui ) {
        // event 是当前事件对象
        
        // ui对象是空的，只是为了和其他事件的参数签名保持一致
    }
});

 

response 事件

当自动完成的搜索完成，但尚未显示菜单时触发该事件。其事件全名为autocompleteresponse。你可以通过该事件来更改数据，从而修改显示的菜单内容。

$( "#title" ).autocomplete({
    response: function( event, ui ) {
        // event 是当前事件对象
        
        // ui对象仅有一个content属性，它表示当前用于显示菜单的数组数据
        // 每个元素都是具有label和value属性的对象
        // 你可以对属性进行更改，从而改变显示的菜单内容
    }
});

 

search 事件

当一次自动完成的搜索被执行前触发该事件。其事件全名为autocompletesearch。如果被取消，则不会开始一个请求，并且不会显示菜单项。

$( "#title" ).autocomplete({
    search: function( event, ui ) {
        // event 是当前事件对象
        
        // ui对象是空的，只是为了和其他事件的参数签名保持一致
    }
});

 

select 事件

当任一菜单项被选择时触发该事件。其事件全名为autocompleteselect。其默认行为是将输入框的文本内容更改为当前选中项的value属性值。

取消该事件的默认行为( event.preventDefault() )，可以阻止输入框的值被更改，但不会阻止菜单被关闭。

$( "#title" ).autocomplete({
    select: function( event, ui ) {
        // event 是当前事件对象
        
        // ui对象仅有一个item属性，它表示当前被选中的菜单项对应的数据源对象
        // 该对象具有label和value属性，以及其它自定义(如果有的话)的属性
    }
});