Skip to main content

Visit Mozilla.org

XUL:prefwindow

出典: MDC

« XUL リファレンス HOME    [ 例 | 属性 | プロパティ | メソッド | 関連項目 ]

設定ダイアログに使用される特別なウィンドウ。この要素は window タグの中に置いて使用し、一つ以上の prefpane 要素を含めなければなりません。ボタンの行が preference ダイアログの各 prefpane すべてに現れます。通常、各ペインは関連する設定が一つのグループにまとめられます。一つの prefpane しかないときは、ナビゲーション領域が隠されます。

変更がすぐに適用される慣習のあるプラットフォーム上では、ユーザインタフェース要素が変更されるとすぐに設定が調整されます。他のプラットフォーム上では、ダイアログが閉じられるまで設定が適用されません。

設定ウィンドウをは、他のダイアログと同じように、window の openDialog メソッドを使用して開くことができます。デフォルトで指定のペインを開くには、openDialog の四番目の引数に特定のペインの id を渡します。また、prefwindow タグ上の lastSelected 属性に開始するペインの id を設定して指定することもできます。通常は、この属性を設定しなくても、設定ダイアログを最後に閉じた時に表示していたものが自動的にデフォルトのペインとして設定されます。

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

属性
buttonalign, buttondir, buttonorient, buttonpack, buttons, defaultButton, lastSelected, onbeforeaccept, ondialogaccept, ondialogcancel, ondialogdisclosure, ondialoghelp, onpaneload, title, type
プロパティ
buttons, currentPane, defaultButton, lastSelected, preferencePanes, type
メソッド
acceptDialog, addPane, cancelDialog, centerWindowOnScreen, getButton, openSubDialog, openWindow, showPane

[編集] 例 

   <prefwindow xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul">
     <prefpane id="saveoptions" label="Backups">
       <preferences>
         <preference id="pref-backup" name="myapp.mybackups" type="bool"/>
         <preference id="pref-backupduration" name="myapp.mybackups.duration" type="int"/>
       </preferences>
       <checkbox label="Automatically Save Backups" preference="pref-backup"/>
       <textbox label="Duration:" preference="pref-backupduration"/>
     </prefpane>
   </prefwindow>

[編集] 属性

XUL 要素からの継承
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, querytype, ref, removeelement, sortDirection, sortResource, sortResource2, statustext, style, template, tooltip, tooltiptext, top, uri, wait-cursor, width

activetitlebarcolor Firefox 3 の新機能
型: color string
ウィンドウがアクティブな時のタイトルバーについて、背景色を指定された色にし、ウィンドウ内容との間の境界線を非表示にします。この属性は Mac OS X でのみ有効です。

buttonalign
型: string
box が含むボタンのための align 属性の値。

buttondir
型: string
box が含むボタンのための dir 属性の値。

buttonorient
型: string
box が含むボタンのための orient 属性の値。

buttonpack
型: string
box が含むボタンのための pack 属性の値。

buttons
型: 下記の値をカンマで区切ったリスト
ダイアログボックス中に現れるボタンをカンマで区切ったリスト。ボタンはユーザのプラットフォームに適した位置に置かれ、基本的なイベントハンドリングが自動で行われます。次の値をリストで使用することができます。
  • accept: 押下すると変更を許諾する OKボタンです。このボタンがデフォルトになります。
  • cancel: 操作を中止するキャンセルボタンです。
  • help: ダイアログについてのヘルプを表示するヘルプボタンです。
  • disclosure: 追加の情報を表示するボタンです。これはボタンになるか、情報を表示する三角形になります。
  • extra1:任意で追加されるボタンです。buttonlabelextra1 属性でこのボタンのラベルを設定することができます。
  • extra2: 任意で追加されるもう一つのボタンです。buttonlabelextra2 属性でこのボタンのラベルを設定することができます。
註: ダイアログボックス内にボタンを表示したくないときは、属性の値に "," (カンマ一つ) を設定してください。

defaultButton
型: string
通常、この属性を設定すべきではありません。設定すると、ダイアログ内のデフォルトボタンを指定します。一般的に、これは Enter キーが押下された時にボタンが有効化されることを意味します。この属性には buttons 属性で設定できる値と同じものを設定します。

inactivetitlebarcolor Firefox 3 の新機能
型: color string
ウィンドウが非アクティブな時のタイトルバーについて、背景色を指定された色にし、ウィンドウ内容との間の境界線を非表示にします。この属性は Mac OS X でのみ有効です。

lastSelected
型: string
最後に選択されたペインの id を設定します。次に設定ダイアログを開いたとき、このペインがデフォルトで開かれます。

onbeforeaccept
型: script code
この属性内のコードは、OK ボタンが押されたとき、または acceptDialog メソッドが呼ばれたときに呼び出されます。

ondialogaccept
型: script code
この属性内のコードは、accept ボタンが押されたとき、もしくは acceptDialog メソッドが呼ばれたときに呼ばれます。ハンドラが true を返す場合、ダイアログは閉じますが、false を返す場合、閉じることはありません。

ondialogcancel
型: script code
この属性内のコードは、"cancel" ボタンが押されたとき、または cancelDialog メソッドが呼ばれたときに呼び出されます。このルーチンが true を返す場合、そのままダイアログが閉じられます。false を返す場合は閉じられません。

ondialogdisclosure
型: script code
この属性内のコードは、"disclosure" ボタンが押されたとき呼び出されます。

ondialoghelp
型: script code
この属性内のコードは、"help" ボタンが押されたとき呼び出されます。

onpaneload
型: script code
ここで定義されたコードは、window の load イベントのように、ペインが読み込まれた時、呼び出されます。

title
型: string
window のタイトルバーに表示するためのテキスト。

type
型: string
メイン設定ウィンドウの子ダイアログには、この属性を child に設定してください。プラットフォームにとって適切な動作であれば、設定はメインダイアログが閉じられた時のみ保存されます。


[編集] プロパティ

XUL 要素からの継承
align, allowEvents, boxObject, builder, className, collapsed, contextMenu, controllers, currentItem, database, datasources, dir, flex, height, hidden, id, left, listBoxObject, maxHeight, maxWidth, menu, minHeight, minWidth, observes, ordinal, orient, pack, persist, ref, resource, statusText, style, tooltip, tooltipText, top, value, width

DOM 要素からの継承
attributes, childNodes, cloneNode, firstChild, lastChild, localName, namespaceURI, nextSibling, nodeName, nodeType, nodeValue, ownerDocument, parentNode, prefix, previousSibling, tagName

buttons
型: 下記の値をカンマで区切ったリスト
ダイアログボックス中に現れるボタンをカンマで区切ったリスト。ボタンはユーザのプラットフォームに適した位置に置かれ、基本的なイベントハンドリングが自動で行われます。次の値をリストで使用することができます:
  • accept: 押下すると変更を許諾する OKボタンです。このボタンがデフォルトになります。
  • cancel: 操作を中止するキャンセルボタンです。
  • help: ダイアログについてのヘルプを表示するヘルプボタンです。
  • disclosure: 追加の情報を表示するボタンです。これはボタンになるか、情報を表示する三角形になります。
  • extra1: 任意で追加されるボタンです。buttonlabelextra1 属性でこのボタンのラベルを設定することができます。
  • extra2: 任意で追加されるもう一つのボタンです。buttonlabelextra2 属性でこのボタンのラベルを設定することができます。

currentPane
型: prefpane element
現在表示されているペインへの参照。現在のペインを変更するには showPane メソッドを使用してください。

defaultButton
型: string
通常、この属性を設定すべきではありません。設定すると、ダイアログ内のデフォルトボタンを指定します。一般的に、これは Enter キーが押下された時にボタンが有効化されることを意味します。この属性には buttons 属性で設定できる値と同じものを設定します。

lastSelected
型: string
最後に選択されたペインの id を設定します。次に設定ダイアログを開いたとき、このペインがデフォルトで開かれます。

preferencePanes
型: DOM NodeList
window 内のすべての prefpane 要素のリストを保持します。

type
型: string
type 属性の値の取得と設定。

[編集] メソッド

XUL 要素からの継承
blur, click, doCommand, focus, getElementsByAttribute

DOM 要素からの継承
addEventListener, appendChild, dispatchEvent, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, hasAttribute, hasAttributeNS, hasAttributes, hasChildNodes, insertBefore, isSupported, normalize, removeAttribute, removeAttributeNode, removeAttributeNS, removeChild, removeEventListener, replaceChild, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS

acceptDialog()
戻り値の型: 戻り値なし
dialog に同意して閉じます。OK ボタンの押下と似ています。

addPane( prefpane )
戻り値の型: 戻り値なし
ペインのリストに prefpane を追加します。

cancelDialog()
戻り値の型: 戻り値なし
dialog をキャンセルして閉じます。Cancel ボタンの押下と似ています。

centerWindowOnScreen()
戻り値の型: 戻り値なし
dialog をスクリーンの中央に配置します。

getButton( type )
戻り値の型: button 要素
与えられた type に一致する dialog 内の button 要素を返します。

openSubDialog( url, features, params )
戻り値の型: window
子ダイアログを開きます。通常、このメソッドはユーザに詳細オプションを設定させるために使用します。引数は window の openDialog に似ていますが、window 名を提供する必要はありません。url は XUL ファイルでなければなりません。子ダイアログも prefwindow である場合は、その type 属性を child に設定してください。メインダイアログが閉じられた時、その設定が保存されます。

openWindow( windowtype, url, features, params )
戻り値の型: window
子ウィンドウを開きます。windowtype は window 形式を指定する文字列です。指定した形式のウィンドウがすでに開かれている場合、このメソッドは、もう一つのウィンドウを開く代わりに、そのウィンドウにフォーカスを切り替えて最前面に表示します。指定した形式のウィンドウが開かれていない場合、与えられた url を表示する新しいウィンドウが開かれます。

showPane( prefpane )
戻り値の型: 戻り値なし
特定のペインに表示を切り替えます。

[編集] 関連項目

TBD

"http://developer.mozilla.org/ja/docs/XUL:prefwindow" より作成