@DefaultKey(value="messages") @ValidScope(value="request") public class ActionMessagesTool extends MessageResourcesTool
This tool deals with Struts action messages. A few important aspects about action messages are:
property
that describes the category of
message. This allows the view designer to place action messages precisely where they are
wanted. Several methods of this tool provide a parameter
property
that allows to select a specific category of messages to operate
on. Without the property
parameter, methods operate on all action messages.See the Struts User's Guide, section Building View Components for more information on this topic.
Template example(s): #if( $messages.exist() ) #foreach( $e in $messages.all ) $e <br> #end #end Toolbox configuration: <tools> <toolbox scope="request"> <tool class="org.apache.velocity.tools.struts.ActionMessagesTool"/> </toolbox> </tools>
This tool should only be used in the request scope.
Modifier and Type | Field and Description |
---|---|
protected org.apache.struts.action.ActionMessages |
actionMsgs
A reference to the queued action messages.
|
application, LOG, request
Constructor and Description |
---|
ActionMessagesTool() |
Modifier and Type | Method and Description |
---|---|
boolean |
exist()
Returns
true if there are action messages queued,
otherwise false . |
boolean |
exist(String property)
Returns true if there are action messages queued for the specified
category of messages, otherwise
false . |
List |
get(String property)
Returns the set of localized action messages as an
java.util.List of strings for all actionMsgs
queued of the specified category or null
if no messages are queued for the specified category. |
List |
get(String property,
String bundle)
Returns the set of localized action messages as a
java.util.List of strings for all action messages
queued of the specified category or null
if no action messages are queued for the specified category. |
protected org.apache.struts.action.ActionMessages |
getActionMessages() |
List |
getAll()
Returns the set of localized action messages as an
java.util.List of strings for all actionMsgs
queued or null if no messages are queued. |
List |
getAll(String bundle)
Returns a List of all queued action messages using
the specified message resource bundle.
|
List |
getGlobal()
This a convenience method and the equivalent of
$messages.get($messages.globalName) . |
String |
getGlobalName()
Returns the default "GLOBAL" category name that can be used for
messages that are not associated with a particular property.
|
int |
getSize()
Returns the number of action messages queued.
|
int |
getSize(String property)
Returns the number of action messages queued for a particular property.
|
configure, getLocale, getResources, init
protected org.apache.struts.action.ActionMessages actionMsgs
protected org.apache.struts.action.ActionMessages getActionMessages()
public boolean exist()
Returns true
if there are action messages queued,
otherwise false
.
public boolean exist(String property)
Returns true if there are action messages queued for the specified
category of messages, otherwise false
.
property
- the category of messages to check forpublic int getSize()
public int getSize(String property)
property
- the category of messages to check forpublic List getGlobal()
This a convenience method and the equivalent of
$messages.get($messages.globalName)
.
Returns the set of localized action messages as an
list of strings for all action messages queued of the
global category or null
if no messages
are queued for the specified category. If the message
resources don't contain an action message for a
particular message key, the key itself is used.
public List getAll()
java.util.List
of strings for all actionMsgs
queued or null
if no messages are queued.
If the message resources don't contain a message for a
particular key, the key itself is used as the message.public List getAll(String bundle)
bundle
- the message resource bundle to usegetAll()
public List get(String property)
java.util.List
of strings for all actionMsgs
queued of the specified category or null
if no messages are queued for the specified category. If the
message resources don't contain a message for a particular
key, the key itself is used as the message.property
- the category of actionMsgs to operate onpublic List get(String property, String bundle)
java.util.List
of strings for all action messages
queued of the specified category or null
if no action messages are queued for the specified category. If the
message resources don't contain an action message for a particular
action key, the key itself is used as action message.property
- the category of actionMsgs to operate onbundle
- the message resource bundle to usepublic String getGlobalName()
Copyright © 2002–2021 Apache Software Foundation. All rights reserved.