wizard

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

この要素はいくつかのアプリケーションでみられるタスク全体をユーザに案内するための段階的なウィザードを作るために使われます。それは複数のページに含まれる複数の段階のウィンドウとして使われます。この要素はヘッダとページの下のボタン及びページ間の移動を処理します。それぞれのページは wizardpage を使ってつくられます。ページは順序を変更するために next と pageid 属性が使われない限り、wizard におかれた順に表示されます。ウィザードはユーザの選択したテーマとプラットフォームに的した方法で表示されます。Mozilla の新しいバージョンでは wizard 要素に全てのページで共有される statusbar を直接おくことができます。

詳しい情報が XUL チュートリアルにあります。

属性: firstpage, lastpage, onextra1, onextra2, onwizardback, onwizardcancel, onwizardfinish, onwizardnext, pagestep, title, windowtype

プロパティ: canAdvance, canRewind, currentPage, onFirstPage, onLastPage, pageCount, pageIndex, pageStep, title, wizardPages

メソッド: advance, cancel, extra1, extra2, getButton, getPageById, goTo, rewind

例

<?xml version="1.0"?>
<?xml-stylesheet href="chrome://global/skin/" type="text/css"?>

<wizard id="theWizard" title="Secret Code Wizard"
  xmlns="https://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul">

<script>
function checkCode(){
  document.getElementById('theWizard').canAdvance = (document.getElementById('secretCode').value == "cabbage");
} 
</script>

  <wizardpage onpageshow="checkCode();">
       <label value="Enter the secret code:"/>
       <textbox id="secretCode" onkeyup="checkCode();"/>
  </wizardpage>

  <wizardpage>
       <label value="That is the correct secret code."/>
  </wizardpage>

</wizard>

属性

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

firstpage: 型: 論理型; wizard が最初の page であるとき true になります。

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

lastpage: 型: 論理型; wizard が最後の page であるとき true になります。

onextra1: 型: スクリプトコード; ユーザが extra1 ボタンを押した時に呼び出されるコードを設定します。

onextra2: 型: スクリプトコード; ユーザが extra2 ボタンを押した時に呼び出されるコードを設定します。

onwizardback: 型: スクリプトコード; ユーザが Back ボタンを押した時に呼び出されるコードを設定します。前のページの表示を許可するには true を返し、前のページへの移動を許可しないときは false を返してください。ユーザに (Back ボタンを無効にして) ページを戻れないことを示すには canRewind プロパティを使用してください。

onwizardcancel: 型: スクリプトコード; ユーザが Cancel ボタンを押した時に呼び出されるコードを設定します。wizard のキャンセルを許可して閉じるには true を返し、wizard のキャンセルを防ぐには false を返してください。ユーザに (Cancel ボタンを無効にして) キャンセルできないことを示すには {{ XULProp|canCancel }} プロパティを使用してください。

onwizardfinish: 型: スクリプトコード; ユーザが Finish ボタンを押した時に呼び出されるコードを設定します。Finish ボタンは wizard の最後のページで Next ボタンの位置に現れます。wizard を閉じてページ上に入力された値に同意するには true を返し、wizard を閉じないようにするには false を返してください。ユーザに (Finish ボタンを無効にして) wizard が終了できないことを示すには canAdvance プロパティを使用してください。

onwizardnext: 型: スクリプトコード; ユーザが Next ボタンを押した時に呼び出されるコードを設定します。次のページを表示するには true を返し、次のページへの移動を許可しないときは false を返してください。ユーザに (Next ボタンを無効にして) 次のページへ移動できないことを示すには canAdvance プロパティを使用してください。

pagestep: 型: 整数型; 現在のページの index。

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

windowtype: 型: 文字列型; window の種類を識別するために使用する文字列を設定します。例えば、ブラウザウィンドウと編集ウィンドウを区別するために使用します。Mozilla のウィンドウを扱う関数の一部は、この属性を同じ種類のウィンドウをグループ化するために使用します。

プロパティ

canAdvance: 型: 論理型; このプロパティは、ユーザが Next ボタンを押して次のページへ進めるとき、true に設定されます。このプロパティが false の場合、ユーザは次のページへ移動することができません。ユーザが次のページへ進めることを示すには、このプロパティを true に設定します。次のページへの移動を拒否するには false に設定します。これは Next ボタン (wizard の最後のページでは Finish ボタン) を有効または無効にします。

canRewind: 型: 論理型; このプロパティは、ユーザが Back ボタンを押して前のページへ戻れるとき、true に設定されます。このプロパティが false の場合、ユーザは前のページへ移動することができません。ユーザが前のページへ戻れることを示すには、このプロパティを true に設定します。前のページへの移動を拒否するには false に設定します。これは Back ボタンを有効または無効にします。

currentPage: 型: wizardpage 要素; このプロパティは現在表示されている wizardpage 要素を返します。この値を調整して現在のページを変更することができます。

onFirstPage: 型: 論理型; このプロパティは、ユーザが最初のページを開いているとき、true に設定されます。このページは最初の index かもしれません。

onLastPage: 型: 論理型; このプロパティは、ユーザが wizard の最後のページを開いている時、true に設定されます。

pageCount: 型: 整数型; このプロパティは wizard 内のページ数を保持します。

pageIndex: 型: 整数型; このプロパティは現在選択されているページの index を返します。このプロパティを調整して選択されたページを変更することができます。

pageStep: 型: 整数型; このプロパティはユーザが辿ってきたページ数を返します。つまり、ユーザが Back ボタンを押すと、この値もその回数分最初に戻ります。ユーザが各ページへ順番に移動する必要はないため、このプロパティは pageIndex と異なります。

title: 型: 文字列型; wizard の上部に表示されるタイトル。これは、各ページの label 属性によって上書きされます。

wizardPages: 型: wizardpage 要素の DOM NodeList; このプロパティは wizard 内の wizardpage 要素のリストを保持します。

メソッド

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

DOM 要素からの継承
addEventListener(), appendChild(), compareDocumentPosition, dispatchEvent(), getAttribute(), getAttributeNode(), getAttributeNodeNS(), getAttributeNS(), getElementsByTagName(), getElementsByTagNameNS(), getFeature, getUserData, hasAttribute(), hasAttributeNS(), hasAttributes(), hasChildNodes(), insertBefore(), isEqualNode, isSameNode, isSupported(), lookupNamespaceURI, lookupPrefix, normalize(), removeAttribute(), removeAttributeNode(), removeAttributeNS(), removeChild(), removeEventListener(), replaceChild(), setAttribute(), setAttributeNode(), setAttributeNodeNS(), setAttributeNS(), setUserData

« XUL リファレンス HOME

advance( pageID ): 戻り値の型: 戻り値なし; 次のページへ移動するには、このメソッドを呼び出します。これは Next ボタンの押下と同等です。ページを変更するために、canAdvance プロパティが true に設定されていなければなりません。onwizardnext 属性内のコードはページが変更される前に呼び出されます。pageID 引数はジャンプ先のページの index を指定します。次のページへ順番に移動するには、引数に null を設定します。

cancel(): 戻り値の型: 戻り値無し; wizard をキャンセルして閉じるには、このメソッドを呼び出します。 wizard がキャンセルされる前に、onwizardcancel 属性内のコードが呼び出されます。

extra1(): 戻り値の型: 戻り値無し; extra1 ボタンのクリックをシミュレートするには、このメソッドを呼び出します。 onextra1 属性内のコードが呼び出されます。

extra2(): 戻り値の型: 戻り値無し; extra2 ボタンのクリックをシミュレートするには、このメソッドを呼び出します。 onextra2 属性内のコードが呼び出されます。

getButton( type ): 戻り値の型: button 要素; 指定した type に一致する、 dialog 内の button 要素を返します。

getPageById( pageID ): 戻り値の型: wizardpage 要素; 指定した <var>pageID</var> に対応する wizardpage 要素を返します。

goTo( pageID ): 戻り値の型: 戻り値無し; このメソッドは、現在表示されているページを pageID 引数で指定されたページに変更します。ページは canAdvance や canRewind の値にかまわず変更されます。この関数を使用した場合、onwizardback および onwizardnext のコードは呼び出されません。

rewind(): 戻り値の型: 戻り値無し; ページを戻るには、このメソッドを呼び出します。これは Back ボタンの押下と同等です。ページを変更するために、canRewind プロパティが true に設定されていなければなりません。ページが変更される前に、onwizardback 属性内のコードが呼び出されます。

wizard

例

属性

プロパティ

メソッド

関連項目

ドキュメントのタグと貢献者