TriggerBox

F. TriggerBox

new TriggerBox(options)

Description:

  • 触发器输入框控件

Parameters:
Name Type Description
options Object

初始参数

Properties
Name Type Default Description
triggerCls boolean ''

触发图标样式类
trigger1Cls boolean ''

第一个触发图标样式类
trigger2Cls boolean ''

第二个触发图标样式类
triggerHidden boolean false

是否显示触发图标
trigger1Hidden boolean false

是否显示第一个触发图标
trigger2Hidden boolean false

是否显示第二个触发图标
enableClickAction boolean false

点击输入框是否触发默认行为
type string 'triggerbox'

控件类型

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

add(value)

Description:

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

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

控件实例数组

blur()

Description:

  • 取消焦点

Inherited From:

clearDirty()

Description:

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

Inherited From:

clearInvalid()

Description:

  • 清空无效标记

Overrides:

clearValue()

Description:

  • 清空值

Inherited From:

disable()

Description:

  • 禁用控件

Inherited From:

doLayout(startFormTopmostComonentopt)

Description:

  • 执行布局操作

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

从最顶层的控件开始布局

enable()

Description:

  • 启用控件

Inherited From:

focus(selectText, delayMilliseconds)

Description:

  • 设置焦点

Inherited From:
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:

  • 获取字段标签

Inherited From:
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:

  • 获取显示文本

Inherited From:
Returns:

显示文本

Type
string

getTooltip() → {string}

Description:

  • 获取提示信息

Inherited From:
Returns:

提示信息

Type
string

getValue() → {string}

Description:

  • 获取值

Inherited From:
Returns:

文本框的值

Type
string

getWidth() → {number}

Description:

  • 获取控件宽度

Inherited From:
Returns:

宽度

Type
number

hide()

Description:

  • 隐藏控件

Inherited From:

hideLoading()

Description:

  • 隐藏加载动画

Inherited From:

hideTrigger()

Description:

  • 隐藏触发按钮

hideTrigger1()

Description:

  • 隐藏第一个触发按钮

hideTrigger2()

Description:

  • 隐藏第二个触发按钮

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:

  • 字段值是否已经改变

Inherited From:
Returns:

字段值是否已经改变

Type
boolean

isDisabled() → {boolean}

Description:

  • 是否禁用

Inherited From:
Returns:

是否禁用

Type
boolean

isFocused() → {boolean}

Description:

  • 是否焦点元素

Inherited From:
Returns:

是否焦点元素

Type
boolean

isTriggerVisible(triggerNumber) → {boolean}

Description:

  • 触发按钮是否可见

Parameters:
Name Type Description
triggerNumber number

触发按钮序号（1或者2，从左开始计数）
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:

  • 将字段标记为无效

Overrides:
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:

  • 重置字段

Inherited From:

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

是否禁用

setEditable(editable)

Description:

  • 设置是否可编辑

Inherited From:
Parameters:
Name Type Description
editable boolean

是否可编辑

setEmptyText(emptyText)

Description:

  • 设置空白文本

Inherited From:
Parameters:
Name Type Description
emptyText string

空白文本

setEnabled(enabled)

Description:

  • 设置控件的启用状态

Inherited From:
Parameters:
Name Type Description
enabled boolean

是否启用

setFieldLabel(label)

Description:

  • 设置字段标签

Inherited From:
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

是否隐藏

setMaxLength(maxLength)

Description:

  • 设置最大长度

Inherited From:
Parameters:
Name Type Description
maxLength number

最大长度

setMinLength(minLength)

Description:

  • 设置最小长度

Inherited From:
Parameters:
Name Type Description
minLength number

最小长度

setReadonly(readonly)

Description:

  • 设置只读

Inherited From:
Parameters:
Name Type Description
readonly boolean

只读状态

setRedStar(redStar)

Description:

  • 设置是否显示红色星号

Inherited From:
Parameters:
Name Type Description
redStar boolean

是否显示红色星号

setRegex(regex)

Description:

  • 设置正则表达式

Inherited From:
Parameters:
Name Type Description
regex Regex

正则表达式

setRegexPattern(regexPattern)

Description:

  • 设置正则表达式规则

Inherited From:
Parameters:
Name Type Description
regexPattern string

正则表达式规则

setRequired(required)

Description:

  • 设置是否必填

Inherited From:
Parameters:
Name Type Description
required boolean

是否必填

setSize(width, height)

Description:

  • 设置控件尺寸

Inherited From:
Parameters:
Name Type Description
width number

宽度
height number

高度

setText(text, forceNoValidate)

Description:

  • 设置显示文本

Inherited From:
Parameters:
Name Type Description
text string

显示文本
forceNoValidate boolean

是否验证

setTooltip(tooltip)

Description:

  • 设置提示信息

Inherited From:
Parameters:
Name Type Description
tooltip string

提示信息

setTriggerVisible(triggerNumber, visible)

Description:

  • 设置触发按钮的显示状态

Parameters:
Name Type Description
triggerNumber number

触发按钮序号（1或者2，从左开始计数）
visible boolean

显示状态

setValue(value, forceNoValidate)

Description:

  • 设置值

Inherited From:
Parameters:
Name Type Description
value boolean

文本框的值
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

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

showTrigger()

Description:

  • 显示触发按钮

showTrigger1()

Description:

  • 显示第一个触发按钮

showTrigger2()

Description:

  • 显示第二个触发按钮

toggleEnabled()

Description:

  • 切换启用状态

Inherited From:

toggleVisible()

Description:

  • 切换显示状态

Inherited From:

trigger(eventName, args)

Description:

  • 触发事件

Inherited From:
Parameters:
Name Type Description
eventName string

事件名称
args Object

事件参数

triggerDefaultAction()

Description:

  • 触发缺省动作

validate() → {boolean}

Description:

  • 验证字段的有效性

Inherited From:
Returns:

是否有效

Type
boolean

Events

beforehide

Description:

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

Inherited From:

beforeshow

Description:

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

Inherited From:

blur

Description:

  • 输入框失去焦点时触发

Inherited From:
Parameters:
Name Type Description
event jQuery.Event

事件对象

change

Description:

  • 输入框值改变时触发

Inherited From:
Parameters:
Name Type Description
event jQuery.Event

事件对象

enter

Description:

  • 输入框获取焦点并按下ENTER键时触发

Inherited From:
Parameters:
Name Type Description
event jQuery.Event

事件对象

focus

Description:

  • 输入框获取焦点时触发

Inherited From:
Parameters:
Name Type Description
event jQuery.Event

事件对象

hide

Description:

  • 隐藏控件时触发

Inherited From:

layout

Description:

  • 布局控件时触发

Inherited From:

render

Description:

  • 渲染控件时触发

Inherited From:

show

Description:

  • 显示控件时触发

Inherited From:

trigger1click

Description:

  • 点击第一个触发图标时触发

Parameters:
Name Type Description
event jQuery.Event

事件对象

trigger2click

Description:

  • 点击第二个触发图标时触发

Parameters:
Name Type Description
event jQuery.Event

事件对象

triggerclick

Description:

  • 点击触发图标时触发

Parameters:
Name Type Description
event jQuery.Event

事件对象