Interface TranslationContext
-
- All Known Subinterfaces:
NodeFormatterContext
,TranslationHandler
,TranslationHandlerFactory
- All Known Implementing Classes:
NodeFormatterSubContext
public interface TranslationContext
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
customPlaceholderFormat(@NotNull TranslationPlaceholderGenerator generator, @NotNull TranslatingSpanRender render)
Temporarily change the format for placeholders@Nullable HtmlIdGenerator
getIdGenerator()
@Nullable MergeContext
getMergeContext()
@NotNull RenderPurpose
getRenderPurpose()
Get the reason this format rendering is being performed@NotNull com.vladsch.flexmark.util.data.MutableDataHolder
getTranslationStore()
Get MutableDataHolder for storing this translation run values across render purpose phasesboolean
isPostProcessingNonTranslating()
boolean
isTransformingText()
Returns false if special translation functions are no-opsvoid
nonTranslatingSpan(@NotNull TranslatingSpanRender render)
Separate non-translation span.void
postProcessNonTranslating(@NotNull Function<String,CharSequence> postProcessor, @NotNull Runnable scope)
<T> T
postProcessNonTranslating(@NotNull Function<String,CharSequence> postProcessor, @NotNull Supplier<T> scope)
@NotNull CharSequence
transformAnchorRef(@NotNull CharSequence pageRef, @NotNull CharSequence anchorRef)
DuringRenderPurpose.TRANSLATION_SPANS
this converts anchorRef to ordinal placeholder id DuringRenderPurpose.TRANSLATED_SPANS
this returns the ordinal placeholder DuringRenderPurpose.TRANSLATED
this returns new anchorRef for the AnchorRefTarget original was referring to@NotNull CharSequence
transformNonTranslating(@Nullable CharSequence prefix, @NotNull CharSequence nonTranslatingText, @Nullable CharSequence suffix, @Nullable CharSequence suffix2)
Transform non-translating text@NotNull CharSequence
transformTranslating(@Nullable CharSequence prefix, @NotNull CharSequence translatingText, @Nullable CharSequence suffix, @Nullable CharSequence suffix2)
Transform translating text but which is contextually isolated from the text block in which it is located ie.void
translatingRefTargetSpan(@Nullable com.vladsch.flexmark.util.ast.Node target, @NotNull TranslatingSpanRender render)
Separate translation span which is also a ref targetvoid
translatingSpan(@NotNull TranslatingSpanRender render)
Separate translation span.
-
-
-
Method Detail
-
getIdGenerator
@Nullable @Nullable HtmlIdGenerator getIdGenerator()
-
getRenderPurpose
@NotNull @NotNull RenderPurpose getRenderPurpose()
Get the reason this format rendering is being performed- Returns:
- RenderPurpose for current rendering
-
getTranslationStore
@NotNull @NotNull com.vladsch.flexmark.util.data.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-opsDuring
RenderPurpose.TRANSLATION_SPANS
this is true DuringRenderPurpose.TRANSLATED_SPANS
this is true DuringRenderPurpose.TRANSLATED
this is true- Returns:
- true if need to call translation related functions
-
transformNonTranslating
@NotNull @NotNull CharSequence transformNonTranslating(@Nullable @Nullable CharSequence prefix, @NotNull @NotNull CharSequence nonTranslatingText, @Nullable @Nullable CharSequence suffix, @Nullable @Nullable CharSequence suffix2)
Transform non-translating textDuring
RenderPurpose.TRANSLATION_SPANS
this converts text to non-translating placeholder based on ordinal id DuringRenderPurpose.TRANSLATED_SPANS
this returns the non-translating placeholder based on ordinal id DuringRenderPurpose.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 parsingnonTranslatingText
- 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 parsingsuffix2
- 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
-
postProcessNonTranslating
void postProcessNonTranslating(@NotNull @NotNull Function<String,CharSequence> postProcessor, @NotNull @NotNull Runnable scope)
- Parameters:
postProcessor
- id post processor for TRANSLATED purposescope
- code to which the post processor applies
-
postProcessNonTranslating
@NotNull <T> T postProcessNonTranslating(@NotNull @NotNull Function<String,CharSequence> postProcessor, @NotNull @NotNull Supplier<T> scope)
- Parameters:
postProcessor
- id post processor for TRANSLATED purposescope
- code to which the post processor applies
-
isPostProcessingNonTranslating
boolean isPostProcessingNonTranslating()
- Returns:
- true if non-translating post processor is set
-
transformTranslating
@NotNull @NotNull CharSequence transformTranslating(@Nullable @Nullable CharSequence prefix, @NotNull @NotNull CharSequence translatingText, @Nullable @Nullable CharSequence suffix, @Nullable @Nullable CharSequence suffix2)
Transform translating text but which is contextually isolated from the text block in which it is located ie. link reference or image referenceDuring
RenderPurpose.TRANSLATION_SPANS
this converts text to non-translating placeholder based on ordinal id and adds it to translation snippets DuringRenderPurpose.TRANSLATED_SPANS
this returns the non-translating placeholder based on ordinal id DuringRenderPurpose.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 parsingtranslatingText
- 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 parsingsuffix2
- 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 @NotNull CharSequence transformAnchorRef(@NotNull @NotNull CharSequence pageRef, @NotNull @NotNull CharSequence anchorRef)
DuringRenderPurpose.TRANSLATION_SPANS
this converts anchorRef to ordinal placeholder id DuringRenderPurpose.TRANSLATED_SPANS
this returns the ordinal placeholder DuringRenderPurpose.TRANSLATED
this returns new anchorRef for the AnchorRefTarget original was referring to- Parameters:
pageRef
- url part without the anchor ref to resolve referenceanchorRef
- anchor ref- Returns:
- anchorRef for the phase to be used for rendering
-
translatingSpan
void translatingSpan(@NotNull @NotNull TranslatingSpanRender render)
Separate translation span. Will generate a paragraph of text which should be translated as one pieceDuring
RenderPurpose.TRANSLATION_SPANS
this adds the generated output to translation spans DuringRenderPurpose.TRANSLATED_SPANS
output from renderer is suppressed, instead outputs corresponding translated span DuringRenderPurpose.TRANSLATED
calls render
-
nonTranslatingSpan
void nonTranslatingSpan(@NotNull @NotNull TranslatingSpanRender render)
Separate non-translation span. Will generate a paragraph of text which will not be translatedDuring
RenderPurpose.TRANSLATION_SPANS
this adds the generated output to translation spans DuringRenderPurpose.TRANSLATED_SPANS
output from renderer is suppressed, instead outputs corresponding translated span DuringRenderPurpose.TRANSLATED
calls render
-
translatingRefTargetSpan
void translatingRefTargetSpan(@Nullable @Nullable com.vladsch.flexmark.util.ast.Node target, @NotNull @NotNull TranslatingSpanRender render)
Separate translation span which is also a ref target- Parameters:
target
- target node,render
-
-
customPlaceholderFormat
void customPlaceholderFormat(@NotNull @NotNull TranslationPlaceholderGenerator generator, @NotNull @NotNull TranslatingSpanRender render)
Temporarily change the format for placeholders- Parameters:
generator
- placeholder generatorrender
- render which will be used with the custom generator
-
getMergeContext
@Nullable @Nullable MergeContext getMergeContext()
-
-