|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.report.model.api.ElementDetailHandle
org.eclipse.birt.report.model.api.TranslationHandle
public class TranslationHandle
Represents a translation message in the design. A translation message is used for the user to save their localized information in the design.
TranslationTable
Field Summary | |
---|---|
protected org.eclipse.birt.report.model.elements.Translation |
translation
The translation message. |
Fields inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle |
---|
elementHandle |
Constructor Summary | |
---|---|
TranslationHandle(ModuleHandle moduleHandle,
org.eclipse.birt.report.model.elements.Translation trans)
Constructs a handle for a translation message. |
Method Summary | |
---|---|
java.lang.String |
getLocale()
Returns the locale of the translation message. |
java.lang.String |
getResourceKey()
Returns the resource key of the translation. |
java.lang.String |
getText()
Returns translated text for the translation, the text defined for the locale. |
void |
setLocale(java.lang.String newLocale)
Sets the locale of the translation message. |
void |
setText(java.lang.String text)
Sets the translated text for the translation message. |
Methods inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle |
---|
getDesign, getElement, getElementHandle, getModule |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected org.eclipse.birt.report.model.elements.Translation translation
Constructor Detail |
---|
public TranslationHandle(ModuleHandle moduleHandle, org.eclipse.birt.report.model.elements.Translation trans)
moduleHandle
- a handle to a moduletrans
- the translation instance to be handled.Method Detail |
---|
public java.lang.String getResourceKey()
public void setLocale(java.lang.String newLocale) throws CustomMsgException
newLocale
- new locale of the translation
CustomMsgException
- if the translation message is not found in the design.public java.lang.String getLocale()
public void setText(java.lang.String text) throws CustomMsgException
text
- translated text for the locale.
CustomMsgException
- if the translation message is not found in the design.public java.lang.String getText()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |