Liferay 7.0-ce-m6

com.liferay.portal.kernel.editor.configuration
Interface EditorConfigContributor

All Known Implementing Classes:
BaseEditorConfigContributor

public interface EditorConfigContributor

Provides an interface responsible for setting the configuration and options of the editor.

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

The configuration and options can be targeted for specific editors, based on three different criteria: portlet name, editor config key, and editor name. These criteria can be defined as OSGi properties with the following names:

In case there's more than one configuration, they're prioritized by the following criteria combinations (the first combination getting the highest priority):

  1. portlet name, editor config key, editor name
  2. portlet name, editor config key
  3. editor config key, editor name
  4. portlet name, editor name
  5. editor config key
  6. portlet name
  7. editor name

If there are multiple configurations having the same criteria elements, prioritization between them is based on service rank.


Method Summary
 void populateConfigJSONObject(JSONObject jsonObject, Map<String,Object> inputEditorTaglibAttributes, ThemeDisplay themeDisplay, LiferayPortletResponse liferayPortletResponse)
          Updates the original configuration JSON object to some new configuration.
 

Method Detail

populateConfigJSONObject

void populateConfigJSONObject(JSONObject jsonObject,
                              Map<String,Object> inputEditorTaglibAttributes,
                              ThemeDisplay themeDisplay,
                              LiferayPortletResponse liferayPortletResponse)
Updates the original configuration JSON object to some new configuration. It can even update or delete the original configuration, or any other configuration introduced by any other EditorConfigContributor.

The configuration object contains the configuration to be directly used by the editor. The configuration JSON object might, therefore, be different for different editors.

Parameters:
jsonObject - the original JSON object containing the entire configuration set by previous EditorConfigContributor modules
inputEditorTaglibAttributes - the attributes specified to the input taglib tag that renders the editor
themeDisplay - the theme display
liferayPortletResponse - the Liferay portlet response (optionally null). Only use the response to generate portlet URLs.

Liferay 7.0-ce-m6