org.ametys.web.clientsideelement

Class TemplatesMenu

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.web.clientsideelement.AbstractPageMenu

org.ametys.web.clientsideelement.TemplatesMenu

All Implemented Interfaces:

ClientSideElement, MenuClientSideElement, LogEnabled, PluginAware, Configurable, Serviceable

public class TemplatesMenu
extends AbstractPageMenu

This element finally creates a gallery button with one item per template

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 I18nUtils	_i18nUtils The i18n utils
protected static String	_RESOURCES_PLUGIN The plugin in which are the templates resources (messages and icons).
protected SiteManager	_siteManager The site manager
protected SkinsManager	_skinsManager The skins manager
protected TemplatesAssignmentHandler	_templatesAssignmentHandler The template assignment handler

Fields inherited from class org.ametys.web.clientsideelement.AbstractPageMenu

_resolver, _synchronizeComponent

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
TemplatesMenu()

Method Summary

Modifier and Type	Method and Description
protected void	_getGalleryItems(Map<String,Object> parameters, Map<String,Object> contextualParameters) Get the gallery items
protected Configuration	_getTemplateItemConfiguration(String itemId, SkinTemplate template) Get the configuration for a language item
private void	_lazyInitializeTemplateGallery(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.
Map<String,Object>	getStatus(List<String> pageIds) Get the available templates for pages
void	service(ServiceManager smanager)

Methods inherited from class org.ametys.web.clientsideelement.AbstractPageMenu

getAllRightPageDescription, getNoModifiablePageDescription, getNoRightPageDescription, getPageDefaultParameters, hasRight

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

_addDependencies, _configureClass, _configureGalleries, _configureGroupGallery, _configureItemsMenu, _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

_RESOURCES_PLUGIN

protected static final String _RESOURCES_PLUGIN

The plugin in which are the templates resources (messages and icons).

See Also:

Constant Field Values

_skinsManager

protected SkinsManager _skinsManager

The skins manager

_templatesAssignmentHandler

protected TemplatesAssignmentHandler _templatesAssignmentHandler

The template assignment handler

_siteManager

protected SiteManager _siteManager

The site manager

_i18nUtils

protected I18nUtils _i18nUtils

The i18n utils

Constructor Detail

TemplatesMenu

public TemplatesMenu()

Method Detail

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractPageMenu

Throws:

ServiceException

getStatus

public Map<String,Object> getStatus(List<String> pageIds)

Get the available templates for pages

Parameters:

pageIds - The ids of pages

Returns:

the list of templates' name

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.

_getGalleryItems

protected void _getGalleryItems(Map<String,Object> parameters,
                                Map<String,Object> contextualParameters)

Description copied from class: SimpleMenu

Get the gallery items

Overrides:

_getGalleryItems in class SimpleMenu

Parameters:

parameters - Contextual the parameters given to the control script class.

contextualParameters - Contextual parameters transmitted by the environment.

_lazyInitializeTemplateGallery

private void _lazyInitializeTemplateGallery(Map<String,Object> contextualParameters)
                                     throws ConfigurationException

Throws:

ConfigurationException

_getTemplateItemConfiguration

protected Configuration _getTemplateItemConfiguration(String itemId,
                                                      SkinTemplate template)

Get the configuration for a language item

Parameters:

itemId - The item id

template - The template used for the item

Returns:

The configuration