public abstract class SkinFactory extends Object
SkinProvider, 
Skin, 
SkinMetadata| Constructor and Description | 
|---|
| SkinFactory() | 
| Modifier and Type | Method and Description | 
|---|---|
| abstract void | addSkin(String skinId,
       Skin skin)Deprecated. 
 use SkinProvider SPI to deal with externals skins Implementing SkinProvider and
 exposing skins using SkinProvider#getSkin() method is recommended than using this API to make
 skins available at runtime. | 
| Skin | createSkin(javax.faces.context.ExternalContext externalContext,
          SkinMetadata skinMetadata)Creates a Skin based on the supplied base skin information and skinMetadata information. | 
| Skin | createSkin(javax.faces.context.ExternalContext externalContext,
          SkinMetadata baseSkinMetadata,
          SkinMetadata skinMetadata)Creates a Skin based on the supplied base skin information and skinMetadata information. | 
| static SkinFactory | getFactory()Retrieve the current SkinFactory. | 
| abstract Skin | getSkin(javax.faces.context.FacesContext context,
       String skinId)Deprecated. 
 use SkinProvider#getSkin method to query skins | 
| abstract Skin | getSkin(javax.faces.context.FacesContext context,
       String family,
       String renderKitId)Deprecated. 
 use SkinProvider#getSkin method to query skins | 
| abstract Skin | getSkin(javax.faces.context.FacesContext context,
       String family,
       String renderKitId,
       String version)Deprecated. 
 use SkinProvider#getSkin method to query skins | 
| abstract Iterator<String> | getSkinIds()Deprecated. 
 use SkinProvider#getSkinMetadata to get the list of skins supported | 
| void | reload()Deprecated. 
 use SkinProvider SPI to deal with externals skins this functionality will now be
 replaced by having the SkinProvider implementations reloading skins themselves as and when
 required. | 
| static void | setFactory(SkinFactory factory)Store the current SkinFactory. | 
public static SkinFactory getFactory()
public static void setFactory(SkinFactory factory)
public Skin createSkin(javax.faces.context.ExternalContext externalContext, SkinMetadata baseSkinMetadata, SkinMetadata skinMetadata)
externalContext - valid ExternalContextbaseSkinMetadata - SkinMetadata metadata to find the base skin for the new skin to
                         be created. The user should pass enough information to pick the base
                         skin with id / family / version / renderkit. Base skin is obtained
                         using SkinProvider#getSkin API.skinMetadata - SkinMetadata metadata to create new Skin. The user should pass
                         all information such as id, family, version, renderkit, styleSheetName,
                         features, metadata etc. for the new skin.Skin object created using the skinMetadata SkinMetadata
 suppliedIllegalArgumentException - if the baseSkinId contained in the supplied skinMetadata did
                                  not match the id of the baseSkin obtained using
                                  baseSkinMetadataClassCastException - if SkinProvider does not provide as matching base skin as per
                                  metadata passed in baseSkinMetadatapublic Skin createSkin(javax.faces.context.ExternalContext externalContext, SkinMetadata skinMetadata)
externalContext - valid ExternalContextskinMetadata - SkinMetadata metadata to create new Skin. The user should
                        pass all information such as baseSkinId, id, family, version, renderkit,
                        styleSheetName, features, metadata etc. for the new skin. baseSkinId is
                        mandatory, since it is used to query the base skin for the new skin
                        using SkinProvider#getSkin API.Skin object created using the skinMetadata SkinMetadata
 suppliedIllegalArgumentException - if the baseSkinId contained in the supplied skinMetadata did
                                  not match the id of the baseSkin obtained from
                                  SkinProvider#getSkin@Deprecated public void reload()
@Deprecated public abstract void addSkin(String skinId, Skin skin)
Register the specified Skin instance, associated with the specified
 skinId, to be supported by this SkinFactory, replacing any previously
 registered Skin for this identifier.
@Deprecated public abstract Skin getSkin(javax.faces.context.FacesContext context, String skinId)
Return a Skin instance for the specified skinId. If there is no registered Skin for the specified identifier, return null.  The set of available skin
 identifiers is available via the getSkinIds() method.
context - FacesContext for the request currently being processed, or null if
                none is available.skinId - Skin identifier of the requested Skin instance@Deprecated public abstract Skin getSkin(javax.faces.context.FacesContext context, String family, String renderKitId)
@Deprecated public abstract Skin getSkin(javax.faces.context.FacesContext context, String family, String renderKitId, String version)
Return a Skin instance for the specified skinFamily and renderKitId, and skin
 version. The best matched skin is returned. If there is no registered Skin for the
 specified identifier, return null.  The set of available skin identifiers is
 available via the getSkinIds() method.
context - FacesContext for the request currently being processed, or null
                    if none is available.family - family of the requested Skin instancerenderKitId - RenderKit identifier of the requested Skin instanceversion - A string that denotes the skin version name. It can be "default" or the name
                    of the version (see the Skin's SkinVersion#getName) or null which returns
                    the skin with no version set.@Deprecated public abstract Iterator<String> getSkinIds()
Return an Iterator over the set of skin identifiers registered with this
 factory. 
Copyright © 2001-2017 The Apache Software Foundation. All Rights Reserved.