Class AbbreviationExtension

java.lang.Object

com.vladsch.flexmark.ext.abbreviation.AbbreviationExtension

All Implemented Interfaces:

Formatter.FormatterExtension, HtmlRenderer.HtmlRendererExtension, Parser.ParserExtension, Parser.ReferenceHoldingExtension, Extension

public class AbbreviationExtension
extends Object
implements Parser.ParserExtension, HtmlRenderer.HtmlRendererExtension, Parser.ReferenceHoldingExtension, Formatter.FormatterExtension

Extension for adding abbreviations to markdown

Create it with create() then configure builders

The parsed abbreviations are turned into abbr tags by default or a links as an option by setting the USE_LINKS key to true in option used to create the Parser.Builder via Parser.builder(options)

Field Summary

Fields

Modifier and Type	Field	Description
static final DataKey<AbbreviationRepository>	ABBREVIATIONS	A DataKey that is used to get the document's Node repository holding all the abbreviations defined in the current document.
static final DataKey<KeepType>	ABBREVIATIONS_KEEP	A DataKey that is used to set the behavior of the abbreviations repository when duplicates are defined.
static final DataKey<ElementPlacement>	ABBREVIATIONS_PLACEMENT
static final DataKey<ElementPlacementSort>	ABBREVIATIONS_SORT
static final DataKey<Boolean>	MAKE_MERGED_ABBREVIATIONS_UNIQUE
static final DataKey<Boolean>	USE_LINKS	A DataKey that is used to set the use links option when true, default is false and abbr tag will be used in the rendered HTML.

Fields inherited from interface Extension

EMPTY_LIST

Constructor Summary

Constructors

Constructor	Description
AbbreviationExtension()

Method Summary

Modifier and Type	Method	Description
static AbbreviationExtension	create()
void	extend(Formatter.Builder formatterBuilder)
void	extend(HtmlRenderer.Builder htmlRendererBuilder, @NotNull String rendererType)	Called to give each extension to register extension points that it contains
void	extend(Parser.Builder parserBuilder)	This method is called on all extensions so that they can register their custom processors
void	parserOptions(MutableDataHolder options)	This method is called first on all extensions so that they can adjust the options that must be common to all extensions.
void	rendererOptions(@NotNull MutableDataHolder options)	This method is called first on all extensions so that they can adjust the options that must be common to all extensions.
boolean	transferReferences(MutableDataHolder document, DataHolder included)	This method is called to transfer references from included document to the source document

Methods inherited from class Object

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

Field Details

ABBREVIATIONS_KEEP

public static final DataKey<KeepType> ABBREVIATIONS_KEEP

A DataKey that is used to set the behavior of the abbreviations repository when duplicates are defined. KeepType

ABBREVIATIONS

public static final DataKey<AbbreviationRepository> ABBREVIATIONS

A DataKey that is used to get the document's Node repository holding all the abbreviations defined in the current document.

USE_LINKS

public static final DataKey<Boolean> USE_LINKS

A DataKey that is used to set the use links option when true, default is false and abbr tag will be used in the rendered HTML.

ABBREVIATIONS_PLACEMENT

public static final DataKey<ElementPlacement> ABBREVIATIONS_PLACEMENT

ABBREVIATIONS_SORT

public static final DataKey<ElementPlacementSort> ABBREVIATIONS_SORT

MAKE_MERGED_ABBREVIATIONS_UNIQUE

public static final DataKey<Boolean> MAKE_MERGED_ABBREVIATIONS_UNIQUE

Constructor Details

AbbreviationExtension

public AbbreviationExtension()

Method Details

create

public static AbbreviationExtension create()

extend

public void extend(Formatter.Builder formatterBuilder)

Specified by:

extend in interface Formatter.FormatterExtension

rendererOptions

public void rendererOptions(@NotNull
 @NotNull MutableDataHolder options)

Description copied from interface: HtmlRenderer.HtmlRendererExtension

This method is called first on all extensions so that they can adjust the options that must be common to all extensions.

Specified by:

rendererOptions in interface Formatter.FormatterExtension

Specified by:

rendererOptions in interface HtmlRenderer.HtmlRendererExtension

Parameters:

options - option set that will be used for the builder

parserOptions

public void parserOptions(MutableDataHolder options)

Description copied from interface: Parser.ParserExtension

This method is called first on all extensions so that they can adjust the options that must be common to all extensions.

Specified by:

parserOptions in interface Parser.ParserExtension

Parameters:

options - option set that will be used for the builder

transferReferences

public boolean transferReferences(MutableDataHolder document,
 DataHolder included)

Description copied from interface: Parser.ReferenceHoldingExtension

This method is called to transfer references from included document to the source document

Specified by:

transferReferences in interface Parser.ReferenceHoldingExtension

Parameters:

document - destination document for references

included - source document for references

Returns:

true if there were references to transfer

extend

public void extend(Parser.Builder parserBuilder)

Description copied from interface: Parser.ParserExtension

This method is called on all extensions so that they can register their custom processors

Specified by:

extend in interface Parser.ParserExtension

Parameters:

parserBuilder - parser builder with which to register extensions

See Also:

• Parser.Builder.customBlockParserFactory(CustomBlockParserFactory)
• Parser.Builder.customInlineParserExtensionFactory(InlineParserExtensionFactory)
• Parser.Builder.customInlineParserFactory(InlineParserFactory)
• Parser.Builder.customDelimiterProcessor(DelimiterProcessor)
• Parser.Builder.postProcessorFactory(PostProcessorFactory)
• Parser.Builder.paragraphPreProcessorFactory(ParagraphPreProcessorFactory)
• Parser.Builder.blockPreProcessorFactory(BlockPreProcessorFactory)
• Parser.Builder.linkRefProcessorFactory(LinkRefProcessorFactory)
• Parser.Builder.specialLeadInHandler(SpecialLeadInHandler)

extend

public void extend(@NotNull
 HtmlRenderer.Builder htmlRendererBuilder,
 @NotNull
 @NotNull String rendererType)

Description copied from interface: HtmlRenderer.HtmlRendererExtension

Called to give each extension to register extension points that it contains

Specified by:

extend in interface HtmlRenderer.HtmlRendererExtension

Parameters:

htmlRendererBuilder - builder to call back for extension point registration

rendererType - type of rendering being performed. For now "HTML", "JIRA" or "YOUTRACK"

See Also:

• HtmlRenderer.Builder.attributeProviderFactory(AttributeProviderFactory)
• HtmlRenderer.Builder.nodeRendererFactory(NodeRendererFactory)
• HtmlRenderer.Builder.linkResolverFactory(LinkResolverFactory)
• HtmlRenderer.Builder.htmlIdGeneratorFactory(HeaderIdGeneratorFactory)