com.vladsch.flexmark.ext.toc

Class TocExtension

java.lang.Object

com.vladsch.flexmark.ext.toc.TocExtension

All Implemented Interfaces:

Extension, HtmlRenderer.HtmlRendererExtension, Parser.ParserExtension

public class TocExtension
extends Object
implements Parser.ParserExtension, HtmlRenderer.HtmlRendererExtension

Extension for tocs

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

The parsed [TOC] text is turned into TocBlock nodes. Rendered into table of contents based on the headings in the document

Field Summary

Fields

Modifier and Type	Field and Description
static DataKey<Boolean>	AST_INCLUDE_OPTIONS
static DataKey<Boolean>	BLANK_LINE_SPACER
static DataKey<TocOptions>	FORMAT_OPTIONS
static DataKey<SimTocGenerateOnFormat>	FORMAT_UPDATE_ON_FORMAT
static DataKey<Boolean>	IS_HTML
static DataKey<Boolean>	IS_NUMBERED
static DataKey<Boolean>	IS_TEXT_ONLY
static DataKey<Integer>	LEVELS
static DataKey<TocOptions.ListType>	LIST_TYPE
static DataKey<String>	TITLE
static DataKey<Integer>	TITLE_LEVEL

Fields inherited from interface com.vladsch.flexmark.Extension

EMPTY_LIST, EMPTY_SET

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

LEVELS

public static final DataKey<Integer> LEVELS

IS_TEXT_ONLY

public static final DataKey<Boolean> IS_TEXT_ONLY

IS_NUMBERED

public static final DataKey<Boolean> IS_NUMBERED

LIST_TYPE

public static final DataKey<TocOptions.ListType> LIST_TYPE

IS_HTML

public static final DataKey<Boolean> IS_HTML

TITLE_LEVEL

public static final DataKey<Integer> TITLE_LEVEL

TITLE

public static final DataKey<String> TITLE

AST_INCLUDE_OPTIONS

public static final DataKey<Boolean> AST_INCLUDE_OPTIONS

BLANK_LINE_SPACER

public static final DataKey<Boolean> BLANK_LINE_SPACER

FORMAT_UPDATE_ON_FORMAT

public static final DataKey<SimTocGenerateOnFormat> FORMAT_UPDATE_ON_FORMAT

FORMAT_OPTIONS

public static final DataKey<TocOptions> FORMAT_OPTIONS

Method Detail

create

public static Extension create()

rendererOptions

public void rendererOptions(MutableDataHolder options)

Specified by:

rendererOptions in interface HtmlRenderer.HtmlRendererExtension

parserOptions

public void parserOptions(MutableDataHolder options)

Specified by:

parserOptions in interface Parser.ParserExtension

extend

public void extend(Parser.Builder parserBuilder)

Specified by:

extend in interface Parser.ParserExtension

extend

public void extend(HtmlRenderer.Builder rendererBuilder,
                   String rendererType)

Specified by:

extend in interface HtmlRenderer.HtmlRendererExtension