com.jalios.jcms.policy

Interface WysiwygPolicyFilter

All Superinterfaces:

java.lang.Comparable, PluginComponent, PolicyFilter

All Known Implementing Classes:

BasicWysiwygPolicyFilter

public interface WysiwygPolicyFilter
extends PolicyFilter

This class provides hooks for wysiwyg rendering.

Since:

jcms-5.7.0

Version:

$Revision: 63352 $

Author:

Jean-Philippe Encausse

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	REVISION

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	afterClean(java.lang.String unsafeStr, java.lang.String safeStr, java.util.Map<java.lang.String,java.lang.Object> contextMap) This method is called after cleaning process of a HTML input received from the user.
java.lang.String	afterRendering(java.lang.String text, java.util.Locale userLocale) This method is called after wysiwyg rendering
void	beforeClean(java.lang.String unsafeStr, java.util.Map<java.lang.String,java.lang.Object> contextMap) This method is called before cleaning process of a HTML input received from the user.
java.lang.String	beforeRendering(java.lang.String text, java.util.Locale userLocale) This method is called before wysiwyg rendering
void	checkGlobalWysiwygCSS(java.util.Set globalStyle, Workspace workspace) This method is a hook called by Workspace to manage wysiwyg css global style to display.
void	checkLocalWysiwygCSS(java.util.Set localStyle, java.lang.String globalStyle, Workspace workspace) This method is a hook called by Workspace to manage wysiwyg css local style to display.
void	checkWysiwygCSSFile(java.util.Set cssFileSet) This method is a hook called by Workspace to manage wysiwyg css files to parse and to display in wysiwyg css bar.
boolean	loadWysiwygEditor(JcmsJspContext context, boolean load) This method is a hook called by JcmsJspContext to fill the JavaScript headers with the javascript files required to provide the WYSIWYG editor.

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.jalios.jcms.plugin.PluginComponent

init

Field Detail

REVISION

static final java.lang.String REVISION

See Also:

Constant Field Values

Method Detail

loadWysiwygEditor

boolean loadWysiwygEditor(JcmsJspContext context,
                        boolean load)

This method is a hook called by JcmsJspContext to fill the JavaScript headers with the javascript files required to provide the WYSIWYG editor.

Parameters:

context - the JcmsJspContext for which the check should be made.

load - the value computed by JCMS, true if the wysiwyg's javascript files need to be included, false otherwise.

Returns:

true when the wysiwyg's javascript files are to be included, false otherwise.
You should not modify this method to return false when the load argument was computed to true as you will prevent the editor to be loaded where it is needed by default.

checkWysiwygCSSFile

void checkWysiwygCSSFile(java.util.Set cssFileSet)

This method is a hook called by Workspace to manage wysiwyg css files to parse and to display in wysiwyg css bar.

Parameters:

cssFileSet - the path of CSSFile to work with

See Also:

Workspace.getGlobalWYSIWYGStyle()

checkGlobalWysiwygCSS

void checkGlobalWysiwygCSS(java.util.Set globalStyle,
                         Workspace workspace)

This method is a hook called by Workspace to manage wysiwyg css global style to display.

Parameters:

globalStyle - Set of global style

workspace - the current Workspace

See Also:

Workspace.getGlobalWYSIWYGStyle()

checkLocalWysiwygCSS

void checkLocalWysiwygCSS(java.util.Set localStyle,
                        java.lang.String globalStyle,
                        Workspace workspace)

This method is a hook called by Workspace to manage wysiwyg css local style to display.

Parameters:

localStyle - Set of local style

globalStyle - the chosen global style

workspace - the current Workspace

See Also:

Workspace.getLocalWYSIWYGStyle(String)

beforeClean

void beforeClean(java.lang.String unsafeStr,
               java.util.Map<java.lang.String,java.lang.Object> contextMap)

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)
• The JSoup Whitelist that will be used for the cleaning process :
  Whitelist whitelist = (org.jsoup.safety.Whitelist) contextMap.get(WysiwygManager.CLEANHTML_CTXT_WHITELIST)
  Your WysiwygPolicyFilter implementation can set a custom Whitelist 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 afterClean(String, String, Map) will still be invoked.

Parameters:

unsafeStr - the input received from the user

contextMap - the map providing information on cleaning context, NEVER null

Since:

JCMS-3751+jcms-9.0

afterClean

java.lang.String afterClean(java.lang.String unsafeStr,
                          java.lang.String safeStr,
                          java.util.Map<java.lang.String,java.lang.Object> contextMap)

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);
• The JSoup Whitelist that was used for the cleaning process :
  Whitelist whitelist = (org.jsoup.safety.Whitelist) contextMap.get(WysiwygManager.CLEANHTML_CTXT_WHITELIST);
  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.

Parameters:

unsafeStr - the input received from the user

safeStr - the input cleaned by JCMS (unless it was cancelled in beforeClean(String, Map))

contextMap - the map providing information on cleaning context, NEVER null

Returns:

the cleaned HTML

Since:

JCMS-3751+jcms-9.0

beforeRendering

java.lang.String beforeRendering(java.lang.String text,
                               java.util.Locale userLocale)

This method is called before wysiwyg rendering

Parameters:

text - the text to be rendered.

userLocale - an optionnal Locale of the user for which the text will be generated

Returns:

the text.

Since:

jcms-5.7.0

afterRendering

java.lang.String afterRendering(java.lang.String text,
                              java.util.Locale userLocale)

This method is called after wysiwyg rendering

Parameters:

text - the text after the rendering.

userLocale - an optionnal Locale of the user for which the text will be generated

Returns:

the text.

Since:

jcms-5.7.0