F.js - 企业级前端界面库

Class: Menu

F. Menu

menu/F.Menu.js, line 2

菜单控件

Name Type Description

options

Object

初始参数

Name	Type	Default	Description
`hidden`	boolean	true	是否隐藏（菜单默认隐藏）
`type`	string	'menu'	控件类型

Extends

F.Container

Members

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: '新菜单项'
}]);

inherited clearDirty() F.Container.js, line 83

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

inherited disable() F.Component.js, line 236

禁用控件

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

执行布局操作

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

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

启用控件

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

获取节点属性

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

Returns:

Type	Description
string	节点属性值

getCheckedItem(groupName){F.MenuCheckBox} menu/F.Menu.js, line 90

获取选中的复选框菜单项

Name	Type	Description
`groupName`	string	optional 分组名称

Returns:

Type	Description
F.MenuCheckBox	复选框菜单项

getCheckedItems(groupName){Array.<F.MenuCheckBox>} menu/F.Menu.js, line 82

获取选中的复选框菜单项数组

Name	Type	Description
`groupName`	string	optional 分组名称

Returns:

Type	Description
Array.<F.MenuCheckBox>	复选框菜单项数组

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	子控件实例

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

获取提示信息

Returns:

Type	Description
string	提示信息

getTopMenu(){F.Menu} menu/F.Menu.js, line 65

获取顶层菜单

Returns:

Type	Description
F.Menu	顶层菜单

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

获取控件宽度

Returns:

Type	Description
number	宽度

hide() menu/F.Menu.js, line 50

隐藏菜单

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

隐藏加载动画

hideTopMenu() menu/F.Menu.js, line 57

隐藏顶层菜单

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: '新菜单项'
}]);

inherited isDirty(){boolean} F.Container.js, line 77

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

Returns:

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

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

是否禁用

Returns:

Type	Description
boolean	是否禁用

isTopMenu(){boolean} menu/F.Menu.js, line 73

是否顶层菜单

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	是否可见

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

删除提示信息

inherited reset() F.Container.js, line 89

重置容器内的全部字段

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	是否启用

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	是否隐藏

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	提示信息

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	宽度

show(target, pos, offset) menu/F.Menu.js, line 26

显示菜单

Name Type Description

target jQuery 目标元素

pos string 菜单相对于目标元素的位置（可选项为：right, bottom）

offset

Object

偏移量

Name	Type	Description
`left`	number	水平方向的偏移量
`top`	number	垂直方向的偏移量

Example

F.ui.menu1.show(); // 在当前光标处弹出菜单
F.ui.menu1.show(20, 100); // 在 {left:20,top:100} 处弹出菜单
F.ui.menu1.show(el, 'right'); // 在 el 元素的右侧弹出菜单

showAt(left, top) menu/F.Menu.js, line 43

在指定位置显示菜单

Name	Type	Description
`left`	number	指定的水平位置
`top`	number	指定的垂直位置

showBy(target, pos, offset) menu/F.Menu.js, line 36

在目标元素处显示菜单

Name Type Description

target jQuery 目标元素

pos string 菜单相对于目标元素的位置（可选项为：right, bottom）

offset

Object

偏移量

Name	Type	Description
`left`	number	水平方向的偏移量
`top`	number	垂直方向的偏移量

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	事件参数

Events

inherited beforehide F.Component.js, line 57

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

inherited beforeshow F.Component.js, line 69

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

checkchange menu/F.MenuCheckBox.js, line 25

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

Name	Type	Description
`event`	jQuery.Event	事件对象
`item`	F.MenuCheckBox	触发事件的复选框对象
`checked`	boolean	是否选中

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 v8.2.1

Class: Menu

new F.Menu(options)

Extends

Members

eljQuery

itemsObject

Methods

inherited add(value)

Example

inherited clearDirty()

inherited disable()

inherited doLayout(startFormTopmostComonent)

inherited enable()

inherited getAttr(key){string}

Returns:

getCheckedItem(groupName){F.MenuCheckBox}

Returns:

getCheckedItems(groupName){Array.<F.MenuCheckBox>}

Returns:

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

Returns:

inherited getHeight(){number}

Returns:

inherited getItem(value){F.Component}

Returns:

inherited getTooltip(){string}

Returns:

getTopMenu(){F.Menu}

Returns:

inherited getWidth(){number}

Returns:

hide()

inherited hideLoading()

hideTopMenu()

inherited insert(insertIndex, value)

Example

inherited isDirty(){boolean}

Returns:

inherited isDisabled(){boolean}

Returns:

isTopMenu(){boolean}

Returns:

inherited isType(value){boolean}

Returns:

Example

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

Returns:

inherited isVisible(){boolean}

Returns:

inherited off(eventNames, fn)

inherited on(eventNames, fn)

inherited remove()

inherited removeAttr(key)

inherited removeTooltip()

inherited reset()

inherited setAttr(key, value)

inherited setAttrs(attrs)

inherited setDisabled(disabled)

inherited setEnabled(enabled)

inherited setHeight(height)

inherited setHidden(hidden)

inherited setSize(width, height)

inherited setTooltip(tooltip)

inherited setVisible(visible)

inherited setWidth(width)

show(target, pos, offset)

Example

showAt(left, top)

showBy(target, pos, offset)

inherited showLoading(opacity, container)

inherited toggleEnabled()

inherited toggleVisible()

inherited trigger(eventName, args)

Events

inherited beforehide

inherited beforeshow

checkchange

inherited hide

inherited layout