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 push the implementation being wrapped to the constructor and use
getWrapped to access the instance being wrapped.
| Modifier and Type | Field and Description |
|---|---|
| private ViewHandler |
| Access | Constructor and Description |
|---|---|
| public | ViewHandlerWrapper(ViewHandler
The implementation being wrapped. wrapped)If this view handler has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. |
| public |
| Modifier and Type | Method and Description |
|---|---|
| public void | addProtectedView(String
the url-pattern to add. urlPattern)Overrides javax.
The default behavior of this method is to call |
| public String | calculateCharacterEncoding(FacesContext
the Faces context. context)Overrides javax.
The default behavior of this method is to call
|
| public Locale | calculateLocale(FacesContext
FacesContext for the current requestImplements abstract javax.
The default behavior of this method is to call
|
| public String | calculateRenderKitId(FacesContext
FacesContext for the current requestImplements abstract javax.
The default behavior of this method is to call
|
| public UIViewRoot | createView(FacesContext
the Faces context. context, String the view id. viewId)Implements abstract javax.
The default behavior of this method is to call
|
| public String | deriveLogicalViewId(FacesContext
the context, String FacesContext for this requestthe requestViewId)viewId to derive,Overrides javax.
The default behavior of this method is to call
|
| public String | deriveViewId(FacesContext
the context, String FacesContext for this requestthe requestViewId)viewId to derive,Overrides javax.
The default behavior of this method is to call
|
| public String | getActionURL(FacesContext
FacesContext for this requestView identifier of the desired view viewId)Implements abstract javax.
The default behavior of this method is to call
|
| public String | getBookmarkableURL(FacesContext
The FacesContext processing this request context, String The view identifier of the target page viewId, Map<String, List<String>> A mapping of parameter names to one or more values parameters, boolean A flag indicating whether view parameters should be encoded into
this URL includeViewParams)Overrides javax.
The default behavior of this method is to call
|
| public Set | getProtectedViewsUnmodifiable()
Overrides javax.
The default behavior of this method is to call
|
| public String | getRedirectURL(FacesContext
The FacesContext processing this request context, String The view identifier of the target page viewId, Map<String, List<String>> A mapping of parameter names to one or more values parameters, boolean A flag indicating whether view parameters should be encoded into
this URL includeViewParams)Overrides javax.
The default behavior of this method is to call
|
| public String | getResourceURL(FacesContext
FacesContext for the current requestResource path to convert to a URL path)Implements abstract javax.
The default behavior of this method is to call
|
| public ViewDeclarationLanguage | getViewDeclarationLanguage(FacesContext
the context, String FacesContext for this request.the logical view id, as returned from
viewId)deriveLogicalViewId for which the ViewDeclarationLanguage
should be returned.Overrides javax.
The default behavior of this method is to call |
| public Stream | getViews(FacesContext
The context, String FacesContext for this request.The initial path from which to start looking for view ids. path, ViewVisitOption... The options to influence the traversal. See options)ViewVisitOption for
details on those.Overrides javax.
The default behavior of this method is to call
|
| public Stream | getViews(FacesContext
The context, String FacesContext for this request.The initial path from which to start looking for view ids. path, int The absolute maximum depth of nested directories to visit counted from the
root ( maxDepth, ViewVisitOption... /).The options to influence the traversal. See options)ViewVisitOption for
details on those.Overrides javax.
The default behavior of this method is to call
|
| public String | getWebsocketURL(FacesContext
FacesContext for the current request.The channel name of the websocket. channel)Implements abstract javax.
The default behavior of this method is to call
|
| public ViewHandler | getWrapped()
Implements javax. A class that implements this interface uses this method to return an instance of the class being wrapped. |
| public void | initView(FacesContext
the Faces context. context)Overrides javax.
The default behavior of this method is to call |
| public boolean | removeProtectedView(String
the url-pattern to remove. urlPattern)Overrides javax.
The default behavior of this method is to call |
| public void | renderView(FacesContext
FacesContext for the current requestthe view to render viewToRender)Implements abstract javax.
The default behavior of this method is to call
|
| public UIViewRoot | restoreView(FacesContext
FacesContext for the current requestthe view identifier for the current request viewId)Implements abstract javax.
The default behavior of this method is to call
|
| public void | writeState(FacesContext
FacesContext for the current requestImplements abstract javax.
The default behavior of this method is to call
|
| wrapped | back to summary |
|---|---|
| private ViewHandler wrapped | |
| ViewHandlerWrapper | back to summary |
|---|---|
| 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
| |
| ViewHandlerWrapper | back to summary |
|---|---|
| public ViewHandlerWrapper()
Deprecated Use the other constructor taking the implementation being wrapped.
| |
| addProtectedView | back to summary |
|---|---|
| public void addProtectedView(String urlPattern) Overrides javax.
The default behavior of this method is to call
| |
| calculateCharacterEncoding | back to summary |
|---|---|
| public String calculateCharacterEncoding(FacesContext context) Overrides javax.
The default behavior of this method is to call
| |
| calculateLocale | back to summary |
|---|---|
| public Locale calculateLocale(FacesContext context) Implements abstract javax.
The default behavior of this method is to call
| |
| calculateRenderKitId | back to summary |
|---|---|
| public String calculateRenderKitId(FacesContext context) Implements abstract javax.
The default behavior of this method is to call
| |
| createView | back to summary |
|---|---|
| public UIViewRoot createView(FacesContext context, String viewId) Implements abstract javax.
The default behavior of this method is to call
| |
| deriveLogicalViewId | back to summary |
|---|---|
| public String deriveLogicalViewId(FacesContext context, String requestViewId) Overrides javax.
The default behavior of this method is to call
| |
| deriveViewId | back to summary |
|---|---|
| public String deriveViewId(FacesContext context, String requestViewId) Overrides javax.
The default behavior of this method is to call
| |
| getActionURL | back to summary |
|---|---|
| public String getActionURL(FacesContext context, String viewId) Implements abstract javax.
The default behavior of this method is to call
| |
| getProtectedViewsUnmodifiable | back to summary |
|---|---|
| public Set Overrides javax.
The default behavior of this method is to call
| |
| getResourceURL | back to summary |
|---|---|
| public String getResourceURL(FacesContext context, String path) Implements abstract javax.
The default behavior of this method is to call
| |
| getViewDeclarationLanguage | back to summary |
|---|---|
| public ViewDeclarationLanguage getViewDeclarationLanguage(FacesContext context, String viewId) Overrides javax.
The default behavior of this method is to call
| |
| getViews | back to summary |
|---|---|
| public Stream Overrides javax.
The default behavior of this method is to call
| |
| getViews | back to summary |
|---|---|
| public Stream Overrides javax.
The default behavior of this method is to call
| |
| getWebsocketURL | back to summary |
|---|---|
| public String getWebsocketURL(FacesContext context, String channel) Implements abstract javax.
The default behavior of this method is to call
| |
| getWrapped | back to summary |
|---|---|
| public ViewHandler getWrapped() Implements javax. Doc from javax. A class that implements this interface uses this method to return an instance of the class being wrapped.
| |
| initView | back to summary |
|---|---|
| public void initView(FacesContext context) throws FacesException Overrides javax.
The default behavior of this method is to call
| |
| removeProtectedView | back to summary |
|---|---|
| public boolean removeProtectedView(String urlPattern) Overrides javax.
The default behavior of this method is to call
| |
| renderView | back to summary |
|---|---|
| public void renderView(FacesContext context, UIViewRoot viewToRender) throws IOException, FacesException Implements abstract javax.
The default behavior of this method is to call
| |
| restoreView | back to summary |
|---|---|
| public UIViewRoot restoreView(FacesContext context, String viewId) Implements abstract javax.
The default behavior of this method is to call
| |
| writeState | back to summary |
|---|---|
| public void writeState(FacesContext context) throws IOException Implements abstract javax.
The default behavior of this method is to call
| |