org.ceryle.wiki.filters
Class AllHeadingsFilter

java.lang.Object
  com.ecyrd.jspwiki.filters.BasicPageFilter
      org.ceryle.wiki.filters.AllHeadingsFilter

All Implemented Interfaces:

PageFilter

public class AllHeadingsFilter
extends BasicPageFilter

A page filter to process additional (<h4> through <h6>) heading levels. These are not processed by the TableOfContentsPlugin, but do generate the correct markup. Note that this plugin only makes sense when the reverseHeadings feature is on.

Author:

Murray Altheim

Field Summary

Fields inherited from class com.ecyrd.jspwiki.filters.BasicPageFilter

m_engine

Constructor Summary

AllHeadingsFilter()

Method Summary

void	initialize(Properties properties) Is called whenever the a new PageFilter is instantiated and reset.
String	postTranslate(WikiContext wikiContext, String htmlContent) This method is called after a page has been fed through the TranslatorReader, so anything you are seeing here is translated content.
String	preTranslate(WikiContext wikiContext, String content) This method is called whenever a page has been loaded from the provider, but not yet been sent through the TranslatorReader.

Methods inherited from class com.ecyrd.jspwiki.filters.BasicPageFilter

destroy, initialize, postSave, preSave

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AllHeadingsFilter

public AllHeadingsFilter()

Method Detail

initialize

public void initialize(Properties properties)
                throws FilterException

Is called whenever the a new PageFilter is instantiated and reset.

Throws:

FilterException

preTranslate

public String preTranslate(WikiContext wikiContext,
                           String content)
                    throws FilterException

This method is called whenever a page has been loaded from the provider, but not yet been sent through the TranslatorReader. Note that you cannot do HTML translation here unless HTML is allowed in the wiki, because TranslatorReader is likely to escape it.

Specified by:

preTranslate in interface PageFilter

Overrides:

preTranslate in class BasicPageFilter

Parameters:

wikiContext - The current wikicontext.

content - WikiMarkup.

Throws:

FilterException

postTranslate

public String postTranslate(WikiContext wikiContext,
                            String htmlContent)
                     throws FilterException

This method is called after a page has been fed through the TranslatorReader, so anything you are seeing here is translated content. If you want to do any of your own WikiMarkup2HTML translation, do it here.

Specified by:

postTranslate in interface PageFilter

Overrides:

postTranslate in class BasicPageFilter

Throws:

FilterException