Requires

• module:ht-menu.js

Methods

addTo(container) → {void}

参数为HTML元素，将菜单作为其child

Parameters:

Name	Type	Attributes	Description
container	HTMLElement	<optional>	父DOM

Returns:

void

addToDOM(parentNode) → {void}

将视图插入到 dom 中，不指定 dom 节点默认添加到 body 下

Parameters:

Name	Type	Attributes	Description
parentNode	HTMLDivElement	<optional>	父DOM

Returns:

void

addViewListener(listener, scope, ahead) → {void}

监听视图事件，如布局、刷新等

Parameters:

Name	Type	Attributes	Description
listener	function		监听器函数
scope	object	<optional>	监听器函数域
ahead	boolean	<optional>	是否将当前监听器插入到监听器列表开头

Returns:

void

disableGlobalKey() → {void}

禁用全局快捷键

Returns:

void

dispose() → {void}

销毁此组件

Returns:

void

enableGlobalKey() → {void}

启用全局快捷键，一旦启用此选项，菜单不再使用时需要显式调用dispose销毁菜单

Returns:

void

fireViewEvent(kind) → {void}

Parameters:

Name	Type	Description
kind	string

Returns:

void

getClass() → {function}

获取类声明(构造函数)

Returns:

function -

类声明(构造函数)

getDisabledDiv() → {HTMLElement}

获取被禁用组件的div

Returns:

HTMLElement -

被禁用组件的div

getDropDownMenu() → {any}

Returns:

any

getHeaderItemAlign() → {string}

获取根菜单项的对齐方式

Returns:

string -

根菜单项的对齐方式

getHeaderItemHGap() → {number}

获取根菜单项的水平间隔

Returns:

number -

根菜单项的水平间隔

getHeaderItemVGap() → {number}

获取根菜单项的垂直间隔

Returns:

number -

根菜单项的垂直间隔

getHeight() → {number}

获取布局高度

Returns:

number -

布局高度

getItemByProperty(property, value) → {object}

查找属性名为 property，值为value的菜单项，只返回第一个查找结果

Parameters:

Name	Type	Description
property	string	属性名
value	any	值

Returns:

object

getLayout() → {string}

获取布局方式

Returns:

string

getShowingMenuIndex() → {number}

获得当前显示下拉菜单的根菜单项的index，如果没有显示下拉菜单返回-1

Returns:

number -

当前显示下拉菜单的根菜单项的index

getSuperClass() → {function}

获取父类声明(构造函数)

Returns:

function -

父类声明(构造函数)

getView() → {HTMLDivElement}

获取组件的根层div

Returns:

HTMLDivElement

getWidth() → {number}

获取布局宽度

Returns:

number -

布局宽度

hideDropdownMenu() → {void}

隐藏下拉菜单

Returns:

void

invalidate(delay) → {void}

无效组件，并调用延时刷新

Parameters:

Name	Type	Attributes	Description
delay	number	<optional>	延迟刷新的间隔事件(单位:ms)

Returns:

void

See:

• iv

isDisabled() → {boolean}

组件是否处于不可用状态，处于此状态时不能进行任何操作并且会遮挡一层蒙板

Returns:

boolean

iv(delay) → {void}

无效组件，并调用延时刷新

Parameters:

Name	Type	Attributes	Description
delay	number	<optional>	延迟刷新的间隔事件(单位:ms)

Returns:

void

See:

• invalidate

layout(x, y, width, height) → {void}

执行布局

Parameters:

Name	Type	Description
x	number	视图左上角布局 x 点位置
y	number	视图左上角布局 y 点位置
width	number	视图宽度
height	number	视图高度

Returns:

void

removeViewListener(listener, scope) → {void}

删除视图事件监听器

Parameters:

Name	Type	Attributes	Description
listener	function		监听器函数
scope	object	<optional>	监听器函数域

Returns:

void

setAutoShow(v) → {void}

设置鼠标移入是否自动显示

Parameters:

Name	Type	Description
v	boolean

Returns:

void

setCursor(style) → {void}

设置 css 的鼠标样式，cursor

Parameters:

Name	Type	Description
style	string

Returns:

void

setDisabled(value, iconUrl) → {void}

设置组件是否处于不可用状态，处于不可用状态时不能进行任何操作并且会遮挡一层蒙板

Parameters:

Name	Type	Attributes	Description
value	boolean		是否禁用组件
iconUrl	string	<optional>	蒙板上显示的icon的路径

Returns:

void

setFocus(value) → {void}

根据值给组件设置焦点

Parameters:

Name	Type	Attributes	Description
value	string	<optional>

Returns:

void

setHeaderItemAlign(align) → {void}

设置根菜单项的对齐方式

Parameters:

Name	Type	Description
align	string	对齐方式

Returns:

void

setHeaderItemHGap(gap) → {void}

设置根菜单项的水平间隔

Parameters:

Name	Type	Description
gap	number	根菜单项的水平间隔

Returns:

void

setHeaderItemVGap(gap) → {void}

设置根菜单项的垂直间隔

Parameters:

Name	Type	Description
gap	number	根菜单项的垂直间隔

Returns:

void

setHeight(height) → {void}

设置布局高度

Parameters:

Name	Type	Description
height	number	高度值

Returns:

void

setHoverBackground(color) → {void}

设置鼠标划过根菜单时的背景色

Parameters:

Name	Type	Description
color	string	颜色

Returns:

void

setHoverColor(color) → {void}

设置鼠标划过根菜单时的文字颜色

Parameters:

Name	Type	Description
color	string	颜色

Returns:

void

setItems(json) → {void}

设置菜单项，参数为JSON对象

Parameters:

Name	Type	Description
json	string | Array.<MenuParams>	当数组对象为字符串 separator 时为分割线

Returns:

void

setLayout(layout) → {void}

设置布局方式，largeicons表示大图标模式，smallicons表示小图标模式，iconsonly表示仅图标模式

Parameters:

Name	Type	Description
layout	string	布局方式

Returns:

void

setWidth(width) → {void}

设置布局宽度

Parameters:

Name	Type	Description
width	number	宽度值

Returns:

void

showDropdownMenu(index) → {void}

显示下拉菜单，参数为根菜单项的index

Parameters:

Name	Type	Description
index	string | number	菜单项下标

Returns:

void

validate() → {void}

立刻刷新拓扑

Returns:

void

validateImpl() → {void}

刷新

Returns:

void