Package org.ametys.web.clientsideelement.styles

Class SkinHTMLEditorStyleExtension

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.cms.clientsideelement.styles.StaticHTMLEditorStyleExtension

org.ametys.web.clientsideelement.styles.SkinHTMLEditorStyleExtension

All Implemented Interfaces:

HTMLEditorStyleExtensionPoint, PluginAware, Configurable, LogEnabled, Serviceable

public class SkinHTMLEditorStyleExtension
extends StaticHTMLEditorStyleExtension

Based on a configuration like the StaticHTMLEditorStyleExtension but the file is located inside the current skin directory (skin/conf/edition-styles.xml).

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,StyleCategory>	_imageStyleCategories	The assocation skinId Style ; to know for a given skin its style
protected Map<String,Long>	_lastUpdates	The assocation skinId lastUpdateDate ; to know for a given skin when its conf file was read for the last time
protected Map<String,StyleCategory>	_linkStyleCategories	The assocation skinId Style ; to know for a given skin its style
protected Map<String,StyleCategory>	_olStyleCategories	The assocation skinId Style ; to know for a given skin its style
protected Map<String,StyleCategory>	_paraStyleCategories	The assocation skinId Style ; to know for a given skin its style
protected SiteManager	_siteManager	The sites manager
protected SkinConfigurationHelper	_skinConfigurationHelper	The helper for inheritable skin configuration
protected SkinsManager	_skinsManager	The skins manager
protected SourceResolver	_sourceResolver	The excalibur source resolver
protected Map<String,StyleCategory>	_tableStyleCategories	The assocation skinId Style ; to know for a given skin its style
protected Map<String,StyleCategory>	_ulStyleCategories	The assocation skinId Style ; to know for a given skin its style

Fields inherited from class org.ametys.cms.clientsideelement.styles.StaticHTMLEditorStyleExtension

_featureName, _imageStyleCategory, _linkStyleCategory, _olStyleCategory, _paraStyleCategory, _pluginName, _resolver, _tableStyleCategory, _ulStyleCategory, IMAGE_DEFAULT_ICONS, LINK_DEFAULT_ICONS, OL_DEFAULT_ICONS, TABLE_DEFAULT_ICONS, UL_DEFAULT_ICONS

Fields inherited from interface org.ametys.cms.clientsideelement.styles.HTMLEditorStyleExtensionPoint

ROLE

Constructor Summary

Constructors

Constructor	Description
SkinHTMLEditorStyleExtension()

Method Summary

Modifier and Type	Method	Description
protected void	_defaultValues(String skinId)	Set default values for the given skin
protected String	_getImport(Configuration configuration, Map<String,Object> contextualParameters)	Determine an url from a configuration node.
protected String	_updateStyleCategories(Map<String,Object> contextualParameters)	Update if necessary the values associated with the current skin
void	configure(Configuration configuration)
StyleCategory	getImage(Map<String,Object> contextualParameters)	Get the list of styles for images
StyleCategory	getLink(Map<String,Object> contextualParameters)	Get the list of styles for link
StyleCategory	getOrderedList(Map<String,Object> contextualParameters)	Get the list of styles for ordered lists
StyleCategory	getPara(Map<String,Object> contextualParameters)	Get the list of styles for paragraphs
StyleCategory	getTable(Map<String,Object> contextualParameters)	Get the list of styles for tables
StyleCategory	getUnorderedList(Map<String,Object> contextualParameters)	Get the list of styles for unordered lists
void	service(ServiceManager manager)

Methods inherited from class org.ametys.cms.clientsideelement.styles.StaticHTMLEditorStyleExtension

_configure, _configureStyle, _configureStyleCategory, setPluginInfo

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.cms.clientsideelement.styles.HTMLEditorStyleExtensionPoint

getBackOfficeCSSFiles, getInlineEditorCSSFiles

Field Detail

_lastUpdates

protected Map<String,Long> _lastUpdates

The assocation skinId lastUpdateDate ; to know for a given skin when its conf file was read for the last time

_paraStyleCategories

protected Map<String,StyleCategory> _paraStyleCategories

The assocation skinId Style ; to know for a given skin its style

_tableStyleCategories

protected Map<String,StyleCategory> _tableStyleCategories

The assocation skinId Style ; to know for a given skin its style

_imageStyleCategories

protected Map<String,StyleCategory> _imageStyleCategories

The assocation skinId Style ; to know for a given skin its style

_linkStyleCategories

protected Map<String,StyleCategory> _linkStyleCategories

The assocation skinId Style ; to know for a given skin its style

_ulStyleCategories

protected Map<String,StyleCategory> _ulStyleCategories

The assocation skinId Style ; to know for a given skin its style

_olStyleCategories

protected Map<String,StyleCategory> _olStyleCategories

The assocation skinId Style ; to know for a given skin its style

_sourceResolver

protected SourceResolver _sourceResolver

The excalibur source resolver

_siteManager

protected SiteManager _siteManager

The sites manager

_skinsManager

protected SkinsManager _skinsManager

The skins manager

_skinConfigurationHelper

protected SkinConfigurationHelper _skinConfigurationHelper

The helper for inheritable skin configuration

Constructor Detail

SkinHTMLEditorStyleExtension

public SkinHTMLEditorStyleExtension()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class StaticHTMLEditorStyleExtension

Throws:

ServiceException

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Overrides:

configure in class StaticHTMLEditorStyleExtension

Throws:

ConfigurationException

_getImport

protected String _getImport(Configuration configuration,
                            Map<String,Object> contextualParameters)

Description copied from class: StaticHTMLEditorStyleExtension

Determine an url from a configuration node.

Overrides:

_getImport in class StaticHTMLEditorStyleExtension

Parameters:

configuration - Read the optional plugin attribute and concatenate it to the value of the node. Can be null

contextualParameters - Contextuals parameters transmitted by the environment.

Returns:

The non-null path to the plugin resource

getPara

public StyleCategory getPara(Map<String,Object> contextualParameters)

Description copied from interface: HTMLEditorStyleExtensionPoint

Get the list of styles for paragraphs

Specified by:

getPara in interface HTMLEditorStyleExtensionPoint

Overrides:

getPara in class StaticHTMLEditorStyleExtension

Parameters:

contextualParameters - Contextuals parameters transmitted by the environment.

Returns:

A category. Can be null.

getImage

public StyleCategory getImage(Map<String,Object> contextualParameters)

Description copied from interface: HTMLEditorStyleExtensionPoint

Get the list of styles for images

Specified by:

getImage in interface HTMLEditorStyleExtensionPoint

Overrides:

getImage in class StaticHTMLEditorStyleExtension

Parameters:

contextualParameters - Contextuals parameters transmitted by the environment.

Returns:

A category. Can be null.

getLink

public StyleCategory getLink(Map<String,Object> contextualParameters)

Description copied from interface: HTMLEditorStyleExtensionPoint

Get the list of styles for link

Specified by:

getLink in interface HTMLEditorStyleExtensionPoint

Overrides:

getLink in class StaticHTMLEditorStyleExtension

Parameters:

contextualParameters - Contextuals parameters transmitted by the environment.

Returns:

A category. Can be null.

getOrderedList

public StyleCategory getOrderedList(Map<String,Object> contextualParameters)

Description copied from interface: HTMLEditorStyleExtensionPoint

Get the list of styles for ordered lists

Specified by:

getOrderedList in interface HTMLEditorStyleExtensionPoint

Overrides:

getOrderedList in class StaticHTMLEditorStyleExtension

Parameters:

contextualParameters - Contextuals parameters transmitted by the environment.

Returns:

A category. Can be null.

getTable

public StyleCategory getTable(Map<String,Object> contextualParameters)

Description copied from interface: HTMLEditorStyleExtensionPoint

Get the list of styles for tables

Specified by:

getTable in interface HTMLEditorStyleExtensionPoint

Overrides:

getTable in class StaticHTMLEditorStyleExtension

Parameters:

contextualParameters - Contextuals parameters transmitted by the environment.

Returns:

A category. Can be null.

getUnorderedList

public StyleCategory getUnorderedList(Map<String,Object> contextualParameters)

Description copied from interface: HTMLEditorStyleExtensionPoint

Get the list of styles for unordered lists

Specified by:

getUnorderedList in interface HTMLEditorStyleExtensionPoint

Overrides:

getUnorderedList in class StaticHTMLEditorStyleExtension

Parameters:

contextualParameters - Contextuals parameters transmitted by the environment.

Returns:

A category. Can be null.

_updateStyleCategories

protected String _updateStyleCategories(Map<String,Object> contextualParameters)

Update if necessary the values associated with the current skin

Parameters:

contextualParameters - Contextuals parameters transmitted by the environment.

Returns:

The current skin

_defaultValues

protected void _defaultValues(String skinId)

Set default values for the given skin

Parameters:

skinId - The skin