net.javaprog.ui.wizard
Interface Step

All Known Implementing Classes:
AbstractStep, DefaultWizardModel.DummyStep

public interface Step

Models a simple step in a sequence of steps.

See Also:
WizardModel

Field Summary
static String BACK_PROPERTY
           
static String FINISH_PROPERTY
           
static String NEXT_PROPERTY
           
 
Method Summary
 void addPropertyChangeListener(PropertyChangeListener l)
          Adds a listener for the back, next and finish properties.
 boolean canFinish()
          Returns whether the finish action is enabled.
 boolean canGoBack()
          Returns whether the back action is enabled.
 boolean canGoNext()
          Returns whether the next action is enabled.
 JComponent getComponent()
          Returns the step's component that will be displayed in the wizard.
 String getDescription()
          Returns a descriptive string for this step that might be displayed in the StepDescriptionRenderer.
 String getName()
          Returns the step's name that might be displayed in the StepDescriptionRenderer and in the StepListRenderer.
 void prepareRendering()
          Is called just before the component will be displayed.
 void removePropertyChangeListener(PropertyChangeListener l)
          Removes a previously added listener.
 

Field Detail

BACK_PROPERTY

public static final String BACK_PROPERTY
See Also:
Constant Field Values

FINISH_PROPERTY

public static final String FINISH_PROPERTY
See Also:
Constant Field Values

NEXT_PROPERTY

public static final String NEXT_PROPERTY
See Also:
Constant Field Values
Method Detail

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener l)
Adds a listener for the back, next and finish properties.


canFinish

public boolean canFinish()
Returns whether the finish action is enabled.


canGoBack

public boolean canGoBack()
Returns whether the back action is enabled.


canGoNext

public boolean canGoNext()
Returns whether the next action is enabled.


getComponent

public JComponent getComponent()
Returns the step's component that will be displayed in the wizard. You should cache this return value in your implementation to avoid performance bottlenecks.


getDescription

public String getDescription()
Returns a descriptive string for this step that might be displayed in the StepDescriptionRenderer.


getName

public String getName()
Returns the step's name that might be displayed in the StepDescriptionRenderer and in the StepListRenderer.


prepareRendering

public void prepareRendering()
Is called just before the component will be displayed. This enables the step to adjust certain values according to the value of other steps.

See Also:
getComponent()

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener l)
Removes a previously added listener.

See Also:
addPropertyChangeListener(PropertyChangeListener)