Mozilla XUL Element and Script Reference

Contents  Quick Reference

Outliner

The outliner displays tabular text data. It is a simpler version of the tree but can handle larger numbers of rows more efficiently. The outliner should contain one or more outlinercol elements, and one outlinerbody elements. You can also place splitter elements between the columns to allow column resizing.

The outliner content is calculated via a script object which you supply and assign to the outliner. This object should contain functions which calculate cell data. The content may also be generated via an RDF datasource with a template, in which case one can also use the outlinerrow and outlinercell elements.

Attributes:

Attributes inherited from XUL Element

align

The align attribute specifies how child elements of the box are aligned, when the size of the box is larger than the total size of the children. For boxes that have horizontal orientation, it specifies how its children will be aligned vertically. For boxes that have vertical orientation, it is used to specify how its children are algined horizontally. The pack attribute is related to the alignment but is used to specify the position in the opposite direction. You can also specify the value of align using the style property '-moz-xul-box-align'.

autostretch

(Deprecated) For a outliner with horizontal orientation, autostretch determines whether its children stretch vertically to fit the given space. If the outliner has vertical orientation, it determines whether the children stretch horizontally to fit the given space. Stetching in the opoosite direction is controlled with the flex attribute on the child element. The attribute has been replaced with align='stretch'.

collapsed

If true, then the outliner is collapsed and does not appear. It is equivalent to setting the CSS visibility property to collapsed.

crop

If the label of the outliner 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 placed in place of the cropped text.

debug

If true, extra borders are drawn around the element and all its descendants. This can be used to determine orientation and where flexible elements are. If debug mode is enabled for a box, horizontal oriented boxes are displayed with a blue border and vertical boxes are displayed with a red border. The border above the element will be straight for non-flexible elements and wavy for flexible elements.

dir

The direction in which the child elements of the outliner are placed.

equalsize

This attribute can be used to make the children of the outliner equal in size.

flex

Indicates the flexibility of the outliner. Flexible elements grow and shrink to fit their given space. The actual value is not relevant unless there are other flexible elements within the same container. Elements with larger flex values will grow more than elements with lower flex values, at the ratio determined by the two elements.

height

The height of the outliner in pixels. It is recommended that the CSS height property be used instead.

left

For elements placed within a bulletinboard, specifies the position of the left edge of the outliner.

maxheight

The maximum height of the outliner. This corresponds to the max-height CSS property.

maxwidth

The maximum width of the outliner. This corresponds to the max-width CSS property.

minheight

The minimum height of the outliner. This corresponds to the min-height CSS property.

minwidth

The minimum width of the outliner. This corresponds to the min-width CSS property.

orient

Used to specify whether the children of the outliner element are oriented horizontally or vertically. You can also use the '-moz-xul-box-orient' style property.

pack

The pack attribute specifies where child elements of the box are placed when the box is larger that the size of the children. For boxes with horizontal orientation, it is used to indicate the position of children horizontally. For boxes with vertical orientation, it is used to indicate the position of children vertically. The align attribute is used to specify the position in the opposite direction. You can also specify the value of pack using the style property '-moz-xul-box-pack'.

top

For elements placed within a bulletinboard, specifies the position of the top edge of the outliner.

valign

(Deprecated) Determines the vertical alignment of the children of the outliner.

width

The width of the outliner in pixels. It is recommended that the CSS width property be used instead.

JavaScript Properties and Methods:

Properties and Methods inherited from XUL Element

currentIndex

Set to the index of the currently selected row in the outliner. If no row is selected, the value will be -1. You can assign a value to this property to change the selected row.