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 FlexmarkHtmlConverter.MainHtmlConverter
myMainNodeRenderer
private 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
All Methods Instance Methods Concrete Methods 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)
org.jsoup.nodes.Node
getCurrentNode()
@NotNull org.jsoup.nodes.Document
getDocument()
@NotNull java.util.HashSet<Reference>
getExternalReferences()
Document
getForDocument()
HtmlConverterPhase
getFormattingPhase()
@NotNull HtmlConverterOptions
getHtmlConverterOptions()
@NotNull DataHolder
getOptions()
Get the current rendering contextDataHolder
.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()
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)
@NotNull 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, java.lang.Runnable prePopAction)
Render the children of the node, used by custom renderersvoid
renderDefault(@NotNull org.jsoup.nodes.Node node)
@NotNull ResolvedLink
resolveLink(@NotNull LinkType linkType, @NotNull java.lang.CharSequence url, Attributes attributes, java.lang.Boolean urlEncode)
@NotNull ResolvedLink
resolveLink(@NotNull LinkType linkType, @NotNull java.lang.CharSequence url, 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)
-
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 Detail
-
myMainNodeRenderer
private final FlexmarkHtmlConverter.MainHtmlConverter myMainNodeRenderer
-
myOptions
private final DataHolder myOptions
-
-
Constructor Detail
-
SubHtmlNodeConverter
SubHtmlNodeConverter(@NotNull @NotNull FlexmarkHtmlConverter.MainHtmlConverter mainNodeRenderer, @NotNull @NotNull HtmlMarkdownWriter out, @Nullable @Nullable DataHolder options)
-
-
Method Detail
-
getOptions
@NotNull public @NotNull DataHolder getOptions()
Description copied from interface:HtmlNodeConverterContext
Get the current rendering contextDataHolder
. These are the options passed or set on theFlexmarkHtmlConverter.builder()
or passed toFlexmarkHtmlConverter.builder(DataHolder)
. To get the document options you should useHtmlNodeConverterContext.getDocument()
as the data holder.- Specified by:
getOptions
in interfaceHtmlNodeConverterContext
- Specified by:
getOptions
in interfaceNodeContext<org.jsoup.nodes.Node,HtmlNodeConverterContext>
- Returns:
- the current renderer options
DataHolder
-
getHtmlConverterOptions
@NotNull public @NotNull HtmlConverterOptions getHtmlConverterOptions()
- Specified by:
getHtmlConverterOptions
in interfaceHtmlNodeConverterContext
- Returns:
- the
HtmlConverterOptions
for the context.
-
getDocument
@NotNull public @NotNull org.jsoup.nodes.Document getDocument()
- Specified by:
getDocument
in interfaceHtmlNodeConverterContext
- Returns:
- the
Document
node of the current context
-
getFormattingPhase
public HtmlConverterPhase getFormattingPhase()
- Specified by:
getFormattingPhase
in interfaceHtmlNodeConverterContext
- 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 interfaceHtmlNodeConverterContext
- Parameters:
node
- the node to render
-
getCurrentNode
public org.jsoup.nodes.Node getCurrentNode()
- Specified by:
getCurrentNode
in interfaceHtmlNodeConverterContext
- Specified by:
getCurrentNode
in interfaceNodeContext<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 interfaceHtmlNodeConverterContext
- Specified by:
getSubContext
in interfaceNodeContext<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 interfaceHtmlNodeConverterContext
- Specified by:
getSubContext
in interfaceNodeContext<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 interfaceHtmlNodeConverterContext
- Specified by:
getSubContext
in interfaceNodeContext<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, java.lang.Runnable prePopAction)
Description copied from interface:HtmlNodeConverterContext
Render the children of the node, used by custom renderers- Specified by:
renderChildren
in interfaceHtmlNodeConverterContext
- Parameters:
parent
- node the children of which are to be renderedoutputAttributes
- true if attributes should be outputprePopAction
- runnable to run before popping state
-
getForDocument
@Nullable public Document getForDocument()
- Specified by:
getForDocument
in interfaceHtmlNodeConverterContext
- Returns:
- the
Document
node of the current context
-
resolveLink
@NotNull public @NotNull ResolvedLink resolveLink(@NotNull @NotNull LinkType linkType, @NotNull @NotNull java.lang.CharSequence url, java.lang.Boolean urlEncode)
- Specified by:
resolveLink
in interfaceHtmlNodeConverterContext
-
resolveLink
@NotNull public @NotNull ResolvedLink resolveLink(@NotNull @NotNull LinkType linkType, @NotNull @NotNull java.lang.CharSequence url, Attributes attributes, java.lang.Boolean urlEncode)
- Specified by:
resolveLink
in interfaceHtmlNodeConverterContext
-
pushState
public void pushState(@NotNull @NotNull org.jsoup.nodes.Node parent)
- Specified by:
pushState
in interfaceHtmlNodeConverterContext
-
popState
public void popState(@Nullable @Nullable LineAppendable out)
- Specified by:
popState
in interfaceHtmlNodeConverterContext
-
processAttributes
public void processAttributes(@NotNull @NotNull org.jsoup.nodes.Node node)
- Specified by:
processAttributes
in interfaceHtmlNodeConverterContext
-
outputAttributes
public int outputAttributes(@NotNull @NotNull LineAppendable out, @NotNull @NotNull java.lang.String initialSep)
- Specified by:
outputAttributes
in interfaceHtmlNodeConverterContext
-
transferIdToParent
public void transferIdToParent()
- Specified by:
transferIdToParent
in interfaceHtmlNodeConverterContext
-
transferToParentExcept
public void transferToParentExcept(java.lang.String... excludes)
- Specified by:
transferToParentExcept
in interfaceHtmlNodeConverterContext
-
transferToParentOnly
public void transferToParentOnly(java.lang.String... includes)
- Specified by:
transferToParentOnly
in interfaceHtmlNodeConverterContext
-
peek
@Nullable public @Nullable org.jsoup.nodes.Node peek()
- Specified by:
peek
in interfaceHtmlNodeConverterContext
-
peek
@Nullable public @Nullable org.jsoup.nodes.Node peek(int skip)
- Specified by:
peek
in interfaceHtmlNodeConverterContext
-
next
@Nullable public @Nullable org.jsoup.nodes.Node next()
- Specified by:
next
in interfaceHtmlNodeConverterContext
-
skip
public void skip()
- Specified by:
skip
in interfaceHtmlNodeConverterContext
-
next
@Nullable public @Nullable org.jsoup.nodes.Node next(int skip)
- Specified by:
next
in interfaceHtmlNodeConverterContext
-
skip
public void skip(int skip)
- Specified by:
skip
in interfaceHtmlNodeConverterContext
-
delegateRender
public void delegateRender()
- Specified by:
delegateRender
in interfaceHtmlNodeConverterContext
-
getReferenceUrlToReferenceMap
@NotNull public @NotNull java.util.HashMap<java.lang.String,Reference> getReferenceUrlToReferenceMap()
- Specified by:
getReferenceUrlToReferenceMap
in interfaceHtmlNodeConverterContext
-
getExternalReferences
@NotNull public @NotNull java.util.HashSet<Reference> getExternalReferences()
- Specified by:
getExternalReferences
in interfaceHtmlNodeConverterContext
-
getOrCreateReference
public Reference getOrCreateReference(@NotNull @NotNull java.lang.String url, @NotNull @NotNull java.lang.String text, @Nullable @Nullable java.lang.String title)
- Specified by:
getOrCreateReference
in interfaceHtmlNodeConverterContext
-
parseMarkdown
public @NotNull Node parseMarkdown(@NotNull @NotNull java.lang.String markdown)
- Specified by:
parseMarkdown
in interfaceHtmlNodeConverterContext
-
processUnwrapped
public void processUnwrapped(@NotNull @NotNull org.jsoup.nodes.Node element)
- Specified by:
processUnwrapped
in interfaceHtmlNodeConverterContext
-
processWrapped
public void processWrapped(@NotNull @NotNull org.jsoup.nodes.Node node, @Nullable @Nullable java.lang.Boolean isBlock, boolean escapeMarkdown)
- Specified by:
processWrapped
in interfaceHtmlNodeConverterContext
-
appendOuterHtml
public void appendOuterHtml(@NotNull @NotNull org.jsoup.nodes.Node node)
- Specified by:
appendOuterHtml
in interfaceHtmlNodeConverterContext
-
isInlineCode
public boolean isInlineCode()
- Specified by:
isInlineCode
in interfaceHtmlNodeConverterContext
-
setInlineCode
public void setInlineCode(boolean inlineCode)
- Specified by:
setInlineCode
in interfaceHtmlNodeConverterContext
-
inlineCode
public void inlineCode(@NotNull @NotNull java.lang.Runnable inlineRunnable)
- Specified by:
inlineCode
in interfaceHtmlNodeConverterContext
-
escapeSpecialChars
@NotNull public @NotNull java.lang.String escapeSpecialChars(@NotNull @NotNull java.lang.String text)
- Specified by:
escapeSpecialChars
in interfaceHtmlNodeConverterContext
-
prepareText
@NotNull public @NotNull java.lang.String prepareText(@NotNull @NotNull java.lang.String text)
- Specified by:
prepareText
in interfaceHtmlNodeConverterContext
-
prepareText
@NotNull public @NotNull java.lang.String prepareText(@NotNull @NotNull java.lang.String text, boolean inCode)
- Specified by:
prepareText
in interfaceHtmlNodeConverterContext
-
processTextNodes
@NotNull public @NotNull java.lang.String processTextNodes(@NotNull @NotNull org.jsoup.nodes.Node node)
- Specified by:
processTextNodes
in interfaceHtmlNodeConverterContext
-
excludeAttributes
public void excludeAttributes(java.lang.String... excludes)
- Specified by:
excludeAttributes
in interfaceHtmlNodeConverterContext
-
processTextNodes
public void processTextNodes(@NotNull @NotNull org.jsoup.nodes.Node node, boolean stripIdAttribute)
- Specified by:
processTextNodes
in interfaceHtmlNodeConverterContext
-
processTextNodes
public void processTextNodes(@NotNull @NotNull org.jsoup.nodes.Node node, boolean stripIdAttribute, @NotNull @NotNull java.lang.CharSequence wrapText)
- Specified by:
processTextNodes
in interfaceHtmlNodeConverterContext
-
processTextNodes
public void processTextNodes(@NotNull @NotNull org.jsoup.nodes.Node node, boolean stripIdAttribute, @Nullable @Nullable java.lang.CharSequence textPrefix, @Nullable @Nullable java.lang.CharSequence textSuffix)
- Specified by:
processTextNodes
in interfaceHtmlNodeConverterContext
-
wrapTextNodes
public void wrapTextNodes(@NotNull @NotNull org.jsoup.nodes.Node node, @NotNull @NotNull java.lang.CharSequence wrapText, boolean needSpaceAround)
- Specified by:
wrapTextNodes
in interfaceHtmlNodeConverterContext
-
processConditional
public void processConditional(@NotNull @NotNull ExtensionConversion extensionConversion, @NotNull @NotNull org.jsoup.nodes.Node node, @NotNull @NotNull java.lang.Runnable processNode)
- Specified by:
processConditional
in interfaceHtmlNodeConverterContext
-
renderDefault
public void renderDefault(@NotNull @NotNull org.jsoup.nodes.Node node)
- Specified by:
renderDefault
in interfaceHtmlNodeConverterContext
-
getState
public HtmlConverterState getState()
- Specified by:
getState
in interfaceHtmlNodeConverterContext
-
isTrace
public boolean isTrace()
- Specified by:
isTrace
in interfaceHtmlNodeConverterContext
-
setTrace
public void setTrace(boolean trace)
- Specified by:
setTrace
in interfaceHtmlNodeConverterContext
-
getStateStack
@NotNull public @NotNull java.util.Stack<HtmlConverterState> getStateStack()
- Specified by:
getStateStack
in interfaceHtmlNodeConverterContext
-
-