|
||||||||||
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.Wizard
public class Wizard
Field Summary |
---|
Fields inherited from interface javax.faces.component.NamingContainer |
---|
SEPARATOR_CHAR |
Constructor Summary | |
---|---|
Wizard()
Construct a Wizard instance. |
Method Summary | |
---|---|
void |
broadcast(javax.faces.event.FacesEvent facesEvent)
This method broadcasts a WizardEvent event that is queued as a result
of an immediate ActionEvent from one of the wizard's
navigation components. |
void |
broadcastEvent(javax.faces.component.UIComponent source,
int event)
Called from WizardActionListener
to establish the event state of the wizard. |
void |
decode(javax.faces.context.FacesContext context)
Called by processDecodes
during APPLY_REQUEST_VALUES phase. |
void |
encodeBegin(javax.faces.context.FacesContext context)
Begin the rendering of the wizard. |
void |
encodeChildren(javax.faces.context.FacesContext context)
Begin the rendering of the wizard child components. |
void |
encodeEnd(javax.faces.context.FacesContext context)
Complete the rendering of the wizard. |
javax.faces.component.UIComponent |
getCancelComponent()
Return the UIComponent that will be used for the
Cancel button. |
javax.faces.component.UIComponent |
getCloseComponent()
Return the UIComponent that will be used for the Close
button. |
javax.faces.component.UIComponent |
getControlBarComponent()
Return a component that represents the control bar or navigation controls, rendered after the step's components. |
WizardStep |
getCurrentStep()
Return the step currently being performed. |
java.lang.String |
getCurrentStepNumberString()
Return the number of the current Step, to be used in a steps list. |
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 wizard. |
java.lang.String |
getFamily()
Return the family for this component, com.sun.webui.jsf.Wizard . |
javax.faces.component.UIComponent |
getFinishComponent()
Return the UIComponent that will be used for the
Finish button. |
javax.faces.component.UIComponent |
getLeftControlBarComponent()
Return a component that is rendered for the controls justified to the left below the step's components. |
WizardModel |
getModel()
Overrides WizardModel instance. |
javax.faces.component.UIComponent |
getNextComponent()
Return the UIComponent that will be used for the Next
button. |
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 |
getOnPopupDismiss()
Scripting code that is invoked when the wizard popup is dismissed. |
java.lang.String |
getOnPrevious()
Scripting code executed when the Previous 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. |
javax.faces.component.UIComponent |
getPreviousComponent()
Return the UIComponent that will be used for the
Previous button. |
javax.faces.component.UIComponent |
getRightControlBarComponent()
Return a component that is rendered for the controls justified to the right, below the step's components. |
javax.faces.component.UIComponent |
getStepDetailComponent()
Return a component that represents the step detail or step instruction, rendered below the step title. |
javax.faces.component.UIComponent |
getStepDetailTextComponent()
Return the component to render the step detail text. |
javax.faces.component.UIComponent |
getStepHelpComponent()
Return a component that represents the step help for the current step, rendered in the Help tab. |
javax.faces.component.UIComponent |
getStepHelpTextComponent()
Return the component to render for the step help text for the current step in the steps pane help tab. |
javax.faces.component.UIComponent |
getStepIndicatorComponent()
Return a component that implements the current step indicator icon. |
javax.faces.component.UIComponent |
getSteplinkComponent(java.lang.String id,
java.lang.String text,
int wizardEvent,
boolean immediate,
java.lang.String javascript)
Return an existing or create a Hyperlink component
to be used as a step link in the steps list. |
javax.faces.component.UIComponent |
getStepListComponent()
Return a that represents the steps list, rendered in the Steps tab. |
java.util.Iterator |
getStepListIterator()
Returns an iterator of WizardStepListItem
instances that represent the steps for this wizard. |
javax.faces.component.UIComponent |
getStepNumberComponent(WizardStep step,
java.lang.String numberString)
Return the component to render for the step number that appears in the step list. |
javax.faces.component.UIComponent |
getStepPlaceholderTextComponent(WizardStep step)
Return the component to render for a branch step's placeholder text that appears in the step list. |
java.lang.Object |
getSteps()
Use the steps attribute to specify the wizard steps programmatically, instead of using the webuijsf:wizardStep tags in the JSP. |
javax.faces.component.UIComponent |
getStepsBarComponent()
Return a component to represent the wizards's top bar that typically contains the Steps and Help tabs. |
javax.faces.component.UIComponent |
getStepsPaneComponent()
Return a component to represent the left pane in the wizard that typically contains the steps list. |
javax.faces.component.UIComponent |
getStepsPaneTitleComponent()
Return the component to render for the steps pane title text when there is no step help and therefore no tabs. |
javax.faces.component.UIComponent |
getStepSummaryComponent(WizardStep step)
Return the component to render for the step summary text that appears in the step list. |
javax.faces.component.UIComponent |
getStepTitleComponent()
Return a component that represents the step title. |
javax.faces.component.UIComponent |
getStepTitleLabelTextComponent()
Return the component to render the step title label. |
javax.faces.component.UIComponent |
getStepTitleTextComponent()
Return the component to render the step title text. |
java.lang.String |
getStyle()
CSS style(s) to be applied to the outermost HTML element when this component is rendered. |
java.lang.String |
getStyleClass()
CSS style class(es) to be applied to the outermost HTML element when this component is rendered. |
javax.faces.component.UIComponent |
getTabsComponent()
Return a component that is rendered in the Steps pane. |
javax.faces.component.UIComponent |
getTaskComponent()
Return a component that represents the entire right pane including the step title, detail and components. |
javax.faces.component.UIComponent |
getTaskHeaderComponent()
Return a component that represents the step title and detail for the current step. This Wizard implementation returns null. |
javax.faces.component.UIComponent |
getTaskStepComponent()
Return a component that represents the components that comprise the current wizard step. |
java.lang.String |
getTitle()
The text to be displayed as the title for the wizard. |
javax.faces.component.UIComponent |
getTitleComponent()
Return the component to render for the wizard title. |
static Wizard |
getWizard(javax.faces.component.UIComponent child,
java.lang.String wizardId)
Return the Wizard instance ancestor of child
identified by wizardId . |
boolean |
hasCancel()
Return true if the cancel button should be rendered for the current step, else false. |
boolean |
hasClose()
Return true if the close button should be rendered for the current step, else false. |
boolean |
hasFinish()
Return true if the finish button should be rendered for the current step, else false. |
boolean |
hasNext()
Return true if the next button should be rendered for the current step, else false. |
boolean |
hasPrevious()
Return true if the previous button should be rendered for the current step, else false. |
boolean |
hasStepHelp()
Return true if the wizard has help for steps. |
boolean |
isCancelDisabled()
Return true if the cancel button should be disabled for the current step, else false. |
boolean |
isCloseDisabled()
Return true if the close button should be disabled for the current step, else false. |
boolean |
isComplete()
Return true if the wizard has completed all its steps. |
boolean |
isCurrentStep(WizardStep step)
Return true if step is the current step, else false. |
boolean |
isFinishDisabled()
Return true if the finish button should be disabled for the current step, else false. |
boolean |
isIsPopup()
The wizard is being targeted to a popup window. |
boolean |
isNextDisabled()
Return true if the next button should be disabled for the current step, else false. |
boolean |
isPreviousDisabled()
Return true if the previous button should be disabled for the current step, else false. |
boolean |
isStepsTabActive()
Returns true if the steps pane has Steps and Help tabs and the Steps tab is selected. |
boolean |
isVisible()
Indicates whether the component is viewable by the user in the rendered HTML page. |
void |
processDecodes(javax.faces.context.FacesContext context)
The wizard controls the decoding of the current wizard step. |
void |
processRestoreState(javax.faces.context.FacesContext context,
java.lang.Object state)
This implementation calls super.processRestortState and then calls getModel().initialize(). |
void |
processUpdates(javax.faces.context.FacesContext context)
The wizard controls the updating of the current wizard step. |
void |
processValidators(javax.faces.context.FacesContext context)
The wizard controls the validating of the current wizard step. |
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 |
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 wizard. |
void |
setId(java.lang.String id)
The component identifier for this component. |
void |
setIsPopup(boolean isPopup)
The wizard is being targeted to a popup window. |
void |
setModel(WizardModel model)
The model property is a value binding that
resolves to an instance of WizardModel . |
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 |
setOnPopupDismiss(java.lang.String onPopupDismiss)
Scripting code that is invoked when the wizard popup is dismissed. |
void |
setOnPrevious(java.lang.String onPrevious)
Scripting code executed when the Previous 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 |
setRendered(boolean rendered)
Use the rendered attribute to indicate whether the HTML code for the component should be included in the rendered HTML page. |
void |
setSteps(java.lang.Object steps)
Use the steps attribute to specify the wizard steps programmatically, instead of using the webuijsf:wizardStep tags in the JSP. |
void |
setStyle(java.lang.String style)
CSS style(s) to be applied to the outermost HTML element when this component is rendered. |
void |
setStyleClass(java.lang.String styleClass)
CSS style class(es) to be applied to the outermost HTML element when this component is rendered. |
void |
setTitle(java.lang.String title)
The text to be displayed as the title for the wizard. |
void |
setVisible(boolean visible)
Indicate whether the component should be viewable by the user in the rendered HTML page. |
Methods inherited from class javax.faces.component.UIComponentBase |
---|
findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnComponent, isRendered, isTransient, processSaveState, queueEvent, restoreAttachedState, saveAttachedState, setParent, 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 Wizard()
Wizard
instance.
Sets renderer type to com.sun.webui.jsf.Wizard
.
Method Detail |
---|
public java.lang.String getFamily()
com.sun.webui.jsf.Wizard
.
getFamily
in class javax.faces.component.UIComponent
public WizardModel getModel()
WizardModel
instance.
If super.getModel()
returns null, create an instance of
WizardModelBase
and call
super.setModel()
with the instance.
public void decode(javax.faces.context.FacesContext context)
processDecodes
during APPLY_REQUEST_VALUES phase.
Unlike many components, this method does not defer to the
renderer since there is nothing in the response to decode
by the Wizard
component directly.
decode
in class javax.faces.component.UIComponentBase
public void processDecodes(javax.faces.context.FacesContext context)
processDecodes()
for
its controls before the current step, to ensure that any control
events are issued before processing the step.
processDecodes
in class javax.faces.component.UIComponentBase
context
- This FacesContext for this request.
java.lang.NullPointerException
public void processValidators(javax.faces.context.FacesContext context)
processValidators()
for
its controls before the current step, to ensure that any control
events are issued before processing the step.
Call the validateControls
method, and then validateStep
.
processValidators
in class javax.faces.component.UIComponentBase
context
- This FacesContext for this request.
java.lang.NullPointerException
public void processUpdates(javax.faces.context.FacesContext context)
processUpdates()
for
its controls before the current step, to ensure that any control
events are issued before processing the step.
Call the updateControls
method,
and then updateStep
.
processUpdates
in class javax.faces.component.UIComponentBase
context
- This FacesContext for this request.
java.lang.NullPointerException
public void encodeBegin(javax.faces.context.FacesContext context) throws java.io.IOException
event
member is WizardEvent.START
, call
broadcastStartEvent
and then
set event
to WizardEvent.NOEVENT
to indicate
that the wizard has rendered at least once.
Then call the renderer's encodeBegin
method.
encodeBegin
in class javax.faces.component.UIComponentBase
context
- This FacesContext for this requset.
java.io.IOException
public void encodeChildren(javax.faces.context.FacesContext context) throws java.io.IOException
initialize)
method.
Then call the renderer's encodeChildren
method.
encodeChildren
in class javax.faces.component.UIComponentBase
context
- This FacesContext for this requset.
java.io.IOException
public void encodeEnd(javax.faces.context.FacesContext context) throws java.io.IOException
encodeChildren
method.
If the wizard model's
isComplete
method
returns true, call the model's complete
method to inform the model this wizard instance
will no longer invoke methods on that model instance during
this wizard session.
encodeEnd
in class javax.faces.component.UIComponentBase
context
- This FacesContext for this requset.
java.io.IOException
public java.util.Iterator getStepListIterator()
WizardStepListItem
instances that represent the steps for this wizard.
WizardStepListItem
instances encapsulate information about a step that is
useful for rendering a list of steps.
public boolean isComplete()
public boolean isCurrentStep(WizardStep step)
step
- The step to check.public WizardStep getCurrentStep()
public boolean hasStepHelp()
public boolean hasClose()
public boolean hasNext()
public boolean hasPrevious()
public boolean hasFinish()
public boolean hasCancel()
public boolean isCloseDisabled()
public boolean isNextDisabled()
public boolean isPreviousDisabled()
public boolean isFinishDisabled()
public boolean isCancelDisabled()
public boolean isStepsTabActive()
public java.lang.String getCurrentStepNumberString()
public javax.faces.component.UIComponent getCancelComponent()
UIComponent
that will be used for the
Cancel button.
public javax.faces.component.UIComponent getCloseComponent()
UIComponent
that will be used for the Close
button.
public javax.faces.component.UIComponent getFinishComponent()
UIComponent
that will be used for the
Finish button.
public javax.faces.component.UIComponent getNextComponent()
UIComponent
that will be used for the Next
button.
public javax.faces.component.UIComponent getPreviousComponent()
UIComponent
that will be used for the
Previous button.
public javax.faces.component.UIComponent getTabsComponent()
public javax.faces.component.UIComponent getStepIndicatorComponent()
stepIndicator
is found
that component is returned. Otherwise an Icon
component
is returned. It is assigned the id
getId() + "_stepIndicator"
If the facet is not defined then the returned Icon
component is re-intialized every time this method is called.
The icon image is ThemeImages.WIZARD_ARROW
public javax.faces.component.UIComponent getSteplinkComponent(java.lang.String id, java.lang.String text, int wizardEvent, boolean immediate, java.lang.String javascript)
Hyperlink
component
to be used as a step link in the steps list. The id for the created
component is:
step.getId() + "_stplnk" + "_" + stepId().
The appended step id is used to identify the step the wizard should
navigate to.
An WizardActionListener
is added to the
component if it is created.
id
- The component id as described above.text
- The Hylerlink text, typically WizardStep.getSummaryText.wizardEvent
- the WizardEvent for the listener to process.immediate
- the component's immediate value.javascript
- the onclick JavaScript routine name for this componentpublic javax.faces.component.UIComponent getStepsPaneComponent()
Wizard
implementation returns null.
public javax.faces.component.UIComponent getStepsBarComponent()
Wizard
implementation returns null.
public javax.faces.component.UIComponent getStepListComponent()
Wizard
implementation returns null.
public javax.faces.component.UIComponent getStepHelpComponent()
Wizard
implementation returns null.
public javax.faces.component.UIComponent getStepTitleComponent()
Wizard
implementation returns null.
public javax.faces.component.UIComponent getStepDetailComponent()
Wizard
implementation returns null.
public javax.faces.component.UIComponent getTaskStepComponent()
Wizard
implementation returns null.
public javax.faces.component.UIComponent getTaskComponent()
Wizard
implementation returns null.
public javax.faces.component.UIComponent getTaskHeaderComponent()
Wizard
implementation returns null.
public javax.faces.component.UIComponent getControlBarComponent()
Wizard
implementation returns null.
public javax.faces.component.UIComponent getLeftControlBarComponent()
Wizard
implementation returns null.
public javax.faces.component.UIComponent getRightControlBarComponent()
Wizard
implementation returns null.
public javax.faces.component.UIComponent getStepTitleLabelTextComponent()
getCurrentStep().getId() + "_stpttllbl"
.
This component also includes the step number. Typically
renders "Step 1:".
This Wizard
implementation returns a
StaticText
component that is created and
initialized every time this method is called.
public javax.faces.component.UIComponent getStepTitleTextComponent()
getCurrentStep().getId() + "_stpttl"
.
This component typically renders after the step title label.
This Wizard
implementation returns a
StaticText
component that is created and
initialized every time this method is called.
public javax.faces.component.UIComponent getStepDetailTextComponent()
getCurrentStep().getId() + "_stpdtl"
.
This component typically renders below the step title.
This Wizard
implementation returns a
StaticText
component that is created and
initialized every time this method is called.
public javax.faces.component.UIComponent getStepSummaryComponent(WizardStep step)
This Wizard
implementation returns either:
StaticText
component for the current
and future steps, created and initialized every time this method.
The component id is:
step.getId() + "_stpsmmy"
.
Hyperlink
component for visited steps.
The component is re-initialized every time this method is called.
The component id is:
step.getId() + "_stplnk" + "_" + step.getId()
.
The right most "step.getId()" text is interpreted in event handlers to
identify the step to navigate to.
step
- The step being rendered.public javax.faces.component.UIComponent getStepPlaceholderTextComponent(WizardStep step)
step.getId() + "_stpplhld"
.
This Wizard
implementation returns a
StaticText
component that is created and
initialized every time this method is called.
step
- The step being rendered.public javax.faces.component.UIComponent getStepNumberComponent(WizardStep step, java.lang.String numberString)
This Wizard
implementation returns either:
StaticText
component for the current and
future steps, created and initialized every time this method is called.
The id of this component is:
step.getId() + "_stpnum"
.
Hyperlink
component for visited steps.
The component is re-initialized every time this method is called.
The component id is:
step.getId() + "_num" + "_stplnk" + "_" + step.getId()
.
The right most "step.getId()" text is interpreted in event handlers to
identify the step to navigate to.
step
- The step being rendered.numberString
- The step number.public javax.faces.component.UIComponent getStepHelpTextComponent()
step.getId() + "_stphlp"
.
This Wizard
implementation returns a
StaticText
component that is created and
initialized every time this method is called.
public javax.faces.component.UIComponent getTitleComponent()
this.getId() + "_title"
.
This Wizard
implementation returns a
StaticText
component that is created and
initialized every time this method is called.
public javax.faces.component.UIComponent getStepsPaneTitleComponent()
step().getId() + "_stepsPaneTitle"
.
This Wizard
implementation returns a
StaticText
component that is created and
initialized every time this method is called.
public static Wizard getWizard(javax.faces.component.UIComponent child, java.lang.String wizardId)
Wizard
instance ancestor of child
identified by wizardId
.
child
- A descendant of the desired Wizard.wizardId
- The id of a Wizard ancestor.public void broadcastEvent(javax.faces.component.UIComponent source, int event) throws javax.faces.event.AbortProcessingException
WizardActionListener
to establish the event state of the wizard.
source
- The UIComponent originating the even.event
- One of:
javax.faces.event.AbortProcessingException
public void broadcast(javax.faces.event.FacesEvent facesEvent) throws javax.faces.event.AbortProcessingException
WizardEvent
event that is queued as a result
of an immediate ActionEvent
from one of the wizard's
navigation components. If facesEvent
is not an instance of
WizardEvent
the method just returns.
If facesEvent
is an instance of
WizardEvent
a new WizardEvent
is constructed with addtional information based on the navigation
event and the wizard state, including:
WizardEvent.getSource
WizardEvent.getStep
WizardEvent.getEventSource
WizardEvent
constant that identifies the
event WizardEvent.getEvent
.WizardStep
component id if the event is
WizardEvent.GOTOSTEP
WizardEvent.getgetGotoStepId
,
otherwise null.
The event is then broadcast to
WizardEventListeners
configured on the
current step and the wizard, and then forwarded to the wizard model
in the following manner:
getEventListener
method does
not return null, the
handleEvent
method is called on the returned instance.
getEventListner
is called
and if it returns a non null instance, its
handleEvent
method is called.
true
, the event is forwarded to the wizard model.
Note that if both listeners exist both listeners are sent the
event, even if the step's listener returns false. This means that
if the wizard's listener returns true
, since it is
called last, the event is forwarded to the wizard model.
If the last listener called returns false
the event
is not forwarded to the model and the current step will be
redisplayed.
handleEvent
method throws an exception the event is changed to
WizardEvent.CANCEL
and forwarded to the
wizard model, effectively ending the wizard session, as if the
user had clicked the cancel button.
broadcast
in class javax.faces.component.UIComponentBase
facesEvent
- must be an instance of WizardEvent
javax.faces.event.AbortProcessingException
public void setId(java.lang.String id)
setId
in class javax.faces.component.UIComponentBase
public void setRendered(boolean rendered)
setRendered
in class javax.faces.component.UIComponentBase
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 that is being performed, and determines whether the next step or a previous step, etc. can be navigated to.
See the Event Listeners section also.
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 that is being performed, and determines whether the next step or a previous step, etc. can be navigated to.
See the Event Listeners section also.
getEventListener()
public boolean isIsPopup()
true
. Set this property to false
if the wizard is to appear within a main browser window.
public void setIsPopup(boolean isPopup)
true
. Set this property to false
if the wizard is to appear within a main browser window.
isIsPopup()
public void setModel(WizardModel model)
model
property is a value binding that
resolves to an instance of WizardModel
. This instance
is an alternative to the default WizardModelBase
instance that controls the flow of steps in the wizard.
getModel()
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 getOnPopupDismiss()
public void setOnPopupDismiss(java.lang.String onPopupDismiss)
getOnPopupDismiss()
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 java.lang.Object getSteps()
webuijsf:wizardStep
tags in the JSP.
The steps attribute must be specified as an ArrayList
or
List
of WizardStep
, WizardBranch
,
WizardBranchSteps
, or WizardSubstepBranch
components.
public void setSteps(java.lang.Object steps)
webuijsf:wizardStep
tags in the JSP.
The steps attribute must be specified as an ArrayList
or
List
of WizardStep
, WizardBranch
,
WizardBranchSteps
, or WizardSubstepBranch
components.
getSteps()
public java.lang.String getStyle()
public void setStyle(java.lang.String style)
getStyle()
public java.lang.String getStyleClass()
public void setStyleClass(java.lang.String styleClass)
getStyleClass()
public java.lang.String getTitle()
public void setTitle(java.lang.String title)
getTitle()
public boolean isVisible()
true
by default and the HTML markup
for the component HTML is rendered in the page and the
component is visible to the user.
If false
is returned the the HTML markup for the
component is present in the rendered page, but the component
is not visible to the user.
setVisible(boolean)
public void setVisible(boolean visible)
false
, the HTML markup for the component is present in the
rendered page, but the component is viewable to the user.
By default, the HTML markup for the component is included in the
rendered page and is visible to the user. If visible
is false
, the component is not viewable to the user,
but the HTML markup is included in the rendered
page and can still be processed on subsequent form
submissions because the HTML is present.
isVisible()
public void processRestoreState(javax.faces.context.FacesContext context, java.lang.Object state)
processRestoreState
in class javax.faces.component.UIComponentBase
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 |