Package com.vladsch.flexmark.html2md.converter

Class FlexmarkHtmlConverter.MainHtmlConverter.SubHtmlNodeConverter

java.lang.Object

com.vladsch.flexmark.html2md.converter.HtmlNodeConverterSubContext

com.vladsch.flexmark.html2md.converter.FlexmarkHtmlConverter.MainHtmlConverter.SubHtmlNodeConverter

All Implemented Interfaces:

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

Enclosing class:

FlexmarkHtmlConverter.MainHtmlConverter

private class FlexmarkHtmlConverter.MainHtmlConverter.SubHtmlNodeConverter
extends HtmlNodeConverterSubContext
implements HtmlNodeConverterContext

Field Summary

Fields

Modifier and Type	Field	Description
private final FlexmarkHtmlConverter.MainHtmlConverter	myMainNodeRenderer
private final DataHolder	myOptions

Fields inherited from class com.vladsch.flexmark.html2md.converter.HtmlNodeConverterSubContext

markdown, myRenderingNode, renderingHandlerWrapper

Constructor Summary

Constructors

Constructor	Description
SubHtmlNodeConverter(@NotNull FlexmarkHtmlConverter.MainHtmlConverter mainNodeRenderer, @NotNull HtmlMarkdownWriter out, @Nullable DataHolder options)

Method Summary

Modifier and Type	Method	Description
void	appendOuterHtml(@NotNull org.jsoup.nodes.Node node)
void	delegateRender()
@NotNull String	escapeSpecialChars(@NotNull String text)
void	excludeAttributes(String... excludes)
org.jsoup.nodes.Node	getCurrentNode()
@NotNull org.jsoup.nodes.Document	getDocument()
@NotNull HashSet<Reference>	getExternalReferences()
Document	getForDocument()
HtmlConverterPhase	getFormattingPhase()
@NotNull HtmlConverterOptions	getHtmlConverterOptions()
@NotNull DataHolder	getOptions()	Get the current rendering context DataHolder.
Reference	getOrCreateReference(@NotNull String url, @NotNull String text, @Nullable String title)
@NotNull HashMap<String,Reference>	getReferenceUrlToReferenceMap()
HtmlConverterState	getState()
@NotNull 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 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 String initialSep)
@NotNull Node	parseMarkdown(@NotNull String markdown)
@Nullable org.jsoup.nodes.Node	peek()
@Nullable org.jsoup.nodes.Node	peek(int skip)
void	popState(@Nullable LineAppendable out)
@NotNull String	prepareText(@NotNull String text)
@NotNull String	prepareText(@NotNull String text, boolean inCode)
void	processAttributes(@NotNull org.jsoup.nodes.Node node)
void	processConditional(@NotNull ExtensionConversion extensionConversion, @NotNull org.jsoup.nodes.Node node, @NotNull Runnable processNode)
@NotNull 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 CharSequence wrapText)
void	processTextNodes(@NotNull org.jsoup.nodes.Node node, boolean stripIdAttribute, @Nullable CharSequence textPrefix, @Nullable CharSequence textSuffix)
void	processUnwrapped(@NotNull org.jsoup.nodes.Node element)
void	processWrapped(@NotNull org.jsoup.nodes.Node node, @Nullable 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, 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 CharSequence url, Attributes attributes, Boolean urlEncode)
@NotNull ResolvedLink	resolveLink(@NotNull LinkType linkType, @NotNull 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(@NotNull org.jsoup.nodes.Node node, @NotNull CharSequence wrapText, boolean needSpaceAround)

Methods inherited from class com.vladsch.flexmark.html2md.converter.HtmlNodeConverterSubContext

flushTo, flushTo, getMarkdown, getRenderingNode, setRenderingNode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vladsch.flexmark.html2md.converter.HtmlNodeConverterContext

getMarkdown

Field Details

myMainNodeRenderer

private final FlexmarkHtmlConverter.MainHtmlConverter myMainNodeRenderer

myOptions

private final DataHolder myOptions

Constructor Details

SubHtmlNodeConverter

SubHtmlNodeConverter(@NotNull
 @NotNull FlexmarkHtmlConverter.MainHtmlConverter mainNodeRenderer,
 @NotNull
 @NotNull HtmlMarkdownWriter out,
 @Nullable
 @Nullable DataHolder options)

Method Details

getOptions

@NotNull
public @NotNull DataHolder getOptions()

Description copied from interface: HtmlNodeConverterContext

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 HtmlNodeConverterContext.getDocument() as the data holder.

Specified by:

getOptions in interface HtmlNodeConverterContext

Specified by:

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

Returns:

the current renderer options DataHolder

getHtmlConverterOptions

@NotNull
public @NotNull HtmlConverterOptions getHtmlConverterOptions()

Specified by:

getHtmlConverterOptions in interface HtmlNodeConverterContext

Returns:

the HtmlConverterOptions for the context.

getDocument

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

Specified by:

getDocument in interface HtmlNodeConverterContext

Returns:

the Document node of the current context

getFormattingPhase

public HtmlConverterPhase getFormattingPhase()

Specified by:

getFormattingPhase in interface HtmlNodeConverterContext

Returns:

current rendering phase

render

public void render(@NotNull
 @NotNull org.jsoup.nodes.Node node)

Description copied from interface: HtmlNodeConverterContext

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.

Specified by:

render in interface HtmlNodeConverterContext

Parameters:

node - the node to render

getCurrentNode

public org.jsoup.nodes.Node getCurrentNode()

Specified by:

getCurrentNode in interface HtmlNodeConverterContext

Specified by:

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

Returns:

the current node being rendered

getSubContext

@NotNull
public @NotNull HtmlNodeConverterContext getSubContext()

Description copied from interface: HtmlNodeConverterContext

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 HtmlNodeConverterContext

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

Description copied from interface: HtmlNodeConverterContext

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 HtmlNodeConverterContext

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
public @NotNull HtmlNodeConverterContext getSubContext(@Nullable
 @Nullable DataHolder options,
 @NotNull
 @NotNull ISequenceBuilder<?,?> builder)

Description copied from interface: HtmlNodeConverterContext

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 HtmlNodeConverterContext

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

renderChildren

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

Description copied from interface: HtmlNodeConverterContext

Render the children of the node, used by custom renderers

Specified by:

renderChildren in interface HtmlNodeConverterContext

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

getForDocument

@Nullable
public Document getForDocument()

Specified by:

getForDocument in interface HtmlNodeConverterContext

Returns:

the Document node of the current context

resolveLink

@NotNull
public @NotNull ResolvedLink resolveLink(@NotNull
 @NotNull LinkType linkType,
 @NotNull
 @NotNull CharSequence url,
 Boolean urlEncode)

Specified by:

resolveLink in interface HtmlNodeConverterContext

resolveLink

@NotNull
public @NotNull ResolvedLink resolveLink(@NotNull
 @NotNull LinkType linkType,
 @NotNull
 @NotNull CharSequence url,
 Attributes attributes,
 Boolean urlEncode)

Specified by:

resolveLink in interface HtmlNodeConverterContext

pushState

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

Specified by:

pushState in interface HtmlNodeConverterContext

popState

public void popState(@Nullable
 @Nullable LineAppendable out)

Specified by:

popState in interface HtmlNodeConverterContext

processAttributes

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

Specified by:

processAttributes in interface HtmlNodeConverterContext

outputAttributes

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

Specified by:

outputAttributes in interface HtmlNodeConverterContext

transferIdToParent

public void transferIdToParent()

Specified by:

transferIdToParent in interface HtmlNodeConverterContext

transferToParentExcept

public void transferToParentExcept(String... excludes)

Specified by:

transferToParentExcept in interface HtmlNodeConverterContext

transferToParentOnly

public void transferToParentOnly(String... includes)

Specified by:

transferToParentOnly in interface HtmlNodeConverterContext

peek

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

Specified by:

peek in interface HtmlNodeConverterContext

peek

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

Specified by:

peek in interface HtmlNodeConverterContext

next

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

Specified by:

next in interface HtmlNodeConverterContext

skip

public void skip()

Specified by:

skip in interface HtmlNodeConverterContext

next

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

Specified by:

next in interface HtmlNodeConverterContext

skip

public void skip(int skip)

Specified by:

skip in interface HtmlNodeConverterContext

delegateRender

public void delegateRender()

Specified by:

delegateRender in interface HtmlNodeConverterContext

getReferenceUrlToReferenceMap

@NotNull
public @NotNull HashMap<String,Reference> getReferenceUrlToReferenceMap()

Specified by:

getReferenceUrlToReferenceMap in interface HtmlNodeConverterContext

getExternalReferences

@NotNull
public @NotNull HashSet<Reference> getExternalReferences()

Specified by:

getExternalReferences in interface HtmlNodeConverterContext

getOrCreateReference

public Reference getOrCreateReference(@NotNull
 @NotNull String url,
 @NotNull
 @NotNull String text,
 @Nullable
 @Nullable String title)

Specified by:

getOrCreateReference in interface HtmlNodeConverterContext

parseMarkdown

public @NotNull Node parseMarkdown(@NotNull
 @NotNull String markdown)

Specified by:

parseMarkdown in interface HtmlNodeConverterContext

processUnwrapped

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

Specified by:

processUnwrapped in interface HtmlNodeConverterContext

processWrapped

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

Specified by:

processWrapped in interface HtmlNodeConverterContext

appendOuterHtml

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

Specified by:

appendOuterHtml in interface HtmlNodeConverterContext

isInlineCode

public boolean isInlineCode()

Specified by:

isInlineCode in interface HtmlNodeConverterContext

setInlineCode

public void setInlineCode(boolean inlineCode)

Specified by:

setInlineCode in interface HtmlNodeConverterContext

inlineCode

public void inlineCode(@NotNull
 @NotNull Runnable inlineRunnable)

Specified by:

inlineCode in interface HtmlNodeConverterContext

escapeSpecialChars

@NotNull
public @NotNull String escapeSpecialChars(@NotNull
 @NotNull String text)

Specified by:

escapeSpecialChars in interface HtmlNodeConverterContext

prepareText

@NotNull
public @NotNull String prepareText(@NotNull
 @NotNull String text)

Specified by:

prepareText in interface HtmlNodeConverterContext

prepareText

@NotNull
public @NotNull String prepareText(@NotNull
 @NotNull String text,
 boolean inCode)

Specified by:

prepareText in interface HtmlNodeConverterContext

processTextNodes

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

Specified by:

processTextNodes in interface HtmlNodeConverterContext

excludeAttributes

public void excludeAttributes(String... excludes)

Specified by:

excludeAttributes in interface HtmlNodeConverterContext

processTextNodes

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

Specified by:

processTextNodes in interface HtmlNodeConverterContext

processTextNodes

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

Specified by:

processTextNodes in interface HtmlNodeConverterContext

processTextNodes

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

Specified by:

processTextNodes in interface HtmlNodeConverterContext

wrapTextNodes

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

Specified by:

wrapTextNodes in interface HtmlNodeConverterContext

processConditional

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

Specified by:

processConditional in interface HtmlNodeConverterContext

renderDefault

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

Specified by:

renderDefault in interface HtmlNodeConverterContext

getState

public HtmlConverterState getState()

Specified by:

getState in interface HtmlNodeConverterContext

isTrace

public boolean isTrace()

Specified by:

isTrace in interface HtmlNodeConverterContext

setTrace

public void setTrace(boolean trace)

Specified by:

setTrace in interface HtmlNodeConverterContext

getStateStack

@NotNull
public @NotNull Stack<HtmlConverterState> getStateStack()

Specified by:

getStateStack in interface HtmlNodeConverterContext