com.vladsch.flexmark.formatter.internal

Class Formatter

java.lang.Object

com.vladsch.flexmark.formatter.internal.Formatter

All Implemented Interfaces:

IRender

public class Formatter
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	Formatter.Builder Builder for configuring an Formatter.
static interface	Formatter.FormatterExtension Extension for Formatter.

Field Summary

Fields

Modifier and Type	Field and Description
static DataKey<EqualizeTrailingMarker>	ATX_HEADER_TRAILING_MARKER
static DataKey<Boolean>	BLOCK_QUOTE_BLANK_LINES
static DataKey<BlockQuoteMarker>	BLOCK_QUOTE_MARKERS
static DataKey<CharWidthProvider>	CHAR_WIDTH_PROVIDER
static DataKey<Integer>	FENCED_CODE_MARKER_LENGTH
static DataKey<CodeFenceMarker>	FENCED_CODE_MARKER_TYPE
static DataKey<Boolean>	FENCED_CODE_MATCH_CLOSING_MARKER
static DataKey<Boolean>	FENCED_CODE_MINIMIZE_INDENT
static DataKey<Boolean>	FENCED_CODE_SPACE_BEFORE_INFO
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<ParserEmulationProfile>	FORMATTER_EMULATION_PROFILE
static DataKey<Boolean>	INDENTED_CODE_MINIMIZE_INDENT
static DataKey<Boolean>	KEEP_EXPLICIT_LINKS_AT_START
static DataKey<Boolean>	KEEP_IMAGE_LINKS_AT_START
static DataKey<Boolean>	LIST_ADD_BLANK_LINE_BEFORE
static DataKey<ListBulletMarker>	LIST_BULLET_MARKER
static DataKey<ListNumberedMarker>	LIST_NUMBERED_MARKER
static DataKey<Boolean>	LIST_RENUMBER_ITEMS
static DataKey<ListSpacing>	LIST_SPACING
static DataKey<Integer>	MAX_BLANK_LINES
static DataKey<Integer>	MAX_TRAILING_BLANK_LINES
static DataKey<ElementPlacement>	REFERENCE_PLACEMENT
static DataKey<ElementPlacementSort>	REFERENCE_SORT
static DataKey<Boolean>	SETEXT_HEADER_EQUALIZE_MARKER
static DataKey<DiscretionaryText>	SPACE_AFTER_ATX_MARKER
static DataKey<String>	THEMATIC_BREAK

Method Summary

Modifier and Type	Method and Description
static Formatter.Builder	builder() Create a new builder for configuring an Formatter.
static Formatter.Builder	builder(DataHolder options) Create a new builder for configuring an Formatter.
String	render(Node node) Render the tree of nodes to markdown
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
Formatter	withOptions(DataHolder options)

Methods inherited from class java.lang.Object

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

Field Detail

FORMAT_FLAGS

public static final DataKey<Integer> FORMAT_FLAGS

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

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

MAX_BLANK_LINES

public static final DataKey<Integer> MAX_BLANK_LINES

MAX_TRAILING_BLANK_LINES

public static final DataKey<Integer> MAX_TRAILING_BLANK_LINES

SPACE_AFTER_ATX_MARKER

public static final DataKey<DiscretionaryText> SPACE_AFTER_ATX_MARKER

SETEXT_HEADER_EQUALIZE_MARKER

public static final DataKey<Boolean> SETEXT_HEADER_EQUALIZE_MARKER

ATX_HEADER_TRAILING_MARKER

public static final DataKey<EqualizeTrailingMarker> ATX_HEADER_TRAILING_MARKER

THEMATIC_BREAK

public static final DataKey<String> THEMATIC_BREAK

BLOCK_QUOTE_BLANK_LINES

public static final DataKey<Boolean> BLOCK_QUOTE_BLANK_LINES

BLOCK_QUOTE_MARKERS

public static final DataKey<BlockQuoteMarker> BLOCK_QUOTE_MARKERS

INDENTED_CODE_MINIMIZE_INDENT

public static final DataKey<Boolean> INDENTED_CODE_MINIMIZE_INDENT

FENCED_CODE_MINIMIZE_INDENT

public static final DataKey<Boolean> FENCED_CODE_MINIMIZE_INDENT

FENCED_CODE_MATCH_CLOSING_MARKER

public static final DataKey<Boolean> FENCED_CODE_MATCH_CLOSING_MARKER

FENCED_CODE_SPACE_BEFORE_INFO

public static final DataKey<Boolean> FENCED_CODE_SPACE_BEFORE_INFO

FENCED_CODE_MARKER_LENGTH

public static final DataKey<Integer> FENCED_CODE_MARKER_LENGTH

FENCED_CODE_MARKER_TYPE

public static final DataKey<CodeFenceMarker> FENCED_CODE_MARKER_TYPE

LIST_ADD_BLANK_LINE_BEFORE

public static final DataKey<Boolean> LIST_ADD_BLANK_LINE_BEFORE

LIST_RENUMBER_ITEMS

public static final DataKey<Boolean> LIST_RENUMBER_ITEMS

LIST_BULLET_MARKER

public static final DataKey<ListBulletMarker> LIST_BULLET_MARKER

LIST_NUMBERED_MARKER

public static final DataKey<ListNumberedMarker> LIST_NUMBERED_MARKER

LIST_SPACING

public static final DataKey<ListSpacing> LIST_SPACING

REFERENCE_PLACEMENT

public static final DataKey<ElementPlacement> REFERENCE_PLACEMENT

REFERENCE_SORT

public static final DataKey<ElementPlacementSort> REFERENCE_SORT

KEEP_IMAGE_LINKS_AT_START

public static final DataKey<Boolean> KEEP_IMAGE_LINKS_AT_START

KEEP_EXPLICIT_LINKS_AT_START

public static final DataKey<Boolean> KEEP_EXPLICIT_LINKS_AT_START

CHAR_WIDTH_PROVIDER

public static final DataKey<CharWidthProvider> CHAR_WIDTH_PROVIDER

FORMATTER_EMULATION_PROFILE

public static final DataKey<ParserEmulationProfile> FORMATTER_EMULATION_PROFILE

Method Detail

builder

public static Formatter.Builder builder()

Create a new builder for configuring an Formatter.

Returns:

a builder

builder

public static Formatter.Builder builder(DataHolder options)

Create a new builder for configuring an Formatter.

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 markdown

Specified by:

render in interface IRender

Parameters:

node - the root node

Returns:

the formatted markdown

withOptions

public Formatter withOptions(DataHolder options)

Specified by:

withOptions in interface IRender