com.atlassian.renderer.v2
Interface SubRenderer

All Superinterfaces:

Renderer

All Known Implementing Classes:

V2SubRenderer

public interface SubRenderer
extends Renderer

Render some sub-section of wiki content, usually in a different mode. The subrenderer is useful because it takes care of things like ensuring that the RenderContext comes back out in the same state it went in.

Method Summary

java.lang.String

render(java.lang.String wiki, RenderContext renderContext, RenderMode newRenderMode) Render some wiki content in a particular render mode.

Methods inherited from interface com.atlassian.renderer.v2.Renderer

getRendererType, render, renderAsText

Method Detail

render

java.lang.String render(java.lang.String wiki,
                        RenderContext renderContext,
                        RenderMode newRenderMode)

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.

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