Class HtmlRenderer.MainNodeRenderer.SubNodeRenderer
- All Implemented Interfaces:
LinkResolverBasicContext
,LinkResolverContext
,NodeRendererContext
- Enclosing class:
- HtmlRenderer.MainNodeRenderer
-
Field Summary
FieldsFields inherited from class com.vladsch.flexmark.html.NodeRendererSubContext
doNotRenderLinksNesting, htmlWriter, renderingHandlerWrapper, renderingNode
-
Constructor Summary
ConstructorsConstructorDescriptionSubNodeRenderer
(HtmlRenderer.MainNodeRenderer mainNodeRenderer, HtmlWriter htmlWriter, boolean inheritCurrentHandler) -
Method Summary
Modifier and TypeMethodDescriptionvoid
pass node rendering to previously registered handlervoid
Increment the do not render links in this context.void
doNotRenderLinks
(boolean doNotRenderLinks) Increment/Decrement the do not render links in this context.void
Decrement the do not render links in this context.@NotNull String
encodeUrl
(@NotNull 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
@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
protected int
@NotNull HtmlRendererOptions
@NotNull HtmlWriter
Get the id attribute for the given node.@NotNull DataHolder
Get the current rendering contextDataHolder
.@NotNull RenderingPhase
@NotNull NodeRendererContext
getSubContext
(boolean inheritIndent) Creates a child rendering context that can be used to collect rendered html text.boolean
Whether the current rendering context has link rendering disabled.void
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 CharSequence url, Attributes attributes, Boolean urlEncode) Resolve link for rendering.@NotNull ResolvedLink
resolveLink
(@NotNull LinkType linkType, @NotNull CharSequence url, Boolean urlEncode) Resolve link for rendering.Methods inherited from class com.vladsch.flexmark.html.NodeRendererSubContext
flushTo, flushTo
-
Field Details
-
myMainNodeRenderer
-
-
Constructor Details
-
SubNodeRenderer
public SubNodeRenderer(HtmlRenderer.MainNodeRenderer mainNodeRenderer, HtmlWriter htmlWriter, boolean inheritCurrentHandler)
-
-
Method Details
-
getNodeId
Description copied from interface:NodeRendererContext
Get the id attribute for the given node.- Specified by:
getNodeId
in interfaceNodeRendererContext
- Parameters:
node
- node for which to get an id, depends on theHtmlIdGenerator
assigned for the context. Default generator only creates ids forHeading
nodes or custom nodes that implementAnchorRefTarget
interface.- Returns:
- id string or null
-
getOptions
Description copied from interface:LinkResolverContext
Get the current rendering contextDataHolder
. These are the options passed or set on theHtmlRenderer.builder()
or passed toHtmlRenderer.builder(DataHolder)
. To get the document options you should useLinkResolverContext.getDocument()
as the data holder.- Specified by:
getOptions
in interfaceLinkResolverBasicContext
- Specified by:
getOptions
in interfaceLinkResolverContext
- Returns:
- the current renderer options
DataHolder
-
getHtmlOptions
- Specified by:
getHtmlOptions
in interfaceNodeRendererContext
- Returns:
- the
HtmlRendererOptions
for the context.
-
getDocument
- Specified by:
getDocument
in interfaceLinkResolverBasicContext
- Specified by:
getDocument
in interfaceLinkResolverContext
- Returns:
- the
Document
node of the current context
-
getRenderingPhase
- Specified by:
getRenderingPhase
in interfaceNodeRendererContext
- Returns:
- current rendering phase
-
encodeUrl
- Specified by:
encodeUrl
in interfaceLinkResolverContext
- 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 interfaceNodeRendererContext
- Parameters:
part
- the tag of the node being rendered, some nodes render multiple tags with attributesattributes
- 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 interfaceNodeRendererContext
- Parameters:
node
- node for which to get attributespart
- the tag of the node being rendered, some nodes render multiple tags with attributesattributes
- 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
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 interfaceLinkResolverContext
- 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 interfaceNodeRendererContext
-
getCurrentNode
- Specified by:
getCurrentNode
in interfaceLinkResolverContext
- Returns:
- the current node being rendered
-
resolveLink
@NotNull public @NotNull ResolvedLink resolveLink(@NotNull @NotNull LinkType linkType, @NotNull @NotNull CharSequence url, 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.UnknownA 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 interfaceLinkResolverContext
- Parameters:
linkType
- type of link being rendered. Core defined links are Link, Image. Extensions can define their ownurl
- link url texturlEncode
- whether the link should be url encoded, if null then the value ofHtmlRenderer.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 CharSequence url, Attributes attributes, 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.UnknownA 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 interfaceLinkResolverContext
- Parameters:
linkType
- type of link being rendered. Core defined links are Link, Image. Extensions can define their ownurl
- link url textattributes
- link attributesurlEncode
- whether the link should be url encoded, if null then the value ofHtmlRenderer.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
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 interfaceNodeRendererContext
- 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
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 interfaceNodeRendererContext
- 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
Description copied from interface:LinkResolverContext
Render the children of the node, used by custom renderers- Specified by:
renderChildren
in interfaceLinkResolverContext
- Parameters:
parent
- node the children of which are to be rendered
-
getHtmlWriter
- Specified by:
getHtmlWriter
in interfaceNodeRendererContext
- Overrides:
getHtmlWriter
in classNodeRendererSubContext
- Returns:
- the HTML writer to use
-
getDoNotRenderLinksNesting
protected int getDoNotRenderLinksNesting()- Overrides:
getDoNotRenderLinksNesting
in classNodeRendererSubContext
-
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 interfaceNodeRendererContext
- Overrides:
isDoNotRenderLinks
in classNodeRendererSubContext
- Returns:
- true if links should be output as only text.
- See Also:
-
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 interfaceNodeRendererContext
- Overrides:
doNotRenderLinks
in classNodeRendererSubContext
- Parameters:
doNotRenderLinks
- if true then increment the doNotRenderLinks value, else decrement it- See Also:
-
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 interfaceNodeRendererContext
- Overrides:
doNotRenderLinks
in classNodeRendererSubContext
- See Also:
-
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 interfaceNodeRendererContext
- Overrides:
doRenderLinks
in classNodeRendererSubContext
- See Also:
-