Top Inners Fields Constructors Methods
com.vladsch.flexmark.formatter.internal

public Class CoreNodeFormatter

extends NodeRepositoryFormatter<ReferenceRepository, Reference, RefNode>
Class Inheritance
Annotations
@SuppressWarnings:WeakerAccess
Imports
com.vladsch.flexmark.ast.*, com.vladsch.flexmark.ast.util.ReferenceRepository, com.vladsch.flexmark.formatter.Formatter, com.vladsch.flexmark.formatter.*, com.vladsch.flexmark.html.renderer.HtmlIdGenerator, .LinkType, .ResolvedLink, com.vladsch.flexmark.parser.ListOptions, .Parser, .ParserEmulationProfile, com.vladsch.flexmark.util.ast.*, com.vladsch.flexmark.util.data.DataHolder, .DataKey, .DataKeyBase, .MutableDataHolder, com.vladsch.flexmark.util.format.options.ElementPlacement, .ElementPlacementSort, .HeadingStyle, .ListSpacing, com.vladsch.flexmark.util.misc.CharPredicate, .Utils, com.vladsch.flexmark.util.sequence.BasedSequence, .RepeatedSequence, .SequenceUtils, com.vladsch.flexmark.util.sequence.mappers.SpaceMapper, org.jetbrains.annotations.NotNull, .Nullable, java.util.*

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final DataKey<Map<String, String>>
private Map<String, String>
private int
pack-priv final FormatterOptions
pack-priv static final TranslationPlaceholderGenerator
private final ListOptions
private final String
private final String
private final String
pack-priv MutableDataHolder
public static final DataKey<Map<String, String>>
public static final DataKey<Boolean>
Inherited from com.vladsch.flexmark.formatter.NodeRepositoryFormatter:
FORMATTING_PHASESlastReferencemyComparatorrecheckUndefinedReferencesreferenceListreferenceRepositoryreferenceUniqificationMaprepositoryNodesDoneunusedReferences

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
pack-priv void
public char
getBlockQuoteLikePrefixChar()

Overrides default com.vladsch.flexmark.formatter.NodeFormatter.getBlockQuoteLikePrefixChar.

Return character which compacts like block quote prefix

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<?>>
public ElementPlacement
public ElementPlacementSort
public ReferenceRepository
private void
private void
private void
private void
private void
private void
private void
private void
private void
private void
private void
private void
private void
private void
private void
private void
private void
private void
private void
private void
private void
private void
private void
private void
private void
private void
private void
private void
private void
private void
private void
public void
public void
Inherited from com.vladsch.flexmark.formatter.NodeRepositoryFormatter:
getFormattingPhasesgetReferenceComparatorgetTranslationReferencePlacementmakeReferencesUniquemodifyTransformedReferencerenderDocumentrenderReferencetransformReferenceIduniquifyIds

Field Detail

ATTRIBUTE_UNIQUIFICATION_ID_MAPback to summary
public static final DataKey<Map<String, String>> ATTRIBUTE_UNIQUIFICATION_ID_MAP

2020-04-10

Annotations
@Deprecated
attributeUniquificationIdMapback to summary
private Map<String, String> attributeUniquificationIdMap
blankLinesback to summary
private int blankLines
formatterOptionsback to summary
pack-priv final FormatterOptions formatterOptions
htmlEntityPlaceholderGeneratorback to summary
pack-priv static final TranslationPlaceholderGenerator htmlEntityPlaceholderGenerator
listOptionsback to summary
private final ListOptions listOptions
myHtmlBlockPrefixback to summary
private final String myHtmlBlockPrefix
myHtmlInlinePrefixback to summary
private final String myHtmlInlinePrefix
myTranslationAutolinkPrefixback to summary
private final String myTranslationAutolinkPrefix
myTranslationStoreback to summary
pack-priv MutableDataHolder myTranslationStore
UNIQUIFICATION_MAPback to summary
public static final DataKey<Map<String, String>> UNIQUIFICATION_MAP

2020-04-10

Annotations
@Deprecated

Constructor Detail

CoreNodeFormatterback to summary
public CoreNodeFormatter(DataHolder options)

Method Detail

appendReferenceback to summary
pack-priv void appendReference(CharSequence id, NodeFormatterContext context, MarkdownWriter markdown)
getBlockQuoteLikePrefixCharback to summary
public char getBlockQuoteLikePrefixChar()

Overrides default com.vladsch.flexmark.formatter.NodeFormatter.getBlockQuoteLikePrefixChar.

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

Return character which compacts like block quote prefix

Returns:char

character or NUL if none

Annotations
@Override
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 ReferenceRepository getRepository(DataHolder options)

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

Annotations
@Override
renderback to summary
private void render(Node node, NodeFormatterContext context, MarkdownWriter markdown)
renderback to summary
private void render(BlankLine node, NodeFormatterContext context, MarkdownWriter markdown)
renderback to summary
private void render(Document node, NodeFormatterContext context, MarkdownWriter markdown)
renderback to summary
private void render(Heading node, NodeFormatterContext context, MarkdownWriter markdown)
renderback to summary
private void render(BlockQuote node, NodeFormatterContext context, MarkdownWriter markdown)
renderback to summary
private void render(ThematicBreak node, NodeFormatterContext context, MarkdownWriter markdown)
renderback to summary
private void render(FencedCodeBlock node, NodeFormatterContext context, MarkdownWriter markdown)
renderback to summary
private void render(IndentedCodeBlock node, NodeFormatterContext context, MarkdownWriter markdown)
renderback to summary
private void render(BulletList node, NodeFormatterContext context, MarkdownWriter markdown)
renderback to summary
private void render(OrderedList node, NodeFormatterContext context, MarkdownWriter markdown)
renderback to summary
private void render(BulletListItem node, NodeFormatterContext context, MarkdownWriter markdown)
renderback to summary
private void render(OrderedListItem node, NodeFormatterContext context, MarkdownWriter markdown)
renderback to summary
private void render(Emphasis node, NodeFormatterContext context, MarkdownWriter markdown)
renderback to summary
private void render(StrongEmphasis node, NodeFormatterContext context, MarkdownWriter markdown)
renderback to summary
private void render(Paragraph node, NodeFormatterContext context, MarkdownWriter markdown)
renderback to summary
private void render(SoftLineBreak node, NodeFormatterContext context, MarkdownWriter markdown)
renderback to summary
private void render(HardLineBreak node, NodeFormatterContext context, MarkdownWriter markdown)
renderback to summary
private void render(HtmlEntity node, NodeFormatterContext context, MarkdownWriter markdown)
renderback to summary
private void render(Text node, NodeFormatterContext context, MarkdownWriter markdown)
renderback to summary
private void render(TextBase node, NodeFormatterContext context, MarkdownWriter markdown)
renderback to summary
private void render(Code node, NodeFormatterContext context, MarkdownWriter markdown)
renderback to summary
private void render(HtmlBlock node, NodeFormatterContext context, MarkdownWriter markdown)
renderback to summary
private void render(HtmlCommentBlock node, NodeFormatterContext context, MarkdownWriter markdown)
renderback to summary
private void render(HtmlBlockBase node, NodeFormatterContext context, MarkdownWriter markdown)
renderback to summary
private void render(HtmlInnerBlockComment node, NodeFormatterContext context, MarkdownWriter markdown)
renderback to summary
private void render(HtmlInline node, NodeFormatterContext context, MarkdownWriter markdown)
renderback to summary
private void render(HtmlInlineComment node, NodeFormatterContext context, MarkdownWriter markdown)
renderback to summary
private void render(Reference node, NodeFormatterContext context, MarkdownWriter markdown)
renderback to summary
private void render(Image node, NodeFormatterContext context, MarkdownWriter markdown)
renderback to summary
private void render(ImageRef node, NodeFormatterContext context, MarkdownWriter markdown)
renderback to summary
private void render(LinkRef node, NodeFormatterContext context, MarkdownWriter markdown)
renderDocumentback to summary
public void renderDocument(@NotNull NodeFormatterContext context, @NotNull MarkdownWriter markdown, @NotNull Document document, @NotNull FormattingPhase phase)
Annotations
@Override
renderReferenceBlockback to summary
public void renderReferenceBlock(Reference node, NodeFormatterContext context, MarkdownWriter markdown)

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

Annotations
@Override
com.vladsch.flexmark.formatter.internal back to summary

public Class CoreNodeFormatter.Factory

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

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public @NotNull NodeFormatter
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