An element, much like a button
, that is placed on a menubar
. When the user clicks the menu
element, the child menupopup
of the menu will be displayed. This element is also used to create submenus.
More information is available in the XUL tutorial.
- Attributes
- acceltext, accesskey, allowevents, command, crop, disabled, image, label, menuactive, open, sizetopopup, tabindex, value
- Properties
- accessibleType, accessKey, command, control, crop, disabled, image, itemCount, label, labelElement, menupopup, open, parentContainer, selected, tabIndex, value
- Methods
- appendItem, getIndexOfItem, getItemAtIndex, insertItemAt, removeItemAt
Example
<menubar id="sample-menubar"> <menu id="file-menu" label="File"> <menupopup id="file-popup"> <menuitem label="New"/> <menuitem label="Open"/> <menuitem label="Save"/> <menuseparator/> <menuitem label="Exit"/> </menupopup> </menu> <menu id="edit-menu" label="Edit"> <menupopup id="edit-popup"> <menuitem label="Undo"/> <menuitem label="Redo"/> </menupopup> </menu> </menubar>
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.
-
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.
-
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 在元素上显示。如果左侧出界,则不显示任何文字。
-
open
- Type: boolean
-
For the
menu
type
buttons, theopen
attribute is set totrue
when the menu is open. Theopen
attribute is not present if the menu is closed.
sizetopopup
- Type: one of the values below
- Indicates how the menu width and the
menupopup
width are determined. If thesizetopopup
attribute is left out or set tonone
, the menu will be its preferred width and the popup may extend outside of this width, unaffected by the maximum width of the menu itself. Otherwise, the menu will size itself to at least the size of the popup. If the menu has a maximum width, the popup will also be this width. -
none
- The width of the popup will not be constrained to the size of the menu.
pref
- The preferred width of the menu label or button will be the size needed for the popup contents. This is the default value for menulists.
always
- Both the preferred and minimum width of the menu label or button will be the same as that necessary for the
menupopup
.
-
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.
itemCount
- Type: integer
- Read only property holding the number of child items.
-
parentContainer
-
Type:
menu
element -
Read only property that returns the containing
menu
element, ornull
if there isn't a containing menu.
Methods
-
appendItem( label, value )
- Return type: element
- Creates a new item and adds it to the end of the existing list of items. You may optionally set a value. The function returns the newly created element.
-
getIndexOfItem( item )
- Return type: integer
- Returns the zero-based position of the specified item. Items are numbered starting at the first item displayed in the list.
-
getItemAtIndex( index )
- Return type: element
- Returns the element that is at the specified index.
-
insertItemAt( index, label, value )
- Return type: element
- This method creates a new item and inserts it at the specified position. You may optionally set a value. The new item element is returned.
-
removeItemAt( index )
- Return type: element
- Removes the child item in the element at the specified index. The method returns the removed item.
Related
- Elements
-
menubar
,menuitem
,menulist
,menupopup
,menuseparator
- Interfaces
- nsIAccessibleProvider, nsIDOMXULContainerElement, nsIDOMXULContainerItemElement, nsIDOMXULSelectControlItemElement