Package com.vladsch.flexmark.ext.footnotes

Class FootnoteExtension

java.lang.Object

com.vladsch.flexmark.ext.footnotes.FootnoteExtension

All Implemented Interfaces:

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

public class FootnoteExtension
extends java.lang.Object
implements Parser.ParserExtension, HtmlRenderer.HtmlRendererExtension, Parser.ReferenceHoldingExtension, Formatter.FormatterExtension

Extension for footnotes

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

The parsed footnote references in text regions are turned into Footnote nodes. The parsed footnote definitions are turned into FootnoteBlock nodes.

Field Summary

Fields

Modifier and Type	Field	Description
static DataKey<java.lang.String>	FOOTNOTE_BACK_LINK_REF_CLASS
static DataKey<java.lang.String>	FOOTNOTE_BACK_REF_STRING
static DataKey<java.lang.String>	FOOTNOTE_LINK_REF_CLASS
static DataKey<ElementPlacement>	FOOTNOTE_PLACEMENT
static DataKey<java.lang.String>	FOOTNOTE_REF_PREFIX
static DataKey<java.lang.String>	FOOTNOTE_REF_SUFFIX
static DataKey<ElementPlacementSort>	FOOTNOTE_SORT
static DataKey<FootnoteRepository>	FOOTNOTES
static DataKey<KeepType>	FOOTNOTES_KEEP

Fields inherited from interface com.vladsch.flexmark.util.misc.Extension

EMPTY_LIST

Constructor Summary

Constructors

Modifier	Constructor	Description
private	FootnoteExtension()

Method Summary

Modifier and Type	Method	Description
static FootnoteExtension	create()
void	extend(Formatter.Builder formatterBuilder)
void	extend(HtmlRenderer.Builder htmlRendererBuilder, @NotNull java.lang.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 java.lang.Object

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

Field Detail

FOOTNOTES_KEEP

public static final DataKey<KeepType> FOOTNOTES_KEEP

FOOTNOTES

public static final DataKey<FootnoteRepository> FOOTNOTES

FOOTNOTE_REF_PREFIX

public static final DataKey<java.lang.String> FOOTNOTE_REF_PREFIX

FOOTNOTE_REF_SUFFIX

public static final DataKey<java.lang.String> FOOTNOTE_REF_SUFFIX

FOOTNOTE_BACK_REF_STRING

public static final DataKey<java.lang.String> FOOTNOTE_BACK_REF_STRING

FOOTNOTE_LINK_REF_CLASS

public static final DataKey<java.lang.String> FOOTNOTE_LINK_REF_CLASS

FOOTNOTE_BACK_LINK_REF_CLASS

public static final DataKey<java.lang.String> FOOTNOTE_BACK_LINK_REF_CLASS

FOOTNOTE_PLACEMENT

public static final DataKey<ElementPlacement> FOOTNOTE_PLACEMENT

FOOTNOTE_SORT

public static final DataKey<ElementPlacementSort> FOOTNOTE_SORT

Constructor Detail

FootnoteExtension

private FootnoteExtension()

Method Detail

create

public static FootnoteExtension 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 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 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)