flexmark-all 0.64.8 · com.vladsch.flexmark.formatter.NodeFormatterContext

Method Summary

Modifier and Type	Method and Description
public void	delegateRender() pass node rendering to previously registered handler
public @NotNull BasedSequence	Returns: char sequence of all prefix chars which compact like block quote prefix char getBlockQuoteLikePrefixChars()
public @NotNull CharPredicate	Returns: predicate for prefix chars which compact like block quote prefix char getBlockQuoteLikePrefixPredicate()
public @NotNull Document	Returns: the `Document` node of the current context getDocument() Redeclares com.vladsch.flexmark.html.renderer.LinkResolverContext.getDocument.
public @NotNull FormatterOptions	Returns: the `FormatterOptions` for the context. getFormatterOptions()
public @NotNull FormattingPhase	Returns: current rendering phase getFormattingPhase()
public @NotNull MarkdownWriter	Returns: the HTML writer to use getMarkdown()
public @NotNull DataHolder	Returns: the current renderer options `DataHolder` getOptions() Redeclares com.vladsch.flexmark.util.format.NodeContext.getOptions, com.vladsch.flexmark.html.renderer.LinkResolverContext.getOptions. Get the current rendering context `DataHolder`.
public @NotNull TrackedOffsetList	Returns: tracked offset list getTrackedOffsets()
public @NotNull BasedSequence	Returns: original sequence used for tracked offsets. getTrackedSequence() Note parser can only use a contiguous sequence, not segmented.
public boolean	isRestoreTrackedSpaces()
public @NotNull Iterable<? extends Node>	Returns: iterable nodesOfType(@NotNull Class<?>[] node classes to return classes) Get iterable of nodes of given types, in order of their appearance in the document tree, depth first traversal.
public @NotNull Iterable<? extends Node>	nodesOfType(@NotNull Collection<Class<?>> classes)
public void	render(@NotNull Node the node to render node) Render the specified node and its children using the configured renderers.
public void	renderChildren(@NotNull Node node the children of which are to be rendered parent) Render the children of the node, used by custom renderers
public @NotNull Iterable<? extends Node>	Returns: iterable reversedNodesOfType(@NotNull Class<?>[] node classes to return classes) Get iterable of nodes of given types, in reverse order of their appearance in the document tree, depth first traversal.
public @NotNull Iterable<? extends Node>	reversedNodesOfType(@NotNull Collection<Class<?>> classes)

Method Detail

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

getBlockQuoteLikePrefixChars	back to summary
public @NotNull BasedSequence getBlockQuoteLikePrefixChars() Returns:@NotNull BasedSequence char sequence of all prefix chars which compact like block quote prefix char Annotations @NotNull

getBlockQuoteLikePrefixPredicate	back to summary
public @NotNull CharPredicate getBlockQuoteLikePrefixPredicate() Returns:@NotNull CharPredicate predicate for prefix chars which compact like block quote prefix char Annotations @NotNull

getDocument back to summary

getDocument	back to summary
public @NotNull Document getDocument() Redeclares com.vladsch.flexmark.html.renderer.LinkResolverContext.getDocument. Returns:@NotNull Document the `Document` node of the current context Annotations @NotNull

public @NotNull Document getDocument()

Redeclares com.vladsch.flexmark.html.renderer.LinkResolverContext.getDocument.

Returns:@NotNull Document

the Document node of the current context

Annotations

@NotNull

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

getFormattingPhase	back to summary
public @NotNull FormattingPhase getFormattingPhase() Returns:@NotNull FormattingPhase current rendering phase Annotations @NotNull

getMarkdown	back to summary
public @NotNull MarkdownWriter getMarkdown() Returns:@NotNull MarkdownWriter the HTML writer to use Annotations @NotNull

getOptions back to summary

getOptions	back to summary
public @NotNull DataHolder getOptions() Redeclares com.vladsch.flexmark.util.format.NodeContext.getOptions, com.vladsch.flexmark.html.renderer.LinkResolverContext.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:@NotNull DataHolder the current renderer options `DataHolder` Annotations @NotNull

public @NotNull DataHolder getOptions()

Redeclares com.vladsch.flexmark.util.format.NodeContext.getOptions, com.vladsch.flexmark.html.renderer.LinkResolverContext.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:@NotNull DataHolder

the current renderer options DataHolder

Annotations

@NotNull

getTrackedOffsets	back to summary
public @NotNull TrackedOffsetList getTrackedOffsets() Returns:@NotNull TrackedOffsetList tracked offset list Annotations @NotNull

getTrackedSequence back to summary

getTrackedSequence	back to summary
public @NotNull BasedSequence getTrackedSequence() Note parser can only use a contiguous sequence, not segmented. Therefore, the AST offsets and base sequence from AST nodes has always an index into sequence equal to the offset. This sequence is set to not `BasedSequence#NULL` when the format sequence used for tracked offsets is not contiguous and TrackedOffset.offset is an offset from this sequence and need to be converted to index into this sequence to be used as an offset into AST sequence for offset conversion Returns:@NotNull BasedSequence original sequence used for tracked offsets. Annotations @NotNull

public @NotNull BasedSequence getTrackedSequence()

Note

parser can only use a contiguous sequence, not segmented. Therefore, the AST offsets and base sequence from AST nodes has always an index into sequence equal to the offset. This sequence is set to not BasedSequence#NULL when the format sequence used for tracked offsets is not contiguous and TrackedOffset.offset is an offset from this sequence and need to be converted to index into this sequence to be used as an offset into AST sequence for offset conversion

Returns:@NotNull BasedSequence

original sequence used for tracked offsets.

Annotations

@NotNull

isRestoreTrackedSpaces	back to summary
public boolean isRestoreTrackedSpaces()

nodesOfType back to summary

nodesOfType	back to summary
public @NotNull Iterable<? extends Node> nodesOfType(@NotNull 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 `com.vladsch.flexmark.ast.RefNode` if `Formatter#REFERENCE_SORT` is set to `ElementPlacementSort#SORT_UNUSED_LAST` so that Parameters classes:@NotNull Class<?>[] node classes to return Returns:@NotNull Iterable<? extends Node> iterable Annotations @NotNull

public @NotNull Iterable<? extends Node> nodesOfType(@NotNull 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 com.vladsch.flexmark.ast.RefNode if Formatter#REFERENCE_SORT is set to ElementPlacementSort#SORT_UNUSED_LAST so that

Parameters

classes:@NotNull Class<?>[]: node classes to return

Returns:@NotNull Iterable<? extends Node>

iterable

Annotations

@NotNull

nodesOfType	back to summary
public @NotNull Iterable<? extends Node> nodesOfType(@NotNull Collection<Class<?>> classes) Annotations @NotNull

render	back to summary
public void render(@NotNull 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:@NotNull Node the node to render

render

back to summary

public void render(@NotNull 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:@NotNull Node: the node to render

renderChildren	back to summary
public void renderChildren(@NotNull Node parent) Render the children of the node, used by custom renderers Parameters parent:@NotNull Node node the children of which are to be rendered

renderChildren

back to summary

public void renderChildren(@NotNull Node parent)

Render the children of the node, used by custom renderers

Parameters

parent:@NotNull Node: node the children of which are to be rendered

reversedNodesOfType back to summary

reversedNodesOfType	back to summary
public @NotNull Iterable<? extends Node> reversedNodesOfType(@NotNull 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 `com.vladsch.flexmark.ast.RefNode` if `Formatter#REFERENCE_SORT` is set to `ElementPlacementSort#SORT_UNUSED_LAST` so that Parameters classes:@NotNull Class<?>[] node classes to return Returns:@NotNull Iterable<? extends Node> iterable Annotations @NotNull

public @NotNull Iterable<? extends Node> reversedNodesOfType(@NotNull 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 com.vladsch.flexmark.ast.RefNode if Formatter#REFERENCE_SORT is set to ElementPlacementSort#SORT_UNUSED_LAST so that

Parameters

classes:@NotNull Class<?>[]: node classes to return

Returns:@NotNull Iterable<? extends Node>

iterable

Annotations

@NotNull

reversedNodesOfType	back to summary
public @NotNull Iterable<? extends Node> reversedNodesOfType(@NotNull Collection<Class<?>> classes) Annotations @NotNull

public Interface NodeFormatterContext

Method Summary

Method Detail