com.ibm.xsp.application
Class ViewHandlerEx

java.lang.Object
  javax.faces.application.ViewHandler
      com.ibm.xsp.application.ViewHandlerEx

public abstract class ViewHandlerEx
extends javax.faces.application.ViewHandler

Extension of the JSF Viewhandler with specific implementation points for XPages

Field Summary

Fields inherited from class javax.faces.application.ViewHandler

CHARACTER_ENCODING_KEY, DEFAULT_SUFFIX, DEFAULT_SUFFIX_PARAM_NAME

Constructor Summary

ViewHandlerEx()

Method Summary

javax.faces.component.UIViewRoot	createView(javax.faces.context.FacesContext context, java.lang.String viewId) Construct an instance of the view root
protected abstract javax.faces.component.UIViewRoot	doCreateView(javax.faces.context.FacesContext context, java.lang.String viewId, java.util.Locale locale, java.lang.String renderKitId) Do the creation of the view and ensure it is an XSP view root
abstract void	doInitRender(javax.faces.context.FacesContext context) Performs some setup required to begin rendering.
abstract FacesPageDriver	getPageDriver() Return the FacesDriver used by this application
boolean	isGlobalResource(javax.faces.context.FacesContext context, java.lang.String path) Abstract method for checking is a resource a global one in the xpage application.ie that it starts with /.ibmxspres/
boolean	isModuleResource(javax.faces.context.FacesContext context, java.lang.String path) Abstract method for checking is a resource a module one in the xpage application .ie that it starts with /.ibmmodres/
abstract void	saveViewState(javax.faces.context.FacesContext context, javax.faces.component.UIViewRoot viewToRender)
abstract void	setPageDriver(FacesPageDriver driver) Set the FacesPageDriver to be used by this application

Methods inherited from class javax.faces.application.ViewHandler

calculateLocale, calculateRenderKitId, getActionURL, getResourceURL, renderView, restoreView, writeState

Methods inherited from class java.lang.Object

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

Constructor Detail

ViewHandlerEx

public ViewHandlerEx()

Method Detail

createView

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

Construct an instance of the view root

Specified by:

createView in class javax.faces.application.ViewHandler

Parameters:

{@link - javax.faces.context.FacesContext}

viewId -

isGlobalResource

public boolean isGlobalResource(javax.faces.context.FacesContext context,
                                java.lang.String path)

Abstract method for checking is a resource a global one in the xpage application.ie that it starts with /.ibmxspres/

Parameters:

{@link - javax.faces.context.FacesContext}

path -

isModuleResource

public boolean isModuleResource(javax.faces.context.FacesContext context,
                                java.lang.String path)

Abstract method for checking is a resource a module one in the xpage application .ie that it starts with /.ibmmodres/

Parameters:

{@link - javax.faces.context.FacesContext}

path -

saveViewState

public abstract void saveViewState(javax.faces.context.FacesContext context,
                                   javax.faces.component.UIViewRoot viewToRender)

doCreateView

protected abstract javax.faces.component.UIViewRoot doCreateView(javax.faces.context.FacesContext context,
                                                                 java.lang.String viewId,
                                                                 java.util.Locale locale,
                                                                 java.lang.String renderKitId)

Do the creation of the view and ensure it is an XSP view root

setPageDriver

public abstract void setPageDriver(FacesPageDriver driver)

Set the FacesPageDriver to be used by this application

getPageDriver

public abstract FacesPageDriver getPageDriver()

Return the FacesDriver used by this application

doInitRender

public abstract void doInitRender(javax.faces.context.FacesContext context)
                           throws java.io.IOException

Performs some setup required to begin rendering. This is not necessarily called during the jsf render phase.

Amongst other things it will call FacesContext.setResponseWriter(javax.faces.context.ResponseWriter) with a non-null writer.

Parameters:

context -

Throws:

java.io.IOException