XUL:label

From MDC

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

This element is used to provide a label for a control element. If the user clicks the label, it will move the focus to the associated control, specified with the control attribute.

More information is available in the XUL tutorial.

Attributes

accesskey, control, crop, disabled, href, value

Properties

accessKey, accessibleType, control, crop, disabled, value

Style classes

header, indent, monospace, plain, small-margin, text-link

[edit] Examples

<label value="Email address" control="email"/>
<textbox id="email"/>

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

control

Type: element id

This attribute specifies the id of the element with which the label is associated. When the user clicks on the label, the associated element is given focus.

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.

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.

href

Type: string

Defines a URL to open when this element is clicked. Requires the class attribute to include text-link.

value

Type: string

The text to be used for the label.

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

accessibleType

Type: integer

A value indicating the type of accessibility object for the element.

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.

disabled

Type: boolean

Gets and sets the value of the disabled 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.

header

A class used for headings. Typically, this will cause the text to appear bold.

indent

This class causes the text to be indented on its left side.

monospace

This class causes the text to be displayed in a monospace font.

plain

This class causes the element to be displayed with no border or margin.

small-margin

This class causes the text to be displayed with a smaller margin.

text-link

Labels with this class may be focused and the click handler run or the address in the href attribute opened on a mouse click or Enter key press. Labels will appear like a link (blue and underlined).

[edit] Related

Elements

description

Attributes

label

Interfaces

nsIAccessibleProvider, nsIDOMXULLabelElement

[edit] User notes

Remember that the label element has a "value" attribute, unlike value in HTML whereas buttons, checkboxes use label="foo" as the attribute

<label label="A Caption"/> <-- wrong -->
<label value="A Caption"/>

<label value="Click the button"/>
<button label="A Button"/>
<checkbox label="A Decision" value="1"/>