Package org.opencms.gwt

Interface I_CmsClientMessageBundle

All Known Implementing Classes:
A_CmsClientMessageBundle, ClientMessages, ClientMessages, ClientMessages, ClientMessages, ClientMessages, ClientMessages, ClientMessages, ClientMessages, ClientMessages
public interface I_CmsClientMessageBundle
Convenient client message bundle interface.

Since:
8.0.0
See Also:

  • Method Summary

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

  • Method Details

    • export

      String export(javax.servlet.http.HttpServletRequest request)
      Returns the JSON code for this resource bundle and the default locale.

      Parameters:
      request - the current request to get the default locale from
      Returns:
      the JSON code

    • export

      String export(Locale locale)
      Returns the JSON code for this resource bundle and given locale.

      Parameters:
      locale - the locale to export
      Returns:
      the JSON code

    • export

      String export(Locale locale, boolean wrapScript)
      Returns the JSON code for this resource bundle and given locale.

      Parameters:
      locale - the locale to export
      wrapScript - true to wrap the data in a script tag
      Returns:
      the JSON code

    • export

      String export(String localeName)
      Returns the JSON code for this resource bundle and given locale.

      Parameters:
      localeName - the name of the locale to export
      Returns:
      the JSON code

    • getBundleName

      String getBundleName()
      Returns the bundle name for this OpenCms package.

      Returns:
      the bundle name for this OpenCms package

    • getClientImpl

      Class<?> getClientImpl() throws Exception
      Returns the class of the client implementation.

      Returns:
      the class of the client implementation
      Throws:
      Exception - if something goes wrong