java.lang.Object
- org.ametys.web.skin.Skin

```
public class Skin
extends Object
```
A skin

Field Summary

Fields
Modifier and Type	Field	Description
`protected boolean`	`_abstract`	Is the skin abstract
`protected I18nizableText`	`_description`	The skin description
`protected String`	`_id`	The skin id (e.g.
`protected I18nizableText`	`_label`	The skin name
`protected String`	`_largeImage`	The skin thumbnail 48x48
`protected long`	`_lastConfUpdate`	The last time the file was loaded
`private static org.slf4j.Logger`	`_logger`
`protected String`	`_mediumImage`	The skin thumbnail 32x32
`protected boolean`	`_modifiable`	Is the skin modifiable
`protected List<String>`	`_parents`	Parents of the skin in the inheritance process
`protected Path`	`_path`	The skin root path
`protected SkinsManager`	`_skinsManager`	The skins manager to access components
`protected String`	`_smallImage`	The skin thumbnail 16x16
`protected Map<String,SkinTemplate>`	`_templates`	The map of templates id and associated templates
`(package private) static String`	`CONF_PATH`
`(package private) static String`	`TEMPLATES_PATH`

Constructor Summary

Constructors
Constructor Description

Skin(String id, Path skinPath, boolean modifiable, SkinsManager skinsManager)
Creates a skin

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`private I18nizableText`	`_configureI18n(Configuration child, I18nizableText defaultValue)`
`private String`	`_configureThumbnail(String value, String defaultImage)`
`protected void`	`_defaultValues()`	The configuration default values (if configuration file does not exist or is unreadable)
`private boolean`	`_isATemplate(TraversableSource path)`
`private List<String>`	`_parseParents(String parents)`
`void`	`dispose()`	Dispose skin component
`I18nizableText`	`getDescription()`	The skin description
`String`	`getId()`	The skin id
`I18nizableText`	`getLabel()`	The skin label
`String`	`getLargeImage()`	The large image file uri
`String`	`getMediumImage()`	The medium image file uri
`List<String>`	`getParents()`	Get the parent skins from the inheritance point of view.
`Path`	`getRawPath()`	Get the skin's path.
`String`	`getSmallImage()`	The small image file uri
`SkinTemplate`	`getTemplate(String id)`	Get a template
`Set<String>`	`getTemplates()`	Get the list of existing templates
`boolean`	`isAbstract()`	Is the skin abstract?
`boolean`	`isConfigurable()`	Is the skin modifiable?
`boolean`	`isModifiable()`	Is the skin modifiable?
`void`	`refreshValues()`	Refresh the configuration values

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CONF_PATH
```
static final String CONF_PATH
```
    See Also:
    
    Constant Field Values
  - TEMPLATES_PATH
```
static final String TEMPLATES_PATH
```
    See Also:
    
    Constant Field Values
  - _logger
```
private static org.slf4j.Logger _logger
```
  - _id
```
protected String _id
```
    The skin id (e.g. the directory name)
  - _path
```
protected Path _path
```
    The skin root path
  - _label
```
protected I18nizableText _label
```
    The skin name
  - _description
```
protected I18nizableText _description
```
    The skin description
  - _smallImage
```
protected String _smallImage
```
    The skin thumbnail 16x16
  - _mediumImage
```
protected String _mediumImage
```
    The skin thumbnail 32x32
  - _largeImage
```
protected String _largeImage
```
    The skin thumbnail 48x48
  - _templates
```
protected Map<String,SkinTemplate> _templates
```
    The map of templates id and associated templates
  - _lastConfUpdate
```
protected long _lastConfUpdate
```
    The last time the file was loaded
  - _modifiable
```
protected boolean _modifiable
```
    Is the skin modifiable
  - _abstract
```
protected boolean _abstract
```
    Is the skin abstract
  - _parents
```
protected List<String> _parents
```
    Parents of the skin in the inheritance process
  - _skinsManager
```
protected SkinsManager _skinsManager
```
    The skins manager to access components
- Constructor Detail
  - Skin
```
public Skin(String id,
            Path skinPath,
            boolean modifiable,
            SkinsManager skinsManager)
```
    Creates a skin
    
    Parameters:
    
    id - The id of the skin (e.g. the directory name)
    
    skinPath - The skin root path
    
    modifiable - Is this skin modifiable?
    
    skinsManager - The skins manager
- Method Detail
  - dispose
```
public void dispose()
```
    Dispose skin component
  - isModifiable
```
public boolean isModifiable()
```
    Is the skin modifiable?
    
    Returns:
    
    true if modifiable
  - isAbstract
```
public boolean isAbstract()
```
    Is the skin abstract?
    
    Returns:
    
    true if abstract
  - isConfigurable
```
public boolean isConfigurable()
```
    Is the skin modifiable?
    
    Returns:
    
    true if modifiable
  - getParents
```
public List<String> getParents()
```
    Get the parent skins from the inheritance point of view. Consider using SkinsManager.getSkinAndParents(org.ametys.web.skin.Skin)
    
    Returns:
    
    The non null list of parents. The sooner a parent appears in the list, the stronger it is.
  - getTemplates
```
public Set<String> getTemplates()
```
    Get the list of existing templates
    
    Returns:
    
    A set of skin names. Can be null if there is an error.
  - getTemplate
```
public SkinTemplate getTemplate(String id)
```
    Get a template
    
    Parameters:
    
    id - The id of the template
    
    Returns:
    
    The template or null if the template doesn't exists
  - _isATemplate
```
private boolean _isATemplate(TraversableSource path)
                      throws SourceException
```
    Throws:
    
    SourceException
  - _defaultValues
```
protected void _defaultValues()
```
    The configuration default values (if configuration file does not exist or is unreadable)
  - refreshValues
```
public void refreshValues()
```
    Refresh the configuration values
  - _parseParents
```
private List<String> _parseParents(String parents)
```
  - _configureThumbnail
```
private String _configureThumbnail(String value,
                                   String defaultImage)
```
  - _configureI18n
```
private I18nizableText _configureI18n(Configuration child,
                                      I18nizableText defaultValue)
                               throws ConfigurationException
```
    Throws:
    
    ConfigurationException
  - getId
```
public String getId()
```
    The skin id
    
    Returns:
    
    the id
  - getLabel
```
public I18nizableText getLabel()
```
    The skin label
    
    Returns:
    
    The label
  - getDescription
```
public I18nizableText getDescription()
```
    The skin description
    
    Returns:
    
    The description. Can not be null but can be empty
  - getSmallImage
```
public String getSmallImage()
```
    The small image file uri
    
    Returns:
    
    The small image file uri
  - getMediumImage
```
public String getMediumImage()
```
    The medium image file uri
    
    Returns:
    
    The medium image file uri
  - getLargeImage
```
public String getLargeImage()
```
    The large image file uri
    
    Returns:
    
    The large image file uri
  - getRawPath
```
public Path getRawPath()
```
    Get the skin's path. Should not be used. Use the skin:// protocol.
    
    Returns:
    
    the skin's path

Class Skin

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CONF_PATH

TEMPLATES_PATH

_logger

_id

_path

_label

_description

_smallImage

_mediumImage

_largeImage

_templates

_lastConfUpdate

_modifiable

_abstract

_parents

_skinsManager

Constructor Detail

Skin

Method Detail

dispose

isModifiable

isAbstract

isConfigurable

getParents

getTemplates

getTemplate

_isATemplate

_defaultValues

refreshValues

_parseParents

_configureThumbnail

_configureI18n

getId

getLabel

getDescription

getSmallImage

getMediumImage

getLargeImage

getRawPath