com.webmethods.caf.faces.view

Class SkinnableViewHandler

java.lang.Object

javax.faces.application.ViewHandler

javax.faces.application.ViewHandlerWrapper

com.webmethods.caf.faces.view.SkinnableViewHandler

All Implemented Interfaces:

FacesWrapper<ViewHandler>

public class SkinnableViewHandler
extends ViewHandlerWrapper

View handler which can resolve skinned properties.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALT_PREFIX
static String	INIT_PARAM_RESOLVE_SKINNED_RESOURCES Binding expression which indicates whether or not to resolve skinned resources for the current context.
static String	INIT_PARAM_SKINNED_RESOURCES_DIRECTORY Binding expression which indicates the directory containing skinned resources.
protected ViewHandler	m_parent
protected ValueExpression	m_resolveSkinnedResources
protected ValueExpression	m_skinnedResourcesDirectory
protected Map<String,String>	m_skinnedResourcesPaths
static String	SKIN_PREFIX

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
SkinnableViewHandler(ViewHandler parent) Standard ViewHandler constructor.

Method Summary

Modifier and Type	Method and Description
String	getResourceURL(FacesContext ctx, String path)
protected String	getSkinnedResourcePath(FacesContext ctx, String name) Returns the actual resource path for the specified skinned resource name, or null if the there is no resource for the specified name.
protected String	getSkinnedResourcesDirectory(FacesContext ctx) Returns the path to the directory in this war containing the skinned resources.
protected Map<String,String>	getSkinnedResourcesPaths(FacesContext ctx) Returns the map of skin names to actual resource paths.
ViewHandler	getWrapped()
protected boolean	resolveSkinnedResources(FacesContext ctx) Returns true to resolve skinned resources for the specified context; false to ignore skinned resources.

Methods inherited from class javax.faces.application.ViewHandlerWrapper

addProtectedView, calculateCharacterEncoding, calculateLocale, calculateRenderKitId, createView, 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_RESOLVE_SKINNED_RESOURCES

public static final String INIT_PARAM_RESOLVE_SKINNED_RESOURCES

Binding expression which indicates whether or not to resolve skinned resources for the current context.

See Also:

Constant Field Values

INIT_PARAM_SKINNED_RESOURCES_DIRECTORY

public static final String INIT_PARAM_SKINNED_RESOURCES_DIRECTORY

Binding expression which indicates the directory containing skinned resources.

See Also:

Constant Field Values

SKIN_PREFIX

public static final String SKIN_PREFIX

See Also:

Constant Field Values

ALT_PREFIX

public static final String ALT_PREFIX

See Also:

Constant Field Values

m_parent

protected ViewHandler m_parent

m_resolveSkinnedResources

protected ValueExpression m_resolveSkinnedResources

m_skinnedResourcesDirectory

protected ValueExpression m_skinnedResourcesDirectory

m_skinnedResourcesPaths

protected Map<String,String> m_skinnedResourcesPaths

Constructor Detail

SkinnableViewHandler

public SkinnableViewHandler(ViewHandler parent)

Standard ViewHandler constructor.

Method Detail

getWrapped

public ViewHandler getWrapped()

Specified by:

getWrapped in interface FacesWrapper<ViewHandler>

Overrides:

getWrapped in class ViewHandlerWrapper

getResourceURL

public String getResourceURL(FacesContext ctx,
                             String path)

Overrides:

getResourceURL in class ViewHandlerWrapper

resolveSkinnedResources

protected boolean resolveSkinnedResources(FacesContext ctx)

Returns true to resolve skinned resources for the specified context; false to ignore skinned resources.

getSkinnedResourcesDirectory

protected String getSkinnedResourcesDirectory(FacesContext ctx)

Returns the path to the directory in this war containing the skinned resources. Use forward-slashes ("/") for path separators. Null, empty string (""), or forward-slash ("/") indicates the root of the war.

getSkinnedResourcesPaths

protected Map<String,String> getSkinnedResourcesPaths(FacesContext ctx)

Returns the map of skin names to actual resource paths. Ex: {images/move-left.gif=/myskin/images/move-left.gif, images/move-right.gif=/myskin/images/move-right.gif}

getSkinnedResourcePath

protected String getSkinnedResourcePath(FacesContext ctx,
                                        String name)

Returns the actual resource path for the specified skinned resource name, or null if the there is no resource for the specified name. For example, might return "/myskin/images/move-right.gif" for "images/move-right.gif" name. Note that the actual resource path MUST NOT start with "/skin/".