Package com.vladsch.flexmark.formatter

Class Formatter.MainNodeFormatter.SubNodeFormatter

java.lang.Object

com.vladsch.flexmark.formatter.NodeFormatterSubContext

com.vladsch.flexmark.formatter.Formatter.MainNodeFormatter.SubNodeFormatter

All Implemented Interfaces:

ExplicitAttributeIdProvider, NodeFormatterContext, TranslationContext, LinkResolverBasicContext, LinkResolverContext, NodeContext<Node,NodeFormatterContext>

Enclosing class:

Formatter.MainNodeFormatter

private class Formatter.MainNodeFormatter.SubNodeFormatter
extends NodeFormatterSubContext
implements NodeFormatterContext

Field Summary

Fields

Modifier and Type	Field	Description
private FormatterOptions	myFormatterOptions
private Formatter.MainNodeFormatter	myMainNodeRenderer
private DataHolder	myOptions

Fields inherited from class com.vladsch.flexmark.formatter.NodeFormatterSubContext

markdown, rendererIndex, rendererList, renderingNode

Constructor Summary

Constructors

Constructor	Description
SubNodeFormatter(Formatter.MainNodeFormatter mainNodeRenderer, MarkdownWriter out, @Nullable DataHolder options)

Method Summary

Modifier and Type	Method	Description
void	addExplicitId(@NotNull Node node, @Nullable java.lang.String id, @NotNull NodeFormatterContext context, @NotNull MarkdownWriter markdown)	Used by AttributesExtension to insert attributes for headings during merge
void	customPlaceholderFormat(@NotNull TranslationPlaceholderGenerator generator, @NotNull TranslatingSpanRender render)	Temporarily change the format for placeholders
void	delegateRender()	pass node rendering to previously registered handler
@NotNull java.lang.String	encodeUrl(@NotNull java.lang.CharSequence url)
@NotNull BasedSequence	getBlockQuoteLikePrefixChars()
@NotNull CharPredicate	getBlockQuoteLikePrefixPredicate()
@NotNull Node	getCurrentNode()
@NotNull Document	getDocument()
@NotNull FormatterOptions	getFormatterOptions()
@NotNull FormattingPhase	getFormattingPhase()
HtmlIdGenerator	getIdGenerator()
@NotNull MarkdownWriter	getMarkdown()
MergeContext	getMergeContext()
@NotNull DataHolder	getOptions()	Get the current rendering context DataHolder.
@NotNull RenderPurpose	getRenderPurpose()	Get the reason this format rendering is being performed
@NotNull NodeFormatterContext	getSubContext()	Creates a child rendering context that can be used to collect rendered html text.
@NotNull NodeFormatterContext	getSubContext(@Nullable DataHolder options)	Creates a child rendering context that can be used to collect rendered html text.
@NotNull NodeFormatterContext	getSubContext(@Nullable DataHolder options, @NotNull ISequenceBuilder<?,?> builder)	Creates a child rendering context that can be used to collect rendered html text.
@NotNull TrackedOffsetList	getTrackedOffsets()	Sub-context does not have offset tracking
@NotNull BasedSequence	getTrackedSequence()	NOTE: parser can only use a contiguous sequence, not segmented.
@NotNull MutableDataHolder	getTranslationStore()	Get MutableDataHolder for storing this translation run values across render purpose phases
boolean	isPostProcessingNonTranslating()
boolean	isRestoreTrackedSpaces()
boolean	isTransformingText()	Returns false if special translation functions are no-ops
@NotNull java.lang.Iterable<? extends Node>	nodesOfType(@NotNull java.lang.Class<?>[] classes)	Get iterable of nodes of given types, in order of their appearance in the document tree, depth first traversal.
@NotNull java.lang.Iterable<? extends Node>	nodesOfType(@NotNull java.util.Collection<java.lang.Class<?>> classes)
void	nonTranslatingSpan(@NotNull TranslatingSpanRender render)	Separate non-translation span.
void	postProcessNonTranslating(@NotNull java.util.function.Function<java.lang.String,java.lang.CharSequence> postProcessor, @NotNull java.lang.Runnable scope)
<T> T	postProcessNonTranslating(@NotNull java.util.function.Function<java.lang.String,java.lang.CharSequence> postProcessor, @NotNull java.util.function.Supplier<T> scope)
void	render(@NotNull Node node)	Render the specified node and its children using the configured renderers.
void	renderChildren(@NotNull Node parent)	Render the children of the node, used by custom renderers
@NotNull ResolvedLink	resolveLink(@NotNull LinkType linkType, @NotNull java.lang.CharSequence url, Attributes attributes, java.lang.Boolean urlEncode)	Resolve link for rendering.
@NotNull ResolvedLink	resolveLink(@NotNull LinkType linkType, @NotNull java.lang.CharSequence url, java.lang.Boolean urlEncode)	Resolve link for rendering.
@NotNull java.lang.Iterable<? extends Node>	reversedNodesOfType(@NotNull java.lang.Class<?>[] classes)	Get iterable of nodes of given types, in reverse order of their appearance in the document tree, depth first traversal.
@NotNull java.lang.Iterable<? extends Node>	reversedNodesOfType(@NotNull java.util.Collection<java.lang.Class<?>> classes)
@NotNull java.lang.CharSequence	transformAnchorRef(@NotNull java.lang.CharSequence pageRef, @NotNull java.lang.CharSequence anchorRef)	During RenderPurpose.TRANSLATION_SPANS this converts anchorRef to ordinal placeholder id During RenderPurpose.TRANSLATED_SPANS this returns the ordinal placeholder During RenderPurpose.TRANSLATED this returns new anchorRef for the AnchorRefTarget original was referring to
@NotNull java.lang.CharSequence	transformNonTranslating(java.lang.CharSequence prefix, @NotNull java.lang.CharSequence nonTranslatingText, java.lang.CharSequence suffix, java.lang.CharSequence suffix2)	Transform non-translating text
@NotNull java.lang.CharSequence	transformTranslating(java.lang.CharSequence prefix, @NotNull java.lang.CharSequence translatingText, java.lang.CharSequence suffix, java.lang.CharSequence suffix2)	Transform translating text but which is contextually isolated from the text block in which it is located ie.
void	translatingRefTargetSpan(@Nullable Node target, @NotNull TranslatingSpanRender render)	Separate translation span which is also a ref target
void	translatingSpan(@NotNull TranslatingSpanRender render)	Separate translation span.

Methods inherited from class com.vladsch.flexmark.formatter.NodeFormatterSubContext

flushTo, flushTo, getRenderingNode, setRenderingNode

Methods inherited from class java.lang.Object

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

Field Detail

myMainNodeRenderer

private final Formatter.MainNodeFormatter myMainNodeRenderer

myOptions

private final DataHolder myOptions

myFormatterOptions

private final FormatterOptions myFormatterOptions

Constructor Detail

SubNodeFormatter

public SubNodeFormatter(Formatter.MainNodeFormatter mainNodeRenderer,
                        MarkdownWriter out,
                        @Nullable
                        @Nullable DataHolder options)

Method Detail

getTranslationStore

@NotNull
public @NotNull MutableDataHolder getTranslationStore()

Description copied from interface: TranslationContext

Get MutableDataHolder for storing this translation run values across render purpose phases

Specified by:

getTranslationStore in interface TranslationContext

nodesOfType

@NotNull
public final @NotNull java.lang.Iterable<? extends Node> nodesOfType(@NotNull
                                                                     @NotNull java.lang.Class<?>[] classes)

Description copied from interface: NodeFormatterContext

Get iterable of nodes of given types, in order of their appearance in the document tree, depth first traversal. Only node classes returned by NodeFormatter.getNodeClasses() of all loaded extensions will be available to formatters.

CoreNodeFormatter registers RefNode if Formatter.REFERENCE_SORT is set to ElementPlacementSort.SORT_UNUSED_LAST so that

Specified by:

nodesOfType in interface NodeFormatterContext

Parameters:

classes - node classes to return

Returns:

iterable

nodesOfType

@NotNull
public final @NotNull java.lang.Iterable<? extends Node> nodesOfType(@NotNull
                                                                     @NotNull java.util.Collection<java.lang.Class<?>> classes)

Specified by:

nodesOfType in interface NodeFormatterContext

reversedNodesOfType

@NotNull
public final @NotNull java.lang.Iterable<? extends Node> reversedNodesOfType(@NotNull
                                                                             @NotNull java.lang.Class<?>[] classes)

Description copied from interface: NodeFormatterContext

Get iterable of nodes of given types, in reverse order of their appearance in the document tree, depth first traversal. Only node classes returned by NodeFormatter.getNodeClasses() of all loaded extensions will be available to formatters.

CoreNodeFormatter registers RefNode if Formatter.REFERENCE_SORT is set to ElementPlacementSort.SORT_UNUSED_LAST so that

Specified by:

reversedNodesOfType in interface NodeFormatterContext

Parameters:

classes - node classes to return

Returns:

iterable

reversedNodesOfType

@NotNull
public final @NotNull java.lang.Iterable<? extends Node> reversedNodesOfType(@NotNull
                                                                             @NotNull java.util.Collection<java.lang.Class<?>> classes)

Specified by:

reversedNodesOfType in interface NodeFormatterContext

getOptions

@NotNull
public @NotNull DataHolder getOptions()

Description copied from interface: NodeFormatterContext

Get the current rendering context DataHolder. These are the options passed or set on the Formatter.builder() or passed to Formatter.builder(DataHolder). To get the document options you should use NodeFormatterContext.getDocument() as the data holder.

Specified by:

getOptions in interface LinkResolverBasicContext

Specified by:

getOptions in interface LinkResolverContext

Specified by:

getOptions in interface NodeContext<Node,NodeFormatterContext>

Specified by:

getOptions in interface NodeFormatterContext

Returns:

the current renderer options DataHolder

getFormatterOptions

@NotNull
public @NotNull FormatterOptions getFormatterOptions()

Specified by:

getFormatterOptions in interface NodeFormatterContext

Returns:

the FormatterOptions for the context.

getDocument

@NotNull
public @NotNull Document getDocument()

Specified by:

getDocument in interface LinkResolverBasicContext

Specified by:

getDocument in interface LinkResolverContext

Specified by:

getDocument in interface NodeFormatterContext

Returns:

the Document node of the current context

getBlockQuoteLikePrefixPredicate

@NotNull
public @NotNull CharPredicate getBlockQuoteLikePrefixPredicate()

Specified by:

getBlockQuoteLikePrefixPredicate in interface NodeFormatterContext

Returns:

predicate for prefix chars which compact like block quote prefix char

getBlockQuoteLikePrefixChars

@NotNull
public @NotNull BasedSequence getBlockQuoteLikePrefixChars()

Specified by:

getBlockQuoteLikePrefixChars in interface NodeFormatterContext

Returns:

char sequence of all prefix chars which compact like block quote prefix char

getTrackedOffsets

@NotNull
public @NotNull TrackedOffsetList getTrackedOffsets()

Sub-context does not have offset tracking

Specified by:

getTrackedOffsets in interface NodeFormatterContext

Returns:

empty lise

isRestoreTrackedSpaces

public boolean isRestoreTrackedSpaces()

Specified by:

isRestoreTrackedSpaces in interface NodeFormatterContext

getTrackedSequence

@NotNull
public @NotNull BasedSequence getTrackedSequence()

Description copied from interface: NodeFormatterContext

NOTE: parser can only use a contiguous sequence, not segmented. Therefore, the AST offsets and base sequence from AST nodes has always an index into sequence equal to the offset. This sequence is set to not BasedSequence.NULL when the format sequence used for tracked offsets is not contiguous and TrackedOffset.offset is an offset from this sequence and need to be converted to index into this sequence to be used as an offset into AST sequence for offset conversion

Specified by:

getTrackedSequence in interface NodeFormatterContext

Returns:

original sequence used for tracked offsets.

getFormattingPhase

@NotNull
public @NotNull FormattingPhase getFormattingPhase()

Specified by:

getFormattingPhase in interface NodeFormatterContext

Returns:

current rendering phase

render

public void render(@NotNull
                   @NotNull Node node)

Description copied from interface: NodeFormatterContext

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 LinkResolverContext

Specified by:

render in interface NodeFormatterContext

Parameters:

node - the node to render

getCurrentNode

@NotNull
public @NotNull Node getCurrentNode()

Specified by:

getCurrentNode in interface LinkResolverContext

Specified by:

getCurrentNode in interface NodeContext<Node,NodeFormatterContext>

Returns:

the current node being rendered

delegateRender

public void delegateRender()

Description copied from interface: NodeFormatterContext

pass node rendering to previously registered handler

Specified by:

delegateRender in interface NodeFormatterContext

getSubContext

@NotNull
public @NotNull NodeFormatterContext getSubContext()

Description copied from interface: NodeContext

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<Node,NodeFormatterContext>

Returns:

a new rendering context with a given appendable for its output

getSubContext

@NotNull
public @NotNull NodeFormatterContext getSubContext(@Nullable
                                                   @Nullable DataHolder options)

Description copied from interface: NodeContext

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<Node,NodeFormatterContext>

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

Description copied from interface: NodeContext

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<Node,NodeFormatterContext>

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 Node parent)

Description copied from interface: NodeFormatterContext

Render the children of the node, used by custom renderers

Specified by:

renderChildren in interface LinkResolverContext

Specified by:

renderChildren in interface NodeFormatterContext

Parameters:

parent - node the children of which are to be rendered

getMarkdown

@NotNull
public @NotNull MarkdownWriter getMarkdown()

Specified by:

getMarkdown in interface NodeFormatterContext

Overrides:

getMarkdown in class NodeFormatterSubContext

Returns:

the HTML writer to use

getRenderPurpose

@NotNull
public @NotNull RenderPurpose getRenderPurpose()

Description copied from interface: TranslationContext

Get the reason this format rendering is being performed

Specified by:

getRenderPurpose in interface TranslationContext

Returns:

RenderPurpose for current rendering

isTransformingText

public boolean isTransformingText()

Description copied from interface: TranslationContext

Returns false if special translation functions are no-ops

During RenderPurpose.TRANSLATION_SPANS this is true During RenderPurpose.TRANSLATED_SPANS this is true During RenderPurpose.TRANSLATED this is true

Specified by:

isTransformingText in interface TranslationContext

Returns:

true if need to call translation related functions

transformNonTranslating

@NotNull
public @NotNull java.lang.CharSequence transformNonTranslating(java.lang.CharSequence prefix,
                                                               @NotNull
                                                               @NotNull java.lang.CharSequence nonTranslatingText,
                                                               java.lang.CharSequence suffix,
                                                               java.lang.CharSequence suffix2)

Description copied from interface: TranslationContext

Transform non-translating text

During RenderPurpose.TRANSLATION_SPANS this converts text to non-translating placeholder based on ordinal id During RenderPurpose.TRANSLATED_SPANS this returns the non-translating placeholder based on ordinal id During RenderPurpose.TRANSLATED this returns the original non-translating text for the nonTranslatingText (placeholder)

Specified by:

transformNonTranslating in interface TranslationContext

Parameters:

prefix - prefix to use on non-translating placeholder so it is interpreted as a proper element during parsing

nonTranslatingText - non-rendering text of the node (content will depend on translation phase)

suffix - suffix to use on non-translating placeholder so it is interpreted as a proper element during parsing

suffix2 - suffix to use on non-translating placeholder so it is interpreted as a proper element during parsing

Returns:

text to be used in rendering for this phase

transformTranslating

@NotNull
public @NotNull java.lang.CharSequence transformTranslating(java.lang.CharSequence prefix,
                                                            @NotNull
                                                            @NotNull java.lang.CharSequence translatingText,
                                                            java.lang.CharSequence suffix,
                                                            java.lang.CharSequence suffix2)

Description copied from interface: TranslationContext

Transform translating text but which is contextually isolated from the text block in which it is located ie. link reference or image reference

During RenderPurpose.TRANSLATION_SPANS this converts text to non-translating placeholder based on ordinal id and adds it to translation snippets During RenderPurpose.TRANSLATED_SPANS this returns the non-translating placeholder based on ordinal id During RenderPurpose.TRANSLATED this returns the translated text for the translatingText (placeholder)

Specified by:

transformTranslating in interface TranslationContext

Parameters:

prefix - prefix to use on non-translating placeholder so it is interpreted as a proper element during parsing

translatingText - translating but isolated text of the node (content will depend on translation phase)

suffix - suffix to use on non-translating placeholder so it is interpreted as a proper element during parsing

suffix2 - suffix to use on non-translating placeholder so it is interpreted as a proper element during parsing

Returns:

text to be used in rendering for this phase

transformAnchorRef

@NotNull
public @NotNull java.lang.CharSequence transformAnchorRef(@NotNull
                                                          @NotNull java.lang.CharSequence pageRef,
                                                          @NotNull
                                                          @NotNull java.lang.CharSequence anchorRef)

Description copied from interface: TranslationContext

During RenderPurpose.TRANSLATION_SPANS this converts anchorRef to ordinal placeholder id During RenderPurpose.TRANSLATED_SPANS this returns the ordinal placeholder During RenderPurpose.TRANSLATED this returns new anchorRef for the AnchorRefTarget original was referring to

Specified by:

transformAnchorRef in interface TranslationContext

Parameters:

pageRef - url part without the anchor ref to resolve reference

anchorRef - anchor ref

Returns:

anchorRef for the phase to be used for rendering

translatingSpan

public void translatingSpan(@NotNull
                            @NotNull TranslatingSpanRender render)

Description copied from interface: TranslationContext

Separate translation span. Will generate a paragraph of text which should be translated as one piece

During RenderPurpose.TRANSLATION_SPANS this adds the generated output to translation spans During RenderPurpose.TRANSLATED_SPANS output from renderer is suppressed, instead outputs corresponding translated span During RenderPurpose.TRANSLATED calls render

Specified by:

translatingSpan in interface TranslationContext

nonTranslatingSpan

public void nonTranslatingSpan(@NotNull
                               @NotNull TranslatingSpanRender render)

Description copied from interface: TranslationContext

Separate non-translation span. Will generate a paragraph of text which will not be translated

During RenderPurpose.TRANSLATION_SPANS this adds the generated output to translation spans During RenderPurpose.TRANSLATED_SPANS output from renderer is suppressed, instead outputs corresponding translated span During RenderPurpose.TRANSLATED calls render

Specified by:

nonTranslatingSpan in interface TranslationContext

translatingRefTargetSpan

public void translatingRefTargetSpan(@Nullable
                                     @Nullable Node target,
                                     @NotNull
                                     @NotNull TranslatingSpanRender render)

Description copied from interface: TranslationContext

Separate translation span which is also a ref target

Specified by:

translatingRefTargetSpan in interface TranslationContext

Parameters:

target - target node,

customPlaceholderFormat

public void customPlaceholderFormat(@NotNull
                                    @NotNull TranslationPlaceholderGenerator generator,
                                    @NotNull
                                    @NotNull TranslatingSpanRender render)

Description copied from interface: TranslationContext

Temporarily change the format for placeholders

Specified by:

customPlaceholderFormat in interface TranslationContext

Parameters:

generator - placeholder generator

render - render which will be used with the custom generator

encodeUrl

@NotNull
public @NotNull java.lang.String encodeUrl(@NotNull
                                           @NotNull java.lang.CharSequence url)

Specified by:

encodeUrl in interface LinkResolverContext

Parameters:

url - to be encoded

Returns:

an encoded URL (depending on the configuration)

resolveLink

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

Description copied from interface: LinkResolverContext

Resolve link for rendering. Link Resolvers are going to be called until one returns ResolvedLink with getStatus() != LinkStatus.Unknown

A resolver can replace the url but not change the status letting downstream resolvers handle the rest. This is useful when a resolver does partial processing like macro expansion but does not know how to handle the rest.

Core processing will simply pass the link as is. It is up to extension LinkResolvers and AttributeProviders to make sense of the link and applicable attributes based on status.

Specified by:

resolveLink in interface LinkResolverContext

Parameters:

linkType - type of link being rendered. Core defined links are Link, Image. Extensions can define their own

url - link url text

urlEncode - whether the link should be url encoded, if null then the value of HtmlRenderer.PERCENT_ENCODE_URLS will be used to determine whether the resolved URL is to be encoded.

Returns:

resolved link url for this link and its resolved status

resolveLink

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

Description copied from interface: LinkResolverContext

Resolve link for rendering. Link Resolvers are going to be called until one returns ResolvedLink with getStatus() != LinkStatus.Unknown

A resolver can replace the url but not change the status letting downstream resolvers handle the rest. This is useful when a resolver does partial processing like macro expansion but does not know how to handle the rest.

Core processing will simply pass the link as is. It is up to extension LinkResolvers and AttributeProviders to make sense of the link and applicable attributes based on status.

Specified by:

resolveLink in interface LinkResolverContext

Parameters:

linkType - type of link being rendered. Core defined links are Link, Image. Extensions can define their own

url - link url text

attributes - link attributes

urlEncode - whether the link should be url encoded, if null then the value of HtmlRenderer.PERCENT_ENCODE_URLS will be used to determine whether the resolved URL is to be encoded.

Returns:

resolved link url for this link and its resolved status

postProcessNonTranslating

public void postProcessNonTranslating(@NotNull
                                      @NotNull java.util.function.Function<java.lang.String,java.lang.CharSequence> postProcessor,
                                      @NotNull
                                      @NotNull java.lang.Runnable scope)

Specified by:

postProcessNonTranslating in interface TranslationContext

Parameters:

postProcessor - id post processor for TRANSLATED purpose

scope - code to which the post processor applies

postProcessNonTranslating

@NotNull
public <T> T postProcessNonTranslating(@NotNull
                                       @NotNull java.util.function.Function<java.lang.String,java.lang.CharSequence> postProcessor,
                                       @NotNull
                                       @NotNull java.util.function.Supplier<T> scope)

Specified by:

postProcessNonTranslating in interface TranslationContext

Parameters:

postProcessor - id post processor for TRANSLATED purpose

scope - code to which the post processor applies

isPostProcessingNonTranslating

public boolean isPostProcessingNonTranslating()

Specified by:

isPostProcessingNonTranslating in interface TranslationContext

Returns:

true if non-translating post processor is set

getMergeContext

public MergeContext getMergeContext()

Specified by:

getMergeContext in interface TranslationContext

addExplicitId

public void addExplicitId(@NotNull
                          @NotNull Node node,
                          @Nullable
                          @Nullable java.lang.String id,
                          @NotNull
                          @NotNull NodeFormatterContext context,
                          @NotNull
                          @NotNull MarkdownWriter markdown)

Description copied from interface: ExplicitAttributeIdProvider

Used by AttributesExtension to insert attributes for headings during merge

Specified by:

addExplicitId in interface ExplicitAttributeIdProvider

Parameters:

node - node

id - explicit id

context - context

markdown - markdown writer

getIdGenerator

public HtmlIdGenerator getIdGenerator()

Specified by:

getIdGenerator in interface TranslationContext