org.ametys.web.skin

Class SkinTemplate

java.lang.Object

org.ametys.web.skin.SkinTemplate

public class SkinTemplate
extends Object

Represent a skin template.

Field Summary

Fields

Modifier and Type	Field and Description
protected I18nizableText	_description Template description
protected File	_file The template directory
protected String	_id Template id (e.g.
protected I18nizableText	_label Template label
protected String	_largeImage Template thumbnail 48px
protected long	_lastConfUpdate The last time the file was loaded
private static Logger	_logger
protected String	_mediumImage Template thumbnail 32px
protected String	_skinId The skin id
protected String	_smallImage Template thumbnail 16px
protected Map<String,SkinTemplateZone>	_zones Template zones.

Constructor Summary

Constructors

Constructor and Description
SkinTemplate(String skinId, String templateId, File file) Creates a template

Method Summary

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)
String	getDefaultZoneId() Get the primary default zone.
I18nizableText	getDescription() The template description
File	getFile() Get the template's file directory
String	getId() The template id
I18nizableText	getLabel() The template label
String	getLargeImage() The large image file uri
String	getMediumImage() The medium image file uri
String	getSmallImage() The small image file uri
SkinTemplateZone	getZone(String zoneId) The zone identifier by its id
Map<String,SkinTemplateZone>	getZones() The zones defined in by the template def
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

_skinId

protected String _skinId

The skin id

_id

protected String _id

Template id (e.g. the directory name)

_file

protected File _file

The template directory

_label

protected I18nizableText _label

Template label

_description

protected I18nizableText _description

Template description

_smallImage

protected String _smallImage

Template thumbnail 16px

_mediumImage

protected String _mediumImage

Template thumbnail 32px

_largeImage

protected String _largeImage

Template thumbnail 48px

_zones

protected Map<String,SkinTemplateZone> _zones

Template zones. the key is the zone id

_lastConfUpdate

protected long _lastConfUpdate

The last time the file was loaded

Constructor Detail

SkinTemplate

public SkinTemplate(String skinId,
                    String templateId,
                    File file)

Creates a template

Parameters:

skinId - The skin id

templateId - The template id

file - The template 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

_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 template id

Returns:

the id

getLabel

public I18nizableText getLabel()

The template label

Returns:

The label

getDescription

public I18nizableText getDescription()

The template 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

getZones

public Map<String,SkinTemplateZone> getZones()

The zones defined in by the template def

Returns:

The zones

getZone

public SkinTemplateZone getZone(String zoneId)

The zone identifier by its id

Parameters:

zoneId - The id of the zone definition to get

Returns:

The zone or null if no zone has this name

getFile

public File getFile()

Get the template's file directory

Returns:

the template's file directory

getDefaultZoneId

public String getDefaultZoneId()

Get the primary default zone. That is the first primary zone, or the 'default' zone if it exists and is primary

Returns:

The default zone or null if there is no primary zone