com.jalios.jcms.policy
Interface WikiPolicyFilter

All Superinterfaces:

Comparable, PluginComponent, PolicyFilter

All Known Implementing Classes:

BasicWikiPolicyFilter

public interface WikiPolicyFilter
extends PolicyFilter

This class provides hooks for wiki rendering.

Since:

jcms-5.7.0

Version:

$Revision: 24040 $

Author:

Olivier Dedieu

Field Summary

static String

REVISION

Method Summary

String	afterRendering(String text, Locale userLocale, WikiRenderingHints hints) This method is called after wiki rendering
String	beforeRendering(String text, Locale userLocale, WikiRenderingHints hints) This method is called before wiki rendering
void	handleWikiToolbar(WikiToolbar tb, StringBuffer sb) This method is called by WikiToolbar to add buttons / information at the end of wiki toolbar.

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

beforeRendering

String beforeRendering(String text,
                       Locale userLocale,
                       WikiRenderingHints hints)

This method is called before wiki rendering

Parameters:

text - the text to be rendered.

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

hints - the rendering options to use.

Returns:

the text.

Since:

jcms-5.7.0

afterRendering

String afterRendering(String text,
                      Locale userLocale,
                      WikiRenderingHints hints)

This method is called after wiki rendering

Parameters:

text - the text after the rendering.

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

hints - the rendering options to use.

Returns:

the text.

Since:

jcms-5.7.0

handleWikiToolbar

void handleWikiToolbar(WikiToolbar tb,
                       StringBuffer sb)

This method is called by WikiToolbar to add buttons / information at the end of wiki toolbar.

Parameters:

tb - the WikiToolbar

sb - the StringBuffer before closing </div> toolbar