flexmark-all 0.64.8 · com.vladsch.flexmark.html2md.converter.HtmlNodeConverterContext

Method Summary

Modifier and Type	Method and Description
public void	appendOuterHtml(@NotNull Node node)
public void	delegateRender()
public @NotNull String	escapeSpecialChars(@NotNull String text)
public void	excludeAttributes(String... excludes)
public @Nullable Node	Returns: the current node being rendered getCurrentNode() Redeclares com.vladsch.flexmark.util.format.NodeContext.getCurrentNode.
public @NotNull Document	Returns: the `Document` node of the current context getDocument()
public @NotNull HashSet<Reference>	getExternalReferences()
public Document	Returns: the `com.vladsch.flexmark.util.ast.Document` node of the current context getForDocument()
public HtmlConverterPhase	Returns: current rendering phase getFormattingPhase()
public @NotNull HtmlConverterOptions	Returns: the `HtmlConverterOptions` for the context. getHtmlConverterOptions()
public HtmlMarkdownWriter	Returns: the `LineAppendable` writer to use getMarkdown()
public @NotNull DataHolder	Returns: the current renderer options `DataHolder` getOptions() Redeclares com.vladsch.flexmark.util.format.NodeContext.getOptions. Get the current rendering context `DataHolder`.
public @Nullable Reference	getOrCreateReference(@NotNull String url, @NotNull String text, @Nullable String title)
public @NotNull HashMap<String, Reference>	getReferenceIdToReferenceMap()
public @NotNull HashMap<String, Reference>	getReferenceUrlToReferenceMap()
public @Nullable HtmlConverterState	getState()
public @NotNull Stack<HtmlConverterState>	getStateStack()
public @NotNull HtmlNodeConverterContext	Returns: a new rendering context with a given appendable for its output getSubContext() Redeclares com.vladsch.flexmark.util.format.NodeContext.getSubContext. Creates a child rendering context that can be used to collect rendered html text.
public @NotNull HtmlNodeConverterContext	Returns: a new rendering context with a given appendable for its output getSubContext(@Nullable DataHolder options to use for the context (only options which do not affect the context construction will be used) options) Creates a child rendering context that can be used to collect rendered html text.
public @NotNull HtmlNodeConverterContext	Returns: a new rendering context with a given appendable for its output getSubContext(@Nullable DataHolder options to use for the context (only options which do not affect the context construction will be used) options, @NotNull ISequenceBuilder<?, ?> sequence builder to user for appended text for tracking original base offsets builder) Creates a child rendering context that can be used to collect rendered html text.
public void	inlineCode(@NotNull Runnable inlineRunnable)
public boolean	isInlineCode()
public boolean	isTrace()
public @Nullable Node	next()
public @Nullable Node	next(int skip)
public int	outputAttributes(@NotNull LineAppendable out, @NotNull String initialSep)
public Node	parseMarkdown(@NotNull String markdown)
public @Nullable Node	peek()
public @Nullable Node	peek(int skip)
public void	popState(@Nullable LineAppendable out)
public @NotNull String	prepareText(@NotNull String text)
public @NotNull String	prepareText(@NotNull String text, boolean inCode)
public void	processAttributes(@NotNull Node node)
public void	processConditional(@NotNull ExtensionConversion extensionConversion, @NotNull Node node, @NotNull Runnable processNode)
public void	processTextNodes(@NotNull Node node, boolean stripIdAttribute)
public void	processTextNodes(@NotNull Node node, boolean stripIdAttribute, @NotNull CharSequence wrapText)
public void	processTextNodes(@NotNull Node node, boolean stripIdAttribute, @Nullable CharSequence textPrefix, @Nullable CharSequence textSuffix)
public @NotNull String	processTextNodes(@NotNull Node node)
public void	processUnwrapped(@NotNull Node element)
public void	processWrapped(@NotNull Node node, @Nullable Boolean isBlock, boolean escapeMarkdown)
public void	pushState(@NotNull Node parent)
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, boolean true if attributes should be output outputAttributes, @Nullable Runnable runnable to run before popping state prePopAction) Render the children of the node, used by custom renderers
public void	renderDefault(@NotNull Node node)
public @NotNull ResolvedLink	resolveLink(@NotNull LinkType linkType, @NotNull CharSequence url, @Nullable Boolean urlEncode)
public @NotNull ResolvedLink	resolveLink(@NotNull LinkType linkType, @NotNull CharSequence url, @Nullable Attributes attributes, @Nullable Boolean urlEncode)
public void	setInlineCode(boolean inlineCode)
public void	setTrace(boolean trace)
public void	skip()
public void	skip(int skip)
public void	transferIdToParent()
public void	transferToParentExcept(String... excludes)
public void	transferToParentOnly(String... includes)
public void	wrapTextNodes(@NotNull Node node, @NotNull CharSequence wrapText, boolean needSpaceAround)

Inherited from com.vladsch.flexmark.util.format.NodeContext:: getSubContext getSubContext

Method Detail

appendOuterHtml	back to summary
public void appendOuterHtml(@NotNull Node node)

delegateRender	back to summary
public void delegateRender()

escapeSpecialChars	back to summary
public @NotNull String escapeSpecialChars(@NotNull String text) Annotations @NotNull

excludeAttributes	back to summary
public void excludeAttributes(String... excludes)

getCurrentNode	back to summary
public @Nullable Node getCurrentNode() Redeclares com.vladsch.flexmark.util.format.NodeContext.getCurrentNode. Returns:@Nullable Node the current node being rendered Annotations @Nullable

getCurrentNode

back to summary

public @Nullable Node getCurrentNode()

Redeclares com.vladsch.flexmark.util.format.NodeContext.getCurrentNode.

Returns:@Nullable Node

the current node being rendered

Annotations

@Nullable

getDocument	back to summary
public @NotNull Document getDocument() Returns:@NotNull Document the `Document` node of the current context Annotations @NotNull

getExternalReferences	back to summary
public @NotNull HashSet<Reference> getExternalReferences() Annotations @NotNull

getForDocument	back to summary
public Document getForDocument() Returns:Document the `com.vladsch.flexmark.util.ast.Document` node of the current context Annotations @Nullable

getFormattingPhase	back to summary
public HtmlConverterPhase getFormattingPhase() Returns:HtmlConverterPhase current rendering phase

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

getMarkdown	back to summary
public HtmlMarkdownWriter getMarkdown() Returns:HtmlMarkdownWriter the `LineAppendable` writer to use

getOptions back to summary

getOptions	back to summary
public @NotNull DataHolder getOptions() Redeclares com.vladsch.flexmark.util.format.NodeContext.getOptions. Get the current rendering context `DataHolder`. These are the options passed or set on the `FlexmarkHtmlConverter#builder()` or passed to `FlexmarkHtmlConverter#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.

Get the current rendering context DataHolder. These are the options passed or set on the FlexmarkHtmlConverter#builder() or passed to FlexmarkHtmlConverter#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

getOrCreateReference	back to summary
public @Nullable Reference getOrCreateReference(@NotNull String url, @NotNull String text, @Nullable String title) Annotations @Nullable

getReferenceIdToReferenceMap	back to summary
public @NotNull HashMap<String, Reference> getReferenceIdToReferenceMap() Annotations @NotNull

getReferenceUrlToReferenceMap	back to summary
public @NotNull HashMap<String, Reference> getReferenceUrlToReferenceMap() Annotations @NotNull

getState	back to summary
public @Nullable HtmlConverterState getState() Annotations @Nullable

getStateStack	back to summary
public @NotNull Stack<HtmlConverterState> getStateStack() Annotations @NotNull

getSubContext	back to summary
public @NotNull HtmlNodeConverterContext getSubContext() Redeclares com.vladsch.flexmark.util.format.NodeContext.getSubContext. Creates a child rendering context that can be used to collect rendered html text. The child context inherits everything but the HtmlRenderer and doNotRenderLinksNesting from the parent. Returns:@NotNull HtmlNodeConverterContext a new rendering context with a given appendable for its output Annotations @NotNull

getSubContext

back to summary

public @NotNull HtmlNodeConverterContext getSubContext()

Redeclares com.vladsch.flexmark.util.format.NodeContext.getSubContext.

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

Returns:@NotNull HtmlNodeConverterContext

a new rendering context with a given appendable for its output

Annotations

@NotNull

getSubContext	back to summary
public @NotNull HtmlNodeConverterContext getSubContext(@Nullable DataHolder options) Creates a child rendering context that can be used to collect rendered html text. The child context inherits everything but the HtmlRenderer and doNotRenderLinksNesting from the parent. Parameters options:@Nullable DataHolder options to use for the context (only options which do not affect the context construction will be used) Returns:@NotNull HtmlNodeConverterContext a new rendering context with a given appendable for its output Annotations @NotNull

getSubContext	back to summary
public @NotNull HtmlNodeConverterContext getSubContext(@Nullable DataHolder options, @NotNull ISequenceBuilder<?, ?> builder) Creates a child rendering context that can be used to collect rendered html text. The child context inherits everything but the HtmlRenderer and doNotRenderLinksNesting from the parent. Parameters options:@Nullable DataHolder options to use for the context (only options which do not affect the context construction will be used) builder:@NotNull ISequenceBuilder<?, ?> sequence builder to user for appended text for tracking original base offsets Returns:@NotNull HtmlNodeConverterContext a new rendering context with a given appendable for its output Annotations @NotNull

inlineCode	back to summary
public void inlineCode(@NotNull Runnable inlineRunnable)

isInlineCode	back to summary
public boolean isInlineCode()

isTrace	back to summary
public boolean isTrace()

next	back to summary
public @Nullable Node next() Annotations @Nullable

next	back to summary
public @Nullable Node next(int skip) Annotations @Nullable

outputAttributes	back to summary
public int outputAttributes(@NotNull LineAppendable out, @NotNull String initialSep)

parseMarkdown	back to summary
public Node parseMarkdown(@NotNull String markdown) Annotations @NotNull

peek	back to summary
public @Nullable Node peek() Annotations @Nullable

peek	back to summary
public @Nullable Node peek(int skip) Annotations @Nullable

popState	back to summary
public void popState(@Nullable LineAppendable out)

prepareText	back to summary
public @NotNull String prepareText(@NotNull String text) Annotations @NotNull

prepareText	back to summary
public @NotNull String prepareText(@NotNull String text, boolean inCode) Annotations @NotNull

processAttributes	back to summary
public void processAttributes(@NotNull Node node)

processConditional	back to summary
public void processConditional(@NotNull ExtensionConversion extensionConversion, @NotNull Node node, @NotNull Runnable processNode)

processTextNodes	back to summary
public void processTextNodes(@NotNull Node node, boolean stripIdAttribute)

processTextNodes	back to summary
public void processTextNodes(@NotNull Node node, boolean stripIdAttribute, @NotNull CharSequence wrapText)

processTextNodes	back to summary
public void processTextNodes(@NotNull Node node, boolean stripIdAttribute, @Nullable CharSequence textPrefix, @Nullable CharSequence textSuffix)

processTextNodes	back to summary
public @NotNull String processTextNodes(@NotNull Node node) Annotations @NotNull

processUnwrapped	back to summary
public void processUnwrapped(@NotNull Node element)

processWrapped	back to summary
public void processWrapped(@NotNull Node node, @Nullable Boolean isBlock, boolean escapeMarkdown)

pushState	back to summary
public void pushState(@NotNull Node parent)

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, boolean outputAttributes, @Nullable Runnable prePopAction) Render the children of the node, used by custom renderers Parameters parent:@NotNull Node node the children of which are to be rendered outputAttributes:boolean true if attributes should be output prePopAction:@Nullable Runnable runnable to run before popping state

renderChildren

back to summary

public void renderChildren(@NotNull Node parent, boolean outputAttributes, @Nullable Runnable prePopAction)

Render the children of the node, used by custom renderers

Parameters

parent:@NotNull Node: node the children of which are to be rendered
outputAttributes:boolean: true if attributes should be output
prePopAction:@Nullable Runnable: runnable to run before popping state

renderDefault	back to summary
public void renderDefault(@NotNull Node node)

resolveLink	back to summary
public @NotNull ResolvedLink resolveLink(@NotNull LinkType linkType, @NotNull CharSequence url, @Nullable Boolean urlEncode) Annotations @NotNull

resolveLink	back to summary
public @NotNull ResolvedLink resolveLink(@NotNull LinkType linkType, @NotNull CharSequence url, @Nullable Attributes attributes, @Nullable Boolean urlEncode) Annotations @NotNull

setInlineCode	back to summary
public void setInlineCode(boolean inlineCode)

setTrace	back to summary
public void setTrace(boolean trace)

skip	back to summary
public void skip()

skip	back to summary
public void skip(int skip)

transferIdToParent	back to summary
public void transferIdToParent()

transferToParentExcept	back to summary
public void transferToParentExcept(String... excludes)

transferToParentOnly	back to summary
public void transferToParentOnly(String... includes)

wrapTextNodes	back to summary
public void wrapTextNodes(@NotNull Node node, @NotNull CharSequence wrapText, boolean needSpaceAround)

public Interface HtmlNodeConverterContext

Method Summary

Method Detail