Package org.apache.velocity.tools.struts
Class MessageTool.TextKey
java.lang.Object
org.apache.velocity.tools.struts.MessageTool.TextKey
- Enclosing class:
- MessageTool
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
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns a new TextKey with the specified resource bundle set.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.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
Convenience method to allow$text.key.exists
syntax.Returns a new TextKey with the specified argument to be inserted into the text output.Returns a new TextKey with the specified array of arguments to be inserted into the text output.Returns a new TextKey with the specified arguments to be inserted into the text output.Returns a new TextKey with the specified arguments to be inserted into the text output.Returns a new TextKey with the specified List of arguments to be inserted into the text output.Returns a new TextKey with the specified resource bundle set.toString()
Renders the text output according to the collected key value, bundle, and arguments.
-
Field Details
-
key
-
bundle
-
args
-
locale
-
-
Constructor Details
-
TextKey
- Since:
- VelocityTools 1.4
-
-
Method Details
-
get
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
Returns a new TextKey with the specified resource bundle set.- Since:
- VelocityTools 1.3
-
locale
Returns a new TextKey with the specified resource bundle set.- Since:
- VelocityTools 1.4
-
insert
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
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
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
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
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
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
Renders the text output according to the collected key value, bundle, and arguments.
-