javax.faces.application
Class ViewHandlerWrapper

java.lang.Object
  extended by javax.faces.application.ViewHandler
      extended by javax.faces.application.ViewHandlerWrapper
All Implemented Interfaces:
FacesWrapper<ViewHandler>

public abstract class ViewHandlerWrapper
extends ViewHandler
implements FacesWrapper<ViewHandler>

Provides a simple implementation of ViewHandler that can be subclassed by developers wishing to provide specialized behavior to an existing ViewHandler instance. The default implementation of all methods is to call through to the wrapped ViewHandler.

Usage: extend this class and override getWrapped() to return the instance we are wrapping.

Since:
1.2

Field Summary
 
Fields inherited from class javax.faces.application.ViewHandler
CHARACTER_ENCODING_KEY, DEFAULT_FACELETS_SUFFIX, DEFAULT_SUFFIX, DEFAULT_SUFFIX_PARAM_NAME, FACELETS_SUFFIX_PARAM_NAME, FACELETS_VIEW_MAPPINGS_PARAM_NAME
 
Constructor Summary
ViewHandlerWrapper()
           
 
Method Summary
 String calculateCharacterEncoding(FacesContext context)
          The default behavior of this method is to call ViewHandler.calculateCharacterEncoding(javax.faces.context.FacesContext) on the wrapped ViewHandler object.
 Locale calculateLocale(FacesContext context)
          The default behavior of this method is to call ViewHandler.calculateLocale(javax.faces.context.FacesContext) on the wrapped ViewHandler object.
 String calculateRenderKitId(FacesContext context)
          The default behavior of this method is to call ViewHandler.calculateRenderKitId(javax.faces.context.FacesContext) on the wrapped ViewHandler object.
 UIViewRoot createView(FacesContext context, String viewId)
          The default behavior of this method is to call ViewHandler.createView(javax.faces.context.FacesContext, String) on the wrapped ViewHandler object.
 String getActionURL(FacesContext context, String viewId)
          The default behavior of this method is to call ViewHandler.getActionURL(javax.faces.context.FacesContext, String) on the wrapped ViewHandler object.
 PageDeclarationLanguage getPageDeclarationLanguage(FacesContext context, String viewId)
          The default behavior of this method is to call ViewHandler.getPageDeclarationLanguage(javax.faces.context.FacesContext, java.lang.String) on the wrapped ViewHandler object.
 String getResourceURL(FacesContext context, String path)
          The default behavior of this method is to call ViewHandler.getResourceURL(javax.faces.context.FacesContext, String) on the wrapped ViewHandler object.
abstract  ViewHandler getWrapped()
          

A class that implements this interface uses this method to return an instance of the class being wrapped.

 void initView(FacesContext context)
          The default behavior of this method is to call ViewHandler.initView(javax.faces.context.FacesContext) on the wrapped ViewHandler object.
 void renderView(FacesContext context, UIViewRoot viewToRender)
          The default behavior of this method is to call ViewHandler.renderView(javax.faces.context.FacesContext, javax.faces.component.UIViewRoot) on the wrapped ViewHandler object.
 UIViewRoot restoreView(FacesContext context, String viewId)
          The default behavior of this method is to call ViewHandler.restoreView(javax.faces.context.FacesContext, String) on the wrapped ViewHandler object.
 void retargetAttachedObjects(FacesContext context, UIComponent topLevelComponent, List<AttachedObjectHandler> handlers)
          The default behavior of this method is to call ViewHandler.retargetAttachedObjects(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.util.List) on the wrapped ViewHandler object.
 void retargetMethodExpressions(FacesContext context, UIComponent topLevelComponent)
          The default behavior of this method is to call ViewHandler.retargetMethodExpressions(javax.faces.context.FacesContext, javax.faces.component.UIComponent) on the wrapped ViewHandler object.
 void writeState(FacesContext context)
          The default behavior of this method is to call ViewHandler.writeState(javax.faces.context.FacesContext) on the wrapped ViewHandler object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ViewHandlerWrapper

public ViewHandlerWrapper()
Method Detail

getWrapped

public abstract ViewHandler getWrapped()
Description copied from interface: FacesWrapper

A class that implements this interface uses this method to return an instance of the class being wrapped.

Specified by:
getWrapped in interface FacesWrapper<ViewHandler>
Returns:
the instance that we are wrapping.

calculateCharacterEncoding

public String calculateCharacterEncoding(FacesContext context)

The default behavior of this method is to call ViewHandler.calculateCharacterEncoding(javax.faces.context.FacesContext) on the wrapped ViewHandler object.

Overrides:
calculateCharacterEncoding in class ViewHandler
Since:
1.2
See Also:
ViewHandler.calculateCharacterEncoding(javax.faces.context.FacesContext)

calculateLocale

public Locale calculateLocale(FacesContext context)

The default behavior of this method is to call ViewHandler.calculateLocale(javax.faces.context.FacesContext) on the wrapped ViewHandler object.

Specified by:
calculateLocale in class ViewHandler
Parameters:
context - FacesContext for the current request
Since:
1.2
See Also:
ViewHandler.calculateLocale(javax.faces.context.FacesContext)

calculateRenderKitId

public String calculateRenderKitId(FacesContext context)

The default behavior of this method is to call ViewHandler.calculateRenderKitId(javax.faces.context.FacesContext) on the wrapped ViewHandler object.

Specified by:
calculateRenderKitId in class ViewHandler
Parameters:
context - FacesContext for the current request
Since:
1.2
See Also:
ViewHandler.calculateRenderKitId(javax.faces.context.FacesContext)

createView

public UIViewRoot createView(FacesContext context,
                             String viewId)

The default behavior of this method is to call ViewHandler.createView(javax.faces.context.FacesContext, String) on the wrapped ViewHandler object.

Specified by:
createView in class ViewHandler
Since:
1.2
See Also:
ViewHandler.createView(javax.faces.context.FacesContext, String)

getActionURL

public String getActionURL(FacesContext context,
                           String viewId)

The default behavior of this method is to call ViewHandler.getActionURL(javax.faces.context.FacesContext, String) on the wrapped ViewHandler object.

Specified by:
getActionURL in class ViewHandler
Parameters:
context - FacesContext for this request
viewId - View identifier of the desired view
Since:
1.2
See Also:
ViewHandler.getActionURL(javax.faces.context.FacesContext, String)

getResourceURL

public String getResourceURL(FacesContext context,
                             String path)

The default behavior of this method is to call ViewHandler.getResourceURL(javax.faces.context.FacesContext, String) on the wrapped ViewHandler object.

Specified by:
getResourceURL in class ViewHandler
Parameters:
context - FacesContext for the current request
path - Resource path to convert to a URL
Since:
1.2
See Also:
ViewHandler.getResourceURL(javax.faces.context.FacesContext, String)

getPageDeclarationLanguage

public PageDeclarationLanguage getPageDeclarationLanguage(FacesContext context,
                                                          String viewId)

The default behavior of this method is to call ViewHandler.getPageDeclarationLanguage(javax.faces.context.FacesContext, java.lang.String) on the wrapped ViewHandler object.

Overrides:
getPageDeclarationLanguage in class ViewHandler
Since:
2.0

initView

public void initView(FacesContext context)
              throws FacesException

The default behavior of this method is to call ViewHandler.initView(javax.faces.context.FacesContext) on the wrapped ViewHandler object.

Overrides:
initView in class ViewHandler
Throws:
FacesException - if a problem occurs setting the encoding, such as the UnsupportedEncodingException thrown by the underlying Servlet or Portlet technology when the encoding is not supported.
Since:
1.2
See Also:
ViewHandler.initView(javax.faces.context.FacesContext)

renderView

public void renderView(FacesContext context,
                       UIViewRoot viewToRender)
                throws IOException,
                       FacesException

The default behavior of this method is to call ViewHandler.renderView(javax.faces.context.FacesContext, javax.faces.component.UIViewRoot) on the wrapped ViewHandler object.

Specified by:
renderView in class ViewHandler
Parameters:
context - FacesContext for the current request
viewToRender - the view to render
Throws:
IOException - if an input/output error occurs
FacesException - if a servlet error occurs
Since:
1.2
See Also:
ViewHandler.renderView(javax.faces.context.FacesContext, javax.faces.component.UIViewRoot)

restoreView

public UIViewRoot restoreView(FacesContext context,
                              String viewId)

The default behavior of this method is to call ViewHandler.restoreView(javax.faces.context.FacesContext, String) on the wrapped ViewHandler object.

Specified by:
restoreView in class ViewHandler
Parameters:
context - FacesContext for the current request
viewId - the view identifier for the current request
Since:
1.2
See Also:
ViewHandler.restoreView(javax.faces.context.FacesContext, String)

retargetAttachedObjects

public void retargetAttachedObjects(FacesContext context,
                                    UIComponent topLevelComponent,
                                    List<AttachedObjectHandler> handlers)

The default behavior of this method is to call ViewHandler.retargetAttachedObjects(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.util.List) on the wrapped ViewHandler object.

Overrides:
retargetAttachedObjects in class ViewHandler
Parameters:
context - the FacesContext for this request.
topLevelComponent - The UIComponent in the view to which the attached objects must be attached. This UIComponent must have its component metadata already associated and available from via the JavaBeans API.
handlers - specified by the page author in the consuming page, provided to this method by the PDL implementation, this is a list of implementations of AttachedObjectHandler, each one of which represents a relationship between an attached object and the UIComponent to which it is attached.
Since:
2.0

retargetMethodExpressions

public void retargetMethodExpressions(FacesContext context,
                                      UIComponent topLevelComponent)

The default behavior of this method is to call ViewHandler.retargetMethodExpressions(javax.faces.context.FacesContext, javax.faces.component.UIComponent) on the wrapped ViewHandler object.

Overrides:
retargetMethodExpressions in class ViewHandler
Parameters:
context - the FacesContext for this request.
topLevelComponent - The UIComponent in the view to which the attached objects must be attached. This UIComponent must have its component metadata already associated and available from via the JavaBeans API. RELEASE_PENDING (edburns, rogerk) Exceptions for null arguments? If so, which ones?
Since:
2.0

writeState

public void writeState(FacesContext context)
                throws IOException

The default behavior of this method is to call ViewHandler.writeState(javax.faces.context.FacesContext) on the wrapped ViewHandler object.

Specified by:
writeState in class ViewHandler
Parameters:
context - FacesContext for the current request
Throws:
IOException - if an input/output error occurs
Since:
1.2
See Also:
ViewHandler.writeState(javax.faces.context.FacesContext)


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