Package org.ametys.cms.clientsideelement.styles

Class HTMLEditorStyleRichTextConfiguration

java.lang.Object

org.ametys.cms.clientsideelement.styles.HTMLEditorStyleRichTextConfiguration

All Implemented Interfaces:

RichTextConfiguration, Prioritizable, Serviceable

public class HTMLEditorStyleRichTextConfiguration
extends Object
implements RichTextConfiguration, Serviceable

Declares all rich text configurations relative the HTMLEditorStyle

Constructor Summary

Constructors

Constructor	Description
HTMLEditorStyleRichTextConfiguration()

Method Summary

Modifier and Type	Method	Description
Map<String,Map<RichTextConfigurationStyleGroup,List<RichTextConfigurationStyle>>>	getAvailableStyles(String category, Map<String,Object> contextualParameters)	Get the available styles classified by identifiers such as "table", "link"...
Set<String>	getCategories()	Get the categories supported by this extension
Set<ClientSideElement>	getConvertors(String category, Map<String,Object> contextParameters)	Get the convertors used when richtext switch from code to view and from view to code.
List<ClientSideElement.ScriptFile>	getCSSFiles(String category, Map<String,Object> contextParameters)	Get the CSS files required during the edition of the given category.
Collection<RichTextConfigurationTag>	getHandledTags(String category, Map<String,Object> contextParameters)	Get the authorized tags for the given category
int	getPriority()	Get the priority for the component.
Set<ClientSideElement>	getValidators(String category, Map<String,Object> contextParameters)	Get the validators used during an edition of the rich text to ensure the value is correct.
void	service(ServiceManager manager)

Methods inherited from class java.lang.Object

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

Constructor Details

HTMLEditorStyleRichTextConfiguration

public HTMLEditorStyleRichTextConfiguration()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getCategories

public Set<String> getCategories()

Description copied from interface: RichTextConfiguration

Get the categories supported by this extension

Specified by:

getCategories in interface RichTextConfiguration

Returns:

The categories supported. Cannot be null, but may be empty and of course contains the "" key for the default category.

getPriority

public int getPriority()

Description copied from interface: Prioritizable

Get the priority for the component. On components using Prioritizable interface, each implementation define the order. In most cases, less is the number, more prior is the component.

Specified by:

getPriority in interface Prioritizable

Returns:

the priority

getHandledTags

public Collection<RichTextConfigurationTag> getHandledTags(String category,
 Map<String,Object> contextParameters)

Description copied from interface: RichTextConfiguration

Get the authorized tags for the given category

Specified by:

getHandledTags in interface RichTextConfiguration

Parameters:

category - The category. "" is the default category.

contextParameters - Contextuals parameters transmitted by the environment.

Returns:

The tags supported (can be null). The key is the html tag name supported and the value is the associated value.

getCSSFiles

public List<ClientSideElement.ScriptFile> getCSSFiles(String category,
 Map<String,Object> contextParameters)

Description copied from interface: RichTextConfiguration

Get the CSS files required during the edition of the given category.

Specified by:

getCSSFiles in interface RichTextConfiguration

Parameters:

category - The category. "" is the default category.

contextParameters - Contextuals parameters transmitted by the environment.

Returns:

The CSS files requires. Can be null.

getConvertors

public Set<ClientSideElement> getConvertors(String category,
 Map<String,Object> contextParameters)

Description copied from interface: RichTextConfiguration

Get the convertors used when richtext switch from code to view and from view to code. Convertors can be differents by category.

Specified by:

getConvertors in interface RichTextConfiguration

Parameters:

category - The category. "" is the default category.

contextParameters - Contextuals parameters transmitted by the environment.

Returns:

The convertors to use. The class of the ClientSideElement must inherit the front-side convertor js interface. Can be null.

getValidators

public Set<ClientSideElement> getValidators(String category,
 Map<String,Object> contextParameters)

Description copied from interface: RichTextConfiguration

Get the validators used during an edition of the rich text to ensure the value is correct. Validators can be differents by category.

Specified by:

getValidators in interface RichTextConfiguration

Parameters:

category - The category. "" is the default category.

contextParameters - Contextuals parameters transmitted by the environment.

Returns:

The validators to use. The class of the ClientSideElement must inherit the front-side validor js interface. Can be null.

getAvailableStyles

public Map<String,Map<RichTextConfigurationStyleGroup,List<RichTextConfigurationStyle>>> getAvailableStyles(String category,
 Map<String,Object> contextualParameters)

Description copied from interface: RichTextConfiguration

Get the available styles classified by identifiers such as "table", "link"...

Specified by:

getAvailableStyles in interface RichTextConfiguration

Parameters:

category - The category. "" is the default category.

contextualParameters - Contextuals parameters transmitted by the environment.

Returns:

The available styles. Can be null.