Field

F. Field

new Field(options)

Description:

  • 表单字段基类

Parameters:
Name Type Description
options Object

初始参数

Properties
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

Members

bodyEl :jQuery

Description:

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

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

Type:
  • jQuery

el :jQuery

Description:

  • 控件对应的jQuery节点对象

Inherited From:

控件对应的jQuery节点对象

Type:
  • jQuery

items :Object

Description:

  • 子控件列表

Inherited From:

子控件列表

Type:
  • Object

Methods

add(value)

Description:

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

Inherited From:
Example
menu1.add(['-', {
		type: 'menuitem',
		text: '新菜单项'
}]);
Parameters:
Name Type Description
value Object | Array.<Object>

控件实例数组

blur()

Description:

  • 取消焦点

clearDirty()

Description:

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

Overrides:

clearInvalid()

Description:

  • 清空无效标记

clearValue()

Description:

  • 清空值

disable()

Description:

  • 禁用控件

Overrides:

doLayout(startFormTopmostComonentopt)

Description:

  • 执行布局操作

Inherited From:
Parameters:
Name Type Attributes Default Description
startFormTopmostComonent boolean <optional>
 false

从最顶层的控件开始布局

enable()

Description:

  • 启用控件

Inherited From:

focus(selectText, delayMilliseconds)

Description:

  • 设置焦点

Parameters:
Name Type Description
selectText boolean

是否同时选中文本
delayMilliseconds number

设置焦点前延迟的毫秒数

getAttr(key) → {string}

Description:

  • 获取节点属性

Inherited From:
Parameters:
Name Type Description
key string

节点属性键
Returns:

节点属性值

Type
string

getFieldLabel() → {string}

Description:

  • 获取字段标签

Returns:

字段标签

Type
string

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

Description:

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

Inherited From:
Returns:

表单字段数组

Type
Array.<F.Field>

getHeight() → {number}

Description:

  • 获取控件高度

Inherited From:
Returns:

高度

Type
number

getItem(value) → {F.Component}

Description:

  • 获取子控件

Inherited From:
Parameters:
Name Type Description
value number | string | function

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

子控件实例

Type
F.Component

getText() → {string}

Description:

  • 获取显示文本

Returns:

显示文本

Type
string

getTooltip() → {string}

Description:

  • 获取提示信息

Inherited From:
Returns:

提示信息

Type
string

getValue() → {Object}

Description:

  • 获取值

Returns:

值

Type
Object

getWidth() → {number}

Description:

  • 获取控件宽度

Inherited From:
Returns:

宽度

Type
number

hide()

Description:

  • 隐藏控件

Inherited From:

hideLoading()

Description:

  • 隐藏加载动画

Inherited From:

insert(insertIndex, value)

Description:

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

Inherited From:
Example
menu1.insert(0, ['-', {
		type: 'menuitem',
		text: '新菜单项'
}]);
Parameters:
Name Type Description
insertIndex number

插入的位置
value Object | Array.<Object>

控件实例数组

isDirty() → {boolean}

Description:

  • 字段值是否已经改变

Overrides:
Returns:

字段值是否已经改变

Type
boolean

isDisabled() → {boolean}

Description:

  • 是否禁用

Inherited From:
Returns:

是否禁用

Type
boolean

isFocused() → {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

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

Description:

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

Inherited From:
Parameters:
Name Type Default Description
onlyFirstInvalidField boolean false

是否仅返回第一个无效的字段
Returns:

容器内的表单字段是否有效（[isValid, firstInvalidField, secondInvalidField, thirdInvalidField...]）

Type
Array.<Object>

isVisible() → {boolean}

Description:

  • 是否可见

Inherited From:
Returns:

是否可见

Type
boolean

markInvalid(errorMsg)

Description:

  • 将字段标记为无效

Parameters:
Name Type Description
errorMsg string

错误提示消息

off(eventNames, fn)

Description:

  • 移除事件

Inherited From:
Parameters:
Name Type Description
eventNames string

事件名称（可以空格分割多个事件名称）
fn F_Component_on

之前注册的事件处理函数

on(eventNames, fn)

Description:

  • 注册事件

Inherited From:
Parameters:
Name Type Description
eventNames string

事件名称（可以空格分割多个事件名称）
fn F_Component_on

触发事件时执行的函数

remove()

Description:

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

Inherited From:

removeAttr(key)

Description:

  • 删除节点属性

Inherited From:
Parameters:
Name Type Description
key string

节点属性键

removeTooltip()

Description:

  • 删除提示信息

Inherited From:

reset()

Description:

  • 重置字段

Overrides:

setAttr(key, value)

Description:

  • 设置节点属性

Inherited From:
Parameters:
Name Type Description
key string

节点属性键
value string

节点属性值

setAttrs(attrs)

Description:

  • 设置节点属性

Inherited From:
Parameters:
Name Type Description
attrs Object

节点属性对象

setDisabled(disabled)

Description:

  • 设置控件的禁用状态

Inherited From:
Parameters:
Name Type Description
disabled boolean

是否禁用

setEnabled(enabled)

Description:

  • 设置控件的启用状态

Inherited From:
Parameters:
Name Type Description
enabled boolean

是否启用

setFieldLabel(label)

Description:

  • 设置字段标签

Parameters:
Name Type Description
label string

字段标签

setHeight(height)

Description:

  • 设置控件高度

Inherited From:
Parameters:
Name Type Description
height number

高度

setHidden(hidden)

Description:

  • 设置控件的隐藏状态

Inherited From:
Parameters:
Name Type Description
hidden boolean

是否隐藏

setReadonly(readonly)

Description:

  • 设置只读

Parameters:
Name Type Description
readonly boolean

只读状态

setRedStar(redStar)

Description:

  • 设置是否显示红色星号

Parameters:
Name Type Description
redStar boolean

是否显示红色星号

setSize(width, height)

Description:

  • 设置控件尺寸

Inherited From:
Parameters:
Name Type Description
width number

宽度
height number

高度

setTooltip(tooltip)

Description:

  • 设置提示信息

Inherited From:
Parameters:
Name Type Description
tooltip string

提示信息

setValue(value, forceNoValidate)

Description:

  • 设置值

Parameters:
Name Type Description
value Object

值
forceNoValidate boolean

是否验证

setVisible(visible)

Description:

  • 设置控件的显示状态

Inherited From:
Parameters:
Name Type Description
visible boolean

是否可见

setWidth(width)

Description:

  • 设置控件宽度

Inherited From:
Parameters:
Name Type Description
width number

宽度

show()

Description:

  • 显示控件

Inherited From:

showLoading(opacity, container)

Description:

  • 显示加载动画

Inherited From:
Parameters:
Name Type Description
opacity number

透明度（默认值：0.65）
container jQuery

显示动画的目标元素（留空则为内容元素）

toggleEnabled()

Description:

  • 切换启用状态

Inherited From:

toggleVisible()

Description:

  • 切换显示状态

Inherited From:

trigger(eventName, args)

Description:

  • 触发事件

Inherited From:
Parameters:
Name Type Description
eventName string

事件名称
args Object

事件参数

validate() → {boolean}

Description:

  • 验证字段的有效性

Returns:

是否有效

Type
boolean

Events

beforehide

Description:

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

Inherited From:

beforeshow

Description:

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

Inherited From:

hide

Description:

  • 隐藏控件时触发

Inherited From:

layout

Description:

  • 布局控件时触发

Inherited From:

render

Description:

  • 渲染控件时触发

Inherited From:

show

Description:

  • 显示控件时触发

Inherited From: