<bean:include>

<p><strong>Load the response from a dynamic application request and make it available as a bean.</strong></p> <p>Perform an internal dispatch to the specified application component (or external URL) and make the response data from that request available as a scoped variable of type <code>String</code>. This tag has a function similar to that of the standard <code>&lt;jsp:include&gt;</code> tag, except that the response data is stored in a page scope attribute instead of being written to the output stream. If the current request is part of a session, the generated request for the include will also include the session identifier (and thus be part of the same session).</p> <p>The URL used to access the specified application component is calculated based on which of the following attributes you specify (you must specify exactly one of them):</p> <ul> <li> <em>forward</em> - Use the value of this attribute as the name of a global <code>ActionForward</code> to be looked up, and use the module-relative or context-relative URI found there.</li> <li> <em>href</em> - Use the value of this attribute unchanged (since this might link to a resource external to the application, the session identifier is <strong>not</strong> included.</li> <li> <em>page</em> - Use the value of this attribute as an module-relative URI to the desired resource.</li> </ul>

Can contain: empty

<bean:message>

<p><strong>Render an internationalized message string to the response. </strong></p> <p>Retrieves an internationalized message for the specified locale, using the specified message key, and write it to the output stream. Up to five parametric replacements (such as "{0}") may be specified.</p> <p>The message key may be specified directly, using the <code>key</code> attribute, or indirectly, using the <code>name</code> and <code>property</code> attributes to obtain it from a bean.</p> <p><strong>JSTL</strong>: The equivalent JSTL tag is <code>&lt;fmt:message&gt;</code>. For example, <br/> <code> &lt;fmt:message key="my.msg.key"> &lt;fmt:param value="replacement text"/> &lt;/fmt:message> </code> </p>

Can contain: empty

<bean:page>

<p><strong>Expose a specified item from the page context as a bean. </strong></p> <p>Retrieve the value of the specified item from the page context for this page, and define it as a scripting variable, and a page scope attribute accessible to the remainder of the current page.</p> <p>If a problem occurs while retrieving the specified configuration object, a request time exception will be thrown.</p>

Can contain: empty

<bean:resource>

<p><strong>Load a web application resource and make it available as a bean.</strong></p> <p>Retrieve the value of the specified web application resource, and make it available as either a <code>InputStream</code> or a <code>String</code>, depending on the value of the <code>input</code> attribute.</p> <p>If a problem occurs while retrieving the specified resource, a request time exception will be thrown.</p>

Can contain: empty

<bean:size>

<p><strong>Define a bean containing the number of elements in a Collection or Map.</strong></p> <p>Given a reference to an array, Collection or Map, creates a new bean, of type <code>java.lang.Integer</code>, whose value is the number of elements in that collection. You can specify the collection to be counted in any one of the following ways:</p> <ul> <li>As a runtime expression specified as the value of the <code>collection</code> attribute.</li> <li>As a JSP bean specified by the <code>name</code> attribute.</li> <li>As the property, specified by the <code>property</code> attribute, of the JSP bean specified by the <code>name</code> attribute.</li> </ul>

Can contain: empty

<bean:struts>

<p><strong>Expose a named Struts internal configuration object as a bean. </strong></p> <p>Retrieve the value of the specified Struts internal configuration object, and define it as a scripting variable and as a page scope attribute accessible to the remainder of the current page. You must specify exactly one of the <code>formBean</code>, <code>forward</code>, and <code>mapping</code> attributes to select the configuration object to be exposed.</p> <p>If a problem occurs while retrieving the specified configuration object, a request time exception will be thrown.</p>

Can contain: empty

<html:base>

<p><strong>Render an HTML <code>&lt;base&gt;</code> Element</strong></p> <p>Renders an HTML <code>&lt;base&gt;</code> element with an <code>href</code> attribute pointing to the absolute location of the enclosing JSP page. This tag is valid only when nested inside an HTML <code>&lt;head&gt;</code> element.</p> <p>This tag is useful because it allows you to use relative URL references in the page that are calculated based on the URL of the page itself, rather than the URL to which the most recent submit took place (which is where the browser would normally resolve relative references against).</p>

Can contain: empty

<html:button>

<p><strong> Render A Button Input Field </strong></p> <p> Renders an HTML <code>&lt;input&gt;</code> element of type <code>button</code>, populated from the specified value or the content of this tag body. This tag is only valid when nested inside a form tag body. </p> <p> If a graphical button is needed (a button with an image), then the <a href="#image"><code>image</code></a> tag is more appropriate. </p>

Can contain:

<html:cancel>

<p><strong>Render a Cancel Button</strong></p> <p> Renders an HTML <code>&lt;input&gt;</code> element of type submit. This tag is only valid when nested inside a form tag body. Pressing of this submit button causes the action servlet to bypass calling the associated form bean validate() method. The action is called normally. </p>

Can contain:

<html:checkbox>

<p><strong> Render A Checkbox Input Field </strong></p> <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 form. This tag is only valid when nested inside a form tag body.</p> <p> <strong>NOTE</strong>: The underlying property value associated with this field should be of type <code>boolean</code>, and any <code>value</code> you specify should correspond to one of the Strings that indicate a true value ("true", "yes", or "on"). If you wish to utilize a set of related String values, consider using the <code>multibox</code> tag.</p> <p> <strong>WARNING</strong>: In order to correctly recognize unchecked checkboxes, the <code>ActionForm</code> bean associated with this form must include a statement setting the corresponding boolean property to <code>false</code> in the <code>reset()</code> method.</p>

Can contain:

<html:errors>

<p><strong> Conditionally display a set of accumulated error messages. </strong></p> <p>Displays a set of error messages prepared by a business logic component and stored as an <code>ActionErrors</code> object, a String, or a String array in any scope. 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 optional definitions of message keys specified in the following attributes:</p> <ul> <li> <strong>header</strong> - Text that will be rendered before the error messages list. Typically, this message text will end with <code>&lt;ul&gt;</code> to start the error messages list (default "errors.header").</li> <li> <strong>footer</strong> - Text that will be rendered after the error messages list. Typically, this message text will begin with <code>&lt;/ul&gt;</code> to end the error messages list (default "errors.footer").</li> <li> <strong>prefix</strong> - Text that will be rendered before each individual error in the list (default "errors.prefix").</li> <li> <strong>suffix</strong> - Text that will be rendered after each individual error in the list (default "errors.suffix").</li> </ul>

Can contain: empty

<html:file>

<p><strong> Render A File Select Input Field </strong></p> <p> Renders an HTML <code>&lt;input&gt;</code> element of type file, defaulting to the specified value or the specified property of the bean associated with our current form. This tag is only valid when nested inside a form tag body. </p> <p> As with the corresponding HTML <code>&lt;input&gt;</code> element, the enclosing form element must specify "POST" for the <code>method</code> attribute, and "multipart/form-data" for the <code>enctype</code> attribute. For example: </p> <pre> &lt;html:form method="POST" enctype="multipart/form-data"> &lt;html:file property="theFile" /> &lt;/html:form></pre> <p> WARNING: In order to correctly recognize uploaded files, the ActionForm bean associated with this form must include a statement setting the corresponding org.apache.struts.upload.FormFile property to null in the reset() method. </p>

Can contain:

<html:form>

<p><strong> Define An Input Form </strong></p> <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> <p> The form bean is located, and created if necessary, based on the form bean specification for the associated <code>ActionMapping</code>. </p>

Can contain: JSP

<html:frame>

<p><strong>Render an HTML frame element</strong></p> <p>Renders an HTML <code>&lt;frame&gt;</code> element with processing for the <code>src</code> attribute that is identical to that performed by the <code>&lt;html:link&gt;</code> tag for the <code>href</code> attribute. URL rewriting will be applied automatically, to maintain session state in the absence of cookies.</p> <p>The base URL for this frame is calculated based on which of the following attributes you specify (you must specify exactly one of them):</p> <ul> <li> <em>forward</em> - Use the value of this attribute as the name of a global <code>ActionForward</code> to be looked up, and use the module-relative or context-relative URI found there.</li> <li> <em>href</em> - Use the value of this attribute unchanged. </li> <li> <em>page</em> - Use the value of this attribute as a module-relative URI, and generate a server-relative URI by including the context path and application prefix.</li> <li> <em>action</em> - Use the value of this attribute as the logical name of a global Action that contains the actual content-relative URI of the destination of this transfer.</li> </ul> <p>Normally, the hyperlink you specify with one of the attributes described in the previous paragraph will be left unchanged (other than URL rewriting if necessary). However, there are two ways you can append one or more dynamically defined query parameters to the hyperlink -- specify a single parameter with the <code>paramId</code> attribute (and its associated attributes to select the value), or specify the <code>name</code> (and optional <code>property</code>) attributes to select a <code>java.util.Map</code> bean that contains one or more parameter ids and corresponding values. </p> <p>To specify a single parameter, use the <code>paramId</code> attribute to define the name of the request parameter to be submitted. To specify the corresponding value, use one of the following approaches:</p> <ul> <li> <em>Specify only the <code>paramName</code> attribute</em> - The named JSP bean (optionally scoped by the value of the <code>paramScope</code> attribute) must identify a value that can be converted to a String.</li> <li> <em>Specify both the <code>paramName</code> and <code>paramProperty</code> attributes</em> - The specified property getter method will be called on the JSP bean identified by the <code>paramName</code> (and optional <code>paramScope</code>) attributes, in order to select a value that can be converted to a String.</li> </ul> <p>If you prefer to specify a <code>java.util.Map</code> that contains all of the request parameters to be added to the hyperlink, use one of the following techniques:</p> <ul> <li> <em>Specify only the <code>name</code> attribute</em> - The named JSP bean (optionally scoped by the value of the <code>scope</code> attribute) must identify a <code>java.util.Map</code> containing the parameters.</li> <li> <em>Specify both <code>name</code> and <code>property</code> attributes</em> - The specified property getter method will be called on the bean identified by the <code>name</code> (and optional <code>scope</code>) attributes, in order to return the <code>java.util.Map</code> containing the parameters.</li> </ul> <p>As the <code>Map</code> is processed, the keys are assumed to be the names of query parameters to be appended to the hyperlink. The value associated with each key must be either a String or a String array representing the parameter value(s), or an object whose toString() method will be called. If a String array is specified, more than one value for the same query parameter name will be created.</p> <p>Additionally, you can request that the current transaction control token, if any, be included in the generated hyperlink by setting the <code>transaction</code> attribute to <code>true</code>. You can also request that an anchor ("#xxx") be added to the end of the URL that is created by any of the above mechanisms, by using the <code>anchor</code> attribute.</p>

Can contain: JSP

<html:hidden>

<p><strong> Render A Hidden Field </strong></p> <p> Renders an HTML <code>&lt;input&gt;</code> element of type hidden, populated from the specified value or the specified property of the bean associated with our current form. This tag is only valid when nested inside a form tag body. </p>

Can contain: empty

<html:html>

<p><strong>Render an HTML <code>&lt;html&gt;</code> Element </strong></p> <p>Renders an HTML <code>&lt;html&gt;</code> element with language attributes extracted from the user's current Locale object, if there is one.</p>

Can contain: JSP

<html:image>

<p><strong> Render an input tag of type "image" </strong></p> <p>Renders an HTML <code>&lt;input&gt;</code> tag of type "image". The base URL for this image is calculated directly based on the value specified in the <code>src</code> or <code>page</code> attributes, or indirectly by looking up a message resource string based on the <code>srcKey</code> or <code>pageKey</code> attributes. You <strong>must</strong> specify exactly one of these attributes.</p> <p>If you would like to obtain the coordinates of the mouse click that submitted this request, see the information below on the <code>property</code> attribute.</p> <p>This tag is only valid when nested inside a form tag body.</p>

Can contain:

<html:img>

<p><strong>Render an HTML img tag</strong></p> <p>Renders an HTML <code>&lt;img&gt;</code> element with the image at the specified URL. Like the link tag, URL rewriting will be applied automatically to the value specified in <code>src</code>, <code>page</code>, or <code>action</code> to maintain session state in the absence of cookies. This will allow dynamic generation of an image where the content displayed for this image will be taken from the attributes of this tag.</p> <p>The base URL for this image is calculated directly based on the value specified in <code>src</code>, <code>page</code>, or <code>action</code> or <code>page</code>, or indirectly by looking up a message resource string based on the <code>srcKey</code> or <code>pageKey</code> attributes. You <strong>must</strong> specify exactly one of these attributes.</p> <p>Normally, the <code>src</code>, <code>page</code>, or <code>action</code> that you specify will be left unchanged (other than URL rewriting if necessary). However, there are two ways you can append one or more dynamically defined query parameters to the <code>src</code> URL -- specify a single parameter with the <code>paramId</code> attribute (at its associated attributes to select the value), or specify the <code>name</code> (and optional <code>property</code>) attributes to select a <code>java.util.Map</code> bean that contains one or more parameter ids and corresponding values.</p> <p>To specify a single parameter, use the <code>paramId</code> attribute to define the name of the request parameter to be submitted. To specify the corresponding value, use one of the following approaches:</p> <ul> <li> <em>Specify only the <code>paramName</code> attribute</em> - The named JSP bean (optionally scoped by the value of the <code>paramScope</code> attribute) must identify a value that can be converted to a String.</li> <li> <em>Specify both the <code>paramName</code> and <code>paramProperty</code> attributes</em> - The specified property getter will be called on the JSP bean identified by the <code>paramName</code> (and optional <code>paramScope</code>) attributes, in order to select a value that can be converted to a String.</li> </ul> <p>If you prefer to specify a <code>java.util.Map</code> that contains all of the request parameters to be added to the hyperlink, use one of the following techniques:</p> <ul> <li> <em>Specify only the <code>name</code> attribute</em> - The named JSP bean (optionally scoped by the value of the <code>scope</code> attribute) must identify a <code>java.util.Map</code> containing the parameters.</li> <li> <em>Specify both <code>name</code> and <code>property</code> attributes</em> - The specified property getter method will be called on the bean identified by the <code>name</code> (and optional <code>scope</code>) attributes, in order to return the <code>java.util.Map</code> containing the parameters.</li> </ul> <p>As the <code>Map</code> is processed, the keys are assumed to be the names of query parameters to be appended to the <code>src</code> URL. The value associated with each key must be either a String or a String array representing the parameter value(s), or an object whose toString() method will be called. If a String array is specified, more than one value for the same query parameter name will be created.</p> <p>You can specify the alternate text for this image (which most browsers display as pop-up text block when the user hovers the mouse over this image) either directly, through the <code>alt</code> attribute, or indirectly from a message resources bundle, using the <code>bundle</code> and <code>altKey</code> attributes.</p>

Can contain: empty

<html:javascript>

<p><strong> Render JavaScript validation based on the validation rules loaded by the ValidatorPlugIn. </strong></p> <p> Render JavaScript validation based on the validation rules loaded by the <code>ValidatorPlugIn</code>. The set of validation rules that should be generated is based on the formName attribute passed in, which should match the name attribute of the form element in the xml file. </p> <p> The dynamicJavascript and staticJavascript attributes default to true, but if dynamicJavascript is set to <code>true</code> and staticJavascript is set to <code>false</code> then only the dynamic JavaScript will be rendered. If dynamicJavascript is set to <code>false</code> and staticJavascript is set to <code>true</code> then only the static JavaScript will be rendered which can then be put in separate JSP page so the browser can cache the static JavaScript. </p>

Can contain: empty

<html:link>

<p><strong>Render an HTML anchor or hyperlink</strong></p> <p>Renders an HTML <code>&lt;a&gt;</code> element as an anchor definition (if "linkName" is specified) or 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> <p>The base URL for this hyperlink is calculated based on which of the following attributes you specify (you must specify exactly one of them):</p> <ul> <li> <em>forward</em> - Use the value of this attribute as the name of a global <code>ActionForward</code> to be looked up, and use the module-relative or context-relative URI found there. If the forward is module-relative then it must point to an action and NOT to a page.</li> <li> <em>action</em> - Use the value of this attribute as the name of a <code>Action</code> to be looked up, and use the module-relative or context-relative URI found there.</li> <li> <em>href</em> - Use the value of this attribute unchanged. </li> <li> <em>page</em> - Use the value of this attribute as a module-relative URI, and generate a server-relative URI by including the context path and module prefix.</li> </ul> <p>Normally, the hyperlink you specify with one of the attributes described in the previous paragraph will be left unchanged (other than URL rewriting if necessary). However, there are two ways you can append one or more dynamically defined query parameters to the hyperlink -- specify a single parameter with the <code>paramId</code> attribute (and its associated attributes to select the value), or specify the <code>name</code> (and optional <code>property</code>) attributes to select a <code>java.util.Map</code> bean that contains one or more parameter ids and corresponding values. </p> <p>To specify a single parameter, use the <code>paramId</code> attribute to define the name of the request parameter to be submitted. To specify the corresponding value, use one of the following approaches:</p> <ul> <li> <em>Specify only the <code>paramName</code> attribute</em> - The named JSP bean (optionally scoped by the value of the <code>paramScope</code> attribute) must identify a value that can be converted to a String.</li> <li> <em>Specify both the <code>paramName</code> and <code>paramProperty</code> attributes</em> - The specified property getter method will be called on the JSP bean identified by the <code>paramName</code> (and optional <code>paramScope</code>) attributes, in order to select a value that can be converted to a String.</li> </ul> <p>If you prefer to specify a <code>java.util.Map</code> that contains all of the request parameters to be added to the hyperlink, use one of the following techniques:</p> <ul> <li> <em>Specify only the <code>name</code> attribute</em> - The named JSP bean (optionally scoped by the value of the <code>scope</code> attribute) must identify a <code>java.util.Map</code> containing the parameters.</li> <li> <em>Specify both <code>name</code> and <code>property</code> attributes</em> - The specified property getter method will be called on the bean identified by the <code>name</code> (and optional <code>scope</code>) attributes, in order to return the <code>java.util.Map</code> containing the parameters.</li> </ul> <p>As the <code>Map</code> is processed, the keys are assumed to be the names of query parameters to be appended to the hyperlink. The value associated with each key must be either a String or a String array representing the parameter value(s), or an object whose toString() method will be called. If a String array is specified, more than one value for the same query parameter name will be created.</p> <p>Additionally, you can request that the current transaction control token, if any, be included in the generated hyperlink by setting the <code>transaction</code> attribute to <code>true</code>. You can also request that an anchor ("#xxx") be added to the end of the URL that is created by any of the above mechanisms, by using the <code>anchor</code> attribute.</p>

Can contain: JSP

<html:messages>

<p><strong> Conditionally display a set of accumulated messages. </strong></p> <p>Displays a set of messages prepared by a business logic component and stored as an <code>ActionMessages</code> object, <code>ActionErrors</code> object, a String, or a String array in any scope. 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.</p>

Can contain: JSP

<html:multibox>

<p><strong> Render A Checkbox Input Field </strong></p> <p>Renders an HTML <code>&lt;input&gt;</code> element of type <code>checkbox</code>, whose "checked" status is initialized based on whether the specified value matches one of the elements of the underlying property's array of current values. This element is useful when you have large numbers of checkboxes, and prefer to combine the values into a single array-valued property instead of multiple boolean properties. This tag is only valid when nested inside a form tag body.</p> <p> <strong>WARNING</strong>: In order to correctly recognize cases where none of the associated checkboxes are selected, the <code>ActionForm</code> bean associated with this form must include a statement setting the corresponding array to zero length in the <code>reset()</code> method.</p> <p>The value to be returned to the server, if this checkbox is selected, must be defined by one of the following methods:</p> <ul> <li>Specify a <code>value</code> attribute, whose contents will be used literally as the value to be returned.</li> <li>Specify no <code>value</code> attribute, and the nested body content of this tag will be used as the value to be returned.</li> </ul>

Can contain:

<html:option>

<p><strong> Render A Select Option </strong></p> <p>Render an HTML <code>&lt;option&gt;</code> element, representing one of the choices for an enclosing <code>&lt;select&gt;</code> element. The text displayed to the user comes from either the body of this tag, or from a message string looked up based on the <code>bundle</code>, <code>locale</code>, and <code>key</code> attributes.</p> <p>If the value of the corresponding bean property matches the specified value, this option will be marked selected. This tag is only valid when nested inside a <code>&lt;html:select&gt;</code> tag body.</p>

Can contain:

<html:options>

<p><strong> Render a Collection of Select Options </strong></p> <p>Renders a set of HTML <code>&lt;option&gt;</code> elements, representing possible choices for a <code>&lt;select&gt;</code> element. This tag can be used multiple times within a single <code>&lt;html:select&gt;</code> element, either in conjunction with or instead of one or more <code>&lt;html:option&gt;</code> or <code>&lt;html:optionsCollection&gt;</code> elements.</p> <p>This tag operates in one of two major modes, depending on whether or not the <code>collection</code> attribute is specified. If the <code>collection</code> attribute is included, the following rules apply:</p> <ul> <li>The <strong>collection</strong> attribute is interpreted as the name of a JSP bean, in some scope, that itself represents a collection of individual beans, one per option value to be rendered.</li> <li>The <strong>property</strong> attribute is interpreted as the name of a property of the individual beans included in the collection, and is used to retrieve the value that will be returned to the server if this option is selected.</li> <li>The <strong>labelProperty</strong> attribute is interpreted as the name of a property of the individual beans included in the collection, and is used to retrieve the label that will be displayed to the user for this option. If the <code>labelProperty</code> attribute is not specified, the property named by the <code>property</code> attribute will be used to select both the value returned to the server and the label displayed to the user for this option.</li> </ul> <p>If the <code>collection</code> attribute is not specified, the rules described in the remainder of this section apply.</p> <p>The collection of values actually selected depends on the presence or absence of the <code>name</code> and <code>property</code> attributes. The following combinations are allowed:</p> <ul> <li> <em>Only <code>name</code> is specified</em> - The value of this attribute is the name of a JSP bean in some scope that is the collection.</li> <li> <em>Only <code>property</code> is specified</em> - The value of this attribute is the name of a property of the ActionForm bean associated with our form, which will return the collection.</li> <li> <em>Both <code>name</code> and <code>property</code> are specified</em> - The value of the <code>name</code> attribute identifies a JSP bean in some scope. The value of the <code>property</code> attribute is the name of some property of that bean which will return the collection.</li> </ul> <p>The collection of labels displayed to the user can be the same as the option values themselves, or can be different, depending on the presence or absence of the <code>labelName</code> and <code>labelProperty</code> attributes. If this feature is used, the collection of labels must contain the same number of elements as the corresponding collection of values. The following combinations are allowed:</p> <ul> <li> <em>Neither <code>labelName</code> nor <code>labelProperty</code> is specified</em> - The labels will be the same as the option values themselves.</li> <li> <em>Only <code>labelName</code> is specified</em> - The value of this attribute is the name of a JSP bean in some scope that is the collection.</li> <li> <em>Only <code>labelProperty</code> is specified</em> - The value of this attribute is the name of a property of the ActionForm bean associated with our form, which will return the collection.</li> <li> <em>Both <code>labelName</code> and <code>labelProperty</code> are specified</em> - The value of the <code>labelName</code> attribute identifies a JSP bean in some scope. The value of the <code>labelProperty</code> attribute is the name of some property of that bean which will return the collection.</li> </ul> <p>Note that this tag does not support a <code>styleId</code> attribute, as it would have to apply the value to all the <code>option</code> elements created by this element, which would mean that more than one <code>id</code> element might have the same value, which the HTML specification says is illegal.</p>

Can contain: empty

<html:optionsCollection>

<p><strong> Render a Collection of Select Options </strong></p> <p>Renders a set of HTML <code>&lt;option&gt;</code> elements, representing possible choices for a <code>&lt;select&gt;</code> element. This tag can be used multiple times within a single <code>&lt;html:select&gt;</code> element, either in conjunction with or instead of one or more <code>&lt;html:option&gt;</code> or <code>&lt;html:options&gt;</code> elements.</p> <p>This tag operates on a collection of beans, where each bean has a <strong>label</strong> property and a <strong>value</strong> property. The actual names of these properties can be configured using the <code>label</code> and <code>value</code> attributes of this tag.</p> <p>This tag differs from the <code>&lt;html:options&gt;</code> tag in that it makes more consistent use of the <code>name</code> and <code>property</code> attributes, and allows the collection to be more easily obtained from the enclosing form bean.</p> <p>Note that this tag does not support a <code>styleId</code> attribute, as it would have to apply the value to all the <code>option</code> elements created by this element, which would mean that more than one <code>id</code> element might have the same value, which the HTML specification says is illegal.</p>

Can contain: empty

<html:param>

<p>Adds a parameter to the following tags: <ol> <li><a href="#frame">&lt;html:frame&gt;</li> <li><a href="#link">&lt;html:link&gt;</li> <li><a href="#rewrite">&lt;html:rewrite&gt;</li> </ol> </p> <dl><dt><b>Since:</b></dt> <dd>Struts 1.3.6</dd></dl>

Can contain:

<html:password>

<p><strong> Render A Password Input Field </strong></p> Renders an HTML <code>&lt;input&gt;</code> element of type password, populated from the specified value or the specified property of the bean associated with our current form. This tag is only valid when nested inside a form tag body.

Can contain:

<html:radio>

<p><strong> Render A Radio Button Input Field </strong></p> <p> Renders an HTML <code>&lt;input&gt;</code> element of type radio, populated from the specified property of the bean associated with our current form. This tag is only valid when nested inside a form tag body. </p> <p> If an iterator is used to render a series of radio tags, the idName attribute may be used to specify the name of the bean exposed by the iterator. In this case, the value attribute is used as the name of a property on the idName bean that returns the value of the radio tag in this iteration. </p>

Can contain:

<html:reset>

<p><strong> Render A Reset Button Input Field </strong></p> Renders an HTML <code>&lt;input&gt;</code> element of type reset.

Can contain:

<html:rewrite>

<p><strong>Render an URI</strong></p> <p>Renders a request URI based on exactly the same rules as the <code> <a href="#link">link</a> </code> tag does, but without creating the <code>&lt;a&gt;</code> hyperlink. This value is useful when you want to generate a string constant for use by a JavaScript procedure.</p>

Can contain: JSP

<html:select>

<p><strong> Render A Select Element </strong></p> <p>Renders an HTML <code>&lt;select&gt;</code> element, associated with a bean property specified by our attributes. This tag is only valid when nested inside a form tag body. </p> <p>This tag operates in two modes, depending upon the state of the <code>multiple</code> attribute, which affects the data type of the associated property you should use:</p> <ul> <li> <em>multiple="true" IS NOT selected</em> - The corresponding property should be a scalar value of any supported data type.</li> <li> <em>multiple="true" IS selected</em> - The corresponding property should be an array of any supported data type.</li> </ul> <p> <strong>WARNING</strong>: In order to correctly recognize cases where no selection at all is made, the <code>ActionForm</code> bean associated with this form must include a statement resetting the scalar property to a default value (if <code>multiple</code> is not set), or the array property to zero length (if <code>multiple</code> is set) in the <code>reset()</code> method.</p>

Can contain: JSP

<html:submit>

<p><strong> Render A Submit Button </strong></p> Renders an HTML <code>&lt;input&gt;</code> element of type <code>submit</code> <p> If a graphical button is needed (a button with an image), then the <a href="#image"><code>image</code></a> tag is more appropriate. </p>

Can contain:

<html:text>

<p><strong> Render An Input Field of Type text </strong></p> Render an input button of type text. This tag is only valid when nested inside a form tag body.

Can contain:

<html:textarea>

<p><strong> Render A Textarea </strong></p> Render a textarea element. This tag is only valid when nested inside a form tag body.

Can contain:

<html:xhtml>

<p><strong>Render HTML tags as XHTML</strong></p> <p> Using this tag in a page tells all other html taglib tags to render themselves as XHTML 1.0. This is useful when composing pages with JSP includes or Tiles. <code>&lt;html:html xhtml="true"&gt;</code> has a similar effect. This tag has no attributes; you use it like this: <code>&lt;html:xhtml/&gt;</code>. </p> <p> <strong>Note</strong>: Included pages do not inherit the rendering style of the including page. Each JSP fragment or Tile must use this tag to render as XHTML. </p>

Can contain: empty

This tag has no attributes.

<logic:forward>

<p><strong> Forward control to the page specified by the specified ActionForward entry. </strong></p> <p>Performs a <code>PageContext.forward()</code> or <code>HttpServletResponse.sendRedirect()</code> call for the global <code>ActionForward</code> entry for the specified name. URL rewriting will occur automatically if a redirect is performed.</p>

Can contain: empty

<logic:iterate>

<p><strong> Repeat the nested body content of this tag over a specified collection. </strong></p> <p>Repeats the nested body content of this tag once for every element of the specified collection, which must be an <code>Iterator</code>, a <code>Collection</code>, a <code>Map</code> (whose values are to be iterated over), or an array. The collection to be iterated over must be specified in one of the following ways:</p> <ul> <li>As a runtime expression specified as the value of the <code>collection</code> attribute.</li> <li>As a JSP bean specified by the <code>name</code> attribute.</li> <li>As the property, specified by the <code>property</code>, of the JSP bean specified by the <code>name</code> attribute.</li> </ul> <p>The collection to be iterated over MUST conform to one of the following requirements in order for iteration to be successful:</p> <ul> <li>An array of Java objects or primitives.</li> <li>An implementation of <code>java.util.Collection</code>, including <code>ArrayList</code> and <code>Vector</code>.</li> <li>An implementation of <code>java.util.Enumeration</code>.</li> <li>An implementation of <code>java.util.Iterator</code>.</li> <li>An implementation of <code>java.util.Map</code>, including <code>HashMap</code>, <code>Hashtable</code>, and <code>TreeMap</code>. <strong>NOTE</strong> - See below for additional information about accessing Maps.</li> </ul> <p>Normally, each object exposed by the iterate tag is an element of the underlying collection you are iterating over. However, if you iterate over a <code>Map</code>, the exposed object is of type <code>Map.Entry</code> that has two properties:</p> <ul> <li> <code>key</code> - The key under which this item is stored in the underlying Map.</li> <li> <code>value</code> - The value that corresponds to this key.</li> </ul> <p>So, if you wish to iterate over the values of a Hashtable, you would implement code like the following:</p> <code>&lt;logic-el:iterate id="element" name="myhashtable"><br/> Next element is &lt;bean:write name="element" property="value"/><br/> &lt;/logic-el:iterate> </code> <p>If the collection you are iterating over can contain <code>null</code> values, the loop will still be performed but no page scope attribute (named by the <code>id</code> attribute) will be created for that loop iteration. You can use the <code>&lt;logic-el:present;gt;</code> and <code>&lt;logic-el:notPresent&gt;</code> tags to test for this case.</p>

Can contain: JSP

<logic:match>

<p><strong> Evaluate the nested body content of this tag if the specified value is an appropriate substring of the requested variable. </strong></p> <p>Matches the variable specified by one of the selector attributes (as a String) against the specified constant value. If the value is a substring (appropriately limited by the <code>location</code> attribute), the nested body content of this tag is evaluated.</p>

Can contain: JSP

<logic:messagesNotPresent>

<p><strong> Generate the nested body content of this tag if the specified message is not present in this request. </strong></p> <p>Evaluates the nested body content of this tag if an <code>ActionMessages</code> object, <code>ActionErrors</code> object, a String, or a String array is not in request scope. If such a bean is not found, nothing will be rendered. </p> <dl><dt><b>Since:</b></dt> <dd>Struts 1.1</dd></dl>

Can contain: JSP

<logic:messagesPresent>

<p><strong> Generate the nested body content of this tag if the specified message is present in this request. </strong></p> <p>Evaluates the nested body content of this tag if an <code>ActionMessages</code> object, <code>ActionErrors</code> object, a String, or a String array is in request scope. If such a bean is not found, nothing will be rendered. </p> <dl><dt><b>Since:</b></dt> <dd>Struts 1.1</dd></dl>

Can contain: JSP

<logic:notMatch>

<p><strong> Evaluate the nested body content of this tag if the specified value is not an appropriate substring of the requested variable. </strong></p> <p>Matches the variable specified by one of the selector attributes (as a String) against the specified constant value. If the value is not a substring (appropriately limited by the <code>location</code> attribute), the nested body content of this tag is evaluated.</p>

Can contain: JSP

<logic:notPresent>

<p><strong> Generate the nested body content of this tag if the specified value is not present in this request. </strong></p> <p>Depending on which attribute is specified, this tag checks the current request, and evaluates the nested body content of this tag only if the specified value <strong>is not</strong> present. Only one of the attributes may be used in one occurrence of this tag, unless you use the <code>property</code> attribute, in which case the <code>name</code> attribute is also required.</p>

Can contain: JSP

<logic:present>

<p><strong> Generate the nested body content of this tag if the specified value is present in this request. </strong></p> <p>Depending on which attribute is specified, this tag checks the current request, and evaluates the nested body content of this tag only if the specified value <strong>is</strong> present. Only one of the attributes may be used in one occurrence of this tag, unless you use the <code>property</code> attribute, in which case the <code>name</code> attribute is also required.</p>

Can contain: JSP

<logic:redirect>

<p><strong>Render an HTTP Redirect</strong></p> <p>Performs an <code>HttpServletResponse.sendRedirect()</code> call to the hyperlink specified by the attributes to this tag. URL rewriting will be applied automatically, to maintain session state in the absence of cookies.</p> <p>The base URL for this redirect is calculated based on which of the following attributes you specify (you must specify exactly one of them):</p> <ul> <li> <em>forward</em> - Use the value of this attribute as the name of a global <code>ActionForward</code> to be looked up, and use the module-relative or context-relative URI found there.</li> <li> <em>href</em> - Use the value of this attribute unchanged. </li> <li> <em>page</em> - Use the value of this attribute as an module-relative URI, and generate a server-relative URI by including the context path.</li> </ul> <p>Normally, the redirect you specify with one of the attributes described in the previous paragraph will be left unchanged (other than URL rewriting if necessary). However, there are two ways you can append one or more dynamically defined query parameters to the hyperlink -- specify a single parameter with the <code>paramId</code> attribute (and its associated attributes to select the value), or specify the <code>name</code> (and optional <code>property</code>) attributes to select a <code>java.util.Map</code> bean that contains one or more parameter ids and corresponding values. </p> <p>To specify a single parameter, use the <code>paramId</code> attribute to define the name of the request parameter to be submitted. To specify the corresponding value, use one of the following approaches:</p> <ul> <li> <em>Specify only the <code>paramName</code> attribute</em> - The named JSP bean (optionally scoped by the value of the <code>paramScope</code> attribute) must identify a value that can be converted to a String.</li> <li> <em>Specify both the <code>paramName</code> and <code>paramProperty</code> attributes</em> - The specified property getter method will be called on the JSP bean identified by the <code>paramName</code> (and optional <code>paramScope</code>) attributes, in order to select a value that can be converted to a String.</li> </ul> <p>If you prefer to specify a <code>java.util.Map</code> that contains all of the request parameters to be added to the hyperlink, use one of the following techniques:</p> <ul> <li> <em>Specify only the <code>name</code> attribute</em> - The named JSP bean (optionally scoped by the value of the <code>scope</code> attribute) must identify a <code>java.util.Map</code> containing the parameters.</li> <li> <em>Specify both <code>name</code> and <code>property</code> attributes</em> - The specified property getter method will be called on the bean identified by the <code>name</code> (and optional <code>scope</code>) attributes, in order to return the <code>java.util.Map</code> containing the parameters.</li> </ul> <p>As the <code>Map</code> is processed, the keys are assumed to be the names of query parameters to be appended to the hyperlink. The value associated with each key must be either a String or a String array representing the parameter value(s). If a String array is specified, more than one value for the same query parameter name will be created.</p>

Can contain:

<tiles:add>

<p><strong> Add an element to the surrounding list. Equivalent to 'put', but for list element. </strong></p> <p>Add an element to the surrounding list. This tag can only be used inside putList tag. Value can come from a direct assignment (value="aValue") or from a bean. One of 'value' or 'beanName' must be present.</p>

Can contain: JSP

<tiles:definition>

<p><strong>Create a tile /component / template definition bean. </strong></p> <p>Create a tile/component/template definition as a bean. Newly created bean will be saved under specified "id", in the requested "scope". Definition tag has same syntax as <code>insert</code></p>

Can contain: JSP

<tiles:get>

<p><strong>Gets the content from request scope that was put there by a put tag.</strong></p> <p>Retrieve content from tile context and include it.</p> <p>Take into account the 'type' attribute.</p>

Can contain: empty

<tiles:getAsString>

<p><strong>Render the value of the specified tile/component/template attribute to the current JspWriter</strong></p> <p>Retrieve the value of the specified tile/component/template attribute property, and render it to the current JspWriter as a String. The usual toString() conversions is applied on found value.</p> <p>Throw a JSPException if named value is not found.</p>

Can contain: empty

<tiles:importAttribute>

<p><strong>Import Tile's attribute in specified context.</strong></p> <p>Import attribute from tile to requested scope. Attribute name and scope are optional. If not specified, all tile attributes are imported in page scope. Once imported, an attribute can be used as any other beans from jsp contexts.</p>

Can contain: empty

<tiles:initComponentDefinitions>

<p><strong>Initialize Tile/Component definitions factory.</strong></p> <p>In order to use Tile/Component definitions factory, you need to initialize the factory. This is generally done in a initializing servlet. In particular, it is done in "ComponentActionServlet" if you use it. If you don't initialize factory in a servlet, you can initialize it using this tag. You need to provide the description file name, and optionally the factory classname. Initialization is done only once, at the first call of this tag. Subsequent calls are ignored (tag checks existence of the factory).</p>

Can contain: empty

<tiles:insert>

<p><strong>Insert a tiles/component/template.</strong></p> <p>Insert a tiles/component/template with the possibility to pass parameters (called attribute). A tile can be seen as a procedure that can take parameters or attributes. <code>&lt;tiles:insert&gt;</code> allows to define these attributes and pass them to the inserted jsp page, called template. Attributes are defined using nested tag <code>&lt;tiles:put&gt;</code> or <code>&lt;tiles:putList&gt;</code>. </p> <p>You must specify one of this tag attribute :</p> <ul> <li><code>template</code>, for inserting a tiles/component/template page,</li> <li><code>component</code>, for inserting a tiles/component/template page, (same as template)</li> <li><code>page</code> for inserting a JSP page, (same as template)</li> <li><code>definition</code>, for inserting a definition from definitions factory</li> <li><code>attribute</code>, surrounding tiles's attribute name whose value is used.<br/> If attribute is associated to 'direct' flag (see put), and flag is true, write attribute value (no insertion).</li> <li><code>name</code>, to let 'insert' determine the type of entities to insert. In this later case, search is done in this order : definitions, tiles/components/templates, pages.</li> </ul> <p>In fact, Page, component and template, are equivalent as a tile, component or template are jsp page.</p> <p><strong>Example : </strong></p> <pre> <code> &lt;tiles:insert page="/basic/myLayout.jsp" flush="true"> &lt;tiles:put name="title" value="My first page" /> &lt;tiles:put name="header" value="/common/header.jsp" /> &lt;tiles:put name="footer" value="/common/footer.jsp" /> &lt;tiles:put name="menu" value="/basic/menu.jsp" /> &lt;tiles:put name="body" value="/basic/helloBody.jsp" /> &lt;/tiles:insert> </code> </pre>

Can contain: JSP

<tiles:put>

<p><strong>Put an attribute into tile/component/template context. </strong></p> <p>Define an attribute to pass to tile/component/template. This tag can only be used inside 'insert' or 'definition' tag. Value (or content) is specified using attribute 'value' (or 'content'), or using the tag body. It is also possible to specify the type of the value :</p> <ul> <li>string : Content is written directly.</li> <li>page | template : Content is included from specified URL. Name is used as an URL.</li> <li>definition : Content come from specified definition (from factory). Name is used as definition name.</li> </ul> <p>If 'type' attribute is not specified, content is 'untyped', unless it comes from a typed bean.</p> <p>Note that using 'direct="true"' is equivalent to 'type="string"'.</p>

Can contain: JSP

<tiles:putList>

<p><strong>Declare a list that will be pass as attribute to tile. </strong></p> <p>Declare a list that will be pass as attribute to tile. List elements are added using the tag 'add'. This tag can only be used inside 'insert' or 'definition' tag.</p>

Can contain: JSP

<tiles:useAttribute>

<p><strong>Use attribute value inside page.</strong></p> <p>Declare a Java variable, and an attribute in the specified scope, using tile attribute value.</p> <p>Java variable and attribute will have the name specified by 'id', or the original name if not specified.</p>

Can contain: empty