Package com.vladsch.flexmark.html2md.converter

Interface HtmlNodeConverterContext

All Superinterfaces:

NodeContext<org.jsoup.nodes.Node,HtmlNodeConverterContext>

All Known Implementing Classes:

FlexmarkHtmlConverter.MainHtmlConverter, FlexmarkHtmlConverter.MainHtmlConverter.SubHtmlNodeConverter, HtmlNodeConverterSubContext

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

Method Detail

getMarkdown

HtmlMarkdownWriter getMarkdown()

Returns:

the LineAppendable writer to use

delegateRender

void delegateRender()

getSubContext

@NotNull
@NotNull 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 NodeContext<org.jsoup.nodes.Node,HtmlNodeConverterContext>

Returns:

a new rendering context with a given appendable for its output

getSubContext

@NotNull
@NotNull HtmlNodeConverterContext getSubContext(@Nullable
                                                @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.

Specified by:

getSubContext in interface 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

@NotNull
@NotNull HtmlNodeConverterContext getSubContext(@Nullable
                                                @Nullable DataHolder options,
                                                @NotNull
                                                @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.

Specified by:

getSubContext in interface 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(@NotNull
            @NotNull 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(@NotNull
                    @NotNull org.jsoup.nodes.Node parent,
                    boolean outputAttributes,
                    @Nullable
                    @Nullable java.lang.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

@NotNull
@NotNull 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 NodeContext<org.jsoup.nodes.Node,HtmlNodeConverterContext>

Returns:

the current renderer options DataHolder

getHtmlConverterOptions

@NotNull
@NotNull HtmlConverterOptions getHtmlConverterOptions()

Returns:

the HtmlConverterOptions for the context.

getDocument

@NotNull
@NotNull org.jsoup.nodes.Document getDocument()

Returns:

the Document node of the current context

getForDocument

@Nullable
Document getForDocument()

Returns:

the Document node of the current context

getState

@Nullable
@Nullable HtmlConverterState getState()

getReferenceUrlToReferenceMap

@NotNull
@NotNull java.util.HashMap<java.lang.String,Reference> getReferenceUrlToReferenceMap()

getExternalReferences

@NotNull
@NotNull java.util.HashSet<Reference> getExternalReferences()

isTrace

boolean isTrace()

getStateStack

@NotNull
@NotNull java.util.Stack<HtmlConverterState> getStateStack()

setTrace

void setTrace(boolean trace)

parseMarkdown

@NotNull
Node parseMarkdown(@NotNull
                   @NotNull java.lang.String markdown)

getOrCreateReference

@Nullable
@Nullable Reference getOrCreateReference(@NotNull
                                         @NotNull java.lang.String url,
                                         @NotNull
                                         @NotNull java.lang.String text,
                                         @Nullable
                                         @Nullable java.lang.String title)

resolveLink

@NotNull
@NotNull ResolvedLink resolveLink(@NotNull
                                  @NotNull LinkType linkType,
                                  @NotNull
                                  @NotNull java.lang.CharSequence url,
                                  @Nullable
                                  @Nullable java.lang.Boolean urlEncode)

resolveLink

@NotNull
@NotNull ResolvedLink resolveLink(@NotNull
                                  @NotNull LinkType linkType,
                                  @NotNull
                                  @NotNull java.lang.CharSequence url,
                                  @Nullable
                                  @Nullable Attributes attributes,
                                  @Nullable
                                  @Nullable java.lang.Boolean urlEncode)

getCurrentNode

@Nullable
@Nullable org.jsoup.nodes.Node getCurrentNode()

Specified by:

getCurrentNode in interface NodeContext<org.jsoup.nodes.Node,HtmlNodeConverterContext>

Returns:

the current node being rendered

pushState

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

popState

void popState(@Nullable
              @Nullable LineAppendable out)

excludeAttributes

void excludeAttributes(java.lang.String... excludes)

processAttributes

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

outputAttributes

int outputAttributes(@NotNull
                     @NotNull LineAppendable out,
                     @NotNull
                     @NotNull java.lang.String initialSep)

transferIdToParent

void transferIdToParent()

transferToParentExcept

void transferToParentExcept(java.lang.String... excludes)

transferToParentOnly

void transferToParentOnly(java.lang.String... includes)

peek

@Nullable
@Nullable org.jsoup.nodes.Node peek()

peek

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

next

@Nullable
@Nullable org.jsoup.nodes.Node next()

skip

void skip()

next

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

skip

void skip(int skip)

processUnwrapped

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

processWrapped

void processWrapped(@NotNull
                    @NotNull org.jsoup.nodes.Node node,
                    @Nullable
                    @Nullable java.lang.Boolean isBlock,
                    boolean escapeMarkdown)

processTextNodes

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

processTextNodes

void processTextNodes(@NotNull
                      @NotNull org.jsoup.nodes.Node node,
                      boolean stripIdAttribute,
                      @NotNull
                      @NotNull java.lang.CharSequence wrapText)

processTextNodes

void processTextNodes(@NotNull
                      @NotNull org.jsoup.nodes.Node node,
                      boolean stripIdAttribute,
                      @Nullable
                      @Nullable java.lang.CharSequence textPrefix,
                      @Nullable
                      @Nullable java.lang.CharSequence textSuffix)

wrapTextNodes

void wrapTextNodes(@NotNull
                   @NotNull org.jsoup.nodes.Node node,
                   @NotNull
                   @NotNull java.lang.CharSequence wrapText,
                   boolean needSpaceAround)

processTextNodes

@NotNull
@NotNull java.lang.String processTextNodes(@NotNull
                                           @NotNull org.jsoup.nodes.Node node)

appendOuterHtml

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

isInlineCode

boolean isInlineCode()

setInlineCode

void setInlineCode(boolean inlineCode)

escapeSpecialChars

@NotNull
@NotNull java.lang.String escapeSpecialChars(@NotNull
                                             @NotNull java.lang.String text)

prepareText

@NotNull
@NotNull java.lang.String prepareText(@NotNull
                                      @NotNull java.lang.String text)

prepareText

@NotNull
@NotNull java.lang.String prepareText(@NotNull
                                      @NotNull java.lang.String text,
                                      boolean inCode)

inlineCode

void inlineCode(@NotNull
                @NotNull java.lang.Runnable inlineRunnable)

processConditional

void processConditional(@NotNull
                        @NotNull ExtensionConversion extensionConversion,
                        @NotNull
                        @NotNull org.jsoup.nodes.Node node,
                        @NotNull
                        @NotNull java.lang.Runnable processNode)

renderDefault

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