org.apache.velocity.tools.struts
Class ValidatorTool

java.lang.Object
  org.apache.velocity.tools.struts.ValidatorTool

public class ValidatorTool
extends java.lang.Object

View tool that works with Struts Validator to produce client side javascript validation for your forms.

Usage:

 Template example:

 $validator.getJavascript("nameOfYourForm")

 Toolbox configuration:
 <tool>
   <key>validator</key>
   <scope>request</scope>
   <class>org.apache.velocity.tools.struts.ValidatorTool</class>
 </tool>
 

This is an adaptation of the JavascriptValidatorTag from the Struts 1.1 validator library.

Since:

VelocityTools 1.1

Version:

$Revision: 497643 $ $Date: 2007-01-18 15:54:14 -0800 (Thu, 18 Jan 2007) $

Author:

David Winterfeldt, David Graham, Marino A. Jonsson, Nathan Bubna

Field Summary

protected javax.servlet.ServletContext	app A reference to the ServletContext
protected ViewContext	context A reference to the ViewContext
protected java.lang.String	jsFormName formName is used for both Javascript and non-javascript validations.
protected javax.servlet.http.HttpServletRequest	request A reference to the HttpServletRequest.
protected org.apache.commons.validator.ValidatorResources	resources A reference to the ValidatorResources.
protected javax.servlet.http.HttpSession	session A reference to the HttpSession.

Constructor Summary

ValidatorTool()
Default constructor.

Method Summary

protected java.util.List	createActionList(org.apache.commons.validator.ValidatorResources resources, org.apache.commons.validator.Form form) Get List of actions for the given Form.
protected java.lang.String	createMethods(java.util.List actions) Creates the JavaScript methods list from the given actions.
protected java.lang.String	escapeJavascript(java.lang.String str) Backslash-escapes the following characters from the input string: ", ', \, \r, \n.
boolean	getCdata() Returns the cdata setting "true" or "false".
java.lang.String	getDynamicJavascript() Render just the dynamic JavaScript to perform validations based on the form name attribute of the action mapping associated with the current request (if such exists).
java.lang.String	getDynamicJavascript(java.lang.String formName) Render just the dynamic JavaScript to perform validations based on the supplied form name.
protected java.lang.String	getDynamicJavascript(org.apache.commons.validator.ValidatorResources resources, java.util.Locale locale, org.apache.commons.validator.Form form) Generates the dynamic JavaScript for the form.
boolean	getHtmlComment() Gets whether or not to delimit the JavaScript with html comments.
java.lang.String	getJavascript() Render both dynamic and static JavaScript to perform validations based on the form name attribute of the action mapping associated with the current request (if such exists).
java.lang.String	getJavascript(java.lang.String formName) Render both dynamic and static JavaScript to perform validations based on the supplied form name.
protected java.lang.String	getJavascript(java.lang.String formName, boolean getStatic) Render both dynamic and static JavaScript to perform validations based on the supplied form name.
protected java.lang.String	getJavascriptBegin(java.lang.String methods) Returns the opening script element and some initial javascript.
protected java.lang.String	getJavascriptEnd() Returns the closing script element.
protected java.lang.String	getJavascriptStaticMethods(org.apache.commons.validator.ValidatorResources resources)
java.lang.String	getMethod() Gets the method name that will be used for the Javascript validation method name if it has a value.
int	getPage() Gets the current page number of a multi-part form.
java.lang.String	getSrc() Gets the src attribute's value when defining the html script element.
java.lang.String	getStaticJavascript() Render just the static JavaScript methods.
void	init(java.lang.Object obj) Initializes this tool.
void	setCdata(boolean cdata) Sets the cdata status.
void	setHtmlComment(boolean htmlComment) Sets whether or not to delimit the JavaScript with html comments.
void	setMethod(java.lang.String methodName) Sets the method name that will be used for the Javascript validation method name if it has a value.
void	setPage(int page) Sets the current page number of a multi-part form.
void	setSrc(java.lang.String src) Sets the src attribute's value (used to include an external script resource) when defining the html script element.

Methods inherited from class java.lang.Object

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

Field Detail

context

protected ViewContext context

A reference to the ViewContext

app

protected javax.servlet.ServletContext app

A reference to the ServletContext

request

protected javax.servlet.http.HttpServletRequest request

A reference to the HttpServletRequest.

session

protected javax.servlet.http.HttpSession session

A reference to the HttpSession.

resources

protected org.apache.commons.validator.ValidatorResources resources

A reference to the ValidatorResources.

jsFormName

protected java.lang.String jsFormName

formName is used for both Javascript and non-javascript validations. For the javascript validations, there is the possibility that we will be rewriting the formName (if it is a ValidatorActionForm instead of just a ValidatorForm) so we need another variable to hold the formName just for javascript usage.

Constructor Detail

ValidatorTool

public ValidatorTool()

Default constructor. Tool must be initialized before use.

Method Detail

init

public void init(java.lang.Object obj)

Initializes this tool.

Parameters:

obj - the current ViewContext

Throws:

java.lang.IllegalArgumentException - if the param is not a ViewContext

getPage

public int getPage()

Gets the current page number of a multi-part form. Only field validations with a matching page number will be generated that match the current page number. Only valid when the formName attribute is set.

Returns:

the current page number of a multi-part form

setPage

public void setPage(int page)

Sets the current page number of a multi-part form. Only field validations with a matching page number will be generated that match the current page number.

Parameters:

page - the current page number of a multi-part form

getMethod

public java.lang.String getMethod()

Gets the method name that will be used for the Javascript validation method name if it has a value. This overrides the auto-generated method name based on the key (form name) passed in.

Returns:

the method name that will be used for the Javascript validation method

setMethod

public void setMethod(java.lang.String methodName)

Sets the method name that will be used for the Javascript validation method name if it has a value. This overrides the auto-generated method name based on the key (form name) passed in.

Parameters:

methodName - the method name that will be used for the Javascript validation method name

getHtmlComment

public boolean getHtmlComment()

Gets whether or not to delimit the JavaScript with html comments. If this is set to 'true', which is the default, html comments will surround the JavaScript.

Returns:

true if the JavaScript should be delimited with html comments

setHtmlComment

public void setHtmlComment(boolean htmlComment)

Sets whether or not to delimit the JavaScript with html comments. If this is set to 'true', which is the default, html comments will surround the JavaScript.

Parameters:

htmlComment - whether or not to delimit the JavaScript with html comments

getSrc

public java.lang.String getSrc()

Gets the src attribute's value when defining the html script element.

Returns:

the src attribute's value

setSrc

public void setSrc(java.lang.String src)

Sets the src attribute's value (used to include an external script resource) when defining the html script element. The src attribute is only recognized when the formName attribute is specified.

Parameters:

src - the src attribute's value

getCdata

public boolean getCdata()

Returns the cdata setting "true" or "false".

Returns:

boolean - "true" if JavaScript will be hidden in a CDATA section

setCdata

public void setCdata(boolean cdata)

Sets the cdata status.

Parameters:

cdata - The cdata to set

getJavascript

public java.lang.String getJavascript()
                               throws java.lang.Exception

Render both dynamic and static JavaScript to perform validations based on the form name attribute of the action mapping associated with the current request (if such exists).

Returns:

the javascript for the current form

Throws:

java.lang.Exception

getJavascript

public java.lang.String getJavascript(java.lang.String formName)
                               throws java.lang.Exception

Render both dynamic and static JavaScript to perform validations based on the supplied form name.

Parameters:

formName - the key (form name)

Returns:

the Javascript for the specified form

Throws:

java.lang.Exception

getDynamicJavascript

public java.lang.String getDynamicJavascript()
                                      throws java.lang.Exception

Render just the dynamic JavaScript to perform validations based on the form name attribute of the action mapping associated with the current request (if such exists). Useful i.e. if the static parts are located in a seperate .js file.

Returns:

the javascript for the current form

Throws:

java.lang.Exception

getStaticJavascript

public java.lang.String getStaticJavascript()
                                     throws java.lang.Exception

Render just the static JavaScript methods. Useful i.e. if the static parts should be located in a seperate .js file.

Returns:

all static Javascript methods

Throws:

java.lang.Exception

getDynamicJavascript

public java.lang.String getDynamicJavascript(java.lang.String formName)
                                      throws java.lang.Exception

Render just the dynamic JavaScript to perform validations based on the supplied form name. Useful i.e. if the static parts are located in a seperate .js file.

Parameters:

formName - the key (form name)

Returns:

the dynamic Javascript for the specified form

Throws:

java.lang.Exception

getJavascript

protected java.lang.String getJavascript(java.lang.String formName,
                                         boolean getStatic)
                                  throws java.lang.Exception

Render both dynamic and static JavaScript to perform validations based on the supplied form name.

Parameters:

formName - the key (form name)

getStatic - indicates if the static methods should be rendered

Returns:

the Javascript for the specified form

Throws:

java.lang.Exception

getDynamicJavascript

protected java.lang.String getDynamicJavascript(org.apache.commons.validator.ValidatorResources resources,
                                                java.util.Locale locale,
                                                org.apache.commons.validator.Form form)

Generates the dynamic JavaScript for the form.

Parameters:

resources - the validator resources

locale - the locale for the current request

form - the form to generate javascript for

Returns:

the dynamic javascript

escapeJavascript

protected java.lang.String escapeJavascript(java.lang.String str)

Backslash-escapes the following characters from the input string: ", ', \, \r, \n.

This method escapes characters that will result in an invalid Javascript statement within the validator Javascript.

Parameters:

str - The string to escape.

Returns:

The string s with each instance of a double quote, single quote, backslash, carriage-return, or line feed escaped with a leading backslash.

Since:

VelocityTools 1.2

createMethods

protected java.lang.String createMethods(java.util.List actions)

Creates the JavaScript methods list from the given actions.

Parameters:

actions - A List of ValidatorAction objects.

Returns:

JavaScript methods.

createActionList

protected java.util.List createActionList(org.apache.commons.validator.ValidatorResources resources,
                                          org.apache.commons.validator.Form form)

Get List of actions for the given Form.

Parameters:

resources - the validator resources

form - the form for which the actions are requested

Returns:

A sorted List of ValidatorAction objects.

getJavascriptBegin

protected java.lang.String getJavascriptBegin(java.lang.String methods)

Returns the opening script element and some initial javascript.

Parameters:

methods - javascript validation methods

Returns:

the opening script element and some initial javascript

getJavascriptStaticMethods

protected java.lang.String getJavascriptStaticMethods(org.apache.commons.validator.ValidatorResources resources)

Parameters:

resources - the validation resources

Returns:

the static javascript methods

getJavascriptEnd

protected java.lang.String getJavascriptEnd()

Returns the closing script element.

Returns:

the closing script element