Class BasicWysiwygPolicyFilter

java.lang.Object
com.jalios.jcms.policy.AbstractPolicyFilter
com.jalios.jcms.policy.BasicWysiwygPolicyFilter
All Implemented Interfaces:
PluginComponent, PolicyFilter, WysiwygPolicyFilter, Comparable

public class BasicWysiwygPolicyFilter extends AbstractPolicyFilter implements WysiwygPolicyFilter, PluginComponent
This class allow users to customize behaviour of widgets by re-writing call-back methods.
Since:
jcms-5.5.0
  • Constructor Details

    • BasicWysiwygPolicyFilter

      public BasicWysiwygPolicyFilter()
  • Method Details

    • init

      public boolean init(Plugin plugin)
      Description copied from interface: PluginComponent
      Initialize the component with the given plugin configuration
      Specified by:
      init in interface PluginComponent
      Parameters:
      plugin - the calling plugin
      Returns:
      true if the component has been correctly initialized.
      Since:
      jcms-5.7.1
      See Also:
    • beforeRendering

      public String beforeRendering(String text, Locale userLocale)
      Description copied from interface: WysiwygPolicyFilter
      This method is called before wysiwyg rendering
      Specified by:
      beforeRendering in interface WysiwygPolicyFilter
      Parameters:
      text - the text to be rendered.
      userLocale - an optional Locale of the user for which the text will be generated
      Returns:
      the text.
      See Also:
    • afterRendering

      public String afterRendering(String text, Locale userLocale)
      Description copied from interface: WysiwygPolicyFilter
      This method is called after wysiwyg rendering
      Specified by:
      afterRendering in interface WysiwygPolicyFilter
      Parameters:
      text - the text after the rendering.
      userLocale - an optional Locale of the user for which the text will be generated
      Returns:
      the text.
      See Also:
    • processJHTML

      public org.jsoup.nodes.Document processJHTML(org.jsoup.nodes.Document document, Locale userLocale, WysiwygRenderingHints hints)
      Description copied from interface: WysiwygPolicyFilter
      This method is called during JHTML processing
      Specified by:
      processJHTML in interface WysiwygPolicyFilter
      Parameters:
      document - the JSoup document of the HTML to be rendered.
      userLocale - an optional Locale of the user for which the text will be generated
      hints - the rendering options to use.
      Returns:
      the document.
      See Also:
    • beforeClean

      public void beforeClean(String unsafeStr, Map<String,Object> contextMap)
      Description copied from interface: WysiwygPolicyFilter
      This method is called before cleaning process of a HTML input received from the user.

      In current implementation, the following informations can be retrieved or modified from the context map :

      • Data instance on which cleaning is performed (can be null) :
        Data data = (Data) contextMap.get(WysiwygManager.CLEANHTML_CTXT_DATA)
      • Data's field name on which cleaning is performed, as described in type xml, eg "myWysiwygField" (can be null) :
        String fieldName = (String) contextMap.get(WysiwygManager.CLEANHTML_CTXT_FIELDNAME)
      • TypeFieldEntry of field for which HTML cleanup is being performed. (can be null) :
        TypeFieldEntry tfe = (com.jalios.jcms.TypeFieldEntry) contextMap.get(WysiwygManager.CLEANHTML_CTXT_TYPEFIELDENTRY);
      • The JSoup Safelist that will be used for the cleaning process :
        Safelist safelist = (org.jsoup.safety.Safelist) contextMap.get(WysiwygManager.CLEANHTML_CTXT_SAFELIST)
        Your WysiwygPolicyFilter implementation can set a custom Safelist for this key if you want to apply a stricter or relaxed policy in some circumstances.
        Set to null to cancel the cleaning process (ie HTML parsing and cleaning), in such case, method WysiwygPolicyFilter.afterClean(String, String, Map) will still be invoked.
      Specified by:
      beforeClean in interface WysiwygPolicyFilter
      Parameters:
      unsafeStr - the input received from the user
      contextMap - the map providing information on cleaning context, NEVER null
      See Also:
    • afterClean

      public String afterClean(String unsafeStr, String safeStr, Map<String,Object> contextMap)
      Description copied from interface: WysiwygPolicyFilter
      This method is called after cleaning process of a HTML input received from the user.

      In current implementation, the following informations can be retrieved or modified from the context map :

      • Data instance on which cleaning is performed (can be null) :
        Data data = (Data) contextMap.get(WysiwygManager.CLEANHTML_CTXT_DATA);
      • Data's field name on which cleaning is performed, as described in type xml, eg "myWysiwygField" (can be null) :
        String fieldName = (String) contextMap.get(WysiwygManager.CLEANHTML_CTXT_FIELDNAME);
      • TypeFieldEntry of field for which HTML cleanup is being performed. (can be null) :
        TypeFieldEntry tfe = (com.jalios.jcms.TypeFieldEntry) contextMap.get(WysiwygManager.CLEANHTML_CTXT_TYPEFIELDENTRY);
      • The JSoup Safelist that was used for the cleaning process :
        Safelist safelist = (org.jsoup.safety.Safelist) contextMap.get(WysiwygManager.CLEANHTML_CTXT_SAFELIST);
        Can be null if a custom WysiwygPolicyFilter has cancelled the cleaning process.
      • The JSoup Document instance that was created by parsing input :
        Document dirtyDoc = (org.jsoup.nodes.Document) contextMap.get(WysiwygManager.CLEANHTML_CTXT_DIRTYDOC);
        Can be null if a custom WysiwygPolicyFilter has cancelled the cleaning process.
      • The JSoup Document instance that was created by cleaned the dirty document :
        Document cleanDoc = (org.jsoup.nodes.Document) contextMap.get(WysiwygManager.CLEANHTML_CTXT_CLEANDOC);
        Can be null if a custom WysiwygPolicyFilter has cancelled the cleaning process.
      Specified by:
      afterClean in interface WysiwygPolicyFilter
      Parameters:
      unsafeStr - the input received from the user
      safeStr - the input cleaned by JCMS (unless it was cancelled in WysiwygPolicyFilter.beforeClean(String, Map))
      contextMap - the map providing information on cleaning context, NEVER null
      Returns:
      the cleaned HTML
      See Also:
    • updateWysiwygConfiguration

      public List<WysiwygConfigurationUpdate> updateWysiwygConfiguration(String configId)
      Description copied from interface: WysiwygPolicyFilter
      Returns the list of updates to perform to the wysiwyg configuration defined by the given id.
      Specified by:
      updateWysiwygConfiguration in interface WysiwygPolicyFilter
      Parameters:
      configId - configuration id
      Returns:
      List of WysiwygConfigurationUpdate
      See Also: