Package org.ametys.cms.clientsideelement

Class ReferenceTablesGallery

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

org.ametys.cms.clientsideelement.ReferenceTablesGallery

All Implemented Interfaces:

ClientSideElement, MenuClientSideElement, LogEnabled, PluginAware, Configurable, Serviceable

public class ReferenceTablesGallery
extends ContentTypesGallery

This element creates a menu with one gallery item per reference table content type classified by category.

Nested Class Summary

Nested classes/interfaces inherited from class org.ametys.cms.clientsideelement.ContentTypesGallery

ContentTypesGallery.ContentTypeClientSideElementComparator

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 HierarchicalReferenceTablesHelper	_hierarchicalSimpleContentsHelper	The helper component for hierarchical simple contents

Fields inherited from class org.ametys.cms.clientsideelement.ContentTypesGallery

_contentTypeExtensionPoint, _i18nUtils, _languagesManager, _rootContentHelper

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

Method Summary

Modifier and Type	Method	Description
protected void	_addContentTypeConfiguration(DefaultConfiguration rootConf, ContentType cType)	Get the configuration of the content type item
protected Map<String,List<String>>	_configureDependencies(Configuration configuration)	Configure the dependencies following the configuration
protected List<ContentType>	getReferenceTables()	Get the list of available simple content types
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.cms.clientsideelement.ContentTypesGallery

_addContentTypeIconsConfiguration, _addGroupContentTypeConfiguration, _addRightsOnContentTypeConfiguration, _configureScript, _getContentTypesByGroup, _getGalleryItems, _getI18nizableTextConfiguration, addContentType

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

_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

_hierarchicalSimpleContentsHelper

protected HierarchicalReferenceTablesHelper _hierarchicalSimpleContentsHelper

The helper component for hierarchical simple contents

Constructor Detail

ReferenceTablesGallery

public ReferenceTablesGallery()

Method Detail

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class ContentTypesGallery

Throws:

ServiceException

isValidContentType

protected boolean isValidContentType(ContentType contentType)

Description copied from class: ContentTypesGallery

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

Overrides:

isValidContentType in class ContentTypesGallery

Parameters:

contentType - The coentent

Returns:

true if it is a valid content type

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 ContentTypesGallery

Parameters:

ignoreRights - True to ignore the rights verification.

contextParameters - Contextuals parameters transmitted by the environment.

Returns:

The list of scripts or an empty list.

getReferenceTables

protected List<ContentType> getReferenceTables()

Get the list of available simple content types

Returns:

The simple content types

_addContentTypeConfiguration

protected void _addContentTypeConfiguration(DefaultConfiguration rootConf,
                                            ContentType cType)

Description copied from class: ContentTypesGallery

Get the configuration of the content type item

Overrides:

_addContentTypeConfiguration in class ContentTypesGallery

Parameters:

rootConf - The root configuration

cType - The content type

hasRight

protected boolean hasRight(ContentType cType)

Description copied from class: ContentTypesGallery

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

Overrides:

hasRight in class ContentTypesGallery

Parameters:

cType - the content type

Returns:

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

_configureDependencies

protected Map<String,List<String>> _configureDependencies(Configuration configuration)
                                                         throws ConfigurationException

Description copied from class: StaticFileImportsClientSideElement

Configure the dependencies following the configuration

Overrides:

_configureDependencies in class StaticFileImportsClientSideElement

Parameters:

configuration - The root configuration

Returns:

The list of dependencies, by extension point.

Throws:

ConfigurationException - if a dependency element is present but empty