HtmlRenderer.Builder

Builder for configuring an {@link HtmlRenderer}. See methods for default configuration.

Constructors

this
this()
Undocumented in source.

Members

Functions

attributeProviderFactory
Builder attributeProviderFactory(AttributeProviderFactory attributeProviderFactory)

Add a factory for an attribute provider for adding/changing HTML attributes to the rendered tags.

build
HtmlRenderer build()

@return the configured {@link HtmlRenderer}

escapeHtml
Builder escapeHtml(bool escapeHtml)

Whether {@link HtmlInline} and {@link HtmlBlock} should be escaped, defaults to {@code false}. <p> Note that {@link HtmlInline} is only a tag itself, not the text between an opening tag and a closing tag. So markup in the text will be parsed as normal and is not affected by this option.

extensions
Builder extensions(Iterable!Extension extensions)

@param extensions extensions to use on this HTML renderer @return {@code this}

nodeRendererFactory
Builder nodeRendererFactory(HtmlNodeRendererFactory nodeRendererFactory)

Add a factory for instantiating a node renderer (done when rendering). This allows to override the rendering of node types or define rendering for custom node types. <p> If multiple node renderers for the same node type are created, the one from the factory that was added first "wins". (This is how the rendering for core node types can be overridden; the default rendering comes last.)

percentEncodeUrls
Builder percentEncodeUrls(bool percentEncodeUrls)

Whether URLs of link or images should be percent-encoded, defaults to {@code false}. <p> If enabled, the following is done: <ul> <li>Existing percent-encoded parts are preserved (e.g. "%20" is kept as "%20")</li> <li>Reserved characters such as "/" are preserved, except for "[" and "]" (see encodeURI in JS)</li> <li>Unreserved characters such as "a" are preserved</li> <li>Other characters such umlauts are percent-encoded</li> </ul>

softbreak
Builder softbreak(string softbreak)

The HTML to use for rendering a softbreak, defaults to {@code "\n"} (meaning the rendered result doesn't have a line break). <p> Set it to {@code "<br>"} (or {@code "<br />"} to make them hard breaks. <p> Set it to {@code " "} to ignore line wrapping in the source.

Meta