Top Inners Fields Constructors Methods
com.vladsch.flexmark.ext.footnotes.internal

public Class FootnoteNodeFormatter

extends NodeRepositoryFormatter<FootnoteRepository, FootnoteBlock, Footnote>
Class Inheritance
Imports
com.vladsch.flexmark.ext.footnotes.Footnote, .FootnoteBlock, .FootnoteExtension, com.vladsch.flexmark.formatter.*, com.vladsch.flexmark.util.data.DataHolder, .DataKey, com.vladsch.flexmark.util.format.options.ElementPlacement, .ElementPlacementSort, org.jetbrains.annotations.NotNull, .Nullable, java.util.*

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
FootnoteNodeFormatter.Factory

Field Summary

Modifier and TypeField and Description
public static final DataKey<Map<String, String>>
FOOTNOTE_TRANSLATION_MAP

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

private final FootnoteFormatOptions
options

Inherited from com.vladsch.flexmark.formatter.NodeRepositoryFormatter:
FORMATTING_PHASESlastReferencemyComparatorrecheckUndefinedReferencesreferenceListreferenceRepositoryreferenceUniqificationMaprepositoryNodesDoneunusedReferences

Constructor Summary

AccessConstructor and Description
public
FootnoteNodeFormatter(DataHolder options)

Method Summary

Modifier and TypeMethod and Description
public @Nullable Set<Class<?>>
getNodeClasses()

Implements com.vladsch.flexmark.formatter.NodeFormatter.getNodeClasses.

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

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

Implements com.vladsch.flexmark.formatter.NodeFormatter.getNodeFormattingHandlers.

public ElementPlacement
getReferencePlacement()

Implements abstract com.vladsch.flexmark.formatter.NodeRepositoryFormatter.getReferencePlacement.

public ElementPlacementSort
getReferenceSort()

Implements abstract com.vladsch.flexmark.formatter.NodeRepositoryFormatter.getReferenceSort.

public FootnoteRepository
getRepository(DataHolder options)

Implements abstract com.vladsch.flexmark.formatter.NodeRepositoryFormatter.getRepository.

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

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

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

Implements abstract com.vladsch.flexmark.formatter.NodeRepositoryFormatter.renderReferenceBlock.

Inherited from com.vladsch.flexmark.formatter.NodeRepositoryFormatter:
getFormattingPhasesgetReferenceComparatorgetTranslationReferencePlacementmakeReferencesUniquemodifyTransformedReferencerenderDocumentrenderReferencetransformReferenceIduniquifyIds

Field Detail

FOOTNOTE_TRANSLATION_MAPback to summary
public static final DataKey<Map<String, String>> FOOTNOTE_TRANSLATION_MAP
FOOTNOTE_UNIQUIFICATION_MAPback to summary
public static final DataKey<Map<String, String>> FOOTNOTE_UNIQUIFICATION_MAP
optionsback to summary
private final FootnoteFormatOptions options

Constructor Detail

FootnoteNodeFormatterback to summary
public FootnoteNodeFormatter(DataHolder options)

Method Detail

getNodeClassesback to summary
public @Nullable Set<Class<?>> getNodeClasses()

Implements com.vladsch.flexmark.formatter.NodeFormatter.getNodeClasses.

Doc from com.vladsch.flexmark.formatter.NodeFormatter.getNodeClasses.

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

Returns:@Nullable Set<Class<?>>

the nodes of interest to this formatter during formatting.

Annotations
@Nullable
@Override
getNodeFormattingHandlersback to summary
public @Nullable Set<NodeFormattingHandler<?>> getNodeFormattingHandlers()

Implements com.vladsch.flexmark.formatter.NodeFormatter.getNodeFormattingHandlers.

Returns:@Nullable Set<NodeFormattingHandler<?>>

Doc from com.vladsch.flexmark.formatter.NodeFormatter.getNodeFormattingHandlers.

the mapping of nodes this renderer handles to rendering function

Annotations
@Nullable
@Override
getReferencePlacementback to summary
public ElementPlacement getReferencePlacement()

Implements abstract com.vladsch.flexmark.formatter.NodeRepositoryFormatter.getReferencePlacement.

Annotations
@Override
getReferenceSortback to summary
public ElementPlacementSort getReferenceSort()

Implements abstract com.vladsch.flexmark.formatter.NodeRepositoryFormatter.getReferenceSort.

Annotations
@Override
getRepositoryback to summary
public FootnoteRepository getRepository(DataHolder options)

Implements abstract com.vladsch.flexmark.formatter.NodeRepositoryFormatter.getRepository.

Annotations
@Override
renderback to summary
private void render(FootnoteBlock node, NodeFormatterContext context, MarkdownWriter markdown)
renderback to summary
private void render(Footnote node, NodeFormatterContext context, MarkdownWriter markdown)
renderReferenceBlockback to summary
public void renderReferenceBlock(FootnoteBlock node, NodeFormatterContext context, MarkdownWriter markdown)

Implements abstract com.vladsch.flexmark.formatter.NodeRepositoryFormatter.renderReferenceBlock.

Annotations
@Override
com.vladsch.flexmark.ext.footnotes.internal back to summary

public Class FootnoteNodeFormatter.Factory

extends Object
implements NodeFormatterFactory
Class Inheritance
  • java.lang.Object
  • com.vladsch.flexmark.ext.footnotes.internal.FootnoteNodeFormatter.Factory
All Implemented Interfaces
com.vladsch.flexmark.formatter.NodeFormatterFactory, com.vladsch.flexmark.util.dependency.Dependent

Constructor Summary

AccessConstructor and Description
public
Factory()

Method Summary

Modifier and TypeMethod and Description
public @NotNull NodeFormatter
create(@NotNull DataHolder options)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

Factoryback to summary
public Factory()

Method Detail

createback to summary
public @NotNull NodeFormatter create(@NotNull DataHolder options)
Annotations
@NotNull
@Override