org.pietschy.wizard.pane
Class WizardPaneStep

java.lang.Object
  extended byorg.pietschy.wizard.AbstractWizardStep
      extended byorg.pietschy.wizard.pane.WizardPaneStep
All Implemented Interfaces:
WizardStep

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

public class WizardPaneStep
extends AbstractWizardStep

A simple step that can be used to decouple the step from its user interface so that the user interface can be created in a standalone class implementing WizardPane.
Particularly useful if the user interface is built using a GUI tool. For example:

    StaticModel model = new StaticModel();
    model.add(new (new WizardPaneStep(new FirstPane(), "Start", "Description"));
    model.add(...);
    ...

    Wizard wizard = new Wizard(model);
    wizard.showInFrame("My Wizard");
 

Author:
Andrea Aime

Field Summary
 
Fields inherited from interface org.pietschy.wizard.WizardStep
_ID_
 
Constructor Summary
WizardPaneStep(WizardPane pane, java.lang.String name, java.lang.String summary)
          Deprecated. Creates a new WizardPaneStep
WizardPaneStep(WizardPane pane, java.lang.String name, java.lang.String summary, javax.swing.Icon icon)
          Deprecated. Creates a new WizardPaneStep
 
Method Summary
 void applyState()
          Deprecated. This method is called whenever the user presses next while this step is active.
 java.awt.Dimension getPreferredSize()
          Deprecated. This method must return the maximum preferred size of this wizard step.
 void init(WizardModel model)
          Deprecated. Called to initialize the step.
 void prepare()
          Deprecated. Called to prepare this step to display.
 
Methods inherited from class org.pietschy.wizard.AbstractWizardStep
abortBusy, addPropertyChangeListener, addPropertyChangeListener, getIcon, getName, getSummary, getView, isBusy, isComplete, removePropertyChangeListener, removePropertyChangeListener, setBusy, setComplete, setIcon, setName, setSummary, setView
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WizardPaneStep

public WizardPaneStep(WizardPane pane,
                      java.lang.String name,
                      java.lang.String summary)
Deprecated. 
Creates a new WizardPaneStep

Parameters:
pane - - the graphical component. Should be a subclass of Component
name -
summary -

WizardPaneStep

public WizardPaneStep(WizardPane pane,
                      java.lang.String name,
                      java.lang.String summary,
                      javax.swing.Icon icon)
Deprecated. 
Creates a new WizardPaneStep

Parameters:
pane - - the graphical component. Should be a subclass of Component
name -
summary -
icon -
Method Detail

init

public void init(WizardModel model)
Deprecated. 
Description copied from class: AbstractWizardStep
Called to initialize the step. This method will be called when the wizard is first initialising.

Specified by:
init in interface WizardStep
Specified by:
init in class AbstractWizardStep
Parameters:
model - the model to which the step belongs.
See Also:
WizardStep.init(org.pietschy.wizard.WizardModel)

prepare

public void prepare()
Deprecated. 
Description copied from interface: WizardStep
Called to prepare this step to display. Subclasses 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.

See Also:
WizardStep.prepare()

applyState

public void applyState()
                throws InvalidStateException
Deprecated. 
Description copied from interface: WizardStep
This method is called whenever the user presses next while this step is active.

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 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.
See Also:
WizardStep.applyState()

getPreferredSize

public java.awt.Dimension getPreferredSize()
Deprecated. 
Description copied from interface: WizardStep
This method must return the maximum preferred size of this wizard step. This method will be called during wizard initialization to determine the correct size of the wizard. This method will be called after WizardStep.init(org.pietschy.wizard.WizardModel).

Returns:
the preferred size of this step.
See Also:
WizardStep.getPreferredSize()


Copyright © 2004 Andrew Pietsch.