You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@velocity.apache.org by nb...@apache.org on 2003/10/29 02:04:52 UTC
cvs commit: jakarta-velocity-tools/docs/javadoc/org/apache/velocity/tools/struts SecureLinkTool.html ValidatorTool.html ValidatorTool.ValidatorActionComparator.html
nbubna 2003/10/28 17:04:52
Added: docs/javadoc/org/apache/velocity/tools/struts
SecureLinkTool.html ValidatorTool.html
ValidatorTool.ValidatorActionComparator.html
Log:
these were forgotten in past updates
Revision Changes Path
1.1 jakarta-velocity-tools/docs/javadoc/org/apache/velocity/tools/struts/SecureLinkTool.html
Index: SecureLinkTool.html
===================================================================
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc on Tue Oct 28 16:53:05 PST 2003 -->
<TITLE>
SecureLinkTool (Velocity-Tools API Documentation)
</TITLE>
<META NAME="keywords" CONTENT="org.apache.velocity.tools.struts.SecureLinkTool,SecureLinkTool class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
</HEAD>
<SCRIPT>
function asd()
{
parent.document.title="SecureLinkTool (Velocity-Tools API Documentation)";
}
</SCRIPT>
<BODY BGCOLOR="white" onload="asd();">
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_top"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../org/apache/velocity/tools/struts/MessageTool.html"><B>PREV CLASS</B></A>
<A HREF="../../../../../org/apache/velocity/tools/struts/StrutsLinkTool.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="SecureLinkTool.html" TARGET="_top"><B>NO FRAMES</B></A>
<SCRIPT>
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: <A HREF="#nested_classes_inherited_from_class_org.apache.velocity.tools.view.tools.LinkTool">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.apache.velocity.tools.struts</FONT>
<BR>
Class SecureLinkTool</H2>
<PRE>
java.lang.Object
|
+--<A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html">org.apache.velocity.tools.view.tools.LinkTool</A>
|
+--<B>org.apache.velocity.tools.struts.SecureLinkTool</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD>java.lang.Cloneable, <A HREF="../../../../../org/apache/velocity/tools/view/tools/ViewTool.html">ViewTool</A></DD>
</DL>
<HR>
<DL>
<DT>public class <B>SecureLinkTool</B><DT>extends <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html">LinkTool</A></DL>
<P>
<p>Title: SecureLinkTool</p>
<p>Description: Tool to be able to use Struts SSL Extensions with Velocity</p>
<p>It has the same interface as StrutsLinkTool and can function as a substitute if Struts 1.1 and SSL Ext are installed. </p>
<p>Usage:
<pre>
Template example:
<!-- Use just like a regular StrutsLinkTool -->
$link.setAction("nameOfAction")
$link.setForward("nameOfForward")
If the action or forward is marked as secure, or not, in your struts-config then the link will be rendered
with https or http accordingly.
Toolbox configuration:
<tool>
<key>link</key>
<scope>request</scope>
<class>org.apache.velocity.tools.struts.SecureLinkTool</class>
</tool>
</pre>
</p>
<P>
<P>
<DL>
<DT><B>Version:</B></DT>
<DD>$Revision: 1.1 $ $Date: 2003/10/29 01:04:52 $</DD>
<DT><B>Author:</B></DT>
<DD><a href="mailto:marinoj@centrum.is">Marino A. Jonsson</a></DD>
</DL>
<HR>
<P>
<!-- ======== NESTED CLASS SUMMARY ======== -->
<A NAME="nested_class_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Nested Class Summary</B></FONT></TD>
</TR>
</TABLE>
<A NAME="nested_classes_inherited_from_class_org.apache.velocity.tools.view.tools.LinkTool"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Nested classes inherited from class org.apache.velocity.tools.view.tools.<A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html">LinkTool</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.QueryPair.html">LinkTool.QueryPair</A></CODE></TD>
</TR>
</TABLE>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Field Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/SecureLinkTool.html#HTTP">HTTP</A></B></CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/SecureLinkTool.html#HTTPS">HTTPS</A></B></CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/SecureLinkTool.html#STD_HTTP_PORT">STD_HTTP_PORT</A></B></CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/SecureLinkTool.html#STD_HTTPS_PORT">STD_HTTPS_PORT</A></B></CODE>
<BR>
</TD>
</TR>
</TABLE>
<A NAME="fields_inherited_from_class_org.apache.velocity.tools.view.tools.LinkTool"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Fields inherited from class org.apache.velocity.tools.view.tools.<A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html">LinkTool</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#application">application</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#HTML_QUERY_DELIMITER">HTML_QUERY_DELIMITER</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#request">request</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#response">response</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#XHTML_QUERY_DELIMITER">XHTML_QUERY_DELIMITER</A></CODE></TD>
</TR>
</TABLE>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/SecureLinkTool.html#SecureLinkTool()">SecureLinkTool</A></B>()</CODE>
<BR>
</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Method Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/SecureLinkTool.html#computeURL(javax.servlet.http.HttpServletRequest, javax.servlet.ServletContext, java.lang.String)">computeURL</A></B>(javax.servlet.http.HttpServletRequest request,
javax.servlet.ServletContext app,
java.lang.String link)</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private static org.apache.struts.config.SecureActionConfig</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/SecureLinkTool.html#getActionConfig(javax.servlet.http.HttpServletRequest, javax.servlet.ServletContext, java.lang.String)">getActionConfig</A></B>(javax.servlet.http.HttpServletRequest request,
javax.servlet.ServletContext app,
java.lang.String linkString)</CODE>
<BR>
Finds the configuration definition for the specified action link</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../org/apache/velocity/tools/struts/SecureLinkTool.html">SecureLinkTool</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/SecureLinkTool.html#setAction(java.lang.String)">setAction</A></B>(java.lang.String action)</CODE>
<BR>
Returns a copy of the link with the given action name
converted into a server-relative URI reference.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../org/apache/velocity/tools/struts/SecureLinkTool.html">SecureLinkTool</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/SecureLinkTool.html#setForward(java.lang.String)">setForward</A></B>(java.lang.String forward)</CODE>
<BR>
Returns a copy of the link with the given global forward name
converted into a server-relative URI reference.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private static java.lang.StringBuffer</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/SecureLinkTool.html#startNewUrlString(javax.servlet.http.HttpServletRequest, java.lang.String, java.lang.String)">startNewUrlString</A></B>(javax.servlet.http.HttpServletRequest request,
java.lang.String desiredScheme,
java.lang.String desiredPort)</CODE>
<BR>
Builds the protocol, server name, and port portion of the new URL</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/SecureLinkTool.html#toEncoded(java.lang.String, java.lang.String)">toEncoded</A></B>(java.lang.String url,
java.lang.String sessionId)</CODE>
<BR>
Return the specified URL with the specified session identifier
suitably encoded.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_org.apache.velocity.tools.view.tools.LinkTool"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class org.apache.velocity.tools.view.tools.<A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html">LinkTool</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#addQueryData(java.lang.String, java.lang.Object)">addQueryData</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#copyWith(org.apache.velocity.tools.view.tools.LinkTool.QueryPair)">copyWith</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#copyWith(java.lang.String)">copyWith</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#copyWithAnchor(java.lang.String)">copyWithAnchor</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#encodeURL(java.lang.String)">encodeURL</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getAnchor()">getAnchor</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getBaseRef()">getBaseRef</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getContextPath()">getContextPath</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getContextURL()">getContextURL</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getQueryData()">getQueryData</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getURI()">getURI</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#init(java.lang.Object)">init</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#setAnchor(java.lang.String)">setAnchor</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#setRelative(java.lang.String)">setRelative</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#setURI(java.lang.String)">setURI</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#setXhtml(boolean)">setXhtml</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#toString()">toString</A></CODE></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class java.lang.Object</B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Field Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="HTTP"><!-- --></A><H3>
HTTP</H3>
<PRE>
private static final java.lang.String <B>HTTP</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.velocity.tools.struts.SecureLinkTool.HTTP">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="HTTPS"><!-- --></A><H3>
HTTPS</H3>
<PRE>
private static final java.lang.String <B>HTTPS</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.velocity.tools.struts.SecureLinkTool.HTTPS">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="STD_HTTP_PORT"><!-- --></A><H3>
STD_HTTP_PORT</H3>
<PRE>
private static final java.lang.String <B>STD_HTTP_PORT</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.velocity.tools.struts.SecureLinkTool.STD_HTTP_PORT">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="STD_HTTPS_PORT"><!-- --></A><H3>
STD_HTTPS_PORT</H3>
<PRE>
private static final java.lang.String <B>STD_HTTPS_PORT</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.velocity.tools.struts.SecureLinkTool.STD_HTTPS_PORT">Constant Field Values</A></DL>
</DL>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="SecureLinkTool()"><!-- --></A><H3>
SecureLinkTool</H3>
<PRE>
public <B>SecureLinkTool</B>()</PRE>
<DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="setAction(java.lang.String)"><!-- --></A><H3>
setAction</H3>
<PRE>
public <A HREF="../../../../../org/apache/velocity/tools/struts/SecureLinkTool.html">SecureLinkTool</A> <B>setAction</B>(java.lang.String action)</PRE>
<DL>
<DD><p>Returns a copy of the link with the given action name
converted into a server-relative URI reference. This method
does not check if the specified action really is defined.
This method will overwrite any previous URI reference settings
but will copy the query string.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>action</CODE> - an action path as defined in struts-config.xml
<DT><B>Returns:</B><DD>a new instance of StrutsLinkTool</DL>
</DD>
</DL>
<HR>
<A NAME="setForward(java.lang.String)"><!-- --></A><H3>
setForward</H3>
<PRE>
public <A HREF="../../../../../org/apache/velocity/tools/struts/SecureLinkTool.html">SecureLinkTool</A> <B>setForward</B>(java.lang.String forward)</PRE>
<DL>
<DD><p>Returns a copy of the link with the given global forward name
converted into a server-relative URI reference. If the parameter
does not map to an existing global forward name, <code>null</code>
is returned. This method will overwrite any previous URI reference
settings but will copy the query string.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>forward</CODE> - a global forward name as defined in struts-config.xml
<DT><B>Returns:</B><DD>a new instance of StrutsLinkTool</DL>
</DD>
</DL>
<HR>
<A NAME="computeURL(javax.servlet.http.HttpServletRequest, javax.servlet.ServletContext, java.lang.String)"><!-- --></A><H3>
computeURL</H3>
<PRE>
public java.lang.String <B>computeURL</B>(javax.servlet.http.HttpServletRequest request,
javax.servlet.ServletContext app,
java.lang.String link)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getActionConfig(javax.servlet.http.HttpServletRequest, javax.servlet.ServletContext, java.lang.String)"><!-- --></A><H3>
getActionConfig</H3>
<PRE>
private static org.apache.struts.config.SecureActionConfig <B>getActionConfig</B>(javax.servlet.http.HttpServletRequest request,
javax.servlet.ServletContext app,
java.lang.String linkString)</PRE>
<DL>
<DD>Finds the configuration definition for the specified action link
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>linkString</CODE> - The action we are searching for, specified as a
link. (i.e. may include "..")
<DT><B>Returns:</B><DD>The SecureActionConfig object entry for this action,
or null if not found</DL>
</DD>
</DL>
<HR>
<A NAME="startNewUrlString(javax.servlet.http.HttpServletRequest, java.lang.String, java.lang.String)"><!-- --></A><H3>
startNewUrlString</H3>
<PRE>
private static java.lang.StringBuffer <B>startNewUrlString</B>(javax.servlet.http.HttpServletRequest request,
java.lang.String desiredScheme,
java.lang.String desiredPort)</PRE>
<DL>
<DD>Builds the protocol, server name, and port portion of the new URL
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - The current request<DD><CODE>desiredScheme</CODE> - The scheme (http or https) to be used in the new URL<DD><CODE>desiredPort</CODE> - The port number to be used in th enew URL
<DT><B>Returns:</B><DD>The new URL as a StringBuffer</DL>
</DD>
</DL>
<HR>
<A NAME="toEncoded(java.lang.String, java.lang.String)"><!-- --></A><H3>
toEncoded</H3>
<PRE>
public java.lang.String <B>toEncoded</B>(java.lang.String url,
java.lang.String sessionId)</PRE>
<DL>
<DD>Return the specified URL with the specified session identifier
suitably encoded.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>url</CODE> - URL to be encoded with the session id<DD><CODE>sessionId</CODE> - Session id to be included in the encoded URL</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../org/apache/velocity/tools/struts/MessageTool.html"><B>PREV CLASS</B></A>
<A HREF="../../../../../org/apache/velocity/tools/struts/StrutsLinkTool.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="SecureLinkTool.html" TARGET="_top"><B>NO FRAMES</B></A>
<SCRIPT>
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: <A HREF="#nested_classes_inherited_from_class_org.apache.velocity.tools.view.tools.LinkTool">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
Copyright (c) 2003 Apache Software Foundation
</BODY>
</HTML>
1.1 jakarta-velocity-tools/docs/javadoc/org/apache/velocity/tools/struts/ValidatorTool.html
Index: ValidatorTool.html
===================================================================
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc on Tue Oct 28 16:53:05 PST 2003 -->
<TITLE>
ValidatorTool (Velocity-Tools API Documentation)
</TITLE>
<META NAME="keywords" CONTENT="org.apache.velocity.tools.struts.ValidatorTool,ValidatorTool class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
</HEAD>
<SCRIPT>
function asd()
{
parent.document.title="ValidatorTool (Velocity-Tools API Documentation)";
}
</SCRIPT>
<BODY BGCOLOR="white" onload="asd();">
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_top"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../org/apache/velocity/tools/struts/TilesTool.html"><B>PREV CLASS</B></A>
<A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.ValidatorActionComparator.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="ValidatorTool.html" TARGET="_top"><B>NO FRAMES</B></A>
<SCRIPT>
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.apache.velocity.tools.struts</FONT>
<BR>
Class ValidatorTool</H2>
<PRE>
java.lang.Object
|
+--<B>org.apache.velocity.tools.struts.ValidatorTool</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../org/apache/velocity/tools/view/tools/ViewTool.html">ViewTool</A></DD>
</DL>
<HR>
<DL>
<DT>public class <B>ValidatorTool</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../../org/apache/velocity/tools/view/tools/ViewTool.html">ViewTool</A></DL>
<P>
<p>Title: ValidatorTool</p>
<p>Description: View tool to work with the Struts Validator to
produce client side javascript validation.</p>
<p>Usage:
<pre>
Template example:
<!-- javascript form validation -->
#set ($foo = $validator.setFormName("nameofyourform"))
$validator.javascript <-- spits out the dynamic javascript
or simply
$validator.getJavascript("nameOfYourForm")
Toolbox configuration:
<tool>
<key>validator</key>
<scope>request</scope>
<class>package org.apache.velocity.tools.struts.ValidatorTool</class>
</tool>
</pre>
<p>This is an adaptation of the JavascriptValidator Tag
from the Struts 1.1 validator library.</p>
<P>
<P>
<DL>
<DT><B>Version:</B></DT>
<DD>$Revision: 1.1 $ $Date: 2003/10/29 01:04:52 $</DD>
<DT><B>Author:</B></DT>
<DD>David Winterfeldt, David Graham, <a href="mailto:marinoj@centrum.is">Marino A. Jonsson</a>, <a href="mailto:nathan@esha.com">Nathan Bubna</a></DD>
</DL>
<HR>
<P>
<!-- ======== NESTED CLASS SUMMARY ======== -->
<A NAME="nested_class_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Nested Class Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected class</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.ValidatorActionComparator.html">ValidatorTool.ValidatorActionComparator</A></B></CODE>
<BR>
Inner class for use when creating dynamic javascript</TD>
</TR>
</TABLE>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Field Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected javax.servlet.ServletContext</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.html#app">app</A></B></CODE>
<BR>
A reference to the ServletContext</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.html#cdata">cdata</A></B></CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected <A HREF="../../../../../org/apache/velocity/tools/view/context/ViewContext.html">ViewContext</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.html#context">context</A></B></CODE>
<BR>
A reference to the ViewContext</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.html#dynamicJavascript">dynamicJavascript</A></B></CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.html#formName">formName</A></B></CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.html#HTML_BEGIN_COMMENT">HTML_BEGIN_COMMENT</A></B></CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.html#HTML_END_COMMENT">HTML_END_COMMENT</A></B></CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.html#htmlComment">htmlComment</A></B></CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.html#methodName">methodName</A></B></CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.html#page">page</A></B></CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected javax.servlet.http.HttpServletRequest</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.html#request">request</A></B></CODE>
<BR>
A reference to the HttpServletRequest.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected javax.servlet.http.HttpSession</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.html#session">session</A></B></CODE>
<BR>
A reference to the HttpSession.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.html#src">src</A></B></CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.html#staticJavascript">staticJavascript</A></B></CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.html#xhtml">xhtml</A></B></CODE>
<BR>
</TD>
</TR>
</TABLE>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.html#ValidatorTool()">ValidatorTool</A></B>()</CODE>
<BR>
Default constructor.</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Method Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected java.util.List</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.html#createActionList(org.apache.commons.validator.ValidatorResources, org.apache.commons.validator.Form)">createActionList</A></B>(org.apache.commons.validator.ValidatorResources resources,
org.apache.commons.validator.Form form)</CODE>
<BR>
Get List of actions for the given Form.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.html#createMethods(java.util.List)">createMethods</A></B>(java.util.List actions)</CODE>
<BR>
Creates the JavaScript methods list from the given actions.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.html#getCdata()">getCdata</A></B>()</CODE>
<BR>
Returns the cdata setting "true" or "false".</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.html#getDynamicJavascript()">getDynamicJavascript</A></B>()</CODE>
<BR>
Gets whether or not to generate the dynamic
JavaScript.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.html#getDynamicJavascript(org.apache.commons.validator.ValidatorResources, java.util.Locale, org.apache.commons.validator.Form)">getDynamicJavascript</A></B>(org.apache.commons.validator.ValidatorResources resources,
java.util.Locale locale,
org.apache.commons.validator.Form form)</CODE>
<BR>
Generates the dynamic JavaScript for the form.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.html#getFormName()">getFormName</A></B>()</CODE>
<BR>
Gets the key (form name) that will be used
to retrieve a set of validation rules to be
performed on the bean passed in for validation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.html#getHtmlComment()">getHtmlComment</A></B>()</CODE>
<BR>
Gets whether or not to delimit the
JavaScript with html comments.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.html#getJavascript(java.lang.String)">getJavascript</A></B>(java.lang.String formName)</CODE>
<BR>
Render the JavaScript for to perform validations based on the form name.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.html#getJavascriptBegin(java.lang.String)">getJavascriptBegin</A></B>(java.lang.String methods)</CODE>
<BR>
Returns the opening script element and some initial javascript.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.html#getJavascriptEnd()">getJavascriptEnd</A></B>()</CODE>
<BR>
Returns the closing script element.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.html#getJavascriptStaticMethods(org.apache.commons.validator.ValidatorResources)">getJavascriptStaticMethods</A></B>(org.apache.commons.validator.ValidatorResources resources)</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.html#getMethod()">getMethod</A></B>()</CODE>
<BR>
Gets the method name that will be used for the Javascript
validation method name if it has a value.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.html#getNextVar(java.lang.String)">getNextVar</A></B>(java.lang.String input)</CODE>
<BR>
The value <code>null</code> will be returned at the end of the sequence.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.html#getPage()">getPage</A></B>()</CODE>
<BR>
Gets the current page number of a multi-part form.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.html#getSrc()">getSrc</A></B>()</CODE>
<BR>
Gets the src attribute's value when defining
the html script element.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.html#getStartElement()">getStartElement</A></B>()</CODE>
<BR>
Constructs the beginning <script> element depending on xhtml status.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.html#getStaticJavascript()">getStaticJavascript</A></B>()</CODE>
<BR>
Gets whether or not to generate the static
JavaScript.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.html#init(java.lang.Object)">init</A></B>(java.lang.Object obj)</CODE>
<BR>
Initializes this tool.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.html#replaceChar(java.lang.String, int, char)">replaceChar</A></B>(java.lang.String input,
int pos,
char c)</CODE>
<BR>
Replaces a single character in a <code>String</code></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.html#setCdata(boolean)">setCdata</A></B>(boolean cdata)</CODE>
<BR>
Sets the cdata status.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.html#setDynamicJavascript(boolean)">setDynamicJavascript</A></B>(boolean dynamicJavascript)</CODE>
<BR>
Sets whether or not to generate the dynamic
JavaScript.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.html#setFormName(java.lang.String)">setFormName</A></B>(java.lang.String formName)</CODE>
<BR>
Sets the key (form name) that will be used
to retrieve a set of validation rules to be
performed on the bean passed in for validation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.html#setHtmlComment(boolean)">setHtmlComment</A></B>(boolean htmlComment)</CODE>
<BR>
Sets whether or not to delimit the
JavaScript with html comments.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.html#setMethod(java.lang.String)">setMethod</A></B>(java.lang.String methodName)</CODE>
<BR>
Sets the method name that will be used for the Javascript
validation method name if it has a value.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.html#setPage(int)">setPage</A></B>(int page)</CODE>
<BR>
Sets the current page number of a multi-part form.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.html#setSrc(java.lang.String)">setSrc</A></B>(java.lang.String src)</CODE>
<BR>
Sets the src attribute's value (used to include
an external script resource) when defining
the html script element.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.html#setStaticJavascript(boolean)">setStaticJavascript</A></B>(boolean staticJavascript)</CODE>
<BR>
Sets whether or not to generate the static
JavaScript.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class java.lang.Object</B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Field Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="context"><!-- --></A><H3>
context</H3>
<PRE>
protected <A HREF="../../../../../org/apache/velocity/tools/view/context/ViewContext.html">ViewContext</A> <B>context</B></PRE>
<DL>
<DD>A reference to the ViewContext
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="app"><!-- --></A><H3>
app</H3>
<PRE>
protected javax.servlet.ServletContext <B>app</B></PRE>
<DL>
<DD>A reference to the ServletContext
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="request"><!-- --></A><H3>
request</H3>
<PRE>
protected javax.servlet.http.HttpServletRequest <B>request</B></PRE>
<DL>
<DD>A reference to the HttpServletRequest.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="session"><!-- --></A><H3>
session</H3>
<PRE>
protected javax.servlet.http.HttpSession <B>session</B></PRE>
<DL>
<DD>A reference to the HttpSession.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="HTML_BEGIN_COMMENT"><!-- --></A><H3>
HTML_BEGIN_COMMENT</H3>
<PRE>
private static final java.lang.String <B>HTML_BEGIN_COMMENT</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.velocity.tools.struts.ValidatorTool.HTML_BEGIN_COMMENT">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="HTML_END_COMMENT"><!-- --></A><H3>
HTML_END_COMMENT</H3>
<PRE>
private static final java.lang.String <B>HTML_END_COMMENT</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.velocity.tools.struts.ValidatorTool.HTML_END_COMMENT">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="staticJavascript"><!-- --></A><H3>
staticJavascript</H3>
<PRE>
private boolean <B>staticJavascript</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="dynamicJavascript"><!-- --></A><H3>
dynamicJavascript</H3>
<PRE>
private boolean <B>dynamicJavascript</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="htmlComment"><!-- --></A><H3>
htmlComment</H3>
<PRE>
private boolean <B>htmlComment</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="cdata"><!-- --></A><H3>
cdata</H3>
<PRE>
private boolean <B>cdata</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="xhtml"><!-- --></A><H3>
xhtml</H3>
<PRE>
private boolean <B>xhtml</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="formName"><!-- --></A><H3>
formName</H3>
<PRE>
private java.lang.String <B>formName</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="methodName"><!-- --></A><H3>
methodName</H3>
<PRE>
private java.lang.String <B>methodName</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="src"><!-- --></A><H3>
src</H3>
<PRE>
private java.lang.String <B>src</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="page"><!-- --></A><H3>
page</H3>
<PRE>
private int <B>page</B></PRE>
<DL>
<DL>
</DL>
</DL>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="ValidatorTool()"><!-- --></A><H3>
ValidatorTool</H3>
<PRE>
public <B>ValidatorTool</B>()</PRE>
<DL>
<DD>Default constructor. Tool must be initialized before use.
<P>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="init(java.lang.Object)"><!-- --></A><H3>
init</H3>
<PRE>
public void <B>init</B>(java.lang.Object obj)</PRE>
<DL>
<DD>Initializes this tool.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/velocity/tools/view/tools/ViewTool.html#init(java.lang.Object)">init</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/velocity/tools/view/tools/ViewTool.html">ViewTool</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>obj</CODE> - the current ViewContext
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the param is not a ViewContext</DL>
</DD>
</DL>
<HR>
<A NAME="getFormName()"><!-- --></A><H3>
getFormName</H3>
<PRE>
public java.lang.String <B>getFormName</B>()</PRE>
<DL>
<DD>Gets the key (form name) that will be used
to retrieve a set of validation rules to be
performed on the bean passed in for validation.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setFormName(java.lang.String)"><!-- --></A><H3>
setFormName</H3>
<PRE>
public void <B>setFormName</B>(java.lang.String formName)</PRE>
<DL>
<DD>Sets the key (form name) that will be used
to retrieve a set of validation rules to be
performed on the bean passed in for validation.
Specifying a form name places a
<script> </script> tag around the javascript.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getPage()"><!-- --></A><H3>
getPage</H3>
<PRE>
public int <B>getPage</B>()</PRE>
<DL>
<DD>Gets the current page number of a multi-part form.
Only field validations with a matching page numer
will be generated that match the current page number.
Only valid when the formName attribute is set.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setPage(int)"><!-- --></A><H3>
setPage</H3>
<PRE>
public void <B>setPage</B>(int page)</PRE>
<DL>
<DD>Sets the current page number of a multi-part form.
Only field validations with a matching page numer
will be generated that match the current page number.
Only valid when the formName attribute is set.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getMethod()"><!-- --></A><H3>
getMethod</H3>
<PRE>
public java.lang.String <B>getMethod</B>()</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setMethod(java.lang.String)"><!-- --></A><H3>
setMethod</H3>
<PRE>
public void <B>setMethod</B>(java.lang.String methodName)</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getStaticJavascript()"><!-- --></A><H3>
getStaticJavascript</H3>
<PRE>
public boolean <B>getStaticJavascript</B>()</PRE>
<DL>
<DD>Gets whether or not to generate the static
JavaScript. If this is set to 'true', which
is the default, the static JavaScript will be generated.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setStaticJavascript(boolean)"><!-- --></A><H3>
setStaticJavascript</H3>
<PRE>
public void <B>setStaticJavascript</B>(boolean staticJavascript)</PRE>
<DL>
<DD>Sets whether or not to generate the static
JavaScript. If this is set to 'true', which
is the default, the static JavaScript will be generated.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getDynamicJavascript()"><!-- --></A><H3>
getDynamicJavascript</H3>
<PRE>
public boolean <B>getDynamicJavascript</B>()</PRE>
<DL>
<DD>Gets whether or not to generate the dynamic
JavaScript. If this is set to 'true', which
is the default, the dynamic JavaScript will be generated.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setDynamicJavascript(boolean)"><!-- --></A><H3>
setDynamicJavascript</H3>
<PRE>
public void <B>setDynamicJavascript</B>(boolean dynamicJavascript)</PRE>
<DL>
<DD>Sets whether or not to generate the dynamic
JavaScript. If this is set to 'true', which
is the default, the dynamic JavaScript will be generated.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getHtmlComment()"><!-- --></A><H3>
getHtmlComment</H3>
<PRE>
public boolean <B>getHtmlComment</B>()</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setHtmlComment(boolean)"><!-- --></A><H3>
setHtmlComment</H3>
<PRE>
public void <B>setHtmlComment</B>(boolean htmlComment)</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getSrc()"><!-- --></A><H3>
getSrc</H3>
<PRE>
public java.lang.String <B>getSrc</B>()</PRE>
<DL>
<DD>Gets the src attribute's value when defining
the html script element.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setSrc(java.lang.String)"><!-- --></A><H3>
setSrc</H3>
<PRE>
public void <B>setSrc</B>(java.lang.String src)</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getCdata()"><!-- --></A><H3>
getCdata</H3>
<PRE>
public boolean <B>getCdata</B>()</PRE>
<DL>
<DD>Returns the cdata setting "true" or "false".
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>boolean - "true" if JavaScript will be hidden in a CDATA section</DL>
</DD>
</DL>
<HR>
<A NAME="setCdata(boolean)"><!-- --></A><H3>
setCdata</H3>
<PRE>
public void <B>setCdata</B>(boolean cdata)</PRE>
<DL>
<DD>Sets the cdata status.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>cdata</CODE> - The cdata to set</DL>
</DD>
</DL>
<HR>
<A NAME="getJavascript(java.lang.String)"><!-- --></A><H3>
getJavascript</H3>
<PRE>
public java.lang.String <B>getJavascript</B>(java.lang.String formName)
throws java.lang.Exception</PRE>
<DL>
<DD>Render the JavaScript for to perform validations based on the form name.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DD><CODE>java.lang.Exception</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getDynamicJavascript(org.apache.commons.validator.ValidatorResources, java.util.Locale, org.apache.commons.validator.Form)"><!-- --></A><H3>
getDynamicJavascript</H3>
<PRE>
protected java.lang.String <B>getDynamicJavascript</B>(org.apache.commons.validator.ValidatorResources resources,
java.util.Locale locale,
org.apache.commons.validator.Form form)</PRE>
<DL>
<DD>Generates the dynamic JavaScript for the form.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="createMethods(java.util.List)"><!-- --></A><H3>
createMethods</H3>
<PRE>
protected java.lang.String <B>createMethods</B>(java.util.List actions)</PRE>
<DL>
<DD>Creates the JavaScript methods list from the given actions.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>actions</CODE> - A List of ValidatorAction objects.
<DT><B>Returns:</B><DD>JavaScript methods.</DL>
</DD>
</DL>
<HR>
<A NAME="createActionList(org.apache.commons.validator.ValidatorResources, org.apache.commons.validator.Form)"><!-- --></A><H3>
createActionList</H3>
<PRE>
protected java.util.List <B>createActionList</B>(org.apache.commons.validator.ValidatorResources resources,
org.apache.commons.validator.Form form)</PRE>
<DL>
<DD>Get List of actions for the given Form.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>A sorted List of ValidatorAction objects.</DL>
</DD>
</DL>
<HR>
<A NAME="getJavascriptBegin(java.lang.String)"><!-- --></A><H3>
getJavascriptBegin</H3>
<PRE>
protected java.lang.String <B>getJavascriptBegin</B>(java.lang.String methods)</PRE>
<DL>
<DD>Returns the opening script element and some initial javascript.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getJavascriptStaticMethods(org.apache.commons.validator.ValidatorResources)"><!-- --></A><H3>
getJavascriptStaticMethods</H3>
<PRE>
protected java.lang.String <B>getJavascriptStaticMethods</B>(org.apache.commons.validator.ValidatorResources resources)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getJavascriptEnd()"><!-- --></A><H3>
getJavascriptEnd</H3>
<PRE>
protected java.lang.String <B>getJavascriptEnd</B>()</PRE>
<DL>
<DD>Returns the closing script element.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getNextVar(java.lang.String)"><!-- --></A><H3>
getNextVar</H3>
<PRE>
private java.lang.String <B>getNextVar</B>(java.lang.String input)</PRE>
<DL>
<DD>The value <code>null</code> will be returned at the end of the sequence.
ex: "zz" will return <code>null</code>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="replaceChar(java.lang.String, int, char)"><!-- --></A><H3>
replaceChar</H3>
<PRE>
private java.lang.String <B>replaceChar</B>(java.lang.String input,
int pos,
char c)</PRE>
<DL>
<DD>Replaces a single character in a <code>String</code>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getStartElement()"><!-- --></A><H3>
getStartElement</H3>
<PRE>
private java.lang.String <B>getStartElement</B>()</PRE>
<DL>
<DD>Constructs the beginning <script> element depending on xhtml status.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../org/apache/velocity/tools/struts/TilesTool.html"><B>PREV CLASS</B></A>
<A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.ValidatorActionComparator.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="ValidatorTool.html" TARGET="_top"><B>NO FRAMES</B></A>
<SCRIPT>
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
Copyright (c) 2003 Apache Software Foundation
</BODY>
</HTML>
1.1 jakarta-velocity-tools/docs/javadoc/org/apache/velocity/tools/struts/ValidatorTool.ValidatorActionComparator.html
Index: ValidatorTool.ValidatorActionComparator.html
===================================================================
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc on Tue Oct 28 16:53:05 PST 2003 -->
<TITLE>
ValidatorTool.ValidatorActionComparator (Velocity-Tools API Documentation)
</TITLE>
<META NAME="keywords" CONTENT="org.apache.velocity.tools.struts.ValidatorTool.ValidatorActionComparator,ValidatorTool.ValidatorActionComparator class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
</HEAD>
<SCRIPT>
function asd()
{
parent.document.title="ValidatorTool.ValidatorActionComparator (Velocity-Tools API Documentation)";
}
</SCRIPT>
<BODY BGCOLOR="white" onload="asd();">
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_top"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.html"><B>PREV CLASS</B></A>
NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="ValidatorTool.ValidatorActionComparator.html" TARGET="_top"><B>NO FRAMES</B></A>
<SCRIPT>
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.apache.velocity.tools.struts</FONT>
<BR>
Class ValidatorTool.ValidatorActionComparator</H2>
<PRE>
java.lang.Object
|
+--<B>org.apache.velocity.tools.struts.ValidatorTool.ValidatorActionComparator</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD>java.util.Comparator</DD>
</DL>
<DL>
<DT><B>Enclosing class:</B><DD><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.html">ValidatorTool</A></DD>
</DL>
<HR>
<DL>
<DT>protected class <B>ValidatorTool.ValidatorActionComparator</B><DT>extends java.lang.Object<DT>implements java.util.Comparator</DL>
<P>
Inner class for use when creating dynamic javascript
<P>
<P>
<HR>
<P>
<!-- ======== NESTED CLASS SUMMARY ======== -->
<!-- =========== FIELD SUMMARY =========== -->
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected </CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.ValidatorActionComparator.html#ValidatorTool.ValidatorActionComparator()">ValidatorTool.ValidatorActionComparator</A></B>()</CODE>
<BR>
</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Method Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.ValidatorActionComparator.html#compare(java.lang.Object, java.lang.Object)">compare</A></B>(java.lang.Object o1,
java.lang.Object o2)</CODE>
<BR>
</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class java.lang.Object</B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.util.Comparator"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from interface java.util.Comparator</B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>equals</CODE></TD>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="ValidatorTool.ValidatorActionComparator()"><!-- --></A><H3>
ValidatorTool.ValidatorActionComparator</H3>
<PRE>
protected <B>ValidatorTool.ValidatorActionComparator</B>()</PRE>
<DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="compare(java.lang.Object, java.lang.Object)"><!-- --></A><H3>
compare</H3>
<PRE>
public int <B>compare</B>(java.lang.Object o1,
java.lang.Object o2)</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>compare</CODE> in interface <CODE>java.util.Comparator</CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../org/apache/velocity/tools/struts/ValidatorTool.html"><B>PREV CLASS</B></A>
NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="ValidatorTool.ValidatorActionComparator.html" TARGET="_top"><B>NO FRAMES</B></A>
<SCRIPT>
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
Copyright (c) 2003 Apache Software Foundation
</BODY>
</HTML>
---------------------------------------------------------------------
To unsubscribe, e-mail: velocity-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: velocity-dev-help@jakarta.apache.org