com.vladsch.flexmark.ext.admonition

Class AdmonitionExtension

java.lang.Object

com.vladsch.flexmark.ext.admonition.AdmonitionExtension

All Implemented Interfaces:

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

public class AdmonitionExtension
extends Object
implements Parser.ParserExtension, HtmlRenderer.HtmlRendererExtension, Formatter.FormatterExtension

Extension for admonitions

Create it with create() and then configure it on the builders (Parser.Builder.extensions(Iterable), HtmlRenderer.Builder.extensions(Iterable)).

The parsed admonition text is turned into AdmonitionBlock nodes.

Field Summary

Fields

Modifier and Type	Field and Description
static DataKey<Boolean>	ALLOW_LAZY_CONTINUATION
static DataKey<Boolean>	ALLOW_LEADING_SPACE
static DataKey<Integer>	CONTENT_INDENT
static DataKey<Boolean>	INTERRUPTS_ITEM_PARAGRAPH
static DataKey<Boolean>	INTERRUPTS_PARAGRAPH
static DataKey<Map<String,String>>	QUALIFIER_TITLE_MAP
static DataKey<Map<String,String>>	QUALIFIER_TYPE_MAP
static DataKey<Map<String,String>>	TYPE_SVG_MAP
static DataKey<String>	UNRESOLVED_QUALIFIER
static DataKey<Boolean>	WITH_SPACES_INTERRUPTS_ITEM_PARAGRAPH

Fields inherited from interface com.vladsch.flexmark.Extension

EMPTY_LIST, EMPTY_SET

Method Summary

Modifier and Type	Method and Description
static void	copy(Reader reader, Writer writer)
static Extension	create()
void	extend(Formatter.Builder builder)
void	extend(HtmlRenderer.Builder rendererBuilder, String rendererType)
void	extend(Parser.Builder parserBuilder)
static String	getDefaultCSS()
static String	getDefaultScript()
static String	getInputStreamContent(InputStream inputStream)
static Map<String,String>	getQualifierSvgValueMap()
static Map<String,String>	getQualifierTitleMap()
static Map<String,String>	getQualifierTypeMap()
void	parserOptions(MutableDataHolder options)
void	rendererOptions(MutableDataHolder options)

Methods inherited from class java.lang.Object

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

Field Detail

CONTENT_INDENT

public static final DataKey<Integer> CONTENT_INDENT

ALLOW_LEADING_SPACE

public static final DataKey<Boolean> ALLOW_LEADING_SPACE

INTERRUPTS_PARAGRAPH

public static final DataKey<Boolean> INTERRUPTS_PARAGRAPH

INTERRUPTS_ITEM_PARAGRAPH

public static final DataKey<Boolean> INTERRUPTS_ITEM_PARAGRAPH

WITH_SPACES_INTERRUPTS_ITEM_PARAGRAPH

public static final DataKey<Boolean> WITH_SPACES_INTERRUPTS_ITEM_PARAGRAPH

ALLOW_LAZY_CONTINUATION

public static final DataKey<Boolean> ALLOW_LAZY_CONTINUATION

UNRESOLVED_QUALIFIER

public static final DataKey<String> UNRESOLVED_QUALIFIER

QUALIFIER_TYPE_MAP

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

QUALIFIER_TITLE_MAP

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

TYPE_SVG_MAP

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

Method Detail

getQualifierTypeMap

public static Map<String,String> getQualifierTypeMap()

getQualifierTitleMap

public static Map<String,String> getQualifierTitleMap()

getQualifierSvgValueMap

public static Map<String,String> getQualifierSvgValueMap()

getInputStreamContent

public static String getInputStreamContent(InputStream inputStream)

getDefaultCSS

public static String getDefaultCSS()

getDefaultScript

public static String getDefaultScript()

copy

public static void copy(Reader reader,
                        Writer writer)
                 throws IOException

Throws:

IOException

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

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