Package 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	Description
protected I18nizableText	_description	Template description
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
protected String	_mediumImage	Template thumbnail 32px
protected SkinConfigurationHelper	_skinConfigurationHelper	The skin configuration helper
protected String	_skinId	The skin id
protected SkinsManager	_skinsManager	The skins manager
protected String	_smallImage	Template thumbnail 16px
protected Optional<ViewParametersModel>	_viewParameters	The template view parameters
protected Map<String,SkinTemplateZone>	_zones	Template zones.

Constructor Summary

Constructors

Constructor	Description
SkinTemplate(String skinId, String templateId, SkinsManager skinsManager, SkinConfigurationHelper skinConfigurationHelper)	Creates a template

Method Summary

Modifier and Type	Method	Description
protected Optional<ViewParametersModel>	_configureTemplateViewParameters(String skinId, String templateId, Configuration templateConfiguration)	Parse template view parameters
protected Optional<ViewParametersModel>	_configureViewParameters(Configuration paramConfiguration, String viewParametersId)	Parse view parameters from configuration
protected Optional<ViewParametersModel>	_configureZoneItemViewParameters(String skinId, String templateId, String zoneId, Configuration zoneConfiguration)	Parse zone item view parameters
protected Optional<ViewParametersModel>	_configureZoneViewParameters(String skinId, String templateId, String zoneId, Configuration zoneConfiguration)	Parse zone view parameters
protected void	_defaultValues()	The configuration default values (if configuration file does not exist or is unreadable)
void	dispose()	Dispose skin template component
String	getDefaultZoneId()	Get the primary default zone.
I18nizableText	getDescription()	The template description
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
Optional<ViewParametersModel>	getViewParameters()	Get the view parameters model
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 configuration values

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

_skinId

protected String _skinId

The skin id

_id

protected String _id

Template id (e.g. the directory name)

_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

_viewParameters

protected Optional<ViewParametersModel> _viewParameters

The template view parameters

_lastConfUpdate

protected long _lastConfUpdate

The last time the file was loaded

_skinsManager

protected SkinsManager _skinsManager

The skins manager

_skinConfigurationHelper

protected SkinConfigurationHelper _skinConfigurationHelper

The skin configuration helper

Constructor Details

SkinTemplate

public SkinTemplate(String skinId,
 String templateId,
 SkinsManager skinsManager,
 SkinConfigurationHelper skinConfigurationHelper)

Creates a template

Parameters:

skinId - The skin id

templateId - The template id

skinsManager - The skins manager

skinConfigurationHelper - The skin configuration helper

Method Details

_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

_configureTemplateViewParameters

protected Optional<ViewParametersModel> _configureTemplateViewParameters(String skinId,
 String templateId,
 Configuration templateConfiguration)
                                                                  throws ConfigurationException

Parse template view parameters

Parameters:

skinId - the skin id

templateId - the template id

templateConfiguration - the template configuration

Returns:

the zone item view parameters

Throws:

ConfigurationException - if a configuration error occurred

_configureZoneViewParameters

protected Optional<ViewParametersModel> _configureZoneViewParameters(String skinId,
 String templateId,
 String zoneId,
 Configuration zoneConfiguration)
                                                              throws ConfigurationException

Parse zone view parameters

Parameters:

skinId - the skin id

templateId - the template id

zoneId - the zone id

zoneConfiguration - the zone configuration

Returns:

the zone view parameters

Throws:

ConfigurationException - if a configuration error occurred

_configureZoneItemViewParameters

protected Optional<ViewParametersModel> _configureZoneItemViewParameters(String skinId,
 String templateId,
 String zoneId,
 Configuration zoneConfiguration)
                                                                  throws ConfigurationException

Parse zone item view parameters

Parameters:

skinId - the skin id

templateId - the template id

zoneId - the zone id

zoneConfiguration - the zone configuration

Returns:

the zone item view parameters

Throws:

ConfigurationException - if a configuration error occurred

_configureViewParameters

protected Optional<ViewParametersModel> _configureViewParameters(Configuration paramConfiguration,
 String viewParametersId)
                                                          throws ConfigurationException

Parse view parameters from configuration

Parameters:

paramConfiguration - the configuration

viewParametersId - the view parameters id

Returns:

the view parameters

Throws:

ConfigurationException - if a configuration error occurred

dispose

public void dispose()

Dispose skin template component

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

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

getViewParameters

public Optional<ViewParametersModel> getViewParameters()

Get the view parameters model

Returns:

the view parameters