Mozilla XUL Element and Script Reference

Contents  Quick Reference

Popup

A container that appears in a child window. The popup window does not have any special frame. Popups can be displayed when an element is clicked by assigning the id of the popup to either the popup, context or tooltip attribute of the element. A popup is a type of box that defaults to vertical orientation.

Attributes:

Attributes inherited from XUL Element


align

Determines the horizontal alignment of the children of the popup.

autostretch

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

crop

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

flex

Indicates the flexibility of the popup. 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 popup in pixels. It is recommended to use the CSS height property instead.

left

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

orient

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

top

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

valign

Determines the vertical alignment of the children of the popup.

width

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

JavaScript Properties and Methods:

Properties and Methods inherited from XUL Element

closePopup ( )

Closes the popup window immediately.

openPopup ( element, x , y , popupType, anchor, align )

Opens a popup window at the position (x,y) relative to the element. Type should be either the string "popup", "context" or "tooltip". The parameter anchor corresponds to the popupanchor attribute on the element. The parameter align corresponds to the popupalign attribute on the element.

popup.openPopup (someButton,0,0,"popup","bottomleft","topleft");

This example will open the popup anchored on the bottom-left corner of the button someButton.