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
-
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
text for the element.label
Example
<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
-
allowevents
- Type: boolean
- If true, events are passed to children of the element. Otherwise, events are passed to the element only.
- {{ XULAttr("checked") }}
- Type: boolean
- Indicates whether the element is checked or not.
- Use
hasAttribute()
to determine whether this attribute is set instead ofgetAttribute()
.
{{ 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>
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.-
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 thecommand
event will not fire.
<!-- Checkbox enables/disables the button --> <checkbox label="Enable button" onclick="document.getElementById('buttRemove').disabled = this.checked"/> <button id="buttRemove" label="Remove All" disabled="true"/>
label
- Type: string
- The label that will appear on the element. If this is left out, no text appears.
label 在元素上显示。如果左侧出界,则不显示任何文字。
-
selected
- Type: boolean
- Indicates whether the element is selected or not. This value is read-only. To change the selection, set either the
selectedIndex
orselectedItem
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.
-
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.
-
labelElement
- Type:
label
element - The
label
element associated with the control. This is set when a label has acontrol
attribute pointing to this element. This property will benull
when no label is associated with the control.
-
parentContainer
- Type:
menu
element - Read only property that returns the containing
menu
element, ornull
if there isn't a containing menu.
- {{ 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, orfalse
if it is not. This property is read only.
Inherited Properties |
Methods
Style classes
-
menuitem-iconic
- Use this class to have an image appear on the
menuitem
. Specify the image using theimage
attribute.
-
menuitem-non-iconic
- Normally,
menuitem
s 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.
Related
- Elements
-
menu
,menubar
,menulist
,menupopup
,menuseparator