Interface EditorOptionsContributor


public interface EditorOptionsContributor
Provides an interface for setting the editor's options. Editor configuration can be set using EditorConfigContributor.

This interface facilitates configuring options at a higher level than using EditorConfigContributor. The former requires knowledge about the editor internals, while the latter is more versatile in terms of customization.

The options specified through this interface are not tied to any particular editor implementation. A EditorConfigTransformer transforms these high level options to a low level configuration object.

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

The options can be targeted for specific editors, based on three 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 options 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 options 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 options are applied to every editor with that name.

In case there's more than one options contributor, they're prioritized by the following criteria combinations (the lower the criteria's number, the higher it's prioritized):

  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
  8. empty

If there are multiple contributors with the same criteria elements, they're prioritized by service rank.

Author:
Sergio González
  • Method Details

    • populateEditorOptions

      void populateEditorOptions(EditorOptions editorOptions, Map<String,Object> inputEditorTaglibAttributes, ThemeDisplay themeDisplay, RequestBackedPortletURLFactory requestBackedPortletURLFactory)
      Updates the original EditorOptions object with new options. It can even update or delete the original options, or any other options introduced by any other EditorOptionsContributor.

      The editor options object contains the options to be transformed by the Editor Config Transformer to a configuration JSON object.

      Parameters:
      editorOptions - the original EditorOptions object containing the options set by EditorOptionsContributor modules
      inputEditorTaglibAttributes - the attributes specified to the input taglib tag that renders the editor
      themeDisplay - the theme display