Top Description Fields Constructors Methods
com.vladsch.flexmark.ext.footnotes

public Class FootnoteExtension

extends Object
implements ParserExtension, HtmlRendererExtension, ReferenceHoldingExtension, FormatterExtension
Class Inheritance
All Implemented Interfaces
com.vladsch.flexmark.formatter.Formatter.FormatterExtension, com.vladsch.flexmark.util.misc.Extension, com.vladsch.flexmark.parser.Parser.ReferenceHoldingExtension, com.vladsch.flexmark.html.HtmlRenderer.HtmlRendererExtension, com.vladsch.flexmark.parser.Parser.ParserExtension
Imports
com.vladsch.flexmark.ext.footnotes.internal.*, com.vladsch.flexmark.formatter.Formatter, com.vladsch.flexmark.html.HtmlRenderer, com.vladsch.flexmark.parser.Parser, com.vladsch.flexmark.util.ast.KeepType, com.vladsch.flexmark.util.data.DataHolder, .DataKey, .MutableDataHolder, com.vladsch.flexmark.util.format.options.ElementPlacement, .ElementPlacementSort, org.jetbrains.annotations.NotNull
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

Modifier and TypeField and Description
public static final DataKey<String>
FOOTNOTE_BACK_REF_STRING

public static final DataKey<ElementPlacement>
FOOTNOTE_PLACEMENT

public static final DataKey<String>
FOOTNOTE_REF_PREFIX

public static final DataKey<String>
FOOTNOTE_REF_SUFFIX

public static final DataKey<ElementPlacementSort>
FOOTNOTE_SORT

public static final DataKey<FootnoteRepository>
FOOTNOTES

public static final DataKey<KeepType>
FOOTNOTES_KEEP

Constructor Summary

AccessConstructor and Description
private
FootnoteExtension()

Method Summary

Modifier and TypeMethod and Description
public static FootnoteExtension
create()

public void
extend(Formatter.Builder formatterBuilder)

Implements com.vladsch.flexmark.formatter.Formatter.FormatterExtension.extend.

public void
extend(Parser.Builder
parser builder with which to register extensions
parserBuilder)

Implements com.vladsch.flexmark.parser.Parser.ParserExtension.extend.

This method is called on all extensions so that they can register their custom processors

public void
extend(HtmlRenderer.Builder htmlRendererBuilder, @NotNull String rendererType)

public void
parserOptions(MutableDataHolder
option set that will be used for the builder
options)

Implements com.vladsch.flexmark.parser.Parser.ParserExtension.parserOptions.

This method is called first on all extensions so that they can adjust the options that must be common to all extensions.

public void
rendererOptions(@NotNull MutableDataHolder
option set that will be used for the builder
options)

Implements com.vladsch.flexmark.formatter.Formatter.FormatterExtension.rendererOptions.

This method is called first on all extensions so that they can adjust the options.

public boolean
transferReferences(MutableDataHolder
destination document for references
document, DataHolder
source document for references
included)

Implements com.vladsch.flexmark.parser.Parser.ReferenceHoldingExtension.transferReferences.

This method is called to transfer references from included document to the source document

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

FOOTNOTE_BACK_REF_STRINGback to summary
public static final DataKey<String> FOOTNOTE_BACK_REF_STRING
FOOTNOTE_PLACEMENTback to summary
public static final DataKey<ElementPlacement> FOOTNOTE_PLACEMENT
FOOTNOTE_REF_PREFIXback to summary
public static final DataKey<String> FOOTNOTE_REF_PREFIX
FOOTNOTE_REF_SUFFIXback to summary
public static final DataKey<String> FOOTNOTE_REF_SUFFIX
FOOTNOTE_SORTback to summary
public static final DataKey<ElementPlacementSort> FOOTNOTE_SORT
FOOTNOTESback to summary
public static final DataKey<FootnoteRepository> FOOTNOTES
FOOTNOTES_KEEPback to summary
public static final DataKey<KeepType> FOOTNOTES_KEEP

Constructor Detail

FootnoteExtensionback to summary
private FootnoteExtension()

Method Detail

createback to summary
public static FootnoteExtension create()
extendback to summary
public void extend(Formatter.Builder formatterBuilder)

Implements com.vladsch.flexmark.formatter.Formatter.FormatterExtension.extend.

Annotations
@Override
extendback to summary
public void extend(Parser.Builder parserBuilder)

Implements com.vladsch.flexmark.parser.Parser.ParserExtension.extend.

Doc from com.vladsch.flexmark.parser.Parser.ParserExtension.extend.

This method is called on all extensions so that they can register their custom processors

Parameters
parserBuilder:Parser.Builder

parser builder with which to register extensions

Annotations
@Override
extendback to summary
public void extend(HtmlRenderer.Builder htmlRendererBuilder, @NotNull String rendererType)
Annotations
@Override
parserOptionsback to summary
public void parserOptions(MutableDataHolder options)

Implements com.vladsch.flexmark.parser.Parser.ParserExtension.parserOptions.

Doc from com.vladsch.flexmark.parser.Parser.ParserExtension.parserOptions.

This method is called first on all extensions so that they can adjust the options that must be common to all extensions.

Parameters
options:MutableDataHolder

option set that will be used for the builder

Annotations
@Override
rendererOptionsback to summary
public void rendererOptions(@NotNull MutableDataHolder options)

Implements com.vladsch.flexmark.formatter.Formatter.FormatterExtension.rendererOptions.

Doc from com.vladsch.flexmark.formatter.Formatter.FormatterExtension.rendererOptions.

This method is called first on all extensions so that they can adjust the options.

Parameters
options:@NotNull MutableDataHolder

option set that will be used for the builder

Annotations
@Override
transferReferencesback to summary
public boolean transferReferences(MutableDataHolder document, DataHolder included)

Implements com.vladsch.flexmark.parser.Parser.ReferenceHoldingExtension.transferReferences.

Doc from com.vladsch.flexmark.parser.Parser.ReferenceHoldingExtension.transferReferences.

This method is called to transfer references from included document to the source document

Parameters
document:MutableDataHolder

destination document for references

included:DataHolder

source document for references

Returns:boolean

true if there were references to transfer

Annotations
@Override