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

public Class TypographicExtension

extends Object
implements ParserExtension, HtmlRendererExtension
Class Inheritance
All Implemented Interfaces
com.vladsch.flexmark.html.HtmlRenderer.HtmlRendererExtension, com.vladsch.flexmark.util.misc.Extension, com.vladsch.flexmark.parser.Parser.ParserExtension
Imports
com.vladsch.flexmark.ext.typographic.internal.*, com.vladsch.flexmark.html.HtmlRenderer, com.vladsch.flexmark.parser.Parser, com.vladsch.flexmark.util.data.DataKey, .MutableDataHolder, .NullableDataKey, org.jetbrains.annotations.NotNull
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

Modifier and TypeField and Description
public static final DataKey<String>
ANGLE_QUOTE_CLOSE

public static final DataKey<String>
ANGLE_QUOTE_OPEN

public static final NullableDataKey<String>
ANGLE_QUOTE_UNMATCHED

public static final DataKey<String>
DOUBLE_QUOTE_CLOSE

public static final DataKey<String>
DOUBLE_QUOTE_OPEN

public static final NullableDataKey<String>
DOUBLE_QUOTE_UNMATCHED

public static final DataKey<String>
ELLIPSIS

public static final DataKey<String>
ELLIPSIS_SPACED

public static final DataKey<String>
EM_DASH

public static final DataKey<String>
EN_DASH

public static final DataKey<Boolean>
ENABLE_QUOTES

public static final DataKey<Boolean>
ENABLE_SMARTS

public static final DataKey<String>
SINGLE_QUOTE_CLOSE

public static final DataKey<String>
SINGLE_QUOTE_OPEN

public static final DataKey<String>
SINGLE_QUOTE_UNMATCHED

Constructor Summary

AccessConstructor and Description
private
TypographicExtension()

Method Summary

Modifier and TypeMethod and Description
public static TypographicExtension
create()

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 options)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

ANGLE_QUOTE_CLOSEback to summary
public static final DataKey<String> ANGLE_QUOTE_CLOSE
ANGLE_QUOTE_OPENback to summary
public static final DataKey<String> ANGLE_QUOTE_OPEN
ANGLE_QUOTE_UNMATCHEDback to summary
public static final NullableDataKey<String> ANGLE_QUOTE_UNMATCHED
DOUBLE_QUOTE_CLOSEback to summary
public static final DataKey<String> DOUBLE_QUOTE_CLOSE
DOUBLE_QUOTE_OPENback to summary
public static final DataKey<String> DOUBLE_QUOTE_OPEN
DOUBLE_QUOTE_UNMATCHEDback to summary
public static final NullableDataKey<String> DOUBLE_QUOTE_UNMATCHED
ELLIPSISback to summary
public static final DataKey<String> ELLIPSIS
ELLIPSIS_SPACEDback to summary
public static final DataKey<String> ELLIPSIS_SPACED
EM_DASHback to summary
public static final DataKey<String> EM_DASH
EN_DASHback to summary
public static final DataKey<String> EN_DASH
ENABLE_QUOTESback to summary
public static final DataKey<Boolean> ENABLE_QUOTES
ENABLE_SMARTSback to summary
public static final DataKey<Boolean> ENABLE_SMARTS
SINGLE_QUOTE_CLOSEback to summary
public static final DataKey<String> SINGLE_QUOTE_CLOSE
SINGLE_QUOTE_OPENback to summary
public static final DataKey<String> SINGLE_QUOTE_OPEN
SINGLE_QUOTE_UNMATCHEDback to summary
public static final DataKey<String> SINGLE_QUOTE_UNMATCHED

Constructor Detail

TypographicExtensionback to summary
private TypographicExtension()

Method Detail

createback to summary
public static TypographicExtension create()
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)
Annotations
@Override