Package com.vladsch.flexmark.ext.aside

Class AsideExtension

java.lang.Object

com.vladsch.flexmark.ext.aside.AsideExtension

All Implemented Interfaces:

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

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

Extension for ext_asides

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

The parsed pipe prefixed text is turned into AsideBlock nodes.

Field Summary

Fields

Modifier and Type	Field	Description
static DataKey<java.lang.Boolean>	ALLOW_LEADING_SPACE
static DataKey<java.lang.Boolean>	EXTEND_TO_BLANK_LINE
static DataKey<java.lang.Boolean>	IGNORE_BLANK_LINE
static DataKey<java.lang.Boolean>	INTERRUPTS_ITEM_PARAGRAPH
static DataKey<java.lang.Boolean>	INTERRUPTS_PARAGRAPH
static DataKey<java.lang.Boolean>	WITH_LEAD_SPACES_INTERRUPTS_ITEM_PARAGRAPH

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

EMPTY_LIST

Constructor Summary

Constructors

Modifier	Constructor	Description
private	AsideExtension()

Method Summary

Modifier and Type	Method	Description
static AsideExtension	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
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

EXTEND_TO_BLANK_LINE

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

IGNORE_BLANK_LINE

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

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_LEAD_SPACES_INTERRUPTS_ITEM_PARAGRAPH

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

Constructor Detail

AsideExtension

private AsideExtension()

Method Detail

create

public static AsideExtension create()

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(Formatter.Builder formatterBuilder)

Specified by:

extend in interface Formatter.FormatterExtension

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)