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

Class AbstractWizardStep

java.lang.Object

org.pentaho.ui.xul.XulEventSourceAdapter

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

All Implemented Interfaces:

WizardStep, org.pentaho.ui.xul.XulEventSource

Direct Known Subclasses:

DataSourceAndQueryStep, FormatStep, LayoutStep, LookAndFeelStep

public abstract class AbstractWizardStep
extends org.pentaho.ui.xul.XulEventSourceAdapter
implements WizardStep

Field Summary

Fields

Modifier and Type	Field and Description
static String	FINISHABLE_PROPERTY_NAME
static String	PREVIEWABLE_PROPERTY_NAME
static String	SPACER_IMAGE_SRC
static String	STEP_CONTAINER
static String	STEP_IMAGE_SRC
static String	VALID_PROPERTY_NAME
static String	XUL_HBOX_TYPE
static String	XUL_IMAGE_TYPE
static String	XUL_LABEL_TYPE

Method Summary

Methods

Modifier and Type	Method and Description
void	createPresentationComponent(org.pentaho.ui.xul.XulDomContainer mainWizardContainer)
org.pentaho.reporting.engine.classic.core.wizard.DataAttributeContext	getAttributeContext()
org.pentaho.ui.xul.binding.BindingFactory	getBindingFactory()
org.pentaho.reporting.engine.classic.core.designtime.DesignTimeContext	getDesignTimeContext()
org.pentaho.ui.xul.dom.Document	getDocument()
WizardEditorModel	getEditorModel()
boolean	isFinishable()
boolean	isPreviewable()
boolean	isValid() Checks, whether the step is currently valid.
void	setBindingFactory(org.pentaho.ui.xul.binding.BindingFactory bf)
void	setDesignTimeContext(org.pentaho.reporting.engine.classic.core.designtime.DesignTimeContext designTimeContext)
void	setDocument(org.pentaho.ui.xul.dom.Document document)
void	setEditorModel(WizardEditorModel editorModel)
void	setFinishable(boolean finishable) setFinishable()
void	setPreviewable(boolean previewable) setPreviewable()
void	stepActivating() stepActivating() Called on each step just before it become active (before it's card is shown).
boolean	stepDeactivating() Called on a step just before it becomes deactivated (before the new active step is shown).

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

Methods inherited from interface org.pentaho.reporting.engine.classic.wizard.ui.xul.components.WizardStep

getStepName, setBindings

Field Detail

VALID_PROPERTY_NAME

public static final String VALID_PROPERTY_NAME

See Also:

Constant Field Values

PREVIEWABLE_PROPERTY_NAME

public static final String PREVIEWABLE_PROPERTY_NAME

See Also:

Constant Field Values

FINISHABLE_PROPERTY_NAME

public static final String FINISHABLE_PROPERTY_NAME

See Also:

Constant Field Values

STEP_CONTAINER

public static final String STEP_CONTAINER

See Also:

Constant Field Values

XUL_HBOX_TYPE

public static final String XUL_HBOX_TYPE

See Also:

Constant Field Values

XUL_IMAGE_TYPE

public static final String XUL_IMAGE_TYPE

See Also:

Constant Field Values

XUL_LABEL_TYPE

public static final String XUL_LABEL_TYPE

See Also:

Constant Field Values

STEP_IMAGE_SRC

public static final String STEP_IMAGE_SRC

See Also:

Constant Field Values

SPACER_IMAGE_SRC

public static final String SPACER_IMAGE_SRC

See Also:

Constant Field Values

Method Detail

getAttributeContext

public org.pentaho.reporting.engine.classic.core.wizard.DataAttributeContext getAttributeContext()

setEditorModel

public void setEditorModel(WizardEditorModel editorModel)

getEditorModel

public WizardEditorModel getEditorModel()

isValid

public boolean isValid()

Checks, whether the step is currently valid. This returns false as soon as any of the properties changed.

Specified by:

isValid in interface WizardStep

Returns:

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

setPreviewable

public void setPreviewable(boolean previewable)

Description copied from interface: WizardStep

setPreviewable()

Specified by:

setPreviewable in interface WizardStep

Parameters:

previewable - Sets the previewable field to the value of previewable. Determines if the "Preview" button should be enabled.

isPreviewable

public boolean isPreviewable()

Specified by:

isPreviewable in interface WizardStep

Returns:

a boolean the indicates if the report can be previewed at this point

setFinishable

public void setFinishable(boolean finishable)

Description copied from interface: WizardStep

setFinishable()

Specified by:

setFinishable in interface WizardStep

Parameters:

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

isFinishable

public boolean isFinishable()

Specified by:

isFinishable in interface WizardStep

Returns:

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

setDesignTimeContext

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

Specified by:

setDesignTimeContext in interface WizardStep

getDesignTimeContext

public org.pentaho.reporting.engine.classic.core.designtime.DesignTimeContext getDesignTimeContext()

setBindingFactory

public void setBindingFactory(org.pentaho.ui.xul.binding.BindingFactory bf)

Specified by:

setBindingFactory in interface WizardStep

getBindingFactory

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

getDocument

public org.pentaho.ui.xul.dom.Document getDocument()

setDocument

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

Specified by:

setDocument in interface WizardStep

createPresentationComponent

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

Specified by:

createPresentationComponent in interface WizardStep

Throws:

org.pentaho.ui.xul.XulException

stepActivating

public void stepActivating()

Description copied from interface: WizardStep

stepActivating()

Called on each step just before it become active (before it's card is shown).

Specified by:

stepActivating in interface WizardStep

stepDeactivating

public boolean stepDeactivating()

Description copied from interface: WizardStep

Called on a step just before it becomes deactivated (before the new active step is shown).

Specified by:

stepDeactivating in interface WizardStep

Returns:

boolean indicating that this step should be allowed to become deactive