META-INF.tld.struts-html.tld Maven / Gradle / Ivy
if this input field should be disabled. ]]>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
]]>JspExceptionat 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 keyorg.apache.struts.action.EXCEPTION.1.4 html http://struts.apache.org/tags-html Render an HTML <base>ElementRenders an HTML
<base>element with anhrefattribute 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).
]]>base org.apache.struts.taglib.html.BaseTag empty The window target for this base reference. ]]> target false true java.lang.String The server name to use instead of request.getServerName(). ]]> server false true java.lang.String The reference from which the base uri will created. Possible values are:
page- The base uri will be the jsp page location. (default)site- The base uri will be the application context path.]]>
- Since:
- Struts 1.3
ref false true java.lang.String Render A Button Input Field 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
]]><html:image>tag is more appropriate.button org.apache.struts.taglib.html.ButtonTag JSP The keyboard character used to move focus immediately to this element. ]]> accesskey false true java.lang.String The alternate text for this element. ]]> alt false true java.lang.String The message resources key of the alternate text for this element. ]]> altKey false true java.lang.String The servlet context attributes key for the MessageResources instance to use. If not specified, defaults to the application resources configured for our action servlet. ]]>
- Since:
- Struts 1.2.5
bundle false true java.lang.String The direction for weak/neutral text for this element. ]]>
- Since:
- Struts 1.3.6
dir false true java.lang.String Set to trueif this input field should be disabled. ]]>disabled false true boolean Valid only inside of logic:iteratetag. Iftruethen 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. ]]>indexed false true boolean The language code for this element. ]]>
- Since:
- Struts 1.3.6
lang false true java.lang.String onblur false true java.lang.String onchange false true java.lang.String onclick false true java.lang.String ondblclick false true java.lang.String onfocus false true java.lang.String onkeydown false true java.lang.String onkeypress false true java.lang.String onkeyup false true java.lang.String onmousedown false true java.lang.String onmousemove false true java.lang.String onmouseout false true java.lang.String onmouseover false true java.lang.String onmouseup false true java.lang.String property true true java.lang.String style false true java.lang.String styleClass false true java.lang.String styleId false true java.lang.String tabindex false true java.lang.String The advisory title for this element. ]]> title false true java.lang.String The message resources key for the advisory title for this element. ]]> titleKey false true java.lang.String value false true java.lang.String Render a Cancel Button 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.
]]>cancel org.apache.struts.taglib.html.CancelTag JSP accesskey false true java.lang.String The alternate text for this element. ]]> alt false true java.lang.String The message resources key of the alternate text for this element. ]]> altKey false true java.lang.String Since: Struts 1.2.5 ]]>bundle false true java.lang.String The direction for weak/neutral text for this element. ]]>
- Since:
- Struts 1.3.6
dir false true java.lang.String true disabled false true boolean The language code for this element. ]]>
- Since:
- Struts 1.3.6
lang false true java.lang.String onblur false true java.lang.String onchange false true java.lang.String onclick false true java.lang.String ondblclick false true java.lang.String onfocus false true java.lang.String onkeydown false true java.lang.String onkeypress false true java.lang.String onkeyup false true java.lang.String onmousedown false true java.lang.String onmousemove false true java.lang.String onmouseout false true java.lang.String onmouseover false true java.lang.String onmouseup false true java.lang.String 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. ]]>property false true java.lang.String style false true java.lang.String styleClass false true java.lang.String styleId false true java.lang.String tabindex false true java.lang.String The advisory title for this element. ]]> title false true java.lang.String The message resources key for the advisory title for this element. ]]> titleKey false true java.lang.String value false true java.lang.String Render A Checkbox Input Field 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 anyvalueyou 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 themultiboxtag.WARNING: In order to correctly recognize unchecked checkboxes, the
]]>ActionFormbean associated with this form must include a statement setting the corresponding boolean property tofalsein thereset()method.checkbox org.apache.struts.taglib.html.CheckboxTag JSP accesskey false true java.lang.String The alternate text for this element. ]]> alt false true java.lang.String The message resources key of the alternate text for this element. ]]> altKey false true java.lang.String Since: Struts 1.2.5 ]]>bundle false true java.lang.String The direction for weak/neutral text for this element. ]]>
- Since:
- Struts 1.3.6
dir false true java.lang.String true if this input field should be disabled. ]]> disabled false true boolean Name of the bean (in any scope) under which our error messages have been stored. If not present, the name specified by the Globals.ERROR_KEYconstant string will be used.N.B. This is used in conjunction with the
errorStyle,errorStyleClassanderrorStyleIdattributes and should be set to the same value as thenameattribute on the <html:errors/> tag.]]>
- Since:
- Struts 1.2.5
errorKey false true java.lang.String CSS styles to be applied to this HTML element if an error exists for it. N.B. If present, this overrides the
styleattribute in the event of an error.]]>
- Since:
- Struts 1.2.5
errorStyle false true java.lang.String CSS stylesheet class to be applied to this HTML element if an error exists for it (renders a "class" attribute). N.B. If present, this overrides the
styleClassattribute in the event of an error.]]>
- Since:
- Struts 1.2.5
errorStyleClass false true java.lang.String Identifier to be assigned to this HTML element if an error exists for it (renders an "id" attribute). N.B. If present, this overrides the
styleIdattribute in the event of an error.]]>
- Since:
- Struts 1.2.5
errorStyleId false true java.lang.String logic:iterate tag. If truethen 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. ]]>indexed false true boolean The language code for this element. ]]>
- Since:
- Struts 1.3.6
lang false true java.lang.String name false true java.lang.String onblur false true java.lang.String onchange false true java.lang.String onclick false true java.lang.String ondblclick false true java.lang.String onfocus false true java.lang.String onkeydown false true java.lang.String onkeypress false true java.lang.String onkeyup false true java.lang.String onmousedown false true java.lang.String onmousemove false true java.lang.String onmouseout false true java.lang.String onmouseover false true java.lang.String onmouseup false true java.lang.String property true true java.lang.String CSS styles to be applied to this HTML element. N.B. If present, the
]]>errorStyleoverrides this attribute in the event of an error for the element.style false true java.lang.String CSS stylesheet class to be applied to this HTML element (renders a "class" attribute). N.B. If present, the
]]>errorStyleClassoverrides this attribute in the event of an error for the element.styleClass false true java.lang.String Identifier to be assigned to this HTML element (renders an "id" attribute). N.B. If present, the
]]>errorStyleIdoverrides this attribute in the event of an error for the element.styleId false true java.lang.String tabindex false true java.lang.String The advisory title for this element. ]]> title false true java.lang.String The message resources key for the advisory title for this element. ]]> titleKey false true java.lang.String value false true java.lang.String Conditionally display a set of accumulated error messages. Displays a set of error messages prepared by a business logic component and stored as an
ActionMessagesobject, anActionErrorsobject, a String, or a String array in any 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
MessageResourcesbean under the default attribute name, with optional definitions of message keys specified in the following attributes:
- 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 (default "errors.header").- 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 (default "errors.footer").- prefix - Text that will be rendered before each individual error in the list (default "errors.prefix").
- suffix - Text that will be rendered after each individual error in the list (default "errors.suffix").
See the
]]>messagestag for an alternative to this tag that does not rely on HTML in yourMessageResources.errors org.apache.struts.taglib.html.ErrorsTag empty bundle false true java.lang.String Since: Struts 1.2.5 ]]>footer false true java.lang.String Since: Struts 1.2.5 ]]>header false true java.lang.String locale false true java.lang.String Globals.ERROR_KEY constant string will be used. ]]> name false true java.lang.String Since: Struts 1.2.5 ]]>prefix false true java.lang.String property false true java.lang.String Since: Struts 1.2.5 ]]>suffix false true java.lang.String Render A File Select Input Field 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
methodattribute, and "multipart/form-data" for theenctypeattribute. For example:<html:form method="POST" enctype="multipart/form-data"> <html:file property="theFile" /> </html:form>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.
]]>file org.apache.struts.taglib.html.FileTag JSP accesskey false true java.lang.String accept false true java.lang.String The alternate text for this element. ]]> alt false true java.lang.String The message resources key of the alternate text for this element. ]]> altKey false true java.lang.String Since: Struts 1.2.5 ]]>bundle false true java.lang.String The direction for weak/neutral text for this element. ]]>
- Since:
- Struts 1.3.6
dir false true java.lang.String true if this input field should be disabled. ]]> disabled false true boolean Name of the bean (in any scope) under which our error messages have been stored. If not present, the name specified by the Globals.ERROR_KEYconstant string will be used.N.B. This is used in conjunction with the
errorStyle,errorStyleClassanderrorStyleIdattributes and should be set to the same value as thenameattribute on the <html:errors/> tag.]]>
- Since:
- Struts 1.2.5
errorKey false true java.lang.String CSS styles to be applied to this HTML element if an error exists for it. N.B. If present, this overrides the
styleattribute in the event of an error.]]>
- Since:
- Struts 1.2.5
errorStyle false true java.lang.String CSS stylesheet class to be applied to this HTML element if an error exists for it (renders a "class" attribute). N.B. If present, this overrides the
styleClassattribute in the event of an error.]]>
- Since:
- Struts 1.2.5
errorStyleClass false true java.lang.String Identifier to be assigned to this HTML element if an error exists for it (renders an "id" attribute). N.B. If present, this overrides the
styleIdattribute in the event of an error.]]>
- Since:
- Struts 1.2.5
errorStyleId false true java.lang.String logic:iterate tag. If truethen 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. ]]>indexed false true boolean The language code for this element. ]]>
- Since:
- Struts 1.3.6
lang false true java.lang.String maxlength false true java.lang.String name false true java.lang.String onblur false true java.lang.String onchange false true java.lang.String onclick false true java.lang.String ondblclick false true java.lang.String onfocus false true java.lang.String onkeydown false true java.lang.String onkeypress false true java.lang.String onkeyup false true java.lang.String onmousedown false true java.lang.String onmousemove false true java.lang.String onmouseout false true java.lang.String onmouseover false true java.lang.String onmouseup false true java.lang.String property true true java.lang.String size false true java.lang.String CSS styles to be applied to this HTML element. N.B. If present, the
]]>errorStyleoverrides this attribute in the event of an error for the element.style false true java.lang.String CSS stylesheet class to be applied to this HTML element (renders a "class" attribute). N.B. If present, the
]]>errorStyleClassoverrides this attribute in the event of an error for the element.styleClass false true java.lang.String Identifier to be assigned to this HTML element (renders an "id" attribute). N.B. If present, the
]]>errorStyleIdoverrides this attribute in the event of an error for the element.styleId false true java.lang.String tabindex false true java.lang.String The advisory title for this element. ]]> title false true java.lang.String The message resources key for the advisory title for this element. ]]> titleKey false true java.lang.String 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] ]]> value false true java.lang.String Define An Input Form 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.form org.apache.struts.taglib.html.FormTag JSP 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 a value is not provided, the original URI (servletPath) for the request is used. If you are using extension mapping for selecting the controller servlet, this value should be equal to the
pathattribute 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
]]>pathattribute of the corresponding<action>element.action false true java.lang.String Since: Struts 1.2.2 ]]>acceptCharset false true java.lang.String The direction for weak/neutral text for this element. ]]>
- Since:
- Struts 1.3.6
dir false true java.lang.String true if the Form's input fields should be disabled. ]]>
- Since:
- Struts 1.2.7
disabled false true boolean enctype false true java.lang.String focus false true java.lang.String Since: Struts 1.1 ]]>focusIndex false true java.lang.String The language code for this element. ]]>
- Since:
- Struts 1.3.6
lang false true java.lang.String method false true java.lang.String onreset false true java.lang.String onsubmit false true java.lang.String true if the Form's input fields should be read only. ]]>
- Since:
- Struts 1.2.7
readonly false true boolean Since: Struts 1.2 ]]>scriptLanguage false true boolean style false true java.lang.String styleClass false true java.lang.String styleId false true java.lang.String target false true java.lang.String Render an HTML frame element Renders an HTML
<frame>element with processing for thesrcattribute that is identical to that performed by the<html:link>tag for thehrefattribute. 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
ActionForwardto 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
paramIdattribute (and its associated attributes to select the value), or specify thename(and optionalproperty) attributes to select ajava.util.Mapbean that contains one or more parameter ids and corresponding values.To specify a single parameter, use the
paramIdattribute 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
paramNameattribute - The named JSP bean (optionally scoped by the value of theparamScopeattribute) must identify a value that can be converted to a String.- Specify both the
paramNameandparamPropertyattributes - The specified property getter method will be called on the JSP bean identified by theparamName(and optionalparamScope) attributes, in order to select a value that can be converted to a String.If you prefer to specify a
java.util.Mapthat contains all of the request parameters to be added to the hyperlink, use one of the following techniques:
- Specify only the
nameattribute - The named JSP bean (optionally scoped by the value of thescopeattribute) must identify ajava.util.Mapcontaining the parameters.- Specify both
nameandpropertyattributes - The specified property getter method will be called on the bean identified by thename(and optionalscope) attributes, in order to return thejava.util.Mapcontaining the parameters.As the
Mapis 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
]]>transactionattribute totrue. 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 theanchorattribute.frame org.apache.struts.taglib.html.FrameTag JSP Since: Struts 1.2.5 ]]>bundle false true java.lang.String Logical name of a global Actionthat 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 theactionattribute, theforwardattribute, thehrefattribute, or thepageattribute.Additionally, you can specify a
]]>moduleprefix for linking to other modules.action false true java.lang.String Prefix name of a Modulethat contains the action mapping for theActionthat is specified by theactionattribute. You must specify anactionattribute for this to have an effect.Note: Use "" to map to the default module.
]]>module false true java.lang.String Optional anchor tag ("#xxx") to be added to the generated hyperlink. Specify this value without any "#" character. ]]> anchor false true java.lang.String Logical name of a global ActionForwardthat 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 theactionattribute, theforwardattribute, thehrefattribute, or thepageattribute. ]]>forward false true java.lang.String Should a frame border be generated around this frame (1) or not (0)? ]]> frameborder false true java.lang.String Value for the nameattribute of the rendered<frame>element. ]]>frameName false true java.lang.String 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 actionattribute, theforwardattribute, thehrefattribute, or thepageattribute. ]]>href false true java.lang.String URI of a long description of the frame. This description should supplement the short description provided by the titleattribute, and may be particularly useful for non-visual user agents. ]]>longdesc false true java.lang.String The amount of space (in pixels) to be left between the frame's contents and its top and bottom margins. ]]> marginheight false true java.lang.Integer The amount of space (in pixels) to be left between the frame's contents and its left and right margins. ]]> marginwidth false true java.lang.Integer The name of a JSP bean that contains a Maprepresenting the query parameters (ifpropertyis not specified), or a JSP bean whose property getter is called to return aMap(ifpropertyis specified). ]]>name false true java.lang.String Should users be disallowed from resizing the frame? (true, false). ]]> noresize false true boolean 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 actionattribute, theforwardattribute, thehrefattribute, or thepageattribute. ]]>page false true java.lang.String The name of the request parameter that will be dynamically added to the generated hyperlink. The corresponding value is defined by the paramNameand (optional)paramPropertyattributes, optionally scoped by theparamScopeattribute ]]>paramId false true java.lang.String The name of a JSP bean that is a String containing the value for the request parameter named by paramId(ifparamPropertyis not specified), or a JSP bean whose property getter is called to return a String (ifparamPropertyis specified). The JSP bean is constrained to the bean scope specified by theparamScopeproperty, if it is specified. ]]>paramName false true java.lang.String The name of a property of the bean specified by the paramNameattribute, whose return value must be a String containing the value of the request parameter (named by theparamIdattribute) that will be dynamically added to this hyperlink. ]]>paramProperty false true java.lang.String The scope within which to search for the bean specified by the paramNameattribute. If not specified, all scopes are searched. ]]>paramScope false true java.lang.String The name of a property of the bean specified by the nameattribute, whose return value must be ajava.util.Mapcontaining the query parameters to be added to the hyperlink. You must specify thenameattribute if you specify this attribute. ]]>property false true java.lang.String The scope within which to search for the bean specified by the nameattribute. If not specified, all scopes are searched. ]]>scope false true java.lang.String Should scroll bars be created unconditionally (yes), never (no), or only when needed (auto)? ]]> scrolling false true java.lang.String CSS styles to be applied to this element. ]]> style false true java.lang.String styleClass false true java.lang.String styleId false true java.lang.String The advisory title for this element. ]]> title false true java.lang.String The message resources key for the advisory title for this element. ]]> titleKey false true java.lang.String If set to true, any current transaction control token will be included in the generated hyperlink, so that it will pass anisTokenValid()test in the receiving Action. ]]>transaction false true boolean Render A Hidden Field 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.
]]>hidden org.apache.struts.taglib.html.HiddenTag empty accesskey false true java.lang.String The alternate text for this element. ]]> alt false true java.lang.String The message resources key of the alternate text for this element. ]]> altKey false true java.lang.String Since: Struts 1.2.5 ]]>bundle false true java.lang.String The direction for weak/neutral text for this element. ]]>
- Since:
- Struts 1.3.6
dir false true java.lang.String true if this input field should be disabled. ]]> disabled false true boolean logic:iterate tag. If truethen 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. ]]>indexed false true boolean The language code for this element. ]]>
- Since:
- Struts 1.3.6
lang false true java.lang.String name false true java.lang.String onblur false true java.lang.String onchange false true java.lang.String onclick false true java.lang.String ondblclick false true java.lang.String onfocus false true java.lang.String onkeydown false true java.lang.String onkeypress false true java.lang.String onkeyup false true java.lang.String onmousedown false true java.lang.String onmousemove false true java.lang.String onmouseout false true java.lang.String onmouseover false true java.lang.String onmouseup false true java.lang.String property true true java.lang.String style false true java.lang.String styleClass false true java.lang.String styleId false true java.lang.String The advisory title for this element. ]]> title false true java.lang.String The message resources key for the advisory title for this element. ]]> titleKey false true java.lang.String value false true java.lang.String write false true boolean Render an HTML <html>ElementRenders an HTML
]]><html>element with language attributes extracted from the user's current Locale object, if there is one.html org.apache.struts.taglib.html.HtmlTag JSP Accept-Language HTTP header is used. If still not found, the default language for the server is used. ]]>
- Since:
- Struts 1.2
lang false true boolean Set to truein order to renderxml:langandxmlnsattributes on the generatedhtmlelement. This also causes all other html tags to render as XHTML 1.0 (the <html:xhtml/> tag has a similar purpose).]]>
- Since:
- Struts 1.1
xhtml false true boolean Sets the version of XHTML to render in the String form MAJOR.MINOR. The default is "1.0" when not specified. ]]>
- Since:
- Struts 1.4
xhtmlVersion false true java.lang.String Render an input tag of type "image" Renders an HTML
<input>tag of type "image". The base URL for this image is calculated directly based on the value specified in thesrcorpageattributes, or indirectly by looking up a message resource string based on thesrcKeyorpageKeyattributes. 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
propertyattribute.This tag is only valid when nested inside a form tag body.
]]>image org.apache.struts.taglib.html.ImageTag JSP The keyboard character used to move focus immediately to this element. ]]> accesskey false true java.lang.String The alignment option for this image. ]]> align false true java.lang.String The alternate text for this image. ]]> alt false true java.lang.String The message resources key of the alternate text for this image. ]]> altKey false true java.lang.String The width (in pixels) of the border around this image. ]]> border false true java.lang.String The servlet context attribute key for the MessageResources instance to use. If not specified, defaults to the application resources configured for our action servlet. ]]> bundle false true java.lang.String The direction for weak/neutral text for this element. ]]>
- Since:
- Struts 1.3.6
dir false true java.lang.String true if this input field should be disabled. ]]> disabled false true boolean 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. ]]> indexed false true boolean The language code for this element. ]]>
- Since:
- Struts 1.3.6
lang false true java.lang.String The session attribute key for the Locale used to select internationalized messages. If not specified, defaults to the Struts standard value. ]]> locale false true java.lang.String Prefix name of a Modulethat thepageorpageKeyattributes relate to. ]]>module false true java.lang.String onblur false true java.lang.String onchange false true java.lang.String onclick false true java.lang.String ondblclick false true java.lang.String onfocus false true java.lang.String onkeydown false true java.lang.String onkeypress false true java.lang.String onkeyup false true java.lang.String onmousedown false true java.lang.String onmousemove false true java.lang.String onmouseout false true java.lang.String onmouseover false true java.lang.String onmouseup false true java.lang.String The module-relative path of the image for this input tag. ]]> page false true java.lang.String The key of the message resources string specifying the module-relative path of the image for this input tag. ]]> pageKey false true java.lang.String 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=""). ]]> property false true java.lang.String The source URL of the image for this input tag. ]]> src false true java.lang.String The key of the message resources string specifying the source URL of the image for this input tag. ]]> srcKey false true java.lang.String style false true java.lang.String styleClass false true java.lang.String styleId false true java.lang.String tabindex false true java.lang.String The advisory title for this element. ]]> title false true java.lang.String The message resources key for the advisory title for this element. ]]> titleKey false true java.lang.String The value that will be submitted if this image button is pressed. ]]> value false true java.lang.String Render an HTML img tag 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 insrc,page, oractionto 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, oractionorpage, or indirectly by looking up a message resource string based on thesrcKeyorpageKeyattributes. You must specify exactly one of these attributes.Normally, the
src,page, oractionthat 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 thesrcURL -- specify a single parameter with theparamIdattribute (at its associated attributes to select the value), or specify thename(and optionalproperty) attributes to select ajava.util.Mapbean that contains one or more parameter ids and corresponding values.To specify a single parameter, use the
paramIdattribute 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
paramNameattribute - The named JSP bean (optionally scoped by the value of theparamScopeattribute) must identify a value that can be converted to a String.- Specify both the
paramNameandparamPropertyattributes - The specified property getter will be called on the JSP bean identified by theparamName(and optionalparamScope) attributes, in order to select a value that can be converted to a String.If you prefer to specify a
java.util.Mapthat contains all of the request parameters to be added to the hyperlink, use one of the following techniques:
- Specify only the
nameattribute - The named JSP bean (optionally scoped by the value of thescopeattribute) must identify ajava.util.Mapcontaining the parameters.- Specify both
nameandpropertyattributes - The specified property getter method will be called on the bean identified by thename(and optionalscope) attributes, in order to return thejava.util.Mapcontaining the parameters.As the
Mapis processed, the keys are assumed to be the names of query parameters to be appended to thesrcURL. 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
]]>altattribute, or indirectly from a message resources bundle, using thebundleandaltKeyattributes.img org.apache.struts.taglib.html.ImgTag empty 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
align false true java.lang.String And alternative text to be displayed in browsers that don't support graphics. Also used often as type of context help over images. ]]> alt false true java.lang.String The message resources key of the alternate text for this element. ]]> altKey false true java.lang.String The width of the border surrounding the image. ]]> border false true java.lang.String The servlet context attribute key for the MessageResources instance to use. If not specified, defaults to the application resources configured for our action servlet. ]]> bundle false true java.lang.String The direction for weak/neutral text for this element. ]]>
- Since:
- Struts 1.3.6
dir false true java.lang.String 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. ]]>height false true java.lang.String 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. ]]> hspace false true java.lang.String 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. ]]> imageName false true java.lang.String The name of the server-side map that this image belongs to. ]]> ismap false true java.lang.String The language code for this element. ]]>
- Since:
- Struts 1.3.6
lang false true java.lang.String The name of the request or session Locale attribute used to look up internationalized messages. ]]> locale false true java.lang.String The name of a JSP bean that contains a Maprepresenting the query parameters (ifpropertyis not specified), or a JSP bean whose property getter is called to return aMap(ifpropertyis specified). ]]>name false true java.lang.String onclick false true java.lang.String ondblclick false true java.lang.String JavaScript event handler that is executed when this element receives a key down event. ]]> onkeydown false true java.lang.String JavaScript event handler that is executed when this element receives a key press event. ]]> onkeypress false true java.lang.String JavaScript event handler that is executed when this element receives a key up event. ]]> onkeyup false true java.lang.String onmousedown false true java.lang.String onmousemove false true java.lang.String onmouseout false true java.lang.String onmouseover false true java.lang.String onmouseup false true java.lang.String The name of the request parameter that will be dynamically added to the generated src URL. The corresponding value is defined by the paramNameand (optional)paramPropertyattributes, optionally scoped by theparamScopeattribute ]]>paramId false true java.lang.String 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 pageattribute on the link tag works), in addition to any necessary URL rewriting. You must specify either thepageattribute or thesrcattribute. ]]>page false true java.lang.String The message key, in the message resources bundle named by the bundleattribute, of the String to be used as the module-relative path for this image. ]]>pageKey false true java.lang.String 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 actionattribute on the link tag works), in addition to any necessary URL rewriting. You must specify theaction,pageattribute or thesrcattribute.Additionally, you can specify a
]]>moduleprefix for linking to other modules.action false true java.lang.String Prefix name of a Modulethat contains the action mapping for theActionthat is specified by theactionattribute. You must specify anactionattribute for this to have an effect.Note: Use "" to map to the default module.
]]>module false true java.lang.String The name of a JSP bean that is a String containing the value for the request parameter named by paramId(ifparamPropertyis not specified), or a JSP bean whose property getter is called to return a String (ifparamPropertyis specified). The JSP bean is constrained to the bean scope specified by theparamScopeproperty, if it is specified. ]]>paramName false true java.lang.String The name of a property of the bean specified by the paramNameattribute, whose return value must be a String containing the value of the request parameter (named by theparamIdattribute) that will be dynamically added to this src URL. ]]>paramProperty false true java.lang.String The scope within which to search for the bean specified by the paramNameattribute. If not specified, all scopes are searched. ]]>paramScope false true java.lang.String The name of a property of the bean specified by the nameattribute, whose return value must be ajava.util.Mapcontaining the query parameters to be added to the src URL. You must specify thenameattribute if you specify this attribute. ]]>property false true java.lang.String The scope within which to search for the bean specified by the nameattribute. If not specified, all scopes are searched. ]]>scope false true java.lang.String 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 pageattribute or thesrcattribute. ]]>src false true java.lang.String The message key, in the message resources bundle named by the bundleattribute, of the String to be used as the URL of this image. ]]>srcKey false true java.lang.String CSS styles to be applied to this element. ]]> style false true java.lang.String styleClass false true java.lang.String styleId false true java.lang.String The advisory title for this element. ]]> title false true java.lang.String The message resources key for the advisory title for this element. ]]> titleKey false true java.lang.String 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. ]]>useLocalEncoding false true boolean The name of the map as defined within this page for mapping hot-spot areas of this image. ]]> usemap false true java.lang.String The amount of vertical spacing between the icon and the text, above and below. ]]> vspace false true java.lang.String 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. ]]>width false true java.lang.String Render JavaScript validation based on the validation rules loaded by the ValidatorPlugIn. 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
]]>trueand staticJavascript is set tofalsethen only the dynamic JavaScript will be rendered. If dynamicJavascript is set tofalseand staticJavascript is set totruethen only the static JavaScript will be rendered which can then be put in separate JSP page so the browser can cache the static JavaScript.javascript org.apache.struts.taglib.html.JavascriptValidatorTag empty 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. ]]>
- Since:
- Struts 1.1
cdata false true java.lang.String Whether or not to render the dynamic JavaScript. Defaults to true. ]]>dynamicJavascript false true java.lang.String The key (form name) to retrieve a specific set of validation rules. If "dynamicJavascript" is set to trueand formName is missing or is not recognized by theValidatorPlugIn, a JspException will be thrown. ]]>formName false true java.lang.String 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). ]]> method false true java.lang.String The current page of a set of validation rules if the page attribute for the field element in the xml file is in use. ]]> page false true int Since: Struts 1.2 ]]>scriptLanguage false true boolean The src attribute's value when defining the html script element. ]]> src false true java.lang.String Whether or not to render the static JavaScript. Defaults to true. ]]>staticJavascript false true java.lang.String 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. ]]>htmlComment false true java.lang.String Since: Struts 1.2.7 ]]>bundle false true java.lang.String Render a Label ]]> label org.apache.struts.taglib.html.LabelTag JSP The keyboard character used to move focus immediately to this element. ]]> accesskey false true java.lang.String bundle false true java.lang.String The direction for weak/neutral text for this element. ]]> dir false true java.lang.String CSS styles to be applied to this HTML element if an error exists for it. N.B. If present, this overrides the
]]>styleattribute in the event of an error.errorStyle false true java.lang.String CSS stylesheet class to be applied to this HTML element if an error exists for it (renders a "class" attribute). N.B. If present, this overrides the
]]>styleClassattribute in the event of an error.errorStyleClass false true java.lang.String Identifier to be assigned to this HTML element if an error exists for it (renders an "id" attribute). N.B. If present, this overrides the
]]>styleIdattribute in the event of an error.errorStyleId false true java.lang.String Identifier to be attached to this label (renders a "for" attribute) when the identifier is different than the property name. ]]> forId false true java.lang.String bundle for the value displayed to the user for this label. If not specified, the value to be displayed is taken from the body content of this tag. ]]> key false true java.lang.String The language code for this element. ]]>
- Since:
- Struts 1.3.6
lang false true java.lang.String name false true java.lang.String onblur false true java.lang.String onclick false true java.lang.String ondblclick false true java.lang.String onfocus false true java.lang.String onkeydown false true java.lang.String onkeypress false true java.lang.String onkeyup false true java.lang.String onmousedown false true java.lang.String onmousemove false true java.lang.String onmouseout false true java.lang.String onmouseover false true java.lang.String onmouseup false true java.lang.String property true true java.lang.String Specifies that this label represents a required field. ]]> required false true boolean CSS styles to be applied to this HTML element. N.B. If present, the
]]>errorStyleoverrides this attribute in the event of an error for the element.style false true java.lang.String CSS stylesheet class to be applied to this HTML element (renders a "class" attribute). N.B. If present, the
]]>errorStyleClassoverrides this attribute in the event of an error for the element.styleClass false true java.lang.String Identifier to be assigned to this HTML element (renders an "id" attribute). N.B. If present, the
]]>errorStyleIdoverrides this attribute in the event of an error for the element.styleId false true java.lang.String The advisory title for this element. ]]> title false true java.lang.String The message resources key for the advisory title for this element. ]]> titleKey false true java.lang.String Render an HTML anchor or hyperlink 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
ActionForwardto 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.- action - Use the value of this attribute as the name of a
Actionto 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 three ways you can append one or more dynamically defined query parameters to the hyperlink -- specify a single parameter with the
paramIdattribute (and its associated attributes to select the value), or specify thename(and optionalproperty) attributes to select ajava.util.Mapbean that contains one or more parameter ids and corresponding values, or nest one or more <html:param> tags in the tag body.To specify a single parameter, use the
paramIdattribute 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
paramNameattribute - The named JSP bean (optionally scoped by the value of theparamScopeattribute) must identify a value that can be converted to a String.- Specify both the
paramNameandparamPropertyattributes - The specified property getter method will be called on the JSP bean identified by theparamName(and optionalparamScope) attributes, in order to select a value that can be converted to a String.If you prefer to specify a
java.util.Mapthat contains all of the request parameters to be added to the hyperlink, use one of the following techniques:
- Specify only the
nameattribute - The named JSP bean (optionally scoped by the value of thescopeattribute) must identify ajava.util.Mapcontaining the parameters.- Specify both
nameandpropertyattributes - The specified property getter method will be called on the bean identified by thename(and optionalscope) attributes, in order to return thejava.util.Mapcontaining the parameters.As the
Mapis 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.Supplmenting these two methods, you can nest one or more <html:param> tags to dynamically add parameters in a logic-friendly way (such as executing a for loop that assigns the name/value pairs at runtime). This method does not compete with the aforementioned; it will adds its parameters in addition to whatever parameters are already specified.
Additionally, you can request that the current transaction control token, if any, be included in the generated hyperlink by setting the
]]>transactionattribute totrue. 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 theanchorattribute.link org.apache.struts.taglib.html.LinkTag JSP The keyboard character used to move focus immediately to this element. ]]> accesskey false true java.lang.String Logical name of a Actionthat 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 theactionattribute, theforwardattribute, thehrefattribute, thelinkNameattribute, or thepageattribute.Additionally, you can specify a
]]>moduleprefix for linking to other modules.action false true java.lang.String Prefix name of a Modulethat contains the action mapping for theActionthat is specified by theactionattribute. You must specify anactionattribute for this to have an effect.Note: Use "" to map to the default module.
]]>module false true java.lang.String Optional anchor tag ("#xxx") to be added to the generated hyperlink. Specify this value without any "#" character. Exactly one of forward,href, orpageattribute must still be specified with the anchor. ]]>anchor false true java.lang.String The direction for weak/neutral text for this element. ]]>
- Since:
- Struts 1.3.6
dir false true java.lang.String Logical name of a global ActionForwardthat 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 theactionattribute, theforwardattribute, thehrefattribute, thelinkNameattribute, or thepageattribute. ]]>forward false true java.lang.String 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 actionattribute, theforwardattribute, thehrefattribute, thelinkNameattribute, or thepageattribute. ]]>href false true java.lang.String true then indexed parameter with name from indexId attribute will be added to the query string. Indexed parameter looks like "index[32]". Number in brackets will be generated for every iteration and taken from ancestor logic:iterate tag. ]]> indexed false true boolean indexId false true java.lang.String Since: Struts 1.2.5 ]]>bundle false true java.lang.String The language code for this element. ]]>
- Since:
- Struts 1.3.6
lang false true java.lang.String The anchor name to be defined within this page, so that you can reference it with intra-page hyperlinks. In other words, the value specified here will render a "name" element in the generated anchor tag. ]]> linkName false true java.lang.String The name of a JSP bean that contains a Maprepresenting the query parameters (ifpropertyis not specified), or a JSP bean whose property getter is called to return aMap(ifpropertyis specified). ]]>name false true java.lang.String JavaScript event handler that is executed when this element loses input focus. ]]> onblur false true java.lang.String JavaScript event handler that is executed when this element receives a mouse click. ]]> onclick false true java.lang.String JavaScript event handler that is executed when this element receives a mouse double click. ]]> ondblclick false true java.lang.String JavaScript event handler that is executed when this element receives input focus. ]]> onfocus false true java.lang.String JavaScript event handler that is executed when this element receives a key down event. ]]> onkeydown false true java.lang.String JavaScript event handler that is executed when this element receives a key press event. ]]> onkeypress false true java.lang.String JavaScript event handler that is executed when this element receives a key up event. ]]> onkeyup false true java.lang.String JavaScript event handler that is executed when this element receives a mouse down event. ]]> onmousedown false true java.lang.String JavaScript event handler that is executed when this element receives a mouse move event. ]]> onmousemove false true java.lang.String JavaScript event handler that is executed when this element receives a mouse out event. ]]> onmouseout false true java.lang.String JavaScript event handler that is executed when this element receives a mouse over event. ]]> onmouseover false true java.lang.String JavaScript event handler that is executed when this element receives a mouse up event. ]]> onmouseup false true java.lang.String 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 actionattribute,forwardattribute, thehrefattribute, thelinkNameattribute, or thepageattribute. ]]>page false true java.lang.String The name of the request parameter that will be dynamically added to the generated hyperlink. The corresponding value is defined by the paramNameand (optional)paramPropertyattributes, optionally scoped by theparamScopeattribute ]]>paramId false true java.lang.String The name of a JSP bean that is a String containing the value for the request parameter named by paramId(ifparamPropertyis not specified), or a JSP bean whose property getter is called to return a String (ifparamPropertyis specified). The JSP bean is constrained to the bean scope specified by theparamScopeproperty, if it is specified. ]]>paramName false true java.lang.String The name of a property of the bean specified by the paramNameattribute, whose return value must be a String containing the value of the request parameter (named by theparamIdattribute) that will be dynamically added to this hyperlink. ]]>paramProperty false true java.lang.String The scope within which to search for the bean specified by the paramNameattribute. If not specified, all scopes are searched. ]]>paramScope false true java.lang.String The name of a property of the bean specified by the nameattribute, whose return value must be ajava.util.Mapcontaining the query parameters to be added to the hyperlink. You must specify thenameattribute if you specify this attribute. ]]>property false true java.lang.String The scope within which to search for the bean specified by the nameattribute. If not specified, all scopes are searched. ]]>scope false true java.lang.String CSS styles to be applied to this element. ]]> style false true java.lang.String styleClass false true java.lang.String styleId false true java.lang.String The tab order (ascending positive integers) for this element. ]]> tabindex false true java.lang.String The window target in which the resource requested by this hyperlink will be displayed, for example in a framed presentation. ]]> target false true java.lang.String The advisory title for this hyperlink. ]]> title false true java.lang.String The message resources key for the advisory title for this element. ]]> titleKey false true java.lang.String If set to true, any current transaction control token will be included in the generated hyperlink, so that it will pass anisTokenValid()test in the receiving Action. ]]>transaction false true boolean 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. ]]>useLocalEncoding false true boolean Adds a parameter to the following tags:
- <html:frame>
- <html:link>
- <html:rewrite>
]]>
- Since:
- Struts 1.3.6
param org.apache.struts.taglib.html.ParamTag JSP The String containing the name of the request parameter. ]]> name true true java.lang.String The value of the request parameter specified by the nameattribute, whose return value must be a String or String[] that will be dynamically added to this hyperlink. ]]>value false true java.lang.String Conditionally display a set of accumulated messages. Displays a set of messages prepared by a business logic component and stored as an
ActionMessagesobject,ActionErrorsobject, a String, or a String array in any scope. If such a bean is not found, nothing will be rendered. The messages are placed into the page scope in the body of this tag where they can be displayed by standard JSP methods. (For example:<bean:write>,<c:out>)In order to use this tag successfully, you must have defined an application scope
]]>MessageResourcesbean under the default attribute name.messages org.apache.struts.taglib.html.MessagesTag org.apache.struts.taglib.html.MessagesTei JSP null. ]]> id true false java.lang.String bundle false true java.lang.String errors.divideZero=The mathematical expression <strong>{0}</strong> caused a divide by zero.
- Since:
- Struts 1.4
Globals.MESSAGE_KEY
constant string. Also if this is set to 'true', any value
assigned to the name attribute will be ignored.
]]>
Renders an HTML <input> element of type
checkbox, 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.
WARNING: In order to correctly
recognize cases where none of the associated checkboxes
are selected, the ActionForm bean
associated with this form must include a statement
setting the corresponding array to zero length in the
reset() method.
The value to be returned to the server, if this checkbox is selected, must be defined by one of the following methods:
- Specify a
valueattribute, whose contents will be used literally as the value to be returned. - Specify no
valueattribute, and the nested body content of this tag will be used as the value to be returned.
Also note that a map backed attribute cannot be used to hold a the String[] for a group of multibox tags.
]]>Globals.ERROR_KEY constant string will be used.
N.B. This is used in conjunction with the
errorStyle, errorStyleClass and
errorStyleId attributes and should be set to
the same value as the name attribute on the
<html:errors/> tag.
- Since:
- Struts 1.2.5
N.B. If present, this overrides the
style attribute in the event of an error.
- Since:
- Struts 1.2.5
N.B. If present, this overrides the
styleClass attribute in the event of an error.
- Since:
- Struts 1.2.5
N.B. If present, this overrides the
styleId attribute in the event of an error.
- Since:
- Struts 1.2.5
N.B. If present, the errorStyle
overrides this attribute in the event of an error for the element.
N.B. If present, the errorStyleClass
overrides this attribute in the event of an error for the element.
N.B. If present, the errorStyleId
overrides this attribute in the event of an error for the element.
Render an HTML <option> element,
representing one of the choices for an enclosing
<select> 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 bundle,
locale, and key attributes.
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
<html:select> tag body.
- Since:
- Struts 1.3.6
- Since:
- Struts 1.3.6
- Since:
- Struts 1.4
- Since:
- Struts 1.4
Renders a set of HTML <option> elements,
representing possible choices for a <select>
element. This tag can be used multiple times within a single
<html:select> element, either in conjunction
with or instead of one or more <html:option>
or <html:optionsCollection> elements.
This tag operates in one of two major modes, depending on
whether or not the collection attribute is
specified. If the collection attribute is
included, the following rules apply:
- The collection 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.
- The property 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.
- The labelProperty 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
labelPropertyattribute is not specified, the property named by thepropertyattribute will be used to select both the value returned to the server and the label displayed to the user for this option.
If the collection attribute is not specified,
the rules described in the remainder of this section apply.
The collection of values actually selected depends on the presence or
absence of the name and property attributes. The
following combinations are allowed:
- Only
nameis specified - The value of this attribute is the name of a JSP bean in some scope that is the collection. - Only
propertyis specified - The value of this attribute is the name of a property of the ActionForm bean associated with our form, which will return the collection. - Both
nameandpropertyare specified - The value of thenameattribute identifies a JSP bean in some scope. The value of thepropertyattribute is the name of some property of that bean which will return the collection.
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 labelName and labelProperty
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:
- Neither
labelNamenorlabelPropertyis specified - The labels will be the same as the option values themselves. - Only
labelNameis specified - The value of this attribute is the name of a JSP bean in some scope that is the collection. - Only
labelPropertyis specified - The value of this attribute is the name of a property of the ActionForm bean associated with our form, which will return the collection. - Both
labelNameandlabelPropertyare specified - The value of thelabelNameattribute identifies a JSP bean in some scope. The value of thelabelPropertyattribute is the name of some property of that bean which will return the collection.
Note that this tag does not support a styleId
attribute, as it would have to apply the value to all the
option elements created by this element, which would
mean that more than one id element might have the same
value, which the HTML specification says is illegal.
Renders a set of HTML <option> elements,
representing possible choices for a <select>
element. This tag can be used multiple times within a single
<html:select> element, either in conjunction
with or instead of one or more <html:option>
or <html:options> elements.
This tag operates on a collection of beans, where each bean
has a label property and a value
property. The actual names of these properties can be configured
using the label and value attributes
of this tag.
This tag differs from the <html:options> tag
in that it makes more consistent use of the name and
property attributes, and allows the collection to be
more easily obtained from the enclosing form bean.
Note that this tag does not support a styleId
attribute, as it would have to apply the value to all the
option elements created by this element, which would
mean that more than one id element might have the same
value, which the HTML specification says is illegal.
- Since:
- Struts 1.3.6
Globals.ERROR_KEY constant string will be used.
N.B. This is used in conjunction with the
errorStyle, errorStyleClass and
errorStyleId attributes and should be set to
the same value as the name attribute on the
<html:errors/> tag.
- Since:
- Struts 1.2.5
N.B. If present, this overrides the
style attribute in the event of an error.
- Since:
- Struts 1.2.5
N.B. If present, this overrides the
styleClass attribute in the event of an error.
- Since:
- Struts 1.2.5
N.B. If present, this overrides the
styleId attribute in the event of an error.
- Since:
- Struts 1.2.5
- Since:
- Struts 1.3.6
true for consistency with
all other form tags that redisplay their contents.
]]>
N.B. If present, the errorStyle
overrides this attribute in the event of an error for the element.
N.B. If present, the errorStyleClass
overrides this attribute in the event of an error for the element.
N.B. If present, the errorStyleId
overrides this attribute in the event of an error for the element.
Renders an HTML <input> 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.
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.
]]>- Since:
- Struts 1.3.6
Globals.ERROR_KEY constant string will be used.
N.B. This is used in conjunction with the
errorStyle, errorStyleClass and
errorStyleId attributes and should be set to
the same value as the name attribute on the
<html:errors/> tag.
- Since:
- Struts 1.2.5
N.B. If present, this overrides the
style attribute in the event of an error.
- Since:
- Struts 1.2.5
N.B. If present, this overrides the
styleClass attribute in the event of an error.
- Since:
- Struts 1.2.5
N.B. If present, this overrides the
styleId attribute in the event of an error.
- Since:
- Struts 1.2.5
- Since:
- Struts 1.3.6
N.B. If present, the errorStyle
overrides this attribute in the event of an error for the element.
N.B. If present, the errorStyleClass
overrides this attribute in the event of an error for the element.
N.B. If present, the errorStyleId
overrides this attribute in the event of an error for the element.
- Since:
- Struts 1.1
- Since:
- Struts 1.3.6
- Since:
- Struts 1.3.6
Renders a request URI based on exactly the same rules
as the <html:link> tag does,
but without creating
the <a> hyperlink. This value is useful
when you want to generate a string constant for use by
a JavaScript procedure.
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.
- Since:
- Struts 1.2.0
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.
]]>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.
]]>
action attribute, the
forward attribute, the
href attribute, or the page
attribute.
]]>
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).
]]>
action attribute, the
forward attribute, the
href attribute, or the page
attribute.
]]>
paramName and (optional)
paramProperty attributes, optionally scoped by
the paramScope attribute
]]>
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.
]]>
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.
]]>
paramName attribute. If not specified,
all scopes are searched.
]]>
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.
]]>
name attribute. If not specified, all
scopes are searched.
]]>
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.
]]>
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.
]]>
Renders an HTML <select> element, associated with a bean property specified by our attributes. This tag is only valid when nested inside a form tag body.
This tag operates in two modes, depending upon the
state of the multiple attribute, which
affects the data type of the associated property you
should use:
- multiple="false" or multiple IS NOT selected - The corresponding property should be a scalar value of any supported data type.
- multiple="true" IS selected - The corresponding property should be an array of any supported data type.
WARNING: In order to correctly
recognize cases where no selection at all is made, the
ActionForm bean associated with this form
must include a statement resetting the scalar property
to a default value (if multiple is not
set), or the array property to zero length (if
multiple is set) in the
reset() method.
- Since:
- Struts 1.3.6
Globals.ERROR_KEY constant string will be used.
N.B. This is used in conjunction with the
errorStyle, errorStyleClass and
errorStyleId attributes and should be set to
the same value as the name attribute on the
<html:errors/> tag.
- Since:
- Struts 1.2.5
N.B. If present, this overrides the
style attribute in the event of an error.
- Since:
- Struts 1.2.5
N.B. If present, this overrides the
styleClass attribute in the event of an error.
- Since:
- Struts 1.2.5
N.B. If present, this overrides the
styleId attribute in the event of an error.
- Since:
- Struts 1.2.5
- Since:
- Struts 1.3.6
N.B. If present, the errorStyle
overrides this attribute in the event of an error for the element.
N.B. If present, the errorStyleClass
overrides this attribute in the event of an error for the element.
N.B. If present, the errorStyleId
overrides this attribute in the event of an error for the element.
submit.
If a graphical button is needed (a button with an image), then the
<html:image> tag is more appropriate.
- Since:
- Struts 1.3.6
Render an input field of type text. This tag is only valid when nested inside a form tag body.
]]>- Since:
- Struts 1.3.6
Globals.ERROR_KEY constant string will be used.
N.B. This is used in conjunction with the
errorStyle, errorStyleClass and
errorStyleId attributes and should be set to
the same value as the name attribute on the
<html:errors/> tag.
- Since:
- Struts 1.2.5
N.B. If present, this overrides the
style attribute in the event of an error.
- Since:
- Struts 1.2.5
N.B. If present, this overrides the
styleClass attribute in the event of an error.
- Since:
- Struts 1.2.5
N.B. If present, this overrides the
styleId attribute in the event of an error.
- Since:
- Struts 1.2.5
- Since:
- Struts 1.3.6
N.B. If present, the errorStyle
overrides this attribute in the event of an error for the element.
N.B. If present, the errorStyleClass
overrides this attribute in the event of an error for the element.
N.B. If present, the errorStyleId
overrides this attribute in the event of an error for the element.
- Since:
- Struts 1.3.6
Globals.ERROR_KEY constant string will be used.
N.B. This is used in conjunction with the
errorStyle, errorStyleClass and
errorStyleId attributes and should be set to
the same value as the name attribute on the
<html:errors/> tag.
- Since:
- Struts 1.2.5
N.B. If present, this overrides the
style attribute in the event of an error.
- Since:
- Struts 1.2.5
N.B. If present, this overrides the
styleClass attribute in the event of an error.
- Since:
- Struts 1.2.5
N.B. If present, this overrides the
styleId attribute in the event of an error.
- Since:
- Struts 1.2.5
- Since:
- Struts 1.3.6
N.B. If present, the errorStyle
overrides this attribute in the event of an error for the element.
N.B. If present, the errorStyleClass
overrides this attribute in the event of an error for the element.
N.B. If present, the errorStyleId
overrides this attribute in the event of an error for the element.
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.
<html:html xhtml="true"> has a similar effect. This
tag has no attributes; you use it like this:
<html:xhtml/>.
Note: Included pages do not inherit the rendering
style of the including page by default. Without setting the
scope attribute, which defaults to page
scope, each JSP fragment or Tile must use this tag to render as
XHTML.