Craig R. McClanahan Martin Cooper Mike Schachter James Turner David Graham The Struts Framework Project - HTML Tags 1.2 1.1 html Page Construction Tags http://struts.apache.org/tags-html

This taglib contains tags used to create struts input forms, as well as other tags generally useful in the creation of HTML-based user interfaces.

Many of the tags in this tag library will throw a JspException at runtime when they are utilized incorrectly (such as when you specify an invalid combination of tag attributes). JSP allows you to declare an "error page" in the <%@ page %> directive. If you wish to process the actual exception that caused the problem, it is passed to the error page as a request attribute under key org.apache.struts.action.EXCEPTION.

 base Render an HTML <base> Element org.apache.struts.taglib.html.BaseTag empty

Renders an HTML <base> element with an href attribute pointing to the absolute location of the enclosing JSP page. This tag is valid only when nested inside an HTML <head> element.

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).

 target false true

The window target for this base reference.

 server false true

The server name to use instead of request.getServerName().

 button Render A Button Input Field org.apache.struts.taglib.html.ButtonTag

Renders an HTML <input> element of type button, populated from the specified value or the content of this tag body. This tag is only valid when nested inside a form tag body.

If a graphical button is needed (a button with an image), then the image tag is more appropriate.

accesskey false true The keyboard character used to move focus immediately to this element. alt false true

The alternate text for this element.

 altKey false true

The message resources key of the alternate text for this element.

 disabled false true Set to true if this input field should be disabled. indexed false true Valid only inside of logic:iterate tag. If true then name of the html tag will be rendered as "propertyName[34]". Number in brackets will be generated for every iteration and taken from ancestor logic:iterate tag. onblur false true JavaScript event handler executed when this element loses input focus. onchange false true JavaScript event handler executed when this element loses input focus and its value has changed. onclick false true JavaScript event handler executed when this element receives a mouse click. ondblclick false true JavaScript event handler executed when this element receives a mouse double click. onfocus false true JavaScript event handler executed when this element receives input focus. onkeydown false true JavaScript event handler executed when this element has focus and a key is depressed. onkeypress false true JavaScript event handler executed when this element has focus and a key is depressed and released. onkeyup false true JavaScript event handler executed when this element has focus and a key is released. onmousedown false true JavaScript event handler executed when this element is under the mouse pointer and a mouse button is depressed. onmousemove false true JavaScript event handler executed when this element is under the mouse pointer and the pointer is moved. onmouseout false true JavaScript event handler executed when this element was under the mouse pointer but the pointer was moved outside the element. onmouseover false true JavaScript event handler executed when this element was not under the mouse pointer but the pointer is moved inside the element. onmouseup false true JavaScript event handler executed when this element is under the mouse pointer and a mouse button is released. property true true Name of the request parameter that will be included with this submission, set to the specified value. style false true CSS styles to be applied to this HTML element. styleClass false true CSS stylesheet class to be applied to this HTML element (renders a "class" attribute). styleId false true Identifier to be assigned to this HTML element (renders an "id" attribute). tabindex false true The tab order (ascending positive integers) for this element. title false true

The advisory title for this element.

 titleKey false true

The message resources key for the advisory title for this element.

 value false true 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 "Click"] cancel Render a Cancel Button org.apache.struts.taglib.html.CancelTag

Renders an HTML <input> 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.

accesskey false true The keyboard character used to move focus immediately to this element. alt false true

The alternate text for this element.

 altKey false true

The message resources key of the alternate text for this element.

 disabled false true Set to true if this input field should be disabled. onblur false true JavaScript event handler executed when this element loses input focus. onchange false true JavaScript event handler executed when this element loses input focus and its value has changed. onclick false true JavaScript event handler executed when this element receives a mouse click. ondblclick false true JavaScript event handler executed when this element receives a mouse double click. onfocus false true JavaScript event handler executed when this element receives input focus. onkeydown false true JavaScript event handler executed when this element has focus and a key is depressed. onkeypress false true JavaScript event handler executed when this element has focus and a key is depressed and released. onkeyup false true JavaScript event handler executed when this element has focus and a key is released. onmousedown false true JavaScript event handler executed when this element is under the mouse pointer and a mouse button is depressed. onmousemove false true JavaScript event handler executed when this element is under the mouse pointer and the pointer is moved. onmouseout false true JavaScript event handler executed when this element was under the mouse pointer but the pointer was moved outside the element. onmouseover false true JavaScript event handler executed when this element was not under the mouse pointer but the pointer is moved inside the element. onmouseup false true JavaScript event handler executed when this element is under the mouse pointer and a mouse button is released. property false true Name of the request parameter that will be included with this submission, set to the specified value. WARNING - If you set this attribute to a value other than the default, this will NOT be recognized as the cancel key by the Struts controller servlet or the Action.isCancelled() method. You will need to do your own cancel detection. style false true CSS styles to be applied to this HTML element. styleClass false true CSS stylesheet class to be applied to this HTML element (renders a "class" attribute). styleId false true Identifier to be assigned to this HTML element (renders an "id" attribute). tabindex false true The tab order (ascending positive integers) for this element. title false true

The advisory title for this element.

 titleKey false true

The message resources key for the advisory title for this element.

 value false true 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 "Cancel"] checkbox Render A Checkbox Input Field org.apache.struts.taglib.html.CheckboxTag

Renders an HTML <input> element of type checkbox, 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.

NOTE: The underlying property value associated with this field should be of type boolean, and any value 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 multibox tag.

WARNING: In order to correctly recognize unchecked checkboxes, the ActionForm bean associated with this form must include a statement setting the corresponding boolean property to false in the reset() method.

 accesskey false true The keyboard character used to move focus immediately to this element. alt false true

The alternate text for this element.

 altKey false true

The message resources key of the alternate text for this element.

 disabled false true Set to true if this input field should be disabled. indexed false true Valid only inside of logic:iterate tag. If true then name of the html tag will be rendered as "id[34].propertyName". Number in brackets will be generated for every iteration and taken from ancestor logic:iterate tag. name false true The attribute name of the bean whose properties are consulted when rendering the current value of this input field. If not specified, the bean associated with the form tag we are nested within is utilized. onblur false true JavaScript event handler executed when this element loses input focus. onchange false true JavaScript event handler executed when this element loses input focus and its value has changed. onclick false true JavaScript event handler executed when this element receives a mouse click. ondblclick false true JavaScript event handler executed when this element receives a mouse double click. onfocus false true JavaScript event handler executed when this element receives input focus. onkeydown false true JavaScript event handler executed when this element has focus and a key is depressed. onkeypress false true JavaScript event handler executed when this element has focus and a key is depressed and released. onkeyup false true JavaScript event handler executed when this element has focus and a key is released. onmousedown false true JavaScript event handler executed when this element is under the mouse pointer and a mouse button is depressed. onmousemove false true JavaScript event handler executed when this element is under the mouse pointer and the pointer is moved. onmouseout false true JavaScript event handler executed when this element was under the mouse pointer but the pointer was moved outside the element. onmouseover false true JavaScript event handler executed when this element was not under the mouse pointer but the pointer is moved inside the element. onmouseup false true JavaScript event handler executed when this element is under the mouse pointer and a mouse button is released. property true true Name of the request parameter that will be included with this submission, set to the specified value. style false true CSS styles to be applied to this HTML element. styleClass false true CSS stylesheet class to be applied to this HTML element (renders a "class" attribute). styleId false true Identifier to be assigned to this HTML element (renders an "id" attribute). tabindex false true The tab order (ascending positive integers) for this element. title false true

The advisory title for this element.

 titleKey false true

The message resources key for the advisory title for this element.

 value false true The value to be transmitted if this checkbox is checked when the form is submitted. If not specified, the value "on" will be returned. errors Conditionally display a set of accumulated error messages. org.apache.struts.taglib.html.ErrorsTag empty

Displays a set of error messages prepared by a business logic component and stored as an ActionErrors object, a String, or a String array in request scope. If such a bean is not found, nothing will be rendered.

In order to use this tag successfully, you must have defined an application scope MessageResources bean under the default attribute name, with optional definitions of the following message keys:

  • errors.header - Text that will be rendered before the error messages list. Typically, this message text will end with <ul> to start the error messages list.
  • errors.footer - Text that will be rendered after the error messages list. Typically, this message text will begin with </ul> to end the error messages list.
  • errors.prefix - Text that will be rendered before each individual error in the list.
  • errors.suffix - Text that will be rendered after each individual error in the list.
 bundle false true The servlet context attribute key for the MessageResources instance to use. If not specified, defaults to the application resources configured for our action servlet. locale false true The session attribute key for the Locale used to select messages to be displayed. If not specified, defaults to the Struts standard value. name false true Name of the request scope bean under which our error messages have been stored. If not present, the name specified by the Globals.ERROR_KEY constant string will be used. property false true Name of the property for which error messages should be displayed. If not specified, all error messages (regardless of property) are displayed. file Render A File Select Input Field org.apache.struts.taglib.html.FileTag

Renders an HTML <input> 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.

As with the corresponding HTML <input> element, the enclosing form element must specify "POST" for the method attribute, and "multipart/form-data" for the enctype attribute. For example: 

    <html:form method="POST" enctype="multipart/form-data">
        <html:file property="theFile" />
    </html:form>
 accesskey false true The keyboard character used to move focus immediately to this element. accept false true Comma-delimited set of content types that the server you submit to knows how to process. This list can be used by the client browser to limit the set of file options that is made available for selection. If not specified, no content type list will be sent. alt false true

The alternate text for this element.

 altKey false true

The message resources key of the alternate text for this element.

 disabled false true Set to true if this input field should be disabled. indexed false true Valid only inside of logic:iterate tag. If true then name of the html tag will be rendered as "id[34].propertyName". Number in brackets will be generated for every iteration and taken from ancestor logic:iterate tag. maxlength false true Maximum number of input characters to accept. This is ignored by most browsers. [No limit] name false true The attribute name of the bean whose properties are consulted when rendering the current value of this input field. If not specified, the bean associated with the form tag we are nested within is utilized. onblur false true JavaScript event handler executed when this element loses input focus. onchange false true JavaScript event handler executed when this element loses input focus and its value has changed. onclick false true JavaScript event handler executed when this element receives a mouse click. ondblclick false true JavaScript event handler executed when this element receives a mouse double click. onfocus false true JavaScript event handler executed when this element receives input focus. onkeydown false true JavaScript event handler executed when this element has focus and a key is depressed. onkeypress false true JavaScript event handler executed when this element has focus and a key is depressed and released. onkeyup false true JavaScript event handler executed when this element has focus and a key is released. onmousedown false true JavaScript event handler executed when this element is under the mouse pointer and a mouse button is depressed. onmousemove false true JavaScript event handler executed when this element is under the mouse pointer and the pointer is moved. onmouseout false true JavaScript event handler executed when this element was under the mouse pointer but the pointer was moved outside the element. onmouseover false true JavaScript event handler executed when this element was not under the mouse pointer but the pointer is moved inside the element. onmouseup false true JavaScript event handler executed when this element is under the mouse pointer and a mouse button is released. property true true Name of the request parameter that will be included with this submission, set to the specified value. size false true Size of the file selection box to be displayed. style false true CSS styles to be applied to this HTML element. styleClass false true CSS stylesheet class to be applied to this HTML element (renders a "class" attribute). styleId false true Identifier to be assigned to this HTML element (renders an "id" attribute). tabindex false true The tab order (ascending positive integers) for this element. title false true

The advisory title for this element.

 titleKey false true

The message resources key for the advisory title for this element.

 value false true

NOTE: When setting this to some value, whether intentional or as the result (for example) of validation errors forcing the user back to the original jsp, this value is ignored by most browsers (for security reasons). This means that your users will have to re-select any previously selected files when submitting the form. Opera web browser will prompt the user so they have a chance to abort the submit.

Value to which this field should be initialized. [Use the corresponding bean property value or body content (if any) if property is not specified] form Define An Input Form org.apache.struts.taglib.html.FormTag JSP

Renders an HTML <form> 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.

The form bean is located, and created if necessary, based on the form bean specification for the associated ActionMapping.

action true true

The URL to which this form will be submitted. This value is also used to select the ActionMapping we are assumed to be processing, from which we can identify the appropriate form bean and scope.

If you are using extension mapping for selecting the controller servlet, this value should be equal to the path attribute of the corresponding <action> element, optionally followed by the correct extension suffix.

If you are using path mapping to select the controller servlet, this value should be exactly equal to the path attribute of the corresponding <action> element.

 acceptCharset false true The list of character encodings for input data that the server should accept. Struts 1.2.2 enctype false true The content encoding to be used to submit this form, if the method is POST. This must be set to "multipart/form-data" if you are using the file tag to enable file upload. If not specified, the browser default (normally "application/x-www-form-urlencoded") is used. focus false true The field name (among the fields on this form) to which initial focus will be assigned with a JavaScript function. If not specified, no special JavaScript for this purpose will be rendered. focusIndex false true If the focus field is a field array, such as a radio button group, you can specify the index in the array to receive focus. Struts 1.1 method false true The HTTP method that will be used to submit this request (GET, POST). [POST] onreset false true JavaScript event handler executed if the form is reset. onsubmit false true JavaScript event handler executed if the form is submitted. scriptLanguage false true The form's focus <script> element will not contain a language attribute when this is set to false. The default is true but this property is ignored in XHMTL mode. Struts 1.2 style false true CSS styles to be applied to this HTML element. styleClass false true CSS stylesheet class to be applied to this HTML element (renders a "class" attribute). styleId false true Identifier to be assigned to this HTML element (renders an "id" attribute). target false true Window target to which this form is submitted, such as for use in framed presentations. frame Render an HTML frame element org.apache.struts.taglib.html.FrameTag

Renders an HTML <frame> element with processing for the src attribute that is identical to that performed by the <html:link> tag for the href attribute. URL rewriting will be applied automatically, to maintain session state in the absence of cookies.

The base URL for this frame is calculated based on which of the following attributes you specify (you must specify exactly one of them):

  • forward - Use the value of this attribute as the name of a global ActionForward to be looked up, and use the module-relative or context-relative URI found there.
  • href - Use the value of this attribute unchanged.
  • page - 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.
  • action - 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.

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 paramId attribute (and its associated attributes to select the value), or specify the name (and optional property) attributes to select a java.util.Map bean that contains one or more parameter ids and corresponding values.

To specify a single parameter, use the paramId attribute to define the name of the request parameter to be submitted. To specify the corresponding value, use one of the following approaches:

  • Specify only the paramName attribute - The named JSP bean (optionally scoped by the value of the paramScope attribute) must identify a value that can be converted to a String.
  • Specify both the paramName and paramProperty attributes - The specified property getter method will be called on the JSP bean identified by the paramName (and optional paramScope) attributes, in order to select a value that can be converted to a String.

If you prefer to specify a java.util.Map that contains all of the request parameters to be added to the hyperlink, use one of the following techniques:

  • Specify only the name attribute - The named JSP bean (optionally scoped by the value of the scope attribute) must identify a java.util.Map containing the parameters.
  • Specify both name and property attributes - The specified property getter method will be called on the bean identified by the name (and optional scope) attributes, in order to return the java.util.Map containing the parameters.

As the Map 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.

Additionally, you can request that the current transaction control token, if any, be included in the generated hyperlink by setting the transaction attribute to true. 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 anchor attribute.

 action false true

Logical name of a global Action that contains the actual content-relative URI of the destination of this transfer. This hyperlink may be dynamically modified by the inclusion of query parameters, as described in the tag description. You must specify exactly one of the action attribute, the forward attribute, the href attribute, or the page attribute.

Additionally, you can specify a module prefix for linking to other modules.

 module false true

Prefix name of a Module that contains the action mapping for the Action that is specified by the action attribute. You must specify an action attribute for this to have an effect.

Note: Use "" to map to the default module.

 anchor false true

Optional anchor tag ("#xxx") to be added to the generated hyperlink. Specify this value without any "#" character.

 forward false true

Logical name of a global ActionForward that contains the actual content-relative URI of the destination of this transfer. This hyperlink may be dynamically modified by the inclusion of query parameters, as described in the tag description. You must specify exactly one of the action attribute, the forward attribute, the href attribute, or the page attribute.

 frameborder false true

Should a frame border be generated around this frame (1) or not (0)?

 frameName false true

Value for the name attribute of the rendered <frame> element.

 href false true

The URL to which this hyperlink will transfer control if activated. This hyperlink may be dynamically modified by the inclusion of query parameters, as described in the tag description. You must specify exactly one of the action attribute, the forward attribute, the href attribute, or the page attribute.

 longdesc false true

URI of a long description of the frame. This description should supplement the short description provided by the title attribute, and may be particularly useful for non-visual user agents.

 marginheight false true

The amount of space (in pixels) to be left between the frame's contents and its top and bottom margins.

 marginwidth false true

The amount of space (in pixels) to be left between the frame's contents and its left and right margins.

 name false true

The name of a JSP bean that contains a Map representing the query parameters (if property is not specified), or a JSP bean whose property getter is called to return a Map (if property is specified).

 noresize false true

Should users be disallowed from resizing the frame? (true, false).

 page false true

The module-relative path (beginning with a "/" character) to which this hyperlink will transfer control if activated. This hyperlink may be dynamically modified by the inclusion of query parameters, as described in the tag description. You must specify exactly one of the action attribute, the forward attribute, the href attribute, or the page attribute.

 paramId false true

The name of the request parameter that will be dynamically added to the generated hyperlink. The corresponding value is defined by the paramName and (optional) paramProperty attributes, optionally scoped by the paramScope attribute

 paramName false true

The name of a JSP bean that is a String containing the value for the request parameter named by paramId (if paramProperty is not specified), or a JSP bean whose property getter is called to return a String (if paramProperty is specified). The JSP bean is constrained to the bean scope specified by the paramScope property, if it is specified.

 paramProperty false true

The name of a property of the bean specified by the paramName attribute, whose return value must be a String containing the value of the request parameter (named by the paramId attribute) that will be dynamically added to this hyperlink.

 paramScope false true

The scope within which to search for the bean specified by the paramName attribute. If not specified, all scopes are searched.

 property false true

The name of a property of the bean specified by the name attribute, whose return value must be a java.util.Map containing the query parameters to be added to the hyperlink. You must specify the name attribute if you specify this attribute.

 scope false true

The scope within which to search for the bean specified by the name attribute. If not specified, all scopes are searched.

 scrolling false true

Should scroll bars be created unconditionally (yes), never (no), or only when needed (auto)?

 style false true

CSS styles to be applied to this element.

 styleClass false true CSS stylesheet class to be applied to this HTML element (renders a "class" attribute). styleId false true Identifier to be assigned to this HTML element (renders an "id" attribute). title false true

The advisory title for this element.

 titleKey false true

The message resources key for the advisory title for this element.

 transaction false true

If set to true, any current transaction control token will be included in the generated hyperlink, so that it will pass an isTokenValid() test in the receiving Action.

 hidden Render A Hidden Field org.apache.struts.taglib.html.HiddenTag empty

Renders an HTML <input> 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.

accesskey false true The keyboard character used to move focus immediately to this element. alt false true

The alternate text for this element.

 altKey false true

The message resources key of the alternate text for this element.

 disabled false true Set to true if this input field should be disabled. indexed false true Valid only inside of logic:iterate tag. If true then name of the html tag will be rendered as "id[34].propertyName". Number in brackets will be generated for every iteration and taken from ancestor logic:iterate tag. name false true The attribute name of the bean whose properties are consulted when rendering the current value of this input field. If not specified, the bean associated with the form tag we are nested within is utilized. onblur false true JavaScript event handler executed when this element loses input focus. onchange false true JavaScript event handler executed when this element loses input focus and its value has changed. onclick false true JavaScript event handler executed when this element receives a mouse click. ondblclick false true JavaScript event handler executed when this element receives a mouse double click. onfocus false true JavaScript event handler executed when this element receives input focus. onkeydown false true JavaScript event handler executed when this element has focus and a key is depressed. onkeypress false true JavaScript event handler executed when this element has focus and a key is depressed and released. onkeyup false true JavaScript event handler executed when this element has focus and a key is released. onmousedown false true JavaScript event handler executed when this element is under the mouse pointer and a mouse button is depressed. onmousemove false true JavaScript event handler executed when this element is under the mouse pointer and the pointer is moved. onmouseout false true JavaScript event handler executed when this element was under the mouse pointer but the pointer was moved outside the element. onmouseover false true JavaScript event handler executed when this element was not under the mouse pointer but the pointer is moved inside the element. onmouseup false true JavaScript event handler executed when this element is under the mouse pointer and a mouse button is released. property true true Name of this input field, and the name of the corresponding bean property if value is not specified. The corresponding bean property (if any) must be of type String. style false true CSS styles to be applied to this HTML element. styleClass false true CSS stylesheet class to be applied to this HTML element (renders a "class" attribute). styleId false true Identifier to be assigned to this HTML element (renders an "id" attribute). title false true

The advisory title for this element.

 titleKey false true

The message resources key for the advisory title for this element.

 value false true Value to which this field should be initialized. [Use the corresponding bean property value] write false true Should the value of this field also be rendered to the response page to make it visible, in addition to creating an HTML type="hidden" element? By default, only the hidden element is created. html Render an HTML <html> Element org.apache.struts.taglib.html.HtmlTag JSP

Renders an HTML <html> element with language attributes extracted from the user's current Locale object, if there is one.

 lang false true Renders a lang attribute with the locale stored in the user's session. If not found in the session, the language from the Accept-Language HTTP header is used. If still not found, the default language for the server is used. Struts 1.2 locale false true

Set to true in order to store a Locale in the session based on the current request's Accept-Language header (if any) if none has currently been set. This attribute will create a session if one does not already exist. The lang attribute is rendered with the appropriate language code.

 Creating a session is undesirable for apps that don't support them. Use the lang attribute to achieve the same functionality without creating a session. xhtml false true

Set to true in order to render xml:lang and xmlns attributes on the generated html element. This also causes all other html tags to render as XHTML 1.0 (the <html:xhtml/> tag has a similar purpose).

Struts 1.1 image Render an input tag of type "image" org.apache.struts.taglib.html.ImageTag

Renders an HTML <input> tag of type "image". The base URL for this image is calculated directly based on the value specified in the src or page attributes, or indirectly by looking up a message resource string based on the srcKey or pageKey attributes. You must specify exactly one of these attributes.

If you would like to obtain the coordinates of the mouse click that submitted this request, see the information below on the property attribute.

This tag is only valid when nested inside a form tag body.

 accesskey false true

The keyboard character used to move focus immediately to this element.

 align false true

The alignment option for this image.

 The align attribute is deprecated in HTML 4.x. The suggested alternative is to use CSS. Please see http://www.w3.org/TR/REC-html40/struct/objects.html#h-13.7.4 for more details. alt false true

The alternate text for this image.

 altKey false true

The message resources key of the alternate text for this image.

 border false true

The width (in pixels) of the border around this image.

 bundle false true

The servlet context attribute key for the MessageResources instance to use. If not specified, defaults to the application resources configured for our action servlet.

 disabled false true Set to true if this input field should be disabled. indexed false true Valid only inside of logic:iterate tag. If true then name of the html tag will be rendered as "propertyName[34]". Number in brackets will be generated for every iteration and taken from ancestor logic:iterate tag. locale false true

The session attribute key for the Locale used to select internationalized messages. If not specified, defaults to the Struts standard value.

 onblur false true JavaScript event handler executed when this element loses input focus. onchange false true JavaScript event handler executed when this element loses input focus and its value has changed. onclick false true JavaScript event handler executed when this element receives a mouse click. ondblclick false true JavaScript event handler executed when this element receives a mouse double click. onfocus false true JavaScript event handler executed when this element receives input focus. onkeydown false true JavaScript event handler executed when this element has focus and a key is depressed. onkeypress false true JavaScript event handler executed when this element has focus and a key is depressed and released. onkeyup false true JavaScript event handler executed when this element has focus and a key is released. onmousedown false true JavaScript event handler executed when this element is under the mouse pointer and a mouse button is depressed. onmousemove false true JavaScript event handler executed when this element is under the mouse pointer and the pointer is moved. onmouseout false true JavaScript event handler executed when this element was under the mouse pointer but the pointer was moved outside the element. onmouseover false true JavaScript event handler executed when this element was not under the mouse pointer but the pointer is moved inside the element. onmouseup false true JavaScript event handler executed when this element is under the mouse pointer and a mouse button is released. page false true

The module-relative path of the image for this input tag.

 pageKey false true

The key of the message resources string specifying the module-relative path of the image for this input tag.

 property false true

The property name of this image tag. The parameter names for the request will appear as "property.x" and "property.y", the x and y representing the coordinates of the mouse click for the image. A way of retrieving these values through a form bean is to define getX(), getY(), setX(), and setY() methods, and specify your property as a blank string (property="").

 src false true

The source URL of the image for this input tag.

 srcKey false true

The key of the message resources string specifying the source URL of the image for this input tag.

 style false true CSS styles to be applied to this HTML element. styleClass false true CSS stylesheet class to be applied to this HTML element (renders a "class" attribute). styleId false true Identifier to be assigned to this HTML element (renders an "id" attribute). tabindex false true The tab order (ascending positive integers) for this element. title false true

The advisory title for this element.

 titleKey false true

The message resources key for the advisory title for this element.

 value false true

The value that will be submitted if this image button is pressed.

 img Render an HTML img tag org.apache.struts.taglib.html.ImgTag empty

Renders an HTML <img> element with the image at the specified URL. Like the link tag, URL rewriting will be applied automatically to the value specified in src, page, or action 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.

The base URL for this image is calculated directly based on the value specified in src, page, or action or page, or indirectly by looking up a message resource string based on the srcKey or pageKey attributes. You must specify exactly one of these attributes.

Normally, the src, page, or action 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 src URL -- specify a single parameter with the paramId attribute (at its associated attributes to select the value), or specify the name (and optional property) attributes to select a java.util.Map bean that contains one or more parameter ids and corresponding values.

To specify a single parameter, use the paramId attribute to define the name of the request parameter to be submitted. To specify the corresponding value, use one of the following approaches:

  • Specify only the paramName attribute - The named JSP bean (optionally scoped by the value of the paramScope attribute) must identify a value that can be converted to a String.
  • Specify both the paramName and paramProperty attributes - The specified property getter will be called on the JSP bean identified by the paramName (and optional paramScope) attributes, in order to select a value that can be converted to a String.

If you prefer to specify a java.util.Map that contains all of the request parameters to be added to the hyperlink, use one of the following techniques:

  • Specify only the name attribute - The named JSP bean (optionally scoped by the value of the scope attribute) must identify a java.util.Map containing the parameters.
  • Specify both name and property attributes - The specified property getter method will be called on the bean identified by the name (and optional scope) attributes, in order to return the java.util.Map containing the parameters.

As the Map is processed, the keys are assumed to be the names of query parameters to be appended to the src 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.

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 alt attribute, or indirectly from a message resources bundle, using the bundle and altKey attributes.

 align false true

Where the image is aligned to. Can be one of the following attributes:

  • left - left justify, wrapping text on right
  • right -right justify, wrapping test on left
  • top - aligns the image with the top of the text on the same row
  • middle - aligns the image's vertical center with the text base line
  • bottom - aligns the image with the bottom of the text's base line
  • texttop - aligns the image's top with that of the text font on the same line
  • absmiddle - aligns the image's vertical center with the absolute center of the text
  • absbottom - aligns the image with the absolute bottom of the text font on the same row
 alt false true

And alternative text to be displayed in browsers that don't support graphics. Also used often as type of context help over images.

 altKey false true

The message resources key of the alternate text for this element.

 border false true

The width of the border surrounding the image.

 bundle false true

The servlet context attribute key for the MessageResources instance to use. If not specified, defaults to the application resources configured for our action servlet.

 contextRelative false true Use module attribute instead; will be removed in a release afer 1.2.0.

If set to "true", this "anchors" the image src at the application context rather than the module context when the 'page' attribute is used to specify an image path.

 height false true

The height of the image being displayed. This parameter is very nice to specify (along with width) to help the browser render the page faster.

 hspace false true

The amount of horizontal spacing between the icon and the text. The text may be in the same paragraph, or be wrapped around the image.

 imageName false true

The scriptable name to be defined within this page, so that you can reference it with intra-page scripts. In other words, the value specified here will render a "name" element in the generated image tag.

 ismap false true

The name of the server-side map that this image belongs to.

 locale false true

The name of the request or session Locale attribute used to look up internationalized messages.

 lowsrc false true

An image for people with low resolution graphics cards.

This attribute is not defined in the HTML 4.01 spec and will be removed in a future version of Struts. name false true

The name of a JSP bean that contains a Map representing the query parameters (if property is not specified), or a JSP bean whose property getter is called to return a Map (if property is specified).

 onclick false true JavaScript event handler executed when this element receives a mouse click. ondblclick false true JavaScript event handler executed when this element receives a mouse double click. onkeydown false true

JavaScript event handler that is executed when this element receives a key down event.

 onkeypress false true

JavaScript event handler that is executed when this element receives a key press event.

 onkeyup false true

JavaScript event handler that is executed when this element receives a key up event.

 onmousedown false true JavaScript event handler executed when this element is under the mouse pointer and a mouse button is depressed. onmousemove false true JavaScript event handler executed when this element is under the mouse pointer and the pointer is moved. onmouseout false true JavaScript event handler executed when this element was under the mouse pointer but the pointer was moved outside the element. onmouseover false true JavaScript event handler executed when this element was not under the mouse pointer but the pointer is moved inside the element. onmouseup false true JavaScript event handler executed when this element is under the mouse pointer and a mouse button is released. paramId false true

The name of the request parameter that will be dynamically added to the generated src URL. The corresponding value is defined by the paramName and (optional) paramProperty attributes, optionally scoped by the paramScope attribute

 page false true

The module-relative path, starting with a slash, of the image to be displayed by this tag. The rendered URL for this image will automatically prepend the context path of this web application (in the same manner as the page attribute on the link tag works), in addition to any necessary URL rewriting. You must specify either the page attribute or the src attribute.

 pageKey false true

The message key, in the message resources bundle named by the bundle attribute, of the String to be used as the module-relative path for this image.

 action false true

The action, starting with a slash, that will render the image to be displayed by this tag. The rendered URL for this image will automatically prepend the context path of this web application (in the same manner as the action attribute on the link tag works), in addition to any necessary URL rewriting. You must specify the action, page attribute or the src attribute.

Additionally, you can specify a module prefix for linking to other modules.

 module false true

Prefix name of a Module that contains the action mapping for the Action that is specified by the action attribute. You must specify an action attribute for this to have an effect.

Note: Use "" to map to the default module.

 paramName false true

The name of a JSP bean that is a String containing the value for the request parameter named by paramId (if paramProperty is not specified), or a JSP bean whose property getter is called to return a String (if paramProperty is specified). The JSP bean is constrained to the bean scope specified by the paramScope property, if it is specified.

 paramProperty false true

The name of a property of the bean specified by the paramName attribute, whose return value must be a String containing the value of the request parameter (named by the paramId attribute) that will be dynamically added to this src URL.

 paramScope false true

The scope within which to search for the bean specified by the paramName attribute. If not specified, all scopes are searched.

 property false true

The name of a property of the bean specified by the name attribute, whose return value must be a java.util.Map containing the query parameters to be added to the src URL. You must specify the name attribute if you specify this attribute.

 scope false true

The scope within which to search for the bean specified by the name attribute. If not specified, all scopes are searched.

 src false true

The URL to which this image will be transferred from This image may be dynamically modified by the inclusion of query parameters, as described in the tag description. This value will be used unmodified (other than potential URL rewriting) as the value of the "src" attribute in the rendered tag. You must specify either the page attribute or the src attribute.

 srcKey false true

The message key, in the message resources bundle named by the bundle attribute, of the String to be used as the URL of this image.

 style false true

CSS styles to be applied to this element.

 styleClass false true CSS stylesheet class to be applied to this HTML element (renders a "class" attribute). styleId false true Identifier to be assigned to this HTML element (renders an "id" attribute). title false true

The advisory title for this element.

 titleKey false true

The message resources key for the advisory title for this element.

 useLocalEncoding false true

If set to true, LocalCharacterEncoding will be used, that is, the characterEncoding set to the HttpServletResponse, as prefered character encoding rather than UTF-8, when URLEncoding is done on parameters of the URL.

 usemap false true

The name of the map as defined within this page for mapping hot-spot areas of this image.

 vspace false true

The amount of vertical spacing between the icon and the text, above and below.

 width false true

The width of the image being displayed. This parameter is very nice to specify (along with height) to help the browser render the page faster.

 javascript Render JavaScript validation based on the validation rules loaded by the ValidatorPlugIn. org.apache.struts.taglib.html.JavascriptValidatorTag empty

Render JavaScript validation based on the validation rules loaded by the ValidatorPlugIn. 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.

The dynamicJavascript and staticJavascript attributes default to true, but if dynamicJavascript is set to true and staticJavascript is set to false then only the dynamic JavaScript will be rendered. If dynamicJavascript is set to false and staticJavascript is set to true 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.

cdata false true

If set to "true" and XHTML has been enabled, the JavaScript will be wrapped in a CDATA section to prevent XML parsing. The default is "true" to comply with the W3C's recommendation.

Struts 1.1 dynamicJavascript false false

Whether or not to render the dynamic JavaScript. Defaults to true.

formName false true

The key (form name) to retrieve a specific set of validation rules. If "dynamicJavascript" is set to true and formName is missing or is not recognized by the ValidatorPlugIn, a JspException will be thrown.

method false true

The alternate JavaScript method name to be used instead of the of the default. The default is 'validate' concatenated in front of the key (form name) passed in (ex: validateRegistrationForm).

page false true

The current page of a set of validation rules if the page attribute for the field element in the xml file is in use.

scriptLanguage false true The <script> element will not contain a language attribute when this is set to false. The default is true but this property is ignored in XHTML mode. Struts 1.2 src false true

The src attribute's value when defining the html script element.

staticJavascript false false

Whether or not to render the static JavaScript. Defaults to true.

htmlComment false true

Whether or not to enclose the javascript with HTML comments. This attribute is ignored in XHTML mode because the script would be deleted by the XML parser. See the cdata attribute for details on hiding scripts from XML parsers. Defaults to true.

link Render an HTML anchor or hyperlink org.apache.struts.taglib.html.LinkTag

Renders an HTML <a> 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.

The base URL for this hyperlink is calculated based on which of the following attributes you specify (you must specify exactly one of them):

  • forward - Use the value of this attribute as the name of a global ActionForward to be looked up, and use the module-relative or context-relative URI found there.
  • action - Use the value of this attribute as the name of a Action to be looked up, and use the module-relative or context-relative URI found there.
  • href - Use the value of this attribute unchanged.
  • page - 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.

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 paramId attribute (and its associated attributes to select the value), or specify the name (and optional property) attributes to select a java.util.Map bean that contains one or more parameter ids and corresponding values.

To specify a single parameter, use the paramId attribute to define the name of the request parameter to be submitted. To specify the corresponding value, use one of the following approaches:

  • Specify only the paramName attribute - The named JSP bean (optionally scoped by the value of the paramScope attribute) must identify a value that can be converted to a String.
  • Specify both the paramName and paramProperty attributes - The specified property getter method will be called on the JSP bean identified by the paramName (and optional paramScope) attributes, in order to select a value that can be converted to a String.

If you prefer to specify a java.util.Map that contains all of the request parameters to be ad