Skin (Ametys 4.1.x

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

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected I18nizableText`	`_description` The skin description
`protected File`	`_file` The skin directory
`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 Logger`	`_logger`
`protected String`	`_mediumImage` The skin thumbnail 32x32
`protected String`	`_smallImage` The skin thumbnail 16x16
`protected Map<String,SkinTemplate>`	`_templates` The map of templates id and associated templates

Constructor Summary

Constructors
Constructor and Description

Skin(String id, File file)
Creates a skin

Constructors
Constructor and Description
`Skin(String id, File file)` Creates a skin

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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`	`_templateExists(String id)`
`I18nizableText`	`getDescription()` The skin description
`File`	`getFile()` Get the skin's file directory
`String`	`getId()` The skin id
`I18nizableText`	`getLabel()` The skin label
`String`	`getLargeImage()` The large image file uri
`String`	`getLocation()` Get the absolute path of the skin's file directory
`String`	`getMediumImage()` The medium image file uri
`String`	`getSmallImage()` The small image file uri
`SkinTemplate`	`getTemplate(String id)` Get a template
`Set<String>`	`getTemplates()` Get the list of existing templates
`void`	`refreshValues()` Refresh the conf values

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

- Field Detail
  - _logger
```
private static Logger _logger
```
  - _id
```
protected String _id
```
    The skin id (e.g. the directory name)
  - _file
```
protected File _file
```
    The skin directory
  - _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
- Constructor Detail
  - Skin
```
public Skin(String id,
            File file)
```
    Creates a skin
    
    Parameters:
    
    id - The id of the skin (e.g. the directory name)
    
    file - The skin file
- Method Detail
  - 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 doest not exists
  - _templateExists
```
private boolean _templateExists(String id)
```
  - _defaultValues
```
protected void _defaultValues()
```
    The configuration default values (if configuration file does not exist or is unreadable)
  - refreshValues
```
public void refreshValues()
```
    Refresh the conf values
  - _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
  - getFile
```
public File getFile()
```
    Get the skin's file directory
    
    Returns:
    
    the skin's file directory
  - getLocation
```
public String getLocation()
```
    Get the absolute path of the skin's file directory
    
    Returns:
    
    the absolute path of the skin's file directory

Class Skin

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_logger

_id

_file

_label

_description

_smallImage

_mediumImage

_largeImage

_templates

_lastConfUpdate

Constructor Detail

Skin

Method Detail

getTemplates

getTemplate

_templateExists

_defaultValues

refreshValues

_configureThumbnail

_configureI18n

getId

getLabel

getDescription

getSmallImage

getMediumImage

getLargeImage

getFile

getLocation