Top Description Inners Fields Constructors Methods
com.vladsch.flexmark.html

public Class HtmlRenderer

extends Object
implements IRender
Class Inheritance
All Implemented Interfaces
com.vladsch.flexmark.util.ast.IRender
Annotations
@SuppressWarnings:WeakerAccess
Imports
com.vladsch.flexmark.ast.HtmlBlock, .HtmlInline, com.vladsch.flexmark.html.renderer.*, com.vladsch.flexmark.util.ast.Document, .IRender, .Node, com.vladsch.flexmark.util.builder.BuilderBase, com.vladsch.flexmark.util.data.*, com.vladsch.flexmark.util.dependency.DependencyResolver, com.vladsch.flexmark.util.format.TrackedOffset, .TrackedOffsetUtils, com.vladsch.flexmark.util.html.Attributes, .MutableAttributes, com.vladsch.flexmark.util.misc.Extension, .Pair, com.vladsch.flexmark.util.sequence.Escaping, .LineAppendable, .TagRange, org.jetbrains.annotations.NotNull, .Nullable, java.util.*
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 and Inner Type Summary

Modifier and TypeClass and Description
public static class
HtmlRenderer.Builder

Builder for configuring an HtmlRenderer.

public static interface
HtmlRenderer.HtmlRendererExtension

Extension for HtmlRenderer.

private class
HtmlRenderer.MainNodeRenderer

Field Summary

Modifier and TypeField and Description
pack-priv final List<AttributeProviderFactory>
attributeProviderFactories

public static final NullableDataKey<String>
CODE_STYLE_HTML_CLOSE

public static final NullableDataKey<String>
CODE_STYLE_HTML_OPEN

public static final int
COLLAPSE_WHITESPACE

Deprecated
public static final int
CONVERT_TABS

Deprecated
public static final DataKey<Boolean>
DO_NOT_RENDER_LINKS

public static final DataKey<Boolean>
EMBEDDED_ATTRIBUTE_PROVIDER

public static final NullableDataKey<String>
EMPHASIS_STYLE_HTML_CLOSE

public static final NullableDataKey<String>
EMPHASIS_STYLE_HTML_OPEN

public static final DataKey<Boolean>
ESCAPE_HTML

public static final DataKey<Boolean>
ESCAPE_HTML_BLOCKS

public static final DataKey<Boolean>
ESCAPE_HTML_COMMENT_BLOCKS

public static final DataKey<Boolean>
ESCAPE_INLINE_HTML

public static final DataKey<Boolean>
ESCAPE_INLINE_HTML_COMMENTS

public static final DataKey<HashMap<String, String>>
FENCED_CODE_LANGUAGE_CLASS_MAP

public static final DataKey<String>
FENCED_CODE_LANGUAGE_CLASS_PREFIX

public static final DataKey<String>
FENCED_CODE_LANGUAGE_DELIMITERS

public static final DataKey<String>
FENCED_CODE_NO_LANGUAGE_CLASS

public static final int
FORMAT_ALL

Deprecated
public static final int
FORMAT_ALL_OPTIONS

Deprecated
public static final int
FORMAT_COLLAPSE_WHITESPACE

Deprecated
public static final int
FORMAT_CONVERT_TABS

Deprecated
public static final DataKey<Integer>
FORMAT_FLAGS

output control for FormattingAppendable, see LineAppendable#setOptions(int)

public static final int
FORMAT_SUPPRESS_TRAILING_WHITESPACE

Deprecated
public static final DataKey<Boolean>
GENERATE_HEADER_ID

public static final DataKey<String>
HARD_BREAK

public static final DataKey<Boolean>
HEADER_ID_ADD_EMOJI_SHORTCUT

public static final DataKey<Boolean>
HEADER_ID_GENERATOR_NO_DUPED_DASHES

public static final DataKey<Boolean>
HEADER_ID_GENERATOR_NON_ASCII_TO_LOWERCASE

public static final DataKey<String>
HEADER_ID_GENERATOR_NON_DASH_CHARS

public static final DataKey<Boolean>
HEADER_ID_GENERATOR_RESOLVE_DUPES

public static final DataKey<String>
HEADER_ID_GENERATOR_TO_DASH_CHARS

public static final DataKey<Boolean>
HEADER_ID_REF_TEXT_TRIM_LEADING_SPACES

public static final DataKey<Boolean>
HEADER_ID_REF_TEXT_TRIM_TRAILING_SPACES

public static final DataKey<Boolean>
HTML_BLOCK_CLOSE_TAG_EOL

public static final DataKey<Boolean>
HTML_BLOCK_OPEN_TAG_EOL

pack-priv final HeaderIdGeneratorFactory
htmlIdGeneratorFactory

pack-priv final HtmlRendererOptions
htmlOptions

public static final DataKey<Integer>
INDENT_SIZE

public static final NullableDataKey<String>
INLINE_CODE_SPLICE_CLASS

pack-priv final List<LinkResolverFactory>
linkResolverFactories

public static final DataKey<Integer>
MAX_BLANK_LINES

public static final DataKey<Integer>
MAX_TRAILING_BLANK_LINES

public static final DataKey<Boolean>
NO_P_TAGS_USE_BR

pack-priv final List<DelegatingNodeRendererFactoryWrapper>
nodeRendererFactories

public static final DataKey<Boolean>
OBFUSCATE_EMAIL

public static final DataKey<Boolean>
OBFUSCATE_EMAIL_RANDOM

pack-priv final DataHolder
options

public static final int
PASS_THROUGH

Deprecated
public static final DataKey<Boolean>
PERCENT_ENCODE_URLS

public static final DataKey<Boolean>
RECHECK_UNDEFINED_REFERENCES

public static final DataKey<Boolean>
RENDER_HEADER_ID

public static final DataKey<List<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

public static final DataKey<String>
SOFT_BREAK

public static final DataKey<String>
SOURCE_POSITION_ATTRIBUTE

public static final DataKey<Boolean>
SOURCE_POSITION_PARAGRAPH_LINES

public static final DataKey<Boolean>
SOURCE_WRAP_HTML

public static final DataKey<Boolean>
SOURCE_WRAP_HTML_BLOCKS

public static final NullableDataKey<String>
STRONG_EMPHASIS_STYLE_HTML_CLOSE

public static final NullableDataKey<String>
STRONG_EMPHASIS_STYLE_HTML_OPEN

public static final DataKey<Boolean>
SUPPRESS_HTML

public static final DataKey<Boolean>
SUPPRESS_HTML_BLOCKS

public static final DataKey<Boolean>
SUPPRESS_HTML_COMMENT_BLOCKS

public static final DataKey<Boolean>
SUPPRESS_INLINE_HTML

public static final DataKey<Boolean>
SUPPRESS_INLINE_HTML_COMMENTS

public static final int
SUPPRESS_TRAILING_WHITESPACE

Deprecated
public static final DataKey<String>
SUPPRESSED_LINKS

public static final DataKey<ArrayList<TagRange>>
TAG_RANGES

public static final DataKey<List<TrackedOffset>>
TRACKED_OFFSETS

public static final DataKey<String>
TYPE

public static final DataKey<Boolean>
UNESCAPE_HTML_ENTITIES

Constructor Summary

AccessConstructor and Description
pack-priv
HtmlRenderer(@NotNull HtmlRenderer.Builder builder)

Method Summary

Modifier and TypeMethod and Description
public static @NotNull MutableDataHolder
addRenderTypeEquivalence(@NotNull MutableDataHolder options, @NotNull String rendererType, @NotNull String supportedRendererType)

public static @NotNull HtmlRenderer.Builder

Returns:

a builder
builder()

Create a new builder for configuring an HtmlRenderer.

public static @NotNull HtmlRenderer.Builder

Returns:

a builder
builder(@Nullable DataHolder
initialization options
options)

Create a new builder for configuring an HtmlRenderer.

public @NotNull DataHolder
getOptions()

Implements com.vladsch.flexmark.util.ast.IRender.getOptions.

Get Options for parsing

public static boolean
isCompatibleRendererType(@NotNull MutableDataHolder options, @NotNull String supportedRendererType)

public static boolean
isCompatibleRendererType(@NotNull MutableDataHolder options, @NotNull String rendererType, @NotNull String supportedRendererType)

public void
render(@NotNull Node
node to render
node, @NotNull Appendable
appendable to use for the output
output)

Render a node to the appendable

public void
render(@NotNull Node
node to render
node, @NotNull Appendable
appendable to use for the output
output, int maxTrailingBlankLines)

Render a node to the appendable

public @NotNull String

Returns:

the rendered HTML.
render(@NotNull Node
the root node
node)

Render the tree of nodes to HTML.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait