Class FootnoteExtension
- java.lang.Object
-
- com.vladsch.flexmark.ext.footnotes.FootnoteExtension
-
- All Implemented Interfaces:
com.vladsch.flexmark.formatter.Formatter.FormatterExtension
,com.vladsch.flexmark.html.HtmlRenderer.HtmlRendererExtension
,com.vladsch.flexmark.parser.Parser.ParserExtension
,com.vladsch.flexmark.parser.Parser.ReferenceHoldingExtension
,com.vladsch.flexmark.util.misc.Extension
public class FootnoteExtension extends Object implements com.vladsch.flexmark.parser.Parser.ParserExtension, com.vladsch.flexmark.html.HtmlRenderer.HtmlRendererExtension, com.vladsch.flexmark.parser.Parser.ReferenceHoldingExtension, com.vladsch.flexmark.formatter.Formatter.FormatterExtension
Extension for footnotesCreate it with
create()
and then configure it on the buildersThe parsed footnote references in text regions are turned into
Footnote
nodes. The parsed footnote definitions are turned intoFootnoteBlock
nodes.
-
-
Field Summary
Fields Modifier and Type Field Description static com.vladsch.flexmark.util.data.DataKey<String>
FOOTNOTE_BACK_LINK_REF_CLASS
static com.vladsch.flexmark.util.data.DataKey<String>
FOOTNOTE_BACK_REF_STRING
static com.vladsch.flexmark.util.data.DataKey<String>
FOOTNOTE_LINK_REF_CLASS
static com.vladsch.flexmark.util.data.DataKey<com.vladsch.flexmark.util.format.options.ElementPlacement>
FOOTNOTE_PLACEMENT
static com.vladsch.flexmark.util.data.DataKey<String>
FOOTNOTE_REF_PREFIX
static com.vladsch.flexmark.util.data.DataKey<String>
FOOTNOTE_REF_SUFFIX
static com.vladsch.flexmark.util.data.DataKey<com.vladsch.flexmark.util.format.options.ElementPlacementSort>
FOOTNOTE_SORT
static com.vladsch.flexmark.util.data.DataKey<com.vladsch.flexmark.ext.footnotes.internal.FootnoteRepository>
FOOTNOTES
static com.vladsch.flexmark.util.data.DataKey<com.vladsch.flexmark.util.ast.KeepType>
FOOTNOTES_KEEP
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static FootnoteExtension
create()
void
extend(com.vladsch.flexmark.formatter.Formatter.Builder formatterBuilder)
void
extend(com.vladsch.flexmark.html.HtmlRenderer.Builder htmlRendererBuilder, @NotNull String rendererType)
void
extend(com.vladsch.flexmark.parser.Parser.Builder parserBuilder)
void
parserOptions(com.vladsch.flexmark.util.data.MutableDataHolder options)
void
rendererOptions(@NotNull com.vladsch.flexmark.util.data.MutableDataHolder options)
boolean
transferReferences(com.vladsch.flexmark.util.data.MutableDataHolder document, com.vladsch.flexmark.util.data.DataHolder included)
-
-
-
Field Detail
-
FOOTNOTES_KEEP
public static final com.vladsch.flexmark.util.data.DataKey<com.vladsch.flexmark.util.ast.KeepType> FOOTNOTES_KEEP
-
FOOTNOTES
public static final com.vladsch.flexmark.util.data.DataKey<com.vladsch.flexmark.ext.footnotes.internal.FootnoteRepository> FOOTNOTES
-
FOOTNOTE_REF_PREFIX
public static final com.vladsch.flexmark.util.data.DataKey<String> FOOTNOTE_REF_PREFIX
-
FOOTNOTE_REF_SUFFIX
public static final com.vladsch.flexmark.util.data.DataKey<String> FOOTNOTE_REF_SUFFIX
-
FOOTNOTE_BACK_REF_STRING
public static final com.vladsch.flexmark.util.data.DataKey<String> FOOTNOTE_BACK_REF_STRING
-
FOOTNOTE_LINK_REF_CLASS
public static final com.vladsch.flexmark.util.data.DataKey<String> FOOTNOTE_LINK_REF_CLASS
-
FOOTNOTE_BACK_LINK_REF_CLASS
public static final com.vladsch.flexmark.util.data.DataKey<String> FOOTNOTE_BACK_LINK_REF_CLASS
-
FOOTNOTE_PLACEMENT
public static final com.vladsch.flexmark.util.data.DataKey<com.vladsch.flexmark.util.format.options.ElementPlacement> FOOTNOTE_PLACEMENT
-
FOOTNOTE_SORT
public static final com.vladsch.flexmark.util.data.DataKey<com.vladsch.flexmark.util.format.options.ElementPlacementSort> FOOTNOTE_SORT
-
-
Method Detail
-
create
public static FootnoteExtension create()
-
extend
public void extend(com.vladsch.flexmark.formatter.Formatter.Builder formatterBuilder)
- Specified by:
extend
in interfacecom.vladsch.flexmark.formatter.Formatter.FormatterExtension
-
rendererOptions
public void rendererOptions(@NotNull @NotNull com.vladsch.flexmark.util.data.MutableDataHolder options)
- Specified by:
rendererOptions
in interfacecom.vladsch.flexmark.formatter.Formatter.FormatterExtension
- Specified by:
rendererOptions
in interfacecom.vladsch.flexmark.html.HtmlRenderer.HtmlRendererExtension
-
parserOptions
public void parserOptions(com.vladsch.flexmark.util.data.MutableDataHolder options)
- Specified by:
parserOptions
in interfacecom.vladsch.flexmark.parser.Parser.ParserExtension
-
transferReferences
public boolean transferReferences(com.vladsch.flexmark.util.data.MutableDataHolder document, com.vladsch.flexmark.util.data.DataHolder included)
- Specified by:
transferReferences
in interfacecom.vladsch.flexmark.parser.Parser.ReferenceHoldingExtension
-
extend
public void extend(com.vladsch.flexmark.parser.Parser.Builder parserBuilder)
- Specified by:
extend
in interfacecom.vladsch.flexmark.parser.Parser.ParserExtension
-
extend
public void extend(@NotNull com.vladsch.flexmark.html.HtmlRenderer.Builder htmlRendererBuilder, @NotNull @NotNull String rendererType)
- Specified by:
extend
in interfacecom.vladsch.flexmark.html.HtmlRenderer.HtmlRendererExtension
-
-