org.apache.velocity.tools.struts
Class MessageTool

java.lang.Object
  org.apache.velocity.tools.struts.MessageResourcesTool
      org.apache.velocity.tools.struts.MessageTool

public class MessageTool
extends MessageResourcesTool

View tool that provides methods to render Struts application resources for internationalized text.

 Template example(s):
   #if( $text.greeting.exists )
     $text.greeting
   #end

 Toolbox configuration:
 <tool>
   <key>text</key>
   <scope>request</scope>
   <class>org.apache.velocity.tools.struts.MessageTool</class>
 </tool>
 

This tool should only be used in the request scope.

Since:

VelocityTools 1.0

Version:

$Id: MessageTool.java 510272 2007-02-21 22:29:48Z nbubna $

Author:

Gabe Sidler

Nested Class Summary

class

MessageTool.TextKey Helper class to simplify tool usage when retrieving no-arg messages from the default bundle that have periods in their key.

Field Summary

Fields inherited from class org.apache.velocity.tools.struts.MessageResourcesTool

application, locale, LOG, request, resources

Constructor Summary

MessageTool()
Default constructor.

Method Summary

boolean	exists(java.lang.String key) Checks if a message string for a specified message key exists for the user's locale.
boolean	exists(java.lang.String key, java.lang.String bundle) Checks if a message string for a specified message key exists for the user's locale.
MessageTool.TextKey	get(java.lang.String key) Looks up and returns the localized message for the specified key.
java.lang.String	get(java.lang.String key, java.util.List args) Same as get(String key, Object[] args), but takes a java.util.List instead of an array.
java.lang.String	get(java.lang.String key, java.lang.Object[] args) Looks up and returns the localized message for the specified key.
java.lang.String	get(java.lang.String key, java.lang.String bundle) Looks up and returns the localized message for the specified key.
java.lang.String	get(java.lang.String key, java.lang.String bundle, java.util.List args) Same as get(String key, Object[] args), but takes a java.util.List instead of an array.
java.lang.String	get(java.lang.String key, java.lang.String bundle, java.util.List args, java.util.Locale locale) Looks up and returns the localized message for the specified key.
java.lang.String	get(java.lang.String key, java.lang.String bundle, java.lang.Object[] args) Looks up and returns the localized message for the specified key.
java.lang.String	get(java.lang.String key, java.lang.String bundle, java.lang.Object[] args, java.util.Locale locale) Looks up and returns the localized message for the specified key.

Methods inherited from class org.apache.velocity.tools.struts.MessageResourcesTool

getResources, init

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageTool

public MessageTool()

Default constructor. Tool must be initialized before use.

Method Detail

get

public MessageTool.TextKey get(java.lang.String key)

Looks up and returns the localized message for the specified key. The user's locale is consulted to determine the language of the message.

Example use: $text.forms.profile.title

Parameters:

key - message key

get

public java.lang.String get(java.lang.String key,
                            java.lang.String bundle)

Looks up and returns the localized message for the specified key. The user's locale is consulted to determine the language of the message.

Parameters:

key - message key

bundle - The bundle name to look for.

Returns:

the localized message for the specified key or null if no such message exists

Since:

VelocityTools 1.1

get

public java.lang.String get(java.lang.String key,
                            java.lang.Object[] args)

Looks up and returns the localized message for the specified key. Replacement parameters passed with args are inserted into the message. The user's locale is consulted to determine the language of the message.

Parameters:

key - message key

args - replacement parameters for this message

Returns:

the localized message for the specified key or null if no such message exists

get

public java.lang.String get(java.lang.String key,
                            java.lang.String bundle,
                            java.lang.Object[] args)

Looks up and returns the localized message for the specified key. Replacement parameters passed with args are inserted into the message. The user's locale is consulted to determine the language of the message.

Parameters:

key - message key

bundle - The bundle name to look for.

args - replacement parameters for this message

Returns:

the localized message for the specified key or null if no such message exists

Since:

VelocityTools 1.1

get

public java.lang.String get(java.lang.String key,
                            java.lang.String bundle,
                            java.lang.Object[] args,
                            java.util.Locale locale)

Looks up and returns the localized message for the specified key. Replacement parameters passed with args are inserted into the message.

Parameters:

key - message key

bundle - The bundle name to look for.

args - replacement parameters for this message

locale - The locale to use for this message.

Returns:

the localized message for the specified key or null if no such message exists

Since:

VelocityTools 1.4

get

public java.lang.String get(java.lang.String key,
                            java.util.List args)

Same as get(String key, Object[] args), but takes a java.util.List instead of an array. This is more Velocity friendly.

Parameters:

key - message key

args - replacement parameters for this message

Returns:

the localized message for the specified key or null if no such message exists

get

public java.lang.String get(java.lang.String key,
                            java.lang.String bundle,
                            java.util.List args)

Same as get(String key, Object[] args), but takes a java.util.List instead of an array. This is more Velocity friendly.

Parameters:

key - message key

bundle - The bundle name to look for.

args - replacement parameters for this message

Returns:

the localized message for the specified key or null if no such message exists

Since:

VelocityTools 1.1

get

public java.lang.String get(java.lang.String key,
                            java.lang.String bundle,
                            java.util.List args,
                            java.util.Locale locale)

Looks up and returns the localized message for the specified key. Replacement parameters passed with args are inserted into the message.

Parameters:

key - message key

bundle - The bundle name to look for.

args - replacement parameters for this message

locale - The locale to use for this message.

Returns:

the localized message for the specified key or null if no such message exists

Since:

VelocityTools 1.4

exists

public boolean exists(java.lang.String key)

Checks if a message string for a specified message key exists for the user's locale.

Parameters:

key - message key

Returns:

true if a message strings exists, false otherwise

exists

public boolean exists(java.lang.String key,
                      java.lang.String bundle)

Checks if a message string for a specified message key exists for the user's locale.

Parameters:

key - message key

bundle - The bundle name to look for.

Returns:

true if a message strings exists, false otherwise

Since:

VelocityTools 1.1