You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@struts.apache.org by cr...@locus.apache.org on 2000/06/01 23:06:28 UTC

cvs commit: jakarta-struts/web/documentation tags.html index.jsp

craigmcc    00/06/01 14:06:28

  Modified:    src/conf struts.tld
               src/share/org/apache/struts/taglib ErrorsTag.java
                        MessageTag.java
               web/documentation index.jsp
  Added:       web/documentation tags.html
  Log:
  Write a reference document describing the details of using all of the
  custom tags included in Struts.  Migrate the descriptive text out of the
  "struts.tld" file (where nobody was likely to find it anyway :-).  The
  new page is part of the "struts-documentation.war" web application.
  
  Tweak the behavior of the <struts:errors> and <struts:message> tags to
  match the documentation.
  
  Revision  Changes    Path
  1.2       +9 -301    jakarta-struts/src/conf/struts.tld
  
  Index: struts.tld
  ===================================================================
  RCS file: /home/cvs/jakarta-struts/src/conf/struts.tld,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- struts.tld	2000/05/31 22:28:10	1.1
  +++ struts.tld	2000/06/01 21:06:24	1.2
  @@ -25,25 +25,6 @@
       <tagclass>org.apache.struts.taglib.EnumerateTag</tagclass>
       <teiclass>org.apache.struts.taglib.EnumerateTei</teiclass>
       <bodycontent>JSP</bodycontent>
  -    <info>
  -      Repeat the body of this tag for each element of the collection
  -      specified by our attributes.  The collection may be an object
  -      itself, or may be a bean property.  The collection may be an
  -      Enumeration, a Hashtable, a Vector, or an object array.  The
  -      following attributes are supported:
  -
  -      id       - Attribute name of the page scope attribute which is
  -                 visible to the body tag, and contains the current
  -                 element from the collection.
  -      
  -      name     - Attribute name of the collection itself (if property
  -                 is not specified) or the bean whose property is to
  -                 be retrieved as the collection.
  -      
  -      property - Property name of the bean property containing the
  -                 collection, if any.  [The "name" attribute identifies
  -                 the collection bean itself]
  -    </info>
       <attribute>
         <name>id</name>
         <required>true</required>
  @@ -66,16 +47,6 @@
       <name>ifParameterEquals</name>
       <tagclass>org.apache.struts.taglib.IfParameterEqualsTag</tagclass>
       <bodycontent>JSP</bodycontent>
  -    <info>
  -      Conditionally evaluate the body of this tag, if the specified
  -      parameter has the specified value.  For the purposes of this
  -      comparision, a missing parameter is treated as if is a zero-length
  -      string.  The following attributes are supported:
  -
  -      name     - Name of the parameter to be retrieved.  [REQUIRED]
  -      
  -      value    - Value to be compared.  [REQUIRED]
  -    </info>
       <attribute>
         <name>name</name>
         <required>true</required>
  @@ -93,16 +64,6 @@
       <name>ifParameterNotEquals</name>
       <tagclass>org.apache.struts.taglib.IfParameterNotEqualsTag</tagclass>
       <bodycontent>JSP</bodycontent>
  -    <info>
  -      Conditionally evaluate the body of this tag, if the specified
  -      parameter does not have the specified value.  For the purposes of this
  -      comparision, a missing parameter is treated as if is a zero-length
  -      string.  The following attributes are supported:
  -
  -      name     - Name of the parameter to be retrieved.  [REQUIRED]
  -      
  -      value    - Value to be compared.  [REQUIRED]
  -    </info>
       <attribute>
         <name>name</name>
         <required>true</required>
  @@ -122,12 +83,11 @@
     <tag>
       <name>errors</name>
       <tagclass>org.apache.struts.taglib.ErrorsTag</tagclass>
  -    <info>
  -      If an action class has created a String[] request attribute under the
  -      standard key, it is rendered as a list of errors that must be fixed
  -      on the form that is presumably next on this page.  Otherwise, nothing
  -      will be rendered.
  -    </info>
  +    <attribute>
  +      <name>name</name>
  +      <required>false</required>
  +      <rtexprvalue>false</rtexprvalue>
  +    </attribute>
     </tag>
   
   
  @@ -135,28 +95,6 @@
       <name>form</name>
       <tagclass>org.apache.struts.taglib.FormTag</tagclass>
       <bodycontent>JSP</bodycontent>
  -    <info>
  -      Generates an HTML &lt;FORM&gt; tag, containing the template text
  -      and nested field elements inside.  This tag also implicitly uses
  -      or creates a bean (in the specified scope) with the given name and
  -      Java class.  The following attributes are supported, with default
  -      values in square brackets:
  -
  -      action - URL to which this form will be submitted.  [This page]
  -
  -      method - The HTTP method used to submit this requeest (GET, POST).
  -               [POST]
  -
  -      name   - The name of the attribute to be accessed or created in
  -               page scope, as well as the name of the scripting variable
  -               to be created referencing this attribute.
  -
  -      scope  - The JSP scope within which this bean is created or
  -               accessed (request, session).  [session]
  -
  -      type   - Java class of the bean object to be created, if necessary
  -               [Runtime error if creation is needed]
  -    </info>
       <attribute>
         <name>action</name>
         <required>false</required>
  @@ -188,20 +126,6 @@
     <tag>
       <name>checkbox</name>
       <tagclass>org.apache.struts.taglib.CheckboxTag</tagclass>
  -    <info>
  -      Generates an HTML &lt;INPUT&gt; tag of type "checkbox", based
  -      on the specified attributes.  This tag must be nested inside a
  -      form tag.  The following attributes are supported, with default
  -      values in square brackets.
  -
  -      name      - The name of the input field, and of the corresponding
  -                  property in the bean specified in our form tag.  The
  -                  property must be of type "boolean".
  -
  -      value     - A string representing whether the checkbox should be
  -                  initialized as checked ("true" or "yes").  [Use the
  -                  corresponding property value from the bean]
  -    </info>
       <attribute>
         <name>name</name>
         <required>true</required>
  @@ -218,19 +142,6 @@
     <tag>
       <name>hidden</name>
       <tagclass>org.apache.struts.taglib.HiddenTag</tagclass>
  -    <info>
  -      Generates an HTML &lt;INPUT&gt; tag of type "hidden", based on the
  -      specified attributes.  This tag must be nested inside a form tag.
  -      The following attributes are supported, with default values in
  -      square brackets:
  -
  -      name      - The name of the input field, and of the corresponding
  -                  property in the bean specified in our form tag.
  -
  -      value     - Value with which to initialize this field.
  -                  [Corresponding property from the bean specified
  -                  in our form tag]
  -    </info>
       <attribute>
         <name>name</name>
         <required>name</required>
  @@ -247,16 +158,6 @@
     <tag>
       <name>option</name>
       <tagclass>org.apache.struts.taglib.OptionTag</tagclass>
  -    <info>
  -      Generates an HTML &lt;OPTION&gt; element, which must be nested within
  -      a corresponding "select" tag.  If the value specified here matches
  -      the value of the underlying "select" tag, this option will be
  -      marked as "selected" in the rendered element.  The body of this
  -      tag will be presented to the user in the option list.
  -      
  -      value    - The value returned if this option is selected, and is matched
  -                 against the underlying property.
  -    </info>
       <attribute>
         <name>value</name>
         <required>true</required>
  @@ -268,23 +169,6 @@
     <tag>
       <name>password</name>
       <tagclass>org.apache.struts.taglib.PasswordTag</tagclass>
  -    <info>
  -      Generates an HTML &lt;INPUT&gt; tag of type "password", based on the
  -      specified attributes.  This tag must be nested inside a form tag.
  -      The following attributes are supported, with default values in
  -      square brackets:
  -
  -      maxlength - Maximum number of characters allowed.  [No limit]
  -
  -      name      - The name of the input field, and of the corresponding
  -                  property in the bean specified in our form tag.
  -
  -      size      - Number of character positions defined.  [Browser default]
  -
  -      value     - Value with which to initialize this field.
  -                  [Corresponding property from the bean specified
  -                  in our form tag]
  -    </info>
       <attribute>
         <name>maxlength</name>
         <required>false</required>
  @@ -311,17 +195,6 @@
     <tag>
       <name>property</name>
       <tagclass>org.apache.struts.taglib.PropertyTag</tagclass>
  -    <info>
  -      Generates the value of the specified property as readonly text.
  -      This tag must be nested inside a form tag.  The following attributes
  -      are supported, with default values in square brackets:
  -
  -      name      - The name of the property we are displaying.
  -
  -      value     - Value with which to initialize this field.
  -                  [Corresponding property from the bean specified
  -                  in our form tag]
  -    </info>
       <attribute>
         <name>name</name>
         <required>name</required>
  @@ -338,20 +211,6 @@
     <tag>
       <name>radio</name>
       <tagclass>org.apache.struts.taglib.RadioTag</tagclass>
  -    <info>
  -      Generates an HTML &lt;INPUT&gt; tag of type "radio", based
  -      on the specified attributes.  This tag must be nested inside a
  -      form tag.  The following attributes are supported, with default
  -      values in square brackets.
  -
  -      name      - The name of the input field, and of the corresponding
  -                  property in the bean specified in our form tag.  The
  -                  property must be of type "boolean".
  -
  -      value     - A String value matched against the underlying property
  -                  value.  If they match, this radio button will be
  -                  rendered as "checked".
  -    </info>
       <attribute>
         <name>name</name>
         <required>true</required>
  @@ -368,13 +227,6 @@
     <tag>
       <name>reset</name>
       <tagclass>org.apache.struts.taglib.ResetTag</tagclass>
  -    <info>
  -      Generates an HTML &lt;INPUT&gt; tag of type "reset".
  -      The following attributes are supported:
  -      
  -      value   - The value that will be defined for this button
  -                [Body of this tag or "Reset"]
  -    </info>
     </tag>
   
   
  @@ -382,21 +234,6 @@
       <name>select</name>
       <tagclass>org.apache.struts.taglib.SelectTag</tagclass>
       <bodycontent>JSP</bodycontent>
  -    <info>
  -      Generates an HTML &lt;SELECT&gt; element, based on the specified
  -      attributes.  You must use "option" tags nested within this tag
  -      to establish the values of the available options -- any such option
  -      that matches the current property value will be marked selected.
  -      The following attributes are supported, with default values in
  -      square brackets:
  -      
  -      name      - The name of the input field, and of the corresponding
  -                  property in the bean specified in our form tag.
  -
  -      value     - Value with which to initialize this field.
  -                  [Corresponding property from the bean specified
  -                  in our form tag]
  -    </info>
       <attribute>
         <name>name</name>
         <required>true</required>
  @@ -413,19 +250,6 @@
     <tag>
       <name>submit</name>
       <tagclass>org.apache.struts.taglib.SubmitTag</tagclass>
  -    <info>
  -      Generates an HTML &lt;INPUT&gt; tag of type "submit", based
  -      on the specified attributes.  This tag must be nested inside a
  -      form tag.  The following attributes are supported, with default
  -      values in square brackets.
  -
  -      name      - The name of a request parameter that will be included
  -                  with this form submission.  [submit]
  -
  -      value     - The value that will be defined for this request
  -                  parameter, if this submit button is pressed.
  -                  [Body of this tag or "Submit"]
  -    </info>
       <attribute>
         <name>name</name>
         <required>false</required>
  @@ -442,23 +266,6 @@
     <tag>
       <name>text</name>
       <tagclass>org.apache.struts.taglib.TextTag</tagclass>
  -    <info>
  -      Generates an HTML &lt;INPUT&gt; tag of type "text", based on the
  -      specified attributes.  This tag must be nested inside a form tag.
  -      The following attributes are supported, with default values in
  -      square brackets:
  -
  -      maxlength - Maximum number of characters allowed.  [No limit]
  -
  -      name      - The name of the input field, and of the corresponding
  -                  property in the bean specified in our form tag.
  -
  -      size      - Number of character positions defined.  [Browser default]
  -
  -      value     - Value with which to initialize this field.
  -                  [Corresponding property from the bean specified
  -                  in our form tag]
  -    </info>
       <attribute>
         <name>maxlength</name>
         <required>false</required>
  @@ -485,25 +292,6 @@
     <tag>
       <name>textarea</name>
       <tagclass>org.apache.struts.taglib.TextareaTag</tagclass>
  -    <info>
  -      Generates an HTML &lt;TEXTAREA&gt; tag, based on the
  -      specified attributes.  This tag must be nested inside a form tag.
  -      The following attributes are supported, with default values in
  -      square brackets:
  -
  -      cols      - The number of columns allowed for the textarea.
  -                  [Browser default]
  -
  -      name      - The name of the input field, and of the corresponding
  -                  property in the bean specified in our form tag.
  -
  -      rows      - The number of rows allowed for the textarea.
  -                  [Browser default]
  -
  -      value     - Value with which to initialize this field.
  -                  [Corresponding property from the bean specified
  -                  in our form tag]
  -    </info>
       <attribute>
         <name>maxlength</name>
         <required>false</required>
  @@ -533,13 +321,6 @@
     <tag>
       <name>encodeRedirectURL</name>
       <tagclass>org.apache.struts.taglib.EncodeRedirectURLTag</tagclass>
  -    <info>
  -      Encodes the URL specified by the "url" attribute with the
  -      session identifier, if the client is not supporting cookies.
  -      The following attributes are supported:
  -      
  -      url      - URL to be encoded
  -    </info>
       <attribute>
         <name>url</name>
         <required>true</required>
  @@ -551,13 +332,6 @@
     <tag>
       <name>encodeURL</name>
       <tagclass>org.apache.struts.taglib.EncodeURLTag</tagclass>
  -    <info>
  -      Encodes the URL specified by the "url" attribute with the
  -      session identifier, if the client is not supporting cookies.
  -      The following attributes are supported:
  -      
  -      url      - URL to be encoded
  -    </info>
       <attribute>
         <name>url</name>
         <required>true</required>
  @@ -569,19 +343,6 @@
     <tag>
       <name>getProperty</name>
       <tagclass>org.apache.struts.taglib.GetPropertyTag</tagclass>
  -    <info>
  -      Retrieves the specified property from the bean with the specified
  -      attribute name, and makes it available as a scripting variable
  -      for the remainder of the current page.  The following attributes
  -      are supported:
  -      
  -      id       - Attribute key under which the property will be exposed.
  -      
  -      name     - Name of the bean conaining the property to be
  -                 retrieved and exposed.
  -      
  -      property - Name of the property to be retrieved and exposed.
  -    </info>
       <attribute>
         <name>id</name>
         <required>true</required>
  @@ -603,19 +364,6 @@
     <tag>
       <name>htmlProperty</name>
       <tagclass>org.apache.struts.taglib.HtmlPropertyTag</tagclass>
  -    <info>
  -      Places the value of a Bean instance property, converted to a
  -      String, into the implicit "out" object.  It performs the same
  -      function as the standard &lt;jsp:getProperty&gt; tag, except
  -      that the output is encoded appropriately so that characters
  -      significant to HTML do not cause any problems.  The supported
  -      attributes are as follows, with default values in square brackets:
  -
  -      name     - Name of the object instance from which the property
  -                 is obtained.  This object can be in any scope. [REQUIRED]
  -
  -      property - Name of the property to be retrieved.  [REQUIRED]
  -    </info>
       <attribute>
         <name>name</name>
         <required>true</required>
  @@ -633,14 +381,6 @@
       <name>link</name>
       <tagclass>org.apache.struts.taglib.LinkTag</tagclass>
       <bodycontent>JSP</bodycontent>
  -    <info>
  -      Generates a URL encoded hyperlink to the specified URI, with the
  -      body of this tag being the hyperlink text value.
  -      The supported attributes are as follows, with default values in
  -      square brackets.
  -      
  -      href     - Hyperlink URI to be encoded.
  -    </info>
       <attribute>
         <name>href</name>
         <required>true</required>
  @@ -652,14 +392,6 @@
     <tag>
       <name>parameter</name>
       <tagclass>org.apache.struts.taglib.ParameterTag</tagclass>
  -    <info>
  -      Place the value of the specified parameter, suitably HTML filtered,
  -      into the output stream.  If no parameter value is found, a zero
  -      length string is inserted.  The supported attributes are as follows,
  -      with default values in square brackets.
  -
  -      name     - Name of the query parameter to retrieve.
  -    </info>
       <attribute>
         <name>name</name>
         <required>true</required>
  @@ -674,43 +406,19 @@
     <tag>
       <name>message</name>
       <tagclass>org.apache.struts.taglib.MessageTag</tagclass>
  -    <info>
  -      Retrieves an internationalized message from the application resources
  -      component that has been loaded by our controller servlet as a servlet
  -      context attribute.  The supported attributes are as follows, with
  -      default values in square brackets:
  -
  -      bundle - Servlet context attribute key of the resources to be
  -               accessed.  [applicationResources]
  -
  -      locale - The language and/or country selector to use (request
  -               time variables allowed).  [Default Locale]
  -
  -      key -    Message key of the requested message.  [REQUIRED - NO DEFAULT]
  -
  -      arg0 -   First optional argument for parametric replacement.  [NONE]
  -
  -      arg1 -   Second optional argument for parametric replacement.  [NONE]
  -
  -      arg2 -   Third optional argument for parametric replacement.  [NONE]
  -
  -      arg3 -   Fourth optional argument for parametric replacement.  [NONE]
  -
  -      arg4 -   Fifth optional argument for parametric replacement.  [NONE]
  -    </info>
       <attribute>
         <name>bundle</name>
         <required>false</required>
         <rtexprvalue>false</rtexprvalue>
       </attribute>
       <attribute>
  -      <name>locale</name>
  -      <required>false</required>
  +      <name>key</name>
  +      <required>true</required>
         <rtexprvalue>false</rtexprvalue>
       </attribute>
       <attribute>
  -      <name>key</name>
  -      <required>true</required>
  +      <name>locale</name>
  +      <required>false</required>
         <rtexprvalue>false</rtexprvalue>
       </attribute>
       <attribute>
  
  
  
  1.2       +36 -4     jakarta-struts/src/share/org/apache/struts/taglib/ErrorsTag.java
  
  Index: ErrorsTag.java
  ===================================================================
  RCS file: /home/cvs/jakarta-struts/src/share/org/apache/struts/taglib/ErrorsTag.java,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- ErrorsTag.java	2000/05/31 22:28:11	1.1
  +++ ErrorsTag.java	2000/06/01 21:06:27	1.2
  @@ -1,7 +1,7 @@
   /*
  - * $Header: /home/cvs/jakarta-struts/src/share/org/apache/struts/taglib/ErrorsTag.java,v 1.1 2000/05/31 22:28:11 craigmcc Exp $
  - * $Revision: 1.1 $
  - * $Date: 2000/05/31 22:28:11 $
  + * $Header: /home/cvs/jakarta-struts/src/share/org/apache/struts/taglib/ErrorsTag.java,v 1.2 2000/06/01 21:06:27 craigmcc Exp $
  + * $Revision: 1.2 $
  + * $Date: 2000/06/01 21:06:27 $
    *
    * ====================================================================
    *
  @@ -88,7 +88,7 @@
    * </ul>
    *
    * @author Craig R. McClanahan
  - * @version $Revision: 1.1 $ $Date: 2000/05/31 22:28:11 $
  + * @version $Revision: 1.2 $ $Date: 2000/06/01 21:06:27 $
    */
   
   public final class ErrorsTag extends TagSupport {
  @@ -103,6 +103,38 @@
       private static Locale defaultLocale = Locale.getDefault();
   
   
  +    /**
  +     * Name of the request scope attribute containing our error messages,
  +     * if any.
  +     */
  +    private String name = Action.ERROR_KEY;
  +
  +
  +    // ----------------------------------------------------------- Properties
  +
  +
  +    /**
  +     * Return the errors attribute name.
  +     */
  +    public String getName() {
  +
  +	return (this.name);
  +
  +    }
  +
  +
  +    /**
  +     * Set the errors attribute name.
  +     *
  +     * @param name The new errors attribute name
  +     */
  +    public void setName(String name) {
  +
  +	this.name = name;
  +
  +    }
  +
  +
       // ------------------------------------------------------- Public Methods
   
   
  @@ -117,7 +149,7 @@
   	String errors[] = null;
   	try {
   	    errors = (String[]) pageContext.getAttribute
  -	      (Action.ERROR_KEY, PageContext.REQUEST_SCOPE);
  +	      (name, PageContext.REQUEST_SCOPE);
   	} catch (Exception e) {
   	    errors = null;
   	}
  
  
  
  1.2       +8 -33     jakarta-struts/src/share/org/apache/struts/taglib/MessageTag.java
  
  Index: MessageTag.java
  ===================================================================
  RCS file: /home/cvs/jakarta-struts/src/share/org/apache/struts/taglib/MessageTag.java,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- MessageTag.java	2000/05/31 22:28:12	1.1
  +++ MessageTag.java	2000/06/01 21:06:27	1.2
  @@ -1,7 +1,7 @@
   /*
  - * $Header: /home/cvs/jakarta-struts/src/share/org/apache/struts/taglib/MessageTag.java,v 1.1 2000/05/31 22:28:12 craigmcc Exp $
  - * $Revision: 1.1 $
  - * $Date: 2000/05/31 22:28:12 $
  + * $Header: /home/cvs/jakarta-struts/src/share/org/apache/struts/taglib/MessageTag.java,v 1.2 2000/06/01 21:06:27 craigmcc Exp $
  + * $Revision: 1.2 $
  + * $Date: 2000/06/01 21:06:27 $
    *
    * ====================================================================
    *
  @@ -80,7 +80,7 @@
    * <code>ActionServlet</code> implementation.
    *
    * @author Craig R. McClanahan
  - * @version $Revision: 1.1 $ $Date: 2000/05/31 22:28:12 $
  + * @version $Revision: 1.2 $ $Date: 2000/06/01 21:06:27 $
    */
   
   public final class MessageTag extends TagSupport {
  @@ -151,12 +151,6 @@
   
   
       /**
  -     * The language and/or country selector to use for selecting a Locale.
  -     */
  -    private String locale = null;
  -
  -
  -    /**
        * The message resources for this package.
        */
       private static MessageResources messages =
  @@ -321,28 +315,6 @@
       }
   
   
  -    /**
  -     * Return the locale selector.
  -     */
  -    public String getLocale() {
  -
  -	return (this.locale);
  -
  -    }
  -
  -
  -    /**
  -     * Set the locale selector.
  -     *
  -     * @param locale The new locale selector
  -     */
  -    public void setLocale(String locale) {
  -
  -	this.locale = locale;
  -
  -    }
  -
  -
       // --------------------------------------------------------- Public Methods
   
   
  @@ -361,8 +333,11 @@
   		(messages.getMessage("getMessageTag.resources", bundle));
   
   	// Calculate the Locale we will be using
  -	Locale locale = defaultLocale;
  -	;	// FIXME - evaluate "this.locale" and get one!  cache!
  +	Locale locale = (Locale)
  +	    pageContext.getAttribute(Action.LOCALE_KEY,
  +				     PageContext.SESSION_SCOPE);
  +	if (locale == null)
  +	    locale = defaultLocale;
   
   	// Construct the optional arguments array we will be using
   	Object args[] = new Object[5];
  
  
  
  1.2       +6 -1      jakarta-struts/web/documentation/index.jsp
  
  Index: index.jsp
  ===================================================================
  RCS file: /home/cvs/jakarta-struts/web/documentation/index.jsp,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- index.jsp	2000/05/31 22:28:10	1.1
  +++ index.jsp	2000/06/01 21:06:27	1.2
  @@ -4,7 +4,12 @@
   </head>
   <body bgcolor="white">
   
  -FIXME - Write the documentation and include it here!
  +FIXME - Write the documentation and include it here!<br><br>
  +
  +The following documentation is available:
  +<ul>
  +<li><a href="tags.html">Custom Tag Library Reference</a>
  +</ul>
   
   </body>
   </html>
  
  
  
  1.1                  jakarta-struts/web/documentation/tags.html
  
  Index: tags.html
  ===================================================================
  <html>
  <head>
  <title>Struts - Custom Tag Library Reference</title>
  </head>
  <body bgcolor="white">
  
  
  <a name="Top"></a>
  <h1>Introduction</h1>
  
  <p>This document contains reference information about each of the tags defined
  in the Struts custom tag library.  For each tag, the following information
  is presented:</p>
  <ul>
  <li>The name of this tag.</li>
  <li>A brief description of what the tag does and how it is used.</li>
  <li>Descriptions of the attributes of this tag, including default
      values (if the attribute is not specified) in square brackets.</li>
  </ul>
  
  
  <a name="checkbox"></a>
  <h1><i>checkbox</i> - Render A Checkbox Input Field</h1>
  
  <p>Renders an HTML <code>&lt;input&gt;</code> element of type
  <code>checkbox</code>, populated from the specified value or the specified
  property of the bean associated with our current <code>form</code>.  This
  tag is only valid when nested inside a <code>form</code> tag body.</p>
  
  <table width="100%" border="1">
    <tr>
      <th width="15%">Attribute</th>
      <th width="85%">Description</th>
    </tr>
    <tr>
      <td align="center">name</td>
      <td>
        Name of this input field, and the name of the corresponding bean
        property if <code>value</code> is not specified.  The corresponding
        bean property (if any) must be of type <code>boolean</code>.
      </td>
    </tr>
    <tr>
      <td align="center">value</td>
      <td>
        Value to which the checkbox should be initialized ("true", "false",
        "yes", or "no").  [Use the corresponding bean property value]
      </td>
    </tr>
  </table>
  
  <a href="#Top">Top</a>
  
  
  <a name="enumerate"></a>
  <h1><i>enumerate</i> - Repeat Tag Body For Elements of a Collection</h1>
  
  <p>Repeats the body of this tag once for each element of a collection, which
  must be an <code>Enumeration</code>, a <code>Hashtable</code>, a
  <code>Vector</code>, or an array of objects.  The collection to be enumerated
  is identified by the <code>name</code> or <code>name</code> and
  <code>property</code> attributes, and the element being processed is exposed
  as a page scope bean named by the <code>id</code> attribute.</p>
  
  <table width="100%" border="1">
    <tr>
      <th width="15%">Attribute</th>
      <th width="85%">Description</th>
    </tr>
    <tr>
      <td align="center">id</td>
      <td>
        Attribute name of the page scope bean that will be made visible to
        the body of the <code>enumerate</code> tag, containing the current
        element of the enumeration.
      </td>
    </tr>
    <tr>
      <td align="center">name</td>
      <td>
        Attribute name of the collection bean itself (if <code>property</code>
        is not specified), or the bean whose property is retrieved (if
        <code>property</code> is specified).  The collection may be in
        any scope, but must be one of the Java types described above.
      </td>
    </tr>
    <tr>
      <td align="center">property</td>
      <td>
        Name of a property of the bean identified by <code>name</code>
        that is retrieved to provide the collection to be enumerated.
        [Use the bean identified by <code>name</code> itself]
      </td>
    </tr>
  </table>
  
  <a href="#Top">Top</a>
  
  
  <a name="errors"></a>
  <h1><i>errors</i> - Conditionally Display Error Messages</h1>
  
  <p>Displays a set of error messages prepared by a business logic component
  and stored as a <code>String[]</code> request scope bean.  If such a bean
  is not found, nothing will be rendered.</p>
  
  <p>In order to use this tag successfully, you must have defined an application
  scope <code>MessageResources</code> bean under the default attribute name,
  with at least the following message keys:</p>
  <ul>
  <li><b>errors.header</b> - Text that will be rendered before the error
      messages list.  Typically, this message text ends with
      <code>&lt;ul&gt;</code> to start the error messages list.</li>
  <li><b>errors.detail</b> - Text that will be rendered for each error message,
      with <code>{0}</code> replacement text for the message actually generated
      by the business logic component.  A typical value for this message text is
      <code>"&lt;li&gt;{0}&lt;/li&gt;"</code>.</li>
  <li><b>errors.footer</b> - Text that will be rendered after the error messages
      list.  Typically, this message text begins with
      <code>&lt;/ul&gt;</code> to end the error messages list.</li>
  </ul>
  
  <table width="100%" border="1">
    <tr>
      <th width="15%">Attribute</th>
      <th width="85%">Description</th>
    </tr>
    <tr>
      <td align="center">name</td>
      <td>
        Name of the request scope bean under which a <code>String[]</code>
        object has possibly been stored.  [The value of the
        <code>org.apache.struts.Action.ERROR_KEY</code> constant string]
      </td>
    </tr>
  </table>
  
  <a href="#Top">Top</a>
  
  
  <a name="form"></a>
  <h1><i>form</i> - Define An Input Form</h1>
  
  <p>Renders an HTML <code>&lt;form&gt;</code> element whose contents are
  described by the body content of this tag.  The form implicitly interacts
  with the specified request scope or session scope bean to populate
  the input fields with the current property values from the bean.</p>
  
  <table width="100%" border="1">
    <tr>
      <th width="15%">Attribute</th>
      <th width="85%">Description</th>
    </tr>
    <tr>
      <td align="center">action</td>
      <td>
        The URL to which this form will be submitted.  Typically, this will
        match a mapping for the <code>ActionServlet</code> managing this
        application.  URL rewriting will automatically be performed on this
        URL, to maintain session state in the absence of cookies.
        [Form will be submitted to this page itself]
      </td>
    </tr>
    <tr>
      <td align="center">method</td>
      <td>
        The HTTP method that will be used to submit this request (GET, POST).
        [POST]
      </td>
    </tr>
    <tr>
      <td align="center">name</td>
      <td>
        Name of the request scope or session scope bean (as defined by
        the <code>scope</code> attribute) whose properties will
        be used to populate input field values.  If no such bean is found,
        a new bean will be created (and added to the appropriate scope), using
        the Java class name specified by the <code>type</code> attribute.
      </td>
    </tr>
    <tr>
      <td align="center">scope</td>
      <td>
        JSP scope within which the associated bean will be accessed
        or created (request, session).  [session]
      </td>
    </tr>
    <tr>
      <td align="center">type</td>
      <td>
        Fully qualified Java class name of the bean to be created if no bean
        is found for the specified <code>name</code> and <code>scope</code>.
        To be used successfully with the Struts <code>ActionServlet</code>, this
        class must implement the <code>org.apache.struts.action.ActionForm</code>
        interface.  [Runtime error if bean creation is attempted]
      </td>
    </tr>
  </table>
  
  <a href="#Top">Top</a>
  
  
  <a name="getProperty"></a>
  <h1><i>getProperty</i> - Expose Bean Property as an Attribute</h1>
  
  <p>Retrieves the value of the specified property from the specified bean,
  and exposes it as a page scope bean for use by other tags.</p>
  
  <table width="100%" border="1">
    <tr>
      <th width="15%">Attribute</th>
      <th width="85%">Description</th>
    </tr>
    <tr>
      <td align="center">id</td>
      <td>
        Name of the page scope bean under which the retrieved attribute
        will be retrieved.
      </td>
    </tr>
    <tr>
      <td align="center">name</td>
      <td>
        Name of the bean (which can be in any scope) whose specified
        property value is retrieved and exposed.
      </td>
    </tr>
    <tr>
      <td align="center">property</td>
      <td>
        Name of the property whose value is retrieved and exposed.
      </td>
    </tr>
  </table>
  
  <a href="#Top">Top</a>
  
  
  <a name="hidden"></a>
  <h1><i>hidden</i> - Render A Hidden Input Field</h1>
  
  <p>Renders an HTML <code>&lt;input&gt;</code> element of type
  <code>hidden</code>, populated from the specified value or the specified
  property of the bean associated with our current <code>form</code>.  This
  tag is only valid when nested inside a <code>form</code> tag body.</p>
  
  <table width="100%" border="1">
    <tr>
      <th width="15%">Attribute</th>
      <th width="85%">Description</th>
    </tr>
    <tr>
      <td align="center">name</td>
      <td>
        Name of this input field, and the name of the corresponding bean
        property if <code>value</code> is not specified.  The corresponding
        bean property (if any) must be of type <code>String</code>.
      </td>
    </tr>
    <tr>
      <td align="center">value</td>
      <td>
        Value to which this field should be initialized.  [Use the
        corresponding bean property value]
      </td>
    </tr>
  </table>
  
  <a href="#Top">Top</a>
  
  
  <a name="htmlProperty"></a>
  <h1><i>htmlProperty</i> - Render A Bean Property</h1>
  
  <p>Retrieves the value of the specified property from the specified bean,
  and renders it to the output stream, with suitable filtering for characters
  that are sensitive in HTML.</p>
  
  <table width="100%" border="1">
    <tr>
      <th width="15%">Attribute</th>
      <th width="85%">Description</th>
    </tr>
    <tr>
      <td align="center">name</td>
      <td>
        Name of the bean (which can be in any scope) whose specified
        property value is retrieved and rendered.
      </td>
    </tr>
    <tr>
      <td align="center">property</td>
      <td>
        Name of the property whose value is retrieved and rendered.
      </td>
    </tr>
  </table>
  
  <a href="#Top">Top</a>
  
  
  <a name="ifParameterEquals"></a>
  <h1><i>ifParameterEquals</i> - Conditionally Evaluate Tag Body</h1>
  
  <p>Evaluates and processes the body of this tag if the specified parameter
  included with this request has the specified value.  Otherwise, the body of
  this tag is skipped.</p>
  
  <table width="100%" border="1">
    <tr>
      <th width="15%">Attribute</th>
      <th width="85%">Description</th>
    </tr>
    <tr>
      <td align="center">name</td>
      <td>
        Name of the request parameter whose value must match for
        conditional evaluation of the tag body to take place.
      </td>
    </tr>
    <tr>
      <td align="center">value</td>
      <td>
        Value that must match exactly in order for conditional
        evaluation of the tag body to take place.
      </td>
    </tr>
  </table>
  
  <a href="#Top">Top</a>
  
  
  <a name="ifParameterNotEquals"></a>
  <h1><i>ifParameterNotEquals</i> - Conditionally Evaluate Tag Body</h1>
  
  <p>Evaluates and processes the body of this tag if the specified parameter
  included with this request does not match the specified value (or it is
  omitted).  Otherwise, the body of this tag is skipped.</p>
  
  <table width="100%" border="1">
    <tr>
      <th width="15%">Attribute</th>
      <th width="85%">Description</th>
    </tr>
    <tr>
      <td align="center">name</td>
      <td>
        Name of the request parameter whose value must not match for
        conditional evaluation of the tag body to take place.
      </td>
    </tr>
    <tr>
      <td align="center">value</td>
      <td>
        Value that must not match exactly in order for conditional
        evaluation of the tag body to take place.
      </td>
    </tr>
  </table>
  
  <a href="#Top">Top</a>
  
  
  <a name="link"></a>
  <h1><i>link</i> - Render HTML Hyperlink</h1>
  
  <p>Renders an HTML <code>&lt;a&gt;</code> element as a hyperlink to the
  specified URL.  URL rewriting will be applied automatically to maintain
  session state in the absence of cookies.  The content displayed for this
  hyperlink will be taken from the body of this tag.</p>
  
  <table width="100%" border="1">
    <tr>
      <th width="15%">Attribute</th>
      <th width="85%">Description</th>
    </tr>
    <tr>
      <td align="center">href</td>
      <td>
        URL to which this hyperlink will transfer if activated.
      </td>
    </tr>
  </table>
  
  <a href="#Top">Top</a>
  
  
  <a name="message"></a>
  <h1><i>message</i> - Render An Internationalized Message</h1>
  
  <p>Retrieves an internationalized message for the specified Locale, using
  the specified key, and renders it to the output stream.  If the message
  supports parametric replacements (such as "{0}"), you can specify up to
  four argument values to use as replacement text.</p>
  
  <table width="100%" border="1">
    <tr>
      <th width="15%">Attribute</th>
      <th width="85%">Description</th>
    </tr>
    <tr>
      <td align="center">arg0</td>
      <td>
        First parameteric replacement value, if any.  [None]
      </td>
    </tr>
    <tr>
      <td align="center">arg1</td>
      <td>
        Second parameteric replacement value, if any.  [None]
      </td>
    </tr>
    <tr>
      <td align="center">arg2</td>
      <td>
        Third parameteric replacement value, if any.  [None]
      </td>
    </tr>
    <tr>
      <td align="center">arg3</td>
      <td>
        Fourth parameteric replacement value, if any.  [None]
      </td>
    </tr>
    <tr>
      <td align="center">bundle</td>
      <td>
        Application scope attribute under which the <code>MessageResources</code>
        bean containing our messages is stored.  [The value of the
        <code>Action.MESSAGES_KEY</code> constant string]
      </td>
    </tr>
    <tr>
      <td align="center">key</td>
      <td>
        Message key of the requested message, which must have a corresponding
        value in the resources.
      </td>
    </tr>
    <tr>
      <td align="center">locale</td>
      <td>
        Session scope attribute under which the <code>Locale</code> bean
        selected by the current user is stored.  If no such bean is found,
        the system default Locale will be used.  [The value of the
        <code>Action.LOCALE_KEY</code> constant string]
      </td>
    </tr>
  </table>
  
  <a href="#Top">Top</a>
  
  
  <a name="option"></a>
  <h1><i>option</i> - Render A Select Option</h1>
  
  <p>Renders an HTML <code>&lt;option&gt;</code> element, representing one of
  the choices for a <code>&lt;select&gt;</code> element.  The text displayed
  to the user comes from the body of this tag.  If the value of the corresponding
  bean property matches the specified <code>value</code>, this
  <code>option</code> will be marked <code>selected</code>.  This tag is only
  valid when nested inside a <code>select</code> tag body.</p>
  
  <table width="100%" border="1">
    <tr>
      <th width="15%">Attribute</th>
      <th width="85%">Description</th>
    </tr>
    <tr>
      <td align="center">value</td>
      <td>
        Value to be submitted for this field if this option is selected
        by the user.
      </td>
    </tr>
  </table>
  
  <a href="#Top">Top</a>
  
  
  <a name="parameter"></a>
  <h1><i>parameter</i> - Render Request Parameter</h1>
  
  <p>Renders the value of the specified request parameter, suitably filtered
  for characters that are sensitive in HTML.</p>
  
  <table width="100%" border="1">
    <tr>
      <th width="15%">Attribute</th>
      <th width="85%">Description</th>
    </tr>
    <tr>
      <td align="center">name</td>
      <td>
        Name of the request parameter whose value is to be rendered.
      </td>
    </tr>
  </table>
  
  <a href="#Top">Top</a>
  
  
  <a name="password"></a>
  <h1><i>password</i> - Render A Password Input Field</h1>
  
  <p>Renders an HTML <code>&lt;input&gt;</code> element of type
  <code>password</code>, populated from the specified value or the specified
  property of the bean associated with our current <code>form</code>.  This
  tag is only valid when nested inside a <code>form</code> tag body.</p>
  
  <table width="100%" border="1">
    <tr>
      <th width="15%">Attribute</th>
      <th width="85%">Description</th>
    </tr>
    <tr>
      <td align="center">maxlength</td>
      <td>
        Maximum number of input characters to accept.  [No limit]
      </td>
    </tr>
    <tr>
      <td align="center">name</td>
      <td>
        Name of this input field, and the name of the corresponding bean
        property if <code>value</code> is not specified.  The corresponding
        bean property (if any) must be of type <code>String</code>.
      </td>
    </tr>
    <tr>
      <td align="center">size</td>
      <td>
        Number of character positions to allocate.  [Browser default]
      </td>
    </tr>
    <tr>
      <td align="center">value</td>
      <td>
        Value to which this field should be initialized.  [Use the
        corresponding bean property value]
      </td>
    </tr>
  </table>
  
  <a href="#Top">Top</a>
  
  
  <a name="property"></a>
  <h1><i>property</i> - Render A Read-only Property Value</h1>
  
  <p>Renders the value of the specified property as read-only text.  It
  is similar to the standard &lt;jsp:getProperty&gt; tag, but also filters
  the output text for characters that HTML is sensitive to.  This tag is
  only valid when nested inside a <code>form</code> tag body.</p>
  
  <table width="100%" border="1">
    <tr>
      <th width="15%">Attribute</th>
      <th width="85%">Description</th>
    </tr>
    <tr>
      <td align="center">name</td>
      <td>
        Name of this input field, and the name of the corresponding bean
        property if <code>value</code> is not specified.  The corresponding
        bean property (if any) must be of type <code>String</code>.
      </td>
    </tr>
    <tr>
      <td align="center">value</td>
      <td>
        Value to which this field should be initialized.  [Use the
        corresponding bean property value]
      </td>
    </tr>
  </table>
  
  <a href="#Top">Top</a>
  
  
  <a name="radio"></a>
  <h1><i>radio</i> - Render A Radio Button Input Field</h1>
  
  <p>Renders an HTML <code>&lt;input&gt;</code> element of type
  <code>radio</code>, populated from the specified value or the specified
  property of the bean associated with our current <code>form</code>.  This
  tag is only valid when nested inside a <code>form</code> tag body.</p>
  
  <table width="100%" border="1">
    <tr>
      <th width="15%">Attribute</th>
      <th width="85%">Description</th>
    </tr>
    <tr>
      <td align="center">name</td>
      <td>
        Name of this input field, and the name of the corresponding bean
        property if <code>value</code> is not specified.  The corresponding
        bean property (if any) must be of type <code>boolean</code>.
      </td>
    </tr>
    <tr>
      <td align="center">value</td>
      <td>
        Value that is matched against the underlying bean property value.
        If the property has the same value, this radio button will be
        rendered as <code>checked</code>.
      </td>
    </tr>
  </table>
  
  <a href="#Top">Top</a>
  
  
  <a name="reset"></a>
  <h1><i>reset</i> - Render a Reset Button</h1>
  
  <p>Renders an HTML <code>&lt;input&gt;</code> element of type
  <code>reset</code>.  This tag is only valid when nested inside a
  <code>form</code> tag body.</p>
  
  <table width="100%" border="1">
    <tr>
      <th width="15%">Attribute</th>
      <th width="85%">Description</th>
    </tr>
    <tr>
      <td align="center">value</td>
      <td>
        Value of the label to be placed on this button.
        [Body of this tag (if any), or "Reset"]
      </td>
    </tr>
  </table>
  
  <a href="#Top">Top</a>
  
  
  <a name="select"></a>
  <h1><i>select</i> - Render a Select Input Field</h1>
  
  <p>Renders an HTML <code>&lt;select&gt;</code> element, whose available
  options are described by <code>&lt;option&gt;</code> elements nested in the
  tag body of this tag.  This tag is only valid when nested inside a
  <code>form</code> tag body.</p>
  
  <table width="100%" border="1">
    <tr>
      <th width="15%">Attribute</th>
      <th width="85%">Description</th>
    </tr>
    <tr>
      <td align="center">name</td>
      <td>
        Name of this input field, and the name of the corresponding bean
        property if <code>value</code> is not specified.  The corresponding
        bean property (if any) must be of type <code>String</code>.
      </td>
    </tr>
    <tr>
      <td align="center">value</td>
      <td>
        Value to which this field should be initialized.  [Use the
        corresponding bean property value]
      </td>
    </tr>
  </table>
  
  <a href="#Top">Top</a>
  
  
  <a name="submit"></a>
  <h1><i>submit</i> - Render a Submit Button</h1>
  
  <p>Renders an HTML <code>&lt;input&gt;</code> element of type
  <code>submit</code>.  This tag is only valid when nested inside a
  <code>form</code> tag body.</p>
  
  <table width="100%" border="1">
    <tr>
      <th width="15%">Attribute</th>
      <th width="85%">Description</th>
    </tr>
    <tr>
      <td align="center">name</td>
      <td>
        Name of the request parameter that will be included with this
        submission, set to the specified value.  [submit]
      </td>
    </tr>
    <tr>
      <td align="center">value</td>
      <td>
        Value of the label to be placed on this button.  This value will
        also be submitted as the value of the specified request parameter.
        [Body of this tag (if any), or "Reset"]
      </td>
    </tr>
  </table>
  
  <a href="#Top">Top</a>
  
  
  <a name="text"></a>
  <h1><i>text</i> - Render A Text Input Field</h1>
  
  <p>Renders an HTML <code>&lt;input&gt;</code> element of type
  <code>text/code>, populated from the specified value or the specified
  property of the bean associated with our current <code>form</code>.  This
  tag is only valid when nested inside a <code>form</code> tag body.</p>
  
  <table width="100%" border="1">
    <tr>
      <th width="15%">Attribute</th>
      <th width="85%">Description</th>
    </tr>
    <tr>
      <td align="center">maxlength</td>
      <td>
        Maximum number of input characters to accept.  [No limit]
      </td>
    </tr>
    <tr>
      <td align="center">name</td>
      <td>
        Name of this input field, and the name of the corresponding bean
        property if <code>value</code> is not specified.  The corresponding
        bean property (if any) must be of type <code>String</code>.
      </td>
    </tr>
    <tr>
      <td align="center">size</td>
      <td>
        Number of character positions to allocate.  [Browser default]
      </td>
    </tr>
    <tr>
      <td align="center">value</td>
      <td>
        Value to which this field should be initialized.  [Use the
        corresponding bean property value]
      </td>
    </tr>
  </table>
  
  <a href="#Top">Top</a>
  
  
  <a name="textarea"></a>
  <h1><i>textarea</i> - Render A Textarea Input Field</h1>
  
  <p>Renders an HTML <code>&lt;textarea&gt;</code> element, based on the
  specified attributes.  This tag is only valid when nested inside a
  <code>form</code> tag body.</p>
  
  <table width="100%" border="1">
    <tr>
      <th width="15%">Attribute</th>
      <th width="85%">Description</th>
    </tr>
    <tr>
      <td align="center">cols</td>
      <td>
        Number of columns displayed in the textarea.  [Browser default]
      </td>
    </tr>
    <tr>
      <td align="center">name</td>
      <td>
        Name of this input field, and the name of the corresponding bean
        property if <code>value</code> is not specified.  The corresponding
        bean property (if any) must be of type <code>String</code>.
      </td>
    </tr>
    <tr>
      <td align="center">rows</td>
      <td>
        Number of rows displayed in the textarea.  [Browser default]
      </td>
    </tr>
    <tr>
      <td align="center">value</td>
      <td>
        Value to which this field should be initialized.  [Use the
        corresponding bean property value]
      </td>
    </tr>
  </table>
  
  <a href="#Top">Top</a>
  
  
  </body>
  </html>