com.sun.webui.jsf.model
Interface WizardStepListItem


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

isSubstep

boolean isSubstep()
Returns true if this step is a substep.


isBranch

boolean isBranch()
Returns true if this step is a branch step.


getPlaceholderText

java.lang.String getPlaceholderText()
Returns the text that should be displayed describing this branch step.


getStepNumberString

java.lang.String getStepNumberString()
Returns the number of this step in the list of steps.


isCurrentStep

boolean isCurrentStep()
Returns true if this step is the current step.


setCurrentStep

void setCurrentStep(boolean currentStep)
If currentStep is true this WizardStepListItem represents the current step in the step list. If false, it is not the current step.

Parameters:
currentStep - true if this WizardStepListItem is the current step.

canGotoStep

boolean canGotoStep()
Returns true if this step can be navigated to out of sequence.


setCanGotoStep

void setCanGotoStep(boolean canGotoStep)
If canGotoStep is true, this step can be navigated to out of sequence.

Parameters:
canGotoStep - If true this step can be reached out of sequence.

getStep

WizardStep getStep()
Return the WizardStep instance that this WizardStepListItem represents.


setStep

void setStep(WizardStep step)
Set the WizardStep instance this WizardStepListItem represents.

Parameters:
step - The WizardStep instance this WizardStepListItem represents.


Copyright © 2008 Sun Microsystems, Inc. All Rights Reserved.