Package org.apache.velocity.tools.struts
Class MessageTool
java.lang.Object
org.apache.velocity.tools.struts.MessageResourcesTool
org.apache.velocity.tools.struts.MessageTool
The MessageTool is used to render internationalized message strings. Source of the strings are the message resource bundles of the Struts framework. The following methods operate on these message resources.
Template example(s): #if( $text.greeting.exists ) $text.greeting #end Toolbox configuration: <tools> <toolbox scope="request"> <tool class="org.apache.velocity.tools.struts.MessageTool"/> </toolbox> </tools>
This tool should only be used in the request scope.
- Since:
- VelocityTools 1.0
- Version:
- $Id: MessageTool.java 601976 2007-12-07 03:50:51Z nbubna $
- Author:
- Gabe Sidler
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionclass
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, LOG, request
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
Checks if a message string for a specified message key exists for the user's locale.boolean
Checks if a message string for a specified message key exists for the user's locale.Looks up and returns the localized message for the specified key.Looks up and returns the localized message for the specified key.Looks up and returns the localized message for the specified key.Looks up and returns the localized message for the specified key.Looks up and returns the localized message for the specified key.Same asget(String key, Object[] args)
, but takes ajava.util.List
instead of an array.Looks up and returns the localized message for the specified key.Same asget(String key, Object[] args)
, but takes ajava.util.List
instead of an array.Methods inherited from class org.apache.velocity.tools.struts.MessageResourcesTool
configure, getLocale, getResources, init
-
Constructor Details
-
MessageTool
public MessageTool()
-
-
Method Details
-
get
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
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 keybundle
- 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
Looks up and returns the localized message for the specified key. Replacement parameters passed withargs
are inserted into the message. The user's locale is consulted to determine the language of the message.- Parameters:
key
- message keyargs
- replacement parameters for this message- Returns:
- the localized message for the specified key or
null
if no such message exists
-
get
Looks up and returns the localized message for the specified key. Replacement parameters passed withargs
are inserted into the message. The user's locale is consulted to determine the language of the message.- Parameters:
key
- message keybundle
- 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
Looks up and returns the localized message for the specified key. Replacement parameters passed withargs
are inserted into the message.- Parameters:
key
- message keybundle
- The bundle name to look for.args
- replacement parameters for this messagelocale
- 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
Same asget(String key, Object[] args)
, but takes ajava.util.List
instead of an array. This is more Velocity friendly.- Parameters:
key
- message keyargs
- replacement parameters for this message- Returns:
- the localized message for the specified key or
null
if no such message exists
-
get
Same asget(String key, Object[] args)
, but takes ajava.util.List
instead of an array. This is more Velocity friendly.- Parameters:
key
- message keybundle
- 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
Looks up and returns the localized message for the specified key. Replacement parameters passed withargs
are inserted into the message.- Parameters:
key
- message keybundle
- The bundle name to look for.args
- replacement parameters for this messagelocale
- 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
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
Checks if a message string for a specified message key exists for the user's locale.- Parameters:
key
- message keybundle
- The bundle name to look for.- Returns:
true
if a message strings exists,false
otherwise- Since:
- VelocityTools 1.1
-