com.vladsch.flexmark.formatter

Interface NodeFormatterContext

All Superinterfaces:

TranslationContext

All Known Implementing Classes:

NodeFormatterSubContext

public interface NodeFormatterContext
extends TranslationContext

The context for node rendering, including configuration and functionality for the node renderer to use.

Method Summary

Modifier and Type	Method and Description
com.vladsch.flexmark.util.ast.Node	getCurrentNode()
com.vladsch.flexmark.util.ast.Document	getDocument()
FormatterOptions	getFormatterOptions()
FormattingPhase	getFormattingPhase()
MarkdownWriter	getMarkdown()
com.vladsch.flexmark.util.options.DataHolder	getOptions() Get the current rendering context DataHolder.
NodeFormatterContext	getSubContext(Appendable out) Creates a child rendering context that can be used to collect rendered html text.
Iterable<? extends com.vladsch.flexmark.util.ast.Node>	nodesOfType(Class<?>[] classes) Get iterable of nodes of given types, in order of their appearance in the document tree, depth first traversal.
Iterable<? extends com.vladsch.flexmark.util.ast.Node>	nodesOfType(Collection<Class<?>> classes)
void	render(com.vladsch.flexmark.util.ast.Node node) Render the specified node and its children using the configured renderers.
void	renderChildren(com.vladsch.flexmark.util.ast.Node parent) Render the children of the node, used by custom renderers
Iterable<? extends com.vladsch.flexmark.util.ast.Node>	reversedNodesOfType(Class<?>[] classes) Get iterable of nodes of given types, in reverse order of their appearance in the document tree, depth first traversal.
Iterable<? extends com.vladsch.flexmark.util.ast.Node>	reversedNodesOfType(Collection<Class<?>> classes)

Methods inherited from interface com.vladsch.flexmark.formatter.TranslationContext

customPlaceholderFormat, getRenderPurpose, getTranslationStore, isTransformingText, nonTranslatingSpan, transformAnchorRef, transformNonTranslating, transformTranslating, translatingRefTargetSpan, translatingSpan

Method Detail

getMarkdown

MarkdownWriter getMarkdown()

Returns:

the HTML writer to use

getSubContext

NodeFormatterContext getSubContext(Appendable out)

Creates a child rendering context that can be used to collect rendered html text. The child context inherits everything but the HtmlRenderer and doNotRenderLinksNesting from the parent.

Parameters:

out - appendable to use for generated html

Returns:

a new rendering context with a given appendable for its output

render

void render(com.vladsch.flexmark.util.ast.Node node)

Render the specified node and its children using the configured renderers. This should be used to render child nodes; be careful not to pass the node that is being rendered, that would result in an endless loop.

Parameters:

node - the node to render

renderChildren

void renderChildren(com.vladsch.flexmark.util.ast.Node parent)

Render the children of the node, used by custom renderers

Parameters:

parent - node the children of which are to be rendered

getFormattingPhase

FormattingPhase getFormattingPhase()

Returns:

current rendering phase

getOptions

com.vladsch.flexmark.util.options.DataHolder getOptions()

Get the current rendering context DataHolder. These are the options passed or set on the Formatter.builder() or passed to Formatter.builder(DataHolder). To get the document options you should use getDocument() as the data holder.

Returns:

the current renderer options DataHolder

getFormatterOptions

FormatterOptions getFormatterOptions()

Returns:

the FormatterOptions for the context.

getDocument

com.vladsch.flexmark.util.ast.Document getDocument()

Returns:

the Document node of the current context

getCurrentNode

com.vladsch.flexmark.util.ast.Node getCurrentNode()

Returns:

the current node being rendered

nodesOfType

Iterable<? extends com.vladsch.flexmark.util.ast.Node> nodesOfType(Class<?>[] classes)

Get iterable of nodes of given types, in order of their appearance in the document tree, depth first traversal. Only node classes returned by NodeFormatter.getNodeClasses() of all loaded extensions will be available to formatters.

CoreNodeFormatter registers RefNode if Formatter.REFERENCE_SORT is set to ElementPlacementSort.SORT_UNUSED_LAST so that

Parameters:

classes - node classes to return

Returns:

iterable

nodesOfType

Iterable<? extends com.vladsch.flexmark.util.ast.Node> nodesOfType(Collection<Class<?>> classes)

reversedNodesOfType

Iterable<? extends com.vladsch.flexmark.util.ast.Node> reversedNodesOfType(Class<?>[] classes)

Get iterable of nodes of given types, in reverse order of their appearance in the document tree, depth first traversal. Only node classes returned by NodeFormatter.getNodeClasses() of all loaded extensions will be available to formatters.

CoreNodeFormatter registers RefNode if Formatter.REFERENCE_SORT is set to ElementPlacementSort.SORT_UNUSED_LAST so that

Parameters:

classes - node classes to return

Returns:

iterable

reversedNodesOfType

Iterable<? extends com.vladsch.flexmark.util.ast.Node> reversedNodesOfType(Collection<Class<?>> classes)