F.js - 基于 jQuery 的专业 WebUI 控件库

Class: Field

F. Field

new F.Field(options)

form/F.Field.js, line 2

表单字段基类

Name Type Description

options

Object

初始参数

Name	Type	Default	Description
`hideEmptyLabel`	boolean	true	是否隐藏空白标签
`fieldLabel`	string	''	字段标签
`hideLabel`	string	false	是否隐藏字段标签
`readonly`	boolean	false	是否只读（不可以响应触发按钮，注意和 editable 的区别）
`msgTarget`	string	'side'	无效字段提示消息的位置（可选项为：side, qtip, title, none）
`labelWidth`	number	100	字段标签的宽度
`labelSeparator`	string	'：'	字段标签的分隔符
`redStar`	boolean	false	是否在标签上显示红色的星号，用来标识必填项
`redStarPosition`	string	'afterText'	红色星号的显示位置（可选项为：afterText, beforeText, afterSeparator）
`labelAlign`	string	'left'	字段标签的显示位置（可选项为：left, top, right）
`enablePrefix`	boolean	false	是否启用字段前缀
`prefix`	string	''	字段前缀的内容
`enableSuffix`	boolean	false	是否启用字段后缀
`suffix`	string	''	字段后缀的内容
`compareControl`	string	''	需要比较的控件标识符（对值进行验证）
`compareValue`	string		需要比较的值（对值进行验证）
`compareOperator`	string	'=='	比较操作符（可选项为：==, >, >=, <, <=, !=）
`compareType`	string	'string'	比较的类型（可选项为：string, int, float）
`compareMessage`	string	''	不满足比较条件时提示信息
`validateTrim`	boolean	true	验证时去除文本的前后空白字符
`tabIndex`	number	0	TAB键导航的顺序
`name`	string	''	表单字段的名称（name属性用于对提交到服务器的表单数据进行标识，留空则使用id属性）
`type`	string	'field'	控件类型

Extends

F.Container

Members

bodyEljQuery

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

eljQuery

控件对应的jQuery节点对象

itemsObject

子控件列表

Methods

inherited add(value) F.Container.js, line 55

添加新的子控件到当前控件

Name	Type	Description
`value`	Object \| Array.<Object>	控件实例数组

Example

menu1.add(['-', {
		type: 'menuitem',
		text: '新菜单项'
}]);

blur() form/F.Field.js, line 87

取消焦点

clearDirty() form/F.Field.js, line 138

清空已改变状态（接受当前已改变的值）

clearInvalid() form/F.Field.js, line 152

清空无效标记

clearValue() form/F.Field.js, line 73

清空值

disable() form/F.Field.js, line 45

禁用控件

inherited doLayout(startFormTopmostComonent) F.Component.js, line 122

执行布局操作

Name	Type	Default	Description
`startFormTopmostComonent`	boolean	false	optional 从最顶层的控件开始布局

inherited enable() F.Component.js, line 242

启用控件

focus(selectText, delayMilliseconds) form/F.Field.js, line 81

设置焦点

Name	Type	Description
`selectText`	boolean	是否同时选中文本
`delayMilliseconds`	number	设置焦点前延迟的毫秒数

inherited getAttr(key){string} F.Component.js, line 101

获取节点属性

Name	Type	Description
`key`	string	节点属性键

Returns:

Type	Description
string	节点属性值

getFieldLabel(){string} form/F.Field.js, line 106

获取字段标签

Returns:

Type	Description
string	字段标签

inherited getFormFields(){Array.<F.Field>} F.Container.js, line 64

获取容器内的所有表单字段

Returns:

Type	Description
Array.<F.Field>	表单字段数组

inherited getHeight(){number} F.Component.js, line 136

获取控件高度

Returns:

Type	Description
number	高度

inherited getItem(value){F.Component} F.Container.js, line 112

获取子控件

Name	Type	Description
`value`	number \| string \| function	子控件索引、标识符或者函数

Returns:

Type	Description
F.Component	子控件实例

getText(){string} form/F.Field.js, line 52

获取显示文本

Returns:

Type	Description
string	显示文本

inherited getTooltip(){string} F.Component.js, line 196

获取提示信息

Returns:

Type	Description
string	提示信息

getValue(){Object} form/F.Field.js, line 59

获取值

Returns:

Type	Description
Object	值

inherited getWidth(){number} F.Component.js, line 130

获取控件宽度

Returns:

Type	Description
number	宽度

inherited hide() F.Component.js, line 262

隐藏控件

inherited hideLoading() F.Container.js, line 95

隐藏加载动画

inherited insert(insertIndex, value) F.Container.js, line 44

插入新的子控件到当前控件

Name	Type	Description
`insertIndex`	number	插入的位置
`value`	Object \| Array.<Object>	控件实例数组

Example

menu1.insert(0, ['-', {
		type: 'menuitem',
		text: '新菜单项'
}]);

isDirty(){boolean} form/F.Field.js, line 132

字段值是否已经改变

Returns:

Type	Description
boolean	字段值是否已经改变

inherited isDisabled(){boolean} F.Component.js, line 224

是否禁用

Returns:

Type	Description
boolean	是否禁用

isFocus(){boolean} form/F.Field.js, line 93

是否焦点元素

Returns:

Type	Description
boolean	是否焦点元素

inherited isType(value){boolean} F.Base.js, line 23

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

Name	Type	Description
`value`	Object	控件类型

Returns:

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

Example

grid1.isType('panel') // 返回true
grid1.isType('grid')  // 返回true

inherited isValid(onlyFirstInvalidField){Array.<Object>} F.Container.js, line 71

容器内的表单字段是否有效

Name	Type	Default	Description
`onlyFirstInvalidField`	boolean	false	是否仅返回第一个无效的字段

Returns:

Type	Description
Array.<Object>	容器内的表单字段是否有效（[isValid, firstInvalidField, secondInvalidField, thirdInvalidField...]）

inherited isVisible(){boolean} F.Component.js, line 216

是否可见

Returns:

Type	Description
boolean	是否可见

markInvalid(errorMsg) form/F.Field.js, line 146

将字段标记为无效

Name	Type	Description
`errorMsg`	string	错误提示消息

inherited off(eventNames, fn) F.Component.js, line 181

移除事件

Name	Type	Description
`eventNames`	string	事件名称（可以空格分割多个事件名称）
`fn`	F_Component_on	之前注册的事件处理函数

inherited on(eventNames, fn) F.Component.js, line 174

注册事件

Name	Type	Description
`eventNames`	string	事件名称（可以空格分割多个事件名称）
`fn`	F_Component_on	触发事件时执行的函数

inherited remove() F.Component.js, line 115

删除父控件中移除当前控件

inherited removeAttr(key) F.Component.js, line 108

删除节点属性

Name	Type	Description
`key`	string	节点属性键

inherited removeTooltip() F.Component.js, line 208

删除提示信息

reset() form/F.Field.js, line 125

重置字段

inherited setAttr(key, value) F.Component.js, line 94

设置节点属性

Name	Type	Description
`key`	string	节点属性键
`value`	string	节点属性值

inherited setAttrs(attrs) F.Component.js, line 86

设置节点属性

Name	Type	Description
`attrs`	Object	节点属性对象

inherited setDisabled(disabled) F.Component.js, line 248

设置控件的禁用状态

Name	Type	Description
`disabled`	boolean	是否禁用

inherited setEnabled(enabled) F.Component.js, line 254

设置控件的启用状态

Name	Type	Description
`enabled`	boolean	是否启用

setFieldLabel(label) form/F.Field.js, line 100

设置字段标签

Name	Type	Description
`label`	string	字段标签

inherited setHeight(height) F.Component.js, line 143

设置控件高度

Name	Type	Description
`height`	number	高度

inherited setHidden(hidden) F.Component.js, line 286

设置控件的隐藏状态

Name	Type	Description
`hidden`	boolean	是否隐藏

setReadonly(readonly) form/F.Field.js, line 113

设置只读

Name	Type	Description
`readonly`	boolean	只读状态

setRedStar(redStar) form/F.Field.js, line 119

设置是否显示红色星号

Name	Type	Description
`redStar`	boolean	是否显示红色星号

inherited setSize(width, height) F.Component.js, line 158

设置控件尺寸

Name	Type	Description
`width`	number	宽度
`height`	number	高度

inherited setTooltip(tooltip) F.Component.js, line 202

设置提示信息

Name	Type	Description
`tooltip`	string	提示信息

setValue(value, forceNoValidate) form/F.Field.js, line 67

设置值

Name	Type	Description
`value`	Object	值
`forceNoValidate`	boolean	是否验证

inherited setVisible(visible) F.Component.js, line 280

设置控件的显示状态

Name	Type	Description
`visible`	boolean	是否可见

inherited setWidth(width) F.Component.js, line 150

设置控件宽度

Name	Type	Description
`width`	number	宽度

inherited show() F.Component.js, line 268

显示控件

inherited showLoading(opacity, container) F.Container.js, line 103

显示加载动画

Name	Type	Description
`opacity`	number	透明度（默认值：0.65）
`container`	jQuery	显示动画的目标元素（留空则为内容元素）

inherited toggleEnabled() F.Component.js, line 230

切换启用状态

inherited toggleVisible() F.Component.js, line 274

切换显示状态

inherited trigger(eventName, args) F.Component.js, line 189

触发事件

Name	Type	Description
`eventName`	string	事件名称
`args`	Object	事件参数

validate(){boolean} form/F.Field.js, line 159

验证字段的有效性

Returns:

Type	Description
boolean	是否有效

Events

inherited beforehide F.Component.js, line 57

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

inherited beforeshow F.Component.js, line 69

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

inherited hide F.Component.js, line 63

隐藏控件时触发

inherited layout F.Component.js, line 45

布局控件时触发

inherited render F.Component.js, line 51

渲染控件时触发

inherited show F.Component.js, line 75

显示控件时触发

F.js v7.1.0

Class: Field

new F.Field(options)

Extends

Members

bodyEljQuery

eljQuery

itemsObject

Methods

inherited add(value)

Example

blur()

clearDirty()

clearInvalid()

clearValue()

disable()

inherited doLayout(startFormTopmostComonent)

inherited enable()

focus(selectText, delayMilliseconds)

inherited getAttr(key){string}

Returns:

getFieldLabel(){string}

Returns:

inherited getFormFields(){Array.<F.Field>}

Returns:

inherited getHeight(){number}

Returns:

inherited getItem(value){F.Component}

Returns:

getText(){string}

Returns:

inherited getTooltip(){string}

Returns:

getValue(){Object}

Returns:

inherited getWidth(){number}

Returns:

inherited hide()

inherited hideLoading()

inherited insert(insertIndex, value)

Example

isDirty(){boolean}

Returns:

inherited isDisabled(){boolean}

Returns:

isFocus(){boolean}

Returns:

inherited isType(value){boolean}

Returns:

Example

inherited isValid(onlyFirstInvalidField){Array.<Object>}

Returns:

inherited isVisible(){boolean}

Returns:

markInvalid(errorMsg)

inherited off(eventNames, fn)

inherited on(eventNames, fn)

inherited remove()

inherited removeAttr(key)

inherited removeTooltip()

reset()

inherited setAttr(key, value)

inherited setAttrs(attrs)

inherited setDisabled(disabled)

inherited setEnabled(enabled)

setFieldLabel(label)

inherited setHeight(height)

inherited setHidden(hidden)

setReadonly(readonly)

setRedStar(redStar)

inherited setSize(width, height)

inherited setTooltip(tooltip)

setValue(value, forceNoValidate)

inherited setVisible(visible)

inherited setWidth(width)

inherited show()

inherited showLoading(opacity, container)

inherited toggleEnabled()

inherited toggleVisible()

inherited trigger(eventName, args)