com.atlassian.jira.util.i18n
Interface I18nTranslationMode

All Known Implementing Classes:

I18nTranslationModeImpl

public interface I18nTranslationMode

This allows a plugin or JIRA to set a special translations mode flag on for the current thread. The I18n text generated after that will be is a special meta data mode.

JIRA will check the HttpServletRequest for sensibleness however and hence it may not be set.

Since:

4.3

Method Summary

boolean	isTranslationMode()
void	setTranslationsModeOff() Turns off the i18n translations mode for this thread.
void	setTranslationsModeOn(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse) Attempts to turn on the i18n translations mode.

Method Detail

isTranslationMode

boolean isTranslationMode()

Returns:

true if the I18n translations mode is on for this thread

setTranslationsModeOn

void setTranslationsModeOn(javax.servlet.http.HttpServletRequest httpServletRequest,
                           javax.servlet.http.HttpServletResponse httpServletResponse)

Attempts to turn on the i18n translations mode. JIRA may decide that its not sensible to turn it on

Parameters:

httpServletRequest - the request in play

httpServletResponse - the response in play

setTranslationsModeOff

void setTranslationsModeOff()

Turns off the i18n translations mode for this thread.