Package org.ametys.plugins.contentstree.ui

Class TreeToolClientSideElement

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.ui.StaticFileImportsClientSideElement

org.ametys.core.ui.StaticClientSideElement

org.ametys.plugins.contentstree.ui.TreeToolClientSideElement

All Implemented Interfaces:

ClientSideElement, LogEnabled, PluginAware, Configurable, Serviceable

Direct Known Subclasses:

ODFTreeToolClientSideElement

public class TreeToolClientSideElement
extends StaticClientSideElement

This client side element automatically add elements to the js configuration in relation with the <tree-config>

Nested Class Summary

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 content type extension point
protected ContentTypesHelper	_contentTypesHelper	The content type helper
protected String	_treeConfigId	During startup will contains the configured tree config id.
protected TreeExtensionPoint	_treeExtensionPoint	The tree configuration EP
protected ContentsTreeHelper	_treeHelper	The content types helper instance

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

_currentUserProvider, _dependencies, _featureName, _id, _pluginName, _rightManager, _rights, _rightsMode, _script

Constructor Summary

Constructors

Constructor	Description
TreeToolClientSideElement()

Method Summary

Modifier and Type	Method	Description
protected void	_lazyConfigure()	Lazy configuration of the component
void	configure(Configuration configuration)
Map<String,Object>	getRootNodeInformations(String contentId, String treeId)	Get the root node informations
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.StaticClientSideElement

_configureClass, _configureParameters, _configureScript, configureInitialParameters

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

_configureDependencies, _configureImports, _configureRights, _configureRightsMode, getDependencies, getId, getPluginName, getRights, 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

_treeHelper

protected ContentsTreeHelper _treeHelper

The content types helper instance

_treeExtensionPoint

protected TreeExtensionPoint _treeExtensionPoint

The tree configuration EP

_treeConfigId

protected String _treeConfigId

During startup will contains the configured tree config id. Null once initialized

_contentTypesHelper

protected ContentTypesHelper _contentTypesHelper

The content type helper

_contentTypeExtensionPoint

protected ContentTypeExtensionPoint _contentTypeExtensionPoint

The content type extension point

Constructor Details

TreeToolClientSideElement

public TreeToolClientSideElement()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class StaticFileImportsClientSideElement

Throws:

ServiceException

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Overrides:

configure in class StaticFileImportsClientSideElement

Throws:

ConfigurationException

_lazyConfigure

protected void _lazyConfigure()

Lazy configuration of the component

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 StaticFileImportsClientSideElement

Parameters:

ignoreRights - True to ignore the rights verification.

contextParameters - Contextuals parameters transmitted by the environment.

Returns:

The list of scripts or an empty list.

getRootNodeInformations

public Map<String,Object> getRootNodeInformations(String contentId,
 String treeId)
                                           throws Exception

Get the root node informations

Parameters:

contentId - The content

treeId - The tree config id

Returns:

The informations

Throws:

Exception - if an error occurred