Package com.jalios.jcms.policy
Class BasicWikiPolicyFilter
- java.lang.Object
-
- com.jalios.jcms.policy.AbstractPolicyFilter
-
- com.jalios.jcms.policy.BasicWikiPolicyFilter
-
- All Implemented Interfaces:
PluginComponent
,PolicyFilter
,WikiPolicyFilter
,java.lang.Comparable
public class BasicWikiPolicyFilter extends AbstractPolicyFilter implements WikiPolicyFilter, PluginComponent
This class provides hooks for wiki rendering.- Since:
- jcms-5.7.0
-
-
Field Summary
-
Fields inherited from class com.jalios.jcms.policy.AbstractPolicyFilter
order
-
-
Constructor Summary
Constructors Constructor Description BasicWikiPolicyFilter()
-
Method Summary
All Methods Instance Methods Concrete Methods 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 renderingjava.lang.String
beforeRendering(java.lang.String text, java.util.Locale userLocale, WikiRenderingHints hints)
This method is called before wiki renderingvoid
handleWikiToolbar(WikiToolbar tb, java.lang.StringBuffer sb)
This method is called by WikiToolbar to add buttons / information at the end of wiki toolbar.boolean
init(Plugin plugin)
Initialize the component with the given plugin configuration-
Methods inherited from class com.jalios.jcms.policy.AbstractPolicyFilter
compareTo, equals, getOrder, setOrder
-
-
-
-
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 interfacePluginComponent
- Parameters:
plugin
- the calling plugin- Returns:
- true if the component has been correctly initialized.
- Since:
- jcms-5.7.1
- See Also:
PluginComponent.init(Plugin)
-
beforeRendering
public java.lang.String beforeRendering(java.lang.String text, java.util.Locale userLocale, WikiRenderingHints hints)
Description copied from interface:WikiPolicyFilter
This method is called before wiki rendering- Specified by:
beforeRendering
in interfaceWikiPolicyFilter
- Parameters:
text
- the text to be rendered.userLocale
- an optionalLocale
of the user for which the text will be generatedhints
- the rendering options to use.- Returns:
- the text.
- See Also:
WikiPolicyFilter.beforeRendering(String, Locale, WikiRenderingHints)
-
afterRendering
public java.lang.String afterRendering(java.lang.String text, java.util.Locale userLocale, WikiRenderingHints hints)
Description copied from interface:WikiPolicyFilter
This method is called after wiki rendering- Specified by:
afterRendering
in interfaceWikiPolicyFilter
- Parameters:
text
- the text after the rendering.userLocale
- an optionalLocale
of the user for which the text will be generatedhints
- the rendering options to use.- Returns:
- the text.
- See Also:
WikiPolicyFilter.afterRendering(String, Locale, WikiRenderingHints)
-
handleWikiToolbar
public void handleWikiToolbar(WikiToolbar tb, java.lang.StringBuffer sb)
Description copied from interface:WikiPolicyFilter
This method is called by WikiToolbar to add buttons / information at the end of wiki toolbar.- Specified by:
handleWikiToolbar
in interfaceWikiPolicyFilter
- Parameters:
tb
- the WikiToolbarsb
- the StringBuffer before closing </div> toolbar- See Also:
WikiPolicyFilter.handleWikiToolbar(WikiToolbar, StringBuffer)
-
-