prefpane

prefwindow 内の一つの設定パネル。prefpane は、変更される設定一式を明記する設定の説明と、それらの設定を調節するユーザインタフェースの二つの部分から成っています。前者は preferences 要素で指定し、後者は他の XUL 要素で指定されます。

これら二つの部分は prefpane 要素の子として直接指定するか、src 属性を使用して別のファイル内のペインに置きます。後者の場合、メインの設定ウィンドウのオーバーレイとして読み込まれるため、別のファイルでは、そのルートタグとして overlay タグを使用しなければなりません。

詳しい情報が設定システムの記事にあります。

属性

helpURI, image, label, onpaneload, selected, src

プロパティ

image, label, preferenceElements, preferences, selected, src

メソッド

preferenceForElement

例

<prefpane id="paneGeneral" label="General" src="chrome://path/to/paneOverlay.xul"/>

または…

<prefpane id="paneGeneral" label="General" onpaneload="onGeneralPaneLoad(event);">
  <preferences>
    <preference id="pref_one" name="extensions.myextension.one" type="bool"/>
    ... more preferences ...
  </preferences>

  <checkbox label="Number one?" preference="pref_one"/>
  ... more UI elements ...
</prefpane>

属性

プロパティ

メソッド

DOMElement getPreferenceElement(in DOMElement startElement)

preferenceForElement( uielement )

戻り値の型: preference 要素

preference 要素をユーザインタフェース要素が付属する要素に返します。

void userChangedValue(in DOMElement element);

The user changed the value in a widget that the preferences system does not automatically track state changes for (1) and the preference element associated with the widget should be updated based on the state held by the widget. For example, if you are using a listbox and the user changes the contents of the listbox (such as adding or removing an item) and you want to sync the changes back to a preference, you must write an onsynctopreference handler for your listbox that returns the value to be written to the preference element, and then call the userChangedValue function every time you edit the list in a way that should cause the preference's value to change.

(1) an example of a widget that has state changes tracked for it includes the checkbox element, whose state is tracked automatically when the "command" event fires.

void writePreferences(in boolean flushToDisk);

Writes all changes in this pane to preferences, optionally flushes to disk.

Events

paneload

This event is fired on the pane element when the pane is fully loaded (e.g. after the overlay is merged.) You can put the handler for this event in the onpaneload attribute on the element.

Using multiple prefpanes

Note that when using multiple prefpanes in the same prefwindow, you must not put the <script> elements above the prefpane elements, but instead below them. Otherwise the dialog will show erratic behavior and not display correctly.

Place the <script> tags as in the following example for preference dialogs to work correctly:

<prefwindow>
  <prefpane id="paneGeneral" label="General">
    ...
  </prefpane>

  <prefpane id="paneSecurity" label="Security">
    ...
  </prefpane>

  <script type="application/javascript" src="chrome://myext/content/script0.js">
  <script type="application/javascript" src="chrome://myext/content/script1.js">
</prefwindow>

When opening a dialog with multiple panes you must include the toolbar feature in the call to openDialog, for example:

window.openDialog("chrome://example/content/prefwin.xul", "", "chrome,toolbar");

関連項目

• prefwindow