com.vladsch.flexmark.ext.gfm.strikethrough

Class StrikethroughExtension

java.lang.Object

com.vladsch.flexmark.ext.gfm.strikethrough.StrikethroughExtension

All Implemented Interfaces:

com.vladsch.flexmark.Extension, com.vladsch.flexmark.html.HtmlRenderer.HtmlRendererExtension, com.vladsch.flexmark.parser.Parser.ParserExtension

public class StrikethroughExtension
extends Object
implements com.vladsch.flexmark.parser.Parser.ParserExtension, com.vladsch.flexmark.html.HtmlRenderer.HtmlRendererExtension

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

Create it with create() and then configure it on the builders (Parser.Builder.extensions(Iterable), HtmlRenderer.Builder.extensions(Iterable)).

The parsed strikethrough text regions are turned into Strikethrough nodes.

Field Summary

Fields

Modifier and Type	Field and Description
static com.vladsch.flexmark.util.options.DataKey<String>	STRIKETHROUGH_STYLE_HTML_CLOSE
static com.vladsch.flexmark.util.options.DataKey<String>	STRIKETHROUGH_STYLE_HTML_OPEN

Fields inherited from interface com.vladsch.flexmark.Extension

EMPTY_LIST, EMPTY_SET

Method Summary

Modifier and Type	Method and Description
static com.vladsch.flexmark.Extension	create()
void	extend(com.vladsch.flexmark.html.HtmlRenderer.Builder rendererBuilder, String rendererType)
void	extend(com.vladsch.flexmark.parser.Parser.Builder parserBuilder)
void	parserOptions(com.vladsch.flexmark.util.options.MutableDataHolder options)
void	rendererOptions(com.vladsch.flexmark.util.options.MutableDataHolder options)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

STRIKETHROUGH_STYLE_HTML_OPEN

public static final com.vladsch.flexmark.util.options.DataKey<String> STRIKETHROUGH_STYLE_HTML_OPEN

STRIKETHROUGH_STYLE_HTML_CLOSE

public static final com.vladsch.flexmark.util.options.DataKey<String> STRIKETHROUGH_STYLE_HTML_CLOSE

Method Detail

create

public static com.vladsch.flexmark.Extension create()

rendererOptions

public void rendererOptions(com.vladsch.flexmark.util.options.MutableDataHolder options)

Specified by:

rendererOptions in interface com.vladsch.flexmark.html.HtmlRenderer.HtmlRendererExtension

parserOptions

public void parserOptions(com.vladsch.flexmark.util.options.MutableDataHolder options)

Specified by:

parserOptions in interface com.vladsch.flexmark.parser.Parser.ParserExtension

extend

public void extend(com.vladsch.flexmark.parser.Parser.Builder parserBuilder)

Specified by:

extend in interface com.vladsch.flexmark.parser.Parser.ParserExtension

extend

public void extend(com.vladsch.flexmark.html.HtmlRenderer.Builder rendererBuilder,
                   String rendererType)

Specified by:

extend in interface com.vladsch.flexmark.html.HtmlRenderer.HtmlRendererExtension