com.sun.webui.jsf.component
Class WizardBranch

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by com.sun.webui.jsf.component.WizardStep
              extended by com.sun.webui.jsf.component.WizardBranch
All Implemented Interfaces:
javax.faces.component.NamingContainer, javax.faces.component.StateHolder

public class WizardBranch
extends WizardStep
implements javax.faces.component.NamingContainer


Field Summary
 
Fields inherited from interface javax.faces.component.NamingContainer
SEPARATOR_CHAR
 
Constructor Summary
WizardBranch()
          Construct a new WizardBranchBase.
 
Method Summary
 java.lang.String getDetail()
          The detail attribute supplies the text that is to be displayed in the Step Instructions area, before the input components of the Step Content pane.
 WizardEventListener getEventListener()
          The eventListener attribute is used to specify an object to handle an event that is triggered when a user activates a component in the step.
 java.lang.String getFamily()
          Return the family for this component, com.sun.webui.jsf.WizardBranch.
 java.lang.String getHelp()
          Descriptive text that provides detailed help to the user for this step.
 java.lang.String getOnCancel()
          Scripting code executed when the Cancel button is clicked.
 java.lang.String getOnClose()
          Scripting code executed when the Close button is clicked.
 java.lang.String getOnFinish()
          Scripting code executed when the Finish button is clicked.
 java.lang.String getOnHelpTab()
          Scripting code executed when the Help tab is clicked.
 java.lang.String getOnNext()
          Scripting code executed when the Next button is clicked.
 java.lang.String getOnPrevious()
          Scripting code executed when the Next button is clicked.
 java.lang.String getOnStepLink()
          Scripting code executed when a Step link is clicked.
 java.lang.String getOnStepsTab()
          Scripting code executed when the Steps tab is clicked.
 java.lang.String getPlaceholderText()
          Text that describes to users what happens when they make a selection in the step that sets up the branch.
 java.lang.String getSummary()
          A brief description of this step, to be used in the numbered list of steps in the Steps pane.
 java.lang.String getTitle()
          A descriptive title to be displayed as the Step Title in the Step Content pane.
 boolean isFinish()
          Set the finish attribute to true when the wizard step represents the Finish step.
 boolean isResults()
          Set the results attribute to true when the wizard step represents the View Results page.
 boolean isTaken()
          The taken attribute is used to evaluate whether the steps of the branch are displayed.
 void restoreState(javax.faces.context.FacesContext _context, java.lang.Object _state)
          Restore the state of this component.
 java.lang.Object saveState(javax.faces.context.FacesContext _context)
          Save the state of this component.
 void setId(java.lang.String id)
          The component identifier for this component.
 void setPlaceholderText(java.lang.String placeholderText)
          Text that describes to users what happens when they make a selection in the step that sets up the branch.
 void setTaken(boolean taken)
          The taken attribute is used to evaluate whether the steps of the branch are displayed.
 
Methods inherited from class com.sun.webui.jsf.component.WizardStep
isRendered, setDetail, setEventListener, setFinish, setHelp, setOnCancel, setOnClose, setOnFinish, setOnHelpTab, setOnNext, setOnPrevious, setOnStepLink, setOnStepsTab, setResults, setSummary, setTitle
 
Methods inherited from class javax.faces.component.UIComponentBase
broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnComponent, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, restoreAttachedState, saveAttachedState, setParent, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getContainerClientId
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WizardBranch

public WizardBranch()
Construct a new WizardBranchBase.

Method Detail

getFamily

public java.lang.String getFamily()
Return the family for this component, com.sun.webui.jsf.WizardBranch.

Overrides:
getFamily in class WizardStep

setId

public void setId(java.lang.String id)
The component identifier for this component. This value must be unique within the closest parent component that is a naming container.

Overrides:
setId in class WizardStep

getDetail

public java.lang.String getDetail()
Description copied from class: WizardStep
The detail attribute supplies the text that is to be displayed in the Step Instructions area, before the input components of the Step Content pane. Typically you would provide one or two sentences that describe what the step does, or tell the user how to interact with the step.

Overrides:
getDetail in class WizardStep

getEventListener

public WizardEventListener getEventListener()
Description copied from class: WizardStep
The eventListener attribute is used to specify an object to handle an event that is triggered when a user activates a component in the step. The eventListener attribute value must be a JavaServer Faces EL expression that resolves to an instance of com.sun.webui.jsf.event.WizardEventListener.

The return value of the wizard component's call to the event listener's handleEvent() method controls the processing of the current step, and determines whether the next step or a previous step, etc. can be navigated to.

See the Event Listeners section in the webuijsf:wizard tag documentation for more information.

Overrides:
getEventListener in class WizardStep

isFinish

public boolean isFinish()
Description copied from class: WizardStep
Set the finish attribute to true when the wizard step represents the Finish step. For wizards with three or more steps, the Finish step should be the Review Selections page. The finish attribute causes the Finish button to be displayed. The Finish step performs the wizard task when the user clicks the Finish button.

Overrides:
isFinish in class WizardStep

getHelp

public java.lang.String getHelp()
Description copied from class: WizardStep
Descriptive text that provides detailed help to the user for this step. The amount of text specified is unlimited but is typically only a few short paragraphs. The content can contain HTML markup for formatting. Note that you must use the character entity references &lt; and &gt; to create the < and > characters for HTML elements in the help text.

Overrides:
getHelp in class WizardStep

getOnCancel

public java.lang.String getOnCancel()
Description copied from class: WizardStep
Scripting code executed when the Cancel button is clicked.

Overrides:
getOnCancel in class WizardStep

getOnClose

public java.lang.String getOnClose()
Description copied from class: WizardStep
Scripting code executed when the Close button is clicked.

Overrides:
getOnClose in class WizardStep

getOnFinish

public java.lang.String getOnFinish()
Description copied from class: WizardStep
Scripting code executed when the Finish button is clicked.

Overrides:
getOnFinish in class WizardStep

getOnHelpTab

public java.lang.String getOnHelpTab()
Description copied from class: WizardStep
Scripting code executed when the Help tab is clicked.

Overrides:
getOnHelpTab in class WizardStep

getOnNext

public java.lang.String getOnNext()
Description copied from class: WizardStep
Scripting code executed when the Next button is clicked.

Overrides:
getOnNext in class WizardStep

getOnPrevious

public java.lang.String getOnPrevious()
Description copied from class: WizardStep
Scripting code executed when the Next button is clicked.

Overrides:
getOnPrevious in class WizardStep

getOnStepLink

public java.lang.String getOnStepLink()
Description copied from class: WizardStep
Scripting code executed when a Step link is clicked.

Overrides:
getOnStepLink in class WizardStep

getOnStepsTab

public java.lang.String getOnStepsTab()
Description copied from class: WizardStep
Scripting code executed when the Steps tab is clicked.

Overrides:
getOnStepsTab in class WizardStep

isResults

public boolean isResults()
Description copied from class: WizardStep
Set the results attribute to true when the wizard step represents the View Results page. This page should be used after the wizard task is completed, to display information related to the task, including failure information if appropriate. This attribute causes the Close button to be displayed on the View Results page.

Overrides:
isResults in class WizardStep

getSummary

public java.lang.String getSummary()
Description copied from class: WizardStep
A brief description of this step, to be used in the numbered list of steps in the Steps pane.

Overrides:
getSummary in class WizardStep

getTitle

public java.lang.String getTitle()
Description copied from class: WizardStep
A descriptive title to be displayed as the Step Title in the Step Content pane. The Step Title consists of the step number followed by the value of the title attribute. The value of the title attribute could be the same as the value of the summary attribute, or could provide a more detailed description.

Overrides:
getTitle in class WizardStep

getPlaceholderText

public java.lang.String getPlaceholderText()
Text that describes to users what happens when they make a selection in the step that sets up the branch. This text is displayed in the Steps pane when that step is initially displayed, before the user proceeds through the step.


setPlaceholderText

public void setPlaceholderText(java.lang.String placeholderText)
Text that describes to users what happens when they make a selection in the step that sets up the branch. This text is displayed in the Steps pane when that step is initially displayed, before the user proceeds through the step.

See Also:
getPlaceholderText()

isTaken

public boolean isTaken()
The taken attribute is used to evaluate whether the steps of the branch are displayed. If taken is true, the branch is followed, and the child webuijsf:wizardBranchSteps tags are evaluated. The taken attribute should be a JavaServer Faces EL expression that could use the user's response in a previous step to determine whether the branch should be followed.


setTaken

public void setTaken(boolean taken)
The taken attribute is used to evaluate whether the steps of the branch are displayed. If taken is true, the branch is followed, and the child webuijsf:wizardBranchSteps tags are evaluated. The taken attribute should be a JavaServer Faces EL expression that could use the user's response in a previous step to determine whether the branch should be followed.

See Also:
isTaken()

restoreState

public void restoreState(javax.faces.context.FacesContext _context,
                         java.lang.Object _state)
Restore the state of this component.

Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class WizardStep

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext _context)
Save the state of this component.

Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class WizardStep


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