com.vladsch.flexmark.html

Class HtmlRenderer

java.lang.Object

com.vladsch.flexmark.html.HtmlRenderer

All Implemented Interfaces:

IRender

public class HtmlRenderer
extends Object
implements 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.

Field Summary

Fields

Modifier and Type	Field and Description
static DataKey<Boolean>	DO_NOT_RENDER_LINKS
static DataKey<Boolean>	ESCAPE_HTML
static DataKey<Boolean>	ESCAPE_HTML_BLOCKS
static DataKey<Boolean>	ESCAPE_HTML_COMMENT_BLOCKS
static DataKey<Boolean>	ESCAPE_INLINE_HTML
static DataKey<Boolean>	ESCAPE_INLINE_HTML_COMMENTS
static DataKey<String>	FENCED_CODE_LANGUAGE_CLASS_PREFIX
static int	FORMAT_ALL_OPTIONS
static int	FORMAT_COLLAPSE_WHITESPACE
static int	FORMAT_CONVERT_TABS
static DataKey<Integer>	FORMAT_FLAGS output control for FormattingAppendable, see FormattingAppendable.setOptions(int)
static int	FORMAT_SUPPRESS_TRAILING_WHITESPACE
static DataKey<Boolean>	GENERATE_HEADER_ID
static DataKey<String>	HARD_BREAK
static DataKey<Boolean>	HEADER_ID_GENERATOR_NO_DUPED_DASHES
static DataKey<Boolean>	HEADER_ID_GENERATOR_RESOLVE_DUPES
static DataKey<String>	HEADER_ID_GENERATOR_TO_DASH_CHARS
static DataKey<Integer>	INDENT_SIZE
static DataKey<Integer>	MAX_TRAILING_BLANK_LINES
static DataKey<Boolean>	PERCENT_ENCODE_URLS
static DataKey<Boolean>	RECHECK_UNDEFINED_REFERENCES
static DataKey<Boolean>	RENDER_HEADER_ID
static DataKey<String>	SOFT_BREAK
static DataKey<String>	SOURCE_POSITION_ATTRIBUTE
static DataKey<Boolean>	SOURCE_POSITION_PARAGRAPH_LINES
static DataKey<Boolean>	SOURCE_WRAP_HTML
static DataKey<Boolean>	SOURCE_WRAP_HTML_BLOCKS
static DataKey<Boolean>	SUPPRESS_HTML
static DataKey<Boolean>	SUPPRESS_HTML_BLOCKS
static DataKey<Boolean>	SUPPRESS_HTML_COMMENT_BLOCKS
static DataKey<Boolean>	SUPPRESS_INLINE_HTML
static DataKey<Boolean>	SUPPRESS_INLINE_HTML_COMMENTS
static DataKey<ArrayList<TagRange>>	TAG_RANGES
static DataKey<String>	TYPE

Method Summary

Modifier and Type	Method and Description
static HtmlRenderer.Builder	builder() Create a new builder for configuring an HtmlRenderer.
static HtmlRenderer.Builder	builder(DataHolder options) Create a new builder for configuring an HtmlRenderer.
String	render(Node node) Render the tree of nodes to HTML.
void	render(Node node, Appendable output) Render a node to the appendable
void	render(Node node, Appendable output, int maxTrailingBlankLines) Render a node to the appendable
HtmlRenderer	withOptions(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 DataKey<String> SOFT_BREAK

HARD_BREAK

public static final DataKey<String> HARD_BREAK

PERCENT_ENCODE_URLS

public static final DataKey<Boolean> PERCENT_ENCODE_URLS

INDENT_SIZE

public static final DataKey<Integer> INDENT_SIZE

ESCAPE_HTML

public static final DataKey<Boolean> ESCAPE_HTML

ESCAPE_HTML_BLOCKS

public static final DataKey<Boolean> ESCAPE_HTML_BLOCKS

ESCAPE_HTML_COMMENT_BLOCKS

public static final DataKey<Boolean> ESCAPE_HTML_COMMENT_BLOCKS

ESCAPE_INLINE_HTML

public static final DataKey<Boolean> ESCAPE_INLINE_HTML

ESCAPE_INLINE_HTML_COMMENTS

public static final DataKey<Boolean> ESCAPE_INLINE_HTML_COMMENTS

SUPPRESS_HTML

public static final DataKey<Boolean> SUPPRESS_HTML

SUPPRESS_HTML_BLOCKS

public static final DataKey<Boolean> SUPPRESS_HTML_BLOCKS

SUPPRESS_HTML_COMMENT_BLOCKS

public static final DataKey<Boolean> SUPPRESS_HTML_COMMENT_BLOCKS

SUPPRESS_INLINE_HTML

public static final DataKey<Boolean> SUPPRESS_INLINE_HTML

SUPPRESS_INLINE_HTML_COMMENTS

public static final DataKey<Boolean> SUPPRESS_INLINE_HTML_COMMENTS

SOURCE_WRAP_HTML

public static final DataKey<Boolean> SOURCE_WRAP_HTML

SOURCE_WRAP_HTML_BLOCKS

public static final DataKey<Boolean> SOURCE_WRAP_HTML_BLOCKS

HEADER_ID_GENERATOR_RESOLVE_DUPES

public static final DataKey<Boolean> HEADER_ID_GENERATOR_RESOLVE_DUPES

HEADER_ID_GENERATOR_TO_DASH_CHARS

public static final DataKey<String> HEADER_ID_GENERATOR_TO_DASH_CHARS

HEADER_ID_GENERATOR_NO_DUPED_DASHES

public static final DataKey<Boolean> HEADER_ID_GENERATOR_NO_DUPED_DASHES

RENDER_HEADER_ID

public static final DataKey<Boolean> RENDER_HEADER_ID

GENERATE_HEADER_ID

public static final DataKey<Boolean> GENERATE_HEADER_ID

DO_NOT_RENDER_LINKS

public static final DataKey<Boolean> DO_NOT_RENDER_LINKS

FENCED_CODE_LANGUAGE_CLASS_PREFIX

public static final DataKey<String> FENCED_CODE_LANGUAGE_CLASS_PREFIX

SOURCE_POSITION_ATTRIBUTE

public static final DataKey<String> SOURCE_POSITION_ATTRIBUTE

SOURCE_POSITION_PARAGRAPH_LINES

public static final DataKey<Boolean> SOURCE_POSITION_PARAGRAPH_LINES

TYPE

public static final DataKey<String> TYPE

TAG_RANGES

public static final DataKey<ArrayList<TagRange>> TAG_RANGES

RECHECK_UNDEFINED_REFERENCES

public static final DataKey<Boolean> RECHECK_UNDEFINED_REFERENCES

FORMAT_FLAGS

public static final DataKey<Integer> FORMAT_FLAGS

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

MAX_TRAILING_BLANK_LINES

public static final DataKey<Integer> MAX_TRAILING_BLANK_LINES

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(DataHolder options)

Create a new builder for configuring an HtmlRenderer.

Parameters:

options - initialization options

Returns:

a builder

render

public void render(Node node,
                   Appendable output)

Render a node to the appendable

Specified by:

render in interface IRender

Parameters:

node - node to render

output - appendable to use for the output

render

public void render(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(Node node)

Render the tree of nodes to HTML.

Specified by:

render in interface IRender

Parameters:

node - the root node

Returns:

the rendered HTML

withOptions

public HtmlRenderer withOptions(DataHolder options)

Specified by:

withOptions in interface IRender