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

public Class AsideExtension

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.aside.internal.AsideBlockParser, .AsideNodeFormatter, .AsideNodeRenderer, 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
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

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

public static final DataKey<Boolean>
EXTEND_TO_BLANK_LINE

public static final DataKey<Boolean>
IGNORE_BLANK_LINE

public static final DataKey<Boolean>
INTERRUPTS_ITEM_PARAGRAPH

public static final DataKey<Boolean>
INTERRUPTS_PARAGRAPH

public static final DataKey<Boolean>
WITH_LEAD_SPACES_INTERRUPTS_ITEM_PARAGRAPH

Constructor Summary

AccessConstructor and Description
private
AsideExtension()

Method Summary

Modifier and TypeMethod and Description
public static AsideExtension
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 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_LEADING_SPACEback to summary
public static final DataKey<Boolean> ALLOW_LEADING_SPACE
EXTEND_TO_BLANK_LINEback to summary
public static final DataKey<Boolean> EXTEND_TO_BLANK_LINE
IGNORE_BLANK_LINEback to summary
public static final DataKey<Boolean> IGNORE_BLANK_LINE
INTERRUPTS_ITEM_PARAGRAPHback to summary
public static final DataKey<Boolean> INTERRUPTS_ITEM_PARAGRAPH
INTERRUPTS_PARAGRAPHback to summary
public static final DataKey<Boolean> INTERRUPTS_PARAGRAPH
WITH_LEAD_SPACES_INTERRUPTS_ITEM_PARAGRAPHback to summary
public static final DataKey<Boolean> WITH_LEAD_SPACES_INTERRUPTS_ITEM_PARAGRAPH

Constructor Detail

AsideExtensionback to summary
private AsideExtension()

Method Detail

createback to summary
public static AsideExtension 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
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