craigmcc 01/01/22 21:06:49
Modified: src/doc/userGuide building_controller.xml building_model.xml
building_view.xml
Log:
More tweaks to improve the printability of the User's Guide, without
having to resort wholesale to smaller font sizes for the examples. The
entire guide will now print for me in portrait mode.
Revision Changes Path
1.9 +146 -101 jakarta-struts/src/doc/userGuide/building_controller.xml
Index: building_controller.xml
===================================================================
RCS file: /home/cvs/jakarta-struts/src/doc/userGuide/building_controller.xml,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- building_controller.xml 2001/01/22 04:44:07 1.8
+++ building_controller.xml 2001/01/23 05:06:49 1.9
@@ -8,7 +8,7 @@
</properties>
<body>
- <chapter name="Building Controller Components" href="building_controller">
+ <chapter name="4. Building Controller Components" href="building_controller">
<section name="4.1 Overview" href="overview">
@@ -39,19 +39,21 @@
<p>The <code>Action</code> class defines two methods that could be
executed depending on your servlet environment:
-<pre><font size="-1">public ActionForward perform(ActionMapping mapping,
- ActionForm form,
- ServletRequest request,
- ServletResponse response)
- throws IOException, ServletException
-
- public ActionForward perform(ActionMapping mapping,
- ActionForm form,
- HttpServletRequest request,
- HttpServletResponse response)
- throws IOException, ServletException
-</font></pre>
</p>
+
+<pre>
+public ActionForward perform(ActionMapping mapping,
+ ActionForm form,
+ ServletRequest request,
+ ServletResponse response)
+ throws IOException, ServletException;
+
+public ActionForward perform(ActionMapping mapping,
+ ActionForm form,
+ HttpServletRequest request,
+ HttpServletResponse response)
+ throws IOException, ServletException;
+</pre>
<p>
Most people would only use the "HttpServletRequest" version.
@@ -265,25 +267,32 @@
to illustrate the requirements. Note that the entries for all the other
actions
are left out:
</p>
-<pre><font size="-1"><struts-config>
- <form-beans>
- <form-bean name="logonForm"
- type="org.apache.struts.example.LogonForm">
- </form-beans>
- <global-forwards type="org.apache.struts.action.ActionForward">
- <forward name="logon" path="/logon.jsp" redirect="false" />
- </global-forwards>
- <action-mappings>
- <action path="/logon"
- type="org.apache.struts.example.LogonAction"
- name="logonForm"
- scope="request"
- input="/logon.jsp"
- unknown="false"
- validate="true" />
- </action-mappings>
- </struts-config>
-</font></pre>
+
+<pre>
+<struts-config>
+ <form-beans>
+ <form-bean
+ name="logonForm"
+ type="org.apache.struts.example.LogonForm" />
+ </form-beans>
+ <global-forwards
+ type="org.apache.struts.action.ActionForward" />
+ <forward name="logon" path="/logon.jsp"
+ redirect="false" />
+ </global-forwards>
+ <action-mappings>
+ <action
+ path="/logon"
+ type="org.apache.struts.example.LogonAction"
+ name="logonForm"
+ scope="request"
+ input="/logon.jsp"
+ unknown="false"
+ validate="true" />
+ </action-mappings>
+</struts-config>
+</pre>
+
<p>
First the form bean is defined. A basic bean of class
"org.apache.struts.example.LogonForm"
is mapped to the logical name "logonForm". This name is used as a session
or request attribute
@@ -309,21 +318,23 @@
specifies data sources that your application can use.This is how you would
specify a basic data source for your application inside
of struts-config.xml:
</p>
- <p>
-<pre><font size="-1"><struts-config>
- <data-sources>
- <data-source autoCommit="false"
- description="Example Data Source Description"
- driverClass="org.postgresql.Driver"
- maxCount="4"
- minCount="2"
- password="mypassword"
- url="jdbc:postgresql://localhost/mydatabase"
- user="myusername"/>
- </data-sources>
- </struts-config>
-</font></pre>
- </p>
+
+<pre>
+<struts-config>
+ <data-sources>
+ <data-source
+ autoCommit="false"
+ description="Example Data Source Description"
+ driverClass="org.postgresql.Driver"
+ maxCount="4"
+ minCount="2"
+ password="mypassword"
+ url="jdbc:postgresql://localhost/mydatabase"
+ user="myusername"/>
+ </data-sources>
+</struts-config>
+</pre>
+
<p>
For information on how to retrieve the data source, see the
<a href="building_model.html#databases">Accessing Relational Databases</a>
section.
@@ -345,29 +356,39 @@
<p>
Add an entry defining the action servlet itself, along with the
appropriate
initialization parameters. Such an entry might look like this:
-<pre><font size="-1"><servlet>
- <servlet-name>action</servlet-name>
-
<servlet-class>org.apache.struts.action.ActionServlet</servlet-class>
- <init-param>
- <param-name>application</param-name>
-
<param-value>org.apache.struts.example.ApplicationResources</param-value>
- </init-param>
- <init-param>
- <param-name>config</param-name>
- <param-value>/WEB-INF/struts-config.xml</param-value>
- </init-param>
- <init-param>
- <param-name>debug</param-name>
- <param-value>2</param-value>
- </init-param>
- <init-param>
- <param-name>mapping</param-name>
-
<param-value>org.apache.struts.example.ApplicationMapping</param-value>
- </init-param>
- <load-on-startup>2</load-on-startup>
- </servlet>
-</font></pre>
</p>
+
+<pre>
+<servlet>
+ <servlet-name>action</servlet-name>
+ <servlet-class>
+ org.apache.struts.action.ActionServlet
+ </servlet-class>
+ <init-param>
+ <param-name>application</param-name>
+ <param-value>
+ org.apache.struts.example.ApplicationResources
+ </param-value>
+ </init-param>
+ <init-param>
+ <param-name>config</param-name>
+ <param-value>
+ /WEB-INF/struts-config.xml
+ </param-value>
+ </init-param>
+ <init-param>
+ <param-name>debug</param-name>
+ <param-value>2</param-value>
+ </init-param>
+ <init-param>
+ <param-name>mapping</param-name>
+ <param-value>
+ org.apache.struts.example.ApplicationMapping
+ </param-value>
+ </init-param>
+ <load-on-startup>2</load-on-startup>
+</servlet>
+</pre>
<p>
The initialization parameters supported by the controller servlet are
@@ -465,19 +486,22 @@
path part) with a particular value to be passed to this servlet. Such an
entry might look like this:
</p>
-<pre><font size="-1"><servlet-mapping>
+
+<pre>
+ <servlet-mapping>
<servlet-name>action</servlet-name>
<url-pattern>/execute/*</url-pattern>
</servlet-mapping>
-</font></pre>
+</pre>
<p>
which means that a request URI to match the <code>/logon</code> path
described earlier might look like this:</p>
- <p>
- <code> http://www.mycompany.com/myapplication/execute/logon</code>
- </p>
-
+
+<pre><font size="-1">
+http://www.mycompany.com/myapplication/execute/logon
+</font></pre>
+
<p>
where <code>/myapplication</code> is the context path under which your
application is deployed.
@@ -490,18 +514,23 @@
to the <code>*.jsp</code> pattern so that it is called to process every
JSP page that is requested. To use the <code>*.do</code> extension (which
implies "do something"), the mapping entry would look like this:
-<pre><font size="-1"><servlet-mapping>
+ </p>
+
+<pre>
+ <servlet-mapping>
<servlet-name>action</servlet-name>
<url-pattern>*.do</url-pattern>
</servlet-mapping>
-</font></pre>
- </p>
+</pre>
<p>
and a request URI to match the <code>/logon</code> path described
- earlier might look like this:<br />
- <code> http://www.mycompany.com/myapplication/logon.do</code>
+ earlier might look like this:
</p>
+
+<pre><font size="-1">
+http://www.mycompany.com/myapplication/logon.do
+</font></pre>
</section>
<section name="4.5.3 Configure the Struts Tag Library"
href="dd_config_taglib">
@@ -532,26 +561,44 @@
<p>
Below is how you would define all taglibs for use within your application,
- in reality you would only specify the taglib's that your application will
use:
-<pre><font size="-1"><taglib>
- <taglib-uri>/WEB-INF/struts-bean.tld</taglib-uri>
- <taglib-location>/WEB-INF/struts-bean.tld</taglib-location>
- </taglib>
- <taglib>
- <taglib-uri>/WEB-INF/struts-html.tld</taglib-uri>
- <taglib-location>/WEB-INF/struts-html.tld</taglib-location>
- </taglib>
- <taglib>
- <taglib-uri>/WEB-INF/struts-logic.tld</taglib-uri>
- <taglib-location>/WEB-INF/struts-logic.tld</taglib-location>
- </taglib>
- <taglib>
- <taglib-uri>/WEB-INF/struts-template.tld</taglib-uri>
- <taglib-location>/WEB-INF/struts-template.tld</taglib-location>
- </taglib>
-</font></pre>
+ in reality you would only specify the taglib's that your application will
use:
</p>
-
+
+<pre>
+<taglib>
+ <taglib-uri>
+ /WEB-INF/struts-bean.tld
+ </taglib-uri>
+ <taglib-location>
+ /WEB-INF/struts-bean.tld
+ </taglib-location>
+</taglib>
+<taglib>
+ <taglib-uri>
+ /WEB-INF/struts-html.tld
+ </taglib-uri>
+ <taglib-location>
+ /WEB-INF/struts-html.tld
+ </taglib-location>
+</taglib>
+<taglib>
+ <taglib-uri>
+ /WEB-INF/struts-logic.tld
+ </taglib-uri>
+ <taglib-location>
+ /WEB-INF/struts-logic.tld
+ </taglib-location>
+</taglib>
+<taglib>
+ <taglib-uri>
+ /WEB-INF/struts-template.tld
+ </taglib-uri>
+ <taglib-location>
+ /WEB-INF/struts-template.tld
+ </taglib-location>
+</taglib>
+</pre>
+
<p>
This tells the JSP system where to find the tag library descriptor
for this library (in your application's WEB-INF directory, instead of
@@ -573,5 +620,3 @@
</chapter>
</body>
</document>
-
-
1.11 +23 -21 jakarta-struts/src/doc/userGuide/building_model.xml
Index: building_model.xml
===================================================================
RCS file: /home/cvs/jakarta-struts/src/doc/userGuide/building_model.xml,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- building_model.xml 2001/01/23 04:08:18 1.10
+++ building_model.xml 2001/01/23 05:06:49 1.11
@@ -8,7 +8,7 @@
</properties>
<body>
- <chapter name="Building Model Components" href="building_model">
+ <chapter name="2. Building Model Components" href="building_model">
<section name="2.1 Overview" href="overview">
@@ -227,31 +227,33 @@
</p>
<p>
After the datasource is defined, here is an example of establishing a
connection
- from within a Action perform method.
+ from within a Action perform method.
</p>
<pre>
- public ActionForward perform(ActionMapping mapping,
- ActionForm form,
- HttpServletRequest request,
- HttpServletResponse response) {
+public ActionForward
+ perform(ActionMapping mapping,
+ ActionForm form,
+ HttpServletRequest request,
+ HttpServletResponse response)
+{
+ try {
+ javax.sql.DataSource dataSource =
+ servlet.findDataSource(null);
+ java.sql.Connection myConnection =
+ dataSource.getConnection();
+ //do what you wish with myConnection
+ } catch (SQLException sqle) {
+ getServlet().log("Connection.process", sqle);
+ } finally {
+ //enclose this in a finally block to make
+ //sure the connection is closed
try {
- javax.sql.DataSource dataSource = servlet.findDataSource(null);
- java.sql.Connection myConnection = dataSource.getConnection();
- //do what you wish with myConnection
+ myConnection.close();
+ } catch (SQLException e) {
+ getServlet().log("Connection.close", e);
}
- catch (SQLException sqle) {
- getServlet().log("Connection.process", sqle);
- }
- finally {
- //enclose this in a finally block to make
- //sure the connection is closed
- try {
- myConnection.close();
- } catch (SQLException e) {
- getServlet().log("Connection.close", e);
- }
- }
}
+}
</pre>
<p align="center">
1.13 +48 -32 jakarta-struts/src/doc/userGuide/building_view.xml
Index: building_view.xml
===================================================================
RCS file: /home/cvs/jakarta-struts/src/doc/userGuide/building_view.xml,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- building_view.xml 2001/01/22 04:44:07 1.12
+++ building_view.xml 2001/01/23 05:06:49 1.13
@@ -8,7 +8,7 @@
</properties>
<body>
- <chapter name="Building View Components" href="building_view">
+ <chapter name="3. Building View Components" href="building_view">
<section name="3.1 Overview" href="overview">
@@ -132,10 +132,10 @@
<code>username</code> field might look like this (in JSP):
</p>
- <p>
- <code><input type="text" name="username"
- value="<%= loginBean.getUsername() %>"></code>
- </p>
+<pre>
+<input type="text" name="username"
+ value="<%= loginBean.getUsername() %>"/>
+</pre>
<p>
which is difficult to type correctly, confuses HTML developers who are
@@ -143,12 +143,12 @@
HTML editors. Instead, Struts provides a comprehensive facility for
building forms, based on the Custom Tag Library facility of JSP 1.1.
The case above would be rendered like this using Struts:
- </p>
-
- <p>
- <code><html:text property="username"/></code>
</p>
-
+
+<pre>
+<html:text property="username"/>
+</pre>
+
<p>
with no need to explicitly refer to the JavaBean from which the initial
value is retrieved. That is handled automatically by the framework.
@@ -170,12 +170,18 @@
and standard JSP facilities. Consider the following page (based on the
example application included with Struts) named <code>logon.jsp</code>:
</p>
-<pre><font size="-1"><%@ page language="java" %>
-<%@ taglib uri="/WEB-INF/struts-html.tld" prefix="html" %>
-<%@ taglib uri="/WEB-INF/struts-bean.tld" prefix="bean" %>
-<html>
+
+<pre>
+<%@ page language="java" %>
+<%@ taglib uri="/WEB-INF/struts-html.tld"
+ prefix="html" %>
+<%@ taglib uri="/WEB-INF/struts-bean.tld"
+ prefix="bean" %>
+<html:html>
<head>
-<title><bean:message key="logon.title"/></title>
+<title>
+ <bean:message key="logon.title"/>
+</title>
<body bgcolor="white">
<html:errors/>
<html:form name="logonForm" action="logon.do">
@@ -185,7 +191,8 @@
<html:message key="prompt.username"/>
</th>
<td align="left">
- <html:text property="username" size="16"/>
+ <html:text property="username"
+ size="16"/>
</td>
</tr>
<tr>
@@ -193,7 +200,8 @@
<html:message key="prompt.password"/>
</th>
<td align="left">
- <html:password property="password" size="16"/>
+ <html:password property="password"
+ size="16"/>
</td>
</tr>
<tr>
@@ -211,7 +219,9 @@
</table>
</html:form>
</body>
-</html></font></pre>
+</html:html>
+</pre>
+
<p>
The following items illustrate the key features of form handling in
Struts,
based on this example:
@@ -279,22 +289,25 @@
page:
</p>
- <p>
-<pre><font size="-1"><%@page language="java">
-<%@taglib uri="/WEB-INF/struts-html.tld" prefix="html">
+<pre>
+<%@page language="java">
+<%@taglib uri="/WEB-INF/struts-html.tld"
+ prefix="html">
<html:form action="uploadAction.do">
- Please Input Text: <html:text property="myText"><br />
- Please Input The File You Wish to Upload:<br />
+ Please Input Text:
+ <html:text property="myText"><br/>
+ Please Input The File You Wish to Upload:<br/>
<html:file property="myFile"><br />
<html:submit />
</html:form>
-</font></pre>
- </p>
+</pre>
+
<p>
The next step is to create your ActionForm bean:
</p>
- <p>
-<pre><font size="-1">import javax.servlet.http.HttpServletRequest;
+
+<pre>
+import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.apache.struts.action.ActionForm;
import org.apache.struts.action.ActionMapping;
@@ -314,8 +327,8 @@
public FormFile getMyFile() {
return myFile;
}
-}</font></pre>
- </p>
+}
+</pre>
<p>
Look at the <a href="../api/index.html">javadocs</a> for FormFile to see
the
@@ -397,10 +410,13 @@
offers an additional facility to validate the input fields it has
received.
To utilize this feature, override the following method in your ActionForm
class:
- <pre><font size="-1">public ActionErrors validate(ActionMapping mapping,
- HttpServletRequest request)
- </font></pre>
</p>
+
+<pre>
+public ActionErrors
+ validate(ActionMapping mapping,
+ HttpServletRequest request);
+</pre>
<p>
The validate() method is called by the controller servlet after the bean
