MenuCheckBox

F. MenuCheckBox

Description:

  • 复选框菜单项控件

Parameters:
Name Type Description
options Object

初始参数

Properties
Name Type Default Description
checked boolean false

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

分组名称（拥有相同 group 属性的复选框菜单项被渲染为单选按钮）
hiddenName string ''

用来存放复选框 input 节点的 name 属性
text string ''

显示文本
type string 'menucheckbox'

控件类型

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>

控件实例数组

addTool(item)

Description:

  • 添加工具图标

Inherited From:
Parameters:
Name Type Description
item F.Tool

工具图标实例

clearDirty()

Description:

  • 清空容器内字段的改变状态（接受字段已改变的值）

Inherited From:

collapse()

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:

expand()

Description:

  • 展开面板

Inherited From:

getAttr(key) → {string}

Description:

  • 获取节点属性

Inherited From:
Parameters:
Name Type Description
key string

节点属性键
Returns:

节点属性值

Type
string

getCheckBoxEl() → {jQuery}

Description:

  • 获取菜单项的复选框元素

Returns:

复选框元素

Type
jQuery

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

Description:

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

Inherited From:
Returns:

表单字段数组

Type
Array.<F.Field>

getHeight() → {number}

Description:

  • 获取控件高度

Inherited From:
Returns:

高度

Type
number

getIFrameEl() → {jQuery}

Description:

  • 获取内联框架元素

Inherited From:
Returns:

内联框架元素

Type
jQuery

getIFrameUrl() → {string}

Description:

  • 获取内联框架地址

Inherited From:
Returns:

内联框架地址

Type
string

getIFrameWindow() → {Window}

Description:

  • 获取内联框架窗体对象

Inherited From:
Returns:

内联框架窗体对象

Type
Window

getIconEl() → {jQuery}

Description:

  • 获取图标元素

Inherited From:
Returns:

图标元素

Type
jQuery

getItem(value) → {F.Component}

Description:

  • 获取子控件

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

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

子控件实例

Type
F.Component

getScrollEl() → {jQuery}

Description:

  • 获取可滚动元素

Inherited From:
Returns:

可滚动元素

Type
jQuery

getText() → {string}

Description:

  • 获取菜单项的显示文本

Returns:

显示文本

Type
string

getTitle() → {string}

Description:

  • 获取面板标题

Inherited From:
Returns:

标题文本

Type
string

getTitleTooltip() → {string}

Description:

  • 获取面板标题提示信息

Inherited From:
Returns:

标题提示信息

Type
string

getTooltip() → {string}

Description:

  • 获取提示信息

Inherited From:
Returns:

提示信息

Type
string

getWidth() → {number}

Description:

  • 获取控件宽度

Inherited From:
Returns:

宽度

Type
number

hasHScrollbar() → {boolean}

Description:

  • 是否存在水平滚动条

Inherited From:
Returns:

是否存在水平滚动条

Type
boolean

hasIcon() → {boolean}

Description:

  • 是否有图标

Inherited From:
Returns:

是否有图标

Type
boolean

hasVScrollbar() → {boolean}

Description:

  • 是否存在垂直滚动条

Inherited From:
Returns:

是否存在垂直滚动条

Type
boolean

hide()

Description:

  • 隐藏面板

Inherited From:

hideLoading()

Description:

  • 隐藏加载动画

Inherited From:

hideTopMenu()

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>

控件实例数组

insertTool(item, insertIndex)

Description:

  • 插入工具图标

Inherited From:
Parameters:
Name Type Description
item F.Tool

工具图标实例
insertIndex number

插入的位置

isChecked() → {boolean}

Description:

  • 是否选中

Returns:

是否选中

Type
boolean

isCollapsed() → {boolean}

Description:

  • 是否处于折叠状态

Inherited From:
Returns:

折叠状态

Type
boolean

isDirty() → {boolean}

Description:

  • 容器内的表单字段是否已经改变

Inherited From:
Returns:

容器内的表单字段是否已经改变

Type
boolean

isDisabled() → {boolean}

Description:

  • 是否禁用

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

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

触发事件时执行的函数

refreshIFrame()

Description:

  • 刷新内联框架

Inherited From:

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

节点属性对象

setChecked(checked)

Description:

  • 设置复选框的选中状态

Parameters:
Name Type Description
checked boolean

选中状态

setDisabled(disabled)

Description:

  • 设置控件的禁用状态

Inherited From:
Parameters:
Name Type Description
disabled boolean

是否禁用

setEnabled(enabled)

Description:

  • 设置控件的启用状态

Inherited From:
Parameters:
Name Type Description
enabled boolean

是否启用

setHeight(height)

Description:

  • 设置控件高度

Inherited From:
Parameters:
Name Type Description
height number

高度

setHidden(hidden)

Description:

  • 设置控件的隐藏状态

Inherited From:
Parameters:
Name Type Description
hidden boolean

是否隐藏

setIFrameUrl(url)

Description:

  • 设置内联框架地址

Inherited From:
Parameters:
Name Type Description
url string

内联框架地址

setIcon(icon)

Description:

  • 设置图标地址

Inherited From:
Example
F.ui.panel1.setIcon('../res/images/16/1.png');
Parameters:
Name Type Description
icon string

图标地址

setIconFont(iconFont)

Description:

  • 设置图标字体

Inherited From:
Example
F.ui.panel1.setIconFont('bank');
Parameters:
Name Type Description
iconFont string

图标字体

setSize(width, height)

Description:

  • 设置控件尺寸

Inherited From:
Parameters:
Name Type Description
width number

宽度
height number

高度

setSplitDraggable() → {boolean}

Description:

  • 设置分隔条是否可以拖动

Inherited From:
Returns:

是否可以拖动

Type
boolean

setText(text)

Description:

  • 设置菜单项的显示文本

Parameters:
Name Type Description
text string

显示文本

setTitle(title)

Description:

  • 设置面板标题

Inherited From:
Parameters:
Name Type Description
title string

标题文本

setTitleTooltip(tooltip)

Description:

  • 设置面板标题提示信息

Inherited From:
Parameters:
Name Type Description
tooltip string

提示信息字符串

setTooltip(tooltip)

Description:

  • 设置提示信息

Inherited From:
Parameters:
Name Type Description
tooltip string

提示信息

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

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

toggleCollapse()

Description:

  • 切换面板的折叠状态

Inherited From:

toggleEnabled()

Description:

  • 切换启用状态

Inherited From:

toggleVisible()

Description:

  • 切换显示状态

Inherited From:

trigger(eventName, args)

Description:

  • 触发事件

Inherited From:
Parameters:
Name Type Description
eventName string

事件名称
args Object

事件参数

Events

beforehide

Description:

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

Inherited From:

beforeshow

Description:

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

Inherited From:

checkchange

Description:

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

Parameters:
Name Type Description
event jQuery.Event

事件对象
checked boolean

是否选中

click

Description:

  • 点击菜单复选框时触发（返回false则不执行handler方法）

Parameters:
Name Type Description
event jQuery.Event

事件对象

collapse

Description:

  • 折叠面板时触发

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

事件对象

dirtychange

Description:

  • 容器内的字段值改变时触发

Inherited From:

expand

Description:

  • 展开面板时触发

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

事件对象

hide

Description:

  • 隐藏控件时触发

Inherited From:

iframeload

Description:

  • 内联框架加载完毕时触发

Inherited From:

layout

Description:

  • 布局控件时触发

Inherited From:

render

Description:

  • 渲染控件时触发

Inherited From:

resize

Description:

  • 面板尺寸改变时触发

Inherited From:

show

Description:

  • 显示控件时触发

Inherited From:

splitdrag

Description:

  • 拖动分隔条时触发（拖动操作）

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

事件对象