XUL:listitem

From MDC

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

A single row in a listbox. The text of the listitem is specified either using listcell elements, or by placing a label attribute directly on the listitem element. By default it contains a single listcell element of type and class approprate to that of the listitem.

More information is available in the XUL tutorial.

Attributes: accesskey, checked, command, crop, current, disabled, image, label, preference, selected, tabindex, type, value

Properties: accessKey, accessible, checked, control, crop, current, disabled, image, label, selected, tabIndex, value

Style classes: listitem-iconic

[edit] Examples

(example needed)

[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

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.

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.

current: Type: boolean; This attribute will be set to true if the listitem is the current item. This is typically used by a theme to customize the focus ring. To change the currently selected item in a listbox, use the listbox property selectedItem.

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.

label: Type: string; The label that will appear on the element. If this is left out, no text appears.

preference: Type: element id; Connects the element to a corresponding preference. This attribute only has any effect when used inside a prefwindow. The value of the preference will be updated to match the value property of the element.

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: string; You can make an item in a listbox a checkbox by setting this attribute to the value checkbox.

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

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

accessKey: Type: character; Gets and sets the value of the accesskey attribute.

accessible: Type: nsIAccessible; Returns the accessibility object for the element.

checked: Type: boolean; Gets and sets the value of the checked attribute.

control: Type: element id; Gets and sets the value of the control attribute.

crop: Type: string; Gets and sets the value of the crop attribute.

current: Type: boolean; Gets and sets the value of the current 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.

selected: 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.

[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

The following classes may be used to style the element. These classes should be used instead of changing the style of the element directly since they will fit more naturally with the user's selected theme.