ariba.ui.wizard.core
Class Wizard

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

All Implemented Interfaces:

WizardStepsParent

public class Wizard
extends Object
implements WizardStepsParent

The Wizard class represents a user's trip through a particular wizard instance. It keeps track of the current step and/or frame, which actions are enabled, etc. It also manages the event handling via the per-frame and per-wizard delegate classes provided by the application.

Field Summary

WizardAction	cancel
WizardAction	exit
WizardAction	next
WizardAction	ok
WizardAction	prev
WizardAction	refresh

Constructor Summary

Wizard(String name, Object context, AWResourceManager resourceManager)
Constructor

Wizard(String name, Object context, AWResourceManager resourceManager, String extensionDirectory)
Constructor

Method Summary

void	addAction(String name, WizardAction action) added for use by demoshell
boolean	allowsClickableSteps()
void	cleanup()
WizardAction	getActionWithName(String actionName)
Object	getAttribute(Object key)
String	getCommandBar()
Object	getContext()
WizardActionTarget	getCurrentActionTarget()
WizardFrame	getCurrentFrame()
WizardStep	getCurrentStep()
WizardDelegate	getDelegate()
WizardFrame	getExitFrame()
WizardFrame	getFrameWithName(String frameName)
String	getLabel()
String	getName()
AWPageCacheMark	getPageCacheMark()
String	getPostTocSource()
String	getPreTocSource()
WizardFrame	getSelectionsFrame()
String	getSelectionsIcon()
String	getSelectionsLabel()
List	getSteps()
WizardStep	getStepWithName(String stepName)
String	getSummarySource()
int	getVisibleTopLevelStepSize()
WizardFrame	gotoFrame(WizardFrame frame) Tells the wizard to go to a particular frame.
WizardFrame	gotoStep(WizardStep step) Tells the wizard to go to a particular step.
void	insertStepAfter(WizardStep step, WizardStep afterStep)
void	insertStepAt(WizardStep step, int index)
void	insertStepBefore(WizardStep step, WizardStep beforeStep)
WizardActionTarget	invokeAction(WizardAction action, AWRequestContext requestContext) This take place after the take values phase.
boolean	isTerminated()
void	removeStep(WizardStep step)
void	setAttribute(Object key, Object value)
void	setCommandBar(String commandBar)
void	setCurrentActionTarget(WizardActionTarget target)
void	setExitFrame(WizardFrame frame)
void	setLabel(String label)
void	setPageCacheMark(AWPageCacheMark pageCacheMark)
boolean	showSteps()
void	start()
void	updateChildrenVisible()

Methods inherited from class java.lang.Object

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

Field Detail

next

public final WizardAction next

prev

public final WizardAction prev

exit

public final WizardAction exit

ok

public final WizardAction ok

cancel

public final WizardAction cancel

refresh

public final WizardAction refresh

Constructor Detail

Wizard

public Wizard(String name,
              Object context,
              AWResourceManager resourceManager)

Constructor

Wizard

public Wizard(String name,
              Object context,
              AWResourceManager resourceManager,
              String extensionDirectory)

Constructor

Method Detail

setCommandBar

public void setCommandBar(String commandBar)

getCommandBar

public String getCommandBar()

getActionWithName

public WizardAction getActionWithName(String actionName)

addAction

public void addAction(String name,
                      WizardAction action)

added for use by demoshell

getFrameWithName

public WizardFrame getFrameWithName(String frameName)

getStepWithName

public WizardStep getStepWithName(String stepName)

getExitFrame

public WizardFrame getExitFrame()

setExitFrame

public void setExitFrame(WizardFrame frame)

getContext

public Object getContext()

getLabel

public String getLabel()

setLabel

public void setLabel(String label)

getDelegate

public WizardDelegate getDelegate()

getSummarySource

public String getSummarySource()

getPreTocSource

public String getPreTocSource()

getPostTocSource

public String getPostTocSource()

getCurrentStep

public WizardStep getCurrentStep()

getSelectionsLabel

public String getSelectionsLabel()

getSelectionsIcon

public String getSelectionsIcon()

getSelectionsFrame

public WizardFrame getSelectionsFrame()

getCurrentActionTarget

public WizardActionTarget getCurrentActionTarget()

getCurrentFrame

public WizardFrame getCurrentFrame()

setAttribute

public void setAttribute(Object key,
                         Object value)

getAttribute

public Object getAttribute(Object key)

start

public void start()

invokeAction

public WizardActionTarget invokeAction(WizardAction action,
                                       AWRequestContext requestContext)

This take place after the take values phase. So the validation result has already been stored in the current frame

gotoStep

public WizardFrame gotoStep(WizardStep step)

Tells the wizard to go to a particular step. It enforces validation. In other words, the user will be forced to stay on the current frame if there is any error.

gotoFrame

public WizardFrame gotoFrame(WizardFrame frame)

Tells the wizard to go to a particular frame. It enforces validation. In other words, the user will be forced to stay on the current frame if there is any error.

cleanup

public void cleanup()

isTerminated

public boolean isTerminated()

getSteps

public List getSteps()

Specified by:

getSteps in interface WizardStepsParent

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

updateChildrenVisible

public void updateChildrenVisible()

Specified by:

updateChildrenVisible in interface WizardStepsParent

removeStep

public void removeStep(WizardStep step)

Specified by:

removeStep in interface WizardStepsParent

getPageCacheMark

public AWPageCacheMark getPageCacheMark()

setPageCacheMark

public void setPageCacheMark(AWPageCacheMark pageCacheMark)

setCurrentActionTarget

public void setCurrentActionTarget(WizardActionTarget target)

getVisibleTopLevelStepSize

public int getVisibleTopLevelStepSize()

allowsClickableSteps

public boolean allowsClickableSteps()

showSteps

public boolean showSteps()

getName

public String getName()