Interface WizardStep
-
- All Known Implementing Classes:
AbstractWizardStep
,DataSourceAndQueryStep
,FormatStep
,LayoutStep
,LookAndFeelStep
public interface WizardStep
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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
createPresentationComponent(org.pentaho.ui.xul.XulDomContainer mainWizardContainer)
String
getStepName()
boolean
isFinishable()
boolean
isPreviewable()
boolean
isValid()
Checks, whether the step is currently valid.void
setBindingFactory(org.pentaho.ui.xul.binding.BindingFactory bindingFactory)
void
setBindings()
setBindings()void
setDesignTimeContext(org.pentaho.reporting.engine.classic.core.designtime.DesignTimeContext context)
void
setDocument(org.pentaho.ui.xul.dom.Document document)
void
setFinishable(boolean finishable)
setFinishable()void
setPreviewable(boolean previewable)
setPreviewable()void
stepActivating()
stepActivating()boolean
stepDeactivating()
Called on a step just before it becomes deactivated (before the new active step is shown).
-
-
-
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.
-
stepActivating
void stepActivating()
stepActivating() Called on each step just before it become active (before it's card is shown).
-
stepDeactivating
boolean stepDeactivating()
Called on a step just before it becomes deactivated (before the new active step is shown).- 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.
-
setPreviewable
void setPreviewable(boolean previewable)
setPreviewable()- Parameters:
previewable
- Sets the previewable field to the value of previewable. Determines if the "Preview" button should be enabled.
-
isPreviewable
boolean isPreviewable()
- Returns:
- a boolean the indicates if the report can be previewed at this point
-
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 WizardStep. 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
-
setDesignTimeContext
void setDesignTimeContext(org.pentaho.reporting.engine.classic.core.designtime.DesignTimeContext context)
-
-