| <!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 Fri Aug 22 03:44:10 EDT 2003 --> |
| <TITLE> |
| ActionForm (Apache Struts API Documentation) |
| </TITLE> |
| <META NAME="keywords" CONTENT="org.apache.struts.action.ActionForm,ActionForm class"> |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
| </HEAD> |
| <SCRIPT> |
| function asd() |
| { |
| parent.document.title="ActionForm (Apache Struts 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="class-use/ActionForm.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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/struts/action/ActionException.html"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/struts/action/ActionFormBean.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="ActionForm.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 | <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.struts.action</FONT> |
| <BR> |
| Class ActionForm</H2> |
| <PRE> |
| java.lang.Object |
| | |
| +--<B>org.apache.struts.action.ActionForm</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD> |
| </DL> |
| <DL> |
| <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/apache/struts/action/DynaActionForm.html">DynaActionForm</A>, <A HREF="../../../../org/apache/struts/validator/ValidatorForm.html">ValidatorForm</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT>public abstract class <B>ActionForm</B><DT>extends java.lang.Object<DT>implements java.io.Serializable</DL> |
| |
| <P> |
| <p>An <strong>ActionForm</strong> is a JavaBean optionally associated with |
| one or more <code>ActionMappings</code>. Such a bean will have had its |
| properties initialized from the corresponding request parameters before |
| the corresonding action's <code>execute</code> method is called.</p> |
| |
| <p>When the properties of this bean have been populated, but before the |
| <code>execute</code> method of the action is called, this bean's |
| <code>validate</code> method will be called, which gives the bean a chance |
| to verify that the properties submitted by the user are correct and valid. |
| If this method finds problems, it returns an error messages object that |
| encapsulates those problems, and the controller servlet will return control |
| to the corresponding input form. Otherwise, the <code>validate</code> |
| method returns <code>null</code>, indicating that everything is acceptable |
| and the corresponding Action's <code>execute</code> method should be |
| called.</p> |
| |
| <p>This class must be subclassed in order to be instantiated. Subclasses |
| should provide property getter and setter methods for all of the bean |
| properties they wish to expose, plus override any of the public or |
| protected methods for which they wish to provide modified functionality. |
| </p> |
| |
| <p>Because ActionForms are JavaBeans, subclasses should also implement |
| <code>Serializable</code>, as required by the JavaBean specification. |
| Some containers require that an object meet all JavaBean requirements |
| in order to use the introspection API upon which ActionForms rely.</p> |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Version:</B></DT> |
| <DD>$Revision: 1.1 $ $Date$</DD> |
| <DT><B>Author:</B></DT> |
| <DD>Craig R. McClanahan, Ted Husted</DD> |
| <DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html" TARGET="org.apache.struts.action.ActionForm">Serialized Form</A></DL> |
| <HR> |
| |
| <P> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| |
| |
| <!-- =========== 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 <A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionForm.html#multipartRequestHandler">multipartRequestHandler</A></B></CODE> |
| |
| <BR> |
| The MultipartRequestHandler for this form, can be |
| <code>null</code>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="../../../../org/apache/struts/action/ActionServlet.html">ActionServlet</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionForm.html#servlet">servlet</A></B></CODE> |
| |
| <BR> |
| The controller servlet instance to which we are attached.</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/struts/action/ActionForm.html#ActionForm()">ActionForm</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> <A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionForm.html#getMultipartRequestHandler()">getMultipartRequestHandler</A></B>()</CODE> |
| |
| <BR> |
| Return the MultipartRequestHandler for this form |
| The reasoning behind this is to give form bean developers |
| control over the lifecycle of their multipart requests |
| through the use of the finish() and/or rollback() methods |
| of MultipartRequestHandler.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="../../../../org/apache/struts/action/ActionServlet.html">ActionServlet</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionForm.html#getServlet()">getServlet</A></B>()</CODE> |
| |
| <BR> |
| Return the controller servlet instance to which we are attached.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/struts/action/ActionServletWrapper.html">ActionServletWrapper</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionForm.html#getServletWrapper()">getServletWrapper</A></B>()</CODE> |
| |
| <BR> |
| Return the controller servlet instance to which we are attached.</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/struts/action/ActionForm.html#reset(org.apache.struts.action.ActionMapping, javax.servlet.http.HttpServletRequest)">reset</A></B>(<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping, |
| javax.servlet.http.HttpServletRequest request)</CODE> |
| |
| <BR> |
| Reset all bean properties to their default state.</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/struts/action/ActionForm.html#reset(org.apache.struts.action.ActionMapping, javax.servlet.ServletRequest)">reset</A></B>(<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping, |
| javax.servlet.ServletRequest request)</CODE> |
| |
| <BR> |
| Reset all bean properties to their default state.</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/struts/action/ActionForm.html#setMultipartRequestHandler(org.apache.struts.upload.MultipartRequestHandler)">setMultipartRequestHandler</A></B>(<A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A> multipartRequestHandler)</CODE> |
| |
| <BR> |
| Set the Handler provides to use in dealing with file uploads.</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/struts/action/ActionForm.html#setServlet(org.apache.struts.action.ActionServlet)">setServlet</A></B>(<A HREF="../../../../org/apache/struts/action/ActionServlet.html">ActionServlet</A> servlet)</CODE> |
| |
| <BR> |
| Set the controller servlet instance to which we are attached (if |
| <code>servlet</code> is non-null), or release any allocated resources |
| (if <code>servlet</code> is null).</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/struts/action/ActionErrors.html">ActionErrors</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionForm.html#validate(org.apache.struts.action.ActionMapping, javax.servlet.http.HttpServletRequest)">validate</A></B>(<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping, |
| javax.servlet.http.HttpServletRequest request)</CODE> |
| |
| <BR> |
| Validate the properties that have been set for this HTTP request, |
| and return an <code>ActionErrors</code> object that encapsulates any |
| validation errors that have been found.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/struts/action/ActionErrors.html">ActionErrors</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionForm.html#validate(org.apache.struts.action.ActionMapping, javax.servlet.ServletRequest)">validate</A></B>(<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping, |
| javax.servlet.ServletRequest request)</CODE> |
| |
| <BR> |
| Validate the properties that have been set for this non-HTTP request, |
| and return an <code>ActionErrors</code> object that encapsulates any |
| validation errors that have been found.</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="servlet"><!-- --></A><H3> |
| servlet</H3> |
| <PRE> |
| protected transient <A HREF="../../../../org/apache/struts/action/ActionServlet.html">ActionServlet</A> <B>servlet</B></PRE> |
| <DL> |
| <DD>The controller servlet instance to which we are attached. |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="multipartRequestHandler"><!-- --></A><H3> |
| multipartRequestHandler</H3> |
| <PRE> |
| protected transient <A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A> <B>multipartRequestHandler</B></PRE> |
| <DL> |
| <DD>The MultipartRequestHandler for this form, can be |
| <code>null</code>. |
| <P> |
| <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="ActionForm()"><!-- --></A><H3> |
| ActionForm</H3> |
| <PRE> |
| public <B>ActionForm</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="getServlet()"><!-- --></A><H3> |
| getServlet</H3> |
| <PRE> |
| protected <A HREF="../../../../org/apache/struts/action/ActionServlet.html">ActionServlet</A> <B>getServlet</B>()</PRE> |
| <DL> |
| <DD>Return the controller servlet instance to which we are attached. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getServletWrapper()"><!-- --></A><H3> |
| getServletWrapper</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/struts/action/ActionServletWrapper.html">ActionServletWrapper</A> <B>getServletWrapper</B>()</PRE> |
| <DL> |
| <DD>Return the controller servlet instance to which we are attached. |
| as an ActionServletWrapper. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>Struts 1.0.1</DD> |
| <DT><B>See Also:</B><DD><A HREF="../../../../org/apache/struts/action/ActionServletWrapper.html"><CODE>ActionServletWrapper</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getMultipartRequestHandler()"><!-- --></A><H3> |
| getMultipartRequestHandler</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A> <B>getMultipartRequestHandler</B>()</PRE> |
| <DL> |
| <DD>Return the MultipartRequestHandler for this form |
| The reasoning behind this is to give form bean developers |
| control over the lifecycle of their multipart requests |
| through the use of the finish() and/or rollback() methods |
| of MultipartRequestHandler. This method will return |
| <code>null</code> if this form's enctype is not |
| "multipart/request-data". |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html"><CODE>MultipartRequestHandler</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setServlet(org.apache.struts.action.ActionServlet)"><!-- --></A><H3> |
| setServlet</H3> |
| <PRE> |
| public void <B>setServlet</B>(<A HREF="../../../../org/apache/struts/action/ActionServlet.html">ActionServlet</A> servlet)</PRE> |
| <DL> |
| <DD>Set the controller servlet instance to which we are attached (if |
| <code>servlet</code> is non-null), or release any allocated resources |
| (if <code>servlet</code> is null). |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>servlet</CODE> - The new controller servlet, if any</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setMultipartRequestHandler(org.apache.struts.upload.MultipartRequestHandler)"><!-- --></A><H3> |
| setMultipartRequestHandler</H3> |
| <PRE> |
| public void <B>setMultipartRequestHandler</B>(<A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html">MultipartRequestHandler</A> multipartRequestHandler)</PRE> |
| <DL> |
| <DD>Set the Handler provides to use in dealing with file uploads. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>multipartRequestHandler</CODE> - The Handler to use for fileuploads.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="reset(org.apache.struts.action.ActionMapping, javax.servlet.ServletRequest)"><!-- --></A><H3> |
| reset</H3> |
| <PRE> |
| public void <B>reset</B>(<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping, |
| javax.servlet.ServletRequest request)</PRE> |
| <DL> |
| <DD>Reset all bean properties to their default state. This method is |
| called before the properties are repopulated by the controller servlet. |
| <p> |
| The default implementation attempts to forward to the HTTP |
| version of this method. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>mapping</CODE> - The mapping used to select this instance<DD><CODE>request</CODE> - The servlet request we are processing</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="reset(org.apache.struts.action.ActionMapping, javax.servlet.http.HttpServletRequest)"><!-- --></A><H3> |
| reset</H3> |
| <PRE> |
| public void <B>reset</B>(<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping, |
| javax.servlet.http.HttpServletRequest request)</PRE> |
| <DL> |
| <DD>Reset all bean properties to their default state. This method is |
| called before the properties are repopulated by the controller servlet. |
| <p> |
| The default implementation does nothing. Subclasses should override |
| this method to reset all bean properties to default values. |
| </p> |
| <p> |
| This method is <strong>not</strong> the appropriate place to initialize form values |
| for an "update" type page (this should be done in a setup Action). You mainly |
| need to worry about setting checkbox values to false; most of the time you |
| can leave this method unimplemented. |
| </p> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>mapping</CODE> - The mapping used to select this instance<DD><CODE>request</CODE> - The servlet request we are processing</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="validate(org.apache.struts.action.ActionMapping, javax.servlet.ServletRequest)"><!-- --></A><H3> |
| validate</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/struts/action/ActionErrors.html">ActionErrors</A> <B>validate</B>(<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping, |
| javax.servlet.ServletRequest request)</PRE> |
| <DL> |
| <DD>Validate the properties that have been set for this non-HTTP request, |
| and return an <code>ActionErrors</code> object that encapsulates any |
| validation errors that have been found. If no errors are found, return |
| <code>null</code> or an <code>ActionErrors</code> object with no |
| recorded error messages. |
| <p> |
| The default implementation attempts to forward to the HTTP version of |
| this method. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>mapping</CODE> - The mapping used to select this instance<DD><CODE>request</CODE> - The servlet request we are processing</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="validate(org.apache.struts.action.ActionMapping, javax.servlet.http.HttpServletRequest)"><!-- --></A><H3> |
| validate</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/struts/action/ActionErrors.html">ActionErrors</A> <B>validate</B>(<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping, |
| javax.servlet.http.HttpServletRequest request)</PRE> |
| <DL> |
| <DD>Validate the properties that have been set for this HTTP request, |
| and return an <code>ActionErrors</code> object that encapsulates any |
| validation errors that have been found. If no errors are found, |
| return <code>null</code> or an <code>ActionErrors</code> object with |
| no recorded error messages. |
| <p> |
| The default ipmlementation performs no validation and returns |
| <code>null</code>. Subclasses must override this method to provide |
| any validation they wish to perform. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>mapping</CODE> - The mapping used to select this instance<DD><CODE>request</CODE> - The servlet request we are processing</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="class-use/ActionForm.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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/struts/action/ActionException.html"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/struts/action/ActionFormBean.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="ActionForm.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 | <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 © 2000-2003 - Apache Software Foundation |
| </BODY> |
| </HTML> |
