Package org.apache.velocity.tools.struts

Class MessageTool.TextKey

java.lang.Object

org.apache.velocity.tools.struts.MessageTool.TextKey

Enclosing class:

MessageTool

public class MessageTool.TextKey
extends Object

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

So instead of $text.get("forms.profile.title"),1 you can just type $text.forms.profile.title. Also, this lets you do things like:

   #if( $text.forms.profile.exists )
      #set( $profiletext = $text.forms.profile )
      <h1>$profiletext.title</h1>
      <h3>$profiletext.subtitle</h3>
   #end
 

Since:

VelocityTools 1.2

Constructor Summary

Constructors

Constructor	Description
TextKey(String key, String bundle, Object[] args, Locale locale)

Method Summary

Modifier and Type	Method	Description
MessageTool.TextKey	bundle(String setme)	Returns a new TextKey with the specified resource bundle set.
MessageTool.TextKey	clearArgs()	This will return a new TextKey that has no arguments to be inserted into the text output.
boolean	exists()	Checks for the existence of the key that we've built up.
MessageTool.TextKey	get(String appendme)	Appends a period and the new key to the current key and returns a new TextKey instance with the combined result as its key.
boolean	getExists()	Convenience method to allow $text.key.exists syntax.
MessageTool.TextKey	insert(Object addme)	Returns a new TextKey with the specified argument to be inserted into the text output.
MessageTool.TextKey	insert(Object[] addme)	Returns a new TextKey with the specified array of arguments to be inserted into the text output.
MessageTool.TextKey	insert(Object addme, Object metoo)	Returns a new TextKey with the specified arguments to be inserted into the text output.
MessageTool.TextKey	insert(Object addme, Object metoo, Object methree)	Returns a new TextKey with the specified arguments to be inserted into the text output.
MessageTool.TextKey	insert(List addme)	Returns a new TextKey with the specified List of arguments to be inserted into the text output.
MessageTool.TextKey	locale(Locale setme)	Returns a new TextKey with the specified resource bundle set.
String	toString()	Renders the text output according to the collected key value, bundle, and arguments.

Methods inherited from class java.lang.Object

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

Constructor Detail

TextKey

public TextKey(String key,
               String bundle,
               Object[] args,
               Locale locale)

Since:

VelocityTools 1.4

Method Detail

get

public MessageTool.TextKey get(String appendme)

Appends a period and the new key to the current key and returns a new TextKey instance with the combined result as its key.

bundle

public MessageTool.TextKey bundle(String setme)

Returns a new TextKey with the specified resource bundle set.

Since:

VelocityTools 1.3

locale

public MessageTool.TextKey locale(Locale setme)

Returns a new TextKey with the specified resource bundle set.

Since:

VelocityTools 1.4

insert

public MessageTool.TextKey insert(Object addme)

Returns a new TextKey with the specified argument to be inserted into the text output. If arguments already exist for this TextKey, the new arguments will be appended to the old ones in the new TextKey that is returned.

Since:

VelocityTools 1.3

insert

public MessageTool.TextKey insert(Object addme,
                                  Object metoo)

Returns a new TextKey with the specified arguments to be inserted into the text output. If arguments already exist for this TextKey, the new arguments will be appended to the old ones in the new TextKey that is returned.

Since:

VelocityTools 1.3

insert

public MessageTool.TextKey insert(Object addme,
                                  Object metoo,
                                  Object methree)

Returns a new TextKey with the specified arguments to be inserted into the text output. If arguments already exist for this TextKey, the new arguments will be appended to the old ones in the new TextKey that is returned.

Since:

VelocityTools 1.3

insert

public MessageTool.TextKey insert(List addme)

Returns a new TextKey with the specified List of arguments to be inserted into the text output. If arguments already exist for this TextKey, the new arguments will be appended to the old ones in the new TextKey that is returned.

Since:

VelocityTools 1.3

insert

public MessageTool.TextKey insert(Object[] addme)

Returns a new TextKey with the specified array of arguments to be inserted into the text output. If arguments already exist for this TextKey, the new arguments will be appended to the old ones in the new TextKey that is returned.

Since:

VelocityTools 1.3

clearArgs

public MessageTool.TextKey clearArgs()

This will return a new TextKey that has no arguments to be inserted into the text output.

Since:

VelocityTools 1.3

getExists

public boolean getExists()

Convenience method to allow $text.key.exists syntax.

Since:

VelocityTools 1.3

exists

public boolean exists()

Checks for the existence of the key that we've built up.

Since:

VelocityTools 1.3

toString

public String toString()

Renders the text output according to the collected key value, bundle, and arguments.

Overrides:

toString in class Object