|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.myfaces.trinidad.skin.Skin
public abstract class Skin
Defines the components (icons, styles, etc) which are used to implement a particular skin.
SkinFactory| Constructor Summary | |
|---|---|
Skin()
|
|
| Method Summary | |
|---|---|
abstract void |
addSkinAddition(SkinAddition skinAddition)
Adds a SkinAddition on this Skin. |
abstract String |
getFamily()
Returns the name of the skin "family" for this skin. |
abstract Icon |
getIcon(String iconName)
Our renderers call this to get the icon. |
abstract Icon |
getIcon(String iconName,
boolean resolveIcon)
Returns an Icon object; can be a ReferenceIcon. |
abstract String |
getId()
Returns an string identifier which uniquely identies this Skin implementation. |
abstract Object |
getProperty(Object key)
Retrieves a property that was set via a call to setProperty(). |
abstract String |
getRenderKitId()
Returns the renderKitId for the Skin. |
abstract List<SkinAddition> |
getSkinAdditions()
Gets a List of SkinAdditions that have been added on this Skin. |
abstract Map<String,String> |
getStyleClassMap(RenderingContext arc)
Returns the style class map, or null if there is no map. |
abstract String |
getStyleSheetDocumentId(RenderingContext arc)
Returns the id of the Skin's stylesheet document. |
abstract String |
getStyleSheetName()
Returns the name of the style sheet for this Skin. |
abstract String |
getTranslatedString(LocaleContext lContext,
String key)
Returns a translated String in the LocaleContext's translation Locale. |
abstract Object |
getTranslatedValue(LocaleContext lContext,
String key)
Returns a translated value in the LocaleContext's translation Locale. |
abstract boolean |
isDirty()
Check to see if this Skin has been marked dirty. |
abstract void |
registerIcon(String iconName,
Icon icon)
Registers an Icon for the specified icon name. |
abstract void |
registerStyleSheet(String styleSheetName)
Deprecated. Use addSkinAddition(SkinAddition) instead. |
abstract void |
setDirty(boolean dirty)
Sets the dirty flag of the Skin. |
abstract void |
setProperty(Object key,
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 Skin()
| Method Detail |
|---|
public abstract String getId()
SkinFactory.getSkin(javax.faces.context.FacesContext, java.lang.String)public abstract String getFamily()
public abstract String getRenderKitId()
public abstract String getStyleSheetDocumentId(RenderingContext arc)
public abstract Map<String,String> getStyleClassMap(RenderingContext arc)
public abstract String getStyleSheetName()
public abstract String getTranslatedString(LocaleContext lContext,
String key)
throws MissingResourceException
MissingResourceException
public abstract Object getTranslatedValue(LocaleContext lContext,
String key)
throws MissingResourceException
lContext - The LocaleContext which provides the translation Locale.
Cannot be null.key - The key of the translation to retrieve. Cannot be null.
NullPointerException - if lContext or key is null.
MissingResourceExceptionpublic abstract Icon getIcon(String iconName)
public abstract Icon getIcon(String iconName,
boolean resolveIcon)
iconName - The name of the icon to retrieve. Cannot be null
NullPointerException - if iconName is null.public abstract Object getProperty(Object key)
public abstract void setProperty(Object key,
Object value)
public abstract void registerIcon(String iconName,
Icon icon)
iconName - The name of the icon. Cannot be null.icon - The Icon to register.
NullPointerException - if iconName is null.@Deprecated public abstract void registerStyleSheet(String styleSheetName)
styleSheetName - The name of the style sheet which
defines the extension's styles.
NullPointerException - if styleSheetName is null.addSkinAddition(SkinAddition)public abstract void addSkinAddition(SkinAddition skinAddition)
skinAddition - The SkinAddition object to add to the Skin.
NullPointerException - if SkinAddition is null.public abstract List<SkinAddition> getSkinAdditions()
public abstract boolean isDirty()
public abstract void setDirty(boolean dirty)
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||