Package com.vladsch.flexmark.ext.spec.example

Class SpecExampleExtension

java.lang.Object

com.vladsch.flexmark.ext.spec.example.SpecExampleExtension

All Implemented Interfaces:

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

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

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

Fields

Modifier and Type	Field	Description
private static java.util.Map<java.lang.Integer,java.lang.String>	DEFAULT_LANGUAGE_MAPPING
private static java.util.Map<java.lang.Integer,java.lang.String>	DEFAULT_SECTION_MAPPING
static DataKey<java.lang.String>	SPEC_EXAMPLE_BREAK
static DataKey<RenderAs>	SPEC_EXAMPLE_RENDER_AS
static DataKey<java.lang.Boolean>	SPEC_EXAMPLE_RENDER_RAW_HTML
static DataKey<java.lang.String>	SPEC_EXAMPLE_RENDERED_HTML_PREFIX
static DataKey<java.lang.String>	SPEC_EXAMPLE_RENDERED_HTML_SUFFIX
static DataKey<java.util.Map<java.lang.Integer,java.lang.String>>	SPEC_EXAMPLE_SECTION_LANGUAGES
static DataKey<java.util.Map<java.lang.Integer,java.lang.String>>	SPEC_EXAMPLE_SECTION_NAMES
static DataKey<java.lang.Boolean>	SPEC_OPTION_NODES
static DataKey<java.lang.String>	SPEC_SECTION_BREAK
static DataKey<java.lang.String>	SPEC_TYPE_BREAK	Deprecated.

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

EMPTY_LIST

Constructor Summary

Constructors

Modifier	Constructor	Description
private	SpecExampleExtension()

Method Summary

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

DEFAULT_LANGUAGE_MAPPING

private static final java.util.Map<java.lang.Integer,java.lang.String> DEFAULT_LANGUAGE_MAPPING

DEFAULT_SECTION_MAPPING

private static final java.util.Map<java.lang.Integer,java.lang.String> DEFAULT_SECTION_MAPPING

SPEC_EXAMPLE_RENDER_RAW_HTML

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

SPEC_EXAMPLE_RENDERED_HTML_PREFIX

public static final DataKey<java.lang.String> SPEC_EXAMPLE_RENDERED_HTML_PREFIX

SPEC_EXAMPLE_RENDERED_HTML_SUFFIX

public static final DataKey<java.lang.String> SPEC_EXAMPLE_RENDERED_HTML_SUFFIX

SPEC_EXAMPLE_RENDER_AS

public static final DataKey<RenderAs> SPEC_EXAMPLE_RENDER_AS

SPEC_EXAMPLE_BREAK

public static final DataKey<java.lang.String> SPEC_EXAMPLE_BREAK

SPEC_SECTION_BREAK

public static final DataKey<java.lang.String> SPEC_SECTION_BREAK

SPEC_OPTION_NODES

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

SPEC_EXAMPLE_SECTION_LANGUAGES

public static final DataKey<java.util.Map<java.lang.Integer,java.lang.String>> SPEC_EXAMPLE_SECTION_LANGUAGES

SPEC_EXAMPLE_SECTION_NAMES

public static final DataKey<java.util.Map<java.lang.Integer,java.lang.String>> SPEC_EXAMPLE_SECTION_NAMES

SPEC_TYPE_BREAK

@Deprecated
public static final DataKey<java.lang.String> SPEC_TYPE_BREAK

Deprecated.

Constructor Detail

SpecExampleExtension

private SpecExampleExtension()

Method Detail

create

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