com.jalios.jcms.policy

Class BasicWysiwygPolicyFilter

java.lang.Object

com.jalios.jcms.policy.AbstractPolicyFilter

com.jalios.jcms.policy.BasicWysiwygPolicyFilter

All Implemented Interfaces:

PluginComponent, PolicyFilter, WysiwygPolicyFilter, java.lang.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

Version:

$Revision: 72474 $

Author:

Jean-Philippe Encausse

Field Summary

Fields

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

Fields inherited from class com.jalios.jcms.policy.AbstractPolicyFilter

order

Constructor Summary

Constructors

Constructor and Description
BasicWysiwygPolicyFilter()

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	init(Plugin plugin) Initialize the component with the given plugin configuration
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 class com.jalios.jcms.policy.AbstractPolicyFilter

compareTo, equals, getOrder, setOrder

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

REVISION

public static final java.lang.String REVISION

See Also:

Constant Field Values

Constructor Detail

BasicWysiwygPolicyFilter

public BasicWysiwygPolicyFilter()

Method Detail

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:

PluginComponent.init(Plugin)

loadWysiwygEditor

public boolean loadWysiwygEditor(JcmsJspContext context,
                        boolean load)

Description copied from interface: WysiwygPolicyFilter

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

Specified by:

loadWysiwygEditor in interface WysiwygPolicyFilter

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.

See Also:

WysiwygPolicyFilter.loadWysiwygEditor(JcmsJspContext, boolean)

checkWysiwygCSSFile

public void checkWysiwygCSSFile(java.util.Set cssFileSet)

Description copied from interface: WysiwygPolicyFilter

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

Specified by:

checkWysiwygCSSFile in interface WysiwygPolicyFilter

Parameters:

cssFileSet - the path of CSSFile to work with

See Also:

WysiwygPolicyFilter.checkWysiwygCSSFile(Set)

checkGlobalWysiwygCSS

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

Description copied from interface: WysiwygPolicyFilter

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

Specified by:

checkGlobalWysiwygCSS in interface WysiwygPolicyFilter

Parameters:

globalStyle - Set of global style

workspace - the current Workspace

See Also:

WysiwygPolicyFilter.checkGlobalWysiwygCSS(Set, Workspace)

checkLocalWysiwygCSS

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

Description copied from interface: WysiwygPolicyFilter

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

Specified by:

checkLocalWysiwygCSS in interface WysiwygPolicyFilter

Parameters:

localStyle - Set of local style

globalStyle - the chosen global style

workspace - the current Workspace

See Also:

WysiwygPolicyFilter.checkLocalWysiwygCSS(Set, String, Workspace)

beforeRendering

public java.lang.String beforeRendering(java.lang.String text,
                               java.util.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 optionnal Locale of the user for which the text will be generated

Returns:

the text.

See Also:

WysiwygPolicyFilter.beforeRendering(String, Locale)

afterRendering

public java.lang.String afterRendering(java.lang.String text,
                              java.util.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 optionnal Locale of the user for which the text will be generated

Returns:

the text.

See Also:

WysiwygPolicyFilter.afterRendering(String, Locale)

beforeClean

public void beforeClean(java.lang.String unsafeStr,
               java.util.Map<java.lang.String,java.lang.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)
• 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 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:

WysiwygPolicyFilter.beforeClean(String, Map)

afterClean

public java.lang.String afterClean(java.lang.String unsafeStr,
                          java.lang.String safeStr,
                          java.util.Map<java.lang.String,java.lang.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);
• 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.

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:

WysiwygPolicyFilter.afterClean(String, String, Map)