com.vladsch.flexmark.formatter.internal

Class CoreNodeFormatter

java.lang.Object

com.vladsch.flexmark.formatter.NodeRepositoryFormatter<com.vladsch.flexmark.ast.util.ReferenceRepository,com.vladsch.flexmark.ast.Reference,com.vladsch.flexmark.ast.RefNode>

com.vladsch.flexmark.formatter.internal.CoreNodeFormatter

All Implemented Interfaces:

NodeFormatter, PhasedNodeFormatter

public class CoreNodeFormatter
extends NodeRepositoryFormatter<com.vladsch.flexmark.ast.util.ReferenceRepository,com.vladsch.flexmark.ast.Reference,com.vladsch.flexmark.ast.RefNode>

Field Summary

Fields

Modifier and Type	Field and Description
static com.vladsch.flexmark.util.options.DataKey<Integer>	LIST_ITEM_NUMBER
static com.vladsch.flexmark.util.options.DataKey<com.vladsch.flexmark.util.format.options.ListSpacing>	LIST_ITEM_SPACING
static com.vladsch.flexmark.util.options.DataKey<Boolean>	UNWRAPPED_AUTO_LINKS
static com.vladsch.flexmark.util.options.DataKey<HashSet<String>>	UNWRAPPED_AUTO_LINKS_MAP

Fields inherited from class com.vladsch.flexmark.formatter.NodeRepositoryFormatter

FORMATTING_PHASES, lastReference, myComparator, recheckUndefinedReferences, referenceList, referenceRepository, repositoryNodesDone, unusedReferences

Constructor Summary

Constructors

Constructor and Description
CoreNodeFormatter(com.vladsch.flexmark.util.options.DataHolder options)

Method Summary

Modifier and Type	Method and Description
static void	appendWhiteSpaceBetween(MarkdownWriter markdown, com.vladsch.flexmark.util.sequence.BasedSequence prev, com.vladsch.flexmark.util.sequence.BasedSequence next, boolean preserve, boolean collapse, boolean collapseToEOL)
static void	appendWhiteSpaceBetween(MarkdownWriter markdown, com.vladsch.flexmark.util.ast.Node prev, com.vladsch.flexmark.util.ast.Node next, boolean preserve, boolean collapse, boolean collapseToEOL)
Set<Class<?>>	getNodeClasses() Collect nodes of given type so that they can be quickly accessed without traversing the AST by all formatting extensions.
Set<NodeFormattingHandler<?>>	getNodeFormattingHandlers()
com.vladsch.flexmark.util.format.options.ElementPlacement	getReferencePlacement()
com.vladsch.flexmark.util.format.options.ElementPlacementSort	getReferenceSort()
com.vladsch.flexmark.ast.util.ReferenceRepository	getRepository(com.vladsch.flexmark.util.options.DataHolder options)
static com.vladsch.flexmark.util.sequence.BasedSequence	getSoftLineBreakSpan(com.vladsch.flexmark.util.ast.Node node)
void	renderDocument(NodeFormatterContext context, MarkdownWriter markdown, com.vladsch.flexmark.util.ast.Document document, FormattingPhase phase) Render the specified node.
static void	renderList(com.vladsch.flexmark.ast.ListBlock node, NodeFormatterContext context, MarkdownWriter markdown)
static void	renderList(com.vladsch.flexmark.ast.ListBlock node, NodeFormatterContext context, MarkdownWriter markdown, List<com.vladsch.flexmark.util.ast.Node> itemList)
static void	renderListItem(com.vladsch.flexmark.ast.ListItem node, NodeFormatterContext context, MarkdownWriter markdown, com.vladsch.flexmark.parser.ListOptions listOptions, CharSequence markerSuffix, boolean addBlankLineLooseItems)
static void	renderLooseItemParagraph(com.vladsch.flexmark.ast.Paragraph node, NodeFormatterContext context, MarkdownWriter markdown)
static void	renderLooseParagraph(com.vladsch.flexmark.ast.Paragraph node, NodeFormatterContext context, MarkdownWriter markdown)
void	renderReferenceBlock(com.vladsch.flexmark.ast.Reference node, NodeFormatterContext context, MarkdownWriter markdown)
static void	renderTextBlockParagraphLines(com.vladsch.flexmark.util.ast.Node node, NodeFormatterContext context, MarkdownWriter markdown)

Methods inherited from class com.vladsch.flexmark.formatter.NodeRepositoryFormatter

getFormattingPhases, getReferenceComparator, getTranslationReferencePlacement, modifyTransformedReference, renderReference, transformReferenceId

Methods inherited from class java.lang.Object

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

Field Detail

LIST_ITEM_NUMBER

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

LIST_ITEM_SPACING

public static final com.vladsch.flexmark.util.options.DataKey<com.vladsch.flexmark.util.format.options.ListSpacing> LIST_ITEM_SPACING

UNWRAPPED_AUTO_LINKS

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

UNWRAPPED_AUTO_LINKS_MAP

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

Constructor Detail

CoreNodeFormatter

public CoreNodeFormatter(com.vladsch.flexmark.util.options.DataHolder options)

Method Detail

getNodeClasses

public Set<Class<?>> getNodeClasses()

Description copied from interface: NodeFormatter

Collect nodes of given type so that they can be quickly accessed without traversing the AST by all formatting extensions.

Returns:

the nodes of interest to this formatter during formatting.

getRepository

public com.vladsch.flexmark.ast.util.ReferenceRepository getRepository(com.vladsch.flexmark.util.options.DataHolder options)

Specified by:

getRepository in class NodeRepositoryFormatter<com.vladsch.flexmark.ast.util.ReferenceRepository,com.vladsch.flexmark.ast.Reference,com.vladsch.flexmark.ast.RefNode>

getReferencePlacement

public com.vladsch.flexmark.util.format.options.ElementPlacement getReferencePlacement()

Specified by:

getReferencePlacement in class NodeRepositoryFormatter<com.vladsch.flexmark.ast.util.ReferenceRepository,com.vladsch.flexmark.ast.Reference,com.vladsch.flexmark.ast.RefNode>

getReferenceSort

public com.vladsch.flexmark.util.format.options.ElementPlacementSort getReferenceSort()

Specified by:

getReferenceSort in class NodeRepositoryFormatter<com.vladsch.flexmark.ast.util.ReferenceRepository,com.vladsch.flexmark.ast.Reference,com.vladsch.flexmark.ast.RefNode>

renderReferenceBlock

public void renderReferenceBlock(com.vladsch.flexmark.ast.Reference node,
                                 NodeFormatterContext context,
                                 MarkdownWriter markdown)

Specified by:

renderReferenceBlock in class NodeRepositoryFormatter<com.vladsch.flexmark.ast.util.ReferenceRepository,com.vladsch.flexmark.ast.Reference,com.vladsch.flexmark.ast.RefNode>

renderDocument

public void renderDocument(NodeFormatterContext context,
                           MarkdownWriter markdown,
                           com.vladsch.flexmark.util.ast.Document document,
                           FormattingPhase phase)

Description copied from interface: PhasedNodeFormatter

Render the specified node.

Specified by:

renderDocument in interface PhasedNodeFormatter

Overrides:

renderDocument in class NodeRepositoryFormatter<com.vladsch.flexmark.ast.util.ReferenceRepository,com.vladsch.flexmark.ast.Reference,com.vladsch.flexmark.ast.RefNode>

Parameters:

context - node renderer context instance

markdown - markdown writer instance

document - the document node to render

phase - rendering phase for which to generate the output. Will be any of FormattingPhase except FormattingPhase.DOCUMENT because this phase is used for the non-phased node rendering

getNodeFormattingHandlers

public Set<NodeFormattingHandler<?>> getNodeFormattingHandlers()

Returns:

the mapping of nodes this renderer handles to rendering function

renderList

public static void renderList(com.vladsch.flexmark.ast.ListBlock node,
                              NodeFormatterContext context,
                              MarkdownWriter markdown)

renderList

public static void renderList(com.vladsch.flexmark.ast.ListBlock node,
                              NodeFormatterContext context,
                              MarkdownWriter markdown,
                              List<com.vladsch.flexmark.util.ast.Node> itemList)

renderListItem

public static void renderListItem(com.vladsch.flexmark.ast.ListItem node,
                                  NodeFormatterContext context,
                                  MarkdownWriter markdown,
                                  com.vladsch.flexmark.parser.ListOptions listOptions,
                                  CharSequence markerSuffix,
                                  boolean addBlankLineLooseItems)

renderTextBlockParagraphLines

public static void renderTextBlockParagraphLines(com.vladsch.flexmark.util.ast.Node node,
                                                 NodeFormatterContext context,
                                                 MarkdownWriter markdown)

renderLooseParagraph

public static void renderLooseParagraph(com.vladsch.flexmark.ast.Paragraph node,
                                        NodeFormatterContext context,
                                        MarkdownWriter markdown)

renderLooseItemParagraph

public static void renderLooseItemParagraph(com.vladsch.flexmark.ast.Paragraph node,
                                            NodeFormatterContext context,
                                            MarkdownWriter markdown)

getSoftLineBreakSpan

public static com.vladsch.flexmark.util.sequence.BasedSequence getSoftLineBreakSpan(com.vladsch.flexmark.util.ast.Node node)

appendWhiteSpaceBetween

public static void appendWhiteSpaceBetween(MarkdownWriter markdown,
                                           com.vladsch.flexmark.util.ast.Node prev,
                                           com.vladsch.flexmark.util.ast.Node next,
                                           boolean preserve,
                                           boolean collapse,
                                           boolean collapseToEOL)

appendWhiteSpaceBetween

public static void appendWhiteSpaceBetween(MarkdownWriter markdown,
                                           com.vladsch.flexmark.util.sequence.BasedSequence prev,
                                           com.vladsch.flexmark.util.sequence.BasedSequence next,
                                           boolean preserve,
                                           boolean collapse,
                                           boolean collapseToEOL)