com.atlassian.renderer.v2

Class V2RendererFacade

java.lang.Object

com.atlassian.renderer.v2.V2RendererFacade

All Implemented Interfaces:

WikiStyleRenderer

public class V2RendererFacade
extends Object
implements WikiStyleRenderer

The facade class for the whole rendering system. This is what you call if you want to render something from anywhere OUTSIDE the rendering subsystem. The facade is responsible for setting up the environment before the renderer is invoked, if there is anything missing.

Inside the rendering subsystem, you are more likely to call the V2Renderer directly (or the SubRenderer)

Constructor Summary

Constructors

Constructor and Description
V2RendererFacade()
V2RendererFacade(RendererConfiguration rendererConfiguration, LinkRenderer defaultLinkRenderer, EmbeddedResourceRenderer defaultEmbeddedRenderer, Renderer renderer)
V2RendererFacade(RendererConfiguration rendererConfiguration, LinkRenderer defaultLinkRenderer, EmbeddedResourceRenderer defaultEmbeddedRenderer, Renderer renderer, boolean escapeInternalTokens)

Method Summary

Modifier and Type	Method and Description
String	convertWikiToText(RenderContext context, String wiki)
String	convertWikiToXHtml(RenderContext context, String wiki) Convert a given piece of wiki text into HTML markup.
boolean	isEscapeInternalTokensEnabled()
void	setDefaultEmbeddedRenderer(EmbeddedResourceRenderer embeddedRenderer)
void	setDefaultLinkRenderer(LinkRenderer linkRenderer)
void	setEscapeInternalTokens(boolean escapeInternalTokens)
void	setRenderer(Renderer renderer)
void	setRendererConfiguration(RendererConfiguration rendererConfiguration)

Methods inherited from class java.lang.Object

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

Constructor Detail

V2RendererFacade

public V2RendererFacade()

V2RendererFacade

public V2RendererFacade(RendererConfiguration rendererConfiguration,
                        LinkRenderer defaultLinkRenderer,
                        EmbeddedResourceRenderer defaultEmbeddedRenderer,
                        Renderer renderer)

V2RendererFacade

public V2RendererFacade(RendererConfiguration rendererConfiguration,
                        LinkRenderer defaultLinkRenderer,
                        EmbeddedResourceRenderer defaultEmbeddedRenderer,
                        Renderer renderer,
                        boolean escapeInternalTokens)

Method Detail

setRendererConfiguration

public void setRendererConfiguration(RendererConfiguration rendererConfiguration)

setRenderer

public void setRenderer(Renderer renderer)

setEscapeInternalTokens

public void setEscapeInternalTokens(boolean escapeInternalTokens)

isEscapeInternalTokensEnabled

public boolean isEscapeInternalTokensEnabled()

convertWikiToXHtml

public String convertWikiToXHtml(RenderContext context,
                                 String wiki)

Description copied from interface: WikiStyleRenderer

Convert a given piece of wiki text into HTML markup.

Specified by:

convertWikiToXHtml in interface WikiStyleRenderer

Parameters:

context - the context in which to render the text

wiki - the text to render

Returns:

the HTML text produced by the rendering subsystem

convertWikiToText

public String convertWikiToText(RenderContext context,
                                String wiki)

setDefaultLinkRenderer

public void setDefaultLinkRenderer(LinkRenderer linkRenderer)

setDefaultEmbeddedRenderer

public void setDefaultEmbeddedRenderer(EmbeddedResourceRenderer embeddedRenderer)