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

public Class AdmonitionExtension

extends Object
implements ParserExtension, HtmlRendererExtension, FormatterExtension
Class Inheritance
All Implemented Interfaces
com.vladsch.flexmark.formatter.Formatter.FormatterExtension, com.vladsch.flexmark.util.misc.Extension, com.vladsch.flexmark.html.HtmlRenderer.HtmlRendererExtension, com.vladsch.flexmark.parser.Parser.ParserExtension
Imports
com.vladsch.flexmark.ext.admonition.internal.AdmonitionBlockParser, .AdmonitionNodeFormatter, .AdmonitionNodeRenderer, com.vladsch.flexmark.formatter.Formatter, com.vladsch.flexmark.html.HtmlRenderer, com.vladsch.flexmark.parser.Parser, com.vladsch.flexmark.util.data.DataKey, .MutableDataHolder, org.jetbrains.annotations.NotNull, java.io.*, java.util.HashMap, .Map
Extension for admonitions

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

The parsed admonition text is turned into AdmonitionBlock nodes.

Field Summary

Modifier and TypeField and Description
public static final DataKey<Boolean>
ALLOW_LAZY_CONTINUATION

public static final DataKey<Boolean>
ALLOW_LEADING_SPACE

public static final DataKey<Integer>
CONTENT_INDENT

public static final DataKey<Boolean>
INTERRUPTS_ITEM_PARAGRAPH

public static final DataKey<Boolean>
INTERRUPTS_PARAGRAPH

public static final DataKey<Map<String, String>>
QUALIFIER_TITLE_MAP

public static final DataKey<Map<String, String>>
QUALIFIER_TYPE_MAP

public static final DataKey<Map<String, String>>
TYPE_SVG_MAP

public static final DataKey<String>
UNRESOLVED_QUALIFIER

public static final DataKey<Boolean>
WITH_SPACES_INTERRUPTS_ITEM_PARAGRAPH

Constructor Summary

AccessConstructor and Description
private
AdmonitionExtension()

Method Summary

Modifier and TypeMethod and Description
public static void
copy(Reader reader, Writer writer)

public static AdmonitionExtension
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 static String
getDefaultCSS()

public static String
getDefaultScript()

public static String
getInputStreamContent(InputStream inputStream)

public static Map<String, String>
getQualifierSvgValueMap()

public static Map<String, String>
getQualifierTitleMap()

public static Map<String, String>
getQualifierTypeMap()

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.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

ALLOW_LAZY_CONTINUATIONback to summary
public static final DataKey<Boolean> ALLOW_LAZY_CONTINUATION
ALLOW_LEADING_SPACEback to summary
public static final DataKey<Boolean> ALLOW_LEADING_SPACE
CONTENT_INDENTback to summary
public static final DataKey<Integer> CONTENT_INDENT
INTERRUPTS_ITEM_PARAGRAPHback to summary
public static final DataKey<Boolean> INTERRUPTS_ITEM_PARAGRAPH
INTERRUPTS_PARAGRAPHback to summary
public static final DataKey<Boolean> INTERRUPTS_PARAGRAPH
QUALIFIER_TITLE_MAPback to summary
public static final DataKey<Map<String, String>> QUALIFIER_TITLE_MAP
QUALIFIER_TYPE_MAPback to summary
public static final DataKey<Map<String, String>> QUALIFIER_TYPE_MAP
TYPE_SVG_MAPback to summary
public static final DataKey<Map<String, String>> TYPE_SVG_MAP
UNRESOLVED_QUALIFIERback to summary
public static final DataKey<String> UNRESOLVED_QUALIFIER
WITH_SPACES_INTERRUPTS_ITEM_PARAGRAPHback to summary
public static final DataKey<Boolean> WITH_SPACES_INTERRUPTS_ITEM_PARAGRAPH

Constructor Detail

AdmonitionExtensionback to summary
private AdmonitionExtension()

Method Detail

copyback to summary
public static void copy(Reader reader, Writer writer) throws IOException
createback to summary
public static AdmonitionExtension 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
getDefaultCSSback to summary
public static String getDefaultCSS()
getDefaultScriptback to summary
public static String getDefaultScript()
getInputStreamContentback to summary
public static String getInputStreamContent(InputStream inputStream)
getQualifierSvgValueMapback to summary
public static Map<String, String> getQualifierSvgValueMap()
getQualifierTitleMapback to summary
public static Map<String, String> getQualifierTitleMap()
getQualifierTypeMapback to summary
public static Map<String, String> getQualifierTypeMap()
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