com.atlassian.renderer.v2

Class V2SubRenderer

java.lang.Object

com.atlassian.renderer.v2.V2SubRenderer

All Implemented Interfaces:

Renderer, SubRenderer

public class V2SubRenderer
extends Object
implements SubRenderer

Constructor Summary

Constructors

Constructor and Description
V2SubRenderer()
V2SubRenderer(Renderer renderer)

Method Summary

Methods

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

Methods inherited from class java.lang.Object

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

Constructor Detail

V2SubRenderer

public V2SubRenderer()

V2SubRenderer

public V2SubRenderer(Renderer renderer)

Method Detail

setRenderer

public void setRenderer(Renderer renderer)

render

public String render(String wiki,
            RenderContext renderContext)

Description copied from interface: Renderer

Render some content without changing render modes.

Specified by:

render in interface Renderer

Parameters:

wiki - the content to render

renderContext - the context in which it is being rendered

Returns:

the resulting HTML

renderAsText

public String renderAsText(String originalContent,
                  RenderContext context)

Description copied from interface: Renderer

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

Specified by:

renderAsText in interface Renderer

Parameters:

originalContent - is the content to render.

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

public String getRendererType()

Description copied from interface: Renderer

Returns a unique type that describes the renderer.

Specified by:

getRendererType in interface Renderer

Returns:

a string that uniquely identifies the renderer.

render

public String render(String wiki,
            RenderContext renderContext,
            RenderMode newRenderMode)

Description copied from interface: SubRenderer

Render some wiki content in a particular render mode. The subRenderer will take care of setting the new mode on the context, and returning the context to its previous mode afterwards.

Specified by:

render in interface SubRenderer

Parameters:

wiki - the content to render

renderContext - the context in which it is being rendered

newRenderMode - the RenderMode in which to render it, or null to leave the RenderMode unchanged

Returns:

the resulting HTML