org.apache.velocity.tools.struts
Class ErrorsTool

java.lang.Object
  org.apache.velocity.tools.struts.MessageResourcesTool
      org.apache.velocity.tools.struts.ActionMessagesTool
          org.apache.velocity.tools.struts.ErrorsTool

@DefaultKey(value="errors")
@ValidScope(value="request")
public class ErrorsTool
extends ActionMessagesTool

This tool deals with Struts error messages. Errors may stem from the validation of a submitted form or from the processing of a request. If there are errors, they are made available to the view to render. A few important aspects about errors are:

• Error message strings are looked up in the message resources. Support for internationalized messages is provided.
• Error messages can have up to five replacement parameters.
• Errors have an attribute property that describes the category of error. This allows the view designer to place error messages precisely where an error occurred. For example, errors that apply to the entire page can be rendered at the top of the page, errors that apply to a specific input field can be rendered next to this input field. Several methods of this tool provide a parameter property that allows to select a specific category of errors to operate on. Without the property parameter, methods operate on all error messages.

See the Struts User's Guide, section Building View Components for more information on this topic.

 Template example(s):
   #if( $errors.exist() )
     <div class="errors">
     #foreach( $e in $errors.all )
       $e <br>
     #end
     </div>
   #end

 Toolbox configuration:
 <tools>
   <toolbox scope="request">
     <tool class="org.apache.velocity.tools.struts.ErrorsTool"/>
   </toolbox>
 </tools>
 

This tool should only be used in the request scope.

Since VelocityTools 1.1, ErrorsTool extends ActionMessagesTool.

Since:

VelocityTools 1.0

Version:

$Id: ErrorsTool.java 601976 2007-12-07 03:50:51Z nbubna $

Author:

Gabe Sidler, Nathan Bubna

Field Summary

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

actionMsgs

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

application, LOG, request

Constructor Summary

ErrorsTool()

Method Summary

protected org.apache.struts.action.ActionMessages	getActionMessages()
java.lang.String	getMsgs() Renders the queued error messages as a list.
java.lang.String	getMsgs(java.lang.String property) Renders the queued error messages of a particual category as a list.
java.lang.String	getMsgs(java.lang.String property, java.lang.String bundle) Renders the queued error messages of a particual category as a list.

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

exist, exist, get, get, getAll, getAll, getGlobal, getGlobalName, getSize, getSize

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

configure, getLocale, getResources, init

Methods inherited from class java.lang.Object

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

Constructor Detail

ErrorsTool

public ErrorsTool()

Method Detail

getActionMessages

protected org.apache.struts.action.ActionMessages getActionMessages()

Overrides:

getActionMessages in class ActionMessagesTool

getMsgs

public java.lang.String getMsgs()

Renders the queued error messages as a list. This method expects the message keys errors.header and errors.footer in the message resources. The value of the former is rendered before the list of error messages and the value of the latter is rendered after the error messages.

Returns:

The formatted error messages. If no error messages are queued, an empty string is returned.

getMsgs

public java.lang.String getMsgs(java.lang.String property)

Renders the queued error messages of a particual category as a list. This method expects the message keys errors.header and errors.footer in the message resources. The value of the former is rendered before the list of error messages and the value of the latter is rendered after the error messages.

Parameters:

property - the category of errors to render

Returns:

The formatted error messages. If no error messages are queued, an empty string is returned.

getMsgs

public java.lang.String getMsgs(java.lang.String property,
                                java.lang.String bundle)

Renders the queued error messages of a particual category as a list. This method expects the message keys errors.header and errors.footer in the message resources. The value of the former is rendered before the list of error messages and the value of the latter is rendered after the error messages.

Parameters:

property - the category of errors to render

bundle - the message resource bundle to use

Returns:

The formatted error messages. If no error messages are queued, an empty string is returned.

Since:

VelocityTools 1.1