Home > Element Reference : Prefpane

Contents

### Prefpane

Mozilla 1.8

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.

Attributes:

helpURI | image | label | onpaneload | selected
src

Properties and Methods:

image | label | preferenceElements | preferenceForElement | preferences
selected | src

#### 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
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 this preference panel. The URI will be opened using the help viewer when the help button is pressed.

##### image

Type: image URL

The image to appear on the navigation area for this pane.

##### label

Type: string

The label to appear on the navigation area for this pane.

##### 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 pane. 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.

#### Properties and Methods:

Inherited from XUL Element:

align
allowEvents
blur
boxObject
boxObject.element
boxObject.getLookAndFeelMetric
boxObject.height
boxObject.screenX
boxObject.screenY
boxObject.width
boxObject.x
boxObject.y
builder
className
click
collapsed
contextMenu
controllers
database
datasources
dir
doCommand
flex
focus
getElementsByAttribute
height
hidden
id
left
maxHeight
maxWidth
menu
minHeight
minWidth
observes
ordinal
orient
pack
persist
ref
resource
statusText
style
tooltip
tooltipText
top
width

Inherited from Element:

addEventListener
appendChild
attributes
childNodes
cloneNode
dispatchEvent
firstChild
getAttribute
getAttributeNS
getAttributeNode
getAttributeNodeNS
getElementsByTagName
getElementsByTagNameNS
hasAttribute
hasAttributeNS
hasAttributes
hasChildNodes
insertBefore
isSupported
lastChild
localName
namespaceURI
nextSibling
nodeName
nodeType
nodeValue
normalize
ownerDocument
parentNode
prefix
previousSibling
removeAttribute
removeAttributeNS
removeAttributeNode
removeChild
removeEventListener
replaceChild
setAttribute
setAttributeNS
setAttributeNode
setAttributeNodeNS
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.

##### preferenceForElement ( uielement )

Return Type: preference element

Returns the preference element that a user interface element is attached to.

##### preferences

Type: DOM NodeList

Holds a list of the preference elements in the pane.

##### selected

Type: boolean

Gets and sets the value of the selected attribute.

##### src

Type: image URL

Gets and sets the value of the src attribute.

Copyright (C) 1999 - 2004 XulPlanet.com