| org.radeox.api.engine.RenderEngine
All known Subclasses: uk.ac.cam.caret.sakai.rwiki.component.radeox.service.impl.RWikiBaseRenderEngine, org.radeox.test.filter.mock.MockWikiRenderEngine, org.radeox.engine.BaseRenderEngine, org.radeox.test.filter.mock.MockInterWikiRenderEngine, examples.MyRenderEngine, uk.ac.cam.caret.sakai.rwiki.component.radeox.service.impl.SpecializedRenderEngine,
| RenderEngine | | public interface RenderEngine (Code) | | Interface for RenderEngines. A RenderEngine renders a input string to an
output string with the help of filters.
author:
Stephan J. Schmidt
version:
$Id: RenderEngine.java 29159 2007-04-19 01:46:15Z ajpoland@iupui.edu $ |
| Method Summary | |
| void | addMacro(Macro macro)
Add a macro to the render engine, this can be performed from a component or a webapp and will
be keyed on its name. | | public String | getName()
Name of the RenderEngine. | | public String | render(String content, RenderContext context)
Render an input with text markup and return a String with e.g. | | public void | render(Writer out, String content, RenderContext context)
Render an input with text markup and an write the result e.g. | | public String | render(Reader in, RenderContext context)
Render an input with text markup from a Reader and write the result to a
writer
Parameters:
in - Reader to read the input from
Parameters:
context - Special context for the render engine, e.g. |
| addMacro | | void addMacro(Macro macro)(Code) | | Add a macro to the render engine, this can be performed from a component or a webapp and will
be keyed on its name. If the webapp is reloaded, the macro will be replaced. When a webapp is unloaded
it will be removed from the engine.
Parameters:
macro - |
| getName | | public String getName()(Code) | | Name of the RenderEngine. This is used to get a RenderEngine instance
with EngineManager.getInstance(name);
name Name of the engine |
| render | | public String render(String content, RenderContext context)(Code) | | Render an input with text markup and return a String with e.g. HTML
Parameters:
content - String with the input to render
Parameters:
context - Special context for the render engine, e.g. with configurationinformation result Output with rendered content |
| render | | public void render(Writer out, String content, RenderContext context) throws IOException(Code) | | Render an input with text markup and an write the result e.g. HTML to a
writer
Parameters:
out - Writer to write the output to
Parameters:
content - String with the input to render
Parameters:
context - Special context for the render engine, e.g. with configurationinformation |
| render | | public String render(Reader in, RenderContext context) throws IOException(Code) | | Render an input with text markup from a Reader and write the result to a
writer
Parameters:
in - Reader to read the input from
Parameters:
context - Special context for the render engine, e.g. with configurationinformation |
|
|