SkinModel (Ametys 4.1.x

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

```
public class SkinModel
extends Object
```
A skin

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`SkinModel.CssMenuItem` Abstract representation of a menu item
`class`	`SkinModel.CssStyleItem` Bean representing a item of css style
`class`	`SkinModel.Separator` Item representing a separator
`class`	`SkinModel.Theme` Bean representing a theme

Field Summary

Fields
Modifier and Type	Field and Description
`private List<String>`	`_colors`
`private Map<String,List<SkinModel.CssMenuItem>>`	`_cssStyles`
`private String`	`_defaultColorTheme`
`private Map<String,String>`	`_defaultValues`
`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
`private long`	`_lastColorsUpdate`
`protected long`	`_lastConfUpdate` The last time the file was loaded
`private long`	`_lastCssStylesUpdate`
`private long`	`_lastDefaultValuesUpdate`
`private static Logger`	`_logger`
`protected String`	`_mediumImage` The skin thumbnail 32x32
`protected String`	`_smallImage` The skin thumbnail 16x16
`private Map<String,SkinModel.Theme>`	`_themes`

Constructor Summary

Constructors
Constructor and Description

SkinModel(String id, File file)
Creates a skin

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private I18nizableText`	`_configureI18nizableText(Configuration configuration, I18nizableText defaultValue)`
`private String`	`_configureIcon(Configuration iconConf)`
`private List<SkinModel.CssMenuItem>`	`_configureStyleItems(Configuration styleConfig)`
`private String`	`_configureThumbnail(String value, String defaultImage)`
`protected void`	`_defaultValues()` The configuration default values (if configuration file does not exist or is unreadable)
`private void`	`_refreshColorsValues()`
`private void`	`_refreshCssStyles()`
`private void`	`_refreshDefaultValues()`
`List<String>`	`getColors(String themeId)` Get the default colors of this theme
`List<String>`	`getDefaultColors()` Get the default colors of this model
`String`	`getDefaultColorTheme()` Get the default color theme
`Map<String,String>`	`getDefaultValues()` Get model default values
`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
`Map<String,List<SkinModel.CssMenuItem>>`	`getStyleItems()` Get all style items of this model
`List<SkinModel.CssMenuItem>`	`getStyleItems(String styleId)` Get the items of this css style
`SkinModel.Theme`	`getTheme(String themeId)` Get a theme of this model
`Map<String,SkinModel.Theme>`	`getThemes()` Get color themes of this model
`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

_lastConfUpdate
```
protected long _lastConfUpdate
```
The last time the file was loaded

_lastDefaultValuesUpdate
```
private long _lastDefaultValuesUpdate
```

_defaultValues

private Map<String,String> _defaultValues

_defaultColorTheme
```
private String _defaultColorTheme
```

_lastColorsUpdate
```
private long _lastColorsUpdate
```

_themes

private Map<String,SkinModel.Theme> _themes

_colors
```
private List<String> _colors
```

_lastCssStylesUpdate
```
private long _lastCssStylesUpdate
```

_cssStyles

private Map<String,List<SkinModel.CssMenuItem>> _cssStyles

Constructor Detail
- SkinModel
```
public SkinModel(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
- _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
- getDefaultColorTheme
```
public String getDefaultColorTheme()
```
  Get the default color theme
  
  Returns:
  
  The default color theme or null
- getThemes
```
public Map<String,SkinModel.Theme> getThemes()
```
  Get color themes of this model
  
  Returns:
  
  color themes of this model
- getTheme
```
public SkinModel.Theme getTheme(String themeId)
```
  Get a theme of this model
  
  Parameters:
  
  themeId - the theme id
  
  Returns:
  
  the theme
- getDefaultColors
```
public List<String> getDefaultColors()
```
  Get the default colors of this model
  
  Returns:
  
  The default colors of this model
- getColors
```
public List<String> getColors(String themeId)
```
  Get the default colors of this theme
  
  Parameters:
  
  themeId - The theme id
  
  Returns:
  
  the default colors of this theme
- getStyleItems
```
public Map<String,List<SkinModel.CssMenuItem>> getStyleItems()
```
  Get all style items of this model
  
  Returns:
  
  the list of items of css style
- getStyleItems
```
public List<SkinModel.CssMenuItem> getStyleItems(String styleId)
```
  Get the items of this css style
  
  Parameters:
  
  styleId - The css style id
  
  Returns:
  
  the list of items of css style
- getDefaultValues
```
public Map<String,String> getDefaultValues()
```
  Get model default values
  
  Returns:
  
  The default values
- _refreshColorsValues
```
private void _refreshColorsValues()
```
- _refreshCssStyles
```
private void _refreshCssStyles()
```
- _configureStyleItems
```
private List<SkinModel.CssMenuItem> _configureStyleItems(Configuration styleConfig)
                                                  throws ConfigurationException
```
  Throws:
  
  ConfigurationException
- _refreshDefaultValues
```
private void _refreshDefaultValues()
```
- _configureThumbnail
```
private String _configureThumbnail(String value,
                                   String defaultImage)
```
- _configureI18nizableText
```
private I18nizableText _configureI18nizableText(Configuration configuration,
                                                I18nizableText defaultValue)
                                         throws ConfigurationException
```
  Throws:
  
  ConfigurationException
- _configureIcon
```
private String _configureIcon(Configuration iconConf)
                       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 SkinModel

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_logger

_id

_file

_label

_description

_smallImage

_mediumImage

_largeImage

_lastConfUpdate

_lastDefaultValuesUpdate

_defaultValues

_defaultColorTheme

_lastColorsUpdate

_themes

_colors

_lastCssStylesUpdate

_cssStyles

Constructor Detail

SkinModel

Method Detail

_defaultValues

refreshValues

getDefaultColorTheme

getThemes

getTheme

getDefaultColors

getColors

getStyleItems

getStyleItems

getDefaultValues

_refreshColorsValues

_refreshCssStyles

_configureStyleItems

_refreshDefaultValues

_configureThumbnail

_configureI18nizableText

_configureIcon

getId

getLabel

getDescription

getSmallImage

getMediumImage

getLargeImage

getFile

getLocation