Package com.vladsch.flexmark.ext.admonition

Class AdmonitionExtension

java.lang.Object

com.vladsch.flexmark.ext.admonition.AdmonitionExtension

All Implemented Interfaces:

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

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

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

Fields

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

Fields inherited from interface com.vladsch.flexmark.util.misc.Extension

EMPTY_LIST

Constructor Summary

Constructors

Modifier	Constructor	Description
private	AdmonitionExtension()

Method Summary

Modifier and Type	Method	Description
static void	copy(java.io.Reader reader, java.io.Writer writer)
static AdmonitionExtension	create()
void	extend(Formatter.Builder formatterBuilder)
void	extend(HtmlRenderer.Builder htmlRendererBuilder, @NotNull java.lang.String rendererType)	Called to give each extension to register extension points that it contains
void	extend(Parser.Builder parserBuilder)	This method is called on all extensions so that they can register their custom processors
static java.lang.String	getDefaultCSS()
static java.lang.String	getDefaultScript()
static java.lang.String	getInputStreamContent(java.io.InputStream inputStream)
static java.util.Map<java.lang.String,java.lang.String>	getQualifierSvgValueMap()
static java.util.Map<java.lang.String,java.lang.String>	getQualifierTitleMap()
static java.util.Map<java.lang.String,java.lang.String>	getQualifierTypeMap()
void	parserOptions(MutableDataHolder options)	This method is called first on all extensions so that they can adjust the options that must be common to all extensions.
void	rendererOptions(@NotNull MutableDataHolder options)	This method is called first on all extensions so that they can adjust the options that must be common to all extensions.

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<java.lang.Integer> CONTENT_INDENT

ALLOW_LEADING_SPACE

public static final DataKey<java.lang.Boolean> ALLOW_LEADING_SPACE

INTERRUPTS_PARAGRAPH

public static final DataKey<java.lang.Boolean> INTERRUPTS_PARAGRAPH

INTERRUPTS_ITEM_PARAGRAPH

public static final DataKey<java.lang.Boolean> INTERRUPTS_ITEM_PARAGRAPH

WITH_SPACES_INTERRUPTS_ITEM_PARAGRAPH

public static final DataKey<java.lang.Boolean> WITH_SPACES_INTERRUPTS_ITEM_PARAGRAPH

ALLOW_LAZY_CONTINUATION

public static final DataKey<java.lang.Boolean> ALLOW_LAZY_CONTINUATION

UNRESOLVED_QUALIFIER

public static final DataKey<java.lang.String> UNRESOLVED_QUALIFIER

QUALIFIER_TYPE_MAP

public static final DataKey<java.util.Map<java.lang.String,java.lang.String>> QUALIFIER_TYPE_MAP

QUALIFIER_TITLE_MAP

public static final DataKey<java.util.Map<java.lang.String,java.lang.String>> QUALIFIER_TITLE_MAP

TYPE_SVG_MAP

public static final DataKey<java.util.Map<java.lang.String,java.lang.String>> TYPE_SVG_MAP

Constructor Detail

AdmonitionExtension

private AdmonitionExtension()

Method Detail

getQualifierTypeMap

public static java.util.Map<java.lang.String,java.lang.String> getQualifierTypeMap()

getQualifierTitleMap

public static java.util.Map<java.lang.String,java.lang.String> getQualifierTitleMap()

getQualifierSvgValueMap

public static java.util.Map<java.lang.String,java.lang.String> getQualifierSvgValueMap()

getInputStreamContent

public static java.lang.String getInputStreamContent(java.io.InputStream inputStream)

getDefaultCSS

public static java.lang.String getDefaultCSS()

getDefaultScript

public static java.lang.String getDefaultScript()

copy

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

Throws:

java.io.IOException

create

public static AdmonitionExtension create()

extend

public void extend(Formatter.Builder formatterBuilder)

Specified by:

extend in interface Formatter.FormatterExtension

rendererOptions

public void rendererOptions(@NotNull
                            @NotNull MutableDataHolder options)

Description copied from interface: HtmlRenderer.HtmlRendererExtension

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

Specified by:

rendererOptions in interface Formatter.FormatterExtension

Specified by:

rendererOptions in interface HtmlRenderer.HtmlRendererExtension

Parameters:

options - option set that will be used for the builder

parserOptions

public void parserOptions(MutableDataHolder options)

Description copied from interface: Parser.ParserExtension

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

Specified by:

parserOptions in interface Parser.ParserExtension

Parameters:

options - option set that will be used for the builder

extend

public void extend(Parser.Builder parserBuilder)

Description copied from interface: Parser.ParserExtension

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

Specified by:

extend in interface Parser.ParserExtension

Parameters:

parserBuilder - parser builder with which to register extensions

See Also:

Parser.Builder.customBlockParserFactory(CustomBlockParserFactory), Parser.Builder.customInlineParserExtensionFactory(InlineParserExtensionFactory), Parser.Builder.customInlineParserFactory(InlineParserFactory), Parser.Builder.customDelimiterProcessor(DelimiterProcessor), Parser.Builder.postProcessorFactory(PostProcessorFactory), Parser.Builder.paragraphPreProcessorFactory(ParagraphPreProcessorFactory), Parser.Builder.blockPreProcessorFactory(BlockPreProcessorFactory), Parser.Builder.linkRefProcessorFactory(LinkRefProcessorFactory), Parser.Builder.specialLeadInHandler(SpecialLeadInHandler)

extend

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

Description copied from interface: HtmlRenderer.HtmlRendererExtension

Called to give each extension to register extension points that it contains

Specified by:

extend in interface HtmlRenderer.HtmlRendererExtension

Parameters:

htmlRendererBuilder - builder to call back for extension point registration

rendererType - type of rendering being performed. For now "HTML", "JIRA" or "YOUTRACK"

See Also:

HtmlRenderer.Builder.attributeProviderFactory(AttributeProviderFactory), HtmlRenderer.Builder.nodeRendererFactory(NodeRendererFactory), HtmlRenderer.Builder.linkResolverFactory(LinkResolverFactory), HtmlRenderer.Builder.htmlIdGeneratorFactory(HeaderIdGeneratorFactory)