com.jalios.jcms.policy
Interface WysiwygPolicyFilter

All Superinterfaces:
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: 19371 $
Author:
Jean-Philippe Encausse

Field Summary
static String REVISION
           
 
Method Summary
 String afterRendering(String text, Locale userLocale)
          This method is called after wysiwyg rendering
 String beforeRendering(String text, Locale userLocale)
          This method is called before wysiwyg rendering
 void checkGlobalWysiwygCSS(Set globalStyle, Workspace workspace)
          This method is a hook called by Workspace to manage wysiwyg css global style to display.
 void checkLocalWysiwygCSS(Set localStyle, String globalStyle, Workspace workspace)
          This method is a hook called by Workspace to manage wysiwyg css local style to display.
 void checkWysiwygCSSFile(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 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(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(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(Set localStyle,
                          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)

beforeRendering

String beforeRendering(String text,
                       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

String afterRendering(String text,
                      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


Copyright © 2001-2010 Jalios SA. All Rights Reserved.