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 java.lang.Object implements Parser.ParserExtension, HtmlRenderer.HtmlRendererExtension, Formatter.FormatterExtension
Extension for GFM style task list itemsCreate it with
create()
and then configure it on the buildersThe bullet list items that begin with [ ], [x] or [X] are turned into TaskListItem nodes
-
-
Field Summary
Fields Modifier and Type Field Description static java.util.Map<java.lang.Character,java.lang.Integer>
DEFAULT_PRIORITIES
static DataKey<java.lang.Integer>
FORMAT_DEFAULT_TASK_ITEM_PRIORITY
static DataKey<TaskListItemCase>
FORMAT_LIST_ITEM_CASE
static DataKey<TaskListItemPlacement>
FORMAT_LIST_ITEM_PLACEMENT
static DataKey<java.lang.Integer>
FORMAT_ORDERED_TASK_ITEM_PRIORITY
static DataKey<java.lang.Boolean>
FORMAT_PRIORITIZED_TASK_ITEMS
static DataKey<java.util.Map<java.lang.Character,java.lang.Integer>>
FORMAT_TASK_ITEM_PRIORITIES
Priorities corresponding toParser.LISTS_ITEM_PREFIX_CHARS
If shorter than item prefix chars then any missing priorities are set to 0static DataKey<java.lang.String>
ITEM_DONE_CLASS
static DataKey<java.lang.String>
ITEM_DONE_MARKER
static DataKey<java.lang.String>
ITEM_NOT_DONE_CLASS
static DataKey<java.lang.String>
ITEM_NOT_DONE_MARKER
static DataKey<java.lang.String>
LOOSE_ITEM_CLASS
static DataKey<java.lang.String>
PARAGRAPH_CLASS
static DataKey<java.lang.String>
TIGHT_ITEM_CLASS
-
Fields inherited from interface com.vladsch.flexmark.util.misc.Extension
EMPTY_LIST
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static TaskListExtension
create()
void
extend(Formatter.Builder formatterBuilder)
void
extend(HtmlRenderer.Builder htmlRendererBuilder, java.lang.String rendererType)
Called to give each extension to register extension points that it containsvoid
extend(Parser.Builder parserBuilder)
This method is called on all extensions so that they can register their custom processorsvoid
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(MutableDataHolder options)
This method is called first on all extensions so that they can adjust the options that must be common to all extensions.
-
-
-
Field Detail
-
DEFAULT_PRIORITIES
public static final java.util.Map<java.lang.Character,java.lang.Integer> DEFAULT_PRIORITIES
-
ITEM_DONE_MARKER
public static final DataKey<java.lang.String> ITEM_DONE_MARKER
-
ITEM_NOT_DONE_MARKER
public static final DataKey<java.lang.String> ITEM_NOT_DONE_MARKER
-
TIGHT_ITEM_CLASS
public static final DataKey<java.lang.String> TIGHT_ITEM_CLASS
-
LOOSE_ITEM_CLASS
public static final DataKey<java.lang.String> LOOSE_ITEM_CLASS
-
PARAGRAPH_CLASS
public static final DataKey<java.lang.String> PARAGRAPH_CLASS
-
ITEM_DONE_CLASS
public static final DataKey<java.lang.String> ITEM_DONE_CLASS
-
ITEM_NOT_DONE_CLASS
public static final DataKey<java.lang.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<java.lang.Integer> FORMAT_ORDERED_TASK_ITEM_PRIORITY
-
FORMAT_DEFAULT_TASK_ITEM_PRIORITY
public static final DataKey<java.lang.Integer> FORMAT_DEFAULT_TASK_ITEM_PRIORITY
-
FORMAT_PRIORITIZED_TASK_ITEMS
public static final DataKey<java.lang.Boolean> FORMAT_PRIORITIZED_TASK_ITEMS
-
FORMAT_TASK_ITEM_PRIORITIES
public static final DataKey<java.util.Map<java.lang.Character,java.lang.Integer>> FORMAT_TASK_ITEM_PRIORITIES
Priorities corresponding toParser.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(Formatter.Builder formatterBuilder)
- Specified by:
extend
in interfaceFormatter.FormatterExtension
-
rendererOptions
public void rendererOptions(@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 interfaceFormatter.FormatterExtension
- Specified by:
rendererOptions
in interfaceHtmlRenderer.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 interfaceParser.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 interfaceParser.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 java.lang.String rendererType)
Description copied from interface:HtmlRenderer.HtmlRendererExtension
Called to give each extension to register extension points that it contains- Specified by:
extend
in interfaceHtmlRenderer.HtmlRendererExtension
- Parameters:
htmlRendererBuilder
- builder to call back for extension point registrationrendererType
- 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)
-
-