|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.myfaces.trinidad.skin.Skin
org.apache.myfaces.trinidadinternal.skin.SkinImpl
public abstract class SkinImpl
Defines the components (icons, styles, etc) which are used to implement a particular skin.
SkinFactory
,
org.apache.myfaces.trinidadinternal.ui.UIXRenderingContext#getSkinFactory
Constructor Summary | |
---|---|
SkinImpl()
|
Method Summary | |
---|---|
protected abstract java.lang.String |
getBundleName()
Returns the name of the ResourceBundle for the Skin. |
java.lang.String |
getFamily()
Returns the name of the skin "family" for this skin. |
org.apache.myfaces.trinidad.skin.Icon |
getIcon(java.lang.String iconName)
Our renderers call this to get the icon. |
org.apache.myfaces.trinidad.skin.Icon |
getIcon(java.lang.String iconName,
boolean resolveIcon)
Returns an Icon object; can be a ReferenceIcon. |
java.lang.String |
getId()
Returns an string identifier which uniquely identies this Skin implementation. |
java.lang.Object |
getProperty(java.lang.Object key)
Retrieves a property that was set via a call to setProperty(). |
java.lang.String |
getRenderKitId()
Returns the renderKitId for the Skin. |
java.util.Map<java.lang.String,java.lang.String> |
getStyleClassMap(org.apache.myfaces.trinidad.context.RenderingContext arc)
Returns the style class map, or null if there is no map. |
StyleSheetDocument |
getStyleSheetDocument(StyleContext context)
Returns the StyleSheetDocument object which defines all of the styles for this Skin, including any styles that are contributed by UIExtensions. |
abstract java.lang.String |
getStyleSheetName()
Returns the name of the XSS style sheet for this Skin. |
java.lang.String |
getTranslatedString(org.apache.myfaces.trinidad.context.LocaleContext lContext,
java.lang.String key)
Returns a translated String in the LocaleContext's translation Locale. |
java.lang.Object |
getTranslatedValue(org.apache.myfaces.trinidad.context.LocaleContext lContext,
java.lang.String key)
Returns a translated value in the LocaleContext's translation Locale. |
void |
registerIcon(java.lang.String iconName,
org.apache.myfaces.trinidad.skin.Icon icon)
Registers an Icon for the specified icon name. |
void |
registerStyleSheet(java.lang.String styleSheetName)
Registers a style sheet which defines extension-specific styles. |
void |
setProperty(java.lang.Object key,
java.lang.Object value)
Sets a value for the specified property key. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SkinImpl()
Method Detail |
---|
public java.lang.String getId()
getId
in class org.apache.myfaces.trinidad.skin.Skin
org.apache.myfaces.trinidadinternal.skin.SkinFactory#getSkin
public java.lang.String getFamily()
getFamily
in class org.apache.myfaces.trinidad.skin.Skin
public java.lang.String getRenderKitId()
getRenderKitId
in class org.apache.myfaces.trinidad.skin.Skin
public abstract java.lang.String getStyleSheetName()
getStyleSheetName
in class org.apache.myfaces.trinidad.skin.Skin
public java.lang.String getTranslatedString(org.apache.myfaces.trinidad.context.LocaleContext lContext, java.lang.String key) throws java.util.MissingResourceException
getTranslatedString
in class org.apache.myfaces.trinidad.skin.Skin
java.util.MissingResourceException
public java.lang.Object getTranslatedValue(org.apache.myfaces.trinidad.context.LocaleContext lContext, java.lang.String key) throws java.util.MissingResourceException
getTranslatedValue
in class org.apache.myfaces.trinidad.skin.Skin
lContext
- The LocaleContext which provides the translation Locale.
Cannot be null.key
- The key of the translation to retrieve. Cannot be null.
java.lang.NullPointerException
- if lContext or key is null.
java.util.MissingResourceException
protected abstract java.lang.String getBundleName()
public org.apache.myfaces.trinidad.skin.Icon getIcon(java.lang.String iconName)
getIcon
in class org.apache.myfaces.trinidad.skin.Skin
public org.apache.myfaces.trinidad.skin.Icon getIcon(java.lang.String iconName, boolean resolveIcon)
getIcon
in class org.apache.myfaces.trinidad.skin.Skin
iconName
- The name of the icon to retrieve. Cannot be null
java.lang.NullPointerException
- if iconName is null.public void registerIcon(java.lang.String iconName, org.apache.myfaces.trinidad.skin.Icon icon)
registerIcon
in class org.apache.myfaces.trinidad.skin.Skin
iconName
- The name of the icon. Cannot be null.icon
- The Icon to register.
java.lang.NullPointerException
- if iconName is null.public void registerStyleSheet(java.lang.String styleSheetName)
registerStyleSheet
in class org.apache.myfaces.trinidad.skin.Skin
styleSheetName
- The name of the style sheet which
defines the extension's styles. This style sheet
should be installed under the directory specified by
Configuration.STYLES_DIRECTORY path.
java.lang.NullPointerException
- if styleSheetName is null.getStyleSheetDocument(org.apache.myfaces.trinidadinternal.style.StyleContext)
public java.util.Map<java.lang.String,java.lang.String> getStyleClassMap(org.apache.myfaces.trinidad.context.RenderingContext arc)
getStyleClassMap
in class org.apache.myfaces.trinidad.skin.Skin
arc
- RenderingContext
public StyleSheetDocument getStyleSheetDocument(StyleContext context)
public java.lang.Object getProperty(java.lang.Object key)
getProperty
in class org.apache.myfaces.trinidad.skin.Skin
public void setProperty(java.lang.Object key, java.lang.Object value)
setProperty
in class org.apache.myfaces.trinidad.skin.Skin
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |