Top Description Fields Constructors Methods
com.vladsch.flexmark.ext.spec.example

public Class SpecExampleExtension

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.spec.example.internal.RenderAs, .SpecExampleBlockParser, .SpecExampleNodeFormatter, .SpecExampleNodeRenderer, com.vladsch.flexmark.formatter.Formatter, com.vladsch.flexmark.html.HtmlRenderer, com.vladsch.flexmark.parser.Parser, com.vladsch.flexmark.test.util.spec.SpecExample, .SpecReader, com.vladsch.flexmark.util.data.DataKey, .MutableDataHolder, org.jetbrains.annotations.NotNull, java.util.HashMap, .Map
Extension for spec_examples

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

The parsed spec_example text is turned into SpecExample nodes.

Field Summary

Modifier and TypeField and Description
private static final Map<Integer, String>
DEFAULT_LANGUAGE_MAPPING

private static final Map<Integer, String>
DEFAULT_SECTION_MAPPING

public static final DataKey<String>
SPEC_EXAMPLE_BREAK

public static final DataKey<RenderAs>
SPEC_EXAMPLE_RENDER_AS

public static final DataKey<Boolean>
SPEC_EXAMPLE_RENDER_RAW_HTML

public static final DataKey<String>
SPEC_EXAMPLE_RENDERED_HTML_PREFIX

public static final DataKey<String>
SPEC_EXAMPLE_RENDERED_HTML_SUFFIX

public static final DataKey<Map<Integer, String>>
SPEC_EXAMPLE_SECTION_LANGUAGES

public static final DataKey<Map<Integer, String>>
SPEC_EXAMPLE_SECTION_NAMES

public static final DataKey<Boolean>
SPEC_OPTION_NODES

public static final DataKey<String>
SPEC_SECTION_BREAK

public static final DataKey<String>
SPEC_TYPE_BREAK

Deprecated

Constructor Summary

AccessConstructor and Description
private
SpecExampleExtension()

Method Summary

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

DEFAULT_LANGUAGE_MAPPINGback to summary
private static final Map<Integer, String> DEFAULT_LANGUAGE_MAPPING
DEFAULT_SECTION_MAPPINGback to summary
private static final Map<Integer, String> DEFAULT_SECTION_MAPPING
SPEC_EXAMPLE_BREAKback to summary
public static final DataKey<String> SPEC_EXAMPLE_BREAK
SPEC_EXAMPLE_RENDER_ASback to summary
public static final DataKey<RenderAs> SPEC_EXAMPLE_RENDER_AS
SPEC_EXAMPLE_RENDER_RAW_HTMLback to summary
public static final DataKey<Boolean> SPEC_EXAMPLE_RENDER_RAW_HTML
SPEC_EXAMPLE_RENDERED_HTML_PREFIXback to summary
public static final DataKey<String> SPEC_EXAMPLE_RENDERED_HTML_PREFIX
SPEC_EXAMPLE_RENDERED_HTML_SUFFIXback to summary
public static final DataKey<String> SPEC_EXAMPLE_RENDERED_HTML_SUFFIX
SPEC_EXAMPLE_SECTION_LANGUAGESback to summary
public static final DataKey<Map<Integer, String>> SPEC_EXAMPLE_SECTION_LANGUAGES
SPEC_EXAMPLE_SECTION_NAMESback to summary
public static final DataKey<Map<Integer, String>> SPEC_EXAMPLE_SECTION_NAMES
SPEC_OPTION_NODESback to summary
public static final DataKey<Boolean> SPEC_OPTION_NODES
SPEC_SECTION_BREAKback to summary
public static final DataKey<String> SPEC_SECTION_BREAK
SPEC_TYPE_BREAKback to summary
public static final DataKey<String> SPEC_TYPE_BREAK

Deprecated

Annotations
@Deprecated

Constructor Detail

SpecExampleExtensionback to summary
private SpecExampleExtension()

Method Detail

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