com.liferay.portal.kernel.editor.configuration

Interface EditorConfigTransformer

public interface EditorConfigTransformer

Provides an interface for adapting an EditorOptionsContributor's high level options to a specific configuration JSON object (as used by the EditorConfigContributor).

Each editor should typically create its own Editor Config Transformer for the editor's configuration JSON objects, which can differ from those of other editors.

Implementations must be OSGi components that are registered in the OSGi Registry.

Editor Config Transformers are targeted to specific editors based on the editor.name OSGi property.

In case there's more than one Editor Config Transformer for an editor, the one with the highest service rank is used.

Author:

Sergio González

Method Summary

Modifier and Type	Method and Description
void	transform(EditorOptions editorOptions, java.util.Map<java.lang.String,java.lang.Object> inputEditorTaglibAttributes, JSONObject configJSONObject, ThemeDisplay themeDisplay, RequestBackedPortletURLFactory requestBackedPortletURLFactory) Transforms the editor options in configuration that the editor can handle, by populating the configuration JSON object.

Method Detail

transform

void transform(EditorOptions editorOptions,
               java.util.Map<java.lang.String,java.lang.Object> inputEditorTaglibAttributes,
               JSONObject configJSONObject,
               ThemeDisplay themeDisplay,
               RequestBackedPortletURLFactory requestBackedPortletURLFactory)

Transforms the editor options in configuration that the editor can handle, by populating the configuration JSON object.

Parameters:

editorOptions - the EditorOptions object composed of the options set by EditorOptionsContributor modules

inputEditorTaglibAttributes - the attributes specified to the input taglib tag that renders the editor

configJSONObject - the JSON object composed of the entire configuration set by EditorConfigContributor modules

themeDisplay - the theme display