|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.application.ViewHandler
javax.faces.application.ViewHandlerWrapper
public abstract class ViewHandlerWrapper
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.
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()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ViewHandlerWrapper()
Method Detail |
---|
public abstract ViewHandler getWrapped()
FacesWrapper
A class that implements this interface uses this method to return an instance of the class being wrapped.
getWrapped
in interface FacesWrapper<ViewHandler>
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.
calculateCharacterEncoding
in class ViewHandler
ViewHandler.calculateCharacterEncoding(javax.faces.context.FacesContext)
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.
calculateLocale
in class ViewHandler
context
- FacesContext
for the current requestViewHandler.calculateLocale(javax.faces.context.FacesContext)
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.
calculateRenderKitId
in class ViewHandler
context
- FacesContext
for the current requestViewHandler.calculateRenderKitId(javax.faces.context.FacesContext)
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.
createView
in class ViewHandler
ViewHandler.createView(javax.faces.context.FacesContext, String)
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.
getActionURL
in class ViewHandler
context
- FacesContext
for this requestviewId
- View identifier of the desired viewViewHandler.getActionURL(javax.faces.context.FacesContext, String)
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.
getResourceURL
in class ViewHandler
context
- FacesContext
for the current requestpath
- Resource path to convert to a URLViewHandler.getResourceURL(javax.faces.context.FacesContext, String)
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.
getPageDeclarationLanguage
in class ViewHandler
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.
initView
in class ViewHandler
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.ViewHandler.initView(javax.faces.context.FacesContext)
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.
renderView
in class ViewHandler
context
- FacesContext
for the current requestviewToRender
- the view to render
IOException
- if an input/output error occurs
FacesException
- if a servlet error occursViewHandler.renderView(javax.faces.context.FacesContext, javax.faces.component.UIViewRoot)
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.
restoreView
in class ViewHandler
context
- FacesContext
for the current requestviewId
- the view identifier for the current requestViewHandler.restoreView(javax.faces.context.FacesContext, String)
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.
retargetAttachedObjects
in class ViewHandler
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.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.
retargetMethodExpressions
in class ViewHandler
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?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.
writeState
in class ViewHandler
context
- FacesContext
for the current request
IOException
- if an input/output error occursViewHandler.writeState(javax.faces.context.FacesContext)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |