de.mindmatters.faces.application
Class FaceletViewBuilder

java.lang.Object
  javax.faces.application.ViewHandler
      de.mindmatters.faces.application.ViewBuilder
          de.mindmatters.faces.application.FaceletViewBuilder

public class FaceletViewBuilder
extends ViewBuilder

ViewBuilder implementation based upon jsf-facelets. Facelets is able to restore the structure of a view without any state representing the tree structure.

Configure this resolver in your faces-config.xml file as follows:

 <application>
   ...
   <view-handler>de.mindmatters.faces.application.FaceletViewBuilder</view-handler>
 </application>
 

Author:

Andreas Kuhrwahl

See Also:

ViewBuilder, ViewBuilder.buildView(FacesContext, String), FaceletViewHandler

Field Summary

Fields inherited from class javax.faces.application.ViewHandler

CHARACTER_ENCODING_KEY, DEFAULT_SUFFIX, DEFAULT_SUFFIX_PARAM_NAME

Constructor Summary

FaceletViewBuilder(ViewHandler delegate)
Constructor that takes the original ViewHandler.

Method Summary

UIViewRoot	buildView(FacesContext context, java.lang.String viewId) Perform whatever actions are required to build the view associated with the specified FacesContext and viewId.
java.util.Locale	calculateLocale(FacesContext context)
java.lang.String	calculateRenderKitId(FacesContext context)
UIViewRoot	createView(FacesContext context, java.lang.String viewId)
protected java.lang.Class	extendedFaceletViewHandlerClass() Must return a ViewHandler class of type ExtendedFaceletViewHandler.
java.lang.String	getActionURL(FacesContext context, java.lang.String viewId)
java.lang.String	getResourceURL(FacesContext context, java.lang.String path)
void	renderView(FacesContext context, UIViewRoot viewToRender)
UIViewRoot	restoreView(FacesContext context, java.lang.String viewId)
protected void	writeStateInClient(FacesContext context) Writes the state of a view into the response.

Methods inherited from class de.mindmatters.faces.application.ViewBuilder

markForTransientState, unmarkTransientState, writeState

Methods inherited from class java.lang.Object

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

Constructor Detail

FaceletViewBuilder

public FaceletViewBuilder(ViewHandler delegate)

Constructor that takes the original ViewHandler.

Parameters:

delegate - the original ViewHandler

Method Detail

buildView

public UIViewRoot buildView(FacesContext context,
                            java.lang.String viewId)

Perform whatever actions are required to build the view associated with the specified FacesContext and viewId. Building a view means to restore the component tree structure of a view without the need of a serialized state representing the structure.

Specified by:

buildView in class ViewBuilder

Parameters:

context - FacesContext for the current request

viewId - the view identifier for the current request

Returns:

Built UIViewRoot representing the view

writeStateInClient

protected void writeStateInClient(FacesContext context)
                           throws java.io.IOException

Writes the state of a view into the response. Usually this is done by calling StateManager.writeState(javax.faces.context.FacesContext, javax.faces.application.StateManager.SerializedView)

Specified by:

writeStateInClient in class ViewBuilder

Parameters:

context - FacesContext for the current request

Throws:

java.io.IOException - if an input/output error occurs

See Also:

ViewHandler.writeState(FacesContext)

calculateLocale

public java.util.Locale calculateLocale(FacesContext context)

Specified by:

calculateLocale in class ViewHandler

calculateRenderKitId

public java.lang.String calculateRenderKitId(FacesContext context)

Specified by:

calculateRenderKitId in class ViewHandler

createView

public UIViewRoot createView(FacesContext context,
                             java.lang.String viewId)

Specified by:

createView in class ViewHandler

getActionURL

public java.lang.String getActionURL(FacesContext context,
                                     java.lang.String viewId)

Specified by:

getActionURL in class ViewHandler

getResourceURL

public java.lang.String getResourceURL(FacesContext context,
                                       java.lang.String path)

Specified by:

getResourceURL in class ViewHandler

renderView

public void renderView(FacesContext context,
                       UIViewRoot viewToRender)
                throws java.io.IOException

Specified by:

renderView in class ViewHandler

Throws:

java.io.IOException

restoreView

public UIViewRoot restoreView(FacesContext context,
                              java.lang.String viewId)

Specified by:

restoreView in class ViewHandler

extendedFaceletViewHandlerClass

protected java.lang.Class extendedFaceletViewHandlerClass()

Must return a ViewHandler class of type ExtendedFaceletViewHandler. An instance of this class will be used internal as delegate. Default implementation delivers a class object of ExtendedFaceletViewHandler. May be overridden in subclasses.

Returns:

a ViewHandler class