com.japisoft.framework.wizard
Interface WizardStepContext

public interface WizardStepContext

Version:

1.0

Author:

(c) 2004 JAPISoft / http://www.japisoft.com

Method Summary

void	acceptNext(boolean accept) Notify the main wizard component that the next step is accessible.
void	acceptPrevious(boolean accept) Notify the main wizard component that the previous step is accessible.
WizardStep	getNextWizardStep()
WizardStep	getPreviousWizardStep()
java.lang.Object	getSharedData(java.lang.String key) Get a value.
java.lang.Object	getSharedData(java.lang.String key, java.lang.Object defaultValue) Get a value.
JWizard	getSource()
void	goTo(WizardStep step) Force the wizard to go the following step
void	setSharedData(java.lang.String key, java.lang.Object data) Store a data, this value will be available for all the wizard next step and user can retreive these values on the JWizard component

Method Detail

getSource

public JWizard getSource()

Returns:

the main component, user can access to other wizard step using the WizardStepModel

getPreviousWizardStep

public WizardStep getPreviousWizardStep()

Returns:

the previous step or null for the first wizard step

getNextWizardStep

public WizardStep getNextWizardStep()

Returns:

the next step or null for the last wizard step

goTo

public void goTo(WizardStep step)

Force the wizard to go the following step

acceptNext

public void acceptNext(boolean accept)

Notify the main wizard component that the next step is accessible. By default the next step is never accessible without calling acceptNext( true )

acceptPrevious

public void acceptPrevious(boolean accept)

Notify the main wizard component that the previous step is accessible. By default the previous step is always accessible

setSharedData

public void setSharedData(java.lang.String key,
                          java.lang.Object data)

Store a data, this value will be available for all the wizard next step and user can retreive these values on the JWizard component

getSharedData

public java.lang.Object getSharedData(java.lang.String key)

Get a value. This value has been set by previous wizard step

getSharedData

public java.lang.Object getSharedData(java.lang.String key,
                                      java.lang.Object defaultValue)

Get a value. This value has been set by previous wizard step

Parameters:

key - the Shared data key

defaultValue - the value returned if the key is unknown