com.communote.server.web.commons.viewtool

Class FormatTool

java.lang.Object

com.communote.server.web.commons.viewtool.RequestAwareTool

com.communote.server.web.commons.viewtool.FormatTool

@DefaultKey(value="fmtTool")
 @ValidScope(value="request")
public class FormatTool
extends RequestAwareTool

Tools for message formatting.

Author:

Communote GmbH - http://www.communote.com/

Constructor Summary

Constructors

Constructor and Description
FormatTool()

Method Summary

Modifier and Type	Method and Description
String	jsMessagesDeclaration(String category, String namespace) Creates a Javascript declaration of an object containing all the key to localized message mappings for the category.
String	message(String key) Returns the localized message for the provided key.
String	message(String key, List<Object> args) Returns the localized message for the provided key.
String	message(String key, Locale locale) Returns the localized message for the provided key.
String	message(String key, Object... args) Returns the localized message for the provided key.

Methods inherited from class com.communote.server.web.commons.viewtool.RequestAwareTool

getRequest, getResponse, getServletContext, setRequest, setResponse, setServletContext

Methods inherited from class java.lang.Object

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

Constructor Detail

FormatTool

public FormatTool()

Method Detail

jsMessagesDeclaration

public String jsMessagesDeclaration(String category,
                                    String namespace)

Creates a Javascript declaration of an object containing all the key to localized message mappings for the category. If a namespace is provided the messages are added under the name localizedMessages to the namespace. If no namespace is given the method returns a declaration of the jsLocalizedMessages variable.

Parameters:

category - the category for which the messages are to be returned. Can be one of the built-in categories (see constants in JsMessagesRegistry) or one provided by plugin.

namespace - A string defining a namespace object (e.g. communote.i18n) to which the localizedMessages member should be added.

Returns:

the Javascript declaration in the form of 'var jsLocalizedMessages = {...};' or as a namespace member

message

public String message(String key)

Returns the localized message for the provided key.

Parameters:

key - the message key

Returns:

the localized message

message

public String message(String key,
                      List<Object> args)

Returns the localized message for the provided key.

Parameters:

key - the message key

args - additional arguments to insert in place holders

Returns:

the localized message

message

public String message(String key,
                      Locale locale)

Returns the localized message for the provided key.

Parameters:

key - the message key

locale - use the provided locale for localization. If null the current locale provided by the session handler will be used.

Returns:

the localized message

message

public String message(String key,
                      Object... args)

Returns the localized message for the provided key.

Parameters:

key - the message key

args - additional arguments to insert in place holders

Returns:

the localized message