Package com.vladsch.flexmark.ext.definition

Class DefinitionExtension

java.lang.Object

com.vladsch.flexmark.ext.definition.DefinitionExtension

All Implemented Interfaces:

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

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

Extension for definitions

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

The parsed definition text is turned into DefinitionList, DefinitionTerm and DefinitionItem nodes.

Field Summary

Fields

Modifier and Type	Field	Description
static DataKey<java.lang.Boolean>	COLON_MARKER
static DataKey<java.lang.Boolean>	DOUBLE_BLANK_LINE_BREAKS_LIST
static DataKey<java.lang.Integer>	FORMAT_MARKER_SPACES
static DataKey<DefinitionMarker>	FORMAT_MARKER_TYPE
static DataKey<java.lang.Integer>	MARKER_SPACES
static DataKey<java.lang.Boolean>	TILDE_MARKER

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

EMPTY_LIST

Constructor Summary

Constructors

Modifier	Constructor	Description
private	DefinitionExtension()

Method Summary

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

COLON_MARKER

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

MARKER_SPACES

public static final DataKey<java.lang.Integer> MARKER_SPACES

TILDE_MARKER

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

DOUBLE_BLANK_LINE_BREAKS_LIST

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

FORMAT_MARKER_SPACES

public static final DataKey<java.lang.Integer> FORMAT_MARKER_SPACES

FORMAT_MARKER_TYPE

public static final DataKey<DefinitionMarker> FORMAT_MARKER_TYPE

Constructor Detail

DefinitionExtension

private DefinitionExtension()

Method Detail

create

public static DefinitionExtension 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)