XUL:prefpane

From MDC

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

A single preference panel in a prefwindow. A prefpane is made up of two parts, the preferences descriptions, which specify the set of preferences that will be modified, and the user interface for adjusting those preferences. The former is specified using a preferences element while the latter may be specified using other XUL elements.

Both may be specified directly as children of the prefpane element, or the src attribute may be used to put a pane in a separate file. In this latter case, the separate file should use an overlay tag as its root tag since it will be loaded as an overlay to the main preferences window.

More information is available in the Preferences System article.

Attributes: helpURI, image, label, onpaneload, selected, src

Properties: image, label, preferenceElements, preferences, selected, src

Methods: preferenceForElement

[edit] Examples

(example needed)

[edit] Attributes

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

helpURI: Type: uri; The URI of the help page associated with a preference panel. The URI will be opened using the help viewer when the help button is pressed.

image: Type: image URL; The URL 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.

onpaneload: Type: script code; Code defined here is called when the pane has been loaded, much like the load event for a window.

selected: Type: boolean; This attribute will be set to true for the currently selected prefpane. To change the selected pane, use the prefwindow's showPane method.

src: Type: overlay URL; The URL of the contents of preference pane. If this is not specified, the contents of the prefpane element is used.

[edit] Properties

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

Inherited from DOM element
attributes, childNodes, cloneNode, firstChild, lastChild, localName, namespaceURI, nextSibling, nodeName, nodeType, nodeValue, ownerDocument, parentNode, prefix, previousSibling, tagName

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.

preferenceElements: Type: DOM Nodelist; Holds a list of the UI elements in the pane that are attached to preferences.

preferences: Type: DOM Nodelist; Holds a list of the preference elements in the pane.

selected: Type: boolean; This property's value is true if this element is selected, or false if it is not. This property is read only.

src: Type: URL; Gets and sets the value of the src attribute.

[edit] Methods

preferenceForElement( uielement ): Return type: preference element; Returns the preference element to which a user interface element is attached.

Inherited from XUL element
blur, click, doCommand, focus, getElementsByAttribute

Inherited from DOM element
addEventListener, appendChild, dispatchEvent, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, hasAttribute, hasAttributeNS, hasAttributes, hasChildNodes, insertBefore, isSupported, normalize, removeAttribute, removeAttributeNode, removeAttributeNS, removeChild, removeEventListener, replaceChild, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS