Jive Forums API (5.5.20.2-oracle) Core Javadocs

com.jivesoftware.forum.renderer
Interface Renderer


public interface Renderer

A Renderer is an object that allows for converting text markup to html and back again. To use this API you would create and provide a RenderContext which contains all the necessary information for transforming the content as appropriate.

Note that this API does not provide for caching of rendered text - that is expected to be handled by classes using this API.


Method Summary
 java.lang.String render(java.lang.String content, com.jivesoftware.forum.renderer.RenderContext context)
          Render the input string according to the RenderStrategy and RenderTarget specified by the given render context.
 

Method Detail

render

java.lang.String render(java.lang.String content,
                        com.jivesoftware.forum.renderer.RenderContext context)
Render the input string according to the RenderStrategy and RenderTarget specified by the given render context.

Parameters:
content - the input to render
context - rendering context containing all necessary information required for rendering
Returns:
the rendered content

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.