BiWizardPane

This component creates a wizard that can contain 1 or more pages. The wizard pane provides buttons for navigating back and forth and finishing and canceling the wizard.

Any BiComponent may be used as a page. Use addPage to add pages to the wizard. The pages dispatch activated and deactivated when the active page changes. You can also use the change event to get notifications about when the user changes the active page.

This class extends BiComponent and therefore all methods and fields available for BiComponent are also available for BiWizardPane .

Constructor

new BiWizardPane ( )

Parameters

No parameters.

Properties

Name	Type	get	set	Descripton
backButton	BiButton			Returns the back button of the wizard.
cancelButton	BiButton			Returns the cancel button of the wizard.
finishButton	BiButton			Returns the finish button of the wizard.
nextButton	BiButton			Returns the next button of the wizard.
pages	BiComponent[]			Returns all the pages currently in the wizard.
selectedIndex	Number			The index of the selected page. If no page is selected this returns -1.
selectedPage	BiComponent			The currently selected page.
stringBundle	BiStringBundle			The string bundle to use for this wizard pane. If this is set to null then the string bundle for application is used.

Methods

Name	Description
addPage	This adds a page to the wizard pane.
back	Goes to the previous page.
cancel	This is called when the user presses the cancel button.
finish	This is called when the user presses the finish button.
next	Goes to the next page.
removePage	This removes a page from the wizard pane.

Events

Name	Type	Bubbles	Descripton
back	BiEvent		Fires when the selectedPage changes to the previous page.
beforeback	BiEvent		Fires before the selectedPage changes to the previous page. Call preventDefault on the event object to prevent the wizard pane to change the page.
beforecancel	BiEvent		Fires before the the wizard pane's cancel event is called. Calling preventDefault on the event object will prevent the wizard pane from dispatching the cancel event.
beforechange	BiEvent		Fires before the selectedPage page changes. Call preventDefault on the event object to prevent the wizard pane to change the page.
beforefinish	BiEvent		Fires before the the wizard pane's finish event is called. Calling preventDefault on the event object will prevent the wizard pane from dispatching the finish event.
beforenext	BiEvent		Fires before the selectedPage changes to the next page. Call preventDefault on the event object to prevent the wizard pane to change the page.
cancel	BiEvent		This event is dispatched when the user clicks the cancel button.
change	BiEvent		Fires when the selectedPage page changes.
finish	BiEvent		This event is dispatched when the user clicks the finish button.
next	BiEvent		Fires when the selectedPage changes to the next page.

Static Methods

None.

Static Fields

None.

Remarks

The wizard pane fires an event called deactivated on the page before moving away from that page. If the default action for this event is prevented the wizard stays at the current page. This is similar to the beforechange except that this is fired on the page instead of on the wizard pane The wizard pane also fires an event called activated on the page after the wizard pane has navigated to the page. The labels for the buttons are provided by a BiStringBundle and the following keys are used: WizardPaneBack - Text for back button WizardPaneNext - Text for next button WizardPaneFinish - Text for finish button WizardPaneCancel - Text for cancel button WizardPaneBackMnemonic - Mnemonic for back button WizardPaneNextMnemonic - Mnemonic for next button WizardPaneBackAccessKey - Access key for back button WizardPaneNextAccessKey - Access key for next button

Method Details

addPage

This adds a page to the wizard pane.

Syntax

object.addPage ( oPage,oBefore )

Parameters

Name	Type	Optional	Default	Descripton
oPage	BiComponent			The page to add
oBefore	BiComponent			Optional and if provided the new page will be added before this one.

Return Type

void

back

Goes to the previous page.

Syntax

object.back ( )

Parameters

No arguments.

Return Type

void

cancel

This is called when the user presses the cancel button.

Syntax

object.cancel ( )

Parameters

No arguments.

Return Type

void

finish

This is called when the user presses the finish button.

Syntax

object.finish ( )

Parameters

No arguments.

Return Type

void

next

Goes to the next page.

Syntax

object.next ( )

Parameters

No arguments.

Return Type

void

removePage

This removes a page from the wizard pane.

Syntax

object.removePage ( oPage )

Parameters

Name	Type	Optional	Default	Descripton
oPage	BiComponent			The page to remove.

Return Type

BiComponent