com.vladsch.flexmark.ext.abbreviation

Class AbbreviationExtension

java.lang.Object

com.vladsch.flexmark.ext.abbreviation.AbbreviationExtension

All Implemented Interfaces:

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

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 (Parser.Builder.extensions(Iterable), HtmlRenderer.Builder.extensions(Iterable)).

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 and Description
static 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 DataKey<KeepType>	ABBREVIATIONS_KEEP A DataKey that is used to set the behavior of the abbreviations repository when duplicates are defined.
static DataKey<ElementPlacement>	ABBREVIATIONS_PLACEMENT
static DataKey<ElementPlacementSort>	ABBREVIATIONS_SORT
static 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 com.vladsch.flexmark.Extension

EMPTY_LIST, EMPTY_SET

Constructor Summary

Constructors

Constructor and Description
AbbreviationExtension()

Method Summary

Modifier and Type	Method and Description
static Extension	create()
void	extend(Formatter.Builder builder)
void	extend(HtmlRenderer.Builder rendererBuilder, String rendererType)
void	extend(Parser.Builder parserBuilder)
void	parserOptions(MutableDataHolder options)
void	rendererOptions(MutableDataHolder options)
boolean	transferReferences(MutableDataHolder document, DataHolder included)

Methods inherited from class java.lang.Object

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

Field Detail

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.

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

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

Constructor Detail

AbbreviationExtension

public AbbreviationExtension()

Method Detail

create

public static Extension create()

extend

public void extend(Formatter.Builder builder)

Specified by:

extend in interface Formatter.FormatterExtension

rendererOptions

public void rendererOptions(MutableDataHolder options)

Specified by:

rendererOptions in interface Formatter.FormatterExtension

Specified by:

rendererOptions in interface HtmlRenderer.HtmlRendererExtension

parserOptions

public void parserOptions(MutableDataHolder options)

Specified by:

parserOptions in interface Parser.ParserExtension

transferReferences

public boolean transferReferences(MutableDataHolder document,
                                  DataHolder included)

Specified by:

transferReferences in interface Parser.ReferenceHoldingExtension

extend

public void extend(Parser.Builder parserBuilder)

Specified by:

extend in interface Parser.ParserExtension

extend

public void extend(HtmlRenderer.Builder rendererBuilder,
                   String rendererType)

Specified by:

extend in interface HtmlRenderer.HtmlRendererExtension