|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WizardStepListItem
Defines the interface of an object used to represent a WizardStep for use in a WizardStepList, and for rendering a step list in the Steps pane of a rendered Wizard component.
Method Summary | |
---|---|
boolean |
canGotoStep()
Returns true if this step can be navigated to out of sequence. |
java.lang.String |
getPlaceholderText()
Returns the text that should be displayed describing this branch step. |
WizardStep |
getStep()
Return the WizardStep instance that this WizardStepListItem represents. |
java.lang.String |
getStepNumberString()
Returns the number of this step in the list of steps. |
boolean |
isBranch()
Returns true if this step is a branch step. |
boolean |
isCurrentStep()
Returns true if this step is the current step. |
boolean |
isSubstep()
Returns true if this step is a substep. |
void |
setCanGotoStep(boolean canGotoStep)
If canGotoStep is true, this step can be navigated to
out of sequence. |
void |
setCurrentStep(boolean currentStep)
If currentStep is true this WizardStepListItem represents
the current step in the step list. |
void |
setStep(WizardStep step)
Set the WizardStep instance this WizardStepListItem represents. |
Method Detail |
---|
boolean isSubstep()
boolean isBranch()
java.lang.String getPlaceholderText()
java.lang.String getStepNumberString()
boolean isCurrentStep()
void setCurrentStep(boolean currentStep)
currentStep
is true this WizardStepListItem represents
the current step in the step list. If false, it is not the current
step.
currentStep
- true if this WizardStepListItem is the current step.boolean canGotoStep()
void setCanGotoStep(boolean canGotoStep)
canGotoStep
is true, this step can be navigated to
out of sequence.
canGotoStep
- If true this step can be reached out of sequence.WizardStep getStep()
void setStep(WizardStep step)
step
- The WizardStep instance this WizardStepListItem represents.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |