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

Class RichTextConfigurationFileImportsClientSideElement

java.lang.Object

org.ametys.core.ui.widgets.richtext.RichTextConfigurationFileImportsClientSideElement

All Implemented Interfaces:

ClientSideElement, PluginAware, Serviceable

public class RichTextConfigurationFileImportsClientSideElement
extends Object
implements ClientSideElement, PluginAware, Serviceable

This file imports extension will imports all files requires by validators and convertors from the RichTextConfigurationExtensionPoint

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
private String	_id
private String	_pluginName
private RichTextConfigurationExtensionPoint	_richTextConfigurationExtensionPoint

Constructor Summary

Constructors

Constructor	Description
RichTextConfigurationFileImportsClientSideElement()

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.
void	service(ServiceManager manager)
void	setPluginInfo(String pluginName, String featureName, String id)	Sets the plugin info relative to the current component. Note : The feature name may be null if the targeted component in declared at plugin level.

Methods inherited from class java.lang.Object

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

Field Detail

_richTextConfigurationExtensionPoint

private RichTextConfigurationExtensionPoint _richTextConfigurationExtensionPoint

_id

private String _id

_pluginName

private String _pluginName

Constructor Detail

RichTextConfigurationFileImportsClientSideElement

public RichTextConfigurationFileImportsClientSideElement()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

setPluginInfo

public void setPluginInfo(String pluginName,
                          String featureName,
                          String id)

Description copied from interface: PluginAware

Sets the plugin info relative to the current component.
Note : The feature name may be null if the targeted component in declared at plugin level.

Specified by:

setPluginInfo in interface PluginAware

Parameters:

pluginName - Unique identifier for the plugin hosting the extension

featureName - Unique feature identifier (unique for a given pluginName)

id - Unique identifier of this component

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.