Mozilla XUL Element and Script Reference

Contents  Quick Reference

Scrollbar

When a container contains contents which are larger that the size of the content, scroll bars may be placed at the side of the container to allow the user to scroll around in the container. The scroll bar may also be used independently when a numeric value or percentage needs to be selected by the user. The user can adjust the position of the scroll bar by clicking arrows on either end of the scroll bar or by dragging the scroll bar thumb around.

Example:

    <scrollbar curpos="5" maxpos="50"/>

Attributes:

Attributes inherited from XUL Element


align

Determines the horizontal alignment of the children of the scrollbar.

autostretch

In the scrollbar is placed inside a horizontally oriented box, autostretch determines whether the scrollbar stretches vertically to fit the given space. For vertically oriented boxes, determines whether the scrollbar stretches horizontally to fit the given space. Stetching in the opoosite direction is controlled with the flex attribute.

collapsed

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

crop

If the label of the scrollbar 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.

curpos

The current position of the scrollbar, which ranges from 0 to the value of the maxpos attribute. The default value is 0.

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.

flex

Indicates the flexibility of the scrollbar. Flexible elements grow and shrink to fit their given space. The actual value is not relevant unless there are other flexible elements with-in 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 scrollbar in pixels. It is recommended to use the CSS height property instead.

increment

The amount that the value of the curpos attribute changes by when the scroll bar arrows are clicked. The default value is 1.

left

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

maxpos

The maximum position of the scrollbar. The default value is 100.

orient

Used to specify whether the children of the scrollbar element are oriented horizontally or vertically.

pageincrement

The amount that the value of the curpos attribute changes by when the tray of the scroll bar is clicked. The tray is the area in which the scroll bar thumb moves along. The default value is 10.

top

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

valign

Determines the vertical alignment of the children of the scrollbar.

width

The width of the scrollbar in pixels. It is recommended to use the CSS width property instead.