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 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
FieldsModifier and TypeFieldDescriptionstatic final DataKey<ElementPlacement>
static final DataKey<ElementPlacementSort>
static final DataKey<FootnoteRepository>
Fields inherited from interface com.vladsch.flexmark.util.misc.Extension
EMPTY_LIST
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic FootnoteExtension
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 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
(@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
-
Field Details
-
FOOTNOTES_KEEP
-
FOOTNOTES
-
FOOTNOTE_REF_PREFIX
-
FOOTNOTE_REF_SUFFIX
-
FOOTNOTE_BACK_REF_STRING
-
FOOTNOTE_LINK_REF_CLASS
-
FOOTNOTE_BACK_LINK_REF_CLASS
-
FOOTNOTE_PLACEMENT
-
FOOTNOTE_SORT
-
-
Constructor Details
-
FootnoteExtension
private FootnoteExtension()
-
-
Method Details
-
create
-
extend
- Specified by:
extend
in interfaceFormatter.FormatterExtension
-
rendererOptions
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
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
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
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 @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 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:
-