flexmark-all 0.64.8 · com.vladsch.flexmark.html.renderer.NodeRendererContext

Method Summary

Modifier and Type	Method and Description
public void	delegateRender() pass node rendering to previously registered handler
public void	doNotRenderLinks(boolean if true then increment the doNotRenderLinks value, else decrement it doNotRenderLinks) Increment/Decrement the do not render links in this context.
public void	doNotRenderLinks() Increment the do not render links in this context.
public void	doRenderLinks() Decrement the do not render links in this context.
public @NotNull MutableAttributes	Returns: the extended attributes with added/updated/removed entries extendRenderingNodeAttributes(@NotNull AttributablePart the tag of the node being rendered, some nodes render multiple tags with attributes part, @Nullable Attributes the attributes that were calculated by the renderer or null, these may be modified. To preserve originals pass a copy. attributes) Extend the attributes by extensions for the node being currently rendered.
public @NotNull MutableAttributes	Returns: the extended attributes with added/updated/removed entries extendRenderingNodeAttributes(@NotNull Node node for which to get attributes node, @NotNull AttributablePart the tag of the node being rendered, some nodes render multiple tags with attributes part, @Nullable Attributes the attributes that were calculated by the renderer or null, these may be modified. To preserve originals pass a copy. attributes) Extend the attributes by extensions for the node being currently rendered.
public @NotNull NodeRendererContext	Returns: a new rendering context with a given appendable for its output getDelegatedSubContext(boolean whether the html writer of the sub-context should inherit the current context's indentation level or start with 0 indentation inheritIndent) Creates a child rendering context that can be used to collect rendered html text of the previously registered node renderer.
public @NotNull HtmlRendererOptions	Returns: the `HtmlRendererOptions` for the context. getHtmlOptions()
public @NotNull HtmlWriter	Returns: the HTML writer to use getHtmlWriter()
public @Nullable String	Returns: id string or null getNodeId(@NotNull Node node for which to get an id, depends on the `HtmlIdGenerator` assigned for the context. Default generator only creates ids for `com.vladsch.flexmark.ast.Heading` nodes or custom nodes that implement `com.vladsch.flexmark.ast.AnchorRefTarget` interface. node) Get the id attribute for the given node.
public @NotNull RenderingPhase	Returns: current rendering phase getRenderingPhase()
public @NotNull NodeRendererContext	Returns: a new rendering context with a given appendable for its output getSubContext(boolean whether the html writer of the sub-context should inherit the current context's indentation level or start with 0 indentation inheritIndent) Creates a child rendering context that can be used to collect rendered html text.
public boolean	Returns: true if links should be output as only text. isDoNotRenderLinks() Whether the current rendering context has link rendering disabled.

Inherited from com.vladsch.flexmark.html.renderer.LinkResolverContext:: encodeUrl getCurrentNode getDocument getOptions render renderChildren resolveLink resolveLink

Method Detail

delegateRender	back to summary
public void delegateRender() pass node rendering to previously registered handler

doNotRenderLinks back to summary

doNotRenderLinks	back to summary
public 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:boolean if true then increment the doNotRenderLinks value, else decrement it See Also `isDoNotRenderLinks()`, `doNotRenderLinks()`, `doRenderLinks()`, `doNotRenderLinks(boolean)`

public 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:boolean: if true then increment the doNotRenderLinks value, else decrement it

doNotRenderLinks back to summary

doNotRenderLinks	back to summary
public 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)`

public 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 back to summary

doRenderLinks	back to summary
public 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. Exceptions IllegalStateException: if the current doNotRender links value is 0. See Also `isDoNotRenderLinks()`, `doNotRenderLinks()`, `doRenderLinks()`, `doNotRenderLinks(boolean)`

public 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.

Exceptions

IllegalStateException:: if the current doNotRender links value is 0.

extendRenderingNodeAttributes	back to summary
public @NotNull MutableAttributes extendRenderingNodeAttributes(@NotNull AttributablePart part, @Nullable Attributes attributes) Extend the attributes by extensions for the node being currently rendered. Parameters part:@NotNull AttributablePart the tag of the node being rendered, some nodes render multiple tags with attributes attributes:@Nullable Attributes the attributes that were calculated by the renderer or null, these may be modified. To preserve originals pass a copy. Returns:@NotNull MutableAttributes the extended attributes with added/updated/removed entries Annotations @NotNull

extendRenderingNodeAttributes

back to summary

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

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

Parameters

part:@NotNull AttributablePart: the tag of the node being rendered, some nodes render multiple tags with attributes
attributes:@Nullable Attributes: the attributes that were calculated by the renderer or null, these may be modified. To preserve originals pass a copy.

Returns:@NotNull MutableAttributes

the extended attributes with added/updated/removed entries

Annotations

@NotNull

extendRenderingNodeAttributes	back to summary
public @NotNull MutableAttributes extendRenderingNodeAttributes(@NotNull Node node, @NotNull AttributablePart part, @Nullable Attributes attributes) Extend the attributes by extensions for the node being currently rendered. Parameters node:@NotNull Node node for which to get attributes part:@NotNull AttributablePart the tag of the node being rendered, some nodes render multiple tags with attributes attributes:@Nullable Attributes the attributes that were calculated by the renderer or null, these may be modified. To preserve originals pass a copy. Returns:@NotNull MutableAttributes the extended attributes with added/updated/removed entries Annotations @NotNull

extendRenderingNodeAttributes

back to summary

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

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

Parameters

node:@NotNull Node: node for which to get attributes
part:@NotNull AttributablePart: the tag of the node being rendered, some nodes render multiple tags with attributes
attributes:@Nullable Attributes: the attributes that were calculated by the renderer or null, these may be modified. To preserve originals pass a copy.

Returns:@NotNull MutableAttributes

the extended attributes with added/updated/removed entries

Annotations

@NotNull

getDelegatedSubContext	back to summary
public @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:boolean whether the html writer of the sub-context should inherit the current context's indentation level or start with 0 indentation Returns:@NotNull NodeRendererContext a new rendering context with a given appendable for its output Annotations @NotNull

getDelegatedSubContext

back to summary

public @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:boolean: whether the html writer of the sub-context should inherit the current context's indentation level or start with 0 indentation

Returns:@NotNull NodeRendererContext

a new rendering context with a given appendable for its output

Annotations

@NotNull

getHtmlOptions	back to summary
public @NotNull HtmlRendererOptions getHtmlOptions() Returns:@NotNull HtmlRendererOptions the `HtmlRendererOptions` for the context. Annotations @NotNull

getHtmlWriter	back to summary
public @NotNull HtmlWriter getHtmlWriter() Returns:@NotNull HtmlWriter the HTML writer to use Annotations @NotNull

getNodeId back to summary

getNodeId	back to summary
public @Nullable String getNodeId(@NotNull Node node) Get the id attribute for the given node. Parameters node:@NotNull Node node for which to get an id, depends on the `HtmlIdGenerator` assigned for the context. Default generator only creates ids for `com.vladsch.flexmark.ast.Heading` nodes or custom nodes that implement `com.vladsch.flexmark.ast.AnchorRefTarget` interface. Returns:@Nullable String id string or null Annotations @Nullable

public @Nullable String getNodeId(@NotNull Node node)

Get the id attribute for the given node.

Parameters

node:@NotNull Node: node for which to get an id, depends on the HtmlIdGenerator assigned for the context. Default generator only creates ids for com.vladsch.flexmark.ast.Heading nodes or custom nodes that implement com.vladsch.flexmark.ast.AnchorRefTarget interface.

Returns:@Nullable String

id string or null

Annotations

@Nullable

getRenderingPhase	back to summary
public @NotNull RenderingPhase getRenderingPhase() Returns:@NotNull RenderingPhase current rendering phase Annotations @NotNull

getSubContext	back to summary
public @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:boolean whether the html writer of the sub-context should inherit the current context's indentation level or start with 0 indentation Returns:@NotNull NodeRendererContext a new rendering context with a given appendable for its output Annotations @NotNull

getSubContext

back to summary

public @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:boolean: whether the html writer of the sub-context should inherit the current context's indentation level or start with 0 indentation

Returns:@NotNull NodeRendererContext

a new rendering context with a given appendable for its output

Annotations

@NotNull

isDoNotRenderLinks back to summary

isDoNotRenderLinks	back to summary
public 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:boolean true if links should be output as only text. See Also `isDoNotRenderLinks()`, `doNotRenderLinks()`, `doRenderLinks()`, `doNotRenderLinks(boolean)`

public 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:boolean: true if links should be output as only text.
See Also: isDoNotRenderLinks(), doNotRenderLinks(), doRenderLinks(), doNotRenderLinks(boolean)

public Interface NodeRendererContext

Method Summary

Method Detail