Class ViewHandlerWrapper
- java.lang.Object
-
- javax.faces.application.ViewHandler
-
- 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 existingViewHandler
instance. The default implementation of all methods is to call through to the wrappedViewHandler
.Usage: extend this class and push the implementation being wrapped to the constructor and use
getWrapped()
to access the instance being wrapped.- 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, DISABLE_FACELET_JSF_VIEWHANDLER_PARAM_NAME, FACELETS_BUFFER_SIZE_PARAM_NAME, FACELETS_DECORATORS_PARAM_NAME, FACELETS_LIBRARIES_PARAM_NAME, FACELETS_REFRESH_PERIOD_PARAM_NAME, FACELETS_SKIP_COMMENTS_PARAM_NAME, FACELETS_SUFFIX_PARAM_NAME, FACELETS_VIEW_MAPPINGS_PARAM_NAME
-
-
Constructor Summary
Constructors Constructor Description ViewHandlerWrapper()
Deprecated.Use the other constructor taking the implementation being wrapped.ViewHandlerWrapper(ViewHandler wrapped)
If this view handler has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addProtectedView(java.lang.String urlPattern)
The default behavior of this method is to callViewHandler.addProtectedView(java.lang.String)
on the wrappedViewHandler
object.java.lang.String
calculateCharacterEncoding(FacesContext context)
The default behavior of this method is to callViewHandler.calculateCharacterEncoding(javax.faces.context.FacesContext)
on the wrappedViewHandler
object.java.util.Locale
calculateLocale(FacesContext context)
The default behavior of this method is to callViewHandler.calculateLocale(javax.faces.context.FacesContext)
on the wrappedViewHandler
object.java.lang.String
calculateRenderKitId(FacesContext context)
The default behavior of this method is to callViewHandler.calculateRenderKitId(javax.faces.context.FacesContext)
on the wrappedViewHandler
object.UIViewRoot
createView(FacesContext context, java.lang.String viewId)
The default behavior of this method is to callViewHandler.createView(javax.faces.context.FacesContext, String)
on the wrappedViewHandler
object.java.lang.String
deriveLogicalViewId(FacesContext context, java.lang.String requestViewId)
The default behavior of this method is to callViewHandler.deriveLogicalViewId(javax.faces.context.FacesContext, String)
on the wrappedViewHandler
object.java.lang.String
deriveViewId(FacesContext context, java.lang.String requestViewId)
The default behavior of this method is to callViewHandler.deriveViewId(javax.faces.context.FacesContext, String)
on the wrappedViewHandler
object.java.lang.String
getActionURL(FacesContext context, java.lang.String viewId)
The default behavior of this method is to callViewHandler.getActionURL(javax.faces.context.FacesContext, String)
on the wrappedViewHandler
object.java.lang.String
getBookmarkableURL(FacesContext context, java.lang.String viewId, java.util.Map<java.lang.String,java.util.List<java.lang.String>> parameters, boolean includeViewParams)
The default behavior of this method is to callViewHandler.getBookmarkableURL(javax.faces.context.FacesContext, String, java.util.Map, boolean)
on the wrappedViewHandler
object.java.util.Set<java.lang.String>
getProtectedViewsUnmodifiable()
The default behavior of this method is to callViewHandler.getProtectedViewsUnmodifiable()
on the wrappedViewHandler
object.java.lang.String
getRedirectURL(FacesContext context, java.lang.String viewId, java.util.Map<java.lang.String,java.util.List<java.lang.String>> parameters, boolean includeViewParams)
The default behavior of this method is to callViewHandler.getRedirectURL(javax.faces.context.FacesContext, String, java.util.Map, boolean)
on the wrappedViewHandler
object.java.lang.String
getResourceURL(FacesContext context, java.lang.String path)
The default behavior of this method is to callViewHandler.getResourceURL(javax.faces.context.FacesContext, String)
on the wrappedViewHandler
object.ViewDeclarationLanguage
getViewDeclarationLanguage(FacesContext context, java.lang.String viewId)
The default behavior of this method is to callViewHandler.getViewDeclarationLanguage(javax.faces.context.FacesContext, java.lang.String)
on the wrappedViewHandler
object.java.util.stream.Stream<java.lang.String>
getViews(FacesContext context, java.lang.String path, int maxDepth, ViewVisitOption... options)
The default behavior of this method is to callViewHandler.getViews(FacesContext, String, int, ViewVisitOption...)
on the wrappedViewHandler
object.java.util.stream.Stream<java.lang.String>
getViews(FacesContext context, java.lang.String path, ViewVisitOption... options)
The default behavior of this method is to callViewHandler.getViews(FacesContext, String, ViewVisitOption...)
on the wrappedViewHandler
object.java.lang.String
getWebsocketURL(FacesContext context, java.lang.String channel)
The default behavior of this method is to callViewHandler.getWebsocketURL(FacesContext, String)
on the wrappedViewHandler
object.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 callViewHandler.initView(javax.faces.context.FacesContext)
on the wrappedViewHandler
object.boolean
removeProtectedView(java.lang.String urlPattern)
The default behavior of this method is to callViewHandler.removeProtectedView(java.lang.String)
on the wrappedViewHandler
object.void
renderView(FacesContext context, UIViewRoot viewToRender)
The default behavior of this method is to callViewHandler.renderView(javax.faces.context.FacesContext, javax.faces.component.UIViewRoot)
on the wrappedViewHandler
object.UIViewRoot
restoreView(FacesContext context, java.lang.String viewId)
The default behavior of this method is to callViewHandler.restoreView(javax.faces.context.FacesContext, String)
on the wrappedViewHandler
object.void
writeState(FacesContext context)
The default behavior of this method is to callViewHandler.writeState(javax.faces.context.FacesContext)
on the wrappedViewHandler
object.
-
-
-
Constructor Detail
-
ViewHandlerWrapper
@Deprecated public ViewHandlerWrapper()
Deprecated. Use the other constructor taking the implementation being wrapped.
-
ViewHandlerWrapper
public ViewHandlerWrapper(ViewHandler wrapped)
If this view handler has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The
getWrapped()
will then return the implementation being wrapped.- Parameters:
wrapped
- The implementation being wrapped.- Since:
- 2.3
-
-
Method Detail
-
getWrapped
public 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 interfaceFacesWrapper<ViewHandler>
- Returns:
- the wrapped instance.
-
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 wrappedViewHandler
object.- Overrides:
initView
in classViewHandler
- Parameters:
context
- the Faces context.- Throws:
FacesException
- if a problem occurs setting the encoding, such as theUnsupportedEncodingException
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)
-
restoreView
public UIViewRoot restoreView(FacesContext context, java.lang.String viewId)
The default behavior of this method is to call
ViewHandler.restoreView(javax.faces.context.FacesContext, String)
on the wrappedViewHandler
object.- Specified by:
restoreView
in classViewHandler
- Parameters:
context
-FacesContext
for the current requestviewId
- the view identifier for the current request- Returns:
- the restored view root, or null.
- Since:
- 1.2
- See Also:
ViewHandler.restoreView(javax.faces.context.FacesContext, String)
-
createView
public UIViewRoot createView(FacesContext context, java.lang.String viewId)
The default behavior of this method is to call
ViewHandler.createView(javax.faces.context.FacesContext, String)
on the wrappedViewHandler
object.- Specified by:
createView
in classViewHandler
- Parameters:
context
- the Faces context.viewId
- the view id.- Returns:
- the viewroot.
- Since:
- 1.2
- See Also:
ViewHandler.createView(javax.faces.context.FacesContext, String)
-
renderView
public void renderView(FacesContext context, UIViewRoot viewToRender) throws java.io.IOException, FacesException
The default behavior of this method is to call
ViewHandler.renderView(javax.faces.context.FacesContext, javax.faces.component.UIViewRoot)
on the wrappedViewHandler
object.- Specified by:
renderView
in classViewHandler
- Parameters:
context
-FacesContext
for the current requestviewToRender
- the view to render- Throws:
java.io.IOException
- if an input/output error occursFacesException
- if a servlet error occurs- Since:
- 1.2
- See Also:
ViewHandler.renderView(javax.faces.context.FacesContext, javax.faces.component.UIViewRoot)
-
calculateCharacterEncoding
public java.lang.String calculateCharacterEncoding(FacesContext context)
The default behavior of this method is to call
ViewHandler.calculateCharacterEncoding(javax.faces.context.FacesContext)
on the wrappedViewHandler
object.- Overrides:
calculateCharacterEncoding
in classViewHandler
- Parameters:
context
- the Faces context.- Returns:
- the character encoding, or
null
- Since:
- 1.2
- See Also:
ViewHandler.calculateCharacterEncoding(javax.faces.context.FacesContext)
-
calculateLocale
public java.util.Locale calculateLocale(FacesContext context)
The default behavior of this method is to call
ViewHandler.calculateLocale(javax.faces.context.FacesContext)
on the wrappedViewHandler
object.- Specified by:
calculateLocale
in classViewHandler
- Parameters:
context
-FacesContext
for the current request- Returns:
- the locale.
- Since:
- 1.2
- See Also:
ViewHandler.calculateLocale(javax.faces.context.FacesContext)
-
deriveViewId
public java.lang.String deriveViewId(FacesContext context, java.lang.String requestViewId)
The default behavior of this method is to call
ViewHandler.deriveViewId(javax.faces.context.FacesContext, String)
on the wrappedViewHandler
object.- Overrides:
deriveViewId
in classViewHandler
- Parameters:
context
- theFacesContext
for this requestrequestViewId
- theviewId
to derive,- Returns:
- the derived view id.
- Since:
- 2.0
- See Also:
ViewHandler.deriveViewId(javax.faces.context.FacesContext, String)
-
deriveLogicalViewId
public java.lang.String deriveLogicalViewId(FacesContext context, java.lang.String requestViewId)
The default behavior of this method is to call
ViewHandler.deriveLogicalViewId(javax.faces.context.FacesContext, String)
on the wrappedViewHandler
object.- Overrides:
deriveLogicalViewId
in classViewHandler
- Parameters:
context
- theFacesContext
for this requestrequestViewId
- theviewId
to derive,- Returns:
- the derived logical view id.
- Since:
- 2.1
- See Also:
ViewHandler.deriveLogicalViewId(javax.faces.context.FacesContext, String)
-
calculateRenderKitId
public java.lang.String calculateRenderKitId(FacesContext context)
The default behavior of this method is to call
ViewHandler.calculateRenderKitId(javax.faces.context.FacesContext)
on the wrappedViewHandler
object.- Specified by:
calculateRenderKitId
in classViewHandler
- Parameters:
context
-FacesContext
for the current request- Returns:
- the render kit id.
- Since:
- 1.2
- See Also:
ViewHandler.calculateRenderKitId(javax.faces.context.FacesContext)
-
getActionURL
public java.lang.String getActionURL(FacesContext context, java.lang.String viewId)
The default behavior of this method is to call
ViewHandler.getActionURL(javax.faces.context.FacesContext, String)
on the wrappedViewHandler
object.- Specified by:
getActionURL
in classViewHandler
- Parameters:
context
-FacesContext
for this requestviewId
- View identifier of the desired view- Returns:
- the action url.
- Since:
- 1.2
- See Also:
ViewHandler.getActionURL(javax.faces.context.FacesContext, String)
-
getProtectedViewsUnmodifiable
public java.util.Set<java.lang.String> getProtectedViewsUnmodifiable()
The default behavior of this method is to call
ViewHandler.getProtectedViewsUnmodifiable()
on the wrappedViewHandler
object.- Overrides:
getProtectedViewsUnmodifiable
in classViewHandler
- Returns:
- the unmodifiable set of protected views.
- Since:
- 2.2
- See Also:
ViewHandler.getProtectedViewsUnmodifiable()
-
addProtectedView
public void addProtectedView(java.lang.String urlPattern)
The default behavior of this method is to call
ViewHandler.addProtectedView(java.lang.String)
on the wrappedViewHandler
object.- Overrides:
addProtectedView
in classViewHandler
- Parameters:
urlPattern
- the url-pattern to add.- Since:
- 2.2
- See Also:
ViewHandler.addProtectedView(java.lang.String)
-
removeProtectedView
public boolean removeProtectedView(java.lang.String urlPattern)
The default behavior of this method is to call
ViewHandler.removeProtectedView(java.lang.String)
on the wrappedViewHandler
object.- Overrides:
removeProtectedView
in classViewHandler
- Parameters:
urlPattern
- the url-pattern to remove.- Returns:
true
if in theSet
,false
otherwise.- Since:
- 2.2
- See Also:
ViewHandler.removeProtectedView(java.lang.String)
-
getRedirectURL
public java.lang.String getRedirectURL(FacesContext context, java.lang.String viewId, java.util.Map<java.lang.String,java.util.List<java.lang.String>> parameters, boolean includeViewParams)
The default behavior of this method is to call
ViewHandler.getRedirectURL(javax.faces.context.FacesContext, String, java.util.Map, boolean)
on the wrappedViewHandler
object.- Overrides:
getRedirectURL
in classViewHandler
- Parameters:
context
- The FacesContext processing this requestviewId
- The view identifier of the target pageparameters
- A mapping of parameter names to one or more valuesincludeViewParams
- A flag indicating whether view parameters should be encoded into this URL- Returns:
- the redirect URL.
- Since:
- 2.0
- See Also:
ViewHandler.getRedirectURL(javax.faces.context.FacesContext, String, java.util.Map, boolean)
-
getBookmarkableURL
public java.lang.String getBookmarkableURL(FacesContext context, java.lang.String viewId, java.util.Map<java.lang.String,java.util.List<java.lang.String>> parameters, boolean includeViewParams)
The default behavior of this method is to call
ViewHandler.getBookmarkableURL(javax.faces.context.FacesContext, String, java.util.Map, boolean)
on the wrappedViewHandler
object.- Overrides:
getBookmarkableURL
in classViewHandler
- Parameters:
context
- The FacesContext processing this requestviewId
- The view identifier of the target pageparameters
- A mapping of parameter names to one or more valuesincludeViewParams
- A flag indicating whether view parameters should be encoded into this URL- Returns:
- the bookmarkable URL.
- Since:
- 2.0
- See Also:
ViewHandler.getBookmarkableURL(javax.faces.context.FacesContext, String, java.util.Map, boolean)
-
getResourceURL
public java.lang.String getResourceURL(FacesContext context, java.lang.String path)
The default behavior of this method is to call
ViewHandler.getResourceURL(javax.faces.context.FacesContext, String)
on the wrappedViewHandler
object.- Specified by:
getResourceURL
in classViewHandler
- Parameters:
context
-FacesContext
for the current requestpath
- Resource path to convert to a URL- Returns:
- the resource URL.
- Since:
- 1.2
- See Also:
ViewHandler.getResourceURL(javax.faces.context.FacesContext, String)
-
getWebsocketURL
public java.lang.String getWebsocketURL(FacesContext context, java.lang.String channel)
The default behavior of this method is to call
ViewHandler.getWebsocketURL(FacesContext, String)
on the wrappedViewHandler
object.- Specified by:
getWebsocketURL
in classViewHandler
- Parameters:
context
-FacesContext
for the current request.channel
- The channel name of the websocket.- Returns:
- the websocket URL.
- Since:
- 2.3
- See Also:
ViewHandler.getWebsocketURL(FacesContext, String)
-
getViewDeclarationLanguage
public ViewDeclarationLanguage getViewDeclarationLanguage(FacesContext context, java.lang.String viewId)
The default behavior of this method is to call
ViewHandler.getViewDeclarationLanguage(javax.faces.context.FacesContext, java.lang.String)
on the wrappedViewHandler
object.- Overrides:
getViewDeclarationLanguage
in classViewHandler
- Parameters:
context
- theFacesContext
for this request.viewId
- the logical view id, as returned fromViewHandler.deriveLogicalViewId(javax.faces.context.FacesContext, java.lang.String)
for which theViewDeclarationLanguage
should be returned.- Returns:
- the ViewDeclarationLanguage, or null.
- Since:
- 2.0
-
getViews
public java.util.stream.Stream<java.lang.String> getViews(FacesContext context, java.lang.String path, ViewVisitOption... options)
The default behavior of this method is to call
ViewHandler.getViews(FacesContext, String, ViewVisitOption...)
on the wrappedViewHandler
object.- Overrides:
getViews
in classViewHandler
- Parameters:
context
- TheFacesContext
for this request.path
- The initial path from which to start looking for view ids.options
- The options to influence the traversal. SeeViewVisitOption
for details on those.- Returns:
- the
Stream
of view ids - Since:
- 2.3
-
getViews
public java.util.stream.Stream<java.lang.String> getViews(FacesContext context, java.lang.String path, int maxDepth, ViewVisitOption... options)
The default behavior of this method is to call
ViewHandler.getViews(FacesContext, String, int, ViewVisitOption...)
on the wrappedViewHandler
object.- Overrides:
getViews
in classViewHandler
- Parameters:
context
- TheFacesContext
for this request.path
- The initial path from which to start looking for view ids.maxDepth
- The absolute maximum depth of nested directories to visit counted from the root (/
).options
- The options to influence the traversal. SeeViewVisitOption
for details on those.- Returns:
- the
Stream
of view ids - Since:
- 2.3
-
writeState
public void writeState(FacesContext context) throws java.io.IOException
The default behavior of this method is to call
ViewHandler.writeState(javax.faces.context.FacesContext)
on the wrappedViewHandler
object.- Specified by:
writeState
in classViewHandler
- Parameters:
context
-FacesContext
for the current request- Throws:
java.io.IOException
- if an input/output error occurs- Since:
- 1.2
- See Also:
ViewHandler.writeState(javax.faces.context.FacesContext)
-
-