org.ametys.web.clientsideelement

Class ServiceMenu

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.ServiceMenu

All Implemented Interfaces:

ClientSideElement, MenuClientSideElement, LogEnabled, PluginAware, Configurable, Serviceable

public class ServiceMenu
extends AbstractPageMenu

Menu that lists the services

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	ServiceMenu.I18nizableTextComparator
(package private) class	ServiceMenu.ServiceComparator

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 ServiceExtensionPoint	_serviceExtensionPoint The list of content types
protected ServicesAssignmentHandler	_servicesHandler The service assignment handler
private boolean	_servicesInitialized

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

Method Summary

Modifier and Type	Method and Description
protected ClientSideElement.Script	_configureScript(Configuration configuration) Configure the script
protected void	_getGalleryItems(Map<String,Object> parameters, Map<String,Object> contextualParameters) Get the gallery items
protected Configuration	_getServiceConfiguration(String id, Service service) Get the configuration of the service item
protected Map<I18nizableText,Set<Service>>	_getServicesByGroup() Get the list of services classified by groups
protected boolean	_hasRight(Page page, String rightId) Determines if user has convenient right on page
private void	_lazyInitializeServiceGallery()
protected void	addService(Service service, Map<I18nizableText,Set<Service>> groups) Add service to groups
Map<String,Object>	getAvailableServices(String pageId, String zoneName) Get the available templates for pages
List<ClientSideElement.Script>	getScripts(boolean ignoreRights, Map<String,Object> contextParameters) This method return the scripts that will be used on client side.
protected boolean	hasRight(Service service, Page page) Test if the current user has the right needed by the service to create it.
protected boolean	isValidService(Service service) Determines if the service is a valid service for the gallery
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, 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

_serviceExtensionPoint

protected ServiceExtensionPoint _serviceExtensionPoint

The list of content types

_servicesHandler

protected ServicesAssignmentHandler _servicesHandler

The service assignment handler

_i18nUtils

protected I18nUtils _i18nUtils

The i18n utils

_servicesInitialized

private boolean _servicesInitialized

Constructor Detail

ServiceMenu

public ServiceMenu()

Method Detail

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractPageMenu

Throws:

ServiceException

_configureScript

protected ClientSideElement.Script _configureScript(Configuration configuration)
                                             throws ConfigurationException

Description copied from class: StaticFileImportsClientSideElement

Configure the script

Overrides:

_configureScript in class StaticClientSideElement

Parameters:

configuration - the global configuration

Returns:

The script created

Throws:

ConfigurationException - The configuration is incorrect

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.

getAvailableServices

public Map<String,Object> getAvailableServices(String pageId,
                                               String zoneName)

Get the available templates for pages

Parameters:

pageId - The id of the page

zoneName - the name of the zone

Returns:

the list of templates' name

_hasRight

protected boolean _hasRight(Page page,
                            String rightId)

Determines if user has convenient right on page

Parameters:

page - The page

rightId - The right to check

Returns:

true if the user has convenient right

_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.

_lazyInitializeServiceGallery

private void _lazyInitializeServiceGallery()
                                    throws ConfigurationException

Throws:

ConfigurationException

_getServicesByGroup

protected Map<I18nizableText,Set<Service>> _getServicesByGroup()

Get the list of services classified by groups

Returns:

The content types

addService

protected void addService(Service service,
                          Map<I18nizableText,Set<Service>> groups)

Add service to groups

Parameters:

service - The service

groups - The groups

isValidService

protected boolean isValidService(Service service)

Determines if the service is a valid service for the gallery

Parameters:

service - The service

Returns:

true if it is a valid service

_getServiceConfiguration

protected Configuration _getServiceConfiguration(String id,
                                                 Service service)

Get the configuration of the service item

Parameters:

id - The id of item

service - The service

Returns:

The configuration

hasRight

protected boolean hasRight(Service service,
                           Page page)

Test if the current user has the right needed by the service to create it.

Parameters:

service - the service.

page - the current page.

Returns:

true if the user has the right needed, false otherwise.