Class SubscriptExtension
- java.lang.Object
-
- com.vladsch.flexmark.ext.gfm.strikethrough.SubscriptExtension
-
- All Implemented Interfaces:
HtmlRenderer.HtmlRendererExtension
,Parser.ParserExtension
,Extension
public class SubscriptExtension extends java.lang.Object implements Parser.ParserExtension, HtmlRenderer.HtmlRendererExtension
Extension for GFM strikethrough using ~~ (GitHub Flavored Markdown).Create it with
create()
and then configure it on the buildersThe parsed strikethrough text regions are turned into
Strikethrough
nodes.
-
-
Field Summary
Fields Modifier and Type Field Description static NullableDataKey<java.lang.String>
SUBSCRIPT_STYLE_HTML_CLOSE
static NullableDataKey<java.lang.String>
SUBSCRIPT_STYLE_HTML_OPEN
-
Fields inherited from interface com.vladsch.flexmark.util.misc.Extension
EMPTY_LIST
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static SubscriptExtension
create()
void
extend(HtmlRenderer.Builder htmlRendererBuilder, java.lang.String rendererType)
Called to give each extension to register extension points that it containsvoid
extend(Parser.Builder parserBuilder)
This method is called on all extensions so that they can register their custom processorsvoid
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.
-
-
-
Field Detail
-
SUBSCRIPT_STYLE_HTML_OPEN
public static final NullableDataKey<java.lang.String> SUBSCRIPT_STYLE_HTML_OPEN
-
SUBSCRIPT_STYLE_HTML_CLOSE
public static final NullableDataKey<java.lang.String> SUBSCRIPT_STYLE_HTML_CLOSE
-
-
Method Detail
-
create
public static SubscriptExtension 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 interfaceHtmlRenderer.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 interfaceParser.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 interfaceParser.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 interfaceHtmlRenderer.HtmlRendererExtension
- Parameters:
htmlRendererBuilder
- builder to call back for extension point registrationrendererType
- 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)
-
-