org.apache.myfaces.trinidadinternal.skin
Class RequestSkinWrapper

java.lang.Object
  org.apache.myfaces.trinidad.skin.Skin
      org.apache.myfaces.trinidadinternal.skin.RequestSkinWrapper

All Implemented Interfaces:

DocumentProviderSkin

public class RequestSkinWrapper
extends org.apache.myfaces.trinidad.skin.Skin
implements DocumentProviderSkin

This is a Skin decorator which is used to store request-specific skin state. For example, the set of icons to use varies from request to request, eg. based on the browser/platform. We cannot store such request-specific state on our shared Skin instances. Instead, SkinFactoryImpl wraps shared Skin instances in RequestSkinWrappers so that request-specific state can be stored locally in the wrapper. Currently, the request-specific state for a skin is the icon map and the skin property map. They are retrieved from the StyleProvider one time per request and stored here.

See Also:

FileSystemStyleCache

Constructor Summary

RequestSkinWrapper(org.apache.myfaces.trinidad.skin.Skin wrappedSkin)

Method Summary

void	addSkinAddition(org.apache.myfaces.trinidad.skin.SkinAddition skinAddition)
java.lang.String	getFamily()
org.apache.myfaces.trinidad.skin.Icon	getIcon(java.lang.String iconName)
org.apache.myfaces.trinidad.skin.Icon	getIcon(java.lang.String iconName, boolean resolveIcon)
java.lang.String	getId()
java.lang.Object	getProperty(java.lang.Object key)
java.lang.String	getRenderKitId()
java.util.List<org.apache.myfaces.trinidad.skin.SkinAddition>	getSkinAdditions()
java.util.Map<java.lang.String,java.lang.String>	getStyleClassMap(org.apache.myfaces.trinidad.context.RenderingContext arc)
StyleSheetDocument	getStyleSheetDocument(StyleContext styleContext) Implementation of DocumentProviderSkin.getStyleSheetDocument().
java.lang.String	getStyleSheetDocumentId(org.apache.myfaces.trinidad.context.RenderingContext arc)
java.lang.String	getStyleSheetName()
java.lang.String	getTranslatedString(org.apache.myfaces.trinidad.context.LocaleContext lContext, java.lang.String key)
java.lang.Object	getTranslatedValue(org.apache.myfaces.trinidad.context.LocaleContext lContext, java.lang.String key)
org.apache.myfaces.trinidad.skin.SkinVersion	getVersion()
org.apache.myfaces.trinidad.skin.Skin	getWrappedSkin() Returns the Skin that is wrapped by this request-specific wrapper skin.
boolean	isDirty()
void	registerIcon(java.lang.String iconName, org.apache.myfaces.trinidad.skin.Icon icon)
void	registerStyleSheet(java.lang.String styleSheetName) Deprecated. Use addSkinAddition instead
void	setDirty(boolean dirty)
void	setProperty(java.lang.Object key, java.lang.Object value)

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestSkinWrapper

public RequestSkinWrapper(org.apache.myfaces.trinidad.skin.Skin wrappedSkin)

Method Detail

getWrappedSkin

public org.apache.myfaces.trinidad.skin.Skin getWrappedSkin()

Returns the Skin that is wrapped by this request-specific wrapper skin.

getId

public java.lang.String getId()

Specified by:

getId in class org.apache.myfaces.trinidad.skin.Skin

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class org.apache.myfaces.trinidad.skin.Skin

getVersion

public org.apache.myfaces.trinidad.skin.SkinVersion getVersion()

Overrides:

getVersion in class org.apache.myfaces.trinidad.skin.Skin

getRenderKitId

public java.lang.String getRenderKitId()

Specified by:

getRenderKitId in class org.apache.myfaces.trinidad.skin.Skin

getStyleSheetDocumentId

public java.lang.String getStyleSheetDocumentId(org.apache.myfaces.trinidad.context.RenderingContext arc)

Specified by:

getStyleSheetDocumentId in class org.apache.myfaces.trinidad.skin.Skin

getStyleClassMap

public java.util.Map<java.lang.String,java.lang.String> getStyleClassMap(org.apache.myfaces.trinidad.context.RenderingContext arc)

Specified by:

getStyleClassMap in class org.apache.myfaces.trinidad.skin.Skin

getStyleSheetName

public java.lang.String getStyleSheetName()

Specified by:

getStyleSheetName in class org.apache.myfaces.trinidad.skin.Skin

getTranslatedString

public java.lang.String getTranslatedString(org.apache.myfaces.trinidad.context.LocaleContext lContext,
                                            java.lang.String key)
                                     throws java.util.MissingResourceException

Specified by:

getTranslatedString in class org.apache.myfaces.trinidad.skin.Skin

Throws:

java.util.MissingResourceException

getTranslatedValue

public java.lang.Object getTranslatedValue(org.apache.myfaces.trinidad.context.LocaleContext lContext,
                                           java.lang.String key)
                                    throws java.util.MissingResourceException

Specified by:

getTranslatedValue in class org.apache.myfaces.trinidad.skin.Skin

Throws:

java.util.MissingResourceException

getIcon

public org.apache.myfaces.trinidad.skin.Icon getIcon(java.lang.String iconName)

Specified by:

getIcon in class org.apache.myfaces.trinidad.skin.Skin

getIcon

public org.apache.myfaces.trinidad.skin.Icon getIcon(java.lang.String iconName,
                                                     boolean resolveIcon)

Specified by:

getIcon in class org.apache.myfaces.trinidad.skin.Skin

registerIcon

public void registerIcon(java.lang.String iconName,
                         org.apache.myfaces.trinidad.skin.Icon icon)

Specified by:

registerIcon in class org.apache.myfaces.trinidad.skin.Skin

getProperty

public java.lang.Object getProperty(java.lang.Object key)

Specified by:

getProperty in class org.apache.myfaces.trinidad.skin.Skin

setProperty

public void setProperty(java.lang.Object key,
                        java.lang.Object value)

Specified by:

setProperty in class org.apache.myfaces.trinidad.skin.Skin

registerStyleSheet

public void registerStyleSheet(java.lang.String styleSheetName)

Deprecated. Use addSkinAddition instead

Specified by:

registerStyleSheet in class org.apache.myfaces.trinidad.skin.Skin

addSkinAddition

public void addSkinAddition(org.apache.myfaces.trinidad.skin.SkinAddition skinAddition)

Specified by:

addSkinAddition in class org.apache.myfaces.trinidad.skin.Skin

getSkinAdditions

public java.util.List<org.apache.myfaces.trinidad.skin.SkinAddition> getSkinAdditions()

Specified by:

getSkinAdditions in class org.apache.myfaces.trinidad.skin.Skin

getStyleSheetDocument

public StyleSheetDocument getStyleSheetDocument(StyleContext styleContext)

Implementation of DocumentProviderSkin.getStyleSheetDocument().

Specified by:

getStyleSheetDocument in interface DocumentProviderSkin

isDirty

public boolean isDirty()

Specified by:

isDirty in class org.apache.myfaces.trinidad.skin.Skin

setDirty

public void setDirty(boolean dirty)

Specified by:

setDirty in class org.apache.myfaces.trinidad.skin.Skin