extIPreferenceBranch

Interface for simplified access to preferences. The interface has a
predefined root preference branch. The root branch is set based on the
context of the owner. For example, an extension’s preferences have a root
of “extensions..", while the application level preferences have an empty root. All preference "aName" parameters used in this interface are relative to the root branch.

Methods

has(aName)

Check to see if a preference exists.

Parameters

aName

The name of preference

Returns

true if the preference exists, false if not

get(aName)

Gets an object representing a preference

Parameters

aName

The name of preference

Returns

a preference object, or null if the preference does not exist

getValue(aName, aDefaultValue)

Gets the value of a preference. Returns a default value if
the preference does not exist.

Parameters

aName	The name of preference
aDefaultValue	The value to return if preference does not exist

Returns

value of the preference or the given default value if preference does not exists.

setValue(aName, aValue)

Sets the value of a storage item with the given name.

Parameters

aName	The name of an item
aValue	The value to assign to the item

reset()

Resets all preferences in a branch back to their default values.

Attributes

root

The name of the branch root.

all

Array of extIPreference listing all preferences in this branch.

events

The events object for the preferences
supports: “change”