Class AnchorLinkExtension

java.lang.Object

com.vladsch.flexmark.ext.anchorlink.AnchorLinkExtension

All Implemented Interfaces:

HtmlRenderer.HtmlRendererExtension, Parser.ParserExtension, Extension

public class AnchorLinkExtension
extends Object
implements Parser.ParserExtension, HtmlRenderer.HtmlRendererExtension

Extension for anchor links

Create it with create() and then configure it on the builders

The parsed anchorlink text is turned into AnchorLink nodes.

Field Summary

Fields

Modifier and Type	Field	Description
static final DataKey<String>	ANCHORLINKS_ANCHOR_CLASS
static final DataKey<Boolean>	ANCHORLINKS_NO_BLOCK_QUOTE
static final DataKey<Boolean>	ANCHORLINKS_SET_ID
static final DataKey<Boolean>	ANCHORLINKS_SET_NAME
static final DataKey<String>	ANCHORLINKS_TEXT_PREFIX
static final DataKey<String>	ANCHORLINKS_TEXT_SUFFIX
static final DataKey<Boolean>	ANCHORLINKS_WRAP_TEXT

Fields inherited from interface Extension

EMPTY_LIST

Constructor Summary

Constructors

Modifier	Constructor	Description
private	AnchorLinkExtension()

Method Summary

Modifier and Type	Method	Description
static AnchorLinkExtension	create()
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.

Methods inherited from class Object

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

Field Details

ANCHORLINKS_WRAP_TEXT

public static final DataKey<Boolean> ANCHORLINKS_WRAP_TEXT

ANCHORLINKS_TEXT_PREFIX

public static final DataKey<String> ANCHORLINKS_TEXT_PREFIX

ANCHORLINKS_TEXT_SUFFIX

public static final DataKey<String> ANCHORLINKS_TEXT_SUFFIX

ANCHORLINKS_ANCHOR_CLASS

public static final DataKey<String> ANCHORLINKS_ANCHOR_CLASS

ANCHORLINKS_SET_NAME

public static final DataKey<Boolean> ANCHORLINKS_SET_NAME

ANCHORLINKS_SET_ID

public static final DataKey<Boolean> ANCHORLINKS_SET_ID

ANCHORLINKS_NO_BLOCK_QUOTE

public static final DataKey<Boolean> ANCHORLINKS_NO_BLOCK_QUOTE

Constructor Details

AnchorLinkExtension

private AnchorLinkExtension()

Method Details

create

public static AnchorLinkExtension create()

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)

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 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

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)