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

public Class AbbreviationNodeFormatter

extends NodeRepositoryFormatter<AbbreviationRepository, AbbreviationBlock, Abbreviation>
Class Inheritance
Imports
com.vladsch.flexmark.ext.abbreviation.Abbreviation, .AbbreviationBlock, .AbbreviationExtension, com.vladsch.flexmark.formatter.Formatter, 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
AbbreviationNodeFormatter.Factory

Field Summary

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

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

private final boolean
makeMergedAbbreviationsUnique

private final AbbreviationFormatOptions
options

private final boolean
transformUnderscores

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

Constructor Summary

AccessConstructor and Description
public
AbbreviationNodeFormatter(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 AbbreviationRepository
getRepository(DataHolder options)

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

protected boolean
makeReferencesUnique()

Overrides com.vladsch.flexmark.formatter.NodeRepositoryFormatter.makeReferencesUnique.

Whether references should be made unique

public String
modifyTransformedReference(String transformedText, NodeFormatterContext context)

Overrides com.vladsch.flexmark.formatter.NodeRepositoryFormatter.modifyTransformedReference.

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

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

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

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

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

Field Detail

ABBREVIATION_TRANSLATION_MAPback to summary
public static final DataKey<Map<String, String>> ABBREVIATION_TRANSLATION_MAP
ABBREVIATION_UNIQUIFICATION_MAPback to summary
public static final DataKey<Map<String, String>> ABBREVIATION_UNIQUIFICATION_MAP
makeMergedAbbreviationsUniqueback to summary
private final boolean makeMergedAbbreviationsUnique
optionsback to summary
private final AbbreviationFormatOptions options
transformUnderscoresback to summary
private final boolean transformUnderscores

Constructor Detail

AbbreviationNodeFormatterback to summary
public AbbreviationNodeFormatter(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 AbbreviationRepository getRepository(DataHolder options)

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

Annotations
@Override
makeReferencesUniqueback to summary
protected boolean makeReferencesUnique()

Overrides com.vladsch.flexmark.formatter.NodeRepositoryFormatter.makeReferencesUnique.

Doc from com.vladsch.flexmark.formatter.NodeRepositoryFormatter.makeReferencesUnique.

Whether references should be made unique

Returns:boolean

true if yes, false if leave all references as is

Annotations
@Override
modifyTransformedReferenceback to summary
public String modifyTransformedReference(String transformedText, NodeFormatterContext context)

Overrides com.vladsch.flexmark.formatter.NodeRepositoryFormatter.modifyTransformedReference.

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

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

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

public Class AbbreviationNodeFormatter.Factory

extends Object
implements NodeFormatterFactory
Class Inheritance
  • java.lang.Object
  • com.vladsch.flexmark.ext.abbreviation.internal.AbbreviationNodeFormatter.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