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. It is recommended to subclass AbstractStep instead of implementing this interface.

Author:

Michael Rudolf

See Also:

WizardModel, AbstractStep

Field Summary

static String	BACK_PROPERTY Property name that is used for PropertyChangeEvents generated when the canGoBack property is Changed.
static String	CANCEL_PROPERTY Property name that is used for PropertyChangeEvents generated when the canCancel property is Changed.
static String	FINISH_PROPERTY Property name that is used for PropertyChangeEvents generated when the canFinish property is Changed.
static String	NEXT_PROPERTY Property name that is used for PropertyChangeEvents generated when the canGoNext property is Changed.

Method Summary

void	addPropertyChangeListener(PropertyChangeListener l) Adds a listener for the back, next and finish properties.
boolean	canCancel() Returns whether the cancel action is enabled.
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

static final String BACK_PROPERTY

Property name that is used for PropertyChangeEvents generated when the canGoBack property is Changed.

See Also:

canGoBack(), Constant Field Values

NEXT_PROPERTY

static final String NEXT_PROPERTY

Property name that is used for PropertyChangeEvents generated when the canGoNext property is Changed.

See Also:

canGoNext(), Constant Field Values

FINISH_PROPERTY

static final String FINISH_PROPERTY

Property name that is used for PropertyChangeEvents generated when the canFinish property is Changed.

See Also:

canFinish(), Constant Field Values

CANCEL_PROPERTY

static final String CANCEL_PROPERTY

Property name that is used for PropertyChangeEvents generated when the canCancel property is Changed.

Since:

0.1.4

See Also:

canFinish(), Constant Field Values

Method Detail

addPropertyChangeListener

void addPropertyChangeListener(PropertyChangeListener l)

Adds a listener for the back, next and finish properties.

See Also:

removePropertyChangeListener(PropertyChangeListener)

removePropertyChangeListener

void removePropertyChangeListener(PropertyChangeListener l)

Removes a previously added listener.

See Also:

addPropertyChangeListener(PropertyChangeListener)

canGoBack

boolean canGoBack()

Returns whether the back action is enabled.

canGoNext

boolean canGoNext()

Returns whether the next action is enabled.

canFinish

boolean canFinish()

Returns whether the finish action is enabled.

canCancel

boolean canCancel()

Returns whether the cancel action is enabled.

Since:

0.1.4

prepareRendering

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()

getComponent

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.

getName

String getName()

Returns the step's name that might be displayed in the StepDescriptionRenderer and in the StepListRenderer.

getDescription

String getDescription()

Returns a descriptive string for this step that might be displayed in the StepDescriptionRenderer.