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
Modifier and TypeFieldDescriptionprotected String
The identifierprotected String
The plugin nameprotected ClientSideElement.Script
The script -
Constructor Summary
ModifierConstructorDescriptionprotected
StaticRichTextConfigurationClientSideElement
(Configuration configuration, String pluginName, Logger logger) Create by configuration -
Method Summary
Modifier and TypeMethodDescriptionThis method returns the list of dependencies, sorted by extension point.getId()
Get the id of the element.Get the plugin name where the control was declaredThis method return the right that will be needed on client side.getScripts
(boolean ignoreRights, Map<String, Object> contextParameters) This method return the scripts that will be used on client side.getScripts
(Map<String, Object> contextParameters) This method return the scripts that will be used on client side.
-
Field Details
-
_id
The identifier -
_pluginName
The plugin name -
_script
The script
-
-
Constructor Details
-
StaticRichTextConfigurationClientSideElement
protected StaticRichTextConfigurationClientSideElement(Configuration configuration, String pluginName, Logger logger) throws ConfigurationException Create by configuration- Parameters:
configuration
- The tag configurationpluginName
- The name of the plugin where it was declaredlogger
- The logger- Throws:
ConfigurationException
- If an error occurred
-
-
Method Details
-
getId
Description copied from interface:ClientSideElement
Get the id of the element.- Specified by:
getId
in interfaceClientSideElement
- Returns:
- the id. Can not be null.
-
getScripts
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 interfaceClientSideElement
- 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 interfaceClientSideElement
- 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
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 interfaceClientSideElement
- Parameters:
contextParameters
- Contextuals parameters transmitted by the environment.- Returns:
- The rights in a Map of (rightId, context). Can be empty.
-
getPluginName
Description copied from interface:ClientSideElement
Get the plugin name where the control was declared- Specified by:
getPluginName
in interfaceClientSideElement
- Returns:
- The plugin name. Can not be null.
-
getDependencies
Description copied from interface:ClientSideElement
This method returns the list of dependencies, sorted by extension point.- Specified by:
getDependencies
in interfaceClientSideElement
- Returns:
- a map of dependencies ids by extension point.
-