com.vladsch.flexmark.formatter

Interface TranslationContext

All Known Subinterfaces:

NodeFormatterContext, TranslationHandler, TranslationHandlerFactory

All Known Implementing Classes:

NodeFormatterSubContext, TranslationHandlerImpl

public interface TranslationContext

Method Summary

Modifier and Type	Method and Description
void	customPlaceholderFormat(TranslationPlaceholderGenerator generator, TranslatingSpanRender render) Temporarily change the format for placeholders
RenderPurpose	getRenderPurpose() Get the reason this format rendering is being performed
com.vladsch.flexmark.util.options.MutableDataHolder	getTranslationStore() Get MutableDataHolder for storing this translation run values across render purpose phases
boolean	isTransformingText() 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
void	nonTranslatingSpan(TranslatingSpanRender render) Separate non-translation span.
CharSequence	transformAnchorRef(CharSequence pageRef, 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
CharSequence	transformNonTranslating(CharSequence prefix, CharSequence nonTranslatingText, CharSequence suffix, CharSequence suffix2) 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)
CharSequence	transformTranslating(CharSequence prefix, CharSequence translatingText, CharSequence suffix, CharSequence suffix2) Transform translating text but which is contextually isolated from the text block in which it is located ie.
void	translatingRefTargetSpan(com.vladsch.flexmark.ast.Node target, TranslatingSpanRender render) Separate translation span which is also a ref target
void	translatingSpan(TranslatingSpanRender render) Separate translation span.

Method Detail

getRenderPurpose

RenderPurpose getRenderPurpose()

Get the reason this format rendering is being performed

Returns:

RenderPurpose for current rendering

getTranslationStore

com.vladsch.flexmark.util.options.MutableDataHolder getTranslationStore()

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

isTransformingText

boolean isTransformingText()

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

Returns:

true if need to call translation related functions

transformNonTranslating

CharSequence transformNonTranslating(CharSequence prefix,
                                     CharSequence nonTranslatingText,
                                     CharSequence suffix,
                                     CharSequence suffix2)

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)

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

CharSequence transformTranslating(CharSequence prefix,
                                  CharSequence translatingText,
                                  CharSequence suffix,
                                  CharSequence suffix2)

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)

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

CharSequence transformAnchorRef(CharSequence pageRef,
                                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

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

void translatingSpan(TranslatingSpanRender render)

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

nonTranslatingSpan

void nonTranslatingSpan(TranslatingSpanRender render)

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

translatingRefTargetSpan

void translatingRefTargetSpan(com.vladsch.flexmark.ast.Node target,
                              TranslatingSpanRender render)

Separate translation span which is also a ref target

Parameters:

target -

render -

customPlaceholderFormat

void customPlaceholderFormat(TranslationPlaceholderGenerator generator,
                             TranslatingSpanRender render)

Temporarily change the format for placeholders

Parameters:

generator - placeholder generator

render - render which will be used with the custom generator