|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WizardModel
Defines an interface for control a sequence of WizardStep components through a Wizard component.
A Wizard component delegates to a WizardModel instance for control and navigation through a set WizardStep instances.
Method Summary | |
---|---|
boolean |
canGotoStep(WizardStep step)
Return true if the user can navigate to this step out of seqence, else false. |
void |
complete()
Called to inform the model that no more references will be made to this model instance. |
boolean |
decode(int event,
boolean prematureRender)
Return true if processDecodes() should be called
for the current step. |
WizardStep |
getCurrentStep()
Return the step currently being preformed. |
WizardStep |
getFirstStep()
Return the first WizardStep instance of the sequence. |
WizardStep |
getNextStep(WizardStep step)
Return the WizardStep instance following the specified step. |
java.lang.String |
getPlaceholderText(WizardStep step)
Return a description of this branch step. |
WizardStep |
getPreviousStep(WizardStep step)
Return the WizardStep instance preceding the specified step. |
java.util.Iterator |
getWizardStepIterator()
Based on the current state of the Wizard, return an Iterator of the current sequence of WizardSteps. |
WizardStepList |
getWizardStepList()
Return a WizardStepList of WizardStepListItem instances. |
boolean |
handleEvent(WizardEvent event)
Handle the following WizardEvent events. |
boolean |
hasCancel(WizardStep step)
Return true if the cancel button should be rendered for this step, else false. |
boolean |
hasClose(WizardStep step)
Return true if the close button should be rendered for this step, else false. |
boolean |
hasFinish(WizardStep step)
Return true if the finish button should be rendered for this step, else false. |
boolean |
hasNext(WizardStep step)
Return true if the next button should be rendered for this step, else false. |
boolean |
hasPrevious(WizardStep step)
Return true if the previous button should be rendered for this step, else false. |
boolean |
hasStepHelp()
Return true if any of the steps have step help. |
void |
initialize(Wizard wizard)
This method is called when the wizard instance has completed assembling any child components. |
boolean |
isBranch(WizardStep step)
Return true if step is a baranching step, else false. |
boolean |
isCancelDisabled(WizardStep step)
Return true if the cancel button should be disabled for this step, else false. |
boolean |
isCloseDisabled(WizardStep step)
Return true if the close button should be disabled for this step, else false. |
boolean |
isComplete()
Return true if the wizard has completed and there are no more steps for the user to complete, else false. |
boolean |
isCurrentStep(WizardStep step)
Return true if step is the current step, else false. |
boolean |
isFinishDisabled(WizardStep step)
Return true if the finish button should be disabled for this step, else false. |
boolean |
isFinishStep(WizardStep step)
Return true if step is the finish step, else false. |
boolean |
isNextDisabled(WizardStep step)
Return true if the next button should be disabled for this step, else false. |
boolean |
isPreviousDisabled(WizardStep step)
Return true if the previous button should be disabled for this step, else false. |
boolean |
isResultsStep(WizardStep step)
Return true if step is the results step, else false. |
boolean |
isSubstep(WizardStep step)
Return true if step is a substep step, else false. |
boolean |
update(int event,
boolean prematureRender)
Return true if processUpdates() should be called
for the current step. |
boolean |
validate(int event,
boolean prematureRender)
Return true if processValidators() should be called
for the current step. |
Methods inherited from interface javax.faces.component.StateHolder |
---|
isTransient, restoreState, saveState, setTransient |
Method Detail |
---|
void initialize(Wizard wizard)
wizard
- The Wizard instance owning this model instance.boolean handleEvent(WizardEvent event)
WizardEvent
events.
java.util.Iterator getWizardStepIterator()
WizardStepList getWizardStepList()
WizardStep getFirstStep()
WizardStep getPreviousStep(WizardStep step)
step
- The step following the returned WizardStep.WizardStep getNextStep(WizardStep step)
step
- The step preceding the returned WizardStep.WizardStep getCurrentStep()
boolean hasStepHelp()
boolean isCurrentStep(WizardStep step)
step
- The step to check.boolean isFinishStep(WizardStep step)
step
- The step to check.boolean isResultsStep(WizardStep step)
step
- The step to check.boolean isBranch(WizardStep step)
getPlaceholderText
for this
step, describing the branch.
step
- The step to check.java.lang.String getPlaceholderText(WizardStep step)
step
- A branching step.boolean isSubstep(WizardStep step)
step
- The step to check.boolean canGotoStep(WizardStep step)
step
- The step to check.boolean isPreviousDisabled(WizardStep step)
step
- The step to check.boolean isNextDisabled(WizardStep step)
step
- The step to check.boolean isFinishDisabled(WizardStep step)
step
- The step to check.boolean isCancelDisabled(WizardStep step)
step
- The step to check.boolean isCloseDisabled(WizardStep step)
step
- The step to check.boolean hasPrevious(WizardStep step)
step
- The step to check.boolean hasNext(WizardStep step)
step
- The step to check.boolean hasCancel(WizardStep step)
step
- The step to check.boolean hasClose(WizardStep step)
step
- The step to check.boolean hasFinish(WizardStep step)
step
- The step to check.boolean validate(int event, boolean prematureRender)
processValidators()
should be called
for the current step. The event
argument is the event
that precipitated this validate call, one of:
event
- The event that precipitated this call.prematureRender
- Is true if rendering is occuring before
RENDER_RESPONSE phase.boolean update(int event, boolean prematureRender)
processUpdates()
should be called
for the current step. The event
argument is the event
that precipitated this update call, one of:
event
- The event that precipitated this call.prematureRender
- Is true if rendering is occuring before
RENDER_RESPONSE phase.boolean decode(int event, boolean prematureRender)
processDecodes()
should be called
for the current step. The event
argument is the event
that precipitated this decode call, one of:
event
- The event that precipitated this call.prematureRender
- Is true if rendering is occuring before
RENDER_RESPONSE phase.boolean isComplete()
void complete()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |