com.japisoft.framework.wizard
Interface WizardStep

All Known Implementing Classes:

BasicWizardStep

public interface WizardStep

Step for a wizard. This wizard step is stored inside a WizardStepModel. It gives informations about the wizard properties and order.

Author:

(c) 2003 JAPISOFT

See Also:

JWizard

Method Summary

boolean	canStart(WizardStepContext context) Called before the wizard step is started.
javax.swing.Icon	getLargeIcon()
java.lang.String	getLongTitle()
java.lang.String	getName()
java.lang.String	getShortTitle()
javax.swing.Icon	getSmallIcon()
StepView	getStepView() This is the user interface part for the wizard step
boolean	isEnabled()
boolean	start(WizardStepContext context) Called when the wizard step is started, so the final user can interact with the view provided by the getView method
void	stop(WizardStepContext context) Called before a new wizard step is started

Method Detail

getName

public java.lang.String getName()

Returns:

a name for this wizard

getShortTitle

public java.lang.String getShortTitle()

Returns:

a short title for this wizard. This title will appear on the left part

getLongTitle

public java.lang.String getLongTitle()

Returns:

a long title for this wizard. This title will appear on the center part

getStepView

public StepView getStepView()

This is the user interface part for the wizard step

getSmallIcon

public javax.swing.Icon getSmallIcon()

Returns:

a small icon for the left part

getLargeIcon

public javax.swing.Icon getLargeIcon()

Returns:

a big icon for the center part

isEnabled

public boolean isEnabled()

Returns:

true if the wizard step is accessible

canStart

public boolean canStart(WizardStepContext context)

Called before the wizard step is started. If the step return false then the step will be canceled and the wizard will stay to the current one

Parameters:

context - The wizard step context

Returns:

true to start really the step or false to stay on the current one

start

public boolean start(WizardStepContext context)

Called when the wizard step is started, so the final user can interact with the view provided by the getView method

Parameters:

context - Information about the wizard step

Returns:

true when it accept to be started else the current wizard step will be skipped

stop

public void stop(WizardStepContext context)

Called before a new wizard step is started

Parameters:

context - Information about the wizard step