com.atlassian.renderer.v2

Interface Renderer

All Known Subinterfaces:

MutableRenderer, SubRenderer

All Known Implementing Classes:

PluggableV2Renderer, V2Renderer, V2SubRenderer

public interface Renderer

Method Summary

Methods

Modifier and Type	Method and Description
String	getRendererType() Returns a unique type that describes the renderer.
String	render(String originalContent, RenderContext renderContext) Render some content without changing render modes.
String	renderAsText(String originalContent, RenderContext context) Render some content as text, performing any transforms that may be needed to produce nicely formatted text.

Method Detail

render

String render(String originalContent,
            RenderContext renderContext)

Render some content without changing render modes.

Parameters:

originalContent - the content to render

renderContext - the context in which it is being rendered

Returns:

the resulting HTML

renderAsText

String renderAsText(String originalContent,
                  RenderContext context)

Render some content as text, performing any transforms that may be needed to produce nicely formatted text.

Parameters:

originalContent - is the content to render.

context -

Returns:

a string that represents the text of the original content which has been stripped of any markup characters that need not be indexed by lucene.

getRendererType

String getRendererType()

Returns a unique type that describes the renderer.

Returns:

a string that uniquely identifies the renderer.