Menu

FineUI. Menu

Description:

  • 菜单控件

Parameters:
Name Type Description
options Object

初始参数

Properties
Name Type Default Description
hidden boolean true

是否隐藏（菜单默认隐藏）
type string 'menu'

控件类型

Extends

Members

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>

控件实例数组

clearDirty()

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:

getAttr(key) → {string}

Description:

  • 获取节点属性

Inherited From:
Parameters:
Name Type Description
key string

节点属性键
Returns:

节点属性值

Type
string

getCheckedItem(groupNameopt) → {FineUI.MenuCheckBox}

Description:

  • 获取选中的复选框菜单项

Parameters:
Name Type Attributes Description
groupName string <optional>

分组名称
Returns:

复选框菜单项

Type
FineUI.MenuCheckBox

getCheckedItems(groupNameopt) → {Array.<FineUI.MenuCheckBox>}

Description:

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

Parameters:
Name Type Attributes Description
groupName string <optional>

分组名称
Returns:

复选框菜单项数组

Type
Array.<FineUI.MenuCheckBox>

getEncodedText(text) → {string}

Description:

  • 获取编码后的字符串

Inherited From:
Parameters:
Name Type Description
text string

原始字符串
Returns:

编码后的字符串

Type
string

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

Description:

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

Inherited From:
Returns:

表单字段数组

Type
Array.<FineUI.Field>

getHeight() → {number}

Description:

  • 获取控件高度

Inherited From:
Returns:

高度

Type
number

getItem(value) → {FineUI.Component}

Description:

  • 获取子控件

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

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

子控件实例

Type
FineUI.Component

getTooltip() → {string}

Description:

  • 获取提示信息

Inherited From:
Returns:

提示信息

Type
string

getTopMenu() → {FineUI.Menu}

Description:

  • 获取顶层菜单

Returns:

顶层菜单

Type
FineUI.Menu

getWidth() → {number}

Description:

  • 获取控件宽度

Inherited From:
Returns:

宽度

Type
number

hide()

Description:

  • 隐藏菜单

Overrides:

hideLoading()

Description:

  • 隐藏加载动画

Inherited From:

hideTopMenu()

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

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

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

是否禁用

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

是否隐藏

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

提示信息

setVisible(visible)

Description:

  • 设置控件的显示状态

Inherited From:
Parameters:
Name Type Description
visible boolean

是否可见

setWidth(width)

Description:

  • 设置控件宽度

Inherited From:
Parameters:
Name Type Description
width number

宽度

show(target, pos, offset)

Description:

  • 显示菜单

Overrides:
Example
FineUI.ui.menu1.show(); // 在当前光标处弹出菜单
FineUI.ui.menu1.show(20, 100); // 在 {left:20,top:100} 处弹出菜单
FineUI.ui.menu1.show(el, 'right'); // 在 el 元素的右侧弹出菜单
Parameters:
Name Type Description
target jQuery

目标元素
pos string

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

偏移量

Properties
Name Type Description
left number

水平方向的偏移量
top number

垂直方向的偏移量

showAt(left, top)

Description:

  • 在指定位置显示菜单

Parameters:
Name Type Description
left number

指定的水平位置
top number

指定的垂直位置

showBy(target, pos, offset)

Description:

  • 在目标元素处显示菜单

Parameters:
Name Type Description
target jQuery

目标元素
pos string

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

偏移量

Properties
Name Type Description
left number

水平方向的偏移量
top number

垂直方向的偏移量

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

事件参数

Events

beforehide

Description:

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

Inherited From:

beforeshow

Description:

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

Inherited From:

checkchange

Description:

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

Parameters:
Name Type Description
event jQuery.Event

事件对象
item FineUI.MenuCheckBox

触发事件的复选框对象
checked boolean

是否选中

hide

Description:

  • 隐藏控件时触发

Inherited From:

layout

Description:

  • 布局控件时触发

Inherited From:

render

Description:

  • 渲染控件时触发

Inherited From:

show

Description:

  • 显示控件时触发

Inherited From: