|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.velocity.tools.struts.ValidatorTool
public class ValidatorTool
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.
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 |
---|
protected ViewContext context
protected javax.servlet.ServletContext app
protected javax.servlet.http.HttpServletRequest request
protected javax.servlet.http.HttpSession session
protected org.apache.commons.validator.ValidatorResources resources
protected java.lang.String jsFormName
Constructor Detail |
---|
public ValidatorTool()
Method Detail |
---|
public void init(java.lang.Object obj)
obj
- the current ViewContext
java.lang.IllegalArgumentException
- if the param is not a ViewContextpublic int getPage()
public void setPage(int page)
page
- the current page number of a multi-part formpublic java.lang.String getMethod()
public void setMethod(java.lang.String methodName)
methodName
- the method name that will be used for the Javascript validation method namepublic boolean getHtmlComment()
public void setHtmlComment(boolean htmlComment)
htmlComment
- whether or not to delimit the JavaScript with html commentspublic java.lang.String getSrc()
public void setSrc(java.lang.String src)
src
- the src attribute's valuepublic boolean getCdata()
public void setCdata(boolean cdata)
cdata
- The cdata to setpublic java.lang.String getJavascript() throws java.lang.Exception
java.lang.Exception
public java.lang.String getJavascript(java.lang.String formName) throws java.lang.Exception
formName
- the key (form name)
java.lang.Exception
public java.lang.String getDynamicJavascript() throws java.lang.Exception
java.lang.Exception
public java.lang.String getStaticJavascript() throws java.lang.Exception
java.lang.Exception
public java.lang.String getDynamicJavascript(java.lang.String formName) throws java.lang.Exception
formName
- the key (form name)
java.lang.Exception
protected java.lang.String getJavascript(java.lang.String formName, boolean getStatic) throws java.lang.Exception
formName
- the key (form name)getStatic
- indicates if the static methods should be rendered
java.lang.Exception
protected java.lang.String getDynamicJavascript(org.apache.commons.validator.ValidatorResources resources, java.util.Locale locale, org.apache.commons.validator.Form form)
resources
- the validator resourceslocale
- the locale for the current requestform
- the form to generate javascript for
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.
str
- The string to escape.
s
with each instance of a double quote,
single quote, backslash, carriage-return, or line feed escaped
with a leading backslash.protected java.lang.String createMethods(java.util.List actions)
actions
- A List of ValidatorAction objects.
protected java.util.List createActionList(org.apache.commons.validator.ValidatorResources resources, org.apache.commons.validator.Form form)
resources
- the validator resourcesform
- the form for which the actions are requested
protected java.lang.String getJavascriptBegin(java.lang.String methods)
methods
- javascript validation methods
protected java.lang.String getJavascriptStaticMethods(org.apache.commons.validator.ValidatorResources resources)
resources
- the validation resources
protected java.lang.String getJavascriptEnd()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |