XUL:menuitem

From MDC

« XUL Reference home [ Examples | Attributes | Properties | Methods | Related ]

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

[edit] Example

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

[edit] Attributes

Inherited from XUL element
align, allowevents, allownegativeassertions, class, coalesceduplicatearcs, collapsed, container, containment, context, contextmenu, datasources, dir, empty, equalsize, flags, flex, height, hidden, id, insertafter, insertbefore, left, maxheight, maxwidth, menu, minheight, minwidth, mousethrough, observes, ordinal, orient, pack, persist, popup, position, preference-editable, querytype, ref, removeelement, sortDirection, sortResource, sortResource2, statustext, style, template, tooltip, tooltiptext, top, uri, wait-cursor, width

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.

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.

checked: Type: boolean; Indicates whether the element is checked or not.; Use hasAttribute() to determine whether this attribute is set instead of getAttribute().

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: Deprecated The text will be cropped on its left side.
right: Deprecated 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: 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.

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 "tab" 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.

[edit] 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 New in Firefox 3: Type: menu element; Read only property that returns the containing menu element, or null if there isn't a containing menu.

selected New in Firefox 3: 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 from XUL element
align, allowEvents, boxObject, builder, className, collapsed, contextMenu, controllers, currentItem, database, datasources, dir, flex, height, hidden, id, left, listBoxObject, maxHeight, maxWidth, menu, minHeight, minWidth, observes, ordinal, orient, pack, persist, ref, resource, statusText, style, tooltip, tooltipText, top, value, width

Inherited from DOM element
attributes, childNodes, cloneNode, firstChild, lastChild, localName, namespaceURI, nextSibling, nodeName, nodeType, nodeValue, ownerDocument, parentNode, prefix, previousSibling, tagName

[edit] 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

[edit] 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.