C# Class Habanero.Faces.Win.WizardControlWin

Provides the controls for a wizard, which guides users through a process one step at a time.

Inheritance: UserControlWin, IWizardControl

Show file Open project: Chillisoft/habanero.faces Class Usage Examples

Public Methods

Method	Description
Finish ( ) : void	Calls the finish method on the controller to being the completion process. If this is successful the Finished event is fired.
Next ( ) : void	Attempts to go to the next step in the wizard. If this is disallowed by the wizard controller a MessagePosted event will be fired.
Previous ( ) : void	Attempts to go to the previous step in the wizard.
Start ( ) : void	Starts the wizard by moving to the first step.
WizardControlWin ( IWizardController wizardController, IControlFactory controlFactory ) : System	Initialises the WizardControl with the IWizardController. No logic is performed other than storing the wizard controller.

Protected Methods

Method	Description
CreateButtonPanel ( ) : IPanel	Creates all the Previous Next etc Buttons and puts them on a Panel.
CreateCancelButton ( Size buttonSize ) : IButton
CreateFinishButton ( Size buttonSize ) : IButton
CreateNextButton ( Size buttonSize ) : IButton
CreatePreviousButton ( Size buttonSize ) : IButton
DoIfCanMoveOn ( System.Operation operation ) : void
FireFinished ( ) : void
FireMessagePosted ( string message ) : void
FireStepChanged ( IWizardStep wizardStep ) : void
GetButtonSize ( ) : Size
GetLayoutManager ( IPanel buttonPanel ) : FlowLayoutManager
SetButtonState ( ) : void

Private Methods

Method	Description
CancelButton_Click ( object sender, EventArgs e ) : void
FinishButton_Click ( object sender, EventArgs e ) : void
NextButton_Click ( object sender, EventArgs e ) : void
PreviousButton_Click ( object sender, EventArgs e ) : void
SetStep ( IWizardStep step ) : void

Method Details

CreateButtonPanel() protected method

Creates all the Previous Next etc Buttons and puts them on a Panel.

protected CreateButtonPanel ( ) : IPanel
return	IPanel

CreateCancelButton() protected method

protected CreateCancelButton ( Size buttonSize ) : IButton
buttonSize	System.Drawing.Size
return	IButton

CreateFinishButton() protected method

protected CreateFinishButton ( Size buttonSize ) : IButton
buttonSize	System.Drawing.Size
return	IButton

CreateNextButton() protected method

protected CreateNextButton ( Size buttonSize ) : IButton
buttonSize	System.Drawing.Size
return	IButton

CreatePreviousButton() protected method

protected CreatePreviousButton ( Size buttonSize ) : IButton
buttonSize	System.Drawing.Size
return	IButton

DoIfCanMoveOn() protected method

protected DoIfCanMoveOn ( System.Operation operation ) : void
operation	System.Operation
return	void

Finish() public method

Calls the finish method on the controller to being the completion process. If this is successful the Finished event is fired.

public Finish ( ) : void
return	void

FireFinished() protected method

protected FireFinished ( ) : void
return	void

FireMessagePosted() protected method

protected FireMessagePosted ( string message ) : void
message	string
return	void

FireStepChanged() protected method

protected FireStepChanged ( IWizardStep wizardStep ) : void
wizardStep	IWizardStep
return	void

GetButtonSize() protected static method

protected static GetButtonSize ( ) : Size
return	System.Drawing.Size

GetLayoutManager() protected method

protected GetLayoutManager ( IPanel buttonPanel ) : FlowLayoutManager
buttonPanel	IPanel
return	Habanero.Faces.Base.FlowLayoutManager

Next() public method

Attempts to go to the next step in the wizard. If this is disallowed by the wizard controller a MessagePosted event will be fired.

public Next ( ) : void
return	void

Previous() public method

Attempts to go to the previous step in the wizard.

If the wizard is on the first step this exception will be thrown.

public Previous ( ) : void
return	void

SetButtonState() protected method

protected SetButtonState ( ) : void
return	void

Start() public method

Starts the wizard by moving to the first step.

public Start ( ) : void
return	void

WizardControlWin() public method

Initialises the WizardControl with the IWizardController. No logic is performed other than storing the wizard controller.

public WizardControlWin ( IWizardController wizardController, IControlFactory controlFactory ) : System
wizardController	IWizardController
controlFactory	IControlFactory	The control factory that this control will use to create a button
return	System