API Docs for: TWaver HTML5 5.7.5
Show:

twaver.controls.PopupMenu Class

右键菜单对象

用于创建和操作右键弹出菜单

Constructor

twaver.controls.PopupMenu

(
  • contextView
)
twaver.controls.PopupMenu

Parameters:

  • contextView Object

    HTML元素或者twaver.controles.ControlBase对象

Returns:

twaver.controls.PopupMenu:

返回右键菜单对象

Item Index

Methods

Methods

twaver.controls.PopupMenu.addMenuItem

(
  • menuItem
)

添加菜单项

Parameters:

  • menuItem Object

    包含id, type, icon, label, visible, enabled, separator, action, items, selected, groupName属性的对象

twaver.controls.PopupMenu.addSeparator

()

添加分隔条

twaver.controls.PopupMenu.dispose

()

销毁右键菜单对象，删除关联的视图的右键事件

twaver.controls.PopupMenu.getBackground

() String

获取背景颜色

Returns:

String:

返回背景颜色

twaver.controls.PopupMenu.getBorder

() String

获取边框颜色

Returns:

String:

返回边框颜色

twaver.controls.PopupMenu.getCheckboxSelectedIcon

() String

返回勾选框在选中状态时的图标名称

Returns:

String:

获取勾选框在选中状态时的图标名称

twaver.controls.PopupMenu.getCheckboxUnselectedIcon

() String

获取勾选框在未选中状态时的图标名称

Returns:

String:

返回勾选框在未选中状态时的图标名称

twaver.controls.PopupMenu.getClassName

() String

获取类名

Returns:

String:

返回类名

twaver.controls.PopupMenu.getColor

() String

获取菜单文字颜色

Returns:

String:

返回菜单的文字颜色值

twaver.controls.PopupMenu.getContextView

() Object

获取右键菜单关联的视图对象

Returns:

Object:

返回视图对象

twaver.controls.PopupMenu.getDisabledColor

() String

获取菜单项不可用时的文字颜色

Returns:

String:

返回菜单项不可用时的文字颜色

twaver.controls.PopupMenu.getFocusBackground

() String

获取菜单项高亮背景颜色

Returns:

String:

返回菜单项高亮背景颜色

twaver.controls.PopupMenu.getFocusColor

() String

获取菜单项高亮背景颜色

Returns:

String:

返回菜单项高亮背景颜色

twaver.controls.PopupMenu.getMenuItem

(
  • id
)
Object

根据编号返回菜单项

Parameters:

  • id String

    编号

Returns:

Object:

返回菜单项

twaver.controls.PopupMenu.getMenuItemById

(
  • id
)
Object

根据编号返回菜单项

Parameters:

  • id String

    编号

Returns:

Object:

返回菜单项

twaver.controls.PopupMenu.getMenuItemHeight

() Number

获取菜单项高度

Returns:

Number:

返回菜单项高度

twaver.controls.PopupMenu.getMenuItems

() Array

获取菜单项数组

Returns:

Array:

返回菜单项数组

twaver.controls.PopupMenu.getRadiobuttonSelectedIcon

() String

获取单选框在选中状态时的图标名称

Returns:

String:

返回单选框在选中状态时的图标名称

twaver.controls.PopupMenu.getRadiobuttonUnselectedIcon

() String

获取单选框在未选中状态时的图标名称

Returns:

String:

返回单选框在未选中状态时的图标名称

twaver.controls.PopupMenu.getSubMenuDisableIcon

() String

获取子菜单项不可用时的图标名称

Returns:

String:

返回子菜单项不可用时的图标名称

twaver.controls.PopupMenu.getSubMenuEnableIcon

() String

获取子菜单项可用时的图标名称

Returns:

String:

返回子菜单项可用时的图标名称

twaver.controls.PopupMenu.getView

() HTMLElement

获取右键菜单div元素

Returns:

HTMLElement:

返回右键菜单div元素

twaver.controls.PopupMenu.getWidth

() Number

获取右键菜单宽度

Returns:

Number:

返回右键菜单宽度

twaver.controls.PopupMenu.getXOffset

() Number

获取菜单x轴方向偏移量

Returns:

Number:

菜单在x轴方向偏移量

twaver.controls.PopupMenu.getYOffset

() String

获取菜单y轴方向偏移量

Returns:

String:

菜单在y轴方向偏移量

twaver.controls.PopupMenu.hide

()

隐藏右键菜单

twaver.controls.PopupMenu.isEnabled

(
  • menuItem
)
Boolean

获取菜单项是否可用，默认菜单项的enable属性不为false时可用

Parameters:

  • menuItem Object

    菜单项

Returns:

Boolean:

返回菜单项是否可用

twaver.controls.PopupMenu.isVisible

(
  • menuItem
)
Boolean

获取菜单项是否可见，默认菜单项的visible属性不为false时可用

Parameters:

  • menuItem Object

    菜单项

Returns:

Boolean:

返回菜单项是否可见

twaver.controls.PopupMenu.onAction

(
  • menuItem
)

菜单点击时的回调函数

Parameters:

  • menuItem Object

    菜单项

twaver.controls.PopupMenu.onMenuItemRendered

(
  • div
  • menuItem
)

菜单项绘制后的回调函数

Parameters:

  • div HTMLDivElement

    div元素

  • menuItem Object

    菜单项

twaver.controls.PopupMenu.onMenuShowing

(
  • e
)
Boolean

菜单显示前的回调函数，如果返回false，则右键菜单不显示

Parameters:

  • e MouseEvent

    鼠标事件

Returns:

Boolean:

返回值决定右键菜单是否显示

twaver.controls.PopupMenu.renderMenu

(
  • view
  • menuItems
)

绘制菜单

Parameters:

  • view HTMLDivElement

    HTML元素

  • menuItems Array

    菜单项数组

twaver.controls.PopupMenu.renderMenuItem

(
  • div
  • menuItem
)

绘制菜单项

Parameters:

  • div HTMLDivElement

    div元素

  • menuItem Object

    菜单项

twaver.controls.PopupMenu.setBackground

(
  • value
)

设置背景色

Parameters:

  • value String

    背景色

twaver.controls.PopupMenu.setBorder

(
  • value
)

设置边框颜色

Parameters:

  • value String

    颜色

twaver.controls.PopupMenu.setCheckboxSelectedIcon

(
  • value
)

设置勾选框在选中状态时的图标名称

Parameters:

  • value String

    勾选框在选中状态时的图标名称

twaver.controls.PopupMenu.setCheckboxUnselectedIcon

(
  • value
)

设置勾选框在未选中状态时的图标名称

Parameters:

  • value String

    勾选框在未选中状态时的图标名称

twaver.controls.PopupMenu.setColor

(
  • value
)

设置菜单文字颜色

Parameters:

  • value String

    颜色值

twaver.controls.PopupMenu.setContextView

(
  • contextView
)

设置右键菜单关联的视图对象

Parameters:

  • contextView Object

    右键菜单关联的视图对象

twaver.controls.PopupMenu.setDisabledColor

(
  • value
)

设置菜单项不可用时的文字颜色

Parameters:

  • value String

    菜单项不可用时的文字颜色

twaver.controls.PopupMenu.setFocusBackground

(
  • value
)

设置菜单项高亮背景颜色

Parameters:

  • value String

    颜色值

twaver.controls.PopupMenu.setFocusColor

(
  • value
)

设置菜单项高亮背景颜色

Parameters:

  • value String

    菜单项高亮背景颜色

twaver.controls.PopupMenu.setMenuItemHeight

(
  • value
)

设置菜单项高度

Parameters:

  • value Number

    菜单项高度

twaver.controls.PopupMenu.setMenuItems

(
  • menuItems
)

设置菜单项数组

Parameters:

  • menuItems Array

    菜单项数组

twaver.controls.PopupMenu.setRadiobuttonSelectedIcon

(
  • value
)

设置单选框在选中状态时的图标名称

Parameters:

  • value String

    单选框在选中状态时的图标名称

twaver.controls.PopupMenu.setRadiobuttonUnselectedIcon

(
  • value
)

设置单选框在未选中状态时的图标名称

Parameters:

  • value String

    单选框在未选中状态时的图标名称

twaver.controls.PopupMenu.setSubMenuDisableIcon

(
  • value
)

设置子菜单项不可用时的图标名称

Parameters:

  • value String

    子菜单项不可用时的图标名称

twaver.controls.PopupMenu.setSubMenuEnableIcon

(
  • value
)

设置子菜单项可用时的图标名称

Parameters:

  • value String

    子菜单项可用时的图标名称

twaver.controls.PopupMenu.setWidth

(
  • value
)

设置右键菜单宽度

Parameters:

  • value Number

    宽度

twaver.controls.PopupMenu.setXOffset

(
  • value
)

设置菜单x轴方向偏移量

Parameters:

  • value String

    菜单在x轴方向偏移量

twaver.controls.PopupMenu.setYOffset

(
  • value
)

设置菜单y轴方向偏移量

Parameters:

  • value String

    菜单在y轴方向偏移量

twaver.controls.PopupMenu.show

(
  • e
)

显示右键菜单

Parameters:

  • e Object

    鼠标事件