|
Liferay 7.0-ce-m6 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
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:
javax.portlet.name: The portlet name. If specified, the
configuration and options populated in the JSON object are applied to every
editor used in that portlet.
editor.config.key: The key used to identify the editor (the
input-editor taglib tag's configKey attribute
value). If specified, the configuration and options populated in the JSON
object are applied to every editor with the specified configKey.
editor.name: The name of the editor (the
input-editor taglib tag's editorName attribute
value: ckeditor, ckeditor_bbcode,
alloyeditor, etc.). If specified, the configuration and options
populated in the JSON object are applied to every editor with that name.
In case there's more than one configuration, they're prioritized by the following criteria combinations (the first combination getting the highest priority):
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 |
|---|
void populateConfigJSONObject(JSONObject jsonObject,
Map<String,Object> inputEditorTaglibAttributes,
ThemeDisplay themeDisplay,
LiferayPortletResponse liferayPortletResponse)
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.
jsonObject - the original JSON object containing the entire
configuration set by previous EditorConfigContributor
modulesinputEditorTaglibAttributes - the attributes specified to the input
taglib tag that renders the editorthemeDisplay - the theme displayliferayPortletResponse - the Liferay portlet response (optionally
null). Only use the response to generate portlet
URLs.
|
Liferay 7.0-ce-m6 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||