Package org.ametys.cms.clientsideelement

Class ContentTypesGallery

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

All Implemented Interfaces:

ClientSideElement, MenuClientSideElement, LogEnabled, PluginAware, Configurable, Serviceable

Direct Known Subclasses:

ContentTypesGallery, MixinContentTypesGallery, ReferenceTablesGallery

public class ContentTypesGallery
extends SimpleMenu

This element creates a menu with one gallery item per content type classified by category (default mode). This element supports an alternative display, to display content types into sub menu items (root menu items will be the categories), if 'show-in-menu' parameters is set to 'true'. This mode should be privileged if the number of content types is important (> 30) The user rights are checked.

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
protected ContentTypeExtensionPoint	_contentTypeExtensionPoint	The list of content types
protected I18nUtils	_i18nUtils	The i18n utils
protected LanguagesManager	_languagesManager	The language manager
protected RootContentHelper	_rootContentHelper	Helper for root content

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

Method Summary

Modifier and Type	Method	Description
protected void	_addContentTypeConfiguration(DefaultConfiguration rootConf, ContentType cType)	Get the configuration of the content type item
protected void	_addContentTypeIconsConfiguration(DefaultConfiguration classConf, ContentType cType)	Add configuration for content type's icons and/or glyphes
protected void	_addGroupContentTypeConfiguration(DefaultConfiguration rootConf, I18nizableText groupLabel, Set<ContentType> cTypes)	Get the configuration of the content type item
protected void	_addRightsOnContentTypeConfiguration(DefaultConfiguration rootConf)	Get the 'rights' configuration of the content type item
protected ClientSideElement.Script	_configureScript(Configuration configuration)	Configure the script
protected Map<I18nizableText,Set<ContentType>>	_getContentTypesByGroup()	Get the list of content types classified by groups
protected void	_getGalleryItems(Map<String,Object> parameters, Map<String,Object> contextualParameters)	Get the gallery items
protected DefaultConfiguration	_getI18nizableTextConfiguration(String tagName, I18nizableText i18nText)	Get the configuration for an i18nizable text
protected void	addContentType(ContentType contentType, Map<I18nizableText,Set<ContentType>> groups)	Add content to groups
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(ContentType cType)	Test if the current user has the right needed by the content type to create a content.
protected boolean	isValidContentType(ContentType contentType)	Determines if the content type is a valid content type for the gallery
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, 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 Details

_contentTypeExtensionPoint

protected ContentTypeExtensionPoint _contentTypeExtensionPoint

The list of content types

_languagesManager

protected LanguagesManager _languagesManager

The language manager

_i18nUtils

protected I18nUtils _i18nUtils

The i18n utils

_rootContentHelper

protected RootContentHelper _rootContentHelper

Helper for root content

Constructor Details

ContentTypesGallery

public ContentTypesGallery()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class SimpleMenu

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

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

_addGroupContentTypeConfiguration

protected void _addGroupContentTypeConfiguration(DefaultConfiguration rootConf,
 I18nizableText groupLabel,
 Set<ContentType> cTypes)

Get the configuration of the content type item

Parameters:

rootConf - The root configuration

groupLabel - The group's label

cTypes - The content types of the group

_addContentTypeConfiguration

protected void _addContentTypeConfiguration(DefaultConfiguration rootConf,
 ContentType cType)

Get the configuration of the content type item

Parameters:

rootConf - The root configuration

cType - The content type

_getI18nizableTextConfiguration

protected DefaultConfiguration _getI18nizableTextConfiguration(String tagName,
 I18nizableText i18nText)

Get the configuration for an i18nizable text

Parameters:

tagName - the tag name

i18nText - the i18n text

Returns:

the configuration for i18nizable text

_addRightsOnContentTypeConfiguration

protected void _addRightsOnContentTypeConfiguration(DefaultConfiguration rootConf)

Get the 'rights' configuration of the content type item

Parameters:

rootConf - The root configuration

_addContentTypeIconsConfiguration

protected void _addContentTypeIconsConfiguration(DefaultConfiguration classConf,
 ContentType cType)

Add configuration for content type's icons and/or glyphes

Parameters:

classConf - the class configuration

cType - the content type

_getContentTypesByGroup

protected Map<I18nizableText,Set<ContentType>> _getContentTypesByGroup()

Get the list of content types classified by groups

Returns:

The content types

addContentType

protected void addContentType(ContentType contentType,
 Map<I18nizableText,Set<ContentType>> groups)

Add content to groups

Parameters:

contentType - The content type

groups - The groups

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.

isValidContentType

protected boolean isValidContentType(ContentType contentType)

Determines if the content type is a valid content type for the gallery

Parameters:

contentType - The coentent

Returns:

true if it is a valid content type

hasRight

protected boolean hasRight(ContentType cType)

Test if the current user has the right needed by the content type to create a content.

Parameters:

cType - the content type

Returns:

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