java.lang.Object
- com.vladsch.flexmark.ext.toc.SimTocExtension

All Implemented Interfaces:

Formatter.FormatterExtension, HtmlRenderer.HtmlRendererExtension, Parser.ParserExtension, Extension
```
public class SimTocExtension
extends java.lang.Object
implements Parser.ParserExtension, HtmlRenderer.HtmlRendererExtension, Formatter.FormatterExtension
```
Extension for tocs
Create it with create() and then configure it on the builders
The parsed [TOC] text is turned into SimTocBlock nodes. Rendered into table of contents based on the headings in the document

Field Summary

Fields
Modifier and Type	Field	Description
`static DataKey<java.lang.Boolean>`	`AST_INCLUDE_OPTIONS`
`static DataKey<java.lang.Boolean>`	`BLANK_LINE_SPACER`
`static DataKey<java.lang.Boolean>`	`CASE_SENSITIVE_TOC_TAG`
`static DataKey<java.lang.String>`	`DIV_CLASS`
`static DataKey<TocOptions>`	`FORMAT_OPTIONS`
`static DataKey<SimTocGenerateOnFormat>`	`FORMAT_UPDATE_ON_FORMAT`
`static DataKey<java.lang.Boolean>`	`IS_HTML`
`static DataKey<java.lang.Boolean>`	`IS_NUMBERED`
`static DataKey<java.lang.Boolean>`	`IS_TEXT_ONLY`
`static DataKey<java.lang.Integer>`	`LEVELS`
`static DataKey<java.lang.String>`	`LIST_CLASS`
`static DataKey<TocOptions.ListType>`	`LIST_TYPE`
`static NullableDataKey<java.lang.String>`	`TITLE`
`static DataKey<java.lang.Integer>`	`TITLE_LEVEL`
`static AttributablePart`	`TOC_CONTENT`
`static AttributablePart`	`TOC_LIST`

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

Constructor Summary

Constructors
Modifier Constructor Description

private SimTocExtension()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static SimTocExtension`	`create()`
`void`	`extend(Formatter.Builder formatterBuilder)`
`void`	`extend(HtmlRenderer.Builder htmlRendererBuilder, @NotNull java.lang.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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TOC_CONTENT
```
public static final AttributablePart TOC_CONTENT
```
  - TOC_LIST
```
public static final AttributablePart TOC_LIST
```
  - LEVELS
```
public static final DataKey<java.lang.Integer> LEVELS
```
  - IS_TEXT_ONLY
```
public static final DataKey<java.lang.Boolean> IS_TEXT_ONLY
```
  - IS_NUMBERED
```
public static final DataKey<java.lang.Boolean> IS_NUMBERED
```
  - LIST_TYPE
```
public static final DataKey<TocOptions.ListType> LIST_TYPE
```
  - IS_HTML
```
public static final DataKey<java.lang.Boolean> IS_HTML
```
  - TITLE_LEVEL
```
public static final DataKey<java.lang.Integer> TITLE_LEVEL
```
  - TITLE
```
public static final NullableDataKey<java.lang.String> TITLE
```
  - AST_INCLUDE_OPTIONS
```
public static final DataKey<java.lang.Boolean> AST_INCLUDE_OPTIONS
```
  - BLANK_LINE_SPACER
```
public static final DataKey<java.lang.Boolean> BLANK_LINE_SPACER
```
  - DIV_CLASS
```
public static final DataKey<java.lang.String> DIV_CLASS
```
  - LIST_CLASS
```
public static final DataKey<java.lang.String> LIST_CLASS
```
  - CASE_SENSITIVE_TOC_TAG
```
public static final DataKey<java.lang.Boolean> CASE_SENSITIVE_TOC_TAG
```
  - FORMAT_UPDATE_ON_FORMAT
```
public static final DataKey<SimTocGenerateOnFormat> FORMAT_UPDATE_ON_FORMAT
```
  - FORMAT_OPTIONS
```
public static final DataKey<TocOptions> FORMAT_OPTIONS
```
- Constructor Detail
  - SimTocExtension
```
private SimTocExtension()
```
- Method Detail
  - create
```
public static SimTocExtension create()
```
  - 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(Formatter.Builder formatterBuilder)
```
    Specified by:
    
    extend in interface Formatter.FormatterExtension
  - 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 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 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)

Class SimTocExtension

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TOC_CONTENT

TOC_LIST

LEVELS

IS_TEXT_ONLY

IS_NUMBERED

LIST_TYPE

IS_HTML

TITLE_LEVEL

TITLE

AST_INCLUDE_OPTIONS

BLANK_LINE_SPACER

DIV_CLASS

LIST_CLASS

CASE_SENSITIVE_TOC_TAG

FORMAT_UPDATE_ON_FORMAT

FORMAT_OPTIONS

Constructor Detail

SimTocExtension

Method Detail

create

rendererOptions

parserOptions

extend

extend

extend