org.primefaces.component.wizard
Class Wizard

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          org.primefaces.component.wizard.Wizard

All Implemented Interfaces:

EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, Widget

public class Wizard
extends javax.faces.component.UIComponentBase
implements Widget

Nested Class Summary

protected static class

Wizard.PropertyKeys

Field Summary

static String	ACTIVE_STEP_CLASS
static String	BACK_BUTTON_CLASS
static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE
static String	NEXT_BUTTON_CLASS
static String	STEP_CLASS
static String	STEP_STATUS_CLASS

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Constructor Summary

Wizard()

Method Summary

void	broadcast(javax.faces.event.FacesEvent event)
String	getBackLabel()
String	getFamily()
javax.el.MethodExpression	getFlowListener()
String	getNextLabel()
String	getOnback()
String	getOnnext()
String	getStep()
Tab	getStepToProcess()
String	getStyle()
String	getStyleClass()
String	getWidgetVar()
boolean	isBackRequest(javax.faces.context.FacesContext context)
boolean	isShowNavBar()
boolean	isShowStepStatus()
boolean	isWizardRequest(javax.faces.context.FacesContext context)
void	processDecodes(javax.faces.context.FacesContext context)
void	processUpdates(javax.faces.context.FacesContext context)
void	processValidators(javax.faces.context.FacesContext context)
String	resolveWidgetVar()
void	setBackLabel(String _backLabel)
void	setFlowListener(javax.el.MethodExpression _flowListener)
void	setNextLabel(String _nextLabel)
void	setOnback(String _onback)
void	setOnnext(String _onnext)
void	setShowNavBar(boolean _showNavBar)
void	setShowStepStatus(boolean _showStepStatus)
void	setStep(String _step)
void	setStyle(String _style)
void	setStyleClass(String _styleClass)
void	setWidgetVar(String _widgetVar)

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

STEP_STATUS_CLASS

public static final String STEP_STATUS_CLASS

See Also:

Constant Field Values

STEP_CLASS

public static final String STEP_CLASS

See Also:

Constant Field Values

ACTIVE_STEP_CLASS

public static final String ACTIVE_STEP_CLASS

See Also:

Constant Field Values

BACK_BUTTON_CLASS

public static final String BACK_BUTTON_CLASS

See Also:

Constant Field Values

NEXT_BUTTON_CLASS

public static final String NEXT_BUTTON_CLASS

See Also:

Constant Field Values

Constructor Detail

Wizard

public Wizard()

Method Detail

getFamily

public String getFamily()

Specified by:

getFamily in class javax.faces.component.UIComponent

getWidgetVar

public String getWidgetVar()

setWidgetVar

public void setWidgetVar(String _widgetVar)

getStep

public String getStep()

setStep

public void setStep(String _step)

getStyle

public String getStyle()

setStyle

public void setStyle(String _style)

getStyleClass

public String getStyleClass()

setStyleClass

public void setStyleClass(String _styleClass)

getFlowListener

public javax.el.MethodExpression getFlowListener()

setFlowListener

public void setFlowListener(javax.el.MethodExpression _flowListener)

isShowNavBar

public boolean isShowNavBar()

setShowNavBar

public void setShowNavBar(boolean _showNavBar)

isShowStepStatus

public boolean isShowStepStatus()

setShowStepStatus

public void setShowStepStatus(boolean _showStepStatus)

getOnback

public String getOnback()

setOnback

public void setOnback(String _onback)

getOnnext

public String getOnnext()

setOnnext

public void setOnnext(String _onnext)

getNextLabel

public String getNextLabel()

setNextLabel

public void setNextLabel(String _nextLabel)

getBackLabel

public String getBackLabel()

setBackLabel

public void setBackLabel(String _backLabel)

processDecodes

public void processDecodes(javax.faces.context.FacesContext context)

Overrides:

processDecodes in class javax.faces.component.UIComponentBase

processValidators

public void processValidators(javax.faces.context.FacesContext context)

Overrides:

processValidators in class javax.faces.component.UIComponentBase

processUpdates

public void processUpdates(javax.faces.context.FacesContext context)

Overrides:

processUpdates in class javax.faces.component.UIComponentBase

getStepToProcess

public Tab getStepToProcess()

isWizardRequest

public boolean isWizardRequest(javax.faces.context.FacesContext context)

isBackRequest

public boolean isBackRequest(javax.faces.context.FacesContext context)

broadcast

public void broadcast(javax.faces.event.FacesEvent event)
               throws javax.faces.event.AbortProcessingException

Overrides:

broadcast in class javax.faces.component.UIComponentBase

Throws:

javax.faces.event.AbortProcessingException

resolveWidgetVar

public String resolveWidgetVar()

Specified by:

resolveWidgetVar in interface Widget