ariba.ui.wizard.core
Class WizardStep

java.lang.Object
  ariba.ui.wizard.core.WizardStep

All Implemented Interfaces:

WizardStepsParent

public final class WizardStep
extends java.lang.Object
implements WizardStepsParent

A WizardStep represents the runtime state of a particular step in a wizard flow. It reflects both the immutable meta-data specified in the XML or given by the application, as well as the dynamic state of the step for a particular trip through the wizard.

Constructor Summary

WizardStep(Wizard wizard, java.lang.String name, java.lang.String label)

WizardStep(Wizard wizard, java.lang.String name, java.lang.String label, WizardStep parent)

Method Summary

WizardFrame	getFrame()
java.lang.String	getLabel()
java.lang.String	getName()
WizardStep	getNextSibling()
WizardStep	getNextVisibleSibling()
WizardStepsParent	getParent()
WizardStep	getPreviousSibling()
WizardStep	getPreviousVisibleSibling()
java.util.List	getSteps()
Wizard	getWizard()
boolean	hasBeenVisited()
int	index()
void	insertStepAfter(WizardStep step, WizardStep afterStep)
void	insertStepAt(WizardStep step, int index)
void	insertStepBefore(WizardStep step, WizardStep beforeStep)
boolean	isNumbered()
boolean	isTopLevelStep()
boolean	isVisible()
WizardStepMeta	meta()
void	removeAllSteps() Removes all the substeps contained by the step
void	removeStep(WizardStep step)
void	setFrame(WizardFrame frame) Sets the frame that is directly contained by this step. If the step already contains a frame, it will be replace by the given frame.
void	setHasBeenVisited(boolean hasBeenVisited)
void	setLabel(java.lang.String localizedLabel) Overrides the default label for the wizard step
void	setVisible(boolean visible)
void	updateChildrenVisible()

Methods inherited from class java.lang.Object

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

Constructor Detail

WizardStep

public WizardStep(Wizard wizard,
                  java.lang.String name,
                  java.lang.String label)

WizardStep

public WizardStep(Wizard wizard,
                  java.lang.String name,
                  java.lang.String label,
                  WizardStep parent)

Method Detail

getName

public java.lang.String getName()

getWizard

public Wizard getWizard()

getLabel

public java.lang.String getLabel()

setLabel

public void setLabel(java.lang.String localizedLabel)

Overrides the default label for the wizard step

Parameters:

localizedLabel - localized string to use as label for wizard step

isNumbered

public boolean isNumbered()

getFrame

public WizardFrame getFrame()

setFrame

public void setFrame(WizardFrame frame)

Sets the frame that is directly contained by this step.
If the step already contains a frame, it will be replace by the given frame. The old frame will be a dialog frame with no containing step and can be obtained by calling Wizard.getFrameWithName().
If the parameter is null, the current frame will be removed from the step the step will be left with no frame. It is the responsiblity of the application to ensure that there is at least one visible frame under each top level step, either contained directly by the step or one of the substeps. If not, the step should be remove or runtime exception will be thrown.

removeAllSteps

public void removeAllSteps()

Removes all the substeps contained by the step

getSteps

public java.util.List getSteps()

Specified by:

getSteps in interface WizardStepsParent

getParent

public WizardStepsParent getParent()

insertStepBefore

public void insertStepBefore(WizardStep step,
                             WizardStep beforeStep)

Specified by:

insertStepBefore in interface WizardStepsParent

insertStepAfter

public void insertStepAfter(WizardStep step,
                            WizardStep afterStep)

Specified by:

insertStepAfter in interface WizardStepsParent

insertStepAt

public void insertStepAt(WizardStep step,
                         int index)

Specified by:

insertStepAt in interface WizardStepsParent

removeStep

public void removeStep(WizardStep step)

Specified by:

removeStep in interface WizardStepsParent

isVisible

public boolean isVisible()

setVisible

public void setVisible(boolean visible)

updateChildrenVisible

public void updateChildrenVisible()

Specified by:

updateChildrenVisible in interface WizardStepsParent

hasBeenVisited

public boolean hasBeenVisited()

setHasBeenVisited

public void setHasBeenVisited(boolean hasBeenVisited)

getNextVisibleSibling

public WizardStep getNextVisibleSibling()

getNextSibling

public WizardStep getNextSibling()

index

public int index()

getPreviousVisibleSibling

public WizardStep getPreviousVisibleSibling()

getPreviousSibling

public WizardStep getPreviousSibling()

meta

public WizardStepMeta meta()

isTopLevelStep

public boolean isTopLevelStep()