Home > Element Reference : Tab

Contents

### Tab

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 about tab

The tab element implements the following interfaces:

nsIAccessibleProvider nsIDOMXULSelectControlItemElement

Attributes:

accesskey | afterselected | beforeselected | crop | disabled
image | label | linkedpanel | selected | validate

Properties and Methods:

accessible | label | linkedPanel | selected | tabs

#### 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
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 tab. This letter will typically be drawn underlined, although this behavior will be platform and theme specific. When the user presses ALT (or a similar key that varies on each platform) and the access key, the tab will be activated from anywhere in the window. Although the value is case insensitive, a letter with the case matching the accesskey attribute will used if both cases exist in the label.

##### 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 tab is too small 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 on both sides.
- 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 tab is disabled or not. If this attribute is set to true, the tab is disabled. This is usually drawn with the text in grey. If the tab is disabled, it does not respond to user actions. The element cannot be focused and the command event will not fire. The element will still respond to mouse events. To enable the tab, leave the attribute out entirely as opposed to setting the value to false.

##### image

Type: image URL

The URL of the image to appear on the tab. If this is attribute is 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 tab. 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.

##### selected

Type: boolean

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

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

#### Properties and Methods:

Inherited from XUL Element:

align
allowEvents
blur
boxObject
boxObject.element
boxObject.getLookAndFeelMetric
boxObject.height
boxObject.screenX
boxObject.screenY
boxObject.width
boxObject.x
boxObject.y
builder
className
click
collapsed
contextMenu
controllers
database
datasources
dir
doCommand
flex
focus
getElementsByAttribute
height
hidden
id
left
maxHeight
maxWidth
menu
minHeight
minWidth
observes
ordinal
orient
pack
persist
ref
resource
statusText
style
tooltip
tooltipText
top
width

Inherited from Element:

addEventListener
appendChild
attributes
childNodes
cloneNode
dispatchEvent
firstChild
getAttribute
getAttributeNS
getAttributeNode
getAttributeNodeNS
getElementsByTagName
getElementsByTagNameNS
hasAttribute
hasAttributeNS
hasAttributes
hasChildNodes
insertBefore
isSupported
lastChild
localName
namespaceURI
nextSibling
nodeName
nodeType
nodeValue
normalize
ownerDocument
parentNode
prefix
previousSibling
removeAttribute
removeAttributeNS
removeAttributeNode
removeChild
removeEventListener
replaceChild
setAttribute
setAttributeNS
setAttributeNode
setAttributeNodeNS
tagName

##### accessible

Type: nsIAccessible

Returns the accessibility object for the tab.

##### label

Type: string

The label that will appear on the tab. If this is left out, no text appears.

##### linkedPanel

Type: id of a tabpanel element

Gets and sets the value of the linkedpanel attribute.

##### selected

Type: boolean

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

##### tabs

Type: tabs element

The tabs element that the tab is contained in.

Copyright (C) 1999 - 2004 XulPlanet.com