Package org.ametys.core.ui.widgets.richtext

Class StaticRichTextConfiguration.StaticRichTextConfigurationClientSideElement

java.lang.Object

org.ametys.core.ui.widgets.richtext.StaticRichTextConfiguration.StaticRichTextConfigurationClientSideElement

All Implemented Interfaces:

ClientSideElement

Enclosing class:

StaticRichTextConfiguration

protected static class StaticRichTextConfiguration.StaticRichTextConfigurationClientSideElement
extends Object
implements ClientSideElement

A configured implementation of the ClientSideElement

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 String	_id	The identifier
protected String	_pluginName	The plugin name
protected ClientSideElement.Script	_script	The script

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	StaticRichTextConfigurationClientSideElement(Configuration configuration, String pluginName, org.slf4j.Logger logger)	Create by configuration

Method Summary

Modifier and Type	Method	Description
Map<String,List<String>>	getDependencies()	This method returns the list of dependencies, sorted by extension point.
String	getId()	Get the id of the element.
String	getPluginName()	Get the plugin name where the control was declared
Map<String,String>	getRights(Map<String,Object> contextParameters)	This method return the right that will be needed on client side.
List<ClientSideElement.Script>	getScripts(boolean ignoreRights, Map<String,Object> contextParameters)	This method return the scripts that will be used on client side.
List<ClientSideElement.Script>	getScripts(Map<String,Object> contextParameters)	This method return the scripts that will be used on client side.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_id

protected String _id

The identifier

_pluginName

protected String _pluginName

The plugin name

_script

protected ClientSideElement.Script _script

The script

Constructor Detail

StaticRichTextConfigurationClientSideElement

protected StaticRichTextConfigurationClientSideElement(Configuration configuration,
                                                       String pluginName,
                                                       org.slf4j.Logger logger)
                                                throws ConfigurationException

Create by configuration

Parameters:

configuration - The tag configuration

pluginName - The name of the plugin where it was declared

logger - The logger

Throws:

ConfigurationException - If an error occurred

Method Detail

getId

public String getId()

Description copied from interface: ClientSideElement

Get the id of the element.

Specified by:

getId in interface ClientSideElement

Returns:

the id. Can not be null.

getScripts

public List<ClientSideElement.Script> getScripts(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

Parameters:

contextParameters - Contextuals parameters transmitted by the environment.

Returns:

The list of scripts or an empty list.

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

Parameters:

ignoreRights - True to ignore the rights verification.

contextParameters - Contextuals parameters transmitted by the environment.

Returns:

The list of scripts or an empty list.

getRights

public Map<String,String> getRights(Map<String,Object> contextParameters)

Description copied from interface: ClientSideElement

This method return the right that will be needed on client side. This class will be parametrized by initial and current parameters.

Specified by:

getRights in interface ClientSideElement

Parameters:

contextParameters - Contextuals parameters transmitted by the environment.

Returns:

The rights in a Map of (rightId, context). Can be empty.

getPluginName

public String getPluginName()

Description copied from interface: ClientSideElement

Get the plugin name where the control was declared

Specified by:

getPluginName in interface ClientSideElement

Returns:

The plugin name. Can not be null.

getDependencies

public Map<String,List<String>> getDependencies()

Description copied from interface: ClientSideElement

This method returns the list of dependencies, sorted by extension point.

Specified by:

getDependencies in interface ClientSideElement

Returns:

a map of dependencies ids by extension point.