XUL:tab

From MDC

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

A single tab which should be placed inside a tabs element. The user may click a tab to bring the associated page of the tabbox to the front.

More information is available in the XUL tutorial.

Attributes

accesskey, afterselected, beforeselected, command, crop, disabled, image, label, linkedpanel, oncommand, selected, tabindex, validate, value

Properties

accessKey, accessibleType, command, control, crop, disabled, image, label, linkedPanel, selected, tabIndex, value

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

afterselected

Type: boolean

This is set to true if the tab is immediately after the currently selected tab. This is set automatically set when needed and you shouldn't adjust it manually. This is primarily useful for themes so that they can adjust the appearance of the area around the selected tab.

beforeselected

Type: boolean

This is set to true if the tab is immediately before the currently selected tab. This is set automatically set when needed and you shouldn't adjust it manually. This is primarily useful for themes so that they can adjust the appearance of the area around the selected tab.

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.

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.

linkedpanel

Type: id of a tabpanel element

The id of the linked tabpanel element that will be displayed when the tab is selected. If this attribute is not used, the tab will be connected to the panel at the corresponding index in the tabpanels element that the tab is in its tabs container. However, if this attribute is used, this behavior is overridden, and the tab will always be linked to a specific panel. This might be used to avoid duplication by linking several tabs to one panel with slight differences to the content adjusted in the select event.

oncommand

Type: script code

This event handler is called when the command is activated. This occurs when a user selects a menu item or presses a keyboard shortcut attached to the command.

selected

Type: boolean

This attribute is set to true if the tab is selected by default.

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.

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.

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

command

Type: element id

Gets and sets the value of the command attribute.

control

Type: tabs element

Returns the enclosing tabs element.

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.

linkedPanel

Type: id of a tabpanel element

Gets and sets the value of the linkedpanel 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] Issues

Currently disabling of the tab fails. Whilst the tab is "greyed" out it does accept events - bug 106387 (fixed in Firefox 3 by bug 370742).

Also "unhiding" a tab leads to unpredictable ordering of the tabs. See bug 307088 and bug 261826. (Use collapsed instead of hidden)

[edit] Related

Elements

tabbox, tabs, tabpanels, tabpanel.

Interfaces

nsIAccessibleProvider, nsIDOMXULSelectControlItemElement