com.sun.webui.jsf.component
Class WizardStep

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

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

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

WizardStep

public WizardStep()
Construct a new WizardStep.

Method Detail

getFamily

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

Specified by:
getFamily in class javax.faces.component.UIComponent

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 javax.faces.component.UIComponentBase

isRendered

public boolean isRendered()
Overrides:
isRendered in class javax.faces.component.UIComponentBase

getDetail

public 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. Typically you would provide one or two sentences that describe what the step does, or tell the user how to interact with the step.


setDetail

public 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. Typically you would provide one or two sentences that describe what the step does, or tell the user how to interact with the step.

See Also:
getDetail()

getEventListener

public 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. 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.


setEventListener

public 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. 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.

See Also:
getEventListener()

isFinish

public boolean isFinish()
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.


setFinish

public void setFinish(boolean finish)
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.

See Also:
isFinish()

getHelp

public java.lang.String getHelp()
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.


setHelp

public void setHelp(java.lang.String help)
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.

See Also:
getHelp()

getOnCancel

public java.lang.String getOnCancel()
Scripting code executed when the Cancel button is clicked.


setOnCancel

public void setOnCancel(java.lang.String onCancel)
Scripting code executed when the Cancel button is clicked.

See Also:
getOnCancel()

getOnClose

public java.lang.String getOnClose()
Scripting code executed when the Close button is clicked.


setOnClose

public void setOnClose(java.lang.String onClose)
Scripting code executed when the Close button is clicked.

See Also:
getOnClose()

getOnFinish

public java.lang.String getOnFinish()
Scripting code executed when the Finish button is clicked.


setOnFinish

public void setOnFinish(java.lang.String onFinish)
Scripting code executed when the Finish button is clicked.

See Also:
getOnFinish()

getOnHelpTab

public java.lang.String getOnHelpTab()
Scripting code executed when the Help tab is clicked.


setOnHelpTab

public void setOnHelpTab(java.lang.String onHelpTab)
Scripting code executed when the Help tab is clicked.

See Also:
getOnHelpTab()

getOnNext

public java.lang.String getOnNext()
Scripting code executed when the Next button is clicked.


setOnNext

public void setOnNext(java.lang.String onNext)
Scripting code executed when the Next button is clicked.

See Also:
getOnNext()

getOnPrevious

public java.lang.String getOnPrevious()
Scripting code executed when the Next button is clicked.


setOnPrevious

public void setOnPrevious(java.lang.String onPrevious)
Scripting code executed when the Next button is clicked.

See Also:
getOnPrevious()

getOnStepLink

public java.lang.String getOnStepLink()
Scripting code executed when a Step link is clicked.


setOnStepLink

public void setOnStepLink(java.lang.String onStepLink)
Scripting code executed when a Step link is clicked.

See Also:
getOnStepLink()

getOnStepsTab

public java.lang.String getOnStepsTab()
Scripting code executed when the Steps tab is clicked.


setOnStepsTab

public void setOnStepsTab(java.lang.String onStepsTab)
Scripting code executed when the Steps tab is clicked.

See Also:
getOnStepsTab()

isResults

public boolean isResults()
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.


setResults

public void setResults(boolean results)
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.

See Also:
isResults()

getSummary

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


setSummary

public 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.

See Also:
getSummary()

getTitle

public java.lang.String getTitle()
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.


setTitle

public void setTitle(java.lang.String title)
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.

See Also:
getTitle()

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 javax.faces.component.UIComponentBase

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 javax.faces.component.UIComponentBase


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