Java Doc for PanelWizardStep.java in  » Swing-Library » wizard-framework » org » pietschy » wizard » Java Source Code / Java DocumentationJava Source Code and Java Documentation

The Wizard listens to property change events from the step and will update accordingly when ever PanelWizardStep.setComplete or PanelWizardStep.setBusy is called.

An example is shown below.

 public class MyWizardStep
 extends PanelWizardStep
 {
 private MyModel model;
 private JCheckBox agreeCheckbox;
 private JTextArea license;
 public MyWizardStep()
 {
 super("My First Step", "A summary of the first step");
 // build and layout the components..
 agreeCheckbox = new JCheckBox("Agree");
 license = new JTextArea();
 setLayout(...);
 add(agreeCheckbox);
 ...
 // listen to changes in the state..
 agreeCheckbox.addItemListener(new ItemListener()
 {
 public void itemSelected(ItemEvent e)
 {
 // only continue if they agree
 MyWizardStep.this.setComplete(agreeCheckbox.isSelected());
 }
 });
 }
 public void init(WizardModel model)
 {
 this.model = (MyModel) model;
 }
 public void prepare()
 {
 // read the model and configure the panel
 }
 public void applyState()
 throws InvalidStateException
 {
 // load a progress bar of some kind..
 ...
 setBusy(true);
 try
 {
 // do some work on another thread.. see Foxtrot
 ...
 }
 finally
 {
 setBusy(false);
 }
 // if error then throw an exception
 if (!ok)
 {
 // restore our original view..
 ......
 throw new InvalidStateException("That didn't work!");
 }
 // this isn't really meaningful as we refuse to continue
 // while the checkbox is un-checked.
 model.setAcceptsLicense(agreeCheckbox.isSelected());
 }
 public void getPreferredSize()
 {
 // use the size of our main view...
 return mainView.getPreferredSize();
 }
 }
 

If this method will take a long time to complete, subclasses should consider executing the work and a separate thread and displaying some kind of progress indicator.

This method will only be called if WizardModel.isNextAvailable and PanelWizardStep.isComplete return true.
throws:
  InvalidStateException - if an error occurs and the wizard can't progress to the nextstep.

If this method will take a long time to complete, subclasses should consider executing the work and a separate thread and displaying some kind of progress indicator.

This method will only be called if WizardModel.isNextAvailable and PanelWizardStep.isComplete return true.
throws:
  InvalidStateException - if an error occurs and the wizard can't progress to the nextstep. By default the message of this exception will be displayed to the user. If you wish toprevent this behaviour please ensure InvalidStateException.setShowUser is called witha value of false.

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

Wizard steps that go into a busy state must also implement PanelWizardStep.abortBusy to cancel any inprogress operation.
Parameters:
  busy - true to mark the step as busy and disable further user action, falseto return the wizard to its normal state.