com.vladsch.flexmark.ext.gfm.tasklist

Class TaskListExtension

java.lang.Object

com.vladsch.flexmark.ext.gfm.tasklist.TaskListExtension

All Implemented Interfaces:

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

public class TaskListExtension
extends Object
implements com.vladsch.flexmark.parser.Parser.ParserExtension, com.vladsch.flexmark.html.HtmlRenderer.HtmlRendererExtension, com.vladsch.flexmark.formatter.Formatter.FormatterExtension

Extension for GFM style task list items

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

The bullet list items that begin with [ ], [x] or [X] are turned into TaskListItem nodes

Field Summary

Fields

Modifier and Type	Field and Description
static com.vladsch.flexmark.util.options.DataKey<TaskListItemCase>	FORMAT_LIST_ITEM_CASE
static com.vladsch.flexmark.util.options.DataKey<TaskListItemPlacement>	FORMAT_LIST_ITEM_PLACEMENT
static com.vladsch.flexmark.util.options.DataKey<String>	ITEM_CLASS Deprecated. use TIGHT_ITEM_CLASS instead
static com.vladsch.flexmark.util.options.DataKey<String>	ITEM_DONE_CLASS
static com.vladsch.flexmark.util.options.DataKey<String>	ITEM_DONE_MARKER
static com.vladsch.flexmark.util.options.DataKey<String>	ITEM_NOT_DONE_CLASS
static com.vladsch.flexmark.util.options.DataKey<String>	ITEM_NOT_DONE_MARKER
static com.vladsch.flexmark.util.options.DataKey<String>	LOOSE_ITEM_CLASS
static com.vladsch.flexmark.util.options.DataKey<String>	PARAGRAPH_CLASS
static com.vladsch.flexmark.util.options.DataKey<String>	TIGHT_ITEM_CLASS

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.formatter.Formatter.Builder builder)
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

ITEM_DONE_MARKER

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

ITEM_NOT_DONE_MARKER

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

TIGHT_ITEM_CLASS

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

LOOSE_ITEM_CLASS

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

PARAGRAPH_CLASS

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

ITEM_DONE_CLASS

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

ITEM_NOT_DONE_CLASS

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

ITEM_CLASS

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

Deprecated. use TIGHT_ITEM_CLASS instead

FORMAT_LIST_ITEM_CASE

public static final com.vladsch.flexmark.util.options.DataKey<TaskListItemCase> FORMAT_LIST_ITEM_CASE

FORMAT_LIST_ITEM_PLACEMENT

public static final com.vladsch.flexmark.util.options.DataKey<TaskListItemPlacement> FORMAT_LIST_ITEM_PLACEMENT

Method Detail

create

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

extend

public void extend(com.vladsch.flexmark.formatter.Formatter.Builder builder)

Specified by:

extend in interface com.vladsch.flexmark.formatter.Formatter.FormatterExtension

rendererOptions

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

Specified by:

rendererOptions in interface com.vladsch.flexmark.formatter.Formatter.FormatterExtension

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