com.vladsch.flexmark.html2md.converter

Interface HtmlNodeConverterContext

All Superinterfaces:

com.vladsch.flexmark.util.format.NodeContext<org.jsoup.nodes.Node,HtmlNodeConverterContext>

All Known Implementing Classes:

HtmlNodeConverterSubContext

public interface HtmlNodeConverterContext
extends com.vladsch.flexmark.util.format.NodeContext<org.jsoup.nodes.Node,HtmlNodeConverterContext>

The context for node rendering, including configuration and functionality for the node renderer to use.

Method Summary

Modifier and Type	Method and Description
void	appendOuterHtml(org.jsoup.nodes.Node node)
void	delegateRender()
String	escapeSpecialChars(String text)
void	excludeAttributes(String... excludes)
org.jsoup.nodes.Node	getCurrentNode()
org.jsoup.nodes.Document	getDocument()
HashSet<com.vladsch.flexmark.ast.Reference>	getExternalReferences()
com.vladsch.flexmark.util.ast.Document	getForDocument()
HtmlConverterPhase	getFormattingPhase()
HtmlConverterOptions	getHtmlConverterOptions()
HtmlMarkdownWriter	getMarkdown()
com.vladsch.flexmark.util.data.DataHolder	getOptions() Get the current rendering context DataHolder.
com.vladsch.flexmark.ast.Reference	getOrCreateReference(String url, String text, String title)
HashMap<String,com.vladsch.flexmark.ast.Reference>	getReferenceUrlToReferenceMap()
HtmlConverterState	getState()
Stack<HtmlConverterState>	getStateStack()
HtmlNodeConverterContext	getSubContext() Creates a child rendering context that can be used to collect rendered html text.
HtmlNodeConverterContext	getSubContext(com.vladsch.flexmark.util.data.DataHolder options) Creates a child rendering context that can be used to collect rendered html text.
HtmlNodeConverterContext	getSubContext(com.vladsch.flexmark.util.data.DataHolder options, @NotNull com.vladsch.flexmark.util.sequence.builder.ISequenceBuilder<?,?> builder) Creates a child rendering context that can be used to collect rendered html text.
void	inlineCode(Runnable inlineRunnable)
boolean	isInlineCode()
boolean	isTrace()
org.jsoup.nodes.Node	next()
org.jsoup.nodes.Node	next(int skip)
int	outputAttributes(com.vladsch.flexmark.util.sequence.LineAppendable out, String initialSep)
com.vladsch.flexmark.util.ast.Node	parseMarkdown(String markdown)
org.jsoup.nodes.Node	peek()
org.jsoup.nodes.Node	peek(int skip)
void	popState(com.vladsch.flexmark.util.sequence.LineAppendable out)
String	prepareText(String text)
String	prepareText(String text, boolean inCode)
void	processAttributes(org.jsoup.nodes.Node node)
void	processConditional(ExtensionConversion extensionConversion, org.jsoup.nodes.Node node, Runnable processNode)
String	processTextNodes(org.jsoup.nodes.Node node)
void	processTextNodes(org.jsoup.nodes.Node node, boolean stripIdAttribute)
void	processTextNodes(org.jsoup.nodes.Node node, boolean stripIdAttribute, CharSequence wrapText)
void	processTextNodes(org.jsoup.nodes.Node node, boolean stripIdAttribute, CharSequence textPrefix, CharSequence textSuffix)
void	processUnwrapped(org.jsoup.nodes.Node element)
void	processWrapped(org.jsoup.nodes.Node node, Boolean isBlock, boolean escapeMarkdown)
void	pushState(org.jsoup.nodes.Node parent)
void	render(org.jsoup.nodes.Node node) Render the specified node and its children using the configured renderers.
void	renderChildren(org.jsoup.nodes.Node parent, boolean outputAttributes, Runnable prePopAction) Render the children of the node, used by custom renderers
void	renderDefault(org.jsoup.nodes.Node node)
com.vladsch.flexmark.html.renderer.ResolvedLink	resolveLink(com.vladsch.flexmark.html.renderer.LinkType linkType, CharSequence url, com.vladsch.flexmark.util.html.Attributes attributes, Boolean urlEncode)
com.vladsch.flexmark.html.renderer.ResolvedLink	resolveLink(com.vladsch.flexmark.html.renderer.LinkType linkType, CharSequence url, Boolean urlEncode)
void	setInlineCode(boolean inlineCode)
void	setTrace(boolean trace)
void	skip()
void	skip(int skip)
void	transferIdToParent()
void	transferToParentExcept(String... excludes)
void	transferToParentOnly(String... includes)
void	wrapTextNodes(org.jsoup.nodes.Node node, CharSequence wrapText, boolean needSpaceAround)

Method Detail

getMarkdown

HtmlMarkdownWriter getMarkdown()

Returns:

the LineAppendable writer to use

delegateRender

void delegateRender()

getSubContext

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

Specified by:

getSubContext in interface com.vladsch.flexmark.util.format.NodeContext<org.jsoup.nodes.Node,HtmlNodeConverterContext>

Returns:

a new rendering context with a given appendable for its output

getSubContext

HtmlNodeConverterContext getSubContext(com.vladsch.flexmark.util.data.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.

Specified by:

getSubContext in interface com.vladsch.flexmark.util.format.NodeContext<org.jsoup.nodes.Node,HtmlNodeConverterContext>

Parameters:

options - options to use for the context (only options which do not affect the context construction will be used)

Returns:

a new rendering context with a given appendable for its output

getSubContext

HtmlNodeConverterContext getSubContext(com.vladsch.flexmark.util.data.DataHolder options,
                                       @NotNull
                                       @NotNull com.vladsch.flexmark.util.sequence.builder.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.

Specified by:

getSubContext in interface com.vladsch.flexmark.util.format.NodeContext<org.jsoup.nodes.Node,HtmlNodeConverterContext>

Parameters:

options - options to use for the context (only options which do not affect the context construction will be used)

builder - sequence builder to user for appended text for tracking original base offsets

Returns:

a new rendering context with a given appendable for its output

render

void render(org.jsoup.nodes.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 - the node to render

renderChildren

void renderChildren(org.jsoup.nodes.Node parent,
                    boolean outputAttributes,
                    Runnable prePopAction)

Render the children of the node, used by custom renderers

Parameters:

parent - node the children of which are to be rendered

outputAttributes - true if attributes should be output

prePopAction - runnable to run before popping state

getFormattingPhase

HtmlConverterPhase getFormattingPhase()

Returns:

current rendering phase

getOptions

com.vladsch.flexmark.util.data.DataHolder 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.

Specified by:

getOptions in interface com.vladsch.flexmark.util.format.NodeContext<org.jsoup.nodes.Node,HtmlNodeConverterContext>

Returns:

the current renderer options DataHolder

getHtmlConverterOptions

HtmlConverterOptions getHtmlConverterOptions()

Returns:

the HtmlConverterOptions for the context.

getDocument

org.jsoup.nodes.Document getDocument()

Returns:

the Document node of the current context

getForDocument

com.vladsch.flexmark.util.ast.Document getForDocument()

Returns:

the Document node of the current context

getState

HtmlConverterState getState()

getReferenceUrlToReferenceMap

HashMap<String,com.vladsch.flexmark.ast.Reference> getReferenceUrlToReferenceMap()

getExternalReferences

HashSet<com.vladsch.flexmark.ast.Reference> getExternalReferences()

isTrace

boolean isTrace()

getStateStack

Stack<HtmlConverterState> getStateStack()

setTrace

void setTrace(boolean trace)

parseMarkdown

com.vladsch.flexmark.util.ast.Node parseMarkdown(String markdown)

getOrCreateReference

com.vladsch.flexmark.ast.Reference getOrCreateReference(String url,
                                                        String text,
                                                        String title)

resolveLink

com.vladsch.flexmark.html.renderer.ResolvedLink resolveLink(com.vladsch.flexmark.html.renderer.LinkType linkType,
                                                            CharSequence url,
                                                            Boolean urlEncode)

resolveLink

com.vladsch.flexmark.html.renderer.ResolvedLink resolveLink(com.vladsch.flexmark.html.renderer.LinkType linkType,
                                                            CharSequence url,
                                                            com.vladsch.flexmark.util.html.Attributes attributes,
                                                            Boolean urlEncode)

getCurrentNode

org.jsoup.nodes.Node getCurrentNode()

Specified by:

getCurrentNode in interface com.vladsch.flexmark.util.format.NodeContext<org.jsoup.nodes.Node,HtmlNodeConverterContext>

Returns:

the current node being rendered

pushState

void pushState(org.jsoup.nodes.Node parent)

popState

void popState(com.vladsch.flexmark.util.sequence.LineAppendable out)

excludeAttributes

void excludeAttributes(String... excludes)

processAttributes

void processAttributes(org.jsoup.nodes.Node node)

outputAttributes

int outputAttributes(com.vladsch.flexmark.util.sequence.LineAppendable out,
                     String initialSep)

transferIdToParent

void transferIdToParent()

transferToParentExcept

void transferToParentExcept(String... excludes)

transferToParentOnly

void transferToParentOnly(String... includes)

peek

org.jsoup.nodes.Node peek()

peek

org.jsoup.nodes.Node peek(int skip)

next

org.jsoup.nodes.Node next()

skip

void skip()

next

org.jsoup.nodes.Node next(int skip)

skip

void skip(int skip)

processUnwrapped

void processUnwrapped(org.jsoup.nodes.Node element)

processWrapped

void processWrapped(org.jsoup.nodes.Node node,
                    Boolean isBlock,
                    boolean escapeMarkdown)

processTextNodes

void processTextNodes(org.jsoup.nodes.Node node,
                      boolean stripIdAttribute)

processTextNodes

void processTextNodes(org.jsoup.nodes.Node node,
                      boolean stripIdAttribute,
                      CharSequence wrapText)

processTextNodes

void processTextNodes(org.jsoup.nodes.Node node,
                      boolean stripIdAttribute,
                      CharSequence textPrefix,
                      CharSequence textSuffix)

wrapTextNodes

void wrapTextNodes(org.jsoup.nodes.Node node,
                   CharSequence wrapText,
                   boolean needSpaceAround)

processTextNodes

String processTextNodes(org.jsoup.nodes.Node node)

appendOuterHtml

void appendOuterHtml(org.jsoup.nodes.Node node)

isInlineCode

boolean isInlineCode()

setInlineCode

void setInlineCode(boolean inlineCode)

escapeSpecialChars

String escapeSpecialChars(String text)

prepareText

String prepareText(String text)

prepareText

String prepareText(String text,
                   boolean inCode)

inlineCode

void inlineCode(Runnable inlineRunnable)

processConditional

void processConditional(ExtensionConversion extensionConversion,
                        org.jsoup.nodes.Node node,
                        Runnable processNode)

renderDefault

void renderDefault(org.jsoup.nodes.Node node)