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 java.lang.Object implements Parser.ParserExtension, HtmlRenderer.HtmlRendererExtension, Parser.ReferenceHoldingExtension, Formatter.FormatterExtension
Extension for adding abbreviations to markdownCreate it with
create()
then configure buildersThe 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 theParser.Builder
viaParser.builder(options)
-
-
Field Summary
Fields Modifier and Type Field Description static DataKey<AbbreviationRepository>
ABBREVIATIONS
ADataKey
that is used to get the document's Node repository holding all the abbreviations defined in the current document.static DataKey<KeepType>
ABBREVIATIONS_KEEP
ADataKey
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<java.lang.Boolean>
MAKE_MERGED_ABBREVIATIONS_UNIQUE
static DataKey<java.lang.Boolean>
USE_LINKS
ADataKey
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.util.misc.Extension
EMPTY_LIST
-
-
Constructor Summary
Constructors Constructor Description AbbreviationExtension()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static AbbreviationExtension
create()
void
extend(Formatter.Builder formatterBuilder)
void
extend(HtmlRenderer.Builder htmlRendererBuilder, java.lang.String rendererType)
Called to give each extension to register extension points that it containsvoid
extend(Parser.Builder parserBuilder)
This method is called on all extensions so that they can register their custom processorsvoid
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(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
-
-
-
Field Detail
-
ABBREVIATIONS
public static final DataKey<AbbreviationRepository> ABBREVIATIONS
ADataKey
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<java.lang.Boolean> USE_LINKS
ADataKey
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<java.lang.Boolean> MAKE_MERGED_ABBREVIATIONS_UNIQUE
-
-
Method Detail
-
create
public static AbbreviationExtension create()
-
extend
public void extend(Formatter.Builder formatterBuilder)
- Specified by:
extend
in interfaceFormatter.FormatterExtension
-
rendererOptions
public void rendererOptions(@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 interfaceFormatter.FormatterExtension
- Specified by:
rendererOptions
in interfaceHtmlRenderer.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 interfaceParser.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 interfaceParser.ReferenceHoldingExtension
- Parameters:
document
- destination document for referencesincluded
- 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 interfaceParser.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 java.lang.String rendererType)
Description copied from interface:HtmlRenderer.HtmlRendererExtension
Called to give each extension to register extension points that it contains- Specified by:
extend
in interfaceHtmlRenderer.HtmlRendererExtension
- Parameters:
htmlRendererBuilder
- builder to call back for extension point registrationrendererType
- 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)
-
-