Package org.ametys.skinfactory.clientsidelement

Class DesignsMenu

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.skinfactory.clientsidelement.DesignsMenu

All Implemented Interfaces:

ClientSideElement, MenuClientSideElement, LogEnabled, PluginAware, Configurable, Serviceable

public class DesignsMenu
extends SimpleMenu

StaticClientSideElement for design of model

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	Description
private boolean	_designsInitialized
private ModelDesignsManager	_designsManager
private I18nUtils	_i18nUtils
private SkinModelsManager	_modelsManager

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

_galleryItems, _menuItemManager, _menuItems, _primaryMenuItem, _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	Description
DesignsMenu()

Method Summary

Modifier and Type	Method	Description
protected Configuration	_getDesignConfiguration(String id, ModelDesignsManager.Design design, String modelName)	Get the configuration of the model item
protected void	_getGalleryItems(Map<String,Object> parameters, Map<String,Object> contextualParameters)	Get the gallery items
private void	_lazyInitializeDesignsGallery()	Lazy initialization of the design gallery
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, _configureGroupGallery, _configureItemsMenu, _getGalleryItemManager, _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

_designsManager

private ModelDesignsManager _designsManager

_designsInitialized

private boolean _designsInitialized

_modelsManager

private SkinModelsManager _modelsManager

_i18nUtils

private I18nUtils _i18nUtils

Constructor Detail

DesignsMenu

public DesignsMenu()

Method Detail

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.

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

_lazyInitializeDesignsGallery

private void _lazyInitializeDesignsGallery()
                                    throws ConfigurationException,
                                           ProcessingException

Lazy initialization of the design gallery

Throws:

ConfigurationException - if the design configuration is wrong

ProcessingException - if an error occurs when retrieving the models

_getDesignConfiguration

protected Configuration _getDesignConfiguration(String id,
                                                ModelDesignsManager.Design design,
                                                String modelName)

Get the configuration of the model item

Parameters:

id - The id of item

design - The design

modelName - The model name

Returns:

The configuration