path: root/files/ja/archive/mozilla/xul/prefpane/index.html

---
title: prefpane
slug: Archive/Mozilla/XUL/prefpane
tags:
  - Preferences system
  - XUL Elements
  - XUL Reference
translation_of: Archive/Mozilla/XUL/prefpane
---
<div class="noinclude"><span class="breadcrumbs XULRef_breadcrumbs">
 « <a href="/ja/docs/XUL/XUL_Reference">XUL リファレンス HOME</a>    [
 <a href="#Examples">例</a> |
 <a href="#Attributes">属性</a> |
 <a href="#Properties">プロパティ</a> |
 <a href="#Methods">メソッド</a> |
 <a href="#Related">関連項目</a> ]
</span></div>

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

<p>これら二つの部分は <code>prefpane</code> 要素の子として直接指定するか、<code id="a-src"><a href="https://developer.mozilla.org/ja/docs/Mozilla/Tech/XUL/Attribute/src">src</a></code> 属性を使用して別のファイル内のペインに置きます。後者の場合、メインの設定ウィンドウのオーバーレイとして読み込まれるため、別のファイルでは、そのルートタグとして <code><a href="/ja/docs/Mozilla/Tech/XUL/overlay" title="overlay">overlay</a></code> タグを使用しなければなりません。</p>

<p>詳しい情報が<a href="/ja/docs/Preferences_System" title="Preferences_System">設定システム</a>の記事にあります。</p>

<dl>
 <dt>属性</dt>
 <dd><a href="#a-helpURI">helpURI</a>, <a href="#a-image">image</a>, <a href="#a-label">label</a>, <a href="#a-onpaneload">onpaneload</a>, <a href="#a-prefpane.selected">selected</a>, <a href="#a-prefpane.src">src</a></dd>
 <dt>プロパティ</dt>
 <dd><a href="#p-image">image</a>, <a href="#p-label">label</a>, <a href="#p-preferenceElements">preferenceElements</a>, <a href="#p-prefpane.preferences">preferences</a>, <a href="#p-selected">selected</a>, <a href="#p-src">src</a></dd>
 <dt>メソッド</dt>
 <dd><a href="#m-preferenceForElement">preferenceForElement</a></dd>
</dl>

<h3 id="Examples" name="Examples">例</h3>

<pre class="brush:xml;auto-links:false;">&lt;prefpane id="paneGeneral" label="General" src="chrome://path/to/paneOverlay.xul"/&gt;
</pre>

<p>または…</p>

<pre class="brush:xml">&lt;prefpane id="paneGeneral" label="General" onpaneload="onGeneralPaneLoad(event);"&gt;
  &lt;preferences&gt;
    &lt;preference id="pref_one" name="extensions.myextension.one" type="bool"/&gt;
    ... more preferences ...
  &lt;/preferences&gt;

  &lt;checkbox label="Number one?" preference="pref_one"/&gt;
  ... more UI elements ...
&lt;/prefpane&gt;</pre>

<h3 id="Attributes" name="Attributes">属性</h3>

<div> <div id="a-helpURI">

<dl>
  <dt>
    <code id="a-helpURI"><a href="https://developer.mozilla.org/ja/docs/Mozilla/Tech/XUL/Attribute/helpURI">helpURI</a></code></dt>
  <dd>
    型: <em>uri</em></dd>
  <dd>
    preference パネルに関連付けられたヘルプページの URI。この URI は、help ボタンが押されたとき、ヘルプビューアで開かれます。</dd>
</dl>
</div> <div id="a-image">

<dl>
  <dt>
    <code id="a-image"><a href="https://developer.mozilla.org/ja/docs/Mozilla/Tech/XUL/Attribute/image">image</a></code></dt>
  <dd>
    型: 画像の <em>URL</em></dd>
  <dd>
    要素上に表示する画像の URL。この属性が空または除外された場合、画像は表示されません。画像の位置は <code id="a-dir"><a href="https://developer.mozilla.org/ja/docs/Mozilla/Tech/XUL/Attribute/dir">dir</a></code> 属性および <code id="a-orient"><a href="https://developer.mozilla.org/ja/docs/Mozilla/Tech/XUL/Attribute/orient">orient</a></code> 属性によって決定されます。</dd>
</dl>


</div> <div id="a-label">

<dl><dt> <code id="a-label"><a href="https://developer.mozilla.org/ja/docs/Mozilla/Tech/XUL/Attribute/label">label</a></code> </dt><dd> 型: <em>文字列型</em> </dd><dd> 要素上に表示するlabel。 省略された場合、テキストは表示されない。 </dd></dl>


</div> <div id="a-onpaneload">

<dl>
  <dt>
    <code id="a-onpaneload"><a href="https://developer.mozilla.org/ja/docs/Mozilla/Tech/XUL/Attribute/onpaneload">onpaneload</a></code></dt>
  <dd>
    型: <em>スクリプトコード</em></dd>
  <dd>
    ここで定義されたコードは、window の <code>load</code> イベントのように、ペインが読み込まれた時、呼び出されます。</dd>
</dl>
</div> <div id="a-prefpane.selected">

<dl>
  <dt>
    <code id="a-prefpane.selected"><a href="https://developer.mozilla.org/ja/docs/Mozilla/Tech/XUL/Attribute/prefpane.selected">selected</a></code></dt>
  <dd>
    型: <em>論理型</em></dd>
  <dd>
    この属性は、現在選択された <code><a href="/ja/docs/Mozilla/Tech/XUL/prefpane" title="prefpane">prefpane</a></code> で <code>true</code> に設定されます。選択されたペインを変更するには <code><a href="/ja/docs/Mozilla/Tech/XUL/prefwindow" title="prefwindow">prefwindow</a></code> の <span id="m-showPane"><code><a href="https://developer.mozilla.org/ja/docs/Mozilla/Tech/XUL/Method/showPane">showPane</a></code></span> メソッドを使用してください。</dd>
</dl>

</div> <div id="a-prefpane.src">

<dl>
  <dt>
    <code id="a-prefpane.src"><a href="https://developer.mozilla.org/ja/docs/Mozilla/Tech/XUL/Attribute/prefpane.src">src</a></code></dt>
  <dd>
    型: <em>overlay URL</em></dd>
  <dd>
    preference ペインのコンテンツの URL。これが指定されていないときは <code><a href="/ja/docs/Mozilla/Tech/XUL/prefpane" title="prefpane">prefpane</a></code> 要素のコンテンツが使用されます。</dd>
</dl>


</div></div>

<h3 id="Properties" name="Properties">プロパティ</h3>

<p> </p><div id="p-image">
<dl><dt> <code><span><a href="https://developer.mozilla.org/ja/docs/XUL/Property/image">image</a></span></code> </dt><dd> 型: <em>image の URL</em> </dd><dd> <code id="a-image"><a href="https://developer.mozilla.org/ja/docs/Mozilla/Tech/XUL/Attribute/image">image</a></code> 属性の値の取得と設定。 </dd></dl>
</div> <div id="p-label">
<dl>
  <dt>
    <code><span><a href="https://developer.mozilla.org/ja/docs/XUL/Property/label">label</a></span></code></dt>
  <dd>
    型: <em>文字列型</em></dd>
  <dd>
    <code id="a-label"><a href="https://developer.mozilla.org/ja/docs/Mozilla/Tech/XUL/Attribute/label">label</a></code> 属性の値の取得と設定。</dd>
</dl>

</div> <div id="p-preferenceElements">
<dl>
  <dt>
    <code><span><a href="https://developer.mozilla.org/ja/docs/XUL/Property/preferenceElements">preferenceElements</a></span></code></dt>
  <dd>
    型: <em>DOM Nodelist</em></dd>
  <dd>
    preferences に関連付けられたペイン内の UI 要素のリストを保持します。</dd>
</dl></div> <div id="p-prefpane.preferences">
<dl>
  <dt>
    <code><span><a href="https://developer.mozilla.org/ja/docs/XUL/Property/prefpane.preferences">preferences</a></span></code></dt>
  <dd>
    型: <em>DOM Nodelist</em></dd>
  <dd>
    ペイン内の <code><a href="/ja/docs/Mozilla/Tech/XUL/preference" title="preference">preference</a></code> 要素のリストを保持します。</dd>
</dl></div> <div id="p-selected">
<dl>
<dt><code><span><a href="https://developer.mozilla.org/ja/docs/XUL/Property/selected">selected</a></span></code></dt>
<dd> 型: <em>論理型</em> </dd><dd> このプロパティの値は、要素が選択されているときは <code>true</code>、選択されていないときは <code>false</code> です。このプロパティは読み取り専用です。</dd>
</dl></div> <div id="p-src">
<dl><dt> <code><span><a href="https://developer.mozilla.org/ja/docs/XUL/Property/src">src</a></span></code> </dt><dd> 型: <em>URL</em> </dd><dd> <code id="a-src"><a href="https://developer.mozilla.org/ja/docs/Mozilla/Tech/XUL/Attribute/src">src</a></code> 属性の値の取得と設定。 </dd></dl>
</div>

<h3 id="Methods" name="Methods">メソッド</h3>

<dl>
 <dt><code>DOMElement getPreferenceElement(in DOMElement startElement)</code></dt>
 <dd><dl>
  <dt><span id="m-preferenceForElement"><code><a href="https://developer.mozilla.org/ja/docs/Mozilla/Tech/XUL/Method/preferenceForElement">preferenceForElement( uielement )</a></code></span></dt>
  <dd>戻り値の型: <em><code>preference</code> 要素</em></dd>
  <dd><code><a href="/ja/docs/Mozilla/Tech/XUL/preference" title="preference">preference</a></code> 要素をユーザインタフェース要素が付属する要素に返します。</dd>
</dl></dd>
 <dt><code>void userChangedValue(in DOMElement element);</code></dt>
 <dd>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 <code>onsynctopreference</code> handler for your listbox that returns the value to be written to the preference element, and then call the <code>userChangedValue</code> function every time you edit the list in a way that should cause the preference's value to change.</dd>
 <dd>(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.</dd>
 <dt><code>void writePreferences(in boolean flushToDisk);</code></dt>
 <dd>Writes all changes in this pane to preferences, optionally flushes to disk.</dd>
</dl>

<div><div style="border: 1px solid rgb(204, 204, 204); margin: 0px 0px 10px 10px; padding: 0px 10px; background: rgb(238, 238, 238) none repeat scroll 0% 50%;">
<p><strong>XUL 要素からの継承</strong><br>
<small> <span id="m-blur"><code><a href="https://developer.mozilla.org/ja/docs/Mozilla/Tech/XUL/Method/blur">blur</a></code></span>, <span id="m-click"><code><a href="https://developer.mozilla.org/ja/docs/Mozilla/Tech/XUL/Method/click">click</a></code></span>, <span id="m-doCommand"><code><a href="https://developer.mozilla.org/ja/docs/Mozilla/Tech/XUL/Method/doCommand">doCommand</a></code></span>, <span id="m-focus"><code><a href="https://developer.mozilla.org/ja/docs/Mozilla/Tech/XUL/Method/focus">focus</a></code></span>, <span id="m-getElementsByAttribute"><code><a href="https://developer.mozilla.org/ja/docs/Mozilla/Tech/XUL/Method/getElementsByAttribute">getElementsByAttribute</a></code></span>, <span id="m-getElementsByAttributeNS"><code><a href="https://developer.mozilla.org/ja/docs/Mozilla/Tech/XUL/Method/getElementsByAttributeNS">getElementsByAttributeNS</a></code></span> </small></p>
<p><strong>DOM 要素からの継承</strong><br>
<small> <code><a href="https://developer.mozilla.org/ja/docs/DOM/element.addEventListener">addEventListener()</a></code>, <code><a href="https://developer.mozilla.org/ja/docs/DOM/element.appendChild">appendChild()</a></code>, <a class="internal" href="/ja/DOM/Node.compareDocumentPosition" title="ja/DOM/Node.compareDocumentPosition">compareDocumentPosition</a>, <code><a href="https://developer.mozilla.org/ja/docs/DOM/element.dispatchEvent">dispatchEvent()</a></code>, <code><a href="https://developer.mozilla.org/ja/docs/DOM/element.getAttribute">getAttribute()</a></code>, <code><a href="https://developer.mozilla.org/ja/docs/DOM/element.getAttributeNode">getAttributeNode()</a></code>, <code><a href="https://developer.mozilla.org/ja/docs/DOM/element.getAttributeNodeNS">getAttributeNodeNS()</a></code>, <code><a href="https://developer.mozilla.org/ja/docs/DOM/element.getAttributeNS">getAttributeNS()</a></code>, <code><a href="https://developer.mozilla.org/ja/docs/DOM/element.getElementsByTagName">getElementsByTagName()</a></code>, <code><a href="https://developer.mozilla.org/ja/docs/DOM/element.getElementsByTagNameNS">getElementsByTagNameNS()</a></code>, <a class="internal" href="/ja/DOM/Node.getFeature" title="ja/DOM/Node.getFeature">getFeature</a>, <a class="internal" href="/ja/DOM/Node.getUserData" title="ja/DOM/Node.getUserData">getUserData</a>, <code><a href="https://developer.mozilla.org/ja/docs/DOM/element.hasAttribute">hasAttribute()</a></code>, <code><a href="https://developer.mozilla.org/ja/docs/DOM/element.hasAttributeNS">hasAttributeNS()</a></code>, <code><a href="https://developer.mozilla.org/ja/docs/DOM/element.hasAttributes">hasAttributes()</a></code>, <code><a href="https://developer.mozilla.org/ja/docs/DOM/element.hasChildNodes">hasChildNodes()</a></code>, <code><a href="https://developer.mozilla.org/ja/docs/DOM/element.insertBefore">insertBefore()</a></code>, <a class="internal" href="/ja/DOM/Node.isEqualNode" title="ja/DOM/Node.isEqualNode">isEqualNode</a>, <a class="internal" href="/ja/DOM/Node.isSameNode" title="ja/DOM/Node.isSameNode">isSameNode</a>, <code><a href="https://developer.mozilla.org/ja/docs/DOM/element.isSupported">isSupported()</a></code>, <a class="internal" href="/ja/DOM/Node.lookupNamespaceURI" title="ja/DOM/Node.lookupNamespaceURI">lookupNamespaceURI</a>, <a class="internal" href="/ja/DOM/Node.lookupPrefix" title="ja/DOM/Node.lookupPrefix">lookupPrefix</a>, <code><a href="https://developer.mozilla.org/ja/docs/DOM/element.normalize">normalize()</a></code>, <code><a href="https://developer.mozilla.org/ja/docs/DOM/element.removeAttribute">removeAttribute()</a></code>, <code><a href="https://developer.mozilla.org/ja/docs/DOM/element.removeAttributeNode">removeAttributeNode()</a></code>, <code><a href="https://developer.mozilla.org/ja/docs/DOM/element.removeAttributeNS">removeAttributeNS()</a></code>, <code><a href="https://developer.mozilla.org/ja/docs/DOM/element.removeChild">removeChild()</a></code>, <code><a href="https://developer.mozilla.org/ja/docs/DOM/element.removeEventListener">removeEventListener()</a></code>, <code><a href="https://developer.mozilla.org/ja/docs/DOM/element.replaceChild">replaceChild()</a></code>, <code><a href="https://developer.mozilla.org/ja/docs/DOM/element.setAttribute">setAttribute()</a></code>, <code><a href="https://developer.mozilla.org/ja/docs/DOM/element.setAttributeNode">setAttributeNode()</a></code>, <code><a href="https://developer.mozilla.org/ja/docs/DOM/element.setAttributeNodeNS">setAttributeNodeNS()</a></code>, <code><a href="https://developer.mozilla.org/ja/docs/DOM/element.setAttributeNS">setAttributeNS()</a></code>, <a class="internal" href="/ja/DOM/Node.setUserData" title="ja/DOM/Node.setUserData">setUserData</a></small></p>
</div></div>

<h3 id="Events" name="Events">Events</h3>

<dl>
 <dt><code>paneload</code></dt>
 <dd>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 <code>onpaneload</code> attribute on the element.</dd>
</dl>

<h3 id="Using_multiple_prefpanes" name="Using_multiple_prefpanes">Using multiple <code>prefpane</code>s</h3>

<p>Note that when using multiple <code>prefpane</code>s in the same <code>prefwindow</code>, you must not put the <code>&lt;script&gt;</code> elements above the <code>prefpane</code> elements, but instead below them. Otherwise the dialog will show erratic behavior and not display correctly.</p>

<p>Place the <code>&lt;script&gt;</code> tags as in the following example for preference dialogs to work correctly:</p>

<pre class="brush:xml;auto-links:false;">&lt;prefwindow&gt;
  &lt;prefpane id="paneGeneral" label="General"&gt;
    ...
  &lt;/prefpane&gt;

  &lt;prefpane id="paneSecurity" label="Security"&gt;
    ...
  &lt;/prefpane&gt;

  &lt;script type="application/javascript" src="chrome://myext/content/script0.js"&gt;
  &lt;script type="application/javascript" src="chrome://myext/content/script1.js"&gt;
&lt;/prefwindow&gt;</pre>

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

<pre class="brush:js;auto-links:false;">window.openDialog("chrome://example/content/prefwin.xul", "", "chrome,toolbar");</pre>

<h3 id="Related" name="Related">関連項目</h3>

<ul>
 <li><code><a href="/ja/docs/Mozilla/Tech/XUL/prefwindow" title="prefwindow">prefwindow</a></code></li>
</ul>

<div><div class="moreinfo">  <p><strong><a href="/ja/docs/Preferences_System">設定システム</a>の資料:</strong></p>  <ul>    <li>簡単な紹介: <a href="/ja/docs/Preferences_System/Getting_Started">Getting Started</a> | <a href="/ja/docs/Preferences_System/Examples">サンプル</a> | <a href="/ja/docs/Preferences_System/Troubleshooting">トラブルシューティング</a></li>    <li>リファレンス: <code><a href="/ja/docs/Mozilla/Tech/XUL/prefwindow" title="prefwindow">prefwindow</a></code> | <code><a href="/ja/docs/Mozilla/Tech/XUL/prefpane" title="prefpane">prefpane</a></code> | <code><a href="/ja/docs/Mozilla/Tech/XUL/preferences" title="preferences">preferences</a></code> | <code><a href="/ja/docs/Mozilla/Tech/XUL/preference" title="preference">preference</a></code> | <a href="/ja/docs/Preferences_System/New_attributes">新しい属性</a></li>  </ul></div></div>