com.vladsch.flexmark.html

Interface RendererBuilder

All Superinterfaces:

DataHolder

All Known Implementing Classes:

HtmlRenderer.Builder

public interface RendererBuilder
extends DataHolder

Extension point for RenderingExtensions that only provide attributes, link resolvers or html id generators

Method Summary

Modifier and Type	Method and Description
RendererBuilder	attributeProviderFactory(AttributeProviderFactory attributeProviderFactory) Add an attribute provider for adding/changing HTML attributes to the rendered tags.
RendererBuilder	htmlIdGeneratorFactory(HeaderIdGeneratorFactory htmlIdGeneratorFactory) Add a factory for generating the header id attribute from the header's text
RendererBuilder	linkResolverFactory(LinkResolverFactory linkResolverFactory) Add a factory for instantiating a node renderer (done when rendering).

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

contains, get, getAll, keySet, toImmutable, toMutable

Method Detail

attributeProviderFactory

RendererBuilder attributeProviderFactory(AttributeProviderFactory attributeProviderFactory)

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

Parameters:

attributeProviderFactory - the attribute provider factory to add

Returns:

this

linkResolverFactory

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

Parameters:

linkResolverFactory - the factory for creating a node renderer

Returns:

this

htmlIdGeneratorFactory

RendererBuilder htmlIdGeneratorFactory(HeaderIdGeneratorFactory htmlIdGeneratorFactory)

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

Parameters:

htmlIdGeneratorFactory - the factory for generating header tag id attributes

Returns:

this