Package org.ametys.core.ui.widgets.richtext

Interface RichTextConfiguration

All Known Implementing Classes:
HTMLEditorStyleRichTextConfiguration, StaticRichTextConfiguration
public interface RichTextConfiguration
Extension for the RichTextConfigurationExtensionPoint. Extensions are classified by categories: "" is the default category.

  • Method Details

    • getCategories

      Set<String> getCategories()
      Get the categories supported by this extension
      Returns:
      The categories supported. Cannot be null, but may be empty and of course contains the "" key for the default category.

    • getHandledTags

      Collection<RichTextConfigurationTag> getHandledTags(String category, Map<String,Object> contextualParameters)
      Get the authorized tags for the given category
      Parameters:
      category - The category. "" is the default category.
      contextualParameters - Contextuals parameters transmitted by the environment.
      Returns:
      The tags supported (can be null). The key is the html tag name supported and the value is the associated value.

    • getCSSFiles

      List<ClientSideElement.ScriptFile> getCSSFiles(String category, Map<String,Object> contextualParameters)
      Get the CSS files required during the edition of the given category.
      Parameters:
      category - The category. "" is the default category.
      contextualParameters - Contextuals parameters transmitted by the environment.
      Returns:
      The CSS files requires. Can be null.

    • getValidators

      Set<ClientSideElement> getValidators(String category, Map<String,Object> contextualParameters)
      Get the validators used during an edition of the rich text to ensure the value is correct. Validators can be differents by category.
      Parameters:
      category - The category. "" is the default category.
      contextualParameters - Contextuals parameters transmitted by the environment.
      Returns:
      The validators to use. The class of the ClientSideElement must inherit the front-side validor js interface. Can be null.

    • getConvertors

      Set<ClientSideElement> getConvertors(String category, Map<String,Object> contextualParameters)
      Get the convertors used when richtext switch from code to view and from view to code. Convertors can be differents by category.
      Parameters:
      category - The category. "" is the default category.
      contextualParameters - Contextuals parameters transmitted by the environment.
      Returns:
      The convertors to use. The class of the ClientSideElement must inherit the front-side convertor js interface. Can be null.

    • getAvailableStyles

      Map<String,Map<RichTextConfigurationStyleGroup,List<RichTextConfigurationStyle>>> getAvailableStyles(String category, Map<String,Object> contextualParameters)
      Get the available styles classified by identifiers such as "table", "link"...
      Parameters:
      category - The category. "" is the default category.
      contextualParameters - Contextuals parameters transmitted by the environment.
      Returns:
      The available styles. Can be null.