|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
com.sun.webui.jsf.component.WizardStep
com.sun.webui.jsf.component.WizardBranchSteps
public class WizardBranchSteps
The WizardBranchSteps component groups a sequence of
WizardStep
children into a conditional branch.
This component has no visual representation in the wizard step list.
If this branch is taken, they steps appear as if they were
specified as children of the Wizard
component.
Field Summary |
---|
Fields inherited from interface javax.faces.component.NamingContainer |
---|
SEPARATOR_CHAR |
Constructor Summary | |
---|---|
WizardBranchSteps()
Construct a new WizardBranchSteps . |
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.WizardBranchSteps . |
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 |
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 this branch sequence 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 |
setTaken(boolean taken)
The taken attribute is used to evaluate whether the steps of this branch sequence 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 |
---|
public WizardBranchSteps()
WizardBranchSteps
.
Method Detail |
---|
public java.lang.String getFamily()
com.sun.webui.jsf.WizardBranchSteps
.
getFamily
in class WizardStep
public void setId(java.lang.String id)
setId
in class WizardStep
public java.lang.String getDetail()
WizardStep
getDetail
in class WizardStep
public WizardEventListener getEventListener()
WizardStep
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.
getEventListener
in class WizardStep
public boolean isFinish()
WizardStep
isFinish
in class WizardStep
public java.lang.String getHelp()
WizardStep
<
and >
to create the < and > characters for HTML elements
in the help text.
getHelp
in class WizardStep
public java.lang.String getOnCancel()
WizardStep
getOnCancel
in class WizardStep
public java.lang.String getOnClose()
WizardStep
getOnClose
in class WizardStep
public java.lang.String getOnFinish()
WizardStep
getOnFinish
in class WizardStep
public java.lang.String getOnHelpTab()
WizardStep
getOnHelpTab
in class WizardStep
public java.lang.String getOnNext()
WizardStep
getOnNext
in class WizardStep
public java.lang.String getOnPrevious()
WizardStep
getOnPrevious
in class WizardStep
public java.lang.String getOnStepLink()
WizardStep
getOnStepLink
in class WizardStep
public java.lang.String getOnStepsTab()
WizardStep
getOnStepsTab
in class WizardStep
public boolean isResults()
WizardStep
isResults
in class WizardStep
public java.lang.String getSummary()
WizardStep
getSummary
in class WizardStep
public java.lang.String getTitle()
WizardStep
getTitle
in class WizardStep
public boolean isTaken()
webuijsf:wizardStep
tags within this webuijsf:wizardBranchSteps
tag are
rendered. The taken attribute should be
a JavaServer Faces EL expression that uses the user's response in
a previous step to determine whether the branch sequence should be
rendered.
public void setTaken(boolean taken)
webuijsf:wizardStep
tags within this webuijsf:wizardBranchSteps
tag are
rendered. The taken attribute should be
a JavaServer Faces EL expression that uses the user's response in
a previous step to determine whether the branch sequence should be
rendered.
isTaken()
public void restoreState(javax.faces.context.FacesContext _context, java.lang.Object _state)
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class WizardStep
public java.lang.Object saveState(javax.faces.context.FacesContext _context)
saveState
in interface javax.faces.component.StateHolder
saveState
in class WizardStep
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |