Please note, this is a STATIC archive of website developer.mozilla.org from November 2016, cach3.com does not collect or store any user information, there is no "phishing" involved.

menuitem

A single choice in a menupopup element. It acts much like a button but it is rendered on a menu.

More information is available in the XUL tutorial.

Attributes
acceltext, accesskey, allowevents, autocheck, checked, command, crop, description, disabled, image, key, label, name, selected, tabindex, type, validate, value
Properties
accessibleType, accessKey, command, control, crop, disabled, image, label, labelElement, parentContainer, selected, tabIndex, value
Style classes
menuitem-iconic, menuitem-non-iconic

Example

<menu id="edit-menu" label="Edit">
  <menupopup id="edit-popup">
     <menuitem label="Undo"/>
     <menuitem label="Redo"/>
  </menupopup>
</menu>

Attributes

acceltext
Type: string
Text that appears beside beside the menu label to indicate the shortcut key (accelerator key) to use to invoke the command. If this value is set, it overrides an assigned key set in the key attribute. This attribute does not apply to menus directly on the menubar.
accesskey
Type: character
This should be set to a letter that is used as a shortcut key. This letter should be one of the characters that appears in the label text for the element.

Example

Image:XUL_ref_accesskey_attr.png
<vbox>	
  <label value="Enter Name" accesskey="e" control="myName"/>
  <textbox id="myName"/>
  <button label="Cancel" accesskey="n"/>
  <button label="Ok" accesskey="O"/>
</vbox>

See also

label attribute, acceltext attribute

allowevents
Type: boolean
If true, events are passed to children of the element. Otherwise, events are passed to the element only.
autocheck
Type: boolean
If this attribute is true, or left out, the menuitem check mark will update each time the menu item is selected. If this attribute is false, the check mark must be adjusted manually.
{{ languages( { "fr": "fr/XUL/Attributs/checked", "ja": "ja/XUL/Attribute/checked", "pl": "pl/XUL/Atrybut/checked" } ) }}
{{ XULAttr("checked") }}
Type: boolean
Indicates whether the element is checked or not.
Use hasAttribute() to determine whether this attribute is set instead of getAttribute().

{{ mediawiki['#switch']('<magic name="\"PAGENAME\"/">', XUL:button = The .. '<template><name>' .. XULAttr .. '</name><arg>' .. type .. '</arg></template>' .. attribute must be set to checkbox or radio for this attribute to have any effect.) }}</magic>

Note: if the checked attribute is set to true, and you persist its value via the persist attribute, Mozilla will fail to persist its value when the menuitem is unchecked because of bug 15232. A workaround is to set the autocheck attribute to false, then programmatically set the checked attribute when the user selects the item, and set it to false instead of removing the attribute (i.e. do menuitem.setAttribute("checked", "false") instead of menuitem.removeAttribute("checked")) when the user unchecks the menuitem, as a value of false will both correctly hide the checkmark and persist its hidden state.

command
Type: element id
Set to the id of a command element that is being observed by the element.
crop
Type: one of the values below
If the label of the element is too big to fit in its given space, the text will be cropped on the side specified by the crop attribute. An ellipsis will be used in place of the cropped text. If the box direction is reversed, the cropping is reversed.
  • start: The text will be cropped on its left side.
  • end: The text will be cropped on its right side.
  • left: The text will be cropped on its left side.
  • right: The text will be cropped on its right side.
  • center: The text will be cropped in the middle, showing both the start and end of the text normally.
  • none: The text will be not be cropped using an ellipsis. However, the text will simply be cut off if it is too large. The side depends on the CSS text alignment.
description
Type: string
Descriptive text to appear in addition to the dialog title.
disabled
Type: boolean
Indicates whether the element is disabled or not. If this element is set to true the element is disabled. Disabled elements are usually drawn with grayed-out text. If the element is disabled, it does not respond to user actions, it cannot be focused, and the command event will not fire.


Image:XUL_ref_attr_disabled.png
<!-- Checkbox enables/disables the button -->
<checkbox label="Enable button" 
    onclick="document.getElementById('buttRemove').disabled = this.checked"/>
<button id="buttRemove" label="Remove All" disabled="true"/>
image
Type: image URL
The URL of the image to appear on the element. If this attribute is empty or left out, no image appears. The position of the image is determined by the dir and orient attributes.
key
Type: element id
Set to the id of a key element whose key shortcut is displayed in the menuitem.
label
Type: string
The label that will appear on the element. If this is left out, no text appears.
label 在元素上显示。如果左侧出界,则不显示任何文字。

name
Type: string name
Radio menuitems with the same name as put into a group. Only one menuitem in each radio group can be checked at a time.
selected
Type: boolean
Indicates whether the element is selected or not. This value is read-only. To change the selection, set either the selectedIndex or selectedItem property of the containing element.
tabindex
Type: integer
The tab order of the element. The tab order is the order in which the focus is moved when the user presses the "<kbd>tab</kbd>" key. Elements with a higher tabindex are later in the tab sequence.
type
Type: one of the values below
Can be used to create checkable menuitems or for radio button menuitems.
  • checkbox: The menuitem is checked. The checked attribute determines whether the menuitem is checked or not.
  • radio: The menuitem becomes part of a radio group. Other menuitems that have the same value for their name attributes are part of the same radio group. Only one menuitem in the same radio group can be checked at once.

More information on adding checkmarks to menus in the XUL tutorial

validate
Type: one of the values below
This attribute indicates whether to load the image from the cache or not. This would be useful if the images are stored remotely or you plan on swapping the image frequently. The following values are accepted, or leave out the attribute entirely for default handling:
  • always: The image is always checked to see whether it should be reloaded.
  • never: The image will be loaded from the cache if possible.
value
Type: string
The string attribute allows you to associate a data value with an element. It is not used for any specific purpose, but you can access it with a script for your own use.

Properties

accessibleType
Type: integer
A value indicating the type of accessibility object for the element.
accessKey
Type: character
Gets and sets the value of the accesskey attribute.
command
Type: element id
Gets and sets the value of the command attribute.
control
Type: menu element
Returns the enclosing menu that the item is inside, if any, or null if there is no enclosing menu.
crop
Type: string
Gets and sets the value of the crop attribute.
disabled
Type: boolean
Gets and sets the value of the disabled attribute.
image
Type: image URL
Gets and sets the value of the image attribute.
label
Type: string
Gets and sets the value of the label attribute.
labelElement
Type: label element
The label element associated with the control. This is set when a label has a control attribute pointing to this element. This property will be null when no label is associated with the control.
parentContainer
Type: menu element
Read only property that returns the containing menu element, or null if there isn't a containing menu.
{{ languages( { "fr": "fr/XUL/Propri\u00e9t\u00e9s/selected", "ja": "ja/XUL/Property/selected" } ) }}
{{ XULProp("selected") }} {{ mediawiki['#switch']('<magic name="\"PAGENAME\"/">', XUL:menuitem, XUL:menuseparator = .. '<template><name>' .. Fx_minversion_inline .. '</name><arg>' .. 3 .. '</arg></template>') }}</magic>
Type: boolean
This property's value is true if this element is selected, or false if it is not. This property is read only.
tabIndex
Type: integer
Gets and sets the value of the tabindex attribute.
value
Type: string
Gets and sets the value of the value attribute.

Inherited Properties
align, attributes, allowEvents, baseURI, boxObject, builder, childElementCount, childNodes, children, className, clientHeight, clientLeft, clientTop, clientWidth, collapsed, contextMenu, controllers, database, datasources, dir, firstChild, firstElementChild, flex, height, hidden, id, lastChild, lastElementChild, left, localName, maxHeight, maxWidth, menu, minHeight, minWidth, namespaceURI, nextElementSibling, nextSibling, nodeName, nodeType, nodeValue, observes, ordinal, orient, ownerDocument, pack, parentNode, persist, prefix, previousElementSibling, previousSibling, ref, resource, scrollHeight, scrollLeft, scrollTop, scrollWidth, statusText, style, tagName,textContent, tooltip, tooltipText, top, width

Methods

Inherited from XUL element
blur, click, doCommand, focus, getElementsByAttribute

Inherited from DOM element
addEventListener(), appendChild(), dispatchEvent(), getAttribute(), getAttributeNode(), getAttributeNodeNS(), getAttributeNS(), getElementsByTagName(), getElementsByTagNameNS(), hasAttribute(), hasAttributeNS(), hasAttributes(), hasChildNodes(), insertBefore(), isSupported(), normalize(), removeAttribute(), removeAttributeNode(), removeAttributeNS(), removeChild(), removeEventListener(), replaceChild(), setAttribute(), setAttributeNode(), setAttributeNodeNS(), setAttributeNS()

Style classes

menuitem-iconic
Use this class to have an image appear on the menuitem. Specify the image using the image attribute.
menuitem-non-iconic
Normally, menuitems have a margin to the left for an image or checkmark. This class may be used to remove this margin so that the menuitem appears on the left edge of the menupopup.

Elements
menu, menubar, menulist, menupopup, menuseparator
Interfaces
nsIAccessibleProvider, nsIDOMXULContainerItemElement, nsIDOMXULSelectControlItemElement

 

 

文档标签和贡献者

 此页面的贡献者: ziyunfei, Cuimingda
 最后编辑者: ziyunfei,