CheckBox

FineUI. CheckBox

new CheckBox(options)

Description:
Examples

创建复选框，inputLabel设置文本，checked设置选中状态：

FineUI.create({
	type: 'CheckBox', renderTo: document.body, fieldLabel: '记住我', inputLabel: '下次自动登录', checked: true
});

使用displayType: 'switch'显示为开关样式：

FineUI.create({
	type: 'CheckBox', renderTo: document.body, fieldLabel: '推送通知',
	displayType: 'switch', switchTextVisible: true, switchOnText: '开', switchOffText: '关', checked: true
});

通过change事件监听状态变化：

FineUI.create({
	type: 'CheckBox', renderTo: document.body, fieldLabel: '同意条款', inputLabel: '我已阅读并同意',
	listeners: {
		change: function (event) {
			FineUI.alert(this.isChecked() ? '已勾选' : '已取消');
		}
	}
});
Parameters:
Name Type Description
options Object

初始参数

Properties
Name Type Default Description
checked boolean false

是否处于选中状态
inputLabel string ''

复选框的标签（显示在复选框右侧的文字）
inputValue string ''

复选框 input 节点的 value 属性（提交到服务器时随表单一起发送）
displayType string 'default'

复选框的显示类型（可选项为：default, switch, radio）
switchTextVisible boolean false

是否显示开关类型的文本
switchOnText string 'ON'

开关类型的选中文本
switchOffText string 'OFF'

开关类型的未选中文本
type string 'CheckBox'

控件类型

Extends

Members

bodyEl :jQuery

Description:

  • 字段主体对应的jQuery节点对象

Inherited From:

字段主体对应的jQuery节点对象

Type:
  • jQuery

el :jQuery

Description:

  • 控件对应的jQuery节点对象

Inherited From:

控件对应的jQuery节点对象

Type:
  • jQuery

items :Object

Description:

  • 子控件列表

Inherited From:

子控件列表

Type:
  • Object

Methods

getEncodedText(text) → {string}

Description:

  • 获取编码后的字符串

Inherited From:
Parameters:
Name Type Description
text string

原始字符串
Returns:

编码后的字符串

Type
string

getFormFields() → {Array.<FineUI.Field>}

Description:

  • 获取容器内（深度遍历）所有表单字段实例（FineUI.Field的子类，如TextBox/NumberBox/DatePicker等）

Inherited From:
Example

遍历表单全部字段，序列化为 name → value 的对象（用于自定义 ajax 提交；字段未声明name时改用id）：

var values = {};
FineUI.ui.form1.getFormFields().forEach(function (field) {
    values[field.name || field.id] = field.getValue();
});
// values 形如：{ tbxUserName: 'FineUIPro', numberAge: 30, ... }
Returns:

表单字段数组

Type
Array.<FineUI.Field>

getItem(value) → {FineUI.Component}

Description:

  • 获取子控件（按索引/标识符/匹配函数查找；通常配合items无显式 id 的场景，比按FineUI.ui[id]更精准）

Inherited From:
Examples

按索引取第一个子控件：

var firstChild = FineUI.ui.toolbar1.getItem(0);

按 id 取子控件：

var btn = FineUI.ui.toolbar1.getItem('btnSave');

按匹配函数找第一个匹配的子控件（函数对每项返回 true 即匹配）：

var btn = FineUI.ui.toolbar1.getItem(function (item) {
    return item.type === 'Button' && item.text === '保存';
});
Parameters:
Name Type Description
value number | string | function

子控件索引、标识符或者匹配函数
Returns:

子控件实例

Type
FineUI.Component

hidePopEl()

Description:

  • 隐藏容器内的所有弹出框

Inherited From:

isChecked() → {boolean}

Description:

  • 复选框是否选中

Returns:

是否选中

Type
boolean

isType(value) → {boolean}

Description:

  • 检测当前实例是否指定的控件类型

Inherited From:
Example
grid1.isType('panel') // 返回true
grid1.isType('grid')  // 返回true
Parameters:
Name Type Description
value Object

控件类型
Returns:

如果当前实例是指定的控件类型，返回true；否则返回false

Type
boolean

Events

beforehide

Description:

  • 隐藏控件之前触发（返回false则取消隐藏操作）

Inherited From:

beforeshow

Description:

  • 显示控件之前触发（返回false则取消显示操作）

Inherited From:

change

Description:

  • 复选框选中状态改变时触发

Parameters:
Name Type Description
event jQuery.Event

事件对象
isChecked boolean

是否选中

hide

Description:

  • 隐藏控件时触发

Inherited From:

layout

Description:

  • 布局控件时触发

Inherited From:

remove

Description:

  • 移除控件时触发（调用 remove() 时，控件 DOM 被销毁之前触发；可用于清理外部资源 / 解绑全局事件）

Inherited From:

render

Description:

  • 渲染控件时触发

Inherited From:

show

Description:

  • 显示控件时触发

Inherited From: