Package com.vladsch.flexmark.html

Class HtmlRenderer.MainNodeRenderer.SubNodeRenderer

java.lang.Object

com.vladsch.flexmark.html.NodeRendererSubContext

com.vladsch.flexmark.html.HtmlRenderer.MainNodeRenderer.SubNodeRenderer

All Implemented Interfaces:

LinkResolverBasicContext, LinkResolverContext, NodeRendererContext

Enclosing class:

HtmlRenderer.MainNodeRenderer

private class HtmlRenderer.MainNodeRenderer.SubNodeRenderer
extends NodeRendererSubContext
implements NodeRendererContext

Field Summary

Fields

Modifier and Type	Field	Description
private HtmlRenderer.MainNodeRenderer	myMainNodeRenderer

Fields inherited from class com.vladsch.flexmark.html.NodeRendererSubContext

doNotRenderLinksNesting, htmlWriter, renderingHandlerWrapper, renderingNode

Constructor Summary

Constructors

Constructor	Description
SubNodeRenderer(HtmlRenderer.MainNodeRenderer mainNodeRenderer, HtmlWriter htmlWriter, boolean inheritCurrentHandler)

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 java.lang.String	encodeUrl(@NotNull java.lang.CharSequence url)
@NotNull MutableAttributes	extendRenderingNodeAttributes(@NotNull AttributablePart part, Attributes attributes)	Extend the attributes by extensions for the node being currently rendered.
@NotNull MutableAttributes	extendRenderingNodeAttributes(@NotNull Node node, @NotNull AttributablePart part, Attributes attributes)	Extend the attributes by extensions for the node being currently rendered.
@NotNull Node	getCurrentNode()
@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 Document	getDocument()
protected int	getDoNotRenderLinksNesting()
@NotNull HtmlRendererOptions	getHtmlOptions()
@NotNull HtmlWriter	getHtmlWriter()
java.lang.String	getNodeId(@NotNull Node node)	Get the id attribute for the given node.
@NotNull DataHolder	getOptions()	Get the current rendering context DataHolder.
@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.
void	render(@NotNull Node node)	Render the specified node and its children using the configured renderers.
void	renderChildren(@NotNull Node parent)	Render the children of the node, used by custom renderers
@NotNull ResolvedLink	resolveLink(@NotNull LinkType linkType, @NotNull java.lang.CharSequence url, Attributes attributes, java.lang.Boolean urlEncode)	Resolve link for rendering.
@NotNull ResolvedLink	resolveLink(@NotNull LinkType linkType, @NotNull java.lang.CharSequence url, java.lang.Boolean urlEncode)	Resolve link for rendering.

Methods inherited from class com.vladsch.flexmark.html.NodeRendererSubContext

flushTo, flushTo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

myMainNodeRenderer

private final HtmlRenderer.MainNodeRenderer myMainNodeRenderer

Constructor Detail

SubNodeRenderer

public SubNodeRenderer(HtmlRenderer.MainNodeRenderer mainNodeRenderer,
                       HtmlWriter htmlWriter,
                       boolean inheritCurrentHandler)

Method Detail

getNodeId

public java.lang.String getNodeId(@NotNull
                                  @NotNull Node node)

Description copied from interface: NodeRendererContext

Get the id attribute for the given node.

Specified by:

getNodeId in interface NodeRendererContext

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

getOptions

@NotNull
public @NotNull DataHolder getOptions()

Description copied from interface: LinkResolverContext

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

Specified by:

getOptions in interface LinkResolverBasicContext

Specified by:

getOptions in interface LinkResolverContext

Returns:

the current renderer options DataHolder

getHtmlOptions

@NotNull
public @NotNull HtmlRendererOptions getHtmlOptions()

Specified by:

getHtmlOptions in interface NodeRendererContext

Returns:

the HtmlRendererOptions for the context.

getDocument

@NotNull
public @NotNull Document getDocument()

Specified by:

getDocument in interface LinkResolverBasicContext

Specified by:

getDocument in interface LinkResolverContext

Returns:

the Document node of the current context

getRenderingPhase

@NotNull
public @NotNull RenderingPhase getRenderingPhase()

Specified by:

getRenderingPhase in interface NodeRendererContext

Returns:

current rendering phase

encodeUrl

@NotNull
public @NotNull java.lang.String encodeUrl(@NotNull
                                           @NotNull java.lang.CharSequence url)

Specified by:

encodeUrl in interface LinkResolverContext

Parameters:

url - to be encoded

Returns:

an encoded URL (depending on the configuration)

extendRenderingNodeAttributes

@NotNull
public @NotNull MutableAttributes extendRenderingNodeAttributes(@NotNull
                                                                @NotNull AttributablePart part,
                                                                Attributes attributes)

Description copied from interface: NodeRendererContext

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

Specified by:

extendRenderingNodeAttributes in interface NodeRendererContext

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
public @NotNull MutableAttributes extendRenderingNodeAttributes(@NotNull
                                                                @NotNull Node node,
                                                                @NotNull
                                                                @NotNull AttributablePart part,
                                                                Attributes attributes)

Description copied from interface: NodeRendererContext

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

Specified by:

extendRenderingNodeAttributes in interface NodeRendererContext

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

render

public void render(@NotNull
                   @NotNull Node node)

Description copied from interface: LinkResolverContext

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.

Specified by:

render in interface LinkResolverContext

Parameters:

node - the node to render

delegateRender

public void delegateRender()

Description copied from interface: NodeRendererContext

pass node rendering to previously registered handler

Specified by:

delegateRender in interface NodeRendererContext

getCurrentNode

@NotNull
public @NotNull Node getCurrentNode()

Specified by:

getCurrentNode in interface LinkResolverContext

Returns:

the current node being rendered

resolveLink

@NotNull
public @NotNull ResolvedLink resolveLink(@NotNull
                                         @NotNull LinkType linkType,
                                         @NotNull
                                         @NotNull java.lang.CharSequence url,
                                         java.lang.Boolean urlEncode)

Description copied from interface: LinkResolverContext

Resolve link for rendering. Link Resolvers are going to be called until one returns ResolvedLink with getStatus() != LinkStatus.Unknown

A resolver can replace the url but not change the status letting downstream resolvers handle the rest. This is useful when a resolver does partial processing like macro expansion but does not know how to handle the rest.

Core processing will simply pass the link as is. It is up to extension LinkResolvers and AttributeProviders to make sense of the link and applicable attributes based on status.

Specified by:

resolveLink in interface LinkResolverContext

Parameters:

linkType - type of link being rendered. Core defined links are Link, Image. Extensions can define their own

url - link url text

urlEncode - whether the link should be url encoded, if null then the value of HtmlRenderer.PERCENT_ENCODE_URLS will be used to determine whether the resolved URL is to be encoded.

Returns:

resolved link url for this link and its resolved status

resolveLink

@NotNull
public @NotNull ResolvedLink resolveLink(@NotNull
                                         @NotNull LinkType linkType,
                                         @NotNull
                                         @NotNull java.lang.CharSequence url,
                                         Attributes attributes,
                                         java.lang.Boolean urlEncode)

Description copied from interface: LinkResolverContext

Resolve link for rendering. Link Resolvers are going to be called until one returns ResolvedLink with getStatus() != LinkStatus.Unknown

A resolver can replace the url but not change the status letting downstream resolvers handle the rest. This is useful when a resolver does partial processing like macro expansion but does not know how to handle the rest.

Core processing will simply pass the link as is. It is up to extension LinkResolvers and AttributeProviders to make sense of the link and applicable attributes based on status.

Specified by:

resolveLink in interface LinkResolverContext

Parameters:

linkType - type of link being rendered. Core defined links are Link, Image. Extensions can define their own

url - link url text

attributes - link attributes

urlEncode - whether the link should be url encoded, if null then the value of HtmlRenderer.PERCENT_ENCODE_URLS will be used to determine whether the resolved URL is to be encoded.

Returns:

resolved link url for this link and its resolved status

getSubContext

@NotNull
public @NotNull NodeRendererContext getSubContext(boolean inheritIndent)

Description copied from interface: NodeRendererContext

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.

Specified by:

getSubContext in interface NodeRendererContext

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
public @NotNull NodeRendererContext getDelegatedSubContext(boolean inheritIndent)

Description copied from interface: NodeRendererContext

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.

Specified by:

getDelegatedSubContext in interface NodeRendererContext

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

renderChildren

public void renderChildren(@NotNull
                           @NotNull Node parent)

Description copied from interface: LinkResolverContext

Render the children of the node, used by custom renderers

Specified by:

renderChildren in interface LinkResolverContext

Parameters:

parent - node the children of which are to be rendered

getHtmlWriter

@NotNull
public @NotNull HtmlWriter getHtmlWriter()

Specified by:

getHtmlWriter in interface NodeRendererContext

Overrides:

getHtmlWriter in class NodeRendererSubContext

Returns:

the HTML writer to use

getDoNotRenderLinksNesting

protected int getDoNotRenderLinksNesting()

Overrides:

getDoNotRenderLinksNesting in class NodeRendererSubContext

isDoNotRenderLinks

public boolean isDoNotRenderLinks()

Description copied from interface: NodeRendererContext

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.

Specified by:

isDoNotRenderLinks in interface NodeRendererContext

Overrides:

isDoNotRenderLinks in class NodeRendererSubContext

Returns:

true if links should be output as only text.

See Also:

NodeRendererContext.isDoNotRenderLinks(), NodeRendererContext.doNotRenderLinks(), NodeRendererContext.doRenderLinks(), NodeRendererContext.doNotRenderLinks(boolean)

doNotRenderLinks

public void doNotRenderLinks(boolean doNotRenderLinks)

Description copied from interface: NodeRendererContext

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.

Specified by:

doNotRenderLinks in interface NodeRendererContext

Overrides:

doNotRenderLinks in class NodeRendererSubContext

Parameters:

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

See Also:

NodeRendererContext.isDoNotRenderLinks(), NodeRendererContext.doNotRenderLinks(), NodeRendererContext.doRenderLinks(), NodeRendererContext.doNotRenderLinks(boolean)

doNotRenderLinks

public void doNotRenderLinks()

Description copied from interface: NodeRendererContext

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.

Specified by:

doNotRenderLinks in interface NodeRendererContext

Overrides:

doNotRenderLinks in class NodeRendererSubContext

See Also:

NodeRendererContext.isDoNotRenderLinks(), NodeRendererContext.doNotRenderLinks(), NodeRendererContext.doRenderLinks(), NodeRendererContext.doNotRenderLinks(boolean)

doRenderLinks

public void doRenderLinks()

Description copied from interface: NodeRendererContext

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.

Specified by:

doRenderLinks in interface NodeRendererContext

Overrides:

doRenderLinks in class NodeRendererSubContext

See Also:

NodeRendererContext.isDoNotRenderLinks(), NodeRendererContext.doNotRenderLinks(), NodeRendererContext.doRenderLinks(), NodeRendererContext.doNotRenderLinks(boolean)