org.pentaho.platform.dataaccess.datasource.wizard.steps
Interface IWizardStep

All Known Implementing Classes:

AbstractWizardStep, PhysicalStep, StageDataStep, VisualizeStep

public interface IWizardStep

A single step in the wizard. The architecture assumes that the wizard-ui keeps synchronized with the model at all the time, so that other steps can react to changes and update their own availability. Steps *should* preserve the user input even when they temporarily enter a invalid UI state while they are not yet active.

Author:

Thomas Morgner

Method Summary

void	createPresentationComponent(org.pentaho.ui.xul.XulDomContainer mainWizardContainer)
String	getStepName()
boolean	isDisabled() isDisabled()
boolean	isFinishable()
boolean	isValid() Checks, whether the step is currently valid.
void	setBindingFactory(org.pentaho.ui.xul.binding.BindingFactory bindingFactory)
void	setBindings() setBindings() Allows concrete implementations to set their bindings for enclosed properties and Xul defined elements.
void	setDisabled(boolean disabled) setDisabled(boolean disable);
void	setDocument(org.pentaho.ui.xul.dom.Document document)
void	setFinishable(boolean finishable) setFinishable()
void	stepActivatingForward() stepActivatingForward() Called if the step that is activating is higher in the list than the current one (next).
void	stepActivatingReverse() stepActivatingReverse() Called if the step that is activatig is lower in the list than the current active one (back)
boolean	stepDeactivatingForward() Called on a step just before it becomes deactivated (before the next active step is shown) on response to moving forward in the step list (next).
boolean	stepDeactivatingReverse() Called on a step just before it become deactivated (before the next active step is shown) on response to moving backward in the step list (back)

Method Detail

setBindings

void setBindings()

setBindings() Allows concrete implementations to set their bindings for enclosed properties and Xul defined elements.

isValid

boolean isValid()

Checks, whether the step is currently valid. A step is valid, if it

Returns:

true, if the model matches the step's internal state, false otherwise.

stepActivatingForward

void stepActivatingForward()

stepActivatingForward() Called if the step that is activating is higher in the list than the current one (next).

stepActivatingReverse

void stepActivatingReverse()

stepActivatingReverse() Called if the step that is activatig is lower in the list than the current active one (back)

stepDeactivatingForward

boolean stepDeactivatingForward()

Called on a step just before it becomes deactivated (before the next active step is shown) on response to moving forward in the step list (next).

Returns:

boolean indicating that this step should be allowed to become deactive

stepDeactivatingReverse

boolean stepDeactivatingReverse()

Called on a step just before it become deactivated (before the next active step is shown) on response to moving backward in the step list (back)

Returns:

boolean indicating that this step should be allowed to become deactive

setFinishable

void setFinishable(boolean finishable)

setFinishable()

Parameters:

finishable - sets the flag that determines if the "Finish" button should be enabled for this wizard panel.

isFinishable

boolean isFinishable()

Returns:

a boolean that determines if the "Finish" button should be enabled.

createPresentationComponent

void createPresentationComponent(org.pentaho.ui.xul.XulDomContainer mainWizardContainer)
                                 throws org.pentaho.ui.xul.XulException

Parameters:

mainWizardContainer -

Throws:

org.pentaho.ui.xul.XulException - Creates the presentation layer associated with this IWizardStep. This is usually done by loading an overlay into the main_wzard_panel.xul

setBindingFactory

void setBindingFactory(org.pentaho.ui.xul.binding.BindingFactory bindingFactory)

setDocument

void setDocument(org.pentaho.ui.xul.dom.Document document)

getStepName

String getStepName()

Returns:

a string (must be localized) that describes this step

isDisabled

boolean isDisabled()

isDisabled()

Returns:

boolean that indicates if this step is active in the current linear controller If this returns false the linear wizard controller will skip this step and move to the next enabled step.

setDisabled

void setDisabled(boolean disabled)

setDisabled(boolean disable);

Parameters:

enable - boolean that indicates if this step should be enabled in the current chain Note: it is an error to call this method on a step that is currently being displayed.