Package org.pentaho.reporting.engine.classic.wizard.ui.xul.components

Class LinearWizardController

java.lang.Object

org.pentaho.ui.xul.XulEventSourceAdapter

org.pentaho.ui.xul.impl.AbstractXulEventHandler

org.pentaho.reporting.engine.classic.wizard.ui.xul.components.LinearWizardController

All Implemented Interfaces:

WizardController, org.pentaho.ui.xul.impl.XulEventHandler, org.pentaho.ui.xul.XulEventSource

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

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 class org.pentaho.ui.xul.impl.AbstractXulEventHandler

document, name, xulDomContainer

Fields inherited from class org.pentaho.ui.xul.XulEventSourceAdapter

changeSupport

Fields inherited from interface org.pentaho.reporting.engine.classic.wizard.ui.xul.components.WizardController

ACTIVE_STEP_PROPERTY_NAME, CANCELLED_PROPERTY_NAME, FINISHABLE_PROPERTY_NAME, FINISHED_PROPERTY_NAME, PREVIEWABLE_PROPERTY_NAME, STEP_COUNT_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
LinearWizardController(WizardEditorModel editorModel, org.pentaho.ui.xul.binding.BindingFactory bf)

Method Summary

Modifier and Type	Method	Description
void	addStep(AbstractWizardStep step)
void	back()
void	cancel()
void	finish()
int	getActiveStep()
org.pentaho.ui.xul.binding.BindingFactory	getBindingFactory()
WizardEditorModel	getEditorModel()
String	getName()
WizardStep	getStep(int step)
int	getStepCount()
void	initialize()
boolean	isCancelled()
boolean	isFinished()
void	next()
void	onLoad()
void	preview()
void	registerMainXULContainer(org.pentaho.ui.xul.XulDomContainer mainWizardContainer)
void	removeStep(WizardStep step)
void	setActiveStep(int step)
void	setBindingFactory(org.pentaho.ui.xul.binding.BindingFactory bf)
void	setCancelled(boolean canceled)
void	setDesignTimeContext(org.pentaho.reporting.engine.classic.core.designtime.DesignTimeContext designTimeContext)
void	setFinished(boolean finished)
protected void	updateBindings()

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, firePropertyChange, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LinearWizardController

public LinearWizardController(WizardEditorModel editorModel,
                              org.pentaho.ui.xul.binding.BindingFactory bf)

Method Detail

setDesignTimeContext

public void setDesignTimeContext(org.pentaho.reporting.engine.classic.core.designtime.DesignTimeContext designTimeContext)

Specified by:

setDesignTimeContext in interface WizardController

Parameters:

designTimeContext -

getEditorModel

public WizardEditorModel getEditorModel()

addStep

public void addStep(AbstractWizardStep step)

removeStep

public void removeStep(WizardStep step)

getStep

public WizardStep getStep(int step)

Specified by:

getStep in interface WizardController

getStepCount

public int getStepCount()

Specified by:

getStepCount in interface WizardController

setActiveStep

public void setActiveStep(int step)

Specified by:

setActiveStep in interface WizardController

getActiveStep

public int getActiveStep()

Specified by:

getActiveStep in interface WizardController

initialize

public void initialize()

Specified by:

initialize in interface WizardController

updateBindings

protected void updateBindings()

cancel

public void cancel()

Specified by:

cancel in interface WizardController

setCancelled

public void setCancelled(boolean canceled)

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface WizardController

finish

public void finish()

Specified by:

finish in interface WizardController

isFinished

public boolean isFinished()

Specified by:

isFinished in interface WizardController

setFinished

public void setFinished(boolean finished)

next

public void next()

back

public void back()

preview

public void preview()

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 WizardController

getBindingFactory

public org.pentaho.ui.xul.binding.BindingFactory getBindingFactory()

Specified by:

getBindingFactory in interface WizardController