<form id="ff" method="post">
...
</form>
$('#ff').form({
url:...,
onSubmit: function(){
//进行表单验证
//如果返回false阻止提交
},
success:function(data){
alert(data)
}
});
//提交表单
$('#ff').submit();
普通方式提交
//调用表单插件的'submit'方法提交
$('#ff').form('submit', {
url:...,
onSubmit: function(){
//进行表单验证
//如果返回false阻止提交
},
success:function(data){
alert(data)
}
});
| 名称 | 类型 | 描述 | 默认值 |
|---|---|---|---|
| url(目标网址) | string(字符串) | 表单提交的目标网址 | null |
| 名称 | 参数 | 描述 |
|---|---|---|
| onSubmit | none | 在表单提交之前触发,返回false将阻止表单提交。 |
| success | data | 当表单成功提交时触发。 |
| onBeforeLoad | param | 在发送载入远程数据请求之前触发,返回false将取消请求。 |
| onLoadSuccess | data | 在表单数据被载入时触发。 |
| onLoadError | none | 在载入表单数据发生错误时触发。 |
| 名称 | 参数 | 描述 |
|---|---|---|
| submit | options | 执行表单提交,options参数是一个包含以下属性的对象: url:表单提交的目标网址 onSubmit:在表单提交之前执行的回调函数 success: 在表单成功提交后执行的回调函数 |
| load | data | 载入记录填充表单。 data参数可以是字符串或者对象类型,当传入字符串时,data参数必须是一个远程url地址,否则用户必须自定义要载入的数据 |
| clear | none | 清除表单数据 |
| validate | none | 执行表单域验证,如果全部表单域有效返回true,该方法与表单验证插件一起使用。 |
使用$.fn.validatebox.defaults重载默认值。
<input id="vv" required="true" validType="email">
$('#vv').validatebox({
required:true
});
验证规则使用required和validType属性来定义, 以下列出的是插件内置的验证规则。
要自定义规则,重载$.fn.validatebox.defaults。你所定义的验证规则必须定义一个验证函数和验证无效时的提示信息。 例如,定义一个验证最小长度的规则:
$.extend($.fn.validatebox.defaults.rules, {
minLength: {
validator: function(value, param){
return value.length >= param[0];
},
message: 'Please enter at least {0} characters.'
}
});
现在你可以使用最小长度验证规则来定义一个至少要输入5个字符的输入框。
<input class="easyui-validatebox" validType="minLength[5]">
| 名称 | 类型 | 描述 | 默认值 |
|---|---|---|---|
| required(必填) | boolean(布尔型) | 定义表单域必须填写。 | false |
| validType(验证类型) | string(字符串) | 定义表单域的验证类型,比如:email, url等。 | null |
| missingMessage(未填提示) | string(字符串) | 当表单域未填写时出现的提示信息。 | This field is required. |
| invalidMessage(无效提示) | string(字符串) | 当表单域的内容被验证为无效时出现的提示。 | null |
| 名称 | 参数 | 描述 |
|---|---|---|
| destroy | none | 移除并注销组件。 |
| validate | none | 验证表单域的内容是否有效。 |
| isValid | none | 调用validate方法并且返回验证结果,true或者false。 |
继承$.fn.validatebox.defaults,使$.fn.combo.defaults重载。
<input id="cc" value="001"> <select id="cc"></select >
$('#cc').combo({
required:true,
multiple:true
});
| 名称 | 类型 | 描述 | 默认值 |
|---|---|---|---|
| width(宽度) | number(数字) | 组合框的宽度。 | auto |
| panelWidth(下拉框宽度) | number(数字) | 下拉框的宽度。 | null |
| panelHeight(下拉框高度) | number(数字) | 下拉框的高度。 | 200 |
| multiple(可多选) | boolean(布尔型) | 定义是否支持多选。 | false |
| separator(分隔条) | string(字符串) | 当支持多选时,用以分隔文本的字符。 | , |
| editable(可编辑) | boolean(布尔型) | 定义用户是否可以直接向组合框输入内容。 | true |
| disabled(禁用) | boolean(布尔型) | 定义是否禁用输入框。 | false |
| hasDownArrow(下拉图标) | boolean(布尔型) | 定义是否显示下拉按钮。 | true |
| value(值) | string(字符串) | 默认值。 | |
| delay(延迟) | number(数字) | 最后一次输入事件与搜索(自动完成)之间的延迟间隔。 | 200 |
| keyHandler(按键助手) | object(对象) |
当用户按下一个键位时调用的函数,默认的按键助手定义如下:
keyHandler: {
up: function(){},
down: function(){},
enter: function(){},
query: function(q){}
}
|
| 名称 | 参数 | 描述 |
|---|---|---|
| onShowPanel | none | 当显示下拉面板的时候触发。 |
| onHidePanel | none | 当隐藏下拉面板的时候触发。 |
| onChange | newValue, oldValue | 当组合框的值发生改变时触发。 |
| 名称 | 参数 | 描述 |
|---|---|---|
| options | none | 返回属性对象。 |
| panel | none | 返回下拉面板对象。 |
| textbox | none | 返回文本框对象。 |
| destroy | none | 销毁组件。 |
| resize | width | 调整组件的宽度。 |
| showPanel | none | 显示下拉面板。 |
| hidePanel | none | 隐藏下拉面板。 |
| disable | none | 禁用组合框。 |
| enable | none | 启用组合框。 |
| validate | none | 验证输入的值。 |
| isValid | none | 返回验证结果。 |
| clear | none | 清除组件的值。 |
| getText | none | 获取组合框的值。 |
| setText | text | 设置组合框的值。 |
| getValues | none | 返回一个存储下拉面板值的数组。 |
| setValues | values | 设置下拉面板的值,参数values是一个数组。 |
| getValue | none | 获取下拉面板的值。 |
| setValue | value | 设置下拉面板的值。 |
继承$.fn.combo.defaults,使用$.fn.combobox.defaults重载默认值。
<select id="cc" name="dept" style="width:200px;">
<option value="aa">aitem1</option>
<option>bitem2</option>
<option>bitem3</option>
<option>ditem4</option>
<option>eitem5</option>
</select>
<input id="cc" name="dept" value="aa">
$('#cc').combobox({
url:'combobox_data.json',
valueField:'id',
textField:'text'
});
json数据转换示例:
[{
"id":1,
"text":"text1"
},{
"id":2,
"text":"text2"
},{
"id":3,
"text":"text3",
"selected":true
},{
"id":4,
"text":"text4"
},{
"id":5,
"text":"text5"
}]
继承自定义组合框的属性, 以下是可装载组合框的独有属性。
| 名称 | 类型 | 描述 | 默认值 |
|---|---|---|---|
| valueField(值域) | string(字符串) | 绑定到组合框下的数据的值域的名称。 | value |
| textField(文本域) | string(字符串) | 绑定到组合框下数据的文本域的名称。 | text |
| mode(模式) | string(字符串) | 定义当文本发生改变时,如何载入数据列表。如果组合框要从远程地址载入数据,设置为'remote'。 | local |
| url(超链接地址) | string(字符串) | 可供载入数据列表的远程地址。 | null |
| method(方法) | string(字符串) | 获取数据的HTTP方法。 | post |
| data(数据) | array(数组) | 将被载入的数据列表。 | null |
| filter(过滤器) | function(函数) | 定义当模式设置为'local'时如何过滤本地数据,function有2个参数: q: 用户输入的文本。 row: 数据列表 返回true将允许显示数据列表。 |
|
| formatter(格式) | function(函数) | 定义如何返回数据,function有一个参数:row。 |
事件继承自定义组合框,以下是可装载组合框的独有事件。
| 名称 | 参数 | 描述 |
|---|---|---|
| onLoadSuccess | none | 当远程数据载入成功时触发。 |
| onLoadError | none | 当远程数据载入错误时触发。 |
| onSelect | record | 当用户选择一个列表项时触发。 |
| onUnselect | record | 当用户取消选择一个列表项时触发。 |
方法继承自定义组合框,以下是可装载组合框独有的或者重载自定义组合框的方法。
| 名称 | 参数 | 描述 |
|---|---|---|
| options | none | 返回属性对象。 |
| getData | none | 返回已载入的数据。 |
| loadData | data | 载入本地数据列表。 |
| reload | url | 请求远程数据列表。 |
| setValues | values | 设置组合框的值,参数values是一个数组。 |
| setValue | value | 设置组合框的值。 |
| clear | none | 清除组合框的值。 |
| select | value | 选择特定的项目。 |
| unselect | value | 取消选择特定的项目。 |
继承$.fn.combo.defaults和$.fn.tree.defaults,使用$.fn.combotree.defaults重载默认值。
<select id="cc" style="width:200px;"></select>
<input id="cc" value="01">
$('#cc').combotree({
url:'tree_data.json'
});
属性继承自定义组合框和树形菜单,以下是组合树重载的属性。
| 名称 | 类型 | 描述 | 默认值 |
|---|---|---|---|
| editable(可编辑) | boolean(布尔型) | 定义用户是否可以直接输入。 | false |
事件继承自定义组合框和树形菜单
方法继承自定义组合框,以下是组合树独有的或者重载自定义组合框的方法。
| 名称 | 参数 | 描述 |
|---|---|---|
| options | none | 返回属性对象。 |
| tree | none | 返回树形菜单对象。 |
| loadData | data | 载入本地树形菜单数据。 |
| reload | url | 再次向远程树形菜单数据发起请求。 |
| clear | none | 清除组件值。 |
| setValues | values | 设置组合框的值,参数values是一个数组。 |
| setValue | value | 设置组合框的值。 |
继承$.fn.combo.defaults和$.fn.datagrid.defaults,使用$.fn.combogrid.defaults重载默认值。
<select id="cc" name="dept" style="width:250px;"></select>
<input id="cc" name="dept" value="01">
$('#cc').combogrid({
panelWidth:450,
value:'006',
idField:'code',
textField:'name',
url:'datagrid_data.json',
columns:[[
{field:'code',title:'Code',width:60},
{field:'name',title:'Name',width:100},
{field:'addr',title:'Address',width:120},
{field:'col4',title:'Col41',width:100}
]]
});
属性继承自定义组合框和数据表格,以下是组合表格独有的属性。
| 名称 | 类型 | 描述 | 默认值 |
|---|---|---|---|
| loadMsg(载入时信息) | string(字符串) | 当数据表格载入远程数据时的提示信息。 | null |
| idField(id字段) | string(字符串) | 标识表格行数据唯一性的字段名。 | null |
| textField(文本域) | string(字符串) | 显示在文本框中的文本域的名称。 | null |
| mode(模式) | string(字符串) | 定义当文本发生改变时如何载入组合表格的数据。如果组合表格要从远程服务器载入数据,设置为'remote'。 | local |
| filter(过滤器) | function(q, row) | 定义当模式设置为'local'时如何选择本地数据,返回true将选择一行。 |
事件继承自定义组合框和数据表格。
方法继承自定义组合框,以下是组合表格独有的或者重载自定义组合框的方法。
| 名称 | 参数 | 描述 |
|---|---|---|
| options | none | 返回属性对象。 |
| grid | none | 返回数据表格对象。 |
| setValues | values | 设置组合框的值,参数values是一个数组。 |
| setValue | value | 设置组合框的值 |
| clear | none | 清除组合框的值。 |
继承$.fn.validatebox.defaults,使用$.fn.numberbox.defaults重载默认值。
<input id="nn" value="01">
$('#nn').numberbox({
min:0,
precision:2
});
属性继承表单验证,以下是数字验证框的独有属性。
| 名称 | 类型 | 描述 | 默认值 |
|---|---|---|---|
| disabled(禁用) | boolean(布尔型) | 定义是否禁用输入框。 | false |
| min(最小值) | number(数字) | 允许的最小值。 | null |
| max(最大值) | number(数字) | 允许的最大值。 | null |
| precision(精度) | number(数字) | 精确到小数点后的最大位数。 | 0 |
方法继承表单验证,以下是数字验证独有的或者重载表单验证的方法。
| 名称 | 参数 | 描述 |
|---|---|---|
| disable | none | 禁用输入框。 |
| enable | none | 启用输入框。 |
| fix | none | 将输入框的值修正为一个有效值。 |
继承$.fn.combo.defaults,使用$.fn.datebox.defaults重载默认值。
<input id="dd" value="01">
$('#dd').datebox({
required:true
});
属性继承自定义组合框,以下是日期组合框独有的属性。
| 名称 | 类型 | 描述 | 默认值 |
|---|---|---|---|
| panelWidth(面板宽度) | number(数字) | 下拉日历面板的宽度。 | 180 |
| panelHeight(面板高度) | number(数字) | 下拉日历面板的高度。 | auto |
| currentText(当前文本) | string(字符串) | 显示在日历左下角用以选择今天日期的按钮上的文本。 | Today |
| closeText(关闭) | string(字符串) | 显示在关闭按钮上的文本。 | Close |
| okText(OK按钮文本) | string(字符串) | 显示在OK按钮上的文本。 | Ok |
| disabled(禁用) | boolean(布尔型) | 当设置为true时禁用输入框。 | false |
| formatter(格式) | function(函数) | 一个格式化日期的函数,该函数的参数是一个被选择的日期并且一个字符串。 | |
| parser(解析器) | function(函数) | 一个解析日期的字符串,该函数的参数是一个被选择的日期并且返回一个解析后的日期值。 |
| 名称 | 参数 | 描述 |
|---|---|---|
| onSelect | date | 当用户选择日期时触发。 |
方法继承表单验证,以下是数字验证独有的或者重载表单验证的方法。
| 名称 | 参数 | 描述 |
|---|---|---|
| options | none | 返回属性对象。 |
| calendar | none | 获取日历对象。 |
| setValue | value | 设置日期组合框的值。 |
继承$.fn.combo.defaults,使用$.fn.datebox.defaults重载默认值。
<input id="dt" value="01">
$('#dt').datetimebox({
showSeconds:false
});
属性继承日期组合框,以下是日期时间组合框独有的属性。
| 名称 | 类型 | 描述 | 默认值 |
|---|---|---|---|
| showSeconds(显示秒) | boolean(布尔型) | 定义是否显示秒数信息。 | true |
| timeSeparator | string(文本型) | 选项允许用户定义的时间分隔符。这个属性从1.3版本可用。 | : |
方法继承日期组合框,以下是重载日期组合框的方法。
| 名称 | 参数 | 描述 |
|---|---|---|
| options | none | 返回属性对象。 |
| spinner | none | 返回时间调节器对象。 |
| setValue | value | 设置日期时间组合框的值。 |
使用$.fn.calendar.defaults重载默认值。
<div id="cc" style="width:180px;height:180px;"></div>
$('#cc').calendar({
width:600,
height:600,
current:new Date()
});
| 名称 | 类型 | 描述 | 默认值 |
|---|---|---|---|
| width(宽度) | number(数字) | 日历组件的宽度。 | 180 |
| height(高度) | number(数字) | 日历组件的高度。 | 180 |
| fit(铺满浏览器) | boolean(布尔型) | 当设置为true时,日历组件的大小将铺满装载它的父容器(浏览器)。 | false |
| border(边框) | boolean(布尔型) | 定义是否显示边框。 | true |
| weeks(星期代码列表) | array(数组) | 显示星期几的代码列表。 | ['S','M','T','W','T','F','S'] |
| months(月份代码列表) | array(数组) | 显示月份的代码列表。 | ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'] |
| year(年份) | number(数字) | 日历组件的起始年份 | 当前年份(4位数字) |
| month(月份) | number(数字) | 日历组件默认显示的月份。 | 当前月份,从1开始。 |
| current(当前日期) | Date(日期) | 当前日期。 | 当前日期。 |
| 名称 | 参数 | 描述 |
|---|---|---|
| onSelect | date | 当用户选择日期的时候触发。 |
| 名称 | 参数 | 描述 |
|---|---|---|
| options | none | 返回属性对象。 |
| resize | none | 重置日历的大小。 |
| moveTo | date | 将日历设置到一个指定的日期。 |
继承$.fn.validatebox.defaults,使用$.fn.spinner.defaults重载默认值。
<input id="ss" value="2">
$('#ss').spinner({
required:true,
increment:10
});
属性继承表单验证,以下是调节器的独有属性。
| 名称 | 类型 | 描述 | 默认值 |
|---|---|---|---|
| width(宽度) | number(数字) | 组件的宽度 | auto |
| value(值) | string(字符串) | 初始值。 | |
| min(最小值) | string(字符串) | 允许的最小值。 | null |
| max(最大值) | string(字符串) | 允许的最大值。 | null |
| increment(增量) | number(数字) | 当点击调节器按钮时的增量值。 | 1 |
| editable(可编辑) | boolean(布尔型) | 定义用户是否可以直接输入。 | true |
| disabled(禁用) | boolean(布尔型) | 定义是否禁用输入框。 | false |
| spin(调节函数) | function(down) | 当用户点击调节按钮时调用的函数。 |
| 名称 | 参数 | 描述 |
|---|---|---|
| onSelect | date | 当用户选择日期的时候触发。 |
| 名称 | 参数 | 描述 |
|---|---|---|
| onSpinUp | none | 当用户点击增加按钮时触发。 |
| onSpinDown | none | 当用户点击减少按钮时触发。 |
方法继承表单验证,以下是调节器独有的方法。
| 名称 | 参数 | 描述 |
|---|---|---|
| options | none | 返回属性对象。 |
| destroy | none | 销毁组件。 |
| resize | width | 调整组件宽度。 |
| enable | none | 启用组件。 |
| disable | none | 禁用组件。 |
| getValue | none | 获取组件的值。 |
| setValue | value | 设置组件的值。 |
| clear | none | 清除组件的值。 |
继承$.fn.validatebox.defaults,使用$.fn.spinner.defaults重载默认值。
<input id="ss" min="10" max="100" required="true" style="width:80px;" >
$('#ss').numberspinner({
editable:false
});
属性继承调节器和数字验证框。
事件继承调节器。
方法继承调节器,以下是重载调节器的方法。
| 名称 | 参数 | 描述 |
|---|---|---|
| options | none | 返回属性对象。 |
| setValue | value | 设置数字调节器的值。 |
继承$.fn.spinner.defaults,使用$.fn.timespinner.defaults重载默认值。
<input id="ss" required="true" style="width:80px;" >
$('#ss').timespinner({
showSeconds:true
});
属性继承调节器,以下是重载调节器的属性。
| 名称 | 类型 | 描述 | 默认值 |
|---|---|---|---|
| separator(分隔符) | string(字符串) | 时分秒直接的分隔符号。 | : |
| showSeconds(显示秒数) | boolean(布尔型) | 定义是否显示描述信息。 | false |
| highlight(高亮) | number(数字) | 显示高亮背景的时间要素,0=时,1=分,… | 0 |
事件继承调节器。
方法继承调节器,以下是重载调节器的方法。
| 名称 | 参数 | 描述 |
|---|---|---|
| options | none | 返回属性对象。 |
| setValue | value | 设置时间调节器的值。 |
| getHours | none | 获取当前小时的值。 |
| getMinutes | none | 获取当前分钟的值。 |
| getSeconds | none | 获取当前秒钟的值。 |