public final class SkinMetadata extends Object
SkinMetadata mySkinMetadata = new SkinMetadata.Builder()
.baseSkinId("alta-v1.desktop")
.id("mySkin.desktop")
.family("mySkin")
.renderKitId(SkinMetadata.RenderKit.DESKTOP)
.styleSheetName("my/css/location.css")
.version(new SkinVersion("v1"))
.build();
SkinMetadata is used mainly in two ways: First, as a representation of a Skin. Second, as a means
to query Skins.
SkinProvider#getSkinMetadata returns a collection of SkinMetadata. The collection returned from
this method can be built by the SkinProvider implementations beforehand, so that it can publish
the information about the skins that it supports to callers. Creation of SkinMetadata is a far
less costly process than creating a Skin. SkinMetadata created for this purpose should contain
all relevant information. SkinProviders can also use SkinMetadata objects to create the actual
Skin objects using SkinFactory#createSkin API as well. In this case, SkinMetadata should be well
formed with all relevant information so that SkinFactory can create the skin.
SkinMetadata is used as query object to retrieve Skin from a SkinProvider#getSkin. Querying Skins
are based on id, family, version and renderkit. For querying Skins, user should set either id or
family as mandatory. Other information (even if present) are not relevant while searching for a
skin.
SkinProvider
,
SkinMetadata.Builder
,
Skin
,
SkinFeatures
,
CustomMetadata
Modifier and Type | Class and Description |
---|---|
static class |
SkinMetadata.Builder
convenience builder class for SkinMetadata SkinMetadata object can be created using this:
|
static class |
SkinMetadata.RenderKitId
Enumeration representing RenderKit
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object o) |
String |
getBaseSkinId() |
String |
getFamily() |
SkinFeatures |
getFeatures() |
String |
getId() |
CustomMetadata |
getMetadata() |
String |
getRenderKitId() |
String |
getResourceBundleName() |
String |
getStyleSheetName() |
javax.el.ValueExpression |
getTranslationSource() |
SkinVersion |
getVersion() |
int |
hashCode() |
String |
toString() |
public String getId()
public String getFamily()
public String getRenderKitId()
RenderKit
id of the Skinpublic SkinVersion getVersion()
SkinVersion
of the Skinpublic String getStyleSheetName()
NameResolver
implementation.public String getResourceBundleName()
public javax.el.ValueExpression getTranslationSource()
public String getBaseSkinId()
public SkinFeatures getFeatures()
SkinFeatures
for this Skinpublic CustomMetadata getMetadata()
CustomMetadata
for this SkinCopyright © 2001-2017 The Apache Software Foundation. All Rights Reserved.