org.opencms.gwt

Class A_CmsClientMessageBundle

java.lang.Object

org.opencms.gwt.A_CmsClientMessageBundle

All Implemented Interfaces:

I_CmsClientMessageBundle

Direct Known Subclasses:

ClientMessages, ClientMessages, ClientMessages, ClientMessages, ClientMessages, ClientMessages, ClientMessages, ClientMessages, ClientMessages

public abstract class A_CmsClientMessageBundle
extends java.lang.Object
implements I_CmsClientMessageBundle

Convenience class to access the localized messages of this OpenCms package.

Intended only for test cases.

Since:

8.0.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IMPORT_PREFIX Prefix for imported message values.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	A_CmsClientMessageBundle() Hides the public constructor for this utility class.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	export(javax.servlet.http.HttpServletRequest request) Returns the JSON code for this resource bundle and the default locale.
java.lang.String	export(java.util.Locale locale) Returns the JSON code for this resource bundle and given locale.
java.lang.String	export(java.util.Locale locale, boolean wrapScript) Returns the JSON code for this resource bundle and given locale.
java.lang.String	export(java.lang.String localeName) Returns the JSON code for this resource bundle and given locale.
java.lang.String	getBundleName() Returns the bundle name for this OpenCms package.
java.lang.Class<?>	getClientImpl() Returns the class of the client implementation.
java.lang.String	importMessage(java.lang.String key, java.util.Locale locale) Imports a message from another bundle.

Methods inherited from class java.lang.Object

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

Field Detail

IMPORT_PREFIX

public static final java.lang.String IMPORT_PREFIX

Prefix for imported message values.

See Also:

Constant Field Values

Constructor Detail

A_CmsClientMessageBundle

protected A_CmsClientMessageBundle()

Hides the public constructor for this utility class.

Method Detail

export

public java.lang.String export(javax.servlet.http.HttpServletRequest request)

Description copied from interface: I_CmsClientMessageBundle

Returns the JSON code for this resource bundle and the default locale.

Specified by:

export in interface I_CmsClientMessageBundle

Parameters:

request - the current request to get the default locale from

Returns:

the JSON code

See Also:

I_CmsClientMessageBundle.export(javax.servlet.http.HttpServletRequest)

export

public java.lang.String export(java.util.Locale locale)

Description copied from interface: I_CmsClientMessageBundle

Returns the JSON code for this resource bundle and given locale.

Specified by:

export in interface I_CmsClientMessageBundle

Parameters:

locale - the locale to export

Returns:

the JSON code

See Also:

I_CmsClientMessageBundle.export(java.util.Locale)

export

public java.lang.String export(java.util.Locale locale,
                      boolean wrapScript)

Description copied from interface: I_CmsClientMessageBundle

Returns the JSON code for this resource bundle and given locale.

Specified by:

export in interface I_CmsClientMessageBundle

Parameters:

locale - the locale to export

wrapScript - true to wrap the data in a script tag

Returns:

the JSON code

See Also:

I_CmsClientMessageBundle.export(java.util.Locale, boolean)

export

public java.lang.String export(java.lang.String localeName)

Description copied from interface: I_CmsClientMessageBundle

Returns the JSON code for this resource bundle and given locale.

Specified by:

export in interface I_CmsClientMessageBundle

Parameters:

localeName - the name of the locale to export

Returns:

the JSON code

See Also:

I_CmsClientMessageBundle.export(java.lang.String)

getBundleName

public java.lang.String getBundleName()

Description copied from interface: I_CmsClientMessageBundle

Returns the bundle name for this OpenCms package.

Specified by:

getBundleName in interface I_CmsClientMessageBundle

Returns:

the bundle name for this OpenCms package

See Also:

I_CmsClientMessageBundle.getBundleName()

getClientImpl

public java.lang.Class<?> getClientImpl()
                                 throws java.lang.Exception

Description copied from interface: I_CmsClientMessageBundle

Returns the class of the client implementation.

Specified by:

getClientImpl in interface I_CmsClientMessageBundle

Returns:

the class of the client implementation

Throws:

java.lang.Exception - if something goes wrong

See Also:

I_CmsClientMessageBundle.getClientImpl()

importMessage

public java.lang.String importMessage(java.lang.String key,
                             java.util.Locale locale)

Imports a message from another bundle.

Parameters:

key - a key of the form classname#MESSAGE_FIELD_NAME

locale - the locale for which to import the message

Returns:

the imported message string