Package com.vladsch.flexmark.ext.typographic

Class TypographicExtension

java.lang.Object

com.vladsch.flexmark.ext.typographic.TypographicExtension

All Implemented Interfaces:

HtmlRenderer.HtmlRendererExtension, Parser.ParserExtension, Extension

public class TypographicExtension
extends java.lang.Object
implements Parser.ParserExtension, HtmlRenderer.HtmlRendererExtension

Extension for typographics

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

The parsed typographic text is turned into TypographicQuotes and TypographicSmarts nodes.

Field Summary

Fields

Modifier and Type	Field	Description
static DataKey<java.lang.String>	ANGLE_QUOTE_CLOSE
static DataKey<java.lang.String>	ANGLE_QUOTE_OPEN
static NullableDataKey<java.lang.String>	ANGLE_QUOTE_UNMATCHED
static DataKey<java.lang.String>	DOUBLE_QUOTE_CLOSE
static DataKey<java.lang.String>	DOUBLE_QUOTE_OPEN
static NullableDataKey<java.lang.String>	DOUBLE_QUOTE_UNMATCHED
static DataKey<java.lang.String>	ELLIPSIS
static DataKey<java.lang.String>	ELLIPSIS_SPACED
static DataKey<java.lang.String>	EM_DASH
static DataKey<java.lang.String>	EN_DASH
static DataKey<java.lang.Boolean>	ENABLE_QUOTES
static DataKey<java.lang.Boolean>	ENABLE_SMARTS
static DataKey<java.lang.String>	SINGLE_QUOTE_CLOSE
static DataKey<java.lang.String>	SINGLE_QUOTE_OPEN
static DataKey<java.lang.String>	SINGLE_QUOTE_UNMATCHED

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

EMPTY_LIST

Method Summary

Modifier and Type	Method	Description
static TypographicExtension	create()
void	extend(HtmlRenderer.Builder htmlRendererBuilder, 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(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

ENABLE_QUOTES

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

ENABLE_SMARTS

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

ANGLE_QUOTE_CLOSE

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

ANGLE_QUOTE_OPEN

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

ANGLE_QUOTE_UNMATCHED

public static final NullableDataKey<java.lang.String> ANGLE_QUOTE_UNMATCHED

DOUBLE_QUOTE_CLOSE

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

DOUBLE_QUOTE_OPEN

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

DOUBLE_QUOTE_UNMATCHED

public static final NullableDataKey<java.lang.String> DOUBLE_QUOTE_UNMATCHED

ELLIPSIS

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

ELLIPSIS_SPACED

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

EM_DASH

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

EN_DASH

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

SINGLE_QUOTE_CLOSE

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

SINGLE_QUOTE_OPEN

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

SINGLE_QUOTE_UNMATCHED

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

Method Detail

create

public static TypographicExtension create()

rendererOptions

public void rendererOptions(@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 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
                   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)