|
|
| (10 intermediate revisions by 3 users not shown) |
| Line 1: |
Line 1: |
| : '''''Work in progress''' See also [http://forums.mozillazine.org/viewtopic.php?t=263028 this forum thread] for the general description and list of available elements/attributes.''
| | Information from this page and [http://forums.mozillazine.org/viewtopic.php?t=263028 this thread] has been migrated to [http://developer-test.mozilla.org/en/docs/Preferences_System Devmo]. |
|
| |
|
| This document describes the new [[XBL]] bindings introduced in Toolkit 1.1, which allow you write preferences UI faster, using less [[JavaScript]] code.
| | [[Category:Redirects]] |
| | |
| == todo ==
| |
| | |
| Todo:
| |
| * list attributes too
| |
| * more detailed descriptions
| |
| * mark readonly properties as such
| |
| * sort alphabetically
| |
| * check correctness
| |
| | |
| * platform specific issues:
| |
| ** instant apply
| |
| ** animation
| |
| * examples
| |
| | |
| __TOC__
| |
| == <prefwindow> ==
| |
| <code><prefwindow></code> is a top-level element, like <code><window></code> or <code><dialog</code>. You should use it when creating Options dialog for Toolkit 1.1+ application.
| |
| | |
| The following attributes, properties and methods are available.
| |
| | |
| === Attributes ===
| |
| Please see [http://forums.mozillazine.org/viewtopic.php?t=263028]
| |
| | |
| === Properties ===
| |
| ; <code>preferencePanes</code> (readonly) : A <code>NodeList</code> of <code><prefpane></code> elements.
| |
| ; <code>type</code> (readonly) : Returns the value of the <code>type</code> attribute.
| |
| ; <code>lastSelected</code> (readonly) : Returns the value of the <code>lastSelected</code> attribute.
| |
| ; <code>instantApply</code> (readonly) : Indicates whether the window is in "instant apply" mode. The value is read from <code>browser.preferences.instantApply</code> boolean user preference. (?? It's declared as a <cope><field></code>, so you ''can'' set the value, however I don't believe it's valid to do that.)
| |
| ; <code>currentPane</code> (readonly) : Currently selected <code><prefpane></code> element. Use <code>showPane()</code> method to select another pane. (Same comment as for <code>instantApply</code>.)
| |
| | |
| === Methods ===
| |
| ; <code>showPane(aPaneElement)</code> : Selects given pane, loading it dynamically, if necessary. <code>aPaneElement</code> must be a <code><prefpane></code> element from the same window.
| |
| ; <code>animate(aOldPane, aNewPane)</code> : ?? is this a public method
| |
| ; <code>addPane(aPaneElement)</code> : Adds the specified <code><prefpane></code> element to the dialog. You can use this method to append dynamically created panes to the dialog.
| |
| ; <code>openSubDialog(aURL, aFeatures, aParams)</code> : Opens a modal sub-dialog. Similar to <code>window.openDialog</code>, except you don't have to specify <code>modal</code> and <code>centerscreen</code> features when using this method, they are added automatically. Use this method to open a modal subdialog, like Connection Settings in Firefox.
| |
| ; <code>openWindow(aWindowType, aURL, aFeatures, aParams)</code> : Opens the specified window or focuses an already open one with given window type. Use this method to open a non-modal window, like Exceptions window in Firefox Options.
| |
| | |
| Note that you can define an <code>initWithParams()</code> function in your window - to handle parameters passed using <code>openWindow()</code> in case the window was already open. For example the Permissions Manager UI in Firefox uses the same window for three dialogs: Images, Software installation and Popups. It uses <code>initWithParams()</code> to change the dialog type without closing and re-opening it.
| |
| | |
| The suggested pattern is as follows:
| |
| <pre>
| |
| function onLoad(ev) {
| |
| // do some initialization...
| |
| | |
| initWithParams(arguments[0]); // we expect a single parameter to be passed to the window
| |
| }
| |
| | |
| function initWithParams(aParams) {
| |
| // this will also get called when an already open window is activated using openWindow()
| |
| }
| |
| </pre>
| |
| | |
| == <prefpane> ==
| |
| <code><prefpane></code> is an element representing a ''pane'' (tab) in the Options window. It must be a child of the <code><prefwindow></code> element.
| |
| | |
| <code><prefpane></code> can have a <code>src</code> attribute specifying the overlay which provides the real content for it, or it can contain arbitrary XUL elements as its content. Using the first method can reduce time needed to load your Options window, if it's very large, as only a single pane needs to be loaded before the window can be shown to user.
| |
| | |
| === Attributes ===
| |
| ; <code>id</code> : The id of the pane. This may be used to match the element from a dynamic overlay, but you must provide an id for all your <code><prefpane></code> elements, even if you don't use dynamic pane loading.
| |
| ; <code>image</code> : Specifies the URL of an image to be used on the pane button. (does setting this at runtime have any effect??)
| |
| ; <code>label</code> : The label for the pane button.
| |
| ; <code>selected</code> : Indicates whether the pane is currently selected (active).
| |
| ; <code>src</code> : See above, the URL of the overlay which provides content for the pane.
| |
| | |
| === Properties ===
| |
| (todo: figure out what happens if you set these attributes/properties at runtime. I don't think all of them have effect at runtime.)
| |
| ; <code>src</code> : Gets and sets the value of the <code>src</code> attribute.
| |
| ; <code>selected</code> : Gets and sets the value of the <code>selected</code> attribute.
| |
| ; <code>image</code> : Gets and sets the value of the <code>image</code> attribute.
| |
| ; <code>label</code> : Gets and sets the value of the <code>label</code> attribute.
| |
| ; <code>preferenceElements</code> (readonly) : A <code>NodeList</code> of child elements with <code>preference</code> attribute.
| |
| ; <code>preferences</code> (readonly) : A <code>NodeList</code> of all child <code><preference></code> elements.
| |
| ; <code>loaded</code> (readonly) : Indicates whether the pane is fully loaded. (?? while it's possible to set the value of the property, it's not recommended to do so. The property really ought to be readonly)
| |
| ; <code>contentHeight</code> (readonly) : The height (in pixels) of current pane's content.
| |
| | |
| === Methods ===
| |
| ; <code>writePreferences(aFlushToDisk)</code> : Saves all <code><preference></code>s of the pane in user preferences, flushes to the disk (updating <tt>prefs.js</tt>) if <code>aFlushToDisk</code> is <code>true</code>.
| |
| ; <code>preferenceForElement(aElement)</code> : Returns the <code><preference></code> element, which is specified in <code>aElement</code>'s <code>preference</code> attribute.
| |
| ; <code>getPreferenceElement(aStartElement)</code> : ??
| |
| ; <code>userChangedValue(aElement)</code> : ??
| |
| | |
| == <preferences> ==
| |
| <code><preferences></code> is a container element for <code><preference></code> elements. It's supposed to be a child of <code><prefpane></code> element.
| |
| | |
| === Methods ===
| |
| ; <code>fireChangedEvent(aPreference)</code> : ??
| |
| | |
| === Fields ===
| |
| ; <code>service</code> : The preferences service (<code>nsIPrefService</code>).
| |
| ; <code>rootBranch</code> : The root prefs branch (<code>nsIPrefBranch</code>).
| |
| ; <code>defaultBranch</code> : The root branch with default values (<code>nsIPrefBranch</code>).
| |
| ; <code>rootBranchInternal</code> : The root prefs branch (<code>nsIPrefBranch2</code>).
| |
| | |
| == <preference> ==
| |
| <code><preference></code> is an element that is used as an intermediary between UI elements and items in user preferences. It must be a direct child of <code><preferences></code>.
| |
| | |
| === Attributes ===
| |
| ; id : The id of the element, it's used as a value of <code>preference</code> attribute on UI elements.
| |
| ; name : The preference it controls (e.g. <tt>browser.preferences.instantApply</tt>).
| |
| ; type : The type of the preference. Possible values are: <code>int</code>, <code>bool</code>, <code>string</code> (for non-unicode (ASCII) strings), <code>wstring</code> (like [[Dev_:_Using_preferences#nsIPrefLocalizedString|<code>nsIPrefLocalizedString</code>]]), <code>unichar</code> (unicode string), <code>file</code> (<code>nsIFile</code>).
| |
| ; inverted : (Applies only to prefs with <code>type="bool"</code>.) When this is set to <code>true</code>, the value on the associated UI element is a negation of the value stored in user preferences.
| |
| ; readonly : ??
| |
| | |
| === Properties ===
| |
| ; <code>instantApply</code> :
| |
| ; <code>preferences</code> :
| |
| ; <code>name</code> :
| |
| ; <code>type</code> :
| |
| ; <code>inverted</code> :
| |
| ; <code>readonly</code> :
| |
| ; <code>value</code> :
| |
| ; <code>locked</code> :
| |
| ; <code>disabled</code> :
| |
| ; <code>tabIndex</code> :
| |
| ; <code>hasUserValue</code> :
| |
| ; <code>defaultValue</code> :
| |
| ; <code>valueFromPreferences</code> :
| |
| | |
| === Methods ===
| |
| ; <code>reset()</code> :
| |
| ; <code>setElementValue(aElement)</code> :
| |
| ; <code>getElementValue(aElement)</code> :
| |
| ; <code>isElementEditable(aElement)</code> :
| |
| ; <code>updateElements()</code> :
| |
