Package org.ametys.cms.clientsideelement.styles

Interface HTMLEditorStyle

All Known Implementing Classes:

SkinHTMLEditorContentStyle, StaticHTMLEditorContentStyle

public interface HTMLEditorStyle

This extension point allows to determine which styles does exist for html edition

Field Summary

Fields

Modifier and Type	Field	Description
static String	ROLE	Avalon role name

Method Summary

Modifier and Type	Method	Description
default List<ClientSideElement.ScriptFile>	getBackOfficeCSSFiles(String category, Map<String,Object> contextParameters)	Get the aggregation of all backoffice css files
Set<String>	getCategories()	Get the categories supported by this component
StyleCategory	getImage(String category, Map<String,Object> contextualParameters)	Get the list of styles for images
default List<ClientSideElement.ScriptFile>	getInlineEditorCSSFiles(String category, Map<String,Object> contextParameters)	Get the aggregation of all inline editor css files
StyleCategory	getLink(String category, Map<String,Object> contextualParameters)	Get the list of styles for link
StyleCategory	getOrderedList(String category, Map<String,Object> contextualParameters)	Get the list of styles for ordered lists
StyleCategory	getPara(String category, Map<String,Object> contextualParameters)	Get the list of styles for paragraphs
StyleCategory	getTable(String category, Map<String,Object> contextualParameters)	Get the list of styles for tables
StyleCategory	getUnorderedList(String category, Map<String,Object> contextualParameters)	Get the list of styles for unordered lists

Field Detail

ROLE

static final String ROLE

Avalon role name

Method Detail

getCategories

Set<String> getCategories()

Get the categories supported by this component

Returns:

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

getPara

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

Get the list of styles for paragraphs

Parameters:

category - The richtext category

contextualParameters - Contextuals parameters transmitted by the environment.

Returns:

A category. Can be null.

getTable

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

Get the list of styles for tables

Parameters:

category - The richtext category

contextualParameters - Contextuals parameters transmitted by the environment.

Returns:

A category. Can be null.

getLink

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

Get the list of styles for link

Parameters:

category - The richtext category

contextualParameters - Contextuals parameters transmitted by the environment.

Returns:

A category. Can be null.

getImage

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

Get the list of styles for images

Parameters:

category - The richtext category

contextualParameters - Contextuals parameters transmitted by the environment.

Returns:

A category. Can be null.

getUnorderedList

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

Get the list of styles for unordered lists

Parameters:

category - The richtext category

contextualParameters - Contextuals parameters transmitted by the environment.

Returns:

A category. Can be null.

getOrderedList

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

Get the list of styles for ordered lists

Parameters:

category - The richtext category

contextualParameters - Contextuals parameters transmitted by the environment.

Returns:

A category. Can be null.

getBackOfficeCSSFiles

default List<ClientSideElement.ScriptFile> getBackOfficeCSSFiles(String category,
                                                                 Map<String,Object> contextParameters)

Get the aggregation of all backoffice css files

Parameters:

category - The richtext category

contextParameters - The contextual parameters

Returns:

A non null list of ScriptFile

getInlineEditorCSSFiles

default List<ClientSideElement.ScriptFile> getInlineEditorCSSFiles(String category,
                                                                   Map<String,Object> contextParameters)

Get the aggregation of all inline editor css files

Parameters:

category - The richtext category

contextParameters - The contextual parameters

Returns:

A non null list of ScriptFile