progressmeter

« XUL Reference home [ Examples | Attributes | Properties | Methods | Related ]

A meter which can be used to display the progress of a lengthy operation. It is drawn as a bar that is filled as the operation completes. In addition, an indeterminate progressmeter may be created by setting the mode attribute to undetermined. This is used when the length of time to complete an operation is not known beforehand.

More information is available in the XUL tutorial.

Attributes
max, mode, value
Properties
accessibleType, max, mode, value

Examples

Image:XUL_ref_progress.png
<progressmeter mode="determined" value="82"/>
<progressmeter mode="undetermined"/>

<!-- switching modes while the mouse is over a button -->
<progressmeter mode="determined" id="myProgress"/>
<button label="Example" onmouseover="setLoading(true)"
                        onmouseout="setLoading(false)"/>
function setLoading(state){
  document.getElementById('myProgress').mode =
           (state) ? 'undetermined' : 'determined';
}

Attributes

max
Type: integer
The maximum value that progressmeter may have. The default value if not specified is 100 such that the value may be used as a percentage.
mode
Type: one of the values below
A determinedprogressmeter is used in cases where you know how long an operation will take. An undeterminedprogressmeter can be used when you don't and will typically be drawn as a spinning barber pole.
determined
The progress meter uses its value attribute to determine the amount of the bar that is filled in.
undetermined
The progressmeter is indeterminate.
value
Type: integer
An integer ranging from 0 to the maximum value that indicates the progress. For instance, if no maximum value has been set, setting the value to "0" shows an empty bar, "100" shows a bar at full length and "25" shows the first quarter of the bar.

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, querytype, ref, removeelement, sortDirection, sortResource, sortResource2, statustext, style, template, tooltip, tooltiptext, top, uri, wait-cursor, width

Properties

accessibleType
Type: integer
A value indicating the type of accessibility object for the element.
max
Type: integer
Gets and sets the value of the max attribute.
mode
Type: string
Gets and sets the value of the mode attribute.
value
Type: string
Gets and sets the value of the value attribute. For textbox and user editable menulist elements, the contents, as visible to the user, are read and set using the Textbox.value and Menulist.value syntax.

 

Inherited Properties
align, , allowEvents, , boxObject, builder, , , , className, , , , , collapsed, contextMenu, controllers, database, datasources, dir, , , flex, height, hidden, id, , , left, , maxHeight, maxWidth, menu, minHeight, minWidth, , , , , , , observes, ordinal, orient, , pack, , persist, , , , ref, resource, , , , , statusText, style, ,, tooltip, tooltipText, top, width

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
Interfaces
nsIAccessibleProvider