Package com.jalios.jcms.policy

Interface WikiPolicyFilter

All Superinterfaces:

java.lang.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: 112713 $

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
java.lang.String	afterRendering(java.lang.String text, java.util.Locale userLocale, WikiRenderingHints hints)	This method is called after wiki rendering
java.lang.String	beforeRendering(java.lang.String text, java.util.Locale userLocale, WikiRenderingHints hints)	This method is called before wiki rendering
void	handleWikiToolbar(WikiToolbar tb, java.lang.StringBuffer sb)	Deprecated. wiki editor is no longer maintained, port your toolbar customization to 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

beforeRendering

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

This method is called before wiki rendering

Parameters:

text - the text to be rendered.

userLocale - an optional 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

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

This method is called after wiki rendering

Parameters:

text - the text after the rendering.

userLocale - an optional 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,
                       java.lang.StringBuffer sb)

Deprecated.

wiki editor is no longer maintained, port your toolbar customization to Wysiwyg editor

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