Class TaskListExtension

java.lang.Object

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

All Implemented Interfaces:

Formatter.FormatterExtension, HtmlRenderer.HtmlRendererExtension, Parser.ParserExtension, Extension

public class TaskListExtension
extends Object
implements Parser.ParserExtension, HtmlRenderer.HtmlRendererExtension, 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 final Map<Character, Integer>	DEFAULT_PRIORITIES
static final DataKey<Integer>	FORMAT_DEFAULT_TASK_ITEM_PRIORITY
static final DataKey<TaskListItemCase>	FORMAT_LIST_ITEM_CASE
static final DataKey<TaskListItemPlacement>	FORMAT_LIST_ITEM_PLACEMENT
static final DataKey<Integer>	FORMAT_ORDERED_TASK_ITEM_PRIORITY
static final DataKey<Boolean>	FORMAT_PRIORITIZED_TASK_ITEMS
static final 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 final DataKey<String>	ITEM_DONE_CLASS
static final DataKey<String>	ITEM_DONE_MARKER
static final DataKey<String>	ITEM_NOT_DONE_CLASS
static final DataKey<String>	ITEM_NOT_DONE_MARKER
static final DataKey<String>	LOOSE_ITEM_CLASS
static final DataKey<String>	PARAGRAPH_CLASS
static final DataKey<String>	TIGHT_ITEM_CLASS

Fields inherited from interface Extension

EMPTY_LIST

Constructor Summary

Constructors

Modifier	Constructor	Description
private	TaskListExtension()

Method Summary

Modifier and Type	Method	Description
static TaskListExtension	create()
void	extend(Formatter.Builder formatterBuilder)
void	extend(HtmlRenderer.Builder htmlRendererBuilder, @NotNull String rendererType)	Called to give each extension to register extension points that it contains
void	extend(Parser.Builder parserBuilder)	This method is called on all extensions so that they can register their custom processors
void	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(@NotNull MutableDataHolder options)	This method is called first on all extensions so that they can adjust the options that must be common to all extensions.

Methods inherited from class Object

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

Field Details

DEFAULT_PRIORITIES

public static final Map<Character, Integer> DEFAULT_PRIORITIES

ITEM_DONE_MARKER

public static final DataKey<String> ITEM_DONE_MARKER

ITEM_NOT_DONE_MARKER

public static final DataKey<String> ITEM_NOT_DONE_MARKER

TIGHT_ITEM_CLASS

public static final DataKey<String> TIGHT_ITEM_CLASS

LOOSE_ITEM_CLASS

public static final DataKey<String> LOOSE_ITEM_CLASS

PARAGRAPH_CLASS

public static final DataKey<String> PARAGRAPH_CLASS

ITEM_DONE_CLASS

public static final DataKey<String> ITEM_DONE_CLASS

ITEM_NOT_DONE_CLASS

public static final DataKey<String> ITEM_NOT_DONE_CLASS

FORMAT_LIST_ITEM_CASE

public static final DataKey<TaskListItemCase> FORMAT_LIST_ITEM_CASE

FORMAT_LIST_ITEM_PLACEMENT

public static final DataKey<TaskListItemPlacement> FORMAT_LIST_ITEM_PLACEMENT

FORMAT_ORDERED_TASK_ITEM_PRIORITY

public static final DataKey<Integer> FORMAT_ORDERED_TASK_ITEM_PRIORITY

FORMAT_DEFAULT_TASK_ITEM_PRIORITY

public static final DataKey<Integer> FORMAT_DEFAULT_TASK_ITEM_PRIORITY

FORMAT_PRIORITIZED_TASK_ITEMS

public static final DataKey<Boolean> FORMAT_PRIORITIZED_TASK_ITEMS

FORMAT_TASK_ITEM_PRIORITIES

public static final 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

Constructor Details

TaskListExtension

private TaskListExtension()

Method Details

create

public static TaskListExtension create()

extend

public void extend(Formatter.Builder formatterBuilder)

Specified by:

extend in interface Formatter.FormatterExtension

rendererOptions

public void rendererOptions(@NotNull
 @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 interface Formatter.FormatterExtension

Specified by:

rendererOptions in interface HtmlRenderer.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 interface Parser.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 interface Parser.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
 @NotNull String rendererType)

Description copied from interface: HtmlRenderer.HtmlRendererExtension

Called to give each extension to register extension points that it contains

Specified by:

extend in interface HtmlRenderer.HtmlRendererExtension

Parameters:

htmlRendererBuilder - builder to call back for extension point registration

rendererType - 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)