caption

A header for a groupbox. It may contain either a text label, using the label attribute, or child elements for a more complex caption.

More information is available in the XUL tutorial.

Attributes
accesskey, crop, image, label, tabindex
Properties
accessKey, crop, image, label, tabIndex

Examples

Image:XUL_ref_caption.png
<groupbox>
  <caption label="My groupbox"/>
</groupbox>
<groupbox flex="1">
  <caption>
    <checkbox label="A checked groupbox"/>
  </caption>
</groupbox>

Attributes

accesskey
Type: character
This should be set to a character that is used as a shortcut key. This should be one of the characters that appears in the label label for 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 in left-to-right text locales, and the right side in right-to-left locales.
end
The text will be cropped on its right side in left-to-right text locales, and the right side in right-to-left locales.
left
The text will be cropped on its left side.
right
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.
Depending on the platform and theme being used, some elements will have set a maximum width so they will always appear cropped. If you wish to use the value none and the displayed text is larger than this maximum width, you may be able to use the max-width CSS property (or the maxwidth attribute) to override this size. For example, for a menuitem in a menu you can add the following CSS rule when you want to use the value none:
menupopup > menuitem, menupopup > menu { max-width: none; }
image
Type: URI
The URI 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. For an editable menuitem element the value of this attribute is copied to the menulist.value property upon user selection of the menuitem.

 

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.

Properties

accessKey
Type: character
Gets and sets the value of the accesskey attribute.
crop
Type: string
Gets and sets the value of the crop 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.
tabIndex
Type: integer
Gets and sets the value of the tabindex attribute.

Methods

Inherited Methods
addEventListener(), appendChild(), blur, click, cloneNode(), compareDocumentPosition, dispatchEvent(), doCommand, focus, getAttribute(), getAttributeNode(), getAttributeNodeNS(), getAttributeNS(), getBoundingClientRect(), getClientRects(), getElementsByAttribute, getElementsByAttributeNS, getElementsByClassName(), getElementsByTagName(), getElementsByTagNameNS(), getFeature, getUserData, hasAttribute(), hasAttributeNS(), hasAttributes(), hasChildNodes(), insertBefore(), isDefaultNamespace(), isEqualNode, isSameNode, isSupported(), lookupNamespaceURI, lookupPrefix, normalize(), querySelector(), querySelectorAll(), removeAttribute(), removeAttributeNode(), removeAttributeNS(), removeChild(), removeEventListener(), replaceChild(), setAttribute(), setAttributeNode(), setAttributeNodeNS(), setAttributeNS(), setUserData

Elements
groupbox, checkbox

Document Tags and Contributors

Contributors to this page: Sheppy, lmorchard, Taken, Ptak82, Mgjbot, Pmash, Dria
Last updated by: Sheppy,