Package com.vladsch.flexmark.html.renderer

Interface NodeRendererContext

All Superinterfaces:

LinkResolverBasicContext, LinkResolverContext

All Known Implementing Classes:

NodeRendererSubContext

public interface NodeRendererContext
extends LinkResolverContext

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

Method Summary

Modifier and Type	Method	Description
void	delegateRender()	pass node rendering to previously registered handler
void	doNotRenderLinks()	Increment the do not render links in this context.
void	doNotRenderLinks(boolean doNotRenderLinks)	Increment/Decrement the do not render links in this context.
void	doRenderLinks()	Decrement the do not render links in this context.
@NotNull com.vladsch.flexmark.util.html.MutableAttributes	extendRenderingNodeAttributes(@NotNull AttributablePart part, @Nullable com.vladsch.flexmark.util.html.Attributes attributes)	Extend the attributes by extensions for the node being currently rendered.
@NotNull com.vladsch.flexmark.util.html.MutableAttributes	extendRenderingNodeAttributes(@NotNull com.vladsch.flexmark.util.ast.Node node, @NotNull AttributablePart part, @Nullable com.vladsch.flexmark.util.html.Attributes attributes)	Extend the attributes by extensions for the node being currently rendered.
@NotNull NodeRendererContext	getDelegatedSubContext(boolean inheritIndent)	Creates a child rendering context that can be used to collect rendered html text of the previously registered node renderer.
@NotNull HtmlRendererOptions	getHtmlOptions()
@NotNull HtmlWriter	getHtmlWriter()
@Nullable String	getNodeId(@NotNull com.vladsch.flexmark.util.ast.Node node)	Get the id attribute for the given node.
@NotNull RenderingPhase	getRenderingPhase()
@NotNull NodeRendererContext	getSubContext(boolean inheritIndent)	Creates a child rendering context that can be used to collect rendered html text.
boolean	isDoNotRenderLinks()	Whether the current rendering context has link rendering disabled.

Methods inherited from interface com.vladsch.flexmark.html.renderer.LinkResolverContext

encodeUrl, getCurrentNode, getDocument, getOptions, render, renderChildren, resolveLink, resolveLink

Method Detail

extendRenderingNodeAttributes

@NotNull
@NotNull com.vladsch.flexmark.util.html.MutableAttributes extendRenderingNodeAttributes(@NotNull
                                                                                        @NotNull AttributablePart part,
                                                                                        @Nullable
                                                                                        @Nullable com.vladsch.flexmark.util.html.Attributes attributes)

Extend the attributes by extensions for the node being currently rendered.

Parameters:

part - the tag of the node being rendered, some nodes render multiple tags with attributes

attributes - the attributes that were calculated by the renderer or null, these may be modified. To preserve originals pass a copy.

Returns:

the extended attributes with added/updated/removed entries

extendRenderingNodeAttributes

@NotNull
@NotNull com.vladsch.flexmark.util.html.MutableAttributes extendRenderingNodeAttributes(@NotNull
                                                                                        @NotNull com.vladsch.flexmark.util.ast.Node node,
                                                                                        @NotNull
                                                                                        @NotNull AttributablePart part,
                                                                                        @Nullable
                                                                                        @Nullable com.vladsch.flexmark.util.html.Attributes attributes)

Extend the attributes by extensions for the node being currently rendered.

Parameters:

node - node for which to get attributes

part - the tag of the node being rendered, some nodes render multiple tags with attributes

attributes - the attributes that were calculated by the renderer or null, these may be modified. To preserve originals pass a copy.

Returns:

the extended attributes with added/updated/removed entries

getHtmlWriter

@NotNull
@NotNull HtmlWriter getHtmlWriter()

Returns:

the HTML writer to use

getSubContext

@NotNull
@NotNull NodeRendererContext getSubContext(boolean inheritIndent)

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

Parameters:

inheritIndent - whether the html writer of the sub-context should inherit the current context's indentation level or start with 0 indentation

Returns:

a new rendering context with a given appendable for its output

getDelegatedSubContext

@NotNull
@NotNull NodeRendererContext getDelegatedSubContext(boolean inheritIndent)

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

Parameters:

inheritIndent - whether the html writer of the sub-context should inherit the current context's indentation level or start with 0 indentation

Returns:

a new rendering context with a given appendable for its output

delegateRender

void delegateRender()

pass node rendering to previously registered handler

getNodeId

@Nullable
@Nullable String getNodeId(@NotNull
                           @NotNull com.vladsch.flexmark.util.ast.Node node)

Get the id attribute for the given node.

Parameters:

node - node for which to get an id, depends on the HtmlIdGenerator assigned for the context. Default generator only creates ids for Heading nodes or custom nodes that implement AnchorRefTarget interface.

Returns:

id string or null

isDoNotRenderLinks

boolean isDoNotRenderLinks()

Whether the current rendering context has link rendering disabled. When true any renderer that would render a link, should only output the text of that link and image links should not render anything.

Returns:

true if links should be output as only text.

See Also:

isDoNotRenderLinks(), doNotRenderLinks(), doRenderLinks(), doNotRenderLinks(boolean)

doNotRenderLinks

void doNotRenderLinks(boolean doNotRenderLinks)

Increment/Decrement the do not render links in this context. This value will persist for the duration of the current node's render() method and will be restored upon return. Effectively it will persist for the rendering of the children of this node.

Parameters:

doNotRenderLinks - if true then increment the doNotRenderLinks value, else decrement it

See Also:

isDoNotRenderLinks(), doNotRenderLinks(), doRenderLinks(), doNotRenderLinks(boolean)

doNotRenderLinks

void doNotRenderLinks()

Increment the do not render links in this context. This value will persist for the duration of the current node's render() method and will be restored upon return. Effectively it will persist for the rendering of the children of this node.

See Also:

isDoNotRenderLinks(), doNotRenderLinks(), doRenderLinks(), doNotRenderLinks(boolean)

doRenderLinks

void doRenderLinks()

Decrement the do not render links in this context. This value will persist for the duration of the current node's render() method and will be restored upon return. Effectively it will persist for the rendering of the children of this node.

Throws:

IllegalStateException - if the current doNotRender links value is 0.

See Also:

isDoNotRenderLinks(), doNotRenderLinks(), doRenderLinks(), doNotRenderLinks(boolean)

getRenderingPhase

@NotNull
@NotNull RenderingPhase getRenderingPhase()

Returns:

current rendering phase

getHtmlOptions

@NotNull
@NotNull HtmlRendererOptions getHtmlOptions()

Returns:

the HtmlRendererOptions for the context.