Wizard
This element is used to construct a step-by-step wizard found in some applications to guide users through a task. It is used for a window with several steps contained on several pages. This element provides the header and buttons along the bottom, and also handles navigation between the pages. Each page should be constructed using a wizardpage. The pages are displayed in the order that they are placed in the wizard, unless you use the next and pageid attributes on the pages to change the sequence. The wizard will rendered in a manner suitable for the user's selected theme and platform. In newer versions of Mozilla, a statusbar may be placed directly inside the wizard element which will be shared among all pages.
この要素は一部のアプリケーションなどで見られるような、利用者が行うべきことをガイドする、逐次的なウィザードの構築に利用される。 これはいくつかに分かれた段階を何ページかに分けたものを内容とするウインドウに利用される。この要素は見出しと下部のボタンを用意し、ページ間の移動を受け持つ。各ページは wizardpage 要素により構成され、ページの next 属性および pageid 属性によって順番が変更されていない限り、 wizard 要素内に置かれた順番どおりに表示される。 ウィザードは利用者が選択したテーマおよび利用者のプラットフォームにしたがって描画される。 Mozilla の新しいバージョンでは、 wizard 要素内に statusbar 要素を直接置いて、全てのページ間で共有させることができる。
プロパティとメソッド:
| advance | canAdvance | canRewind | cancel | currentPage |
| getButton | getPageById | goTo | onFirstPage | onLastPage |
| pageCount | pageIndex | pageStep | rewind | title |
| wizardPages |
属性:
XUL Element から継承:
align
allowevents
allownegativeassertions
class
coalesceduplicatearcs
collapsed
container
containment
context
contextmenu
datasources
debug
dir
empty
equalsize
flags
flex
height
hidden
id
insertafter
insertbefore
left
maxheight
maxwidth
menu
minheight
minwidth
mousethrough
observes
ordinal
orient
pack
persist
popup
position
ref
removeelement
sortDirection
sortResource
sortResource2
statustext
style
template
tooltip
tooltiptext
top
uri
wait-cursor
width
firstpage
Type: boolean
True if the wizard is on the first page.
型 : boolean
ウィザードが最初のページにあるとき、True。
lastpage
Type: boolean
True if the wizard is on the last page.
型 : boolean
ウィザードが最後のページにあるとき、True。
onwizardback
Type: script code
This should be set to code which is called when the user presses the Back button. Return true to allow the previous page to be displayed and false to disallow moving back a page. Use the canRewind property to indicate to the user (by disabling the Back button) that they cannot go back a page.
型 : script code
ユーザが「戻る」 (Back) ボタンを押したときに呼び出されるコードを設定する。 true を返した場合には前のページが表示され、 false を返した場合にはページの戻りが拒否される。 canRewind プロパティを使うと、ユーザに (「戻る」ボタンを無効にすることにより) ページを戻ることができないことを示すことができる。
onwizardcancel
Type: script code
This should be set to code which is called when the user presses the Cancel button. Return true to allow the wizard to be cancelled, and close the wizard, or return false to prevent the wizard from being cancelled. Use the canCancel property to indicate to the user (by disabling the Cancel button) that they cannot cancel.
型 : script code
ユーザが「キャンセル」 (Cancel) ボタンを押したときに呼び出されるコードを設定する。 true を返した場合にはウィザードがキャンセルを受けるまたは閉じられることができ、 false を返した場合にはウィザードをキャンセルすることができない。 canCancel プロパティを使うと、ユーザに (「キャンセル」ボタンを無効にすることにより) キャンセルすることができないことを示すことができる。
onwizardfinish
Type: script code
This should be set to code which is called when the user presses the Finish button, which would appear in place of the Next button on the last page of the wizard. Return true to allow the wizard to be closed, accepting any values entered on the pages, or return false to prevent the wizard from being closed. Use the canAdvance property to indicate to the user (by disabling the Finish button) that they cannot end the wizard.
型 : script code
ユーザが「完了」 (Finish) ボタンを押したときに呼び出されるコードを設定する。このボタンは、ウィザードの最後のページで「進む」 (Next) ボタンの代わりに表示される。 true を返した場合にはウィザードは閉じられ、各ページで入力された内容を受け取る。 false を返した場合にはウィザードを閉じることができない。 canAdvance プロパティを使うと、ユーザに (「完了」ボタンを無効にすることにより) ウィザードを終了することができないことを示すことができる。
onwizardnext
Type: script code
This should be set to code which is called when the user presses the Next button. Return true to allow the next page to be displayed and false to disallow moving to the next page. Use the canAdvance property to indicate to the user (by disabling the Next button) that they cannot go to the next page.
型 : script code
ユーザが「進む」 (Next) ボタンを押したときに呼び出されるコードを設定する。 true を返した場合には次のページが表示され、 false を返した場合には次のページへの移動が拒否される。 canAdvance プロパティを使うと、ユーザに (「進む」ボタンを無効にすることにより) 次のページへ行くことができないことを示すことができる。
pagestep
Type: integer
The index of the current page.
型 : integer
現在のページのインデックス。
title
Type: string
The title that appears at the top of the wizard. This is overriden by the label attribute on the individual pages.
型 : string
ウィザードの最上部に表示されるタイトル。個々のページの label 属性で、これを上書きすることができる。
プロパティとメソッド:
XUL Element から継承:
align
allowEvents
blur
boxObject
boxObject.element
boxObject.getLookAndFeelMetric
boxObject.height
boxObject.screenX
boxObject.screenY
boxObject.width
boxObject.x
boxObject.y
builder
className
click
collapsed
contextMenu
controllers
database
datasources
dir
doCommand
flex
focus
getElementsByAttribute
height
hidden
id
left
maxHeight
maxWidth
menu
minHeight
minWidth
observes
ordinal
orient
pack
persist
ref
resource
statusText
style
tooltip
tooltipText
top
width
Element から継承:
addEventListener
appendChild
attributes
childNodes
cloneNode
dispatchEvent
firstChild
getAttribute
getAttributeNS
getAttributeNode
getAttributeNodeNS
getElementsByTagName
getElementsByTagNameNS
hasAttribute
hasAttributeNS
hasAttributes
hasChildNodes
insertBefore
isSupported
lastChild
localName
namespaceURI
nextSibling
nodeName
nodeType
nodeValue
normalize
ownerDocument
parentNode
prefix
previousSibling
removeAttribute
removeAttributeNS
removeAttributeNode
removeChild
removeEventListener
replaceChild
setAttribute
setAttributeNS
setAttributeNode
setAttributeNodeNS
tagName
advance ( pageID )
Return Type: no return value
Call this function to go to the next page. It is equivalent to pressing the next button. The canAdvance property must be set to true for the page to be changed. The code in the onwizardnext attribute is called before the page is changed. You may supply as the argument to the advance function a page index to jump to. Supply null as the argument to go to the next page in sequence.
戻り値の型 : 戻り値なし
この関数を呼び出すと、次のページに進む。「進む」ボタンを押すのと等価である。ページを変更するには、 canAdvance プロパティを true に設定しておく必要がある。ページが変わる前に onwizardnext 属性に設定したコードが呼び出される。 advance 関数への引数として、移動先のページインデックスを渡すことができる。引数として null を渡すと、順番通りに次のページに進む。
canAdvance
Type: boolean
This property is set to true if the user can press the Next button to go to the next page. If this property is false, the user cannot navigate to the next page. Set this property to true to indicate that the user can go to the next page. Set to false to disallow moving to the next page. This has the effect of enabling or disabling the Next button, or, on the last page of the wizard, the Finish button.
型 : boolean
ユーザが「進む (Next)」ボタンを押して次のページに進むことができるとき、このプロパティは true に設定する。このプロパティが false のとき、ユーザは次のページに進むことができない。ユーザが次のページに進めることを示すには、このプロパティを true に設定する。次のページへの移動を拒否するには、 false に設定する。このプロパティは、「進む」ボタン (ウィザードの最後のページのときは「完了 (Finish)」ボタン) を有効・無効にする効果を持っている。
canRewind
Type: boolean
This property is set to true if the user can press the Next button to go to the next page. If this property is false, the user cannot navigate to the next page. Set this property to true to indicate that the user can go back a page. Set to false to disallow moving to the previous page. This has the effect of enabling or disabling the Back button.
型 : boolean
ユーザが「進む (Next)」ボタンを押して次のページに進むことができるとき、このプロパティは true に設定する。このプロパティが false のとき、ユーザは次のページに進むことができない。ユーザが前のページに戻れることを示すには、このプロパティを true に設定する。前のページへの移動を拒否するには、 false に設定する。このプロパティは、「戻る (Back)」ボタンを有効・無効にする効果を持っている。
cancel ( )
Return Type: no return value
This function can be called to cancel the wizard and close it. The code in the onwizardcancel attribute is called before the wizard is cancelled.
戻り値の型 : 戻り値なし
この関数を呼び出すと、ウィザードをキャンセルして閉じることができる。ウィザードがキャンセルされる前に、 onwizardcancel 属性のコードが呼び出される。
currentPage
Type: wizardpage element
This property returns the wizardpage element that is currently displayed. You can modify this value to change the current page.
型 : wizardpage element
このプロパティは現在表示中の wizardpage 要素を返す。この値を変更して、現在のページを買えることができる。
getButton ( type )
Return Type: button element
This method returns the wizard button of the specific type, which should be either "back", "next", "finish" or "cancel".
戻り値の型 : button element
このメソッドは、特定の型のウィザードボタン ("back"、 "next"、 "finish"、 "cancel" のどれか) を返します。
getPageById ( pageID )
Return Type: wizardpage element
Returns the wizardpage element corresponding to the specified page ID.
戻り値の型 : wizardpage element
指定したページ ID に対応する wizardpage 要素を返す。
goTo ( pageID )
Return Type: no return value
This function is used to change which page is currently displayed, specified by the argument pageID. The page will be changed regardless of the value of canAdvance or canRewind. The onwizardback and onwizardnext code is not called when using this function.
戻り値の型 : 戻り値なし
この関数は、現在表示中のページを pageID 引数で指定したものに変更するのに使用する。 canAdvance や canRewind の値には関係なく、ページは変更される。この関数を使用した場合には、 onwizardback 属性または onwizardnext 属性のコードは呼び出されない。
onFirstPage
Type: boolean
This property is set to true if the user is on the first page, which may or may not be the first index.
型 : boolean
ユーザが最初のページを表示しているとき、このプロパティは true になる。最初のページは最初のインデックスであるとは限らない。
onLastPage
Type: boolean
This property is set to true if the user is on the last page of the wizard.
型 : boolean
ユーザがウィザードの最後のページを表示しているとき、このプロパティは true になる。
pageCount
Type: integer
This property holds the number of pages in the wizard.
型 : integer
このプロパティはウィザードのページ数を保持する。
pageIndex
Type: integer
This property returns the index of the currently selected page. You can change the selected page by modifying this property.
型 : integer
このプロパティは現在選択中のページのインデックスを返す。このプロパティを変更することで、選択中のページを変更することができる。
pageStep
Type: integer
This property returns the number of pages that the user has navigated through so far, meaning that the user would press the Back button this many times to go back to the beginning. This property is different than pageIndex, because pages are not necessarily navigated in order.
型 : integer
このプロパティは、ユーザがそれまでに移動したページ数を返します。つまり、ユーザが「戻る」ボタンを押してウィザードの始めに戻る、その回数のことです。ページは必ずしも順番通りに進むわけではないので、このプロパティは pageIndex とは異なります。
rewind ( )
Return Type: no return value
Call this function to go back a page. It is equivalent to pressing the back button. The canRewind property must be set to true for the page to be changed. The code in the onwizardback attribute is called before the page is changed.
戻り値の型 : 戻り値なし
この関数を呼び出すと、1 ページ戻る。「戻る」ボタンを押すのと同じです。ページを変更するには、 canRewind プロパティが true でなければならない。ページが変わる前に onwizardback 属性のコードが呼び出される。
title
Type: string
The title that appears at the top of the wizard. This is overriden by the label attribute on the individual pages.
型 : string
ウィザードの最上部に表示されるタイトル。各ページの label 属性により上書きされる。
wizardPages
Type: DOM NodeList of wizardpage elements
This property holds the list of wizardpage elements in the wizard.
型 : DOM NodeList of wizardpage elements
このプロパティはウィザードの wizardpage 要素のリストを保持する。