org.ametys.cms.clientsideelement.styles

Class AbstractEditorStyleMenu

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.ui.StaticFileImportsClientSideElement

org.ametys.core.ui.StaticClientSideElement

org.ametys.core.ui.SimpleMenu

org.ametys.cms.clientsideelement.styles.AbstractEditorStyleMenu

All Implemented Interfaces:

ClientSideElement, MenuClientSideElement, LogEnabled, PluginAware, Configurable, Serviceable

Direct Known Subclasses:

ImageMenu, LinkMenu, OrderedListMenu, TableMenu, UnorderedListMenu

public abstract class AbstractEditorStyleMenu
extends SimpleMenu

This StaticMenu also search for special tags to transform them into parameters thanks to HTMLEditorStyleExtensionPoint Special tags are

• table

Nested Class Summary

Nested classes/interfaces inherited from class org.ametys.core.ui.SimpleMenu

SimpleMenu.GalleryGroup, SimpleMenu.GalleryItem, SimpleMenu.UnresolvedItem

Nested classes/interfaces inherited from interface org.ametys.core.ui.ClientSideElement

ClientSideElement.Script, ClientSideElement.ScriptFile

Field Summary

Fields

Modifier and Type	Field and Description
protected I18nizableText	_autoGroupLabel The label of auto group
protected String	_autoItemClassName JS class name for auto items
protected Map<String,Object>	_defaultValues The default value
protected HTMLEditorStyleExtensionPoint	_htmlEditorStyleExtensionPoint The HTMLEditorStyleExtensionPoint instance
protected I18nUtils	_i18nUtils I18n helper

Fields inherited from class org.ametys.core.ui.SimpleMenu

_galleryItemManager, _galleryItems, _menuItemManager, _menuItems, _primaryMenuItem, _referencedClientSideElement, _ribbonControlManager, _smanager, _unresolvedMenuItems

Fields inherited from class org.ametys.core.ui.StaticFileImportsClientSideElement

_currentUserProvider, _dependencies, _featureName, _id, _pluginName, _rightManager, _rights, _rightsMode, _script

Constructor Summary

Constructors

Constructor and Description
AbstractEditorStyleMenu()

Method Summary

Modifier and Type	Method and Description
protected SimpleMenu.GalleryGroup	_configureGroupGallery(Configuration configuration) Configure a group gallery
protected abstract StyleCategory	_getStyleCategory(Map<String,Object> contextParameters) Return the StyleCategory to use
private Map<String,Object>	getParameters(Map<String,Object> parameters, Map<String,Object> contextualParameters)
List<ClientSideElement.Script>	getScripts(boolean ignoreRights, Map<String,Object> contextParameters) This method return the scripts that will be used on client side.
void	service(ServiceManager smanager)

Methods inherited from class org.ametys.core.ui.SimpleMenu

_addDependencies, _configureClass, _configureGalleries, _configureItemsMenu, _getGalleryItems, _getMenuItems, configure, getReferencedClientSideElements, getRights

Methods inherited from class org.ametys.core.ui.StaticClientSideElement

_configureParameters, _configureScript, configureInitialParameters

Methods inherited from class org.ametys.core.ui.StaticFileImportsClientSideElement

_configureDependencies, _configureImports, _configureRights, _configureRightsMode, getDependencies, getId, getPluginName, getScripts, hasRight, setPluginInfo, toString

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Detail

_htmlEditorStyleExtensionPoint

protected HTMLEditorStyleExtensionPoint _htmlEditorStyleExtensionPoint

The HTMLEditorStyleExtensionPoint instance

_i18nUtils

protected I18nUtils _i18nUtils

I18n helper

_defaultValues

protected Map<String,Object> _defaultValues

The default value

_autoGroupLabel

protected I18nizableText _autoGroupLabel

The label of auto group

_autoItemClassName

protected String _autoItemClassName

JS class name for auto items

Constructor Detail

AbstractEditorStyleMenu

public AbstractEditorStyleMenu()

Method Detail

_getStyleCategory

protected abstract StyleCategory _getStyleCategory(Map<String,Object> contextParameters)

Return the StyleCategory to use

Parameters:

contextParameters - Contextual parameters transmitted by the environment.

Returns:

A non null category

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class SimpleMenu

Throws:

ServiceException

getScripts

public List<ClientSideElement.Script> getScripts(boolean ignoreRights,
                                                 Map<String,Object> contextParameters)

Description copied from interface: ClientSideElement

This method return the scripts that will be used on client side. This class will be parametrized by initial and current parameters.

Specified by:

getScripts in interface ClientSideElement

Overrides:

getScripts in class SimpleMenu

Parameters:

ignoreRights - True to ignore the rights verification.

contextParameters - Contextuals parameters transmitted by the environment.

Returns:

The list of scripts or an empty list.

getParameters

private Map<String,Object> getParameters(Map<String,Object> parameters,
                                         Map<String,Object> contextualParameters)

_configureGroupGallery

protected SimpleMenu.GalleryGroup _configureGroupGallery(Configuration configuration)
                                                  throws ConfigurationException

Description copied from class: SimpleMenu

Configure a group gallery

Overrides:

_configureGroupGallery in class SimpleMenu

Parameters:

configuration - the configuration

Returns:

The configured group gallery

Throws:

ConfigurationException - If the configuration has an issue