Top Description Fields Constructors Methods
com.vladsch.flexmark.ext.gfm.strikethrough

public Class StrikethroughExtension

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.gfm.strikethrough.internal.StrikethroughDelimiterProcessor, .StrikethroughJiraRenderer, .StrikethroughNodeRenderer, .StrikethroughYouTrackRenderer, com.vladsch.flexmark.html.HtmlRenderer, com.vladsch.flexmark.parser.Parser, com.vladsch.flexmark.util.data.MutableDataHolder, .NullableDataKey, org.jetbrains.annotations.NotNull

Extension for GFM strikethrough using ~~ (GitHub Flavored Markdown).

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

The parsed strikethrough text regions are turned into Strikethrough nodes.

Field Summary

Modifier and TypeField and Description
public static final NullableDataKey<String>
public static final NullableDataKey<String>

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static StrikethroughExtension
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
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

STRIKETHROUGH_STYLE_HTML_CLOSEback to summary
public static final NullableDataKey<String> STRIKETHROUGH_STYLE_HTML_CLOSE
STRIKETHROUGH_STYLE_HTML_OPENback to summary
public static final NullableDataKey<String> STRIKETHROUGH_STYLE_HTML_OPEN

Constructor Detail

StrikethroughExtensionback to summary
private StrikethroughExtension()

Method Detail

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