com.vladsch.flexmark.formatter.internal

Class TranslationHandlerImpl

java.lang.Object

com.vladsch.flexmark.formatter.internal.TranslationHandlerImpl

All Implemented Interfaces:

TranslationContext, TranslationHandler

public class TranslationHandlerImpl
extends Object
implements TranslationHandler

Constructor Summary

Constructors

Constructor and Description
TranslationHandlerImpl(com.vladsch.flexmark.util.options.DataHolder options, FormatterOptions formatterOptions, com.vladsch.flexmark.html.renderer.HtmlIdGeneratorFactory idGeneratorFactory)

Method Summary

Modifier and Type	Method and Description
static String	addPrefixSuffix(CharSequence placeholderId, CharSequence prefix, CharSequence suffix, CharSequence suffix2)
void	beginRendering(com.vladsch.flexmark.ast.Document node, NodeFormatterContext context, MarkdownWriter appendable)
void	customPlaceholderFormat(TranslationPlaceholderGenerator generator, TranslatingSpanRender render) Temporarily change the format for placeholders
String	getPlaceholderId(String format, int placeholderId, CharSequence prefix, CharSequence suffix, CharSequence suffix2)
RenderPurpose	getRenderPurpose() Get the reason this format rendering is being performed
List<String>	getTranslatingTexts()
com.vladsch.flexmark.util.options.MutableDataSet	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.
void	setRenderPurpose(RenderPurpose renderPurpose)
void	setTranslatedTexts(List<CharSequence> translatedTexts)
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

TranslationHandlerImpl

public TranslationHandlerImpl(com.vladsch.flexmark.util.options.DataHolder options,
                              FormatterOptions formatterOptions,
                              com.vladsch.flexmark.html.renderer.HtmlIdGeneratorFactory idGeneratorFactory)

Method Detail

getTranslationStore

public com.vladsch.flexmark.util.options.MutableDataSet getTranslationStore()

Description copied from interface: TranslationContext

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

Specified by:

getTranslationStore in interface TranslationContext

beginRendering

public void beginRendering(com.vladsch.flexmark.ast.Document node,
                           NodeFormatterContext context,
                           MarkdownWriter appendable)

Specified by:

beginRendering in interface TranslationHandler

getTranslatingTexts

public List<String> getTranslatingTexts()

Specified by:

getTranslatingTexts in interface TranslationHandler

setTranslatedTexts

public void setTranslatedTexts(List<CharSequence> translatedTexts)

Specified by:

setTranslatedTexts in interface TranslationHandler

setRenderPurpose

public void setRenderPurpose(RenderPurpose renderPurpose)

Specified by:

setRenderPurpose in interface TranslationHandler

getRenderPurpose

public 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

transformAnchorRef

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

customPlaceholderFormat

public void customPlaceholderFormat(TranslationPlaceholderGenerator generator,
                                    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

translatingSpan

public void translatingSpan(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

translatingRefTargetSpan

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

Description copied from interface: TranslationContext

Separate translation span which is also a ref target

Specified by:

translatingRefTargetSpan in interface TranslationContext

nonTranslatingSpan

public void nonTranslatingSpan(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

getPlaceholderId

public String getPlaceholderId(String format,
                               int placeholderId,
                               CharSequence prefix,
                               CharSequence suffix,
                               CharSequence suffix2)

addPrefixSuffix

public static String addPrefixSuffix(CharSequence placeholderId,
                                     CharSequence prefix,
                                     CharSequence suffix,
                                     CharSequence suffix2)

transformNonTranslating

public CharSequence transformNonTranslating(CharSequence prefix,
                                            CharSequence nonTranslatingText,
                                            CharSequence suffix,
                                            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

public CharSequence transformTranslating(CharSequence prefix,
                                         CharSequence translatingText,
                                         CharSequence suffix,
                                         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