Top Inners Fields Constructors Methods
com.vladsch.flexmark.ext.toc.internal

public Class TocNodeRenderer

extends Object
implements NodeRenderer
Class Inheritance
All Implemented Interfaces
com.vladsch.flexmark.html.renderer.NodeRenderer
Imports
com.vladsch.flexmark.ast.Heading, com.vladsch.flexmark.ast.util.HeadingCollectingVisitor, com.vladsch.flexmark.ext.toc.TocBlock, .TocExtension, .TocUtils, com.vladsch.flexmark.html.HtmlWriter, com.vladsch.flexmark.html.renderer.NodeRenderer, .NodeRendererContext, .NodeRendererFactory, .NodeRenderingHandler, com.vladsch.flexmark.util.ast.Node, com.vladsch.flexmark.util.data.DataHolder, com.vladsch.flexmark.util.misc.Paired, com.vladsch.flexmark.util.sequence.BasedSequence, org.jetbrains.annotations.NotNull, java.util.HashSet, .List, .Set, java.util.stream.Collectors

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
TocNodeRenderer.Factory

Field Summary

Modifier and TypeField and Description
private final boolean
haveTitle

private final TocOptions
options

Constructor Summary

AccessConstructor and Description
public
TocNodeRenderer(DataHolder options)

Method Summary

Modifier and TypeMethod and Description
public Set<NodeRenderingHandler<?>>
getNodeRenderingHandlers()

Implements com.vladsch.flexmark.html.renderer.NodeRenderer.getNodeRenderingHandlers.

private void
render(TocBlock node, NodeRendererContext context, HtmlWriter html)

private void
renderTocHeaders(NodeRendererContext context, HtmlWriter html, Node node, List<Heading> headings, TocOptions options)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

haveTitleback to summary
private final boolean haveTitle
optionsback to summary
private final TocOptions options

Constructor Detail

TocNodeRendererback to summary
public TocNodeRenderer(DataHolder options)

Method Detail

getNodeRenderingHandlersback to summary
public Set<NodeRenderingHandler<?>> getNodeRenderingHandlers()

Implements com.vladsch.flexmark.html.renderer.NodeRenderer.getNodeRenderingHandlers.

Returns:Set<NodeRenderingHandler<?>>

Doc from com.vladsch.flexmark.html.renderer.NodeRenderer.getNodeRenderingHandlers.

the mapping of nodes this renderer handles to rendering function

Annotations
@Override
renderback to summary
private void render(TocBlock node, NodeRendererContext context, HtmlWriter html)
renderTocHeadersback to summary
private void renderTocHeaders(NodeRendererContext context, HtmlWriter html, Node node, List<Heading> headings, TocOptions options)
com.vladsch.flexmark.ext.toc.internal back to summary

public Class TocNodeRenderer.Factory

extends Object
implements NodeRendererFactory
Class Inheritance
  • java.lang.Object
  • com.vladsch.flexmark.ext.toc.internal.TocNodeRenderer.Factory
All Implemented Interfaces
com.vladsch.flexmark.html.renderer.NodeRendererFactory, java.util.function.Function

Constructor Summary

AccessConstructor and Description
public
Factory()

Method Summary

Modifier and TypeMethod and Description
public @NotNull NodeRenderer
apply(@NotNull DataHolder
the function argument
options)

Implements java.util.function.Function.apply.

Applies this function to the given argument.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

Factoryback to summary
public Factory()

Method Detail

applyback to summary
public @NotNull NodeRenderer apply(@NotNull DataHolder options)

Implements java.util.function.Function.apply.

Doc from java.util.function.Function.apply.

Applies this function to the given argument.

Parameters
options:@NotNull DataHolder

the function argument

Returns:@NotNull NodeRenderer

the function result

Annotations
@NotNull
@Override