Package 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,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
-
Field Summary
Fields inherited from class com.jalios.jcms.policy.AbstractPolicyFilter
order -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionThis method is called after cleaning process of a HTML input received from the user.afterRendering(String text, Locale userLocale) This method is called after wysiwyg renderingvoidbeforeClean(String unsafeStr, Map<String, Object> contextMap) This method is called before cleaning process of a HTML input received from the user.beforeRendering(String text, Locale userLocale) This method is called before wysiwyg renderingbooleanInitialize the component with the given plugin configurationorg.jsoup.nodes.DocumentprocessJHTML(org.jsoup.nodes.Document document, Locale userLocale, WysiwygRenderingHints hints) This method is called during JHTML processingupdateWysiwygConfiguration(String configId) Returns the list of updates to perform to the wysiwyg configuration defined by the given id.Methods inherited from class com.jalios.jcms.policy.AbstractPolicyFilter
compareTo, equals, getOrder, setOrderMethods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface java.lang.Comparable
compareTo
-
Constructor Details
-
BasicWysiwygPolicyFilter
public BasicWysiwygPolicyFilter()
-
-
Method Details
-
init
Description copied from interface:PluginComponentInitialize the component with the given plugin configuration- Specified by:
initin interfacePluginComponent- Parameters:
plugin- the calling plugin- Returns:
- true if the component has been correctly initialized.
- Since:
- jcms-5.7.1
- See Also:
-
beforeRendering
Description copied from interface:WysiwygPolicyFilterThis method is called before wysiwyg rendering- Specified by:
beforeRenderingin interfaceWysiwygPolicyFilter- Parameters:
text- the text to be rendered.userLocale- an optionalLocaleof the user for which the text will be generated- Returns:
- the text.
- See Also:
-
afterRendering
Description copied from interface:WysiwygPolicyFilterThis method is called after wysiwyg rendering- Specified by:
afterRenderingin interfaceWysiwygPolicyFilter- Parameters:
text- the text after the rendering.userLocale- an optionalLocaleof 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:WysiwygPolicyFilterThis method is called during JHTML processing- Specified by:
processJHTMLin interfaceWysiwygPolicyFilter- Parameters:
document- the JSoup document of the HTML to be rendered.userLocale- an optionalLocaleof the user for which the text will be generatedhints- the rendering options to use.- Returns:
- the document.
- See Also:
-
beforeClean
Description copied from interface:WysiwygPolicyFilterThis 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 tonullto cancel the cleaning process (ie HTML parsing and cleaning), in such case, methodWysiwygPolicyFilter.afterClean(String, String, Map)will still be invoked.
- Specified by:
beforeCleanin interfaceWysiwygPolicyFilter- Parameters:
unsafeStr- the input received from the usercontextMap- the map providing information on cleaning context, NEVER null- See Also:
-
Data instance on which cleaning is performed (can be null) :
-
afterClean
Description copied from interface:WysiwygPolicyFilterThis 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:
afterCleanin interfaceWysiwygPolicyFilter- Parameters:
unsafeStr- the input received from the usersafeStr- the input cleaned by JCMS (unless it was cancelled inWysiwygPolicyFilter.beforeClean(String, Map))contextMap- the map providing information on cleaning context, NEVER null- Returns:
- the cleaned HTML
- See Also:
-
Data instance on which cleaning is performed (can be null) :
-
updateWysiwygConfiguration
Description copied from interface:WysiwygPolicyFilterReturns the list of updates to perform to the wysiwyg configuration defined by the given id.- Specified by:
updateWysiwygConfigurationin interfaceWysiwygPolicyFilter- Parameters:
configId- configuration id- Returns:
- List of
WysiwygConfigurationUpdate - See Also:
-