com.webmethods.caf.faces.view

Class BaseViewHandler

java.lang.Object

javax.faces.application.ViewHandler

javax.faces.application.ViewHandlerWrapper

com.webmethods.caf.faces.view.BaseViewHandler

All Implemented Interfaces:

FacesWrapper<ViewHandler>

Direct Known Subclasses:

XMLViewHandler

public abstract class BaseViewHandler
extends ViewHandlerWrapper

Base faces ViewHandler. Only handles views whose ID matches filter. Optionally caches view builder apparatus.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FILTER_KEY
static String	INIT_PARAM_CACHE
static String	INIT_PARAM_FILTER
static String	INJECT_STATE
protected Map<String,ViewBuilder>	m_builders
protected Pattern	m_filter
protected ViewHandler	m_parent
protected Boolean	m_useCache
protected static int	MAX_VIEWS
static String	NO_RENDER
static String	VIEW_FRAGMENT
static String	VIEW_FRAGMENT_CLIENT_ID Deprecated.

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 and Description
BaseViewHandler(ViewHandler parent) Standard ViewHandler constructor.

Method Summary

Modifier and Type	Method and Description
void	clearBuilderCache() Clears entire ViewBuilder cache.
void	clearBuilderFromCache(String viewId) Removes cached ViewBuilder for view ID.
abstract ViewBuilder	createBuilder(FacesContext ctx, String viewId)
UIViewRoot	createView(FacesContext ctx, String viewId)
ViewBuilder	getBuilderFromCache(String viewId)
protected Pattern	getFilter(FacesContext ctx)
String	getResourceURL(FacesContext ctx, String path)
ViewHandler	getWrapped()
boolean	matchesFilter(FacesContext ctx, String viewId)
void	putBuilderIntoCache(String viewId, ViewBuilder builder) Caches ViewBuilder for view ID.
boolean	useCache() True to use ViewBuilder cache.

Methods inherited from class javax.faces.application.ViewHandlerWrapper

addProtectedView, calculateCharacterEncoding, calculateLocale, calculateRenderKitId, deriveLogicalViewId, deriveViewId, getActionURL, getBookmarkableURL, getProtectedViewsUnmodifiable, getRedirectURL, getViewDeclarationLanguage, initView, removeProtectedView, renderView, restoreView, writeState

Methods inherited from class java.lang.Object

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

Field Detail

INIT_PARAM_FILTER

public static final String INIT_PARAM_FILTER

See Also:

Constant Field Values

INIT_PARAM_CACHE

public static final String INIT_PARAM_CACHE

See Also:

Constant Field Values

VIEW_FRAGMENT

public static final String VIEW_FRAGMENT

See Also:

Constant Field Values

VIEW_FRAGMENT_CLIENT_ID

@Deprecated
public static final String VIEW_FRAGMENT_CLIENT_ID

Deprecated.

See Also:

Constant Field Values

INJECT_STATE

public static final String INJECT_STATE

See Also:

Constant Field Values

NO_RENDER

public static final String NO_RENDER

See Also:

Constant Field Values

MAX_VIEWS

protected static final int MAX_VIEWS

See Also:

Constant Field Values

FILTER_KEY

public static final String FILTER_KEY

See Also:

Constant Field Values

m_parent

protected ViewHandler m_parent

m_builders

protected Map<String,ViewBuilder> m_builders

m_filter

protected Pattern m_filter

m_useCache

protected Boolean m_useCache

Constructor Detail

BaseViewHandler

public BaseViewHandler(ViewHandler parent)

Standard ViewHandler constructor.

Method Detail

getWrapped

public ViewHandler getWrapped()

Specified by:

getWrapped in interface FacesWrapper<ViewHandler>

Overrides:

getWrapped in class ViewHandlerWrapper

createView

public UIViewRoot createView(FacesContext ctx,
                             String viewId)

Overrides:

createView in class ViewHandlerWrapper

getResourceURL

public String getResourceURL(FacesContext ctx,
                             String path)

Overrides:

getResourceURL in class ViewHandlerWrapper

getBuilderFromCache

public ViewBuilder getBuilderFromCache(String viewId)

Returns:

Cached ViewBuilder for view ID or null.

putBuilderIntoCache

public void putBuilderIntoCache(String viewId,
                                ViewBuilder builder)

Caches ViewBuilder for view ID.

clearBuilderFromCache

public void clearBuilderFromCache(String viewId)

Removes cached ViewBuilder for view ID. Does nothing if not cached.

clearBuilderCache

public void clearBuilderCache()

Clears entire ViewBuilder cache.

useCache

public boolean useCache()

True to use ViewBuilder cache.

createBuilder

public abstract ViewBuilder createBuilder(FacesContext ctx,
                                          String viewId)

Returns:

ViewBuilder for view ID.

matchesFilter

public boolean matchesFilter(FacesContext ctx,
                             String viewId)

Returns:

True if the view ID matches this handler's filter.

getFilter

protected Pattern getFilter(FacesContext ctx)

Returns:

Regexp that matches view IDs that this handler should handle.