|
||||||||||
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
public class WizardStep
The WizardStep component represents a single step in a Wizard component step sequence. The components to obtain user data also known collectively as the step task, are specified as children of the WizardStep component.
Field Summary |
---|
Fields inherited from interface javax.faces.component.NamingContainer |
---|
SEPARATOR_CHAR |
Constructor Summary | |
---|---|
WizardStep()
Construct a new WizardStep . |
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.WizardStep . |
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 |
isRendered()
|
boolean |
isResults()
Set the results attribute to true when the wizard step represents the View Results page. |
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 |
setDetail(java.lang.String detail)
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. |
void |
setEventListener(WizardEventListener eventListener)
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. |
void |
setFinish(boolean finish)
Set the finish attribute to true when the wizard step represents the Finish step. |
void |
setHelp(java.lang.String help)
Descriptive text that provides detailed help to the user for this step. |
void |
setId(java.lang.String id)
The component identifier for this component. |
void |
setOnCancel(java.lang.String onCancel)
Scripting code executed when the Cancel button is clicked. |
void |
setOnClose(java.lang.String onClose)
Scripting code executed when the Close button is clicked. |
void |
setOnFinish(java.lang.String onFinish)
Scripting code executed when the Finish button is clicked. |
void |
setOnHelpTab(java.lang.String onHelpTab)
Scripting code executed when the Help tab is clicked. |
void |
setOnNext(java.lang.String onNext)
Scripting code executed when the Next button is clicked. |
void |
setOnPrevious(java.lang.String onPrevious)
Scripting code executed when the Next button is clicked. |
void |
setOnStepLink(java.lang.String onStepLink)
Scripting code executed when a Step link is clicked. |
void |
setOnStepsTab(java.lang.String onStepsTab)
Scripting code executed when the Steps tab is clicked. |
void |
setResults(boolean results)
Set the results attribute to true when the wizard step represents the View Results page. |
void |
setSummary(java.lang.String summary)
A brief description of this step, to be used in the numbered list of steps in the Steps pane. |
void |
setTitle(java.lang.String title)
A descriptive title to be displayed as the Step Title in the Step Content pane. |
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 WizardStep()
WizardStep
.
Method Detail |
---|
public java.lang.String getFamily()
com.sun.webui.jsf.WizardStep
.
getFamily
in class javax.faces.component.UIComponent
public void setId(java.lang.String id)
setId
in class javax.faces.component.UIComponentBase
public boolean isRendered()
isRendered
in class javax.faces.component.UIComponentBase
public java.lang.String getDetail()
public void setDetail(java.lang.String detail)
getDetail()
public WizardEventListener getEventListener()
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.
public void setEventListener(WizardEventListener eventListener)
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()
public boolean isFinish()
public void setFinish(boolean finish)
isFinish()
public java.lang.String getHelp()
<
and >
to create the < and > characters for HTML elements
in the help text.
public void setHelp(java.lang.String help)
<
and >
to create the < and > characters for HTML elements
in the help text.
getHelp()
public java.lang.String getOnCancel()
public void setOnCancel(java.lang.String onCancel)
getOnCancel()
public java.lang.String getOnClose()
public void setOnClose(java.lang.String onClose)
getOnClose()
public java.lang.String getOnFinish()
public void setOnFinish(java.lang.String onFinish)
getOnFinish()
public java.lang.String getOnHelpTab()
public void setOnHelpTab(java.lang.String onHelpTab)
getOnHelpTab()
public java.lang.String getOnNext()
public void setOnNext(java.lang.String onNext)
getOnNext()
public java.lang.String getOnPrevious()
public void setOnPrevious(java.lang.String onPrevious)
getOnPrevious()
public java.lang.String getOnStepLink()
public void setOnStepLink(java.lang.String onStepLink)
getOnStepLink()
public java.lang.String getOnStepsTab()
public void setOnStepsTab(java.lang.String onStepsTab)
getOnStepsTab()
public boolean isResults()
public void setResults(boolean results)
isResults()
public java.lang.String getSummary()
public void setSummary(java.lang.String summary)
getSummary()
public java.lang.String getTitle()
public void setTitle(java.lang.String title)
getTitle()
public void restoreState(javax.faces.context.FacesContext _context, java.lang.Object _state)
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class javax.faces.component.UIComponentBase
public java.lang.Object saveState(javax.faces.context.FacesContext _context)
saveState
in interface javax.faces.component.StateHolder
saveState
in class javax.faces.component.UIComponentBase
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |