Class FootnoteNodeFormatter

java.lang.Object

com.vladsch.flexmark.formatter.NodeRepositoryFormatter<FootnoteRepository, FootnoteBlock, Footnote>

com.vladsch.flexmark.ext.footnotes.internal.FootnoteNodeFormatter

All Implemented Interfaces:

NodeFormatter, PhasedNodeFormatter

public class FootnoteNodeFormatter
extends NodeRepositoryFormatter<FootnoteRepository, FootnoteBlock, Footnote>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FootnoteNodeFormatter.Factory

Field Summary

Fields

Modifier and Type	Field	Description
static final DataKey<Map<String,String>>	FOOTNOTE_TRANSLATION_MAP
static final DataKey<Map<String,String>>	FOOTNOTE_UNIQUIFICATION_MAP
private final FootnoteFormatOptions	options

Fields inherited from class NodeRepositoryFormatter

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

Constructor Summary

Constructors

Constructor	Description
FootnoteNodeFormatter(DataHolder options)

Method Summary

Modifier and Type	Method	Description
@Nullable Set<Class<?>>	getNodeClasses()	Collect nodes of given type so that they can be quickly accessed without traversing the AST by all formatting extensions.
@Nullable Set<NodeFormattingHandler<?>>	getNodeFormattingHandlers()
ElementPlacement	getReferencePlacement()
ElementPlacementSort	getReferenceSort()
FootnoteRepository	getRepository(DataHolder options)
private void	render(FootnoteBlock node, NodeFormatterContext context, MarkdownWriter markdown)
private void	render(Footnote node, NodeFormatterContext context, MarkdownWriter markdown)
void	renderReferenceBlock(FootnoteBlock node, NodeFormatterContext context, MarkdownWriter markdown)

Methods inherited from class NodeRepositoryFormatter

getFormattingPhases, getReferenceComparator, getTranslationReferencePlacement, makeReferencesUnique, modifyTransformedReference, renderDocument, renderReference, transformReferenceId, uniquifyIds

Methods inherited from class Object

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

Methods inherited from interface NodeFormatter

getBlockQuoteLikePrefixChar

Field Details

FOOTNOTE_TRANSLATION_MAP

public static final DataKey<Map<String,String>> FOOTNOTE_TRANSLATION_MAP

FOOTNOTE_UNIQUIFICATION_MAP

public static final DataKey<Map<String,String>> FOOTNOTE_UNIQUIFICATION_MAP

options

private final FootnoteFormatOptions options

Constructor Details

FootnoteNodeFormatter

public FootnoteNodeFormatter(DataHolder options)

Method Details

getRepository

public FootnoteRepository getRepository(DataHolder options)

Specified by:

getRepository in class NodeRepositoryFormatter<FootnoteRepository, FootnoteBlock, Footnote>

getReferencePlacement

public ElementPlacement getReferencePlacement()

Specified by:

getReferencePlacement in class NodeRepositoryFormatter<FootnoteRepository, FootnoteBlock, Footnote>

getReferenceSort

public ElementPlacementSort getReferenceSort()

Specified by:

getReferenceSort in class NodeRepositoryFormatter<FootnoteRepository, FootnoteBlock, Footnote>

renderReferenceBlock

public void renderReferenceBlock(FootnoteBlock node,
 NodeFormatterContext context,
 MarkdownWriter markdown)

Specified by:

renderReferenceBlock in class NodeRepositoryFormatter<FootnoteRepository, FootnoteBlock, Footnote>

getNodeFormattingHandlers

@Nullable
public @Nullable Set<NodeFormattingHandler<?>> getNodeFormattingHandlers()

Returns:

the mapping of nodes this renderer handles to rendering function

getNodeClasses

@Nullable
public @Nullable 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.

render

private void render(FootnoteBlock node,
 NodeFormatterContext context,
 MarkdownWriter markdown)

render

private void render(Footnote node,
 NodeFormatterContext context,
 MarkdownWriter markdown)