com.vladsch.flexmark.html

Class HtmlRenderer

java.lang.Object

com.vladsch.flexmark.html.HtmlRenderer

All Implemented Interfaces:

com.vladsch.flexmark.IRender

public class HtmlRenderer
extends Object
implements com.vladsch.flexmark.IRender

Renders a tree of nodes to HTML.

Start with the builder method to configure the renderer. Example:

 HtmlRenderer renderer = HtmlRenderer.builder().escapeHtml(true).build();
 renderer.render(node);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HtmlRenderer.Builder Builder for configuring an HtmlRenderer.
static interface	HtmlRenderer.HtmlRendererExtension Extension for HtmlRenderer.
static class	HtmlRenderer.RendererDependencies
static class	HtmlRenderer.RendererDependencyStage

Field Summary

Fields

Modifier and Type	Field and Description
static com.vladsch.flexmark.util.options.DataKey<String>	AUTOLINK_WWW_PREFIX
static com.vladsch.flexmark.util.options.DataKey<String>	CODE_STYLE_HTML_CLOSE
static com.vladsch.flexmark.util.options.DataKey<String>	CODE_STYLE_HTML_OPEN
static com.vladsch.flexmark.util.options.DataKey<Boolean>	DO_NOT_RENDER_LINKS
static com.vladsch.flexmark.util.options.DataKey<String>	EMPHASIS_STYLE_HTML_CLOSE
static com.vladsch.flexmark.util.options.DataKey<String>	EMPHASIS_STYLE_HTML_OPEN
static com.vladsch.flexmark.util.options.DataKey<Boolean>	ESCAPE_HTML
static com.vladsch.flexmark.util.options.DataKey<Boolean>	ESCAPE_HTML_BLOCKS
static com.vladsch.flexmark.util.options.DataKey<Boolean>	ESCAPE_HTML_COMMENT_BLOCKS
static com.vladsch.flexmark.util.options.DataKey<Boolean>	ESCAPE_INLINE_HTML
static com.vladsch.flexmark.util.options.DataKey<Boolean>	ESCAPE_INLINE_HTML_COMMENTS
static com.vladsch.flexmark.util.options.DataKey<String>	FENCED_CODE_LANGUAGE_CLASS_PREFIX
static com.vladsch.flexmark.util.options.DataKey<String>	FENCED_CODE_NO_LANGUAGE_CLASS
static int	FORMAT_ALL_OPTIONS
static int	FORMAT_COLLAPSE_WHITESPACE
static int	FORMAT_CONVERT_TABS
static com.vladsch.flexmark.util.options.DataKey<Integer>	FORMAT_FLAGS output control for FormattingAppendable, see FormattingAppendable.setOptions(int)
static int	FORMAT_SUPPRESS_TRAILING_WHITESPACE
static com.vladsch.flexmark.util.options.DataKey<Boolean>	GENERATE_HEADER_ID
static com.vladsch.flexmark.util.options.DataKey<String>	HARD_BREAK
static com.vladsch.flexmark.util.options.DataKey<Boolean>	HEADER_ID_GENERATOR_NO_DUPED_DASHES
static com.vladsch.flexmark.util.options.DataKey<String>	HEADER_ID_GENERATOR_NON_DASH_CHARS
static com.vladsch.flexmark.util.options.DataKey<Boolean>	HEADER_ID_GENERATOR_RESOLVE_DUPES
static com.vladsch.flexmark.util.options.DataKey<String>	HEADER_ID_GENERATOR_TO_DASH_CHARS
static com.vladsch.flexmark.util.options.DataKey<Boolean>	HTML_BLOCK_CLOSE_TAG_EOL
static com.vladsch.flexmark.util.options.DataKey<Boolean>	HTML_BLOCK_OPEN_TAG_EOL
static com.vladsch.flexmark.util.options.DataKey<Integer>	INDENT_SIZE
static com.vladsch.flexmark.util.options.DataKey<String>	INLINE_CODE_SPLICE_CLASS
static com.vladsch.flexmark.util.options.DataKey<Integer>	MAX_TRAILING_BLANK_LINES
static com.vladsch.flexmark.util.options.DataKey<Boolean>	OBFUSCATE_EMAIL
static com.vladsch.flexmark.util.options.DataKey<Boolean>	OBFUSCATE_EMAIL_RANDOM
static com.vladsch.flexmark.util.options.DataKey<Boolean>	PERCENT_ENCODE_URLS
static com.vladsch.flexmark.util.options.DataKey<Boolean>	RECHECK_UNDEFINED_REFERENCES
static com.vladsch.flexmark.util.options.DataKey<Boolean>	RENDER_HEADER_ID
static com.vladsch.flexmark.util.options.DataKey<List<com.vladsch.flexmark.util.Pair<String,String>>>	RENDERER_TYPE_EQUIVALENCE Stores pairs of equivalent renderer types to allow extensions to resolve types not known to them Pair contains: rendererType, equivalentType
static com.vladsch.flexmark.util.options.DataKey<String>	SOFT_BREAK
static com.vladsch.flexmark.util.options.DataKey<String>	SOURCE_POSITION_ATTRIBUTE
static com.vladsch.flexmark.util.options.DataKey<Boolean>	SOURCE_POSITION_PARAGRAPH_LINES
static com.vladsch.flexmark.util.options.DataKey<Boolean>	SOURCE_WRAP_HTML
static com.vladsch.flexmark.util.options.DataKey<Boolean>	SOURCE_WRAP_HTML_BLOCKS
static com.vladsch.flexmark.util.options.DataKey<String>	STRONG_EMPHASIS_STYLE_HTML_CLOSE
static com.vladsch.flexmark.util.options.DataKey<String>	STRONG_EMPHASIS_STYLE_HTML_OPEN
static com.vladsch.flexmark.util.options.DataKey<Boolean>	SUPPRESS_HTML
static com.vladsch.flexmark.util.options.DataKey<Boolean>	SUPPRESS_HTML_BLOCKS
static com.vladsch.flexmark.util.options.DataKey<Boolean>	SUPPRESS_HTML_COMMENT_BLOCKS
static com.vladsch.flexmark.util.options.DataKey<Boolean>	SUPPRESS_INLINE_HTML
static com.vladsch.flexmark.util.options.DataKey<Boolean>	SUPPRESS_INLINE_HTML_COMMENTS
static com.vladsch.flexmark.util.options.DataKey<String>	SUPPRESSED_LINKS
static com.vladsch.flexmark.util.options.DataKey<ArrayList<com.vladsch.flexmark.util.sequence.TagRange>>	TAG_RANGES
static com.vladsch.flexmark.util.options.DataKey<String>	TYPE
static com.vladsch.flexmark.util.options.DataKey<Boolean>	UNESCAPE_HTML_ENTITIES

Method Summary

Modifier and Type	Method and Description
static com.vladsch.flexmark.util.options.MutableDataHolder	addRenderTypeEquivalence(com.vladsch.flexmark.util.options.MutableDataHolder options, String rendererType, String supportedRendererType)
static HtmlRenderer.Builder	builder() Create a new builder for configuring an HtmlRenderer.
static HtmlRenderer.Builder	builder(com.vladsch.flexmark.util.options.DataHolder options) Create a new builder for configuring an HtmlRenderer.
static boolean	isCompatibleRendererType(com.vladsch.flexmark.util.options.MutableDataHolder options, String supportedRendererType)
static boolean	isCompatibleRendererType(com.vladsch.flexmark.util.options.MutableDataHolder options, String rendererType, String supportedRendererType)
String	render(com.vladsch.flexmark.ast.Node node) Render the tree of nodes to HTML.
void	render(com.vladsch.flexmark.ast.Node node, Appendable output) Render a node to the appendable
void	render(com.vladsch.flexmark.ast.Node node, Appendable output, int maxTrailingBlankLines) Render a node to the appendable
HtmlRenderer	withOptions(com.vladsch.flexmark.util.options.DataHolder options)

Methods inherited from class java.lang.Object

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

Field Detail

SOFT_BREAK

public static final com.vladsch.flexmark.util.options.DataKey<String> SOFT_BREAK

HARD_BREAK

public static final com.vladsch.flexmark.util.options.DataKey<String> HARD_BREAK

STRONG_EMPHASIS_STYLE_HTML_OPEN

public static final com.vladsch.flexmark.util.options.DataKey<String> STRONG_EMPHASIS_STYLE_HTML_OPEN

STRONG_EMPHASIS_STYLE_HTML_CLOSE

public static final com.vladsch.flexmark.util.options.DataKey<String> STRONG_EMPHASIS_STYLE_HTML_CLOSE

EMPHASIS_STYLE_HTML_OPEN

public static final com.vladsch.flexmark.util.options.DataKey<String> EMPHASIS_STYLE_HTML_OPEN

EMPHASIS_STYLE_HTML_CLOSE

public static final com.vladsch.flexmark.util.options.DataKey<String> EMPHASIS_STYLE_HTML_CLOSE

CODE_STYLE_HTML_OPEN

public static final com.vladsch.flexmark.util.options.DataKey<String> CODE_STYLE_HTML_OPEN

CODE_STYLE_HTML_CLOSE

public static final com.vladsch.flexmark.util.options.DataKey<String> CODE_STYLE_HTML_CLOSE

INLINE_CODE_SPLICE_CLASS

public static final com.vladsch.flexmark.util.options.DataKey<String> INLINE_CODE_SPLICE_CLASS

PERCENT_ENCODE_URLS

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> PERCENT_ENCODE_URLS

INDENT_SIZE

public static final com.vladsch.flexmark.util.options.DataKey<Integer> INDENT_SIZE

ESCAPE_HTML

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> ESCAPE_HTML

ESCAPE_HTML_BLOCKS

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> ESCAPE_HTML_BLOCKS

ESCAPE_HTML_COMMENT_BLOCKS

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> ESCAPE_HTML_COMMENT_BLOCKS

ESCAPE_INLINE_HTML

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> ESCAPE_INLINE_HTML

ESCAPE_INLINE_HTML_COMMENTS

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> ESCAPE_INLINE_HTML_COMMENTS

SUPPRESS_HTML

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> SUPPRESS_HTML

SUPPRESS_HTML_BLOCKS

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> SUPPRESS_HTML_BLOCKS

SUPPRESS_HTML_COMMENT_BLOCKS

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> SUPPRESS_HTML_COMMENT_BLOCKS

SUPPRESS_INLINE_HTML

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> SUPPRESS_INLINE_HTML

SUPPRESS_INLINE_HTML_COMMENTS

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> SUPPRESS_INLINE_HTML_COMMENTS

SOURCE_WRAP_HTML

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> SOURCE_WRAP_HTML

SOURCE_WRAP_HTML_BLOCKS

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> SOURCE_WRAP_HTML_BLOCKS

HEADER_ID_GENERATOR_RESOLVE_DUPES

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> HEADER_ID_GENERATOR_RESOLVE_DUPES

HEADER_ID_GENERATOR_TO_DASH_CHARS

public static final com.vladsch.flexmark.util.options.DataKey<String> HEADER_ID_GENERATOR_TO_DASH_CHARS

HEADER_ID_GENERATOR_NON_DASH_CHARS

public static final com.vladsch.flexmark.util.options.DataKey<String> HEADER_ID_GENERATOR_NON_DASH_CHARS

HEADER_ID_GENERATOR_NO_DUPED_DASHES

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> HEADER_ID_GENERATOR_NO_DUPED_DASHES

RENDER_HEADER_ID

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> RENDER_HEADER_ID

GENERATE_HEADER_ID

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> GENERATE_HEADER_ID

DO_NOT_RENDER_LINKS

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> DO_NOT_RENDER_LINKS

FENCED_CODE_LANGUAGE_CLASS_PREFIX

public static final com.vladsch.flexmark.util.options.DataKey<String> FENCED_CODE_LANGUAGE_CLASS_PREFIX

FENCED_CODE_NO_LANGUAGE_CLASS

public static final com.vladsch.flexmark.util.options.DataKey<String> FENCED_CODE_NO_LANGUAGE_CLASS

SOURCE_POSITION_ATTRIBUTE

public static final com.vladsch.flexmark.util.options.DataKey<String> SOURCE_POSITION_ATTRIBUTE

SOURCE_POSITION_PARAGRAPH_LINES

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> SOURCE_POSITION_PARAGRAPH_LINES

TYPE

public static final com.vladsch.flexmark.util.options.DataKey<String> TYPE

TAG_RANGES

public static final com.vladsch.flexmark.util.options.DataKey<ArrayList<com.vladsch.flexmark.util.sequence.TagRange>> TAG_RANGES

RECHECK_UNDEFINED_REFERENCES

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> RECHECK_UNDEFINED_REFERENCES

OBFUSCATE_EMAIL

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> OBFUSCATE_EMAIL

OBFUSCATE_EMAIL_RANDOM

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> OBFUSCATE_EMAIL_RANDOM

HTML_BLOCK_OPEN_TAG_EOL

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> HTML_BLOCK_OPEN_TAG_EOL

HTML_BLOCK_CLOSE_TAG_EOL

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> HTML_BLOCK_CLOSE_TAG_EOL

UNESCAPE_HTML_ENTITIES

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> UNESCAPE_HTML_ENTITIES

AUTOLINK_WWW_PREFIX

public static final com.vladsch.flexmark.util.options.DataKey<String> AUTOLINK_WWW_PREFIX

SUPPRESSED_LINKS

public static final com.vladsch.flexmark.util.options.DataKey<String> SUPPRESSED_LINKS

FORMAT_FLAGS

public static final com.vladsch.flexmark.util.options.DataKey<Integer> FORMAT_FLAGS

output control for FormattingAppendable, see FormattingAppendable.setOptions(int)

MAX_TRAILING_BLANK_LINES

public static final com.vladsch.flexmark.util.options.DataKey<Integer> MAX_TRAILING_BLANK_LINES

RENDERER_TYPE_EQUIVALENCE

public static final com.vladsch.flexmark.util.options.DataKey<List<com.vladsch.flexmark.util.Pair<String,String>>> RENDERER_TYPE_EQUIVALENCE

Stores pairs of equivalent renderer types to allow extensions to resolve types not known to them Pair contains: rendererType, equivalentType

FORMAT_CONVERT_TABS

public static final int FORMAT_CONVERT_TABS

See Also:

Constant Field Values

FORMAT_COLLAPSE_WHITESPACE

public static final int FORMAT_COLLAPSE_WHITESPACE

See Also:

Constant Field Values

FORMAT_SUPPRESS_TRAILING_WHITESPACE

public static final int FORMAT_SUPPRESS_TRAILING_WHITESPACE

See Also:

Constant Field Values

FORMAT_ALL_OPTIONS

public static final int FORMAT_ALL_OPTIONS

See Also:

Constant Field Values

Method Detail

builder

public static HtmlRenderer.Builder builder()

Create a new builder for configuring an HtmlRenderer.

Returns:

a builder

builder

public static HtmlRenderer.Builder builder(com.vladsch.flexmark.util.options.DataHolder options)

Create a new builder for configuring an HtmlRenderer.

Parameters:

options - initialization options

Returns:

a builder

render

public void render(com.vladsch.flexmark.ast.Node node,
                   Appendable output)

Render a node to the appendable

Specified by:

render in interface com.vladsch.flexmark.IRender

Parameters:

node - node to render

output - appendable to use for the output

render

public void render(com.vladsch.flexmark.ast.Node node,
                   Appendable output,
                   int maxTrailingBlankLines)

Render a node to the appendable

Parameters:

node - node to render

output - appendable to use for the output

render

public String render(com.vladsch.flexmark.ast.Node node)

Render the tree of nodes to HTML.

Specified by:

render in interface com.vladsch.flexmark.IRender

Parameters:

node - the root node

Returns:

the rendered HTML

withOptions

public HtmlRenderer withOptions(com.vladsch.flexmark.util.options.DataHolder options)

Specified by:

withOptions in interface com.vladsch.flexmark.IRender

isCompatibleRendererType

public static boolean isCompatibleRendererType(com.vladsch.flexmark.util.options.MutableDataHolder options,
                                               String supportedRendererType)

isCompatibleRendererType

public static boolean isCompatibleRendererType(com.vladsch.flexmark.util.options.MutableDataHolder options,
                                               String rendererType,
                                               String supportedRendererType)

addRenderTypeEquivalence

public static com.vladsch.flexmark.util.options.MutableDataHolder addRenderTypeEquivalence(com.vladsch.flexmark.util.options.MutableDataHolder options,
                                                                                           String rendererType,
                                                                                           String supportedRendererType)