com.ecyrd.jspwiki.render
Class WikiRenderer
java.lang.Object
com.ecyrd.jspwiki.render.WikiRenderer
- Direct Known Subclasses:
- CleanTextRenderer, CreoleRenderer, WysiwygEditingRenderer, XHTMLRenderer
public abstract class WikiRenderer
- extends Object
Provides an interface to the basic rendering engine.
This class is an abstract class instead of an interface because
it is expected that rendering capabilities are increased at some
point, and I would hate if renderers broke. This class allows
some sane defaults to be implemented.
- Since:
- 2.4
Method Summary |
void |
enablePlugins(boolean toggle)
Can be used to turn on plugin execution on a translator-reader basis. |
abstract String |
getString()
Renders and returns the end result. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
m_context
protected WikiContext m_context
m_document
protected WikiDocument m_document
m_enablePlugins
protected boolean m_enablePlugins
WikiRenderer
protected WikiRenderer(WikiContext context,
WikiDocument doc)
- Create a WikiRenderer.
- Parameters:
context
- A WikiContext in which the rendering will take place.doc
- The WikiDocument which shall be rendered.
enablePlugins
public void enablePlugins(boolean toggle)
- Can be used to turn on plugin execution on a translator-reader basis.
- Parameters:
toggle
- True, if plugins are to be enabled. False, if disabled.
getString
public abstract String getString()
throws IOException
- Renders and returns the end result.
- Returns:
- A rendered string.
- Throws:
IOException
- If rendering fails.