org.pietschy.wizard.pane
Interface WizardPane

Deprecated. since 0.1.10. WizardStep is now an interface allowing implementation by any swing componenent. See PanelWizardStep.

public interface WizardPane

WizardPane: must be implemented by components that want to act as wizard panes in collaboration with a WizardPaneStep.

Author:

Andrea Aime

Method Summary

void	applyState() Deprecated. This method is called whenever the user presses next while this step is active.
void	init(WizardStep step, WizardModel model) Deprecated. Called to initialize the step.
void	prepare() Deprecated. Called to prepare this step to display.

Method Detail

init

void init(WizardStep step,
          WizardModel model)

Deprecated.

Called to initialize the step. This method will be called when the wizard is first initialising. You should get a reference to the WizardStep in order to call WizardStep#setComplete(boolean) when the step is filled with enough information, and a reference to the model in order to update it on applyState().

Parameters:

WizardStep - the step that uses this pane

model - the model to which the step belongs.

applyState

void applyState()
                throws InvalidStateException

Deprecated.

This method is called whenever the user presses next while this step is active.

If this method will take a long time to complete, implementors should consider executing the work and a separate thread calling WizardStep#setView()with some kind of progress indicator.

This method will only be called if WizardModel.isNextAvailable() and WizardStep.isComplete()return true.

Throws:

InvalidStateException - if an error occurs and the wizard can't progress to the next step. By default the message of this exception will be displayed to the user. If you wish to prevent this behaviour please ensure InvalidStateException.setShowUser(boolean)is called with a value of false.

prepare

void prepare()

Deprecated.

Called to prepare this step to display. Implementors should query the model and configure their view appropriately.

This method will be called whenever the step is to be displayed, regardless of whether the user pressed next or previous.