ESUI - Checkbox and Radio


Table of Contents

1. BoxGroup
1.1. 说明
1.2. 公共实例方法
2. CheckBox
2.1. 继承层级
2.2. 说明
2.3. 初始化参数
2.4. 公共实例方法
2.5. 事件
3. Radio
3.1. 继承层级
3.2. 说明
3.3. 初始化参数
3.4. 公共实例方法
3.5. 事件

List of Tables

1.1. 公共实例方法
2.1. 初始化参数
2.2. 公共实例方法
2.3. 事件
3.1. 初始化参数
3.2. 公共实例方法
3.3. 事件

Chapter 1. BoxGroup

1.1. 说明

BoxGroup用于处理CheckBox与Radio的分组行为。

分组行为描述:自动通过name属性来进行分组。如果控件位于某个form下,则在当前form范围内分组;否则在整个文档的范围内进行分组。

BoxGroup不具有具体的UI。BoxGroup不允许被直接创建。

1.2. 公共实例方法

Table 1.1. 公共实例方法

名称描述
{Array} getBoxList( {void} )获取选项组下DOM元素列表。
{Array} getValue( {void} )获取CheckBox组或Radio组当前被选中的值。
{void} selectAll( {void} )全选。仅对CheckBox组可用。
{void} selectInverse( {void} )反选。仅对CheckBox组可用。

Chapter 2. CheckBox

2.1. 继承层级

CheckBox - InputControl - Control

2.2. 说明

CheckBox关联的点击label,由控件根据Input的title attribute自动生成。

CheckBox的name、checked和value可以直接写在input上,也可以通过初始化参数传入。

2.3. 初始化参数

Table 2.1. 初始化参数

名称描述
{boolean} checked当前CheckBox的选中状态。
{Array} datasource选项数组。如果选项数组中包含该CheckBox的value,则会自动设置为checked。
{boolean} disabled控件是否禁用。
{HTMLElement} main控件主元素。
{string} name当前CheckBox的表单名。
{string|Object} rule验证规则。
{string} value当前CheckBox的value。

2.4. 公共实例方法

Table 2.2. 公共实例方法

名称描述
{void} appendTo( {HTMLElement} wrap )将控件添加到页面的某个元素中。
{boolean} checkValidity( {void} )验证控件,仅返回true/false。
{void} disable( {void} )设置控件状态为禁用。
{void} enable( {void} )设置控件状态为启用。
{BoxGroup} getGroup( {void} )获取CheckBox对应的选项组对象。
{string} getValue( {void} )获取CheckBox的值。
{boolean} isChecked( {void} )获取CheckBox的选中状态。
{boolean} isDisabled( {void} )获取控件可用状态。
{void} render( {void} )绘制控件。
{void} setChecked( {boolean} checked )设置CheckBox的选中状态。
{void} setValue( {string} value )设置CheckBox的值。
{boolean} validate( {void} )验证控件,当值不合法时显示错误信息。

2.5. 事件

Table 2.3. 事件

名称描述
{void} onclick: ( {void} )当CheckBox被点击时触发。
{void} onbeforevalidate( {validator.Validity} )验证开始前触发。
{void} onaftervalidate( {validator.Validity} )验证结束后触发。
{void} oninvalid( {validator.Validity} )验证控件值不合法时触发。

Chapter 3. Radio

3.1. 继承层级

Radio - InputControl - Control

3.2. 说明

Radio关联的点击label,由控件根据Input的title attribute自动生成。

Radio的name、checked和value可以直接写在input上,也可以通过初始化参数传入。

3.3. 初始化参数

Table 3.1. 初始化参数

名称描述
{boolean} checked当前CheckBox的选中状态。
{Array} datasource选项数组。如果选项数组中包含该Radio的value,则会自动设置为checked。
{boolean} disabled控件是否禁用。
{HTMLElement} main控件主元素。
{string} name当前CheckBox的表单名。
{string|Object} rule验证规则。
{string} value当前Radio的value。

3.4. 公共实例方法

Table 3.2. 公共实例方法

名称描述
{void} appendTo( {HTMLElement} wrap )将控件添加到页面的某个元素中。
{boolean} checkValidity( {void} )验证控件,仅返回true/false。
{void} disable( {void} )设置控件状态为禁用。
{void} enable( {void} )设置控件状态为启用。
{BoxGroup} getGroup( {void} )获取Radio对应的选项组对象。
{string} getValue( {void} )获取Radio的值。
{boolean} isChecked( {void} )获取Radio的选中状态。
{boolean} isDisabled( {void} )获取控件可用状态。
{void} render( {void} )绘制控件。
{void} setChecked( {boolean} checked )设置Radio的选中状态。
{void} setValue( {string} value )设置Radio的值。
{boolean} validate( {void} )验证控件,当值不合法时显示错误信息。

3.5. 事件

Table 3.3. 事件

名称描述
{void} onclick: ( {void} )当Radio被点击时触发。
{void} onbeforevalidate( {validator.Validity} )验证开始前触发。
{void} onaftervalidate( {validator.Validity} )验证结束后触发。
{void} oninvalid( {validator.Validity} )验证控件值不合法时触发。