ToolBarItem 类

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

提供一个在 ToolBar 控件中显示的菜单项的类。

构造函数

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

初始化函数

名称	说明
init()	初始化方法。执行设置样式并初始化属性等操作。

方法

名称	说明
appendItem(p_item)	将 ToolStripItem 对象添加到集合 items 中，并返回该对象。
appendItem(p_name, [p_text], [p_image])	将 ToolStripItem 对象添加到集合 items 中，并返回该对象。
appendItems(p_items)	向 ToolStripItem 的项集合（items 集合）中添加一组新项。
appendSeparator([p_name])	将 ToolSeparator 分隔符添加到集合 items 中，并返回该对象。
clearItems()	从 items 集合中移除所有的项。若要从 ToolStripItem 中移除单个项，请使用 removeItem 方法。
contains($p_target)	返回一个 Boolean 值，该值表示控件的容器中是否包含该 JQuery 对象。
dispose()	释放对象运行时动态生成的内容（属性、方法、事件）。
dropDown(p_speed)	显示 ToolStripItem 所有的子项。该方法会触发 ondropdown 和 ondroppingdown 事件。
getContext()	获取控件当前所属 Weblet 的上下文信息（ WebletContext 类型）。
getEl()	获取控件容器对应的 HTML DOM 元素对象。
getIndex()	当 parent 字段不为空时，返回该项在父 ToolStripItem 的 items 集合中的序号（0 代表第一个）；当 parent 字段为空并且 owner 字段不为空时，返回该项在 ToolStrip 的 ToolStrip.items 集合中的序号（0 代表第一个）。如果该对象的 parent 和 owner 字段都为空，则返回 -1。
getItemByName(p_name)	提供一个方法，根据指定的 ToolStripItem.name 值选中 ToolStripItem 项。
hasChildren()	返回一个 Boolean 值，表示该项是否有子项，也表示 items 集合的 length 属性是否大于 0。如果该值为 true，则表示该项包含子项；反之则没有。
hide()	将该 ToolStripItem 置为不可见，即将 visible 字段置为 false。
hideDropDown(p_speed)	隐藏 ToolStripItem 所有的子项。
makeGroup()	设置 isGroup 字段值为 true。
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 字段的值。
setChecked(p_checked)	设置 checked 字段的值。
setCss(p_css)	设置 css 字段的值。
setCssClass(p_cssClass)	设置 cssClass} 字段的值
setDisplay(p_display)	设置 display 字段的值。
setEnabled(p_enabled)	设置 enabled 字段的值。
setFont([p_fontFamily], [p_fontSize], [p_fontWeight], [p_fontStyle])	设置 ToolStripItem 的显示文本的文本特性。
setHeight(p_height)	设置 height 字段的值。
setHtml(p_html)	设置 text 字段的值。
setImageKey([p_imageKey])	设置 imageKey 字段的值。该方法会在 $/icons/ 目录中查找相应的 png 图片。($/icons/ 指 mx/resources/icons/)
setImageUrl(p_image)	设置 image 字段的值。
setItems(p_items)	设置 items 字段的值。该方法首先会清空 items 集合。
setLeft(p_left)	设置 left 字段的值。
setLink()	设置 ToolStripItem.$link 字段值。
setPadding(p_padding)	设置控件的内边距。
setPosition(p_position)	设置 position 字段的值。
setRight(p_right)	设置 right 字段的值。
setText(p_text)	设置 text 字段的值。
setToolTip(p_toolTip)	设置 toolTip 字段的值。
setTop(p_top)	设置 top 字段的值。
setVisible(p_visible)	设置 visible 字段的值。
setWidth(p_width)	设置 width 字段的值。
show()	将该 ToolStripItem 置为可见，即将 visible 字段置为 true。
toggleChecked()	切换选中状态。
$(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 方法设置该字段的值。
checked	获取一个 Boolean 值，表示该项是否为选择项。如果该值为 true，则该项前面会出现打钩的图片，表示选择了该项；反之则没有选择。请使用 setChecked 方法设置该字段的值。
cssClass	指定css伪类名称，设置控件显示样式
display	获取控件的显示样式值。如“none”，表示隐藏控件； “block”表示强制作为块对象呈递。请使用 setDisplay。注：该"block"值不能在ComplexGrid控件中使用。方法设置该字段的值。
droppedDown	获取一个 Boolean 值，表示子项是否显示。如果该值为 true，表示子项已显示；反之则隐藏。该字段与 ToolStripItem.dropDown 方法和 ToolStripItem.hideDropDown 方法有关。
enabled	获取该项是否可以对用户交互作出响应。如果该值为 true，则表示可以对用户交互作出响应；反之则不能。请使用 setEnabled 方法设置该字段的值。
height	获取控件的高度。可以是数字（如 500）、字符串（如“500px”或“50%”）。请使用 setHeight 方法设置该字段的值。
imageKey	获取一个字符串，表示 ToolStripItem 图像的名称。请使用 setImageKey 方法设置该字段的值。
imageUrl	获取一个字符串，表示 ToolStripItem 图像的 URL（如“~/icons/save.png”）。请使用 setImageUrl 方法设置该字段的值。
isGroup	获取一个 Boolean 值，表示该项是否包含子项。如果该值为 true，表示有子项；反之则没有。通常 items 集合的 length 属性大于 0，该字段就为 true。如果要将该值设为 true，请使用 makeGroup 方法。
isSeparator	获取该项是否为分隔符。如果为 true，表示该项为分隔符；反之则不是。
items	获取一个集合，包含所有的子项（ToolStripItem 类型）。请使用 setItems 方法设置该字段的值。
layoutConfigs	获取或者设置一个 JSON 对象，该属性表示控件在父容器中的布局配置参数。该属性只有在控件父容器运用布局器才会生效。
left	获取控件的左边界与父容器左边界的像素距离。请使用 setLeft 方法设置该字段的值。
name	获取或设置项的名称。
owner	获取该项的父容器的对象，通常是一个 ToolStrip 类型的实例。
padding	获取控件的内边距。如“4px”表示上下左右的内边距均为 4 像素； “4px 2px 3px 1px”则表示上边距为 4 像素，右边距为 2 像素，下边距为 3 像素，左边距为 1 像素。请使用 setPadding 方法设置该字段的值。
parent	获取该项的父 ToolStripItem 对象。如果没有，则为 null。
permissionID	获取或设置一个字符串，表示控件的权限标识。
position	获取控件位置样式值。如“static”，表示无特殊定位，对象遵循 HTML 定位规则。请使用 setPosition 方法设置该字段的值。该字段的可选值包括: static relative absolute fixed
right	获取控件的右边界与父容器右边界的像素距离。请使用 setRight 方法设置该字段的值。
symbolSize	获取或设置一个值，表示字符图标文本的大小。
text	获取要显示在项上的文本。请使用 setText 方法设置该字段的值。
toolTip	获取一个字符串，表示用户将鼠标悬停在该项上时显示的简短说明。请使用 setToolTip 方法设置该字段的值。
top	获取控件的上边界与父容器上边界的像素距离。请使用 setTop 方法设置该字段的值。
useSymbol	获取或设置一个值，表示显示字符图标还是普通文本。请参见 SymbolUtilClass。
visible	获取该项是否为可见状态。如果该值为 true，则表示可见；反之则不可见。请使用 setVisible 方法设置该字段的值。
width	获取控件的宽度。可以是数字（如 500）、字符串（如“500px”或“50%”）。请使用 setWidth 方法设置该字段的值。
$e	获取该控件的占位符，该占位符为一个 JQuery 对象。
$link	设置该项接受点击事件的对象，请使用 setLink 方法设置该值。

事件

名称	说明
onclick	在单击 ToolStripItem 时触发该事件。
ondropdown	当该项的子项显示时，会触发该事件。调用 dropDown 方法后会触发该事件。
ondroppingdown	当该项的子项显示之前，会触发该事件。调用 dropDown 方法时会触发该事件。

构造函数详细信息

ToolBarItem() 方法

构建 ToolBarItem 类的新实例。

初始化函数详细信息

init() 方法

初始化方法。执行设置样式并初始化属性等操作。

继承自

mx.controls.ToolStripItem.init

方法详细信息

appendItem(p_item) 方法

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

参数

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

继承自

mx.controls.ToolStripItem.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.ToolStripItem.appendItem

appendItems(p_items) 方法

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

参数

p_items
一个数组，该数组包含了一组新项（ToolStripItem 类型）。

继承自

mx.controls.ToolStripItem.appendItems

appendSeparator([p_name]) 方法

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

参数

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

继承自

mx.controls.ToolStripItem.appendSeparator

clearItems() 方法

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

继承自

mx.controls.ToolStripItem.clearItems

contains($p_target) 方法

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

参数

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

继承自

mx.controls.Control.contains

dispose() 方法

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

继承自

mx.controls.Control.dispose

dropDown(p_speed) 方法

显示 ToolStripItem 所有的子项。该方法会触发 ondropdown 和 ondroppingdown 事件。

参数

p_speed
三种预定速度之一的字符串（“slow”，“normal”，“fast”）或表示动画时长的毫秒数值（如：1000）。

继承自

mx.controls.ToolStripItem.dropDown

getContext() 方法

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

继承自

mx.controls.Control.getContext

getEl() 方法

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

继承自

mx.controls.Control.getEl

getIndex() 方法

当 parent 字段不为空时，返回该项在父 ToolStripItem 的 items 集合中的序号（0 代表第一个）；当 parent 字段为空并且 owner 字段不为空时，返回该项在 ToolStrip 的 ToolStrip.items 集合中的序号（0 代表第一个）。如果该对象的 parent 和 owner 字段都为空，则返回 -1。

继承自

mx.controls.ToolStripItem.getIndex

getItemByName(p_name) 方法

提供一个方法，根据指定的 ToolStripItem.name 值选中 ToolStripItem 项。

参数

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

继承自

mx.controls.ToolStripItem.getItemByName

hasChildren() 方法

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

继承自

mx.controls.ToolStripItem.hasChildren

hide() 方法

将该 ToolStripItem 置为不可见，即将 visible 字段置为 false。

继承自

mx.controls.ToolStripItem.hide

hideDropDown(p_speed) 方法

隐藏 ToolStripItem 所有的子项。

参数

p_speed
三种预定速度之一的字符串（“slow”，“normal”，“fast”）或表示动画时长的毫秒数值（如：1000）。

继承自

mx.controls.ToolStripItem.hideDropDown

makeGroup() 方法

设置 isGroup 字段值为 true。

继承自

mx.controls.ToolStripItem.makeGroup

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.ToolStripItem.removeByIndex

removeByName(p_name) 方法

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

参数

p_name
一个数字或者字符串，表示要刪除的 ToolStripItem 对象的 ToolStripItem.name 属性的值。

继承自

mx.controls.ToolStripItem.removeByName

removeItem(p_item) 方法

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

参数

p_item
一个 ToolStripItem 对象。

继承自

mx.controls.ToolStripItem.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

setChecked(p_checked) 方法

设置 checked 字段的值。

参数

p_checked

继承自

mx.controls.ToolStripItem.setChecked

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.ToolStripItem.setEnabled

setFont([p_fontFamily], [p_fontSize], [p_fontWeight], [p_fontStyle]) 方法

设置 ToolStripItem 的显示文本的文本特性。

参数

p_fontFamily
可选的。一个字符串，表示字体的名称。可参见 css 的 font-family 属性。
p_fontSize
可选的。一个数字或字符串，表示字体的尺寸。可参见 css 的 font-size 属性。
p_fontWeight
可选的。一个字符串，表示字体的粗细。可参见 css 的 font-weight 属性。
p_fontStyle
可选的。一个字符串，表示字体的样式。可参见 css 的 font-style 属性。

继承自

mx.controls.ToolStripItem.setFont

setHeight(p_height) 方法

设置 height 字段的值。

参数

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

继承自

mx.controls.Control.setHeight

setHtml(p_html) 方法

设置 text 字段的值。

参数

p_html
一段 html 代码。

继承自

mx.controls.ToolStripItem.setHtml

setImageKey([p_imageKey]) 方法

设置 imageKey 字段的值。该方法会在 $/icons/ 目录中查找相应的 png 图片。($/icons/ 指 mx/resources/icons/)

参数

p_imageKey
可选的。一个字符串，表示图片的名称。如 $/icons 目录中有一张图片为“role_48.png”或“role.png”的图片，那么该参数都是“role”。

继承自

mx.controls.ToolStripItem.setImageKey

setImageUrl(p_image) 方法

设置 image 字段的值。

参数

p_image

继承自

mx.controls.ToolStripItem.setImageUrl

setItems(p_items) 方法

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

参数

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

继承自

mx.controls.ToolStripItem.setItems

setLeft(p_left) 方法

设置 left 字段的值。

参数

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

继承自

mx.controls.Control.setLeft

setLink() 方法

设置 ToolStripItem.$link 字段值。

继承自

mx.controls.ToolStripItem.setLink

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

setText(p_text) 方法

设置 text 字段的值。

参数

p_text

继承自

mx.controls.ToolStripItem.setText

setToolTip(p_toolTip) 方法

设置 toolTip 字段的值。

参数

p_toolTip

继承自

mx.controls.ToolStripItem.setToolTip

setTop(p_top) 方法

设置 top 字段的值。

参数

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

继承自

mx.controls.Control.setTop

setVisible(p_visible) 方法

设置 visible 字段的值。

参数

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

继承自

mx.controls.ToolStripItem.setVisible

setWidth(p_width) 方法

设置 width 字段的值。

参数

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

继承自

mx.controls.Control.setWidth

show() 方法

将该 ToolStripItem 置为可见，即将 visible 字段置为 true。

继承自

mx.controls.ToolStripItem.show

toggleChecked() 方法

切换选中状态。

继承自

mx.controls.ToolStripItem.toggleChecked

$(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 对象。