com.vladsch.flexmark.html

Class HtmlRenderer.Builder

java.lang.Object

com.vladsch.flexmark.util.options.DataSet

com.vladsch.flexmark.util.options.MutableDataSet

com.vladsch.flexmark.html.HtmlRenderer.Builder

All Implemented Interfaces:

RendererBuilder, com.vladsch.flexmark.util.options.DataHolder, com.vladsch.flexmark.util.options.MutableDataHolder, com.vladsch.flexmark.util.options.MutableDataSetter

Enclosing class:

HtmlRenderer

public static class HtmlRenderer.Builder
extends com.vladsch.flexmark.util.options.MutableDataSet
implements RendererBuilder

Builder for configuring an HtmlRenderer. See methods for default configuration.

Field Summary

Fields inherited from class com.vladsch.flexmark.util.options.DataSet

dataSet

Constructor Summary

Constructors

Constructor and Description
Builder()
Builder(com.vladsch.flexmark.util.options.DataHolder options)
Builder(HtmlRenderer.Builder other)
Builder(HtmlRenderer.Builder other, com.vladsch.flexmark.util.options.DataHolder options)

Method Summary

Modifier and Type	Method and Description
HtmlRenderer.Builder	attributeProviderFactory(AttributeProviderFactory attributeProviderFactory) Add an attribute provider for adding/changing HTML attributes to the rendered tags.
HtmlRenderer	build()
HtmlRenderer.Builder	escapeHtml(boolean escapeHtml) Whether HtmlInline and HtmlBlock should be escaped, defaults to false.
HtmlRenderer.Builder	extensions(Iterable<? extends Extension> extensions)
HtmlRenderer.Builder	htmlIdGeneratorFactory(HeaderIdGeneratorFactory htmlIdGeneratorFactory) Add a factory for generating the header id attribute from the header's text
HtmlRenderer.Builder	indentSize(int indentSize) The size of the indent to use for hierarchical elements, default 0, means no indent, also fastest rendering
boolean	isRendererType(String supportedRendererType)
HtmlRenderer.Builder	linkResolverFactory(LinkResolverFactory linkResolverFactory) Add a factory for instantiating a node renderer (done when rendering).
HtmlRenderer.Builder	nodeRendererFactory(NodeRendererFactory nodeRendererFactory) Add a factory for instantiating a node renderer (done when rendering).
HtmlRenderer.Builder	percentEncodeUrls(boolean percentEncodeUrls) Whether URLs of link or images should be percent-encoded, defaults to false.
HtmlRenderer.Builder	softBreak(String softBreak) The HTML to use for rendering a softbreak, defaults to "\n" (meaning the rendered result doesn't have a line break).

Methods inherited from class com.vladsch.flexmark.util.options.MutableDataSet

clear, get, getOrCompute, merge, remove, set, setAll, setFrom, setIn, toImmutable, toMutable

Methods inherited from class com.vladsch.flexmark.util.options.DataSet

contains, getAll, keySet

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vladsch.flexmark.util.options.DataHolder

contains, get, getAll, keySet, toImmutable, toMutable

Constructor Detail

Builder

public Builder()

Builder

public Builder(com.vladsch.flexmark.util.options.DataHolder options)

Builder

public Builder(HtmlRenderer.Builder other)

Builder

public Builder(HtmlRenderer.Builder other,
               com.vladsch.flexmark.util.options.DataHolder options)

Method Detail

build

public HtmlRenderer build()

Returns:

the configured HtmlRenderer

softBreak

public HtmlRenderer.Builder softBreak(String softBreak)

The HTML to use for rendering a softbreak, defaults to "\n" (meaning the rendered result doesn't have a line break).

Set it to "<br>" (or "<br />" to make them hard breaks.

Set it to " " to ignore line wrapping in the source.

Parameters:

softBreak - HTML for softbreak

Returns:

this

indentSize

public HtmlRenderer.Builder indentSize(int indentSize)

The size of the indent to use for hierarchical elements, default 0, means no indent, also fastest rendering

Parameters:

indentSize - number of spaces per indent

Returns:

this

escapeHtml

public HtmlRenderer.Builder escapeHtml(boolean escapeHtml)

Whether HtmlInline and HtmlBlock should be escaped, defaults to false.

Note that 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.

Parameters:

escapeHtml - true for escaping, false for preserving raw HTML

Returns:

this

isRendererType

public boolean isRendererType(String supportedRendererType)

percentEncodeUrls

public HtmlRenderer.Builder percentEncodeUrls(boolean percentEncodeUrls)

Whether URLs of link or images should be percent-encoded, defaults to false.

If enabled, the following is done:

• Existing percent-encoded parts are preserved (e.g. "%20" is kept as "%20")
• Reserved characters such as "/" are preserved, except for "[" and "]" (see encodeURI in JS)
• Unreserved characters such as "a" are preserved
• Other characters such umlauts are percent-encoded

Parameters:

percentEncodeUrls - true to percent-encode, false for leaving as-is

Returns:

this

attributeProviderFactory

public HtmlRenderer.Builder attributeProviderFactory(AttributeProviderFactory attributeProviderFactory)

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

Specified by:

attributeProviderFactory in interface RendererBuilder

Parameters:

attributeProviderFactory - the attribute provider factory to add

Returns:

this

nodeRendererFactory

public HtmlRenderer.Builder nodeRendererFactory(NodeRendererFactory 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.

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.)

Parameters:

nodeRendererFactory - the factory for creating a node renderer

Returns:

this

linkResolverFactory

public HtmlRenderer.Builder linkResolverFactory(LinkResolverFactory linkResolverFactory)

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.

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.)

Specified by:

linkResolverFactory in interface RendererBuilder

Parameters:

linkResolverFactory - the factory for creating a node renderer

Returns:

this

htmlIdGeneratorFactory

public HtmlRenderer.Builder htmlIdGeneratorFactory(HeaderIdGeneratorFactory htmlIdGeneratorFactory)

Add a factory for generating the header id attribute from the header's text

Specified by:

htmlIdGeneratorFactory in interface RendererBuilder

Parameters:

htmlIdGeneratorFactory - the factory for generating header tag id attributes

Returns:

this

extensions

public HtmlRenderer.Builder extensions(Iterable<? extends Extension> extensions)

Parameters:

extensions - extensions to use on this HTML renderer

Returns:

this