Package com.vladsch.flexmark.ext.gfm.tasklist

Class TaskListExtension

java.lang.Object

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

All Implemented Interfaces:

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

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static Map<Character,Integer>	DEFAULT_PRIORITIES
static com.vladsch.flexmark.util.data.DataKey<Integer>	FORMAT_DEFAULT_TASK_ITEM_PRIORITY
static com.vladsch.flexmark.util.data.DataKey<TaskListItemCase>	FORMAT_LIST_ITEM_CASE
static com.vladsch.flexmark.util.data.DataKey<TaskListItemPlacement>	FORMAT_LIST_ITEM_PLACEMENT
static com.vladsch.flexmark.util.data.DataKey<Integer>	FORMAT_ORDERED_TASK_ITEM_PRIORITY
static com.vladsch.flexmark.util.data.DataKey<Boolean>	FORMAT_PRIORITIZED_TASK_ITEMS
static com.vladsch.flexmark.util.data.DataKey<Map<Character,Integer>>	FORMAT_TASK_ITEM_PRIORITIES	Priorities corresponding to Parser.LISTS_ITEM_PREFIX_CHARS If shorter than item prefix chars then any missing priorities are set to 0
static com.vladsch.flexmark.util.data.DataKey<String>	ITEM_DONE_CLASS
static com.vladsch.flexmark.util.data.DataKey<String>	ITEM_DONE_MARKER
static com.vladsch.flexmark.util.data.DataKey<String>	ITEM_NOT_DONE_CLASS
static com.vladsch.flexmark.util.data.DataKey<String>	ITEM_NOT_DONE_MARKER
static com.vladsch.flexmark.util.data.DataKey<String>	LOOSE_ITEM_CLASS
static com.vladsch.flexmark.util.data.DataKey<String>	PARAGRAPH_CLASS
static com.vladsch.flexmark.util.data.DataKey<String>	TIGHT_ITEM_CLASS

Fields inherited from interface com.vladsch.flexmark.util.misc.Extension

EMPTY_LIST

Method Summary

Modifier and Type	Method	Description
static TaskListExtension	create()
void	extend(com.vladsch.flexmark.formatter.Formatter.Builder formatterBuilder)
void	extend(com.vladsch.flexmark.html.HtmlRenderer.Builder htmlRendererBuilder, @NotNull String rendererType)
void	extend(com.vladsch.flexmark.parser.Parser.Builder parserBuilder)
void	parserOptions(com.vladsch.flexmark.util.data.MutableDataHolder options)
void	rendererOptions(@NotNull com.vladsch.flexmark.util.data.MutableDataHolder options)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PRIORITIES

public static final Map<Character,Integer> DEFAULT_PRIORITIES

ITEM_DONE_MARKER

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

ITEM_NOT_DONE_MARKER

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

TIGHT_ITEM_CLASS

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

LOOSE_ITEM_CLASS

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

PARAGRAPH_CLASS

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

ITEM_DONE_CLASS

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

ITEM_NOT_DONE_CLASS

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

FORMAT_LIST_ITEM_CASE

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

FORMAT_LIST_ITEM_PLACEMENT

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

FORMAT_ORDERED_TASK_ITEM_PRIORITY

public static final com.vladsch.flexmark.util.data.DataKey<Integer> FORMAT_ORDERED_TASK_ITEM_PRIORITY

FORMAT_DEFAULT_TASK_ITEM_PRIORITY

public static final com.vladsch.flexmark.util.data.DataKey<Integer> FORMAT_DEFAULT_TASK_ITEM_PRIORITY

FORMAT_PRIORITIZED_TASK_ITEMS

public static final com.vladsch.flexmark.util.data.DataKey<Boolean> FORMAT_PRIORITIZED_TASK_ITEMS

FORMAT_TASK_ITEM_PRIORITIES

public static final com.vladsch.flexmark.util.data.DataKey<Map<Character,Integer>> FORMAT_TASK_ITEM_PRIORITIES

Priorities corresponding to Parser.LISTS_ITEM_PREFIX_CHARS If shorter than item prefix chars then any missing priorities are set to 0

Method Detail

create

public static TaskListExtension create()

extend

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

Specified by:

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

rendererOptions

public void rendererOptions(@NotNull
                            @NotNull com.vladsch.flexmark.util.data.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.data.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(@NotNull
                   com.vladsch.flexmark.html.HtmlRenderer.Builder htmlRendererBuilder,
                   @NotNull
                   @NotNull String rendererType)

Specified by:

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