ContextMenu 类

全称	mx.controls.ContextMenu
命名空间	mx.controls
类	ContextMenu
继承层次结构	ContextMenuToolStripControl
源文件	~\mx\scripts\controls\ContextMenu.js

提供一个上下文菜单的类，该上下文菜单使控件能够公开特定于该控件的上下文的功能。

示例 1

以下是一个创建 ContextMenu 的示例。该示例将说明如何创建一个 ContextMenu，如何添加菜单项，以及如何订购菜单项的事件。

JavaScript 代码

JavaScript 代码
var contextMenu = new mx.controls.ContextMenu({ items: [ { name: "new", text: "新建", items: [{ name: "file", text: "文件" }] }, // 菜单项可以嵌套，表示子菜单 { name: "open", text: "打开", imageKey: "open" }, // 使用“$/icons”目录中的“open.png”图片 "-", // 表示分隔符 { name: "close", text: "关闭", enabled: false } ], // 菜单项集合 onitemclick: _contextMenuItem_click }); contextMenu.show(300, 400); function _contextMenuItem_click(e) { alert(e.item.text); }

var contextMenu = new mx.controls.ContextMenu({
    items: [
        { name: "new", text: "新建", items: [{ name: "file", text: "文件" }] }, // 菜单项可以嵌套，表示子菜单
        { name: "open", text: "打开", imageKey: "open" },  // 使用“$/icons”目录中的“open.png”图片
        "-", // 表示分隔符
        { name: "close", text: "关闭", enabled: false }
    ], // 菜单项集合
    onitemclick: _contextMenuItem_click
});
contextMenu.show(300, 400);

function _contextMenuItem_click(e)
{
   alert(e.item.text);
}

构造函数

名称	说明
ContextMenu()	构建 ContextMenu 类的新实例。

初始化函数

名称	说明
init()

方法

名称	说明
appendItem(p_item)	将 ToolStripItem 对象添加到集合 items 中，并返回该对象。
appendItem(p_name, [p_text], [p_image])	将 ToolStripItem 对象添加到集合 items 中，并返回该对象。
appendItems(p_items)	向 ToolStrip 的项集合（items 集合）中添加一组新项。
appendSeparator([p_name])	将 ToolSeparator 分隔符添加到集合 items 中，并返回该对象。
clearItems()	从 items 集合中移除所有的项。若要从 ToolStrip 中移除单个项，请使用 removeItem 方法。
contains($p_target)	返回一个 Boolean 值，该值表示控件的容器中是否包含该 JQuery 对象。
dispose()	释放对象运行时动态生成的内容（属性、方法、事件）。
getContext()	获取控件当前所属 Weblet 的上下文信息（ WebletContext 类型）。
getEl()	获取控件容器对应的 HTML DOM 元素对象。
getItem(p_commands)	根据菜单项的名称查找并返回对应的菜单项。如果该菜单项为子菜单中的项，可以使用“/”将上级菜单分隔开来（如 “new/newFile”）。
getItemByName(p_name)	提供一个方法，根据指定的 ToolStripItem.name 值获取一级 ToolStripItem 项。该方法不支持递归查找，如果需要请使用 getItem方法
hasChildren()	返回一个 Boolean 值，表示控件是否有项，也表示 items 集合的 length 属性是否大于 0。如果该值为 true，则表示控件中有项；反之则没有。
hide()	隐藏控件，设置控件不可见。
hideDropDown(p_speed)	请参见 ToolStripItem.hideDropDown 方法。该方法仅在 dropDownChildItem 字段不为空时有效。
insertItem(p_position, p_item, p_direction)	在指定位置插入一个 ToolStripItem 对象。
insertItemAfter(p_position, p_item)	在指定位置后插入一个 ToolStripItem 对象。
insertItemBefore(p_position, p_item)	在指定位置前插入一个 ToolStripItem 对象。
insertSeparator(p_position, p_item, p_direction)	在指定位置插入一个 ToolSeparator 分隔符。
insertSeparatorAfter(p_position, p_item)	在指定位置后插入一个 ToolSeparator 分隔符。
insertSeparatorBefore(p_position, p_item)	在指定位置前插入一个 ToolSeparator 分隔符。
moveTo(p_left, p_top)	移动控件到指定位置。
removeByIndex(p_index)	删除指定位置的 ToolStripItem 对象。
removeByName(p_name)	提供一个方法，根据指定值删除 ToolStripItem 对象。
removeItem(p_item)	从 items 集合中移除指定的 ToolStripItem 对象。从集合中移除项时，有关移除的项的所有信息均会被删除。若要从集合中移除所有项，请使用 clearItems 方法。该方法只能删除一级菜单项。
resizeTo(p_width, p_height)	重设控件的大小。
setBorder(p_border)	设置控件的边框样式。
setBottom(p_bottom)	设置 bottom 字段的值。
setCss(p_css)	设置 css 字段的值。
setCssClass(p_cssClass)	设置 cssClass} 字段的值
setDisplay(p_display)	设置 display 字段的值。
setEnabled(p_enabled)	设置 enabled 字段的值。
setHeight(p_height)	设置 height 字段的值。
setItems(p_items)	设置 items 字段的值。该方法首先会清空 items 集合。
setLeft(p_left)	设置 left 字段的值。
setPadding(p_padding)	设置控件的内边距。
setPosition(p_position)	设置 position 字段的值。
setRight(p_right)	设置 right 字段的值。
setTop(p_top)	设置 top 字段的值。
setVisible(p_visible)	设置 visible 字段的值。
setWidth(p_width)	设置 width 字段的值。
show(x, y, speed)	显示上下文菜单。该方法会触发 ondropdown 和 ondroppingdown 事件。
updateItemsVisibility(p_items)	将指定的所有菜单项重新布局，并返回一个 Boolean 值，表示是否显示菜单项。规则为第一和最后一个可见项应该为 ToolStripItem 类型，并且中间不能出现连续的分割线。
$(p_expression)	该方法与 me.$e.find(p_expression) 等同。
$wrap([p_obj])	返回一个 JQuery 对象。
_appendItem(p_item)	受保护的。将指定的项（通常是 ToolStripItem 类型和 ToolSeparator 类型）添加到集合 items 中，并返回该对象。

字段

名称	说明
alias	获取或设置一个字符串，表示控件的别名。
border	获取控件的边框样式。如“1px solid red”，表示边框的样式为 1 像素红色的实线。请使用 setBorder 方法设置该字段的值。
bottom	获取控件的下边界与父容器下边界的像素距离。请使用 setBottom 方法设置该字段的值。
cssClass	指定css伪类名称，设置控件显示样式
defaultItemType	获取 ToolStrip.items 集合中项的默认类型。详见 ToolStrip.defaultItemType 字段。
display	获取控件的显示样式值。如“none”，表示隐藏控件； “block”表示强制作为块对象呈递。请使用 setDisplay。注：该"block"值不能在ComplexGrid控件中使用。方法设置该字段的值。
enabled	获取控件是否可以对用户交互作出响应。如果该值为 true，则表示控件可以对用户交互作出响应；反之则不能。请使用 setEnabled 方法设置该字段的值。
height	获取控件的高度。可以是数字（如 500）、字符串（如“500px”或“50%”）。请使用 setHeight 方法设置该字段的值。
imageSize	获取 ToolStripItem 图片的大小。该字段必须在初始化前设置。
itemAlign	获取或设置菜单项的对齐方式，请在初始化之前设置该字段的值。该字段的可选值包括: right left
items	获取一个集合，包含 ToolStrip 中所有的项（ToolStripItem 类型）。请使用 setItems 方法设置该字段的值。
layoutConfigs	获取或者设置一个 JSON 对象，该属性表示控件在父容器中的布局配置参数。该属性只有在控件父容器运用布局器才会生效。
left	获取控件的左边界与父容器左边界的像素距离。请使用 setLeft 方法设置该字段的值。
padding	获取控件的内边距。如“4px”表示上下左右的内边距均为 4 像素； “4px 2px 3px 1px”则表示上边距为 4 像素，右边距为 2 像素，下边距为 3 像素，左边距为 1 像素。请使用 setPadding 方法设置该字段的值。
parent	获取控件所属的父对象。
permissionID	获取或设置一个字符串，表示控件的权限标识。
position	获取控件位置样式值。如“static”，表示无特殊定位，对象遵循 HTML 定位规则。请使用 setPosition 方法设置该字段的值。该字段的可选值包括: static relative absolute fixed
right	获取控件的右边界与父容器右边界的像素距离。请使用 setRight 方法设置该字段的值。
symbolSize	获取或设置一个值，表示字符图标文本的大小。
toolStripType	获取一个字符串，表示控件的类型。详见 ToolStrip.toolStripType 字段。
top	获取控件的上边界与父容器上边界的像素距离。请使用 setTop 方法设置该字段的值。
useSymbol	获取或设置一个值，表示显示字符图标还是普通文本。请参见 SymbolUtilClass。
visible	获取一个 Boolean 值，表示控件是否可见。如果该值为 true，则表示控件可见；反之则不可见。请使用 setVisible 方法设置该字段的值。
width	获取控件的宽度。可以是数字（如 500）、字符串（如“500px”或“50%”）。请使用 setWidth 方法设置该字段的值。
$e	获取该控件的占位符，该占位符为一个 JQuery 对象。
$left_scroll_div
$right_scroll_div

事件

名称	说明
ondropdown	当显示子菜单时将触发该事件。调用 show 方法时会触发该事件。
ondroppingdown	当显示子菜单之前，会触发该事件。调用 show 方法时会触发该事件。
onhidedropdown	当子项收缩时，会触发该事件。调用 ToolStripItem.hideDropDown 方法后会触发该事件。
onitemclick	当单击控件中 ToolStripItem 的时候，将触发该事件。
onitemmousedown	当鼠标在 ToolStripItem 上按下时触发该事件。

构造函数详细信息

ContextMenu() 方法

构建 ContextMenu 类的新实例。

初始化函数详细信息

init() 方法

继承自

mx.controls.ToolStrip.init

方法详细信息

appendItem(p_item) 方法

将 ToolStripItem 对象添加到集合 items 中，并返回该对象。

参数

p_item
一个 ToolStripItem 对象，表示要添加的项。

继承自

mx.controls.ToolStrip.appendItem

appendItem(p_name, [p_text], [p_image]) 方法

将 ToolStripItem 对象添加到集合 items 中，并返回该对象。

参数

p_name
一个字符串，表示添加的 ToolStripItem 对象的名称（ToolStripItem.name 字段的值）；当参数只有 p_name 一个时，也可以作为一个 JSON 对象（如 { name:"new", text:"新建" }），表示 ToolStripItem 的一组属性值。
p_text
可选的。一个字符串，表示 ToolStripItem 对象的 ToolStripItem.text 字段的值。
p_image
可选的。一个字符串，表示 ToolStripItem 图标的 URL。详见 {mx.controls.ToolStripItem.iamge} 字段。

继承自

mx.controls.ToolStrip.appendItem

appendItems(p_items) 方法

向 ToolStrip 的项集合（items 集合）中添加一组新项。

参数

p_items
一个数组，该数组包含了一组新项。

继承自

mx.controls.ToolStrip.appendItems

appendSeparator([p_name]) 方法

将 ToolSeparator 分隔符添加到集合 items 中，并返回该对象。

参数

p_name
可选的。一个 ToolSeparator 对象；或一个 JSON 对象，表示 ToolSeparator 对象的一组属性值。

继承自

mx.controls.ToolStrip.appendSeparator

clearItems() 方法

从 items 集合中移除所有的项。若要从 ToolStrip 中移除单个项，请使用 removeItem 方法。

继承自

mx.controls.ToolStrip.clearItems

contains($p_target) 方法

返回一个 Boolean 值，该值表示控件的容器中是否包含该 JQuery 对象。

参数

$p_target
一个 JQuery 对象，或 JQuery 选择器对应的字符串（如“#container”），或 HTML DOM 元素。

继承自

mx.controls.Control.contains

dispose() 方法

释放对象运行时动态生成的内容（属性、方法、事件）。

继承自

mx.controls.Control.dispose

getContext() 方法

获取控件当前所属 Weblet 的上下文信息（ WebletContext 类型）。

继承自

mx.controls.Control.getContext

getEl() 方法

获取控件容器对应的 HTML DOM 元素对象。

继承自

mx.controls.Control.getEl

getItem(p_commands) 方法

根据菜单项的名称查找并返回对应的菜单项。如果该菜单项为子菜单中的项，可以使用“/”将上级菜单分隔开来（如 “new/newFile”）。

参数

p_commands
一个字符串，表示上级菜单与下级菜单，中间以“/”分隔。

继承自

mx.controls.ToolStrip.getItem

getItemByName(p_name) 方法

提供一个方法，根据指定的 ToolStripItem.name 值获取一级 ToolStripItem 项。该方法不支持递归查找，如果需要请使用 getItem方法

参数

p_name
一个字符串，表示要选中的 ToolStripItem 对象的 ToolStripItem.name 属性的值。

继承自

mx.controls.ToolStrip.getItemByName

hasChildren() 方法

返回一个 Boolean 值，表示控件是否有项，也表示 items 集合的 length 属性是否大于 0。如果该值为 true，则表示控件中有项；反之则没有。

继承自

mx.controls.ToolStrip.hasChildren

hide() 方法

隐藏控件，设置控件不可见。

继承自

mx.controls.Control.hide

hideDropDown(p_speed) 方法

请参见 ToolStripItem.hideDropDown 方法。该方法仅在 dropDownChildItem 字段不为空时有效。

参数

p_speed

继承自

mx.controls.ToolStrip.hideDropDown

insertItem(p_position, p_item, p_direction) 方法

在指定位置插入一个 ToolStripItem 对象。

参数

p_position
表示待插入的位置，通常是一个索引值。
p_item
表示待插入的 ToolStripItem 对象实例或者 JSON 对象。
p_direction
一个 Boolean 值，该值表示插入的方向，当值为 true 表示向后插入，反之为向前插入。默认为 true。

继承自

mx.controls.ToolStrip.insertItem

insertItemAfter(p_position, p_item) 方法

在指定位置后插入一个 ToolStripItem 对象。

参数

p_position
表示插入位置，通常是一个索引值。
p_item
表示待插入的 ToolStripItem 对象实例或者 JSON 对象。

继承自

mx.controls.ToolStrip.insertItemAfter

insertItemBefore(p_position, p_item) 方法

在指定位置前插入一个 ToolStripItem 对象。

参数

p_position
表示插入的位置，通常是一个索引值。
p_item
表示待插入的 ToolStripItem 对象实例或者 JSON 对象。

继承自

mx.controls.ToolStrip.insertItemBefore

insertSeparator(p_position, p_item, p_direction) 方法

在指定位置插入一个 ToolSeparator 分隔符。

参数

p_position
表示插入的位置，通常是一个索引值。
p_item
表示待插入的 ToolSeparator 对象实例或者字符串分割符 "-" 。
p_direction
一个 Boolean 值，该值表示插入的方向，当值为 true 表示向后插入，反之为向前插入。默认为 true。

继承自

mx.controls.ToolStrip.insertSeparator

insertSeparatorAfter(p_position, p_item) 方法

在指定位置后插入一个 ToolSeparator 分隔符。

参数

p_position
表示插入的位置，通常是一个索引值。
p_item
表示待插入的 ToolSeparator 对象实例或者字符串分割符 "-" 。

继承自

mx.controls.ToolStrip.insertSeparatorAfter

insertSeparatorBefore(p_position, p_item) 方法

在指定位置前插入一个 ToolSeparator 分隔符。

参数

p_position
表示插入的位置，通常是一个索引值。
p_item
表示待插入的 ToolSeparator 对象实例或者字符串分割符 "-" 。

继承自

mx.controls.ToolStrip.insertSeparatorBefore

moveTo(p_left, p_top) 方法

移动控件到指定位置。

参数

p_left
一个数字，表示 css 样式的 left 属性。
p_top
一个数字，表示 css 样式的 top 属性。

继承自

mx.controls.Control.moveTo

removeByIndex(p_index) 方法

删除指定位置的 ToolStripItem 对象。

参数

p_index
一个数字（如 0），表示 items 集合中项的序号。

继承自

mx.controls.ToolStrip.removeByIndex

removeByName(p_name) 方法

提供一个方法，根据指定值删除 ToolStripItem 对象。

参数

p_name
一个数字或者字符串，表示要刪除的 ToolStripItem 对象的 ToolStripItem.name 属性的值。该方法只能删除一级子项。

继承自

mx.controls.ToolStrip.removeByName

removeItem(p_item) 方法

从 items 集合中移除指定的 ToolStripItem 对象。从集合中移除项时，有关移除的项的所有信息均会被删除。若要从集合中移除所有项，请使用 clearItems 方法。该方法只能删除一级菜单项。

参数

p_item
一个 ToolStripItem 对象。

继承自

mx.controls.ToolStrip.removeItem

resizeTo(p_width, p_height) 方法

重设控件的大小。

参数

p_width
控件的宽度，可以是数字（如 100），也可以是字符串（如 “100%”）。
p_height
控件的高度，可以是数字（如 100），也可以是字符串（如 “100%”）。

继承自

mx.controls.Control.resizeTo

setBorder(p_border) 方法

设置控件的边框样式。

参数

p_border
一个字符串，表示css样式的 border 属性。

继承自

mx.controls.Control.setBorder

setBottom(p_bottom) 方法

设置 bottom 字段的值。

参数

p_bottom
控件的下边界与父容器下边界的像素距离，可以是数字（如 50），也可以是字符串（如 50%）。

继承自

mx.controls.Control.setBottom

setCss(p_css) 方法

设置 css 字段的值。

参数

p_css
一个 JSON 对象，表示控件的 CSS 样式。

继承自

mx.controls.Control.setCss

setCssClass(p_cssClass) 方法

设置 cssClass} 字段的值

参数

p_cssClass
一个String 对象，样式classname

继承自

mx.controls.Control.setCssClass

setDisplay(p_display) 方法

设置 display 字段的值。

参数

p_display
css 样式的 display 属性。

继承自

mx.controls.Control.setDisplay

setEnabled(p_enabled) 方法

设置 enabled 字段的值。

参数

p_enabled

继承自

mx.controls.Control.setEnabled

setHeight(p_height) 方法

设置 height 字段的值。

参数

p_height
控件的高度，可以是数字（如 100），也可以是字符串（如 “100%”）。

继承自

mx.controls.Control.setHeight

setItems(p_items) 方法

设置 items 字段的值。该方法首先会清空 items 集合。

参数

p_items
一个数组，该数组包含了一组 ToolStripItem 对象。

继承自

mx.controls.ToolStrip.setItems

setLeft(p_left) 方法

设置 left 字段的值。

参数

p_left
控件的左边界与父容器左边界的像素距离，可以是数字（如 50），也可以是字符串（如 50%）。

继承自

mx.controls.Control.setLeft

setPadding(p_padding) 方法

设置控件的内边距。

参数

p_padding
一个字符串，表示css样式的 padding 属性。

继承自

mx.controls.Control.setPadding

setPosition(p_position) 方法

设置 position 字段的值。

参数

p_position
一个字符串，表示 css 样式的 position 属性。

继承自

mx.controls.Control.setPosition

setRight(p_right) 方法

设置 right 字段的值。

参数

p_right
控件的右边界与父容器右边界的像素距离，可以是数字（如 50），也可以是字符串（如 50%）。

继承自

mx.controls.Control.setRight

setTop(p_top) 方法

设置 top 字段的值。

参数

p_top
控件的上边界与父容器上边界的像素距离，可以是数字（如 50），也可以是字符串（如 50%）。

继承自

mx.controls.Control.setTop

setVisible(p_visible) 方法

设置 visible 字段的值。

参数

p_visible
一个 Boolean 值，表示控件是否可见。

继承自

mx.controls.Control.setVisible

setWidth(p_width) 方法

设置 width 字段的值。

参数

p_width
控件的高度,可以是数字（如 500）、字符串（如“500px”或“50%”）.

继承自

mx.controls.Control.setWidth

show(x, y, speed) 方法

显示上下文菜单。该方法会触发 ondropdown 和 ondroppingdown 事件。

参数

x
一个数字，表示容器左边缘相对于父容器左边缘的距离。
y
一个数字，表示容器上边缘相对于父容器上边缘的距离。
speed
三种预定速度之一的字符串（"slow", "normal", or "fast"）或表示动画时长的毫秒数值（如 1000）。

继承自

mx.controls.Control.show

updateItemsVisibility(p_items) 方法

将指定的所有菜单项重新布局，并返回一个 Boolean 值，表示是否显示菜单项。规则为第一和最后一个可见项应该为 ToolStripItem 类型，并且中间不能出现连续的分割线。

参数

p_items

继承自

mx.controls.ToolStrip.updateItemsVisibility

$(p_expression) 方法

该方法与 me.$e.find(p_expression) 等同。

参数

p_expression

继承自

mx.controls.Control.$

$wrap([p_obj]) 方法

返回一个 JQuery 对象。

参数

p_obj
可选的。默认值为“me.$e”。一个 JQuery 对象，或继承自 Control 的控件，或字符串，或 HTML DOM 元素。如果参数为 JQuery 对象，则返回本身；如果参数为继承自 Control 的控件，则返回控件的 $e 对象；如果参数为字符串，则返回以字符串为选择器的 JQuery 对象；如果参数为空，则返回控件本身的 $e 对象。