com.vladsch.flexmark.ext.footnotes

Class FootnoteExtension

java.lang.Object

com.vladsch.flexmark.ext.footnotes.FootnoteExtension

All Implemented Interfaces:

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

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 (Parser.Builder.extensions(Iterable), HtmlRenderer.Builder.extensions(Iterable)).

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 and Description
static DataKey<String>	FOOTNOTE_BACK_LINK_REF_CLASS
static DataKey<String>	FOOTNOTE_BACK_REF_STRING
static DataKey<String>	FOOTNOTE_LINK_REF_CLASS
static DataKey<ElementPlacement>	FOOTNOTE_PLACEMENT
static DataKey<String>	FOOTNOTE_REF_PREFIX
static DataKey<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.Extension

EMPTY_LIST, EMPTY_SET

Method Summary

Modifier and Type	Method and Description
static Extension	create()
void	extend(Formatter.Builder builder)
void	extend(HtmlRenderer.Builder rendererBuilder, String rendererType)
void	extend(Parser.Builder parserBuilder)
void	parserOptions(MutableDataHolder options)
void	rendererOptions(MutableDataHolder options)
boolean	transferReferences(MutableDataHolder document, DataHolder included)

Methods inherited from class java.lang.Object

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

Field Detail

FOOTNOTES

public static final DataKey<FootnoteRepository> FOOTNOTES

FOOTNOTES_KEEP

public static final DataKey<KeepType> FOOTNOTES_KEEP

FOOTNOTE_REF_PREFIX

public static final DataKey<String> FOOTNOTE_REF_PREFIX

FOOTNOTE_REF_SUFFIX

public static final DataKey<String> FOOTNOTE_REF_SUFFIX

FOOTNOTE_BACK_REF_STRING

public static final DataKey<String> FOOTNOTE_BACK_REF_STRING

FOOTNOTE_LINK_REF_CLASS

public static final DataKey<String> FOOTNOTE_LINK_REF_CLASS

FOOTNOTE_BACK_LINK_REF_CLASS

public static final DataKey<String> FOOTNOTE_BACK_LINK_REF_CLASS

FOOTNOTE_PLACEMENT

public static final DataKey<ElementPlacement> FOOTNOTE_PLACEMENT

FOOTNOTE_SORT

public static final DataKey<ElementPlacementSort> FOOTNOTE_SORT

Method Detail

create

public static Extension create()

extend

public void extend(Formatter.Builder builder)

Specified by:

extend in interface Formatter.FormatterExtension

rendererOptions

public void rendererOptions(MutableDataHolder options)

Specified by:

rendererOptions in interface Formatter.FormatterExtension

Specified by:

rendererOptions in interface HtmlRenderer.HtmlRendererExtension

parserOptions

public void parserOptions(MutableDataHolder options)

Specified by:

parserOptions in interface Parser.ParserExtension

transferReferences

public boolean transferReferences(MutableDataHolder document,
                                  DataHolder included)

Specified by:

transferReferences in interface Parser.ReferenceHoldingExtension

extend

public void extend(Parser.Builder parserBuilder)

Specified by:

extend in interface Parser.ParserExtension

extend

public void extend(HtmlRenderer.Builder rendererBuilder,
                   String rendererType)

Specified by:

extend in interface HtmlRenderer.HtmlRendererExtension