Package org.commonmark.renderer.html

Class HtmlRenderer.RendererContext

java.lang.Object

org.commonmark.renderer.html.HtmlRenderer.RendererContext

All Implemented Interfaces:

AttributeProviderContext, HtmlNodeRendererContext

Enclosing class:

HtmlRenderer

private class HtmlRenderer.RendererContext
extends java.lang.Object
implements HtmlNodeRendererContext, AttributeProviderContext

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.List<AttributeProvider>	attributeProviders
private HtmlWriter	htmlWriter
private NodeRendererMap	nodeRendererMap

Constructor Summary

Constructors

Modifier	Constructor	Description
private	RendererContext(HtmlWriter htmlWriter)

Method Summary

Modifier and Type	Method	Description
void	afterRoot(Node node)
void	beforeRoot(Node node)
java.lang.String	encodeUrl(java.lang.String url)
java.util.Map<java.lang.String,java.lang.String>	extendAttributes(Node node, java.lang.String tagName, java.util.Map<java.lang.String,java.lang.String> attributes)	Let extensions modify the HTML tag attributes.
java.lang.String	getSoftbreak()
HtmlWriter	getWriter()
void	render(Node node)	Render the specified node and its children using the configured renderers.
private void	setCustomAttributes(Node node, java.lang.String tagName, java.util.Map<java.lang.String,java.lang.String> attrs)
boolean	shouldEscapeHtml()
boolean	shouldOmitSingleParagraphP()
boolean	shouldSanitizeUrls()
UrlSanitizer	urlSanitizer()

Methods inherited from class java.lang.Object

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

Field Detail

htmlWriter

private final HtmlWriter htmlWriter

attributeProviders

private final java.util.List<AttributeProvider> attributeProviders

nodeRendererMap

private final NodeRendererMap nodeRendererMap

Constructor Detail

RendererContext

private RendererContext(HtmlWriter htmlWriter)

Method Detail

shouldEscapeHtml

public boolean shouldEscapeHtml()

Specified by:

shouldEscapeHtml in interface HtmlNodeRendererContext

Returns:

whether HTML blocks and tags should be escaped or not

shouldOmitSingleParagraphP

public boolean shouldOmitSingleParagraphP()

Specified by:

shouldOmitSingleParagraphP in interface HtmlNodeRendererContext

Returns:

whether documents that only contain a single paragraph should be rendered without the <p> tag

shouldSanitizeUrls

public boolean shouldSanitizeUrls()

Specified by:

shouldSanitizeUrls in interface HtmlNodeRendererContext

Returns:

true if the UrlSanitizer should be used.

urlSanitizer

public UrlSanitizer urlSanitizer()

Specified by:

urlSanitizer in interface HtmlNodeRendererContext

Returns:

Sanitizer to use for securing Link href and Image src if HtmlNodeRendererContext.shouldSanitizeUrls() is true.

encodeUrl

public java.lang.String encodeUrl(java.lang.String url)

Specified by:

encodeUrl in interface HtmlNodeRendererContext

Parameters:

url - to be encoded

Returns:

an encoded URL (depending on the configuration)

extendAttributes

public java.util.Map<java.lang.String,java.lang.String> extendAttributes(Node node,
                                                                               java.lang.String tagName,
                                                                               java.util.Map<java.lang.String,java.lang.String> attributes)

Description copied from interface: HtmlNodeRendererContext

Let extensions modify the HTML tag attributes.

Specified by:

extendAttributes in interface HtmlNodeRendererContext

Parameters:

node - the node for which the attributes are applied

tagName - the HTML tag name that these attributes are for (e.g. h1, pre, code).

attributes - the attributes that were calculated by the renderer

Returns:

the extended attributes with added/updated/removed entries

getWriter

public HtmlWriter getWriter()

Specified by:

getWriter in interface HtmlNodeRendererContext

Returns:

the HTML writer to use

getSoftbreak

public java.lang.String getSoftbreak()

Specified by:

getSoftbreak in interface HtmlNodeRendererContext

Returns:

HTML that should be rendered for a soft line break

render

public void render(Node node)

Description copied from interface: HtmlNodeRendererContext

Render the specified node and its children using the configured renderers. This should be used to render child nodes; be careful not to pass the node that is being rendered, that would result in an endless loop.

Specified by:

render in interface HtmlNodeRendererContext

Parameters:

node - the node to render

beforeRoot

public void beforeRoot(Node node)

afterRoot

public void afterRoot(Node node)

setCustomAttributes

private void setCustomAttributes(Node node,
                                 java.lang.String tagName,
                                 java.util.Map<java.lang.String,java.lang.String> attrs)