com.vladsch.flexmark.ext.toc

Class TocExtension

java.lang.Object

com.vladsch.flexmark.ext.toc.TocExtension

All Implemented Interfaces:

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

public class TocExtension
extends Object
implements com.vladsch.flexmark.parser.Parser.ParserExtension, com.vladsch.flexmark.html.HtmlRenderer.HtmlRendererExtension

Extension for tocs

Create it with create() and then configure it on the builders

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 com.vladsch.flexmark.util.data.DataKey<Boolean>	AST_INCLUDE_OPTIONS
static com.vladsch.flexmark.util.data.DataKey<Boolean>	BLANK_LINE_SPACER
static com.vladsch.flexmark.util.data.DataKey<Boolean>	CASE_SENSITIVE_TOC_TAG
static com.vladsch.flexmark.util.data.DataKey<String>	DIV_CLASS
static com.vladsch.flexmark.util.data.DataKey<TocOptions>	FORMAT_OPTIONS
static com.vladsch.flexmark.util.data.DataKey<SimTocGenerateOnFormat>	FORMAT_UPDATE_ON_FORMAT
static com.vladsch.flexmark.util.data.DataKey<Boolean>	IS_HTML
static com.vladsch.flexmark.util.data.DataKey<Boolean>	IS_NUMBERED
static com.vladsch.flexmark.util.data.DataKey<Boolean>	IS_TEXT_ONLY
static com.vladsch.flexmark.util.data.DataKey<Integer>	LEVELS
static com.vladsch.flexmark.util.data.DataKey<String>	LIST_CLASS
static com.vladsch.flexmark.util.data.DataKey<TocOptions.ListType>	LIST_TYPE
static com.vladsch.flexmark.util.data.NullableDataKey<String>	TITLE
static com.vladsch.flexmark.util.data.DataKey<Integer>	TITLE_LEVEL
static com.vladsch.flexmark.html.renderer.AttributablePart	TOC_CONTENT
static com.vladsch.flexmark.html.renderer.AttributablePart	TOC_LIST

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

EMPTY_LIST

Method Summary

Modifier and Type	Method and Description
static TocExtension	create()
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

TOC_CONTENT

public static final com.vladsch.flexmark.html.renderer.AttributablePart TOC_CONTENT

TOC_LIST

public static final com.vladsch.flexmark.html.renderer.AttributablePart TOC_LIST

LEVELS

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

IS_TEXT_ONLY

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

IS_NUMBERED

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

LIST_TYPE

public static final com.vladsch.flexmark.util.data.DataKey<TocOptions.ListType> LIST_TYPE

IS_HTML

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

TITLE_LEVEL

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

TITLE

public static final com.vladsch.flexmark.util.data.NullableDataKey<String> TITLE

AST_INCLUDE_OPTIONS

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

BLANK_LINE_SPACER

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

DIV_CLASS

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

LIST_CLASS

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

CASE_SENSITIVE_TOC_TAG

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

FORMAT_UPDATE_ON_FORMAT

public static final com.vladsch.flexmark.util.data.DataKey<SimTocGenerateOnFormat> FORMAT_UPDATE_ON_FORMAT

FORMAT_OPTIONS

public static final com.vladsch.flexmark.util.data.DataKey<TocOptions> FORMAT_OPTIONS

Method Detail

create

public static TocExtension create()

rendererOptions

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

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