org.pentaho.platform.dataaccess.datasource.wizard.controllers
Class LinearWizardController

java.lang.Object
  extended by org.pentaho.ui.xul.XulEventSourceAdapter
      extended by org.pentaho.ui.xul.impl.AbstractXulEventHandler
          extended by org.pentaho.platform.dataaccess.datasource.wizard.controllers.LinearWizardController
All Implemented Interfaces:
IWizardController, org.pentaho.ui.xul.impl.XulEventHandler, org.pentaho.ui.xul.XulEventSource

public class LinearWizardController
extends org.pentaho.ui.xul.impl.AbstractXulEventHandler
implements IWizardController

The wizard-controler manages the navigation between the wizard-panes. All panes are organized as a list, where each panel cannot be enabled if the previous panels are not valid or enabled.

It is possible to jump back to previous steps and change values there. In some cases, this will just update the model, but in some cases this will invalidate the subsequent steps (for instance, if the query has been changed).

Author:
William Seyler

Field Summary
 
Fields inherited from interface org.pentaho.platform.dataaccess.datasource.wizard.controllers.IWizardController
ACTIVE_STEP_PROPERTY_NAME, CANCELLED_PROPERTY_NAME, FINISHABLE_PROPERTY_NAME, FINISHED_PROPERTY_NAME, PREVIEWABLE_PROPERTY_NAME, STEP_COUNT_PROPERTY_NAME
 
Constructor Summary
LinearWizardController(org.pentaho.ui.xul.binding.BindingFactory bf, DatasourceModel datasourceModel)
           
 
Method Summary
 void addStep(AbstractWizardStep step)
           
 void back()
           
 void cancel()
           
 void finish()
           
 int getActiveStep()
           
 org.pentaho.ui.xul.binding.BindingFactory getBindingFactory()
           
 String getName()
           
 IWizardStep getStep(int step)
           
 int getStepCount()
           
 void initialize()
           
 boolean isCancelled()
           
 boolean isFinished()
           
 void next()
           
 void onLoad()
           
 void overwriteDialogAccept()
           
 void overwriteDialogCancel()
           
 void registerMainXULContainer(org.pentaho.ui.xul.XulDomContainer mainWizardContainer)
           
 void removeStep(IWizardStep step)
           
 void setActiveStep(int step)
           
 void setBindingFactory(org.pentaho.ui.xul.binding.BindingFactory bf)
           
 void setCancelled(boolean canceled)
           
 void setFinished(boolean finished)
           
 void showWarningDialog()
           
 
Methods inherited from class org.pentaho.ui.xul.impl.AbstractXulEventHandler
bind, bind, getData, getXulDomContainer, setData, setName, setXulDomContainer
 
Methods inherited from class org.pentaho.ui.xul.XulEventSourceAdapter
addPropertyChangeListener, addPropertyChangeListener, removePropertyChangeListener, removePropertyChangeListener
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LinearWizardController

public LinearWizardController(org.pentaho.ui.xul.binding.BindingFactory bf,
                              DatasourceModel datasourceModel)
Method Detail

addStep

public void addStep(AbstractWizardStep step)

removeStep

public void removeStep(IWizardStep step)

getStep

public IWizardStep getStep(int step)
Specified by:
getStep in interface IWizardController

getStepCount

public int getStepCount()
Specified by:
getStepCount in interface IWizardController

setActiveStep

public void setActiveStep(int step)
Specified by:
setActiveStep in interface IWizardController

getActiveStep

public int getActiveStep()
Specified by:
getActiveStep in interface IWizardController

initialize

public void initialize()
Specified by:
initialize in interface IWizardController

cancel

public void cancel()
Specified by:
cancel in interface IWizardController

setCancelled

public void setCancelled(boolean canceled)

isCancelled

public boolean isCancelled()
Specified by:
isCancelled in interface IWizardController

finish

public void finish()
Specified by:
finish in interface IWizardController

overwriteDialogAccept

public void overwriteDialogAccept()

overwriteDialogCancel

public void overwriteDialogCancel()

isFinished

public boolean isFinished()
Specified by:
isFinished in interface IWizardController

setFinished

public void setFinished(boolean finished)

showWarningDialog

public void showWarningDialog()

next

public void next()

back

public void back()

getName

public String getName()
Specified by:
getName in interface org.pentaho.ui.xul.impl.XulEventHandler
Overrides:
getName in class org.pentaho.ui.xul.impl.AbstractXulEventHandler

onLoad

public void onLoad()

registerMainXULContainer

public void registerMainXULContainer(org.pentaho.ui.xul.XulDomContainer mainWizardContainer)
Parameters:
mainWizardContainer -

setBindingFactory

public void setBindingFactory(org.pentaho.ui.xul.binding.BindingFactory bf)
Specified by:
setBindingFactory in interface IWizardController

getBindingFactory

public org.pentaho.ui.xul.binding.BindingFactory getBindingFactory()
Specified by:
getBindingFactory in interface IWizardController