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

public Class DefinitionExtension

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.definition.internal.*, com.vladsch.flexmark.formatter.Formatter, com.vladsch.flexmark.html.HtmlRenderer, com.vladsch.flexmark.parser.Parser, com.vladsch.flexmark.util.data.DataKey, .MutableDataHolder, com.vladsch.flexmark.util.format.options.DefinitionMarker, org.jetbrains.annotations.NotNull
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

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

public static final DataKey<Boolean>
DOUBLE_BLANK_LINE_BREAKS_LIST

public static final DataKey<Integer>
FORMAT_MARKER_SPACES

public static final DataKey<DefinitionMarker>
FORMAT_MARKER_TYPE

public static final DataKey<Integer>
MARKER_SPACES

public static final DataKey<Boolean>
TILDE_MARKER

Constructor Summary

AccessConstructor and Description
private
DefinitionExtension()

Method Summary

Modifier and TypeMethod and Description
public static DefinitionExtension
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

COLON_MARKERback to summary
public static final DataKey<Boolean> COLON_MARKER
DOUBLE_BLANK_LINE_BREAKS_LISTback to summary
public static final DataKey<Boolean> DOUBLE_BLANK_LINE_BREAKS_LIST
FORMAT_MARKER_SPACESback to summary
public static final DataKey<Integer> FORMAT_MARKER_SPACES
FORMAT_MARKER_TYPEback to summary
public static final DataKey<DefinitionMarker> FORMAT_MARKER_TYPE
MARKER_SPACESback to summary
public static final DataKey<Integer> MARKER_SPACES
TILDE_MARKERback to summary
public static final DataKey<Boolean> TILDE_MARKER

Constructor Detail

DefinitionExtensionback to summary
private DefinitionExtension()

Method Detail

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